src/include/core/object.h

   1 /*
   2  * SysDB - src/include/core/object.h
   3  * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef SDB_CORE_OBJECT_H
  29 #define SDB_CORE_OBJECT_H 1
  30
  31 #include <stdarg.h>
  32 #include <stddef.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct sdb_type;
  39 typedef struct sdb_type sdb_type_t;
  40
  41 struct sdb_object;
  42 typedef struct sdb_object sdb_object_t;
  43
  44 struct sdb_type {
  45         size_t size;
  46
  47         int (*init)(sdb_object_t *, va_list);
  48         void (*destroy)(sdb_object_t *);
  49 };
  50 #define SDB_TYPE_INIT { 0, NULL, NULL }
  51
  52 struct sdb_object {
  53         sdb_type_t type;
  54         int ref_cnt;
  55         char *name;
  56 };
  57 #define SDB_OBJECT_INIT { SDB_TYPE_INIT, 1, NULL }
  58 #define SDB_OBJECT_TYPED_INIT(t) { (t), 1, NULL }
  59
  60 #define SDB_OBJECT_STATIC(name) { \
  61         /* type */ { sizeof(sdb_object_t), NULL, NULL }, \
  62         /* ref-cnt */ 1, (name) }
  63
  64 typedef struct {
  65         sdb_object_t super;
  66         void *data;
  67         void (*destructor)(void *);
  68 } sdb_object_wrapper_t;
  69
  70 #define SDB_OBJ(obj) ((sdb_object_t *)(obj))
  71 #define SDB_CONST_OBJ(obj) ((const sdb_object_t *)(obj))
  72 #define SDB_OBJ_WRAPPER(obj) ((sdb_object_wrapper_t *)(obj))
  73 #define SDB_CONST_OBJ_WRAPPER(obj) ((const sdb_object_wrapper_t *)(obj))
  74
  75 /*
  76  * Callback types for comparing objects or performing object lookup.
  77  */
  78 typedef int (*sdb_object_cmp_cb)(const sdb_object_t *, const sdb_object_t *);
  79 typedef int (*sdb_object_lookup_cb)(const sdb_object_t *, const void *user_data);
  80
  81 /*
  82  * sdb_object_create:
  83  * Allocates a new sdb_object_t of the specified 'name' and 'type'. The object
  84  * will be initialized to zero and then passed on to the 'init' function (if
  85  * specified). If specified, the 'destroy' callback will be called, when the
  86  * reference count drops to zero and before freeing the memory allocated by
  87  * the object itself.
  88  *
  89  * The init function will be called with the remaining arguments passed to
  90  * sdb_object_create. If the init function fails (returns a non-zero value),
  91  * the object will be destructed and destroyed. In this case, the 'destroy'
  92  * callback may be called on objects that were only half-way initialized. The
  93  * callback has to handle that case correctly.
  94  *
  95  * The reference count of the new object will be 1.
  96  *
  97  * Returns:
  98  *  - the newly allocated object
  99  *  - NULL on error
 100  */
 101 sdb_object_t *
 102 sdb_object_create(const char *name, sdb_type_t type, ...);
 103 sdb_object_t *
 104 sdb_object_vcreate(const char *name, sdb_type_t type, va_list ap);
 105
 106 /*
 107  * sdb_object_create_simple:
 108  * Create a "simple" object without custom initialization and optional
 109  * destructor. See the description of sdb_object_create for more details.
 110  */
 111 sdb_object_t *
 112 sdb_object_create_simple(const char *name, size_t size,
 113                 void (*destructor)(sdb_object_t *));
 114
 115 /*
 116  * sdb_object_create_T:
 117  * Create a simple object of type 't'.
 118  */
 119 #define sdb_object_create_T(n,t) \
 120         sdb_object_create_simple((n), sizeof(t), NULL)
 121
 122 /*
 123  * sdb_object_create_dT:
 124  * Create a simple object of dynamic type 't' using destructor 'd'.
 125  */
 126 #define sdb_object_create_dT(n,t,d) \
 127         sdb_object_create_simple((n), sizeof(t), d)
 128
 129 /*
 130  * sdb_object_create_wrapper:
 131  * Create a new sdb_object_t wrapping some arbitrary other object.
 132  *
 133  * Creation and initialization of the wrapped object needs to happen outside
 134  * of the SysDB object system.
 135  */
 136 sdb_object_t *
 137 sdb_object_create_wrapper(const char *name,
 138                 void *data, void (*destructor)(void *));
 139
 140 #define SDB_OBJECT_WRAPPER_STATIC(obj) \
 141         { SDB_OBJECT_INIT, (obj), /* destructor */ NULL }
 142
 143 /*
 144  * sdb_object_deref:
 145  * Dereference the object and free the allocated memory in case the ref-count
 146  * drops to zero. In case a 'destructor' had been registered with the object,
 147  * it will be called before freeing the memory.
 148  */
 149 void
 150 sdb_object_deref(sdb_object_t *obj);
 151
 152 /*
 153  * sdb_object_ref:
 154  * Take ownership of the specified object, that is, increment the reference
 155  * count by one.
 156  */
 157 void
 158 sdb_object_ref(sdb_object_t *obj);
 159
 160 /*
 161  * sdb_object_cmp_by_name:
 162  * Compare two objects by their name ignoring the case of the characters.
 163  *
 164  * Returns:
 165  *  - a negative value if o1 compares less than o2
 166  *  - zero if o1 matches o2
 167  *  - a positive value if o1 compares greater than o2
 168  */
 169 int
 170 sdb_object_cmp_by_name(const sdb_object_t *o1, const sdb_object_t *o2);
 171
 172 #ifdef __cplusplus
 173 } /* extern "C" */
 174 #endif
 175
 176 #endif /* ! SDB_CORE_OBJECT_H */
 177
 178 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 179