xref: /netbsd-src/common/include/prop/prop_array.h (revision cd22f25e6f6d1cc1f197fe8c5468a80f51d1c4e1)
1 /*	$NetBSD: prop_array.h,v 1.6 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_ARRAY_H_
33 #define	_PROPLIB_PROP_ARRAY_H_
34 
35 #include <prop/prop_object.h>
36 
37 typedef struct _prop_array *prop_array_t;
38 
39 __BEGIN_DECLS
40 prop_array_t	prop_array_create(void);
41 prop_array_t	prop_array_create_with_capacity(unsigned int);
42 
43 prop_array_t	prop_array_copy(prop_array_t);
44 prop_array_t	prop_array_copy_mutable(prop_array_t);
45 
46 unsigned int	prop_array_capacity(prop_array_t);
47 unsigned int	prop_array_count(prop_array_t);
48 bool		prop_array_ensure_capacity(prop_array_t, unsigned int);
49 
50 void		prop_array_make_immutable(prop_array_t);
51 bool		prop_array_mutable(prop_array_t);
52 
53 prop_object_iterator_t prop_array_iterator(prop_array_t);
54 
55 prop_object_t	prop_array_get(prop_array_t, unsigned int);
56 bool		prop_array_set(prop_array_t, unsigned int, prop_object_t);
57 bool		prop_array_add(prop_array_t, prop_object_t);
58 void		prop_array_remove(prop_array_t, unsigned int);
59 
60 bool		prop_array_equals(prop_array_t, prop_array_t);
61 
62 char *		prop_array_externalize(prop_array_t);
63 prop_array_t	prop_array_internalize(const char *);
64 
65 bool		prop_array_externalize_to_file(prop_array_t, const char *);
66 prop_array_t	prop_array_internalize_from_file(const char *);
67 
68 #if defined(__NetBSD__)
69 #if !defined(_KERNEL) && !defined(_STANDALONE)
70 int		prop_array_send_ioctl(prop_array_t, int, unsigned long);
71 int		prop_array_recv_ioctl(int, unsigned long, prop_array_t *);
72 #elif defined(_KERNEL)
73 struct plistref;
74 
75 int		prop_array_copyin_ioctl(const struct plistref *, const u_long,
76 					prop_array_t *);
77 int		prop_array_copyout_ioctl(struct plistref *, const u_long,
78 					 prop_array_t);
79 #endif
80 #endif /* __NetBSD__ */
81 
82 __END_DECLS
83 
84 #endif /* _PROPLIB_PROP_ARRAY_H_ */
85