peter1138@2625: /* $Id$ */
peter1138@2625: 
peter1138@2963: /** @file newgrf_station.c Functions for dealing with station classes and custom stations. */
peter1138@2625: 
peter1138@2625: #include "stdafx.h"
peter1138@2625: #include "openttd.h"
peter1138@2625: #include "debug.h"
peter1138@2625: #include "sprite.h"
peter1138@2967: #include "station.h"
peter1138@2963: #include "newgrf_station.h"
peter1138@2625: 
peter1138@2625: static StationClass station_classes[STAT_CLASS_MAX];
peter1138@2625: 
peter1138@2625: /**
peter1138@2625:  * Reset station classes to their default state.
peter1138@2625:  * This includes initialising the Default and Waypoint classes with an empty
peter1138@2625:  * entry, for standard stations and waypoints.
peter1138@2625:  */
peter1138@2625: void ResetStationClasses(void)
peter1138@2625: {
peter1138@2625: 	StationClassID i;
peter1138@2625: 	for (i = 0; i < STAT_CLASS_MAX; i++) {
peter1138@2625: 		station_classes[i].id = 0;
peter1138@2625: 
peter1138@2625: 		free(station_classes[i].name);
peter1138@2625: 		station_classes[i].name = NULL;
peter1138@2625: 
peter1138@2625: 		station_classes[i].stations = 0;
peter1138@2625: 
peter1138@2625: 		free(station_classes[i].spec);
peter1138@2625: 		station_classes[i].spec = NULL;
peter1138@2625: 	}
peter1138@2625: 
peter1138@2625: 	// Set up initial data
peter1138@2625: 	station_classes[0].id = 'DFLT';
peter1138@2625: 	station_classes[0].name = strdup("Default");
peter1138@2625: 	station_classes[0].stations = 1;
peter1138@2625: 	station_classes[0].spec = malloc(sizeof(*station_classes[0].spec));
peter1138@2625: 	station_classes[0].spec[0] = NULL;
peter1138@2625: 
peter1138@2625: 	station_classes[1].id = 'WAYP';
peter1138@2625: 	station_classes[1].name = strdup("Waypoints");
peter1138@2625: 	station_classes[1].stations = 1;
peter1138@2625: 	station_classes[1].spec = malloc(sizeof(*station_classes[1].spec));
peter1138@2625: 	station_classes[1].spec[0] = NULL;
peter1138@2625: }
peter1138@2625: 
peter1138@2625: /**
peter1138@2625:  * Allocate a station class for the given class id.
peter1138@2625:  * @param classid A 32 bit value identifying the class.
peter1138@2625:  * @return Index into station_classes of allocated class.
peter1138@2625:  */
peter1138@2625: StationClassID AllocateStationClass(uint32 class)
peter1138@2625: {
peter1138@2625: 	StationClassID i;
peter1138@2625: 
peter1138@2625: 	for (i = 0; i < STAT_CLASS_MAX; i++) {
peter1138@2625: 		if (station_classes[i].id == class) {
peter1138@2625: 			// ClassID is already allocated, so reuse it.
peter1138@2625: 			return i;
peter1138@2625: 		} else if (station_classes[i].id == 0) {
peter1138@2625: 			// This class is empty, so allocate it to the ClassID.
peter1138@2625: 			station_classes[i].id = class;
peter1138@2625: 			return i;
peter1138@2625: 		}
peter1138@2625: 	}
peter1138@2625: 
peter1138@2625: 	DEBUG(grf, 2)("StationClassAllocate: Already allocated %d classes, using default.", STAT_CLASS_MAX);
peter1138@2625: 	return STAT_CLASS_DFLT;
peter1138@2625: }
peter1138@2625: 
peter1138@2625: /**
peter1138@2625:  * Return the number of stations for the given station class.
peter1138@2625:  * @param sclass Index of the station class.
peter1138@2625:  * @return Number of stations in the class.
peter1138@2625:  */
peter1138@2625: uint GetNumCustomStations(StationClassID sclass)
peter1138@2625: {
peter1138@2625: 	assert(sclass < STAT_CLASS_MAX);
peter1138@2625: 	return station_classes[sclass].stations;
peter1138@2625: }
peter1138@2625: 
peter1138@2625: /**
peter1138@2625:  * Tie a station spec to its station class.
peter1138@2625:  * @param spec The station spec.
peter1138@2625:  */
peter1138@2625: void SetCustomStation(StationSpec *spec)
peter1138@2625: {
peter1138@2625: 	StationClass *station_class;
peter1138@2625: 	int i;
peter1138@2625: 
peter1138@2625: 	assert(spec->sclass < STAT_CLASS_MAX);
peter1138@2625: 	station_class = &station_classes[spec->sclass];
peter1138@2625: 
peter1138@2625: 	i = station_class->stations++;
peter1138@2625: 	station_class->spec = realloc(station_class->spec, station_class->stations * sizeof(*station_class->spec));
peter1138@2625: 
peter1138@2625: 	station_class->spec[i] = spec;
peter1138@2625: }
peter1138@2625: 
peter1138@2625: /**
peter1138@2625:  * Retrieve a station spec from a class.
peter1138@2625:  * @param sclass Index of the station class.
peter1138@2625:  * @param station The station index with the class.
peter1138@2625:  * @return The station spec.
peter1138@2625:  */
peter1138@2625: const StationSpec *GetCustomStation(StationClassID sclass, uint station)
peter1138@2625: {
peter1138@2625: 	assert(sclass < STAT_CLASS_MAX);
peter1138@2625: 	if (station < station_classes[sclass].stations)
peter1138@2625: 		return station_classes[sclass].spec[station];
peter1138@2625: 
peter1138@2625: 	// If the custom station isn't defined any more, then the GRF file
peter1138@2625: 	// probably was not loaded.
peter1138@2625: 	return NULL;
peter1138@2625: }
peter1138@2967: 
peter1138@2967: static const RealSpriteGroup *ResolveStationSpriteGroup(const SpriteGroup *spg, const Station *st)
peter1138@2967: {
peter1138@2967: 	switch (spg->type) {
peter1138@2967: 		case SGT_REAL:
peter1138@2967: 			return &spg->g.real;
peter1138@2967: 
peter1138@2967: 		case SGT_DETERMINISTIC: {
peter1138@2967: 			const DeterministicSpriteGroup *dsg = &spg->g.determ;
peter1138@2967: 			SpriteGroup *target;
peter1138@2967: 			int value = -1;
peter1138@2967: 
peter1138@2967: 			if ((dsg->variable >> 6) == 0) {
peter1138@2967: 				/* General property */
peter1138@2967: 				value = GetDeterministicSpriteValue(dsg->variable);
peter1138@2967: 			} else {
peter1138@2967: 				if (st == NULL) {
peter1138@2967: 					/* We are in a build dialog of something,
peter1138@2967: 					 * and we are checking for something undefined.
peter1138@2967: 					 * That means we should get the first target
peter1138@2967: 					 * (NOT the default one). */
peter1138@2967: 					if (dsg->num_ranges > 0) {
peter1138@2967: 						target = dsg->ranges[0].group;
peter1138@2967: 					} else {
peter1138@2967: 						target = dsg->default_group;
peter1138@2967: 					}
peter1138@2967: 					return ResolveStationSpriteGroup(target, NULL);
peter1138@2967: 				}
peter1138@2967: 
peter1138@2967: 				/* Station-specific property. */
peter1138@2967: 				if (dsg->var_scope == VSG_SCOPE_PARENT) {
peter1138@2967: 					/* TODO: Town structure. */
peter1138@2967: 
peter1138@2967: 				} else /* VSG_SELF */ {
peter1138@2967: 					if (dsg->variable == 0x40 || dsg->variable == 0x41) {
peter1138@2967: 						/* FIXME: This is ad hoc only
peter1138@2967: 						 * for waypoints. */
peter1138@2967: 						value = 0x01010000;
peter1138@2967: 					} else {
peter1138@2967: 						/* TODO: Only small fraction done. */
peter1138@2967: 						// TTDPatch runs on little-endian arch;
peter1138@2967: 						// Variable is 0x70 + offset in the TTD's station structure
peter1138@2967: 						switch (dsg->variable - 0x70) {
peter1138@2967: 							case 0x80: value = st->facilities;             break;
peter1138@2967: 							case 0x81: value = st->airport_type;           break;
peter1138@2967: 							case 0x82: value = st->truck_stops->status;    break;
peter1138@2967: 							case 0x83: value = st->bus_stops->status;      break;
peter1138@2967: 							case 0x86: value = st->airport_flags & 0xFFFF; break;
peter1138@2967: 							case 0x87: value = st->airport_flags & 0xFF;   break;
peter1138@2967: 							case 0x8A: value = st->build_date;             break;
peter1138@2967: 						}
peter1138@2967: 					}
peter1138@2967: 				}
peter1138@2967: 			}
peter1138@2967: 
peter1138@2967: 			target = value != -1 ? EvalDeterministicSpriteGroup(dsg, value) : dsg->default_group;
peter1138@2967: 			return ResolveStationSpriteGroup(target, st);
peter1138@2967: 		}
peter1138@2967: 
peter1138@2967: 		default:
peter1138@2967: 		case SGT_RANDOMIZED:
peter1138@2967: 			DEBUG(grf, 6)("I don't know how to handle random spritegroups yet!");
peter1138@2967: 			return NULL;
peter1138@2967: 	}
peter1138@2967: }
peter1138@2967: 
peter1138@2967: uint32 GetCustomStationRelocation(const StationSpec *spec, const Station *st, byte ctype)
peter1138@2967: {
peter1138@2967: 	const RealSpriteGroup *rsg = ResolveStationSpriteGroup(spec->spritegroup[ctype], st);
peter1138@2967: 
peter1138@2967: 	if (rsg->sprites_per_set != 0) {
peter1138@2967: 		if (rsg->loading_count != 0) return rsg->loading[0]->g.result.result;
peter1138@2967: 		if (rsg->loaded_count != 0) return rsg->loaded[0]->g.result.result;
peter1138@2967: 	}
peter1138@2967: 
peter1138@2967: 	DEBUG(grf, 6)("Custom station 0x%08x::0x%02x has no sprites associated.",
peter1138@2967: 		spec->grfid, spec->localidx);
peter1138@2967: 	/* This is what gets subscribed of dtss->image in newgrf.c,
peter1138@2967: 	 * so it's probably kinda "default offset". Try to use it as
peter1138@2967: 	 * emergency measure. */
peter1138@2967: 	return 0;
peter1138@2967: }