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