src/order_base.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file order_base.h Base class for orders. */
  11
  12 #ifndef ORDER_BASE_H
  13 #define ORDER_BASE_H
  14
  15 #include "order_type.h"
  16 #include "core/pool_type.hpp"
  17 #include "core/bitmath_func.hpp"
  18 #include "cargo_type.h"
  19 #include "depot_type.h"
  20 #include "station_type.h"
  21 #include "vehicle_type.h"
  22 #include "date_type.h"
  23
  24 typedef Pool<Order, OrderID, 256, 64000> OrderPool;
  25 typedef Pool<OrderList, OrderListID, 128, 64000> OrderListPool;
  26 extern OrderPool _order_pool;
  27 extern OrderListPool _orderlist_pool;
  28
  29 /* If you change this, keep in mind that it is saved on 3 places:
  30  * - Load_ORDR, all the global orders
  31  * - Vehicle -> current_order
  32  * - REF_ORDER (all REFs are currently limited to 16 bits!!)
  33  */
  34 struct Order : OrderPool::PoolItem<&_order_pool> {
  35 private:
  36         friend const struct SaveLoad *GetVehicleDescription(VehicleType vt); ///< Saving and loading the current order of vehicles.
  37         friend void Load_VEHS();                                             ///< Loading of ancient vehicles.
  38         friend const struct SaveLoad *GetOrderDescription();                 ///< Saving and loading of orders.
  39
  40         uint8 type;           ///< The type of order + non-stop flags
  41         uint8 flags;          ///< Load/unload types, depot order/action types.
  42         DestinationID dest;   ///< The destination of the order.
  43
  44         CargoID refit_cargo;  ///< Refit CargoID
  45
  46         uint16 wait_time;    ///< How long in ticks to wait at the destination.
  47         uint16 travel_time;  ///< How long in ticks the journey to this destination should take.
  48         uint16 max_speed;    ///< How fast the vehicle may go on the way to the destination.
  49
  50 public:
  51         Order *next;          ///< Pointer to next order. If NULL, end of list
  52
  53         Order() : refit_cargo(CT_NO_REFIT), max_speed(UINT16_MAX) {}
  54         ~Order();
  55
  56         Order(uint32 packed);
  57
  58         /**
  59          * Check whether this order is of the given type.
  60          * @param type the type to check against.
  61          * @return true if the order matches.
  62          */
  63         inline bool IsType(OrderType type) const { return this->GetType() == type; }
  64
  65         /**
  66          * Get the type of order of this order.
  67          * @return the order type.
  68          */
  69         inline OrderType GetType() const { return (OrderType)GB(this->type, 0, 4); }
  70
  71         void Free();
  72
  73         void MakeGoToStation(StationID destination);
  74         void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type = ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action = ODATF_SERVICE_ONLY, CargoID cargo = CT_NO_REFIT);
  75         void MakeGoToWaypoint(StationID destination);
  76         void MakeLoading(bool ordered);
  77         void MakeLeaveStation();
  78         void MakeDummy();
  79         void MakeConditional(VehicleOrderID order);
  80         void MakeImplicit(StationID destination);
  81
  82         /**
  83          * Is this a 'goto' order with a real destination?
  84          * @return True if the type is either #OT_GOTO_WAYPOINT, #OT_GOTO_DEPOT or #OT_GOTO_STATION.
  85          */
  86         inline bool IsGotoOrder() const
  87         {
  88                 return IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION);
  89         }
  90
  91         /**
  92          * Gets the destination of this order.
  93          * @pre IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).
  94          * @return the destination of the order.
  95          */
  96         inline DestinationID GetDestination() const { return this->dest; }
  97
  98         /**
  99          * Sets the destination of this order.
 100          * @param destination the new destination of the order.
 101          * @pre IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).
 102          */
 103         inline void SetDestination(DestinationID destination) { this->dest = destination; }
 104
 105         /**
 106          * Is this order a refit order.
 107          * @pre IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
 108          * @return true if a refit should happen.
 109          */
 110         inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO || this->refit_cargo == CT_AUTO_REFIT; }
 111
 112         /**
 113          * Is this order a auto-refit order.
 114          * @pre IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
 115          * @return true if a auto-refit should happen.
 116          */
 117         inline bool IsAutoRefit() const { return this->refit_cargo == CT_AUTO_REFIT; }
 118
 119         /**
 120          * Get the cargo to to refit to.
 121          * @pre IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
 122          * @return the cargo type.
 123          */
 124         inline CargoID GetRefitCargo() const { return this->refit_cargo; }
 125
 126         void SetRefit(CargoID cargo);
 127
 128         /** How must the consist be loaded? */
 129         inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 3); }
 130         /** How must the consist be unloaded? */
 131         inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 3); }
 132         /** At which stations must we stop? */
 133         inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
 134         /** Where must we stop at the platform? */
 135         inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
 136         /** What caused us going to the depot? */
 137         inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 3); }
 138         /** What are we going to do when in the depot. */
 139         inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 4, 3); }
 140         /** What variable do we have to compare? */
 141         inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
 142         /** What is the comparator to use? */
 143         inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
 144         /** Get the order to skip to. */
 145         inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
 146         /** Get the value to base the skip on. */
 147         inline uint16 GetConditionValue() const { return GB(this->dest, 0, 11); }
 148
 149         /** Set how the consist must be loaded. */
 150         inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 3, load_type); }
 151         /** Set how the consist must be unloaded. */
 152         inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 3, unload_type); }
 153         /** Set whether we must stop at stations or not. */
 154         inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
 155         /** Set where we must stop at the platform. */
 156         inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
 157         /** Set the cause to go to the depot. */
 158         inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 3, depot_order_type); }
 159         /** Set what we are going to do in the depot. */
 160         inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 4, 3, depot_service_type); }
 161         /** Set variable we have to compare. */
 162         inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
 163         /** Set the comparator to use. */
 164         inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
 165         /** Get the order to skip to. */
 166         inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
 167         /** Set the value to base the skip on. */
 168         inline void SetConditionValue(uint16 value) { SB(this->dest, 0, 11, value); }
 169
 170         /* As conditional orders write their "skip to" order all over the flags, we cannot check the
 171          * flags to find out if timetabling is enabled. However, as conditional orders are never
 172          * autofilled we can be sure that any non-zero values for their wait_time and travel_time are
 173          * explicitly set (but travel_time is actually unused for conditionals). */
 174
 175         /** Does this order have an explicit wait time set? */
 176         inline bool IsWaitTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->wait_time > 0 : HasBit(this->flags, 3); }
 177         /** Does this order have an explicit travel time set? */
 178         inline bool IsTravelTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->travel_time > 0 : HasBit(this->flags, 7); }
 179
 180         /** Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled. */
 181         inline uint16 GetTimetabledWait() const { return this->IsWaitTimetabled() ? this->wait_time : 0; }
 182         /** Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled. */
 183         inline uint16 GetTimetabledTravel() const { return this->IsTravelTimetabled() ? this->travel_time : 0; }
 184         /** Get the time in ticks a vehicle will probably wait at the destination (timetabled or not). */
 185         inline uint16 GetWaitTime() const { return this->wait_time; }
 186         /** Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not). */
 187         inline uint16 GetTravelTime() const { return this->travel_time; }
 188
 189         /**
 190          * Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the
 191          * destination.
 192          * @return maximum speed.
 193          */
 194         inline uint16 GetMaxSpeed() const { return this->max_speed; }
 195
 196         /** Set if the wait time is explicitly timetabled (unless the order is conditional). */
 197         inline void SetWaitTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 3, 1, timetabled ? 1 : 0); }
 198         /** Set if the travel time is explicitly timetabled (unless the order is conditional). */
 199         inline void SetTravelTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 7, 1, timetabled ? 1 : 0); }
 200
 201         /**
 202          * Set the time in ticks to wait at the destination.
 203          * @param time Time to set as wait time.
 204          */
 205         inline void SetWaitTime(uint16 time) { this->wait_time = time;  }
 206
 207         /**
 208          * Set the time in ticks to take for travelling to the destination.
 209          * @param time Time to set as travel time.
 210          */
 211         inline void SetTravelTime(uint16 time) { this->travel_time = time; }
 212
 213         /**
 214          * Set the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the
 215          * destination.
 216          * @param speed Speed to be set.
 217          */
 218         inline void SetMaxSpeed(uint16 speed) { this->max_speed = speed; }
 219
 220         bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
 221         bool CanLoadOrUnload() const;
 222         bool CanLeaveWithCargo(bool has_cargo) const;
 223
 224         TileIndex GetLocation(const Vehicle *v, bool airport = false) const;
 225
 226         /** Checks if travel_time and wait_time apply to this order and if they are timetabled. */
 227         inline bool IsCompletelyTimetabled() const
 228         {
 229                 if (!this->IsTravelTimetabled() && !this->IsType(OT_CONDITIONAL)) return false;
 230                 if (!this->IsWaitTimetabled() && this->IsType(OT_GOTO_STATION) &&
 231                                 !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) {
 232                         return false;
 233                 }
 234                 return true;
 235         }
 236
 237         void AssignOrder(const Order &other);
 238         bool Equals(const Order &other) const;
 239
 240         uint32 Pack() const;
 241         uint16 MapOldOrder() const;
 242         void ConvertFromOldSavegame();
 243 };
 244
 245 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord);
 246 void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord);
 247
 248 /**
 249  * Shared order list linking together the linked list of orders and the list
 250  *  of vehicles sharing this order list.
 251  */
 252 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
 253 private:
 254         friend void AfterLoadVehicles(bool part_of_load); ///< For instantiating the shared vehicle chain
 255         friend const struct SaveLoad *GetOrderListDescription(); ///< Saving and loading of order lists.
 256
 257         StationID GetBestLoadableNext(const Vehicle *v, const Order *o1, const Order *o2) const;
 258
 259         Order *first;                     ///< First order of the order list.
 260         VehicleOrderID num_orders;        ///< NOSAVE: How many orders there are in the list.
 261         VehicleOrderID num_manual_orders; ///< NOSAVE: How many manually added orders are there in the list.
 262         uint num_vehicles;                ///< NOSAVE: Number of vehicles that share this order list.
 263         Vehicle *first_shared;            ///< NOSAVE: pointer to the first vehicle in the shared order chain.
 264
 265         Ticks timetable_duration;         ///< NOSAVE: Total timetabled duration of the order list.
 266         Ticks total_duration;             ///< NOSAVE: Total (timetabled or not) duration of the order list.
 267
 268 public:
 269         /** Default constructor producing an invalid order list. */
 270         OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
 271                 : first(NULL), num_orders(num_orders), num_manual_orders(0), num_vehicles(0), first_shared(NULL),
 272                   timetable_duration(0), total_duration(0) { }
 273
 274         /**
 275          * Create an order list with the given order chain for the given vehicle.
 276          *  @param chain pointer to the first order of the order chain
 277          *  @param v any vehicle using this orderlist
 278          */
 279         OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
 280
 281         /** Destructor. Invalidates OrderList for re-usage by the pool. */
 282         ~OrderList() {}
 283
 284         void Initialize(Order *chain, Vehicle *v);
 285
 286         /**
 287          * Get the first order of the order chain.
 288          * @return the first order of the chain.
 289          */
 290         inline Order *GetFirstOrder() const { return this->first; }
 291
 292         Order *GetOrderAt(int index) const;
 293
 294         /**
 295          * Get the last order of the order chain.
 296          * @return the last order of the chain.
 297          */
 298         inline Order *GetLastOrder() const { return this->GetOrderAt(this->num_orders - 1); }
 299
 300         /**
 301          * Get the order after the given one or the first one, if the given one is the
 302          * last one.
 303          * @param curr Order to find the next one for.
 304          * @return Next order.
 305          */
 306         inline const Order *GetNext(const Order *curr) const { return (curr->next == NULL) ? this->GetFirstOrder() : curr->next; }
 307
 308         /**
 309          * Get number of orders in the order list.
 310          * @return number of orders in the chain.
 311          */
 312         inline VehicleOrderID GetNumOrders() const { return this->num_orders; }
 313
 314         /**
 315          * Get number of manually added orders in the order list.
 316          * @return number of manual orders in the chain.
 317          */
 318         inline VehicleOrderID GetNumManualOrders() const { return this->num_manual_orders; }
 319
 320         StationIDStack GetNextStoppingStation(const Vehicle *v, const Order *first = NULL, uint hops = 0) const;
 321         const Order *GetNextDecisionNode(const Order *next, uint hops) const;
 322
 323         void InsertOrderAt(Order *new_order, int index);
 324         void DeleteOrderAt(int index);
 325         void MoveOrder(int from, int to);
 326
 327         /**
 328          * Is this a shared order list?
 329          * @return whether this order list is shared among multiple vehicles
 330          */
 331         inline bool IsShared() const { return this->num_vehicles > 1; };
 332
 333         /**
 334          * Get the first vehicle of this vehicle chain.
 335          * @return the first vehicle of the chain.
 336          */
 337         inline Vehicle *GetFirstSharedVehicle() const { return this->first_shared; }
 338
 339         /**
 340          * Return the number of vehicles that share this orders list
 341          * @return the count of vehicles that use this shared orders list
 342          */
 343         inline uint GetNumVehicles() const { return this->num_vehicles; }
 344
 345         bool IsVehicleInSharedOrdersList(const Vehicle *v) const;
 346         int GetPositionInSharedOrderList(const Vehicle *v) const;
 347
 348         /**
 349          * Adds the given vehicle to this shared order list.
 350          * @note This is supposed to be called after the vehicle has been inserted
 351          *       into the shared vehicle chain.
 352          * @param v vehicle to add to the list
 353          */
 354         inline void AddVehicle(Vehicle *v) { ++this->num_vehicles; }
 355
 356         void RemoveVehicle(Vehicle *v);
 357
 358         bool IsCompleteTimetable() const;
 359
 360         /**
 361          * Gets the total duration of the vehicles timetable or INVALID_TICKS is the timetable is not complete.
 362          * @return total timetable duration or INVALID_TICKS for incomplete timetables
 363          */
 364         inline Ticks GetTimetableTotalDuration() const { return this->IsCompleteTimetable() ? this->timetable_duration : INVALID_TICKS; }
 365
 366         /**
 367          * Gets the known duration of the vehicles timetable even if the timetable is not complete.
 368          * @return known timetable duration
 369          */
 370         inline Ticks GetTimetableDurationIncomplete() const { return this->timetable_duration; }
 371
 372         /**
 373          * Gets the known duration of the vehicles orders, timetabled or not.
 374          * @return  known order duration.
 375          */
 376         inline Ticks GetTotalDuration() const { return this->total_duration; }
 377
 378         /**
 379          * Must be called if an order's timetable is changed to update internal book keeping.
 380          * @param delta By how many ticks has the timetable duration changed
 381          */
 382         void UpdateTimetableDuration(Ticks delta) { this->timetable_duration += delta; }
 383
 384         /**
 385          * Must be called if an order's timetable is changed to update internal book keeping.
 386          * @param delta By how many ticks has the total duration changed
 387          */
 388         void UpdateTotalDuration(Ticks delta) { this->total_duration += delta; }
 389
 390         void FreeChain(bool keep_orderlist = false);
 391
 392         void DebugCheckSanity() const;
 393 };
 394
 395 #define FOR_ALL_ORDERS_FROM(var, start) FOR_ALL_ITEMS_FROM(Order, order_index, var, start)
 396 #define FOR_ALL_ORDERS(var) FOR_ALL_ORDERS_FROM(var, 0)
 397
 398
 399 #define FOR_VEHICLE_ORDERS(v, order) for (order = (v->orders.list == NULL) ? NULL : v->orders.list->GetFirstOrder(); order != NULL; order = order->next)
 400
 401
 402 #define FOR_ALL_ORDER_LISTS_FROM(var, start) FOR_ALL_ITEMS_FROM(OrderList, orderlist_index, var, start)
 403 #define FOR_ALL_ORDER_LISTS(var) FOR_ALL_ORDER_LISTS_FROM(var, 0)
 404
 405 #endif /* ORDER_BASE_H */