Extended MaximInterface
Dependents: mbed_DS28EC20_GPIO
Utilities/system_error.hpp@3:f818ea5172ed, 2018-01-11 (annotated)
- Committer:
- IanBenzMaxim
- Date:
- Thu Jan 11 13:50:39 2018 -0600
- Revision:
- 3:f818ea5172ed
- Parent:
- 0:f77ad7f72d04
- Child:
- 6:a8c83a2e6fa4
Updated to version 1.1.
Who changed what in which revision?
User | Revision | Line number | New 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 | 3:f818ea5172ed | 34 | /// Error handling constructs similar std::error_code, std::error_condition, and |
IanBenzMaxim | 3:f818ea5172ed | 35 | /// std::error_category. |
IanBenzMaxim | 3:f818ea5172ed | 36 | |
IanBenzMaxim | 0:f77ad7f72d04 | 37 | #ifndef MaximInterface_system_error |
IanBenzMaxim | 0:f77ad7f72d04 | 38 | #define MaximInterface_system_error |
IanBenzMaxim | 0:f77ad7f72d04 | 39 | |
IanBenzMaxim | 0:f77ad7f72d04 | 40 | #include <string> |
IanBenzMaxim | 0:f77ad7f72d04 | 41 | #include <MaximInterface/Utilities/Export.h> |
IanBenzMaxim | 0:f77ad7f72d04 | 42 | #include "Uncopyable.hpp" |
IanBenzMaxim | 0:f77ad7f72d04 | 43 | |
IanBenzMaxim | 0:f77ad7f72d04 | 44 | namespace MaximInterface { |
IanBenzMaxim | 0:f77ad7f72d04 | 45 | |
IanBenzMaxim | 0:f77ad7f72d04 | 46 | class error_condition; |
IanBenzMaxim | 0:f77ad7f72d04 | 47 | class error_code; |
IanBenzMaxim | 0:f77ad7f72d04 | 48 | |
IanBenzMaxim | 0:f77ad7f72d04 | 49 | class error_category : private Uncopyable { |
IanBenzMaxim | 0:f77ad7f72d04 | 50 | public: |
IanBenzMaxim | 0:f77ad7f72d04 | 51 | virtual ~error_category() {} |
IanBenzMaxim | 0:f77ad7f72d04 | 52 | |
IanBenzMaxim | 0:f77ad7f72d04 | 53 | virtual const char * name() const = 0; |
IanBenzMaxim | 0:f77ad7f72d04 | 54 | MaximInterface_EXPORT virtual error_condition |
IanBenzMaxim | 0:f77ad7f72d04 | 55 | default_error_condition(int code) const; |
IanBenzMaxim | 0:f77ad7f72d04 | 56 | MaximInterface_EXPORT virtual bool |
IanBenzMaxim | 0:f77ad7f72d04 | 57 | equivalent(int code, const error_condition & condition) const; |
IanBenzMaxim | 0:f77ad7f72d04 | 58 | MaximInterface_EXPORT virtual bool equivalent(const error_code & code, |
IanBenzMaxim | 0:f77ad7f72d04 | 59 | int condition) const; |
IanBenzMaxim | 0:f77ad7f72d04 | 60 | virtual std::string message(int condition) const = 0; |
IanBenzMaxim | 0:f77ad7f72d04 | 61 | }; |
IanBenzMaxim | 0:f77ad7f72d04 | 62 | inline bool operator==(const error_category & lhs, const error_category & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 63 | return &lhs == &rhs; |
IanBenzMaxim | 0:f77ad7f72d04 | 64 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 65 | inline bool operator!=(const error_category & lhs, const error_category & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 66 | return !operator==(lhs, rhs); |
IanBenzMaxim | 0:f77ad7f72d04 | 67 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 68 | inline bool operator<(const error_category & lhs, const error_category & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 69 | return &lhs < &rhs; |
IanBenzMaxim | 0:f77ad7f72d04 | 70 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 71 | |
IanBenzMaxim | 0:f77ad7f72d04 | 72 | MaximInterface_EXPORT const error_category & system_category(); |
IanBenzMaxim | 0:f77ad7f72d04 | 73 | |
IanBenzMaxim | 0:f77ad7f72d04 | 74 | class error_condition { |
IanBenzMaxim | 0:f77ad7f72d04 | 75 | public: |
IanBenzMaxim | 0:f77ad7f72d04 | 76 | error_condition() : value_(0), category_(&system_category()) {} |
IanBenzMaxim | 0:f77ad7f72d04 | 77 | error_condition(int value, const error_category & category) |
IanBenzMaxim | 0:f77ad7f72d04 | 78 | : value_(value), category_(&category) {} |
IanBenzMaxim | 0:f77ad7f72d04 | 79 | |
IanBenzMaxim | 0:f77ad7f72d04 | 80 | void assign(int value, const error_category & category) { |
IanBenzMaxim | 0:f77ad7f72d04 | 81 | value_ = value; |
IanBenzMaxim | 0:f77ad7f72d04 | 82 | category_ = &category; |
IanBenzMaxim | 0:f77ad7f72d04 | 83 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 84 | void clear() { |
IanBenzMaxim | 0:f77ad7f72d04 | 85 | value_ = 0; |
IanBenzMaxim | 0:f77ad7f72d04 | 86 | category_ = &system_category(); |
IanBenzMaxim | 0:f77ad7f72d04 | 87 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 88 | int value() const { return value_; } |
IanBenzMaxim | 0:f77ad7f72d04 | 89 | const error_category & category() const { return *category_; } |
IanBenzMaxim | 0:f77ad7f72d04 | 90 | std::string message() const { return category().message(value()); } |
IanBenzMaxim | 0:f77ad7f72d04 | 91 | operator bool() const { return value() != 0; } |
IanBenzMaxim | 0:f77ad7f72d04 | 92 | |
IanBenzMaxim | 0:f77ad7f72d04 | 93 | private: |
IanBenzMaxim | 0:f77ad7f72d04 | 94 | int value_; |
IanBenzMaxim | 0:f77ad7f72d04 | 95 | const error_category * category_; |
IanBenzMaxim | 0:f77ad7f72d04 | 96 | }; |
IanBenzMaxim | 0:f77ad7f72d04 | 97 | inline bool operator==(const error_condition & lhs, |
IanBenzMaxim | 0:f77ad7f72d04 | 98 | const error_condition & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 99 | return (lhs.value() == rhs.value()) && (lhs.category() == rhs.category()); |
IanBenzMaxim | 0:f77ad7f72d04 | 100 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 101 | inline bool operator!=(const error_condition & lhs, |
IanBenzMaxim | 0:f77ad7f72d04 | 102 | const error_condition & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 103 | return !operator==(lhs, rhs); |
IanBenzMaxim | 0:f77ad7f72d04 | 104 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 105 | inline bool operator<(const error_condition & lhs, |
IanBenzMaxim | 0:f77ad7f72d04 | 106 | const error_condition & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 107 | return (lhs.category() < rhs.category()) || |
IanBenzMaxim | 0:f77ad7f72d04 | 108 | ((lhs.category() == rhs.category()) && (lhs.value() < rhs.value())); |
IanBenzMaxim | 0:f77ad7f72d04 | 109 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 110 | |
IanBenzMaxim | 0:f77ad7f72d04 | 111 | class error_code { |
IanBenzMaxim | 0:f77ad7f72d04 | 112 | public: |
IanBenzMaxim | 0:f77ad7f72d04 | 113 | error_code() : value_(0), category_(&system_category()) {} |
IanBenzMaxim | 0:f77ad7f72d04 | 114 | error_code(int value, const error_category & category) |
IanBenzMaxim | 0:f77ad7f72d04 | 115 | : value_(value), category_(&category) {} |
IanBenzMaxim | 0:f77ad7f72d04 | 116 | |
IanBenzMaxim | 0:f77ad7f72d04 | 117 | void assign(int value, const error_category & category) { |
IanBenzMaxim | 0:f77ad7f72d04 | 118 | value_ = value; |
IanBenzMaxim | 0:f77ad7f72d04 | 119 | category_ = &category; |
IanBenzMaxim | 0:f77ad7f72d04 | 120 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 121 | void clear() { |
IanBenzMaxim | 0:f77ad7f72d04 | 122 | value_ = 0; |
IanBenzMaxim | 0:f77ad7f72d04 | 123 | category_ = &system_category(); |
IanBenzMaxim | 0:f77ad7f72d04 | 124 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 125 | int value() const { return value_; } |
IanBenzMaxim | 0:f77ad7f72d04 | 126 | const error_category & category() const { return *category_; } |
IanBenzMaxim | 0:f77ad7f72d04 | 127 | error_condition default_error_condition() const { |
IanBenzMaxim | 0:f77ad7f72d04 | 128 | return category().default_error_condition(value()); |
IanBenzMaxim | 0:f77ad7f72d04 | 129 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 130 | std::string message() const { return category().message(value()); } |
IanBenzMaxim | 0:f77ad7f72d04 | 131 | operator bool() const { return value() != 0; } |
IanBenzMaxim | 0:f77ad7f72d04 | 132 | |
IanBenzMaxim | 0:f77ad7f72d04 | 133 | private: |
IanBenzMaxim | 0:f77ad7f72d04 | 134 | int value_; |
IanBenzMaxim | 0:f77ad7f72d04 | 135 | const error_category * category_; |
IanBenzMaxim | 0:f77ad7f72d04 | 136 | }; |
IanBenzMaxim | 0:f77ad7f72d04 | 137 | inline bool operator==(const error_code & lhs, const error_code & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 138 | return (lhs.value() == rhs.value()) && (lhs.category() == rhs.category()); |
IanBenzMaxim | 0:f77ad7f72d04 | 139 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 140 | inline bool operator!=(const error_code & lhs, const error_code & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 141 | return !operator==(lhs, rhs); |
IanBenzMaxim | 0:f77ad7f72d04 | 142 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 143 | inline bool operator<(const error_code & lhs, const error_code & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 144 | return (lhs.category() < rhs.category()) || |
IanBenzMaxim | 0:f77ad7f72d04 | 145 | ((lhs.category() == rhs.category()) && (lhs.value() < rhs.value())); |
IanBenzMaxim | 0:f77ad7f72d04 | 146 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 147 | |
IanBenzMaxim | 0:f77ad7f72d04 | 148 | template <typename CharT, typename Traits> |
IanBenzMaxim | 0:f77ad7f72d04 | 149 | std::basic_ostream<CharT, Traits> & |
IanBenzMaxim | 0:f77ad7f72d04 | 150 | operator<<(std::basic_ostream<CharT, Traits> & os, const error_code & ec) { |
IanBenzMaxim | 0:f77ad7f72d04 | 151 | os << ec.category().name() << ':' << ec.value(); |
IanBenzMaxim | 0:f77ad7f72d04 | 152 | return os; |
IanBenzMaxim | 0:f77ad7f72d04 | 153 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 154 | |
IanBenzMaxim | 0:f77ad7f72d04 | 155 | inline bool operator==(const error_code & lhs, const error_condition & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 156 | return lhs.category().equivalent(lhs.value(), rhs) || |
IanBenzMaxim | 0:f77ad7f72d04 | 157 | rhs.category().equivalent(lhs, rhs.value()); |
IanBenzMaxim | 0:f77ad7f72d04 | 158 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 159 | inline bool operator!=(const error_code & lhs, const error_condition & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 160 | return !operator==(lhs, rhs); |
IanBenzMaxim | 0:f77ad7f72d04 | 161 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 162 | inline bool operator==(const error_condition & lhs, const error_code & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 163 | return operator==(rhs, lhs); |
IanBenzMaxim | 0:f77ad7f72d04 | 164 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 165 | inline bool operator!=(const error_condition & lhs, const error_code & rhs) { |
IanBenzMaxim | 0:f77ad7f72d04 | 166 | return !operator==(lhs, rhs); |
IanBenzMaxim | 0:f77ad7f72d04 | 167 | } |
IanBenzMaxim | 0:f77ad7f72d04 | 168 | |
IanBenzMaxim | 0:f77ad7f72d04 | 169 | } // namespace MaximInterface |
IanBenzMaxim | 0:f77ad7f72d04 | 170 | |
IanBenzMaxim | 0:f77ad7f72d04 | 171 | #endif |