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