Reader Class Reference

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

#include <reader.h>

Public Types
typedef char	Char
typedef const Char *	Location

Public Member Functions
	Reader ()
	Constructs a Reader allowing all features for parsing. More...
	Reader (const Features &features)
	Constructs a Reader allowing the specified feature set for parsing. More...
bool	parse (const std::string &document, Value &root, bool collectComments=true)
	Read a Value from a JSON document. More...
bool	parse (const char *beginDoc, const char *endDoc, Value &root, bool collectComments=true)
	Read a Value from a JSON document. More...
bool	parse (std::istream &is, Value &root, bool collectComments=true)
	Parse from input stream. More...
std::string	getFormatedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document. More...
local	getFormatedErrorMessages ()
	Returns a user friendly string that list errors in the parsed document. More...
std::string	getFormattedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document. More...

Detailed Description

Unserialize a JSON document into a Value.

Member Typedef Documentation

typedef char Char

var Char

local Char

typedef const Char* Location

var Location

local Location

Constructor & Destructor Documentation

Reader

(

)

Constructs a Reader allowing all features for parsing.

var Reader

(

)

Constructs a Reader allowing all features for parsing.

local Reader

(

)

Constructs a Reader allowing all features for parsing.

Reader

(

const Features &

features)

Constructs a Reader allowing the specified feature set for parsing.

var Reader

(

var

features)

Constructs a Reader allowing the specified feature set for parsing.

local Reader

(

local

features)

Constructs a Reader allowing the specified feature set for parsing.

Member Function Documentation

std::string getFormatedErrorMessages

(

)

const

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

Deprecated:

Use getFormattedErrorMessages() instead (typo fix).

var getFormatedErrorMessages

(

)

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

Deprecated:

Use getFormattedErrorMessages() instead (typo fix).

local getFormatedErrorMessages

(

)

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

Deprecated:

Use getFormattedErrorMessages() instead (typo fix).

std::string getFormattedErrorMessages

(

)

const

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

var getFormattedErrorMessages

(

)

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

local getFormattedErrorMessages

(

)

Returns a user friendly string that list errors in the parsed document.

Returns

Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

bool parse	(	const std::string &	document,
		Value &	root,
		bool	collectComments = true
	)

Read a Value from a JSON document.

Parameters

document	UTF-8 encoded string containing the document to read.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

var parse	(	var	document,
		var	root,
		var	collectComments = true
	)

Read a Value from a JSON document.

Parameters

document	UTF-8 encoded string containing the document to read.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

local parse	(	local	document,
		local	root,
		local	collectComments = true
	)

Read a Value from a JSON document.

Parameters

document	UTF-8 encoded string containing the document to read.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

bool parse	(	const char *	beginDoc,
		const char *	endDoc,
		Value &	root,
		bool	collectComments = true
	)

Read a Value from a JSON document.

Parameters

beginDoc	Pointer on the beginning of the UTF-8 encoded string of the document to read.
endDoc	Pointer on the end of the UTF-8 encoded string of the document to read. \ Must be >= beginDoc.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

var parse	(	var	beginDoc,
		var	endDoc,
		var	root,
		var	collectComments = true
	)

Read a Value from a JSON document.

Parameters

beginDoc	Pointer on the beginning of the UTF-8 encoded string of the document to read.
endDoc	Pointer on the end of the UTF-8 encoded string of the document to read. \ Must be >= beginDoc.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

local parse	(	local	beginDoc,
		local	endDoc,
		local	root,
		local	collectComments = true
	)

Read a Value from a JSON document.

Parameters

beginDoc	Pointer on the beginning of the UTF-8 encoded string of the document to read.
endDoc	Pointer on the end of the UTF-8 encoded string of the document to read. \ Must be >= beginDoc.
root	[out] Contains the root value of the document if it was successfully parsed.
collectComments	true to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.

Returns

true if the document was successfully parsed, false if an error occurred.

bool parse	(	std::istream &	is,
		Value &	root,
		bool	collectComments = true
	)

Parse from input stream.

See Also

CSJson::operator>>(std::istream&, CSJson::Value&).

var parse	(	var	is,
		var	root,
		var	collectComments = true
	)

Parse from input stream.

See Also

CSJson::operator>>(std::istream&, CSJson::Value&).

local parse	(	local	is,
		local	root,
		local	collectComments = true
	)

Parse from input stream.

See Also

CSJson::operator>>(std::istream&, CSJson::Value&).

---

The documentation for this class was generated from the following file:

• /Users/cocos2d/MyWork/cocos2d-x/extensions/CocoStudio/Json/lib_json/reader.h