1

/* $Id$ */

     2

     3

/** @file newgrf_spritegroup.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "landscape.h"

     9

#include "oldpool.h"

    10

#include "newgrf.h"

    11

#include "newgrf_callbacks.h"

    12

#include "newgrf_spritegroup.h"

    13

#include "sprite.h"

    14

#include "date_func.h"

    15

#include "settings_type.h"

    16

    17

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item);

    18

    19

static uint _spritegroup_count = 0;

    20

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

    21

    22

static void DestroySpriteGroup(SpriteGroup *group)

    23

{

    24

	/* Free dynamically allocated memory */

    25

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

    26

	switch (group->type) {

    27

		case SGT_REAL:

    28

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

    29

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

    30

			break;

    31

    32

		case SGT_DETERMINISTIC:

    33

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

    34

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

    35

			break;

    36

    37

		case SGT_RANDOMIZED:

    38

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

    39

			break;

    40

    41

		case SGT_TILELAYOUT:

    42

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

    43

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

    44

			break;

    45

    46

		default:

    47

			break;

    48

	}

    49

}

    50

    51

static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)

    52

{

    53

	uint i;

    54

    55

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

    56

		DestroySpriteGroup(GetSpriteGroup(i));

    57

	}

    58

}

    59

    60

    61

/* Allocate a new SpriteGroup */

    62

SpriteGroup *AllocateSpriteGroup()

    63

{

    64

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

    65

	if (_spritegroup_count == GetSpriteGroupPoolSize()) {

    66

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

    67

	}

    68

    69

	return GetSpriteGroup(_spritegroup_count++);

    70

}

    71

    72

    73

void InitializeSpriteGroupPool()

    74

{

    75

	_SpriteGroup_pool.CleanPool();

    76

    77

	_spritegroup_count = 0;

    78

}

    79

    80

TemporaryStorageArray<uint32, 0x110> _temp_store;

    81

    82

    83

static inline bool Is8BitCallback(const ResolverObject *object)

    84

{

    85

	/* Var 0x7E procedure results are always 15 bit */

    86

	if (object == NULL || object->procedure_call) return false;

    87

    88

	switch (object->callback) {

    89

		/* All these functions are 15 bit callbacks */

    90

		case CBID_STATION_SPRITE_LAYOUT:

    91

		case CBID_VEHICLE_REFIT_CAPACITY:

    92

		case CBID_HOUSE_COLOUR:

    93

		case CBID_HOUSE_CARGO_ACCEPTANCE:

    94

		case CBID_INDUSTRY_LOCATION:

    95

		case CBID_HOUSE_ACCEPT_CARGO:

    96

		case CBID_INDTILE_CARGO_ACCEPTANCE:

    97

		case CBID_INDTILE_ACCEPT_CARGO:

    98

		case CBID_VEHICLE_COLOUR_MAPPING:

    99

		case CBID_HOUSE_PRODUCE_CARGO:

   100

		case CBID_INDTILE_SHAPE_CHECK: // depends on grf version, masked to 8 bit in PerformIndustryTileSlopeCheck() if needed

   101

		case CBID_VEHICLE_SOUND_EFFECT:

   102

		case CBID_VEHICLE_MODIFY_PROPERTY: // depends on queried property

   103

		case CBID_CARGO_PROFIT_CALC:

   104

		case CBID_SOUNDS_AMBIENT_EFFECT:

   105

		case CBID_CARGO_STATION_RATING_CALC:

   106

			return false;

   107

   108

		/* The rest is a 8 bit callback, which should be truncated properly */

   109

		default:

   110

			return true;

   111

	}

   112

}

   113

   114

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

   115

{

   116

	/* First handle variables common with Action7/9/D */

   117

	uint32 value;

   118

	if (GetGlobalVariable(variable, &value)) return value;

   119

   120

	/* Non-common variable */

   121

	switch (variable) {

   122

		case 0x0C: return object->callback;

   123

		case 0x10: return object->callback_param1;

   124

		case 0x18: return object->callback_param2;

   125

		case 0x1C: return object->last_value;

   126

   127

		case 0x7D: return _temp_store.Get(parameter);

   128

   129

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

   130

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

   131

	}

   132

}

   133

   134

   135

/**

   136

 * Rotate val rot times to the right

   137

 * @param val the value to rotate

   138

 * @param rot the amount of times to rotate

   139

 * @return the rotated value

   140

 */

   141

static uint32 RotateRight(uint32 val, uint32 rot)

   142

{

   143

	/* Do not rotate more than necessary */

   144

	rot %= 32;

   145

   146

	return (val >> rot) | (val << (32 - rot));

   147

}

   148

   149

   150

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

   151

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

   152

template <typename U, typename S>

   153

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

   154

{

   155

	value >>= adjust->shift_num;

   156

	value  &= adjust->and_mask;

   157

   158

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

   159

   160

	switch (adjust->type) {

   161

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

   162

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

   163

		case DSGA_TYPE_NONE: break;

   164

	}

   165

   166

	switch (adjust->operation) {

   167

		case DSGA_OP_ADD:  return last_value + value;

   168

		case DSGA_OP_SUB:  return last_value - value;

   169

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

   170

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

   171

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

   172

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

   173

		case DSGA_OP_SDIV: return value == 0 ? (S)last_value : (S)last_value / (S)value;

   174

		case DSGA_OP_SMOD: return value == 0 ? (S)last_value : (S)last_value % (S)value;

   175

		case DSGA_OP_UDIV: return value == 0 ? (U)last_value : (U)last_value / (U)value;

   176

		case DSGA_OP_UMOD: return value == 0 ? (U)last_value : (U)last_value % (U)value;

   177

		case DSGA_OP_MUL:  return last_value * value;

   178

		case DSGA_OP_AND:  return last_value & value;

   179

		case DSGA_OP_OR:   return last_value | value;

   180

		case DSGA_OP_XOR:  return last_value ^ value;

   181

		case DSGA_OP_STO:  _temp_store.Store(value, last_value); return last_value;

   182

		case DSGA_OP_RST:  return value;

   183

		case DSGA_OP_STOP: if (object->psa != NULL) object->psa->Store(value, last_value); return last_value;

   184

		case DSGA_OP_ROR:  return RotateRight(last_value, value);

   185

		case DSGA_OP_SCMP: return ((S)last_value == (S)value) ? 1 : ((S)last_value < (S)value ? 0 : 2);

   186

		case DSGA_OP_UCMP: return ((U)last_value == (U)value) ? 1 : ((U)last_value < (U)value ? 0 : 2);

   187

		default:           return value;

   188

	}

   189

}

   190

   191

   192

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

   193

{

   194

	static SpriteGroup nvarzero;

   195

	uint32 last_value = 0;

   196

	uint32 value = 0;

   197

	uint i;

   198

   199

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

   200

   201

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

   202

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

   203

   204

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

   205

		bool available = true;

   206

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

   207

			ResolverObject subobject = *object;

   208

			subobject.procedure_call = true;

   209

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

   210

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

   211

				value = CALLBACK_FAILED;

   212

			} else {

   213

				value = subgroup->g.callback.result;

   214

			}

   215

		} else {

   216

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

   217

		}

   218

   219

		if (!available) {

   220

			/* Unsupported property: skip further processing and return either

   221

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

   222

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

   223

		}

   224

   225

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

   226

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

   227

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

   228

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

   229

			default: NOT_REACHED(); break;

   230

		}

   231

		last_value = value;

   232

	}

   233

   234

	object->last_value = last_value;

   235

   236

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

   237

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

   238

		nvarzero.type = SGT_CALLBACK;

   239

		nvarzero.g.callback.result = GB(value, 0, Is8BitCallback(object) ? 8 : 15);

   240

		return &nvarzero;

   241

	}

   242

   243

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

   244

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

   245

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

   246

		}

   247

	}

   248

   249

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

   250

}

   251

   252

   253

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

   254

{

   255

	uint32 mask;

   256

	byte index;

   257

   258

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

   259

	object->count = group->g.random.count;

   260

   261

	if (object->trigger != 0) {

   262

		/* Handle triggers */

   263

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

   264

		byte waiting_triggers = object->GetTriggers(object);

   265

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

   266

		bool res;

   267

   268

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

   269

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

   270

   271

		if (res) {

   272

			waiting_triggers &= ~match;

   273

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

   274

		} else {

   275

			waiting_triggers |= object->trigger;

   276

		}

   277

   278

		object->SetTriggers(object, waiting_triggers);

   279

	}

   280

   281

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

   282

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

   283

   284

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

   285

}

   286

   287

   288

/* ResolverObject (re)entry point */

   289

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

   290

{

   291

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

   292

	if (group == NULL) return NULL;

   293

   294

	switch (group->type) {

   295

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

   296

		case SGT_DETERMINISTIC: return ResolveVariable(group, object);

   297

		case SGT_RANDOMIZED:    return ResolveRandom(group, object);

   298

		case SGT_CALLBACK: {

   299

			if (!Is8BitCallback(object)) return group;

   300

   301

			static SpriteGroup result8bit;

   302

			result8bit.type = SGT_CALLBACK;

   303

			result8bit.g.callback.result = GB(group->g.callback.result, 0, 8);

   304

			return &result8bit;

   305

		}

   306

		default:                return group;

   307

	}

   308

}