OSDN Git Service

In libobjc/:
[pf3gnuchains/gcc-fork.git] / libobjc / objc / objc-api.h
1 /* GNU Objective-C Runtime API - Traditional API
2    Copyright (C) 1993, 1995, 1996, 1997, 2001, 2002, 2003, 2004, 2005,
3    2007, 2009, 2010 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 it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option) any
10 later version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
15 License for more details.
16
17 Under Section 7 of GPL version 3, you are granted additional
18 permissions described in the GCC Runtime Library Exception, version
19 3.1, as published by the Free Software Foundation.
20
21 You should have received a copy of the GNU General Public License and
22 a copy of the GCC Runtime Library Exception along with this program;
23 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
24 <http://www.gnu.org/licenses/>.  */
25
26 #ifndef __objc_api_INCLUDE_GNU
27 #define __objc_api_INCLUDE_GNU
28
29 /* This file declares the "traditional" GNU Objective-C Runtime API.
30    It is the API supported by older versions of the GNU Objective-C
31    Runtime.  Include this file to use it.
32
33    This API is being replaced by the "modern" GNU Objective-C Runtime
34    API, which is declared in objc/runtime.h.  The "modern" API is very
35    similar to the API used by the modern Apple/NeXT runtime.
36
37    The last version of GCC supporting the traditional API is GCC 4.6.
38    This file will not exist in later versions of GCC.
39
40    Because the two APIs have some conflicting definitions (in
41    particular, Method and Category are defined differently) you should
42    include either objc/objc-api.h (to use the traditional GNU
43    Objective-C Runtime API) or objc/runtime.h (to use the modern GNU
44    Objective-C Runtime API), but not both.  */
45 #ifdef __objc_runtime_INCLUDE_GNU
46 # error You can not include both objc/objc-api.h and objc/runtime.h.  Include objc/objc-api.h for the traditional GNU Objective-C Runtime API and objc/runtime.h for the modern one.
47 #endif
48
49 /* TODO: A deprecation warning any time the file is included ? */
50
51 #include "objc.h"
52 #ifndef GNU_LIBOBJC_COMPILING_LIBOBJC_ITSELF
53 # include "deprecated/hash.h"
54 #endif
55 #include "thr.h"
56 #include "objc-decls.h"
57 #include <stdio.h>
58 #include <stdarg.h>
59
60 #ifdef __cplusplus
61 extern "C" {
62 #endif /* __cplusplus */
63
64 #include "deprecated/METHOD_NULL.h"
65
66 /* Method descriptor returned by introspective Object methods.
67    This is really just the first part of the more complete objc_method
68    structure defined below and used internally by the runtime.  */
69 struct objc_method_description
70 {
71     SEL name;                   /* this is a selector, not a string */
72     char *types;                /* type encoding */
73 };
74
75 /* The following are used in encode strings to describe the type of
76    Ivars and Methods.  */
77 #define _C_ID       '@'
78 #define _C_CLASS    '#'
79 #define _C_SEL      ':'
80 #define _C_CHR      'c'
81 #define _C_UCHR     'C'
82 #define _C_SHT      's'
83 #define _C_USHT     'S'
84 #define _C_INT      'i'
85 #define _C_UINT     'I'
86 #define _C_LNG      'l'
87 #define _C_ULNG     'L'
88 #define _C_LNG_LNG  'q'
89 #define _C_ULNG_LNG 'Q'
90 #define _C_FLT      'f'
91 #define _C_DBL      'd'
92 #define _C_LNG_DBL  'D'
93 #define _C_BFLD     'b'
94 #define _C_BOOL     'B'
95 #define _C_VOID     'v'
96 #define _C_UNDEF    '?'
97 #define _C_PTR      '^'
98 #define _C_CHARPTR  '*'
99 #define _C_ARY_B    '['
100 #define _C_ARY_E    ']'
101 #define _C_UNION_B  '('
102 #define _C_UNION_E  ')'
103 #define _C_STRUCT_B '{'
104 #define _C_STRUCT_E '}'
105 #define _C_VECTOR   '!'
106 #define _C_COMPLEX  'j'
107
108 /* _C_ATOM is never generated by the compiler.  You can treat it as
109    equivalent to "*".  */
110 #define _C_ATOM     '%'
111
112 #include "deprecated/struct_objc_static_instances.h"
113 #include "deprecated/struct_objc_symtab.h"
114 #include "deprecated/struct_objc_module.h"
115 #include "deprecated/struct_objc_ivar.h"
116 #include "deprecated/struct_objc_ivar_list.h"
117 #include "deprecated/struct_objc_method.h"
118 typedef struct objc_method Method, *Method_t;
119
120 #include "deprecated/struct_objc_method_list.h"
121 #include "deprecated/struct_objc_protocol_list.h"
122
123 /*
124 ** This is used to assure consistent access to the info field of 
125 ** classes
126 */
127 #ifndef HOST_BITS_PER_LONG
128 #define HOST_BITS_PER_LONG  (sizeof(long)*8)
129 #endif 
130
131 #define __CLS_INFO(cls) ((cls)->info)
132 #define __CLS_ISINFO(cls, mask) ((__CLS_INFO(cls)&mask)==mask)
133 #define __CLS_SETINFO(cls, mask) (__CLS_INFO(cls) |= mask)
134
135 /* The structure is of type MetaClass */
136 #define _CLS_META 0x2L
137 #define CLS_ISMETA(cls) ((cls)&&__CLS_ISINFO(cls, _CLS_META))
138
139
140 /* The structure is of type Class */
141 #define _CLS_CLASS 0x1L
142 #define CLS_ISCLASS(cls) ((cls)&&__CLS_ISINFO(cls, _CLS_CLASS))
143
144 /*
145 ** The class is initialized within the runtime.  This means that 
146 ** it has had correct super and sublinks assigned
147 */
148 #define _CLS_RESOLV 0x8L
149 #define CLS_ISRESOLV(cls) __CLS_ISINFO(cls, _CLS_RESOLV)
150 #define CLS_SETRESOLV(cls) __CLS_SETINFO(cls, _CLS_RESOLV)
151
152 /*
153 ** The class has been send a +initialize message or a such is not 
154 ** defined for this class
155 */
156 #define _CLS_INITIALIZED 0x04L
157 #define CLS_ISINITIALIZED(cls) __CLS_ISINFO(cls, _CLS_INITIALIZED)
158 #define CLS_SETINITIALIZED(cls) __CLS_SETINFO(cls, _CLS_INITIALIZED)
159
160 /*
161 ** The class number of this class.  This must be the same for both the 
162 ** class and its meta class object
163 */
164 #define CLS_GETNUMBER(cls) (__CLS_INFO(cls) >> (HOST_BITS_PER_LONG/2))
165 #define CLS_SETNUMBER(cls, num) \
166   ({ (cls)->info <<= (HOST_BITS_PER_LONG/2); \
167      (cls)->info >>= (HOST_BITS_PER_LONG/2); \
168      __CLS_SETINFO(cls, (((unsigned long)num) << (HOST_BITS_PER_LONG/2))); })
169
170 #include "deprecated/struct_objc_category.h"
171
172 typedef struct objc_category Category, *Category_t;
173
174 /* We include message.h for compatibility with the old objc-api.h
175    which included the declarations currently in message.h.  The
176    Apple/NeXT runtime does not do this and only includes message.h in
177    objc-runtime.h.  It does not matter that much since most of the
178    definitions in message.h are runtime-specific.  */
179 #include "message.h"
180
181 /*
182 ** This is a hook which is called by objc_lookup_class and
183 ** objc_get_class if the runtime is not able to find the class.
184 ** This may e.g. try to load in the class using dynamic loading.
185 ** The function is guaranteed to be passed a non-NULL name string.
186 ** In the Modern API, this is replaced by
187 ** objc_setGetUnknownClassHandler ().
188 */
189 objc_EXPORT Class (*_objc_lookup_class)(const char *name);
190
191 /*
192 ** This is a hook which is called by __objc_exec_class every time a class
193 ** or a category is loaded into the runtime.  This may e.g. help a
194 ** dynamic loader determine the classes that have been loaded when
195 ** an object file is dynamically linked in.
196 */
197 objc_EXPORT void (*_objc_load_callback)(Class _class, Category* category);
198
199 #include "deprecated/objc_object_alloc.h"
200
201 /*
202   Standard functions for memory allocation and disposal.  Users should
203   use these functions in their ObjC programs so that they work so that
204   they work properly with garbage collectors.
205 */
206 objc_EXPORT void *
207 objc_malloc(size_t size);
208
209 /* FIXME: Shouldn't the following be called objc_malloc_atomic ?  The
210    GC function is GC_malloc_atomic() which makes sense.
211  */
212 objc_EXPORT void *
213 objc_atomic_malloc(size_t size);
214
215 objc_EXPORT void *
216 objc_realloc(void *mem, size_t size);
217
218 objc_EXPORT void *
219 objc_calloc(size_t nelem, size_t size);
220
221 objc_EXPORT void
222 objc_free(void *mem);
223
224 #include "deprecated/objc_valloc.h"
225 #include "deprecated/objc_malloc.h"
226
227 #include "deprecated/objc_unexpected_exception.h"
228
229 objc_EXPORT Method_t class_get_class_method(MetaClass _class, SEL aSel);
230
231 objc_EXPORT Method_t class_get_instance_method(Class _class, SEL aSel);
232
233 objc_EXPORT Class class_pose_as(Class impostor, Class superclass);
234
235 objc_EXPORT Class objc_get_class(const char *name);
236
237 objc_EXPORT Class objc_lookup_class(const char *name);
238
239 objc_EXPORT Class objc_next_class(void **enum_state);
240
241 objc_EXPORT const char *sel_get_name(SEL selector);
242
243 objc_EXPORT const char *sel_get_type(SEL selector);
244
245 objc_EXPORT SEL sel_get_uid(const char *name);
246
247 objc_EXPORT SEL sel_get_any_uid(const char *name);
248
249 objc_EXPORT SEL sel_get_any_typed_uid(const char *name);
250
251 objc_EXPORT SEL sel_get_typed_uid(const char *name, const char*);
252
253 objc_EXPORT SEL sel_register_name(const char *name);
254
255 objc_EXPORT SEL sel_register_typed_name(const char *name, const char*type);
256
257
258 objc_EXPORT BOOL sel_is_mapped (SEL aSel);
259
260 extern id class_create_instance(Class _class);
261
262 static inline const char *
263 class_get_class_name(Class _class)
264 {
265   return CLS_ISCLASS(_class)?_class->name:((_class==Nil)?"Nil":0);
266 }
267
268 static inline long
269 class_get_instance_size(Class _class)
270 {
271   return CLS_ISCLASS(_class)?_class->instance_size:0;
272 }
273
274 static inline MetaClass
275 class_get_meta_class(Class _class)
276 {
277   return CLS_ISCLASS(_class)?_class->class_pointer:Nil;
278 }
279
280 static inline Class
281 class_get_super_class(Class _class)
282 {
283   return CLS_ISCLASS(_class)?_class->super_class:Nil;
284 }
285
286 static inline int
287 class_get_version(Class _class)
288 {
289   return CLS_ISCLASS(_class)?_class->version:-1;
290 }
291
292 static inline BOOL
293 class_is_class(Class _class)
294 {
295   return CLS_ISCLASS(_class);
296 }
297
298 static inline BOOL
299 class_is_meta_class(Class _class)
300 {
301   return CLS_ISMETA(_class);
302 }
303
304
305 static inline void
306 class_set_version(Class _class, long version)
307 {
308   if (CLS_ISCLASS(_class))
309     _class->version = version;
310 }
311
312 static inline void *
313 class_get_gc_object_type (Class _class)
314 {
315   return CLS_ISCLASS(_class) ? _class->gc_object_type : NULL;
316 }
317
318 /* Mark the instance variable as innaccessible to the garbage collector */
319 extern void class_ivar_set_gcinvisible (Class _class,
320                                         const char* ivarname,
321                                         BOOL gcInvisible);
322
323 objc_EXPORT IMP method_get_imp(Method_t method);
324
325 objc_EXPORT IMP get_imp (Class _class, SEL sel);
326
327 /* object_copy used to take a single argument in the traditional GNU
328    Objective-C Runtime API (the one declared here), but takes 2 in the
329    modern API (implemented in the actual runtime).  Define the old
330    object_copy in terms of the new one.  */
331 objc_EXPORT id object_copy (id object, size_t size);
332 #define object_copy(X) (object_copy ((X), 0))
333
334 objc_EXPORT id object_dispose(id object);
335
336 static inline Class
337 object_get_class(id object)
338 {
339   return ((object!=nil)
340           ? (CLS_ISCLASS(object->class_pointer)
341              ? object->class_pointer
342              : (CLS_ISMETA(object->class_pointer)
343                 ? (Class)object
344                 : Nil))
345           : Nil);
346 }
347
348 static inline const char *
349 object_get_class_name(id object)
350 {
351   return ((object!=nil)?(CLS_ISCLASS(object->class_pointer)
352                          ?object->class_pointer->name
353                          :((Class)object)->name)
354                        :"Nil");
355 }
356
357 static inline MetaClass
358 object_get_meta_class(id object)
359 {
360   return ((object!=nil)?(CLS_ISCLASS(object->class_pointer)
361                          ?object->class_pointer->class_pointer
362                          :(CLS_ISMETA(object->class_pointer)
363                            ?object->class_pointer
364                            :Nil))
365                        :Nil);
366 }
367
368 static inline Class
369 object_get_super_class
370 (id object)
371 {
372   return ((object!=nil)?(CLS_ISCLASS(object->class_pointer)
373                          ?object->class_pointer->super_class
374                          :(CLS_ISMETA(object->class_pointer)
375                            ?((Class)object)->super_class
376                            :Nil))
377                        :Nil);
378 }
379
380 static inline BOOL
381 object_is_class (id object)
382 {
383   return ((object != nil)  &&  CLS_ISMETA (object->class_pointer));
384 }
385  
386 static inline BOOL
387 object_is_instance (id object)
388 {
389   return ((object != nil)  &&  CLS_ISCLASS (object->class_pointer));
390 }
391
392 static inline BOOL
393 object_is_meta_class (id object)
394 {
395   return ((object != nil)
396           &&  !object_is_instance (object)  
397           &&  !object_is_class (object));
398 }
399
400 #include "deprecated/objc_get_uninstalled_dtable.h"
401
402 #ifdef __cplusplus
403 }
404 #endif /* __cplusplus */
405
406 #endif /* not __objc_api_INCLUDE_GNU */
407
408
409