xref: /netbsd-src/common/include/prop/prop_object.h (revision 58a45c6ffee639514e74650f99c60f4e590a99e0)
1*58a45c6fSad /*	$NetBSD: prop_object.h,v 1.8 2008/12/05 13:11:41 ad Exp $	*/
2774eb1a3Sthorpej 
3774eb1a3Sthorpej /*-
4774eb1a3Sthorpej  * Copyright (c) 2006 The NetBSD Foundation, Inc.
5774eb1a3Sthorpej  * All rights reserved.
6774eb1a3Sthorpej  *
7774eb1a3Sthorpej  * This code is derived from software contributed to The NetBSD Foundation
8774eb1a3Sthorpej  * by Jason R. Thorpe.
9774eb1a3Sthorpej  *
10774eb1a3Sthorpej  * Redistribution and use in source and binary forms, with or without
11774eb1a3Sthorpej  * modification, are permitted provided that the following conditions
12774eb1a3Sthorpej  * are met:
13774eb1a3Sthorpej  * 1. Redistributions of source code must retain the above copyright
14774eb1a3Sthorpej  *    notice, this list of conditions and the following disclaimer.
15774eb1a3Sthorpej  * 2. Redistributions in binary form must reproduce the above copyright
16774eb1a3Sthorpej  *    notice, this list of conditions and the following disclaimer in the
17774eb1a3Sthorpej  *    documentation and/or other materials provided with the distribution.
18774eb1a3Sthorpej  *
19774eb1a3Sthorpej  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20774eb1a3Sthorpej  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21774eb1a3Sthorpej  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22774eb1a3Sthorpej  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23774eb1a3Sthorpej  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24774eb1a3Sthorpej  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25774eb1a3Sthorpej  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26774eb1a3Sthorpej  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27774eb1a3Sthorpej  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28774eb1a3Sthorpej  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29774eb1a3Sthorpej  * POSSIBILITY OF SUCH DAMAGE.
30774eb1a3Sthorpej  */
31774eb1a3Sthorpej 
32774eb1a3Sthorpej #ifndef _PROPLIB_PROP_OBJECT_H_
33774eb1a3Sthorpej #define	_PROPLIB_PROP_OBJECT_H_
34774eb1a3Sthorpej 
35774eb1a3Sthorpej #include <sys/types.h>
36774eb1a3Sthorpej 
376bbc4281She #if !defined(_KERNEL) && !defined(_STANDALONE)
3804377267Sthorpej #include <stdbool.h>
396bbc4281She #endif /* ! _KERNEL && ! _STANDALONE */
40774eb1a3Sthorpej 
41774eb1a3Sthorpej typedef void *prop_object_t;
42774eb1a3Sthorpej 
43774eb1a3Sthorpej typedef enum {
44d21620b2Sthorpej 	PROP_TYPE_UNKNOWN	=	0x00000000,
45*58a45c6fSad #ifndef _PROPLIB_ZFS_CONFLICT
46774eb1a3Sthorpej 	PROP_TYPE_BOOL		=	0x626f6f6c,	/* 'bool' */
47774eb1a3Sthorpej 	PROP_TYPE_NUMBER	=	0x6e6d6272,	/* 'nmbr' */
48774eb1a3Sthorpej 	PROP_TYPE_STRING	=	0x73746e67,	/* 'stng' */
49774eb1a3Sthorpej 	PROP_TYPE_DATA		=	0x64617461,	/* 'data' */
50774eb1a3Sthorpej 	PROP_TYPE_ARRAY		=	0x61726179,	/* 'aray' */
51774eb1a3Sthorpej 	PROP_TYPE_DICTIONARY	=	0x64696374,	/* 'dict' */
52774eb1a3Sthorpej 	PROP_TYPE_DICT_KEYSYM	=	0x646b6579	/* 'dkey' */
53*58a45c6fSad #endif	/* !_PROPLIB_ZFS_CONFLICT */
54774eb1a3Sthorpej } prop_type_t;
55774eb1a3Sthorpej 
56774eb1a3Sthorpej __BEGIN_DECLS
57774eb1a3Sthorpej void		prop_object_retain(prop_object_t);
58774eb1a3Sthorpej void		prop_object_release(prop_object_t);
59774eb1a3Sthorpej 
60774eb1a3Sthorpej prop_type_t	prop_object_type(prop_object_t);
61774eb1a3Sthorpej 
6204377267Sthorpej bool		prop_object_equals(prop_object_t, prop_object_t);
634deb5931Sjoerg bool		prop_object_equals_with_error(prop_object_t, prop_object_t, bool *);
643e69f1b2Sthorpej 
65774eb1a3Sthorpej typedef struct _prop_object_iterator *prop_object_iterator_t;
66774eb1a3Sthorpej 
67774eb1a3Sthorpej prop_object_t	prop_object_iterator_next(prop_object_iterator_t);
68774eb1a3Sthorpej void		prop_object_iterator_reset(prop_object_iterator_t);
69774eb1a3Sthorpej void		prop_object_iterator_release(prop_object_iterator_t);
70774eb1a3Sthorpej __END_DECLS
71774eb1a3Sthorpej 
72774eb1a3Sthorpej #endif /* _PROPLIB_PROP_OBJECT_H_ */
73