nsz Git - cparser/blob - entity_t.h

   1 /*
   2  * This file is part of cparser.
   3  * Copyright (C) 2007-2008 Matthias Braun <matze@braunis.de>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18  * 02111-1307, USA.
  19  */
  20 #ifndef ENTITY_T_H
  21 #define ENTITY_T_H
  22
  23 #include "lexer.h"
  24 #include "symbol.h"
  25 #include "entity.h"
  26 #include <libfirm/firm_types.h>
  27
  28 typedef enum {
  29         ENTITY_INVALID,
  30         ENTITY_VARIABLE,
  31         ENTITY_COMPOUND_MEMBER,
  32         ENTITY_PARAMETER,
  33         ENTITY_FUNCTION,
  34         ENTITY_TYPEDEF,
  35         ENTITY_STRUCT,
  36         ENTITY_UNION,
  37         ENTITY_ENUM,
  38         ENTITY_ENUM_VALUE,
  39         ENTITY_LABEL,
  40         ENTITY_LOCAL_LABEL,
  41         ENTITY_NAMESPACE
  42 } entity_kind_tag_t;
  43 typedef unsigned char entity_kind_t;
  44
  45 typedef enum namespace_tag_t {
  46         NAMESPACE_INVALID,
  47         NAMESPACE_NORMAL,
  48         NAMESPACE_STRUCT,
  49         NAMESPACE_UNION,
  50         NAMESPACE_ENUM,
  51         NAMESPACE_LABEL
  52 } namespace_tag_t;
  53 typedef unsigned char entity_namespace_t;
  54
  55 typedef enum storage_class_tag_t {
  56         STORAGE_CLASS_NONE,
  57         STORAGE_CLASS_EXTERN,
  58         STORAGE_CLASS_STATIC,
  59         STORAGE_CLASS_TYPEDEF,
  60         STORAGE_CLASS_AUTO,
  61         STORAGE_CLASS_REGISTER,
  62 } storage_class_tag_t;
  63 typedef unsigned char storage_class_t;
  64
  65 typedef enum decl_modifier_t {
  66         DM_NONE              = 0,
  67         DM_DLLIMPORT         = 1 <<  0,
  68         DM_DLLEXPORT         = 1 <<  1,
  69         DM_THREAD            = 1 <<  2,
  70         DM_NAKED             = 1 <<  3,
  71         DM_MICROSOFT_INLINE  = 1 <<  4,
  72         DM_FORCEINLINE       = 1 <<  5,
  73         DM_SELECTANY         = 1 <<  6,
  74         DM_NOTHROW           = 1 <<  7,
  75         DM_NOVTABLE          = 1 <<  8,
  76         DM_NORETURN          = 1 <<  9,
  77         DM_NOINLINE          = 1 << 10,
  78         DM_RESTRICT          = 1 << 11,
  79         DM_NOALIAS           = 1 << 12,
  80         DM_PACKED            = 1 << 13,
  81         DM_TRANSPARENT_UNION = 1 << 14,
  82         DM_CONST             = 1 << 15,
  83         DM_PURE              = 1 << 16,
  84         DM_CONSTRUCTOR       = 1 << 17,
  85         DM_DESTRUCTOR        = 1 << 18,
  86         DM_UNUSED            = 1 << 19,
  87         DM_USED              = 1 << 20,
  88         DM_CDECL             = 1 << 21,
  89         DM_FASTCALL          = 1 << 22,
  90         DM_STDCALL           = 1 << 23,
  91         DM_THISCALL          = 1 << 24,
  92         DM_DEPRECATED        = 1 << 25,
  93         DM_RETURNS_TWICE     = 1 << 26,
  94 } decl_modifier_t;
  95
  96 typedef unsigned decl_modifiers_t;
  97
  98 /**
  99  * A scope containing entities.
 100  */
 101 struct scope_t {
 102         entity_t *entities;
 103         entity_t *last_entity;
 104         unsigned  depth;        /**< while parsing, the depth of this scope in the
 105                                      scope stack. */
 106 };
 107
 108 /**
 109  * a named entity is something which can be referenced by its name
 110  * (a symbol)
 111  */
 112 struct entity_base_t {
 113         entity_kind_t       kind;
 114         entity_namespace_t  namespc;
 115         symbol_t           *symbol;
 116         source_position_t   source_position;
 117         scope_t            *parent_scope;    /**< The scope where this entity
 118                                                                                       is contained in */
 119
 120         /** next declaration in a scope */
 121         entity_t           *next;
 122         /** next declaration with same symbol */
 123         entity_t           *symbol_next;
 124 };
 125
 126 struct compound_t {
 127         entity_base_t     base;
 128         entity_t         *alias; /* used for name mangling of anonymous types */
 129         scope_t           members;
 130         decl_modifiers_t  modifiers;
 131         bool              complete            : 1;
 132
 133         /* ast2firm info */
 134         ir_type          *irtype;
 135         bool              irtype_complete : 1;
 136 };
 137
 138 struct enum_t {
 139         entity_base_t  base;
 140         entity_t      *alias; /* used for name mangling of anonymous types */
 141         bool           complete : 1;
 142
 143         /* ast2firm info */
 144         ir_type       *irtype;
 145 };
 146
 147 struct enum_value_t {
 148         entity_base_t  base;
 149         expression_t  *value;
 150         type_t        *enum_type;
 151
 152         /* ast2firm info */
 153         tarval        *tv;
 154 };
 155
 156 struct label_t {
 157         entity_base_t  base;
 158         bool           used : 1;
 159         bool           address_taken : 1;
 160         statement_t   *statement;
 161
 162         /* ast2firm info */
 163         ir_node       *block;
 164 };
 165
 166 struct namespace_t {
 167         entity_base_t  base;
 168         scope_t        members;
 169 };
 170
 171 struct typedef_t {
 172         entity_base_t     base;
 173         decl_modifiers_t  modifiers;
 174         type_t           *type;
 175         bool              builtin : 1;
 176 };
 177
 178 struct declaration_t {
 179         entity_base_t     base;
 180         storage_class_t   declared_storage_class;
 181         storage_class_t   storage_class;
 182         decl_modifiers_t  modifiers;
 183         const char       *deprecated_string;  /**< MS deprecated string if any. */
 184         bool              used          : 1;  /**< Set if the declaration is used. */
 185         bool              implicit      : 1;  /**< Set for implicit (not found in source code) declarations. */
 186         type_t           *type;
 187
 188         /* ast2firm info */
 189         unsigned char     kind;
 190 };
 191
 192 struct compound_member_t {
 193         declaration_t  base;
 194         unsigned char  alignment;
 195         bool           read          : 1;
 196         bool           address_taken : 1;  /**< Set if the address of this declaration was taken. */
 197
 198         /* ast2firm info */
 199         ir_entity *entity;
 200         il_size_t  offset;  /**< The offset of this member inside a compound. */
 201 };
 202
 203 struct variable_t {
 204         declaration_t  base;
 205         bool           thread_local  : 1;  /**< GCC __thread */
 206         bool           address_taken : 1;  /**< Set if the address of this declaration was taken. */
 207         bool           read          : 1;
 208         unsigned char  alignment;
 209         symbol_t      *get_property_sym;   /**< MS get property. */
 210         symbol_t      *put_property_sym;   /**< MS put property. */
 211
 212         initializer_t *initializer;
 213
 214         /* ast2firm info */
 215         union {
 216                 unsigned int  value_number;
 217                 ir_entity    *entity;
 218                 ir_node      *vla_base;
 219         } v;
 220 };
 221
 222 struct parameter_t {
 223         declaration_t  base;
 224         bool           address_taken : 1;
 225         bool           read          : 1;
 226
 227         /* ast2firm info */
 228         union {
 229                 unsigned int  value_number;
 230                 ir_entity    *entity;
 231         } v;
 232 };
 233
 234 /**
 235  * GNU builtin or MS intrinsic functions.
 236  */
 237 typedef enum builtin_kind_t {
 238         bk_none = 0,                   /**< no builtin */
 239         bk_gnu_builtin_alloca,         /**< GNU __builtin_alloca */
 240         bk_gnu_builtin_huge_val,       /**< GNU __builtin_huge_val */
 241         bk_gnu_builtin_inf,            /**< GNU __builtin_inf */
 242         bk_gnu_builtin_inff,           /**< GNU __builtin_inff */
 243         bk_gnu_builtin_infl,           /**< GNU __builtin_infl */
 244         bk_gnu_builtin_nan,            /**< GNU __builtin_nan */
 245         bk_gnu_builtin_nanf,           /**< GNU __builtin_nanf */
 246         bk_gnu_builtin_nanl,           /**< GNU __builtin_nanl */
 247         bk_gnu_builtin_va_end,         /**< GNU __builtin_va_end */
 248         bk_gnu_builtin_expect,         /**< GNU __builtin_expect */
 249         bk_gnu_builtin_return_address, /**< GNU __builtin_return_address */
 250         bk_gnu_builtin_frame_address,  /**< GNU __builtin_frame_address */
 251         bk_gnu_builtin_ffs,            /**< GNU __builtin_ffs */
 252         bk_gnu_builtin_clz,            /**< GNU __builtin_clz */
 253         bk_gnu_builtin_ctz,            /**< GNU __builtin_ctz */
 254         bk_gnu_builtin_popcount,       /**< GNU __builtin_popcount */
 255         bk_gnu_builtin_parity,         /**< GNU __builtin_parity */
 256         bk_gnu_builtin_prefetch,       /**< GNU __builtin_prefetch */
 257         bk_gnu_builtin_trap,           /**< GNU __builtin_trap */
 258
 259         bk_ms_rotl,                    /**< MS _rotl */
 260         bk_ms_rotr,                    /**< MS _rotr */
 261         bk_ms_rotl64,                  /**< MS _rotl64 */
 262         bk_ms_rotr64,                  /**< MS _rotr64 */
 263         bk_ms_byteswap_ushort,         /**< MS _byteswap_ushort */
 264         bk_ms_byteswap_ulong,          /**< MS _byteswap_ulong */
 265         bk_ms_byteswap_uint64,         /**< MS _byteswap_uint64 */
 266
 267         bk_ms__debugbreak,             /**< MS __debugbreak */
 268         bk_ms_ReturnAddress,           /**< MS _ReturnAddress */
 269         bk_ms__popcount,               /**< MS __popcount */
 270         bk_ms_enable,                  /**< MS _enable */
 271         bk_ms_disable,                 /**< MS _disable */
 272         bk_ms__inbyte,                 /**< MS __inbyte */
 273         bk_ms__inword,                 /**< MS __inword */
 274         bk_ms__indword,                /**< MS __indword */
 275         bk_ms__outbyte,                /**< MS __outbyte */
 276         bk_ms__outword,                /**< MS __outword */
 277         bk_ms__outdword,               /**< MS __outdword */
 278         bk_ms__ud2,                    /**< MS __ud2 */
 279         bk_ms_BitScanForward,          /**< MS _BitScanForward */
 280         bk_ms_BitScanReverse,          /**< MS _BitScanReverse */
 281         bk_ms_InterlockedExchange,     /**< MS _InterlockedExchange */
 282         bk_ms_InterlockedExchange64,   /**< MS _InterlockedExchange64 */
 283         bk_ms__readeflags,             /**< MS __readflags */
 284         bk_ms__writeeflags,            /**< MS __writeflags */
 285 } builtin_kind_t;
 286
 287 struct function_t {
 288         declaration_t  base;
 289         bool           is_inline     : 1;
 290         bool           need_closure  : 1;  /**< Inner function needs closure. */
 291         bool           goto_to_outer : 1;  /**< Inner function has goto to outer function. */
 292
 293         builtin_kind_t btk;
 294         scope_t        parameters;
 295         statement_t   *statement;
 296
 297         /* ast2firm info */
 298         ir_entity     *entity;
 299 };
 300
 301 union entity_t {
 302         entity_kind_t      kind;
 303         entity_base_t      base;
 304         compound_t         structe;
 305         compound_t         unione;
 306         compound_t         compound;
 307         enum_t             enume;
 308         enum_value_t       enum_value;
 309         label_t            label;
 310         namespace_t        namespacee;
 311         typedef_t          typedefe;
 312         declaration_t      declaration;
 313         variable_t         variable;
 314         parameter_t        parameter;
 315         function_t         function;
 316         compound_member_t  compound_member;
 317 };
 318
 319 static inline bool is_declaration(const entity_t *entity)
 320 {
 321         return entity->kind == ENTITY_FUNCTION || entity->kind == ENTITY_VARIABLE
 322                 || entity->kind == ENTITY_PARAMETER
 323                 || entity->kind == ENTITY_COMPOUND_MEMBER;
 324 }
 325
 326
 327 const char *get_entity_kind_name(entity_kind_t kind);
 328
 329 #endif