1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "variables.h"

     6

#include "macros.h"

     7

#include "oldpool.h"

     8

#include "newgrf_callbacks.h"

     9

#include "newgrf_spritegroup.h"

    10

#include "date.h"

    11

    12

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item);

    13

    14

static uint _spritegroup_count = 0;

    15

STATIC_OLD_POOL(SpriteGroup, SpriteGroup, 9, 250, NULL, SpriteGroupPoolCleanBlock)

    16

    17

static void DestroySpriteGroup(SpriteGroup *group)

    18

{

    19

	/* Free dynamically allocated memory */

    20

	/* XXX Cast away the consts due to MSVC being buggy... */

    21

	switch (group->type) {

    22

		case SGT_REAL:

    23

			free((SpriteGroup**)group->g.real.loaded);

    24

			free((SpriteGroup**)group->g.real.loading);

    25

			break;

    26

    27

		case SGT_DETERMINISTIC:

    28

			free(group->g.determ.adjusts);

    29

			free(group->g.determ.ranges);

    30

			break;

    31

    32

		case SGT_RANDOMIZED:

    33

			free((SpriteGroup**)group->g.random.groups);

    34

			break;

    35

    36

		default:

    37

			break;

    38

	}

    39

}

    40

    41

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)

    42

{

    43

	uint i;

    44

    45

	for (i = start_item; i <= end_item; i++) {

    46

		DestroySpriteGroup(GetSpriteGroup(i));

    47

	}

    48

}

    49

    50

    51

/* Allocate a new SpriteGroup */

    53

{

    54

	/* This is totally different to the other pool allocators, as we never remove an item from the pool. */

    55

	if (_spritegroup_count == GetSpriteGroupPoolSize()) {

    56

		if (!AddBlockToPool(&_SpriteGroup_pool)) return NULL;

    57

	}

    58

    59

	return GetSpriteGroup(_spritegroup_count++);

    60

}

    61

    62

    64

{

    65

	CleanPool(&_SpriteGroup_pool);

    66

    67

	_spritegroup_count = 0;

    68

}

    69

    70

    71

static inline uint32 GetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

    72

{

    73

	/* Return common variables */

    74

	switch (variable) {

    75

		case 0x00: return max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);

    76

		case 0x01: return clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;

    77

		case 0x02: return _cur_month;

    78

		case 0x03: return _opt.landscape;

    79

		case 0x09: return _date_fract;

    80

		case 0x0A: return _tick_counter;

    81

		case 0x0C: return object->callback;

    82

		case 0x10: return object->callback_param1;

    83

		case 0x11: return 0;

    84

		case 0x18: return object->callback_param2;

    85

		case 0x1A: return UINT_MAX;

    86

		case 0x1B: return GB(_display_opt, 0, 6);

    87

		case 0x1C: return object->last_value;

    88

		case 0x20: return _opt.landscape == LT_HILLY ? _opt.snow_line : 0xFF;

    89

    90

		/* Not a common variable, so evalute the feature specific variables */

    91

		default: return object->GetVariable(object, variable, parameter, available);

    92

	}

    93

}

    94

    95

    96

/* Evaluate an adjustment for a variable of the given size.

    97

* U is the unsigned type and S is the signed type to use. */

    98

template <typename U, typename S>

    99

static U EvalAdjustT(const DeterministicSpriteGroupAdjust *adjust, U last_value, uint32 value)

   100

{

   101

	value >>= adjust->shift_num;

   102

	value  &= adjust->and_mask;

   103

   104

	if (adjust->type != DSGA_TYPE_NONE) value += (S)adjust->add_val;

   105

   106

	switch (adjust->type) {

   107

		case DSGA_TYPE_DIV:  value /= (S)adjust->divmod_val; break;

   108

		case DSGA_TYPE_MOD:  value %= (U)adjust->divmod_val; break;

   109

		case DSGA_TYPE_NONE: break;

   110

	}

   111

   112

	switch (adjust->operation) {

   113

		case DSGA_OP_ADD:  return last_value + value;

   114

		case DSGA_OP_SUB:  return last_value - value;

   115

		case DSGA_OP_SMIN: return min((S)last_value, (S)value);

   116

		case DSGA_OP_SMAX: return max((S)last_value, (S)value);

   117

		case DSGA_OP_UMIN: return min((U)last_value, (U)value);

   118

		case DSGA_OP_UMAX: return max((U)last_value, (U)value);

   119

		case DSGA_OP_SDIV: return (S)last_value / (S)value;

   120

		case DSGA_OP_SMOD: return (S)last_value % (S)value;

   121

		case DSGA_OP_UDIV: return (U)last_value / (U)value;

   122

		case DSGA_OP_UMOD: return (U)last_value % (U)value;

   123

		case DSGA_OP_MUL:  return last_value * value;

   124

		case DSGA_OP_AND:  return last_value & value;

   125

		case DSGA_OP_OR:   return last_value | value;

   126

		case DSGA_OP_XOR:  return last_value ^ value;

   127

		default:           return value;

   128

	}

   129

}

   130

   131

   132

static inline const SpriteGroup *ResolveVariable(const SpriteGroup *group, ResolverObject *object)

   133

{

   134

	static SpriteGroup nvarzero;

   135

	uint32 last_value = 0;

   136

	uint32 value = 0;

   137

	uint i;

   138

   139

	object->scope = group->g.determ.var_scope;

   140

   141

	for (i = 0; i < group->g.determ.num_adjusts; i++) {

   142

		DeterministicSpriteGroupAdjust *adjust = &group->g.determ.adjusts[i];

   143

   144

		/* Try to get the variable. We shall assume it is available, unless told otherwise. */

   145

		bool available = true;

   146

		if (adjust->variable == 0x7E) {

   147

			ResolverObject subobject = *object;

   148

			const SpriteGroup *subgroup = Resolve(adjust->subroutine, &subobject);

   149

			if (subgroup == NULL || subgroup->type != SGT_CALLBACK) {

   150

				value = CALLBACK_FAILED;

   151

			} else {

   152

				value = subgroup->g.callback.result;

   153

			}

   154

		} else {

   155

			value = GetVariable(object, adjust->variable, adjust->parameter, &available);

   156

		}

   157

   158

		if (!available) {

   159

			/* Unsupported property: skip further processing and return either

   160

			 * the group from the first range or the default group. */

   161

			return Resolve(group->g.determ.num_ranges > 0 ? group->g.determ.ranges[0].group : group->g.determ.default_group, object);

   162

		}

   163

   164

		switch (group->g.determ.size) {

   165

			case DSG_SIZE_BYTE:  value = EvalAdjustT<uint8, int8>(adjust, last_value, value); break;

   166

			case DSG_SIZE_WORD:  value = EvalAdjustT<uint16, int16>(adjust, last_value, value); break;

   167

			case DSG_SIZE_DWORD: value = EvalAdjustT<uint32, int32>(adjust, last_value, value); break;

   168

			default: NOT_REACHED(); break;

   169

		}

   170

		last_value = value;

   171

	}

   172

   173

	object->last_value = last_value;

   174

   175

	if (group->g.determ.num_ranges == 0) {

   176

		/* nvar == 0 is a special case -- we turn our value into a callback result */

   177

		nvarzero.type = SGT_CALLBACK;

   178

		nvarzero.g.callback.result = GB(value, 0, 15);

   179

		return &nvarzero;

   180

	}

   181

   182

	for (i = 0; i < group->g.determ.num_ranges; i++) {

   183

		if (group->g.determ.ranges[i].low <= value && value <= group->g.determ.ranges[i].high) {

   184

			return Resolve(group->g.determ.ranges[i].group, object);

   185

		}

   186

	}

   187

   188

	return Resolve(group->g.determ.default_group, object);

   189

}

   190

   191

   192

static inline const SpriteGroup *ResolveRandom(const SpriteGroup *group, ResolverObject *object)

   193

{

   194

	uint32 mask;

   195

	byte index;

   196

   197

	object->scope = group->g.random.var_scope;

   198

   199

	if (object->trigger != 0) {

   200

		/* Handle triggers */

   201

		/* Magic code that may or may not do the right things... */

   202

		byte waiting_triggers = object->GetTriggers(object);

   203

		byte match = group->g.random.triggers & (waiting_triggers | object->trigger);

   204

		bool res;

   205

   206

		res = (group->g.random.cmp_mode == RSG_CMP_ANY) ?

   207

			(match != 0) : (match == group->g.random.triggers);

   208

   209

		if (res) {

   210

			waiting_triggers &= ~match;

   211

			object->reseed |= (group->g.random.num_groups - 1) << group->g.random.lowest_randbit;

   212

		} else {

   213

			waiting_triggers |= object->trigger;

   214

		}

   215

   216

		object->SetTriggers(object, waiting_triggers);

   217

	}

   218

   219

	mask  = (group->g.random.num_groups - 1) << group->g.random.lowest_randbit;

   220

	index = (object->GetRandomBits(object) & mask) >> group->g.random.lowest_randbit;

   221

   222

	return Resolve(group->g.random.groups[index], object);

   223

}

   224

   225

   226

/* ResolverObject (re)entry point */

   227

const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject *object)

   228

{

   229

	/* We're called even if there is no group, so quietly return nothing */

   230

	if (group == NULL) return NULL;

   231

   232

	switch (group->type) {

   233

		case SGT_REAL:          return object->ResolveReal(object, group);

   234

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   235

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   236

		default:                return group;

   237

	}

   238

}