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 "station_base.h"

    13

#include "station_map.h"

    14

#include "newgrf.h"

    15

#include "newgrf_callbacks.h"

    16

#include "newgrf_commons.h"

    17

#include "newgrf_station.h"

    18

#include "newgrf_spritegroup.h"

    19

#include "newgrf_sound.h"

    20

#include "cargotype.h"

    21

#include "town.h"

    22

#include "newgrf_town.h"

    23

#include "gfx_func.h"

    24

#include "date_func.h"

    25

#include "company_func.h"

    26

#include "animated_tile_func.h"

    27

#include "functions.h"

    28

#include "tunnelbridge_map.h"

    29

#include "rail_map.h"

    30

#include "spritecache.h"

    31

    32

#include "table/sprites.h"

    33

#include "table/strings.h"

    34

    35

static StationClass _station_classes[STAT_CLASS_MAX];

    36

    37

enum {

    38

	MAX_SPECLIST = 255,

    39

};

    40

    41

/**

    42

 * Reset station classes to their default state.

    43

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

    44

 * entry, for standard stations and waypoints.

    45

 */

    46

void ResetStationClasses()

    47

{

    48

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

    49

		_station_classes[i].id = 0;

    50

		_station_classes[i].name = STR_EMPTY;

    51

		_station_classes[i].stations = 0;

    52

    53

		free(_station_classes[i].spec);

    54

		_station_classes[i].spec = NULL;

    55

	}

    56

    57

	/* Set up initial data */

    58

	_station_classes[0].id = 'DFLT';

    59

	_station_classes[0].name = STR_STAT_CLASS_DFLT;

    60

	_station_classes[0].stations = 1;

    61

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

    62

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

    63

    64

	_station_classes[1].id = 'WAYP';

    65

	_station_classes[1].name = STR_STAT_CLASS_WAYP;

    66

	_station_classes[1].stations = 1;

    67

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

    68

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

    69

}

    70

    71

/**

    72

 * Allocate a station class for the given class id.

    73

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

    74

 * @return Index into _station_classes of allocated class.

    75

 */

    76

StationClassID AllocateStationClass(uint32 cls)

    77

{

    78

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

    79

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

    80

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

    81

			return i;

    82

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

    83

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

    84

			_station_classes[i].id = cls;

    85

			return i;

    86

		}

    87

	}

    88

    89

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

    90

	return STAT_CLASS_DFLT;

    91

}

    92

    93

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

    94

void SetStationClassName(StationClassID sclass, StringID name)

    95

{

    96

	assert(sclass < STAT_CLASS_MAX);

    97

	_station_classes[sclass].name = name;

    98

}

    99

   100

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

   101

StringID GetStationClassName(StationClassID sclass)

   102

{

   103

	assert(sclass < STAT_CLASS_MAX);

   104

	return _station_classes[sclass].name;

   105

}

   106

   107

/**

   108

 * Get the number of station classes in use.

   109

 * @return Number of station classes.

   110

 */

   111

uint GetNumStationClasses()

   112

{

   113

	uint i;

   114

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

   115

	return i;

   116

}

   117

   118

/**

   119

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

   120

 * @param sclass Index of the station class.

   121

 * @return Number of stations in the class.

   122

 */

   123

uint GetNumCustomStations(StationClassID sclass)

   124

{

   125

	assert(sclass < STAT_CLASS_MAX);

   126

	return _station_classes[sclass].stations;

   127

}

   128

   129

/**

   130

 * Tie a station spec to its station class.

   131

 * @param statspec The station spec.

   132

 */

   133

void SetCustomStationSpec(StationSpec *statspec)

   134

{

   135

	StationClass *station_class;

   136

	int i;

   137

   138

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

   139

	if (statspec->allocated) return;

   140

   141

	assert(statspec->sclass < STAT_CLASS_MAX);

   142

	station_class = &_station_classes[statspec->sclass];

   143

   144

	i = station_class->stations++;

   145

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

   146

   147

	station_class->spec[i] = statspec;

   148

	statspec->allocated = true;

   149

}

   150

   151

/**

   152

 * Retrieve a station spec from a class.

   153

 * @param sclass Index of the station class.

   154

 * @param station The station index with the class.

   155

 * @return The station spec.

   156

 */

   157

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   158

{

   159

	assert(sclass < STAT_CLASS_MAX);

   160

	if (station < _station_classes[sclass].stations)

   161

		return _station_classes[sclass].spec[station];

   162

   163

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

   164

	 * probably was not loaded. */

   165

	return NULL;

   166

}

   167

   168

   169

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   170

{

   171

	uint j;

   172

   173

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

   174

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

   175

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

   176

			if (statspec == NULL) continue;

   177

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

   178

		}

   179

	}

   180

   181

	return NULL;

   182

}

   183

   184

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

 */

   192

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

   193

{

   194

	uint32 retval = 0;

   195

   196

	if (axis == AXIS_X) {

   197

		Swap(platforms, length);

   198

		Swap(x, y);

   199

	}

   200

   201

	/* Limit our sizes to 4 bits */

   202

	platforms = min(15, platforms);

   203

	length    = min(15, length);

   204

	x = min(15, x);

   205

	y = min(15, y);

   206

	if (centred) {

   207

		x -= platforms / 2;

   208

		y -= length / 2;

   209

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

   210

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

   211

	} else {

   212

		SB(retval,  0, 4, y);

   213

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

   214

		SB(retval,  8, 4, x);

   215

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

   216

	}

   217

	SB(retval, 16, 4, length);

   218

	SB(retval, 20, 4, platforms);

   219

	SB(retval, 24, 4, tile);

   220

   221

	return retval;

   222

}

   223

   224

   225

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

   226

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

   227

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

   228

 */

   229

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

   230

{

   231

	bool waypoint;

   232

	byte orig_type = 0;

   233

	Axis orig_axis = AXIS_X;

   234

   235

	waypoint = IsTileType(tile, MP_RAILWAY);

   236

   237

	if (waypoint) {

   238

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   239

	} else {

   240

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   241

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   242

	}

   243

   244

	while (true) {

   245

		TileIndex new_tile = TILE_ADD(tile, delta);

   246

   247

		if (waypoint) {

   248

			if (!IsRailWaypointTile(new_tile)) break;

   249

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

   250

		} else {

   251

			if (!IsRailwayStationTile(new_tile)) break;

   252

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

   253

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

   254

		}

   255

   256

		tile = new_tile;

   257

	}

   258

	return tile;

   259

}

   260

   261

   262

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

   263

{

   264

	int tx = TileX(tile);

   265

	int ty = TileY(tile);

   266

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

   267

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

   268

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

   269

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

   270

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

   271

   272

	tx -= sx; ex -= sx;

   273

	ty -= sy; ey -= sy;

   274

   275

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

   276

}

   277

   278

   279

static uint32 GetRailContinuationInfo(TileIndex tile)

   280

{

   281

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

   282

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

   283

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

   284

   285

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

   286

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

   287

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

   288

   289

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

   290

   291

	/* Choose appropriate lookup table to use */

   292

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

   293

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

   294

   295

	uint32 res = 0;

   296

	uint i;

   297

   298

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

   299

		TileIndex neighbour_tile = tile + TileOffsByDir(*dir);

   300

		TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(neighbour_tile, TRANSPORT_RAIL, 0));

   301

		if (trackbits != TRACK_BIT_NONE) {

   302

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

   303

			SetBit(res, i + 8);

   304

   305

			/* With tunnels and bridges the tile has tracks, but they are not necessarily connected

   306

			 * with the next tile because the ramp is not going in the right direction. */

   307

			if (IsTileType(neighbour_tile, MP_TUNNELBRIDGE) && GetTunnelBridgeDirection(neighbour_tile) != *diagdir) {

   308

				continue;

   309

			}

   310

   311

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

   312

			if (trackbits & 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

 * Station variable cache

   345

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

   346

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

   347

 */

   348

static struct {

   349

	uint32 v40;

   350

	uint32 v41;

   351

	uint32 v45;

   352

	uint32 v46;

   353

	uint32 v47;

   354

	uint32 v49;

   355

	uint8 valid;

   356

} _svc;

   357

   358

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

   359

{

   360

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

   361

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

   362

   363

	if (object->scope == VSG_SCOPE_PARENT) {

   364

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

   365

		const Town *t;

   366

   367

		if (st != NULL) {

   368

			t = st->town;

   369

		} else if (tile != INVALID_TILE) {

   370

			t = ClosestTownFromTile(tile, UINT_MAX);

   371

		} else {

   372

			*available = false;

   373

			return UINT_MAX;

   374

		}

   375

   376

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

   377

	}

   378

   379

	if (st == NULL) {

   380

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

   381

		switch (variable) {

   382

			case 0x40:

   383

			case 0x41:

   384

			case 0x46:

   385

			case 0x47:

   386

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

   387

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

   388

			case 0x43: return _current_company; // Station owner

   389

			case 0x44: return 2;                // PBS status

   390

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

   391

		}

   392

   393

		*available = false;

   394

		return UINT_MAX;

   395

	}

   396

   397

	switch (variable) {

   398

		/* Calculated station variables */

   399

		case 0x40:

   400

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

   401

			return _svc.v40;

   402

   403

		case 0x41:

   404

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

   405

			return _svc.v41;

   406

   407

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

   408

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

   409

		case 0x44:

   410

			if (IsRailWaypointTile(tile)) {

   411

				return GetDepotWaypointReservation(tile) ? 7 : 4;

   412

			} else {

   413

				return GetRailwayStationReservation(tile) ? 7 : 4; // PBS status

   414

			}

   415

		case 0x45:

   416

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

   417

			return _svc.v45;

   418

   419

		case 0x46:

   420

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

   421

			return _svc.v46;

   422

   423

		case 0x47:

   424

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

   425

			return _svc.v47;

   426

   427

		case 0x48: { // Accepted cargo types

   428

			CargoID cargo_type;

   429

			uint32 value = 0;

   430

   431

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

   432

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

   433

			}

   434

			return value;

   435

		}

   436

		case 0x49:

   437

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

   438

			return _svc.v49;

   439

   440

		case 0x4A: // Animation frame of tile

   441

			return GetStationAnimationFrame(tile);

   442

   443

		/* Variables which use the parameter */

   444

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

   445

		case 0x66: // Animation frame of nearby tile

   446

			if (parameter != 0) tile = GetNearbyTile(parameter, tile);

   447

			return st->TileBelongsToRailStation(tile) ? GetStationAnimationFrame(tile) : UINT_MAX;

   448

   449

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

   450

			Axis axis = GetRailStationAxis(tile);

   451

   452

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

   453

   454

			Slope tileh = GetTileSlope(tile, NULL);

   455

			bool swap = (axis == AXIS_Y && HasBit(tileh, SLOPE_W) != HasBit(tileh, SLOPE_E));

   456

   457

			return GetNearbyTileInformation(tile) ^ (swap ? SLOPE_EW : 0);

   458

		}

   459

   460

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

   461

			TileIndex nearby_tile = GetNearbyTile(parameter, tile);

   462

   463

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

   464

   465

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

   466

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

   467

			bool same_station = st->TileBelongsToRailStation(nearby_tile);

   468

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

   469

   470

			if (IsCustomStationSpecIndex(nearby_tile)) {

   471

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

   472

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

   473

			}

   474

			return res;

   475

		}

   476

   477

		/* General station properties */

   478

		case 0x82: return 50;

   479

		case 0x84: return st->string_id;

   480

		case 0x86: return 0;

   481

		case 0x8A: return st->had_vehicle_of_type;

   482

		case 0xF0: return st->facilities;

   483

		case 0xF1: return st->airport_type;

   484

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

   485

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

   486

		case 0xF6: return st->airport_flags;

   487

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

   488

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

   489

	}