vehicle_cmd.cpp

Go to the documentation of this file.
00001 /* $Id: vehicle_cmd.cpp 23581 2011-12-17 21:22:10Z frosch $ */
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 "roadveh.h"
00014 #include "news_func.h"
00015 #include "airport.h"
00016 #include "cmd_helper.h"
00017 #include "command_func.h"
00018 #include "company_func.h"
00019 #include "vehicle_gui.h"
00020 #include "train.h"
00021 #include "aircraft.h"
00022 #include "newgrf_text.h"
00023 #include "window_func.h"
00024 #include "vehicle_func.h"
00025 #include "string_func.h"
00026 #include "depot_map.h"
00027 #include "vehiclelist.h"
00028 #include "engine_func.h"
00029 #include "articulated_vehicles.h"
00030 #include "autoreplace_gui.h"
00031 #include "company_base.h"
00032 #include "order_backup.h"
00033 #include "ship.h"
00034 #include "newgrf.h"
00035 
00036 #include "table/strings.h"
00037 
00038 /* Tables used in vehicle.h to find the right command for a certain vehicle type */
00039 const uint32 _veh_build_proc_table[] = {
00040   CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN),
00041   CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_ROAD_VEHICLE),
00042   CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_SHIP),
00043   CMD_BUILD_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_AIRCRAFT),
00044 };
00045 
00046 const uint32 _veh_sell_proc_table[] = {
00047   CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_TRAIN),
00048   CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_ROAD_VEHICLE),
00049   CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_SHIP),
00050   CMD_SELL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_SELL_AIRCRAFT),
00051 };
00052 
00053 const uint32 _veh_refit_proc_table[] = {
00054   CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_TRAIN),
00055   CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_ROAD_VEHICLE),
00056   CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_SHIP),
00057   CMD_REFIT_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_REFIT_AIRCRAFT),
00058 };
00059 
00060 const uint32 _send_to_depot_proc_table[] = {
00061   /* TrainGotoDepot has a nice randomizer in the pathfinder, which causes desyncs... */
00062   CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_TRAIN_TO_DEPOT) | CMD_NO_TEST_IF_IN_NETWORK,
00063   CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_ROAD_VEHICLE_TO_DEPOT),
00064   CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_SHIP_TO_DEPOT),
00065   CMD_SEND_VEHICLE_TO_DEPOT | CMD_MSG(STR_ERROR_CAN_T_SEND_AIRCRAFT_TO_HANGAR),
00066 };
00067 
00068 
00069 CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
00070 CommandCost CmdBuildRoadVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
00071 CommandCost CmdBuildShip       (TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
00072 CommandCost CmdBuildAircraft   (TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **v);
00073 
00085 CommandCost CmdBuildVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00086 {
00087   /* Elementary check for valid location. */
00088   if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
00089 
00090   VehicleType type;
00091   switch (GetTileType(tile)) {
00092     case MP_RAILWAY: type = VEH_TRAIN;    break;
00093     case MP_ROAD:    type = VEH_ROAD;     break;
00094     case MP_WATER:   type = VEH_SHIP;     break;
00095     case MP_STATION: type = VEH_AIRCRAFT; break;
00096     default: NOT_REACHED(); // Safe due to IsDepotTile()
00097   }
00098 
00099   /* Validate the engine type. */
00100   EngineID eid = GB(p1, 0, 16);
00101   if (!IsEngineBuildable(eid, type, _current_company)) return_cmd_error(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE + type);
00102 
00103   const Engine *e = Engine::Get(eid);
00104   CommandCost value(EXPENSES_NEW_VEHICLES, e->GetCost());
00105 
00106   /* Engines without valid cargo should not be available */
00107   if (e->GetDefaultCargoType() == CT_INVALID) return CMD_ERROR;
00108 
00109   /* Check whether the number of vehicles we need to build can be built according to pool space. */
00110   uint num_vehicles;
00111   switch (type) {
00112     case VEH_TRAIN:    num_vehicles = (e->u.rail.railveh_type == RAILVEH_MULTIHEAD ? 2 : 1) + CountArticulatedParts(eid, false); break;
00113     case VEH_ROAD:     num_vehicles = 1 + CountArticulatedParts(eid, false); break;
00114     case VEH_SHIP:     num_vehicles = 1; break;
00115     case VEH_AIRCRAFT: num_vehicles = e->u.air.subtype & AIR_CTOL ? 2 : 3; break;
00116     default: NOT_REACHED(); // Safe due to IsDepotTile()
00117   }
00118   if (!Vehicle::CanAllocateItem(num_vehicles)) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
00119 
00120   /* Check whether we can allocate a unit number. Autoreplace does not allocate
00121    * an unit number as it will (always) reuse the one of the replaced vehicle
00122    * and (train) wagons don't have an unit number in any scenario. */
00123   UnitID unit_num = (flags & DC_AUTOREPLACE || (type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON)) ? 0 : GetFreeUnitNumber(type);
00124   if (unit_num == UINT16_MAX) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
00125 
00126   Vehicle *v;
00127   switch (type) {
00128     case VEH_TRAIN:    value.AddCost(CmdBuildRailVehicle(tile, flags, e, GB(p1, 16, 16), &v)); break;
00129     case VEH_ROAD:     value.AddCost(CmdBuildRoadVehicle(tile, flags, e, GB(p1, 16, 16), &v)); break;
00130     case VEH_SHIP:     value.AddCost(CmdBuildShip       (tile, flags, e, GB(p1, 16, 16), &v)); break;
00131     case VEH_AIRCRAFT: value.AddCost(CmdBuildAircraft   (tile, flags, e, GB(p1, 16, 16), &v)); break;
00132     default: NOT_REACHED(); // Safe due to IsDepotTile()
00133   }
00134 
00135   if (value.Succeeded() && flags & DC_EXEC) {
00136     v->unitnumber = unit_num;
00137     v->value      = value.GetCost();
00138 
00139     InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
00140     InvalidateWindowClassesData(GetWindowClassForVehicleType(type), 0);
00141     SetWindowDirty(WC_COMPANY, _current_company);
00142     if (IsLocalCompany()) {
00143       InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the auto replace window (must be called before incrementing num_engines)
00144     }
00145 
00146     GroupStatistics::CountEngine(v, 1);
00147     GroupStatistics::UpdateAutoreplace(_current_company);
00148 
00149     if (v->IsPrimaryVehicle()) {
00150       GroupStatistics::CountVehicle(v, 1);
00151       OrderBackup::Restore(v, p2);
00152     }
00153   }
00154 
00155   return value;
00156 }
00157 
00158 CommandCost CmdSellRailWagon(DoCommandFlag flags, Vehicle *v, uint16 data, uint32 user);
00159 
00172 CommandCost CmdSellVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00173 {
00174   Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
00175   if (v == NULL) return CMD_ERROR;
00176 
00177   Vehicle *front = v->First();
00178 
00179   CommandCost ret = CheckOwnership(front->owner);
00180   if (ret.Failed()) return ret;
00181 
00182   if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
00183 
00184   if (!front->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
00185 
00186   /* Can we actually make the order backup, i.e. are there enough orders? */
00187   if (p1 & MAKE_ORDER_BACKUP_FLAG &&
00188       front->orders.list != NULL &&
00189       !front->orders.list->IsShared() &&
00190       !Order::CanAllocateItem(front->orders.list->GetNumOrders())) {
00191     /* Only happens in exceptional cases when there aren't enough orders anyhow.
00192      * Thus it should be safe to just drop the orders in that case. */
00193     p1 &= ~MAKE_ORDER_BACKUP_FLAG;
00194   }
00195 
00196   if (v->type == VEH_TRAIN) {
00197     ret = CmdSellRailWagon(flags, v, GB(p1, 20, 12), p2);
00198   } else {
00199     ret = CommandCost(EXPENSES_NEW_VEHICLES, -front->value);
00200 
00201     if (flags & DC_EXEC) {
00202       if (v->IsPrimaryVehicle() && p1 & MAKE_ORDER_BACKUP_FLAG) OrderBackup::Backup(v, p2);
00203       delete front;
00204     }
00205   }
00206 
00207   return ret;
00208 }
00209 
00219 static int GetRefitCostFactor(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
00220 {
00221   /* Prepare callback param with info about the new cargo type. */
00222   const Engine *e = Engine::Get(engine_type);
00223 
00224   /* Is this vehicle a NewGRF vehicle? */
00225   if (e->GetGRF() != NULL) {
00226     const CargoSpec *cs = CargoSpec::Get(new_cid);
00227     uint32 param1 = (cs->classes << 16) | (new_subtype << 8) | e->GetGRF()->cargo_map[new_cid];
00228 
00229     uint16 cb_res = GetVehicleCallback(CBID_VEHICLE_REFIT_COST, param1, 0, engine_type, v);
00230     if (cb_res != CALLBACK_FAILED) {
00231       *auto_refit_allowed = HasBit(cb_res, 14);
00232       int factor = GB(cb_res, 0, 14);
00233       if (factor >= 0x2000) factor -= 0x4000; // Treat as signed integer.
00234       return factor;
00235     }
00236   }
00237 
00238   *auto_refit_allowed = e->info.refit_cost == 0;
00239   return (v == NULL || v->cargo_type != new_cid) ? e->info.refit_cost : 0;
00240 }
00241 
00251 static CommandCost GetRefitCost(const Vehicle *v, EngineID engine_type, CargoID new_cid, byte new_subtype, bool *auto_refit_allowed)
00252 {
00253   ExpensesType expense_type;
00254   const Engine *e = Engine::Get(engine_type);
00255   Price base_price;
00256   int cost_factor = GetRefitCostFactor(v, engine_type, new_cid, new_subtype, auto_refit_allowed);
00257   switch (e->type) {
00258     case VEH_SHIP:
00259       base_price = PR_BUILD_VEHICLE_SHIP;
00260       expense_type = EXPENSES_SHIP_RUN;
00261       break;
00262 
00263     case VEH_ROAD:
00264       base_price = PR_BUILD_VEHICLE_ROAD;
00265       expense_type = EXPENSES_ROADVEH_RUN;
00266       break;
00267 
00268     case VEH_AIRCRAFT:
00269       base_price = PR_BUILD_VEHICLE_AIRCRAFT;
00270       expense_type = EXPENSES_AIRCRAFT_RUN;
00271       break;
00272 
00273     case VEH_TRAIN:
00274       base_price = (e->u.rail.railveh_type == RAILVEH_WAGON) ? PR_BUILD_VEHICLE_WAGON : PR_BUILD_VEHICLE_TRAIN;
00275       cost_factor <<= 1;
00276       expense_type = EXPENSES_TRAIN_RUN;
00277       break;
00278 
00279     default: NOT_REACHED();
00280   }
00281   if (cost_factor < 0) {
00282     return CommandCost(expense_type, -GetPrice(base_price, -cost_factor, e->GetGRF(), -10));
00283   } else {
00284     return CommandCost(expense_type, GetPrice(base_price, cost_factor, e->GetGRF(), -10));
00285   }
00286 }
00287 
00300 static CommandCost RefitVehicle(Vehicle *v, bool only_this, uint8 num_vehicles, CargoID new_cid, byte new_subtype, DoCommandFlag flags, bool auto_refit)
00301 {
00302   CommandCost cost(v->GetExpenseType(false));
00303   uint total_capacity = 0;
00304   uint total_mail_capacity = 0;
00305   num_vehicles = num_vehicles == 0 ? UINT8_MAX : num_vehicles;
00306 
00307   VehicleSet vehicles_to_refit;
00308   if (!only_this) {
00309     GetVehicleSet(vehicles_to_refit, v, num_vehicles);
00310     /* In this case, we need to check the whole chain. */
00311     v = v->First();
00312   }
00313 
00314   v->InvalidateNewGRFCacheOfChain();
00315   for (; v != NULL; v = (only_this ? NULL : v->Next())) {
00316     if (v->type == VEH_TRAIN && !vehicles_to_refit.Contains(v->index) && !only_this) continue;
00317 
00318     const Engine *e = v->GetEngine();
00319     if (!e->CanCarryCargo()) continue;
00320 
00321     /* If the vehicle is not refittable, or does not allow automatic refitting,
00322      * count its capacity nevertheless if the cargo matches */
00323     bool refittable = HasBit(e->info.refit_mask, new_cid) && (!auto_refit || HasBit(e->info.misc_flags, EF_AUTO_REFIT));
00324     if (!refittable && v->cargo_type != new_cid) continue;
00325 
00326     /* Back up the vehicle's cargo type */
00327     CargoID temp_cid = v->cargo_type;
00328     byte temp_subtype = v->cargo_subtype;
00329     if (refittable) {
00330       v->cargo_type = new_cid;
00331       v->cargo_subtype = new_subtype;
00332     }
00333 
00334     uint16 mail_capacity = 0;
00335     uint amount = e->DetermineCapacity(v, &mail_capacity);
00336     total_capacity += amount;
00337     /* mail_capacity will always be zero if the vehicle is not an aircraft. */
00338     total_mail_capacity += mail_capacity;
00339 
00340     if (!refittable) continue;
00341 
00342     /* Restore the original cargo type */
00343     v->cargo_type = temp_cid;
00344     v->cargo_subtype = temp_subtype;
00345 
00346     bool auto_refit_allowed;
00347     CommandCost refit_cost = GetRefitCost(v, v->engine_type, new_cid, new_subtype, &auto_refit_allowed);
00348     if (auto_refit && !auto_refit_allowed) {
00349       /* Sorry, auto-refitting not allowed, subtract the cargo amount again from the total. */
00350       total_capacity -= amount;
00351       total_mail_capacity -= mail_capacity;
00352       continue;
00353     }
00354     cost.AddCost(refit_cost);
00355 
00356     if (flags & DC_EXEC) {
00357       v->cargo.Truncate((v->cargo_type == new_cid) ? amount : 0);
00358       v->cargo_type = new_cid;
00359       v->cargo_cap = amount;
00360       v->cargo_subtype = new_subtype;
00361       if (v->type == VEH_AIRCRAFT) {
00362         Vehicle *u = v->Next();
00363         u->cargo_cap = mail_capacity;
00364         u->cargo.Truncate(mail_capacity);
00365       }
00366     }
00367   }
00368 
00369   _returned_refit_capacity = total_capacity;
00370   _returned_mail_refit_capacity = total_mail_capacity;
00371   return cost;
00372 }
00373 
00389 CommandCost CmdRefitVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00390 {
00391   Vehicle *v = Vehicle::GetIfValid(p1);
00392   if (v == NULL) return CMD_ERROR;
00393 
00394   /* Don't allow disasters and sparks and such to be refitted.
00395    * We cannot check for IsPrimaryVehicle as autoreplace also refits in free wagon chains. */
00396   if (!IsCompanyBuildableVehicleType(v->type)) return CMD_ERROR;
00397 
00398   Vehicle *front = v->First();
00399 
00400   CommandCost ret = CheckOwnership(front->owner);
00401   if (ret.Failed()) return ret;
00402 
00403   bool auto_refit = HasBit(p2, 6);
00404 
00405   /* Don't allow shadows and such to be refitted. */
00406   if (v != front && (v->type == VEH_SHIP || v->type == VEH_AIRCRAFT)) return CMD_ERROR;
00407   /* Allow auto-refitting only during loading and normal refitting only in a depot. */
00408   if ((!auto_refit || !front->current_order.IsType(OT_LOADING)) && !front->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
00409   if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
00410 
00411   /* Check cargo */
00412   CargoID new_cid = GB(p2, 0, 5);
00413   byte new_subtype = GB(p2, 8, 8);
00414   if (new_cid >= NUM_CARGO) return CMD_ERROR;
00415 
00416   /* For ships and aircrafts there is always only one. */
00417   bool only_this = HasBit(p2, 7) || front->type == VEH_SHIP || front->type == VEH_AIRCRAFT;
00418   uint8 num_vehicles = GB(p2, 16, 8);
00419 
00420   CommandCost cost = RefitVehicle(v, only_this, num_vehicles, new_cid, new_subtype, flags, auto_refit);
00421 
00422   if (flags & DC_EXEC) {
00423     /* Update the cached variables */
00424     switch (v->type) {
00425       case VEH_TRAIN:
00426         Train::From(front)->ConsistChanged(auto_refit);
00427         break;
00428       case VEH_ROAD:
00429         RoadVehUpdateCache(RoadVehicle::From(front), auto_refit);
00430         if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) RoadVehicle::From(front)->CargoChanged();
00431         break;
00432 
00433       case VEH_SHIP:
00434         v->InvalidateNewGRFCacheOfChain();
00435         v->colourmap = PAL_NONE; // invalidate vehicle colour map
00436         Ship::From(v)->UpdateCache();
00437         break;
00438 
00439       case VEH_AIRCRAFT:
00440         v->InvalidateNewGRFCacheOfChain();
00441         v->colourmap = PAL_NONE; // invalidate vehicle colour map
00442         UpdateAircraftCache(Aircraft::From(v), true);
00443         break;
00444 
00445       default: NOT_REACHED();
00446     }
00447 
00448     InvalidateWindowData(WC_VEHICLE_DETAILS, front->index);
00449     SetWindowDirty(WC_VEHICLE_DEPOT, front->tile);
00450     InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 0);
00451   } else {
00452     /* Always invalidate the cache; querycost might have filled it. */
00453     v->InvalidateNewGRFCacheOfChain();
00454   }
00455 
00456   return cost;
00457 }
00458 
00468 CommandCost CmdStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00469 {
00470   /* Disable the effect of p2 bit 0, when DC_AUTOREPLACE is not set */
00471   if ((flags & DC_AUTOREPLACE) == 0) SetBit(p2, 0);
00472 
00473   Vehicle *v = Vehicle::GetIfValid(p1);
00474   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
00475 
00476   CommandCost ret = CheckOwnership(v->owner);
00477   if (ret.Failed()) return ret;
00478 
00479   if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
00480 
00481   switch (v->type) {
00482     case VEH_TRAIN:
00483       if ((v->vehstatus & VS_STOPPED) && Train::From(v)->gcache.cached_power == 0) return_cmd_error(STR_ERROR_TRAIN_START_NO_POWER);
00484       break;
00485 
00486     case VEH_SHIP:
00487     case VEH_ROAD:
00488       break;
00489 
00490     case VEH_AIRCRAFT: {
00491       Aircraft *a = Aircraft::From(v);
00492       /* cannot stop airplane when in flight, or when taking off / landing */
00493       if (!(v->vehstatus & VS_CRASHED) && a->state >= STARTTAKEOFF && a->state < TERM7) return_cmd_error(STR_ERROR_AIRCRAFT_IS_IN_FLIGHT);
00494       break;
00495     }
00496 
00497     default: return CMD_ERROR;
00498   }
00499 
00500   if (HasBit(p2, 0)) {
00501     /* Check if this vehicle can be started/stopped. Failure means 'allow'. */
00502     uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
00503     StringID error = STR_NULL;
00504     if (callback != CALLBACK_FAILED) {
00505       if (v->GetGRF()->grf_version < 8) {
00506         /* 8 bit result 0xFF means 'allow' */
00507         if (callback < 0x400 && GB(callback, 0, 8) != 0xFF) error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
00508       } else {
00509         if (callback < 0x400) {
00510           error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
00511         } else {
00512           switch (callback) {
00513             case 0x400: // allow
00514               break;
00515 
00516             default: // unknown reason -> disallow
00517               error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
00518               break;
00519           }
00520         }
00521       }
00522     }
00523     if (error != STR_NULL) return_cmd_error(error);
00524   }
00525 
00526   if (flags & DC_EXEC) {
00527     if (v->IsStoppedInDepot() && (flags & DC_AUTOREPLACE) == 0) DeleteVehicleNews(p1, STR_NEWS_TRAIN_IS_WAITING + v->type);
00528 
00529     v->vehstatus ^= VS_STOPPED;
00530     if (v->type != VEH_TRAIN) v->cur_speed = 0; // trains can stop 'slowly'
00531     v->MarkDirty();
00532     SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
00533     SetWindowDirty(WC_VEHICLE_DEPOT, v->tile);
00534     SetWindowClassesDirty(GetWindowClassForVehicleType(v->type));
00535   }
00536   return CommandCost();
00537 }
00538 
00550 CommandCost CmdMassStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00551 {
00552   VehicleList list;
00553   bool do_start = HasBit(p1, 0);
00554   bool vehicle_list_window = HasBit(p1, 1);
00555 
00556   VehicleListIdentifier vli;
00557   if (!vli.Unpack(p2)) return CMD_ERROR;
00558   if (!IsCompanyBuildableVehicleType(vli.vtype)) return CMD_ERROR;
00559 
00560   if (vehicle_list_window) {
00561     if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
00562   } else {
00563     /* Get the list of vehicles in the depot */
00564     BuildDepotVehicleList(vli.vtype, tile, &list, NULL);
00565   }
00566 
00567   for (uint i = 0; i < list.Length(); i++) {
00568     const Vehicle *v = list[i];
00569 
00570     if (!!(v->vehstatus & VS_STOPPED) != do_start) continue;
00571 
00572     if (!vehicle_list_window) {
00573       if (vli.vtype == VEH_TRAIN) {
00574         if (!Train::From(v)->IsInDepot()) continue;
00575       } else {
00576         if (!(v->vehstatus & VS_HIDDEN)) continue;
00577       }
00578     }
00579 
00580     /* Just try and don't care if some vehicle's can't be stopped. */
00581     DoCommand(tile, v->index, 0, flags, CMD_START_STOP_VEHICLE);
00582   }
00583 
00584   return CommandCost();
00585 }
00586 
00596 CommandCost CmdDepotSellAllVehicles(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00597 {
00598   VehicleList list;
00599 
00600   CommandCost cost(EXPENSES_NEW_VEHICLES);
00601   VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
00602 
00603   if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
00604 
00605   uint sell_command = GetCmdSellVeh(vehicle_type);
00606 
00607   /* Get the list of vehicles in the depot */
00608   BuildDepotVehicleList(vehicle_type, tile, &list, &list);
00609 
00610   CommandCost last_error = CMD_ERROR;
00611   bool had_success = false;
00612   for (uint i = 0; i < list.Length(); i++) {
00613     CommandCost ret = DoCommand(tile, list[i]->index | (1 << 20), 0, flags, sell_command);
00614     if (ret.Succeeded()) {
00615       cost.AddCost(ret);
00616       had_success = true;
00617     } else {
00618       last_error = ret;
00619     }
00620   }
00621 
00622   return had_success ? cost : last_error;
00623 }
00624 
00634 CommandCost CmdDepotMassAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00635 {
00636   VehicleList list;
00637   CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES);
00638   VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
00639 
00640   if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
00641   if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
00642 
00643   /* Get the list of vehicles in the depot */
00644   BuildDepotVehicleList(vehicle_type, tile, &list, &list, true);
00645 
00646   for (uint i = 0; i < list.Length(); i++) {
00647     const Vehicle *v = list[i];
00648 
00649     /* Ensure that the vehicle completely in the depot */
00650     if (!v->IsInDepot()) continue;
00651 
00652     CommandCost ret = DoCommand(0, v->index, 0, flags, CMD_AUTOREPLACE_VEHICLE);
00653 
00654     if (ret.Succeeded()) cost.AddCost(ret);
00655   }
00656   return cost;
00657 }
00658 
00664 static bool IsUniqueVehicleName(const char *name)
00665 {
00666   const Vehicle *v;
00667 
00668   FOR_ALL_VEHICLES(v) {
00669     if (v->name != NULL && strcmp(v->name, name) == 0) return false;
00670   }
00671 
00672   return true;
00673 }
00674 
00680 static void CloneVehicleName(const Vehicle *src, Vehicle *dst)
00681 {
00682   char buf[256];
00683 
00684   /* Find the position of the first digit in the last group of digits. */
00685   size_t number_position;
00686   for (number_position = strlen(src->name); number_position > 0; number_position--) {
00687     /* The design of UTF-8 lets this work simply without having to check
00688      * for UTF-8 sequences. */
00689     if (src->name[number_position - 1] < '0' || src->name[number_position - 1] > '9') break;
00690   }
00691 
00692   /* Format buffer and determine starting number. */
00693   int num;
00694   byte padding = 0;
00695   if (number_position == strlen(src->name)) {
00696     /* No digit at the end, so start at number 2. */
00697     strecpy(buf, src->name, lastof(buf));
00698     strecat(buf, " ", lastof(buf));
00699     number_position = strlen(buf);
00700     num = 2;
00701   } else {
00702     /* Found digits, parse them and start at the next number. */
00703     strecpy(buf, src->name, lastof(buf));
00704     buf[number_position] = '\0';
00705     char *endptr;
00706     num = strtol(&src->name[number_position], &endptr, 10) + 1;
00707     padding = endptr - &src->name[number_position];
00708   }
00709 
00710   /* Check if this name is already taken. */
00711   for (int max_iterations = 1000; max_iterations > 0; max_iterations--, num++) {
00712     /* Attach the number to the temporary name. */
00713     seprintf(&buf[number_position], lastof(buf), "%0*d", padding, num);
00714 
00715     /* Check the name is unique. */
00716     if (IsUniqueVehicleName(buf)) {
00717       dst->name = strdup(buf);
00718       break;
00719     }
00720   }
00721 
00722   /* All done. If we didn't find a name, it'll just use its default. */
00723 }
00724 
00734 CommandCost CmdCloneVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00735 {
00736   CommandCost total_cost(EXPENSES_NEW_VEHICLES);
00737 
00738   Vehicle *v = Vehicle::GetIfValid(p1);
00739   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
00740   Vehicle *v_front = v;
00741   Vehicle *w = NULL;
00742   Vehicle *w_front = NULL;
00743   Vehicle *w_rear = NULL;
00744 
00745   /*
00746    * v_front is the front engine in the original vehicle
00747    * v is the car/vehicle of the original vehicle that is currently being copied
00748    * w_front is the front engine of the cloned vehicle
00749    * w is the car/vehicle currently being cloned
00750    * w_rear is the rear end of the cloned train. It's used to add more cars and is only used by trains
00751    */
00752 
00753   CommandCost ret = CheckOwnership(v->owner);
00754   if (ret.Failed()) return ret;
00755 
00756   if (v->type == VEH_TRAIN && (!v->IsFrontEngine() || Train::From(v)->crash_anim_pos >= 4400)) return CMD_ERROR;
00757 
00758   /* check that we can allocate enough vehicles */
00759   if (!(flags & DC_EXEC)) {
00760     int veh_counter = 0;
00761     do {
00762       veh_counter++;
00763     } while ((v = v->Next()) != NULL);
00764 
00765     if (!Vehicle::CanAllocateItem(veh_counter)) {
00766       return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
00767     }
00768   }
00769 
00770   v = v_front;
00771 
00772   do {
00773     if (v->type == VEH_TRAIN && Train::From(v)->IsRearDualheaded()) {
00774       /* we build the rear ends of multiheaded trains with the front ones */
00775       continue;
00776     }
00777 
00778     /* In case we're building a multi headed vehicle and the maximum number of
00779      * vehicles is almost reached (e.g. max trains - 1) not all vehicles would
00780      * be cloned. When the non-primary engines were build they were seen as
00781      * 'new' vehicles whereas they would immediately be joined with a primary
00782      * engine. This caused the vehicle to be not build as 'the limit' had been
00783      * reached, resulting in partially build vehicles and such. */
00784     DoCommandFlag build_flags = flags;
00785     if ((flags & DC_EXEC) && !v->IsPrimaryVehicle()) build_flags |= DC_AUTOREPLACE;
00786 
00787     CommandCost cost = DoCommand(tile, v->engine_type | (1 << 16), 0, build_flags, GetCmdBuildVeh(v));
00788 
00789     if (cost.Failed()) {
00790       /* Can't build a part, then sell the stuff we already made; clear up the mess */
00791       if (w_front != NULL) DoCommand(w_front->tile, w_front->index | (1 << 20), 0, flags, GetCmdSellVeh(w_front));
00792       return cost;
00793     }
00794 
00795     total_cost.AddCost(cost);
00796 
00797     if (flags & DC_EXEC) {
00798       w = Vehicle::Get(_new_vehicle_id);
00799 
00800       if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION)) {
00801         SetBit(Train::From(w)->flags, VRF_REVERSE_DIRECTION);
00802       }
00803 
00804       if (v->type == VEH_TRAIN && !v->IsFrontEngine()) {
00805         /* this s a train car
00806          * add this unit to the end of the train */
00807         CommandCost result = DoCommand(0, w->index | 1 << 20, w_rear->index, flags, CMD_MOVE_RAIL_VEHICLE);
00808         if (result.Failed()) {
00809           /* The train can't be joined to make the same consist as the original.
00810            * Sell what we already made (clean up) and return an error.           */
00811           DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
00812           DoCommand(w_front->tile, w->index       | 1 << 20, 0, flags, GetCmdSellVeh(w));
00813           return result; // return error and the message returned from CMD_MOVE_RAIL_VEHICLE
00814         }
00815       } else {
00816         /* this is a front engine or not a train. */
00817         w_front = w;
00818         w->service_interval = v->service_interval;
00819       }
00820       w_rear = w; // trains needs to know the last car in the train, so they can add more in next loop
00821     }
00822   } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != NULL);
00823 
00824   if ((flags & DC_EXEC) && v_front->type == VEH_TRAIN) {
00825     /* for trains this needs to be the front engine due to the callback function */
00826     _new_vehicle_id = w_front->index;
00827   }
00828 
00829   if (flags & DC_EXEC) {
00830     /* Cloned vehicles belong to the same group */
00831     DoCommand(0, v_front->group_id, w_front->index, flags, CMD_ADD_VEHICLE_GROUP);
00832   }
00833 
00834 
00835   /* Take care of refitting. */
00836   w = w_front;
00837   v = v_front;
00838 
00839   /* Both building and refitting are influenced by newgrf callbacks, which
00840    * makes it impossible to accurately estimate the cloning costs. In
00841    * particular, it is possible for engines of the same type to be built with
00842    * different numbers of articulated parts, so when refitting we have to
00843    * loop over real vehicles first, and then the articulated parts of those
00844    * vehicles in a different loop. */
00845   do {
00846     do {
00847       if (flags & DC_EXEC) {
00848         assert(w != NULL);
00849 
00850         /* Find out what's the best sub type */
00851         byte subtype = GetBestFittingSubType(v, w, v->cargo_type);
00852         if (w->cargo_type != v->cargo_type || w->cargo_subtype != subtype) {
00853           CommandCost cost = DoCommand(0, w->index, v->cargo_type | 1U << 7 | (subtype << 8), flags, GetCmdRefitVeh(v));
00854           if (cost.Succeeded()) total_cost.AddCost(cost);
00855         }
00856 
00857         if (w->IsGroundVehicle() && w->HasArticulatedPart()) {
00858           w = w->GetNextArticulatedPart();
00859         } else {
00860           break;
00861         }
00862       } else {
00863         const Engine *e = v->GetEngine();
00864         CargoID initial_cargo = (e->CanCarryCargo() ? e->GetDefaultCargoType() : (CargoID)CT_INVALID);
00865 
00866         if (v->cargo_type != initial_cargo && initial_cargo != CT_INVALID) {
00867           bool dummy;
00868           total_cost.AddCost(GetRefitCost(NULL, v->engine_type, v->cargo_type, v->cargo_subtype, &dummy));
00869         }
00870       }
00871 
00872       if (v->IsGroundVehicle() && v->HasArticulatedPart()) {
00873         v = v->GetNextArticulatedPart();
00874       } else {
00875         break;
00876       }
00877     } while (v != NULL);
00878 
00879     if ((flags & DC_EXEC) && v->type == VEH_TRAIN) w = w->GetNextVehicle();
00880   } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != NULL);
00881 
00882   if (flags & DC_EXEC) {
00883     /*
00884      * Set the orders of the vehicle. Cannot do it earlier as we need
00885      * the vehicle refitted before doing this, otherwise the moved
00886      * cargo types might not match (passenger vs non-passenger)
00887      */
00888     DoCommand(0, w_front->index | (p2 & 1 ? CO_SHARE : CO_COPY) << 30, v_front->index, flags, CMD_CLONE_ORDER);
00889 
00890     /* Now clone the vehicle's name, if it has one. */
00891     if (v_front->name != NULL) CloneVehicleName(v_front, w_front);
00892   }
00893 
00894   /* Since we can't estimate the cost of cloning a vehicle accurately we must
00895    * check whether the company has enough money manually. */
00896   if (!CheckCompanyHasMoney(total_cost)) {
00897     if (flags & DC_EXEC) {
00898       /* The vehicle has already been bought, so now it must be sold again. */
00899       DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
00900     }
00901     return total_cost;
00902   }
00903 
00904   return total_cost;
00905 }
00906 
00914 static CommandCost SendAllVehiclesToDepot(DoCommandFlag flags, bool service, const VehicleListIdentifier &vli)
00915 {
00916   VehicleList list;
00917 
00918   if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
00919 
00920   /* Send all the vehicles to a depot */
00921   bool had_success = false;
00922   for (uint i = 0; i < list.Length(); i++) {
00923     const Vehicle *v = list[i];
00924     CommandCost ret = DoCommand(v->tile, v->index | (service ? DEPOT_SERVICE : 0U) | DEPOT_DONT_CANCEL, 0, flags, GetCmdSendToDepot(vli.vtype));
00925 
00926     if (ret.Succeeded()) {
00927       had_success = true;
00928 
00929       /* Return 0 if DC_EXEC is not set this is a valid goto depot command)
00930        * In this case we know that at least one vehicle can be sent to a depot
00931        * and we will issue the command. We can now safely quit the loop, knowing
00932        * it will succeed at least once. With DC_EXEC we really need to send them to the depot */
00933       if (!(flags & DC_EXEC)) break;
00934     }
00935   }
00936 
00937   return had_success ? CommandCost() : CMD_ERROR;
00938 }
00939 
00951 CommandCost CmdSendVehicleToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00952 {
00953   if (p1 & DEPOT_MASS_SEND) {
00954     /* Mass goto depot requested */
00955     VehicleListIdentifier vli;
00956     if (!vli.Unpack(p2)) return CMD_ERROR;
00957     return SendAllVehiclesToDepot(flags, (p1 & DEPOT_SERVICE) != 0, vli);
00958   }
00959 
00960   Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
00961   if (v == NULL) return CMD_ERROR;
00962 
00963   return v->SendToDepot(flags, (DepotCommand)(p1 & DEPOT_COMMAND_MASK));
00964 }
00965 
00975 CommandCost CmdRenameVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00976 {
00977   Vehicle *v = Vehicle::GetIfValid(p1);
00978   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
00979 
00980   CommandCost ret = CheckOwnership(v->owner);
00981   if (ret.Failed()) return ret;
00982 
00983   bool reset = StrEmpty(text);
00984 
00985   if (!reset) {
00986     if (Utf8StringLength(text) >= MAX_LENGTH_VEHICLE_NAME_CHARS) return CMD_ERROR;
00987     if (!(flags & DC_AUTOREPLACE) && !IsUniqueVehicleName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
00988   }
00989 
00990   if (flags & DC_EXEC) {
00991     free(v->name);
00992     v->name = reset ? NULL : strdup(text);
00993     InvalidateWindowClassesData(WC_TRAINS_LIST, 1);
00994     MarkWholeScreenDirty();
00995   }
00996 
00997   return CommandCost();
00998 }
00999 
01000 
01010 CommandCost CmdChangeServiceInt(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01011 {
01012   Vehicle *v = Vehicle::GetIfValid(p1);
01013   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
01014 
01015   CommandCost ret = CheckOwnership(v->owner);
01016   if (ret.Failed()) return ret;
01017 
01018   uint16 serv_int = GetServiceIntervalClamped(p2, v->owner); // Double check the service interval from the user-input
01019   if (serv_int != p2) return CMD_ERROR;
01020 
01021   if (flags & DC_EXEC) {
01022     v->service_interval = serv_int;
01023     SetWindowDirty(WC_VEHICLE_DETAILS, v->index);
01024   }
01025 
01026   return CommandCost();
01027 }