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.
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 literal 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 */
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  //!! Unspecified boolean type
108  typedef bool (ParseResult::*BooleanType)() const;
109 public:
110  //! Default constructor, no error.
111  ParseResult() : code_(kParseErrorNone), offset_(0) {}
112  //! Constructor to set an error.
113  ParseResult(ParseErrorCode code, size_t offset) : code_(code), offset_(offset) {}
114 
115  //! Get the error code.
116  ParseErrorCode Code() const { return code_; }
117  //! Get the error offset, if \ref IsError(), 0 otherwise.
118  size_t Offset() const { return offset_; }
119 
120  //! Explicit conversion to \c bool, returns \c true, iff !\ref IsError().
121  operator BooleanType() const { return !IsError() ? &ParseResult::IsError : NULL; }
122  //! Whether the result is an error.
123  bool IsError() const { return code_ != kParseErrorNone; }
124 
125  bool operator==(const ParseResult& that) const { return code_ == that.code_; }
126  bool operator==(ParseErrorCode code) const { return code_ == code; }
127  friend bool operator==(ParseErrorCode code, const ParseResult & err) { return code == err.code_; }
128 
129  bool operator!=(const ParseResult& that) const { return !(*this == that); }
130  bool operator!=(ParseErrorCode code) const { return !(*this == code); }
131  friend bool operator!=(ParseErrorCode code, const ParseResult & err) { return err != code; }
132 
133  //! Reset error code.
134  void Clear() { Set(kParseErrorNone); }
135  //! Update error code and offset.
136  void Set(ParseErrorCode code, size_t offset = 0) { code_ = code; offset_ = offset; }
137 
138 private:
139  ParseErrorCode code_;
140  size_t offset_;
141 };
142 
143 //! Function pointer type of GetParseError().
144 /*! \ingroup RAPIDJSON_ERRORS
145 
146  This is the prototype for \c GetParseError_X(), where \c X is a locale.
147  User can dynamically change locale in runtime, e.g.:
148 \code
149  GetParseErrorFunc GetParseError = GetParseError_En; // or whatever
150  const RAPIDJSON_ERROR_CHARTYPE* s = GetParseError(document.GetParseErrorCode());
151 \endcode
152 */
153 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetParseErrorFunc)(ParseErrorCode);
154 
155 ///////////////////////////////////////////////////////////////////////////////
156 // ValidateErrorCode
157 
158 //! Error codes when validating.
159 /*! \ingroup RAPIDJSON_ERRORS
160  \see GenericSchemaValidator
161 */
163  kValidateErrors = -1, //!< Top level error code when kValidateContinueOnErrorsFlag set.
164  kValidateErrorNone = 0, //!< No error.
165 
166  kValidateErrorMultipleOf, //!< Number is not a multiple of the 'multipleOf' value.
167  kValidateErrorMaximum, //!< Number is greater than the 'maximum' value.
168  kValidateErrorExclusiveMaximum, //!< Number is greater than or equal to the 'maximum' value.
169  kValidateErrorMinimum, //!< Number is less than the 'minimum' value.
170  kValidateErrorExclusiveMinimum, //!< Number is less than or equal to the 'minimum' value.
171 
172  kValidateErrorMaxLength, //!< String is longer than the 'maxLength' value.
173  kValidateErrorMinLength, //!< String is longer than the 'maxLength' value.
174  kValidateErrorPattern, //!< String does not match the 'pattern' regular expression.
175 
176  kValidateErrorMaxItems, //!< Array is longer than the 'maxItems' value.
177  kValidateErrorMinItems, //!< Array is shorter than the 'minItems' value.
178  kValidateErrorUniqueItems, //!< Array has duplicate items but 'uniqueItems' is true.
179  kValidateErrorAdditionalItems, //!< Array has additional items that are not allowed by the schema.
180 
181  kValidateErrorMaxProperties, //!< Object has more members than 'maxProperties' value.
182  kValidateErrorMinProperties, //!< Object has less members than 'minProperties' value.
183  kValidateErrorRequired, //!< Object is missing one or more members required by the schema.
184  kValidateErrorAdditionalProperties, //!< Object has additional members that are not allowed by the schema.
185  kValidateErrorPatternProperties, //!< See other errors.
186  kValidateErrorDependencies, //!< Object has missing property or schema dependencies.
187 
188  kValidateErrorEnum, //!< Property has a value that is not one of its allowed enumerated values.
189  kValidateErrorType, //!< Property has a type that is not allowed by the schema.
190 
191  kValidateErrorOneOf, //!< Property did not match any of the sub-schemas specified by 'oneOf'.
192  kValidateErrorOneOfMatch, //!< Property matched more than one of the sub-schemas specified by 'oneOf'.
193  kValidateErrorAllOf, //!< Property did not match all of the sub-schemas specified by 'allOf'.
194  kValidateErrorAnyOf, //!< Property did not match any of the sub-schemas specified by 'anyOf'.
195  kValidateErrorNot, //!< Property matched the sub-schema specified by 'not'.
196 
197  kValidateErrorReadOnly, //!< Property is read-only but has been provided when validation is for writing
198  kValidateErrorWriteOnly //!< Property is write-only but has been provided when validation is for reading
199 };
200 
201 //! Function pointer type of GetValidateError().
202 /*! \ingroup RAPIDJSON_ERRORS
203 
204  This is the prototype for \c GetValidateError_X(), where \c X is a locale.
205  User can dynamically change locale in runtime, e.g.:
206 \code
207  GetValidateErrorFunc GetValidateError = GetValidateError_En; // or whatever
208  const RAPIDJSON_ERROR_CHARTYPE* s = GetValidateError(validator.GetInvalidSchemaCode());
209 \endcode
210 */
211 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetValidateErrorFunc)(ValidateErrorCode);
212 
213 ///////////////////////////////////////////////////////////////////////////////
214 // SchemaErrorCode
215 
216 //! Error codes when validating.
217 /*! \ingroup RAPIDJSON_ERRORS
218  \see GenericSchemaValidator
219 */
221  kSchemaErrorNone = 0, //!< No error.
222 
223  kSchemaErrorStartUnknown, //!< Pointer to start of schema does not resolve to a location in the document
224  kSchemaErrorRefPlainName, //!< $ref fragment must be a JSON pointer
225  kSchemaErrorRefInvalid, //!< $ref must not be an empty string
226  kSchemaErrorRefPointerInvalid, //!< $ref fragment is not a valid JSON pointer at offset
227  kSchemaErrorRefUnknown, //!< $ref does not resolve to a location in the target document
228  kSchemaErrorRefCyclical, //!< $ref is cyclical
229  kSchemaErrorRefNoRemoteProvider, //!< $ref is remote but there is no remote provider
230  kSchemaErrorRefNoRemoteSchema, //!< $ref is remote but the remote provider did not return a schema
231  kSchemaErrorRegexInvalid, //!< Invalid regular expression in 'pattern' or 'patternProperties'
232  kSchemaErrorSpecUnknown, //!< JSON schema draft or OpenAPI version is not recognized
233  kSchemaErrorSpecUnsupported, //!< JSON schema draft or OpenAPI version is not supported
234  kSchemaErrorSpecIllegal, //!< Both JSON schema draft and OpenAPI version found in document
235  kSchemaErrorReadOnlyAndWriteOnly //!< Property must not be both 'readOnly' and 'writeOnly'
236 };
237 
238 //! Function pointer type of GetSchemaError().
239 /*! \ingroup RAPIDJSON_ERRORS
240 
241  This is the prototype for \c GetSchemaError_X(), where \c X is a locale.
242  User can dynamically change locale in runtime, e.g.:
243 \code
244  GetSchemaErrorFunc GetSchemaError = GetSchemaError_En; // or whatever
245  const RAPIDJSON_ERROR_CHARTYPE* s = GetSchemaError(validator.GetInvalidSchemaCode());
246 \endcode
247 */
248 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetSchemaErrorFunc)(SchemaErrorCode);
249 
250 ///////////////////////////////////////////////////////////////////////////////
251 // PointerParseErrorCode
252 
253 //! Error code of JSON pointer parsing.
254 /*! \ingroup RAPIDJSON_ERRORS
255  \see GenericPointer::GenericPointer, GenericPointer::GetParseErrorCode
256 */
258  kPointerParseErrorNone = 0, //!< The parse is successful
259 
260  kPointerParseErrorTokenMustBeginWithSolidus, //!< A token must begin with a '/'
261  kPointerParseErrorInvalidEscape, //!< Invalid escape
262  kPointerParseErrorInvalidPercentEncoding, //!< Invalid percent encoding in URI fragment
263  kPointerParseErrorCharacterMustPercentEncode //!< A character must percent encoded in URI fragment
264 };
265 
266 //! Function pointer type of GetPointerParseError().
267 /*! \ingroup RAPIDJSON_ERRORS
268 
269  This is the prototype for \c GetPointerParseError_X(), where \c X is a locale.
270  User can dynamically change locale in runtime, e.g.:
271 \code
272  GetPointerParseErrorFunc GetPointerParseError = GetPointerParseError_En; // or whatever
273  const RAPIDJSON_ERROR_CHARTYPE* s = GetPointerParseError(pointer.GetParseErrorCode());
274 \endcode
275 */
276 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetPointerParseErrorFunc)(PointerParseErrorCode);
277 
278 
279 RAPIDJSON_NAMESPACE_END
280 
281 #ifdef __clang__
282 RAPIDJSON_DIAG_POP
283 #endif
284 
285 #endif // RAPIDJSON_ERROR_ERROR_H_
Invalid escape.
Definition: error.h:261
String does not match the 'pattern' regular expression.
Definition: error.h:174
PointerParseErrorCode
Error code of JSON pointer parsing.
Definition: error.h:257
Number is not a multiple of the 'multipleOf' value.
Definition: error.h:166
Property matched more than one of the sub-schemas specified by 'oneOf'.
Definition: error.h:192
See other errors.
Definition: error.h:185
Invalid value.
Definition: error.h:70
The surrogate pair in string is invalid.
Definition: error.h:79
ParseResult(ParseErrorCode code, size_t offset)
Constructor to set an error.
Definition: error.h:113
Number is greater than or equal to the 'maximum' value.
Definition: error.h:168
Missing a colon after a name of object member.
Definition: error.h:73
Object has more members than 'maxProperties' value.
Definition: error.h:181
Number is greater than the 'maximum' value.
Definition: error.h:167
Incorrect hex digit after \u escape in string.
Definition: error.h:78
Miss fraction part in number.
Definition: error.h:85
The parse is successful.
Definition: error.h:258
A character must percent encoded in URI fragment.
Definition: error.h:263
No error.
Definition: error.h:65
ParseErrorCode
Error code of parsing.
Definition: error.h:64
JSON schema draft or OpenAPI version is not recognized.
Definition: error.h:232
String is longer than the 'maxLength' value.
Definition: error.h:172
$ref fragment is not a valid JSON pointer at offset
Definition: error.h:226
void Clear()
Reset error code.
Definition: error.h:134
$ref does not resolve to a location in the target document
Definition: error.h:227
Missing a comma or ']' after an array element.
Definition: error.h:76
Top level error code when kValidateContinueOnErrorsFlag set.
Definition: error.h:163
The document root must not follow by other values.
Definition: error.h:68
bool IsError() const
Whether the result is an error.
Definition: error.h:123
SchemaErrorCode
Error codes when validating.
Definition: error.h:220
A token must begin with a '/'.
Definition: error.h:260
$ref is remote but there is no remote provider
Definition: error.h:229
JSON schema draft or OpenAPI version is not supported.
Definition: error.h:233
$ref fragment must be a JSON pointer
Definition: error.h:224
Unspecific syntax error.
Definition: error.h:89
Number is less than or equal to the 'minimum' value.
Definition: error.h:170
Property is read-only but has been provided when validation is for writing.
Definition: error.h:197
Missing a closing quotation mark in string.
Definition: error.h:81
Array is longer than the 'maxItems' value.
Definition: error.h:176
Invalid escape character in string.
Definition: error.h:80
#define RAPIDJSON_ERROR_CHARTYPE
Character type of error messages.
Definition: error.h:39
Result of parsing (wraps ParseErrorCode)
Definition: error.h:106
$ref must not be an empty string
Definition: error.h:225
Property matched the sub-schema specified by 'not'.
Definition: error.h:195
Invalid regular expression in 'pattern' or 'patternProperties'.
Definition: error.h:231
Number is less than the 'minimum' value.
Definition: error.h:169
Missing a name for object member.
Definition: error.h:72
Array has duplicate items but 'uniqueItems' is true.
Definition: error.h:178
ValidateErrorCode
Error codes when validating.
Definition: error.h:162
Array has additional items that are not allowed by the schema.
Definition: error.h:179
No error.
Definition: error.h:221
Object has less members than 'minProperties' value.
Definition: error.h:182
ParseErrorCode Code() const
Get the error code.
Definition: error.h:116
Array is shorter than the 'minItems' value.
Definition: error.h:177
$ref is remote but the remote provider did not return a schema
Definition: error.h:230
Property did not match all of the sub-schemas specified by 'allOf'.
Definition: error.h:193
String is longer than the 'maxLength' value.
Definition: error.h:173
Parsing was terminated.
Definition: error.h:88
Property did not match any of the sub-schemas specified by 'anyOf'.
Definition: error.h:194
$ref is cyclical
Definition: error.h:228
Number too big to be stored in double.
Definition: error.h:84
Property has a value that is not one of its allowed enumerated values.
Definition: error.h:188
Miss exponent in number.
Definition: error.h:86
No error.
Definition: error.h:164
Object has missing property or schema dependencies.
Definition: error.h:186
Object is missing one or more members required by the schema.
Definition: error.h:183
Property is write-only but has been provided when validation is for reading.
Definition: error.h:198
ParseResult()
Default constructor, no error.
Definition: error.h:111
Pointer to start of schema does not resolve to a location in the document.
Definition: error.h:223
Both JSON schema draft and OpenAPI version found in document.
Definition: error.h:234
Property must not be both 'readOnly' and 'writeOnly'.
Definition: error.h:235
Invalid percent encoding in URI fragment.
Definition: error.h:262
The document is empty.
Definition: error.h:67
Missing a comma or '}' after an object member.
Definition: error.h:74
Invalid encoding in string.
Definition: error.h:82
size_t Offset() const
Get the error offset, if IsError(), 0 otherwise.
Definition: error.h:118
Property did not match any of the sub-schemas specified by 'oneOf'.
Definition: error.h:191
Property has a type that is not allowed by the schema.
Definition: error.h:189
Object has additional members that are not allowed by the schema.
Definition: error.h:184
void Set(ParseErrorCode code, size_t offset=0)
Update error code and offset.
Definition: error.h:136