1

/* $Id$ */

     2

     3

/** @file helpers.hpp */

     4

     5

#ifndef HELPERS_HPP

     6

#define HELPERS_HPP

     7

     8

#include "macros.h"

     9

#include "core/enum_type.hpp"

    10

    11

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

    12

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

    13

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

    14

{

    15

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

    16

	if (t_ptr == NULL && num_elements != 0) error("Out of memory. Cannot allocate %i bytes", num_elements * sizeof(T));

    17

	return t_ptr;

    18

}

    19

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

    20

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

    21

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

    22

{

    23

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

    24

	if (t_ptr == NULL && num_elements != 0) error("Out of memory. Cannot allocate %i bytes", num_elements * sizeof(T));

    25

	return t_ptr;

    26

}

    27

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

    28

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

    29

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

    30

{

    31

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

    32

	if (t_ptr == NULL && num_elements != 0) error("Out of memory. Cannot reallocate %i bytes", num_elements * sizeof(T));

    33

	return t_ptr;

    34

}

    35

    36

    37

/** type safe swap operation */

    38

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

    39

{

    40

	T t = a;

    41

	a = b;

    42

	b = t;

    43

}

    44

    45

    46

/**

    47

 * Overflow safe template for integers, i.e. integers that will never overflow

    48

 * you multiply the maximum value with 2, or add 2, or substract somethng from

    49

 * the minimum value, etc.

    50

 * @param T     the type these integers are stored with.

    51

 * @param T_MAX the maximum value for the integers.

    52

 * @param T_MIN the minimum value for the integers.

    53

 */

    54

template <class T, T T_MAX, T T_MIN>

    55

class OverflowSafeInt

    56

{

    57

private:

    58

	/** The non-overflow safe backend to store the value in. */

    59

	T m_value;

    60

public:

    61

	OverflowSafeInt() : m_value(0) { }

    62

    63

	OverflowSafeInt(const OverflowSafeInt& other) { this->m_value = other.m_value; }

    64

	OverflowSafeInt(const int64 int_)             { this->m_value = int_; }

    65

    66

	FORCEINLINE OverflowSafeInt& operator = (const OverflowSafeInt& other) { this->m_value = other.m_value; return *this; }

    67

    68

	FORCEINLINE OverflowSafeInt operator - () const { return OverflowSafeInt(-this->m_value); }

    69

    70

	/**

    71

	 * Safe implementation of addition.

    72

	 * @param other the amount to add

    73

	 * @note when the addition would yield more than T_MAX (or less than T_MIN),

    74

	 *       it will be T_MAX (respectively T_MIN).

    75

	 */

    76

	FORCEINLINE OverflowSafeInt& operator += (const OverflowSafeInt& other)

    77

	{

    78

		if ((T_MAX - abs(other.m_value)) < abs(this->m_value) &&

    79

				(this->m_value < 0) == (other.m_value < 0)) {

    80

			this->m_value = (this->m_value < 0) ? T_MIN : T_MAX ;

    81

		} else {

    82

			this->m_value += other.m_value;

    83

		}

    84

		return *this;

    85

	}

    86

    87

	/* Operators for addition and substraction */

    88

	FORCEINLINE OverflowSafeInt  operator +  (const OverflowSafeInt& other) const { OverflowSafeInt result = *this; result += other; return result; }

    89

	FORCEINLINE OverflowSafeInt  operator +  (const int              other) const { OverflowSafeInt result = *this; result += (int64)other; return result; }

    90

	FORCEINLINE OverflowSafeInt  operator +  (const uint             other) const { OverflowSafeInt result = *this; result += (int64)other; return result; }

    91

	FORCEINLINE OverflowSafeInt& operator -= (const OverflowSafeInt& other)       { return *this += (-other); }

    92

	FORCEINLINE OverflowSafeInt  operator -  (const OverflowSafeInt& other) const { OverflowSafeInt result = *this; result -= other; return result; }

    93

	FORCEINLINE OverflowSafeInt  operator -  (const int              other) const { OverflowSafeInt result = *this; result -= (int64)other; return result; }

    94

	FORCEINLINE OverflowSafeInt  operator -  (const uint             other) const { OverflowSafeInt result = *this; result -= (int64)other; return result; }

    95

    96

	FORCEINLINE OverflowSafeInt& operator ++ () { return *this += 1; }

    97

	FORCEINLINE OverflowSafeInt& operator -- () { return *this += -1; }

    98

	FORCEINLINE OverflowSafeInt operator ++ (int) { OverflowSafeInt org = *this; *this += 1; return org; }

    99

	FORCEINLINE OverflowSafeInt operator -- (int) { OverflowSafeInt org = *this; *this += -1; return org; }

   100

   101

	/**

   102

	 * Safe implementation of multiplication.

   103

	 * @param factor the factor to multiply this with.

   104

	 * @note when the multiplication would yield more than T_MAX (or less than T_MIN),

   105

	 *       it will be T_MAX (respectively T_MIN).

   106

	 */

   107

	FORCEINLINE OverflowSafeInt& operator *= (const int factor)

   108

	{

   109

		if (factor != 0 && (T_MAX / abs(factor)) < abs(this->m_value)) {

   110

			 this->m_value = ((this->m_value < 0) == (factor < 0)) ? T_MAX : T_MIN ;

   111

		} else {

   112

			this->m_value *= factor ;

   113

		}

   114

		return *this;

   115

	}

   116

   117

	/* Operators for multiplication */

   118

	FORCEINLINE OverflowSafeInt operator * (const int64  factor) const { OverflowSafeInt result = *this; result *= factor; return result; }

   119

	FORCEINLINE OverflowSafeInt operator * (const int    factor) const { OverflowSafeInt result = *this; result *= (int64)factor; return result; }

   120

	FORCEINLINE OverflowSafeInt operator * (const uint   factor) const { OverflowSafeInt result = *this; result *= (int64)factor; return result; }

   121

	FORCEINLINE OverflowSafeInt operator * (const uint16 factor) const { OverflowSafeInt result = *this; result *= (int64)factor; return result; }

   122

	FORCEINLINE OverflowSafeInt operator * (const byte   factor) const { OverflowSafeInt result = *this; result *= (int64)factor; return result; }

   123

   124

	/* Operators for division */

   125

	FORCEINLINE OverflowSafeInt& operator /= (const int              divisor)       { this->m_value /= divisor; return *this; }

   126

	FORCEINLINE OverflowSafeInt  operator /  (const OverflowSafeInt& divisor) const { OverflowSafeInt result = *this; result /= divisor.m_value; return result; }

   127

	FORCEINLINE OverflowSafeInt  operator /  (const int              divisor) const { OverflowSafeInt result = *this; result /= divisor; return result; }

   128

	FORCEINLINE OverflowSafeInt  operator /  (const uint             divisor) const { OverflowSafeInt result = *this; result /= (int)divisor; return result; }

   129

   130

	/* Operators for modulo */

   131

	FORCEINLINE OverflowSafeInt& operator %= (const int  divisor)       { this->m_value %= divisor; return *this; }

   132

	FORCEINLINE OverflowSafeInt  operator %  (const int  divisor) const { OverflowSafeInt result = *this; result %= divisor; return result; }

   133

   134

	/* Operators for shifting */

   135

	FORCEINLINE OverflowSafeInt& operator <<= (const int shift)       { this->m_value <<= shift; return *this; }

   136

	FORCEINLINE OverflowSafeInt  operator <<  (const int shift) const { OverflowSafeInt result = *this; result <<= shift; return result; }

   137

	FORCEINLINE OverflowSafeInt& operator >>= (const int shift)       { this->m_value >>= shift; return *this; }

   138

	FORCEINLINE OverflowSafeInt  operator >>  (const int shift) const { OverflowSafeInt result = *this; result >>= shift; return result; }

   139

   140

	/* Operators for (in)equality when comparing overflow safe ints */

   141

	FORCEINLINE bool operator == (const OverflowSafeInt& other) const { return this->m_value == other.m_value; }

   142

	FORCEINLINE bool operator != (const OverflowSafeInt& other) const { return !(*this == other); }

   143

	FORCEINLINE bool operator >  (const OverflowSafeInt& other) const { return this->m_value > other.m_value; }

   144

	FORCEINLINE bool operator >= (const OverflowSafeInt& other) const { return this->m_value >= other.m_value; }

   145

	FORCEINLINE bool operator <  (const OverflowSafeInt& other) const { return !(*this >= other); }

   146

	FORCEINLINE bool operator <= (const OverflowSafeInt& other) const { return !(*this > other); }

   147

   148

	/* Operators for (in)equality when comparing non-overflow safe ints */

   149

	FORCEINLINE bool operator == (const int other) const { return this->m_value == other; }

   150

	FORCEINLINE bool operator != (const int other) const { return !(*this == other); }

   151

	FORCEINLINE bool operator >  (const int other) const { return this->m_value > other; }

   152

	FORCEINLINE bool operator >= (const int other) const { return this->m_value >= other; }

   153

	FORCEINLINE bool operator <  (const int other) const { return !(*this >= other); }

   154

	FORCEINLINE bool operator <= (const int other) const { return !(*this > other); }

   155

   156

	FORCEINLINE operator int64 () const { return this->m_value; }

   157

};

   158

   159

/* Sometimes we got int64 operator OverflowSafeInt instead of vice versa. Handle that properly */

   160

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator + (int64 a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b + a; }

   161

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator - (int64 a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return -b + a; }

   162

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator * (int64 a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b * a; }

   163

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator / (int64 a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return (OverflowSafeInt<T, T_MAX, T_MIN>)a / (int)b; }

   164

   165

/* Sometimes we got int operator OverflowSafeInt instead of vice versa. Handle that properly */

   166

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator + (int   a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b + a; }

   167

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator - (int   a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return -b + a; }

   168

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator * (int   a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b * a; }

   169

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator / (int   a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return (OverflowSafeInt<T, T_MAX, T_MIN>)a / (int)b; }

   170

   171

/* Sometimes we got uint operator OverflowSafeInt instead of vice versa. Handle that properly */

   172

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator + (uint  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b + a; }

   173

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator - (uint  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return -b + a; }

   174

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator * (uint  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b * a; }

   175

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator / (uint  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return (OverflowSafeInt<T, T_MAX, T_MIN>)a / (int)b; }

   176

   177

/* Sometimes we got byte operator OverflowSafeInt instead of vice versa. Handle that properly */

   178

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator + (byte  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b + a; }

   179

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator - (byte  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return -b + a; }

   180

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator * (byte  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return b * a; }

   181

template <class T, int64 T_MAX, int64 T_MIN> FORCEINLINE OverflowSafeInt<T, T_MAX, T_MIN> operator / (byte  a, OverflowSafeInt<T, T_MAX, T_MIN> b) { return (OverflowSafeInt<T, T_MAX, T_MIN>)a / (int)b; }

   182

   183

#endif /* HELPERS_HPP */