prop_array.h revision 1.11 1 1.11 bouyer /* $NetBSD: prop_array.h,v 1.11 2011/01/20 11:17:58 bouyer Exp $ */
2 1.1 thorpej
3 1.1 thorpej /*-
4 1.9 bad * Copyright (c) 2006, 2009 The NetBSD Foundation, Inc.
5 1.1 thorpej * All rights reserved.
6 1.1 thorpej *
7 1.1 thorpej * This code is derived from software contributed to The NetBSD Foundation
8 1.1 thorpej * by Jason R. Thorpe.
9 1.1 thorpej *
10 1.1 thorpej * Redistribution and use in source and binary forms, with or without
11 1.1 thorpej * modification, are permitted provided that the following conditions
12 1.1 thorpej * are met:
13 1.1 thorpej * 1. Redistributions of source code must retain the above copyright
14 1.1 thorpej * notice, this list of conditions and the following disclaimer.
15 1.1 thorpej * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 thorpej * notice, this list of conditions and the following disclaimer in the
17 1.1 thorpej * documentation and/or other materials provided with the distribution.
18 1.1 thorpej *
19 1.1 thorpej * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 thorpej * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 thorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 thorpej * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 thorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 thorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 thorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 thorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 thorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 thorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 thorpej * POSSIBILITY OF SUCH DAMAGE.
30 1.1 thorpej */
31 1.1 thorpej
32 1.1 thorpej #ifndef _PROPLIB_PROP_ARRAY_H_
33 1.1 thorpej #define _PROPLIB_PROP_ARRAY_H_
34 1.1 thorpej
35 1.1 thorpej #include <prop/prop_object.h>
36 1.1 thorpej
37 1.1 thorpej typedef struct _prop_array *prop_array_t;
38 1.1 thorpej
39 1.1 thorpej __BEGIN_DECLS
40 1.1 thorpej prop_array_t prop_array_create(void);
41 1.1 thorpej prop_array_t prop_array_create_with_capacity(unsigned int);
42 1.1 thorpej
43 1.1 thorpej prop_array_t prop_array_copy(prop_array_t);
44 1.1 thorpej prop_array_t prop_array_copy_mutable(prop_array_t);
45 1.1 thorpej
46 1.1 thorpej unsigned int prop_array_capacity(prop_array_t);
47 1.1 thorpej unsigned int prop_array_count(prop_array_t);
48 1.5 thorpej bool prop_array_ensure_capacity(prop_array_t, unsigned int);
49 1.1 thorpej
50 1.1 thorpej void prop_array_make_immutable(prop_array_t);
51 1.5 thorpej bool prop_array_mutable(prop_array_t);
52 1.1 thorpej
53 1.1 thorpej prop_object_iterator_t prop_array_iterator(prop_array_t);
54 1.1 thorpej
55 1.1 thorpej prop_object_t prop_array_get(prop_array_t, unsigned int);
56 1.5 thorpej bool prop_array_set(prop_array_t, unsigned int, prop_object_t);
57 1.5 thorpej bool prop_array_add(prop_array_t, prop_object_t);
58 1.1 thorpej void prop_array_remove(prop_array_t, unsigned int);
59 1.2 thorpej
60 1.5 thorpej bool prop_array_equals(prop_array_t, prop_array_t);
61 1.3 thorpej
62 1.3 thorpej char * prop_array_externalize(prop_array_t);
63 1.3 thorpej prop_array_t prop_array_internalize(const char *);
64 1.3 thorpej
65 1.5 thorpej bool prop_array_externalize_to_file(prop_array_t, const char *);
66 1.3 thorpej prop_array_t prop_array_internalize_from_file(const char *);
67 1.4 thorpej
68 1.4 thorpej #if defined(__NetBSD__)
69 1.9 bad struct plistref;
70 1.9 bad
71 1.4 thorpej #if !defined(_KERNEL) && !defined(_STANDALONE)
72 1.9 bad bool prop_array_externalize_to_pref(prop_array_t, struct plistref *);
73 1.4 thorpej int prop_array_send_ioctl(prop_array_t, int, unsigned long);
74 1.4 thorpej int prop_array_recv_ioctl(int, unsigned long, prop_array_t *);
75 1.10 bouyer bool prop_array_send_syscall(prop_array_t, struct plistref *);
76 1.10 bouyer bool prop_array_recv_syscall(const struct plistref *,
77 1.10 bouyer prop_array_t *);
78 1.4 thorpej #elif defined(_KERNEL)
79 1.9 bad int prop_array_copyin(const struct plistref *, prop_array_t *);
80 1.11 bouyer int prop_array_copyout(struct plistref *, prop_array_t);
81 1.4 thorpej int prop_array_copyin_ioctl(const struct plistref *, const u_long,
82 1.4 thorpej prop_array_t *);
83 1.4 thorpej int prop_array_copyout_ioctl(struct plistref *, const u_long,
84 1.4 thorpej prop_array_t);
85 1.4 thorpej #endif
86 1.4 thorpej #endif /* __NetBSD__ */
87 1.4 thorpej
88 1.7 haad /*
89 1.7 haad * Utility routines to make it more convenient to work with values
90 1.7 haad * stored in dictionaries.
91 1.7 haad */
92 1.7 haad bool prop_array_get_bool(prop_array_t, unsigned int,
93 1.7 haad bool *);
94 1.7 haad bool prop_array_set_bool(prop_array_t, unsigned int,
95 1.7 haad bool);
96 1.7 haad
97 1.7 haad bool prop_array_get_int8(prop_array_t, unsigned int,
98 1.7 haad int8_t *);
99 1.7 haad bool prop_array_get_uint8(prop_array_t, unsigned int,
100 1.7 haad uint8_t *);
101 1.7 haad bool prop_array_set_int8(prop_array_t, unsigned int,
102 1.7 haad int8_t);
103 1.7 haad bool prop_array_set_uint8(prop_array_t, unsigned int,
104 1.7 haad uint8_t);
105 1.7 haad
106 1.7 haad bool prop_array_get_int16(prop_array_t, unsigned int,
107 1.7 haad int16_t *);
108 1.7 haad bool prop_array_get_uint16(prop_array_t, unsigned int,
109 1.7 haad uint16_t *);
110 1.7 haad bool prop_array_set_int16(prop_array_t, unsigned int,
111 1.7 haad int16_t);
112 1.7 haad bool prop_array_set_uint16(prop_array_t, unsigned int,
113 1.7 haad uint16_t);
114 1.7 haad
115 1.7 haad bool prop_array_get_int32(prop_array_t, unsigned int,
116 1.7 haad int32_t *);
117 1.7 haad bool prop_array_get_uint32(prop_array_t, unsigned int,
118 1.7 haad uint32_t *);
119 1.7 haad bool prop_array_set_int32(prop_array_t, unsigned int,
120 1.7 haad int32_t);
121 1.7 haad bool prop_array_set_uint32(prop_array_t, unsigned int,
122 1.7 haad uint32_t);
123 1.7 haad
124 1.7 haad bool prop_array_get_int64(prop_array_t, unsigned int,
125 1.7 haad int64_t *);
126 1.7 haad bool prop_array_get_uint64(prop_array_t, unsigned int,
127 1.7 haad uint64_t *);
128 1.7 haad bool prop_array_set_int64(prop_array_t, unsigned int,
129 1.7 haad int64_t);
130 1.7 haad bool prop_array_set_uint64(prop_array_t, unsigned int,
131 1.7 haad uint64_t);
132 1.7 haad
133 1.8 haad bool prop_array_add_int8(prop_array_t, int8_t);
134 1.8 haad bool prop_array_add_uint8(prop_array_t, uint8_t);
135 1.8 haad
136 1.8 haad bool prop_array_add_int16(prop_array_t, int16_t);
137 1.8 haad bool prop_array_add_uint16(prop_array_t, uint16_t);
138 1.8 haad
139 1.8 haad bool prop_array_add_int32(prop_array_t, int32_t);
140 1.8 haad bool prop_array_add_uint32(prop_array_t, uint32_t);
141 1.8 haad
142 1.8 haad bool prop_array_add_int64(prop_array_t, int64_t);
143 1.8 haad bool prop_array_add_uint64(prop_array_t, uint64_t);
144 1.8 haad
145 1.7 haad bool prop_array_get_cstring(prop_array_t, unsigned int,
146 1.7 haad char **);
147 1.7 haad bool prop_array_set_cstring(prop_array_t, unsigned int,
148 1.7 haad const char *);
149 1.7 haad
150 1.7 haad bool prop_array_get_cstring_nocopy(prop_array_t,
151 1.7 haad unsigned int,
152 1.7 haad const char **);
153 1.7 haad bool prop_array_set_cstring_nocopy(prop_array_t,
154 1.7 haad unsigned int,
155 1.7 haad const char *);
156 1.7 haad
157 1.1 thorpej __END_DECLS
158 1.1 thorpej
159 1.1 thorpej #endif /* _PROPLIB_PROP_ARRAY_H_ */
160