| JsonCpp project page | JsonCpp home page | 
Unserialize a JSON document into a Value. More...
#include <json/reader.h>
 Collaboration diagram for Json::Reader:
 Collaboration diagram for Json::Reader:| Classes | |
| struct | StructuredError | 
| An error tagged with where in the JSON text it was encountered.  More... | |
| 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... | |
| std::string | getFormattedErrorMessages () const | 
| Returns a user friendly string that list errors in the parsed document.  More... | |
| std::vector< StructuredError > | getStructuredErrors () const | 
| Returns a vector of structured erros encounted while parsing.  More... | |
| bool | pushError (const Value &value, const std::string &message) | 
| Add a semantic error message.  More... | |
| bool | pushError (const Value &value, const std::string &message, const Value &extra) | 
| Add a semantic error message with extra context.  More... | |
| bool | good () const | 
| Return whether there are any errors.  More... | |
Unserialize a JSON document into a Value.
| typedef char Json::Reader::Char | 
| typedef const Char* Json::Reader::Location | 
| Json::Reader::Reader | ( | ) | 
Constructs a Reader allowing all features for parsing.
Definition at line 94 of file json_reader.cpp.
| Json::Reader::Reader | ( | const Features & | features | ) | 
Constructs a Reader allowing the specified feature set for parsing.
Definition at line 99 of file json_reader.cpp.
| std::string Json::Reader::getFormatedErrorMessages | ( | ) | const | 
Returns a user friendly string that list errors in the parsed document.
Definition at line 823 of file json_reader.cpp.
References getFormattedErrorMessages().
| std::string Json::Reader::getFormattedErrorMessages | ( | ) | const | 
Returns a user friendly string that list errors in the parsed document.
Definition at line 827 of file json_reader.cpp.
References JSONCPP_STRING.
Referenced by getFormatedErrorMessages(), and good().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| std::vector< Reader::StructuredError > Json::Reader::getStructuredErrors | ( | ) | const | 
Returns a vector of structured erros encounted while parsing.
Definition at line 843 of file json_reader.cpp.
References Json::Reader::StructuredError::message, Json::Reader::StructuredError::offset_limit, and Json::Reader::StructuredError::offset_start.
Referenced by good().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| bool Json::Reader::good | ( | ) | const | 
Return whether there are any errors.
true if there are no errors to report false if errors have occurred. Definition at line 893 of file json_reader.cpp.
References Json::arrayValue, Json::Value::asString(), Json::codePointToUTF8(), Json::commentAfter, Json::commentAfterOnSameLine, Json::commentBefore, Json::containsNewLine(), Json::fixNumericLocaleInput(), getFormattedErrorMessages(), Json::Value::getOffsetLimit(), Json::Value::getOffsetStart(), getStructuredErrors(), Json::Value::isArray(), Json::Value::isObject(), JSONCPP_OVERRIDE, JSONCPP_STRING, Json::Value::maxInt, Json::Value::maxLargestUInt, Json::Value::minLargestInt, Json::normalizeEOL(), Json::objectValue, parse(), pushError(), Json::Value::setComment(), snprintf, and Json::Value::swapPayload().
| bool Json::Reader::parse | ( | const std::string & | document, | 
| Value & | root, | ||
| bool | collectComments = true | ||
| ) | 
Read a Value from a JSON document.
| 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 | trueto collect comment and allow writing them back during serialization,falseto discard comments. This parameter is ignored if Features::allowComments_ isfalse. | 
true if the document was successfully parsed, false if an error occurred. Definition at line 105 of file json_reader.cpp.
References JSONCPP_STRING.
Referenced by good(), and parse().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| bool Json::Reader::parse | ( | const char * | beginDoc, | 
| const char * | endDoc, | ||
| Value & | root, | ||
| bool | collectComments = true | ||
| ) | 
Read a Value from a JSON document.
| 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 | trueto collect comment and allow writing them back during serialization,falseto discard comments. This parameter is ignored if Features::allowComments_ isfalse. | 
true if the document was successfully parsed, false if an error occurred. Definition at line 126 of file json_reader.cpp.
References Json::Features::allowComments_, Json::Features::allowDroppedNullPlaceholders_, Json::commentAfter, Json::commentAfterOnSameLine, Json::commentBefore, Json::containsNewLine(), Json::Value::isArray(), Json::Value::isObject(), Json::Value::setComment(), Json::Value::setOffsetLimit(), Json::Value::setOffsetStart(), stackLimit_g, Json::Features::strictRoot_, and Json::Value::swapPayload().
| bool Json::Reader::parse | ( | std::istream & | is, | 
| Value & | root, | ||
| bool | collectComments = true | ||
| ) | 
Parse from input stream.
Definition at line 113 of file json_reader.cpp.
References JSONCPP_STRING, and parse().
| bool Json::Reader::pushError | ( | const Value & | value, | 
| const std::string & | message | ||
| ) | 
Add a semantic error message.
| value | JSON Value location associated with the error | 
| message | The error message. | 
true if the error was successfully added, false if the Value offset exceeds the document size. Definition at line 858 of file json_reader.cpp.
References Json::Value::getOffsetLimit(), and Json::Value::getOffsetStart().
Referenced by good().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| bool Json::Reader::pushError | ( | const Value & | value, | 
| const std::string & | message, | ||
| const Value & | extra | ||
| ) | 
Add a semantic error message with extra context.
| value | JSON Value location associated with the error | 
| message | The error message. | 
| extra | Additional JSON Value location to contextualize the error | 
true if the error was successfully added, false if either Value offset exceeds the document size. Definition at line 875 of file json_reader.cpp.
References Json::Value::getOffsetLimit(), and Json::Value::getOffsetStart().