X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Fident.h;h=f77e6daa2881e6177c13b86c08bf6802385df012;hb=3d61544bd177bdb8c880ee87f5cdad2b7d1606e5;hp=5296f339eb278cca6f995f3f00706955fe8ff3ef;hpb=d11427731d82eb4392500d59c7432eefd24e08da;p=libfirm diff --git a/include/libfirm/ident.h b/include/libfirm/ident.h index 5296f339e..f77e6daa2 100644 --- a/include/libfirm/ident.h +++ b/include/libfirm/ident.h @@ -21,105 +21,19 @@ * @file * @brief Data type for unique names. * @author Goetz Lindenmaier - * @version $Id$ - * @summary - * Declarations for identifiers in the firm library - * - * Identifiers are used in the firm library. This is the interface to it. + * @brief Declarations for identifiers in the firm library */ -#ifndef FIRM_IDENT_IDENT_H -#define FIRM_IDENT_IDENT_H +#ifndef FIRM_IDENT_H +#define FIRM_IDENT_H -#include "firm_config.h" +#include #include "firm_types.h" - -#ifdef FIRM_ENABLE_WCHAR -#include -#endif - -/* Identifiers */ +#include "begin.h" /** - * The ident module interface. + * @defgroup ir_ident Identifiers + * @{ */ -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. @@ -128,27 +42,21 @@ typedef struct _ident_if_t { * * 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() + * @param str the string which shall be stored + * @return id a handle for the generated ident */ -ident *new_id_from_str (const char *str); +FIRM_API 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() + * @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 */ -ident *new_id_from_chars (const char *str, int len); +FIRM_API ident *new_id_from_chars(const char *str, size_t len); /** * Returns a string represented by an ident. @@ -156,159 +64,67 @@ ident *new_id_from_chars (const char *str, int len); * 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() + * @param id the ident + * @return cp a string */ -const char *get_id_str (ident *id); +FIRM_API 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() + * @param id the ident + * @return len the length of the string */ -int id_is_prefix (ident *prefix, ident *id); +FIRM_API size_t get_id_strlen(ident *id); /** - * Returns true if suffix is a suffix of an ident. + * Test if @p prefix is a prefix of ident @p id. * - * @param suffix - the suffix - * @param id - the ident - * - * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix() + * @param prefix the prefix + * @param id the ident + * @returns 1 if @p prefix is prefix of @p id, 0 otherwise */ -int id_is_suffix (ident *suffix, ident *id); +FIRM_API int id_is_prefix(ident *prefix, 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 + * Test if @p suffix is a suffix of ident @p id. * - * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix() + * @param suffix the suffix + * @param id the ident + * @returns 1 if @p suffix is suffix of @p id, 0 otherwise */ -/* int id_contains(ident *infix, ident *id); */ +FIRM_API 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 + * Test if identifier contains a given character. * - * @see new_id_from_str(), new_id_from_chars(), get_id_str() + * @param id the ident + * @param c the character + * @returns 1 if character is contained, 0 otherwise */ -int id_contains_char (ident *id, char c); +FIRM_API int id_contains_char(ident *id, char c); /** * helper function for creating unique idents. It contains an internal counter * and replaces a "%u" inside the tag with the counter. */ -ident *id_unique(const char *tag); - -#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 - * - * @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. - * - * @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 new_id_from_str(), get_id_strlen() - */ -ident *new_id_from_wchars (const wchar_t *str, int len); - -/** - * Returns a wide character 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_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 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 */ - -/** initializes the name mangling code */ -void firm_init_mangle (void); - -/** Computes a definite name for this entity by concatenating - the name of the owner type and the name of the entity with - a separating "_". */ -ident *mangle_entity (ir_entity *ent); +FIRM_API ident *id_unique(const char *tag); /** mangle underscore: Returns a new ident that represents first_scnd. */ -ident *mangle_u (ident *first, ident* scnd); +FIRM_API ident *id_mangle_u(ident *first, ident* scnd); /** mangle dot: Returns a new ident that represents first.scnd. */ -ident *mangle_dot (ident *first, ident* scnd); +FIRM_API ident *id_mangle_dot(ident *first, ident* scnd); /** mangle: Returns a new ident that represents firstscnd. */ -ident *mangle (ident *first, ident* scnd); +FIRM_API ident *id_mangle(ident *first, ident* scnd); /** Returns a new ident that represents 'prefixscndsuffix'. */ -ident *mangle3 (const char *prefix, ident *middle, const char *suffix); +FIRM_API ident *id_mangle3(const char *prefix, ident *middle, + const char *suffix); + +/** @} */ -/** returns a mangled name for a Win32 function using it's calling convention */ -ident *decorate_win32_c_fkt(ir_entity *ent, ident *id); +#include "end.h" #endif