1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "string.h"

     8

#include "strings.h"

     9

#include "engine.h"

    10

#include "newgrf_callbacks.h"

    11

#include "newgrf_engine.h"

    12

#include "sprite.h"

    13

#include "variables.h"

    14

#include "train.h"

    15

    16

// TODO: We don't support cargo-specific wagon overrides. Pretty exotic... ;-) --pasky

    17

    18

typedef struct WagonOverride {

    19

	byte *train_id;

    20

	int trains;

    21

	SpriteGroup *group;

    22

} WagonOverride;

    23

    24

typedef struct WagonOverrides {

    25

	int overrides_count;

    26

	WagonOverride *overrides;

    27

} WagonOverrides;

    28

    29

static WagonOverrides _engine_wagon_overrides[TOTAL_NUM_ENGINES];

    30

    31

void SetWagonOverrideSprites(EngineID engine, SpriteGroup *group, byte *train_id,

    32

	int trains)

    33

{

    34

	WagonOverrides *wos;

    35

	WagonOverride *wo;

    36

    37

	wos = &_engine_wagon_overrides[engine];

    38

	wos->overrides_count++;

    39

	wos->overrides = realloc(wos->overrides,

    40

		wos->overrides_count * sizeof(*wos->overrides));

    41

    42

	wo = &wos->overrides[wos->overrides_count - 1];

    43

	/* FIXME: If we are replacing an override, release original SpriteGroup

    44

	 * to prevent leaks. But first we need to refcount the SpriteGroup.

    45

	 * --pasky */

    46

	wo->group = group;

    47

	group->ref_count++;

    48

	wo->trains = trains;

    49

	wo->train_id = malloc(trains);

    50

	memcpy(wo->train_id, train_id, trains);

    51

}

    52

    53

static const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, byte overriding_engine)

    54

{

    55

	const WagonOverrides *wos = &_engine_wagon_overrides[engine];

    56

	int i;

    57

    58

	// XXX: This could turn out to be a timesink on profiles. We could

    59

	// always just dedicate 65535 bytes for an [engine][train] trampoline

    60

	// for O(1). Or O(logMlogN) and searching binary tree or smt. like

    61

	// that. --pasky

    62

    63

	for (i = 0; i < wos->overrides_count; i++) {

    64

		const WagonOverride *wo = &wos->overrides[i];

    65

		int j;

    66

    67

		for (j = 0; j < wo->trains; j++) {

    68

			if (wo->train_id[j] == overriding_engine)

    69

				return wo->group;

    70

		}

    71

	}

    72

	return NULL;

    73

}

    74

    75

/**

    76

 * Unload all wagon override sprite groups.

    77

 */

    78

void UnloadWagonOverrides(void)

    79

{

    80

	WagonOverrides *wos;

    81

	WagonOverride *wo;

    82

	EngineID engine;

    83

	int i;

    84

    85

	for (engine = 0; engine < TOTAL_NUM_ENGINES; engine++) {

    86

		wos = &_engine_wagon_overrides[engine];

    87

		for (i = 0; i < wos->overrides_count; i++) {

    88

			wo = &wos->overrides[i];

    89

			UnloadSpriteGroup(&wo->group);

    90

			free(wo->train_id);

    91

		}

    92

		free(wos->overrides);

    93

		wos->overrides_count = 0;

    94

		wos->overrides = NULL;

    95

	}

    96

}

    97

    98

// 0 - 28 are cargos, 29 is default, 30 is the advert (purchase list)

    99

// (It isn't and shouldn't be like this in the GRF files since new cargo types

   100

// may appear in future - however it's more convenient to store it like this in

   101

// memory. --pasky)

   102

static SpriteGroup *engine_custom_sprites[TOTAL_NUM_ENGINES][NUM_GLOBAL_CID];

   103

   104

void SetCustomEngineSprites(EngineID engine, byte cargo, SpriteGroup *group)

   105

{

   106

	if (engine_custom_sprites[engine][cargo] != NULL) {

   107

		DEBUG(grf, 6)("SetCustomEngineSprites: engine `%d' cargo `%d' already has group -- removing.", engine, cargo);

   108

		UnloadSpriteGroup(&engine_custom_sprites[engine][cargo]);

   109

	}

   110

	engine_custom_sprites[engine][cargo] = group;

   111

	group->ref_count++;

   112

}

   113

   114

/**

   115

 * Unload all engine sprite groups.

   116

 */

   117

void UnloadCustomEngineSprites(void)

   118

{

   119

	EngineID engine;

   120

	CargoID cargo;

   121

   122

	for (engine = 0; engine < TOTAL_NUM_ENGINES; engine++) {

   123

		for (cargo = 0; cargo < NUM_GLOBAL_CID; cargo++) {

   124

			if (engine_custom_sprites[engine][cargo] != NULL) {

   125

				DEBUG(grf, 6)("UnloadCustomEngineSprites: Unloading group for engine `%d' cargo `%d'.", engine, cargo);

   126

				UnloadSpriteGroup(&engine_custom_sprites[engine][cargo]);

   127

			}

   128

		}

   129

	}

   130

}

   131

   132

static int MapOldSubType(const Vehicle *v)

   133

{

   134

	if (v->type != VEH_Train) return v->subtype;

   135

	if (IsTrainEngine(v)) return 0;

   136

	if (IsFreeWagon(v)) return 4;

   137

	return 2;

   138

}

   139

   140

typedef SpriteGroup *(*resolve_callback)(const SpriteGroup *spritegroup,

   141

	const Vehicle *veh, uint16 callback_info, void *resolve_func); /* XXX data pointer used as function pointer */

   142

   143

static const SpriteGroup* ResolveVehicleSpriteGroup(const SpriteGroup *spritegroup,

   144

	const Vehicle *veh, uint16 callback_info, resolve_callback resolve_func)

   145

{

   146

	if (spritegroup == NULL)

   147

		return NULL;

   148

   149

	//debug("spgt %d", spritegroup->type);

   150

	switch (spritegroup->type) {

   151

		case SGT_REAL:

   152

		case SGT_CALLBACK:

   153

			return spritegroup;

   154

   155

		case SGT_DETERMINISTIC: {

   156

			const DeterministicSpriteGroup *dsg = &spritegroup->g.determ;

   157

			const SpriteGroup *target;

   158

			int value = -1;

   159

   160

			//debug("[%p] Having fun resolving variable %x", veh, dsg->variable);

   161

			if (dsg->variable == 0x0C) {

   162

				/* Callback ID */

   163

				value = callback_info & 0xFF;

   164

			} else if (dsg->variable == 0x10) {

   165

				value = (callback_info >> 8) & 0xFF;

   166

			} else if ((dsg->variable >> 6) == 0) {

   167

				/* General property */

   168

				value = GetDeterministicSpriteValue(dsg->variable);

   169

			} else {

   170

				/* Vehicle-specific property. */

   171

   172

				if (veh == NULL) {

   173

					/* We are in a purchase list of something,

   174

					 * and we are checking for something undefined.

   175

					 * That means we should get the first target

   176

					 * (NOT the default one). */

   177

					if (dsg->num_ranges > 0) {

   178

						target = dsg->ranges[0].group;

   179

					} else {

   180

						target = dsg->default_group;

   181

					}

   182

					return resolve_func(target, NULL, callback_info, resolve_func);

   183

				}

   184

   185

				if (dsg->var_scope == VSG_SCOPE_PARENT) {

   186

					/* First engine in the vehicle chain */

   187

					if (veh->type == VEH_Train)

   188

						veh = GetFirstVehicleInChain(veh);

   189

				}

   190

   191

				if (dsg->variable == 0x40 || dsg->variable == 0x41) {

   192

					if (veh->type == VEH_Train) {

   193

						const Vehicle *u = GetFirstVehicleInChain(veh);

   194

						byte chain_before = 0, chain_after = 0;

   195

   196

						while (u != veh) {

   197

							chain_before++;

   198

							if (dsg->variable == 0x41 && u->engine_type != veh->engine_type)

   199

								chain_before = 0;

   200

							u = u->next;

   201

						}

   202

						while (u->next != NULL && (dsg->variable == 0x40 || u->next->engine_type == veh->engine_type)) {

   203

							chain_after++;

   204

							u = u->next;

   205

						};

   206

   207

						value = chain_before | chain_after << 8

   208

						        | (chain_before + chain_after) << 16;

   209

					} else {

   210

						value = 1; /* 1 vehicle in the chain */

   211

					}

   212

   213

				} else {

   214

					// TTDPatch runs on little-endian arch;

   215

					// Variable is 0x80 + offset in TTD's vehicle structure

   216

					switch (dsg->variable - 0x80) {

   217

#define veh_prop(id_, value_) case (id_): value = (value_); break

   218

						veh_prop(0x00, veh->type);

   219

						veh_prop(0x01, MapOldSubType(veh));

   220

						veh_prop(0x04, veh->index);

   221

						veh_prop(0x05, veh->index & 0xFF);

   222

						/* XXX? Is THIS right? */

   223

						veh_prop(0x0A, PackOrder(&veh->current_order));

   224

						veh_prop(0x0B, PackOrder(&veh->current_order) & 0xff);

   225

						veh_prop(0x0C, veh->num_orders);

   226

						veh_prop(0x0D, veh->cur_order_index);

   227

						veh_prop(0x10, veh->load_unload_time_rem);

   228

						veh_prop(0x11, veh->load_unload_time_rem & 0xFF);

   229

						veh_prop(0x12, veh->date_of_last_service);

   230

						veh_prop(0x13, veh->date_of_last_service & 0xFF);

   231

						veh_prop(0x14, veh->service_interval);

   232

						veh_prop(0x15, veh->service_interval & 0xFF);

   233

						veh_prop(0x16, veh->last_station_visited);

   234

						veh_prop(0x17, veh->tick_counter);

   235

						veh_prop(0x18, veh->max_speed);

   236

						veh_prop(0x19, veh->max_speed & 0xFF);

   237

						veh_prop(0x1F, veh->direction);

   238

						veh_prop(0x28, veh->cur_image);

   239

						veh_prop(0x29, veh->cur_image & 0xFF);

   240

						veh_prop(0x32, veh->vehstatus);

   241

						veh_prop(0x33, veh->vehstatus);

   242

						veh_prop(0x34, veh->cur_speed);

   243

						veh_prop(0x35, veh->cur_speed & 0xFF);

   244

						veh_prop(0x36, veh->subspeed);

   245

						veh_prop(0x37, veh->acceleration);

   246

						veh_prop(0x39, veh->cargo_type);

   247

						veh_prop(0x3A, veh->cargo_cap);

   248

						veh_prop(0x3B, veh->cargo_cap & 0xFF);

   249

						veh_prop(0x3C, veh->cargo_count);

   250

						veh_prop(0x3D, veh->cargo_count & 0xFF);

   251

						veh_prop(0x3E, veh->cargo_source); // Probably useless; so what

   252

						veh_prop(0x3F, veh->cargo_days);

   253

						veh_prop(0x40, veh->age);

   254

						veh_prop(0x41, veh->age & 0xFF);

   255

						veh_prop(0x42, veh->max_age);

   256

						veh_prop(0x43, veh->max_age & 0xFF);

   257

						veh_prop(0x44, veh->build_year);

   258

						veh_prop(0x45, veh->unitnumber);

   259

						veh_prop(0x46, veh->engine_type);

   260

						veh_prop(0x47, veh->engine_type & 0xFF);

   261

						veh_prop(0x48, veh->spritenum);

   262

						veh_prop(0x49, veh->day_counter);

   263

						veh_prop(0x4A, veh->breakdowns_since_last_service);

   264

						veh_prop(0x4B, veh->breakdown_ctr);

   265

						veh_prop(0x4C, veh->breakdown_delay);

   266

						veh_prop(0x4D, veh->breakdown_chance);

   267

						veh_prop(0x4E, veh->reliability);

   268

						veh_prop(0x4F, veh->reliability & 0xFF);

   269

						veh_prop(0x50, veh->reliability_spd_dec);

   270

						veh_prop(0x51, veh->reliability_spd_dec & 0xFF);

   271

						veh_prop(0x52, veh->profit_this_year);

   272

						veh_prop(0x53, veh->profit_this_year & 0xFFFFFF);

   273

						veh_prop(0x54, veh->profit_this_year & 0xFFFF);

   274

						veh_prop(0x55, veh->profit_this_year & 0xFF);

   275

						veh_prop(0x56, veh->profit_last_year);

   276

						veh_prop(0x57, veh->profit_last_year & 0xFF);

   277

						veh_prop(0x58, veh->profit_last_year);

   278

						veh_prop(0x59, veh->profit_last_year & 0xFF);

   279

						veh_prop(0x5A, veh->next == NULL ? INVALID_VEHICLE : veh->next->index);

   280

						veh_prop(0x5C, veh->value);

   281

						veh_prop(0x5D, veh->value & 0xFFFFFF);

   282

						veh_prop(0x5E, veh->value & 0xFFFF);

   283

						veh_prop(0x5F, veh->value & 0xFF);

   284

						veh_prop(0x60, veh->string_id);

   285

						veh_prop(0x61, veh->string_id & 0xFF);

   286

						/* 00h..07h=sub image? 40h=in tunnel; actually some kind of status

   287

						 * aircraft: >=13h when in flight

   288

						 * train, ship: 80h=in depot

   289

						 * rv: 0feh=in depot */

   290

						/* TODO veh_prop(0x62, veh->???); */

   291

   292

						/* TODO: The rest is per-vehicle, I hope no GRF file looks so far.

   293

						 * But they won't let us have an easy ride so surely *some* GRF

   294

						 * file does. So someone needs to do this too. --pasky */

   295

   296

#undef veh_prop

   297

					}

   298

				}

   299

			}

   300

   301

			target = value != -1 ? EvalDeterministicSpriteGroup(dsg, value) : dsg->default_group;

   302

			//debug("Resolved variable %x: %d, %p", dsg->variable, value, callback);

   303

			return resolve_func(target, veh, callback_info, resolve_func);

   304

		}

   305

   306

		case SGT_RANDOMIZED: {

   307

			const RandomizedSpriteGroup *rsg = &spritegroup->g.random;

   308

   309

			if (veh == NULL) {

   310

				/* Purchase list of something. Show the first one. */

   311

				assert(rsg->num_groups > 0);

   312

				//debug("going for %p: %d", rsg->groups[0], rsg->groups[0].type);

   313

				return resolve_func(rsg->groups[0], NULL, callback_info, resolve_func);

   314

			}

   315

   316

			if (rsg->var_scope == VSG_SCOPE_PARENT) {

   317

				/* First engine in the vehicle chain */

   318

				if (veh->type == VEH_Train)

   319

					veh = GetFirstVehicleInChain(veh);

   320

			}

   321

   322

			return resolve_func(EvalRandomizedSpriteGroup(rsg, veh->random_bits), veh, callback_info, resolve_func);

   323

		}

   324

   325

		default:

   326

			error("I don't know how to handle such a spritegroup %d!", spritegroup->type);

   327

			return NULL;

   328

	}

   329

}

   330

   331

static const SpriteGroup *GetVehicleSpriteGroup(EngineID engine, const Vehicle *v)

   332

{

   333

	const SpriteGroup *group;

   334

	byte cargo = GC_PURCHASE;

   335

   336

	if (v != NULL) {

   337

		cargo = _global_cargo_id[_opt.landscape][v->cargo_type];

   338

		assert(cargo != GC_INVALID);

   339

	}

   340

   341

	group = engine_custom_sprites[engine][cargo];

   342

   343

	if (v != NULL && v->type == VEH_Train) {

   344

		const SpriteGroup *overset = GetWagonOverrideSpriteSet(engine, v->u.rail.first_engine);

   345

   346

		if (overset != NULL) group = overset;

   347

	}

   348

   349

	return group;

   350

}

   351

   352

int GetCustomEngineSprite(EngineID engine, const Vehicle *v, byte direction)

   353

{

   354

	const SpriteGroup *group;

   355

	const RealSpriteGroup *rsg;

   356

	byte cargo = GC_PURCHASE;

   357

	byte loaded = 0;

   358

	bool in_motion = 0;

   359

	int totalsets, spriteset;

   360

	int r;

   361

   362

	if (v != NULL) {

   363

		int capacity = v->cargo_cap;

   364

   365

		cargo = _global_cargo_id[_opt.landscape][v->cargo_type];

   366

		assert(cargo != GC_INVALID);

   367

   368

		if (capacity == 0) capacity = 1;

   369

		loaded = (v->cargo_count * 100) / capacity;

   370

   371

		if (v->type == VEH_Train) {

   372

			in_motion = GetFirstVehicleInChain(v)->current_order.type != OT_LOADING;

   373

		} else {

   374

			in_motion = v->current_order.type != OT_LOADING;

   375

		}

   376

	}

   377

   378

	group = GetVehicleSpriteGroup(engine, v);

   379

	group = ResolveVehicleSpriteGroup(group, v, 0, (resolve_callback) ResolveVehicleSpriteGroup);

   380

   381

	if (group == NULL && cargo != GC_DEFAULT) {

   382

		// This group is empty but perhaps there'll be a default one.

   383

		group = ResolveVehicleSpriteGroup(engine_custom_sprites[engine][GC_DEFAULT], v, 0,

   384

		                                (resolve_callback) ResolveVehicleSpriteGroup);

   385

	}

   386

   387

	if (group == NULL)

   388

		return 0;

   389

   390

	assert(group->type == SGT_REAL);

   391

	rsg = &group->g.real;

   392

   393

	if (!rsg->sprites_per_set) {

   394

		// This group is empty. This function users should therefore

   395

		// look up the sprite number in _engine_original_sprites.

   396

		return 0;

   397

	}

   398

   399

	assert(rsg->sprites_per_set <= 8);

   400

	direction %= rsg->sprites_per_set;

   401

   402

	totalsets = in_motion ? rsg->loaded_count : rsg->loading_count;

   403

   404

	// My aim here is to make it possible to visually determine absolutely

   405

	// empty and totally full vehicles. --pasky

   406

	if (loaded == 100 || totalsets == 1) { // full

   407

		spriteset = totalsets - 1;

   408

	} else if (loaded == 0 || totalsets == 2) { // empty

   409

		spriteset = 0;

   410

	} else { // something inbetween

   411

		spriteset = loaded * (totalsets - 2) / 100 + 1;

   412

		// correct possible rounding errors

   413

		if (!spriteset)

   414

			spriteset = 1;

   415

		else if (spriteset == totalsets - 1)

   416

			spriteset--;

   417

	}

   418

   419

	r = (in_motion ? rsg->loaded[spriteset]->g.result.result : rsg->loading[spriteset]->g.result.result) + direction;

   420

	return r;

   421

}

   422

   423

/**

   424

 * Check if a wagon is currently using a wagon override

   425

 * @param v The wagon to check

   426

 * @return true if it is using an override, false otherwise

   427

 */

   428

bool UsesWagonOverride(const Vehicle* v)

   429

{

   430

	assert(v->type == VEH_Train);

   431

	return GetWagonOverrideSpriteSet(v->engine_type, v->u.rail.first_engine) != NULL;

   432

}

   433

   434

/**

   435

 * Evaluates a newgrf callback

   436

 * @param callback_info info about which callback to evaluate

   437

 *  (bit 0-7)  = CallBack id of the callback to use, see CallBackId enum

   438

 *  (bit 8-15) = Other info some callbacks need to have, callback specific, see CallBackId enum, not used yet

   439

 * @param engine Engine type of the vehicle to evaluate the callback for

   440

 * @param vehicle The vehicle to evaluate the callback for, NULL if it doesnt exist (yet)

   441

 * @return The value the callback returned, or CALLBACK_FAILED if it failed

   442

 */

   443

uint16 GetCallBackResult(uint16 callback_info, EngineID engine, const Vehicle *v)

   444

{

   445

	const SpriteGroup *group;

   446

	byte cargo = GC_DEFAULT;

   447

   448

	if (v != NULL)

   449

		cargo = _global_cargo_id[_opt.landscape][v->cargo_type];

   450

   451

	group = engine_custom_sprites[engine][cargo];

   452

   453

	if (v != NULL && v->type == VEH_Train) {

   454

		const SpriteGroup *overset = GetWagonOverrideSpriteSet(engine, v->u.rail.first_engine);

   455

   456

		if (overset != NULL) group = overset;

   457

	}

   458

   459

	group = ResolveVehicleSpriteGroup(group, v, callback_info, (resolve_callback) ResolveVehicleSpriteGroup);

   460

   461

	if (group == NULL && cargo != GC_DEFAULT) {

   462

		// This group is empty but perhaps there'll be a default one.

   463

		group = ResolveVehicleSpriteGroup(engine_custom_sprites[engine][GC_DEFAULT], v, callback_info,

   464

		                                (resolve_callback) ResolveVehicleSpriteGroup);

   465

	}

   466

   467

	if (group == NULL || group->type != SGT_CALLBACK)

   468

		return CALLBACK_FAILED;

   469

   470

	return group->g.callback.result;

   471

}

   472

   473

   474

   475

// Global variables are evil, yes, but we would end up with horribly overblown

   476

// calling convention otherwise and this should be 100% reentrant.

   477

static byte _vsg_random_triggers;

   478

static byte _vsg_bits_to_reseed;

   479

   480

static const SpriteGroup *TriggerVehicleSpriteGroup(const SpriteGroup *spritegroup,

   481

	Vehicle *veh, uint16 callback_info, resolve_callback resolve_func)

   482

{

   483

	if (spritegroup == NULL)

   484

		return NULL;

   485

   486

	if (spritegroup->type == SGT_RANDOMIZED) {

   487

		_vsg_bits_to_reseed |= RandomizedSpriteGroupTriggeredBits(

   488

			&spritegroup->g.random,

   489

			_vsg_random_triggers,

   490