Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceCore/system_error.hpp@7:9cd16581b578, 2019-07-22 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Jul 22 11:44:07 2019 -0500
Revision:
7:9cd16581b578
Child:
8:5ea891c7d1a1
Updated to version 1.9.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 7:9cd16581b578 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 7:9cd16581b578 33 /// @file
IanBenzMaxim 7:9cd16581b578 34 /// @brief
IanBenzMaxim 7:9cd16581b578 35 /// Error handling constructs similar to std::error_code, std::error_condition,
IanBenzMaxim 7:9cd16581b578 36 /// and std::error_category.
IanBenzMaxim 7:9cd16581b578 37
IanBenzMaxim 7:9cd16581b578 38 #ifndef MaximInterfaceCore_system_error
IanBenzMaxim 7:9cd16581b578 39 #define MaximInterfaceCore_system_error
IanBenzMaxim 7:9cd16581b578 40
IanBenzMaxim 7:9cd16581b578 41 #include <stdexcept>
IanBenzMaxim 7:9cd16581b578 42 #include <string>
IanBenzMaxim 7:9cd16581b578 43 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 44 #include "SafeBool.hpp"
IanBenzMaxim 7:9cd16581b578 45 #include "Uncopyable.hpp"
IanBenzMaxim 7:9cd16581b578 46
IanBenzMaxim 7:9cd16581b578 47 namespace MaximInterfaceCore {
IanBenzMaxim 7:9cd16581b578 48
IanBenzMaxim 7:9cd16581b578 49 class error_condition;
IanBenzMaxim 7:9cd16581b578 50 class error_code;
IanBenzMaxim 7:9cd16581b578 51
IanBenzMaxim 7:9cd16581b578 52 class error_category : private Uncopyable {
IanBenzMaxim 7:9cd16581b578 53 public:
IanBenzMaxim 7:9cd16581b578 54 virtual ~error_category() {}
IanBenzMaxim 7:9cd16581b578 55
IanBenzMaxim 7:9cd16581b578 56 virtual const char * name() const = 0;
IanBenzMaxim 7:9cd16581b578 57
IanBenzMaxim 7:9cd16581b578 58 MaximInterfaceCore_EXPORT virtual error_condition
IanBenzMaxim 7:9cd16581b578 59 default_error_condition(int code) const;
IanBenzMaxim 7:9cd16581b578 60
IanBenzMaxim 7:9cd16581b578 61 MaximInterfaceCore_EXPORT virtual bool
IanBenzMaxim 7:9cd16581b578 62 equivalent(int code, const error_condition & condition) const;
IanBenzMaxim 7:9cd16581b578 63
IanBenzMaxim 7:9cd16581b578 64 MaximInterfaceCore_EXPORT virtual bool equivalent(const error_code & code,
IanBenzMaxim 7:9cd16581b578 65 int condition) const;
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 7:9cd16581b578 67 virtual std::string message(int condition) const = 0;
IanBenzMaxim 7:9cd16581b578 68 };
IanBenzMaxim 7:9cd16581b578 69
IanBenzMaxim 7:9cd16581b578 70 inline bool operator==(const error_category & lhs, const error_category & rhs) {
IanBenzMaxim 7:9cd16581b578 71 return &lhs == &rhs;
IanBenzMaxim 7:9cd16581b578 72 }
IanBenzMaxim 7:9cd16581b578 73
IanBenzMaxim 7:9cd16581b578 74 inline bool operator!=(const error_category & lhs, const error_category & rhs) {
IanBenzMaxim 7:9cd16581b578 75 return !operator==(lhs, rhs);
IanBenzMaxim 7:9cd16581b578 76 }
IanBenzMaxim 7:9cd16581b578 77
IanBenzMaxim 7:9cd16581b578 78 inline bool operator<(const error_category & lhs, const error_category & rhs) {
IanBenzMaxim 7:9cd16581b578 79 return &lhs < &rhs;
IanBenzMaxim 7:9cd16581b578 80 }
IanBenzMaxim 7:9cd16581b578 81
IanBenzMaxim 7:9cd16581b578 82 MaximInterfaceCore_EXPORT const error_category & system_category();
IanBenzMaxim 7:9cd16581b578 83
IanBenzMaxim 7:9cd16581b578 84 class error_condition {
IanBenzMaxim 7:9cd16581b578 85 public:
IanBenzMaxim 7:9cd16581b578 86 error_condition() : value_(0), category_(&system_category()) {}
IanBenzMaxim 7:9cd16581b578 87
IanBenzMaxim 7:9cd16581b578 88 error_condition(int value, const error_category & category)
IanBenzMaxim 7:9cd16581b578 89 : value_(value), category_(&category) {}
IanBenzMaxim 7:9cd16581b578 90
IanBenzMaxim 7:9cd16581b578 91 void assign(int value, const error_category & category) {
IanBenzMaxim 7:9cd16581b578 92 value_ = value;
IanBenzMaxim 7:9cd16581b578 93 category_ = &category;
IanBenzMaxim 7:9cd16581b578 94 }
IanBenzMaxim 7:9cd16581b578 95
IanBenzMaxim 7:9cd16581b578 96 void clear() {
IanBenzMaxim 7:9cd16581b578 97 value_ = 0;
IanBenzMaxim 7:9cd16581b578 98 category_ = &system_category();
IanBenzMaxim 7:9cd16581b578 99 }
IanBenzMaxim 7:9cd16581b578 100
IanBenzMaxim 7:9cd16581b578 101 int value() const { return value_; }
IanBenzMaxim 7:9cd16581b578 102
IanBenzMaxim 7:9cd16581b578 103 const error_category & category() const { return *category_; }
IanBenzMaxim 7:9cd16581b578 104
IanBenzMaxim 7:9cd16581b578 105 std::string message() const { return category().message(value()); }
IanBenzMaxim 7:9cd16581b578 106
IanBenzMaxim 7:9cd16581b578 107 operator SafeBool() const { return makeSafeBool(value() != 0); }
IanBenzMaxim 7:9cd16581b578 108
IanBenzMaxim 7:9cd16581b578 109 private:
IanBenzMaxim 7:9cd16581b578 110 int value_;
IanBenzMaxim 7:9cd16581b578 111 const error_category * category_;
IanBenzMaxim 7:9cd16581b578 112 };
IanBenzMaxim 7:9cd16581b578 113
IanBenzMaxim 7:9cd16581b578 114 inline bool operator==(const error_condition & lhs,
IanBenzMaxim 7:9cd16581b578 115 const error_condition & rhs) {
IanBenzMaxim 7:9cd16581b578 116 return (lhs.value() == rhs.value()) && (lhs.category() == rhs.category());
IanBenzMaxim 7:9cd16581b578 117 }
IanBenzMaxim 7:9cd16581b578 118
IanBenzMaxim 7:9cd16581b578 119 inline bool operator!=(const error_condition & lhs,
IanBenzMaxim 7:9cd16581b578 120 const error_condition & rhs) {
IanBenzMaxim 7:9cd16581b578 121 return !operator==(lhs, rhs);
IanBenzMaxim 7:9cd16581b578 122 }
IanBenzMaxim 7:9cd16581b578 123
IanBenzMaxim 7:9cd16581b578 124 inline bool operator<(const error_condition & lhs,
IanBenzMaxim 7:9cd16581b578 125 const error_condition & rhs) {
IanBenzMaxim 7:9cd16581b578 126 return (lhs.category() < rhs.category()) ||
IanBenzMaxim 7:9cd16581b578 127 ((lhs.category() == rhs.category()) && (lhs.value() < rhs.value()));
IanBenzMaxim 7:9cd16581b578 128 }
IanBenzMaxim 7:9cd16581b578 129
IanBenzMaxim 7:9cd16581b578 130 class error_code {
IanBenzMaxim 7:9cd16581b578 131 public:
IanBenzMaxim 7:9cd16581b578 132 error_code() : value_(0), category_(&system_category()) {}
IanBenzMaxim 7:9cd16581b578 133
IanBenzMaxim 7:9cd16581b578 134 error_code(int value, const error_category & category)
IanBenzMaxim 7:9cd16581b578 135 : value_(value), category_(&category) {}
IanBenzMaxim 7:9cd16581b578 136
IanBenzMaxim 7:9cd16581b578 137 void assign(int value, const error_category & category) {
IanBenzMaxim 7:9cd16581b578 138 value_ = value;
IanBenzMaxim 7:9cd16581b578 139 category_ = &category;
IanBenzMaxim 7:9cd16581b578 140 }
IanBenzMaxim 7:9cd16581b578 141
IanBenzMaxim 7:9cd16581b578 142 void clear() {
IanBenzMaxim 7:9cd16581b578 143 value_ = 0;
IanBenzMaxim 7:9cd16581b578 144 category_ = &system_category();
IanBenzMaxim 7:9cd16581b578 145 }
IanBenzMaxim 7:9cd16581b578 146
IanBenzMaxim 7:9cd16581b578 147 int value() const { return value_; }
IanBenzMaxim 7:9cd16581b578 148
IanBenzMaxim 7:9cd16581b578 149 const error_category & category() const { return *category_; }
IanBenzMaxim 7:9cd16581b578 150
IanBenzMaxim 7:9cd16581b578 151 error_condition default_error_condition() const {
IanBenzMaxim 7:9cd16581b578 152 return category().default_error_condition(value());
IanBenzMaxim 7:9cd16581b578 153 }
IanBenzMaxim 7:9cd16581b578 154
IanBenzMaxim 7:9cd16581b578 155 std::string message() const { return category().message(value()); }
IanBenzMaxim 7:9cd16581b578 156
IanBenzMaxim 7:9cd16581b578 157 operator SafeBool() const { return makeSafeBool(value() != 0); }
IanBenzMaxim 7:9cd16581b578 158
IanBenzMaxim 7:9cd16581b578 159 private:
IanBenzMaxim 7:9cd16581b578 160 int value_;
IanBenzMaxim 7:9cd16581b578 161 const error_category * category_;
IanBenzMaxim 7:9cd16581b578 162 };
IanBenzMaxim 7:9cd16581b578 163
IanBenzMaxim 7:9cd16581b578 164 inline bool operator==(const error_code & lhs, const error_code & rhs) {
IanBenzMaxim 7:9cd16581b578 165 return (lhs.value() == rhs.value()) && (lhs.category() == rhs.category());
IanBenzMaxim 7:9cd16581b578 166 }
IanBenzMaxim 7:9cd16581b578 167
IanBenzMaxim 7:9cd16581b578 168 inline bool operator!=(const error_code & lhs, const error_code & rhs) {
IanBenzMaxim 7:9cd16581b578 169 return !operator==(lhs, rhs);
IanBenzMaxim 7:9cd16581b578 170 }
IanBenzMaxim 7:9cd16581b578 171
IanBenzMaxim 7:9cd16581b578 172 inline bool operator<(const error_code & lhs, const error_code & rhs) {
IanBenzMaxim 7:9cd16581b578 173 return (lhs.category() < rhs.category()) ||
IanBenzMaxim 7:9cd16581b578 174 ((lhs.category() == rhs.category()) && (lhs.value() < rhs.value()));
IanBenzMaxim 7:9cd16581b578 175 }
IanBenzMaxim 7:9cd16581b578 176
IanBenzMaxim 7:9cd16581b578 177 template <typename CharT, typename Traits>
IanBenzMaxim 7:9cd16581b578 178 std::basic_ostream<CharT, Traits> &
IanBenzMaxim 7:9cd16581b578 179 operator<<(std::basic_ostream<CharT, Traits> & os, const error_code & ec) {
IanBenzMaxim 7:9cd16581b578 180 os << ec.category().name() << ':' << ec.value();
IanBenzMaxim 7:9cd16581b578 181 return os;
IanBenzMaxim 7:9cd16581b578 182 }
IanBenzMaxim 7:9cd16581b578 183
IanBenzMaxim 7:9cd16581b578 184 inline bool operator==(const error_code & lhs, const error_condition & rhs) {
IanBenzMaxim 7:9cd16581b578 185 return lhs.category().equivalent(lhs.value(), rhs) ||
IanBenzMaxim 7:9cd16581b578 186 rhs.category().equivalent(lhs, rhs.value());
IanBenzMaxim 7:9cd16581b578 187 }
IanBenzMaxim 7:9cd16581b578 188
IanBenzMaxim 7:9cd16581b578 189 inline bool operator!=(const error_code & lhs, const error_condition & rhs) {
IanBenzMaxim 7:9cd16581b578 190 return !operator==(lhs, rhs);
IanBenzMaxim 7:9cd16581b578 191 }
IanBenzMaxim 7:9cd16581b578 192
IanBenzMaxim 7:9cd16581b578 193 inline bool operator==(const error_condition & lhs, const error_code & rhs) {
IanBenzMaxim 7:9cd16581b578 194 return operator==(rhs, lhs);
IanBenzMaxim 7:9cd16581b578 195 }
IanBenzMaxim 7:9cd16581b578 196
IanBenzMaxim 7:9cd16581b578 197 inline bool operator!=(const error_condition & lhs, const error_code & rhs) {
IanBenzMaxim 7:9cd16581b578 198 return !operator==(lhs, rhs);
IanBenzMaxim 7:9cd16581b578 199 }
IanBenzMaxim 7:9cd16581b578 200
IanBenzMaxim 7:9cd16581b578 201 class system_error : public std::runtime_error {
IanBenzMaxim 7:9cd16581b578 202 public:
IanBenzMaxim 7:9cd16581b578 203 MaximInterfaceCore_EXPORT system_error(const error_code & ec);
IanBenzMaxim 7:9cd16581b578 204
IanBenzMaxim 7:9cd16581b578 205 MaximInterfaceCore_EXPORT system_error(const error_code & ec,
IanBenzMaxim 7:9cd16581b578 206 const std::string & what_arg);
IanBenzMaxim 7:9cd16581b578 207
IanBenzMaxim 7:9cd16581b578 208 MaximInterfaceCore_EXPORT system_error(const error_code & ec,
IanBenzMaxim 7:9cd16581b578 209 const char * what_arg);
IanBenzMaxim 7:9cd16581b578 210
IanBenzMaxim 7:9cd16581b578 211 MaximInterfaceCore_EXPORT system_error(int ev, const error_category & ecat);
IanBenzMaxim 7:9cd16581b578 212
IanBenzMaxim 7:9cd16581b578 213 MaximInterfaceCore_EXPORT system_error(int ev, const error_category & ecat,
IanBenzMaxim 7:9cd16581b578 214 const std::string & what_arg);
IanBenzMaxim 7:9cd16581b578 215
IanBenzMaxim 7:9cd16581b578 216 MaximInterfaceCore_EXPORT system_error(int ev, const error_category & ecat,
IanBenzMaxim 7:9cd16581b578 217 const char * what_arg);
IanBenzMaxim 7:9cd16581b578 218
IanBenzMaxim 7:9cd16581b578 219 const error_code & code() const { return code_; }
IanBenzMaxim 7:9cd16581b578 220
IanBenzMaxim 7:9cd16581b578 221 private:
IanBenzMaxim 7:9cd16581b578 222 error_code code_;
IanBenzMaxim 7:9cd16581b578 223 };
IanBenzMaxim 7:9cd16581b578 224
IanBenzMaxim 7:9cd16581b578 225 } // namespace MaximInterfaceCore
IanBenzMaxim 7:9cd16581b578 226
IanBenzMaxim 7:9cd16581b578 227 #endif