Merge branch 'development' into master_joker
[openttd-joker.git] / src / newgrf_gui.cpp
blobf54d425a67d897ef129c38667db3415a6c84dc91
1 /* $Id: newgrf_gui.cpp 26086 2013-11-24 14:46:26Z rubidium $ */
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 newgrf_gui.cpp GUI to change NewGRF settings. */
12 #include "stdafx.h"
13 #include "error.h"
14 #include "settings_gui.h"
15 #include "newgrf.h"
16 #include "strings_func.h"
17 #include "window_func.h"
18 #include "gamelog.h"
19 #include "settings_type.h"
20 #include "settings_func.h"
21 #include "widgets/dropdown_type.h"
22 #include "widgets/dropdown_func.h"
23 #include "network/network.h"
24 #include "network/network_content.h"
25 #include "sortlist_type.h"
26 #include "stringfilter_type.h"
27 #include "querystring_gui.h"
28 #include "core/geometry_func.hpp"
29 #include "newgrf_text.h"
30 #include "textfile_gui.h"
31 #include "tilehighlight_func.h"
32 #include "fios.h"
34 #include "widgets/newgrf_widget.h"
35 #include "widgets/misc_widget.h"
37 #include "table/sprites.h"
39 #include <map>
40 #include "safeguards.h"
42 /**
43 * Show the first NewGRF error we can find.
45 void ShowNewGRFError()
47 /* Do not show errors when entering the main screen */
48 if (_game_mode == GM_MENU) return;
50 for (const GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {
51 /* We only want to show fatal errors */
52 if (c->error == nullptr || c->error->severity != STR_NEWGRF_ERROR_MSG_FATAL) continue;
54 SetDParam (0, c->error->custom_message == nullptr ? c->error->message : STR_JUST_RAW_STRING);
55 SetDParamStr(1, c->error->custom_message);
56 SetDParamStr(2, c->filename);
57 SetDParamStr(3, c->error->data);
58 for (uint i = 0; i < lengthof(c->error->param_value); i++) {
59 SetDParam(4 + i, c->error->param_value[i]);
61 ShowErrorMessage(STR_NEWGRF_ERROR_FATAL_POPUP, INVALID_STRING_ID, WL_CRITICAL);
62 break;
66 static void ShowNewGRFInfo(const GRFConfig *c, uint x, uint y, uint right, uint bottom, bool show_params)
68 if (c->error != nullptr) {
69 char message[512];
70 SetDParamStr(0, c->error->custom_message); // is skipped by built-in messages
71 SetDParamStr(1, c->filename);
72 SetDParamStr(2, c->error->data);
73 for (uint i = 0; i < lengthof(c->error->param_value); i++) {
74 SetDParam(3 + i, c->error->param_value[i]);
76 GetString(message, c->error->custom_message == nullptr ? c->error->message : STR_JUST_RAW_STRING, lastof(message));
78 SetDParamStr(0, message);
79 y = DrawStringMultiLine(x, right, y, bottom, c->error->severity);
82 /* Draw filename or not if it is not known (GRF sent over internet) */
83 if (c->filename != nullptr) {
84 SetDParamStr(0, c->filename);
85 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_FILENAME);
88 /* Prepare and draw GRF ID */
89 char buff[256];
90 seprintf(buff, lastof(buff), "%08X", BSWAP32(c->ident.grfid));
91 SetDParamStr(0, buff);
92 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_GRF_ID);
94 if ((_settings_client.gui.newgrf_developer_tools || _settings_client.gui.newgrf_show_old_versions) && c->version != 0) {
95 SetDParam(0, c->version);
96 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_VERSION);
98 if ((_settings_client.gui.newgrf_developer_tools || _settings_client.gui.newgrf_show_old_versions) && c->min_loadable_version != 0) {
99 SetDParam(0, c->min_loadable_version);
100 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_MIN_VERSION);
103 /* Prepare and draw MD5 sum */
104 md5sumToString(buff, lastof(buff), c->ident.md5sum);
105 SetDParamStr(0, buff);
106 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_MD5SUM);
108 /* Show GRF parameter list */
109 if (show_params) {
110 if (c->num_params > 0) {
111 GRFBuildParamList(buff, c, lastof(buff));
112 SetDParam(0, STR_JUST_RAW_STRING);
113 SetDParamStr(1, buff);
114 } else {
115 SetDParam(0, STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY_NONE);
117 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_PARAMETER);
119 /* Draw the palette of the NewGRF */
120 if (c->palette & GRFP_BLT_32BPP) {
121 SetDParamStr(0, (c->palette & GRFP_USE_WINDOWS) ? "Legacy (W) / 32 bpp" : "Default (D) / 32 bpp");
122 } else {
123 SetDParamStr(0, (c->palette & GRFP_USE_WINDOWS) ? "Legacy (W)" : "Default (D)");
125 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_PALETTE);
128 /* Show flags */
129 if (c->status == GCS_NOT_FOUND) y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_NOT_FOUND);
130 if (c->status == GCS_DISABLED) y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_DISABLED);
131 if (HasBit(c->flags, GCF_INVALID)) y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_INCOMPATIBLE);
132 if (HasBit(c->flags, GCF_COMPATIBLE)) y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_COMPATIBLE_LOADED);
134 /* Draw GRF info if it exists */
135 if (!StrEmpty(c->GetDescription())) {
136 SetDParamStr(0, c->GetDescription());
137 y = DrawStringMultiLine(x, right, y, bottom, STR_BLACK_RAW_STRING);
138 } else {
139 y = DrawStringMultiLine(x, right, y, bottom, STR_NEWGRF_SETTINGS_NO_INFO);
144 * Window for setting the parameters of a NewGRF.
146 struct NewGRFParametersWindow : public Window {
147 static GRFParameterInfo dummy_parameter_info; ///< Dummy info in case a newgrf didn't provide info about some parameter.
148 GRFConfig *grf_config; ///< Set the parameters of this GRFConfig.
149 uint clicked_button; ///< The row in which a button was clicked or UINT_MAX.
150 bool clicked_increase; ///< True if the increase button was clicked, false for the decrease button.
151 bool clicked_dropdown; ///< Whether the dropdown is open.
152 bool closing_dropdown; ///< True, if the dropdown list is currently closing.
153 int timeout; ///< How long before we unpress the last-pressed button?
154 uint clicked_row; ///< The selected parameter
155 int line_height; ///< Height of a row in the matrix widget.
156 Scrollbar *vscroll;
157 bool action14present; ///< True if action14 information is present.
158 bool editable; ///< Allow editing parameters.
160 NewGRFParametersWindow(WindowDesc *desc, GRFConfig *c, bool editable) : Window(desc),
161 grf_config(c),
162 clicked_button(UINT_MAX),
163 clicked_dropdown(false),
164 closing_dropdown(false),
165 timeout(0),
166 clicked_row(UINT_MAX),
167 editable(editable)
169 this->action14present = (c->num_valid_params != lengthof(c->param) || c->param_info.Length() != 0);
171 this->CreateNestedTree();
172 this->vscroll = this->GetScrollbar(WID_NP_SCROLLBAR);
173 this->GetWidget<NWidgetStacked>(WID_NP_SHOW_NUMPAR)->SetDisplayedPlane(this->action14present ? SZSP_HORIZONTAL : 0);
174 this->GetWidget<NWidgetStacked>(WID_NP_SHOW_DESCRIPTION)->SetDisplayedPlane(this->action14present ? 0 : SZSP_HORIZONTAL);
175 this->FinishInitNested(); // Initializes 'this->line_height' as side effect.
177 this->SetWidgetDisabledState(WID_NP_RESET, !this->editable);
179 this->InvalidateData();
183 * Get a dummy parameter-info object with default information.
184 * @param nr The param number that should be changed.
185 * @return GRFParameterInfo with dummy information about the given parameter.
187 static GRFParameterInfo *GetDummyParameterInfo(uint nr)
189 dummy_parameter_info.param_nr = nr;
190 return &dummy_parameter_info;
193 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
195 switch (widget) {
196 case WID_NP_NUMPAR_DEC:
197 case WID_NP_NUMPAR_INC: {
198 size->width = max(SETTING_BUTTON_WIDTH / 2, FONT_HEIGHT_NORMAL);
199 size->height = max(SETTING_BUTTON_HEIGHT, FONT_HEIGHT_NORMAL);
200 break;
203 case WID_NP_NUMPAR: {
204 SetDParamMaxValue(0, lengthof(this->grf_config->param));
205 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
206 d.width += padding.width;
207 d.height += padding.height;
208 *size = maxdim(*size, d);
209 break;
212 case WID_NP_BACKGROUND:
213 this->line_height = max(SETTING_BUTTON_HEIGHT, FONT_HEIGHT_NORMAL) + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
215 resize->width = 1;
216 resize->height = this->line_height;
217 size->height = 5 * this->line_height;
218 break;
220 case WID_NP_DESCRIPTION:
221 /* Minimum size of 4 lines. The 500 is the default size of the window. */
222 Dimension suggestion = {500 - WD_FRAMERECT_LEFT - WD_FRAMERECT_RIGHT, (uint)FONT_HEIGHT_NORMAL * 4 + WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM};
223 for (uint i = 0; i < this->grf_config->param_info.Length(); i++) {
224 const GRFParameterInfo *par_info = this->grf_config->param_info[i];
225 if (par_info == nullptr) continue;
226 const char *desc = GetGRFStringFromGRFText(par_info->desc);
227 if (desc == nullptr) continue;
228 Dimension d = GetStringMultiLineBoundingBox(desc, suggestion);
229 d.height += WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM;
230 suggestion = maxdim(d, suggestion);
232 size->height = suggestion.height;
233 break;
237 virtual void SetStringParameters(int widget) const
239 switch (widget) {
240 case WID_NP_NUMPAR:
241 SetDParam(0, this->vscroll->GetCount());
242 break;
246 virtual void DrawWidget(const Rect &r, int widget) const
248 if (widget == WID_NP_DESCRIPTION) {
249 const GRFParameterInfo *par_info = (this->clicked_row < this->grf_config->param_info.Length()) ? this->grf_config->param_info[this->clicked_row] : nullptr;
250 if (par_info == nullptr) return;
251 const char *desc = GetGRFStringFromGRFText(par_info->desc);
252 if (desc == nullptr) return;
253 DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_TEXTPANEL_TOP, r.bottom - WD_TEXTPANEL_BOTTOM, desc, TC_BLACK);
254 return;
255 } else if (widget != WID_NP_BACKGROUND) {
256 return;
259 bool rtl = _current_text_dir == TD_RTL;
260 uint buttons_left = rtl ? r.right - SETTING_BUTTON_WIDTH - 3 : r.left + 4;
261 uint text_left = r.left + (rtl ? WD_FRAMERECT_LEFT : SETTING_BUTTON_WIDTH + 8);
262 uint text_right = r.right - (rtl ? SETTING_BUTTON_WIDTH + 8 : WD_FRAMERECT_RIGHT);
264 int y = r.top;
265 int button_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
266 int text_y_offset = (this->line_height - FONT_HEIGHT_NORMAL) / 2;
267 for (uint i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < this->vscroll->GetCount(); i++) {
268 GRFParameterInfo *par_info = (i < this->grf_config->param_info.Length()) ? this->grf_config->param_info[i] : nullptr;
269 if (par_info == nullptr) par_info = GetDummyParameterInfo(i);
270 uint32 current_value = par_info->GetValue(this->grf_config);
271 bool selected = (i == this->clicked_row);
273 if (par_info->type == PTYPE_BOOL) {
274 DrawBoolButton(buttons_left, y + button_y_offset, current_value != 0, this->editable);
275 SetDParam(2, par_info->GetValue(this->grf_config) == 0 ? STR_CONFIG_SETTING_OFF : STR_CONFIG_SETTING_ON);
276 } else if (par_info->type == PTYPE_UINT_ENUM) {
277 if (par_info->complete_labels) {
278 DrawDropDownButton(buttons_left, y + button_y_offset, COLOUR_YELLOW, this->clicked_row == i && this->clicked_dropdown, this->editable);
279 } else {
280 DrawArrowButtons(buttons_left, y + button_y_offset, COLOUR_YELLOW, (this->clicked_button == i) ? 1 + (this->clicked_increase != rtl) : 0, this->editable && current_value > par_info->min_value, this->editable && current_value < par_info->max_value);
282 SetDParam(2, STR_JUST_INT);
283 SetDParam(3, current_value);
284 if (par_info->value_names.Contains(current_value)) {
285 const char *label = GetGRFStringFromGRFText(par_info->value_names.Find(current_value)->second);
286 if (label != nullptr) {
287 SetDParam(2, STR_JUST_RAW_STRING);
288 SetDParamStr(3, label);
293 const char *name = GetGRFStringFromGRFText(par_info->name);
294 if (name != nullptr) {
295 SetDParam(0, STR_JUST_RAW_STRING);
296 SetDParamStr(1, name);
297 } else {
298 SetDParam(0, STR_NEWGRF_PARAMETERS_DEFAULT_NAME);
299 SetDParam(1, i + 1);
302 DrawString(text_left, text_right, y + text_y_offset, STR_NEWGRF_PARAMETERS_SETTING, selected ? TC_WHITE : TC_LIGHT_BLUE);
303 y += this->line_height;
307 virtual void OnPaint()
309 if (this->closing_dropdown) {
310 this->closing_dropdown = false;
311 this->clicked_dropdown = false;
313 this->DrawWidgets();
316 virtual void OnClick(Point pt, int widget, int click_count)
318 switch (widget) {
319 case WID_NP_NUMPAR_DEC:
320 if (this->editable && !this->action14present && this->grf_config->num_params > 0) {
321 this->grf_config->num_params--;
322 this->InvalidateData();
323 SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
325 break;
327 case WID_NP_NUMPAR_INC: {
328 GRFConfig *c = this->grf_config;
329 if (this->editable && !this->action14present && c->num_params < c->num_valid_params) {
330 c->param[c->num_params++] = 0;
331 this->InvalidateData();
332 SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
334 break;
337 case WID_NP_BACKGROUND: {
338 if (!this->editable) break;
339 uint num = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NP_BACKGROUND);
340 if (num >= this->vscroll->GetCount()) break;
341 if (this->clicked_row != num) {
342 DeleteChildWindows(WC_QUERY_STRING);
343 HideDropDownMenu(this);
344 this->clicked_row = num;
345 this->clicked_dropdown = false;
348 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_NP_BACKGROUND);
349 int x = pt.x - wid->pos_x;
350 if (_current_text_dir == TD_RTL) x = wid->current_x - 1 - x;
351 x -= 4;
353 GRFParameterInfo *par_info = (num < this->grf_config->param_info.Length()) ? this->grf_config->param_info[num] : nullptr;
354 if (par_info == nullptr) par_info = GetDummyParameterInfo(num);
356 /* One of the arrows is clicked */
357 uint32 old_val = par_info->GetValue(this->grf_config);
358 if (par_info->type != PTYPE_BOOL && IsInsideMM(x, 0, SETTING_BUTTON_WIDTH) && par_info->complete_labels) {
359 if (this->clicked_dropdown) {
360 /* unclick the dropdown */
361 HideDropDownMenu(this);
362 this->clicked_dropdown = false;
363 this->closing_dropdown = false;
364 } else {
365 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_NP_BACKGROUND);
366 int rel_y = (pt.y - (int)wid->pos_y) % this->line_height;
368 Rect wi_rect;
369 wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);;
370 wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
371 wi_rect.top = pt.y - rel_y + (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
372 wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
374 /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
375 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
376 this->clicked_dropdown = true;
377 this->closing_dropdown = false;
379 DropDownList *list = new DropDownList();
380 for (uint32 i = par_info->min_value; i <= par_info->max_value; i++) {
381 *list->Append() = new DropDownListCharStringItem(GetGRFStringFromGRFText(par_info->value_names.Find(i)->second), i, false);
384 ShowDropDownListAt(this, list, old_val, -1, wi_rect, COLOUR_ORANGE, true);
387 } else if (IsInsideMM(x, 0, SETTING_BUTTON_WIDTH)) {
388 uint32 val = old_val;
389 if (par_info->type == PTYPE_BOOL) {
390 val = !val;
391 } else {
392 if (x >= SETTING_BUTTON_WIDTH / 2) {
393 /* Increase button clicked */
394 if (val < par_info->max_value) val++;
395 this->clicked_increase = true;
396 } else {
397 /* Decrease button clicked */
398 if (val > par_info->min_value) val--;
399 this->clicked_increase = false;
402 if (val != old_val) {
403 par_info->SetValue(this->grf_config, val);
405 this->clicked_button = num;
406 this->timeout = 5;
408 } else if (par_info->type == PTYPE_UINT_ENUM && !par_info->complete_labels && click_count >= 2) {
409 /* Display a query box so users can enter a custom value. */
410 SetDParam(0, old_val);
411 ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 10, this, CS_NUMERAL, QSF_NONE);
413 this->SetDirty();
414 break;
417 case WID_NP_RESET:
418 if (!this->editable) break;
419 this->grf_config->SetParameterDefaults();
420 this->InvalidateData();
421 SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
422 break;
424 case WID_NP_ACCEPT:
425 delete this;
426 break;
430 virtual void OnQueryTextFinished(char *str)
432 if (StrEmpty(str)) return;
433 int32 value = atoi(str);
434 GRFParameterInfo *par_info = ((uint)this->clicked_row < this->grf_config->param_info.Length()) ? this->grf_config->param_info[this->clicked_row] : nullptr;
435 if (par_info == nullptr) par_info = GetDummyParameterInfo(this->clicked_row);
436 uint32 val = Clamp<uint32>(value, par_info->min_value, par_info->max_value);
437 par_info->SetValue(this->grf_config, val);
438 this->SetDirty();
441 virtual void OnDropdownSelect(int widget, int index)
443 assert(this->clicked_dropdown);
444 GRFParameterInfo *par_info = ((uint)this->clicked_row < this->grf_config->param_info.Length()) ? this->grf_config->param_info[this->clicked_row] : nullptr;
445 if (par_info == nullptr) par_info = GetDummyParameterInfo(this->clicked_row);
446 par_info->SetValue(this->grf_config, index);
447 this->SetDirty();
450 virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
452 /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
453 * the same dropdown button was clicked again, and then not open the dropdown again.
454 * So, we only remember that it was closed, and process it on the next OnPaint, which is
455 * after OnClick. */
456 assert(this->clicked_dropdown);
457 this->closing_dropdown = true;
458 this->SetDirty();
461 virtual void OnResize()
463 this->vscroll->SetCapacityFromWidget(this, WID_NP_BACKGROUND);
467 * Some data on this window has become invalid.
468 * @param data Information about the changed data.
469 * @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.
471 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
473 if (!gui_scope) return;
474 if (!this->action14present) {
475 this->SetWidgetDisabledState(WID_NP_NUMPAR_DEC, !this->editable || this->grf_config->num_params == 0);
476 this->SetWidgetDisabledState(WID_NP_NUMPAR_INC, !this->editable || this->grf_config->num_params >= this->grf_config->num_valid_params);
479 this->vscroll->SetCount(this->action14present ? this->grf_config->num_valid_params : this->grf_config->num_params);
480 if (this->clicked_row != UINT_MAX && this->clicked_row >= this->vscroll->GetCount()) {
481 this->clicked_row = UINT_MAX;
482 DeleteChildWindows(WC_QUERY_STRING);
486 virtual void OnTick()
488 if (--this->timeout == 0) {
489 this->clicked_button = UINT_MAX;
490 this->SetDirty();
494 GRFParameterInfo NewGRFParametersWindow::dummy_parameter_info(0);
497 static const NWidgetPart _nested_newgrf_parameter_widgets[] = {
498 NWidget(NWID_HORIZONTAL),
499 NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
500 NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_PARAMETERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
501 NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
502 EndContainer(),
503 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NP_SHOW_NUMPAR),
504 NWidget(WWT_PANEL, COLOUR_MAUVE), SetResize(1, 0), SetFill(1, 0), SetPIP(4, 0, 4),
505 NWidget(NWID_HORIZONTAL), SetPIP(4, 0, 4),
506 NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_NP_NUMPAR_DEC), SetMinimalSize(12, 12), SetDataTip(AWV_DECREASE, STR_NULL),
507 NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_NP_NUMPAR_INC), SetMinimalSize(12, 12), SetDataTip(AWV_INCREASE, STR_NULL),
508 NWidget(WWT_TEXT, COLOUR_MAUVE, WID_NP_NUMPAR), SetResize(1, 0), SetFill(1, 0), SetPadding(0, 0, 0, 4), SetDataTip(STR_NEWGRF_PARAMETERS_NUM_PARAM, STR_NULL),
509 EndContainer(),
510 EndContainer(),
511 EndContainer(),
512 NWidget(NWID_HORIZONTAL),
513 NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_NP_BACKGROUND), SetMinimalSize(188, 182), SetResize(1, 1), SetFill(1, 0), SetMatrixDataTip(1, 0, STR_NULL), SetScrollbar(WID_NP_SCROLLBAR),
514 NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_NP_SCROLLBAR),
515 EndContainer(),
516 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NP_SHOW_DESCRIPTION),
517 NWidget(WWT_PANEL, COLOUR_MAUVE, WID_NP_DESCRIPTION), SetResize(1, 0), SetFill(1, 0),
518 EndContainer(),
519 EndContainer(),
520 NWidget(NWID_HORIZONTAL),
521 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
522 NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_NP_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_NEWGRF_PARAMETERS_CLOSE, STR_NULL),
523 NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_NP_RESET), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_NEWGRF_PARAMETERS_RESET, STR_NEWGRF_PARAMETERS_RESET_TOOLTIP),
524 EndContainer(),
525 NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
526 EndContainer(),
529 /** Window definition for the change grf parameters window */
530 static WindowDesc _newgrf_parameters_desc(
531 WDP_CENTER, "settings_newgrf_config", 500, 208,
532 WC_GRF_PARAMETERS, WC_NONE,
534 _nested_newgrf_parameter_widgets, lengthof(_nested_newgrf_parameter_widgets)
537 static void OpenGRFParameterWindow(GRFConfig *c, bool editable)
539 DeleteWindowByClass(WC_GRF_PARAMETERS);
540 new NewGRFParametersWindow(&_newgrf_parameters_desc, c, editable);
543 /** Window for displaying the textfile of a NewGRF. */
544 struct NewGRFTextfileWindow : public TextfileWindow {
545 const GRFConfig *grf_config; ///< View the textfile of this GRFConfig.
547 NewGRFTextfileWindow(TextfileType file_type, const GRFConfig *c) : TextfileWindow(file_type), grf_config(c)
549 const char *textfile = this->grf_config->GetTextfile(file_type);
550 this->LoadTextfile(textfile, NEWGRF_DIR);
553 /* virtual */ void SetStringParameters(int widget) const
555 if (widget == WID_TF_CAPTION) {
556 SetDParam(0, STR_CONTENT_TYPE_NEWGRF);
557 SetDParamStr(1, this->grf_config->GetName());
562 void ShowNewGRFTextfileWindow(TextfileType file_type, const GRFConfig *c)
564 DeleteWindowByClass(WC_TEXTFILE);
565 new NewGRFTextfileWindow(file_type, c);
568 static GRFPresetList _grf_preset_list; ///< List of known NewGRF presets. @see GetGRFPresetList
570 class DropDownListPresetItem : public DropDownListItem {
571 public:
572 DropDownListPresetItem(int result) : DropDownListItem(result, false) {}
574 virtual ~DropDownListPresetItem() {}
576 bool Selectable() const
578 return true;
581 void Draw(int left, int right, int top, int bottom, bool sel, int bg_colour) const
583 DrawString(left + 2, right + 2, top, _grf_preset_list[this->result], sel ? TC_WHITE : TC_BLACK);
588 typedef std::map<uint32, const GRFConfig *> GrfIdMap; ///< Map of grfid to the grf config.
591 * Add all grf configs from \a c into the map.
592 * @param c Grf list to add.
593 * @param grfid_map Map to add them to.
595 static void FillGrfidMap(const GRFConfig *c, GrfIdMap *grfid_map)
597 while (c != nullptr) {
598 std::pair<uint32, const GRFConfig *> p(c->ident.grfid, c);
599 grfid_map->insert(p);
600 c = c->next;
604 static void NewGRFConfirmationCallback(Window *w, bool confirmed);
605 static void ShowSavePresetWindow(const char *initial_text);
606 void PostCheckNewGRFLoadWarnings();
609 * Window for showing NewGRF files
611 struct NewGRFWindow : public Window, NewGRFScanCallback {
612 typedef GUIList<const GRFConfig *, StringFilter &> GUIGRFConfigList;
614 static const uint EDITBOX_MAX_SIZE = 50;
616 static Listing last_sorting; ///< Default sorting of #GUIGRFConfigList.
617 static Filtering last_filtering; ///< Default filtering of #GUIGRFConfigList.
618 static GUIGRFConfigList::SortFunction * const sorter_funcs[]; ///< Sort functions of the #GUIGRFConfigList.
619 static GUIGRFConfigList::FilterFunction * const filter_funcs[]; ///< Filter functions of the #GUIGRFConfigList.
621 GUIGRFConfigList avails; ///< Available (non-active) grfs.
622 const GRFConfig *avail_sel; ///< Currently selected available grf. \c nullptr is none is selected.
623 int avail_pos; ///< Index of #avail_sel if existing, else \c -1.
624 StringFilter string_filter; ///< Filter for available grf.
625 QueryString filter_editbox; ///< Filter editbox;
627 GRFConfig *actives; ///< Temporary active grf list to which changes are made.
628 GRFConfig *active_sel; ///< Selected active grf item.
630 GRFConfig **orig_list; ///< List active grfs in the game. Used as initial value, may be updated by the window.
631 bool editable; ///< Is the window editable?
632 bool show_params; ///< Are the grf-parameters shown in the info-panel?
633 bool execute; ///< On pressing 'apply changes' are grf changes applied immediately, or only list is updated.
634 int preset; ///< Selected preset or \c -1 if none selected.
635 int active_over; ///< Active GRF item over which another one is dragged, \c -1 if none.
637 Scrollbar *vscroll;
638 Scrollbar *vscroll2;
640 NewGRFWindow(WindowDesc *desc, bool editable, bool show_params, bool execute, GRFConfig **orig_list) : Window(desc), filter_editbox(EDITBOX_MAX_SIZE)
642 this->avail_sel = nullptr;
643 this->avail_pos = -1;
644 this->active_sel = nullptr;
645 this->actives = nullptr;
646 this->orig_list = orig_list;
647 this->editable = editable;
648 this->execute = execute;
649 this->show_params = show_params;
650 this->preset = -1;
651 this->active_over = -1;
653 CopyGRFConfigList(&this->actives, *orig_list, false);
654 GetGRFPresetList(&_grf_preset_list);
656 this->CreateNestedTree();
657 this->vscroll = this->GetScrollbar(WID_NS_SCROLLBAR);
658 this->vscroll2 = this->GetScrollbar(WID_NS_SCROLL2BAR);
660 this->GetWidget<NWidgetStacked>(WID_NS_SHOW_REMOVE)->SetDisplayedPlane(this->editable ? 0 : 1);
661 this->GetWidget<NWidgetStacked>(WID_NS_SHOW_APPLY)->SetDisplayedPlane(this->editable ? 0 : this->show_params ? 1 : SZSP_HORIZONTAL);
662 this->FinishInitNested(WN_GAME_OPTIONS_NEWGRF_STATE);
664 this->querystrings[WID_NS_FILTER] = &this->filter_editbox;
665 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
666 if (editable) {
667 this->SetFocusedWidget(WID_NS_FILTER);
668 } else {
669 this->DisableWidget(WID_NS_FILTER);
672 this->avails.SetListing(this->last_sorting);
673 this->avails.SetFiltering(this->last_filtering);
674 this->avails.SetSortFuncs(this->sorter_funcs);
675 this->avails.SetFilterFuncs(this->filter_funcs);
676 this->avails.ForceRebuild();
678 this->OnInvalidateData(GOID_NEWGRF_LIST_EDITED);
681 ~NewGRFWindow()
683 DeleteWindowByClass(WC_GRF_PARAMETERS);
684 DeleteWindowByClass(WC_TEXTFILE);
685 DeleteWindowByClass(WC_SAVE_PRESET);
687 if (this->editable && !this->execute) {
688 CopyGRFConfigList(this->orig_list, this->actives, true);
689 ResetGRFConfig(false);
690 ReloadNewGRFData();
691 PostCheckNewGRFLoadWarnings();
694 /* Remove the temporary copy of grf-list used in window */
695 ClearGRFConfigList(&this->actives);
696 _grf_preset_list.Clear();
700 * Test whether the currently active set of NewGRFs can be upgraded with the available NewGRFs.
701 * @return Whether an upgrade is possible.
703 bool CanUpgradeCurrent()
705 GrfIdMap grfid_map;
706 FillGrfidMap(this->actives, &grfid_map);
708 for (const GRFConfig *a = _all_grfs; a != nullptr; a = a->next) {
709 GrfIdMap::const_iterator iter = grfid_map.find(a->ident.grfid);
710 if (iter != grfid_map.end() && a->version > iter->second->version) return true;
712 return false;
715 /** Upgrade the currently active set of NewGRFs. */
716 void UpgradeCurrent()
718 GrfIdMap grfid_map;
719 FillGrfidMap(this->actives, &grfid_map);
721 for (const GRFConfig *a = _all_grfs; a != nullptr; a = a->next) {
722 GrfIdMap::iterator iter = grfid_map.find(a->ident.grfid);
723 if (iter == grfid_map.end() || iter->second->version >= a->version) continue;
725 GRFConfig **c = &this->actives;
726 while (*c != iter->second) c = &(*c)->next;
727 GRFConfig *d = new GRFConfig(*a);
728 d->next = (*c)->next;
729 d->CopyParams(**c);
730 if (this->active_sel == *c) this->active_sel = nullptr;
731 delete *c;
732 *c = d;
733 iter->second = d;
737 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
739 switch (widget) {
740 case WID_NS_FILE_LIST:
742 Dimension d = maxdim(GetSpriteSize(SPR_SQUARE), GetSpriteSize(SPR_WARNING_SIGN));
743 resize->height = max(d.height + 2U, FONT_HEIGHT_NORMAL + 2U);
744 size->height = max(size->height, WD_FRAMERECT_TOP + 6 * resize->height + WD_FRAMERECT_BOTTOM);
745 break;
748 case WID_NS_AVAIL_LIST:
749 resize->height = max(12, FONT_HEIGHT_NORMAL + 2);
750 size->height = max(size->height, WD_FRAMERECT_TOP + 8 * resize->height + WD_FRAMERECT_BOTTOM);
751 break;
753 case WID_NS_NEWGRF_INFO_TITLE: {
754 Dimension dim = GetStringBoundingBox(STR_NEWGRF_SETTINGS_INFO_TITLE);
755 size->height = max(size->height, dim.height + WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM);
756 size->width = max(size->width, dim.width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT);
757 break;
760 case WID_NS_NEWGRF_INFO:
761 size->height = max(size->height, WD_FRAMERECT_TOP + 10 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM + padding.height + 2);
762 break;
764 case WID_NS_PRESET_LIST: {
765 Dimension d = GetStringBoundingBox(STR_NUM_CUSTOM);
766 for (uint i = 0; i < _grf_preset_list.Length(); i++) {
767 if (_grf_preset_list[i] != nullptr) {
768 SetDParamStr(0, _grf_preset_list[i]);
769 d = maxdim(d, GetStringBoundingBox(STR_JUST_RAW_STRING));
772 d.width += padding.width;
773 *size = maxdim(d, *size);
774 break;
777 case WID_NS_CONTENT_DOWNLOAD:
778 case WID_NS_CONTENT_DOWNLOAD2: {
779 Dimension d = GetStringBoundingBox(STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON);
780 *size = maxdim(d, GetStringBoundingBox(STR_INTRO_ONLINE_CONTENT));
781 size->width += padding.width;
782 size->height += padding.height;
783 break;
788 virtual void OnResize()
790 this->vscroll->SetCapacityFromWidget(this, WID_NS_FILE_LIST);
791 this->vscroll2->SetCapacityFromWidget(this, WID_NS_AVAIL_LIST);
794 virtual void SetStringParameters(int widget) const
796 switch (widget) {
797 case WID_NS_PRESET_LIST:
798 if (this->preset == -1) {
799 SetDParam(0, STR_NUM_CUSTOM);
800 } else {
801 SetDParam(0, STR_JUST_RAW_STRING);
802 SetDParamStr(1, _grf_preset_list[this->preset]);
804 break;
809 * Pick the palette for the sprite of the grf to display.
810 * @param c grf to display.
811 * @return Palette for the sprite.
813 inline PaletteID GetPalette(const GRFConfig *c) const
815 PaletteID pal;
817 /* Pick a colour */
818 switch (c->status) {
819 case GCS_NOT_FOUND:
820 case GCS_DISABLED:
821 pal = PALETTE_TO_RED;
822 break;
823 case GCS_ACTIVATED:
824 pal = PALETTE_TO_GREEN;
825 break;
826 default:
827 pal = PALETTE_TO_BLUE;
828 break;
831 /* Do not show a "not-failure" colour when it actually failed to load */
832 if (pal != PALETTE_TO_RED) {
833 if (HasBit(c->flags, GCF_STATIC)) {
834 pal = PALETTE_TO_GREY;
835 } else if (HasBit(c->flags, GCF_COMPATIBLE)) {
836 pal = PALETTE_TO_ORANGE;
840 return pal;
843 virtual void DrawWidget(const Rect &r, int widget) const
845 switch (widget) {
846 case WID_NS_FILE_LIST: {
847 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK);
849 uint step_height = this->GetWidget<NWidgetBase>(WID_NS_FILE_LIST)->resize_y;
850 uint y = r.top + WD_FRAMERECT_TOP;
851 Dimension square = GetSpriteSize(SPR_SQUARE);
852 Dimension warning = GetSpriteSize(SPR_WARNING_SIGN);
853 int square_offset_y = (step_height - square.height) / 2;
854 int warning_offset_y = (step_height - warning.height) / 2;
855 int offset_y = (step_height - FONT_HEIGHT_NORMAL) / 2;
857 bool rtl = _current_text_dir == TD_RTL;
858 uint text_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.left + square.width + 15;
859 uint text_right = rtl ? r.right - square.width - 15 : r.right - WD_FRAMERECT_RIGHT;
860 uint square_left = rtl ? r.right - square.width - 5 : r.left + 5;
861 uint warning_left = rtl ? r.right - square.width - warning.width - 10 : r.left + square.width + 10;
863 int i = 0;
864 for (const GRFConfig *c = this->actives; c != nullptr; c = c->next, i++) {
865 if (this->vscroll->IsVisible(i)) {
866 const char *text = c->GetName();
867 bool h = (this->active_sel == c);
868 PaletteID pal = this->GetPalette(c);
870 if (h) {
871 GfxFillRect(r.left + 1, y, r.right - 1, y + step_height - 1, PC_DARK_BLUE);
872 } else if (i == this->active_over) {
873 /* Get index of current selection. */
874 int active_sel_pos = 0;
875 for (GRFConfig *c = this->actives; c != nullptr && c != this->active_sel; c = c->next, active_sel_pos++) {}
876 if (active_sel_pos != this->active_over) {
877 uint top = this->active_over < active_sel_pos ? y + 1 : y + step_height - 2;
878 GfxFillRect(r.left + WD_FRAMERECT_LEFT, top - 1, r.right - WD_FRAMERECT_RIGHT, top + 1, PC_GREY);
881 DrawSprite(SPR_SQUARE, pal, square_left, y + square_offset_y);
882 if (c->error != nullptr) DrawSprite(SPR_WARNING_SIGN, 0, warning_left, y + warning_offset_y);
883 uint txtoffset = c->error == nullptr ? 0 : warning.width;
884 DrawString(text_left + (rtl ? 0 : txtoffset), text_right - (rtl ? txtoffset : 0), y + offset_y, text, h ? TC_WHITE : TC_ORANGE);
885 y += step_height;
888 if (i == this->active_over && this->vscroll->IsVisible(i)) { // Highlight is after the last GRF entry.
889 GfxFillRect(r.left + WD_FRAMERECT_LEFT, y, r.right - WD_FRAMERECT_RIGHT, y + 2, PC_GREY);
891 break;
894 case WID_NS_AVAIL_LIST: {
895 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, this->active_over == -2 ? PC_DARK_GREY : PC_BLACK);
897 uint step_height = this->GetWidget<NWidgetBase>(WID_NS_AVAIL_LIST)->resize_y;
898 int offset_y = (step_height - FONT_HEIGHT_NORMAL) / 2;
899 uint y = r.top + WD_FRAMERECT_TOP;
900 uint min_index = this->vscroll2->GetPosition();
901 uint max_index = min(min_index + this->vscroll2->GetCapacity(), this->avails.Length());
903 for (uint i = min_index; i < max_index; i++) {
904 const GRFConfig *c = this->avails[i];
905 bool h = (c == this->avail_sel);
906 const char *text = c->GetName();
908 if (h) GfxFillRect(r.left + 1, y, r.right - 1, y + step_height - 1, PC_DARK_BLUE);
909 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y + offset_y, text, h ? TC_WHITE : TC_SILVER);
910 y += step_height;
912 break;
915 case WID_NS_NEWGRF_INFO_TITLE:
916 /* Create the nice grayish rectangle at the details top. */
917 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_DARK_BLUE);
918 DrawString(r.left, r.right, (r.top + r.bottom - FONT_HEIGHT_NORMAL) / 2, STR_NEWGRF_SETTINGS_INFO_TITLE, TC_FROMSTRING, SA_HOR_CENTER);
919 break;
921 case WID_NS_NEWGRF_INFO: {
922 const GRFConfig *selected = this->active_sel;
923 if (selected == nullptr) selected = this->avail_sel;
924 if (selected != nullptr) {
925 ShowNewGRFInfo(selected, r.left + WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP, r.right - WD_FRAMERECT_RIGHT, r.bottom - WD_FRAMERECT_BOTTOM, this->show_params);
927 break;
932 virtual void OnClick(Point pt, int widget, int click_count)
934 if (widget >= WID_NS_NEWGRF_TEXTFILE && widget < WID_NS_NEWGRF_TEXTFILE + TFT_END) {
935 if (this->active_sel == nullptr && this->avail_sel == nullptr) return;
937 ShowNewGRFTextfileWindow((TextfileType)(widget - WID_NS_NEWGRF_TEXTFILE), this->active_sel != nullptr ? this->active_sel : this->avail_sel);
938 return;
941 switch (widget) {
942 case WID_NS_PRESET_LIST: {
943 DropDownList *list = new DropDownList();
945 /* Add 'None' option for clearing list */
946 *list->Append() = new DropDownListStringItem(STR_NONE, -1, false);
948 for (uint i = 0; i < _grf_preset_list.Length(); i++) {
949 if (_grf_preset_list[i] != nullptr) {
950 *list->Append() = new DropDownListPresetItem(i);
954 this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
955 ShowDropDownList(this, list, this->preset, WID_NS_PRESET_LIST);
956 break;
959 case WID_NS_OPEN_URL: {
960 const GRFConfig *c = (this->avail_sel == nullptr) ? this->active_sel : this->avail_sel;
962 extern void OpenBrowser(const char *url);
963 OpenBrowser(c->GetURL());
964 break;
967 case WID_NS_PRESET_SAVE:
968 ShowSavePresetWindow((this->preset == -1) ? nullptr : _grf_preset_list[this->preset]);
969 break;
971 case WID_NS_PRESET_DELETE:
972 if (this->preset == -1) return;
974 DeleteGRFPresetFromConfig(_grf_preset_list[this->preset]);
975 GetGRFPresetList(&_grf_preset_list);
976 this->preset = -1;
977 this->InvalidateData();
978 this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
979 break;
981 case WID_NS_MOVE_UP: { // Move GRF up
982 if (this->active_sel == nullptr || !this->editable) break;
984 int pos = 0;
985 for (GRFConfig **pc = &this->actives; *pc != nullptr; pc = &(*pc)->next, pos++) {
986 GRFConfig *c = *pc;
987 if (c->next == this->active_sel) {
988 c->next = this->active_sel->next;
989 this->active_sel->next = c;
990 *pc = this->active_sel;
991 break;
994 this->vscroll->ScrollTowards(pos);
995 this->preset = -1;
996 this->InvalidateData();
997 break;
1000 case WID_NS_MOVE_DOWN: { // Move GRF down
1001 if (this->active_sel == nullptr || !this->editable) break;
1003 int pos = 1; // Start at 1 as we swap the selected newgrf with the next one
1004 for (GRFConfig **pc = &this->actives; *pc != nullptr; pc = &(*pc)->next, pos++) {
1005 GRFConfig *c = *pc;
1006 if (c == this->active_sel) {
1007 *pc = c->next;
1008 c->next = c->next->next;
1009 (*pc)->next = c;
1010 break;
1013 this->vscroll->ScrollTowards(pos);
1014 this->preset = -1;
1015 this->InvalidateData();
1016 break;
1019 case WID_NS_FILE_LIST: { // Select an active GRF.
1020 ResetObjectToPlace();
1022 uint i = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST);
1024 GRFConfig *c;
1025 for (c = this->actives; c != nullptr && i > 0; c = c->next, i--) {}
1027 if (this->active_sel != c) DeleteWindowByClass(WC_GRF_PARAMETERS);
1028 this->active_sel = c;
1029 this->avail_sel = nullptr;
1030 this->avail_pos = -1;
1032 this->InvalidateData();
1033 if (click_count == 1) {
1034 if (this->editable && this->active_sel != nullptr) SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
1035 break;
1037 /* With double click, continue */
1039 FALLTHROUGH;
1041 case WID_NS_REMOVE: { // Remove GRF
1042 if (this->active_sel == nullptr || !this->editable) break;
1043 DeleteWindowByClass(WC_GRF_PARAMETERS);
1045 /* Choose the next GRF file to be the selected file. */
1046 GRFConfig *newsel = this->active_sel->next;
1047 for (GRFConfig **pc = &this->actives; *pc != nullptr; pc = &(*pc)->next) {
1048 GRFConfig *c = *pc;
1049 /* If the new selection is empty (i.e. we're deleting the last item
1050 * in the list, pick the file just before the selected file */
1051 if (newsel == nullptr && c->next == this->active_sel) newsel = c;
1053 if (c == this->active_sel) {
1054 if (newsel == c) newsel = nullptr;
1056 *pc = c->next;
1057 delete c;
1058 break;
1062 this->active_sel = newsel;
1063 this->preset = -1;
1064 this->avail_pos = -1;
1065 this->avail_sel = nullptr;
1066 this->avails.ForceRebuild();
1067 this->InvalidateData(GOID_NEWGRF_LIST_EDITED);
1068 break;
1071 case WID_NS_UPGRADE: { // Upgrade GRF.
1072 if (!this->editable || this->actives == nullptr) break;
1073 UpgradeCurrent();
1074 this->InvalidateData(GOID_NEWGRF_LIST_EDITED);
1075 break;
1078 case WID_NS_AVAIL_LIST: { // Select a non-active GRF.
1079 ResetObjectToPlace();
1081 uint i = this->vscroll2->GetScrolledRowFromWidget(pt.y, this, WID_NS_AVAIL_LIST);
1082 this->active_sel = nullptr;
1083 DeleteWindowByClass(WC_GRF_PARAMETERS);
1084 if (i < this->avails.Length()) {
1085 this->avail_sel = this->avails[i];
1086 this->avail_pos = i;
1088 this->InvalidateData();
1089 if (click_count == 1) {
1090 if (this->editable && this->avail_sel != nullptr && !HasBit(this->avail_sel->flags, GCF_INVALID)) SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
1091 break;
1093 /* With double click, continue */
1095 FALLTHROUGH;
1097 case WID_NS_ADD:
1098 if (this->avail_sel == nullptr || !this->editable || HasBit(this->avail_sel->flags, GCF_INVALID)) break;
1100 this->AddGRFToActive();
1101 break;
1103 case WID_NS_APPLY_CHANGES: // Apply changes made to GRF list
1104 if (!this->editable) break;
1105 if (this->execute) {
1106 ShowQuery(
1107 STR_NEWGRF_POPUP_CAUTION_CAPTION,
1108 STR_NEWGRF_CONFIRMATION_TEXT,
1109 this,
1110 NewGRFConfirmationCallback
1112 } else {
1113 CopyGRFConfigList(this->orig_list, this->actives, true);
1114 ResetGRFConfig(false);
1115 ReloadNewGRFData();
1116 PostCheckNewGRFLoadWarnings();
1118 this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
1119 break;
1121 case WID_NS_VIEW_PARAMETERS:
1122 case WID_NS_SET_PARAMETERS: { // Edit parameters
1123 if (this->active_sel == nullptr || !this->show_params || this->active_sel->num_valid_params == 0) break;
1125 OpenGRFParameterWindow(this->active_sel, this->editable);
1126 break;
1129 case WID_NS_TOGGLE_PALETTE:
1130 if (this->active_sel != nullptr && this->editable) {
1131 this->active_sel->palette ^= GRFP_USE_MASK;
1132 this->SetDirty();
1134 break;
1136 case WID_NS_CONTENT_DOWNLOAD:
1137 case WID_NS_CONTENT_DOWNLOAD2:
1138 if (!_network_available) {
1139 ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
1140 } else {
1141 #if defined(ENABLE_NETWORK)
1142 this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
1144 ShowMissingContentWindow(this->actives);
1145 #endif
1147 break;
1149 case WID_NS_RESCAN_FILES:
1150 case WID_NS_RESCAN_FILES2:
1151 ScanNewGRFFiles(this);
1152 break;
1156 virtual void OnNewGRFsScanned()
1158 this->avail_sel = nullptr;
1159 this->avail_pos = -1;
1160 this->avails.ForceRebuild();
1161 this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
1162 this->DeleteChildWindows(WC_TEXTFILE); // Remove the view textfile window
1165 virtual void OnDropdownSelect(int widget, int index)
1167 if (!this->editable) return;
1169 ClearGRFConfigList(&this->actives);
1170 this->preset = index;
1172 if (index != -1) {
1173 this->actives = LoadGRFPresetFromConfig(_grf_preset_list[index]);
1175 this->avails.ForceRebuild();
1177 ResetObjectToPlace();
1178 DeleteWindowByClass(WC_GRF_PARAMETERS);
1179 this->active_sel = nullptr;
1180 this->InvalidateData(GOID_NEWGRF_PRESET_LOADED);
1183 virtual void OnQueryTextFinished(char *str)
1185 if (str == nullptr) return;
1187 SaveGRFPresetToConfig(str, this->actives);
1188 GetGRFPresetList(&_grf_preset_list);
1190 /* Switch to this preset */
1191 for (uint i = 0; i < _grf_preset_list.Length(); i++) {
1192 if (_grf_preset_list[i] != nullptr && strcmp(_grf_preset_list[i], str) == 0) {
1193 this->preset = i;
1194 break;
1198 this->InvalidateData();
1202 * Some data on this window has become invalid.
1203 * @param data Information about the changed data. @see GameOptionsInvalidationData
1204 * @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.
1206 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
1208 if (!gui_scope) return;
1209 switch (data) {
1210 default:
1211 /* Nothing important to do */
1212 break;
1214 case GOID_NEWGRF_RESCANNED:
1215 /* Search the list for items that are now found and mark them as such. */
1216 for (GRFConfig **l = &this->actives; *l != nullptr; l = &(*l)->next) {
1217 GRFConfig *c = *l;
1218 bool compatible = HasBit(c->flags, GCF_COMPATIBLE);
1219 if (c->status != GCS_NOT_FOUND && !compatible) continue;
1221 const GRFConfig *f = FindGRFConfig(c->ident.grfid, FGCM_EXACT, compatible ? c->original_md5sum : c->ident.md5sum);
1222 if (f == nullptr || HasBit(f->flags, GCF_INVALID)) continue;
1224 *l = new GRFConfig(*f);
1225 (*l)->next = c->next;
1227 if (active_sel == c) active_sel = *l;
1229 delete c;
1232 this->avails.ForceRebuild();
1233 FALLTHROUGH;
1235 case GOID_NEWGRF_LIST_EDITED:
1236 this->preset = -1;
1237 FALLTHROUGH;
1239 case GOID_NEWGRF_PRESET_LOADED: {
1240 /* Update scrollbars */
1241 int i = 0;
1242 for (const GRFConfig *c = this->actives; c != nullptr; c = c->next, i++) {}
1244 this->vscroll->SetCount(i + 1); // Reserve empty space for drag and drop handling.
1246 if (this->avail_pos >= 0) this->vscroll2->ScrollTowards(this->avail_pos);
1247 break;
1251 this->BuildAvailables();
1253 this->SetWidgetsDisabledState(!this->editable,
1254 WID_NS_PRESET_LIST,
1255 WID_NS_APPLY_CHANGES,
1256 WID_NS_TOGGLE_PALETTE,
1257 WIDGET_LIST_END
1259 this->SetWidgetDisabledState(WID_NS_ADD, !this->editable || this->avail_sel == nullptr || HasBit(this->avail_sel->flags, GCF_INVALID));
1260 this->SetWidgetDisabledState(WID_NS_UPGRADE, !this->editable || this->actives == nullptr || !this->CanUpgradeCurrent());
1262 bool disable_all = this->active_sel == nullptr || !this->editable;
1263 this->SetWidgetsDisabledState(disable_all,
1264 WID_NS_REMOVE,
1265 WID_NS_MOVE_UP,
1266 WID_NS_MOVE_DOWN,
1267 WIDGET_LIST_END
1270 const GRFConfig *c = (this->avail_sel == nullptr) ? this->active_sel : this->avail_sel;
1271 for (TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
1272 this->SetWidgetDisabledState(WID_NS_NEWGRF_TEXTFILE + tft, c == nullptr || c->GetTextfile(tft) == nullptr);
1274 this->SetWidgetDisabledState(WID_NS_OPEN_URL, c == nullptr || StrEmpty(c->GetURL()));
1276 this->SetWidgetDisabledState(WID_NS_SET_PARAMETERS, !this->show_params || this->active_sel == nullptr || this->active_sel->num_valid_params == 0);
1277 this->SetWidgetDisabledState(WID_NS_VIEW_PARAMETERS, !this->show_params || this->active_sel == nullptr || this->active_sel->num_valid_params == 0);
1278 this->SetWidgetDisabledState(WID_NS_TOGGLE_PALETTE, disable_all ||
1279 (!(_settings_client.gui.newgrf_developer_tools || _settings_client.gui.scenario_developer) && ((c->palette & GRFP_GRF_MASK) != GRFP_GRF_UNSET)));
1281 if (!disable_all) {
1282 /* All widgets are now enabled, so disable widgets we can't use */
1283 if (this->active_sel == this->actives) this->DisableWidget(WID_NS_MOVE_UP);
1284 if (this->active_sel->next == nullptr) this->DisableWidget(WID_NS_MOVE_DOWN);
1287 this->SetWidgetDisabledState(WID_NS_PRESET_DELETE, this->preset == -1);
1289 bool has_missing = false;
1290 bool has_compatible = false;
1291 for (const GRFConfig *c = this->actives; !has_missing && c != nullptr; c = c->next) {
1292 has_missing |= c->status == GCS_NOT_FOUND;
1293 has_compatible |= HasBit(c->flags, GCF_COMPATIBLE);
1295 uint32 widget_data;
1296 StringID tool_tip;
1297 if (has_missing || has_compatible) {
1298 widget_data = STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON;
1299 tool_tip = STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP;
1300 } else {
1301 widget_data = STR_INTRO_ONLINE_CONTENT;
1302 tool_tip = STR_INTRO_TOOLTIP_ONLINE_CONTENT;
1304 this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD)->widget_data = widget_data;
1305 this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD)->tool_tip = tool_tip;
1306 this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD2)->widget_data = widget_data;
1307 this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD2)->tool_tip = tool_tip;
1309 this->SetWidgetDisabledState(WID_NS_PRESET_SAVE, has_missing);
1312 virtual EventState OnKeyPress(WChar key, uint16 keycode)
1314 if (!this->editable) return ES_NOT_HANDLED;
1316 switch (keycode) {
1317 case WKC_UP:
1318 /* scroll up by one */
1319 if (this->avail_pos > 0) this->avail_pos--;
1320 break;
1322 case WKC_DOWN:
1323 /* scroll down by one */
1324 if (this->avail_pos < (int)this->avails.Length() - 1) this->avail_pos++;
1325 break;
1327 case WKC_PAGEUP:
1328 /* scroll up a page */
1329 this->avail_pos = (this->avail_pos < this->vscroll2->GetCapacity()) ? 0 : this->avail_pos - this->vscroll2->GetCapacity();
1330 break;
1332 case WKC_PAGEDOWN:
1333 /* scroll down a page */
1334 this->avail_pos = min(this->avail_pos + this->vscroll2->GetCapacity(), (int)this->avails.Length() - 1);
1335 break;
1337 case WKC_HOME:
1338 /* jump to beginning */
1339 this->avail_pos = 0;
1340 break;
1342 case WKC_END:
1343 /* jump to end */
1344 this->avail_pos = this->avails.Length() - 1;
1345 break;
1347 default:
1348 return ES_NOT_HANDLED;
1351 if (this->avails.Length() == 0) this->avail_pos = -1;
1352 if (this->avail_pos >= 0) {
1353 this->avail_sel = this->avails[this->avail_pos];
1354 this->vscroll2->ScrollTowards(this->avail_pos);
1355 this->InvalidateData(0);
1358 return ES_HANDLED;
1361 virtual void OnEditboxChanged(int wid)
1363 if (!this->editable) return;
1365 string_filter.SetFilterTerm(this->filter_editbox.text.buf);
1366 this->avails.SetFilterState(!string_filter.IsEmpty());
1367 this->avails.ForceRebuild();
1368 this->InvalidateData(0);
1371 virtual void OnDragDrop(Point pt, int widget)
1373 if (!this->editable) return;
1375 if (widget == WID_NS_FILE_LIST) {
1376 if (this->active_sel != nullptr) {
1377 /* Get pointer to the selected file in the active list. */
1378 int from_pos = 0;
1379 GRFConfig **from_prev;
1380 for (from_prev = &this->actives; *from_prev != this->active_sel; from_prev = &(*from_prev)->next, from_pos++) {}
1382 /* Gets the drag-and-drop destination offset. Ignore the last dummy line. */
1383 int to_pos = min(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST), this->vscroll->GetCount() - 2);
1384 if (to_pos != from_pos) { // Don't move NewGRF file over itself.
1385 /* Get pointer to destination position. */
1386 GRFConfig **to_prev = &this->actives;
1387 for (int i = from_pos < to_pos ? -1 : 0; *to_prev != nullptr && i < to_pos; to_prev = &(*to_prev)->next, i++) {}
1389 /* Detach NewGRF file from its original position. */
1390 *from_prev = this->active_sel->next;
1392 /* Attach NewGRF file to its new position. */
1393 this->active_sel->next = *to_prev;
1394 *to_prev = this->active_sel;
1396 this->vscroll->ScrollTowards(to_pos);
1397 this->preset = -1;
1398 this->InvalidateData();
1400 } else if (this->avail_sel != nullptr) {
1401 int to_pos = min(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST), this->vscroll->GetCount() - 1);
1402 this->AddGRFToActive(to_pos);
1404 } else if (widget == WID_NS_AVAIL_LIST && this->active_sel != nullptr) {
1405 /* Remove active NewGRF file by dragging it over available list. */
1406 Point dummy = {-1, -1};
1407 this->OnClick(dummy, WID_NS_REMOVE, 1);
1410 ResetObjectToPlace();
1412 if (this->active_over != -1) {
1413 /* End of drag-and-drop, hide dragged destination highlight. */
1414 this->SetWidgetDirty(this->active_over == -2 ? WID_NS_AVAIL_LIST : WID_NS_FILE_LIST);
1415 this->active_over = -1;
1419 virtual void OnMouseDrag(Point pt, int widget)
1421 if (!this->editable) return;
1423 if (widget == WID_NS_FILE_LIST && (this->active_sel != nullptr || this->avail_sel != nullptr)) {
1424 /* An NewGRF file is dragged over the active list. */
1425 int to_pos = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST);
1426 /* Skip the last dummy line if the source is from the active list. */
1427 to_pos = min(to_pos, this->vscroll->GetCount() - (this->active_sel != nullptr ? 2 : 1));
1429 if (to_pos != this->active_over) {
1430 this->active_over = to_pos;
1431 this->SetWidgetDirty(WID_NS_FILE_LIST);
1433 } else if (widget == WID_NS_AVAIL_LIST && this->active_sel != nullptr) {
1434 this->active_over = -2;
1435 this->SetWidgetDirty(WID_NS_AVAIL_LIST);
1436 } else if (this->active_over != -1) {
1437 this->SetWidgetDirty(this->active_over == -2 ? WID_NS_AVAIL_LIST : WID_NS_FILE_LIST);
1438 this->active_over = -1;
1442 private:
1443 /** Sort grfs by name. */
1444 static int CDECL NameSorter(const GRFConfig * const *a, const GRFConfig * const *b)
1446 int i = strnatcmp((*a)->GetName(), (*b)->GetName(), true); // Sort by name (natural sorting).
1447 if (i != 0) return i;
1449 i = (*a)->version - (*b)->version;
1450 if (i != 0) return i;
1452 return memcmp((*a)->ident.md5sum, (*b)->ident.md5sum, lengthof((*b)->ident.md5sum));
1455 /** Filter grfs by tags/name */
1456 static bool CDECL TagNameFilter(const GRFConfig * const *a, StringFilter &filter)
1458 filter.ResetState();
1459 filter.AddLine((*a)->GetName());
1460 filter.AddLine((*a)->filename);
1461 filter.AddLine((*a)->GetDescription());
1462 return filter.GetState();;
1465 void BuildAvailables()
1467 if (!this->avails.NeedRebuild()) return;
1469 this->avails.Clear();
1471 for (const GRFConfig *c = _all_grfs; c != nullptr; c = c->next) {
1472 bool found = false;
1473 for (const GRFConfig *grf = this->actives; grf != nullptr && !found; grf = grf->next) found = grf->ident.HasGrfIdentifier(c->ident.grfid, c->ident.md5sum);
1474 if (found) continue;
1476 if (_settings_client.gui.newgrf_show_old_versions) {
1477 *this->avails.Append() = c;
1478 } else {
1479 const GRFConfig *best = FindGRFConfig(c->ident.grfid, HasBit(c->flags, GCF_INVALID) ? FGCM_NEWEST : FGCM_NEWEST_VALID);
1481 * If the best version is 0, then all NewGRF with this GRF ID
1482 * have version 0, so for backward compatibility reasons we
1483 * want to show them all.
1484 * If we are the best version, then we definitely want to
1485 * show that NewGRF!.
1487 if (best->version == 0 || best->ident.HasGrfIdentifier(c->ident.grfid, c->ident.md5sum)) {
1488 *this->avails.Append() = c;
1493 this->avails.Filter(this->string_filter);
1494 this->avails.Compact();
1495 this->avails.RebuildDone();
1496 this->avails.Sort();
1498 if (this->avail_sel != nullptr) {
1499 this->avail_pos = this->avails.FindIndex(this->avail_sel);
1500 if (this->avail_pos < 0) this->avail_sel = nullptr;
1503 this->vscroll2->SetCount(this->avails.Length()); // Update the scrollbar
1507 * Insert a GRF into the active list.
1508 * @param ins_pos Insert GRF at this position.
1509 * @return True if the GRF was successfully added.
1511 bool AddGRFToActive(int ins_pos = -1)
1513 if (this->avail_sel == nullptr || !this->editable || HasBit(this->avail_sel->flags, GCF_INVALID)) return false;
1515 uint count = 0;
1516 GRFConfig **entry = nullptr;
1517 GRFConfig **list;
1518 /* Find last entry in the list, checking for duplicate grfid on the way */
1519 for (list = &this->actives; *list != nullptr; list = &(*list)->next, ins_pos--) {
1520 if (ins_pos == 0) entry = list; // Insert position? Save.
1521 if ((*list)->ident.grfid == this->avail_sel->ident.grfid) {
1522 ShowErrorMessage(STR_NEWGRF_DUPLICATE_GRFID, INVALID_STRING_ID, WL_INFO);
1523 return false;
1525 if (!HasBit((*list)->flags, GCF_STATIC)) count++;
1527 if (entry == nullptr) entry = list;
1528 if (count >= MAX_NEWGRFS) {
1529 ShowErrorMessage(STR_NEWGRF_TOO_MANY_NEWGRFS, INVALID_STRING_ID, WL_INFO);
1530 return false;
1533 GRFConfig *c = new GRFConfig(*this->avail_sel); // Copy GRF details from scanned list.
1534 c->SetParameterDefaults();
1536 /* Insert GRF config to configuration list. */
1537 c->next = *entry;
1538 *entry = c;
1540 /* Select next (or previous, if last one) item in the list. */
1541 int new_pos = this->avail_pos + 1;
1542 if (new_pos >= (int)this->avails.Length()) new_pos = this->avail_pos - 1;
1543 this->avail_pos = new_pos;
1544 if (new_pos >= 0) this->avail_sel = this->avails[new_pos];
1546 this->avails.ForceRebuild();
1547 this->InvalidateData(GOID_NEWGRF_LIST_EDITED);
1548 return true;
1552 #if defined(ENABLE_NETWORK)
1554 * Show the content list window with all missing grfs from the given list.
1555 * @param list The list of grfs to check for missing / not exactly matching ones.
1557 void ShowMissingContentWindow(const GRFConfig *list)
1559 /* Only show the things in the current list, or everything when nothing's selected */
1560 ContentVector cv;
1561 for (const GRFConfig *c = list; c != nullptr; c = c->next) {
1562 if (c->status != GCS_NOT_FOUND && !HasBit(c->flags, GCF_COMPATIBLE)) continue;
1564 ContentInfo *ci = new ContentInfo();
1565 ci->type = CONTENT_TYPE_NEWGRF;
1566 ci->state = ContentInfo::DOES_NOT_EXIST;
1567 strecpy(ci->name, c->GetName(), lastof(ci->name));
1568 ci->unique_id = BSWAP32(c->ident.grfid);
1569 memcpy(ci->md5sum, HasBit(c->flags, GCF_COMPATIBLE) ? c->original_md5sum : c->ident.md5sum, sizeof(ci->md5sum));
1570 *cv.Append() = ci;
1572 ShowNetworkContentListWindow(cv.Length() == 0 ? nullptr : &cv, CONTENT_TYPE_NEWGRF);
1574 #endif
1576 Listing NewGRFWindow::last_sorting = {false, 0};
1577 Filtering NewGRFWindow::last_filtering = {false, 0};
1579 NewGRFWindow::GUIGRFConfigList::SortFunction * const NewGRFWindow::sorter_funcs[] = {
1580 &NameSorter,
1583 NewGRFWindow::GUIGRFConfigList::FilterFunction * const NewGRFWindow::filter_funcs[] = {
1584 &TagNameFilter,
1588 * Custom nested widget container for the NewGRF gui.
1589 * Depending on the space in the gui, it uses either
1590 * - two column mode, put the #acs and the #avs underneath each other and the #info next to it, or
1591 * - three column mode, put the #avs, #acs, and #info each in its own column.
1593 class NWidgetNewGRFDisplay : public NWidgetContainer {
1594 public:
1595 static const uint INTER_LIST_SPACING; ///< Empty vertical space between both lists in the 2 column mode.
1596 static const uint INTER_COLUMN_SPACING; ///< Empty horizontal space between two columns.
1597 static const uint MAX_EXTRA_INFO_WIDTH; ///< Maximal additional width given to the panel.
1598 static const uint MIN_EXTRA_FOR_3_COLUMNS; ///< Minimal additional width needed before switching to 3 columns.
1600 NWidgetBase *avs; ///< Widget with the available grfs list and buttons.
1601 NWidgetBase *acs; ///< Widget with the active grfs list and buttons.
1602 NWidgetBase *inf; ///< Info panel.
1603 bool editable; ///< Editable status of the parent NewGRF window (if \c false, drop all widgets that make the window editable).
1605 NWidgetNewGRFDisplay(NWidgetBase *avs, NWidgetBase *acs, NWidgetBase *inf) : NWidgetContainer(NWID_HORIZONTAL)
1607 this->avs = avs;
1608 this->acs = acs;
1609 this->inf = inf;
1611 this->Add(this->avs);
1612 this->Add(this->acs);
1613 this->Add(this->inf);
1615 this->editable = true; // Temporary setting, 'real' value is set in SetupSmallestSize().
1618 virtual void SetupSmallestSize(Window *w, bool init_array)
1620 /* Copy state flag from the window. */
1621 assert(dynamic_cast<NewGRFWindow *>(w) != nullptr);
1622 NewGRFWindow *ngw = (NewGRFWindow *)w;
1623 this->editable = ngw->editable;
1625 this->avs->SetupSmallestSize(w, init_array);
1626 this->acs->SetupSmallestSize(w, init_array);
1627 this->inf->SetupSmallestSize(w, init_array);
1629 uint min_avs_width = this->avs->smallest_x + this->avs->padding_left + this->avs->padding_right;
1630 uint min_acs_width = this->acs->smallest_x + this->acs->padding_left + this->acs->padding_right;
1631 uint min_inf_width = this->inf->smallest_x + this->inf->padding_left + this->inf->padding_right;
1633 uint min_avs_height = this->avs->smallest_y + this->avs->padding_top + this->avs->padding_bottom;
1634 uint min_acs_height = this->acs->smallest_y + this->acs->padding_top + this->acs->padding_bottom;
1635 uint min_inf_height = this->inf->smallest_y + this->inf->padding_top + this->inf->padding_bottom;
1637 /* Smallest window is in two column mode. */
1638 this->smallest_x = max(min_avs_width, min_acs_width) + INTER_COLUMN_SPACING + min_inf_width;
1639 this->smallest_y = max(min_inf_height, min_acs_height + INTER_LIST_SPACING + min_avs_height);
1641 /* Filling. */
1642 this->fill_x = LeastCommonMultiple(this->avs->fill_x, this->acs->fill_x);
1643 if (this->inf->fill_x > 0 && (this->fill_x == 0 || this->fill_x > this->inf->fill_x)) this->fill_x = this->inf->fill_x;
1645 this->fill_y = this->avs->fill_y;
1646 if (this->acs->fill_y > 0 && (this->fill_y == 0 || this->fill_y > this->acs->fill_y)) this->fill_y = this->acs->fill_y;
1647 this->fill_y = LeastCommonMultiple(this->fill_y, this->inf->fill_y);
1649 /* Resizing. */
1650 this->resize_x = LeastCommonMultiple(this->avs->resize_x, this->acs->resize_x);
1651 if (this->inf->resize_x > 0 && (this->resize_x == 0 || this->resize_x > this->inf->resize_x)) this->resize_x = this->inf->resize_x;
1653 this->resize_y = this->avs->resize_y;
1654 if (this->acs->resize_y > 0 && (this->resize_y == 0 || this->resize_y > this->acs->resize_y)) this->resize_y = this->acs->resize_y;
1655 this->resize_y = LeastCommonMultiple(this->resize_y, this->inf->resize_y);
1657 /* Make sure the height suits the 3 column (resp. not-editable) format; the 2 column format can easily fill space between the lists */
1658 this->smallest_y = ComputeMaxSize(min_acs_height, this->smallest_y + this->resize_y - 1, this->resize_y);
1661 virtual void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)
1663 this->StoreSizePosition(sizing, x, y, given_width, given_height);
1665 uint min_avs_width = this->avs->smallest_x + this->avs->padding_left + this->avs->padding_right;
1666 uint min_acs_width = this->acs->smallest_x + this->acs->padding_left + this->acs->padding_right;
1667 uint min_inf_width = this->inf->smallest_x + this->inf->padding_left + this->inf->padding_right;
1669 uint min_list_width = max(min_avs_width, min_acs_width); // Smallest width of the lists such that they have equal width (incl padding).
1670 uint avs_extra_width = min_list_width - min_avs_width; // Additional width needed for avs to reach min_list_width.
1671 uint acs_extra_width = min_list_width - min_acs_width; // Additional width needed for acs to reach min_list_width.
1673 /* Use 2 or 3 columns? */
1674 uint min_three_columns = min_avs_width + min_acs_width + min_inf_width + 2 * INTER_COLUMN_SPACING;
1675 uint min_two_columns = min_list_width + min_inf_width + INTER_COLUMN_SPACING;
1676 bool use_three_columns = this->editable && (min_three_columns + MIN_EXTRA_FOR_3_COLUMNS <= given_width);
1678 /* Info panel is a separate column in both modes. Compute its width first. */
1679 uint extra_width, inf_width;
1680 if (use_three_columns) {
1681 extra_width = given_width - min_three_columns;
1682 inf_width = min(MAX_EXTRA_INFO_WIDTH, extra_width / 2);
1683 } else {
1684 extra_width = given_width - min_two_columns;
1685 inf_width = min(MAX_EXTRA_INFO_WIDTH, extra_width / 2);
1687 inf_width = ComputeMaxSize(this->inf->smallest_x, this->inf->smallest_x + inf_width, this->inf->GetHorizontalStepSize(sizing));
1688 extra_width -= inf_width - this->inf->smallest_x;
1690 uint inf_height = ComputeMaxSize(this->inf->smallest_y, given_height, this->inf->GetVerticalStepSize(sizing));
1692 if (use_three_columns) {
1693 /* Three column display, first make both lists equally wide, then divide whatever is left between both lists.
1694 * Only keep track of what avs gets, all other space goes to acs. */
1695 uint avs_width = min(avs_extra_width, extra_width);
1696 extra_width -= avs_width;
1697 extra_width -= min(acs_extra_width, extra_width);
1698 avs_width += extra_width / 2;
1700 avs_width = ComputeMaxSize(this->avs->smallest_x, this->avs->smallest_x + avs_width, this->avs->GetHorizontalStepSize(sizing));
1702 uint acs_width = given_width - // Remaining space, including horizontal padding.
1703 inf_width - this->inf->padding_left - this->inf->padding_right -
1704 avs_width - this->avs->padding_left - this->avs->padding_right - 2 * INTER_COLUMN_SPACING;
1705 acs_width = ComputeMaxSize(min_acs_width, acs_width, this->acs->GetHorizontalStepSize(sizing)) -
1706 this->acs->padding_left - this->acs->padding_right;
1708 /* Never use fill_y on these; the minimal size is chosen, so that the 3 column view looks nice */
1709 uint avs_height = ComputeMaxSize(this->avs->smallest_y, given_height, this->avs->resize_y);
1710 uint acs_height = ComputeMaxSize(this->acs->smallest_y, given_height, this->acs->resize_y);
1712 /* Assign size and position to the children. */
1713 if (rtl) {
1714 x += this->inf->padding_left;
1715 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
1716 x += inf_width + this->inf->padding_right + INTER_COLUMN_SPACING;
1717 } else {
1718 x += this->avs->padding_left;
1719 this->avs->AssignSizePosition(sizing, x, y + this->avs->padding_top, avs_width, avs_height, rtl);
1720 x += avs_width + this->avs->padding_right + INTER_COLUMN_SPACING;
1723 x += this->acs->padding_left;
1724 this->acs->AssignSizePosition(sizing, x, y + this->acs->padding_top, acs_width, acs_height, rtl);
1725 x += acs_width + this->acs->padding_right + INTER_COLUMN_SPACING;
1727 if (rtl) {
1728 x += this->avs->padding_left;
1729 this->avs->AssignSizePosition(sizing, x, y + this->avs->padding_top, avs_width, avs_height, rtl);
1730 } else {
1731 x += this->inf->padding_left;
1732 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
1734 } else {
1735 /* Two columns, all space in extra_width goes to both lists. Since the lists are underneath each other,
1736 * the column is min_list_width wide at least. */
1737 uint avs_width = ComputeMaxSize(this->avs->smallest_x, this->avs->smallest_x + avs_extra_width + extra_width,
1738 this->avs->GetHorizontalStepSize(sizing));
1739 uint acs_width = ComputeMaxSize(this->acs->smallest_x, this->acs->smallest_x + acs_extra_width + extra_width,
1740 this->acs->GetHorizontalStepSize(sizing));
1742 uint min_avs_height = (!this->editable) ? 0 : this->avs->smallest_y + this->avs->padding_top + this->avs->padding_bottom + INTER_LIST_SPACING;
1743 uint min_acs_height = this->acs->smallest_y + this->acs->padding_top + this->acs->padding_bottom;
1744 uint extra_height = given_height - min_acs_height - min_avs_height;
1746 /* Never use fill_y on these; instead use the INTER_LIST_SPACING as filler */
1747 uint avs_height = ComputeMaxSize(this->avs->smallest_y, this->avs->smallest_y + extra_height / 2, this->avs->resize_y);
1748 if (this->editable) extra_height -= avs_height - this->avs->smallest_y;
1749 uint acs_height = ComputeMaxSize(this->acs->smallest_y, this->acs->smallest_y + extra_height, this->acs->resize_y);
1751 /* Assign size and position to the children. */
1752 if (rtl) {
1753 x += this->inf->padding_left;
1754 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
1755 x += inf_width + this->inf->padding_right + INTER_COLUMN_SPACING;
1757 this->acs->AssignSizePosition(sizing, x + this->acs->padding_left, y + this->acs->padding_top, acs_width, acs_height, rtl);
1758 if (this->editable) {
1759 this->avs->AssignSizePosition(sizing, x + this->avs->padding_left, y + given_height - avs_height - this->avs->padding_bottom, avs_width, avs_height, rtl);
1760 } else {
1761 this->avs->AssignSizePosition(sizing, 0, 0, this->avs->smallest_x, this->avs->smallest_y, rtl);
1763 } else {
1764 this->acs->AssignSizePosition(sizing, x + this->acs->padding_left, y + this->acs->padding_top, acs_width, acs_height, rtl);
1765 if (this->editable) {
1766 this->avs->AssignSizePosition(sizing, x + this->avs->padding_left, y + given_height - avs_height - this->avs->padding_bottom, avs_width, avs_height, rtl);
1767 } else {
1768 this->avs->AssignSizePosition(sizing, 0, 0, this->avs->smallest_x, this->avs->smallest_y, rtl);
1770 uint dx = this->acs->current_x + this->acs->padding_left + this->acs->padding_right;
1771 if (this->editable) {
1772 dx = max(dx, this->avs->current_x + this->avs->padding_left + this->avs->padding_right);
1774 x += dx + INTER_COLUMN_SPACING + this->inf->padding_left;
1775 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
1780 virtual NWidgetCore *GetWidgetFromPos(int x, int y)
1782 if (!IsInsideBS(x, this->pos_x, this->current_x) || !IsInsideBS(y, this->pos_y, this->current_y)) return nullptr;
1784 NWidgetCore *nw = (this->editable) ? this->avs->GetWidgetFromPos(x, y) : nullptr;
1785 if (nw == nullptr) nw = this->acs->GetWidgetFromPos(x, y);
1786 if (nw == nullptr) nw = this->inf->GetWidgetFromPos(x, y);
1787 return nw;
1790 virtual void Draw(const Window *w)
1792 if (this->editable) this->avs->Draw(w);
1793 this->acs->Draw(w);
1794 this->inf->Draw(w);
1798 const uint NWidgetNewGRFDisplay::INTER_LIST_SPACING = WD_RESIZEBOX_WIDTH + 1;
1799 const uint NWidgetNewGRFDisplay::INTER_COLUMN_SPACING = WD_RESIZEBOX_WIDTH;
1800 const uint NWidgetNewGRFDisplay::MAX_EXTRA_INFO_WIDTH = 150;
1801 const uint NWidgetNewGRFDisplay::MIN_EXTRA_FOR_3_COLUMNS = 50;
1803 static const NWidgetPart _nested_newgrf_actives_widgets[] = {
1804 /* Left side, presets. */
1805 NWidget(NWID_HORIZONTAL),
1806 NWidget(WWT_TEXT, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_SELECT_PRESET, STR_NULL),
1807 SetPadding(0, WD_FRAMETEXT_RIGHT, 0, 0),
1808 NWidget(WWT_DROPDOWN, COLOUR_YELLOW, WID_NS_PRESET_LIST), SetFill(1, 0), SetResize(1, 0),
1809 SetDataTip(STR_JUST_STRING, STR_NEWGRF_SETTINGS_PRESET_LIST_TOOLTIP),
1810 EndContainer(),
1811 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1812 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_PRESET_SAVE), SetFill(1, 0), SetResize(1, 0),
1813 SetDataTip(STR_NEWGRF_SETTINGS_PRESET_SAVE, STR_NEWGRF_SETTINGS_PRESET_SAVE_TOOLTIP),
1814 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_PRESET_DELETE), SetFill(1, 0), SetResize(1, 0),
1815 SetDataTip(STR_NEWGRF_SETTINGS_PRESET_DELETE, STR_NEWGRF_SETTINGS_PRESET_DELETE_TOOLTIP),
1816 EndContainer(),
1818 NWidget(NWID_SPACER), SetMinimalSize(0, WD_RESIZEBOX_WIDTH), SetResize(1, 0), SetFill(1, 0),
1819 NWidget(WWT_PANEL, COLOUR_MAUVE),
1820 NWidget(WWT_LABEL, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_ACTIVE_LIST, STR_NULL),
1821 SetFill(1, 0), SetResize(1, 0), SetPadding(3, WD_FRAMETEXT_RIGHT, 0, WD_FRAMETEXT_LEFT),
1822 /* Left side, active grfs. */
1823 NWidget(NWID_HORIZONTAL), SetPadding(0, 2, 0, 2),
1824 NWidget(WWT_PANEL, COLOUR_MAUVE),
1825 NWidget(WWT_INSET, COLOUR_MAUVE, WID_NS_FILE_LIST), SetMinimalSize(100, 1), SetPadding(2, 2, 2, 2),
1826 SetFill(1, 1), SetResize(1, 1), SetScrollbar(WID_NS_SCROLLBAR), SetDataTip(STR_NULL, STR_NEWGRF_SETTINGS_FILE_TOOLTIP),
1827 EndContainer(),
1828 EndContainer(),
1829 NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_NS_SCROLLBAR),
1830 EndContainer(),
1831 /* Buttons. */
1832 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NS_SHOW_REMOVE),
1833 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPadding(2, 2, 2, 2), SetPIP(0, WD_RESIZEBOX_WIDTH, 0),
1834 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_REMOVE), SetFill(1, 0), SetResize(1, 0),
1835 SetDataTip(STR_NEWGRF_SETTINGS_REMOVE, STR_NEWGRF_SETTINGS_REMOVE_TOOLTIP),
1836 NWidget(NWID_VERTICAL),
1837 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_MOVE_UP), SetFill(1, 0), SetResize(1, 0),
1838 SetDataTip(STR_NEWGRF_SETTINGS_MOVEUP, STR_NEWGRF_SETTINGS_MOVEUP_TOOLTIP),
1839 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_MOVE_DOWN), SetFill(1, 0), SetResize(1, 0),
1840 SetDataTip(STR_NEWGRF_SETTINGS_MOVEDOWN, STR_NEWGRF_SETTINGS_MOVEDOWN_TOOLTIP),
1841 EndContainer(),
1842 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_UPGRADE), SetFill(1, 0), SetResize(1, 0),
1843 SetDataTip(STR_NEWGRF_SETTINGS_UPGRADE, STR_NEWGRF_SETTINGS_UPGRADE_TOOLTIP),
1844 EndContainer(),
1846 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPadding(2, 2, 2, 2),
1847 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_RESCAN_FILES2), SetFill(1, 0), SetResize(1, 0),
1848 SetDataTip(STR_NEWGRF_SETTINGS_RESCAN_FILES, STR_NEWGRF_SETTINGS_RESCAN_FILES_TOOLTIP),
1849 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_CONTENT_DOWNLOAD2), SetFill(1, 0), SetResize(1, 0),
1850 SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
1851 EndContainer(),
1852 EndContainer(),
1853 EndContainer(),
1856 static const NWidgetPart _nested_newgrf_availables_widgets[] = {
1857 NWidget(WWT_PANEL, COLOUR_MAUVE),
1858 NWidget(WWT_LABEL, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_INACTIVE_LIST, STR_NULL),
1859 SetFill(1, 0), SetResize(1, 0), SetPadding(3, WD_FRAMETEXT_RIGHT, 0, WD_FRAMETEXT_LEFT),
1860 /* Left side, available grfs, filter edit box. */
1861 NWidget(NWID_HORIZONTAL), SetPadding(WD_TEXTPANEL_TOP, 0, WD_TEXTPANEL_BOTTOM, 0),
1862 SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_RIGHT),
1863 NWidget(WWT_TEXT, COLOUR_MAUVE), SetFill(0, 1), SetDataTip(STR_NEWGRF_FILTER_TITLE, STR_NULL),
1864 NWidget(WWT_EDITBOX, COLOUR_MAUVE, WID_NS_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
1865 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
1866 EndContainer(),
1867 /* Left side, available grfs. */
1868 NWidget(NWID_HORIZONTAL), SetPadding(0, 2, 0, 2),
1869 NWidget(WWT_PANEL, COLOUR_MAUVE),
1870 NWidget(WWT_INSET, COLOUR_MAUVE, WID_NS_AVAIL_LIST), SetMinimalSize(100, 1), SetPadding(2, 2, 2, 2),
1871 SetFill(1, 1), SetResize(1, 1), SetScrollbar(WID_NS_SCROLL2BAR),
1872 EndContainer(),
1873 EndContainer(),
1874 NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_NS_SCROLL2BAR),
1875 EndContainer(),
1876 /* Left side, available grfs, buttons. */
1877 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPadding(2, 2, 2, 2), SetPIP(0, WD_RESIZEBOX_WIDTH, 0),
1878 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_ADD), SetFill(1, 0), SetResize(1, 0),
1879 SetDataTip(STR_NEWGRF_SETTINGS_ADD, STR_NEWGRF_SETTINGS_ADD_FILE_TOOLTIP),
1880 NWidget(NWID_VERTICAL),
1881 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_RESCAN_FILES), SetFill(1, 0), SetResize(1, 0),
1882 SetDataTip(STR_NEWGRF_SETTINGS_RESCAN_FILES, STR_NEWGRF_SETTINGS_RESCAN_FILES_TOOLTIP),
1883 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_CONTENT_DOWNLOAD), SetFill(1, 0), SetResize(1, 0),
1884 SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
1885 EndContainer(),
1886 EndContainer(),
1887 EndContainer(),
1890 static const NWidgetPart _nested_newgrf_infopanel_widgets[] = {
1891 /* Right side, info panel. */
1892 NWidget(NWID_VERTICAL), SetPadding(0, 0, 2, 0),
1893 NWidget(WWT_PANEL, COLOUR_MAUVE), SetPadding(0, 0, 2, 0),
1894 NWidget(WWT_EMPTY, COLOUR_MAUVE, WID_NS_NEWGRF_INFO_TITLE), SetFill(1, 0), SetResize(1, 0),
1895 NWidget(WWT_EMPTY, COLOUR_MAUVE, WID_NS_NEWGRF_INFO), SetFill(1, 1), SetResize(1, 1), SetMinimalSize(150, 100),
1896 EndContainer(),
1897 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_OPEN_URL), SetFill(1, 0), SetResize(1, 0),
1898 SetDataTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
1899 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_NEWGRF_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0),
1900 SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
1901 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1902 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_NEWGRF_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0),
1903 SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
1904 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_NEWGRF_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0),
1905 SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
1906 EndContainer(),
1907 EndContainer(),
1908 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NS_SHOW_APPLY),
1909 /* Right side, buttons. */
1910 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(0, WD_RESIZEBOX_WIDTH, 0),
1911 NWidget(NWID_VERTICAL),
1912 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_SET_PARAMETERS), SetFill(1, 0), SetResize(1, 0),
1913 SetDataTip(STR_NEWGRF_SETTINGS_SET_PARAMETERS, STR_NULL),
1914 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_TOGGLE_PALETTE), SetFill(1, 0), SetResize(1, 0),
1915 SetDataTip(STR_NEWGRF_SETTINGS_TOGGLE_PALETTE, STR_NEWGRF_SETTINGS_TOGGLE_PALETTE_TOOLTIP),
1916 EndContainer(),
1917 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_APPLY_CHANGES), SetFill(1, 0), SetResize(1, 0),
1918 SetDataTip(STR_NEWGRF_SETTINGS_APPLY_CHANGES, STR_NULL),
1919 EndContainer(),
1920 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_VIEW_PARAMETERS), SetFill(1, 0), SetResize(1, 0),
1921 SetDataTip(STR_NEWGRF_SETTINGS_SHOW_PARAMETERS, STR_NULL),
1922 EndContainer(),
1925 /** Construct nested container widget for managing the lists and the info panel of the NewGRF GUI. */
1926 NWidgetBase* NewGRFDisplay(int *biggest_index)
1928 NWidgetBase *avs = MakeNWidgets(_nested_newgrf_availables_widgets, lengthof(_nested_newgrf_availables_widgets), biggest_index, nullptr);
1930 int biggest2;
1931 NWidgetBase *acs = MakeNWidgets(_nested_newgrf_actives_widgets, lengthof(_nested_newgrf_actives_widgets), &biggest2, nullptr);
1932 *biggest_index = max(*biggest_index, biggest2);
1934 NWidgetBase *inf = MakeNWidgets(_nested_newgrf_infopanel_widgets, lengthof(_nested_newgrf_infopanel_widgets), &biggest2, nullptr);
1935 *biggest_index = max(*biggest_index, biggest2);
1937 return new NWidgetNewGRFDisplay(avs, acs, inf);
1940 /* Widget definition of the manage newgrfs window */
1941 static const NWidgetPart _nested_newgrf_widgets[] = {
1942 NWidget(NWID_HORIZONTAL),
1943 NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
1944 NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1945 NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
1946 EndContainer(),
1947 NWidget(WWT_PANEL, COLOUR_MAUVE),
1948 NWidgetFunction(NewGRFDisplay), SetPadding(WD_RESIZEBOX_WIDTH, WD_RESIZEBOX_WIDTH, 2, WD_RESIZEBOX_WIDTH),
1949 /* Resize button. */
1950 NWidget(NWID_HORIZONTAL),
1951 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1952 NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
1953 EndContainer(),
1954 EndContainer(),
1957 /* Window definition of the manage newgrfs window */
1958 static WindowDesc _newgrf_desc(
1959 WDP_CENTER, "settings_newgrf", 300, 263,
1960 WC_GAME_OPTIONS, WC_NONE,
1962 _nested_newgrf_widgets, lengthof(_nested_newgrf_widgets)
1966 * Callback function for the newgrf 'apply changes' confirmation window
1967 * @param w Window which is calling this callback
1968 * @param confirmed boolean value, true when yes was clicked, false otherwise
1970 static void NewGRFConfirmationCallback(Window *w, bool confirmed)
1972 if (confirmed) {
1973 DeleteWindowByClass(WC_GRF_PARAMETERS);
1974 NewGRFWindow *nw = dynamic_cast<NewGRFWindow*>(w);
1976 GamelogStartAction(GLAT_GRF);
1977 GamelogGRFUpdate(_grfconfig, nw->actives); // log GRF changes
1978 CopyGRFConfigList(nw->orig_list, nw->actives, false);
1979 ReloadNewGRFData();
1980 PostCheckNewGRFLoadWarnings();
1981 GamelogStopAction();
1983 /* Show new, updated list */
1984 GRFConfig *c;
1985 int i = 0;
1986 for (c = nw->actives; c != nullptr && c != nw->active_sel; c = c->next, i++) {}
1987 CopyGRFConfigList(&nw->actives, *nw->orig_list, false);
1988 for (c = nw->actives; c != nullptr && i > 0; c = c->next, i--) {}
1989 nw->active_sel = c;
1990 nw->avails.ForceRebuild();
1992 w->InvalidateData();
1994 ReInitAllWindows();
1995 DeleteWindowByClass(WC_BUILD_OBJECT);
1999 void PostCheckNewGRFLoadWarnings()
2001 if (_grf_bug_too_many_strings) {
2002 ShowErrorMessage(STR_NEWGRF_TOO_MANY_STRINGS, STR_NEWGRF_TOO_MANY_STRINGS_DETAIL, WL_WARNING);
2007 * Setup the NewGRF gui
2008 * @param editable allow the user to make changes to the grfconfig in the window
2009 * @param show_params show information about what parameters are set for the grf files
2010 * @param exec_changes if changes are made to the list (editable is true), apply these
2011 * changes immediately or only update the list
2012 * @param config pointer to a linked-list of grfconfig's that will be shown
2014 void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
2016 DeleteWindowByClass(WC_GAME_OPTIONS);
2017 new NewGRFWindow(&_newgrf_desc, editable, show_params, exec_changes, config);
2020 /** Widget parts of the save preset window. */
2021 static const NWidgetPart _nested_save_preset_widgets[] = {
2022 NWidget(NWID_HORIZONTAL),
2023 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2024 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_SAVE_PRESET_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2025 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
2026 EndContainer(),
2027 NWidget(WWT_PANEL, COLOUR_GREY),
2028 NWidget(NWID_HORIZONTAL),
2029 NWidget(WWT_INSET, COLOUR_GREY, WID_SVP_PRESET_LIST), SetPadding(2, 1, 0, 2),
2030 SetDataTip(0x0, STR_SAVE_PRESET_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SVP_SCROLLBAR), EndContainer(),
2031 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_SVP_SCROLLBAR),
2032 EndContainer(),
2033 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SVP_EDITBOX), SetPadding(3, 2, 2, 2), SetFill(1, 0), SetResize(1, 0),
2034 SetDataTip(STR_SAVE_PRESET_TITLE, STR_SAVE_PRESET_EDITBOX_TOOLTIP),
2035 EndContainer(),
2036 NWidget(NWID_HORIZONTAL),
2037 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SVP_CANCEL), SetDataTip(STR_SAVE_PRESET_CANCEL, STR_SAVE_PRESET_CANCEL_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
2038 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SVP_SAVE), SetDataTip(STR_SAVE_PRESET_SAVE, STR_SAVE_PRESET_SAVE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
2039 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
2040 EndContainer(),
2043 /** Window description of the preset save window. */
2044 static WindowDesc _save_preset_desc(
2045 WDP_CENTER, "save_preset", 140, 110,
2046 WC_SAVE_PRESET, WC_GAME_OPTIONS,
2047 WDF_MODAL,
2048 _nested_save_preset_widgets, lengthof(_nested_save_preset_widgets)
2051 /** Class for the save preset window. */
2052 struct SavePresetWindow : public Window {
2053 QueryString presetname_editbox; ///< Edit box of the save preset.
2054 GRFPresetList presets; ///< Available presets.
2055 Scrollbar *vscroll; ///< Pointer to the scrollbar widget.
2056 int selected; ///< Selected entry in the preset list, or \c -1 if none selected.
2059 * Constructor of the save preset window.
2060 * @param initial_text Initial text to display in the edit box, or \c nullptr.
2062 SavePresetWindow(const char *initial_text) : Window(&_save_preset_desc), presetname_editbox(32)
2064 GetGRFPresetList(&this->presets);
2065 this->selected = -1;
2066 if (initial_text != nullptr) {
2067 for (uint i = 0; i < this->presets.Length(); i++) {
2068 if (!strcmp(initial_text, this->presets[i])) {
2069 this->selected = i;
2070 break;
2075 this->querystrings[WID_SVP_EDITBOX] = &this->presetname_editbox;
2076 this->presetname_editbox.ok_button = WID_SVP_SAVE;
2077 this->presetname_editbox.cancel_button = WID_SVP_CANCEL;
2079 this->CreateNestedTree();
2080 this->vscroll = this->GetScrollbar(WID_SVP_SCROLLBAR);
2081 this->FinishInitNested(0);
2083 this->vscroll->SetCount(this->presets.Length());
2084 this->SetFocusedWidget(WID_SVP_EDITBOX);
2085 if (initial_text != nullptr) this->presetname_editbox.text.Assign(initial_text);
2088 ~SavePresetWindow()
2092 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
2094 switch (widget) {
2095 case WID_SVP_PRESET_LIST: {
2096 resize->height = FONT_HEIGHT_NORMAL + 2U;
2097 size->height = 0;
2098 for (uint i = 0; i < this->presets.Length(); i++) {
2099 Dimension d = GetStringBoundingBox(this->presets[i]);
2100 size->width = max(size->width, d.width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT);
2101 resize->height = max(resize->height, d.height);
2103 size->height = ClampU(this->presets.Length(), 5, 20) * resize->height + 1;
2104 break;
2109 virtual void DrawWidget(const Rect &r, int widget) const
2111 switch (widget) {
2112 case WID_SVP_PRESET_LIST: {
2113 GfxFillRect(r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK);
2115 uint step_height = this->GetWidget<NWidgetBase>(WID_SVP_PRESET_LIST)->resize_y;
2116 int offset_y = (step_height - FONT_HEIGHT_NORMAL) / 2;
2117 uint y = r.top + WD_FRAMERECT_TOP;
2118 uint min_index = this->vscroll->GetPosition();
2119 uint max_index = min(min_index + this->vscroll->GetCapacity(), this->presets.Length());
2121 for (uint i = min_index; i < max_index; i++) {
2122 if ((int)i == this->selected) GfxFillRect(r.left + 1, y, r.right - 1, y + step_height - 2, PC_DARK_BLUE);
2124 const char *text = this->presets[i];
2125 DrawString(r.left + WD_FRAMERECT_LEFT, r.right, y + offset_y, text, ((int)i == this->selected) ? TC_WHITE : TC_SILVER);
2126 y += step_height;
2128 break;
2133 virtual void OnClick(Point pt, int widget, int click_count)
2135 switch (widget) {
2136 case WID_SVP_PRESET_LIST: {
2137 uint row = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SVP_PRESET_LIST);
2138 if (row < this->presets.Length()) {
2139 this->selected = row;
2140 this->presetname_editbox.text.Assign(this->presets[row]);
2141 this->SetWidgetDirty(WID_SVP_PRESET_LIST);
2142 this->SetWidgetDirty(WID_SVP_EDITBOX);
2144 break;
2147 case WID_SVP_CANCEL:
2148 delete this;
2149 break;
2151 case WID_SVP_SAVE: {
2152 Window *w = FindWindowById(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
2153 if (w != nullptr && !StrEmpty(this->presetname_editbox.text.buf)) w->OnQueryTextFinished(this->presetname_editbox.text.buf);
2154 delete this;
2155 break;
2160 virtual void OnResize()
2162 this->vscroll->SetCapacityFromWidget(this, WID_SVP_PRESET_LIST);
2167 * Open the window for saving a preset.
2168 * @param initial_text Initial text to display in the edit box, or \c nullptr.
2170 static void ShowSavePresetWindow(const char *initial_text)
2172 DeleteWindowByClass(WC_SAVE_PRESET);
2173 new SavePresetWindow(initial_text);
2176 /** Widgets for the progress window. */
2177 static const NWidgetPart _nested_scan_progress_widgets[] = {
2178 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_NEWGRF_SCAN_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2179 NWidget(WWT_PANEL, COLOUR_GREY),
2180 NWidget(NWID_HORIZONTAL), SetPIP(20, 0, 20),
2181 NWidget(NWID_VERTICAL), SetPIP(11, 8, 11),
2182 NWidget(WWT_LABEL, INVALID_COLOUR), SetDataTip(STR_NEWGRF_SCAN_MESSAGE, STR_NULL), SetFill(1, 0),
2183 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SP_PROGRESS_BAR), SetFill(1, 0),
2184 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SP_PROGRESS_TEXT), SetFill(1, 0),
2185 EndContainer(),
2186 EndContainer(),
2187 EndContainer(),
2190 /** Description of the widgets and other settings of the window. */
2191 static WindowDesc _scan_progress_desc(
2192 WDP_CENTER, nullptr, 0, 0,
2193 WC_MODAL_PROGRESS, WC_NONE,
2195 _nested_scan_progress_widgets, lengthof(_nested_scan_progress_widgets)
2198 /** Window for showing the progress of NewGRF scanning. */
2199 struct ScanProgressWindow : public Window {
2200 char *last_name; ///< The name of the last 'seen' NewGRF.
2201 int scanned; ///< The number of NewGRFs that we have seen.
2203 /** Create the window. */
2204 ScanProgressWindow() : Window(&_scan_progress_desc), last_name(nullptr), scanned(0)
2206 this->InitNested(1);
2209 /** Free the last name buffer. */
2210 ~ScanProgressWindow()
2212 free(last_name);
2215 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
2217 switch (widget) {
2218 case WID_SP_PROGRESS_BAR: {
2219 SetDParamMaxValue(0, 100);
2220 *size = GetStringBoundingBox(STR_GENERATION_PROGRESS);
2221 /* We need some spacing for the 'border' */
2222 size->height += 8;
2223 size->width += 8;
2224 break;
2227 case WID_SP_PROGRESS_TEXT:
2228 SetDParamMaxDigits(0, 4);
2229 SetDParamMaxDigits(1, 4);
2230 /* We really don't know the width. We could determine it by scanning the NewGRFs,
2231 * but this is the status window for scanning them... */
2232 size->width = max(400U, GetStringBoundingBox(STR_NEWGRF_SCAN_STATUS).width);
2233 size->height = FONT_HEIGHT_NORMAL * 2 + WD_PAR_VSEP_NORMAL;
2234 break;
2238 virtual void DrawWidget(const Rect &r, int widget) const
2240 switch (widget) {
2241 case WID_SP_PROGRESS_BAR: {
2242 /* Draw the % complete with a bar and a text */
2243 DrawFrameRect(r.left, r.top, r.right, r.bottom, COLOUR_GREY, FR_BORDERONLY);
2244 uint percent = scanned * 100 / max(1U, _settings_client.gui.last_newgrf_count);
2245 DrawFrameRect(r.left + 1, r.top + 1, (int)((r.right - r.left - 2) * percent / 100) + r.left + 1, r.bottom - 1, COLOUR_MAUVE, FR_NONE);
2246 SetDParam(0, percent);
2247 DrawString(r.left, r.right, r.top + 5, STR_GENERATION_PROGRESS, TC_FROMSTRING, SA_HOR_CENTER);
2248 break;
2251 case WID_SP_PROGRESS_TEXT:
2252 SetDParam(0, this->scanned);
2253 SetDParam(1, _settings_client.gui.last_newgrf_count);
2254 DrawString(r.left, r.right, r.top, STR_NEWGRF_SCAN_STATUS, TC_FROMSTRING, SA_HOR_CENTER);
2256 DrawString(r.left, r.right, r.top + FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL, this->last_name == nullptr ? "" : this->last_name, TC_BLACK, SA_HOR_CENTER);
2257 break;
2262 * Update the NewGRF scan status.
2263 * @param num The number of NewGRFs scanned so far.
2264 * @param name The name of the last scanned NewGRF.
2266 void UpdateNewGRFScanStatus(uint num, const char *name)
2268 free(this->last_name);
2269 if (name == nullptr) {
2270 char buf[256];
2271 GetString(buf, STR_NEWGRF_SCAN_ARCHIVES, lastof(buf));
2272 this->last_name = stredup(buf);
2273 } else {
2274 this->last_name = stredup(name);
2276 this->scanned = num;
2277 if (num > _settings_client.gui.last_newgrf_count) _settings_client.gui.last_newgrf_count = num;
2279 this->SetDirty();
2284 * Update the NewGRF scan status.
2285 * @param num The number of NewGRFs scanned so far.
2286 * @param name The name of the last scanned NewGRF.
2288 void UpdateNewGRFScanStatus(uint num, const char *name)
2290 ScanProgressWindow *w = dynamic_cast<ScanProgressWindow *>(FindWindowByClass(WC_MODAL_PROGRESS));
2291 if (w == nullptr) w = new ScanProgressWindow();
2292 w->UpdateNewGRFScanStatus(num, name);