proton  0
object.h
Go to the documentation of this file.
1 #ifndef PROTON_OBJECT_H
2 #define PROTON_OBJECT_H 1
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include <proton/cid.h>
26 #include <proton/types.h>
27 #include <stdarg.h>
28 #include <proton/type_compat.h>
29 #include <stddef.h>
30 #include <proton/import_export.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 typedef uintptr_t pn_handle_t;
37 typedef intptr_t pn_shandle_t;
38 
39 typedef struct pn_class_t pn_class_t;
40 typedef struct pn_string_t pn_string_t;
41 typedef struct pn_list_t pn_list_t;
42 typedef struct pn_map_t pn_map_t;
43 typedef struct pn_hash_t pn_hash_t;
44 typedef void *(*pn_iterator_next_t)(void *state);
46 typedef struct pn_record_t pn_record_t;
47 
48 struct pn_class_t {
49  const char *name;
50  const pn_cid_t cid;
51  void *(*newinst)(const pn_class_t *, size_t);
52  void (*initialize)(void *);
53  void (*incref)(void *);
54  void (*decref)(void *);
55  int (*refcount)(void *);
56  void (*finalize)(void *);
57  void (*free)(void *);
58  const pn_class_t *(*reify)(void *);
59  uintptr_t (*hashcode)(void *);
60  intptr_t (*compare)(void *, void *);
61  int (*inspect)(void *, pn_string_t *);
62 };
63 
64 // Hack alert: Declare these as arrays so we can treat the name
65 // of the single object as the address
66 PN_EXTERN extern const pn_class_t PN_OBJECT[];
67 PN_EXTERN extern const pn_class_t PN_VOID[];
68 PN_EXTERN extern const pn_class_t PN_WEAKREF[];
69 
70 #define PN_CLASSDEF(PREFIX) \
71 static void PREFIX ## _initialize_cast(void *object) { \
72  PREFIX ## _initialize((PREFIX ## _t *) object); \
73 } \
74  \
75 static void PREFIX ## _finalize_cast(void *object) { \
76  PREFIX ## _finalize((PREFIX ## _t *) object); \
77 } \
78  \
79 static uintptr_t PREFIX ## _hashcode_cast(void *object) { \
80  uintptr_t (*fp)(PREFIX ## _t *) = PREFIX ## _hashcode; \
81  if (fp) { \
82  return fp((PREFIX ## _t *) object); \
83  } else { \
84  return (uintptr_t) object; \
85  } \
86 } \
87  \
88 static intptr_t PREFIX ## _compare_cast(void *a, void *b) { \
89  intptr_t (*fp)(PREFIX ## _t *, PREFIX ## _t *) = PREFIX ## _compare; \
90  if (fp) { \
91  return fp((PREFIX ## _t *) a, (PREFIX ## _t *) b); \
92  } else { \
93  return (intptr_t) a - (intptr_t) b; \
94  } \
95 } \
96  \
97 static int PREFIX ## _inspect_cast(void *object, pn_string_t *str) { \
98  int (*fp)(PREFIX ## _t *, pn_string_t *) = PREFIX ## _inspect; \
99  if (fp) { \
100  return fp((PREFIX ## _t *) object, str); \
101  } else { \
102  return pn_string_addf(str, "%s<%p>", #PREFIX, object); \
103  } \
104 } \
105  \
106 const pn_class_t *PREFIX ## __class(void) { \
107  static const pn_class_t clazz = { \
108  #PREFIX, \
109  CID_ ## PREFIX, \
110  pn_object_new, \
111  PREFIX ## _initialize_cast, \
112  pn_object_incref, \
113  pn_object_decref, \
114  pn_object_refcount, \
115  PREFIX ## _finalize_cast, \
116  pn_object_free, \
117  pn_object_reify, \
118  PREFIX ## _hashcode_cast, \
119  PREFIX ## _compare_cast, \
120  PREFIX ## _inspect_cast \
121  }; \
122  return &clazz; \
123 } \
124  \
125 PREFIX ## _t *PREFIX ## _new(void) { \
126  return (PREFIX ## _t *) pn_class_new(PREFIX ## __class(), \
127  sizeof(PREFIX ## _t)); \
128 }
129 
130 #define PN_CLASS(PREFIX) { \
131  #PREFIX, \
132  CID_ ## PREFIX, \
133  pn_object_new, \
134  PREFIX ## _initialize, \
135  pn_object_incref, \
136  pn_object_decref, \
137  pn_object_refcount, \
138  PREFIX ## _finalize, \
139  pn_object_free, \
140  pn_object_reify, \
141  PREFIX ## _hashcode, \
142  PREFIX ## _compare, \
143  PREFIX ## _inspect \
144 }
145 
146 #define PN_METACLASS(PREFIX) { \
147  #PREFIX, \
148  CID_ ## PREFIX, \
149  PREFIX ## _new, \
150  PREFIX ## _initialize, \
151  PREFIX ## _incref, \
152  PREFIX ## _decref, \
153  PREFIX ## _refcount, \
154  PREFIX ## _finalize, \
155  PREFIX ## _free, \
156  PREFIX ## _reify, \
157  PREFIX ## _hashcode, \
158  PREFIX ## _compare, \
159  PREFIX ## _inspect \
160 }
161 
163 PN_EXTERN const char *pn_class_name(const pn_class_t *clazz);
164 PN_EXTERN void *pn_class_new(const pn_class_t *clazz, size_t size);
165 PN_EXTERN void *pn_class_incref(const pn_class_t *clazz, void *object);
166 PN_EXTERN int pn_class_refcount(const pn_class_t *clazz, void *object);
167 PN_EXTERN int pn_class_decref(const pn_class_t *clazz, void *object);
168 PN_EXTERN void pn_class_free(const pn_class_t *clazz, void *object);
169 PN_EXTERN const pn_class_t *pn_class_reify(const pn_class_t *clazz, void *object);
170 PN_EXTERN uintptr_t pn_class_hashcode(const pn_class_t *clazz, void *object);
171 PN_EXTERN intptr_t pn_class_compare(const pn_class_t *clazz, void *a, void *b);
172 PN_EXTERN bool pn_class_equals(const pn_class_t *clazz, void *a, void *b);
173 PN_EXTERN int pn_class_inspect(const pn_class_t *clazz, void *object, pn_string_t *dst);
174 
175 PN_EXTERN uintptr_t pn_void_hashcode(void *object);
176 PN_EXTERN intptr_t pn_void_compare(void *a, void *b);
177 PN_EXTERN int pn_void_inspect(void *object, pn_string_t *dst);
178 
179 PN_EXTERN void *pn_object_new(const pn_class_t *clazz, size_t size);
180 PN_EXTERN const pn_class_t *pn_object_reify(void *object);
181 PN_EXTERN void pn_object_incref(void *object);
182 PN_EXTERN int pn_object_refcount(void *object);
183 PN_EXTERN void pn_object_decref(void *object);
184 PN_EXTERN void pn_object_free(void *object);
185 
186 PN_EXTERN void *pn_incref(void *object);
187 PN_EXTERN int pn_decref(void *object);
188 PN_EXTERN int pn_refcount(void *object);
189 PN_EXTERN void pn_free(void *object);
190 PN_EXTERN const pn_class_t *pn_class(void* object);
191 PN_EXTERN uintptr_t pn_hashcode(void *object);
192 PN_EXTERN intptr_t pn_compare(void *a, void *b);
193 PN_EXTERN bool pn_equals(void *a, void *b);
194 PN_EXTERN int pn_inspect(void *object, pn_string_t *dst);
195 
196 #define PN_REFCOUNT (0x1)
197 
198 PN_EXTERN pn_list_t *pn_list(const pn_class_t *clazz, size_t capacity);
199 PN_EXTERN size_t pn_list_size(pn_list_t *list);
200 PN_EXTERN void *pn_list_get(pn_list_t *list, int index);
201 PN_EXTERN void pn_list_set(pn_list_t *list, int index, void *value);
202 PN_EXTERN int pn_list_add(pn_list_t *list, void *value);
203 PN_EXTERN void *pn_list_pop(pn_list_t *list);
204 PN_EXTERN ssize_t pn_list_index(pn_list_t *list, void *value);
205 PN_EXTERN bool pn_list_remove(pn_list_t *list, void *value);
206 PN_EXTERN void pn_list_del(pn_list_t *list, int index, int n);
207 PN_EXTERN void pn_list_clear(pn_list_t *list);
209 PN_EXTERN void pn_list_minpush(pn_list_t *list, void *value);
210 PN_EXTERN void *pn_list_minpop(pn_list_t *list);
211 
212 #define PN_REFCOUNT_KEY (0x2)
213 #define PN_REFCOUNT_VALUE (0x4)
214 
215 PN_EXTERN pn_map_t *pn_map(const pn_class_t *key, const pn_class_t *value,
216  size_t capacity, float load_factor);
217 PN_EXTERN size_t pn_map_size(pn_map_t *map);
218 PN_EXTERN int pn_map_put(pn_map_t *map, void *key, void *value);
219 PN_EXTERN void *pn_map_get(pn_map_t *map, void *key);
220 PN_EXTERN void pn_map_del(pn_map_t *map, void *key);
221 PN_EXTERN pn_handle_t pn_map_head(pn_map_t *map);
222 PN_EXTERN pn_handle_t pn_map_next(pn_map_t *map, pn_handle_t entry);
223 PN_EXTERN void *pn_map_key(pn_map_t *map, pn_handle_t entry);
224 PN_EXTERN void *pn_map_value(pn_map_t *map, pn_handle_t entry);
225 
226 PN_EXTERN pn_hash_t *pn_hash(const pn_class_t *clazz, size_t capacity, float load_factor);
227 PN_EXTERN size_t pn_hash_size(pn_hash_t *hash);
228 PN_EXTERN int pn_hash_put(pn_hash_t *hash, uintptr_t key, void *value);
229 PN_EXTERN void *pn_hash_get(pn_hash_t *hash, uintptr_t key);
230 PN_EXTERN void pn_hash_del(pn_hash_t *hash, uintptr_t key);
231 PN_EXTERN pn_handle_t pn_hash_head(pn_hash_t *hash);
232 PN_EXTERN pn_handle_t pn_hash_next(pn_hash_t *hash, pn_handle_t entry);
233 PN_EXTERN uintptr_t pn_hash_key(pn_hash_t *hash, pn_handle_t entry);
234 PN_EXTERN void *pn_hash_value(pn_hash_t *hash, pn_handle_t entry);
235 
236 PN_EXTERN pn_string_t *pn_string(const char *bytes);
237 PN_EXTERN pn_string_t *pn_stringn(const char *bytes, size_t n);
238 PN_EXTERN const char *pn_string_get(pn_string_t *string);
239 PN_EXTERN size_t pn_string_size(pn_string_t *string);
240 PN_EXTERN int pn_string_set(pn_string_t *string, const char *bytes);
241 PN_EXTERN int pn_string_setn(pn_string_t *string, const char *bytes, size_t n);
242 PN_EXTERN ssize_t pn_string_put(pn_string_t *string, char *dst);
244 PN_EXTERN int pn_string_format(pn_string_t *string, const char *format, ...)
245 #ifdef __GNUC__
246  __attribute__ ((format (printf, 2, 3)))
247 #endif
248  ;
249 PN_EXTERN int pn_string_vformat(pn_string_t *string, const char *format, va_list ap);
250 PN_EXTERN int pn_string_addf(pn_string_t *string, const char *format, ...)
251 #ifdef __GNUC__
252  __attribute__ ((format (printf, 2, 3)))
253 #endif
254  ;
255 PN_EXTERN int pn_string_vaddf(pn_string_t *string, const char *format, va_list ap);
256 PN_EXTERN int pn_string_grow(pn_string_t *string, size_t capacity);
257 PN_EXTERN char *pn_string_buffer(pn_string_t *string);
259 PN_EXTERN int pn_string_resize(pn_string_t *string, size_t size);
261 
264  pn_iterator_next_t next, size_t size);
265 PN_EXTERN void *pn_iterator_next(pn_iterator_t *iterator);
266 
267 #define PN_LEGCTX ((pn_handle_t) 0)
268 
269 #define PN_HANDLE(name) \
270  static const char _PN_HANDLE_ ## name = 0; \
271  static const pn_handle_t name = ((pn_handle_t) &_PN_HANDLE_ ## name);
272 
274 PN_EXTERN void pn_record_def(pn_record_t *record, pn_handle_t key, const pn_class_t *clazz);
275 PN_EXTERN bool pn_record_has(pn_record_t *record, pn_handle_t key);
276 PN_EXTERN void *pn_record_get(pn_record_t *record, pn_handle_t key);
277 PN_EXTERN void pn_record_set(pn_record_t *record, pn_handle_t key, void *value);
279 
280 #ifdef __cplusplus
281 }
282 #endif
283 
284 #endif /* object.h */
PN_EXTERN pn_string_t * pn_string(const char *bytes)
PN_EXTERN uintptr_t pn_hash_key(pn_hash_t *hash, pn_handle_t entry)
PN_EXTERN int pn_list_add(pn_list_t *list, void *value)
const pn_cid_t cid
Definition: object.h:50
PN_EXTERN const pn_class_t * pn_class(void *object)
PN_EXTERN int pn_string_set(pn_string_t *string, const char *bytes)
PN_EXTERN pn_list_t * pn_list(const pn_class_t *clazz, size_t capacity)
PN_EXTERN void * pn_record_get(pn_record_t *record, pn_handle_t key)
PN_EXTERN void pn_object_free(void *object)
void(* incref)(void *)
Definition: object.h:53
intptr_t(* compare)(void *, void *)
Definition: object.h:60
void(* free)(void *)
Definition: object.h:57
PN_EXTERN void * pn_iterator_next(pn_iterator_t *iterator)
PN_EXTERN pn_handle_t pn_hash_head(pn_hash_t *hash)
PN_EXTERN ssize_t pn_list_index(pn_list_t *list, void *value)
struct pn_record_t pn_record_t
Definition: object.h:46
PN_EXTERN void pn_list_minpush(pn_list_t *list, void *value)
PN_EXTERN pn_handle_t pn_map_next(pn_map_t *map, pn_handle_t entry)
PN_EXTERN pn_string_t * pn_stringn(const char *bytes, size_t n)
PN_EXTERN bool pn_list_remove(pn_list_t *list, void *value)
PN_EXTERN void pn_list_iterator(pn_list_t *list, pn_iterator_t *iter)
PN_EXTERN void pn_map_del(pn_map_t *map, void *key)
PN_EXTERN void pn_hash_del(pn_hash_t *hash, uintptr_t key)
PN_EXTERN int pn_string_addf(pn_string_t *string, const char *format,...)
struct pn_string_t pn_string_t
Definition: object.h:40
PN_EXTERN intptr_t pn_class_compare(const pn_class_t *clazz, void *a, void *b)
PN_EXTERN int pn_object_refcount(void *object)
PN_EXTERN size_t pn_list_size(pn_list_t *list)
PN_EXTERN pn_handle_t pn_map_head(pn_map_t *map)
PN_EXTERN int pn_void_inspect(void *object, pn_string_t *dst)
PN_EXTERN int pn_refcount(void *object)
#define PN_EXTERN
Definition: import_export.h:53
PN_EXTERN void * pn_list_pop(pn_list_t *list)
PN_EXTERN int pn_inspect(void *object, pn_string_t *dst)
PN_EXTERN int pn_decref(void *object)
PN_EXTERN pn_cid_t pn_class_id(const pn_class_t *clazz)
PN_EXTERN char * pn_string_buffer(pn_string_t *string)
PN_EXTERN uintptr_t pn_hashcode(void *object)
PN_EXTERN int pn_map_put(pn_map_t *map, void *key, void *value)
PN_EXTERN uintptr_t pn_void_hashcode(void *object)
PN_EXTERN void * pn_list_get(pn_list_t *list, int index)
PN_EXTERN void * pn_object_new(const pn_class_t *clazz, size_t size)
uintptr_t(* hashcode)(void *)
Definition: object.h:59
PN_EXTERN void pn_object_decref(void *object)
PN_EXTERN int pn_string_copy(pn_string_t *string, pn_string_t *src)
PN_EXTERN size_t pn_map_size(pn_map_t *map)
PN_EXTERN void * pn_hash_value(pn_hash_t *hash, pn_handle_t entry)
PN_EXTERN int pn_string_vaddf(pn_string_t *string, const char *format, va_list ap)
PN_EXTERN int pn_string_format(pn_string_t *string, const char *format,...)
PN_EXTERN void * pn_map_get(pn_map_t *map, void *key)
PN_EXTERN void * pn_class_new(const pn_class_t *clazz, size_t size)
struct pn_list_t pn_list_t
Definition: object.h:41
PN_EXTERN void * pn_hash_get(pn_hash_t *hash, uintptr_t key)
PN_EXTERN void pn_free(void *object)
PN_EXTERN const char * pn_string_get(pn_string_t *string)
PN_EXTERN const pn_class_t PN_WEAKREF[]
PN_EXTERN void pn_record_set(pn_record_t *record, pn_handle_t key, void *value)
PN_EXTERN size_t pn_string_size(pn_string_t *string)
PN_EXTERN const pn_class_t PN_VOID[]
PN_EXTERN pn_iterator_t * pn_iterator(void)
PN_EXTERN void pn_list_set(pn_list_t *list, int index, void *value)
PN_EXTERN bool pn_equals(void *a, void *b)
PN_EXTERN void pn_list_del(pn_list_t *list, int index, int n)
PN_EXTERN void pn_record_def(pn_record_t *record, pn_handle_t key, const pn_class_t *clazz)
PN_EXTERN intptr_t pn_void_compare(void *a, void *b)
PN_EXTERN bool pn_record_has(pn_record_t *record, pn_handle_t key)
PN_EXTERN int pn_class_refcount(const pn_class_t *clazz, void *object)
struct pn_map_t pn_map_t
Definition: object.h:42
PN_EXTERN void pn_list_clear(pn_list_t *list)
PN_EXTERN size_t pn_string_capacity(pn_string_t *string)
PN_EXTERN int pn_string_resize(pn_string_t *string, size_t size)
int(* inspect)(void *, pn_string_t *)
Definition: object.h:61
Definition: object.h:48
uintptr_t pn_handle_t
Definition: object.h:36
void *(* pn_iterator_next_t)(void *state)
Definition: object.h:44
PN_EXTERN pn_map_t * pn_map(const pn_class_t *key, const pn_class_t *value, size_t capacity, float load_factor)
PN_EXTERN size_t pn_hash_size(pn_hash_t *hash)
PN_EXTERN void * pn_list_minpop(pn_list_t *list)
PN_EXTERN void * pn_incref(void *object)
const char * name
Definition: object.h:49
void(* initialize)(void *)
Definition: object.h:52
PN_EXTERN bool pn_class_equals(const pn_class_t *clazz, void *a, void *b)
struct pn_hash_t pn_hash_t
Definition: object.h:43
PN_EXTERN int pn_class_decref(const pn_class_t *clazz, void *object)
pn_cid_t
Definition: cid.h:24
PN_EXTERN void pn_record_clear(pn_record_t *record)
PN_EXTERN const char * pn_class_name(const pn_class_t *clazz)
PN_EXTERN void * pn_class_incref(const pn_class_t *clazz, void *object)
PN_EXTERN intptr_t pn_compare(void *a, void *b)
PN_EXTERN void pn_string_clear(pn_string_t *string)
PN_EXTERN int pn_class_inspect(const pn_class_t *clazz, void *object, pn_string_t *dst)
void(* decref)(void *)
Definition: object.h:54
PN_EXTERN int pn_string_grow(pn_string_t *string, size_t capacity)
PN_EXTERN void * pn_map_key(pn_map_t *map, pn_handle_t entry)
PN_EXTERN int pn_string_setn(pn_string_t *string, const char *bytes, size_t n)
PN_EXTERN int pn_hash_put(pn_hash_t *hash, uintptr_t key, void *value)
PN_EXTERN const pn_class_t * pn_object_reify(void *object)
PN_EXTERN void pn_class_free(const pn_class_t *clazz, void *object)
PN_EXTERN pn_record_t * pn_record(void)
PN_EXTERN uintptr_t pn_class_hashcode(const pn_class_t *clazz, void *object)
PN_EXTERN int pn_string_vformat(pn_string_t *string, const char *format, va_list ap)
PN_EXTERN void * pn_map_value(pn_map_t *map, pn_handle_t entry)
intptr_t pn_shandle_t
Definition: object.h:37
PN_EXTERN const pn_class_t * pn_class_reify(const pn_class_t *clazz, void *object)
void(* finalize)(void *)
Definition: object.h:56
PN_EXTERN const pn_class_t PN_OBJECT[]
PN_EXTERN pn_handle_t pn_hash_next(pn_hash_t *hash, pn_handle_t entry)
PN_EXTERN ssize_t pn_string_put(pn_string_t *string, char *dst)
PN_EXTERN pn_hash_t * pn_hash(const pn_class_t *clazz, size_t capacity, float load_factor)
PN_EXTERN void pn_object_incref(void *object)
int(* refcount)(void *)
Definition: object.h:55
PN_EXTERN void * pn_iterator_start(pn_iterator_t *iterator, pn_iterator_next_t next, size_t size)
struct pn_iterator_t pn_iterator_t
Definition: object.h:45