aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMuhammad Moinur Rahman <bofh@FreeBSD.org>2026-01-07 18:19:44 +0000
committerMuhammad Moinur Rahman <bofh@FreeBSD.org>2026-01-07 18:19:44 +0000
commit1dd83cf7e527ff29d734f6a2c8f9b61d39b41d94 (patch)
treeda5185757a055488bdc9cbb7d17077a8f36596a9 /include
parent1e2f270469c61337ef7f5f92ab93f691e5d86492 (diff)
Diffstat (limited to 'include')
-rw-r--r--include/lua_ucl.h18
-rw-r--r--include/ucl++.h568
-rw-r--r--include/ucl.h681
3 files changed, 661 insertions, 606 deletions
diff --git a/include/lua_ucl.h b/include/lua_ucl.h
index 5b7f88e031e1..30dd87f7520d 100644
--- a/include/lua_ucl.h
+++ b/include/lua_ucl.h
@@ -44,7 +44,7 @@ struct ucl_lua_funcdata {
/**
* Initialize lua UCL API
*/
-UCL_EXTERN int luaopen_ucl (lua_State *L);
+UCL_EXTERN int luaopen_ucl(lua_State *L);
/**
* Import UCL object from lua state
@@ -52,7 +52,7 @@ UCL_EXTERN int luaopen_ucl (lua_State *L);
* @param idx index of object at the lua stack to convert to UCL
* @return new UCL object or NULL, the caller should unref object after using
*/
-UCL_EXTERN ucl_object_t* ucl_object_lua_import (lua_State *L, int idx);
+UCL_EXTERN ucl_object_t *ucl_object_lua_import(lua_State *L, int idx);
/**
* Import UCL object from lua state, escaping JSON strings
@@ -60,7 +60,7 @@ UCL_EXTERN ucl_object_t* ucl_object_lua_import (lua_State *L, int idx);
* @param idx index of object at the lua stack to convert to UCL
* @return new UCL object or NULL, the caller should unref object after using
*/
-UCL_EXTERN ucl_object_t* ucl_object_lua_import_escape (lua_State *L, int idx);
+UCL_EXTERN ucl_object_t *ucl_object_lua_import_escape(lua_State *L, int idx);
/**
* Push an object to lua
@@ -68,18 +68,18 @@ UCL_EXTERN ucl_object_t* ucl_object_lua_import_escape (lua_State *L, int idx);
* @param obj object to push
* @param allow_array traverse over implicit arrays
*/
-UCL_EXTERN int ucl_object_push_lua (lua_State *L,
- const ucl_object_t *obj, bool allow_array);
+UCL_EXTERN int ucl_object_push_lua(lua_State *L,
+ const ucl_object_t *obj, bool allow_array);
/**
* Push an object to lua replacing all ucl.null with `false`
* @param L lua state
* @param obj object to push
* @param allow_array traverse over implicit arrays
*/
-UCL_EXTERN int ucl_object_push_lua_filter_nil (lua_State *L,
- const ucl_object_t *obj,
- bool allow_array);
+UCL_EXTERN int ucl_object_push_lua_filter_nil(lua_State *L,
+ const ucl_object_t *obj,
+ bool allow_array);
-UCL_EXTERN struct ucl_lua_funcdata* ucl_object_toclosure (const ucl_object_t *obj);
+UCL_EXTERN struct ucl_lua_funcdata *ucl_object_toclosure(const ucl_object_t *obj);
#endif /* LUA_UCL_H_ */
diff --git a/include/ucl++.h b/include/ucl++.h
index fb63430d400d..215e61b3807e 100644
--- a/include/ucl++.h
+++ b/include/ucl++.h
@@ -37,57 +37,57 @@
namespace ucl {
-struct ucl_map_construct_t { };
+struct ucl_map_construct_t {};
constexpr ucl_map_construct_t ucl_map_construct = ucl_map_construct_t();
-struct ucl_array_construct_t { };
+struct ucl_array_construct_t {};
constexpr ucl_array_construct_t ucl_array_construct = ucl_array_construct_t();
class Ucl final {
private:
-
struct ucl_deleter {
- void operator() (ucl_object_t *obj) {
- ucl_object_unref (obj);
+ void operator()(ucl_object_t *obj)
+ {
+ ucl_object_unref(obj);
}
};
static int
- append_char (unsigned char c, size_t nchars, void *ud)
+ append_char(unsigned char c, size_t nchars, void *ud)
{
std::string *out = reinterpret_cast<std::string *>(ud);
- out->append (nchars, (char)c);
+ out->append(nchars, (char) c);
return nchars;
}
static int
- append_len (unsigned const char *str, size_t len, void *ud)
+ append_len(unsigned const char *str, size_t len, void *ud)
{
std::string *out = reinterpret_cast<std::string *>(ud);
- out->append ((const char *)str, len);
+ out->append((const char *) str, len);
return len;
}
static int
- append_int (int64_t elt, void *ud)
+ append_int(int64_t elt, void *ud)
{
std::string *out = reinterpret_cast<std::string *>(ud);
- auto nstr = std::to_string (elt);
+ auto nstr = std::to_string(elt);
- out->append (nstr);
+ out->append(nstr);
- return nstr.size ();
+ return nstr.size();
}
static int
- append_double (double elt, void *ud)
+ append_double(double elt, void *ud)
{
std::string *out = reinterpret_cast<std::string *>(ud);
- auto nstr = std::to_string (elt);
+ auto nstr = std::to_string(elt);
- out->append (nstr);
+ out->append(nstr);
- return nstr.size ();
+ return nstr.size();
}
static struct ucl_emitter_functions default_emit_funcs()
@@ -98,26 +98,25 @@ private:
Ucl::append_int,
Ucl::append_double,
nullptr,
- nullptr
- };
+ nullptr};
return func;
};
static bool ucl_variable_getter(const unsigned char *data, size_t len,
- unsigned char ** /*replace*/, size_t * /*replace_len*/, bool *need_free, void* ud)
+ unsigned char ** /*replace*/, size_t * /*replace_len*/, bool *need_free, void *ud)
{
*need_free = false;
auto vars = reinterpret_cast<std::set<std::string> *>(ud);
if (vars && data && len != 0) {
- vars->emplace (data, data + len);
+ vars->emplace(data, data + len);
}
return false;
}
- static bool ucl_variable_replacer (const unsigned char *data, size_t len,
- unsigned char **replace, size_t *replace_len, bool *need_free, void* ud)
+ static bool ucl_variable_replacer(const unsigned char *data, size_t len,
+ unsigned char **replace, size_t *replace_len, bool *need_free, void *ud)
{
*need_free = false;
@@ -126,89 +125,96 @@ private:
return false;
}
- std::string var_name (data, data + len);
- if (!replacer->is_variable (var_name)) {
+ std::string var_name(data, data + len);
+ if (!replacer->is_variable(var_name)) {
return false;
}
- std::string var_value = replacer->replace (var_name);
- if (var_value.empty ()) {
+ std::string var_value = replacer->replace(var_name);
+ if (var_value.empty()) {
return false;
- }
+ }
- *replace = (unsigned char *)UCL_ALLOC (var_value.size ());
- memcpy (*replace, var_value.data (), var_value.size ());
+ *replace = (unsigned char *) UCL_ALLOC(var_value.size());
+ memcpy(*replace, var_value.data(), var_value.size());
- *replace_len = var_value.size ();
+ *replace_len = var_value.size();
*need_free = true;
return true;
}
- template <typename C, typename P>
- static Ucl parse_with_strategy_function (C config_func, P parse_func, std::string &err)
+ template<typename C, typename P>
+ static Ucl parse_with_strategy_function(C config_func, P parse_func, std::string &err)
{
- auto parser = ucl_parser_new (UCL_PARSER_DEFAULT);
+ auto parser = ucl_parser_new(UCL_PARSER_DEFAULT);
- config_func (parser);
+ config_func(parser);
- if (!parse_func (parser)) {
- const char *error = ucl_parser_get_error (parser); //Assigning here without checking result first causes a
- if( error != NULL ) err.assign(error); // crash if ucl_parser_get_error returns NULL
- ucl_parser_free (parser);
+ if (!parse_func(parser)) {
+ const char *error = ucl_parser_get_error(parser);//Assigning here without checking result first causes a
+ if (error != NULL) err.assign(error); // crash if ucl_parser_get_error returns NULL
+ ucl_parser_free(parser);
return nullptr;
}
- auto obj = ucl_parser_get_object (parser);
- ucl_parser_free (parser);
+ auto obj = ucl_parser_get_object(parser);
+ ucl_parser_free(parser);
// Obj will handle ownership
- return Ucl (obj);
+ return Ucl(obj);
}
std::unique_ptr<ucl_object_t, ucl_deleter> obj;
public:
struct macro_handler_s {
- ucl_macro_handler handler;
+ ucl_macro_handler handler;
ucl_context_macro_handler ctx_handler;
};
struct macro_userdata_s {
- ucl_parser *parser;
- void *userdata;
+ ucl_parser *parser;
+ void *userdata;
};
class const_iterator {
private:
struct ucl_iter_deleter {
- void operator() (ucl_object_iter_t it) {
- ucl_object_iterate_free (it);
+ void operator()(ucl_object_iter_t it)
+ {
+ ucl_object_iterate_free(it);
}
};
std::shared_ptr<void> it;
std::unique_ptr<Ucl> cur;
+
public:
typedef std::forward_iterator_tag iterator_category;
- const_iterator(const Ucl &obj) {
- it = std::shared_ptr<void>(ucl_object_iterate_new (obj.obj.get()),
- ucl_iter_deleter());
- cur.reset (new Ucl(ucl_object_iterate_safe (it.get(), true)));
+ const_iterator(const Ucl &obj)
+ {
+ it = std::shared_ptr<void>(ucl_object_iterate_new(obj.obj.get()),
+ ucl_iter_deleter());
+ cur.reset(new Ucl(ucl_object_iterate_safe(it.get(), true)));
if (!cur->obj) {
- it.reset ();
- cur.reset ();
+ it.reset();
+ cur.reset();
}
}
- const_iterator() {}
+ const_iterator()
+ {
+ }
const_iterator(const const_iterator &other) = delete;
const_iterator(const_iterator &&other) = default;
- ~const_iterator() {}
+ ~const_iterator()
+ {
+ }
- const_iterator& operator=(const const_iterator &other) = delete;
- const_iterator& operator=(const_iterator &&other) = default;
+ const_iterator &operator=(const const_iterator &other) = delete;
+ const_iterator &operator=(const_iterator &&other) = default;
bool operator==(const const_iterator &other) const
{
@@ -224,135 +230,154 @@ public:
return !(*this == other);
}
- const_iterator& operator++()
+ const_iterator &operator++()
{
if (it) {
- cur.reset (new Ucl(ucl_object_iterate_safe (it.get(), true)));
+ cur.reset(new Ucl(ucl_object_iterate_safe(it.get(), true)));
}
if (cur && !cur->obj) {
- it.reset ();
- cur.reset ();
+ it.reset();
+ cur.reset();
}
return *this;
}
- const Ucl& operator*() const
+ const Ucl &operator*() const
{
return *cur;
}
- const Ucl* operator->() const
+ const Ucl *operator->() const
{
return cur.get();
}
};
struct variable_replacer {
- virtual ~variable_replacer() {}
+ virtual ~variable_replacer()
+ {
+ }
- virtual bool is_variable (const std::string &str) const
+ virtual bool is_variable(const std::string &str) const
{
- return !str.empty ();
+ return !str.empty();
}
- virtual std::string replace (const std::string &var) const = 0;
+ virtual std::string replace(const std::string &var) const = 0;
};
// We grab ownership if get non-const ucl_object_t
- Ucl(ucl_object_t *other) {
- obj.reset (other);
+ Ucl(ucl_object_t *other)
+ {
+ obj.reset(other);
}
// Shared ownership
- Ucl(const ucl_object_t *other) {
- obj.reset (ucl_object_ref (other));
+ Ucl(const ucl_object_t *other)
+ {
+ obj.reset(ucl_object_ref(other));
}
- Ucl(const Ucl &other) {
- obj.reset (ucl_object_ref (other.obj.get()));
+ Ucl(const Ucl &other)
+ {
+ obj.reset(ucl_object_ref(other.obj.get()));
}
- Ucl(Ucl &&other) {
- obj.swap (other.obj);
+ Ucl(Ucl &&other)
+ {
+ obj.swap(other.obj);
}
- Ucl() noexcept {
- obj.reset (ucl_object_typed_new (UCL_NULL));
+ Ucl() noexcept
+ {
+ obj.reset(ucl_object_typed_new(UCL_NULL));
}
- Ucl(std::nullptr_t) noexcept {
- obj.reset (ucl_object_typed_new (UCL_NULL));
+ Ucl(std::nullptr_t) noexcept
+ {
+ obj.reset(ucl_object_typed_new(UCL_NULL));
}
- Ucl(double value) {
- obj.reset (ucl_object_typed_new (UCL_FLOAT));
+ Ucl(double value)
+ {
+ obj.reset(ucl_object_typed_new(UCL_FLOAT));
obj->value.dv = value;
}
- Ucl(int64_t value) {
- obj.reset (ucl_object_typed_new (UCL_INT));
+ Ucl(int64_t value)
+ {
+ obj.reset(ucl_object_typed_new(UCL_INT));
obj->value.iv = value;
}
- Ucl(bool value) {
- obj.reset (ucl_object_typed_new (UCL_BOOLEAN));
+ Ucl(bool value)
+ {
+ obj.reset(ucl_object_typed_new(UCL_BOOLEAN));
obj->value.iv = static_cast<int64_t>(value);
}
- Ucl(const std::string &value) {
- obj.reset (ucl_object_fromstring_common (value.data (), value.size (),
- UCL_STRING_RAW));
+ Ucl(const std::string &value)
+ {
+ obj.reset(ucl_object_fromstring_common(value.data(), value.size(),
+ UCL_STRING_RAW));
}
- Ucl(const char *value) {
- obj.reset (ucl_object_fromstring_common (value, 0, UCL_STRING_RAW));
+ Ucl(const char *value)
+ {
+ obj.reset(ucl_object_fromstring_common(value, 0, UCL_STRING_RAW));
}
// Implicit constructor: anything with a to_json() function.
- template <class T, class = decltype(&T::to_ucl)>
- Ucl(const T &t) : Ucl(t.to_ucl()) {}
+ template<class T, class = decltype(&T::to_ucl)>
+ Ucl(const T &t)
+ : Ucl(t.to_ucl())
+ {
+ }
// Implicit constructor: map-like objects (std::map, std::unordered_map, etc)
- template <class M, typename std::enable_if<
- std::is_constructible<std::string, typename M::key_type>::value
- && std::is_constructible<Ucl, typename M::mapped_type>::value,
- int>::type = 0>
- Ucl(const M &m) {
- obj.reset (ucl_object_typed_new (UCL_OBJECT));
- auto cobj = obj.get ();
+ template<class M, typename std::enable_if<
+ std::is_constructible<std::string, typename M::key_type>::value && std::is_constructible<Ucl, typename M::mapped_type>::value,
+ int>::type = 0>
+ Ucl(const M &m)
+ {
+ obj.reset(ucl_object_typed_new(UCL_OBJECT));
+ auto cobj = obj.get();
- for (const auto &e : m) {
- ucl_object_insert_key (cobj, ucl_object_ref (e.second.obj.get()),
- e.first.data (), e.first.size (), true);
+ for (const auto &e: m) {
+ ucl_object_insert_key(cobj, ucl_object_ref(e.second.obj.get()),
+ e.first.data(), e.first.size(), true);
}
}
// Implicit constructor: vector-like objects (std::list, std::vector, std::set, etc)
- template <class V, typename std::enable_if<
- std::is_constructible<Ucl, typename V::value_type>::value,
- int>::type = 0>
- Ucl(const V &v) {
- obj.reset (ucl_object_typed_new (UCL_ARRAY));
- auto cobj = obj.get ();
+ template<class V, typename std::enable_if<
+ std::is_constructible<Ucl, typename V::value_type>::value,
+ int>::type = 0>
+ Ucl(const V &v)
+ {
+ obj.reset(ucl_object_typed_new(UCL_ARRAY));
+ auto cobj = obj.get();
- for (const auto &e : v) {
- ucl_array_append (cobj, ucl_object_ref (e.obj.get()));
+ for (const auto &e: v) {
+ ucl_array_append(cobj, ucl_object_ref(e.obj.get()));
}
}
- ucl_type_t type () const {
+ ucl_type_t type() const
+ {
if (obj) {
- return ucl_object_type (obj.get ());
+ return ucl_object_type(obj.get());
}
return UCL_NULL;
}
- std::string key () const {
+ std::string key() const
+ {
std::string res;
if (obj->key) {
- res.assign (obj->key, obj->keylen);
+ res.assign(obj->key, obj->keylen);
}
return res;
}
- double number_value (const double default_val = 0.0) const
+ double number_value(const double default_val = 0.0) const
{
double res;
@@ -363,7 +388,7 @@ public:
return default_val;
}
- int64_t int_value (const int64_t default_val = 0) const
+ int64_t int_value(const int64_t default_val = 0) const
{
int64_t res;
@@ -374,7 +399,7 @@ public:
return default_val;
}
- bool bool_value (const bool default_val = false) const
+ bool bool_value(const bool default_val = false) const
{
bool res;
@@ -385,9 +410,9 @@ public:
return default_val;
}
- std::string string_value (const std::string& default_val = "") const
+ std::string string_value(const std::string &default_val = "") const
{
- const char* res = nullptr;
+ const char *res = nullptr;
if (ucl_object_tostring_safe(obj.get(), &res)) {
return res;
@@ -396,35 +421,40 @@ public:
return default_val;
}
- size_t size () const
+ std::string forced_string_value() const
+ {
+ return ucl_object_tostring_forced(obj.get());
+ }
+
+ size_t size() const
{
- if (type () == UCL_ARRAY) {
- return ucl_array_size (obj.get());
+ if (type() == UCL_ARRAY) {
+ return ucl_array_size(obj.get());
}
return 0;
}
- Ucl at (size_t i) const
+ Ucl at(size_t i) const
{
- if (type () == UCL_ARRAY) {
- return Ucl (ucl_array_find_index (obj.get(), i));
+ if (type() == UCL_ARRAY) {
+ return Ucl(ucl_array_find_index(obj.get(), i));
}
- return Ucl (nullptr);
+ return Ucl(nullptr);
}
- Ucl lookup (const std::string &key) const
+ Ucl lookup(const std::string &key) const
{
- if (type () == UCL_OBJECT) {
- return Ucl (ucl_object_lookup_len (obj.get(),
- key.data (), key.size ()));
+ if (type() == UCL_OBJECT) {
+ return Ucl(ucl_object_lookup_len(obj.get(),
+ key.data(), key.size()));
}
- return Ucl (nullptr);
+ return Ucl(nullptr);
}
- inline Ucl operator[] (size_t i) const
+ inline Ucl operator[](size_t i) const
{
return at(i);
}
@@ -434,285 +464,297 @@ public:
return lookup(key);
}
// Serialize.
- void dump (std::string &out, ucl_emitter_t type = UCL_EMIT_JSON) const
+ void dump(std::string &out, ucl_emitter_t type = UCL_EMIT_JSON) const
{
struct ucl_emitter_functions cbdata;
cbdata = Ucl::default_emit_funcs();
cbdata.ud = reinterpret_cast<void *>(&out);
- ucl_object_emit_full (obj.get(), type, &cbdata, nullptr);
+ ucl_object_emit_full(obj.get(), type, &cbdata, nullptr);
}
- std::string dump (ucl_emitter_t type = UCL_EMIT_JSON) const
+ std::string dump(ucl_emitter_t type = UCL_EMIT_JSON) const
{
std::string out;
- dump (out, type);
+ dump(out, type);
return out;
}
- static Ucl parse (const std::string &in, std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const std::string &in, std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
- return parse (in, std::map<std::string, std::string>(), err, duplicate_strategy);
+ return parse(in, std::map<std::string, std::string>(), err, duplicate_strategy);
}
- static Ucl parse (const std::string &in, const std::map<std::string, std::string> &vars,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const std::string &in, const std::map<std::string, std::string> &vars,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
- std::vector< std::tuple< std::string, macro_handler_s, void * > > emptyVector;
- return parse ( in, vars, emptyVector, err, duplicate_strategy );
+ std::vector<std::tuple<std::string, macro_handler_s, void *>> emptyVector;
+ return parse(in, vars, emptyVector, err, duplicate_strategy);
}
//Macro handler will receive a macro_userdata_s as void *ud
- static Ucl parse (const std::string &in,
- std::vector< std::tuple< std::string /*name*/, macro_handler_s, void * /*userdata*/ > > &macros,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const std::string &in,
+ std::vector<std::tuple<std::string /*name*/, macro_handler_s, void * /*userdata*/>> &macros,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
- return parse (in, std::map<std::string, std::string>(), macros, err, duplicate_strategy);
+ return parse(in, std::map<std::string, std::string>(), macros, err, duplicate_strategy);
}
//Macro handler will receive a macro_userdata_s as void *ud
- static Ucl parse (const std::string &in, const std::map<std::string, std::string> &vars,
- std::vector< std::tuple< std::string /*name*/, macro_handler_s, void * /*userdata*/ > > &macros,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const std::string &in, const std::map<std::string, std::string> &vars,
+ std::vector<std::tuple<std::string /*name*/, macro_handler_s, void * /*userdata*/>> &macros,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
//Preserve macro_userdata_s memory for later use in parse_with_strategy_function()
std::vector<macro_userdata_s> userdata_list;
- userdata_list.reserve (macros.size());
- auto config_func = [&userdata_list, &vars, &macros] (ucl_parser *parser) {
- for (const auto & item : vars) {
- ucl_parser_register_variable (parser, item.first.c_str (), item.second.c_str ());
+ userdata_list.reserve(macros.size());
+ auto config_func = [&userdata_list, &vars, &macros](ucl_parser *parser) {
+ for (const auto &item: vars) {
+ ucl_parser_register_variable(parser, item.first.c_str(), item.second.c_str());
}
- for (auto & macro : macros) {
- userdata_list.push_back ({parser, std::get<2>(macro)});
+ for (auto &macro: macros) {
+ userdata_list.push_back({parser, std::get<2>(macro)});
if (std::get<1>(macro).handler != NULL) {
- ucl_parser_register_macro (parser,
- std::get<0>(macro).c_str(),
- std::get<1>(macro).handler,
- reinterpret_cast<void*>(&userdata_list.back()));
+ ucl_parser_register_macro(parser,
+ std::get<0>(macro).c_str(),
+ std::get<1>(macro).handler,
+ reinterpret_cast<void *>(&userdata_list.back()));
}
else if (std::get<1>(macro).ctx_handler != NULL) {
- ucl_parser_register_context_macro (parser,
- std::get<0>(macro).c_str(),
- std::get<1>(macro).ctx_handler,
- reinterpret_cast<void*>(&userdata_list.back()));
+ ucl_parser_register_context_macro(parser,
+ std::get<0>(macro).c_str(),
+ std::get<1>(macro).ctx_handler,
+ reinterpret_cast<void *>(&userdata_list.back()));
}
}
};
- auto parse_func = [&in, &duplicate_strategy] (struct ucl_parser *parser) -> bool {
- return ucl_parser_add_chunk_full (parser,
- (unsigned char *) in.data (),
- in.size (),
- (unsigned int)ucl_parser_get_default_priority (parser),
- duplicate_strategy,
- UCL_PARSE_UCL);
+ auto parse_func = [&in, &duplicate_strategy](struct ucl_parser *parser) -> bool {
+ return ucl_parser_add_chunk_full(parser,
+ (unsigned char *) in.data(),
+ in.size(),
+ (unsigned int) ucl_parser_get_default_priority(parser),
+ duplicate_strategy,
+ UCL_PARSE_UCL);
};
- return parse_with_strategy_function (config_func, parse_func, err);
+ return parse_with_strategy_function(config_func, parse_func, err);
}
- static Ucl parse (const std::string &in, const variable_replacer &replacer,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const std::string &in, const variable_replacer &replacer,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
- std::vector< std::tuple< std::string, macro_handler_s, void * > > emptyVector;
- return parse ( in, replacer, emptyVector, err, duplicate_strategy );
+ std::vector<std::tuple<std::string, macro_handler_s, void *>> emptyVector;
+ return parse(in, replacer, emptyVector, err, duplicate_strategy);
}
//Macro handler will receive a macro_userdata_s as void *ud
- static Ucl parse (const std::string &in, const variable_replacer &replacer,
- std::vector< std::tuple< std::string /*name*/, macro_handler_s, void * /*userdata*/ > > &macros,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const std::string &in, const variable_replacer &replacer,
+ std::vector<std::tuple<std::string /*name*/, macro_handler_s, void * /*userdata*/>> &macros,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
//Preserve macro_userdata_s memory for later use in parse_with_strategy_function()
std::vector<macro_userdata_s> userdata_list;
- userdata_list.reserve (macros.size());
- auto config_func = [&userdata_list, &replacer, &macros] (ucl_parser *parser) {
- ucl_parser_set_variables_handler (parser, ucl_variable_replacer, &const_cast<variable_replacer &>(replacer));
- for (auto & macro : macros) {
- userdata_list.push_back ({parser, std::get<2>(macro)});
+ userdata_list.reserve(macros.size());
+ auto config_func = [&userdata_list, &replacer, &macros](ucl_parser *parser) {
+ ucl_parser_set_variables_handler(parser, ucl_variable_replacer, &const_cast<variable_replacer &>(replacer));
+ for (auto &macro: macros) {
+ userdata_list.push_back({parser, std::get<2>(macro)});
if (std::get<1>(macro).handler != NULL) {
- ucl_parser_register_macro (parser,
- std::get<0>(macro).c_str(),
- std::get<1>(macro).handler,
- reinterpret_cast<void*>(&userdata_list.back()));
+ ucl_parser_register_macro(parser,
+ std::get<0>(macro).c_str(),
+ std::get<1>(macro).handler,
+ reinterpret_cast<void *>(&userdata_list.back()));
}
else if (std::get<1>(macro).ctx_handler != NULL) {
- ucl_parser_register_context_macro (parser,
- std::get<0>(macro).c_str(),
- std::get<1>(macro).ctx_handler,
- reinterpret_cast<void*>(&userdata_list.back()));
+ ucl_parser_register_context_macro(parser,
+ std::get<0>(macro).c_str(),
+ std::get<1>(macro).ctx_handler,
+ reinterpret_cast<void *>(&userdata_list.back()));
}
}
};
- auto parse_func = [&in, &duplicate_strategy] (struct ucl_parser *parser) -> bool {
- return ucl_parser_add_chunk_full (parser,
- (unsigned char *) in.data (),
- in.size (),
- (unsigned int)ucl_parser_get_default_priority (parser),
- duplicate_strategy,
- UCL_PARSE_UCL);
+ auto parse_func = [&in, &duplicate_strategy](struct ucl_parser *parser) -> bool {
+ return ucl_parser_add_chunk_full(parser,
+ (unsigned char *) in.data(),
+ in.size(),
+ (unsigned int) ucl_parser_get_default_priority(parser),
+ duplicate_strategy,
+ UCL_PARSE_UCL);
};
- return parse_with_strategy_function (config_func, parse_func, err);
+ return parse_with_strategy_function(config_func, parse_func, err);
}
- static Ucl parse (const char *in, std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const char *in, std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
- return parse (in, std::map<std::string, std::string>(), err, duplicate_strategy);
+ return parse(in, std::map<std::string, std::string>(), err, duplicate_strategy);
}
- static Ucl parse (const char *in, const std::map<std::string, std::string> &vars, std::string &err)
+ static Ucl parse(const char *in, const std::map<std::string, std::string> &vars, std::string &err)
{
if (!in) {
err = "null input";
return nullptr;
}
- return parse (std::string (in), vars, err);
+ return parse(std::string(in), vars, err);
}
//Macro handler will receive a macro_userdata_s as void *ud
- static Ucl parse (const char *in,
- std::vector< std::tuple< std::string /*name*/, macro_handler_s, void * /*userdata*/ > > &macros,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const char *in,
+ std::vector<std::tuple<std::string /*name*/, macro_handler_s, void * /*userdata*/>> &macros,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
- return parse (in, std::map<std::string, std::string>(), macros, err, duplicate_strategy);
+ return parse(in, std::map<std::string, std::string>(), macros, err, duplicate_strategy);
}
//Macro handler will receive a macro_userdata_s as void *ud
- static Ucl parse (const char *in, const std::map<std::string, std::string> &vars,
- std::vector< std::tuple< std::string /*name*/, macro_handler_s, void * /*userdata*/ > > &macros,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const char *in, const std::map<std::string, std::string> &vars,
+ std::vector<std::tuple<std::string /*name*/, macro_handler_s, void * /*userdata*/>> &macros,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
if (!in) {
err = "null input";
return nullptr;
}
- return parse (std::string (in), vars, macros, err, duplicate_strategy);
+ return parse(std::string(in), vars, macros, err, duplicate_strategy);
}
- static Ucl parse (const char *in, const variable_replacer &replacer,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const char *in, const variable_replacer &replacer,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
if (!in) {
err = "null input";
return nullptr;
}
- return parse (std::string(in), replacer, err, duplicate_strategy);
+ return parse(std::string(in), replacer, err, duplicate_strategy);
}
//Macro handler will receive a macro_userdata_s as void *ud
- static Ucl parse (const char *in, const variable_replacer &replacer,
- std::vector< std::tuple< std::string /*name*/, macro_handler_s, void * /*userdata*/ > > &macros,
- std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
+ static Ucl parse(const char *in, const variable_replacer &replacer,
+ std::vector<std::tuple<std::string /*name*/, macro_handler_s, void * /*userdata*/>> &macros,
+ std::string &err, enum ucl_duplicate_strategy duplicate_strategy = UCL_DUPLICATE_APPEND)
{
if (!in) {
err = "null input";
return nullptr;
}
- return parse (std::string (in), replacer, macros, err, duplicate_strategy);
+ return parse(std::string(in), replacer, macros, err, duplicate_strategy);
}
- static Ucl parse_from_file (const std::string &filename, std::string &err)
+ static Ucl parse_from_file(const std::string &filename, std::string &err)
{
- return parse_from_file (filename, std::map<std::string, std::string>(), err);
+ return parse_from_file(filename, std::map<std::string, std::string>(), err);
}
- static Ucl parse_from_file (const std::string &filename, const std::map<std::string, std::string> &vars, std::string &err)
+ static Ucl parse_from_file(const std::string &filename, const std::map<std::string, std::string> &vars, std::string &err)
{
- auto config_func = [&vars] (ucl_parser *parser) {
- for (const auto & item : vars) {
- ucl_parser_register_variable (parser, item.first.c_str (), item.second.c_str ());
- }
+ auto config_func = [&vars](ucl_parser *parser) {
+ for (const auto &item: vars) {
+ ucl_parser_register_variable(parser, item.first.c_str(), item.second.c_str());
+ }
};
- auto parse_func = [&filename] (ucl_parser *parser) {
- return ucl_parser_add_file (parser, filename.c_str ());
+ auto parse_func = [&filename](ucl_parser *parser) {
+ return ucl_parser_add_file(parser, filename.c_str());
};
- return parse_with_strategy_function (config_func, parse_func, err);
+ return parse_with_strategy_function(config_func, parse_func, err);
}
- static Ucl parse_from_file (const std::string &filename, const variable_replacer &replacer, std::string &err)
+ static Ucl parse_from_file(const std::string &filename, const variable_replacer &replacer, std::string &err)
{
- auto config_func = [&replacer] (ucl_parser *parser) {
- ucl_parser_set_variables_handler (parser, ucl_variable_replacer,
- &const_cast<variable_replacer &>(replacer));
+ auto config_func = [&replacer](ucl_parser *parser) {
+ ucl_parser_set_variables_handler(parser, ucl_variable_replacer,
+ &const_cast<variable_replacer &>(replacer));
};
- auto parse_func = [&filename] (ucl_parser *parser) {
- return ucl_parser_add_file (parser, filename.c_str ());
+ auto parse_func = [&filename](ucl_parser *parser) {
+ return ucl_parser_add_file(parser, filename.c_str());
};
- return parse_with_strategy_function (config_func, parse_func, err);
+ return parse_with_strategy_function(config_func, parse_func, err);
}
- static std::vector<std::string> find_variable (const std::string &in)
+ static std::vector<std::string> find_variable(const std::string &in)
{
- auto parser = ucl_parser_new (UCL_PARSER_DEFAULT);
+ auto parser = ucl_parser_new(UCL_PARSER_DEFAULT);
std::set<std::string> vars;
- ucl_parser_set_variables_handler (parser, ucl_variable_getter, &vars);
- ucl_parser_add_chunk (parser, (const unsigned char *)in.data (), in.size ());
- ucl_parser_free (parser);
+ ucl_parser_set_variables_handler(parser, ucl_variable_getter, &vars);
+ ucl_parser_add_chunk(parser, (const unsigned char *) in.data(), in.size());
+ ucl_parser_free(parser);
std::vector<std::string> result;
- std::move (vars.begin (), vars.end (), std::back_inserter (result));
+ std::move(vars.begin(), vars.end(), std::back_inserter(result));
return result;
}
- static std::vector<std::string> find_variable (const char *in)
+ static std::vector<std::string> find_variable(const char *in)
{
if (!in) {
return std::vector<std::string>();
}
- return find_variable (std::string (in));
+ return find_variable(std::string(in));
}
- static std::vector<std::string> find_variable_from_file (const std::string &filename)
+ static std::vector<std::string> find_variable_from_file(const std::string &filename)
{
- auto parser = ucl_parser_new (UCL_PARSER_DEFAULT);
+ auto parser = ucl_parser_new(UCL_PARSER_DEFAULT);
std::set<std::string> vars;
- ucl_parser_set_variables_handler (parser, ucl_variable_getter, &vars);
- ucl_parser_add_file (parser, filename.c_str ());
- ucl_parser_free (parser);
+ ucl_parser_set_variables_handler(parser, ucl_variable_getter, &vars);
+ ucl_parser_add_file(parser, filename.c_str());
+ ucl_parser_free(parser);
std::vector<std::string> result;
- std::move (vars.begin (), vars.end (), std::back_inserter (result));
+ std::move(vars.begin(), vars.end(), std::back_inserter(result));
return result;
}
- Ucl& operator= (Ucl rhs)
+ Ucl &operator=(Ucl rhs)
{
- obj.swap (rhs.obj);
+ obj.swap(rhs.obj);
return *this;
}
- bool operator== (const Ucl &rhs) const
+ bool operator==(const Ucl &rhs) const
+ {
+ return ucl_object_compare(obj.get(), rhs.obj.get()) == 0;
+ }
+ bool operator<(const Ucl &rhs) const
+ {
+ return ucl_object_compare(obj.get(), rhs.obj.get()) < 0;
+ }
+ bool operator!=(const Ucl &rhs) const
{
- return ucl_object_compare (obj.get(), rhs.obj.get ()) == 0;
+ return !(*this == rhs);
}
- bool operator< (const Ucl &rhs) const
+ bool operator<=(const Ucl &rhs) const
{
- return ucl_object_compare (obj.get(), rhs.obj.get ()) < 0;
+ return !(rhs < *this);
+ }
+ bool operator>(const Ucl &rhs) const
+ {
+ return (rhs < *this);
+ }
+ bool operator>=(const Ucl &rhs) const
+ {
+ return !(*this < rhs);
}
- bool operator!= (const Ucl &rhs) const { return !(*this == rhs); }
- bool operator<= (const Ucl &rhs) const { return !(rhs < *this); }
- bool operator> (const Ucl &rhs) const { return (rhs < *this); }
- bool operator>= (const Ucl &rhs) const { return !(*this < rhs); }
- explicit operator bool () const
+ explicit operator bool() const
{
if (!obj || type() == UCL_NULL) {
return false;
}
- if (type () == UCL_BOOLEAN) {
- return bool_value ();
+ if (type() == UCL_BOOLEAN) {
+ return bool_value();
}
return true;
@@ -736,4 +778,4 @@ public:
}
};
-};
+};// namespace ucl
diff --git a/include/ucl.h b/include/ucl.h
index b8625b9fce2f..96ddaa9cb987 100644
--- a/include/ucl.h
+++ b/include/ucl.h
@@ -33,9 +33,9 @@
#include <stdio.h>
#ifdef _WIN32
-# define UCL_EXTERN __declspec(dllexport)
+#define UCL_EXTERN __declspec(dllexport)
#else
-# define UCL_EXTERN
+#define UCL_EXTERN
#endif
/**
@@ -58,7 +58,7 @@
* JSON with less strict rules that make it more comfortable for
* using as a configuration language
*/
-#ifdef __cplusplus
+#ifdef __cplusplus
extern "C" {
#endif
/*
@@ -73,16 +73,29 @@ extern "C" {
#ifndef UCL_FREE
#define UCL_FREE(size, ptr) free(ptr)
#endif
+#ifndef UCL_REALLOC
+#define UCL_REALLOC(ptr, size) realloc(ptr, size)
+#endif
+#ifndef UCL_STRDUP
+static inline char *ucl_strdup_impl(const char *s)
+{
+ size_t len = strlen(s) + 1;
+ char *p = (char *) UCL_ALLOC(len);
+ if (p) memcpy(p, s, len);
+ return p;
+}
+#define UCL_STRDUP(str) ucl_strdup_impl(str)
+#endif
-#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
-#define UCL_WARN_UNUSED_RESULT \
- __attribute__((warn_unused_result))
+#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
+#define UCL_WARN_UNUSED_RESULT \
+ __attribute__((warn_unused_result))
#else
#define UCL_WARN_UNUSED_RESULT
#endif
#ifdef __GNUC__
-#define UCL_DEPRECATED(func) func __attribute__ ((deprecated))
+#define UCL_DEPRECATED(func) func __attribute__((deprecated))
#elif defined(_MSC_VER)
#define UCL_DEPRECATED(func) __declspec(deprecated) func
#else
@@ -100,16 +113,16 @@ extern "C" {
* The common error codes returned by ucl parser
*/
typedef enum ucl_error {
- UCL_EOK = 0, /**< No error */
- UCL_ESYNTAX, /**< Syntax error occurred during parsing */
- UCL_EIO, /**< IO error occurred during parsing */
- UCL_ESTATE, /**< Invalid state machine state */
- UCL_ENESTED, /**< Input has too many recursion levels */
+ UCL_EOK = 0, /**< No error */
+ UCL_ESYNTAX, /**< Syntax error occurred during parsing */
+ UCL_EIO, /**< IO error occurred during parsing */
+ UCL_ESTATE, /**< Invalid state machine state */
+ UCL_ENESTED, /**< Input has too many recursion levels */
UCL_EUNPAIRED, /**< Input has too many recursion levels */
- UCL_EMACRO, /**< Error processing a macro */
+ UCL_EMACRO, /**< Error processing a macro */
UCL_EINTERNAL, /**< Internal unclassified error */
- UCL_ESSL, /**< SSL error */
- UCL_EMERGE /**< A merge error occurred */
+ UCL_ESSL, /**< SSL error */
+ UCL_EMERGE /**< A merge error occurred */
} ucl_error_t;
/**
@@ -120,26 +133,26 @@ typedef enum ucl_error {
*/
typedef enum ucl_type {
UCL_OBJECT = 0, /**< UCL object - key/value pairs */
- UCL_ARRAY, /**< UCL array */
- UCL_INT, /**< Integer number */
- UCL_FLOAT, /**< Floating point number */
- UCL_STRING, /**< Null terminated string */
- UCL_BOOLEAN, /**< Boolean value */
- UCL_TIME, /**< Time value (floating point number of seconds) */
- UCL_USERDATA, /**< Opaque userdata pointer (may be used in macros) */
- UCL_NULL /**< Null value */
+ UCL_ARRAY, /**< UCL array */
+ UCL_INT, /**< Integer number */
+ UCL_FLOAT, /**< Floating point number */
+ UCL_STRING, /**< Null terminated string */
+ UCL_BOOLEAN, /**< Boolean value */
+ UCL_TIME, /**< Time value (floating point number of seconds) */
+ UCL_USERDATA, /**< Opaque userdata pointer (may be used in macros) */
+ UCL_NULL /**< Null value */
} ucl_type_t;
/**
* You can use one of these types to serialise #ucl_object_t by using ucl_object_emit().
*/
typedef enum ucl_emitter {
- UCL_EMIT_JSON = 0, /**< Emit fine formatted JSON */
+ UCL_EMIT_JSON = 0, /**< Emit fine formatted JSON */
UCL_EMIT_JSON_COMPACT, /**< Emit compacted JSON */
- UCL_EMIT_CONFIG, /**< Emit human readable config format */
- UCL_EMIT_YAML, /**< Emit embedded YAML format */
- UCL_EMIT_MSGPACK, /**< Emit msgpack output */
- UCL_EMIT_MAX /**< Unsupported emitter type */
+ UCL_EMIT_CONFIG, /**< Emit human readable config format */
+ UCL_EMIT_YAML, /**< Emit embedded YAML format */
+ UCL_EMIT_MSGPACK, /**< Emit msgpack output */
+ UCL_EMIT_MAX /**< Unsupported emitter type */
} ucl_emitter_t;
/**
@@ -149,32 +162,32 @@ typedef enum ucl_emitter {
* UCL still has to perform copying implicitly.
*/
typedef enum ucl_parser_flags {
- UCL_PARSER_DEFAULT = 0, /**< No special flags */
- UCL_PARSER_KEY_LOWERCASE = (1 << 0), /**< Convert all keys to lower case */
- UCL_PARSER_ZEROCOPY = (1 << 1), /**< Parse input in zero-copy mode if possible */
- UCL_PARSER_NO_TIME = (1 << 2), /**< Do not parse time and treat time values as strings */
+ UCL_PARSER_DEFAULT = 0, /**< No special flags */
+ UCL_PARSER_KEY_LOWERCASE = (1 << 0), /**< Convert all keys to lower case */
+ UCL_PARSER_ZEROCOPY = (1 << 1), /**< Parse input in zero-copy mode if possible */
+ UCL_PARSER_NO_TIME = (1 << 2), /**< Do not parse time and treat time values as strings */
UCL_PARSER_NO_IMPLICIT_ARRAYS = (1 << 3), /** Create explicit arrays instead of implicit ones */
- UCL_PARSER_SAVE_COMMENTS = (1 << 4), /** Save comments in the parser context */
- UCL_PARSER_DISABLE_MACRO = (1 << 5), /** Treat macros as comments */
- UCL_PARSER_NO_FILEVARS = (1 << 6) /** Do not set file vars */
+ UCL_PARSER_SAVE_COMMENTS = (1 << 4), /** Save comments in the parser context */
+ UCL_PARSER_DISABLE_MACRO = (1 << 5), /** Treat macros as comments */
+ UCL_PARSER_NO_FILEVARS = (1 << 6) /** Do not set file vars */
} ucl_parser_flags_t;
/**
* String conversion flags, that are used in #ucl_object_fromstring_common function.
*/
typedef enum ucl_string_flags {
- UCL_STRING_RAW = 0x0, /**< Treat string as is */
- UCL_STRING_ESCAPE = (1 << 0), /**< Perform JSON escape */
- UCL_STRING_TRIM = (1 << 1), /**< Trim leading and trailing whitespaces */
- UCL_STRING_PARSE_BOOLEAN = (1 << 2), /**< Parse passed string and detect boolean */
- UCL_STRING_PARSE_INT = (1 << 3), /**< Parse passed string and detect integer number */
- UCL_STRING_PARSE_DOUBLE = (1 << 4), /**< Parse passed string and detect integer or float number */
- UCL_STRING_PARSE_TIME = (1 << 5), /**< Parse time strings */
- UCL_STRING_PARSE_NUMBER = UCL_STRING_PARSE_INT|UCL_STRING_PARSE_DOUBLE|UCL_STRING_PARSE_TIME, /**<
+ UCL_STRING_RAW = 0x0, /**< Treat string as is */
+ UCL_STRING_ESCAPE = (1 << 0), /**< Perform JSON escape */
+ UCL_STRING_TRIM = (1 << 1), /**< Trim leading and trailing whitespaces */
+ UCL_STRING_PARSE_BOOLEAN = (1 << 2), /**< Parse passed string and detect boolean */
+ UCL_STRING_PARSE_INT = (1 << 3), /**< Parse passed string and detect integer number */
+ UCL_STRING_PARSE_DOUBLE = (1 << 4), /**< Parse passed string and detect integer or float number */
+ UCL_STRING_PARSE_TIME = (1 << 5), /**< Parse time strings */
+ UCL_STRING_PARSE_NUMBER = UCL_STRING_PARSE_INT | UCL_STRING_PARSE_DOUBLE | UCL_STRING_PARSE_TIME, /**<
Parse passed string and detect number */
- UCL_STRING_PARSE = UCL_STRING_PARSE_BOOLEAN|UCL_STRING_PARSE_NUMBER, /**<
+ UCL_STRING_PARSE = UCL_STRING_PARSE_BOOLEAN | UCL_STRING_PARSE_NUMBER, /**<
Parse passed string (and detect booleans and numbers) */
- UCL_STRING_PARSE_BYTES = (1 << 6) /**< Treat numbers as bytes */
+ UCL_STRING_PARSE_BYTES = (1 << 6) /**< Treat numbers as bytes */
} ucl_string_flags_t;
/**
@@ -182,15 +195,15 @@ typedef enum ucl_string_flags {
* for priorities)
*/
typedef enum ucl_object_flags {
- UCL_OBJECT_ALLOCATED_KEY = (1 << 0), /**< An object has key allocated internally */
+ UCL_OBJECT_ALLOCATED_KEY = (1 << 0), /**< An object has key allocated internally */
UCL_OBJECT_ALLOCATED_VALUE = (1 << 1), /**< An object has a string value allocated internally */
UCL_OBJECT_NEED_KEY_ESCAPE = (1 << 2), /**< The key of an object need to be escaped on output */
- UCL_OBJECT_EPHEMERAL = (1 << 3), /**< Temporary object that does not need to be freed really */
- UCL_OBJECT_MULTILINE = (1 << 4), /**< String should be displayed as multiline string */
- UCL_OBJECT_MULTIVALUE = (1 << 5), /**< Object is a key with multiple values */
- UCL_OBJECT_INHERITED = (1 << 6), /**< Object has been inherited from another */
- UCL_OBJECT_BINARY = (1 << 7), /**< Object contains raw binary data */
- UCL_OBJECT_SQUOTED = (1 << 8) /**< Object has been enclosed in single quotes */
+ UCL_OBJECT_EPHEMERAL = (1 << 3), /**< Temporary object that does not need to be freed really */
+ UCL_OBJECT_MULTILINE = (1 << 4), /**< String should be displayed as multiline string */
+ UCL_OBJECT_MULTIVALUE = (1 << 5), /**< Object is a key with multiple values */
+ UCL_OBJECT_INHERITED = (1 << 6), /**< Object has been inherited from another */
+ UCL_OBJECT_BINARY = (1 << 7), /**< Object contains raw binary data */
+ UCL_OBJECT_SQUOTED = (1 << 8) /**< Object has been enclosed in single quotes */
} ucl_object_flags_t;
/**
@@ -198,9 +211,9 @@ typedef enum ucl_object_flags {
*/
enum ucl_duplicate_strategy {
UCL_DUPLICATE_APPEND = 0, /**< Default policy to merge based on priorities */
- UCL_DUPLICATE_MERGE, /**< Merge new object with old one */
- UCL_DUPLICATE_REWRITE, /**< Rewrite old keys */
- UCL_DUPLICATE_ERROR /**< Stop parsing on duplicate found */
+ UCL_DUPLICATE_MERGE, /**< Merge new object with old one */
+ UCL_DUPLICATE_REWRITE, /**< Rewrite old keys */
+ UCL_DUPLICATE_ERROR /**< Stop parsing on duplicate found */
};
/**
@@ -209,8 +222,8 @@ enum ucl_duplicate_strategy {
enum ucl_parse_type {
UCL_PARSE_UCL = 0, /**< Default ucl format */
UCL_PARSE_MSGPACK, /**< Message pack input format */
- UCL_PARSE_CSEXP, /**< Canonical S-expressions */
- UCL_PARSE_AUTO /**< Try to detect parse type */
+ UCL_PARSE_CSEXP, /**< Canonical S-expressions */
+ UCL_PARSE_AUTO /**< Try to detect parse type */
};
/**
@@ -222,22 +235,22 @@ typedef struct ucl_object_s {
* Variant value type
*/
union {
- int64_t iv; /**< Int value of an object */
- const char *sv; /**< String value of an object */
- double dv; /**< Double value of an object */
- void *av; /**< Array */
- void *ov; /**< Object */
- void* ud; /**< Opaque user data */
+ int64_t iv; /**< Int value of an object */
+ const char *sv; /**< String value of an object */
+ double dv; /**< Double value of an object */
+ void *av; /**< Array */
+ void *ov; /**< Object */
+ void *ud; /**< Opaque user data */
} value;
- const char *key; /**< Key of an object */
- struct ucl_object_s *next; /**< Array handle */
- struct ucl_object_s *prev; /**< Array handle */
- uint32_t keylen; /**< Length of a key */
- uint32_t len; /**< Size of an object */
- uint32_t ref; /**< Reference count */
- uint16_t flags; /**< Object flags */
- uint16_t type; /**< Real type */
- unsigned char* trash_stack[2]; /**< Pointer to allocated chunks */
+ const char *key; /**< Key of an object */
+ struct ucl_object_s *next; /**< Array handle */
+ struct ucl_object_s *prev; /**< Array handle */
+ uint32_t keylen; /**< Length of a key */
+ uint32_t len; /**< Size of an object */
+ uint32_t ref; /**< Reference count */
+ uint16_t flags; /**< Object flags */
+ uint16_t type; /**< Real type */
+ unsigned char *trash_stack[2]; /**< Pointer to allocated chunks */
} ucl_object_t;
/**
@@ -245,7 +258,7 @@ typedef struct ucl_object_s {
* @param ud user specified data pointer
*/
typedef void (*ucl_userdata_dtor)(void *ud);
-typedef const char* (*ucl_userdata_emitter)(void *ud);
+typedef const char *(*ucl_userdata_emitter)(void *ud);
/** @} */
@@ -260,27 +273,27 @@ typedef const char* (*ucl_userdata_emitter)(void *ud);
* @param obj CL object
* @return zero terminated key
*/
-UCL_EXTERN char* ucl_copy_key_trash (const ucl_object_t *obj);
+UCL_EXTERN char *ucl_copy_key_trash(const ucl_object_t *obj);
/**
* Copy and return a string value of an object, returned key is zero-terminated
* @param obj CL object
* @return zero terminated string representation of object value
*/
-UCL_EXTERN char* ucl_copy_value_trash (const ucl_object_t *obj);
+UCL_EXTERN char *ucl_copy_value_trash(const ucl_object_t *obj);
/**
* Creates a new object
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_new (void) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_new(void) UCL_WARN_UNUSED_RESULT;
/**
* Create new object with type specified
* @param type type of a new object
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_typed_new (ucl_type_t type) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_typed_new(ucl_type_t type) UCL_WARN_UNUSED_RESULT;
/**
* Create new object with type and priority specified
@@ -288,7 +301,7 @@ UCL_EXTERN ucl_object_t* ucl_object_typed_new (ucl_type_t type) UCL_WARN_UNUSED_
* @param priority priority of an object
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_new_full (ucl_type_t type, unsigned priority)
+UCL_EXTERN ucl_object_t *ucl_object_new_full(ucl_type_t type, unsigned priority)
UCL_WARN_UNUSED_RESULT;
/**
@@ -298,29 +311,29 @@ UCL_EXTERN ucl_object_t* ucl_object_new_full (ucl_type_t type, unsigned priority
* @param ptr opaque pointer
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_new_userdata (ucl_userdata_dtor dtor,
- ucl_userdata_emitter emitter, void *ptr) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_new_userdata(ucl_userdata_dtor dtor,
+ ucl_userdata_emitter emitter, void *ptr) UCL_WARN_UNUSED_RESULT;
/**
* Perform deep copy of an object copying everything
* @param other object to copy
* @return new object with refcount equal to 1
*/
-UCL_EXTERN ucl_object_t * ucl_object_copy (const ucl_object_t *other)
+UCL_EXTERN ucl_object_t *ucl_object_copy(const ucl_object_t *other)
UCL_WARN_UNUSED_RESULT;
/**
* Return the type of an object
* @return the object type
*/
-UCL_EXTERN ucl_type_t ucl_object_type (const ucl_object_t *obj);
+UCL_EXTERN ucl_type_t ucl_object_type(const ucl_object_t *obj);
/**
* Converts ucl object type to its string representation
* @param type type of object
* @return constant string describing type
*/
-UCL_EXTERN const char * ucl_object_type_to_string (ucl_type_t type);
+UCL_EXTERN const char *ucl_object_type_to_string(ucl_type_t type);
/**
* Converts string that represents ucl type to real ucl type enum
@@ -328,7 +341,7 @@ UCL_EXTERN const char * ucl_object_type_to_string (ucl_type_t type);
* @param res resulting target
* @return true if `input` is a name of type stored in `res`
*/
-UCL_EXTERN bool ucl_object_string_to_type (const char *input, ucl_type_t *res);
+UCL_EXTERN bool ucl_object_string_to_type(const char *input, ucl_type_t *res);
/**
* Convert any string to an ucl object making the specified transformations
@@ -337,15 +350,15 @@ UCL_EXTERN bool ucl_object_string_to_type (const char *input, ucl_type_t *res);
* @param flags conversion flags
* @return new object
*/
-UCL_EXTERN ucl_object_t * ucl_object_fromstring_common (const char *str, size_t len,
- enum ucl_string_flags flags) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_fromstring_common(const char *str, size_t len,
+ enum ucl_string_flags flags) UCL_WARN_UNUSED_RESULT;
/**
* Create a UCL object from the specified string
* @param str NULL terminated string, will be json escaped
* @return new object
*/
-UCL_EXTERN ucl_object_t *ucl_object_fromstring (const char *str) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_fromstring(const char *str) UCL_WARN_UNUSED_RESULT;
/**
* Create a UCL object from the specified string
@@ -353,29 +366,29 @@ UCL_EXTERN ucl_object_t *ucl_object_fromstring (const char *str) UCL_WARN_UNUSED
* @param len length of a string
* @return new object
*/
-UCL_EXTERN ucl_object_t *ucl_object_fromlstring (const char *str,
- size_t len) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_fromlstring(const char *str,
+ size_t len) UCL_WARN_UNUSED_RESULT;
/**
* Create an object from an integer number
* @param iv number
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_fromint (int64_t iv) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_fromint(int64_t iv) UCL_WARN_UNUSED_RESULT;
/**
* Create an object from a float number
* @param dv number
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_fromdouble (double dv) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_fromdouble(double dv) UCL_WARN_UNUSED_RESULT;
/**
* Create an object from a boolean
* @param bv bool value
* @return new object
*/
-UCL_EXTERN ucl_object_t* ucl_object_frombool (bool bv) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_frombool(bool bv) UCL_WARN_UNUSED_RESULT;
/**
* Insert a object 'elt' to the hash 'top' and associate it with key 'key'
@@ -386,8 +399,8 @@ UCL_EXTERN ucl_object_t* ucl_object_frombool (bool bv) UCL_WARN_UNUSED_RESULT;
* @param copy_key make an internal copy of key
* @return true if key has been inserted
*/
-UCL_EXTERN bool ucl_object_insert_key (ucl_object_t *top, ucl_object_t *elt,
- const char *key, size_t keylen, bool copy_key);
+UCL_EXTERN bool ucl_object_insert_key(ucl_object_t *top, ucl_object_t *elt,
+ const char *key, size_t keylen, bool copy_key);
/**
* Replace a object 'elt' to the hash 'top' and associate it with key 'key', old object will be unrefed,
@@ -399,8 +412,8 @@ UCL_EXTERN bool ucl_object_insert_key (ucl_object_t *top, ucl_object_t *elt,
* @param copy_key make an internal copy of key
* @return true if key has been inserted
*/
-UCL_EXTERN bool ucl_object_replace_key (ucl_object_t *top, ucl_object_t *elt,
- const char *key, size_t keylen, bool copy_key);
+UCL_EXTERN bool ucl_object_replace_key(ucl_object_t *top, ucl_object_t *elt,
+ const char *key, size_t keylen, bool copy_key);
/**
* Merge the keys from one object to another object. Overwrite on conflict
@@ -409,7 +422,7 @@ UCL_EXTERN bool ucl_object_replace_key (ucl_object_t *top, ucl_object_t *elt,
* @param copy copy rather than reference the elements
* @return true if all keys have been merged
*/
-UCL_EXTERN bool ucl_object_merge (ucl_object_t *top, ucl_object_t *elt, bool copy);
+UCL_EXTERN bool ucl_object_merge(ucl_object_t *top, ucl_object_t *elt, bool copy);
/**
* Delete a object associated with key 'key', old object will be unrefered,
@@ -417,16 +430,16 @@ UCL_EXTERN bool ucl_object_merge (ucl_object_t *top, ucl_object_t *elt, bool cop
* @param key key associated to the object to remove
* @param keylen length of the key (or 0 for NULL terminated keys)
*/
-UCL_EXTERN bool ucl_object_delete_keyl (ucl_object_t *top,
- const char *key, size_t keylen);
+UCL_EXTERN bool ucl_object_delete_keyl(ucl_object_t *top,
+ const char *key, size_t keylen);
/**
* Delete a object associated with key 'key', old object will be unrefered,
* @param top object
* @param key key associated to the object to remove
*/
-UCL_EXTERN bool ucl_object_delete_key (ucl_object_t *top,
- const char *key);
+UCL_EXTERN bool ucl_object_delete_key(ucl_object_t *top,
+ const char *key);
/**
@@ -438,8 +451,8 @@ UCL_EXTERN bool ucl_object_delete_key (ucl_object_t *top,
* @param keylen length of the key (or 0 for NULL terminated keys)
* @return removed object or NULL if object has not been found
*/
-UCL_EXTERN ucl_object_t* ucl_object_pop_keyl (ucl_object_t *top, const char *key,
- size_t keylen) UCL_WARN_UNUSED_RESULT;
+UCL_EXTERN ucl_object_t *ucl_object_pop_keyl(ucl_object_t *top, const char *key,
+ size_t keylen) UCL_WARN_UNUSED_RESULT;
/**
* Removes `key` from `top` object returning the object that was removed. This
@@ -449,7 +462,7 @@ UCL_EXTERN ucl_object_t* ucl_object_pop_keyl (ucl_object_t *top, const char *key
* @param key key to remove
* @return removed object or NULL if object has not been found
*/
-UCL_EXTERN ucl_object_t* ucl_object_pop_key (ucl_object_t *top, const char *key)
+UCL_EXTERN ucl_object_t *ucl_object_pop_key(ucl_object_t *top, const char *key)
UCL_WARN_UNUSED_RESULT;
/**
@@ -462,8 +475,8 @@ UCL_EXTERN ucl_object_t* ucl_object_pop_key (ucl_object_t *top, const char *key)
* @param copy_key make an internal copy of key
* @return true if key has been inserted
*/
-UCL_EXTERN bool ucl_object_insert_key_merged (ucl_object_t *top, ucl_object_t *elt,
- const char *key, size_t keylen, bool copy_key);
+UCL_EXTERN bool ucl_object_insert_key_merged(ucl_object_t *top, ucl_object_t *elt,
+ const char *key, size_t keylen, bool copy_key);
/**
* Reserve space in ucl array or object for `elt` elements
@@ -471,7 +484,7 @@ UCL_EXTERN bool ucl_object_insert_key_merged (ucl_object_t *top, ucl_object_t *e
* @param reserved size to reserve in an object
* @return 0 on success, -1 on failure (i.e. ENOMEM)
*/
-UCL_EXTERN bool ucl_object_reserve (ucl_object_t *obj, size_t reserved);
+UCL_EXTERN bool ucl_object_reserve(ucl_object_t *obj, size_t reserved);
/**
* Append an element to the end of array object
@@ -479,8 +492,8 @@ UCL_EXTERN bool ucl_object_reserve (ucl_object_t *obj, size_t reserved);
* @param elt element to append (must NOT be NULL)
* @return true if value has been inserted
*/
-UCL_EXTERN bool ucl_array_append (ucl_object_t *top,
- ucl_object_t *elt);
+UCL_EXTERN bool ucl_array_append(ucl_object_t *top,
+ ucl_object_t *elt);
/**
* Append an element to the start of array object
@@ -488,8 +501,8 @@ UCL_EXTERN bool ucl_array_append (ucl_object_t *top,
* @param elt element to append (must NOT be NULL)
* @return true if value has been inserted
*/
-UCL_EXTERN bool ucl_array_prepend (ucl_object_t *top,
- ucl_object_t *elt);
+UCL_EXTERN bool ucl_array_prepend(ucl_object_t *top,
+ ucl_object_t *elt);
/**
* Merge all elements of second array into the first array
@@ -498,8 +511,8 @@ UCL_EXTERN bool ucl_array_prepend (ucl_object_t *top,
* @param copy copy elements instead of referencing them
* @return true if arrays were merged
*/
-UCL_EXTERN bool ucl_array_merge (ucl_object_t *top, ucl_object_t *elt,
- bool copy);
+UCL_EXTERN bool ucl_array_merge(ucl_object_t *top, ucl_object_t *elt,
+ bool copy);
/**
* Removes an element `elt` from the array `top`, returning the object that was
@@ -509,22 +522,22 @@ UCL_EXTERN bool ucl_array_merge (ucl_object_t *top, ucl_object_t *elt,
* @param elt element to remove
* @return removed element or NULL if `top` is NULL or not an array
*/
-UCL_EXTERN ucl_object_t* ucl_array_delete (ucl_object_t *top,
- ucl_object_t *elt);
+UCL_EXTERN ucl_object_t *ucl_array_delete(ucl_object_t *top,
+ ucl_object_t *elt);
/**
* Returns the first element of the array `top`
* @param top array ucl object
* @return element or NULL if `top` is NULL or not an array
*/
-UCL_EXTERN const ucl_object_t* ucl_array_head (const ucl_object_t *top);
+UCL_EXTERN const ucl_object_t *ucl_array_head(const ucl_object_t *top);
/**
* Returns the last element of the array `top`
* @param top array ucl object
* @return element or NULL if `top` is NULL or not an array
*/
-UCL_EXTERN const ucl_object_t* ucl_array_tail (const ucl_object_t *top);
+UCL_EXTERN const ucl_object_t *ucl_array_tail(const ucl_object_t *top);
/**
* Removes the last element from the array `top`, returning the object that was
@@ -533,7 +546,7 @@ UCL_EXTERN const ucl_object_t* ucl_array_tail (const ucl_object_t *top);
* @param top array ucl object
* @return removed element or NULL if `top` is NULL or not an array
*/
-UCL_EXTERN ucl_object_t* ucl_array_pop_last (ucl_object_t *top);
+UCL_EXTERN ucl_object_t *ucl_array_pop_last(ucl_object_t *top);
/**
* Removes the first element from the array `top`, returning the object that was
@@ -542,14 +555,14 @@ UCL_EXTERN ucl_object_t* ucl_array_pop_last (ucl_object_t *top);
* @param top array ucl object
* @return removed element or NULL if `top` is NULL or not an array
*/
-UCL_EXTERN ucl_object_t* ucl_array_pop_first (ucl_object_t *top);
+UCL_EXTERN ucl_object_t *ucl_array_pop_first(ucl_object_t *top);
/**
* Return size of the array `top`
* @param top object to get size from (must be of type UCL_ARRAY)
* @return size of the array
*/
-UCL_EXTERN unsigned int ucl_array_size (const ucl_object_t *top);
+UCL_EXTERN unsigned int ucl_array_size(const ucl_object_t *top);
/**
* Return object identified by index of the array `top`
@@ -557,8 +570,8 @@ UCL_EXTERN unsigned int ucl_array_size (const ucl_object_t *top);
* @param index array index to return
* @return object at the specified index or NULL if index is not found
*/
-UCL_EXTERN const ucl_object_t* ucl_array_find_index (const ucl_object_t *top,
- unsigned int index);
+UCL_EXTERN const ucl_object_t *ucl_array_find_index(const ucl_object_t *top,
+ unsigned int index);
/**
* Return the index of `elt` in the array `top`
@@ -566,8 +579,8 @@ UCL_EXTERN const ucl_object_t* ucl_array_find_index (const ucl_object_t *top,
* @param elt element to find index of (must NOT be NULL)
* @return index of `elt` in the array `top or (unsigned int)-1 if `elt` is not found
*/
-UCL_EXTERN unsigned int ucl_array_index_of (ucl_object_t *top,
- ucl_object_t *elt);
+UCL_EXTERN unsigned int ucl_array_index_of(ucl_object_t *top,
+ ucl_object_t *elt);
/**
* Replace an element in an array with a different element, returning the object
@@ -579,8 +592,8 @@ UCL_EXTERN unsigned int ucl_array_index_of (ucl_object_t *top,
* @return object that was replaced or NULL if index is not found
*/
ucl_object_t *
-ucl_array_replace_index (ucl_object_t *top, ucl_object_t *elt,
- unsigned int index);
+ucl_array_replace_index(ucl_object_t *top, ucl_object_t *elt,
+ unsigned int index);
/**
* Append a element to another element forming an implicit array
@@ -588,8 +601,8 @@ ucl_array_replace_index (ucl_object_t *top, ucl_object_t *elt,
* @param elt new element
* @return the new implicit array
*/
-UCL_EXTERN ucl_object_t * ucl_elt_append (ucl_object_t *head,
- ucl_object_t *elt);
+UCL_EXTERN ucl_object_t *ucl_elt_append(ucl_object_t *head,
+ ucl_object_t *elt);
/**
* Converts an object to double value
@@ -597,14 +610,14 @@ UCL_EXTERN ucl_object_t * ucl_elt_append (ucl_object_t *head,
* @param target target double variable
* @return true if conversion was successful
*/
-UCL_EXTERN bool ucl_object_todouble_safe (const ucl_object_t *obj, double *target);
+UCL_EXTERN bool ucl_object_todouble_safe(const ucl_object_t *obj, double *target);
/**
* Unsafe version of \ref ucl_obj_todouble_safe
* @param obj CL object
* @return double value
*/
-UCL_EXTERN double ucl_object_todouble (const ucl_object_t *obj);
+UCL_EXTERN double ucl_object_todouble(const ucl_object_t *obj);
/**
* Converts an object to integer value
@@ -612,14 +625,14 @@ UCL_EXTERN double ucl_object_todouble (const ucl_object_t *obj);
* @param target target integer variable
* @return true if conversion was successful
*/
-UCL_EXTERN bool ucl_object_toint_safe (const ucl_object_t *obj, int64_t *target);
+UCL_EXTERN bool ucl_object_toint_safe(const ucl_object_t *obj, int64_t *target);
/**
* Unsafe version of \ref ucl_obj_toint_safe
* @param obj CL object
* @return int value
*/
-UCL_EXTERN int64_t ucl_object_toint (const ucl_object_t *obj);
+UCL_EXTERN int64_t ucl_object_toint(const ucl_object_t *obj);
/**
* Converts an object to boolean value
@@ -627,14 +640,14 @@ UCL_EXTERN int64_t ucl_object_toint (const ucl_object_t *obj);
* @param target target boolean variable
* @return true if conversion was successful
*/
-UCL_EXTERN bool ucl_object_toboolean_safe (const ucl_object_t *obj, bool *target);
+UCL_EXTERN bool ucl_object_toboolean_safe(const ucl_object_t *obj, bool *target);
/**
* Unsafe version of \ref ucl_obj_toboolean_safe
* @param obj CL object
* @return boolean value
*/
-UCL_EXTERN bool ucl_object_toboolean (const ucl_object_t *obj);
+UCL_EXTERN bool ucl_object_toboolean(const ucl_object_t *obj);
/**
* Converts an object to string value
@@ -642,21 +655,21 @@ UCL_EXTERN bool ucl_object_toboolean (const ucl_object_t *obj);
* @param target target string variable, no need to free value
* @return true if conversion was successful
*/
-UCL_EXTERN bool ucl_object_tostring_safe (const ucl_object_t *obj, const char **target);
+UCL_EXTERN bool ucl_object_tostring_safe(const ucl_object_t *obj, const char **target);
/**
* Unsafe version of \ref ucl_obj_tostring_safe
* @param obj CL object
* @return string value
*/
-UCL_EXTERN const char* ucl_object_tostring (const ucl_object_t *obj);
+UCL_EXTERN const char *ucl_object_tostring(const ucl_object_t *obj);
/**
* Convert any object to a string in JSON notation if needed
* @param obj CL object
* @return string value
*/
-UCL_EXTERN const char* ucl_object_tostring_forced (const ucl_object_t *obj);
+UCL_EXTERN const char *ucl_object_tostring_forced(const ucl_object_t *obj);
/**
* Return string as char * and len, string may be not zero terminated, more efficient that \ref ucl_obj_tostring as it
@@ -666,15 +679,15 @@ UCL_EXTERN const char* ucl_object_tostring_forced (const ucl_object_t *obj);
* @param tlen target length
* @return true if conversion was successful
*/
-UCL_EXTERN bool ucl_object_tolstring_safe (const ucl_object_t *obj,
- const char **target, size_t *tlen);
+UCL_EXTERN bool ucl_object_tolstring_safe(const ucl_object_t *obj,
+ const char **target, size_t *tlen);
/**
* Unsafe version of \ref ucl_obj_tolstring_safe
* @param obj CL object
* @return string value
*/
-UCL_EXTERN const char* ucl_object_tolstring (const ucl_object_t *obj, size_t *tlen);
+UCL_EXTERN const char *ucl_object_tolstring(const ucl_object_t *obj, size_t *tlen);
/**
* Return object identified by a key in the specified object
@@ -682,8 +695,8 @@ UCL_EXTERN const char* ucl_object_tolstring (const ucl_object_t *obj, size_t *tl
* @param key key to search
* @return object matching the specified key or NULL if key was not found
*/
-UCL_EXTERN const ucl_object_t* ucl_object_lookup (const ucl_object_t *obj,
- const char *key);
+UCL_EXTERN const ucl_object_t *ucl_object_lookup(const ucl_object_t *obj,
+ const char *key);
#define ucl_object_find_key ucl_object_lookup
/**
@@ -696,8 +709,8 @@ UCL_EXTERN const ucl_object_t* ucl_object_lookup (const ucl_object_t *obj,
* @param ... list of alternative keys to search (NULL terminated)
* @return object matching the specified key or NULL if key was not found
*/
-UCL_EXTERN const ucl_object_t* ucl_object_lookup_any (const ucl_object_t *obj,
- const char *key, ...);
+UCL_EXTERN const ucl_object_t *ucl_object_lookup_any(const ucl_object_t *obj,
+ const char *key, ...);
#define ucl_object_find_any_key ucl_object_lookup_any
/**
@@ -707,8 +720,8 @@ UCL_EXTERN const ucl_object_t* ucl_object_lookup_any (const ucl_object_t *obj,
* @param klen length of a key
* @return object matching the specified key or NULL if key was not found
*/
-UCL_EXTERN const ucl_object_t* ucl_object_lookup_len (const ucl_object_t *obj,
- const char *key, size_t klen);
+UCL_EXTERN const ucl_object_t *ucl_object_lookup_len(const ucl_object_t *obj,
+ const char *key, size_t klen);
#define ucl_object_find_keyl ucl_object_lookup_len
/**
@@ -717,8 +730,8 @@ UCL_EXTERN const ucl_object_t* ucl_object_lookup_len (const ucl_object_t *obj,
* @param path dot.notation.path to the path to lookup. May use numeric .index on arrays
* @return object matched the specified path or NULL if path is not found
*/
-UCL_EXTERN const ucl_object_t *ucl_object_lookup_path (const ucl_object_t *obj,
- const char *path);
+UCL_EXTERN const ucl_object_t *ucl_object_lookup_path(const ucl_object_t *obj,
+ const char *path);
#define ucl_lookup_path ucl_object_lookup_path
/**
@@ -728,8 +741,8 @@ UCL_EXTERN const ucl_object_t *ucl_object_lookup_path (const ucl_object_t *obj,
* @param sep the sepatorator to use in place of . (incase keys have . in them)
* @return object matched the specified path or NULL if path is not found
*/
-UCL_EXTERN const ucl_object_t *ucl_object_lookup_path_char (const ucl_object_t *obj,
- const char *path, char sep);
+UCL_EXTERN const ucl_object_t *ucl_object_lookup_path_char(const ucl_object_t *obj,
+ const char *path, char sep);
#define ucl_lookup_path_char ucl_object_lookup_path_char
/**
@@ -737,7 +750,7 @@ UCL_EXTERN const ucl_object_t *ucl_object_lookup_path_char (const ucl_object_t *
* @param obj CL object
* @return key or NULL if there is no key
*/
-UCL_EXTERN const char* ucl_object_key (const ucl_object_t *obj);
+UCL_EXTERN const char *ucl_object_key(const ucl_object_t *obj);
/**
* Returns a key of an object as a fixed size string (may be more efficient)
@@ -745,26 +758,26 @@ UCL_EXTERN const char* ucl_object_key (const ucl_object_t *obj);
* @param len target key length
* @return key pointer
*/
-UCL_EXTERN const char* ucl_object_keyl (const ucl_object_t *obj, size_t *len);
+UCL_EXTERN const char *ucl_object_keyl(const ucl_object_t *obj, size_t *len);
/**
* Increase reference count for an object
* @param obj object to ref
* @return the referenced object
*/
-UCL_EXTERN ucl_object_t* ucl_object_ref (const ucl_object_t *obj);
+UCL_EXTERN ucl_object_t *ucl_object_ref(const ucl_object_t *obj);
/**
* Free ucl object
* @param obj ucl object to free
*/
-UCL_DEPRECATED(UCL_EXTERN void ucl_object_free (ucl_object_t *obj));
+UCL_DEPRECATED(UCL_EXTERN void ucl_object_free(ucl_object_t *obj));
/**
* Decrease reference count for an object
* @param obj object to unref
*/
-UCL_EXTERN void ucl_object_unref (ucl_object_t *obj);
+UCL_EXTERN void ucl_object_unref(ucl_object_t *obj);
/**
* Compare objects `o1` and `o2`
@@ -776,8 +789,8 @@ UCL_EXTERN void ucl_object_unref (ucl_object_t *obj);
* 2) Size of objects
* 3) Content of objects
*/
-UCL_EXTERN int ucl_object_compare (const ucl_object_t *o1,
- const ucl_object_t *o2);
+UCL_EXTERN int ucl_object_compare(const ucl_object_t *o1,
+ const ucl_object_t *o2);
/**
* Compare objects `o1` and `o2` useful for sorting
@@ -789,16 +802,16 @@ UCL_EXTERN int ucl_object_compare (const ucl_object_t *o1,
* 2) Size of objects
* 3) Content of objects
*/
-UCL_EXTERN int ucl_object_compare_qsort (const ucl_object_t **o1,
- const ucl_object_t **o2);
+UCL_EXTERN int ucl_object_compare_qsort(const ucl_object_t **o1,
+ const ucl_object_t **o2);
/**
* Sort UCL array using `cmp` compare function
* @param ar
* @param cmp
*/
-UCL_EXTERN void ucl_object_array_sort (ucl_object_t *ar,
- int (*cmp)(const ucl_object_t **o1, const ucl_object_t **o2));
+UCL_EXTERN void ucl_object_array_sort(ucl_object_t *ar,
+ int (*cmp)(const ucl_object_t **o1, const ucl_object_t **o2));
enum ucl_object_keys_sort_flags {
UCL_SORT_KEYS_DEFAULT = 0,
@@ -810,28 +823,28 @@ enum ucl_object_keys_sort_flags {
* @param obj
* @param how
*/
-UCL_EXTERN void ucl_object_sort_keys (ucl_object_t *obj,
- enum ucl_object_keys_sort_flags how);
+UCL_EXTERN void ucl_object_sort_keys(ucl_object_t *obj,
+ enum ucl_object_keys_sort_flags how);
/**
* Get the priority for specific UCL object
* @param obj any ucl object
* @return priority of an object
*/
-UCL_EXTERN unsigned int ucl_object_get_priority (const ucl_object_t *obj);
+UCL_EXTERN unsigned int ucl_object_get_priority(const ucl_object_t *obj);
/**
* Set explicit priority of an object.
* @param obj any ucl object
* @param priority new priroity value (only 4 least significant bits are considred)
*/
-UCL_EXTERN void ucl_object_set_priority (ucl_object_t *obj,
- unsigned int priority);
+UCL_EXTERN void ucl_object_set_priority(ucl_object_t *obj,
+ unsigned int priority);
/**
* Opaque iterator object
*/
-typedef void* ucl_object_iter_t;
+typedef void *ucl_object_iter_t;
/**
* Get next key from an object
@@ -842,8 +855,8 @@ typedef void* ucl_object_iter_t;
* @param ep pointer record exception (such as ENOMEM), could be NULL
* @return the next object or NULL
*/
-UCL_EXTERN const ucl_object_t* ucl_object_iterate_with_error (const ucl_object_t *obj,
- ucl_object_iter_t *iter, bool expand_values, int *ep);
+UCL_EXTERN const ucl_object_t *ucl_object_iterate_with_error(const ucl_object_t *obj,
+ ucl_object_iter_t *iter, bool expand_values, int *ep);
#define ucl_iterate_object ucl_object_iterate
#define ucl_object_iterate(ob, it, ev) ucl_object_iterate_with_error((ob), (it), (ev), NULL)
@@ -853,7 +866,7 @@ UCL_EXTERN const ucl_object_t* ucl_object_iterate_with_error (const ucl_object_t
* @param obj object to iterate
* @return new iterator object that should be used with safe iterators API only
*/
-UCL_EXTERN ucl_object_iter_t ucl_object_iterate_new (const ucl_object_t *obj)
+UCL_EXTERN ucl_object_iter_t ucl_object_iterate_new(const ucl_object_t *obj)
UCL_WARN_UNUSED_RESULT;
/**
* Check safe iterator object after performing some operations on it
@@ -869,8 +882,8 @@ UCL_EXTERN bool ucl_object_iter_chk_excpn(ucl_object_iter_t *it);
* @param obj new object to iterate
* @return modified iterator object
*/
-UCL_EXTERN ucl_object_iter_t ucl_object_iterate_reset (ucl_object_iter_t it,
- const ucl_object_t *obj);
+UCL_EXTERN ucl_object_iter_t ucl_object_iterate_reset(ucl_object_iter_t it,
+ const ucl_object_t *obj);
/**
* Get the next object from the `obj`. This function iterates over arrays, objects
@@ -879,15 +892,15 @@ UCL_EXTERN ucl_object_iter_t ucl_object_iterate_reset (ucl_object_iter_t it,
* @param expand_values expand explicit arrays and objects
* @return the next object in sequence
*/
-UCL_EXTERN const ucl_object_t* ucl_object_iterate_safe (ucl_object_iter_t iter,
- bool expand_values);
+UCL_EXTERN const ucl_object_t *ucl_object_iterate_safe(ucl_object_iter_t iter,
+ bool expand_values);
/**
* Iteration type enumerator
*/
enum ucl_iterate_type {
- UCL_ITERATE_EXPLICIT = 1 << 0, /**< Iterate just explicit arrays and objects */
- UCL_ITERATE_IMPLICIT = 1 << 1, /**< Iterate just implicit arrays */
- UCL_ITERATE_BOTH = (1 << 0) | (1 << 1), /**< Iterate both explicit and implicit arrays*/
+ UCL_ITERATE_EXPLICIT = 1 << 0, /**< Iterate just explicit arrays and objects */
+ UCL_ITERATE_IMPLICIT = 1 << 1, /**< Iterate just implicit arrays */
+ UCL_ITERATE_BOTH = (1 << 0) | (1 << 1), /**< Iterate both explicit and implicit arrays*/
};
/**
@@ -897,14 +910,14 @@ enum ucl_iterate_type {
* @param
* @return the next object in sequence
*/
-UCL_EXTERN const ucl_object_t* ucl_object_iterate_full (ucl_object_iter_t iter,
- enum ucl_iterate_type type);
+UCL_EXTERN const ucl_object_t *ucl_object_iterate_full(ucl_object_iter_t iter,
+ enum ucl_iterate_type type);
/**
* Free memory associated with the safe iterator
* @param it safe iterator object
*/
-UCL_EXTERN void ucl_object_iterate_free (ucl_object_iter_t it);
+UCL_EXTERN void ucl_object_iterate_free(ucl_object_iter_t it);
/** @} */
@@ -925,9 +938,9 @@ UCL_EXTERN void ucl_object_iterate_free (ucl_object_iter_t it);
* @param err error pointer
* @return true if macro has been parsed
*/
-typedef bool (*ucl_macro_handler) (const unsigned char *data, size_t len,
- const ucl_object_t *arguments,
- void* ud);
+typedef bool (*ucl_macro_handler)(const unsigned char *data, size_t len,
+ const ucl_object_t *arguments,
+ void *ud);
/**
* Context dependent macro handler for a parser
@@ -939,10 +952,10 @@ typedef bool (*ucl_macro_handler) (const unsigned char *data, size_t len,
* @param err error pointer
* @return true if macro has been parsed
*/
-typedef bool (*ucl_context_macro_handler) (const unsigned char *data, size_t len,
- const ucl_object_t *arguments,
- const ucl_object_t *context,
- void* ud);
+typedef bool (*ucl_context_macro_handler)(const unsigned char *data, size_t len,
+ const ucl_object_t *arguments,
+ const ucl_object_t *context,
+ void *ud);
/* Opaque parser */
struct ucl_parser;
@@ -952,7 +965,7 @@ struct ucl_parser;
* @param pool pool to allocate memory from
* @return new parser object
*/
-UCL_EXTERN struct ucl_parser* ucl_parser_new (int flags);
+UCL_EXTERN struct ucl_parser *ucl_parser_new(int flags);
/**
* Sets the default priority for the parser applied to chunks that do not
@@ -961,15 +974,15 @@ UCL_EXTERN struct ucl_parser* ucl_parser_new (int flags);
* @param prio default priority (0 .. 16)
* @return true if parser's default priority was set
*/
-UCL_EXTERN bool ucl_parser_set_default_priority (struct ucl_parser *parser,
- unsigned prio);
+UCL_EXTERN bool ucl_parser_set_default_priority(struct ucl_parser *parser,
+ unsigned prio);
/**
* Gets the default priority for the parser applied to chunks that do not
* specify priority explicitly
* @param parser parser object
* @return true default priority (0 .. 16), -1 for failure
*/
-UCL_EXTERN int ucl_parser_get_default_priority (struct ucl_parser *parser);
+UCL_EXTERN int ucl_parser_get_default_priority(struct ucl_parser *parser);
/**
* Register new handler for a macro
@@ -979,9 +992,9 @@ UCL_EXTERN int ucl_parser_get_default_priority (struct ucl_parser *parser);
* @param ud opaque user data for a handler
* @return true on success, false on failure (i.e. ENOMEM)
*/
-UCL_EXTERN bool ucl_parser_register_macro (struct ucl_parser *parser,
- const char *macro,
- ucl_macro_handler handler, void* ud);
+UCL_EXTERN bool ucl_parser_register_macro(struct ucl_parser *parser,
+ const char *macro,
+ ucl_macro_handler handler, void *ud);
/**
* Register new context dependent handler for a macro
@@ -991,10 +1004,10 @@ UCL_EXTERN bool ucl_parser_register_macro (struct ucl_parser *parser,
* @param ud opaque user data for a handler
* @return true on success, false on failure (i.e. ENOMEM)
*/
-UCL_EXTERN bool ucl_parser_register_context_macro (struct ucl_parser *parser,
- const char *macro,
- ucl_context_macro_handler handler,
- void* ud);
+UCL_EXTERN bool ucl_parser_register_context_macro(struct ucl_parser *parser,
+ const char *macro,
+ ucl_context_macro_handler handler,
+ void *ud);
/**
* Handler to detect unregistered variables
@@ -1006,8 +1019,8 @@ UCL_EXTERN bool ucl_parser_register_context_macro (struct ucl_parser *parser,
* @param ud opaque userdata
* @return true if variable
*/
-typedef bool (*ucl_variable_handler) (const unsigned char *data, size_t len,
- unsigned char **replace, size_t *replace_len, bool *need_free, void* ud);
+typedef bool (*ucl_variable_handler)(const unsigned char *data, size_t len,
+ unsigned char **replace, size_t *replace_len, bool *need_free, void *ud);
/**
* Register new parser variable
@@ -1015,8 +1028,8 @@ typedef bool (*ucl_variable_handler) (const unsigned char *data, size_t len,
* @param var variable name
* @param value variable value
*/
-UCL_EXTERN void ucl_parser_register_variable (struct ucl_parser *parser, const char *var,
- const char *value);
+UCL_EXTERN void ucl_parser_register_variable(struct ucl_parser *parser, const char *var,
+ const char *value);
/**
* Set handler for unknown variables
@@ -1024,8 +1037,8 @@ UCL_EXTERN void ucl_parser_register_variable (struct ucl_parser *parser, const c
* @param handler desired handler
* @param ud opaque data for the handler
*/
-UCL_EXTERN void ucl_parser_set_variables_handler (struct ucl_parser *parser,
- ucl_variable_handler handler, void *ud);
+UCL_EXTERN void ucl_parser_set_variables_handler(struct ucl_parser *parser,
+ ucl_variable_handler handler, void *ud);
/**
* Load new chunk to a parser
@@ -1034,8 +1047,8 @@ UCL_EXTERN void ucl_parser_set_variables_handler (struct ucl_parser *parser,
* @param len the length of a chunk
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_chunk (struct ucl_parser *parser,
- const unsigned char *data, size_t len);
+UCL_EXTERN bool ucl_parser_add_chunk(struct ucl_parser *parser,
+ const unsigned char *data, size_t len);
/**
* Load new chunk to a parser with the specified priority
@@ -1046,8 +1059,8 @@ UCL_EXTERN bool ucl_parser_add_chunk (struct ucl_parser *parser,
* are considered for this parameter)
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_chunk_priority (struct ucl_parser *parser,
- const unsigned char *data, size_t len, unsigned priority);
+UCL_EXTERN bool ucl_parser_add_chunk_priority(struct ucl_parser *parser,
+ const unsigned char *data, size_t len, unsigned priority);
/**
* Insert new chunk to a parser (must have previously processed data with an existing top object)
@@ -1056,8 +1069,8 @@ UCL_EXTERN bool ucl_parser_add_chunk_priority (struct ucl_parser *parser,
* @param len the length of a chunk
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_insert_chunk (struct ucl_parser *parser,
- const unsigned char *data, size_t len);
+UCL_EXTERN bool ucl_parser_insert_chunk(struct ucl_parser *parser,
+ const unsigned char *data, size_t len);
/**
* Full version of ucl_add_chunk with priority and duplicate strategy
@@ -1070,9 +1083,9 @@ UCL_EXTERN bool ucl_parser_insert_chunk (struct ucl_parser *parser,
* @param parse_type input format
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_chunk_full (struct ucl_parser *parser,
- const unsigned char *data, size_t len, unsigned priority,
- enum ucl_duplicate_strategy strat, enum ucl_parse_type parse_type);
+UCL_EXTERN bool ucl_parser_add_chunk_full(struct ucl_parser *parser,
+ const unsigned char *data, size_t len, unsigned priority,
+ enum ucl_duplicate_strategy strat, enum ucl_parse_type parse_type);
/**
* Load ucl object from a string
@@ -1081,8 +1094,8 @@ UCL_EXTERN bool ucl_parser_add_chunk_full (struct ucl_parser *parser,
* @param len the length of the string, if `len` is 0 then `data` must be zero-terminated string
* @return true if string has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_string (struct ucl_parser *parser,
- const char *data, size_t len);
+UCL_EXTERN bool ucl_parser_add_string(struct ucl_parser *parser,
+ const char *data, size_t len);
/**
* Load ucl object from a string
@@ -1093,8 +1106,8 @@ UCL_EXTERN bool ucl_parser_add_string (struct ucl_parser *parser,
* are considered for this parameter)
* @return true if string has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_string_priority (struct ucl_parser *parser,
- const char *data, size_t len, unsigned priority);
+UCL_EXTERN bool ucl_parser_add_string_priority(struct ucl_parser *parser,
+ const char *data, size_t len, unsigned priority);
/**
* Load and add data from a file
@@ -1103,8 +1116,8 @@ UCL_EXTERN bool ucl_parser_add_string_priority (struct ucl_parser *parser,
* @param err if *err is NULL it is set to parser error
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_file (struct ucl_parser *parser,
- const char *filename);
+UCL_EXTERN bool ucl_parser_add_file(struct ucl_parser *parser,
+ const char *filename);
/**
* Load and add data from a file
@@ -1115,8 +1128,8 @@ UCL_EXTERN bool ucl_parser_add_file (struct ucl_parser *parser,
* are considered for this parameter)
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_file_priority (struct ucl_parser *parser,
- const char *filename, unsigned priority);
+UCL_EXTERN bool ucl_parser_add_file_priority(struct ucl_parser *parser,
+ const char *filename, unsigned priority);
/**
* Load and add data from a file
@@ -1128,9 +1141,9 @@ UCL_EXTERN bool ucl_parser_add_file_priority (struct ucl_parser *parser,
* @param parse_type Parser type to use while parsing this file
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_file_full (struct ucl_parser *parser, const char *filename,
- unsigned priority, enum ucl_duplicate_strategy strat,
- enum ucl_parse_type parse_type);
+UCL_EXTERN bool ucl_parser_add_file_full(struct ucl_parser *parser, const char *filename,
+ unsigned priority, enum ucl_duplicate_strategy strat,
+ enum ucl_parse_type parse_type);
/**
* Load and add data from a file descriptor
@@ -1139,8 +1152,8 @@ UCL_EXTERN bool ucl_parser_add_file_full (struct ucl_parser *parser, const char
* @param err if *err is NULL it is set to parser error
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_fd (struct ucl_parser *parser,
- int fd);
+UCL_EXTERN bool ucl_parser_add_fd(struct ucl_parser *parser,
+ int fd);
/**
* Load and add data from a file descriptor
@@ -1151,8 +1164,8 @@ UCL_EXTERN bool ucl_parser_add_fd (struct ucl_parser *parser,
* are considered for this parameter)
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_fd_priority (struct ucl_parser *parser,
- int fd, unsigned priority);
+UCL_EXTERN bool ucl_parser_add_fd_priority(struct ucl_parser *parser,
+ int fd, unsigned priority);
/**
* Load and add data from a file descriptor
@@ -1165,9 +1178,9 @@ UCL_EXTERN bool ucl_parser_add_fd_priority (struct ucl_parser *parser,
* @param parse_type Parser type to use while parsing this file
* @return true if chunk has been added and false in case of error
*/
-UCL_EXTERN bool ucl_parser_add_fd_full (struct ucl_parser *parser, int fd,
- unsigned priority, enum ucl_duplicate_strategy strat,
- enum ucl_parse_type parse_type);
+UCL_EXTERN bool ucl_parser_add_fd_full(struct ucl_parser *parser, int fd,
+ unsigned priority, enum ucl_duplicate_strategy strat,
+ enum ucl_parse_type parse_type);
/**
* Provide a UCL_ARRAY of paths to search for include files. The object is
@@ -1176,8 +1189,8 @@ UCL_EXTERN bool ucl_parser_add_fd_full (struct ucl_parser *parser, int fd,
* @param paths UCL_ARRAY of paths to search
* @return true if the path search array was replaced in the parser
*/
-UCL_EXTERN bool ucl_set_include_path (struct ucl_parser *parser,
- ucl_object_t *paths);
+UCL_EXTERN bool ucl_set_include_path(struct ucl_parser *parser,
+ ucl_object_t *paths);
/**
* Get a top object for a parser (refcount is increased)
@@ -1185,7 +1198,7 @@ UCL_EXTERN bool ucl_set_include_path (struct ucl_parser *parser,
* @param err if *err is NULL it is set to parser error
* @return top parser object or NULL
*/
-UCL_EXTERN ucl_object_t* ucl_parser_get_object (struct ucl_parser *parser);
+UCL_EXTERN ucl_object_t *ucl_parser_get_object(struct ucl_parser *parser);
/**
* Get the current stack object as stack accessor function for use in macro
@@ -1194,61 +1207,61 @@ UCL_EXTERN ucl_object_t* ucl_parser_get_object (struct ucl_parser *parser);
* @param depth depth of stack to retrieve (top is 0)
* @return current stack object or NULL
*/
-UCL_EXTERN ucl_object_t* ucl_parser_get_current_stack_object (struct ucl_parser *parser, unsigned int depth);
+UCL_EXTERN ucl_object_t *ucl_parser_get_current_stack_object(struct ucl_parser *parser, unsigned int depth);
/**
* Peek at the character at the current chunk position
* @param parser parser structure
* @return current chunk position character
*/
-UCL_EXTERN unsigned char ucl_parser_chunk_peek (struct ucl_parser *parser);
+UCL_EXTERN unsigned char ucl_parser_chunk_peek(struct ucl_parser *parser);
/**
* Skip the character at the current chunk position
* @param parser parser structure
* @return success boolean
*/
-UCL_EXTERN bool ucl_parser_chunk_skip (struct ucl_parser *parser);
+UCL_EXTERN bool ucl_parser_chunk_skip(struct ucl_parser *parser);
/**
* Get the error string if parsing has been failed
* @param parser parser object
* @return error description
*/
-UCL_EXTERN const char *ucl_parser_get_error (struct ucl_parser *parser);
+UCL_EXTERN const char *ucl_parser_get_error(struct ucl_parser *parser);
/**
* Get the code of the last error
* @param parser parser object
* @return error code
*/
-UCL_EXTERN int ucl_parser_get_error_code (struct ucl_parser *parser);
+UCL_EXTERN int ucl_parser_get_error_code(struct ucl_parser *parser);
/**
* Get the current column number within parser
* @param parser parser object
* @return current column number
*/
-UCL_EXTERN unsigned ucl_parser_get_column (struct ucl_parser *parser);
+UCL_EXTERN unsigned ucl_parser_get_column(struct ucl_parser *parser);
/**
* Get the current line number within parser
* @param parser parser object
* @return current line number
*/
-UCL_EXTERN unsigned ucl_parser_get_linenum (struct ucl_parser *parser);
+UCL_EXTERN unsigned ucl_parser_get_linenum(struct ucl_parser *parser);
/**
* Clear the error in the parser
* @param parser parser object
*/
-UCL_EXTERN void ucl_parser_clear_error (struct ucl_parser *parser);
+UCL_EXTERN void ucl_parser_clear_error(struct ucl_parser *parser);
/**
* Free ucl parser object
* @param parser parser object
*/
-UCL_EXTERN void ucl_parser_free (struct ucl_parser *parser);
+UCL_EXTERN void ucl_parser_free(struct ucl_parser *parser);
/**
* Get constant opaque pointer to comments structure for this parser. Increase
@@ -1256,7 +1269,7 @@ UCL_EXTERN void ucl_parser_free (struct ucl_parser *parser);
* @param parser parser structure
* @return ucl comments pointer or NULL
*/
-UCL_EXTERN const ucl_object_t * ucl_parser_get_comments (struct ucl_parser *parser);
+UCL_EXTERN const ucl_object_t *ucl_parser_get_comments(struct ucl_parser *parser);
/**
* Utility function to find a comment object for the specified object in the input
@@ -1264,8 +1277,8 @@ UCL_EXTERN const ucl_object_t * ucl_parser_get_comments (struct ucl_parser *pars
* @param srch search object
* @return string comment enclosed in ucl_object_t
*/
-UCL_EXTERN const ucl_object_t * ucl_comments_find (const ucl_object_t *comments,
- const ucl_object_t *srch);
+UCL_EXTERN const ucl_object_t *ucl_comments_find(const ucl_object_t *comments,
+ const ucl_object_t *srch);
/**
* Move comment from `from` object to `to` object
@@ -1274,8 +1287,8 @@ UCL_EXTERN const ucl_object_t * ucl_comments_find (const ucl_object_t *comments,
* @param with destination object
* @return `true` if `from` has comment and it has been moved to `to`
*/
-UCL_EXTERN bool ucl_comments_move (ucl_object_t *comments,
- const ucl_object_t *from, const ucl_object_t *to);
+UCL_EXTERN bool ucl_comments_move(ucl_object_t *comments,
+ const ucl_object_t *from, const ucl_object_t *to);
/**
* Adds a new comment for an object
@@ -1283,8 +1296,8 @@ UCL_EXTERN bool ucl_comments_move (ucl_object_t *comments,
* @param obj object to add comment to
* @param comment string representation of a comment
*/
-UCL_EXTERN void ucl_comments_add (ucl_object_t *comments,
- const ucl_object_t *obj, const char *comment);
+UCL_EXTERN void ucl_comments_add(ucl_object_t *comments,
+ const ucl_object_t *obj, const char *comment);
/**
* Add new public key to parser for signatures check
@@ -1294,8 +1307,8 @@ UCL_EXTERN void ucl_comments_add (ucl_object_t *comments,
* @param err if *err is NULL it is set to parser error
* @return true if a key has been successfully added
*/
-UCL_EXTERN bool ucl_parser_pubkey_add (struct ucl_parser *parser,
- const unsigned char *key, size_t len);
+UCL_EXTERN bool ucl_parser_pubkey_add(struct ucl_parser *parser,
+ const unsigned char *key, size_t len);
/**
* Set FILENAME and CURDIR variables in parser
@@ -1304,23 +1317,23 @@ UCL_EXTERN bool ucl_parser_pubkey_add (struct ucl_parser *parser,
* @param need_expand perform realpath() if this variable is true and filename is not NULL
* @return true if variables has been set
*/
-UCL_EXTERN bool ucl_parser_set_filevars (struct ucl_parser *parser, const char *filename,
- bool need_expand);
+UCL_EXTERN bool ucl_parser_set_filevars(struct ucl_parser *parser, const char *filename,
+ bool need_expand);
/**
* Returns current file for the parser
* @param parser parser object
* @return current file or NULL if parsing memory
*/
-UCL_EXTERN const char *ucl_parser_get_cur_file (struct ucl_parser *parser);
+UCL_EXTERN const char *ucl_parser_get_cur_file(struct ucl_parser *parser);
/**
* Defines special handler for certain types of data (identified by magic)
*/
-typedef bool (*ucl_parser_special_handler_t) (struct ucl_parser *parser,
- const unsigned char *source, size_t source_len,
- unsigned char **destination, size_t *dest_len,
- void *user_data);
+typedef bool (*ucl_parser_special_handler_t)(struct ucl_parser *parser,
+ const unsigned char *source, size_t source_len,
+ unsigned char **destination, size_t *dest_len,
+ void *user_data);
/**
* Special handler flags
@@ -1338,7 +1351,7 @@ struct ucl_parser_special_handler {
size_t magic_len;
enum ucl_special_handler_flags flags;
ucl_parser_special_handler_t handler;
- void (*free_function) (unsigned char *data, size_t len, void *user_data);
+ void (*free_function)(unsigned char *data, size_t len, void *user_data);
void *user_data;
struct ucl_parser_special_handler *next; /* Used internally */
};
@@ -1348,8 +1361,8 @@ struct ucl_parser_special_handler {
* @param parser parser structure
* @param handler handler structure
*/
-UCL_EXTERN void ucl_parser_add_special_handler (struct ucl_parser *parser,
- struct ucl_parser_special_handler *handler);
+UCL_EXTERN void ucl_parser_add_special_handler(struct ucl_parser *parser,
+ struct ucl_parser_special_handler *handler);
/**
* Handler for include traces:
@@ -1360,12 +1373,12 @@ UCL_EXTERN void ucl_parser_add_special_handler (struct ucl_parser *parser,
* @param pathlen length of the path
* @param user_data opaque userdata
*/
-typedef void (ucl_include_trace_func_t) (struct ucl_parser *parser,
- const ucl_object_t *parent,
- const ucl_object_t *args,
- const char *path,
- size_t pathlen,
- void *user_data);
+typedef void(ucl_include_trace_func_t)(struct ucl_parser *parser,
+ const ucl_object_t *parent,
+ const ucl_object_t *args,
+ const char *path,
+ size_t pathlen,
+ void *user_data);
/**
* Register trace function for an include handler
@@ -1373,9 +1386,9 @@ typedef void (ucl_include_trace_func_t) (struct ucl_parser *parser,
* @param func function to trace includes
* @param user_data opaque data
*/
-UCL_EXTERN void ucl_parser_set_include_tracer (struct ucl_parser *parser,
- ucl_include_trace_func_t func,
- void *user_data);
+UCL_EXTERN void ucl_parser_set_include_tracer(struct ucl_parser *parser,
+ ucl_include_trace_func_t func,
+ void *user_data);
/** @} */
@@ -1392,13 +1405,13 @@ struct ucl_emitter_context;
*/
struct ucl_emitter_functions {
/** Append a single character */
- int (*ucl_emitter_append_character) (unsigned char c, size_t nchars, void *ud);
+ int (*ucl_emitter_append_character)(unsigned char c, size_t nchars, void *ud);
/** Append a string of a specified length */
- int (*ucl_emitter_append_len) (unsigned const char *str, size_t len, void *ud);
+ int (*ucl_emitter_append_len)(unsigned const char *str, size_t len, void *ud);
/** Append a 64 bit integer */
- int (*ucl_emitter_append_int) (int64_t elt, void *ud);
+ int (*ucl_emitter_append_int)(int64_t elt, void *ud);
/** Append floating point element */
- int (*ucl_emitter_append_double) (double elt, void *ud);
+ int (*ucl_emitter_append_double)(double elt, void *ud);
/** Free userdata */
void (*ucl_emitter_free_func)(void *ud);
/** Opaque userdata pointer */
@@ -1407,19 +1420,19 @@ struct ucl_emitter_functions {
struct ucl_emitter_operations {
/** Write a primitive element */
- void (*ucl_emitter_write_elt) (struct ucl_emitter_context *ctx,
- const ucl_object_t *obj, bool first, bool print_key);
+ void (*ucl_emitter_write_elt)(struct ucl_emitter_context *ctx,
+ const ucl_object_t *obj, bool first, bool print_key);
/** Start ucl object */
- void (*ucl_emitter_start_object) (struct ucl_emitter_context *ctx,
- const ucl_object_t *obj, bool first, bool print_key);
+ void (*ucl_emitter_start_object)(struct ucl_emitter_context *ctx,
+ const ucl_object_t *obj, bool first, bool print_key);
/** End ucl object */
- void (*ucl_emitter_end_object) (struct ucl_emitter_context *ctx,
- const ucl_object_t *obj);
+ void (*ucl_emitter_end_object)(struct ucl_emitter_context *ctx,
+ const ucl_object_t *obj);
/** Start ucl array */
- void (*ucl_emitter_start_array) (struct ucl_emitter_context *ctx,
- const ucl_object_t *obj, bool first, bool print_key);
- void (*ucl_emitter_end_array) (struct ucl_emitter_context *ctx,
- const ucl_object_t *obj);
+ void (*ucl_emitter_start_array)(struct ucl_emitter_context *ctx,
+ const ucl_object_t *obj, bool first, bool print_key);
+ void (*ucl_emitter_end_array)(struct ucl_emitter_context *ctx,
+ const ucl_object_t *obj);
};
/**
@@ -1449,8 +1462,8 @@ struct ucl_emitter_context {
* #UCL_EMIT_CONFIG then emit config like object
* @return dump of an object (must be freed after using) or NULL in case of error
*/
-UCL_EXTERN unsigned char *ucl_object_emit (const ucl_object_t *obj,
- enum ucl_emitter emit_type);
+UCL_EXTERN unsigned char *ucl_object_emit(const ucl_object_t *obj,
+ enum ucl_emitter emit_type);
/**
* Emit object to a string that can contain `\0` inside
@@ -1460,8 +1473,8 @@ UCL_EXTERN unsigned char *ucl_object_emit (const ucl_object_t *obj,
* @param len the resulting length
* @return dump of an object (must be freed after using) or NULL in case of error
*/
-UCL_EXTERN unsigned char *ucl_object_emit_len (const ucl_object_t *obj,
- enum ucl_emitter emit_type, size_t *len);
+UCL_EXTERN unsigned char *ucl_object_emit_len(const ucl_object_t *obj,
+ enum ucl_emitter emit_type, size_t *len);
/**
* Emit object to a string
@@ -1472,10 +1485,10 @@ UCL_EXTERN unsigned char *ucl_object_emit_len (const ucl_object_t *obj,
* @param comments optional comments for the parser
* @return dump of an object (must be freed after using) or NULL in case of error
*/
-UCL_EXTERN bool ucl_object_emit_full (const ucl_object_t *obj,
- enum ucl_emitter emit_type,
- struct ucl_emitter_functions *emitter,
- const ucl_object_t *comments);
+UCL_EXTERN bool ucl_object_emit_full(const ucl_object_t *obj,
+ enum ucl_emitter emit_type,
+ struct ucl_emitter_functions *emitter,
+ const ucl_object_t *comments);
/**
* Start streamlined UCL object emitter
@@ -1485,65 +1498,65 @@ UCL_EXTERN bool ucl_object_emit_full (const ucl_object_t *obj,
* @return new streamlined context that should be freed by
* `ucl_object_emit_streamline_finish`
*/
-UCL_EXTERN struct ucl_emitter_context* ucl_object_emit_streamline_new (
- const ucl_object_t *obj, enum ucl_emitter emit_type,
- struct ucl_emitter_functions *emitter);
+UCL_EXTERN struct ucl_emitter_context *ucl_object_emit_streamline_new(
+ const ucl_object_t *obj, enum ucl_emitter emit_type,
+ struct ucl_emitter_functions *emitter);
/**
* Start object or array container for the streamlined output
* @param ctx streamlined context
* @param obj container object
*/
-UCL_EXTERN void ucl_object_emit_streamline_start_container (
- struct ucl_emitter_context *ctx, const ucl_object_t *obj);
+UCL_EXTERN bool ucl_object_emit_streamline_start_container(
+ struct ucl_emitter_context *ctx, const ucl_object_t *obj);
/**
* Add a complete UCL object to streamlined output
* @param ctx streamlined context
* @param obj object to output
*/
-UCL_EXTERN void ucl_object_emit_streamline_add_object (
- struct ucl_emitter_context *ctx, const ucl_object_t *obj);
+UCL_EXTERN void ucl_object_emit_streamline_add_object(
+ struct ucl_emitter_context *ctx, const ucl_object_t *obj);
/**
* End previously added container
* @param ctx streamlined context
*/
-UCL_EXTERN void ucl_object_emit_streamline_end_container (
- struct ucl_emitter_context *ctx);
+UCL_EXTERN void ucl_object_emit_streamline_end_container(
+ struct ucl_emitter_context *ctx);
/**
* Terminate streamlined container finishing all containers in it
* @param ctx streamlined context
*/
-UCL_EXTERN void ucl_object_emit_streamline_finish (
- struct ucl_emitter_context *ctx);
+UCL_EXTERN void ucl_object_emit_streamline_finish(
+ struct ucl_emitter_context *ctx);
/**
* Returns functions to emit object to memory
* @param pmem target pointer (should be freed by caller)
* @return emitter functions structure
*/
-UCL_EXTERN struct ucl_emitter_functions* ucl_object_emit_memory_funcs (
- void **pmem);
+UCL_EXTERN struct ucl_emitter_functions *ucl_object_emit_memory_funcs(
+ void **pmem);
/**
* Returns functions to emit object to FILE *
* @param fp FILE * object
* @return emitter functions structure
*/
-UCL_EXTERN struct ucl_emitter_functions* ucl_object_emit_file_funcs (
- FILE *fp);
+UCL_EXTERN struct ucl_emitter_functions *ucl_object_emit_file_funcs(
+ FILE *fp);
/**
* Returns functions to emit object to a file descriptor
* @param fd file descriptor
* @return emitter functions structure
*/
-UCL_EXTERN struct ucl_emitter_functions* ucl_object_emit_fd_funcs (
- int fd);
+UCL_EXTERN struct ucl_emitter_functions *ucl_object_emit_fd_funcs(
+ int fd);
/**
* Free emitter functions
* @param f pointer to functions
*/
-UCL_EXTERN void ucl_object_emit_funcs_free (struct ucl_emitter_functions *f);
+UCL_EXTERN void ucl_object_emit_funcs_free(struct ucl_emitter_functions *f);
/** @} */
@@ -1558,25 +1571,25 @@ UCL_EXTERN void ucl_object_emit_funcs_free (struct ucl_emitter_functions *f);
* Used to define UCL schema error
*/
enum ucl_schema_error_code {
- UCL_SCHEMA_OK = 0, /**< no error */
- UCL_SCHEMA_TYPE_MISMATCH, /**< type of object is incorrect */
- UCL_SCHEMA_INVALID_SCHEMA, /**< schema is invalid */
- UCL_SCHEMA_MISSING_PROPERTY,/**< one or more missing properties */
- UCL_SCHEMA_CONSTRAINT, /**< constraint found */
- UCL_SCHEMA_MISSING_DEPENDENCY, /**< missing dependency */
+ UCL_SCHEMA_OK = 0, /**< no error */
+ UCL_SCHEMA_TYPE_MISMATCH, /**< type of object is incorrect */
+ UCL_SCHEMA_INVALID_SCHEMA, /**< schema is invalid */
+ UCL_SCHEMA_MISSING_PROPERTY, /**< one or more missing properties */
+ UCL_SCHEMA_CONSTRAINT, /**< constraint found */
+ UCL_SCHEMA_MISSING_DEPENDENCY, /**< missing dependency */
UCL_SCHEMA_EXTERNAL_REF_MISSING, /**< cannot fetch external ref */
UCL_SCHEMA_EXTERNAL_REF_INVALID, /**< invalid external ref */
- UCL_SCHEMA_INTERNAL_ERROR, /**< something bad happened */
- UCL_SCHEMA_UNKNOWN /**< generic error */
+ UCL_SCHEMA_INTERNAL_ERROR, /**< something bad happened */
+ UCL_SCHEMA_UNKNOWN /**< generic error */
};
/**
* Generic ucl schema error
*/
struct ucl_schema_error {
- enum ucl_schema_error_code code; /**< error code */
- char msg[128]; /**< error message */
- const ucl_object_t *obj; /**< object where error occurred */
+ enum ucl_schema_error_code code; /**< error code */
+ char msg[128]; /**< error message */
+ const ucl_object_t *obj; /**< object where error occurred */
};
/**
@@ -1587,8 +1600,8 @@ struct ucl_schema_error {
* occurred, then `err` is filled with the exact error definition.
* @return true if `obj` is valid using `schema`
*/
-UCL_EXTERN bool ucl_object_validate (const ucl_object_t *schema,
- const ucl_object_t *obj, struct ucl_schema_error *err);
+UCL_EXTERN bool ucl_object_validate(const ucl_object_t *schema,
+ const ucl_object_t *obj, struct ucl_schema_error *err);
/**
* Validate object `obj` using schema object `schema` and root schema at `root`.
@@ -1599,10 +1612,10 @@ UCL_EXTERN bool ucl_object_validate (const ucl_object_t *schema,
* occurred, then `err` is filled with the exact error definition.
* @return true if `obj` is valid using `schema`
*/
-UCL_EXTERN bool ucl_object_validate_root (const ucl_object_t *schema,
- const ucl_object_t *obj,
- const ucl_object_t *root,
- struct ucl_schema_error *err);
+UCL_EXTERN bool ucl_object_validate_root(const ucl_object_t *schema,
+ const ucl_object_t *obj,
+ const ucl_object_t *root,
+ struct ucl_schema_error *err);
/**
* Validate object `obj` using schema object `schema` and root schema at `root`
@@ -1615,15 +1628,15 @@ UCL_EXTERN bool ucl_object_validate_root (const ucl_object_t *schema,
* occurred, then `err` is filled with the exact error definition.
* @return true if `obj` is valid using `schema`
*/
-UCL_EXTERN bool ucl_object_validate_root_ext (const ucl_object_t *schema,
- const ucl_object_t *obj,
- const ucl_object_t *root,
- ucl_object_t *ext_refs,
- struct ucl_schema_error *err);
+UCL_EXTERN bool ucl_object_validate_root_ext(const ucl_object_t *schema,
+ const ucl_object_t *obj,
+ const ucl_object_t *root,
+ ucl_object_t *ext_refs,
+ struct ucl_schema_error *err);
/** @} */
-#ifdef __cplusplus
+#ifdef __cplusplus
}
#endif
/*