Fixed get_SymConst_kind() call, removed non-portable __FUNCTION__ extension, fixed...

[libfirm] / ir / ident / ident.h

diff --git a/ir/ident/ident.h b/ir/ident/ident.h
index c211854..28d39b9 100644 (file)
--- a/ir/ident/ident.h
+++ b/ir/ident/ident.h
@@ -2,89 +2,114 @@
    Copyright (C) 1995, 1996 Markus Armbruster */
 
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
+* All rights reserved.
+*
+* Authors: Martin Trapp, Christian Schaefer
 */
 
+/* $Id$ */
+
 # ifndef _IDENT_H_
 # define _IDENT_H_
 
-# include "assert.h"
+# include <stdio.h>
+# include <assert.h>
+# include "firm_common.h"
 
-/****h* libfirm/ident
+/**
  *
- * NAME
- *   ident -- identifiers in the firm library
- * NOTES
+ *   - identifiers in the firm library
  *  Identifiers are used in the firm library. This is the interface to it.
- *
- ******
  */
 
 /* Identifiers */
-/****s* ident/ident
+/**
  *
- * NAME
- *  ident - the abstract data type ident
- * SOURCE
+ *  the abstract data type ident
  */
 typedef const struct set_entry ident;
-/*****/
 
-/****f* ident/id_from_str
+/**
  *
- * NAME
- *  id_from_str - store a string and create an ident
- * SYNOPSIS
- *  ident *id = id_from_str (char *str, int len);
- * FUNCTION
+ *  store a string and create an ident
  *  Stores a string in the ident module and returns a handle for the string.
- * INPUTS
- *  str - the string (or whatever) which shall be stored
- *  len - the length of the data in bytes
- * RESULT
- *  id - a handle for the generated ident
- * SEE ALSO
- *  id_to_str, id_to_strlen
- ***
+ *  Copies the string.
+ *  @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 id_to_str, id_to_strlen
+ * @see
  */
-inline ident      *id_from_str (char *str, int len);
+INLINE ident      *id_from_str (const char *str, int len);
 
-/****f* ident/id_to_str
+/**
  *
- * NAME
- *  id_to_str - return a string represented by an ident
- * SYNOPSIS
- *  char *cp = id_to_str (ident *id);
- * FUNCTION
- *  Returns the string cp represented by id. This string cp is not Null terminated!
- * INPUTS
- *  id - the ident
- * RESULT
- *  cp - a string
- * SEE ALSO
- *  id_from_str, id_to_strlen
- ***
+ *  return a string represented by an ident
+ *  Returns the string cp represented by id. This string cp is not
+ *  Null terminated!  The string may not be changed.
+ *  @param id - the ident
+ *  @return cp - a string
+ * @see id_from_str, id_to_strlen
+ * @see
  */
-inline const char *id_to_str   (ident *id);
+INLINE const char *id_to_str   (ident *id);
 
-/****f* ident/id_to_strlen
+/**
  *
- * NAME
- *  id_to_strlen - return the length of a string represented by an ident
- * SYNOPSIS
- *  int len = id_to_strlen (ident *id);
- * FUNCTION
+ *  return the length of a string represented by an ident
  *  Returns the length of string represented by id.
- * INPUTS
- *  id - the ident
- * RESULT
- *  len - the length of the string
- * SEE ALSO
- *  id_from_str, id_to_str
- ***
+ *  @param id - the ident
+ *  @return len - the length of the string
+ * @see id_from_str, id_to_str
+ * @see
+ */
+INLINE int  id_to_strlen(ident *id);
+
+/**
+ *
+ *
+ *  Returns true if prefix is prefix of id.
+ *  @param prefix - the prefix
+ *  @param id - the ident
+ * @see id_from_str, id_to_str, id_is_prefix
+ * @see
+ */
+/*  */
+int id_is_prefix (ident *prefix, ident *id);
+
+/**
+ *
+ *
+ *  Returns true if suffix is suffix of id.
+ *  @param suffix - the suffix
+ *  @param id - the ident
+ * @see id_from_str, id_to_str, id_is_prefix
+ * @see
  */
-inline int         id_to_strlen(ident *id);
+/*  */
+int id_is_suffix (ident *suffix, ident *id);
+
+/**
+ *
+ *
+ *  Prints the ident to stdout.
+ *  @param The ident to print.
+ * @see id_from_str, id_to_str, id_is_prefix, fprint_id
+ * @see
+ */
+/*  */
+int print_id (ident *id);
+
+/**
+ *
+ *
+ *  Prints the ident to the file passed.
+ *  @param The ident to print and the file.
+ * @see id_from_str, id_to_str, id_is_prefix, print_id
+ * @see
+ */
+/*  */
+int fprint_id (FILE *F, ident *id);
+
 
 # endif /* _IDENT_H_ */