error.h
Go to the documentation of this file.
1 // Tencent is pleased to support the open source community by making RapidJSON available.
2 //
3 // Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
4 //
5 // Licensed under the MIT License (the "License"); you may not use this file except
6 // in compliance with the License. You may obtain a copy of the License at
7 //
8 // http://opensource.org/licenses/MIT
9 //
10 // Unless required by applicable law or agreed to in writing, software distributed
11 // under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
12 // CONDITIONS OF ANY KIND, either express or implied. See the License for the
13 // specific language governing permissions and limitations under the License.
14
15 #ifndef RAPIDJSON_ERROR_ERROR_H_
16 #define RAPIDJSON_ERROR_ERROR_H_
17
18 #include "../rapidjson.h"
19
20 #ifdef __clang__
21 RAPIDJSON_DIAG_PUSH
22 RAPIDJSON_DIAG_OFF(padded)
23 #endif
24
25 /*! \file error.h */
26
27 /*! \defgroup RAPIDJSON_ERRORS RapidJSON error handling */
28
29 ///////////////////////////////////////////////////////////////////////////////
30 // RAPIDJSON_ERROR_CHARTYPE
31
32 //! Character type of error messages.
33 /*! \ingroup RAPIDJSON_ERRORS
34 The default character type is \c char.
35 On Windows, user can define this macro as \c TCHAR for supporting both
36 unicode/non-unicode settings.
37 */
38 #ifndef RAPIDJSON_ERROR_CHARTYPE
39 #define RAPIDJSON_ERROR_CHARTYPE char
40 #endif
41
42 ///////////////////////////////////////////////////////////////////////////////
43 // RAPIDJSON_ERROR_STRING
44
45 //! Macro for converting string literial to \ref RAPIDJSON_ERROR_CHARTYPE[].
46 /*! \ingroup RAPIDJSON_ERRORS
47 By default this conversion macro does nothing.
48 On Windows, user can define this macro as \c _T(x) for supporting both
49 unicode/non-unicode settings.
50 */
51 #ifndef RAPIDJSON_ERROR_STRING
52 #define RAPIDJSON_ERROR_STRING(x) x
53 #endif
54
55 RAPIDJSON_NAMESPACE_BEGIN
56
57 ///////////////////////////////////////////////////////////////////////////////
58 // ParseErrorCode
59
60 //! Error code of parsing.
61 /*! \ingroup RAPIDJSON_ERRORS
62 \see GenericReader::Parse, GenericReader::GetParseErrorCode
63 */
64 enum ParseErrorCode {
65 kParseErrorNone = 0, //!< No error.
66
67 kParseErrorDocumentEmpty, //!< The document is empty.
68 kParseErrorDocumentRootNotSingular, //!< The document root must not follow by other values.
69
70 kParseErrorValueInvalid, //!< Invalid value.
71
72 kParseErrorObjectMissName, //!< Missing a name for object member.
73 kParseErrorObjectMissColon, //!< Missing a colon after a name of object member.
74 kParseErrorObjectMissCommaOrCurlyBracket, //!< Missing a comma or '}' after an object member.
75
76 kParseErrorArrayMissCommaOrSquareBracket, //!< Missing a comma or ']' after an array element.
77
78 kParseErrorStringUnicodeEscapeInvalidHex, //!< Incorrect hex digit after \\u escape in string.
79 kParseErrorStringUnicodeSurrogateInvalid, //!< The surrogate pair in string is invalid.
80 kParseErrorStringEscapeInvalid, //!< Invalid escape character in string.
81 kParseErrorStringMissQuotationMark, //!< Missing a closing quotation mark in string.
82 kParseErrorStringInvalidEncoding, //!< Invalid encoding in string.
83
84 kParseErrorNumberTooBig, //!< Number too big to be stored in double.
85 kParseErrorNumberMissFraction, //!< Miss fraction part in number.
86 kParseErrorNumberMissExponent, //!< Miss exponent in number.
87
88 kParseErrorTermination, //!< Parsing was terminated.
89 kParseErrorUnspecificSyntaxError //!< Unspecific syntax error.
90 };
91
92 //! Result of parsing (wraps ParseErrorCode)
93 /*!
94 \ingroup RAPIDJSON_ERRORS
95 \code
96 Document doc;
97 ParseResult ok = doc.Parse("[42]");
98 if (!ok) {
99 fprintf(stderr, "JSON parse error: %s (%u)",
100 GetParseError_En(ok.Code()), ok.Offset());
101 exit(EXIT_FAILURE);
102 }
103 \endcode
104 \see GenericReader::Parse, GenericDocument::Parse
105 */
106 struct ParseResult {
107 public:
108 //! Default constructor, no error.
109 ParseResult() : code_(kParseErrorNone), offset_(0) {}
110 //! Constructor to set an error.
111 ParseResult(ParseErrorCode code, size_t offset) : code_(code), offset_(offset) {}
112
113 //! Get the error code.
114 ParseErrorCode Code() const { return code_; }
115 //! Get the error offset, if \ref IsError(), 0 otherwise.
116 size_t Offset() const { return offset_; }
117
118 //! Conversion to \c bool, returns \c true, iff !\ref IsError().
119 operator bool() const { return !IsError(); }
120 //! Whether the result is an error.
121 bool IsError() const { return code_ != kParseErrorNone; }
122
123 bool operator==(const ParseResult& that) const { return code_ == that.code_; }
124 bool operator==(ParseErrorCode code) const { return code_ == code; }
125 friend bool operator==(ParseErrorCode code, const ParseResult & err) { return code == err.code_; }
126
127 //! Reset error code.
128 void Clear() { Set(kParseErrorNone); }
129 //! Update error code and offset.
130 void Set(ParseErrorCode code, size_t offset = 0) { code_ = code; offset_ = offset; }
131
132 private:
133 ParseErrorCode code_;
134 size_t offset_;
135 };
136
137 //! Function pointer type of GetParseError().
138 /*! \ingroup RAPIDJSON_ERRORS
139
140 This is the prototype for \c GetParseError_X(), where \c X is a locale.
141 User can dynamically change locale in runtime, e.g.:
142 \code
143 GetParseErrorFunc GetParseError = GetParseError_En; // or whatever
144 const RAPIDJSON_ERROR_CHARTYPE* s = GetParseError(document.GetParseErrorCode());
145 \endcode
146 */
147 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetParseErrorFunc)(ParseErrorCode);
148
149 RAPIDJSON_NAMESPACE_END
150
151 #ifdef __clang__
152 RAPIDJSON_DIAG_POP
153 #endif
154
155 #endif // RAPIDJSON_ERROR_ERROR_H_
rapidjson::kParseErrorValueInvalid
Invalid value.
Definition: error.h:70
rapidjson::kParseErrorStringUnicodeSurrogateInvalid
The surrogate pair in string is invalid.
Definition: error.h:79
rapidjson::ParseResult::ParseResult
ParseResult(ParseErrorCode code, size_t offset)
Constructor to set an error.
Definition: error.h:111
rapidjson::kParseErrorObjectMissColon
Missing a colon after a name of object member.
Definition: error.h:73
rapidjson::kParseErrorStringUnicodeEscapeInvalidHex
Incorrect hex digit after \u escape in string.
Definition: error.h:78
rapidjson::kParseErrorNumberMissFraction
Miss fraction part in number.
Definition: error.h:85
rapidjson::kParseErrorNone
No error.
Definition: error.h:65
rapidjson::ParseErrorCode
ParseErrorCode
Error code of parsing.
Definition: error.h:64
rapidjson::ParseResult::Clear
void Clear()
Reset error code.
Definition: error.h:128
rapidjson::kParseErrorArrayMissCommaOrSquareBracket
Missing a comma or &#39;]&#39; after an array element.
Definition: error.h:76
rapidjson::kParseErrorDocumentRootNotSingular
The document root must not follow by other values.
Definition: error.h:68
rapidjson::kParseErrorUnspecificSyntaxError
Unspecific syntax error.
Definition: error.h:89
rapidjson::kParseErrorStringMissQuotationMark
Missing a closing quotation mark in string.
Definition: error.h:81
rapidjson::kParseErrorStringEscapeInvalid
Invalid escape character in string.
Definition: error.h:80
RAPIDJSON_ERROR_CHARTYPE
#define RAPIDJSON_ERROR_CHARTYPE
Character type of error messages.
Definition: error.h:39
rapidjson::ParseResult
Result of parsing (wraps ParseErrorCode)
Definition: error.h:106
rapidjson::kParseErrorObjectMissName
Missing a name for object member.
Definition: error.h:72
rapidjson::ParseResult::IsError
bool IsError() const
Whether the result is an error.
Definition: error.h:121
rapidjson::ParseResult::Offset
size_t Offset() const
Get the error offset, if IsError(), 0 otherwise.
Definition: error.h:116
rapidjson::kParseErrorTermination
Parsing was terminated.
Definition: error.h:88
rapidjson::kParseErrorNumberTooBig
Number too big to be stored in double.
Definition: error.h:84
rapidjson::ParseResult::Code
ParseErrorCode Code() const
Get the error code.
Definition: error.h:114
rapidjson::kParseErrorNumberMissExponent
Miss exponent in number.
Definition: error.h:86
rapidjson::ParseResult::ParseResult
ParseResult()
Default constructor, no error.
Definition: error.h:109
rapidjson::kParseErrorDocumentEmpty
The document is empty.
Definition: error.h:67
rapidjson::kParseErrorObjectMissCommaOrCurlyBracket
Missing a comma or &#39;}&#39; after an object member.
Definition: error.h:74
rapidjson::kParseErrorStringInvalidEncoding
Invalid encoding in string.
Definition: error.h:82
rapidjson::ParseResult::Set
void Set(ParseErrorCode code, size_t offset=0)
Update error code and offset.
Definition: error.h:130