-/* Declarations for ident.
- Copyright (C) 1995, 1996 Markus Armbruster */
-
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-* All rights reserved.
-*
-* Authors: Martin Trapp, Christian Schaefer
-*/
+/*
+ * Project: libFIRM
+ * File name: ir/common/ident_t.h
+ * Purpose: Data type for unique names.
+ * Author: Goetz Lindenmaier
+ * Modified by:
+ * Created:
+ * CVS-ID: $Id$
+ * Copyright: (c) 1999-2003 Universität Karlsruhe
+ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ */
+/**
+ * @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_
# define _IDENT_H_
# include <assert.h>
# include "firm_common.h"
+/* Identifiers */
+
/**
+ * The abstract data type ident.
*
- * - identifiers in the firm library
- * Identifiers are used in the firm library. This is the interface to it.
+ * An ident represents an unique string. The == operator
+ * is sufficient to compare two idents.
*/
+typedef const struct set_entry ident;
-/* Identifiers */
/**
+ * Store a string and create an ident.
+ *
+ * Stores a string in the ident module and returns a handle for the string.
+ *
+ * Copies the string. @p str must be zero terminated
*
- * the abstract data type ident
+ * @param str - the string which shall be stored
+ *
+ * @return id - a handle for the generated ident
+ *
+ * @see get_id_str(), get_id_strlen()
*/
-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.
- * @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
+ *
+ * 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_get_id_str(), get_id_strlen()
*/
-INLINE ident *id_from_str (const char *str, int len);
+INLINE ident *id_from_str (const char *str, int len);
/**
+ * 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 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
+ * @return cp - a string
+ *
+ * @see new_get_id_str(), id_from_str(), get_id_strlen()
*/
-INLINE const char *id_to_str (ident *id);
+INLINE const char *get_id_str (ident *id);
+#define id_to_str get_id_str
/**
+ * Returns the length of the string represented by an ident.
+ *
+ * @param id - the ident
*
- * return the length of a string represented by an ident
- * Returns the length of string represented by id.
- * @param id - the ident
- * @return len - the length of the string
- * @see id_from_str, id_to_str
- * @see
+ * @return len - the length of the string
+ *
+ * @see new_get_id_str(), id_from_str(), get_id_str()
*/
-INLINE int id_to_strlen(ident *id);
-
+INLINE int get_id_strlen(ident *id);
+#define id_to_strlen get_id_strlen
/**
+ * Returns true if prefix is a prefix of an ident.
*
+ * @param prefix - the prefix
+ * @param id - the ident
*
- * 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
+ * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix()
*/
-/* */
int id_is_prefix (ident *prefix, ident *id);
/**
+ * Returns true if suffix is a suffix of an ident.
*
+ * @param suffix - the suffix
+ * @param id - the ident
*
- * 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
+ * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix()
*/
-/* */
int id_is_suffix (ident *suffix, ident *id);
/**
+ * Return true if an ident contains a given character.
*
+ * @param id - the ident
+ * @param c - the character
*
- * Prints the ident to stdout.
- * @param The ident to print.
- * @see id_from_str, id_to_str, id_is_prefix, fprint_id
- * @see
+ * @see new_get_id_str(), id_from_str(), get_id_str()
+ */
+int id_contains_char (ident *id, char c);
+
+/**
+ * Prints the ident to stdout.
+ *
+ * @param id - The ident to be printed.
+ *
+ * @return
+ * number of btes written
+ *
+ * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix(), fprint_id()
*/
-/* */
int print_id (ident *id);
/**
+ * Prints the ident to the file passed.
*
+ * @param F - file pointer to print the ident to.
+ * @param id - The ident to print and the file.
*
- * 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
+ * @return
+ * number of btes written
+ *
+ * @see new_get_id_str(), id_from_str(), get_id_str(), id_is_prefix(), print_id()
*/
-/* */
int fprint_id (FILE *F, ident *id);
-
# endif /* _IDENT_H_ */