* 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"
/*
#include <stdbool.h>
#include <setjmp.h>
#include <stdio.h>
+#include <stdint.h>
#define UCI_CONFDIR "/etc/config"
#define UCI_SAVEDIR "/tmp/.uci"
};
struct uci_ptr;
-struct uci_plugin;
-struct uci_hook_ops;
struct uci_element;
struct uci_package;
struct uci_section;
struct uci_delta;
struct uci_context;
struct uci_backend;
+struct uci_parse_option;
struct uci_parse_context;
* @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);
* @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:
* Note: uci_lookup_ptr will automatically load a config package if necessary
* @str must not be constant, as it will be modified and used for the strings inside @ptr,
* thus it must also be available as long as @ptr is in use.
+ *
+ * This function returns UCI_ERR_NOTFOUND if the package specified in the tuple
+ * string cannot be found. Otherwise it will return UCI_OK.
+ *
+ * Note that failures in looking up other parts, if they are also specfied,
+ * including section and option, will also have a return value UCI_OK but with
+ * ptr->flags * UCI_LOOKUP_COMPLETE not set.
*/
extern int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended);
/**
* 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
*/
extern int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr);
/**
+ * uci_del_list: Remove a string from an element list
+ * @ctx: uci context
+ * @ptr: uci pointer (with value)
+ *
+ */
+extern int uci_del_list(struct uci_context *ctx, struct uci_ptr *ptr);
+
+/**
* uci_reorder: Reposition a section
* @ctx: uci context
* @s: uci section to reposition
/**
* 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);
*/
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
+ *
+ * This will also try adding the specified dir to the end of delta pathes.
*/
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
*
* This function allows you to add directories, which contain 'overlays'
* for the active config, that will never be committed.
+ *
+ * Adding a duplicate directory will cause UCI_ERR_DUPLICATE be returned.
*/
extern int uci_add_delta_path(struct uci_context *ctx, const char *dir);
*/
extern bool uci_validate_text(const char *str);
-
/**
- * uci_add_hook: add a uci hook
+ * uci_parse_ptr: parse a uci string into a uci_ptr
* @ctx: uci context
- * @ops: uci hook ops
+ * @ptr: target data structure
+ * @str: string to parse
*
- * NB: allocated and freed by the caller
- */
-extern int uci_add_hook(struct uci_context *ctx, const struct uci_hook_ops *ops);
-
-/**
- * uci_remove_hook: remove a uci hook
- * @ctx: uci context
- * @ops: uci hook ops
+ * str is modified by this function
*/
-extern int uci_remove_hook(struct uci_context *ctx, const struct uci_hook_ops *ops);
+int uci_parse_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str);
/**
- * uci_load_plugin: load an uci plugin
+ * uci_lookup_next: lookup a child element
* @ctx: uci context
- * @filename: path to the uci plugin
+ * @e: target element pointer
+ * @list: list of elements
+ * @name: name of the child element
*
- * NB: plugin will be unloaded automatically when the context is freed
+ * if parent is NULL, the function looks up the package with the given name
*/
-int uci_load_plugin(struct uci_context *ctx, const char *filename);
+int uci_lookup_next(struct uci_context *ctx, struct uci_element **e, struct uci_list *list, const char *name);
/**
- * uci_load_plugins: load all uci plugins from a directory
- * @ctx: uci context
- * @pattern: pattern of uci plugin files (optional)
- *
- * if pattern is NULL, then uci_load_plugins will call uci_load_plugin
- * for uci_*.so in <prefix>/lib/
+ * 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
*/
-int uci_load_plugins(struct uci_context *ctx, const char *pattern);
+void uci_parse_section(struct uci_section *s, const struct uci_parse_option *opts,
+ int n_opts, struct uci_option **tb);
/**
- * uci_parse_ptr: parse a uci string into a uci_ptr
- * @ctx: uci context
- * @ptr: target data structure
- * @str: string to parse
- *
- * str is modified by this function
+ * uci_hash_options: build a hash over a list of options
+ * @tb: list of option pointers
+ * @n_opts: number of options
*/
-int uci_parse_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str);
+uint32_t uci_hash_options(struct uci_option **tb, int n_opts);
+
/* UCI data structures */
enum uci_type {
UCI_TYPE_BACKEND = 6,
UCI_TYPE_ITEM = 7,
UCI_TYPE_HOOK = 8,
- UCI_TYPE_PLUGIN = 9,
};
enum uci_option_type {
bool internal, nested;
char *buf;
int bufsz;
-
- struct uci_list hooks;
- struct uci_list plugins;
};
struct uci_package
} v;
};
+/*
+ * UCI_CMD_ADD is used for anonymous sections or list values
+ */
enum uci_command {
UCI_CMD_ADD,
UCI_CMD_REMOVE,
UCI_CMD_RENAME,
UCI_CMD_REORDER,
UCI_CMD_LIST_ADD,
+ UCI_CMD_LIST_DEL,
+ __UCI_CMD_MAX,
+ __UCI_CMD_LAST = __UCI_CMD_MAX - 1
};
+extern char const uci_command_char[];
struct uci_delta
{
const char *value;
};
-struct uci_hook_ops
-{
- void (*load)(const struct uci_hook_ops *ops, struct uci_package *p);
- void (*set)(const struct uci_hook_ops *ops, struct uci_package *p, struct uci_delta *e);
-};
-
-struct uci_hook
-{
- struct uci_element e;
- const struct uci_hook_ops *ops;
-};
-
-struct uci_plugin_ops
-{
- int (*attach)(struct uci_context *ctx);
- void (*detach)(struct uci_context *ctx);
-};
-
-struct uci_plugin
-{
- struct uci_element e;
- const struct uci_plugin_ops *ops;
- void *dlh;
+struct uci_parse_option {
+ const char *name;
+ enum uci_option_type type;
};
#define uci_type_package UCI_TYPE_PACKAGE
#define uci_type_section UCI_TYPE_SECTION
#define uci_type_option UCI_TYPE_OPTION
-#define uci_type_hook UCI_TYPE_HOOK
-#define uci_type_plugin UCI_TYPE_PLUGIN
/* element typecasting */
#ifdef UCI_DEBUG_TYPECAST
[uci_type_package] = "package",
[uci_type_section] = "section",
[uci_type_option] = "option",
- [uci_type_hook] = "hook",
- [uci_type_plugin] = "plugin",
};
static void uci_typecast_error(int from, int to)
BUILD_CAST(package)
BUILD_CAST(section)
BUILD_CAST(option)
-BUILD_CAST(hook)
-BUILD_CAST(plugin)
#else
#define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
#define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
#define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
#define uci_to_option(ptr) container_of(ptr, struct uci_option, e)
-#define uci_to_hook(ptr) container_of(ptr, struct uci_hook, e)
-#define uci_to_plugin(ptr) container_of(ptr, struct uci_plugin, e)
#endif
/**
#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;
+}
+
+#ifndef BITS_PER_LONG
+#define BITS_PER_LONG (8 * sizeof(unsigned long))
+#endif
+
+static inline void uci_bitfield_set(unsigned long *bits, int bit)
+{
+ bits[bit / BITS_PER_LONG] |= (1UL << (bit % BITS_PER_LONG));
+}
+
+#ifdef __cplusplus
+}
+#endif
+
#endif
projects / project / uci.git / blobdiff