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 /* For enum gimplify_status */
26 #include "tree-gimple.h"
28 /*** Language hooks ***/
30 bool objc_init (void);
31 const char *objc_printable_name (tree
, int);
32 tree
objc_get_callee_fndecl (tree
);
33 void objc_finish_file (void);
34 tree
objc_fold_obj_type_ref (tree
, tree
);
35 int objc_types_compatible_p (tree
, tree
);
36 enum gimplify_status
objc_gimplify_expr (tree
*, tree
*, tree
*);
38 /* NB: The remaining public functions are prototyped in c-common.h, for the
39 benefit of stub-objc.c and objc-act.c. */
41 /* Objective-C structures */
43 #define CLASS_LANG_SLOT_ELTS 5
44 #define PROTOCOL_LANG_SLOT_ELTS 2
45 #define OBJC_INFO_SLOT_ELTS 2
48 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl.name)
49 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl.arguments)
51 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
52 #define METHOD_SEL_NAME(DECL) ((DECL)->decl.name)
53 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl.arguments)
54 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl.result)
55 #define METHOD_DEFINITION(DECL) ((DECL)->decl.initial)
56 #define METHOD_ENCODING(DECL) ((DECL)->decl.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. */
79 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
80 #define TYPE_HAS_OBJC_INFO(TYPE) \
81 (TYPE_LANG_SPECIFIC (TYPE) \
82 && TYPE_LANG_SPECIFIC (TYPE)->objc_info)
83 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
84 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
86 #define INIT_TYPE_OBJC_INFO(TYPE) \
89 if (!TYPE_LANG_SPECIFIC (TYPE)) \
90 TYPE_LANG_SPECIFIC (TYPE) \
91 = ALLOC_OBJC_TYPE_LANG_SPECIFIC; \
92 if (!TYPE_LANG_SPECIFIC (TYPE)->objc_info) \
93 TYPE_LANG_SPECIFIC (TYPE)->objc_info \
94 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
97 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
100 TYPE_LANG_SPECIFIC (DST) \
101 = ALLOC_OBJC_TYPE_LANG_SPECIFIC; \
102 if (TYPE_LANG_SPECIFIC (SRC)) \
103 memcpy (TYPE_LANG_SPECIFIC (DST), \
104 TYPE_LANG_SPECIFIC (SRC), \
105 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
106 TYPE_LANG_SPECIFIC (DST)->objc_info \
107 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
111 /* The following two macros must be overridden (in objcp/objcp-decl.h)
112 for Objective-C++. */
113 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC GGC_CNEW (struct lang_type)
114 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
116 #define TYPED_OBJECT(TYPE) \
117 (TREE_CODE (TYPE) == RECORD_TYPE \
118 && TYPE_HAS_OBJC_INFO (TYPE) \
119 && TYPE_OBJC_INTERFACE (TYPE))
120 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
121 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
123 /* Define the Objective-C or Objective-C++ language-specific tree codes. */
125 #define DEFTREECODE(SYM, NAME, TYPE, LENGTH) SYM,
126 enum objc_tree_code
{
127 #if defined (GCC_CP_TREE_H)
128 LAST_BASE_TREE_CODE
= LAST_CPLUS_TREE_CODE
,
130 #if defined (GCC_C_TREE_H)
131 LAST_BASE_TREE_CODE
= LAST_C_TREE_CODE
,
133 #error You must include <c-tree.h> or <cp/cp-tree.h> before <objc/objc-act.h>
136 #include "objc-tree.def"
141 /* Hash tables to manage the global pool of method prototypes. */
143 typedef struct hashed_entry
*hash
;
144 typedef struct hashed_attribute
*attr
;
146 struct hashed_attribute
GTY(())
151 struct hashed_entry
GTY(())
158 extern GTY ((length ("SIZEHASHTABLE"))) hash
*nst_method_hash_list
;
159 extern GTY ((length ("SIZEHASHTABLE"))) hash
*cls_method_hash_list
;
161 #define SIZEHASHTABLE 257
163 /* Objective-C/Objective-C++ @implementation list. */
165 struct imp_entry
GTY(())
167 struct imp_entry
*next
;
170 tree class_decl
; /* _OBJC_CLASS_<my_name>; */
171 tree meta_decl
; /* _OBJC_METACLASS_<my_name>; */
174 extern GTY(()) struct imp_entry
*imp_list
;
175 extern GTY(()) int imp_count
; /* `@implementation' */
176 extern GTY(()) int cat_count
; /* `@category' */
178 extern GTY(()) enum tree_code objc_inherit_code
;
179 extern GTY(()) int objc_public_flag
;
181 /* Objective-C/Objective-C++ global tree enumeration. */
186 OCTI_STATIC_NST_DECL
,
193 OCTI_UMSG_SUPER_DECL
,
194 OCTI_UMSG_STRET_DECL
,
195 OCTI_UMSG_SUPER_STRET_DECL
,
197 OCTI_GET_MCLASS_DECL
,
213 OCTI_CLS_NAMES_CHAIN
,
214 OCTI_METH_VAR_NAMES_CHAIN
,
215 OCTI_METH_VAR_TYPES_CHAIN
,
240 OCTI_UUCLS_SUPER_REF
,
248 OCTI_METH_PROTO_TEMPL
,
249 OCTI_FUNCTION1_TEMPL
,
250 OCTI_FUNCTION2_TEMPL
,
258 OCTI_CNST_STR_GLOB_ID
,
259 OCTI_STRING_CLASS_DECL
,
261 OCTI_UMSG_NONNIL_DECL
,
262 OCTI_UMSG_NONNIL_STRET_DECL
,
264 OCTI_EXCEPTION_EXTRACT_DECL
,
265 OCTI_EXCEPTION_TRY_ENTER_DECL
,
266 OCTI_EXCEPTION_TRY_EXIT_DECL
,
267 OCTI_EXCEPTION_MATCH_DECL
,
268 OCTI_EXCEPTION_THROW_DECL
,
269 OCTI_SYNC_ENTER_DECL
,
273 OCTI_STACK_EXCEPTION_DATA_DECL
,
274 OCTI_LOCAL_EXCEPTION_DECL
,
275 OCTI_RETHROW_EXCEPTION_DECL
,
283 extern GTY(()) tree objc_global_trees
[OCTI_MAX
];
285 /* List of classes with list of their static instances. */
286 #define objc_static_instances objc_global_trees[OCTI_STATIC_NST]
288 /* The declaration of the array administrating the static instances. */
289 #define static_instances_decl objc_global_trees[OCTI_STATIC_NST_DECL]
291 /* Some commonly used instances of "identifier_node". */
293 #define self_id objc_global_trees[OCTI_SELF_ID]
294 #define ucmd_id objc_global_trees[OCTI_UCMD_ID]
295 #define unused_list objc_global_trees[OCTI_UNUSED_LIST]
297 #define self_decl objc_global_trees[OCTI_SELF_DECL]
298 #define umsg_decl objc_global_trees[OCTI_UMSG_DECL]
299 #define umsg_super_decl objc_global_trees[OCTI_UMSG_SUPER_DECL]
300 #define umsg_stret_decl objc_global_trees[OCTI_UMSG_STRET_DECL]
301 #define umsg_super_stret_decl objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
302 #define objc_get_class_decl objc_global_trees[OCTI_GET_CLASS_DECL]
303 #define objc_get_meta_class_decl \
304 objc_global_trees[OCTI_GET_MCLASS_DECL]
306 #define objc_super_type objc_global_trees[OCTI_SUPER_TYPE]
307 #define objc_selector_type objc_global_trees[OCTI_SEL_TYPE]
308 #define objc_object_type objc_global_trees[OCTI_ID_TYPE]
309 #define objc_class_type objc_global_trees[OCTI_CLS_TYPE]
310 #define objc_instance_type objc_global_trees[OCTI_NST_TYPE]
311 #define objc_protocol_type objc_global_trees[OCTI_PROTO_TYPE]
313 /* Type checking macros. */
315 #define IS_ID(TYPE) \
316 (TREE_CODE (TYPE) == POINTER_TYPE \
317 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
318 == TREE_TYPE (objc_object_type)))
319 #define IS_CLASS(TYPE) \
320 (TREE_CODE (TYPE) == POINTER_TYPE \
321 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
322 == TREE_TYPE (objc_class_type)))
323 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE) \
324 ((IS_ID (TYPE) || IS_CLASS (TYPE)) \
325 && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE)) \
326 && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
327 #define IS_SUPER(TYPE) \
328 (TREE_CODE (TYPE) == POINTER_TYPE \
329 && TREE_TYPE (TYPE) == objc_super_template)
331 #define class_chain objc_global_trees[OCTI_CLS_CHAIN]
332 #define alias_chain objc_global_trees[OCTI_ALIAS_CHAIN]
333 #define interface_chain objc_global_trees[OCTI_INTF_CHAIN]
334 #define protocol_chain objc_global_trees[OCTI_PROTO_CHAIN]
335 #define implemented_classes objc_global_trees[OCTI_IMPL_CHAIN]
337 /* Chains to manage selectors that are referenced and defined in the
340 #define cls_ref_chain objc_global_trees[OCTI_CLS_REF_CHAIN] /* Classes referenced. */
341 #define sel_ref_chain objc_global_trees[OCTI_SEL_REF_CHAIN] /* Selectors referenced. */
342 #define objc_ivar_chain objc_global_trees[OCTI_IVAR_CHAIN]
344 /* Chains to manage uniquing of strings. */
346 #define class_names_chain objc_global_trees[OCTI_CLS_NAMES_CHAIN]
347 #define meth_var_names_chain objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
348 #define meth_var_types_chain objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
351 /* Backend data declarations. */
353 #define UOBJC_SYMBOLS_decl objc_global_trees[OCTI_SYMBOLS_DECL]
354 #define UOBJC_INSTANCE_VARIABLES_decl objc_global_trees[OCTI_NST_VAR_DECL]
355 #define UOBJC_CLASS_VARIABLES_decl objc_global_trees[OCTI_CLS_VAR_DECL]
356 #define UOBJC_INSTANCE_METHODS_decl objc_global_trees[OCTI_NST_METH_DECL]
357 #define UOBJC_CLASS_METHODS_decl objc_global_trees[OCTI_CLS_METH_DECL]
358 #define UOBJC_CLASS_decl objc_global_trees[OCTI_CLS_DECL]
359 #define UOBJC_METACLASS_decl objc_global_trees[OCTI_MCLS_DECL]
360 #define UOBJC_SELECTOR_TABLE_decl objc_global_trees[OCTI_SEL_TABLE_DECL]
361 #define UOBJC_MODULES_decl objc_global_trees[OCTI_MODULES_DECL]
362 #define GNU_INIT_decl objc_global_trees[OCTI_GNU_INIT_DECL]
364 /* The following are used when compiling a class implementation.
365 implementation_template will normally be an interface, however if
366 none exists this will be equal to objc_implementation_context...it is
367 set in start_class. */
369 #define objc_interface_context objc_global_trees[OCTI_INTF_CTX]
370 #define objc_implementation_context objc_global_trees[OCTI_IMPL_CTX]
371 #define objc_method_context objc_global_trees[OCTI_METH_CTX]
372 #define objc_ivar_context objc_global_trees[OCTI_IVAR_CTX]
374 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
375 #define objc_class_template objc_global_trees[OCTI_CLS_TEMPL]
376 #define objc_category_template objc_global_trees[OCTI_CAT_TEMPL]
377 #define uprivate_record objc_global_trees[OCTI_UPRIV_REC]
378 #define objc_protocol_template objc_global_trees[OCTI_PROTO_TEMPL]
379 #define objc_selector_template objc_global_trees[OCTI_SEL_TEMPL]
380 #define ucls_super_ref objc_global_trees[OCTI_UCLS_SUPER_REF]
381 #define uucls_super_ref objc_global_trees[OCTI_UUCLS_SUPER_REF]
383 #define umsg_nonnil_decl objc_global_trees[OCTI_UMSG_NONNIL_DECL]
384 #define umsg_nonnil_stret_decl objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
385 #define objc_storage_class objc_global_trees[OCTI_STORAGE_CLS]
386 #define objc_exception_extract_decl \
387 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
388 #define objc_exception_try_enter_decl \
389 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
390 #define objc_exception_try_exit_decl \
391 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
392 #define objc_exception_match_decl \
393 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
394 #define objc_exception_throw_decl \
395 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
396 #define objc_sync_enter_decl objc_global_trees[OCTI_SYNC_ENTER_DECL]
397 #define objc_sync_exit_decl objc_global_trees[OCTI_SYNC_EXIT_DECL]
398 #define objc_exception_data_template \
399 objc_global_trees[OCTI_EXCDATA_TEMPL]
400 #define objc_setjmp_decl objc_global_trees[OCTI_SETJMP_DECL]
401 #define objc_stack_exception_data \
402 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
403 #define objc_caught_exception objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
404 #define objc_rethrow_exception objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
405 #define objc_eval_once objc_global_trees[OCTI_EVAL_ONCE_DECL]
406 #define objc_catch_type objc_global_trees[OCTI_CATCH_TYPE]
408 #define execclass_decl objc_global_trees[OCTI_EXECCLASS_DECL]
410 #define objc_method_template objc_global_trees[OCTI_METH_TEMPL]
411 #define objc_ivar_template objc_global_trees[OCTI_IVAR_TEMPL]
412 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
413 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
414 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
415 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
416 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
417 #define objc_method_prototype_template \
418 objc_global_trees[OCTI_METH_PROTO_TEMPL]
419 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
420 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
422 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
423 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
424 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
425 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
426 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
427 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
428 #define constant_string_global_id \
429 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
430 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
431 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
433 #endif /* GCC_OBJC_ACT_H */