prop_dictionary.h revision 1.7
1 /* $NetBSD: prop_dictionary.h,v 1.7 2007/08/16 16:28:17 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 2006 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 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #ifndef _PROPLIB_PROP_DICTIONARY_H_ 40 #define _PROPLIB_PROP_DICTIONARY_H_ 41 42 #include <prop/prop_object.h> 43 44 typedef struct _prop_dictionary *prop_dictionary_t; 45 typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t; 46 47 __BEGIN_DECLS 48 prop_dictionary_t prop_dictionary_create(void); 49 prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int); 50 51 prop_dictionary_t prop_dictionary_copy(prop_dictionary_t); 52 prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t); 53 54 unsigned int prop_dictionary_capacity(prop_dictionary_t); 55 unsigned int prop_dictionary_count(prop_dictionary_t); 56 bool prop_dictionary_ensure_capacity(prop_dictionary_t, 57 unsigned int); 58 59 void prop_dictionary_make_immutable(prop_dictionary_t); 60 bool prop_dictionary_mutable(prop_dictionary_t); 61 62 prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t); 63 prop_array_t prop_dictionary_all_keys(prop_dictionary_t); 64 65 prop_object_t prop_dictionary_get(prop_dictionary_t, const char *); 66 bool prop_dictionary_set(prop_dictionary_t, const char *, 67 prop_object_t); 68 void prop_dictionary_remove(prop_dictionary_t, const char *); 69 70 prop_object_t prop_dictionary_get_keysym(prop_dictionary_t, 71 prop_dictionary_keysym_t); 72 bool prop_dictionary_set_keysym(prop_dictionary_t, 73 prop_dictionary_keysym_t, 74 prop_object_t); 75 void prop_dictionary_remove_keysym(prop_dictionary_t, 76 prop_dictionary_keysym_t); 77 78 bool prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t); 79 80 char * prop_dictionary_externalize(prop_dictionary_t); 81 prop_dictionary_t prop_dictionary_internalize(const char *); 82 83 bool prop_dictionary_externalize_to_file(prop_dictionary_t, 84 const char *); 85 prop_dictionary_t prop_dictionary_internalize_from_file(const char *); 86 87 const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t); 88 89 bool prop_dictionary_keysym_equals(prop_dictionary_keysym_t, 90 prop_dictionary_keysym_t); 91 92 #if defined(__NetBSD__) 93 #if !defined(_KERNEL) && !defined(_STANDALONE) 94 int prop_dictionary_send_ioctl(prop_dictionary_t, int, 95 unsigned long); 96 int prop_dictionary_recv_ioctl(int, unsigned long, 97 prop_dictionary_t *); 98 int prop_dictionary_sendrecv_ioctl(prop_dictionary_t, 99 int, unsigned long, 100 prop_dictionary_t *); 101 #elif defined(_KERNEL) 102 struct plistref; 103 104 int prop_dictionary_copyin_ioctl(const struct plistref *, 105 const u_long, 106 prop_dictionary_t *); 107 int prop_dictionary_copyout_ioctl(struct plistref *, 108 const u_long, 109 prop_dictionary_t); 110 #endif 111 #endif /* __NetBSD__ */ 112 113 /* 114 * Utility routines to make it more convenient to work with values 115 * stored in dictionaries. 116 */ 117 bool prop_dictionary_get_bool(prop_dictionary_t, const char *, 118 bool *); 119 bool prop_dictionary_set_bool(prop_dictionary_t, const char *, 120 bool); 121 122 bool prop_dictionary_get_int8(prop_dictionary_t, const char *, 123 int8_t *); 124 bool prop_dictionary_get_uint8(prop_dictionary_t, const char *, 125 uint8_t *); 126 bool prop_dictionary_set_int8(prop_dictionary_t, const char *, 127 int8_t); 128 bool prop_dictionary_set_uint8(prop_dictionary_t, const char *, 129 uint8_t); 130 131 bool prop_dictionary_get_int16(prop_dictionary_t, const char *, 132 int16_t *); 133 bool prop_dictionary_get_uint16(prop_dictionary_t, const char *, 134 uint16_t *); 135 bool prop_dictionary_set_int16(prop_dictionary_t, const char *, 136 int16_t); 137 bool prop_dictionary_set_uint16(prop_dictionary_t, const char *, 138 uint16_t); 139 140 bool prop_dictionary_get_int32(prop_dictionary_t, const char *, 141 int32_t *); 142 bool prop_dictionary_get_uint32(prop_dictionary_t, const char *, 143 uint32_t *); 144 bool prop_dictionary_set_int32(prop_dictionary_t, const char *, 145 int32_t); 146 bool prop_dictionary_set_uint32(prop_dictionary_t, const char *, 147 uint32_t); 148 149 bool prop_dictionary_get_int64(prop_dictionary_t, const char *, 150 int64_t *); 151 bool prop_dictionary_get_uint64(prop_dictionary_t, const char *, 152 uint64_t *); 153 bool prop_dictionary_set_int64(prop_dictionary_t, const char *, 154 int64_t); 155 bool prop_dictionary_set_uint64(prop_dictionary_t, const char *, 156 uint64_t); 157 158 bool prop_dictionary_get_cstring(prop_dictionary_t, const char *, 159 char **); 160 bool prop_dictionary_set_cstring(prop_dictionary_t, const char *, 161 const char *); 162 163 bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t, 164 const char *, 165 const char **); 166 bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t, 167 const char *, 168 const char *); 169 170 __END_DECLS 171 172 #endif /* _PROPLIB_PROP_DICTIONARY_H_ */ 173
Indexes created Tue Sep 30 20:09:53 GMT 2025