2008-11-19 Andrew Stubbs <ams@codesourcery.com>
[official-gcc.git] / gcc / objc / objc-act.h
blob6c6b227bd6b7afab2f142c2f9bb060d624dfcde6
1 /* Declarations for objc-act.c.
2 Copyright (C) 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2007
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)
10 any later version.
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 /* For enum gimplify_status */
26 #include "gimple.h"
28 /*** Language hooks ***/
30 bool objc_init (void);
31 const char *objc_printable_name (tree, int);
32 void objc_finish_file (void);
33 tree objc_fold_obj_type_ref (tree, tree);
34 enum gimplify_status objc_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
36 /* NB: The remaining public functions are prototyped in c-common.h, for the
37 benefit of stub-objc.c and objc-act.c. */
39 /* Objective-C structures */
41 #define CLASS_LANG_SLOT_ELTS 5
42 #define PROTOCOL_LANG_SLOT_ELTS 2
43 #define OBJC_INFO_SLOT_ELTS 2
45 /* KEYWORD_DECL */
46 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl_minimal.name)
47 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl_non_common.arguments)
49 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
50 #define METHOD_SEL_NAME(DECL) ((DECL)->decl_minimal.name)
51 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl_non_common.arguments)
52 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl_non_common.result)
53 #define METHOD_ADD_ARGS_ELLIPSIS_P(DECL) ((DECL)->decl_common.lang_flag_0)
54 #define METHOD_DEFINITION(DECL) ((DECL)->decl_common.initial)
55 #define METHOD_ENCODING(DECL) ((DECL)->decl_minimal.context)
57 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
58 CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
59 PROTOCOL_INTERFACE_TYPE */
60 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
61 #define CLASS_SUPER_NAME(CLASS) (TYPE_CHECK (CLASS)->type.context)
62 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
63 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
64 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
65 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
66 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
67 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
68 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
69 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
70 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
71 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
72 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
73 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
74 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
76 /* ObjC-specific information pertaining to RECORD_TYPEs are stored in
77 the LANG_SPECIFIC structures, which may itself need allocating first. */
79 /* The following three macros must be overridden (in objcp/objcp-decl.h)
80 for Objective-C++. */
81 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
82 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
83 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC(NODE) \
84 do { \
85 TYPE_LANG_SPECIFIC (NODE) = GGC_CNEW (struct lang_type); \
86 } while (0)
88 #define TYPE_HAS_OBJC_INFO(TYPE) \
89 (TYPE_LANG_SPECIFIC (TYPE) && TYPE_OBJC_INFO (TYPE))
90 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
91 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
94 #define INIT_TYPE_OBJC_INFO(TYPE) \
95 do \
96 { \
97 if (!TYPE_LANG_SPECIFIC (TYPE)) \
98 ALLOC_OBJC_TYPE_LANG_SPECIFIC(TYPE); \
99 if (!TYPE_OBJC_INFO (TYPE)) \
100 TYPE_OBJC_INFO (TYPE) \
101 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
103 while (0)
104 #define DUP_TYPE_OBJC_INFO(DST, SRC) \
105 do \
107 ALLOC_OBJC_TYPE_LANG_SPECIFIC(DST); \
108 if (TYPE_LANG_SPECIFIC (SRC)) \
109 memcpy (TYPE_LANG_SPECIFIC (DST), \
110 TYPE_LANG_SPECIFIC (SRC), \
111 SIZEOF_OBJC_TYPE_LANG_SPECIFIC); \
112 TYPE_OBJC_INFO (DST) \
113 = make_tree_vec (OBJC_INFO_SLOT_ELTS); \
115 while (0)
117 #define TYPED_OBJECT(TYPE) \
118 (TREE_CODE (TYPE) == RECORD_TYPE \
119 && TYPE_HAS_OBJC_INFO (TYPE) \
120 && TYPE_OBJC_INTERFACE (TYPE))
121 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
122 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
124 /* Hash tables to manage the global pool of method prototypes. */
126 typedef struct hashed_entry *hash;
127 typedef struct hashed_attribute *attr;
129 struct hashed_attribute GTY(())
131 attr next;
132 tree value;
134 struct hashed_entry GTY(())
136 attr list;
137 hash next;
138 tree key;
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 imp_entry GTY(())
150 struct imp_entry *next;
151 tree imp_context;
152 tree imp_template;
153 tree class_decl; /* _OBJC_CLASS_<my_name>; */
154 tree meta_decl; /* _OBJC_METACLASS_<my_name>; */
155 BOOL_BITFIELD has_cxx_cdtors : 1;
158 extern GTY(()) struct imp_entry *imp_list;
159 extern GTY(()) int imp_count; /* `@implementation' */
160 extern GTY(()) int cat_count; /* `@category' */
162 extern GTY(()) enum tree_code objc_inherit_code;
163 extern GTY(()) int objc_public_flag;
165 /* Objective-C/Objective-C++ global tree enumeration. */
167 enum objc_tree_index
169 OCTI_STATIC_NST,
170 OCTI_STATIC_NST_DECL,
171 OCTI_SELF_ID,
172 OCTI_UCMD_ID,
174 OCTI_SELF_DECL,
175 OCTI_UMSG_DECL,
176 OCTI_UMSG_FAST_DECL,
177 OCTI_UMSG_SUPER_DECL,
178 OCTI_UMSG_STRET_DECL,
179 OCTI_UMSG_SUPER_STRET_DECL,
180 OCTI_GET_CLASS_DECL,
181 OCTI_GET_MCLASS_DECL,
182 OCTI_SUPER_TYPE,
183 OCTI_SEL_TYPE,
184 OCTI_ID_TYPE,
185 OCTI_CLS_TYPE,
186 OCTI_NST_TYPE,
187 OCTI_PROTO_TYPE,
189 OCTI_CLS_CHAIN,
190 OCTI_ALIAS_CHAIN,
191 OCTI_INTF_CHAIN,
192 OCTI_PROTO_CHAIN,
193 OCTI_IMPL_CHAIN,
194 OCTI_CLS_REF_CHAIN,
195 OCTI_SEL_REF_CHAIN,
196 OCTI_IVAR_CHAIN,
197 OCTI_CLS_NAMES_CHAIN,
198 OCTI_METH_VAR_NAMES_CHAIN,
199 OCTI_METH_VAR_TYPES_CHAIN,
201 OCTI_SYMBOLS_DECL,
202 OCTI_NST_VAR_DECL,
203 OCTI_CLS_VAR_DECL,
204 OCTI_NST_METH_DECL,
205 OCTI_CLS_METH_DECL,
206 OCTI_CLS_DECL,
207 OCTI_MCLS_DECL,
208 OCTI_SEL_TABLE_DECL,
209 OCTI_MODULES_DECL,
210 OCTI_GNU_INIT_DECL,
212 OCTI_INTF_CTX,
213 OCTI_IMPL_CTX,
214 OCTI_METH_CTX,
215 OCTI_IVAR_CTX,
217 OCTI_IMPL_TEMPL,
218 OCTI_CLS_TEMPL,
219 OCTI_CAT_TEMPL,
220 OCTI_UPRIV_REC,
221 OCTI_PROTO_TEMPL,
222 OCTI_SEL_TEMPL,
223 OCTI_UCLS_SUPER_REF,
224 OCTI_UUCLS_SUPER_REF,
225 OCTI_METH_TEMPL,
226 OCTI_IVAR_TEMPL,
227 OCTI_METH_LIST_TEMPL,
228 OCTI_METH_PROTO_LIST_TEMPL,
229 OCTI_IVAR_LIST_TEMPL,
230 OCTI_SYMTAB_TEMPL,
231 OCTI_MODULE_TEMPL,
232 OCTI_SUPER_TEMPL,
233 OCTI_OBJ_REF,
234 OCTI_CLS_REF,
235 OCTI_METH_PROTO_TEMPL,
236 OCTI_FUNCTION1_TEMPL,
237 OCTI_FUNCTION2_TEMPL,
239 OCTI_OBJ_ID,
240 OCTI_CLS_ID,
241 OCTI_ID_NAME,
242 OCTI_CLASS_NAME,
243 OCTI_CNST_STR_ID,
244 OCTI_CNST_STR_TYPE,
245 OCTI_CNST_STR_GLOB_ID,
246 OCTI_STRING_CLASS_DECL,
247 OCTI_INTERNAL_CNST_STR_TYPE,
248 OCTI_SUPER_DECL,
249 OCTI_UMSG_NONNIL_DECL,
250 OCTI_UMSG_NONNIL_STRET_DECL,
251 OCTI_STORAGE_CLS,
252 OCTI_EXCEPTION_EXTRACT_DECL,
253 OCTI_EXCEPTION_TRY_ENTER_DECL,
254 OCTI_EXCEPTION_TRY_EXIT_DECL,
255 OCTI_EXCEPTION_MATCH_DECL,
256 OCTI_EXCEPTION_THROW_DECL,
257 OCTI_SYNC_ENTER_DECL,
258 OCTI_SYNC_EXIT_DECL,
259 OCTI_SETJMP_DECL,
260 OCTI_EXCDATA_TEMPL,
261 OCTI_STACK_EXCEPTION_DATA_DECL,
262 OCTI_LOCAL_EXCEPTION_DECL,
263 OCTI_RETHROW_EXCEPTION_DECL,
264 OCTI_EVAL_ONCE_DECL,
265 OCTI_CATCH_TYPE,
266 OCTI_EXECCLASS_DECL,
268 OCTI_ASSIGN_IVAR_DECL,
269 OCTI_ASSIGN_IVAR_FAST_DECL,
270 OCTI_ASSIGN_GLOBAL_DECL,
271 OCTI_ASSIGN_STRONGCAST_DECL,
273 OCTI_MAX
276 extern GTY(()) tree objc_global_trees[OCTI_MAX];
278 /* List of classes with list of their static instances. */
279 #define objc_static_instances objc_global_trees[OCTI_STATIC_NST]
281 /* The declaration of the array administrating the static instances. */
282 #define static_instances_decl objc_global_trees[OCTI_STATIC_NST_DECL]
284 /* Some commonly used instances of "identifier_node". */
286 #define self_id objc_global_trees[OCTI_SELF_ID]
287 #define ucmd_id objc_global_trees[OCTI_UCMD_ID]
289 #define self_decl objc_global_trees[OCTI_SELF_DECL]
290 #define umsg_decl objc_global_trees[OCTI_UMSG_DECL]
291 #define umsg_fast_decl objc_global_trees[OCTI_UMSG_FAST_DECL]
292 #define umsg_super_decl objc_global_trees[OCTI_UMSG_SUPER_DECL]
293 #define umsg_stret_decl objc_global_trees[OCTI_UMSG_STRET_DECL]
294 #define umsg_super_stret_decl objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
295 #define objc_get_class_decl objc_global_trees[OCTI_GET_CLASS_DECL]
296 #define objc_get_meta_class_decl \
297 objc_global_trees[OCTI_GET_MCLASS_DECL]
299 #define objc_super_type objc_global_trees[OCTI_SUPER_TYPE]
300 #define objc_selector_type objc_global_trees[OCTI_SEL_TYPE]
301 #define objc_object_type objc_global_trees[OCTI_ID_TYPE]
302 #define objc_class_type objc_global_trees[OCTI_CLS_TYPE]
303 #define objc_instance_type objc_global_trees[OCTI_NST_TYPE]
304 #define objc_protocol_type objc_global_trees[OCTI_PROTO_TYPE]
306 /* Type checking macros. */
308 #define IS_ID(TYPE) \
309 (TREE_CODE (TYPE) == POINTER_TYPE \
310 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
311 == TREE_TYPE (objc_object_type)))
312 #define IS_CLASS(TYPE) \
313 (TREE_CODE (TYPE) == POINTER_TYPE \
314 && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE)) \
315 == TREE_TYPE (objc_class_type)))
316 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE) \
317 ((IS_ID (TYPE) || IS_CLASS (TYPE)) \
318 && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE)) \
319 && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
320 #define IS_SUPER(TYPE) \
321 (TREE_CODE (TYPE) == POINTER_TYPE \
322 && TREE_TYPE (TYPE) == objc_super_template)
324 #define class_chain objc_global_trees[OCTI_CLS_CHAIN]
325 #define alias_chain objc_global_trees[OCTI_ALIAS_CHAIN]
326 #define interface_chain objc_global_trees[OCTI_INTF_CHAIN]
327 #define protocol_chain objc_global_trees[OCTI_PROTO_CHAIN]
328 #define implemented_classes objc_global_trees[OCTI_IMPL_CHAIN]
330 /* Chains to manage selectors that are referenced and defined in the
331 module. */
333 #define cls_ref_chain objc_global_trees[OCTI_CLS_REF_CHAIN] /* Classes referenced. */
334 #define sel_ref_chain objc_global_trees[OCTI_SEL_REF_CHAIN] /* Selectors referenced. */
335 #define objc_ivar_chain objc_global_trees[OCTI_IVAR_CHAIN]
337 /* Chains to manage uniquing of strings. */
339 #define class_names_chain objc_global_trees[OCTI_CLS_NAMES_CHAIN]
340 #define meth_var_names_chain objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
341 #define meth_var_types_chain objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
344 /* Backend data declarations. */
346 #define UOBJC_SYMBOLS_decl objc_global_trees[OCTI_SYMBOLS_DECL]
347 #define UOBJC_INSTANCE_VARIABLES_decl objc_global_trees[OCTI_NST_VAR_DECL]
348 #define UOBJC_CLASS_VARIABLES_decl objc_global_trees[OCTI_CLS_VAR_DECL]
349 #define UOBJC_INSTANCE_METHODS_decl objc_global_trees[OCTI_NST_METH_DECL]
350 #define UOBJC_CLASS_METHODS_decl objc_global_trees[OCTI_CLS_METH_DECL]
351 #define UOBJC_CLASS_decl objc_global_trees[OCTI_CLS_DECL]
352 #define UOBJC_METACLASS_decl objc_global_trees[OCTI_MCLS_DECL]
353 #define UOBJC_SELECTOR_TABLE_decl objc_global_trees[OCTI_SEL_TABLE_DECL]
354 #define UOBJC_MODULES_decl objc_global_trees[OCTI_MODULES_DECL]
355 #define GNU_INIT_decl objc_global_trees[OCTI_GNU_INIT_DECL]
357 /* The following are used when compiling a class implementation.
358 implementation_template will normally be an interface, however if
359 none exists this will be equal to objc_implementation_context...it is
360 set in start_class. */
362 #define objc_interface_context objc_global_trees[OCTI_INTF_CTX]
363 #define objc_implementation_context objc_global_trees[OCTI_IMPL_CTX]
364 #define objc_method_context objc_global_trees[OCTI_METH_CTX]
365 #define objc_ivar_context objc_global_trees[OCTI_IVAR_CTX]
367 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
368 #define objc_class_template objc_global_trees[OCTI_CLS_TEMPL]
369 #define objc_category_template objc_global_trees[OCTI_CAT_TEMPL]
370 #define uprivate_record objc_global_trees[OCTI_UPRIV_REC]
371 #define objc_protocol_template objc_global_trees[OCTI_PROTO_TEMPL]
372 #define objc_selector_template objc_global_trees[OCTI_SEL_TEMPL]
373 #define ucls_super_ref objc_global_trees[OCTI_UCLS_SUPER_REF]
374 #define uucls_super_ref objc_global_trees[OCTI_UUCLS_SUPER_REF]
376 #define umsg_nonnil_decl objc_global_trees[OCTI_UMSG_NONNIL_DECL]
377 #define umsg_nonnil_stret_decl objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
378 #define objc_storage_class objc_global_trees[OCTI_STORAGE_CLS]
379 #define objc_exception_extract_decl \
380 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
381 #define objc_exception_try_enter_decl \
382 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
383 #define objc_exception_try_exit_decl \
384 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
385 #define objc_exception_match_decl \
386 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
387 #define objc_exception_throw_decl \
388 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
389 #define objc_sync_enter_decl objc_global_trees[OCTI_SYNC_ENTER_DECL]
390 #define objc_sync_exit_decl objc_global_trees[OCTI_SYNC_EXIT_DECL]
391 #define objc_exception_data_template \
392 objc_global_trees[OCTI_EXCDATA_TEMPL]
393 #define objc_setjmp_decl objc_global_trees[OCTI_SETJMP_DECL]
394 #define objc_stack_exception_data \
395 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
396 #define objc_caught_exception objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
397 #define objc_rethrow_exception objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
398 #define objc_eval_once objc_global_trees[OCTI_EVAL_ONCE_DECL]
399 #define objc_catch_type objc_global_trees[OCTI_CATCH_TYPE]
401 #define execclass_decl objc_global_trees[OCTI_EXECCLASS_DECL]
403 #define objc_assign_ivar_decl objc_global_trees[OCTI_ASSIGN_IVAR_DECL]
404 #define objc_assign_ivar_fast_decl \
405 objc_global_trees[OCTI_ASSIGN_IVAR_FAST_DECL]
406 #define objc_assign_global_decl objc_global_trees[OCTI_ASSIGN_GLOBAL_DECL]
407 #define objc_assign_strong_cast_decl \
408 objc_global_trees[OCTI_ASSIGN_STRONGCAST_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_method_list_ptr objc_global_trees[OCTI_METH_LIST_TEMPL]
413 #define objc_method_proto_list_ptr \
414 objc_global_trees[OCTI_METH_PROTO_LIST_TEMPL]
415 #define objc_ivar_list_ptr objc_global_trees[OCTI_IVAR_LIST_TEMPL]
416 #define objc_symtab_template objc_global_trees[OCTI_SYMTAB_TEMPL]
417 #define objc_module_template objc_global_trees[OCTI_MODULE_TEMPL]
418 #define objc_super_template objc_global_trees[OCTI_SUPER_TEMPL]
419 #define objc_object_reference objc_global_trees[OCTI_OBJ_REF]
420 #define objc_class_reference objc_global_trees[OCTI_CLS_REF]
421 #define objc_method_prototype_template \
422 objc_global_trees[OCTI_METH_PROTO_TEMPL]
423 #define function1_template objc_global_trees[OCTI_FUNCTION1_TEMPL]
424 #define function2_template objc_global_trees[OCTI_FUNCTION2_TEMPL]
426 #define objc_object_id objc_global_trees[OCTI_OBJ_ID]
427 #define objc_class_id objc_global_trees[OCTI_CLS_ID]
428 #define objc_object_name objc_global_trees[OCTI_ID_NAME]
429 #define objc_class_name objc_global_trees[OCTI_CLASS_NAME]
430 #define constant_string_id objc_global_trees[OCTI_CNST_STR_ID]
431 #define constant_string_type objc_global_trees[OCTI_CNST_STR_TYPE]
432 #define constant_string_global_id \
433 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
434 #define string_class_decl objc_global_trees[OCTI_STRING_CLASS_DECL]
435 #define internal_const_str_type objc_global_trees[OCTI_INTERNAL_CNST_STR_TYPE]
436 #define UOBJC_SUPER_decl objc_global_trees[OCTI_SUPER_DECL]
438 #endif /* GCC_OBJC_ACT_H */