libs/generic/enumeration.h

   1 /*
   2 Copyright (C) 2001-2006, William Joseph.
   3 All Rights Reserved.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 #if !defined(INCLUDED_GENERIC_ENUMERATION_H)
  23 #define INCLUDED_GENERIC_ENUMERATION_H
  24
  25 /// \file
  26 /// \brief Type safe enumeration.
  27
  28 /// \brief An enumerated value.
  29 ///
  30 /// - Can be forward-declared when the definition of Enumeration is unknown.
  31 /// - Can only be constructed from valid enumerated values.
  32 /// - Can only be compared with others of the same type.
  33 ///
  34 /// \param Enumeration A type that contains an enum \c Value of the allowed values of the enumeration.
  35 template<typename Enumeration>
  36 class EnumeratedValue : public Enumeration
  37 {
  38   typename Enumeration::Value m_value;
  39 public:
  40   explicit EnumeratedValue(typename Enumeration::Value value) : m_value(value)
  41   {
  42   }
  43   typename Enumeration::Value get() const
  44   {
  45     return m_value;
  46   }
  47 };
  48
  49 template<typename Enumeration>
  50 inline bool operator==(EnumeratedValue<Enumeration> self, EnumeratedValue<Enumeration> other)
  51 {
  52   return self.get() == other.get();
  53 }
  54 template<typename Enumeration>
  55 inline bool operator!=(EnumeratedValue<Enumeration> self, EnumeratedValue<Enumeration> other)
  56 {
  57   return !operator==(self, other);
  58 }
  59
  60 #endif