1

/* $Id$ */

     2

     3

/** @file newgrf_station.c Functions for dealing with station classes and custom stations. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "functions.h"

     9

#include "debug.h"

    10

#include "sprite.h"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "station.h"

    14

#include "station_map.h"

    15

#include "newgrf.h"

    16

#include "newgrf_callbacks.h"

    17

#include "newgrf_station.h"

    18

#include "newgrf_spritegroup.h"

    19

#include "date.h"

    20

    21

static StationClass station_classes[STAT_CLASS_MAX];

    22

    23

enum {

    24

	MAX_SPECLIST = 255,

    25

};

    26

    27

/**

    28

 * Reset station classes to their default state.

    29

 * This includes initialising the Default and Waypoint classes with an empty

    30

 * entry, for standard stations and waypoints.

    31

 */

    32

void ResetStationClasses(void)

    33

{

    34

	StationClassID i;

    35

	for (i = 0; i < STAT_CLASS_MAX; i++) {

    36

		station_classes[i].id = 0;

    37

		station_classes[i].name = STR_EMPTY;

    38

		station_classes[i].stations = 0;

    39

    40

		free(station_classes[i].spec);

    41

		station_classes[i].spec = NULL;

    42

	}

    43

    44

	// Set up initial data

    45

	station_classes[0].id = 'DFLT';

    46

	station_classes[0].name = STR_STAT_CLASS_DFLT;

    47

	station_classes[0].stations = 1;

    48

	station_classes[0].spec = malloc(sizeof(*station_classes[0].spec));

    49

	station_classes[0].spec[0] = NULL;

    50

    51

	station_classes[1].id = 'WAYP';

    52

	station_classes[1].name = STR_STAT_CLASS_WAYP;

    53

	station_classes[1].stations = 1;

    54

	station_classes[1].spec = malloc(sizeof(*station_classes[1].spec));

    55

	station_classes[1].spec[0] = NULL;

    56

}

    57

    58

/**

    59

 * Allocate a station class for the given class id.

    60

 * @param classid A 32 bit value identifying the class.

    61

 * @return Index into station_classes of allocated class.

    62

 */

    63

StationClassID AllocateStationClass(uint32 class)

    64

{

    65

	StationClassID i;

    66

    67

	for (i = 0; i < STAT_CLASS_MAX; i++) {

    68

		if (station_classes[i].id == class) {

    69

			// ClassID is already allocated, so reuse it.

    70

			return i;

    71

		} else if (station_classes[i].id == 0) {

    72

			// This class is empty, so allocate it to the ClassID.

    73

			station_classes[i].id = class;

    74

			return i;

    75

		}

    76

	}

    77

    78

	grfmsg(2, "StationClassAllocate: already allocated %d classes, using default", STAT_CLASS_MAX);

    79

	return STAT_CLASS_DFLT;

    80

}

    81

    82

/** Set the name of a custom station class */

    83

void SetStationClassName(StationClassID sclass, StringID name)

    84

{

    85

	assert(sclass < STAT_CLASS_MAX);

    86

	station_classes[sclass].name = name;

    87

}

    88

    89

/** Retrieve the name of a custom station class */

    90

StringID GetStationClassName(StationClassID sclass)

    91

{

    92

	assert(sclass < STAT_CLASS_MAX);

    93

	return station_classes[sclass].name;

    94

}

    95

    96

/** Build a list of station class name StringIDs to use in a dropdown list

    97

 * @return Pointer to a (static) array of StringIDs

    98

 */

    99

StringID *BuildStationClassDropdown(void)

   100

{

   101

	/* Allow room for all station classes, plus a terminator entry */

   102

	static StringID names[STAT_CLASS_MAX + 1];

   103

	uint i;

   104

   105

	/* Add each name */

   106

	for (i = 0; i < STAT_CLASS_MAX && station_classes[i].id != 0; i++) {

   107

		names[i] = station_classes[i].name;

   108

	}

   109

	/* Terminate the list */

   110

	names[i] = INVALID_STRING_ID;

   111

   112

	return names;

   113

}

   114

   115

/**

   116

 * Get the number of station classes in use.

   117

 * @return Number of station classes.

   118

 */

   119

uint GetNumStationClasses(void)

   120

{

   121

	uint i;

   122

	for (i = 0; i < STAT_CLASS_MAX && station_classes[i].id != 0; i++);

   123

	return i;

   124

}

   125

   126

/**

   127

 * Return the number of stations for the given station class.

   128

 * @param sclass Index of the station class.

   129

 * @return Number of stations in the class.

   130

 */

   131

uint GetNumCustomStations(StationClassID sclass)

   132

{

   133

	assert(sclass < STAT_CLASS_MAX);

   134

	return station_classes[sclass].stations;

   135

}

   136

   137

/**

   138

 * Tie a station spec to its station class.

   139

 * @param spec The station spec.

   140

 */

   141

void SetCustomStationSpec(StationSpec *statspec)

   142

{

   143

	StationClass *station_class;

   144

	int i;

   145

   146

	/* If the station has already been allocated, don't reallocate it. */

   147

	if (statspec->allocated) return;

   148

   149

	assert(statspec->sclass < STAT_CLASS_MAX);

   150

	station_class = &station_classes[statspec->sclass];

   151

   152

	i = station_class->stations++;

   153

	station_class->spec = realloc(station_class->spec, station_class->stations * sizeof(*station_class->spec));

   154

   155

	station_class->spec[i] = statspec;

   156

	statspec->allocated = true;

   157

}

   158

   159

/**

   160

 * Retrieve a station spec from a class.

   161

 * @param sclass Index of the station class.

   162

 * @param station The station index with the class.

   163

 * @return The station spec.

   164

 */

   165

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   166

{

   167

	assert(sclass < STAT_CLASS_MAX);

   168

	if (station < station_classes[sclass].stations)

   169

		return station_classes[sclass].spec[station];

   170

   171

	// If the custom station isn't defined any more, then the GRF file

   172

	// probably was not loaded.

   173

	return NULL;

   174

}

   175

   176

   177

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   178

{

   179

	StationClassID i;

   180

	uint j;

   181

   182

	for (i = STAT_CLASS_DFLT; i < STAT_CLASS_MAX; i++) {

   183

		for (j = 0; j < station_classes[i].stations; j++) {

   184

			const StationSpec *statspec = station_classes[i].spec[j];

   185

			if (statspec == NULL) continue;

   186

			if (statspec->grfid == grfid && statspec->localidx == localidx) return statspec;

   187

		}

   188

	}

   189

   190

	return NULL;

   191

}

   192

   193

   194

/* Evaluate a tile's position within a station, and return the result a bitstuffed format.

   195

 * if not centred: .TNLcCpP, if centred: .TNL..CP

   196

 * T = Tile layout number (GetStationGfx), N = Number of platforms, L = Length of platforms

   197

 * C = Current platform number from start, c = from end

   198

 * P = Position along platform from start, p = from end

   199

 * if centred, C/P start from the centre and c/p are not available.

   200

 */

   201

uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred)

   202

{

   203

	uint32 retval = 0;

   204

   205

	if (axis == AXIS_X) {

   206

		intswap(platforms, length);

   207

		intswap(x, y);

   208

	}

   209

   210

	/* Limit our sizes to 4 bits */

   211

	platforms = min(15, platforms);

   212

	length    = min(15, length);

   213

	x = min(15, x);

   214

	y = min(15, y);

   215

	if (centred) {

   216

		x -= platforms / 2;

   217

		y -= length / 2;

   218

		SB(retval,  0, 4, y & 0xF);

   219

		SB(retval,  4, 4, x & 0xF);

   220

	} else {

   221

		SB(retval,  0, 4, y);

   222

		SB(retval,  4, 4, length - y - 1);

   223

		SB(retval,  8, 4, x);

   224

		SB(retval, 12, 4, platforms - x - 1);

   225

	}

   226

	SB(retval, 16, 4, length);

   227

	SB(retval, 20, 4, platforms);

   228

	SB(retval, 24, 4, tile);

   229

   230

	return retval;

   231

}

   232

   233

   234

/* Find the end of a railway station, from the tile, in the direction of delta.

   235

 * If check_type is set, we stop if the custom station type changes.

   236

 * If check_axis is set, we stop if the station direction changes.

   237

 */

   238

static TileIndex FindRailStationEnd(TileIndex tile, TileIndexDiff delta, bool check_type, bool check_axis)

   239

{

   240

	bool waypoint;

   241

	byte orig_type = 0;

   242

	Axis orig_axis = AXIS_X;

   243

   244

	waypoint = IsTileType(tile, MP_RAILWAY);

   245

   246

	if (waypoint) {

   247

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   248

	} else {

   249

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   250

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   251

	}

   252

   253

	while (true) {

   254

		TileIndex new_tile = TILE_ADD(tile, delta);

   255

   256

		if (waypoint) {

   257

			if (!IsTileType(new_tile, MP_RAILWAY)) break;

   258

			if (!IsRailWaypoint(new_tile)) break;

   259

			if (check_axis && GetWaypointAxis(new_tile) != orig_axis) break;

   260

		} else {

   261

			if (!IsRailwayStationTile(new_tile)) break;

   262

			if (check_type && GetCustomStationSpecIndex(new_tile) != orig_type) break;

   263

			if (check_axis && GetRailStationAxis(new_tile) != orig_axis) break;

   264

		}

   265

   266

		tile = new_tile;

   267

	}

   268

	return tile;

   269

}

   270

   271

   272

static uint32 GetPlatformInfoHelper(TileIndex tile, bool check_type, bool check_axis, bool centred)

   273

{

   274

	int tx = TileX(tile);

   275

	int ty = TileY(tile);

   276

	int sx = TileX(FindRailStationEnd(tile, TileDiffXY(-1,  0), check_type, check_axis));

   277

	int sy = TileY(FindRailStationEnd(tile, TileDiffXY( 0, -1), check_type, check_axis));

   278

	int ex = TileX(FindRailStationEnd(tile, TileDiffXY( 1,  0), check_type, check_axis)) + 1;

   279

	int ey = TileY(FindRailStationEnd(tile, TileDiffXY( 0,  1), check_type, check_axis)) + 1;

   280

	Axis axis = IsTileType(tile, MP_RAILWAY) ? GetWaypointAxis(tile) : GetRailStationAxis(tile);

   281

   282

	tx -= sx; ex -= sx;

   283

	ty -= sy; ey -= sy;

   284

   285

	return GetPlatformInfo(axis, IsTileType(tile, MP_RAILWAY) ? 2 : GetStationGfx(tile), ex, ey, tx, ty, centred);

   286

}

   287

   288

   289

/* Station Resolver Functions */

   290

static uint32 StationGetRandomBits(const ResolverObject *object)

   291

{

   292

	const Station *st = object->u.station.st;

   293

	const TileIndex tile = object->u.station.tile;

   294

	return (st == NULL ? 0 : st->random_bits) | (tile == INVALID_TILE ? 0 : GetStationTileRandomBits(tile) << 16);

   295

}

   296

   297

   298

static uint32 StationGetTriggers(const ResolverObject *object)

   299

{

   300

	const Station *st = object->u.station.st;

   301

	return st == NULL ? 0 : st->waiting_triggers;

   302

}

   303

   304

   305

static void StationSetTriggers(const ResolverObject *object, int triggers)

   306

{

   307

	Station *st = (Station*)object->u.station.st;

   308

	assert(st != NULL);

   309

	st->waiting_triggers = triggers;

   310

}

   311

   312

   313

static uint32 StationGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

   314

{

   315

	const Station *st = object->u.station.st;

   316

	TileIndex tile = object->u.station.tile;

   317

   318

	if (st == NULL) {

   319

		/* Station does not exist, so we're in a purchase list */

   320

		switch (variable) {

   321

			case 0x40:

   322

			case 0x41:

   323

			case 0x46:

   324

			case 0x47:

   325

			case 0x49: return 0x2110000;       /* Platforms, tracks & position */

   326

			case 0x42: return 0;               /* Rail type (XXX Get current type from GUI?) */

   327

			case 0x43: return _current_player; /* Station owner */

   328

			case 0x44: return 2;               /* PBS status */

   329

			case 0xFA: return max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0); /* Build date */

   330

		}

   331

   332

		*available = false;

   333

		return -1;

   334

	}

   335

   336

	switch (variable) {

   337

		/* Calculated station variables */

   338

		case 0x40: return GetPlatformInfoHelper(tile, false, false, false);

   339

		case 0x41: return GetPlatformInfoHelper(tile, true,  false, false);

   340

		case 0x42: /* Terrain and rail type */

   341

			return ((_opt.landscape == LT_HILLY && GetTileZ(tile) > _opt.snow_line) ? 4 : 0) |

   342

			       (GetRailType(tile) << 8);

   343

		case 0x43: return st->owner; /* Station owner */

   344

		case 0x44: return 2;         /* PBS status */

   345

		case 0x46: return GetPlatformInfoHelper(tile, false, false, true);

   346

		case 0x47: return GetPlatformInfoHelper(tile, true,  false, true);

   347

		case 0x48: { /* Accepted cargo types */

   348

			CargoID cargo_type;

   349

			uint32 value = 0;

   350

   351

			for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {

   352

				if (HASBIT(st->goods[cargo_type].waiting_acceptance, 15)) SETBIT(value, cargo_type);

   353

			}

   354

			return value;

   355

		}

   356

		case 0x49: return GetPlatformInfoHelper(tile, false, true, false);

   357

   358

		/* Variables which use the parameter */

   359

		case 0x60: return GB(st->goods[parameter].waiting_acceptance, 0, 12);

   360

		case 0x61: return st->goods[parameter].days_since_pickup;

   361

		case 0x62: return st->goods[parameter].rating;

   362

		case 0x63: return st->goods[parameter].enroute_time;

   363

		case 0x64: return st->goods[parameter].last_speed | (st->goods[parameter].last_age << 8);

   364

   365

		/* General station properties */

   366

		case 0x82: return 50;

   367

		case 0x84: return st->string_id;

   368

		case 0x86: return 0;

   369

		case 0x8A: return st->had_vehicle_of_type;

   370

		case 0xF0: return st->facilities;

   371

		case 0xF1: return st->airport_type;

   372

		case 0xF2: return st->truck_stops->status;

   373

		case 0xF3: return st->bus_stops->status;

   374

		case 0xF6: return st->airport_flags;

   375

		case 0xF7: return GB(st->airport_flags, 8, 8);

   376

		case 0xFA: return max(st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);

   377

	}

   378

   379

	/* Handle cargo variables (deprecated) */

   380

	if (variable >= 0x8C && variable <= 0xEC) {

   381

		const GoodsEntry *g = &st->goods[GB(variable - 0x8C, 3, 4)];

   382

		switch (GB(variable - 0x8C, 0, 3)) {

   383

			case 0: return g->waiting_acceptance;

   384

			case 1: return GB(g->waiting_acceptance, 8, 8);

   385

			case 2: return g->days_since_pickup;

   386

			case 3: return g->rating;

   387

			case 4: return g->enroute_from;

   388

			case 5: return g->enroute_time;

   389

			case 6: return g->last_speed;

   390

			case 7: return g->last_age;

   391

		}

   392

	}

   393

   394

	DEBUG(grf, 1, "Unhandled station property 0x%X", variable);

   395

   396

	*available = false;

   397

	return -1;

   398

}

   399

   400

   401

static const SpriteGroup *StationResolveReal(const ResolverObject *object, const SpriteGroup *group)

   402

{

   403

	const Station *st = object->u.station.st;

   404

	const StationSpec *statspec = object->u.station.statspec;

   405

	uint set;

   406

   407

	uint cargo = 0;

   408

	CargoID cargo_type = object->u.station.cargo_type;

   409

   410

	if (st == NULL || statspec->sclass == STAT_CLASS_WAYP) {

   411

		return group->g.real.loading[0];

   412

	}

   413

   414

	switch (cargo_type) {

   415

		case GC_INVALID:

   416

		case GC_DEFAULT_NA:

   417

		case GC_PURCHASE:

   418

			cargo = 0;

   419

			break;

   420

   421

		case GC_DEFAULT:

   422

			for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {

   423

				cargo += GB(st->goods[cargo_type].waiting_acceptance, 0, 12);

   424

			}

   425

			break;

   426

   427

		default:

   428

			cargo = GB(st->goods[_local_cargo_id_ctype[cargo_type]].waiting_acceptance, 0, 12);

   429

			break;

   430

	}

   431

   432

	if (HASBIT(statspec->flags, 1)) cargo /= (st->trainst_w + st->trainst_h);

   433

	cargo = min(0xfff, cargo);

   434

   435

	if (cargo > statspec->cargo_threshold) {

   436

		if (group->g.real.num_loading > 0) {

   437

			set = ((cargo - statspec->cargo_threshold) * group->g.real.num_loading) / (4096 - statspec->cargo_threshold);

   438

			return group->g.real.loading[set];

   439

		}

   440

	} else {

   441

		if (group->g.real.num_loaded > 0) {

   442

			set = (cargo * group->g.real.num_loaded) / (statspec->cargo_threshold + 1);

   443

			return group->g.real.loaded[set];

   444

		}

   445

	}

   446

   447

	return group->g.real.loading[0];

   448

}

   449

   450

   451

static void NewStationResolver(ResolverObject *res, const StationSpec *statspec, const Station *st, TileIndex tile)

   452

{

   453

	res->GetRandomBits = StationGetRandomBits;

   454

	res->GetTriggers   = StationGetTriggers;

   455

	res->SetTriggers   = StationSetTriggers;

   456

	res->GetVariable   = StationGetVariable;

   457

	res->ResolveReal   = StationResolveReal;

   458

   459

	res->u.station.st       = st;

   460

	res->u.station.statspec = statspec;

   461

	res->u.station.tile     = tile;

   462

   463

	res->callback        = 0;

   464

	res->callback_param1 = 0;

   465

	res->callback_param2 = 0;

   466

	res->last_value      = 0;

   467

	res->trigger         = 0;

   468

	res->reseed          = 0;

   469

}

   470

   471

static const SpriteGroup *ResolveStation(const StationSpec *statspec, const Station *st, ResolverObject *object)

   472

{

   473

	const SpriteGroup *group;

   474

	CargoID ctype = GC_DEFAULT_NA;

   475

   476

	if (st == NULL) {

   477

		/* No station, so we are in a purchase list */

   478

		ctype = GC_PURCHASE;

   479

	} else {

   480

		CargoID cargo;

   481

   482

		/* Pick the first cargo that we have waiting */

   483

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

   484

			CargoID lcid = _local_cargo_id_ctype[cargo];

   485

			if (lcid != CT_INVALID && statspec->spritegroup[cargo] != NULL && GB(st->goods[lcid].waiting_acceptance, 0, 12) != 0) {

   486

				ctype = cargo;

   487

				break;

   488

			}

   489

		}

   490

	}

   491

   492

	group = statspec->spritegroup[ctype];

   493

	if (group == NULL) {

   494

		ctype = GC_DEFAULT;

   495

		group = statspec->spritegroup[ctype];

   496

	}

   497