1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "variables.h"

     6

#include "macros.h"

     8

#include "oldpool.h"

     9

#include "newgrf_callbacks.h"

    10

#include "newgrf_spritegroup.h"

    11

#include "date.h"

    12

#include "sprite.h"

    13

    14

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item);

    15

    16

static uint _spritegroup_count = 0;

    17

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

    18

    19

static void DestroySpriteGroup(SpriteGroup *group)

    20

{

    21

	/* Free dynamically allocated memory */

    22

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

    23

	switch (group->type) {

    24

		case SGT_REAL:

    25

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

    26

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

    27

			break;

    28

    29

		case SGT_DETERMINISTIC:

    30

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

    31

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

    32

			break;

    33

    34

		case SGT_RANDOMIZED:

    35

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

    36

			break;

    37

    38

		case SGT_TILELAYOUT:

    39

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

    40

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

    41

			break;

    42

    43

		default:

    44

			break;

    45

	}

    46

}

    47

    48

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)

    49

{

    50

	uint i;

    51

    52

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

    53

		DestroySpriteGroup(GetSpriteGroup(i));

    54

	}

    55

}

    56

    57

    58

/* Allocate a new SpriteGroup */

    59

SpriteGroup *AllocateSpriteGroup()

    60

{

    61

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

    62

	if (_spritegroup_count == GetSpriteGroupPoolSize()) {

    63

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

    64

	}

    65

    66

	return GetSpriteGroup(_spritegroup_count++);

    67

}

    68

    69

    70

void InitializeSpriteGroupPool()

    71

{

    72

	CleanPool(&_SpriteGroup_pool);

    73

    74

	_spritegroup_count = 0;

    75

}

    76

    77

    78

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

    79

{

    80

	/* Return common variables */

    81

	switch (variable) {

    82

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

    83

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

    84

		case 0x02: return _cur_month;

    85

		case 0x03: return _opt.landscape;

    86

		case 0x09: return _date_fract;

    87

		case 0x0A: return _tick_counter;

    88

		case 0x0C: return object->callback;

    89

		case 0x10: return object->callback_param1;

    90

		case 0x11: return 0;

    91

		case 0x18: return object->callback_param2;

    92

		case 0x1A: return UINT_MAX;

    93

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

    94

		case 0x1C: return object->last_value;

    96

    97

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

    98

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

    99

	}

   100

}

   101

   102

   103

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

   104

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

   105

template <typename U, typename S>

   106

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

   107

{

   108

	value >>= adjust->shift_num;

   109

	value  &= adjust->and_mask;

   110

   111

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

   112

   113

	switch (adjust->type) {

   114

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

   115

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

   116

		case DSGA_TYPE_NONE: break;

   117

	}

   118

   119

	switch (adjust->operation) {

   120

		case DSGA_OP_ADD:  return last_value + value;

   121

		case DSGA_OP_SUB:  return last_value - value;

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

		case DSGA_OP_MUL:  return last_value * value;

   131

		case DSGA_OP_AND:  return last_value & value;

   132

		case DSGA_OP_OR:   return last_value | value;

   133

		case DSGA_OP_XOR:  return last_value ^ value;

   134

		default:           return value;

   135

	}

   136

}

   137

   138

   139

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

   140

{

   141

	static SpriteGroup nvarzero;

   142

	uint32 last_value = 0;

   143

	uint32 value = 0;

   144

	uint i;

   145

   146

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

   147

   148

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

   149

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

   150

   151

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

   152

		bool available = true;

   153

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

   154

			ResolverObject subobject = *object;

   155

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

   156

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

   157

				value = CALLBACK_FAILED;

   158

			} else {

   159

				value = subgroup->g.callback.result;

   160

			}

   161

		} else {

   162

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

   163

		}

   164

   165

		if (!available) {

   166

			/* Unsupported property: skip further processing and return either

   167

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

   168

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

   169

		}

   170

   171

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

   172

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

   173

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

   174

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

   175

			default: NOT_REACHED(); break;

   176

		}

   177

		last_value = value;

   178

	}

   179

   180

	object->last_value = last_value;

   181

   182

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

   183

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

   184

		nvarzero.type = SGT_CALLBACK;

   185

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

   186

		return &nvarzero;

   187

	}

   188

   189

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

   190

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

   191

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

   192

		}

   193

	}

   194

   195

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

   196

}

   197

   198

   199

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

   200

{

   201

	uint32 mask;

   202

	byte index;

   203

   204

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

   205

   206

	if (object->trigger != 0) {

   207

		/* Handle triggers */

   208

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

   209

		byte waiting_triggers = object->GetTriggers(object);

   210

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

   211

		bool res;

   212

   213

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

   214

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

   215

   216

		if (res) {

   217

			waiting_triggers &= ~match;

   218

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

   219

		} else {

   220

			waiting_triggers |= object->trigger;

   221

		}

   222

   223

		object->SetTriggers(object, waiting_triggers);

   224

	}

   225

   226

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

   227

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

   228

   229

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

   230

}

   231

   232

   233

/* ResolverObject (re)entry point */

   234

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

   235

{

   236

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

   237

	if (group == NULL) return NULL;

   238

   239

	switch (group->type) {

   240

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

   241

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   242

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   243

		default:                return group;

   244

	}

   245

}