README.md

JSMN

jsmn (pronounced like 'jasmine') is a minimalistic JSON parser in C. It can be easily integrated into resource-limited or embedded projects.

You can find more information about JSON format at json.org

Library sources are available at https://github.com/zserge/jsmn

The web page with some information about jsmn can be found at https://zserge.com/jsmn.html

Philosophy

Most JSON parsers offer you a bunch of functions to load JSON data, parse it and extract any value by its name. jsmn proves that checking the correctness of every JSON packet or allocating temporary objects to store parsed JSON fields often is an overkill.

JSON format itself is extremely simple, so why should we complicate it?

jsmn is designed to be robust (it should work fine even with erroneous data), fast (it should parse data on the fly), portable (no superfluous dependencies or non-standard C extensions). And of course, simplicity is a key feature - simple code style, simple algorithm, simple integration into other projects.

Features

• compatible with C89
• no dependencies (even libc!)
• highly portable (tested on x86/amd64, ARM, AVR)
• about 200 lines of code
• extremely small code footprint
• API contains only 2 functions
• no dynamic memory allocation
• incremental single-pass parsing
• library code is covered with unit-tests

Design

The rudimentary jsmn object is a token. Let's consider a JSON string:

{ "name" : "Jack", "age" : 27 }

It holds the following tokens:

• Object: { "name" : "Jack", "age" : 27 } (the whole object)
• Strings: "name", "Jack", "age" (keys and some values)
• Number: 27

In jsmn, tokens do not hold any data, but point to token boundaries in JSON string instead. In the example above jsmn will create tokens like: Object [0..31], String [3..7], String [12..16], String [20..23], Number [27..29].

Every jsmn token has a type, which indicates the type of corresponding JSON token. jsmn supports the following token types:

• Object - a container of key-value pairs, e.g.: { "foo":"bar", "x":0.3 }
• Array - a sequence of values, e.g.: [ 1, 2, 3 ]
• String - a quoted sequence of chars, e.g.: "foo"
• Primitive - a number, a boolean (true, false) or null

Besides start/end positions, jsmn tokens for complex types (like arrays or objects) also contain a number of child items, so you can easily follow object hierarchy.

This approach provides enough information for parsing any JSON data and makes it possible to use zero-copy techniques.

Usage

Download jsmn.h, include it, done.

#include "jsmn.h"

...
jsmn_parser p;
jsmntok_t t[128]; /* We expect no more than 128 JSON tokens */

jsmn_init(&p);
r = jsmn_parse(&p, s, strlen(s), t, 128);

Since jsmn is a single-header, header-only library, for more complex use cases you might need to define additional macros. #define JSMN_STATIC hides all jsmn API symbols by making them static. Also, if you want to include jsmn.h from multiple C files, to avoid duplication of symbols you may define JSMN_HEADER macro.

/* In every .c file that uses jsmn include only declarations: */
#define JSMN_HEADER
#include "jsmn.h"

/* Additionally, create one jsmn.c file for jsmn implementation: */
#include "jsmn.h"

API

Token types are described by jsmntype_t:

typedef enum {
	JSMN_UNDEFINED    = 0x0000,
	JSMN_OBJECT       = 0x0001,   /*!< Object */
	JSMN_ARRAY        = 0x0002,   /*!< Array */
	JSMN_STRING       = 0x0004,   /*!< String */
	JSMN_PRIMITIVE    = 0x0008,   /*!< Other primitive: number, boolean (true/false) or null */
	...
} jsmntype_t;

Note: Unlike JSON data types, primitive tokens are not divided into numbers, booleans and null, because one can easily tell the type using the first character:

• 't', 'f' - boolean
• 'n' - null
• '-', '0'..'9' - number

Token is an object of jsmntok_t type:

typedef struct {
	jsmntype_t type;              /*!< type (object, array, string etc.) */
	jsmnint_t start;              /*!< start position in JSON data string */
	jsmnint_t end;                /*!< end position in JSON data string */
	jsmnint_t size;               /*!< number of children */
	...
} jsmntok_t;

Note: string tokens point to the first character after the opening quote and the previous symbol before final quote. This was made to simplify string extraction from JSON data.

All jobs are done by the jsmn_parser object. You can initialize a new parser using:

jsmn_parser parser;
jsmntok_t tokens[10];

jsmn_init(&parser);

/* js - pointer to JSON string */
/* tokens - an array of tokens available */
/* 10 - number of tokens available */
jsmn_parse(&parser, js, strlen(js), tokens, 10);

This will create a parser, and then it tries to parse up to 10 JSON tokens from the js string.

A non-negative return value of jsmn_parse is the number of tokens actually used by the parser.

Passing NULL instead of the tokens array would not store parsing results, but instead the function will return the number of tokens needed to parse the given string. This can be useful if you don't know yet how many tokens to allocate.

If something goes wrong, you will get an error. Error will be one of these:

• JSMN_ERROR_INVAL - bad token, JSON string is corrupted
• JSMN_ERROR_NOMEM - not enough tokens, JSON string is too large
• JSMN_ERROR_PART - JSON string is too short, expecting more JSON data
• JSMN_ERROR_LEN - JSON string is too long (see note)

If you get JSMN_ERROR_NOMEM, you can re-allocate more tokens and call jsmn_parse once more. If you read json data from the stream, you can periodically call jsmn_parse and check if return value is JSMN_ERROR_PART. You will get this error until you reach the end of JSON data.

Note: The amount of input data jsmn can parse is limited by the size of jsmnint_t. Currently typedefed as an unsigned int.

Thus follows max len = 2^(sizeof(jsmnint_t)*8) -1 for various int sizes:

• 16bit ints - 65535
• 32bit ints - 4294967295
• 64bit ints - ~1.8e19

feed more data into jsmn_parse and you will get JSMN_ERROR_LEN.

Other info

This software is distributed under MIT license, so feel free to integrate it in your commercial products.