newgrf_spritegroup.c
author Darkvater
Tue, 24 Oct 2006 13:20:54 +0000
changeset 4937 a525d56a8d40
parent 4894 079148a9eadc
child 4971 0a3653c45b5a
permissions -rw-r--r--
(svn r6924) -Codechange: Give the last (in the widget arrays at least) sprites meaningful names.
3595
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
     1
/* $Id$ */
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
     2
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
     3
#include "stdafx.h"
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
     4
#include "openttd.h"
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
     5
#include "variables.h"
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
     6
#include "macros.h"
3595
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
     7
#include "pool.h"
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
     8
#include "newgrf_spritegroup.h"
4261
2ec8f5a9747b (svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents: 3971
diff changeset
     9
#include "date.h"
3595
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    10
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    11
enum {
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    12
	SPRITEGROUP_POOL_BLOCK_SIZE_BITS = 4, /* (1 << 4) == 16 items */
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    13
	SPRITEGROUP_POOL_MAX_BLOCKS      = 8000,
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    14
};
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    15
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    16
static uint _spritegroup_count = 0;
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    17
static MemoryPool _spritegroup_pool;
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    18
4402
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    19
void DestroySpriteGroup(SpriteGroup *group)
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    20
{
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    21
	/* Free dynamically allocated memory */
4894
079148a9eadc (svn r6838) - Fix (r6836): MS VC complains beecause it doesn't understand consts... (or I don't...)
peter1138
parents: 4402
diff changeset
    22
	/* XXX Cast away the consts due to MSVC being buggy... */
4402
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    23
	switch (group->type) {
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    24
		case SGT_REAL:
4894
079148a9eadc (svn r6838) - Fix (r6836): MS VC complains beecause it doesn't understand consts... (or I don't...)
peter1138
parents: 4402
diff changeset
    25
			free((SpriteGroup**)group->g.real.loaded);
079148a9eadc (svn r6838) - Fix (r6836): MS VC complains beecause it doesn't understand consts... (or I don't...)
peter1138
parents: 4402
diff changeset
    26
			free((SpriteGroup**)group->g.real.loading);
4402
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    27
			break;
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    28
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    29
		case SGT_DETERMINISTIC:
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    30
			free(group->g.determ.adjusts);
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    31
			free(group->g.determ.ranges);
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    32
			break;
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    33
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    34
		case SGT_RANDOMIZED:
4894
079148a9eadc (svn r6838) - Fix (r6836): MS VC complains beecause it doesn't understand consts... (or I don't...)
peter1138
parents: 4402
diff changeset
    35
			free((SpriteGroup**)group->g.random.groups);
4402
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    36
			break;
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    37
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    38
		default:
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    39
			break;
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    40
	}
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    41
}
3595
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    42
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    43
static void SpriteGroupPoolCleanBlock(uint start_item, uint end_item)
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    44
{
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    45
	uint i;
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    46
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    47
	for (i = start_item; i <= end_item; i++) {
4402
05a9ad2ec919 (svn r6155) -Codechange: split Destroy routine from SpriteGroupPoolCleanBlock
truelight
parents: 4331
diff changeset
    48
		DestroySpriteGroup((SpriteGroup*)GetItemFromPool(&_spritegroup_pool, i));
3595
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    49
	}
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    50
}
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    51
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    52
/* Initialize the SpriteGroup pool */
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    53
static MemoryPool _spritegroup_pool = { "SpriteGr", SPRITEGROUP_POOL_MAX_BLOCKS, SPRITEGROUP_POOL_BLOCK_SIZE_BITS, sizeof(SpriteGroup), NULL, &SpriteGroupPoolCleanBlock, 0, 0, NULL };
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    54
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    55
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    56
/* Allocate a new SpriteGroup */
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    57
SpriteGroup *AllocateSpriteGroup(void)
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    58
{
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    59
	/* This is totally different to the other pool allocators, as we never remove an item from the pool. */
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    60
	if (_spritegroup_count == _spritegroup_pool.total_items) {
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    61
		if (!AddBlockToPool(&_spritegroup_pool)) return NULL;
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    62
	}
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    63
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    64
	return (SpriteGroup*)GetItemFromPool(&_spritegroup_pool, _spritegroup_count++);
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    65
}
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    66
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    67
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    68
void InitializeSpriteGroupPool(void)
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    69
{
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    70
	CleanPool(&_spritegroup_pool);
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    71
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    72
	_spritegroup_count = 0;
20621831cd46 (svn r4486) - NewGRF: Create and use a memory pool to manage sprite groups. This
peter1138
parents:
diff changeset
    73
}
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    74
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    75
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
    76
static inline uint32 GetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    77
{
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    78
	/* Return common variables */
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    79
	switch (variable) {
4331
11de01553605 (svn r6013) -Fix: some newgrf properties returned the date in the new format where the newgrf's expect the original format. Thanks to michi_cc for finding these and providing the initial patch.
rubidium
parents: 4322
diff changeset
    80
		case 0x00: return max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);
4322
0bee6d9bc452 (svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents: 4293
diff changeset
    81
		case 0x01: return clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    82
		case 0x02: return _cur_month;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    83
		case 0x03: return _opt.landscape;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    84
		case 0x09: return _date_fract;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    85
		case 0x0A: return _tick_counter;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    86
		case 0x0C: return object->callback;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    87
		case 0x10: return object->callback_param1;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    88
		case 0x11: return 0;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    89
		case 0x18: return object->callback_param2;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    90
		case 0x1A: return -1;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    91
		case 0x1B: return GB(_display_opt, 0, 6);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    92
		case 0x1C: return object->last_value;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    93
		case 0x20: return _opt.landscape == LT_HILLY ? _opt.snow_line : 0xFF;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    94
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    95
		/* Not a common variable, so evalute the feature specific variables */
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
    96
		default: return object->GetVariable(object, variable, parameter, available);
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    97
	}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    98
}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
    99
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   100
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   101
/* Evaluate an adjustment for a variable of the given size. This is a bit of
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   102
 * an unwieldy macro, but it saves triplicating the code. */
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   103
#define BUILD_EVAL_ADJUST(size, usize) \
3788
069d945ed860 (svn r4784) - NewGRF: shuffle the mix of signed / unsigned types when dealing with var adjusts. Fixes issues with some station layouts.
peter1138
parents: 3753
diff changeset
   104
static inline usize EvalAdjust_ ## size(const DeterministicSpriteGroupAdjust *adjust, usize last_value, int32 value) \
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   105
{ \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   106
	value >>= adjust->shift_num; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   107
	value  &= adjust->and_mask; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   108
\
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   109
	if (adjust->type != DSGA_TYPE_NONE) value += (size)adjust->add_val; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   110
\
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   111
	switch (adjust->type) { \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   112
		case DSGA_TYPE_DIV:  value /= (size)adjust->divmod_val; break; \
3788
069d945ed860 (svn r4784) - NewGRF: shuffle the mix of signed / unsigned types when dealing with var adjusts. Fixes issues with some station layouts.
peter1138
parents: 3753
diff changeset
   113
		case DSGA_TYPE_MOD:  value %= (usize)adjust->divmod_val; break; \
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   114
		case DSGA_TYPE_NONE: break; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   115
	} \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   116
\
3690
610c920b283a (svn r4616) - NewGRF: when evaluating a variable adjustment, give our value the correct type after rather than before it has been adjusted.
peter1138
parents: 3686
diff changeset
   117
	/* Get our value to the correct range */ \
3788
069d945ed860 (svn r4784) - NewGRF: shuffle the mix of signed / unsigned types when dealing with var adjusts. Fixes issues with some station layouts.
peter1138
parents: 3753
diff changeset
   118
	value = (usize)value; \
3690
610c920b283a (svn r4616) - NewGRF: when evaluating a variable adjustment, give our value the correct type after rather than before it has been adjusted.
peter1138
parents: 3686
diff changeset
   119
\
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   120
	switch (adjust->operation) { \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   121
		case DSGA_OP_ADD:  return last_value + value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   122
		case DSGA_OP_SUB:  return last_value - value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   123
		case DSGA_OP_SMIN: return min(last_value, value); \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   124
		case DSGA_OP_SMAX: return max(last_value, value); \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   125
		case DSGA_OP_UMIN: return min((usize)last_value, (usize)value); \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   126
		case DSGA_OP_UMAX: return max((usize)last_value, (usize)value); \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   127
		case DSGA_OP_SDIV: return last_value / value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   128
		case DSGA_OP_SMOD: return last_value % value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   129
		case DSGA_OP_UDIV: return (usize)last_value / (usize)value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   130
		case DSGA_OP_UMOD: return (usize)last_value % (usize)value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   131
		case DSGA_OP_MUL:  return last_value * value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   132
		case DSGA_OP_AND:  return last_value & value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   133
		case DSGA_OP_OR:   return last_value | value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   134
		case DSGA_OP_XOR:  return last_value ^ value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   135
		default:           return value; \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   136
	} \
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   137
}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   138
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   139
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   140
BUILD_EVAL_ADJUST(int8, uint8)
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   141
BUILD_EVAL_ADJUST(int16, uint16)
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   142
BUILD_EVAL_ADJUST(int32, uint32)
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   143
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   144
3686
55efe6da4dfb (svn r4611) - NewGRF: introduce new vehicle sprite group resolver code. This also fixes some known bugs (e.g. the 'Standard Five' in UKRS is now the correct colour)
peter1138
parents: 3681
diff changeset
   145
static inline const SpriteGroup *ResolveVariable(const SpriteGroup *group, ResolverObject *object)
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   146
{
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   147
	static SpriteGroup nvarzero;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   148
	int32 last_value = object->last_value;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   149
	int32 value = -1;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   150
	uint i;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   151
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   152
	object->scope = group->g.determ.var_scope;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   153
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   154
	for (i = 0; i < group->g.determ.num_adjusts; i++) {
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   155
		DeterministicSpriteGroupAdjust *adjust = &group->g.determ.adjusts[i];
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   156
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   157
		/* Try to get the variable. We shall assume it is available, unless told otherwise. */
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   158
		bool available = true;
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   159
		value = GetVariable(object, adjust->variable, adjust->parameter, &available);
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   160
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   161
		if (!available) {
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   162
			/* Unsupported property: skip further processing and return either
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   163
			 * the group from the first range or the default group. */
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   164
			return Resolve(group->g.determ.num_ranges > 0 ? group->g.determ.ranges[0].group : group->g.determ.default_group, object);
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   165
		}
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   166
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   167
		switch (group->g.determ.size) {
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   168
			case DSG_SIZE_BYTE:  value = EvalAdjust_int8(adjust, last_value, value); break;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   169
			case DSG_SIZE_WORD:  value = EvalAdjust_int16(adjust, last_value, value); break;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   170
			case DSG_SIZE_DWORD: value = EvalAdjust_int32(adjust, last_value, value); break;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   171
			default: NOT_REACHED(); break;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   172
		}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   173
		last_value = value;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   174
	}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   175
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   176
	if (group->g.determ.num_ranges == 0) {
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   177
		/* nvar == 0 is a special case -- we turn our value into a callback result */
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   178
		nvarzero.type = SGT_CALLBACK;
3942
18f75e002a09 (svn r5087) - NewGRF: Fix thinko in returning a calculated callback result
peter1138
parents: 3893
diff changeset
   179
		nvarzero.g.callback.result = GB(value, 0, 15);
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   180
		return &nvarzero;
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   181
	}
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   182
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   183
	for (i = 0; i < group->g.determ.num_ranges; i++) {
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   184
		if (group->g.determ.ranges[i].low <= (uint32)value && (uint32)value <= group->g.determ.ranges[i].high) {
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   185
			return Resolve(group->g.determ.ranges[i].group, object);
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   186
		}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   187
	}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   188
3893
46169364701b (svn r4960) - NewGRF: explicitly handle unsupported variables, instead of returning -1.
peter1138
parents: 3861
diff changeset
   189
	return Resolve(group->g.determ.default_group, object);
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   190
}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   191
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   192
3686
55efe6da4dfb (svn r4611) - NewGRF: introduce new vehicle sprite group resolver code. This also fixes some known bugs (e.g. the 'Standard Five' in UKRS is now the correct colour)
peter1138
parents: 3681
diff changeset
   193
static inline const SpriteGroup *ResolveRandom(const SpriteGroup *group, ResolverObject *object)
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   194
{
3753
aa15896bc569 (svn r4741) - NewGRF: use the correct variable type for the random bit mask
peter1138
parents: 3734
diff changeset
   195
	uint32 mask;
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   196
	byte index;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   197
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   198
	object->scope = group->g.random.var_scope;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   199
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   200
	if (object->trigger != 0) {
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   201
		/* Handle triggers */
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   202
		/* Magic code that may or may not do the right things... */
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   203
		byte waiting_triggers = object->GetTriggers(object);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   204
		byte match = group->g.random.triggers & (waiting_triggers | object->trigger);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   205
		bool res;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   206
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   207
		res = (group->g.random.cmp_mode == RSG_CMP_ANY) ?
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   208
			(match != 0) : (match == group->g.random.triggers);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   209
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   210
		if (res) {
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   211
			waiting_triggers &= ~match;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   212
			object->reseed |= (group->g.random.num_groups - 1) << group->g.random.lowest_randbit;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   213
		} else {
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   214
			waiting_triggers |= object->trigger;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   215
		}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   216
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   217
		object->SetTriggers(object, waiting_triggers);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   218
	}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   219
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   220
	mask  = (group->g.random.num_groups - 1) << group->g.random.lowest_randbit;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   221
	index = (object->GetRandomBits(object) & mask) >> group->g.random.lowest_randbit;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   222
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   223
	return Resolve(group->g.random.groups[index], object);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   224
}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   225
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   226
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   227
/* ResolverObject (re)entry point */
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   228
const SpriteGroup *Resolve(const SpriteGroup *group, ResolverObject *object)
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   229
{
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   230
	/* We're called even if there is no group, so quietly return nothing */
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   231
	if (group == NULL) return NULL;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   232
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   233
	switch (group->type) {
3734
f929883c5ae0 (svn r4714) - NewGRF: simplify evaluation of 'real' sprite groups.
peter1138
parents: 3690
diff changeset
   234
		case SGT_REAL:          return object->ResolveReal(object, group);
3677
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   235
		case SGT_DETERMINISTIC: return ResolveVariable(group, object);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   236
		case SGT_RANDOMIZED:    return ResolveRandom(group, object);
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   237
		default:                return group;
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   238
	}
cb6659a684b5 (svn r4594) - NewGRF: introduce the basic sprite group resolver. This code isn't used yet.
peter1138
parents: 3668
diff changeset
   239
}