Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Utilities/FlagSet.hpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Child:
6:a8c83a2e6fa4
Initial commit.

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 0:f77ad7f72d04 33 #ifndef MaximInterface_FlagSet
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_FlagSet
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <stddef.h>
IanBenzMaxim 0:f77ad7f72d04 37 #include <bitset>
IanBenzMaxim 0:f77ad7f72d04 38
IanBenzMaxim 0:f77ad7f72d04 39 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 /// Provides functionality similar to std::bitset except using a bit flag,
IanBenzMaxim 0:f77ad7f72d04 42 /// typically of an enum type, as the indexer.
IanBenzMaxim 0:f77ad7f72d04 43 template <typename Flag, size_t flagBits> class FlagSet {
IanBenzMaxim 0:f77ad7f72d04 44 public:
IanBenzMaxim 0:f77ad7f72d04 45 class reference {
IanBenzMaxim 0:f77ad7f72d04 46 public:
IanBenzMaxim 0:f77ad7f72d04 47 reference(FlagSet & flagSet, Flag flag) : flagSet(&flagSet), flag(flag) {}
IanBenzMaxim 0:f77ad7f72d04 48 reference & operator=(bool x) {
IanBenzMaxim 0:f77ad7f72d04 49 flagSet->set(flag, x);
IanBenzMaxim 0:f77ad7f72d04 50 return *this;
IanBenzMaxim 0:f77ad7f72d04 51 }
IanBenzMaxim 0:f77ad7f72d04 52 reference & operator=(const reference & x) {
IanBenzMaxim 0:f77ad7f72d04 53 return operator=(static_cast<bool>(x));
IanBenzMaxim 0:f77ad7f72d04 54 }
IanBenzMaxim 0:f77ad7f72d04 55 operator bool() const { return flagSet->test(flag); }
IanBenzMaxim 0:f77ad7f72d04 56 bool operator~() const { return reference(*this).flip(); }
IanBenzMaxim 0:f77ad7f72d04 57 reference & flip() {
IanBenzMaxim 0:f77ad7f72d04 58 *this = !*this;
IanBenzMaxim 0:f77ad7f72d04 59 return *this;
IanBenzMaxim 0:f77ad7f72d04 60 }
IanBenzMaxim 0:f77ad7f72d04 61
IanBenzMaxim 0:f77ad7f72d04 62 private:
IanBenzMaxim 0:f77ad7f72d04 63 FlagSet * flagSet;
IanBenzMaxim 0:f77ad7f72d04 64 Flag flag;
IanBenzMaxim 0:f77ad7f72d04 65 };
IanBenzMaxim 0:f77ad7f72d04 66
IanBenzMaxim 0:f77ad7f72d04 67 FlagSet() : bits() {}
IanBenzMaxim 0:f77ad7f72d04 68 FlagSet(unsigned long val) : bits(val) {}
IanBenzMaxim 0:f77ad7f72d04 69
IanBenzMaxim 0:f77ad7f72d04 70 template <typename CharT, typename Traits, typename Alloc>
IanBenzMaxim 0:f77ad7f72d04 71 explicit FlagSet(
IanBenzMaxim 0:f77ad7f72d04 72 const std::basic_string<CharT, Traits, Alloc> & str,
IanBenzMaxim 0:f77ad7f72d04 73 typename std::basic_string<CharT, Traits, Alloc>::size_type pos = 0,
IanBenzMaxim 0:f77ad7f72d04 74 typename std::basic_string<CharT, Traits, Alloc>::size_type n =
IanBenzMaxim 0:f77ad7f72d04 75 std::basic_string<CharT, Traits, Alloc>::npos)
IanBenzMaxim 0:f77ad7f72d04 76 : bits(str, pos, n) {}
IanBenzMaxim 0:f77ad7f72d04 77
IanBenzMaxim 0:f77ad7f72d04 78 bool operator==(const FlagSet & rhs) const { return bits == rhs.bits; }
IanBenzMaxim 0:f77ad7f72d04 79 bool operator!=(const FlagSet & rhs) const { return !operator==(rhs); }
IanBenzMaxim 0:f77ad7f72d04 80
IanBenzMaxim 0:f77ad7f72d04 81 // Element access
IanBenzMaxim 0:f77ad7f72d04 82 bool operator[](Flag flag) const { return test(flag); }
IanBenzMaxim 0:f77ad7f72d04 83 reference operator[](Flag flag) { return reference(*this, flag); }
IanBenzMaxim 0:f77ad7f72d04 84 bool test(Flag flag) const { return (bits.to_ulong() & flag) == flag; }
IanBenzMaxim 0:f77ad7f72d04 85 bool any() const { return bits.any(); }
IanBenzMaxim 0:f77ad7f72d04 86 bool none() const { return bits.none(); }
IanBenzMaxim 0:f77ad7f72d04 87 size_t count() const { return bits.count(); }
IanBenzMaxim 0:f77ad7f72d04 88
IanBenzMaxim 0:f77ad7f72d04 89 // Capacity
IanBenzMaxim 0:f77ad7f72d04 90 size_t size() const { return bits.size(); }
IanBenzMaxim 0:f77ad7f72d04 91
IanBenzMaxim 0:f77ad7f72d04 92 // Modifiers
IanBenzMaxim 0:f77ad7f72d04 93 FlagSet & operator&=(const FlagSet & other) {
IanBenzMaxim 0:f77ad7f72d04 94 bits &= other.bits;
IanBenzMaxim 0:f77ad7f72d04 95 return *this;
IanBenzMaxim 0:f77ad7f72d04 96 }
IanBenzMaxim 0:f77ad7f72d04 97 FlagSet & operator|=(const FlagSet & other) {
IanBenzMaxim 0:f77ad7f72d04 98 bits |= other.bits;
IanBenzMaxim 0:f77ad7f72d04 99 return *this;
IanBenzMaxim 0:f77ad7f72d04 100 }
IanBenzMaxim 0:f77ad7f72d04 101 FlagSet & operator^=(const FlagSet & other) {
IanBenzMaxim 0:f77ad7f72d04 102 bits ^= other.bits;
IanBenzMaxim 0:f77ad7f72d04 103 return *this;
IanBenzMaxim 0:f77ad7f72d04 104 }
IanBenzMaxim 0:f77ad7f72d04 105 FlagSet operator~() const { return ~bits; }
IanBenzMaxim 0:f77ad7f72d04 106
IanBenzMaxim 0:f77ad7f72d04 107 FlagSet & set() {
IanBenzMaxim 0:f77ad7f72d04 108 bits.set();
IanBenzMaxim 0:f77ad7f72d04 109 return *this;
IanBenzMaxim 0:f77ad7f72d04 110 }
IanBenzMaxim 0:f77ad7f72d04 111 FlagSet & set(Flag flag, bool value = true) {
IanBenzMaxim 0:f77ad7f72d04 112 if (value) {
IanBenzMaxim 0:f77ad7f72d04 113 bits |= flag;
IanBenzMaxim 0:f77ad7f72d04 114 } else {
IanBenzMaxim 0:f77ad7f72d04 115 bits &= ~std::bitset<flagBits>(flag);
IanBenzMaxim 0:f77ad7f72d04 116 }
IanBenzMaxim 0:f77ad7f72d04 117 return *this;
IanBenzMaxim 0:f77ad7f72d04 118 }
IanBenzMaxim 0:f77ad7f72d04 119 FlagSet & reset() {
IanBenzMaxim 0:f77ad7f72d04 120 bits.reset();
IanBenzMaxim 0:f77ad7f72d04 121 return *this;
IanBenzMaxim 0:f77ad7f72d04 122 }
IanBenzMaxim 0:f77ad7f72d04 123 FlagSet & reset(Flag flag) { return set(flag, false); }
IanBenzMaxim 0:f77ad7f72d04 124 FlagSet & flip() {
IanBenzMaxim 0:f77ad7f72d04 125 bits.flip();
IanBenzMaxim 0:f77ad7f72d04 126 return *this;
IanBenzMaxim 0:f77ad7f72d04 127 }
IanBenzMaxim 0:f77ad7f72d04 128 FlagSet & flip(Flag flag) {
IanBenzMaxim 0:f77ad7f72d04 129 bits ^= flag;
IanBenzMaxim 0:f77ad7f72d04 130 return *this;
IanBenzMaxim 0:f77ad7f72d04 131 }
IanBenzMaxim 0:f77ad7f72d04 132
IanBenzMaxim 0:f77ad7f72d04 133 // Conversions
IanBenzMaxim 0:f77ad7f72d04 134 template <typename CharT, typename Traits, typename Allocator>
IanBenzMaxim 0:f77ad7f72d04 135 std::basic_string<CharT, Traits, Allocator> to_string() const {
IanBenzMaxim 0:f77ad7f72d04 136 return bits.template to_string<CharT, Traits, Allocator>();
IanBenzMaxim 0:f77ad7f72d04 137 }
IanBenzMaxim 0:f77ad7f72d04 138 unsigned long to_ulong() const { return bits.to_ulong(); }
IanBenzMaxim 0:f77ad7f72d04 139
IanBenzMaxim 0:f77ad7f72d04 140 private:
IanBenzMaxim 0:f77ad7f72d04 141 std::bitset<flagBits> bits;
IanBenzMaxim 0:f77ad7f72d04 142
IanBenzMaxim 0:f77ad7f72d04 143 template <typename CharT, typename Traits>
IanBenzMaxim 0:f77ad7f72d04 144 friend std::basic_ostream<CharT, Traits> &
IanBenzMaxim 0:f77ad7f72d04 145 operator<<(std::basic_ostream<CharT, Traits> & os, const FlagSet & x);
IanBenzMaxim 0:f77ad7f72d04 146
IanBenzMaxim 0:f77ad7f72d04 147 template <typename CharT, class Traits>
IanBenzMaxim 0:f77ad7f72d04 148 friend std::basic_istream<CharT, Traits> &
IanBenzMaxim 0:f77ad7f72d04 149 operator>>(std::basic_istream<CharT, Traits> & is, FlagSet & x);
IanBenzMaxim 0:f77ad7f72d04 150 };
IanBenzMaxim 0:f77ad7f72d04 151
IanBenzMaxim 0:f77ad7f72d04 152 template <typename Flag, size_t flagBits>
IanBenzMaxim 0:f77ad7f72d04 153 FlagSet<Flag, flagBits> operator&(const FlagSet<Flag, flagBits> & lhs,
IanBenzMaxim 0:f77ad7f72d04 154 const FlagSet<Flag, flagBits> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 155 return FlagSet<Flag, flagBits>(lhs) &= rhs;
IanBenzMaxim 0:f77ad7f72d04 156 }
IanBenzMaxim 0:f77ad7f72d04 157
IanBenzMaxim 0:f77ad7f72d04 158 template <typename Flag, size_t flagBits>
IanBenzMaxim 0:f77ad7f72d04 159 FlagSet<Flag, flagBits> operator|(const FlagSet<Flag, flagBits> & lhs,
IanBenzMaxim 0:f77ad7f72d04 160 const FlagSet<Flag, flagBits> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 161 return FlagSet<Flag, flagBits>(lhs) |= rhs;
IanBenzMaxim 0:f77ad7f72d04 162 }
IanBenzMaxim 0:f77ad7f72d04 163
IanBenzMaxim 0:f77ad7f72d04 164 template <typename Flag, size_t flagBits>
IanBenzMaxim 0:f77ad7f72d04 165 FlagSet<Flag, flagBits> operator^(const FlagSet<Flag, flagBits> & lhs,
IanBenzMaxim 0:f77ad7f72d04 166 const FlagSet<Flag, flagBits> & rhs) {
IanBenzMaxim 0:f77ad7f72d04 167 return FlagSet<Flag, flagBits>(lhs) ^= rhs;
IanBenzMaxim 0:f77ad7f72d04 168 }
IanBenzMaxim 0:f77ad7f72d04 169
IanBenzMaxim 0:f77ad7f72d04 170 template <typename CharT, typename Traits, typename Flag, size_t flagBits>
IanBenzMaxim 0:f77ad7f72d04 171 std::basic_ostream<CharT, Traits> &
IanBenzMaxim 0:f77ad7f72d04 172 operator<<(std::basic_ostream<CharT, Traits> & os,
IanBenzMaxim 0:f77ad7f72d04 173 const FlagSet<Flag, flagBits> & x) {
IanBenzMaxim 0:f77ad7f72d04 174 os << x.bits;
IanBenzMaxim 0:f77ad7f72d04 175 return os;
IanBenzMaxim 0:f77ad7f72d04 176 }
IanBenzMaxim 0:f77ad7f72d04 177
IanBenzMaxim 0:f77ad7f72d04 178 template <typename CharT, class Traits, typename Flag, size_t flagBits>
IanBenzMaxim 0:f77ad7f72d04 179 std::basic_istream<CharT, Traits> &
IanBenzMaxim 0:f77ad7f72d04 180 operator>>(std::basic_istream<CharT, Traits> & is,
IanBenzMaxim 0:f77ad7f72d04 181 FlagSet<Flag, flagBits> & x) {
IanBenzMaxim 0:f77ad7f72d04 182 is >> x.bits;
IanBenzMaxim 0:f77ad7f72d04 183 return is;
IanBenzMaxim 0:f77ad7f72d04 184 }
IanBenzMaxim 0:f77ad7f72d04 185
IanBenzMaxim 0:f77ad7f72d04 186 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 187
IanBenzMaxim 0:f77ad7f72d04 188 #endif