gcc/objc/objc-act.h

   1 /* Declarations for objc-act.c.
   2    Copyright (C) 1990, 2000, 2001, 2002, 2003
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   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)
  10 any later version.
  11
  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.
  16
  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.  */
  21
  22 #ifndef GCC_OBJC_ACT_H
  23 #define GCC_OBJC_ACT_H
  24
  25 /*** Public Interface (procedures) ***/
  26
  27 const char *objc_init                           PARAMS ((const char *));
  28 const char *objc_printable_name                 PARAMS ((tree, int));
  29
  30 /* used by yyparse */
  31
  32 void finish_file                                PARAMS ((void));
  33 tree start_class                                PARAMS ((enum tree_code, tree, tree, tree));
  34 tree continue_class                             PARAMS ((tree));
  35 void finish_class                               PARAMS ((tree));
  36 void start_method_def                           PARAMS ((tree));
  37 void continue_method_def                        PARAMS ((void));
  38 void finish_method_def                          PARAMS ((void));
  39 tree start_protocol                             PARAMS ((enum tree_code, tree, tree));
  40 void finish_protocol                            PARAMS ((tree));
  41 void add_objc_decls                             PARAMS ((void));
  42
  43 tree is_ivar                                    PARAMS ((tree, tree));
  44 int is_private                                  PARAMS ((tree));
  45 int is_public                                   PARAMS ((tree, tree));
  46 tree add_instance_variable                      PARAMS ((tree, int, tree, tree, tree));
  47 tree add_class_method                           PARAMS ((tree, tree));
  48 tree add_instance_method                        PARAMS ((tree, tree));
  49 tree get_super_receiver                         PARAMS ((void));
  50 tree get_class_ivars                            PARAMS ((tree));
  51 tree get_class_reference                        PARAMS ((tree));
  52 tree get_static_reference                       PARAMS ((tree, tree));
  53 tree get_object_reference                       PARAMS ((tree));
  54 tree build_message_expr                         PARAMS ((tree));
  55 tree finish_message_expr                        PARAMS ((tree, tree, tree));
  56 tree build_selector_expr                        PARAMS ((tree));
  57 tree build_ivar_reference                       PARAMS ((tree));
  58 tree build_keyword_decl                         PARAMS ((tree, tree, tree));
  59 tree build_method_decl                          PARAMS ((enum tree_code, tree, tree, tree));
  60 tree build_protocol_expr                        PARAMS ((tree));
  61 tree build_objc_string_object                   PARAMS ((tree));
  62
  63 void objc_declare_alias                         PARAMS ((tree, tree));
  64 void objc_declare_class                         PARAMS ((tree));
  65 void objc_declare_protocols                     PARAMS ((tree));
  66
  67 /* the following routines are used to implement statically typed objects */
  68
  69 int objc_comptypes                              PARAMS ((tree, tree, int));
  70 void objc_check_decl                            PARAMS ((tree));
  71
  72 /* NeXT extensions */
  73
  74 tree build_encode_expr                          PARAMS ((tree));
  75
  76 /* Objective-C structures */
  77
  78 /* KEYWORD_DECL */
  79 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl.name)
  80 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl.arguments)
  81
  82 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
  83 #define METHOD_SEL_NAME(DECL) ((DECL)->decl.name)
  84 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl.arguments)
  85 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl.result)
  86 #define METHOD_DEFINITION(DECL) ((DECL)->decl.initial)
  87 #define METHOD_ENCODING(DECL) ((DECL)->decl.context)
  88
  89 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
  90    CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
  91    PROTOCOL_INTERFACE_TYPE */
  92 #define CLASS_NAME(CLASS) ((CLASS)->type.name)
  93 #define CLASS_SUPER_NAME(CLASS) ((CLASS)->type.context)
  94 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 0)
  95 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 1)
  96 #define CLASS_NST_METHODS(CLASS) ((CLASS)->type.minval)
  97 #define CLASS_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
  98 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 2)
  99 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 3)
 100 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 4)
 101 #define CLASS_OWN_IVARS(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 5)
 102 #define PROTOCOL_NAME(CLASS) ((CLASS)->type.name)
 103 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 0)
 104 #define PROTOCOL_NST_METHODS(CLASS) ((CLASS)->type.minval)
 105 #define PROTOCOL_CLS_METHODS(CLASS) ((CLASS)->type.maxval)
 106 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_BINFO (CLASS), 1)
 107 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
 108 #define TYPE_PROTOCOL_LIST(TYPE) ((TYPE)->type.context)
 109
 110 /* Set by `continue_class' and checked by `is_public'.  */
 111
 112 #define TREE_STATIC_TEMPLATE(record_type) (TREE_PUBLIC (record_type))
 113 #define TYPED_OBJECT(type) \
 114        (TREE_CODE (type) == RECORD_TYPE && TREE_STATIC_TEMPLATE (type))
 115
 116 /* Define the Objective-C or Objective-C++ language-specific tree codes.  */
 117
 118 #define DEFTREECODE(SYM, NAME, TYPE, LENGTH) SYM,
 119 enum objc_tree_code {
 120 #ifdef OBJCPLUS
 121   LAST_BASE_TREE_CODE = LAST_CPLUS_TREE_CODE,
 122 #else
 123   LAST_BASE_TREE_CODE = LAST_C_TREE_CODE,
 124 #endif
 125 #include "objc-tree.def"
 126   LAST_OBJC_TREE_CODE
 127 };
 128 #undef DEFTREECODE
 129
 130 /* Hash tables to manage the global pool of method prototypes.  */
 131
 132 typedef struct hashed_entry     *hash;
 133 typedef struct hashed_attribute *attr;
 134
 135 struct hashed_attribute GTY(())
 136 {
 137   attr next;
 138   tree value;
 139 };
 140 struct hashed_entry GTY(())
 141 {
 142   attr list;
 143   hash next;
 144   tree key;
 145 };
 146
 147 extern GTY ((length ("SIZEHASHTABLE"))) hash *nst_method_hash_list;
 148 extern GTY ((length ("SIZEHASHTABLE"))) hash *cls_method_hash_list;
 149
 150 #define SIZEHASHTABLE           257
 151
 152 /* Objective-C/Objective-C++ @implementation list.  */
 153
 154 struct imp_entry GTY(())
 155 {
 156   struct imp_entry *next;
 157   tree imp_context;
 158   tree imp_template;
 159   tree class_decl;              /* _OBJC_CLASS_<my_name>; */
 160   tree meta_decl;               /* _OBJC_METACLASS_<my_name>; */
 161 };
 162
 163 extern GTY(()) struct imp_entry *imp_list;
 164 extern int imp_count;   /* `@implementation' */
 165 extern int cat_count;   /* `@category' */
 166
 167 /* Objective-C/Objective-C++ global tree enumeration.  */
 168
 169 enum objc_tree_index
 170 {
 171     OCTI_STATIC_NST,
 172     OCTI_STATIC_NST_DECL,
 173     OCTI_SELF_ID,
 174     OCTI_UCMD_ID,
 175     OCTI_UNUSED_LIST,
 176     OCTI_ELLIPSIS_NODE,
 177
 178     OCTI_SELF_DECL,
 179     OCTI_UMSG_DECL,
 180     OCTI_UMSG_SUPER_DECL,
 181     OCTI_GET_CLASS_DECL,
 182     OCTI_GET_MCLASS_DECL,
 183     OCTI_SUPER_TYPE,
 184     OCTI_SEL_TYPE,
 185     OCTI_ID_TYPE,
 186     OCTI_CLS_TYPE,
 187     OCTI_NST_TYPE,
 188     OCTI_PROTO_TYPE,
 189
 190     OCTI_CLS_CHAIN,
 191     OCTI_ALIAS_CHAIN,
 192     OCTI_INTF_CHAIN,
 193     OCTI_PROTO_CHAIN,
 194     OCTI_IMPL_CHAIN,
 195     OCTI_CLS_REF_CHAIN,
 196     OCTI_SEL_REF_CHAIN,
 197     OCTI_IVAR_CHAIN,
 198     OCTI_CLS_NAMES_CHAIN,
 199     OCTI_METH_VAR_NAMES_CHAIN,
 200     OCTI_METH_VAR_TYPES_CHAIN,
 201
 202     OCTI_SYMBOLS_DECL,
 203     OCTI_NST_VAR_DECL,
 204     OCTI_CLS_VAR_DECL,
 205     OCTI_NST_METH_DECL,
 206     OCTI_CLS_METH_DECL,
 207     OCTI_CLS_DECL,
 208     OCTI_MCLS_DECL,
 209     OCTI_SEL_TABLE_DECL,
 210     OCTI_MODULES_DECL,
 211     OCTI_STRG_DECL,
 212
 213     OCTI_INTF_CTX,
 214     OCTI_IMPL_CTX,
 215     OCTI_METH_CTX,
 216     OCTI_IVAR_CTX,
 217
 218     OCTI_IMPL_TEMPL,
 219     OCTI_CLS_TEMPL,
 220     OCTI_CAT_TEMPL,
 221     OCTI_UPRIV_REC,
 222     OCTI_PROTO_TEMPL,
 223     OCTI_SEL_TEMPL,
 224     OCTI_UCLS_SUPER_REF,
 225     OCTI_UUCLS_SUPER_REF,
 226     OCTI_METH_TEMPL,
 227     OCTI_IVAR_TEMPL,
 228     OCTI_SYMTAB_TEMPL,
 229     OCTI_MODULE_TEMPL,
 230     OCTI_SUPER_TEMPL,
 231     OCTI_OBJ_REF,
 232     OCTI_METH_PROTO_TEMPL,
 233     OCTI_FUNCTION1_TEMPL,
 234     OCTI_FUNCTION2_TEMPL,
 235
 236     OCTI_OBJ_ID,
 237     OCTI_CLS_ID,
 238     OCTI_ID_ID,
 239     OCTI_CNST_STR_ID,
 240     OCTI_CNST_STR_TYPE,
 241     OCTI_CNST_STR_GLOB_ID,
 242     OCTI_STRING_CLASS_DECL,
 243     OCTI_SUPER_DECL,
 244
 245     OCTI_MAX
 246 };
 247
 248 extern GTY(()) tree objc_global_trees[OCTI_MAX];
 249
 250 /* List of classes with list of their static instances.  */
 251 #define objc_static_instances   objc_global_trees[OCTI_STATIC_NST]
 252
 253 /* The declaration of the array administrating the static instances.  */
 254 #define static_instances_decl   objc_global_trees[OCTI_STATIC_NST_DECL]
 255
 256 /* Some commonly used instances of "identifier_node".  */
 257
 258 #define self_id                 objc_global_trees[OCTI_SELF_ID]
 259 #define ucmd_id                 objc_global_trees[OCTI_UCMD_ID]
 260 #define unused_list             objc_global_trees[OCTI_UNUSED_LIST]
 261 #define objc_ellipsis_node      objc_global_trees[OCTI_ELLIPSIS_NODE]
 262
 263 #define self_decl               objc_global_trees[OCTI_SELF_DECL]
 264 #define umsg_decl               objc_global_trees[OCTI_UMSG_DECL]
 265 #define umsg_super_decl         objc_global_trees[OCTI_UMSG_SUPER_DECL]
 266 #define objc_get_class_decl     objc_global_trees[OCTI_GET_CLASS_DECL]
 267 #define objc_get_meta_class_decl                        \
 268                                 objc_global_trees[OCTI_GET_MCLASS_DECL]
 269
 270 #define super_type              objc_global_trees[OCTI_SUPER_TYPE]
 271 #define selector_type           objc_global_trees[OCTI_SEL_TYPE]
 272 #define id_type                 objc_global_trees[OCTI_ID_TYPE]
 273 #define objc_class_type         objc_global_trees[OCTI_CLS_TYPE]
 274 #define instance_type           objc_global_trees[OCTI_NST_TYPE]
 275 #define protocol_type           objc_global_trees[OCTI_PROTO_TYPE]
 276
 277 /* Type checking macros.  */
 278
 279 #define IS_ID(TYPE) \
 280   (TYPE_MAIN_VARIANT (TYPE) == TYPE_MAIN_VARIANT (id_type))
 281 #define IS_PROTOCOL_QUALIFIED_ID(TYPE) \
 282   (IS_ID (TYPE) && TYPE_PROTOCOL_LIST (TYPE))
 283 #define IS_SUPER(TYPE) \
 284   (super_type && TYPE_MAIN_VARIANT (TYPE) == TYPE_MAIN_VARIANT (super_type))
 285
 286 #define class_chain             objc_global_trees[OCTI_CLS_CHAIN]
 287 #define alias_chain             objc_global_trees[OCTI_ALIAS_CHAIN]
 288 #define interface_chain         objc_global_trees[OCTI_INTF_CHAIN]
 289 #define protocol_chain          objc_global_trees[OCTI_PROTO_CHAIN]
 290 #define implemented_classes     objc_global_trees[OCTI_IMPL_CHAIN]
 291
 292 /* Chains to manage selectors that are referenced and defined in the
 293    module.  */
 294
 295 #define cls_ref_chain           objc_global_trees[OCTI_CLS_REF_CHAIN]   /* Classes referenced.  */
 296 #define sel_ref_chain           objc_global_trees[OCTI_SEL_REF_CHAIN]   /* Selectors referenced.  */
 297 #define objc_ivar_chain         objc_global_trees[OCTI_IVAR_CHAIN]
 298
 299 /* Chains to manage uniquing of strings.  */
 300
 301 #define class_names_chain       objc_global_trees[OCTI_CLS_NAMES_CHAIN]
 302 #define meth_var_names_chain    objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
 303 #define meth_var_types_chain    objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
 304
 305
 306 /* Backend data declarations.  */
 307
 308 #define UOBJC_SYMBOLS_decl              objc_global_trees[OCTI_SYMBOLS_DECL]
 309 #define UOBJC_INSTANCE_VARIABLES_decl   objc_global_trees[OCTI_NST_VAR_DECL]
 310 #define UOBJC_CLASS_VARIABLES_decl      objc_global_trees[OCTI_CLS_VAR_DECL]
 311 #define UOBJC_INSTANCE_METHODS_decl     objc_global_trees[OCTI_NST_METH_DECL]
 312 #define UOBJC_CLASS_METHODS_decl        objc_global_trees[OCTI_CLS_METH_DECL]
 313 #define UOBJC_CLASS_decl                objc_global_trees[OCTI_CLS_DECL]
 314 #define UOBJC_METACLASS_decl            objc_global_trees[OCTI_MCLS_DECL]
 315 #define UOBJC_SELECTOR_TABLE_decl       objc_global_trees[OCTI_SEL_TABLE_DECL]
 316 #define UOBJC_MODULES_decl              objc_global_trees[OCTI_MODULES_DECL]
 317 #define UOBJC_STRINGS_decl              objc_global_trees[OCTI_STRG_DECL]
 318
 319 /* The following are used when compiling a class implementation.
 320    implementation_template will normally be an interface, however if
 321    none exists this will be equal to objc_implementation_context...it is
 322    set in start_class.  */
 323
 324 #define objc_interface_context          objc_global_trees[OCTI_INTF_CTX]
 325 #define objc_implementation_context     objc_global_trees[OCTI_IMPL_CTX]
 326 #define objc_method_context             objc_global_trees[OCTI_METH_CTX]
 327 #define objc_ivar_context               objc_global_trees[OCTI_IVAR_CTX]
 328
 329 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
 330 #define objc_class_template     objc_global_trees[OCTI_CLS_TEMPL]
 331 #define objc_category_template  objc_global_trees[OCTI_CAT_TEMPL]
 332 #define uprivate_record         objc_global_trees[OCTI_UPRIV_REC]
 333 #define objc_protocol_template  objc_global_trees[OCTI_PROTO_TEMPL]
 334 #define objc_selector_template  objc_global_trees[OCTI_SEL_TEMPL]
 335 #define ucls_super_ref          objc_global_trees[OCTI_UCLS_SUPER_REF]
 336 #define uucls_super_ref         objc_global_trees[OCTI_UUCLS_SUPER_REF]
 337
 338 #define objc_method_template    objc_global_trees[OCTI_METH_TEMPL]
 339 #define objc_ivar_template      objc_global_trees[OCTI_IVAR_TEMPL]
 340 #define objc_symtab_template    objc_global_trees[OCTI_SYMTAB_TEMPL]
 341 #define objc_module_template    objc_global_trees[OCTI_MODULE_TEMPL]
 342 #define objc_super_template     objc_global_trees[OCTI_SUPER_TEMPL]
 343 #define objc_object_reference   objc_global_trees[OCTI_OBJ_REF]
 344 #define objc_method_prototype_template          \
 345                                 objc_global_trees[OCTI_METH_PROTO_TEMPL]
 346 #define function1_template      objc_global_trees[OCTI_FUNCTION1_TEMPL]
 347 #define function2_template      objc_global_trees[OCTI_FUNCTION2_TEMPL]
 348
 349 #define objc_object_id          objc_global_trees[OCTI_OBJ_ID]
 350 #define objc_class_id           objc_global_trees[OCTI_CLS_ID]
 351 #define objc_id_id              objc_global_trees[OCTI_ID_ID]
 352 #define constant_string_id      objc_global_trees[OCTI_CNST_STR_ID]
 353 #define constant_string_type    objc_global_trees[OCTI_CNST_STR_TYPE]
 354 #define constant_string_global_id               \
 355                                 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
 356 #define string_class_decl       objc_global_trees[OCTI_STRING_CLASS_DECL]
 357 #define UOBJC_SUPER_decl        objc_global_trees[OCTI_SUPER_DECL]
 358
 359 #endif /* GCC_OBJC_ACT_H */