2 * Copyright (c) 2010 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Portions Copyright (c) 2010 Apple Inc. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the Institute nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #include <sys/types.h>
40 #include <krb5-types.h>
44 #define HEIM_BASE_API_VERSION 20130210
46 typedef void * heim_object_t
;
47 typedef unsigned int heim_tid_t
;
48 typedef heim_object_t heim_bool_t
;
49 typedef heim_object_t heim_null_t
;
50 #define HEIM_BASE_ONCE_INIT 0
51 typedef long heim_base_once_t
; /* XXX arch dependant */
53 #if !defined(__has_extension)
54 #define __has_extension(x) 0
57 #define HEIM_REQUIRE_GNUC(m,n,p) \
58 (((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__) >= \
59 (((m) * 10000) + ((n) * 100) + (p)))
62 #if __has_extension(__builtin_expect) || HEIM_REQUIRE_GNUC(3,0,0)
63 #define heim_builtin_expect(_op,_res) __builtin_expect(_op,_res)
65 #define heim_builtin_expect(_op,_res) (_op)
69 void * heim_retain(heim_object_t
);
70 void heim_release(heim_object_t
);
72 void heim_show(heim_object_t
);
74 typedef void (*heim_type_dealloc
)(void *);
77 heim_alloc(size_t size
, const char *name
, heim_type_dealloc dealloc
);
80 heim_get_tid(heim_object_t object
);
83 heim_cmp(heim_object_t a
, heim_object_t b
);
86 heim_get_hash(heim_object_t ptr
);
89 heim_base_once_f(heim_base_once_t
*, void *, void (*)(void *));
92 heim_abort(const char *fmt
, ...)
93 HEIMDAL_NORETURN_ATTRIBUTE
94 HEIMDAL_PRINTF_ATTRIBUTE((printf
, 1, 2));
97 heim_abortv(const char *fmt
, va_list ap
)
98 HEIMDAL_NORETURN_ATTRIBUTE
99 HEIMDAL_PRINTF_ATTRIBUTE((printf
, 1, 0));
101 #define heim_assert(e,t) \
102 (heim_builtin_expect(!(e), 0) ? heim_abort(t ":" #e) : (void)0)
109 heim_null_create(void);
112 heim_bool_create(int);
115 heim_bool_val(heim_bool_t
);
121 typedef struct heim_array_data
*heim_array_t
;
123 heim_array_t
heim_array_create(void);
124 heim_tid_t
heim_array_get_type_id(void);
126 typedef void (*heim_array_iterator_f_t
)(heim_object_t
, void *, int *);
127 typedef int (*heim_array_filter_f_t
)(heim_object_t
, void *);
129 int heim_array_append_value(heim_array_t
, heim_object_t
);
130 int heim_array_insert_value(heim_array_t
, size_t idx
, heim_object_t
);
131 void heim_array_iterate_f(heim_array_t
, void *, heim_array_iterator_f_t
);
132 void heim_array_iterate_reverse_f(heim_array_t
, void *, heim_array_iterator_f_t
);
134 void heim_array_iterate(heim_array_t
, void (^)(heim_object_t
, int *));
135 void heim_array_iterate_reverse(heim_array_t
, void (^)(heim_object_t
, int *));
137 size_t heim_array_get_length(heim_array_t
);
139 heim_array_get_value(heim_array_t
, size_t);
141 heim_array_copy_value(heim_array_t
, size_t);
142 void heim_array_set_value(heim_array_t
, size_t, heim_object_t
);
143 void heim_array_delete_value(heim_array_t
, size_t);
144 void heim_array_filter_f(heim_array_t
, void *, heim_array_filter_f_t
);
146 void heim_array_filter(heim_array_t
, int (^)(heim_object_t
));
153 typedef struct heim_dict_data
*heim_dict_t
;
155 heim_dict_t
heim_dict_create(size_t size
);
156 heim_tid_t
heim_dict_get_type_id(void);
158 typedef void (*heim_dict_iterator_f_t
)(heim_object_t
, heim_object_t
, void *);
160 int heim_dict_set_value(heim_dict_t
, heim_object_t
, heim_object_t
);
161 void heim_dict_iterate_f(heim_dict_t
, void *, heim_dict_iterator_f_t
);
163 void heim_dict_iterate(heim_dict_t
, void (^)(heim_object_t
, heim_object_t
));
167 heim_dict_get_value(heim_dict_t
, heim_object_t
);
169 heim_dict_copy_value(heim_dict_t
, heim_object_t
);
170 void heim_dict_delete_key(heim_dict_t
, heim_object_t
);
176 typedef struct heim_string_data
*heim_string_t
;
177 typedef void (*heim_string_free_f_t
)(void *);
179 heim_string_t
heim_string_create(const char *);
180 heim_string_t
heim_string_ref_create(const char *, heim_string_free_f_t
);
181 heim_string_t
heim_string_create_with_bytes(const void *, size_t);
182 heim_string_t
heim_string_ref_create_with_bytes(const void *, size_t,
183 heim_string_free_f_t
);
184 heim_string_t
heim_string_create_with_format(const char *, ...);
185 heim_tid_t
heim_string_get_type_id(void);
186 const char * heim_string_get_utf8(heim_string_t
);
188 #define HSTR(_str) (__heim_string_constant("" _str ""))
189 heim_string_t
__heim_string_constant(const char *);
195 typedef struct heim_error
* heim_error_t
;
197 heim_error_t
heim_error_create_enomem(void);
199 heim_error_t
heim_error_create(int, const char *, ...)
200 HEIMDAL_PRINTF_ATTRIBUTE((printf
, 2, 3));
202 void heim_error_create_opt(heim_error_t
*error
, int error_code
, const char *fmt
, ...)
203 HEIMDAL_PRINTF_ATTRIBUTE((printf
, 3, 4));
205 heim_error_t
heim_error_createv(int, const char *, va_list)
206 HEIMDAL_PRINTF_ATTRIBUTE((printf
, 2, 0));
208 heim_string_t
heim_error_copy_string(heim_error_t
);
209 int heim_error_get_code(heim_error_t
);
211 heim_error_t
heim_error_append(heim_error_t
, heim_error_t
);
217 heim_object_t
heim_path_get(heim_object_t ptr
, heim_error_t
*error
, ...);
218 heim_object_t
heim_path_copy(heim_object_t ptr
, heim_error_t
*error
, ...);
219 heim_object_t
heim_path_vget(heim_object_t ptr
, heim_error_t
*error
,
221 heim_object_t
heim_path_vcopy(heim_object_t ptr
, heim_error_t
*error
,
224 int heim_path_vcreate(heim_object_t ptr
, size_t size
, heim_object_t leaf
,
225 heim_error_t
*error
, va_list ap
);
226 int heim_path_create(heim_object_t ptr
, size_t size
, heim_object_t leaf
,
227 heim_error_t
*error
, ...);
229 void heim_path_vdelete(heim_object_t ptr
, heim_error_t
*error
, va_list ap
);
230 void heim_path_delete(heim_object_t ptr
, heim_error_t
*error
, ...);
233 * Data (octet strings)
236 #ifndef __HEIM_BASE_DATA__
237 #define __HEIM_BASE_DATA__
238 struct heim_base_data
{
242 typedef struct heim_base_data heim_octet_string
;
245 typedef struct heim_base_data
* heim_data_t
;
246 typedef void (*heim_data_free_f_t
)(void *);
248 heim_data_t
heim_data_create(const void *, size_t);
249 heim_data_t
heim_data_ref_create(const void *, size_t, heim_data_free_f_t
);
250 heim_tid_t
heim_data_get_type_id(void);
251 const heim_octet_string
*
252 heim_data_get_data(heim_data_t
);
253 const void * heim_data_get_ptr(heim_data_t
);
254 size_t heim_data_get_length(heim_data_t
);
260 typedef struct heim_db_data
*heim_db_t
;
262 typedef void (*heim_db_iterator_f_t
)(heim_data_t
, heim_data_t
, void *);
264 typedef int (*heim_db_plug_open_f_t
)(void *, const char *, const char *,
265 heim_dict_t
, void **, heim_error_t
*);
266 typedef int (*heim_db_plug_clone_f_t
)(void *, void **, heim_error_t
*);
267 typedef int (*heim_db_plug_close_f_t
)(void *, heim_error_t
*);
268 typedef int (*heim_db_plug_lock_f_t
)(void *, int, heim_error_t
*);
269 typedef int (*heim_db_plug_unlock_f_t
)(void *, heim_error_t
*);
270 typedef int (*heim_db_plug_sync_f_t
)(void *, heim_error_t
*);
271 typedef int (*heim_db_plug_begin_f_t
)(void *, int, heim_error_t
*);
272 typedef int (*heim_db_plug_commit_f_t
)(void *, heim_error_t
*);
273 typedef int (*heim_db_plug_rollback_f_t
)(void *, heim_error_t
*);
274 typedef heim_data_t (*heim_db_plug_copy_value_f_t
)(void *, heim_string_t
,
277 typedef int (*heim_db_plug_set_value_f_t
)(void *, heim_string_t
, heim_data_t
,
278 heim_data_t
, heim_error_t
*);
279 typedef int (*heim_db_plug_del_key_f_t
)(void *, heim_string_t
, heim_data_t
,
281 typedef void (*heim_db_plug_iter_f_t
)(void *, heim_string_t
, void *,
282 heim_db_iterator_f_t
, heim_error_t
*);
284 struct heim_db_type
{
286 heim_db_plug_open_f_t openf
;
287 heim_db_plug_clone_f_t clonef
;
288 heim_db_plug_close_f_t closef
;
289 heim_db_plug_lock_f_t lockf
;
290 heim_db_plug_unlock_f_t unlockf
;
291 heim_db_plug_sync_f_t syncf
;
292 heim_db_plug_begin_f_t beginf
;
293 heim_db_plug_commit_f_t commitf
;
294 heim_db_plug_rollback_f_t rollbackf
;
295 heim_db_plug_copy_value_f_t copyf
;
296 heim_db_plug_set_value_f_t setf
;
297 heim_db_plug_del_key_f_t delf
;
298 heim_db_plug_iter_f_t iterf
;
301 extern struct heim_db_type heim_sorted_text_file_dbtype
;
303 #define HEIM_DB_TYPE_VERSION_01 1
305 int heim_db_register(const char *dbtype
,
307 struct heim_db_type
*plugin
);
309 heim_db_t
heim_db_create(const char *dbtype
, const char *dbname
,
310 heim_dict_t options
, heim_error_t
*error
);
311 heim_db_t
heim_db_clone(heim_db_t
, heim_error_t
*);
312 int heim_db_begin(heim_db_t
, int, heim_error_t
*);
313 int heim_db_commit(heim_db_t
, heim_error_t
*);
314 int heim_db_rollback(heim_db_t
, heim_error_t
*);
315 heim_tid_t
heim_db_get_type_id(void);
317 int heim_db_set_value(heim_db_t
, heim_string_t
, heim_data_t
, heim_data_t
,
319 heim_data_t
heim_db_copy_value(heim_db_t
, heim_string_t
, heim_data_t
,
321 int heim_db_delete_key(heim_db_t
, heim_string_t
, heim_data_t
,
323 void heim_db_iterate_f(heim_db_t
, heim_string_t
, void *,
324 heim_db_iterator_f_t
, heim_error_t
*);
326 void heim_db_iterate(heim_db_t
, heim_string_t
,
327 void (^)(heim_data_t
, heim_data_t
), heim_error_t
*);
335 typedef struct heim_number_data
*heim_number_t
;
337 heim_number_t
heim_number_create(int);
338 heim_tid_t
heim_number_get_type_id(void);
339 int heim_number_get_int(heim_number_t
);
345 typedef struct heim_auto_release
* heim_auto_release_t
;
347 heim_auto_release_t
heim_auto_release_create(void);
348 void heim_auto_release_drain(heim_auto_release_t
);
349 heim_object_t
heim_auto_release(heim_object_t
);
354 typedef enum heim_json_flags
{
355 HEIM_JSON_F_NO_C_NULL
= 1,
356 HEIM_JSON_F_STRICT_STRINGS
= 2,
357 HEIM_JSON_F_NO_DATA
= 4,
358 HEIM_JSON_F_NO_DATA_DICT
= 8,
359 HEIM_JSON_F_STRICT_DICT
= 16,
360 HEIM_JSON_F_STRICT
= 31,
361 HEIM_JSON_F_CNULL2JSNULL
= 32,
362 HEIM_JSON_F_TRY_DECODE_DATA
= 64,
363 HEIM_JSON_F_ONE_LINE
= 128
366 heim_object_t
heim_json_create(const char *, size_t, heim_json_flags_t
,
368 heim_object_t
heim_json_create_with_bytes(const void *, size_t, size_t,
371 heim_string_t
heim_copy_serialize(heim_object_t
, heim_json_flags_t
,
380 heim_description(heim_object_t ptr
);
385 * Note: these are private until integrated into the heimbase object system.
387 typedef struct bsearch_file_handle
*bsearch_file_handle
;
388 int _bsearch_text(const char *buf
, size_t buf_sz
, const char *key
,
389 char **value
, size_t *location
, size_t *loops
);
390 int _bsearch_file_open(const char *fname
, size_t max_sz
, size_t page_sz
,
391 bsearch_file_handle
*bfh
, size_t *reads
);
392 int _bsearch_file(bsearch_file_handle bfh
, const char *key
, char **value
,
393 size_t *location
, size_t *loops
, size_t *reads
);
394 void _bsearch_file_info(bsearch_file_handle bfh
, size_t *page_sz
,
395 size_t *max_sz
, int *blockwise
);
396 void _bsearch_file_close(bsearch_file_handle
*bfh
);
398 #endif /* HEIM_BASE_H */