Added tarval_sub_bits() fucntion to access the (binary) bitpattern of a tarval.

[libfirm] / ir / tv / tv_t.h

diff --git a/ir/tv/tv_t.h b/ir/tv/tv_t.h
index 269eaa9..a035689 100644 (file)
--- a/ir/tv/tv_t.h
+++ b/ir/tv/tv_t.h
@@ -1,31 +1,43 @@
 /* Declarations for Target Values.
    Copyright (C) 1995, 1996 Christian von Roques */
 
+/**
+* @file tv_t.h
+*
+* @author Christian von Roques
+*/
+
 /* $Id$ */
 
 #ifndef _TV_T_H_
 #define _TV_T_H_
 
-# include "tv.h"
-# include "misc.h"
-
+#include "tv.h"
+#include "xprintf.h"
+
+/**
+ * This struct represents the aforementioned tarvals.
+ *
+ * A tarval struct consists of an internal representation of the
+ * value and some additional fields further describing the value.
+ *
+ * ATTRIBUTES:
+ *   - ir_mode *mode     The mode of the stored value
+ *   - void *value       The internal representation
+ *
+ * @sa
+ *   irmode.h for predefined modes
+ */
+struct tarval {
+    ir_mode *mode;             /**< the mode of the stored value */
+    const void *value;                 /**< the value stored in an internal way... */
+    unsigned int length;       /**< the length of the stored value */
+};
+
+/** xfprint output */
 int tarval_print (XP_PAR1, const xprintf_info *, XP_PARN);
 
-/* Hash function on tarvals */
-unsigned tarval_hash (tarval *);
-
-
-#ifdef NDEBUG
-#define TARVAL_VRFY(val) ((void)0)
-#else
-#define TARVAL_VRFY(val) _tarval_vrfy ((val))
-extern void _tarval_vrfy (const tarval *);
-#endif
-
-#ifdef STATS
-void tarval_stats (void);
-#else
-#define tarval_stats() ((void)0)
-#endif
+/** remove tarval representing an entity that is about to be destroyed */
+void free_tarval_entity(entity *ent);
 
 #endif /* _TV_T_H_ */