SJSON CPP

sjson-cpp is a C++ library to read and write Simplified JSON files. It aims to be minimal, fast, and get out of the way of the programmer.

By design, the library does no memory allocations. This is in contrast to the nflibs C parser.

Everything is 100% C++11 header based for easy and trivial integration.

This parser is intended to accept only pure SJSON, and it will fail if given a JSON file, unlike the Autodesk JS Stingray parser.

The SJSON format

The data format is described here in the Stingray documentation.

TODO: Add a reference sjson file showing the format as a form of loose specification

Unicode support

UTF-8 support is as follow:

• String values return a raw StringView into the SJSON buffer. It is the responsability of the caller to interpret it as ANSI or UTF-8.
• String values properly support escaped unicode sequences in that they are returned raw in the StringView.
• Keys do not support UTF-8, they must be ANSI.
• The BOM is properly skipped if present

Unicode formats other than UTF-8 aren't supported.

Supported platforms

• Windows (VS2015, VS2017) x86 and x64
• Linux (gcc5, gcc6, gcc7, gcc8, clang4, clang5, clang6) x86 and x64
• OS X (Xcode 8.3, Xcode 9.4, Xcode 10) x86 and x64
• Android (NVIDIA CodeWorks) ARMv7-A
• iOS (Xcode 8.3, Xcode 9.4, Xcode 10) ARM64

The above supported platform list is only what is tested every release but if it compiles, it should run just fine.

External dependencies

There are none! You don't need anything else to get started: everything is self contained. See here for details.

Getting up and running

Windows, Linux, and OS X

1. Install CMake 3.2 or higher, Python 3, and the proper compiler for your platform
2. Generate the IDE solution with: python make.py
   The solution is generated under ./build
   Note that if you do not have CMake in your PATH, you should define the SJSON_CPP_CMAKE_HOME environment variable to something like C:\Program Files\CMake.
3. Build the IDE solution with: python make.py -build
4. Run the unit tests with: python make.py -unit_test

Android

For Android, the steps are identical to Windows, Linux, and OS X but you also need to install NVIDIA CodeWorks 1R5 (or higher).

iOS

For iOS, the steps are identical to the other platforms but due to code signing, you will need to perform the builds from Xcode manually. Note that this is only an issue if you attempt to use the tools or run the unit tests locally.

Authors

• Nicholas Frechette
• Cody Jones

License, copyright, and code of conduct

This project uses the MIT license.

Copyright (c) 2017 Nicholas Frechette, Cody Jones, and sjson-cpp contributors

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.