include/prop_object.h

   1 /*      $NetBSD: prop_object.h,v 1.7 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_OBJECT_H_
  33 #define _PROPLIB_PROP_OBJECT_H_
  34
  35 #include <stdint.h>
  36 #include <stdbool.h>
  37
  38 typedef void *prop_object_t;
  39
  40 typedef enum {
  41         PROP_TYPE_UNKNOWN       =       0x00000000,
  42         PROP_TYPE_BOOL          =       0x626f6f6c,     /* 'bool' */
  43         PROP_TYPE_NUMBER        =       0x6e6d6272,     /* 'nmbr' */
  44         PROP_TYPE_STRING        =       0x73746e67,     /* 'stng' */
  45         PROP_TYPE_DATA          =       0x64617461,     /* 'data' */
  46         PROP_TYPE_ARRAY         =       0x61726179,     /* 'aray' */
  47         PROP_TYPE_DICTIONARY    =       0x64696374,     /* 'dict' */
  48         PROP_TYPE_DICT_KEYSYM   =       0x646b6579      /* 'dkey' */
  49 } prop_type_t;
  50
  51 __BEGIN_DECLS
  52 void            prop_object_retain(prop_object_t);
  53 void            prop_object_release(prop_object_t);
  54
  55 prop_type_t     prop_object_type(prop_object_t);
  56
  57 bool            prop_object_equals(prop_object_t, prop_object_t);
  58 bool            prop_object_equals_with_error(prop_object_t, prop_object_t, bool *);
  59
  60 typedef struct _prop_object_iterator *prop_object_iterator_t;
  61
  62 prop_object_t   prop_object_iterator_next(prop_object_iterator_t);
  63 void            prop_object_iterator_reset(prop_object_iterator_t);
  64 void            prop_object_iterator_release(prop_object_iterator_t);
  65 __END_DECLS
  66
  67 #endif /* _PROPLIB_PROP_OBJECT_H_ */