src/order_base.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file order_base.h Base class for orders. */
   9
  10 #ifndef ORDER_BASE_H
  11 #define ORDER_BASE_H
  12
  13 #include "order_type.h"
  14 #include "core/pool_type.hpp"
  15 #include "core/bitmath_func.hpp"
  16 #include "cargo_type.h"
  17 #include "depot_type.h"
  18 #include "station_type.h"
  19 #include "vehicle_type.h"
  20 #include "date_type.h"
  21
  22 typedef Pool<Order, OrderID, 256, 0xFF0000> OrderPool;
  23 typedef Pool<OrderList, OrderListID, 128, 64000> OrderListPool;
  24 extern OrderPool _order_pool;
  25 extern OrderListPool _orderlist_pool;
  26
  27 /* If you change this, keep in mind that it is saved on 3 places:
  28  * - Load_ORDR, all the global orders
  29  * - Vehicle -> current_order
  30  * - REF_ORDER (all REFs are currently limited to 16 bits!!)
  31  */
  32 struct Order : OrderPool::PoolItem<&_order_pool> {
  33 private:
  34         friend const struct SaveLoad *GetVehicleDescription(VehicleType vt); ///< Saving and loading the current order of vehicles.
  35         friend void Load_VEHS();                                             ///< Loading of ancient vehicles.
  36         friend const struct SaveLoad *GetOrderDescription();                 ///< Saving and loading of orders.
  37
  38         uint8 type;           ///< The type of order + non-stop flags
  39         uint8 flags;          ///< Load/unload types, depot order/action types.
  40         DestinationID dest;   ///< The destination of the order.
  41
  42         CargoID refit_cargo;  ///< Refit CargoID
  43
  44         uint16 wait_time;    ///< How long in ticks to wait at the destination.
  45         uint16 travel_time;  ///< How long in ticks the journey to this destination should take.
  46         uint16 max_speed;    ///< How fast the vehicle may go on the way to the destination.
  47
  48 public:
  49         Order *next;          ///< Pointer to next order. If nullptr, end of list
  50
  51         Order() : flags(0), refit_cargo(CT_NO_REFIT), max_speed(UINT16_MAX) {}
  52         ~Order();
  53
  54         Order(uint32 packed);
  55
  56         /**
  57          * Check whether this order is of the given type.
  58          * @param type the type to check against.
  59          * @return true if the order matches.
  60          */
  61         inline bool IsType(OrderType type) const { return this->GetType() == type; }
  62
  63         /**
  64          * Get the type of order of this order.
  65          * @return the order type.
  66          */
  67         inline OrderType GetType() const { return (OrderType)GB(this->type, 0, 4); }
  68
  69         void Free();
  70
  71         void MakeGoToStation(StationID destination);
  72         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);
  73         void MakeGoToWaypoint(StationID destination);
  74         void MakeLoading(bool ordered);
  75         void MakeLeaveStation();
  76         void MakeDummy();
  77         void MakeConditional(VehicleOrderID order);
  78         void MakeImplicit(StationID destination);
  79
  80         /**
  81          * Is this a 'goto' order with a real destination?
  82          * @return True if the type is either #OT_GOTO_WAYPOINT, #OT_GOTO_DEPOT or #OT_GOTO_STATION.
  83          */
  84         inline bool IsGotoOrder() const
  85         {
  86                 return IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION);
  87         }
  88
  89         /**
  90          * Gets the destination of this order.
  91          * @pre IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).
  92          * @return the destination of the order.
  93          */
  94         inline DestinationID GetDestination() const { return this->dest; }
  95
  96         /**
  97          * Sets the destination of this order.
  98          * @param destination the new destination of the order.
  99          * @pre IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).
 100          */
 101         inline void SetDestination(DestinationID destination) { this->dest = destination; }
 102
 103         /**
 104          * Is this order a refit order.
 105          * @pre IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
 106          * @return true if a refit should happen.
 107          */
 108         inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO || this->refit_cargo == CT_AUTO_REFIT; }
 109
 110         /**
 111          * Is this order a auto-refit order.
 112          * @pre IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
 113          * @return true if a auto-refit should happen.
 114          */
 115         inline bool IsAutoRefit() const { return this->refit_cargo == CT_AUTO_REFIT; }
 116
 117         /**
 118          * Get the cargo to to refit to.
 119          * @pre IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
 120          * @return the cargo type.
 121          */
 122         inline CargoID GetRefitCargo() const { return this->refit_cargo; }
 123
 124         void SetRefit(CargoID cargo);
 125
 126         /** How must the consist be loaded? */
 127         inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 3); }
 128         /** How must the consist be unloaded? */
 129         inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 3); }
 130         /** At which stations must we stop? */
 131         inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
 132         /** Where must we stop at the platform? */
 133         inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
 134         /** What caused us going to the depot? */
 135         inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 3); }
 136         /** What are we going to do when in the depot. */
 137         inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 4, 3); }
 138         /** What variable do we have to compare? */
 139         inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
 140         /** What is the comparator to use? */
 141         inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
 142         /** Get the order to skip to. */
 143         inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
 144         /** Get the value to base the skip on. */
 145         inline uint16 GetConditionValue() const { return GB(this->dest, 0, 11); }
 146
 147         /** Set how the consist must be loaded. */
 148         inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 3, load_type); }
 149         /** Set how the consist must be unloaded. */
 150         inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 3, unload_type); }
 151         /** Set whether we must stop at stations or not. */
 152         inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
 153         /** Set where we must stop at the platform. */
 154         inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
 155         /** Set the cause to go to the depot. */
 156         inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 3, depot_order_type); }
 157         /** Set what we are going to do in the depot. */
 158         inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 4, 3, depot_service_type); }
 159         /** Set variable we have to compare. */
 160         inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
 161         /** Set the comparator to use. */
 162         inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
 163         /** Get the order to skip to. */
 164         inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
 165         /** Set the value to base the skip on. */
 166         inline void SetConditionValue(uint16 value) { SB(this->dest, 0, 11, value); }
 167
 168         /* As conditional orders write their "skip to" order all over the flags, we cannot check the
 169          * flags to find out if timetabling is enabled. However, as conditional orders are never
 170          * autofilled we can be sure that any non-zero values for their wait_time and travel_time are
 171          * explicitly set (but travel_time is actually unused for conditionals). */
 172
 173         /** Does this order have an explicit wait time set? */
 174         inline bool IsWaitTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->wait_time > 0 : HasBit(this->flags, 3); }
 175         /** Does this order have an explicit travel time set? */
 176         inline bool IsTravelTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->travel_time > 0 : HasBit(this->flags, 7); }
 177
 178         /** Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled. */
 179         inline uint16 GetTimetabledWait() const { return this->IsWaitTimetabled() ? this->wait_time : 0; }
 180         /** Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled. */
 181         inline uint16 GetTimetabledTravel() const { return this->IsTravelTimetabled() ? this->travel_time : 0; }
 182         /** Get the time in ticks a vehicle will probably wait at the destination (timetabled or not). */
 183         inline uint16 GetWaitTime() const { return this->wait_time; }
 184         /** Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not). */
 185         inline uint16 GetTravelTime() const { return this->travel_time; }
 186
 187         /**
 188          * Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the
 189          * destination.
 190          * @return maximum speed.
 191          */
 192         inline uint16 GetMaxSpeed() const { return this->max_speed; }
 193
 194         /** Set if the wait time is explicitly timetabled (unless the order is conditional). */
 195         inline void SetWaitTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 3, 1, timetabled ? 1 : 0); }
 196         /** Set if the travel time is explicitly timetabled (unless the order is conditional). */
 197         inline void SetTravelTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 7, 1, timetabled ? 1 : 0); }
 198
 199         /**
 200          * Set the time in ticks to wait at the destination.
 201          * @param time Time to set as wait time.
 202          */
 203         inline void SetWaitTime(uint16 time) { this->wait_time = time;  }
 204
 205         /**
 206          * Set the time in ticks to take for travelling to the destination.
 207          * @param time Time to set as travel time.
 208          */
 209         inline void SetTravelTime(uint16 time) { this->travel_time = time; }
 210
 211         /**
 212          * Set the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the
 213          * destination.
 214          * @param speed Speed to be set.
 215          */
 216         inline void SetMaxSpeed(uint16 speed) { this->max_speed = speed; }
 217
 218         bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
 219         bool CanLoadOrUnload() const;
 220         bool CanLeaveWithCargo(bool has_cargo) const;
 221
 222         TileIndex GetLocation(const Vehicle *v, bool airport = false) const;
 223
 224         /** Checks if travel_time and wait_time apply to this order and if they are timetabled. */
 225         inline bool IsCompletelyTimetabled() const
 226         {
 227                 if (!this->IsTravelTimetabled() && !this->IsType(OT_CONDITIONAL)) return false;
 228                 if (!this->IsWaitTimetabled() && this->IsType(OT_GOTO_STATION) &&
 229                                 !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) {
 230                         return false;
 231                 }
 232                 return true;
 233         }
 234
 235         void AssignOrder(const Order &other);
 236         bool Equals(const Order &other) const;
 237
 238         uint32 Pack() const;
 239         uint16 MapOldOrder() const;
 240         void ConvertFromOldSavegame();
 241 };
 242
 243 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord);
 244 void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord);
 245
 246 /**
 247  * Shared order list linking together the linked list of orders and the list
 248  *  of vehicles sharing this order list.
 249  */
 250 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
 251 private:
 252         friend void AfterLoadVehicles(bool part_of_load); ///< For instantiating the shared vehicle chain
 253         friend const struct SaveLoad *GetOrderListDescription(); ///< Saving and loading of order lists.
 254
 255         StationID GetBestLoadableNext(const Vehicle *v, const Order *o1, const Order *o2) const;
 256
 257         Order *first;                     ///< First order of the order list.
 258         VehicleOrderID num_orders;        ///< NOSAVE: How many orders there are in the list.
 259         VehicleOrderID num_manual_orders; ///< NOSAVE: How many manually added orders are there in the list.
 260         uint num_vehicles;                ///< NOSAVE: Number of vehicles that share this order list.
 261         Vehicle *first_shared;            ///< NOSAVE: pointer to the first vehicle in the shared order chain.
 262
 263         Ticks timetable_duration;         ///< NOSAVE: Total timetabled duration of the order list.
 264         Ticks total_duration;             ///< NOSAVE: Total (timetabled or not) duration of the order list.
 265
 266 public:
 267         /** Default constructor producing an invalid order list. */
 268         OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
 269                 : first(nullptr), num_orders(num_orders), num_manual_orders(0), num_vehicles(0), first_shared(nullptr),
 270                   timetable_duration(0), total_duration(0) { }
 271
 272         /**
 273          * Create an order list with the given order chain for the given vehicle.
 274          *  @param chain pointer to the first order of the order chain
 275          *  @param v any vehicle using this orderlist
 276          */
 277         OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
 278
 279         /** Destructor. Invalidates OrderList for re-usage by the pool. */
 280         ~OrderList() {}
 281
 282         void Initialize(Order *chain, Vehicle *v);
 283
 284         void RecalculateTimetableDuration();
 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 == nullptr) ? 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 = nullptr, 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_VEHICLE_ORDERS(v, order) for (order = (v->orders.list == nullptr) ? nullptr : v->orders.list->GetFirstOrder(); order != nullptr; order = order->next)
 396
 397 #endif /* ORDER_BASE_H */