X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fident%2Fident.h;h=0cfd0235cadefd4463db8e3913e34ff3b8c22c43;hb=e3fdbd41ed77d327784775db5ba8f6577da45abe;hp=e03d2e6fb95990986fea7ead18c653b9da3b1ac2;hpb=677f67f9b487e35b983148f48b933d54ee383db6;p=libfirm diff --git a/ir/ident/ident.h b/ir/ident/ident.h index e03d2e6fb..0cfd0235c 100644 --- a/ir/ident/ident.h +++ b/ir/ident/ident.h @@ -1,166 +1,303 @@ -/* Declarations for ident. - Copyright (C) 1995, 1996 Markus Armbruster */ +/* + * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved. + * + * This file is part of libFirm. + * + * This file may be distributed and/or modified under the terms of the + * GNU General Public License version 2 as published by the Free Software + * Foundation and appearing in the file LICENSE.GPL included in the + * packaging of this file. + * + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. + * + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. + */ -/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe -** All rights reserved. -** -** Authors: Martin Trapp, Christian Schaefer -*/ +/** + * @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. + */ +#ifndef FIRM_IDENT_IDENT_H +#define FIRM_IDENT_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 */ -/****h* libfirm/ident +/** + * The abstract data type ident. * - * NAME - * ident -- identifiers in the firm library - * NOTES - * Identifiers are used in the firm library. This is the interface to it. - ****** + * An ident represents an unique string. The == operator + * is sufficient to compare two idents. */ +#ifndef _IDENT_TYPEDEF_ +#define _IDENT_TYPEDEF_ +typedef const struct _ident ident; +#endif -/* Identifiers */ -/****s* ident/ident - * - * NAME - * ident - the abstract data type ident - * SOURCE +/** + * The ident module interface. */ -typedef const struct set_entry ident; -/*****/ +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); -/****f* ident/id_from_str + /** + * 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. * - * NAME - * id_from_str - store a string and create an ident - * SYNOPSIS - * ident *id = id_from_str (const char *str, int len); - * FUNCTION * Stores a string in the ident module and returns a handle for the string. - * Copies the string. - * INPUTS - * str - the string (or whatever) which shall be stored - * len - the length of the data in bytes - * RESULT - * id - a handle for the generated ident - * SEE ALSO - * id_to_str, id_to_strlen - *** - */ -INLINE ident *id_from_str (const char *str, int len); - -/****f* ident/id_to_str - * - * NAME - * id_to_str - return a string represented by an ident - * SYNOPSIS - * char *cp = id_to_str (ident *id); - * FUNCTION - * Returns the string cp represented by id. This string cp is not - * Null terminated! The string may not be changed. - * INPUTS - * id - the ident - * RESULT - * cp - a string - * SEE ALSO - * id_from_str, id_to_strlen - *** - */ -INLINE const char *id_to_str (ident *id); - -/****f* ident/id_to_strlen - * - * NAME - * id_to_strlen - return the length of a string represented by an ident - * SYNOPSIS - * int len = id_to_strlen (ident *id); - * FUNCTION - * Returns the length of string represented by id. - * INPUTS - * id - the ident - * RESULT - * len - the length of the string - * SEE ALSO - * id_from_str, id_to_str - *** - */ -INLINE int id_to_strlen(ident *id); - -/****f* ident/id_is_suffix - * - * NAME - * - * SYNOPSIS - * int id_is_prefix (ident *prefix, ident *id); - * FUNCTION - * Returns true if prefix is prefix of id. - * INPUTS - * prefix - the prefix - * id - the ident - * SEE ALSO - * id_from_str, id_to_str, id_is_prefix - *** - */ -/* */ + * + * 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); -/****f* ident/id_is_suffix +/** + * Returns true if suffix is a suffix of an ident. * - * NAME + * @param suffix - the suffix + * @param id - the ident * - * SYNOPSIS - * int id_is_suffix (ident *suffix, ident *id); - * FUNCTION - * Returns true if suffix is suffix of id. - * INPUTS - * suffix - the suffix - * id - the ident - * SEE ALSO - * 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); -/****f* ident/print_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. * - * NAME + * @param id - the ident + * @param c - the character * - * SYNOPSIS - * int print_id (ident *id); - * FUNCTION - * Prints the ident to stdout. - * INPUTS - * The ident to print. - * SEE ALSO - * id_from_str, id_to_str, id_is_prefix, fprint_id - *** + * @see new_id_from_str(), new_id_from_chars(), get_id_str() */ -/* */ -int print_id (ident *id); +int id_contains_char (ident *id, char c); -/****f* ident/fprint_id +#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. * - * NAME + * Copies the string. @p str must be zero terminated * - * SYNOPSIS - * int fprint_id (FILE *f, ident *id); - * FUNCTION - * Prints the ident to the file passed. - * INPUTS - * The ident to print and the file. - * SEE ALSO - * id_from_str, id_to_str, id_is_prefix, print_id - *** + * @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() */ -/* */ -int fprint_id (FILE *F, ident *id); +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 */ +#ifdef __cplusplus +} +#endif -# endif /* _IDENT_H_ */ +#endif