Add: Implement 2D map scrolling under SDL2 (#13167)
[openttd-github.git] / src / linkgraph / refresh.cpp
blobfc62ace093ccd7286f0e5476498bbf0d938a5af7
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 */
8 /** @file refresh.h Definition of link refreshing utility. */
10 #include "../stdafx.h"
11 #include "../core/bitmath_func.hpp"
12 #include "../station_func.h"
13 #include "../engine_base.h"
14 #include "../vehicle_func.h"
15 #include "refresh.h"
16 #include "linkgraph.h"
18 #include "../safeguards.h"
20 /**
21 * Refresh all links the given vehicle will visit.
22 * @param v Vehicle to refresh links for.
23 * @param allow_merge If the refresher is allowed to merge or extend link graphs.
24 * @param is_full_loading If the vehicle is full loading.
26 /* static */ void LinkRefresher::Run(Vehicle *v, bool allow_merge, bool is_full_loading)
28 /* If there are no orders we can't predict anything.*/
29 if (v->orders == nullptr) return;
31 /* Make sure the first order is a useful order. */
32 const Order *first = v->orders->GetNextDecisionNode(v->GetOrder(v->cur_implicit_order_index), 0);
33 if (first == nullptr) return;
35 HopSet seen_hops;
36 LinkRefresher refresher(v, &seen_hops, allow_merge, is_full_loading);
38 refresher.RefreshLinks(first, first, v->last_loading_station != INVALID_STATION ? 1 << HAS_CARGO : 0);
41 /**
42 * Comparison operator to allow hops to be used in a std::set.
43 * @param other Other hop to be compared with.
44 * @return If this hop is "smaller" than the other (defined by from, to and cargo in this order).
46 bool LinkRefresher::Hop::operator<(const Hop &other) const
48 if (this->from < other.from) {
49 return true;
50 } else if (this->from > other.from) {
51 return false;
53 if (this->to < other.to) {
54 return true;
55 } else if (this->to > other.to) {
56 return false;
58 return this->cargo < other.cargo;
61 /**
62 * Constructor for link refreshing algorithm.
63 * @param vehicle Vehicle to refresh links for.
64 * @param seen_hops Set of hops already seen. This is shared between this
65 * refresher and all its children.
66 * @param allow_merge If the refresher is allowed to merge or extend link graphs.
67 * @param is_full_loading If the vehicle is full loading.
69 LinkRefresher::LinkRefresher(Vehicle *vehicle, HopSet *seen_hops, bool allow_merge, bool is_full_loading) :
70 vehicle(vehicle), seen_hops(seen_hops), cargo(INVALID_CARGO), allow_merge(allow_merge),
71 is_full_loading(is_full_loading)
73 /* Assemble list of capacities and set last loading stations to 0. */
74 for (Vehicle *v = this->vehicle; v != nullptr; v = v->Next()) {
75 this->refit_capacities.push_back(RefitDesc(v->cargo_type, v->cargo_cap, v->refit_cap));
76 if (v->refit_cap > 0) {
77 assert(v->cargo_type < NUM_CARGO);
78 this->capacities[v->cargo_type] += v->refit_cap;
83 /**
84 * Handle refit orders by updating capacities and refit_capacities.
85 * @param refit_cargo Cargo to refit to.
86 * @return True if any vehicle was refit; false if none was.
88 bool LinkRefresher::HandleRefit(CargoID refit_cargo)
90 this->cargo = refit_cargo;
91 RefitList::iterator refit_it = this->refit_capacities.begin();
92 bool any_refit = false;
93 for (Vehicle *v = this->vehicle; v != nullptr; v = v->Next()) {
94 const Engine *e = Engine::Get(v->engine_type);
95 if (!HasBit(e->info.refit_mask, this->cargo)) {
96 ++refit_it;
97 continue;
99 any_refit = true;
101 /* Back up the vehicle's cargo type */
102 CargoID temp_cid = v->cargo_type;
103 uint8_t temp_subtype = v->cargo_subtype;
104 v->cargo_type = this->cargo;
105 v->cargo_subtype = GetBestFittingSubType(v, v, this->cargo);
107 uint16_t mail_capacity = 0;
108 uint amount = e->DetermineCapacity(v, &mail_capacity);
110 /* Restore the original cargo type */
111 v->cargo_type = temp_cid;
112 v->cargo_subtype = temp_subtype;
114 /* Skip on next refit. */
115 if (this->cargo != refit_it->cargo && refit_it->remaining > 0) {
116 this->capacities[refit_it->cargo] -= refit_it->remaining;
117 refit_it->remaining = 0;
118 } else if (amount < refit_it->remaining) {
119 this->capacities[refit_it->cargo] -= refit_it->remaining - amount;
120 refit_it->remaining = amount;
122 refit_it->capacity = amount;
123 refit_it->cargo = this->cargo;
125 ++refit_it;
127 /* Special case for aircraft with mail. */
128 if (v->type == VEH_AIRCRAFT) {
129 if (mail_capacity < refit_it->remaining) {
130 this->capacities[refit_it->cargo] -= refit_it->remaining - mail_capacity;
131 refit_it->remaining = mail_capacity;
133 refit_it->capacity = mail_capacity;
134 break; // aircraft have only one vehicle
137 return any_refit;
141 * Restore capacities and refit_capacities as vehicle might have been able to load now.
143 void LinkRefresher::ResetRefit()
145 for (auto &it : this->refit_capacities) {
146 if (it.remaining == it.capacity) continue;
147 this->capacities[it.cargo] += it.capacity - it.remaining;
148 it.remaining = it.capacity;
153 * Predict the next order the vehicle will execute and resolve conditionals by
154 * recursion and return next non-conditional order in list.
155 * @param cur Current order being evaluated.
156 * @param next Next order to be evaluated.
157 * @param flags RefreshFlags to give hints about the previous link and state carried over from that.
158 * @param num_hops Number of hops already taken by recursive calls to this method.
159 * @return new next Order.
161 const Order *LinkRefresher::PredictNextOrder(const Order *cur, const Order *next, uint8_t flags, uint num_hops)
163 /* next is good if it's either nullptr (then the caller will stop the
164 * evaluation) or if it's not conditional and the caller allows it to be
165 * chosen (by setting USE_NEXT). */
166 while (next != nullptr && (!HasBit(flags, USE_NEXT) || next->IsType(OT_CONDITIONAL))) {
168 /* After the first step any further non-conditional order is good,
169 * regardless of previous USE_NEXT settings. The case of cur and next or
170 * their respective stations being equal is handled elsewhere. */
171 SetBit(flags, USE_NEXT);
173 if (next->IsType(OT_CONDITIONAL)) {
174 const Order *skip_to = this->vehicle->orders->GetNextDecisionNode(
175 this->vehicle->orders->GetOrderAt(next->GetConditionSkipToOrder()), num_hops);
176 if (skip_to != nullptr && num_hops < this->vehicle->orders->GetNumOrders()) {
177 /* Make copies of capacity tracking lists. There is potential
178 * for optimization here: If the vehicle never refits we don't
179 * need to copy anything. Also, if we've seen the branched link
180 * before we don't need to branch at all. */
181 LinkRefresher branch(*this);
182 branch.RefreshLinks(cur, skip_to, flags, num_hops + 1);
186 /* Reassign next with the following stop. This can be a station or a
187 * depot.*/
188 next = this->vehicle->orders->GetNextDecisionNode(
189 this->vehicle->orders->GetNext(next), num_hops++);
191 return next;
195 * Refresh link stats for the given pair of orders.
196 * @param cur Last stop where the consist could interact with cargo.
197 * @param next Next order to be processed.
199 void LinkRefresher::RefreshStats(const Order *cur, const Order *next)
201 StationID next_station = next->GetDestination();
202 Station *st = Station::GetIfValid(cur->GetDestination());
203 if (st != nullptr && next_station != INVALID_STATION && next_station != st->index) {
204 Station *st_to = Station::Get(next_station);
205 for (CargoID c = 0; c < NUM_CARGO; c++) {
206 /* Refresh the link and give it a minimum capacity. */
208 uint cargo_quantity = this->capacities[c];
209 if (cargo_quantity == 0) continue;
211 if (this->vehicle->GetDisplayMaxSpeed() == 0) continue;
213 /* If not allowed to merge link graphs, make sure the stations are
214 * already in the same link graph. */
215 if (!this->allow_merge && st->goods[c].link_graph != st_to->goods[c].link_graph) {
216 continue;
219 /* A link is at least partly restricted if a vehicle can't load at its source. */
220 EdgeUpdateMode restricted_mode = (cur->GetLoadType() & OLFB_NO_LOAD) == 0 ?
221 EUM_UNRESTRICTED : EUM_RESTRICTED;
222 /* This estimates the travel time of the link as the time needed
223 * to travel between the stations at half the max speed of the consist.
224 * The result is in tiles/tick (= 2048 km-ish/h). */
225 uint32_t time_estimate = DistanceManhattan(st->xy, st_to->xy) * 4096U / this->vehicle->GetDisplayMaxSpeed();
227 /* If the vehicle is currently full loading, increase the capacities at the station
228 * where it is loading by an estimate of what it would have transported if it wasn't
229 * loading. Don't do that if the vehicle has been waiting for longer than the entire
230 * order list is supposed to take, though. If that is the case the total duration is
231 * probably far off and we'd greatly overestimate the capacity by increasing.*/
232 if (this->is_full_loading && this->vehicle->orders != nullptr &&
233 st->index == vehicle->last_station_visited &&
234 this->vehicle->orders->GetTotalDuration() > this->vehicle->current_order_time) {
235 uint effective_capacity = cargo_quantity * this->vehicle->load_unload_ticks;
236 if (effective_capacity > (uint)this->vehicle->orders->GetTotalDuration()) {
237 IncreaseStats(st, c, next_station, effective_capacity /
238 this->vehicle->orders->GetTotalDuration(), 0, 0,
239 EUM_INCREASE | restricted_mode);
240 } else if (RandomRange(this->vehicle->orders->GetTotalDuration()) < effective_capacity) {
241 IncreaseStats(st, c, next_station, 1, 0, 0, EUM_INCREASE | restricted_mode);
242 } else {
243 IncreaseStats(st, c, next_station, cargo_quantity, 0, time_estimate, EUM_REFRESH | restricted_mode);
245 } else {
246 IncreaseStats(st, c, next_station, cargo_quantity, 0, time_estimate, EUM_REFRESH | restricted_mode);
253 * Iterate over orders starting at \a cur and \a next and refresh links
254 * associated with them. \a cur and \a next can be equal. If they're not they
255 * must be "neighbours" in their order list, which means \a next must be directly
256 * reachable from \a cur without passing any further OT_GOTO_STATION or
257 * OT_IMPLICIT orders in between.
258 * @param cur Current order being evaluated.
259 * @param next Next order to be checked.
260 * @param flags RefreshFlags to give hints about the previous link and state carried over from that.
261 * @param num_hops Number of hops already taken by recursive calls to this method.
263 void LinkRefresher::RefreshLinks(const Order *cur, const Order *next, uint8_t flags, uint num_hops)
265 while (next != nullptr) {
267 if ((next->IsType(OT_GOTO_DEPOT) || next->IsType(OT_GOTO_STATION)) && next->IsRefit()) {
268 SetBit(flags, WAS_REFIT);
269 if (!next->IsAutoRefit()) {
270 this->HandleRefit(next->GetRefitCargo());
271 } else if (!HasBit(flags, IN_AUTOREFIT)) {
272 SetBit(flags, IN_AUTOREFIT);
273 LinkRefresher backup(*this);
274 for (CargoID c = 0; c != NUM_CARGO; ++c) {
275 if (CargoSpec::Get(c)->IsValid() && this->HandleRefit(c)) {
276 this->RefreshLinks(cur, next, flags, num_hops);
277 *this = backup;
283 /* Only reset the refit capacities if the "previous" next is a station,
284 * meaning that either the vehicle was refit at the previous station or
285 * it wasn't at all refit during the current hop. */
286 if (HasBit(flags, WAS_REFIT) && (next->IsType(OT_GOTO_STATION) || next->IsType(OT_IMPLICIT))) {
287 SetBit(flags, RESET_REFIT);
288 } else {
289 ClrBit(flags, RESET_REFIT);
292 next = this->PredictNextOrder(cur, next, flags, num_hops);
293 if (next == nullptr) break;
294 Hop hop(cur->index, next->index, this->cargo);
295 if (this->seen_hops->find(hop) != this->seen_hops->end()) {
296 break;
297 } else {
298 this->seen_hops->insert(hop);
301 /* Don't use the same order again, but choose a new one in the next round. */
302 ClrBit(flags, USE_NEXT);
304 /* Skip resetting and link refreshing if next order won't do anything with cargo. */
305 if (!next->IsType(OT_GOTO_STATION) && !next->IsType(OT_IMPLICIT)) continue;
307 if (HasBit(flags, RESET_REFIT)) {
308 this->ResetRefit();
309 ClrBit(flags, RESET_REFIT);
310 ClrBit(flags, WAS_REFIT);
313 if (cur->IsType(OT_GOTO_STATION) || cur->IsType(OT_IMPLICIT)) {
314 if (cur->CanLeaveWithCargo(HasBit(flags, HAS_CARGO))) {
315 SetBit(flags, HAS_CARGO);
316 this->RefreshStats(cur, next);
317 } else {
318 ClrBit(flags, HAS_CARGO);
322 /* "cur" is only assigned here if the stop is a station so that
323 * whenever stats are to be increased two stations can be found. */
324 cur = next;