1/*
2 * Copyright (c) 2010 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
5 *
6 * Portions Copyright (c) 2010 Apple Inc. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 *
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.
18 *
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.
22 *
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
33 * SUCH DAMAGE.
34 */
35
36#ifndef HEIM_BASE_H
37#define HEIM_BASE_H 1
38
39#include <sys/types.h>
40#include <krb5-types.h>
41#include <stdarg.h>
42#include <stdbool.h>
43
44typedef void * heim_object_t;
45typedef unsigned int heim_tid_t;
46typedef heim_object_t heim_bool_t;
47typedef heim_object_t heim_null_t;
48#define HEIM_BASE_ONCE_INIT 0
49typedef long heim_base_once_t; /* XXX arch dependant */
50
51#if !defined(__has_extension)
52#define __has_extension(x) 0
53#endif
54
55#define HEIM_REQUIRE_GNUC(m,n,p) \
56    (((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__) >= \
57     (((m) * 10000) + ((n) * 100) + (p)))
58
59
60#if __has_extension(__builtin_expect) || HEIM_REQUIRE_GNUC(3,0,0)
61#define heim_builtin_expect(_op,_res) __builtin_expect(_op,_res)
62#else
63#define heim_builtin_expect(_op,_res) (_op)
64#endif
65
66
67void *	heim_retain(heim_object_t);
68void	heim_release(heim_object_t);
69
70typedef void (*heim_type_dealloc)(void *);
71
72void *
73heim_alloc(size_t size, const char *name, heim_type_dealloc dealloc);
74
75heim_tid_t
76heim_get_tid(heim_object_t object);
77
78int
79heim_cmp(heim_object_t a, heim_object_t b);
80
81unsigned long
82heim_get_hash(heim_object_t ptr);
83
84void
85heim_base_once_f(heim_base_once_t *, void *, void (*)(void *));
86
87void
88heim_abort(const char *fmt, ...)
89    HEIMDAL_NORETURN_ATTRIBUTE
90    HEIMDAL_PRINTF_ATTRIBUTE((printf, 1, 2));
91
92void
93heim_abortv(const char *fmt, va_list ap)
94    HEIMDAL_NORETURN_ATTRIBUTE
95    HEIMDAL_PRINTF_ATTRIBUTE((printf, 1, 0));
96
97#define heim_assert(e,t) \
98    (heim_builtin_expect(!(e), 0) ? heim_abort(t ":" #e) : (void)0)
99
100/*
101 *
102 */
103
104heim_null_t
105heim_null_create(void);
106
107heim_bool_t
108heim_bool_create(int);
109
110int
111heim_bool_val(heim_bool_t);
112
113/*
114 * Array
115 */
116
117typedef struct heim_array_data *heim_array_t;
118
119heim_array_t heim_array_create(void);
120heim_tid_t heim_array_get_type_id(void);
121
122typedef void (*heim_array_iterator_f_t)(heim_object_t, void *);
123
124int	heim_array_append_value(heim_array_t, heim_object_t);
125void	heim_array_iterate_f(heim_array_t, heim_array_iterator_f_t, void *);
126#ifdef __BLOCKS__
127void	heim_array_iterate(heim_array_t, void (^)(heim_object_t));
128#endif
129size_t	heim_array_get_length(heim_array_t);
130heim_object_t
131	heim_array_copy_value(heim_array_t, size_t);
132void	heim_array_delete_value(heim_array_t, size_t);
133#ifdef __BLOCKS__
134void	heim_array_filter(heim_array_t, int (^)(heim_object_t));
135#endif
136
137/*
138 * Dict
139 */
140
141typedef struct heim_dict_data *heim_dict_t;
142
143heim_dict_t heim_dict_create(size_t size);
144heim_tid_t heim_dict_get_type_id(void);
145
146typedef void (*heim_dict_iterator_f_t)(heim_object_t, heim_object_t, void *);
147
148int	heim_dict_add_value(heim_dict_t, heim_object_t, heim_object_t);
149void	heim_dict_iterate_f(heim_dict_t, heim_dict_iterator_f_t, void *);
150#ifdef __BLOCKS__
151void	heim_dict_iterate(heim_dict_t, void (^)(heim_object_t, heim_object_t));
152#endif
153
154heim_object_t
155	heim_dict_copy_value(heim_dict_t, heim_object_t);
156void	heim_dict_delete_key(heim_dict_t, heim_object_t);
157
158/*
159 * String
160 */
161
162typedef struct heim_string_data *heim_string_t;
163
164heim_string_t heim_string_create(const char *);
165heim_tid_t heim_string_get_type_id(void);
166const char * heim_string_get_utf8(heim_string_t);
167
168/*
169 * Number
170 */
171
172typedef struct heim_number_data *heim_number_t;
173
174heim_number_t heim_number_create(int);
175heim_tid_t heim_number_get_type_id(void);
176int heim_number_get_int(heim_number_t);
177
178/*
179 *
180 */
181
182typedef struct heim_auto_release * heim_auto_release_t;
183
184heim_auto_release_t heim_auto_release_create(void);
185void heim_auto_release_drain(heim_auto_release_t);
186void heim_auto_release(heim_object_t);
187
188#endif /* HEIM_BASE_H */
189