JSON (JavaScript Object Notation). More...

Classes
struct	BuiltStyledStreamWriter

class	CharReader

class	CharReaderBuilder
	Build a CharReader implementation. More...

struct	CommentStyle
	Scoped enums are not available until C++11. More...

class	Exception

class	FastWriter
	Outputs a Value in JSON format without formatting (not human friendly). More...

class	Features
	Configuration passed to reader and writer. This configuration object can be used to force the Reader or Writer to behave in a standard conforming way. More...

class	LogicError

class	OurCharReader

class	OurFeatures

class	OurReader

class	Path
	Experimental and untested: represents a "path" to access a node. More...

class	PathArgument
	Experimental and untested: represents an element of the "path" to access a node. More...

class	Reader
	Unserialize a JSON document into a Value. More...

class	RuntimeError

class	StaticString
	Lightweight wrapper to tag static string. More...

class	StreamWriter

class	StreamWriterBuilder
	Build a StreamWriter implementation. More...

class	StyledStreamWriter
	Writes a Value in JSON format in a human friendly way, to a stream rather than to a string. More...

class	StyledWriter
	Writes a Value in JSON format in a human friendly way. More...

class	Value
	Represents a JSON value. More...

class	ValueConstIterator
	const iterator for object and array value. More...

class	ValueIterator
	Iterator for object and array value. More...

class	ValueIteratorBase
	base class for Value iterators. More...

class	Writer
	Abstract class for writers. More...

Typedefs
typedef unsigned int	ArrayIndex

typedef std::auto_ptr< CharReader >	CharReaderPtr

typedef int	Int

typedef long long int	Int64

typedef Int64	LargestInt

typedef UInt64	LargestUInt

typedef std::auto_ptr< StreamWriter >	StreamWriterPtr

typedef unsigned int	UInt

typedef unsigned long long int	UInt64

typedef char	UIntToStringBuffer[uintToStringBufferSize]

Enumerations
enum	{ uintToStringBufferSize = 3 * sizeof(LargestUInt) + 1 }

enum	CommentPlacement { commentBefore = 0, commentAfterOnSameLine, commentAfter, numberOfCommentPlacement }

enum	ValueType { nullValue = 0, intValue, uintValue, realValue, stringValue, booleanValue, arrayValue, objectValue }
	Type of the value held by a Value object. More...

Functions
static const unsigned char	ALIGNAS (8) kNull[sizeof(Value)]

static std::string	codePointToUTF8 (unsigned int cp)
	Converts a unicode code-point to UTF-8. More...

static bool	containsControlCharacter (const char *str)

static bool	containsControlCharacter0 (const char *str, unsigned len)

static bool	containsNewLine (Reader::Location begin, Reader::Location end)

static void	decodePrefixedString (bool isPrefixed, char const prefixed, unsigned length, char const **value)

static char *	duplicateAndPrefixStringValue (const char *value, unsigned int length)

static char *	duplicateStringValue (const char *value, size_t length)

static void	fixNumericLocale (char begin, char end)

static void	getValidReaderKeys (std::set< std::string > *valid_keys)

static void	getValidWriterKeys (std::set< std::string > *valid_keys)

template<typename T , typename U >
static bool	InRange (double d, T min, U max)

static bool	isControlCharacter (char ch)
	Returns true if ch is a control character (in range [1,31]). More...

static bool	IsIntegral (double d)

static std::string	normalizeEOL (Reader::Location begin, Reader::Location end)

JSON_API std::ostream &	operator<< (std::ostream &, const Value &root)
	Output using the StyledStreamWriter. More...

JSON_API std::istream &	operator>> (std::istream &, Value &)
	Read from 'sin' into 'root'. More...

bool JSON_API	parseFromStream (CharReader::Factory const &, std::istream &, Value root, std::string errs)

static void	releaseStringValue (char *value)

static char const *	strnpbrk (char const s, char const accept, size_t n)

void	throwLogicError (std::string const &msg)
	used internally More...

void	throwRuntimeError (std::string const &msg)
	used internally More...

static void	uintToString (LargestUInt value, char *&current)

std::string JSON_API	valueToQuotedString (const char *value)

static std::string	valueToQuotedStringN (const char *value, unsigned length)

std::string JSON_API	valueToString (bool value)

std::string JSON_API	valueToString (double value)

std::string	valueToString (double value, bool useSpecialFloats, unsigned int precision)

std::string JSON_API	valueToString (Int value)

std::string JSON_API	valueToString (LargestInt value)

std::string JSON_API	valueToString (LargestUInt value)

std::string JSON_API	valueToString (UInt value)

std::string JSON_API	writeString (StreamWriter::Factory const &factory, Value const &root)
	Write into stringstream, then return string, for convenience. A StreamWriter will be created from the factory, used, and then deleted. More...

Variables
const unsigned char &	kNullRef = kNull[0]

Detailed Description

JSON (JavaScript Object Notation).

Typedef Documentation

◆ ArrayIndex

typedef unsigned int Json::ArrayIndex

Definition at line 286 of file json.h.

◆ CharReaderPtr

typedef std::auto_ptr<CharReader> Json::CharReaderPtr

Definition at line 240 of file jsoncpp.cpp.

◆ Int

typedef int Json::Int

Definition at line 228 of file json.h.

◆ Int64

typedef long long int Json::Int64

Definition at line 240 of file json.h.

◆ LargestInt

typedef Int64 Json::LargestInt

Definition at line 243 of file json.h.

◆ LargestUInt

typedef UInt64 Json::LargestUInt

Definition at line 244 of file json.h.

◆ StreamWriterPtr

typedef std::auto_ptr<StreamWriter> Json::StreamWriterPtr

Definition at line 4048 of file jsoncpp.cpp.

◆ UInt

typedef unsigned int Json::UInt

Definition at line 229 of file json.h.

◆ UInt64

typedef unsigned long long int Json::UInt64

Definition at line 241 of file json.h.

◆ UIntToStringBuffer

typedef char Json::UIntToStringBuffer[uintToStringBufferSize]

Definition at line 142 of file jsoncpp.cpp.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
uintToStringBufferSize	Constant that specify the size of the buffer that must be passed to uintToString.

Definition at line 135 of file jsoncpp.cpp.

◆ CommentPlacement

enum Json::CommentPlacement

Enumerator
commentBefore	a comment placed on the line before a value
commentAfterOnSameLine	a comment just after a value on the same line
commentAfter	a comment on the line after a value (only make sense for
numberOfCommentPlacement	root value)

Definition at line 474 of file json.h.

◆ ValueType

enum Json::ValueType

Type of the value held by a Value object.

Enumerator
nullValue	'null' value
intValue	signed integer value
uintValue	unsigned integer value
realValue	double value
stringValue	UTF-8 string value.
booleanValue	bool value
arrayValue	array value (ordered list)
objectValue	object value (collection of name/value pairs).

Definition at line 463 of file json.h.

Function Documentation

◆ ALIGNAS()

static const unsigned char Json::ALIGNAS ( 8 )

static

◆ codePointToUTF8()

static std::string Json::codePointToUTF8 ( unsigned int cp )

inlinestatic

Converts a unicode code-point to UTF-8.

Definition at line 104 of file jsoncpp.cpp.

◆ containsControlCharacter()

static bool Json::containsControlCharacter ( const char * str )

static

Definition at line 4051 of file jsoncpp.cpp.

◆ containsControlCharacter0()

static bool Json::containsControlCharacter0	(	const char *	str,
		unsigned	len
	)

static

Definition at line 4059 of file jsoncpp.cpp.

◆ containsNewLine()

static bool Json::containsNewLine	(	Reader::Location	begin,
		Reader::Location	end
	)

static

Definition at line 264 of file jsoncpp.cpp.

◆ decodePrefixedString()

static void Json::decodePrefixedString	(	bool	isPrefixed,
		char const *	prefixed,
		unsigned *	length,
		char const **	value
	)

inlinestatic

Definition at line 2537 of file jsoncpp.cpp.

◆ duplicateAndPrefixStringValue()

static char* Json::duplicateAndPrefixStringValue	(	const char *	value,
		unsigned int	length
	)

inlinestatic

Definition at line 2516 of file jsoncpp.cpp.

◆ duplicateStringValue()

static char* Json::duplicateStringValue	(	const char *	value,
		size_t	length
	)

inlinestatic

Duplicates the specified string value.

Parameters

value	Pointer to the string to duplicate. Must be zero-terminated if length is "unknown".
length	Length of the value. if equals to unknown, then it will be computed using strlen(value).

Returns: Pointer on the duplicate instance of string.

Definition at line 2496 of file jsoncpp.cpp.

◆ fixNumericLocale()

static void Json::fixNumericLocale	(	char *	begin,
		char *	end
	)

inlinestatic

Change ',' to '.' everywhere in buffer.

We had a sophisticated way, but it did not work in WinCE.

See also: https://github.com/open-source-parsers/jsoncpp/pull/9

Definition at line 162 of file jsoncpp.cpp.

◆ getValidReaderKeys()

static void Json::getValidReaderKeys ( std::set< std::string > * valid_keys )

static

Definition at line 2121 of file jsoncpp.cpp.

◆ getValidWriterKeys()

static void Json::getValidWriterKeys ( std::set< std::string > * valid_keys )

static

Definition at line 5125 of file jsoncpp.cpp.

◆ InRange()

template<typename T , typename U >

static bool Json::InRange	(	double	d,
		T	min,
		U	max
	)

inlinestatic

Definition at line 2471 of file jsoncpp.cpp.

◆ isControlCharacter()

static bool Json::isControlCharacter ( char ch )

inlinestatic

Returns true if ch is a control character (in range [1,31]).

Definition at line 133 of file jsoncpp.cpp.

◆ IsIntegral()

static bool Json::IsIntegral ( double d )

static

Definition at line 3624 of file jsoncpp.cpp.

◆ normalizeEOL()

static std::string Json::normalizeEOL	(	Reader::Location	begin,
		Reader::Location	end
	)

static

Definition at line 556 of file jsoncpp.cpp.

◆ operator<<()

std::ostream & Json::operator<<	(	std::ostream &	sout,
		const Value &	root
	)

Output using the StyledStreamWriter.

See also: Json::operator>>()

Definition at line 5176 of file jsoncpp.cpp.

◆ operator>>()

std::istream & Json::operator>>	(	std::istream &	sin,
		Value &	root
	)

Read from 'sin' into 'root'.

Always keep comments from the input JSON.

This can be used to read a file into a particular sub-object. For example:

Json::Value root;
cin >> root["dir"]["file"];
cout << root;

Result:

{
"dir": {
    "file": {
    // The input stream JSON would be nested here.
    }
}
}

Exceptions

std::exception on parse error.

See also: Json::operator<<()

Definition at line 2205 of file jsoncpp.cpp.

◆ parseFromStream()

bool Json::parseFromStream	(	CharReader::Factory const &	fact,
		std::istream &	sin,
		Value *	root,
		std::string *	errs
	)

Consume entire stream and use its begin/end. Someday we might have a real StreamReader, but for now this is convenient.

Definition at line 2191 of file jsoncpp.cpp.

◆ releaseStringValue()

static void Json::releaseStringValue ( char * value )

inlinestatic

Free the string duplicated by duplicateStringValue()/duplicateAndPrefixStringValue().

Definition at line 2551 of file jsoncpp.cpp.

◆ strnpbrk()

static char const* Json::strnpbrk	(	char const *	s,
		char const *	accept,
		size_t	n
	)

static

Definition at line 4202 of file jsoncpp.cpp.

◆ throwLogicError()

void Json::throwLogicError ( std::string const & msg )

used internally

Definition at line 2588 of file jsoncpp.cpp.

◆ throwRuntimeError()

void Json::throwRuntimeError ( std::string const & msg )

used internally

Definition at line 2584 of file jsoncpp.cpp.

◆ uintToString()

static void Json::uintToString	(	LargestUInt	value,
		char *&	current
	)

inlinestatic

Converts an unsigned integer to string.

Parameters

value	Unsigned interger to convert to string
current	Input/Output string buffer. Must have at least uintToStringBufferSize chars free.

Definition at line 149 of file jsoncpp.cpp.

◆ valueToQuotedString()

std::string Json::valueToQuotedString ( const char * value )

Definition at line 4139 of file jsoncpp.cpp.

◆ valueToQuotedStringN()

static std::string Json::valueToQuotedStringN	(	const char *	value,
		unsigned	length
	)

static

Definition at line 4216 of file jsoncpp.cpp.

◆ valueToString() [1/7]

std::string Json::valueToString ( bool value )

Definition at line 4137 of file jsoncpp.cpp.

◆ valueToString() [2/7]

std::string Json::valueToString ( double value )

Definition at line 4135 of file jsoncpp.cpp.

◆ valueToString() [3/7]

std::string Json::valueToString	(	double	value,
		bool	useSpecialFloats,
		unsigned int	precision
	)

Definition at line 4105 of file jsoncpp.cpp.

◆ valueToString() [4/7]

std::string JSON_API Json::valueToString ( Int value )

◆ valueToString() [5/7]

std::string Json::valueToString ( LargestInt value )

Definition at line 4069 of file jsoncpp.cpp.

◆ valueToString() [6/7]

std::string Json::valueToString ( LargestUInt value )

Definition at line 4085 of file jsoncpp.cpp.

◆ valueToString() [7/7]

std::string JSON_API Json::valueToString ( UInt value )

◆ writeString()

std::string Json::writeString	(	StreamWriter::Factory const &	factory,
		Value const &	root
	)

Write into stringstream, then return string, for convenience. A StreamWriter will be created from the factory, used, and then deleted.

Definition at line 5169 of file jsoncpp.cpp.

Variable Documentation

◆ kNullRef

const unsigned char& Json::kNullRef = kNull[0]

Definition at line 2449 of file jsoncpp.cpp.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ ArrayIndex

◆ CharReaderPtr

◆ Int

◆ Int64

◆ LargestInt

◆ LargestUInt

◆ StreamWriterPtr

◆ UInt

◆ UInt64

◆ UIntToStringBuffer

Enumeration Type Documentation

◆ anonymous enum

◆ CommentPlacement

◆ ValueType

Function Documentation

◆ ALIGNAS()

◆ codePointToUTF8()

◆ containsControlCharacter()

◆ containsControlCharacter0()

◆ containsNewLine()

◆ decodePrefixedString()

◆ duplicateAndPrefixStringValue()

◆ duplicateStringValue()

◆ fixNumericLocale()

◆ getValidReaderKeys()

◆ getValidWriterKeys()

◆ InRange()

◆ isControlCharacter()

◆ IsIntegral()

◆ normalizeEOL()

◆ operator<<()

◆ operator>>()

◆ parseFromStream()

◆ releaseStringValue()

◆ strnpbrk()

◆ throwLogicError()

◆ throwRuntimeError()

◆ uintToString()

◆ valueToQuotedString()

◆ valueToQuotedStringN()

◆ valueToString() [1/7]

◆ valueToString() [2/7]

◆ valueToString() [3/7]

◆ valueToString() [4/7]

◆ valueToString() [5/7]

◆ valueToString() [6/7]

◆ valueToString() [7/7]

◆ writeString()

Variable Documentation

◆ kNullRef