libs/generic/constant.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_CONSTANT_H)
  23 #define INCLUDED_GENERIC_CONSTANT_H
  24
  25 /// \file
  26 /// \brief Language extensions for constants that are guaranteed to be evaluated at compile-time.
  27
  28 /// \brief A compile-time-constant as a type.
  29 template<typename Type>
  30 struct ConstantWrapper
  31 {
  32   typedef typename Type::Value Value;
  33   operator Value() const
  34   {
  35     return Type::evaluate();
  36   }
  37 };
  38 template<typename TextOutputStreamType,  typename Type>
  39 inline TextOutputStreamType& ostream_write(TextOutputStreamType& ostream, const ConstantWrapper<Type>& c)
  40 {
  41   return ostream_write(ostream, typename Type::Value(c));
  42 }
  43
  44 #define TYPE_CONSTANT(name, value, type) struct name##_CONSTANT_ { typedef type Value; static Value evaluate() { return value; } }; typedef ConstantWrapper<name##_CONSTANT_> name
  45 #define STRING_CONSTANT(name, value) TYPE_CONSTANT(name, value, const char*)
  46 #define INTEGER_CONSTANT(name, value) TYPE_CONSTANT(name, value, int)
  47
  48 STRING_CONSTANT(EmptyString, "");
  49
  50 #endif