order_cmd.cpp

Go to the documentation of this file.
00001 /* $Id: order_cmd.cpp 18809 2010-01-15 16:41:15Z 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 "debug.h"
00014 #include "command_func.h"
00015 #include "company_func.h"
00016 #include "news_func.h"
00017 #include "vehicle_gui.h"
00018 #include "strings_func.h"
00019 #include "functions.h"
00020 #include "window_func.h"
00021 #include "timetable.h"
00022 #include "vehicle_func.h"
00023 #include "depot_base.h"
00024 #include "core/pool_func.hpp"
00025 #include "aircraft.h"
00026 #include "roadveh.h"
00027 #include "station_base.h"
00028 #include "waypoint_base.h"
00029 #include "company_base.h"
00030 
00031 #include "table/strings.h"
00032 
00033 /* DestinationID must be at least as large as every these below, because it can
00034  * be any of them
00035  */
00036 assert_compile(sizeof(DestinationID) >= sizeof(DepotID));
00037 assert_compile(sizeof(DestinationID) >= sizeof(StationID));
00038 
00039 TileIndex _backup_orders_tile;
00040 BackuppedOrders _backup_orders_data;
00041 
00042 OrderPool _order_pool("Order");
00043 INSTANTIATE_POOL_METHODS(Order)
00044 OrderListPool _orderlist_pool("OrderList");
00045 INSTANTIATE_POOL_METHODS(OrderList)
00046 
00047 void Order::Free()
00048 {
00049   this->type  = OT_NOTHING;
00050   this->flags = 0;
00051   this->dest  = 0;
00052   this->next  = NULL;
00053 }
00054 
00055 void Order::MakeGoToStation(StationID destination)
00056 {
00057   this->type = OT_GOTO_STATION;
00058   this->flags = 0;
00059   this->dest = destination;
00060 }
00061 
00062 void Order::MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type, OrderDepotActionFlags action, CargoID cargo, byte subtype)
00063 {
00064   this->type = OT_GOTO_DEPOT;
00065   this->SetDepotOrderType(order);
00066   this->SetDepotActionType(action);
00067   this->SetNonStopType(non_stop_type);
00068   this->dest = destination;
00069   this->SetRefit(cargo, subtype);
00070 }
00071 
00072 void Order::MakeGoToWaypoint(StationID destination)
00073 {
00074   this->type = OT_GOTO_WAYPOINT;
00075   this->flags = 0;
00076   this->dest = destination;
00077 }
00078 
00079 void Order::MakeLoading(bool ordered)
00080 {
00081   this->type = OT_LOADING;
00082   if (!ordered) this->flags = 0;
00083 }
00084 
00085 void Order::MakeLeaveStation()
00086 {
00087   this->type = OT_LEAVESTATION;
00088   this->flags = 0;
00089 }
00090 
00091 void Order::MakeDummy()
00092 {
00093   this->type = OT_DUMMY;
00094   this->flags = 0;
00095 }
00096 
00097 void Order::MakeConditional(VehicleOrderID order)
00098 {
00099   this->type = OT_CONDITIONAL;
00100   this->flags = order;
00101   this->dest = 0;
00102 }
00103 
00104 void Order::SetRefit(CargoID cargo, byte subtype)
00105 {
00106   this->refit_cargo = cargo;
00107   this->refit_subtype = subtype;
00108 }
00109 
00110 bool Order::Equals(const Order &other) const
00111 {
00112   /* In case of go to nearest depot orders we need "only" compare the flags
00113    * with the other and not the nearest depot order bit or the actual
00114    * destination because those get clear/filled in during the order
00115    * evaluation. If we do not do this the order will continuously be seen as
00116    * a different order and it will try to find a "nearest depot" every tick. */
00117   if ((this->type == OT_GOTO_DEPOT && this->type == other.type) &&
00118       ((this->GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0 ||
00119        (other.GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0)) {
00120     return
00121       this->GetDepotOrderType() == other.GetDepotOrderType() &&
00122       (this->GetDepotActionType() & ~ODATFB_NEAREST_DEPOT) == (other.GetDepotActionType() & ~ODATFB_NEAREST_DEPOT);
00123   }
00124 
00125   return
00126       this->type  == other.type &&
00127       this->flags == other.flags &&
00128       this->dest  == other.dest;
00129 }
00130 
00131 uint32 Order::Pack() const
00132 {
00133   return this->dest << 16 | this->flags << 8 | this->type;
00134 }
00135 
00136 uint16 Order::MapOldOrder() const
00137 {
00138   uint16 order = this->GetType();
00139   switch (this->type) {
00140     case OT_GOTO_STATION:
00141       if (this->GetUnloadType() & OUFB_UNLOAD) SetBit(order, 5);
00142       if (this->GetLoadType() & OLFB_FULL_LOAD) SetBit(order, 6);
00143       if (this->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) SetBit(order, 7);
00144       order |= GB(this->GetDestination(), 0, 8) << 8;
00145       break;
00146     case OT_GOTO_DEPOT:
00147       if (!(this->GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) SetBit(order, 6);
00148       SetBit(order, 7);
00149       order |= GB(this->GetDestination(), 0, 8) << 8;
00150       break;
00151     case OT_LOADING:
00152       if (this->GetLoadType() & OLFB_FULL_LOAD) SetBit(order, 6);
00153       break;
00154   }
00155   return order;
00156 }
00157 
00158 Order::Order(uint32 packed)
00159 {
00160   this->type    = (OrderType)GB(packed,  0,  8);
00161   this->flags   = GB(packed,  8,  8);
00162   this->dest    = GB(packed, 16, 16);
00163   this->next    = NULL;
00164   this->refit_cargo   = CT_NO_REFIT;
00165   this->refit_subtype = 0;
00166   this->wait_time     = 0;
00167   this->travel_time   = 0;
00168 }
00169 
00175 void InvalidateVehicleOrder(const Vehicle *v, int data)
00176 {
00177   SetWindowDirty(WC_VEHICLE_VIEW, v->index);
00178 
00179   if (data != 0) {
00180     /* Calls SetDirty() too */
00181     InvalidateWindowData(WC_VEHICLE_ORDERS,    v->index, data);
00182     InvalidateWindowData(WC_VEHICLE_TIMETABLE, v->index, data);
00183     return;
00184   }
00185 
00186   SetWindowDirty(WC_VEHICLE_ORDERS,    v->index);
00187   SetWindowDirty(WC_VEHICLE_TIMETABLE, v->index);
00188 }
00189 
00196 void Order::AssignOrder(const Order &other)
00197 {
00198   this->type  = other.type;
00199   this->flags = other.flags;
00200   this->dest  = other.dest;
00201 
00202   this->refit_cargo   = other.refit_cargo;
00203   this->refit_subtype = other.refit_subtype;
00204 
00205   this->wait_time   = other.wait_time;
00206   this->travel_time = other.travel_time;
00207 }
00208 
00209 void OrderList::Initialize(Order *chain, Vehicle *v)
00210 {
00211   this->first = chain;
00212   this->first_shared = v;
00213 
00214   this->num_orders = 0;
00215   this->num_vehicles = 1;
00216   this->timetable_duration = 0;
00217 
00218   for (Order *o = this->first; o != NULL; o = o->next) {
00219     ++this->num_orders;
00220     this->timetable_duration += o->wait_time + o->travel_time;
00221   }
00222 
00223   for (Vehicle *u = this->first_shared->PreviousShared(); u != NULL; u = u->PreviousShared()) {
00224     ++this->num_vehicles;
00225     this->first_shared = u;
00226   }
00227 
00228   for (const Vehicle *u = v->NextShared(); u != NULL; u = u->NextShared()) ++this->num_vehicles;
00229 }
00230 
00231 void OrderList::FreeChain(bool keep_orderlist)
00232 {
00233   Order *next;
00234   for (Order *o = this->first; o != NULL; o = next) {
00235     next = o->next;
00236     delete o;
00237   }
00238 
00239   if (keep_orderlist) {
00240     this->first = NULL;
00241     this->num_orders = 0;
00242     this->timetable_duration = 0;
00243   } else {
00244     delete this;
00245   }
00246 }
00247 
00248 Order *OrderList::GetOrderAt(int index) const
00249 {
00250   if (index < 0) return NULL;
00251 
00252   Order *order = this->first;
00253 
00254   while (order != NULL && index-- > 0)
00255     order = order->next;
00256 
00257   return order;
00258 }
00259 
00260 void OrderList::InsertOrderAt(Order *new_order, int index)
00261 {
00262   if (this->first == NULL) {
00263     this->first = new_order;
00264   } else {
00265     if (index == 0) {
00266       /* Insert as first or only order */
00267       new_order->next = this->first;
00268       this->first = new_order;
00269     } else if (index >= this->num_orders) {
00270       /* index is after the last order, add it to the end */
00271       this->GetLastOrder()->next = new_order;
00272     } else {
00273       /* Put the new order in between */
00274       Order *order = this->GetOrderAt(index - 1);
00275       new_order->next = order->next;
00276       order->next = new_order;
00277     }
00278   }
00279   ++this->num_orders;
00280   this->timetable_duration += new_order->wait_time + new_order->travel_time;
00281 }
00282 
00283 
00284 void OrderList::DeleteOrderAt(int index)
00285 {
00286   if (index >= this->num_orders) return;
00287 
00288   Order *to_remove;
00289 
00290   if (index == 0) {
00291     to_remove = this->first;
00292     this->first = to_remove->next;
00293   } else {
00294     Order *prev = GetOrderAt(index - 1);
00295     to_remove = prev->next;
00296     prev->next = to_remove->next;
00297   }
00298   --this->num_orders;
00299   this->timetable_duration -= (to_remove->wait_time + to_remove->travel_time);
00300   delete to_remove;
00301 }
00302 
00303 void OrderList::MoveOrder(int from, int to)
00304 {
00305   if (from >= this->num_orders || to >= this->num_orders || from == to) return;
00306 
00307   Order *moving_one;
00308 
00309   /* Take the moving order out of the pointer-chain */
00310   if (from == 0) {
00311     moving_one = this->first;
00312     this->first = moving_one->next;
00313   } else {
00314     Order *one_before = GetOrderAt(from - 1);
00315     moving_one = one_before->next;
00316     one_before->next = moving_one->next;
00317   }
00318 
00319   /* Insert the moving_order again in the pointer-chain */
00320   if (to == 0) {
00321     moving_one->next = this->first;
00322     this->first = moving_one;
00323   } else {
00324     Order *one_before = GetOrderAt(to - 1);
00325     moving_one->next = one_before->next;
00326     one_before->next = moving_one;
00327   }
00328 }
00329 
00330 void OrderList::RemoveVehicle(Vehicle *v)
00331 {
00332   --this->num_vehicles;
00333   if (v == this->first_shared) this->first_shared = v->NextShared();
00334 }
00335 
00336 bool OrderList::IsVehicleInSharedOrdersList(const Vehicle *v) const
00337 {
00338   for (const Vehicle *v_shared = this->first_shared; v_shared != NULL; v_shared = v_shared->NextShared()) {
00339     if (v_shared == v) return true;
00340   }
00341 
00342   return false;
00343 }
00344 
00345 int OrderList::GetPositionInSharedOrderList(const Vehicle *v) const
00346 {
00347   int count = 0;
00348   for (const Vehicle *v_shared = v->PreviousShared(); v_shared != NULL; v_shared = v_shared->PreviousShared()) count++;
00349   return count;
00350 }
00351 
00352 bool OrderList::IsCompleteTimetable() const
00353 {
00354   for (Order *o = this->first; o != NULL; o = o->next) {
00355     if (!o->IsCompletelyTimetabled()) return false;
00356   }
00357   return true;
00358 }
00359 
00360 void OrderList::DebugCheckSanity() const
00361 {
00362   VehicleOrderID check_num_orders = 0;
00363   uint check_num_vehicles = 0;
00364   Ticks check_timetable_duration = 0;
00365 
00366   DEBUG(misc, 6, "Checking OrderList %hu for sanity...", this->index);
00367 
00368   for (const Order *o = this->first; o != NULL; o = o->next) {
00369     ++check_num_orders;
00370     check_timetable_duration += o->wait_time + o->travel_time;
00371   }
00372   assert(this->num_orders == check_num_orders);
00373   assert(this->timetable_duration == check_timetable_duration);
00374 
00375   for (const Vehicle *v = this->first_shared; v != NULL; v = v->NextShared()) {
00376     ++check_num_vehicles;
00377     assert(v->orders.list == this);
00378   }
00379   assert(this->num_vehicles == check_num_vehicles);
00380   DEBUG(misc, 6, "... detected %u orders, %u vehicles, %i ticks", (uint)this->num_orders,
00381         this->num_vehicles, this->timetable_duration);
00382 }
00383 
00391 static inline bool OrderGoesToStation(const Vehicle *v, const Order *o)
00392 {
00393   return o->IsType(OT_GOTO_STATION) ||
00394       (v->type == VEH_AIRCRAFT && o->IsType(OT_GOTO_DEPOT) && !(o->GetDepotActionType() & ODATFB_NEAREST_DEPOT));
00395 }
00396 
00403 static void DeleteOrderWarnings(const Vehicle *v)
00404 {
00405   DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_TOO_FEW_ORDERS);
00406   DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_VOID_ORDER);
00407   DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_DUPLICATE_ENTRY);
00408   DeleteVehicleNews(v->index, STR_NEWS_VEHICLE_HAS_INVALID_ENTRY);
00409 }
00410 
00411 
00412 static TileIndex GetOrderLocation(const Order& o)
00413 {
00414   switch (o.GetType()) {
00415     default: NOT_REACHED();
00416     case OT_GOTO_WAYPOINT: return Waypoint::Get(o.GetDestination())->xy;
00417     case OT_GOTO_STATION:  return Station::Get(o.GetDestination())->xy;
00418     case OT_GOTO_DEPOT:    return Depot::Get(o.GetDestination())->xy;
00419   }
00420 }
00421 
00422 static uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth = 0)
00423 {
00424   assert(v->type == VEH_SHIP);
00425 
00426   if (cur->IsType(OT_CONDITIONAL)) {
00427     if (conditional_depth > v->GetNumOrders()) return 0;
00428 
00429     conditional_depth++;
00430 
00431     int dist1 = GetOrderDistance(prev, v->GetOrder(cur->GetConditionSkipToOrder()), v, conditional_depth);
00432     int dist2 = GetOrderDistance(prev, cur->next == NULL ? v->orders.list->GetFirstOrder() : cur->next, v, conditional_depth);
00433     return max(dist1, dist2);
00434   }
00435 
00436   return DistanceManhattan(GetOrderLocation(*prev), GetOrderLocation(*cur));
00437 }
00438 
00451 CommandCost CmdInsertOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00452 {
00453   VehicleID veh   = GB(p1,  0, 16);
00454   VehicleOrderID sel_ord = GB(p1, 16, 16);
00455   Order new_order(p2);
00456 
00457   Vehicle *v = Vehicle::GetIfValid(veh);
00458   if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
00459 
00460   /* Check if the inserted order is to the correct destination (owner, type),
00461    * and has the correct flags if any */
00462   switch (new_order.GetType()) {
00463     case OT_GOTO_STATION: {
00464       const Station *st = Station::GetIfValid(new_order.GetDestination());
00465       if (st == NULL) return CMD_ERROR;
00466 
00467       if (st->owner != OWNER_NONE && !CheckOwnership(st->owner)) return CMD_ERROR;
00468 
00469       if (!CanVehicleUseStation(v, st)) return_cmd_error(STR_ERROR_CAN_T_ADD_ORDER);
00470       for (Vehicle *u = v->FirstShared(); u != NULL; u = u->NextShared()) {
00471         if (!CanVehicleUseStation(u, st)) return_cmd_error(STR_ERROR_CAN_T_ADD_ORDER_SHARED);
00472       }
00473 
00474       /* Non stop not allowed for non-trains. */
00475       if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN && v->type != VEH_ROAD) return CMD_ERROR;
00476 
00477       /* No load and no unload are mutual exclusive. */
00478       if ((new_order.GetLoadType() & OLFB_NO_LOAD) && (new_order.GetUnloadType() & OUFB_NO_UNLOAD)) return CMD_ERROR;
00479 
00480       /* Filter invalid load/unload types. */
00481       switch (new_order.GetLoadType()) {
00482         case OLF_LOAD_IF_POSSIBLE: case OLFB_FULL_LOAD: case OLF_FULL_LOAD_ANY: case OLFB_NO_LOAD: break;
00483         default: return CMD_ERROR;
00484       }
00485       switch (new_order.GetUnloadType()) {
00486         case OUF_UNLOAD_IF_POSSIBLE: case OUFB_UNLOAD: case OUFB_TRANSFER: case OUFB_NO_UNLOAD: break;
00487         default: return CMD_ERROR;
00488       }
00489 
00490       /* Filter invalid stop locations */
00491       switch (new_order.GetStopLocation()) {
00492         case OSL_PLATFORM_NEAR_END:
00493         case OSL_PLATFORM_MIDDLE:
00494           if (v->type != VEH_TRAIN) return CMD_ERROR;
00495           /* FALL THROUGH */
00496         case OSL_PLATFORM_FAR_END:
00497           break;
00498 
00499         default:
00500           return CMD_ERROR;
00501       }
00502 
00503       break;
00504     }
00505 
00506     case OT_GOTO_DEPOT: {
00507       if (new_order.GetDepotActionType() != ODATFB_NEAREST_DEPOT) {
00508         if (v->type == VEH_AIRCRAFT) {
00509           const Station *st = Station::GetIfValid(new_order.GetDestination());
00510 
00511           if (st == NULL || !CheckOwnership(st->owner) ||
00512               !CanVehicleUseStation(v, st) ||
00513               st->GetAirportSpec()->nof_depots == 0) {
00514             return CMD_ERROR;
00515           }
00516         } else {
00517           const Depot *dp = Depot::GetIfValid(new_order.GetDestination());
00518 
00519           if (dp == NULL || !CheckOwnership(GetTileOwner(dp->xy))) return CMD_ERROR;
00520 
00521           switch (v->type) {
00522             case VEH_TRAIN:
00523               if (!IsRailDepotTile(dp->xy)) return CMD_ERROR;
00524               break;
00525 
00526             case VEH_ROAD:
00527               if (!IsRoadDepotTile(dp->xy)) return CMD_ERROR;
00528               break;
00529 
00530             case VEH_SHIP:
00531               if (!IsShipDepotTile(dp->xy)) return CMD_ERROR;
00532               break;
00533 
00534             default: return CMD_ERROR;
00535           }
00536         }
00537       } else {
00538         if (!IsCompanyBuildableVehicleType(v)) return CMD_ERROR;
00539       }
00540 
00541       if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN && v->type != VEH_ROAD) return CMD_ERROR;
00542       if (new_order.GetDepotOrderType() & ~(ODTFB_PART_OF_ORDERS | ((new_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0 ? ODTFB_SERVICE : 0))) return CMD_ERROR;
00543       if (new_order.GetDepotActionType() & ~(ODATFB_HALT | ODATFB_NEAREST_DEPOT)) return CMD_ERROR;
00544       if ((new_order.GetDepotOrderType() & ODTFB_SERVICE) && (new_order.GetDepotActionType() & ODATFB_HALT)) return CMD_ERROR;
00545       break;
00546     }
00547 
00548     case OT_GOTO_WAYPOINT: {
00549       const Waypoint *wp = Waypoint::GetIfValid(new_order.GetDestination());
00550       if (wp == NULL) return CMD_ERROR;
00551 
00552       switch (v->type) {
00553         default: return CMD_ERROR;
00554 
00555         case VEH_TRAIN:
00556           if (!(wp->facilities & FACIL_TRAIN)) return_cmd_error(STR_ERROR_CAN_T_ADD_ORDER);
00557           if (!CheckOwnership(wp->owner)) return CMD_ERROR;
00558           break;
00559 
00560         case VEH_SHIP:
00561           if (!(wp->facilities & FACIL_DOCK)) return_cmd_error(STR_ERROR_CAN_T_ADD_ORDER);
00562           if (!CheckOwnership(wp->owner) && wp->owner != OWNER_NONE) return CMD_ERROR;
00563           break;
00564       }
00565 
00566       /* Order flags can be any of the following for waypoints:
00567        * [non-stop]
00568        * non-stop orders (if any) are only valid for trains */
00569       if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;
00570       break;
00571     }
00572 
00573     case OT_CONDITIONAL: {
00574       VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();
00575       if (skip_to != 0 && skip_to >= v->GetNumOrders()) return CMD_ERROR; // Always allow jumping to the first (even when there is no order).
00576       if (new_order.GetConditionVariable() > OCV_END) return CMD_ERROR;
00577 
00578       OrderConditionComparator occ = new_order.GetConditionComparator();
00579       if (occ > OCC_END) return CMD_ERROR;
00580       switch (new_order.GetConditionVariable()) {
00581         case OCV_REQUIRES_SERVICE:
00582           if (occ != OCC_IS_TRUE && occ != OCC_IS_FALSE) return CMD_ERROR;
00583           break;
00584 
00585         case OCV_UNCONDITIONALLY:
00586           if (occ != OCC_EQUALS) return CMD_ERROR;
00587           if (new_order.GetConditionValue() != 0) return CMD_ERROR;
00588           break;
00589 
00590         case OCV_LOAD_PERCENTAGE:
00591         case OCV_RELIABILITY:
00592           if (new_order.GetConditionValue() > 100) return CMD_ERROR;
00593           /* FALL THROUGH */
00594         default:
00595           if (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) return CMD_ERROR;
00596           break;
00597       }
00598     } break;
00599 
00600     default: return CMD_ERROR;
00601   }
00602 
00603   if (sel_ord > v->GetNumOrders()) return CMD_ERROR;
00604 
00605   if (v->GetNumOrders() >= MAX_VEH_ORDER_ID) return_cmd_error(STR_ERROR_TOO_MANY_ORDERS);
00606   if (!Order::CanAllocateItem()) return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
00607   if (v->orders.list == NULL && !OrderList::CanAllocateItem()) return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
00608 
00609   if (v->type == VEH_SHIP && _settings_game.pf.pathfinder_for_ships != VPF_NPF) {
00610     /* Make sure the new destination is not too far away from the previous */
00611     const Order *prev = NULL;
00612     uint n = 0;
00613 
00614     /* Find the last goto station or depot order before the insert location.
00615      * If the order is to be inserted at the beginning of the order list this
00616      * finds the last order in the list. */
00617     const Order *o;
00618     FOR_VEHICLE_ORDERS(v, o) {
00619       switch (o->GetType()) {
00620         case OT_GOTO_STATION:
00621         case OT_GOTO_DEPOT:
00622         case OT_GOTO_WAYPOINT:
00623           prev = o;
00624           break;
00625 
00626         default: break;
00627       }
00628       if (++n == sel_ord && prev != NULL) break;
00629     }
00630     if (prev != NULL) {
00631       uint dist = GetOrderDistance(prev, &new_order, v);
00632       if (dist >= 130) {
00633         return_cmd_error(STR_ERROR_TOO_FAR_FROM_PREVIOUS_DESTINATION);
00634       }
00635     }
00636   }
00637 
00638   if (flags & DC_EXEC) {
00639     Order *new_o = new Order();
00640     new_o->AssignOrder(new_order);
00641 
00642     /* Create new order and link in list */
00643     if (v->orders.list == NULL) {
00644       v->orders.list = new OrderList(new_o, v);
00645     } else {
00646       v->orders.list->InsertOrderAt(new_o, sel_ord);
00647     }
00648 
00649     Vehicle *u = v->FirstShared();
00650     DeleteOrderWarnings(u);
00651     for (; u != NULL; u = u->NextShared()) {
00652       assert(v->orders.list == u->orders.list);
00653 
00654       /* If there is added an order before the current one, we need
00655       to update the selected order */
00656       if (sel_ord <= u->cur_order_index) {
00657         uint cur = u->cur_order_index + 1;
00658         /* Check if we don't go out of bound */
00659         if (cur < u->GetNumOrders())
00660           u->cur_order_index = cur;
00661       }
00662       /* Update any possible open window of the vehicle */
00663       InvalidateVehicleOrder(u, INVALID_VEH_ORDER_ID | (sel_ord << 8));
00664     }
00665 
00666     /* As we insert an order, the order to skip to will be 'wrong'. */
00667     VehicleOrderID cur_order_id = 0;
00668     Order *order;
00669     FOR_VEHICLE_ORDERS(v, order) {
00670       if (order->IsType(OT_CONDITIONAL)) {
00671         VehicleOrderID order_id = order->GetConditionSkipToOrder();
00672         if (order_id >= sel_ord) {
00673           order->SetConditionSkipToOrder(order_id + 1);
00674         }
00675         if (order_id == cur_order_id) {
00676           order->SetConditionSkipToOrder((order_id + 1) % v->GetNumOrders());
00677         }
00678       }
00679       cur_order_id++;
00680     }
00681 
00682     /* Make sure to rebuild the whole list */
00683     InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 0);
00684   }
00685 
00686   return CommandCost();
00687 }
00688 
00693 static CommandCost DecloneOrder(Vehicle *dst, DoCommandFlag flags)
00694 {
00695   if (flags & DC_EXEC) {
00696     DeleteVehicleOrders(dst);
00697     InvalidateVehicleOrder(dst, -1);
00698     InvalidateWindowClassesData(GetWindowClassForVehicleType(dst->type), 0);
00699   }
00700   return CommandCost();
00701 }
00702 
00711 CommandCost CmdDeleteOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00712 {
00713   VehicleID veh_id = p1;
00714   VehicleOrderID sel_ord = p2;
00715   Order *order;
00716 
00717   Vehicle *v = Vehicle::GetIfValid(veh_id);
00718 
00719   if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
00720 
00721   /* If we did not select an order, we maybe want to de-clone the orders */
00722   if (sel_ord >= v->GetNumOrders())
00723     return DecloneOrder(v, flags);
00724 
00725   order = v->GetOrder(sel_ord);
00726   if (order == NULL) return CMD_ERROR;
00727 
00728   if (flags & DC_EXEC) {
00729     v->orders.list->DeleteOrderAt(sel_ord);
00730 
00731     Vehicle *u = v->FirstShared();
00732     DeleteOrderWarnings(u);
00733     for (; u != NULL; u = u->NextShared()) {
00734       if (sel_ord < u->cur_order_index)
00735         u->cur_order_index--;
00736 
00737       assert(v->orders.list == u->orders.list);
00738 
00739       /* NON-stop flag is misused to see if a train is in a station that is
00740        * on his order list or not */
00741       if (sel_ord == u->cur_order_index && u->current_order.IsType(OT_LOADING)) {
00742         u->current_order.SetNonStopType(ONSF_STOP_EVERYWHERE);
00743       }
00744 
00745       /* Update any possible open window of the vehicle */
00746       InvalidateVehicleOrder(u, sel_ord | (INVALID_VEH_ORDER_ID << 8));
00747     }
00748 
00749     /* As we delete an order, the order to skip to will be 'wrong'. */
00750     VehicleOrderID cur_order_id = 0;
00751     FOR_VEHICLE_ORDERS(v, order) {
00752       if (order->IsType(OT_CONDITIONAL)) {
00753         VehicleOrderID order_id = order->GetConditionSkipToOrder();
00754         if (order_id >= sel_ord) {
00755           order->SetConditionSkipToOrder(max(order_id - 1, 0));
00756         }
00757         if (order_id == cur_order_id) {
00758           order->SetConditionSkipToOrder((order_id + 1) % v->GetNumOrders());
00759         }
00760       }
00761       cur_order_id++;
00762     }
00763 
00764     InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 0);
00765   }
00766 
00767   return CommandCost();
00768 }
00769 
00778 CommandCost CmdSkipToOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00779 {
00780   VehicleID veh_id = p1;
00781   VehicleOrderID sel_ord = p2;
00782 
00783   Vehicle *v = Vehicle::GetIfValid(veh_id);
00784 
00785   if (v == NULL || !CheckOwnership(v->owner) || sel_ord == v->cur_order_index ||
00786       sel_ord >= v->GetNumOrders() || v->GetNumOrders() < 2) {
00787     return CMD_ERROR;
00788   }
00789 
00790   if (flags & DC_EXEC) {
00791     v->cur_order_index = sel_ord;
00792 
00793     if (v->current_order.IsType(OT_LOADING)) v->LeaveStation();
00794 
00795     InvalidateVehicleOrder(v, -2);
00796   }
00797 
00798   /* We have an aircraft/ship, they have a mini-schedule, so update them all */
00799   if (v->type == VEH_AIRCRAFT) SetWindowClassesDirty(WC_AIRCRAFT_LIST);
00800   if (v->type == VEH_SHIP) SetWindowClassesDirty(WC_SHIPS_LIST);
00801 
00802   return CommandCost();
00803 }
00804 
00818 CommandCost CmdMoveOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00819 {
00820   VehicleID veh = p1;
00821   VehicleOrderID moving_order = GB(p2,  0, 16);
00822   VehicleOrderID target_order = GB(p2, 16, 16);
00823 
00824   Vehicle *v = Vehicle::GetIfValid(veh);
00825   if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
00826 
00827   /* Don't make senseless movements */
00828   if (moving_order >= v->GetNumOrders() || target_order >= v->GetNumOrders() ||
00829       moving_order == target_order || v->GetNumOrders() <= 1)
00830     return CMD_ERROR;
00831 
00832   Order *moving_one = v->GetOrder(moving_order);
00833   /* Don't move an empty order */
00834   if (moving_one == NULL) return CMD_ERROR;
00835 
00836   if (flags & DC_EXEC) {
00837     v->orders.list->MoveOrder(moving_order, target_order);
00838 
00839     /* Update shared list */
00840     Vehicle *u = v->FirstShared();
00841 
00842     DeleteOrderWarnings(u);
00843 
00844     for (; u != NULL; u = u->NextShared()) {
00845       /* Update the current order */
00846       if (u->cur_order_index == moving_order) {
00847         u->cur_order_index = target_order;
00848       } else if (u->cur_order_index > moving_order && u->cur_order_index <= target_order) {
00849         u->cur_order_index--;
00850       } else if (u->cur_order_index < moving_order && u->cur_order_index >= target_order) {
00851         u->cur_order_index++;
00852       }
00853 
00854       assert(v->orders.list == u->orders.list);
00855       /* Update any possible open window of the vehicle */
00856       InvalidateVehicleOrder(u, moving_order | (target_order << 8));
00857     }
00858 
00859     /* As we move an order, the order to skip to will be 'wrong'. */
00860     Order *order;
00861     FOR_VEHICLE_ORDERS(v, order) {
00862       if (order->IsType(OT_CONDITIONAL)) {
00863         VehicleOrderID order_id = order->GetConditionSkipToOrder();
00864         if (order_id == moving_order) {
00865           order_id = target_order;
00866         } else if (order_id > moving_order && order_id <= target_order) {
00867           order_id--;
00868         } else if (order_id < moving_order && order_id >= target_order) {
00869           order_id++;
00870         }
00871         order->SetConditionSkipToOrder(order_id);
00872       }
00873     }
00874 
00875     /* Make sure to rebuild the whole list */
00876     InvalidateWindowClassesData(GetWindowClassForVehicleType(v->type), 0);
00877   }
00878 
00879   return CommandCost();
00880 }
00881 
00896 CommandCost CmdModifyOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
00897 {
00898   VehicleOrderID sel_ord = GB(p1, 16, 16); // XXX - automatically truncated to 8 bits.
00899   VehicleID veh          = GB(p1,  0, 16);
00900   ModifyOrderFlags mof   = (ModifyOrderFlags)GB(p2,  0,  4);
00901   uint16 data             = GB(p2, 4, 11);
00902 
00903   if (mof >= MOF_END) return CMD_ERROR;
00904 
00905   Vehicle *v = Vehicle::GetIfValid(veh);
00906   if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
00907 
00908   /* Is it a valid order? */
00909   if (sel_ord >= v->GetNumOrders()) return CMD_ERROR;
00910 
00911   Order *order = v->GetOrder(sel_ord);
00912   switch (order->GetType()) {
00913     case OT_GOTO_STATION:
00914       if (mof == MOF_COND_VARIABLE || mof == MOF_COND_COMPARATOR || mof == MOF_DEPOT_ACTION || mof == MOF_COND_VALUE) return CMD_ERROR;
00915       break;
00916 
00917     case OT_GOTO_DEPOT:
00918       if (mof != MOF_NON_STOP && mof != MOF_DEPOT_ACTION) return CMD_ERROR;
00919       break;
00920 
00921     case OT_GOTO_WAYPOINT:
00922       if (mof != MOF_NON_STOP) return CMD_ERROR;
00923       break;
00924 
00925     case OT_CONDITIONAL:
00926       if (mof != MOF_COND_VARIABLE && mof != MOF_COND_COMPARATOR && mof != MOF_COND_VALUE && mof != MOF_COND_DESTINATION) return CMD_ERROR;
00927       break;
00928 
00929     default:
00930       return CMD_ERROR;
00931   }
00932 
00933   switch (mof) {
00934     default: NOT_REACHED();
00935 
00936     case MOF_NON_STOP:
00937       if (v->type != VEH_TRAIN && v->type != VEH_ROAD) return CMD_ERROR;
00938       if (data >= ONSF_END) return CMD_ERROR;
00939       if (data == order->GetNonStopType()) return CMD_ERROR;
00940       break;
00941 
00942     case MOF_STOP_LOCATION:
00943       if (v->type != VEH_TRAIN) return CMD_ERROR;
00944       if (data >= OSL_END) return CMD_ERROR;
00945       break;
00946 
00947     case MOF_UNLOAD:
00948       if ((data & ~(OUFB_UNLOAD | OUFB_TRANSFER | OUFB_NO_UNLOAD)) != 0) return CMD_ERROR;
00949       /* Unload and no-unload are mutual exclusive and so are transfer and no unload. */
00950       if (data != 0 && ((data & (OUFB_UNLOAD | OUFB_TRANSFER)) != 0) == ((data & OUFB_NO_UNLOAD) != 0)) return CMD_ERROR;
00951       if (data == order->GetUnloadType()) return CMD_ERROR;
00952       break;
00953 
00954     case MOF_LOAD:
00955       if (data > OLFB_NO_LOAD || data == 1) return CMD_ERROR;
00956       if (data == order->GetLoadType()) return CMD_ERROR;
00957       break;
00958 
00959     case MOF_DEPOT_ACTION:
00960       if (data >= DA_END) return CMD_ERROR;
00961       break;
00962 
00963     case MOF_COND_VARIABLE:
00964       if (data >= OCV_END) return CMD_ERROR;
00965       break;
00966 
00967     case MOF_COND_COMPARATOR:
00968       if (data >= OCC_END) return CMD_ERROR;
00969       switch (order->GetConditionVariable()) {
00970         case OCV_UNCONDITIONALLY: return CMD_ERROR;
00971 
00972         case OCV_REQUIRES_SERVICE:
00973           if (data != OCC_IS_TRUE && data != OCC_IS_FALSE) return CMD_ERROR;
00974           break;
00975 
00976         default:
00977           if (data == OCC_IS_TRUE || data == OCC_IS_FALSE) return CMD_ERROR;
00978           break;
00979       }
00980       break;
00981 
00982     case MOF_COND_VALUE:
00983       switch (order->GetConditionVariable()) {
00984         case OCV_UNCONDITIONALLY: return CMD_ERROR;
00985 
00986         case OCV_LOAD_PERCENTAGE:
00987         case OCV_RELIABILITY:
00988           if (data > 100) return CMD_ERROR;
00989           break;
00990 
00991         default:
00992           if (data > 2047) return CMD_ERROR;
00993           break;
00994       }
00995       break;
00996 
00997     case MOF_COND_DESTINATION:
00998       if (data >= v->GetNumOrders()) return CMD_ERROR;
00999       break;
01000   }
01001 
01002   if (flags & DC_EXEC) {
01003     switch (mof) {
01004       case MOF_NON_STOP:
01005         order->SetNonStopType((OrderNonStopFlags)data);
01006         break;
01007 
01008       case MOF_STOP_LOCATION:
01009         order->SetStopLocation((OrderStopLocation)data);
01010         break;
01011 
01012       case MOF_UNLOAD:
01013         order->SetUnloadType((OrderUnloadFlags)data);
01014         if ((data & OUFB_NO_UNLOAD) != 0 && (order->GetLoadType() & OLFB_NO_LOAD) != 0) {
01015           order->SetLoadType((OrderLoadFlags)(order->GetLoadType() & ~OLFB_NO_LOAD));
01016         }
01017         break;
01018 
01019       case MOF_LOAD:
01020         order->SetLoadType((OrderLoadFlags)data);
01021         if ((data & OLFB_NO_LOAD) != 0 && (order->GetUnloadType() & OUFB_NO_UNLOAD) != 0) {
01022           /* No load + no unload isn't compatible */
01023           order->SetUnloadType((OrderUnloadFlags)(order->GetUnloadType() & ~OUFB_NO_UNLOAD));
01024         }
01025         break;
01026 
01027       case MOF_DEPOT_ACTION: {
01028         switch (data) {
01029           case DA_ALWAYS_GO:
01030             order->SetDepotOrderType((OrderDepotTypeFlags)(order->GetDepotOrderType() & ~ODTFB_SERVICE));
01031             order->SetDepotActionType((OrderDepotActionFlags)(order->GetDepotActionType() & ~ODATFB_HALT));
01032             break;
01033 
01034           case DA_SERVICE:
01035             order->SetDepotOrderType((OrderDepotTypeFlags)(order->GetDepotOrderType() | ODTFB_SERVICE));
01036             order->SetDepotActionType((OrderDepotActionFlags)(order->GetDepotActionType() & ~ODATFB_HALT));
01037             break;
01038 
01039           case DA_STOP:
01040             order->SetDepotOrderType((OrderDepotTypeFlags)(order->GetDepotOrderType() & ~ODTFB_SERVICE));
01041             order->SetDepotActionType((OrderDepotActionFlags)(order->GetDepotActionType() | ODATFB_HALT));
01042             break;
01043 
01044           default:
01045             NOT_REACHED();
01046         }
01047       } break;
01048 
01049       case MOF_COND_VARIABLE: {
01050         order->SetConditionVariable((OrderConditionVariable)data);
01051 
01052         OrderConditionComparator occ = order->GetConditionComparator();
01053         switch (order->GetConditionVariable()) {
01054           case OCV_UNCONDITIONALLY:
01055             order->SetConditionComparator(OCC_EQUALS);
01056             order->SetConditionValue(0);
01057             break;
01058 
01059           case OCV_REQUIRES_SERVICE:
01060             if (occ != OCC_IS_TRUE && occ != OCC_IS_FALSE) order->SetConditionComparator(OCC_IS_TRUE);
01061             break;
01062 
01063           case OCV_LOAD_PERCENTAGE:
01064           case OCV_RELIABILITY:
01065             if (order->GetConditionValue() > 100) order->SetConditionValue(100);
01066             /* FALL THROUGH */
01067           default:
01068             if (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) order->SetConditionComparator(OCC_EQUALS);
01069             break;
01070         }
01071       } break;
01072 
01073       case MOF_COND_COMPARATOR:
01074         order->SetConditionComparator((OrderConditionComparator)data);
01075         break;
01076 
01077       case MOF_COND_VALUE:
01078         order->SetConditionValue(data);
01079         break;
01080 
01081       case MOF_COND_DESTINATION:
01082         order->SetConditionSkipToOrder(data);
01083         break;
01084 
01085       default: NOT_REACHED();
01086     }
01087 
01088     /* Update the windows and full load flags, also for vehicles that share the same order list */
01089     Vehicle *u = v->FirstShared();
01090     DeleteOrderWarnings(u);
01091     for (; u != NULL; u = u->NextShared()) {
01092       /* Toggle u->current_order "Full load" flag if it changed.
01093        * However, as the same flag is used for depot orders, check
01094        * whether we are not going to a depot as there are three
01095        * cases where the full load flag can be active and only
01096        * one case where the flag is used for depot orders. In the
01097        * other cases for the OrderTypeByte the flags are not used,
01098        * so do not care and those orders should not be active
01099        * when this function is called.
01100        */
01101       if (sel_ord == u->cur_order_index &&
01102           (u->current_order.IsType(OT_GOTO_STATION) || u->current_order.IsType(OT_LOADING)) &&
01103           u->current_order.GetLoadType() != order->GetLoadType()) {
01104         u->current_order.SetLoadType(order->GetLoadType());
01105       }
01106       InvalidateVehicleOrder(u, -2);
01107     }
01108   }
01109 
01110   return CommandCost();
01111 }
01112 
01123 CommandCost CmdCloneOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01124 {
01125   VehicleID veh_src = GB(p1, 16, 16);
01126   VehicleID veh_dst = GB(p1,  0, 16);
01127 
01128   Vehicle *dst = Vehicle::GetIfValid(veh_dst);
01129 
01130   if (dst == NULL || !CheckOwnership(dst->owner)) return CMD_ERROR;
01131 
01132   switch (p2) {
01133     case CO_SHARE: {
01134       Vehicle *src = Vehicle::GetIfValid(veh_src);
01135 
01136       /* Sanity checks */
01137       if (src == NULL || !CheckOwnership(src->owner) || dst->type != src->type || dst == src) {
01138         return CMD_ERROR;
01139       }
01140 
01141       /* Trucks can't share orders with busses (and visa versa) */
01142       if (src->type == VEH_ROAD && RoadVehicle::From(src)->IsBus() != RoadVehicle::From(dst)->IsBus()) {
01143         return CMD_ERROR;
01144       }
01145 
01146       /* Is the vehicle already in the shared list? */
01147       if (src->FirstShared() == dst->FirstShared()) return CMD_ERROR;
01148 
01149       const Order *order;
01150 
01151       FOR_VEHICLE_ORDERS(src, order) {
01152         if (OrderGoesToStation(dst, order) &&
01153             !CanVehicleUseStation(dst, Station::Get(order->GetDestination()))) {
01154           return_cmd_error(STR_ERROR_CAN_T_COPY_SHARE_ORDER);
01155         }
01156       }
01157 
01158       if (flags & DC_EXEC) {
01159         /* If the destination vehicle had a OrderList, destroy it */
01160         DeleteVehicleOrders(dst);
01161 
01162         dst->orders.list = src->orders.list;
01163 
01164         /* Link this vehicle in the shared-list */
01165         dst->AddToShared(src);
01166 
01167         InvalidateVehicleOrder(dst, -1);
01168         InvalidateVehicleOrder(src, -2);
01169 
01170         InvalidateWindowClassesData(GetWindowClassForVehicleType(dst->type), 0);
01171       }
01172     } break;
01173 
01174     case CO_COPY: {
01175       Vehicle *src = Vehicle::GetIfValid(veh_src);
01176 
01177       /* Sanity checks */
01178       if (src == NULL || !CheckOwnership(src->owner) || dst->type != src->type || dst == src) {
01179         return CMD_ERROR;
01180       }
01181 
01182       /* Trucks can't copy all the orders from busses (and visa versa),
01183        * and neither can helicopters and aircarft. */
01184       const Order *order;
01185       FOR_VEHICLE_ORDERS(src, order) {
01186         if (OrderGoesToStation(dst, order) &&
01187             !CanVehicleUseStation(dst, Station::Get(order->GetDestination()))) {
01188           return_cmd_error(STR_ERROR_CAN_T_COPY_SHARE_ORDER);
01189         }
01190       }
01191 
01192       /* make sure there are orders available */
01193       int delta = dst->IsOrderListShared() ? src->GetNumOrders() + 1 : src->GetNumOrders() - dst->GetNumOrders();
01194       if (!Order::CanAllocateItem(delta) ||
01195           ((dst->orders.list == NULL || dst->IsOrderListShared()) && !OrderList::CanAllocateItem())) {
01196         return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
01197       }
01198 
01199       if (flags & DC_EXEC) {
01200         const Order *order;
01201         Order *first = NULL;
01202         Order **order_dst;
01203 
01204         /* If the destination vehicle had an order list, destroy the chain but keep the OrderList */
01205         DeleteVehicleOrders(dst, true);
01206 
01207         order_dst = &first;
01208         FOR_VEHICLE_ORDERS(src, order) {
01209           *order_dst = new Order();
01210           (*order_dst)->AssignOrder(*order);
01211           order_dst = &(*order_dst)->next;
01212         }
01213         if (dst->orders.list == NULL) {
01214           dst->orders.list = new OrderList(first, dst);
01215         } else {
01216           assert(dst->orders.list->GetFirstOrder() == NULL);
01217           assert(!dst->orders.list->IsShared());
01218           delete dst->orders.list;
01219           dst->orders.list = new OrderList(first, dst);
01220         }
01221 
01222         InvalidateVehicleOrder(dst, -1);
01223 
01224         InvalidateWindowClassesData(GetWindowClassForVehicleType(dst->type), 0);
01225       }
01226     } break;
01227 
01228     case CO_UNSHARE: return DecloneOrder(dst, flags);
01229     default: return CMD_ERROR;
01230   }
01231 
01232   return CommandCost();
01233 }
01234 
01246 CommandCost CmdOrderRefit(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01247 {
01248   VehicleID veh = GB(p1, 0, 16);
01249   VehicleOrderID order_number  = GB(p2, 16, 8);
01250   CargoID cargo = GB(p2, 0, 8);
01251   byte subtype  = GB(p2, 8, 8);
01252 
01253   const Vehicle *v = Vehicle::GetIfValid(veh);
01254   if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
01255 
01256   Order *order = v->GetOrder(order_number);
01257   if (order == NULL) return CMD_ERROR;
01258 
01259   if (flags & DC_EXEC) {
01260     order->SetRefit(cargo, subtype);
01261 
01262     for (Vehicle *u = v->FirstShared(); u != NULL; u = u->NextShared()) {
01263       /* Update any possible open window of the vehicle */
01264       InvalidateVehicleOrder(u, -2);
01265 
01266       /* If the vehicle already got the current depot set as current order, then update current order as well */
01267       if (u->cur_order_index == order_number && (u->current_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) {
01268         u->current_order.SetRefit(cargo, subtype);
01269       }
01270     }
01271   }
01272 
01273   return CommandCost();
01274 }
01275 
01282 void BackupVehicleOrders(const Vehicle *v, BackuppedOrders *bak)
01283 {
01284   /* Make sure we always have freed the stuff */
01285   free(bak->order);
01286   bak->order = NULL;
01287   free(bak->name);
01288   bak->name = NULL;
01289 
01290   /* Save general info */
01291   bak->orderindex       = v->cur_order_index;
01292   bak->group            = v->group_id;
01293   bak->service_interval = v->service_interval;
01294   if (v->name != NULL) bak->name = strdup(v->name);
01295 
01296   /* If we have shared orders, store it on a special way */
01297   if (v->IsOrderListShared()) {
01298     const Vehicle *u = (v->FirstShared() == v) ? v->NextShared() : v->FirstShared();
01299 
01300     bak->clone = u->index;
01301   } else {
01302     /* Else copy the orders */
01303 
01304     /* We do not have shared orders */
01305     bak->clone = INVALID_VEHICLE;
01306 
01307 
01308     /* Count the number of orders */
01309     uint cnt = 0;
01310     const Order *order;
01311     FOR_VEHICLE_ORDERS(v, order) cnt++;
01312 
01313     /* Allocate memory for the orders plus an end-of-orders marker */
01314     bak->order = MallocT<Order>(cnt + 1);
01315 
01316     Order *dest = bak->order;
01317 
01318     /* Copy the orders */
01319     FOR_VEHICLE_ORDERS(v, order) {
01320       memcpy(dest, order, sizeof(Order));
01321       dest++;
01322     }
01323     /* End the list with an empty order */
01324     dest->Free();
01325   }
01326 }
01327 
01333 void RestoreVehicleOrders(const Vehicle *v, const BackuppedOrders *bak)
01334 {
01335   /* If we have a custom name, process that */
01336   if (bak->name != NULL) DoCommandP(0, v->index, 0, CMD_RENAME_VEHICLE, NULL, bak->name);
01337 
01338   /* If we had shared orders, recover that */
01339   if (bak->clone != INVALID_VEHICLE) {
01340     DoCommandP(0, v->index | (bak->clone << 16), CO_SHARE, CMD_CLONE_ORDER);
01341   } else {
01342 
01343     /* CMD_NO_TEST_IF_IN_NETWORK is used here, because CMD_INSERT_ORDER checks if the
01344      *  order number is one more than the current amount of orders, and because
01345      *  in network the commands are queued before send, the second insert always
01346      *  fails in test mode. By bypassing the test-mode, that no longer is a problem. */
01347     for (uint i = 0; !bak->order[i].IsType(OT_NOTHING); i++) {
01348       Order o = bak->order[i];
01349       /* Conditional orders need to have their destination to be valid on insertion. */
01350       if (o.IsType(OT_CONDITIONAL)) o.SetConditionSkipToOrder(0);
01351 
01352       if (!DoCommandP(0, v->index + (i << 16), o.Pack(),
01353           CMD_INSERT_ORDER | CMD_NO_TEST_IF_IN_NETWORK)) {
01354         break;
01355       }
01356 
01357       /* Copy timetable if enabled */
01358       if (_settings_game.order.timetabling && !DoCommandP(0, v->index | (i << 16) | (1 << 25),
01359           o.wait_time << 16 | o.travel_time,
01360           CMD_CHANGE_TIMETABLE | CMD_NO_TEST_IF_IN_NETWORK)) {
01361         break;
01362       }
01363     }
01364 
01365       /* Fix the conditional orders' destination. */
01366     for (uint i = 0; !bak->order[i].IsType(OT_NOTHING); i++) {
01367       if (!bak->order[i].IsType(OT_CONDITIONAL)) continue;
01368 
01369       if (!DoCommandP(0, v->index + (i << 16), MOF_LOAD | (bak->order[i].GetConditionSkipToOrder() << 4),
01370           CMD_MODIFY_ORDER | CMD_NO_TEST_IF_IN_NETWORK)) {
01371         break;
01372       }
01373     }
01374   }
01375 
01376   /* Restore vehicle order-index and service interval */
01377   DoCommandP(0, v->index, bak->orderindex | (bak->service_interval << 16), CMD_RESTORE_ORDER_INDEX);
01378 
01379   /* Restore vehicle group */
01380   DoCommandP(0, bak->group, v->index, CMD_ADD_VEHICLE_GROUP);
01381 }
01382 
01399 CommandCost CmdRestoreOrderIndex(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01400 {
01401   VehicleOrderID cur_ord = GB(p2,  0, 16);
01402   uint16 serv_int = GB(p2, 16, 16);
01403 
01404   Vehicle *v = Vehicle::GetIfValid(p1);
01405   /* Check the vehicle type and ownership, and if the service interval and order are in range */
01406   if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
01407   if (serv_int != GetServiceIntervalClamped(serv_int, v->owner) || cur_ord >= v->GetNumOrders()) return CMD_ERROR;
01408 
01409   if (flags & DC_EXEC) {
01410     v->cur_order_index = cur_ord;
01411     v->service_interval = serv_int;
01412   }
01413 
01414   return CommandCost();
01415 }
01416 
01417 
01423 void CheckOrders(const Vehicle *v)
01424 {
01425   /* Does the user wants us to check things? */
01426   if (_settings_client.gui.order_review_system == 0) return;
01427 
01428   /* Do nothing for crashed vehicles */
01429   if (v->vehstatus & VS_CRASHED) return;
01430 
01431   /* Do nothing for stopped vehicles if setting is '1' */
01432   if (_settings_client.gui.order_review_system == 1 && (v->vehstatus & VS_STOPPED))
01433     return;
01434 
01435   /* do nothing we we're not the first vehicle in a share-chain */
01436   if (v->FirstShared() != v) return;
01437 
01438   /* Only check every 20 days, so that we don't flood the message log */
01439   if (v->owner == _local_company && v->day_counter % 20 == 0) {
01440     int n_st, problem_type = -1;
01441     const Order *order;
01442     int message = 0;
01443 
01444     /* Check the order list */
01445     n_st = 0;
01446 
01447     FOR_VEHICLE_ORDERS(v, order) {
01448       /* Dummy order? */
01449       if (order->IsType(OT_DUMMY)) {
01450         problem_type = 1;
01451         break;
01452       }
01453       /* Does station have a load-bay for this vehicle? */
01454       if (order->IsType(OT_GOTO_STATION)) {
01455         const Station *st = Station::Get(order->GetDestination());
01456 
01457         n_st++;
01458         if (!CanVehicleUseStation(v, st)) problem_type = 3;
01459       }
01460     }
01461 
01462     /* Check if the last and the first order are the same */
01463     if (v->GetNumOrders() > 1) {
01464       const Order *last = v->GetLastOrder();
01465 
01466       if (v->orders.list->GetFirstOrder()->Equals(*last)) {
01467         problem_type = 2;
01468       }
01469     }
01470 
01471     /* Do we only have 1 station in our order list? */
01472     if (n_st < 2 && problem_type == -1) problem_type = 0;
01473 
01474 #ifndef NDEBUG
01475     if (v->orders.list != NULL) v->orders.list->DebugCheckSanity();
01476 #endif
01477 
01478     /* We don't have a problem */
01479     if (problem_type < 0) return;
01480 
01481     message = STR_NEWS_VEHICLE_HAS_TOO_FEW_ORDERS + problem_type;
01482     //DEBUG(misc, 3, "Triggered News Item for vehicle %d", v->index);
01483 
01484     SetDParam(0, v->index);
01485     AddVehicleNewsItem(
01486       message,
01487       NS_ADVICE,
01488       v->index
01489     );
01490   }
01491 }
01492 
01498 void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination)
01499 {
01500   Vehicle *v;
01501 
01502   /* Aircraft have StationIDs for depot orders and never use DepotIDs
01503    * This fact is handled specially below
01504    */
01505 
01506   /* Go through all vehicles */
01507   FOR_ALL_VEHICLES(v) {
01508     Order *order;
01509 
01510     order = &v->current_order;
01511     if ((v->type == VEH_AIRCRAFT && order->IsType(OT_GOTO_DEPOT) ? OT_GOTO_STATION : order->GetType()) == type &&
01512         v->current_order.GetDestination() == destination) {
01513       order->MakeDummy();
01514       SetWindowDirty(WC_VEHICLE_VIEW, v->index);
01515     }
01516 
01517     /* Clear the order from the order-list */
01518     int id = -1;
01519     FOR_VEHICLE_ORDERS(v, order) {
01520       id++;
01521       if (order->IsType(OT_GOTO_DEPOT) && (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0) continue;
01522       if ((v->type == VEH_AIRCRAFT && order->IsType(OT_GOTO_DEPOT) ? OT_GOTO_STATION : order->GetType()) == type &&
01523           order->GetDestination() == destination) {
01524         order->MakeDummy();
01525         for (const Vehicle *w = v->FirstShared(); w != NULL; w = w->NextShared()) {
01526           /* In GUI, simulate by removing the order and adding it back */
01527           InvalidateVehicleOrder(w, id | (INVALID_VEH_ORDER_ID << 8));
01528           InvalidateVehicleOrder(w, (INVALID_VEH_ORDER_ID << 8) | id);
01529         }
01530       }
01531     }
01532   }
01533 }
01534 
01542 bool VehicleHasDepotOrders(const Vehicle *v)
01543 {
01544   const Order *order;
01545 
01546   FOR_VEHICLE_ORDERS(v, order) {
01547     if (order->IsType(OT_GOTO_DEPOT))
01548       return true;
01549   }
01550 
01551   return false;
01552 }
01553 
01559 void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist)
01560 {
01561   DeleteOrderWarnings(v);
01562 
01563   if (v->IsOrderListShared()) {
01564     /* Remove ourself from the shared order list. */
01565     v->RemoveFromShared();
01566     v->orders.list = NULL;
01567   } else if (v->orders.list != NULL) {
01568     /* Remove the orders */
01569     v->orders.list->FreeChain(keep_orderlist);
01570     if (!keep_orderlist) v->orders.list = NULL;
01571   }
01572 }
01573 
01574 uint16 GetServiceIntervalClamped(uint interval, CompanyID company_id)
01575 {
01576   return (Company::Get(company_id)->settings.vehicle.servint_ispercent) ? Clamp(interval, MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT) : Clamp(interval, MIN_SERVINT_DAYS, MAX_SERVINT_DAYS);
01577 }
01578 
01587 static bool CheckForValidOrders(const Vehicle *v)
01588 {
01589   const Order *order;
01590 
01591   FOR_VEHICLE_ORDERS(v, order) {
01592     switch (order->GetType()) {
01593       case OT_GOTO_STATION:
01594       case OT_GOTO_DEPOT:
01595       case OT_GOTO_WAYPOINT:
01596         return true;
01597 
01598       default:
01599         break;
01600     }
01601   }
01602 
01603   return false;
01604 }
01605 
01609 static bool OrderConditionCompare(OrderConditionComparator occ, int variable, int value)
01610 {
01611   switch (occ) {
01612     case OCC_EQUALS:      return variable == value;
01613     case OCC_NOT_EQUALS:  return variable != value;
01614     case OCC_LESS_THAN:   return variable <  value;
01615     case OCC_LESS_EQUALS: return variable <= value;
01616     case OCC_MORE_THAN:   return variable >  value;
01617     case OCC_MORE_EQUALS: return variable >= value;
01618     case OCC_IS_TRUE:     return variable != 0;
01619     case OCC_IS_FALSE:    return variable == 0;
01620     default: NOT_REACHED();
01621   }
01622 }
01623 
01630 VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
01631 {
01632   if (order->GetType() != OT_CONDITIONAL) return INVALID_VEH_ORDER_ID;
01633 
01634   bool skip_order = false;
01635   OrderConditionComparator occ = order->GetConditionComparator();
01636   uint16 value = order->GetConditionValue();
01637 
01638   switch (order->GetConditionVariable()) {
01639     case OCV_LOAD_PERCENTAGE:  skip_order = OrderConditionCompare(occ, CalcPercentVehicleFilled(v, NULL), value); break;
01640     case OCV_RELIABILITY:      skip_order = OrderConditionCompare(occ, ToPercent16(v->reliability),       value); break;
01641     case OCV_MAX_SPEED:        skip_order = OrderConditionCompare(occ, v->GetDisplayMaxSpeed() * 10 / 16, value); break;
01642     case OCV_AGE:              skip_order = OrderConditionCompare(occ, v->age / DAYS_IN_LEAP_YEAR,        value); break;
01643     case OCV_REQUIRES_SERVICE: skip_order = OrderConditionCompare(occ, v->NeedsServicing(),               value); break;
01644     case OCV_UNCONDITIONALLY:  skip_order = true; break;
01645     default: NOT_REACHED();
01646   }
01647 
01648   return skip_order ? order->GetConditionSkipToOrder() : (VehicleOrderID)INVALID_VEH_ORDER_ID;
01649 }
01650 
01657 bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth)
01658 {
01659   if (conditional_depth > v->GetNumOrders()) return false;
01660 
01661   switch (order->GetType()) {
01662     case OT_GOTO_STATION:
01663       v->dest_tile = v->GetOrderStationLocation(order->GetDestination());
01664       return true;
01665 
01666     case OT_GOTO_DEPOT:
01667       if (v->current_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) {
01668         /* We need to search for the nearest depot (hangar). */
01669         TileIndex location;
01670         DestinationID destination;
01671         bool reverse;
01672 
01673         if (v->FindClosestDepot(&location, &destination, &reverse)) {
01674           v->dest_tile = location;
01675           v->current_order.MakeGoToDepot(destination, v->current_order.GetDepotOrderType(), v->current_order.GetNonStopType(), (OrderDepotActionFlags)(v->current_order.GetDepotActionType() & ~ODATFB_NEAREST_DEPOT), v->current_order.GetRefitCargo(), v->current_order.GetRefitSubtype());
01676 
01677           /* If there is no depot in front, reverse automatically (trains only) */
01678           if (v->type == VEH_TRAIN && reverse) DoCommand(v->tile, v->index, 0, DC_EXEC, CMD_REVERSE_TRAIN_DIRECTION);
01679 
01680           if (v->type == VEH_AIRCRAFT) {
01681             Aircraft *a = Aircraft::From(v);
01682             if (a->state == FLYING && a->targetairport != destination) {
01683               /* The aircraft is now heading for a different hangar than the next in the orders */
01684               extern void AircraftNextAirportPos_and_Order(Aircraft *a);
01685               AircraftNextAirportPos_and_Order(a);
01686             }
01687           }
01688           return true;
01689         }
01690 
01691         UpdateVehicleTimetable(v, true);
01692         v->IncrementOrderIndex();
01693       } else if ((order->GetDepotOrderType() & ODTFB_SERVICE) && !v->NeedsServicing()) {
01694         UpdateVehicleTimetable(v, true);
01695         v->IncrementOrderIndex();
01696       } else {
01697         if (v->type != VEH_AIRCRAFT) {
01698           v->dest_tile = Depot::Get(order->GetDestination())->xy;
01699         }
01700         return true;
01701       }
01702       break;
01703 
01704     case OT_GOTO_WAYPOINT:
01705       v->dest_tile = Waypoint::Get(order->GetDestination())->xy;
01706       return true;
01707 
01708     case OT_CONDITIONAL: {
01709       VehicleOrderID next_order = ProcessConditionalOrder(order, v);
01710       if (next_order != INVALID_VEH_ORDER_ID) {
01711         UpdateVehicleTimetable(v, false);
01712         v->cur_order_index = next_order;
01713         v->current_order_time += v->GetOrder(next_order)->travel_time;
01714       } else {
01715         UpdateVehicleTimetable(v, true);
01716         v->IncrementOrderIndex();
01717       }
01718       break;
01719     }
01720 
01721     default:
01722       v->dest_tile = 0;
01723       return false;
01724   }
01725 
01726   assert(v->cur_order_index < v->GetNumOrders());
01727 
01728   /* Get the current order */
01729   order = v->GetOrder(v->cur_order_index);
01730   v->current_order = *order;
01731   return UpdateOrderDest(v, order, conditional_depth + 1);
01732 }
01733 
01741 bool ProcessOrders(Vehicle *v)
01742 {
01743   switch (v->current_order.GetType()) {
01744     case OT_GOTO_DEPOT:
01745       /* Let a depot order in the orderlist interrupt. */
01746       if (!(v->current_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) return false;
01747       break;
01748 
01749     case OT_LOADING:
01750       return false;
01751 
01752     case OT_LEAVESTATION:
01753       if (v->type != VEH_AIRCRAFT) return false;
01754       break;
01755 
01756     default: break;
01757   }
01758 
01766   bool may_reverse = v->current_order.IsType(OT_NOTHING);
01767 
01768   /* Check if we've reached a non-stop station.. */
01769   if (((v->current_order.IsType(OT_GOTO_STATION) && (v->current_order.GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) || v->current_order.IsType(OT_GOTO_WAYPOINT)) &&
01770       IsTileType(v->tile, MP_STATION) &&
01771       v->current_order.GetDestination() == GetStationIndex(v->tile)) {
01772     if (v->current_order.IsType(OT_GOTO_STATION)) v->last_station_visited = v->current_order.GetDestination();
01773     UpdateVehicleTimetable(v, true);
01774     v->IncrementOrderIndex();
01775   }
01776 
01777   /* Get the current order */
01778   if (v->cur_order_index >= v->GetNumOrders()) v->cur_order_index = 0;
01779 
01780   const Order *order = v->GetOrder(v->cur_order_index);
01781 
01782   /* If no order, do nothing. */
01783   if (order == NULL || (v->type == VEH_AIRCRAFT && !CheckForValidOrders(v))) {
01784     if (v->type == VEH_AIRCRAFT) {
01785       /* Aircraft do something vastly different here, so handle separately */
01786       extern void HandleMissingAircraftOrders(Aircraft *v);
01787       HandleMissingAircraftOrders(Aircraft::From(v));
01788       return false;
01789     }
01790 
01791     v->current_order.Free();
01792     v->dest_tile = 0;
01793     return false;
01794   }
01795 
01796   /* If it is unchanged, keep it. */
01797   if (order->Equals(v->current_order) && (v->type == VEH_AIRCRAFT || v->dest_tile != 0) &&
01798       (v->type != VEH_SHIP || !order->IsType(OT_GOTO_STATION) || Station::Get(order->GetDestination())->dock_tile != INVALID_TILE)) {
01799     return false;
01800   }
01801 
01802   /* Otherwise set it, and determine the destination tile. */
01803   v->current_order = *order;
01804 
01805   InvalidateVehicleOrder(v, -2);
01806   switch (v->type) {
01807     default:
01808       NOT_REACHED();
01809 
01810     case VEH_ROAD:
01811     case VEH_TRAIN:
01812       break;
01813 
01814     case VEH_AIRCRAFT:
01815     case VEH_SHIP:
01816       SetWindowClassesDirty(GetWindowClassForVehicleType(v->type));
01817       break;
01818   }
01819 
01820   return UpdateOrderDest(v, order) && may_reverse;
01821 }
01822 
01830 bool Order::ShouldStopAtStation(const Vehicle *v, StationID station) const
01831 {
01832   bool is_dest_station = this->IsType(OT_GOTO_STATION) && this->dest == station;
01833   return
01834       (!this->IsType(OT_GOTO_DEPOT) || (this->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0) &&
01835       v->last_station_visited != station && // Do stop only when we've not just been there
01836       /* Finally do stop when there is no non-stop flag set for this type of station. */
01837       !(this->GetNonStopType() & (is_dest_station ? ONSF_NO_STOP_AT_DESTINATION_STATION : ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS));
01838 }
01839 
01840 void InitializeOrders()
01841 {
01842   _order_pool.CleanPool();
01843 
01844   _orderlist_pool.CleanPool();
01845 
01846   _backup_orders_tile = 0;
01847 }

Generated on Wed Feb 17 23:06:49 2010 for OpenTTD by  doxygen 1.6.1