1

/* $Id$ */

     2

     3

#ifndef MACROS_H

     4

#define MACROS_H

     5

     6

#include "map.h"

     7

     8

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

     9

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

    10

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

    11

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

    12

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

    13

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

    14

    15

#ifdef min

    16

#undef min

    17

#endif

    18

    19

#ifdef max

    20

#undef max

    21

#endif

    22

    23

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

    24

static inline int max(int a, int b) { if (a >= b) return a; return b; }

    25

static inline int64 max64(int64 a, int64 b) { if (a >= b) return a; return b; }

    26

    27

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

    28

static inline uint maxu(uint a, uint b) { if (a >= b) return a; return b; }

    29

    30

    31

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

    32

{

    33

	if (a <= min) return min;

    34

	if (a >= max) return max;

    35

	return a;

    36

}

    37

    38

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

    39

{

    40

	if (a <= min) return min;

    41

	if (a >= max) return max;

    42

	return a;

    43

}

    44

    45

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

    46

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

    47

}

    48

    49

static inline int64 BIGMULSS64(int64 a, int64 b, int shift) {

    50

	return ((a) * (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

    66

#define HASBIT(x,y)    (((x) & (1 << (y))) != 0)

    67

#define SETBIT(x,y)    ((x) |=  (1 << (y)))

    68

#define CLRBIT(x,y)    ((x) &= ~(1 << (y)))

    69

#define TOGGLEBIT(x,y) ((x) ^=  (1 << (y)))

    70

    71

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

    72

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

    73

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

    74

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

    75

    76

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

    77

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

    78

#define SPRITE_PALETTE(x) ((x) | PALETTE_MODIFIER_COLOR)

    79

    80

extern const byte _ffb_64[128];

    81

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

    82

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

    83

 * 0.

    84

 */

    85

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

    86

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

    87

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

    88

 */

    89

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

    90

    91

static inline int FindFirstBit2x64(int value)

    92

{

    93

/*

    94

	int i = 0;

    95

	if ( (byte) value == 0) {

    96

		i += 8;

    97

		value >>= 8;

    98

	}

    99

	return i + FIND_FIRST_BIT(value & 0x3F);

   100

   101

Faster ( or at least cleaner ) implementation below?

   102

*/

   103

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

   104

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

   105

	} else {

   106

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

   107

	}

   108

   109

}

   110

   111

static inline int KillFirstBit2x64(int value)

   112

{

   113

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

   114

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

   115

	} else {

   116

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

   117

	}

   118

}

   119

   120

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

   121

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

   122

   123

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

   124

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

   125

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

   126

   127

   128

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

   129

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

   130

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

   131

   132

   133

#define for_each_bit(_i, _b)            \

   134

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

   135

		if (_b & 1)

   136

   137

#define abs myabs

   138

   139

   140

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

   141

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

   142

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

   143

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

   144

   145

static inline int myabs(int a) { if (a<0) a = -a; return a; }

   146

static inline int64 myabs64(int64 a) { if (a<0) a = -a; return a; }

   147

   148

static inline void swap_byte(byte *a, byte *b) { byte t = *a; *a = *b; *b = t; }

   149

static inline void swap_uint16(uint16 *a, uint16 *b) { uint16 t = *a; *a = *b; *b = t; }

   150

static inline void swap_int16(int16 *a, int16 *b) { int16 t = *a; *a = *b; *b = t; }

   151

static inline void swap_uint32(uint32 *a, uint32 *b) { uint32 t = *a; *a = *b; *b = t; }

   152

static inline void swap_int32(int32 *a, int32 *b) { int32 t = *a; *a = *b; *b = t; }

   153

static inline void swap_tile(TileIndex *a, TileIndex *b) { TileIndex t = *a; *a = *b; *b = t; }

   154

   155

   156

static inline uint16 ReadLE16Aligned(const void* x)

   157

{

   158

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

   159

}

   160

   161

static inline uint16 ReadLE16Unaligned(const void* x)

   162

{

   163

#ifdef OTTD_ALIGNMENT

   164

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

   165

#else

   166

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

   167

#endif

   168

}

   169

   170

   171

/**

   172

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

   173

 * @note Assumes a byte has 8 bits

   174

 */

   175

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

   176

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

   177

   178

/**

   179

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

   180

 * @note n must be a power of 2

   181

 */

   182

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

   183

   184

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

   185

 *  known to work for uint32.

   186

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

   187

 */

   188

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

   189

   190

#endif /* MACROS_H */