nsz Git - cparser/blob - entity_t.h

   1 /*
   2  * This file is part of cparser.
   3  * Copyright (C) 2007-2009 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 "attribute.h"
  27 #include <libfirm/firm_types.h>
  28
  29 typedef enum {
  30         ENTITY_INVALID,
  31         ENTITY_VARIABLE,
  32         ENTITY_COMPOUND_MEMBER,
  33         ENTITY_PARAMETER,
  34         ENTITY_FUNCTION,
  35         ENTITY_TYPEDEF,
  36         ENTITY_CLASS,
  37         ENTITY_STRUCT,
  38         ENTITY_UNION,
  39         ENTITY_ENUM,
  40         ENTITY_ENUM_VALUE,
  41         ENTITY_LABEL,
  42         ENTITY_LOCAL_LABEL,
  43         ENTITY_NAMESPACE
  44 } entity_kind_tag_t;
  45 typedef unsigned char entity_kind_t;
  46
  47 typedef enum namespace_tag_t {
  48         NAMESPACE_INVALID,
  49         NAMESPACE_NORMAL,
  50         NAMESPACE_TAG,
  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_TRANSPARENT_UNION = 1 << 13,
  81         DM_CONST             = 1 << 14,
  82         DM_PURE              = 1 << 15,
  83         DM_CONSTRUCTOR       = 1 << 16,
  84         DM_DESTRUCTOR        = 1 << 17,
  85         DM_UNUSED            = 1 << 18,
  86         DM_USED              = 1 << 19,
  87         DM_CDECL             = 1 << 20,
  88         DM_FASTCALL          = 1 << 21,
  89         DM_STDCALL           = 1 << 22,
  90         DM_THISCALL          = 1 << 23,
  91         DM_DEPRECATED        = 1 << 24,
  92         DM_RETURNS_TWICE     = 1 << 25,
  93         DM_MALLOC            = 1 << 26,
  94 } decl_modifier_t;
  95
  96 /**
  97  * A scope containing entities.
  98  */
  99 struct scope_t {
 100         entity_t *entities;
 101         entity_t *last_entity; /**< pointer to last entity (so appending is fast) */
 102         unsigned  depth;       /**< while parsing, the depth of this scope in the
 103                                     scope stack. */
 104 };
 105
 106 /**
 107  * a named entity is something which can be referenced by its name
 108  * (a symbol)
 109  */
 110 struct entity_base_t {
 111         entity_kind_t       kind;
 112         entity_namespace_t  namespc;
 113         symbol_t           *symbol;
 114         source_position_t   source_position;
 115         scope_t            *parent_scope;    /**< The scope where this entity
 116                                                                                       is contained in */
 117         entity_t           *parent_entity;
 118
 119         /** next declaration in a scope */
 120         entity_t           *next;
 121         /** next declaration with same symbol */
 122         entity_t           *symbol_next;
 123 };
 124
 125 struct compound_t {
 126         entity_base_t     base;
 127         entity_t         *alias; /* used for name mangling of anonymous types */
 128         scope_t           members;
 129         decl_modifiers_t  modifiers;
 130         bool              layouted          : 1;
 131         bool              complete          : 1;
 132         bool              transparent_union : 1;
 133         bool              packed            : 1;
 134
 135         il_alignment_t    alignment;
 136         il_size_t         size;
 137
 138         /* ast2firm info */
 139         ir_type          *irtype;
 140         bool              irtype_complete : 1;
 141 };
 142
 143 struct enum_t {
 144         entity_base_t  base;
 145         entity_t      *alias; /* used for name mangling of anonymous types */
 146         bool           complete : 1;
 147
 148         /* ast2firm info */
 149         ir_type       *irtype;
 150 };
 151
 152 struct enum_value_t {
 153         entity_base_t  base;
 154         expression_t  *value;
 155         type_t        *enum_type;
 156
 157         /* ast2firm info */
 158         tarval        *tv;
 159 };
 160
 161 struct label_t {
 162         entity_base_t  base;
 163         bool           used : 1;
 164         bool           address_taken : 1;
 165         statement_t   *statement;
 166
 167         /* ast2firm info */
 168         ir_node       *block;
 169 };
 170
 171 struct namespace_t {
 172         entity_base_t  base;
 173         scope_t        members;
 174 };
 175
 176 struct typedef_t {
 177         entity_base_t     base;
 178         decl_modifiers_t  modifiers;
 179         type_t           *type;
 180         il_alignment_t    alignment;
 181         bool              builtin : 1;
 182 };
 183
 184 struct declaration_t {
 185         entity_base_t     base;
 186         type_t           *type;
 187         storage_class_t   declared_storage_class;
 188         storage_class_t   storage_class;
 189         decl_modifiers_t  modifiers;
 190         il_alignment_t    alignment;
 191         attribute_t      *attributes;
 192         bool              used     : 1;  /**< Set if the declaration is used. */
 193         bool              implicit : 1;  /**< Set for implicit (not found in source code) declarations. */
 194
 195         /* ast2firm info */
 196         unsigned char     kind;
 197 };
 198
 199 struct compound_member_t {
 200         declaration_t  base;
 201         bool           read          : 1;
 202         bool           address_taken : 1;  /**< Set if the address of this declaration was taken. */
 203         unsigned short offset;     /**< the offset of this member in the compound */
 204         unsigned char  bit_offset; /**< extra bit offset for bitfield members */
 205
 206         /* ast2firm info */
 207         ir_entity *entity;
 208 };
 209
 210 struct variable_t {
 211         declaration_t     base;
 212         bool              thread_local  : 1;  /**< GCC __thread */
 213         bool              restricta     : 1;
 214         bool              deprecated    : 1;
 215         bool              noalias       : 1;
 216
 217         bool              address_taken : 1;  /**< Set if the address of this declaration was taken. */
 218         bool              read          : 1;
 219
 220         initializer_t    *initializer;
 221
 222         /* ast2firm info */
 223         union {
 224                 unsigned int  value_number;
 225                 ir_entity    *entity;
 226                 ir_node      *vla_base;
 227         } v;
 228 };
 229
 230 struct parameter_t {
 231         declaration_t  base;
 232         bool           address_taken : 1;
 233         bool           read          : 1;
 234
 235         /* ast2firm info */
 236         union {
 237                 unsigned int  value_number;
 238                 ir_entity    *entity;
 239         } v;
 240 };
 241
 242 /**
 243  * GNU builtin or MS intrinsic functions.
 244  */
 245 typedef enum builtin_kind_t {
 246         bk_none = 0,                   /**< no builtin */
 247         bk_gnu_builtin_alloca,         /**< GNU __builtin_alloca */
 248         bk_gnu_builtin_huge_val,       /**< GNU __builtin_huge_val */
 249         bk_gnu_builtin_inf,            /**< GNU __builtin_inf */
 250         bk_gnu_builtin_inff,           /**< GNU __builtin_inff */
 251         bk_gnu_builtin_infl,           /**< GNU __builtin_infl */
 252         bk_gnu_builtin_nan,            /**< GNU __builtin_nan */
 253         bk_gnu_builtin_nanf,           /**< GNU __builtin_nanf */
 254         bk_gnu_builtin_nanl,           /**< GNU __builtin_nanl */
 255         bk_gnu_builtin_va_end,         /**< GNU __builtin_va_end */
 256         bk_gnu_builtin_expect,         /**< GNU __builtin_expect */
 257         bk_gnu_builtin_return_address, /**< GNU __builtin_return_address */
 258         bk_gnu_builtin_frame_address,  /**< GNU __builtin_frame_address */
 259         bk_gnu_builtin_ffs,            /**< GNU __builtin_ffs */
 260         bk_gnu_builtin_clz,            /**< GNU __builtin_clz */
 261         bk_gnu_builtin_ctz,            /**< GNU __builtin_ctz */
 262         bk_gnu_builtin_popcount,       /**< GNU __builtin_popcount */
 263         bk_gnu_builtin_parity,         /**< GNU __builtin_parity */
 264         bk_gnu_builtin_prefetch,       /**< GNU __builtin_prefetch */
 265         bk_gnu_builtin_trap,           /**< GNU __builtin_trap */
 266
 267         bk_ms_rotl,                    /**< MS _rotl */
 268         bk_ms_rotr,                    /**< MS _rotr */
 269         bk_ms_rotl64,                  /**< MS _rotl64 */
 270         bk_ms_rotr64,                  /**< MS _rotr64 */
 271         bk_ms_byteswap_ushort,         /**< MS _byteswap_ushort */
 272         bk_ms_byteswap_ulong,          /**< MS _byteswap_ulong */
 273         bk_ms_byteswap_uint64,         /**< MS _byteswap_uint64 */
 274
 275         bk_ms__debugbreak,             /**< MS __debugbreak */
 276         bk_ms_ReturnAddress,           /**< MS _ReturnAddress */
 277         bk_ms_AddressOfReturnAddress,  /**< MS _AddressOfReturnAddress */
 278         bk_ms__popcount,               /**< MS __popcount */
 279         bk_ms_enable,                  /**< MS _enable */
 280         bk_ms_disable,                 /**< MS _disable */
 281         bk_ms__inbyte,                 /**< MS __inbyte */
 282         bk_ms__inword,                 /**< MS __inword */
 283         bk_ms__indword,                /**< MS __indword */
 284         bk_ms__outbyte,                /**< MS __outbyte */
 285         bk_ms__outword,                /**< MS __outword */
 286         bk_ms__outdword,               /**< MS __outdword */
 287         bk_ms__ud2,                    /**< MS __ud2 */
 288         bk_ms_BitScanForward,          /**< MS _BitScanForward */
 289         bk_ms_BitScanReverse,          /**< MS _BitScanReverse */
 290         bk_ms_InterlockedExchange,     /**< MS _InterlockedExchange */
 291         bk_ms_InterlockedExchange64,   /**< MS _InterlockedExchange64 */
 292         bk_ms__readeflags,             /**< MS __readflags */
 293         bk_ms__writeeflags,            /**< MS __writeflags */
 294 } builtin_kind_t;
 295
 296 struct function_t {
 297         declaration_t  base;
 298         bool           is_inline     : 1;
 299
 300         bool           need_closure  : 1;  /**< Inner function needs closure. */
 301         bool           goto_to_outer : 1;  /**< Inner function has goto to outer function. */
 302
 303         builtin_kind_t btk;
 304         scope_t        parameters;
 305         statement_t   *statement;
 306
 307         /* ast2firm info */
 308         ir_entity     *irentity;
 309         ir_node       *static_link;        /**< if need_closure is set, the node
 310                                                 representing the static link. */
 311 };
 312
 313 union entity_t {
 314         entity_kind_t      kind;
 315         entity_base_t      base;
 316         compound_t         structe;
 317         compound_t         unione;
 318         compound_t         compound;
 319         enum_t             enume;
 320         enum_value_t       enum_value;
 321         label_t            label;
 322         namespace_t        namespacee;
 323         typedef_t          typedefe;
 324         declaration_t      declaration;
 325         variable_t         variable;
 326         parameter_t        parameter;
 327         function_t         function;
 328         compound_member_t  compound_member;
 329 };
 330
 331 #define DECLARATION_KIND_CASES        \
 332         case ENTITY_FUNCTION:             \
 333         case ENTITY_VARIABLE:             \
 334         case ENTITY_PARAMETER:            \
 335         case ENTITY_COMPOUND_MEMBER:
 336
 337 static inline bool is_declaration(const entity_t *entity)
 338 {
 339         switch(entity->kind) {
 340         DECLARATION_KIND_CASES
 341                 return true;
 342         default:
 343                 return false;
 344         }
 345 }
 346
 347 const char *get_entity_kind_name(entity_kind_t kind);
 348
 349 #endif