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

     8

#include "sprite.h"

     9

#include "table/strings.h"

    10

#include "station.h"

    11

#include "station_map.h"

    12

#include "newgrf_station.h"

    13

    14

static StationClass station_classes[STAT_CLASS_MAX];

    15

    16

/**

    17

 * Reset station classes to their default state.

    18

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

    19

 * entry, for standard stations and waypoints.

    20

 */

    21

void ResetStationClasses(void)

    22

{

    23

	StationClassID i;

    24

	for (i = 0; i < STAT_CLASS_MAX; i++) {

    25

		station_classes[i].id = 0;

    26

		station_classes[i].name = STR_EMPTY;

    27

		station_classes[i].stations = 0;

    28

    29

		free(station_classes[i].spec);

    30

		station_classes[i].spec = NULL;

    31

	}

    32

    33

	// Set up initial data

    34

	station_classes[0].id = 'DFLT';

    35

	station_classes[0].name = STR_STAT_CLASS_DFLT;

    36

	station_classes[0].stations = 1;

    37

	station_classes[0].spec = malloc(sizeof(*station_classes[0].spec));

    38

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

    39

    40

	station_classes[1].id = 'WAYP';

    41

	station_classes[1].name = STR_STAT_CLASS_WAYP;

    42

	station_classes[1].stations = 1;

    43

	station_classes[1].spec = malloc(sizeof(*station_classes[1].spec));

    44

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

    45

}

    46

    47

/**

    48

 * Allocate a station class for the given class id.

    49

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

    50

 * @return Index into station_classes of allocated class.

    51

 */

    52

StationClassID AllocateStationClass(uint32 class)

    53

{

    54

	StationClassID i;

    55

    56

	for (i = 0; i < STAT_CLASS_MAX; i++) {

    57

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

    58

			// ClassID is already allocated, so reuse it.

    59

			return i;

    60

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

    61

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

    62

			station_classes[i].id = class;

    63

			return i;

    64

		}

    65

	}

    66

    67

	DEBUG(grf, 2)("StationClassAllocate: Already allocated %d classes, using default.", STAT_CLASS_MAX);

    68

	return STAT_CLASS_DFLT;

    69

}

    70

   104

/**

   105

 * Get the number of station classes in use.

   106

 * @return Number of station classes.

   107

 */

   108

uint GetNumStationClasses(void)

   109

{

   110

	uint i;

   111

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

   112

	return i;

   113

}

   114

   115

/**

   116

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

   117

 * @param sclass Index of the station class.

   118

 * @return Number of stations in the class.

   119

 */

   120

uint GetNumCustomStations(StationClassID sclass)

   121

{

   122

	assert(sclass < STAT_CLASS_MAX);

   123

	return station_classes[sclass].stations;

   124

}

   125

   126

/**

   127

 * Tie a station spec to its station class.

   128

 * @param spec The station spec.

   129

 */

   130

void SetCustomStation(StationSpec *spec)

   131

{

   132

	StationClass *station_class;

   133

	int i;

   134

   135

	assert(spec->sclass < STAT_CLASS_MAX);

   136

	station_class = &station_classes[spec->sclass];

   137

   138

	i = station_class->stations++;

   139

	station_class->spec = realloc(station_class->spec, station_class->stations * sizeof(*station_class->spec));

   140

   141

	station_class->spec[i] = spec;

   142

}

   143

   144

/**

   145

 * Retrieve a station spec from a class.

   146

 * @param sclass Index of the station class.

   147

 * @param station The station index with the class.

   148

 * @return The station spec.

   149

 */

   150

const StationSpec *GetCustomStation(StationClassID sclass, uint station)

   151

{

   152

	assert(sclass < STAT_CLASS_MAX);

   153

	if (station < station_classes[sclass].stations)

   154

		return station_classes[sclass].spec[station];

   155

   156

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

   157

	// probably was not loaded.

   158

	return NULL;

   159

}

   160

   161

static const RealSpriteGroup *ResolveStationSpriteGroup(const SpriteGroup *spg, const Station *st)

   162

{

   163

	if (spg == NULL) return NULL;

   164

	switch (spg->type) {

   165

		case SGT_REAL:

   166

			return &spg->g.real;

   167

   168

		case SGT_DETERMINISTIC: {

   169

			const DeterministicSpriteGroup *dsg = &spg->g.determ;

   170

			SpriteGroup *target;

   171

			int value = -1;

   172

   173

			if ((dsg->variable >> 6) == 0) {

   174

				/* General property */

   175

				value = GetDeterministicSpriteValue(dsg->variable);

   176

			} else {

   177

				if (st == NULL) {

   178

					/* We are in a build dialog of something,

   179

					 * and we are checking for something undefined.

   180

					 * That means we should get the first target

   181

					 * (NOT the default one). */

   182

					if (dsg->num_ranges > 0) {

   183

						target = dsg->ranges[0].group;

   184

					} else {

   185

						target = dsg->default_group;

   186

					}

   187

					return ResolveStationSpriteGroup(target, NULL);

   188

				}

   189

   190

				/* Station-specific property. */

   191

				if (dsg->var_scope == VSG_SCOPE_PARENT) {

   192

					/* TODO: Town structure. */

   193

   194

				} else /* VSG_SELF */ {

   195

					if (dsg->variable == 0x40 || dsg->variable == 0x41) {

   196

						/* FIXME: This is ad hoc only

   197

						 * for waypoints. */

   198

						value = 0x01010000;

   199

					} else {

   200

						/* TODO: Only small fraction done. */

   201

						// TTDPatch runs on little-endian arch;

   202

						// Variable is 0x70 + offset in the TTD's station structure

   203

						switch (dsg->variable - 0x70) {

   204

							case 0x80: value = st->facilities;             break;

   205

							case 0x81: value = st->airport_type;           break;

   206

							case 0x82: value = st->truck_stops->status;    break;

   207

							case 0x83: value = st->bus_stops->status;      break;

   208

							case 0x86: value = st->airport_flags & 0xFFFF; break;

   209

							case 0x87: value = st->airport_flags & 0xFF;   break;

   210

							case 0x8A: value = st->build_date;             break;

   211

						}

   212

					}

   213

				}

   214

			}

   215

   216

			target = value != -1 ? EvalDeterministicSpriteGroup(dsg, value) : dsg->default_group;

   217

			return ResolveStationSpriteGroup(target, st);

   218

		}

   219

   220

		default:

   221

		case SGT_RANDOMIZED:

   222

			DEBUG(grf, 6)("I don't know how to handle random spritegroups yet!");

   223

			return NULL;

   224

	}

   225

}

   226

   227

uint32 GetCustomStationRelocation(const StationSpec *spec, const Station *st, byte ctype)

   228

{

   229

	const RealSpriteGroup *rsg = ResolveStationSpriteGroup(spec->spritegroup[ctype], st);

   230

	if (rsg == NULL) return 0;

   231

   232

	if (rsg->sprites_per_set != 0) {

   233

		if (rsg->loading_count != 0) return rsg->loading[0]->g.result.result;

   234

		if (rsg->loaded_count != 0) return rsg->loaded[0]->g.result.result;

   235

	}

   236

   237

	DEBUG(grf, 6)("Custom station 0x%08x::0x%02x has no sprites associated.",

   238

		spec->grfid, spec->localidx);

   239

	/* This is what gets subscribed of dtss->image in newgrf.c,

   240

	 * so it's probably kinda "default offset". Try to use it as

   241

	 * emergency measure. */

   242

	return 0;

   243

}

   244

   245

   246

/**

   247

 * Allocate a StationSpec to a Station. This is called once per build operation.

   248

 * @param spec StationSpec to allocate.

   249

 * @param st Station to allocate it to.

   250

 * @param exec Whether to actually allocate the spec.

   251

 * @return Index within the Station's spec list, or -1 if the allocation failed.

   252

 */

   253

int AllocateSpecToStation(const StationSpec *spec, Station *st, bool exec)

   254

{

   255

	uint i;

   256

   257

	if (spec == NULL) return 0;

   258

   259

	/* Check if this spec has already been allocated */

   260

	for (i = 1; i < st->num_specs && i < 256; i++) {

   261

		if (st->speclist[i].spec == spec) return i;

   262

	}

   263

   264

	for (i = 1; i < st->num_specs && i < 256; i++) {

   265

		if (st->speclist[i].spec == NULL && st->speclist[i].grfid == 0) break;

   266

	}

   267

   268

	if (i < 256) {

   269

		if (exec) {

   270

			if (i >= st->num_specs) {

   271

				st->num_specs = i + 1;

   272

				st->speclist = realloc(st->speclist, st->num_specs * sizeof(*st->speclist));

   273

   274

				if (st->num_specs == 2) {

   275

					/* Initial allocation */

   276

					st->speclist[0].spec     = NULL;

   277

					st->speclist[0].grfid    = 0;

   278

					st->speclist[0].localidx = 0;

   279

				}

   280

			}

   281

   282

			st->speclist[i].spec     = spec;

   283

			st->speclist[i].grfid    = spec->grfid;

   284

			st->speclist[i].localidx = spec->localidx;

   285

		}

   286

		return i;

   287

	}

   288

   289

	return -1;

   290

}

   291

   292

   293

/** Deallocate a StationSpec from a Station. Called when removing a single station tile.

   294

 * @param st Station to work with.

   295

 * @param specindex Index of the custom station within the Station's spec list.

   296

 * @return Indicates whether the StationSpec was deallocated.

   297

 */

   298

bool DeallocateSpecFromStation(Station *st, byte specindex)

   299

{

   300

	bool freeable = true;

   301

   302

	/* specindex of 0 (default) is never freeable */

   303

	if (specindex == 0) return false;

   304

   305

	/* Check all tiles over the station to check if the specindex is still in use */

   306

	BEGIN_TILE_LOOP(tile, st->trainst_w, st->trainst_h, st->train_tile) {

   307

		if (IsTileType(tile, MP_STATION) && GetStationIndex(tile) == st->index && IsRailwayStation(tile) && GetCustomStationSpecIndex(tile) == specindex) {

   308

			freeable = false;

   309

			break;

   310

		}

   311

	} END_TILE_LOOP(tile, st->trainst_w, st->trainst_h, st->train_tile)

   312

   313

	if (freeable) {

   314

		/* This specindex is no longer in use, so deallocate it */

   315

		st->speclist[specindex].spec     = NULL;

   316

		st->speclist[specindex].grfid    = 0;

   317

		st->speclist[specindex].localidx = 0;

   318

   319

		/* If this was the highest spec index, reallocate */

   320

		if (specindex == st->num_specs - 1) {

   321

			for (; st->speclist[st->num_specs - 1].grfid == 0 && st->num_specs > 1; st->num_specs--);

   322

   323

			if (st->num_specs > 1) {

   324

				st->speclist = realloc(st->speclist, st->num_specs * sizeof(*st->speclist));

   325

			} else {

   326

				free(st->speclist);

   327

				st->num_specs = 0;

   328

				st->speclist  = NULL;

   329

			}

   330

		}

   331

	}

   332

   333

	return freeable;

   334

}