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__
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 */
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 
198 //! Function pointer type of GetValidateError().
199 /*! \ingroup RAPIDJSON_ERRORS
200 
201  This is the prototype for \c GetValidateError_X(), where \c X is a locale.
202  User can dynamically change locale in runtime, e.g.:
203 \code
204  GetValidateErrorFunc GetValidateError = GetValidateError_En; // or whatever
205  const RAPIDJSON_ERROR_CHARTYPE* s = GetValidateError(validator.GetInvalidSchemaCode());
206 \endcode
207 */
208 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetValidateErrorFunc)(ValidateErrorCode);
209 
210 RAPIDJSON_NAMESPACE_END
211 
212 #ifdef __clang__
213 RAPIDJSON_DIAG_POP
214 #endif
215 
216 #endif // RAPIDJSON_ERROR_ERROR_H_
rapidjson::ParseResult
Result of parsing (wraps ParseErrorCode)
Definition: error.h:106
rapidjson::kParseErrorUnspecificSyntaxError
Unspecific syntax error.
Definition: error.h:89
rapidjson::kValidateErrorMaxItems
Array is longer than the 'maxItems' value.
Definition: error.h:176
rapidjson::kParseErrorDocumentRootNotSingular
The document root must not follow by other values.
Definition: error.h:68
rapidjson::kValidateErrorExclusiveMaximum
Number is greater than or equal to the 'maximum' value.
Definition: error.h:168
rapidjson::kParseErrorObjectMissCommaOrCurlyBracket
Missing a comma or '}' after an object member.
Definition: error.h:74
rapidjson::kValidateErrorRequired
Object is missing one or more members required by the schema.
Definition: error.h:183
rapidjson::kParseErrorStringMissQuotationMark
Missing a closing quotation mark in string.
Definition: error.h:81
rapidjson::kValidateErrorOneOf
Property did not match any of the sub-schemas specified by 'oneOf'.
Definition: error.h:191
rapidjson::ParseResult::Offset
size_t Offset() const
Get the error offset, if IsError(), 0 otherwise.
Definition: error.h:118
rapidjson::ParseResult::Code
ParseErrorCode Code() const
Get the error code.
Definition: error.h:116
rapidjson::kParseErrorObjectMissName
Missing a name for object member.
Definition: error.h:72
rapidjson::ParseResult::ParseResult
ParseResult(ParseErrorCode code, size_t offset)
Constructor to set an error.
Definition: error.h:113
rapidjson::kValidateErrorOneOfMatch
Property matched more than one of the sub-schemas specified by 'oneOf'.
Definition: error.h:192
rapidjson::kParseErrorStringInvalidEncoding
Invalid encoding in string.
Definition: error.h:82
rapidjson::kValidateErrorExclusiveMinimum
Number is less than or equal to the 'minimum' value.
Definition: error.h:170
rapidjson::kValidateErrorEnum
Property has a value that is not one of its allowed enumerated values
Definition: error.h:188
rapidjson::ParseErrorCode
ParseErrorCode
Error code of parsing.
Definition: error.h:64
rapidjson::kValidateErrorAdditionalProperties
Object has additional members that are not allowed by the schema.
Definition: error.h:184
rapidjson::kParseErrorStringUnicodeSurrogateInvalid
The surrogate pair in string is invalid.
Definition: error.h:79
rapidjson::kValidateErrorMaxProperties
Object has more members than 'maxProperties' value.
Definition: error.h:181
rapidjson::kValidateErrorMinProperties
Object has less members than 'minProperties' value.
Definition: error.h:182
rapidjson::kParseErrorDocumentEmpty
The document is empty.
Definition: error.h:67
rapidjson::kValidateErrorNot
Property matched the sub-schema specified by 'not'.
Definition: error.h:195
rapidjson::kValidateErrorPatternProperties
See other errors.
Definition: error.h:185
rapidjson::kValidateErrorType
Property has a type that is not allowed by the schema..
Definition: error.h:189
rapidjson::kParseErrorNumberTooBig
Number too big to be stored in double.
Definition: error.h:84
RAPIDJSON_ERROR_CHARTYPE
#define RAPIDJSON_ERROR_CHARTYPE
Character type of error messages.
Definition: error.h:39
rapidjson::kValidateErrorPattern
String does not match the 'pattern' regular expression.
Definition: error.h:174
rapidjson::ParseResult::Clear
void Clear()
Reset error code.
Definition: error.h:134
rapidjson::kParseErrorTermination
Parsing was terminated.
Definition: error.h:88
rapidjson::kParseErrorArrayMissCommaOrSquareBracket
Missing a comma or ']' after an array element.
Definition: error.h:76
rapidjson::kValidateErrorAllOf
Property did not match all of the sub-schemas specified by 'allOf'.
Definition: error.h:193
rapidjson::ValidateErrorCode
ValidateErrorCode
Error codes when validating.
Definition: error.h:162
rapidjson::kValidateErrorAnyOf
Property did not match any of the sub-schemas specified by 'anyOf'.
Definition: error.h:194
rapidjson::ParseResult::IsError
bool IsError() const
Whether the result is an error.
Definition: error.h:123
rapidjson::kParseErrorNumberMissFraction
Miss fraction part in number.
Definition: error.h:85
rapidjson::kValidateErrorMinItems
Array is shorter than the 'minItems' value.
Definition: error.h:177
rapidjson::kValidateErrorNone
No error.
Definition: error.h:164
rapidjson::kValidateErrorMinimum
Number is less than the 'minimum' value.
Definition: error.h:169
rapidjson::kValidateErrorMultipleOf
Number is not a multiple of the 'multipleOf' value.
Definition: error.h:166
rapidjson::kValidateErrorMaximum
Number is greater than the 'maximum' value.
Definition: error.h:167
rapidjson::kParseErrorNumberMissExponent
Miss exponent in number.
Definition: error.h:86
rapidjson::kValidateErrorDependencies
Object has missing property or schema dependencies.
Definition: error.h:186
rapidjson::kParseErrorNone
No error.
Definition: error.h:65
rapidjson::kValidateErrorMinLength
String is longer than the 'maxLength' value.
Definition: error.h:173
rapidjson::kParseErrorStringEscapeInvalid
Invalid escape character in string.
Definition: error.h:80
rapidjson::kValidateErrorAdditionalItems
Array has additional items that are not allowed by the schema.
Definition: error.h:179
rapidjson::kValidateErrorUniqueItems
Array has duplicate items but 'uniqueItems' is true.
Definition: error.h:178
rapidjson::kParseErrorValueInvalid
Invalid value.
Definition: error.h:70
rapidjson::ParseResult::ParseResult
ParseResult()
Default constructor, no error.
Definition: error.h:111
rapidjson::kValidateErrors
Top level error code when kValidateContinueOnErrorsFlag set.
Definition: error.h:163
rapidjson::kValidateErrorMaxLength
String is longer than the 'maxLength' value.
Definition: error.h:172
rapidjson::kParseErrorObjectMissColon
Missing a colon after a name of object member.
Definition: error.h:73
rapidjson::ParseResult::Set
void Set(ParseErrorCode code, size_t offset=0)
Update error code and offset.
Definition: error.h:136
rapidjson::kParseErrorStringUnicodeEscapeInvalidHex
Incorrect hex digit after \u escape in string.
Definition: error.h:78