vehicle_cmd.cpp

Go to the documentation of this file.
00001 /* $Id: vehicle_cmd.cpp 24998 2013-02-14 17:24:55Z 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 
00438   /* Don't allow shadows and such to be refitted. */
00439   if (v != front && (v->type == VEH_SHIP || v->type == VEH_AIRCRAFT)) return CMD_ERROR;
00440   /* Allow auto-refitting only during loading and normal refitting only in a depot. */
00441   if ((!auto_refit || !front->current_order.IsType(OT_LOADING)) && !front->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAIN_MUST_BE_STOPPED_INSIDE_DEPOT + front->type);
00442   if (front->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
00443 
00444   /* Check cargo */
00445   CargoID new_cid = GB(p2, 0, 5);
00446   byte new_subtype = GB(p2, 8, 8);
00447   if (new_cid >= NUM_CARGO) return CMD_ERROR;
00448 
00449   /* For ships and aircrafts there is always only one. */
00450   bool only_this = HasBit(p2, 7) || front->type == VEH_SHIP || front->type == VEH_AIRCRAFT;
00451   uint8 num_vehicles = GB(p2, 16, 8);
00452 
00453   CommandCost cost = RefitVehicle(v, only_this, num_vehicles, new_cid, new_subtype, flags, auto_refit);
00454 
00455   if (flags & DC_EXEC) {
00456     /* Update the cached variables */
00457     switch (v->type) {
00458       case VEH_TRAIN:
00459         Train::From(front)->ConsistChanged(auto_refit);
00460         break;
00461       case VEH_ROAD:
00462         RoadVehUpdateCache(RoadVehicle::From(front), auto_refit);
00463         if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) RoadVehicle::From(front)->CargoChanged();
00464         break;
00465 
00466       case VEH_SHIP:
00467         v->InvalidateNewGRFCacheOfChain();
00468         v->colourmap = PAL_NONE; // invalidate vehicle colour map
00469         Ship::From(v)->UpdateCache();
00470         break;
00471 
00472       case VEH_AIRCRAFT:
00473         v->InvalidateNewGRFCacheOfChain();
00474         v->colourmap = PAL_NONE; // invalidate vehicle colour map
00475         UpdateAircraftCache(Aircraft::From(v), true);
00476         break;
00477 
00478       default: NOT_REACHED();
00479     }
00480 
00481     InvalidateWindowData(WC_VEHICLE_DETAILS, front->index);
00482     SetWindowDirty(WC_VEHICLE_DEPOT, front->tile);
00483     InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 0);
00484   } else {
00485     /* Always invalidate the cache; querycost might have filled it. */
00486     v->InvalidateNewGRFCacheOfChain();
00487   }
00488 
00489   return cost;
00490 }
00491 
00501 CommandCost CmdStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00502 {
00503   /* Disable the effect of p2 bit 0, when DC_AUTOREPLACE is not set */
00504   if ((flags & DC_AUTOREPLACE) == 0) SetBit(p2, 0);
00505 
00506   Vehicle *v = Vehicle::GetIfValid(p1);
00507   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
00508 
00509   CommandCost ret = CheckOwnership(v->owner);
00510   if (ret.Failed()) return ret;
00511 
00512   if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_VEHICLE_IS_DESTROYED);
00513 
00514   switch (v->type) {
00515     case VEH_TRAIN:
00516       if ((v->vehstatus & VS_STOPPED) && Train::From(v)->gcache.cached_power == 0) return_cmd_error(STR_ERROR_TRAIN_START_NO_POWER);
00517       break;
00518 
00519     case VEH_SHIP:
00520     case VEH_ROAD:
00521       break;
00522 
00523     case VEH_AIRCRAFT: {
00524       Aircraft *a = Aircraft::From(v);
00525       /* cannot stop airplane when in flight, or when taking off / landing */
00526       if (!(v->vehstatus & VS_CRASHED) && a->state >= STARTTAKEOFF && a->state < TERM7) return_cmd_error(STR_ERROR_AIRCRAFT_IS_IN_FLIGHT);
00527       break;
00528     }
00529 
00530     default: return CMD_ERROR;
00531   }
00532 
00533   if (HasBit(p2, 0)) {
00534     /* Check if this vehicle can be started/stopped. Failure means 'allow'. */
00535     uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
00536     StringID error = STR_NULL;
00537     if (callback != CALLBACK_FAILED) {
00538       if (v->GetGRF()->grf_version < 8) {
00539         /* 8 bit result 0xFF means 'allow' */
00540         if (callback < 0x400 && GB(callback, 0, 8) != 0xFF) error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
00541       } else {
00542         if (callback < 0x400) {
00543           error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
00544         } else {
00545           switch (callback) {
00546             case 0x400: // allow
00547               break;
00548 
00549             default: // unknown reason -> disallow
00550               error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
00551               break;
00552           }
00553         }
00554       }
00555     }
00556     if (error != STR_NULL) return_cmd_error(error);
00557   }
00558 
00559   if (flags & DC_EXEC) {
00560     if (v->IsStoppedInDepot() && (flags & DC_AUTOREPLACE) == 0) DeleteVehicleNews(p1, STR_NEWS_TRAIN_IS_WAITING + v->type);
00561 
00562     v->vehstatus ^= VS_STOPPED;
00563     if (v->type != VEH_TRAIN) v->cur_speed = 0; // trains can stop 'slowly'
00564     v->MarkDirty();
00565     SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
00566     SetWindowDirty(WC_VEHICLE_DEPOT, v->tile);
00567     SetWindowClassesDirty(GetWindowClassForVehicleType(v->type));
00568   }
00569   return CommandCost();
00570 }
00571 
00583 CommandCost CmdMassStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00584 {
00585   VehicleList list;
00586   bool do_start = HasBit(p1, 0);
00587   bool vehicle_list_window = HasBit(p1, 1);
00588 
00589   VehicleListIdentifier vli;
00590   if (!vli.Unpack(p2)) return CMD_ERROR;
00591   if (!IsCompanyBuildableVehicleType(vli.vtype)) return CMD_ERROR;
00592 
00593   if (vehicle_list_window) {
00594     if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
00595   } else {
00596     /* Get the list of vehicles in the depot */
00597     BuildDepotVehicleList(vli.vtype, tile, &list, NULL);
00598   }
00599 
00600   for (uint i = 0; i < list.Length(); i++) {
00601     const Vehicle *v = list[i];
00602 
00603     if (!!(v->vehstatus & VS_STOPPED) != do_start) continue;
00604 
00605     if (!vehicle_list_window && !v->IsChainInDepot()) continue;
00606 
00607     /* Just try and don't care if some vehicle's can't be stopped. */
00608     DoCommand(tile, v->index, 0, flags, CMD_START_STOP_VEHICLE);
00609   }
00610 
00611   return CommandCost();
00612 }
00613 
00623 CommandCost CmdDepotSellAllVehicles(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00624 {
00625   VehicleList list;
00626 
00627   CommandCost cost(EXPENSES_NEW_VEHICLES);
00628   VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
00629 
00630   if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
00631 
00632   uint sell_command = GetCmdSellVeh(vehicle_type);
00633 
00634   /* Get the list of vehicles in the depot */
00635   BuildDepotVehicleList(vehicle_type, tile, &list, &list);
00636 
00637   CommandCost last_error = CMD_ERROR;
00638   bool had_success = false;
00639   for (uint i = 0; i < list.Length(); i++) {
00640     CommandCost ret = DoCommand(tile, list[i]->index | (1 << 20), 0, flags, sell_command);
00641     if (ret.Succeeded()) {
00642       cost.AddCost(ret);
00643       had_success = true;
00644     } else {
00645       last_error = ret;
00646     }
00647   }
00648 
00649   return had_success ? cost : last_error;
00650 }
00651 
00661 CommandCost CmdDepotMassAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00662 {
00663   VehicleList list;
00664   CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES);
00665   VehicleType vehicle_type = Extract<VehicleType, 0, 3>(p1);
00666 
00667   if (!IsCompanyBuildableVehicleType(vehicle_type)) return CMD_ERROR;
00668   if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;
00669 
00670   /* Get the list of vehicles in the depot */
00671   BuildDepotVehicleList(vehicle_type, tile, &list, &list, true);
00672 
00673   for (uint i = 0; i < list.Length(); i++) {
00674     const Vehicle *v = list[i];
00675 
00676     /* Ensure that the vehicle completely in the depot */
00677     if (!v->IsChainInDepot()) continue;
00678 
00679     CommandCost ret = DoCommand(0, v->index, 0, flags, CMD_AUTOREPLACE_VEHICLE);
00680 
00681     if (ret.Succeeded()) cost.AddCost(ret);
00682   }
00683   return cost;
00684 }
00685 
00691 static bool IsUniqueVehicleName(const char *name)
00692 {
00693   const Vehicle *v;
00694 
00695   FOR_ALL_VEHICLES(v) {
00696     if (v->name != NULL && strcmp(v->name, name) == 0) return false;
00697   }
00698 
00699   return true;
00700 }
00701 
00707 static void CloneVehicleName(const Vehicle *src, Vehicle *dst)
00708 {
00709   char buf[256];
00710 
00711   /* Find the position of the first digit in the last group of digits. */
00712   size_t number_position;
00713   for (number_position = strlen(src->name); number_position > 0; number_position--) {
00714     /* The design of UTF-8 lets this work simply without having to check
00715      * for UTF-8 sequences. */
00716     if (src->name[number_position - 1] < '0' || src->name[number_position - 1] > '9') break;
00717   }
00718 
00719   /* Format buffer and determine starting number. */
00720   int num;
00721   byte padding = 0;
00722   if (number_position == strlen(src->name)) {
00723     /* No digit at the end, so start at number 2. */
00724     strecpy(buf, src->name, lastof(buf));
00725     strecat(buf, " ", lastof(buf));
00726     number_position = strlen(buf);
00727     num = 2;
00728   } else {
00729     /* Found digits, parse them and start at the next number. */
00730     strecpy(buf, src->name, lastof(buf));
00731     buf[number_position] = '\0';
00732     char *endptr;
00733     num = strtol(&src->name[number_position], &endptr, 10) + 1;
00734     padding = endptr - &src->name[number_position];
00735   }
00736 
00737   /* Check if this name is already taken. */
00738   for (int max_iterations = 1000; max_iterations > 0; max_iterations--, num++) {
00739     /* Attach the number to the temporary name. */
00740     seprintf(&buf[number_position], lastof(buf), "%0*d", padding, num);
00741 
00742     /* Check the name is unique. */
00743     if (IsUniqueVehicleName(buf)) {
00744       dst->name = strdup(buf);
00745       break;
00746     }
00747   }
00748 
00749   /* All done. If we didn't find a name, it'll just use its default. */
00750 }
00751 
00761 CommandCost CmdCloneVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00762 {
00763   CommandCost total_cost(EXPENSES_NEW_VEHICLES);
00764 
00765   Vehicle *v = Vehicle::GetIfValid(p1);
00766   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
00767   Vehicle *v_front = v;
00768   Vehicle *w = NULL;
00769   Vehicle *w_front = NULL;
00770   Vehicle *w_rear = NULL;
00771 
00772   /*
00773    * v_front is the front engine in the original vehicle
00774    * v is the car/vehicle of the original vehicle that is currently being copied
00775    * w_front is the front engine of the cloned vehicle
00776    * w is the car/vehicle currently being cloned
00777    * w_rear is the rear end of the cloned train. It's used to add more cars and is only used by trains
00778    */
00779 
00780   CommandCost ret = CheckOwnership(v->owner);
00781   if (ret.Failed()) return ret;
00782 
00783   if (v->type == VEH_TRAIN && (!v->IsFrontEngine() || Train::From(v)->crash_anim_pos >= 4400)) return CMD_ERROR;
00784 
00785   /* check that we can allocate enough vehicles */
00786   if (!(flags & DC_EXEC)) {
00787     int veh_counter = 0;
00788     do {
00789       veh_counter++;
00790     } while ((v = v->Next()) != NULL);
00791 
00792     if (!Vehicle::CanAllocateItem(veh_counter)) {
00793       return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
00794     }
00795   }
00796 
00797   v = v_front;
00798 
00799   do {
00800     if (v->type == VEH_TRAIN && Train::From(v)->IsRearDualheaded()) {
00801       /* we build the rear ends of multiheaded trains with the front ones */
00802       continue;
00803     }
00804 
00805     /* In case we're building a multi headed vehicle and the maximum number of
00806      * vehicles is almost reached (e.g. max trains - 1) not all vehicles would
00807      * be cloned. When the non-primary engines were build they were seen as
00808      * 'new' vehicles whereas they would immediately be joined with a primary
00809      * engine. This caused the vehicle to be not build as 'the limit' had been
00810      * reached, resulting in partially build vehicles and such. */
00811     DoCommandFlag build_flags = flags;
00812     if ((flags & DC_EXEC) && !v->IsPrimaryVehicle()) build_flags |= DC_AUTOREPLACE;
00813 
00814     CommandCost cost = DoCommand(tile, v->engine_type | (1 << 16), 0, build_flags, GetCmdBuildVeh(v));
00815 
00816     if (cost.Failed()) {
00817       /* Can't build a part, then sell the stuff we already made; clear up the mess */
00818       if (w_front != NULL) DoCommand(w_front->tile, w_front->index | (1 << 20), 0, flags, GetCmdSellVeh(w_front));
00819       return cost;
00820     }
00821 
00822     total_cost.AddCost(cost);
00823 
00824     if (flags & DC_EXEC) {
00825       w = Vehicle::Get(_new_vehicle_id);
00826 
00827       if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION)) {
00828         SetBit(Train::From(w)->flags, VRF_REVERSE_DIRECTION);
00829       }
00830 
00831       if (v->type == VEH_TRAIN && !v->IsFrontEngine()) {
00832         /* this s a train car
00833          * add this unit to the end of the train */
00834         CommandCost result = DoCommand(0, w->index | 1 << 20, w_rear->index, flags, CMD_MOVE_RAIL_VEHICLE);
00835         if (result.Failed()) {
00836           /* The train can't be joined to make the same consist as the original.
00837            * Sell what we already made (clean up) and return an error.           */
00838           DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
00839           DoCommand(w_front->tile, w->index       | 1 << 20, 0, flags, GetCmdSellVeh(w));
00840           return result; // return error and the message returned from CMD_MOVE_RAIL_VEHICLE
00841         }
00842       } else {
00843         /* this is a front engine or not a train. */
00844         w_front = w;
00845         w->service_interval = v->service_interval;
00846         w->SetServiceIntervalIsCustom(v->ServiceIntervalIsCustom());
00847         w->SetServiceIntervalIsPercent(v->ServiceIntervalIsPercent());
00848       }
00849       w_rear = w; // trains needs to know the last car in the train, so they can add more in next loop
00850     }
00851   } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != NULL);
00852 
00853   if ((flags & DC_EXEC) && v_front->type == VEH_TRAIN) {
00854     /* for trains this needs to be the front engine due to the callback function */
00855     _new_vehicle_id = w_front->index;
00856   }
00857 
00858   if (flags & DC_EXEC) {
00859     /* Cloned vehicles belong to the same group */
00860     DoCommand(0, v_front->group_id, w_front->index, flags, CMD_ADD_VEHICLE_GROUP);
00861   }
00862 
00863 
00864   /* Take care of refitting. */
00865   w = w_front;
00866   v = v_front;
00867 
00868   /* Both building and refitting are influenced by newgrf callbacks, which
00869    * makes it impossible to accurately estimate the cloning costs. In
00870    * particular, it is possible for engines of the same type to be built with
00871    * different numbers of articulated parts, so when refitting we have to
00872    * loop over real vehicles first, and then the articulated parts of those
00873    * vehicles in a different loop. */
00874   do {
00875     do {
00876       if (flags & DC_EXEC) {
00877         assert(w != NULL);
00878 
00879         /* Find out what's the best sub type */
00880         byte subtype = GetBestFittingSubType(v, w, v->cargo_type);
00881         if (w->cargo_type != v->cargo_type || w->cargo_subtype != subtype) {
00882           CommandCost cost = DoCommand(0, w->index, v->cargo_type | 1U << 7 | (subtype << 8), flags, GetCmdRefitVeh(v));
00883           if (cost.Succeeded()) total_cost.AddCost(cost);
00884         }
00885 
00886         if (w->IsGroundVehicle() && w->HasArticulatedPart()) {
00887           w = w->GetNextArticulatedPart();
00888         } else {
00889           break;
00890         }
00891       } else {
00892         const Engine *e = v->GetEngine();
00893         CargoID initial_cargo = (e->CanCarryCargo() ? e->GetDefaultCargoType() : (CargoID)CT_INVALID);
00894 
00895         if (v->cargo_type != initial_cargo && initial_cargo != CT_INVALID) {
00896           bool dummy;
00897           total_cost.AddCost(GetRefitCost(NULL, v->engine_type, v->cargo_type, v->cargo_subtype, &dummy));
00898         }
00899       }
00900 
00901       if (v->IsGroundVehicle() && v->HasArticulatedPart()) {
00902         v = v->GetNextArticulatedPart();
00903       } else {
00904         break;
00905       }
00906     } while (v != NULL);
00907 
00908     if ((flags & DC_EXEC) && v->type == VEH_TRAIN) w = w->GetNextVehicle();
00909   } while (v->type == VEH_TRAIN && (v = v->GetNextVehicle()) != NULL);
00910 
00911   if (flags & DC_EXEC) {
00912     /*
00913      * Set the orders of the vehicle. Cannot do it earlier as we need
00914      * the vehicle refitted before doing this, otherwise the moved
00915      * cargo types might not match (passenger vs non-passenger)
00916      */
00917     DoCommand(0, w_front->index | (p2 & 1 ? CO_SHARE : CO_COPY) << 30, v_front->index, flags, CMD_CLONE_ORDER);
00918 
00919     /* Now clone the vehicle's name, if it has one. */
00920     if (v_front->name != NULL) CloneVehicleName(v_front, w_front);
00921   }
00922 
00923   /* Since we can't estimate the cost of cloning a vehicle accurately we must
00924    * check whether the company has enough money manually. */
00925   if (!CheckCompanyHasMoney(total_cost)) {
00926     if (flags & DC_EXEC) {
00927       /* The vehicle has already been bought, so now it must be sold again. */
00928       DoCommand(w_front->tile, w_front->index | 1 << 20, 0, flags, GetCmdSellVeh(w_front));
00929     }
00930     return total_cost;
00931   }
00932 
00933   return total_cost;
00934 }
00935 
00943 static CommandCost SendAllVehiclesToDepot(DoCommandFlag flags, bool service, const VehicleListIdentifier &vli)
00944 {
00945   VehicleList list;
00946 
00947   if (!GenerateVehicleSortList(&list, vli)) return CMD_ERROR;
00948 
00949   /* Send all the vehicles to a depot */
00950   bool had_success = false;
00951   for (uint i = 0; i < list.Length(); i++) {
00952     const Vehicle *v = list[i];
00953     CommandCost ret = DoCommand(v->tile, v->index | (service ? DEPOT_SERVICE : 0U) | DEPOT_DONT_CANCEL, 0, flags, GetCmdSendToDepot(vli.vtype));
00954 
00955     if (ret.Succeeded()) {
00956       had_success = true;
00957 
00958       /* Return 0 if DC_EXEC is not set this is a valid goto depot command)
00959        * In this case we know that at least one vehicle can be sent to a depot
00960        * and we will issue the command. We can now safely quit the loop, knowing
00961        * it will succeed at least once. With DC_EXEC we really need to send them to the depot */
00962       if (!(flags & DC_EXEC)) break;
00963     }
00964   }
00965 
00966   return had_success ? CommandCost() : CMD_ERROR;
00967 }
00968 
00980 CommandCost CmdSendVehicleToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00981 {
00982   if (p1 & DEPOT_MASS_SEND) {
00983     /* Mass goto depot requested */
00984     VehicleListIdentifier vli;
00985     if (!vli.Unpack(p2)) return CMD_ERROR;
00986     return SendAllVehiclesToDepot(flags, (p1 & DEPOT_SERVICE) != 0, vli);
00987   }
00988 
00989   Vehicle *v = Vehicle::GetIfValid(GB(p1, 0, 20));
00990   if (v == NULL) return CMD_ERROR;
00991   if (!v->IsPrimaryVehicle()) return CMD_ERROR;
00992 
00993   return v->SendToDepot(flags, (DepotCommand)(p1 & DEPOT_COMMAND_MASK));
00994 }
00995 
01005 CommandCost CmdRenameVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01006 {
01007   Vehicle *v = Vehicle::GetIfValid(p1);
01008   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
01009 
01010   CommandCost ret = CheckOwnership(v->owner);
01011   if (ret.Failed()) return ret;
01012 
01013   bool reset = StrEmpty(text);
01014 
01015   if (!reset) {
01016     if (Utf8StringLength(text) >= MAX_LENGTH_VEHICLE_NAME_CHARS) return CMD_ERROR;
01017     if (!(flags & DC_AUTOREPLACE) && !IsUniqueVehicleName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
01018   }
01019 
01020   if (flags & DC_EXEC) {
01021     free(v->name);
01022     v->name = reset ? NULL : strdup(text);
01023     InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 1);
01024     MarkWholeScreenDirty();
01025   }
01026 
01027   return CommandCost();
01028 }
01029 
01030 
01043 CommandCost CmdChangeServiceInt(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01044 {
01045   Vehicle *v = Vehicle::GetIfValid(p1);
01046   if (v == NULL || !v->IsPrimaryVehicle()) return CMD_ERROR;
01047 
01048   CommandCost ret = CheckOwnership(v->owner);
01049   if (ret.Failed()) return ret;
01050 
01051   const Company *company = Company::Get(v->owner);
01052   bool iscustom  = HasBit(p2, 16);
01053   bool ispercent = iscustom ? HasBit(p2, 17) : company->settings.vehicle.servint_ispercent;
01054 
01055   uint16 serv_int;
01056   if (iscustom) {
01057     serv_int = GB(p2, 0, 16);
01058     if (serv_int != GetServiceIntervalClamped(serv_int, ispercent)) return CMD_ERROR;
01059   } else {
01060     serv_int = CompanyServiceInterval(company, v->type);
01061   }
01062 
01063   if (flags & DC_EXEC) {
01064     v->SetServiceInterval(serv_int);
01065     v->SetServiceIntervalIsCustom(iscustom);
01066     v->SetServiceIntervalIsPercent(ispercent);
01067     SetWindowDirty(WC_VEHICLE_DETAILS, v->index);
01068   }
01069 
01070   return CommandCost();
01071 }