shared: add JSMN v1.1.0 parser header
James Prestwood
PATCH v3 1/3 shared: add JSMN v1.1.0 parser header
--- shared/jsmn.h | 468 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 468 insertions(+) create mode 100644 shared/jsmn.h
v3:
* Added version in commit description
shared/jsmn.h new file +468 -0
@@ -0,0 +1,468 @@ +/* +* MIT License +* +* Copyright (c) 2010 Serge Zaitsev +* +* Permission is hereby granted, free of charge, to any person obtaining a copy +* of this software and associated documentation files (the "Software"), to deal +* in the Software without restriction, including without limitation the rights +* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +* copies of the Software, and to permit persons to whom the Software is +* furnished to do so, subject to the following conditions: +* +* The above copyright notice and this permission notice shall be included in +* all copies or substantial portions of the Software. +* +* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +* SOFTWARE. +*/ +#ifndef JSMN_H +#define JSMN_H + +#include <stddef.h> + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef JSMN_STATIC +#define JSMN_API static +#else +#define JSMN_API extern +#endif + +/** +* JSON type identifier. Basic types are: +* o Object +* o Array +* o String +* o Other primitive: number, boolean (true/false) or null +*/ +typedef enum { +JSMN_UNDEFINED =0 , +JSMN_OBJECT =1 , +JSMN_ARRAY =2 , +JSMN_STRING =3 , +JSMN_PRIMITIVE =4 +}jsmntype_t ; + +enum jsmnerr { +/* Not enough tokens were provided */ +JSMN_ERROR_NOMEM =-1 , +/* Invalid character inside JSON string */ +JSMN_ERROR_INVAL =-2 , +/* The string is not a full JSON packet, more bytes expected */ +JSMN_ERROR_PART =-3 +}; + +/** +* JSON token description. +* type type (object, array, string etc.) +* start start position in JSON data string +* end end position in JSON data string +*/ +typedef struct { +jsmntype_t type; +int start; +int end; +int size; +#ifdef JSMN_PARENT_LINKS +int parent; +#endif +}jsmntok_t ; + +/** +* JSON parser. Contains an array of token blocks available. Also stores +* the string being parsed now and current position in that string. +*/ +typedef struct { +unsigned int pos;/* offset in the JSON string */ +unsigned int toknext;/* next token to allocate */ +int toksuper;/* superior token node, e.g. parent object or array */ +}jsmn_parser ; + +/** +* Create JSON parser over an array of tokens +*/ +JSMN_API void jsmn_init(jsmn_parser *parser); + +/** +* Run JSON parser. It parses a JSON data string into and array of tokens, each +* describing +* a single JSON object. +*/ +JSMN_API int jsmn_parse(jsmn_parser *parser, const char *js, const size_t len, +jsmntok_t *tokens,const unsigned int num_tokens); + +#ifndef JSMN_HEADER +/** +* Allocates a fresh unused token from the token pool. +*/ +static jsmntok_t *jsmn_alloc_token (jsmn_parser *parser,jsmntok_t *tokens, +const size_t num_tokens) { +jsmntok_t *tok; +if (parser->toknext >= num_tokens) { +return NULL ; + } + tok = &tokens[parser->toknext++]; + tok->start = tok->end =-1 ; + tok->size =0 ; +#ifdef JSMN_PARENT_LINKS + tok->parent =-1 ; +#endif +return tok; +} + +/** +* Fills token type and boundaries. +*/ +static void jsmn_fill_token (jsmntok_t *token,const jsmntype_t type, +const int start,const int end) { + token->type = type; + token->start = start; + token->end = end; + token->size =0 ; +} + +/** +* Fills next available token with JSON primitive. +*/ +static int jsmn_parse_primitive (jsmn_parser *parser,const char *js, +const size_t len,jsmntok_t *tokens, +const size_t num_tokens) { +jsmntok_t *token; +int start; + + start = parser->pos; + +for (; parser->pos < len && js[parser->pos] !='\0' ; parser->pos++) { +switch (js[parser->pos]) { +#ifndef JSMN_STRICT +/* In strict mode primitive must be followed by "," or "}" or "]" */ +case ':' : +#endif +case '\t' : +case '\r' : +case '\n' : +case ' ' : +case ',' : +case ']' : +case '}' : + goto found; + } +if (js[parser->pos] <32 || js[parser->pos] >=127 ) { + parser->pos = start; +return JSMN_ERROR_INVAL ; + } + } +#ifdef JSMN_STRICT +/* In strict mode primitive must be followed by a comma/object/array */ + parser->pos = start; +return JSMN_ERROR_PART ; +#endif + +found: +if (tokens ==NULL ) { + parser->pos--; +return 0 ; + } + token =jsmn_alloc_token (parser, tokens, num_tokens); +if (token ==NULL ) { + parser->pos = start; +return JSMN_ERROR_NOMEM ; + } +jsmn_fill_token (token,JSMN_PRIMITIVE , start, parser->pos); +#ifdef JSMN_PARENT_LINKS + token->parent = parser->toksuper; +#endif + parser->pos--; +return 0 ; +} + +/** +* Fills next token with JSON string. +*/ +static int jsmn_parse_string (jsmn_parser *parser,const char *js, +const size_t len,jsmntok_t *tokens, +const size_t num_tokens) { +jsmntok_t *token; + +int start = parser->pos; + + parser->pos++; + +/* Skip starting quote */ +for (; parser->pos < len && js[parser->pos] !='\0' ; parser->pos++) { +char c = js[parser->pos]; + +/* Quote: end of string */ +if (c =='\"' ) { +if (tokens ==NULL ) { +return 0 ; + } + token =jsmn_alloc_token (parser, tokens, num_tokens); +if (token ==NULL ) { + parser->pos = start; +return JSMN_ERROR_NOMEM ; + } +jsmn_fill_token (token,JSMN_STRING , start +1 , parser->pos); +#ifdef JSMN_PARENT_LINKS + token->parent = parser->toksuper; +#endif +return 0 ; + } + +/* Backslash: Quoted symbol expected */ +if (c =='\\' && parser->pos +1 < len) { +int i; + parser->pos++; +switch (js[parser->pos]) { +/* Allowed escaped symbols */ +case '\"' : +case '/' : +case '\\' : +case 'b' : +case 'f' : +case 'r' : +case 'n' : +case 't' : +break ; +/* Allows escaped symbol \uXXXX */ +case 'u' : + parser->pos++; +for (i =0 ; i <4 && parser->pos < len && js[parser->pos] !='\0' ; + i++) { +/* If it isn't a hex character we have an error */ +if (!((js[parser->pos] >=48 && js[parser->pos] <=57 ) ||/* 0-9 */ + (js[parser->pos] >=65 && js[parser->pos] <=70 ) ||/* A-F */ + (js[parser->pos] >=97 && js[parser->pos] <=102 ))) {/* a-f */ + parser->pos = start; +return JSMN_ERROR_INVAL ; + } + parser->pos++; + } + parser->pos--; +break ; +/* Unexpected symbol */ +default : + parser->pos = start; +return JSMN_ERROR_INVAL ; + } + } + } + parser->pos = start; +return JSMN_ERROR_PART ; +} + +/** +* Parse JSON string and fill tokens. +*/ +JSMN_API int jsmn_parse(jsmn_parser *parser, const char *js, const size_t len, +jsmntok_t *tokens,const unsigned int num_tokens) { +int r; +int i; +jsmntok_t *token; +int count = parser->toknext; + +for (; parser->pos < len && js[parser->pos] !='\0' ; parser->pos++) { +char c; +jsmntype_t type; + + c = js[parser->pos]; +switch (c) { +case '{' : +case '[' : + count++; +if (tokens ==NULL ) { +break ; + } + token =jsmn_alloc_token (parser, tokens, num_tokens); +if (token ==NULL ) { +return JSMN_ERROR_NOMEM ; + } +if (parser->toksuper !=-1 ) { +jsmntok_t *t = &tokens[parser->toksuper]; +#ifdef JSMN_STRICT +/* In strict mode an object or array can't become a key */ +if (t->type ==JSMN_OBJECT ) { +return JSMN_ERROR_INVAL ; + } +#endif + t->size++; +#ifdef JSMN_PARENT_LINKS + token->parent = parser->toksuper; +#endif + } + token->type = (c =='{' ?JSMN_OBJECT :JSMN_ARRAY ); + token->start = parser->pos; + parser->toksuper = parser->toknext -1 ; +break ; +case '}' : +case ']' : +if (tokens ==NULL ) { +break ; + } + type = (c =='}' ?JSMN_OBJECT :JSMN_ARRAY ); +#ifdef JSMN_PARENT_LINKS +if (parser->toknext <1 ) { +return JSMN_ERROR_INVAL ; + } + token = &tokens[parser->toknext -1 ]; +for (;;) { +if (token->start !=-1 && token->end ==-1 ) { +if (token->type != type) { +return JSMN_ERROR_INVAL ; + } + token->end = parser->pos +1 ; + parser->toksuper = token->parent; +break ; + } +if (token->parent ==-1 ) { +if (token->type != type || parser->toksuper ==-1 ) { +return JSMN_ERROR_INVAL ; + } +break ; + } + token = &tokens[token->parent]; + } +#else +for (i = parser->toknext -1 ; i >=0 ; i--) { + token = &tokens[i]; +if (token->start !=-1 && token->end ==-1 ) { +if (token->type != type) { +return JSMN_ERROR_INVAL ; + } + parser->toksuper =-1 ; + token->end = parser->pos +1 ; +break ; + } + } +/* Error if unmatched closing bracket */ +if (i ==-1 ) { +return JSMN_ERROR_INVAL ; + } +for (; i >=0 ; i--) { + token = &tokens[i]; +if (token->start !=-1 && token->end ==-1 ) { + parser->toksuper = i; +break ; + } + } +#endif +break ; +case '\"' : + r =jsmn_parse_string (parser, js, len, tokens, num_tokens); +if (r <0 ) { +return r; + } + count++; +if (parser->toksuper !=-1 && tokens !=NULL ) { + tokens[parser->toksuper].size++; + } +break ; +case '\t' : +case '\r' : +case '\n' : +case ' ' : +break ; +case ':' : + parser->toksuper = parser->toknext -1 ; +break ; +case ',' : +if (tokens !=NULL && parser->toksuper !=-1 && + tokens[parser->toksuper].type !=JSMN_ARRAY && + tokens[parser->toksuper].type !=JSMN_OBJECT ) { +#ifdef JSMN_PARENT_LINKS + parser->toksuper = tokens[parser->toksuper].parent; +#else +for (i = parser->toknext -1 ; i >=0 ; i--) { +if (tokens[i].type ==JSMN_ARRAY || tokens[i].type ==JSMN_OBJECT ) { +if (tokens[i].start !=-1 && tokens[i].end ==-1 ) { + parser->toksuper = i; +break ; + } + } + } +#endif + } +break ; +#ifdef JSMN_STRICT +/* In strict mode primitives are: numbers and booleans */ +case '-' : +case '0' : +case '1' : +case '2' : +case '3' : +case '4' : +case '5' : +case '6' : +case '7' : +case '8' : +case '9' : +case 't' : +case 'f' : +case 'n' : +/* And they must not be keys of the object */ +if (tokens !=NULL && parser->toksuper !=-1 ) { +const jsmntok_t *t = &tokens[parser->toksuper]; +if (t->type ==JSMN_OBJECT || + (t->type ==JSMN_STRING && t->size !=0 )) { +return JSMN_ERROR_INVAL ; + } + } +#else +/* In non-strict mode every unquoted value is a primitive */ +default : +#endif + r =jsmn_parse_primitive (parser, js, len, tokens, num_tokens); +if (r <0 ) { +return r; + } + count++; +if (parser->toksuper !=-1 && tokens !=NULL ) { + tokens[parser->toksuper].size++; + } +break ; + +#ifdef JSMN_STRICT +/* Unexpected char in strict mode */ +default : +return JSMN_ERROR_INVAL ; +#endif + } + } + +if (tokens !=NULL ) { +for (i = parser->toknext -1 ; i >=0 ; i--) { +/* Unmatched opened object or array */ +if (tokens[i].start !=-1 && tokens[i].end ==-1 ) { +return JSMN_ERROR_PART ; + } + } + } + +return count; +} + +/** +* Creates a new parser based over a given buffer with an array of tokens +* available. +*/ +JSMN_API void jsmn_init(jsmn_parser *parser) { + parser->pos =0 ; + parser->toknext =0 ; + parser->toksuper =-1 ; +} + +#endif /* JSMN_HEADER */ + +#ifdef __cplusplus +} +#endif + +#endif /* JSMN_H */
Signature · 1 line
2.31.1
James Prestwood
PATCH v3 2/3 json: introduce JSON module
This is a minimal wrapper around jsmn.h to make things a bit easier for iterating through a JSON object.
To use, first parse the JSON and create a contents object using json_contents_new(). This object can then be used to initialize a json_iter object using json_iter_init().
The json_iter object can then be parsed with json_iter_parse by passing in JSON_MANDATORY/JSON_OPTIONAL arguments. Currently only JSON_STRING and JSON_OBJECT types are supported. Any JSON_MANDATORY values that are not found will result in an error.
If a JSON_OPTIONAL string is not found, the pointer will be NULL. If a JSON_OPTIONAL object is not found, this iterator will be initialized but 'start' will be -1. This can be checked with a convenience macro json_object_not_found();
--- Makefile.am | 4 +- src/json.c | 271 ++++++++++++++++++++++++++++++++++++++++++++++++++++ src/json.h | 83 ++++++++++++++++ 3 files changed, 357 insertions(+), 1 deletion(-) create mode 100644 src/json.c create mode 100644 src/json.h
v3:
* Return allocated strings
* Initialize iterators using contents object which allows them to be stored on the stack. This also removes the need for child objects to be tracked.
* Enabled JSMN_PARENT_LINKS to make iterating keys much more straight forward
* Enabled JSMN_STRICT for strict JSON parsing
* Removed side-effecting with supplied arguments. Instead push arguments into a queue during parsing. Then, once all arguments are verified, set the out args from the caller.
Makefile.am +3 -1
@@ -249,6 +249,7 @@ src_iwd_SOURCES = src/main.c linux/nl80211.h src/iwd.h src/missing.h \ src/sysfs.h src/sysfs.c \ src/offchannel.h src/offchannel.c \ src/dpp-util.h src/dpp-util.c \ + src/json.h src/json.c \ $(eap_sources) \ $(builtin_sources)
@@ -566,7 +567,8 @@ EXTRA_DIST = src/genbuiltin src/iwd.service.in src/net.connman.iwd.service \ AM_CFLAGS = $(ell_cflags) -fvisibility=hidden \ -DUNITDIR=\""$(top_srcdir)/unit/"\" \ - -DCERTDIR=\""$(top_builddir)/unit/"\" + -DCERTDIR=\""$(top_builddir)/unit/"\" \ + -DJSMN_PARENT_LINKS -DJSMN_STRICT if MAINTAINER_MODE AM_CFLAGS += -DHAVE_PKCS8_SUPPORT
src/json.c new file +271 -0
271 lines not on this page · raw message
src/json.h new file +83 -0
83 lines not on this page · raw message
Signature · 1 line
2.31.1
James Prestwood
PATCH v3 3/3 unit: add JSON unit test
In reply to James Prestwood--- Makefile.am | 5 +- unit/test-json.c | 231 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 235 insertions(+), 1 deletion(-) create mode 100644 unit/test-json.c
Makefile.am +4 -1
@@ -396,7 +396,7 @@ unit_tests = unit/test-cmac-aes \ unit/test-ie unit/test-util unit/test-ssid-security \ unit/test-arc4 unit/test-wsc unit/test-eap-mschapv2 \ unit/test-eap-sim unit/test-sae unit/test-p2p unit/test-band \ - unit/test-dpp + unit/test-dpp unit/test-json if CLIENT unit_tests += unit/test-client
@@ -556,6 +556,9 @@ unit_test_dpp_SOURCES = unit/test-dpp.c src/dpp-util.h src/dpp-util.c \ unit_test_dpp_LDADD = $(ell_ldadd) +unit_test_json_SOURCES = unit/test-json.c src/json.h src/json.c shared/jsmn.h +unit_test_json_LDADD = $(ell_ldadd) + TESTS = $(unit_tests) EXTRA_DIST = src/genbuiltin src/iwd.service.in src/net.connman.iwd.service \
unit/test-json.c new file +231 -0
231 lines not on this page · raw message
Signature · 1 line
2.31.1