1 /* Declarations for objc-act.c.
2 Copyright (C) 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
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)
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 /*** Language hooks ***/
27 bool objc_init (void);
28 const char *objc_printable_name (tree, int);
29 void objc_finish_file (void);
30 tree objc_fold_obj_type_ref (tree, tree);
31 int objc_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
32 tree objc_eh_runtime_type (tree);
33 tree objc_eh_personality (void);
35 /* NB: The remaining public functions are prototyped in c-common.h, for the
36 benefit of stub-objc.c and objc-act.c. */
38 /* Objective-C structures */
40 #define CLASS_LANG_SLOT_ELTS 7
41 #define PROTOCOL_LANG_SLOT_ELTS 7
42 #define OBJC_INFO_SLOT_ELTS 2
45 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl_minimal.name)
46 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl_non_common.arguments)
48 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
49 #define METHOD_SEL_NAME(DECL) ((DECL)->decl_minimal.name)
50 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl_non_common.arguments)
51 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl_non_common.result)
52 #define METHOD_ADD_ARGS_ELLIPSIS_P(DECL) ((DECL)->decl_common.lang_flag_0)
53 #define METHOD_DEFINITION(DECL) ((DECL)->decl_common.initial)
54 #define METHOD_ENCODING(DECL) ((DECL)->decl_minimal.context)
55 #define METHOD_TYPE_ATTRIBUTES(DECL) ((DECL)->decl_common.abstract_origin)
56 #define METHOD_PROPERTY_CONTEXT(DECL) ((DECL)->decl_common.size_unit)
58 #define PROPERTY_NAME(DECL) ((DECL)->decl_minimal.name)
59 #define PROPERTY_GETTER_NAME(DECL) ((DECL)->decl_non_common.arguments)
60 #define PROPERTY_SETTER_NAME(DECL) ((DECL)->decl_non_common.result)
61 #define PROPERTY_IVAR_NAME(DECL) ((DECL)->decl_common.initial)
62 #define PROPERTY_READONLY(DECL) ((DECL)->decl_minimal.context)
63 #define PROPERTY_COPIES(DECL) ((DECL)->decl_common.size_unit)
65 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
66 CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
67 PROTOCOL_INTERFACE_TYPE */
68 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
69 #define CLASS_SUPER_NAME(CLASS) (TYPE_CHECK (CLASS)->type.context)
70 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
71 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
72 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
73 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
74 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
75 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
76 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
77 #define TOTAL_CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 5)
79 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
80 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
81 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
82 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
83 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
84 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
85 #define PROTOCOL_OPTIONAL_CLS_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
86 #define PROTOCOL_OPTIONAL_NST_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
88 /* For CATEGORY_INTERFACE_TYPE, CLASS_INTERFACE_TYPE or PROTOCOL_INTERFACE_TYPE */
89 #define CLASS_PROPERTY_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 6)
90 /* For CLASS_IMPLEMENTATION_TYPE or CATEGORY_IMPLEMENTATION_TYPE. */
91 #define IMPL_PROPERTY_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 6)
93 /* ObjC-specific information pertaining to RECORD_TYPEs are stored in
94 the LANG_SPECIFIC structures, which may itself need allocating first. */
96 /* The following three macros must be overridden (in objcp/objcp-decl.h)
98 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
99 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
100 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC(NODE) \
102 TYPE_LANG_SPECIFIC (NODE) \
103 = ggc_alloc_cleared_lang_type (sizeof (struct lang_type)); \
106 #define TYPE_HAS_OBJC_INFO(TYPE) \
107 (TYPE_LANG_SPECIFIC (TYPE) && TYPE_OBJC_INFO (TYPE))
108 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
109 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
112 #define INIT_TYPE_OBJC_INFO(TYPE) \
115 if (!TYPE_LANG_SPECIFIC (TYPE)) \
116 ALLOC_OBJC_TYPE_LANG_SPECIFIC(TYPE); \
117 if (!TYPE_OBJC_INFO (TYPE)) \
118 TYPE_OBJC_INFO (TYPE) \
119 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
122 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
125 ALLOC_OBJC_TYPE_LANG_SPECIFIC(DST); \
126 if (TYPE_LANG_SPECIFIC (SRC)) \
127 memcpy (TYPE_LANG_SPECIFIC (DST), \
128 TYPE_LANG_SPECIFIC (SRC), \
129 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
130 TYPE_OBJC_INFO (DST) \
131 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
135 #define TYPED_OBJECT(TYPE) \
136 (TREE_CODE (TYPE) == RECORD_TYPE \
137 && TYPE_HAS_OBJC_INFO (TYPE) \
138 && TYPE_OBJC_INTERFACE (TYPE))
139 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
140 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
142 /* Hash tables to manage the global pool of method prototypes. */
144 typedef struct hashed_entry *hash;
145 typedef struct hashed_attribute *attr;
147 struct GTY(()) hashed_attribute {
151 struct GTY(()) hashed_entry {
157 extern GTY ((length ("SIZEHASHTABLE"))) hash *nst_method_hash_list;
158 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_method_hash_list;
160 #define SIZEHASHTABLE 257
162 /* Objective-C/Objective-C++ @implementation list. */
164 struct GTY(()) imp_entry {
165 struct imp_entry *next;
168 tree class_decl; /* _OBJC_CLASS_<my_name>; */
169 tree meta_decl; /* _OBJC_METACLASS_<my_name>; */
170 BOOL_BITFIELD has_cxx_cdtors : 1;
173 extern GTY(()) struct imp_entry *imp_list;
174 extern GTY(()) int imp_count; /* `@implementation' */
175 extern GTY(()) int cat_count; /* `@category' */
177 extern GTY(()) enum tree_code objc_inherit_code;
178 extern GTY(()) objc_ivar_visibility_kind objc_ivar_visibility;
180 /* Objective-C/Objective-C++ global tree enumeration. */
185 OCTI_STATIC_NST_DECL,
192 OCTI_UMSG_SUPER_DECL,
193 OCTI_UMSG_STRET_DECL,
194 OCTI_UMSG_SUPER_STRET_DECL,
196 OCTI_GET_MCLASS_DECL,
212 OCTI_CLS_NAMES_CHAIN,
213 OCTI_METH_VAR_NAMES_CHAIN,
214 OCTI_METH_VAR_TYPES_CHAIN,
239 OCTI_UUCLS_SUPER_REF,
242 OCTI_METH_LIST_TEMPL,
243 OCTI_METH_PROTO_LIST_TEMPL,
244 OCTI_IVAR_LIST_TEMPL,
250 OCTI_METH_PROTO_TEMPL,
251 OCTI_FUNCTION1_TEMPL,
252 OCTI_FUNCTION2_TEMPL,
260 OCTI_CNST_STR_GLOB_ID,
261 OCTI_STRING_CLASS_DECL,
262 OCTI_INTERNAL_CNST_STR_TYPE,
264 OCTI_UMSG_NONNIL_DECL,
265 OCTI_UMSG_NONNIL_STRET_DECL,
267 OCTI_EXCEPTION_EXTRACT_DECL,
268 OCTI_EXCEPTION_TRY_ENTER_DECL,
269 OCTI_EXCEPTION_TRY_EXIT_DECL,
270 OCTI_EXCEPTION_MATCH_DECL,
271 OCTI_EXCEPTION_THROW_DECL,
272 OCTI_SYNC_ENTER_DECL,
276 OCTI_STACK_EXCEPTION_DATA_DECL,
277 OCTI_LOCAL_EXCEPTION_DECL,
278 OCTI_RETHROW_EXCEPTION_DECL,
283 OCTI_ASSIGN_IVAR_DECL,
284 OCTI_ASSIGN_IVAR_FAST_DECL,
285 OCTI_ASSIGN_GLOBAL_DECL,
286 OCTI_ASSIGN_STRONGCAST_DECL,
288 OCTI_FAST_ENUM_STATE_TEMP,
289 OCTI_ENUM_MUTATION_DECL,
294 extern GTY(()) tree objc_global_trees[OCTI_MAX];
296 /* List of classes with list of their static instances. */
297 #define objc_static_instances objc_global_trees[OCTI_STATIC_NST]
299 /* The declaration of the array administrating the static instances. */
300 #define static_instances_decl objc_global_trees[OCTI_STATIC_NST_DECL]
302 /* Some commonly used instances of "identifier_node". */
304 #define self_id objc_global_trees[OCTI_SELF_ID]
305 #define ucmd_id objc_global_trees[OCTI_UCMD_ID]
307 #define self_decl objc_global_trees[OCTI_SELF_DECL]
308 #define umsg_decl objc_global_trees[OCTI_UMSG_DECL]
309 #define umsg_fast_decl objc_global_trees[OCTI_UMSG_FAST_DECL]
310 #define umsg_super_decl objc_global_trees[OCTI_UMSG_SUPER_DECL]
311 #define umsg_stret_decl objc_global_trees[OCTI_UMSG_STRET_DECL]
312 #define umsg_super_stret_decl objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
313 #define objc_get_class_decl objc_global_trees[OCTI_GET_CLASS_DECL]
314 #define objc_get_meta_class_decl \
315 objc_global_trees[OCTI_GET_MCLASS_DECL]
317 #define objc_super_type objc_global_trees[OCTI_SUPER_TYPE]
318 #define objc_selector_type objc_global_trees[OCTI_SEL_TYPE]
319 #define objc_object_type objc_global_trees[OCTI_ID_TYPE]
320 #define objc_class_type objc_global_trees[OCTI_CLS_TYPE]
321 #define objc_instance_type objc_global_trees[OCTI_NST_TYPE]
322 #define objc_protocol_type objc_global_trees[OCTI_PROTO_TYPE]
324 /* Type checking macros. */
326 #define IS_ID(TYPE) \
327 (TREE_CODE (TYPE) == POINTER_TYPE \
328 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
329 == TREE_TYPE (objc_object_type)))
330 #define IS_CLASS(TYPE) \
331 (TREE_CODE (TYPE) == POINTER_TYPE \
332 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
333 == TREE_TYPE (objc_class_type)))
334 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE) \
335 ((IS_ID (TYPE) || IS_CLASS (TYPE)) \
336 && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE)) \
337 && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
338 #define IS_SUPER(TYPE) \
339 (TREE_CODE (TYPE) == POINTER_TYPE \
340 && TREE_TYPE (TYPE) == objc_super_template)
342 #define class_chain objc_global_trees[OCTI_CLS_CHAIN]
343 #define alias_chain objc_global_trees[OCTI_ALIAS_CHAIN]
344 #define interface_chain objc_global_trees[OCTI_INTF_CHAIN]
345 #define protocol_chain objc_global_trees[OCTI_PROTO_CHAIN]
346 #define implemented_classes objc_global_trees[OCTI_IMPL_CHAIN]
348 /* Chains to manage selectors that are referenced and defined in the
351 #define cls_ref_chain objc_global_trees[OCTI_CLS_REF_CHAIN] /* Classes referenced. */
352 #define sel_ref_chain objc_global_trees[OCTI_SEL_REF_CHAIN] /* Selectors referenced. */
353 #define objc_ivar_chain objc_global_trees[OCTI_IVAR_CHAIN]
355 /* Chains to manage uniquing of strings. */
357 #define class_names_chain objc_global_trees[OCTI_CLS_NAMES_CHAIN]
358 #define meth_var_names_chain objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
359 #define meth_var_types_chain objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
362 /* Backend data declarations. */
364 #define UOBJC_SYMBOLS_decl objc_global_trees[OCTI_SYMBOLS_DECL]
365 #define UOBJC_INSTANCE_VARIABLES_decl objc_global_trees[OCTI_NST_VAR_DECL]
366 #define UOBJC_CLASS_VARIABLES_decl objc_global_trees[OCTI_CLS_VAR_DECL]
367 #define UOBJC_INSTANCE_METHODS_decl objc_global_trees[OCTI_NST_METH_DECL]
368 #define UOBJC_CLASS_METHODS_decl objc_global_trees[OCTI_CLS_METH_DECL]
369 #define UOBJC_CLASS_decl objc_global_trees[OCTI_CLS_DECL]
370 #define UOBJC_METACLASS_decl objc_global_trees[OCTI_MCLS_DECL]
371 #define UOBJC_SELECTOR_TABLE_decl objc_global_trees[OCTI_SEL_TABLE_DECL]
372 #define UOBJC_MODULES_decl objc_global_trees[OCTI_MODULES_DECL]
373 #define GNU_INIT_decl objc_global_trees[OCTI_GNU_INIT_DECL]
375 /* The following are used when compiling a class implementation.
376 implementation_template will normally be an interface, however if
377 none exists this will be equal to objc_implementation_context...it is
378 set in start_class. */
380 #define objc_interface_context objc_global_trees[OCTI_INTF_CTX]
381 #define objc_implementation_context objc_global_trees[OCTI_IMPL_CTX]
382 #define objc_method_context objc_global_trees[OCTI_METH_CTX]
383 #define objc_ivar_context objc_global_trees[OCTI_IVAR_CTX]
385 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
386 #define objc_class_template objc_global_trees[OCTI_CLS_TEMPL]
387 #define objc_category_template objc_global_trees[OCTI_CAT_TEMPL]
388 #define uprivate_record objc_global_trees[OCTI_UPRIV_REC]
389 #define objc_protocol_template objc_global_trees[OCTI_PROTO_TEMPL]
390 #define objc_selector_template objc_global_trees[OCTI_SEL_TEMPL]
391 #define ucls_super_ref objc_global_trees[OCTI_UCLS_SUPER_REF]
392 #define uucls_super_ref objc_global_trees[OCTI_UUCLS_SUPER_REF]
394 #define umsg_nonnil_decl objc_global_trees[OCTI_UMSG_NONNIL_DECL]
395 #define umsg_nonnil_stret_decl objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
396 #define objc_storage_class objc_global_trees[OCTI_STORAGE_CLS]
397 #define objc_exception_extract_decl \
398 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
399 #define objc_exception_try_enter_decl \
400 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
401 #define objc_exception_try_exit_decl \
402 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
403 #define objc_exception_match_decl \
404 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
405 #define objc_exception_throw_decl \
406 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
407 #define objc_sync_enter_decl objc_global_trees[OCTI_SYNC_ENTER_DECL]
408 #define objc_sync_exit_decl objc_global_trees[OCTI_SYNC_EXIT_DECL]
409 #define objc_exception_data_template \
410 objc_global_trees[OCTI_EXCDATA_TEMPL]
411 #define objc_setjmp_decl objc_global_trees[OCTI_SETJMP_DECL]
412 #define objc_stack_exception_data \
413 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
414 #define objc_caught_exception objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
415 #define objc_rethrow_exception objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
416 #define objc_eval_once objc_global_trees[OCTI_EVAL_ONCE_DECL]
417 #define objc_catch_type objc_global_trees[OCTI_CATCH_TYPE]
419 #define execclass_decl objc_global_trees[OCTI_EXECCLASS_DECL]
421 #define objc_assign_ivar_decl objc_global_trees[OCTI_ASSIGN_IVAR_DECL]
422 #define objc_assign_ivar_fast_decl \
423 objc_global_trees[OCTI_ASSIGN_IVAR_FAST_DECL]
424 #define objc_assign_global_decl objc_global_trees[OCTI_ASSIGN_GLOBAL_DECL]
425 #define objc_assign_strong_cast_decl \
426 objc_global_trees[OCTI_ASSIGN_STRONGCAST_DECL]
428 #define objc_method_template objc_global_trees[OCTI_METH_TEMPL]
429 #define objc_ivar_template objc_global_trees[OCTI_IVAR_TEMPL]
430 #define objc_method_list_ptr objc_global_trees[OCTI_METH_LIST_TEMPL]
431 #define objc_method_proto_list_ptr \
432 objc_global_trees[OCTI_METH_PROTO_LIST_TEMPL]
433 #define objc_ivar_list_ptr objc_global_trees[OCTI_IVAR_LIST_TEMPL]
434 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
435 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
436 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
437 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
438 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
439 #define objc_method_prototype_template \
440 objc_global_trees[OCTI_METH_PROTO_TEMPL]
441 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
442 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
444 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
445 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
446 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
447 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
448 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
449 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
450 #define constant_string_global_id \
451 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
452 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
453 #define internal_const_str_type objc_global_trees[OCTI_INTERNAL_CNST_STR_TYPE]
454 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
455 #define objc_fast_enumeration_state_template \
456 objc_global_trees[OCTI_FAST_ENUM_STATE_TEMP]
457 #define objc_enumeration_mutation_decl \
458 objc_global_trees[OCTI_ENUM_MUTATION_DECL]
460 #endif /* GCC_OBJC_ACT_H */