X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fident%2Fident.h;h=27c40684762d78cf51cd1025e9f29f272d3138bd;hb=b751adfd19f36b83ed09d00deec0602ffeba0909;hp=60623777a252d19961b20f3aab0ecf4e8bf32124;hpb=fb648cf14f79e1baffd2b4c4b705f69383e9b613;p=libfirm diff --git a/ir/ident/ident.h b/ir/ident/ident.h index 60623777a..27c406847 100644 --- a/ir/ident/ident.h +++ b/ir/ident/ident.h @@ -1,130 +1,156 @@ -/* 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" - -/****h* libfirm/ident - * - * NAME - * ident -- identifiers in the firm library - * NOTES - * Identifiers are used in the firm library. This is the interface to it. - * @@@ we need comparison of the prefis of two idents! (strncmp); - ****** - */ +# include +# include +# include "firm_common.h" /* 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 (char *str, int len); - * FUNCTION * 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. @p str must be zero terminated + * + * @param str - the string which shall be stored + * + * @return id - a handle for the generated ident + * + * @see get_id_str(), get_id_strlen() */ -inline ident *id_from_str (const char *str, int len); +ident *new_id_from_str (const char *str); -/****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 - *** +/** 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 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_id_from_str(), get_id_strlen() */ -inline const char *id_to_str (ident *id); +ident *new_id_from_chars (const char *str, int len); -/****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 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_from_str(), new_id_from_chars(), get_id_strlen() */ -inline int id_to_strlen(ident *id); +const char *get_id_str (ident *id); -/****f* ident/id_is_suffix - * - * NAME - * - * 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 - *** +/** + * Returns the length of the string represented by an ident. + * + * @param id - the ident + * + * @return len - the length of the string + * + * @see new_id_from_str(), new_id_from_chars(), get_id_str() + */ +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_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix() */ -/* */ int id_is_prefix (ident *prefix, ident *id); -/****f* ident/id_is_suffix - * - * NAME - * - * 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 - *** +/** + * Returns true if suffix is a suffix of an ident. + * + * @param suffix - the suffix + * @param id - the ident + * + * @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 contained in id. (Can be suffix or prefix) + * + * @param infix - the infix + * @param id - the ident to search in + * + * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix() + */ +/* int id_contains(ident *infix, ident *id); */ + +/** + * Return true if an ident contains a given character. + * + * @param id - the ident + * @param c - the character + * + * @see new_id_from_str(), new_id_from_chars(), 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 bytes written + * + * @see new_id_from_str(), new_id_from_chars(), 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. + * + * @return + * number of btes written + * + * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix(), print_id() + */ +int fprint_id (FILE *F, ident *id); # endif /* _IDENT_H_ */