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 typedef struct {
  61         sdb_object_t super;
  62         void *data;
  63         void (*destructor)(void *);
  64 } sdb_object_wrapper_t;
  65
  66 #define SDB_OBJ(obj) ((sdb_object_t *)(obj))
  67 #define SDB_CONST_OBJ(obj) ((const sdb_object_t *)(obj))
  68 #define SDB_OBJ_WRAPPER(obj) ((sdb_object_wrapper_t *)(obj))
  69 #define SDB_CONST_OBJ_WRAPPER(obj) ((const sdb_object_wrapper_t *)(obj))
  70
  71 /*
  72  * sdb_object_create:
  73  * Allocates a new sdb_object_t of the specified 'name' and 'type'. The object
  74  * will be initialized to zero and then passed on to the 'init' function (if
  75  * specified). If specified, the 'destroy' callback will be called, when the
  76  * reference count drops to zero and before freeing the memory allocated by
  77  * the object itself.
  78  *
  79  * The init function will be called with the remaining arguments passed to
  80  * sdb_object_create. If the init function fails (returns a non-zero value),
  81  * the object will be destructed and destroyed. In this case, the 'destroy'
  82  * callback may be called on objects that were only half-way initialized. The
  83  * callback has to handle that case correctly.
  84  *
  85  * The reference count of the new object will be 1.
  86  *
  87  * Returns:
  88  *  - the newly allocated object
  89  *  - NULL on error
  90  */
  91 sdb_object_t *
  92 sdb_object_create(const char *name, sdb_type_t type, ...);
  93 sdb_object_t *
  94 sdb_object_vcreate(const char *name, sdb_type_t type, va_list ap);
  95
  96 /*
  97  * sdb_object_create_simple:
  98  * Create a "simple" object without custom initialization and optional
  99  * destructor. See the description of sdb_object_create for more details.
 100  */
 101 sdb_object_t *
 102 sdb_object_create_simple(const char *name, size_t size,
 103                 void (*destructor)(sdb_object_t *));
 104
 105 /*
 106  * sdb_object_create_T:
 107  * Create a simple object of type 't'.
 108  */
 109 #define sdb_object_create_T(n,t) \
 110         sdb_object_create_simple((n), sizeof(t), NULL)
 111
 112 /*
 113  * sdb_object_create_wrapper:
 114  * Create a new sdb_object_t wrapping some arbitrary other object.
 115  *
 116  * Creation and initialization of the wrapped object needs to happen outside
 117  * of the SysDB object system.
 118  */
 119 sdb_object_t *
 120 sdb_object_create_wrapper(const char *name,
 121                 void *data, void (*destructor)(void *));
 122
 123 #define SDB_OBJECT_WRAPPER_STATIC(obj, destructor) \
 124         { SDB_OBJECT_INIT, (obj), (destructor) }
 125
 126 /*
 127  * sdb_object_deref:
 128  * Dereference the object and free the allocated memory in case the ref-count
 129  * drops to zero. In case a 'destructor' had been registered with the object,
 130  * it will be called before freeing the memory.
 131  */
 132 void
 133 sdb_object_deref(sdb_object_t *obj);
 134
 135 /*
 136  * sdb_object_ref:
 137  * Take ownership of the specified object, that is, increment the reference
 138  * count by one.
 139  */
 140 void
 141 sdb_object_ref(sdb_object_t *obj);
 142
 143 /*
 144  * sdb_object_cmp_by_name:
 145  * Compare two objects by their name ignoring the case of the characters.
 146  *
 147  * Returns:
 148  *  - a negative value if o1 compares less than o2
 149  *  - zero if o1 matches o2
 150  *  - a positive value if o1 compares greater than o2
 151  */
 152 int
 153 sdb_object_cmp_by_name(const sdb_object_t *o1, const sdb_object_t *o2);
 154
 155 #ifdef __cplusplus
 156 } /* extern "C" */
 157 #endif
 158
 159 #endif /* ! SDB_CORE_OBJECT_H */
 160
 161 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 162