X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fident%2Fident.h;h=eab7d9d7a2e73087c0908d2ec0b8a78b0a98fb7e;hb=e70c22e8aa4cc93e7d72f58453c03cb9bd797e31;hp=46b31fb2370476d2fa733d48767326959a65575f;hpb=d2397bae93f29d259eb15755d2ebe876071692e1;p=libfirm diff --git a/ir/ident/ident.h b/ir/ident/ident.h index 46b31fb23..eab7d9d7a 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 * @@ -14,47 +16,142 @@ * * Identifiers are used in the firm library. This is the interface to it. */ +#ifndef _IDENT_H_ +#define _IDENT_H_ -/* $Id$ */ +#include "firm_config.h" -# ifndef _IDENT_H_ -# define _IDENT_H_ +#ifdef FIRM_ENABLE_WCHAR +#include +#endif -# include -# include -# include "firm_common.h" +#ifdef __cplusplus +extern "C" { +#endif /* 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 _ident ident; +#endif + +/** + * The ident module interface. + */ +typedef struct _ident_if_t { + /** The handle. */ + void *handle; + + /** + * 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); + +#ifdef FIRM_ENABLE_WCHAR + /** + * Store a wide character string and create an ident. + * This function may be NULL, new_id_from_wchars() + * is then used to emulate it's behavior. + * + * @param wstr - the string which shall be stored + */ + ident *(*new_id_from_wcs)(void *handle, const wchar_t *wstr); + + /** + * Store a wide character string and create an ident. + * This function may be NULL, new_id_from_chars() is then used appropriate. + * Beware: the string might not be stored at a right alignment! + * + * @param wstr - the wide character string which shall be stored + * @param len - the length of the string + */ + ident *(*new_id_from_wchars)(void *handle, const wchar_t *wstr, int len); + + /** + * Returns a wide character string represented by an ident. + * This function may be NULL, get_id_str() is then used. + * This assume that the strings are stored at an address aligned + * for wchar_t, so beware! + */ + const wchar_t *(*get_id_wcs)(void *handle, ident *id); + + /** + * Returns the length of the string represented by an ident. + * This function may be NULL, get_id_wcs() is then used + * to emulate it's behavior. + * + * @param id - the ident + */ + int (*get_id_wcslen)(void *handle, ident *id); +#endif +} 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. + * + * 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 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. @@ -66,9 +163,9 @@ INLINE ident *id_from_str (const char *str, int len); * * @return cp - a string * - * @see 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. @@ -77,9 +174,9 @@ INLINE const char *id_to_str (ident *id); * * @return len - the length of the string * - * @see 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. @@ -87,7 +184,7 @@ INLINE int id_to_strlen(ident *id); * @param prefix - the prefix * @param id - the ident * - * @see 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); @@ -97,33 +194,99 @@ int id_is_prefix (ident *prefix, ident *id); * @param suffix - the suffix * @param id - the ident * - * @see 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); /** - * Prints the ident to stdout. + * 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); + +#ifdef FIRM_ENABLE_WCHAR +/** + * Store a wide character 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 wide character string which shall be stored + * + * @return id - a handle for the generated ident * - * @param id - The ident to be printed. + * @see get_id_wcs(), get_id_wcs() + */ +ident *new_id_from_wcs (const wchar_t *str); + +/** Store a wide character 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. * - * @return - * number of btes written + * @param wstr - the wide character string (or whatever) which shall be stored + * @param len - the length of string + * + * @return id - a handle for the generated ident * - * @see id_from_str(), id_to_str(), id_is_prefix(), fprint_id() + * @see new_id_from_str(), get_id_strlen() */ -int print_id (ident *id); +ident *new_id_from_wchars (const wchar_t *str, int len); /** - * Prints the ident to the file passed. + * Returns a wide character string represented by an ident. * - * @param F - file pointer to print the ident to. - * @param id - The ident to print and the file. + * Returns the string represented by id. This string is + * NULL terminated. The string may not be changed. * - * @return - * number of btes written + * @param id - the ident * - * @see id_from_str(), id_to_str(), id_is_prefix(), print_id() + * @return cp - a string + * + * @see new_id_from_wcs(), new_id_from_wchars(), get_id_wcslen() + */ +const wchar_t *get_id_wcs(ident *id); + +/** + * Returns the length of the wide character string represented by an ident. + * + * @param id - the ident + * + * @return len - the length of the string + * + * @see new_id_from_wcs(), new_id_from_wchars(), get_id_wcs() */ -int fprint_id (FILE *F, ident *id); +int get_id_wcslen(ident *id); + +/** + * Return true if an ident contains a given character. + * + * @param id - the ident + * @param c - the character + * + * @see new_id_from_wcs(), new_id_from_chars(), get_id_str() + */ +int id_contains_wchar (ident *id, wchar_t c); + +#endif /* FIRM_ENABLE_WCHAR */ + +#ifdef __cplusplus +} +#endif # endif /* _IDENT_H_ */