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