src/order_backup.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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 <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file order_backup.cpp Handling of order backups. */
  11
  12 #include "stdafx.h"
  13 #include "command_func.h"
  14 #include "core/pool_func.hpp"
  15 #include "network/network.h"
  16 #include "network/network_func.h"
  17 #include "order_backup.h"
  18 #include "vehicle_base.h"
  19 #include "window_func.h"
  20 #include "station_map.h"
  21
  22 #include "safeguards.h"
  23
  24 OrderBackupPool _order_backup_pool("BackupOrder");
  25 INSTANTIATE_POOL_METHODS(OrderBackup)
  26
  27 /** Free everything that is allocated. */
  28 OrderBackup::~OrderBackup()
  29 {
  30         if (CleaningPool()) return;
  31
  32         Order *o = this->orders;
  33         while (o != nullptr) {
  34                 Order *next = o->next;
  35                 delete o;
  36                 o = next;
  37         }
  38 }
  39
  40 /**
  41  * Create an order backup for the given vehicle.
  42  * @param v    The vehicle to make a backup of.
  43  * @param user The user that is requesting the backup.
  44  */
  45 OrderBackup::OrderBackup(const Vehicle *v, uint32 user)
  46 {
  47         this->user             = user;
  48         this->tile             = v->tile;
  49         this->group            = v->group_id;
  50
  51         this->CopyConsistPropertiesFrom(v);
  52
  53         /* If we have shared orders, store the vehicle we share the order with. */
  54         if (v->HasSharedOrdersList()) {
  55                 this->clone = (v->FirstShared() == v) ? v->NextShared() : v->FirstShared();
  56         } else {
  57                 /* Else copy the orders */
  58                 Order **tail = &this->orders;
  59
  60                 /* Count the number of orders */
  61                 const Order *order;
  62                 FOR_VEHICLE_ORDERS(v, order) {
  63                         Order *copy = new Order();
  64                         copy->AssignOrder(*order);
  65                         *tail = copy;
  66                         tail = &copy->next;
  67                 }
  68         }
  69 }
  70
  71 /**
  72  * Restore the data of this order to the given vehicle.
  73  * @param v The vehicle to restore to.
  74  */
  75 void OrderBackup::DoRestore(Vehicle *v)
  76 {
  77         /* If we had shared orders, recover that */
  78         if (this->clone != nullptr) {
  79                 DoCommand(0, v->index | CO_SHARE << 30, this->clone->index, DC_EXEC, CMD_CLONE_ORDER);
  80         } else if (this->orders != nullptr && OrderList::CanAllocateItem()) {
  81                 v->SetOrdersList(new OrderList(this->orders, v));
  82                 this->orders = nullptr;
  83                 /* Make sure buoys/oil rigs are updated in the station list. */
  84                 InvalidateWindowClassesData(WC_STATION_LIST, 0);
  85         }
  86
  87         v->CopyConsistPropertiesFrom(this);
  88
  89         /* Make sure orders are in range */
  90         v->UpdateRealOrderIndex();
  91         if (v->cur_implicit_order_index >= v->GetNumOrders()) v->cur_implicit_order_index = v->cur_real_order_index;
  92         if (v->cur_timetable_order_index >= v->GetNumOrders()) v->cur_timetable_order_index = INVALID_VEH_ORDER_ID;
  93
  94         /* Restore vehicle group */
  95         DoCommand(0, this->group, v->index, DC_EXEC, CMD_ADD_VEHICLE_GROUP);
  96 }
  97
  98 /**
  99  * Create an order backup for the given vehicle.
 100  * @param v    The vehicle to make a backup of.
 101  * @param user The user that is requesting the backup.
 102  * @note Will automatically remove any previous backups of this user.
 103  */
 104 /* static */ void OrderBackup::Backup(const Vehicle *v, uint32 user)
 105 {
 106         /* Don't use reset as that broadcasts over the network to reset the variable,
 107          * which is what we are doing at the moment. */
 108         OrderBackup *ob;
 109         FOR_ALL_ORDER_BACKUPS(ob) {
 110                 if (ob->user == user) delete ob;
 111         }
 112         if (OrderBackup::CanAllocateItem()) {
 113                 new OrderBackup(v, user);
 114         }
 115 }
 116
 117 /**
 118  * Restore the data of this order to the given vehicle.
 119  * @param v    The vehicle to restore to.
 120  * @param user The user that built the vehicle, thus wants to restore.
 121  * @note After restoration the backup will automatically be removed.
 122  */
 123 /* static */ void OrderBackup::Restore(Vehicle *v, uint32 user)
 124 {
 125         OrderBackup *ob;
 126         FOR_ALL_ORDER_BACKUPS(ob) {
 127                 if (v->tile != ob->tile || ob->user != user) continue;
 128
 129                 ob->DoRestore(v);
 130                 delete ob;
 131         }
 132 }
 133
 134 /**
 135  * Reset an OrderBackup given a tile and user.
 136  * @param tile The tile associated with the OrderBackup.
 137  * @param user The user associated with the OrderBackup.
 138  * @note Must not be used from the GUI!
 139  */
 140 /* static */ void OrderBackup::ResetOfUser(TileIndex tile, uint32 user)
 141 {
 142         OrderBackup *ob;
 143         FOR_ALL_ORDER_BACKUPS(ob) {
 144                 if (ob->user == user && (ob->tile == tile || tile == INVALID_TILE)) delete ob;
 145         }
 146 }
 147
 148 /**
 149  * Clear an OrderBackup
 150  * @param tile  Tile related to the to-be-cleared OrderBackup.
 151  * @param flags For command.
 152  * @param p1    Unused.
 153  * @param p2    User that had the OrderBackup.
 154  * @param text  Unused.
 155  * @return The cost of this operation or an error.
 156  */
 157 CommandCost CmdClearOrderBackup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 158 {
 159         /* No need to check anything. If the tile or user don't exist we just ignore it. */
 160         if (flags & DC_EXEC) OrderBackup::ResetOfUser(tile == 0 ? INVALID_TILE : tile, p2);
 161
 162         return CommandCost();
 163 }
 164
 165 /**
 166  * Reset an user's OrderBackup if needed.
 167  * @param user The user associated with the OrderBackup.
 168  * @pre _network_server.
 169  * @note Must not be used from a command.
 170  */
 171 /* static */ void OrderBackup::ResetUser(uint32 user)
 172 {
 173         assert(_network_server);
 174
 175         OrderBackup *ob;
 176         FOR_ALL_ORDER_BACKUPS(ob) {
 177                 /* If it's not an backup of us, so ignore it. */
 178                 if (ob->user != user) continue;
 179
 180                 DoCommandP(0, 0, user, CMD_CLEAR_ORDER_BACKUP);
 181                 return;
 182         }
 183 }
 184
 185 /**
 186  * Reset the OrderBackups from GUI/game logic.
 187  * @param t        The tile of the order backup.
 188  * @param from_gui Whether the call came from the GUI, i.e. whether
 189  *                 it must be synced over the network.
 190  */
 191 /* static */ void OrderBackup::Reset(TileIndex t, bool from_gui)
 192 {
 193         /* The user has CLIENT_ID_SERVER as default when network play is not active,
 194          * but compiled it. A network client has its own variable for the unique
 195          * client/user identifier. Finally if networking isn't compiled in the
 196          * default is just plain and simple: 0. */
 197 #ifdef ENABLE_NETWORK
 198         uint32 user = _networking && !_network_server ? _network_own_client_id : CLIENT_ID_SERVER;
 199 #else
 200         uint32 user = 0;
 201 #endif
 202
 203         OrderBackup *ob;
 204         FOR_ALL_ORDER_BACKUPS(ob) {
 205                 /* If it's not an backup of us, so ignore it. */
 206                 if (ob->user != user) continue;
 207                 /* If it's not for our chosen tile either, ignore it. */
 208                 if (t != INVALID_TILE && t != ob->tile) continue;
 209
 210                 if (from_gui) {
 211                         /* We need to circumvent the "prevention" from this command being executed
 212                          * while the game is paused, so use the internal method. Nor do we want
 213                          * this command to get its cost estimated when shift is pressed. */
 214                         DoCommandPInternal(ob->tile, 0, user, CMD_CLEAR_ORDER_BACKUP, nullptr, nullptr, true, false, 0);
 215                 } else {
 216                         /* The command came from the game logic, i.e. the clearing of a tile.
 217                          * In that case we have no need to actually sync this, just do it. */
 218                         delete ob;
 219                 }
 220         }
 221 }
 222
 223 /**
 224  * Clear the group of all backups having this group ID.
 225  * @param group The group to clear.
 226  */
 227 /* static */ void OrderBackup::ClearGroup(GroupID group)
 228 {
 229         OrderBackup *ob;
 230         FOR_ALL_ORDER_BACKUPS(ob) {
 231                 if (ob->group == group) ob->group = DEFAULT_GROUP;
 232         }
 233 }
 234
 235 /**
 236  * Clear/update the (clone) vehicle from an order backup.
 237  * @param v The vehicle to clear.
 238  * @pre v != nullptr
 239  * @note If it is not possible to set another vehicle as clone
 240  *       "example", then this backed up order will be removed.
 241  */
 242 /* static */ void OrderBackup::ClearVehicle(const Vehicle *v)
 243 {
 244         assert(v != nullptr);
 245         OrderBackup *ob;
 246         FOR_ALL_ORDER_BACKUPS(ob) {
 247                 if (ob->clone == v) {
 248                         /* Get another item in the shared list. */
 249                         ob->clone = (v->FirstShared() == v) ? v->NextShared() : v->FirstShared();
 250                         /* But if that isn't there, remove it. */
 251                         if (ob->clone == nullptr) delete ob;
 252                 }
 253         }
 254 }
 255
 256 /**
 257  * Removes an order from all vehicles. Triggers when, say, a station is removed.
 258  * @param type The type of the order (OT_GOTO_[STATION|DEPOT|WAYPOINT]).
 259  * @param destination The destination. Can be a StationID, DepotID or WaypointID.
 260  */
 261 /* static */ void OrderBackup::RemoveOrder(OrderType type, DestinationID destination)
 262 {
 263         OrderBackup *ob;
 264         FOR_ALL_ORDER_BACKUPS(ob) {
 265                 for (Order *order = ob->orders; order != nullptr; order = order->next) {
 266                         OrderType ot = order->GetType();
 267                         if (ot == OT_GOTO_DEPOT && (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0) continue;
 268                         if (ot == OT_IMPLICIT || (IsHangarTile(ob->tile) && ot == OT_GOTO_DEPOT)) ot = OT_GOTO_STATION;
 269                         if (ot == type && order->GetDestination() == destination) {
 270                                 /* Remove the order backup! If a station/depot gets removed, we can't/shouldn't restore those broken orders. */
 271                                 delete ob;
 272                                 break;
 273                         }
 274                 }
 275         }
 276 }