]> git.saurik.com Git - apple/libdispatch.git/blob - os/object_private.h
libdispatch-228.23.tar.gz
[apple/libdispatch.git] / os / object_private.h
1 /*
2 * Copyright (c) 2011-2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_APACHE_LICENSE_HEADER_START@
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * @APPLE_APACHE_LICENSE_HEADER_END@
19 */
20
21 /*
22 * IMPORTANT: This header file describes INTERNAL interfaces to libdispatch
23 * which are subject to change in future releases of Mac OS X. Any applications
24 * relying on these interfaces WILL break.
25 */
26
27 #ifndef __OS_OBJECT_PRIVATE__
28 #define __OS_OBJECT_PRIVATE__
29
30 #include <sys/cdefs.h>
31 #include <stddef.h>
32 #include <os/object.h>
33
34 #ifndef __OSX_AVAILABLE_STARTING
35 #define __OSX_AVAILABLE_STARTING(x, y)
36 #endif
37
38 #if __GNUC__
39 #define OS_OBJECT_NOTHROW __attribute__((__nothrow__))
40 #define OS_OBJECT_NONNULL __attribute__((__nonnull__))
41 #define OS_OBJECT_WARN_RESULT __attribute__((__warn_unused_result__))
42 #define OS_OBJECT_MALLOC __attribute__((__malloc__))
43 #define OS_OBJECT_EXPORT extern __attribute__((visibility("default")))
44 #else
45 /*! @parseOnly */
46 #define OS_OBJECT_NOTHROW
47 /*! @parseOnly */
48 #define OS_OBJECT_NONNULL
49 /*! @parseOnly */
50 #define OS_OBJECT_WARN_RESULT
51 /*! @parseOnly */
52 #define OS_OBJECT_MALLOC
53 #define OS_OBJECT_EXPORT extern
54 #endif
55
56 #if OS_OBJECT_USE_OBJC && defined(__has_feature) && __has_feature(objc_arc)
57 #define _OS_OBJECT_OBJC_ARC 1
58 #else
59 #define _OS_OBJECT_OBJC_ARC 0
60 #endif
61
62 #define _OS_OBJECT_GLOBAL_REFCNT INT_MAX
63
64 #define _OS_OBJECT_HEADER(isa, ref_cnt, xref_cnt) \
65 isa; /* must be pointer-sized */ \
66 int volatile ref_cnt; \
67 int volatile xref_cnt
68
69 #if OS_OBJECT_HAVE_OBJC_SUPPORT
70 // Must match size of compiler-generated OBJC_CLASS structure rdar://10640168
71 #define _OS_OBJECT_CLASS_HEADER() \
72 void *_os_obj_objc_class_t[5]
73 #else
74 #define _OS_OBJECT_CLASS_HEADER() \
75 void (*_os_obj_xref_dispose)(_os_object_t); \
76 void (*_os_obj_dispose)(_os_object_t)
77 #endif
78
79 #define OS_OBJECT_CLASS(name) OS_##name
80
81 #if OS_OBJECT_USE_OBJC
82 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
83 OS_OBJECT_EXPORT
84 @interface OS_OBJECT_CLASS(object) : NSObject
85 - (void)_xref_dispose;
86 - (void)_dispose;
87 @end
88 typedef OS_OBJECT_CLASS(object) *_os_object_t;
89 #define _OS_OBJECT_DECL_SUBCLASS_INTERFACE(name, super) \
90 @interface OS_OBJECT_CLASS(name) : OS_OBJECT_CLASS(super) \
91 <OS_OBJECT_CLASS(name)> \
92 @end
93 #else
94 typedef struct _os_object_s *_os_object_t;
95 #endif
96
97 __BEGIN_DECLS
98
99 #if !_OS_OBJECT_OBJC_ARC
100
101 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
102 OS_OBJECT_EXPORT OS_OBJECT_MALLOC OS_OBJECT_WARN_RESULT OS_OBJECT_NOTHROW
103 _os_object_t
104 _os_object_alloc(const void *cls, size_t size);
105
106 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
107 OS_OBJECT_EXPORT OS_OBJECT_NONNULL OS_OBJECT_NOTHROW
108 void _os_object_dealloc(_os_object_t object);
109
110 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
111 OS_OBJECT_EXPORT OS_OBJECT_NONNULL OS_OBJECT_NOTHROW
112 _os_object_t
113 _os_object_retain(_os_object_t object);
114
115 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
116 OS_OBJECT_EXPORT OS_OBJECT_NONNULL OS_OBJECT_NOTHROW
117 void
118 _os_object_release(_os_object_t object);
119
120 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
121 OS_OBJECT_EXPORT OS_OBJECT_NONNULL OS_OBJECT_NOTHROW
122 _os_object_t
123 _os_object_retain_internal(_os_object_t object);
124
125 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0)
126 OS_OBJECT_EXPORT OS_OBJECT_NONNULL OS_OBJECT_NOTHROW
127 void
128 _os_object_release_internal(_os_object_t object);
129
130 #endif // !_OS_OBJECT_OBJC_ARC
131
132 __END_DECLS
133
134 #endif