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

    71

/**

    72

 * Get the number of station classes in use.

    73

 * @return Number of station classes.

    74

 */

    75

uint GetNumStationClasses(void)

    76

{

    77

	uint i;

    78

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

    79

	return i;

    80

}

    81

    82

/**

    83

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

    84

 * @param sclass Index of the station class.

    85

 * @return Number of stations in the class.

    86

 */

    87

uint GetNumCustomStations(StationClassID sclass)

    88

{

    89

	assert(sclass < STAT_CLASS_MAX);

    90

	return station_classes[sclass].stations;

    91

}

    92

    93

/**

    94

 * Tie a station spec to its station class.

    95

 * @param spec The station spec.

    96

 */

    97

void SetCustomStation(StationSpec *spec)

    98

{

    99

	StationClass *station_class;

   100

	int i;

   101

   102

	assert(spec->sclass < STAT_CLASS_MAX);

   103

	station_class = &station_classes[spec->sclass];

   104

   105

	i = station_class->stations++;

   106

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

   107

   108

	station_class->spec[i] = spec;

   109

}

   110

   111

/**

   112

 * Retrieve a station spec from a class.

   113

 * @param sclass Index of the station class.

   114

 * @param station The station index with the class.

   115

 * @return The station spec.

   116

 */

   117

const StationSpec *GetCustomStation(StationClassID sclass, uint station)

   118

{

   119

	assert(sclass < STAT_CLASS_MAX);

   120

	if (station < station_classes[sclass].stations)

   121

		return station_classes[sclass].spec[station];

   122

   123

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

   124

	// probably was not loaded.

   125

	return NULL;

   126

}

   127

   128

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

   129

{

   130

	if (spg == NULL) return NULL;

   131

	switch (spg->type) {

   132

		case SGT_REAL:

   133

			return &spg->g.real;

   134

   135

		case SGT_DETERMINISTIC: {

   136

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

   137

			SpriteGroup *target;

   138

			int value = -1;

   139

   140

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

   141

				/* General property */

   142

				value = GetDeterministicSpriteValue(dsg->variable);

   143

			} else {

   144

				if (st == NULL) {

   145

					/* We are in a build dialog of something,

   146

					 * and we are checking for something undefined.

   147

					 * That means we should get the first target

   148

					 * (NOT the default one). */

   149

					if (dsg->num_ranges > 0) {

   150

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

   151

					} else {

   152

						target = dsg->default_group;

   153

					}

   154

					return ResolveStationSpriteGroup(target, NULL);

   155

				}

   156

   157

				/* Station-specific property. */

   158

				if (dsg->var_scope == VSG_SCOPE_PARENT) {

   159

					/* TODO: Town structure. */

   160

   161

				} else /* VSG_SELF */ {

   162

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

   163

						/* FIXME: This is ad hoc only

   164

						 * for waypoints. */

   165

						value = 0x01010000;

   166

					} else {

   167

						/* TODO: Only small fraction done. */

   168

						// TTDPatch runs on little-endian arch;

   169

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

   170

						switch (dsg->variable - 0x70) {

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

						}

   179

					}

   180

				}

   181

			}

   182

   183

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

   184

			return ResolveStationSpriteGroup(target, st);

   185

		}

   186

   187

		default:

   188

		case SGT_RANDOMIZED:

   189

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

   190

			return NULL;

   191

	}

   192

}

   193

   194

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

   195

{

   196

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

   197

	if (rsg == NULL) return 0;

   198

   199

	if (rsg->sprites_per_set != 0) {

   200

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

   201

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

   202

	}

   203

   204

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

   205

		spec->grfid, spec->localidx);

   206

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

   207

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

   208

	 * emergency measure. */

   209

	return 0;

   210

}

   211

   212

   213

/**

   214

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

   215

 * @param spec StationSpec to allocate.

   216

 * @param st Station to allocate it to.

   217

 * @param exec Whether to actually allocate the spec.

   218

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

   219

 */

   220

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

   221

{

   222

	uint i;

   223

   224

	if (spec == NULL) return 0;

   225

   226

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

   227

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

   228

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

   229

	}

   230

   231

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

   232

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

   233

	}

   234

   235

	if (i < 256) {

   236

		if (exec) {

   237

			if (i >= st->num_specs) {

   238

				st->num_specs = i + 1;

   239

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

   240

   241

				if (st->num_specs == 2) {

   242

					/* Initial allocation */

   243

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

   244

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

   245

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

   246

				}

   247

			}

   248

   249

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

   250

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

   251

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

   252

		}

   253

		return i;

   254

	}

   255

   256

	return -1;

   257

}

   258

   259

   260

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

   261

 * @param st Station to work with.

   262

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

   263

 * @return Indicates whether the StationSpec was deallocated.

   264

 */

   265

bool DeallocateSpecFromStation(Station *st, byte specindex)

   266

{

   267

	bool freeable = true;

   268

   269

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

   270

	if (specindex == 0) return false;

   271

   272

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

   273

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

   274

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

   275

			freeable = false;

   276

			break;

   277

		}

   278

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

   279

   280

	if (freeable) {

   281

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

   282

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

   283

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

   284

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

   285

   286

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

   287

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

   288

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

   289

   290

			if (st->num_specs > 1) {

   291

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

   292

			} else {

   293

				free(st->speclist);

   294

				st->num_specs = 0;

   295

				st->speclist  = NULL;

   296

			}

   297

		}

   298

	}

   299

   300

	return freeable;

   301

}