gcc/objc/objc-act.h

   1 /* Declarations for objc-act.c.
   2    Copyright (C) 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009,
   3    2010, 2011 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 3, 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 COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21
  22 #ifndef GCC_OBJC_ACT_H
  23 #define GCC_OBJC_ACT_H
  24
  25 /*** Language hooks ***/
  26
  27 bool objc_init (void);
  28 const char *objc_printable_name (tree, int);
  29 int objc_gimplify_expr (tree *, gimple_seq *, gimple_seq *);
  30 void objc_common_init_ts (void);
  31
  32 /* NB: The remaining public functions are prototyped in c-common.h, for the
  33    benefit of stub-objc.c and objc-act.c.  */
  34
  35 /* Objective-C structures */
  36
  37 #define CLASS_LANG_SLOT_ELTS            7
  38 #define PROTOCOL_LANG_SLOT_ELTS         7
  39 #define OBJC_INFO_SLOT_ELTS             2
  40
  41 /* KEYWORD_DECL */
  42 #define KEYWORD_KEY_NAME(DECL) ((DECL)->decl_minimal.name)
  43 #define KEYWORD_ARG_NAME(DECL) ((DECL)->decl_non_common.arguments)
  44
  45 /* INSTANCE_METHOD_DECL, CLASS_METHOD_DECL */
  46 #define METHOD_SEL_NAME(DECL) ((DECL)->decl_minimal.name)
  47 #define METHOD_SEL_ARGS(DECL) ((DECL)->decl_non_common.arguments)
  48 #define METHOD_ADD_ARGS(DECL) ((DECL)->decl_non_common.result)
  49 #define METHOD_ADD_ARGS_ELLIPSIS_P(DECL) ((DECL)->decl_common.lang_flag_0)
  50 #define METHOD_DEFINITION(DECL) ((DECL)->decl_common.initial)
  51 #define METHOD_ENCODING(DECL) ((DECL)->decl_minimal.context)
  52 #define METHOD_TYPE_ATTRIBUTES(DECL) ((DECL)->decl_common.abstract_origin)
  53 #define METHOD_PROPERTY_CONTEXT(DECL) ((DECL)->decl_common.size_unit)
  54
  55
  56 /* PROPERTY_DECL.  A PROPERTY_DECL repesents a @property declaration
  57    (when attached to the list of properties of an interface) or a
  58    @synthesize or @dynamic declaration (when attached to the list of
  59    properties of an implementation).  */
  60
  61 /* TREE_TYPE is the type (int, float, etc) of the property.  */
  62
  63 /* DECL_ARTIFICIAL is set to 1 if the PROPERTY_DECL is an artificial
  64    property declaration created when the dot-syntax object.component
  65    is used with no actual @property matching the component, but a
  66    valid getter/setter.  */
  67
  68 /* PROPERTY_NAME is the name of the property.  */
  69 #define PROPERTY_NAME(DECL) DECL_NAME(DECL)
  70
  71 /* PROPERTY_GETTER_NAME is the identifier of the getter method.  */
  72 #define PROPERTY_GETTER_NAME(DECL) ((DECL)->decl_non_common.arguments)
  73
  74 /* PROPERTY_SETTER_NAME is the identifier of the setter method.  */
  75 #define PROPERTY_SETTER_NAME(DECL) ((DECL)->decl_non_common.result)
  76
  77 /* PROPERTY_READONLY can be 0 or 1.  */
  78 #define PROPERTY_READONLY(DECL) DECL_LANG_FLAG_0 (DECL)
  79
  80 /* PROPERTY_NONATOMIC can be 0 or 1.  */
  81 #define PROPERTY_NONATOMIC(DECL) DECL_LANG_FLAG_1 (DECL)
  82
  83 typedef enum objc_property_assign_semantics {
  84   OBJC_PROPERTY_ASSIGN = 1,
  85   OBJC_PROPERTY_RETAIN = 2,
  86   OBJC_PROPERTY_COPY = 3
  87 } objc_property_assign_semantics;
  88
  89 /* PROPERTY_ASSIGN_SEMANTICS can be OBJC_PROPERTY_ASSIGN,
  90    OBJC_PROPERTY_RETAIN or OBJC_PROPERTY_COPY.  We need an integer to
  91    store it, so we hijack the alignment, that properties don't
  92    have.  */
  93 #define PROPERTY_ASSIGN_SEMANTICS(DECL) ((DECL)->decl_common.align)
  94
  95 /* PROPERTY_IVAR_NAME is the identifier of the instance variable.
  96    This is set only if the PROPERTY_DECL represents a @synthesize;
  97    otherwise, it is set to TREE_NULL.  */
  98 #define PROPERTY_IVAR_NAME(DECL) ((DECL)->decl_common.initial)
  99
 100 /* PROPERTY_DYNAMIC can be 0 or 1.  This is 1 if the PROPERTY_DECL
 101    represents a @dynamic; otherwise, it is set to 0.  */
 102 #define PROPERTY_DYNAMIC(DECL) DECL_LANG_FLAG_2 (DECL)
 103
 104 /* PROPERTY_HAS_NO_GETTER can be 0 or 1.  Normally it is 0, but if
 105    this is an artificial PROPERTY_DECL that we generate even without a
 106    getter, it is set to 1.  */
 107 #define PROPERTY_HAS_NO_GETTER(DECL) DECL_LANG_FLAG_3 (DECL)
 108
 109 /* PROPERTY_HAS_NO_SETTER can be 0 or 1.  Normally it is 0, but if
 110    this is an artificial PROPERTY_DECL that we generate even without a
 111    setter, it is set to 1.  */
 112 #define PROPERTY_HAS_NO_SETTER(DECL) DECL_LANG_FLAG_4 (DECL)
 113
 114 /* PROPERTY_OPTIONAL can be 0 or 1.  Normally it is 0, but if this is
 115    a property declared as @optional in a @protocol, then it is set to
 116    1.  */
 117 #define PROPERTY_OPTIONAL(DECL) DECL_LANG_FLAG_5 (DECL)
 118
 119 /* PROPERTY_REF.  A PROPERTY_REF represents an 'object.property'
 120    expression.  It is normally used for property access, but when
 121    the Objective-C 2.0 "dot-syntax" (object.component) is used
 122    with no matching property, a PROPERTY_REF is still created to
 123    represent it, with an artificial PROPERTY_DECL.  */
 124
 125 /* PROPERTY_REF_OBJECT is the object whose property we are
 126    accessing.  */
 127 #define PROPERTY_REF_OBJECT(NODE) TREE_OPERAND (PROPERTY_REF_CHECK (NODE), 0)
 128
 129 /* PROPERTY_REF_PROPERTY_DECL is the PROPERTY_DECL for the property
 130    used in the expression.  From it, you can get the property type,
 131    and the getter/setter names.  This PROPERTY_DECL could be artificial
 132    if we are processing an 'object.component' syntax with no matching
 133    declared property.  */
 134 #define PROPERTY_REF_PROPERTY_DECL(NODE) TREE_OPERAND (PROPERTY_REF_CHECK (NODE), 1)
 135
 136 /* PROPERTY_REF_GETTER_CALL is the getter call expression, ready to
 137    use at gimplify time if needed.  Generating the getter call
 138    requires modifying the selector table, and, in the case of
 139    self/super, requires the context to be generated correctly.  The
 140    gimplify stage is too late to do these things, so we generate the
 141    getter call earlier instead, and keep it here in case we need to
 142    use it.  */
 143 #define PROPERTY_REF_GETTER_CALL(NODE) TREE_OPERAND (PROPERTY_REF_CHECK (NODE), 2)
 144
 145 /* PROPERTY_REF_DEPRECATED_GETTER is normally set to NULL_TREE.  If
 146    the property getter is deprecated, it is set to the method
 147    prototype for it, which is used to generate the deprecation warning
 148    when the getter is used.  */
 149 #define PROPERTY_REF_DEPRECATED_GETTER(NODE) TREE_OPERAND (PROPERTY_REF_CHECK (NODE), 3)
 150
 151 /* CLASS_INTERFACE_TYPE, CLASS_IMPLEMENTATION_TYPE,
 152    CATEGORY_INTERFACE_TYPE, CATEGORY_IMPLEMENTATION_TYPE,
 153    PROTOCOL_INTERFACE_TYPE */
 154 /* CLASS_NAME is the name of the class.  */
 155 #define CLASS_NAME(CLASS) (TYPE_NAME (CLASS))
 156 /* CLASS_SUPER_NAME is the name of the superclass, or, in the case of
 157    categories, it is the name of the category itself.  */
 158 #define CLASS_SUPER_NAME(CLASS) (TYPE_CONTEXT (CLASS))
 159 #define CLASS_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
 160 #define CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
 161 #define CLASS_NST_METHODS(CLASS) (TYPE_MINVAL (CLASS))
 162 #define CLASS_CLS_METHODS(CLASS) (TYPE_MAXVAL (CLASS))
 163 #define CLASS_STATIC_TEMPLATE(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
 164 #define CLASS_CATEGORY_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
 165 #define CLASS_PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 4)
 166 #define TOTAL_CLASS_RAW_IVARS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 5)
 167 #define CLASS_HAS_EXCEPTION_ATTR(CLASS) (TYPE_LANG_FLAG_0 (CLASS))
 168
 169 #define PROTOCOL_NAME(CLASS) (TYPE_NAME (CLASS))
 170 #define PROTOCOL_LIST(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 0)
 171 #define PROTOCOL_NST_METHODS(CLASS) (TYPE_MINVAL (CLASS))
 172 #define PROTOCOL_CLS_METHODS(CLASS) (TYPE_MAXVAL (CLASS))
 173 #define PROTOCOL_FORWARD_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 1)
 174 #define PROTOCOL_DEFINED(CLASS) TREE_USED (CLASS)
 175 #define PROTOCOL_OPTIONAL_CLS_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 2)
 176 #define PROTOCOL_OPTIONAL_NST_METHODS(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 3)
 177
 178 /* For CATEGORY_INTERFACE_TYPE, CLASS_INTERFACE_TYPE or PROTOCOL_INTERFACE_TYPE */
 179 #define CLASS_PROPERTY_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 6)
 180 /* For CLASS_IMPLEMENTATION_TYPE or CATEGORY_IMPLEMENTATION_TYPE. */
 181 #define IMPL_PROPERTY_DECL(CLASS) TREE_VEC_ELT (TYPE_LANG_SLOT_1 (CLASS), 6)
 182
 183 /* TREE_DEPRECATED is used for a CLASS_INTERFACE_TYPE or PROTOCOL_INTERFACE_TYPE.  */
 184
 185 /* TYPE_ATTRIBUTES is used for a CLASS_INTERFACE_TYPE or PROTOCOL_INTERFACE_TYPE.  */
 186
 187 /* ObjC-specific information pertaining to RECORD_TYPEs are stored in
 188    the LANG_SPECIFIC structures, which may itself need allocating first.  */
 189
 190 /* The following three macros must be overridden (in objcp/objcp-decl.h)
 191    for Objective-C++.  */
 192 #define TYPE_OBJC_INFO(TYPE) TYPE_LANG_SPECIFIC (TYPE)->objc_info
 193 #define SIZEOF_OBJC_TYPE_LANG_SPECIFIC sizeof (struct lang_type)
 194 #define ALLOC_OBJC_TYPE_LANG_SPECIFIC(NODE)                             \
 195   do {                                                                  \
 196     TYPE_LANG_SPECIFIC (NODE)                                           \
 197       = ggc_alloc_cleared_lang_type (sizeof (struct lang_type));        \
 198   } while (0)
 199
 200 #define TYPE_HAS_OBJC_INFO(TYPE)                                \
 201         (TYPE_LANG_SPECIFIC (TYPE) && TYPE_OBJC_INFO (TYPE))
 202 #define TYPE_OBJC_INTERFACE(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 0)
 203 #define TYPE_OBJC_PROTOCOL_LIST(TYPE) TREE_VEC_ELT (TYPE_OBJC_INFO (TYPE), 1)
 204
 205
 206 #define INIT_TYPE_OBJC_INFO(TYPE)                               \
 207         do                                                      \
 208           {                                                     \
 209             if (!TYPE_LANG_SPECIFIC (TYPE))                     \
 210               ALLOC_OBJC_TYPE_LANG_SPECIFIC(TYPE);              \
 211             if (!TYPE_OBJC_INFO (TYPE))                         \
 212               TYPE_OBJC_INFO (TYPE)                             \
 213                 = make_tree_vec (OBJC_INFO_SLOT_ELTS);          \
 214           }                                                     \
 215         while (0)
 216
 217 #define DUP_TYPE_OBJC_INFO(DST, SRC)                            \
 218         do                                                      \
 219           {                                                     \
 220             ALLOC_OBJC_TYPE_LANG_SPECIFIC(DST);                 \
 221             if (TYPE_LANG_SPECIFIC (SRC))                       \
 222               memcpy (TYPE_LANG_SPECIFIC (DST),                 \
 223                       TYPE_LANG_SPECIFIC (SRC),                 \
 224                       SIZEOF_OBJC_TYPE_LANG_SPECIFIC);          \
 225             TYPE_OBJC_INFO (DST)                                \
 226               = make_tree_vec (OBJC_INFO_SLOT_ELTS);            \
 227           }                                                     \
 228         while (0)
 229
 230 #define TYPED_OBJECT(TYPE)                                      \
 231         (TREE_CODE (TYPE) == RECORD_TYPE                        \
 232          && TYPE_HAS_OBJC_INFO (TYPE)                           \
 233          && TYPE_OBJC_INTERFACE (TYPE))
 234 #define OBJC_TYPE_NAME(TYPE) TYPE_NAME(TYPE)
 235 #define OBJC_SET_TYPE_NAME(TYPE, NAME) (TYPE_NAME (TYPE) = NAME)
 236
 237 /* Hash tables to manage the global pool of method prototypes.  */
 238
 239 typedef struct hashed_entry     *hash;
 240 typedef struct hashed_attribute *attr;
 241
 242 struct GTY(()) hashed_attribute {
 243   attr next;
 244   tree value;
 245 };
 246
 247 struct GTY(()) hashed_entry {
 248   attr list;
 249   hash next;
 250   tree key;
 251 };
 252
 253 #define SIZEHASHTABLE           257
 254
 255 /* An array of all the local variables in the current function that
 256    need to be marked as volatile.  */
 257 extern GTY(()) vec<tree, va_gc> *local_variables_to_volatilize;
 258
 259 /* Objective-C/Objective-C++ @implementation list.  */
 260
 261 struct GTY(()) imp_entry {
 262   struct imp_entry *next;
 263   tree imp_context;
 264   tree imp_template;
 265   tree class_decl;              /* _OBJC[_v2]_CLASS/CATEGORY_<my_name>; */
 266   tree meta_decl;               /* _OBJC[_v2]_METACLASS_<my_name>; */
 267   BOOL_BITFIELD has_cxx_cdtors : 1;
 268 };
 269
 270 extern GTY(()) struct imp_entry *imp_list;
 271 extern GTY(()) int imp_count;   /* `@implementation' */
 272 extern GTY(()) int cat_count;   /* `@category' */
 273
 274 extern GTY(()) objc_ivar_visibility_kind objc_ivar_visibility;
 275
 276 /* Objective-C/Objective-C++ global tree enumeration.  */
 277
 278 enum objc_tree_index
 279 {
 280     OCTI_STATIC_NST,
 281     OCTI_STATIC_NST_DECL,
 282     OCTI_SELF_ID,
 283     OCTI_UCMD_ID,
 284
 285     OCTI_SELF_DECL,
 286     OCTI_UMSG_DECL,
 287     OCTI_UMSG_FAST_DECL,
 288     OCTI_UMSG_SUPER_DECL,
 289     OCTI_UMSG_STRET_DECL,
 290     OCTI_UMSG_SUPER_STRET_DECL,
 291     OCTI_GET_CLASS_DECL,
 292     OCTI_GET_MCLASS_DECL,
 293     OCTI_SUPER_TYPE,
 294     OCTI_SEL_TYPE,
 295     OCTI_ID_TYPE,
 296     OCTI_CLS_TYPE,
 297     OCTI_NST_TYPE,
 298     OCTI_PROTO_TYPE,
 299
 300     OCTI_INTF_CHAIN,
 301     OCTI_PROTO_CHAIN,
 302     OCTI_IMPL_CHAIN,
 303     OCTI_CLS_REF_CHAIN,
 304     OCTI_SEL_REF_CHAIN,
 305     OCTI_IVAR_CHAIN,
 306     OCTI_CLS_NAMES_CHAIN,
 307     OCTI_METH_VAR_NAMES_CHAIN,
 308     OCTI_METH_VAR_TYPES_CHAIN,
 309
 310     OCTI_SYMBOLS_DECL,
 311     OCTI_NST_VAR_DECL,
 312     OCTI_CLS_VAR_DECL,
 313     OCTI_NST_METH_DECL,
 314     OCTI_CLS_METH_DECL,
 315     OCTI_CLS_DECL,
 316     OCTI_MCLS_DECL,
 317     OCTI_SEL_TABLE_DECL,
 318     OCTI_MODULES_DECL,
 319     OCTI_GNU_INIT_DECL,
 320
 321     OCTI_INTF_CTX,
 322     OCTI_IMPL_CTX,
 323     OCTI_METH_CTX,
 324     OCTI_IVAR_CTX,
 325
 326     OCTI_IMPL_TEMPL,
 327     OCTI_CLS_TEMPL,
 328     OCTI_CAT_TEMPL,
 329     OCTI_UPRIV_REC,
 330     OCTI_PROTO_TEMPL,
 331     OCTI_SEL_TEMPL,
 332     OCTI_UCLS_SUPER_REF,
 333     OCTI_UUCLS_SUPER_REF,
 334     OCTI_METH_TEMPL,
 335     OCTI_IVAR_TEMPL,
 336     OCTI_METH_LIST_TEMPL,
 337     OCTI_METH_PROTO_LIST_TEMPL,
 338     OCTI_IVAR_LIST_TEMPL,
 339     OCTI_SYMTAB_TEMPL,
 340     OCTI_MODULE_TEMPL,
 341     OCTI_SUPER_TEMPL,
 342     OCTI_OBJ_REF,
 343     OCTI_CLS_REF,
 344     OCTI_METH_PROTO_TEMPL,
 345     OCTI_FUNCTION1_TEMPL,
 346     OCTI_FUNCTION2_TEMPL,
 347
 348     OCTI_OBJ_ID,
 349     OCTI_CLS_ID,
 350     OCTI_ID_NAME,
 351     OCTI_CLASS_NAME,
 352     OCTI_CNST_STR_ID,
 353     OCTI_CNST_STR_TYPE,
 354     OCTI_CNST_STR_GLOB_ID,
 355     OCTI_STRING_CLASS_DECL,
 356     OCTI_INTERNAL_CNST_STR_TYPE,
 357     OCTI_SUPER_DECL,
 358     OCTI_SUPER_SUPERFIELD_ID,
 359     OCTI_UMSG_NONNIL_DECL,
 360     OCTI_UMSG_NONNIL_STRET_DECL,
 361     OCTI_STORAGE_CLS,
 362     OCTI_EXCEPTION_EXTRACT_DECL,
 363     OCTI_EXCEPTION_TRY_ENTER_DECL,
 364     OCTI_EXCEPTION_TRY_EXIT_DECL,
 365     OCTI_EXCEPTION_MATCH_DECL,
 366     OCTI_EXCEPTION_THROW_DECL,
 367     OCTI_SYNC_ENTER_DECL,
 368     OCTI_SYNC_EXIT_DECL,
 369     OCTI_SETJMP_DECL,
 370     OCTI_EXCDATA_TEMPL,
 371     OCTI_STACK_EXCEPTION_DATA_DECL,
 372     OCTI_LOCAL_EXCEPTION_DECL,
 373     OCTI_RETHROW_EXCEPTION_DECL,
 374     OCTI_EVAL_ONCE_DECL,
 375     OCTI_CATCH_TYPE,
 376     OCTI_EXECCLASS_DECL,
 377
 378     OCTI_ASSIGN_IVAR_DECL,
 379     OCTI_ASSIGN_IVAR_FAST_DECL,
 380     OCTI_ASSIGN_GLOBAL_DECL,
 381     OCTI_ASSIGN_STRONGCAST_DECL,
 382
 383     OCTI_FAST_ENUM_STATE_TEMP,
 384     OCTI_ENUM_MUTATION_DECL,
 385
 386     OCTI_GET_PROPERTY_DECL,
 387     OCTI_SET_PROPERTY_DECL,
 388     OCTI_COPY_STRUCT_DECL,
 389     OCTI_GET_PROPERTY_STRUCT_DECL,
 390     OCTI_SET_PROPERTY_STRUCT_DECL,
 391
 392     /* TODO: Add comment.  */
 393     /* "V1" stuff.  */
 394     OCTI_V1_PROP_LIST_TEMPL,
 395     OCTI_V1_PROP_NAME_ATTR_CHAIN,
 396
 397     OCTI_MAX
 398 };
 399
 400 extern GTY(()) tree objc_global_trees[OCTI_MAX];
 401
 402 /* List of classes with list of their static instances.  */
 403 #define objc_static_instances   objc_global_trees[OCTI_STATIC_NST]
 404
 405 /* The declaration of the array administrating the static instances.  */
 406 #define static_instances_decl   objc_global_trees[OCTI_STATIC_NST_DECL]
 407
 408 /* Some commonly used instances of "identifier_node".  */
 409
 410 #define self_id                 objc_global_trees[OCTI_SELF_ID]
 411 #define ucmd_id                 objc_global_trees[OCTI_UCMD_ID]
 412
 413 #define self_decl               objc_global_trees[OCTI_SELF_DECL]
 414 #define umsg_decl               objc_global_trees[OCTI_UMSG_DECL]
 415 #define umsg_fast_decl          objc_global_trees[OCTI_UMSG_FAST_DECL]
 416 #define umsg_super_decl         objc_global_trees[OCTI_UMSG_SUPER_DECL]
 417 #define umsg_stret_decl         objc_global_trees[OCTI_UMSG_STRET_DECL]
 418 #define umsg_super_stret_decl   objc_global_trees[OCTI_UMSG_SUPER_STRET_DECL]
 419 #define objc_get_class_decl     objc_global_trees[OCTI_GET_CLASS_DECL]
 420 #define objc_get_meta_class_decl                        \
 421                                 objc_global_trees[OCTI_GET_MCLASS_DECL]
 422
 423 #define objc_super_type         objc_global_trees[OCTI_SUPER_TYPE]
 424 #define objc_selector_type              objc_global_trees[OCTI_SEL_TYPE]
 425 #define objc_object_type        objc_global_trees[OCTI_ID_TYPE]
 426 #define objc_class_type         objc_global_trees[OCTI_CLS_TYPE]
 427 #define objc_instance_type      objc_global_trees[OCTI_NST_TYPE]
 428 #define objc_protocol_type      objc_global_trees[OCTI_PROTO_TYPE]
 429
 430 /* Type checking macros.  */
 431
 432 #define IS_ID(TYPE)                                                     \
 433         (TREE_CODE (TYPE) == POINTER_TYPE                               \
 434          && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE))                       \
 435              == TREE_TYPE (objc_object_type)))
 436
 437 #define IS_CLASS(TYPE)                                                  \
 438         (TREE_CODE (TYPE) == POINTER_TYPE                               \
 439          && (TYPE_MAIN_VARIANT (TREE_TYPE (TYPE))                       \
 440              == TREE_TYPE (objc_class_type)))
 441
 442 #define IS_PROTOCOL_QUALIFIED_UNTYPED(TYPE)                             \
 443         ((IS_ID (TYPE) || IS_CLASS (TYPE))                              \
 444          && TYPE_HAS_OBJC_INFO (TREE_TYPE (TYPE))                       \
 445          && TYPE_OBJC_PROTOCOL_LIST (TREE_TYPE (TYPE)))
 446
 447 #define IS_SUPER(TYPE)                                                  \
 448         (TREE_CODE (TYPE) == POINTER_TYPE                               \
 449          && TREE_TYPE (TYPE) == objc_super_template)
 450
 451 #define interface_chain         objc_global_trees[OCTI_INTF_CHAIN]
 452 #define protocol_chain          objc_global_trees[OCTI_PROTO_CHAIN]
 453 #define implemented_classes     objc_global_trees[OCTI_IMPL_CHAIN]
 454
 455 /* Chains to manage selectors that are referenced and defined in the
 456    module.  */
 457
 458 #define cls_ref_chain           objc_global_trees[OCTI_CLS_REF_CHAIN]   /* Classes referenced.  */
 459 #define sel_ref_chain           objc_global_trees[OCTI_SEL_REF_CHAIN]   /* Selectors referenced.  */
 460 #define objc_ivar_chain         objc_global_trees[OCTI_IVAR_CHAIN]
 461
 462 /* Chains to manage uniquing of strings.  */
 463
 464 #define class_names_chain       objc_global_trees[OCTI_CLS_NAMES_CHAIN]
 465 #define meth_var_names_chain    objc_global_trees[OCTI_METH_VAR_NAMES_CHAIN]
 466 #define meth_var_types_chain    objc_global_trees[OCTI_METH_VAR_TYPES_CHAIN]
 467
 468
 469 /* Backend data declarations.  */
 470
 471 #define UOBJC_SYMBOLS_decl              objc_global_trees[OCTI_SYMBOLS_DECL]
 472 #define UOBJC_INSTANCE_VARIABLES_decl   objc_global_trees[OCTI_NST_VAR_DECL]
 473 #define UOBJC_CLASS_VARIABLES_decl      objc_global_trees[OCTI_CLS_VAR_DECL]
 474 #define UOBJC_INSTANCE_METHODS_decl     objc_global_trees[OCTI_NST_METH_DECL]
 475 #define UOBJC_CLASS_METHODS_decl        objc_global_trees[OCTI_CLS_METH_DECL]
 476 #define UOBJC_CLASS_decl                objc_global_trees[OCTI_CLS_DECL]
 477 #define UOBJC_METACLASS_decl            objc_global_trees[OCTI_MCLS_DECL]
 478 #define UOBJC_SELECTOR_TABLE_decl       objc_global_trees[OCTI_SEL_TABLE_DECL]
 479 #define UOBJC_MODULES_decl              objc_global_trees[OCTI_MODULES_DECL]
 480 #define GNU_INIT_decl                   objc_global_trees[OCTI_GNU_INIT_DECL]
 481
 482 /* The following are used when compiling a class implementation.
 483    implementation_template will normally be an interface, however if
 484    none exists this will be equal to objc_implementation_context...it is
 485    set in start_class.  */
 486
 487 #define objc_interface_context          objc_global_trees[OCTI_INTF_CTX]
 488 #define objc_implementation_context     objc_global_trees[OCTI_IMPL_CTX]
 489 #define objc_method_context             objc_global_trees[OCTI_METH_CTX]
 490 #define objc_ivar_context               objc_global_trees[OCTI_IVAR_CTX]
 491
 492 #define implementation_template objc_global_trees[OCTI_IMPL_TEMPL]
 493 #define objc_class_template     objc_global_trees[OCTI_CLS_TEMPL]
 494 #define objc_category_template  objc_global_trees[OCTI_CAT_TEMPL]
 495 #define uprivate_record         objc_global_trees[OCTI_UPRIV_REC]
 496 #define objc_protocol_template  objc_global_trees[OCTI_PROTO_TEMPL]
 497 #define objc_selector_template  objc_global_trees[OCTI_SEL_TEMPL]
 498 #define ucls_super_ref          objc_global_trees[OCTI_UCLS_SUPER_REF]
 499 #define uucls_super_ref         objc_global_trees[OCTI_UUCLS_SUPER_REF]
 500
 501 #define umsg_nonnil_decl        objc_global_trees[OCTI_UMSG_NONNIL_DECL]
 502 #define umsg_nonnil_stret_decl  objc_global_trees[OCTI_UMSG_NONNIL_STRET_DECL]
 503 #define objc_storage_class      objc_global_trees[OCTI_STORAGE_CLS]
 504 #define objc_exception_extract_decl             \
 505                                 objc_global_trees[OCTI_EXCEPTION_EXTRACT_DECL]
 506 #define objc_exception_try_enter_decl           \
 507                                 objc_global_trees[OCTI_EXCEPTION_TRY_ENTER_DECL]
 508 #define objc_exception_try_exit_decl            \
 509                                 objc_global_trees[OCTI_EXCEPTION_TRY_EXIT_DECL]
 510 #define objc_exception_match_decl               \
 511                                 objc_global_trees[OCTI_EXCEPTION_MATCH_DECL]
 512 #define objc_exception_throw_decl               \
 513                                 objc_global_trees[OCTI_EXCEPTION_THROW_DECL]
 514 #define objc_sync_enter_decl    objc_global_trees[OCTI_SYNC_ENTER_DECL]
 515 #define objc_sync_exit_decl     objc_global_trees[OCTI_SYNC_EXIT_DECL]
 516 #define objc_exception_data_template            \
 517                                 objc_global_trees[OCTI_EXCDATA_TEMPL]
 518 #define objc_setjmp_decl        objc_global_trees[OCTI_SETJMP_DECL]
 519 #define objc_stack_exception_data               \
 520                                 objc_global_trees[OCTI_STACK_EXCEPTION_DATA_DECL]
 521 #define objc_caught_exception   objc_global_trees[OCTI_LOCAL_EXCEPTION_DECL]
 522 #define objc_rethrow_exception  objc_global_trees[OCTI_RETHROW_EXCEPTION_DECL]
 523 #define objc_eval_once          objc_global_trees[OCTI_EVAL_ONCE_DECL]
 524 #define objc_catch_type         objc_global_trees[OCTI_CATCH_TYPE]
 525
 526 #define execclass_decl          objc_global_trees[OCTI_EXECCLASS_DECL]
 527
 528 #define objc_assign_ivar_decl   objc_global_trees[OCTI_ASSIGN_IVAR_DECL]
 529 #define objc_assign_ivar_fast_decl              \
 530                                 objc_global_trees[OCTI_ASSIGN_IVAR_FAST_DECL]
 531 #define objc_assign_global_decl objc_global_trees[OCTI_ASSIGN_GLOBAL_DECL]
 532 #define objc_assign_strong_cast_decl            \
 533                                 objc_global_trees[OCTI_ASSIGN_STRONGCAST_DECL]
 534
 535 #define objc_method_template    objc_global_trees[OCTI_METH_TEMPL]
 536 #define objc_ivar_template      objc_global_trees[OCTI_IVAR_TEMPL]
 537 #define objc_method_list_ptr    objc_global_trees[OCTI_METH_LIST_TEMPL]
 538 #define objc_method_proto_list_ptr              \
 539                                 objc_global_trees[OCTI_METH_PROTO_LIST_TEMPL]
 540 #define objc_ivar_list_ptr      objc_global_trees[OCTI_IVAR_LIST_TEMPL]
 541 #define objc_symtab_template    objc_global_trees[OCTI_SYMTAB_TEMPL]
 542 #define objc_module_template    objc_global_trees[OCTI_MODULE_TEMPL]
 543 #define objc_super_template     objc_global_trees[OCTI_SUPER_TEMPL]
 544 #define objc_object_reference   objc_global_trees[OCTI_OBJ_REF]
 545 #define objc_class_reference    objc_global_trees[OCTI_CLS_REF]
 546 #define objc_method_prototype_template          \
 547                                 objc_global_trees[OCTI_METH_PROTO_TEMPL]
 548 #define function1_template      objc_global_trees[OCTI_FUNCTION1_TEMPL]
 549 #define function2_template      objc_global_trees[OCTI_FUNCTION2_TEMPL]
 550
 551 #define objc_object_id          objc_global_trees[OCTI_OBJ_ID]
 552 #define objc_class_id           objc_global_trees[OCTI_CLS_ID]
 553 #define objc_object_name                objc_global_trees[OCTI_ID_NAME]
 554 #define objc_class_name         objc_global_trees[OCTI_CLASS_NAME]
 555
 556 /* Constant string classes.  */
 557 #define constant_string_id      objc_global_trees[OCTI_CNST_STR_ID]
 558 #define constant_string_type    objc_global_trees[OCTI_CNST_STR_TYPE]
 559 #define constant_string_global_id               \
 560                                 objc_global_trees[OCTI_CNST_STR_GLOB_ID]
 561 #define string_class_decl       objc_global_trees[OCTI_STRING_CLASS_DECL]
 562 #define internal_const_str_type objc_global_trees[OCTI_INTERNAL_CNST_STR_TYPE]
 563
 564 #define UOBJC_SUPER_decl        objc_global_trees[OCTI_SUPER_DECL]
 565 #define super_superclassfield_id \
 566                                 objc_global_trees[OCTI_SUPER_SUPERFIELD_ID]
 567
 568 #define objc_fast_enumeration_state_template    \
 569                                 objc_global_trees[OCTI_FAST_ENUM_STATE_TEMP]
 570 #define objc_enumeration_mutation_decl          \
 571                                 objc_global_trees[OCTI_ENUM_MUTATION_DECL]
 572
 573 /* Declarations of functions used when synthesizing property
 574    accessors.  */
 575 #define objc_getProperty_decl   objc_global_trees[OCTI_GET_PROPERTY_DECL]
 576 #define objc_setProperty_decl   objc_global_trees[OCTI_SET_PROPERTY_DECL]
 577 #define objc_copyStruct_decl    objc_global_trees[OCTI_COPY_STRUCT_DECL]
 578 #define objc_getPropertyStruct_decl \
 579                                 objc_global_trees[OCTI_GET_PROPERTY_STRUCT_DECL]
 580 #define objc_setPropertyStruct_decl \
 581                                 objc_global_trees[OCTI_SET_PROPERTY_STRUCT_DECL]
 582
 583 /* TODO: Add comment.  */
 584 /* V1 stuff.  */
 585 #define objc_prop_list_ptr      objc_global_trees[OCTI_V1_PROP_LIST_TEMPL]
 586 #define prop_names_attr_chain   objc_global_trees[OCTI_V1_PROP_NAME_ATTR_CHAIN]
 587
 588 /* Reserved tag definitions.  */
 589
 590 #define OBJECT_TYPEDEF_NAME             "id"
 591 #define CLASS_TYPEDEF_NAME              "Class"
 592
 593 #define TAG_OBJECT                      "objc_object"
 594 #define TAG_CLASS                       "objc_class"
 595 #define TAG_SUPER                       "objc_super"
 596 #define TAG_SELECTOR                    "objc_selector"
 597
 598 #define UTAG_CLASS                      "_objc_class"
 599 #define UTAG_IVAR                       "_objc_ivar"
 600 #define UTAG_IVAR_LIST                  "_objc_ivar_list"
 601 #define UTAG_METHOD                     "_objc_method"
 602 #define UTAG_METHOD_LIST                "_objc_method_list"
 603 #define UTAG_CATEGORY                   "_objc_category"
 604 #define UTAG_MODULE                     "_objc_module"
 605 #define UTAG_SYMTAB                     "_objc_symtab"
 606 #define UTAG_SUPER                      "_objc_super"
 607 #define UTAG_SELECTOR                   "_objc_selector"
 608
 609 #define UTAG_PROTOCOL                   "_objc_protocol"
 610 #define UTAG_METHOD_PROTOTYPE           "_objc_method_prototype"
 611 #define UTAG_METHOD_PROTOTYPE_LIST      "_objc__method_prototype_list"
 612
 613 #define PROTOCOL_OBJECT_CLASS_NAME      "Protocol"
 614
 615 #define TAG_EXCEPTIONTHROW              "objc_exception_throw"
 616 #define TAG_SYNCENTER                   "objc_sync_enter"
 617 #define TAG_SYNCEXIT                    "objc_sync_exit"
 618
 619 /* Really should be NeXT private.  */
 620 #define UTAG_EXCDATA                    "_objc_exception_data"
 621
 622 #define TAG_CXX_CONSTRUCT               ".cxx_construct"
 623 #define TAG_CXX_DESTRUCT                ".cxx_destruct"
 624
 625 #define TAG_ENUMERATION_MUTATION        "objc_enumerationMutation"
 626 #define TAG_FAST_ENUMERATION_STATE      "__objcFastEnumerationState"
 627
 628 typedef enum string_section
 629 {
 630   class_names,          /* class, category, protocol, module names */
 631   meth_var_names,       /* method and variable names */
 632   meth_var_types,       /* method and variable type descriptors */
 633   prop_names_attr       /* property names and their attributes. */
 634 } string_section;
 635
 636 #define METHOD_DEF                      0
 637 #define METHOD_REF                      1
 638
 639 #define BUFSIZE                         1024
 640
 641 #define CLS_FACTORY                     0x0001L
 642 #define CLS_META                        0x0002L
 643
 644 /* Runtime metadata flags - ??? apparently unused.  */
 645
 646 #define OBJC_MODIFIER_STATIC            0x00000001
 647 #define OBJC_MODIFIER_FINAL             0x00000002
 648 #define OBJC_MODIFIER_PUBLIC            0x00000004
 649 #define OBJC_MODIFIER_PRIVATE           0x00000008
 650 #define OBJC_MODIFIER_PROTECTED         0x00000010
 651 #define OBJC_MODIFIER_NATIVE            0x00000020
 652 #define OBJC_MODIFIER_SYNCHRONIZED      0x00000040
 653 #define OBJC_MODIFIER_ABSTRACT          0x00000080
 654 #define OBJC_MODIFIER_VOLATILE          0x00000100
 655 #define OBJC_MODIFIER_TRANSIENT         0x00000200
 656 #define OBJC_MODIFIER_NONE_SPECIFIED    0x80000000
 657
 658 /* Exception handling constructs.  We begin by having the parser do most
 659    of the work and passing us blocks.
 660    This allows us to handle different exceptions implementations.  */
 661
 662 /* Stack of open try blocks.  */
 663
 664 struct objc_try_context
 665 {
 666   struct objc_try_context *outer;
 667
 668   /* Statements (or statement lists) as processed by the parser.  */
 669   tree try_body;
 670   tree finally_body;
 671
 672   /* Some file position locations.  */
 673   location_t try_locus;
 674   location_t end_try_locus;
 675   location_t end_catch_locus;
 676   location_t finally_locus;
 677   location_t end_finally_locus;
 678
 679   /* A STATEMENT_LIST of CATCH_EXPRs, appropriate for sticking into op1
 680      of a TRY_CATCH_EXPR.  Even when doing Darwin setjmp.  */
 681   tree catch_list;
 682
 683   /* The CATCH_EXPR of an open @catch clause.  */
 684   tree current_catch;
 685
 686   /* The VAR_DECL holding  __builtin_eh_pointer (or equivalent).  */
 687   tree caught_decl;
 688   tree stack_decl;
 689   tree rethrow_decl;
 690 };
 691
 692 /*  A small number of routines used by the FE parser and the runtime code
 693    generators.  Put here as inlines for efficiency in non-lto builds rather
 694    than making them externs.  */
 695
 696 extern tree objc_create_temporary_var (tree, const char *);
 697
 698 #define objc_is_object_id(TYPE) (OBJC_TYPE_NAME (TYPE) == objc_object_id)
 699 #define objc_is_class_id(TYPE) (OBJC_TYPE_NAME (TYPE) == objc_class_id)
 700
 701 /* Retrieve category interface CAT_NAME (if any) associated with CLASS.  */
 702 static inline tree
 703 lookup_category (tree klass, tree cat_name)
 704 {
 705   tree category = CLASS_CATEGORY_LIST (klass);
 706
 707   while (category && CLASS_SUPER_NAME (category) != cat_name)
 708     category = CLASS_CATEGORY_LIST (category);
 709   return category;
 710 }
 711
 712 /* Count only the fields occurring in T.  */
 713 static inline int
 714 ivar_list_length (tree t)
 715 {
 716   int count = 0;
 717
 718   for (; t; t = DECL_CHAIN (t))
 719     if (TREE_CODE (t) == FIELD_DECL)
 720       ++count;
 721
 722   return count;
 723 }
 724
 725 static inline tree
 726 is_ivar (tree decl_chain, tree ident)
 727 {
 728   for ( ; decl_chain; decl_chain = DECL_CHAIN (decl_chain))
 729     if (DECL_NAME (decl_chain) == ident)
 730       return decl_chain;
 731   return NULL_TREE;
 732 }
 733
 734 #endif /* GCC_OBJC_ACT_H */