updated for new hooks

[libfirm] / ir / ident / ident.h

diff --git a/ir/ident/ident.h b/ir/ident/ident.h
index 56c5b4e..e15fdab 100644 (file)
--- a/ir/ident/ident.h
+++ b/ir/ident/ident.h
@@ -33,7 +33,55 @@
  *  An ident represents an unique string. The == operator
  *  is sufficient to compare two idents.
  */
-typedef const struct set_entry ident;
+#ifndef _IDENT_TYPEDEF_
+#define _IDENT_TYPEDEF_
+typedef const struct s_ident ident;
+#endif
+
+/**
+ * The ident module interface.
+ */
+typedef struct _ident_if_t {
+  /**
+   * Store a string and create an ident.
+   * This function may be NULL, new_id_from_chars()
+   * is then used to emulate it's behavior.
+   *
+   * @param str - the string which shall be stored
+   */
+  ident *(*new_id_from_str)(void *handle, const char *str);
+
+  /**
+   * Store a string and create an ident.
+   *
+   * @param str - the string (or whatever) which shall be stored
+   * @param len - the length of the data in bytes
+   */
+  ident *(*new_id_from_chars)(void *handle, const char *str, int len);
+
+  /**
+   * Returns a string represented by an ident.
+   */
+  const char *(*get_id_str)(void *handle, ident *id);
+
+  /**
+   * Returns the length of the string represented by an ident.
+   * This function may be NULL, get_id_str() is then used
+   * to emulate it's behavior.
+   *
+   * @param id - the ident
+   */
+  int  (*get_id_strlen)(void *handle, ident *id);
+
+  /**
+   * Finish the ident module and frees all idents, may be NULL.
+   */
+  void (*finish_ident)(void *handle);
+
+  /** The handle. */
+  void *handle;
+
+} ident_if_t;
 
 /**
  *  Store a string and create an ident.
@@ -50,21 +98,19 @@ typedef const struct set_entry ident;
  */
 ident *new_id_from_str (const char *str);
 
-/**
- *  Store a string and create an ident.
+/** Store a string and create an ident.
  *
- *  Stores a string in the ident module and returns a handle for the string.
- *
- *  Copies the string. This version can take non-zero-terminated strings
+ * Stores a string in the ident module and returns a handle for the string.
+ * Copies the string. This version takes non-zero-terminated strings.
  *
  * @param str - the string (or whatever) which shall be stored
  * @param len - the length of the data in bytes
  *
  * @return id - a handle for the generated ident
  *
- * @see new_get_id_str(), get_id_strlen()
+ * @see new_id_from_str(), get_id_strlen()
  */
-INLINE ident *id_from_str (const char *str, int len);
+ident *new_id_from_chars (const char *str, int len);
 
 /**
  * Returns a string represented by an ident.
@@ -76,10 +122,9 @@ INLINE ident *id_from_str (const char *str, int len);
  *
  * @return cp - a string
  *
- * @see new_get_id_str(), id_from_str(), get_id_strlen()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_strlen()
  */
-INLINE const char *get_id_str  (ident *id);
-#define id_to_str  get_id_str
+const char *get_id_str  (ident *id);
 
 /**
  * Returns the length of the string represented by an ident.
@@ -88,17 +133,16 @@ INLINE const char *get_id_str  (ident *id);
  *
  * @return len - the length of the string
  *
- * @see new_get_id_str(), id_from_str(), get_id_str()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str()
  */
-INLINE int  get_id_strlen(ident *id);
-#define id_to_strlen get_id_strlen
+int  get_id_strlen(ident *id);
 /**
  * Returns true if prefix is a prefix of an ident.
  *
  * @param prefix - the prefix
  * @param id     - the ident
  *
- * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix()
  */
 int id_is_prefix (ident *prefix, ident *id);
 
@@ -108,19 +152,19 @@ int id_is_prefix (ident *prefix, ident *id);
  * @param suffix - the suffix
  * @param id     - the ident
  *
- * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix()
  */
 int id_is_suffix (ident *suffix, ident *id);
 
 /**
- * Returns true if infix is a contained in id.  (Can be suffix or prefix)
+ * Returns true if infix is contained in id.  (Can be suffix or prefix)
  *
  * @param infix  - the infix
  * @param id     - the ident to search in
  *
- * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix()
  */
-//int id_contains(ident *infix, ident *id);
+/* int id_contains(ident *infix, ident *id); */
 
 /**
  * Return true if an ident contains a given character.
@@ -128,7 +172,7 @@ int id_is_suffix (ident *suffix, ident *id);
  * @param id     - the ident
  * @param c      - the character
  *
- * @see new_get_id_str(), id_from_str(), get_id_str()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str()
  */
 int id_contains_char (ident *id, char c);
 
@@ -138,9 +182,9 @@ int id_contains_char (ident *id, char c);
  * @param id - The ident to be printed.
  *
  * @return
- *    number of btes written
+ *    number of bytes written
  *
- * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix(), fprint_id()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix(), fprint_id()
  */
 int print_id (ident *id);
 
@@ -153,7 +197,7 @@ int print_id (ident *id);
  * @return
  *    number of btes written
  *
- * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix(), print_id()
+ * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix(), print_id()
  */
 int fprint_id (FILE *F, ident *id);