1

/* $Id$ */

     2

     3

/** @file enum_type.hpp Type (helpers) for enums */

     4

     5

#ifndef ENUM_TYPE_HPP

     6

#define ENUM_TYPE_HPP

     7

     8

/** Some enums need to have allowed incrementing (i.e. StationClassID) */

     9

#define DECLARE_POSTFIX_INCREMENT(type) \

    10

	FORCEINLINE type operator ++(type& e, int) \

    11

	{ \

    12

		type e_org = e; \

    13

		e = (type)((int)e + 1); \

    14

		return e_org; \

    15

	} \

    16

	FORCEINLINE type operator --(type& e, int) \

    17

	{ \

    18

		type e_org = e; \

    19

		e = (type)((int)e - 1); \

    20

		return e_org; \

    21

	}

    22

    23

    24

    25

/** Operators to allow to work with enum as with type safe bit set in C++ */

    26

# define DECLARE_ENUM_AS_BIT_SET(mask_t) \

    27

	FORCEINLINE mask_t operator | (mask_t m1, mask_t m2) {return (mask_t)((int)m1 | m2);} \

    28

	FORCEINLINE mask_t operator & (mask_t m1, mask_t m2) {return (mask_t)((int)m1 & m2);} \

    29

	FORCEINLINE mask_t operator ^ (mask_t m1, mask_t m2) {return (mask_t)((int)m1 ^ m2);} \

    30

	FORCEINLINE mask_t& operator |= (mask_t& m1, mask_t m2) {m1 = m1 | m2; return m1;} \

    31

	FORCEINLINE mask_t& operator &= (mask_t& m1, mask_t m2) {m1 = m1 & m2; return m1;} \

    32

	FORCEINLINE mask_t& operator ^= (mask_t& m1, mask_t m2) {m1 = m1 ^ m2; return m1;} \

    33

	FORCEINLINE mask_t operator ~(mask_t m) {return (mask_t)(~(int)m);}

    34

    35

    36

/** Informative template class exposing basic enumeration properties used by several

    37

 *  other templates below. Here we have only forward declaration. For each enum type

    38

 *  we will create specialization derived from MakeEnumPropsT<>.

    39

 *  i.e.:

    40

 *    template <> struct EnumPropsT<Track> : MakeEnumPropsT<Track, byte, TRACK_BEGIN, TRACK_END, INVALID_TRACK> {};

    41

 *  followed by:

    42

 *    typedef TinyEnumT<Track> TrackByte;

    43

 */

    44

template <typename Tenum_t> struct EnumPropsT;

    45

    46

/** Helper template class that makes basic properties of given enumeration type visible

    47

 *  from outsize. It is used as base class of several EnumPropsT specializations each

    48

 *  dedicated to one of commonly used enumeration types.

    49

 *  @param Tenum_t enumeration type that you want to describe

    50

 *  @param Tstorage_t what storage type would be sufficient (i.e. byte)

    51

 *  @param Tbegin first valid value from the contiguous range (i.e. TRACK_BEGIN)

    52

 *  @param Tend one past the last valid value from the contiguous range (i.e. TRACK_END)

    53

 *  @param Tinvalid value used as invalid value marker (i.e. INVALID_TRACK)

    54

 */

    55

template <typename Tenum_t, typename Tstorage_t, Tenum_t Tbegin, Tenum_t Tend, Tenum_t Tinvalid>

    56

struct MakeEnumPropsT {

    57

	typedef Tenum_t type;                     ///< enum type (i.e. Trackdir)

    58

	typedef Tstorage_t storage;               ///< storage type (i.e. byte)

    59

	static const Tenum_t begin = Tbegin;      ///< lowest valid value (i.e. TRACKDIR_BEGIN)

    60

	static const Tenum_t end = Tend;          ///< one after the last valid value (i.e. TRACKDIR_END)

    61

	static const Tenum_t invalid = Tinvalid;  ///< what value is used as invalid value (i.e. INVALID_TRACKDIR)

    62

};

    63

    64

    65

    66

/** In some cases we use byte or uint16 to store values that are defined as enum. It is

    67

	*  necessary in order to control the sizeof() such values. Some compilers make enum

    68

	*  the same size as int (4 or 8 bytes instead of 1 or 2). As a consequence the strict

    69

	*  compiler type - checking causes errors like:

    70

	*     'HasPowerOnRail' : cannot convert parameter 1 from 'byte' to 'RailType' when

    71

	*  u->u.rail.railtype is passed as argument or type RailType. In such cases it is better

    72

	*  to teach the compiler that u->u.rail.railtype is to be treated as RailType. */

    73

template <typename Tenum_t> struct TinyEnumT;

    74

    75

/** The general declaration of TinyEnumT<> (above) */

    78

{

    79

	typedef Tenum_t enum_type;                      ///< expose our enumeration type (i.e. Trackdir) to outside

    80

	typedef EnumPropsT<Tenum_t> Props;              ///< make easier access to our enumeration propeties

    81

	typedef typename Props::storage storage_type;   ///< small storage type

    82

	static const enum_type begin = Props::begin;    ///< enum beginning (i.e. TRACKDIR_BEGIN)

    83

	static const enum_type end = Props::end;        ///< enum end (i.e. TRACKDIR_END)

    84

	static const enum_type invalid = Props::invalid;///< invalid value (i.e. INVALID_TRACKDIR)

    85

    86

	storage_type m_val;  ///< here we hold the actual value in small (i.e. byte) form

    87

    88

	/** Cast operator - invoked then the value is assigned to the Tenum_t type */

    89

	FORCEINLINE operator enum_type () const

    90

	{

    91

		return (enum_type)m_val;

    92

	}

    93

    94

	/** Assignment operator (from Tenum_t type) */

    95

	FORCEINLINE TinyEnumT& operator = (enum_type e)

    96

	{

    97

		m_val = (storage_type)e; return *this;

    98

	}

    99

   100

	/** postfix ++ operator on tiny type */

   101

	FORCEINLINE TinyEnumT operator ++ (int)

   102

	{

   103

		TinyEnumT org = *this;

   104

		if (++m_val >= end) m_val -= (storage_type)(end - begin);

   105

		return org;

   106

	}

   107

   108

	/** prefix ++ operator on tiny type */

   109

	FORCEINLINE TinyEnumT& operator ++ ()

   110

	{

   111

		if (++m_val >= end) m_val -= (storage_type)(end - begin);

   112

		return *this;

   113

	}

   114

};

   115

   116

#endif /* HELPERS_HPP */