used ircons_t.h now

[libfirm] / ir / tv / tv.h

diff --git a/ir/tv/tv.h b/ir/tv/tv.h
index 2c8b95d..ab2feb7 100644 (file)
--- a/ir/tv/tv.h
+++ b/ir/tv/tv.h
@@ -217,11 +217,13 @@ int tarval_is_double(tarval *tv);
  * Construct a tarval that represents the address of the entity.
  *
  * The address must be constant, the entity must have as owner the global type.
+ * We no more support this function: Use the new SymConst instead.
  */
 tarval *new_tarval_from_entity (entity *ent, ir_mode *mode);
 
 /**
- * Returns the associated entity of a tarval.
+ * Returns the associated entity of a tarval.  Asserts if tarval does not
+ * contain an entity.
  */
 #define get_tarval_entity tarval_to_entity
 entity *tarval_to_entity(tarval *tv);
@@ -275,6 +277,13 @@ int tarval_is_negative(tarval *a);
  */
 int tarval_is_null(tarval *a);
 
+/**
+ * Returns 1 if tv is the "one"
+ *
+ * @param a    the tarval
+ */
+int tarval_is_one(tarval *a);
+
 /** The 'bad' tarval. */
 extern tarval *tarval_bad;
 /** Returns the 'bad tarval. */
@@ -552,19 +561,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.
@@ -580,6 +595,8 @@ void init_tarval_1(void);
  */
 void init_tarval_2(void);
 
+void finish_tarval(void);
+
 /**
  * Output of tarvals to a buffer.
  */