OpenTTD Source 20250528-master-g3aca5d62a8
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 "dropdown_type.h"
24#include "dropdown_func.h"
25#include "station_base.h"
26#include "waypoint_base.h"
27#include "tilehighlight_func.h"
28#include "company_base.h"
29#include "sortlist_type.h"
31#include "vehiclelist.h"
32#include "town.h"
33#include "linkgraph/linkgraph.h"
34#include "zoom_func.h"
35#include "station_cmd.h"
36
38
39#include "table/strings.h"
40
42
43#include "safeguards.h"
44
46{
47 using StationType = Station;
48
49 static bool IsValidID(StationID id) { return Station::IsValidID(id); }
50 static bool IsValidBaseStation(const BaseStation *st) { return Station::IsExpected(st); }
51 static bool IsAcceptableWaypointTile(TileIndex) { return false; }
52 static constexpr bool IsWaypoint() { return false; }
53};
54
55template <bool ROAD, TileType TILE_TYPE>
57{
58 using StationType = Waypoint;
59
60 static bool IsValidID(StationID id) { return Waypoint::IsValidID(id) && HasBit(Waypoint::Get(id)->waypoint_flags, WPF_ROAD) == ROAD; }
61 static bool IsValidBaseStation(const BaseStation *st) { return Waypoint::IsExpected(st) && HasBit(Waypoint::From(st)->waypoint_flags, WPF_ROAD) == ROAD; }
62 static bool IsAcceptableWaypointTile(TileIndex tile) { return IsTileType(tile, TILE_TYPE); }
63 static constexpr bool IsWaypoint() { return true; }
64};
67
76int DrawStationCoverageAreaText(const Rect &r, StationCoverageType sct, int rad, bool supplies)
77{
78 TileIndex tile = TileVirtXY(_thd.pos.x, _thd.pos.y);
79 CargoTypes cargo_mask = 0;
80 if (_thd.drawstyle == HT_RECT && tile < Map::Size()) {
81 CargoArray cargoes;
82 if (supplies) {
83 cargoes = GetProductionAroundTiles(tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE, rad);
84 } else {
85 cargoes = GetAcceptanceAroundTiles(tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE, rad);
86 }
87
88 /* Convert cargo counts to a set of cargo bits, and draw the result. */
89 for (CargoType cargo = 0; cargo < NUM_CARGO; ++cargo) {
90 switch (sct) {
91 case SCT_PASSENGERS_ONLY: if (!IsCargoInClass(cargo, CargoClass::Passengers)) continue; break;
92 case SCT_NON_PASSENGERS_ONLY: if (IsCargoInClass(cargo, CargoClass::Passengers)) continue; break;
93 case SCT_ALL: break;
94 default: NOT_REACHED();
95 }
96 if (cargoes[cargo] >= (supplies ? 1U : 8U)) SetBit(cargo_mask, cargo);
97 }
98 }
99 return DrawStringMultiLine(r, GetString(supplies ? STR_STATION_BUILD_SUPPLIES_CARGO : STR_STATION_BUILD_ACCEPTS_CARGO, cargo_mask));
100}
101
106template <typename T>
108{
109 /* With distant join we don't know which station will be selected, so don't show any */
110 if (_ctrl_pressed) {
111 SetViewportCatchmentSpecializedStation<typename T::StationType>(nullptr, true);
112 return;
113 }
114
115 /* Tile area for TileHighlightData */
116 TileArea location(TileVirtXY(_thd.pos.x, _thd.pos.y), _thd.size.x / TILE_SIZE - 1, _thd.size.y / TILE_SIZE - 1);
117
118 /* If the current tile is already a station, then it must be the nearest station. */
119 if (IsTileType(location.tile, MP_STATION) && GetTileOwner(location.tile) == _local_company) {
120 typename T::StationType *st = T::StationType::GetByTile(location.tile);
121 if (st != nullptr && T::IsValidBaseStation(st)) {
122 SetViewportCatchmentSpecializedStation<typename T::StationType>(st, true);
123 return;
124 }
125 }
126
127 /* Extended area by one tile */
128 uint x = TileX(location.tile);
129 uint y = TileY(location.tile);
130
131 /* Waypoints can only be built on existing rail/road tiles, so don't extend area if not highlighting a rail tile. */
132 int max_c = T::IsWaypoint() && !T::IsAcceptableWaypointTile(location.tile) ? 0 : 1;
133 TileArea ta(TileXY(std::max<int>(0, x - max_c), std::max<int>(0, y - max_c)), TileXY(std::min<int>(Map::MaxX(), x + location.w + max_c), std::min<int>(Map::MaxY(), y + location.h + max_c)));
134
135 typename T::StationType *adjacent = nullptr;
136
137 /* Direct loop instead of ForAllStationsAroundTiles as we are not interested in catchment area */
138 for (TileIndex tile : ta) {
139 if (IsTileType(tile, MP_STATION) && GetTileOwner(tile) == _local_company) {
140 typename T::StationType *st = T::StationType::GetByTile(tile);
141 if (st == nullptr || !T::IsValidBaseStation(st)) continue;
142 if (adjacent != nullptr && st != adjacent) {
143 /* Multiple nearby, distant join is required. */
144 adjacent = nullptr;
145 break;
146 }
147 adjacent = st;
148 }
149 }
150 SetViewportCatchmentSpecializedStation<typename T::StationType>(adjacent, true);
151}
152
159{
160 /* Test if ctrl state changed */
161 static bool _last_ctrl_pressed;
162 if (_ctrl_pressed != _last_ctrl_pressed) {
163 _thd.dirty = 0xff;
164 _last_ctrl_pressed = _ctrl_pressed;
165 }
166
167 if (_thd.dirty & 1) {
168 _thd.dirty &= ~1;
169 w->SetDirty();
170
172 FindStationsAroundSelection<StationTypeFilter>();
173 }
174 }
175}
176
177template <typename T>
178void CheckRedrawWaypointCoverage()
179{
180 /* Test if ctrl state changed */
181 static bool _last_ctrl_pressed;
182 if (_ctrl_pressed != _last_ctrl_pressed) {
183 _thd.dirty = 0xff;
184 _last_ctrl_pressed = _ctrl_pressed;
185 }
186
187 if (_thd.dirty & 1) {
188 _thd.dirty &= ~1;
189
190 if (_thd.drawstyle == HT_RECT) {
191 FindStationsAroundSelection<T>();
192 }
193 }
194}
195
196void CheckRedrawRailWaypointCoverage(const Window *)
197{
198 CheckRedrawWaypointCoverage<RailWaypointTypeFilter>();
199}
200
201void CheckRedrawRoadWaypointCoverage(const Window *)
202{
203 CheckRedrawWaypointCoverage<RoadWaypointTypeFilter>();
204}
205
218static void StationsWndShowStationRating(int left, int right, int y, CargoType cargo, uint amount, uint8_t rating)
219{
220 static const uint units_full = 576;
221 static const uint rating_full = 224;
222
223 const CargoSpec *cs = CargoSpec::Get(cargo);
224 if (!cs->IsValid()) return;
225
226 int padding = ScaleGUITrad(1);
227 int width = right - left;
228 int colour = cs->rating_colour;
229 TextColour tc = GetContrastColour(colour);
230 uint w = std::min(amount + 5, units_full) * width / units_full;
231
232 int height = GetCharacterHeight(FS_SMALL) + padding - 1;
233
234 if (amount > 30) {
235 /* Draw total cargo (limited) on station */
236 GfxFillRect(left, y, left + w - 1, y + height, colour);
237 } else {
238 /* Draw a (scaled) one pixel-wide bar of additional cargo meter, useful
239 * for stations with only a small amount (<=30) */
240 uint rest = ScaleGUITrad(amount) / 5;
241 if (rest != 0) {
242 GfxFillRect(left, y + height - rest, left + padding - 1, y + height, colour);
243 }
244 }
245
246 DrawString(left + padding, right, y, cs->abbrev, tc, SA_CENTER, false, FS_SMALL);
247
248 /* Draw green/red ratings bar (fits under the waiting bar) */
249 y += height + padding + 1;
250 GfxFillRect(left + padding, y, right - padding - 1, y + padding - 1, PC_RED);
251 w = std::min<uint>(rating, rating_full) * (width - padding - padding) / rating_full;
252 if (w != 0) GfxFillRect(left + padding, y, left + w - 1, y + padding - 1, PC_GREEN);
253}
254
256
261{
262protected:
263 /* Runtime saved values */
264 struct FilterState {
265 Listing last_sorting;
268 CargoTypes cargoes;
269 };
270
271 static inline FilterState initial_state = {
272 {false, 0},
274 true,
275 ALL_CARGOTYPES,
276 };
277
278 /* Constants for sorting stations */
279 static inline const StringID sorter_names[] = {
280 STR_SORT_BY_NAME,
281 STR_SORT_BY_FACILITY,
282 STR_SORT_BY_WAITING_TOTAL,
283 STR_SORT_BY_WAITING_AVAILABLE,
284 STR_SORT_BY_RATING_MAX,
285 STR_SORT_BY_RATING_MIN,
286 };
287 static const std::initializer_list<GUIStationList::SortFunction * const> sorter_funcs;
288
289 FilterState filter{};
290 GUIStationList stations{filter.cargoes};
291 Scrollbar *vscroll = nullptr;
292 uint rating_width = 0;
293 bool filter_expanded = false;
294 std::array<uint16_t, NUM_CARGO> stations_per_cargo_type{};
296
303 {
304 if (!this->stations.NeedRebuild()) return;
305
306 Debug(misc, 3, "Building station list for company {}", owner);
307
308 this->stations.clear();
309 this->stations_per_cargo_type.fill(0);
310 this->stations_per_cargo_type_no_rating = 0;
311
312 for (const Station *st : Station::Iterate()) {
313 if (this->filter.facilities.Any(st->facilities)) { // only stations with selected facilities
314 if (st->owner == owner || (st->owner == OWNER_NONE && HasStationInUse(st->index, true, owner))) {
315 bool has_rating = false;
316 /* Add to the station/cargo counts. */
317 for (CargoType cargo = 0; cargo < NUM_CARGO; ++cargo) {
318 if (st->goods[cargo].HasRating()) this->stations_per_cargo_type[cargo]++;
319 }
320 for (CargoType cargo = 0; cargo < NUM_CARGO; ++cargo) {
321 if (st->goods[cargo].HasRating()) {
322 has_rating = true;
323 if (HasBit(this->filter.cargoes, cargo)) {
324 this->stations.push_back(st);
325 break;
326 }
327 }
328 }
329 /* Stations with no cargo rating. */
330 if (!has_rating) {
331 if (this->filter.include_no_rating) this->stations.push_back(st);
332 this->stations_per_cargo_type_no_rating++;
333 }
334 }
335 }
336 }
337
338 this->stations.RebuildDone();
339
340 this->vscroll->SetCount(this->stations.size()); // Update the scrollbar
341 }
342
344 static bool StationNameSorter(const Station * const &a, const Station * const &b, const CargoTypes &)
345 {
346 int r = StrNaturalCompare(a->GetCachedName(), b->GetCachedName()); // Sort by name (natural sorting).
347 if (r == 0) return a->index < b->index;
348 return r < 0;
349 }
350
352 static bool StationTypeSorter(const Station * const &a, const Station * const &b, const CargoTypes &)
353 {
354 return a->facilities < b->facilities;
355 }
356
358 static bool StationWaitingTotalSorter(const Station * const &a, const Station * const &b, const CargoTypes &cargo_filter)
359 {
360 int diff = 0;
361
362 for (CargoType cargo : SetCargoBitIterator(cargo_filter)) {
363 diff += (a->goods[cargo].HasData() ? a->goods[cargo].GetData().cargo.TotalCount() : 0) - (b->goods[cargo].HasData() ? b->goods[cargo].GetData().cargo.TotalCount() : 0);
364 }
365
366 return diff < 0;
367 }
368
370 static bool StationWaitingAvailableSorter(const Station * const &a, const Station * const &b, const CargoTypes &cargo_filter)
371 {
372 int diff = 0;
373
374 for (CargoType cargo : SetCargoBitIterator(cargo_filter)) {
375 diff += (a->goods[cargo].HasData() ? a->goods[cargo].GetData().cargo.AvailableCount() : 0) - (b->goods[cargo].HasData() ? b->goods[cargo].GetData().cargo.AvailableCount() : 0);
376 }
377
378 return diff < 0;
379 }
380
382 static bool StationRatingMaxSorter(const Station * const &a, const Station * const &b, const CargoTypes &cargo_filter)
383 {
384 uint8_t maxr1 = 0;
385 uint8_t maxr2 = 0;
386
387 for (CargoType cargo : SetCargoBitIterator(cargo_filter)) {
388 if (a->goods[cargo].HasRating()) maxr1 = std::max(maxr1, a->goods[cargo].rating);
389 if (b->goods[cargo].HasRating()) maxr2 = std::max(maxr2, b->goods[cargo].rating);
390 }
391
392 return maxr1 < maxr2;
393 }
394
396 static bool StationRatingMinSorter(const Station * const &a, const Station * const &b, const CargoTypes &cargo_filter)
397 {
398 uint8_t minr1 = 255;
399 uint8_t minr2 = 255;
400
401 for (CargoType cargo : SetCargoBitIterator(cargo_filter)) {
402 if (a->goods[cargo].HasRating()) minr1 = std::min(minr1, a->goods[cargo].rating);
403 if (b->goods[cargo].HasRating()) minr2 = std::min(minr2, b->goods[cargo].rating);
404 }
405
406 return minr1 > minr2;
407 }
408
411 {
412 if (!this->stations.Sort()) return;
413
414 /* Set the modified widget dirty */
416 }
417
418public:
420 {
421 /* Load initial filter state. */
422 this->filter = CompanyStationsWindow::initial_state;
423 if (this->filter.cargoes == ALL_CARGOTYPES) this->filter.cargoes = _cargo_mask;
424
425 this->stations.SetListing(this->filter.last_sorting);
426 this->stations.SetSortFuncs(CompanyStationsWindow::sorter_funcs);
427 this->stations.ForceRebuild();
428 this->stations.NeedResort();
429 this->SortStationsList();
430
431 this->CreateNestedTree();
432 this->vscroll = this->GetScrollbar(WID_STL_SCROLLBAR);
433 this->FinishInitNested(window_number);
434 this->owner = this->window_number;
435
436 if (this->filter.cargoes == ALL_CARGOTYPES) this->filter.cargoes = _cargo_mask;
437
438 for (uint i = 0; i < 5; i++) {
439 if (HasBit(this->filter.facilities.base(), i)) this->LowerWidget(i + WID_STL_TRAIN);
440 }
441
442 this->GetWidget<NWidgetCore>(WID_STL_SORTDROPBTN)->SetString(CompanyStationsWindow::sorter_names[this->stations.SortType()]);
443 }
444
446 {
447 /* Save filter state. */
448 this->filter.last_sorting = this->stations.GetListing();
449 CompanyStationsWindow::initial_state = this->filter;
450 }
451
452 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
453 {
454 switch (widget) {
455 case WID_STL_SORTBY: {
456 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->GetString());
457 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
458 d.height += padding.height;
459 size = maxdim(size, d);
460 break;
461 }
462
463 case WID_STL_SORTDROPBTN: {
464 Dimension d = GetStringListBoundingBox(CompanyStationsWindow::sorter_names);
465 d.width += padding.width;
466 d.height += padding.height;
467 size = maxdim(size, d);
468 break;
469 }
470
471 case WID_STL_LIST:
473 size.height = padding.height + 5 * resize.height;
474
475 /* Determine appropriate width for mini station rating graph */
476 this->rating_width = 0;
477 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
478 this->rating_width = std::max(this->rating_width, GetStringBoundingBox(cs->abbrev, FS_SMALL).width);
479 }
480 /* Approximately match original 16 pixel wide rating bars by multiplying string width by 1.6 */
481 this->rating_width = this->rating_width * 16 / 10;
482 break;
483 }
484 }
485
486 void OnPaint() override
487 {
488 this->BuildStationsList(this->window_number);
489 this->SortStationsList();
490
491 this->DrawWidgets();
492 }
493
494 void DrawWidget(const Rect &r, WidgetID widget) const override
495 {
496 switch (widget) {
497 case WID_STL_SORTBY:
498 /* draw arrow pointing up/down for ascending/descending sorting */
500 break;
501
502 case WID_STL_LIST: {
503 bool rtl = _current_text_dir == TD_RTL;
504 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
505 uint line_height = this->GetWidget<NWidgetBase>(widget)->resize_y;
506 /* Spacing between station name and first rating graph. */
507 int text_spacing = WidgetDimensions::scaled.hsep_wide;
508 /* Spacing between additional rating graphs. */
509 int rating_spacing = WidgetDimensions::scaled.hsep_normal;
510
511 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->stations);
512 for (auto it = first; it != last; ++it) {
513 const Station *st = *it;
514 assert(st->xy != INVALID_TILE);
515
516 /* Do not do the complex check HasStationInUse here, it may be even false
517 * when the order had been removed and the station list hasn't been removed yet */
518 assert(st->owner == owner || st->owner == OWNER_NONE);
519
520 int x = DrawString(tr.left, tr.right, tr.top + (line_height - GetCharacterHeight(FS_NORMAL)) / 2, GetString(STR_STATION_LIST_STATION, st->index, st->facilities));
521 x += rtl ? -text_spacing : text_spacing;
522
523 /* show cargo waiting and station ratings */
524 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
525 CargoType cargo_type = cs->Index();
526 if (st->goods[cargo_type].HasRating()) {
527 /* For RTL we work in exactly the opposite direction. So
528 * decrement the space needed first, then draw to the left
529 * instead of drawing to the left and then incrementing
530 * the space. */
531 if (rtl) {
532 x -= rating_width + rating_spacing;
533 if (x < tr.left) break;
534 }
535 StationsWndShowStationRating(x, x + rating_width, tr.top, cargo_type, st->goods[cargo_type].HasData() ? st->goods[cargo_type].GetData().cargo.TotalCount() : 0, st->goods[cargo_type].rating);
536 if (!rtl) {
537 x += rating_width + rating_spacing;
538 if (x > tr.right) break;
539 }
540 }
541 }
542 tr.top += line_height;
543 }
544
545 if (this->vscroll->GetCount() == 0) { // company has no stations
546 DrawString(tr.left, tr.right, tr.top + (line_height - GetCharacterHeight(FS_NORMAL)) / 2, STR_STATION_LIST_NONE);
547 return;
548 }
549 break;
550 }
551 }
552 }
553
554 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
555 {
556 if (widget == WID_STL_CAPTION) {
557 return GetString(STR_STATION_LIST_CAPTION, this->window_number, this->vscroll->GetCount());
558 }
559
560 if (widget == WID_STL_CARGODROPDOWN) {
561 if (this->filter.cargoes == 0) return GetString(this->filter.include_no_rating ? STR_STATION_LIST_CARGO_FILTER_ONLY_NO_RATING : STR_STATION_LIST_CARGO_FILTER_NO_CARGO_TYPES);
562 if (this->filter.cargoes == _cargo_mask) return GetString(this->filter.include_no_rating ? STR_STATION_LIST_CARGO_FILTER_ALL_AND_NO_RATING : STR_CARGO_TYPE_FILTER_ALL);
563 if (CountBits(this->filter.cargoes) == 1 && !this->filter.include_no_rating) return GetString(CargoSpec::Get(FindFirstBit(this->filter.cargoes))->name);
564 return GetString(STR_STATION_LIST_CARGO_FILTER_MULTIPLE);
565 }
566
567 return this->Window::GetWidgetString(widget, stringid);
568 }
569
570 DropDownList BuildCargoDropDownList(bool expanded) const
571 {
572 /* Define a custom item consisting of check mark, count string, icon and name string. */
574
575 DropDownList list;
576 list.push_back(MakeDropDownListStringItem(STR_STATION_LIST_CARGO_FILTER_SELECT_ALL, CargoFilterCriteria::CF_SELECT_ALL));
577 list.push_back(MakeDropDownListDividerItem());
578
579 bool any_hidden = false;
580
581 uint16_t count = this->stations_per_cargo_type_no_rating;
582 if (count == 0 && !expanded) {
583 any_hidden = true;
584 } else {
585 list.push_back(std::make_unique<DropDownString<DropDownListCheckedItem, FS_SMALL, true>>(fmt::format("{}", count), 0, this->filter.include_no_rating, GetString(STR_STATION_LIST_CARGO_FILTER_NO_RATING), CargoFilterCriteria::CF_NO_RATING, false, count == 0));
586 }
587
589 for (const CargoSpec *cs : _sorted_cargo_specs) {
590 count = this->stations_per_cargo_type[cs->Index()];
591 if (count == 0 && !expanded) {
592 any_hidden = true;
593 } else {
594 list.push_back(std::make_unique<DropDownListCargoItem>(HasBit(this->filter.cargoes, cs->Index()), fmt::format("{}", count), d, cs->GetCargoIcon(), PAL_NONE, GetString(cs->name), cs->Index(), false, count == 0));
595 }
596 }
597
598 if (!expanded && any_hidden) {
599 if (list.size() > 2) list.push_back(MakeDropDownListDividerItem());
600 list.push_back(MakeDropDownListStringItem(STR_STATION_LIST_CARGO_FILTER_EXPAND, CargoFilterCriteria::CF_EXPAND_LIST));
601 }
602
603 return list;
604 }
605
606 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
607 {
608 switch (widget) {
609 case WID_STL_LIST: {
610 auto it = this->vscroll->GetScrolledItemFromWidget(this->stations, pt.y, this, WID_STL_LIST, WidgetDimensions::scaled.framerect.top);
611 if (it == this->stations.end()) return; // click out of list bound
612
613 const Station *st = *it;
614 /* do not check HasStationInUse - it is slow and may be invalid */
615 assert(st->owner == this->window_number || st->owner == OWNER_NONE);
616
617 if (_ctrl_pressed) {
619 } else {
621 }
622 break;
623 }
624
625 case WID_STL_TRAIN:
626 case WID_STL_TRUCK:
627 case WID_STL_BUS:
628 case WID_STL_AIRPLANE:
629 case WID_STL_SHIP:
630 if (_ctrl_pressed) {
631 this->filter.facilities.Flip(static_cast<StationFacility>(widget - WID_STL_TRAIN));
632 this->ToggleWidgetLoweredState(widget);
633 } else {
634 for (StationFacility i : this->filter.facilities) {
636 }
637 this->filter.facilities = {};
638 this->filter.facilities.Set(static_cast<StationFacility>(widget - WID_STL_TRAIN));
639 this->LowerWidget(widget);
640 }
641 this->stations.ForceRebuild();
642 this->SetDirty();
643 break;
644
645 case WID_STL_FACILALL:
646 for (WidgetID i = WID_STL_TRAIN; i <= WID_STL_SHIP; i++) {
647 this->LowerWidget(i);
648 }
649
651 this->stations.ForceRebuild();
652 this->SetDirty();
653 break;
654
655 case WID_STL_SORTBY: // flip sorting method asc/desc
656 this->stations.ToggleSortOrder();
657 this->SetDirty();
658 break;
659
660 case WID_STL_SORTDROPBTN: // select sorting criteria dropdown menu
661 ShowDropDownMenu(this, CompanyStationsWindow::sorter_names, this->stations.SortType(), WID_STL_SORTDROPBTN, 0, 0);
662 break;
663
665 this->filter_expanded = false;
666 ShowDropDownList(this, this->BuildCargoDropDownList(this->filter_expanded), -1, widget, 0, false, true);
667 break;
668 }
669 }
670
671 void OnDropdownSelect(WidgetID widget, int index, int) override
672 {
673 if (widget == WID_STL_SORTDROPBTN) {
674 if (this->stations.SortType() != index) {
675 this->stations.SetSortType(index);
676
677 /* Display the current sort variant */
678 this->GetWidget<NWidgetCore>(WID_STL_SORTDROPBTN)->SetString(CompanyStationsWindow::sorter_names[this->stations.SortType()]);
679
680 this->SetDirty();
681 }
682 }
683
684 if (widget == WID_STL_CARGODROPDOWN) {
685 FilterState oldstate = this->filter;
686
687 if (index >= 0 && index < NUM_CARGO) {
688 if (_ctrl_pressed) {
689 ToggleBit(this->filter.cargoes, index);
690 } else {
691 this->filter.cargoes = 1ULL << index;
692 this->filter.include_no_rating = false;
693 }
694 } else if (index == CargoFilterCriteria::CF_NO_RATING) {
695 if (_ctrl_pressed) {
696 this->filter.include_no_rating = !this->filter.include_no_rating;
697 } else {
698 this->filter.include_no_rating = true;
699 this->filter.cargoes = 0;
700 }
701 } else if (index == CargoFilterCriteria::CF_SELECT_ALL) {
702 this->filter.cargoes = _cargo_mask;
703 this->filter.include_no_rating = true;
704 } else if (index == CargoFilterCriteria::CF_EXPAND_LIST) {
705 this->filter_expanded = true;
706 ReplaceDropDownList(this, this->BuildCargoDropDownList(this->filter_expanded));
707 return;
708 }
709
710 if (oldstate.cargoes != this->filter.cargoes || oldstate.include_no_rating != this->filter.include_no_rating) {
711 this->stations.ForceRebuild();
712 this->SetDirty();
713
714 /* Only refresh the list if it's changed. */
715 if (_ctrl_pressed) ReplaceDropDownList(this, this->BuildCargoDropDownList(this->filter_expanded));
716 }
717
718 /* Always close the list if ctrl is not pressed. */
720 }
721 }
722
723 void OnGameTick() override
724 {
725 if (this->stations.NeedResort()) {
726 Debug(misc, 3, "Periodic rebuild station list company {}", static_cast<int>(this->window_number));
727 this->SetDirty();
728 }
729 }
730
731 void OnResize() override
732 {
733 this->vscroll->SetCapacityFromWidget(this, WID_STL_LIST, WidgetDimensions::scaled.framerect.Vertical());
734 }
735
741 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
742 {
743 if (data == 0) {
744 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
745 this->stations.ForceRebuild();
746 } else {
747 this->stations.ForceResort();
748 }
749 }
750};
751
752/* Available station sorting functions */
753const std::initializer_list<GUIStationList::SortFunction * const> CompanyStationsWindow::sorter_funcs = {
754 &StationNameSorter,
755 &StationTypeSorter,
756 &StationWaitingTotalSorter,
757 &StationWaitingAvailableSorter,
758 &StationRatingMaxSorter,
759 &StationRatingMinSorter
760};
761
762static constexpr NWidgetPart _nested_company_stations_widgets[] = {
764 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
765 NWidget(WWT_CAPTION, COLOUR_GREY, WID_STL_CAPTION),
766 NWidget(WWT_SHADEBOX, COLOUR_GREY),
767 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
768 NWidget(WWT_STICKYBOX, COLOUR_GREY),
769 EndContainer(),
771 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_TRAIN), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetStringTip(STR_TRAIN, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE_TOOLTIP), SetFill(0, 1),
772 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_TRUCK), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetStringTip(STR_LORRY, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE_TOOLTIP), SetFill(0, 1),
773 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_BUS), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetStringTip(STR_BUS, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE_TOOLTIP), SetFill(0, 1),
774 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_SHIP), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetStringTip(STR_SHIP, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE_TOOLTIP), SetFill(0, 1),
775 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_AIRPLANE), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetStringTip(STR_PLANE, STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE_TOOLTIP), SetFill(0, 1),
776 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_STL_FACILALL), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetStringTip(STR_ABBREV_ALL, STR_STATION_LIST_SELECT_ALL_FACILITIES_TOOLTIP), SetTextStyle(TC_BLACK, FS_SMALL), SetFill(0, 1),
777 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(5, 0), SetFill(0, 1), EndContainer(),
778 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_STL_CARGODROPDOWN), SetFill(1, 0), SetToolTip(STR_STATION_LIST_USE_CTRL_TO_SELECT_MORE_TOOLTIP),
779 NWidget(WWT_PANEL, COLOUR_GREY), SetResize(1, 0), SetFill(1, 1), EndContainer(),
780 EndContainer(),
782 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_STL_SORTBY), SetMinimalSize(81, 12), SetStringTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
783 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_STL_SORTDROPBTN), SetMinimalSize(163, 12), SetStringTip(STR_SORT_BY_NAME, STR_TOOLTIP_SORT_CRITERIA), // widget_data gets overwritten.
784 NWidget(WWT_PANEL, COLOUR_GREY), SetResize(1, 0), SetFill(1, 1), EndContainer(),
785 EndContainer(),
787 NWidget(WWT_PANEL, COLOUR_GREY, WID_STL_LIST), SetMinimalSize(346, 125), SetResize(1, 10), SetToolTip(STR_STATION_LIST_TOOLTIP), SetScrollbar(WID_STL_SCROLLBAR), EndContainer(),
790 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
791 EndContainer(),
792 EndContainer(),
793};
794
795static WindowDesc _company_stations_desc(
796 WDP_AUTO, "list_stations", 358, 162,
798 {},
799 _nested_company_stations_widgets
800);
801
808{
809 if (!Company::IsValidID(company)) return;
810
811 AllocateWindowDescFront<CompanyStationsWindow>(_company_stations_desc, company);
812}
813
814static constexpr NWidgetPart _nested_station_view_widgets[] = {
816 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
817 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SV_RENAME), SetAspect(WidgetDimensions::ASPECT_RENAME), SetSpriteTip(SPR_RENAME, STR_STATION_VIEW_RENAME_TOOLTIP),
818 NWidget(WWT_CAPTION, COLOUR_GREY, WID_SV_CAPTION),
819 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SV_LOCATION), SetAspect(WidgetDimensions::ASPECT_LOCATION), SetSpriteTip(SPR_GOTO_LOCATION, STR_STATION_VIEW_CENTER_TOOLTIP),
820 NWidget(WWT_SHADEBOX, COLOUR_GREY),
821 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
822 NWidget(WWT_STICKYBOX, COLOUR_GREY),
823 EndContainer(),
825 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SV_GROUP), SetMinimalSize(81, 12), SetFill(1, 1), SetStringTip(STR_STATION_VIEW_GROUP),
826 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_SV_GROUP_BY), SetMinimalSize(168, 12), SetResize(1, 0), SetFill(0, 1), SetToolTip(STR_TOOLTIP_GROUP_ORDER),
827 EndContainer(),
829 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_SORT_ORDER), SetMinimalSize(81, 12), SetFill(1, 1), SetStringTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
830 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_SV_SORT_BY), SetMinimalSize(168, 12), SetResize(1, 0), SetFill(0, 1), SetToolTip(STR_TOOLTIP_SORT_CRITERIA),
831 EndContainer(),
835 EndContainer(),
838 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_ACCEPTS_RATINGS), SetMinimalSize(46, 12), SetResize(1, 0), SetFill(1, 1),
839 SetStringTip(STR_STATION_VIEW_RATINGS_BUTTON, STR_STATION_VIEW_RATINGS_TOOLTIP),
840 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SV_CLOSE_AIRPORT), SetMinimalSize(45, 12), SetResize(1, 0), SetFill(1, 1),
841 SetStringTip(STR_STATION_VIEW_CLOSE_AIRPORT, STR_STATION_VIEW_CLOSE_AIRPORT_TOOLTIP),
842 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SV_CATCHMENT), SetMinimalSize(45, 12), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_BUTTON_CATCHMENT, STR_TOOLTIP_CATCHMENT),
843 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_TRAINS), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetFill(0, 1), SetStringTip(STR_TRAIN, STR_STATION_VIEW_SCHEDULED_TRAINS_TOOLTIP),
844 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_ROADVEHS), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetFill(0, 1), SetStringTip(STR_LORRY, STR_STATION_VIEW_SCHEDULED_ROAD_VEHICLES_TOOLTIP),
845 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_SHIPS), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetFill(0, 1), SetStringTip(STR_SHIP, STR_STATION_VIEW_SCHEDULED_SHIPS_TOOLTIP),
846 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SV_PLANES), SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON), SetFill(0, 1), SetStringTip(STR_PLANE, STR_STATION_VIEW_SCHEDULED_AIRCRAFT_TOOLTIP),
847 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
848 EndContainer(),
849};
850
860static void DrawCargoIcons(CargoType cargo, uint waiting, int left, int right, int y)
861{
862 int width = ScaleSpriteTrad(10);
863 uint num = std::min<uint>((waiting + (width / 2)) / width, (right - left) / width); // maximum is width / 10 icons so it won't overflow
864 if (num == 0) return;
865
866 SpriteID sprite = CargoSpec::Get(cargo)->GetCargoIcon();
867
868 int x = _current_text_dir == TD_RTL ? left : right - num * width;
869 do {
870 DrawSprite(sprite, PAL_NONE, x, y);
871 x += width;
872 } while (--num);
873}
874
875enum SortOrder : uint8_t {
876 SO_DESCENDING,
877 SO_ASCENDING
878};
879
880class CargoDataEntry;
881
882enum class CargoSortType : uint8_t {
883 AsGrouping,
884 Count,
886 StationID,
887 CargoType,
888};
889
891public:
892 using is_transparent = void;
893 CargoSorter(CargoSortType t = CargoSortType::StationID, SortOrder o = SO_ASCENDING) : type(t), order(o) {}
894 CargoSortType GetSortType() {return this->type;}
895 bool operator()(const CargoDataEntry &cd1, const CargoDataEntry &cd2) const;
896 bool operator()(const CargoDataEntry &cd1, const std::unique_ptr<CargoDataEntry> &cd2) const { return this->operator()(cd1, *cd2); }
897 bool operator()(const std::unique_ptr<CargoDataEntry> &cd1, const CargoDataEntry &cd2) const { return this->operator()(*cd1, cd2); }
898 bool operator()(const std::unique_ptr<CargoDataEntry> &cd1, const std::unique_ptr<CargoDataEntry> &cd2) const { return this->operator()(*cd1, *cd2); }
899
900private:
901 CargoSortType type;
902 SortOrder order;
903
904 template <class Tid>
905 bool SortId(Tid st1, Tid st2) const;
906 bool SortCount(const CargoDataEntry &cd1, const CargoDataEntry &cd2) const;
907 bool SortStation(StationID st1, StationID st2) const;
908};
909
910typedef std::set<std::unique_ptr<CargoDataEntry>, CargoSorter> CargoDataSet;
911
918public:
921
928 {
929 return this->InsertOrRetrieve<StationID>(station);
930 }
931
938 {
939 return this->InsertOrRetrieve<CargoType>(cargo);
940 }
941
942 void Update(uint count);
943
949 {
951 this->Remove(t);
952 }
953
959 {
961 this->Remove(t);
962 }
963
970 {
972 return this->Retrieve(this->children->find(t));
973 }
974
981 {
983 return this->Retrieve(this->children->find(t));
984 }
985
986 void Resort(CargoSortType type, SortOrder order);
987
991 StationID GetStation() const { return this->station; }
992
996 CargoType GetCargo() const { return this->cargo; }
997
1001 uint GetCount() const { return this->count; }
1002
1006 CargoDataEntry *GetParent() const { return this->parent; }
1007
1011 uint GetNumChildren() const { return this->num_children; }
1012
1016 CargoDataSet::iterator Begin() const { return this->children->begin(); }
1017
1021 CargoDataSet::iterator End() const { return this->children->end(); }
1022
1026 bool HasTransfers() const { return this->transfers; }
1027
1031 void SetTransfers(bool value) { this->transfers = value; }
1032
1033 void Clear();
1034
1039
1040private:
1041 CargoDataEntry *Retrieve(CargoDataSet::iterator i) const;
1042
1043 template <class Tid>
1045
1046 void Remove(CargoDataEntry &entry);
1047 void IncrementSize();
1048
1050 const union {
1052 struct {
1055 };
1056 };
1058 uint count;
1059 std::unique_ptr<CargoDataSet> children;
1060};
1061
1062CargoDataEntry::CargoDataEntry() :
1063 parent(nullptr),
1064 station(StationID::Invalid()),
1065 num_children(0),
1066 count(0),
1067 children(std::make_unique<CargoDataSet>(CargoSorter(CargoSortType::CargoType)))
1068{}
1069
1070CargoDataEntry::CargoDataEntry(CargoType cargo, uint count, CargoDataEntry *parent) :
1071 parent(parent),
1072 cargo(cargo),
1073 num_children(0),
1074 count(count),
1075 children(std::make_unique<CargoDataSet>())
1076{}
1077
1078CargoDataEntry::CargoDataEntry(StationID station, uint count, CargoDataEntry *parent) :
1079 parent(parent),
1080 station(station),
1081 num_children(0),
1082 count(count),
1083 children(std::make_unique<CargoDataSet>())
1084{}
1085
1086CargoDataEntry::CargoDataEntry(StationID station) :
1087 parent(nullptr),
1088 station(station),
1089 num_children(0),
1090 count(0),
1091 children(nullptr)
1092{}
1093
1094CargoDataEntry::CargoDataEntry(CargoType cargo) :
1095 parent(nullptr),
1096 cargo(cargo),
1097 num_children(0),
1098 count(0),
1099 children(nullptr)
1100{}
1101
1102CargoDataEntry::~CargoDataEntry()
1103{
1104 this->Clear();
1105}
1106
1111{
1112 if (this->children != nullptr) this->children->clear();
1113 if (this->parent != nullptr) this->parent->count -= this->count;
1114 this->count = 0;
1115 this->num_children = 0;
1116}
1117
1125{
1126 CargoDataSet::iterator i = this->children->find(entry);
1127 if (i != this->children->end()) this->children->erase(i);
1128}
1129
1136template <class Tid>
1138{
1139 CargoDataEntry tmp(child_id);
1140 CargoDataSet::iterator i = this->children->find(tmp);
1141 if (i == this->children->end()) {
1142 IncrementSize();
1143 return **(this->children->insert(std::make_unique<CargoDataEntry>(child_id, 0, this)).first);
1144 } else {
1145 assert(this->children->value_comp().GetSortType() != CargoSortType::Count);
1146 return **i;
1147 }
1148}
1149
1156{
1157 this->count += count;
1158 if (this->parent != nullptr) this->parent->Update(count);
1159}
1160
1165{
1166 ++this->num_children;
1167 if (this->parent != nullptr) this->parent->IncrementSize();
1168}
1169
1170void CargoDataEntry::Resort(CargoSortType type, SortOrder order)
1171{
1172 auto new_children = std::make_unique<CargoDataSet>(CargoSorter(type, order));
1173 new_children->merge(*this->children);
1174 this->children = std::move(new_children);
1175}
1176
1177CargoDataEntry *CargoDataEntry::Retrieve(CargoDataSet::iterator i) const
1178{
1179 if (i == this->children->end()) {
1180 return nullptr;
1181 } else {
1182 assert(this->children->value_comp().GetSortType() != CargoSortType::Count);
1183 return i->get();
1184 }
1185}
1186
1187bool CargoSorter::operator()(const CargoDataEntry &cd1, const CargoDataEntry &cd2) const
1188{
1189 switch (this->type) {
1191 return this->SortId<StationID>(cd1.GetStation(), cd2.GetStation());
1193 return this->SortId<CargoType>(cd1.GetCargo(), cd2.GetCargo());
1195 return this->SortCount(cd1, cd2);
1197 return this->SortStation(cd1.GetStation(), cd2.GetStation());
1198 default:
1199 NOT_REACHED();
1200 }
1201}
1202
1203template <class Tid>
1204bool CargoSorter::SortId(Tid st1, Tid st2) const
1205{
1206 return (this->order == SO_ASCENDING) ? st1 < st2 : st2 < st1;
1207}
1208
1209bool CargoSorter::SortCount(const CargoDataEntry &cd1, const CargoDataEntry &cd2) const
1210{
1211 uint c1 = cd1.GetCount();
1212 uint c2 = cd2.GetCount();
1213 if (c1 == c2) {
1214 return this->SortStation(cd1.GetStation(), cd2.GetStation());
1215 } else if (this->order == SO_ASCENDING) {
1216 return c1 < c2;
1217 } else {
1218 return c2 < c1;
1219 }
1220}
1221
1222bool CargoSorter::SortStation(StationID st1, StationID st2) const
1223{
1224 if (!Station::IsValidID(st1)) {
1225 return Station::IsValidID(st2) ? this->order == SO_ASCENDING : this->SortId(st1, st2);
1226 } else if (!Station::IsValidID(st2)) {
1227 return order == SO_DESCENDING;
1228 }
1229
1230 int res = StrNaturalCompare(Station::Get(st1)->GetCachedName(), Station::Get(st2)->GetCachedName()); // Sort by name (natural sorting).
1231 if (res == 0) {
1232 return this->SortId(st1, st2);
1233 } else {
1234 return (this->order == SO_ASCENDING) ? res < 0 : res > 0;
1235 }
1236}
1237
1241struct StationViewWindow : public Window {
1265
1266 typedef std::vector<RowDisplay> CargoDataVector;
1267
1268 static const int NUM_COLUMNS = 4;
1269
1273 enum Invalidation : uint16_t {
1274 INV_FLOWS = 0x100,
1275 INV_CARGO = 0x200
1277
1287
1291 enum Mode : uint8_t {
1295
1299 Scrollbar *vscroll = nullptr;
1300
1301 /* Height of the #WID_SV_ACCEPT_RATING_LIST widget for different views. */
1302 static constexpr uint RATING_LINES = 13;
1303 static constexpr uint ACCEPTS_LINES = 3;
1304
1306 static inline const StringID sort_names[] = {
1307 STR_STATION_VIEW_WAITING_STATION,
1308 STR_STATION_VIEW_WAITING_AMOUNT,
1309 STR_STATION_VIEW_PLANNED_STATION,
1310 STR_STATION_VIEW_PLANNED_AMOUNT,
1311 };
1313 static inline const StringID group_names[] = {
1314 STR_STATION_VIEW_GROUP_S_V_D,
1315 STR_STATION_VIEW_GROUP_S_D_V,
1316 STR_STATION_VIEW_GROUP_V_S_D,
1317 STR_STATION_VIEW_GROUP_V_D_S,
1318 STR_STATION_VIEW_GROUP_D_S_V,
1319 STR_STATION_VIEW_GROUP_D_V_S,
1320 };
1321
1328 std::array<CargoSortType, NUM_COLUMNS> sortings{};
1329
1331 std::array<SortOrder, NUM_COLUMNS> sort_orders{};
1332
1333 int scroll_to_row = INT_MAX;
1336 std::array<Grouping, NUM_COLUMNS> groupings;
1337
1340 CargoDataVector displayed_rows{};
1341
1343 {
1344 this->CreateNestedTree();
1345 this->vscroll = this->GetScrollbar(WID_SV_SCROLLBAR);
1346 /* Nested widget tree creation is done in two steps to ensure that this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS) exists in UpdateWidgetSize(). */
1347 this->FinishInitNested(window_number);
1348
1349 this->groupings[0] = GR_CARGO;
1353 this->sort_orders[0] = SO_ASCENDING;
1355 this->owner = Station::Get(window_number)->owner;
1356 }
1357
1358 void Close([[maybe_unused]] int data = 0) override
1359 {
1360 CloseWindowById(WC_TRAINS_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_TRAIN, this->owner, this->window_number).ToWindowNumber(), false);
1361 CloseWindowById(WC_ROADVEH_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_ROAD, this->owner, this->window_number).ToWindowNumber(), false);
1362 CloseWindowById(WC_SHIPS_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_SHIP, this->owner, this->window_number).ToWindowNumber(), false);
1363 CloseWindowById(WC_AIRCRAFT_LIST, VehicleListIdentifier(VL_STATION_LIST, VEH_AIRCRAFT, this->owner, this->window_number).ToWindowNumber(), false);
1364
1365 SetViewportCatchmentStation(Station::Get(this->window_number), false);
1366 this->Window::Close();
1367 }
1368
1379 void ShowCargo(CargoDataEntry *data, CargoType cargo, StationID source, StationID next, StationID dest, uint count)
1380 {
1381 if (count == 0) return;
1382 bool auto_distributed = _settings_game.linkgraph.GetDistributionType(cargo) != DT_MANUAL;
1383 const CargoDataEntry *expand = &this->expanded_rows;
1384 for (int i = 0; i < NUM_COLUMNS && expand != nullptr; ++i) {
1385 switch (groupings[i]) {
1386 case GR_CARGO:
1387 assert(i == 0);
1388 data = &data->InsertOrRetrieve(cargo);
1389 data->SetTransfers(source != this->window_number);
1390 expand = expand->Retrieve(cargo);
1391 break;
1392 case GR_SOURCE:
1393 if (auto_distributed || source != this->window_number) {
1394 data = &data->InsertOrRetrieve(source);
1395 expand = expand->Retrieve(source);
1396 }
1397 break;
1398 case GR_NEXT:
1399 if (auto_distributed) {
1400 data = &data->InsertOrRetrieve(next);
1401 expand = expand->Retrieve(next);
1402 }
1403 break;
1404 case GR_DESTINATION:
1405 if (auto_distributed) {
1406 data = &data->InsertOrRetrieve(dest);
1407 expand = expand->Retrieve(dest);
1408 }
1409 break;
1410 }
1411 }
1412 data->Update(count);
1413 }
1414
1415 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1416 {
1417 switch (widget) {
1418 case WID_SV_WAITING:
1420 size.height = 4 * resize.height + padding.height;
1421 this->expand_shrink_width = std::max(GetStringBoundingBox("-").width, GetStringBoundingBox("+").width);
1422 break;
1423
1425 size.height = ((this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS)->GetString() == STR_STATION_VIEW_RATINGS_BUTTON) ? this->accepts_lines : this->rating_lines) * GetCharacterHeight(FS_NORMAL) + padding.height;
1426 break;
1427
1429 if (!Station::Get(this->window_number)->facilities.Test(StationFacility::Airport)) {
1430 /* Hide 'Close Airport' button if no airport present. */
1431 size.width = 0;
1432 resize.width = 0;
1433 fill.width = 0;
1434 }
1435 break;
1436 }
1437 }
1438
1439 void OnPaint() override
1440 {
1441 const Station *st = Station::Get(this->window_number);
1442 CargoDataEntry cargo;
1443 BuildCargoList(&cargo, st);
1444
1445 this->vscroll->SetCount(cargo.GetNumChildren()); // update scrollbar
1446
1447 /* disable some buttons */
1453 this->SetWidgetDisabledState(WID_SV_CLOSE_AIRPORT, !st->facilities.Test(StationFacility::Airport) || st->owner != _local_company || st->owner == OWNER_NONE); // Also consider SE, where _local_company == OWNER_NONE
1455
1458 this->SetWidgetLoweredState(WID_SV_CATCHMENT, _viewport_highlight_station == st);
1459
1460 this->DrawWidgets();
1461
1462 if (!this->IsShaded()) {
1463 /* Draw 'accepted cargo' or 'cargo ratings'. */
1464 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SV_ACCEPT_RATING_LIST);
1465 const Rect r = wid->GetCurrentRect();
1466 if (this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS)->GetString() == STR_STATION_VIEW_RATINGS_BUTTON) {
1467 int lines = this->DrawAcceptedCargo(r);
1468 if (lines > this->accepts_lines) { // Resize the widget, and perform re-initialization of the window.
1469 this->accepts_lines = lines;
1470 this->ReInit();
1471 return;
1472 }
1473 } else {
1474 int lines = this->DrawCargoRatings(r);
1475 if (lines > this->rating_lines) { // Resize the widget, and perform re-initialization of the window.
1476 this->rating_lines = lines;
1477 this->ReInit();
1478 return;
1479 }
1480 }
1481
1482 /* Draw arrow pointing up/down for ascending/descending sorting */
1483 this->DrawSortButtonState(WID_SV_SORT_ORDER, sort_orders[1] == SO_ASCENDING ? SBS_UP : SBS_DOWN);
1484
1485 int pos = this->vscroll->GetPosition();
1486
1487 int maxrows = this->vscroll->GetCapacity();
1488
1489 displayed_rows.clear();
1490
1491 /* Draw waiting cargo. */
1492 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_SV_WAITING);
1493 Rect waiting_rect = nwi->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
1494 this->DrawEntries(cargo, waiting_rect, pos, maxrows, 0);
1495 scroll_to_row = INT_MAX;
1496 }
1497 }
1498
1499 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1500 {
1501 if (widget == WID_SV_CAPTION) {
1502 const Station *st = Station::Get(this->window_number);
1503 return GetString(STR_STATION_VIEW_CAPTION, st->index, st->facilities);
1504 }
1505
1506 return this->Window::GetWidgetString(widget, stringid);
1507 }
1508
1515 {
1516 const Station *st = Station::Get(this->window_number);
1518 entry.Clear();
1519
1520 if (!st->goods[cargo].HasData()) return;
1521
1522 for (const auto &it : st->goods[cargo].GetData().flows) {
1523 StationID from = it.first;
1524 CargoDataEntry &source_entry = entry.InsertOrRetrieve(from);
1525 uint32_t prev_count = 0;
1526 for (const auto &flow_it : *it.second.GetShares()) {
1527 StationID via = flow_it.second;
1528 CargoDataEntry &via_entry = source_entry.InsertOrRetrieve(via);
1529 if (via == this->window_number) {
1530 via_entry.InsertOrRetrieve(via).Update(flow_it.first - prev_count);
1531 } else {
1532 EstimateDestinations(cargo, from, via, flow_it.first - prev_count, via_entry);
1533 }
1534 prev_count = flow_it.first;
1535 }
1536 }
1537 }
1538
1548 void EstimateDestinations(CargoType cargo, StationID source, StationID next, uint count, CargoDataEntry &dest)
1549 {
1550 if (Station::IsValidID(next) && Station::IsValidID(source)) {
1551 GoodsEntry &ge = Station::Get(next)->goods[cargo];
1552 if (!ge.HasData()) return;
1553
1554 CargoDataEntry tmp;
1555 const FlowStatMap &flowmap = ge.GetData().flows;
1556 FlowStatMap::const_iterator map_it = flowmap.find(source);
1557 if (map_it != flowmap.end()) {
1558 const FlowStat::SharesMap *shares = map_it->second.GetShares();
1559 uint32_t prev_count = 0;
1560 for (FlowStat::SharesMap::const_iterator i = shares->begin(); i != shares->end(); ++i) {
1561 tmp.InsertOrRetrieve(i->second).Update(i->first - prev_count);
1562 prev_count = i->first;
1563 }
1564 }
1565
1566 if (tmp.GetCount() == 0) {
1567 dest.InsertOrRetrieve(StationID::Invalid()).Update(count);
1568 } else {
1569 uint sum_estimated = 0;
1570 while (sum_estimated < count) {
1571 for (CargoDataSet::iterator i = tmp.Begin(); i != tmp.End() && sum_estimated < count; ++i) {
1572 CargoDataEntry &child = **i;
1573 uint estimate = DivideApprox(child.GetCount() * count, tmp.GetCount());
1574 if (estimate == 0) estimate = 1;
1575
1576 sum_estimated += estimate;
1577 if (sum_estimated > count) {
1578 estimate -= sum_estimated - count;
1579 sum_estimated = count;
1580 }
1581
1582 if (estimate > 0) {
1583 if (child.GetStation() == next) {
1584 dest.InsertOrRetrieve(next).Update(estimate);
1585 } else {
1586 EstimateDestinations(cargo, source, child.GetStation(), estimate, dest);
1587 }
1588 }
1589 }
1590
1591 }
1592 }
1593 } else {
1594 dest.InsertOrRetrieve(StationID::Invalid()).Update(count);
1595 }
1596 }
1597
1604 void BuildFlowList(CargoType cargo, const FlowStatMap &flows, CargoDataEntry *entry)
1605 {
1606 const CargoDataEntry *source_dest = this->cached_destinations.Retrieve(cargo);
1607 for (FlowStatMap::const_iterator it = flows.begin(); it != flows.end(); ++it) {
1608 StationID from = it->first;
1609 const CargoDataEntry *source_entry = source_dest->Retrieve(from);
1610 const FlowStat::SharesMap *shares = it->second.GetShares();
1611 for (FlowStat::SharesMap::const_iterator flow_it = shares->begin(); flow_it != shares->end(); ++flow_it) {
1612 const CargoDataEntry *via_entry = source_entry->Retrieve(flow_it->second);
1613 for (CargoDataSet::iterator dest_it = via_entry->Begin(); dest_it != via_entry->End(); ++dest_it) {
1614 CargoDataEntry &dest_entry = **dest_it;
1615 ShowCargo(entry, cargo, from, flow_it->second, dest_entry.GetStation(), dest_entry.GetCount());
1616 }
1617 }
1618 }
1619 }
1620
1627 void BuildCargoList(CargoType cargo, const StationCargoList &packets, CargoDataEntry *entry)
1628 {
1629 const CargoDataEntry *source_dest = this->cached_destinations.Retrieve(cargo);
1630 for (StationCargoList::ConstIterator it = packets.Packets()->begin(); it != packets.Packets()->end(); it++) {
1631 const CargoPacket *cp = *it;
1632 StationID next = it.GetKey();
1633
1634 const CargoDataEntry *source_entry = source_dest->Retrieve(cp->GetFirstStation());
1635 if (source_entry == nullptr) {
1636 this->ShowCargo(entry, cargo, cp->GetFirstStation(), next, StationID::Invalid(), cp->Count());
1637 continue;
1638 }
1639
1640 const CargoDataEntry *via_entry = source_entry->Retrieve(next);
1641 if (via_entry == nullptr) {
1642 this->ShowCargo(entry, cargo, cp->GetFirstStation(), next, StationID::Invalid(), cp->Count());
1643 continue;
1644 }
1645
1646 uint remaining = cp->Count();
1647 for (CargoDataSet::iterator dest_it = via_entry->Begin(); dest_it != via_entry->End();) {
1648 CargoDataEntry &dest_entry = **dest_it;
1649
1650 /* Advance iterator here instead of in the for statement to test whether this is the last entry */
1651 ++dest_it;
1652
1653 uint val;
1654 if (dest_it == via_entry->End()) {
1655 /* Allocate all remaining waiting cargo to the last destination to avoid
1656 * waiting cargo being "lost", and the displayed total waiting cargo
1657 * not matching GoodsEntry::TotalCount() */
1658 val = remaining;
1659 } else {
1660 val = std::min<uint>(remaining, DivideApprox(cp->Count() * dest_entry.GetCount(), via_entry->GetCount()));
1661 remaining -= val;
1662 }
1663 this->ShowCargo(entry, cargo, cp->GetFirstStation(), next, dest_entry.GetStation(), val);
1664 }
1665 }
1666 this->ShowCargo(entry, cargo, NEW_STATION, NEW_STATION, NEW_STATION, packets.ReservedCount());
1667 }
1668
1674 void BuildCargoList(CargoDataEntry *entry, const Station *st)
1675 {
1676 for (CargoType cargo = 0; cargo < NUM_CARGO; ++cargo) {
1677
1678 if (this->cached_destinations.Retrieve(cargo) == nullptr) {
1679 this->RecalcDestinations(cargo);
1680 }
1681
1682 const GoodsEntry &ge = st->goods[cargo];
1683 if (!ge.HasData()) continue;
1684
1685 if (this->current_mode == MODE_WAITING) {
1686 this->BuildCargoList(cargo, ge.GetData().cargo, entry);
1687 } else {
1688 this->BuildFlowList(cargo, ge.GetData().flows, entry);
1689 }
1690 }
1691 }
1692
1698 {
1699 std::list<StationID> stations;
1700 const CargoDataEntry *parent = entry.GetParent();
1701 if (parent->GetParent() == nullptr) {
1702 this->displayed_rows.push_back(RowDisplay(&this->expanded_rows, entry.GetCargo()));
1703 return;
1704 }
1705
1706 StationID next = entry.GetStation();
1707 while (parent->GetParent()->GetParent() != nullptr) {
1708 stations.push_back(parent->GetStation());
1709 parent = parent->GetParent();
1710 }
1711
1712 CargoType cargo = parent->GetCargo();
1713 CargoDataEntry *filter = this->expanded_rows.Retrieve(cargo);
1714 while (!stations.empty()) {
1715 filter = filter->Retrieve(stations.back());
1716 stations.pop_back();
1717 }
1718
1719 this->displayed_rows.push_back(RowDisplay(filter, next));
1720 }
1721
1730 StringID GetEntryString(StationID station, StringID here, StringID other_station, StringID any) const
1731 {
1732 if (station == this->window_number) {
1733 return here;
1734 } else if (station == StationID::Invalid()) {
1735 return any;
1736 } else if (station == NEW_STATION) {
1737 return STR_STATION_VIEW_RESERVED;
1738 } else {
1739 return other_station;
1740 }
1741 }
1742
1743 StringID GetGroupingString(Grouping grouping, StationID station) const
1744 {
1745 switch (grouping) {
1746 case GR_SOURCE: return this->GetEntryString(station, STR_STATION_VIEW_FROM_HERE, STR_STATION_VIEW_FROM, STR_STATION_VIEW_FROM_ANY);
1747 case GR_NEXT: return this->GetEntryString(station, STR_STATION_VIEW_VIA_HERE, STR_STATION_VIEW_VIA, STR_STATION_VIEW_VIA_ANY);
1748 case GR_DESTINATION: return this->GetEntryString(station, STR_STATION_VIEW_TO_HERE, STR_STATION_VIEW_TO, STR_STATION_VIEW_TO_ANY);
1749 default: NOT_REACHED();
1750 }
1751 }
1752
1761 {
1762 assert(column < NUM_COLUMNS);
1764 for (int i = column - 1; i > 0; --i) {
1765 if (this->groupings[i] == GR_DESTINATION) {
1766 if (parent->GetStation() == station) {
1767 return STR_STATION_VIEW_NONSTOP;
1768 } else {
1769 return STR_STATION_VIEW_VIA;
1770 }
1771 }
1772 parent = parent->GetParent();
1773 }
1774
1775 if (column < NUM_COLUMNS - 1 && this->groupings[column + 1] == GR_DESTINATION) {
1776 CargoDataSet::iterator begin = cd.Begin();
1777 CargoDataSet::iterator end = cd.End();
1778 if (begin != end && ++(cd.Begin()) == end && (*(begin))->GetStation() == station) {
1779 return STR_STATION_VIEW_NONSTOP;
1780 } else {
1781 return STR_STATION_VIEW_VIA;
1782 }
1783 }
1784
1785 return STR_STATION_VIEW_VIA;
1786 }
1787
1798 int DrawEntries(CargoDataEntry &entry, const Rect &r, int pos, int maxrows, int column, CargoType cargo = INVALID_CARGO)
1799 {
1800 assert(column < NUM_COLUMNS);
1801 if (this->sortings[column] == CargoSortType::AsGrouping) {
1802 if (this->groupings[column] != GR_CARGO) {
1803 entry.Resort(CargoSortType::StationString, this->sort_orders[column]);
1804 }
1805 } else {
1806 entry.Resort(CargoSortType::Count, this->sort_orders[column]);
1807 }
1808 for (CargoDataSet::iterator i = entry.Begin(); i != entry.End(); ++i) {
1809 CargoDataEntry &cd = **i;
1810
1811 Grouping grouping = this->groupings[column];
1812 if (grouping == GR_CARGO) cargo = cd.GetCargo();
1813 bool auto_distributed = _settings_game.linkgraph.GetDistributionType(cargo) != DT_MANUAL;
1814
1815 if (pos > -maxrows && pos <= 0) {
1816 StringID str = STR_EMPTY;
1817 StationID station = StationID::Invalid();
1818 int y = r.top - pos * GetCharacterHeight(FS_NORMAL);
1819 if (this->groupings[column] == GR_CARGO) {
1820 str = STR_STATION_VIEW_WAITING_CARGO;
1821 DrawCargoIcons(cd.GetCargo(), cd.GetCount(), r.left + this->expand_shrink_width, r.right - this->expand_shrink_width, y);
1822 } else {
1823 if (!auto_distributed) grouping = GR_SOURCE;
1824 station = cd.GetStation();
1825 str = this->GetGroupingString(grouping, station);
1826 if (grouping == GR_NEXT && str == STR_STATION_VIEW_VIA) str = this->SearchNonStop(cd, station, column);
1827
1828 if (pos == -this->scroll_to_row && Station::IsValidID(station)) {
1830 }
1831 }
1832
1833 bool rtl = _current_text_dir == TD_RTL;
1834 Rect text = r.Indent(column * WidgetDimensions::scaled.hsep_indent, rtl).Indent(this->expand_shrink_width, !rtl);
1835 Rect shrink = r.WithWidth(this->expand_shrink_width, !rtl);
1836
1837 DrawString(text.left, text.right, y, GetString(str, cargo, cd.GetCount(), station));
1838
1839 if (column < NUM_COLUMNS - 1) {
1840 std::string_view sym;
1841 if (cd.GetNumChildren() > 0) {
1842 sym = "-";
1843 } else if (auto_distributed && str != STR_STATION_VIEW_RESERVED) {
1844 sym = "+";
1845 } else {
1846 /* Only draw '+' if there is something to be shown. */
1847 const GoodsEntry &ge = Station::Get(this->window_number)->goods[cargo];
1848 if (ge.HasData()) {
1849 const StationCargoList &cargo_list = ge.GetData().cargo;
1850 if (grouping == GR_CARGO && (cargo_list.ReservedCount() > 0 || cd.HasTransfers())) {
1851 sym = "+";
1852 }
1853 }
1854 }
1855 if (!sym.empty()) DrawString(shrink.left, shrink.right, y, sym, TC_YELLOW);
1856 }
1857 this->SetDisplayedRow(cd);
1858 }
1859 --pos;
1860 if ((auto_distributed || column == 0) && column < NUM_COLUMNS - 1) {
1861 pos = this->DrawEntries(cd, r, pos, maxrows, column + 1, cargo);
1862 }
1863 }
1864 return pos;
1865 }
1866
1872 int DrawAcceptedCargo(const Rect &r) const
1873 {
1874 const Station *st = Station::Get(this->window_number);
1875 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
1876
1877 int bottom = DrawStringMultiLine(tr.left, tr.right, tr.top, INT32_MAX, GetString(STR_STATION_VIEW_ACCEPTS_CARGO, GetAcceptanceMask(st)));
1879 }
1880
1886 int DrawCargoRatings(const Rect &r) const
1887 {
1888 const Station *st = Station::Get(this->window_number);
1889 bool rtl = _current_text_dir == TD_RTL;
1890 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
1891
1892 if (st->town->exclusive_counter > 0) {
1893 tr.top = DrawStringMultiLine(tr, GetString(st->town->exclusivity == st->owner ? STR_STATION_VIEW_EXCLUSIVE_RIGHTS_SELF : STR_STATION_VIEW_EXCLUSIVE_RIGHTS_COMPANY, st->town->exclusivity));
1895 }
1896
1897 DrawString(tr, TimerGameEconomy::UsingWallclockUnits() ? STR_STATION_VIEW_SUPPLY_RATINGS_TITLE_MINUTE : STR_STATION_VIEW_SUPPLY_RATINGS_TITLE_MONTH);
1898 tr.top += GetCharacterHeight(FS_NORMAL);
1899
1900 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
1901 const GoodsEntry *ge = &st->goods[cs->Index()];
1902 if (!ge->HasRating()) continue;
1903
1906 GetString(STR_STATION_VIEW_CARGO_SUPPLY_RATING,
1907 cs->name,
1908 lg != nullptr ? lg->Monthly((*lg)[ge->node].supply) : 0,
1909 STR_CARGO_RATING_APPALLING + (ge->rating >> 5),
1910 ToPercent8(ge->rating)));
1911 tr.top += GetCharacterHeight(FS_NORMAL);
1912 }
1914 }
1915
1921 template <class Tid>
1923 {
1924 if (filter->Retrieve(next) != nullptr) {
1925 filter->Remove(next);
1926 } else {
1927 filter->InsertOrRetrieve(next);
1928 }
1929 }
1930
1936 {
1937 if (row < 0 || (uint)row >= this->displayed_rows.size()) return;
1938 if (_ctrl_pressed) {
1939 this->scroll_to_row = row;
1940 } else {
1941 RowDisplay &display = this->displayed_rows[row];
1942 if (display.filter == &this->expanded_rows) {
1943 this->HandleCargoWaitingClick<CargoType>(display.filter, display.next_cargo);
1944 } else {
1945 this->HandleCargoWaitingClick<StationID>(display.filter, display.next_station);
1946 }
1947 }
1949 }
1950
1951 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1952 {
1953 switch (widget) {
1954 case WID_SV_WAITING:
1955 this->HandleCargoWaitingClick(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SV_WAITING, WidgetDimensions::scaled.framerect.top) - this->vscroll->GetPosition());
1956 break;
1957
1958 case WID_SV_CATCHMENT:
1960 break;
1961
1962 case WID_SV_LOCATION:
1963 if (_ctrl_pressed) {
1964 ShowExtraViewportWindow(Station::Get(this->window_number)->xy);
1965 } else {
1966 ScrollMainWindowToTile(Station::Get(this->window_number)->xy);
1967 }
1968 break;
1969
1971 /* Swap between 'accepts' and 'ratings' view. */
1972 int height_change;
1973 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS);
1974 if (this->GetWidget<NWidgetCore>(WID_SV_ACCEPTS_RATINGS)->GetString() == STR_STATION_VIEW_RATINGS_BUTTON) {
1975 nwi->SetStringTip(STR_STATION_VIEW_ACCEPTS_BUTTON, STR_STATION_VIEW_ACCEPTS_TOOLTIP); // Switch to accepts view.
1976 height_change = this->rating_lines - this->accepts_lines;
1977 } else {
1978 nwi->SetStringTip(STR_STATION_VIEW_RATINGS_BUTTON, STR_STATION_VIEW_RATINGS_TOOLTIP); // Switch to ratings view.
1979 height_change = this->accepts_lines - this->rating_lines;
1980 }
1981 this->ReInit(0, height_change * GetCharacterHeight(FS_NORMAL));
1982 break;
1983 }
1984
1985 case WID_SV_RENAME:
1986 ShowQueryString(GetString(STR_STATION_NAME, this->window_number), STR_STATION_VIEW_RENAME_STATION_CAPTION, MAX_LENGTH_STATION_NAME_CHARS,
1988 break;
1989
1991 Command<CMD_OPEN_CLOSE_AIRPORT>::Post(this->window_number);
1992 break;
1993
1994 case WID_SV_TRAINS: // Show list of scheduled trains to this station
1995 case WID_SV_ROADVEHS: // Show list of scheduled road-vehicles to this station
1996 case WID_SV_SHIPS: // Show list of scheduled ships to this station
1997 case WID_SV_PLANES: { // Show list of scheduled aircraft to this station
1998 Owner owner = Station::Get(this->window_number)->owner;
1999 ShowVehicleListWindow(owner, (VehicleType)(widget - WID_SV_TRAINS), static_cast<StationID>(this->window_number));
2000 break;
2001 }
2002
2003 case WID_SV_SORT_BY: {
2004 /* The initial selection is composed of current mode and
2005 * sorting criteria for columns 1, 2, and 3. Column 0 is always
2006 * sorted by cargo type. The others can theoretically be sorted
2007 * by different things but there is no UI for that. */
2009 this->current_mode * 2 + (this->sortings[1] == CargoSortType::Count ? 1 : 0),
2010 WID_SV_SORT_BY, 0, 0);
2011 break;
2012 }
2013
2014 case WID_SV_GROUP_BY: {
2015 ShowDropDownMenu(this, StationViewWindow::group_names, this->grouping_index, WID_SV_GROUP_BY, 0, 0);
2016 break;
2017 }
2018
2019 case WID_SV_SORT_ORDER: { // flip sorting method asc/desc
2020 this->SelectSortOrder(this->sort_orders[1] == SO_ASCENDING ? SO_DESCENDING : SO_ASCENDING);
2021 this->SetTimeout();
2023 break;
2024 }
2025 }
2026 }
2027
2032 void SelectSortOrder(SortOrder order)
2033 {
2034 this->sort_orders[1] = this->sort_orders[2] = this->sort_orders[3] = order;
2036 this->SetDirty();
2037 }
2038
2043 void SelectSortBy(int index)
2044 {
2046 switch (StationViewWindow::sort_names[index]) {
2047 case STR_STATION_VIEW_WAITING_STATION:
2048 this->current_mode = MODE_WAITING;
2049 this->sortings[1] = this->sortings[2] = this->sortings[3] = CargoSortType::AsGrouping;
2050 break;
2051 case STR_STATION_VIEW_WAITING_AMOUNT:
2052 this->current_mode = MODE_WAITING;
2053 this->sortings[1] = this->sortings[2] = this->sortings[3] = CargoSortType::Count;
2054 break;
2055 case STR_STATION_VIEW_PLANNED_STATION:
2056 this->current_mode = MODE_PLANNED;
2057 this->sortings[1] = this->sortings[2] = this->sortings[3] = CargoSortType::AsGrouping;
2058 break;
2059 case STR_STATION_VIEW_PLANNED_AMOUNT:
2060 this->current_mode = MODE_PLANNED;
2061 this->sortings[1] = this->sortings[2] = this->sortings[3] = CargoSortType::Count;
2062 break;
2063 default:
2064 NOT_REACHED();
2065 }
2066 /* Display the current sort variant */
2067 this->GetWidget<NWidgetCore>(WID_SV_SORT_BY)->SetString(StationViewWindow::sort_names[index]);
2068 this->SetDirty();
2069 }
2070
2075 void SelectGroupBy(int index)
2076 {
2077 this->grouping_index = index;
2079 this->GetWidget<NWidgetCore>(WID_SV_GROUP_BY)->SetString(StationViewWindow::group_names[index]);
2080 switch (StationViewWindow::group_names[index]) {
2081 case STR_STATION_VIEW_GROUP_S_V_D:
2082 this->groupings[1] = GR_SOURCE;
2083 this->groupings[2] = GR_NEXT;
2084 this->groupings[3] = GR_DESTINATION;
2085 break;
2086 case STR_STATION_VIEW_GROUP_S_D_V:
2087 this->groupings[1] = GR_SOURCE;
2088 this->groupings[2] = GR_DESTINATION;
2089 this->groupings[3] = GR_NEXT;
2090 break;
2091 case STR_STATION_VIEW_GROUP_V_S_D:
2092 this->groupings[1] = GR_NEXT;
2093 this->groupings[2] = GR_SOURCE;
2094 this->groupings[3] = GR_DESTINATION;
2095 break;
2096 case STR_STATION_VIEW_GROUP_V_D_S:
2097 this->groupings[1] = GR_NEXT;
2098 this->groupings[2] = GR_DESTINATION;
2099 this->groupings[3] = GR_SOURCE;
2100 break;
2101 case STR_STATION_VIEW_GROUP_D_S_V:
2102 this->groupings[1] = GR_DESTINATION;
2103 this->groupings[2] = GR_SOURCE;
2104 this->groupings[3] = GR_NEXT;
2105 break;
2106 case STR_STATION_VIEW_GROUP_D_V_S:
2107 this->groupings[1] = GR_DESTINATION;
2108 this->groupings[2] = GR_NEXT;
2109 this->groupings[3] = GR_SOURCE;
2110 break;
2111 }
2112 this->SetDirty();
2113 }
2114
2115 void OnDropdownSelect(WidgetID widget, int index, int) override
2116 {
2117 if (widget == WID_SV_SORT_BY) {
2118 this->SelectSortBy(index);
2119 } else {
2120 this->SelectGroupBy(index);
2121 }
2122 }
2123
2124 void OnQueryTextFinished(std::optional<std::string> str) override
2125 {
2126 if (!str.has_value()) return;
2127
2128 Command<CMD_RENAME_STATION>::Post(STR_ERROR_CAN_T_RENAME_STATION, this->window_number, *str);
2129 }
2130
2131 void OnResize() override
2132 {
2133 this->vscroll->SetCapacityFromWidget(this, WID_SV_WAITING, WidgetDimensions::scaled.framerect.Vertical());
2134 }
2135
2141 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
2142 {
2143 if (gui_scope) {
2144 if (data >= 0 && data < NUM_CARGO) {
2146 } else {
2147 this->ReInit();
2148 }
2149 }
2150 }
2151};
2152
2153static WindowDesc _station_view_desc(
2154 WDP_AUTO, "view_station", 249, 117,
2156 {},
2157 _nested_station_view_widgets
2158);
2159
2166{
2167 AllocateWindowDescFront<StationViewWindow>(_station_view_desc, station);
2168}
2169
2175
2176static std::vector<TileAndStation> _deleted_stations_nearby;
2177static std::vector<StationID> _stations_nearby_list;
2178
2186template <class T>
2187static void AddNearbyStation(TileIndex tile, TileArea *ctx)
2188{
2189 /* First check if there were deleted stations here */
2190 for (auto it = _deleted_stations_nearby.begin(); it != _deleted_stations_nearby.end(); /* nothing */) {
2191 if (it->tile == tile) {
2192 _stations_nearby_list.push_back(it->station);
2193 it = _deleted_stations_nearby.erase(it);
2194 } else {
2195 ++it;
2196 }
2197 }
2198
2199 /* Check if own station and if we stay within station spread */
2200 if (!IsTileType(tile, MP_STATION)) return;
2201
2202 StationID sid = GetStationIndex(tile);
2203
2204 /* This station is (likely) a waypoint */
2205 if (!T::IsValidID(sid)) return;
2206
2207 BaseStation *st = BaseStation::Get(sid);
2208 if (st->owner != _local_company || std::ranges::find(_stations_nearby_list, sid) != _stations_nearby_list.end()) return;
2209
2210 if (st->rect.BeforeAddRect(ctx->tile, ctx->w, ctx->h, StationRect::ADD_TEST).Succeeded()) {
2211 _stations_nearby_list.push_back(sid);
2212 }
2213}
2214
2224template <class T>
2225static const BaseStation *FindStationsNearby(TileArea ta, bool distant_join)
2226{
2227 TileArea ctx = ta;
2228
2229 _stations_nearby_list.clear();
2230 _stations_nearby_list.push_back(NEW_STATION);
2231 _deleted_stations_nearby.clear();
2232
2233 /* Check the inside, to return, if we sit on another station */
2234 for (TileIndex t : ta) {
2235 if (t < Map::Size() && IsTileType(t, MP_STATION) && T::IsValidID(GetStationIndex(t))) return BaseStation::GetByTile(t);
2236 }
2237
2238 /* Look for deleted stations */
2239 for (const BaseStation *st : BaseStation::Iterate()) {
2240 if (T::IsValidBaseStation(st) && !st->IsInUse() && st->owner == _local_company) {
2241 /* Include only within station spread (yes, it is strictly less than) */
2242 if (std::max(DistanceMax(ta.tile, st->xy), DistanceMax(TileAddXY(ta.tile, ta.w - 1, ta.h - 1), st->xy)) < _settings_game.station.station_spread) {
2243 _deleted_stations_nearby.emplace_back(st->xy, st->index);
2244
2245 /* Add the station when it's within where we're going to build */
2246 if (IsInsideBS(TileX(st->xy), TileX(ctx.tile), ctx.w) &&
2247 IsInsideBS(TileY(st->xy), TileY(ctx.tile), ctx.h)) {
2248 AddNearbyStation<T>(st->xy, &ctx);
2249 }
2250 }
2251 }
2252 }
2253
2254 /* Only search tiles where we have a chance to stay within the station spread.
2255 * The complete check needs to be done in the callback as we don't know the
2256 * extent of the found station, yet. */
2257 if (distant_join && std::min(ta.w, ta.h) >= _settings_game.station.station_spread) return nullptr;
2258 uint max_dist = distant_join ? _settings_game.station.station_spread - std::min(ta.w, ta.h) : 1;
2259
2260 for (auto tile : SpiralTileSequence(TileAddByDir(ctx.tile, DIR_N), max_dist, ta.w, ta.h)) {
2261 AddNearbyStation<T>(tile, &ctx);
2262 }
2263
2264 return nullptr;
2265}
2266
2267static constexpr NWidgetPart _nested_select_station_widgets[] = {
2269 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
2270 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_JS_CAPTION), SetStringTip(STR_JOIN_STATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2271 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
2272 EndContainer(),
2274 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_JS_PANEL), SetResize(1, 0), SetScrollbar(WID_JS_SCROLLBAR), EndContainer(),
2276 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_JS_SCROLLBAR),
2277 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
2278 EndContainer(),
2279 EndContainer(),
2280};
2281
2286template <class T>
2288 StationPickerCmdProc select_station_proc{};
2290 Scrollbar *vscroll = nullptr;
2291
2292 SelectStationWindow(WindowDesc &desc, TileArea ta, StationPickerCmdProc&& proc) :
2293 Window(desc),
2294 select_station_proc(std::move(proc)),
2295 area(ta)
2296 {
2297 this->CreateNestedTree();
2298 this->vscroll = this->GetScrollbar(WID_JS_SCROLLBAR);
2299 this->GetWidget<NWidgetCore>(WID_JS_CAPTION)->SetString(T::IsWaypoint() ? STR_JOIN_WAYPOINT_CAPTION : STR_JOIN_STATION_CAPTION);
2300 this->FinishInitNested(0);
2301 this->OnInvalidateData(0);
2302
2303 _thd.freeze = true;
2304 }
2305
2306 void Close([[maybe_unused]] int data = 0) override
2307 {
2308 SetViewportCatchmentSpecializedStation<typename T::StationType>(nullptr, true);
2309
2310 _thd.freeze = false;
2311 this->Window::Close();
2312 }
2313
2314 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2315 {
2316 if (widget != WID_JS_PANEL) return;
2317
2318 /* Determine the widest string */
2319 Dimension d = GetStringBoundingBox(T::IsWaypoint() ? STR_JOIN_WAYPOINT_CREATE_SPLITTED_WAYPOINT : STR_JOIN_STATION_CREATE_SPLITTED_STATION);
2320 for (const auto &station : _stations_nearby_list) {
2321 if (station == NEW_STATION) continue;
2322 const BaseStation *st = BaseStation::Get(station);
2323 d = maxdim(d, GetStringBoundingBox(T::IsWaypoint()
2324 ? GetString(STR_STATION_LIST_WAYPOINT, st->index)
2325 : GetString(STR_STATION_LIST_STATION, st->index, st->facilities)));
2326 }
2327
2328 resize.height = d.height;
2329 d.height *= 5;
2330 d.width += padding.width;
2331 d.height += padding.height;
2332 size = d;
2333 }
2334
2335 void DrawWidget(const Rect &r, WidgetID widget) const override
2336 {
2337 if (widget != WID_JS_PANEL) return;
2338
2339 Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
2340 auto [first, last] = this->vscroll->GetVisibleRangeIterators(_stations_nearby_list);
2341 for (auto it = first; it != last; ++it, tr.top += this->resize.step_height) {
2342 if (*it == NEW_STATION) {
2343 DrawString(tr, T::IsWaypoint() ? STR_JOIN_WAYPOINT_CREATE_SPLITTED_WAYPOINT : STR_JOIN_STATION_CREATE_SPLITTED_STATION);
2344 } else {
2345 const BaseStation *st = BaseStation::Get(*it);
2346 DrawString(tr, T::IsWaypoint()
2347 ? GetString(STR_STATION_LIST_WAYPOINT, st->index)
2348 : GetString(STR_STATION_LIST_STATION, st->index, st->facilities));
2349 }
2350 }
2351
2352 }
2353
2354 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2355 {
2356 if (widget != WID_JS_PANEL) return;
2357
2358 auto it = this->vscroll->GetScrolledItemFromWidget(_stations_nearby_list, pt.y, this, WID_JS_PANEL, WidgetDimensions::scaled.framerect.top);
2359 if (it == _stations_nearby_list.end()) return;
2360
2361 /* Execute stored Command */
2362 this->select_station_proc(false, *it);
2363
2364 /* Close Window; this might cause double frees! */
2366 }
2367
2368 void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
2369 {
2370 if (_thd.dirty & 2) {
2371 _thd.dirty &= ~2;
2372 this->SetDirty();
2373 }
2374 }
2375
2376 void OnResize() override
2377 {
2378 this->vscroll->SetCapacityFromWidget(this, WID_JS_PANEL, WidgetDimensions::scaled.framerect.Vertical());
2379 }
2380
2386 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
2387 {
2388 if (!gui_scope) return;
2389 FindStationsNearby<T>(this->area, true);
2390 this->vscroll->SetCount(_stations_nearby_list.size());
2391 this->SetDirty();
2392 }
2393
2394 void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
2395 {
2396 if (widget != WID_JS_PANEL) {
2397 SetViewportCatchmentSpecializedStation<typename T::StationType>(nullptr, true);
2398 return;
2399 }
2400
2401 /* Show coverage area of station under cursor */
2402 auto it = this->vscroll->GetScrolledItemFromWidget(_stations_nearby_list, pt.y, this, WID_JS_PANEL, WidgetDimensions::scaled.framerect.top);
2403 const typename T::StationType *st = it == _stations_nearby_list.end() || *it == NEW_STATION ? nullptr : T::StationType::Get(*it);
2404 SetViewportCatchmentSpecializedStation<typename T::StationType>(st, true);
2405 }
2406};
2407
2408static WindowDesc _select_station_desc(
2409 WDP_AUTO, "build_station_join", 200, 180,
2412 _nested_select_station_widgets
2413);
2414
2415
2423template <class T>
2424static bool StationJoinerNeeded(TileArea ta, const StationPickerCmdProc &proc)
2425{
2426 /* Only show selection if distant join is enabled in the settings */
2427 if (!_settings_game.station.distant_join_stations) return false;
2428
2429 /* If a window is already opened and we didn't ctrl-click,
2430 * return true (i.e. just flash the old window) */
2431 Window *selection_window = FindWindowById(WC_SELECT_STATION, 0);
2432 if (selection_window != nullptr) {
2433 /* Abort current distant-join and start new one */
2434 selection_window->Close();
2436 }
2437
2438 /* only show the popup, if we press ctrl */
2439 if (!_ctrl_pressed) return false;
2440
2441 /* Now check if we could build there */
2442 if (!proc(true, StationID::Invalid())) return false;
2443
2444 return FindStationsNearby<T>(ta, false) == nullptr;
2445}
2446
2453template <class T>
2454void ShowSelectBaseStationIfNeeded(TileArea ta, StationPickerCmdProc&& proc)
2455{
2456 if (StationJoinerNeeded<T>(ta, proc)) {
2458 new SelectStationWindow<T>(_select_station_desc, ta, std::move(proc));
2459 } else {
2460 proc(false, StationID::Invalid());
2461 }
2462}
2463
2469void ShowSelectStationIfNeeded(TileArea ta, StationPickerCmdProc proc)
2470{
2471 ShowSelectBaseStationIfNeeded<StationTypeFilter>(ta, std::move(proc));
2472}
2473
2479void ShowSelectRailWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc)
2480{
2481 ShowSelectBaseStationIfNeeded<RailWaypointTypeFilter>(ta, std::move(proc));
2482}
2483
2489void ShowSelectRoadWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc)
2490{
2491 ShowSelectBaseStationIfNeeded<RoadWaypointTypeFilter>(ta, std::move(proc));
2492}
@ AirportClosed
Dummy block for indicating a closed airport.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr uint8_t FindFirstBit(T x)
Search the first set bit in a value.
constexpr uint CountBits(T value)
Counts the number of set bits in a variable.
constexpr T ToggleBit(T &x, const uint8_t y)
Toggles a bit in a variable.
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:23
static const CargoType NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:75
Dimension GetLargestCargoIconSize()
Get dimensions of largest cargo icon.
std::span< const CargoSpec * > _sorted_standard_cargo_specs
Standard cargo specifications sorted alphabetically by name.
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition cargotype.cpp:31
Types/functions related to cargoes.
@ Passengers
Passengers.
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
Definition cargotype.h:236
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Tstorage base() const noexcept
Retrieve the raw value behind this bit set.
constexpr Timpl & Flip(Tvalue_type value)
Flip the value-th bit.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
A cargo data entry representing one possible row in the station view window's top part.
uint count
sum of counts of all children or amount of cargo for this entry.
void Clear()
Delete all subentries, reset count and num_children and adapt parent's count.
StationID GetStation() const
Get the station ID for this entry.
void IncrementSize()
Increment.
void SetTransfers(bool value)
Set the transfers state.
CargoType GetCargo() const
Get the cargo type for this entry.
uint num_children
the number of subentries belonging to this entry.
void Remove(CargoType cargo)
Remove a child associated with the given cargo.
CargoDataEntry * Retrieve(StationID station) const
Retrieve a child for the given station.
uint GetCount() const
Get the cargo count for this entry.
CargoDataEntry * GetParent() const
Get the parent entry for this entry.
StationID station
ID of the station this entry is associated with.
CargoType cargo
ID of the cargo this entry is associated with.
CargoDataEntry & InsertOrRetrieve(StationID station)
Insert a new child or retrieve an existing child using a station ID as ID.
CargoDataEntry & InsertOrRetrieve(CargoType cargo)
Insert a new child or retrieve an existing child using a cargo type as ID.
CargoDataSet::iterator End() const
Get an iterator pointing to the end of the set of children.
void Update(uint count)
Update the count for this entry and propagate the change to the parent entry if there is one.
std::unique_ptr< CargoDataSet > children
the children of this entry.
bool transfers
If there are transfers for this cargo.
CargoDataSet::iterator Begin() const
Get an iterator pointing to the begin of the set of children.
bool HasTransfers() const
Has this entry transfers.
CargoDataEntry * Retrieve(CargoType cargo) const
Retrieve a child for the given cargo.
CargoDataEntry * parent
the parent of this entry.
void Remove(StationID station)
Remove a child associated with the given station.
uint GetNumChildren() const
Get the number of children for this entry.
const Tcont * Packets() const
Returns a pointer to the cargo packet list (so you can iterate over it etc).
Tcont::const_iterator ConstIterator
The const iterator for our container.
bool Succeeded() const
Did this command succeed?
The list of stations per company.
static bool StationRatingMaxSorter(const Station *const &a, const Station *const &b, const CargoTypes &cargo_filter)
Sort stations by their rating.
std::array< uint16_t, NUM_CARGO > stations_per_cargo_type
Number of stations with a rating for each cargo type.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnResize() override
Called after the window got resized.
void SortStationsList()
Sort the stations list.
static bool StationRatingMinSorter(const Station *const &a, const Station *const &b, const CargoTypes &cargo_filter)
Sort stations by their rating.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
static bool StationWaitingAvailableSorter(const Station *const &a, const Station *const &b, const CargoTypes &cargo_filter)
Sort stations by their available waiting cargo.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnPaint() override
The window must be repainted.
static bool StationNameSorter(const Station *const &a, const Station *const &b, const CargoTypes &)
Sort stations by their name.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
static bool StationTypeSorter(const Station *const &a, const Station *const &b, const CargoTypes &)
Sort stations by their type.
void OnGameTick() override
Called once per (game) tick.
static bool StationWaitingTotalSorter(const Station *const &a, const Station *const &b, const CargoTypes &cargo_filter)
Sort stations by their waiting cargo.
void BuildStationsList(const Owner owner)
(Re)Build station list
uint16_t stations_per_cargo_type_no_rating
Number of stations without a rating.
Drop down checkmark component.
Drop down string component.
Flow descriptions by origin stations.
List template of 'things' T to sort in a GUI.
void RebuildDone()
Notify the sortlist that the rebuild is done.
void SetListing(Listing l)
Import sort conditions.
bool IsDescSortOrder() const
Check if the sort order is descending.
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here.
bool NeedRebuild() const
Check if a rebuild is needed.
void ForceRebuild()
Force that a rebuild is needed.
bool Sort(Comp compare)
Sort the list.
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
uint8_t SortType() const
Get the sorttype of the list.
Listing GetListing() const
Export current sort conditions.
void SetSortFuncs(std::span< SortFunction *const > n_funcs)
Hand the sort function pointers to the GUIList.
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
void SetSortType(uint8_t n_type)
Set the sorttype of the list.
A connected component of a link graph.
Definition linkgraph.h:37
uint Monthly(uint base) const
Scale a value to its monthly equivalent, based on last compression.
Definition linkgraph.h:249
Baseclass for nested widgets.
Base class for a 'real' widget.
void SetStringTip(StringID string, StringID tool_tip)
Set string and tool tip of the nested widget.
Definition widget.cpp:1171
Scrollbar data structure.
size_type GetCapacity() const
Gets the number of visible elements of the scrollbar.
void SetCount(size_t num)
Sets the number of elements in the list.
auto GetScrolledItemFromWidget(Tcontainer &container, int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Return an iterator pointing to the element of a scrolled widget that a user clicked in.
size_type GetScrolledRowFromWidget(int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition widget.cpp:2482
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2556
size_type GetCount() const
Gets the number of elements in the list.
auto GetVisibleRangeIterators(Tcontainer &container) const
Get a pair of iterators for the range of visible elements in a container.
size_type GetPosition() const
Gets the position of the first visible element in the list.
Generate TileIndices around a center tile or tile area, with increasing distance.
CargoList that is used for stations.
uint ReservedCount() const
Returns sum of cargo reserved for loading onto vehicles.
static bool UsingWallclockUnits(bool newgame=false)
Check if we are using wallclock units.
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
int vsep_wide
Wide vertical spacing.
Definition window_gui.h:60
int hsep_wide
Wide horizontal spacing.
Definition window_gui.h:62
int hsep_normal
Normal horizontal spacing.
Definition window_gui.h:61
int hsep_indent
Width of indentation for tree layouts.
Definition window_gui.h:63
Functions related to commands.
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
int DivideApprox(int a, int b)
Deterministic approximate division.
Definition math_func.cpp:22
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
@ DIR_N
North.
void ShowDropDownMenu(Window *w, std::span< const StringID > strings, int selected, WidgetID button, uint32_t disabled_mask, uint32_t hidden_mask, uint width)
Show a dropdown menu window near a widget of the parent window.
Definition dropdown.cpp:451
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
Definition dropdown.cpp:414
Common drop down list components.
Functions related to the drop down widget.
Types related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
Definition enum_type.hpp:17
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:887
Dimension GetStringListBoundingBox(std::span< const StringID > list, FontSize fontsize)
Get maximum dimension of a list of strings.
Definition gfx.cpp:925
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:658
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
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:115
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:1024
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:775
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ FS_SMALL
Index of the small font in the font tables.
Definition gfx_type.h:252
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:251
@ SA_CENTER
Center both horizontally and vertically.
Definition gfx_type.h:393
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:302
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetAspect(float ratio, AspectFlags flags=AspectFlag::ResizeX)
Widget part function for setting the aspect ratio.
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:955
GUI functions that shouldn't be here.
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Declaration of link graph classes used for cargo distribution.
@ DT_MANUAL
Manual distribution. No link graph calculations are run.
uint DistanceMax(TileIndex t0, TileIndex t1)
Gets the biggest distance component (x or y) between the two given tiles.
Definition map.cpp:174
TileIndex TileAddXY(TileIndex tile, int x, int y)
Adds a given offset to a tile.
Definition map_func.h:469
TileIndex TileAddByDir(TileIndex tile, Direction dir)
Adds a Direction to a tile.
Definition map_func.h:598
static debug_inline TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:372
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:424
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:414
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:403
constexpr 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.
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr uint ToPercent8(uint i)
Converts a "fract" value 0..255 to "percent" value 0..100.
void ShowQueryString(std::string_view str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
static constexpr CargoType CF_EXPAND_LIST
Expand list to show all items (station list)
Definition cargo_type.h:102
static constexpr CargoType CF_NO_RATING
Show items with no rating (station list)
Definition cargo_type.h:100
static constexpr CargoType CF_SELECT_ALL
Select all items (station list)
Definition cargo_type.h:101
@ Invalid
GRF is unusable with this version of OpenTTD.
TextColour GetContrastColour(uint8_t background, uint8_t threshold)
Determine a contrasty text colour for a coloured background.
Definition palette.cpp:361
static const uint8_t PC_GREEN
Green palette colour.
static const uint8_t PC_RED
Red palette colour.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
Base types for having sorted lists in GUIs.
@ Resort
instruct the code to resort the list in the next loop
Base classes/functions for stations.
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.
bool HasStationInUse(StationID station, bool include_company, CompanyID company)
Tests whether the company's vehicles have this station in orders.
CargoTypes GetAcceptanceMask(const Station *st)
Get a mask of the cargo types that the station accepts.
CargoArray GetProductionAroundTiles(TileIndex north_tile, int w, int h, int rad)
Get the cargo types being produced around the tile (in a rectangle).
Command definitions related to stations.
static void StationsWndShowStationRating(int left, int right, int y, CargoType cargo, uint amount, uint8_t rating)
Draw small boxes of cargo amount and ratings data at the given coordinates.
void ShowSelectStationIfNeeded(TileArea ta, StationPickerCmdProc proc)
Show the station selection window when needed.
CargoSortType
@ StationID
by station id
@ CargoType
by cargo type
@ AsGrouping
by the same principle the entries are being grouped
@ StationString
by station name
@ Count
by amount of cargo
void ShowSelectRailWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc)
Show the rail waypoint selection window when needed.
static void DrawCargoIcons(CargoType cargo, uint waiting, int left, int right, int y)
Draws icons of waiting cargo in the StationView window.
void FindStationsAroundSelection()
Find stations adjacent to the current tile highlight area, so that existing coverage area can be draw...
int DrawStationCoverageAreaText(const Rect &r, StationCoverageType sct, int rad, bool supplies)
Calculates and draws the accepted or supplied cargo around the selected tile(s)
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
static const BaseStation * FindStationsNearby(TileArea ta, bool distant_join)
Circulate around the to-be-built station to find stations we could join.
void CheckRedrawStationCoverage(const Window *w)
Check whether we need to redraw the station coverage text.
void ShowCompanyStations(CompanyID company)
Opens window with list of company's stations.
void ShowSelectBaseStationIfNeeded(TileArea ta, StationPickerCmdProc &&proc)
Show the station selection window when needed.
static void AddNearbyStation(TileIndex tile, TileArea *ctx)
Add station on this tile to _stations_nearby_list if it's fully within the station spread.
static bool StationJoinerNeeded(TileArea ta, const StationPickerCmdProc &proc)
Check whether we need to show the station selection window.
void ShowSelectRoadWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc)
Show the road waypoint selection window when needed.
Contains enums and function declarations connected with stations GUI.
StationCoverageType
Types of cargo to display for station coverage.
Definition station_gui.h:21
@ SCT_NON_PASSENGERS_ONLY
Draw all non-passenger class cargoes.
Definition station_gui.h:23
@ SCT_PASSENGERS_ONLY
Draw only passenger class cargoes.
Definition station_gui.h:22
@ SCT_ALL
Draw all cargoes.
Definition station_gui.h:24
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
StationFacility
The facilities a station might be having.
@ Dock
Station with a dock.
@ TruckStop
Station with truck stops.
@ Train
Station with train station.
@ Airport
Station with an airport.
@ BusStop
Station with bus stops.
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
Types related to the station widgets.
@ WID_SV_CLOSE_AIRPORT
'Close airport' button.
@ WID_SV_SORT_ORDER
'Sort order' button
@ WID_SV_CATCHMENT
Toggle catchment area highlight.
@ WID_SV_ROADVEHS
List of scheduled road vehs button.
@ WID_SV_SCROLLBAR
Scrollbar.
@ WID_SV_CAPTION
Caption of the window.
@ WID_SV_GROUP
label for "group by"
@ WID_SV_RENAME
'Rename' button.
@ WID_SV_SORT_BY
'Sort by' button
@ WID_SV_GROUP_BY
'Group by' button
@ WID_SV_PLANES
List of scheduled planes button.
@ WID_SV_ACCEPT_RATING_LIST
List of accepted cargoes / rating of cargoes.
@ WID_SV_WAITING
List of waiting cargo.
@ WID_SV_SHIPS
List of scheduled ships button.
@ WID_SV_LOCATION
'Location' button.
@ WID_SV_TRAINS
List of scheduled trains button.
@ WID_SV_ACCEPTS_RATINGS
'Accepts' / 'Ratings' button.
@ WID_STL_CAPTION
Caption of the window.
@ WID_STL_TRUCK
'TRUCK' button - list only facilities where is a truck stop.
@ WID_STL_SCROLLBAR
Scrollbar next to the main panel.
@ WID_STL_SORTDROPBTN
Dropdown button.
@ WID_STL_SORTBY
'Sort by' button - reverse sort direction.
@ WID_STL_TRAIN
'TRAIN' button - list only facilities where is a railroad station.
@ WID_STL_BUS
'BUS' button - list only facilities where is a bus stop.
@ WID_STL_FACILALL
'ALL' button - list all facilities.
@ WID_STL_LIST
The main panel, list of stations.
@ WID_STL_SHIP
'SHIP' button - list only facilities where is a dock.
@ WID_STL_CARGODROPDOWN
Cargo type dropdown list.
@ WID_STL_AIRPLANE
'AIRPLANE' button - list only facilities where is an airport.
Definition of base types and functions in a cross-platform compatible way.
int StrNaturalCompare(std::string_view s1, std::string_view s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition string.cpp:425
Functions related to low-level strings.
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition string_type.h:25
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:415
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:57
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
AirportBlocks blocks
stores which blocks on the airport are taken. was 16 bit earlier on, then 32
Base class for all station-ish types.
TileIndex xy
Base tile of the station.
StationFacilities facilities
The facilities that this station has.
Owner owner
The owner of this station.
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Town * town
The town this station is associated with.
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
Class for storing amounts of cargo.
Definition cargo_type.h:113
Container for cargo from the same location and time.
Definition cargopacket.h:41
uint16_t Count() const
Gets the number of 'items' in this packet.
StationID GetFirstStation() const
Gets the ID of the station where the cargo was loaded for the first time.
Specification of a cargo type.
Definition cargotype.h:74
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:137
StringID abbrev
Two letter abbreviation for this cargo type.
Definition cargotype.h:95
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
StringID name
Name of this type of cargo.
Definition cargotype.h:91
bool IsValid() const
Tests for validity of this cargospec.
Definition cargotype.h:118
GUISettings gui
settings related to the GUI
CargoTypes cargoes
bitmap of cargo types to include
StationFacilities facilities
types of stations of interest
bool include_no_rating
Whether we should include stations with no cargo rating.
Dimensions (a width and height) of a rectangle in 2D.
bool persistent_buildingtools
keep the building tools active after usage
uint8_t station_gui_group_order
the order of grouping cargo entries in the station gui
uint8_t station_gui_sort_order
the sort order of entries in the station gui - ascending or descending
bool station_show_coverage
whether to highlight coverage area
uint8_t station_gui_sort_by
sort cargo entries in the station gui by station name or amount
StationSettings station
settings related to station management
LinkGraphSettings linkgraph
settings for link graph calculations
FlowStatMap flows
Planned flows through this station.
StationCargoList cargo
The cargo packets of cargo waiting in this station.
Stores station stats for a single cargo.
bool HasRating() const
Does this cargo have a rating at this station?
debug_inline const GoodsEntryData & GetData() const
Get optional cargo packet/flow data.
NodeID node
ID of node in link graph referring to this goods entry.
LinkGraphID link_graph
Link graph this station belongs to.
uint8_t rating
Station rating for this cargo.
debug_inline bool HasData() const
Test if this goods entry has optional cargo packet/flow data.
Data structure describing how to show the list (what sort direction and criteria).
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition map_func.h:305
static debug_inline uint Size()
Get the size of the map.
Definition map_func.h:287
static debug_inline uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition map_func.h:296
Partial widget specification to allow NWidgets to be written nested.
Represents the covered area of e.g.
uint16_t w
The width of the area.
TileIndex tile
The base tile of the area.
uint16_t h
The height of the area.
Coordinates of a point in 2D.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static Titem * Get(auto index)
Returns Titem with given index.
Tindex index
Index of this pool item.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
Specification of a rectangle with absolute coordinates of all edges.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
uint step_height
Step-size of height resize changes.
Definition window_gui.h:212
Window for selecting stations/waypoints to (distant) join to.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnRealtimeTick(uint delta_ms) override
Called periodically.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnResize() override
Called after the window got resized.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
void OnMouseOver(Point pt, WidgetID widget) override
The mouse is currently moving over the window or has just moved outside of the window.
TileArea area
Location of new station.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
Iterable ensemble of each set bit in a value.
static bool IsValidID(auto index)
Tests whether given index is a valid index for station of this type.
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
static Waypoint * Get(auto index)
Gets station with given index.
static Waypoint * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
uint8_t station_spread
amount a station may spread
bool distant_join_stations
allow to join non-adjacent stations
A row being displayed in the cargo view (as opposed to being "hidden" behind a plus sign).
StationID next_station
ID of the station belonging to the entry actually displayed if it's to/from/via.
CargoDataEntry * filter
Parent of the cargo entry belonging to the row.
CargoType next_cargo
ID of the cargo belonging to the entry actually displayed if it's cargo.
The StationView window.
void HandleCargoWaitingClick(int row)
Handle a click on a specific row in the cargo view.
int DrawEntries(CargoDataEntry &entry, const Rect &r, int pos, int maxrows, int column, CargoType cargo=INVALID_CARGO)
Draw the given cargo entries in the station GUI.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
Mode
Display mode of the cargo view.
@ MODE_PLANNED
Show cargo planned to pass through the station.
@ MODE_WAITING
Show cargo waiting at the station.
std::array< Grouping, NUM_COLUMNS > groupings
Grouping modes for the different columns.
void EstimateDestinations(CargoType 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...
void SelectSortBy(int index)
Select a new sort criterium for the cargo view.
void OnResize() override
Called after the window got resized.
StringID SearchNonStop(CargoDataEntry &cd, StationID station, int column)
Determine if we need to show the special "non-stop" string.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Grouping
Type of grouping used in each of the "columns".
@ GR_SOURCE
Group by source of cargo ("from").
@ GR_NEXT
Group by next station ("via").
@ GR_CARGO
Group by cargo type.
@ GR_DESTINATION
Group by estimated final destination ("to").
void BuildCargoList(CargoType cargo, const StationCargoList &packets, CargoDataEntry *entry)
Build up the cargo view for WAITING mode and a specific cargo.
int DrawCargoRatings(const Rect &r) const
Draw cargo ratings in the WID_SV_ACCEPT_RATING_LIST widget.
static const int NUM_COLUMNS
Number of "columns" in the cargo view: cargo, from, via, to.
void RecalcDestinations(CargoType cargo)
Rebuild the cache for estimated destinations which is used to quickly show the "destination" entries ...
Invalidation
Type of data invalidation.
@ INV_FLOWS
The planned flows have been recalculated and everything has to be updated.
@ INV_CARGO
Some cargo has been added or removed.
void BuildCargoList(CargoDataEntry *entry, const Station *st)
Build up the cargo view for all cargoes.
void SelectSortOrder(SortOrder order)
Select a new sort order for the cargo view.
CargoDataEntry expanded_rows
Parent entry of currently expanded rows.
void OnPaint() override
The window must be repainted.
static constexpr uint RATING_LINES
Height in lines of the cargo ratings view.
CargoDataVector displayed_rows
Parent entry of currently displayed rows (including collapsed ones).
static const StringID group_names[]
Names of the grouping options in the dropdown.
int grouping_index
Currently selected entry in the grouping drop down.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
static constexpr uint ACCEPTS_LINES
Height in lines of the accepted cargo view.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
StringID GetEntryString(StationID station, StringID here, StringID other_station, StringID any) const
Select the correct string for an entry referring to the specified station.
std::array< CargoSortType, NUM_COLUMNS > sortings
Sort types of the different 'columns'.
void SetDisplayedRow(const CargoDataEntry &entry)
Mark a specific row, characterized by its CargoDataEntry, as expanded.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
std::array< SortOrder, NUM_COLUMNS > sort_orders
Sort order (ascending/descending) for the 'columns'.
uint expand_shrink_width
The width allocated to the expand/shrink 'button'.
void HandleCargoWaitingClick(CargoDataEntry *filter, Tid next)
Expand or collapse a specific row.
int rating_lines
Number of lines in the cargo ratings view.
static const StringID sort_names[]
Names of the sorting options in the dropdown.
CargoDataEntry cached_destinations
Cache for the flows passing through this station.
int scroll_to_row
If set, scroll the main viewport to the station pointed to by this row.
Mode current_mode
Currently selected display mode of cargo view.
int accepts_lines
Number of lines in the accepted cargo view.
void BuildFlowList(CargoType cargo, const FlowStatMap &flows, CargoDataEntry *entry)
Build up the cargo view for PLANNED mode and a specific cargo.
void SelectGroupBy(int index)
Select a new grouping mode for the cargo view.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
int DrawAcceptedCargo(const Rect &r) const
Draw accepted cargo in the WID_SV_ACCEPT_RATING_LIST widget.
void ShowCargo(CargoDataEntry *data, CargoType cargo, StationID source, StationID next, StationID dest, uint count)
Show a certain cargo entry characterized by source/next/dest station, cargo type and amount of cargo ...
Station data structure.
std::array< GoodsEntry, NUM_CARGO > goods
Goods at this station.
Airport airport
Tile area the airport covers.
Struct containing TileIndex and StationID.
TileIndex tile
TileIndex.
StationID station
StationID.
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
uint8_t dirty
Whether the build station window needs to redraw due to the changed selection.
Point size
Size, in tile "units", of the white/red selection area.
Point pos
Location, in tile "units", of the northern tile of the selected area.
bool freeze
Freeze highlight in place.
CompanyID exclusivity
which company has exclusivity
Definition town.h:73
uint8_t exclusive_counter
months till the exclusivity expires
Definition town.h:74
The information about a vehicle list.
Definition vehiclelist.h:32
Representation of a waypoint.
High level window description.
Definition window_gui.h:167
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:273
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:967
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1091
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition widget.cpp:826
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1778
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:777
Window * parent
Parent window.
Definition window_gui.h:328
void RaiseWidget(WidgetID widget_index)
Marks a widget as raised.
Definition window_gui.h:469
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:555
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:503
void DrawSortButtonState(WidgetID widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition widget.cpp:809
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1064
ResizeInfo resize
Resize information.
Definition window_gui.h:314
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1768
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:491
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition window_gui.h:316
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:441
bool IsShaded() const
Is window shaded currently?
Definition window_gui.h:559
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition window_gui.h:355
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:460
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:312
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:381
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:311
void ToggleWidgetLoweredState(WidgetID widget_index)
Invert the lowered/raised status of a widget.
Definition window_gui.h:450
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:302
Stuff related to the text buffer GUI.
@ EnableDefault
enable the 'Default' button ("\0" is returned)
@ LengthIsInChars
the length of the string is counted in characters
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
static const uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
@ MP_STATION
A tile of a station.
Definition tile_type.h:53
Functions related to tile highlights.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
void UpdateTileSelection()
Updates tile highlighting for all cases.
@ HT_RECT
rectangle (stations, depots, ...)
Base of the town class.
Functions related to the vehicle's GUIs.
VehicleType
Available vehicle types.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
Functions and type for generating vehicle lists.
@ VL_STATION_LIST
Index is the station.
Definition vehiclelist.h:25
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
const Station * _viewport_highlight_station
Currently selected station for coverage area highlight.
Functions related to (drawing on) viewports.
Base of waypoints.
@ WPF_ROAD
This is a road waypoint.
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:67
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:45
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:40
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:58
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition widget_type.h:56
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:53
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:77
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:69
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:61
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition widget_type.h:60
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition widget_type.h:57
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:62
@ EqualSize
Containers should keep all their (resizing) children equally large.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1182
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1140
Window functions not directly related to making/drawing windows.
@ Construction
This window is used for construction; close it whenever changing company.
@ SBS_DOWN
Sort ascending.
Definition window_gui.h:218
@ SBS_UP
Sort descending.
Definition window_gui.h:219
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
int WidgetID
Widget ID.
Definition window_type.h:20
@ WC_STATION_LIST
Station list; Window numbers:
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:47
@ WC_SELECT_STATION
Select station (when joining stations); Window numbers:
@ WC_SHIPS_LIST
Ships list; Window numbers:
@ WC_STATION_VIEW
Station view; Window numbers:
@ WC_TRAINS_LIST
Trains list; Window numbers:
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Functions related to zooming.
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition zoom_func.h:107