1/* $NetBSD: prop_array.h,v 1.17 2020/06/06 21:25:59 thorpej Exp $ */
2
3/*-
4 * Copyright (c) 2006, 2009, 2020 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * 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.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _PROPLIB_PROP_ARRAY_H_
33#define _PROPLIB_PROP_ARRAY_H_
34
35#include <prop/prop_object.h>
36
37typedef struct _prop_array *prop_array_t;
38
39__BEGIN_DECLS
40prop_array_t prop_array_create(void);
41prop_array_t prop_array_create_with_capacity(unsigned int);
42
43prop_array_t prop_array_copy(prop_array_t);
44prop_array_t prop_array_copy_mutable(prop_array_t);
45
46unsigned int prop_array_capacity(prop_array_t);
47unsigned int prop_array_count(prop_array_t);
48bool prop_array_ensure_capacity(prop_array_t, unsigned int);
49
50void prop_array_make_immutable(prop_array_t);
51bool prop_array_mutable(prop_array_t);
52
53prop_object_iterator_t prop_array_iterator(prop_array_t);
54
55prop_object_t prop_array_get(prop_array_t, unsigned int);
56bool prop_array_set(prop_array_t, unsigned int, prop_object_t);
57bool prop_array_add(prop_array_t, prop_object_t);
58void prop_array_remove(prop_array_t, unsigned int);
59
60bool prop_array_equals(prop_array_t, prop_array_t);
61
62char * prop_array_externalize(prop_array_t);
63prop_array_t prop_array_internalize(const char *);
64
65bool prop_array_externalize_to_file(prop_array_t, const char *);
66prop_array_t prop_array_internalize_from_file(const char *);
67
68#if defined(__NetBSD__)
69struct plistref;
70
71#if !defined(_KERNEL) && !defined(_STANDALONE)
72bool prop_array_externalize_to_pref(prop_array_t, struct plistref *);
73bool prop_array_internalize_from_pref(const struct plistref *,
74 prop_array_t *);
75int prop_array_send_ioctl(prop_array_t, int, unsigned long);
76int prop_array_recv_ioctl(int, unsigned long, prop_array_t *);
77int prop_array_send_syscall(prop_array_t, struct plistref *);
78int prop_array_recv_syscall(const struct plistref *,
79 prop_array_t *);
80#elif defined(_KERNEL)
81int prop_array_copyin(const struct plistref *, prop_array_t *);
82int prop_array_copyin_size(const struct plistref *, prop_array_t *,
83 size_t);
84int prop_array_copyout(struct plistref *, prop_array_t);
85int prop_array_copyin_ioctl(const struct plistref *, const u_long,
86 prop_array_t *);
87int prop_array_copyin_ioctl_size(const struct plistref *,
88 const u_long, prop_array_t *,
89 size_t);
90int prop_array_copyout_ioctl(struct plistref *, const u_long,
91 prop_array_t);
92#endif
93#endif /* __NetBSD__ */
94
95/*
96 * Utility routines to make it more convenient to work with values
97 * stored in dictionaries.
98 */
99bool prop_array_get_bool(prop_array_t, unsigned int,
100 bool *);
101bool prop_array_set_bool(prop_array_t, unsigned int,
102 bool);
103
104bool prop_array_get_schar(prop_array_t, unsigned int,
105 signed char *);
106bool prop_array_get_uchar(prop_array_t, unsigned int,
107 unsigned char *);
108bool prop_array_set_schar(prop_array_t, unsigned int,
109 signed char);
110bool prop_array_set_uchar(prop_array_t, unsigned int,
111 unsigned char);
112
113bool prop_array_get_short(prop_array_t, unsigned int,
114 short *);
115bool prop_array_get_ushort(prop_array_t, unsigned int,
116 unsigned short *);
117bool prop_array_set_short(prop_array_t, unsigned int,
118 short);
119bool prop_array_set_ushort(prop_array_t, unsigned int,
120 unsigned short);
121
122bool prop_array_get_int(prop_array_t, unsigned int,
123 int *);
124bool prop_array_get_uint(prop_array_t, unsigned int,
125 unsigned int *);
126bool prop_array_set_int(prop_array_t, unsigned int,
127 int);
128bool prop_array_set_uint(prop_array_t, unsigned int,
129 unsigned int);
130
131bool prop_array_get_long(prop_array_t, unsigned int,
132 long *);
133bool prop_array_get_ulong(prop_array_t, unsigned int,
134 unsigned long *);
135bool prop_array_set_long(prop_array_t, unsigned int,
136 long);
137bool prop_array_set_ulong(prop_array_t, unsigned int,
138 unsigned long);
139
140bool prop_array_get_longlong(prop_array_t, unsigned int,
141 long long *);
142bool prop_array_get_ulonglong(prop_array_t, unsigned int,
143 unsigned long long *);
144bool prop_array_set_longlong(prop_array_t, unsigned int,
145 long long);
146bool prop_array_set_ulonglong(prop_array_t, unsigned int,
147 unsigned long long);
148
149bool prop_array_get_intptr(prop_array_t, unsigned int,
150 intptr_t *);
151bool prop_array_get_uintptr(prop_array_t, unsigned int,
152 uintptr_t *);
153bool prop_array_set_intptr(prop_array_t, unsigned int,
154 intptr_t);
155bool prop_array_set_uintptr(prop_array_t, unsigned int,
156 uintptr_t);
157
158bool prop_array_get_int8(prop_array_t, unsigned int,
159 int8_t *);
160bool prop_array_get_uint8(prop_array_t, unsigned int,
161 uint8_t *);
162bool prop_array_set_int8(prop_array_t, unsigned int,
163 int8_t);
164bool prop_array_set_uint8(prop_array_t, unsigned int,
165 uint8_t);
166
167bool prop_array_get_int16(prop_array_t, unsigned int,
168 int16_t *);
169bool prop_array_get_uint16(prop_array_t, unsigned int,
170 uint16_t *);
171bool prop_array_set_int16(prop_array_t, unsigned int,
172 int16_t);
173bool prop_array_set_uint16(prop_array_t, unsigned int,
174 uint16_t);
175
176bool prop_array_get_int32(prop_array_t, unsigned int,
177 int32_t *);
178bool prop_array_get_uint32(prop_array_t, unsigned int,
179 uint32_t *);
180bool prop_array_set_int32(prop_array_t, unsigned int,
181 int32_t);
182bool prop_array_set_uint32(prop_array_t, unsigned int,
183 uint32_t);
184
185bool prop_array_get_int64(prop_array_t, unsigned int,
186 int64_t *);
187bool prop_array_get_uint64(prop_array_t, unsigned int,
188 uint64_t *);
189bool prop_array_set_int64(prop_array_t, unsigned int,
190 int64_t);
191bool prop_array_set_uint64(prop_array_t, unsigned int,
192 uint64_t);
193
194bool prop_array_set_and_rel(prop_array_t, unsigned int,
195 prop_object_t);
196
197bool prop_array_add_bool(prop_array_t, bool);
198
199bool prop_array_add_schar(prop_array_t, signed char);
200bool prop_array_add_uchar(prop_array_t, unsigned char);
201
202bool prop_array_add_short(prop_array_t, short);
203bool prop_array_add_ushort(prop_array_t, unsigned short);
204
205bool prop_array_add_int(prop_array_t, int);
206bool prop_array_add_uint(prop_array_t, unsigned int);
207
208bool prop_array_add_long(prop_array_t, long);
209bool prop_array_add_ulong(prop_array_t, unsigned long);
210
211bool prop_array_add_longlong(prop_array_t, long long);
212bool prop_array_add_ulonglong(prop_array_t, unsigned long long);
213
214bool prop_array_add_intptr(prop_array_t, intptr_t);
215bool prop_array_add_uintptr(prop_array_t, uintptr_t);
216
217bool prop_array_add_int8(prop_array_t, int8_t);
218bool prop_array_add_uint8(prop_array_t, uint8_t);
219
220bool prop_array_add_int16(prop_array_t, int16_t);
221bool prop_array_add_uint16(prop_array_t, uint16_t);
222
223bool prop_array_add_int32(prop_array_t, int32_t);
224bool prop_array_add_uint32(prop_array_t, uint32_t);
225
226bool prop_array_add_int64(prop_array_t, int64_t);
227bool prop_array_add_uint64(prop_array_t, uint64_t);
228
229bool prop_array_get_string(prop_array_t, unsigned int,
230 const char **);
231bool prop_array_set_string(prop_array_t, unsigned int,
232 const char *);
233bool prop_array_add_string(prop_array_t, const char *);
234bool prop_array_set_string_nocopy(prop_array_t, unsigned int,
235 const char *);
236bool prop_array_add_string_nocopy(prop_array_t, const char *);
237
238bool prop_array_get_data(prop_array_t, unsigned int,
239 const void **, size_t *);
240bool prop_array_set_data(prop_array_t, unsigned int,
241 const void *, size_t);
242bool prop_array_add_data(prop_array_t,
243 const void *, size_t);
244bool prop_array_set_data_nocopy(prop_array_t, unsigned int,
245 const void *, size_t);
246bool prop_array_add_data_nocopy(prop_array_t,
247 const void *, size_t);
248
249bool prop_array_add_and_rel(prop_array_t, prop_object_t);
250
251
252/* Deprecated functions. */
253
254bool prop_array_add_cstring(prop_array_t, const char *);
255bool prop_array_get_cstring(prop_array_t, unsigned int,
256 char **);
257bool prop_array_set_cstring(prop_array_t, unsigned int,
258 const char *);
259
260bool prop_array_add_cstring_nocopy(prop_array_t, const char *);
261bool prop_array_get_cstring_nocopy(prop_array_t,
262 unsigned int,
263 const char **);
264bool prop_array_set_cstring_nocopy(prop_array_t,
265 unsigned int,
266 const char *);
267__END_DECLS
268
269#endif /* _PROPLIB_PROP_ARRAY_H_ */