* 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_package;
struct uci_section;
struct uci_option;
-struct uci_history;
+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 history 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:
* network.@interface[0].ifname ('ifname' option of the first interface section)
* network.@interface[-1] (last interface section)
- * Note: uci_lookup_ext will automatically load a config package if necessary
+ * 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
+ * @pos: new position in the section list
+ */
+extern int uci_reorder_section(struct uci_context *ctx, struct uci_section *s, int pos);
+
+/**
* uci_rename: Rename an element
* @ctx: uci context
* @ptr: uci pointer (with value)
/**
* 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);
/**
- * uci_save: save change history for a package
+ * uci_save: save change delta for a package
* @ctx: uci context
* @p: uci_package struct
*/
* uci_commit: commit changes to a package
* @ctx: uci context
* @p: uci_package struct pointer
- * @overwrite: overwrite existing config data and flush history
+ * @overwrite: overwrite existing config data and flush delta
*
* committing may reload the whole uci_package data,
* the supplied pointer is updated accordingly
*/
extern int uci_list_configs(struct uci_context *ctx, char ***list);
-/**
- * uci_set_savedir: override the default history save directory
+/**
+ * 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
extern int uci_set_confdir(struct uci_context *ctx, const char *dir);
/**
- * uci_add_history_path: add a directory to the search path for change history files
+ * uci_add_delta_path: add a directory to the search path for change delta files
* @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_history_path(struct uci_context *ctx, const char *dir);
+extern int uci_add_delta_path(struct uci_context *ctx, const char *dir);
/**
* uci_revert: revert all changes to a config item
*/
extern bool uci_validate_text(const char *str);
+/**
+ * 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
+ */
+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,
- UCI_TYPE_HISTORY = 1,
+ UCI_TYPE_DELTA = 1,
UCI_TYPE_PACKAGE = 2,
UCI_TYPE_SECTION = 3,
UCI_TYPE_OPTION = 4,
UCI_TYPE_PATH = 5,
UCI_TYPE_BACKEND = 6,
UCI_TYPE_ITEM = 7,
+ UCI_TYPE_HOOK = 8,
};
enum uci_option_type {
UCI_FLAG_STRICT = (1 << 0), /* strict mode for the parser */
UCI_FLAG_PERROR = (1 << 1), /* print parser error messages */
UCI_FLAG_EXPORT_NAME = (1 << 2), /* when exporting, name unnamed sections */
- UCI_FLAG_SAVED_HISTORY = (1 << 3), /* store the saved history in memory as well */
+ UCI_FLAG_SAVED_DELTA = (1 << 3), /* store the saved delta in memory as well */
};
struct uci_element
char *confdir;
char *savedir;
- /* search path for history files */
- struct uci_list history_path;
+ /* search path for delta files */
+ struct uci_list delta_path;
/* private: */
int err;
struct uci_element e;
struct uci_list sections;
struct uci_context *ctx;
- bool has_history;
+ bool has_delta;
char *path;
/* private: */
struct uci_backend *backend;
void *priv;
int n_section;
- struct uci_list history;
- struct uci_list saved_history;
+ struct uci_list delta;
+ struct uci_list saved_delta;
};
struct uci_section
} v;
};
+/*
+ * UCI_CMD_ADD is used for anonymous sections or list values
+ */
enum uci_command {
UCI_CMD_ADD,
UCI_CMD_REMOVE,
UCI_CMD_CHANGE,
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_history
+struct uci_delta
{
struct uci_element e;
enum uci_command cmd;
const char *value;
};
+struct uci_parse_option {
+ const char *name;
+ enum uci_option_type type;
+};
+
/* linked list handling */
#ifndef offsetof
* @type: the type of the container struct this is embedded in.
* @member: the name of the member within the struct.
*/
+#ifndef container_of
#define container_of(ptr, type, member) \
((type *) ((char *)ptr - offsetof(type,member)))
+#endif
/**
/* wrappers for dynamic type handling */
#define uci_type_backend UCI_TYPE_BACKEND
-#define uci_type_history UCI_TYPE_HISTORY
+#define uci_type_delta UCI_TYPE_DELTA
#define uci_type_package UCI_TYPE_PACKAGE
#define uci_type_section UCI_TYPE_SECTION
#define uci_type_option UCI_TYPE_OPTION
#ifdef UCI_DEBUG_TYPECAST
static const char *uci_typestr[] = {
[uci_type_backend] = "backend",
- [uci_type_history] = "history",
+ [uci_type_delta] = "delta",
[uci_type_package] = "package",
[uci_type_section] = "section",
[uci_type_option] = "option",
}
BUILD_CAST(backend)
-BUILD_CAST(history)
+BUILD_CAST(delta)
BUILD_CAST(package)
BUILD_CAST(section)
BUILD_CAST(option)
#else
#define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
-#define uci_to_history(ptr) container_of(ptr, struct uci_history, e)
+#define uci_to_delta(ptr) container_of(ptr, struct uci_delta, 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_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