src/prop_object_impl.h

   1 /*      $NetBSD: prop_object_impl.h,v 1.27 2008/08/03 04:00:12 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  *
  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_IMPL_H_
  33 #define _PROPLIB_PROP_OBJECT_IMPL_H_
  34
  35 #include <inttypes.h>
  36
  37 #include "prop_stack.h"
  38
  39 struct _prop_object_externalize_context {
  40         char *          poec_buf;               /* string buffer */
  41         size_t          poec_capacity;          /* capacity of buffer */
  42         size_t          poec_len;               /* current length of string */
  43         unsigned int    poec_depth;             /* nesting depth */
  44 };
  45
  46 bool            _prop_object_externalize_start_tag(
  47                                 struct _prop_object_externalize_context *,
  48                                 const char *);
  49 bool            _prop_object_externalize_end_tag(
  50                                 struct _prop_object_externalize_context *,
  51                                 const char *);
  52 bool            _prop_object_externalize_empty_tag(
  53                                 struct _prop_object_externalize_context *,
  54                                 const char *);
  55 bool            _prop_object_externalize_append_cstring(
  56                                 struct _prop_object_externalize_context *,
  57                                 const char *);
  58 bool            _prop_object_externalize_append_encoded_cstring(
  59                                 struct _prop_object_externalize_context *,
  60                                 const char *);
  61 bool            _prop_object_externalize_append_char(
  62                                 struct _prop_object_externalize_context *,
  63                                 unsigned char);
  64 bool            _prop_object_externalize_header(
  65                                 struct _prop_object_externalize_context *);
  66 bool            _prop_object_externalize_footer(
  67                                 struct _prop_object_externalize_context *);
  68
  69 struct _prop_object_externalize_context *
  70         _prop_object_externalize_context_alloc(void);
  71 void    _prop_object_externalize_context_free(
  72                                 struct _prop_object_externalize_context *);
  73
  74 typedef enum {
  75         _PROP_TAG_TYPE_START,                   /* e.g. <dict> */
  76         _PROP_TAG_TYPE_END,                     /* e.g. </dict> */
  77         _PROP_TAG_TYPE_EITHER
  78 } _prop_tag_type_t;
  79
  80 struct _prop_object_internalize_context {
  81         const char *poic_xml;
  82         const char *poic_cp;
  83
  84         const char *poic_tag_start;
  85
  86         const char *poic_tagname;
  87         size_t      poic_tagname_len;
  88         const char *poic_tagattr;
  89         size_t      poic_tagattr_len;
  90         const char *poic_tagattrval;
  91         size_t      poic_tagattrval_len;
  92
  93         bool   poic_is_empty_element;
  94         _prop_tag_type_t poic_tag_type;
  95 };
  96
  97 typedef enum {
  98         _PROP_OBJECT_FREE_DONE,
  99         _PROP_OBJECT_FREE_RECURSE,
 100         _PROP_OBJECT_FREE_FAILED
 101 } _prop_object_free_rv_t;
 102
 103 typedef enum {
 104         _PROP_OBJECT_EQUALS_FALSE,
 105         _PROP_OBJECT_EQUALS_TRUE,
 106         _PROP_OBJECT_EQUALS_RECURSE
 107 } _prop_object_equals_rv_t;
 108
 109 #define _PROP_EOF(c)            ((c) == '\0')
 110 #define _PROP_ISSPACE(c)        \
 111         ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r' || \
 112          _PROP_EOF(c))
 113
 114 #define _PROP_TAG_MATCH(ctx, t)                                 \
 115         _prop_object_internalize_match((ctx)->poic_tagname,     \
 116                                        (ctx)->poic_tagname_len, \
 117                                        (t), strlen(t))
 118
 119 #define _PROP_TAGATTR_MATCH(ctx, a)                             \
 120         _prop_object_internalize_match((ctx)->poic_tagattr,     \
 121                                        (ctx)->poic_tagattr_len, \
 122                                        (a), strlen(a))
 123
 124 #define _PROP_TAGATTRVAL_MATCH(ctx, a)                            \
 125         _prop_object_internalize_match((ctx)->poic_tagattrval,    \
 126                                        (ctx)->poic_tagattrval_len,\
 127                                        (a), strlen(a))
 128
 129 bool            _prop_object_internalize_find_tag(
 130                                 struct _prop_object_internalize_context *,
 131                                 const char *, _prop_tag_type_t);
 132 bool            _prop_object_internalize_match(const char *, size_t,
 133                                                const char *, size_t);
 134 prop_object_t   _prop_object_internalize_by_tag(
 135                                 struct _prop_object_internalize_context *);
 136 bool            _prop_object_internalize_decode_string(
 137                                 struct _prop_object_internalize_context *,
 138                                 char *, size_t, size_t *, const char **);
 139 prop_object_t   _prop_generic_internalize(const char *, const char *);
 140
 141 struct _prop_object_internalize_context *
 142                 _prop_object_internalize_context_alloc(const char *);
 143 void            _prop_object_internalize_context_free(
 144                                 struct _prop_object_internalize_context *);
 145
 146 bool            _prop_object_externalize_write_file(const char *,
 147                                                     const char *, size_t);
 148
 149 struct _prop_object_internalize_mapped_file {
 150         char *  poimf_xml;
 151         size_t  poimf_mapsize;
 152 };
 153
 154 struct _prop_object_internalize_mapped_file *
 155                 _prop_object_internalize_map_file(const char *);
 156 void            _prop_object_internalize_unmap_file(
 157                                 struct _prop_object_internalize_mapped_file *);
 158
 159 typedef bool (*prop_object_internalizer_t)(prop_stack_t, prop_object_t *,
 160                                 struct _prop_object_internalize_context *);
 161 typedef bool (*prop_object_internalizer_continue_t)(prop_stack_t,
 162                                 prop_object_t *,
 163                                 struct _prop_object_internalize_context *,
 164                                 void *, prop_object_t);
 165
 166         /* These are here because they're required by shared code. */
 167 bool            _prop_array_internalize(prop_stack_t, prop_object_t *,
 168                                 struct _prop_object_internalize_context *);
 169 bool            _prop_bool_internalize(prop_stack_t, prop_object_t *,
 170                                 struct _prop_object_internalize_context *);
 171 bool            _prop_data_internalize(prop_stack_t, prop_object_t *,
 172                                 struct _prop_object_internalize_context *);
 173 bool            _prop_dictionary_internalize(prop_stack_t, prop_object_t *,
 174                                 struct _prop_object_internalize_context *);
 175 bool            _prop_number_internalize(prop_stack_t, prop_object_t *,
 176                                 struct _prop_object_internalize_context *);
 177 bool            _prop_string_internalize(prop_stack_t, prop_object_t *,
 178                                 struct _prop_object_internalize_context *);
 179
 180 struct _prop_object_type {
 181         /* type indicator */
 182         uint32_t        pot_type;
 183         /* func to free object */
 184         _prop_object_free_rv_t
 185                         (*pot_free)(prop_stack_t, prop_object_t *);
 186         /*
 187          * func to free the child returned by pot_free with stack == NULL.
 188          *
 189          * Must be implemented if pot_free can return anything other than
 190          * _PROP_OBJECT_FREE_DONE.
 191          */
 192         void    (*pot_emergency_free)(prop_object_t);
 193         /* func to externalize object */
 194         bool    (*pot_extern)(struct _prop_object_externalize_context *,
 195                               void *);
 196         /* func to test quality */
 197         _prop_object_equals_rv_t
 198                 (*pot_equals)(prop_object_t, prop_object_t,
 199                               void **, void **,
 200                               prop_object_t *, prop_object_t *);
 201         /*
 202          * func to finish equality iteration.
 203          *
 204          * Must be implemented if pot_equals can return
 205          * _PROP_OBJECT_EQUALS_RECURSE
 206          */
 207         void    (*pot_equals_finish)(prop_object_t, prop_object_t);
 208 };
 209
 210 struct _prop_object {
 211         const struct _prop_object_type *po_type;/* type descriptor */
 212         uint32_t        po_refcnt;              /* reference count */
 213 };
 214
 215 void            _prop_object_init(struct _prop_object *,
 216                                   const struct _prop_object_type *);
 217 void            _prop_object_fini(struct _prop_object *);
 218
 219 struct _prop_object_iterator {
 220         prop_object_t   (*pi_next_object)(void *);
 221         void            (*pi_reset)(void *);
 222         prop_object_t   pi_obj;
 223         uint32_t        pi_version;
 224 };
 225
 226 /*
 227  * proplib in user space...
 228  */
 229
 230 #include <assert.h>
 231 #include <string.h>
 232 #include <stdio.h>
 233 #include <stdlib.h>
 234 #include <stddef.h>
 235
 236 #define _PROP_ASSERT(x)                 /*LINTED*/assert(x)
 237
 238 #define _PROP_MALLOC(s, t)              malloc((s))
 239 #define _PROP_CALLOC(s, t)              calloc(1, (s))
 240 #define _PROP_REALLOC(v, s, t)          realloc((v), (s))
 241 #define _PROP_FREE(v, t)                free((v))
 242
 243 #define _PROP_POOL_GET(p)               malloc((p))
 244 #define _PROP_POOL_PUT(p, v)            free((v))
 245
 246 #define _PROP_POOL_INIT(p, s, d)        static const size_t p = s;
 247
 248 #define _PROP_MALLOC_DEFINE(t, s, l)    /* nothing */
 249
 250 /*
 251  * Use pthread mutexes everywhere else.
 252  */
 253 #include <pthread.h>
 254 #define _PROP_MUTEX_DECL_STATIC(x)                                      \
 255                 static pthread_mutex_t x = PTHREAD_MUTEX_INITIALIZER;
 256 #define _PROP_MUTEX_LOCK(x)             pthread_mutex_lock(&(x))
 257 #define _PROP_MUTEX_UNLOCK(x)           pthread_mutex_unlock(&(x))
 258
 259 #define _PROP_RWLOCK_DECL(x)            pthread_rwlock_t x ;
 260 #define _PROP_RWLOCK_INIT(x)            pthread_rwlock_init(&(x), NULL)
 261 #define _PROP_RWLOCK_RDLOCK(x)          pthread_rwlock_rdlock(&(x))
 262 #define _PROP_RWLOCK_WRLOCK(x)          pthread_rwlock_wrlock(&(x))
 263 #define _PROP_RWLOCK_UNLOCK(x)          pthread_rwlock_unlock(&(x))
 264 #define _PROP_RWLOCK_DESTROY(x)         pthread_rwlock_destroy(&(x))
 265
 266 /*
 267  * Language features.
 268  */
 269 #define _PROP_ARG_UNUSED                /* delete */
 270
 271 #endif /* _PROPLIB_PROP_OBJECT_IMPL_H_ */