1

/* $Id$ */

     2

     3

/** @file newgrf_spritegroup.h */

     4

     5

#ifndef NEWGRF_SPRITEGROUP_H

     6

#define NEWGRF_SPRITEGROUP_H

     7

     8

#include "town_type.h"

     9

#include "industry_type.h"

    10

#include "newgrf_storage.h"

    11

#include "core/bitmath_func.hpp"

    12

#include "gfx_type.h"

    13

#include "newgrf_generic.h"

    14

    15

/**

    16

 * Gets the value of a so-called newgrf "register".

    17

 * @param i index of the register

    18

 * @pre i < 0x110

    19

 * @return the value of the register

    20

 */

    21

static inline uint32 GetRegister(uint i)

    22

{

    23

	extern TemporaryStorageArray<uint32, 0x110> _temp_store;

    24

	return _temp_store.Get(i);

    25

}

    26

    27

struct SpriteGroup;

    28

    29

    30

/* 'Real' sprite groups contain a list of other result or callback sprite

    31

 * groups. */

    32

struct RealSpriteGroup {

    33

	/* Loaded = in motion, loading = not moving

    34

	 * Each group contains several spritesets, for various loading stages */

    35

    36

	/* XXX: For stations the meaning is different - loaded is for stations

    37

	 * with small amount of cargo whilst loading is for stations with a lot

    38

	 * of da stuff. */

    39

    40

	byte num_loaded;       ///< Number of loaded groups

    41

	byte num_loading;      ///< Number of loading groups

    42

	const SpriteGroup **loaded;  ///< List of loaded groups (can be SpriteIDs or Callback results)

    43

	const SpriteGroup **loading; ///< List of loading groups (can be SpriteIDs or Callback results)

    44

};

    45

    46

/* Shared by deterministic and random groups. */

    47

enum VarSpriteGroupScope {

    48

	VSG_SCOPE_SELF,

    49

	/* Engine of consists for vehicles, city for stations. */

    50

	VSG_SCOPE_PARENT,

    51

};

    52

    53

enum DeterministicSpriteGroupSize {

    54

	DSG_SIZE_BYTE,

    55

	DSG_SIZE_WORD,

    56

	DSG_SIZE_DWORD,

    57

};

    58

    59

enum DeterministicSpriteGroupAdjustType {

    60

	DSGA_TYPE_NONE,

    61

	DSGA_TYPE_DIV,

    62

	DSGA_TYPE_MOD,

    63

};

    64

    65

enum DeterministicSpriteGroupAdjustOperation {

    66

	DSGA_OP_ADD,  ///< a + b

    67

	DSGA_OP_SUB,  ///< a - b

    68

	DSGA_OP_SMIN, ///< (signed) min(a, b)

    69

	DSGA_OP_SMAX, ///< (signed) max(a, b)

    70

	DSGA_OP_UMIN, ///< (unsigned) min(a, b)

    71

	DSGA_OP_UMAX, ///< (unsigned) max(a, b)

    72

	DSGA_OP_SDIV, ///< (signed) a / b

    73

	DSGA_OP_SMOD, ///< (signed) a % b

    74

	DSGA_OP_UDIV, ///< (unsigned) a / b

    75

	DSGA_OP_UMOD, ///< (unsigned) a & b

    76

	DSGA_OP_MUL,  ///< a * b

    77

	DSGA_OP_AND,  ///< a & b

    78

	DSGA_OP_OR,   ///< a | b

    79

	DSGA_OP_XOR,  ///< a ^ b

    80

	DSGA_OP_STO,  ///< store a into temporary storage, indexed by b. return a

    81

	DSGA_OP_RST,  ///< return b

    82

	DSGA_OP_STOP, ///< store a into persistent storage, indexed by b, return a

    83

	DSGA_OP_ROR,  ///< rotate a b positions to the right

    84

	DSGA_OP_SCMP, ///< (signed) comparision (a < b -> 0, a == b = 1, a > b = 2)

    85

	DSGA_OP_UCMP, ///< (unsigned) comparision (a < b -> 0, a == b = 1, a > b = 2)

    86

};

    87

    88

    89

struct DeterministicSpriteGroupAdjust {

    90

	DeterministicSpriteGroupAdjustOperation operation;

    91

	DeterministicSpriteGroupAdjustType type;

    92

	byte variable;

    93

	byte parameter; ///< Used for variables between 0x60 and 0x7F inclusive.

    94

	byte shift_num;

    95

	uint32 and_mask;

    96

	uint32 add_val;

    97

	uint32 divmod_val;

    98

	const SpriteGroup *subroutine;

    99

};

   100

   101

   102

struct DeterministicSpriteGroupRange {

   103

	const SpriteGroup *group;

   104

	uint32 low;

   105

	uint32 high;

   106

};

   107

   108

   109

struct DeterministicSpriteGroup {

   110

	VarSpriteGroupScope var_scope;

   111

	DeterministicSpriteGroupSize size;

   112

	byte num_adjusts;

   113

	byte num_ranges;

   114

	DeterministicSpriteGroupAdjust *adjusts;

   115

	DeterministicSpriteGroupRange *ranges; // Dynamically allocated

   116

   117

	/* Dynamically allocated, this is the sole owner */

   118

	const SpriteGroup *default_group;

   119

};

   120

   121

enum RandomizedSpriteGroupCompareMode {

   122

	RSG_CMP_ANY,

   123

	RSG_CMP_ALL,

   124

};

   125

   126

struct RandomizedSpriteGroup {

   127

	VarSpriteGroupScope var_scope;  ///< Take this object:

   128

   129

	RandomizedSpriteGroupCompareMode cmp_mode; ///< Check for these triggers:

   130

	byte triggers;

   131

   132

	byte lowest_randbit; ///< Look for this in the per-object randomized bitmask:

   133

	byte num_groups; ///< must be power of 2

   134

   135

	const SpriteGroup **groups; ///< Take the group with appropriate index:

   136

};

   137

   138

   139

/* This contains a callback result. A failed callback has a value of

   140

 * CALLBACK_FAILED */

   141

struct CallbackResultSpriteGroup {

   142

	uint16 result;

   143

};

   144

   145

   146

/* A result sprite group returns the first SpriteID and the number of

   147

 * sprites in the set */

   148

struct ResultSpriteGroup {

   149

	SpriteID sprite;

   150

	byte num_sprites;

   151

};

   152

   153

struct TileLayoutSpriteGroup {

   154

	byte num_sprites; ///< Number of sprites in the spriteset, used for loading stages

   155

	struct DrawTileSprites *dts;

   156

};

   157

   158

struct IndustryProductionSpriteGroup {

   159

	uint8 version;

   160

	uint16 substract_input[3];

   161

	uint16 add_output[2];

   162

	uint8 again;

   163

};

   164

   165

/* List of different sprite group types */

   166

enum SpriteGroupType {

   167

	SGT_INVALID,

   168

	SGT_REAL,

   169

	SGT_DETERMINISTIC,

   170

	SGT_RANDOMIZED,

   171

	SGT_CALLBACK,

   172

	SGT_RESULT,

   173

	SGT_TILELAYOUT,

   174

	SGT_INDUSTRY_PRODUCTION,

   175

};

   176

   177

/* Common wrapper for all the different sprite group types */

   178

struct SpriteGroup {

   179

	SpriteGroupType type;

   180

   181

	union {

   182

		RealSpriteGroup real;

   183

		DeterministicSpriteGroup determ;

   184

		RandomizedSpriteGroup random;

   185

		CallbackResultSpriteGroup callback;

   186

		ResultSpriteGroup result;

   187

		TileLayoutSpriteGroup layout;

   188

		IndustryProductionSpriteGroup indprod;

   189

	} g;

   190

};

   191

   192

   193

SpriteGroup *AllocateSpriteGroup();

   194

void InitializeSpriteGroupPool();

   195

   196

   197

struct ResolverObject {

   198

	CallbackID callback;

   199

	uint32 callback_param1;

   200

	uint32 callback_param2;

   201

	bool procedure_call; ///< true if we are currently resolving a var 0x7E procedure result.

   202

   203

	byte trigger;

   204

	uint32 last_value;

   205

	uint32 reseed;

   206

	VarSpriteGroupScope scope;

   207

   208

	bool info_view; ///< Indicates if the item is being drawn in an info window

   209

   210

	BaseStorageArray *psa; ///< The persistent storage array of this resolved object.

   211

   212

	union {

   213

		struct {

   214

			const struct Vehicle *self;

   215

			const struct Vehicle *parent;

   216

			EngineID self_type;

   217

		} vehicle;

   218

		struct {

   219

			TileIndex tile;

   220

		} canal;

   221

		struct {

   222

			TileIndex tile;

   223

			const struct Station *st;

   224

			const struct StationSpec *statspec;

   225

			CargoID cargo_type;

   226

		} station;

   227

		struct {

   228

			TileIndex tile;

   229

			Town *town;

   230

			HouseID house_id;

   231

		} house;

   232

		struct {

   233

			TileIndex tile;

   234

			Industry *ind;

   235

			IndustryGfx gfx;

   236

			IndustryType type;

   237

		} industry;

   238

		struct {

   239

			const struct CargoSpec *cs;

   240

		} cargo;

   241

		struct {

   242

			CargoID cargo_type;

   243

			uint8 default_selection;

   244

			IndustryType src_industry;

   245

			IndustryType dst_industry;

   246

			uint8 distance;

   247

			AIConstructionEvent event;

   248

			uint8 count;

   249

			uint8 station_size;

   250

		} generic;

   251

	} u;

   252

   253

	uint32 (*GetRandomBits)(const struct ResolverObject*);

   254

	uint32 (*GetTriggers)(const struct ResolverObject*);

   255

	void (*SetTriggers)(const struct ResolverObject*, int);

   256

	uint32 (*GetVariable)(const struct ResolverObject*, byte, byte, bool*);

   257

	const SpriteGroup *(*ResolveReal)(const struct ResolverObject*, const SpriteGroup*);

   258

   259

	ResolverObject() : procedure_call(false) { }

   260

};

   261

   262

   263

/* Base sprite group resolver */

   264

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

   265

   266

   267

#endif /* NEWGRF_SPRITEGROUP_H */