JSON

A full-blown ECMA-404 implementation with read, write, and iterators support. More...

Classes
class	sourcemeta::jsontoolkit::JSONArray< Value >
class	sourcemeta::jsontoolkit::ParseError
class	sourcemeta::jsontoolkit::FileParseError
class	sourcemeta::jsontoolkit::JSONObject< Key, Value >
class	sourcemeta::jsontoolkit::JSON

Typedefs
using	sourcemeta::jsontoolkit::KeyComparison = std::function< bool(const JSON::String &, const JSON::String &)>

Functions
auto	sourcemeta::jsontoolkit::parse (std::basic_istream< JSON::Char, JSON::CharTraits > &stream) -> JSON
auto	sourcemeta::jsontoolkit::parse (const std::basic_string< JSON::Char, JSON::CharTraits > &input) -> JSON
auto	sourcemeta::jsontoolkit::parse (std::basic_istream< JSON::Char, JSON::CharTraits > &stream, std::uint64_t &line, std::uint64_t &column) -> JSON
auto	sourcemeta::jsontoolkit::parse (const std::basic_string< JSON::Char, JSON::CharTraits > &input, std::uint64_t &line, std::uint64_t &column) -> JSON
auto	sourcemeta::jsontoolkit::read_file (const std::filesystem::path &path) -> std::basic_ifstream< JSON::Char, JSON::CharTraits >
auto	sourcemeta::jsontoolkit::from_file (const std::filesystem::path &path) -> JSON
auto	sourcemeta::jsontoolkit::stringify (const JSON &document, std::basic_ostream< JSON::Char, JSON::CharTraits > &stream) -> void
auto	sourcemeta::jsontoolkit::prettify (const JSON &document, std::basic_ostream< JSON::Char, JSON::CharTraits > &stream) -> void
auto	sourcemeta::jsontoolkit::stringify (const JSON &document, std::basic_ostream< JSON::Char, JSON::CharTraits > &stream, const KeyComparison &compare) -> void
auto	sourcemeta::jsontoolkit::prettify (const JSON &document, std::basic_ostream< JSON::Char, JSON::CharTraits > &stream, const KeyComparison &compare) -> void
auto	sourcemeta::jsontoolkit::operator<< (std::basic_ostream< JSON::Char, JSON::CharTraits > &stream, const JSON &document) -> std::basic_ostream< JSON::Char, JSON::CharTraits > &
auto	sourcemeta::jsontoolkit::operator<< (std::basic_ostream< JSON::Char, JSON::CharTraits > &stream, const JSON::Type type) -> std::basic_ostream< JSON::Char, JSON::CharTraits > &

Detailed Description

This functionality is included as follows:

#include <sourcemeta/jsontoolkit/json.h>

Typedef Documentation

KeyComparison

using sourcemeta::jsontoolkit::KeyComparison = typedef std::function<bool(const JSON::String &, const JSON::String &)>

A comparison function between object property keys. See https://en.cppreference.com/w/cpp/named_req/Compare

Function Documentation

from_file()

auto sourcemeta::jsontoolkit::from_file

(

const std::filesystem::path &

path

)

-> JSON

A convenience function to create a JSON document from a file. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <cassert>
#include <iostream>
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::from_file("/tmp/foo.json");
sourcemeta::jsontoolkit::stringify(document, std::cout);
std::cout << std::endl;

If parsing fails, sourcemeta::jsontoolkit::ParseError will be thrown.

operator<<() [1/2]

auto sourcemeta::jsontoolkit::operator<<	(	std::basic_ostream< JSON::Char, JSON::CharTraits > &	stream,
		const JSON &	document
	)		-> std::basic_ostream< JSON::Char, JSON::CharTraits > &

Encode the input JSON document into a given standard output stream. The JSON document is stringified or prettified depending on the presence of the NDEBUG define (for debugging purposes). For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <iostream>
#include <sstream>
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("[ 1, 2, 3 ]");
std::ostringstream stream;
stream << document;
std::cout << stream.str() << std::endl;

operator<<() [2/2]

auto sourcemeta::jsontoolkit::operator<<	(	std::basic_ostream< JSON::Char, JSON::CharTraits > &	stream,
		const JSON::Type	type
	)		-> std::basic_ostream< JSON::Char, JSON::CharTraits > &

Encode the input JSON type as a string into a given standard output stream. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <iostream>
#include <sstream>
 
std::ostringstream stream;
stream << sourcemeta::jsontoolkit::JSON::Type::String;
// Will print "string"
std::cout << stream.str() << std::endl;

parse() [1/4]

auto sourcemeta::jsontoolkit::parse

(

const std::basic_string< JSON::Char, JSON::CharTraits > &

input

)

-> JSON

Create a JSON document from a JSON string. For example, a JSON document that represents an array can be parsed as follows:

#include <sourcemeta/jsontoolkit/json.h>
#include <cassert>
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("[ 1, 2, 3 ]");
assert(document.is_array());

If parsing fails, sourcemeta::jsontoolkit::ParseError will be thrown.

parse() [2/4]

auto sourcemeta::jsontoolkit::parse	(	const std::basic_string< JSON::Char, JSON::CharTraits > &	input,
		std::uint64_t &	line,
		std::uint64_t &	column
	)		-> JSON

Create a JSON document from a JSON string, passing your own line and column read/write position indicators. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <cassert>
 
std::uint64_t line{1};
std::uint64_t column{0};
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("[ 1, 2, 3 ]", line, column);
assert(document.is_array());

parse() [3/4]

auto sourcemeta::jsontoolkit::parse

(

std::basic_istream< JSON::Char, JSON::CharTraits > &

stream

)

-> JSON

Create a JSON document from a C++ standard input stream. For example, a JSON document that represents an array can be parsed as follows:

#include <sourcemeta/jsontoolkit/json.h>
#include <cassert>
#include <sstream>
 
std::istringstream stream{"[ 1, 2, 3 ]"};
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse(stream);
assert(document.is_array());

If parsing fails, sourcemeta::jsontoolkit::ParseError will be thrown.

parse() [4/4]

auto sourcemeta::jsontoolkit::parse	(	std::basic_istream< JSON::Char, JSON::CharTraits > &	stream,
		std::uint64_t &	line,
		std::uint64_t &	column
	)		-> JSON

Create a JSON document from a C++ standard input stream, passing your own line and column read/write position indicators. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <cassert>
#include <sstream>
 
std::istringstream stream{"[ 1, 2, 3 ]"};
std::uint64_t line{1};
std::uint64_t column{0};
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse(stream, line, column);
assert(document.is_array());

prettify() [1/2]

auto sourcemeta::jsontoolkit::prettify	(	const JSON &	document,
		std::basic_ostream< JSON::Char, JSON::CharTraits > &	stream
	)		-> void

Stringify the input JSON document into a given C++ standard output stream in pretty mode, indenting the output using 4 spaces. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <iostream>
#include <sstream>
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("[ 1, 2, 3 ]");
std::ostringstream stream;
sourcemeta::jsontoolkit::prettify(document, stream);
std::cout << stream.str() << std::endl;

prettify() [2/2]

auto sourcemeta::jsontoolkit::prettify	(	const JSON &	document,
		std::basic_ostream< JSON::Char, JSON::CharTraits > &	stream,
		const KeyComparison &	compare
	)		-> void

Stringify the input JSON document into a given C++ standard output stream in pretty mode, indenting the output using 4 spaces and sorting object properties on a specific criteria. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <iostream>
#include <sstream>
 
auto key_compare(const sourcemeta::jsontoolkit::JSON::String &left,
                 const sourcemeta::jsontoolkit::JSON::String &right)
  -> bool {
  return left < right;
}
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("{ \"foo\": 1, \"bar\": 2, \"baz\": 3 }");
std::ostringstream stream;
sourcemeta::jsontoolkit::prettify(document, stream, key_compare);
std::cout << stream.str() << std::endl;

read_file()

auto sourcemeta::jsontoolkit::read_file

(

const std::filesystem::path &

path

)

-> std::basic_ifstream< JSON::Char, JSON::CharTraits >

A convenience function to read a document from a file. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <cassert>
#include <iostream>
 
auto stream = sourcemeta::jsontoolkit::read_file("/tmp/foo.json");
const auto document = sourcemeta::jsontoolkit::parse(stream);
sourcemeta::jsontoolkit::stringify(document, std::cout);
std::cout << std::endl;

If parsing fails, sourcemeta::jsontoolkit::ParseError will be thrown.

stringify() [1/2]

auto sourcemeta::jsontoolkit::stringify	(	const JSON &	document,
		std::basic_ostream< JSON::Char, JSON::CharTraits > &	stream
	)		-> void

Stringify the input JSON document into a given C++ standard output stream in compact mode. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <iostream>
#include <sstream>
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("[ 1, 2, 3 ]");
std::ostringstream stream;
sourcemeta::jsontoolkit::stringify(document, stream);
std::cout << stream.str() << std::endl;

stringify() [2/2]

auto sourcemeta::jsontoolkit::stringify	(	const JSON &	document,
		std::basic_ostream< JSON::Char, JSON::CharTraits > &	stream,
		const KeyComparison &	compare
	)		-> void

Stringify the input JSON document into a given C++ standard output stream in compact mode, sorting object properties on a specific criteria. For example:

#include <sourcemeta/jsontoolkit/json.h>
#include <iostream>
#include <sstream>
 
auto key_compare(const sourcemeta::jsontoolkit::JSON::String &left,
                 const sourcemeta::jsontoolkit::JSON::String &right)
  -> bool {
  return left < right;
}
 
const sourcemeta::jsontoolkit::JSON document =
  sourcemeta::jsontoolkit::parse("{ \"foo\": 1, \"bar\": 2, \"baz\": 3 }");
std::ostringstream stream;
sourcemeta::jsontoolkit::stringify(document, stream, key_compare);
std::cout << stream.str() << std::endl;