toolkit: comparison ucx/cx/json.h

-:118e2386d5b4
+:063a9f29098c
 /**
 * The token type.
 */
 CxJsonTokenType tokentype;
 /**
-* True, iff the @c content must be passed to cx_strfree().
+* True, if the @c content must be passed to cx_strfree().
 */
 bool allocated;
 /**
 * The token text, if any.
 *
 /**
 * Internally reserved memory for the value buffer stack.
 */
 CxJsonValue* vbuf_internal[8];
-/**
-* Used internally.
-*/
-bool tokenizer_escape; // TODO: check if it can be replaced with look-behind
 };
 /**
 * Status codes for the json interface.
 */
 * Set false to output the members in the order in which they were added.
 */
 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.
 */
 uint8_t frac_max_digits;
 /**
 * Set true to use spaces instead of tab characters.
 * Indentation is only used in pretty output.
 /**
 * If @c indent_space is true, this is the number of spaces per tab.
 * Indentation is only used in pretty output.
 */
 uint8_t indent;
+/**
+* Set true to enable escaping of the slash character (solidus).
+*/
+bool escape_slash;
 };
 /**
 * Typedef for the json writer.
 */
 * Creates a default writer configuration for compact output.
 *
 * @return new JSON writer settings
 */
 cx_attr_nodiscard
+cx_attr_export
 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
 CxJsonWriter cxJsonWriterPretty(bool use_spaces);
 /**
 * Writes a JSON value to a buffer or stream.
 *
-* This function blocks until all data is written or an error when trying
+* This function blocks until either all data is written, or an error occurs.
-* to write data 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
 * @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
 int cxJsonWrite(
 void* target,
 const CxJsonValue* value,
 cx_write_func wfunc,
 const CxJsonWriter* settings
 * @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
 void cxJsonInit(CxJson *json, const CxAllocator *allocator);
 /**
 * Destroys the json interface.
 *
 * @param json the json interface
 * @see cxJsonInit()
 */
 cx_attr_nonnull
+cx_attr_export
 void cxJsonDestroy(CxJson *json);
 /**
 * Destroys and re-initializes the json interface.
 *
 * @retval non-zero internal allocation error
 * @see cxJsonFill()
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxJsonFilln(CxJson *json, const char *buf, size_t len);
 #ifdef __cplusplus
 } // extern "C"
 * @return the new JSON object or @c NULL if allocation fails
 * @see cxJsonObjPutObj()
 * @see cxJsonArrAddValues()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxJsonValue* cxJsonCreateObj(const CxAllocator* allocator);
 /**
 * Creates a new (empty) JSON array.
 *
 * @return the new JSON array or @c NULL if allocation fails
 * @see cxJsonObjPutArr()
 * @see cxJsonArrAddValues()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxJsonValue* cxJsonCreateArr(const CxAllocator* allocator);
 /**
 * Creates a new JSON number value.
 *
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonObjPutNumber()
 * @see cxJsonArrAddNumbers()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxJsonValue* cxJsonCreateNumber(const CxAllocator* allocator, double num);
 /**
 * Creates a new JSON number value based on an integer.
 *
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonObjPutInteger()
 * @see cxJsonArrAddIntegers()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxJsonValue* cxJsonCreateInteger(const CxAllocator* allocator, int64_t num);
 /**
 * Creates a new JSON string.
 *
 * @see cxJsonArrAddStrings()
 */
 cx_attr_nodiscard
 cx_attr_nonnull_arg(2)
 cx_attr_cstr_arg(2)
+cx_attr_export
 CxJsonValue* cxJsonCreateString(const CxAllocator* allocator, const char *str);
 /**
 * Creates a new JSON string.
 *
 * @see cxJsonCreateCxString()
 * @see cxJsonObjPutCxString()
 * @see cxJsonArrAddCxStrings()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxJsonValue* cxJsonCreateCxString(const CxAllocator* allocator, cxstring str);
 /**
 * Creates a new JSON literal.
 *
 * @return the new JSON value or @c NULL if allocation fails
 * @see cxJsonObjPutLiteral()
 * @see cxJsonArrAddLiterals()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxJsonValue* cxJsonCreateLiteral(const CxAllocator* allocator, CxJsonLiteral lit);
 /**
 * Adds number values to a JSON array.
 *
 * @retval zero success
 * @retval non-zero allocation failure
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+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.
 *
 * @retval zero success
 * @retval non-zero allocation failure
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxJsonArrAddIntegers(CxJsonValue* arr, const int64_t* num, size_t count);
 /**
 * Adds strings to a JSON array.
 *
 * @retval non-zero allocation failure
 * @see cxJsonArrAddCxStrings()
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxJsonArrAddStrings(CxJsonValue* arr, const char* const* str, size_t count);
 /**
 * Adds strings to a JSON array.
 *
 * @retval non-zero allocation failure
 * @see cxJsonArrAddStrings()
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxJsonArrAddCxStrings(CxJsonValue* arr, const cxstring* str, size_t count);
 /**
 * Adds literals to a JSON array.
 *
 * @retval zero success
 * @retval non-zero allocation failure
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxJsonArrAddLiterals(CxJsonValue* arr, const CxJsonLiteral* lit, size_t count);
 /**
 * Add arbitrary values to a JSON array.
 *
 * @retval zero success
 * @retval non-zero allocation failure
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxJsonArrAddValues(CxJsonValue* arr, CxJsonValue* const* val, size_t count);
 /**
 * Adds or replaces a value within a JSON object.
 *
 * @param child the value
 * @retval zero success
 * @retval non-zero allocation failure
 */
 cx_attr_nonnull
+cx_attr_export
 int cxJsonObjPut(CxJsonValue* obj, cxstring name, CxJsonValue* child);
 /**
 * Creates a new JSON object and adds it to an existing object.
 *
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateObj()
 */
 cx_attr_nonnull
+cx_attr_export
 CxJsonValue* cxJsonObjPutObj(CxJsonValue* obj, cxstring name);
 /**
 * Creates a new JSON array and adds it to an object.
 *
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateArr()
 */
 cx_attr_nonnull
+cx_attr_export
 CxJsonValue* cxJsonObjPutArr(CxJsonValue* obj, cxstring name);
 /**
 * Creates a new JSON number and adds it to an object.
 *
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateNumber()
 */
 cx_attr_nonnull
+cx_attr_export
 CxJsonValue* cxJsonObjPutNumber(CxJsonValue* obj, cxstring name, double num);
 /**
 * Creates a new JSON number, based on an integer, and adds it to an object.
 *
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateInteger()
 */
 cx_attr_nonnull
+cx_attr_export
 CxJsonValue* cxJsonObjPutInteger(CxJsonValue* obj, cxstring name, int64_t num);
 /**
 * Creates a new JSON string and adds it to an object.
 *
 * @see cxJsonObjPut()
 * @see cxJsonCreateString()
 */
 cx_attr_nonnull
 cx_attr_cstr_arg(3)
+cx_attr_export
 CxJsonValue* cxJsonObjPutString(CxJsonValue* obj, cxstring name, const char* str);
 /**
 * Creates a new JSON string and adds it to an object.
 *
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateCxString()
 */
 cx_attr_nonnull
+cx_attr_export
 CxJsonValue* cxJsonObjPutCxString(CxJsonValue* obj, cxstring name, cxstring str);
 /**
 * Creates a new JSON literal and adds it to an object.
 *
 * @return the new value or @c NULL if allocation fails
 * @see cxJsonObjPut()
 * @see cxJsonCreateLiteral()
 */
 cx_attr_nonnull
+cx_attr_export
 CxJsonValue* cxJsonObjPutLiteral(CxJsonValue* obj, cxstring name, CxJsonLiteral lit);
 /**
 * Recursively deallocates the memory of a JSON value.
 *
 * 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
 void cxJsonValueFree(CxJsonValue *value);
 /**
 * Tries to obtain the next JSON value.
 *
 * @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_access_w(2)
+cx_attr_export
 CxJsonStatus cxJsonNext(CxJson *json, CxJsonValue **value);
 /**
 * Checks if the specified value is a JSON object.
 *
 * @return the value at the specified index
 * @see cxJsonIsArray()
 */
 cx_attr_nonnull
 cx_attr_returns_nonnull
+cx_attr_export
 CxJsonValue *cxJsonArrGet(const CxJsonValue *value, size_t index);
 /**
 * Returns an iterator over the JSON array elements.
 *
 * @return an iterator over the array elements
 * @see cxJsonIsArray()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 CxIterator cxJsonArrIter(const CxJsonValue *value);
 /**
 * Returns an iterator over the JSON object members.
 *
 * @return an iterator over the object members
 * @see cxJsonIsObject()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 CxIterator cxJsonObjIter(const CxJsonValue *value);
 /**
 * @copydoc cxJsonObjGet()
 */
 cx_attr_nonnull
 cx_attr_returns_nonnull
+cx_attr_export
 CxJsonValue *cx_json_obj_get_cxstr(const CxJsonValue *value, cxstring name);
 #ifdef __cplusplus
 } // extern "C"
-CxJsonValue *cxJsonObjGet(const CxJsonValue *value, cxstring name) {
+static inline CxJsonValue *cxJsonObjGet(const CxJsonValue *value, cxstring name) {
 return cx_json_obj_get_cxstr(value, name);
 }
-CxJsonValue *cxJsonObjGet(const CxJsonValue *value, cxmutstr name) {
+static inline CxJsonValue *cxJsonObjGet(const CxJsonValue *value, cxmutstr name) {
 return cx_json_obj_get_cxstr(value, cx_strcast(name));
 }
-CxJsonValue *cxJsonObjGet(const CxJsonValue *value, const char *name) {
+static inline CxJsonValue *cxJsonObjGet(const CxJsonValue *value, const char *name) {
 return cx_json_obj_get_cxstr(value, cx_str(name));
 }
 extern "C" {
 #else

Mercurial > hg > toolkit / file comparison

comparison: ucx/cx/json.h

ucx/cx/json.h