diff options
-rw-r--r-- | projects/openttd_vs80.vcproj | 4 | ||||
-rw-r--r-- | projects/openttd_vs90.vcproj | 4 | ||||
-rw-r--r-- | source.list | 1 | ||||
-rw-r--r-- | src/base_station_base.h | 192 | ||||
-rw-r--r-- | src/cargopacket.cpp | 2 | ||||
-rw-r--r-- | src/economy_base.h | 2 | ||||
-rw-r--r-- | src/industry.h | 3 | ||||
-rw-r--r-- | src/npf.cpp | 1 | ||||
-rw-r--r-- | src/pathfind.cpp | 1 | ||||
-rw-r--r-- | src/pathfind.h | 1 | ||||
-rw-r--r-- | src/station_base.h | 181 | ||||
-rw-r--r-- | src/terraform_gui.cpp | 2 | ||||
-rw-r--r-- | src/vehicle_gui.cpp | 1 | ||||
-rw-r--r-- | src/waypoint_base.h | 2 | ||||
-rw-r--r-- | src/waypoint_func.h | 2 | ||||
-rw-r--r-- | src/yapf/yapf.hpp | 1 |
16 files changed, 212 insertions, 188 deletions
diff --git a/projects/openttd_vs80.vcproj b/projects/openttd_vs80.vcproj index 0f0a7a399..2e3525a55 100644 --- a/projects/openttd_vs80.vcproj +++ b/projects/openttd_vs80.vcproj @@ -828,6 +828,10 @@ > </File> <File + RelativePath=".\..\src\base_station_base.h" + > + </File> + <File RelativePath=".\..\src\bmp.h" > </File> diff --git a/projects/openttd_vs90.vcproj b/projects/openttd_vs90.vcproj index c0882f493..3ccc2949f 100644 --- a/projects/openttd_vs90.vcproj +++ b/projects/openttd_vs90.vcproj @@ -825,6 +825,10 @@ > </File> <File + RelativePath=".\..\src\base_station_base.h" + > + </File> + <File RelativePath=".\..\src\bmp.h" > </File> diff --git a/source.list b/source.list index ef804891a..6011b89fa 100644 --- a/source.list +++ b/source.list @@ -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 diff --git a/src/base_station_base.h b/src/base_station_base.h new file mode 100644 index 000000000..a4cbb2fc0 --- /dev/null +++ b/src/base_station_base.h @@ -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 */ diff --git a/src/cargopacket.cpp b/src/cargopacket.cpp index df2261139..65514e647 100644 --- a/src/cargopacket.cpp +++ b/src/cargopacket.cpp @@ -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"); diff --git a/src/economy_base.h b/src/economy_base.h index 7e8e8e7d2..ca9dc3326 100644 --- a/src/economy_base.h +++ b/src/economy_base.h @@ -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; diff --git a/src/industry.h b/src/industry.h index 91088b053..404a4e25a 100644 --- a/src/industry.h +++ b/src/industry.h @@ -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, diff --git a/src/npf.cpp b/src/npf.cpp index cc7b4f6a2..34a2a9d55 100644 --- a/src/npf.cpp +++ b/src/npf.cpp @@ -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" diff --git a/src/pathfind.cpp b/src/pathfind.cpp index e68141a0d..8c52c9d88 100644 --- a/src/pathfind.cpp +++ b/src/pathfind.cpp @@ -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" diff --git a/src/pathfind.h b/src/pathfind.h index 7785192b2..db758f0a6 100644 --- a/src/pathfind.h +++ b/src/pathfind.h @@ -6,6 +6,7 @@ #define PATHFIND_H #include "direction_type.h" +#include "station_base.h" enum { STR_FACTOR = 2, diff --git a/src/station_base.h b/src/station_base.h index f4f142287..772c204e3 100644 --- a/src/station_base.h +++ b/src/station_base.h @@ -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; diff --git a/src/terraform_gui.cpp b/src/terraform_gui.cpp index a0c0eadd3..c41b2ac56 100644 --- a/src/terraform_gui.cpp +++ b/src/terraform_gui.cpp @@ -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" diff --git a/src/vehicle_gui.cpp b/src/vehicle_gui.cpp index 69da41a0b..d4d02cccc 100644 --- a/src/vehicle_gui.cpp +++ b/src/vehicle_gui.cpp @@ -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" diff --git a/src/waypoint_base.h b/src/waypoint_base.h index 99efefa0d..199dae975 100644 --- a/src/waypoint_base.h +++ b/src/waypoint_base.h @@ -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) diff --git a/src/waypoint_func.h b/src/waypoint_func.h index 480f690b5..70069859b 100644 --- a/src/waypoint_func.h +++ b/src/waypoint_func.h @@ -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); diff --git a/src/yapf/yapf.hpp b/src/yapf/yapf.hpp index f0c3f4990..50e4ab1a4 100644 --- a/src/yapf/yapf.hpp +++ b/src/yapf/yapf.hpp @@ -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" |