Fix #8316: Make sort industries by production and transported with a cargo filter...
[openttd-github.git] / src / industry_gui.cpp
blob69462c6f066a2a65fd46367821f090f29f0f6598
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file industry_gui.cpp GUIs related to industries. */
10 #include "stdafx.h"
11 #include "error.h"
12 #include "gui.h"
13 #include "settings_gui.h"
14 #include "sound_func.h"
15 #include "window_func.h"
16 #include "textbuf_gui.h"
17 #include "command_func.h"
18 #include "viewport_func.h"
19 #include "industry.h"
20 #include "town.h"
21 #include "cheat_type.h"
22 #include "newgrf_industries.h"
23 #include "newgrf_text.h"
24 #include "newgrf_debug.h"
25 #include "network/network.h"
26 #include "strings_func.h"
27 #include "company_func.h"
28 #include "tilehighlight_func.h"
29 #include "string_func.h"
30 #include "sortlist_type.h"
31 #include "widgets/dropdown_func.h"
32 #include "company_base.h"
33 #include "core/geometry_func.hpp"
34 #include "core/random_func.hpp"
35 #include "core/backup_type.hpp"
36 #include "genworld.h"
37 #include "smallmap_gui.h"
38 #include "widgets/dropdown_type.h"
39 #include "widgets/industry_widget.h"
40 #include "clear_map.h"
41 #include "zoom_func.h"
43 #include "table/strings.h"
45 #include <bitset>
47 #include "safeguards.h"
49 bool _ignore_restrictions;
50 std::bitset<NUM_INDUSTRYTYPES> _displayed_industries; ///< Communication from the industry chain window to the smallmap window about what industries to display.
52 /** Cargo suffix type (for which window is it requested) */
53 enum CargoSuffixType {
54 CST_FUND, ///< Fund-industry window
55 CST_VIEW, ///< View-industry window
56 CST_DIR, ///< Industry-directory window
59 /** Ways of displaying the cargo. */
60 enum CargoSuffixDisplay {
61 CSD_CARGO, ///< Display the cargo without sub-type (cb37 result 401).
62 CSD_CARGO_AMOUNT, ///< Display the cargo and amount (if useful), but no sub-type (cb37 result 400 or fail).
63 CSD_CARGO_TEXT, ///< Display then cargo and supplied string (cb37 result 800-BFF).
64 CSD_CARGO_AMOUNT_TEXT, ///< Display then cargo, amount, and string (cb37 result 000-3FF).
67 /** Transfer storage of cargo suffix information. */
68 struct CargoSuffix {
69 CargoSuffixDisplay display; ///< How to display the cargo and text.
70 char text[512]; ///< Cargo suffix text.
73 static void ShowIndustryCargoesWindow(IndustryType id);
75 /**
76 * Gets the string to display after the cargo name (using callback 37)
77 * @param cargo the cargo for which the suffix is requested, meaning depends on presence of flag 18 in prop 1A
78 * @param cst the cargo suffix type (for which window is it requested). @see CargoSuffixType
79 * @param ind the industry (nullptr if in fund window)
80 * @param ind_type the industry type
81 * @param indspec the industry spec
82 * @param suffix is filled with the string to display
84 static void GetCargoSuffix(uint cargo, CargoSuffixType cst, const Industry *ind, IndustryType ind_type, const IndustrySpec *indspec, CargoSuffix &suffix)
86 suffix.text[0] = '\0';
87 suffix.display = CSD_CARGO_AMOUNT;
89 if (HasBit(indspec->callback_mask, CBM_IND_CARGO_SUFFIX)) {
90 TileIndex t = (cst != CST_FUND) ? ind->location.tile : INVALID_TILE;
91 uint16 callback = GetIndustryCallback(CBID_INDUSTRY_CARGO_SUFFIX, 0, (cst << 8) | cargo, const_cast<Industry *>(ind), ind_type, t);
92 if (callback == CALLBACK_FAILED) return;
94 if (indspec->grf_prop.grffile->grf_version < 8) {
95 if (GB(callback, 0, 8) == 0xFF) return;
96 if (callback < 0x400) {
97 StartTextRefStackUsage(indspec->grf_prop.grffile, 6);
98 GetString(suffix.text, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + callback), lastof(suffix.text));
99 StopTextRefStackUsage();
100 suffix.display = CSD_CARGO_AMOUNT_TEXT;
101 return;
103 ErrorUnknownCallbackResult(indspec->grf_prop.grffile->grfid, CBID_INDUSTRY_CARGO_SUFFIX, callback);
104 return;
106 } else { // GRF version 8 or higher.
107 if (callback == 0x400) return;
108 if (callback == 0x401) {
109 suffix.display = CSD_CARGO;
110 return;
112 if (callback < 0x400) {
113 StartTextRefStackUsage(indspec->grf_prop.grffile, 6);
114 GetString(suffix.text, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + callback), lastof(suffix.text));
115 StopTextRefStackUsage();
116 suffix.display = CSD_CARGO_AMOUNT_TEXT;
117 return;
119 if (callback >= 0x800 && callback < 0xC00) {
120 StartTextRefStackUsage(indspec->grf_prop.grffile, 6);
121 GetString(suffix.text, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 - 0x800 + callback), lastof(suffix.text));
122 StopTextRefStackUsage();
123 suffix.display = CSD_CARGO_TEXT;
124 return;
126 ErrorUnknownCallbackResult(indspec->grf_prop.grffile->grfid, CBID_INDUSTRY_CARGO_SUFFIX, callback);
127 return;
132 enum CargoSuffixInOut {
133 CARGOSUFFIX_OUT = 0,
134 CARGOSUFFIX_IN = 1,
138 * Gets all strings to display after the cargoes of industries (using callback 37)
139 * @param use_input get suffixes for output cargoes or input cargoes?
140 * @param cst the cargo suffix type (for which window is it requested). @see CargoSuffixType
141 * @param ind the industry (nullptr if in fund window)
142 * @param ind_type the industry type
143 * @param indspec the industry spec
144 * @param cargoes array with cargotypes. for CT_INVALID no suffix will be determined
145 * @param suffixes is filled with the suffixes
147 template <typename TC, typename TS>
148 static inline void GetAllCargoSuffixes(CargoSuffixInOut use_input, CargoSuffixType cst, const Industry *ind, IndustryType ind_type, const IndustrySpec *indspec, const TC &cargoes, TS &suffixes)
150 static_assert(lengthof(cargoes) <= lengthof(suffixes));
152 if (indspec->behaviour & INDUSTRYBEH_CARGOTYPES_UNLIMITED) {
153 /* Reworked behaviour with new many-in-many-out scheme */
154 for (uint j = 0; j < lengthof(suffixes); j++) {
155 if (cargoes[j] != CT_INVALID) {
156 byte local_id = indspec->grf_prop.grffile->cargo_map[cargoes[j]]; // should we check the value for valid?
157 uint cargotype = local_id << 16 | use_input;
158 GetCargoSuffix(cargotype, cst, ind, ind_type, indspec, suffixes[j]);
159 } else {
160 suffixes[j].text[0] = '\0';
161 suffixes[j].display = CSD_CARGO;
164 } else {
165 /* Compatible behaviour with old 3-in-2-out scheme */
166 for (uint j = 0; j < lengthof(suffixes); j++) {
167 suffixes[j].text[0] = '\0';
168 suffixes[j].display = CSD_CARGO;
170 switch (use_input) {
171 case CARGOSUFFIX_OUT:
172 if (cargoes[0] != CT_INVALID) GetCargoSuffix(3, cst, ind, ind_type, indspec, suffixes[0]);
173 if (cargoes[1] != CT_INVALID) GetCargoSuffix(4, cst, ind, ind_type, indspec, suffixes[1]);
174 break;
175 case CARGOSUFFIX_IN:
176 if (cargoes[0] != CT_INVALID) GetCargoSuffix(0, cst, ind, ind_type, indspec, suffixes[0]);
177 if (cargoes[1] != CT_INVALID) GetCargoSuffix(1, cst, ind, ind_type, indspec, suffixes[1]);
178 if (cargoes[2] != CT_INVALID) GetCargoSuffix(2, cst, ind, ind_type, indspec, suffixes[2]);
179 break;
180 default:
181 NOT_REACHED();
186 std::array<IndustryType, NUM_INDUSTRYTYPES> _sorted_industry_types; ///< Industry types sorted by name.
188 /** Sort industry types by their name. */
189 static bool IndustryTypeNameSorter(const IndustryType &a, const IndustryType &b)
191 static char industry_name[2][64];
193 const IndustrySpec *indsp1 = GetIndustrySpec(a);
194 GetString(industry_name[0], indsp1->name, lastof(industry_name[0]));
196 const IndustrySpec *indsp2 = GetIndustrySpec(b);
197 GetString(industry_name[1], indsp2->name, lastof(industry_name[1]));
199 int r = strnatcmp(industry_name[0], industry_name[1]); // Sort by name (natural sorting).
201 /* If the names are equal, sort by industry type. */
202 return (r != 0) ? r < 0 : (a < b);
206 * Initialize the list of sorted industry types.
208 void SortIndustryTypes()
210 /* Add each industry type to the list. */
211 for (IndustryType i = 0; i < NUM_INDUSTRYTYPES; i++) {
212 _sorted_industry_types[i] = i;
215 /* Sort industry types by name. */
216 std::sort(_sorted_industry_types.begin(), _sorted_industry_types.end(), IndustryTypeNameSorter);
220 * Command callback. In case of failure to build an industry, show an error message.
221 * @param result Result of the command.
222 * @param tile Tile where the industry is placed.
223 * @param p1 Additional data of the #CMD_BUILD_INDUSTRY command.
224 * @param p2 Additional data of the #CMD_BUILD_INDUSTRY command.
225 * @param cmd Unused.
227 void CcBuildIndustry(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
229 if (result.Succeeded()) return;
231 uint8 indtype = GB(p1, 0, 8);
232 if (indtype < NUM_INDUSTRYTYPES) {
233 const IndustrySpec *indsp = GetIndustrySpec(indtype);
234 if (indsp->enabled) {
235 SetDParam(0, indsp->name);
236 ShowErrorMessage(STR_ERROR_CAN_T_BUILD_HERE, result.GetErrorMessage(), WL_INFO, TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE);
241 static const NWidgetPart _nested_build_industry_widgets[] = {
242 NWidget(NWID_HORIZONTAL),
243 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
244 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_FUND_INDUSTRY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
245 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
246 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
247 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
248 EndContainer(),
249 NWidget(NWID_SELECTION, COLOUR_DARK_GREEN, WID_DPI_SCENARIO_EDITOR_PANE),
250 NWidget(NWID_VERTICAL),
251 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_DPI_CREATE_RANDOM_INDUSTRIES_WIDGET), SetMinimalSize(0, 12), SetFill(1, 0), SetResize(1, 0),
252 SetDataTip(STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES, STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES_TOOLTIP),
253 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_DPI_REMOVE_ALL_INDUSTRIES_WIDGET), SetMinimalSize(0, 12), SetFill(1, 0), SetResize(1, 0),
254 SetDataTip(STR_FUND_INDUSTRY_REMOVE_ALL_INDUSTRIES, STR_FUND_INDUSTRY_REMOVE_ALL_INDUSTRIES_TOOLTIP),
255 EndContainer(),
256 EndContainer(),
257 NWidget(NWID_HORIZONTAL),
258 NWidget(WWT_MATRIX, COLOUR_DARK_GREEN, WID_DPI_MATRIX_WIDGET), SetMatrixDataTip(1, 0, STR_FUND_INDUSTRY_SELECTION_TOOLTIP), SetFill(1, 0), SetResize(1, 1), SetScrollbar(WID_DPI_SCROLLBAR),
259 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_DPI_SCROLLBAR),
260 EndContainer(),
261 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_DPI_INFOPANEL), SetResize(1, 0),
262 EndContainer(),
263 NWidget(NWID_HORIZONTAL),
264 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_DPI_DISPLAY_WIDGET), SetFill(1, 0), SetResize(1, 0),
265 SetDataTip(STR_INDUSTRY_DISPLAY_CHAIN, STR_INDUSTRY_DISPLAY_CHAIN_TOOLTIP),
266 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_DPI_FUND_WIDGET), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_JUST_STRING, STR_NULL),
267 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
268 EndContainer(),
271 /** Window definition of the dynamic place industries gui */
272 static WindowDesc _build_industry_desc(
273 WDP_AUTO, "build_industry", 170, 212,
274 WC_BUILD_INDUSTRY, WC_NONE,
275 WDF_CONSTRUCTION,
276 _nested_build_industry_widgets, lengthof(_nested_build_industry_widgets)
279 /** Build (fund or prospect) a new industry, */
280 class BuildIndustryWindow : public Window {
281 int selected_index; ///< index of the element in the matrix
282 IndustryType selected_type; ///< industry corresponding to the above index
283 uint16 count; ///< How many industries are loaded
284 IndustryType index[NUM_INDUSTRYTYPES + 1]; ///< Type of industry, in the order it was loaded
285 bool enabled[NUM_INDUSTRYTYPES + 1]; ///< availability state, coming from CBID_INDUSTRY_PROBABILITY (if ever)
286 Scrollbar *vscroll;
287 Dimension legend; ///< Dimension of the legend 'blob'.
289 /** The largest allowed minimum-width of the window, given in line heights */
290 static const int MAX_MINWIDTH_LINEHEIGHTS = 20;
292 void SetupArrays()
294 this->count = 0;
296 for (uint i = 0; i < lengthof(this->index); i++) {
297 this->index[i] = INVALID_INDUSTRYTYPE;
298 this->enabled[i] = false;
301 /* Fill the arrays with industries.
302 * The tests performed after the enabled allow to load the industries
303 * In the same way they are inserted by grf (if any)
305 for (IndustryType ind : _sorted_industry_types) {
306 const IndustrySpec *indsp = GetIndustrySpec(ind);
307 if (indsp->enabled) {
308 /* Rule is that editor mode loads all industries.
309 * In game mode, all non raw industries are loaded too
310 * and raw ones are loaded only when setting allows it */
311 if (_game_mode != GM_EDITOR && indsp->IsRawIndustry() && _settings_game.construction.raw_industry_construction == 0) {
312 /* Unselect if the industry is no longer in the list */
313 if (this->selected_type == ind) this->selected_index = -1;
314 continue;
316 this->index[this->count] = ind;
317 this->enabled[this->count] = (_game_mode == GM_EDITOR) || GetIndustryProbabilityCallback(ind, IACT_USERCREATION, 1) > 0;
318 /* Keep the selection to the correct line */
319 if (this->selected_type == ind) this->selected_index = this->count;
320 this->count++;
324 /* first industry type is selected if the current selection is invalid.
325 * I'll be damned if there are none available ;) */
326 if (this->selected_index == -1) {
327 this->selected_index = 0;
328 this->selected_type = this->index[0];
331 this->vscroll->SetCount(this->count);
334 /** Update status of the fund and display-chain widgets. */
335 void SetButtons()
337 this->SetWidgetDisabledState(WID_DPI_FUND_WIDGET, this->selected_type != INVALID_INDUSTRYTYPE && !this->enabled[this->selected_index]);
338 this->SetWidgetDisabledState(WID_DPI_DISPLAY_WIDGET, this->selected_type == INVALID_INDUSTRYTYPE && this->enabled[this->selected_index]);
342 * Build a string of cargo names with suffixes attached.
343 * This is distinct from the CARGO_LIST string formatting code in two ways:
344 * - This cargo list uses the order defined by the industry, rather than alphabetic.
345 * - NewGRF-supplied suffix strings can be attached to each cargo.
347 * @param cargolist Array of CargoID to display
348 * @param cargo_suffix Array of suffixes to attach to each cargo
349 * @param cargolistlen Length of arrays
350 * @param prefixstr String to use for the first item
351 * @return A formatted raw string
353 std::string MakeCargoListString(const CargoID *cargolist, const CargoSuffix *cargo_suffix, int cargolistlen, StringID prefixstr) const
355 std::string cargostring;
356 char buf[1024];
357 int numcargo = 0;
358 int firstcargo = -1;
360 for (int j = 0; j < cargolistlen; j++) {
361 if (cargolist[j] == CT_INVALID) continue;
362 numcargo++;
363 if (firstcargo < 0) {
364 firstcargo = j;
365 continue;
367 SetDParam(0, CargoSpec::Get(cargolist[j])->name);
368 SetDParamStr(1, cargo_suffix[j].text);
369 GetString(buf, STR_INDUSTRY_VIEW_CARGO_LIST_EXTENSION, lastof(buf));
370 cargostring += buf;
373 if (numcargo > 0) {
374 SetDParam(0, CargoSpec::Get(cargolist[firstcargo])->name);
375 SetDParamStr(1, cargo_suffix[firstcargo].text);
376 GetString(buf, prefixstr, lastof(buf));
377 cargostring = std::string(buf) + cargostring;
378 } else {
379 SetDParam(0, STR_JUST_NOTHING);
380 SetDParamStr(1, "");
381 GetString(buf, prefixstr, lastof(buf));
382 cargostring = std::string(buf);
385 return cargostring;
388 public:
389 BuildIndustryWindow() : Window(&_build_industry_desc)
391 this->selected_index = -1;
392 this->selected_type = INVALID_INDUSTRYTYPE;
394 this->CreateNestedTree();
395 this->vscroll = this->GetScrollbar(WID_DPI_SCROLLBAR);
396 this->FinishInitNested(0);
398 this->SetButtons();
400 /* Show scenario editor tools in editor. */
401 if (_game_mode != GM_EDITOR) {
402 auto *se_tools = this->GetWidget<NWidgetStacked>(WID_DPI_SCENARIO_EDITOR_PANE);
403 se_tools->SetDisplayedPlane(SZSP_HORIZONTAL);
404 this->ReInit();
408 void OnInit() override
410 /* Width of the legend blob -- slightly larger than the smallmap legend blob. */
411 this->legend.height = FONT_HEIGHT_SMALL;
412 this->legend.width = this->legend.height * 8 / 5;
414 this->SetupArrays();
417 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
419 switch (widget) {
420 case WID_DPI_MATRIX_WIDGET: {
421 Dimension d = GetStringBoundingBox(STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES);
422 for (uint16 i = 0; i < this->count; i++) {
423 if (this->index[i] == INVALID_INDUSTRYTYPE) continue;
424 d = maxdim(d, GetStringBoundingBox(GetIndustrySpec(this->index[i])->name));
426 resize->height = std::max<uint>(this->legend.height, FONT_HEIGHT_NORMAL) + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
427 d.width += this->legend.width + ScaleFontTrad(7) + padding.width;
428 d.height = 5 * resize->height;
429 *size = maxdim(*size, d);
430 break;
433 case WID_DPI_INFOPANEL: {
434 /* Extra line for cost outside of editor. */
435 int height = 2 + (_game_mode == GM_EDITOR ? 0 : 1);
436 uint extra_lines_req = 0;
437 uint extra_lines_prd = 0;
438 uint extra_lines_newgrf = 0;
439 uint max_minwidth = FONT_HEIGHT_NORMAL * MAX_MINWIDTH_LINEHEIGHTS;
440 Dimension d = {0, 0};
441 for (uint16 i = 0; i < this->count; i++) {
442 if (this->index[i] == INVALID_INDUSTRYTYPE) continue;
444 const IndustrySpec *indsp = GetIndustrySpec(this->index[i]);
445 CargoSuffix cargo_suffix[lengthof(indsp->accepts_cargo)];
447 /* Measure the accepted cargoes, if any. */
448 GetAllCargoSuffixes(CARGOSUFFIX_IN, CST_FUND, nullptr, this->index[i], indsp, indsp->accepts_cargo, cargo_suffix);
449 std::string cargostring = this->MakeCargoListString(indsp->accepts_cargo, cargo_suffix, lengthof(indsp->accepts_cargo), STR_INDUSTRY_VIEW_REQUIRES_N_CARGO);
450 Dimension strdim = GetStringBoundingBox(cargostring.c_str());
451 if (strdim.width > max_minwidth) {
452 extra_lines_req = std::max(extra_lines_req, strdim.width / max_minwidth + 1);
453 strdim.width = max_minwidth;
455 d = maxdim(d, strdim);
457 /* Measure the produced cargoes, if any. */
458 GetAllCargoSuffixes(CARGOSUFFIX_OUT, CST_FUND, nullptr, this->index[i], indsp, indsp->produced_cargo, cargo_suffix);
459 cargostring = this->MakeCargoListString(indsp->produced_cargo, cargo_suffix, lengthof(indsp->produced_cargo), STR_INDUSTRY_VIEW_PRODUCES_N_CARGO);
460 strdim = GetStringBoundingBox(cargostring.c_str());
461 if (strdim.width > max_minwidth) {
462 extra_lines_prd = std::max(extra_lines_prd, strdim.width / max_minwidth + 1);
463 strdim.width = max_minwidth;
465 d = maxdim(d, strdim);
467 if (indsp->grf_prop.grffile != nullptr) {
468 /* Reserve a few extra lines for text from an industry NewGRF. */
469 extra_lines_newgrf = 4;
473 /* Set it to something more sane :) */
474 height += extra_lines_prd + extra_lines_req + extra_lines_newgrf;
475 size->height = height * FONT_HEIGHT_NORMAL + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
476 size->width = d.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
477 break;
480 case WID_DPI_FUND_WIDGET: {
481 Dimension d = GetStringBoundingBox(STR_FUND_INDUSTRY_BUILD_NEW_INDUSTRY);
482 d = maxdim(d, GetStringBoundingBox(STR_FUND_INDUSTRY_PROSPECT_NEW_INDUSTRY));
483 d = maxdim(d, GetStringBoundingBox(STR_FUND_INDUSTRY_FUND_NEW_INDUSTRY));
484 d.width += padding.width;
485 d.height += padding.height;
486 *size = maxdim(*size, d);
487 break;
492 void SetStringParameters(int widget) const override
494 switch (widget) {
495 case WID_DPI_FUND_WIDGET:
496 /* Raw industries might be prospected. Show this fact by changing the string
497 * In Editor, you just build, while ingame, or you fund or you prospect */
498 if (_game_mode == GM_EDITOR) {
499 /* We've chosen many random industries but no industries have been specified */
500 SetDParam(0, STR_FUND_INDUSTRY_BUILD_NEW_INDUSTRY);
501 } else {
502 const IndustrySpec *indsp = GetIndustrySpec(this->index[this->selected_index]);
503 SetDParam(0, (_settings_game.construction.raw_industry_construction == 2 && indsp->IsRawIndustry()) ? STR_FUND_INDUSTRY_PROSPECT_NEW_INDUSTRY : STR_FUND_INDUSTRY_FUND_NEW_INDUSTRY);
505 break;
509 void DrawWidget(const Rect &r, int widget) const override
511 switch (widget) {
512 case WID_DPI_MATRIX_WIDGET: {
513 uint text_left, text_right, icon_left, icon_right;
514 if (_current_text_dir == TD_RTL) {
515 icon_right = r.right - WD_MATRIX_RIGHT;
516 icon_left = icon_right - this->legend.width;
517 text_right = icon_left - ScaleFontTrad(7);
518 text_left = r.left + WD_MATRIX_LEFT;
519 } else {
520 icon_left = r.left + WD_MATRIX_LEFT;
521 icon_right = icon_left + this->legend.width;
522 text_left = icon_right + ScaleFontTrad(7);
523 text_right = r.right - WD_MATRIX_RIGHT;
526 /* Vertical offset for legend icon. */
527 int icon_top = (this->resize.step_height - this->legend.height + 1) / 2;
528 int icon_bottom = icon_top + this->legend.height;
530 int y = r.top;
531 for (uint16 i = 0; i < this->vscroll->GetCapacity() && i + this->vscroll->GetPosition() < this->count; i++) {
532 bool selected = this->selected_index == i + this->vscroll->GetPosition();
534 if (this->index[i + this->vscroll->GetPosition()] == INVALID_INDUSTRYTYPE) {
535 DrawString(text_left, text_right, y + WD_MATRIX_TOP, STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES, selected ? TC_WHITE : TC_ORANGE);
536 y += this->resize.step_height;
537 continue;
539 const IndustrySpec *indsp = GetIndustrySpec(this->index[i + this->vscroll->GetPosition()]);
541 /* Draw the name of the industry in white is selected, otherwise, in orange */
542 DrawString(text_left, text_right, y + WD_MATRIX_TOP, indsp->name, selected ? TC_WHITE : TC_ORANGE);
543 GfxFillRect(icon_left, y + icon_top, icon_right, y + icon_bottom, selected ? PC_WHITE : PC_BLACK);
544 GfxFillRect(icon_left + 1, y + icon_top + 1, icon_right - 1, y + icon_bottom - 1, indsp->map_colour);
546 y += this->resize.step_height;
548 break;
551 case WID_DPI_INFOPANEL: {
552 int y = r.top + WD_FRAMERECT_TOP;
553 int bottom = r.bottom - WD_FRAMERECT_BOTTOM;
554 int left = r.left + WD_FRAMERECT_LEFT;
555 int right = r.right - WD_FRAMERECT_RIGHT;
557 if (this->selected_type == INVALID_INDUSTRYTYPE) {
558 DrawStringMultiLine(left, right, y, bottom, STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES_TOOLTIP);
559 break;
562 const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);
564 if (_game_mode != GM_EDITOR) {
565 SetDParam(0, indsp->GetConstructionCost());
566 DrawString(left, right, y, STR_FUND_INDUSTRY_INDUSTRY_BUILD_COST);
567 y += FONT_HEIGHT_NORMAL;
570 CargoSuffix cargo_suffix[lengthof(indsp->accepts_cargo)];
572 /* Draw the accepted cargoes, if any. Otherwise, will print "Nothing". */
573 GetAllCargoSuffixes(CARGOSUFFIX_IN, CST_FUND, nullptr, this->selected_type, indsp, indsp->accepts_cargo, cargo_suffix);
574 std::string cargostring = this->MakeCargoListString(indsp->accepts_cargo, cargo_suffix, lengthof(indsp->accepts_cargo), STR_INDUSTRY_VIEW_REQUIRES_N_CARGO);
575 y = DrawStringMultiLine(left, right, y, bottom, cargostring);
577 /* Draw the produced cargoes, if any. Otherwise, will print "Nothing". */
578 GetAllCargoSuffixes(CARGOSUFFIX_OUT, CST_FUND, nullptr, this->selected_type, indsp, indsp->produced_cargo, cargo_suffix);
579 cargostring = this->MakeCargoListString(indsp->produced_cargo, cargo_suffix, lengthof(indsp->produced_cargo), STR_INDUSTRY_VIEW_PRODUCES_N_CARGO);
580 y = DrawStringMultiLine(left, right, y, bottom, cargostring);
582 /* Get the additional purchase info text, if it has not already been queried. */
583 if (HasBit(indsp->callback_mask, CBM_IND_FUND_MORE_TEXT)) {
584 uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_FUND_MORE_TEXT, 0, 0, nullptr, this->selected_type, INVALID_TILE);
585 if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
586 if (callback_res > 0x400) {
587 ErrorUnknownCallbackResult(indsp->grf_prop.grffile->grfid, CBID_INDUSTRY_FUND_MORE_TEXT, callback_res);
588 } else {
589 StringID str = GetGRFStringID(indsp->grf_prop.grffile->grfid, 0xD000 + callback_res); // No. here's the new string
590 if (str != STR_UNDEFINED) {
591 StartTextRefStackUsage(indsp->grf_prop.grffile, 6);
592 DrawStringMultiLine(left, right, y, bottom, str, TC_YELLOW);
593 StopTextRefStackUsage();
598 break;
603 static void AskManyRandomIndustriesCallback(Window *w, bool confirmed)
605 if (!confirmed) return;
607 if (Town::GetNumItems() == 0) {
608 ShowErrorMessage(STR_ERROR_CAN_T_GENERATE_INDUSTRIES, STR_ERROR_MUST_FOUND_TOWN_FIRST, WL_INFO);
609 } else {
610 extern void GenerateIndustries();
611 Backup<bool> old_generating_world(_generating_world, true, FILE_LINE);
612 GenerateIndustries();
613 old_generating_world.Restore();
617 static void AskRemoveAllIndustriesCallback(Window *w, bool confirmed)
619 if (!confirmed) return;
621 for (Industry *industry : Industry::Iterate()) delete industry;
623 /* Clear farmland. */
624 for (TileIndex tile = 0; tile < MapSize(); tile++) {
625 if (IsTileType(tile, MP_CLEAR) && GetRawClearGround(tile) == CLEAR_FIELDS) {
626 MakeClear(tile, CLEAR_GRASS, 3);
630 MarkWholeScreenDirty();
633 void OnClick(Point pt, int widget, int click_count) override
635 switch (widget) {
636 case WID_DPI_CREATE_RANDOM_INDUSTRIES_WIDGET: {
637 assert(_game_mode == GM_EDITOR);
638 this->HandleButtonClick(WID_DPI_CREATE_RANDOM_INDUSTRIES_WIDGET);
639 ShowQuery(STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES_CAPTION, STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES_QUERY, nullptr, AskManyRandomIndustriesCallback);
640 break;
643 case WID_DPI_REMOVE_ALL_INDUSTRIES_WIDGET: {
644 assert(_game_mode == GM_EDITOR);
645 this->HandleButtonClick(WID_DPI_REMOVE_ALL_INDUSTRIES_WIDGET);
646 ShowQuery(STR_FUND_INDUSTRY_REMOVE_ALL_INDUSTRIES_CAPTION, STR_FUND_INDUSTRY_REMOVE_ALL_INDUSTRIES_QUERY, nullptr, AskRemoveAllIndustriesCallback);
647 break;
650 case WID_DPI_MATRIX_WIDGET: {
651 int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_DPI_MATRIX_WIDGET);
652 if (y < this->count) { // Is it within the boundaries of available data?
653 this->selected_index = y;
654 this->selected_type = this->index[y];
655 const IndustrySpec *indsp = (this->selected_type == INVALID_INDUSTRYTYPE) ? nullptr : GetIndustrySpec(this->selected_type);
657 this->SetDirty();
659 if (_thd.GetCallbackWnd() == this &&
660 ((_game_mode != GM_EDITOR && _settings_game.construction.raw_industry_construction == 2 && indsp != nullptr && indsp->IsRawIndustry()) ||
661 this->selected_type == INVALID_INDUSTRYTYPE ||
662 !this->enabled[this->selected_index])) {
663 /* Reset the button state if going to prospecting or "build many industries" */
664 this->RaiseButtons();
665 ResetObjectToPlace();
668 this->SetButtons();
669 if (this->enabled[this->selected_index] && click_count > 1) this->OnClick(pt, WID_DPI_FUND_WIDGET, 1);
671 break;
674 case WID_DPI_DISPLAY_WIDGET:
675 if (this->selected_type != INVALID_INDUSTRYTYPE) ShowIndustryCargoesWindow(this->selected_type);
676 break;
678 case WID_DPI_FUND_WIDGET: {
679 if (this->selected_type != INVALID_INDUSTRYTYPE) {
680 if (_game_mode != GM_EDITOR && _settings_game.construction.raw_industry_construction == 2 && GetIndustrySpec(this->selected_type)->IsRawIndustry()) {
681 DoCommandP(0, this->selected_type, InteractiveRandom(), CMD_BUILD_INDUSTRY | CMD_MSG(STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY));
682 this->HandleButtonClick(WID_DPI_FUND_WIDGET);
683 } else {
684 HandlePlacePushButton(this, WID_DPI_FUND_WIDGET, SPR_CURSOR_INDUSTRY, HT_RECT);
687 break;
692 void OnResize() override
694 /* Adjust the number of items in the matrix depending of the resize */
695 this->vscroll->SetCapacityFromWidget(this, WID_DPI_MATRIX_WIDGET);
698 void OnPlaceObject(Point pt, TileIndex tile) override
700 bool success = true;
701 /* We do not need to protect ourselves against "Random Many Industries" in this mode */
702 const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);
703 uint32 seed = InteractiveRandom();
704 uint32 layout_index = InteractiveRandomRange((uint32)indsp->layouts.size());
706 if (_game_mode == GM_EDITOR) {
707 /* Show error if no town exists at all */
708 if (Town::GetNumItems() == 0) {
709 SetDParam(0, indsp->name);
710 ShowErrorMessage(STR_ERROR_CAN_T_BUILD_HERE, STR_ERROR_MUST_FOUND_TOWN_FIRST, WL_INFO, pt.x, pt.y);
711 return;
714 Backup<CompanyID> cur_company(_current_company, OWNER_NONE, FILE_LINE);
715 Backup<bool> old_generating_world(_generating_world, true, FILE_LINE);
716 _ignore_restrictions = true;
718 DoCommandP(tile, (layout_index << 8) | this->selected_type, seed,
719 CMD_BUILD_INDUSTRY | CMD_MSG(STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY), &CcBuildIndustry);
721 cur_company.Restore();
722 old_generating_world.Restore();
723 _ignore_restrictions = false;
724 } else {
725 success = DoCommandP(tile, (layout_index << 8) | this->selected_type, seed, CMD_BUILD_INDUSTRY | CMD_MSG(STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY));
728 /* If an industry has been built, just reset the cursor and the system */
729 if (success && !_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
732 void OnHundredthTick() override
734 if (_game_mode == GM_EDITOR) return;
735 const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);
737 if (indsp->enabled) {
738 bool call_back_result = GetIndustryProbabilityCallback(this->selected_type, IACT_USERCREATION, 1) > 0;
740 /* Only if result does match the previous state would it require a redraw. */
741 if (call_back_result != this->enabled[this->selected_index]) {
742 this->enabled[this->selected_index] = call_back_result;
743 this->SetButtons();
744 this->SetDirty();
749 void OnTimeout() override
751 this->RaiseButtons();
754 void OnPlaceObjectAbort() override
756 this->RaiseButtons();
760 * Some data on this window has become invalid.
761 * @param data Information about the changed data.
762 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
764 void OnInvalidateData(int data = 0, bool gui_scope = true) override
766 if (!gui_scope) return;
767 this->SetupArrays();
769 const IndustrySpec *indsp = (this->selected_type == INVALID_INDUSTRYTYPE) ? nullptr : GetIndustrySpec(this->selected_type);
770 if (indsp == nullptr) this->enabled[this->selected_index] = _settings_game.difficulty.industry_density != ID_FUND_ONLY;
771 this->SetButtons();
775 void ShowBuildIndustryWindow()
777 if (_game_mode != GM_EDITOR && !Company::IsValidID(_local_company)) return;
778 if (BringWindowToFrontById(WC_BUILD_INDUSTRY, 0)) return;
779 new BuildIndustryWindow();
782 static void UpdateIndustryProduction(Industry *i);
784 static inline bool IsProductionAlterable(const Industry *i)
786 const IndustrySpec *is = GetIndustrySpec(i->type);
787 bool has_prod = false;
788 for (size_t j = 0; j < lengthof(is->production_rate); j++) {
789 if (is->production_rate[j] != 0) {
790 has_prod = true;
791 break;
794 return ((_game_mode == GM_EDITOR || _cheats.setup_prod.value) &&
795 (has_prod || is->IsRawIndustry()) &&
796 !_networking);
799 class IndustryViewWindow : public Window
801 /** Modes for changing production */
802 enum Editability {
803 EA_NONE, ///< Not alterable
804 EA_MULTIPLIER, ///< Allow changing the production multiplier
805 EA_RATE, ///< Allow changing the production rates
808 /** Specific lines in the info panel */
809 enum InfoLine {
810 IL_NONE, ///< No line
811 IL_MULTIPLIER, ///< Production multiplier
812 IL_RATE1, ///< Production rate of cargo 1
813 IL_RATE2, ///< Production rate of cargo 2
816 Editability editable; ///< Mode for changing production
817 InfoLine editbox_line; ///< The line clicked to open the edit box
818 InfoLine clicked_line; ///< The line of the button that has been clicked
819 byte clicked_button; ///< The button that has been clicked (to raise)
820 int production_offset_y; ///< The offset of the production texts/buttons
821 int info_height; ///< Height needed for the #WID_IV_INFO panel
823 public:
824 IndustryViewWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
826 this->flags |= WF_DISABLE_VP_SCROLL;
827 this->editbox_line = IL_NONE;
828 this->clicked_line = IL_NONE;
829 this->clicked_button = 0;
830 this->info_height = WD_FRAMERECT_TOP + 2 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM + 1; // Info panel has at least two lines text.
832 this->InitNested(window_number);
833 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_IV_VIEWPORT);
834 nvp->InitializeViewport(this, Industry::Get(window_number)->location.GetCenterTile(), ZOOM_LVL_INDUSTRY);
836 this->InvalidateData();
839 void OnPaint() override
841 this->DrawWidgets();
843 if (this->IsShaded()) return; // Don't draw anything when the window is shaded.
845 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_IV_INFO);
846 uint expected = this->DrawInfo(nwi->pos_x, nwi->pos_x + nwi->current_x - 1, nwi->pos_y) - nwi->pos_y;
847 if (expected > nwi->current_y - 1) {
848 this->info_height = expected + 1;
849 this->ReInit();
850 return;
855 * Draw the text in the #WID_IV_INFO panel.
856 * @param left Left edge of the panel.
857 * @param right Right edge of the panel.
858 * @param top Top edge of the panel.
859 * @return Expected position of the bottom edge of the panel.
861 int DrawInfo(uint left, uint right, uint top)
863 Industry *i = Industry::Get(this->window_number);
864 const IndustrySpec *ind = GetIndustrySpec(i->type);
865 int y = top + WD_FRAMERECT_TOP;
866 bool first = true;
867 bool has_accept = false;
869 if (i->prod_level == PRODLEVEL_CLOSURE) {
870 DrawString(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_INDUSTRY_ANNOUNCED_CLOSURE);
871 y += 2 * FONT_HEIGHT_NORMAL;
874 CargoSuffix cargo_suffix[lengthof(i->accepts_cargo)];
875 GetAllCargoSuffixes(CARGOSUFFIX_IN, CST_VIEW, i, i->type, ind, i->accepts_cargo, cargo_suffix);
876 bool stockpiling = HasBit(ind->callback_mask, CBM_IND_PRODUCTION_CARGO_ARRIVAL) || HasBit(ind->callback_mask, CBM_IND_PRODUCTION_256_TICKS);
878 uint left_side = left + WD_FRAMERECT_LEFT * 4; // Indent accepted cargoes.
879 for (byte j = 0; j < lengthof(i->accepts_cargo); j++) {
880 if (i->accepts_cargo[j] == CT_INVALID) continue;
881 has_accept = true;
882 if (first) {
883 DrawString(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_REQUIRES);
884 y += FONT_HEIGHT_NORMAL;
885 first = false;
887 SetDParam(0, CargoSpec::Get(i->accepts_cargo[j])->name);
888 SetDParam(1, i->accepts_cargo[j]);
889 SetDParam(2, i->incoming_cargo_waiting[j]);
890 SetDParamStr(3, "");
891 StringID str = STR_NULL;
892 switch (cargo_suffix[j].display) {
893 case CSD_CARGO_AMOUNT_TEXT:
894 SetDParamStr(3, cargo_suffix[j].text);
895 FALLTHROUGH;
896 case CSD_CARGO_AMOUNT:
897 str = stockpiling ? STR_INDUSTRY_VIEW_ACCEPT_CARGO_AMOUNT : STR_INDUSTRY_VIEW_ACCEPT_CARGO;
898 break;
900 case CSD_CARGO_TEXT:
901 SetDParamStr(3, cargo_suffix[j].text);
902 FALLTHROUGH;
903 case CSD_CARGO:
904 str = STR_INDUSTRY_VIEW_ACCEPT_CARGO;
905 break;
907 default:
908 NOT_REACHED();
910 DrawString(left_side, right - WD_FRAMERECT_RIGHT, y, str);
911 y += FONT_HEIGHT_NORMAL;
914 GetAllCargoSuffixes(CARGOSUFFIX_OUT, CST_VIEW, i, i->type, ind, i->produced_cargo, cargo_suffix);
915 first = true;
916 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
917 if (i->produced_cargo[j] == CT_INVALID) continue;
918 if (first) {
919 if (has_accept) y += WD_PAR_VSEP_WIDE;
920 DrawString(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_PRODUCTION_LAST_MONTH_TITLE);
921 y += FONT_HEIGHT_NORMAL;
922 if (this->editable == EA_RATE) this->production_offset_y = y;
923 first = false;
926 SetDParam(0, i->produced_cargo[j]);
927 SetDParam(1, i->last_month_production[j]);
928 SetDParamStr(2, cargo_suffix[j].text);
929 SetDParam(3, ToPercent8(i->last_month_pct_transported[j]));
930 uint x = left + WD_FRAMETEXT_LEFT + (this->editable == EA_RATE ? SETTING_BUTTON_WIDTH + 10 : 0);
931 DrawString(x, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_TRANSPORTED);
932 /* Let's put out those buttons.. */
933 if (this->editable == EA_RATE) {
934 DrawArrowButtons(left + WD_FRAMETEXT_LEFT, y, COLOUR_YELLOW, (this->clicked_line == IL_RATE1 + j) ? this->clicked_button : 0,
935 i->production_rate[j] > 0, i->production_rate[j] < 255);
937 y += FONT_HEIGHT_NORMAL;
940 /* Display production multiplier if editable */
941 if (this->editable == EA_MULTIPLIER) {
942 y += WD_PAR_VSEP_WIDE;
943 this->production_offset_y = y;
944 SetDParam(0, RoundDivSU(i->prod_level * 100, PRODLEVEL_DEFAULT));
945 uint x = left + WD_FRAMETEXT_LEFT + SETTING_BUTTON_WIDTH + 10;
946 DrawString(x, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_PRODUCTION_LEVEL);
947 DrawArrowButtons(left + WD_FRAMETEXT_LEFT, y, COLOUR_YELLOW, (this->clicked_line == IL_MULTIPLIER) ? this->clicked_button : 0,
948 i->prod_level > PRODLEVEL_MINIMUM, i->prod_level < PRODLEVEL_MAXIMUM);
949 y += FONT_HEIGHT_NORMAL;
952 /* Get the extra message for the GUI */
953 if (HasBit(ind->callback_mask, CBM_IND_WINDOW_MORE_TEXT)) {
954 uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_WINDOW_MORE_TEXT, 0, 0, i, i->type, i->location.tile);
955 if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
956 if (callback_res > 0x400) {
957 ErrorUnknownCallbackResult(ind->grf_prop.grffile->grfid, CBID_INDUSTRY_WINDOW_MORE_TEXT, callback_res);
958 } else {
959 StringID message = GetGRFStringID(ind->grf_prop.grffile->grfid, 0xD000 + callback_res);
960 if (message != STR_NULL && message != STR_UNDEFINED) {
961 y += WD_PAR_VSEP_WIDE;
963 StartTextRefStackUsage(ind->grf_prop.grffile, 6);
964 /* Use all the available space left from where we stand up to the
965 * end of the window. We ALSO enlarge the window if needed, so we
966 * can 'go' wild with the bottom of the window. */
967 y = DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, UINT16_MAX, message, TC_BLACK);
968 StopTextRefStackUsage();
974 if (!i->text.empty()) {
975 SetDParamStr(0, i->text);
976 y += WD_PAR_VSEP_WIDE;
977 y = DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, UINT16_MAX, STR_JUST_RAW_STRING, TC_BLACK);
980 return y + WD_FRAMERECT_BOTTOM;
983 void SetStringParameters(int widget) const override
985 if (widget == WID_IV_CAPTION) SetDParam(0, this->window_number);
988 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
990 if (widget == WID_IV_INFO) size->height = this->info_height;
993 void OnClick(Point pt, int widget, int click_count) override
995 switch (widget) {
996 case WID_IV_INFO: {
997 Industry *i = Industry::Get(this->window_number);
998 InfoLine line = IL_NONE;
1000 switch (this->editable) {
1001 case EA_NONE: break;
1003 case EA_MULTIPLIER:
1004 if (IsInsideBS(pt.y, this->production_offset_y, FONT_HEIGHT_NORMAL)) line = IL_MULTIPLIER;
1005 break;
1007 case EA_RATE:
1008 if (pt.y >= this->production_offset_y) {
1009 int row = (pt.y - this->production_offset_y) / FONT_HEIGHT_NORMAL;
1010 for (uint j = 0; j < lengthof(i->produced_cargo); j++) {
1011 if (i->produced_cargo[j] == CT_INVALID) continue;
1012 row--;
1013 if (row < 0) {
1014 line = (InfoLine)(IL_RATE1 + j);
1015 break;
1019 break;
1021 if (line == IL_NONE) return;
1023 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(widget);
1024 int left = nwi->pos_x + WD_FRAMETEXT_LEFT;
1025 int right = nwi->pos_x + nwi->current_x - 1 - WD_FRAMERECT_RIGHT;
1026 if (IsInsideMM(pt.x, left, left + SETTING_BUTTON_WIDTH)) {
1027 /* Clicked buttons, decrease or increase production */
1028 byte button = (pt.x < left + SETTING_BUTTON_WIDTH / 2) ? 1 : 2;
1029 switch (this->editable) {
1030 case EA_MULTIPLIER:
1031 if (button == 1) {
1032 if (i->prod_level <= PRODLEVEL_MINIMUM) return;
1033 i->prod_level = std::max<uint>(i->prod_level / 2, PRODLEVEL_MINIMUM);
1034 } else {
1035 if (i->prod_level >= PRODLEVEL_MAXIMUM) return;
1036 i->prod_level = std::min<uint>(i->prod_level * 2, PRODLEVEL_MAXIMUM);
1038 break;
1040 case EA_RATE:
1041 if (button == 1) {
1042 if (i->production_rate[line - IL_RATE1] <= 0) return;
1043 i->production_rate[line - IL_RATE1] = std::max(i->production_rate[line - IL_RATE1] / 2, 0);
1044 } else {
1045 if (i->production_rate[line - IL_RATE1] >= 255) return;
1046 /* a zero production industry is unlikely to give anything but zero, so push it a little bit */
1047 int new_prod = i->production_rate[line - IL_RATE1] == 0 ? 1 : i->production_rate[line - IL_RATE1] * 2;
1048 i->production_rate[line - IL_RATE1] = std::min<uint>(new_prod, 255);
1050 break;
1052 default: NOT_REACHED();
1055 UpdateIndustryProduction(i);
1056 this->SetDirty();
1057 this->SetTimeout();
1058 this->clicked_line = line;
1059 this->clicked_button = button;
1060 } else if (IsInsideMM(pt.x, left + SETTING_BUTTON_WIDTH + 10, right)) {
1061 /* clicked the text */
1062 this->editbox_line = line;
1063 switch (this->editable) {
1064 case EA_MULTIPLIER:
1065 SetDParam(0, RoundDivSU(i->prod_level * 100, PRODLEVEL_DEFAULT));
1066 ShowQueryString(STR_JUST_INT, STR_CONFIG_GAME_PRODUCTION_LEVEL, 10, this, CS_ALPHANUMERAL, QSF_NONE);
1067 break;
1069 case EA_RATE:
1070 SetDParam(0, i->production_rate[line - IL_RATE1] * 8);
1071 ShowQueryString(STR_JUST_INT, STR_CONFIG_GAME_PRODUCTION, 10, this, CS_ALPHANUMERAL, QSF_NONE);
1072 break;
1074 default: NOT_REACHED();
1077 break;
1080 case WID_IV_GOTO: {
1081 Industry *i = Industry::Get(this->window_number);
1082 if (_ctrl_pressed) {
1083 ShowExtraViewportWindow(i->location.GetCenterTile());
1084 } else {
1085 ScrollMainWindowToTile(i->location.GetCenterTile());
1087 break;
1090 case WID_IV_DISPLAY: {
1091 Industry *i = Industry::Get(this->window_number);
1092 ShowIndustryCargoesWindow(i->type);
1093 break;
1098 void OnTimeout() override
1100 this->clicked_line = IL_NONE;
1101 this->clicked_button = 0;
1102 this->SetDirty();
1105 void OnResize() override
1107 if (this->viewport != nullptr) {
1108 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_IV_VIEWPORT);
1109 nvp->UpdateViewportCoordinates(this);
1111 ScrollWindowToTile(Industry::Get(this->window_number)->location.GetCenterTile(), this, true); // Re-center viewport.
1115 void OnQueryTextFinished(char *str) override
1117 if (StrEmpty(str)) return;
1119 Industry *i = Industry::Get(this->window_number);
1120 uint value = atoi(str);
1121 switch (this->editbox_line) {
1122 case IL_NONE: NOT_REACHED();
1124 case IL_MULTIPLIER:
1125 i->prod_level = ClampU(RoundDivSU(value * PRODLEVEL_DEFAULT, 100), PRODLEVEL_MINIMUM, PRODLEVEL_MAXIMUM);
1126 break;
1128 default:
1129 i->production_rate[this->editbox_line - IL_RATE1] = ClampU(RoundDivSU(value, 8), 0, 255);
1130 break;
1132 UpdateIndustryProduction(i);
1133 this->SetDirty();
1137 * Some data on this window has become invalid.
1138 * @param data Information about the changed data.
1139 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
1141 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1143 if (!gui_scope) return;
1144 const Industry *i = Industry::Get(this->window_number);
1145 if (IsProductionAlterable(i)) {
1146 const IndustrySpec *ind = GetIndustrySpec(i->type);
1147 this->editable = ind->UsesOriginalEconomy() ? EA_MULTIPLIER : EA_RATE;
1148 } else {
1149 this->editable = EA_NONE;
1153 bool IsNewGRFInspectable() const override
1155 return ::IsNewGRFInspectable(GSF_INDUSTRIES, this->window_number);
1158 void ShowNewGRFInspectWindow() const override
1160 ::ShowNewGRFInspectWindow(GSF_INDUSTRIES, this->window_number);
1164 static void UpdateIndustryProduction(Industry *i)
1166 const IndustrySpec *indspec = GetIndustrySpec(i->type);
1167 if (indspec->UsesOriginalEconomy()) i->RecomputeProductionMultipliers();
1169 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
1170 if (i->produced_cargo[j] != CT_INVALID) {
1171 i->last_month_production[j] = 8 * i->production_rate[j];
1176 /** Widget definition of the view industry gui */
1177 static const NWidgetPart _nested_industry_view_widgets[] = {
1178 NWidget(NWID_HORIZONTAL),
1179 NWidget(WWT_CLOSEBOX, COLOUR_CREAM),
1180 NWidget(WWT_CAPTION, COLOUR_CREAM, WID_IV_CAPTION), SetDataTip(STR_INDUSTRY_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1181 NWidget(WWT_PUSHIMGBTN, COLOUR_CREAM, WID_IV_GOTO), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_INDUSTRY_VIEW_LOCATION_TOOLTIP),
1182 NWidget(WWT_DEBUGBOX, COLOUR_CREAM),
1183 NWidget(WWT_SHADEBOX, COLOUR_CREAM),
1184 NWidget(WWT_DEFSIZEBOX, COLOUR_CREAM),
1185 NWidget(WWT_STICKYBOX, COLOUR_CREAM),
1186 EndContainer(),
1187 NWidget(WWT_PANEL, COLOUR_CREAM),
1188 NWidget(WWT_INSET, COLOUR_CREAM), SetPadding(2, 2, 2, 2),
1189 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_IV_VIEWPORT), SetMinimalSize(254, 86), SetFill(1, 0), SetResize(1, 1),
1190 EndContainer(),
1191 EndContainer(),
1192 NWidget(WWT_PANEL, COLOUR_CREAM, WID_IV_INFO), SetMinimalSize(260, 2), SetResize(1, 0),
1193 EndContainer(),
1194 NWidget(NWID_HORIZONTAL),
1195 NWidget(WWT_PUSHTXTBTN, COLOUR_CREAM, WID_IV_DISPLAY), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_INDUSTRY_DISPLAY_CHAIN, STR_INDUSTRY_DISPLAY_CHAIN_TOOLTIP),
1196 NWidget(WWT_RESIZEBOX, COLOUR_CREAM),
1197 EndContainer(),
1200 /** Window definition of the view industry gui */
1201 static WindowDesc _industry_view_desc(
1202 WDP_AUTO, "view_industry", 260, 120,
1203 WC_INDUSTRY_VIEW, WC_NONE,
1205 _nested_industry_view_widgets, lengthof(_nested_industry_view_widgets)
1208 void ShowIndustryViewWindow(int industry)
1210 AllocateWindowDescFront<IndustryViewWindow>(&_industry_view_desc, industry);
1213 /** Widget definition of the industry directory gui */
1214 static const NWidgetPart _nested_industry_directory_widgets[] = {
1215 NWidget(NWID_HORIZONTAL),
1216 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1217 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_INDUSTRY_DIRECTORY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1218 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1219 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1220 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1221 EndContainer(),
1222 NWidget(NWID_HORIZONTAL),
1223 NWidget(NWID_VERTICAL),
1224 NWidget(NWID_HORIZONTAL),
1225 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_ID_DROPDOWN_ORDER), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
1226 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_ID_DROPDOWN_CRITERIA), SetDataTip(STR_JUST_STRING, STR_TOOLTIP_SORT_CRITERIA),
1227 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_ID_FILTER_BY_ACC_CARGO), SetMinimalSize(225, 12), SetFill(0, 1), SetDataTip(STR_INDUSTRY_DIRECTORY_ACCEPTED_CARGO_FILTER, STR_TOOLTIP_FILTER_CRITERIA),
1228 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_ID_FILTER_BY_PROD_CARGO), SetMinimalSize(225, 12), SetFill(0, 1), SetDataTip(STR_INDUSTRY_DIRECTORY_PRODUCED_CARGO_FILTER, STR_TOOLTIP_FILTER_CRITERIA),
1229 NWidget(WWT_PANEL, COLOUR_BROWN), SetResize(1, 0), EndContainer(),
1230 EndContainer(),
1231 NWidget(WWT_PANEL, COLOUR_BROWN, WID_ID_INDUSTRY_LIST), SetDataTip(0x0, STR_INDUSTRY_DIRECTORY_LIST_CAPTION), SetResize(1, 1), SetScrollbar(WID_ID_SCROLLBAR), EndContainer(),
1232 EndContainer(),
1233 NWidget(NWID_VERTICAL),
1234 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_ID_SCROLLBAR),
1235 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1236 EndContainer(),
1237 EndContainer(),
1240 typedef GUIList<const Industry *, const std::pair<CargoID, CargoID> &> GUIIndustryList;
1242 /** Special cargo filter criteria */
1243 enum CargoFilterSpecialType {
1244 CF_ANY = CT_NO_REFIT, ///< Show all industries (i.e. no filtering)
1245 CF_NONE = CT_INVALID, ///< Show only industries which do not produce/accept cargo
1248 /** Cargo filter functions */
1250 * Check whether an industry accepts and produces a certain cargo pair.
1251 * @param industry The industry whose cargoes will being checked.
1252 * @param cargoes The accepted and produced cargo pair to look for.
1253 * @return bool Whether the given cargoes accepted and produced by the industry.
1255 static bool CDECL CargoFilter(const Industry * const *industry, const std::pair<CargoID, CargoID> &cargoes)
1257 auto accepted_cargo = cargoes.first;
1258 auto produced_cargo = cargoes.second;
1260 bool accepted_cargo_matches;
1262 switch (accepted_cargo) {
1263 case CF_ANY:
1264 accepted_cargo_matches = true;
1265 break;
1267 case CF_NONE:
1268 accepted_cargo_matches = std::all_of(std::begin((*industry)->accepts_cargo), std::end((*industry)->accepts_cargo), [](CargoID cargo) {
1269 return cargo == CT_INVALID;
1271 break;
1273 default:
1274 const auto &ac = (*industry)->accepts_cargo;
1275 accepted_cargo_matches = std::find(std::begin(ac), std::end(ac), accepted_cargo) != std::end(ac);
1276 break;
1279 bool produced_cargo_matches;
1281 switch (produced_cargo) {
1282 case CF_ANY:
1283 produced_cargo_matches = true;
1284 break;
1286 case CF_NONE:
1287 produced_cargo_matches = std::all_of(std::begin((*industry)->produced_cargo), std::end((*industry)->produced_cargo), [](CargoID cargo) {
1288 return cargo == CT_INVALID;
1290 break;
1292 default:
1293 const auto &pc = (*industry)->produced_cargo;
1294 produced_cargo_matches = std::find(std::begin(pc), std::end(pc), produced_cargo) != std::end(pc);
1295 break;
1298 return accepted_cargo_matches && produced_cargo_matches;
1301 static GUIIndustryList::FilterFunction * const _filter_funcs[] = { &CargoFilter };
1305 * The list of industries.
1307 class IndustryDirectoryWindow : public Window {
1308 protected:
1309 /* Runtime saved values */
1310 static Listing last_sorting;
1312 /* Constants for sorting industries */
1313 static const StringID sorter_names[];
1314 static GUIIndustryList::SortFunction * const sorter_funcs[];
1316 GUIIndustryList industries;
1317 Scrollbar *vscroll;
1319 CargoID cargo_filter[NUM_CARGO + 2]; ///< Available cargo filters; CargoID or CF_ANY or CF_NONE
1320 StringID cargo_filter_texts[NUM_CARGO + 3]; ///< Texts for filter_cargo, terminated by INVALID_STRING_ID
1321 byte produced_cargo_filter_criteria; ///< Selected produced cargo filter index
1322 byte accepted_cargo_filter_criteria; ///< Selected accepted cargo filter index
1323 static CargoID produced_cargo_filter;
1325 enum class SorterType : uint8 {
1326 IDW_SORT_BY_NAME, ///< Sorter type to sort by name
1327 IDW_SORT_BY_TYPE, ///< Sorter type to sort by type
1328 IDW_SORT_BY_PRODUCTION, ///< Sorter type to sort by production amount
1329 IDW_SORT_BY_TRANSPORTED, ///< Sorter type to sort by transported percentage
1333 * Set cargo filter list item index.
1334 * @param index The index of the cargo to be set
1336 void SetProducedCargoFilterIndex(byte index)
1338 if (this->produced_cargo_filter_criteria != index) {
1339 this->produced_cargo_filter_criteria = index;
1340 /* deactivate filter if criteria is 'Show All', activate it otherwise */
1341 bool is_filtering_necessary = this->cargo_filter[this->produced_cargo_filter_criteria] != CF_ANY || this->cargo_filter[this->accepted_cargo_filter_criteria] != CF_ANY;
1343 this->industries.SetFilterState(is_filtering_necessary);
1344 this->industries.SetFilterType(0);
1345 this->industries.ForceRebuild();
1350 * Set cargo filter list item index.
1351 * @param index The index of the cargo to be set
1353 void SetAcceptedCargoFilterIndex(byte index)
1355 if (this->accepted_cargo_filter_criteria != index) {
1356 this->accepted_cargo_filter_criteria = index;
1357 /* deactivate filter if criteria is 'Show All', activate it otherwise */
1358 bool is_filtering_necessary = this->cargo_filter[this->produced_cargo_filter_criteria] != CF_ANY || this->cargo_filter[this->accepted_cargo_filter_criteria] != CF_ANY;
1360 this->industries.SetFilterState(is_filtering_necessary);
1361 this->industries.SetFilterType(0);
1362 this->industries.ForceRebuild();
1367 * Populate the filter list and set the cargo filter criteria.
1369 void SetCargoFilterArray()
1371 byte filter_items = 0;
1373 /* Add item for disabling filtering. */
1374 this->cargo_filter[filter_items] = CF_ANY;
1375 this->cargo_filter_texts[filter_items] = STR_INDUSTRY_DIRECTORY_FILTER_ALL_TYPES;
1376 this->produced_cargo_filter_criteria = filter_items;
1377 this->accepted_cargo_filter_criteria = filter_items;
1378 filter_items++;
1380 /* Add item for industries not producing anything, e.g. power plants */
1381 this->cargo_filter[filter_items] = CF_NONE;
1382 this->cargo_filter_texts[filter_items] = STR_INDUSTRY_DIRECTORY_FILTER_NONE;
1383 filter_items++;
1385 /* Collect available cargo types for filtering. */
1386 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
1387 this->cargo_filter[filter_items] = cs->Index();
1388 this->cargo_filter_texts[filter_items] = cs->name;
1389 filter_items++;
1392 /* Terminate the filter list. */
1393 this->cargo_filter_texts[filter_items] = INVALID_STRING_ID;
1395 this->industries.SetFilterFuncs(_filter_funcs);
1397 bool is_filtering_necessary = this->cargo_filter[this->produced_cargo_filter_criteria] != CF_ANY || this->cargo_filter[this->accepted_cargo_filter_criteria] != CF_ANY;
1399 this->industries.SetFilterState(is_filtering_necessary);
1402 /** (Re)Build industries list */
1403 void BuildSortIndustriesList()
1405 if (this->industries.NeedRebuild()) {
1406 this->industries.clear();
1408 for (const Industry *i : Industry::Iterate()) {
1409 this->industries.push_back(i);
1412 this->industries.shrink_to_fit();
1413 this->industries.RebuildDone();
1416 auto filter = std::make_pair(this->cargo_filter[this->accepted_cargo_filter_criteria],
1417 this->cargo_filter[this->produced_cargo_filter_criteria]);
1419 this->industries.Filter(filter);
1421 IndustryDirectoryWindow::produced_cargo_filter = this->cargo_filter[this->produced_cargo_filter_criteria];
1422 this->industries.Sort();
1424 this->vscroll->SetCount((uint)this->industries.size()); // Update scrollbar as well.
1426 this->SetDirty();
1430 * Returns percents of cargo transported if industry produces this cargo, else -1
1432 * @param i industry to check
1433 * @param id cargo slot
1434 * @return percents of cargo transported, or -1 if industry doesn't use this cargo slot
1436 static inline int GetCargoTransportedPercentsIfValid(const Industry *i, uint id)
1438 assert(id < lengthof(i->produced_cargo));
1440 if (i->produced_cargo[id] == CT_INVALID) return -1;
1441 return ToPercent8(i->last_month_pct_transported[id]);
1445 * Returns value representing industry's transported cargo
1446 * percentage for industry sorting
1448 * @param i industry to check
1449 * @return value used for sorting
1451 static int GetCargoTransportedSortValue(const Industry *i)
1453 CargoID filter = IndustryDirectoryWindow::produced_cargo_filter;
1454 if (filter == CF_NONE) return 0;
1456 int percentage = 0, produced_cargo_count = 0;
1457 for (uint id = 0; id < lengthof(i->produced_cargo); id++) {
1458 if (filter == CF_ANY) {
1459 int transported = GetCargoTransportedPercentsIfValid(i, id);
1460 if (transported != -1) {
1461 produced_cargo_count++;
1462 percentage += transported;
1464 if (produced_cargo_count == 0 && id == lengthof(i->produced_cargo) - 1 && percentage == 0) {
1465 return transported;
1467 } else if (filter == i->produced_cargo[id]) {
1468 return GetCargoTransportedPercentsIfValid(i, id);
1472 if (produced_cargo_count == 0) return percentage;
1473 return percentage / produced_cargo_count;
1476 /** Sort industries by name */
1477 static bool IndustryNameSorter(const Industry * const &a, const Industry * const &b)
1479 int r = strnatcmp(a->GetCachedName(), b->GetCachedName()); // Sort by name (natural sorting).
1480 if (r == 0) return a->index < b->index;
1481 return r < 0;
1484 /** Sort industries by type and name */
1485 static bool IndustryTypeSorter(const Industry * const &a, const Industry * const &b)
1487 int it_a = 0;
1488 while (it_a != NUM_INDUSTRYTYPES && a->type != _sorted_industry_types[it_a]) it_a++;
1489 int it_b = 0;
1490 while (it_b != NUM_INDUSTRYTYPES && b->type != _sorted_industry_types[it_b]) it_b++;
1491 int r = it_a - it_b;
1492 return (r == 0) ? IndustryNameSorter(a, b) : r < 0;
1495 /** Sort industries by production and name */
1496 static bool IndustryProductionSorter(const Industry * const &a, const Industry * const &b)
1498 CargoID filter = IndustryDirectoryWindow::produced_cargo_filter;
1499 if (filter == CF_NONE) return IndustryTypeSorter(a, b);
1501 uint prod_a = 0, prod_b = 0;
1502 for (uint i = 0; i < lengthof(a->produced_cargo); i++) {
1503 if (filter == CF_ANY) {
1504 if (a->produced_cargo[i] != CT_INVALID) prod_a += a->last_month_production[i];
1505 if (b->produced_cargo[i] != CT_INVALID) prod_b += b->last_month_production[i];
1506 } else {
1507 if (a->produced_cargo[i] == filter) prod_a += a->last_month_production[i];
1508 if (b->produced_cargo[i] == filter) prod_b += b->last_month_production[i];
1511 int r = prod_a - prod_b;
1513 return (r == 0) ? IndustryTypeSorter(a, b) : r < 0;
1516 /** Sort industries by transported cargo and name */
1517 static bool IndustryTransportedCargoSorter(const Industry * const &a, const Industry * const &b)
1519 int r = GetCargoTransportedSortValue(a) - GetCargoTransportedSortValue(b);
1520 return (r == 0) ? IndustryNameSorter(a, b) : r < 0;
1524 * Get the StringID to draw and set the appropriate DParams.
1525 * @param i the industry to get the StringID of.
1526 * @return the StringID.
1528 StringID GetIndustryString(const Industry *i) const
1530 const IndustrySpec *indsp = GetIndustrySpec(i->type);
1531 byte p = 0;
1533 /* Industry name */
1534 SetDParam(p++, i->index);
1536 static CargoSuffix cargo_suffix[lengthof(i->produced_cargo)];
1537 GetAllCargoSuffixes(CARGOSUFFIX_OUT, CST_DIR, i, i->type, indsp, i->produced_cargo, cargo_suffix);
1539 /* Get industry productions (CargoID, production, suffix, transported) */
1540 struct CargoInfo {
1541 CargoID cargo_id;
1542 uint16 production;
1543 const char *suffix;
1544 uint transported;
1546 std::vector<CargoInfo> cargos;
1548 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
1549 if (i->produced_cargo[j] == CT_INVALID) continue;
1550 cargos.push_back({ i->produced_cargo[j], i->last_month_production[j], cargo_suffix[j].text, ToPercent8(i->last_month_pct_transported[j]) });
1553 switch (static_cast<IndustryDirectoryWindow::SorterType>(this->industries.SortType())) {
1554 case IndustryDirectoryWindow::SorterType::IDW_SORT_BY_NAME:
1555 case IndustryDirectoryWindow::SorterType::IDW_SORT_BY_TYPE:
1556 case IndustryDirectoryWindow::SorterType::IDW_SORT_BY_PRODUCTION:
1557 /* Sort by descending production, then descending transported */
1558 std::sort(cargos.begin(), cargos.end(), [](const CargoInfo &a, const CargoInfo &b) {
1559 if (a.production != b.production) return a.production > b.production;
1560 return a.transported > b.transported;
1562 break;
1564 case IndustryDirectoryWindow::SorterType::IDW_SORT_BY_TRANSPORTED:
1565 /* Sort by descending transported, then descending production */
1566 std::sort(cargos.begin(), cargos.end(), [](const CargoInfo &a, const CargoInfo &b) {
1567 if (a.transported != b.transported) return a.transported > b.transported;
1568 return a.production > b.production;
1570 break;
1573 /* If the produced cargo filter is active then move the filtered cargo to the beginning of the list,
1574 * because this is the one the player interested in, and that way it is not hidden in the 'n' more cargos */
1575 const CargoID cid = this->cargo_filter[this->produced_cargo_filter_criteria];
1576 if (cid != CF_ANY && cid != CF_NONE) {
1577 auto filtered_ci = std::find_if(cargos.begin(), cargos.end(), [cid](const CargoInfo &ci) -> bool {
1578 return ci.cargo_id == cid;
1580 if (filtered_ci != cargos.end()) {
1581 std::rotate(cargos.begin(), filtered_ci, filtered_ci + 1);
1585 /* Display first 3 cargos */
1586 for (size_t j = 0; j < std::min<size_t>(3, cargos.size()); j++) {
1587 CargoInfo ci = cargos[j];
1588 SetDParam(p++, STR_INDUSTRY_DIRECTORY_ITEM_INFO);
1589 SetDParam(p++, ci.cargo_id);
1590 SetDParam(p++, ci.production);
1591 SetDParamStr(p++, ci.suffix);
1592 SetDParam(p++, ci.transported);
1595 /* Undisplayed cargos if any */
1596 SetDParam(p++, cargos.size() - 3);
1598 /* Drawing the right string */
1599 switch (cargos.size()) {
1600 case 0: return STR_INDUSTRY_DIRECTORY_ITEM_NOPROD;
1601 case 1: return STR_INDUSTRY_DIRECTORY_ITEM_PROD1;
1602 case 2: return STR_INDUSTRY_DIRECTORY_ITEM_PROD2;
1603 case 3: return STR_INDUSTRY_DIRECTORY_ITEM_PROD3;
1604 default: return STR_INDUSTRY_DIRECTORY_ITEM_PRODMORE;
1608 public:
1609 IndustryDirectoryWindow(WindowDesc *desc, WindowNumber number) : Window(desc)
1611 this->CreateNestedTree();
1612 this->vscroll = this->GetScrollbar(WID_ID_SCROLLBAR);
1614 this->industries.SetListing(this->last_sorting);
1615 this->industries.SetSortFuncs(IndustryDirectoryWindow::sorter_funcs);
1616 this->industries.ForceRebuild();
1617 this->BuildSortIndustriesList();
1619 this->FinishInitNested(0);
1622 ~IndustryDirectoryWindow()
1624 this->last_sorting = this->industries.GetListing();
1627 void OnInit() override
1629 this->SetCargoFilterArray();
1632 void SetStringParameters(int widget) const override
1634 switch (widget) {
1635 case WID_ID_DROPDOWN_CRITERIA:
1636 SetDParam(0, IndustryDirectoryWindow::sorter_names[this->industries.SortType()]);
1637 break;
1639 case WID_ID_FILTER_BY_ACC_CARGO:
1640 SetDParam(0, this->cargo_filter_texts[this->accepted_cargo_filter_criteria]);
1641 break;
1643 case WID_ID_FILTER_BY_PROD_CARGO:
1644 SetDParam(0, this->cargo_filter_texts[this->produced_cargo_filter_criteria]);
1645 break;
1649 void DrawWidget(const Rect &r, int widget) const override
1651 switch (widget) {
1652 case WID_ID_DROPDOWN_ORDER:
1653 this->DrawSortButtonState(widget, this->industries.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
1654 break;
1656 case WID_ID_INDUSTRY_LIST: {
1657 int n = 0;
1658 int y = r.top + WD_FRAMERECT_TOP;
1659 if (this->industries.size() == 0) {
1660 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_DIRECTORY_NONE);
1661 break;
1663 TextColour tc;
1664 const CargoID acf_cid = this->cargo_filter[this->accepted_cargo_filter_criteria];
1665 for (uint i = this->vscroll->GetPosition(); i < this->industries.size(); i++) {
1666 tc = TC_FROMSTRING;
1667 if (acf_cid != CF_ANY && acf_cid != CF_NONE) {
1668 Industry *ind = const_cast<Industry *>(this->industries[i]);
1669 if (IndustryTemporarilyRefusesCargo(ind, acf_cid)) {
1670 tc = TC_GREY | TC_FORCED;
1673 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, this->GetIndustryString(this->industries[i]), tc);
1675 y += this->resize.step_height;
1676 if (++n == this->vscroll->GetCapacity()) break; // max number of industries in 1 window
1678 break;
1683 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1685 switch (widget) {
1686 case WID_ID_DROPDOWN_ORDER: {
1687 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
1688 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
1689 d.height += padding.height;
1690 *size = maxdim(*size, d);
1691 break;
1694 case WID_ID_DROPDOWN_CRITERIA: {
1695 Dimension d = {0, 0};
1696 for (uint i = 0; IndustryDirectoryWindow::sorter_names[i] != INVALID_STRING_ID; i++) {
1697 d = maxdim(d, GetStringBoundingBox(IndustryDirectoryWindow::sorter_names[i]));
1699 d.width += padding.width;
1700 d.height += padding.height;
1701 *size = maxdim(*size, d);
1702 break;
1705 case WID_ID_INDUSTRY_LIST: {
1706 Dimension d = GetStringBoundingBox(STR_INDUSTRY_DIRECTORY_NONE);
1707 for (uint i = 0; i < this->industries.size(); i++) {
1708 d = maxdim(d, GetStringBoundingBox(this->GetIndustryString(this->industries[i])));
1710 resize->height = d.height;
1711 d.height *= 5;
1712 d.width += padding.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
1713 d.height += padding.height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
1714 *size = maxdim(*size, d);
1715 break;
1721 void OnClick(Point pt, int widget, int click_count) override
1723 switch (widget) {
1724 case WID_ID_DROPDOWN_ORDER:
1725 this->industries.ToggleSortOrder();
1726 this->SetDirty();
1727 break;
1729 case WID_ID_DROPDOWN_CRITERIA:
1730 ShowDropDownMenu(this, IndustryDirectoryWindow::sorter_names, this->industries.SortType(), WID_ID_DROPDOWN_CRITERIA, 0, 0);
1731 break;
1733 case WID_ID_FILTER_BY_ACC_CARGO: // Cargo filter dropdown
1734 ShowDropDownMenu(this, this->cargo_filter_texts, this->accepted_cargo_filter_criteria, WID_ID_FILTER_BY_ACC_CARGO, 0, 0);
1735 break;
1737 case WID_ID_FILTER_BY_PROD_CARGO: // Cargo filter dropdown
1738 ShowDropDownMenu(this, this->cargo_filter_texts, this->produced_cargo_filter_criteria, WID_ID_FILTER_BY_PROD_CARGO, 0, 0);
1739 break;
1741 case WID_ID_INDUSTRY_LIST: {
1742 uint p = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_ID_INDUSTRY_LIST, WD_FRAMERECT_TOP);
1743 if (p < this->industries.size()) {
1744 if (_ctrl_pressed) {
1745 ShowExtraViewportWindow(this->industries[p]->location.tile);
1746 } else {
1747 ScrollMainWindowToTile(this->industries[p]->location.tile);
1750 break;
1755 void OnDropdownSelect(int widget, int index) override
1757 switch (widget) {
1758 case WID_ID_DROPDOWN_CRITERIA: {
1759 if (this->industries.SortType() != index) {
1760 this->industries.SetSortType(index);
1761 this->BuildSortIndustriesList();
1763 break;
1766 case WID_ID_FILTER_BY_ACC_CARGO: {
1767 this->SetAcceptedCargoFilterIndex(index);
1768 this->BuildSortIndustriesList();
1769 break;
1772 case WID_ID_FILTER_BY_PROD_CARGO: {
1773 this->SetProducedCargoFilterIndex(index);
1774 this->BuildSortIndustriesList();
1775 break;
1780 void OnResize() override
1782 this->vscroll->SetCapacityFromWidget(this, WID_ID_INDUSTRY_LIST);
1785 void OnPaint() override
1787 if (this->industries.NeedRebuild()) this->BuildSortIndustriesList();
1788 this->DrawWidgets();
1791 void OnHundredthTick() override
1793 this->industries.ForceResort();
1794 this->BuildSortIndustriesList();
1798 * Some data on this window has become invalid.
1799 * @param data Information about the changed data.
1800 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
1802 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1804 switch (data) {
1805 case IDIWD_FORCE_REBUILD:
1806 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
1807 this->industries.ForceRebuild();
1808 break;
1810 case IDIWD_PRODUCTION_CHANGE:
1811 if (this->industries.SortType() == 2) this->industries.ForceResort();
1812 break;
1814 default:
1815 this->industries.ForceResort();
1816 break;
1821 Listing IndustryDirectoryWindow::last_sorting = {false, 0};
1823 /* Available station sorting functions. */
1824 GUIIndustryList::SortFunction * const IndustryDirectoryWindow::sorter_funcs[] = {
1825 &IndustryNameSorter,
1826 &IndustryTypeSorter,
1827 &IndustryProductionSorter,
1828 &IndustryTransportedCargoSorter
1831 /* Names of the sorting functions */
1832 const StringID IndustryDirectoryWindow::sorter_names[] = {
1833 STR_SORT_BY_NAME,
1834 STR_SORT_BY_TYPE,
1835 STR_SORT_BY_PRODUCTION,
1836 STR_SORT_BY_TRANSPORTED,
1837 INVALID_STRING_ID
1840 CargoID IndustryDirectoryWindow::produced_cargo_filter = CF_ANY;
1843 /** Window definition of the industry directory gui */
1844 static WindowDesc _industry_directory_desc(
1845 WDP_AUTO, "list_industries", 428, 190,
1846 WC_INDUSTRY_DIRECTORY, WC_NONE,
1848 _nested_industry_directory_widgets, lengthof(_nested_industry_directory_widgets)
1851 void ShowIndustryDirectory()
1853 AllocateWindowDescFront<IndustryDirectoryWindow>(&_industry_directory_desc, 0);
1856 /** Widgets of the industry cargoes window. */
1857 static const NWidgetPart _nested_industry_cargoes_widgets[] = {
1858 NWidget(NWID_HORIZONTAL),
1859 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1860 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_IC_CAPTION), SetDataTip(STR_INDUSTRY_CARGOES_INDUSTRY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1861 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1862 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1863 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1864 EndContainer(),
1865 NWidget(NWID_HORIZONTAL),
1866 NWidget(NWID_VERTICAL),
1867 NWidget(WWT_PANEL, COLOUR_BROWN, WID_IC_PANEL), SetResize(1, 10), SetMinimalSize(200, 90), SetScrollbar(WID_IC_SCROLLBAR), EndContainer(),
1868 NWidget(NWID_HORIZONTAL),
1869 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_IC_NOTIFY),
1870 SetDataTip(STR_INDUSTRY_CARGOES_NOTIFY_SMALLMAP, STR_INDUSTRY_CARGOES_NOTIFY_SMALLMAP_TOOLTIP),
1871 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(0, 0), EndContainer(),
1872 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_IC_IND_DROPDOWN), SetFill(0, 0), SetResize(0, 0),
1873 SetDataTip(STR_INDUSTRY_CARGOES_SELECT_INDUSTRY, STR_INDUSTRY_CARGOES_SELECT_INDUSTRY_TOOLTIP),
1874 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_IC_CARGO_DROPDOWN), SetFill(0, 0), SetResize(0, 0),
1875 SetDataTip(STR_INDUSTRY_CARGOES_SELECT_CARGO, STR_INDUSTRY_CARGOES_SELECT_CARGO_TOOLTIP),
1876 EndContainer(),
1877 EndContainer(),
1878 NWidget(NWID_VERTICAL),
1879 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_IC_SCROLLBAR),
1880 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1881 EndContainer(),
1882 EndContainer(),
1885 /** Window description for the industry cargoes window. */
1886 static WindowDesc _industry_cargoes_desc(
1887 WDP_AUTO, "industry_cargoes", 300, 210,
1888 WC_INDUSTRY_CARGOES, WC_NONE,
1890 _nested_industry_cargoes_widgets, lengthof(_nested_industry_cargoes_widgets)
1893 /** Available types of field. */
1894 enum CargoesFieldType {
1895 CFT_EMPTY, ///< Empty field.
1896 CFT_SMALL_EMPTY, ///< Empty small field (for the header).
1897 CFT_INDUSTRY, ///< Display industry.
1898 CFT_CARGO, ///< Display cargo connections.
1899 CFT_CARGO_LABEL, ///< Display cargo labels.
1900 CFT_HEADER, ///< Header text.
1903 static const uint MAX_CARGOES = 16; ///< Maximum number of cargoes carried in a #CFT_CARGO field in #CargoesField.
1905 /** Data about a single field in the #IndustryCargoesWindow panel. */
1906 struct CargoesField {
1907 static const int VERT_INTER_INDUSTRY_SPACE;
1908 static const int BLOB_DISTANCE;
1910 static Dimension legend;
1911 static Dimension cargo_border;
1912 static Dimension cargo_line;
1913 static Dimension cargo_space;
1914 static Dimension cargo_stub;
1916 static const int INDUSTRY_LINE_COLOUR;
1917 static const int CARGO_LINE_COLOUR;
1919 static int small_height, normal_height;
1920 static int cargo_field_width;
1921 static int industry_width;
1922 static uint max_cargoes;
1924 CargoesFieldType type; ///< Type of field.
1925 union {
1926 struct {
1927 IndustryType ind_type; ///< Industry type (#NUM_INDUSTRYTYPES means 'houses').
1928 CargoID other_produced[MAX_CARGOES]; ///< Cargoes produced but not used in this figure.
1929 CargoID other_accepted[MAX_CARGOES]; ///< Cargoes accepted but not used in this figure.
1930 } industry; ///< Industry data (for #CFT_INDUSTRY).
1931 struct {
1932 CargoID vertical_cargoes[MAX_CARGOES]; ///< Cargoes running from top to bottom (cargo ID or #INVALID_CARGO).
1933 byte num_cargoes; ///< Number of cargoes.
1934 CargoID supp_cargoes[MAX_CARGOES]; ///< Cargoes entering from the left (index in #vertical_cargoes, or #INVALID_CARGO).
1935 byte top_end; ///< Stop at the top of the vertical cargoes.
1936 CargoID cust_cargoes[MAX_CARGOES]; ///< Cargoes leaving to the right (index in #vertical_cargoes, or #INVALID_CARGO).
1937 byte bottom_end; ///< Stop at the bottom of the vertical cargoes.
1938 } cargo; ///< Cargo data (for #CFT_CARGO).
1939 struct {
1940 CargoID cargoes[MAX_CARGOES]; ///< Cargoes to display (or #INVALID_CARGO).
1941 bool left_align; ///< Align all cargo texts to the left (else align to the right).
1942 } cargo_label; ///< Label data (for #CFT_CARGO_LABEL).
1943 StringID header; ///< Header text (for #CFT_HEADER).
1944 } u; // Data for each type.
1947 * Make one of the empty fields (#CFT_EMPTY or #CFT_SMALL_EMPTY).
1948 * @param type Type of empty field.
1950 void MakeEmpty(CargoesFieldType type)
1952 this->type = type;
1956 * Make an industry type field.
1957 * @param ind_type Industry type (#NUM_INDUSTRYTYPES means 'houses').
1958 * @note #other_accepted and #other_produced should be filled later.
1960 void MakeIndustry(IndustryType ind_type)
1962 this->type = CFT_INDUSTRY;
1963 this->u.industry.ind_type = ind_type;
1964 MemSetT(this->u.industry.other_accepted, INVALID_CARGO, MAX_CARGOES);
1965 MemSetT(this->u.industry.other_produced, INVALID_CARGO, MAX_CARGOES);
1969 * Connect a cargo from an industry to the #CFT_CARGO column.
1970 * @param cargo Cargo to connect.
1971 * @param producer Cargo is produced (if \c false, cargo is assumed to be accepted).
1972 * @return Horizontal connection index, or \c -1 if not accepted at all.
1974 int ConnectCargo(CargoID cargo, bool producer)
1976 assert(this->type == CFT_CARGO);
1977 if (cargo == INVALID_CARGO) return -1;
1979 /* Find the vertical cargo column carrying the cargo. */
1980 int column = -1;
1981 for (int i = 0; i < this->u.cargo.num_cargoes; i++) {
1982 if (cargo == this->u.cargo.vertical_cargoes[i]) {
1983 column = i;
1984 break;
1987 if (column < 0) return -1;
1989 if (producer) {
1990 assert(this->u.cargo.supp_cargoes[column] == INVALID_CARGO);
1991 this->u.cargo.supp_cargoes[column] = column;
1992 } else {
1993 assert(this->u.cargo.cust_cargoes[column] == INVALID_CARGO);
1994 this->u.cargo.cust_cargoes[column] = column;
1996 return column;
2000 * Does this #CFT_CARGO field have a horizontal connection?
2001 * @return \c true if a horizontal connection exists, \c false otherwise.
2003 bool HasConnection()
2005 assert(this->type == CFT_CARGO);
2007 for (uint i = 0; i < MAX_CARGOES; i++) {
2008 if (this->u.cargo.supp_cargoes[i] != INVALID_CARGO) return true;
2009 if (this->u.cargo.cust_cargoes[i] != INVALID_CARGO) return true;
2011 return false;
2015 * Make a piece of cargo column.
2016 * @param cargoes Array of #CargoID (may contain #INVALID_CARGO).
2017 * @param length Number of cargoes in \a cargoes.
2018 * @param count Number of cargoes to display (should be at least the number of valid cargoes, or \c -1 to let the method compute it).
2019 * @param top_end This is the first cargo field of this column.
2020 * @param bottom_end This is the last cargo field of this column.
2021 * @note #supp_cargoes and #cust_cargoes should be filled in later.
2023 void MakeCargo(const CargoID *cargoes, uint length, int count = -1, bool top_end = false, bool bottom_end = false)
2025 this->type = CFT_CARGO;
2026 uint i;
2027 uint num = 0;
2028 for (i = 0; i < MAX_CARGOES && i < length; i++) {
2029 if (cargoes[i] != INVALID_CARGO) {
2030 this->u.cargo.vertical_cargoes[num] = cargoes[i];
2031 num++;
2034 this->u.cargo.num_cargoes = (count < 0) ? num : count;
2035 for (; num < MAX_CARGOES; num++) this->u.cargo.vertical_cargoes[num] = INVALID_CARGO;
2036 this->u.cargo.top_end = top_end;
2037 this->u.cargo.bottom_end = bottom_end;
2038 MemSetT(this->u.cargo.supp_cargoes, INVALID_CARGO, MAX_CARGOES);
2039 MemSetT(this->u.cargo.cust_cargoes, INVALID_CARGO, MAX_CARGOES);
2043 * Make a field displaying cargo type names.
2044 * @param cargoes Array of #CargoID (may contain #INVALID_CARGO).
2045 * @param length Number of cargoes in \a cargoes.
2046 * @param left_align ALign texts to the left (else to the right).
2048 void MakeCargoLabel(const CargoID *cargoes, uint length, bool left_align)
2050 this->type = CFT_CARGO_LABEL;
2051 uint i;
2052 for (i = 0; i < MAX_CARGOES && i < length; i++) this->u.cargo_label.cargoes[i] = cargoes[i];
2053 for (; i < MAX_CARGOES; i++) this->u.cargo_label.cargoes[i] = INVALID_CARGO;
2054 this->u.cargo_label.left_align = left_align;
2058 * Make a header above an industry column.
2059 * @param textid Text to display.
2061 void MakeHeader(StringID textid)
2063 this->type = CFT_HEADER;
2064 this->u.header = textid;
2068 * For a #CFT_CARGO, compute the left position of the left-most vertical cargo connection.
2069 * @param xpos Left position of the field.
2070 * @return Left position of the left-most vertical cargo column.
2072 int GetCargoBase(int xpos) const
2074 assert(this->type == CFT_CARGO);
2075 int n = this->u.cargo.num_cargoes;
2077 return xpos + cargo_field_width / 2 - (CargoesField::cargo_line.width * n + CargoesField::cargo_space.width * (n - 1)) / 2;
2081 * Draw the field.
2082 * @param xpos Position of the left edge.
2083 * @param ypos Position of the top edge.
2085 void Draw(int xpos, int ypos) const
2087 switch (this->type) {
2088 case CFT_EMPTY:
2089 case CFT_SMALL_EMPTY:
2090 break;
2092 case CFT_HEADER:
2093 ypos += (small_height - FONT_HEIGHT_NORMAL) / 2;
2094 DrawString(xpos, xpos + industry_width, ypos, this->u.header, TC_WHITE, SA_HOR_CENTER);
2095 break;
2097 case CFT_INDUSTRY: {
2098 int ypos1 = ypos + VERT_INTER_INDUSTRY_SPACE / 2;
2099 int ypos2 = ypos + normal_height - 1 - VERT_INTER_INDUSTRY_SPACE / 2;
2100 int xpos2 = xpos + industry_width - 1;
2101 GfxDrawLine(xpos, ypos1, xpos2, ypos1, INDUSTRY_LINE_COLOUR);
2102 GfxDrawLine(xpos, ypos1, xpos, ypos2, INDUSTRY_LINE_COLOUR);
2103 GfxDrawLine(xpos, ypos2, xpos2, ypos2, INDUSTRY_LINE_COLOUR);
2104 GfxDrawLine(xpos2, ypos1, xpos2, ypos2, INDUSTRY_LINE_COLOUR);
2105 ypos += (normal_height - FONT_HEIGHT_NORMAL) / 2;
2106 if (this->u.industry.ind_type < NUM_INDUSTRYTYPES) {
2107 const IndustrySpec *indsp = GetIndustrySpec(this->u.industry.ind_type);
2108 DrawString(xpos, xpos2, ypos, indsp->name, TC_WHITE, SA_HOR_CENTER);
2110 /* Draw the industry legend. */
2111 int blob_left, blob_right;
2112 if (_current_text_dir == TD_RTL) {
2113 blob_right = xpos2 - BLOB_DISTANCE;
2114 blob_left = blob_right - CargoesField::legend.width;
2115 } else {
2116 blob_left = xpos + BLOB_DISTANCE;
2117 blob_right = blob_left + CargoesField::legend.width;
2119 GfxFillRect(blob_left, ypos2 - BLOB_DISTANCE - CargoesField::legend.height, blob_right, ypos2 - BLOB_DISTANCE, PC_BLACK); // Border
2120 GfxFillRect(blob_left + 1, ypos2 - BLOB_DISTANCE - CargoesField::legend.height + 1, blob_right - 1, ypos2 - BLOB_DISTANCE - 1, indsp->map_colour);
2121 } else {
2122 DrawString(xpos, xpos2, ypos, STR_INDUSTRY_CARGOES_HOUSES, TC_FROMSTRING, SA_HOR_CENTER);
2125 /* Draw the other_produced/other_accepted cargoes. */
2126 const CargoID *other_right, *other_left;
2127 if (_current_text_dir == TD_RTL) {
2128 other_right = this->u.industry.other_accepted;
2129 other_left = this->u.industry.other_produced;
2130 } else {
2131 other_right = this->u.industry.other_produced;
2132 other_left = this->u.industry.other_accepted;
2134 ypos1 += CargoesField::cargo_border.height + (FONT_HEIGHT_NORMAL - CargoesField::cargo_line.height) / 2;
2135 for (uint i = 0; i < CargoesField::max_cargoes; i++) {
2136 if (other_right[i] != INVALID_CARGO) {
2137 const CargoSpec *csp = CargoSpec::Get(other_right[i]);
2138 int xp = xpos + industry_width + CargoesField::cargo_stub.width;
2139 DrawHorConnection(xpos + industry_width, xp - 1, ypos1, csp);
2140 GfxDrawLine(xp, ypos1, xp, ypos1 + CargoesField::cargo_line.height - 1, CARGO_LINE_COLOUR);
2142 if (other_left[i] != INVALID_CARGO) {
2143 const CargoSpec *csp = CargoSpec::Get(other_left[i]);
2144 int xp = xpos - CargoesField::cargo_stub.width;
2145 DrawHorConnection(xp + 1, xpos - 1, ypos1, csp);
2146 GfxDrawLine(xp, ypos1, xp, ypos1 + CargoesField::cargo_line.height - 1, CARGO_LINE_COLOUR);
2148 ypos1 += FONT_HEIGHT_NORMAL + CargoesField::cargo_space.height;
2150 break;
2153 case CFT_CARGO: {
2154 int cargo_base = this->GetCargoBase(xpos);
2155 int top = ypos + (this->u.cargo.top_end ? VERT_INTER_INDUSTRY_SPACE / 2 + 1 : 0);
2156 int bot = ypos - (this->u.cargo.bottom_end ? VERT_INTER_INDUSTRY_SPACE / 2 + 1 : 0) + normal_height - 1;
2157 int colpos = cargo_base;
2158 for (int i = 0; i < this->u.cargo.num_cargoes; i++) {
2159 if (this->u.cargo.top_end) GfxDrawLine(colpos, top - 1, colpos + CargoesField::cargo_line.width - 1, top - 1, CARGO_LINE_COLOUR);
2160 if (this->u.cargo.bottom_end) GfxDrawLine(colpos, bot + 1, colpos + CargoesField::cargo_line.width - 1, bot + 1, CARGO_LINE_COLOUR);
2161 GfxDrawLine(colpos, top, colpos, bot, CARGO_LINE_COLOUR);
2162 colpos++;
2163 const CargoSpec *csp = CargoSpec::Get(this->u.cargo.vertical_cargoes[i]);
2164 GfxFillRect(colpos, top, colpos + CargoesField::cargo_line.width - 2, bot, csp->legend_colour, FILLRECT_OPAQUE);
2165 colpos += CargoesField::cargo_line.width - 2;
2166 GfxDrawLine(colpos, top, colpos, bot, CARGO_LINE_COLOUR);
2167 colpos += 1 + CargoesField::cargo_space.width;
2170 const CargoID *hor_left, *hor_right;
2171 if (_current_text_dir == TD_RTL) {
2172 hor_left = this->u.cargo.cust_cargoes;
2173 hor_right = this->u.cargo.supp_cargoes;
2174 } else {
2175 hor_left = this->u.cargo.supp_cargoes;
2176 hor_right = this->u.cargo.cust_cargoes;
2178 ypos += CargoesField::cargo_border.height + VERT_INTER_INDUSTRY_SPACE / 2 + (FONT_HEIGHT_NORMAL - CargoesField::cargo_line.height) / 2;
2179 for (uint i = 0; i < MAX_CARGOES; i++) {
2180 if (hor_left[i] != INVALID_CARGO) {
2181 int col = hor_left[i];
2182 int dx = 0;
2183 const CargoSpec *csp = CargoSpec::Get(this->u.cargo.vertical_cargoes[col]);
2184 for (; col > 0; col--) {
2185 int lf = cargo_base + col * CargoesField::cargo_line.width + (col - 1) * CargoesField::cargo_space.width;
2186 DrawHorConnection(lf, lf + CargoesField::cargo_space.width - dx, ypos, csp);
2187 dx = 1;
2189 DrawHorConnection(xpos, cargo_base - dx, ypos, csp);
2191 if (hor_right[i] != INVALID_CARGO) {
2192 int col = hor_right[i];
2193 int dx = 0;
2194 const CargoSpec *csp = CargoSpec::Get(this->u.cargo.vertical_cargoes[col]);
2195 for (; col < this->u.cargo.num_cargoes - 1; col++) {
2196 int lf = cargo_base + (col + 1) * CargoesField::cargo_line.width + col * CargoesField::cargo_space.width;
2197 DrawHorConnection(lf + dx - 1, lf + CargoesField::cargo_space.width - 1, ypos, csp);
2198 dx = 1;
2200 DrawHorConnection(cargo_base + col * CargoesField::cargo_space.width + (col + 1) * CargoesField::cargo_line.width - 1 + dx, xpos + CargoesField::cargo_field_width - 1, ypos, csp);
2202 ypos += FONT_HEIGHT_NORMAL + CargoesField::cargo_space.height;
2204 break;
2207 case CFT_CARGO_LABEL:
2208 ypos += CargoesField::cargo_border.height + VERT_INTER_INDUSTRY_SPACE / 2;
2209 for (uint i = 0; i < MAX_CARGOES; i++) {
2210 if (this->u.cargo_label.cargoes[i] != INVALID_CARGO) {
2211 const CargoSpec *csp = CargoSpec::Get(this->u.cargo_label.cargoes[i]);
2212 DrawString(xpos + WD_FRAMERECT_LEFT, xpos + industry_width - 1 - WD_FRAMERECT_RIGHT, ypos, csp->name, TC_WHITE,
2213 (this->u.cargo_label.left_align) ? SA_LEFT : SA_RIGHT);
2215 ypos += FONT_HEIGHT_NORMAL + CargoesField::cargo_space.height;
2217 break;
2219 default:
2220 NOT_REACHED();
2225 * Decide which cargo was clicked at in a #CFT_CARGO field.
2226 * @param left Left industry neighbour if available (else \c nullptr should be supplied).
2227 * @param right Right industry neighbour if available (else \c nullptr should be supplied).
2228 * @param pt Click position in the cargo field.
2229 * @return Cargo clicked at, or #INVALID_CARGO if none.
2231 CargoID CargoClickedAt(const CargoesField *left, const CargoesField *right, Point pt) const
2233 assert(this->type == CFT_CARGO);
2235 /* Vertical matching. */
2236 int cpos = this->GetCargoBase(0);
2237 uint col;
2238 for (col = 0; col < this->u.cargo.num_cargoes; col++) {
2239 if (pt.x < cpos) break;
2240 if (pt.x < cpos + (int)CargoesField::cargo_line.width) return this->u.cargo.vertical_cargoes[col];
2241 cpos += CargoesField::cargo_line.width + CargoesField::cargo_space.width;
2243 /* col = 0 -> left of first col, 1 -> left of 2nd col, ... this->u.cargo.num_cargoes right of last-col. */
2245 int vpos = VERT_INTER_INDUSTRY_SPACE / 2 + CargoesField::cargo_border.width;
2246 uint row;
2247 for (row = 0; row < MAX_CARGOES; row++) {
2248 if (pt.y < vpos) return INVALID_CARGO;
2249 if (pt.y < vpos + FONT_HEIGHT_NORMAL) break;
2250 vpos += FONT_HEIGHT_NORMAL + CargoesField::cargo_space.width;
2252 if (row == MAX_CARGOES) return INVALID_CARGO;
2254 /* row = 0 -> at first horizontal row, row = 1 -> second horizontal row, 2 = 3rd horizontal row. */
2255 if (col == 0) {
2256 if (this->u.cargo.supp_cargoes[row] != INVALID_CARGO) return this->u.cargo.vertical_cargoes[this->u.cargo.supp_cargoes[row]];
2257 if (left != nullptr) {
2258 if (left->type == CFT_INDUSTRY) return left->u.industry.other_produced[row];
2259 if (left->type == CFT_CARGO_LABEL && !left->u.cargo_label.left_align) return left->u.cargo_label.cargoes[row];
2261 return INVALID_CARGO;
2263 if (col == this->u.cargo.num_cargoes) {
2264 if (this->u.cargo.cust_cargoes[row] != INVALID_CARGO) return this->u.cargo.vertical_cargoes[this->u.cargo.cust_cargoes[row]];
2265 if (right != nullptr) {
2266 if (right->type == CFT_INDUSTRY) return right->u.industry.other_accepted[row];
2267 if (right->type == CFT_CARGO_LABEL && right->u.cargo_label.left_align) return right->u.cargo_label.cargoes[row];
2269 return INVALID_CARGO;
2271 if (row >= col) {
2272 /* Clicked somewhere in-between vertical cargo connection.
2273 * Since the horizontal connection is made in the same order as the vertical list, the above condition
2274 * ensures we are left-below the main diagonal, thus at the supplying side.
2276 return (this->u.cargo.supp_cargoes[row] != INVALID_CARGO) ? this->u.cargo.vertical_cargoes[this->u.cargo.supp_cargoes[row]] : INVALID_CARGO;
2277 } else {
2278 /* Clicked at a customer connection. */
2279 return (this->u.cargo.cust_cargoes[row] != INVALID_CARGO) ? this->u.cargo.vertical_cargoes[this->u.cargo.cust_cargoes[row]] : INVALID_CARGO;
2284 * Decide what cargo the user clicked in the cargo label field.
2285 * @param pt Click position in the cargo label field.
2286 * @return Cargo clicked at, or #INVALID_CARGO if none.
2288 CargoID CargoLabelClickedAt(Point pt) const
2290 assert(this->type == CFT_CARGO_LABEL);
2292 int vpos = VERT_INTER_INDUSTRY_SPACE / 2 + CargoesField::cargo_border.height;
2293 uint row;
2294 for (row = 0; row < MAX_CARGOES; row++) {
2295 if (pt.y < vpos) return INVALID_CARGO;
2296 if (pt.y < vpos + FONT_HEIGHT_NORMAL) break;
2297 vpos += FONT_HEIGHT_NORMAL + CargoesField::cargo_space.height;
2299 if (row == MAX_CARGOES) return INVALID_CARGO;
2300 return this->u.cargo_label.cargoes[row];
2303 private:
2305 * Draw a horizontal cargo connection.
2306 * @param left Left-most coordinate to draw.
2307 * @param right Right-most coordinate to draw.
2308 * @param top Top coordinate of the cargo connection.
2309 * @param csp Cargo to draw.
2311 static void DrawHorConnection(int left, int right, int top, const CargoSpec *csp)
2313 GfxDrawLine(left, top, right, top, CARGO_LINE_COLOUR);
2314 GfxFillRect(left, top + 1, right, top + CargoesField::cargo_line.height - 2, csp->legend_colour, FILLRECT_OPAQUE);
2315 GfxDrawLine(left, top + CargoesField::cargo_line.height - 1, right, top + CargoesField::cargo_line.height - 1, CARGO_LINE_COLOUR);
2319 static_assert(MAX_CARGOES >= cpp_lengthof(IndustrySpec, produced_cargo));
2320 static_assert(MAX_CARGOES >= cpp_lengthof(IndustrySpec, accepts_cargo));
2322 Dimension CargoesField::legend; ///< Dimension of the legend blob.
2323 Dimension CargoesField::cargo_border; ///< Dimensions of border between cargo lines and industry boxes.
2324 Dimension CargoesField::cargo_line; ///< Dimensions of cargo lines.
2325 Dimension CargoesField::cargo_space; ///< Dimensions of space between cargo lines.
2326 Dimension CargoesField::cargo_stub; ///< Dimensions of cargo stub (unconnected cargo line.)
2328 int CargoesField::small_height; ///< Height of the header row.
2329 int CargoesField::normal_height; ///< Height of the non-header rows.
2330 int CargoesField::industry_width; ///< Width of an industry field.
2331 int CargoesField::cargo_field_width; ///< Width of a cargo field.
2332 uint CargoesField::max_cargoes; ///< Largest number of cargoes actually on any industry.
2333 const int CargoesField::VERT_INTER_INDUSTRY_SPACE = 6; ///< Amount of space between two industries in a column.
2335 const int CargoesField::BLOB_DISTANCE = 5; ///< Distance of the industry legend colour from the edge of the industry box.
2337 const int CargoesField::INDUSTRY_LINE_COLOUR = PC_YELLOW; ///< Line colour of the industry type box.
2338 const int CargoesField::CARGO_LINE_COLOUR = PC_YELLOW; ///< Line colour around the cargo.
2340 /** A single row of #CargoesField. */
2341 struct CargoesRow {
2342 CargoesField columns[5]; ///< One row of fields.
2345 * Connect industry production cargoes to the cargo column after it.
2346 * @param column Column of the industry.
2348 void ConnectIndustryProduced(int column)
2350 CargoesField *ind_fld = this->columns + column;
2351 CargoesField *cargo_fld = this->columns + column + 1;
2352 assert(ind_fld->type == CFT_INDUSTRY && cargo_fld->type == CFT_CARGO);
2354 MemSetT(ind_fld->u.industry.other_produced, INVALID_CARGO, MAX_CARGOES);
2356 if (ind_fld->u.industry.ind_type < NUM_INDUSTRYTYPES) {
2357 CargoID others[MAX_CARGOES]; // Produced cargoes not carried in the cargo column.
2358 int other_count = 0;
2360 const IndustrySpec *indsp = GetIndustrySpec(ind_fld->u.industry.ind_type);
2361 assert(CargoesField::max_cargoes <= lengthof(indsp->produced_cargo));
2362 for (uint i = 0; i < CargoesField::max_cargoes; i++) {
2363 int col = cargo_fld->ConnectCargo(indsp->produced_cargo[i], true);
2364 if (col < 0) others[other_count++] = indsp->produced_cargo[i];
2367 /* Allocate other cargoes in the empty holes of the horizontal cargo connections. */
2368 for (uint i = 0; i < CargoesField::max_cargoes && other_count > 0; i++) {
2369 if (cargo_fld->u.cargo.supp_cargoes[i] == INVALID_CARGO) ind_fld->u.industry.other_produced[i] = others[--other_count];
2371 } else {
2372 /* Houses only display what is demanded. */
2373 for (uint i = 0; i < cargo_fld->u.cargo.num_cargoes; i++) {
2374 CargoID cid = cargo_fld->u.cargo.vertical_cargoes[i];
2375 if (cid == CT_PASSENGERS || cid == CT_MAIL) cargo_fld->ConnectCargo(cid, true);
2381 * Construct a #CFT_CARGO_LABEL field.
2382 * @param column Column to create the new field.
2383 * @param accepting Display accepted cargo (if \c false, display produced cargo).
2385 void MakeCargoLabel(int column, bool accepting)
2387 CargoID cargoes[MAX_CARGOES];
2388 MemSetT(cargoes, INVALID_CARGO, lengthof(cargoes));
2390 CargoesField *label_fld = this->columns + column;
2391 CargoesField *cargo_fld = this->columns + (accepting ? column - 1 : column + 1);
2393 assert(cargo_fld->type == CFT_CARGO && label_fld->type == CFT_EMPTY);
2394 for (uint i = 0; i < cargo_fld->u.cargo.num_cargoes; i++) {
2395 int col = cargo_fld->ConnectCargo(cargo_fld->u.cargo.vertical_cargoes[i], !accepting);
2396 if (col >= 0) cargoes[col] = cargo_fld->u.cargo.vertical_cargoes[i];
2398 label_fld->MakeCargoLabel(cargoes, lengthof(cargoes), accepting);
2403 * Connect industry accepted cargoes to the cargo column before it.
2404 * @param column Column of the industry.
2406 void ConnectIndustryAccepted(int column)
2408 CargoesField *ind_fld = this->columns + column;
2409 CargoesField *cargo_fld = this->columns + column - 1;
2410 assert(ind_fld->type == CFT_INDUSTRY && cargo_fld->type == CFT_CARGO);
2412 MemSetT(ind_fld->u.industry.other_accepted, INVALID_CARGO, MAX_CARGOES);
2414 if (ind_fld->u.industry.ind_type < NUM_INDUSTRYTYPES) {
2415 CargoID others[MAX_CARGOES]; // Accepted cargoes not carried in the cargo column.
2416 int other_count = 0;
2418 const IndustrySpec *indsp = GetIndustrySpec(ind_fld->u.industry.ind_type);
2419 assert(CargoesField::max_cargoes <= lengthof(indsp->accepts_cargo));
2420 for (uint i = 0; i < CargoesField::max_cargoes; i++) {
2421 int col = cargo_fld->ConnectCargo(indsp->accepts_cargo[i], false);
2422 if (col < 0) others[other_count++] = indsp->accepts_cargo[i];
2425 /* Allocate other cargoes in the empty holes of the horizontal cargo connections. */
2426 for (uint i = 0; i < CargoesField::max_cargoes && other_count > 0; i++) {
2427 if (cargo_fld->u.cargo.cust_cargoes[i] == INVALID_CARGO) ind_fld->u.industry.other_accepted[i] = others[--other_count];
2429 } else {
2430 /* Houses only display what is demanded. */
2431 for (uint i = 0; i < cargo_fld->u.cargo.num_cargoes; i++) {
2432 for (uint h = 0; h < NUM_HOUSES; h++) {
2433 HouseSpec *hs = HouseSpec::Get(h);
2434 if (!hs->enabled) continue;
2436 for (uint j = 0; j < lengthof(hs->accepts_cargo); j++) {
2437 if (hs->cargo_acceptance[j] > 0 && cargo_fld->u.cargo.vertical_cargoes[i] == hs->accepts_cargo[j]) {
2438 cargo_fld->ConnectCargo(cargo_fld->u.cargo.vertical_cargoes[i], false);
2439 goto next_cargo;
2443 next_cargo: ;
2451 * Window displaying the cargo connections around an industry (or cargo).
2453 * The main display is constructed from 'fields', rectangles that contain an industry, piece of the cargo connection, cargo labels, or headers.
2454 * For a nice display, the following should be kept in mind:
2455 * - A #CFT_HEADER is always at the top of an column of #CFT_INDUSTRY fields.
2456 * - A #CFT_CARGO_LABEL field is also always put in a column of #CFT_INDUSTRY fields.
2457 * - The top row contains #CFT_HEADER and #CFT_SMALL_EMPTY fields.
2458 * - Cargo connections have a column of their own (#CFT_CARGO fields).
2459 * - Cargo accepted or produced by an industry, but not carried in a cargo connection, is drawn in the space of a cargo column attached to the industry.
2460 * The information however is part of the industry.
2462 * This results in the following invariants:
2463 * - Width of a #CFT_INDUSTRY column is large enough to hold all industry type labels, all cargo labels, and all header texts.
2464 * - Height of a #CFT_INDUSTRY is large enough to hold a header line, or a industry type line, \c N cargo labels
2465 * (where \c N is the maximum number of cargoes connected between industries), \c N connections of cargo types, and space
2466 * between two industry types (1/2 above it, and 1/2 underneath it).
2467 * - Width of a cargo field (#CFT_CARGO) is large enough to hold \c N vertical columns (one for each type of cargo).
2468 * Also, space is needed between an industry and the leftmost/rightmost column to draw the non-carried cargoes.
2469 * - Height of a #CFT_CARGO field is equally high as the height of the #CFT_INDUSTRY.
2470 * - A field at the top (#CFT_HEADER or #CFT_SMALL_EMPTY) match the width of the fields below them (#CFT_INDUSTRY respectively
2471 * #CFT_CARGO), the height should be sufficient to display the header text.
2473 * When displaying the cargoes around an industry type, five columns are needed (supplying industries, accepted cargoes, the industry,
2474 * produced cargoes, customer industries). Displaying the industries around a cargo needs three columns (supplying industries, the cargo,
2475 * customer industries). The remaining two columns are set to #CFT_EMPTY with a width equal to the average of a cargo and an industry column.
2477 struct IndustryCargoesWindow : public Window {
2478 static const int HOR_TEXT_PADDING, VERT_TEXT_PADDING;
2480 typedef std::vector<CargoesRow> Fields;
2482 Fields fields; ///< Fields to display in the #WID_IC_PANEL.
2483 uint ind_cargo; ///< If less than #NUM_INDUSTRYTYPES, an industry type, else a cargo id + NUM_INDUSTRYTYPES.
2484 Dimension cargo_textsize; ///< Size to hold any cargo text, as well as STR_INDUSTRY_CARGOES_SELECT_CARGO.
2485 Dimension ind_textsize; ///< Size to hold any industry type text, as well as STR_INDUSTRY_CARGOES_SELECT_INDUSTRY.
2486 Scrollbar *vscroll;
2488 IndustryCargoesWindow(int id) : Window(&_industry_cargoes_desc)
2490 this->OnInit();
2491 this->CreateNestedTree();
2492 this->vscroll = this->GetScrollbar(WID_IC_SCROLLBAR);
2493 this->FinishInitNested(0);
2494 this->OnInvalidateData(id);
2497 void OnInit() override
2499 /* Initialize static CargoesField size variables. */
2500 Dimension d = GetStringBoundingBox(STR_INDUSTRY_CARGOES_PRODUCERS);
2501 d = maxdim(d, GetStringBoundingBox(STR_INDUSTRY_CARGOES_CUSTOMERS));
2502 d.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
2503 d.height += WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM;
2504 CargoesField::small_height = d.height;
2506 /* Size of the legend blob -- slightly larger than the smallmap legend blob. */
2507 CargoesField::legend.height = FONT_HEIGHT_SMALL;
2508 CargoesField::legend.width = CargoesField::legend.height * 8 / 5;
2510 /* Size of cargo lines. */
2511 CargoesField::cargo_line.width = FONT_HEIGHT_NORMAL;
2512 CargoesField::cargo_line.height = CargoesField::cargo_line.width;
2514 /* Size of border between cargo lines and industry boxes. */
2515 CargoesField::cargo_border.width = CargoesField::cargo_line.width * 3 / 2;
2516 CargoesField::cargo_border.height = CargoesField::cargo_line.width / 2;
2518 /* Size of space between cargo lines. */
2519 CargoesField::cargo_space.width = CargoesField::cargo_line.width / 2;
2520 CargoesField::cargo_space.height = CargoesField::cargo_line.height / 2;
2522 /* Size of cargo stub (unconnected cargo line.) */
2523 CargoesField::cargo_stub.width = CargoesField::cargo_line.width / 2;
2524 CargoesField::cargo_stub.height = CargoesField::cargo_line.height; /* Unused */
2526 /* Decide about the size of the box holding the text of an industry type. */
2527 this->ind_textsize.width = 0;
2528 this->ind_textsize.height = 0;
2529 CargoesField::max_cargoes = 0;
2530 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2531 const IndustrySpec *indsp = GetIndustrySpec(it);
2532 if (!indsp->enabled) continue;
2533 this->ind_textsize = maxdim(this->ind_textsize, GetStringBoundingBox(indsp->name));
2534 CargoesField::max_cargoes = std::max<uint>(CargoesField::max_cargoes, std::count_if(indsp->accepts_cargo, endof(indsp->accepts_cargo), IsCargoIDValid));
2535 CargoesField::max_cargoes = std::max<uint>(CargoesField::max_cargoes, std::count_if(indsp->produced_cargo, endof(indsp->produced_cargo), IsCargoIDValid));
2537 d.width = std::max(d.width, this->ind_textsize.width);
2538 d.height = this->ind_textsize.height;
2539 this->ind_textsize = maxdim(this->ind_textsize, GetStringBoundingBox(STR_INDUSTRY_CARGOES_SELECT_INDUSTRY));
2541 /* Compute max size of the cargo texts. */
2542 this->cargo_textsize.width = 0;
2543 this->cargo_textsize.height = 0;
2544 for (uint i = 0; i < NUM_CARGO; i++) {
2545 const CargoSpec *csp = CargoSpec::Get(i);
2546 if (!csp->IsValid()) continue;
2547 this->cargo_textsize = maxdim(this->cargo_textsize, GetStringBoundingBox(csp->name));
2549 d = maxdim(d, this->cargo_textsize); // Box must also be wide enough to hold any cargo label.
2550 this->cargo_textsize = maxdim(this->cargo_textsize, GetStringBoundingBox(STR_INDUSTRY_CARGOES_SELECT_CARGO));
2552 d.width += 2 * HOR_TEXT_PADDING;
2553 /* Ensure the height is enough for the industry type text, for the horizontal connections, and for the cargo labels. */
2554 uint min_ind_height = CargoesField::cargo_border.height * 2 + CargoesField::max_cargoes * FONT_HEIGHT_NORMAL + (CargoesField::max_cargoes - 1) * CargoesField::cargo_space.height;
2555 d.height = std::max(d.height + 2 * VERT_TEXT_PADDING, min_ind_height);
2557 CargoesField::industry_width = d.width;
2558 CargoesField::normal_height = d.height + CargoesField::VERT_INTER_INDUSTRY_SPACE;
2560 /* Width of a #CFT_CARGO field. */
2561 CargoesField::cargo_field_width = CargoesField::cargo_border.width * 2 + CargoesField::cargo_line.width * CargoesField::max_cargoes + CargoesField::cargo_space.width * (CargoesField::max_cargoes - 1);
2564 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
2566 switch (widget) {
2567 case WID_IC_PANEL:
2568 resize->height = CargoesField::normal_height;
2569 size->width = WD_FRAMETEXT_LEFT + CargoesField::industry_width * 3 + CargoesField::cargo_field_width * 2 + WD_FRAMETEXT_RIGHT;
2570 size->height = WD_FRAMETEXT_TOP + CargoesField::small_height + 2 * resize->height + WD_FRAMETEXT_BOTTOM;
2571 break;
2573 case WID_IC_IND_DROPDOWN:
2574 size->width = std::max(size->width, this->ind_textsize.width + padding.width);
2575 break;
2577 case WID_IC_CARGO_DROPDOWN:
2578 size->width = std::max(size->width, this->cargo_textsize.width + padding.width);
2579 break;
2584 CargoesFieldType type; ///< Type of field.
2585 void SetStringParameters (int widget) const override
2587 if (widget != WID_IC_CAPTION) return;
2589 if (this->ind_cargo < NUM_INDUSTRYTYPES) {
2590 const IndustrySpec *indsp = GetIndustrySpec(this->ind_cargo);
2591 SetDParam(0, indsp->name);
2592 } else {
2593 const CargoSpec *csp = CargoSpec::Get(this->ind_cargo - NUM_INDUSTRYTYPES);
2594 SetDParam(0, csp->name);
2599 * Do the two sets of cargoes have a valid cargo in common?
2600 * @param cargoes1 Base address of the first cargo array.
2601 * @param length1 Number of cargoes in the first cargo array.
2602 * @param cargoes2 Base address of the second cargo array.
2603 * @param length2 Number of cargoes in the second cargo array.
2604 * @return Arrays have at least one valid cargo in common.
2606 static bool HasCommonValidCargo(const CargoID *cargoes1, uint length1, const CargoID *cargoes2, uint length2)
2608 while (length1 > 0) {
2609 if (*cargoes1 != INVALID_CARGO) {
2610 for (uint i = 0; i < length2; i++) if (*cargoes1 == cargoes2[i]) return true;
2612 cargoes1++;
2613 length1--;
2615 return false;
2619 * Can houses be used to supply one of the cargoes?
2620 * @param cargoes Base address of the cargo array.
2621 * @param length Number of cargoes in the array.
2622 * @return Houses can supply at least one of the cargoes.
2624 static bool HousesCanSupply(const CargoID *cargoes, uint length)
2626 for (uint i = 0; i < length; i++) {
2627 if (cargoes[i] == INVALID_CARGO) continue;
2628 if (cargoes[i] == CT_PASSENGERS || cargoes[i] == CT_MAIL) return true;
2630 return false;
2634 * Can houses be used as customers of the produced cargoes?
2635 * @param cargoes Base address of the cargo array.
2636 * @param length Number of cargoes in the array.
2637 * @return Houses can accept at least one of the cargoes.
2639 static bool HousesCanAccept(const CargoID *cargoes, uint length)
2641 HouseZones climate_mask;
2642 switch (_settings_game.game_creation.landscape) {
2643 case LT_TEMPERATE: climate_mask = HZ_TEMP; break;
2644 case LT_ARCTIC: climate_mask = HZ_SUBARTC_ABOVE | HZ_SUBARTC_BELOW; break;
2645 case LT_TROPIC: climate_mask = HZ_SUBTROPIC; break;
2646 case LT_TOYLAND: climate_mask = HZ_TOYLND; break;
2647 default: NOT_REACHED();
2649 for (uint i = 0; i < length; i++) {
2650 if (cargoes[i] == INVALID_CARGO) continue;
2652 for (uint h = 0; h < NUM_HOUSES; h++) {
2653 HouseSpec *hs = HouseSpec::Get(h);
2654 if (!hs->enabled || !(hs->building_availability & climate_mask)) continue;
2656 for (uint j = 0; j < lengthof(hs->accepts_cargo); j++) {
2657 if (hs->cargo_acceptance[j] > 0 && cargoes[i] == hs->accepts_cargo[j]) return true;
2661 return false;
2665 * Count how many industries have accepted cargoes in common with one of the supplied set.
2666 * @param cargoes Cargoes to search.
2667 * @param length Number of cargoes in \a cargoes.
2668 * @return Number of industries that have an accepted cargo in common with the supplied set.
2670 static int CountMatchingAcceptingIndustries(const CargoID *cargoes, uint length)
2672 int count = 0;
2673 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2674 const IndustrySpec *indsp = GetIndustrySpec(it);
2675 if (!indsp->enabled) continue;
2677 if (HasCommonValidCargo(cargoes, length, indsp->accepts_cargo, lengthof(indsp->accepts_cargo))) count++;
2679 return count;
2683 * Count how many industries have produced cargoes in common with one of the supplied set.
2684 * @param cargoes Cargoes to search.
2685 * @param length Number of cargoes in \a cargoes.
2686 * @return Number of industries that have a produced cargo in common with the supplied set.
2688 static int CountMatchingProducingIndustries(const CargoID *cargoes, uint length)
2690 int count = 0;
2691 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2692 const IndustrySpec *indsp = GetIndustrySpec(it);
2693 if (!indsp->enabled) continue;
2695 if (HasCommonValidCargo(cargoes, length, indsp->produced_cargo, lengthof(indsp->produced_cargo))) count++;
2697 return count;
2701 * Shorten the cargo column to just the part between industries.
2702 * @param column Column number of the cargo column.
2703 * @param top Current top row.
2704 * @param bottom Current bottom row.
2706 void ShortenCargoColumn(int column, int top, int bottom)
2708 while (top < bottom && !this->fields[top].columns[column].HasConnection()) {
2709 this->fields[top].columns[column].MakeEmpty(CFT_EMPTY);
2710 top++;
2712 this->fields[top].columns[column].u.cargo.top_end = true;
2714 while (bottom > top && !this->fields[bottom].columns[column].HasConnection()) {
2715 this->fields[bottom].columns[column].MakeEmpty(CFT_EMPTY);
2716 bottom--;
2718 this->fields[bottom].columns[column].u.cargo.bottom_end = true;
2722 * Place an industry in the fields.
2723 * @param row Row of the new industry.
2724 * @param col Column of the new industry.
2725 * @param it Industry to place.
2727 void PlaceIndustry(int row, int col, IndustryType it)
2729 assert(this->fields[row].columns[col].type == CFT_EMPTY);
2730 this->fields[row].columns[col].MakeIndustry(it);
2731 if (col == 0) {
2732 this->fields[row].ConnectIndustryProduced(col);
2733 } else {
2734 this->fields[row].ConnectIndustryAccepted(col);
2739 * Notify smallmap that new displayed industries have been selected (in #_displayed_industries).
2741 void NotifySmallmap()
2743 if (!this->IsWidgetLowered(WID_IC_NOTIFY)) return;
2745 /* Only notify the smallmap window if it exists. In particular, do not
2746 * bring it to the front to prevent messing up any nice layout of the user. */
2747 InvalidateWindowClassesData(WC_SMALLMAP, 0);
2751 * Compute what and where to display for industry type \a it.
2752 * @param displayed_it Industry type to display.
2754 void ComputeIndustryDisplay(IndustryType displayed_it)
2756 this->GetWidget<NWidgetCore>(WID_IC_CAPTION)->widget_data = STR_INDUSTRY_CARGOES_INDUSTRY_CAPTION;
2757 this->ind_cargo = displayed_it;
2758 _displayed_industries.reset();
2759 _displayed_industries.set(displayed_it);
2761 this->fields.clear();
2762 CargoesRow &row = this->fields.emplace_back();
2763 row.columns[0].MakeHeader(STR_INDUSTRY_CARGOES_PRODUCERS);
2764 row.columns[1].MakeEmpty(CFT_SMALL_EMPTY);
2765 row.columns[2].MakeEmpty(CFT_SMALL_EMPTY);
2766 row.columns[3].MakeEmpty(CFT_SMALL_EMPTY);
2767 row.columns[4].MakeHeader(STR_INDUSTRY_CARGOES_CUSTOMERS);
2769 const IndustrySpec *central_sp = GetIndustrySpec(displayed_it);
2770 bool houses_supply = HousesCanSupply(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo));
2771 bool houses_accept = HousesCanAccept(central_sp->produced_cargo, lengthof(central_sp->produced_cargo));
2772 /* Make a field consisting of two cargo columns. */
2773 int num_supp = CountMatchingProducingIndustries(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo)) + houses_supply;
2774 int num_cust = CountMatchingAcceptingIndustries(central_sp->produced_cargo, lengthof(central_sp->produced_cargo)) + houses_accept;
2775 int num_indrows = std::max(3, std::max(num_supp, num_cust)); // One is needed for the 'it' industry, and 2 for the cargo labels.
2776 for (int i = 0; i < num_indrows; i++) {
2777 CargoesRow &row = this->fields.emplace_back();
2778 row.columns[0].MakeEmpty(CFT_EMPTY);
2779 row.columns[1].MakeCargo(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo));
2780 row.columns[2].MakeEmpty(CFT_EMPTY);
2781 row.columns[3].MakeCargo(central_sp->produced_cargo, lengthof(central_sp->produced_cargo));
2782 row.columns[4].MakeEmpty(CFT_EMPTY);
2784 /* Add central industry. */
2785 int central_row = 1 + num_indrows / 2;
2786 this->fields[central_row].columns[2].MakeIndustry(displayed_it);
2787 this->fields[central_row].ConnectIndustryProduced(2);
2788 this->fields[central_row].ConnectIndustryAccepted(2);
2790 /* Add cargo labels. */
2791 this->fields[central_row - 1].MakeCargoLabel(2, true);
2792 this->fields[central_row + 1].MakeCargoLabel(2, false);
2794 /* Add suppliers and customers of the 'it' industry. */
2795 int supp_count = 0;
2796 int cust_count = 0;
2797 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2798 const IndustrySpec *indsp = GetIndustrySpec(it);
2799 if (!indsp->enabled) continue;
2801 if (HasCommonValidCargo(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo), indsp->produced_cargo, lengthof(indsp->produced_cargo))) {
2802 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, it);
2803 _displayed_industries.set(it);
2804 supp_count++;
2806 if (HasCommonValidCargo(central_sp->produced_cargo, lengthof(central_sp->produced_cargo), indsp->accepts_cargo, lengthof(indsp->accepts_cargo))) {
2807 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 4, it);
2808 _displayed_industries.set(it);
2809 cust_count++;
2812 if (houses_supply) {
2813 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, NUM_INDUSTRYTYPES);
2814 supp_count++;
2816 if (houses_accept) {
2817 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 4, NUM_INDUSTRYTYPES);
2818 cust_count++;
2821 this->ShortenCargoColumn(1, 1, num_indrows);
2822 this->ShortenCargoColumn(3, 1, num_indrows);
2823 this->vscroll->SetCount(num_indrows);
2824 this->SetDirty();
2825 this->NotifySmallmap();
2829 * Compute what and where to display for cargo id \a cid.
2830 * @param cid Cargo id to display.
2832 void ComputeCargoDisplay(CargoID cid)
2834 this->GetWidget<NWidgetCore>(WID_IC_CAPTION)->widget_data = STR_INDUSTRY_CARGOES_CARGO_CAPTION;
2835 this->ind_cargo = cid + NUM_INDUSTRYTYPES;
2836 _displayed_industries.reset();
2838 this->fields.clear();
2839 CargoesRow &row = this->fields.emplace_back();
2840 row.columns[0].MakeHeader(STR_INDUSTRY_CARGOES_PRODUCERS);
2841 row.columns[1].MakeEmpty(CFT_SMALL_EMPTY);
2842 row.columns[2].MakeHeader(STR_INDUSTRY_CARGOES_CUSTOMERS);
2843 row.columns[3].MakeEmpty(CFT_SMALL_EMPTY);
2844 row.columns[4].MakeEmpty(CFT_SMALL_EMPTY);
2846 bool houses_supply = HousesCanSupply(&cid, 1);
2847 bool houses_accept = HousesCanAccept(&cid, 1);
2848 int num_supp = CountMatchingProducingIndustries(&cid, 1) + houses_supply + 1; // Ensure room for the cargo label.
2849 int num_cust = CountMatchingAcceptingIndustries(&cid, 1) + houses_accept;
2850 int num_indrows = std::max(num_supp, num_cust);
2851 for (int i = 0; i < num_indrows; i++) {
2852 CargoesRow &row = this->fields.emplace_back();
2853 row.columns[0].MakeEmpty(CFT_EMPTY);
2854 row.columns[1].MakeCargo(&cid, 1);
2855 row.columns[2].MakeEmpty(CFT_EMPTY);
2856 row.columns[3].MakeEmpty(CFT_EMPTY);
2857 row.columns[4].MakeEmpty(CFT_EMPTY);
2860 this->fields[num_indrows].MakeCargoLabel(0, false); // Add cargo labels at the left bottom.
2862 /* Add suppliers and customers of the cargo. */
2863 int supp_count = 0;
2864 int cust_count = 0;
2865 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2866 const IndustrySpec *indsp = GetIndustrySpec(it);
2867 if (!indsp->enabled) continue;
2869 if (HasCommonValidCargo(&cid, 1, indsp->produced_cargo, lengthof(indsp->produced_cargo))) {
2870 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, it);
2871 _displayed_industries.set(it);
2872 supp_count++;
2874 if (HasCommonValidCargo(&cid, 1, indsp->accepts_cargo, lengthof(indsp->accepts_cargo))) {
2875 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 2, it);
2876 _displayed_industries.set(it);
2877 cust_count++;
2880 if (houses_supply) {
2881 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, NUM_INDUSTRYTYPES);
2882 supp_count++;
2884 if (houses_accept) {
2885 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 2, NUM_INDUSTRYTYPES);
2886 cust_count++;
2889 this->ShortenCargoColumn(1, 1, num_indrows);
2890 this->vscroll->SetCount(num_indrows);
2891 this->SetDirty();
2892 this->NotifySmallmap();
2896 * Some data on this window has become invalid.
2897 * @param data Information about the changed data.
2898 * - data = 0 .. NUM_INDUSTRYTYPES - 1: Display the chain around the given industry.
2899 * - data = NUM_INDUSTRYTYPES: Stop sending updates to the smallmap window.
2900 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
2902 void OnInvalidateData(int data = 0, bool gui_scope = true) override
2904 if (!gui_scope) return;
2905 if (data == NUM_INDUSTRYTYPES) {
2906 if (this->IsWidgetLowered(WID_IC_NOTIFY)) {
2907 this->RaiseWidget(WID_IC_NOTIFY);
2908 this->SetWidgetDirty(WID_IC_NOTIFY);
2910 return;
2913 assert(data >= 0 && data < NUM_INDUSTRYTYPES);
2914 this->ComputeIndustryDisplay(data);
2917 void DrawWidget(const Rect &r, int widget) const override
2919 if (widget != WID_IC_PANEL) return;
2921 DrawPixelInfo tmp_dpi, *old_dpi;
2922 int width = r.right - r.left + 1;
2923 int height = r.bottom - r.top + 1 - WD_FRAMERECT_TOP - WD_FRAMERECT_BOTTOM;
2924 if (!FillDrawPixelInfo(&tmp_dpi, r.left + WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP, width, height)) return;
2925 old_dpi = _cur_dpi;
2926 _cur_dpi = &tmp_dpi;
2928 int left_pos = WD_FRAMERECT_LEFT;
2929 if (this->ind_cargo >= NUM_INDUSTRYTYPES) left_pos += (CargoesField::industry_width + CargoesField::cargo_field_width) / 2;
2930 int last_column = (this->ind_cargo < NUM_INDUSTRYTYPES) ? 4 : 2;
2932 const NWidgetBase *nwp = this->GetWidget<NWidgetBase>(WID_IC_PANEL);
2933 int vpos = -this->vscroll->GetPosition() * nwp->resize_y;
2934 for (uint i = 0; i < this->fields.size(); i++) {
2935 int row_height = (i == 0) ? CargoesField::small_height : CargoesField::normal_height;
2936 if (vpos + row_height >= 0) {
2937 int xpos = left_pos;
2938 int col, dir;
2939 if (_current_text_dir == TD_RTL) {
2940 col = last_column;
2941 dir = -1;
2942 } else {
2943 col = 0;
2944 dir = 1;
2946 while (col >= 0 && col <= last_column) {
2947 this->fields[i].columns[col].Draw(xpos, vpos);
2948 xpos += (col & 1) ? CargoesField::cargo_field_width : CargoesField::industry_width;
2949 col += dir;
2952 vpos += row_height;
2953 if (vpos >= height) break;
2956 _cur_dpi = old_dpi;
2960 * Calculate in which field was clicked, and within the field, at what position.
2961 * @param pt Clicked position in the #WID_IC_PANEL widget.
2962 * @param fieldxy If \c true is returned, field x/y coordinate of \a pt.
2963 * @param xy If \c true is returned, x/y coordinate with in the field.
2964 * @return Clicked at a valid position.
2966 bool CalculatePositionInWidget(Point pt, Point *fieldxy, Point *xy)
2968 const NWidgetBase *nw = this->GetWidget<NWidgetBase>(WID_IC_PANEL);
2969 pt.x -= nw->pos_x;
2970 pt.y -= nw->pos_y;
2972 int vpos = WD_FRAMERECT_TOP + CargoesField::small_height - this->vscroll->GetPosition() * nw->resize_y;
2973 if (pt.y < vpos) return false;
2975 int row = (pt.y - vpos) / CargoesField::normal_height; // row is relative to row 1.
2976 if (row + 1 >= (int)this->fields.size()) return false;
2977 vpos = pt.y - vpos - row * CargoesField::normal_height; // Position in the row + 1 field
2978 row++; // rebase row to match index of this->fields.
2980 int xpos = 2 * WD_FRAMERECT_LEFT + ((this->ind_cargo < NUM_INDUSTRYTYPES) ? 0 : (CargoesField::industry_width + CargoesField::cargo_field_width) / 2);
2981 if (pt.x < xpos) return false;
2982 int column;
2983 for (column = 0; column <= 5; column++) {
2984 int width = (column & 1) ? CargoesField::cargo_field_width : CargoesField::industry_width;
2985 if (pt.x < xpos + width) break;
2986 xpos += width;
2988 int num_columns = (this->ind_cargo < NUM_INDUSTRYTYPES) ? 4 : 2;
2989 if (column > num_columns) return false;
2990 xpos = pt.x - xpos;
2992 /* Return both positions, compensating for RTL languages (which works due to the equal symmetry in both displays). */
2993 fieldxy->y = row;
2994 xy->y = vpos;
2995 if (_current_text_dir == TD_RTL) {
2996 fieldxy->x = num_columns - column;
2997 xy->x = ((column & 1) ? CargoesField::cargo_field_width : CargoesField::industry_width) - xpos;
2998 } else {
2999 fieldxy->x = column;
3000 xy->x = xpos;
3002 return true;
3005 void OnClick(Point pt, int widget, int click_count) override
3007 switch (widget) {
3008 case WID_IC_PANEL: {
3009 Point fieldxy, xy;
3010 if (!CalculatePositionInWidget(pt, &fieldxy, &xy)) return;
3012 const CargoesField *fld = this->fields[fieldxy.y].columns + fieldxy.x;
3013 switch (fld->type) {
3014 case CFT_INDUSTRY:
3015 if (fld->u.industry.ind_type < NUM_INDUSTRYTYPES) this->ComputeIndustryDisplay(fld->u.industry.ind_type);
3016 break;
3018 case CFT_CARGO: {
3019 CargoesField *lft = (fieldxy.x > 0) ? this->fields[fieldxy.y].columns + fieldxy.x - 1 : nullptr;
3020 CargoesField *rgt = (fieldxy.x < 4) ? this->fields[fieldxy.y].columns + fieldxy.x + 1 : nullptr;
3021 CargoID cid = fld->CargoClickedAt(lft, rgt, xy);
3022 if (cid != INVALID_CARGO) this->ComputeCargoDisplay(cid);
3023 break;
3026 case CFT_CARGO_LABEL: {
3027 CargoID cid = fld->CargoLabelClickedAt(xy);
3028 if (cid != INVALID_CARGO) this->ComputeCargoDisplay(cid);
3029 break;
3032 default:
3033 break;
3035 break;
3038 case WID_IC_NOTIFY:
3039 this->ToggleWidgetLoweredState(WID_IC_NOTIFY);
3040 this->SetWidgetDirty(WID_IC_NOTIFY);
3041 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
3043 if (this->IsWidgetLowered(WID_IC_NOTIFY)) {
3044 if (FindWindowByClass(WC_SMALLMAP) == nullptr) ShowSmallMap();
3045 this->NotifySmallmap();
3047 break;
3049 case WID_IC_CARGO_DROPDOWN: {
3050 DropDownList lst;
3051 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
3052 lst.emplace_back(new DropDownListStringItem(cs->name, cs->Index(), false));
3054 if (!lst.empty()) {
3055 int selected = (this->ind_cargo >= NUM_INDUSTRYTYPES) ? (int)(this->ind_cargo - NUM_INDUSTRYTYPES) : -1;
3056 ShowDropDownList(this, std::move(lst), selected, WID_IC_CARGO_DROPDOWN, 0, true);
3058 break;
3061 case WID_IC_IND_DROPDOWN: {
3062 DropDownList lst;
3063 for (IndustryType ind : _sorted_industry_types) {
3064 const IndustrySpec *indsp = GetIndustrySpec(ind);
3065 if (!indsp->enabled) continue;
3066 lst.emplace_back(new DropDownListStringItem(indsp->name, ind, false));
3068 if (!lst.empty()) {
3069 int selected = (this->ind_cargo < NUM_INDUSTRYTYPES) ? (int)this->ind_cargo : -1;
3070 ShowDropDownList(this, std::move(lst), selected, WID_IC_IND_DROPDOWN, 0, true);
3072 break;
3077 void OnDropdownSelect(int widget, int index) override
3079 if (index < 0) return;
3081 switch (widget) {
3082 case WID_IC_CARGO_DROPDOWN:
3083 this->ComputeCargoDisplay(index);
3084 break;
3086 case WID_IC_IND_DROPDOWN:
3087 this->ComputeIndustryDisplay(index);
3088 break;
3092 bool OnTooltip(Point pt, int widget, TooltipCloseCondition close_cond) override
3094 if (widget != WID_IC_PANEL) return false;
3096 Point fieldxy, xy;
3097 if (!CalculatePositionInWidget(pt, &fieldxy, &xy)) return false;
3099 const CargoesField *fld = this->fields[fieldxy.y].columns + fieldxy.x;
3100 CargoID cid = INVALID_CARGO;
3101 switch (fld->type) {
3102 case CFT_CARGO: {
3103 CargoesField *lft = (fieldxy.x > 0) ? this->fields[fieldxy.y].columns + fieldxy.x - 1 : nullptr;
3104 CargoesField *rgt = (fieldxy.x < 4) ? this->fields[fieldxy.y].columns + fieldxy.x + 1 : nullptr;
3105 cid = fld->CargoClickedAt(lft, rgt, xy);
3106 break;
3109 case CFT_CARGO_LABEL: {
3110 cid = fld->CargoLabelClickedAt(xy);
3111 break;
3114 case CFT_INDUSTRY:
3115 if (fld->u.industry.ind_type < NUM_INDUSTRYTYPES && (this->ind_cargo >= NUM_INDUSTRYTYPES || fieldxy.x != 2)) {
3116 GuiShowTooltips(this, STR_INDUSTRY_CARGOES_INDUSTRY_TOOLTIP, 0, nullptr, close_cond);
3118 return true;
3120 default:
3121 break;
3123 if (cid != INVALID_CARGO && (this->ind_cargo < NUM_INDUSTRYTYPES || cid != this->ind_cargo - NUM_INDUSTRYTYPES)) {
3124 const CargoSpec *csp = CargoSpec::Get(cid);
3125 uint64 params[5];
3126 params[0] = csp->name;
3127 GuiShowTooltips(this, STR_INDUSTRY_CARGOES_CARGO_TOOLTIP, 1, params, close_cond);
3128 return true;
3131 return false;
3134 void OnResize() override
3136 this->vscroll->SetCapacityFromWidget(this, WID_IC_PANEL, WD_FRAMERECT_TOP + CargoesField::small_height);
3140 const int IndustryCargoesWindow::HOR_TEXT_PADDING = 5; ///< Horizontal padding around the industry type text.
3141 const int IndustryCargoesWindow::VERT_TEXT_PADDING = 5; ///< Vertical padding around the industry type text.
3144 * Open the industry and cargoes window.
3145 * @param id Industry type to display, \c NUM_INDUSTRYTYPES selects a default industry type.
3147 static void ShowIndustryCargoesWindow(IndustryType id)
3149 if (id >= NUM_INDUSTRYTYPES) {
3150 for (IndustryType ind : _sorted_industry_types) {
3151 const IndustrySpec *indsp = GetIndustrySpec(ind);
3152 if (indsp->enabled) {
3153 id = ind;
3154 break;
3157 if (id >= NUM_INDUSTRYTYPES) return;
3160 Window *w = BringWindowToFrontById(WC_INDUSTRY_CARGOES, 0);
3161 if (w != nullptr) {
3162 w->InvalidateData(id);
3163 return;
3165 new IndustryCargoesWindow(id);
3168 /** Open the industry and cargoes window with an industry. */
3169 void ShowIndustryCargoesWindow()
3171 ShowIndustryCargoesWindow(NUM_INDUSTRYTYPES);