libobjc/objc/objc-api.h

   1 /* GNU Objective-C Runtime API.
   2    Copyright (C) 1993, 1995, 1996, 1997, 2002, 2004 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 it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT
  12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  14 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 COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* As a special exception, if you link this library with files compiled
  22    with GCC to produce an executable, this does not cause the resulting
  23    executable to be covered by the GNU General Public License.  This
  24    exception does not however invalidate any other reasons why the
  25    executable file might be covered by the GNU General Public License. */
  26
  27 #ifndef __objc_api_INCLUDE_GNU
  28 #define __objc_api_INCLUDE_GNU
  29
  30 #include "objc/objc.h"
  31 #include "objc/hash.h"
  32 #include "objc/thr.h"
  33 #include "objc/objc-decls.h"
  34 #include <stdio.h>
  35 #include <stdarg.h>
  36
  37 /* For functions which return Method_t */
  38 #define METHOD_NULL     (Method_t)0
  39                                                 /* Boolean typedefs */
  40 /*
  41 ** Method descriptor returned by introspective Object methods.
  42 ** This is really just the first part of the more complete objc_method
  43 ** structure defined below and used internally by the runtime.
  44 */
  45 struct objc_method_description
  46 {
  47     SEL name;                   /* this is a selector, not a string */
  48     char *types;                /* type encoding */
  49 };
  50
  51 /* Filer types used to describe Ivars and Methods.  */
  52 #define _C_ID       '@'
  53 #define _C_CLASS    '#'
  54 #define _C_SEL      ':'
  55 #define _C_CHR      'c'
  56 #define _C_UCHR     'C'
  57 #define _C_SHT      's'
  58 #define _C_USHT     'S'
  59 #define _C_INT      'i'
  60 #define _C_UINT     'I'
  61 #define _C_LNG      'l'
  62 #define _C_ULNG     'L'
  63 #define _C_LNG_LNG  'q'
  64 #define _C_ULNG_LNG 'Q'
  65 #define _C_FLT      'f'
  66 #define _C_DBL      'd'
  67 #define _C_BFLD     'b'
  68 #define _C_VOID     'v'
  69 #define _C_UNDEF    '?'
  70 #define _C_PTR      '^'
  71 #define _C_CHARPTR  '*'
  72 #define _C_ATOM     '%'
  73 #define _C_ARY_B    '['
  74 #define _C_ARY_E    ']'
  75 #define _C_UNION_B  '('
  76 #define _C_UNION_E  ')'
  77 #define _C_STRUCT_B '{'
  78 #define _C_STRUCT_E '}'
  79 #define _C_VECTOR   '!'
  80
  81
  82 /*
  83 ** Error handling
  84 **
  85 ** Call objc_error() or objc_verror() to record an error; this error
  86 ** routine will generally exit the program but not necessarily if the
  87 ** user has installed his own error handler.
  88 **
  89 ** Call objc_set_error_handler to assign your own function for
  90 ** handling errors.  The function should return YES if it is ok
  91 ** to continue execution, or return NO or just abort if the
  92 ** program should be stopped.  The default error handler is just to
  93 ** print a message on stderr.
  94 **
  95 ** The error handler function should be of type objc_error_handler
  96 ** The first parameter is an object instance of relevance.
  97 ** The second parameter is an error code.
  98 ** The third parameter is a format string in the printf style.
  99 ** The fourth parameter is a variable list of arguments.
 100 */
 101 extern void objc_error(id object, int code, const char* fmt, ...);
 102 extern void objc_verror(id object, int code, const char* fmt, va_list ap);
 103 typedef BOOL (*objc_error_handler)(id, int code, const char *fmt, va_list ap);
 104 extern objc_error_handler objc_set_error_handler(objc_error_handler func);
 105
 106 /*
 107 ** Error codes
 108 ** These are used by the runtime library, and your
 109 ** error handling may use them to determine if the error is
 110 ** hard or soft thus whether execution can continue or abort.
 111 */
 112 #define OBJC_ERR_UNKNOWN 0             /* Generic error */
 113
 114 #define OBJC_ERR_OBJC_VERSION 1        /* Incorrect runtime version */
 115 #define OBJC_ERR_GCC_VERSION 2         /* Incorrect compiler version */
 116 #define OBJC_ERR_MODULE_SIZE 3         /* Bad module size */
 117 #define OBJC_ERR_PROTOCOL_VERSION 4    /* Incorrect protocol version */
 118
 119 #define OBJC_ERR_MEMORY 10             /* Out of memory */
 120
 121 #define OBJC_ERR_RECURSE_ROOT 20       /* Attempt to archive the root
 122                                           object more than once. */
 123 #define OBJC_ERR_BAD_DATA 21           /* Didn't read expected data */
 124 #define OBJC_ERR_BAD_KEY 22            /* Bad key for object */
 125 #define OBJC_ERR_BAD_CLASS 23          /* Unknown class */
 126 #define OBJC_ERR_BAD_TYPE 24           /* Bad type specification */
 127 #define OBJC_ERR_NO_READ 25            /* Cannot read stream */
 128 #define OBJC_ERR_NO_WRITE 26           /* Cannot write stream */
 129 #define OBJC_ERR_STREAM_VERSION 27     /* Incorrect stream version */
 130 #define OBJC_ERR_BAD_OPCODE 28         /* Bad opcode */
 131
 132 #define OBJC_ERR_UNIMPLEMENTED 30      /* Method is not implemented */
 133
 134 #define OBJC_ERR_BAD_STATE 40          /* Bad thread state */
 135
 136 /*
 137 ** Set this variable nonzero to print a line describing each
 138 ** message that is sent.  (this is currently disabled)
 139 */
 140 extern BOOL objc_trace;
 141
 142
 143 /* For every class which happens to have statically allocated instances in
 144    this module, one OBJC_STATIC_INSTANCES is allocated by the compiler.
 145    INSTANCES is NULL terminated and points to all statically allocated
 146    instances of this class.  */
 147 struct objc_static_instances
 148 {
 149   char *class_name;
 150   id instances[0];
 151 };
 152
 153 /*
 154 ** Whereas a Module (defined further down) is the root (typically) of a file,
 155 ** a Symtab is the root of the class and category definitions within the
 156 ** module.
 157 **
 158 ** A Symtab contains a variable length array of pointers to classes and
 159 ** categories  defined in the module.
 160 */
 161 typedef struct objc_symtab {
 162   unsigned long sel_ref_cnt;                     /* Unknown. */
 163   SEL        refs;                              /* Unknown. */
 164   unsigned short cls_def_cnt;                   /* Number of classes compiled
 165                                                   (defined) in the module. */
 166   unsigned short cat_def_cnt;                   /* Number of categories
 167                                                   compiled (defined) in the
 168                                                   module. */
 169
 170   void      *defs[1];                           /* Variable array of pointers.
 171                                                   cls_def_cnt of type Class
 172                                                   followed by cat_def_cnt of
 173                                                   type Category_t, followed
 174                                                   by a NULL terminated array
 175                                                   of objc_static_instances. */
 176 } Symtab,   *Symtab_t;
 177
 178
 179 /*
 180 ** The compiler generates one of these structures for each module that
 181 ** composes the executable (eg main.m).
 182 **
 183 ** This data structure is the root of the definition tree for the module.
 184 **
 185 ** A collect program runs between ld stages and creates a ObjC ctor array.
 186 ** That array holds a pointer to each module structure of the executable.
 187 */
 188 typedef struct objc_module {
 189   unsigned long version;                        /* Compiler revision. */
 190   unsigned long size;                           /* sizeof(Module). */
 191   const char* name;                             /* Name of the file where the
 192                                                   module was generated.   The
 193                                                   name includes the path. */
 194
 195   Symtab_t    symtab;                           /* Pointer to the Symtab of
 196                                                   the module.  The Symtab
 197                                                   holds an array of
 198                                                   pointers to
 199                                                   the classes and categories
 200                                                   defined in the module. */
 201 } Module, *Module_t;
 202
 203
 204 /*
 205 ** The compiler generates one of these structures for a class that has
 206 ** instance variables defined in its specification.
 207 */
 208 typedef struct objc_ivar* Ivar_t;
 209 typedef struct objc_ivar_list {
 210   int   ivar_count;                             /* Number of structures (Ivar)
 211                                                   contained in the list.  One
 212                                                   structure per instance
 213                                                   variable defined in the
 214                                                   class. */
 215   struct objc_ivar {
 216     const char* ivar_name;                      /* Name of the instance
 217                                                   variable as entered in the
 218                                                   class definition. */
 219     const char* ivar_type;                      /* Description of the Ivar's
 220                                                   type.  Useful for
 221                                                   debuggers. */
 222     int        ivar_offset;                    /* Byte offset from the base
 223                                                   address of the instance
 224                                                   structure to the variable. */
 225
 226   } ivar_list[1];                               /* Variable length
 227                                                   structure. */
 228 } IvarList, *IvarList_t;
 229
 230
 231 /*
 232 ** The compiler generates one (or more) of these structures for a class that
 233 ** has methods defined in its specification.
 234 **
 235 ** The implementation of a class can be broken into separate pieces in a file
 236 ** and categories can break them across modules. To handle this problem is a
 237 ** singly linked list of methods.
 238 */
 239 typedef struct objc_method Method;
 240 typedef Method* Method_t;
 241 typedef struct objc_method_list {
 242   struct objc_method_list*  method_next;      /* This variable is used to link
 243                                                 a method list to another.  It
 244                                                 is a singly linked list. */
 245   int            method_count;               /* Number of methods defined in
 246                                                 this structure. */
 247   struct objc_method {
 248     SEL         method_name;                  /* This variable is the method's
 249                                                 name.  It is a char*.
 250                                                   The unique integer passed to
 251                                                 objc_msg_send is a char* too.
 252                                                 It is compared against
 253                                                 method_name using strcmp. */
 254     const char* method_types;                 /* Description of the method's
 255                                                 parameter list.  Useful for
 256                                                 debuggers. */
 257     IMP         method_imp;                   /* Address of the method in the
 258                                                 executable. */
 259   } method_list[1];                           /* Variable length
 260                                                 structure. */
 261 } MethodList, *MethodList_t;
 262
 263 struct objc_protocol_list {
 264   struct objc_protocol_list *next;
 265   size_t count;
 266   Protocol *list[1];
 267 };
 268
 269 /*
 270 ** This is used to assure consistent access to the info field of
 271 ** classes
 272 */
 273 #ifndef HOST_BITS_PER_LONG
 274 #define HOST_BITS_PER_LONG  (sizeof(long)*8)
 275 #endif
 276
 277 #define __CLS_INFO(cls) ((cls)->info)
 278 #define __CLS_ISINFO(cls, mask) ((__CLS_INFO(cls)&mask)==mask)
 279 #define __CLS_SETINFO(cls, mask) (__CLS_INFO(cls) |= mask)
 280
 281 /* The structure is of type MetaClass */
 282 #define _CLS_META 0x2L
 283 #define CLS_ISMETA(cls) ((cls)&&__CLS_ISINFO(cls, _CLS_META))
 284
 285
 286 /* The structure is of type Class */
 287 #define _CLS_CLASS 0x1L
 288 #define CLS_ISCLASS(cls) ((cls)&&__CLS_ISINFO(cls, _CLS_CLASS))
 289
 290 /*
 291 ** The class is initialized within the runtime.  This means that
 292 ** it has had correct super and sublinks assigned
 293 */
 294 #define _CLS_RESOLV 0x8L
 295 #define CLS_ISRESOLV(cls) __CLS_ISINFO(cls, _CLS_RESOLV)
 296 #define CLS_SETRESOLV(cls) __CLS_SETINFO(cls, _CLS_RESOLV)
 297
 298 /*
 299 ** The class has been send a +initialize message or a such is not
 300 ** defined for this class
 301 */
 302 #define _CLS_INITIALIZED 0x04L
 303 #define CLS_ISINITIALIZED(cls) __CLS_ISINFO(cls, _CLS_INITIALIZED)
 304 #define CLS_SETINITIALIZED(cls) __CLS_SETINFO(cls, _CLS_INITIALIZED)
 305
 306 /*
 307 ** The class number of this class.  This must be the same for both the
 308 ** class and its meta class object
 309 */
 310 #define CLS_GETNUMBER(cls) (__CLS_INFO(cls) >> (HOST_BITS_PER_LONG/2))
 311 #define CLS_SETNUMBER(cls, num) \
 312   ({ (cls)->info <<= (HOST_BITS_PER_LONG/2); \
 313      (cls)->info >>= (HOST_BITS_PER_LONG/2); \
 314      __CLS_SETINFO(cls, (((unsigned long)num) << (HOST_BITS_PER_LONG/2))); })
 315
 316 /*
 317 ** The compiler generates one of these structures for each category.  A class
 318 ** may have many categories and contain both instance and factory methods.
 319 */
 320 typedef struct objc_category {
 321   const char*   category_name;                /* Name of the category.  Name
 322                                                 contained in the () of the
 323                                                 category definition. */
 324   const char*   class_name;                   /* Name of the class to which
 325                                                 the category belongs. */
 326   MethodList_t  instance_methods;             /* Linked list of instance
 327                                                 methods defined in the
 328                                                 category. NULL indicates no
 329                                                 instance methods defined. */
 330   MethodList_t  class_methods;                /* Linked list of factory
 331                                                 methods defined in the
 332                                                 category.  NULL indicates no
 333                                                 class methods defined. */
 334   struct objc_protocol_list *protocols;       /* List of Protocols
 335                                                  conformed to */
 336 } Category, *Category_t;
 337
 338 /*
 339 ** Structure used when a message is send to a class's super class.  The
 340 ** compiler generates one of these structures and passes it to
 341 ** objc_msg_super.
 342 */
 343 typedef struct objc_super {
 344   id      self;                           /* Id of the object sending
 345                                                 the message. */
 346 #ifdef __cplusplus
 347   Class super_class;
 348 #else
 349   Class class;                              /* Object's super class. */
 350 #endif
 351 } Super, *Super_t;
 352
 353 IMP objc_msg_lookup_super(Super_t super, SEL sel);
 354
 355 retval_t objc_msg_sendv(id, SEL, arglist_t);
 356
 357
 358
 359 /*
 360 ** This is a hook which is called by objc_lookup_class and
 361 ** objc_get_class if the runtime is not able to find the class.
 362 ** This may e.g. try to load in the class using dynamic loading.
 363 ** The function is guaranteed to be passed a non-NULL name string.
 364 */
 365 objc_EXPORT Class (*_objc_lookup_class)(const char *name);
 366
 367 /*
 368 ** This is a hook which is called by __objc_exec_class every time a class
 369 ** or a category is loaded into the runtime.  This may e.g. help a
 370 ** dynamic loader determine the classes that have been loaded when
 371 ** an object file is dynamically linked in.
 372 */
 373 objc_EXPORT void (*_objc_load_callback)(Class class, Category* category);
 374
 375 /*
 376 ** Hook functions for allocating, copying and disposing of instances
 377 */
 378 objc_EXPORT id (*_objc_object_alloc)(Class class);
 379 objc_EXPORT id (*_objc_object_copy)(id object);
 380 objc_EXPORT id (*_objc_object_dispose)(id object);
 381
 382 /*
 383 ** Standard functions for memory allocation and disposal.
 384 ** Users should use these functions in their ObjC programs so
 385 ** that they work properly with garbage collectors as well as
 386 ** can take advantage of the exception/error handling available.
 387 */
 388 void *
 389 objc_malloc(size_t size);
 390
 391 void *
 392 objc_atomic_malloc(size_t size);
 393
 394 void *
 395 objc_valloc(size_t size);
 396
 397 void *
 398 objc_realloc(void *mem, size_t size);
 399
 400 void *
 401 objc_calloc(size_t nelem, size_t size);
 402
 403 void
 404 objc_free(void *mem);
 405
 406 /*
 407 ** Hook functions for memory allocation and disposal.
 408 ** This makes it easy to substitute garbage collection systems
 409 ** such as Boehm's GC by assigning these function pointers
 410 ** to the GC's allocation routines.  By default these point
 411 ** to the ANSI standard malloc, realloc, free, etc.
 412 **
 413 ** Users should call the normal objc routines above for
 414 ** memory allocation and disposal within their programs.
 415 */
 416 objc_EXPORT void *(*_objc_malloc)(size_t);
 417 objc_EXPORT void *(*_objc_atomic_malloc)(size_t);
 418 objc_EXPORT void *(*_objc_valloc)(size_t);
 419 objc_EXPORT void *(*_objc_realloc)(void *, size_t);
 420 objc_EXPORT void *(*_objc_calloc)(size_t, size_t);
 421 objc_EXPORT void (*_objc_free)(void *);
 422
 423 /*
 424 **  Hook for method forwarding. This makes it easy to substitute a
 425 **  library, such as ffcall, that implements closures, thereby avoiding
 426 **  gcc's __builtin_apply problems.
 427 */
 428 objc_EXPORT IMP (*__objc_msg_forward)(SEL);
 429
 430 Method_t class_get_class_method(MetaClass class, SEL aSel);
 431
 432 Method_t class_get_instance_method(Class class, SEL aSel);
 433
 434 Class class_pose_as(Class impostor, Class superclass);
 435
 436 Class objc_get_class(const char *name);
 437
 438 Class objc_lookup_class(const char *name);
 439
 440 Class objc_next_class(void **enum_state);
 441
 442 const char *sel_get_name(SEL selector);
 443
 444 const char *sel_get_type(SEL selector);
 445
 446 SEL sel_get_uid(const char *name);
 447
 448 SEL sel_get_any_uid(const char *name);
 449
 450 SEL sel_get_any_typed_uid(const char *name);
 451
 452 SEL sel_get_typed_uid(const char *name, const char*);
 453
 454 SEL sel_register_name(const char *name);
 455
 456 SEL sel_register_typed_name(const char *name, const char*type);
 457
 458
 459 BOOL sel_is_mapped (SEL aSel);
 460
 461 extern id class_create_instance(Class class);
 462
 463 static inline const char *
 464 class_get_class_name(Class class)
 465 {
 466   return CLS_ISCLASS(class)?class->name:((class==Nil)?"Nil":0);
 467 }
 468
 469 static inline long
 470 class_get_instance_size(Class class)
 471 {
 472   return CLS_ISCLASS(class)?class->instance_size:0;
 473 }
 474
 475 static inline MetaClass
 476 class_get_meta_class(Class class)
 477 {
 478   return CLS_ISCLASS(class)?class->class_pointer:Nil;
 479 }
 480
 481 static inline Class
 482 class_get_super_class(Class class)
 483 {
 484   return CLS_ISCLASS(class)?class->super_class:Nil;
 485 }
 486
 487 static inline int
 488 class_get_version(Class class)
 489 {
 490   return CLS_ISCLASS(class)?class->version:-1;
 491 }
 492
 493 static inline BOOL
 494 class_is_class(Class class)
 495 {
 496   return CLS_ISCLASS(class);
 497 }
 498
 499 static inline BOOL
 500 class_is_meta_class(Class class)
 501 {
 502   return CLS_ISMETA(class);
 503 }
 504
 505
 506 static inline void
 507 class_set_version(Class class, long version)
 508 {
 509   if (CLS_ISCLASS(class))
 510     class->version = version;
 511 }
 512
 513 static inline void *
 514 class_get_gc_object_type (Class class)
 515 {
 516   return CLS_ISCLASS(class) ? class->gc_object_type : NULL;
 517 }
 518
 519 /* Mark the instance variable as innaccessible to the garbage collector */
 520 extern void class_ivar_set_gcinvisible (Class class,
 521                                         const char* ivarname,
 522                                         BOOL gcInvisible);
 523
 524 static inline IMP
 525 method_get_imp(Method_t method)
 526 {
 527   return (method!=METHOD_NULL)?method->method_imp:(IMP)0;
 528 }
 529
 530 IMP get_imp (Class class, SEL sel);
 531
 532 /* Redefine on NeXTSTEP so as not to conflict with system function */
 533 #ifdef __NeXT__
 534 #define object_copy     gnu_object_copy
 535 #define object_dispose  gnu_object_dispose
 536 #endif
 537
 538 id object_copy(id object);
 539
 540 id object_dispose(id object);
 541
 542 static inline Class
 543 object_get_class(id object)
 544 {
 545   return ((object!=nil)
 546           ? (CLS_ISCLASS(object->class_pointer)
 547              ? object->class_pointer
 548              : (CLS_ISMETA(object->class_pointer)
 549                 ? (Class)object
 550                 : Nil))
 551           : Nil);
 552 }
 553
 554 static inline const char *
 555 object_get_class_name(id object)
 556 {
 557   return ((object!=nil)?(CLS_ISCLASS(object->class_pointer)
 558                          ?object->class_pointer->name
 559                          :((Class)object)->name)
 560                        :"Nil");
 561 }
 562
 563 static inline MetaClass
 564 object_get_meta_class(id object)
 565 {
 566   return ((object!=nil)?(CLS_ISCLASS(object->class_pointer)
 567                          ?object->class_pointer->class_pointer
 568                          :(CLS_ISMETA(object->class_pointer)
 569                            ?object->class_pointer
 570                            :Nil))
 571                        :Nil);
 572 }
 573
 574 static inline Class
 575 object_get_super_class
 576 (id object)
 577 {
 578   return ((object!=nil)?(CLS_ISCLASS(object->class_pointer)
 579                          ?object->class_pointer->super_class
 580                          :(CLS_ISMETA(object->class_pointer)
 581                            ?((Class)object)->super_class
 582                            :Nil))
 583                        :Nil);
 584 }
 585
 586 static inline BOOL
 587 object_is_class (id object)
 588 {
 589   return ((object != nil)  &&  CLS_ISMETA (object->class_pointer));
 590 }
 591
 592 static inline BOOL
 593 object_is_instance (id object)
 594 {
 595   return ((object != nil)  &&  CLS_ISCLASS (object->class_pointer));
 596 }
 597
 598 static inline BOOL
 599 object_is_meta_class (id object)
 600 {
 601   return ((object != nil)
 602           &&  !object_is_instance (object)
 603           &&  !object_is_class (object));
 604 }
 605
 606 struct sarray*
 607 objc_get_uninstalled_dtable(void);
 608
 609 #endif /* not __objc_api_INCLUDE_GNU */
 610
 611
 612