1

/* $Id$ */

     2

     3

#ifndef NEWGRF_SPRITEGROUP_H

     4

#define NEWGRF_SPRITEGROUP_H

     5

     6

     7

typedef struct SpriteGroup SpriteGroup;

     8

     9

    10

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

    11

 * groups. */

    12

typedef struct RealSpriteGroup {

    13

	// Loaded = in motion, loading = not moving

    14

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

    15

    16

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

    17

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

    18

	// of da stuff.

    19

    20

	byte num_loaded;       ///< Number of loaded groups

    21

	byte num_loading;      ///< Number of loading groups

    22

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

    23

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

    24

} RealSpriteGroup;

    25

    26

/* Shared by deterministic and random groups. */

    27

typedef enum VarSpriteGroupScopes {

    28

	VSG_SCOPE_SELF,

    29

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

    30

	VSG_SCOPE_PARENT,

    31

} VarSpriteGroupScope;

    32

    33

typedef enum DeterministicSpriteGroupSizes {

    34

	DSG_SIZE_BYTE,

    35

	DSG_SIZE_WORD,

    36

	DSG_SIZE_DWORD,

    37

} DeterministicSpriteGroupSize;

    38

    39

typedef enum DeterministicSpriteGroupAdjustTypes {

    40

	DSGA_TYPE_NONE,

    41

	DSGA_TYPE_DIV,

    42

	DSGA_TYPE_MOD,

    43

} DeterministicSpriteGroupAdjustType;

    44

    45

typedef enum DeterministicSpriteGroupAdjustOperations {

    46

	DSGA_OP_ADD,  // a + b

    47

	DSGA_OP_SUB,  // a - b

    48

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

    49

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

    50

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

    51

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

    52

	DSGA_OP_SDIV, // (signed) a / b

    53

	DSGA_OP_SMOD, // (signed) a % b

    54

	DSGA_OP_UDIV, // (unsigned) a / b

    55

	DSGA_OP_UMOD, // (unsigned) a & b

    56

	DSGA_OP_MUL,  // a * b

    57

	DSGA_OP_AND,  // a & b

    58

	DSGA_OP_OR,   // a | b

    59

	DSGA_OP_XOR,  // a ^ b

    60

} DeterministicSpriteGroupAdjustOperation;

    61

    62

    63

typedef struct DeterministicSpriteGroupAdjust {

    64

	DeterministicSpriteGroupAdjustOperation operation;

    65

	DeterministicSpriteGroupAdjustType type;

    66

	byte variable;

    67

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

    68

	byte shift_num;

    69

	uint32 and_mask;

    70

	uint32 add_val;

    71

	uint32 divmod_val;

    72

	const SpriteGroup *subroutine;

    73

} DeterministicSpriteGroupAdjust;

    74

    75

    76

typedef struct DeterministicSpriteGroupRange {

    77

	const SpriteGroup *group;

    78

	uint32 low;

    79

	uint32 high;

    80

} DeterministicSpriteGroupRange;

    81

    82

    83

typedef struct DeterministicSpriteGroup {

    84

	VarSpriteGroupScope var_scope;

    85

	DeterministicSpriteGroupSize size;

    86

	byte num_adjusts;

    87

	byte num_ranges;

    88

	DeterministicSpriteGroupAdjust *adjusts;

    89

	DeterministicSpriteGroupRange *ranges; // Dynamically allocated

    90

    91

	// Dynamically allocated, this is the sole owner

    92

	const SpriteGroup *default_group;

    93

} DeterministicSpriteGroup;

    94

    95

typedef enum RandomizedSpriteGroupCompareModes {

    96

	RSG_CMP_ANY,

    97

	RSG_CMP_ALL,

    98

} RandomizedSpriteGroupCompareMode;

    99

   100

typedef struct RandomizedSpriteGroup {

   101

	// Take this object:

   102

	VarSpriteGroupScope var_scope;

   103

   104

	// Check for these triggers:

   105

	RandomizedSpriteGroupCompareMode cmp_mode;

   106

	byte triggers;

   107

   108

	// Look for this in the per-object randomized bitmask:

   109

	byte lowest_randbit;

   110

	byte num_groups; // must be power of 2

   111

   112

	// Take the group with appropriate index:

   113

	const SpriteGroup **groups;

   114

} RandomizedSpriteGroup;

   115

   116

   117

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

   118

 * CALLBACK_FAILED */

   119

typedef struct CallbackResultSpriteGroup {

   120

	uint16 result;

   121

} CallbackResultSpriteGroup;

   122

   123

   124

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

   125

 * sprites in the set */

   126

typedef struct ResultSpriteGroup {

   127

	SpriteID sprite;

   128

	byte num_sprites;

   129

} ResultSpriteGroup;

   130

   131

/* List of different sprite group types */

   132

typedef enum SpriteGroupType {

   133

	SGT_INVALID,

   134

	SGT_REAL,

   135

	SGT_DETERMINISTIC,

   136

	SGT_RANDOMIZED,

   137

	SGT_CALLBACK,

   138

	SGT_RESULT,

   139

} SpriteGroupType;

   140

   141

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

   142

struct SpriteGroup {

   143

	SpriteGroupType type;

   144

   145

	union {

   146

		RealSpriteGroup real;

   147

		DeterministicSpriteGroup determ;

   148

		RandomizedSpriteGroup random;

   149

		CallbackResultSpriteGroup callback;

   150

		ResultSpriteGroup result;

   151

	} g;

   152

};

   153

   154

   155

SpriteGroup *AllocateSpriteGroup(void);

   156

void InitializeSpriteGroupPool(void);

   157

   158

   159

typedef struct ResolverObject {

   160

	uint16 callback;

   161

	uint32 callback_param1;

   162

	uint32 callback_param2;

   163

   164

	byte trigger;

   165

	uint32 last_value;

   166

	uint32 reseed;

   167

	VarSpriteGroupScope scope;

   168

   169

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

   170

   171

	union {

   172

		struct {

   173

			const struct Vehicle *self;

   174

			const struct Vehicle *parent;

   175

			EngineID self_type;

   176

		} vehicle;

   177

		struct {

   178

			TileIndex tile;

   179

			const struct Station *st;

   180

			const struct StationSpec *statspec;

   181

			CargoID cargo_type;

   182

		} station;

   183

	} u;

   184

   185

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

   186

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

   187

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

   188

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

   189

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

   190

} ResolverObject;

   191

   192

   193

/* Base sprite group resolver */

   194

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

   195

   196

   197

#endif /* NEWGRF_SPRITEGROUP_H */