载入中...
搜索中...
未找到
error.h
浏览该文件的文档.
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__
21RAPIDJSON_DIAG_PUSH
22RAPIDJSON_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
55RAPIDJSON_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*/
107 //!! Unspecified boolean type
108 typedef bool (ParseResult::*BooleanType)() const;
109public:
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.
135 //! Update error code and offset.
136 void Set(ParseErrorCode code, size_t offset = 0) { code_ = code; offset_ = offset; }
137
138private:
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*/
153typedef 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*/
211typedef 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*/
248typedef 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 '/'
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*/
276typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetPointerParseErrorFunc)(PointerParseErrorCode);
277
278
279RAPIDJSON_NAMESPACE_END
280
281#ifdef __clang__
282RAPIDJSON_DIAG_POP
283#endif
284
285#endif // RAPIDJSON_ERROR_ERROR_H_
ParseResult()
Default constructor, no error.
定义 error.h:111
void Clear()
Reset error code.
定义 error.h:134
ParseErrorCode Code() const
Get the error code.
定义 error.h:116
void Set(ParseErrorCode code, size_t offset=0)
Update error code and offset.
定义 error.h:136
size_t Offset() const
Get the error offset, if IsError(), 0 otherwise.
定义 error.h:118
bool IsError() const
Whether the result is an error.
定义 error.h:123
ParseResult(ParseErrorCode code, size_t offset)
Constructor to set an error.
定义 error.h:113
bool(ParseResult::* BooleanType)() const
! Unspecified boolean type
定义 error.h:108
ValidateErrorCode
Error codes when validating.
定义 error.h:162
ParseErrorCode
Error code of parsing.
定义 error.h:64
#define RAPIDJSON_ERROR_CHARTYPE
Character type of error messages.
定义 error.h:39
SchemaErrorCode
Error codes when validating.
定义 error.h:220
PointerParseErrorCode
Error code of JSON pointer parsing.
定义 error.h:257
@ kValidateErrors
Top level error code when kValidateContinueOnErrorsFlag set.
定义 error.h:163
@ kValidateErrorMaxItems
Array is longer than the 'maxItems' value.
定义 error.h:176
@ kValidateErrorRequired
Object is missing one or more members required by the schema.
定义 error.h:183
@ kValidateErrorMinProperties
Object has less members than 'minProperties' value.
定义 error.h:182
@ kValidateErrorMaximum
Number is greater than the 'maximum' value.
定义 error.h:167
@ kValidateErrorAdditionalProperties
Object has additional members that are not allowed by the schema.
定义 error.h:184
@ kValidateErrorNone
No error.
定义 error.h:164
@ kValidateErrorOneOf
Property did not match any of the sub-schemas specified by 'oneOf'.
定义 error.h:191
@ kValidateErrorEnum
Property has a value that is not one of its allowed enumerated values.
定义 error.h:188
@ kValidateErrorMaxLength
String is longer than the 'maxLength' value.
定义 error.h:172
@ kValidateErrorType
Property has a type that is not allowed by the schema.
定义 error.h:189
@ kValidateErrorMaxProperties
Object has more members than 'maxProperties' value.
定义 error.h:181
@ kValidateErrorNot
Property matched the sub-schema specified by 'not'.
定义 error.h:195
@ kValidateErrorExclusiveMinimum
Number is less than or equal to the 'minimum' value.
定义 error.h:170
@ kValidateErrorExclusiveMaximum
Number is greater than or equal to the 'maximum' value.
定义 error.h:168
@ kValidateErrorMultipleOf
Number is not a multiple of the 'multipleOf' value.
定义 error.h:166
@ kValidateErrorAnyOf
Property did not match any of the sub-schemas specified by 'anyOf'.
定义 error.h:194
@ kValidateErrorReadOnly
Property is read-only but has been provided when validation is for writing
定义 error.h:197
@ kValidateErrorWriteOnly
Property is write-only but has been provided when validation is for reading
定义 error.h:198
@ kValidateErrorAdditionalItems
Array has additional items that are not allowed by the schema.
定义 error.h:179
@ kValidateErrorPatternProperties
See other errors.
定义 error.h:185
@ kValidateErrorMinLength
String is longer than the 'maxLength' value.
定义 error.h:173
@ kValidateErrorMinimum
Number is less than the 'minimum' value.
定义 error.h:169
@ kValidateErrorDependencies
Object has missing property or schema dependencies.
定义 error.h:186
@ kValidateErrorMinItems
Array is shorter than the 'minItems' value.
定义 error.h:177
@ kValidateErrorOneOfMatch
Property matched more than one of the sub-schemas specified by 'oneOf'.
定义 error.h:192
@ kValidateErrorUniqueItems
Array has duplicate items but 'uniqueItems' is true.
定义 error.h:178
@ kValidateErrorPattern
String does not match the 'pattern' regular expression.
定义 error.h:174
@ kValidateErrorAllOf
Property did not match all of the sub-schemas specified by 'allOf'.
定义 error.h:193
@ kParseErrorDocumentEmpty
The document is empty.
定义 error.h:67
@ kParseErrorArrayMissCommaOrSquareBracket
Missing a comma or ']' after an array element.
定义 error.h:76
@ kParseErrorDocumentRootNotSingular
The document root must not follow by other values.
定义 error.h:68
@ kParseErrorStringUnicodeEscapeInvalidHex
Incorrect hex digit after \u escape in string.
定义 error.h:78
@ kParseErrorNumberTooBig
Number too big to be stored in double.
定义 error.h:84
@ kParseErrorNumberMissExponent
Miss exponent in number.
定义 error.h:86
@ kParseErrorObjectMissCommaOrCurlyBracket
Missing a comma or '}' after an object member.
定义 error.h:74
@ kParseErrorObjectMissColon
Missing a colon after a name of object member.
定义 error.h:73
@ kParseErrorStringInvalidEncoding
Invalid encoding in string.
定义 error.h:82
@ kParseErrorStringUnicodeSurrogateInvalid
The surrogate pair in string is invalid.
定义 error.h:79
@ kParseErrorUnspecificSyntaxError
Unspecific syntax error.
定义 error.h:89
@ kParseErrorNone
No error.
定义 error.h:65
@ kParseErrorStringEscapeInvalid
Invalid escape character in string.
定义 error.h:80
@ kParseErrorTermination
Parsing was terminated.
定义 error.h:88
@ kParseErrorObjectMissName
Missing a name for object member.
定义 error.h:72
@ kParseErrorValueInvalid
Invalid value.
定义 error.h:70
@ kParseErrorNumberMissFraction
Miss fraction part in number.
定义 error.h:85
@ kParseErrorStringMissQuotationMark
Missing a closing quotation mark in string.
定义 error.h:81
@ kSchemaErrorRefInvalid
$ref must not be an empty string
定义 error.h:225
@ kSchemaErrorRefNoRemoteSchema
$ref is remote but the remote provider did not return a schema
定义 error.h:230
@ kSchemaErrorRefPointerInvalid
$ref fragment is not a valid JSON pointer at offset
定义 error.h:226
@ kSchemaErrorSpecIllegal
Both JSON schema draft and OpenAPI version found in document
定义 error.h:234
@ kSchemaErrorReadOnlyAndWriteOnly
Property must not be both 'readOnly' and 'writeOnly'
定义 error.h:235
@ kSchemaErrorRefNoRemoteProvider
$ref is remote but there is no remote provider
定义 error.h:229
@ kSchemaErrorSpecUnsupported
JSON schema draft or OpenAPI version is not supported
定义 error.h:233
@ kSchemaErrorRefCyclical
$ref is cyclical
定义 error.h:228
@ kSchemaErrorRegexInvalid
Invalid regular expression in 'pattern' or 'patternProperties'
定义 error.h:231
@ kSchemaErrorRefUnknown
$ref does not resolve to a location in the target document
定义 error.h:227
@ kSchemaErrorSpecUnknown
JSON schema draft or OpenAPI version is not recognized
定义 error.h:232
@ kSchemaErrorStartUnknown
Pointer to start of schema does not resolve to a location in the document
定义 error.h:223
@ kSchemaErrorNone
No error.
定义 error.h:221
@ kSchemaErrorRefPlainName
$ref fragment must be a JSON pointer
定义 error.h:224
@ kPointerParseErrorInvalidPercentEncoding
Invalid percent encoding in URI fragment
定义 error.h:262
@ kPointerParseErrorTokenMustBeginWithSolidus
A token must begin with a '/'
定义 error.h:260
@ kPointerParseErrorInvalidEscape
Invalid escape
定义 error.h:261
@ kPointerParseErrorNone
The parse is successful
定义 error.h:258
@ kPointerParseErrorCharacterMustPercentEncode
A character must percent encoded in URI fragment
定义 error.h:263
Result of parsing (wraps ParseErrorCode)
定义 error.h:106
common definitions and configuration