prop_dictionary.h revision 1.10 
1/*	$NetBSD: prop_dictionary.h,v 1.10 2009/10/10 21:26:16 bad 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 *);
96#elif defined(_KERNEL)
97int		prop_dictionary_copyin(const struct plistref *,
98				       prop_dictionary_t *);
99int		prop_dictionary_copyin_ioctl(const struct plistref *,
100					     const u_long,
101					     prop_dictionary_t *);
102int		prop_dictionary_copyout_ioctl(struct plistref *,
103					      const u_long,
104					      prop_dictionary_t);
105#endif
106#endif /* __NetBSD__ */
107
108/*
109 * Utility routines to make it more convenient to work with values
110 * stored in dictionaries.
111 */
112bool		prop_dictionary_get_bool(prop_dictionary_t, const char *,
113					 bool *);
114bool		prop_dictionary_set_bool(prop_dictionary_t, const char *,
115					 bool);
116
117bool		prop_dictionary_get_int8(prop_dictionary_t, const char *,
118					 int8_t *);
119bool		prop_dictionary_get_uint8(prop_dictionary_t, const char *,
120					  uint8_t *);
121bool		prop_dictionary_set_int8(prop_dictionary_t, const char *,
122					 int8_t);
123bool		prop_dictionary_set_uint8(prop_dictionary_t, const char *,
124					  uint8_t);
125
126bool		prop_dictionary_get_int16(prop_dictionary_t, const char *,
127					  int16_t *);
128bool		prop_dictionary_get_uint16(prop_dictionary_t, const char *,
129					   uint16_t *);
130bool		prop_dictionary_set_int16(prop_dictionary_t, const char *,
131					  int16_t);
132bool		prop_dictionary_set_uint16(prop_dictionary_t, const char *,
133					   uint16_t);
134
135bool		prop_dictionary_get_int32(prop_dictionary_t, const char *,
136					  int32_t *);
137bool		prop_dictionary_get_uint32(prop_dictionary_t, const char *,
138					   uint32_t *);
139bool		prop_dictionary_set_int32(prop_dictionary_t, const char *,
140					  int32_t);
141bool		prop_dictionary_set_uint32(prop_dictionary_t, const char *,
142					   uint32_t);
143
144bool		prop_dictionary_get_int64(prop_dictionary_t, const char *,
145					  int64_t *);
146bool		prop_dictionary_get_uint64(prop_dictionary_t, const char *,
147					   uint64_t *);
148bool		prop_dictionary_set_int64(prop_dictionary_t, const char *,
149					  int64_t);
150bool		prop_dictionary_set_uint64(prop_dictionary_t, const char *,
151					   uint64_t);
152
153bool		prop_dictionary_get_cstring(prop_dictionary_t, const char *,
154					     char **);
155bool		prop_dictionary_set_cstring(prop_dictionary_t, const char *,
156					    const char *);
157
158bool		prop_dictionary_get_cstring_nocopy(prop_dictionary_t,
159						   const char *,
160						   const char **);
161bool		prop_dictionary_set_cstring_nocopy(prop_dictionary_t,
162						   const char *,
163						   const char *);
164
165__END_DECLS
166
167#endif /* _PROPLIB_PROP_DICTIONARY_H_ */
168