Fixed documentation od tarval_classify and add new enum to make things more clear

[libfirm] / ir / tv / tv.h

diff --git a/ir/tv/tv.h b/ir/tv/tv.h
index d56ab44..9778967 100644 (file)
--- a/ir/tv/tv.h
+++ b/ir/tv/tv.h
@@ -560,19 +560,25 @@ char *tarval_bitpattern(tarval *tv);
 unsigned char tarval_sub_bits(tarval *tv, unsigned byte_ofs);
 
 /**
- * Identifying some tarvals ???
- *
+ * Return values of tarval classify
+ */
+typedef enum _tarval_classification_t {
+  TV_CLASSIFY_NULL    =  0,    /**< the tarval represents the additive neutral element */
+  TV_CLASSIFY_ONE     = +1,    /**< the tarval represents the multiplicative neutral element */
+  TV_CLASSIFY_ALL_ONE = -1,    /**< the tarval represents the bitwise-and neutral element */
+  TV_CLASSIFY_OTHER   =  2,    /*<< all other tarvals */
+} tarval_classification_t;
+
+/**
+ * Identifying tarvals values for algebraic simplifications.
+ * @param tv
  * @return
- *   - 0 for additive neutral,
- *   - +1 for multiplicative neutral,
- *   - -1 for bitwise-and neutral
- *   - 2 else
- *
- * @deprecated
- *   This function is deprecated and its use strongly discouraged.
- *   Implemented for completeness.
+ *   - TV_CLASSIFY_NULL    for additive neutral,
+ *   - TV_CLASSIFY_ONE     for multiplicative neutral,
+ *   - TV_CLASSIFY_ALL_ONE for bitwise-and neutral
+ *   - TV_CLASSIFY_OTHER   else
  */
-long tarval_classify(tarval *tv);
+tarval_classification_t tarval_classify(tarval *tv);
 
 /**
  * Initialization of the tarval module.