include/prop_dictionary.h

   1 /*      $NetBSD: prop_dictionary.h,v 1.9 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_DICTIONARY_H_
  33 #define _PROPLIB_PROP_DICTIONARY_H_
  34
  35 #include <stdint.h>
  36 #include <prop/prop_object.h>
  37 #include <prop/prop_array.h>
  38
  39 typedef struct _prop_dictionary *prop_dictionary_t;
  40 typedef struct _prop_dictionary_keysym *prop_dictionary_keysym_t;
  41
  42 __BEGIN_DECLS
  43 prop_dictionary_t prop_dictionary_create(void);
  44 prop_dictionary_t prop_dictionary_create_with_capacity(unsigned int);
  45
  46 prop_dictionary_t prop_dictionary_copy(prop_dictionary_t);
  47 prop_dictionary_t prop_dictionary_copy_mutable(prop_dictionary_t);
  48
  49 unsigned int    prop_dictionary_count(prop_dictionary_t);
  50 bool            prop_dictionary_ensure_capacity(prop_dictionary_t,
  51                                                 unsigned int);
  52
  53 void            prop_dictionary_make_immutable(prop_dictionary_t);
  54 bool            prop_dictionary_mutable(prop_dictionary_t);
  55
  56 prop_object_iterator_t prop_dictionary_iterator(prop_dictionary_t);
  57 prop_array_t    prop_dictionary_all_keys(prop_dictionary_t);
  58
  59 prop_object_t   prop_dictionary_get(prop_dictionary_t, const char *);
  60 bool            prop_dictionary_set(prop_dictionary_t, const char *,
  61                                     prop_object_t);
  62 void            prop_dictionary_remove(prop_dictionary_t, const char *);
  63
  64 prop_object_t   prop_dictionary_get_keysym(prop_dictionary_t,
  65                                            prop_dictionary_keysym_t);
  66 bool            prop_dictionary_set_keysym(prop_dictionary_t,
  67                                            prop_dictionary_keysym_t,
  68                                            prop_object_t);
  69 void            prop_dictionary_remove_keysym(prop_dictionary_t,
  70                                               prop_dictionary_keysym_t);
  71
  72 bool            prop_dictionary_equals(prop_dictionary_t, prop_dictionary_t);
  73
  74 char *          prop_dictionary_externalize(prop_dictionary_t);
  75 prop_dictionary_t prop_dictionary_internalize(const char *);
  76
  77 bool            prop_dictionary_externalize_to_file(prop_dictionary_t,
  78                                                     const char *);
  79 prop_dictionary_t prop_dictionary_internalize_from_file(const char *);
  80
  81 const char *    prop_dictionary_keysym_cstring_nocopy(prop_dictionary_keysym_t);
  82
  83 bool            prop_dictionary_keysym_equals(prop_dictionary_keysym_t,
  84                                               prop_dictionary_keysym_t);
  85
  86 /*
  87  * Utility routines to make it more convenient to work with values
  88  * stored in dictionaries.
  89  */
  90 bool            prop_dictionary_get_bool(prop_dictionary_t, const char *,
  91                                          bool *);
  92 bool            prop_dictionary_set_bool(prop_dictionary_t, const char *,
  93                                          bool);
  94
  95 bool            prop_dictionary_get_int8(prop_dictionary_t, const char *,
  96                                          int8_t *);
  97 bool            prop_dictionary_get_uint8(prop_dictionary_t, const char *,
  98                                           uint8_t *);
  99 bool            prop_dictionary_set_int8(prop_dictionary_t, const char *,
 100                                          int8_t);
 101 bool            prop_dictionary_set_uint8(prop_dictionary_t, const char *,
 102                                           uint8_t);
 103
 104 bool            prop_dictionary_get_int16(prop_dictionary_t, const char *,
 105                                           int16_t *);
 106 bool            prop_dictionary_get_uint16(prop_dictionary_t, const char *,
 107                                            uint16_t *);
 108 bool            prop_dictionary_set_int16(prop_dictionary_t, const char *,
 109                                           int16_t);
 110 bool            prop_dictionary_set_uint16(prop_dictionary_t, const char *,
 111                                            uint16_t);
 112
 113 bool            prop_dictionary_get_int32(prop_dictionary_t, const char *,
 114                                           int32_t *);
 115 bool            prop_dictionary_get_uint32(prop_dictionary_t, const char *,
 116                                            uint32_t *);
 117 bool            prop_dictionary_set_int32(prop_dictionary_t, const char *,
 118                                           int32_t);
 119 bool            prop_dictionary_set_uint32(prop_dictionary_t, const char *,
 120                                            uint32_t);
 121
 122 bool            prop_dictionary_get_int64(prop_dictionary_t, const char *,
 123                                           int64_t *);
 124 bool            prop_dictionary_get_uint64(prop_dictionary_t, const char *,
 125                                            uint64_t *);
 126 bool            prop_dictionary_set_int64(prop_dictionary_t, const char *,
 127                                           int64_t);
 128 bool            prop_dictionary_set_uint64(prop_dictionary_t, const char *,
 129                                            uint64_t);
 130
 131 bool            prop_dictionary_get_cstring(prop_dictionary_t, const char *,
 132                                              char **);
 133 bool            prop_dictionary_set_cstring(prop_dictionary_t, const char *,
 134                                             const char *);
 135
 136 bool            prop_dictionary_get_cstring_nocopy(prop_dictionary_t,
 137                                                    const char *,
 138                                                    const char **);
 139 bool            prop_dictionary_set_cstring_nocopy(prop_dictionary_t,
 140                                                    const char *,
 141                                                    const char *);
 142
 143 __END_DECLS
 144
 145 #endif /* _PROPLIB_PROP_DICTIONARY_H_ */