diff options
Diffstat (limited to 'src/common/json.h')
| -rw-r--r-- | src/common/json.h | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/src/common/json.h b/src/common/json.h new file mode 100644 index 0000000..746a6ef --- /dev/null +++ b/src/common/json.h @@ -0,0 +1,248 @@ +/* + * Copyright (c) 2012, Intel Corporation + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Intel Corporation nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __MURPHY_JSON_H__ +#define __MURPHY_JSON_H__ + +#include <stdarg.h> +#include <stdbool.h> + +#include "murphy/config.h" + +#ifndef JSON_INCLUDE_PATH_JSONC +# include <json/json.h> +# include <json/linkhash.h> +/* workaround for older broken json-c not exposing json_object_iter */ +# include <json/json_object_private.h> +#else +# include <json-c/json.h> +# include <json-c/linkhash.h> +/* workaround for older broken json-c not exposing json_object_iter */ +# include <json-c/json_object_private.h> +#endif + +#include <murphy/common/macros.h> + +MRP_CDECL_BEGIN + +/* + * We use json-c as the underlying json implementation, However, we do + * not want direct json-c dependencies to spread all over the code base + * (at least not yet). So we try to define here an envelop layer that + * hides json-c underneath. + */ + +/** Type of a JSON object. */ +typedef json_object mrp_json_t; + +/** JSON object/member types. */ +typedef enum { + MRP_JSON_STRING = json_type_string, + MRP_JSON_BOOLEAN = json_type_boolean, + MRP_JSON_INTEGER = json_type_int, + MRP_JSON_DOUBLE = json_type_double, + MRP_JSON_OBJECT = json_type_object, + MRP_JSON_ARRAY = json_type_array +} mrp_json_type_t; + +/** Type for a JSON member iterator. */ +typedef json_object_iter mrp_json_iter_t; + +/** Create a new JSON object of the given type. */ +mrp_json_t *mrp_json_create(mrp_json_type_t type, ...); + +/** Clone the given JSON object, creating a new private copy of it. */ +mrp_json_t *mrp_json_clone(mrp_json_t *o); + +/** Deserialize a string to a JSON object. */ +mrp_json_t *mrp_json_string_to_object(const char *str, int len); + +/** Serialize a JSON object to a string. */ +const char *mrp_json_object_to_string(mrp_json_t *o); + +/** Add a reference to the given JSON object. */ +mrp_json_t *mrp_json_ref(mrp_json_t *o); + +/** Remove a reference from the given JSON object, freeing if it was last. */ +void mrp_json_unref(mrp_json_t *o); + +/** Get the type of a JSON object. */ +mrp_json_type_t mrp_json_get_type(mrp_json_t *o); + +/** Check if a JSON object has the given type. */ +int mrp_json_is_type(mrp_json_t *o, mrp_json_type_t type); + +/** Convenience macros to get values of JSON objects of basic types. */ +#define mrp_json_string_value(o) json_object_get_string(o) +#define mrp_json_integer_value(o) json_object_get_int(o) +#define mrp_json_double_value(o) json_object_get_double(o) +#define mrp_json_boolean_value(o) json_object_get_boolean(o) + +/** Set a member of a JSON object. */ +void mrp_json_add(mrp_json_t *o, const char *key, mrp_json_t *m); + +/** Create a new JSON object and set it as a member of another object. */ +mrp_json_t *mrp_json_add_member(mrp_json_t *o, const char *key, + mrp_json_type_t type, ...); + +/** Convenience macros to add members of various basic types. */ +#define mrp_json_add_string(o, key, s) \ + mrp_json_add_member(o, key, MRP_JSON_STRING, s, -1) + +#define mrp_json_add_string_slice(o, key, s, l) \ + mrp_json_add_member(o, key, MRP_JSON_STRING, s, l) + +#define mrp_json_add_integer(o, key, i) \ + mrp_json_add_member(o, key, MRP_JSON_INTEGER, i) + +#define mrp_json_add_double(o, key, d) \ + mrp_json_add_member(o, key, MRP_JSON_DOUBLE, d) + +#define mrp_json_add_boolean(o, key, b) \ + mrp_json_add_member(o, key, MRP_JSON_BOOLEAN, (int)b) + +/** Add an array member from a native C array of the given type. */ +mrp_json_t *mrp_json_add_array(mrp_json_t *o, const char *key, + mrp_json_type_t type, ...); + +/** Convenience macros for adding arrays of various basic types. */ +#define mrp_json_add_string_array(o, key, arr, size) \ + mrp_json_add_array(o, key, MRP_JSON_STRING, arr, size) + +#define mrp_json_add_int_array(o, key, arr, size) \ + mrp_json_add_array(o, key, MRP_JSON_INTEGER, arr, size) + +#define mrp_json_add_double_array(o, key, arr, size) \ + mrp_json_add_array(o, key, MRP_JSON_DOUBLE, arr, size) + +#define mrp_json_add_boolean_array(o, key, arr, size) \ + mrp_json_add_array(o, key, MRP_JSON_BOOLEAN, arr, size) + +/** Get the member of a JSON object as a json object. */ +mrp_json_t *mrp_json_get(mrp_json_t *o, const char *key); + +/** Get the member of a JSON object in a type specific format. */ +int mrp_json_get_member(mrp_json_t *o, const char *key, + mrp_json_type_t type, ...); + +/** Convenience macros to get members of various types. */ +#define mrp_json_get_string(o, key, sptr) \ + mrp_json_get_member(o, key, MRP_JSON_STRING, sptr) + +#define mrp_json_get_integer(o, key, iptr) \ + mrp_json_get_member(o, key, MRP_JSON_INTEGER, iptr) + +#define mrp_json_get_double(o, key, dptr) \ + mrp_json_get_member(o, key, MRP_JSON_DOUBLE, dptr) + +#define mrp_json_get_boolean(o, key, bptr) \ + mrp_json_get_member(o, key, MRP_JSON_BOOLEAN, bptr) + +#define mrp_json_get_array(o, key, aptr) \ + mrp_json_get_member(o, key, MRP_JSON_ARRAY, aptr) + +#define mrp_json_get_object(o, key, optr) \ + mrp_json_get_member(o, key, MRP_JSON_OBJECT, optr) + +/** Delete a member of a JSON object. */ +void mrp_json_del_member(mrp_json_t *o, const char *key); + +/** Get the length of a JSON array object. */ +int mrp_json_array_length(mrp_json_t *a); + +/** Append a JSON object to an array object. */ +int mrp_json_array_append(mrp_json_t *a, mrp_json_t *v); + +/** Create and append a new item to a JSON array object. */ +mrp_json_t *mrp_json_array_append_item(mrp_json_t *a, mrp_json_type_t type, + ...); + +/** Convenience macros for appending array items of basic types. */ +#define mrp_json_array_append_string(a, s) \ + mrp_json_array_append_item(a, MRP_JSON_STRING, s, -1) + +#define mrp_json_array_append_string_slice(a, s, l) \ + mrp_json_array_append_item(a, MRP_JSON_STRING, s, l) + + +#define mrp_json_array_append_integer(a, i) \ + mrp_json_array_append_item(a, MRP_JSON_INTEGER, (int)i) + +#define mrp_json_array_append_double(a, d) \ + mrp_json_array_append_item(a, MRP_JSON_DOUBLE, 1.0*d) + +#define mrp_json_array_append_boolean(a, b) \ + mrp_json_array_append_item(a, MRP_JSON_BOOLEAN, (int)b) + +/** Add a JSON object to a given index of an array object. */ +int mrp_json_array_set(mrp_json_t *a, int idx, mrp_json_t *v); + +/** Add a JSON object to a given index of an array object. */ +int mrp_json_array_set_item(mrp_json_t *a, int idx, mrp_json_type_t type, ...); + +/** Get the object at a given index of a JSON array object. */ +mrp_json_t *mrp_json_array_get(mrp_json_t *a, int idx); + +/** Get the element of a JSON array object at an index. */ +int mrp_json_array_get_item(mrp_json_t *a, int idx, mrp_json_type_t type, ...); + +/** Convenience macros to get items of certain types from an array. */ +#define mrp_json_array_get_string(a, idx, sptr) \ + mrp_json_array_get_item(a, idx, MRP_JSON_STRING, sptr) + +#define mrp_json_array_get_integer(a, idx, iptr) \ + mrp_json_array_get_item(a, idx, MRP_JSON_INTEGER, iptr) + +#define mrp_json_array_get_double(a, idx, dptr) \ + mrp_json_array_get_item(a, idx, MRP_JSON_DOUBLE, dptr) + +#define mrp_json_array_get_boolean(a, idx, bptr) \ + mrp_json_array_get_item(a, idx, MRP_JSON_BOOLEAN, bptr) + +#define mrp_json_array_get_array(a, idx, aptr) \ + mrp_json_array_get_item(a, idx, MRP_JSON_ARRAY, aptr) + +#define mrp_json_array_get_object(a, idx, optr) \ + mrp_json_array_get_item(a, idx, MRP_JSON_OBJECT, optr) + +/** Iterate through the members of an object. */ +#define mrp_json_foreach_member(o, _k, _v, it) \ + for (it.entry = json_object_get_object((o))->head; \ + (it.entry ? \ + (_k = it.key = it.entry->k, \ + _v = it.val = (mrp_json_t *)it.entry->v, \ + it.entry) : 0); \ + it.entry = it.entry->next) + +/** Parse a JSON object from the given string. */ +int mrp_json_parse_object(char **str, int *len, mrp_json_t **op); + +MRP_CDECL_END + +#endif /* __MURPHY_JSON_H__ */ |