X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Fident.h;h=d42c6f5ecc8b96e8e19834b5b3ddf6f8d33dcb83;hb=e2e929ea04eb563b5fffadfd84bd61eb1f85735f;hp=a4b88ee78d81abc21dcd56b74ac06dc9cfea763b;hpb=c8aeb8f4758d38f1663292e77cc9c55be87439fa;p=libfirm diff --git a/include/libfirm/ident.h b/include/libfirm/ident.h index a4b88ee78..d42c6f5ec 100644 --- a/include/libfirm/ident.h +++ b/include/libfirm/ident.h @@ -22,7 +22,7 @@ * @brief Data type for unique names. * @author Goetz Lindenmaier * @version $Id$ - * @summary + * @brief * Declarations for identifiers in the firm library * * Identifiers are used in the firm library. This is the interface to it. @@ -37,24 +37,24 @@ /** * The ident module interface. */ -typedef struct _ident_if_t { +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. + * is then used to emulate its behavior. * - * @param str - the string which shall be stored + * @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 + * @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); @@ -66,9 +66,9 @@ typedef struct _ident_if_t { /** * 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. + * to emulate its behavior. * - * @param id - the ident + * @param id the ident */ int (*get_id_strlen)(void *handle, ident *id); @@ -76,7 +76,7 @@ typedef struct _ident_if_t { * Finish the ident module and frees all idents, may be NULL. */ void (*finish_ident)(void *handle); -} ident_if_t; +}; /** * Store a string and create an ident. @@ -85,9 +85,9 @@ typedef struct _ident_if_t { * * Copies the string. @p str must be zero terminated * - * @param str - the string which shall be stored + * @param str the string which shall be stored * - * @return id - a handle for the generated ident + * @return id a handle for the generated ident * * @see get_id_str(), get_id_strlen() */ @@ -98,10 +98,10 @@ ident *new_id_from_str (const char *str); * 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 + * @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 + * @return id a handle for the generated ident * * @see new_id_from_str(), get_id_strlen() */ @@ -113,9 +113,9 @@ 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 + * @param id the ident * - * @return cp - a string + * @return cp a string * * @see new_id_from_str(), new_id_from_chars(), get_id_strlen() */ @@ -124,9 +124,9 @@ const char *get_id_str (ident *id); /** * Returns the length of the string represented by an ident. * - * @param id - the ident + * @param id the ident * - * @return len - the length of the string + * @return len the length of the string * * @see new_id_from_str(), new_id_from_chars(), get_id_str() */ @@ -135,8 +135,8 @@ int get_id_strlen(ident *id); /** * Returns true if prefix is a prefix of an ident. * - * @param prefix - the prefix - * @param id - the ident + * @param prefix the prefix + * @param id the ident * * @see new_id_from_str(), new_id_from_chars(), get_id_str(), id_is_prefix() */ @@ -145,28 +145,18 @@ 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 + * @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 + * @param id the ident + * @param c the character * * @see new_id_from_str(), new_id_from_chars(), get_id_str() */ @@ -184,21 +174,21 @@ 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); +ident *id_mangle_entity (ir_entity *ent); /** mangle underscore: Returns a new ident that represents first_scnd. */ -ident *mangle_u (ident *first, ident* scnd); +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); +ident *id_mangle_dot (ident *first, ident* scnd); /** mangle: Returns a new ident that represents firstscnd. */ -ident *mangle (ident *first, ident* scnd); +ident *id_mangle (ident *first, ident* scnd); /** Returns a new ident that represents 'prefixscndsuffix'. */ -ident *mangle3 (const char *prefix, ident *middle, const char *suffix); +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); +/** returns a mangled name for a Win32 function using its calling convention */ +ident *id_decorate_win32_c_fkt(ir_entity *ent, ident *id); #endif