mirrors
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

(svn r16914) -Codechange: split Station and BaseStation into different files

This commit is contained in:
rubidium 2009-07-22 11:35:35 +00:00
parent da9d9a27fe
commit 6e3d999dce
16 changed files with 212 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
projects/openttd_vs80.vcproj
View File

@ -827,6 +827,10 @@
RelativePath=".\..\src\aystar.h"
>
</File>
<File
RelativePath=".\..\src\base_station_base.h"
>
</File>
<File
RelativePath=".\..\src\bmp.h"
>

4
projects/openttd_vs90.vcproj
View File

@ -824,6 +824,10 @@
RelativePath=".\..\src\aystar.h"
>
</File>
<File
RelativePath=".\..\src\base_station_base.h"
>
</File>
<File
RelativePath=".\..\src\bmp.h"
>

1
source.list
View File

@ -135,6 +135,7 @@ autoreplace_gui.h
autoreplace_type.h
autoslope.h
aystar.h
base_station_base.h
bmp.h
bridge.h
callback_table.h

192
src/base_station_base.h Normal file
View File

@ -0,0 +1,192 @@
/* $Id$ */
/** @file base_station_base.h Base classes/functions for base stations. */
#ifndef BASE_STATION_BASE_H
#define BASE_STATION_BASE_H
#include "station_type.h"
#include "core/pool_type.hpp"
#include "town_type.h"
#include "strings_type.h"
#include "date_type.h"
#include "company_type.h"
#include "viewport_type.h"
#include "station_map.h"
typedef Pool<BaseStation, StationID, 32, 64000> StationPool;
extern StationPool _station_pool;
struct StationSpecList {
const StationSpec *spec;
uint32 grfid; ///< GRF ID of this custom station
uint8 localidx; ///< Station ID within GRF of station
};
/** Represents the covered area */
struct TileArea {
TileIndex tile; ///< The base tile of the area
uint8 w; ///< The width of the area
uint8 h; ///< The height of the area
};
/** Base class for all station-ish types */
struct BaseStation : StationPool::PoolItem<&_station_pool> {
TileIndex xy; ///< Base tile of the station
ViewportSign sign; ///< NOSAVE: Dimensions of sign
byte delete_ctr; ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.
char *name; ///< Custom name
StringID string_id; ///< Default name (town area) of station
Town *town; ///< The town this station is associated with
OwnerByte owner; ///< The owner of this station
StationFacilityByte facilities; ///< The facilities that this station has
uint8 num_specs; ///< Number of specs in the speclist
StationSpecList *speclist; ///< List of station specs of this station
Date build_date; ///< Date of construction
uint16 random_bits; ///< Random bits assigned to this station
byte waiting_triggers; ///< Waiting triggers (NewGRF) for this station
uint8 cached_anim_triggers; ///< NOSAVE: Combined animation trigger bitmask, used to determine if trigger processing should happen.
BaseStation(TileIndex tile) : xy(tile) { }
virtual ~BaseStation();
/**
* Check whether a specific tile belongs to this station.
* @param tile the tile to check
* @return true if the tile belongs to this station
*/
virtual bool TileBelongsToRailStation(TileIndex tile) const = 0;
/**
* Helper function to get a NewGRF variable that isn't implemented by the base class.
* @param object the resolver object related to this query
* @param variable that is queried
* @param parameter parameter for that variable
* @param available will return false if ever the variable asked for does not exist
* @return the value stored in the corresponding variable
*/
virtual uint32 GetNewGRFVariable(const struct ResolverObject *object, byte variable, byte parameter, bool *available) const = 0;
/**
* Update the coordinated of the sign (as shown in the viewport).
*/
virtual void UpdateVirtCoord() = 0;
/**
* Get the tile area for a given station type.
* @param ta tile area to fill.
* @param type the type of the area
*/
virtual void GetTileArea(TileArea *ta, StationType type) const = 0;
/**
* Get the base station belonging to a specific tile.
* @param tile The tile to get the base station from.
* @return the station associated with that tile.
*/
static FORCEINLINE BaseStation *GetByTile(TileIndex tile)
{
return BaseStation::Get(GetStationIndex(tile));
}
};
#define FOR_ALL_BASE_STATIONS(var) FOR_ALL_ITEMS_FROM(BaseStation, station_index, var, 0)
/**
* Class defining several overloaded accessors so we don't
* have to cast base stations that often
*/
template <class T, bool Tis_waypoint>
struct SpecializedStation : public BaseStation {
static const StationFacility EXPECTED_FACIL = Tis_waypoint ? FACIL_WAYPOINT : FACIL_NONE; ///< Specialized type
/**
* Set station type correctly
* @param tile The base tile of the station.
*/
FORCEINLINE SpecializedStation<T, Tis_waypoint>(TileIndex tile) :
BaseStation(tile)
{
this->facilities = EXPECTED_FACIL;
}
/**
* Helper for checking whether the given station is of this type.
* @param st the station to check.
* @return true if the station is the type we expect it to be.
*/
static FORCEINLINE bool IsExpected(const BaseStation *st)
{
return (st->facilities & FACIL_WAYPOINT) == EXPECTED_FACIL;
}
/**
* Tests whether given index is a valid index for station of this type
* @param index tested index
* @return is this index valid index of T?
*/
static FORCEINLINE bool IsValidID(size_t index)
{
return BaseStation::IsValidID(index) && IsExpected(BaseStation::Get(index));
}
/**
* Gets station with given index
* @return pointer to station with given index casted to T *
*/
static FORCEINLINE T *Get(size_t index)
{
return (T *)BaseStation::Get(index);
}
/**
* Returns station if the index is a valid index for this station type
* @return pointer to station with given index if it's a station of this type
*/
static FORCEINLINE T *GetIfValid(size_t index)
{
return IsValidID(index) ? Get(index) : NULL ;
}
/**
* Get the station belonging to a specific tile.
* @param tile The tile to get the station from.
* @return the station associated with that tile.
*/
static FORCEINLINE T *GetByTile(TileIndex tile)
{
return GetIfValid(GetStationIndex(tile));
}
/**
* Converts a BaseStation to SpecializedStation with type checking.
* @param st BaseStation pointer
* @return pointer to SpecializedStation
*/
static FORCEINLINE T *From(BaseStation *st)
{
assert(IsExpected(st));
return (T *)st;
}
/**
* Converts a const BaseStation to const SpecializedStation with type checking.
* @param st BaseStation pointer
* @return pointer to SpecializedStation
*/
static FORCEINLINE const T *From(const BaseStation *st)
{
assert(IsExpected(st));
return (const T *)st;
}
};
#define FOR_ALL_BASE_STATIONS_OF_TYPE(name, var) FOR_ALL_ITEMS_FROM(name, station_index, var, 0) if (name::IsExpected(var))
#endif /* STATION_BASE_H */

2
src/cargopacket.cpp
View File

@ -3,9 +3,9 @@
/** @file cargopacket.cpp Implementation of the cargo packets */
#include "stdafx.h"
#include "station_base.h"
#include "core/pool_func.hpp"
#include "economy_base.h"
#include "station_base.h"
/* Initialize the cargopacket-pool */
CargoPacketPool _cargopacket_pool("CargoPacket");

2
src/economy_base.h
View File

@ -6,6 +6,8 @@
#define ECONOMY_BASE_H
#include "cargopacket.h"
#include "vehicle_type.h"
#include "company_type.h"
/** Type of pool to store cargo payments in. */
typedef Pool<CargoPayment, CargoPaymentID, 512, 64000> CargoPaymentPool;

3
src/industry.h
View File

@ -16,6 +16,9 @@
#include "town_type.h"
#include "industry_type.h"
#include "landscape_type.h"
#include "tile_type.h"
#include "company_type.h"
#include "strings_type.h"
enum {
INVALID_INDUSTRY = 0xFFFF,

1
src/npf.cpp
View File

@ -12,7 +12,6 @@
#include "tunnelbridge_map.h"
#include "functions.h"
#include "vehicle_base.h"
#include "station_base.h"
#include "tunnelbridge.h"
#include "pbs.h"
#include "settings_type.h"

1
src/pathfind.cpp
View File

@ -3,7 +3,6 @@
/** @file pathfind.cpp Implementation of the oldest supported pathfinder. */
#include "stdafx.h"
#include "station_base.h"
#include "settings_type.h"
#include "pathfind.h"
#include "debug.h"

1
src/pathfind.h
View File

@ -6,6 +6,7 @@
#define PATHFIND_H
#include "direction_type.h"
#include "station_base.h"
enum {
STR_FACTOR = 2,

181
src/station_base.h
View File

@ -5,20 +5,13 @@
#ifndef STATION_BASE_H
#define STATION_BASE_H
#include "station_type.h"
#include "base_station_base.h"
#include "airport.h"
#include "core/pool_type.hpp"
#include "cargopacket.h"
#include "cargo_type.h"
#include "town_type.h"
#include "strings_type.h"
#include "date_type.h"
#include "vehicle_type.h"
#include "company_type.h"
#include "industry_type.h"
#include "core/geometry_type.hpp"
#include "viewport_type.h"
#include "station_map.h"
#include <list>
typedef Pool<BaseStation, StationID, 32, 64000> StationPool;
@ -48,12 +41,6 @@ struct GoodsEntry {
CargoList cargo; ///< The cargo packets of cargo waiting in this station
};
struct StationSpecList {
const StationSpec *spec;
uint32 grfid; ///< GRF ID of this custom station
uint8 localidx; ///< Station ID within GRF of station
};
/** StationRect - used to track station spread out rectangle - cheaper than scanning whole map */
struct StationRect : public Rect {
enum StationRectMode
@ -77,172 +64,6 @@ struct StationRect : public Rect {
StationRect& operator = (Rect src);
};
/** Represents the covered area */
struct TileArea {
TileIndex tile; ///< The base tile of the area
uint8 w; ///< The width of the area
uint8 h; ///< The height of the area
};
/** Base class for all station-ish types */
struct BaseStation : StationPool::PoolItem<&_station_pool> {
TileIndex xy; ///< Base tile of the station
ViewportSign sign; ///< NOSAVE: Dimensions of sign
byte delete_ctr; ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.
char *name; ///< Custom name
StringID string_id; ///< Default name (town area) of station
Town *town; ///< The town this station is associated with
OwnerByte owner; ///< The owner of this station
StationFacilityByte facilities; ///< The facilities that this station has
uint8 num_specs; ///< Number of specs in the speclist
StationSpecList *speclist; ///< List of station specs of this station
Date build_date; ///< Date of construction
uint16 random_bits; ///< Random bits assigned to this station
byte waiting_triggers; ///< Waiting triggers (NewGRF) for this station
uint8 cached_anim_triggers; ///< NOSAVE: Combined animation trigger bitmask, used to determine if trigger processing should happen.
BaseStation(TileIndex tile) : xy(tile) { }
virtual ~BaseStation();
/**
* Check whether a specific tile belongs to this station.
* @param tile the tile to check
* @return true if the tile belongs to this station
*/
virtual bool TileBelongsToRailStation(TileIndex tile) const = 0;
/**
* Helper function to get a NewGRF variable that isn't implemented by the base class.
* @param object the resolver object related to this query
* @param variable that is queried
* @param parameter parameter for that variable
* @param available will return false if ever the variable asked for does not exist
* @return the value stored in the corresponding variable
*/
virtual uint32 GetNewGRFVariable(const struct ResolverObject *object, byte variable, byte parameter, bool *available) const = 0;
/**
* Update the coordinated of the sign (as shown in the viewport).
*/
virtual void UpdateVirtCoord() = 0;
/**
* Get the tile area for a given station type.
* @param ta tile area to fill.
* @param type the type of the area
*/
virtual void GetTileArea(TileArea *ta, StationType type) const = 0;
/**
* Get the base station belonging to a specific tile.
* @param tile The tile to get the base station from.
* @return the station associated with that tile.
*/
static FORCEINLINE BaseStation *GetByTile(TileIndex tile)
{
return BaseStation::Get(GetStationIndex(tile));
}
};
#define FOR_ALL_BASE_STATIONS(var) FOR_ALL_ITEMS_FROM(BaseStation, station_index, var, 0)
/**
* Class defining several overloaded accessors so we don't
* have to cast base stations that often
*/
template <class T, bool Tis_waypoint>
struct SpecializedStation : public BaseStation {
static const StationFacility EXPECTED_FACIL = Tis_waypoint ? FACIL_WAYPOINT : FACIL_NONE; ///< Specialized type
/**
* Set station type correctly
* @param tile The base tile of the station.
*/
FORCEINLINE SpecializedStation<T, Tis_waypoint>(TileIndex tile) :
BaseStation(tile)
{
this->facilities = EXPECTED_FACIL;
}
/**
* Helper for checking whether the given station is of this type.
* @param st the station to check.
* @return true if the station is the type we expect it to be.
*/
static FORCEINLINE bool IsExpected(const BaseStation *st)
{
return (st->facilities & FACIL_WAYPOINT) == EXPECTED_FACIL;
}
/**
* Tests whether given index is a valid index for station of this type
* @param index tested index
* @return is this index valid index of T?
*/
static FORCEINLINE bool IsValidID(size_t index)
{
return BaseStation::IsValidID(index) && IsExpected(BaseStation::Get(index));
}
/**
* Gets station with given index
* @return pointer to station with given index casted to T *
*/
static FORCEINLINE T *Get(size_t index)
{
return (T *)BaseStation::Get(index);
}
/**
* Returns station if the index is a valid index for this station type
* @return pointer to station with given index if it's a station of this type
*/
static FORCEINLINE T *GetIfValid(size_t index)
{
return IsValidID(index) ? Get(index) : NULL ;
}
/**
* Get the station belonging to a specific tile.
* @param tile The tile to get the station from.
* @return the station associated with that tile.
*/
static FORCEINLINE T *GetByTile(TileIndex tile)
{
return GetIfValid(GetStationIndex(tile));
}
/**
* Converts a BaseStation to SpecializedStation with type checking.
* @param st BaseStation pointer
* @return pointer to SpecializedStation
*/
static FORCEINLINE T *From(BaseStation *st)
{
assert(IsExpected(st));
return (T *)st;
}
/**
* Converts a const BaseStation to const SpecializedStation with type checking.
* @param st BaseStation pointer
* @return pointer to SpecializedStation
*/
static FORCEINLINE const T *From(const BaseStation *st)
{
assert(IsExpected(st));
return (const T *)st;
}
};
#define FOR_ALL_BASE_STATIONS_OF_TYPE(name, var) FOR_ALL_ITEMS_FROM(name, station_index, var, 0) if (name::IsExpected(var))
typedef SmallVector<Industry *, 2> IndustryVector;

2
src/terraform_gui.cpp
View File

@ -17,7 +17,7 @@
#include "variables.h"
#include "functions.h"
#include "sound_func.h"
#include "station_base.h"
#include "base_station_base.h"
#include "unmovable_map.h"
#include "textbuf_gui.h"
#include "genworld.h"

1
src/vehicle_gui.cpp
View File

@ -16,7 +16,6 @@
#include "gfx_func.h"
#include "newgrf_engine.h"
#include "newgrf_text.h"
#include "station_base.h"
#include "waypoint_base.h"
#include "roadveh.h"
#include "train.h"

2
src/waypoint_base.h
View File

@ -6,7 +6,7 @@
#define WAYPOINT_H
#include "waypoint_type.h"
#include "station_base.h"
#include "base_station_base.h"
struct Waypoint : SpecializedStation<Waypoint, true> {
uint16 town_cn; ///< The Nth waypoint for this town (consecutive number)

2
src/waypoint_func.h
View File

@ -7,7 +7,7 @@
#include "rail_type.h"
#include "command_type.h"
#include "station_base.h"
#include "waypoint_type.h"
CommandCost RemoveTrainWaypoint(TileIndex tile, DoCommandFlag flags, bool justremove);
void ShowWaypointWindow(const Waypoint *wp);

1
src/yapf/yapf.hpp
View File

@ -12,7 +12,6 @@
#include "../bridge_map.h"
#include "../tunnelbridge_map.h"
#include "../bridge.h"
#include "../station_base.h"
#include "../station_map.h"
#include "../tile_cmd.h"
#include "../landscape.h"