xref: /netbsd-src/common/include/prop/prop_object.h (revision fad4c9f71477ae11cea2ee75ec82151ac770a534)
1 /*	$NetBSD: prop_object.h,v 1.3 2006/05/18 03:05:19 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_OBJECT_H_
40 #define	_PROPLIB_PROP_OBJECT_H_
41 
42 #include <sys/types.h>
43 
44 #if !defined(_KERNEL) && !defined(_STANDALONE)
45 
46 typedef	int	boolean_t;
47 #undef TRUE
48 #define	TRUE	1
49 #undef FALSE
50 #define	FALSE	0
51 
52 #endif /* ! _KERNEL && ! _STANDALONE */
53 
54 typedef void *prop_object_t;
55 
56 typedef enum {
57 	PROP_TYPE_BOOL		=	0x626f6f6c,	/* 'bool' */
58 	PROP_TYPE_NUMBER	=	0x6e6d6272,	/* 'nmbr' */
59 	PROP_TYPE_STRING	=	0x73746e67,	/* 'stng' */
60 	PROP_TYPE_DATA		=	0x64617461,	/* 'data' */
61 	PROP_TYPE_ARRAY		=	0x61726179,	/* 'aray' */
62 	PROP_TYPE_DICTIONARY	=	0x64696374,	/* 'dict' */
63 	PROP_TYPE_DICT_KEYSYM	=	0x646b6579	/* 'dkey' */
64 } prop_type_t;
65 
66 __BEGIN_DECLS
67 void		prop_object_retain(prop_object_t);
68 void		prop_object_release(prop_object_t);
69 
70 prop_type_t	prop_object_type(prop_object_t);
71 
72 boolean_t	prop_object_equals(prop_object_t, prop_object_t);
73 
74 typedef struct _prop_object_iterator *prop_object_iterator_t;
75 
76 prop_object_t	prop_object_iterator_next(prop_object_iterator_t);
77 void		prop_object_iterator_reset(prop_object_iterator_t);
78 void		prop_object_iterator_release(prop_object_iterator_t);
79 __END_DECLS
80 
81 #endif /* _PROPLIB_PROP_OBJECT_H_ */
82