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

    20

#include "town_map.h"

    21

#include "newgrf_town.h"

    22

#include "gfx_func.h"

    23

#include "date_func.h"

    24

#include "player_func.h"

    25

    26

#include "table/sprites.h"

    27

#include "table/strings.h"

    28

    29

static StationClass _station_classes[STAT_CLASS_MAX];

    30

    31

enum {

    32

	MAX_SPECLIST = 255,

    33

};

    34

    35

/**

    36

 * Reset station classes to their default state.

    37

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

    38

 * entry, for standard stations and waypoints.

    39

 */

    40

void ResetStationClasses()

    41

{

    42

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

    43

		_station_classes[i].id = 0;

    44

		_station_classes[i].name = STR_EMPTY;

    45

		_station_classes[i].stations = 0;

    46

    47

		free(_station_classes[i].spec);

    48

		_station_classes[i].spec = NULL;

    49

	}

    50

    51

	/* Set up initial data */

    52

	_station_classes[0].id = 'DFLT';

    53

	_station_classes[0].name = STR_STAT_CLASS_DFLT;

    54

	_station_classes[0].stations = 1;

    55

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

    56

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

    57

    58

	_station_classes[1].id = 'WAYP';

    59

	_station_classes[1].name = STR_STAT_CLASS_WAYP;

    60

	_station_classes[1].stations = 1;

    61

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

    62

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

    63

}

    64

    65

/**

    66

 * Allocate a station class for the given class id.

    67

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

    68

 * @return Index into _station_classes of allocated class.

    69

 */

    70

StationClassID AllocateStationClass(uint32 cls)

    71

{

    72

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

    73

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

    74

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

    75

			return i;

    76

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

    77

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

    78

			_station_classes[i].id = cls;

    79

			return i;

    80

		}

    81

	}

    82

    83

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

    84

	return STAT_CLASS_DFLT;

    85

}

    86

    87

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

    88

void SetStationClassName(StationClassID sclass, StringID name)

    89

{

    90

	assert(sclass < STAT_CLASS_MAX);

    91

	_station_classes[sclass].name = name;

    92

}

    93

    94

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

    95

StringID GetStationClassName(StationClassID sclass)

    96

{

    97

	assert(sclass < STAT_CLASS_MAX);

    98

	return _station_classes[sclass].name;

    99

}

   100

   101

/**

   102

 * Get the number of station classes in use.

   103

 * @return Number of station classes.

   104

 */

   105

uint GetNumStationClasses()

   106

{

   107

	uint i;

   108

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

   109

	return i;

   110

}

   111

   112

/**

   113

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

   114

 * @param sclass Index of the station class.

   115

 * @return Number of stations in the class.

   116

 */

   117

uint GetNumCustomStations(StationClassID sclass)

   118

{

   119

	assert(sclass < STAT_CLASS_MAX);

   120

	return _station_classes[sclass].stations;

   121

}

   122

   123

/**

   124

 * Tie a station spec to its station class.

   125

 * @param statspec The station spec.

   126

 */

   127

void SetCustomStationSpec(StationSpec *statspec)

   128

{

   129

	StationClass *station_class;

   130

	int i;

   131

   132

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

   133

	if (statspec->allocated) return;

   134

   135

	assert(statspec->sclass < STAT_CLASS_MAX);

   136

	station_class = &_station_classes[statspec->sclass];

   137

   138

	i = station_class->stations++;

   139

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

   140

   141

	station_class->spec[i] = statspec;

   142

	statspec->allocated = true;

   143

}

   144

   145

/**

   146

 * Retrieve a station spec from a class.

   147

 * @param sclass Index of the station class.

   148

 * @param station The station index with the class.

   149

 * @return The station spec.

   150

 */

   151

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   152

{

   153

	assert(sclass < STAT_CLASS_MAX);

   154

	if (station < _station_classes[sclass].stations)

   155

		return _station_classes[sclass].spec[station];

   156

   157

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

   158

	 * probably was not loaded. */

   159

	return NULL;

   160

}

   161

   162

   163

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   164

{

   165

	uint j;

   166

   167

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

   168

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

   169

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

   170

			if (statspec == NULL) continue;

   171

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

   172

		}

   173

	}

   174

   175

	return NULL;

   176

}

   177

   178

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

 */

   186

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

   187

{

   188

	uint32 retval = 0;

   189

   190

	if (axis == AXIS_X) {

   191

		Swap(platforms, length);

   192

		Swap(x, y);

   193

	}

   194

   195

	/* Limit our sizes to 4 bits */

   196

	platforms = min(15, platforms);

   197

	length    = min(15, length);

   198

	x = min(15, x);

   199

	y = min(15, y);

   200

	if (centred) {

   201

		x -= platforms / 2;

   202

		y -= length / 2;

   203

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

   204

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

   205

	} else {

   206

		SB(retval,  0, 4, y);

   207

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

   208

		SB(retval,  8, 4, x);

   209

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

   210

	}

   211

	SB(retval, 16, 4, length);

   212

	SB(retval, 20, 4, platforms);

   213

	SB(retval, 24, 4, tile);

   214

   215

	return retval;

   216

}

   217

   218

   219

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

   220

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

   221

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

   222

 */

   223

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

   224

{

   225

	bool waypoint;

   226

	byte orig_type = 0;

   227

	Axis orig_axis = AXIS_X;

   228

   229

	waypoint = IsTileType(tile, MP_RAILWAY);

   230

   231

	if (waypoint) {

   232

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   233

	} else {

   234

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   235

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   236

	}

   237

   238

	while (true) {

   239

		TileIndex new_tile = TILE_ADD(tile, delta);

   240

   241

		if (waypoint) {

   242

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

   243

			if (!IsRailWaypoint(new_tile)) break;

   244

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

   245

		} else {

   246

			if (!IsRailwayStationTile(new_tile)) break;

   247

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

   248

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

   249

		}

   250

   251

		tile = new_tile;

   252

	}

   253

	return tile;

   254

}

   255

   256

   257

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

   258

{

   259

	int tx = TileX(tile);

   260

	int ty = TileY(tile);

   261

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

   262

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

   263

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

   264

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

   265

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

   266

   267

	tx -= sx; ex -= sx;

   268

	ty -= sy; ey -= sy;

   269

   270

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

   271

}

   272

   273

   274

static uint32 GetRailContinuationInfo(TileIndex tile)

   275

{

   276

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

   277

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

   278

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

   279

   280

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

   281

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

   282

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

   283

   284

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

   285

   286

	/* Choose appropriate lookup table to use */

   287

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

   288

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

   289

   290

	uint32 res = 0;

   291

	uint i;

   292

   293

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

   296

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

   297

			SetBit(res, i + 8);

   298

   299

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

   301

		}

   302

	}

   303

   304

	return res;

   305

}

   306

   307

   308

/* Station Resolver Functions */

   309

static uint32 StationGetRandomBits(const ResolverObject *object)

   310

{

   311

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

   312

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

   313

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

   314

}

   315

   316

   317

static uint32 StationGetTriggers(const ResolverObject *object)

   318

{

   319

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

   320

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

   321

}

   322

   323

   324

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

   325

{

   326

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

   327

	assert(st != NULL);

   328

	st->waiting_triggers = triggers;

   329

}

   330

   331

/**

   332

 * Station variable cache

   333

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

   334

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

   335

 */

   336

static struct {

   337

	uint32 v40;

   338

	uint32 v41;

   339

	uint32 v45;

   340

	uint32 v46;

   341

	uint32 v47;

   342

	uint32 v49;

   343

	uint8 valid;

   344

} _svc;

   345

   346

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

   347

{

   348

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

   349

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

   350

   351

	if (object->scope == VSG_SCOPE_PARENT) {

   352

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

   353

		Town *t;

   354

   355

		if (st != NULL) {

   356

			t = st->town;

   357

		} else if (tile != INVALID_TILE) {

   358

			t = GetTownByTile(tile);

   359

		} else {

   360

			*available = false;

   361

			return UINT_MAX;

   362

		}

   363

   364

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

   365

	}

   366

   367

	if (st == NULL) {

   368

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

   369

		switch (variable) {

   370

			case 0x40:

   371

			case 0x41:

   372

			case 0x46:

   373

			case 0x47:

   374

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

   375

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

   376

			case 0x43: return _current_player; // Station owner

   377

			case 0x44: return 2;               // PBS status

   378

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

   379

		}

   380

   381

		*available = false;

   382

		return UINT_MAX;

   383

	}

   384

   385

	switch (variable) {

   386

		/* Calculated station variables */

   387

		case 0x40:

   388

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

   389

			return _svc.v40;

   390

   391

		case 0x41:

   392

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

   393

			return _svc.v41;

   394

   395

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

   396

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

   397

		case 0x44: return 2;         // PBS status

   398

		case 0x45:

   399

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

   400

			return _svc.v45;

   401

   402

		case 0x46:

   403

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

   404

			return _svc.v46;

   405

   406

		case 0x47:

   407

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

   408

			return _svc.v47;

   409

   410

		case 0x48: { // Accepted cargo types

   411

			CargoID cargo_type;

   412

			uint32 value = 0;

   413

   414

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

   415

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

   416

			}

   417

			return value;

   418

		}

   419

		case 0x49:

   420

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

   421

			return _svc.v49;

   422

   423

		/* Variables which use the parameter */

   424

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

   425

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

   426

			Axis axis = GetRailStationAxis(tile);

   427

   428

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

   429

   430

			Slope tileh = GetTileSlope(tile, NULL);

   431

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

   432

   433

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

   434

		}

   435

   436

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

   437

			TileIndex nearby_tile = GetNearbyTile(parameter, tile);

   438

   439

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

   440

   441

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

   442

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

   443

			bool same_station = st->TileBelongsToRailStation(nearby_tile);

   444

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

   445

   446

			if (IsCustomStationSpecIndex(nearby_tile)) {

   447

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

   448

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

   449

			}

   450

			return res;

   451

		}

   452

   453

		/* General station properties */

   454

		case 0x82: return 50;

   455

		case 0x84: return st->string_id;

   456

		case 0x86: return 0;

   457

		case 0x8A: return st->had_vehicle_of_type;

   458

		case 0xF0: return st->facilities;

   459

		case 0xF1: return st->airport_type;

   460

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

   461

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

   462

		//TODO: how/what to return here

   463

		//case 0xF6: return st->airport_flags;

   464

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

   465

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

   466

	}

   467

   468

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

   469

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

   470

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

   471

   472

		if (c == CT_INVALID) return 0;

   473

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

   474

   475

		switch (variable) {

   476

			case 0x60: return min(ge->cargo.Count(), 4095);

   477

			case 0x61: return ge->days_since_pickup;

   478

			case 0x62: return ge->rating;

   479

			case 0x63: return ge->cargo.DaysInTransit();

   480

			case 0x64: return ge->last_speed | (ge->last_age << 8);

   481

			case 0x65: return GB(ge->acceptance_pickup, GoodsEntry::ACCEPTANCE, 1) << 3;

   482

		}

   483

	}

   484

   485

	/* Handle cargo variables (deprecated) */

   486

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

   487

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

   488

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

   489

			case 0: return g->cargo.Count();

   490

			case 1: return GB(min(g->cargo.Count(), 4095), 0, 4) | (GB(g->acceptance_pickup, GoodsEntry::ACCEPTANCE, 1) << 7);