1 /* Declarations for objc-act.c.
2 Copyright (C) 1990, 2000, 2001, 2002, 2003, 2004, 2005
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 2, 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 COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
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_types_compatible_p (tree, tree);
33 /* NB: The remaining public functions are prototyped in c-common.h, for the
34 benefit of stub-objc.c and objc-act.c. */
36 /* Objective-C structures */
38 #define CLASS_LANG_SLOT_ELTS 5
39 #define PROTOCOL_LANG_SLOT_ELTS 2
40 #define OBJC_INFO_SLOT_ELTS 2
43 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl.name)
44 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl.arguments)
46 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
47 #define METHOD_SEL_NAME(DECL) ((DECL)->decl.name)
48 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl.arguments)
49 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl.result)
50 #define METHOD_DEFINITION(DECL) ((DECL)->decl.initial)
51 #define METHOD_ENCODING(DECL) ((DECL)->decl.context)
53 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
54 CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
55 PROTOCOL_INTERFACE_TYPE */
56 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
57 #define CLASS_SUPER_NAME(CLASS) (TYPE_CHECK (CLASS)->type.context)
58 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
59 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
60 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
61 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
62 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
63 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
64 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
65 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
66 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
67 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
68 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
69 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
70 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
72 /* ObjC-specific information pertaining to RECORD_TYPEs are stored in
73 the LANG_SPECIFIC structures, which may itself need allocating first. */
74 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
75 #define TYPE_HAS_OBJC_INFO(TYPE) \
76 (TYPE_LANG_SPECIFIC (TYPE) \
77 && TYPE_LANG_SPECIFIC (TYPE)->objc_info)
78 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
79 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
81 #define INIT_TYPE_OBJC_INFO(TYPE) \
84 if (!TYPE_LANG_SPECIFIC (TYPE)) \
85 TYPE_LANG_SPECIFIC (TYPE) \
86 = ALLOC_OBJC_TYPE_LANG_SPECIFIC; \
87 if (!TYPE_LANG_SPECIFIC (TYPE)->objc_info) \
88 TYPE_LANG_SPECIFIC (TYPE)->objc_info \
89 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
92 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
95 TYPE_LANG_SPECIFIC (DST) \
96 = ALLOC_OBJC_TYPE_LANG_SPECIFIC; \
97 if (TYPE_LANG_SPECIFIC (SRC)) \
98 memcpy (TYPE_LANG_SPECIFIC (DST), \
99 TYPE_LANG_SPECIFIC (SRC), \
100 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
101 TYPE_LANG_SPECIFIC (DST)->objc_info \
102 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
106 /* The following two macros must be overridden (in objcp/objcp-decl.h)
107 for Objective-C++. */
108 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC GGC_CNEW (struct lang_type)
109 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
111 #define TYPED_OBJECT(TYPE) \
112 (TREE_CODE (TYPE) == RECORD_TYPE \
113 && TYPE_HAS_OBJC_INFO (TYPE) \
114 && TYPE_OBJC_INTERFACE (TYPE))
115 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
116 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
118 /* Define the Objective-C or Objective-C++ language-specific tree codes. */
120 #define DEFTREECODE(SYM, NAME, TYPE, LENGTH) SYM,
121 enum objc_tree_code {
122 #if defined (GCC_CP_TREE_H)
123 LAST_BASE_TREE_CODE = LAST_CPLUS_TREE_CODE,
125 #if defined (GCC_C_TREE_H)
126 LAST_BASE_TREE_CODE = LAST_C_TREE_CODE,
128 #error You must include <c-tree.h> or <cp/cp-tree.h> before <objc/objc-act.h>
131 #include "objc-tree.def"
136 /* Hash tables to manage the global pool of method prototypes. */
138 typedef struct hashed_entry *hash;
139 typedef struct hashed_attribute *attr;
141 struct hashed_attribute GTY(())
146 struct hashed_entry GTY(())
153 extern GTY ((length ("SIZEHASHTABLE"))) hash *nst_method_hash_list;
154 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_method_hash_list;
156 #define SIZEHASHTABLE 257
158 /* Objective-C/Objective-C++ @implementation list. */
160 struct imp_entry GTY(())
162 struct imp_entry *next;
165 tree class_decl; /* _OBJC_CLASS_<my_name>; */
166 tree meta_decl; /* _OBJC_METACLASS_<my_name>; */
169 extern GTY(()) struct imp_entry *imp_list;
170 extern GTY(()) int imp_count; /* `@implementation' */
171 extern GTY(()) int cat_count; /* `@category' */
173 extern GTY(()) enum tree_code objc_inherit_code;
174 extern GTY(()) int objc_public_flag;
176 /* Objective-C/Objective-C++ global tree enumeration. */
181 OCTI_STATIC_NST_DECL,
188 OCTI_UMSG_SUPER_DECL,
189 OCTI_UMSG_STRET_DECL,
190 OCTI_UMSG_SUPER_STRET_DECL,
192 OCTI_GET_MCLASS_DECL,
208 OCTI_CLS_NAMES_CHAIN,
209 OCTI_METH_VAR_NAMES_CHAIN,
210 OCTI_METH_VAR_TYPES_CHAIN,
235 OCTI_UUCLS_SUPER_REF,
243 OCTI_METH_PROTO_TEMPL,
244 OCTI_FUNCTION1_TEMPL,
245 OCTI_FUNCTION2_TEMPL,
253 OCTI_CNST_STR_GLOB_ID,
254 OCTI_STRING_CLASS_DECL,
256 OCTI_UMSG_NONNIL_DECL,
257 OCTI_UMSG_NONNIL_STRET_DECL,
259 OCTI_EXCEPTION_EXTRACT_DECL,
260 OCTI_EXCEPTION_TRY_ENTER_DECL,
261 OCTI_EXCEPTION_TRY_EXIT_DECL,
262 OCTI_EXCEPTION_MATCH_DECL,
263 OCTI_EXCEPTION_THROW_DECL,
264 OCTI_SYNC_ENTER_DECL,
268 OCTI_STACK_EXCEPTION_DATA_DECL,
269 OCTI_LOCAL_EXCEPTION_DECL,
270 OCTI_RETHROW_EXCEPTION_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]
290 #define unused_list objc_global_trees[OCTI_UNUSED_LIST]
292 #define self_decl objc_global_trees[OCTI_SELF_DECL]
293 #define umsg_decl objc_global_trees[OCTI_UMSG_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_method_template objc_global_trees[OCTI_METH_TEMPL]
406 #define objc_ivar_template objc_global_trees[OCTI_IVAR_TEMPL]
407 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
408 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
409 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
410 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
411 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
412 #define objc_method_prototype_template \
413 objc_global_trees[OCTI_METH_PROTO_TEMPL]
414 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
415 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
417 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
418 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
419 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
420 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
421 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
422 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
423 #define constant_string_global_id \
424 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
425 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
426 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
428 #endif /* GCC_OBJC_ACT_H */