(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / industry_gui.cpp
blob41b3c573ffa0c95b11c24276e6a38a4c731cdedc
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file industry_gui.cpp GUIs related to industries. */
12 #include "stdafx.h"
13 #include "error.h"
14 #include "gui.h"
15 #include "settings_gui.h"
16 #include "sound_func.h"
17 #include "window_func.h"
18 #include "textbuf_gui.h"
19 #include "command_func.h"
20 #include "viewport_func.h"
21 #include "industry.h"
22 #include "town.h"
23 #include "cheat_type.h"
24 #include "newgrf_industries.h"
25 #include "newgrf_text.h"
26 #include "newgrf_debug.h"
27 #include "network/network.h"
28 #include "strings_func.h"
29 #include "company_func.h"
30 #include "tilehighlight_func.h"
31 #include "string_func.h"
32 #include "sortlist_type.h"
33 #include "widgets/dropdown_func.h"
34 #include "company_base.h"
35 #include "core/geometry_func.hpp"
36 #include "core/random_func.hpp"
37 #include "core/backup_type.hpp"
38 #include "genworld.h"
39 #include "smallmap_gui.h"
40 #include "widgets/dropdown_type.h"
41 #include "widgets/industry_widget.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
78 * - 00 - first accepted cargo type
79 * - 01 - second accepted cargo type
80 * - 02 - third accepted cargo type
81 * - 03 - first produced cargo type
82 * - 04 - second produced cargo type
83 * @param cst the cargo suffix type (for which window is it requested). @see CargoSuffixType
84 * @param ind the industry (NULL if in fund window)
85 * @param ind_type the industry type
86 * @param indspec the industry spec
87 * @param suffix is filled with the string to display
89 static void GetCargoSuffix(uint cargo, CargoSuffixType cst, const Industry *ind, IndustryType ind_type, const IndustrySpec *indspec, CargoSuffix &suffix)
91 suffix.text[0] = '\0';
92 suffix.display = CSD_CARGO_AMOUNT;
94 if (HasBit(indspec->callback_mask, CBM_IND_CARGO_SUFFIX)) {
95 TileIndex t = (cst != CST_FUND) ? ind->location.tile : INVALID_TILE;
96 uint16 callback = GetIndustryCallback(CBID_INDUSTRY_CARGO_SUFFIX, 0, (cst << 8) | cargo, const_cast<Industry *>(ind), ind_type, t);
97 if (callback == CALLBACK_FAILED) return;
99 if (indspec->grf_prop.grffile->grf_version < 8) {
100 if (GB(callback, 0, 8) == 0xFF) return;
101 if (callback < 0x400) {
102 StartTextRefStackUsage(indspec->grf_prop.grffile, 6);
103 GetString(suffix.text, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + callback), lastof(suffix.text));
104 StopTextRefStackUsage();
105 suffix.display = CSD_CARGO_AMOUNT_TEXT;
106 return;
108 ErrorUnknownCallbackResult(indspec->grf_prop.grffile->grfid, CBID_INDUSTRY_CARGO_SUFFIX, callback);
109 return;
111 } else { // GRF version 8 or higher.
112 if (callback == 0x400) return;
113 if (callback == 0x401) {
114 suffix.display = CSD_CARGO;
115 return;
117 if (callback < 0x400) {
118 StartTextRefStackUsage(indspec->grf_prop.grffile, 6);
119 GetString(suffix.text, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + callback), lastof(suffix.text));
120 StopTextRefStackUsage();
121 suffix.display = CSD_CARGO_AMOUNT_TEXT;
122 return;
124 if (callback >= 0x800 && callback < 0xC00) {
125 StartTextRefStackUsage(indspec->grf_prop.grffile, 6);
126 GetString(suffix.text, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 - 0x800 + callback), lastof(suffix.text));
127 StopTextRefStackUsage();
128 suffix.display = CSD_CARGO_TEXT;
129 return;
131 ErrorUnknownCallbackResult(indspec->grf_prop.grffile->grfid, CBID_INDUSTRY_CARGO_SUFFIX, callback);
132 return;
138 * Gets all strings to display after the cargoes of industries (using callback 37)
139 * @param cb_offset The offset for the cargo used in cb37, 0 for accepted cargoes, 3 for produced cargoes
140 * @param cst the cargo suffix type (for which window is it requested). @see CargoSuffixType
141 * @param ind the industry (NULL 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(uint cb_offset, CargoSuffixType cst, const Industry *ind, IndustryType ind_type, const IndustrySpec *indspec, const TC &cargoes, TS &suffixes)
150 assert_compile(lengthof(cargoes) <= lengthof(suffixes));
151 for (uint j = 0; j < lengthof(cargoes); j++) {
152 if (cargoes[j] != CT_INVALID) {
153 GetCargoSuffix(cb_offset + j, cst, ind, ind_type, indspec, suffixes[j]);
154 } else {
155 suffixes[j].text[0] = '\0';
160 IndustryType _sorted_industry_types[NUM_INDUSTRYTYPES]; ///< Industry types sorted by name.
162 /** Sort industry types by their name. */
163 static int CDECL IndustryTypeNameSorter(const IndustryType *a, const IndustryType *b)
165 static char industry_name[2][64];
167 const IndustrySpec *indsp1 = GetIndustrySpec(*a);
168 GetString(industry_name[0], indsp1->name, lastof(industry_name[0]));
170 const IndustrySpec *indsp2 = GetIndustrySpec(*b);
171 GetString(industry_name[1], indsp2->name, lastof(industry_name[1]));
173 int r = strnatcmp(industry_name[0], industry_name[1]); // Sort by name (natural sorting).
175 /* If the names are equal, sort by industry type. */
176 return (r != 0) ? r : (*a - *b);
180 * Initialize the list of sorted industry types.
182 void SortIndustryTypes()
184 /* Add each industry type to the list. */
185 for (IndustryType i = 0; i < NUM_INDUSTRYTYPES; i++) {
186 _sorted_industry_types[i] = i;
189 /* Sort industry types by name. */
190 QSortT(_sorted_industry_types, NUM_INDUSTRYTYPES, &IndustryTypeNameSorter);
194 * Command callback. In case of failure to build an industry, show an error message.
195 * @param result Result of the command.
196 * @param tile Tile where the industry is placed.
197 * @param p1 Additional data of the #CMD_BUILD_INDUSTRY command.
198 * @param p2 Additional data of the #CMD_BUILD_INDUSTRY command.
200 void CcBuildIndustry(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
202 if (result.Succeeded()) return;
204 uint8 indtype = GB(p1, 0, 8);
205 if (indtype < NUM_INDUSTRYTYPES) {
206 const IndustrySpec *indsp = GetIndustrySpec(indtype);
207 if (indsp->enabled) {
208 SetDParam(0, indsp->name);
209 ShowErrorMessage(STR_ERROR_CAN_T_BUILD_HERE, result.GetErrorMessage(), WL_INFO, TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE);
214 static const NWidgetPart _nested_build_industry_widgets[] = {
215 NWidget(NWID_HORIZONTAL),
216 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
217 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_FUND_INDUSTRY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
218 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
219 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
220 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
221 EndContainer(),
222 NWidget(NWID_HORIZONTAL),
223 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),
224 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_DPI_SCROLLBAR),
225 EndContainer(),
226 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_DPI_INFOPANEL), SetResize(1, 0),
227 EndContainer(),
228 NWidget(NWID_HORIZONTAL),
229 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_DPI_DISPLAY_WIDGET), SetFill(1, 0), SetResize(1, 0),
230 SetDataTip(STR_INDUSTRY_DISPLAY_CHAIN, STR_INDUSTRY_DISPLAY_CHAIN_TOOLTIP),
231 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_DPI_FUND_WIDGET), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_JUST_STRING, STR_NULL),
232 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
233 EndContainer(),
236 /** Window definition of the dynamic place industries gui */
237 static WindowDesc _build_industry_desc(
238 WDP_AUTO, "build_industry", 170, 212,
239 WC_BUILD_INDUSTRY, WC_NONE,
240 WDF_CONSTRUCTION,
241 _nested_build_industry_widgets, lengthof(_nested_build_industry_widgets)
244 /** Build (fund or prospect) a new industry, */
245 class BuildIndustryWindow : public Window {
246 int selected_index; ///< index of the element in the matrix
247 IndustryType selected_type; ///< industry corresponding to the above index
248 uint16 callback_timer; ///< timer counter for callback eventual verification
249 bool timer_enabled; ///< timer can be used
250 uint16 count; ///< How many industries are loaded
251 IndustryType index[NUM_INDUSTRYTYPES + 1]; ///< Type of industry, in the order it was loaded
252 bool enabled[NUM_INDUSTRYTYPES + 1]; ///< availability state, coming from CBID_INDUSTRY_PROBABILITY (if ever)
253 Scrollbar *vscroll;
255 /** The offset for the text in the matrix. */
256 static const int MATRIX_TEXT_OFFSET = 17;
258 void SetupArrays()
260 this->count = 0;
262 for (uint i = 0; i < lengthof(this->index); i++) {
263 this->index[i] = INVALID_INDUSTRYTYPE;
264 this->enabled[i] = false;
267 if (_game_mode == GM_EDITOR) { // give room for the Many Random "button"
268 this->index[this->count] = INVALID_INDUSTRYTYPE;
269 this->enabled[this->count] = true;
270 this->count++;
271 this->timer_enabled = false;
273 /* Fill the arrays with industries.
274 * The tests performed after the enabled allow to load the industries
275 * In the same way they are inserted by grf (if any)
277 for (uint i = 0; i < NUM_INDUSTRYTYPES; i++) {
278 IndustryType ind = _sorted_industry_types[i];
279 const IndustrySpec *indsp = GetIndustrySpec(ind);
280 if (indsp->enabled) {
281 /* Rule is that editor mode loads all industries.
282 * In game mode, all non raw industries are loaded too
283 * and raw ones are loaded only when setting allows it */
284 if (_game_mode != GM_EDITOR && indsp->IsRawIndustry() && _settings_game.construction.raw_industry_construction == 0) {
285 /* Unselect if the industry is no longer in the list */
286 if (this->selected_type == ind) this->selected_index = -1;
287 continue;
289 this->index[this->count] = ind;
290 this->enabled[this->count] = (_game_mode == GM_EDITOR) || GetIndustryProbabilityCallback(ind, IACT_USERCREATION, 1) > 0;
291 /* Keep the selection to the correct line */
292 if (this->selected_type == ind) this->selected_index = this->count;
293 this->count++;
297 /* first industry type is selected if the current selection is invalid.
298 * I'll be damned if there are none available ;) */
299 if (this->selected_index == -1) {
300 this->selected_index = 0;
301 this->selected_type = this->index[0];
304 this->vscroll->SetCount(this->count);
307 /** Update status of the fund and display-chain widgets. */
308 void SetButtons()
310 this->SetWidgetDisabledState(WID_DPI_FUND_WIDGET, this->selected_type != INVALID_INDUSTRYTYPE && !this->enabled[this->selected_index]);
311 this->SetWidgetDisabledState(WID_DPI_DISPLAY_WIDGET, this->selected_type == INVALID_INDUSTRYTYPE && this->enabled[this->selected_index]);
314 public:
315 BuildIndustryWindow() : Window(&_build_industry_desc)
317 this->timer_enabled = _loaded_newgrf_features.has_newindustries;
319 this->selected_index = -1;
320 this->selected_type = INVALID_INDUSTRYTYPE;
322 this->callback_timer = DAY_TICKS;
324 this->CreateNestedTree();
325 this->vscroll = this->GetScrollbar(WID_DPI_SCROLLBAR);
326 this->FinishInitNested(0);
328 this->SetButtons();
331 virtual void OnInit()
333 this->SetupArrays();
336 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
338 switch (widget) {
339 case WID_DPI_MATRIX_WIDGET: {
340 Dimension d = GetStringBoundingBox(STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES);
341 for (byte i = 0; i < this->count; i++) {
342 if (this->index[i] == INVALID_INDUSTRYTYPE) continue;
343 d = maxdim(d, GetStringBoundingBox(GetIndustrySpec(this->index[i])->name));
345 resize->height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
346 d.width += MATRIX_TEXT_OFFSET + padding.width;
347 d.height = 5 * resize->height;
348 *size = maxdim(*size, d);
349 break;
352 case WID_DPI_INFOPANEL: {
353 /* Extra line for cost outside of editor + extra lines for 'extra' information for NewGRFs. */
354 int height = 2 + (_game_mode == GM_EDITOR ? 0 : 1) + (_loaded_newgrf_features.has_newindustries ? 4 : 0);
355 Dimension d = {0, 0};
356 for (byte i = 0; i < this->count; i++) {
357 if (this->index[i] == INVALID_INDUSTRYTYPE) continue;
359 const IndustrySpec *indsp = GetIndustrySpec(this->index[i]);
361 CargoSuffix cargo_suffix[3];
362 GetAllCargoSuffixes(0, CST_FUND, NULL, this->index[i], indsp, indsp->accepts_cargo, cargo_suffix);
363 StringID str = STR_INDUSTRY_VIEW_REQUIRES_CARGO;
364 byte p = 0;
365 SetDParam(0, STR_JUST_NOTHING);
366 SetDParamStr(1, "");
367 for (byte j = 0; j < lengthof(indsp->accepts_cargo); j++) {
368 if (indsp->accepts_cargo[j] == CT_INVALID) continue;
369 if (p > 0) str++;
370 SetDParam(p++, CargoSpec::Get(indsp->accepts_cargo[j])->name);
371 SetDParamStr(p++, cargo_suffix[j].text);
373 d = maxdim(d, GetStringBoundingBox(str));
375 /* Draw the produced cargoes, if any. Otherwise, will print "Nothing". */
376 GetAllCargoSuffixes(3, CST_FUND, NULL, this->index[i], indsp, indsp->produced_cargo, cargo_suffix);
377 str = STR_INDUSTRY_VIEW_PRODUCES_CARGO;
378 p = 0;
379 SetDParam(0, STR_JUST_NOTHING);
380 SetDParamStr(1, "");
381 for (byte j = 0; j < lengthof(indsp->produced_cargo); j++) {
382 if (indsp->produced_cargo[j] == CT_INVALID) continue;
383 if (p > 0) str++;
384 SetDParam(p++, CargoSpec::Get(indsp->produced_cargo[j])->name);
385 SetDParamStr(p++, cargo_suffix[j].text);
387 d = maxdim(d, GetStringBoundingBox(str));
390 /* Set it to something more sane :) */
391 size->height = height * FONT_HEIGHT_NORMAL + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
392 size->width = d.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
393 break;
396 case WID_DPI_FUND_WIDGET: {
397 Dimension d = GetStringBoundingBox(STR_FUND_INDUSTRY_BUILD_NEW_INDUSTRY);
398 d = maxdim(d, GetStringBoundingBox(STR_FUND_INDUSTRY_PROSPECT_NEW_INDUSTRY));
399 d = maxdim(d, GetStringBoundingBox(STR_FUND_INDUSTRY_FUND_NEW_INDUSTRY));
400 d.width += padding.width;
401 d.height += padding.height;
402 *size = maxdim(*size, d);
403 break;
408 virtual void SetStringParameters(int widget) const
410 switch (widget) {
411 case WID_DPI_FUND_WIDGET:
412 /* Raw industries might be prospected. Show this fact by changing the string
413 * In Editor, you just build, while ingame, or you fund or you prospect */
414 if (_game_mode == GM_EDITOR) {
415 /* We've chosen many random industries but no industries have been specified */
416 SetDParam(0, STR_FUND_INDUSTRY_BUILD_NEW_INDUSTRY);
417 } else {
418 const IndustrySpec *indsp = GetIndustrySpec(this->index[this->selected_index]);
419 SetDParam(0, (_settings_game.construction.raw_industry_construction == 2 && indsp->IsRawIndustry()) ? STR_FUND_INDUSTRY_PROSPECT_NEW_INDUSTRY : STR_FUND_INDUSTRY_FUND_NEW_INDUSTRY);
421 break;
425 virtual void DrawWidget(const Rect &r, int widget) const
427 switch (widget) {
428 case WID_DPI_MATRIX_WIDGET: {
429 uint text_left, text_right, icon_left, icon_right;
430 if (_current_text_dir == TD_RTL) {
431 icon_right = r.right - WD_MATRIX_RIGHT;
432 icon_left = icon_right - 10;
433 text_right = icon_right - BuildIndustryWindow::MATRIX_TEXT_OFFSET;
434 text_left = r.left + WD_MATRIX_LEFT;
435 } else {
436 icon_left = r.left + WD_MATRIX_LEFT;
437 icon_right = icon_left + 10;
438 text_left = icon_left + BuildIndustryWindow::MATRIX_TEXT_OFFSET;
439 text_right = r.right - WD_MATRIX_RIGHT;
442 for (byte i = 0; i < this->vscroll->GetCapacity() && i + this->vscroll->GetPosition() < this->count; i++) {
443 int y = r.top + WD_MATRIX_TOP + i * this->resize.step_height;
444 bool selected = this->selected_index == i + this->vscroll->GetPosition();
446 if (this->index[i + this->vscroll->GetPosition()] == INVALID_INDUSTRYTYPE) {
447 DrawString(text_left, text_right, y, STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES, selected ? TC_WHITE : TC_ORANGE);
448 continue;
450 const IndustrySpec *indsp = GetIndustrySpec(this->index[i + this->vscroll->GetPosition()]);
452 /* Draw the name of the industry in white is selected, otherwise, in orange */
453 DrawString(text_left, text_right, y, indsp->name, selected ? TC_WHITE : TC_ORANGE);
454 GfxFillRect(icon_left, y + 1, icon_right, y + 7, selected ? PC_WHITE : PC_BLACK);
455 GfxFillRect(icon_left + 1, y + 2, icon_right - 1, y + 6, indsp->map_colour);
457 break;
460 case WID_DPI_INFOPANEL: {
461 int y = r.top + WD_FRAMERECT_TOP;
462 int bottom = r.bottom - WD_FRAMERECT_BOTTOM;
463 int left = r.left + WD_FRAMERECT_LEFT;
464 int right = r.right - WD_FRAMERECT_RIGHT;
466 if (this->selected_type == INVALID_INDUSTRYTYPE) {
467 DrawStringMultiLine(left, right, y, bottom, STR_FUND_INDUSTRY_MANY_RANDOM_INDUSTRIES_TOOLTIP);
468 break;
471 const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);
473 if (_game_mode != GM_EDITOR) {
474 SetDParam(0, indsp->GetConstructionCost());
475 DrawString(left, right, y, STR_FUND_INDUSTRY_INDUSTRY_BUILD_COST);
476 y += FONT_HEIGHT_NORMAL;
479 /* Draw the accepted cargoes, if any. Otherwise, will print "Nothing". */
480 CargoSuffix cargo_suffix[3];
481 GetAllCargoSuffixes(0, CST_FUND, NULL, this->selected_type, indsp, indsp->accepts_cargo, cargo_suffix);
482 StringID str = STR_INDUSTRY_VIEW_REQUIRES_CARGO;
483 byte p = 0;
484 SetDParam(0, STR_JUST_NOTHING);
485 SetDParamStr(1, "");
486 for (byte j = 0; j < lengthof(indsp->accepts_cargo); j++) {
487 if (indsp->accepts_cargo[j] == CT_INVALID) continue;
488 if (p > 0) str++;
489 SetDParam(p++, CargoSpec::Get(indsp->accepts_cargo[j])->name);
490 SetDParamStr(p++, cargo_suffix[j].text);
492 DrawString(left, right, y, str);
493 y += FONT_HEIGHT_NORMAL;
495 /* Draw the produced cargoes, if any. Otherwise, will print "Nothing". */
496 GetAllCargoSuffixes(3, CST_FUND, NULL, this->selected_type, indsp, indsp->produced_cargo, cargo_suffix);
497 str = STR_INDUSTRY_VIEW_PRODUCES_CARGO;
498 p = 0;
499 SetDParam(0, STR_JUST_NOTHING);
500 SetDParamStr(1, "");
501 for (byte j = 0; j < lengthof(indsp->produced_cargo); j++) {
502 if (indsp->produced_cargo[j] == CT_INVALID) continue;
503 if (p > 0) str++;
504 SetDParam(p++, CargoSpec::Get(indsp->produced_cargo[j])->name);
505 SetDParamStr(p++, cargo_suffix[j].text);
507 DrawString(left, right, y, str);
508 y += FONT_HEIGHT_NORMAL;
510 /* Get the additional purchase info text, if it has not already been queried. */
511 str = STR_NULL;
512 if (HasBit(indsp->callback_mask, CBM_IND_FUND_MORE_TEXT)) {
513 uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_FUND_MORE_TEXT, 0, 0, NULL, this->selected_type, INVALID_TILE);
514 if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
515 if (callback_res > 0x400) {
516 ErrorUnknownCallbackResult(indsp->grf_prop.grffile->grfid, CBID_INDUSTRY_FUND_MORE_TEXT, callback_res);
517 } else {
518 str = GetGRFStringID(indsp->grf_prop.grffile->grfid, 0xD000 + callback_res); // No. here's the new string
519 if (str != STR_UNDEFINED) {
520 StartTextRefStackUsage(indsp->grf_prop.grffile, 6);
521 DrawStringMultiLine(left, right, y, bottom, str, TC_YELLOW);
522 StopTextRefStackUsage();
527 break;
532 virtual void OnClick(Point pt, int widget, int click_count)
534 switch (widget) {
535 case WID_DPI_MATRIX_WIDGET: {
536 int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_DPI_MATRIX_WIDGET);
537 if (y < this->count) { // Is it within the boundaries of available data?
538 this->selected_index = y;
539 this->selected_type = this->index[y];
540 const IndustrySpec *indsp = (this->selected_type == INVALID_INDUSTRYTYPE) ? NULL : GetIndustrySpec(this->selected_type);
542 this->SetDirty();
544 if (_thd.GetCallbackWnd() == this &&
545 ((_game_mode != GM_EDITOR && _settings_game.construction.raw_industry_construction == 2 && indsp != NULL && indsp->IsRawIndustry()) ||
546 this->selected_type == INVALID_INDUSTRYTYPE ||
547 !this->enabled[this->selected_index])) {
548 /* Reset the button state if going to prospecting or "build many industries" */
549 this->RaiseButtons();
550 ResetObjectToPlace();
553 this->SetButtons();
554 if (this->enabled[this->selected_index] && click_count > 1) this->OnClick(pt, WID_DPI_FUND_WIDGET, 1);
556 break;
559 case WID_DPI_DISPLAY_WIDGET:
560 if (this->selected_type != INVALID_INDUSTRYTYPE) ShowIndustryCargoesWindow(this->selected_type);
561 break;
563 case WID_DPI_FUND_WIDGET: {
564 if (this->selected_type == INVALID_INDUSTRYTYPE) {
565 this->HandleButtonClick(WID_DPI_FUND_WIDGET);
567 if (Town::GetNumItems() == 0) {
568 ShowErrorMessage(STR_ERROR_CAN_T_GENERATE_INDUSTRIES, STR_ERROR_MUST_FOUND_TOWN_FIRST, WL_INFO);
569 } else {
570 extern void GenerateIndustries();
571 _generating_world = true;
572 GenerateIndustries();
573 _generating_world = false;
575 } else if (_game_mode != GM_EDITOR && _settings_game.construction.raw_industry_construction == 2 && GetIndustrySpec(this->selected_type)->IsRawIndustry()) {
576 DoCommandP(0, this->selected_type, InteractiveRandom(), CMD_BUILD_INDUSTRY | CMD_MSG(STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY));
577 this->HandleButtonClick(WID_DPI_FUND_WIDGET);
578 } else {
579 HandlePlacePushButton(this, WID_DPI_FUND_WIDGET, SPR_CURSOR_INDUSTRY, HT_RECT);
581 break;
586 virtual void OnResize()
588 /* Adjust the number of items in the matrix depending of the resize */
589 this->vscroll->SetCapacityFromWidget(this, WID_DPI_MATRIX_WIDGET);
592 virtual void OnPlaceObject(Point pt, TileIndex tile)
594 bool success = true;
595 /* We do not need to protect ourselves against "Random Many Industries" in this mode */
596 const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);
597 uint32 seed = InteractiveRandom();
599 if (_game_mode == GM_EDITOR) {
600 /* Show error if no town exists at all */
601 if (Town::GetNumItems() == 0) {
602 SetDParam(0, indsp->name);
603 ShowErrorMessage(STR_ERROR_CAN_T_BUILD_HERE, STR_ERROR_MUST_FOUND_TOWN_FIRST, WL_INFO, pt.x, pt.y);
604 return;
607 Backup<CompanyByte> cur_company(_current_company, OWNER_NONE, FILE_LINE);
608 _generating_world = true;
609 _ignore_restrictions = true;
611 DoCommandP(tile, (InteractiveRandomRange(indsp->num_table) << 8) | this->selected_type, seed,
612 CMD_BUILD_INDUSTRY | CMD_MSG(STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY), &CcBuildIndustry);
614 cur_company.Restore();
615 _ignore_restrictions = false;
616 _generating_world = false;
617 } else {
618 success = DoCommandP(tile, (InteractiveRandomRange(indsp->num_table) << 8) | this->selected_type, seed, CMD_BUILD_INDUSTRY | CMD_MSG(STR_ERROR_CAN_T_CONSTRUCT_THIS_INDUSTRY));
621 /* If an industry has been built, just reset the cursor and the system */
622 if (success && !_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
625 virtual void OnTick()
627 if (_pause_mode != PM_UNPAUSED) return;
628 if (!this->timer_enabled) return;
629 if (--this->callback_timer == 0) {
630 /* We have just passed another day.
631 * See if we need to update availability of currently selected industry */
632 this->callback_timer = DAY_TICKS; // restart counter
634 const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);
636 if (indsp->enabled) {
637 bool call_back_result = GetIndustryProbabilityCallback(this->selected_type, IACT_USERCREATION, 1) > 0;
639 /* Only if result does match the previous state would it require a redraw. */
640 if (call_back_result != this->enabled[this->selected_index]) {
641 this->enabled[this->selected_index] = call_back_result;
642 this->SetButtons();
643 this->SetDirty();
649 virtual void OnTimeout()
651 this->RaiseButtons();
654 virtual void OnPlaceObjectAbort()
656 this->RaiseButtons();
660 * Some data on this window has become invalid.
661 * @param data Information about the changed data.
662 * @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.
664 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
666 if (!gui_scope) return;
667 this->SetupArrays();
669 const IndustrySpec *indsp = (this->selected_type == INVALID_INDUSTRYTYPE) ? NULL : GetIndustrySpec(this->selected_type);
670 if (indsp == NULL) this->enabled[this->selected_index] = _settings_game.difficulty.industry_density != ID_FUND_ONLY;
671 this->SetButtons();
675 void ShowBuildIndustryWindow()
677 if (_game_mode != GM_EDITOR && !Company::IsValidID(_local_company)) return;
678 if (BringWindowToFrontById(WC_BUILD_INDUSTRY, 0)) return;
679 new BuildIndustryWindow();
682 static void UpdateIndustryProduction(Industry *i);
684 static inline bool IsProductionAlterable(const Industry *i)
686 const IndustrySpec *is = GetIndustrySpec(i->type);
687 return ((_game_mode == GM_EDITOR || _cheats.setup_prod.value) &&
688 (is->production_rate[0] != 0 || is->production_rate[1] != 0 || is->IsRawIndustry()) &&
689 !_networking);
692 class IndustryViewWindow : public Window
694 /** Modes for changing production */
695 enum Editability {
696 EA_NONE, ///< Not alterable
697 EA_MULTIPLIER, ///< Allow changing the production multiplier
698 EA_RATE, ///< Allow changing the production rates
701 /** Specific lines in the info panel */
702 enum InfoLine {
703 IL_NONE, ///< No line
704 IL_MULTIPLIER, ///< Production multiplier
705 IL_RATE1, ///< Production rate of cargo 1
706 IL_RATE2, ///< Production rate of cargo 2
709 Editability editable; ///< Mode for changing production
710 InfoLine editbox_line; ///< The line clicked to open the edit box
711 InfoLine clicked_line; ///< The line of the button that has been clicked
712 byte clicked_button; ///< The button that has been clicked (to raise)
713 int production_offset_y; ///< The offset of the production texts/buttons
714 int info_height; ///< Height needed for the #WID_IV_INFO panel
716 public:
717 IndustryViewWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
719 this->flags |= WF_DISABLE_VP_SCROLL;
720 this->editbox_line = IL_NONE;
721 this->clicked_line = IL_NONE;
722 this->clicked_button = 0;
723 this->info_height = WD_FRAMERECT_TOP + 2 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM + 1; // Info panel has at least two lines text.
725 this->InitNested(window_number);
726 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_IV_VIEWPORT);
727 nvp->InitializeViewport(this, Industry::Get(window_number)->location.GetCenterTile(), ZOOM_LVL_INDUSTRY);
729 this->InvalidateData();
732 virtual void OnPaint()
734 this->DrawWidgets();
736 if (this->IsShaded()) return; // Don't draw anything when the window is shaded.
738 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_IV_INFO);
739 uint expected = this->DrawInfo(nwi->pos_x, nwi->pos_x + nwi->current_x - 1, nwi->pos_y) - nwi->pos_y;
740 if (expected > nwi->current_y - 1) {
741 this->info_height = expected + 1;
742 this->ReInit();
743 return;
748 * Draw the text in the #WID_IV_INFO panel.
749 * @param left Left edge of the panel.
750 * @param right Right edge of the panel.
751 * @param top Top edge of the panel.
752 * @return Expected position of the bottom edge of the panel.
754 int DrawInfo(uint left, uint right, uint top)
756 Industry *i = Industry::Get(this->window_number);
757 const IndustrySpec *ind = GetIndustrySpec(i->type);
758 int y = top + WD_FRAMERECT_TOP;
759 bool first = true;
760 bool has_accept = false;
762 if (i->prod_level == PRODLEVEL_CLOSURE) {
763 DrawString(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_INDUSTRY_ANNOUNCED_CLOSURE);
764 y += 2 * FONT_HEIGHT_NORMAL;
767 CargoSuffix cargo_suffix[3];
768 GetAllCargoSuffixes(0, CST_VIEW, i, i->type, ind, i->accepts_cargo, cargo_suffix);
769 bool stockpiling = HasBit(ind->callback_mask, CBM_IND_PRODUCTION_CARGO_ARRIVAL) || HasBit(ind->callback_mask, CBM_IND_PRODUCTION_256_TICKS);
771 uint left_side = left + WD_FRAMERECT_LEFT * 4; // Indent accepted cargoes.
772 for (byte j = 0; j < lengthof(i->accepts_cargo); j++) {
773 if (i->accepts_cargo[j] == CT_INVALID) continue;
774 has_accept = true;
775 if (first) {
776 DrawString(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_REQUIRES);
777 y += FONT_HEIGHT_NORMAL;
778 first = false;
780 switch (cargo_suffix[j].display) {
781 case CSD_CARGO_AMOUNT:
782 if (stockpiling) {
783 SetDParam(0, i->accepts_cargo[j]);
784 SetDParam(1, i->incoming_cargo_waiting[j]);
785 DrawString(left_side, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_ACCEPT_CARGO_AMOUNT);
786 break;
788 FALLTHROUGH;
790 case CSD_CARGO:
791 SetDParam(0, CargoSpec::Get(i->accepts_cargo[j])->name);
792 DrawString(left_side, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_ACCEPT_CARGO);
793 break;
795 case CSD_CARGO_TEXT:
796 SetDParam(0, CargoSpec::Get(i->accepts_cargo[j])->name);
797 SetDParamStr(1, cargo_suffix[j].text);
798 DrawString(left_side, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_ACCEPT_CARGO_TEXT);
799 break;
801 case CSD_CARGO_AMOUNT_TEXT:
802 SetDParam(0, i->accepts_cargo[j]);
803 SetDParam(1, i->incoming_cargo_waiting[j]);
804 SetDParamStr(2, cargo_suffix[j].text);
805 DrawString(left_side, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_ACCEPT_CARGO_AMOUNT_TEXT);
806 break;
808 default:
809 NOT_REACHED();
811 y += FONT_HEIGHT_NORMAL;
814 GetAllCargoSuffixes(3, CST_VIEW, i, i->type, ind, i->produced_cargo, cargo_suffix);
815 first = true;
816 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
817 if (i->produced_cargo[j] == CT_INVALID) continue;
818 if (first) {
819 if (has_accept) y += WD_PAR_VSEP_WIDE;
820 DrawString(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_PRODUCTION_LAST_MONTH_TITLE);
821 y += FONT_HEIGHT_NORMAL;
822 if (this->editable == EA_RATE) this->production_offset_y = y;
823 first = false;
826 SetDParam(0, i->produced_cargo[j]);
827 SetDParam(1, i->last_month_production[j]);
828 SetDParamStr(2, cargo_suffix[j].text);
829 SetDParam(3, ToPercent8(i->last_month_pct_transported[j]));
830 uint x = left + WD_FRAMETEXT_LEFT + (this->editable == EA_RATE ? SETTING_BUTTON_WIDTH + 10 : 0);
831 DrawString(x, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_TRANSPORTED);
832 /* Let's put out those buttons.. */
833 if (this->editable == EA_RATE) {
834 DrawArrowButtons(left + WD_FRAMETEXT_LEFT, y, COLOUR_YELLOW, (this->clicked_line == IL_RATE1 + j) ? this->clicked_button : 0,
835 i->production_rate[j] > 0, i->production_rate[j] < 255);
837 y += FONT_HEIGHT_NORMAL;
840 /* Display production multiplier if editable */
841 if (this->editable == EA_MULTIPLIER) {
842 y += WD_PAR_VSEP_WIDE;
843 this->production_offset_y = y;
844 SetDParam(0, RoundDivSU(i->prod_level * 100, PRODLEVEL_DEFAULT));
845 uint x = left + WD_FRAMETEXT_LEFT + SETTING_BUTTON_WIDTH + 10;
846 DrawString(x, right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_VIEW_PRODUCTION_LEVEL);
847 DrawArrowButtons(left + WD_FRAMETEXT_LEFT, y, COLOUR_YELLOW, (this->clicked_line == IL_MULTIPLIER) ? this->clicked_button : 0,
848 i->prod_level > PRODLEVEL_MINIMUM, i->prod_level < PRODLEVEL_MAXIMUM);
849 y += FONT_HEIGHT_NORMAL;
852 /* Get the extra message for the GUI */
853 if (HasBit(ind->callback_mask, CBM_IND_WINDOW_MORE_TEXT)) {
854 uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_WINDOW_MORE_TEXT, 0, 0, i, i->type, i->location.tile);
855 if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
856 if (callback_res > 0x400) {
857 ErrorUnknownCallbackResult(ind->grf_prop.grffile->grfid, CBID_INDUSTRY_WINDOW_MORE_TEXT, callback_res);
858 } else {
859 StringID message = GetGRFStringID(ind->grf_prop.grffile->grfid, 0xD000 + callback_res);
860 if (message != STR_NULL && message != STR_UNDEFINED) {
861 y += WD_PAR_VSEP_WIDE;
863 StartTextRefStackUsage(ind->grf_prop.grffile, 6);
864 /* Use all the available space left from where we stand up to the
865 * end of the window. We ALSO enlarge the window if needed, so we
866 * can 'go' wild with the bottom of the window. */
867 y = DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, UINT16_MAX, message, TC_BLACK);
868 StopTextRefStackUsage();
873 return y + WD_FRAMERECT_BOTTOM;
876 virtual void SetStringParameters(int widget) const
878 if (widget == WID_IV_CAPTION) SetDParam(0, this->window_number);
881 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
883 if (widget == WID_IV_INFO) size->height = this->info_height;
886 virtual void OnClick(Point pt, int widget, int click_count)
888 switch (widget) {
889 case WID_IV_INFO: {
890 Industry *i = Industry::Get(this->window_number);
891 InfoLine line = IL_NONE;
893 switch (this->editable) {
894 case EA_NONE: break;
896 case EA_MULTIPLIER:
897 if (IsInsideBS(pt.y, this->production_offset_y, FONT_HEIGHT_NORMAL)) line = IL_MULTIPLIER;
898 break;
900 case EA_RATE:
901 if (pt.y >= this->production_offset_y) {
902 int row = (pt.y - this->production_offset_y) / FONT_HEIGHT_NORMAL;
903 for (uint j = 0; j < lengthof(i->produced_cargo); j++) {
904 if (i->produced_cargo[j] == CT_INVALID) continue;
905 row--;
906 if (row < 0) {
907 line = (InfoLine)(IL_RATE1 + j);
908 break;
912 break;
914 if (line == IL_NONE) return;
916 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(widget);
917 int left = nwi->pos_x + WD_FRAMETEXT_LEFT;
918 int right = nwi->pos_x + nwi->current_x - 1 - WD_FRAMERECT_RIGHT;
919 if (IsInsideMM(pt.x, left, left + SETTING_BUTTON_WIDTH)) {
920 /* Clicked buttons, decrease or increase production */
921 byte button = (pt.x < left + SETTING_BUTTON_WIDTH / 2) ? 1 : 2;
922 switch (this->editable) {
923 case EA_MULTIPLIER:
924 if (button == 1) {
925 if (i->prod_level <= PRODLEVEL_MINIMUM) return;
926 i->prod_level = max<uint>(i->prod_level / 2, PRODLEVEL_MINIMUM);
927 } else {
928 if (i->prod_level >= PRODLEVEL_MAXIMUM) return;
929 i->prod_level = minu(i->prod_level * 2, PRODLEVEL_MAXIMUM);
931 break;
933 case EA_RATE:
934 if (button == 1) {
935 if (i->production_rate[line - IL_RATE1] <= 0) return;
936 i->production_rate[line - IL_RATE1] = max(i->production_rate[line - IL_RATE1] / 2, 0);
937 } else {
938 if (i->production_rate[line - IL_RATE1] >= 255) return;
939 /* a zero production industry is unlikely to give anything but zero, so push it a little bit */
940 int new_prod = i->production_rate[line - IL_RATE1] == 0 ? 1 : i->production_rate[line - IL_RATE1] * 2;
941 i->production_rate[line - IL_RATE1] = minu(new_prod, 255);
943 break;
945 default: NOT_REACHED();
948 UpdateIndustryProduction(i);
949 this->SetDirty();
950 this->SetTimeout();
951 this->clicked_line = line;
952 this->clicked_button = button;
953 } else if (IsInsideMM(pt.x, left + SETTING_BUTTON_WIDTH + 10, right)) {
954 /* clicked the text */
955 this->editbox_line = line;
956 switch (this->editable) {
957 case EA_MULTIPLIER:
958 SetDParam(0, RoundDivSU(i->prod_level * 100, PRODLEVEL_DEFAULT));
959 ShowQueryString(STR_JUST_INT, STR_CONFIG_GAME_PRODUCTION_LEVEL, 10, this, CS_ALPHANUMERAL, QSF_NONE);
960 break;
962 case EA_RATE:
963 SetDParam(0, i->production_rate[line - IL_RATE1] * 8);
964 ShowQueryString(STR_JUST_INT, STR_CONFIG_GAME_PRODUCTION, 10, this, CS_ALPHANUMERAL, QSF_NONE);
965 break;
967 default: NOT_REACHED();
970 break;
973 case WID_IV_GOTO: {
974 Industry *i = Industry::Get(this->window_number);
975 if (_ctrl_pressed) {
976 ShowExtraViewPortWindow(i->location.GetCenterTile());
977 } else {
978 ScrollMainWindowToTile(i->location.GetCenterTile());
980 break;
983 case WID_IV_DISPLAY: {
984 Industry *i = Industry::Get(this->window_number);
985 ShowIndustryCargoesWindow(i->type);
986 break;
991 virtual void OnTimeout()
993 this->clicked_line = IL_NONE;
994 this->clicked_button = 0;
995 this->SetDirty();
998 virtual void OnResize()
1000 if (this->viewport != NULL) {
1001 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_IV_VIEWPORT);
1002 nvp->UpdateViewportCoordinates(this);
1004 ScrollWindowToTile(Industry::Get(this->window_number)->location.GetCenterTile(), this, true); // Re-center viewport.
1008 virtual void OnQueryTextFinished(char *str)
1010 if (StrEmpty(str)) return;
1012 Industry *i = Industry::Get(this->window_number);
1013 uint value = atoi(str);
1014 switch (this->editbox_line) {
1015 case IL_NONE: NOT_REACHED();
1017 case IL_MULTIPLIER:
1018 i->prod_level = ClampU(RoundDivSU(value * PRODLEVEL_DEFAULT, 100), PRODLEVEL_MINIMUM, PRODLEVEL_MAXIMUM);
1019 break;
1021 default:
1022 i->production_rate[this->editbox_line - IL_RATE1] = ClampU(RoundDivSU(value, 8), 0, 255);
1023 break;
1025 UpdateIndustryProduction(i);
1026 this->SetDirty();
1030 * Some data on this window has become invalid.
1031 * @param data Information about the changed data.
1032 * @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.
1034 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
1036 if (!gui_scope) return;
1037 const Industry *i = Industry::Get(this->window_number);
1038 if (IsProductionAlterable(i)) {
1039 const IndustrySpec *ind = GetIndustrySpec(i->type);
1040 this->editable = ind->UsesSmoothEconomy() ? EA_RATE : EA_MULTIPLIER;
1041 } else {
1042 this->editable = EA_NONE;
1046 virtual bool IsNewGRFInspectable() const
1048 return ::IsNewGRFInspectable(GSF_INDUSTRIES, this->window_number);
1051 virtual void ShowNewGRFInspectWindow() const
1053 ::ShowNewGRFInspectWindow(GSF_INDUSTRIES, this->window_number);
1057 static void UpdateIndustryProduction(Industry *i)
1059 const IndustrySpec *indspec = GetIndustrySpec(i->type);
1060 if (!indspec->UsesSmoothEconomy()) i->RecomputeProductionMultipliers();
1062 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
1063 if (i->produced_cargo[j] != CT_INVALID) {
1064 i->last_month_production[j] = 8 * i->production_rate[j];
1069 /** Widget definition of the view industry gui */
1070 static const NWidgetPart _nested_industry_view_widgets[] = {
1071 NWidget(NWID_HORIZONTAL),
1072 NWidget(WWT_CLOSEBOX, COLOUR_CREAM),
1073 NWidget(WWT_CAPTION, COLOUR_CREAM, WID_IV_CAPTION), SetDataTip(STR_INDUSTRY_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1074 NWidget(WWT_DEBUGBOX, COLOUR_CREAM),
1075 NWidget(WWT_SHADEBOX, COLOUR_CREAM),
1076 NWidget(WWT_DEFSIZEBOX, COLOUR_CREAM),
1077 NWidget(WWT_STICKYBOX, COLOUR_CREAM),
1078 EndContainer(),
1079 NWidget(WWT_PANEL, COLOUR_CREAM),
1080 NWidget(WWT_INSET, COLOUR_CREAM), SetPadding(2, 2, 2, 2),
1081 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_IV_VIEWPORT), SetMinimalSize(254, 86), SetFill(1, 0), SetPadding(1, 1, 1, 1), SetResize(1, 1),
1082 EndContainer(),
1083 EndContainer(),
1084 NWidget(WWT_PANEL, COLOUR_CREAM, WID_IV_INFO), SetMinimalSize(260, 2), SetResize(1, 0),
1085 EndContainer(),
1086 NWidget(NWID_HORIZONTAL),
1087 NWidget(WWT_PUSHTXTBTN, COLOUR_CREAM, WID_IV_GOTO), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_BUTTON_LOCATION, STR_INDUSTRY_VIEW_LOCATION_TOOLTIP),
1088 NWidget(WWT_PUSHTXTBTN, COLOUR_CREAM, WID_IV_DISPLAY), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_INDUSTRY_DISPLAY_CHAIN, STR_INDUSTRY_DISPLAY_CHAIN_TOOLTIP),
1089 NWidget(WWT_RESIZEBOX, COLOUR_CREAM),
1090 EndContainer(),
1093 /** Window definition of the view industry gui */
1094 static WindowDesc _industry_view_desc(
1095 WDP_AUTO, "view_industry", 260, 120,
1096 WC_INDUSTRY_VIEW, WC_NONE,
1098 _nested_industry_view_widgets, lengthof(_nested_industry_view_widgets)
1101 void ShowIndustryViewWindow(int industry)
1103 AllocateWindowDescFront<IndustryViewWindow>(&_industry_view_desc, industry);
1106 /** Widget definition of the industry directory gui */
1107 static const NWidgetPart _nested_industry_directory_widgets[] = {
1108 NWidget(NWID_HORIZONTAL),
1109 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1110 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_INDUSTRY_DIRECTORY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1111 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1112 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1113 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1114 EndContainer(),
1115 NWidget(NWID_HORIZONTAL),
1116 NWidget(NWID_VERTICAL),
1117 NWidget(NWID_HORIZONTAL),
1118 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_ID_DROPDOWN_ORDER), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
1119 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_ID_DROPDOWN_CRITERIA), SetDataTip(STR_JUST_STRING, STR_TOOLTIP_SORT_CRITERIA),
1120 NWidget(WWT_PANEL, COLOUR_BROWN), SetResize(1, 0), EndContainer(),
1121 EndContainer(),
1122 NWidget(WWT_PANEL, COLOUR_BROWN, WID_ID_INDUSTRY_LIST), SetDataTip(0x0, STR_INDUSTRY_DIRECTORY_LIST_CAPTION), SetResize(1, 1), SetScrollbar(WID_ID_SCROLLBAR), EndContainer(),
1123 EndContainer(),
1124 NWidget(NWID_VERTICAL),
1125 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_ID_SCROLLBAR),
1126 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1127 EndContainer(),
1128 EndContainer(),
1131 typedef GUIList<const Industry*> GUIIndustryList;
1135 * The list of industries.
1137 class IndustryDirectoryWindow : public Window {
1138 protected:
1139 /* Runtime saved values */
1140 static Listing last_sorting;
1141 static const Industry *last_industry;
1143 /* Constants for sorting stations */
1144 static const StringID sorter_names[];
1145 static GUIIndustryList::SortFunction * const sorter_funcs[];
1147 GUIIndustryList industries;
1148 Scrollbar *vscroll;
1150 /** (Re)Build industries list */
1151 void BuildSortIndustriesList()
1153 if (this->industries.NeedRebuild()) {
1154 this->industries.Clear();
1156 const Industry *i;
1157 FOR_ALL_INDUSTRIES(i) {
1158 *this->industries.Append() = i;
1161 this->industries.Compact();
1162 this->industries.RebuildDone();
1163 this->vscroll->SetCount(this->industries.Length()); // Update scrollbar as well.
1166 if (!this->industries.Sort()) return;
1167 IndustryDirectoryWindow::last_industry = NULL; // Reset name sorter sort cache
1168 this->SetWidgetDirty(WID_ID_INDUSTRY_LIST); // Set the modified widget dirty
1172 * Returns percents of cargo transported if industry produces this cargo, else -1
1174 * @param i industry to check
1175 * @param id cargo slot
1176 * @return percents of cargo transported, or -1 if industry doesn't use this cargo slot
1178 static inline int GetCargoTransportedPercentsIfValid(const Industry *i, uint id)
1180 assert(id < lengthof(i->produced_cargo));
1182 if (i->produced_cargo[id] == CT_INVALID) return 101;
1183 return ToPercent8(i->last_month_pct_transported[id]);
1187 * Returns value representing industry's transported cargo
1188 * percentage for industry sorting
1190 * @param i industry to check
1191 * @return value used for sorting
1193 static int GetCargoTransportedSortValue(const Industry *i)
1195 int p1 = GetCargoTransportedPercentsIfValid(i, 0);
1196 int p2 = GetCargoTransportedPercentsIfValid(i, 1);
1198 if (p1 > p2) Swap(p1, p2); // lower value has higher priority
1200 return (p1 << 8) + p2;
1203 /** Sort industries by name */
1204 static int CDECL IndustryNameSorter(const Industry * const *a, const Industry * const *b)
1206 static char buf_cache[96];
1207 static char buf[96];
1209 SetDParam(0, (*a)->index);
1210 GetString(buf, STR_INDUSTRY_NAME, lastof(buf));
1212 if (*b != last_industry) {
1213 last_industry = *b;
1214 SetDParam(0, (*b)->index);
1215 GetString(buf_cache, STR_INDUSTRY_NAME, lastof(buf_cache));
1218 return strnatcmp(buf, buf_cache); // Sort by name (natural sorting).
1221 /** Sort industries by type and name */
1222 static int CDECL IndustryTypeSorter(const Industry * const *a, const Industry * const *b)
1224 int it_a = 0;
1225 while (it_a != NUM_INDUSTRYTYPES && (*a)->type != _sorted_industry_types[it_a]) it_a++;
1226 int it_b = 0;
1227 while (it_b != NUM_INDUSTRYTYPES && (*b)->type != _sorted_industry_types[it_b]) it_b++;
1228 int r = it_a - it_b;
1229 return (r == 0) ? IndustryNameSorter(a, b) : r;
1232 /** Sort industries by production and name */
1233 static int CDECL IndustryProductionSorter(const Industry * const *a, const Industry * const *b)
1235 uint prod_a = 0, prod_b = 0;
1236 for (uint i = 0; i < lengthof((*a)->produced_cargo); i++) {
1237 if ((*a)->produced_cargo[i] != CT_INVALID) prod_a += (*a)->last_month_production[i];
1238 if ((*b)->produced_cargo[i] != CT_INVALID) prod_b += (*b)->last_month_production[i];
1240 int r = prod_a - prod_b;
1242 return (r == 0) ? IndustryTypeSorter(a, b) : r;
1245 /** Sort industries by transported cargo and name */
1246 static int CDECL IndustryTransportedCargoSorter(const Industry * const *a, const Industry * const *b)
1248 int r = GetCargoTransportedSortValue(*a) - GetCargoTransportedSortValue(*b);
1249 return (r == 0) ? IndustryNameSorter(a, b) : r;
1253 * Get the StringID to draw and set the appropriate DParams.
1254 * @param i the industry to get the StringID of.
1255 * @return the StringID.
1257 StringID GetIndustryString(const Industry *i) const
1259 const IndustrySpec *indsp = GetIndustrySpec(i->type);
1260 byte p = 0;
1262 /* Industry name */
1263 SetDParam(p++, i->index);
1265 static CargoSuffix cargo_suffix[lengthof(i->produced_cargo)];
1266 GetAllCargoSuffixes(3, CST_DIR, i, i->type, indsp, i->produced_cargo, cargo_suffix);
1268 /* Industry productions */
1269 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
1270 if (i->produced_cargo[j] == CT_INVALID) continue;
1271 SetDParam(p++, i->produced_cargo[j]);
1272 SetDParam(p++, i->last_month_production[j]);
1273 SetDParamStr(p++, cargo_suffix[j].text);
1276 /* Transported productions */
1277 for (byte j = 0; j < lengthof(i->produced_cargo); j++) {
1278 if (i->produced_cargo[j] == CT_INVALID) continue;
1279 SetDParam(p++, ToPercent8(i->last_month_pct_transported[j]));
1282 /* Drawing the right string */
1283 switch (p) {
1284 case 1: return STR_INDUSTRY_DIRECTORY_ITEM_NOPROD;
1285 case 5: return STR_INDUSTRY_DIRECTORY_ITEM;
1286 default: return STR_INDUSTRY_DIRECTORY_ITEM_TWO;
1290 public:
1291 IndustryDirectoryWindow(WindowDesc *desc, WindowNumber number) : Window(desc)
1293 this->CreateNestedTree();
1294 this->vscroll = this->GetScrollbar(WID_ID_SCROLLBAR);
1296 this->industries.SetListing(this->last_sorting);
1297 this->industries.SetSortFuncs(IndustryDirectoryWindow::sorter_funcs);
1298 this->industries.ForceRebuild();
1299 this->BuildSortIndustriesList();
1301 this->FinishInitNested(0);
1304 ~IndustryDirectoryWindow()
1306 this->last_sorting = this->industries.GetListing();
1309 virtual void SetStringParameters(int widget) const
1311 if (widget == WID_ID_DROPDOWN_CRITERIA) SetDParam(0, IndustryDirectoryWindow::sorter_names[this->industries.SortType()]);
1314 virtual void DrawWidget(const Rect &r, int widget) const
1316 switch (widget) {
1317 case WID_ID_DROPDOWN_ORDER:
1318 this->DrawSortButtonState(widget, this->industries.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
1319 break;
1321 case WID_ID_INDUSTRY_LIST: {
1322 int n = 0;
1323 int y = r.top + WD_FRAMERECT_TOP;
1324 if (this->industries.Length() == 0) {
1325 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_INDUSTRY_DIRECTORY_NONE);
1326 break;
1328 for (uint i = this->vscroll->GetPosition(); i < this->industries.Length(); i++) {
1329 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, this->GetIndustryString(this->industries[i]));
1331 y += this->resize.step_height;
1332 if (++n == this->vscroll->GetCapacity()) break; // max number of industries in 1 window
1334 break;
1339 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
1341 switch (widget) {
1342 case WID_ID_DROPDOWN_ORDER: {
1343 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
1344 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
1345 d.height += padding.height;
1346 *size = maxdim(*size, d);
1347 break;
1350 case WID_ID_DROPDOWN_CRITERIA: {
1351 Dimension d = {0, 0};
1352 for (uint i = 0; IndustryDirectoryWindow::sorter_names[i] != INVALID_STRING_ID; i++) {
1353 d = maxdim(d, GetStringBoundingBox(IndustryDirectoryWindow::sorter_names[i]));
1355 d.width += padding.width;
1356 d.height += padding.height;
1357 *size = maxdim(*size, d);
1358 break;
1361 case WID_ID_INDUSTRY_LIST: {
1362 Dimension d = GetStringBoundingBox(STR_INDUSTRY_DIRECTORY_NONE);
1363 for (uint i = 0; i < this->industries.Length(); i++) {
1364 d = maxdim(d, GetStringBoundingBox(this->GetIndustryString(this->industries[i])));
1366 resize->height = d.height;
1367 d.height *= 5;
1368 d.width += padding.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
1369 d.height += padding.height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
1370 *size = maxdim(*size, d);
1371 break;
1377 virtual void OnClick(Point pt, int widget, int click_count)
1379 switch (widget) {
1380 case WID_ID_DROPDOWN_ORDER:
1381 this->industries.ToggleSortOrder();
1382 this->SetDirty();
1383 break;
1385 case WID_ID_DROPDOWN_CRITERIA:
1386 ShowDropDownMenu(this, IndustryDirectoryWindow::sorter_names, this->industries.SortType(), WID_ID_DROPDOWN_CRITERIA, 0, 0);
1387 break;
1389 case WID_ID_INDUSTRY_LIST: {
1390 uint p = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_ID_INDUSTRY_LIST, WD_FRAMERECT_TOP);
1391 if (p < this->industries.Length()) {
1392 if (_ctrl_pressed) {
1393 ShowExtraViewPortWindow(this->industries[p]->location.tile);
1394 } else {
1395 ScrollMainWindowToTile(this->industries[p]->location.tile);
1398 break;
1403 virtual void OnDropdownSelect(int widget, int index)
1405 if (this->industries.SortType() != index) {
1406 this->industries.SetSortType(index);
1407 this->BuildSortIndustriesList();
1411 virtual void OnResize()
1413 this->vscroll->SetCapacityFromWidget(this, WID_ID_INDUSTRY_LIST);
1416 virtual void OnPaint()
1418 if (this->industries.NeedRebuild()) this->BuildSortIndustriesList();
1419 this->DrawWidgets();
1422 virtual void OnHundredthTick()
1424 this->industries.ForceResort();
1425 this->BuildSortIndustriesList();
1429 * Some data on this window has become invalid.
1430 * @param data Information about the changed data.
1431 * @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.
1433 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
1435 if (data == 0) {
1436 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
1437 this->industries.ForceRebuild();
1438 } else {
1439 this->industries.ForceResort();
1444 Listing IndustryDirectoryWindow::last_sorting = {false, 0};
1445 const Industry *IndustryDirectoryWindow::last_industry = NULL;
1447 /* Available station sorting functions. */
1448 GUIIndustryList::SortFunction * const IndustryDirectoryWindow::sorter_funcs[] = {
1449 &IndustryNameSorter,
1450 &IndustryTypeSorter,
1451 &IndustryProductionSorter,
1452 &IndustryTransportedCargoSorter
1455 /* Names of the sorting functions */
1456 const StringID IndustryDirectoryWindow::sorter_names[] = {
1457 STR_SORT_BY_NAME,
1458 STR_SORT_BY_TYPE,
1459 STR_SORT_BY_PRODUCTION,
1460 STR_SORT_BY_TRANSPORTED,
1461 INVALID_STRING_ID
1465 /** Window definition of the industry directory gui */
1466 static WindowDesc _industry_directory_desc(
1467 WDP_AUTO, "list_industries", 428, 190,
1468 WC_INDUSTRY_DIRECTORY, WC_NONE,
1470 _nested_industry_directory_widgets, lengthof(_nested_industry_directory_widgets)
1473 void ShowIndustryDirectory()
1475 AllocateWindowDescFront<IndustryDirectoryWindow>(&_industry_directory_desc, 0);
1478 /** Widgets of the industry cargoes window. */
1479 static const NWidgetPart _nested_industry_cargoes_widgets[] = {
1480 NWidget(NWID_HORIZONTAL),
1481 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1482 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_IC_CAPTION), SetDataTip(STR_INDUSTRY_CARGOES_INDUSTRY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1483 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1484 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1485 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1486 EndContainer(),
1487 NWidget(NWID_HORIZONTAL),
1488 NWidget(NWID_VERTICAL),
1489 NWidget(WWT_PANEL, COLOUR_BROWN, WID_IC_PANEL), SetResize(1, 10), SetMinimalSize(200, 90), SetScrollbar(WID_IC_SCROLLBAR), EndContainer(),
1490 NWidget(NWID_HORIZONTAL),
1491 NWidget(WWT_TEXTBTN, COLOUR_BROWN, WID_IC_NOTIFY),
1492 SetDataTip(STR_INDUSTRY_CARGOES_NOTIFY_SMALLMAP, STR_INDUSTRY_CARGOES_NOTIFY_SMALLMAP_TOOLTIP),
1493 NWidget(WWT_PANEL, COLOUR_BROWN), SetFill(1, 0), SetResize(0, 0), EndContainer(),
1494 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_IC_IND_DROPDOWN), SetFill(0, 0), SetResize(0, 0),
1495 SetDataTip(STR_INDUSTRY_CARGOES_SELECT_INDUSTRY, STR_INDUSTRY_CARGOES_SELECT_INDUSTRY_TOOLTIP),
1496 NWidget(WWT_DROPDOWN, COLOUR_BROWN, WID_IC_CARGO_DROPDOWN), SetFill(0, 0), SetResize(0, 0),
1497 SetDataTip(STR_INDUSTRY_CARGOES_SELECT_CARGO, STR_INDUSTRY_CARGOES_SELECT_CARGO_TOOLTIP),
1498 EndContainer(),
1499 EndContainer(),
1500 NWidget(NWID_VERTICAL),
1501 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_IC_SCROLLBAR),
1502 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1503 EndContainer(),
1504 EndContainer(),
1507 /** Window description for the industry cargoes window. */
1508 static WindowDesc _industry_cargoes_desc(
1509 WDP_AUTO, "industry_cargoes", 300, 210,
1510 WC_INDUSTRY_CARGOES, WC_NONE,
1512 _nested_industry_cargoes_widgets, lengthof(_nested_industry_cargoes_widgets)
1515 /** Available types of field. */
1516 enum CargoesFieldType {
1517 CFT_EMPTY, ///< Empty field.
1518 CFT_SMALL_EMPTY, ///< Empty small field (for the header).
1519 CFT_INDUSTRY, ///< Display industry.
1520 CFT_CARGO, ///< Display cargo connections.
1521 CFT_CARGO_LABEL, ///< Display cargo labels.
1522 CFT_HEADER, ///< Header text.
1525 static const uint MAX_CARGOES = 3; ///< Maximum number of cargoes carried in a #CFT_CARGO field in #CargoesField.
1527 /** Data about a single field in the #IndustryCargoesWindow panel. */
1528 struct CargoesField {
1529 static const int VERT_INTER_INDUSTRY_SPACE;
1530 static const int HOR_CARGO_BORDER_SPACE;
1531 static const int CARGO_STUB_WIDTH;
1532 static const int HOR_CARGO_WIDTH, HOR_CARGO_SPACE;
1533 static const int CARGO_FIELD_WIDTH;
1534 static const int VERT_CARGO_SPACE, VERT_CARGO_EDGE;
1535 static const int BLOB_DISTANCE, BLOB_WIDTH, BLOB_HEIGHT;
1537 static const int INDUSTRY_LINE_COLOUR;
1538 static const int CARGO_LINE_COLOUR;
1540 static int small_height, normal_height;
1541 static int industry_width;
1543 CargoesFieldType type; ///< Type of field.
1544 union {
1545 struct {
1546 IndustryType ind_type; ///< Industry type (#NUM_INDUSTRYTYPES means 'houses').
1547 CargoID other_produced[MAX_CARGOES]; ///< Cargoes produced but not used in this figure.
1548 CargoID other_accepted[MAX_CARGOES]; ///< Cargoes accepted but not used in this figure.
1549 } industry; ///< Industry data (for #CFT_INDUSTRY).
1550 struct {
1551 CargoID vertical_cargoes[MAX_CARGOES]; ///< Cargoes running from top to bottom (cargo ID or #INVALID_CARGO).
1552 byte num_cargoes; ///< Number of cargoes.
1553 CargoID supp_cargoes[MAX_CARGOES]; ///< Cargoes entering from the left (index in #vertical_cargoes, or #INVALID_CARGO).
1554 byte top_end; ///< Stop at the top of the vertical cargoes.
1555 CargoID cust_cargoes[MAX_CARGOES]; ///< Cargoes leaving to the right (index in #vertical_cargoes, or #INVALID_CARGO).
1556 byte bottom_end; ///< Stop at the bottom of the vertical cargoes.
1557 } cargo; ///< Cargo data (for #CFT_CARGO).
1558 struct {
1559 CargoID cargoes[MAX_CARGOES]; ///< Cargoes to display (or #INVALID_CARGO).
1560 bool left_align; ///< Align all cargo texts to the left (else align to the right).
1561 } cargo_label; ///< Label data (for #CFT_CARGO_LABEL).
1562 StringID header; ///< Header text (for #CFT_HEADER).
1563 } u; // Data for each type.
1566 * Make one of the empty fields (#CFT_EMPTY or #CFT_SMALL_EMPTY).
1567 * @param type Type of empty field.
1569 void MakeEmpty(CargoesFieldType type)
1571 this->type = type;
1575 * Make an industry type field.
1576 * @param ind_type Industry type (#NUM_INDUSTRYTYPES means 'houses').
1577 * @note #other_accepted and #other_produced should be filled later.
1579 void MakeIndustry(IndustryType ind_type)
1581 this->type = CFT_INDUSTRY;
1582 this->u.industry.ind_type = ind_type;
1583 MemSetT(this->u.industry.other_accepted, INVALID_CARGO, MAX_CARGOES);
1584 MemSetT(this->u.industry.other_produced, INVALID_CARGO, MAX_CARGOES);
1588 * Connect a cargo from an industry to the #CFT_CARGO column.
1589 * @param cargo Cargo to connect.
1590 * @param produced Cargo is produced (if \c false, cargo is assumed to be accepted).
1591 * @return Horizontal connection index, or \c -1 if not accepted at all.
1593 int ConnectCargo(CargoID cargo, bool producer)
1595 assert(this->type == CFT_CARGO);
1596 if (cargo == INVALID_CARGO) return -1;
1598 /* Find the vertical cargo column carrying the cargo. */
1599 int column = -1;
1600 for (int i = 0; i < this->u.cargo.num_cargoes; i++) {
1601 if (cargo == this->u.cargo.vertical_cargoes[i]) {
1602 column = i;
1603 break;
1606 if (column < 0) return -1;
1608 if (producer) {
1609 assert(this->u.cargo.supp_cargoes[column] == INVALID_CARGO);
1610 this->u.cargo.supp_cargoes[column] = column;
1611 } else {
1612 assert(this->u.cargo.cust_cargoes[column] == INVALID_CARGO);
1613 this->u.cargo.cust_cargoes[column] = column;
1615 return column;
1619 * Does this #CFT_CARGO field have a horizontal connection?
1620 * @return \c true if a horizontal connection exists, \c false otherwise.
1622 bool HasConnection()
1624 assert(this->type == CFT_CARGO);
1626 for (uint i = 0; i < MAX_CARGOES; i++) {
1627 if (this->u.cargo.supp_cargoes[i] != INVALID_CARGO) return true;
1628 if (this->u.cargo.cust_cargoes[i] != INVALID_CARGO) return true;
1630 return false;
1634 * Make a piece of cargo column.
1635 * @param cargoes Array of #CargoID (may contain #INVALID_CARGO).
1636 * @param length Number of cargoes in \a cargoes.
1637 * @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).
1638 * @param top_end This is the first cargo field of this column.
1639 * @param bottom_end This is the last cargo field of this column.
1640 * @note #supp_cargoes and #cust_cargoes should be filled in later.
1642 void MakeCargo(const CargoID *cargoes, uint length, int count = -1, bool top_end = false, bool bottom_end = false)
1644 this->type = CFT_CARGO;
1645 uint i;
1646 uint num = 0;
1647 for (i = 0; i < MAX_CARGOES && i < length; i++) {
1648 if (cargoes[i] != INVALID_CARGO) {
1649 this->u.cargo.vertical_cargoes[num] = cargoes[i];
1650 num++;
1653 this->u.cargo.num_cargoes = (count < 0) ? num : count;
1654 for (; num < MAX_CARGOES; num++) this->u.cargo.vertical_cargoes[num] = INVALID_CARGO;
1655 this->u.cargo.top_end = top_end;
1656 this->u.cargo.bottom_end = bottom_end;
1657 MemSetT(this->u.cargo.supp_cargoes, INVALID_CARGO, MAX_CARGOES);
1658 MemSetT(this->u.cargo.cust_cargoes, INVALID_CARGO, MAX_CARGOES);
1662 * Make a field displaying cargo type names.
1663 * @param cargoes Array of #CargoID (may contain #INVALID_CARGO).
1664 * @param length Number of cargoes in \a cargoes.
1665 * @param left_align ALign texts to the left (else to the right).
1667 void MakeCargoLabel(const CargoID *cargoes, uint length, bool left_align)
1669 this->type = CFT_CARGO_LABEL;
1670 uint i;
1671 for (i = 0; i < MAX_CARGOES && i < length; i++) this->u.cargo_label.cargoes[i] = cargoes[i];
1672 for (; i < MAX_CARGOES; i++) this->u.cargo_label.cargoes[i] = INVALID_CARGO;
1673 this->u.cargo_label.left_align = left_align;
1677 * Make a header above an industry column.
1678 * @param textid Text to display.
1680 void MakeHeader(StringID textid)
1682 this->type = CFT_HEADER;
1683 this->u.header = textid;
1687 * For a #CFT_CARGO, compute the left position of the left-most vertical cargo connection.
1688 * @param xpos Left position of the field.
1689 * @return Left position of the left-most vertical cargo column.
1691 int GetCargoBase(int xpos) const
1693 assert(this->type == CFT_CARGO);
1695 switch (this->u.cargo.num_cargoes) {
1696 case 0: return xpos + CARGO_FIELD_WIDTH / 2;
1697 case 1: return xpos + CARGO_FIELD_WIDTH / 2 - HOR_CARGO_WIDTH / 2;
1698 case 2: return xpos + CARGO_FIELD_WIDTH / 2 - HOR_CARGO_WIDTH - HOR_CARGO_SPACE / 2;
1699 case 3: return xpos + CARGO_FIELD_WIDTH / 2 - HOR_CARGO_WIDTH - HOR_CARGO_SPACE - HOR_CARGO_WIDTH / 2;
1700 default: NOT_REACHED();
1705 * Draw the field.
1706 * @param xpos Position of the left edge.
1707 * @param vpos Position of the top edge.
1709 void Draw(int xpos, int ypos) const
1711 switch (this->type) {
1712 case CFT_EMPTY:
1713 case CFT_SMALL_EMPTY:
1714 break;
1716 case CFT_HEADER:
1717 ypos += (small_height - FONT_HEIGHT_NORMAL) / 2;
1718 DrawString(xpos, xpos + industry_width, ypos, this->u.header, TC_WHITE, SA_HOR_CENTER);
1719 break;
1721 case CFT_INDUSTRY: {
1722 int ypos1 = ypos + VERT_INTER_INDUSTRY_SPACE / 2;
1723 int ypos2 = ypos + normal_height - 1 - VERT_INTER_INDUSTRY_SPACE / 2;
1724 int xpos2 = xpos + industry_width - 1;
1725 GfxDrawLine(xpos, ypos1, xpos2, ypos1, INDUSTRY_LINE_COLOUR);
1726 GfxDrawLine(xpos, ypos1, xpos, ypos2, INDUSTRY_LINE_COLOUR);
1727 GfxDrawLine(xpos, ypos2, xpos2, ypos2, INDUSTRY_LINE_COLOUR);
1728 GfxDrawLine(xpos2, ypos1, xpos2, ypos2, INDUSTRY_LINE_COLOUR);
1729 ypos += (normal_height - FONT_HEIGHT_NORMAL) / 2;
1730 if (this->u.industry.ind_type < NUM_INDUSTRYTYPES) {
1731 const IndustrySpec *indsp = GetIndustrySpec(this->u.industry.ind_type);
1732 DrawString(xpos, xpos2, ypos, indsp->name, TC_WHITE, SA_HOR_CENTER);
1734 /* Draw the industry legend. */
1735 int blob_left, blob_right;
1736 if (_current_text_dir == TD_RTL) {
1737 blob_right = xpos2 - BLOB_DISTANCE;
1738 blob_left = blob_right - BLOB_WIDTH;
1739 } else {
1740 blob_left = xpos + BLOB_DISTANCE;
1741 blob_right = blob_left + BLOB_WIDTH;
1743 GfxFillRect(blob_left, ypos2 - BLOB_DISTANCE - BLOB_HEIGHT, blob_right, ypos2 - BLOB_DISTANCE, PC_BLACK); // Border
1744 GfxFillRect(blob_left + 1, ypos2 - BLOB_DISTANCE - BLOB_HEIGHT + 1, blob_right - 1, ypos2 - BLOB_DISTANCE - 1, indsp->map_colour);
1745 } else {
1746 DrawString(xpos, xpos2, ypos, STR_INDUSTRY_CARGOES_HOUSES, TC_FROMSTRING, SA_HOR_CENTER);
1749 /* Draw the other_produced/other_accepted cargoes. */
1750 const CargoID *other_right, *other_left;
1751 if (_current_text_dir == TD_RTL) {
1752 other_right = this->u.industry.other_accepted;
1753 other_left = this->u.industry.other_produced;
1754 } else {
1755 other_right = this->u.industry.other_produced;
1756 other_left = this->u.industry.other_accepted;
1758 ypos1 += VERT_CARGO_EDGE;
1759 for (uint i = 0; i < MAX_CARGOES; i++) {
1760 if (other_right[i] != INVALID_CARGO) {
1761 const CargoSpec *csp = CargoSpec::Get(other_right[i]);
1762 int xp = xpos + industry_width + CARGO_STUB_WIDTH;
1763 DrawHorConnection(xpos + industry_width, xp - 1, ypos1, csp);
1764 GfxDrawLine(xp, ypos1, xp, ypos1 + FONT_HEIGHT_NORMAL - 1, CARGO_LINE_COLOUR);
1766 if (other_left[i] != INVALID_CARGO) {
1767 const CargoSpec *csp = CargoSpec::Get(other_left[i]);
1768 int xp = xpos - CARGO_STUB_WIDTH;
1769 DrawHorConnection(xp + 1, xpos - 1, ypos1, csp);
1770 GfxDrawLine(xp, ypos1, xp, ypos1 + FONT_HEIGHT_NORMAL - 1, CARGO_LINE_COLOUR);
1772 ypos1 += FONT_HEIGHT_NORMAL + VERT_CARGO_SPACE;
1774 break;
1777 case CFT_CARGO: {
1778 int cargo_base = this->GetCargoBase(xpos);
1779 int top = ypos + (this->u.cargo.top_end ? VERT_INTER_INDUSTRY_SPACE / 2 + 1 : 0);
1780 int bot = ypos - (this->u.cargo.bottom_end ? VERT_INTER_INDUSTRY_SPACE / 2 + 1 : 0) + normal_height - 1;
1781 int colpos = cargo_base;
1782 for (int i = 0; i < this->u.cargo.num_cargoes; i++) {
1783 if (this->u.cargo.top_end) GfxDrawLine(colpos, top - 1, colpos + HOR_CARGO_WIDTH - 1, top - 1, CARGO_LINE_COLOUR);
1784 if (this->u.cargo.bottom_end) GfxDrawLine(colpos, bot + 1, colpos + HOR_CARGO_WIDTH - 1, bot + 1, CARGO_LINE_COLOUR);
1785 GfxDrawLine(colpos, top, colpos, bot, CARGO_LINE_COLOUR);
1786 colpos++;
1787 const CargoSpec *csp = CargoSpec::Get(this->u.cargo.vertical_cargoes[i]);
1788 GfxFillRect(colpos, top, colpos + HOR_CARGO_WIDTH - 2, bot, csp->legend_colour, FILLRECT_OPAQUE);
1789 colpos += HOR_CARGO_WIDTH - 2;
1790 GfxDrawLine(colpos, top, colpos, bot, CARGO_LINE_COLOUR);
1791 colpos += 1 + HOR_CARGO_SPACE;
1794 const CargoID *hor_left, *hor_right;
1795 if (_current_text_dir == TD_RTL) {
1796 hor_left = this->u.cargo.cust_cargoes;
1797 hor_right = this->u.cargo.supp_cargoes;
1798 } else {
1799 hor_left = this->u.cargo.supp_cargoes;
1800 hor_right = this->u.cargo.cust_cargoes;
1802 ypos += VERT_CARGO_EDGE + VERT_INTER_INDUSTRY_SPACE / 2;
1803 for (uint i = 0; i < MAX_CARGOES; i++) {
1804 if (hor_left[i] != INVALID_CARGO) {
1805 int col = hor_left[i];
1806 int dx = 0;
1807 const CargoSpec *csp = CargoSpec::Get(this->u.cargo.vertical_cargoes[col]);
1808 for (; col > 0; col--) {
1809 int lf = cargo_base + col * HOR_CARGO_WIDTH + (col - 1) * HOR_CARGO_SPACE;
1810 DrawHorConnection(lf, lf + HOR_CARGO_SPACE - dx, ypos, csp);
1811 dx = 1;
1813 DrawHorConnection(xpos, cargo_base - dx, ypos, csp);
1815 if (hor_right[i] != INVALID_CARGO) {
1816 int col = hor_right[i];
1817 int dx = 0;
1818 const CargoSpec *csp = CargoSpec::Get(this->u.cargo.vertical_cargoes[col]);
1819 for (; col < this->u.cargo.num_cargoes - 1; col++) {
1820 int lf = cargo_base + (col + 1) * HOR_CARGO_WIDTH + col * HOR_CARGO_SPACE;
1821 DrawHorConnection(lf + dx - 1, lf + HOR_CARGO_SPACE - 1, ypos, csp);
1822 dx = 1;
1824 DrawHorConnection(cargo_base + col * HOR_CARGO_SPACE + (col + 1) * HOR_CARGO_WIDTH - 1 + dx, xpos + CARGO_FIELD_WIDTH - 1, ypos, csp);
1826 ypos += FONT_HEIGHT_NORMAL + VERT_CARGO_SPACE;
1828 break;
1831 case CFT_CARGO_LABEL:
1832 ypos += VERT_CARGO_EDGE + VERT_INTER_INDUSTRY_SPACE / 2;
1833 for (uint i = 0; i < MAX_CARGOES; i++) {
1834 if (this->u.cargo_label.cargoes[i] != INVALID_CARGO) {
1835 const CargoSpec *csp = CargoSpec::Get(this->u.cargo_label.cargoes[i]);
1836 DrawString(xpos + WD_FRAMERECT_LEFT, xpos + industry_width - 1 - WD_FRAMERECT_RIGHT, ypos, csp->name, TC_WHITE,
1837 (this->u.cargo_label.left_align) ? SA_LEFT : SA_RIGHT);
1839 ypos += FONT_HEIGHT_NORMAL + VERT_CARGO_SPACE;
1841 break;
1843 default:
1844 NOT_REACHED();
1849 * Decide which cargo was clicked at in a #CFT_CARGO field.
1850 * @param left Left industry neighbour if available (else \c NULL should be supplied).
1851 * @param right Right industry neighbour if available (else \c NULL should be supplied).
1852 * @param pt Click position in the cargo field.
1853 * @return Cargo clicked at, or #INVALID_CARGO if none.
1855 CargoID CargoClickedAt(const CargoesField *left, const CargoesField *right, Point pt) const
1857 assert(this->type == CFT_CARGO);
1859 /* Vertical matching. */
1860 int cpos = this->GetCargoBase(0);
1861 uint col;
1862 for (col = 0; col < this->u.cargo.num_cargoes; col++) {
1863 if (pt.x < cpos) break;
1864 if (pt.x < cpos + CargoesField::HOR_CARGO_WIDTH) return this->u.cargo.vertical_cargoes[col];
1865 cpos += CargoesField::HOR_CARGO_WIDTH + CargoesField::HOR_CARGO_SPACE;
1867 /* col = 0 -> left of first col, 1 -> left of 2nd col, ... this->u.cargo.num_cargoes right of last-col. */
1869 int vpos = VERT_INTER_INDUSTRY_SPACE / 2 + VERT_CARGO_EDGE;
1870 uint row;
1871 for (row = 0; row < MAX_CARGOES; row++) {
1872 if (pt.y < vpos) return INVALID_CARGO;
1873 if (pt.y < vpos + FONT_HEIGHT_NORMAL) break;
1874 vpos += FONT_HEIGHT_NORMAL + VERT_CARGO_SPACE;
1876 if (row == MAX_CARGOES) return INVALID_CARGO;
1878 /* row = 0 -> at first horizontal row, row = 1 -> second horizontal row, 2 = 3rd horizontal row. */
1879 if (col == 0) {
1880 if (this->u.cargo.supp_cargoes[row] != INVALID_CARGO) return this->u.cargo.vertical_cargoes[this->u.cargo.supp_cargoes[row]];
1881 if (left != NULL) {
1882 if (left->type == CFT_INDUSTRY) return left->u.industry.other_produced[row];
1883 if (left->type == CFT_CARGO_LABEL && !left->u.cargo_label.left_align) return left->u.cargo_label.cargoes[row];
1885 return INVALID_CARGO;
1887 if (col == this->u.cargo.num_cargoes) {
1888 if (this->u.cargo.cust_cargoes[row] != INVALID_CARGO) return this->u.cargo.vertical_cargoes[this->u.cargo.cust_cargoes[row]];
1889 if (right != NULL) {
1890 if (right->type == CFT_INDUSTRY) return right->u.industry.other_accepted[row];
1891 if (right->type == CFT_CARGO_LABEL && right->u.cargo_label.left_align) return right->u.cargo_label.cargoes[row];
1893 return INVALID_CARGO;
1895 if (row >= col) {
1896 /* Clicked somewhere in-between vertical cargo connection.
1897 * Since the horizontal connection is made in the same order as the vertical list, the above condition
1898 * ensures we are left-below the main diagonal, thus at the supplying side.
1900 return (this->u.cargo.supp_cargoes[row] != INVALID_CARGO) ? this->u.cargo.vertical_cargoes[this->u.cargo.supp_cargoes[row]] : INVALID_CARGO;
1901 } else {
1902 /* Clicked at a customer connection. */
1903 return (this->u.cargo.cust_cargoes[row] != INVALID_CARGO) ? this->u.cargo.vertical_cargoes[this->u.cargo.cust_cargoes[row]] : INVALID_CARGO;
1908 * Decide what cargo the user clicked in the cargo label field.
1909 * @param pt Click position in the cargo label field.
1910 * @return Cargo clicked at, or #INVALID_CARGO if none.
1912 CargoID CargoLabelClickedAt(Point pt) const
1914 assert(this->type == CFT_CARGO_LABEL);
1916 int vpos = VERT_INTER_INDUSTRY_SPACE / 2 + VERT_CARGO_EDGE;
1917 uint row;
1918 for (row = 0; row < MAX_CARGOES; row++) {
1919 if (pt.y < vpos) return INVALID_CARGO;
1920 if (pt.y < vpos + FONT_HEIGHT_NORMAL) break;
1921 vpos += FONT_HEIGHT_NORMAL + VERT_CARGO_SPACE;
1923 if (row == MAX_CARGOES) return INVALID_CARGO;
1924 return this->u.cargo_label.cargoes[row];
1927 private:
1929 * Draw a horizontal cargo connection.
1930 * @param left Left-most coordinate to draw.
1931 * @param right Right-most coordinate to draw.
1932 * @param top Top coordinate of the cargo connection.
1933 * @param csp Cargo to draw.
1935 static void DrawHorConnection(int left, int right, int top, const CargoSpec *csp)
1937 GfxDrawLine(left, top, right, top, CARGO_LINE_COLOUR);
1938 GfxFillRect(left, top + 1, right, top + FONT_HEIGHT_NORMAL - 2, csp->legend_colour, FILLRECT_OPAQUE);
1939 GfxDrawLine(left, top + FONT_HEIGHT_NORMAL - 1, right, top + FONT_HEIGHT_NORMAL - 1, CARGO_LINE_COLOUR);
1943 assert_compile(MAX_CARGOES >= cpp_lengthof(IndustrySpec, produced_cargo));
1944 assert_compile(MAX_CARGOES >= cpp_lengthof(IndustrySpec, accepts_cargo));
1946 int CargoesField::small_height; ///< Height of the header row.
1947 int CargoesField::normal_height; ///< Height of the non-header rows.
1948 int CargoesField::industry_width; ///< Width of an industry field.
1949 const int CargoesField::VERT_INTER_INDUSTRY_SPACE = 6; ///< Amount of space between two industries in a column.
1951 const int CargoesField::HOR_CARGO_BORDER_SPACE = 15; ///< Amount of space between the left/right edge of a #CFT_CARGO field, and the left/right most vertical cargo.
1952 const int CargoesField::CARGO_STUB_WIDTH = 10; ///< Width of a cargo not carried in the column (should be less than #HOR_CARGO_BORDER_SPACE).
1953 const int CargoesField::HOR_CARGO_WIDTH = 15; ///< Width of a vertical cargo column (inclusive the border line).
1954 const int CargoesField::HOR_CARGO_SPACE = 5; ///< Amount of horizontal space between two vertical cargoes.
1955 const int CargoesField::VERT_CARGO_EDGE = 4; ///< Amount of vertical space between top/bottom and the top/bottom connected cargo at an industry.
1956 const int CargoesField::VERT_CARGO_SPACE = 4; ///< Amount of vertical space between two connected cargoes at an industry.
1958 const int CargoesField::BLOB_DISTANCE = 5; ///< Distance of the industry legend colour from the edge of the industry box.
1959 const int CargoesField::BLOB_WIDTH = 12; ///< Width of the industry legend colour, including border.
1960 const int CargoesField::BLOB_HEIGHT = 9; ///< Height of the industry legend colour, including border
1962 /** Width of a #CFT_CARGO field. */
1963 const int CargoesField::CARGO_FIELD_WIDTH = HOR_CARGO_BORDER_SPACE * 2 + HOR_CARGO_WIDTH * MAX_CARGOES + HOR_CARGO_SPACE * (MAX_CARGOES - 1);
1965 const int CargoesField::INDUSTRY_LINE_COLOUR = PC_YELLOW; ///< Line colour of the industry type box.
1966 const int CargoesField::CARGO_LINE_COLOUR = PC_YELLOW; ///< Line colour around the cargo.
1968 /** A single row of #CargoesField. */
1969 struct CargoesRow {
1970 CargoesField columns[5]; ///< One row of fields.
1973 * Connect industry production cargoes to the cargo column after it.
1974 * @param column Column of the industry.
1976 void ConnectIndustryProduced(int column)
1978 CargoesField *ind_fld = this->columns + column;
1979 CargoesField *cargo_fld = this->columns + column + 1;
1980 assert(ind_fld->type == CFT_INDUSTRY && cargo_fld->type == CFT_CARGO);
1982 MemSetT(ind_fld->u.industry.other_produced, INVALID_CARGO, MAX_CARGOES);
1984 if (ind_fld->u.industry.ind_type < NUM_INDUSTRYTYPES) {
1985 CargoID others[MAX_CARGOES]; // Produced cargoes not carried in the cargo column.
1986 int other_count = 0;
1988 const IndustrySpec *indsp = GetIndustrySpec(ind_fld->u.industry.ind_type);
1989 for (uint i = 0; i < lengthof(indsp->produced_cargo); i++) {
1990 int col = cargo_fld->ConnectCargo(indsp->produced_cargo[i], true);
1991 if (col < 0) others[other_count++] = indsp->produced_cargo[i];
1994 /* Allocate other cargoes in the empty holes of the horizontal cargo connections. */
1995 for (uint i = 0; i < MAX_CARGOES && other_count > 0; i++) {
1996 if (cargo_fld->u.cargo.supp_cargoes[i] == INVALID_CARGO) ind_fld->u.industry.other_produced[i] = others[--other_count];
1998 } else {
1999 /* Houses only display what is demanded. */
2000 for (uint i = 0; i < cargo_fld->u.cargo.num_cargoes; i++) {
2001 CargoID cid = cargo_fld->u.cargo.vertical_cargoes[i];
2002 if (cid == CT_PASSENGERS || cid == CT_MAIL) cargo_fld->ConnectCargo(cid, true);
2008 * Construct a #CFT_CARGO_LABEL field.
2009 * @param column Column to create the new field.
2010 * @param accepting Display accepted cargo (if \c false, display produced cargo).
2012 void MakeCargoLabel(int column, bool accepting)
2014 CargoID cargoes[MAX_CARGOES];
2015 MemSetT(cargoes, INVALID_CARGO, lengthof(cargoes));
2017 CargoesField *label_fld = this->columns + column;
2018 CargoesField *cargo_fld = this->columns + (accepting ? column - 1 : column + 1);
2020 assert(cargo_fld->type == CFT_CARGO && label_fld->type == CFT_EMPTY);
2021 for (uint i = 0; i < cargo_fld->u.cargo.num_cargoes; i++) {
2022 int col = cargo_fld->ConnectCargo(cargo_fld->u.cargo.vertical_cargoes[i], !accepting);
2023 if (col >= 0) cargoes[col] = cargo_fld->u.cargo.vertical_cargoes[i];
2025 label_fld->MakeCargoLabel(cargoes, lengthof(cargoes), accepting);
2030 * Connect industry accepted cargoes to the cargo column before it.
2031 * @param column Column of the industry.
2033 void ConnectIndustryAccepted(int column)
2035 CargoesField *ind_fld = this->columns + column;
2036 CargoesField *cargo_fld = this->columns + column - 1;
2037 assert(ind_fld->type == CFT_INDUSTRY && cargo_fld->type == CFT_CARGO);
2039 MemSetT(ind_fld->u.industry.other_accepted, INVALID_CARGO, MAX_CARGOES);
2041 if (ind_fld->u.industry.ind_type < NUM_INDUSTRYTYPES) {
2042 CargoID others[MAX_CARGOES]; // Accepted cargoes not carried in the cargo column.
2043 int other_count = 0;
2045 const IndustrySpec *indsp = GetIndustrySpec(ind_fld->u.industry.ind_type);
2046 for (uint i = 0; i < lengthof(indsp->accepts_cargo); i++) {
2047 int col = cargo_fld->ConnectCargo(indsp->accepts_cargo[i], false);
2048 if (col < 0) others[other_count++] = indsp->accepts_cargo[i];
2051 /* Allocate other cargoes in the empty holes of the horizontal cargo connections. */
2052 for (uint i = 0; i < MAX_CARGOES && other_count > 0; i++) {
2053 if (cargo_fld->u.cargo.cust_cargoes[i] == INVALID_CARGO) ind_fld->u.industry.other_accepted[i] = others[--other_count];
2055 } else {
2056 /* Houses only display what is demanded. */
2057 for (uint i = 0; i < cargo_fld->u.cargo.num_cargoes; i++) {
2058 for (uint h = 0; h < NUM_HOUSES; h++) {
2059 HouseSpec *hs = HouseSpec::Get(h);
2060 if (!hs->enabled) continue;
2062 for (uint j = 0; j < lengthof(hs->accepts_cargo); j++) {
2063 if (hs->cargo_acceptance[j] > 0 && cargo_fld->u.cargo.vertical_cargoes[i] == hs->accepts_cargo[j]) {
2064 cargo_fld->ConnectCargo(cargo_fld->u.cargo.vertical_cargoes[i], false);
2065 goto next_cargo;
2069 next_cargo: ;
2077 * Window displaying the cargo connections around an industry (or cargo).
2079 * The main display is constructed from 'fields', rectangles that contain an industry, piece of the cargo connection, cargo labels, or headers.
2080 * For a nice display, the following should be kept in mind:
2081 * - A #CFT_HEADER is always at the top of an column of #CFT_INDUSTRY fields.
2082 * - A #CFT_CARGO_LABEL field is also always put in a column of #CFT_INDUSTRY fields.
2083 * - The top row contains #CFT_HEADER and #CFT_SMALL_EMPTY fields.
2084 * - Cargo connections have a column of their own (#CFT_CARGO fields).
2085 * - 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.
2086 * The information however is part of the industry.
2088 * This results in the following invariants:
2089 * - Width of a #CFT_INDUSTRY column is large enough to hold all industry type labels, all cargo labels, and all header texts.
2090 * - Height of a #CFT_INDUSTRY is large enough to hold a header line, or a industry type line, \c N cargo labels
2091 * (where \c N is the maximum number of cargoes connected between industries), \c N connections of cargo types, and space
2092 * between two industry types (1/2 above it, and 1/2 underneath it).
2093 * - Width of a cargo field (#CFT_CARGO) is large enough to hold \c N vertical columns (one for each type of cargo).
2094 * Also, space is needed between an industry and the leftmost/rightmost column to draw the non-carried cargoes.
2095 * - Height of a #CFT_CARGO field is equally high as the height of the #CFT_INDUSTRY.
2096 * - A field at the top (#CFT_HEADER or #CFT_SMALL_EMPTY) match the width of the fields below them (#CFT_INDUSTRY respectively
2097 * #CFT_CARGO), the height should be sufficient to display the header text.
2099 * When displaying the cargoes around an industry type, five columns are needed (supplying industries, accepted cargoes, the industry,
2100 * produced cargoes, customer industries). Displaying the industries around a cargo needs three columns (supplying industries, the cargo,
2101 * 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.
2103 struct IndustryCargoesWindow : public Window {
2104 static const int HOR_TEXT_PADDING, VERT_TEXT_PADDING;
2106 typedef SmallVector<CargoesRow, 4> Fields;
2108 Fields fields; ///< Fields to display in the #WID_IC_PANEL.
2109 uint ind_cargo; ///< If less than #NUM_INDUSTRYTYPES, an industry type, else a cargo id + NUM_INDUSTRYTYPES.
2110 Dimension cargo_textsize; ///< Size to hold any cargo text, as well as STR_INDUSTRY_CARGOES_SELECT_CARGO.
2111 Dimension ind_textsize; ///< Size to hold any industry type text, as well as STR_INDUSTRY_CARGOES_SELECT_INDUSTRY.
2112 Scrollbar *vscroll;
2114 IndustryCargoesWindow(int id) : Window(&_industry_cargoes_desc)
2116 this->OnInit();
2117 this->CreateNestedTree();
2118 this->vscroll = this->GetScrollbar(WID_IC_SCROLLBAR);
2119 this->FinishInitNested(0);
2120 this->OnInvalidateData(id);
2123 virtual void OnInit()
2125 /* Initialize static CargoesField size variables. */
2126 Dimension d = GetStringBoundingBox(STR_INDUSTRY_CARGOES_PRODUCERS);
2127 d = maxdim(d, GetStringBoundingBox(STR_INDUSTRY_CARGOES_CUSTOMERS));
2128 d.width += WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT;
2129 d.height += WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM;
2130 CargoesField::small_height = d.height;
2132 /* Decide about the size of the box holding the text of an industry type. */
2133 this->ind_textsize.width = 0;
2134 this->ind_textsize.height = 0;
2135 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2136 const IndustrySpec *indsp = GetIndustrySpec(it);
2137 if (!indsp->enabled) continue;
2138 this->ind_textsize = maxdim(this->ind_textsize, GetStringBoundingBox(indsp->name));
2140 d.width = max(d.width, this->ind_textsize.width);
2141 d.height = this->ind_textsize.height;
2142 this->ind_textsize = maxdim(this->ind_textsize, GetStringBoundingBox(STR_INDUSTRY_CARGOES_SELECT_INDUSTRY));
2144 /* Compute max size of the cargo texts. */
2145 this->cargo_textsize.width = 0;
2146 this->cargo_textsize.height = 0;
2147 for (uint i = 0; i < NUM_CARGO; i++) {
2148 const CargoSpec *csp = CargoSpec::Get(i);
2149 if (!csp->IsValid()) continue;
2150 this->cargo_textsize = maxdim(this->cargo_textsize, GetStringBoundingBox(csp->name));
2152 d = maxdim(d, this->cargo_textsize); // Box must also be wide enough to hold any cargo label.
2153 this->cargo_textsize = maxdim(this->cargo_textsize, GetStringBoundingBox(STR_INDUSTRY_CARGOES_SELECT_CARGO));
2155 d.width += 2 * HOR_TEXT_PADDING;
2156 /* Ensure the height is enough for the industry type text, for the horizontal connections, and for the cargo labels. */
2157 uint min_ind_height = CargoesField::VERT_CARGO_EDGE * 2 + MAX_CARGOES * FONT_HEIGHT_NORMAL + (MAX_CARGOES - 1) * CargoesField::VERT_CARGO_SPACE;
2158 d.height = max(d.height + 2 * VERT_TEXT_PADDING, min_ind_height);
2160 CargoesField::industry_width = d.width;
2161 CargoesField::normal_height = d.height + CargoesField::VERT_INTER_INDUSTRY_SPACE;
2164 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
2166 switch (widget) {
2167 case WID_IC_PANEL:
2168 size->width = WD_FRAMETEXT_LEFT + CargoesField::industry_width * 3 + CargoesField::CARGO_FIELD_WIDTH * 2 + WD_FRAMETEXT_RIGHT;
2169 break;
2171 case WID_IC_IND_DROPDOWN:
2172 size->width = max(size->width, this->ind_textsize.width + padding.width);
2173 break;
2175 case WID_IC_CARGO_DROPDOWN:
2176 size->width = max(size->width, this->cargo_textsize.width + padding.width);
2177 break;
2182 CargoesFieldType type; ///< Type of field.
2183 virtual void SetStringParameters (int widget) const
2185 if (widget != WID_IC_CAPTION) return;
2187 if (this->ind_cargo < NUM_INDUSTRYTYPES) {
2188 const IndustrySpec *indsp = GetIndustrySpec(this->ind_cargo);
2189 SetDParam(0, indsp->name);
2190 } else {
2191 const CargoSpec *csp = CargoSpec::Get(this->ind_cargo - NUM_INDUSTRYTYPES);
2192 SetDParam(0, csp->name);
2197 * Do the two sets of cargoes have a valid cargo in common?
2198 * @param cargoes1 Base address of the first cargo array.
2199 * @param length1 Number of cargoes in the first cargo array.
2200 * @param cargoes2 Base address of the second cargo array.
2201 * @param length2 Number of cargoes in the second cargo array.
2202 * @return Arrays have at least one valid cargo in common.
2204 static bool HasCommonValidCargo(const CargoID *cargoes1, uint length1, const CargoID *cargoes2, uint length2)
2206 while (length1 > 0) {
2207 if (*cargoes1 != INVALID_CARGO) {
2208 for (uint i = 0; i < length2; i++) if (*cargoes1 == cargoes2[i]) return true;
2210 cargoes1++;
2211 length1--;
2213 return false;
2217 * Can houses be used to supply one of the cargoes?
2218 * @param cargoes Base address of the cargo array.
2219 * @param length Number of cargoes in the array.
2220 * @return Houses can supply at least one of the cargoes.
2222 static bool HousesCanSupply(const CargoID *cargoes, uint length)
2224 for (uint i = 0; i < length; i++) {
2225 if (cargoes[i] == INVALID_CARGO) continue;
2226 if (cargoes[i] == CT_PASSENGERS || cargoes[i] == CT_MAIL) return true;
2228 return false;
2232 * Can houses be used as customers of the produced cargoes?
2233 * @param cargoes Base address of the cargo array.
2234 * @param length Number of cargoes in the array.
2235 * @return Houses can accept at least one of the cargoes.
2237 static bool HousesCanAccept(const CargoID *cargoes, uint length)
2239 HouseZones climate_mask;
2240 switch (_settings_game.game_creation.landscape) {
2241 case LT_TEMPERATE: climate_mask = HZ_TEMP; break;
2242 case LT_ARCTIC: climate_mask = HZ_SUBARTC_ABOVE | HZ_SUBARTC_BELOW; break;
2243 case LT_TROPIC: climate_mask = HZ_SUBTROPIC; break;
2244 case LT_TOYLAND: climate_mask = HZ_TOYLND; break;
2245 default: NOT_REACHED();
2247 for (uint i = 0; i < length; i++) {
2248 if (cargoes[i] == INVALID_CARGO) continue;
2250 for (uint h = 0; h < NUM_HOUSES; h++) {
2251 HouseSpec *hs = HouseSpec::Get(h);
2252 if (!hs->enabled || !(hs->building_availability & climate_mask)) continue;
2254 for (uint j = 0; j < lengthof(hs->accepts_cargo); j++) {
2255 if (hs->cargo_acceptance[j] > 0 && cargoes[i] == hs->accepts_cargo[j]) return true;
2259 return false;
2263 * Count how many industries have accepted cargoes in common with one of the supplied set.
2264 * @param cargoes Cargoes to search.
2265 * @param length Number of cargoes in \a cargoes.
2266 * @return Number of industries that have an accepted cargo in common with the supplied set.
2268 static int CountMatchingAcceptingIndustries(const CargoID *cargoes, uint length)
2270 int count = 0;
2271 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2272 const IndustrySpec *indsp = GetIndustrySpec(it);
2273 if (!indsp->enabled) continue;
2275 if (HasCommonValidCargo(cargoes, length, indsp->accepts_cargo, lengthof(indsp->accepts_cargo))) count++;
2277 return count;
2281 * Count how many industries have produced cargoes in common with one of the supplied set.
2282 * @param cargoes Cargoes to search.
2283 * @param length Number of cargoes in \a cargoes.
2284 * @return Number of industries that have a produced cargo in common with the supplied set.
2286 static int CountMatchingProducingIndustries(const CargoID *cargoes, uint length)
2288 int count = 0;
2289 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2290 const IndustrySpec *indsp = GetIndustrySpec(it);
2291 if (!indsp->enabled) continue;
2293 if (HasCommonValidCargo(cargoes, length, indsp->produced_cargo, lengthof(indsp->produced_cargo))) count++;
2295 return count;
2299 * Shorten the cargo column to just the part between industries.
2300 * @param column Column number of the cargo column.
2301 * @param top Current top row.
2302 * @param bottom Current bottom row.
2304 void ShortenCargoColumn(int column, int top, int bottom)
2306 while (top < bottom && !this->fields[top].columns[column].HasConnection()) {
2307 this->fields[top].columns[column].MakeEmpty(CFT_EMPTY);
2308 top++;
2310 this->fields[top].columns[column].u.cargo.top_end = true;
2312 while (bottom > top && !this->fields[bottom].columns[column].HasConnection()) {
2313 this->fields[bottom].columns[column].MakeEmpty(CFT_EMPTY);
2314 bottom--;
2316 this->fields[bottom].columns[column].u.cargo.bottom_end = true;
2320 * Place an industry in the fields.
2321 * @param row Row of the new industry.
2322 * @param col Column of the new industry.
2323 * @param it Industry to place.
2325 void PlaceIndustry(int row, int col, IndustryType it)
2327 assert(this->fields[row].columns[col].type == CFT_EMPTY);
2328 this->fields[row].columns[col].MakeIndustry(it);
2329 if (col == 0) {
2330 this->fields[row].ConnectIndustryProduced(col);
2331 } else {
2332 this->fields[row].ConnectIndustryAccepted(col);
2337 * Notify smallmap that new displayed industries have been selected (in #_displayed_industries).
2339 void NotifySmallmap()
2341 if (!this->IsWidgetLowered(WID_IC_NOTIFY)) return;
2343 /* Only notify the smallmap window if it exists. In particular, do not
2344 * bring it to the front to prevent messing up any nice layout of the user. */
2345 InvalidateWindowClassesData(WC_SMALLMAP, 0);
2349 * Compute what and where to display for industry type \a it.
2350 * @param it Industry type to display.
2352 void ComputeIndustryDisplay(IndustryType it)
2354 this->GetWidget<NWidgetCore>(WID_IC_CAPTION)->widget_data = STR_INDUSTRY_CARGOES_INDUSTRY_CAPTION;
2355 this->ind_cargo = it;
2356 _displayed_industries.reset();
2357 _displayed_industries.set(it);
2359 this->fields.Clear();
2360 CargoesRow *row = this->fields.Append();
2361 row->columns[0].MakeHeader(STR_INDUSTRY_CARGOES_PRODUCERS);
2362 row->columns[1].MakeEmpty(CFT_SMALL_EMPTY);
2363 row->columns[2].MakeEmpty(CFT_SMALL_EMPTY);
2364 row->columns[3].MakeEmpty(CFT_SMALL_EMPTY);
2365 row->columns[4].MakeHeader(STR_INDUSTRY_CARGOES_CUSTOMERS);
2367 const IndustrySpec *central_sp = GetIndustrySpec(it);
2368 bool houses_supply = HousesCanSupply(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo));
2369 bool houses_accept = HousesCanAccept(central_sp->produced_cargo, lengthof(central_sp->produced_cargo));
2370 /* Make a field consisting of two cargo columns. */
2371 int num_supp = CountMatchingProducingIndustries(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo)) + houses_supply;
2372 int num_cust = CountMatchingAcceptingIndustries(central_sp->produced_cargo, lengthof(central_sp->produced_cargo)) + houses_accept;
2373 int num_indrows = max(3, max(num_supp, num_cust)); // One is needed for the 'it' industry, and 2 for the cargo labels.
2374 for (int i = 0; i < num_indrows; i++) {
2375 CargoesRow *row = this->fields.Append();
2376 row->columns[0].MakeEmpty(CFT_EMPTY);
2377 row->columns[1].MakeCargo(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo));
2378 row->columns[2].MakeEmpty(CFT_EMPTY);
2379 row->columns[3].MakeCargo(central_sp->produced_cargo, lengthof(central_sp->produced_cargo));
2380 row->columns[4].MakeEmpty(CFT_EMPTY);
2382 /* Add central industry. */
2383 int central_row = 1 + num_indrows / 2;
2384 this->fields[central_row].columns[2].MakeIndustry(it);
2385 this->fields[central_row].ConnectIndustryProduced(2);
2386 this->fields[central_row].ConnectIndustryAccepted(2);
2388 /* Add cargo labels. */
2389 this->fields[central_row - 1].MakeCargoLabel(2, true);
2390 this->fields[central_row + 1].MakeCargoLabel(2, false);
2392 /* Add suppliers and customers of the 'it' industry. */
2393 int supp_count = 0;
2394 int cust_count = 0;
2395 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2396 const IndustrySpec *indsp = GetIndustrySpec(it);
2397 if (!indsp->enabled) continue;
2399 if (HasCommonValidCargo(central_sp->accepts_cargo, lengthof(central_sp->accepts_cargo), indsp->produced_cargo, lengthof(indsp->produced_cargo))) {
2400 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, it);
2401 _displayed_industries.set(it);
2402 supp_count++;
2404 if (HasCommonValidCargo(central_sp->produced_cargo, lengthof(central_sp->produced_cargo), indsp->accepts_cargo, lengthof(indsp->accepts_cargo))) {
2405 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 4, it);
2406 _displayed_industries.set(it);
2407 cust_count++;
2410 if (houses_supply) {
2411 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, NUM_INDUSTRYTYPES);
2412 supp_count++;
2414 if (houses_accept) {
2415 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 4, NUM_INDUSTRYTYPES);
2416 cust_count++;
2419 this->ShortenCargoColumn(1, 1, num_indrows);
2420 this->ShortenCargoColumn(3, 1, num_indrows);
2421 const NWidgetBase *nwp = this->GetWidget<NWidgetBase>(WID_IC_PANEL);
2422 this->vscroll->SetCount(CeilDiv(WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM + CargoesField::small_height + num_indrows * CargoesField::normal_height, nwp->resize_y));
2423 this->SetDirty();
2424 this->NotifySmallmap();
2428 * Compute what and where to display for cargo id \a cid.
2429 * @param cid Cargo id to display.
2431 void ComputeCargoDisplay(CargoID cid)
2433 this->GetWidget<NWidgetCore>(WID_IC_CAPTION)->widget_data = STR_INDUSTRY_CARGOES_CARGO_CAPTION;
2434 this->ind_cargo = cid + NUM_INDUSTRYTYPES;
2435 _displayed_industries.reset();
2437 this->fields.Clear();
2438 CargoesRow *row = this->fields.Append();
2439 row->columns[0].MakeHeader(STR_INDUSTRY_CARGOES_PRODUCERS);
2440 row->columns[1].MakeEmpty(CFT_SMALL_EMPTY);
2441 row->columns[2].MakeHeader(STR_INDUSTRY_CARGOES_CUSTOMERS);
2442 row->columns[3].MakeEmpty(CFT_SMALL_EMPTY);
2443 row->columns[4].MakeEmpty(CFT_SMALL_EMPTY);
2445 bool houses_supply = HousesCanSupply(&cid, 1);
2446 bool houses_accept = HousesCanAccept(&cid, 1);
2447 int num_supp = CountMatchingProducingIndustries(&cid, 1) + houses_supply + 1; // Ensure room for the cargo label.
2448 int num_cust = CountMatchingAcceptingIndustries(&cid, 1) + houses_accept;
2449 int num_indrows = max(num_supp, num_cust);
2450 for (int i = 0; i < num_indrows; i++) {
2451 CargoesRow *row = this->fields.Append();
2452 row->columns[0].MakeEmpty(CFT_EMPTY);
2453 row->columns[1].MakeCargo(&cid, 1);
2454 row->columns[2].MakeEmpty(CFT_EMPTY);
2455 row->columns[3].MakeEmpty(CFT_EMPTY);
2456 row->columns[4].MakeEmpty(CFT_EMPTY);
2459 this->fields[num_indrows].MakeCargoLabel(0, false); // Add cargo labels at the left bottom.
2461 /* Add suppliers and customers of the cargo. */
2462 int supp_count = 0;
2463 int cust_count = 0;
2464 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
2465 const IndustrySpec *indsp = GetIndustrySpec(it);
2466 if (!indsp->enabled) continue;
2468 if (HasCommonValidCargo(&cid, 1, indsp->produced_cargo, lengthof(indsp->produced_cargo))) {
2469 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, it);
2470 _displayed_industries.set(it);
2471 supp_count++;
2473 if (HasCommonValidCargo(&cid, 1, indsp->accepts_cargo, lengthof(indsp->accepts_cargo))) {
2474 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 2, it);
2475 _displayed_industries.set(it);
2476 cust_count++;
2479 if (houses_supply) {
2480 this->PlaceIndustry(1 + supp_count * num_indrows / num_supp, 0, NUM_INDUSTRYTYPES);
2481 supp_count++;
2483 if (houses_accept) {
2484 this->PlaceIndustry(1 + cust_count * num_indrows / num_cust, 2, NUM_INDUSTRYTYPES);
2485 cust_count++;
2488 this->ShortenCargoColumn(1, 1, num_indrows);
2489 const NWidgetBase *nwp = this->GetWidget<NWidgetBase>(WID_IC_PANEL);
2490 this->vscroll->SetCount(CeilDiv(WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM + CargoesField::small_height + num_indrows * CargoesField::normal_height, nwp->resize_y));
2491 this->SetDirty();
2492 this->NotifySmallmap();
2496 * Some data on this window has become invalid.
2497 * @param data Information about the changed data.
2498 * - data = 0 .. NUM_INDUSTRYTYPES - 1: Display the chain around the given industry.
2499 * - data = NUM_INDUSTRYTYPES: Stop sending updates to the smallmap window.
2500 * @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.
2502 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
2504 if (!gui_scope) return;
2505 if (data == NUM_INDUSTRYTYPES) {
2506 if (this->IsWidgetLowered(WID_IC_NOTIFY)) {
2507 this->RaiseWidget(WID_IC_NOTIFY);
2508 this->SetWidgetDirty(WID_IC_NOTIFY);
2510 return;
2513 assert(data >= 0 && data < NUM_INDUSTRYTYPES);
2514 this->ComputeIndustryDisplay(data);
2517 virtual void DrawWidget(const Rect &r, int widget) const
2519 if (widget != WID_IC_PANEL) return;
2521 DrawPixelInfo tmp_dpi, *old_dpi;
2522 int width = r.right - r.left + 1;
2523 int height = r.bottom - r.top + 1 - WD_FRAMERECT_TOP - WD_FRAMERECT_BOTTOM;
2524 if (!FillDrawPixelInfo(&tmp_dpi, r.left + WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP, width, height)) return;
2525 old_dpi = _cur_dpi;
2526 _cur_dpi = &tmp_dpi;
2528 int left_pos = WD_FRAMERECT_LEFT;
2529 if (this->ind_cargo >= NUM_INDUSTRYTYPES) left_pos += (CargoesField::industry_width + CargoesField::CARGO_FIELD_WIDTH) / 2;
2530 int last_column = (this->ind_cargo < NUM_INDUSTRYTYPES) ? 4 : 2;
2532 const NWidgetBase *nwp = this->GetWidget<NWidgetBase>(WID_IC_PANEL);
2533 int vpos = -this->vscroll->GetPosition() * nwp->resize_y;
2534 for (uint i = 0; i < this->fields.Length(); i++) {
2535 int row_height = (i == 0) ? CargoesField::small_height : CargoesField::normal_height;
2536 if (vpos + row_height >= 0) {
2537 int xpos = left_pos;
2538 int col, dir;
2539 if (_current_text_dir == TD_RTL) {
2540 col = last_column;
2541 dir = -1;
2542 } else {
2543 col = 0;
2544 dir = 1;
2546 while (col >= 0 && col <= last_column) {
2547 this->fields[i].columns[col].Draw(xpos, vpos);
2548 xpos += (col & 1) ? CargoesField::CARGO_FIELD_WIDTH : CargoesField::industry_width;
2549 col += dir;
2552 vpos += row_height;
2553 if (vpos >= height) break;
2556 _cur_dpi = old_dpi;
2560 * Calculate in which field was clicked, and within the field, at what position.
2561 * @param pt Clicked position in the #WID_IC_PANEL widget.
2562 * @param fieldxy If \c true is returned, field x/y coordinate of \a pt.
2563 * @param xy If \c true is returned, x/y coordinate with in the field.
2564 * @return Clicked at a valid position.
2566 bool CalculatePositionInWidget(Point pt, Point *fieldxy, Point *xy)
2568 const NWidgetBase *nw = this->GetWidget<NWidgetBase>(WID_IC_PANEL);
2569 pt.x -= nw->pos_x;
2570 pt.y -= nw->pos_y;
2572 int vpos = WD_FRAMERECT_TOP + CargoesField::small_height - this->vscroll->GetPosition() * nw->resize_y;
2573 if (pt.y < vpos) return false;
2575 int row = (pt.y - vpos) / CargoesField::normal_height; // row is relative to row 1.
2576 if (row + 1 >= (int)this->fields.Length()) return false;
2577 vpos = pt.y - vpos - row * CargoesField::normal_height; // Position in the row + 1 field
2578 row++; // rebase row to match index of this->fields.
2580 int xpos = 2 * WD_FRAMERECT_LEFT + ((this->ind_cargo < NUM_INDUSTRYTYPES) ? 0 : (CargoesField::industry_width + CargoesField::CARGO_FIELD_WIDTH) / 2);
2581 if (pt.x < xpos) return false;
2582 int column;
2583 for (column = 0; column <= 5; column++) {
2584 int width = (column & 1) ? CargoesField::CARGO_FIELD_WIDTH : CargoesField::industry_width;
2585 if (pt.x < xpos + width) break;
2586 xpos += width;
2588 int num_columns = (this->ind_cargo < NUM_INDUSTRYTYPES) ? 4 : 2;
2589 if (column > num_columns) return false;
2590 xpos = pt.x - xpos;
2592 /* Return both positions, compensating for RTL languages (which works due to the equal symmetry in both displays). */
2593 fieldxy->y = row;
2594 xy->y = vpos;
2595 if (_current_text_dir == TD_RTL) {
2596 fieldxy->x = num_columns - column;
2597 xy->x = ((column & 1) ? CargoesField::CARGO_FIELD_WIDTH : CargoesField::industry_width) - xpos;
2598 } else {
2599 fieldxy->x = column;
2600 xy->x = xpos;
2602 return true;
2605 virtual void OnClick(Point pt, int widget, int click_count)
2607 switch (widget) {
2608 case WID_IC_PANEL: {
2609 Point fieldxy, xy;
2610 if (!CalculatePositionInWidget(pt, &fieldxy, &xy)) return;
2612 const CargoesField *fld = this->fields[fieldxy.y].columns + fieldxy.x;
2613 switch (fld->type) {
2614 case CFT_INDUSTRY:
2615 if (fld->u.industry.ind_type < NUM_INDUSTRYTYPES) this->ComputeIndustryDisplay(fld->u.industry.ind_type);
2616 break;
2618 case CFT_CARGO: {
2619 CargoesField *lft = (fieldxy.x > 0) ? this->fields[fieldxy.y].columns + fieldxy.x - 1 : NULL;
2620 CargoesField *rgt = (fieldxy.x < 4) ? this->fields[fieldxy.y].columns + fieldxy.x + 1 : NULL;
2621 CargoID cid = fld->CargoClickedAt(lft, rgt, xy);
2622 if (cid != INVALID_CARGO) this->ComputeCargoDisplay(cid);
2623 break;
2626 case CFT_CARGO_LABEL: {
2627 CargoID cid = fld->CargoLabelClickedAt(xy);
2628 if (cid != INVALID_CARGO) this->ComputeCargoDisplay(cid);
2629 break;
2632 default:
2633 break;
2635 break;
2638 case WID_IC_NOTIFY:
2639 this->ToggleWidgetLoweredState(WID_IC_NOTIFY);
2640 this->SetWidgetDirty(WID_IC_NOTIFY);
2641 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
2643 if (this->IsWidgetLowered(WID_IC_NOTIFY)) {
2644 if (FindWindowByClass(WC_SMALLMAP) == NULL) ShowSmallMap();
2645 this->NotifySmallmap();
2647 break;
2649 case WID_IC_CARGO_DROPDOWN: {
2650 DropDownList *lst = new DropDownList;
2651 const CargoSpec *cs;
2652 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
2653 *lst->Append() = new DropDownListStringItem(cs->name, cs->Index(), false);
2655 if (lst->Length() == 0) {
2656 delete lst;
2657 break;
2659 int selected = (this->ind_cargo >= NUM_INDUSTRYTYPES) ? (int)(this->ind_cargo - NUM_INDUSTRYTYPES) : -1;
2660 ShowDropDownList(this, lst, selected, WID_IC_CARGO_DROPDOWN, 0, true);
2661 break;
2664 case WID_IC_IND_DROPDOWN: {
2665 DropDownList *lst = new DropDownList;
2666 for (uint i = 0; i < NUM_INDUSTRYTYPES; i++) {
2667 IndustryType ind = _sorted_industry_types[i];
2668 const IndustrySpec *indsp = GetIndustrySpec(ind);
2669 if (!indsp->enabled) continue;
2670 *lst->Append() = new DropDownListStringItem(indsp->name, ind, false);
2672 if (lst->Length() == 0) {
2673 delete lst;
2674 break;
2676 int selected = (this->ind_cargo < NUM_INDUSTRYTYPES) ? (int)this->ind_cargo : -1;
2677 ShowDropDownList(this, lst, selected, WID_IC_IND_DROPDOWN, 0, true);
2678 break;
2683 virtual void OnDropdownSelect(int widget, int index)
2685 if (index < 0) return;
2687 switch (widget) {
2688 case WID_IC_CARGO_DROPDOWN:
2689 this->ComputeCargoDisplay(index);
2690 break;
2692 case WID_IC_IND_DROPDOWN:
2693 this->ComputeIndustryDisplay(index);
2694 break;
2698 virtual void OnHover(Point pt, int widget)
2700 if (widget != WID_IC_PANEL) return;
2702 Point fieldxy, xy;
2703 if (!CalculatePositionInWidget(pt, &fieldxy, &xy)) return;
2705 const CargoesField *fld = this->fields[fieldxy.y].columns + fieldxy.x;
2706 CargoID cid = INVALID_CARGO;
2707 switch (fld->type) {
2708 case CFT_CARGO: {
2709 CargoesField *lft = (fieldxy.x > 0) ? this->fields[fieldxy.y].columns + fieldxy.x - 1 : NULL;
2710 CargoesField *rgt = (fieldxy.x < 4) ? this->fields[fieldxy.y].columns + fieldxy.x + 1 : NULL;
2711 cid = fld->CargoClickedAt(lft, rgt, xy);
2712 break;
2715 case CFT_CARGO_LABEL: {
2716 cid = fld->CargoLabelClickedAt(xy);
2717 break;
2720 case CFT_INDUSTRY:
2721 if (fld->u.industry.ind_type < NUM_INDUSTRYTYPES && (this->ind_cargo >= NUM_INDUSTRYTYPES || fieldxy.x != 2)) {
2722 GuiShowTooltips(this, STR_INDUSTRY_CARGOES_INDUSTRY_TOOLTIP, 0, NULL, TCC_HOVER);
2724 return;
2726 default:
2727 break;
2729 if (cid != INVALID_CARGO && (this->ind_cargo < NUM_INDUSTRYTYPES || cid != this->ind_cargo - NUM_INDUSTRYTYPES)) {
2730 const CargoSpec *csp = CargoSpec::Get(cid);
2731 uint64 params[5];
2732 params[0] = csp->name;
2733 GuiShowTooltips(this, STR_INDUSTRY_CARGOES_CARGO_TOOLTIP, 1, params, TCC_HOVER);
2737 virtual void OnResize()
2739 this->vscroll->SetCapacityFromWidget(this, WID_IC_PANEL);
2743 const int IndustryCargoesWindow::HOR_TEXT_PADDING = 5; ///< Horizontal padding around the industry type text.
2744 const int IndustryCargoesWindow::VERT_TEXT_PADDING = 5; ///< Vertical padding around the industry type text.
2747 * Open the industry and cargoes window.
2748 * @param id Industry type to display, \c NUM_INDUSTRYTYPES selects a default industry type.
2750 static void ShowIndustryCargoesWindow(IndustryType id)
2752 if (id >= NUM_INDUSTRYTYPES) {
2753 for (uint i = 0; i < NUM_INDUSTRYTYPES; i++) {
2754 const IndustrySpec *indsp = GetIndustrySpec(_sorted_industry_types[i]);
2755 if (indsp->enabled) {
2756 id = _sorted_industry_types[i];
2757 break;
2760 if (id >= NUM_INDUSTRYTYPES) return;
2763 Window *w = BringWindowToFrontById(WC_INDUSTRY_CARGOES, 0);
2764 if (w != NULL) {
2765 w->InvalidateData(id);
2766 return;
2768 new IndustryCargoesWindow(id);
2771 /** Open the industry and cargoes window with an industry. */
2772 void ShowIndustryCargoesWindow()
2774 ShowIndustryCargoesWindow(NUM_INDUSTRYTYPES);