1

/* $Id$ */

     2

     3

#ifndef MACROS_H

     4

#define MACROS_H

     5

     6

/// Fetch n bits starting at bit s from x

     7

#define GB(x, s, n) (((x) >> (s)) & ((1U << (n)) - 1))

     8

/// Set n bits starting at bit s in x to d

     9

#define SB(x, s, n, d) ((x) = ((x) & ~(((1U << (n)) - 1) << (s))) | ((d) << (s)))

    10

/// Add i to the n bits starting at bit s in x

    11

#define AB(x, s, n, i) ((x) = ((x) & ~(((1U << (n)) - 1) << (s))) | (((x) + ((i) << (s))) & (((1U << (n)) - 1) << (s))))

    12

    13

#ifdef min

    14

#undef min

    15

#endif

    16

    17

#ifdef max

    18

#undef max

    19

#endif

    20

    21

/* Objective C don't like templates */

    22

#ifdef __cplusplus

    23

template <typename T>

    24

static inline T max(T a, T b)

    25

{

    26

	return a >= b ? a : b;

    27

}

    28

#endif

    29

    30

static inline int min(int a, int b) { if (a <= b) return a; return b; }

    31

    32

static inline uint minu(uint a, uint b) { if (a <= b) return a; return b; }

    33

    34

    35

static inline int clamp(int a, int min, int max)

    36

{

    37

	if (a <= min) return min;

    38

	if (a >= max) return max;

    39

	return a;

    40

}

    41

    42

static inline uint clampu(uint a, uint min, uint max)

    43

{

    44

	if (a <= min) return min;

    45

	if (a >= max) return max;

    46

	return a;

    47

}

    48

    49

static inline int32 BIGMULSS(int32 a, int32 b, int shift) {

    50

	return (int32)(((int64)(a) * (int64)(b)) >> (shift));

    51

}

    52

    53

static inline uint32 BIGMULUS(uint32 a, uint32 b, int shift) {

    54

	return (uint32)(((uint64)(a) * (uint64)(b)) >> (shift));

    55

}

    56

    57

static inline int64 BIGMULS(int32 a, int32 b) {

    58

	return (int64)(a) * (int64)(b);

    59

}

    60

    61

/* OPT: optimized into an unsigned comparison */

    62

//#define IS_INSIDE_1D(x, base, size) ((x) >= (base) && (x) < (base) + (size))

    63

#define IS_INSIDE_1D(x, base, size) ( (uint)((x) - (base)) < ((uint)(size)) )

    64

    65

template <typename T>

    66

static inline bool HASBIT(T x, int y)

    67

{

    68

	return (x & (((T)1) << y)) != 0;

    69

}

    70

    71

template <typename T>

    72

static inline T SETBIT(T& x, int y)

    73

{

    74

	return x |= (((T)1) << y);

    75

}

    76

    77

template <typename T>

    78

static inline T CLRBIT(T& x, int y)

    79

{

    80

	return x &= ~(((T)1) << y);

    81

}

    82

    83

template <typename T>

    84

static inline T TOGGLEBIT(T& x, int y)

    85

{

    86

	return x ^= (((T)1) << y);

    87

}

    88

    89

    90

// checking more bits. Maybe unneccessary, but easy to use

    91

#define HASBITS(x,y) ((x) & (y))

    92

#define SETBITS(x,y) ((x) |= (y))

    93

#define CLRBITS(x,y) ((x) &= ~(y))

    94

    95

#define GENERAL_SPRITE_COLOR(color) ((color) + PALETTE_RECOLOR_START)

    96

#define PLAYER_SPRITE_COLOR(owner) (GENERAL_SPRITE_COLOR(_player_colors[owner]))

    97

    98

extern const byte _ffb_64[128];

    99

/* Returns the position of the first bit that is not zero, counted from the

   100

 * left. Ie, 10110100 returns 2, 00000001 returns 0, etc. When x == 0 returns

   101

 * 0.

   102

 */

   103

#define FIND_FIRST_BIT(x) _ffb_64[(x)]

   104

/* Returns x with the first bit that is not zero, counted from the left, set

   105

 * to zero. So, 10110100 returns 10110000, 00000001 returns 00000000, etc.

   106

 */

   107

#define KILL_FIRST_BIT(x) _ffb_64[(x)+64]

   108

   109

static inline int FindFirstBit2x64(int value)

   110

{

   111

/*

   112

	int i = 0;

   113

	if ( (byte) value == 0) {

   114

		i += 8;

   115

		value >>= 8;

   116

	}

   117

	return i + FIND_FIRST_BIT(value & 0x3F);

   118

   119

Faster ( or at least cleaner ) implementation below?

   120

*/

   121

	if (GB(value, 0, 8) == 0) {

   122

		return FIND_FIRST_BIT(GB(value, 8, 6)) + 8;

   123

	} else {

   124

		return FIND_FIRST_BIT(GB(value, 0, 6));

   125

	}

   126

   127

}

   128

   129

static inline int KillFirstBit2x64(int value)

   130

{

   131

	if (GB(value, 0, 8) == 0) {

   132

		return KILL_FIRST_BIT(GB(value, 8, 6)) << 8;

   133

	} else {

   134

		return value & (KILL_FIRST_BIT(GB(value, 0, 6)) | 0x3F00);

   135

	}

   136

}

   137

   138

/** returns true if value a has only one bit set to 1 */

   139

#define HAS_SINGLE_BIT(a) ( ((a) & ((a) - 1)) == 0)

   140

   141

/* [min,max), strictly less than */

   142

#define IS_BYTE_INSIDE(a,min,max) ((byte)((a)-(min)) < (byte)((max)-(min)))

   143

#define IS_INT_INSIDE(a,min,max) ((uint)((a)-(min)) < (uint)((max)-(min)))

   144

   145

   146

#define CHANCE16(a,b) ((uint16)Random() <= (uint16)((65536 * (a)) / (b)))

   147

#define CHANCE16R(a,b,r) ((uint16)(r=Random()) <= (uint16)((65536 * (a)) / (b)))

   148

#define CHANCE16I(a,b,v) ((uint16)(v) <= (uint16)((65536 * (a)) / (b)))

   149

   150

   151

#define for_each_bit(_i, _b)            \

   152

	for (_i = 0; _b != 0; _i++, _b >>= 1) \

   153

		if (_b & 1)

   154

   155

#define abs myabs

   156

   157

static inline int intxchg_(int *a, int b) { int t = *a; *a = b; return t; }

   158

#define intswap(a,b) ((b) = intxchg_(&(a), (b)))

   159

static inline int uintxchg_(uint *a, uint b) { uint t = *a; *a = b; return t; }

   160

#define uintswap(a,b) ((b) = uintxchg_(&(a), (b)))

   161

   162

   163

static inline uint16 ReadLE16Aligned(const void* x)

   164

{

   165

	return FROM_LE16(*(const uint16*)x);

   166

}

   167

   168

static inline uint16 ReadLE16Unaligned(const void* x)

   169

{

   170

#ifdef OTTD_ALIGNMENT

   171

	return ((const byte*)x)[0] | ((const byte*)x)[1] << 8;

   172

#else

   173

	return FROM_LE16(*(const uint16*)x);

   174

#endif

   175

}

   176

   177

   178

/**

   179

 * ROtate x Left/Right by n (must be >= 0)

   180

 * @note Assumes a byte has 8 bits

   181

 */

   182

#define ROL(x, n) ((x) << (n) | (x) >> (sizeof(x) * 8 - (n)))

   183

#define ROR(x, n) ((x) >> (n) | (x) << (sizeof(x) * 8 - (n)))

   184

   185

/**

   186

 * Return the smallest multiple of n equal or greater than x

   187

 * @note n must be a power of 2

   188

 */

   189

#define ALIGN(x, n) (((x) + (n) - 1) & ~((n) - 1))

   190

   191

/** return the largest value that can be entered in a variable.

   192

 *  known to work for uint32.

   193

 *  used by TGP to set the max value of the _patches.generation_seed in its definition

   194

 */

   195

#define MAX_UVALUE(type) ((type)~(type)0)

   196

   197

#endif /* MACROS_H */