dbutils: comparison ucx/cx/json.h

-:d33eaaec15da
+:287484519844
 #include "string.h"
 #include "buffer.h"
 #include "array_list.h"
 #include "map.h"
-#include <string.h>
 #ifdef __cplusplus
 extern "C" {
 #endif
 * Type alias for the JSON value struct.
 */
 typedef struct cx_json_value_s CxJsonValue;
 /**
-* Type alias for the JSON array struct.
-*/
-typedef struct cx_json_array_s CxJsonArray;
-/**
 * Type alias for the map representing a JSON object.
 * The map contains pointers of type @c CxJsonValue.
 */
 typedef CxMap* CxJsonObject;
 /**
 typedef double CxJsonNumber;
 /**
 * Type alias for a JSON literal.
 */
 typedef enum cx_json_literal CxJsonLiteral;
-/**
-* JSON array structure.
-*/
-struct cx_json_array_s {
-/**
-* The array data.
-*/
-CX_ARRAY_DECLARE(CxJsonValue*, data);
-};
 /**
 * Structure for a JSON value.
 */
 struct cx_json_value_s {
 */
 union {
 /**
 * The array data if the type is #CX_JSON_ARRAY.
 */
-CxJsonArray array;
+CX_ARRAY(CxJsonValue*, array);
 /**
 * The object data if the type is #CX_JSON_OBJECT.
 */
 CxJsonObject object;
 /**
 struct cx_json_s {
 /**
 * The allocator used for produced JSON values.
 */
 const CxAllocator *allocator;
 /**
 * The input buffer.
 */
 CxBuffer buffer;
 cxmutstr uncompleted_member_name;
 /**
 * State stack.
 */
-CX_ARRAY_DECLARE_SIZED(int, states, unsigned);
+CX_ARRAY(int, states);
 /**
 * Value buffer stack.
 */
-CX_ARRAY_DECLARE_SIZED(CxJsonValue*, vbuf, unsigned);
+CX_ARRAY(CxJsonValue*, vbuf);
 /**
 * Internally reserved memory for the state stack.
 */
 int states_internal[8];
 * @retval non-zero when no or not all data could be written
 */
 cx_attr_nonnull_arg(1, 2, 3)
 CX_EXPORT int cxJsonWrite(void* target, const CxJsonValue* value,
 cx_write_func wfunc, const CxJsonWriter* settings);
+/**
+* Produces a compact string representation of the specified JSON value.
+*
+* @param allocator the allocator for the string
+* @param value the JSON value
+* @return the produced string
+* @see cxJsonWrite()
+* @see cxJsonWriterCompact()
+* @see cxJsonToPrettyString()
+*/
+cx_attr_nonnull_arg(2)
+CX_EXPORT cxmutstr cxJsonToString(const CxAllocator *allocator, CxJsonValue *value);
+/**
+* Produces a pretty string representation of the specified JSON value.
+*
+* @param allocator the allocator for the string
+* @param value the JSON value
+* @return the produced string
+* @see cxJsonWrite()
+* @see cxJsonWriterPretty()
+* @see cxJsonToString()
+*/
+cx_attr_nonnull_arg(2)
+CX_EXPORT cxmutstr cxJsonToPrettyString(const CxAllocator *allocator, CxJsonValue *value);
 /**
 * Initializes the JSON interface.
 *
 * @param json the JSON interface
 CX_EXPORT CxJsonValue* cxJsonCreateObj(const CxAllocator* allocator);
 /**
 * Creates a new (empty) JSON array.
 *
+* Optionally, this function already allocates memory with the given capacity.
+*
 * @param allocator the allocator to use
+* @param capacity optional capacity or zero if it's unknown how many elements the array will have
 * @return the new JSON array or @c NULL if allocation fails
 * @see cxJsonObjPutArr()
 * @see cxJsonArrAddValues()
 */
 cx_attr_nodiscard
-CX_EXPORT CxJsonValue* cxJsonCreateArr(const CxAllocator* allocator);
+CX_EXPORT CxJsonValue* cxJsonCreateArr(const CxAllocator* allocator, size_t capacity);
 /**
 * Creates a new JSON number value.
 *
 * @param allocator the allocator to use
 *
 * Internal function - use cxJsonObjPutArr().
 *
 * @param obj the target JSON object
 * @param name the name of the new value
+* @param capacity optional initial capacity
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateArr()
 */
 cx_attr_nonnull
-CX_EXPORT CxJsonValue* cx_json_obj_put_arr(CxJsonValue* obj, cxstring name);
+CX_EXPORT CxJsonValue* cx_json_obj_put_arr(CxJsonValue* obj, cxstring name, size_t capacity);
 /**
 * Creates a new JSON array and adds it to an object.
 *
 * @param obj (@c CxJsonValue*) the target JSON object
 * @param name (any string) the name of the new value
+* @param capacity (@c size_t) optional initial capacity
 * @return (@c CxJsonValue*) the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateArr()
 */
-#define cxJsonObjPutArr(obj, name) cx_json_obj_put_arr(obj, cx_strcast(name))
+#define cxJsonObjPutArr(obj, name, capacity) cx_json_obj_put_arr(obj, cx_strcast(name), capacity)
 /**
 * Creates a new JSON number and adds it to an object.
 *
 * Internal function - use cxJsonObjPutNumber().
 * @return the size of the array
 * @see cxJsonIsArray()
 */
 cx_attr_nonnull
 CX_INLINE size_t cxJsonArrSize(const CxJsonValue *value) {
-return value->array.data_size;
+return value->array.size;
 }
 /**
 * Returns an element from a JSON array.
 *
 * @return the value corresponding to the key or @c NULL when the key is not part of the object
 * @see cxJsonIsObject()
 */
 #define cxJsonObjRemove(value, name) cx_json_obj_remove(value, cx_strcast(name))
+/**
+* Performs a deep comparison of two JSON values.
+*
+* The order of object members is ignored during comparison.
+*
+* @param json the JSON value
+* @param other the other JSON value that the JSON value is compared to
+* @retval zero the values are equal (except for ordering of object members)
+* @retval non-zero the values differ
+*/
+CX_EXPORT int cxJsonCompare(const CxJsonValue *json, const CxJsonValue *other);
+/**
+* Creates a deep copy of the specified JSON value.
+*
+* If you need a @c cx_clone_func compatible version, see cxJsonCloneFunc().
+*
+* @note when you are cloning @c NULL, you will get a pointer to a statically
+* allocated value which represents nothing.
+*
+* @param value the value to be cloned
+* @param allocator the allocator for the new value
+* @return the new value or @c NULL if any allocation was unsuccessful
+* @see cxJsonCloneFunc()
+*/
+cx_attr_nodiscard
+CX_EXPORT CxJsonValue* cxJsonClone(const CxJsonValue* value,
+const CxAllocator* allocator);
+/**
+* A @c cx_clone_func compatible version of cxJsonClone().
+*
+* Internal function - use cxJsonCloneFunc() to get a properly casted function pointer.
+*
+* @param target the target memory or @c NULL
+* @param source the value to be cloned
+* @param allocator the allocator for the new value
+* @param data unused
+* @return the new value or @c NULL if any allocation was unsuccessful
+* @see cxJsonClone()
+*/
+cx_attr_nodiscard
+CX_EXPORT CxJsonValue* cx_json_clone_func(
+CxJsonValue* target, const CxJsonValue* source,
+const CxAllocator* allocator, void *data);
+/**
+* A @c cx_clone_func compatible version of cxJsonClone().
+*
+* @param target (@c CxJsonValue*) the target memory or @c NULL
+* @param source (@c CxJsonValue*) the value to be cloned
+* @param allocator (@c CxAllocator*) the allocator for the new value
+* @param data unused
+* @return the new value or @c NULL if any allocation was unsuccessful
+* @see cxJsonClone()
+*/
+#define cxJsonCloneFunc  ((cx_clone_func) cx_json_clone_func)
 #ifdef __cplusplus
 }
 #endif
 #endif /* UCX_JSON_H */

Mercurial > hg > dbutils / file comparison

comparison: ucx/cx/json.h

ucx/cx/json.h