1 /* $NetBSD: prop_dictionary.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_DICTIONARY_H_ 33 #define _PROPLIB_PROP_DICTIONARY_H_ 34 35 #include <prop/prop_object.h> 36 #include <prop/prop_array.h> 37 38 typedef struct _prop_dictionary *prop_dictionary_t; 39 typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t; 40 41 __BEGIN_DECLS 42 prop_dictionary_t prop_dictionary_create(void); 43 prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int); 44 45 prop_dictionary_t prop_dictionary_copy(prop_dictionary_t); 46 prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t); 47 48 unsigned int prop_dictionary_count(prop_dictionary_t); 49 bool prop_dictionary_ensure_capacity(prop_dictionary_t, 50 unsigned int); 51 52 void prop_dictionary_make_immutable(prop_dictionary_t); 53 bool prop_dictionary_mutable(prop_dictionary_t); 54 55 prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t); 56 prop_array_t prop_dictionary_all_keys(prop_dictionary_t); 57 58 prop_object_t prop_dictionary_get(prop_dictionary_t, const char *); 59 bool prop_dictionary_set(prop_dictionary_t, const char *, 60 prop_object_t); 61 void prop_dictionary_remove(prop_dictionary_t, const char *); 62 63 prop_object_t prop_dictionary_get_keysym(prop_dictionary_t, 64 prop_dictionary_keysym_t); 65 bool prop_dictionary_set_keysym(prop_dictionary_t, 66 prop_dictionary_keysym_t, 67 prop_object_t); 68 void prop_dictionary_remove_keysym(prop_dictionary_t, 69 prop_dictionary_keysym_t); 70 71 bool prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t); 72 73 char * prop_dictionary_externalize(prop_dictionary_t); 74 prop_dictionary_t prop_dictionary_internalize(const char *); 75 76 bool prop_dictionary_externalize_to_file(prop_dictionary_t, 77 const char *); 78 prop_dictionary_t prop_dictionary_internalize_from_file(const char *); 79 80 const char * prop_dictionary_keysym_value(prop_dictionary_keysym_t); 81 82 bool prop_dictionary_keysym_equals(prop_dictionary_keysym_t, 83 prop_dictionary_keysym_t); 84 85 #if defined(__NetBSD__) 86 struct plistref; 87 88 #if !defined(_KERNEL) && !defined(_STANDALONE) 89 bool prop_dictionary_externalize_to_pref(prop_dictionary_t, struct plistref *); 90 bool prop_dictionary_internalize_from_pref(const struct plistref *, 91 prop_dictionary_t *); 92 int prop_dictionary_send_ioctl(prop_dictionary_t, int, 93 unsigned long); 94 int prop_dictionary_recv_ioctl(int, unsigned long, 95 prop_dictionary_t *); 96 int prop_dictionary_sendrecv_ioctl(prop_dictionary_t, 97 int, unsigned long, 98 prop_dictionary_t *); 99 int prop_dictionary_send_syscall(prop_dictionary_t, 100 struct plistref *); 101 int prop_dictionary_recv_syscall(const struct plistref *, 102 prop_dictionary_t *); 103 #elif defined(_KERNEL) 104 int prop_dictionary_copyin(const struct plistref *, 105 prop_dictionary_t *); 106 int prop_dictionary_copyin_size(const struct plistref *, 107 prop_dictionary_t *, size_t); 108 int prop_dictionary_copyout(struct plistref *, 109 prop_dictionary_t); 110 int prop_dictionary_copyin_ioctl(const struct plistref *, 111 const u_long, 112 prop_dictionary_t *); 113 int prop_dictionary_copyin_ioctl_size(const struct plistref *, 114 const u_long, 115 prop_dictionary_t *, size_t); 116 int prop_dictionary_copyout_ioctl(struct plistref *, 117 const u_long, 118 prop_dictionary_t); 119 #endif 120 #endif /* __NetBSD__ */ 121 122 /* 123 * Utility routines to make it more convenient to work with values 124 * stored in dictionaries. 125 */ 126 bool prop_dictionary_get_dict(prop_dictionary_t, const char *, 127 prop_dictionary_t *); 128 129 bool prop_dictionary_get_bool(prop_dictionary_t, const char *, 130 bool *); 131 bool prop_dictionary_set_bool(prop_dictionary_t, const char *, 132 bool); 133 134 bool prop_dictionary_get_schar(prop_dictionary_t, const char *, 135 signed char *); 136 bool prop_dictionary_get_uchar(prop_dictionary_t, const char *, 137 unsigned char *); 138 bool prop_dictionary_set_schar(prop_dictionary_t, const char *, 139 signed char); 140 bool prop_dictionary_set_uchar(prop_dictionary_t, const char *, 141 unsigned char); 142 143 bool prop_dictionary_get_short(prop_dictionary_t, const char *, 144 short *); 145 bool prop_dictionary_get_ushort(prop_dictionary_t, const char *, 146 unsigned short *); 147 bool prop_dictionary_set_short(prop_dictionary_t, const char *, 148 short); 149 bool prop_dictionary_set_ushort(prop_dictionary_t, const char *, 150 unsigned short); 151 152 bool prop_dictionary_get_int(prop_dictionary_t, const char *, 153 int *); 154 bool prop_dictionary_get_uint(prop_dictionary_t, const char *, 155 unsigned int *); 156 bool prop_dictionary_set_int(prop_dictionary_t, const char *, 157 int); 158 bool prop_dictionary_set_uint(prop_dictionary_t, const char *, 159 unsigned int); 160 161 bool prop_dictionary_get_long(prop_dictionary_t, const char *, 162 long *); 163 bool prop_dictionary_get_ulong(prop_dictionary_t, const char *, 164 unsigned long *); 165 bool prop_dictionary_set_long(prop_dictionary_t, const char *, 166 long); 167 bool prop_dictionary_set_ulong(prop_dictionary_t, const char *, 168 unsigned long); 169 170 bool prop_dictionary_get_longlong(prop_dictionary_t, const char *, 171 long long *); 172 bool prop_dictionary_get_ulonglong(prop_dictionary_t, const char *, 173 unsigned long long *); 174 bool prop_dictionary_set_longlong(prop_dictionary_t, const char *, 175 long long); 176 bool prop_dictionary_set_ulonglong(prop_dictionary_t, const char *, 177 unsigned long long); 178 179 bool prop_dictionary_get_intptr(prop_dictionary_t, const char *, 180 intptr_t *); 181 bool prop_dictionary_get_uintptr(prop_dictionary_t, const char *, 182 uintptr_t *); 183 bool prop_dictionary_set_intptr(prop_dictionary_t, const char *, 184 intptr_t); 185 bool prop_dictionary_set_uintptr(prop_dictionary_t, const char *, 186 uintptr_t); 187 188 bool prop_dictionary_get_int8(prop_dictionary_t, const char *, 189 int8_t *); 190 bool prop_dictionary_get_uint8(prop_dictionary_t, const char *, 191 uint8_t *); 192 bool prop_dictionary_set_int8(prop_dictionary_t, const char *, 193 int8_t); 194 bool prop_dictionary_set_uint8(prop_dictionary_t, const char *, 195 uint8_t); 196 197 bool prop_dictionary_get_int16(prop_dictionary_t, const char *, 198 int16_t *); 199 bool prop_dictionary_get_uint16(prop_dictionary_t, const char *, 200 uint16_t *); 201 bool prop_dictionary_set_int16(prop_dictionary_t, const char *, 202 int16_t); 203 bool prop_dictionary_set_uint16(prop_dictionary_t, const char *, 204 uint16_t); 205 206 bool prop_dictionary_get_int32(prop_dictionary_t, const char *, 207 int32_t *); 208 bool prop_dictionary_get_uint32(prop_dictionary_t, const char *, 209 uint32_t *); 210 bool prop_dictionary_set_int32(prop_dictionary_t, const char *, 211 int32_t); 212 bool prop_dictionary_set_uint32(prop_dictionary_t, const char *, 213 uint32_t); 214 215 bool prop_dictionary_get_int64(prop_dictionary_t, const char *, 216 int64_t *); 217 bool prop_dictionary_get_uint64(prop_dictionary_t, const char *, 218 uint64_t *); 219 bool prop_dictionary_set_int64(prop_dictionary_t, const char *, 220 int64_t); 221 bool prop_dictionary_set_uint64(prop_dictionary_t, const char *, 222 uint64_t); 223 224 bool prop_dictionary_get_string(prop_dictionary_t, const char *, 225 const char **cpp); 226 bool prop_dictionary_set_string(prop_dictionary_t, const char *, 227 const char *); 228 bool prop_dictionary_set_string_nocopy(prop_dictionary_t, 229 const char *, const char *); 230 231 bool prop_dictionary_get_data(prop_dictionary_t, const char *, 232 const void **, size_t *); 233 bool prop_dictionary_set_data(prop_dictionary_t, const char *, 234 const void *, size_t); 235 bool prop_dictionary_set_data_nocopy(prop_dictionary_t, const char *, 236 const void *, size_t); 237 238 bool prop_dictionary_set_and_rel(prop_dictionary_t, 239 const char *, 240 prop_object_t); 241 242 243 /* Deprecated functions. */ 244 bool prop_dictionary_get_cstring(prop_dictionary_t, const char *, 245 char **); 246 bool prop_dictionary_set_cstring(prop_dictionary_t, const char *, 247 const char *); 248 249 bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t, 250 const char *, 251 const char **); 252 bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t, 253 const char *, 254 const char *); 255 256 const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t); 257 __END_DECLS 258 259 #endif /* _PROPLIB_PROP_DICTIONARY_H_ */ 260