lua: always return after calling luaL_error (patch by Stanislav Fomichev)
[project/uci.git] / uci.h
diff --git a/uci.h b/uci.h
index 5644ca8ff78dd59ebb52699f8b932d5970a265c0..6d13ea6c5f5d0ba2696ae8352dd5c08c5c7eab48 100644 (file)
--- a/uci.h
+++ b/uci.h
@@ -9,12 +9,16 @@
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * GNU Lesser General Public License for more details.
  */
 
 #ifndef __LIBUCI_H
 #define __LIBUCI_H
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include "uci_config.h"
 
 /*
@@ -29,6 +33,7 @@
 #include <stdbool.h>
 #include <setjmp.h>
 #include <stdio.h>
+#include <stdint.h>
 
 #define UCI_CONFDIR "/etc/config"
 #define UCI_SAVEDIR "/tmp/.uci"
@@ -65,6 +70,7 @@ struct uci_option;
 struct uci_delta;
 struct uci_context;
 struct uci_backend;
+struct uci_parse_option;
 struct uci_parse_context;
 
 
@@ -104,7 +110,7 @@ extern void uci_get_errorstr(struct uci_context *ctx, char **dest, const char *s
  * @single: ignore the 'package' keyword and parse everything into a single package
  *
  * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
- * if 'package' points to a non-null struct pointer, enable delta tracking and merge 
+ * if 'package' points to a non-null struct pointer, enable delta tracking and merge
  */
 extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single);
 
@@ -141,7 +147,7 @@ extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
  * @str: uci tuple string to look up
  * @extended: allow extended syntax lookup
  *
- * if extended is set to true, uci_lookup_ptr supports the following 
+ * if extended is set to true, uci_lookup_ptr supports the following
  * extended syntax:
  *
  * Examples:
@@ -165,7 +171,7 @@ extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, const
 /**
  * uci_set: Set an element's value; create the element if necessary
  * @ctx: uci context
- * @ptr: uci pointer 
+ * @ptr: uci pointer
  *
  * The updated/created element is stored in ptr->last
  */
@@ -199,7 +205,7 @@ extern int uci_rename(struct uci_context *ctx, struct uci_ptr *ptr);
 /**
  * uci_delete: Delete a section or option
  * @ctx: uci context
- * @ptr: uci pointer 
+ * @ptr: uci pointer
  */
 extern int uci_delete(struct uci_context *ctx, struct uci_ptr *ptr);
 
@@ -229,14 +235,14 @@ extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool over
  */
 extern int uci_list_configs(struct uci_context *ctx, char ***list);
 
-/** 
+/**
  * uci_set_savedir: override the default delta save directory
  * @ctx: uci context
  * @dir: directory name
  */
 extern int uci_set_savedir(struct uci_context *ctx, const char *dir);
 
-/** 
+/**
  * uci_set_savedir: override the default config storage directory
  * @ctx: uci context
  * @dir: directory name
@@ -333,6 +339,35 @@ int uci_load_plugins(struct uci_context *ctx, const char *pattern);
  */
 int uci_parse_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str);
 
+/**
+ * uci_lookup_next: lookup a child element
+ * @ctx: uci context
+ * @e: target element pointer
+ * @list: list of elements
+ * @name: name of the child element
+ *
+ * if parent is NULL, the function looks up the package with the given name
+ */
+int uci_lookup_next(struct uci_context *ctx, struct uci_element **e, struct uci_list *list, const char *name);
+
+/**
+ * uci_parse_section: look up a set of options
+ * @s: uci section
+ * @opts: list of options to look up
+ * @n_opts: number of options to look up
+ * @tb: array of pointers to found options
+ */
+void uci_parse_section(struct uci_section *s, const struct uci_parse_option *opts,
+                      int n_opts, struct uci_option **tb);
+
+/**
+ * uci_hash_options: build a hash over a list of options
+ * @tb: list of option pointers
+ * @n_opts: number of options
+ */
+uint32_t uci_hash_options(struct uci_option **tb, int n_opts);
+
+
 /* UCI data structures */
 enum uci_type {
        UCI_TYPE_UNSPEC = 0,
@@ -509,6 +544,11 @@ struct uci_plugin
        void *dlh;
 };
 
+struct uci_parse_option {
+       const char *name;
+       enum uci_option_type type;
+};
+
 
 /* linked list handling */
 #ifndef offsetof
@@ -639,4 +679,67 @@ BUILD_CAST(plugin)
 #define uci_dataptr(ptr) \
        (((char *) ptr) + sizeof(*ptr))
 
+/**
+ * uci_lookup_package: look up a package
+ * @ctx: uci context
+ * @name: name of the package
+ */
+static inline struct uci_package *
+uci_lookup_package(struct uci_context *ctx, const char *name)
+{
+       struct uci_element *e = NULL;
+       if (uci_lookup_next(ctx, &e, &ctx->root, name) == 0)
+               return uci_to_package(e);
+       else
+               return NULL;
+}
+
+/**
+ * uci_lookup_section: look up a section
+ * @ctx: uci context
+ * @p: package that the section belongs to
+ * @name: name of the section
+ */
+static inline struct uci_section *
+uci_lookup_section(struct uci_context *ctx, struct uci_package *p, const char *name)
+{
+       struct uci_element *e = NULL;
+       if (uci_lookup_next(ctx, &e, &p->sections, name) == 0)
+               return uci_to_section(e);
+       else
+               return NULL;
+}
+
+/**
+ * uci_lookup_option: look up an option
+ * @ctx: uci context
+ * @section: section that the option belongs to
+ * @name: name of the option
+ */
+static inline struct uci_option *
+uci_lookup_option(struct uci_context *ctx, struct uci_section *s, const char *name)
+{
+       struct uci_element *e = NULL;
+       if (uci_lookup_next(ctx, &e, &s->options, name) == 0)
+               return uci_to_option(e);
+       else
+               return NULL;
+}
+
+static inline const char *
+uci_lookup_option_string(struct uci_context *ctx, struct uci_section *s, const char *name)
+{
+       struct uci_option *o;
+
+       o = uci_lookup_option(ctx, s, name);
+       if (!o || o->type != UCI_TYPE_STRING)
+               return NULL;
+
+       return o->v.string;
+}
+
+#ifdef __cplusplus
+}
+#endif
+
 #endif