1

/* $Id$ */

     2

     3

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

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "tile_cmd.h"

     9

#include "landscape.h"

    10

#include "debug.h"

    11

#include "sprite.h"

    12

#include "table/sprites.h"

    13

#include "table/strings.h"

    14

#include "station.h"

    15

#include "station_map.h"

    16

#include "newgrf.h"

    17

#include "newgrf_callbacks.h"

    18

#include "newgrf_commons.h"

    19

#include "newgrf_station.h"

    20

#include "newgrf_spritegroup.h"

    21

#include "cargotype.h"

    22

#include "town_map.h"

    23

#include "newgrf_town.h"

    24

#include "gfx_func.h"

    25

#include "date_func.h"

    27

    28

static StationClass station_classes[STAT_CLASS_MAX];

    29

    30

enum {

    31

	MAX_SPECLIST = 255,

    32

};

    33

    34

/**

    35

 * Reset station classes to their default state.

    36

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

    37

 * entry, for standard stations and waypoints.

    38

 */

    39

void ResetStationClasses()

    40

{

    41

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

    42

		station_classes[i].id = 0;

    43

		station_classes[i].name = STR_EMPTY;

    44

		station_classes[i].stations = 0;

    45

    46

		free(station_classes[i].spec);

    47

		station_classes[i].spec = NULL;

    48

	}

    49

    50

	/* Set up initial data */

    51

	station_classes[0].id = 'DFLT';

    52

	station_classes[0].name = STR_STAT_CLASS_DFLT;

    53

	station_classes[0].stations = 1;

    54

	station_classes[0].spec = MallocT<StationSpec*>(1);

    55

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

    56

    57

	station_classes[1].id = 'WAYP';

    58

	station_classes[1].name = STR_STAT_CLASS_WAYP;

    59

	station_classes[1].stations = 1;

    60

	station_classes[1].spec = MallocT<StationSpec*>(1);

    61

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

    62

}

    63

    64

/**

    65

 * Allocate a station class for the given class id.

    66

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

    67

 * @return Index into station_classes of allocated class.

    68

 */

    69

StationClassID AllocateStationClass(uint32 cls)

    70

{

    71

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

    72

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

    73

			/* ClassID is already allocated, so reuse it. */

    74

			return i;

    75

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

    76

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

    77

			station_classes[i].id = cls;

    78

			return i;

    79

		}

    80

	}

    81

    82

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

    83

	return STAT_CLASS_DFLT;

    84

}

    85

    86

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

    87

void SetStationClassName(StationClassID sclass, StringID name)

    88

{

    89

	assert(sclass < STAT_CLASS_MAX);

    90

	station_classes[sclass].name = name;

    91

}

    92

    93

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

    94

StringID GetStationClassName(StationClassID sclass)

    95

{

    96

	assert(sclass < STAT_CLASS_MAX);

    97

	return station_classes[sclass].name;

    98

}

    99

   100

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

   101

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

   102

 */

   103

StringID *BuildStationClassDropdown()

   104

{

   105

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

   106

	static StringID names[STAT_CLASS_MAX + 1];

   107

	uint i;

   108

   109

	/* Add each name */

   110

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

   111

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

   112

	}

   113

	/* Terminate the list */

   114

	names[i] = INVALID_STRING_ID;

   115

   116

	return names;

   117

}

   118

   119

/**

   120

 * Get the number of station classes in use.

   121

 * @return Number of station classes.

   122

 */

   123

uint GetNumStationClasses()

   124

{

   125

	uint i;

   126

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

   127

	return i;

   128

}

   129

   130

/**

   131

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

   132

 * @param sclass Index of the station class.

   133

 * @return Number of stations in the class.

   134

 */

   135

uint GetNumCustomStations(StationClassID sclass)

   136

{

   137

	assert(sclass < STAT_CLASS_MAX);

   138

	return station_classes[sclass].stations;

   139

}

   140

   141

/**

   142

 * Tie a station spec to its station class.

   143

 * @param statspec The station spec.

   144

 */

   145

void SetCustomStationSpec(StationSpec *statspec)

   146

{

   147

	StationClass *station_class;

   148

	int i;

   149

   150

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

   151

	if (statspec->allocated) return;

   152

   153

	assert(statspec->sclass < STAT_CLASS_MAX);

   154

	station_class = &station_classes[statspec->sclass];

   155

   156

	i = station_class->stations++;

   157

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

   158

   159

	station_class->spec[i] = statspec;

   160

	statspec->allocated = true;

   161

}

   162

   163

/**

   164

 * Retrieve a station spec from a class.

   165

 * @param sclass Index of the station class.

   166

 * @param station The station index with the class.

   167

 * @return The station spec.

   168

 */

   169

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   170

{

   171

	assert(sclass < STAT_CLASS_MAX);

   172

	if (station < station_classes[sclass].stations)

   173

		return station_classes[sclass].spec[station];

   174

   175

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

   176

	 * probably was not loaded. */

   177

	return NULL;

   178

}

   179

   180

   181

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   182

{

   183

	uint j;

   184

   185

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

   186

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

   187

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

   188

			if (statspec == NULL) continue;

   189

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

   190

		}

   191

	}

   192

   193

	return NULL;

   194

}

   195

   196

   197

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

   198

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

   199

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

   200

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

   201

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

   202

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

   203

 */

   204

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

   205

{

   206

	uint32 retval = 0;

   207

   208

	if (axis == AXIS_X) {

   209

		Swap(platforms, length);

   210

		Swap(x, y);

   211

	}

   212

   213

	/* Limit our sizes to 4 bits */

   214

	platforms = min(15, platforms);

   215

	length    = min(15, length);

   216

	x = min(15, x);

   217

	y = min(15, y);

   218

	if (centred) {

   219

		x -= platforms / 2;

   220

		y -= length / 2;

   221

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

   222

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

   223

	} else {

   224

		SB(retval,  0, 4, y);

   225

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

   226

		SB(retval,  8, 4, x);

   227

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

   228

	}

   229

	SB(retval, 16, 4, length);

   230

	SB(retval, 20, 4, platforms);

   231

	SB(retval, 24, 4, tile);

   232

   233

	return retval;

   234

}

   235

   236

   237

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

   238

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

   239

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

   240

 */

   241

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

   242

{

   243

	bool waypoint;

   244

	byte orig_type = 0;

   245

	Axis orig_axis = AXIS_X;

   246

   247

	waypoint = IsTileType(tile, MP_RAILWAY);

   248

   249

	if (waypoint) {

   250

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   251

	} else {

   252

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   253

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   254

	}

   255

   256

	while (true) {

   257

		TileIndex new_tile = TILE_ADD(tile, delta);

   258

   259

		if (waypoint) {

   260

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

   261

			if (!IsRailWaypoint(new_tile)) break;

   262

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

   263

		} else {

   264

			if (!IsRailwayStationTile(new_tile)) break;

   265

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

   266

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

   267

		}

   268

   269

		tile = new_tile;

   270

	}

   271

	return tile;

   272

}

   273

   274

   275

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

   276

{

   277

	int tx = TileX(tile);

   278

	int ty = TileY(tile);

   279

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

   280

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

   281

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

   282

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

   283

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

   284

   285

	tx -= sx; ex -= sx;

   286

	ty -= sy; ey -= sy;

   287

   288

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

   289

}

   290

   291

   292

static uint32 GetRailContinuationInfo(TileIndex tile)

   293

{

   294

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

   295

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

   296

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

   297

   298

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

   299

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

   300

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

   301

   302

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

   303

   304

	/* Choose appropriate lookup table to use */

   305

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

   306

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

   307

   308

	uint32 res = 0;

   309

	uint i;

   310

   311

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

   312

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

   313

		if (ts != 0) {

   314

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

   315

			SetBit(res, i + 8);

   316

   317

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

   318

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

   319

		}

   320

	}

   321

   322

	return res;

   323

}

   324

   325

   326

/* Station Resolver Functions */

   327

static uint32 StationGetRandomBits(const ResolverObject *object)

   328

{

   329

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

   330

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

   331

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

   332

}

   333

   334

   335

static uint32 StationGetTriggers(const ResolverObject *object)

   336

{

   337

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

   338

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

   339

}

   340

   341

   342

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

   343

{

   344

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

   345

	assert(st != NULL);

   346

	st->waiting_triggers = triggers;

   347

}

   348

   349

/**

   350

 * Station variable cache

   351

 * This caches 'expensive' station variable lookups which iterate over

   352

 * several tiles that may be called multiple times per Resolve().

   353

 */

   354

static struct {

   355

	uint32 v40;

   356

	uint32 v41;

   357

	uint32 v45;

   358

	uint32 v46;

   359

	uint32 v47;

   360

	uint32 v49;

   361

	uint8 valid;

   362

} _svc;

   363

   364

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

   365

{

   366

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

   367

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

   368

   369

	if (object->scope == VSG_SCOPE_PARENT) {

   370

		/* Pass the request on to the town of the station */

   371

		Town *t;

   372

   373

		if (st != NULL) {

   374

			t = st->town;

   375

		} else if (tile != INVALID_TILE) {

   376

			t = GetTownByTile(tile);

   377

		} else {

   378

			*available = false;

   379

			return UINT_MAX;

   380

		}

   381

   382

		return TownGetVariable(variable, parameter, available, t);

   383

	}

   384

   385

	if (st == NULL) {

   386

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

   387

		switch (variable) {

   388

			case 0x40:

   389

			case 0x41:

   390

			case 0x46:

   391

			case 0x47:

   392

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

   393

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

   394

			case 0x43: return _current_player; // Station owner

   395

			case 0x44: return 2;               // PBS status

   396

			case 0xFA: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Build date, clamped to a 16 bit value

   397

		}

   398

   399

		*available = false;

   400

		return UINT_MAX;

   401

	}

   402

   403

	switch (variable) {

   404

		/* Calculated station variables */

   405

		case 0x40:

   406

			if (!HasBit(_svc.valid, 0)) { _svc.v40 = GetPlatformInfoHelper(tile, false, false, false); SetBit(_svc.valid, 0); }

   407

			return _svc.v40;

   408

   409

		case 0x41:

   410

			if (!HasBit(_svc.valid, 1)) { _svc.v41 = GetPlatformInfoHelper(tile, true,  false, false); SetBit(_svc.valid, 1); }

   411

			return _svc.v41;

   412

   413

		case 0x42: return GetTerrainType(tile) | (GetRailType(tile) << 8);

   414

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

   415

		case 0x44: return 2;         // PBS status

   416

		case 0x45:

   417

			if (!HasBit(_svc.valid, 2)) { _svc.v45 = GetRailContinuationInfo(tile); SetBit(_svc.valid, 2); }

   418

			return _svc.v45;

   419

   420

		case 0x46:

   421

			if (!HasBit(_svc.valid, 3)) { _svc.v46 = GetPlatformInfoHelper(tile, false, false, true); SetBit(_svc.valid, 3); }

   422

			return _svc.v46;

   423

   424

		case 0x47:

   425

			if (!HasBit(_svc.valid, 4)) { _svc.v47 = GetPlatformInfoHelper(tile, true,  false, true); SetBit(_svc.valid, 4); }

   426

			return _svc.v47;

   427

   428

		case 0x48: { // Accepted cargo types

   429

			CargoID cargo_type;

   430

			uint32 value = 0;

   431

   432

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

   433

				if (HasBit(st->goods[cargo_type].acceptance_pickup, GoodsEntry::PICKUP)) SetBit(value, cargo_type);

   434

			}

   435

			return value;

   436

		}

   437

		case 0x49:

   438

			if (!HasBit(_svc.valid, 5)) { _svc.v49 = GetPlatformInfoHelper(tile, false, true, false); SetBit(_svc.valid, 5); }

   439

			return _svc.v49;

   440

   441

		/* Variables which use the parameter */

   442

		/* Variables 0x60 to 0x65 are handled separately below */

   443

		case 0x67: { // Land info of nearby tiles

   444

			Axis axis = GetRailStationAxis(tile);

   445

   446

			if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required

   447

			byte tile_type = GetTerrainType(tile) << 2 | (IsTileType(tile, MP_WATER) ? 1 : 0) << 1;

   448

   449

			uint z;

   450

			Slope tileh = GetTileSlope(tile, &z);

   451

			bool swap = (axis == AXIS_Y && HasBit(tileh, 0) != HasBit(tileh, 2));

   452

			return GetTileType(tile) << 24 | z << 16 | tile_type << 8 | (tileh ^ (swap ? 5 : 0));

   453

		}

   454

   455

		case 0x68: { // Station info of nearby tiles

   456

			TileIndex nearby_tile = GetNearbyTile(parameter, tile);

   457

   458

			if (!IsRailwayStationTile(nearby_tile)) return 0xFFFFFFFF;

   459

   460

			uint32 grfid = st->speclist[GetCustomStationSpecIndex(tile)].grfid;

   461

			bool perpendicular = GetRailStationAxis(tile) != GetRailStationAxis(nearby_tile);

   462

			bool same_station = st->TileBelongsToRailStation(nearby_tile);

   463

			uint32 res = GB(GetStationGfx(nearby_tile), 1, 2) << 12 | !!perpendicular << 11 | !!same_station << 10;

   464

   465

			if (IsCustomStationSpecIndex(nearby_tile)) {

   466

				const StationSpecList ssl = GetStationByTile(nearby_tile)->speclist[GetCustomStationSpecIndex(nearby_tile)];

   467

				res |= 1 << (ssl.grfid != grfid ? 9 : 8) | ssl.localidx;

   468

			}

   469

			return res;

   470

		}

   471

   472

		/* General station properties */

   473

		case 0x82: return 50;

   474

		case 0x84: return st->string_id;

   475

		case 0x86: return 0;

   476

		case 0x8A: return st->had_vehicle_of_type;

   477

		case 0xF0: return st->facilities;

   478

		case 0xF1: return st->airport_type;

   479

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

   480

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

   481

		case 0xF6: return st->airport_flags;

   482

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

   483

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

   484

	}

   485

   486

	/* Handle cargo variables with parameter, 0x60 to 0x65 */

   487

	if (variable >= 0x60 && variable <= 0x65) {

   488

		CargoID c = GetCargoTranslation(parameter, object->u.station.statspec->grffile);

   489

   490

		if (c == CT_INVALID) return 0;

   491

		const GoodsEntry *ge = &st->goods[c];

   492