C++11 header-only JSON library
Clone or download

README.md

The Art of C++ / JSON

Release Download TravisCI AppVeyor Coverage

The Art of C++ / JSON is a zero-dependency C++11 header-only JSON library that provides a generic Value Class, uses Type Traits to interoperate with C++ types, and provides an Events Interface to convert from and to multiple additional formats like JSON, JAXN, CBOR, MsgPack, ...

Documentation

Features

  • Supported Standards

    • RFC8259, ECMA-404: The JavaScript Object Notation (JSON) Data Interchange Format.
    • Achieves a 100% conformance score in the Native JSON Benchmark tests.
    • RFC6901: JavaScript Object Notation (JSON) Pointer.
    • RFC6902: JavaScript Object Notation (JSON) Patch.
    • RFC7049: Concise Binary Object Representation (CBOR).
    • JAXN: Relaxed JSON.
    • MsgPack: MessagePack binary format (without extensions).
    • UBJSON: Universal Binary JSON.
  • Value Class

    • JSON data model extended with non-finite number values, date-time values, and binary data.
    • Construction of objects and arrays via std::initializer_list.
    • Conversion from and to arbitrary user-defined types via Type Traits.
    • Built around STL containers std::string, std::map and std::vector.
    • No memory allocations by the Value class itself (the wrapped containers allocate normally).
    • Instance sharing for string, binary, Value, and user-defined types via non-owning pointers.
    • C++11 literal operator for Values, including binary data.
    • Optional Base class for Values (e.g. to annotate (sub-)values with file and line).
  • Events Interface

    • Simple, straightforward and flexible Events API.
    • Events-to-Value and Value-to-Events interfaces.
    • Parse JSON & JAXN string representation to Events.
    • Stream Events to (prettified) JSON & JAXN string representation.
    • Conversion from and to binary formats, currently CBOR, UBJSON, MsgPack.
    • Conversion from and to other JSON libraries (e.g. contrib/nlohmann.cpp).
    • Events comparison, hashing, counting, and schema validation.
    • Events Transformers to manipulate Events in various ways.

Status

The library is stable as in "works correctly" over months of multiple real-world applications.

The library is not stable as in "under construction"; some parts of the API are under discussion and development and might change and/or be extended before version 1.0.

This library also serves as a real-world example application of the Parsing Expression Grammar Template Library (PEGTL), which is used for parsing the JSON and JAXN representation formats.

License

The Art of C++ / JSON is certified Open Source software. It may be used for any purpose, including commercial purposes, at absolutely no cost. It is distributed under the terms of the MIT license reproduced here.

Copyright (c) 2015-2018 Dr. Colin Hirsch and Daniel Frey

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.

Contact

The Art of C++ / JSON is part of The Art of C++.

For questions and suggestions about The Art of C++ / JSON please contact the authors at taocpp(at)icemx.net.

Thank You

Additional Licenses

The Art of C++ / JSON contains modified portions of the double-conversion library which is licensed as follows:

Copyright 2006-2011, the V8 project authors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The Art of C++ / JSON contains modified portions of James Edward Anhalt III's itoa library which is licensed as follows:

Copyright (c) 2017 James Edward Anhalt III - https://github.com/jeaiii/itoa

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.

The Art of C++ / JSON contains modified portions of Ulf Adams' Ryu implementation which is licensed as follows:

Copyright 2018 Ulf Adams

The contents of this file may be used under the terms of the Apache License, Version 2.0.

(See accompanying file LICENSE.ryu or copy at http://www.apache.org/licenses/LICENSE-2.0)

Alternatively, the contents of this file may be used under the terms of the Boost Software License, Version 1.0. (See accompanying file LICENSE-Boost or copy at https://www.boost.org/LICENSE_1_0.txt)

Unless required by applicable law or agreed to in writing, this software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.