parser: Let the TIMESERIES command accept optional data-source names.

[sysdb.git] / src / include / core / object.h

diff --git a/src/include/core/object.h b/src/include/core/object.h
index dab220b2df41e6bd2d5361b2e9a5f12a0002c2a9..19d6cc33799c68eeefa3a7e72f322fdf2522201c 100644 (file)
--- a/src/include/core/object.h
+++ b/src/include/core/object.h
@@ -46,15 +46,20 @@ struct sdb_type {
 
        int (*init)(sdb_object_t *, va_list);
        void (*destroy)(sdb_object_t *);
-       sdb_object_t *(*clone)(const sdb_object_t *);
 };
-#define SDB_TYPE_INIT { 0, NULL, NULL, NULL }
+#define SDB_TYPE_INIT { 0, NULL, NULL }
 
 struct sdb_object {
        sdb_type_t type;
        int ref_cnt;
+       char *name;
 };
-#define SDB_OBJECT_INIT { SDB_TYPE_INIT, 1 }
+#define SDB_OBJECT_INIT { SDB_TYPE_INIT, 1, NULL }
+#define SDB_OBJECT_TYPED_INIT(t) { (t), 1, NULL }
+
+#define SDB_OBJECT_STATIC(name) { \
+       /* type */ { sizeof(sdb_object_t), NULL, NULL }, \
+       /* ref-cnt */ 1, (name) }
 
 typedef struct {
        sdb_object_t super;
@@ -63,19 +68,34 @@ typedef struct {
 } sdb_object_wrapper_t;
 
 #define SDB_OBJ(obj) ((sdb_object_t *)(obj))
+#define SDB_CONST_OBJ(obj) ((const sdb_object_t *)(obj))
 #define SDB_OBJ_WRAPPER(obj) ((sdb_object_wrapper_t *)(obj))
+#define SDB_CONST_OBJ_WRAPPER(obj) ((const sdb_object_wrapper_t *)(obj))
+
+/*
+ * Callback types for comparing objects or performing object lookup.
+ * Any function of type sdb_object_cmp_cb shall return a negative value, zero,
+ * or a positive value if the first object compares less than, equal to, or
+ * greater than the second object respectively.
+ * Any function of type sdb_object_lookup_cb shall return zero for all
+ * matching objects.
+ */
+typedef int (*sdb_object_cmp_cb)(const sdb_object_t *, const sdb_object_t *);
+typedef int (*sdb_object_lookup_cb)(const sdb_object_t *, const void *user_data);
 
 /*
  * sdb_object_create:
- * Allocates a new sdb_object_t of the specified 'type'. The object will be
- * initialized to zero and then passed on to the 'init' function (if
+ * Allocates a new sdb_object_t of the specified 'name' and 'type'. The object
+ * will be initialized to zero and then passed on to the 'init' function (if
  * specified). If specified, the 'destroy' callback will be called, when the
  * reference count drops to zero and before freeing the memory allocated by
  * the object itself.
  *
  * The init function will be called with the remaining arguments passed to
  * sdb_object_create. If the init function fails (returns a non-zero value),
- * the object will be destructed and destroyed.
+ * the object will be destructed and destroyed. In this case, the 'destroy'
+ * callback may be called on objects that were only half-way initialized. The
+ * callback has to handle that case correctly.
  *
  * The reference count of the new object will be 1.
  *
@@ -84,7 +104,32 @@ typedef struct {
  *  - NULL on error
  */
 sdb_object_t *
-sdb_object_create(sdb_type_t type, ...);
+sdb_object_create(const char *name, sdb_type_t type, ...);
+sdb_object_t *
+sdb_object_vcreate(const char *name, sdb_type_t type, va_list ap);
+
+/*
+ * sdb_object_create_simple:
+ * Create a "simple" object without custom initialization and optional
+ * destructor. See the description of sdb_object_create for more details.
+ */
+sdb_object_t *
+sdb_object_create_simple(const char *name, size_t size,
+               void (*destructor)(sdb_object_t *));
+
+/*
+ * sdb_object_create_T:
+ * Create a simple object of type 't'.
+ */
+#define sdb_object_create_T(n,t) \
+       sdb_object_create_simple((n), sizeof(t), NULL)
+
+/*
+ * sdb_object_create_dT:
+ * Create a simple object of dynamic type 't' using destructor 'd'.
+ */
+#define sdb_object_create_dT(n,t,d) \
+       sdb_object_create_simple((n), sizeof(t), d)
 
 /*
  * sdb_object_create_wrapper:
@@ -94,10 +139,11 @@ sdb_object_create(sdb_type_t type, ...);
  * of the SysDB object system.
  */
 sdb_object_t *
-sdb_object_create_wrapper(void *data, void (*destructor)(void *));
+sdb_object_create_wrapper(const char *name,
+               void *data, void (*destructor)(void *));
 
-#define SDB_OBJECT_WRAPPER_STATIC(obj, destructor) \
-       { SDB_OBJECT_INIT, (obj), (destructor) }
+#define SDB_OBJECT_WRAPPER_STATIC(obj) \
+       { SDB_OBJECT_INIT, (obj), /* destructor */ NULL }
 
 /*
  * sdb_object_deref:
@@ -116,6 +162,18 @@ sdb_object_deref(sdb_object_t *obj);
 void
 sdb_object_ref(sdb_object_t *obj);
 
+/*
+ * sdb_object_cmp_by_name:
+ * Compare two objects by their name ignoring the case of the characters.
+ *
+ * Returns:
+ *  - a negative value if o1 compares less than o2
+ *  - zero if o1 matches o2
+ *  - a positive value if o1 compares greater than o2
+ */
+int
+sdb_object_cmp_by_name(const sdb_object_t *o1, const sdb_object_t *o2);
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif