cJSON_ParseWithOpts: Extract pasrse with internal_configuration

Also introduces a allow_data_after_json property in the internal
configuration.
This commit is contained in:
Max Bruckner 2018-02-01 01:24:36 +01:00
parent 772376ed92
commit 47f4337604
13 changed files with 64 additions and 51 deletions

69
cJSON.c
View File

@ -122,6 +122,7 @@ typedef struct internal_configuration
{ {
size_t buffer_size; size_t buffer_size;
cJSON_bool format; cJSON_bool format;
cJSON_bool allow_data_after_json;
void *(*allocate)(size_t size); void *(*allocate)(size_t size);
void (*deallocate)(void *pointer); void (*deallocate)(void *pointer);
void *(*reallocate)(void *pointer, size_t size); void *(*reallocate)(void *pointer, size_t size);
@ -150,6 +151,7 @@ static void *internal_realloc(void *pointer, size_t size)
static internal_configuration global_configuration = { static internal_configuration global_configuration = {
256, /* default buffer size */ 256, /* default buffer size */
true, /* enable formatting by default */ true, /* enable formatting by default */
true, /* allow data after the JSON by default */
internal_malloc, internal_malloc,
internal_free, internal_free,
internal_realloc internal_realloc
@ -1007,39 +1009,38 @@ static parse_buffer *skip_utf8_bom(parse_buffer * const buffer)
} }
/* Parse an object - create a new root, and populate. */ /* Parse an object - create a new root, and populate. */
CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated) static cJSON *parse(const char * const json, const internal_configuration * const configuration, size_t *end_position)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
cJSON *item = NULL; cJSON *item = NULL;
/* reset error position */ /* reset global error position */
global_error.json = NULL; global_error.json = NULL;
global_error.position = 0; global_error.position = 0;
if (value == NULL) if (json == NULL)
{ {
goto fail; goto fail;
} }
buffer.content = (const unsigned char*)value; buffer.content = (const unsigned char*)json;
buffer.length = strlen((const char*)value) + sizeof(""); buffer.length = strlen((const char*)json) + sizeof("");
buffer.offset = 0; buffer.offset = 0;
buffer.configuration = global_configuration; buffer.configuration = *configuration;
item = create_item(&global_configuration); item = create_item(configuration);
if (item == NULL) /* memory fail */ if (item == NULL)
{ {
goto fail; goto fail;
} }
if (!parse_value(item, buffer_skip_whitespace(skip_utf8_bom(&buffer)))) if (!parse_value(item, buffer_skip_whitespace(skip_utf8_bom(&buffer))))
{ {
/* parse failure. ep is set. */ /* parse failure. error position is set. */
goto fail; goto fail;
} }
/* if we require null-terminated JSON without appended garbage, skip and then check for a null terminator */ if (!configuration->allow_data_after_json)
if (require_null_terminated)
{ {
buffer_skip_whitespace(&buffer); buffer_skip_whitespace(&buffer);
if ((buffer.offset >= buffer.length) || buffer_at_offset(&buffer)[0] != '\0') if ((buffer.offset >= buffer.length) || buffer_at_offset(&buffer)[0] != '\0')
@ -1047,23 +1048,20 @@ CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return
goto fail; goto fail;
} }
} }
if (return_parse_end) *end_position = buffer.offset;
{
*return_parse_end = (const char*)buffer_at_offset(&buffer);
}
return item; return item;
fail: fail:
if (item != NULL) if (item != NULL)
{ {
delete_item(item, &global_configuration); delete_item(item, configuration);
} }
if (value != NULL) if (json != NULL)
{ {
error local_error; error local_error;
local_error.json = (const unsigned char*)value; local_error.json = (const unsigned char*)json;
local_error.position = 0; local_error.position = 0;
if (buffer.offset < buffer.length) if (buffer.offset < buffer.length)
@ -1075,21 +1073,36 @@ fail:
local_error.position = buffer.length - 1; local_error.position = buffer.length - 1;
} }
if (return_parse_end != NULL) *end_position = local_error.position;
{
*return_parse_end = (const char*)local_error.json + local_error.position;
}
global_error = local_error; global_error = local_error;
} }
return NULL; return NULL;
} }
/* Default options for cJSON_Parse */ /* Parse an object - create a new root, and populate. */
CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value) CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *json, const char **return_parse_end, cJSON_bool require_null_terminated)
{ {
return cJSON_ParseWithOpts(value, 0, 0); size_t end_position = 0;
internal_configuration configuration = global_configuration;
cJSON *item = NULL;
configuration.allow_data_after_json = !require_null_terminated;
item = parse(json, &configuration, &end_position);
if (return_parse_end != NULL)
{
*return_parse_end = json + end_position;
}
return item;
}
/* Default options for cJSON_Parse */
CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *json)
{
size_t end_position = 0;
return parse(json, &global_configuration, &end_position);
} }
#define cjson_min(a, b) ((a < b) ? a : b) #define cjson_min(a, b) ((a < b) ? a : b)
@ -1188,7 +1201,7 @@ CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON
CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format) CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format)
{ {
printbuffer p = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer p = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
if ((length < 0) || (buffer == NULL)) if ((length < 0) || (buffer == NULL))
{ {

View File

@ -137,10 +137,10 @@ CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks);
/* Memory Management: the caller is always responsible to free the results from all variants of cJSON_Parse (with cJSON_Delete) and cJSON_Print (with stdlib free, cJSON_Hooks.free_fn, or cJSON_free as appropriate). The exception is cJSON_PrintPreallocated, where the caller has full responsibility of the buffer. */ /* Memory Management: the caller is always responsible to free the results from all variants of cJSON_Parse (with cJSON_Delete) and cJSON_Print (with stdlib free, cJSON_Hooks.free_fn, or cJSON_free as appropriate). The exception is cJSON_PrintPreallocated, where the caller has full responsibility of the buffer. */
/* Supply a block of JSON, and this returns a cJSON object you can interrogate. */ /* Supply a block of JSON, and this returns a cJSON object you can interrogate. */
CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value); CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *json);
/* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */ /* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
/* If you supply a ptr in return_parse_end and parsing fails, then return_parse_end will contain a pointer to the error so will match cJSON_GetErrorPtr(). */ /* If you supply a ptr in return_parse_end and parsing fails, then return_parse_end will contain a pointer to the error so will match cJSON_GetErrorPtr(). */
CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated); CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *json, const char **return_parse_end, cJSON_bool require_null_terminated);
/* Render a cJSON entity to text for transfer/storage. */ /* Render a cJSON entity to text for transfer/storage. */
CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item); CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);

View File

@ -419,7 +419,7 @@ static void *failing_realloc(void *pointer, size_t size)
static void ensure_should_fail_on_failed_realloc(void) static void ensure_should_fail_on_failed_realloc(void)
{ {
printbuffer buffer = {NULL, 10, 0, 0, false, {256, false, &malloc, &free, &failing_realloc}}; printbuffer buffer = {NULL, 10, 0, 0, false, {256, false, true, &malloc, &free, &failing_realloc}};
buffer.buffer = (unsigned char*)malloc(100); buffer.buffer = (unsigned char*)malloc(100);
TEST_ASSERT_NOT_NULL(buffer.buffer); TEST_ASSERT_NOT_NULL(buffer.buffer);
@ -429,7 +429,7 @@ static void ensure_should_fail_on_failed_realloc(void)
static void skip_utf8_bom_should_skip_bom(void) static void skip_utf8_bom_should_skip_bom(void)
{ {
const unsigned char string[] = "\xEF\xBB\xBF{}"; const unsigned char string[] = "\xEF\xBB\xBF{}";
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = string; buffer.content = string;
buffer.length = sizeof(string); buffer.length = sizeof(string);
buffer.configuration = global_configuration; buffer.configuration = global_configuration;
@ -441,7 +441,7 @@ static void skip_utf8_bom_should_skip_bom(void)
static void skip_utf8_bom_should_not_skip_bom_if_not_at_beginning(void) static void skip_utf8_bom_should_not_skip_bom_if_not_at_beginning(void)
{ {
const unsigned char string[] = " \xEF\xBB\xBF{}"; const unsigned char string[] = " \xEF\xBB\xBF{}";
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = string; buffer.content = string;
buffer.length = sizeof(string); buffer.length = sizeof(string);
buffer.configuration = global_configuration; buffer.configuration = global_configuration;

View File

@ -44,7 +44,7 @@ static void assert_is_array(cJSON *array_item)
static void assert_not_array(const char *json) static void assert_not_array(const char *json)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = (const unsigned char*)json; buffer.content = (const unsigned char*)json;
buffer.length = strlen(json) + sizeof(""); buffer.length = strlen(json) + sizeof("");
buffer.configuration = global_configuration; buffer.configuration = global_configuration;
@ -55,7 +55,7 @@ static void assert_not_array(const char *json)
static void assert_parse_array(const char *json) static void assert_parse_array(const char *json)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = (const unsigned char*)json; buffer.content = (const unsigned char*)json;
buffer.length = strlen(json) + sizeof(""); buffer.length = strlen(json) + sizeof("");
buffer.configuration = global_configuration; buffer.configuration = global_configuration;

View File

@ -45,7 +45,7 @@ static void assert_is_number(cJSON *number_item)
static void assert_parse_number(const char *string, int integer, double real) static void assert_parse_number(const char *string, int integer, double real)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = (const unsigned char*)string; buffer.content = (const unsigned char*)string;
buffer.length = strlen(string) + sizeof(""); buffer.length = strlen(string) + sizeof("");

View File

@ -52,7 +52,7 @@ static void assert_is_child(cJSON *child_item, const char *name, int type)
static void assert_not_object(const char *json) static void assert_not_object(const char *json)
{ {
parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
parsebuffer.content = (const unsigned char*)json; parsebuffer.content = (const unsigned char*)json;
parsebuffer.length = strlen(json) + sizeof(""); parsebuffer.length = strlen(json) + sizeof("");
parsebuffer.configuration = global_configuration; parsebuffer.configuration = global_configuration;
@ -64,7 +64,7 @@ static void assert_not_object(const char *json)
static void assert_parse_object(const char *json) static void assert_parse_object(const char *json)
{ {
parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
parsebuffer.content = (const unsigned char*)json; parsebuffer.content = (const unsigned char*)json;
parsebuffer.length = strlen(json) + sizeof(""); parsebuffer.length = strlen(json) + sizeof("");
parsebuffer.configuration = global_configuration; parsebuffer.configuration = global_configuration;

View File

@ -45,7 +45,7 @@ static void assert_is_string(cJSON *string_item)
static void assert_parse_string(const char *string, const char *expected) static void assert_parse_string(const char *string, const char *expected)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = (const unsigned char*)string; buffer.content = (const unsigned char*)string;
buffer.length = strlen(string) + sizeof(""); buffer.length = strlen(string) + sizeof("");
buffer.configuration = global_configuration; buffer.configuration = global_configuration;
@ -59,7 +59,7 @@ static void assert_parse_string(const char *string, const char *expected)
static void assert_not_parse_string(const char * const string) static void assert_not_parse_string(const char * const string)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = (const unsigned char*)string; buffer.content = (const unsigned char*)string;
buffer.length = strlen(string) + sizeof(""); buffer.length = strlen(string) + sizeof("");
buffer.configuration = global_configuration; buffer.configuration = global_configuration;

View File

@ -43,7 +43,7 @@ static void assert_is_value(cJSON *value_item, int type)
static void assert_parse_value(const char *string, int type) static void assert_parse_value(const char *string, int type)
{ {
parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.content = (const unsigned char*) string; buffer.content = (const unsigned char*) string;
buffer.length = strlen(string) + sizeof(""); buffer.length = strlen(string) + sizeof("");
buffer.configuration = global_configuration; buffer.configuration = global_configuration;

View File

@ -31,10 +31,10 @@ static void assert_print_array(const char * const expected, const char * const i
cJSON item[1]; cJSON item[1];
printbuffer formatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer formatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
printbuffer unformatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer unformatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
parsebuffer.content = (const unsigned char*)input; parsebuffer.content = (const unsigned char*)input;
parsebuffer.length = strlen(input) + sizeof(""); parsebuffer.length = strlen(input) + sizeof("");
parsebuffer.configuration = global_configuration; parsebuffer.configuration = global_configuration;

View File

@ -28,7 +28,7 @@ static void assert_print_number(const char *expected, double input)
{ {
unsigned char printed[1024]; unsigned char printed[1024];
cJSON item[1]; cJSON item[1];
printbuffer buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.buffer = printed; buffer.buffer = printed;
buffer.length = sizeof(printed); buffer.length = sizeof(printed);
buffer.offset = 0; buffer.offset = 0;

View File

@ -31,9 +31,9 @@ static void assert_print_object(const char * const expected, const char * const
cJSON item[1]; cJSON item[1];
printbuffer formatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer formatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
printbuffer unformatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer unformatted_buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
/* buffer for parsing */ /* buffer for parsing */
parsebuffer.content = (const unsigned char*)input; parsebuffer.content = (const unsigned char*)input;

View File

@ -27,7 +27,7 @@
static void assert_print_string(const char *expected, const char *input) static void assert_print_string(const char *expected, const char *input)
{ {
unsigned char printed[1024]; unsigned char printed[1024];
printbuffer buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.buffer = printed; buffer.buffer = printed;
buffer.length = sizeof(printed); buffer.length = sizeof(printed);
buffer.offset = 0; buffer.offset = 0;

View File

@ -32,8 +32,8 @@ static void assert_print_value(const char *input)
{ {
unsigned char printed[1024]; unsigned char printed[1024];
cJSON item[1]; cJSON item[1];
printbuffer buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; printbuffer buffer = { 0, 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0 } }; parse_buffer parsebuffer = { 0, 0, 0, 0, { 0, 0, 0, 0, 0, 0 } };
buffer.buffer = printed; buffer.buffer = printed;
buffer.length = sizeof(printed); buffer.length = sizeof(printed);
buffer.offset = 0; buffer.offset = 0;