Typo fixed.

[libfirm] / ir / tv / tv.h

diff --git a/ir/tv/tv.h b/ir/tv/tv.h
index c30f0c6..a8c2531 100644 (file)
--- a/ir/tv/tv.h
+++ b/ir/tv/tv.h
@@ -48,6 +48,7 @@ Discussion of new interface, proposals by Prof. Waite:
 # include "entity.h"
 # include "irnode.h"    /* for pnc_number enum */
 
+
 /****h* libfirm/tv
  *
  * NAME
@@ -195,11 +196,11 @@ int tarval_is_long(tarval *tv);
 /**
  * Constructor function for new tarvals.
  *
- * @param d     The long double representing the value
+ * @param d     The (long) double representing the value
  * @param mode  The mode requested for the result tarval
  *
  * This function creates a new tarval representing the value represented
- * by a long double. If a tarval representing this value already exists,
+ * by a (long) double. If a tarval representing this value already exists,
  * this tarval is returned instead of a new one. So tarvals are directly
  * comparable since their representation is unique.
  * Only modes of sort float_number can be constructed this way.
@@ -211,7 +212,7 @@ int tarval_is_long(tarval *tv);
  *   value/mode pair.
  *
  * @note
- *   If the long double is not representable in the given mode an assertion
+ *   If the (long) double is not representable in the given mode an assertion
  *   is thrown. This will happen for any mode not of sort float_number.
  *
  * @sa
@@ -280,16 +281,24 @@ int tarval_is_entity(tarval *tv);
  */
 
 /** Returns the mode of the tarval. */
+ir_mode *get_tarval_mode (tarval *tv);
 
 /* Testing properties of the represented values */
 
-/** Returns 0 if tv is positive, else > 0.
+/**
+ * Returns 1 if tv is negative
  *
- * @todo
- *   not tested!
+ * @param a    the tarval
  */
 int tarval_is_negative(tarval *a);
 
+/**
+ * Returns 1 if tv is null
+ *
+ * @param a    the tarval
+ */
+int tarval_is_null(tarval *a);
+
 /** The 'bad' tarval. */
 extern tarval *tarval_bad;
 /** Returns the 'bad tarval. */
@@ -439,7 +448,7 @@ tarval *tarval_abs(tarval *a);
 tarval *tarval_and(tarval *a, tarval *b);
 
 /** Bitwise or. */
-tarval *tarval_or (tarval *a, tarval *b);
+tarval *tarval_or(tarval *a, tarval *b);
 
 /** Bitwise exclusive or. */
 tarval *tarval_eor(tarval *a, tarval *b);
@@ -458,6 +467,59 @@ tarval *tarval_rot(tarval *a, tarval *b);
 
 /* *********** Output of tarvals *********** */
 
+/**
+ * The output mode for tarval values.
+ *
+ * Some modes allow more that one representation, for instance integers
+ * can be represented hex or decimal. Of course it would be enough to have
+ * one and let every backend convert it into the 'right' one.
+ * However, we can do this in the tarval much simplier...
+ */
+typedef enum {
+  TVO_NATIVE,                  /**< the default output mode, depends on the mode */
+  TVO_HEX,                     /**< use hex representation, always possible */
+  TVO_DECIMAL,                 /**< use decimal representation */
+  TVO_OCTAL,                   /**< use octal representation */
+  TVO_BINARY,                  /**< use binary representation */
+  TVO_FLOAT,                   /**< use floating point representation (i.e 1.342e-2)*/
+  TVO_HEXFLOAT                  /**< use hexadecimal floating point representation (i.e 0x1.ea32p-12)*/
+} tv_output_mode;
+
+/**
+ * This structure contains helper information to format the output
+ * of a tarval of an mode.
+ */
+typedef struct tarval_mode_info {
+    tv_output_mode mode_output;                /**< if != TVO_NATIVE select a special mode */
+    const char *mode_prefix;           /**< if set, this prefix will be printed
+                                            before a value of this mode */
+    const char *mode_suffix;           /**< if set, this suffix will be printed
+                                            after a value of this mode */
+} tarval_mode_info;
+
+/**
+ * Specify the output options of one mode.
+ *
+ * This functions stores the modinfo, so DO NOT DESTROY it.
+ *
+ * @param mode         a ir_mode that should be associated
+ * @param modeinfo     the output format info
+ *
+ * @return zero on success.
+ */
+int tarval_set_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo);
+
+/**
+ * Returns the output options of one mode.
+ *
+ * This functions returns the modinfo of a given mode.
+ *
+ * @param mode         a ir_mode that should be associated
+ *
+ * @return the output option
+ */
+const tarval_mode_info *tarval_get_mode_output_option(ir_mode *mode);
+
 /**
  * Returns Bit representation of a tarval value, as string of '0' and '1'
  *
@@ -483,11 +545,6 @@ tarval *tarval_rot(tarval *a, tarval *b);
  */
 char *tarval_bitpattern(tarval *tv);
 
-/**
- * Returns bitpattern [from, to[.
- */
-char *tarval_sub_bitpattern(tarval *tv, int from, int to);
-
 /**
  * Returns the bitpattern of the bytes_ofs byte.
  *
@@ -544,4 +601,14 @@ void init_tarval_1(void);
  */
 void init_tarval_2(void);
 
+/**
+ * Output of tarvals to a buffer.
+ */
+int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
+
+/**
+ * Output of tarvals to stdio.
+ */
+int tarval_printf(tarval *tv);
+
 #endif  /* _TV_H_ */