Code

data: Added support for a "regex" data-type.
[sysdb.git] / src / include / core / data.h
index 2e9b90bcfd55af660d3cb576b1c5e3e21427730e..a81cea45b5b6e5f52d5c6ba671f5b2ae42aa1e3c 100644 (file)
@@ -33,6 +33,9 @@
 #include <inttypes.h>
 #include <stddef.h>
 
+#include <sys/types.h>
+#include <regex.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -43,20 +46,16 @@ enum {
        SDB_TYPE_STRING,
        SDB_TYPE_DATETIME,
        SDB_TYPE_BINARY,
+       SDB_TYPE_REGEX,
 };
 
 #define SDB_TYPE_TO_STRING(t) \
-       (((t) == SDB_TYPE_INTEGER) \
-               ? "INTEGER" \
-               : ((t) == SDB_TYPE_DECIMAL) \
-                       ? "DECIMAL" \
-                       : ((t) == SDB_TYPE_STRING) \
-                               ? "STRING" \
-                               : ((t) == SDB_TYPE_DATETIME) \
-                                       ? "DATETIME" \
-                                       : ((t) == SDB_TYPE_BINARY) \
-                                               ? "BINARY" \
-                                               : "UNKNOWN")
+       (((t) == SDB_TYPE_INTEGER) ? "INTEGER" \
+               : ((t) == SDB_TYPE_DECIMAL) ? "DECIMAL" \
+               : ((t) == SDB_TYPE_STRING) ? "STRING" \
+               : ((t) == SDB_TYPE_DATETIME) ? "DATETIME" \
+               : ((t) == SDB_TYPE_BINARY) ? "BINARY" \
+               : ((t) == SDB_TYPE_REGEX) ? "REGEX" : "UNKNOWN")
 
 /*
  * sdb_data_t:
@@ -73,6 +72,10 @@ typedef struct {
                        size_t length;
                        unsigned char *datum;
                } binary;             /* SDB_TYPE_BINARY */
+               struct {
+                       char *raw;
+                       regex_t regex;
+               } re;                 /* SDB_TYPE_REGEX */
        } data;
 } sdb_data_t;
 #define SDB_DATA_INIT { 0, { .integer = 0 } }
@@ -105,7 +108,7 @@ sdb_data_free_datum(sdb_data_t *datum);
 /*
  * sdb_data_cmp:
  * Compare two data points. A NULL datum is considered less than any non-NULL
- * datum. On data-type mismatch, the function always returns a negative value.
+ * datum. On data-type mismatch, the function always returns a non-zero value.
  *
  * Returns:
  *  - a value less than zero if d1 compares less than d2
@@ -115,6 +118,28 @@ sdb_data_free_datum(sdb_data_t *datum);
 int
 sdb_data_cmp(const sdb_data_t *d1, const sdb_data_t *d2);
 
+/*
+ * sdb_data_strcmp:
+ * Compare the string values of two data points. A NULL datum is considered
+ * less than any non-NULL. This function works for arbitrary combination of
+ * data-types.
+ *
+ * Returns:
+ *  - a value less than zero if d1 compares less than d2
+ *  - zero if d1 compares equal to d2
+ *  - a value greater than zero if d1 compares greater than d2
+ */
+int
+sdb_data_strcmp(const sdb_data_t *d1, const sdb_data_t *d2);
+
+/*
+ * sdb_data_isnull:
+ * Determine whether a datum is NULL. A datum is considered to be NULL if
+ * either datum is NULL or if the string or binary datum is NULL.
+ */
+_Bool
+sdb_data_isnull(const sdb_data_t *datum);
+
 /*
  * Operators supported by sdb_data_eval_expr.
  */
@@ -143,9 +168,15 @@ enum {
 
 /*
  * sdb_data_expr_eval:
- * Evaluate a simple arithmetic expression on two data points. The data-type
- * of d1 and d2 have to be the same. String and binary data only support
- * concatenation and all other data types only support the other operators.
+ * Evaluate a simple arithmetic expression on two data points. String and
+ * binary data only support concatenation and all other data types only
+ * support the other operators. The result may be allocated dynamically and
+ * has to be freed by the caller (using sdb_data_free_datum).
+ *
+ * The data-types of d1 and d2 have to be the same, except for the following
+ * cases:
+ *  - <integer> or <decimal> <mul> <datetime>
+ *  - <datetime> <mul> or <div> or <mod> <integer> or <decimal>
  *
  * Returns:
  *  - 0 on success
@@ -198,7 +229,9 @@ sdb_data_format(const sdb_data_t *datum, char *buf, size_t buflen, int quoted);
  * specified as (floating point) number of seconds since the epoch. For string
  * and binary data, the input string is passed to the datum. The function does
  * not allocate new memory for that purpose. Use sdb_data_copy() if you want
- * to do that.
+ * to do that. For regex data, the input string is copied to newly allocated
+ * memory and also compiled to a regex. Use sdb_data_free_datum() to free the
+ * dynamically allocated memory.
  *
  * Returns:
  *  - 0 on success