autoreplace_cmd.cpp

Go to the documentation of this file.
00001 /* $Id: autoreplace_cmd.cpp 23526 2011-12-15 21:56:00Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "company_func.h"
00014 #include "train.h"
00015 #include "command_func.h"
00016 #include "engine_func.h"
00017 #include "vehicle_func.h"
00018 #include "autoreplace_func.h"
00019 #include "autoreplace_gui.h"
00020 #include "group.h"
00021 #include "articulated_vehicles.h"
00022 #include "core/random_func.hpp"
00023 
00024 #include "table/strings.h"
00025 
00026 extern void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index);
00027 extern void ChangeVehicleNews(VehicleID from_index, VehicleID to_index);
00028 extern void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index);
00029 
00037 static bool EnginesHaveCargoInCommon(EngineID engine_a, EngineID engine_b)
00038 {
00039   uint32 available_cargoes_a = GetUnionOfArticulatedRefitMasks(engine_a, true);
00040   uint32 available_cargoes_b = GetUnionOfArticulatedRefitMasks(engine_b, true);
00041   return (available_cargoes_a == 0 || available_cargoes_b == 0 || (available_cargoes_a & available_cargoes_b) != 0);
00042 }
00043 
00051 bool CheckAutoreplaceValidity(EngineID from, EngineID to, CompanyID company)
00052 {
00053   assert(Engine::IsValidID(from) && Engine::IsValidID(to));
00054 
00055   /* we can't replace an engine into itself (that would be autorenew) */
00056   if (from == to) return false;
00057 
00058   const Engine *e_from = Engine::Get(from);
00059   const Engine *e_to = Engine::Get(to);
00060   VehicleType type = e_from->type;
00061 
00062   /* check that the new vehicle type is available to the company and its type is the same as the original one */
00063   if (!IsEngineBuildable(to, type, company)) return false;
00064 
00065   switch (type) {
00066     case VEH_TRAIN: {
00067       /* make sure the railtypes are compatible */
00068       if ((GetRailTypeInfo(e_from->u.rail.railtype)->compatible_railtypes & GetRailTypeInfo(e_to->u.rail.railtype)->compatible_railtypes) == 0) return false;
00069 
00070       /* make sure we do not replace wagons with engines or vise versa */
00071       if ((e_from->u.rail.railveh_type == RAILVEH_WAGON) != (e_to->u.rail.railveh_type == RAILVEH_WAGON)) return false;
00072       break;
00073     }
00074 
00075     case VEH_ROAD:
00076       /* make sure that we do not replace a tram with a normal road vehicles or vise versa */
00077       if (HasBit(e_from->info.misc_flags, EF_ROAD_TRAM) != HasBit(e_to->info.misc_flags, EF_ROAD_TRAM)) return false;
00078       break;
00079 
00080     case VEH_AIRCRAFT:
00081       /* make sure that we do not replace a plane with a helicopter or vise versa */
00082       if ((e_from->u.air.subtype & AIR_CTOL) != (e_to->u.air.subtype & AIR_CTOL)) return false;
00083       break;
00084 
00085     default: break;
00086   }
00087 
00088   /* the engines needs to be able to carry the same cargo */
00089   return EnginesHaveCargoInCommon(from, to);
00090 }
00091 
00098 static void TransferCargo(Vehicle *old_veh, Vehicle *new_head, bool part_of_chain)
00099 {
00100   assert(!part_of_chain || new_head->IsPrimaryVehicle());
00101   /* Loop through source parts */
00102   for (Vehicle *src = old_veh; src != NULL; src = src->Next()) {
00103     if (!part_of_chain && src->type == VEH_TRAIN && src != old_veh && src != Train::From(old_veh)->other_multiheaded_part && !src->IsArticulatedPart()) {
00104       /* Skip vehicles, which do not belong to old_veh */
00105       src = src->GetLastEnginePart();
00106       continue;
00107     }
00108     if (src->cargo_type >= NUM_CARGO || src->cargo.Count() == 0) continue;
00109 
00110     /* Find free space in the new chain */
00111     for (Vehicle *dest = new_head; dest != NULL && src->cargo.Count() > 0; dest = dest->Next()) {
00112       if (!part_of_chain && dest->type == VEH_TRAIN && dest != new_head && dest != Train::From(new_head)->other_multiheaded_part && !dest->IsArticulatedPart()) {
00113         /* Skip vehicles, which do not belong to new_head */
00114         dest = dest->GetLastEnginePart();
00115         continue;
00116       }
00117       if (dest->cargo_type != src->cargo_type) continue;
00118 
00119       uint amount = min(src->cargo.Count(), dest->cargo_cap - dest->cargo.Count());
00120       if (amount <= 0) continue;
00121 
00122       src->cargo.MoveTo(&dest->cargo, amount, VehicleCargoList::MTA_UNLOAD, NULL);
00123     }
00124   }
00125 
00126   /* Update train weight etc., the old vehicle will be sold anyway */
00127   if (part_of_chain && new_head->type == VEH_TRAIN) Train::From(new_head)->ConsistChanged(true);
00128 }
00129 
00136 static bool VerifyAutoreplaceRefitForOrders(const Vehicle *v, EngineID engine_type)
00137 {
00138 
00139   uint32 union_refit_mask_a = GetUnionOfArticulatedRefitMasks(v->engine_type, false);
00140   uint32 union_refit_mask_b = GetUnionOfArticulatedRefitMasks(engine_type, false);
00141 
00142   const Order *o;
00143   const Vehicle *u = (v->type == VEH_TRAIN) ? v->First() : v;
00144   FOR_VEHICLE_ORDERS(u, o) {
00145     if (!o->IsRefit() || o->IsAutoRefit()) continue;
00146     CargoID cargo_type = o->GetRefitCargo();
00147 
00148     if (!HasBit(union_refit_mask_a, cargo_type)) continue;
00149     if (!HasBit(union_refit_mask_b, cargo_type)) return false;
00150   }
00151 
00152   return true;
00153 }
00154 
00164 static CargoID GetNewCargoTypeForReplace(Vehicle *v, EngineID engine_type, bool part_of_chain)
00165 {
00166   uint32 available_cargo_types, union_mask;
00167   GetArticulatedRefitMasks(engine_type, true, &union_mask, &available_cargo_types);
00168 
00169   if (union_mask == 0) return CT_NO_REFIT; // Don't try to refit an engine with no cargo capacity
00170 
00171   CargoID cargo_type;
00172   if (IsArticulatedVehicleCarryingDifferentCargoes(v, &cargo_type)) return CT_INVALID; // We cannot refit to mixed cargoes in an automated way
00173 
00174   if (cargo_type == CT_INVALID) {
00175     if (v->type != VEH_TRAIN) return CT_NO_REFIT; // If the vehicle does not carry anything at all, every replacement is fine.
00176 
00177     if (!part_of_chain) return CT_NO_REFIT;
00178 
00179     /* the old engine didn't have cargo capacity, but the new one does
00180      * now we will figure out what cargo the train is carrying and refit to fit this */
00181 
00182     for (v = v->First(); v != NULL; v = v->Next()) {
00183       if (v->cargo_cap == 0) continue;
00184       /* Now we found a cargo type being carried on the train and we will see if it is possible to carry to this one */
00185       if (HasBit(available_cargo_types, v->cargo_type)) return v->cargo_type;
00186     }
00187 
00188     return CT_NO_REFIT; // We failed to find a cargo type on the old vehicle and we will not refit the new one
00189   } else {
00190     if (!HasBit(available_cargo_types, cargo_type)) return CT_INVALID; // We can't refit the vehicle to carry the cargo we want
00191 
00192     if (part_of_chain && !VerifyAutoreplaceRefitForOrders(v, engine_type)) return CT_INVALID; // Some refit orders lose their effect
00193 
00194     return cargo_type;
00195   }
00196 }
00197 
00205 static CommandCost GetNewEngineType(const Vehicle *v, const Company *c, EngineID &e)
00206 {
00207   assert(v->type != VEH_TRAIN || !v->IsArticulatedPart());
00208 
00209   e = INVALID_ENGINE;
00210 
00211   if (v->type == VEH_TRAIN && Train::From(v)->IsRearDualheaded()) {
00212     /* we build the rear ends of multiheaded trains with the front ones */
00213     return CommandCost();
00214   }
00215 
00216   e = EngineReplacementForCompany(c, v->engine_type, v->group_id);
00217 
00218   /* Autoreplace, if engine is available */
00219   if (e != INVALID_ENGINE && IsEngineBuildable(e, v->type, _current_company)) {
00220     return CommandCost();
00221   }
00222 
00223   /* Autorenew if needed */
00224   if (v->NeedsAutorenewing(c)) e = v->engine_type;
00225 
00226   /* Nothing to do or all is fine? */
00227   if (e == INVALID_ENGINE || IsEngineBuildable(e, v->type, _current_company)) return CommandCost();
00228 
00229   /* The engine we need is not available. Report error to user */
00230   return CommandCost(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE + v->type);
00231 }
00232 
00241 static CommandCost BuildReplacementVehicle(Vehicle *old_veh, Vehicle **new_vehicle, bool part_of_chain)
00242 {
00243   *new_vehicle = NULL;
00244 
00245   /* Shall the vehicle be replaced? */
00246   const Company *c = Company::Get(_current_company);
00247   EngineID e;
00248   CommandCost cost = GetNewEngineType(old_veh, c, e);
00249   if (cost.Failed()) return cost;
00250   if (e == INVALID_ENGINE) return CommandCost(); // neither autoreplace is set, nor autorenew is triggered
00251 
00252   /* Does it need to be refitted */
00253   CargoID refit_cargo = GetNewCargoTypeForReplace(old_veh, e, part_of_chain);
00254   if (refit_cargo == CT_INVALID) return CommandCost(); // incompatible cargoes
00255 
00256   /* Build the new vehicle */
00257   cost = DoCommand(old_veh->tile, e, 0, DC_EXEC | DC_AUTOREPLACE, GetCmdBuildVeh(old_veh));
00258   if (cost.Failed()) return cost;
00259 
00260   Vehicle *new_veh = Vehicle::Get(_new_vehicle_id);
00261   *new_vehicle = new_veh;
00262 
00263   /* Refit the vehicle if needed */
00264   if (refit_cargo != CT_NO_REFIT) {
00265     byte subtype = GetBestFittingSubType(old_veh, new_veh, refit_cargo);
00266 
00267     cost.AddCost(DoCommand(0, new_veh->index, refit_cargo | (subtype << 8), DC_EXEC, GetCmdRefitVeh(new_veh)));
00268     assert(cost.Succeeded()); // This should be ensured by GetNewCargoTypeForReplace()
00269   }
00270 
00271   /* Try to reverse the vehicle, but do not care if it fails as the new type might not be reversible */
00272   if (new_veh->type == VEH_TRAIN && HasBit(Train::From(old_veh)->flags, VRF_REVERSE_DIRECTION)) {
00273     DoCommand(0, new_veh->index, true, DC_EXEC, CMD_REVERSE_TRAIN_DIRECTION);
00274   }
00275 
00276   return cost;
00277 }
00278 
00285 static inline CommandCost CmdStartStopVehicle(const Vehicle *v, bool evaluate_callback)
00286 {
00287   return DoCommand(0, v->index, evaluate_callback ? 1 : 0, DC_EXEC | DC_AUTOREPLACE, CMD_START_STOP_VEHICLE);
00288 }
00289 
00298 static inline CommandCost CmdMoveVehicle(const Vehicle *v, const Vehicle *after, DoCommandFlag flags, bool whole_chain)
00299 {
00300   return DoCommand(0, v->index | (whole_chain ? 1 : 0) << 20, after != NULL ? after->index : INVALID_VEHICLE, flags, CMD_MOVE_RAIL_VEHICLE);
00301 }
00302 
00309 static CommandCost CopyHeadSpecificThings(Vehicle *old_head, Vehicle *new_head, DoCommandFlag flags)
00310 {
00311   CommandCost cost = CommandCost();
00312 
00313   /* Share orders */
00314   if (cost.Succeeded() && old_head != new_head) cost.AddCost(DoCommand(0, new_head->index | CO_SHARE << 30, old_head->index, DC_EXEC, CMD_CLONE_ORDER));
00315 
00316   /* Copy group membership */
00317   if (cost.Succeeded() && old_head != new_head) cost.AddCost(DoCommand(0, old_head->group_id, new_head->index, DC_EXEC, CMD_ADD_VEHICLE_GROUP));
00318 
00319   /* Perform start/stop check whether the new vehicle suits newgrf restrictions etc. */
00320   if (cost.Succeeded()) {
00321     /* Start the vehicle, might be denied by certain things */
00322     assert((new_head->vehstatus & VS_STOPPED) != 0);
00323     cost.AddCost(CmdStartStopVehicle(new_head, true));
00324 
00325     /* Stop the vehicle again, but do not care about evil newgrfs allowing starting but not stopping :p */
00326     if (cost.Succeeded()) cost.AddCost(CmdStartStopVehicle(new_head, false));
00327   }
00328 
00329   /* Last do those things which do never fail (resp. we do not care about), but which are not undo-able */
00330   if (cost.Succeeded() && old_head != new_head && (flags & DC_EXEC) != 0) {
00331     /* Copy vehicle name */
00332     if (old_head->name != NULL) {
00333       DoCommand(0, new_head->index, 0, DC_EXEC | DC_AUTOREPLACE, CMD_RENAME_VEHICLE, old_head->name);
00334     }
00335 
00336     /* Copy other things which cannot be copied by a command and which shall not stay resetted from the build vehicle command */
00337     new_head->CopyVehicleConfigAndStatistics(old_head);
00338 
00339     /* Switch vehicle windows/news to the new vehicle, so they are not closed/deleted when the old vehicle is sold */
00340     ChangeVehicleViewports(old_head->index, new_head->index);
00341     ChangeVehicleViewWindow(old_head->index, new_head->index);
00342     ChangeVehicleNews(old_head->index, new_head->index);
00343   }
00344 
00345   return cost;
00346 }
00347 
00355 static CommandCost ReplaceFreeUnit(Vehicle **single_unit, DoCommandFlag flags, bool *nothing_to_do)
00356 {
00357   Train *old_v = Train::From(*single_unit);
00358   assert(!old_v->IsArticulatedPart() && !old_v->IsRearDualheaded());
00359 
00360   CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES, 0);
00361 
00362   /* Build and refit replacement vehicle */
00363   Vehicle *new_v = NULL;
00364   cost.AddCost(BuildReplacementVehicle(old_v, &new_v, false));
00365 
00366   /* Was a new vehicle constructed? */
00367   if (cost.Succeeded() && new_v != NULL) {
00368     *nothing_to_do = false;
00369 
00370     if ((flags & DC_EXEC) != 0) {
00371       /* Move the new vehicle behind the old */
00372       CmdMoveVehicle(new_v, old_v, DC_EXEC, false);
00373 
00374       /* Take over cargo
00375        * Note: We do only transfer cargo from the old to the new vehicle.
00376        *       I.e. we do not transfer remaining cargo to other vehicles.
00377        *       Else you would also need to consider moving cargo to other free chains,
00378        *       or doing the same in ReplaceChain(), which would be quite troublesome.
00379        */
00380       TransferCargo(old_v, new_v, false);
00381 
00382       *single_unit = new_v;
00383     }
00384 
00385     /* Sell the old vehicle */
00386     cost.AddCost(DoCommand(0, old_v->index, 0, flags, GetCmdSellVeh(old_v)));
00387 
00388     /* If we are not in DC_EXEC undo everything */
00389     if ((flags & DC_EXEC) == 0) {
00390       DoCommand(0, new_v->index, 0, DC_EXEC, GetCmdSellVeh(new_v));
00391     }
00392   }
00393 
00394   return cost;
00395 }
00396 
00405 static CommandCost ReplaceChain(Vehicle **chain, DoCommandFlag flags, bool wagon_removal, bool *nothing_to_do)
00406 {
00407   Vehicle *old_head = *chain;
00408   assert(old_head->IsPrimaryVehicle());
00409 
00410   CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES, 0);
00411 
00412   if (old_head->type == VEH_TRAIN) {
00413     /* Store the length of the old vehicle chain, rounded up to whole tiles */
00414     uint16 old_total_length = CeilDiv(Train::From(old_head)->gcache.cached_total_length, TILE_SIZE) * TILE_SIZE;
00415 
00416     int num_units = 0; 
00417     for (Train *w = Train::From(old_head); w != NULL; w = w->GetNextUnit()) num_units++;
00418 
00419     Train **old_vehs = CallocT<Train *>(num_units); 
00420     Train **new_vehs = CallocT<Train *>(num_units); 
00421     Money *new_costs = MallocT<Money>(num_units);   
00422 
00423     /* Collect vehicles and build replacements
00424      * Note: The replacement vehicles can only successfully build as long as the old vehicles are still in their chain */
00425     int i;
00426     Train *w;
00427     for (w = Train::From(old_head), i = 0; w != NULL; w = w->GetNextUnit(), i++) {
00428       assert(i < num_units);
00429       old_vehs[i] = w;
00430 
00431       CommandCost ret = BuildReplacementVehicle(old_vehs[i], (Vehicle**)&new_vehs[i], true);
00432       cost.AddCost(ret);
00433       if (cost.Failed()) break;
00434 
00435       new_costs[i] = ret.GetCost();
00436       if (new_vehs[i] != NULL) *nothing_to_do = false;
00437     }
00438     Train *new_head = (new_vehs[0] != NULL ? new_vehs[0] : old_vehs[0]);
00439 
00440     /* Note: When autoreplace has already failed here, old_vehs[] is not completely initialized. But it is also not needed. */
00441     if (cost.Succeeded()) {
00442       /* Separate the head, so we can start constructing the new chain */
00443       Train *second = Train::From(old_head)->GetNextUnit();
00444       if (second != NULL) cost.AddCost(CmdMoveVehicle(second, NULL, DC_EXEC | DC_AUTOREPLACE, true));
00445 
00446       assert(Train::From(new_head)->GetNextUnit() == NULL);
00447 
00448       /* Append engines to the new chain
00449        * We do this from back to front, so that the head of the temporary vehicle chain does not change all the time.
00450        * That way we also have less trouble when exceeding the unitnumber limit.
00451        * OTOH the vehicle attach callback is more expensive this way :s */
00452       Train *last_engine = NULL; 
00453       if (cost.Succeeded()) {
00454         for (int i = num_units - 1; i > 0; i--) {
00455           Train *append = (new_vehs[i] != NULL ? new_vehs[i] : old_vehs[i]);
00456 
00457           if (RailVehInfo(append->engine_type)->railveh_type == RAILVEH_WAGON) continue;
00458 
00459           if (new_vehs[i] != NULL) {
00460             /* Move the old engine to a separate row with DC_AUTOREPLACE. Else
00461              * moving the wagon in front may fail later due to unitnumber limit.
00462              * (We have to attach wagons without DC_AUTOREPLACE.) */
00463             CmdMoveVehicle(old_vehs[i], NULL, DC_EXEC | DC_AUTOREPLACE, false);
00464           }
00465 
00466           if (last_engine == NULL) last_engine = append;
00467           cost.AddCost(CmdMoveVehicle(append, new_head, DC_EXEC, false));
00468           if (cost.Failed()) break;
00469         }
00470         if (last_engine == NULL) last_engine = new_head;
00471       }
00472 
00473       /* When wagon removal is enabled and the new engines without any wagons are already longer than the old, we have to fail */
00474       if (cost.Succeeded() && wagon_removal && new_head->gcache.cached_total_length > old_total_length) cost = CommandCost(STR_ERROR_TRAIN_TOO_LONG_AFTER_REPLACEMENT);
00475 
00476       /* Append/insert wagons into the new vehicle chain
00477        * We do this from back to front, so we can stop when wagon removal or maximum train length (i.e. from mammoth-train setting) is triggered.
00478        */
00479       if (cost.Succeeded()) {
00480         for (int i = num_units - 1; i > 0; i--) {
00481           assert(last_engine != NULL);
00482           Vehicle *append = (new_vehs[i] != NULL ? new_vehs[i] : old_vehs[i]);
00483 
00484           if (RailVehInfo(append->engine_type)->railveh_type == RAILVEH_WAGON) {
00485             /* Insert wagon after 'last_engine' */
00486             CommandCost res = CmdMoveVehicle(append, last_engine, DC_EXEC, false);
00487 
00488             /* When we allow removal of wagons, either the move failing due
00489              * to the train becoming too long, or the train becoming longer
00490              * would move the vehicle to the empty vehicle chain. */
00491             if (wagon_removal && (res.Failed() ? res.GetErrorMessage() == STR_ERROR_TRAIN_TOO_LONG : new_head->gcache.cached_total_length > old_total_length)) {
00492               CmdMoveVehicle(append, NULL, DC_EXEC | DC_AUTOREPLACE, false);
00493               break;
00494             }
00495 
00496             cost.AddCost(res);
00497             if (cost.Failed()) break;
00498           } else {
00499             /* We have reached 'last_engine', continue with the next engine towards the front */
00500             assert(append == last_engine);
00501             last_engine = last_engine->GetPrevUnit();
00502           }
00503         }
00504       }
00505 
00506       /* Sell superfluous new vehicles that could not be inserted. */
00507       if (cost.Succeeded() && wagon_removal) {
00508         assert(new_head->gcache.cached_total_length <= _settings_game.vehicle.max_train_length * TILE_SIZE);
00509         for (int i = 1; i < num_units; i++) {
00510           Vehicle *wagon = new_vehs[i];
00511           if (wagon == NULL) continue;
00512           if (wagon->First() == new_head) break;
00513 
00514           assert(RailVehInfo(wagon->engine_type)->railveh_type == RAILVEH_WAGON);
00515 
00516           /* Sell wagon */
00517           CommandCost ret = DoCommand(0, wagon->index, 0, DC_EXEC, GetCmdSellVeh(wagon));
00518           assert(ret.Succeeded());
00519           new_vehs[i] = NULL;
00520 
00521           /* Revert the money subtraction when the vehicle was built.
00522            * This value is different from the sell value, esp. because of refitting */
00523           cost.AddCost(-new_costs[i]);
00524         }
00525       }
00526 
00527       /* The new vehicle chain is constructed, now take over orders and everything... */
00528       if (cost.Succeeded()) cost.AddCost(CopyHeadSpecificThings(old_head, new_head, flags));
00529 
00530       if (cost.Succeeded()) {
00531         /* Success ! */
00532         if ((flags & DC_EXEC) != 0 && new_head != old_head) {
00533           *chain = new_head;
00534         }
00535 
00536         /* Transfer cargo of old vehicles and sell them */
00537         for (int i = 0; i < num_units; i++) {
00538           Vehicle *w = old_vehs[i];
00539           /* Is the vehicle again part of the new chain?
00540            * Note: We cannot test 'new_vehs[i] != NULL' as wagon removal might cause to remove both */
00541           if (w->First() == new_head) continue;
00542 
00543           if ((flags & DC_EXEC) != 0) TransferCargo(w, new_head, true);
00544 
00545           /* Sell the vehicle.
00546            * Note: This might temporarly construct new trains, so use DC_AUTOREPLACE to prevent
00547            *       it from failing due to engine limits. */
00548           cost.AddCost(DoCommand(0, w->index, 0, flags | DC_AUTOREPLACE, GetCmdSellVeh(w)));
00549           if ((flags & DC_EXEC) != 0) {
00550             old_vehs[i] = NULL;
00551             if (i == 0) old_head = NULL;
00552           }
00553         }
00554       }
00555 
00556       /* If we are not in DC_EXEC undo everything, i.e. rearrange old vehicles.
00557        * We do this from back to front, so that the head of the temporary vehicle chain does not change all the time.
00558        * Note: The vehicle attach callback is disabled here :) */
00559       if ((flags & DC_EXEC) == 0) {
00560         /* Separate the head, so we can reattach the old vehicles */
00561         Train *second = Train::From(old_head)->GetNextUnit();
00562         if (second != NULL) CmdMoveVehicle(second, NULL, DC_EXEC | DC_AUTOREPLACE, true);
00563 
00564         assert(Train::From(old_head)->GetNextUnit() == NULL);
00565 
00566         for (int i = num_units - 1; i > 0; i--) {
00567           CommandCost ret = CmdMoveVehicle(old_vehs[i], old_head, DC_EXEC | DC_AUTOREPLACE, false);
00568           assert(ret.Succeeded());
00569         }
00570       }
00571     }
00572 
00573     /* Finally undo buying of new vehicles */
00574     if ((flags & DC_EXEC) == 0) {
00575       for (int i = num_units - 1; i >= 0; i--) {
00576         if (new_vehs[i] != NULL) {
00577           DoCommand(0, new_vehs[i]->index, 0, DC_EXEC, GetCmdSellVeh(new_vehs[i]));
00578           new_vehs[i] = NULL;
00579         }
00580       }
00581     }
00582 
00583     free(old_vehs);
00584     free(new_vehs);
00585     free(new_costs);
00586   } else {
00587     /* Build and refit replacement vehicle */
00588     Vehicle *new_head = NULL;
00589     cost.AddCost(BuildReplacementVehicle(old_head, &new_head, true));
00590 
00591     /* Was a new vehicle constructed? */
00592     if (cost.Succeeded() && new_head != NULL) {
00593       *nothing_to_do = false;
00594 
00595       /* The new vehicle is constructed, now take over orders and everything... */
00596       cost.AddCost(CopyHeadSpecificThings(old_head, new_head, flags));
00597 
00598       if (cost.Succeeded()) {
00599         /* The new vehicle is constructed, now take over cargo */
00600         if ((flags & DC_EXEC) != 0) {
00601           TransferCargo(old_head, new_head, true);
00602           *chain = new_head;
00603         }
00604 
00605         /* Sell the old vehicle */
00606         cost.AddCost(DoCommand(0, old_head->index, 0, flags, GetCmdSellVeh(old_head)));
00607       }
00608 
00609       /* If we are not in DC_EXEC undo everything */
00610       if ((flags & DC_EXEC) == 0) {
00611         DoCommand(0, new_head->index, 0, DC_EXEC, GetCmdSellVeh(new_head));
00612       }
00613     }
00614   }
00615 
00616   return cost;
00617 }
00618 
00629 CommandCost CmdAutoreplaceVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00630 {
00631   Vehicle *v = Vehicle::GetIfValid(p1);
00632   if (v == NULL) return CMD_ERROR;
00633 
00634   CommandCost ret = CheckOwnership(v->owner);
00635   if (ret.Failed()) return ret;
00636 
00637   if (!v->IsInDepot()) return CMD_ERROR;
00638   if (v->vehstatus & VS_CRASHED) return CMD_ERROR;
00639 
00640   bool free_wagon = false;
00641   if (v->type == VEH_TRAIN) {
00642     Train *t = Train::From(v);
00643     if (t->IsArticulatedPart() || t->IsRearDualheaded()) return CMD_ERROR;
00644     free_wagon = !t->IsFrontEngine();
00645     if (free_wagon && t->First()->IsFrontEngine()) return CMD_ERROR;
00646   } else {
00647     if (!v->IsPrimaryVehicle()) return CMD_ERROR;
00648   }
00649 
00650   const Company *c = Company::Get(_current_company);
00651   bool wagon_removal = c->settings.renew_keep_length;
00652 
00653   /* Test whether any replacement is set, before issuing a whole lot of commands that would end in nothing changed */
00654   Vehicle *w = v;
00655   bool any_replacements = false;
00656   while (w != NULL) {
00657     EngineID e;
00658     CommandCost cost = GetNewEngineType(w, c, e);
00659     if (cost.Failed()) return cost;
00660     any_replacements |= (e != INVALID_ENGINE);
00661     w = (!free_wagon && w->type == VEH_TRAIN ? Train::From(w)->GetNextUnit() : NULL);
00662   }
00663 
00664   CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES, 0);
00665   bool nothing_to_do = true;
00666 
00667   if (any_replacements) {
00668     bool was_stopped = free_wagon || ((v->vehstatus & VS_STOPPED) != 0);
00669 
00670     /* Stop the vehicle */
00671     if (!was_stopped) cost.AddCost(CmdStartStopVehicle(v, true));
00672     if (cost.Failed()) return cost;
00673 
00674     assert(v->IsStoppedInDepot());
00675 
00676     /* We have to construct the new vehicle chain to test whether it is valid.
00677      * Vehicle construction needs random bits, so we have to save the random seeds
00678      * to prevent desyncs and to replay newgrf callbacks during DC_EXEC */
00679     SavedRandomSeeds saved_seeds;
00680     SaveRandomSeeds(&saved_seeds);
00681     if (free_wagon) {
00682       cost.AddCost(ReplaceFreeUnit(&v, flags & ~DC_EXEC, &nothing_to_do));
00683     } else {
00684       cost.AddCost(ReplaceChain(&v, flags & ~DC_EXEC, wagon_removal, &nothing_to_do));
00685     }
00686     RestoreRandomSeeds(saved_seeds);
00687 
00688     if (cost.Succeeded() && (flags & DC_EXEC) != 0) {
00689       CommandCost ret;
00690       if (free_wagon) {
00691         ret = ReplaceFreeUnit(&v, flags, &nothing_to_do);
00692       } else {
00693         ret = ReplaceChain(&v, flags, wagon_removal, &nothing_to_do);
00694       }
00695       assert(ret.Succeeded() && ret.GetCost() == cost.GetCost());
00696     }
00697 
00698     /* Restart the vehicle */
00699     if (!was_stopped) cost.AddCost(CmdStartStopVehicle(v, false));
00700   }
00701 
00702   if (cost.Succeeded() && nothing_to_do) cost = CommandCost(STR_ERROR_AUTOREPLACE_NOTHING_TO_DO);
00703   return cost;
00704 }
00705 
00718 CommandCost CmdSetAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00719 {
00720   Company *c = Company::GetIfValid(_current_company);
00721   if (c == NULL) return CMD_ERROR;
00722 
00723   EngineID old_engine_type = GB(p2, 0, 16);
00724   EngineID new_engine_type = GB(p2, 16, 16);
00725   GroupID id_g = GB(p1, 16, 16);
00726   CommandCost cost;
00727 
00728   if (Group::IsValidID(id_g) ? Group::Get(id_g)->owner != _current_company : !IsAllGroupID(id_g) && !IsDefaultGroupID(id_g)) return CMD_ERROR;
00729   if (!Engine::IsValidID(old_engine_type)) return CMD_ERROR;
00730 
00731   if (new_engine_type != INVALID_ENGINE) {
00732     if (!Engine::IsValidID(new_engine_type)) return CMD_ERROR;
00733     if (!CheckAutoreplaceValidity(old_engine_type, new_engine_type, _current_company)) return CMD_ERROR;
00734 
00735     cost = AddEngineReplacementForCompany(c, old_engine_type, new_engine_type, id_g, flags);
00736   } else {
00737     cost = RemoveEngineReplacementForCompany(c, old_engine_type, id_g, flags);
00738   }
00739 
00740   if (flags & DC_EXEC) GroupStatistics::UpdateAutoreplace(_current_company);
00741   if ((flags & DC_EXEC) && IsLocalCompany()) InvalidateAutoreplaceWindow(old_engine_type, id_g);
00742 
00743   return cost;
00744 }
00745