pseudo irgs
[libfirm] / ir / tv / tv_t.h
index 658bf9c..4316740 100644 (file)
@@ -1,42 +1,63 @@
-/* Declarations for Target Values.
-   Copyright (C) 1995, 1996 Christian von Roques */
+/*
+ * Project:     libFIRM
+ * File name:   ir/tv/tv_t.h
+ * Purpose:     Representation of and static computations on target machine
+ *              values -- private header.
+ * 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.
+ */
+
 
-/* $Id$ */
 
 #ifndef _TV_T_H_
 #define _TV_T_H_
 
-# include "tv.h"
-# include "misc.h"
-
-#include "gmp.h"
-#undef __need_size_t           /* erroneously defined by 1.3.2's gmp.h */
-
-
-tarval *tarval_S_from_str (const char *s, size_t len);
-tarval *tarval_s_from_str (const char *s, size_t len);
-tarval *tarval_B_from_str (const char *s, size_t len);
-tarval_B tv_val_B (tarval *tv);
-tarval_s tv_val_s (tarval *tv);
-
-
-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
+#include "tv.h"
+
+
+/**
+ * Initialization of the tarval module.
+ *
+ * Call before init_mode().
+ */
+void init_tarval_1(void);
+
+/**
+ * Initialization of the tarval module.
+ *
+ * Call after init_mode().
+ */
+void init_tarval_2(void);
+
+/**
+ * Free all memory occupied by the tarval module.
+ */
+void finish_tarval(void);
+
+/**
+ * This struct represents the afore mentioned 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 */
+};
+
+/** remove tarval representing an entity that is about to be destroyed */
+void free_tarval_entity(entity *ent);
 
 #endif /* _TV_T_H_ */