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 "functions.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 "date.h"

    22

#include "helpers.hpp"

    23

#include "cargotype.h"

    24

#include "town_map.h"

    25

#include "newgrf_town.h"

    26

    27

static StationClass station_classes[STAT_CLASS_MAX];

    28

    29

enum {

    30

	MAX_SPECLIST = 255,

    31

};

    32

    33

/**

    34

 * Reset station classes to their default state.

    35

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

    36

 * entry, for standard stations and waypoints.

    37

 */

    38

void ResetStationClasses()

    39

{

    40

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

    41

		station_classes[i].id = 0;

    42

		station_classes[i].name = STR_EMPTY;

    43

		station_classes[i].stations = 0;

    44

    45

		free(station_classes[i].spec);

    46

		station_classes[i].spec = NULL;

    47

	}

    48

    49

	/* Set up initial data */

    50

	station_classes[0].id = 'DFLT';

    51

	station_classes[0].name = STR_STAT_CLASS_DFLT;

    52

	station_classes[0].stations = 1;

    53

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

    54

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

    55

    56

	station_classes[1].id = 'WAYP';

    57

	station_classes[1].name = STR_STAT_CLASS_WAYP;

    58

	station_classes[1].stations = 1;

    59

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

    60

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

    61

}

    62

    63

/**

    64

 * Allocate a station class for the given class id.

    65

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

    66

 * @return Index into station_classes of allocated class.

    67

 */

    68

StationClassID AllocateStationClass(uint32 cls)

    69

{

    70

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

    71

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

    72

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

    73

			return i;

    74

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

    75

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

    76

			station_classes[i].id = cls;

    77

			return i;

    78

		}

    79

	}

    80

    81

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

    82

	return STAT_CLASS_DFLT;

    83

}

    84

    85

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

    86

void SetStationClassName(StationClassID sclass, StringID name)

    87

{

    88

	assert(sclass < STAT_CLASS_MAX);

    89

	station_classes[sclass].name = name;

    90

}

    91

    92

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

    93

StringID GetStationClassName(StationClassID sclass)

    94

{

    95

	assert(sclass < STAT_CLASS_MAX);

    96

	return station_classes[sclass].name;

    97

}

    98

    99

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

   100

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

   101

 */

   102

StringID *BuildStationClassDropdown()

   103

{

   104

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

   105

	static StringID names[STAT_CLASS_MAX + 1];

   106

	uint i;

   107

   108

	/* Add each name */

   109

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

   110

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

   111

	}

   112

	/* Terminate the list */

   113

	names[i] = INVALID_STRING_ID;

   114

   115

	return names;

   116

}

   117

   118

/**

   119

 * Get the number of station classes in use.

   120

 * @return Number of station classes.

   121

 */

   122

uint GetNumStationClasses()

   123

{

   124

	uint i;

   125

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

   126

	return i;

   127

}

   128

   129

/**

   130

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

   131

 * @param sclass Index of the station class.

   132

 * @return Number of stations in the class.

   133

 */

   134

uint GetNumCustomStations(StationClassID sclass)

   135

{

   136

	assert(sclass < STAT_CLASS_MAX);

   137

	return station_classes[sclass].stations;

   138

}

   139

   140

/**

   141

 * Tie a station spec to its station class.

   142

 * @param statspec The station spec.

   143

 */

   144

void SetCustomStationSpec(StationSpec *statspec)

   145

{

   146

	StationClass *station_class;

   147

	int i;

   148

   149

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

   150

	if (statspec->allocated) return;

   151

   152

	assert(statspec->sclass < STAT_CLASS_MAX);

   153

	station_class = &station_classes[statspec->sclass];

   154

   155

	i = station_class->stations++;

   156

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

   157

   158

	station_class->spec[i] = statspec;

   159

	statspec->allocated = true;

   160

}

   161

   162

/**

   163

 * Retrieve a station spec from a class.

   164

 * @param sclass Index of the station class.

   165

 * @param station The station index with the class.

   166

 * @return The station spec.

   167

 */

   168

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   169

{

   170

	assert(sclass < STAT_CLASS_MAX);

   171

	if (station < station_classes[sclass].stations)

   172

		return station_classes[sclass].spec[station];

   173

   174

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

   175

	 * probably was not loaded. */

   176

	return NULL;

   177

}

   178

   179

   180

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   181

{

   182

	uint j;

   183

   184

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

   185

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

   186

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

   187

			if (statspec == NULL) continue;

   188

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

   189

		}

   190

	}

   191

   192

	return NULL;

   193

}

   194

   195

   196

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

   197

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

   198

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

   199

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

   200

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

   201

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

   202

 */

   203

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

   204

{

   205

	uint32 retval = 0;

   206

   207

	if (axis == AXIS_X) {

   208

		Swap(platforms, length);

   209

		Swap(x, y);

   210

	}

   211

   212

	/* Limit our sizes to 4 bits */

   213

	platforms = min(15, platforms);

   214

	length    = min(15, length);

   215

	x = min(15, x);

   216

	y = min(15, y);

   217

	if (centred) {

   218

		x -= platforms / 2;

   219

		y -= length / 2;

   220

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

   221

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

   222

	} else {

   223

		SB(retval,  0, 4, y);

   224

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

   225

		SB(retval,  8, 4, x);

   226

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

   227

	}

   228

	SB(retval, 16, 4, length);

   229

	SB(retval, 20, 4, platforms);

   230

	SB(retval, 24, 4, tile);

   231

   232

	return retval;

   233

}

   234

   235

   236

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

   237

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

   238

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

   239

 */

   240

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

   241

{

   242

	bool waypoint;

   243

	byte orig_type = 0;

   244

	Axis orig_axis = AXIS_X;

   245

   246

	waypoint = IsTileType(tile, MP_RAILWAY);

   247

   248

	if (waypoint) {

   249

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   250

	} else {

   251

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   252

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   253

	}

   254

   255

	while (true) {

   256

		TileIndex new_tile = TILE_ADD(tile, delta);

   257

   258

		if (waypoint) {

   259

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

   260

			if (!IsRailWaypoint(new_tile)) break;

   261

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

   262

		} else {

   263

			if (!IsRailwayStationTile(new_tile)) break;

   264

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

   265

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

   266

		}

   267

   268

		tile = new_tile;

   269

	}

   270

	return tile;

   271

}

   272

   273

   274

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

   275

{

   276

	int tx = TileX(tile);

   277

	int ty = TileY(tile);

   278

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

   279

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

   280

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

   281

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

   282

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

   283

   284

	tx -= sx; ex -= sx;

   285

	ty -= sy; ey -= sy;

   286

   287

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

   288

}

   289

   290

   291

static uint32 GetRailContinuationInfo(TileIndex tile)

   292

{

   293

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

   294

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

   295

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

   296

   297

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

   298

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

   299

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

   300

   301

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

   302

   303

	/* Choose appropriate lookup table to use */

   304

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

   305

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

   306

   307

	uint32 res = 0;

   308

	uint i;

   309

   310

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

   311

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

   312

		if (ts != 0) {

   313

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

   314

			SETBIT(res, i + 8);

   315

   316

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

   317

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

   318

		}

   319

	}

   320

   321

	return res;

   322

}

   323

   324

   325

/* Station Resolver Functions */

   326

static uint32 StationGetRandomBits(const ResolverObject *object)

   327

{

   328

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

   329

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

   330

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

   331

}

   332

   333

   334

static uint32 StationGetTriggers(const ResolverObject *object)

   335

{

   336

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

   337

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

   338

}

   339

   340

   341

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

   342

{

   343

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

   344

	assert(st != NULL);

   345

	st->waiting_triggers = triggers;

   346

}

   347

   348

/**

   349

 * Station variable cache

   350

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

   351

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

   352

 */

   353

static struct {

   354

	uint32 v40;

   355

	uint32 v41;

   356

	uint32 v45;

   357

	uint32 v46;

   358

	uint32 v47;

   359

	uint32 v49;

   360

	uint8 valid;

   361

} _svc;

   362

   363

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

   364

{

   365

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

   366

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

   367

   368

	if (object->scope == VSG_SCOPE_PARENT) {

   369

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

   370

		Town *t;

   371

   372

		if (st != NULL) {

   373

			t = st->town;

   374

		} else if (tile != INVALID_TILE) {

   375

			t = GetTownByTile(tile);

   376

		} else {

   377

			*available = false;

   378

			return UINT_MAX;

   379

		}

   380

   381

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

   382

	}

   383

   384

	if (st == NULL) {

   385

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

   386

		switch (variable) {

   387

			case 0x40:

   388

			case 0x41:

   389

			case 0x46:

   390

			case 0x47:

   391

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

   392

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

   393

			case 0x43: return _current_player; // Station owner

   394

			case 0x44: return 2;               // PBS status

   395

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

   396

		}

   397

   398

		*available = false;

   399

		return UINT_MAX;

   400

	}

   401

   402

	switch (variable) {

   403

		/* Calculated station variables */

   404

		case 0x40:

   405

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

   406

			return _svc.v40;

   407

   408

		case 0x41:

   409

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

   410

			return _svc.v41;

   411

   412

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

   413

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

   414

		case 0x44: return 2;         // PBS status

   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

		/* Variables which use the parameter */

   441

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

   442

   443

		/* General station properties */

   444

		case 0x82: return 50;

   445

		case 0x84: return st->string_id;

   446

		case 0x86: return 0;

   447

		case 0x8A: return st->had_vehicle_of_type;

   448

		case 0xF0: return st->facilities;

   449

		case 0xF1: return st->airport_type;

   450

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

   451

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

   452

		case 0xF6: return st->airport_flags;

   453

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

   454

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

   455

	}

   456

   457

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

   458

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

   459

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

   460

   461

		if (c == CT_INVALID) return 0;

   462

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

   463

   464

		switch (variable) {

   465

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

   466

			case 0x61: return ge->days_since_pickup;

   467

			case 0x62: return ge->rating;

   468

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

   469

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

   470

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

   471

		}

   472

	}

   473

   474

	/* Handle cargo variables (deprecated) */

   475

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

   476

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

   477

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

   478

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

   479

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

   480

			case 2: return g->days_since_pickup;

   481

			case 3: return g->rating;

   482

			case 4: return g->cargo.Source();

   483

			case 5: return g->cargo.DaysInTransit();

   484

			case 6: return g->last_speed;

   485

			case 7: return g->last_age;

   486

		}

   487

	}

   488

   489

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

   490

   491

	*available = false;

   492

	return UINT_MAX;