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 tree objc_fold_obj_type_ref (tree, tree);
30 int objc_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
31 tree objc_eh_runtime_type (tree);
32 tree objc_eh_personality (void);
34 /* NB: The remaining public functions are prototyped in c-common.h, for the
35 benefit of stub-objc.c and objc-act.c. */
37 /* Objective-C structures */
39 #define CLASS_LANG_SLOT_ELTS 7
40 #define PROTOCOL_LANG_SLOT_ELTS 7
41 #define OBJC_INFO_SLOT_ELTS 2
44 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl_minimal.name)
45 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl_non_common.arguments)
47 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
48 #define METHOD_SEL_NAME(DECL) ((DECL)->decl_minimal.name)
49 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl_non_common.arguments)
50 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl_non_common.result)
51 #define METHOD_ADD_ARGS_ELLIPSIS_P(DECL) ((DECL)->decl_common.lang_flag_0)
52 #define METHOD_DEFINITION(DECL) ((DECL)->decl_common.initial)
53 #define METHOD_ENCODING(DECL) ((DECL)->decl_minimal.context)
54 #define METHOD_TYPE_ATTRIBUTES(DECL) ((DECL)->decl_common.abstract_origin)
55 #define METHOD_PROPERTY_CONTEXT(DECL) ((DECL)->decl_common.size_unit)
57 #define PROPERTY_NAME(DECL) ((DECL)->decl_minimal.name)
58 #define PROPERTY_GETTER_NAME(DECL) ((DECL)->decl_non_common.arguments)
59 #define PROPERTY_SETTER_NAME(DECL) ((DECL)->decl_non_common.result)
60 #define PROPERTY_IVAR_NAME(DECL) ((DECL)->decl_common.initial)
61 #define PROPERTY_READONLY(DECL) ((DECL)->decl_minimal.context)
62 #define PROPERTY_COPIES(DECL) ((DECL)->decl_common.size_unit)
64 enum objc_property_assign_semantics {
65 OBJC_PROPERTY_ASSIGN = 1,
66 OBJC_PROPERTY_RETAIN = 2,
67 OBJC_PROPERTY_COPY = 3
70 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
71 CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
72 PROTOCOL_INTERFACE_TYPE */
73 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
74 #define CLASS_SUPER_NAME(CLASS) (TYPE_CHECK (CLASS)->type.context)
75 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
76 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
77 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
78 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
79 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
80 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
81 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
82 #define TOTAL_CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 5)
84 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
85 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
86 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
87 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
88 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
89 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
90 #define PROTOCOL_OPTIONAL_CLS_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
91 #define PROTOCOL_OPTIONAL_NST_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
93 /* For CATEGORY_INTERFACE_TYPE, CLASS_INTERFACE_TYPE or PROTOCOL_INTERFACE_TYPE */
94 #define CLASS_PROPERTY_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 6)
95 /* For CLASS_IMPLEMENTATION_TYPE or CATEGORY_IMPLEMENTATION_TYPE. */
96 #define IMPL_PROPERTY_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 6)
98 /* ObjC-specific information pertaining to RECORD_TYPEs are stored in
99 the LANG_SPECIFIC structures, which may itself need allocating first. */
101 /* The following three macros must be overridden (in objcp/objcp-decl.h)
102 for Objective-C++. */
103 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
104 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
105 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC(NODE) \
107 TYPE_LANG_SPECIFIC (NODE) \
108 = ggc_alloc_cleared_lang_type (sizeof (struct lang_type)); \
111 #define TYPE_HAS_OBJC_INFO(TYPE) \
112 (TYPE_LANG_SPECIFIC (TYPE) && TYPE_OBJC_INFO (TYPE))
113 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
114 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
117 #define INIT_TYPE_OBJC_INFO(TYPE) \
120 if (!TYPE_LANG_SPECIFIC (TYPE)) \
121 ALLOC_OBJC_TYPE_LANG_SPECIFIC(TYPE); \
122 if (!TYPE_OBJC_INFO (TYPE)) \
123 TYPE_OBJC_INFO (TYPE) \
124 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
127 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
130 ALLOC_OBJC_TYPE_LANG_SPECIFIC(DST); \
131 if (TYPE_LANG_SPECIFIC (SRC)) \
132 memcpy (TYPE_LANG_SPECIFIC (DST), \
133 TYPE_LANG_SPECIFIC (SRC), \
134 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
135 TYPE_OBJC_INFO (DST) \
136 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
140 #define TYPED_OBJECT(TYPE) \
141 (TREE_CODE (TYPE) == RECORD_TYPE \
142 && TYPE_HAS_OBJC_INFO (TYPE) \
143 && TYPE_OBJC_INTERFACE (TYPE))
144 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
145 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
147 /* Hash tables to manage the global pool of method prototypes. */
149 typedef struct hashed_entry *hash;
150 typedef struct hashed_attribute *attr;
152 struct GTY(()) hashed_attribute {
156 struct GTY(()) hashed_entry {
162 extern GTY ((length ("SIZEHASHTABLE"))) hash *nst_method_hash_list;
163 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_method_hash_list;
165 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_name_hash_list;
166 extern GTY ((length ("SIZEHASHTABLE"))) hash *als_name_hash_list;
168 #define SIZEHASHTABLE 257
170 /* Objective-C/Objective-C++ @implementation list. */
172 struct GTY(()) imp_entry {
173 struct imp_entry *next;
176 tree class_decl; /* _OBJC_CLASS_<my_name>; */
177 tree meta_decl; /* _OBJC_METACLASS_<my_name>; */
178 BOOL_BITFIELD has_cxx_cdtors : 1;
181 extern GTY(()) struct imp_entry *imp_list;
182 extern GTY(()) int imp_count; /* `@implementation' */
183 extern GTY(()) int cat_count; /* `@category' */
185 extern GTY(()) objc_ivar_visibility_kind objc_ivar_visibility;
187 /* Objective-C/Objective-C++ global tree enumeration. */
192 OCTI_STATIC_NST_DECL,
199 OCTI_UMSG_SUPER_DECL,
200 OCTI_UMSG_STRET_DECL,
201 OCTI_UMSG_SUPER_STRET_DECL,
203 OCTI_GET_MCLASS_DECL,
217 OCTI_CLS_NAMES_CHAIN,
218 OCTI_METH_VAR_NAMES_CHAIN,
219 OCTI_METH_VAR_TYPES_CHAIN,
244 OCTI_UUCLS_SUPER_REF,
247 OCTI_METH_LIST_TEMPL,
248 OCTI_METH_PROTO_LIST_TEMPL,
249 OCTI_IVAR_LIST_TEMPL,
255 OCTI_METH_PROTO_TEMPL,
256 OCTI_FUNCTION1_TEMPL,
257 OCTI_FUNCTION2_TEMPL,
265 OCTI_CNST_STR_GLOB_ID,
266 OCTI_STRING_CLASS_DECL,
267 OCTI_INTERNAL_CNST_STR_TYPE,
269 OCTI_UMSG_NONNIL_DECL,
270 OCTI_UMSG_NONNIL_STRET_DECL,
272 OCTI_EXCEPTION_EXTRACT_DECL,
273 OCTI_EXCEPTION_TRY_ENTER_DECL,
274 OCTI_EXCEPTION_TRY_EXIT_DECL,
275 OCTI_EXCEPTION_MATCH_DECL,
276 OCTI_EXCEPTION_THROW_DECL,
277 OCTI_SYNC_ENTER_DECL,
281 OCTI_STACK_EXCEPTION_DATA_DECL,
282 OCTI_LOCAL_EXCEPTION_DECL,
283 OCTI_RETHROW_EXCEPTION_DECL,
288 OCTI_ASSIGN_IVAR_DECL,
289 OCTI_ASSIGN_IVAR_FAST_DECL,
290 OCTI_ASSIGN_GLOBAL_DECL,
291 OCTI_ASSIGN_STRONGCAST_DECL,
293 OCTI_FAST_ENUM_STATE_TEMP,
294 OCTI_ENUM_MUTATION_DECL,
299 extern GTY(()) tree objc_global_trees[OCTI_MAX];
301 /* List of classes with list of their static instances. */
302 #define objc_static_instances objc_global_trees[OCTI_STATIC_NST]
304 /* The declaration of the array administrating the static instances. */
305 #define static_instances_decl objc_global_trees[OCTI_STATIC_NST_DECL]
307 /* Some commonly used instances of "identifier_node". */
309 #define self_id objc_global_trees[OCTI_SELF_ID]
310 #define ucmd_id objc_global_trees[OCTI_UCMD_ID]
312 #define self_decl objc_global_trees[OCTI_SELF_DECL]
313 #define umsg_decl objc_global_trees[OCTI_UMSG_DECL]
314 #define umsg_fast_decl objc_global_trees[OCTI_UMSG_FAST_DECL]
315 #define umsg_super_decl objc_global_trees[OCTI_UMSG_SUPER_DECL]
316 #define umsg_stret_decl objc_global_trees[OCTI_UMSG_STRET_DECL]
317 #define umsg_super_stret_decl objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
318 #define objc_get_class_decl objc_global_trees[OCTI_GET_CLASS_DECL]
319 #define objc_get_meta_class_decl \
320 objc_global_trees[OCTI_GET_MCLASS_DECL]
322 #define objc_super_type objc_global_trees[OCTI_SUPER_TYPE]
323 #define objc_selector_type objc_global_trees[OCTI_SEL_TYPE]
324 #define objc_object_type objc_global_trees[OCTI_ID_TYPE]
325 #define objc_class_type objc_global_trees[OCTI_CLS_TYPE]
326 #define objc_instance_type objc_global_trees[OCTI_NST_TYPE]
327 #define objc_protocol_type objc_global_trees[OCTI_PROTO_TYPE]
329 /* Type checking macros. */
331 #define IS_ID(TYPE) \
332 (TREE_CODE (TYPE) == POINTER_TYPE \
333 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
334 == TREE_TYPE (objc_object_type)))
335 #define IS_CLASS(TYPE) \
336 (TREE_CODE (TYPE) == POINTER_TYPE \
337 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
338 == TREE_TYPE (objc_class_type)))
339 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE) \
340 ((IS_ID (TYPE) || IS_CLASS (TYPE)) \
341 && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE)) \
342 && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
343 #define IS_SUPER(TYPE) \
344 (TREE_CODE (TYPE) == POINTER_TYPE \
345 && TREE_TYPE (TYPE) == objc_super_template)
347 #define interface_chain objc_global_trees[OCTI_INTF_CHAIN]
348 #define protocol_chain objc_global_trees[OCTI_PROTO_CHAIN]
349 #define implemented_classes objc_global_trees[OCTI_IMPL_CHAIN]
351 /* Chains to manage selectors that are referenced and defined in the
354 #define cls_ref_chain objc_global_trees[OCTI_CLS_REF_CHAIN] /* Classes referenced. */
355 #define sel_ref_chain objc_global_trees[OCTI_SEL_REF_CHAIN] /* Selectors referenced. */
356 #define objc_ivar_chain objc_global_trees[OCTI_IVAR_CHAIN]
358 /* Chains to manage uniquing of strings. */
360 #define class_names_chain objc_global_trees[OCTI_CLS_NAMES_CHAIN]
361 #define meth_var_names_chain objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
362 #define meth_var_types_chain objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
365 /* Backend data declarations. */
367 #define UOBJC_SYMBOLS_decl objc_global_trees[OCTI_SYMBOLS_DECL]
368 #define UOBJC_INSTANCE_VARIABLES_decl objc_global_trees[OCTI_NST_VAR_DECL]
369 #define UOBJC_CLASS_VARIABLES_decl objc_global_trees[OCTI_CLS_VAR_DECL]
370 #define UOBJC_INSTANCE_METHODS_decl objc_global_trees[OCTI_NST_METH_DECL]
371 #define UOBJC_CLASS_METHODS_decl objc_global_trees[OCTI_CLS_METH_DECL]
372 #define UOBJC_CLASS_decl objc_global_trees[OCTI_CLS_DECL]
373 #define UOBJC_METACLASS_decl objc_global_trees[OCTI_MCLS_DECL]
374 #define UOBJC_SELECTOR_TABLE_decl objc_global_trees[OCTI_SEL_TABLE_DECL]
375 #define UOBJC_MODULES_decl objc_global_trees[OCTI_MODULES_DECL]
376 #define GNU_INIT_decl objc_global_trees[OCTI_GNU_INIT_DECL]
378 /* The following are used when compiling a class implementation.
379 implementation_template will normally be an interface, however if
380 none exists this will be equal to objc_implementation_context...it is
381 set in start_class. */
383 #define objc_interface_context objc_global_trees[OCTI_INTF_CTX]
384 #define objc_implementation_context objc_global_trees[OCTI_IMPL_CTX]
385 #define objc_method_context objc_global_trees[OCTI_METH_CTX]
386 #define objc_ivar_context objc_global_trees[OCTI_IVAR_CTX]
388 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
389 #define objc_class_template objc_global_trees[OCTI_CLS_TEMPL]
390 #define objc_category_template objc_global_trees[OCTI_CAT_TEMPL]
391 #define uprivate_record objc_global_trees[OCTI_UPRIV_REC]
392 #define objc_protocol_template objc_global_trees[OCTI_PROTO_TEMPL]
393 #define objc_selector_template objc_global_trees[OCTI_SEL_TEMPL]
394 #define ucls_super_ref objc_global_trees[OCTI_UCLS_SUPER_REF]
395 #define uucls_super_ref objc_global_trees[OCTI_UUCLS_SUPER_REF]
397 #define umsg_nonnil_decl objc_global_trees[OCTI_UMSG_NONNIL_DECL]
398 #define umsg_nonnil_stret_decl objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
399 #define objc_storage_class objc_global_trees[OCTI_STORAGE_CLS]
400 #define objc_exception_extract_decl \
401 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
402 #define objc_exception_try_enter_decl \
403 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
404 #define objc_exception_try_exit_decl \
405 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
406 #define objc_exception_match_decl \
407 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
408 #define objc_exception_throw_decl \
409 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
410 #define objc_sync_enter_decl objc_global_trees[OCTI_SYNC_ENTER_DECL]
411 #define objc_sync_exit_decl objc_global_trees[OCTI_SYNC_EXIT_DECL]
412 #define objc_exception_data_template \
413 objc_global_trees[OCTI_EXCDATA_TEMPL]
414 #define objc_setjmp_decl objc_global_trees[OCTI_SETJMP_DECL]
415 #define objc_stack_exception_data \
416 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
417 #define objc_caught_exception objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
418 #define objc_rethrow_exception objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
419 #define objc_eval_once objc_global_trees[OCTI_EVAL_ONCE_DECL]
420 #define objc_catch_type objc_global_trees[OCTI_CATCH_TYPE]
422 #define execclass_decl objc_global_trees[OCTI_EXECCLASS_DECL]
424 #define objc_assign_ivar_decl objc_global_trees[OCTI_ASSIGN_IVAR_DECL]
425 #define objc_assign_ivar_fast_decl \
426 objc_global_trees[OCTI_ASSIGN_IVAR_FAST_DECL]
427 #define objc_assign_global_decl objc_global_trees[OCTI_ASSIGN_GLOBAL_DECL]
428 #define objc_assign_strong_cast_decl \
429 objc_global_trees[OCTI_ASSIGN_STRONGCAST_DECL]
431 #define objc_method_template objc_global_trees[OCTI_METH_TEMPL]
432 #define objc_ivar_template objc_global_trees[OCTI_IVAR_TEMPL]
433 #define objc_method_list_ptr objc_global_trees[OCTI_METH_LIST_TEMPL]
434 #define objc_method_proto_list_ptr \
435 objc_global_trees[OCTI_METH_PROTO_LIST_TEMPL]
436 #define objc_ivar_list_ptr objc_global_trees[OCTI_IVAR_LIST_TEMPL]
437 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
438 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
439 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
440 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
441 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
442 #define objc_method_prototype_template \
443 objc_global_trees[OCTI_METH_PROTO_TEMPL]
444 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
445 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
447 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
448 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
449 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
450 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
451 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
452 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
453 #define constant_string_global_id \
454 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
455 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
456 #define internal_const_str_type objc_global_trees[OCTI_INTERNAL_CNST_STR_TYPE]
457 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
458 #define objc_fast_enumeration_state_template \
459 objc_global_trees[OCTI_FAST_ENUM_STATE_TEMP]
460 #define objc_enumeration_mutation_decl \
461 objc_global_trees[OCTI_ENUM_MUTATION_DECL]
463 #endif /* GCC_OBJC_ACT_H */