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