station_sl.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "../stdafx.h"
 
#include "saveload.h"
#include "compat/station_sl_compat.h"
 
#include "../station_base.h"
#include "../waypoint_base.h"
#include "../roadstop_base.h"
#include "../vehicle_base.h"
#include "../newgrf_station.h"
#include "../newgrf_roadstop.h"
#include "../town.h"
#include "../timer/timer_game_calendar.h"
 
#include "table/strings.h"
 
#include "../safeguards.h"

static void UpdateWaypointOrder(Order &o)
{
  if (!o.IsType(OT_GOTO_STATION)) return;
 
  const Station *st = Station::Get(o.GetDestination().ToStationID());
  if (!st->had_vehicle_of_type.Test(StationVehicleType::Waypoint)) return;
 
  o.MakeGoToWaypoint(o.GetDestination().ToStationID());
}

void MoveBuoysToWaypoints()
{
  /* Buoy orders become waypoint orders */
  for (OrderList *ol : OrderList::Iterate()) {
    VehicleType vt = ol->GetFirstSharedVehicle()->type;
    if (vt != VehicleType::Ship && vt != VehicleType::Train) continue;
 
    for (Order &o : ol->GetOrders()) UpdateWaypointOrder(o);
  }
 
  for (Vehicle *v : Vehicle::Iterate()) {
    VehicleType vt = v->type;
    if (vt != VehicleType::Ship && vt != VehicleType::Train) continue;
 
    UpdateWaypointOrder(v->current_order);
  }
 
  /* Now make the stations waypoints */
  for (Station *st : Station::Iterate()) {
    if (!st->had_vehicle_of_type.Test(StationVehicleType::Waypoint)) continue;
 
    StationID index    = st->index;
    TileIndex xy       = st->xy;
    Town *town         = st->town;
    StringID string_id = st->string_id;
    std::string name   = st->name;
    TimerGameCalendar::Date build_date = st->build_date;
    /* TTDPatch could use "buoys with rail station" for rail waypoints */
    bool train         = !st->train_station.IsEmpty();
    TileArea train_st  = st->train_station;
 
    /* Delete the station, so we can make it a real waypoint. */
    delete st;
 
    /* Stations and waypoints are in the same pool, so if a station
     * is deleted there must be place for a Waypoint. */
    assert(Waypoint::CanAllocateItem());
    Waypoint *wp   = Waypoint::CreateAtIndex(index, xy);
    wp->town       = town;
    wp->string_id  = train ? STR_SV_STNAME_WAYPOINT : STR_SV_STNAME_BUOY;
    wp->name       = std::move(name);
    wp->delete_ctr = 0; // Just reset delete counter for once.
    wp->build_date = build_date;
    wp->owner      = train ? GetTileOwner(xy) : OWNER_NONE;
 
    if (IsInsideBS(string_id, STR_SV_STNAME_BUOY, 9)) wp->town_cn = (string_id - STR_SV_STNAME_BUOY).base();
 
    if (train) {
      /* When we make a rail waypoint of the station, convert the map as well. */
      for (TileIndex t : train_st) {
        Tile tile(t);
        if (!IsTileType(tile, TileType::Station) || GetStationIndex(tile) != index) continue;
 
        SB(tile.m6(), 3, 3, to_underlying(StationType::RailWaypoint));
        wp->spread.Add(t);
      }
 
      wp->train_station = train_st;
      wp->facilities.Set(StationFacility::Train);
    } else if (IsBuoyTile(xy) && GetStationIndex(xy) == index) {
      wp->spread.Add(xy);
      wp->facilities.Set(StationFacility::Dock);
    }
  }
}
 
void AfterLoadStations()
{
  /* Update the speclists of all stations to point to the currently loaded custom stations. */
  for (BaseStation *st : BaseStation::Iterate()) {
    for (auto &sm : GetStationSpecList<StationSpec>(st)) {
      if (sm.grfid.Empty()) continue;
      sm.spec = StationClass::GetByGrf(sm.grfid, sm.localidx);
    }
    for (auto &sm : GetStationSpecList<RoadStopSpec>(st)) {
      if (sm.grfid.Empty()) continue;
      sm.spec = RoadStopClass::GetByGrf(sm.grfid, sm.localidx);
    }
 
    if (Station::IsExpected(st)) {
      Station *sta = Station::From(st);
      for (const RoadStop *rs = sta->bus_stops; rs != nullptr; rs = rs->next) sta->bus_station.Add(rs->xy);
      for (const RoadStop *rs = sta->truck_stops; rs != nullptr; rs = rs->next) sta->truck_station.Add(rs->xy);
    }
 
    StationUpdateCachedTriggers(st);
    RoadStopUpdateCachedTriggers(st);
  }
 
  /* Station blocked, wires and pylon flags need to be stored in the map. This is effectively cached data, so no
   * version check is necessary. */
  for (const auto t : Map::Iterate()) {
    if (HasStationTileRail(t)) SetRailStationTileFlags(t, GetStationSpec(t));
  }
}

void AfterLoadRoadStops()
{
  /* First construct the drive through entries */
  for (RoadStop *rs : RoadStop::Iterate()) {
    if (IsDriveThroughStopTile(rs->xy)) rs->MakeDriveThrough();
  }
  /* And then rebuild the data in those entries */
  for (RoadStop *rs : RoadStop::Iterate()) {
    if (!rs->status.Test(RoadStop::RoadStopStatusFlag::BaseEntry)) continue;
 
    rs->GetEntry(DiagDirection::NE).Rebuild(rs);
    rs->GetEntry(DiagDirection::NW).Rebuild(rs);
  }
}
 
static const SaveLoad _roadstop_desc[] = {
  SaveLoad::Variable<VarFileType::U32>("xy", SLE_OBJECT_ADDRESS(RoadStop, xy)),
  SaveLoad::Variable<VarFileType::U8>("status", SLE_OBJECT_ADDRESS(RoadStop, status)),
  SaveLoad::Reference<SLRefType::RoadStop>("next", SLE_OBJECT_ADDRESS(RoadStop, next)),
};
 
static uint16_t _waiting_acceptance;
static uint32_t _old_num_flows;
static uint16_t _cargo_source;
static uint32_t _cargo_source_xy;
static uint8_t  _cargo_periods;
static Money  _cargo_feeder_share;
 
std::list<CargoPacket *> _packets;
uint32_t _old_num_dests;
 
struct FlowSaveLoad {
  StationID source;
  StationID via;
  uint32_t share;
  bool restricted;
};
 
typedef std::pair<const StationID, std::list<CargoPacket *> > StationCargoPair;
 
static OldPersistentStorage _old_st_persistent_storage;

static void SwapPackets(GoodsEntry *ge)
{
  StationCargoPacketMap &ge_packets = const_cast<StationCargoPacketMap &>(*ge->GetOrCreateData().cargo.Packets());
 
  if (_packets.empty()) {
    std::map<StationID, std::list<CargoPacket *> >::iterator it(ge_packets.find(StationID::Invalid()));
    if (it == ge_packets.end()) {
      return;
    } else {
      it->second.swap(_packets);
    }
  } else {
    assert(ge_packets[StationID::Invalid()].empty());
    ge_packets[StationID::Invalid()].swap(_packets);
  }
}
 
template <typename T>
class SlStationSpecList : public VectorSaveLoadHandler<SlStationSpecList<T>, BaseStation, SpecMapping<T>> {
public:
  static inline const SaveLoad description[] = {
    SaveLoad::Variable<VarFileType::Label>("grfid", SLE_OBJECT_ADDRESS(SpecMapping<T>, grfid), SaveLoadVersion::NewGRFStations),
    SaveLoad::Variable<VarFileType::U8>("localidx", SLE_OBJECT_ADDRESS(SpecMapping<T>, localidx), SaveLoadVersion::NewGRFStations, SaveLoadVersion::ExtendEntityMapping),
    SaveLoad::Variable<VarFileType::U16>("localidx", SLE_OBJECT_ADDRESS(SpecMapping<T>, localidx), SaveLoadVersion::ExtendEntityMapping),
  };
  static inline const SaveLoadCompatTable compat_description = _station_spec_list_sl_compat;
 
  static inline uint8_t last_num_specs; 
 
  std::vector<SpecMapping<T>> &GetVector(BaseStation *bst) const override { return GetStationSpecList<T>(bst); }
 
  size_t GetLength() const override
  {
    return IsSavegameVersionBefore(SaveLoadVersion::SaveloadListLength) ? last_num_specs : SlGetStructListLength(UINT8_MAX);
  }
};
 
/* Instantiate SlStationSpecList classes. */
template class SlStationSpecList<StationSpec>;
template class SlStationSpecList<RoadStopSpec>;
 
class SlStationWaitingTriggers : public DefaultSaveLoadHandler<SlStationWaitingTriggers, BaseStation> {
public:
  using StationWaitingTriggersPair = std::pair<const TileIndex, StationRandomTriggers>;
 
  static inline const SaveLoad description[] = {
    SaveLoad::Variable<VarFileType::U32>("first", SLE_OBJECT_ADDRESS(StationWaitingTriggersPair, first)),
    SaveLoad::Variable<VarFileType::U8>("second", SLE_OBJECT_ADDRESS(StationWaitingTriggersPair, second)),
  };
  static inline const SaveLoadCompatTable compat_description = _station_cargo_sl_compat;
 
  void Save(BaseStation *st) const override
  {
    SlSetStructListLength(st->tile_waiting_random_triggers.size());
    for (const auto &pair : st->tile_waiting_random_triggers) {
      SlObject(const_cast<StationWaitingTriggersPair *>(&pair), this->GetDescription());
    }
  }
 
  void Load(BaseStation *st) const override
  {
    size_t num = SlGetStructListLength(UINT32_MAX);
    if (num == 0) return;
 
    StationWaitingTriggersPair pair;
    for (uint j = 0; j < num; ++j) {
      SlObject(&pair, this->GetLoadDescription());
      st->tile_waiting_random_triggers.emplace(pair.first, pair.second);
    }
  }
};
 
class SlStationCargo : public DefaultSaveLoadHandler<SlStationCargo, GoodsEntry> {
public:
  static inline const SaveLoad description[] = {
    SaveLoad::Variable<VarFileType::U16>("first", SLE_OBJECT_ADDRESS(StationCargoPair, first)),
    SaveLoad::ReferenceList<SLRefType::CargoPacket>("second", SLE_OBJECT_ADDRESS(StationCargoPair, second)),
  };
  static inline const SaveLoadCompatTable compat_description = _station_cargo_sl_compat;
 
  void Save(GoodsEntry *ge) const override
  {
    if (!ge->HasData()) {
      SlSetStructListLength(0);
      return;
    }
 
    const auto *packets = ge->GetData().cargo.Packets();
    SlSetStructListLength(packets->MapSize());
    for (StationCargoPacketMap::ConstMapIterator it(packets->begin()); it != packets->end(); ++it) {
      SlObject(const_cast<StationCargoPacketMap::value_type *>(&(*it)), this->GetDescription());
    }
  }
 
  void Load(GoodsEntry *ge) const override
  {
    size_t num_dests = IsSavegameVersionBefore(SaveLoadVersion::SaveloadListLength) ? _old_num_dests : SlGetStructListLength(UINT32_MAX);
    if (num_dests == 0) return;
 
    GoodsEntry::GoodsEntryData &data = ge->GetOrCreateData();
    StationCargoPair pair;
    for (uint j = 0; j < num_dests; ++j) {
      SlObject(&pair, this->GetLoadDescription());
      const_cast<StationCargoPacketMap &>(*(data.cargo.Packets()))[pair.first].swap(pair.second);
      assert(pair.second.empty());
    }
  }
 
  void FixPointers(GoodsEntry *ge) const override
  {
    if (!ge->HasData()) return;
 
    for (StationCargoPacketMap::ConstMapIterator it = ge->GetData().cargo.Packets()->begin(); it != ge->GetData().cargo.Packets()->end(); ++it) {
      SlObject(const_cast<StationCargoPair *>(&(*it)), this->GetDescription());
    }
  }
};
 
class SlStationFlow : public DefaultSaveLoadHandler<SlStationFlow, GoodsEntry> {
public:
  static inline const SaveLoad description[] = {
    SaveLoad::Variable<VarFileType::U16>("source", SLE_OBJECT_ADDRESS(FlowSaveLoad, source)),
    SaveLoad::Variable<VarFileType::U16>("via", SLE_OBJECT_ADDRESS(FlowSaveLoad, via)),
    SaveLoad::Variable<VarFileType::U32>("share", SLE_OBJECT_ADDRESS(FlowSaveLoad, share)),
    SaveLoad::Variable<VarFileType::Bool>("restricted", SLE_OBJECT_ADDRESS(FlowSaveLoad, restricted), SaveLoadVersion::LinkgraphRestrictedFlow),
  };
  static inline const SaveLoadCompatTable compat_description = _station_flow_sl_compat;
 
  void Save(GoodsEntry *ge) const override
  {
    if (!ge->HasData()) {
      SlSetStructListLength(0);
      return;
    }
 
    size_t num_flows = 0;
    for (const auto &it : ge->GetData().flows) {
      num_flows += it.second.GetShares()->size();
    }
    SlSetStructListLength(num_flows);
 
    for (const auto &outer_it : ge->GetData().flows) {
      const FlowStat::SharesMap *shares = outer_it.second.GetShares();
      uint32_t sum_shares = 0;
      FlowSaveLoad flow{};
      flow.source = outer_it.first;
      for (auto &inner_it : *shares) {
        flow.via = inner_it.second;
        flow.share = inner_it.first - sum_shares;
        flow.restricted = inner_it.first > outer_it.second.GetUnrestricted();
        sum_shares = inner_it.first;
        assert(flow.share > 0);
        SlObject(&flow, this->GetDescription());
      }
    }
  }
 
  void Load(GoodsEntry *ge) const override
  {
    size_t num_flows = IsSavegameVersionBefore(SaveLoadVersion::SaveloadListLength) ? _old_num_flows : SlGetStructListLength(UINT32_MAX);
    if (num_flows == 0) return;
 
    GoodsEntry::GoodsEntryData &data = ge->GetOrCreateData();
    FlowSaveLoad flow{};
    FlowStat *fs = nullptr;
    StationID prev_source = StationID::Invalid();
    for (uint32_t j = 0; j < num_flows; ++j) {
      SlObject(&flow, this->GetLoadDescription());
      if (fs == nullptr || prev_source != flow.source) {
        fs = &(data.flows.emplace(flow.source, FlowStat(flow.via, flow.share, flow.restricted))).first->second;
      } else {
        fs->AppendShare(flow.via, flow.share, flow.restricted);
      }
      prev_source = flow.source;
    }
  }
};
 
class SlStationGoods : public DefaultSaveLoadHandler<SlStationGoods, BaseStation> {
public:
  static inline uint cargo_reserved_count;
 
  static inline const SaveLoad description[] = {
    SaveLoad::Variable<VarFileType::U16>("waiting_acceptance", SLE_GLOBAL_ADDRESS(_waiting_acceptance), SaveLoadVersion::MinVersion, SaveLoadVersion::CargoPackets),
    SaveLoad::Variable<VarFileType::U8>("status", SLE_OBJECT_ADDRESS(GoodsEntry, status), SaveLoadVersion::CargoPackets),
    SaveLoad::Variable<VarFileType::U8>("time_since_pickup", SLE_OBJECT_ADDRESS(GoodsEntry, time_since_pickup)),
    SaveLoad::Variable<VarFileType::U8>("rating", SLE_OBJECT_ADDRESS(GoodsEntry, rating)),
    SaveLoad::Variable<VarFileType::U8>("cargo_source", SLE_GLOBAL_ADDRESS(_cargo_source), SaveLoadVersion::MinVersion, SaveLoadVersion::LargerCargoSource),
    SaveLoad::Variable<VarFileType::U16>("cargo_source", SLE_GLOBAL_ADDRESS(_cargo_source), SaveLoadVersion::LargerCargoSource, SaveLoadVersion::CargoPackets),
    SaveLoad::Variable<VarFileType::U32>("cargo_source_xy", SLE_GLOBAL_ADDRESS(_cargo_source_xy), SaveLoadVersion::CargoSourceTile, SaveLoadVersion::CargoPackets),
    SaveLoad::Variable<VarFileType::U8>("cargo_days", SLE_GLOBAL_ADDRESS(_cargo_periods), SaveLoadVersion::MinVersion, SaveLoadVersion::CargoPackets),
    SaveLoad::Variable<VarFileType::U8>("last_speed", SLE_OBJECT_ADDRESS(GoodsEntry, last_speed)),
    SaveLoad::Variable<VarFileType::U8>("last_age", SLE_OBJECT_ADDRESS(GoodsEntry, last_age)),
    SaveLoad::Variable<VarFileType::U32>("cargo_feeder_share", SLE_GLOBAL_ADDRESS(_cargo_feeder_share), SaveLoadVersion::TransferOrder, SaveLoadVersion::UnifyCurrency),
    SaveLoad::Variable<VarFileType::I64>("cargo_feeder_share", SLE_GLOBAL_ADDRESS(_cargo_feeder_share), SaveLoadVersion::UnifyCurrency, SaveLoadVersion::CargoPackets),
    SaveLoad::Variable<VarFileType::U8>("amount_fract", SLE_OBJECT_ADDRESS(GoodsEntry, amount_fract), SaveLoadVersion::FractionalCargoDelivery),
    SaveLoad::ReferenceList<SLRefType::CargoPacket>("packets", SLE_GLOBAL_ADDRESS(_packets), SaveLoadVersion::CargoPackets, SaveLoadVersion::Cargodist),
    SaveLoad::Variable<VarFileType::U32>("old_num_dests", SLE_GLOBAL_ADDRESS(_old_num_dests), SaveLoadVersion::Cargodist, SaveLoadVersion::SaveloadListLength),
    SaveLoad::Variable<VarFileType::U32>("cargo.reserved_count", SLE_GLOBAL_ADDRESS(SlStationGoods::cargo_reserved_count), SaveLoadVersion::CargoReservation),
    SaveLoad::Variable<VarFileType::U16>("link_graph", SLE_OBJECT_ADDRESS(GoodsEntry, link_graph), SaveLoadVersion::Cargodist),
    SaveLoad::Variable<VarFileType::U16>("node", SLE_OBJECT_ADDRESS(GoodsEntry, node), SaveLoadVersion::Cargodist),
    SaveLoad::Variable<VarFileType::U32>("old_num_flows", SLE_GLOBAL_ADDRESS(_old_num_flows), SaveLoadVersion::Cargodist, SaveLoadVersion::SaveloadListLength),
    SaveLoad::Variable<VarFileType::U32>("max_waiting_cargo", SLE_OBJECT_ADDRESS(GoodsEntry, max_waiting_cargo), SaveLoadVersion::Cargodist),
    SaveLoad::StructList<SlStationFlow>("flow", SaveLoadVersion::Cargodist),
    SaveLoad::StructList<SlStationCargo>("cargo", SaveLoadVersion::Cargodist),
  };
 
  static inline const SaveLoadCompatTable compat_description = _station_goods_sl_compat;

  size_t GetNumCargo() const
  {
    if (IsSavegameVersionBefore(SaveLoadVersion::NewGRFCargo)) return 12;
    if (IsSavegameVersionBefore(SaveLoadVersion::ExtendCargotypes)) return 32;
    if (IsSavegameVersionBefore(SaveLoadVersion::SaveloadListLength)) return NUM_CARGO;
    /* Read from the savegame how long the list is. */
    return SlGetStructListLength(NUM_CARGO);
  }
 
  void Save(BaseStation *bst) const override
  {
    Station *st = Station::From(bst);
 
    SlSetStructListLength(NUM_CARGO);
 
    for (GoodsEntry &ge : st->goods) {
      SlStationGoods::cargo_reserved_count = ge.HasData() ? ge.GetData().cargo.reserved_count : 0;
      SlObject(&ge, this->GetDescription());
    }
  }
 
  void Load(BaseStation *bst) const override
  {
    Station *st = Station::From(bst);
 
    /* Before savegame version 161, persistent storages were not stored in a pool. */
    if (IsSavegameVersionBefore(SaveLoadVersion::PersistentStoragePool) && !IsSavegameVersionBefore(SaveLoadVersion::NewGRFAirportSmoke) && st->facilities.Test(StationFacility::Airport)) {
      /* Store the old persistent storage. The GRFID will be added later. */
      assert(PersistentStorage::CanAllocateItem());
      st->airport.psa = PersistentStorage::Create(GrfID{}, GrfSpecFeature::Invalid, TileIndex{});
      std::copy(std::begin(_old_st_persistent_storage.storage), std::end(_old_st_persistent_storage.storage), std::begin(st->airport.psa->storage));
    }
 
    auto end = std::next(std::begin(st->goods), std::min(this->GetNumCargo(), std::size(st->goods)));
    for (auto it = std::begin(st->goods); it != end; ++it) {
      GoodsEntry &ge = *it;
      SlObject(&ge, this->GetLoadDescription());
      if (!IsSavegameVersionBefore(SaveLoadVersion::CargoReservation) && SlStationGoods::cargo_reserved_count != 0) {
        ge.GetOrCreateData().cargo.reserved_count = SlStationGoods::cargo_reserved_count;
      }
      if (IsSavegameVersionBefore(SaveLoadVersion::Cargodist)) {
        SwapPackets(&ge);
      }
      if (IsSavegameVersionBefore(SaveLoadVersion::CargoPackets)) {
        ge.status.Set(GoodsEntry::State::Acceptance, HasBit(_waiting_acceptance, 15));
        if (GB(_waiting_acceptance, 0, 12) != 0) {
          /* In old versions, enroute_from used 0xFF as StationID::Invalid() */
          StationID source = (IsSavegameVersionBefore(SaveLoadVersion::LargerCargoSource) && _cargo_source == 0xFF) ? StationID::Invalid() : static_cast<StationID>(_cargo_source);
 
          /* Make sure we can allocate the CargoPacket. This is safe
           * as there can only be ~64k stations and 32 cargoes in these
           * savegame versions. As the CargoPacketPool has more than
           * 16 million entries; it fits by an order of magnitude. */
          assert(CargoPacket::CanAllocateItem());
 
          /* Don't construct the packet with station here, because that'll fail with old savegames */
          CargoPacket *cp = CargoPacket::Create(GB(_waiting_acceptance, 0, 12), _cargo_periods, source, TileIndex{_cargo_source_xy}, _cargo_feeder_share);
          ge.GetOrCreateData().cargo.Append(cp, StationID::Invalid());
          ge.status.Set(GoodsEntry::State::Rating);
        }
      }
    }
  }
 
  void FixPointers(BaseStation *bst) const override
  {
    Station *st = Station::From(bst);
 
    size_t num_cargo = IsSavegameVersionBefore(SaveLoadVersion::NewGRFCargo) ? 12 : IsSavegameVersionBefore(SaveLoadVersion::ExtendCargotypes) ? 32 : NUM_CARGO;
    auto end = std::next(std::begin(st->goods), std::min(num_cargo, std::size(st->goods)));
    for (auto it = std::begin(st->goods); it != end; ++it) {
      GoodsEntry &ge = *it;
      if (IsSavegameVersionBefore(SaveLoadVersion::Cargodist)) {
        SwapPackets(&ge); // We have to swap back again to be in the format pre-183 expects.
        SlObject(&ge, this->GetDescription());
        SwapPackets(&ge);
      } else {
        SlObject(&ge, this->GetDescription());
      }
    }
  }
};
 
static const SaveLoad _old_station_desc[] = {
  SaveLoad::Variable<VarFileType::U16>("xy", SLE_OBJECT_ADDRESS(Station, xy), SaveLoadVersion::MinVersion, SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Variable<VarFileType::U32>("xy", SLE_OBJECT_ADDRESS(Station, xy), SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Variable<VarFileType::U16>("train_station.tile", SLE_OBJECT_ADDRESS(Station, train_station.tile), SaveLoadVersion::MinVersion, SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Variable<VarFileType::U32>("train_station.tile", SLE_OBJECT_ADDRESS(Station, train_station.tile), SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Variable<VarFileType::U16>("airport.tile", SLE_OBJECT_ADDRESS(Station, airport.tile), SaveLoadVersion::MinVersion, SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Variable<VarFileType::U32>("airport.tile", SLE_OBJECT_ADDRESS(Station, airport.tile), SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Reference<SLRefType::Town>("town", SLE_OBJECT_ADDRESS(Station, town)),
  SaveLoad::Variable<VarFileType::U8>("train_station.w", SLE_OBJECT_ADDRESS(Station, train_station.w)),
  SaveLoad::Variable<VarFileType::U8>("train_station.h", SLE_OBJECT_ADDRESS(Station, train_station.h), SaveLoadVersion::VehicleCurrencyStationChanges),
 
  SaveLoad::Variable<VarFileType::StringID>("string_id", SLE_OBJECT_ADDRESS(Station, string_id)),
  SaveLoad::String("name", SLE_OBJECT_ADDRESS(Station, name), StringValidationSetting::AllowControlCode, SaveLoadVersion::ReplaceCustomNameArray),
  SaveLoad::Variable<VarFileType::U8>("indtype", SLE_OBJECT_ADDRESS(Station, indtype), SaveLoadVersion::NewGRFSuppliedStationName),
  SaveLoad::Variable<VarFileType::U16>("had_vehicle_of_type", SLE_OBJECT_ADDRESS(Station, had_vehicle_of_type), SaveLoadVersion::MinVersion, SaveLoadVersion::WaypointMoreLikeStation),
  SaveLoad::Variable<VarFileType::U8>("had_vehicle_of_type", SLE_OBJECT_ADDRESS(Station, had_vehicle_of_type), SaveLoadVersion::WaypointMoreLikeStation),
 
  SaveLoad::Variable<VarFileType::U8>("time_since_load", SLE_OBJECT_ADDRESS(Station, time_since_load)),
  SaveLoad::Variable<VarFileType::U8>("time_since_unload", SLE_OBJECT_ADDRESS(Station, time_since_unload)),
  SaveLoad::Variable<VarFileType::U8>("delete_ctr", SLE_OBJECT_ADDRESS(Station, delete_ctr)),
  SaveLoad::Variable<VarFileType::U8>("owner", SLE_OBJECT_ADDRESS(Station, owner)),
  SaveLoad::Variable<VarFileType::U8>("facilities", SLE_OBJECT_ADDRESS(Station, facilities)),
  SaveLoad::Variable<VarFileType::U8>("airport.type", SLE_OBJECT_ADDRESS(Station, airport.type)),
  SaveLoad::Variable<VarFileType::U16>("airport.flags", SLE_OBJECT_ADDRESS(Station, airport.blocks), SaveLoadVersion::MinVersion, SaveLoadVersion::BiggerStationVariables),
  SaveLoad::Variable<VarFileType::U32>("airport.flags", SLE_OBJECT_ADDRESS(Station, airport.blocks), SaveLoadVersion::BiggerStationVariables, SaveLoadVersion::MoreAirportBlocks),
  SaveLoad::Variable<VarFileType::U64>("airport.flags", SLE_OBJECT_ADDRESS(Station, airport.blocks), SaveLoadVersion::MoreAirportBlocks),
 
  SaveLoad::Variable<VarFileType::U8>("last_vehicle_type", SLE_OBJECT_ADDRESS(Station, last_vehicle_type), SaveLoadVersion::LastVehicleType),
 
  SaveLoad::Variable<VarFileType::U16>("build_date", SLE_OBJECT_ADDRESS(Station, build_date), SaveLoadVersion::BiggerStationVariables, SaveLoadVersion::BigDates),
  SaveLoad::Variable<VarFileType::I32>("build_date", SLE_OBJECT_ADDRESS(Station, build_date), SaveLoadVersion::BigDates),
 
  SaveLoad::Reference<SLRefType::RoadStop>("bus_stops", SLE_OBJECT_ADDRESS(Station, bus_stops), SaveLoadVersion::MultipleRoadStops),
  SaveLoad::Reference<SLRefType::RoadStop>("truck_stops", SLE_OBJECT_ADDRESS(Station, truck_stops), SaveLoadVersion::MultipleRoadStops),
 
  /* Used by newstations for graphic variations */
  SaveLoad::Variable<VarFileType::U16>("random_bits", SLE_OBJECT_ADDRESS(Station, random_bits), SaveLoadVersion::NewGRFStations),
  SaveLoad::Variable<VarFileType::U8>("waiting_triggers", SLE_OBJECT_ADDRESS(Station, waiting_random_triggers), SaveLoadVersion::NewGRFStations),
  SaveLoad::Variable<VarFileType::U8>("num_specs", SLE_GLOBAL_ADDRESS(SlStationSpecList<StationSpec>::last_num_specs), SaveLoadVersion::NewGRFStations),
 
  SaveLoad::ReferenceList<SLRefType::Vehicle>("loading_vehicles", SLE_OBJECT_ADDRESS(Station, loading_vehicles), SaveLoadVersion::FifoLoading),
 
  SaveLoad::StructList<SlStationGoods>("goods"),
  SaveLoad::StructList<SlStationSpecList<StationSpec>>("speclist", SaveLoadVersion::NewGRFStations),
};
 
struct STNSChunkHandler : ChunkHandler {
  STNSChunkHandler() : ChunkHandler("STNS", ChunkType::ReadOnly) {}
 
  void Load() const override
  {
    const std::vector<SaveLoad> slt = SlCompatTableHeader(_old_station_desc, _old_station_sl_compat);
 
    _cargo_source_xy = 0;
    _cargo_periods = 0;
    _cargo_feeder_share = 0;
 
    int index;
    while ((index = SlIterateArray()) != -1) {
      Station *st = Station::CreateAtIndex(StationID(index));
 
      _waiting_acceptance = 0;
      SlObject(st, slt);
    }
  }
 
  void FixPointers() const override
  {
    /* From SaveLoadVersion::UnifyWaypointAndStation we store stations in STNN; before that in STNS. So do not
     * fix pointers when the version is SaveLoadVersion::UnifyWaypointAndStation or up, as that would fix
     * pointers twice: once in STNN chunk and once here. */
    if (!IsSavegameVersionBefore(SaveLoadVersion::UnifyWaypointAndStation)) return;
 
    for (Station *st : Station::Iterate()) {
      SlObject(st, _old_station_desc);
    }
  }
};
 
class SlRoadStopTileData : public VectorSaveLoadHandler<SlRoadStopTileData, BaseStation, RoadStopTileData> {
public:
  static inline const SaveLoad description[] = {
  SaveLoad::Variable<VarFileType::U32>("tile", SLE_OBJECT_ADDRESS(RoadStopTileData, tile)),
  SaveLoad::Variable<VarFileType::U8>("random_bits", SLE_OBJECT_ADDRESS(RoadStopTileData, random_bits)),
  SaveLoad::Variable<VarFileType::U8>("animation_frame", SLE_OBJECT_ADDRESS(RoadStopTileData, animation_frame)),
  };
  static inline const SaveLoadCompatTable compat_description = {};
 
  std::vector<RoadStopTileData> &GetVector(BaseStation *bst) const override { return bst->custom_roadstop_tile_data; }
};

class SlStationBase : public DefaultSaveLoadHandler<SlStationBase, BaseStation> {
public:
  static inline const SaveLoad description[] = {
    SaveLoad::Variable<VarFileType::U32>("xy", SLE_OBJECT_ADDRESS(BaseStation, xy)),
    SaveLoad::Reference<SLRefType::Town>("town", SLE_OBJECT_ADDRESS(BaseStation, town)),
    SaveLoad::Variable<VarFileType::StringID>("string_id", SLE_OBJECT_ADDRESS(BaseStation, string_id)),
    SaveLoad::String("name", SLE_OBJECT_ADDRESS(BaseStation, name), StringValidationSetting::AllowControlCode),
    SaveLoad::Variable<VarFileType::U8>("delete_ctr", SLE_OBJECT_ADDRESS(BaseStation, delete_ctr)),
    SaveLoad::Variable<VarFileType::U8>("owner", SLE_OBJECT_ADDRESS(BaseStation, owner)),
    SaveLoad::Variable<VarFileType::U8>("facilities", SLE_OBJECT_ADDRESS(BaseStation, facilities)),
    SaveLoad::Variable<VarFileType::I32>("build_date", SLE_OBJECT_ADDRESS(BaseStation, build_date)),
 
    /* Used by newstations for graphic variations */
    SaveLoad::Variable<VarFileType::U16>("random_bits", SLE_OBJECT_ADDRESS(BaseStation, random_bits)),
    SaveLoad::Variable<VarFileType::U8>("waiting_triggers", SLE_OBJECT_ADDRESS(BaseStation, waiting_random_triggers)),
  SaveLoad::StructList<SlStationWaitingTriggers>("tile_waiting_triggers"),
  SaveLoad::Variable<VarFileType::U8>("num_specs", SLE_GLOBAL_ADDRESS(SlStationSpecList<StationSpec>::last_num_specs), SaveLoadVersion::MinVersion, SaveLoadVersion::SaveloadListLength),
  };
  static inline const SaveLoadCompatTable compat_description = _station_base_sl_compat;
 
  void Save(BaseStation *bst) const override
  {
    SlObject(bst, this->GetDescription());
  }
 
  void Load(BaseStation *bst) const override
  {
    SlObject(bst, this->GetLoadDescription());
  }
 
  void FixPointers(BaseStation *bst) const override
  {
    SlObject(bst, this->GetDescription());
  }
};

class SlStationNormal : public DefaultSaveLoadHandler<SlStationNormal, BaseStation> {
public:
  static inline const SaveLoad description[] = {
    SaveLoad::Struct<SlStationBase>("base"),
    SaveLoad::Variable<VarFileType::U32>("train_station.tile", SLE_OBJECT_ADDRESS(Station, train_station.tile)),
    SaveLoad::Variable<VarFileType::U8>("train_station.w", SLE_OBJECT_ADDRESS(Station, train_station.w)),
    SaveLoad::Variable<VarFileType::U8>("train_station.h", SLE_OBJECT_ADDRESS(Station, train_station.h)),
 
    SaveLoad::Reference<SLRefType::RoadStop>("bus_stops", SLE_OBJECT_ADDRESS(Station, bus_stops)),
    SaveLoad::Reference<SLRefType::RoadStop>("truck_stops", SLE_OBJECT_ADDRESS(Station, truck_stops)),
    SaveLoad::Variable<VarFileType::U32>("ship_station.tile", SLE_OBJECT_ADDRESS(Station, ship_station.tile), SaveLoadVersion::MultitileDocks),
    SaveLoad::Variable<VarFileType::U8>("ship_station.w", SLE_OBJECT_ADDRESS(Station, ship_station.w), SaveLoadVersion::MultitileDocks),
    SaveLoad::Variable<VarFileType::U8>("ship_station.h", SLE_OBJECT_ADDRESS(Station, ship_station.h), SaveLoadVersion::MultitileDocks),
    SaveLoad::Variable<VarFileType::U32>("docking_station.tile", SLE_OBJECT_ADDRESS(Station, docking_station.tile), SaveLoadVersion::MultitileDocks),
    SaveLoad::Variable<VarFileType::U8>("docking_station.w", SLE_OBJECT_ADDRESS(Station, docking_station.w), SaveLoadVersion::MultitileDocks),
    SaveLoad::Variable<VarFileType::U8>("docking_station.h", SLE_OBJECT_ADDRESS(Station, docking_station.h), SaveLoadVersion::MultitileDocks),
    SaveLoad::Variable<VarFileType::U32>("airport.tile", SLE_OBJECT_ADDRESS(Station, airport.tile)),
    SaveLoad::Variable<VarFileType::U8>("airport.w", SLE_OBJECT_ADDRESS(Station, airport.w), SaveLoadVersion::StoreAirportSize),
    SaveLoad::Variable<VarFileType::U8>("airport.h", SLE_OBJECT_ADDRESS(Station, airport.h), SaveLoadVersion::StoreAirportSize),
    SaveLoad::Variable<VarFileType::U8>("airport.type", SLE_OBJECT_ADDRESS(Station, airport.type)),
    SaveLoad::Variable<VarFileType::U8>("airport.layout", SLE_OBJECT_ADDRESS(Station, airport.layout), SaveLoadVersion::NewGRFAirportSmoke),
    SaveLoad::Variable<VarFileType::U64>("airport.flags", SLE_OBJECT_ADDRESS(Station, airport.blocks)),
    SaveLoad::Variable<VarFileType::U8>("airport.rotation", SLE_OBJECT_ADDRESS(Station, airport.rotation), SaveLoadVersion::NewGRFAirportSmoke),
    SaveLoad::Array<VarFileType::U32, 16>("storage", SLE_GLOBAL_ADDRESS(_old_st_persistent_storage.storage), SaveLoadVersion::NewGRFAirportSmoke, SaveLoadVersion::PersistentStoragePool),
    SaveLoad::Reference<SLRefType::Storage>("airport.psa", SLE_OBJECT_ADDRESS(Station, airport.psa), SaveLoadVersion::PersistentStoragePool),
 
    SaveLoad::Variable<VarFileType::U8>("indtype", SLE_OBJECT_ADDRESS(Station, indtype)),
 
    SaveLoad::Variable<VarFileType::U8>("time_since_load", SLE_OBJECT_ADDRESS(Station, time_since_load)),
    SaveLoad::Variable<VarFileType::U8>("time_since_unload", SLE_OBJECT_ADDRESS(Station, time_since_unload)),
    SaveLoad::Variable<VarFileType::U8>("last_vehicle_type", SLE_OBJECT_ADDRESS(Station, last_vehicle_type)),
    SaveLoad::Variable<VarFileType::U8>("had_vehicle_of_type", SLE_OBJECT_ADDRESS(Station, had_vehicle_of_type)),
    SaveLoad::ReferenceList<SLRefType::Vehicle>("loading_vehicles", SLE_OBJECT_ADDRESS(Station, loading_vehicles)),
    SaveLoad::Variable<VarFileType::U32>("always_accepted", SLE_OBJECT_ADDRESS(Station, always_accepted), SaveLoadVersion::TownAcceptance, SaveLoadVersion::ExtendCargotypes),
    SaveLoad::Variable<VarFileType::U64>("always_accepted", SLE_OBJECT_ADDRESS(Station, always_accepted), SaveLoadVersion::ExtendCargotypes),
    SaveLoad::StructList<SlRoadStopTileData>("speclist", SaveLoadVersion::NewGRFRoadStops, SaveLoadVersion::RoadStopTileData),
    SaveLoad::StructList<SlStationGoods>("goods"),
  };
  static inline const SaveLoadCompatTable compat_description = _station_normal_sl_compat;
 
  void Save(BaseStation *bst) const override
  {
    if (bst->facilities.Test(StationFacility::Waypoint)) return;
    SlObject(bst, this->GetDescription());
  }
 
  void Load(BaseStation *bst) const override
  {
    if (bst->facilities.Test(StationFacility::Waypoint)) return;
    SlObject(bst, this->GetLoadDescription());
  }
 
  void FixPointers(BaseStation *bst) const override
  {
    if (bst->facilities.Test(StationFacility::Waypoint)) return;
    SlObject(bst, this->GetDescription());
  }
};
 
class SlStationWaypoint : public DefaultSaveLoadHandler<SlStationWaypoint, BaseStation> {
public:
  static inline const SaveLoad description[] = {
    SaveLoad::Struct<SlStationBase>("base"),
    SaveLoad::Variable<VarFileType::U16>("town_cn", SLE_OBJECT_ADDRESS(Waypoint, town_cn)),
 
    SaveLoad::Variable<VarFileType::U32>("train_station.tile", SLE_OBJECT_ADDRESS(Waypoint, train_station.tile), SaveLoadVersion::MultiTileWaypoints),
    SaveLoad::Variable<VarFileType::U8>("train_station.w", SLE_OBJECT_ADDRESS(Waypoint, train_station.w), SaveLoadVersion::MultiTileWaypoints),
    SaveLoad::Variable<VarFileType::U8>("train_station.h", SLE_OBJECT_ADDRESS(Waypoint, train_station.h), SaveLoadVersion::MultiTileWaypoints),
    SaveLoad::Variable<VarFileType::U16>("waypoint_flags", SLE_OBJECT_ADDRESS(Waypoint, waypoint_flags), SaveLoadVersion::RoadWaypoints),
    SaveLoad::Variable<VarFileType::U32>("road_waypoint_area.tile", SLE_OBJECT_ADDRESS(Waypoint, road_waypoint_area.tile), SaveLoadVersion::RoadWaypoints),
    SaveLoad::Variable<VarFileType::U8>("road_waypoint_area.w", SLE_OBJECT_ADDRESS(Waypoint, road_waypoint_area.w), SaveLoadVersion::RoadWaypoints),
    SaveLoad::Variable<VarFileType::U8>("road_waypoint_area.h", SLE_OBJECT_ADDRESS(Waypoint, road_waypoint_area.h), SaveLoadVersion::RoadWaypoints),
  };
  static inline const SaveLoadCompatTable compat_description = _station_waypoint_sl_compat;
 
  void Save(BaseStation *bst) const override
  {
    if (!bst->facilities.Test(StationFacility::Waypoint)) return;
    SlObject(bst, this->GetDescription());
  }
 
  void Load(BaseStation *bst) const override
  {
    if (!bst->facilities.Test(StationFacility::Waypoint)) return;
    SlObject(bst, this->GetLoadDescription());
  }
 
  void FixPointers(BaseStation *bst) const override
  {
    if (!bst->facilities.Test(StationFacility::Waypoint)) return;
    SlObject(bst, this->GetDescription());
  }
};
 
static const SaveLoad _station_desc[] = {
  SaveLoad::SaveByte("facilities", SLE_OBJECT_ADDRESS(BaseStation, facilities)),
  SaveLoad::Struct<SlStationNormal>("normal"),
  SaveLoad::Struct<SlStationWaypoint>("waypoint"),
  SaveLoad::StructList<SlStationSpecList<StationSpec>>("speclist", SaveLoadVersion::NewGRFStations),
  SaveLoad::StructList<SlStationSpecList<RoadStopSpec>>("roadstopspeclist", SaveLoadVersion::NewGRFRoadStops),
  SaveLoad::StructList<SlRoadStopTileData>("roadstoptiledata", SaveLoadVersion::RoadStopTileData),
};
 
struct STNNChunkHandler : ChunkHandler {
  STNNChunkHandler() : ChunkHandler("STNN", ChunkType::Table) {}
 
  void Save() const override
  {
    SlTableHeader(_station_desc);
 
    /* Write the stations */
    for (BaseStation *st : BaseStation::Iterate()) {
      SlSetArrayIndex(st->index);
      SlObject(st, _station_desc);
    }
  }
 
 
  void Load() const override
  {
    const std::vector<SaveLoad> slt = SlCompatTableHeader(_station_desc, _station_sl_compat);
 
    _old_num_flows = 0;
 
    int index;
    while ((index = SlIterateArray()) != -1) {
      bool waypoint = static_cast<StationFacilities>(SlReadByte()).Test(StationFacility::Waypoint);
 
      BaseStation *bst = waypoint ? (BaseStation *)Waypoint::CreateAtIndex(StationID(index)) : Station::CreateAtIndex(StationID(index));
      SlObject(bst, slt);
    }
  }
 
  void FixPointers() const override
  {
    /* From SaveLoadVersion::UnifyWaypointAndStation we store stations in STNN; before that in STNS. So do not
     * fix pointers when the version is below SaveLoadVersion::UnifyWaypointAndStation, as that would fix
     * pointers twice: once in STNS chunk and once here. */
    if (IsSavegameVersionBefore(SaveLoadVersion::UnifyWaypointAndStation)) return;
 
    for (BaseStation *bst : BaseStation::Iterate()) {
      SlObject(bst, _station_desc);
    }
  }
};
 
struct ROADChunkHandler : ChunkHandler {
  ROADChunkHandler() : ChunkHandler("ROAD", ChunkType::Table) {}
 
  void Save() const override
  {
    SlTableHeader(_roadstop_desc);
 
    for (RoadStop *rs : RoadStop::Iterate()) {
      SlSetArrayIndex(rs->index);
      SlObject(rs, _roadstop_desc);
    }
  }
 
  void Load() const override
  {
    const std::vector<SaveLoad> slt = SlCompatTableHeader(_roadstop_desc, _roadstop_sl_compat);
 
    int index;
 
    while ((index = SlIterateArray()) != -1) {
      RoadStop *rs = RoadStop::CreateAtIndex(RoadStopID(index), INVALID_TILE);
 
      SlObject(rs, slt);
    }
  }
 
  void FixPointers() const override
  {
    for (RoadStop *rs : RoadStop::Iterate()) {
      SlObject(rs, _roadstop_desc);
    }
  }
};
 
static const STNSChunkHandler STNS;
static const STNNChunkHandler STNN;
static const ROADChunkHandler ROAD;
static const ChunkHandlerRef station_chunk_handlers[] = {
  STNS,
  STNN,
  ROAD,
};
 
extern const ChunkHandlerTable _station_chunk_handlers(station_chunk_handlers);