cJSON

mirror of Dave's cJSON
git clone git://git.thc420.xyz/cJSON
Log | Files | Refs | README | LICENSE

commit aafb64a1c549b7b927e339df6d35b1d5059dc235
parent 0d10e279c8b604f71829b5d49d092719f4ae96b6
Author: Max Bruckner <max@maxbruckner.de>
Date:   Thu, 17 Nov 2016 08:19:08 +0700

Merge pull request #66 from DaveGamble/v1

Release version 1.0.0
Diffstat:
M.gitignore | 1+
MCMakeLists.txt | 113++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------
ACONTRIBUTORS.md | 27+++++++++++++++++++++++++++
MMakefile | 159+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------
MREADME.md | 401+++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------
McJSON.c | 13++++++++++---
McJSON.h | 2++
AcJSONConfig.cmake.in | 29+++++++++++++++++++++++++++++
AcJSONConfigVersion.cmake.in | 11+++++++++++
Alibcjson.pc.in | 11+++++++++++
Alibcjson_utils.pc.in | 11+++++++++++
11 files changed, 575 insertions(+), 203 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -7,3 +7,4 @@ test *.patch tags *.dylib +build/ diff --git a/CMakeLists.txt b/CMakeLists.txt @@ -1,39 +1,110 @@ +set(CMAKE_LEGACY_CYGWIN_WIN32 0) cmake_minimum_required(VERSION 2.8) -set(PROJ_CJSON cJSON) +include(GNUInstallDirs) -project(${PROJ_CJSON} C) +project(cJSON C) + +set(PROJECT_VERSION_MAJOR 1) +set(PROJECT_VERSION_MINOR 0) +set(PROJECT_VERSION_PATCH 0) +set(CJSON_VERSION_SO 1) +set(CJSON_UTILS_VERSION_SO 1) +set(PROJECT_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}") + +option(ENABLE_CUSTOM_COMPILER_FLAGS ON) +if (ENABLE_CUSTOM_COMPILER_FLAGS) + if(("${CMAKE_C_COMPILER_ID}" MATCHES "GNU") OR ("${CMAKE_C_COMPILER_ID}" MATCHES "Clang")) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c89 -pedantic -Wall -Wextra -Werror -Wstrict-prototypes -Wwrite-strings") + endif() +endif() + +#variables for pkg-config +set(prefix "${CMAKE_INSTALL_PREFIX}") +set(libdir "${CMAKE_INSTALL_LIBDIR}") +set(version "${PROJECT_VERSION}") +set(includedir "${CMAKE_INSTALL_INCLUDEDIR}") + +option(BUILD_SHARED_LIBS "Build shared libraries" ON) +option(ENABLE_TARGET_EXPORT "Enable exporting of CMake targets. Disable when it causes problems!" ON) + +#cJSON +set(CJSON_LIB cjson) file(GLOB HEADERS cJSON.h) set(SOURCES cJSON.c) -add_library(${PROJ_CJSON} ${HEADERS} ${SOURCES}) +add_library("${CJSON_LIB}" "${HEADERS}" "${SOURCES}") if (NOT WIN32) - target_link_libraries(${PROJ_CJSON} m) + target_link_libraries("${CJSON_LIB}" m) +endif() + +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/libcjson.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/libcjson.pc" @ONLY) + +install(FILES cJSON.h DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/cjson") +install (FILES "${CMAKE_CURRENT_BINARY_DIR}/libcjson.pc" DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") +install(TARGETS "${CJSON_LIB}" DESTINATION "${CMAKE_INSTALL_LIBDIR}" EXPORT "${CJSON_LIB}") +if(ENABLE_TARGET_EXPORT) + # export library information for CMake projects + install(EXPORT "${CJSON_LIB}" DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/cJSON") endif() -set(PROJ_CJSON_UTILS cJSON_utils) +set_target_properties("${CJSON_LIB}" + PROPERTIES + SOVERSION "${CJSON_VERSION_SO}" + VERSION "${PROJECT_VERSION}") + +#cJSON_Utils +option(ENABLE_CJSON_UTILS "Enable building the cJSON_Utils library." OFF) +if(ENABLE_CJSON_UTILS) + set(CJSON_UTILS_LIB cjson_utils) + + file(GLOB HEADERS_UTILS cJSON_Utils.h) + set(SOURCES_UTILS cJSON_Utils.c) -project(${PROJ_CJSON_UTILS} C) + add_library("${CJSON_UTILS_LIB}" "${HEADERS_UTILS}" "${SOURCES_UTILS}") + target_link_libraries("${CJSON_UTILS_LIB}" "${CJSON_LIB}") -file(GLOB HEADERS_UTILS cJSON_Utils.h) -set(SOURCES_UTILS cJSON_Utils.c) + configure_file("${CMAKE_CURRENT_SOURCE_DIR}/libcjson_utils.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/libcjson_utils.pc" @ONLY) + + install(TARGETS "${CJSON_UTILS_LIB}" DESTINATION "${CMAKE_INSTALL_LIBDIR}" EXPORT "${CJSON_UTILS_LIB}") + install(FILES cJSON_Utils.h DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/cjson") + install (FILES "${CMAKE_CURRENT_BINARY_DIR}/libcjson_utils.pc" DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") + if(ENABLE_TARGET_EXPORT) + # export library information for CMake projects + install(EXPORT "${CJSON_UTILS_LIB}" DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/cJSON") + endif() + + set_target_properties("${CJSON_UTILS_LIB}" + PROPERTIES + SOVERSION "${CJSON_UTILS_VERSION_SO}" + VERSION "${PROJECT_VERSION}") +endif() -add_library(${PROJ_CJSON_UTILS} ${HEADERS_UTILS} ${SOURCES_UTILS}) -target_link_libraries(${PROJ_CJSON_UTILS} ${PROJ_CJSON}) +# create the other package config files +configure_file( + cJSONConfig.cmake.in + ${PROJECT_BINARY_DIR}/cJSONConfig.cmake @ONLY) +configure_file( + cJSONConfigVersion.cmake.in + ${PROJECT_BINARY_DIR}/cJSONConfigVersion.cmake @ONLY) -install (TARGETS ${PROJ_CJSON} DESTINATION lib${LIB_SUFFIX}) -install (FILES cJSON.h DESTINATION include/cJSON) -install (TARGETS ${PROJ_CJSON_UTILS} DESTINATION lib${LIB_SUFFIX}) -install (FILES cJSON_Utils.h DESTINATION include/cJSON) +# Install package config files +install(FILES ${PROJECT_BINARY_DIR}/cJSONConfig.cmake + ${PROJECT_BINARY_DIR}/cJSONConfigVersion.cmake + DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/cJSON") -option(ENABLE_CJSON_TEST "Enable building cJSON test" OFF) +option(ENABLE_CJSON_TEST "Enable building cJSON test" ON) if(ENABLE_CJSON_TEST) - set(TEST_CJSON cJSON_test) - add_executable(${TEST_CJSON} test.c) - target_link_libraries(${TEST_CJSON} ${PROJ_CJSON}) + set(TEST_CJSON cJSON_test) + add_executable("${TEST_CJSON}" test.c) + target_link_libraries("${TEST_CJSON}" "${CJSON_LIB}") - set(TEST_CJSON_UTILS cJSON_test_utils) - add_executable(${TEST_CJSON_UTILS} test_utils.c) - target_link_libraries(${TEST_CJSON_UTILS} ${PROJ_CJSON_UTILS}) + if(ENABLE_CJSON_UTILS) + set(TEST_CJSON_UTILS cJSON_test_utils) + add_executable("${TEST_CJSON_UTILS}" test_utils.c) + target_link_libraries("${TEST_CJSON_UTILS}" "${CJSON_UTILS_LIB}") + endif() endif() diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md @@ -0,0 +1,27 @@ +Contributors +============ + +* [Ajay Bhargav](https://github.com/ajaybhargav) +* [Anton Sergeev](https://github.com/anton-sergeev) +* [Christian Schulze](https://github.com/ChristianSch) +* [Dave Gamble](https://github.com/DaveGamble) +* [dieyushi](https://github.com/dieyushi) +* [Dongwen Huang (黄东文)](https://github.com/DongwenHuang) +* Eswar Yaganti +* [Evan Todd](https://github.com/etodd) +* [Fabrice Fontaine](https://github.com/ffontaine) +* Ian Mobley +* Irwan Djadjadi +* [IvanVoid](https://github.com/npi3pak) +* [Jonathan Fether](https://github.com/jfether) +* [Kevin Branigan](https://github.com/kbranigan) +* [Linus Wallgren](https://github.com/ecksun) +* [Max Bruckner](https://github.com/FSMaxB) +* Mike Pontillo +* Paulo Antonio Alvarez +* [Rafael Leal Dias](https://github.com/rafaeldias) +* [Rod Vagg](https://github.com/rvagg) +* [Roland Meertens](https://github.com/rmeertens) +* [Weston Schmidt](https://github.com/schmidtw) + +And probably more people on [SourceForge](https://sourceforge.net/p/cjson/bugs/search/?q=status%3Aclosed-rejected+or+status%3Aclosed-out-of-date+or+status%3Awont-fix+or+status%3Aclosed-fixed+or+status%3Aclosed&page=0) diff --git a/Makefile b/Makefile @@ -1,6 +1,15 @@ -OBJ = cJSON.o -LIBNAME = libcjson -TESTS = test +CJSON_OBJ = cJSON.o +UTILS_OBJ = cJSON_Utils.o +CJSON_LIBNAME = libcjson +UTILS_LIBNAME = libcjson_utils +CJSON_TEST = cJSON_test +UTILS_TEST = cJSON_test_utils + +LDLIBS = -lm + +LIBVERSION = 1.0.0 +CJSON_SOVERSION = 1 +UTILS_SOVERSION = 1 PREFIX ?= /usr/local INCLUDE_PATH ?= include/cjson @@ -11,54 +20,126 @@ INSTALL_LIBRARY_PATH = $(DESTDIR)$(PREFIX)/$(LIBRARY_PATH) INSTALL ?= cp -a -R_CFLAGS = -fpic $(CFLAGS) -Wall -Werror -Wstrict-prototypes -Wwrite-strings -D_POSIX_C_SOURCE=200112L +R_CFLAGS = -fPIC -std=c89 -pedantic -Wall -Werror -Wstrict-prototypes -Wwrite-strings $(CFLAGS) -uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo false') +uname := $(shell sh -c 'uname -s 2>/dev/null || echo false') -## shared lib -DYLIBNAME = $(LIBNAME).so -DYLIBCMD = $(CC) -shared -o $(DYLIBNAME) +#library file extensions +SHARED = so +STATIC = a ## create dynamic (shared) library on Darwin (base OS for MacOSX and IOS) -ifeq (Darwin, $(uname_S)) - DYLIBNAME = $(LIBNAME).dylib -## create dyanmic (shared) library on SunOS -else ifeq (SunOS, $(uname_S)) - DYLIBCMD = $(CC) -G -o $(DYLIBNAME) - INSTALL = cp -r +ifeq (Darwin, $(uname)) + SHARED = dylib endif -## static lib -STLIBNAME = $(LIBNAME).a +#cJSON library names +CJSON_SHARED = $(CJSON_LIBNAME).$(SHARED) +CJSON_SHARED_VERSION = $(CJSON_LIBNAME).$(SHARED).$(LIBVERSION) +CJSON_SHARED_SO = $(CJSON_LIBNAME).$(SHARED).$(CJSON_SOVERSION) +CJSON_STATIC = $(CJSON_LIBNAME).$(STATIC) -.PHONY: all clean install +#cJSON_Utils library names +UTILS_SHARED = $(UTILS_LIBNAME).$(SHARED) +UTILS_SHARED_VERSION = $(UTILS_LIBNAME).$(SHARED).$(LIBVERSION) +UTILS_SHARED_SO = $(UTILS_LIBNAME).$(SHARED).$(UTILS_SOVERSION) +UTILS_STATIC = $(UTILS_LIBNAME).$(STATIC) -all: $(DYLIBNAME) $(STLIBNAME) $(TESTS) +SHARED_CMD = $(CC) -shared -o -$(DYLIBNAME): $(OBJ) - $(DYLIBCMD) $< $(LDFLAGS) - -$(STLIBNAME): $(OBJ) - $(AR) rcs $@ $< +.PHONY: all shared static tests clean install -$(OBJ): cJSON.c cJSON.h +all: shared static tests -.c.o: - $(CC) -ansi -pedantic -c $(R_CFLAGS) $< +shared: $(CJSON_SHARED) $(UTILS_SHARED) -$(TESTS): cJSON.c cJSON.h test.c - $(CC) cJSON.c test.c -o test -lm -I. +static: $(CJSON_STATIC) $(UTILS_STATIC) -install: $(DYLIBNAME) $(STLIBNAME) - mkdir -p $(INSTALL_LIBRARY_PATH) $(INSTALL_INCLUDE_PATH) - $(INSTALL) cJSON.h $(INSTALL_INCLUDE_PATH) - $(INSTALL) $(DYLIBNAME) $(INSTALL_LIBRARY_PATH) - $(INSTALL) $(STLIBNAME) $(INSTALL_LIBRARY_PATH) +tests: $(CJSON_TEST) $(UTILS_TEST) -uninstall: - rm -rf $(INSTALL_LIBRARY_PATH)/$(DYLIBNAME) - rm -rf $(INSTALL_LIBRARY_PATH)/$(STLIBNAME) - rm -rf $(INSTALL_INCLUDE_PATH)/cJSON.h +test: tests + ./$(CJSON_TEST) + ./$(UTILS_TEST) -clean: - rm -rf $(DYLIBNAME) $(STLIBNAME) $(TESTS) *.o +.c.o: + $(CC) -ansi -pedantic -c $(R_CFLAGS) $< + +#tests +#cJSON +$(CJSON_TEST): cJSON.c cJSON.h test.c + $(CC) $^ -o $@ $(LDLIBS) -I. +#cJSON_Utils +$(UTILS_TEST): cJSON.c cJSON.h test.c + $(CC) $^ -o $@ $(LDLIBS) -I. + +#static libraries +#cJSON +$(CJSON_STATIC): $(CJSON_OBJ) + $(AR) rcs $@ $< +#cJSON_Utils +$(UTILS_STATIC): $(UTILS_OBJ) + $(AR) rcs $@ $< + +#shared libraries .so.1.0.0 +#cJSON +$(CJSON_SHARED_VERSION): $(CJSON_OBJ) + $(CC) -shared -o $@ $< $(LDFLAGS) +#cJSON_Utils +$(UTILS_SHARED_VERSION): $(UTILS_OBJ) + $(CC) -shared -o $@ $< $(LDFLAGS) + +#objects +#cJSON +$(CJSON_OBJ): cJSON.c cJSON.h +#cJSON_Utils +$(UTILS_OBJ): cJSON_Utils.c cJSON_Utils.h + + +#links .so -> .so.1 -> .so.1.0.0 +#cJSON +$(CJSON_SHARED_SO): $(CJSON_SHARED_VERSION) + ln -s $(CJSON_SHARED_VERSION) $(CJSON_SHARED_SO) +$(CJSON_SHARED): $(CJSON_SHARED_SO) + ln -s $(CJSON_SHARED_SO) $(CJSON_SHARED) +#cJSON_Utils +$(UTILS_SHARED_SO): $(UTILS_SHARED_VERSION) + ln -s $(UTILS_SHARED_VERSION) $(UTILS_SHARED_SO) +$(UTILS_SHARED): $(UTILS_SHARED_SO) + ln -s $(UTILS_SHARED_SO) $(UTILS_SHARED) + +#install +#cJSON +install-cjson: + mkdir -p $(INSTALL_LIBRARY_PATH) $(INSTALL_INCLUDE_PATH) + $(INSTALL) cJSON.h $(INSTALL_INCLUDE_PATH) + $(INSTALL) $(CJSON_SHARED) $(CJSON_SHARED_SO) $(CJSON_SHARED_VERSION) $(INSTALL_LIBRARY_PATH) +#cJSON_Utils +install-utils: install-cjson + $(INSTALL) cJSON_Utils.h $(INSTALL_INCLUDE_PATH) + $(INSTALL) $(UTILS_SHARED) $(UTILS_SHARED_SO) $(UTILS_SHARED_VERSION) $(INSTALL_LIBRARY_PATH) + +install: install-cjson install-utils + +#uninstall +#cJSON +uninstall-cjson: uninstall-utils + $(RM) $(INSTALL_LIBRARY_PATH)/$(CJSON_SHARED) + $(RM) $(INSTALL_LIBRARY_PATH)/$(CJSON_SHARED_VERSION) + $(RM) $(INSTALL_LIBRARY_PATH)/$(CJSON_SHARED_SO) + rmdir $(INSTALL_LIBRARY_PATH) + $(RM) $(INSTALL_INCLUDE_PATH)/cJSON.h + rmdir $(INSTALL_INCLUDE_PATH) +#cJSON_Utils +uninstall-utils: + $(RM) $(INSTALL_LIBRARY_PATH)/$(UTILS_SHARED) + $(RM) $(INSTALL_LIBRARY_PATH)/$(UTILS_SHARED_VERSION) + $(RM) $(INSTALL_LIBRARY_PATH)/$(UTILS_SHARED_SO) + $(RM) $(INSTALL_INCLUDE_PATH)/cJSON_Utils.h + +uninstall: uninstall-utils uninstall-cjson + +clean: + $(RM) $(CJSON_OBJ) $(UTILS_OBJ) #delete object files + $(RM) $(CJSON_SHARED) $(CJSON_SHARED_VERSION) $(CJSON_SHARED_SO) $(CJSON_STATIC) #delete cJSON + $(RM) $(UTILS_SHARED) $(UTILS_SHARED_VERSION) $(UTILS_SHARED_SO) $(UTILS_STATIC) #delete cJSON_Utils + $(RM) $(CJSON_TEST) $(UTILS_TEST) #delete tests diff --git a/README.md b/README.md @@ -1,27 +1,41 @@ - - Copyright (c) 2009 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. - - -Welcome to cJSON. ------------------ +# cJSON + +Ultralightweight JSON parser in ANSI C. + +## Table of contents +* [License](#license) +* [Usage](#usage) + * [Welcome to cJSON](#welcome-to-cjson) + * [Building](#building) + * [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. 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. @@ -30,13 +44,6 @@ 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. -First up, how do I build? -Add cJSON.c to your project, and put cJSON.h somewhere in the header search path. -For example, to build the test app: - - gcc cJSON.c test.c -o test -lm - ./test - 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. @@ -45,167 +52,270 @@ 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. -Some JSON: ----------- +### Building - { - "name": "Jack (\"Bee\") Nimble", - "format": { - "type": "rect", - "width": 1920, - "height": 1080, - "interlace": false, - "frame rate": 24 - } +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`: +* `-DENABLE_CJSON_TESTS=On`: Enable building the tests. (on by default) +* `-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) +* `-DENABLE_CUSTOM_COMPILER_FLAGS=On`: Enable custom compiler flags (currently for Clang and GCC). Turn off if it makes problems. (on by default) +* `-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 +cmake .. -DENABLE_CJSON_UTILS=On -DENABLE_CJSON_TESTS=Off -DCMAKE_INSTALL_PREFIX=/usr +make +make DESTDIR=$pkgdir install +``` + +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. + +#### 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`. + +### Some JSON: + +```json +{ + "name": "Jack (\"Bee\") Nimble", + "format": { + "type": "rect", + "width": 1920, + "height": 1080, + "interlace": false, + "frame rate": 24 } +} +``` Assume that you got this from a file, a webserver, or magic JSON elves, whatever, -you have a char * to it. Everything is a cJSON struct. +you have a `char *` to it. Everything is a `cJSON` struct. Get it parsed: - cJSON * root = cJSON_Parse(my_json_string); +```c +cJSON * root = cJSON_Parse(my_json_string); +``` This is an object. We're in C. We don't have objects. But we do have structs. What's the framerate? - cJSON * format = cJSON_GetObjectItem(root,"format"); - int framerate = cJSON_GetObjectItem(format,"frame rate")->valueint; +```c +cJSON *format = cJSON_GetObjectItem(root, "format"); +int framerate = cJSON_GetObjectItem(format, "frame rate")->valueint; +``` Want to change the framerate? - cJSON_GetObjectItem(format,"frame rate")->valueint = 25; +```c +cJSON_GetObjectItem(format, "frame rate")->valueint = 25; +``` Back to disk? - char * rendered = cJSON_Print(root); +```c +char *rendered = cJSON_Print(root); +``` Finished? Delete the root (this takes care of everything else). - cJSON_Delete(root); +```c +cJSON_Delete(root); +``` 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? - cJSON *root,*fmt; - 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); +```c +cJSON *root; +cJSON *fmt; +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); +``` Hopefully we can agree that's not a lot of code? There's no overhead, no unnecessary setup. -Look at test.c for a bunch of nice examples, mostly all ripped off the json.org site, and +Look at `test.c` for a bunch of nice examples, mostly all ripped off the [json.org](http://json.org) site, and a few from elsewhere. What about manual mode? First up you need some detail. -Let's cover how the cJSON objects represent the JSON data. +Let's cover how the `cJSON` objects represent the JSON data. cJSON doesn't distinguish arrays from objects in handling; just type. -Each cJSON has, potentially, a child, siblings, value, a name. +Each `cJSON` has, potentially, a child, siblings, value, a name. -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 +* 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 -Here's the structure: ---------------------- +### Here's the structure: - typedef struct cJSON { - struct cJSON *next,*prev; - struct cJSON *child; +```c +typedef struct cJSON { + struct cJSON *next,*prev; + struct cJSON *child; - int type; + int type; - char *valuestring; - int valueint; - double valuedouble; + char *valuestring; + int valueint; + double valuedouble; - char *string; - } cJSON; + char *string; +} cJSON; +``` By default all values are 0 unless set by virtue of being meaningful. -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 +`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`. -A Number has valueint and valuedouble. If you're expecting an int, read valueint, if not read -valuedouble. +A *Number* has `valueint` and `valuedouble`. If you're expecting an `int`, read `valueint`, if not read +`valuedouble`. -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. +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. Now you can trivially walk the lists, recursively, and parse as you please. -You can invoke cJSON_Parse to get cJSON to parse for you, and then you can take +You can invoke `cJSON_Parse` to get cJSON to parse for you, and then you can take 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): - void parse_and_callback(cJSON *item,const char *prefix) +```c +void parse_and_callback(cJSON *item, const char *prefix) +{ + while (item) { - while (item) - { char *newprefix = malloc(strlen(prefix) + strlen(item->name) + 2); - sprintf(newprefix,"%s/%s",prefix,item->name); + sprintf(newprefix, "%s/%s", prefix, item->name); int dorecurse = callback(newprefix, item->type, item); - if (item->child && dorecurse) parse_and_callback(item->child, newprefix); + if (item->child && dorecurse) + { + parse_and_callback(item->child, newprefix); + } item = item->next; free(newprefix); - } } +} +``` -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 +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 let you invoke it per-item. For the item above, your callback might look like this: - int callback(const char *name,int type,cJSON *item) +```c +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") { - 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") { /* 24 */ } - return 1; + /* false */ } + else if (!strcmp(name, "format/frame rate") + { + /* 24 */ + } + + return 1; +} +``` Alternatively, you might like to parse iteratively. You'd use: - void parse_object(cJSON *item) +```c +void parse_object(cJSON *item) +{ + int i; + for (i = 0; i < cJSON_GetArraySize(item); i++) { - int i; - for (i = 0 ; i < cJSON_GetArraySize(item) ; i++) - { - cJSON * subitem = cJSON_GetArrayItem(item, i); - // handle subitem. - } + cJSON *subitem = cJSON_GetArrayItem(item, i); + // handle subitem } +} +``` Or, for PROPER manual mode: - void parse_object(cJSON * item) +```c +void parse_object(cJSON *item) +{ + cJSON *subitem = item->child; + while (subitem) { - cJSON *subitem = item->child; - while (subitem) - { // handle subitem - if (subitem->child) parse_object(subitem->child); - + if (subitem->child) + { + parse_object(subitem->child); + } + subitem = subitem->next; - } } +} +``` Of course, this should look familiar, since this is just a stripped-down version of the callback-parser. @@ -218,34 +328,45 @@ 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? - cJSON * objects[24]; +```c +cJSON *objects[24]; - cJSON * Create_array_of_anything(cJSON ** items, int num) +cJSON *Create_array_of_anything(cJSON **items, int num) +{ + int i; + cJSON *prev; + cJSON *root = cJSON_CreateArray(); + for (i = 0; i < 24; i++) { - int i; - cJSON * prev, * root = cJSON_CreateArray(); - for (i = 0 ; i < 24 ; i++) - { - if (!i) root->child = objects[i]; - else prev->next = objects[i], objects[i]->prev = prev; + if (!i) + { + root->child = objects[i]; + } + else + { + prev->next = objects[i]; + objects[i]->prev = prev; + } + prev = objects[i]; - } - return root; } - -and simply: Create_array_of_anything(objects, 24); + + return root; +} +``` + +and simply: `Create_array_of_anything(objects, 24);` 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. -As soon as you call cJSON_Print, it renders the structure to text. +As soon as you call `cJSON_Print`, it renders the structure to text. -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, -which are more complex than I'd care to try and stash into a const char array[]. +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[]`. -Enjoy cJSON! ------------------------ +# Enjoy cJSON! - Dave Gamble, Aug 2009 diff --git a/cJSON.c b/cJSON.c @@ -534,6 +534,11 @@ static const char *parse_string(cJSON *item, const char *str, const char **ep) case 't': *ptr2++ = '\t'; break; + case '\"': + case '\\': + case '/': + *ptr2++ = *ptr; + break; case 'u': /* transcode utf16 to utf8. See RFC2781 and RFC3629. */ uc = parse_hex4(ptr + 1); /* get the unicode char. */ @@ -620,8 +625,8 @@ static const char *parse_string(cJSON *item, const char *str, const char **ep) ptr2 += len; break; default: - *ptr2++ = *ptr; - break; + *ep = str; + return 0; } ptr++; } @@ -920,7 +925,9 @@ static const char *parse_value(cJSON *item, const char *value, const char **ep) return parse_object(item, value, ep); } - *ep=value;return 0; /* failure. */ + /* failure. */ + *ep = value; + return 0; } /* Render a value to text. */ diff --git a/cJSON.h b/cJSON.h @@ -28,6 +28,8 @@ extern "C" { #endif +#include <stddef.h> + /* cJSON Types: */ #define cJSON_False (1 << 0) #define cJSON_True (1 << 1) diff --git a/cJSONConfig.cmake.in b/cJSONConfig.cmake.in @@ -0,0 +1,29 @@ +# Whether the utils lib was build. +set(CJSON_UTILS_FOUND @ENABLE_CJSON_UTILS@) + +# The include directories used by cJSON +set(CJSON_INCLUDE_DIRS "@prefix@/@includedir@") +set(CJSON_INCLUDE_DIR "@prefix@/@includedir@") + +get_filename_component(_dir "${CMAKE_CURRENT_LIST_FILE}" PATH) + +# The cJSON library +set(CJSON_LIBRARY "@CJSON_LIB@") +if(@ENABLE_TARGET_EXPORT@) + # Include the target + include("${_dir}/cjson.cmake") +endif() + +if(CJSON_UTILS_FOUND) + # The cJSON utils library + set(CJSON_UTILS_LIBRARY @CJSON_UTILS_LIB@) + # All cJSON libraries + set(CJSON_LIBRARIES "@CJSON_UTILS_LIB@" "@CJSON_LIB@") + if(@ENABLE_TARGET_EXPORT@) + # Include the target + include("${_dir}/cjson_utils.cmake") + endif() +else() + # All cJSON libraries + set(CJSON_LIBRARIES "@CJSON_LIB@") +endif() diff --git a/cJSONConfigVersion.cmake.in b/cJSONConfigVersion.cmake.in @@ -0,0 +1,11 @@ +set(PACKAGE_VERSION "@PROJECT_VERSION@") + +# Check whether the requested PACKAGE_FIND_VERSION is compatible +if("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}") + set(PACKAGE_VERSION_COMPATIBLE FALSE) +else() + set(PACKAGE_VERSION_COMPATIBLE TRUE) + if ("${PACKAGE_VERSION}" VERSION_EQUAL "${PACKAGE_FIND_VERSION}") + set(PACKAGE_VERSION_EXACT TRUE) + endif() +endif() diff --git a/libcjson.pc.in b/libcjson.pc.in @@ -0,0 +1,11 @@ +prefix=@prefix@ +libdir=${prefix}/@libdir@ +includedir=${prefix}/@includedir@ + +Name: libcjson +Version: @version@ +Description: Ultralightweight JSON parser in ANSI C +URL: https://github.com/DaveGamble/cJSON +Libs: -L${libdir} -lcjson +Libs.Private: -lm +Cflags: -I${includedir} diff --git a/libcjson_utils.pc.in b/libcjson_utils.pc.in @@ -0,0 +1,11 @@ +prefix=@prefix@ +libdir=${prefix}/@libdir@ +includedir=${prefix}/@includedir@ + +Name: libcjson_utils +Version: @version@ +Description: An implementation of JSON Pointer, Patch and Merge Patch based on cJSON. +URL: https://github.com/DaveGamble/cJSON +Libs: -L${libdir} -lcjson_utils +Cflags: -I${includedir} +Requires: libcjson