1

/* $Id$ */

     2

     3

#ifndef HELPERS_HPP

     4

#define HELPERS_HPP

     5

     6

/** @file helpers.hpp */

     7

#include "macros.h"

     8

     9

/** When allocating using malloc/calloc in C++ it is usually needed to cast the return value

    10

*  from void* to the proper pointer type. Another alternative would be MallocT<> as follows */

    11

template <typename T> FORCEINLINE T* MallocT(size_t num_elements)

    12

{

    13

	T *t_ptr = (T*)malloc(num_elements * sizeof(T));

    14

	return t_ptr;

    15

}

    16

/** When allocating using malloc/calloc in C++ it is usually needed to cast the return value

    17

*  from void* to the proper pointer type. Another alternative would be MallocT<> as follows */

    18

template <typename T> FORCEINLINE T* CallocT(size_t num_elements)

    19

{

    20

	T *t_ptr = (T*)calloc(num_elements, sizeof(T));

    21

	return t_ptr;

    22

}

    23

/** When allocating using malloc/calloc in C++ it is usually needed to cast the return value

    24

*  from void* to the proper pointer type. Another alternative would be MallocT<> as follows */

    25

template <typename T> FORCEINLINE T* ReallocT(T* t_ptr, size_t num_elements)

    26

{

    27

	t_ptr = (T*)realloc(t_ptr, num_elements * sizeof(T));

    28

	return t_ptr;

    29

}

    30

    31

    32

/** type safe swap operation */

    33

template<typename T> void Swap(T& a, T& b)

    34

{

    35

	T t = a;

    36

	a = b;

    37

	b = t;

    38

}

    39

    40

    41

/** returns the absolute value of (scalar) variable. @note assumes variable to be signed */

    42

template <typename T> static inline T myabs(T a) { return a < (T)0 ? -a : a; }

    43

/** returns the (absolute) difference between two (scalar) variables */

    44

template <typename T> static inline T delta(T a, T b) { return a < b ? b - a : a - b; }

    45

    46

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

    47

#define DECLARE_POSTFIX_INCREMENT(type) \

    48

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

    49

	{ \

    50

		type e_org = e; \

    51

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

    52

		return e_org; \

    53

	} \

    54

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

    55

	{ \

    56

		type e_org = e; \

    57

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

    58

		return e_org; \

    59

	}

    60

    61

    62

    63

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

    64

# define DECLARE_ENUM_AS_BIT_SET(mask_t) \

    65

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

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

    73

/** probably redundant enum combining operators (as we have conversion functions)

    74

 *  but the old code is full of such arithmetics */

    75

# define DECLARE_ENUM_AS_BIT_INDEX(idx_t, mask_t) \

    76

	FORCEINLINE mask_t operator << (int m, idx_t i) {return (mask_t)(m << (int)i);} \

    77

	FORCEINLINE mask_t operator << (mask_t m, int i) {return (mask_t)(((int)m) << i);} \

    78

	FORCEINLINE mask_t operator >> (mask_t m, int i) {return (mask_t)(((int)m) >> i);}

    79

    80

    81

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

    82

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

    83

 *  we will create specialization derived from MakeEnumPropsT<>.

    84

 *  i.e.:

    85

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

    86

 *  followed by:

    87

 *    typedef TinyEnumT<Track> TrackByte;

    88

 */

    89

template <typename Tenum_t> struct EnumPropsT;

    90

    91

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

    92

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

    93

 *  dedicated to one of commonly used enumeration types.

    94

 *  @param Tenum_t enumeration type that you want to describe

    95

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

    96

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

    97

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

    98

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

    99

 */

   100

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

   101

struct MakeEnumPropsT {

   102

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

   103

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

   104

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

   105

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

   106

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

   107

};

   108

   109

   110

   111

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

   112

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

   113

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

   114

	*  compiler type-checking causes errors like:

   115

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

   116

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

   117

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

   118

template <typename Tenum_t> struct TinyEnumT;

   119

   120

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

   121

template <typename Tenum_t> struct TinyEnumT

   122

{

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

   130

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

   131

   132

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

   133

	FORCEINLINE operator enum_type () const

   134

	{

   135

		return (enum_type)m_val;

   136

	}

   137

   138

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

   139

	FORCEINLINE TinyEnumT& operator = (enum_type e)

   140

	{

   141

		m_val = (storage_type)e; return *this;

   142

	}

   143

   144

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

   145

	FORCEINLINE TinyEnumT& operator ++ (int)

   146

	{

   147

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

   148

		return *this;

   149

	}

   150

};

   151

   152

template <typename T> void ClrBitT(T &t, int bit_index)

   153

{

   154

	t = (T)(t & ~((T)1 << bit_index));

   155

}

   156

   157

template <typename T> void SetBitT(T &t, int bit_index)

   158

{

   159

	t = (T)(t | ((T)1 << bit_index));

   160

}

   161

   162

template <typename T> void ToggleBitT(T &t, int bit_index)

   163

{

   164

	t = (T)(t ^ ((T)1 << bit_index));

   165

}

   166

   167

/**

   168

* Zero initialization end marker.

   169

* @see ZeroInitBegin for usage.

   170

*/

   171

struct ZeroInitEnd {

   172

};

   173

   174

/**

   175

 * Zero initialization begin marker. When you need to initialize struct/class members by

   176

 * memset(&m_first_member, 0, ((byte*)&m_last_member) - ((byte*)&m_first_member + sizeof(m_last_member));

   177

 * place ZeroInitBegin before m_first_member, place ZeroInitEnd after m_last_member, call ZeroInitBegin

   178

 * constructor give him ZeroInitEnd& as parameter. This will clear whole area between them using memset.

   179

 * @see ZeroInitEnd

   180

 */

   181

struct ZeroInitBegin {

   182

	ZeroInitBegin(const ZeroInitEnd &end)

   183

	{

   184

		memset(this, 0, ((byte*)&end) - ((byte*)this));

   185

	}

   186

};

   187

   188

#endif /* HELPERS_HPP */