/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-composable-kernel/checkouts/develop/include/rapidjson/error/error.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-composable-kernel/checkouts/develop/include/rapidjson/error/error.h Source File#

Composable Kernel: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-composable-kernel/checkouts/develop/include/rapidjson/error/error.h Source File
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 
30 // RAPIDJSON_ERROR_CHARTYPE
31 
33 
38 #ifndef RAPIDJSON_ERROR_CHARTYPE
39 #define RAPIDJSON_ERROR_CHARTYPE char
40 #endif
41 
43 // RAPIDJSON_ERROR_STRING
44 
46 
51 #ifndef RAPIDJSON_ERROR_STRING
52 #define RAPIDJSON_ERROR_STRING(x) x
53 #endif
54 
56 
58 // ParseErrorCode
59 
61 
66 
69 
71 
75 
77 
83 
87 
90 };
91 
93 
106 struct ParseResult {
108  typedef bool (ParseResult::*BooleanType)() const;
109 public:
111  ParseResult() : code_(kParseErrorNone), offset_(0) {}
113  ParseResult(ParseErrorCode code, size_t offset) : code_(code), offset_(offset) {}
114 
116  ParseErrorCode Code() const { return code_; }
118  size_t Offset() const { return offset_; }
119 
121  operator BooleanType() const { return !IsError() ? &ParseResult::IsError : NULL; }
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 
134  void Clear() { Set(kParseErrorNone); }
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 
144 
153 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetParseErrorFunc)(ParseErrorCode);
154 
156 // ValidateErrorCode
157 
159 
165 
171 
175 
180 
187 
190 
196 
199 };
200 
202 
211 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetValidateErrorFunc)(ValidateErrorCode);
212 
214 // SchemaErrorCode
215 
217 
222 
236 };
237 
239 
248 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetSchemaErrorFunc)(SchemaErrorCode);
249 
251 // PointerParseErrorCode
252 
254 
259 
264 };
265 
267 
276 typedef const RAPIDJSON_ERROR_CHARTYPE* (*GetPointerParseErrorFunc)(PointerParseErrorCode);
277 
278 
280 
281 #ifdef __clang__
282 RAPIDJSON_DIAG_POP
283 #endif
284 
285 #endif // RAPIDJSON_ERROR_ERROR_H_
#define RAPIDJSON_NAMESPACE_BEGIN
provide custom rapidjson namespace (opening expression)
Definition: rapidjson.h:121
#define RAPIDJSON_NAMESPACE_END
provide custom rapidjson namespace (closing expression)
Definition: rapidjson.h:124
ValidateErrorCode
Error codes when validating.
Definition: error.h:162
SchemaErrorCode
Error codes when validating.
Definition: error.h:220
#define RAPIDJSON_ERROR_CHARTYPE
Character type of error messages.
Definition: error.h:39
ParseErrorCode
Error code of parsing.
Definition: error.h:64
PointerParseErrorCode
Error code of JSON pointer parsing.
Definition: error.h:257
@ kValidateErrorMinProperties
Object has less members than 'minProperties' value.
Definition: error.h:182
@ kValidateErrorExclusiveMinimum
Number is less than or equal to the 'minimum' value.
Definition: error.h:170
@ kValidateErrorAdditionalItems
Array has additional items that are not allowed by the schema.
Definition: error.h:179
@ kValidateErrorMaxProperties
Object has more members than 'maxProperties' value.
Definition: error.h:181
@ kValidateErrorOneOfMatch
Property matched more than one of the sub-schemas specified by 'oneOf'.
Definition: error.h:192
@ kValidateErrorRequired
Object is missing one or more members required by the schema.
Definition: error.h:183
@ kValidateErrorDependencies
Object has missing property or schema dependencies.
Definition: error.h:186
@ kValidateErrorUniqueItems
Array has duplicate items but 'uniqueItems' is true.
Definition: error.h:178
@ kValidateErrorReadOnly
Property is read-only but has been provided when validation is for writing.
Definition: error.h:197
@ kValidateErrorEnum
Property has a value that is not one of its allowed enumerated values.
Definition: error.h:188
@ kValidateErrorExclusiveMaximum
Number is greater than or equal to the 'maximum' value.
Definition: error.h:168
@ kValidateErrorType
Property has a type that is not allowed by the schema.
Definition: error.h:189
@ kValidateErrorOneOf
Property did not match any of the sub-schemas specified by 'oneOf'.
Definition: error.h:191
@ kValidateErrorMinLength
String is longer than the 'maxLength' value.
Definition: error.h:173
@ kValidateErrors
Top level error code when kValidateContinueOnErrorsFlag set.
Definition: error.h:163
@ kValidateErrorMaxLength
String is longer than the 'maxLength' value.
Definition: error.h:172
@ kValidateErrorWriteOnly
Property is write-only but has been provided when validation is for reading.
Definition: error.h:198
@ kValidateErrorAnyOf
Property did not match any of the sub-schemas specified by 'anyOf'.
Definition: error.h:194
@ kValidateErrorPattern
String does not match the 'pattern' regular expression.
Definition: error.h:174
@ kValidateErrorMaximum
Number is greater than the 'maximum' value.
Definition: error.h:167
@ kValidateErrorMaxItems
Array is longer than the 'maxItems' value.
Definition: error.h:176
@ kValidateErrorMinimum
Number is less than the 'minimum' value.
Definition: error.h:169
@ kValidateErrorMultipleOf
Number is not a multiple of the 'multipleOf' value.
Definition: error.h:166
@ kValidateErrorNone
No error.
Definition: error.h:164
@ kValidateErrorMinItems
Array is shorter than the 'minItems' value.
Definition: error.h:177
@ kValidateErrorNot
Property matched the sub-schema specified by 'not'.
Definition: error.h:195
@ kValidateErrorAdditionalProperties
Object has additional members that are not allowed by the schema.
Definition: error.h:184
@ kValidateErrorPatternProperties
See other errors.
Definition: error.h:185
@ kValidateErrorAllOf
Property did not match all of the sub-schemas specified by 'allOf'.
Definition: error.h:193
@ kSchemaErrorStartUnknown
Pointer to start of schema does not resolve to a location in the document.
Definition: error.h:223
@ kSchemaErrorSpecIllegal
Both JSON schema draft and OpenAPI version found in document.
Definition: error.h:234
@ kSchemaErrorSpecUnsupported
JSON schema draft or OpenAPI version is not supported.
Definition: error.h:233
@ kSchemaErrorRefPlainName
$ref fragment must be a JSON pointer
Definition: error.h:224
@ kSchemaErrorRefNoRemoteProvider
$ref is remote but there is no remote provider
Definition: error.h:229
@ kSchemaErrorSpecUnknown
JSON schema draft or OpenAPI version is not recognized.
Definition: error.h:232
@ kSchemaErrorRefUnknown
$ref does not resolve to a location in the target document
Definition: error.h:227
@ kSchemaErrorNone
No error.
Definition: error.h:221
@ kSchemaErrorRefPointerInvalid
$ref fragment is not a valid JSON pointer at offset
Definition: error.h:226
@ kSchemaErrorRefNoRemoteSchema
$ref is remote but the remote provider did not return a schema
Definition: error.h:230
@ kSchemaErrorRefCyclical
$ref is cyclical
Definition: error.h:228
@ kSchemaErrorRefInvalid
$ref must not be an empty string
Definition: error.h:225
@ kSchemaErrorRegexInvalid
Invalid regular expression in 'pattern' or 'patternProperties'.
Definition: error.h:231
@ kSchemaErrorReadOnlyAndWriteOnly
Property must not be both 'readOnly' and 'writeOnly'.
Definition: error.h:235
@ kParseErrorDocumentEmpty
The document is empty.
Definition: error.h:67
@ kParseErrorNumberMissFraction
Miss fraction part in number.
Definition: error.h:85
@ kParseErrorStringInvalidEncoding
Invalid encoding in string.
Definition: error.h:82
@ kParseErrorValueInvalid
Invalid value.
Definition: error.h:70
@ kParseErrorDocumentRootNotSingular
The document root must not follow by other values.
Definition: error.h:68
@ kParseErrorUnspecificSyntaxError
Unspecific syntax error.
Definition: error.h:89
@ kParseErrorObjectMissCommaOrCurlyBracket
Missing a comma or '}' after an object member.
Definition: error.h:74
@ kParseErrorObjectMissColon
Missing a colon after a name of object member.
Definition: error.h:73
@ kParseErrorStringMissQuotationMark
Missing a closing quotation mark in string.
Definition: error.h:81
@ kParseErrorTermination
Parsing was terminated.
Definition: error.h:88
@ kParseErrorNumberMissExponent
Miss exponent in number.
Definition: error.h:86
@ kParseErrorStringEscapeInvalid
Invalid escape character in string.
Definition: error.h:80
@ kParseErrorArrayMissCommaOrSquareBracket
Missing a comma or ']' after an array element.
Definition: error.h:76
@ kParseErrorNone
No error.
Definition: error.h:65
@ kParseErrorStringUnicodeSurrogateInvalid
The surrogate pair in string is invalid.
Definition: error.h:79
@ kParseErrorObjectMissName
Missing a name for object member.
Definition: error.h:72
@ kParseErrorNumberTooBig
Number too big to be stored in double.
Definition: error.h:84
@ kParseErrorStringUnicodeEscapeInvalidHex
Incorrect hex digit after \u escape in string.
Definition: error.h:78
@ kPointerParseErrorInvalidEscape
Invalid escape.
Definition: error.h:261
@ kPointerParseErrorTokenMustBeginWithSolidus
A token must begin with a '/'.
Definition: error.h:260
@ kPointerParseErrorNone
The parse is successful.
Definition: error.h:258
@ kPointerParseErrorCharacterMustPercentEncode
A character must percent encoded in URI fragment.
Definition: error.h:263
@ kPointerParseErrorInvalidPercentEncoding
Invalid percent encoding in URI fragment.
Definition: error.h:262
Result of parsing (wraps ParseErrorCode)
Definition: error.h:106
friend bool operator!=(ParseErrorCode code, const ParseResult &err)
Definition: error.h:131
ParseErrorCode Code() const
Get the error code.
Definition: error.h:116
ParseResult(ParseErrorCode code, size_t offset)
Constructor to set an error.
Definition: error.h:113
bool operator==(const ParseResult &that) const
Definition: error.h:125
friend bool operator==(ParseErrorCode code, const ParseResult &err)
Definition: error.h:127
bool operator==(ParseErrorCode code) const
Definition: error.h:126
void Clear()
Reset error code.
Definition: error.h:134
bool(ParseResult::* BooleanType)() const
! Unspecified boolean type
Definition: error.h:108
bool operator!=(const ParseResult &that) const
Definition: error.h:129
void Set(ParseErrorCode code, size_t offset=0)
Update error code and offset.
Definition: error.h:136
ParseResult()
Default constructor, no error.
Definition: error.h:111
bool IsError() const
Whether the result is an error.
Definition: error.h:123
size_t Offset() const
Get the error offset, if IsError(), 0 otherwise.
Definition: error.h:118
bool operator!=(ParseErrorCode code) const
Definition: error.h:130