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

/* Objective C don't like templates */

    24

#ifdef __cplusplus

    25

template <typename T>

    26

static inline T max(T a, T b)

    27

{

    28

	return a >= b ? a : b;

    29

}

    30

#endif

    31

    32

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

    33

    34

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

    35

    36

    37

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

    38

{

    39

	if (a <= min) return min;

    40

	if (a >= max) return max;

    41

	return a;

    42

}

    43

    44

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

    45

{

    46

	if (a <= min) return min;

    47

	if (a >= max) return max;

    48

	return a;

    49

}

    50

    51

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

    52

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

    53

}

    54

    55

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

    56

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

    57

}

    58

    59

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

    60

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

    61

}

    62

    63

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

    64

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

    65

}

    66

    67

/* OPT: optimized into an unsigned comparison */

    68

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

    69

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

    70

    71

    72

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

    73

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

    74

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

    75

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

    76

    77

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

    78

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

    79

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

    80

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

    81

    82

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

    83

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

    84

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

    85

    86

extern const byte _ffb_64[128];

    87

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

    88

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

    89

 * 0.

    90

 */

    91

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

    92

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

    93

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

    94

 */

    95

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

    96

    97

static inline int FindFirstBit2x64(int value)

    98

{

    99

/*

   100

	int i = 0;

   101

	if ( (byte) value == 0) {

   102

		i += 8;

   103

		value >>= 8;

   104

	}

   105

	return i + FIND_FIRST_BIT(value & 0x3F);

   106

   107

Faster ( or at least cleaner ) implementation below?

   108

*/

   109

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

   110

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

   111

	} else {

   112

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

   113

	}

   114

   115

}

   116

   117

static inline int KillFirstBit2x64(int value)

   118

{

   119

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

   120

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

   121

	} else {

   122

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

   123

	}

   124

}

   125

   126

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

   127

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

   128

   129

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

   130

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

   131

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

   132

   133

   134

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

   135

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

   136

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

   137

   138

   139

#define for_each_bit(_i, _b)            \

   140

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

   141

		if (_b & 1)

   142

   143

#define abs myabs

   144

   145

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

   146

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

   147

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

   148

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

   149

   150

   151

static inline uint16 ReadLE16Aligned(const void* x)

   152

{

   153

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

   154

}

   155

   156

static inline uint16 ReadLE16Unaligned(const void* x)

   157

{

   158

#ifdef OTTD_ALIGNMENT

   159

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

   160

#else

   161

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

   162

#endif

   163

}

   164

   165

   166

/**

   167

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

   168

 * @note Assumes a byte has 8 bits

   169

 */

   170

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

   171

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

   172

   173

/**

   174

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

   175

 * @note n must be a power of 2

   176

 */

   177

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

   178

   179

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

   180

 *  known to work for uint32.

   181

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

   182

 */

   183

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

   184

   185

#endif /* MACROS_H */