1 /* $NetBSD: prop_array.h,v 1.9 2009/10/10 21:26:16 bad Exp $ */
4 * Copyright (c) 2006, 2009 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
32 #ifndef _PROPLIB_PROP_ARRAY_H_
33 #define _PROPLIB_PROP_ARRAY_H_
35 #include <libprop/prop_object.h>
37 typedef struct _prop_array *prop_array_t;
40 prop_array_t prop_array_create(void);
41 prop_array_t prop_array_create_with_capacity(unsigned int);
43 prop_array_t prop_array_copy(prop_array_t);
44 prop_array_t prop_array_copy_mutable(prop_array_t);
46 unsigned int prop_array_capacity(prop_array_t);
47 unsigned int prop_array_count(prop_array_t);
48 bool prop_array_ensure_capacity(prop_array_t, unsigned int);
50 void prop_array_make_immutable(prop_array_t);
51 bool prop_array_mutable(prop_array_t);
53 prop_object_iterator_t prop_array_iterator(prop_array_t);
55 prop_object_t prop_array_get(prop_array_t, unsigned int);
56 bool prop_array_set(prop_array_t, unsigned int, prop_object_t);
57 bool prop_array_add(prop_array_t, prop_object_t);
58 void prop_array_remove(prop_array_t, unsigned int);
60 bool prop_array_equals(prop_array_t, prop_array_t);
62 char * prop_array_externalize(prop_array_t);
63 prop_array_t prop_array_internalize(const char *);
65 bool prop_array_externalize_to_file(prop_array_t, const char *);
66 prop_array_t prop_array_internalize_from_file(const char *);
70 #if !defined(_KERNEL) && !defined(_STANDALONE)
71 bool prop_array_externalize_to_pref(prop_array_t, struct plistref *);
72 int prop_array_send_ioctl(prop_array_t, int, unsigned long);
73 int prop_array_recv_ioctl(int, unsigned long, prop_array_t *);
74 #elif defined(_KERNEL)
75 int prop_array_copyin(const struct plistref *, prop_array_t *);
76 int prop_array_copyin_ioctl(const struct plistref *, const u_long,
78 int prop_array_copyout_ioctl(struct plistref *, const u_long,
83 * Utility routines to make it more convenient to work with values
84 * stored in dictionaries.
86 bool prop_array_get_bool(prop_array_t, unsigned int,
88 bool prop_array_set_bool(prop_array_t, unsigned int,
91 bool prop_array_get_int8(prop_array_t, unsigned int,
93 bool prop_array_get_uint8(prop_array_t, unsigned int,
95 bool prop_array_set_int8(prop_array_t, unsigned int,
97 bool prop_array_set_uint8(prop_array_t, unsigned int,
100 bool prop_array_get_int16(prop_array_t, unsigned int,
102 bool prop_array_get_uint16(prop_array_t, unsigned int,
104 bool prop_array_set_int16(prop_array_t, unsigned int,
106 bool prop_array_set_uint16(prop_array_t, unsigned int,
109 bool prop_array_get_int32(prop_array_t, unsigned int,
111 bool prop_array_get_uint32(prop_array_t, unsigned int,
113 bool prop_array_set_int32(prop_array_t, unsigned int,
115 bool prop_array_set_uint32(prop_array_t, unsigned int,
118 bool prop_array_get_int64(prop_array_t, unsigned int,
120 bool prop_array_get_uint64(prop_array_t, unsigned int,
122 bool prop_array_set_int64(prop_array_t, unsigned int,
124 bool prop_array_set_uint64(prop_array_t, unsigned int,
127 bool prop_array_add_int8(prop_array_t, int8_t);
128 bool prop_array_add_uint8(prop_array_t, uint8_t);
130 bool prop_array_add_int16(prop_array_t, int16_t);
131 bool prop_array_add_uint16(prop_array_t, uint16_t);
133 bool prop_array_add_int32(prop_array_t, int32_t);
134 bool prop_array_add_uint32(prop_array_t, uint32_t);
136 bool prop_array_add_int64(prop_array_t, int64_t);
137 bool prop_array_add_uint64(prop_array_t, uint64_t);
139 bool prop_array_get_cstring(prop_array_t, unsigned int,
141 bool prop_array_set_cstring(prop_array_t, unsigned int,
144 bool prop_array_get_cstring_nocopy(prop_array_t,
147 bool prop_array_set_cstring_nocopy(prop_array_t,
153 #endif /* _PROPLIB_PROP_ARRAY_H_ */