vehicle_cmd.cpp

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