nsz Git - libfirm/blob - include/libfirm/ident.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    Data type for unique names.
  23  * @author   Goetz Lindenmaier
  24  * @brief    Declarations for identifiers in the firm library
  25  */
  26 #ifndef FIRM_IDENT_H
  27 #define FIRM_IDENT_H
  28
  29 #include <stddef.h>
  30 #include "firm_types.h"
  31 #include "begin.h"
  32
  33 /**
  34  * @defgroup ir_ident  Identifiers
  35  * @{
  36  */
  37
  38 /**
  39  *  Store a string and create an ident.
  40  *
  41  *  Stores a string in the ident module and returns a handle for the string.
  42  *
  43  *  Copies the string. @p str must be zero terminated
  44  *
  45  * @param str   the string which shall be stored
  46  * @return id   a handle for the generated ident
  47  */
  48 FIRM_API ident *new_id_from_str(const char *str);
  49
  50 /** Store a string and create an ident.
  51  *
  52  * Stores a string in the ident module and returns a handle for the string.
  53  * Copies the string. This version takes non-zero-terminated strings.
  54  *
  55  * @param str   the string (or whatever) which shall be stored
  56  * @param len   the length of the data in bytes
  57  * @return id   a handle for the generated ident
  58  */
  59 FIRM_API ident *new_id_from_chars(const char *str, size_t len);
  60
  61 /**
  62  * Returns a string represented by an ident.
  63  *
  64  * Returns the string represented by id. This string is
  65  * NULL terminated. The string may not be changed.
  66  *
  67  * @param id   the ident
  68  * @return cp   a string
  69  */
  70 FIRM_API const char *get_id_str(ident *id);
  71
  72 /**
  73  * Returns the length of the string represented by an ident.
  74  *
  75  * @param id   the ident
  76  * @return len   the length of the string
  77  */
  78 FIRM_API size_t get_id_strlen(ident *id);
  79
  80 /**
  81  * Test if @p prefix is a prefix of ident @p id.
  82  *
  83  * @param prefix   the prefix
  84  * @param id       the ident
  85  * @returns        1 if @p prefix is prefix of @p id, 0 otherwise
  86  */
  87 FIRM_API int id_is_prefix(ident *prefix, ident *id);
  88
  89 /**
  90  * Test if @p suffix is a suffix of ident @p id.
  91  *
  92  * @param suffix   the suffix
  93  * @param id       the ident
  94  * @returns        1 if @p suffix is suffix of @p id, 0 otherwise
  95  */
  96 FIRM_API int id_is_suffix(ident *suffix, ident *id);
  97
  98 /**
  99  * Test if identifier contains a given character.
 100  *
 101  * @param id    the ident
 102  * @param c     the character
 103  * @returns     1 if character is contained, 0 otherwise
 104  */
 105 FIRM_API int id_contains_char(ident *id, char c);
 106
 107 /**
 108  * helper function for creating unique idents. It contains an internal counter
 109  * and replaces a "%u" inside the tag with the counter.
 110  */
 111 FIRM_API ident *id_unique(const char *tag);
 112
 113 /** Computes a definite name for this entity by concatenating
 114    the name of the owner type and the name of the entity with
 115    a separating "_". */
 116 FIRM_API ident *id_mangle_entity(const ir_entity *ent);
 117
 118 /** mangle underscore: Returns a new ident that represents first_scnd. */
 119 FIRM_API ident *id_mangle_u(ident *first, ident* scnd);
 120
 121 /** mangle dot: Returns a new ident that represents first.scnd. */
 122 FIRM_API ident *id_mangle_dot(ident *first, ident* scnd);
 123
 124 /** mangle: Returns a new ident that represents firstscnd. */
 125 FIRM_API ident *id_mangle(ident *first, ident* scnd);
 126
 127 /** Returns a new ident that represents 'prefixscndsuffix'. */
 128 FIRM_API ident *id_mangle3(const char *prefix, ident *middle,
 129                            const char *suffix);
 130
 131 /** returns a mangled name for a Win32 function using its calling convention */
 132 FIRM_API ident *id_decorate_win32_c_fkt(const ir_entity *ent, ident *id);
 133
 134 /** @} */
 135
 136 #include "end.h"
 137
 138 #endif