Merge from trunk @ 138209
[official-gcc.git] / gcc / objc / objc-act.h
blob741401d8356e5e10f89067e9dc8282034a360926
1 /* Declarations for objc-act.c.
2 Copyright (C) 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2007
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
22 #ifndef GCC_OBJC_ACT_H
23 #define GCC_OBJC_ACT_H
25 /* For enum gimplify_status */
26 #include "gimple.h"
28 /*** Language hooks ***/
30 bool objc_init (void);
31 const char *objc_printable_name (tree, int);
32 tree objc_get_callee_fndecl (const_tree);
33 void objc_finish_file (void);
34 tree objc_fold_obj_type_ref (tree, tree);
35 enum gimplify_status objc_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
37 /* NB: The remaining public functions are prototyped in c-common.h, for the
38 benefit of stub-objc.c and objc-act.c. */
40 /* Objective-C structures */
42 #define CLASS_LANG_SLOT_ELTS 5
43 #define PROTOCOL_LANG_SLOT_ELTS 2
44 #define OBJC_INFO_SLOT_ELTS 2
46 /* KEYWORD_DECL */
47 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl_minimal.name)
48 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl_non_common.arguments)
50 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
51 #define METHOD_SEL_NAME(DECL) ((DECL)->decl_minimal.name)
52 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl_non_common.arguments)
53 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl_non_common.result)
54 #define METHOD_ADD_ARGS_ELLIPSIS_P(DECL) ((DECL)->decl_common.lang_flag_0)
55 #define METHOD_DEFINITION(DECL) ((DECL)->decl_common.initial)
56 #define METHOD_ENCODING(DECL) ((DECL)->decl_minimal.context)
58 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
59 CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
60 PROTOCOL_INTERFACE_TYPE */
61 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
62 #define CLASS_SUPER_NAME(CLASS) (TYPE_CHECK (CLASS)->type.context)
63 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
64 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
65 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
66 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
67 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
68 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
69 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
70 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
71 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
72 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
73 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
74 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
75 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
77 /* ObjC-specific information pertaining to RECORD_TYPEs are stored in
78 the LANG_SPECIFIC structures, which may itself need allocating first. */
80 /* The following three macros must be overridden (in objcp/objcp-decl.h)
81 for Objective-C++. */
82 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
83 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
84 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC(NODE) \
85 do { \
86 TYPE_LANG_SPECIFIC (NODE) = GGC_CNEW (struct lang_type); \
87 } while (0)
89 #define TYPE_HAS_OBJC_INFO(TYPE) \
90 (TYPE_LANG_SPECIFIC (TYPE) && TYPE_OBJC_INFO (TYPE))
91 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
92 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
95 #define INIT_TYPE_OBJC_INFO(TYPE) \
96 do \
97 { \
98 if (!TYPE_LANG_SPECIFIC (TYPE)) \
99 ALLOC_OBJC_TYPE_LANG_SPECIFIC(TYPE); \
100 if (!TYPE_OBJC_INFO (TYPE)) \
101 TYPE_OBJC_INFO (TYPE) \
102 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
104 while (0)
105 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
106 do \
108 ALLOC_OBJC_TYPE_LANG_SPECIFIC(DST); \
109 if (TYPE_LANG_SPECIFIC (SRC)) \
110 memcpy (TYPE_LANG_SPECIFIC (DST), \
111 TYPE_LANG_SPECIFIC (SRC), \
112 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
113 TYPE_OBJC_INFO (DST) \
114 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
116 while (0)
118 #define TYPED_OBJECT(TYPE) \
119 (TREE_CODE (TYPE) == RECORD_TYPE \
120 && TYPE_HAS_OBJC_INFO (TYPE) \
121 && TYPE_OBJC_INTERFACE (TYPE))
122 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
123 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
125 /* Hash tables to manage the global pool of method prototypes. */
127 typedef struct hashed_entry *hash;
128 typedef struct hashed_attribute *attr;
130 struct hashed_attribute GTY(())
132 attr next;
133 tree value;
135 struct hashed_entry GTY(())
137 attr list;
138 hash next;
139 tree key;
142 extern GTY ((length ("SIZEHASHTABLE"))) hash *nst_method_hash_list;
143 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_method_hash_list;
145 #define SIZEHASHTABLE 257
147 /* Objective-C/Objective-C++ @implementation list. */
149 struct imp_entry GTY(())
151 struct imp_entry *next;
152 tree imp_context;
153 tree imp_template;
154 tree class_decl; /* _OBJC_CLASS_<my_name>; */
155 tree meta_decl; /* _OBJC_METACLASS_<my_name>; */
156 BOOL_BITFIELD has_cxx_cdtors : 1;
159 extern GTY(()) struct imp_entry *imp_list;
160 extern GTY(()) int imp_count; /* `@implementation' */
161 extern GTY(()) int cat_count; /* `@category' */
163 extern GTY(()) enum tree_code objc_inherit_code;
164 extern GTY(()) int objc_public_flag;
166 /* Objective-C/Objective-C++ global tree enumeration. */
168 enum objc_tree_index
170 OCTI_STATIC_NST,
171 OCTI_STATIC_NST_DECL,
172 OCTI_SELF_ID,
173 OCTI_UCMD_ID,
175 OCTI_SELF_DECL,
176 OCTI_UMSG_DECL,
177 OCTI_UMSG_FAST_DECL,
178 OCTI_UMSG_SUPER_DECL,
179 OCTI_UMSG_STRET_DECL,
180 OCTI_UMSG_SUPER_STRET_DECL,
181 OCTI_GET_CLASS_DECL,
182 OCTI_GET_MCLASS_DECL,
183 OCTI_SUPER_TYPE,
184 OCTI_SEL_TYPE,
185 OCTI_ID_TYPE,
186 OCTI_CLS_TYPE,
187 OCTI_NST_TYPE,
188 OCTI_PROTO_TYPE,
190 OCTI_CLS_CHAIN,
191 OCTI_ALIAS_CHAIN,
192 OCTI_INTF_CHAIN,
193 OCTI_PROTO_CHAIN,
194 OCTI_IMPL_CHAIN,
195 OCTI_CLS_REF_CHAIN,
196 OCTI_SEL_REF_CHAIN,
197 OCTI_IVAR_CHAIN,
198 OCTI_CLS_NAMES_CHAIN,
199 OCTI_METH_VAR_NAMES_CHAIN,
200 OCTI_METH_VAR_TYPES_CHAIN,
202 OCTI_SYMBOLS_DECL,
203 OCTI_NST_VAR_DECL,
204 OCTI_CLS_VAR_DECL,
205 OCTI_NST_METH_DECL,
206 OCTI_CLS_METH_DECL,
207 OCTI_CLS_DECL,
208 OCTI_MCLS_DECL,
209 OCTI_SEL_TABLE_DECL,
210 OCTI_MODULES_DECL,
211 OCTI_GNU_INIT_DECL,
213 OCTI_INTF_CTX,
214 OCTI_IMPL_CTX,
215 OCTI_METH_CTX,
216 OCTI_IVAR_CTX,
218 OCTI_IMPL_TEMPL,
219 OCTI_CLS_TEMPL,
220 OCTI_CAT_TEMPL,
221 OCTI_UPRIV_REC,
222 OCTI_PROTO_TEMPL,
223 OCTI_SEL_TEMPL,
224 OCTI_UCLS_SUPER_REF,
225 OCTI_UUCLS_SUPER_REF,
226 OCTI_METH_TEMPL,
227 OCTI_IVAR_TEMPL,
228 OCTI_METH_LIST_TEMPL,
229 OCTI_METH_PROTO_LIST_TEMPL,
230 OCTI_IVAR_LIST_TEMPL,
231 OCTI_SYMTAB_TEMPL,
232 OCTI_MODULE_TEMPL,
233 OCTI_SUPER_TEMPL,
234 OCTI_OBJ_REF,
235 OCTI_CLS_REF,
236 OCTI_METH_PROTO_TEMPL,
237 OCTI_FUNCTION1_TEMPL,
238 OCTI_FUNCTION2_TEMPL,
240 OCTI_OBJ_ID,
241 OCTI_CLS_ID,
242 OCTI_ID_NAME,
243 OCTI_CLASS_NAME,
244 OCTI_CNST_STR_ID,
245 OCTI_CNST_STR_TYPE,
246 OCTI_CNST_STR_GLOB_ID,
247 OCTI_STRING_CLASS_DECL,
248 OCTI_INTERNAL_CNST_STR_TYPE,
249 OCTI_SUPER_DECL,
250 OCTI_UMSG_NONNIL_DECL,
251 OCTI_UMSG_NONNIL_STRET_DECL,
252 OCTI_STORAGE_CLS,
253 OCTI_EXCEPTION_EXTRACT_DECL,
254 OCTI_EXCEPTION_TRY_ENTER_DECL,
255 OCTI_EXCEPTION_TRY_EXIT_DECL,
256 OCTI_EXCEPTION_MATCH_DECL,
257 OCTI_EXCEPTION_THROW_DECL,
258 OCTI_SYNC_ENTER_DECL,
259 OCTI_SYNC_EXIT_DECL,
260 OCTI_SETJMP_DECL,
261 OCTI_EXCDATA_TEMPL,
262 OCTI_STACK_EXCEPTION_DATA_DECL,
263 OCTI_LOCAL_EXCEPTION_DECL,
264 OCTI_RETHROW_EXCEPTION_DECL,
265 OCTI_EVAL_ONCE_DECL,
266 OCTI_CATCH_TYPE,
267 OCTI_EXECCLASS_DECL,
269 OCTI_ASSIGN_IVAR_DECL,
270 OCTI_ASSIGN_IVAR_FAST_DECL,
271 OCTI_ASSIGN_GLOBAL_DECL,
272 OCTI_ASSIGN_STRONGCAST_DECL,
274 OCTI_MAX
277 extern GTY(()) tree objc_global_trees[OCTI_MAX];
279 /* List of classes with list of their static instances. */
280 #define objc_static_instances objc_global_trees[OCTI_STATIC_NST]
282 /* The declaration of the array administrating the static instances. */
283 #define static_instances_decl objc_global_trees[OCTI_STATIC_NST_DECL]
285 /* Some commonly used instances of "identifier_node". */
287 #define self_id objc_global_trees[OCTI_SELF_ID]
288 #define ucmd_id objc_global_trees[OCTI_UCMD_ID]
290 #define self_decl objc_global_trees[OCTI_SELF_DECL]
291 #define umsg_decl objc_global_trees[OCTI_UMSG_DECL]
292 #define umsg_fast_decl objc_global_trees[OCTI_UMSG_FAST_DECL]
293 #define umsg_super_decl objc_global_trees[OCTI_UMSG_SUPER_DECL]
294 #define umsg_stret_decl objc_global_trees[OCTI_UMSG_STRET_DECL]
295 #define umsg_super_stret_decl objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
296 #define objc_get_class_decl objc_global_trees[OCTI_GET_CLASS_DECL]
297 #define objc_get_meta_class_decl \
298 objc_global_trees[OCTI_GET_MCLASS_DECL]
300 #define objc_super_type objc_global_trees[OCTI_SUPER_TYPE]
301 #define objc_selector_type objc_global_trees[OCTI_SEL_TYPE]
302 #define objc_object_type objc_global_trees[OCTI_ID_TYPE]
303 #define objc_class_type objc_global_trees[OCTI_CLS_TYPE]
304 #define objc_instance_type objc_global_trees[OCTI_NST_TYPE]
305 #define objc_protocol_type objc_global_trees[OCTI_PROTO_TYPE]
307 /* Type checking macros. */
309 #define IS_ID(TYPE) \
310 (TREE_CODE (TYPE) == POINTER_TYPE \
311 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
312 == TREE_TYPE (objc_object_type)))
313 #define IS_CLASS(TYPE) \
314 (TREE_CODE (TYPE) == POINTER_TYPE \
315 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
316 == TREE_TYPE (objc_class_type)))
317 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE) \
318 ((IS_ID (TYPE) || IS_CLASS (TYPE)) \
319 && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE)) \
320 && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
321 #define IS_SUPER(TYPE) \
322 (TREE_CODE (TYPE) == POINTER_TYPE \
323 && TREE_TYPE (TYPE) == objc_super_template)
325 #define class_chain objc_global_trees[OCTI_CLS_CHAIN]
326 #define alias_chain objc_global_trees[OCTI_ALIAS_CHAIN]
327 #define interface_chain objc_global_trees[OCTI_INTF_CHAIN]
328 #define protocol_chain objc_global_trees[OCTI_PROTO_CHAIN]
329 #define implemented_classes objc_global_trees[OCTI_IMPL_CHAIN]
331 /* Chains to manage selectors that are referenced and defined in the
332 module. */
334 #define cls_ref_chain objc_global_trees[OCTI_CLS_REF_CHAIN] /* Classes referenced. */
335 #define sel_ref_chain objc_global_trees[OCTI_SEL_REF_CHAIN] /* Selectors referenced. */
336 #define objc_ivar_chain objc_global_trees[OCTI_IVAR_CHAIN]
338 /* Chains to manage uniquing of strings. */
340 #define class_names_chain objc_global_trees[OCTI_CLS_NAMES_CHAIN]
341 #define meth_var_names_chain objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
342 #define meth_var_types_chain objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
345 /* Backend data declarations. */
347 #define UOBJC_SYMBOLS_decl objc_global_trees[OCTI_SYMBOLS_DECL]
348 #define UOBJC_INSTANCE_VARIABLES_decl objc_global_trees[OCTI_NST_VAR_DECL]
349 #define UOBJC_CLASS_VARIABLES_decl objc_global_trees[OCTI_CLS_VAR_DECL]
350 #define UOBJC_INSTANCE_METHODS_decl objc_global_trees[OCTI_NST_METH_DECL]
351 #define UOBJC_CLASS_METHODS_decl objc_global_trees[OCTI_CLS_METH_DECL]
352 #define UOBJC_CLASS_decl objc_global_trees[OCTI_CLS_DECL]
353 #define UOBJC_METACLASS_decl objc_global_trees[OCTI_MCLS_DECL]
354 #define UOBJC_SELECTOR_TABLE_decl objc_global_trees[OCTI_SEL_TABLE_DECL]
355 #define UOBJC_MODULES_decl objc_global_trees[OCTI_MODULES_DECL]
356 #define GNU_INIT_decl objc_global_trees[OCTI_GNU_INIT_DECL]
358 /* The following are used when compiling a class implementation.
359 implementation_template will normally be an interface, however if
360 none exists this will be equal to objc_implementation_context...it is
361 set in start_class. */
363 #define objc_interface_context objc_global_trees[OCTI_INTF_CTX]
364 #define objc_implementation_context objc_global_trees[OCTI_IMPL_CTX]
365 #define objc_method_context objc_global_trees[OCTI_METH_CTX]
366 #define objc_ivar_context objc_global_trees[OCTI_IVAR_CTX]
368 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
369 #define objc_class_template objc_global_trees[OCTI_CLS_TEMPL]
370 #define objc_category_template objc_global_trees[OCTI_CAT_TEMPL]
371 #define uprivate_record objc_global_trees[OCTI_UPRIV_REC]
372 #define objc_protocol_template objc_global_trees[OCTI_PROTO_TEMPL]
373 #define objc_selector_template objc_global_trees[OCTI_SEL_TEMPL]
374 #define ucls_super_ref objc_global_trees[OCTI_UCLS_SUPER_REF]
375 #define uucls_super_ref objc_global_trees[OCTI_UUCLS_SUPER_REF]
377 #define umsg_nonnil_decl objc_global_trees[OCTI_UMSG_NONNIL_DECL]
378 #define umsg_nonnil_stret_decl objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
379 #define objc_storage_class objc_global_trees[OCTI_STORAGE_CLS]
380 #define objc_exception_extract_decl \
381 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
382 #define objc_exception_try_enter_decl \
383 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
384 #define objc_exception_try_exit_decl \
385 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
386 #define objc_exception_match_decl \
387 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
388 #define objc_exception_throw_decl \
389 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
390 #define objc_sync_enter_decl objc_global_trees[OCTI_SYNC_ENTER_DECL]
391 #define objc_sync_exit_decl objc_global_trees[OCTI_SYNC_EXIT_DECL]
392 #define objc_exception_data_template \
393 objc_global_trees[OCTI_EXCDATA_TEMPL]
394 #define objc_setjmp_decl objc_global_trees[OCTI_SETJMP_DECL]
395 #define objc_stack_exception_data \
396 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
397 #define objc_caught_exception objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
398 #define objc_rethrow_exception objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
399 #define objc_eval_once objc_global_trees[OCTI_EVAL_ONCE_DECL]
400 #define objc_catch_type objc_global_trees[OCTI_CATCH_TYPE]
402 #define execclass_decl objc_global_trees[OCTI_EXECCLASS_DECL]
404 #define objc_assign_ivar_decl objc_global_trees[OCTI_ASSIGN_IVAR_DECL]
405 #define objc_assign_ivar_fast_decl \
406 objc_global_trees[OCTI_ASSIGN_IVAR_FAST_DECL]
407 #define objc_assign_global_decl objc_global_trees[OCTI_ASSIGN_GLOBAL_DECL]
408 #define objc_assign_strong_cast_decl \
409 objc_global_trees[OCTI_ASSIGN_STRONGCAST_DECL]
411 #define objc_method_template objc_global_trees[OCTI_METH_TEMPL]
412 #define objc_ivar_template objc_global_trees[OCTI_IVAR_TEMPL]
413 #define objc_method_list_ptr objc_global_trees[OCTI_METH_LIST_TEMPL]
414 #define objc_method_proto_list_ptr \
415 objc_global_trees[OCTI_METH_PROTO_LIST_TEMPL]
416 #define objc_ivar_list_ptr objc_global_trees[OCTI_IVAR_LIST_TEMPL]
417 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
418 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
419 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
420 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
421 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
422 #define objc_method_prototype_template \
423 objc_global_trees[OCTI_METH_PROTO_TEMPL]
424 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
425 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
427 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
428 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
429 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
430 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
431 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
432 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
433 #define constant_string_global_id \
434 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
435 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
436 #define internal_const_str_type objc_global_trees[OCTI_INTERNAL_CNST_STR_TYPE]
437 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
439 #endif /* GCC_OBJC_ACT_H */