src/base/flags.hh

   1 /*
   2  * Copyright (c) 2008 The Hewlett-Packard Development Company
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __BASE_FLAGS_HH__
  30 #define __BASE_FLAGS_HH__
  31
  32 #include <type_traits>
  33
  34 template <typename T>
  35 class Flags
  36 {
  37   private:
  38     static_assert(std::is_unsigned<T>::value, "Flag type must be unsigned");
  39
  40     T _flags;
  41
  42   public:
  43     typedef T Type;
  44
  45     /**
  46      * @ingroup api_flags
  47      * @{
  48      */
  49     Flags() : _flags(0) {}
  50     Flags(Type flags) : _flags(flags) {}
  51     /** @} */ // end of api_flags
  52
  53     /**
  54      * @ingroup api_flags
  55      */
  56     operator const Type() const { return _flags; }
  57
  58     /**
  59      * @ingroup api_flags
  60      */
  61     template <typename U>
  62     const Flags<T> &
  63     operator=(const Flags<U> &flags)
  64     {
  65         _flags = flags._flags;
  66         return *this;
  67     }
  68
  69     /**
  70      * @ingroup api_flags
  71      */
  72     const Flags<T> &
  73     operator=(T flags)
  74     {
  75         _flags = flags;
  76         return *this;
  77     }
  78
  79     /**
  80      * @ingroup api_flags
  81      * @{
  82      */
  83     bool isSet() const { return _flags; }
  84     bool isSet(Type flags) const { return (_flags & flags); }
  85     bool allSet() const { return !(~_flags); }
  86     bool allSet(Type flags) const { return (_flags & flags) == flags; }
  87     bool noneSet() const { return _flags == 0; }
  88     bool noneSet(Type flags) const { return (_flags & flags) == 0; }
  89     void clear() { _flags = 0; }
  90     void clear(Type flags) { _flags &= ~flags; }
  91     void set(Type flags) { _flags |= flags; }
  92     void set(Type f, bool val) { _flags = (_flags & ~f) | (val ? f : 0); }
  93     void
  94     update(Type flags, Type mask)
  95     {
  96         _flags = (_flags & ~mask) | (flags & mask);
  97     }
  98     /** @} */ // end of api_flags
  99 };
 100
 101 #endif // __BASE_FLAGS_HH__