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

#include "helpers.hpp"

    21

    22

static StationClass station_classes[STAT_CLASS_MAX];

    23

    24

enum {

    25

	MAX_SPECLIST = 255,

    26

};

    27

    28

/**

    29

 * Reset station classes to their default state.

    30

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

    31

 * entry, for standard stations and waypoints.

    32

 */

    33

void ResetStationClasses(void)

    34

{

    35

	for (StationClassID i = STAT_CLASS_BEGIN; 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 = MallocT<StationSpec*>(1);

    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 = MallocT<StationSpec*>(1);

    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 cls)

    64

{

    65

	for (StationClassID i = STAT_CLASS_BEGIN; i < STAT_CLASS_MAX; i++) {

    66

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

    67

			// ClassID is already allocated, so reuse it.

    68

			return i;

    69

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

    70

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

    71

			station_classes[i].id = cls;

    72

			return i;

    73

		}

    74

	}

    75

    76

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

    77

	return STAT_CLASS_DFLT;

    78

}

    79

    80

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

    81

void SetStationClassName(StationClassID sclass, StringID name)

    82

{

    83

	assert(sclass < STAT_CLASS_MAX);

    84

	station_classes[sclass].name = name;

    85

}

    86

    87

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

    88

StringID GetStationClassName(StationClassID sclass)

    89

{

    90

	assert(sclass < STAT_CLASS_MAX);

    91

	return station_classes[sclass].name;

    92

}

    93

    94

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

    95

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

    96

 */

    97

StringID *BuildStationClassDropdown(void)

    98

{

    99

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

   100

	static StringID names[STAT_CLASS_MAX + 1];

   101

	uint i;

   102

   103

	/* Add each name */

   104

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

   105

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

   106

	}

   107

	/* Terminate the list */

   108

	names[i] = INVALID_STRING_ID;

   109

   110

	return names;

   111

}

   112

   113

/**

   114

 * Get the number of station classes in use.

   115

 * @return Number of station classes.

   116

 */

   117

uint GetNumStationClasses(void)

   118

{

   119

	uint i;

   120

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

   121

	return i;

   122

}

   123

   124

/**

   125

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

   126

 * @param sclass Index of the station class.

   127

 * @return Number of stations in the class.

   128

 */

   129

uint GetNumCustomStations(StationClassID sclass)

   130

{

   131

	assert(sclass < STAT_CLASS_MAX);

   132

	return station_classes[sclass].stations;

   133

}

   134

   135

/**

   136

 * Tie a station spec to its station class.

   137

 * @param spec The station spec.

   138

 */

   139

void SetCustomStationSpec(StationSpec *statspec)

   140

{

   141

	StationClass *station_class;

   142

	int i;

   143

   144

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

   145

	if (statspec->allocated) return;

   146

   147

	assert(statspec->sclass < STAT_CLASS_MAX);

   148

	station_class = &station_classes[statspec->sclass];

   149

   150

	i = station_class->stations++;

   151

	station_class->spec = ReallocT(station_class->spec, station_class->stations);

   152

   153

	station_class->spec[i] = statspec;

   154

	statspec->allocated = true;

   155

}

   156

   157

/**

   158

 * Retrieve a station spec from a class.

   159

 * @param sclass Index of the station class.

   160

 * @param station The station index with the class.

   161

 * @return The station spec.

   162

 */

   163

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   164

{

   165

	assert(sclass < STAT_CLASS_MAX);

   166

	if (station < station_classes[sclass].stations)

   167

		return station_classes[sclass].spec[station];

   168

   169

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

   170

	// probably was not loaded.

   171

	return NULL;

   172

}

   173

   174

   175

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   176

{

   177

	uint j;

   178

   179

	for (StationClassID i = STAT_CLASS_BEGIN; i < STAT_CLASS_MAX; i++) {

   180

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

   181

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

   182

			if (statspec == NULL) continue;

   183

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

   184

		}

   185

	}

   186

   187

	return NULL;

   188

}

   189

   190

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

 */

   198

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

   199

{

   200

	uint32 retval = 0;

   201

   202

	if (axis == AXIS_X) {

   203

		intswap(platforms, length);

   204

		intswap(x, y);

   205

	}

   206

   207

	/* Limit our sizes to 4 bits */

   208

	platforms = min(15, platforms);

   209

	length    = min(15, length);

   210

	x = min(15, x);

   211

	y = min(15, y);

   212

	if (centred) {

   213

		x -= platforms / 2;

   214

		y -= length / 2;

   215

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

   216

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

   217

	} else {

   218

		SB(retval,  0, 4, y);

   219

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

   220

		SB(retval,  8, 4, x);

   221

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

   222

	}

   223

	SB(retval, 16, 4, length);

   224

	SB(retval, 20, 4, platforms);

   225

	SB(retval, 24, 4, tile);

   226

   227

	return retval;

   228

}

   229

   230

   231

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

   232

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

   233

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

   234

 */

   235

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

   236

{

   237

	bool waypoint;

   238

	byte orig_type = 0;

   239

	Axis orig_axis = AXIS_X;

   240

   241

	waypoint = IsTileType(tile, MP_RAILWAY);

   242

   243

	if (waypoint) {

   244

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   245

	} else {

   246

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   247

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   248

	}

   249

   250

	while (true) {

   251

		TileIndex new_tile = TILE_ADD(tile, delta);

   252

   253

		if (waypoint) {

   254

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

   255

			if (!IsRailWaypoint(new_tile)) break;

   256

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

   257

		} else {

   258

			if (!IsRailwayStationTile(new_tile)) break;

   259

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

   260

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

   261

		}

   262

   263

		tile = new_tile;

   264

	}

   265

	return tile;

   266

}

   267

   268

   269

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

   270

{

   271

	int tx = TileX(tile);

   272

	int ty = TileY(tile);

   273

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

   274

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

   275

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

   276

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

   277

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

   278

   279

	tx -= sx; ex -= sx;

   280

	ty -= sy; ey -= sy;

   281

   282

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

   283

}

   284

   285

   286

static uint32 GetRailContinuationInfo(TileIndex tile)

   287

{

   288

	/* Tile offsets and exit dirs for X axis */

   289

	static Direction x_dir[8] = { DIR_SW, DIR_NE, DIR_SE, DIR_NW, DIR_S, DIR_E, DIR_W, DIR_N };

   290

	static DiagDirection x_exits[8] = { DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SW, DIAGDIR_NE };

   291

   292

	/* Tile offsets and exit dirs for Y axis */

   293

	static Direction y_dir[8] = { DIR_SE, DIR_NW, DIR_SW, DIR_NE, DIR_S, DIR_W, DIR_E, DIR_N };

   294

	static DiagDirection y_exits[8] = { DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_NW };

   295

   296

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

   297

   298

	/* Choose appropriate lookup table to use */

   299

	Direction *dir = axis == AXIS_X ? x_dir : y_dir;

   300

	DiagDirection *diagdir = axis == AXIS_X ? x_exits : y_exits;

   301

   302

	uint32 res = 0;

   303

	uint i;

   304

   305

	for (i = 0; i < lengthof(x_dir); i++, dir++, diagdir++) {

   306

		uint32 ts = GetTileTrackStatus(tile + TileOffsByDir(*dir), TRANSPORT_RAIL);

   307

		if (ts != 0) {

   308

			/* If there is any track on the tile, set the bit in the second byte */

   309

			SETBIT(res, i + 8);

   310

   311

			/* If any track reaches our exit direction, set the bit in the lower byte */

   312

			if (ts & DiagdirReachesTracks(*diagdir)) SETBIT(res, i);

   313

		}

   314

	}

   315

   316

	return res;

   317

}

   318

   319

   320

/* Station Resolver Functions */

   321

static uint32 StationGetRandomBits(const ResolverObject *object)

   322

{

   323

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

   324

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

   325

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

   326

}

   327

   328

   329

static uint32 StationGetTriggers(const ResolverObject *object)

   330

{

   331

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

   332

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

   333

}

   334

   335

   336

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

   337

{

   338

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

   339

	assert(st != NULL);

   340

	st->waiting_triggers = triggers;

   341

}

   342

   343

   344

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

   345

{

   346

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

   347

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

   348

   349

	if (st == NULL) {

   350

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

   351

		switch (variable) {

   352

			case 0x40:

   353

			case 0x41:

   354

			case 0x46:

   355

			case 0x47:

   356

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

   357

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

   358

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

   359

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

   360

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

   361

		}

   362

   363

		*available = false;

   364

		return UINT_MAX;

   365

	}

   366

   367

	switch (variable) {

   368

		/* Calculated station variables */

   369

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

   370

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

   371

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

   372

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

   373

			       (_opt.landscape == LT_DESERT ? GetTropicZone(tile) : 0) |

   374

			       (GetRailType(tile) << 8);

   375

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

   376

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

   377

		case 0x45: return GetRailContinuationInfo(tile);

   378

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

   379

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

   380

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

   381

			CargoID cargo_type;

   382

			uint32 value = 0;

   383

   384

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

   385

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

   386

			}

   387

			return value;

   388

		}

   389

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

   390

   391

		/* Variables which use the parameter */

   392

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

   393

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

   394

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

   395

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

   396

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

   397

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

   398

   399

		/* General station properties */

   400

		case 0x82: return 50;

   401

		case 0x84: return st->string_id;

   402

		case 0x86: return 0;

   403

		case 0x8A: return st->had_vehicle_of_type;

   404

		case 0xF0: return st->facilities;

   405

		case 0xF1: return st->airport_type;

   406

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

   407

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

   408

		case 0xF6: return st->airport_flags;

   409

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

   410

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

   411

	}

   412

   413

	/* Handle cargo variables (deprecated) */

   414

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

   415

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

   416

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

   417

			case 0: return g->waiting_acceptance;

   418

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

   419

			case 2: return g->days_since_pickup;

   420

			case 3: return g->rating;

   421

			case 4: return g->enroute_from;

   422

			case 5: return g->enroute_time;

   423

			case 6: return g->last_speed;

   424

			case 7: return g->last_age;

   425

		}

   426

	}

   427

   428

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

   429

   430

	*available = false;

   431

	return UINT_MAX;

   432

}

   433

   434

   435

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

   436

{

   437

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

   438

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

   439

	uint set;

   440

   441

	uint cargo = 0;

   442

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

   443

   444

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

   445

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

   446

	}

   447

   448

	switch (cargo_type) {

   449

		case GC_INVALID:

   450

		case GC_DEFAULT_NA:

   451

		case GC_PURCHASE:

   452

			cargo = 0;

   453

			break;

   454

   455

		case GC_DEFAULT:

   456

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

   457

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

   458

			}

   459

			break;

   460

   461

		default:

   462

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

   463

			break;

   464

	}

   465

   466

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

   467

	cargo = min(0xfff, cargo);

   468

   469

	if (cargo > statspec->cargo_threshold) {

   470

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

   471

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

   472

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

   473

		}

   474

	} else {

   475

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

   476

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

   477

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

   478

		}

   479

	}

   480

   481

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

   482

}

   483

   484

   485

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

   486

{

   487

	res->GetRandomBits = StationGetRandomBits;

   488

	res->GetTriggers   = StationGetTriggers;

   489

	res->SetTriggers   = StationSetTriggers;

   490

	res->GetVariable   = StationGetVariable;

   491

	res->ResolveReal   = StationResolveReal;

   492

   493

	res->u.station.st       = st;

   494

	res->u.station.statspec = statspec;