1 /* $NetBSD: prop_dictionary.h,v 1.15 2016/01/22 23:03:46 dholland Exp $ */ 2 3 /*- 4 * Copyright (c) 2006, 2009 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_cstring_nocopy(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_copyout(struct plistref *, 107 prop_dictionary_t); 108 int prop_dictionary_copyin_ioctl(const struct plistref *, 109 const u_long, 110 prop_dictionary_t *); 111 int prop_dictionary_copyout_ioctl(struct plistref *, 112 const u_long, 113 prop_dictionary_t); 114 #endif 115 #endif /* __NetBSD__ */ 116 117 /* 118 * Utility routines to make it more convenient to work with values 119 * stored in dictionaries. 120 */ 121 bool prop_dictionary_get_dict(prop_dictionary_t, const char *, 122 prop_dictionary_t *); 123 bool prop_dictionary_get_bool(prop_dictionary_t, const char *, 124 bool *); 125 bool prop_dictionary_set_bool(prop_dictionary_t, const char *, 126 bool); 127 128 bool prop_dictionary_get_int8(prop_dictionary_t, const char *, 129 int8_t *); 130 bool prop_dictionary_get_uint8(prop_dictionary_t, const char *, 131 uint8_t *); 132 bool prop_dictionary_set_int8(prop_dictionary_t, const char *, 133 int8_t); 134 bool prop_dictionary_set_uint8(prop_dictionary_t, const char *, 135 uint8_t); 136 137 bool prop_dictionary_get_int16(prop_dictionary_t, const char *, 138 int16_t *); 139 bool prop_dictionary_get_uint16(prop_dictionary_t, const char *, 140 uint16_t *); 141 bool prop_dictionary_set_int16(prop_dictionary_t, const char *, 142 int16_t); 143 bool prop_dictionary_set_uint16(prop_dictionary_t, const char *, 144 uint16_t); 145 146 bool prop_dictionary_get_int32(prop_dictionary_t, const char *, 147 int32_t *); 148 bool prop_dictionary_get_uint32(prop_dictionary_t, const char *, 149 uint32_t *); 150 bool prop_dictionary_set_int32(prop_dictionary_t, const char *, 151 int32_t); 152 bool prop_dictionary_set_uint32(prop_dictionary_t, const char *, 153 uint32_t); 154 155 bool prop_dictionary_get_int64(prop_dictionary_t, const char *, 156 int64_t *); 157 bool prop_dictionary_get_uint64(prop_dictionary_t, const char *, 158 uint64_t *); 159 bool prop_dictionary_set_int64(prop_dictionary_t, const char *, 160 int64_t); 161 bool prop_dictionary_set_uint64(prop_dictionary_t, const char *, 162 uint64_t); 163 164 bool prop_dictionary_get_cstring(prop_dictionary_t, const char *, 165 char **); 166 bool prop_dictionary_set_cstring(prop_dictionary_t, const char *, 167 const char *); 168 169 bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t, 170 const char *, 171 const char **); 172 bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t, 173 const char *, 174 const char *); 175 176 bool prop_dictionary_set_and_rel(prop_dictionary_t, 177 const char *, 178 prop_object_t); 179 180 __END_DECLS 181 182 #endif /* _PROPLIB_PROP_DICTIONARY_H_ */ 183