Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Committer:
reARMnimator
Date:
Mon Jan 06 15:54:55 2020 +0000
Revision:
10:de4b8812877d
Parent:
7:471901a04573
Fixed inappropriate include path.

Who changed what in which revision?

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