dav: comparison ucx/cx/json.h

-:b60487c3ec36
+:af685cc9d623
 /**
 * A string token.
 */
 CX_JSON_TOKEN_STRING,
 /**
-* A number token that can be represented as integer.
+* A number token that can be represented as an integer.
 */
 CX_JSON_TOKEN_INTEGER,
 /**
-* A number token that cannot be represented as integer.
+* A number token that cannot be represented as an integer.
 */
 CX_JSON_TOKEN_NUMBER,
 /**
 * A literal token.
 */
 /**
 * Type alias for a JSON string.
 */
 typedef struct cx_mutstr_s CxJsonString;
 /**
-* Type alias for a number that can be represented as 64-bit signed integer.
+* Type alias for a number that can be represented as a 64-bit signed integer.
 */
 typedef int64_t CxJsonInteger;
 /**
-* Type alias for number that is not an integer.
+* Type alias for a number that is not an integer.
 */
 typedef double CxJsonNumber;
 /**
 * Type alias for a JSON literal.
 */
 /**
 * The value data.
 */
 union {
 /**
-* The array data if type is #CX_JSON_ARRAY.
+* The array data if the type is #CX_JSON_ARRAY.
 */
 CxJsonArray array;
 /**
-* The object data if type is #CX_JSON_OBJECT.
+* The object data if the type is #CX_JSON_OBJECT.
 */
 CxJsonObject object;
 /**
-* The string data if type is #CX_JSON_STRING.
+* The string data if the type is #CX_JSON_STRING.
 */
 CxJsonString string;
 /**
-* The integer if type is #CX_JSON_INTEGER.
+* The integer if the type is #CX_JSON_INTEGER.
 */
 CxJsonInteger integer;
 /**
-* The number if type is #CX_JSON_NUMBER.
+* The number if the type is #CX_JSON_NUMBER.
 */
 CxJsonNumber number;
 /**
-* The literal type if type is #CX_JSON_LITERAL.
+* The literal type if the type is #CX_JSON_LITERAL.
 */
 CxJsonLiteral literal;
 } value;
 };
 */
 CxJsonValue* vbuf_internal[8];
 };
 /**
-* Status codes for the json interface.
+* Status codes for the JSON interface.
 */
 enum cx_json_status {
 /**
 * Everything is fine.
 */
 */
 CX_JSON_NO_DATA,
 /**
 * The input ends unexpectedly.
 *
-* Refill the buffer with cxJsonFill() to complete the json data.
+* Refill the buffer with cxJsonFill() to complete the JSON data.
 */
 CX_JSON_INCOMPLETE_DATA,
 /**
 * Not used as a status and never returned by any function.
 *
 * You can use this enumerator to check for all "good" status results
 * by checking if the status is less than @c CX_JSON_OK.
 *
-* A "good" status means, that you can refill data and continue parsing.
+* A "good" status means that you can refill data and continue parsing.
 */
 CX_JSON_OK,
 /**
 * The input buffer has never been filled.
 */
 /**
 * Allocating memory for the internal buffer failed.
 */
 CX_JSON_BUFFER_ALLOC_FAILED,
 /**
-* Allocating memory for a json value failed.
+* Allocating memory for a JSON value failed.
 */
 CX_JSON_VALUE_ALLOC_FAILED,
 /**
 * A number value is incorrectly formatted.
 */
 */
 CX_JSON_FORMAT_ERROR_UNEXPECTED_TOKEN
 };
 /**
-* Typedef for the json status enum.
+* Typedef for the JSON status enum.
 */
 typedef enum cx_json_status CxJsonStatus;
 /**
 * The JSON writer settings.
 */
 bool sort_members;
 /**
 * The maximum number of fractional digits in a number value.
 * The default value is 6 and values larger than 15 are reduced to 15.
-* Note, that the actual number of digits may be lower, depending on the concrete number.
+* Note that the actual number of digits may be lower, depending on the concrete number.
 */
 uint8_t frac_max_digits;
 /**
 * Set true to use spaces instead of tab characters.
 * Indentation is only used in pretty output.
 */
 bool escape_slash;
 };
 /**
-* Typedef for the json writer.
+* Typedef for the JSON writer.
 */
 typedef struct cx_json_writer_s CxJsonWriter;
 /**
 * Creates a default writer configuration for compact output.
 *
 * @return new JSON writer settings
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonWriter cxJsonWriterCompact(void);
-CxJsonWriter cxJsonWriterCompact(void);
 /**
 * Creates a default writer configuration for pretty output.
 *
 * @param use_spaces false if you want tabs, true if you want four spaces instead
 * @return new JSON writer settings
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonWriter cxJsonWriterPretty(bool use_spaces);
-CxJsonWriter cxJsonWriterPretty(bool use_spaces);
 /**
 * Writes a JSON value to a buffer or stream.
 *
 * This function blocks until either all data is written, or an error occurs.
 * The write operation is not atomic in the sense that it might happen
 * that the data is only partially written when an error occurs with no
 * way to indicate how much data was written.
 * To avoid this problem, you can use a CxBuffer as @p target which is
-* unlikely to fail a write operation and either use the buffer's flush
+* unlikely to fail a write operation. You can, for example, use the buffer's flush
-* feature to relay the data or use the data in the buffer manually to
+* feature to relay the data.
-* write it to the actual target.
 *
 * @param target the buffer or stream where to write to
 * @param value the value that shall be written
 * @param wfunc the write function to use
 * @param settings formatting settings (or @c NULL to use a compact default)
 * @retval zero success
 * @retval non-zero when no or not all data could be written
 */
 cx_attr_nonnull_arg(1, 2, 3)
-cx_attr_export
+CX_EXPORT int cxJsonWrite(void* target, const CxJsonValue* value,
-int cxJsonWrite(
+cx_write_func wfunc, const CxJsonWriter* settings);
-void* target,
-const CxJsonValue* value,
+/**
-cx_write_func wfunc,
+* Initializes the JSON interface.
-const CxJsonWriter* settings
+*
-);
+* @param json the JSON interface
-/**
-* Initializes the json interface.
-*
-* @param json the json interface
 * @param allocator the allocator that shall be used for the produced values
 * @see cxJsonDestroy()
 */
 cx_attr_nonnull_arg(1)
-cx_attr_export
+CX_EXPORT void cxJsonInit(CxJson *json, const CxAllocator *allocator);
-void cxJsonInit(CxJson *json, const CxAllocator *allocator);
+/**
-/**
+* Destroys the JSON interface.
-* Destroys the json interface.
+*
-*
+* @param json the JSON interface
-* @param json the json interface
 * @see cxJsonInit()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT void cxJsonDestroy(CxJson *json);
-void cxJsonDestroy(CxJson *json);
+/**
-/**
+* Destroys and re-initializes the JSON interface.
-* Destroys and re-initializes the json interface.
+*
-*
+* You might want to use this to reset the parser after
-* You might want to use this, to reset the parser after
 * encountering a syntax error.
 *
-* @param json the json interface
+* @param json the JSON interface
 */
 cx_attr_nonnull
-static inline void cxJsonReset(CxJson *json) {
+CX_EXPORT void cxJsonReset(CxJson *json);
-const CxAllocator *allocator = json->allocator;
-cxJsonDestroy(json);
-cxJsonInit(json, allocator);
-}
 /**
 * Fills the input buffer.
 *
 * @remark The JSON interface tries to avoid copying the input data.
 * pointer to the data in that case. When you invoke the fill
 * function more than once before calling cxJsonNext(),
 * the additional data is appended - inevitably leading to
 * an allocation of a new buffer and copying the previous contents.
 *
-* @param json the json interface
+* @param json the JSON interface
 * @param buf the source buffer
 * @param len the length of the source buffer
 * @retval zero success
 * @retval non-zero internal allocation error
 * @see cxJsonFill()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonFilln(CxJson *json, const char *buf, size_t len);
-cx_attr_export
-int cxJsonFilln(CxJson *json, const char *buf, size_t len);
+/**
-#ifdef __cplusplus
+* Internal function, do not use.
-} // extern "C"
+*
+* @param json the JSON interface
-cx_attr_nonnull
+* @param str the string
-static inline int cxJsonFill(
+* @retval zero success
-CxJson *json,
+* @retval non-zero internal allocation error
-cxstring str
+*/
-) {
+cx_attr_nonnull
+CX_INLINE int cx_json_fill(CxJson *json, cxstring str) {
 return cxJsonFilln(json, str.ptr, str.length);
 }
-cx_attr_nonnull
-static inline int cxJsonFill(
-CxJson *json,
-cxmutstr str
-) {
-return cxJsonFilln(json, str.ptr, str.length);
-}
-cx_attr_nonnull
-cx_attr_cstr_arg(2)
-static inline int cxJsonFill(
-CxJson *json,
-const char *str
-) {
-return cxJsonFilln(json, str, strlen(str));
-}
-extern "C" {
-#else // __cplusplus
 /**
 * Fills the input buffer.
 *
 * The JSON interface tries to avoid copying the input data.
 * When you use this function and cxJsonNext() interleaving,
 * pointer to the data in that case. When you invoke the fill
 * function more than once before calling cxJsonNext(),
 * the additional data is appended - inevitably leading to
 * an allocation of a new buffer and copying the previous contents.
 *
-* @param json the json interface
+* @param json the JSON interface
 * @param str the source string
 * @retval zero success
 * @retval non-zero internal allocation error
 * @see cxJsonFilln()
 */
-#define cxJsonFill(json, str) _Generic((str), \
+#define cxJsonFill(json, str) cx_json_fill(json, cx_strcast(str))
-cxstring: cx_json_fill_cxstr,             \
-cxmutstr: cx_json_fill_mutstr,            \
-char*: cx_json_fill_str,                  \
-const char*: cx_json_fill_str)            \
-(json, str)
-/**
-* @copydoc cxJsonFill()
-*/
-cx_attr_nonnull
-static inline int cx_json_fill_cxstr(
-CxJson *json,
-cxstring str
-) {
-return cxJsonFilln(json, str.ptr, str.length);
-}
-/**
-* @copydoc cxJsonFill()
-*/
-cx_attr_nonnull
-static inline int cx_json_fill_mutstr(
-CxJson *json,
-cxmutstr str
-) {
-return cxJsonFilln(json, str.ptr, str.length);
-}
-/**
-* @copydoc cxJsonFill()
-*/
-cx_attr_nonnull
-cx_attr_cstr_arg(2)
-static inline int cx_json_fill_str(
-CxJson *json,
-const char *str
-) {
-return cxJsonFilln(json, str, strlen(str));
-}
-#endif
 /**
 * Creates a new (empty) JSON object.
 *
 * @param allocator the allocator to use
 * @return the new JSON object or @c NULL if allocation fails
 * @see cxJsonObjPutObj()
 * @see cxJsonArrAddValues()
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonCreateObj(const CxAllocator* allocator);
-CxJsonValue* cxJsonCreateObj(const CxAllocator* allocator);
 /**
 * Creates a new (empty) JSON array.
 *
 * @param allocator the allocator to use
 * @return the new JSON array or @c NULL if allocation fails
 * @see cxJsonObjPutArr()
 * @see cxJsonArrAddValues()
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonCreateArr(const CxAllocator* allocator);
-CxJsonValue* cxJsonCreateArr(const CxAllocator* allocator);
 /**
 * Creates a new JSON number value.
 *
 * @param allocator the allocator to use
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonObjPutNumber()
 * @see cxJsonArrAddNumbers()
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonCreateNumber(const CxAllocator* allocator, double num);
-CxJsonValue* cxJsonCreateNumber(const CxAllocator* allocator, double num);
 /**
 * Creates a new JSON number value based on an integer.
 *
 * @param allocator the allocator to use
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonObjPutInteger()
 * @see cxJsonArrAddIntegers()
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonCreateInteger(const CxAllocator* allocator, int64_t num);
-CxJsonValue* cxJsonCreateInteger(const CxAllocator* allocator, int64_t num);
 /**
 * Creates a new JSON string.
 *
 * @param allocator the allocator to use
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonCreateString()
 * @see cxJsonObjPutString()
 * @see cxJsonArrAddStrings()
 */
-cx_attr_nodiscard
+cx_attr_nodiscard cx_attr_nonnull_arg(2) cx_attr_cstr_arg(2)
-cx_attr_nonnull_arg(2)
+CX_EXPORT CxJsonValue* cxJsonCreateString(const CxAllocator* allocator, const char *str);
-cx_attr_cstr_arg(2)
-cx_attr_export
-CxJsonValue* cxJsonCreateString(const CxAllocator* allocator, const char *str);
 /**
 * Creates a new JSON string.
 *
 * @param allocator the allocator to use
 * @see cxJsonCreateCxString()
 * @see cxJsonObjPutCxString()
 * @see cxJsonArrAddCxStrings()
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonCreateCxString(const CxAllocator* allocator, cxstring str);
-CxJsonValue* cxJsonCreateCxString(const CxAllocator* allocator, cxstring str);
 /**
 * Creates a new JSON literal.
 *
 * @param allocator the allocator to use
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonObjPutLiteral()
 * @see cxJsonArrAddLiterals()
 */
 cx_attr_nodiscard
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonCreateLiteral(const CxAllocator* allocator, CxJsonLiteral lit);
-CxJsonValue* cxJsonCreateLiteral(const CxAllocator* allocator, CxJsonLiteral lit);
 /**
 * Adds number values to a JSON array.
 *
 * @param arr the JSON array
 * @param num the array of values
 * @param count the number of elements
 * @retval zero success
 * @retval non-zero allocation failure
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonArrAddNumbers(CxJsonValue* arr, const double* num, size_t count);
-cx_attr_export
-int cxJsonArrAddNumbers(CxJsonValue* arr, const double* num, size_t count);
 /**
 * Adds number values, of which all are integers, to a JSON array.
 *
 * @param arr the JSON array
 * @param num the array of values
 * @param count the number of elements
 * @retval zero success
 * @retval non-zero allocation failure
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonArrAddIntegers(CxJsonValue* arr, const int64_t* num, size_t count);
-cx_attr_export
-int cxJsonArrAddIntegers(CxJsonValue* arr, const int64_t* num, size_t count);
 /**
 * Adds strings to a JSON array.
 *
 * The strings will be copied with the allocator of the array.
 * @param count the number of elements
 * @retval zero success
 * @retval non-zero allocation failure
 * @see cxJsonArrAddCxStrings()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonArrAddStrings(CxJsonValue* arr, const char* const* str, size_t count);
-cx_attr_export
-int cxJsonArrAddStrings(CxJsonValue* arr, const char* const* str, size_t count);
 /**
 * Adds strings to a JSON array.
 *
 * The strings will be copied with the allocator of the array.
 * @param count the number of elements
 * @retval zero success
 * @retval non-zero allocation failure
 * @see cxJsonArrAddStrings()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonArrAddCxStrings(CxJsonValue* arr, const cxstring* str, size_t count);
-cx_attr_export
-int cxJsonArrAddCxStrings(CxJsonValue* arr, const cxstring* str, size_t count);
 /**
 * Adds literals to a JSON array.
 *
 * @param arr the JSON array
 * @param lit the array of literal types
 * @param count the number of elements
 * @retval zero success
 * @retval non-zero allocation failure
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonArrAddLiterals(CxJsonValue* arr, const CxJsonLiteral* lit, size_t count);
-cx_attr_export
-int cxJsonArrAddLiterals(CxJsonValue* arr, const CxJsonLiteral* lit, size_t count);
 /**
 * Add arbitrary values to a JSON array.
 *
 * @attention In contrast to all other add functions, this function adds the values
 * @param val the values
 * @param count the number of elements
 * @retval zero success
 * @retval non-zero allocation failure
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxJsonArrAddValues(CxJsonValue* arr, CxJsonValue* const* val, size_t count);
-cx_attr_export
-int cxJsonArrAddValues(CxJsonValue* arr, CxJsonValue* const* val, size_t count);
 /**
 * Adds or replaces a value within a JSON object.
 *
 * The value will be directly added and not copied.
 * @param child the value
 * @retval zero success
 * @retval non-zero allocation failure
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT int cxJsonObjPut(CxJsonValue* obj, cxstring name, CxJsonValue* child);
-int cxJsonObjPut(CxJsonValue* obj, cxstring name, CxJsonValue* child);
 /**
 * Creates a new JSON object and adds it to an existing object.
 *
 * @param obj the target JSON object
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateObj()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonObjPutObj(CxJsonValue* obj, cxstring name);
-CxJsonValue* cxJsonObjPutObj(CxJsonValue* obj, cxstring name);
 /**
 * Creates a new JSON array and adds it to an object.
 *
 * @param obj the target JSON object
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateArr()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonObjPutArr(CxJsonValue* obj, cxstring name);
-CxJsonValue* cxJsonObjPutArr(CxJsonValue* obj, cxstring name);
 /**
 * Creates a new JSON number and adds it to an object.
 *
 * @param obj the target JSON object
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateNumber()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonObjPutNumber(CxJsonValue* obj, cxstring name, double num);
-CxJsonValue* cxJsonObjPutNumber(CxJsonValue* obj, cxstring name, double num);
 /**
 * Creates a new JSON number, based on an integer, and adds it to an object.
 *
 * @param obj the target JSON object
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateInteger()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonObjPutInteger(CxJsonValue* obj, cxstring name, int64_t num);
-CxJsonValue* cxJsonObjPutInteger(CxJsonValue* obj, cxstring name, int64_t num);
 /**
 * Creates a new JSON string and adds it to an object.
 *
 * The string data is copied.
 * @param str the string data
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateString()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_cstr_arg(3)
-cx_attr_cstr_arg(3)
+CX_EXPORT CxJsonValue* cxJsonObjPutString(CxJsonValue* obj, cxstring name, const char* str);
-cx_attr_export
-CxJsonValue* cxJsonObjPutString(CxJsonValue* obj, cxstring name, const char* str);
 /**
 * Creates a new JSON string and adds it to an object.
 *
 * The string data is copied.
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateCxString()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonObjPutCxString(CxJsonValue* obj, cxstring name, cxstring str);
-CxJsonValue* cxJsonObjPutCxString(CxJsonValue* obj, cxstring name, cxstring str);
 /**
 * Creates a new JSON literal and adds it to an object.
 *
 * @param obj the target JSON object
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateLiteral()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue* cxJsonObjPutLiteral(CxJsonValue* obj, cxstring name, CxJsonLiteral lit);
-CxJsonValue* cxJsonObjPutLiteral(CxJsonValue* obj, cxstring name, CxJsonLiteral lit);
 /**
 * Recursively deallocates the memory of a JSON value.
 *
 * @remark The type of each deallocated value will be changed
-* to #CX_JSON_NOTHING and values of such type will be skipped
+* to #CX_JSON_NOTHING, and values of such a type will be skipped
-* by the de-allocation. That means, this function protects
+* by the deallocation. That means this function protects
 * you from double-frees when you are accidentally freeing
 * a nested value and then the parent value (or vice versa).
 *
 * @param value the value
 */
-cx_attr_export
+CX_EXPORT void cxJsonValueFree(CxJsonValue *value);
-void cxJsonValueFree(CxJsonValue *value);
 /**
 * Tries to obtain the next JSON value.
 *
 * Before this function can be called, the input buffer needs
 *
 * When this function returns #CX_JSON_INCOMPLETE_DATA, you can
 * add the missing data with another invocation of cxJsonFill()
 * and then repeat the call to cxJsonNext().
 *
-* @param json the json interface
+* @param json the JSON interface
 * @param value a pointer where the next value shall be stored
 * @retval CX_JSON_NO_ERROR successfully retrieve the @p value
 * @retval CX_JSON_NO_DATA there is no (more) data in the buffer to read from
 * @retval CX_JSON_INCOMPLETE_DATA an incomplete value was read
 * and more data needs to be filled
 * @retval CX_JSON_BUFFER_ALLOC_FAILED allocating internal buffer space failed
 * @retval CX_JSON_VALUE_ALLOC_FAILED allocating memory for a CxJsonValue failed
 * @retval CX_JSON_FORMAT_ERROR_NUMBER the JSON text contains an illegally formatted number
 * @retval CX_JSON_FORMAT_ERROR_UNEXPECTED_TOKEN JSON syntax error
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_w(2)
-cx_attr_access_w(2)
+CX_EXPORT CxJsonStatus cxJsonNext(CxJson *json, CxJsonValue **value);
-cx_attr_export
-CxJsonStatus cxJsonNext(CxJson *json, CxJsonValue **value);
 /**
 * Checks if the specified value is a JSON object.
 *
 * @param value a pointer to the value
 * @retval true the value is a JSON object
 * @retval false otherwise
 */
 cx_attr_nonnull
-static inline bool cxJsonIsObject(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsObject(const CxJsonValue *value) {
 return value->type == CX_JSON_OBJECT;
 }
 /**
 * Checks if the specified value is a JSON array.
 * @param value a pointer to the value
 * @retval true the value is a JSON array
 * @retval false otherwise
 */
 cx_attr_nonnull
-static inline bool cxJsonIsArray(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsArray(const CxJsonValue *value) {
 return value->type == CX_JSON_ARRAY;
 }
 /**
 * Checks if the specified value is a string.
 * @param value a pointer to the value
 * @retval true the value is a string
 * @retval false otherwise
 */
 cx_attr_nonnull
-static inline bool cxJsonIsString(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsString(const CxJsonValue *value) {
 return value->type == CX_JSON_STRING;
 }
 /**
 * Checks if the specified value is a JSON number.
 *
-* This function will return true for both floating point and
+* This function will return true for both floating-point and
 * integer numbers.
 *
 * @param value a pointer to the value
 * @retval true the value is a JSON number
 * @retval false otherwise
 * @see cxJsonIsInteger()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsNumber(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsNumber(const CxJsonValue *value) {
 return value->type == CX_JSON_NUMBER || value->type == CX_JSON_INTEGER;
 }
 /**
 * Checks if the specified value is an integer number.
 * @retval true the value is an integer number
 * @retval false otherwise
 * @see cxJsonIsNumber()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsInteger(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsInteger(const CxJsonValue *value) {
 return value->type == CX_JSON_INTEGER;
 }
 /**
 * Checks if the specified value is a JSON literal.
 * @see cxJsonIsTrue()
 * @see cxJsonIsFalse()
 * @see cxJsonIsNull()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsLiteral(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsLiteral(const CxJsonValue *value) {
 return value->type == CX_JSON_LITERAL;
 }
 /**
 * Checks if the specified value is a Boolean literal.
 * @retval false otherwise
 * @see cxJsonIsTrue()
 * @see cxJsonIsFalse()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsBool(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsBool(const CxJsonValue *value) {
 return cxJsonIsLiteral(value) && value->value.literal != CX_JSON_NULL;
 }
 /**
 * Checks if the specified value is @c true.
 *
-* @remark Be advised, that this is not the same as
+* @remark Be advised that this is different from
 * testing @c !cxJsonIsFalse(v).
 *
 * @param value a pointer to the value
 * @retval true the value is @c true
 * @retval false otherwise
 * @see cxJsonIsBool()
 * @see cxJsonIsFalse()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsTrue(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsTrue(const CxJsonValue *value) {
 return cxJsonIsLiteral(value) && value->value.literal == CX_JSON_TRUE;
 }
 /**
 * Checks if the specified value is @c false.
 *
-* @remark Be advised, that this is not the same as
+* @remark Be advised that this is different from
 * testing @c !cxJsonIsTrue(v).
 *
 * @param value a pointer to the value
 * @retval true the value is @c false
 * @retval false otherwise
 * @see cxJsonIsBool()
 * @see cxJsonIsTrue()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsFalse(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsFalse(const CxJsonValue *value) {
 return cxJsonIsLiteral(value) && value->value.literal == CX_JSON_FALSE;
 }
 /**
 * Checks if the specified value is @c null.
 * @retval true the value is @c null
 * @retval false otherwise
 * @see cxJsonIsLiteral()
 */
 cx_attr_nonnull
-static inline bool cxJsonIsNull(const CxJsonValue *value) {
+CX_INLINE bool cxJsonIsNull(const CxJsonValue *value) {
 return cxJsonIsLiteral(value) && value->value.literal == CX_JSON_NULL;
 }
 /**
 * Obtains a C string from the given JSON value.
 *
 * @param value the JSON value
 * @return the value represented as C string
 * @see cxJsonIsString()
 */
-cx_attr_nonnull
+cx_attr_nonnull  cx_attr_returns_nonnull
-cx_attr_returns_nonnull
+CX_EXPORT char *cxJsonAsString(const CxJsonValue *value);
-static inline char *cxJsonAsString(const CxJsonValue *value) {
-return value->value.string.ptr;
-}
 /**
 * Obtains a UCX string from the given JSON value.
 *
 * If the @p value is not a string, the behavior is undefined.
 * @param value the JSON value
 * @return the value represented as UCX string
 * @see cxJsonIsString()
 */
 cx_attr_nonnull
-static inline cxstring cxJsonAsCxString(const CxJsonValue *value) {
+CX_EXPORT cxstring cxJsonAsCxString(const CxJsonValue *value);
-return cx_strcast(value->value.string);
-}
 /**
 * Obtains a mutable UCX string from the given JSON value.
 *
 * If the @p value is not a string, the behavior is undefined.
 * @param value the JSON value
 * @return the value represented as mutable UCX string
 * @see cxJsonIsString()
 */
 cx_attr_nonnull
-static inline cxmutstr cxJsonAsCxMutStr(const CxJsonValue *value) {
+CX_EXPORT cxmutstr cxJsonAsCxMutStr(const CxJsonValue *value);
-return value->value.string;
-}
+/**
+* Obtains a double-precision floating-point value from the given JSON value.
-/**
-* Obtains a double-precision floating point value from the given JSON value.
 *
 * If the @p value is not a JSON number, the behavior is undefined.
 *
 * @param value the JSON value
 * @return the value represented as double
 * @see cxJsonIsNumber()
 */
 cx_attr_nonnull
-static inline double cxJsonAsDouble(const CxJsonValue *value) {
+CX_EXPORT double cxJsonAsDouble(const CxJsonValue *value);
-if (value->type == CX_JSON_INTEGER) {
-return (double) value->value.integer;
-} else {
-return value->value.number;
-}
-}
 /**
 * Obtains a 64-bit signed integer from the given JSON value.
 *
 * If the @p value is not a JSON number, the behavior is undefined.
 * @return the value represented as double
 * @see cxJsonIsNumber()
 * @see cxJsonIsInteger()
 */
 cx_attr_nonnull
-static inline int64_t cxJsonAsInteger(const CxJsonValue *value) {
+CX_EXPORT int64_t cxJsonAsInteger(const CxJsonValue *value);
-if (value->type == CX_JSON_INTEGER) {
-return value->value.integer;
-} else {
-return (int64_t) value->value.number;
-}
-}
 /**
 * Obtains a Boolean value from the given JSON value.
 *
 * If the @p value is not a JSON literal, the behavior is undefined.
 * @param value the JSON value
 * @return the value represented as double
 * @see cxJsonIsLiteral()
 */
 cx_attr_nonnull
-static inline bool cxJsonAsBool(const CxJsonValue *value) {
+CX_INLINE bool cxJsonAsBool(const CxJsonValue *value) {
 return value->value.literal == CX_JSON_TRUE;
 }
 /**
 * Returns the size of a JSON array.
 * @param value the JSON value
 * @return the size of the array
 * @see cxJsonIsArray()
 */
 cx_attr_nonnull
-static inline size_t cxJsonArrSize(const CxJsonValue *value) {
+CX_INLINE size_t cxJsonArrSize(const CxJsonValue *value) {
 return value->value.array.array_size;
 }
 /**
 * Returns an element from a JSON array.
 * @param value the JSON value
 * @param index the index in the array
 * @return the value at the specified index
 * @see cxJsonIsArray()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_returns_nonnull
-cx_attr_returns_nonnull
+CX_EXPORT CxJsonValue *cxJsonArrGet(const CxJsonValue *value, size_t index);
-cx_attr_export
-CxJsonValue *cxJsonArrGet(const CxJsonValue *value, size_t index);
+/**
+* Removes an element from a JSON array.
+*
+* If the @p value is not a JSON array, the behavior is undefined.
+*
+* This function, in contrast to cxJsonArrayGet(), returns @c NULL
+* when the index is out of bounds.
+*
+* @param value the JSON value
+* @param index the index in the array
+* @return the removed value from the specified index or @c NULL when the index was out of bounds
+* @see cxJsonIsArray()
+*/
+cx_attr_nonnull
+CX_EXPORT CxJsonValue *cxJsonArrRemove(CxJsonValue *value, size_t index);
 /**
 * Returns an iterator over the JSON array elements.
 *
 * The iterator yields values of type @c CxJsonValue* .
 *
 * @param value the JSON value
 * @return an iterator over the array elements
 * @see cxJsonIsArray()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_nodiscard
-cx_attr_nodiscard
+CX_EXPORT CxIterator cxJsonArrIter(const CxJsonValue *value);
-cx_attr_export
-CxIterator cxJsonArrIter(const CxJsonValue *value);
 /**
 * Returns an iterator over the JSON object members.
 *
 * The iterator yields values of type @c CxJsonObjValue* which
 *
 * @param value the JSON value
 * @return an iterator over the object members
 * @see cxJsonIsObject()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_nodiscard
-cx_attr_nodiscard
+CX_EXPORT CxIterator cxJsonObjIter(const CxJsonValue *value);
-cx_attr_export
-CxIterator cxJsonObjIter(const CxJsonValue *value);
+/**
+* Internal function, do not use.
-/**
+* @param value the JSON object
-* @copydoc cxJsonObjGet()
+* @param name the key to look up
-*/
+* @return the value corresponding to the key
-cx_attr_nonnull
+*/
-cx_attr_returns_nonnull
+cx_attr_nonnull cx_attr_returns_nonnull
-cx_attr_export
+CX_EXPORT CxJsonValue *cx_json_obj_get(const CxJsonValue *value, cxstring name);
-CxJsonValue *cx_json_obj_get_cxstr(const CxJsonValue *value, cxstring name);
-#ifdef __cplusplus
-} // extern "C"
-static inline CxJsonValue *cxJsonObjGet(const CxJsonValue *value, cxstring name) {
-return cx_json_obj_get_cxstr(value, name);
-}
-static inline CxJsonValue *cxJsonObjGet(const CxJsonValue *value, cxmutstr name) {
-return cx_json_obj_get_cxstr(value, cx_strcast(name));
-}
-static inline CxJsonValue *cxJsonObjGet(const CxJsonValue *value, const char *name) {
-return cx_json_obj_get_cxstr(value, cx_str(name));
-}
-extern "C" {
-#else
 /**
 * Returns a value corresponding to a key in a JSON object.
 *
 * If the @p value is not a JSON object, the behavior is undefined.
 *
 * @param value the JSON object
 * @param name the key to look up
 * @return the value corresponding to the key
 * @see cxJsonIsObject()
 */
-#define cxJsonObjGet(value, name) _Generic((name), \
+#define cxJsonObjGet(value, name) cx_json_obj_get(value, cx_strcast(name))
-cxstring: cx_json_obj_get_cxstr,           \
-cxmutstr: cx_json_obj_get_mutstr,          \
+/**
-char*: cx_json_obj_get_str,                \
+* Internal function, do not use.
-const char*: cx_json_obj_get_str)          \
+* @param value the JSON object
-(value, name)
+* @param name the key to look up
+* @return the value corresponding to the key or @c NULL when the key is not part of the object
-/**
+*/
-* @copydoc cxJsonObjGet()
+cx_attr_nonnull
-*/
+CX_EXPORT CxJsonValue *cx_json_obj_remove(CxJsonValue *value, cxstring name);
-cx_attr_nonnull
-cx_attr_returns_nonnull
+/**
-static inline CxJsonValue *cx_json_obj_get_mutstr(const CxJsonValue *value, cxmutstr name) {
+* Removes and returns a value corresponding to a key in a JSON object.
-return cx_json_obj_get_cxstr(value, cx_strcast(name));
+*
-}
+* If the @p value is not a JSON object, the behavior is undefined.
+*
-/**
+* This function, in contrast to cxJsonObjGet() returns @c NULL when the
-* @copydoc cxJsonObjGet()
+* object does not contain @p name.
-*/
+*
-cx_attr_nonnull
+* @param value the JSON object
-cx_attr_returns_nonnull
+* @param name the key to look up
-cx_attr_cstr_arg(2)
+* @return the value corresponding to the key or @c NULL when the key is not part of the object
-static inline CxJsonValue *cx_json_obj_get_str(const CxJsonValue *value, const char *name) {
+* @see cxJsonIsObject()
-return cx_json_obj_get_cxstr(value, cx_str(name));
+*/
+#define cxJsonObjRemove(value, name) cx_json_obj_remove(value, cx_strcast(name))
+#ifdef __cplusplus
 }
 #endif
-#ifdef __cplusplus
-}
-#endif
 #endif /* UCX_JSON_H */

Mercurial > hg > dav / file comparison

comparison: ucx/cx/json.h

ucx/cx/json.h