Fri Jan 22 23:03:46 2016 UTC ()
Needs prop_array.h to compile.


(dholland)
diff -r1.14 -r1.15 src/common/include/prop/prop_dictionary.h

cvs diff -r1.14 -r1.15 src/common/include/prop/prop_dictionary.h (switch to unified diff)

--- src/common/include/prop/prop_dictionary.h 2011/09/30 22:08:18 1.14
+++ src/common/include/prop/prop_dictionary.h 2016/01/22 23:03:46 1.15
@@ -1,181 +1,182 @@ @@ -1,181 +1,182 @@
1/* $NetBSD: prop_dictionary.h,v 1.14 2011/09/30 22:08:18 jym Exp $ */ 1/* $NetBSD: prop_dictionary.h,v 1.15 2016/01/22 23:03:46 dholland Exp $ */
2 2
3/*- 3/*-
4 * Copyright (c) 2006, 2009 The NetBSD Foundation, Inc. 4 * Copyright (c) 2006, 2009 The NetBSD Foundation, Inc.
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * This code is derived from software contributed to The NetBSD Foundation 7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe. 8 * by Jason R. Thorpe.
9 * 9 *
10 * Redistribution and use in source and binary forms, with or without 10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions 11 * modification, are permitted provided that the following conditions
12 * are met: 12 * are met:
13 * 1. Redistributions of source code must retain the above copyright 13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer. 14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright 15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the 16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution. 17 * documentation and/or other materials provided with the distribution.
18 * 18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 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 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 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 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 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 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 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE. 29 * POSSIBILITY OF SUCH DAMAGE.
30 */ 30 */
31 31
32#ifndef _PROPLIB_PROP_DICTIONARY_H_ 32#ifndef _PROPLIB_PROP_DICTIONARY_H_
33#define _PROPLIB_PROP_DICTIONARY_H_ 33#define _PROPLIB_PROP_DICTIONARY_H_
34 34
35#include <prop/prop_object.h> 35#include <prop/prop_object.h>
 36#include <prop/prop_array.h>
36 37
37typedef struct _prop_dictionary *prop_dictionary_t; 38typedef struct _prop_dictionary *prop_dictionary_t;
38typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t; 39typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t;
39 40
40__BEGIN_DECLS 41__BEGIN_DECLS
41prop_dictionary_t prop_dictionary_create(void); 42prop_dictionary_t prop_dictionary_create(void);
42prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int); 43prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int);
43 44
44prop_dictionary_t prop_dictionary_copy(prop_dictionary_t); 45prop_dictionary_t prop_dictionary_copy(prop_dictionary_t);
45prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t); 46prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t);
46 47
47unsigned int prop_dictionary_count(prop_dictionary_t); 48unsigned int prop_dictionary_count(prop_dictionary_t);
48bool prop_dictionary_ensure_capacity(prop_dictionary_t, 49bool prop_dictionary_ensure_capacity(prop_dictionary_t,
49 unsigned int); 50 unsigned int);
50 51
51void prop_dictionary_make_immutable(prop_dictionary_t); 52void prop_dictionary_make_immutable(prop_dictionary_t);
52bool prop_dictionary_mutable(prop_dictionary_t); 53bool prop_dictionary_mutable(prop_dictionary_t);
53 54
54prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t); 55prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t);
55prop_array_t prop_dictionary_all_keys(prop_dictionary_t); 56prop_array_t prop_dictionary_all_keys(prop_dictionary_t);
56 57
57prop_object_t prop_dictionary_get(prop_dictionary_t, const char *); 58prop_object_t prop_dictionary_get(prop_dictionary_t, const char *);
58bool prop_dictionary_set(prop_dictionary_t, const char *, 59bool prop_dictionary_set(prop_dictionary_t, const char *,
59 prop_object_t); 60 prop_object_t);
60void prop_dictionary_remove(prop_dictionary_t, const char *); 61void prop_dictionary_remove(prop_dictionary_t, const char *);
61 62
62prop_object_t prop_dictionary_get_keysym(prop_dictionary_t, 63prop_object_t prop_dictionary_get_keysym(prop_dictionary_t,
63 prop_dictionary_keysym_t); 64 prop_dictionary_keysym_t);
64bool prop_dictionary_set_keysym(prop_dictionary_t, 65bool prop_dictionary_set_keysym(prop_dictionary_t,
65 prop_dictionary_keysym_t, 66 prop_dictionary_keysym_t,
66 prop_object_t); 67 prop_object_t);
67void prop_dictionary_remove_keysym(prop_dictionary_t, 68void prop_dictionary_remove_keysym(prop_dictionary_t,
68 prop_dictionary_keysym_t); 69 prop_dictionary_keysym_t);
69 70
70bool prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t); 71bool prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t);
71 72
72char * prop_dictionary_externalize(prop_dictionary_t); 73char * prop_dictionary_externalize(prop_dictionary_t);
73prop_dictionary_t prop_dictionary_internalize(const char *); 74prop_dictionary_t prop_dictionary_internalize(const char *);
74 75
75bool prop_dictionary_externalize_to_file(prop_dictionary_t, 76bool prop_dictionary_externalize_to_file(prop_dictionary_t,
76 const char *); 77 const char *);
77prop_dictionary_t prop_dictionary_internalize_from_file(const char *); 78prop_dictionary_t prop_dictionary_internalize_from_file(const char *);
78 79
79const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t); 80const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t);
80 81
81bool prop_dictionary_keysym_equals(prop_dictionary_keysym_t, 82bool prop_dictionary_keysym_equals(prop_dictionary_keysym_t,
82 prop_dictionary_keysym_t); 83 prop_dictionary_keysym_t);
83 84
84#if defined(__NetBSD__) 85#if defined(__NetBSD__)
85struct plistref; 86struct plistref;
86 87
87#if !defined(_KERNEL) && !defined(_STANDALONE) 88#if !defined(_KERNEL) && !defined(_STANDALONE)
88bool prop_dictionary_externalize_to_pref(prop_dictionary_t, struct plistref *); 89bool prop_dictionary_externalize_to_pref(prop_dictionary_t, struct plistref *);
89bool prop_dictionary_internalize_from_pref(const struct plistref *, 90bool prop_dictionary_internalize_from_pref(const struct plistref *,
90 prop_dictionary_t *); 91 prop_dictionary_t *);
91int prop_dictionary_send_ioctl(prop_dictionary_t, int, 92int prop_dictionary_send_ioctl(prop_dictionary_t, int,
92 unsigned long); 93 unsigned long);
93int prop_dictionary_recv_ioctl(int, unsigned long, 94int prop_dictionary_recv_ioctl(int, unsigned long,
94 prop_dictionary_t *); 95 prop_dictionary_t *);
95int prop_dictionary_sendrecv_ioctl(prop_dictionary_t, 96int prop_dictionary_sendrecv_ioctl(prop_dictionary_t,
96 int, unsigned long, 97 int, unsigned long,
97 prop_dictionary_t *); 98 prop_dictionary_t *);
98int prop_dictionary_send_syscall(prop_dictionary_t, 99int prop_dictionary_send_syscall(prop_dictionary_t,
99 struct plistref *); 100 struct plistref *);
100int prop_dictionary_recv_syscall(const struct plistref *, 101int prop_dictionary_recv_syscall(const struct plistref *,
101 prop_dictionary_t *); 102 prop_dictionary_t *);
102#elif defined(_KERNEL) 103#elif defined(_KERNEL)
103int prop_dictionary_copyin(const struct plistref *, 104int prop_dictionary_copyin(const struct plistref *,
104 prop_dictionary_t *); 105 prop_dictionary_t *);
105int prop_dictionary_copyout(struct plistref *, 106int prop_dictionary_copyout(struct plistref *,
106 prop_dictionary_t); 107 prop_dictionary_t);
107int prop_dictionary_copyin_ioctl(const struct plistref *, 108int prop_dictionary_copyin_ioctl(const struct plistref *,
108 const u_long, 109 const u_long,
109 prop_dictionary_t *); 110 prop_dictionary_t *);
110int prop_dictionary_copyout_ioctl(struct plistref *, 111int prop_dictionary_copyout_ioctl(struct plistref *,
111 const u_long, 112 const u_long,
112 prop_dictionary_t); 113 prop_dictionary_t);
113#endif 114#endif
114#endif /* __NetBSD__ */ 115#endif /* __NetBSD__ */
115 116
116/* 117/*
117 * Utility routines to make it more convenient to work with values 118 * Utility routines to make it more convenient to work with values
118 * stored in dictionaries. 119 * stored in dictionaries.
119 */ 120 */
120bool prop_dictionary_get_dict(prop_dictionary_t, const char *, 121bool prop_dictionary_get_dict(prop_dictionary_t, const char *,
121 prop_dictionary_t *); 122 prop_dictionary_t *);
122bool prop_dictionary_get_bool(prop_dictionary_t, const char *, 123bool prop_dictionary_get_bool(prop_dictionary_t, const char *,
123 bool *); 124 bool *);
124bool prop_dictionary_set_bool(prop_dictionary_t, const char *, 125bool prop_dictionary_set_bool(prop_dictionary_t, const char *,
125 bool); 126 bool);
126 127
127bool prop_dictionary_get_int8(prop_dictionary_t, const char *, 128bool prop_dictionary_get_int8(prop_dictionary_t, const char *,
128 int8_t *); 129 int8_t *);
129bool prop_dictionary_get_uint8(prop_dictionary_t, const char *, 130bool prop_dictionary_get_uint8(prop_dictionary_t, const char *,
130 uint8_t *); 131 uint8_t *);
131bool prop_dictionary_set_int8(prop_dictionary_t, const char *, 132bool prop_dictionary_set_int8(prop_dictionary_t, const char *,
132 int8_t); 133 int8_t);
133bool prop_dictionary_set_uint8(prop_dictionary_t, const char *, 134bool prop_dictionary_set_uint8(prop_dictionary_t, const char *,
134 uint8_t); 135 uint8_t);
135 136
136bool prop_dictionary_get_int16(prop_dictionary_t, const char *, 137bool prop_dictionary_get_int16(prop_dictionary_t, const char *,
137 int16_t *); 138 int16_t *);
138bool prop_dictionary_get_uint16(prop_dictionary_t, const char *, 139bool prop_dictionary_get_uint16(prop_dictionary_t, const char *,
139 uint16_t *); 140 uint16_t *);
140bool prop_dictionary_set_int16(prop_dictionary_t, const char *, 141bool prop_dictionary_set_int16(prop_dictionary_t, const char *,
141 int16_t); 142 int16_t);
142bool prop_dictionary_set_uint16(prop_dictionary_t, const char *, 143bool prop_dictionary_set_uint16(prop_dictionary_t, const char *,
143 uint16_t); 144 uint16_t);
144 145
145bool prop_dictionary_get_int32(prop_dictionary_t, const char *, 146bool prop_dictionary_get_int32(prop_dictionary_t, const char *,
146 int32_t *); 147 int32_t *);
147bool prop_dictionary_get_uint32(prop_dictionary_t, const char *, 148bool prop_dictionary_get_uint32(prop_dictionary_t, const char *,
148 uint32_t *); 149 uint32_t *);
149bool prop_dictionary_set_int32(prop_dictionary_t, const char *, 150bool prop_dictionary_set_int32(prop_dictionary_t, const char *,
150 int32_t); 151 int32_t);
151bool prop_dictionary_set_uint32(prop_dictionary_t, const char *, 152bool prop_dictionary_set_uint32(prop_dictionary_t, const char *,
152 uint32_t); 153 uint32_t);
153 154
154bool prop_dictionary_get_int64(prop_dictionary_t, const char *, 155bool prop_dictionary_get_int64(prop_dictionary_t, const char *,
155 int64_t *); 156 int64_t *);
156bool prop_dictionary_get_uint64(prop_dictionary_t, const char *, 157bool prop_dictionary_get_uint64(prop_dictionary_t, const char *,
157 uint64_t *); 158 uint64_t *);
158bool prop_dictionary_set_int64(prop_dictionary_t, const char *, 159bool prop_dictionary_set_int64(prop_dictionary_t, const char *,
159 int64_t); 160 int64_t);
160bool prop_dictionary_set_uint64(prop_dictionary_t, const char *, 161bool prop_dictionary_set_uint64(prop_dictionary_t, const char *,
161 uint64_t); 162 uint64_t);
162 163
163bool prop_dictionary_get_cstring(prop_dictionary_t, const char *, 164bool prop_dictionary_get_cstring(prop_dictionary_t, const char *,
164 char **); 165 char **);
165bool prop_dictionary_set_cstring(prop_dictionary_t, const char *, 166bool prop_dictionary_set_cstring(prop_dictionary_t, const char *,
166 const char *); 167 const char *);
167 168
168bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t, 169bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t,
169 const char *, 170 const char *,
170 const char **); 171 const char **);
171bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t, 172bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t,
172 const char *, 173 const char *,
173 const char *); 174 const char *);
174 175
175bool prop_dictionary_set_and_rel(prop_dictionary_t, 176bool prop_dictionary_set_and_rel(prop_dictionary_t,
176 const char *, 177 const char *,
177 prop_object_t); 178 prop_object_t);
178 179
179__END_DECLS 180__END_DECLS
180 181
181#endif /* _PROPLIB_PROP_DICTIONARY_H_ */ 182#endif /* _PROPLIB_PROP_DICTIONARY_H_ */