/**
- *
* @file type.h
*
* Project: libFIRM <br>
# ifndef _TYPE_IDENTIFY_H_
# define _TYPE_IDENTIFY_H_
-#ifndef _TYPE_TYPEDEF_
-#define _TYPE_TYPEDEF_
-typedef struct type type;
-#endif
+#include "firm_types.h"
/* ------------------------------------------------------------------------ */
* @param tp1 The first type to compare.
* @param tp2 The second type to compare.
*/
-//typedef int (*compare_types_func_tp) (type *tp1, type *tp2);
-typedef int (*compare_types_func_tp) (const void *tp1, const void *tp2);
+typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
/** Compares two types by their name.
*
* Compares the opcode and the name of the types. If these are
- * equal returns true, else false.
+ * equal returns 0, else non-zero.
*/
int compare_names (const void *tp1, const void *tp2);
/** Compares two types strict.
*
- * returns true if tp1 == tp2
+ * returns 0 if tp1 == tp2, else non-zero
*/
int compare_strict (const void *tp1, const void *tp2);
-/** A variable that holds a compare function for types.
- *
- * The compare function is used to identify equal types. The
- * variable is initialized with the function compare_strict().
- *
- * The variable must be set before calling init_firm()! Later changes
- * have no effect.
- */
-extern compare_types_func_tp compare_types_func;
-
-
/* ------------------------------------------------------------------------ */
/** Type for a function that computes a hash value for a type.
*
* @param tp The type to compute a hash for.
*/
-typedef int (*hash_types_func_tp)(type *tp);
+typedef int (hash_types_func_t)(ir_type *tp);
/** Computes a hash value by the type name.
*
* Uses the name of the type and the type opcode to compute the hash.
*/
-int hash_name (type *tp);
+int firm_hash_name (ir_type *tp);
+
+/* ------------------------------------------------------------------------ */
-/** A variable that holds a hash function for a type.
+/** Finalize type construction.
+ *
+ * Indicate that a type is so far completed that it can be
+ * distinguished from other types. Mature_type hashes the type into a
+ * table. It uses the function in compare_types_func to compare the
+ * types.
*
- * The hash function is used to identify equal types. The
- * variable is initialized with the function hash_name().
+ * If it finds a type identical to tp it returns this type. It turns
+ * tp into the Id type. All places formerly pointing to tp will now
+ * point to the found type. All entities of tp now refer to the found
+ * type as their owner, but they are not a member of this type. This
+ * is invalid firm -- the entities must be replaced by entities of the
+ * found type. The Id type will be removed from the representation
+ * automatically, but within an unknown time span. It occupies memory
+ * for this time.
*
- * The variable must be set before calling init_firm()! Later changes
- * have no effect.
+ * @param tp The type to mature.
*/
-extern hash_types_func_tp hash_types_func;
-
+ir_type * mature_type(ir_type *tp);
-/* ------------------------------------------------------------------------ */
+/** Finalize type construction.
+ *
+ * Indicate that a type is so far completed that it can be
+ * distinguished from other types. Mature_type hashes the type into a
+ * table. It uses the function in compare_types_func to compare the
+ * types.
+ *
+ * If it finds a type identical to tp it returns this type. It frees
+ * type tp and all its entities.
+ *
+ * @param tp The type to mature.
+ */
+ir_type * mature_type_free(ir_type *tp);
/** Finalize type construction.
*
* Indicate that a type is so far completed that it can be
* distinguished from other types. Mature_type hashes the type into a
* table. It uses the function in compare_types_func to compare the
- * types. If it find a type identical to tp it returns this type. In
- * this case it also turns tp into the Id type. The caller should free
- * tp if he knows that there are no other references to tp. The memory
- * of tp is not lost, but will remain alive for an unknown time.
+ * types.
+ *
+ * If it find a type identical to tp it returns this type. It frees
+ * the entities and turns the type into an Id type. All places
+ * formerly pointing to tp will now point to the found type. The Id
+ * type will be removed from the representation automatically, but
+ * within an unknown time span. It occupies memory for this time.
+ *
+ * @param tp The type to mature.
+ */
+ir_type * mature_type_free_entities(ir_type *tp);
+
+/**
+ * The interface type for the type identify module;
+ */
+typedef struct _type_identify_if_t {
+ compare_types_func_t *cmp; /**< The function that should be used to compare two types.
+ If NULL, compare_strict() will be used. */
+ hash_types_func_t *hash; /**< The function that should be used to calculate a hash
+ value of a type. If NULL, hash_name() will be used. */
+} type_identify_if_t;
+
+/**
+ * Initialise the type identifier module.
+ *
+ * @param ti_if The interface functions for this module.
*
- * @param tp The type to mature.
+ * If the parameter ti_if is NULL, the default functions compare_strict() and
+ * firm_hash_name() will be used.
*/
-type * mature_type(type *tp);
+void init_type_identify(type_identify_if_t *ti_if);
# endif /* _TYPE_IDENTIFY_H_ */
projects / libfirm / blobdiff