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
*/
+/**
+ * @file ident.h
+ *
+ * Declarations for identifiers in the firm library
+ *
+ * Identifiers are used in the firm library. This is the interface to it.
+ */
+
/* $Id$ */
# ifndef _IDENT_H_
# include <stdio.h>
# include <assert.h>
-# include "common.h"
+# include "firm_common.h"
-/****h* libfirm/ident
+/* Identifiers */
+
+/**
+ * Initialises the ident handling.
*
- * NAME
- * ident -- identifiers in the firm library
- * NOTES
- * Identifiers are used in the firm library. This is the interface to it.
- ******
+ * Must be called before any id_*() function can be called.
*/
+void id_init(void);
-/* Identifiers */
-/****s* ident/ident
+/**
+ * The abstract data type ident.
*
- * NAME
- * ident - the abstract data type ident
- * SOURCE
+ * An ident represents an unique string. The == operator
+ * is sufficient to compare two idents.
*/
typedef const struct set_entry ident;
-/*****/
-/****f* ident/id_from_str
+/**
+ * Store a string and create an ident.
*
- * NAME
- * id_from_str - store a string and create an ident
- * SYNOPSIS
- * ident *id = id_from_str (const char *str, int len);
- * FUNCTION
* Stores a string in the ident module and returns a handle for the string.
- * Copies 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. @p str must be zero terminated
+ *
+ * @param str - the string which shall be stored
+ *
+ * @return id - a handle for the generated ident
+ *
+ * @see id_to_str(), id_to_strlen()
+ */
+ident *new_id_from_str (const char *str);
+
+/**
+ * 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
+ *
+ * @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_id_to_str(), id_to_strlen()
*/
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! The string may not be changed.
- * INPUTS
- * id - the ident
- * RESULT
- * cp - a string
- * SEE ALSO
- * id_from_str, id_to_strlen
- ***
+/**
+ * Returns a string represented by an ident.
+ *
+ * Returns the string represented by id. This string is
+ * NULL terminated. The string may not be changed.
+ *
+ * @param id - the ident
+ *
+ * @return cp - a string
+ *
+ * @see new_id_to_str(), id_from_str(), id_to_strlen()
*/
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
- * 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
- ***
+/**
+ * Returns the length of the string represented by an ident.
+ *
+ * @param id - the ident
+ *
+ * @return len - the length of the string
+ *
+ * @see new_id_to_str(), id_from_str(), id_to_str()
*/
INLINE int id_to_strlen(ident *id);
-/****f* ident/id_is_suffix
+/**
+ * Returns true if prefix is a prefix of an ident.
*
- * NAME
+ * @param prefix - the prefix
+ * @param id - the ident
*
- * SYNOPSIS
- * int id_is_prefix (ident *prefix, ident *id);
- * FUNCTION
- * Returns true if prefix is prefix of id.
- * INPUTS
- * prefix - the prefix
- * id - the ident
- * SEE ALSO
- * id_from_str, id_to_str, id_is_prefix
- ***
+ * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix()
*/
-/* */
int id_is_prefix (ident *prefix, ident *id);
-/****f* ident/id_is_suffix
+/**
+ * Returns true if suffix is a suffix of an ident.
*
- * NAME
+ * @param suffix - the suffix
+ * @param id - the ident
*
- * SYNOPSIS
- * int id_is_suffix (ident *suffix, ident *id);
- * FUNCTION
- * Returns true if suffix is suffix of id.
- * INPUTS
- * suffix - the suffix
- * id - the ident
- * SEE ALSO
- * id_from_str, id_to_str, id_is_prefix
- ***
+ * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix()
*/
-/* */
int id_is_suffix (ident *suffix, ident *id);
-/****f* ident/print_id
+/**
+ * Return true if an ident contains a given character.
+ *
+ * @param id - the ident
+ * @param c - the character
+ *
+ * @see new_id_to_str(), id_from_str(), id_to_str()
+ */
+int id_contains_char (ident *id, char c);
+
+/**
+ * Prints the ident to stdout.
+ *
+ * @param id - The ident to be printed.
*
- * NAME
+ * @return
+ * number of btes written
*
- * SYNOPSIS
- * int print_id (ident *id);
- * FUNCTION
- * Prints the ident to stdout.
- * INPUTS
- * The ident to print.
- * SEE ALSO
- * id_from_str, id_to_str, id_is_prefix, fprint_id
- ***
+ * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix(), fprint_id()
*/
-/* */
int print_id (ident *id);
-/****f* ident/fprint_id
+/**
+ * Prints the ident to the file passed.
*
- * NAME
+ * @param F - file pointer to print the ident to.
+ * @param id - The ident to print and the file.
*
- * SYNOPSIS
- * int fprint_id (FILE *f, ident *id);
- * FUNCTION
- * Prints the ident to the file passed.
- * INPUTS
- * The ident to print and the file.
- * SEE ALSO
- * id_from_str, id_to_str, id_is_prefix, print_id
- ***
+ * @return
+ * number of btes written
+ *
+ * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix(), print_id()
*/
-/* */
int fprint_id (FILE *F, ident *id);
-
# endif /* _IDENT_H_ */
projects / libfirm / blobdiff