/* $Id$ */ /** @file station.cpp Implementation of the station base class. */ #include "stdafx.h" #include "company_func.h" #include "industry.h" #include "newgrf_cargo.h" #include "yapf/yapf.h" #include "cargotype.h" #include "roadveh.h" #include "window_type.h" #include "station_gui.h" #include "zoom_func.h" #include "functions.h" #include "window_func.h" #include "date_func.h" #include "command_func.h" #include "news_func.h" #include "aircraft.h" #include "vehicle_gui.h" #include "settings_type.h" #include "subsidy_func.h" #include "core/pool_func.hpp" #include "table/strings.h" StationPool _station_pool("Station"); INSTANTIATE_POOL_METHODS(Station) RoadStopPool _roadstop_pool("RoadStop"); INSTANTIATE_POOL_METHODS(RoadStop) Station::Station(TileIndex tile) { DEBUG(station, cDebugCtorLevel, "I+%3d", index); xy = tile; airport_tile = dock_tile = train_tile = INVALID_TILE; bus_stops = truck_stops = NULL; had_vehicle_of_type = 0; time_since_load = 255; time_since_unload = 255; delete_ctr = 0; facilities = 0; last_vehicle_type = VEH_INVALID; indtype = IT_INVALID; random_bits = 0; // Random() must be called when station is really built (DC_EXEC) waiting_triggers = 0; } /** * Clean up a station by clearing vehicle orders and invalidating windows. * Aircraft-Hangar orders need special treatment here, as the hangars are * actually part of a station (tiletype is STATION), but the order type * is OT_GOTO_DEPOT. */ Station::~Station() { DEBUG(station, cDebugCtorLevel, "I-%3d", index); free(this->name); free(this->speclist); if (CleaningPool()) return; while (!loading_vehicles.empty()) { loading_vehicles.front()->LeaveStation(); } Aircraft *a; FOR_ALL_AIRCRAFT(a) { if (!IsNormalAircraft(a)) continue; if (a->targetairport == this->index) a->targetairport = INVALID_STATION; } Vehicle *v; FOR_ALL_VEHICLES(v) { /* Forget about this station if this station is removed */ if (v->last_station_visited == destination && type == OT_GOTO_STATION) { v->last_station_visited = INVALID_STATION; } } MarkDirty(); InvalidateWindowData(WC_STATION_LIST, this->owner, 0); DeleteWindowById(WC_STATION_VIEW, index); WindowNumber wno = (index << 16) | VLW_STATION_LIST | this->owner; DeleteWindowById(WC_TRAINS_LIST, wno | (VEH_TRAIN << 11)); DeleteWindowById(WC_ROADVEH_LIST, wno | (VEH_ROAD << 11)); DeleteWindowById(WC_SHIPS_LIST, wno | (VEH_SHIP << 11)); DeleteWindowById(WC_AIRCRAFT_LIST, wno | (VEH_AIRCRAFT << 11)); /* Now delete all orders that go to the station */ RemoveOrderFromAllVehicles(OT_GOTO_STATION, index); /* Subsidies need removal as well */ DeleteSubsidyWithStation(index); /* Remove all news items */ DeleteStationNews(this->index); InvalidateWindowData(WC_SELECT_STATION, 0, 0); for (CargoID c = 0; c < NUM_CARGO; c++) { goods[c].cargo.Truncate(0); } CargoPacket *cp; FOR_ALL_CARGOPACKETS(cp) { /* Don't allow cargo packets with invalid source station */ if (cp->source == this->index) cp->source = INVALID_STATION; } } /** * Get the primary road stop (the first road stop) that the given vehicle can load/unload. * @param v the vehicle to get the first road stop for * @return the first roadstop that this vehicle can load at */ RoadStop *Station::GetPrimaryRoadStop(const RoadVehicle *v) const { RoadStop *rs = this->GetPrimaryRoadStop(IsCargoInClass(v->cargo_type, CC_PASSENGERS) ? ROADSTOP_BUS : ROADSTOP_TRUCK); for (; rs != NULL; rs = rs->next) { /* The vehicle cannot go to this roadstop (different roadtype) */ if ((GetRoadTypes(rs->xy) & v->compatible_roadtypes) == ROADTYPES_NONE) continue; /* The vehicle is articulated and can therefor not go the a standard road stop */ if (IsStandardRoadStopTile(rs->xy) && RoadVehHasArticPart(v)) continue; /* The vehicle can actually go to this road stop. So, return it! */ break; } return rs; } /** Called when new facility is built on the station. If it is the first facility * it initializes also 'xy' and 'random_bits' members */ void Station::AddFacility(byte new_facility_bit, TileIndex facil_xy) { if (facilities == 0) { xy = facil_xy; random_bits = Random(); } facilities |= new_facility_bit; owner = _current_company; build_date = _date; } void Station::MarkDirty() const { if (sign.width_1 != 0) { InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION); /* We use ZOOM_LVL_MAX here, as every viewport can have an other zoom, * and there is no way for us to know which is the biggest. So make the * biggest area dirty, and we are safe for sure. */ MarkAllViewportsDirty( sign.left - 6, sign.top, sign.left + ScaleByZoom(sign.width_1 + 12, ZOOM_LVL_MAX), sign.top + ScaleByZoom(12, ZOOM_LVL_MAX)); } } void Station::MarkTilesDirty(bool cargo_change) const { TileIndex tile = train_tile; int w, h; if (tile == INVALID_TILE) return; /* cargo_change is set if we're refreshing the tiles due to cargo moving * around. */ if (cargo_change) { /* Don't waste time updating if there are no custom station graphics * that might change. Even if there are custom graphics, they might * not change. Unfortunately we have no way of telling. */ if (this->num_specs == 0) return; } for (h = 0; h < trainst_h; h++) { for (w = 0; w < trainst_w; w++) { if (TileBelongsToRailStation(tile)) { MarkTileDirtyByTile(tile); } tile += TileDiffXY(1, 0); } tile += TileDiffXY(-w, 1); } } bool Station::TileBelongsToRailStation(TileIndex tile) const { return IsTileType(tile, MP_STATION) && GetStationIndex(tile) == index && IsRailwayStation(tile); } /** Obtain the length of a platform * @pre tile must be a railway station tile * @param tile A tile that contains the platform in question * @return The length of the platform */ uint Station::GetPlatformLength(TileIndex tile) const { TileIndex t; TileIndexDiff delta; uint len = 0; assert(TileBelongsToRailStation(tile)); delta = (GetRailStationAxis(tile) == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1)); t = tile; do { t -= delta; len++; } while (IsCompatibleTrainStationTile(t, tile)); t = tile; do { t += delta; len++; } while (IsCompatibleTrainStationTile(t, tile)); return len - 1; } /** Determines the REMAINING length of a platform, starting at (and including) * the given tile. * @param tile the tile from which to start searching. Must be a railway station tile * @param dir The direction in which to search. * @return The platform length */ uint Station::GetPlatformLength(TileIndex tile, DiagDirection dir) const { TileIndex start_tile = tile; uint length = 0; assert(IsRailwayStationTile(tile)); assert(dir < DIAGDIR_END); do { length ++; tile += TileOffsByDiagDir(dir); } while (IsCompatibleTrainStationTile(tile, start_tile)); return length; } /** Determines whether a station is a buoy only. * @todo Ditch this encoding of buoys */ bool Station::IsBuoy() const { return (had_vehicle_of_type & HVOT_BUOY) != 0; } /** Determines the catchment radius of the station * @return The radius */ uint Station::GetCatchmentRadius() const { uint ret = CA_NONE; if (_settings_game.station.modified_catchment) { if (this->bus_stops != NULL) ret = max(ret, CA_BUS); if (this->truck_stops != NULL) ret = max(ret, CA_TRUCK); if (this->train_tile != INVALID_TILE) ret = max(ret, CA_TRAIN); if (this->dock_tile != INVALID_TILE) ret = max(ret, CA_DOCK); if (this->airport_tile != INVALID_TILE) ret = max(ret, this->Airport()->catchment); } else { if (this->bus_stops != NULL || this->truck_stops != NULL || this->train_tile != INVALID_TILE || this->dock_tile != INVALID_TILE || this->airport_tile != INVALID_TILE) { ret = CA_UNMODIFIED; } } return ret; } /************************************************************************/ /* StationRect implementation */ /************************************************************************/ StationRect::StationRect() { MakeEmpty(); } void StationRect::MakeEmpty() { left = top = right = bottom = 0; } /** * Determines whether a given point (x, y) is within a certain distance of * the station rectangle. * @note x and y are in Tile coordinates * @param x X coordinate * @param y Y coordinate * @param distance The maxmium distance a point may have (L1 norm) * @return true if the point is within distance tiles of the station rectangle */ bool StationRect::PtInExtendedRect(int x, int y, int distance) const { return (left - distance <= x && x <= right + distance && top - distance <= y && y <= bottom + distance); } bool StationRect::IsEmpty() const { return (left == 0 || left > right || top > bottom); } bool StationRect::BeforeAddTile(TileIndex tile, StationRectMode mode) { int x = TileX(tile); int y = TileY(tile); if (IsEmpty()) { /* we are adding the first station tile */ if (mode != ADD_TEST) { left = right = x; top = bottom = y; } } else if (!PtInExtendedRect(x, y)) { /* current rect is not empty and new point is outside this rect * make new spread-out rectangle */ Rect new_rect = {min(x, left), min(y, top), max(x, right), max(y, bottom)}; /* check new rect dimensions against preset max */ int w = new_rect.right - new_rect.left + 1; int h = new_rect.bottom - new_rect.top + 1; if (mode != ADD_FORCE && (w > _settings_game.station.station_spread || h > _settings_game.station.station_spread)) { assert(mode != ADD_TRY); _error_message = STR_ERROR_STATION_TOO_SPREAD_OUT; return false; } /* spread-out ok, return true */ if (mode != ADD_TEST) { /* we should update the station rect */ *this = new_rect; } } else { ; // new point is inside the rect, we don't need to do anything } return true; } bool StationRect::BeforeAddRect(TileIndex tile, int w, int h, StationRectMode mode) { return (mode == ADD_FORCE || (w <= _settings_game.station.station_spread && h <= _settings_game.station.station_spread)) && // important when the old rect is completely inside the new rect, resp. the old one was empty BeforeAddTile(tile, mode) && BeforeAddTile(TILE_ADDXY(tile, w - 1, h - 1), mode); } /** * Check whether station tiles of the given station id exist in the given rectangle * @param st_id Station ID to look for in the rectangle * @param left_a Minimal tile X edge of the rectangle * @param top_a Minimal tile Y edge of the rectangle * @param right_a Maximal tile X edge of the rectangle (inclusive) * @param bottom_a Maximal tile Y edge of the rectangle (inclusive) * @return \c true if a station tile with the given \a st_id exists in the rectangle, \c false otherwise */ /* static */ bool StationRect::ScanForStationTiles(StationID st_id, int left_a, int top_a, int right_a, int bottom_a) { TileIndex top_left = TileXY(left_a, top_a); int width = right_a - left_a + 1; int height = bottom_a - top_a + 1; BEGIN_TILE_LOOP(tile, width, height, top_left) if (IsTileType(tile, MP_STATION) && GetStationIndex(tile) == st_id) return true; END_TILE_LOOP(tile, width, height, top_left); return false; } bool StationRect::AfterRemoveTile(Station *st, TileIndex tile) { int x = TileX(tile); int y = TileY(tile); /* look if removed tile was on the bounding rect edge * and try to reduce the rect by this edge * do it until we have empty rect or nothing to do */ for (;;) { /* check if removed tile is on rect edge */ bool left_edge = (x == left); bool right_edge = (x == right); bool top_edge = (y == top); bool bottom_edge = (y == bottom); /* can we reduce the rect in either direction? */ bool reduce_x = ((left_edge || right_edge) && !ScanForStationTiles(st->index, x, top, x, bottom)); bool reduce_y = ((top_edge || bottom_edge) && !ScanForStationTiles(st->index, left, y, right, y)); if (!(reduce_x || reduce_y)) break; // nothing to do (can't reduce) if (reduce_x) { /* reduce horizontally */ if (left_edge) { /* move left edge right */ left = x = x + 1; } else { /* move right edge left */ right = x = x - 1; } } if (reduce_y) { /* reduce vertically */ if (top_edge) { /* move top edge down */ top = y = y + 1; } else { /* move bottom edge up */ bottom = y = y - 1; } } if (left > right || top > bottom) { /* can't continue, if the remaining rectangle is empty */ MakeEmpty(); return true; // empty remaining rect } } return false; // non-empty remaining rect } bool StationRect::AfterRemoveRect(Station *st, TileIndex tile, int w, int h) { assert(PtInExtendedRect(TileX(tile), TileY(tile))); assert(PtInExtendedRect(TileX(tile) + w - 1, TileY(tile) + h - 1)); bool empty = AfterRemoveTile(st, tile); if (w != 1 || h != 1) empty = empty || AfterRemoveTile(st, TILE_ADDXY(tile, w - 1, h - 1)); return empty; } StationRect& StationRect::operator = (Rect src) { left = src.left; top = src.top; right = src.right; bottom = src.bottom; return *this; } /************************************************************************/ /* RoadStop implementation */ /************************************************************************/ /** Initializes a RoadStop */ RoadStop::RoadStop(TileIndex tile) : xy(tile), status(3), // stop is free num_vehicles(0), next(NULL) { DEBUG(ms, cDebugCtorLevel, "I+ at %d[0x%x]", tile, tile); } /** De-Initializes a RoadStops. This includes clearing all slots that vehicles might * have and unlinks it from the linked list of road stops at the given station */ RoadStop::~RoadStop() { if (CleaningPool()) return; /* Clear the slot assignment of all vehicles heading for this road stop */ if (num_vehicles != 0) { RoadVehicle *rv; FOR_ALL_ROADVEHICLES(rv) { if (rv->slot == this) ClearSlot(rv); } } assert(num_vehicles == 0); DEBUG(ms, cDebugCtorLevel , "I- at %d[0x%x]", xy, xy); } /** Checks whether there is a free bay in this road stop */ bool RoadStop::HasFreeBay() const { return GB(status, 0, MAX_BAY_COUNT) != 0; } /** Checks whether the given bay is free in this road stop */ bool RoadStop::IsFreeBay(uint nr) const { assert(nr < MAX_BAY_COUNT); return HasBit(status, nr); } /** * Allocates a bay * @return the allocated bay number * @pre this->HasFreeBay() */ uint RoadStop::AllocateBay() { assert(HasFreeBay()); /* Find the first free bay. If the bit is set, the bay is free. */ uint bay_nr = 0; while (!HasBit(status, bay_nr)) bay_nr++; ClrBit(status, bay_nr); return bay_nr; } /** * Allocates a bay in a drive-through road stop * @param nr the number of the bay to allocate */ void RoadStop::AllocateDriveThroughBay(uint nr) { assert(nr < MAX_BAY_COUNT); ClrBit(status, nr); } /** * Frees the given bay * @param nr the number of the bay to free */ void RoadStop::FreeBay(uint nr) { assert(nr < MAX_BAY_COUNT); SetBit(status, nr); } /** Checks whether the entrance of the road stop is occupied by a vehicle */ bool RoadStop::IsEntranceBusy() const { return HasBit(status, 7); } /** Makes an entrance occupied or free */ void RoadStop::SetEntranceBusy(bool busy) { SB(status, 7, 1, busy); } /** * Get the next road stop accessible by this vehicle. * @param v the vehicle to get the next road stop for. * @return the next road stop accessible. */ RoadStop *RoadStop::GetNextRoadStop(const RoadVehicle *v) const { for (RoadStop *rs = this->next; rs != NULL; rs = rs->next) { /* The vehicle cannot go to this roadstop (different roadtype) */ if ((GetRoadTypes(rs->xy) & v->compatible_roadtypes) == ROADTYPES_NONE) continue; /* The vehicle is articulated and can therefor not go the a standard road stop */ if (IsStandardRoadStopTile(rs->xy) && RoadVehHasArticPart(v)) continue; /* The vehicle can actually go to this road stop. So, return it! */ return rs; } return NULL; } void InitializeStations() { _station_pool.CleanPool(); _roadstop_pool.CleanPool(); }