gcc-objc-3.4.5-20060117-3.tar.gz

/* GNU Objective-C Runtime API. Copyright (C) 1993, 1995, 1996, 1997, 2002 Free Software Foundation, Inc. This file is part of GCC. GCC is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GCC is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GCC; see the file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* As a special exception, if you link this library with files compiled with GCC to produce an executable, this does not cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU General Public License. */ #ifndef __objc_api_INCLUDE_GNU #define __objc_api_INCLUDE_GNU #include "objc/objc.h" #include "objc/hash.h" #include "objc/thr.h" #include <stdio.h> #include <stdarg.h> /* For functions which return Method_t */ #define METHOD_NULL (Method_t)0 /* Boolean typedefs */ /* ** Method descriptor returned by introspective Object methods. ** This is really just the first part of the more complete objc_method ** structure defined below and used internally by the runtime. */ struct objc_method_description { SEL name; /* this is a selector, not a string */ char *types; /* type encoding */ }; /* Filer types used to describe Ivars and Methods. */ #define _C_ID '@' #define _C_CLASS '#' #define _C_SEL ':' #define _C_CHR 'c' #define _C_UCHR 'C' #define _C_SHT 's' #define _C_USHT 'S' #define _C_INT 'i' #define _C_UINT 'I' #define _C_LNG 'l' #define _C_ULNG 'L' #define _C_LNG_LNG 'q' #define _C_ULNG_LNG 'Q' #define _C_FLT 'f' #define _C_DBL 'd' #define _C_BFLD 'b' #define _C_VOID 'v' #define _C_UNDEF '?' #define _C_PTR '^' #define _C_CHARPTR '*' #define _C_ATOM '%' #define _C_ARY_B '[' #define _C_ARY_E ']' #define _C_UNION_B '(' #define _C_UNION_E ')' #define _C_STRUCT_B '{' #define _C_STRUCT_E '}' #define _C_VECTOR '!' /* ** Error handling ** ** Call objc_error() or objc_verror() to record an error; this error ** routine will generally exit the program but not necessarily if the ** user has installed his own error handler. ** ** Call objc_set_error_handler to assign your own function for ** handling errors. The function should return YES if it is ok ** to continue execution, or return NO or just abort if the ** program should be stopped. The default error handler is just to ** print a message on stderr. ** ** The error handler function should be of type objc_error_handler ** The first parameter is an object instance of relevance. ** The second parameter is an error code. ** The third parameter is a format string in the printf style. ** The fourth parameter is a variable list of arguments. */ extern void objc_error(id object, int code, const char* fmt, ...); extern void objc_verror(id object, int code, const char* fmt, va_list ap); typedef BOOL (*objc_error_handler)(id, int code, const char *fmt, va_list ap); objc_error_handler objc_set_error_handler(objc_error_handler func); /* ** Error codes ** These are used by the runtime library, and your ** error handling may use them to determine if the error is ** hard or soft thus whether execution can continue or abort. */ #define OBJC_ERR_UNKNOWN 0 /* Generic error */ #define OBJC_ERR_OBJC_VERSION 1 /* Incorrect runtime version */ #define OBJC_ERR_GCC_VERSION 2 /* Incorrect compiler version */ #define OBJC_ERR_MODULE_SIZE 3 /* Bad module size */ #define OBJC_ERR_PROTOCOL_VERSION 4 /* Incorrect protocol version */ #define OBJC_ERR_MEMORY 10 /* Out of memory */ #define OBJC_ERR_RECURSE_ROOT 20 /* Attempt to archive the root object more than once. */ #define OBJC_ERR_BAD_DATA 21 /* Didn't read expected data */ #define OBJC_ERR_BAD_KEY 22 /* Bad key for object */ #define OBJC_ERR_BAD_CLASS 23 /* Unknown class */ #define OBJC_ERR_BAD_TYPE 24 /* Bad type specification */ #define OBJC_ERR_NO_READ 25 /* Cannot read stream */ #define OBJC_ERR_NO_WRITE 26 /* Cannot write stream */ #define OBJC_ERR_STREAM_VERSION 27 /* Incorrect stream version */ #define OBJC_ERR_BAD_OPCODE 28 /* Bad opcode */ #define OBJC_ERR_UNIMPLEMENTED 30 /* Method is not implemented */ #define OBJC_ERR_BAD_STATE 40 /* Bad thread state */ /* ** Set this variable nonzero to print a line describing each ** message that is sent. (this is currently disabled) */ extern BOOL objc_trace; /* For every class which happens to have statically allocated instances in this module, one OBJC_STATIC_INSTANCES is allocated by the compiler. INSTANCES is NULL terminated and points to all statically allocated instances of this class. */ struct objc_static_instances { char *class_name; id instances[0]; }; /* ** Whereas a Module (defined further down) is the root (typically) of a file, ** a Symtab is the root of the class and category definitions within the ** module. ** ** A Symtab contains a variable length array of pointers to classes and ** categories defined in the module. */ typedef struct objc_symtab { unsigned long sel_ref_cnt; /* Unknown. */ SEL refs; /* Unknown. */ unsigned short cls_def_cnt; /* Number of classes compiled (defined) in the module. */ unsigned short cat_def_cnt; /* Number of categories compiled (defined) in the module. */ void *defs[1]; /* Variable array of pointers. cls_def_cnt of type Class followed by cat_def_cnt of type Category_t, followed by a NULL terminated array of objc_static_instances. */ } Symtab, *Symtab_t; /* ** The compiler generates one of these structures for each module that ** composes the executable (eg main.m). ** ** This data structure is the root of the definition tree for the module. ** ** A collect program runs between ld stages and creates a ObjC ctor array. ** That array holds a pointer to each module structure of the executable. */ typedef struct objc_module { unsigned long version; /* Compiler revision. */ unsigned long size; /* sizeof(Module). */ const char* name; /* Name of the file where the module was generated. The name includes the path. */ Symtab_t symtab; /* Pointer to the Symtab of the module. The Symtab holds an array of pointers to the classes and categories defined in the module. */ } Module, *Module_t; /* ** The compiler generates one of these structures for a class that has ** instance variables defined in its specification. */ typedef struct objc_ivar* Ivar_t; typedef struct ob