Code

store: Removed now unused name-matcher and sdb_store_matcher_parse_cmp().
[sysdb.git] / src / include / core / store.h
index 9304acfa79e1f7761928a76dad17e161d02db09f..b82ae2e9134cb41ca1f4cdb4b77626c454ab0cff 100644 (file)
@@ -320,7 +320,8 @@ sdb_store_expr_fieldvalue(int field);
 /*
  * sdb_store_expr_attrvalue:
  * Creates an expression which evaluates to the value of the specified
- * attribute of a stored object.
+ * attribute of a stored object. Evaluates to a NULL value if the attribute
+ * does not exist.
  *
  * Returns:
  *  - an expression object on success
@@ -358,58 +359,18 @@ sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
                sdb_data_t *res, sdb_store_matcher_t *filter);
 
 /*
- * Conditionals may be used to lookup hosts from the store based on a
- * conditional expression.
- *
- * A conditional object inherits from sdb_object_t and, thus, may safely be
- * cast to a generic object.
- */
-struct sdb_store_cond;
-typedef struct sdb_store_cond sdb_store_cond_t;
-#define SDB_STORE_COND(obj) ((sdb_store_cond_t *)(obj))
-
-/*
- * sdb_store_attr_cond:
- * Creates a conditional based on attribute values. The value of stored
- * attributes is compared against the value the expression evaluates to. See
- * sdb_data_cmp for details about the comparison.
- */
-sdb_store_cond_t *
-sdb_store_attr_cond(const char *name, sdb_store_expr_t *expr);
-
-/*
- * sdb_store_obj_cond:
- * Creates a conditional based on queryable object fields. The respective
- * field of *any* object type is compared against the value the expression
- * evaluates to.
- */
-sdb_store_cond_t *
-sdb_store_obj_cond(int field, sdb_store_expr_t *expr);
-
-/*
- * sdb_store_name_matcher:
- * Creates a matcher matching by the specified object type's name. If 're' is
- * true, the specified name is treated as a POSIX extended regular expression.
- * Else, the exact name has to match (case-insensitive).
+ * sdb_store_isnull_matcher:
+ * Creates a matcher matching NULL values.
  */
 sdb_store_matcher_t *
-sdb_store_name_matcher(int type, const char *name, _Bool re);
+sdb_store_isnull_matcher(sdb_store_expr_t *expr);
 
 /*
- * sdb_store_attr_matcher:
- * Creates a matcher matching attributes based on their value. If 're' is
- * true, the specified name is treated as a POSIX extended regular expression.
- * Else, the exact name has to match (case-insensitive).
+ * sdb_store_isnnull_matcher:
+ * Creates a matcher matching non-NULL values.
  */
 sdb_store_matcher_t *
-sdb_store_attr_matcher(const char *name, const char *value, _Bool re);
-
-/*
- * sdb_store_isnull_matcher:
- * Creates a matcher matching "missing" attributes.
- */
-sdb_store_matcher_t *
-sdb_store_isnull_matcher(const char *attr_name);
+sdb_store_isnnull_matcher(sdb_store_expr_t *expr);
 
 /*
  * sdb_store_child_matcher:
@@ -422,79 +383,103 @@ sdb_store_child_matcher(int type, sdb_store_matcher_t *m);
 /*
  * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
  * sdb_store_ge_matcher, sdb_store_gt_matcher:
- * Creates a matcher based on a conditional. The matcher matches objects for
- * which the conditional evaluates the object to compare less than, less or
- * equal, equal, greater or equal, or greater than the conditional's value
- * repsectively.
+ * Create conditional matchers comparing the values of two expressions. The
+ * matcher matches if the left expression compres less than, less or equal
+ * than, equal to, not equal to, greater or equal than, or greater than the
+ * right expression.
  */
 sdb_store_matcher_t *
-sdb_store_lt_matcher(sdb_store_cond_t *cond);
-sdb_store_matcher_t *
-sdb_store_le_matcher(sdb_store_cond_t *cond);
+sdb_store_lt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 sdb_store_matcher_t *
-sdb_store_eq_matcher(sdb_store_cond_t *cond);
+sdb_store_le_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 sdb_store_matcher_t *
-sdb_store_ge_matcher(sdb_store_cond_t *cond);
+sdb_store_eq_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 sdb_store_matcher_t *
-sdb_store_gt_matcher(sdb_store_cond_t *cond);
-
+sdb_store_ne_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 sdb_store_matcher_t *
-sdb_store_cmp_lt(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_ge_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 sdb_store_matcher_t *
-sdb_store_cmp_le(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_gt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
+
+/*
+ * sdb_store_in_matcher:
+ * Creates a matcher which matches if the right value evaluates to an array
+ * value and the left value is included in that array. See sdb_data_inarray
+ * for more details.
+ */
 sdb_store_matcher_t *
-sdb_store_cmp_eq(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_in_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
+
+/*
+ * sdb_store_regex_matcher:
+ * Creates a matcher which matches the string value the left expression
+ * evaluates to against the regular expression the right expression evaluates
+ * to. The right expression may either be a constant value regular expression
+ * or string or a dynamic value evaluating to a string. In the latter case,
+ * the string is compiled to a regex every time the matcher is executed.
+ */
 sdb_store_matcher_t *
-sdb_store_cmp_ge(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_regex_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
+
+/*
+ * sdb_store_nregex_matcher:
+ * Creates a regex matcher just like sdb_store_regex_matcher except that it
+ * matches in case the regular expression does not match.
+ */
 sdb_store_matcher_t *
-sdb_store_cmp_gt(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_nregex_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 
 /*
- * sdb_store_parse_object_type_plural:
- * Parse the type name (plural) of a stored object.
+ * sdb_store_matcher_op_cb:
+ * Callback constructing a matcher operator.
+ */
+typedef sdb_store_matcher_t *(*sdb_store_matcher_op_cb)
+       (sdb_store_expr_t *, sdb_store_expr_t *);
+
+/*
+ * sdb_store_parse_matcher_op:
+ * Parse a matcher operator and return a constructor for the respective
+ * matcher.
  *
  * Returns:
- *  - the object type on success
- *  - a negative value else
+ *  - matcher operator constructor on success
+ *  - NULL else
  */
-int
-sdb_store_parse_object_type_plural(const char *name);
+sdb_store_matcher_op_cb
+sdb_store_parse_matcher_op(const char *op);
 
 /*
- * sdb_store_parse_field_name:
- * Parse the name of a stored object's queryable field.
+ * sdb_store_parse_object_type:
+ * Parse the type name of a stored object.
  *
  * Returns:
- *  - the field id on success
+ *  - the object type on success
  *  - a negative value else
  */
 int
-sdb_store_parse_field_name(const char *name);
+sdb_store_parse_object_type(const char *name);
 
 /*
- * sdb_store_matcher_parse_cmp:
- * Parse a simple compare expression (<obj_type>.<attr> <op> <expression>).
+ * sdb_store_parse_object_type_plural:
+ * Parse the type name (plural) of a stored object.
  *
  * Returns:
- *  - a matcher object on success
- *  - NULL else
+ *  - the object type on success
+ *  - a negative value else
  */
-sdb_store_matcher_t *
-sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr,
-               const char *op, sdb_store_expr_t *expr);
+int
+sdb_store_parse_object_type_plural(const char *name);
 
 /*
- * sdb_store_matcher_parse_field_cmp:
- * Parse a simple compare expression for queryable object fields (<field> <op>
- * <expression>).
+ * sdb_store_parse_field_name:
+ * Parse the name of a stored object's queryable field.
  *
  * Returns:
- *  - a matcher object on success
- *  - NULL else
+ *  - the field id on success
+ *  - a negative value else
  */
-sdb_store_matcher_t *
-sdb_store_matcher_parse_field_cmp(const char *name, const char *op,
-               sdb_store_expr_t *expr);
+int
+sdb_store_parse_field_name(const char *name);
 
 /*
  * sdb_store_dis_matcher:
@@ -536,14 +521,6 @@ int
 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj,
                sdb_store_matcher_t *filter);
 
-/*
- * sdb_store_matcher_tostring:
- * Format a matcher object as string. This is meant for logging or debugging
- * purposes.
- */
-char *
-sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen);
-
 /*
  * sdb_store_lookup_cb:
  * Lookup callback. It is called for each matching object when looking up data