proton  0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 
47 struct pn_class_t {
48  const char *name;
49  const pn_cid_t cid;
50  void *(*newinst)(const pn_class_t *, size_t);
51  void (*initialize)(void *);
52  void (*incref)(void *);
53  void (*decref)(void *);
54  int (*refcount)(void *);
55  void (*finalize)(void *);
56  void (*free)(void *);
57  const pn_class_t *(*reify)(void *);
58  uintptr_t (*hashcode)(void *);
59  intptr_t (*compare)(void *, void *);
60  int (*inspect)(void *, pn_string_t *);
61 };
62 
63 PN_EXTERN extern const pn_class_t *PN_OBJECT;
64 PN_EXTERN extern const pn_class_t *PN_VOID;
65 PN_EXTERN extern const pn_class_t *PN_WEAKREF;
66 
67 #define PN_CLASS(PREFIX) { \
68  #PREFIX, \
69  CID_ ## PREFIX, \
70  pn_object_new, \
71  PREFIX ## _initialize, \
72  pn_object_incref, \
73  pn_object_decref, \
74  pn_object_refcount, \
75  PREFIX ## _finalize, \
76  pn_object_free, \
77  pn_object_reify, \
78  PREFIX ## _hashcode, \
79  PREFIX ## _compare, \
80  PREFIX ## _inspect \
81 }
82 
83 #define PN_METACLASS(PREFIX) { \
84  #PREFIX, \
85  CID_ ## PREFIX, \
86  PREFIX ## _new, \
87  PREFIX ## _initialize, \
88  PREFIX ## _incref, \
89  PREFIX ## _decref, \
90  PREFIX ## _refcount, \
91  PREFIX ## _finalize, \
92  PREFIX ## _free, \
93  PREFIX ## _reify, \
94  PREFIX ## _hashcode, \
95  PREFIX ## _compare, \
96  PREFIX ## _inspect \
97 }
98 
100 PN_EXTERN const char *pn_class_name(const pn_class_t *clazz);
101 PN_EXTERN void *pn_class_new(const pn_class_t *clazz, size_t size);
102 PN_EXTERN void *pn_class_incref(const pn_class_t *clazz, void *object);
103 PN_EXTERN int pn_class_refcount(const pn_class_t *clazz, void *object);
104 PN_EXTERN int pn_class_decref(const pn_class_t *clazz, void *object);
105 PN_EXTERN void pn_class_free(const pn_class_t *clazz, void *object);
106 PN_EXTERN const pn_class_t *pn_class_reify(const pn_class_t *clazz, void *object);
107 PN_EXTERN uintptr_t pn_class_hashcode(const pn_class_t *clazz, void *object);
108 PN_EXTERN intptr_t pn_class_compare(const pn_class_t *clazz, void *a, void *b);
109 PN_EXTERN bool pn_class_equals(const pn_class_t *clazz, void *a, void *b);
110 PN_EXTERN int pn_class_inspect(const pn_class_t *clazz, void *object, pn_string_t *dst);
111 
112 PN_EXTERN uintptr_t pn_void_hashcode(void *object);
113 PN_EXTERN intptr_t pn_void_compare(void *a, void *b);
114 PN_EXTERN int pn_void_inspect(void *object, pn_string_t *dst);
115 
116 PN_EXTERN void *pn_object_new(const pn_class_t *clazz, size_t size);
117 PN_EXTERN const pn_class_t *pn_object_reify(void *object);
118 PN_EXTERN void pn_object_incref(void *object);
119 PN_EXTERN int pn_object_refcount(void *object);
120 PN_EXTERN void pn_object_decref(void *object);
121 PN_EXTERN void pn_object_free(void *object);
122 
123 PN_EXTERN void *pn_incref(void *object);
124 PN_EXTERN int pn_decref(void *object);
125 PN_EXTERN int pn_refcount(void *object);
126 PN_EXTERN void pn_free(void *object);
127 PN_EXTERN const pn_class_t *pn_class(void* object);
128 PN_EXTERN uintptr_t pn_hashcode(void *object);
129 PN_EXTERN intptr_t pn_compare(void *a, void *b);
130 PN_EXTERN bool pn_equals(void *a, void *b);
131 PN_EXTERN int pn_inspect(void *object, pn_string_t *dst);
132 
133 #define PN_REFCOUNT (0x1)
134 
135 PN_EXTERN pn_list_t *pn_list(const pn_class_t *clazz, size_t capacity);
136 PN_EXTERN size_t pn_list_size(pn_list_t *list);
137 PN_EXTERN void *pn_list_get(pn_list_t *list, int index);
138 PN_EXTERN void pn_list_set(pn_list_t *list, int index, void *value);
139 PN_EXTERN int pn_list_add(pn_list_t *list, void *value);
140 PN_EXTERN ssize_t pn_list_index(pn_list_t *list, void *value);
141 PN_EXTERN bool pn_list_remove(pn_list_t *list, void *value);
142 PN_EXTERN void pn_list_del(pn_list_t *list, int index, int n);
143 PN_EXTERN void pn_list_clear(pn_list_t *list);
145 
146 #define PN_REFCOUNT_KEY (0x2)
147 #define PN_REFCOUNT_VALUE (0x4)
148 
149 PN_EXTERN pn_map_t *pn_map(const pn_class_t *key, const pn_class_t *value,
150  size_t capacity, float load_factor);
151 PN_EXTERN size_t pn_map_size(pn_map_t *map);
152 PN_EXTERN int pn_map_put(pn_map_t *map, void *key, void *value);
153 PN_EXTERN void *pn_map_get(pn_map_t *map, void *key);
154 PN_EXTERN void pn_map_del(pn_map_t *map, void *key);
155 PN_EXTERN pn_handle_t pn_map_head(pn_map_t *map);
156 PN_EXTERN pn_handle_t pn_map_next(pn_map_t *map, pn_handle_t entry);
157 PN_EXTERN void *pn_map_key(pn_map_t *map, pn_handle_t entry);
158 PN_EXTERN void *pn_map_value(pn_map_t *map, pn_handle_t entry);
159 
160 PN_EXTERN pn_hash_t *pn_hash(const pn_class_t *clazz, size_t capacity, float load_factor);
161 PN_EXTERN size_t pn_hash_size(pn_hash_t *hash);
162 PN_EXTERN int pn_hash_put(pn_hash_t *hash, uintptr_t key, void *value);
163 PN_EXTERN void *pn_hash_get(pn_hash_t *hash, uintptr_t key);
164 PN_EXTERN void pn_hash_del(pn_hash_t *hash, uintptr_t key);
165 PN_EXTERN pn_handle_t pn_hash_head(pn_hash_t *hash);
166 PN_EXTERN pn_handle_t pn_hash_next(pn_hash_t *hash, pn_handle_t entry);
167 PN_EXTERN uintptr_t pn_hash_key(pn_hash_t *hash, pn_handle_t entry);
168 PN_EXTERN void *pn_hash_value(pn_hash_t *hash, pn_handle_t entry);
169 
170 PN_EXTERN pn_string_t *pn_string(const char *bytes);
171 PN_EXTERN pn_string_t *pn_stringn(const char *bytes, size_t n);
172 PN_EXTERN const char *pn_string_get(pn_string_t *string);
173 PN_EXTERN size_t pn_string_size(pn_string_t *string);
174 PN_EXTERN int pn_string_set(pn_string_t *string, const char *bytes);
175 PN_EXTERN int pn_string_setn(pn_string_t *string, const char *bytes, size_t n);
176 PN_EXTERN ssize_t pn_string_put(pn_string_t *string, char *dst);
178 PN_EXTERN int pn_string_format(pn_string_t *string, const char *format, ...)
179 #ifdef __GNUC__
180  __attribute__ ((format (printf, 2, 3)))
181 #endif
182  ;
183 PN_EXTERN int pn_string_vformat(pn_string_t *string, const char *format, va_list ap);
184 PN_EXTERN int pn_string_addf(pn_string_t *string, const char *format, ...)
185 #ifdef __GNUC__
186  __attribute__ ((format (printf, 2, 3)))
187 #endif
188  ;
189 PN_EXTERN int pn_string_vaddf(pn_string_t *string, const char *format, va_list ap);
190 PN_EXTERN int pn_string_grow(pn_string_t *string, size_t capacity);
191 PN_EXTERN char *pn_string_buffer(pn_string_t *string);
193 PN_EXTERN int pn_string_resize(pn_string_t *string, size_t size);
195 
198  pn_iterator_next_t next, size_t size);
199 PN_EXTERN void *pn_iterator_next(pn_iterator_t *iterator);
200 
201 #ifdef __cplusplus
202 }
203 #endif
204 
205 #endif /* object.h */
intptr_t pn_shandle_t
Definition: object.h:37
PN_EXTERN bool pn_class_equals(const pn_class_t *clazz, void *a, void *b)
PN_EXTERN pn_string_t * pn_stringn(const char *bytes, size_t n)
PN_EXTERN void * pn_incref(void *object)
PN_EXTERN void pn_list_clear(pn_list_t *list)
PN_EXTERN const char * pn_class_name(const pn_class_t *clazz)
struct pn_map_t pn_map_t
Definition: object.h:42
PN_EXTERN size_t pn_string_size(pn_string_t *string)
PN_EXTERN pn_cid_t pn_class_id(const pn_class_t *clazz)
PN_EXTERN int pn_hash_put(pn_hash_t *hash, uintptr_t key, void *value)
const pn_cid_t cid
Definition: object.h:49
PN_EXTERN int pn_string_addf(pn_string_t *string, const char *format,...)
PN_EXTERN const pn_class_t * pn_class(void *object)
PN_EXTERN pn_handle_t pn_hash_head(pn_hash_t *hash)
uintptr_t pn_handle_t
Definition: object.h:36
PN_EXTERN pn_handle_t pn_map_head(pn_map_t *map)
PN_EXTERN const pn_class_t * PN_WEAKREF
const char * name
Definition: object.h:48
PN_EXTERN const pn_class_t * pn_class_reify(const pn_class_t *clazz, void *object)
PN_EXTERN void * pn_object_new(const pn_class_t *clazz, size_t size)
PN_EXTERN intptr_t pn_void_compare(void *a, void *b)
#define PN_EXTERN
Definition: import_export.h:53
PN_EXTERN void pn_hash_del(pn_hash_t *hash, uintptr_t key)
void *(* pn_iterator_next_t)(void *state)
Definition: object.h:44
PN_EXTERN int pn_decref(void *object)
int(* refcount)(void *)
Definition: object.h:54
void(* finalize)(void *)
Definition: object.h:55
PN_EXTERN pn_map_t * pn_map(const pn_class_t *key, const pn_class_t *value, size_t capacity, float load_factor)
struct pn_iterator_t pn_iterator_t
Definition: object.h:45
PN_EXTERN int pn_string_grow(pn_string_t *string, size_t capacity)
PN_EXTERN const pn_class_t * PN_OBJECT
PN_EXTERN void * pn_class_incref(const pn_class_t *clazz, void *object)
PN_EXTERN int pn_class_inspect(const pn_class_t *clazz, void *object, pn_string_t *dst)
PN_EXTERN void * pn_list_get(pn_list_t *list, int index)
void(* incref)(void *)
Definition: object.h:52
PN_EXTERN int pn_string_vaddf(pn_string_t *string, const char *format, va_list ap)
PN_EXTERN int pn_string_set(pn_string_t *string, const char *bytes)
PN_EXTERN void pn_object_incref(void *object)
PN_EXTERN uintptr_t pn_void_hashcode(void *object)
PN_EXTERN ssize_t pn_string_put(pn_string_t *string, char *dst)
intptr_t(* compare)(void *, void *)
Definition: object.h:59
uintptr_t(* hashcode)(void *)
Definition: object.h:58
struct pn_list_t pn_list_t
Definition: object.h:41
PN_EXTERN void pn_string_clear(pn_string_t *string)
PN_EXTERN void * pn_hash_get(pn_hash_t *hash, uintptr_t key)
PN_EXTERN uintptr_t pn_hashcode(void *object)
PN_EXTERN int pn_refcount(void *object)
PN_EXTERN pn_hash_t * pn_hash(const pn_class_t *clazz, size_t capacity, float load_factor)
PN_EXTERN int pn_object_refcount(void *object)
PN_EXTERN void * pn_map_value(pn_map_t *map, pn_handle_t entry)
PN_EXTERN bool pn_equals(void *a, void *b)
PN_EXTERN pn_string_t * pn_string(const char *bytes)
PN_EXTERN int pn_string_setn(pn_string_t *string, const char *bytes, size_t n)
PN_EXTERN size_t pn_map_size(pn_map_t *map)
PN_EXTERN const pn_class_t * pn_object_reify(void *object)
Definition: object.h:47
PN_EXTERN pn_handle_t pn_map_next(pn_map_t *map, pn_handle_t entry)
PN_EXTERN void pn_class_free(const pn_class_t *clazz, void *object)
PN_EXTERN int pn_list_add(pn_list_t *list, void *value)
PN_EXTERN intptr_t pn_compare(void *a, void *b)
PN_EXTERN bool pn_list_remove(pn_list_t *list, void *value)
PN_EXTERN void pn_list_set(pn_list_t *list, int index, void *value)
PN_EXTERN void pn_list_del(pn_list_t *list, int index, int n)
void(* free)(void *)
Definition: object.h:56
void(* initialize)(void *)
Definition: object.h:51
PN_EXTERN size_t pn_hash_size(pn_hash_t *hash)
int(* inspect)(void *, pn_string_t *)
Definition: object.h:60
PN_EXTERN int pn_string_resize(pn_string_t *string, size_t size)
PN_EXTERN size_t pn_list_size(pn_list_t *list)
PN_EXTERN void * pn_iterator_start(pn_iterator_t *iterator, pn_iterator_next_t next, size_t size)
PN_EXTERN const char * pn_string_get(pn_string_t *string)
pn_cid_t
Definition: cid.h:24
PN_EXTERN int pn_class_decref(const pn_class_t *clazz, void *object)
struct pn_hash_t pn_hash_t
Definition: object.h:43
PN_EXTERN ssize_t pn_list_index(pn_list_t *list, void *value)
PN_EXTERN void * pn_hash_value(pn_hash_t *hash, pn_handle_t entry)
PN_EXTERN uintptr_t pn_hash_key(pn_hash_t *hash, pn_handle_t entry)
PN_EXTERN pn_list_t * pn_list(const pn_class_t *clazz, size_t capacity)
PN_EXTERN void pn_object_decref(void *object)
PN_EXTERN void * pn_map_get(pn_map_t *map, void *key)
PN_EXTERN int pn_string_vformat(pn_string_t *string, const char *format, va_list ap)
PN_EXTERN void * pn_class_new(const pn_class_t *clazz, size_t size)
PN_EXTERN void * pn_iterator_next(pn_iterator_t *iterator)
PN_EXTERN int pn_class_refcount(const pn_class_t *clazz, void *object)
PN_EXTERN void * pn_map_key(pn_map_t *map, pn_handle_t entry)
struct pn_string_t pn_string_t
Definition: object.h:40
PN_EXTERN const pn_class_t * PN_VOID
PN_EXTERN int pn_map_put(pn_map_t *map, void *key, void *value)
PN_EXTERN void pn_object_free(void *object)
PN_EXTERN size_t pn_string_capacity(pn_string_t *string)
PN_EXTERN void pn_free(void *object)
PN_EXTERN int pn_string_copy(pn_string_t *string, pn_string_t *src)
void(* decref)(void *)
Definition: object.h:53
PN_EXTERN void pn_list_iterator(pn_list_t *list, pn_iterator_t *iter)
PN_EXTERN pn_iterator_t * pn_iterator(void)
PN_EXTERN int pn_string_format(pn_string_t *string, const char *format,...)
PN_EXTERN void pn_map_del(pn_map_t *map, void *key)
PN_EXTERN int pn_void_inspect(void *object, pn_string_t *dst)
PN_EXTERN uintptr_t pn_class_hashcode(const pn_class_t *clazz, void *object)
PN_EXTERN pn_handle_t pn_hash_next(pn_hash_t *hash, pn_handle_t entry)
PN_EXTERN char * pn_string_buffer(pn_string_t *string)
PN_EXTERN intptr_t pn_class_compare(const pn_class_t *clazz, void *a, void *b)
PN_EXTERN int pn_inspect(void *object, pn_string_t *dst)