1

/* $Id$ */

     2

     3

/** @file newgrf_spritegroup.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "macros.h"

     9

#include "landscape.h"

    10

#include "oldpool.h"

    11

#include "newgrf_callbacks.h"

    12

#include "newgrf_spritegroup.h"

    13

#include "date.h"

    14

#include "sprite.h"

    15

    16

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item);

    17

    18

static uint _spritegroup_count = 0;

    19

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

    20

    21

static void DestroySpriteGroup(SpriteGroup *group)

    22

{

    23

	/* Free dynamically allocated memory */

    24

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

    25

	switch (group->type) {

    26

		case SGT_REAL:

    27

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

    28

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

    29

			break;

    30

    31

		case SGT_DETERMINISTIC:

    32

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

    33

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

    34

			break;

    35

    36

		case SGT_RANDOMIZED:

    37

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

    38

			break;

    39

    40

		case SGT_TILELAYOUT:

    41

			free((void*)group->g.layout.dts->seq);

    42

			free(group->g.layout.dts);

    43

			break;

    44

    45

		default:

    46

			break;

    47

	}

    48

}

    49

    50

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)

    51

{

    52

	uint i;

    53

    54

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

    55

		DestroySpriteGroup(GetSpriteGroup(i));

    56

	}

    57

}

    58

    59

    60

/* Allocate a new SpriteGroup */

    61

SpriteGroup *AllocateSpriteGroup()

    62

{

    63

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

    64

	if (_spritegroup_count == GetSpriteGroupPoolSize()) {

    65

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

    66

	}

    67

    68

	return GetSpriteGroup(_spritegroup_count++);

    69

}

    70

    71

    72

void InitializeSpriteGroupPool()

    73

{

    74

	CleanPool(&_SpriteGroup_pool);

    75

    76

	_spritegroup_count = 0;

    77

}

    78

    81

    82

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

    83

{

    84

	/* Return common variables */

    85

	switch (variable) {

    86

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

    87

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

    88

		case 0x02: return _cur_month;

    89

		case 0x03: return _opt.landscape;

    90

		case 0x09: return _date_fract;

    91

		case 0x0A: return _tick_counter;

    92

		case 0x0C: return object->callback;

    93

		case 0x10: return object->callback_param1;

    94

		case 0x11: return 0;

    95

		case 0x18: return object->callback_param2;

    96

		case 0x1A: return UINT_MAX;

    97

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

    98

		case 0x1C: return object->last_value;

    99

		case 0x20: return _opt.landscape == LT_ARCTIC ? GetSnowLine() : 0xFF;

   100

   103

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

   104

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

   105

	}

   106

}

   107

   108

   109

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

   110

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

   111

template <typename U, typename S>

   112

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

   113

{

   114

	value >>= adjust->shift_num;

   115

	value  &= adjust->and_mask;

   116

   117

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

   118

   119

	switch (adjust->type) {

   120

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

   121

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

   122

		case DSGA_TYPE_NONE: break;

   123

	}

   124

   125

	switch (adjust->operation) {

   126

		case DSGA_OP_ADD:  return last_value + value;

   127

		case DSGA_OP_SUB:  return last_value - value;

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

		case DSGA_OP_MUL:  return last_value * value;

   137

		case DSGA_OP_AND:  return last_value & value;

   138

		case DSGA_OP_OR:   return last_value | value;

   139

		case DSGA_OP_XOR:  return last_value ^ value;

   144

		default:           return value;

   145

	}

   146

}

   147

   148

   149

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

   150

{

   151

	static SpriteGroup nvarzero;

   152

	uint32 last_value = 0;

   153

	uint32 value = 0;

   154

	uint i;

   155

   156

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

   157

   158

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

   159

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

   160

   161

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

   162

		bool available = true;

   163

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

   164

			ResolverObject subobject = *object;

   165

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

   166

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

   167

				value = CALLBACK_FAILED;

   168

			} else {

   169

				value = subgroup->g.callback.result;

   170

			}

   171

		} else {

   172

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

   173

		}

   174

   175

		if (!available) {

   176

			/* Unsupported property: skip further processing and return either

   177

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

   178

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

   179

		}

   180

   181

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

   182

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

   183

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

   184

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

   185

			default: NOT_REACHED(); break;

   186

		}

   187

		last_value = value;

   188

	}

   189

   190

	object->last_value = last_value;

   191

   192

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

   193

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

   194

		nvarzero.type = SGT_CALLBACK;

   195

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

   196

		return &nvarzero;

   197

	}

   198

   199

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

   200

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

   201

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

   202

		}

   203

	}

   204

   205

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

   206

}

   207

   208

   209

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

   210

{

   211

	uint32 mask;

   212

	byte index;

   213

   214

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

   215

   216

	if (object->trigger != 0) {

   217

		/* Handle triggers */

   218

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

   219

		byte waiting_triggers = object->GetTriggers(object);

   220

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

   221

		bool res;

   222

   223

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

   224

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

   225

   226

		if (res) {

   227

			waiting_triggers &= ~match;

   228

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

   229

		} else {

   230

			waiting_triggers |= object->trigger;

   231

		}

   232

   233

		object->SetTriggers(object, waiting_triggers);

   234

	}

   235

   236

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

   237

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

   238

   239

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

   240

}

   241

   242

   243

/* ResolverObject (re)entry point */

   244

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

   245

{

   246

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

   247

	if (group == NULL) return NULL;

   248

   249

	switch (group->type) {

   250

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

   251

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   252

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   253

		default:                return group;

   254

	}

   255

}