used ircons_t.h now

[libfirm] / ir / tv / tv.h

diff --git a/ir/tv/tv.h b/ir/tv/tv.h
index e187be1..ab2feb7 100644 (file)
--- a/ir/tv/tv.h
+++ b/ir/tv/tv.h
@@ -1,11 +1,22 @@
+/*
+ * Project:     libFIRM
+ * File name:   ir/tv/tv.h
+ * Purpose:     Representation of and static computations on target machine
+ *              values.
+ * Author:      Mathias Heil
+ * Modified by:
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
 /**
  * @file tv.h
  *
  * Declarations for Target Values.
  */
 
-/* $Id$ */
-
 #ifndef _TV_H_
 #define _TV_H_
 
@@ -206,12 +217,15 @@ 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);
 
 /**
@@ -263,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. */
@@ -384,7 +405,10 @@ tarval *tarval_convert_to(tarval *src, ir_mode *m);
  *   The sort member of the struct mode defines which operations are valid
  */
 
-/** Negation of a tarval. */
+/** bitwise Negation of a tarval. */
+tarval *tarval_not(tarval *a);
+
+/** arithmetic Negation of a tarval. */
 tarval *tarval_neg(tarval *a);
 
 /** Addition of two tarvals. */
@@ -451,7 +475,7 @@ typedef enum {
 
 /**
  * This structure contains helper information to format the output
- * of a tarval of an mode.
+ * of a tarval of a mode.
  */
 typedef struct tarval_mode_info {
     tv_output_mode mode_output;                /**< if != TVO_NATIVE select a special mode */
@@ -537,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.
@@ -565,6 +595,8 @@ void init_tarval_1(void);
  */
 void init_tarval_2(void);
 
+void finish_tarval(void);
+
 /**
  * Output of tarvals to a buffer.
  */