OpenTTD Source: src/station_gui.cpp Source File

OpenTTD Source 12.2

station_gui.cpp
Go to the documentation of this file.
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
10 #include "stdafx.h"
11 #include "debug.h"
12 #include "gui.h"
13 #include "textbuf_gui.h"
14 #include "company_func.h"
15 #include "command_func.h"
16 #include "vehicle_gui.h"
17 #include "cargotype.h"
18 #include "station_gui.h"
19 #include "strings_func.h"
20 #include "string_func.h"
21 #include "window_func.h"
22 #include "viewport_func.h"
23 #include "widgets/dropdown_func.h"
24 #include "station_base.h"
25 #include "waypoint_base.h"
26 #include "tilehighlight_func.h"
27 #include "company_base.h"
28 #include "sortlist_type.h"
29 #include "core/geometry_func.hpp"
30 #include "vehiclelist.h"
31 #include "town.h"
32 #include "linkgraph/linkgraph.h"
33 #include "zoom_func.h"
34
35 #include "widgets/station_widget.h"
36
37 #include "table/strings.h"
38
39 #include <set>
40 #include <vector>
41
42 #include "safeguards.h"
43
54 int DrawStationCoverageAreaText(int left, int right, int top, StationCoverageType sct, int rad, bool supplies)
55 {
56 TileIndex tile = TileVirtXY(_thd.pos.x, _thd.pos.y);
57 CargoTypes cargo_mask = 0;
58 if (_thd.drawstyle == HT_RECT && tile < MapSize()) {
59 CargoArray cargoes;
60 if (supplies) {
61 cargoes = GetProductionAroundTiles(tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE, rad);
62 } else {
63 cargoes = GetAcceptanceAroundTiles(tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE, rad);
64 }
65
66 /* Convert cargo counts to a set of cargo bits, and draw the result. */
67 for (CargoID i = 0; i < NUM_CARGO; i++) {
68 switch (sct) {
69 case SCT_PASSENGERS_ONLY: if (!IsCargoInClass(i, CC_PASSENGERS)) continue; break;
70 case SCT_NON_PASSENGERS_ONLY: if (IsCargoInClass(i, CC_PASSENGERS)) continue; break;
71 case SCT_ALL: break;
72 default: NOT_REACHED();
73 }
74 if (cargoes[i] >= (supplies ? 1U : 8U)) SetBit(cargo_mask, i);
75 }
76 }
77 SetDParam(0, cargo_mask);
78 return DrawStringMultiLine(left, right, top, INT32_MAX, supplies ? STR_STATION_BUILD_SUPPLIES_CARGO : STR_STATION_BUILD_ACCEPTS_CARGO);
79 }
80
85 static void FindStationsAroundSelection()
86 {
87 /* With distant join we don't know which station will be selected, so don't show any */
88 if (_ctrl_pressed) {
89 SetViewportCatchmentStation(nullptr, true);
90 return;
91 }
92
93 /* Tile area for TileHighlightData */
94 TileArea location(TileVirtXY(_thd.pos.x, _thd.pos.y), _thd.size.x / TILE_SIZE - 1, _thd.size.y / TILE_SIZE - 1);
95
96 /* Extended area by one tile */
97 uint x = TileX(location.tile);
98 uint y = TileY(location.tile);
99
100 int max_c = 1;
101 TileArea ta(TileXY(std::max<int>(0, x - max_c), std::max<int>(0, y - max_c)), TileXY(std::min<int>(MapMaxX(), x + location.w + max_c), std::min<int>(MapMaxY(), y + location.h + max_c)));
102
103 Station *adjacent = nullptr;
104
105 /* Direct loop instead of ForAllStationsAroundTiles as we are not interested in catchment area */
106 for (TileIndex tile : ta) {
107 if (IsTileType(tile, MP_STATION) && GetTileOwner(tile) == _local_company) {
108 Station *st = Station::GetByTile(tile);
109 if (st == nullptr) continue;
110 if (adjacent != nullptr && st != adjacent) {
111 /* Multiple nearby, distant join is required. */
112 adjacent = nullptr;
113 break;
114 }
115 adjacent = st;
116 }
117 }
118 SetViewportCatchmentStation(adjacent, true);
119 }
120
126 void CheckRedrawStationCoverage(const Window *w)
127 {
128 /* Test if ctrl state changed */
129 static bool _last_ctrl_pressed;
130 if (_ctrl_pressed != _last_ctrl_pressed) {
131 _thd.dirty = 0xff;
132 _last_ctrl_pressed = _ctrl_pressed;
133 }
134
135 if (_thd.dirty & 1) {
136 _thd.dirty &= ~1;
137 w->SetDirty();
138
139 if (_settings_client.gui.station_show_coverage && _thd.drawstyle == HT_RECT) {
140 FindStationsAroundSelection();
141 }
142 }
143 }
144
157 static void StationsWndShowStationRating(int left, int right, int y, CargoID type, uint amount, byte rating)
158 {
159 static const uint units_full = 576;
160 static const uint rating_full = 224;
161
162 const CargoSpec *cs = CargoSpec::Get(type);
163 if (!cs->IsValid()) return;
164
165 int padding = ScaleFontTrad(1);
166 int width = right - left;
167 int colour = cs->rating_colour;
168 TextColour tc = GetContrastColour(colour);
169 uint w = std::min(amount + 5, units_full) * width / units_full;
170
171 int height = GetCharacterHeight(FS_SMALL) + padding - 1;
172
173 if (amount > 30) {
174 /* Draw total cargo (limited) on station */
175 GfxFillRect(left, y, left + w - 1, y + height, colour);
176 } else {
177 /* Draw a (scaled) one pixel-wide bar of additional cargo meter, useful
178 * for stations with only a small amount (<=30) */
179 uint rest = ScaleFontTrad(amount) / 5;
180 if (rest != 0) {
181 GfxFillRect(left, y + height - rest, left + padding - 1, y + height, colour);
182 }
183 }
184
185 DrawString(left + padding, right, y, cs->abbrev, tc);
186
187 /* Draw green/red ratings bar (fits under the waiting bar) */
188 y += height + padding + 1;
189 GfxFillRect(left + padding, y, right - padding - 1, y + padding - 1, PC_RED);
190 w = std::min<uint>(rating, rating_full) * (width - padding - padding) / rating_full;
191 if (w != 0) GfxFillRect(left + padding, y, left + w - 1, y + padding - 1, PC_GREEN);
192 }
193
194 typedef GUIList<const Station*> GUIStationList;
195
199 class CompanyStationsWindow : public Window
200 {
201 protected:
202 /* Runtime saved values */
203 static Listing last_sorting;
204 static byte facilities; // types of stations of interest
205 static bool include_empty; // whether we should include stations without waiting cargo
206 static const CargoTypes cargo_filter_max;
207 static CargoTypes cargo_filter; // bitmap of cargo types to include
208
209 /* Constants for sorting stations */
210 static const StringID sorter_names[];
211 static GUIStationList::SortFunction * const sorter_funcs[];
212
213 GUIStationList stations;
214 Scrollbar *vscroll;
215 uint rating_width;
216
222 void BuildStationsList(const Owner owner)
223 {
224 if (!this->stations.NeedRebuild()) return;
225
226 Debug(misc, 3, "Building station list for company {}", owner);
227
228 this->stations.clear();
229
230 for (const Station *st : Station::Iterate()) {
231 if (st->owner == owner || (st->owner == OWNER_NONE && HasStationInUse(st->index, true, owner))) {
232 if (this->facilities & st->facilities) { // only stations with selected facilities
233 int num_waiting_cargo = 0;
234 for (CargoID j = 0; j < NUM_CARGO; j++) {
235 if (st->goods[j].HasRating()) {
236 num_waiting_cargo++; // count number of waiting cargo
237 if (HasBit(this->cargo_filter, j)) {
238 this->stations.push_back(st);
239 break;
240 }
241 }
242 }
243 /* stations without waiting cargo */
244 if (num_waiting_cargo == 0 && this->include_empty) {
245 this->stations.push_back(st);
246 }
247 }
248 }
249 }
250
251 this->stations.shrink_to_fit();
252 this->stations.RebuildDone();
253
254 this->vscroll->SetCount((uint)this->stations.size()); // Update the scrollbar
255 }
256
258 static bool StationNameSorter(const Station * const &a, const Station * const &b)
259 {
260 int r = strnatcmp(a->GetCachedName(), b->GetCachedName()); // Sort by name (natural sorting).
261 if (r == 0) return a->index < b->index;
262 return r < 0;
263 }
264
266 static bool StationTypeSorter(const Station * const &a, const Station * const &b)
267 {
268 return a->facilities < b->facilities;
269 }
270
272 static bool StationWaitingTotalSorter(const Station * const &a, const Station * const &b)
273 {
274 int diff = 0;
275
276 for (CargoID j : SetCargoBitIterator(cargo_filter)) {
277 diff += a->goods[j].cargo.TotalCount() - b->goods[j].cargo.TotalCount();
278 }
279
280 return diff < 0;
281 }
282
284 static bool StationWaitingAvailableSorter(const Station * const &a, const Station * const &b)
285 {
286 int diff = 0;
287
288 for (CargoID j : SetCargoBitIterator(cargo_filter)) {
289 diff += a->goods[j].cargo.AvailableCount() - b->goods[j].cargo.AvailableCount();
290 }
291
292 return diff < 0;
293 }
294
296 static bool StationRatingMaxSorter(const Station * const &a, const Station * const &b)
297 {
298 byte maxr1 = 0;
299 byte maxr2 = 0;
300
301 for (CargoID j : SetCargoBitIterator(cargo_filter)) {
302 if (a->goods[j].HasRating()) maxr1 = std::max(maxr1, a->goods[j].rating);
303 if (b->goods[j].HasRating()) maxr2 = std::max(maxr2, b->goods[j].rating);
304 }
305
306 return maxr1 < maxr2;
307 }
308
310 static bool StationRatingMinSorter(const Station * const &a, const Station * const &b)
311 {
312 byte minr1 = 255;
313 byte minr2 = 255;
314
315 for (CargoID j = 0; j < NUM_CARGO; j++) {
316 if (!HasBit(cargo_filter, j)) continue;
317 if (a->goods[j].HasRating()) minr1 = std::min(minr1, a->goods[j].rating);
318 if (b->goods[j].HasRating()) minr2 = std::min(minr2, b->goods[j].rating);
319 }
320
321 return minr1 > minr2;
322 }
323
325 void SortStationsList()
326 {
327 if (!this->stations.Sort()) return;
328
329 /* Set the modified widget dirty */
330 this->SetWidgetDirty(WID_STL_LIST);
331 }
332
333 public:
334 CompanyStationsWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
335 {
336 this->stations.SetListing(this->last_sorting);
337 this->stations.SetSortFuncs(this->sorter_funcs);
338 this->stations.ForceRebuild();
339 this->stations.NeedResort();
340 this->SortStationsList();
341
342 this->CreateNestedTree();
343 this->vscroll = this->GetScrollbar(WID_STL_SCROLLBAR);
344 this->FinishInitNested(window_number);
345 this->owner = (Owner)this->window_number;
346
347 uint8 index = 0;
348 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
349 if (HasBit(this->cargo_filter, cs->Index())) {
350 this->LowerWidget(WID_STL_CARGOSTART + index);
351 }
352 index++;
353 }
354
355 if (this->cargo_filter == this->cargo_filter_max) this->cargo_filter = _cargo_mask;
356
357 for (uint i = 0; i < 5; i++) {
358 if (HasBit(this->facilities, i)) this->LowerWidget(i + WID_STL_TRAIN);
359 }
360 this->SetWidgetLoweredState(WID_STL_NOCARGOWAITING, this->include_empty);
361
362 this->GetWidget<NWidgetCore>(WID_STL_SORTDROPBTN)->widget_data = this->sorter_names[this->stations.SortType()];
363 }
364
365 ~CompanyStationsWindow()
366 {
367 this->last_sorting = this->stations.GetListing();
368 }
369
370 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
371 {
372 switch (widget) {
373 case WID_STL_SORTBY: {
374 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
375 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
376 d.height += padding.height;
377 *size = maxdim(*size, d);
378 break;
379 }
380
381 case WID_STL_SORTDROPBTN: {
382 Dimension d = {0, 0};
383 for (int i = 0; this->sorter_names[i] != INVALID_STRING_ID; i++) {
384 d = maxdim(d, GetStringBoundingBox(this->sorter_names[i]));
385 }
386 d.width += padding.width;
387 d.height += padding.height;
388 *size = maxdim(*size, d);
389 break;
390 }
391
392 case WID_STL_LIST:
393 resize->height = std::max(FONT_HEIGHT_NORMAL, FONT_HEIGHT_SMALL + ScaleFontTrad(3));
394 size->height = WD_FRAMERECT_TOP + 5 * resize->height + WD_FRAMERECT_BOTTOM;
395
396 /* Determine appropriate width for mini station rating graph */
397 this->rating_width = 0;
398 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
399 this->rating_width = std::max(this->rating_width, GetStringBoundingBox(cs->abbrev).width);
400 }
401 /* Approximately match original 16 pixel wide rating bars by multiplying string width by 1.6 */
402 this->rating_width = this->rating_width * 16 / 10;
403 break;
404
405 case WID_STL_CARGOALL:
406 case WID_STL_FACILALL:
407 case WID_STL_NOCARGOWAITING: {
408 Dimension d = GetStringBoundingBox(widget == WID_STL_NOCARGOWAITING ? STR_ABBREV_NONE : STR_ABBREV_ALL);
409 d.width += padding.width + 2;
410 d.height += padding.height;
411 *size = maxdim(*size, d);
412 break;
413 }
414
415 default:
416 if (widget >= WID_STL_CARGOSTART) {
417 Dimension d = GetStringBoundingBox(_sorted_cargo_specs[widget - WID_STL_CARGOSTART]->abbrev);
418 d.width += padding.width + 2;
419 d.height += padding.height;
420 *size = maxdim(*size, d);
421 }
422 break;
423 }
424 }
425
426 void OnPaint() override
427 {
428 this->BuildStationsList((Owner)this->window_number);
429 this->SortStationsList();
430
431 this->DrawWidgets();
432 }
433
434 void DrawWidget(const Rect &r, int widget) const override
435 {
436 switch (widget) {
437 case WID_STL_SORTBY:
438 /* draw arrow pointing up/down for ascending/descending sorting */
439 this->DrawSortButtonState(WID_STL_SORTBY, this->stations.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
440 break;
441
442 case WID_STL_LIST: {
443 bool rtl = _current_text_dir == TD_RTL;
444 int max = std::min<size_t>(this->vscroll->GetPosition() + this->vscroll->GetCapacity(), this->stations.size());
445 int y = r.top + WD_FRAMERECT_TOP;
446 uint line_height = this->GetWidget<NWidgetBase>(widget)->resize_y;
447 /* Spacing between station name and first rating graph. */
448 int text_spacing = ScaleFontTrad(5);
449 /* Spacing between additional rating graphs. */
450 int rating_spacing = ScaleFontTrad(4);
451
452 for (int i = this->vscroll->GetPosition(); i < max; ++i) { // do until max number of stations of owner
453 const Station *st = this->stations[i];
454 assert(st->xy != INVALID_TILE);
455
456 /* Do not do the complex check HasStationInUse here, it may be even false
457 * when the order had been removed and the station list hasn't been removed yet */
458 assert(st->owner == owner || st->owner == OWNER_NONE);
459
460 SetDParam(0, st->index);
461 SetDParam(1, st->facilities);
462 int x = DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y + (line_height - FONT_HEIGHT_NORMAL) / 2, STR_STATION_LIST_STATION);
463 x += rtl ? -text_spacing : text_spacing;
464
465 /* show cargo waiting and station ratings */
466 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
467 CargoID cid = cs->Index();
468 if (st->goods[cid].cargo.TotalCount() > 0) {
469 /* For RTL we work in exactly the opposite direction. So
470 * decrement the space needed first, then draw to the left
471 * instead of drawing to the left and then incrementing
472 * the space. */
473 if (rtl) {
474 x -= rating_width + rating_spacing;
475 if (x < r.left + WD_FRAMERECT_LEFT) break;
476 }
477 StationsWndShowStationRating(x, x + rating_width, y, cid, st->goods[cid].cargo.TotalCount(), st->goods[cid].rating);
478 if (!rtl) {
479 x += rating_width + rating_spacing;
480 if (x > r.right - WD_FRAMERECT_RIGHT) break;
481 }
482 }
483 }
484 y += line_height;
485 }
486
487 if (this->vscroll->GetCount() == 0) { // company has no stations
488 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_STATION_LIST_NONE);
489 return;
490 }
491 break;
492 }
493
494 case WID_STL_NOCARGOWAITING: {
495 int cg_ofst = this->IsWidgetLowered(widget) ? 1 : 0;
496 DrawString(r.left + cg_ofst, r.right + cg_ofst, r.top + (r.bottom - r.top - FONT_HEIGHT_SMALL) / 2 + cg_ofst, STR_ABBREV_NONE, TC_BLACK, SA_HOR_CENTER);
497 break;
498 }
499
500 case WID_STL_CARGOALL: {
501 int cg_ofst = this->IsWidgetLowered(widget) ? 1 : 0;
502 DrawString(r.left + cg_ofst, r.right + cg_ofst, r.top + (r.bottom - r.top - FONT_HEIGHT_SMALL) / 2 + cg_ofst, STR_ABBREV_ALL, TC_BLACK, SA_HOR_CENTER);
503 break;
504 }
505
506 case WID_STL_FACILALL: {
507 int cg_ofst = this->IsWidgetLowered(widget) ? 1 : 0;
508 DrawString(r.left + cg_ofst, r.right + cg_ofst, r.top + (r.bottom - r.top - FONT_HEIGHT_SMALL) / 2 + cg_ofst, STR_ABBREV_ALL, TC_BLACK, SA_HOR_CENTER);
509 break;
510 }
511
512 default:
513 if (widget >= WID_STL_CARGOSTART) {
514 const CargoSpec *cs = _sorted_cargo_specs[widget - WID_STL_CARGOSTART];
515 int cg_ofst = HasBit(this->cargo_filter, cs->Index()) ? 1 : 0;
516 GfxFillRect(r.left + cg_ofst + 1, r.top + cg_ofst + 1, r.right - 1 + cg_ofst, r.bottom - 1 + cg_ofst, cs->rating_colour);
517 TextColour tc = GetContrastColour(cs->rating_colour);
518 DrawString(r.left + cg_ofst, r.right + cg_ofst, r.top + (r.bottom - r.top - FONT_HEIGHT_SMALL) / 2 + cg_ofst, cs->abbrev, tc, SA_HOR_CENTER);
519 }
520 break;
521 }
522 }
523
524 void SetStringParameters(int widget) const override
525 {
526 if (widget == WID_STL_CAPTION) {
527 SetDParam(0, this->window_number);
528 SetDParam(1, this->vscroll->GetCount());
529 }
530 }
531
532 void OnClick(Point pt, int widget, int click_count) override
533 {
534 switch (widget) {
535 case WID_STL_LIST: {
536 uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_STL_LIST);
537 if (id_v >= this->stations.size()) return; // click out of list bound
538
539 const Station *st = this->stations[id_v];
540 /* do not check HasStationInUse - it is slow and may be invalid */
541 assert(st->owner == (Owner)this->window_number || st->owner == OWNER_NONE);
542
543 if (_ctrl_pressed) {
544 ShowExtraViewportWindow(st->xy);
545 } else {
546 ScrollMainWindowToTile(st->xy);
547 }
548 break;
549 }
550
551 case WID_STL_TRAIN:
552 case WID_STL_TRUCK:
553 case WID_STL_BUS:
554 case WID_STL_AIRPLANE:
555 case WID_STL_SHIP:
556 if (_ctrl_pressed) {
557 ToggleBit(this->facilities, widget - WID_STL_TRAIN);
558 this->ToggleWidgetLoweredState(widget);
559 } else {
560 for (uint i : SetBitIterator(this->facilities)) {
561 this->RaiseWidget(i + WID_STL_TRAIN);
562 }
563 this->facilities = 1 << (widget - WID_STL_TRAIN);
564 this->LowerWidget(widget);
565 }
566 this->stations.ForceRebuild();
567 this->SetDirty();
568 break;
569
570 case WID_STL_FACILALL:
571 for (uint i = WID_STL_TRAIN; i <= WID_STL_SHIP; i++) {
572 this->LowerWidget(i);
573 }
574
575 this->facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;
576 this->stations.ForceRebuild();
577 this->SetDirty();
578 break;
579
580 case WID_STL_CARGOALL: {
581 for (uint i = 0; i < _sorted_standard_cargo_specs.size(); i++) {
582 this->LowerWidget(WID_STL_CARGOSTART + i);
583 }
584 this->LowerWidget(WID_STL_NOCARGOWAITING);
585
586 this->cargo_filter = _cargo_mask;
587 this->include_empty = true;
588 this->stations.ForceRebuild();
589 this->SetDirty();
590 break;
591 }
592
593 case WID_STL_SORTBY: // flip sorting method asc/desc
594 this->stations.ToggleSortOrder();
595 this->SetDirty();
596 break;
597
598 case WID_STL_SORTDROPBTN: // select sorting criteria dropdown menu
599 ShowDropDownMenu(this, this->sorter_names, this->stations.SortType(), WID_STL_SORTDROPBTN, 0, 0);
600 break;
601
602 case WID_STL_NOCARGOWAITING:
603 if (_ctrl_pressed) {
604 this->include_empty = !this->include_empty;
605 this->ToggleWidgetLoweredState(WID_STL_NOCARGOWAITING);
606 } else {
607 for (uint i = 0; i < _sorted_standard_cargo_specs.size(); i++) {
608 this->RaiseWidget(WID_STL_CARGOSTART + i);
609 }
610
611 this->cargo_filter = 0;
612 this->include_empty = true;
613
614 this->LowerWidget(WID_STL_NOCARGOWAITING);
615 }
616 this->stations.ForceRebuild();
617 this->SetDirty();
618 break;
619
620 default:
621 if (widget >= WID_STL_CARGOSTART) { // change cargo_filter
622 /* Determine the selected cargo type */
623 const CargoSpec *cs = _sorted_cargo_specs[widget - WID_STL_CARGOSTART];
624
625 if (_ctrl_pressed) {
626 ToggleBit(this->cargo_filter, cs->Index());
627 this->ToggleWidgetLoweredState(widget);
628 } else {
629 for (uint i = 0; i < _sorted_standard_cargo_specs.size(); i++) {
630 this->RaiseWidget(WID_STL_CARGOSTART + i);
631 }
632 this->RaiseWidget(WID_STL_NOCARGOWAITING);
633
634 this->cargo_filter = 0;
635 this->include_empty = false;
636
637 SetBit(this->cargo_filter, cs->Index());
638 this->LowerWidget(widget);
639 }
640 this->stations.ForceRebuild();
641 this->SetDirty();
642 }
643 break;
644 }
645 }
646
647 void OnDropdownSelect(int widget, int index) override
648 {
649 if (this->stations.SortType() != index) {
650 this->stations.SetSortType(index);
651
652 /* Display the current sort variant */
653 this->GetWidget<NWidgetCore>(WID_STL_SORTDROPBTN)->widget_data = this->sorter_names[this->stations.SortType()];
654
655 this->SetDirty();
656 }
657 }
658
659 void OnGameTick() override
660 {
661 if (this->stations.NeedResort()) {
662 Debug(misc, 3, "Periodic rebuild station list company {}", this->window_number);
663 this->SetDirty();
664 }
665 }
666
667 void OnResize() override
668 {
669 this->vscroll->SetCapacityFromWidget(this, WID_STL_LIST, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM);
670 }
671
677 void OnInvalidateData(int data = 0, bool gui_scope = true) override
678 {
679 if (data == 0) {
680 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
681 this->stations.ForceRebuild();
682 } else {
683 this->stations.ForceResort();
684 }
685 }
686 };
687
688 Listing CompanyStationsWindow::last_sorting = {false, 0};
689 byte CompanyStationsWindow::facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;
690 bool CompanyStationsWindow::include_empty = true;
691 const CargoTypes CompanyStationsWindow::cargo_filter_max = ALL_CARGOTYPES;
692 CargoTypes CompanyStationsWindow::cargo_filter = ALL_CARGOTYPES;
693
694 /* Available station sorting functions */
695 GUIStationList::SortFunction * const CompanyStationsWindow::sorter_funcs[] = {
696 &StationNameSorter,
697 &StationTypeSorter,
698 &StationWaitingTotalSorter,
699 &StationWaitingAvailableSorter,
700 &StationRatingMaxSorter,
701 &StationRatingMinSorter
702 };
703
704 /* Names of the sorting functions */
705 const StringID CompanyStationsWindow::sorter_names[] = {
706 STR_SORT_BY_NAME,
707 STR_SORT_BY_FACILITY,
708 STR_SORT_BY_WAITING_TOTAL,
709 STR_SORT_BY_WAITING_AVAILABLE,
710 STR_SORT_BY_RATING_MAX,
711 STR_SORT_BY_RATING_MIN,
712 INVALID_STRING_ID
713 };
714
720 static NWidgetBase *CargoWidgets(int *biggest_index)
721 {
722 NWidgetHorizontal *container = new NWidgetHorizontal();
723
724 for (uint i = 0; i < _sorted_standard_cargo_specs.size(); i++) {
725 NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_GREY, WID_STL_CARGOSTART + i);
726 panel->SetMinimalSize(14, 0);
727 panel->SetMinimalTextLines(1, 0, FS_NORMAL);
728 panel->SetResize(0, 0);
729 panel->SetFill(0, 1);
730 panel->SetDataTip(0, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE);
731 container->Add(panel);
732 }
733 *biggest_index = WID_STL_CARGOSTART + static_cast<int>(_sorted_standard_cargo_specs.size());
734 return container;
735 }
736
737 static const NWidgetPart _nested_company_stations_widgets[] = {
738 NWidget(NWID_HORIZONTAL),
739 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
740 NWidget(WWT_CAPTION, COLOUR_GREY, WID_STL_CAPTION), SetDataTip(STR_STATION_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
741 NWidget(WWT_SHADEBOX, COLOUR_GREY),
742 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
743 NWidget(WWT_STICKYBOX, COLOUR_GREY),
744 EndContainer(),
745 NWidget(NWID_HORIZONTAL),
746 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_TRAIN), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(STR_TRAIN, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE), SetFill(0, 1),
747 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_TRUCK), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(STR_LORRY, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE), SetFill(0, 1),
748 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_BUS), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(STR_BUS, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE), SetFill(0, 1),
749 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_SHIP), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(STR_SHIP, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE), SetFill(0, 1),
750 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_AIRPLANE), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(STR_PLANE, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE), SetFill(0, 1),
751 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_STL_FACILALL), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(0x0, STR_STATION_LIST_SELECT_ALL_FACILITIES), SetFill(0, 1),
752 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(5, 0), SetFill(0, 1), EndContainer(),
753 NWidgetFunction(CargoWidgets),
754 NWidget(WWT_PANEL, COLOUR_GREY, WID_STL_NOCARGOWAITING), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(0x0, STR_STATION_LIST_NO_WAITING_CARGO), SetFill(0, 1), EndContainer(),
755 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_STL_CARGOALL), SetMinimalSize(14, 0), SetMinimalTextLines(1, 0), SetDataTip(0x0, STR_STATION_LIST_SELECT_ALL_TYPES), SetFill(0, 1),
756 NWidget(WWT_PANEL, COLOUR_GREY), SetDataTip(0x0, STR_NULL), SetResize(1, 0), SetFill(1, 1), EndContainer(),
757 EndContainer(),
758 NWidget(NWID_HORIZONTAL),
759 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_STL_SORTBY), SetMinimalSize(81, 12), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
760 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_STL_SORTDROPBTN), SetMinimalSize(163, 12), SetDataTip(STR_SORT_BY_NAME, STR_TOOLTIP_SORT_CRITERIA), // widget_data gets overwritten.
761 NWidget(WWT_PANEL, COLOUR_GREY), SetDataTip(0x0, STR_NULL), SetResize(1, 0), SetFill(1, 1), EndContainer(),
762 EndContainer(),
763 NWidget(NWID_HORIZONTAL),
764 NWidget(WWT_PANEL, COLOUR_GREY, WID_STL_LIST), SetMinimalSize(346, 125), SetResize(1, 10), SetDataTip(0x0, STR_STATION_LIST_TOOLTIP), SetScrollbar(WID_STL_SCROLLBAR), EndContainer(),
765 NWidget(NWID_VERTICAL),
766 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_STL_SCROLLBAR),
767 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
768 EndContainer(),
769 EndContainer(),
770 };
771
772 static WindowDesc _company_stations_desc(
773 WDP_AUTO, "list_stations", 358, 162,
774 WC_STATION_LIST, WC_NONE,
775 0,
776 _nested_company_stations_widgets, lengthof(_nested_company_stations_widgets)
777 );
778
784 void ShowCompanyStations(CompanyID company)
785 {
786 if (!Company::IsValidID(company)) return;
787
788 AllocateWindowDescFront<CompanyStationsWindow>(&_company_stations_desc, company);
789 }
790
791 static const NWidgetPart _nested_station_view_widgets[] = {
792 NWidget(NWID_HORIZONTAL),
793 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
794 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SV_RENAME), SetMinimalSize(12, 14), SetDataTip(SPR_RENAME, STR_STATION_VIEW_RENAME_TOOLTIP),
795 NWidget(WWT_CAPTION, COLOUR_GREY, WID_SV_CAPTION), SetDataTip(STR_STATION_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
796 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SV_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_STATION_VIEW_CENTER_TOOLTIP),
797 NWidget(WWT_SHADEBOX, COLOUR_GREY),
798 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
799 NWidget(WWT_STICKYBOX, COLOUR_GREY),
800 EndContainer(),
801 NWidget(NWID_HORIZONTAL),
802 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SV_GROUP), SetMinimalSize(81, 12), SetFill(1, 1), SetDataTip(STR_STATION_VIEW_GROUP, 0x0),
803 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_SV_GROUP_BY), SetMinimalSize(168, 12), SetResize(1, 0), SetFill(0, 1), SetDataTip(0x0, STR_TOOLTIP_GROUP_ORDER),
804 EndContainer(),
805 NWidget(NWID_HORIZONTAL),
806 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_SORT_ORDER), SetMinimalSize(81, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
807 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_SV_SORT_BY), SetMinimalSize(168, 12), SetResize(1, 0), SetFill(0, 1), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
808 EndContainer(),
809 NWidget(NWID_HORIZONTAL),
810 NWidget(WWT_PANEL, COLOUR_GREY, WID_SV_WAITING), SetMinimalSize(237, 44), SetResize(1, 10), SetScrollbar(WID_SV_SCROLLBAR), EndContainer(),
811 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_SV_SCROLLBAR),
812 EndContainer(),
813 NWidget(WWT_PANEL, COLOUR_GREY, WID_SV_ACCEPT_RATING_LIST), SetMinimalSize(249, 23), SetResize(1, 0), EndContainer(),
814 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
815 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_ACCEPTS_RATINGS), SetMinimalSize(46, 12), SetResize(1, 0), SetFill(1, 1),
816 SetDataTip(STR_STATION_VIEW_RATINGS_BUTTON, STR_STATION_VIEW_RATINGS_TOOLTIP),
817 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SV_CLOSE_AIRPORT), SetMinimalSize(45, 12), SetResize(1, 0), SetFill(1, 1),
818 SetDataTip(STR_STATION_VIEW_CLOSE_AIRPORT, STR_STATION_VIEW_CLOSE_AIRPORT_TOOLTIP),
819 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SV_CATCHMENT), SetMinimalSize(45, 12), SetResize(1, 0), SetFill(1, 1), SetDataTip(STR_BUTTON_CATCHMENT, STR_TOOLTIP_CATCHMENT),
820 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_TRAINS), SetMinimalSize(14, 12), SetFill(0, 1), SetDataTip(STR_TRAIN, STR_STATION_VIEW_SCHEDULED_TRAINS_TOOLTIP),
821 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_ROADVEHS), SetMinimalSize(14, 12), SetFill(0, 1), SetDataTip(STR_LORRY, STR_STATION_VIEW_SCHEDULED_ROAD_VEHICLES_TOOLTIP),
822 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_SHIPS), SetMinimalSize(14, 12), SetFill(0, 1), SetDataTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
823 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_PLANES), SetMinimalSize(14, 12), SetFill(0, 1), SetDataTip(STR_PLANE, STR_STATION_VIEW_SCHEDULED_AIRCRAFT_TOOLTIP),
824 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
825 EndContainer(),
826 };
827
837 static void DrawCargoIcons(CargoID i, uint waiting, int left, int right, int y)
838 {
839 int width = ScaleGUITrad(10);
840 uint num = std::min<uint>((waiting + (width / 2)) / width, (right - left) / width); // maximum is width / 10 icons so it won't overflow
841 if (num == 0) return;
842
843 SpriteID sprite = CargoSpec::Get(i)->GetCargoIcon();
844
845 int x = _current_text_dir == TD_RTL ? left : right - num * width;
846 do {
847 DrawSprite(sprite, PAL_NONE, x, y);
848 x += width;
849 } while (--num);
850 }
851
852 enum SortOrder {
853 SO_DESCENDING,
854 SO_ASCENDING
855 };
856
857 class CargoDataEntry;
858
859 enum CargoSortType {
860 ST_AS_GROUPING,
861 ST_COUNT,
862 ST_STATION_STRING,
863 ST_STATION_ID,
864 ST_CARGO_ID,
865 };
866
867 class CargoSorter {
868 public:
869 CargoSorter(CargoSortType t = ST_STATION_ID, SortOrder o = SO_ASCENDING) : type(t), order(o) {}
870 CargoSortType GetSortType() {return this->type;}
871 bool operator()(const CargoDataEntry *cd1, const CargoDataEntry *cd2) const;
872
873 private:
874 CargoSortType type;
875 SortOrder order;
876
877 template<class Tid>
878 bool SortId(Tid st1, Tid st2) const;
879 bool SortCount(const CargoDataEntry *cd1, const CargoDataEntry *cd2) const;
880 bool SortStation (StationID st1, StationID st2) const;
881 };
882
883 typedef std::set<CargoDataEntry *, CargoSorter> CargoDataSet;
884
890 class CargoDataEntry {
891 public:
892 CargoDataEntry();
893 ~CargoDataEntry();
894
900 CargoDataEntry *InsertOrRetrieve(StationID station)
901 {
902 return this->InsertOrRetrieve<StationID>(station);
903 }
904
910 CargoDataEntry *InsertOrRetrieve(CargoID cargo)
911 {
912 return this->InsertOrRetrieve<CargoID>(cargo);
913 }
914
915 void Update(uint count);
916
921 void Remove(StationID station)
922 {
923 CargoDataEntry t(station);
924 this->Remove(&t);
925 }
926
931 void Remove(CargoID cargo)
932 {
933 CargoDataEntry t(cargo);
934 this->Remove(&t);
935 }
936
942 CargoDataEntry *Retrieve(StationID station) const
943 {
944 CargoDataEntry t(station);
945 return this->Retrieve(this->children->find(&t));
946 }
947
953 CargoDataEntry *Retrieve(CargoID cargo) const
954 {
955 CargoDataEntry t(cargo);
956 return this->Retrieve(this->children->find(&t));
957 }
958
959 void Resort(CargoSortType type, SortOrder order);
960
964 StationID GetStation() const { return this->station; }
965
969 CargoID GetCargo() const { return this->cargo; }
970
974 uint GetCount() const { return this->count; }
975
979 CargoDataEntry *GetParent() const { return this->parent; }
980
984 uint GetNumChildren() const { return this->num_children; }
985
989 CargoDataSet::iterator Begin() const { return this->children->begin(); }
990
994 CargoDataSet::iterator End() const { return this->children->end(); }
995
999 bool HasTransfers() const { return this->transfers; }
1000
1004 void SetTransfers(bool value) { this->transfers = value; }
1005
1006 void Clear();
1007 private:
1008
1009 CargoDataEntry(StationID st, uint c, CargoDataEntry *p);
1010 CargoDataEntry(CargoID car, uint c, CargoDataEntry *p);
1011 CargoDataEntry(StationID st);
1012 CargoDataEntry(CargoID car);
1013
1014 CargoDataEntry *Retrieve(CargoDataSet::iterator i) const;
1015
1016 template<class Tid>
1017 CargoDataEntry *InsertOrRetrieve(Tid s);
1018
1019 void Remove(CargoDataEntry *comp);
1020 void IncrementSize();
1021
1022 CargoDataEntry *parent;
1023 const union {
1024 StationID station;
1025 struct {
1026 CargoID cargo;
1027 bool transfers;
1028 };
1029 };
1030 uint num_children;
1031 uint count;
1032 CargoDataSet *children;
1033 };
1034
1035 CargoDataEntry::CargoDataEntry() :
1036 parent(nullptr),
1037 station(INVALID_STATION),
1038 num_children(0),
1039 count(0),
1040 children(new CargoDataSet(CargoSorter(ST_CARGO_ID)))
1041 {}
1042
1043 CargoDataEntry::CargoDataEntry(CargoID cargo, uint count, CargoDataEntry *parent) :
1044 parent(parent),
1045 cargo(cargo),
1046 num_children(0),
1047 count(count),
1048 children(new CargoDataSet)
1049 {}
1050
1051 CargoDataEntry::CargoDataEntry(StationID station, uint count, CargoDataEntry *parent) :
1052 parent(parent),
1053 station(station),
1054 num_children(0),
1055 count(count),
1056 children(new CargoDataSet)
1057 {}
1058
1059 CargoDataEntry::CargoDataEntry(StationID station) :
1060 parent(nullptr),
1061 station(station),
1062 num_children(0),
1063 count(0),
1064 children(nullptr)
1065 {}
1066
1067 CargoDataEntry::CargoDataEntry(CargoID cargo) :
1068 parent(nullptr),
1069 cargo(cargo),
1070 num_children(0),
1071 count(0),
1072 children(nullptr)
1073 {}
1074
1075 CargoDataEntry::~CargoDataEntry()
1076 {
1077 this->Clear();
1078 delete this->children;
1079 }
1080
1084 void CargoDataEntry::Clear()
1085 {
1086 if (this->children != nullptr) {
1087 for (CargoDataSet::iterator i = this->children->begin(); i != this->children->end(); ++i) {
1088 assert(*i != this);
1089 delete *i;
1090 }
1091 this->children->clear();
1092 }
1093 if (this->parent != nullptr) this->parent->count -= this->count;
1094 this->count = 0;
1095 this->num_children = 0;
1096 }
1097
1104 void CargoDataEntry::Remove(CargoDataEntry *child)
1105 {
1106 CargoDataSet::iterator i = this->children->find(child);
1107 if (i != this->children->end()) {
1108 delete *i;
1109 this->children->erase(i);
1110 }
1111 }
1112
1119 template<class Tid>
1120 CargoDataEntry *CargoDataEntry::InsertOrRetrieve(Tid child_id)
1121 {
1122 CargoDataEntry tmp(child_id);
1123 CargoDataSet::iterator i = this->children->find(&tmp);
1124 if (i == this->children->end()) {
1125 IncrementSize();
1126 return *(this->children->insert(new CargoDataEntry(child_id, 0, this)).first);
1127 } else {
1128 CargoDataEntry *ret = *i;
1129 assert(this->children->value_comp().GetSortType() != ST_COUNT);
1130 return ret;
1131 }
1132 }
1133
1139 void CargoDataEntry::Update(uint count)
1140 {
1141 this->count += count;
1142 if (this->parent != nullptr) this->parent->Update(count);
1143 }
1144
1148 void CargoDataEntry::IncrementSize()
1149 {
1150 ++this->num_children;
1151 if (this->parent != nullptr) this->parent->IncrementSize();
1152 }
1153
1154 void CargoDataEntry::Resort(CargoSortType type, SortOrder order)
1155 {
1156 CargoDataSet *new_subs = new CargoDataSet(this->children->begin(), this->children->end(), CargoSorter(type, order));
1157 delete this->children;
1158 this->children = new_subs;
1159 }
1160
1161 CargoDataEntry *CargoDataEntry::Retrieve(CargoDataSet::iterator i) const
1162 {
1163 if (i == this->children->end()) {
1164 return nullptr;
1165 } else {
1166 assert(this->children->value_comp().GetSortType() != ST_COUNT);
1167 return *i;
1168 }
1169 }
1170
1171 bool CargoSorter::operator()(const CargoDataEntry *cd1, const CargoDataEntry *cd2) const
1172 {
1173 switch (this->type) {
1174 case ST_STATION_ID:
1175 return this->SortId<StationID>(cd1->GetStation(), cd2->GetStation());
1176 case ST_CARGO_ID:
1177 return this->SortId<CargoID>(cd1->GetCargo(), cd2->GetCargo());
1178 case ST_COUNT:
1179 return this->SortCount(cd1, cd2);
1180 case ST_STATION_STRING:
1181 return this->SortStation(cd1->GetStation(), cd2->GetStation());
1182 default:
1183 NOT_REACHED();
1184 }
1185 }
1186
1187 template<class Tid>
1188 bool CargoSorter::SortId(Tid st1, Tid st2) const
1189 {
1190 return (this->order == SO_ASCENDING) ? st1 < st2 : st2 < st1;
1191 }
1192
1193 bool CargoSorter::SortCount(const CargoDataEntry *cd1, const CargoDataEntry *cd2) const
1194 {
1195 uint c1 = cd1->GetCount();
1196 uint c2 = cd2->GetCount();
1197 if (c1 == c2) {
1198 return this->SortStation(cd1->GetStation(), cd2->GetStation());
1199 } else if (this->order == SO_ASCENDING) {
1200 return c1 < c2;
1201 } else {
1202 return c2 < c1;
1203 }
1204 }
1205
1206 bool CargoSorter::SortStation(StationID st1, StationID st2) const
1207 {
1208 if (!Station::IsValidID(st1)) {
1209 return Station::IsValidID(st2) ? this->order == SO_ASCENDING : this->SortId(st1, st2);
1210 } else if (!Station::IsValidID(st2)) {
1211 return order == SO_DESCENDING;
1212 }
1213
1214 int res = strnatcmp(Station::Get(st1)->GetCachedName(), Station::Get(st2)->GetCachedName()); // Sort by name (natural sorting).
1215 if (res == 0) {
1216 return this->SortId(st1, st2);
1217 } else {
1218 return (this->order == SO_ASCENDING) ? res < 0 : res > 0;
1219 }
1220 }
1221
1225 struct StationViewWindow : public Window {
1229 struct RowDisplay {
1230 RowDisplay(CargoDataEntry *f, StationID n) : filter(f), next_station(n) {}
1231 RowDisplay(CargoDataEntry *f, CargoID n) : filter(f), next_cargo(n) {}
1232
1236 CargoDataEntry *filter;
1237 union {
1241 StationID next_station;
1242
1246 CargoID next_cargo;
1247 };
1248 };
1249
1250 typedef std::vector<RowDisplay> CargoDataVector;
1251
1252 static const int NUM_COLUMNS = 4;
1253
1257 enum Invalidation {
1258 INV_FLOWS = 0x100,
1259 INV_CARGO = 0x200
1260 };
1261
1265 enum Grouping {
1266 GR_SOURCE,
1267 GR_NEXT,
1268 GR_DESTINATION,
1269 GR_CARGO,
1270 };
1271
1275 enum Mode {
1276 MODE_WAITING,
1277 MODE_PLANNED
1278 };
1279
1280 uint expand_shrink_width;
1281 int rating_lines;
1282 int accepts_lines;
1283 Scrollbar *vscroll;
1284
1286 enum AcceptListHeight {
1287 ALH_RATING = 13,
1288 ALH_ACCEPTS = 3,
1289 };
1290
1291 static const StringID _sort_names[];
1292 static const StringID _group_names[];
1293
1300 CargoSortType sortings[NUM_COLUMNS];
1301
1303 SortOrder sort_orders[NUM_COLUMNS];
1304
1305 int scroll_to_row;
1306 int grouping_index;
1307 Mode current_mode;
1308 Grouping groupings[NUM_COLUMNS];
1309
1310 CargoDataEntry expanded_rows;
1311 CargoDataEntry cached_destinations;
1312 CargoDataVector displayed_rows;
1313
1314 StationViewWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc),
1315 scroll_to_row(INT_MAX), grouping_index(0)
1316 {
1317 this->rating_lines = ALH_RATING;
1318 this->accepts_lines = ALH_ACCEPTS;
1319
1320 this->CreateNestedTree();
1321 this->vscroll = this->GetScrollbar(WID_SV_SCROLLBAR);
1322 /* Nested widget tree creation is done in two steps to ensure that this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS) exists in UpdateWidgetSize(). */
1323 this->FinishInitNested(window_number);
1324
1325 this->groupings[0] = GR_CARGO;
1326 this->sortings[0] = ST_AS_GROUPING;
1327 this->SelectGroupBy(_settings_client.gui.station_gui_group_order);
1328 this->SelectSortBy(_settings_client.gui.station_gui_sort_by);
1329 this->sort_orders[0] = SO_ASCENDING;
1330 this->SelectSortOrder((SortOrder)_settings_client.gui.station_gui_sort_order);
1331 this->owner = Station::Get(window_number)->owner;
1332 }
1333
1334 void Close() override
1335 {
1336 CloseWindowById(WC_TRAINS_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_TRAIN, this->owner, this->window_number).Pack(), false);
1337 CloseWindowById(WC_ROADVEH_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_ROAD, this->owner, this->window_number).Pack(), false);
1338 CloseWindowById(WC_SHIPS_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_SHIP, this->owner, this->window_number).Pack(), false);
1339 CloseWindowById(WC_AIRCRAFT_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_AIRCRAFT, this->owner, this->window_number).Pack(), false);
1340
1341 SetViewportCatchmentStation(Station::Get(this->window_number), false);
1342 this->Window::Close();
1343 }
1344
1355 void ShowCargo(CargoDataEntry *data, CargoID cargo, StationID source, StationID next, StationID dest, uint count)
1356 {
1357 if (count == 0) return;
1358 bool auto_distributed = _settings_game.linkgraph.GetDistributionType(cargo) != DT_MANUAL;
1359 const CargoDataEntry *expand = &this->expanded_rows;
1360 for (int i = 0; i < NUM_COLUMNS && expand != nullptr; ++i) {
1361 switch (groupings[i]) {
1362 case GR_CARGO:
1363 assert(i == 0);
1364 data = data->InsertOrRetrieve(cargo);
1365 data->SetTransfers(source != this->window_number);
1366 expand = expand->Retrieve(cargo);
1367 break;
1368 case GR_SOURCE:
1369 if (auto_distributed || source != this->window_number) {
1370 data = data->InsertOrRetrieve(source);
1371 expand = expand->Retrieve(source);
1372 }
1373 break;
1374 case GR_NEXT:
1375 if (auto_distributed) {
1376 data = data->InsertOrRetrieve(next);
1377 expand = expand->Retrieve(next);
1378 }
1379 break;
1380 case GR_DESTINATION:
1381 if (auto_distributed) {
1382 data = data->InsertOrRetrieve(dest);
1383 expand = expand->Retrieve(dest);
1384 }
1385 break;
1386 }
1387 }
1388 data->Update(count);
1389 }
1390
1391 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1392 {
1393 switch (widget) {
1394 case WID_SV_WAITING:
1395 resize->height = FONT_HEIGHT_NORMAL;
1396 size->height = WD_FRAMERECT_TOP + 4 * resize->height + WD_FRAMERECT_BOTTOM;
1397 this->expand_shrink_width = std::max(GetStringBoundingBox("-").width, GetStringBoundingBox("+").width) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
1398 break;
1399
1400 case WID_SV_ACCEPT_RATING_LIST:
1401 size->height = WD_FRAMERECT_TOP + ((this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS)->widget_data == STR_STATION_VIEW_RATINGS_BUTTON) ? this->accepts_lines : this->rating_lines) * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;
1402 break;
1403
1404 case WID_SV_CLOSE_AIRPORT:
1405 if (!(Station::Get(this->window_number)->facilities & FACIL_AIRPORT)) {
1406 /* Hide 'Close Airport' button if no airport present. */
1407 size->width = 0;
1408 resize->width = 0;
1409 fill->width = 0;
1410 }
1411 break;
1412 }
1413 }
1414
1415 void OnPaint() override
1416 {
1417 const Station *st = Station::Get(this->window_number);
1418 CargoDataEntry cargo;
1419 BuildCargoList(&cargo, st);
1420
1421 this->vscroll->SetCount(cargo.GetNumChildren()); // update scrollbar
1422
1423 /* disable some buttons */
1424 this->SetWidgetDisabledState(WID_SV_RENAME, st->owner != _local_company);
1425 this->SetWidgetDisabledState(WID_SV_TRAINS, !(st->facilities & FACIL_TRAIN));
1426 this->SetWidgetDisabledState(WID_SV_ROADVEHS, !(st->facilities & FACIL_TRUCK_STOP) && !(st->facilities & FACIL_BUS_STOP));
1427 this->SetWidgetDisabledState(WID_SV_SHIPS, !(st->facilities & FACIL_DOCK));
1428 this->SetWidgetDisabledState(WID_SV_PLANES, !(st->facilities & FACIL_AIRPORT));
1429 this->SetWidgetDisabledState(WID_SV_CLOSE_AIRPORT, !(st->facilities & FACIL_AIRPORT) || st->owner != _local_company || st->owner == OWNER_NONE); // Also consider SE, where _local_company == OWNER_NONE
1430 this->SetWidgetLoweredState(WID_SV_CLOSE_AIRPORT, (st->facilities & FACIL_AIRPORT) && (st->airport.flags & AIRPORT_CLOSED_block) != 0);
1431
1432 extern const Station *_viewport_highlight_station;
1433 this->SetWidgetDisabledState(WID_SV_CATCHMENT, st->facilities == FACIL_NONE);
1434 this->SetWidgetLoweredState(WID_SV_CATCHMENT, _viewport_highlight_station == st);
1435
1436 this->DrawWidgets();
1437
1438 if (!this->IsShaded()) {
1439 /* Draw 'accepted cargo' or 'cargo ratings'. */
1440 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SV_ACCEPT_RATING_LIST);
1441 const Rect r = wid->GetCurrentRect();
1442 if (this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS)->widget_data == STR_STATION_VIEW_RATINGS_BUTTON) {
1443 int lines = this->DrawAcceptedCargo(r);
1444 if (lines > this->accepts_lines) { // Resize the widget, and perform re-initialization of the window.
1445 this->accepts_lines = lines;
1446 this->ReInit();
1447 return;
1448 }
1449 } else {
1450 int lines = this->DrawCargoRatings(r);
1451 if (lines > this->rating_lines) { // Resize the widget, and perform re-initialization of the window.
1452 this->rating_lines = lines;
1453 this->ReInit();
1454 return;
1455 }
1456 }
1457
1458 /* Draw arrow pointing up/down for ascending/descending sorting */
1459 this->DrawSortButtonState(WID_SV_SORT_ORDER, sort_orders[1] == SO_ASCENDING ? SBS_UP : SBS_DOWN);
1460
1461 int pos = this->vscroll->GetPosition();
1462
1463 int maxrows = this->vscroll->GetCapacity();
1464
1465 displayed_rows.clear();
1466
1467 /* Draw waiting cargo. */
1468 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_SV_WAITING);
1469 Rect waiting_rect = nwi->GetCurrentRect();
1470 this->DrawEntries(&cargo, waiting_rect, pos, maxrows, 0);
1471 scroll_to_row = INT_MAX;
1472 }
1473 }
1474
1475 void SetStringParameters(int widget) const override
1476 {
1477 const Station *st = Station::Get(this->window_number);
1478 SetDParam(0, st->index);
1479 SetDParam(1, st->facilities);
1480 }
1481
1487 void RecalcDestinations(CargoID i)
1488 {
1489 const Station *st = Station::Get(this->window_number);
1490 CargoDataEntry *cargo_entry = cached_destinations.InsertOrRetrieve(i);
1491 cargo_entry->Clear();
1492
1493 const FlowStatMap &flows = st->goods[i].flows;
1494 for (FlowStatMap::const_iterator it = flows.begin(); it != flows.end(); ++it) {
1495 StationID from = it->first;
1496 CargoDataEntry *source_entry = cargo_entry->InsertOrRetrieve(from);
1497 const FlowStat::SharesMap *shares = it->second.GetShares();
1498 uint32 prev_count = 0;
1499 for (FlowStat::SharesMap::const_iterator flow_it = shares->begin(); flow_it != shares->end(); ++flow_it) {
1500 StationID via = flow_it->second;
1501 CargoDataEntry *via_entry = source_entry->InsertOrRetrieve(via);
1502 if (via == this->window_number) {
1503 via_entry->InsertOrRetrieve(via)->Update(flow_it->first - prev_count);
1504 } else {
1505 EstimateDestinations(i, from, via, flow_it->first - prev_count, via_entry);
1506 }
1507 prev_count = flow_it->first;
1508 }
1509 }
1510 }
1511
1521 void EstimateDestinations(CargoID cargo, StationID source, StationID next, uint count, CargoDataEntry *dest)
1522 {
1523 if (Station::IsValidID(next) && Station::IsValidID(source)) {
1524 CargoDataEntry tmp;
1525 const FlowStatMap &flowmap = Station::Get(next)->goods[cargo].flows;
1526 FlowStatMap::const_iterator map_it = flowmap.find(source);
1527 if (map_it != flowmap.end()) {
1528 const FlowStat::SharesMap *shares = map_it->second.GetShares();
1529 uint32 prev_count = 0;
1530 for (FlowStat::SharesMap::const_iterator i = shares->begin(); i != shares->end(); ++i) {
1531 tmp.InsertOrRetrieve(i->second)->Update(i->first - prev_count);
1532 prev_count = i->first;
1533 }
1534 }
1535
1536 if (tmp.GetCount() == 0) {
1537 dest->InsertOrRetrieve(INVALID_STATION)->Update(count);
1538 } else {
1539 uint sum_estimated = 0;
1540 while (sum_estimated < count) {
1541 for (CargoDataSet::iterator i = tmp.Begin(); i != tmp.End() && sum_estimated < count; ++i) {
1542 CargoDataEntry *child = *i;
1543 uint estimate = DivideApprox(child->GetCount() * count, tmp.GetCount());
1544 if (estimate == 0) estimate = 1;
1545
1546 sum_estimated += estimate;
1547 if (sum_estimated > count) {
1548 estimate -= sum_estimated - count;
1549 sum_estimated = count;
1550 }
1551
1552 if (estimate > 0) {
1553 if (child->GetStation() == next) {
1554 dest->InsertOrRetrieve(next)->Update(estimate);
1555 } else {
1556 EstimateDestinations(cargo, source, child->GetStation(), estimate, dest);
1557 }
1558 }
1559 }
1560
1561 }
1562 }
1563 } else {
1564 dest->InsertOrRetrieve(INVALID_STATION)->Update(count);
1565 }
1566 }
1567
1574 void BuildFlowList(CargoID i, const FlowStatMap &flows, CargoDataEntry *cargo)
1575 {
1576 const CargoDataEntry *source_dest = this->cached_destinations.Retrieve(i);
1577 for (FlowStatMap::const_iterator it = flows.begin(); it != flows.end(); ++it) {
1578 StationID from = it->first;
1579 const CargoDataEntry *source_entry = source_dest->Retrieve(from);
1580 const FlowStat::SharesMap *shares = it->second.GetShares();
1581 for (FlowStat::SharesMap::const_iterator flow_it = shares->begin(); flow_it != shares->end(); ++flow_it) {
1582 const CargoDataEntry *via_entry = source_entry->Retrieve(flow_it->second);
1583 for (CargoDataSet::iterator dest_it = via_entry->Begin(); dest_it != via_entry->End(); ++dest_it) {
1584 CargoDataEntry *dest_entry = *dest_it;
1585 ShowCargo(cargo, i, from, flow_it->second, dest_entry->GetStation(), dest_entry->GetCount());
1586 }
1587 }
1588 }
1589 }
1590
1597 void BuildCargoList(CargoID i, const StationCargoList &packets, CargoDataEntry *cargo)
1598 {
1599 const CargoDataEntry *source_dest = this->cached_destinations.Retrieve(i);
1600 for (StationCargoList::ConstIterator it = packets.Packets()->begin(); it != packets.Packets()->end(); it++) {
1601 const CargoPacket *cp = *it;
1602 StationID next = it.GetKey();
1603
1604 const CargoDataEntry *source_entry = source_dest->Retrieve(cp->SourceStation());
1605 if (source_entry == nullptr) {
1606 this->ShowCargo(cargo, i, cp->SourceStation(), next, INVALID_STATION, cp->Count());
1607 continue;
1608 }
1609
1610 const CargoDataEntry *via_entry = source_entry->Retrieve(next);
1611 if (via_entry == nullptr) {
1612 this->ShowCargo(cargo, i, cp->SourceStation(), next, INVALID_STATION, cp->Count());
1613 continue;
1614 }
1615
1616 for (CargoDataSet::iterator dest_it = via_entry->Begin(); dest_it != via_entry->End(); ++dest_it) {
1617 CargoDataEntry *dest_entry = *dest_it;
1618 uint val = DivideApprox(cp->Count() * dest_entry->GetCount(), via_entry->GetCount());
1619 this->ShowCargo(cargo, i, cp->SourceStation(), next, dest_entry->GetStation(), val);
1620 }
1621 }
1622 this->ShowCargo(cargo, i, NEW_STATION, NEW_STATION, NEW_STATION, packets.ReservedCount());
1623 }
1624
1630 void BuildCargoList(CargoDataEntry *cargo, const Station *st)
1631 {
1632 for (CargoID i = 0; i < NUM_CARGO; i++) {
1633
1634 if (this->cached_destinations.Retrieve(i) == nullptr) {
1635 this->RecalcDestinations(i);
1636 }
1637
1638 if (this->current_mode == MODE_WAITING) {
1639 this->BuildCargoList(i, st->goods[i].cargo, cargo);
1640 } else {
1641 this->BuildFlowList(i, st->goods[i].flows, cargo);
1642 }
1643 }
1644 }
1645
1650 void SetDisplayedRow(const CargoDataEntry *data)
1651 {
1652 std::list<StationID> stations;
1653 const CargoDataEntry *parent = data->GetParent();
1654 if (parent->GetParent() == nullptr) {
1655 this->displayed_rows.push_back(RowDisplay(&this->expanded_rows, data->GetCargo()));
1656 return;
1657 }
1658
1659 StationID next = data->GetStation();
1660 while (parent->GetParent()->GetParent() != nullptr) {
1661 stations.push_back(parent->GetStation());
1662 parent = parent->GetParent();
1663 }
1664
1665 CargoID cargo = parent->GetCargo();
1666 CargoDataEntry *filter = this->expanded_rows.Retrieve(cargo);
1667 while (!stations.empty()) {
1668 filter = filter->Retrieve(stations.back());
1669 stations.pop_back();
1670 }
1671
1672 this->displayed_rows.push_back(RowDisplay(filter, next));
1673 }
1674
1683 StringID GetEntryString(StationID station, StringID here, StringID other_station, StringID any)
1684 {
1685 if (station == this->window_number) {
1686 return here;
1687 } else if (station == INVALID_STATION) {
1688 return any;
1689 } else if (station == NEW_STATION) {
1690 return STR_STATION_VIEW_RESERVED;
1691 } else {
1692 SetDParam(2, station);
1693 return other_station;
1694 }
1695 }
1696
1704 StringID SearchNonStop(CargoDataEntry *cd, StationID station, int column)
1705 {
1706 CargoDataEntry *parent = cd->GetParent();
1707 for (int i = column - 1; i > 0; --i) {
1708 if (this->groupings[i] == GR_DESTINATION) {
1709 if (parent->GetStation() == station) {
1710 return STR_STATION_VIEW_NONSTOP;
1711 } else {
1712 return STR_STATION_VIEW_VIA;
1713 }
1714 }
1715 parent = parent->GetParent();
1716 }
1717
1718 if (this->groupings[column + 1] == GR_DESTINATION) {
1719 CargoDataSet::iterator begin = cd->Begin();
1720 CargoDataSet::iterator end = cd->End();
1721 if (begin != end && ++(cd->Begin()) == end && (*(begin))->GetStation() == station) {
1722 return STR_STATION_VIEW_NONSTOP;
1723 } else {
1724 return STR_STATION_VIEW_VIA;
1725 }
1726 }
1727
1728 return STR_STATION_VIEW_VIA;
1729 }
1730
1741 int DrawEntries(CargoDataEntry *entry, Rect &r, int pos, int maxrows, int column, CargoID cargo = CT_INVALID)
1742 {
1743 if (this->sortings[column] == ST_AS_GROUPING) {
1744 if (this->groupings[column] != GR_CARGO) {
1745 entry->Resort(ST_STATION_STRING, this->sort_orders[column]);
1746 }
1747 } else {
1748 entry->Resort(ST_COUNT, this->sort_orders[column]);
1749 }
1750 for (CargoDataSet::iterator i = entry->Begin(); i != entry->End(); ++i) {
1751 CargoDataEntry *cd = *i;
1752
1753 Grouping grouping = this->groupings[column];
1754 if (grouping == GR_CARGO) cargo = cd->GetCargo();
1755 bool auto_distributed = _settings_game.linkgraph.GetDistributionType(cargo) != DT_MANUAL;
1756
1757 if (pos > -maxrows && pos <= 0) {
1758 StringID str = STR_EMPTY;
1759 int y = r.top + WD_FRAMERECT_TOP - pos * FONT_HEIGHT_NORMAL;
1760 SetDParam(0, cargo);
1761 SetDParam(1, cd->GetCount());
1762
1763 if (this->groupings[column] == GR_CARGO) {
1764 str = STR_STATION_VIEW_WAITING_CARGO;
1765 DrawCargoIcons(cd->GetCargo(), cd->GetCount(), r.left + WD_FRAMERECT_LEFT + this->expand_shrink_width, r.right - WD_FRAMERECT_RIGHT - this->expand_shrink_width, y);
1766 } else {
1767 if (!auto_distributed) grouping = GR_SOURCE;
1768 StationID station = cd->GetStation();
1769
1770 switch (grouping) {
1771 case GR_SOURCE:
1772 str = this->GetEntryString(station, STR_STATION_VIEW_FROM_HERE, STR_STATION_VIEW_FROM, STR_STATION_VIEW_FROM_ANY);
1773 break;
1774 case GR_NEXT:
1775 str = this->GetEntryString(station, STR_STATION_VIEW_VIA_HERE, STR_STATION_VIEW_VIA, STR_STATION_VIEW_VIA_ANY);
1776 if (str == STR_STATION_VIEW_VIA) str = this->SearchNonStop(cd, station, column);
1777 break;
1778 case GR_DESTINATION:
1779 str = this->GetEntryString(station, STR_STATION_VIEW_TO_HERE, STR_STATION_VIEW_TO, STR_STATION_VIEW_TO_ANY);
1780 break;
1781 default:
1782 NOT_REACHED();
1783 }
1784 if (pos == -this->scroll_to_row && Station::IsValidID(station)) {
1785 ScrollMainWindowToTile(Station::Get(station)->xy);
1786 }
1787 }
1788
1789 bool rtl = _current_text_dir == TD_RTL;
1790 int text_left = rtl ? r.left + this->expand_shrink_width : r.left + WD_FRAMERECT_LEFT + column * this->expand_shrink_width;
1791 int text_right = rtl ? r.right - WD_FRAMERECT_LEFT - column * this->expand_shrink_width : r.right - this->expand_shrink_width;
1792 int shrink_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.right - this->expand_shrink_width + WD_FRAMERECT_LEFT;
1793 int shrink_right = rtl ? r.left + this->expand_shrink_width - WD_FRAMERECT_RIGHT : r.right - WD_FRAMERECT_RIGHT;
1794
1795 DrawString(text_left, text_right, y, str);
1796
1797 if (column < NUM_COLUMNS - 1) {
1798 const char *sym = nullptr;
1799 if (cd->GetNumChildren() > 0) {
1800 sym = "-";
1801 } else if (auto_distributed && str != STR_STATION_VIEW_RESERVED) {
1802 sym = "+";
1803 } else {
1804 /* Only draw '+' if there is something to be shown. */
1805 const StationCargoList &list = Station::Get(this->window_number)->goods[cargo].cargo;
1806 if (grouping == GR_CARGO && (list.ReservedCount() > 0 || cd->HasTransfers())) {
1807 sym = "+";
1808 }
1809 }
1810 if (sym) DrawString(shrink_left, shrink_right, y, sym, TC_YELLOW);
1811 }
1812 this->SetDisplayedRow(cd);
1813 }
1814 --pos;
1815 if (auto_distributed || column == 0) {
1816 pos = this->DrawEntries(cd, r, pos, maxrows, column + 1, cargo);
1817 }
1818 }
1819 return pos;
1820 }
1821
1827 int DrawAcceptedCargo(const Rect &r) const
1828 {
1829 const Station *st = Station::Get(this->window_number);
1830
1831 CargoTypes cargo_mask = 0;
1832 for (CargoID i = 0; i < NUM_CARGO; i++) {
1833 if (HasBit(st->goods[i].status, GoodsEntry::GES_ACCEPTANCE)) SetBit(cargo_mask, i);
1834 }
1835 SetDParam(0, cargo_mask);
1836 int bottom = DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, INT32_MAX, STR_STATION_VIEW_ACCEPTS_CARGO);
1837 return CeilDiv(bottom - r.top - WD_FRAMERECT_TOP, FONT_HEIGHT_NORMAL);
1838 }
1839
1845 int DrawCargoRatings(const Rect &r) const
1846 {
1847 const Station *st = Station::Get(this->window_number);
1848 int y = r.top + WD_FRAMERECT_TOP;
1849
1850 if (st->town->exclusive_counter > 0) {
1851 SetDParam(0, st->town->exclusivity);
1852 y = DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, r.bottom, st->town->exclusivity == st->owner ? STR_STATION_VIEW_EXCLUSIVE_RIGHTS_SELF : STR_STATION_VIEW_EXCLUSIVE_RIGHTS_COMPANY);
1853 y += WD_PAR_VSEP_WIDE;
1854 }
1855
1856 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_STATION_VIEW_SUPPLY_RATINGS_TITLE);
1857 y += FONT_HEIGHT_NORMAL;
1858
1859 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
1860 const GoodsEntry *ge = &st->goods[cs->Index()];
1861 if (!ge->HasRating()) continue;
1862
1863 const LinkGraph *lg = LinkGraph::GetIfValid(ge->link_graph);
1864 SetDParam(0, cs->name);
1865 SetDParam(1, lg != nullptr ? lg->Monthly((*lg)[ge->node].Supply()) : 0);
1866 SetDParam(2, STR_CARGO_RATING_APPALLING + (ge->rating >> 5));
1867 SetDParam(3, ToPercent8(ge->rating));
1868 DrawString(r.left + WD_FRAMERECT_LEFT + 6, r.right - WD_FRAMERECT_RIGHT - 6, y, STR_STATION_VIEW_CARGO_SUPPLY_RATING);
1869 y += FONT_HEIGHT_NORMAL;
1870 }
1871 return CeilDiv(y - r.top - WD_FRAMERECT_TOP, FONT_HEIGHT_NORMAL);
1872 }
1873
1879 template<class Tid>
1880 void HandleCargoWaitingClick(CargoDataEntry *filter, Tid next)
1881 {
1882 if (filter->Retrieve(next) != nullptr) {
1883 filter->Remove(next);
1884 } else {
1885 filter->InsertOrRetrieve(next);
1886 }
1887 }
1888
1893 void HandleCargoWaitingClick(int row)
1894 {
1895 if (row < 0 || (uint)row >= this->displayed_rows.size()) return;
1896 if (_ctrl_pressed) {
1897 this->scroll_to_row = row;
1898 } else {
1899 RowDisplay &display = this->displayed_rows[row];
1900 if (display.filter == &this->expanded_rows) {
1901 this->HandleCargoWaitingClick<CargoID>(display.filter, display.next_cargo);
1902 } else {
1903 this->HandleCargoWaitingClick<StationID>(display.filter, display.next_station);
1904 }
1905 }
1906 this->SetWidgetDirty(WID_SV_WAITING);
1907 }
1908
1909 void OnClick(Point pt, int widget, int click_count) override
1910 {
1911 switch (widget) {
1912 case WID_SV_WAITING:
1913 this->HandleCargoWaitingClick(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SV_WAITING, WD_FRAMERECT_TOP) - this->vscroll->GetPosition());
1914 break;
1915
1916 case WID_SV_CATCHMENT:
1917 SetViewportCatchmentStation(Station::Get(this->window_number), !this->IsWidgetLowered(WID_SV_CATCHMENT));
1918 break;
1919
1920 case WID_SV_LOCATION:
1921 if (_ctrl_pressed) {
1922 ShowExtraViewportWindow(Station::Get(this->window_number)->xy);
1923 } else {
1924 ScrollMainWindowToTile(Station::Get(this->window_number)->xy);
1925 }
1926 break;
1927
1928 case WID_SV_ACCEPTS_RATINGS: {
1929 /* Swap between 'accepts' and 'ratings' view. */
1930 int height_change;
1931 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS);
1932 if (this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS)->widget_data == STR_STATION_VIEW_RATINGS_BUTTON) {
1933 nwi->SetDataTip(STR_STATION_VIEW_ACCEPTS_BUTTON, STR_STATION_VIEW_ACCEPTS_TOOLTIP); // Switch to accepts view.
1934 height_change = this->rating_lines - this->accepts_lines;
1935 } else {
1936 nwi->SetDataTip(STR_STATION_VIEW_RATINGS_BUTTON, STR_STATION_VIEW_RATINGS_TOOLTIP); // Switch to ratings view.
1937 height_change = this->accepts_lines - this->rating_lines;
1938 }
1939 this->ReInit(0, height_change * FONT_HEIGHT_NORMAL);
1940 break;
1941 }
1942
1943 case WID_SV_RENAME:
1944 SetDParam(0, this->window_number);
1945 ShowQueryString(STR_STATION_NAME, STR_STATION_VIEW_RENAME_STATION_CAPTION, MAX_LENGTH_STATION_NAME_CHARS,
1946 this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
1947 break;
1948
1949 case WID_SV_CLOSE_AIRPORT:
1950 DoCommandP(0, this->window_number, 0, CMD_OPEN_CLOSE_AIRPORT);
1951 break;
1952
1953 case WID_SV_TRAINS: // Show list of scheduled trains to this station
1954 case WID_SV_ROADVEHS: // Show list of scheduled road-vehicles to this station
1955 case WID_SV_SHIPS: // Show list of scheduled ships to this station
1956 case WID_SV_PLANES: { // Show list of scheduled aircraft to this station
1957 Owner owner = Station::Get(this->window_number)->owner;
1958 ShowVehicleListWindow(owner, (VehicleType)(widget - WID_SV_TRAINS), (StationID)this->window_number);
1959 break;
1960 }
1961
1962 case WID_SV_SORT_BY: {
1963 /* The initial selection is composed of current mode and
1964 * sorting criteria for columns 1, 2, and 3. Column 0 is always
1965 * sorted by cargo ID. The others can theoretically be sorted
1966 * by different things but there is no UI for that. */
1967 ShowDropDownMenu(this, _sort_names,
1968 this->current_mode * 2 + (this->sortings[1] == ST_COUNT ? 1 : 0),
1969 WID_SV_SORT_BY, 0, 0);
1970 break;
1971 }
1972
1973 case WID_SV_GROUP_BY: {
1974 ShowDropDownMenu(this, _group_names, this->grouping_index, WID_SV_GROUP_BY, 0, 0);
1975 break;
1976 }
1977
1978 case WID_SV_SORT_ORDER: { // flip sorting method asc/desc
1979 this->SelectSortOrder(this->sort_orders[1] == SO_ASCENDING ? SO_DESCENDING : SO_ASCENDING);
1980 this->SetTimeout();
1981 this->LowerWidget(WID_SV_SORT_ORDER);
1982 break;
1983 }
1984 }
1985 }
1986
1991 void SelectSortOrder(SortOrder order)
1992 {
1993 this->sort_orders[1] = this->sort_orders[2] = this->sort_orders[3] = order;
1994 _settings_client.gui.station_gui_sort_order = this->sort_orders[1];
1995 this->SetDirty();
1996 }
1997
2002 void SelectSortBy(int index)
2003 {
2004 _settings_client.gui.station_gui_sort_by = index;
2005 switch (_sort_names[index]) {
2006 case STR_STATION_VIEW_WAITING_STATION:
2007 this->current_mode = MODE_WAITING;
2008 this->sortings[1] = this->sortings[2] = this->sortings[3] = ST_AS_GROUPING;
2009 break;
2010 case STR_STATION_VIEW_WAITING_AMOUNT:
2011 this->current_mode = MODE_WAITING;
2012 this->sortings[1] = this->sortings[2] = this->sortings[3] = ST_COUNT;
2013 break;
2014 case STR_STATION_VIEW_PLANNED_STATION:
2015 this->current_mode = MODE_PLANNED;
2016 this->sortings[1] = this->sortings[2] = this->sortings[3] = ST_AS_GROUPING;
2017 break;
2018 case STR_STATION_VIEW_PLANNED_AMOUNT:
2019 this->current_mode = MODE_PLANNED;
2020 this->sortings[1] = this->sortings[2] = this->sortings[3] = ST_COUNT;
2021 break;
2022 default:
2023 NOT_REACHED();
2024 }
2025 /* Display the current sort variant */
2026 this->GetWidget<NWidgetCore>(WID_SV_SORT_BY)->widget_data = _sort_names[index];
2027 this->SetDirty();
2028 }
2029
2034 void SelectGroupBy(int index)
2035 {
2036 this->grouping_index = index;
2037 _settings_client.gui.station_gui_group_order = index;
2038 this->GetWidget<NWidgetCore>(WID_SV_GROUP_BY)->widget_data = _group_names[index];
2039 switch (_group_names[index]) {
2040 case STR_STATION_VIEW_GROUP_S_V_D:
2041 this->groupings[1] = GR_SOURCE;
2042 this->groupings[2] = GR_NEXT;
2043 this->groupings[3] = GR_DESTINATION;
2044 break;
2045 case STR_STATION_VIEW_GROUP_S_D_V:
2046 this->groupings[1] = GR_SOURCE;
2047 this->groupings[2] = GR_DESTINATION;
2048 this->groupings[3] = GR_NEXT;
2049 break;
2050 case STR_STATION_VIEW_GROUP_V_S_D:
2051 this->groupings[1] = GR_NEXT;
2052 this->groupings[2] = GR_SOURCE;
2053 this->groupings[3] = GR_DESTINATION;
2054 break;
2055 case STR_STATION_VIEW_GROUP_V_D_S:
2056 this->groupings[1] = GR_NEXT;
2057 this->groupings[2] = GR_DESTINATION;
2058 this->groupings[3] = GR_SOURCE;
2059 break;
2060 case STR_STATION_VIEW_GROUP_D_S_V:
2061 this->groupings[1] = GR_DESTINATION;
2062 this->groupings[2] = GR_SOURCE;
2063 this->groupings[3] = GR_NEXT;
2064 break;
2065 case STR_STATION_VIEW_GROUP_D_V_S:
2066 this->groupings[1] = GR_DESTINATION;
2067 this->groupings[2] = GR_NEXT;
2068 this->groupings[3] = GR_SOURCE;
2069 break;
2070 }
2071 this->SetDirty();
2072 }
2073
2074 void OnDropdownSelect(int widget, int index) override
2075 {
2076 if (widget == WID_SV_SORT_BY) {
2077 this->SelectSortBy(index);
2078 } else {
2079 this->SelectGroupBy(index);
2080 }
2081 }
2082
2083 void OnQueryTextFinished(char *str) override
2084 {
2085 if (str == nullptr) return;
2086
2087 DoCommandP(0, this->window_number, 0, CMD_RENAME_STATION | CMD_MSG(STR_ERROR_CAN_T_RENAME_STATION), nullptr, str);
2088 }
2089
2090 void OnResize() override
2091 {
2092 this->vscroll->SetCapacityFromWidget(this, WID_SV_WAITING, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM);
2093 }
2094
2100 void OnInvalidateData(int data = 0, bool gui_scope = true) override
2101 {
2102 if (gui_scope) {
2103 if (data >= 0 && data < NUM_CARGO) {
2104 this->cached_destinations.Remove((CargoID)data);
2105 } else {
2106 this->ReInit();
2107 }
2108 }
2109 }
2110 };
2111
2112 const StringID StationViewWindow::_sort_names[] = {
2113 STR_STATION_VIEW_WAITING_STATION,
2114 STR_STATION_VIEW_WAITING_AMOUNT,
2115 STR_STATION_VIEW_PLANNED_STATION,
2116 STR_STATION_VIEW_PLANNED_AMOUNT,
2117 INVALID_STRING_ID
2118 };
2119
2120 const StringID StationViewWindow::_group_names[] = {
2121 STR_STATION_VIEW_GROUP_S_V_D,
2122 STR_STATION_VIEW_GROUP_S_D_V,
2123 STR_STATION_VIEW_GROUP_V_S_D,
2124 STR_STATION_VIEW_GROUP_V_D_S,
2125 STR_STATION_VIEW_GROUP_D_S_V,
2126 STR_STATION_VIEW_GROUP_D_V_S,
2127 INVALID_STRING_ID
2128 };
2129
2130 static WindowDesc _station_view_desc(
2131 WDP_AUTO, "view_station", 249, 117,
2132 WC_STATION_VIEW, WC_NONE,
2133 0,
2134 _nested_station_view_widgets, lengthof(_nested_station_view_widgets)
2135 );
2136
2142 void ShowStationViewWindow(StationID station)
2143 {
2144 AllocateWindowDescFront<StationViewWindow>(&_station_view_desc, station);
2145 }
2146
2148 struct TileAndStation {
2149 TileIndex tile;
2150 StationID station;
2151 };
2152
2153 static std::vector<TileAndStation> _deleted_stations_nearby;
2154 static std::vector<StationID> _stations_nearby_list;
2155
2163 template <class T>
2164 static bool AddNearbyStation(TileIndex tile, void *user_data)
2165 {
2166 TileArea *ctx = (TileArea *)user_data;
2167
2168 /* First check if there were deleted stations here */
2169 for (uint i = 0; i < _deleted_stations_nearby.size(); i++) {
2170 auto ts = _deleted_stations_nearby.begin() + i;
2171 if (ts->tile == tile) {
2172 _stations_nearby_list.push_back(_deleted_stations_nearby[i].station);
2173 _deleted_stations_nearby.erase(ts);
2174 i--;
2175 }
2176 }
2177
2178 /* Check if own station and if we stay within station spread */
2179 if (!IsTileType(tile, MP_STATION)) return false;
2180
2181 StationID sid = GetStationIndex(tile);
2182
2183 /* This station is (likely) a waypoint */
2184 if (!T::IsValidID(sid)) return false;
2185
2186 T *st = T::Get(sid);
2187 if (st->owner != _local_company || std::find(_stations_nearby_list.begin(), _stations_nearby_list.end(), sid) != _stations_nearby_list.end()) return false;
2188
2189 if (st->rect.BeforeAddRect(ctx->tile, ctx->w, ctx->h, StationRect::ADD_TEST).Succeeded()) {
2190 _stations_nearby_list.push_back(sid);
2191 }
2192
2193 return false; // We want to include *all* nearby stations
2194 }
2195
2205 template <class T>
2206 static const T *FindStationsNearby(TileArea ta, bool distant_join)
2207 {
2208 TileArea ctx = ta;
2209
2210 _stations_nearby_list.clear();
2211 _deleted_stations_nearby.clear();
2212
2213 /* Check the inside, to return, if we sit on another station */
2214 for (TileIndex t : ta) {
2215 if (t < MapSize() && IsTileType(t, MP_STATION) && T::IsValidID(GetStationIndex(t))) return T::GetByTile(t);
2216 }
2217
2218 /* Look for deleted stations */
2219 for (const BaseStation *st : BaseStation::Iterate()) {
2220 if (T::IsExpected(st) && !st->IsInUse() && st->owner == _local_company) {
2221 /* Include only within station spread (yes, it is strictly less than) */
2222 if (std::max(DistanceMax(ta.tile, st->xy), DistanceMax(TILE_ADDXY(ta.tile, ta.w - 1, ta.h - 1), st->xy)) < _settings_game.station.station_spread) {
2223 _deleted_stations_nearby.push_back({st->xy, st->index});
2224
2225 /* Add the station when it's within where we're going to build */
2226 if (IsInsideBS(TileX(st->xy), TileX(ctx.tile), ctx.w) &&
2227 IsInsideBS(TileY(st->xy), TileY(ctx.tile), ctx.h)) {
2228 AddNearbyStation<T>(st->xy, &ctx);
2229 }
2230 }
2231 }
2232 }
2233
2234 /* Only search tiles where we have a chance to stay within the station spread.
2235 * The complete check needs to be done in the callback as we don't know the
2236 * extent of the found station, yet. */
2237 if (distant_join && std::min(ta.w, ta.h) >= _settings_game.station.station_spread) return nullptr;
2238 uint max_dist = distant_join ? _settings_game.station.station_spread - std::min(ta.w, ta.h) : 1;
2239
2240 TileIndex tile = TileAddByDir(ctx.tile, DIR_N);
2241 CircularTileSearch(&tile, max_dist, ta.w, ta.h, AddNearbyStation<T>, &ctx);
2242
2243 return nullptr;
2244 }
2245
2246 static const NWidgetPart _nested_select_station_widgets[] = {
2247 NWidget(NWID_HORIZONTAL),
2248 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
2249 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_JS_CAPTION), SetDataTip(STR_JOIN_STATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2250 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
2251 EndContainer(),
2252 NWidget(NWID_HORIZONTAL),
2253 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_JS_PANEL), SetResize(1, 0), SetScrollbar(WID_JS_SCROLLBAR), EndContainer(),
2254 NWidget(NWID_VERTICAL),
2255 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_JS_SCROLLBAR),
2256 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
2257 EndContainer(),
2258 EndContainer(),
2259 };
2260
2265 template <class T>
2266 struct SelectStationWindow : Window {
2267 CommandContainer select_station_cmd;
2268 TileArea area;
2269 Scrollbar *vscroll;
2270
2271 SelectStationWindow(WindowDesc *desc, const CommandContainer &cmd, TileArea ta) :
2272 Window(desc),
2273 select_station_cmd(cmd),
2274 area(ta)
2275 {
2276 this->CreateNestedTree();
2277 this->vscroll = this->GetScrollbar(WID_JS_SCROLLBAR);
2278 this->GetWidget<NWidgetCore>(WID_JS_CAPTION)->widget_data = T::EXPECTED_FACIL == FACIL_WAYPOINT ? STR_JOIN_WAYPOINT_CAPTION : STR_JOIN_STATION_CAPTION;
2279 this->FinishInitNested(0);
2280 this->OnInvalidateData(0);
2281
2282 _thd.freeze = true;
2283 }
2284
2285 void Close() override
2286 {
2287 if (_settings_client.gui.station_show_coverage) SetViewportCatchmentStation(nullptr, true);
2288
2289 _thd.freeze = false;
2290 this->Window::Close();
2291 }
2292
2293 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
2294 {
2295 if (widget != WID_JS_PANEL) return;
2296
2297 /* Determine the widest string */
2298 Dimension d = GetStringBoundingBox(T::EXPECTED_FACIL == FACIL_WAYPOINT ? STR_JOIN_WAYPOINT_CREATE_SPLITTED_WAYPOINT : STR_JOIN_STATION_CREATE_SPLITTED_STATION);
2299 for (uint i = 0; i < _stations_nearby_list.size(); i++) {
2300 const T *st = T::Get(_stations_nearby_list[i]);
2301 SetDParam(0, st->index);
2302 SetDParam(1, st->facilities);
2303 d = maxdim(d, GetStringBoundingBox(T::EXPECTED_FACIL == FACIL_WAYPOINT ? STR_STATION_LIST_WAYPOINT : STR_STATION_LIST_STATION));
2304 }
2305
2306 resize->height = d.height;
2307 d.height *= 5;
2308 d.width += WD_FRAMERECT_RIGHT + WD_FRAMERECT_LEFT;
2309 d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
2310 *size = d;
2311 }
2312
2313 void DrawWidget(const Rect &r, int widget) const override
2314 {
2315 if (widget != WID_JS_PANEL) return;
2316
2317 uint y = r.top + WD_FRAMERECT_TOP;
2318 if (this->vscroll->GetPosition() == 0) {
2319 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, T::EXPECTED_FACIL == FACIL_WAYPOINT ? STR_JOIN_WAYPOINT_CREATE_SPLITTED_WAYPOINT : STR_JOIN_STATION_CREATE_SPLITTED_STATION);
2320 y += this->resize.step_height;
2321 }
2322
2323 for (uint i = std::max<uint>(1, this->vscroll->GetPosition()); i <= _stations_nearby_list.size(); ++i, y += this->resize.step_height) {
2324 /* Don't draw anything if it extends past the end of the window. */
2325 if (i - this->vscroll->GetPosition() >= this->vscroll->GetCapacity()) break;
2326
2327 const T *st = T::Get(_stations_nearby_list[i - 1]);
2328 SetDParam(0, st->index);
2329 SetDParam(1, st->facilities);
2330 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, T::EXPECTED_FACIL == FACIL_WAYPOINT ? STR_STATION_LIST_WAYPOINT : STR_STATION_LIST_STATION);
2331 }
2332 }
2333
2334 void OnClick(Point pt, int widget, int click_count) override
2335 {
2336 if (widget != WID_JS_PANEL) return;
2337
2338 uint st_index = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_JS_PANEL, WD_FRAMERECT_TOP);
2339 bool distant_join = (st_index > 0);
2340 if (distant_join) st_index--;
2341
2342 if (distant_join && st_index >= _stations_nearby_list.size()) return;
2343
2344 /* Insert station to be joined into stored command */
2345 SB(this->select_station_cmd.p2, 16, 16,
2346 (distant_join ? _stations_nearby_list[st_index] : NEW_STATION));
2347
2348 /* Execute stored Command */
2349 DoCommandP(&this->select_station_cmd);
2350
2351 /* Close Window; this might cause double frees! */
2352 CloseWindowById(WC_SELECT_STATION, 0);
2353 }
2354
2355 void OnRealtimeTick(uint delta_ms) override
2356 {
2357 if (_thd.dirty & 2) {
2358 _thd.dirty &= ~2;
2359 this->SetDirty();
2360 }
2361 }
2362
2363 void OnResize() override
2364 {
2365 this->vscroll->SetCapacityFromWidget(this, WID_JS_PANEL, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM);
2366 }
2367
2373 void OnInvalidateData(int data = 0, bool gui_scope = true) override
2374 {
2375 if (!gui_scope) return;
2376 FindStationsNearby<T>(this->area, true);
2377 this->vscroll->SetCount((uint)_stations_nearby_list.size() + 1);
2378 this->SetDirty();
2379 }
2380
2381 void OnMouseOver(Point pt, int widget) override
2382 {
2383 if (widget != WID_JS_PANEL || T::EXPECTED_FACIL == FACIL_WAYPOINT) {
2384 SetViewportCatchmentStation(nullptr, true);
2385 return;
2386 }
2387
2388 /* Show coverage area of station under cursor */
2389 uint st_index = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_JS_PANEL, WD_FRAMERECT_TOP);
2390 if (st_index == 0 || st_index > _stations_nearby_list.size()) {
2391 SetViewportCatchmentStation(nullptr, true);
2392 } else {
2393 st_index--;
2394 SetViewportCatchmentStation(Station::Get(_stations_nearby_list[st_index]), true);
2395 }
2396 }
2397 };
2398
2399 static WindowDesc _select_station_desc(
2400 WDP_AUTO, "build_station_join", 200, 180,
2401 WC_SELECT_STATION, WC_NONE,
2402 WDF_CONSTRUCTION,
2403 _nested_select_station_widgets, lengthof(_nested_select_station_widgets)
2404 );
2405
2406
2414 template <class T>
2415 static bool StationJoinerNeeded(const CommandContainer &cmd, TileArea ta)
2416 {
2417 /* Only show selection if distant join is enabled in the settings */
2418 if (!_settings_game.station.distant_join_stations) return false;
2419
2420 /* If a window is already opened and we didn't ctrl-click,
2421 * return true (i.e. just flash the old window) */
2422 Window *selection_window = FindWindowById(WC_SELECT_STATION, 0);
2423 if (selection_window != nullptr) {
2424 /* Abort current distant-join and start new one */
2425 selection_window->Close();
2426 UpdateTileSelection();
2427 }
2428
2429 /* only show the popup, if we press ctrl */
2430 if (!_ctrl_pressed) return false;
2431
2432 /* Now check if we could build there */
2433 if (DoCommand(&cmd, CommandFlagsToDCFlags(GetCommandFlags(cmd.cmd))).Failed()) return false;
2434
2435 /* Test for adjacent station or station below selection.
2436 * If adjacent-stations is disabled and we are building next to a station, do not show the selection window.
2437 * but join the other station immediately. */
2438 const T *st = FindStationsNearby<T>(ta, false);
2439 return st == nullptr && (_settings_game.station.adjacent_stations || _stations_nearby_list.size() == 0);
2440 }
2441
2448 template <class T>
2449 void ShowSelectBaseStationIfNeeded(const CommandContainer &cmd, TileArea ta)
2450 {
2451 if (StationJoinerNeeded<T>(cmd, ta)) {
2452 if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
2453 new SelectStationWindow<T>(&_select_station_desc, cmd, ta);
2454 } else {
2455 DoCommandP(&cmd);
2456 }
2457 }
2458
2464 void ShowSelectStationIfNeeded(const CommandContainer &cmd, TileArea ta)
2465 {
2466 ShowSelectBaseStationIfNeeded<Station>(cmd, ta);
2467 }
2468
2474 void ShowSelectWaypointIfNeeded(const CommandContainer &cmd, TileArea ta)
2475 {
2476 ShowSelectBaseStationIfNeeded<Waypoint>(cmd, ta);
2477 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
StationViewWindow::grouping_index
int grouping_index
Currently selected entry in the grouping drop down.
Definition: station_gui.cpp:1306
StationViewWindow::HandleCargoWaitingClick
void HandleCargoWaitingClick(CargoDataEntry *filter, Tid next)
Expand or collapse a specific row.
Definition: station_gui.cpp:1880
CompanyStationsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: station_gui.cpp:677
BaseStation::facilities
StationFacility facilities
The facilities that this station has.
Definition: base_station_base.h:63
Window::SetTimeout
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:360
StationViewWindow
The StationView window.
Definition: station_gui.cpp:1225
CargoList< StationCargoList, StationCargoPacketMap >::ConstIterator
StationCargoPacketMap ::const_iterator ConstIterator
The const iterator for our container.
Definition: cargopacket.h:208
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
WC_ROADVEH_LIST
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
Definition: window_type.h:306
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:372
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
CommandContainer::cmd
uint32 cmd
command being executed.
Definition: command_type.h:483
CompanyStationsWindow::StationRatingMaxSorter
static bool StationRatingMaxSorter(const Station *const &a, const Station *const &b)
Sort stations by their rating.
Definition: station_gui.cpp:296
WID_STL_SORTBY
@ WID_STL_SORTBY
'Sort by' button - reverse sort direction.
Definition: station_widget.h:52
TileHighlightData::size
Point size
Size, in tile "units", of the white/red selection area.
Definition: tilehighlight_type.h:48
Station::goods
GoodsEntry goods[NUM_CARGO]
Goods at this station.
Definition: station_base.h:476
StationViewWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: station_gui.cpp:1334
StationViewWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: station_gui.cpp:1909
NWidgetFunction
static NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1239
DoCommand
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:450
GUIList::SortType
uint8 SortType() const
Get the sorttype of the list.
Definition: sortlist_type.h:93
GUISettings::station_show_coverage
bool station_show_coverage
whether to highlight coverage area
Definition: settings_type.h:163
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2445
vehicle_gui.h
GameSettings::station
StationSettings station
settings related to station management
Definition: settings_type.h:588
StationViewWindow::ALH_ACCEPTS
@ ALH_ACCEPTS
Height of the accepted cargo view.
Definition: station_gui.cpp:1288
UpdateTileSelection
void UpdateTileSelection()
Updates tile highlighting for all cases.
Definition: viewport.cpp:2532
LinkGraph
A connected component of a link graph.
Definition: linkgraph.h:39
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1188
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
StationViewWindow::RowDisplay::filter
CargoDataEntry * filter
Parent of the cargo entry belonging to the row.
Definition: station_gui.cpp:1236
DivideApprox
int DivideApprox(int a, int b)
Deterministic approximate division.
Definition: math_func.cpp:57
ToPercent8
static uint ToPercent8(uint i)
Converts a "fract" value 0..255 to "percent" value 0..100.
Definition: math_func.hpp:227
GetAcceptanceAroundTiles
CargoArray GetAcceptanceAroundTiles(TileIndex center_tile, int w, int h, int rad, CargoTypes *always_accepted)
Get the acceptance of cargoes around the tile in 1/8.
Definition: station_cmd.cpp:545
ScaleFontTrad
static int ScaleFontTrad(int value)
Scale traditional pixel dimensions to Font zoom level.
Definition: zoom_func.h:96
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:662
command_func.h
Window::DrawSortButtonState
void DrawSortButtonState(int widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition: widget.cpp:670
GUISettings::station_gui_sort_by
uint8 station_gui_sort_by
sort cargo entries in the station gui by station name or amount
Definition: settings_type.h:180
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Pool::PoolItem<&_link_graph_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:348
GUIList::Sort
bool Sort(Comp compare)
Sort the list.
Definition: sortlist_type.h:247
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:210
dropdown_func.h
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:29
CargoDataEntry::InsertOrRetrieve
CargoDataEntry * InsertOrRetrieve(StationID station)
Insert a new child or retrieve an existing child using a station ID as ID.
Definition: station_gui.cpp:900
_sorted_cargo_specs
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:152
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:1004
company_base.h
StationViewWindow::INV_FLOWS
@ INV_FLOWS
The planned flows have been recalculated and everything has to be updated.
Definition: station_gui.cpp:1258
NWidgetContainer::Add
void Add(NWidgetBase *wid)
Append widget wid to container.
Definition: widget.cpp:1047
CargoList::Packets
const Tcont * Packets() const
Returns a pointer to the cargo packet list (so you can iterate over it etc).
Definition: cargopacket.h:247
CargoDataEntry::cargo
CargoID cargo
ID of the cargo this entry is associated with.
Definition: station_gui.cpp:1026
BaseStation::town
Town * town
The town this station is associated with.
Definition: base_station_base.h:61
CompanyStationsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: station_gui.cpp:524
GetContrastColour
TextColour GetContrastColour(uint8 background, uint8 threshold)
Determine a contrasty text colour for a coloured background.
Definition: gfx.cpp:1416
CompanyStationsWindow
The list of stations per company.
Definition: station_gui.cpp:199
FACIL_TRUCK_STOP
@ FACIL_TRUCK_STOP
Station with truck stops.
Definition: station_type.h:53
CompanyStationsWindow::BuildStationsList
void BuildStationsList(const Owner owner)
(Re)Build station list
Definition: station_gui.cpp:222
WID_SV_WAITING
@ WID_SV_WAITING
List of waiting cargo.
Definition: station_widget.h:20
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
Station
Station data structure.
Definition: station_base.h:447
CheckRedrawStationCoverage
void CheckRedrawStationCoverage(const Window *w)
Check whether we need to redraw the station coverage text.
Definition: station_gui.cpp:126
StationViewWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: station_gui.cpp:2100
GUIList< const Station * >
GUISettings::station_gui_group_order
uint8 station_gui_group_order
the order of grouping cargo entries in the station gui
Definition: settings_type.h:179
StationViewWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: station_gui.cpp:2074
SelectStationWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: station_gui.cpp:2363
PC_RED
static const uint8 PC_RED
Red palette colour.
Definition: gfx_func.h:199
vehiclelist.h
TileAddByDir
static TileIndex TileAddByDir(TileIndex tile, Direction dir)
Adds a Direction to a tile.
Definition: map_func.h:370
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
NWidgetResizeBase::SetMinimalTextLines
void SetMinimalTextLines(uint8 min_lines, uint8 spacing, FontSize size)
Set minimal text lines for the widget.
Definition: widget.cpp:892
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:119
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:82
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
DT_MANUAL
@ DT_MANUAL
Manual distribution. No link graph calculations are run.
Definition: linkgraph_type.h:25
StationViewWindow::cached_destinations
CargoDataEntry cached_destinations
Cache for the flows passing through this station.
Definition: station_gui.cpp:1311
StationViewWindow::RowDisplay
A row being displayed in the cargo view (as opposed to being "hidden" behind a plus sign).
Definition: station_gui.cpp:1229
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1146
WID_SV_GROUP_BY
@ WID_SV_GROUP_BY
'Group by' button
Definition: station_widget.h:17
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
CargoDataEntry::GetCargo
CargoID GetCargo() const
Get the cargo ID for this entry.
Definition: station_gui.cpp:969
StationViewWindow::SelectSortBy
void SelectSortBy(int index)
Select a new sort criterium for the cargo view.
Definition: station_gui.cpp:2002
StationViewWindow::DrawEntries
int DrawEntries(CargoDataEntry *entry, Rect &r, int pos, int maxrows, int column, CargoID cargo=CT_INVALID)
Draw the given cargo entries in the station GUI.
Definition: station_gui.cpp:1741
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:710
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
WID_STL_LIST
@ WID_STL_LIST
The main panel, list of stations.
Definition: station_widget.h:38
StationCargoList
CargoList that is used for stations.
Definition: cargopacket.h:449
StationViewWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: station_gui.cpp:1391
StationViewWindow::BuildCargoList
void BuildCargoList(CargoID i, const StationCargoList &packets, CargoDataEntry *cargo)
Build up the cargo view for WAITING mode and a specific cargo.
Definition: station_gui.cpp:1597
DrawCargoIcons
static void DrawCargoIcons(CargoID i, uint waiting, int left, int right, int y)
Draws icons of waiting cargo in the StationView window.
Definition: station_gui.cpp:837
ShowSelectBaseStationIfNeeded
void ShowSelectBaseStationIfNeeded(const CommandContainer &cmd, TileArea ta)
Show the station selection window when needed.
Definition: station_gui.cpp:2449
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
CommandContainer::p2
uint32 p2
parameter p2.
Definition: command_type.h:482
zoom_func.h
FACIL_NONE
@ FACIL_NONE
The station has no facilities at all.
Definition: station_type.h:51
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
StationViewWindow::BuildCargoList
void BuildCargoList(CargoDataEntry *cargo, const Station *st)
Build up the cargo view for all cargoes.
Definition: station_gui.cpp:1630
StationViewWindow::DrawCargoRatings
int DrawCargoRatings(const Rect &r) const
Draw cargo ratings in the WID_SV_ACCEPT_RATING_LIST widget.
Definition: station_gui.cpp:1845
ShowCompanyStations
void ShowCompanyStations(CompanyID company)
Opens window with list of company's stations.
Definition: station_gui.cpp:784
CommandContainer
Structure for buffering the build command when selecting a station to join.
Definition: command_type.h:479
AddNearbyStation
static bool AddNearbyStation(TileIndex tile, void *user_data)
Add station on this tile to _stations_nearby_list if it's fully within the station spread.
Definition: station_gui.cpp:2164
SpecializedStation< Station, false >::Get
static Station * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:219
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:643
StationViewWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: station_gui.cpp:2083
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:57
SpecializedStation< Station, false >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index is a valid index for station of this type.
Definition: base_station_base.h:210
CargoDataEntry::GetCount
uint GetCount() const
Get the cargo count for this entry.
Definition: station_gui.cpp:974
town.h
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:319
FindStationsAroundSelection
static void FindStationsAroundSelection()
Find stations adjacent to the current tile highlight area, so that existing coverage area can be draw...
Definition: station_gui.cpp:85
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
WC_STATION_VIEW
@ WC_STATION_VIEW
Station view; Window numbers:
Definition: window_type.h:337
WID_STL_CAPTION
@ WID_STL_CAPTION
Caption of the window.
Definition: station_widget.h:37
CargoSpec::GetCargoIcon
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
Definition: cargotype.cpp:139
StationViewWindow::_sort_names
static const StringID _sort_names[]
Names of the sorting options in the dropdown.
Definition: station_gui.cpp:1291
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
CC_PASSENGERS
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:41
CompanyStationsWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: station_gui.cpp:426
GUIList::SetSortType
void SetSortType(uint8 n_type)
Set the sorttype of the list.
Definition: sortlist_type.h:103
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:2098
StationViewWindow::GR_DESTINATION
@ GR_DESTINATION
Group by estimated final destination ("to").
Definition: station_gui.cpp:1268
WID_SV_SORT_BY
@ WID_SV_SORT_BY
'Sort by' button
Definition: station_widget.h:19
StationViewWindow::SearchNonStop
StringID SearchNonStop(CargoDataEntry *cd, StationID station, int column)
Determine if we need to show the special "non-stop" string.
Definition: station_gui.cpp:1704
SelectStationWindow::area
TileArea area
Location of new station.
Definition: station_gui.cpp:2268
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:629
BaseStation::owner
Owner owner
The owner of this station.
Definition: base_station_base.h:62
DIR_N
@ DIR_N
North.
Definition: direction_type.h:26
StationViewWindow::expand_shrink_width
uint expand_shrink_width
The width allocated to the expand/shrink 'button'.
Definition: station_gui.cpp:1280
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
StationViewWindow::MODE_PLANNED
@ MODE_PLANNED
Show cargo planned to pass through the station.
Definition: station_gui.cpp:1277
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
CargoDataEntry::children
CargoDataSet * children
the children of this entry.
Definition: station_gui.cpp:1032
GoodsEntry::status
byte status
Status of this cargo, see GoodsEntryStatus.
Definition: station_base.h:223
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
StationViewWindow::GR_SOURCE
@ GR_SOURCE
Group by source of cargo ("from").
Definition: station_gui.cpp:1266
StationViewWindow::AcceptListHeight
AcceptListHeight
Height of the WID_SV_ACCEPT_RATING_LIST widget for different views.
Definition: station_gui.cpp:1286
ShowStationViewWindow
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
Definition: station_gui.cpp:2142
StationCargoList::TotalCount
uint TotalCount() const
Returns total count of cargo at the station, including cargo which is already reserved for loading.
Definition: cargopacket.h:527
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:889
textbuf_gui.h
CompanyStationsWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: station_gui.cpp:532
StationViewWindow::INV_CARGO
@ INV_CARGO
Some cargo has been added or removed.
Definition: station_gui.cpp:1259
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
StationViewWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: station_gui.cpp:1475
CompanyStationsWindow::StationWaitingAvailableSorter
static bool StationWaitingAvailableSorter(const Station *const &a, const Station *const &b)
Sort stations by their available waiting cargo.
Definition: station_gui.cpp:284
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:788
QSF_LEN_IN_CHARS
@ QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition: textbuf_gui.h:22
CargoDataEntry::InsertOrRetrieve
CargoDataEntry * InsertOrRetrieve(CargoID cargo)
Insert a new child or retrieve an existing child using a cargo ID as ID.
Definition: station_gui.cpp:910
SpecializedStation< Station, false >::Iterate
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
Definition: base_station_base.h:270
WID_SV_ROADVEHS
@ WID_SV_ROADVEHS
List of scheduled road vehs button.
Definition: station_widget.h:28
ST_STATION_ID
@ ST_STATION_ID
by station id
Definition: station_gui.cpp:863
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
StationViewWindow::current_mode
Mode current_mode
Currently selected display mode of cargo view.
Definition: station_gui.cpp:1307
CMD_OPEN_CLOSE_AIRPORT
@ CMD_OPEN_CLOSE_AIRPORT
open/close an airport to incoming aircraft
Definition: command_type.h:336
WID_SV_CATCHMENT
@ WID_SV_CATCHMENT
Toggle catchment area highlight.
Definition: station_widget.h:31
StationViewWindow::NUM_COLUMNS
static const int NUM_COLUMNS
Number of "columns" in the cargo view: cargo, from, via, to.
Definition: station_gui.cpp:1252
WindowDesc
High level window description.
Definition: window_gui.h:168
StationViewWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: station_gui.cpp:2090
GoodsEntry::cargo
StationCargoList cargo
The cargo packets of cargo waiting in this station.
Definition: station_base.h:252
CargoDataEntry::num_children
uint num_children
the number of subentries belonging to this entry.
Definition: station_gui.cpp:1030
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:463
FACIL_BUS_STOP
@ FACIL_BUS_STOP
Station with bus stops.
Definition: station_type.h:54
GetProductionAroundTiles
CargoArray GetProductionAroundTiles(TileIndex north_tile, int w, int h, int rad)
Get the cargo types being produced around the tile (in a rectangle).
Definition: station_cmd.cpp:506
CargoSpec::Index
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:90
StationViewWindow::GetEntryString
StringID GetEntryString(StationID station, StringID here, StringID other_station, StringID any)
Select the correct string for an entry referring to the specified station.
Definition: station_gui.cpp:1683
GUIList::IsDescSortOrder
bool IsDescSortOrder() const
Check if the sort order is descending.
Definition: sortlist_type.h:223
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
Listing
Data structure describing how to show the list (what sort direction and criteria).
Definition: sortlist_type.h:30
SCT_PASSENGERS_ONLY
@ SCT_PASSENGERS_ONLY
Draw only passenger class cargoes.
Definition: station_gui.h:20
MapSize
static uint MapSize()
Get the size of the map.
Definition: map_func.h:92
WWT_PUSHBTN
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
Definition: widget_type.h:103
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
StationViewWindow::sortings
CargoSortType sortings[NUM_COLUMNS]
Sort types of the different 'columns'.
Definition: station_gui.cpp:1300
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition: bitmath_func.hpp:329
CargoDataEntry::GetNumChildren
uint GetNumChildren() const
Get the number of children for this entry.
Definition: station_gui.cpp:984
Scrollbar::GetCount
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:653
tilehighlight_func.h
CircularTileSearch
bool CircularTileSearch(TileIndex *tile, uint size, TestTileOnSearchProc proc, void *user_data)
Function performing a search around a center tile and going outward, thus in circle.
Definition: map.cpp:258
WID_STL_CARGOSTART
@ WID_STL_CARGOSTART
Widget numbers used for list of cargo types (not present in _company_stations_widgets).
Definition: station_widget.h:55
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
CargoPacket::SourceStation
StationID SourceStation() const
Gets the ID of the station where the cargo was loaded for the first time.
Definition: cargopacket.h:159
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:207
CompanyStationsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: station_gui.cpp:370
StationViewWindow::DrawAcceptedCargo
int DrawAcceptedCargo(const Rect &r) const
Draw accepted cargo in the WID_SV_ACCEPT_RATING_LIST widget.
Definition: station_gui.cpp:1827
StationCoverageType
StationCoverageType
Types of cargo to display for station coverage.
Definition: station_gui.h:19
StationViewWindow::SetDisplayedRow
void SetDisplayedRow(const CargoDataEntry *data)
Mark a specific row, characterized by its CargoDataEntry, as expanded.
Definition: station_gui.cpp:1650
StationViewWindow::ShowCargo
void ShowCargo(CargoDataEntry *data, CargoID cargo, StationID source, StationID next, StationID dest, uint count)
Show a certain cargo entry characterized by source/next/dest station, cargo ID and amount of cargo at...
Definition: station_gui.cpp:1355
StationViewWindow::RowDisplay::next_station
StationID next_station
ID of the station belonging to the entry actually displayed if it's to/from/via.
Definition: station_gui.cpp:1241
WID_STL_TRUCK
@ WID_STL_TRUCK
'TRUCK' button - list only facilities where is a truck stop.
Definition: station_widget.h:43
GoodsEntry::HasRating
bool HasRating() const
Does this cargo have a rating at this station?
Definition: station_base.h:270
CompanyStationsWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: station_gui.cpp:667
NWidgetResizeBase::SetResize
void SetResize(uint resize_x, uint resize_y)
Set resize step of the widget.
Definition: widget.cpp:916
GUIList< const Station * >::SortFunction
bool SortFunction(const const Station * &, const const Station * &)
Signature of sort function.
Definition: sortlist_type.h:48
CargoSpec::IsValid
bool IsValid() const
Tests for validity of this cargospec.
Definition: cargotype.h:100
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
GUIList::SetListing
void SetListing(Listing l)
Import sort conditions.
Definition: sortlist_type.h:130
StationViewWindow::HandleCargoWaitingClick
void HandleCargoWaitingClick(int row)
Handle a click on a specific row in the cargo view.
Definition: station_gui.cpp:1893
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
FS_SMALL
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:208
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
IsInsideBS
static bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
Definition: math_func.hpp:188
CMD_RENAME_STATION
@ CMD_RENAME_STATION
rename a station
Definition: command_type.h:248
StationViewWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: station_gui.cpp:1415
OrthogonalTileArea::w
uint16 w
The width of the area.
Definition: tilearea_type.h:20
GoodsEntry::node
NodeID node
ID of node in link graph referring to this goods entry.
Definition: station_base.h:255
CargoSortType
CargoSortType
Definition: station_gui.cpp:859
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:159
StationsWndShowStationRating
static void StationsWndShowStationRating(int left, int right, int y, CargoID type, uint amount, byte rating)
Draw small boxes of cargo amount and ratings data at the given coordinates.
Definition: station_gui.cpp:157
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
_cargo_mask
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition: cargotype.cpp:28
Station::airport
Airport airport
Tile area the airport covers.
Definition: station_base.h:461
WID_SV_SORT_ORDER
@ WID_SV_SORT_ORDER
'Sort order' button
Definition: station_widget.h:18
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
CargoWidgets
static NWidgetBase * CargoWidgets(int *biggest_index)
Make a horizontal row of cargo buttons, starting at widget WID_STL_CARGOSTART.
Definition: station_gui.cpp:720
CompanyStationsWindow::StationTypeSorter
static bool StationTypeSorter(const Station *const &a, const Station *const &b)
Sort stations by their type.
Definition: station_gui.cpp:266
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:53
StationViewWindow::BuildFlowList
void BuildFlowList(CargoID i, const FlowStatMap &flows, CargoDataEntry *cargo)
Build up the cargo view for PLANNED mode and a specific cargo.
Definition: station_gui.cpp:1574
SelectStationWindow
Window for selecting stations/waypoints to (distant) join to.
Definition: station_gui.cpp:2266
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:386
Window::parent
Window * parent
Parent window.
Definition: window_gui.h:332
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
safeguards.h
sortlist_type.h
ShowQueryString
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1119
CargoDataEntry::Retrieve
CargoDataEntry * Retrieve(CargoID cargo) const
Retrieve a child for the given cargo.
Definition: station_gui.cpp:953
Airport::flags
uint64 flags
stores which blocks on the airport are taken. was 16 bit earlier on, then 32
Definition: station_base.h:305
WC_SHIPS_LIST
@ WC_SHIPS_LIST
Ships list; Window numbers:
Definition: window_type.h:312
CargoDataEntry::station
StationID station
ID of the station this entry is associated with.
Definition: station_gui.cpp:1024
StationViewWindow::groupings
Grouping groupings[NUM_COLUMNS]
Grouping modes for the different columns.
Definition: station_gui.cpp:1308
StationViewWindow::RecalcDestinations
void RecalcDestinations(CargoID i)
Rebuild the cache for estimated destinations which is used to quickly show the "destination" entries ...
Definition: station_gui.cpp:1487
CargoPacket::Count
uint16 Count() const
Gets the number of 'items' in this packet.
Definition: cargopacket.h:100
TileHighlightData::pos
Point pos
Location, in tile "units", of the northern tile of the selected area.
Definition: tilehighlight_type.h:47
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:1042
WID_SV_LOCATION
@ WID_SV_LOCATION
'Location' button.
Definition: station_widget.h:23
TileAndStation::tile
TileIndex tile
TileIndex.
Definition: station_gui.cpp:2149
StationViewWindow::MODE_WAITING
@ MODE_WAITING
Show cargo waiting at the station.
Definition: station_gui.cpp:1276
CargoDataEntry::Remove
void Remove(StationID station)
Remove a child associated with the given station.
Definition: station_gui.cpp:921
GoodsEntry::rating
byte rating
Station rating for this cargo.
Definition: station_base.h:232
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
ST_CARGO_ID
@ ST_CARGO_ID
by cargo id
Definition: station_gui.cpp:864
GameSettings::linkgraph
LinkGraphSettings linkgraph
settings for link graph calculations
Definition: settings_type.h:587
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition: window_type.h:300
StationCargoList::AvailableCount
uint AvailableCount() const
Returns sum of cargo still available for loading at the sation.
Definition: cargopacket.h:508
WID_STL_CARGOALL
@ WID_STL_CARGOALL
'ALL' button - list all stations.
Definition: station_widget.h:50
CargoDataEntry::GetParent
CargoDataEntry * GetParent() const
Get the parent entry for this entry.
Definition: station_gui.cpp:979
ShowDropDownMenu
void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)
Show a dropdown menu window near a widget of the parent window.
Definition: dropdown.cpp:480
FACIL_DOCK
@ FACIL_DOCK
Station with a dock.
Definition: station_type.h:56
StationSettings::station_spread
byte station_spread
amount a station may spread
Definition: settings_type.h:553
CompanyStationsWindow::StationWaitingTotalSorter
static bool StationWaitingTotalSorter(const Station *const &a, const Station *const &b)
Sort stations by their waiting cargo.
Definition: station_gui.cpp:272
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:117
GetCommandFlags
CommandFlags GetCommandFlags(uint32 cmd)
Definition: command.cpp:393
GoodsEntry::link_graph
LinkGraphID link_graph
Link graph this station belongs to.
Definition: station_base.h:254
SelectStationWindow::OnMouseOver
void OnMouseOver(Point pt, int widget) override
The mouse is currently moving over the window or has just moved outside of the window.
Definition: station_gui.cpp:2381
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:220
GUIList::ToggleSortOrder
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here.
Definition: sortlist_type.h:233
GUIList::NeedResort
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
Definition: sortlist_type.h:199
CS_ALPHANUMERAL
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
viewport_func.h
CompanyStationsWindow::SortStationsList
void SortStationsList()
Sort the stations list.
Definition: station_gui.cpp:325
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
StationViewWindow::_group_names
static const StringID _group_names[]
Names of the grouping options in the dropdown.
Definition: station_gui.cpp:1292
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:329
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
FACIL_WAYPOINT
@ FACIL_WAYPOINT
Station is a waypoint.
Definition: station_type.h:57
ShowSelectStationIfNeeded
void ShowSelectStationIfNeeded(const CommandContainer &cmd, TileArea ta)
Show the station selection window when needed.
Definition: station_gui.cpp:2464
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
NWidgetResizeBase::SetFill
void SetFill(uint fill_x, uint fill_y)
Set the filling of the widget from initial size.
Definition: widget.cpp:905
GetTileOwner
static Owner GetTileOwner(TileIndex tile)
Returns the owner of a tile.
Definition: tile_map.h:178
FONT_HEIGHT_SMALL
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:164
WID_STL_SHIP
@ WID_STL_SHIP
'SHIP' button - list only facilities where is a dock.
Definition: station_widget.h:46
OrthogonalTileArea::h
uint16 h
The height of the area.
Definition: tilearea_type.h:21
DistanceMax
uint DistanceMax(TileIndex t0, TileIndex t1)
Gets the biggest distance component (x or y) between the two given tiles.
Definition: map.cpp:189
StationCargoList::ReservedCount
uint ReservedCount() const
Returns sum of cargo reserved for loading onto vehicles.
Definition: cargopacket.h:517
WID_STL_NOCARGOWAITING
@ WID_STL_NOCARGOWAITING
'NO' button - list stations where no cargo is waiting.
Definition: station_widget.h:49
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
MAX_LENGTH_STATION_NAME_CHARS
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
Definition: station_type.h:87
TileHighlightData::dirty
byte dirty
Whether the build station window needs to redraw due to the changed selection.
Definition: tilehighlight_type.h:58
GUIList::NeedRebuild
bool NeedRebuild() const
Check if a rebuild is needed.
Definition: sortlist_type.h:362
TileHighlightData::drawstyle
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
Definition: tilehighlight_type.h:64
DrawStationCoverageAreaText
int DrawStationCoverageAreaText(int left, int right, int top, StationCoverageType sct, int rad, bool supplies)
Calculates and draws the accepted or supplied cargo around the selected tile(s)
Definition: station_gui.cpp:54
WID_STL_SORTDROPBTN
@ WID_STL_SORTDROPBTN
Dropdown button.
Definition: station_widget.h:53
SelectStationWindow::select_station_cmd
CommandContainer select_station_cmd
Command to build new station.
Definition: station_gui.cpp:2267
string_func.h
AIRPORT_CLOSED_block
static const uint64 AIRPORT_CLOSED_block
Dummy block for indicating a closed airport.
Definition: airport.h:128
SCT_ALL
@ SCT_ALL
Draw all cargoes.
Definition: station_gui.h:22
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
SBS_DOWN
@ SBS_DOWN
Sort ascending.
Definition: window_gui.h:226
CargoDataEntry::SetTransfers
void SetTransfers(bool value)
Set the transfers state.
Definition: station_gui.cpp:1004
GoodsEntry
Stores station stats for a single cargo.
Definition: station_base.h:167
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
WC_SELECT_STATION
@ WC_SELECT_STATION
Select station (when joining stations); Window numbers:
Definition: window_type.h:234
station_base.h
Pool::PoolItem<&_station_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
ST_STATION_STRING
@ ST_STATION_STRING
by station name
Definition: station_gui.cpp:862
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
_sorted_standard_cargo_specs
span< const CargoSpec * > _sorted_standard_cargo_specs
Standard cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:153
StationViewWindow::Invalidation
Invalidation
Type of data invalidation.
Definition: station_gui.cpp:1257
StationViewWindow::displayed_rows
CargoDataVector displayed_rows
Parent entry of currently displayed rows (including collapsed ones).
Definition: station_gui.cpp:1312
NWidgetCore::SetDataTip
void SetDataTip(uint32 widget_data, StringID tool_tip)
Set data and tool tip of the nested widget.
Definition: widget.cpp:962
MapMaxY
static uint MapMaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition: map_func.h:111
Window::IsShaded
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:520
NWidgetHorizontal
Horizontal container.
Definition: widget_type.h:493
CargoDataEntry::Update
void Update(uint count)
Update the count for this entry and propagate the change to the parent entry if there is one.
Definition: station_gui.cpp:1139
TileXY
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:163
CargoDataEntry::Retrieve
CargoDataEntry * Retrieve(StationID station) const
Retrieve a child for the given station.
Definition: station_gui.cpp:942
CargoDataEntry::Clear
void Clear()
Delete all subentries, reset count and num_children and adapt parent's count.
Definition: station_gui.cpp:1084
CargoDataEntry::GetStation
StationID GetStation() const
Get the station ID for this entry.
Definition: station_gui.cpp:964
FACIL_TRAIN
@ FACIL_TRAIN
Station with train station.
Definition: station_type.h:52
StationViewWindow::RowDisplay::next_cargo
CargoID next_cargo
ID of the cargo belonging to the entry actually displayed if it's cargo.
Definition: station_gui.cpp:1246
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:167
GoodsEntry::flows
FlowStatMap flows
Planned flows through this station.
Definition: station_base.h:256
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
StationViewWindow::sort_orders
SortOrder sort_orders[NUM_COLUMNS]
Sort order (ascending/descending) for the 'columns'.
Definition: station_gui.cpp:1303
SCT_NON_PASSENGERS_ONLY
@ SCT_NON_PASSENGERS_ONLY
Draw all non-passenger class cargoes.
Definition: station_gui.h:21
geometry_func.hpp
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
SelectStationWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: station_gui.cpp:2313
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
WID_STL_BUS
@ WID_STL_BUS
'BUS' button - list only facilities where is a bus stop.
Definition: station_widget.h:44
WID_SV_ACCEPT_RATING_LIST
@ WID_SV_ACCEPT_RATING_LIST
List of accepted cargoes / rating of cargoes.
Definition: station_widget.h:22
FlowStatMap
Flow descriptions by origin stations.
Definition: station_base.h:149
TileAndStation::station
StationID station
StationID.
Definition: station_gui.cpp:2150
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
GUIList::GetListing
Listing GetListing() const
Export current sort conditions.
Definition: sortlist_type.h:116
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
Window::IsWidgetLowered
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:487
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:51
GUISettings::station_gui_sort_order
uint8 station_gui_sort_order
the sort order of entries in the station gui - ascending or descending
Definition: settings_type.h:181
WID_SV_GROUP
@ WID_SV_GROUP
label for "group by"
Definition: station_widget.h:16
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
GoodsEntry::GES_ACCEPTANCE
@ GES_ACCEPTANCE
Set when the station accepts the cargo currently for final deliveries.
Definition: station_base.h:174
GetStationIndex
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:28
SpecializedStation< Station, false >::GetByTile
static Station * GetByTile(TileIndex tile)
Get the station belonging to a specific tile.
Definition: base_station_base.h:238
waypoint_base.h
HT_RECT
@ HT_RECT
rectangle (stations, depots, ...)
Definition: tilehighlight_type.h:21
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:671
cargotype.h
WID_STL_AIRPLANE
@ WID_STL_AIRPLANE
'AIRPLANE' button - list only facilities where is an airport.
Definition: station_widget.h:45
WID_SV_ACCEPTS_RATINGS
@ WID_SV_ACCEPTS_RATINGS
'Accepts' / 'Ratings' button.
Definition: station_widget.h:24
linkgraph.h
StationViewWindow::Mode
Mode
Display mode of the cargo view.
Definition: station_gui.cpp:1275
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:53
BaseStation
Base class for all station-ish types.
Definition: base_station_base.h:52
HasStationInUse
bool HasStationInUse(StationID station, bool include_company, CompanyID company)
Tests whether the company's vehicles have this station in orders.
Definition: station_cmd.cpp:2493
company_func.h
SetViewportCatchmentStation
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
Definition: viewport.cpp:3524
CargoDataEntry::HasTransfers
bool HasTransfers() const
Has this entry transfers.
Definition: station_gui.cpp:999
MapMaxX
static uint MapMaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition: map_func.h:102
CargoSpec::abbrev
StringID abbrev
Two letter abbreviation for this cargo type.
Definition: cargotype.h:76
GUIList::ForceResort
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Definition: sortlist_type.h:213
TILE_ADDXY
#define TILE_ADDXY(tile, x, y)
Adds a given offset to a tile.
Definition: map_func.h:258
StationSettings::distant_join_stations
bool distant_join_stations
allow to join non-adjacent stations
Definition: settings_type.h:551
StationViewWindow::GR_NEXT
@ GR_NEXT
Group by next station ("via").
Definition: station_gui.cpp:1267
StationJoinerNeeded
static bool StationJoinerNeeded(const CommandContainer &cmd, TileArea ta)
Check whether we need to show the station selection window.
Definition: station_gui.cpp:2415
StationViewWindow::ALH_RATING
@ ALH_RATING
Height of the cargo ratings view.
Definition: station_gui.cpp:1287
StationSettings::adjacent_stations
bool adjacent_stations
allow stations to be built directly adjacent to other stations
Definition: settings_type.h:550
WID_STL_SCROLLBAR
@ WID_STL_SCROLLBAR
Scrollbar next to the main panel.
Definition: station_widget.h:39
window_func.h
CargoDataEntry
A cargo data entry representing one possible row in the station view window's top part.
Definition: station_gui.cpp:890
GUIList::ForceRebuild
void ForceRebuild()
Force that a rebuild is needed.
Definition: sortlist_type.h:370
CommandFlagsToDCFlags
static DoCommandFlag CommandFlagsToDCFlags(CommandFlags cmd_flags)
Extracts the DC flags needed for DoCommand from the flags returned by GetCommandFlags.
Definition: command_func.h:58
ToggleBit
static T ToggleBit(T &x, const uint8 y)
Toggles a bit in a variable.
Definition: bitmath_func.hpp:181
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
Window::ToggleWidgetLoweredState
void ToggleWidgetLoweredState(byte widget_index)
Invert the lowered/raised status of a widget.
Definition: window_gui.h:457
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:69
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
SelectStationWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: station_gui.cpp:2373
CargoPacket
Container for cargo from the same location and time.
Definition: cargopacket.h:43
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition: widget.cpp:2172
Window::SortButtonWidth
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:690
StationViewWindow::SelectSortOrder
void SelectSortOrder(SortOrder order)
Select a new sort order for the cargo view.
Definition: station_gui.cpp:1991
StationViewWindow::SelectGroupBy
void SelectGroupBy(int index)
Select a new grouping mode for the cargo view.
Definition: station_gui.cpp:2034
WID_STL_TRAIN
@ WID_STL_TRAIN
'TRAIN' button - list only facilities where is a railroad station.
Definition: station_widget.h:42
CargoDataEntry::count
uint count
sum of counts of all children or amount of cargo for this entry.
Definition: station_gui.cpp:1031
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
WID_STL_FACILALL
@ WID_STL_FACILALL
'ALL' button - list all facilities.
Definition: station_widget.h:47
StationViewWindow::accepts_lines
int accepts_lines
Number of lines in the accepted cargo view.
Definition: station_gui.cpp:1282
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
SelectStationWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: station_gui.cpp:2293
CargoDataEntry::parent
CargoDataEntry * parent
the parent of this entry.
Definition: station_gui.cpp:1022
ST_AS_GROUPING
@ ST_AS_GROUPING
by the same principle the entries are being grouped
Definition: station_gui.cpp:860
StationViewWindow::scroll_to_row
int scroll_to_row
If set, scroll the main viewport to the station pointed to by this row.
Definition: station_gui.cpp:1305
strnatcmp
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:718
CargoSorter
Definition: station_gui.cpp:867
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
CargoDataEntry::Remove
void Remove(CargoID cargo)
Remove a child associated with the given cargo.
Definition: station_gui.cpp:931
gui.h
CeilDiv
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:254
StationViewWindow::GR_CARGO
@ GR_CARGO
Group by cargo type.
Definition: station_gui.cpp:1269
WID_SV_CLOSE_AIRPORT
@ WID_SV_CLOSE_AIRPORT
'Close airport' button.
Definition: station_widget.h:26
Window
Data structure for an opened window.
Definition: window_gui.h:279
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition: sortlist_type.h:380
ShowSelectWaypointIfNeeded
void ShowSelectWaypointIfNeeded(const CommandContainer &cmd, TileArea ta)
Show the waypoint selection window when needed.
Definition: station_gui.cpp:2474
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
ST_COUNT
@ ST_COUNT
by amount of cargo
Definition: station_gui.cpp:861
CompanyStationsWindow::OnGameTick
void OnGameTick() override
Called once per (game) tick.
Definition: station_gui.cpp:659
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
Window::RaiseWidget
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:477
StationViewWindow::rating_lines
int rating_lines
Number of lines in the cargo ratings view.
Definition: station_gui.cpp:1281
_viewport_highlight_station
const Station * _viewport_highlight_station
Currently selected station for coverage area highlight.
Definition: viewport.cpp:990
SelectStationWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: station_gui.cpp:2334
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:636
StationViewWindow::expanded_rows
CargoDataEntry expanded_rows
Parent entry of currently expanded rows.
Definition: station_gui.cpp:1310
FACIL_AIRPORT
@ FACIL_AIRPORT
Station with an airport.
Definition: station_type.h:55
NWidgetBackground
Nested widget with a child.
Definition: widget_type.h:584
CompanyStationsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: station_gui.cpp:434
StationViewWindow::Grouping
Grouping
Type of grouping used in each of the "columns".
Definition: station_gui.cpp:1265
CompanyStationsWindow::StationNameSorter
static bool StationNameSorter(const Station *const &a, const Station *const &b)
Sort stations by their name.
Definition: station_gui.cpp:258
SBS_UP
@ SBS_UP
Sort descending.
Definition: window_gui.h:227
CompanyStationsWindow::StationRatingMinSorter
static bool StationRatingMinSorter(const Station *const &a, const Station *const &b)
Sort stations by their rating.
Definition: station_gui.cpp:310
WID_SV_SCROLLBAR
@ WID_SV_SCROLLBAR
Scrollbar.
Definition: station_widget.h:21
CT_INVALID
@ CT_INVALID
Invalid cargo type.
Definition: cargo_type.h:69
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:311
WID_SV_CAPTION
@ WID_SV_CAPTION
Caption of the window.
Definition: station_widget.h:15
IsCargoInClass
static bool IsCargoInClass(CargoID c, CargoClass cc)
Does cargo c have cargo class cc?
Definition: cargotype.h:194
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:608
StationViewWindow::EstimateDestinations
void EstimateDestinations(CargoID cargo, StationID source, StationID next, uint count, CargoDataEntry *dest)
Estimate the amounts of cargo per final destination for a given cargo, source station and next hop an...
Definition: station_gui.cpp:1521
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
WID_SV_SHIPS
@ WID_SV_SHIPS
List of scheduled ships button.
Definition: station_widget.h:29
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
Window::LowerWidget
void LowerWidget(byte widget_index)
Marks a widget as lowered.
Definition: window_gui.h:468
TileAndStation
Struct containing TileIndex and StationID.
Definition: station_gui.cpp:2148
Town::exclusivity
CompanyID exclusivity
which company has exclusivity
Definition: town.h:71
WC_AIRCRAFT_LIST
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Definition: window_type.h:318
FindStationsNearby
static const T * FindStationsNearby(TileArea ta, bool distant_join)
Circulate around the to-be-built station to find stations we could join.
Definition: station_gui.cpp:2206
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
Town::exclusive_counter
uint8 exclusive_counter
months till the exclusivity expires
Definition: town.h:72
WC_STATION_LIST
@ WC_STATION_LIST
Station list; Window numbers:
Definition: window_type.h:294
WD_PAR_VSEP_WIDE
@ WD_PAR_VSEP_WIDE
Large amount of vertical space between two paragraphs of text.
Definition: window_gui.h:140
SelectStationWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: station_gui.cpp:2355
WID_SV_TRAINS
@ WID_SV_TRAINS
List of scheduled trains button.
Definition: station_widget.h:27
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3423
NWidgetResizeBase::SetMinimalSize
void SetMinimalSize(uint min_x, uint min_y)
Set minimal size of the widget.
Definition: widget.cpp:866
PC_GREEN
static const uint8 PC_GREEN
Green palette colour.
Definition: gfx_func.h:209
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:447
station_gui.h
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
TileHighlightData::freeze
bool freeze
Freeze highlight in place.
Definition: tilehighlight_type.h:53
CompanyStationsWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: station_gui.cpp:647
CargoDataEntry::Begin
CargoDataSet::iterator Begin() const
Get an iterator pointing to the begin of the set of children.
Definition: station_gui.cpp:989
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:594
station_widget.h
debug.h
WID_SV_PLANES
@ WID_SV_PLANES
List of scheduled planes button.
Definition: station_widget.h:30
LinkGraph::Monthly
uint Monthly(uint base) const
Scale a value to its monthly equivalent, based on last compression.
Definition: linkgraph.h:527
CargoDataEntry::transfers
bool transfers
If there are transfers for this cargo.
Definition: station_gui.cpp:1027
SetMinimalTextLines
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:1028
WWT_DROPDOWN
@ WWT_DROPDOWN
Drop down list.
Definition: widget_type.h:68
GUIList::SetSortFuncs
void SetSortFuncs(SortFunction *const *n_funcs)
Hand the array of sort function pointers to the sort list.
Definition: sortlist_type.h:270
GUISettings::persistent_buildingtools
bool persistent_buildingtools
keep the building tools active after usage
Definition: settings_type.h:164
TileVirtXY
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
SelectStationWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: station_gui.cpp:2285
CargoDataEntry::IncrementSize
void IncrementSize()
Increment.
Definition: station_gui.cpp:1148
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092
CargoDataEntry::End
CargoDataSet::iterator End() const
Get an iterator pointing to the end of the set of children.
Definition: station_gui.cpp:994
WID_SV_RENAME
@ WID_SV_RENAME
'Rename' button.
Definition: station_widget.h:25