X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fident%2Fident.h;h=e15fdabbaa829d03736f2afd56083482c5284d90;hb=184602875611495e608c27263d0a5a8f24078a70;hp=fb8eddade2228070f3ca162ebc915deee90782d8;hpb=efbeaff549fcc6015da255ed4d453a95937ff0fd;p=libfirm diff --git a/ir/ident/ident.h b/ir/ident/ident.h index fb8eddade..e15fdabba 100644 --- a/ir/ident/ident.h +++ b/ir/ident/ident.h @@ -1,75 +1,204 @@ -/* Declarations for ident. - Copyright (C) 1995, 1996 Markus Armbruster */ +/* + * 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. + */ -/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe -** All rights reserved. -** -** Authors: Martin Trapp, Christian Schaefer -*/ # ifndef _IDENT_H_ # define _IDENT_H_ -#include -#include -#include "misc.h" -#include "debug.h" -#include "set.h" - -# include "xprintf.h" -# include "xp_help.h" +# include +# include +# include "firm_common.h" /* Identifiers */ -typedef const struct set_entry ident; - -/* Caution: strings _not_ zero-terminated! */ -#define ID_FROM_STR(str, len) \ - (assert ((len) > 0), \ - (const set_entry *)set_hinsert (id_set, (str), (len), ID_HASH ((str), (len)))) -#define ID_TO_STR(id) ((const char *)&(id)->dptr[0]) -#define ID_TO_STRLEN(id) ((id)->size) -#define ID_TO_HASH(id) ((long)(id) + (id)->hash) - -ident *new_id_derived (const char *pfx, ident *); -ident *new_id_internal (void); -bool id_is_internal (ident *); -void id_init (void); - -#ifdef NDEBUG -# define ID_VRFY(id) ((void)0) -# define IDS_VRFY(id) ((void)0) -#else -# define ID_VRFY(id) \ - assert ( (id) \ - && ( !d_ (df_vrfy_level, 1) \ - || (ID_FROM_STR (ID_TO_STR((id)), ID_TO_STRLEN((id))) == (id)))) -# define IDS_VRFY(id) ids_vrfy ((id)) -void ids_vrfy (ident **id); -#endif -#ifdef STATS -# define id_stats() set_stats (id_set) -#else -# define id_stats() ((void)0) +/** + * The abstract data type ident. + * + * An ident represents an unique string. The == operator + * is sufficient to compare two idents. + */ +#ifndef _IDENT_TYPEDEF_ +#define _IDENT_TYPEDEF_ +typedef const struct s_ident ident; #endif -/* Private */ - -/* @@@ tune */ -#define ID_HASH(str, len) \ - ((( ((unsigned char *)(str))[0] * 33 \ - + ((unsigned char *)(str))[(len)>>1]) * 31 \ - + ((unsigned char *)(str))[(len)-1]) * 9 \ - + (len)) - -extern set *id_set; - - -# define id_from_str ID_FROM_STR -# define id_to_str ID_TO_STR -# define id_to_strlen ID_TO_STRLEN - - -int ident_print (XP_PAR1, const xprintf_info *, XP_PARN); +/** + * 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. + * + * Stores a string in the ident module and returns a handle for the string. + * + * 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() + */ +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 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() + */ +ident *new_id_from_chars (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 cp - a string + * + * @see new_id_from_str(), new_id_from_chars(), get_id_strlen() + */ +const char *get_id_str (ident *id); + +/** + * 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); + +/** + * 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_ */