mirror of https://github.com/OpenTTD/OpenTTD.git
72 lines
3.9 KiB
C++
72 lines
3.9 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file enum_type.hpp Type (helpers) for enums */
|
|
|
|
#ifndef ENUM_TYPE_HPP
|
|
#define ENUM_TYPE_HPP
|
|
|
|
/** Some enums need to have allowed incrementing (i.e. StationClassID) */
|
|
#define DECLARE_POSTFIX_INCREMENT(enum_type) \
|
|
inline constexpr enum_type operator ++(enum_type& e, int) \
|
|
{ \
|
|
enum_type e_org = e; \
|
|
e = (enum_type)((std::underlying_type<enum_type>::type)e + 1); \
|
|
return e_org; \
|
|
} \
|
|
inline constexpr enum_type operator --(enum_type& e, int) \
|
|
{ \
|
|
enum_type e_org = e; \
|
|
e = (enum_type)((std::underlying_type<enum_type>::type)e - 1); \
|
|
return e_org; \
|
|
}
|
|
|
|
|
|
|
|
/** Operators to allow to work with enum as with type safe bit set in C++ */
|
|
# define DECLARE_ENUM_AS_BIT_SET(mask_t) \
|
|
inline constexpr mask_t operator | (mask_t m1, mask_t m2) {return (mask_t)((std::underlying_type<mask_t>::type)m1 | (std::underlying_type<mask_t>::type)m2);} \
|
|
inline constexpr mask_t operator & (mask_t m1, mask_t m2) {return (mask_t)((std::underlying_type<mask_t>::type)m1 & (std::underlying_type<mask_t>::type)m2);} \
|
|
inline constexpr mask_t operator ^ (mask_t m1, mask_t m2) {return (mask_t)((std::underlying_type<mask_t>::type)m1 ^ (std::underlying_type<mask_t>::type)m2);} \
|
|
inline constexpr mask_t& operator |= (mask_t& m1, mask_t m2) {m1 = m1 | m2; return m1;} \
|
|
inline constexpr mask_t& operator &= (mask_t& m1, mask_t m2) {m1 = m1 & m2; return m1;} \
|
|
inline constexpr mask_t& operator ^= (mask_t& m1, mask_t m2) {m1 = m1 ^ m2; return m1;} \
|
|
inline constexpr mask_t operator ~(mask_t m) {return (mask_t)(~(std::underlying_type<mask_t>::type)m);}
|
|
|
|
|
|
/**
|
|
* Informative template class exposing basic enumeration properties used by several
|
|
* other templates below. Here we have only forward declaration. For each enum type
|
|
* we will create specialization derived from MakeEnumPropsT<>.
|
|
* i.e.:
|
|
* template <> struct EnumPropsT<Track> : MakeEnumPropsT<Track, byte, TRACK_BEGIN, TRACK_END, INVALID_TRACK> {};
|
|
*/
|
|
template <typename Tenum_t> struct EnumPropsT;
|
|
|
|
/**
|
|
* Helper template class that makes basic properties of given enumeration type visible
|
|
* from outsize. It is used as base class of several EnumPropsT specializations each
|
|
* dedicated to one of commonly used enumeration types.
|
|
* @param Tenum_t enumeration type that you want to describe
|
|
* @param Tstorage_t what storage type would be sufficient (i.e. byte)
|
|
* @param Tbegin first valid value from the contiguous range (i.e. TRACK_BEGIN)
|
|
* @param Tend one past the last valid value from the contiguous range (i.e. TRACK_END)
|
|
* @param Tinvalid value used as invalid value marker (i.e. INVALID_TRACK)
|
|
* @param Tnum_bits Number of bits for storing the enum in command parameters
|
|
*/
|
|
template <typename Tenum_t, typename Tstorage_t, Tenum_t Tbegin, Tenum_t Tend, Tenum_t Tinvalid, uint Tnum_bits = 8 * sizeof(Tstorage_t)>
|
|
struct MakeEnumPropsT {
|
|
typedef Tenum_t type; ///< enum type (i.e. Trackdir)
|
|
typedef Tstorage_t storage; ///< storage type (i.e. byte)
|
|
static const Tenum_t begin = Tbegin; ///< lowest valid value (i.e. TRACKDIR_BEGIN)
|
|
static const Tenum_t end = Tend; ///< one after the last valid value (i.e. TRACKDIR_END)
|
|
static const Tenum_t invalid = Tinvalid; ///< what value is used as invalid value (i.e. INVALID_TRACKDIR)
|
|
static const uint num_bits = Tnum_bits; ///< Number of bits for storing the enum in command parameters
|
|
};
|
|
|
|
#endif /* ENUM_TYPE_HPP */
|