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

} DeterministicSpriteGroupAdjust;

    73

    74

    75

typedef struct DeterministicSpriteGroupRange {

    76

	const SpriteGroup *group;

    77

	uint32 low;

    78

	uint32 high;

    79

} DeterministicSpriteGroupRange;

    80

    81

    82

typedef struct DeterministicSpriteGroup {

    83

	VarSpriteGroupScope var_scope;

    84

	DeterministicSpriteGroupSize size;

    85

	byte num_adjusts;

    86

	byte num_ranges;

    87

	DeterministicSpriteGroupAdjust *adjusts;

    88

	DeterministicSpriteGroupRange *ranges; // Dynamically allocated

    89

    90

	// Dynamically allocated, this is the sole owner

    91

	const SpriteGroup *default_group;

    92

} DeterministicSpriteGroup;

    93

    94

typedef enum RandomizedSpriteGroupCompareModes {

    95

	RSG_CMP_ANY,

    96

	RSG_CMP_ALL,

    97

} RandomizedSpriteGroupCompareMode;

    98

    99

typedef struct RandomizedSpriteGroup {

   100

	// Take this object:

   101

	VarSpriteGroupScope var_scope;

   102

   103

	// Check for these triggers:

   104

	RandomizedSpriteGroupCompareMode cmp_mode;

   105

	byte triggers;

   106

   107

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

   108

	byte lowest_randbit;

   109

	byte num_groups; // must be power of 2

   110

   111

	// Take the group with appropriate index:

   112

	const SpriteGroup **groups;

   113

} RandomizedSpriteGroup;

   114

   115

   116

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

   117

 * CALLBACK_FAILED */

   118

typedef struct CallbackResultSpriteGroup {

   119

	uint16 result;

   120

} CallbackResultSpriteGroup;

   121

   122

   123

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

   124

 * sprites in the set */

   125

typedef struct ResultSpriteGroup {

   126

	SpriteID sprite;

   127

	byte num_sprites;

   128

} ResultSpriteGroup;

   129

   130

/* List of different sprite group types */

   131

typedef enum SpriteGroupType {

   132

	SGT_INVALID,

   133

	SGT_REAL,

   134

	SGT_DETERMINISTIC,

   135

	SGT_RANDOMIZED,

   136

	SGT_CALLBACK,

   137

	SGT_RESULT,

   138

} SpriteGroupType;

   139

   140

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

   141

struct SpriteGroup {

   142

	SpriteGroupType type;

   143

   144

	union {

   145

		RealSpriteGroup real;

   146

		DeterministicSpriteGroup determ;

   147

		RandomizedSpriteGroup random;

   148

		CallbackResultSpriteGroup callback;

   149

		ResultSpriteGroup result;

   150

	} g;

   151

};

   152

   153

   154

SpriteGroup *AllocateSpriteGroup(void);

   155

void InitializeSpriteGroupPool(void);

   156

   157

   158

typedef struct ResolverObject {

   159

	uint16 callback;

   160

	uint32 callback_param1;

   161

	uint32 callback_param2;

   162

   163

	byte trigger;

   164

	uint32 last_value;

   165

	uint32 reseed;

   166

	VarSpriteGroupScope scope;

   167

   168

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

   169

   170

	union {

   171

		struct {

   172

			const struct Vehicle *self;

   173

			const struct Vehicle *parent;

   174

			EngineID self_type;

   175

		} vehicle;

   176

		struct {

   177

			TileIndex tile;

   178

			const struct Station *st;

   179

			const struct StationSpec *statspec;

   180

			CargoID cargo_type;

   181

		} station;

   182

	} u;

   183

   184

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

   185

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

   186

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

   187

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

   188

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

   189

} ResolverObject;

   190

   191

   192

/* Base sprite group resolver */

   193

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

   194

   195

   196

#endif /* NEWGRF_SPRITEGROUP_H */