prop_dictionary.h revision 1.9 
1/*	$NetBSD: prop_dictionary.h,v 1.9 2008/04/28 20:22:51 martin 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 *
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__)
85#if !defined(_KERNEL) && !defined(_STANDALONE)
86int		prop_dictionary_send_ioctl(prop_dictionary_t, int,
87					   unsigned long);
88int		prop_dictionary_recv_ioctl(int, unsigned long,
89					   prop_dictionary_t *);
90int		prop_dictionary_sendrecv_ioctl(prop_dictionary_t,
91					       int, unsigned long,
92					       prop_dictionary_t *);
93#elif defined(_KERNEL)
94struct plistref;
95
96int		prop_dictionary_copyin_ioctl(const struct plistref *,
97					     const u_long,
98					     prop_dictionary_t *);
99int		prop_dictionary_copyout_ioctl(struct plistref *,
100					      const u_long,
101					      prop_dictionary_t);
102#endif
103#endif /* __NetBSD__ */
104
105/*
106 * Utility routines to make it more convenient to work with values
107 * stored in dictionaries.
108 */
109bool		prop_dictionary_get_bool(prop_dictionary_t, const char *,
110					 bool *);
111bool		prop_dictionary_set_bool(prop_dictionary_t, const char *,
112					 bool);
113
114bool		prop_dictionary_get_int8(prop_dictionary_t, const char *,
115					 int8_t *);
116bool		prop_dictionary_get_uint8(prop_dictionary_t, const char *,
117					  uint8_t *);
118bool		prop_dictionary_set_int8(prop_dictionary_t, const char *,
119					 int8_t);
120bool		prop_dictionary_set_uint8(prop_dictionary_t, const char *,
121					  uint8_t);
122
123bool		prop_dictionary_get_int16(prop_dictionary_t, const char *,
124					  int16_t *);
125bool		prop_dictionary_get_uint16(prop_dictionary_t, const char *,
126					   uint16_t *);
127bool		prop_dictionary_set_int16(prop_dictionary_t, const char *,
128					  int16_t);
129bool		prop_dictionary_set_uint16(prop_dictionary_t, const char *,
130					   uint16_t);
131
132bool		prop_dictionary_get_int32(prop_dictionary_t, const char *,
133					  int32_t *);
134bool		prop_dictionary_get_uint32(prop_dictionary_t, const char *,
135					   uint32_t *);
136bool		prop_dictionary_set_int32(prop_dictionary_t, const char *,
137					  int32_t);
138bool		prop_dictionary_set_uint32(prop_dictionary_t, const char *,
139					   uint32_t);
140
141bool		prop_dictionary_get_int64(prop_dictionary_t, const char *,
142					  int64_t *);
143bool		prop_dictionary_get_uint64(prop_dictionary_t, const char *,
144					   uint64_t *);
145bool		prop_dictionary_set_int64(prop_dictionary_t, const char *,
146					  int64_t);
147bool		prop_dictionary_set_uint64(prop_dictionary_t, const char *,
148					   uint64_t);
149
150bool		prop_dictionary_get_cstring(prop_dictionary_t, const char *,
151					     char **);
152bool		prop_dictionary_set_cstring(prop_dictionary_t, const char *,
153					    const char *);
154
155bool		prop_dictionary_get_cstring_nocopy(prop_dictionary_t,
156						   const char *,
157						   const char **);
158bool		prop_dictionary_set_cstring_nocopy(prop_dictionary_t,
159						   const char *,
160						   const char *);
161
162__END_DECLS
163
164#endif /* _PROPLIB_PROP_DICTIONARY_H_ */
165