1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/* $NetBSD: prop_dictionary.h,v 1.17 2020/06/06 21:25:59 thorpej Exp $ */
/*-
* Copyright (c) 2006, 2009, 2020 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Jason R. Thorpe.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _PROPLIB_PROP_DICTIONARY_H_
#define _PROPLIB_PROP_DICTIONARY_H_
#include <prop/prop_object.h>
#include <prop/prop_array.h>
typedef struct _prop_dictionary *prop_dictionary_t;
typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t;
__BEGIN_DECLS
prop_dictionary_t prop_dictionary_create(void);
prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int);
prop_dictionary_t prop_dictionary_copy(prop_dictionary_t);
prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t);
unsigned int prop_dictionary_count(prop_dictionary_t);
bool prop_dictionary_ensure_capacity(prop_dictionary_t,
unsigned int);
void prop_dictionary_make_immutable(prop_dictionary_t);
bool prop_dictionary_mutable(prop_dictionary_t);
prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t);
prop_array_t prop_dictionary_all_keys(prop_dictionary_t);
prop_object_t prop_dictionary_get(prop_dictionary_t, const char *);
bool prop_dictionary_set(prop_dictionary_t, const char *,
prop_object_t);
void prop_dictionary_remove(prop_dictionary_t, const char *);
prop_object_t prop_dictionary_get_keysym(prop_dictionary_t,
prop_dictionary_keysym_t);
bool prop_dictionary_set_keysym(prop_dictionary_t,
prop_dictionary_keysym_t,
prop_object_t);
void prop_dictionary_remove_keysym(prop_dictionary_t,
prop_dictionary_keysym_t);
bool prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t);
char * prop_dictionary_externalize(prop_dictionary_t);
prop_dictionary_t prop_dictionary_internalize(const char *);
bool prop_dictionary_externalize_to_file(prop_dictionary_t,
const char *);
prop_dictionary_t prop_dictionary_internalize_from_file(const char *);
const char * prop_dictionary_keysym_value(prop_dictionary_keysym_t);
bool prop_dictionary_keysym_equals(prop_dictionary_keysym_t,
prop_dictionary_keysym_t);
#if defined(__NetBSD__)
struct plistref;
#if !defined(_KERNEL) && !defined(_STANDALONE)
bool prop_dictionary_externalize_to_pref(prop_dictionary_t, struct plistref *);
bool prop_dictionary_internalize_from_pref(const struct plistref *,
prop_dictionary_t *);
int prop_dictionary_send_ioctl(prop_dictionary_t, int,
unsigned long);
int prop_dictionary_recv_ioctl(int, unsigned long,
prop_dictionary_t *);
int prop_dictionary_sendrecv_ioctl(prop_dictionary_t,
int, unsigned long,
prop_dictionary_t *);
int prop_dictionary_send_syscall(prop_dictionary_t,
struct plistref *);
int prop_dictionary_recv_syscall(const struct plistref *,
prop_dictionary_t *);
#elif defined(_KERNEL)
int prop_dictionary_copyin(const struct plistref *,
prop_dictionary_t *);
int prop_dictionary_copyin_size(const struct plistref *,
prop_dictionary_t *, size_t);
int prop_dictionary_copyout(struct plistref *,
prop_dictionary_t);
int prop_dictionary_copyin_ioctl(const struct plistref *,
const u_long,
prop_dictionary_t *);
int prop_dictionary_copyin_ioctl_size(const struct plistref *,
const u_long,
prop_dictionary_t *, size_t);
int prop_dictionary_copyout_ioctl(struct plistref *,
const u_long,
prop_dictionary_t);
#endif
#endif /* __NetBSD__ */
/*
* Utility routines to make it more convenient to work with values
* stored in dictionaries.
*/
bool prop_dictionary_get_dict(prop_dictionary_t, const char *,
prop_dictionary_t *);
bool prop_dictionary_get_bool(prop_dictionary_t, const char *,
bool *);
bool prop_dictionary_set_bool(prop_dictionary_t, const char *,
bool);
bool prop_dictionary_get_schar(prop_dictionary_t, const char *,
signed char *);
bool prop_dictionary_get_uchar(prop_dictionary_t, const char *,
unsigned char *);
bool prop_dictionary_set_schar(prop_dictionary_t, const char *,
signed char);
bool prop_dictionary_set_uchar(prop_dictionary_t, const char *,
unsigned char);
bool prop_dictionary_get_short(prop_dictionary_t, const char *,
short *);
bool prop_dictionary_get_ushort(prop_dictionary_t, const char *,
unsigned short *);
bool prop_dictionary_set_short(prop_dictionary_t, const char *,
short);
bool prop_dictionary_set_ushort(prop_dictionary_t, const char *,
unsigned short);
bool prop_dictionary_get_int(prop_dictionary_t, const char *,
int *);
bool prop_dictionary_get_uint(prop_dictionary_t, const char *,
unsigned int *);
bool prop_dictionary_set_int(prop_dictionary_t, const char *,
int);
bool prop_dictionary_set_uint(prop_dictionary_t, const char *,
unsigned int);
bool prop_dictionary_get_long(prop_dictionary_t, const char *,
long *);
bool prop_dictionary_get_ulong(prop_dictionary_t, const char *,
unsigned long *);
bool prop_dictionary_set_long(prop_dictionary_t, const char *,
long);
bool prop_dictionary_set_ulong(prop_dictionary_t, const char *,
unsigned long);
bool prop_dictionary_get_longlong(prop_dictionary_t, const char *,
long long *);
bool prop_dictionary_get_ulonglong(prop_dictionary_t, const char *,
unsigned long long *);
bool prop_dictionary_set_longlong(prop_dictionary_t, const char *,
long long);
bool prop_dictionary_set_ulonglong(prop_dictionary_t, const char *,
unsigned long long);
bool prop_dictionary_get_intptr(prop_dictionary_t, const char *,
intptr_t *);
bool prop_dictionary_get_uintptr(prop_dictionary_t, const char *,
uintptr_t *);
bool prop_dictionary_set_intptr(prop_dictionary_t, const char *,
intptr_t);
bool prop_dictionary_set_uintptr(prop_dictionary_t, const char *,
uintptr_t);
bool prop_dictionary_get_int8(prop_dictionary_t, const char *,
int8_t *);
bool prop_dictionary_get_uint8(prop_dictionary_t, const char *,
uint8_t *);
bool prop_dictionary_set_int8(prop_dictionary_t, const char *,
int8_t);
bool prop_dictionary_set_uint8(prop_dictionary_t, const char *,
uint8_t);
bool prop_dictionary_get_int16(prop_dictionary_t, const char *,
int16_t *);
bool prop_dictionary_get_uint16(prop_dictionary_t, const char *,
uint16_t *);
bool prop_dictionary_set_int16(prop_dictionary_t, const char *,
int16_t);
bool prop_dictionary_set_uint16(prop_dictionary_t, const char *,
uint16_t);
bool prop_dictionary_get_int32(prop_dictionary_t, const char *,
int32_t *);
bool prop_dictionary_get_uint32(prop_dictionary_t, const char *,
uint32_t *);
bool prop_dictionary_set_int32(prop_dictionary_t, const char *,
int32_t);
bool prop_dictionary_set_uint32(prop_dictionary_t, const char *,
uint32_t);
bool prop_dictionary_get_int64(prop_dictionary_t, const char *,
int64_t *);
bool prop_dictionary_get_uint64(prop_dictionary_t, const char *,
uint64_t *);
bool prop_dictionary_set_int64(prop_dictionary_t, const char *,
int64_t);
bool prop_dictionary_set_uint64(prop_dictionary_t, const char *,
uint64_t);
bool prop_dictionary_get_string(prop_dictionary_t, const char *,
const char **cpp);
bool prop_dictionary_set_string(prop_dictionary_t, const char *,
const char *);
bool prop_dictionary_set_string_nocopy(prop_dictionary_t,
const char *, const char *);
bool prop_dictionary_get_data(prop_dictionary_t, const char *,
const void **, size_t *);
bool prop_dictionary_set_data(prop_dictionary_t, const char *,
const void *, size_t);
bool prop_dictionary_set_data_nocopy(prop_dictionary_t, const char *,
const void *, size_t);
bool prop_dictionary_set_and_rel(prop_dictionary_t,
const char *,
prop_object_t);
/* Deprecated functions. */
bool prop_dictionary_get_cstring(prop_dictionary_t, const char *,
char **);
bool prop_dictionary_set_cstring(prop_dictionary_t, const char *,
const char *);
bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t,
const char *,
const char **);
bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t,
const char *,
const char *);
const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t);
__END_DECLS
#endif /* _PROPLIB_PROP_DICTIONARY_H_ */
|
