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 5
41 #define PROTOCOL_LANG_SLOT_ELTS 4
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)
56 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
57 CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
58 PROTOCOL_INTERFACE_TYPE */
59 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
60 #define CLASS_SUPER_NAME(CLASS) (TYPE_CHECK (CLASS)->type.context)
61 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
62 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
63 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
64 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
65 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
66 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
67 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
68 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
69 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
70 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
71 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
72 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
73 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
74 #define PROTOCOL_OPTIONAL_CLS_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
75 #define PROTOCOL_OPTIONAL_NST_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
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)
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) \
86 TYPE_LANG_SPECIFIC (NODE) \
87 = ggc_alloc_cleared_lang_type (sizeof (struct lang_type)); \
90 #define TYPE_HAS_OBJC_INFO(TYPE) \
91 (TYPE_LANG_SPECIFIC (TYPE) && TYPE_OBJC_INFO (TYPE))
92 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
93 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
96 #define INIT_TYPE_OBJC_INFO(TYPE) \
99 if (!TYPE_LANG_SPECIFIC (TYPE)) \
100 ALLOC_OBJC_TYPE_LANG_SPECIFIC(TYPE); \
101 if (!TYPE_OBJC_INFO (TYPE)) \
102 TYPE_OBJC_INFO (TYPE) \
103 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
106 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
109 ALLOC_OBJC_TYPE_LANG_SPECIFIC(DST); \
110 if (TYPE_LANG_SPECIFIC (SRC)) \
111 memcpy (TYPE_LANG_SPECIFIC (DST), \
112 TYPE_LANG_SPECIFIC (SRC), \
113 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
114 TYPE_OBJC_INFO (DST) \
115 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
119 #define TYPED_OBJECT(TYPE) \
120 (TREE_CODE (TYPE) == RECORD_TYPE \
121 && TYPE_HAS_OBJC_INFO (TYPE) \
122 && TYPE_OBJC_INTERFACE (TYPE))
123 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
124 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
126 /* Hash tables to manage the global pool of method prototypes. */
128 typedef struct hashed_entry *hash;
129 typedef struct hashed_attribute *attr;
131 struct GTY(()) hashed_attribute {
135 struct GTY(()) hashed_entry {
141 extern GTY ((length ("SIZEHASHTABLE"))) hash *nst_method_hash_list;
142 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_method_hash_list;
144 #define SIZEHASHTABLE 257
146 /* Objective-C/Objective-C++ @implementation list. */
148 struct GTY(()) imp_entry {
149 struct imp_entry *next;
152 tree class_decl; /* _OBJC_CLASS_<my_name>; */
153 tree meta_decl; /* _OBJC_METACLASS_<my_name>; */
154 BOOL_BITFIELD has_cxx_cdtors : 1;
157 extern GTY(()) struct imp_entry *imp_list;
158 extern GTY(()) int imp_count; /* `@implementation' */
159 extern GTY(()) int cat_count; /* `@category' */
161 extern GTY(()) enum tree_code objc_inherit_code;
162 extern GTY(()) int objc_public_flag;
164 /* Objective-C/Objective-C++ global tree enumeration. */
169 OCTI_STATIC_NST_DECL,
176 OCTI_UMSG_SUPER_DECL,
177 OCTI_UMSG_STRET_DECL,
178 OCTI_UMSG_SUPER_STRET_DECL,
180 OCTI_GET_MCLASS_DECL,
196 OCTI_CLS_NAMES_CHAIN,
197 OCTI_METH_VAR_NAMES_CHAIN,
198 OCTI_METH_VAR_TYPES_CHAIN,
223 OCTI_UUCLS_SUPER_REF,
226 OCTI_METH_LIST_TEMPL,
227 OCTI_METH_PROTO_LIST_TEMPL,
228 OCTI_IVAR_LIST_TEMPL,
234 OCTI_METH_PROTO_TEMPL,
235 OCTI_FUNCTION1_TEMPL,
236 OCTI_FUNCTION2_TEMPL,
244 OCTI_CNST_STR_GLOB_ID,
245 OCTI_STRING_CLASS_DECL,
246 OCTI_INTERNAL_CNST_STR_TYPE,
248 OCTI_UMSG_NONNIL_DECL,
249 OCTI_UMSG_NONNIL_STRET_DECL,
251 OCTI_EXCEPTION_EXTRACT_DECL,
252 OCTI_EXCEPTION_TRY_ENTER_DECL,
253 OCTI_EXCEPTION_TRY_EXIT_DECL,
254 OCTI_EXCEPTION_MATCH_DECL,
255 OCTI_EXCEPTION_THROW_DECL,
256 OCTI_SYNC_ENTER_DECL,
260 OCTI_STACK_EXCEPTION_DATA_DECL,
261 OCTI_LOCAL_EXCEPTION_DECL,
262 OCTI_RETHROW_EXCEPTION_DECL,
267 OCTI_ASSIGN_IVAR_DECL,
268 OCTI_ASSIGN_IVAR_FAST_DECL,
269 OCTI_ASSIGN_GLOBAL_DECL,
270 OCTI_ASSIGN_STRONGCAST_DECL,
272 OCTI_FAST_ENUM_STATE_TEMP,
273 OCTI_ENUM_MUTATION_DECL,
278 extern GTY(()) tree objc_global_trees[OCTI_MAX];
280 /* List of classes with list of their static instances. */
281 #define objc_static_instances objc_global_trees[OCTI_STATIC_NST]
283 /* The declaration of the array administrating the static instances. */
284 #define static_instances_decl objc_global_trees[OCTI_STATIC_NST_DECL]
286 /* Some commonly used instances of "identifier_node". */
288 #define self_id objc_global_trees[OCTI_SELF_ID]
289 #define ucmd_id objc_global_trees[OCTI_UCMD_ID]
291 #define self_decl objc_global_trees[OCTI_SELF_DECL]
292 #define umsg_decl objc_global_trees[OCTI_UMSG_DECL]
293 #define umsg_fast_decl objc_global_trees[OCTI_UMSG_FAST_DECL]
294 #define umsg_super_decl objc_global_trees[OCTI_UMSG_SUPER_DECL]
295 #define umsg_stret_decl objc_global_trees[OCTI_UMSG_STRET_DECL]
296 #define umsg_super_stret_decl objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
297 #define objc_get_class_decl objc_global_trees[OCTI_GET_CLASS_DECL]
298 #define objc_get_meta_class_decl \
299 objc_global_trees[OCTI_GET_MCLASS_DECL]
301 #define objc_super_type objc_global_trees[OCTI_SUPER_TYPE]
302 #define objc_selector_type objc_global_trees[OCTI_SEL_TYPE]
303 #define objc_object_type objc_global_trees[OCTI_ID_TYPE]
304 #define objc_class_type objc_global_trees[OCTI_CLS_TYPE]
305 #define objc_instance_type objc_global_trees[OCTI_NST_TYPE]
306 #define objc_protocol_type objc_global_trees[OCTI_PROTO_TYPE]
308 /* Type checking macros. */
310 #define IS_ID(TYPE) \
311 (TREE_CODE (TYPE) == POINTER_TYPE \
312 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
313 == TREE_TYPE (objc_object_type)))
314 #define IS_CLASS(TYPE) \
315 (TREE_CODE (TYPE) == POINTER_TYPE \
316 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
317 == TREE_TYPE (objc_class_type)))
318 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE) \
319 ((IS_ID (TYPE) || IS_CLASS (TYPE)) \
320 && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE)) \
321 && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
322 #define IS_SUPER(TYPE) \
323 (TREE_CODE (TYPE) == POINTER_TYPE \
324 && TREE_TYPE (TYPE) == objc_super_template)
326 #define class_chain objc_global_trees[OCTI_CLS_CHAIN]
327 #define alias_chain objc_global_trees[OCTI_ALIAS_CHAIN]
328 #define interface_chain objc_global_trees[OCTI_INTF_CHAIN]
329 #define protocol_chain objc_global_trees[OCTI_PROTO_CHAIN]
330 #define implemented_classes objc_global_trees[OCTI_IMPL_CHAIN]
332 /* Chains to manage selectors that are referenced and defined in the
335 #define cls_ref_chain objc_global_trees[OCTI_CLS_REF_CHAIN] /* Classes referenced. */
336 #define sel_ref_chain objc_global_trees[OCTI_SEL_REF_CHAIN] /* Selectors referenced. */
337 #define objc_ivar_chain objc_global_trees[OCTI_IVAR_CHAIN]
339 /* Chains to manage uniquing of strings. */
341 #define class_names_chain objc_global_trees[OCTI_CLS_NAMES_CHAIN]
342 #define meth_var_names_chain objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
343 #define meth_var_types_chain objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
346 /* Backend data declarations. */
348 #define UOBJC_SYMBOLS_decl objc_global_trees[OCTI_SYMBOLS_DECL]
349 #define UOBJC_INSTANCE_VARIABLES_decl objc_global_trees[OCTI_NST_VAR_DECL]
350 #define UOBJC_CLASS_VARIABLES_decl objc_global_trees[OCTI_CLS_VAR_DECL]
351 #define UOBJC_INSTANCE_METHODS_decl objc_global_trees[OCTI_NST_METH_DECL]
352 #define UOBJC_CLASS_METHODS_decl objc_global_trees[OCTI_CLS_METH_DECL]
353 #define UOBJC_CLASS_decl objc_global_trees[OCTI_CLS_DECL]
354 #define UOBJC_METACLASS_decl objc_global_trees[OCTI_MCLS_DECL]
355 #define UOBJC_SELECTOR_TABLE_decl objc_global_trees[OCTI_SEL_TABLE_DECL]
356 #define UOBJC_MODULES_decl objc_global_trees[OCTI_MODULES_DECL]
357 #define GNU_INIT_decl objc_global_trees[OCTI_GNU_INIT_DECL]
359 /* The following are used when compiling a class implementation.
360 implementation_template will normally be an interface, however if
361 none exists this will be equal to objc_implementation_context...it is
362 set in start_class. */
364 #define objc_interface_context objc_global_trees[OCTI_INTF_CTX]
365 #define objc_implementation_context objc_global_trees[OCTI_IMPL_CTX]
366 #define objc_method_context objc_global_trees[OCTI_METH_CTX]
367 #define objc_ivar_context objc_global_trees[OCTI_IVAR_CTX]
369 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
370 #define objc_class_template objc_global_trees[OCTI_CLS_TEMPL]
371 #define objc_category_template objc_global_trees[OCTI_CAT_TEMPL]
372 #define uprivate_record objc_global_trees[OCTI_UPRIV_REC]
373 #define objc_protocol_template objc_global_trees[OCTI_PROTO_TEMPL]
374 #define objc_selector_template objc_global_trees[OCTI_SEL_TEMPL]
375 #define ucls_super_ref objc_global_trees[OCTI_UCLS_SUPER_REF]
376 #define uucls_super_ref objc_global_trees[OCTI_UUCLS_SUPER_REF]
378 #define umsg_nonnil_decl objc_global_trees[OCTI_UMSG_NONNIL_DECL]
379 #define umsg_nonnil_stret_decl objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
380 #define objc_storage_class objc_global_trees[OCTI_STORAGE_CLS]
381 #define objc_exception_extract_decl \
382 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
383 #define objc_exception_try_enter_decl \
384 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
385 #define objc_exception_try_exit_decl \
386 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
387 #define objc_exception_match_decl \
388 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
389 #define objc_exception_throw_decl \
390 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
391 #define objc_sync_enter_decl objc_global_trees[OCTI_SYNC_ENTER_DECL]
392 #define objc_sync_exit_decl objc_global_trees[OCTI_SYNC_EXIT_DECL]
393 #define objc_exception_data_template \
394 objc_global_trees[OCTI_EXCDATA_TEMPL]
395 #define objc_setjmp_decl objc_global_trees[OCTI_SETJMP_DECL]
396 #define objc_stack_exception_data \
397 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
398 #define objc_caught_exception objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
399 #define objc_rethrow_exception objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
400 #define objc_eval_once objc_global_trees[OCTI_EVAL_ONCE_DECL]
401 #define objc_catch_type objc_global_trees[OCTI_CATCH_TYPE]
403 #define execclass_decl objc_global_trees[OCTI_EXECCLASS_DECL]
405 #define objc_assign_ivar_decl objc_global_trees[OCTI_ASSIGN_IVAR_DECL]
406 #define objc_assign_ivar_fast_decl \
407 objc_global_trees[OCTI_ASSIGN_IVAR_FAST_DECL]
408 #define objc_assign_global_decl objc_global_trees[OCTI_ASSIGN_GLOBAL_DECL]
409 #define objc_assign_strong_cast_decl \
410 objc_global_trees[OCTI_ASSIGN_STRONGCAST_DECL]
412 #define objc_method_template objc_global_trees[OCTI_METH_TEMPL]
413 #define objc_ivar_template objc_global_trees[OCTI_IVAR_TEMPL]
414 #define objc_method_list_ptr objc_global_trees[OCTI_METH_LIST_TEMPL]
415 #define objc_method_proto_list_ptr \
416 objc_global_trees[OCTI_METH_PROTO_LIST_TEMPL]
417 #define objc_ivar_list_ptr objc_global_trees[OCTI_IVAR_LIST_TEMPL]
418 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
419 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
420 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
421 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
422 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
423 #define objc_method_prototype_template \
424 objc_global_trees[OCTI_METH_PROTO_TEMPL]
425 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
426 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
428 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
429 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
430 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
431 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
432 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
433 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
434 #define constant_string_global_id \
435 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
436 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
437 #define internal_const_str_type objc_global_trees[OCTI_INTERNAL_CNST_STR_TYPE]
438 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
439 #define objc_fast_enumeration_state_template \
440 objc_global_trees[OCTI_FAST_ENUM_STATE_TEMP]
441 #define objc_enumeration_mutation_decl \
442 objc_global_trees[OCTI_ENUM_MUTATION_DECL]
444 #endif /* GCC_OBJC_ACT_H */