README.md 12.3 KB
Newer Older
M
Max Bruckner 已提交
1 2 3 4 5 6 7 8
# cJSON

Ultralightweight JSON parser in ANSI C.

## Table of contents
* [License](#license)
* [Usage](#usage)
  * [Welcome to cJSON](#welcome-to-cjson)
M
Max Bruckner 已提交
9
  * [Building](#building)
M
Max Bruckner 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
  * [Some JSON](#some-json)
  * [Here's the structure](#heres-the-structure)
  * [Enjoy cJSON!](#enjoy-cjson)

## License

>  Copyright (c) 2009-2016 Dave Gamble
>
>  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.

## Usage

### Welcome to cJSON.
K
Kevin Branigan 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

cJSON aims to be the dumbest possible parser that you can get your job done with.
It's a single file of C, and a single header file.

JSON is described best here: http://www.json.org/
It's like XML, but fat-free. You use it to move data around, store things, or just
generally represent your program's state.

As a library, cJSON exists to take away as much legwork as it can, but not get in your way.
As a point of pragmatism (i.e. ignoring the truth), I'm going to say that you can use it
in one of two modes: Auto and Manual. Let's have a quick run-through.

I lifted some JSON from this page: http://www.json.org/fatfree.html
That page inspired me to write cJSON, which is a parser that tries to share the same
philosophy as JSON itself. Simple, dumb, out of the way.

M
Max Bruckner 已提交
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
### Building

There are several ways to incorporate cJSON into your project.

#### copying the source
Because the entire library is only one C file and one header file, you can just copy `cJSON.h` and `cJSON.c` to your projects source and start using it.

cJSON is written in ANSI C (C89) in order to support as many platforms and compilers as possible.

#### CMake
With CMake, cJSON supports a full blown build system. This way you get the most features. With CMake it is recommended to do an out of tree build, meaning the compiled files are put in a directory separate from the source files. So in order to build cJSON with CMake on a Unix platform, make a `build` directory and run CMake inside it.

```
mkdir build
cd build
cmake ..
```

This will create a Makefile and a bunch of other files. You can then compile it:

```
make
```

And install it with `make install` if you want. By default it installs the headers `/usr/local/include/cjson` and the libraries to `/usr/local/lib`. It also installs files for pkg-config to make it easier to detect and use an existing installation of CMake. And it installs CMake config files, that can be used by other CMake based projects to discover the library.

You can change the build process with a list of different options that you can pass to CMake. Turn them on with `On` and off with `Off`:
R
Romain Porte 已提交
82
* `-DENABLE_CJSON_TEST=On`: Enable building the tests. (on by default)
M
Max Bruckner 已提交
83 84
* `-DENABLE_CJSON_UTILS=On`: Enable building cJSON_Utils. (off by default)
* `-DENABLE_TARGET_EXPORT=On`: Enable the export of CMake targets. Turn off if it makes problems. (on by default)
85
* `-DENABLE_CUSTOM_COMPILER_FLAGS=On`: Enable custom compiler flags (currently for Clang and GCC). Turn off if it makes problems. (on by default)
M
Max Bruckner 已提交
86 87 88 89 90 91 92
* `-DBUILD_SHARED_LIBS=On`: Build the shared libraries. (on by default)
* `-DCMAKE_INSTALL_PREFIX=/usr`: Set a prefix for the installation.

If you are packaging cJSON for a distribution of Linux, you would probably take these steps for example:
```
mkdir build
cd build
R
Romain Porte 已提交
93
cmake .. -DENABLE_CJSON_UTILS=On -DENABLE_CJSON_TEST=Off -DCMAKE_INSTALL_PREFIX=/usr
M
Max Bruckner 已提交
94 95 96 97
make
make DESTDIR=$pkgdir install
```

M
Max Bruckner 已提交
98
CMake supports a lot of different platforms, not only UNIX Makefiles, but only UNIX Makefiles have been tested. It works on GNU/Linux and has been confirmed to compile on some versions of macOS, Cygwin, FreeBSD, Solaris and OpenIndiana.
M
Max Bruckner 已提交
99 100 101 102 103 104 105 106 107 108 109 110

#### Makefile
If you don't have CMake available, but still have make. You can use the makefile to build cJSON:

Run this command in the directory with the source code and it will automatically compile static and shared libraries and a little test program.

```
make all
```

If you want, you can install the compiled library to your system using `make install`. By default it will install the headers in `/usr/local/include/cjson` and the libraries in `/usr/local/lib`. But you can change this behavior by setting the `PREFIX` and `DESTDIR` variables: `make PREFIX=/usr DESTDIR=temp install`.

M
Max Bruckner 已提交
111 112 113 114 115 116 117 118 119 120 121
### Some JSON:

```json
{
    "name": "Jack (\"Bee\") Nimble",
    "format": {
        "type":       "rect",
        "width":      1920,
        "height":     1080,
        "interlace":  false,
        "frame rate": 24
K
Kevin Branigan 已提交
122
    }
M
Max Bruckner 已提交
123 124
}
```
K
Kevin Branigan 已提交
125 126

Assume that you got this from a file, a webserver, or magic JSON elves, whatever,
M
Max Bruckner 已提交
127
you have a `char *` to it. Everything is a `cJSON` struct.
K
Kevin Branigan 已提交
128
Get it parsed:
129

M
Max Bruckner 已提交
130 131 132
```c
cJSON * root = cJSON_Parse(my_json_string);
```
K
Kevin Branigan 已提交
133 134 135 136

This is an object. We're in C. We don't have objects. But we do have structs.
What's the framerate?

M
Max Bruckner 已提交
137
```c
M
Max Bruckner 已提交
138 139
cJSON *format = cJSON_GetObjectItem(root, "format");
int framerate = cJSON_GetObjectItem(format, "frame rate")->valueint;
M
Max Bruckner 已提交
140
```
K
Kevin Branigan 已提交
141 142

Want to change the framerate?
143

M
Max Bruckner 已提交
144
```c
M
Max Bruckner 已提交
145
cJSON_GetObjectItem(format, "frame rate")->valueint = 25;
M
Max Bruckner 已提交
146
```
147

K
Kevin Branigan 已提交
148
Back to disk?
149

M
Max Bruckner 已提交
150
```c
M
Max Bruckner 已提交
151
char *rendered = cJSON_Print(root);
M
Max Bruckner 已提交
152
```
K
Kevin Branigan 已提交
153 154

Finished? Delete the root (this takes care of everything else).
155

M
Max Bruckner 已提交
156 157 158
```c
cJSON_Delete(root);
```
K
Kevin Branigan 已提交
159 160 161

That's AUTO mode. If you're going to use Auto mode, you really ought to check pointers
before you dereference them. If you want to see how you'd build this struct in code?
162

M
Max Bruckner 已提交
163
```c
M
Max Bruckner 已提交
164 165
cJSON *root;
cJSON *fmt;
M
Max Bruckner 已提交
166 167 168 169 170 171 172 173 174
root = cJSON_CreateObject();
cJSON_AddItemToObject(root, "name", cJSON_CreateString("Jack (\"Bee\") Nimble"));
cJSON_AddItemToObject(root, "format", fmt = cJSON_CreateObject());
cJSON_AddStringToObject(fmt, "type", "rect");
cJSON_AddNumberToObject(fmt, "width", 1920);
cJSON_AddNumberToObject(fmt, "height", 1080);
cJSON_AddFalseToObject (fmt, "interlace");
cJSON_AddNumberToObject(fmt, "frame rate", 24);
```
K
Kevin Branigan 已提交
175 176

Hopefully we can agree that's not a lot of code? There's no overhead, no unnecessary setup.
M
Max Bruckner 已提交
177
Look at `test.c` for a bunch of nice examples, mostly all ripped off the [json.org](http://json.org) site, and
K
Kevin Branigan 已提交
178 179 180
a few from elsewhere.

What about manual mode? First up you need some detail.
M
Max Bruckner 已提交
181
Let's cover how the `cJSON` objects represent the JSON data.
K
Kevin Branigan 已提交
182
cJSON doesn't distinguish arrays from objects in handling; just type.
M
Max Bruckner 已提交
183
Each `cJSON` has, potentially, a child, siblings, value, a name.
K
Kevin Branigan 已提交
184

M
Max Bruckner 已提交
185 186 187 188 189 190 191 192
* The `root` object has: *Object* Type and a Child
* The Child has name "name", with value "Jack ("Bee") Nimble", and a sibling:
* Sibling has type *Object*, name "format", and a child.
* That child has type *String*, name "type", value "rect", and a sibling:
* Sibling has type *Number*, name "width", value 1920, and a sibling:
* Sibling has type *Number*, name "height", value 1080, and a sibling:
* Sibling has type *False*, name "interlace", and a sibling:
* Sibling has type *Number*, name "frame rate", value 24
K
Kevin Branigan 已提交
193

M
Max Bruckner 已提交
194
### Here's the structure:
195

M
Max Bruckner 已提交
196 197
```c
typedef struct cJSON {
M
Max Bruckner 已提交
198 199
    struct cJSON *next,*prev;
    struct cJSON *child;
K
Kevin Branigan 已提交
200

M
Max Bruckner 已提交
201
    int type;
K
Kevin Branigan 已提交
202

M
Max Bruckner 已提交
203 204 205
    char *valuestring;
    int valueint;
    double valuedouble;
K
Kevin Branigan 已提交
206

M
Max Bruckner 已提交
207
    char *string;
M
Max Bruckner 已提交
208 209
} cJSON;
```
K
Kevin Branigan 已提交
210 211 212

By default all values are 0 unless set by virtue of being meaningful.

M
Max Bruckner 已提交
213 214 215 216 217 218
`next`/`prev` is a doubly linked list of siblings. `next` takes you to your sibling,
`prev` takes you back from your sibling to you.
Only objects and arrays have a `child`, and it's the head of the doubly linked list.
A `child` entry will have `prev == 0`, but next potentially points on. The last sibling has `next == 0`.
The type expresses *Null*/*True*/*False*/*Number*/*String*/*Array*/*Object*, all of which are `#defined` in
`cJSON.h`.
K
Kevin Branigan 已提交
219

M
Max Bruckner 已提交
220 221
A *Number* has `valueint` and `valuedouble`. If you're expecting an `int`, read `valueint`, if not read
`valuedouble`.
K
Kevin Branigan 已提交
222

M
Max Bruckner 已提交
223 224 225
Any entry which is in the linked list which is the child of an object will have a `string`
which is the "name" of the entry. When I said "name" in the above example, that's `string`.
`string` is the JSON name for the 'variable name' if you will.
K
Kevin Branigan 已提交
226 227

Now you can trivially walk the lists, recursively, and parse as you please.
M
Max Bruckner 已提交
228
You can invoke `cJSON_Parse` to get cJSON to parse for you, and then you can take
K
Kevin Branigan 已提交
229 230 231 232
the root object, and traverse the structure (which is, formally, an N-tree),
and tokenise as you please. If you wanted to build a callback style parser, this is how
you'd do it (just an example, since these things are very specific):

M
Max Bruckner 已提交
233
```c
M
Max Bruckner 已提交
234
void parse_and_callback(cJSON *item, const char *prefix)
M
Max Bruckner 已提交
235
{
M
Max Bruckner 已提交
236 237 238 239 240 241 242 243 244 245 246 247
    while (item)
    {
        char *newprefix = malloc(strlen(prefix) + strlen(item->name) + 2);
        sprintf(newprefix, "%s/%s", prefix, item->name);
        int dorecurse = callback(newprefix, item->type, item);
        if (item->child && dorecurse)
        {
            parse_and_callback(item->child, newprefix);
        }
        item = item->next;
        free(newprefix);
    }
M
Max Bruckner 已提交
248 249
}
```
K
Kevin Branigan 已提交
250

M
Max Bruckner 已提交
251 252
The `prefix` process will build you a separated list, to simplify your callback handling.
The `dorecurse` flag would let the callback decide to handle sub-arrays on it's own, or
K
Kevin Branigan 已提交
253 254
let you invoke it per-item. For the item above, your callback might look like this:

M
Max Bruckner 已提交
255
```c
M
Max Bruckner 已提交
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
int callback(const char *name, int type, cJSON *item)
{
    if (!strcmp(name, "name"))
    {
        /* populate name */
    }
    else if (!strcmp(name, "format/type")
    {
        /* handle "rect" */ }
    else if (!strcmp(name, "format/width")
    {
        /* 800 */
    }
    else if (!strcmp(name, "format/height")
    {
        /* 600 */
    }
    else if (!strcmp(name, "format/interlace")
    {
        /* false */
    }
    else if (!strcmp(name, "format/frame rate")
278
    {
M
Max Bruckner 已提交
279
        /* 24 */
280
    }
M
Max Bruckner 已提交
281 282 283

    return 1;
}
M
Max Bruckner 已提交
284
```
K
Kevin Branigan 已提交
285 286 287 288

Alternatively, you might like to parse iteratively.
You'd use:

M
Max Bruckner 已提交
289 290 291
```c
void parse_object(cJSON *item)
{
M
Max Bruckner 已提交
292 293 294 295 296 297
    int i;
    for (i = 0; i < cJSON_GetArraySize(item); i++)
    {
        cJSON *subitem = cJSON_GetArrayItem(item, i);
        // handle subitem
    }
M
Max Bruckner 已提交
298 299
}
```
K
Kevin Branigan 已提交
300 301 302

Or, for PROPER manual mode:

M
Max Bruckner 已提交
303
```c
M
Max Bruckner 已提交
304
void parse_object(cJSON *item)
M
Max Bruckner 已提交
305
{
M
Max Bruckner 已提交
306 307 308 309 310 311 312 313 314 315 316
    cJSON *subitem = item->child;
    while (subitem)
    {
        // handle subitem
        if (subitem->child)
        {
            parse_object(subitem->child);
        }

        subitem = subitem->next;
    }
M
Max Bruckner 已提交
317 318
}
```
K
Kevin Branigan 已提交
319 320 321 322 323 324 325 326 327 328 329 330

Of course, this should look familiar, since this is just a stripped-down version
of the callback-parser.

This should cover most uses you'll find for parsing. The rest should be possible
to infer.. and if in doubt, read the source! There's not a lot of it! ;)

In terms of constructing JSON data, the example code above is the right way to do it.
You can, of course, hand your sub-objects to other functions to populate.
Also, if you find a use for it, you can manually build the objects.
For instance, suppose you wanted to build an array of objects?

M
Max Bruckner 已提交
331
```c
M
Max Bruckner 已提交
332
cJSON *objects[24];
M
Max Bruckner 已提交
333

M
Max Bruckner 已提交
334
cJSON *Create_array_of_anything(cJSON **items, int num)
M
Max Bruckner 已提交
335
{
M
Max Bruckner 已提交
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
    int i;
    cJSON *prev;
    cJSON *root = cJSON_CreateArray();
    for (i = 0; i < 24; i++)
    {
        if (!i)
        {
            root->child = objects[i];
        }
        else
        {
            prev->next = objects[i];
            objects[i]->prev = prev;
        }

        prev = objects[i];
    }

    return root;
M
Max Bruckner 已提交
355 356 357 358
}
```

and simply: `Create_array_of_anything(objects, 24);`
K
Kevin Branigan 已提交
359 360 361 362 363

cJSON doesn't make any assumptions about what order you create things in.
You can attach the objects, as above, and later add children to each
of those objects.

M
Max Bruckner 已提交
364
As soon as you call `cJSON_Print`, it renders the structure to text.
K
Kevin Branigan 已提交
365

M
Max Bruckner 已提交
366 367 368
The `test.c` code shows how to handle a bunch of typical cases. If you uncomment
the code, it'll load, parse and print a bunch of test files, also from [json.org](http://json.org),
which are more complex than I'd care to try and stash into a `const char array[]`.
K
Kevin Branigan 已提交
369

M
Max Bruckner 已提交
370
# Enjoy cJSON!
K
Kevin Branigan 已提交
371

I
IvanVoid 已提交
372
- Dave Gamble, Aug 2009