X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fident%2Fident.h;h=e15fdabbaa829d03736f2afd56083482c5284d90;hb=184602875611495e608c27263d0a5a8f24078a70;hp=a83a1c9d425eb42d784937d8fb6e4f1daf54505c;hpb=f55b79e6e431234644133c78f7b034117a7a9a29;p=libfirm diff --git a/ir/ident/ident.h b/ir/ident/ident.h index a83a1c9d4..e15fdabba 100644 --- a/ir/ident/ident.h +++ b/ir/ident/ident.h @@ -1,12 +1,14 @@ -/* 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 * @@ -15,7 +17,6 @@ * Identifiers are used in the firm library. This is the interface to it. */ -/* $Id$ */ # ifndef _IDENT_H_ # define _IDENT_H_ @@ -26,20 +27,61 @@ /* Identifiers */ -/** - * Initialises the ident handling. - * - * Must be called before any id_*() function can be called. - */ -void id_init(void); - /** * The abstract data type ident. * * An ident represents an unique string. The == operator * is sufficient to compare two idents. */ -typedef const struct set_entry ident; +#ifndef _IDENT_TYPEDEF_ +#define _IDENT_TYPEDEF_ +typedef const struct s_ident ident; +#endif + +/** + * 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. @@ -52,25 +94,23 @@ typedef const struct set_entry ident; * * @return id - a handle for the generated ident * - * @see id_to_str(), id_to_strlen() + * @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. +/** Store a string and create an ident. * - * Copies the string. This version can take non-zero-terminated strings + * 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_to_str(), id_to_strlen() + * @see new_id_from_str(), get_id_strlen() */ -INLINE ident *id_from_str (const char *str, int len); +ident *new_id_from_chars (const char *str, int len); /** * Returns a string represented by an ident. @@ -82,9 +122,9 @@ INLINE ident *id_from_str (const char *str, int len); * * @return cp - a string * - * @see new_id_to_str(), id_from_str(), id_to_strlen() + * @see new_id_from_str(), new_id_from_chars(), get_id_strlen() */ -INLINE const char *id_to_str (ident *id); +const char *get_id_str (ident *id); /** * Returns the length of the string represented by an ident. @@ -93,17 +133,16 @@ INLINE const char *id_to_str (ident *id); * * @return len - the length of the string * - * @see new_id_to_str(), id_from_str(), id_to_str() + * @see new_id_from_str(), new_id_from_chars(), get_id_str() */ -INLINE int id_to_strlen(ident *id); - +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_to_str(), id_from_str(), id_to_str(), id_is_prefix() + * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix() */ int id_is_prefix (ident *prefix, ident *id); @@ -113,17 +152,27 @@ int id_is_prefix (ident *prefix, ident *id); * @param suffix - the suffix * @param id - the ident * - * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix() + * @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_to_str(), id_from_str(), id_to_str() + * @see new_id_from_str(), new_id_from_chars(), get_id_str() */ int id_contains_char (ident *id, char c); @@ -133,9 +182,9 @@ int id_contains_char (ident *id, char c); * @param id - The ident to be printed. * * @return - * number of btes written + * number of bytes written * - * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix(), fprint_id() + * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix(), fprint_id() */ int print_id (ident *id); @@ -148,7 +197,7 @@ int print_id (ident *id); * @return * number of btes written * - * @see new_id_to_str(), id_from_str(), id_to_str(), id_is_prefix(), print_id() + * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix(), print_id() */ int fprint_id (FILE *F, ident *id);