Handle GNU extension __REDIRECT
[cparser] / 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 #include "builtins.h"
29
30 typedef enum {
31         ENTITY_INVALID,
32         ENTITY_VARIABLE,
33         ENTITY_COMPOUND_MEMBER,
34         ENTITY_PARAMETER,
35         ENTITY_FUNCTION,
36         ENTITY_TYPEDEF,
37         ENTITY_CLASS,
38         ENTITY_STRUCT,
39         ENTITY_UNION,
40         ENTITY_ENUM,
41         ENTITY_ENUM_VALUE,
42         ENTITY_LABEL,
43         ENTITY_LOCAL_LABEL,
44         ENTITY_NAMESPACE
45 } entity_kind_tag_t;
46 typedef unsigned char entity_kind_t;
47
48 typedef enum namespace_tag_t {
49         NAMESPACE_INVALID,
50         NAMESPACE_NORMAL,
51         NAMESPACE_TAG,
52         NAMESPACE_LABEL
53 } namespace_tag_t;
54 typedef unsigned char entity_namespace_t;
55
56 typedef enum storage_class_tag_t {
57         STORAGE_CLASS_NONE,
58         STORAGE_CLASS_EXTERN,
59         STORAGE_CLASS_STATIC,
60         STORAGE_CLASS_TYPEDEF,
61         STORAGE_CLASS_AUTO,
62         STORAGE_CLASS_REGISTER,
63 } storage_class_tag_t;
64 typedef unsigned char storage_class_t;
65
66 typedef enum decl_modifier_t {
67         DM_NONE              = 0,
68         DM_DLLIMPORT         = 1 <<  0,
69         DM_DLLEXPORT         = 1 <<  1,
70         DM_THREAD            = 1 <<  2,
71         DM_NAKED             = 1 <<  3,
72         DM_MICROSOFT_INLINE  = 1 <<  4,
73         DM_FORCEINLINE       = 1 <<  5,
74         DM_SELECTANY         = 1 <<  6,
75         DM_NOTHROW           = 1 <<  7,
76         DM_NOVTABLE          = 1 <<  8,
77         DM_NORETURN          = 1 <<  9,
78         DM_NOINLINE          = 1 << 10,
79         DM_RESTRICT          = 1 << 11,
80         DM_NOALIAS           = 1 << 12,
81         DM_TRANSPARENT_UNION = 1 << 13,
82         DM_CONST             = 1 << 14,
83         DM_PURE              = 1 << 15,
84         DM_CONSTRUCTOR       = 1 << 16,
85         DM_DESTRUCTOR        = 1 << 17,
86         DM_UNUSED            = 1 << 18,
87         DM_USED              = 1 << 19,
88         DM_CDECL             = 1 << 20,
89         DM_FASTCALL          = 1 << 21,
90         DM_STDCALL           = 1 << 22,
91         DM_THISCALL          = 1 << 23,
92         DM_DEPRECATED        = 1 << 24,
93         DM_RETURNS_TWICE     = 1 << 25,
94         DM_MALLOC            = 1 << 26,
95         DM_WEAK              = 1 << 27,
96 } decl_modifier_t;
97
98 /**
99  * A scope containing entities.
100  */
101 struct scope_t {
102         entity_t *entities;
103         entity_t *last_entity; /**< pointer to last entity (so appending is fast) */
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         entity_t           *parent_entity;
120
121         /** next declaration in a scope */
122         entity_t           *next;
123         /** next declaration with same symbol */
124         entity_t           *symbol_next;
125 };
126
127 struct compound_t {
128         entity_base_t     base;
129         entity_t         *alias; /* used for name mangling of anonymous types */
130         scope_t           members;
131         decl_modifiers_t  modifiers;
132         bool              layouted          : 1;
133         bool              complete          : 1;
134         bool              transparent_union : 1;
135         bool              packed            : 1;
136
137         il_alignment_t    alignment;
138         il_size_t         size;
139
140         /* ast2firm info */
141         ir_type          *irtype;
142         bool              irtype_complete : 1;
143 };
144
145 struct enum_t {
146         entity_base_t  base;
147         entity_t      *alias; /* used for name mangling of anonymous types */
148         bool           complete : 1;
149
150         /* ast2firm info */
151         ir_type       *irtype;
152 };
153
154 struct enum_value_t {
155         entity_base_t  base;
156         expression_t  *value;
157         type_t        *enum_type;
158
159         /* ast2firm info */
160         ir_tarval     *tv;
161 };
162
163 struct label_t {
164         entity_base_t  base;
165         bool           used : 1;
166         bool           address_taken : 1;
167         statement_t   *statement;
168
169         /* ast2firm info */
170         ir_node       *block;
171 };
172
173 struct namespace_t {
174         entity_base_t  base;
175         scope_t        members;
176 };
177
178 struct typedef_t {
179         entity_base_t     base;
180         decl_modifiers_t  modifiers;
181         type_t           *type;
182         il_alignment_t    alignment;
183         bool              builtin : 1;
184 };
185
186 struct declaration_t {
187         entity_base_t     base;
188         type_t           *type;
189         storage_class_t   declared_storage_class;
190         storage_class_t   storage_class;
191         decl_modifiers_t  modifiers;
192         il_alignment_t    alignment;
193         attribute_t      *attributes;
194         bool              used     : 1;  /**< Set if the declaration is used. */
195         bool              implicit : 1;  /**< Set for implicit (not found in source code) declarations. */
196
197         /* ast2firm info */
198         unsigned char     kind;
199 };
200
201 struct compound_member_t {
202         declaration_t  base;
203         il_size_t      offset;     /**< the offset of this member in the compound */
204         unsigned char  bit_offset; /**< extra bit offset for bitfield members */
205         bool           read          : 1;
206         bool           address_taken : 1;  /**< Set if the address of this
207                                                 declaration was taken. */
208
209         /* ast2firm info */
210         ir_entity *entity;
211 };
212
213 struct variable_t {
214         declaration_t     base;
215         bool              thread_local  : 1;  /**< GCC __thread */
216         bool              restricta     : 1;
217         bool              deprecated    : 1;
218         bool              noalias       : 1;
219
220         bool              address_taken : 1;  /**< Set if the address of this declaration was taken. */
221         bool              read          : 1;
222
223         initializer_t    *initializer;
224
225         /* ast2firm info */
226         union {
227                 unsigned int  value_number;
228                 ir_entity    *entity;
229                 ir_node      *vla_base;
230         } v;
231 };
232
233 struct parameter_t {
234         declaration_t  base;
235         bool           address_taken : 1;
236         bool           read          : 1;
237
238         /* ast2firm info */
239         union {
240                 unsigned int  value_number;
241                 ir_entity    *entity;
242         } v;
243 };
244
245 struct function_t {
246         declaration_t  base;
247         bool           is_inline     : 1;
248
249         bool           need_closure  : 1;  /**< Inner function needs closure. */
250         bool           goto_to_outer : 1;  /**< Inner function has goto to outer function. */
251
252         builtin_kind_t btk;
253         scope_t        parameters;
254         statement_t   *statement;
255         symbol_t      *actual_name;        /**< gnu extension __REDIRECT */
256
257         /* ast2firm info */
258         ir_entity     *irentity;
259         ir_node       *static_link;        /**< if need_closure is set, the node
260                                                 representing the static link. */
261 };
262
263 union entity_t {
264         entity_kind_t      kind;
265         entity_base_t      base;
266         compound_t         structe;
267         compound_t         unione;
268         compound_t         compound;
269         enum_t             enume;
270         enum_value_t       enum_value;
271         label_t            label;
272         namespace_t        namespacee;
273         typedef_t          typedefe;
274         declaration_t      declaration;
275         variable_t         variable;
276         parameter_t        parameter;
277         function_t         function;
278         compound_member_t  compound_member;
279 };
280
281 #define DECLARATION_KIND_CASES        \
282         case ENTITY_FUNCTION:             \
283         case ENTITY_VARIABLE:             \
284         case ENTITY_PARAMETER:            \
285         case ENTITY_COMPOUND_MEMBER:
286
287 static inline bool is_declaration(const entity_t *entity)
288 {
289         switch(entity->kind) {
290         DECLARATION_KIND_CASES
291                 return true;
292         default:
293                 return false;
294         }
295 }
296
297 const char *get_entity_kind_name(entity_kind_t kind);
298
299 entity_t *allocate_entity_zero(entity_kind_t kind);
300
301 #endif