prop_dictionary.h revision 1.12
1/* $NetBSD: prop_dictionary.h,v 1.12 2011/01/20 11:17:58 bouyer 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 37typedef struct _prop_dictionary *prop_dictionary_t; 38typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t; 39 40__BEGIN_DECLS 41prop_dictionary_t prop_dictionary_create(void); 42prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int); 43 44prop_dictionary_t prop_dictionary_copy(prop_dictionary_t); 45prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t); 46 47unsigned int prop_dictionary_count(prop_dictionary_t); 48bool prop_dictionary_ensure_capacity(prop_dictionary_t, 49 unsigned int); 50 51void prop_dictionary_make_immutable(prop_dictionary_t); 52bool prop_dictionary_mutable(prop_dictionary_t); 53 54prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t); 55prop_array_t prop_dictionary_all_keys(prop_dictionary_t); 56 57prop_object_t prop_dictionary_get(prop_dictionary_t, const char *); 58bool prop_dictionary_set(prop_dictionary_t, const char *, 59 prop_object_t); 60void prop_dictionary_remove(prop_dictionary_t, const char *); 61 62prop_object_t prop_dictionary_get_keysym(prop_dictionary_t, 63 prop_dictionary_keysym_t); 64bool prop_dictionary_set_keysym(prop_dictionary_t, 65 prop_dictionary_keysym_t, 66 prop_object_t); 67void prop_dictionary_remove_keysym(prop_dictionary_t, 68 prop_dictionary_keysym_t); 69 70bool prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t); 71 72char * prop_dictionary_externalize(prop_dictionary_t); 73prop_dictionary_t prop_dictionary_internalize(const char *); 74 75bool prop_dictionary_externalize_to_file(prop_dictionary_t, 76 const char *); 77prop_dictionary_t prop_dictionary_internalize_from_file(const char *); 78 79const char * prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t); 80 81bool prop_dictionary_keysym_equals(prop_dictionary_keysym_t, 82 prop_dictionary_keysym_t); 83 84#if defined(__NetBSD__) 85struct plistref; 86 87#if !defined(_KERNEL) && !defined(_STANDALONE) 88bool prop_dictionary_externalize_to_pref(prop_dictionary_t, struct plistref *); 89int prop_dictionary_send_ioctl(prop_dictionary_t, int, 90 unsigned long); 91int prop_dictionary_recv_ioctl(int, unsigned long, 92 prop_dictionary_t *); 93int prop_dictionary_sendrecv_ioctl(prop_dictionary_t, 94 int, unsigned long, 95 prop_dictionary_t *); 96bool prop_dictionary_send_syscall(prop_dictionary_t, 97 struct plistref *); 98bool prop_dictionary_recv_syscall(const struct plistref *, 99 prop_dictionary_t *); 100#elif defined(_KERNEL) 101int prop_dictionary_copyin(const struct plistref *, 102 prop_dictionary_t *); 103int prop_dictionary_copyout(struct plistref *, 104 prop_dictionary_t); 105int prop_dictionary_copyin_ioctl(const struct plistref *, 106 const u_long, 107 prop_dictionary_t *); 108int prop_dictionary_copyout_ioctl(struct plistref *, 109 const u_long, 110 prop_dictionary_t); 111#endif 112#endif /* __NetBSD__ */ 113 114/* 115 * Utility routines to make it more convenient to work with values 116 * stored in dictionaries. 117 */ 118bool prop_dictionary_get_bool(prop_dictionary_t, const char *, 119 bool *); 120bool prop_dictionary_set_bool(prop_dictionary_t, const char *, 121 bool); 122 123bool prop_dictionary_get_int8(prop_dictionary_t, const char *, 124 int8_t *); 125bool prop_dictionary_get_uint8(prop_dictionary_t, const char *, 126 uint8_t *); 127bool prop_dictionary_set_int8(prop_dictionary_t, const char *, 128 int8_t); 129bool prop_dictionary_set_uint8(prop_dictionary_t, const char *, 130 uint8_t); 131 132bool prop_dictionary_get_int16(prop_dictionary_t, const char *, 133 int16_t *); 134bool prop_dictionary_get_uint16(prop_dictionary_t, const char *, 135 uint16_t *); 136bool prop_dictionary_set_int16(prop_dictionary_t, const char *, 137 int16_t); 138bool prop_dictionary_set_uint16(prop_dictionary_t, const char *, 139 uint16_t); 140 141bool prop_dictionary_get_int32(prop_dictionary_t, const char *, 142 int32_t *); 143bool prop_dictionary_get_uint32(prop_dictionary_t, const char *, 144 uint32_t *); 145bool prop_dictionary_set_int32(prop_dictionary_t, const char *, 146 int32_t); 147bool prop_dictionary_set_uint32(prop_dictionary_t, const char *, 148 uint32_t); 149 150bool prop_dictionary_get_int64(prop_dictionary_t, const char *, 151 int64_t *); 152bool prop_dictionary_get_uint64(prop_dictionary_t, const char *, 153 uint64_t *); 154bool prop_dictionary_set_int64(prop_dictionary_t, const char *, 155 int64_t); 156bool prop_dictionary_set_uint64(prop_dictionary_t, const char *, 157 uint64_t); 158 159bool prop_dictionary_get_cstring(prop_dictionary_t, const char *, 160 char **); 161bool prop_dictionary_set_cstring(prop_dictionary_t, const char *, 162 const char *); 163 164bool prop_dictionary_get_cstring_nocopy(prop_dictionary_t, 165 const char *, 166 const char **); 167bool prop_dictionary_set_cstring_nocopy(prop_dictionary_t, 168 const char *, 169 const char *); 170 171__END_DECLS 172 173#endif /* _PROPLIB_PROP_DICTIONARY_H_ */ 174