1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  *   https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  *   Redistribution and use in source and binary forms, with or
10  *   without modification, are permitted provided that the following
11  *   conditions are met:
12  *   * Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer.
14  *   * Redistributions in binary form must reproduce the above
15  *     copyright notice, this list of conditions and the following
16  *     disclaimer in the documentation and/or other materials provided
17  *     with the distribution.
18  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  *   POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_UTILS_MJCF_DETAIL_ERROR_HPP_
34 #define DART_UTILS_MJCF_DETAIL_ERROR_HPP_
35 
36 #include <string>
37 #include <vector>
38 
39 namespace dart {
40 namespace utils {
41 namespace MjcfParser {
42 namespace detail {
43 
44 enum class ErrorCode
45 {
46   NONE = 0,
47 
48   FILE_READ,
49 
50   DUPLICATE_NAME,
51 
52   ATTRIBUTE_MISSING,
53 
54   ATTRIBUTE_INVALID,
55 
56   ATTRIBUTE_DEPRECATED,
57 
58   ATTRIBUTE_CONFLICT,
59 
60   ELEMENT_MISSING,
61 
62   ELEMENT_INVALID,
63 
64   INCORRECT_ELEMENT_TYPE,
65 
66   UNDEFINED_ERROR,
67 };
68 
69 class Error final
70 {
71 public:
72   Error() = default;
73   Error(ErrorCode code, const std::string& message);
74 
75   explicit operator bool() const;
76 
77   ErrorCode getCode() const;
78   const std::string& getMessage() const;
79 
80 private:
81   ErrorCode mCode{ErrorCode::NONE};
82   std::string mMessage{""};
83 };
84 
85 using Errors = std::vector<Error>;
86 
87 } // namespace detail
88 } // namespace MjcfParser
89 } // namespace utils
90 } // namespace dart
91 
92 #endif // #ifndef DART_UTILS_MJCF_DETAIL_ERROR_HPP_
93