Make DeleteStaleLinks static

[openttd/fttd.git] / src / newgrf_gui.cpp

/* $Id$ */

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */

/** @file newgrf_gui.cpp GUI to change NewGRF settings. */

#include "stdafx.h"
#include "error.h"
#include "string.h"
#include "settings_gui.h"
#include "newgrf.h"
#include "strings_func.h"
#include "window_func.h"
#include "gamelog.h"
#include "settings_type.h"
#include "settings_func.h"
#include "widgets/dropdown_type.h"
#include "widgets/dropdown_func.h"
#include "network/network.h"
#include "network/network_content.h"
#include "sortlist_type.h"
#include "stringfilter_type.h"
#include "querystring_gui.h"
#include "core/geometry_func.hpp"
#include "newgrf_text.h"
#include "textfile.h"
#include "tilehighlight_func.h"
#include "fios.h"

#include "widgets/newgrf_widget.h"
#include "widgets/misc_widget.h"

#include "table/sprites.h"

#include <map>

/* Maximum number of NewGRFs that may be loaded. Six reserved slots are:
 * 0 - config, 1 - sound, 2 - base, 3 - logos, 4 - climate, 5 - extra */
static const int MAX_NEWGRFS = MAX_FILE_SLOTS - 6;

/**
 * Show the first NewGRF error we can find.
 */
void ShowNewGRFError()
{
        /* Do not show errors when entering the main screen */
        if (_game_mode == GM_MENU) return;

        for (const GRFConfig *c = _grfconfig; c != NULL; c = c->next) {
                /* We only want to show fatal errors */
                if (c->error == NULL || c->error->severity != STR_NEWGRF_ERROR_MSG_FATAL) continue;

                SetDParam   (0, c->error->custom_message == NULL ? c->error->message : STR_JUST_RAW_STRING);
                SetDParamStr(1, c->error->custom_message);
                SetDParamStr(2, c->filename);
                SetDParamStr(3, c->error->data);
                for (uint i = 0; i < lengthof(c->error->param_value); i++) {
                        SetDParam(4 + i, c->error->param_value[i]);
                }
                ShowErrorMessage(STR_NEWGRF_ERROR_FATAL_POPUP, INVALID_STRING_ID, WL_CRITICAL);
                break;
        }
}

static void ShowNewGRFInfo (const GRFConfig *c, BlitArea *dpi,
        uint x, uint y, uint right, uint bottom, bool show_params)
{
        if (c->error != NULL) {
                char message[512];
                SetDParamStr(0, c->error->custom_message); // is skipped by built-in messages
                SetDParamStr(1, c->filename);
                SetDParamStr(2, c->error->data);
                for (uint i = 0; i < lengthof(c->error->param_value); i++) {
                        SetDParam(3 + i, c->error->param_value[i]);
                }
                GetString (message, c->error->custom_message == NULL ? c->error->message : STR_JUST_RAW_STRING);

                SetDParamStr(0, message);
                y = DrawStringMultiLine (dpi, x, right, y, bottom, c->error->severity);
        }

        /* Draw filename or not if it is not known (GRF sent over internet) */
        if (c->filename != NULL) {
                SetDParamStr(0, c->filename);
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_FILENAME);
        }

        /* Prepare and draw GRF ID */
        char buff [36];
        bstrfmt (buff, "%08X", BSWAP32(c->ident.grfid));
        SetDParamStr(0, buff);
        y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_GRF_ID);

        if ((_settings_client.gui.newgrf_developer_tools || _settings_client.gui.newgrf_show_old_versions) && c->version != 0) {
                SetDParam(0, c->version);
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_VERSION);
        }
        if ((_settings_client.gui.newgrf_developer_tools || _settings_client.gui.newgrf_show_old_versions) && c->min_loadable_version != 0) {
                SetDParam(0, c->min_loadable_version);
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_MIN_VERSION);
        }

        /* Prepare and draw MD5 sum */
        md5sumToString (buff, c->ident.md5sum);
        SetDParamStr(0, buff);
        y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_MD5SUM);

        /* Show GRF parameter list */
        if (show_params) {
                sstring<512> buff;
                if (c->num_params > 0) {
                        GRFBuildParamList (&buff, c);
                        SetDParam(0, STR_JUST_RAW_STRING);
                        SetDParamStr (1, buff.c_str());
                } else {
                        SetDParam(0, STR_LAND_AREA_INFORMATION_LOCAL_AUTHORITY_NONE);
                }
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_PARAMETER);

                /* Draw the palette of the NewGRF */
                if (c->palette & GRFP_BLT_32BPP) {
                        SetDParamStr(0, (c->palette & GRFP_USE_WINDOWS) ? "Legacy (W) / 32 bpp" : "Default (D) / 32 bpp");
                } else {
                        SetDParamStr(0, (c->palette & GRFP_USE_WINDOWS) ? "Legacy (W)" : "Default (D)");
                }
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_PALETTE);
        }

        /* Show flags */
        if (c->status == GCS_NOT_FOUND)       y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_NOT_FOUND);
        if (c->status == GCS_DISABLED)        y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_DISABLED);
        if (HasBit(c->flags, GCF_INVALID))    y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_INCOMPATIBLE);
        if (HasBit(c->flags, GCF_COMPATIBLE)) y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_COMPATIBLE_LOADED);

        /* Draw GRF info if it exists */
        if (!StrEmpty(c->GetDescription())) {
                SetDParamStr(0, c->GetDescription());
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_BLACK_RAW_STRING);
        } else {
                y = DrawStringMultiLine (dpi, x, right, y, bottom, STR_NEWGRF_SETTINGS_NO_INFO);
        }
}

/**
 * Window for setting the parameters of a NewGRF.
 */
struct NewGRFParametersWindow : public Window {
        static GRFParameterInfo dummy_parameter_info; ///< Dummy info in case a newgrf didn't provide info about some parameter.
        GRFConfig *grf_config; ///< Set the parameters of this GRFConfig.
        uint clicked_button;   ///< The row in which a button was clicked or UINT_MAX.
        bool clicked_increase; ///< True if the increase button was clicked, false for the decrease button.
        bool clicked_dropdown; ///< Whether the dropdown is open.
        bool closing_dropdown; ///< True, if the dropdown list is currently closing.
        int timeout;           ///< How long before we unpress the last-pressed button?
        uint clicked_row;      ///< The selected parameter
        int line_height;       ///< Height of a row in the matrix widget.
        Scrollbar *vscroll;
        bool action14present;  ///< True if action14 information is present.
        bool editable;         ///< Allow editing parameters.

        NewGRFParametersWindow (const WindowDesc *desc, GRFConfig *c, bool editable) : Window(desc),
                grf_config(c),
                clicked_button(UINT_MAX),
                clicked_increase(false),
                clicked_dropdown(false),
                closing_dropdown(false),
                timeout(0),
                clicked_row(UINT_MAX),
                line_height(0),
                vscroll(NULL),
                action14present ((c->num_valid_params != lengthof(c->param) || c->param_info.Length() != 0)),
                editable(editable)
        {
                this->CreateNestedTree();
                this->vscroll = this->GetScrollbar(WID_NP_SCROLLBAR);
                this->GetWidget<NWidgetStacked>(WID_NP_SHOW_NUMPAR)->SetDisplayedPlane(this->action14present ? SZSP_HORIZONTAL : 0);
                this->GetWidget<NWidgetStacked>(WID_NP_SHOW_DESCRIPTION)->SetDisplayedPlane(this->action14present ? 0 : SZSP_HORIZONTAL);
                this->InitNested();  // Initializes 'this->line_height' as side effect.

                this->SetWidgetDisabledState(WID_NP_RESET, !this->editable);

                this->InvalidateData();
        }

        /**
         * Get a dummy parameter-info object with default information.
         * @param nr The param number that should be changed.
         * @return GRFParameterInfo with dummy information about the given parameter.
         */
        static GRFParameterInfo *GetDummyParameterInfo(uint nr)
        {
                dummy_parameter_info.param_nr = nr;
                return &dummy_parameter_info;
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_NP_NUMPAR_DEC:
                        case WID_NP_NUMPAR_INC: {
                                size->width  = max(SETTING_BUTTON_WIDTH / 2, FONT_HEIGHT_NORMAL);
                                size->height = max(SETTING_BUTTON_HEIGHT, FONT_HEIGHT_NORMAL);
                                break;
                        }

                        case WID_NP_NUMPAR: {
                                SetDParamMaxValue(0, lengthof(this->grf_config->param));
                                Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
                                d.width += padding.width;
                                d.height += padding.height;
                                *size = maxdim(*size, d);
                                break;
                        }

                        case WID_NP_BACKGROUND:
                                this->line_height = max(SETTING_BUTTON_HEIGHT, FONT_HEIGHT_NORMAL) + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;

                                resize->width = 1;
                                resize->height = this->line_height;
                                size->height = 5 * this->line_height;
                                break;

                        case WID_NP_DESCRIPTION:
                                /* Minimum size of 4 lines. The 500 is the default size of the window. */
                                const uint width = 500 - WD_FRAMERECT_LEFT - WD_FRAMERECT_RIGHT;
                                uint hmax = FONT_HEIGHT_NORMAL * 4;
                                for (uint i = 0; i < this->grf_config->param_info.Length(); i++) {
                                        const GRFParameterInfo *par_info = this->grf_config->param_info[i];
                                        if (par_info == NULL) continue;
                                        const char *desc = par_info->desc.get_string();
                                        if (desc == NULL) continue;
                                        uint h = GetStringHeight (desc, width);
                                        hmax = max (h, hmax);
                                }
                                size->height = hmax + WD_TEXTPANEL_TOP + WD_TEXTPANEL_BOTTOM;
                                break;
                }
        }

        virtual void SetStringParameters(int widget) const
        {
                switch (widget) {
                        case WID_NP_NUMPAR:
                                SetDParam(0, this->vscroll->GetCount());
                                break;
                }
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                if (widget == WID_NP_DESCRIPTION) {
                        const GRFParameterInfo *par_info = (this->clicked_row < this->grf_config->param_info.Length()) ? this->grf_config->param_info[this->clicked_row] : NULL;
                        if (par_info == NULL) return;
                        const char *desc = par_info->desc.get_string();
                        if (desc == NULL) return;
                        DrawStringMultiLine (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_TEXTPANEL_TOP, r.bottom - WD_TEXTPANEL_BOTTOM, desc, TC_BLACK);
                        return;
                } else if (widget != WID_NP_BACKGROUND) {
                        return;
                }

                bool rtl = _current_text_dir == TD_RTL;
                uint buttons_left = rtl ? r.right - SETTING_BUTTON_WIDTH - 3 : r.left + 4;
                uint text_left    = r.left + (rtl ? WD_FRAMERECT_LEFT : SETTING_BUTTON_WIDTH + 8);
                uint text_right   = r.right - (rtl ? SETTING_BUTTON_WIDTH + 8 : WD_FRAMERECT_RIGHT);

                int y = r.top;
                int button_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
                int text_y_offset = (this->line_height - FONT_HEIGHT_NORMAL) / 2;
                for (uint i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < this->vscroll->GetCount(); i++) {
                        GRFParameterInfo *par_info = (i < this->grf_config->param_info.Length()) ? this->grf_config->param_info[i] : NULL;
                        if (par_info == NULL) par_info = GetDummyParameterInfo(i);
                        uint32 current_value = par_info->GetValue(this->grf_config);
                        bool selected = (i == this->clicked_row);

                        if (par_info->type == PTYPE_BOOL) {
                                DrawBoolButton (dpi, buttons_left, y + button_y_offset, current_value != 0, this->editable);
                                SetDParam(2, par_info->GetValue(this->grf_config) == 0 ? STR_CONFIG_SETTING_OFF : STR_CONFIG_SETTING_ON);
                        } else if (par_info->type == PTYPE_UINT_ENUM) {
                                if (par_info->complete_labels) {
                                        DrawDropDownButton (dpi, buttons_left, y + button_y_offset, COLOUR_YELLOW, this->clicked_row == i && this->clicked_dropdown, this->editable);
                                } else {
                                        DrawArrowButtons (dpi, 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);
                                }
                                SetDParam(2, STR_JUST_INT);
                                SetDParam(3, current_value);
                                std::map <uint32, GRFTextMap>::iterator iter =
                                                par_info->value_names.find (current_value);
                                if (iter != par_info->value_names.end()) {
                                        const char *label = iter->second.get_string();
                                        if (label != NULL) {
                                                SetDParam(2, STR_JUST_RAW_STRING);
                                                SetDParamStr(3, label);
                                        }
                                }
                        }

                        const char *name = par_info->name.get_string();
                        if (name != NULL) {
                                SetDParam(0, STR_JUST_RAW_STRING);
                                SetDParamStr(1, name);
                        } else {
                                SetDParam(0, STR_NEWGRF_PARAMETERS_DEFAULT_NAME);
                                SetDParam(1, i + 1);
                        }

                        DrawString (dpi, text_left, text_right, y + text_y_offset, STR_NEWGRF_PARAMETERS_SETTING, selected ? TC_WHITE : TC_LIGHT_BLUE);
                        y += this->line_height;
                }
        }

        void OnPaint (BlitArea *dpi) OVERRIDE
        {
                if (this->closing_dropdown) {
                        this->closing_dropdown = false;
                        this->clicked_dropdown = false;
                }
                this->DrawWidgets (dpi);
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                switch (widget) {
                        case WID_NP_NUMPAR_DEC:
                                if (this->editable && !this->action14present && this->grf_config->num_params > 0) {
                                        this->grf_config->num_params--;
                                        this->InvalidateData();
                                        SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
                                }
                                break;

                        case WID_NP_NUMPAR_INC: {
                                GRFConfig *c = this->grf_config;
                                if (this->editable && !this->action14present && c->num_params < c->num_valid_params) {
                                        c->param[c->num_params++] = 0;
                                        this->InvalidateData();
                                        SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
                                }
                                break;
                        }

                        case WID_NP_BACKGROUND: {
                                if (!this->editable) break;
                                uint num = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NP_BACKGROUND);
                                if (num >= this->vscroll->GetCount()) break;
                                if (this->clicked_row != num) {
                                        DeleteChildWindows(WC_QUERY_STRING);
                                        HideDropDownMenu(this);
                                        this->clicked_row = num;
                                        this->clicked_dropdown = false;
                                }

                                const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_NP_BACKGROUND);
                                int x = pt.x - wid->pos_x;
                                if (_current_text_dir == TD_RTL) x = wid->current_x - 1 - x;
                                x -= 4;

                                GRFParameterInfo *par_info = (num < this->grf_config->param_info.Length()) ? this->grf_config->param_info[num] : NULL;
                                if (par_info == NULL) par_info = GetDummyParameterInfo(num);

                                /* One of the arrows is clicked */
                                uint32 old_val = par_info->GetValue(this->grf_config);
                                if (par_info->type != PTYPE_BOOL && IsInsideMM(x, 0, SETTING_BUTTON_WIDTH) && par_info->complete_labels) {
                                        if (this->clicked_dropdown) {
                                                /* unclick the dropdown */
                                                HideDropDownMenu(this);
                                                this->clicked_dropdown = false;
                                                this->closing_dropdown = false;
                                        } else {
                                                const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_NP_BACKGROUND);
                                                int rel_y = (pt.y - (int)wid->pos_y) % this->line_height;

                                                Rect wi_rect;
                                                wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);;
                                                wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
                                                wi_rect.top = pt.y - rel_y + (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
                                                wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;

                                                /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
                                                if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
                                                        this->clicked_dropdown = true;
                                                        this->closing_dropdown = false;

                                                        DropDownList *list = new DropDownList();
                                                        for (uint32 i = par_info->min_value; i <= par_info->max_value; i++) {
                                                                *list->Append() = new DropDownListCharStringItem (par_info->value_names[i].get_string(), i, false);
                                                        }

                                                        ShowDropDownListAt(this, list, old_val, -1, wi_rect, COLOUR_ORANGE, true);
                                                }
                                        }
                                } else if (IsInsideMM(x, 0, SETTING_BUTTON_WIDTH)) {
                                        uint32 val = old_val;
                                        if (par_info->type == PTYPE_BOOL) {
                                                val = !val;
                                        } else {
                                                if (x >= SETTING_BUTTON_WIDTH / 2) {
                                                        /* Increase button clicked */
                                                        if (val < par_info->max_value) val++;
                                                        this->clicked_increase = true;
                                                } else {
                                                        /* Decrease button clicked */
                                                        if (val > par_info->min_value) val--;
                                                        this->clicked_increase = false;
                                                }
                                        }
                                        if (val != old_val) {
                                                par_info->SetValue(this->grf_config, val);

                                                this->clicked_button = num;
                                                this->timeout = 5;
                                        }
                                } else if (par_info->type == PTYPE_UINT_ENUM && !par_info->complete_labels && click_count >= 2) {
                                        /* Display a query box so users can enter a custom value. */
                                        SetDParam(0, old_val);
                                        ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 10, this, CS_NUMERAL, QSF_NONE);
                                }
                                this->SetDirty();
                                break;
                        }

                        case WID_NP_RESET:
                                if (!this->editable) break;
                                this->grf_config->SetParameterDefaults();
                                this->InvalidateData();
                                SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
                                break;

                        case WID_NP_ACCEPT:
                                this->Delete();
                                break;
                }
        }

        virtual void OnQueryTextFinished(char *str)
        {
                if (StrEmpty(str)) return;
                int32 value = atoi(str);
                GRFParameterInfo *par_info = ((uint)this->clicked_row < this->grf_config->param_info.Length()) ? this->grf_config->param_info[this->clicked_row] : NULL;
                if (par_info == NULL) par_info = GetDummyParameterInfo(this->clicked_row);
                uint32 val = Clamp<uint32>(value, par_info->min_value, par_info->max_value);
                par_info->SetValue(this->grf_config, val);
                this->SetDirty();
        }

        virtual void OnDropdownSelect(int widget, int index)
        {
                assert(this->clicked_dropdown);
                GRFParameterInfo *par_info = ((uint)this->clicked_row < this->grf_config->param_info.Length()) ? this->grf_config->param_info[this->clicked_row] : NULL;
                if (par_info == NULL) par_info = GetDummyParameterInfo(this->clicked_row);
                par_info->SetValue(this->grf_config, index);
                this->SetDirty();
        }

        virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
        {
                /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
                 * the same dropdown button was clicked again, and then not open the dropdown again.
                 * So, we only remember that it was closed, and process it on the next OnPaint, which is
                 * after OnClick. */
                assert(this->clicked_dropdown);
                this->closing_dropdown = true;
                this->SetDirty();
        }

        virtual void OnResize()
        {
                this->vscroll->SetCapacityFromWidget(this, WID_NP_BACKGROUND);
        }

        /**
         * Some data on this window has become invalid.
         * @param data Information about the changed data.
         * @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.
         */
        virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
        {
                if (!gui_scope) return;
                if (!this->action14present) {
                        this->SetWidgetDisabledState(WID_NP_NUMPAR_DEC, !this->editable || this->grf_config->num_params == 0);
                        this->SetWidgetDisabledState(WID_NP_NUMPAR_INC, !this->editable || this->grf_config->num_params >= this->grf_config->num_valid_params);
                }

                this->vscroll->SetCount(this->action14present ? this->grf_config->num_valid_params : this->grf_config->num_params);
                if (this->clicked_row != UINT_MAX && this->clicked_row >= this->vscroll->GetCount()) {
                        this->clicked_row = UINT_MAX;
                        DeleteChildWindows(WC_QUERY_STRING);
                }
        }

        virtual void OnTick()
        {
                if (--this->timeout == 0) {
                        this->clicked_button = UINT_MAX;
                        this->SetDirty();
                }
        }
};
GRFParameterInfo NewGRFParametersWindow::dummy_parameter_info(0);


static const NWidgetPart _nested_newgrf_parameter_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
                NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_PARAMETERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
        EndContainer(),
        NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NP_SHOW_NUMPAR),
                NWidget(WWT_PANEL, COLOUR_MAUVE), SetResize(1, 0), SetFill(1, 0), SetPIP(4, 0, 4),
                        NWidget(NWID_HORIZONTAL), SetPIP(4, 0, 4),
                                NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_NP_NUMPAR_DEC), SetMinimalSize(12, 12), SetDataTip(AWV_DECREASE, STR_NULL),
                                NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_NP_NUMPAR_INC), SetMinimalSize(12, 12), SetDataTip(AWV_INCREASE, STR_NULL),
                                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),
                        EndContainer(),
                EndContainer(),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                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),
                NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_NP_SCROLLBAR),
        EndContainer(),
        NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NP_SHOW_DESCRIPTION),
                NWidget(WWT_PANEL, COLOUR_MAUVE, WID_NP_DESCRIPTION), SetResize(1, 0), SetFill(1, 0),
                EndContainer(),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_NP_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_NEWGRF_PARAMETERS_CLOSE, STR_NULL),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_NP_RESET), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_NEWGRF_PARAMETERS_RESET, STR_NEWGRF_PARAMETERS_RESET_TOOLTIP),
                EndContainer(),
                NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
        EndContainer(),
};

/** Window preferences for the change grf parameters window */
static WindowDesc::Prefs _newgrf_parameters_prefs ("settings_newgrf_config");

/** Window definition for the change grf parameters window */
static const WindowDesc _newgrf_parameters_desc(
        WDP_CENTER, 500, 208,
        WC_GRF_PARAMETERS, WC_NONE,
        0,
        _nested_newgrf_parameter_widgets, lengthof(_nested_newgrf_parameter_widgets),
        &_newgrf_parameters_prefs
);

static void OpenGRFParameterWindow(GRFConfig *c, bool editable)
{
        DeleteWindowByClass(WC_GRF_PARAMETERS);
        new NewGRFParametersWindow(&_newgrf_parameters_desc, c, editable);
}

/** Window for displaying the textfile of a NewGRF. */
struct NewGRFTextfileWindow : public TextfileWindow {
        const GRFConfig *grf_config; ///< View the textfile of this GRFConfig.

        NewGRFTextfileWindow (TextfileType file_type, const GRFConfig *c)
                : TextfileWindow (c->GetTextfile(file_type)), grf_config(c)
        {
                this->CheckForMissingGlyphs();
        }

        /* virtual */ void SetStringParameters(int widget) const
        {
                if (widget == WID_TF_CAPTION) {
                        SetDParam(0, STR_CONTENT_TYPE_NEWGRF);
                        SetDParamStr(1, this->grf_config->GetName());
                }
        }
};

void ShowNewGRFTextfileWindow(TextfileType file_type, const GRFConfig *c)
{
        DeleteWindowByClass(WC_TEXTFILE);
        new NewGRFTextfileWindow(file_type, c);
}

static GRFPresetList _grf_preset_list; ///< List of known NewGRF presets. @see GetGRFPresetList

class DropDownListPresetItem : public DropDownListItem {
public:
        DropDownListPresetItem(int result) : DropDownListItem(result, false) {}

        virtual ~DropDownListPresetItem() {}

        bool Selectable() const
        {
                return true;
        }

        void Draw (BlitArea *dpi, int left, int right, int top, int bottom, bool sel, int bg_colour) const OVERRIDE
        {
                DrawString (dpi, left + 2, right + 2, top, _grf_preset_list[this->result], sel ? TC_WHITE : TC_BLACK);
        }
};


typedef std::map<uint32, const GRFConfig *> GrfIdMap; ///< Map of grfid to the grf config.

/**
 * Add all grf configs from \a c into the map.
 * @param c Grf list to add.
 * @param grfid_map Map to add them to.
 */
static void FillGrfidMap(const GRFConfig *c, GrfIdMap *grfid_map)
{
        while (c != NULL) {
                std::pair<uint32, const GRFConfig *> p(c->ident.grfid, c);
                grfid_map->insert(p);
                c = c->next;
        }
}

static void NewGRFConfirmationCallback(Window *w, bool confirmed);
static void ShowSavePresetWindow(const char *initial_text);

/**
 * Window for showing NewGRF files
 */
struct NewGRFWindow : public Window, NewGRFScanCallback {
        typedef GUIList<const GRFConfig *, StringFilter &> GUIGRFConfigList;

        static const uint EDITBOX_MAX_SIZE   =  50;

        static Listing   last_sorting;   ///< Default sorting of #GUIGRFConfigList.
        static Filtering last_filtering; ///< Default filtering of #GUIGRFConfigList.
        static GUIGRFConfigList::SortFunction   * const sorter_funcs[]; ///< Sort functions of the #GUIGRFConfigList.
        static GUIGRFConfigList::FilterFunction * const filter_funcs[]; ///< Filter functions of the #GUIGRFConfigList.

        GUIGRFConfigList avails;    ///< Available (non-active) grfs.
        const GRFConfig *avail_sel; ///< Currently selected available grf. \c NULL is none is selected.
        int avail_pos;              ///< Index of #avail_sel if existing, else \c -1.
        StringFilter string_filter; ///< Filter for available grf.
        QueryStringN<EDITBOX_MAX_SIZE> filter_editbox; ///< Filter editbox;

        GRFConfig *actives;         ///< Temporary active grf list to which changes are made.
        GRFConfig *active_sel;      ///< Selected active grf item.

        GRFConfig **orig_list;      ///< List active grfs in the game. Used as initial value, may be updated by the window.
        bool editable;              ///< Is the window editable?
        bool show_params;           ///< Are the grf-parameters shown in the info-panel?
        bool execute;               ///< On pressing 'apply changes' are grf changes applied immediately, or only list is updated.
        int preset;                 ///< Selected preset or \c -1 if none selected.
        int active_over;            ///< Active GRF item over which another one is dragged, \c -1 if none.

        Scrollbar *vscroll;
        Scrollbar *vscroll2;

        NewGRFWindow (const WindowDesc *desc, bool editable, bool show_params, bool execute, GRFConfig **orig_list) :
                Window (desc), NewGRFScanCallback(),
                avails(), avail_sel (NULL), avail_pos (-1),
                string_filter(), filter_editbox(),
                actives (NULL), active_sel (NULL), orig_list (orig_list),
                editable (editable), show_params (show_params),
                execute (execute), preset (-1), active_over (-1)
        {
                CopyGRFConfigList(&this->actives, *orig_list, false);
                GetGRFPresetList(&_grf_preset_list);

                this->CreateNestedTree();
                this->vscroll = this->GetScrollbar(WID_NS_SCROLLBAR);
                this->vscroll2 = this->GetScrollbar(WID_NS_SCROLL2BAR);

                this->GetWidget<NWidgetStacked>(WID_NS_SHOW_REMOVE)->SetDisplayedPlane(this->editable ? 0 : 1);
                this->GetWidget<NWidgetStacked>(WID_NS_SHOW_APPLY)->SetDisplayedPlane(this->editable ? 0 : this->show_params ? 1 : SZSP_HORIZONTAL);
                this->InitNested(WN_GAME_OPTIONS_NEWGRF_STATE);

                this->querystrings[WID_NS_FILTER] = &this->filter_editbox;
                this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
                if (editable) {
                        this->SetFocusedWidget(WID_NS_FILTER);
                } else {
                        this->DisableWidget(WID_NS_FILTER);
                }

                this->avails.SetListing(this->last_sorting);
                this->avails.SetFiltering(this->last_filtering);
                this->avails.SetSortFuncs(this->sorter_funcs);
                this->avails.SetFilterFuncs(this->filter_funcs);
                this->avails.ForceRebuild();

                this->OnInvalidateData(GOID_NEWGRF_LIST_EDITED);
        }

        void OnDelete (void) FINAL_OVERRIDE
        {
                DeleteWindowByClass(WC_GRF_PARAMETERS);
                DeleteWindowByClass(WC_TEXTFILE);
                DeleteWindowByClass(WC_SAVE_PRESET);

                if (this->editable && !this->execute) {
                        CopyGRFConfigList(this->orig_list, this->actives, true);
                        ResetGRFConfig(false);
                        ReloadNewGRFData();
                }

                /* Remove the temporary copy of grf-list used in window */
                ClearGRFConfigList(&this->actives);
                _grf_preset_list.Clear();
        }

        /**
         * Test whether the currently active set of NewGRFs can be upgraded with the available NewGRFs.
         * @return Whether an upgrade is possible.
         */
        bool CanUpgradeCurrent()
        {
                GrfIdMap grfid_map;
                FillGrfidMap(this->actives, &grfid_map);

                for (const GRFConfig *a = _all_grfs; a != NULL; a = a->next) {
                        GrfIdMap::const_iterator iter = grfid_map.find(a->ident.grfid);
                        if (iter != grfid_map.end() && a->version > iter->second->version) return true;
                }
                return false;
        }

        /** Upgrade the currently active set of NewGRFs. */
        void UpgradeCurrent()
        {
                GrfIdMap grfid_map;
                FillGrfidMap(this->actives, &grfid_map);

                for (const GRFConfig *a = _all_grfs; a != NULL; a = a->next) {
                        GrfIdMap::iterator iter = grfid_map.find(a->ident.grfid);
                        if (iter == grfid_map.end() || iter->second->version >= a->version) continue;

                        GRFConfig **c = &this->actives;
                        while (*c != iter->second) c = &(*c)->next;
                        GRFConfig *d = new GRFConfig(*a);
                        d->next = (*c)->next;
                        d->CopyParams(**c);
                        if (this->active_sel == *c) this->active_sel = NULL;
                        delete *c;
                        *c = d;
                        iter->second = d;
                }
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_NS_FILE_LIST:
                        {
                                Dimension d = maxdim(GetSpriteSize(SPR_SQUARE), GetSpriteSize(SPR_WARNING_SIGN));
                                resize->height = max(d.height + 2U, FONT_HEIGHT_NORMAL + 2U);
                                size->height = max(size->height, WD_FRAMERECT_TOP + 6 * resize->height + WD_FRAMERECT_BOTTOM);
                                break;
                        }

                        case WID_NS_AVAIL_LIST:
                                resize->height = max(12, FONT_HEIGHT_NORMAL + 2);
                                size->height = max(size->height, WD_FRAMERECT_TOP + 8 * resize->height + WD_FRAMERECT_BOTTOM);
                                break;

                        case WID_NS_NEWGRF_INFO_TITLE: {
                                Dimension dim = GetStringBoundingBox(STR_NEWGRF_SETTINGS_INFO_TITLE);
                                size->height = max(size->height, dim.height + WD_FRAMETEXT_TOP + WD_FRAMETEXT_BOTTOM);
                                size->width  = max(size->width,  dim.width  + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT);
                                break;
                        }

                        case WID_NS_NEWGRF_INFO:
                                size->height = max(size->height, WD_FRAMERECT_TOP + 10 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM + padding.height + 2);
                                break;

                        case WID_NS_PRESET_LIST: {
                                Dimension d = GetStringBoundingBox(STR_NUM_CUSTOM);
                                for (uint i = 0; i < _grf_preset_list.Length(); i++) {
                                        if (_grf_preset_list[i] != NULL) {
                                                SetDParamStr(0, _grf_preset_list[i]);
                                                d = maxdim(d, GetStringBoundingBox(STR_JUST_RAW_STRING));
                                        }
                                }
                                d.width += padding.width;
                                *size = maxdim(d, *size);
                                break;
                        }

                        case WID_NS_CONTENT_DOWNLOAD:
                        case WID_NS_CONTENT_DOWNLOAD2: {
                                Dimension d = GetStringBoundingBox(STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON);
                                *size = maxdim(d, GetStringBoundingBox(STR_INTRO_ONLINE_CONTENT));
                                size->width  += padding.width;
                                size->height += padding.height;
                                break;
                        }
                }
        }

        virtual void OnResize()
        {
                this->vscroll->SetCapacityFromWidget(this, WID_NS_FILE_LIST);
                this->vscroll2->SetCapacityFromWidget(this, WID_NS_AVAIL_LIST);
        }

        virtual void SetStringParameters(int widget) const
        {
                switch (widget) {
                        case WID_NS_PRESET_LIST:
                                if (this->preset == -1) {
                                        SetDParam(0, STR_NUM_CUSTOM);
                                } else {
                                        SetDParam(0, STR_JUST_RAW_STRING);
                                        SetDParamStr(1, _grf_preset_list[this->preset]);
                                }
                                break;
                }
        }

        /**
         * Pick the palette for the sprite of the grf to display.
         * @param c grf to display.
         * @return Palette for the sprite.
         */
        inline PaletteID GetPalette(const GRFConfig *c) const
        {
                PaletteID pal;

                /* Pick a colour */
                switch (c->status) {
                        case GCS_NOT_FOUND:
                        case GCS_DISABLED:
                                pal = PALETTE_TO_RED;
                                break;
                        case GCS_ACTIVATED:
                                pal = PALETTE_TO_GREEN;
                                break;
                        default:
                                pal = PALETTE_TO_BLUE;
                                break;
                }

                /* Do not show a "not-failure" colour when it actually failed to load */
                if (pal != PALETTE_TO_RED) {
                        if (HasBit(c->flags, GCF_STATIC)) {
                                pal = PALETTE_TO_GREY;
                        } else if (HasBit(c->flags, GCF_COMPATIBLE)) {
                                pal = PALETTE_TO_ORANGE;
                        }
                }

                return pal;
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                switch (widget) {
                        case WID_NS_FILE_LIST: {
                                GfxFillRect (dpi, r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK);

                                uint step_height = this->GetWidget<NWidgetBase>(WID_NS_FILE_LIST)->resize_y;
                                uint y = r.top + WD_FRAMERECT_TOP;
                                Dimension square = GetSpriteSize(SPR_SQUARE);
                                Dimension warning = GetSpriteSize(SPR_WARNING_SIGN);
                                int square_offset_y = (step_height - square.height) / 2;
                                int warning_offset_y = (step_height - warning.height) / 2;
                                int offset_y = (step_height - FONT_HEIGHT_NORMAL) / 2;

                                bool rtl = _current_text_dir == TD_RTL;
                                uint text_left    = rtl ? r.left + WD_FRAMERECT_LEFT : r.left + square.width + 15;
                                uint text_right   = rtl ? r.right - square.width - 15 : r.right - WD_FRAMERECT_RIGHT;
                                uint square_left  = rtl ? r.right - square.width - 5 : r.left + 5;
                                uint warning_left = rtl ? r.right - square.width - warning.width - 10 : r.left + square.width + 10;

                                int i = 0;
                                for (const GRFConfig *c = this->actives; c != NULL; c = c->next, i++) {
                                        if (this->vscroll->IsVisible(i)) {
                                                const char *text = c->GetName();
                                                bool h = (this->active_sel == c);
                                                PaletteID pal = this->GetPalette(c);

                                                if (h) {
                                                        GfxFillRect (dpi, r.left + 1, y, r.right - 1, y + step_height - 1, PC_DARK_BLUE);
                                                } else if (i == this->active_over) {
                                                        /* Get index of current selection. */
                                                        int active_sel_pos = 0;
                                                        for (GRFConfig *c = this->actives; c != NULL && c != this->active_sel; c = c->next, active_sel_pos++) {}
                                                        if (active_sel_pos != this->active_over) {
                                                                uint top = this->active_over < active_sel_pos ? y + 1 : y + step_height - 2;
                                                                GfxFillRect (dpi, r.left + WD_FRAMERECT_LEFT, top - 1, r.right - WD_FRAMERECT_RIGHT, top + 1, PC_GREY);
                                                        }
                                                }
                                                DrawSprite (dpi, SPR_SQUARE, pal, square_left, y + square_offset_y);
                                                if (c->error != NULL) DrawSprite (dpi, SPR_WARNING_SIGN, 0, warning_left, y + warning_offset_y);
                                                uint txtoffset = c->error == NULL ? 0 : warning.width;
                                                DrawString (dpi, text_left + (rtl ? 0 : txtoffset), text_right - (rtl ? txtoffset : 0), y + offset_y, text, h ? TC_WHITE : TC_ORANGE);
                                                y += step_height;
                                        }
                                }
                                if (i == this->active_over && this->vscroll->IsVisible(i)) { // Highlight is after the last GRF entry.
                                        GfxFillRect (dpi, r.left + WD_FRAMERECT_LEFT, y, r.right - WD_FRAMERECT_RIGHT, y + 2, PC_GREY);
                                }
                                break;
                        }

                        case WID_NS_AVAIL_LIST: {
                                GfxFillRect (dpi, r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, this->active_over == -2 ? PC_DARK_GREY : PC_BLACK);

                                uint step_height = this->GetWidget<NWidgetBase>(WID_NS_AVAIL_LIST)->resize_y;
                                int offset_y = (step_height - FONT_HEIGHT_NORMAL) / 2;
                                uint y = r.top + WD_FRAMERECT_TOP;
                                uint min_index = this->vscroll2->GetPosition();
                                uint max_index = min(min_index + this->vscroll2->GetCapacity(), this->avails.Length());

                                for (uint i = min_index; i < max_index; i++) {
                                        const GRFConfig *c = this->avails[i];
                                        bool h = (c == this->avail_sel);
                                        const char *text = c->GetName();

                                        if (h) GfxFillRect (dpi, r.left + 1, y, r.right - 1, y + step_height - 1, PC_DARK_BLUE);
                                        DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y + offset_y, text, h ? TC_WHITE : TC_SILVER);
                                        y += step_height;
                                }
                                break;
                        }

                        case WID_NS_NEWGRF_INFO_TITLE:
                                /* Create the nice grayish rectangle at the details top. */
                                GfxFillRect (dpi, r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_DARK_BLUE);
                                DrawString (dpi, r.left, r.right, (r.top + r.bottom - FONT_HEIGHT_NORMAL) / 2, STR_NEWGRF_SETTINGS_INFO_TITLE, TC_FROMSTRING, SA_HOR_CENTER);
                                break;

                        case WID_NS_NEWGRF_INFO: {
                                const GRFConfig *selected = this->active_sel;
                                if (selected == NULL) selected = this->avail_sel;
                                if (selected != NULL) {
                                        ShowNewGRFInfo (selected, dpi, r.left + WD_FRAMERECT_LEFT, r.top + WD_FRAMERECT_TOP, r.right - WD_FRAMERECT_RIGHT, r.bottom - WD_FRAMERECT_BOTTOM, this->show_params);
                                }
                                break;
                        }
                }
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                if (widget >= WID_NS_NEWGRF_TEXTFILE && widget < WID_NS_NEWGRF_TEXTFILE + TFT_END) {
                        if (this->active_sel == NULL && this->avail_sel == NULL) return;

                        ShowNewGRFTextfileWindow((TextfileType)(widget - WID_NS_NEWGRF_TEXTFILE), this->active_sel != NULL ? this->active_sel : this->avail_sel);
                        return;
                }

                switch (widget) {
                        case WID_NS_PRESET_LIST: {
                                DropDownList *list = new DropDownList();

                                /* Add 'None' option for clearing list */
                                *list->Append() = new DropDownListStringItem(STR_NONE, -1, false);

                                for (uint i = 0; i < _grf_preset_list.Length(); i++) {
                                        if (_grf_preset_list[i] != NULL) {
                                                *list->Append() = new DropDownListPresetItem(i);
                                        }
                                }

                                this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
                                ShowDropDownList(this, list, this->preset, WID_NS_PRESET_LIST);
                                break;
                        }

                        case WID_NS_OPEN_URL: {
                                const GRFConfig *c = (this->avail_sel == NULL) ? this->active_sel : this->avail_sel;

                                extern void OpenBrowser(const char *url);
                                OpenBrowser(c->GetURL());
                                break;
                        }

                        case WID_NS_PRESET_SAVE:
                                ShowSavePresetWindow((this->preset == -1) ? NULL : _grf_preset_list[this->preset]);
                                break;

                        case WID_NS_PRESET_DELETE:
                                if (this->preset == -1) return;

                                DeleteGRFPresetFromConfig(_grf_preset_list[this->preset]);
                                GetGRFPresetList(&_grf_preset_list);
                                this->preset = -1;
                                this->InvalidateData();
                                this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
                                break;

                        case WID_NS_MOVE_UP: { // Move GRF up
                                if (this->active_sel == NULL || !this->editable) break;

                                int pos = 0;
                                for (GRFConfig **pc = &this->actives; *pc != NULL; pc = &(*pc)->next, pos++) {
                                        GRFConfig *c = *pc;
                                        if (c->next == this->active_sel) {
                                                c->next = this->active_sel->next;
                                                this->active_sel->next = c;
                                                *pc = this->active_sel;
                                                break;
                                        }
                                }
                                this->vscroll->ScrollTowards(pos);
                                this->preset = -1;
                                this->InvalidateData();
                                break;
                        }

                        case WID_NS_MOVE_DOWN: { // Move GRF down
                                if (this->active_sel == NULL || !this->editable) break;

                                int pos = 1; // Start at 1 as we swap the selected newgrf with the next one
                                for (GRFConfig **pc = &this->actives; *pc != NULL; pc = &(*pc)->next, pos++) {
                                        GRFConfig *c = *pc;
                                        if (c == this->active_sel) {
                                                *pc = c->next;
                                                c->next = c->next->next;
                                                (*pc)->next = c;
                                                break;
                                        }
                                }
                                this->vscroll->ScrollTowards(pos);
                                this->preset = -1;
                                this->InvalidateData();
                                break;
                        }

                        case WID_NS_FILE_LIST: { // Select an active GRF.
                                ResetPointerMode();

                                uint i = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST);

                                GRFConfig *c;
                                for (c = this->actives; c != NULL && i > 0; c = c->next, i--) {}

                                if (this->active_sel != c) DeleteWindowByClass(WC_GRF_PARAMETERS);
                                this->active_sel = c;
                                this->avail_sel = NULL;
                                this->avail_pos = -1;

                                this->InvalidateData();
                                if (click_count == 1) {
                                        if (this->editable && this->active_sel != NULL) SetPointerMode (POINTER_DRAG, this, SPR_CURSOR_MOUSE);
                                        break;
                                }
                                /* FALL THROUGH, with double click. */
                        }

                        case WID_NS_REMOVE: { // Remove GRF
                                if (this->active_sel == NULL || !this->editable) break;
                                DeleteWindowByClass(WC_GRF_PARAMETERS);

                                /* Choose the next GRF file to be the selected file. */
                                GRFConfig *newsel = this->active_sel->next;
                                for (GRFConfig **pc = &this->actives; *pc != NULL; pc = &(*pc)->next) {
                                        GRFConfig *c = *pc;
                                        /* If the new selection is empty (i.e. we're deleting the last item
                                         * in the list, pick the file just before the selected file */
                                        if (newsel == NULL && c->next == this->active_sel) newsel = c;

                                        if (c == this->active_sel) {
                                                if (newsel == c) newsel = NULL;

                                                *pc = c->next;
                                                delete c;
                                                break;
                                        }
                                }

                                this->active_sel = newsel;
                                this->preset = -1;
                                this->avail_pos = -1;
                                this->avail_sel = NULL;
                                this->avails.ForceRebuild();
                                this->InvalidateData(GOID_NEWGRF_LIST_EDITED);
                                break;
                        }

                        case WID_NS_UPGRADE: { // Upgrade GRF.
                                if (!this->editable || this->actives == NULL) break;
                                UpgradeCurrent();
                                this->InvalidateData(GOID_NEWGRF_LIST_EDITED);
                                break;
                        }

                        case WID_NS_AVAIL_LIST: { // Select a non-active GRF.
                                ResetPointerMode();

                                uint i = this->vscroll2->GetScrolledRowFromWidget(pt.y, this, WID_NS_AVAIL_LIST);
                                this->active_sel = NULL;
                                DeleteWindowByClass(WC_GRF_PARAMETERS);
                                if (i < this->avails.Length()) {
                                        this->avail_sel = this->avails[i];
                                        this->avail_pos = i;
                                }
                                this->InvalidateData();
                                if (click_count == 1) {
                                        if (this->editable && this->avail_sel != NULL && !HasBit(this->avail_sel->flags, GCF_INVALID)) SetPointerMode (POINTER_DRAG, this, SPR_CURSOR_MOUSE);
                                        break;
                                }
                                /* FALL THROUGH, with double click. */
                        }

                        case WID_NS_ADD:
                                if (this->avail_sel == NULL || !this->editable || HasBit(this->avail_sel->flags, GCF_INVALID)) break;

                                this->AddGRFToActive();
                                break;

                        case WID_NS_APPLY_CHANGES: // Apply changes made to GRF list
                                if (!this->editable) break;
                                if (this->execute) {
                                        ShowQuery(
                                                STR_NEWGRF_POPUP_CAUTION_CAPTION,
                                                STR_NEWGRF_CONFIRMATION_TEXT,
                                                this,
                                                NewGRFConfirmationCallback
                                        );
                                } else {
                                        CopyGRFConfigList(this->orig_list, this->actives, true);
                                        ResetGRFConfig(false);
                                        ReloadNewGRFData();
                                }
                                this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
                                break;

                        case WID_NS_VIEW_PARAMETERS:
                        case WID_NS_SET_PARAMETERS: { // Edit parameters
                                if (this->active_sel == NULL || !this->show_params || this->active_sel->num_valid_params == 0) break;

                                OpenGRFParameterWindow(this->active_sel, this->editable);
                                break;
                        }

                        case WID_NS_TOGGLE_PALETTE:
                                if (this->active_sel != NULL && this->editable) {
                                        this->active_sel->palette ^= GRFP_USE_MASK;
                                        this->SetDirty();
                                }
                                break;

                        case WID_NS_CONTENT_DOWNLOAD:
                        case WID_NS_CONTENT_DOWNLOAD2:
                                if (!_network_available) {
                                        ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
                                } else {
#if defined(ENABLE_NETWORK)
                                        this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window

                                        ShowMissingContentWindow(this->actives);
#endif
                                }
                                break;

                        case WID_NS_RESCAN_FILES:
                        case WID_NS_RESCAN_FILES2:
                                ScanNewGRFFiles(this);
                                break;
                }
        }

        virtual void OnNewGRFsScanned()
        {
                this->avail_sel = NULL;
                this->avail_pos = -1;
                this->avails.ForceRebuild();
                this->DeleteChildWindows(WC_QUERY_STRING); // Remove the parameter query window
                this->DeleteChildWindows(WC_TEXTFILE);     // Remove the view textfile window
        }

        virtual void OnDropdownSelect(int widget, int index)
        {
                if (!this->editable) return;

                ClearGRFConfigList(&this->actives);
                this->preset = index;

                if (index != -1) {
                        this->actives = LoadGRFPresetFromConfig(_grf_preset_list[index]);
                }
                this->avails.ForceRebuild();

                ResetPointerMode();
                DeleteWindowByClass(WC_GRF_PARAMETERS);
                this->active_sel = NULL;
                this->InvalidateData(GOID_NEWGRF_PRESET_LOADED);
        }

        virtual void OnQueryTextFinished(char *str)
        {
                if (str == NULL) return;

                SaveGRFPresetToConfig(str, this->actives);
                GetGRFPresetList(&_grf_preset_list);

                /* Switch to this preset */
                for (uint i = 0; i < _grf_preset_list.Length(); i++) {
                        if (_grf_preset_list[i] != NULL && strcmp(_grf_preset_list[i], str) == 0) {
                                this->preset = i;
                                break;
                        }
                }

                this->InvalidateData();
        }

        /**
         * Some data on this window has become invalid.
         * @param data Information about the changed data. @see GameOptionsInvalidationData
         * @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.
         */
        virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
        {
                if (!gui_scope) return;
                switch (data) {
                        default:
                                /* Nothing important to do */
                                break;

                        case GOID_NEWGRF_RESCANNED:
                                /* Search the list for items that are now found and mark them as such. */
                                for (GRFConfig **l = &this->actives; *l != NULL; l = &(*l)->next) {
                                        GRFConfig *c = *l;
                                        bool compatible = HasBit(c->flags, GCF_COMPATIBLE);
                                        if (c->status != GCS_NOT_FOUND && !compatible) continue;

                                        const GRFConfig *f = FindGRFConfig(c->ident.grfid, FGCM_EXACT, compatible ? c->original_md5sum : c->ident.md5sum);
                                        if (f == NULL || HasBit(f->flags, GCF_INVALID)) continue;

                                        *l = new GRFConfig(*f);
                                        (*l)->next = c->next;

                                        if (active_sel == c) active_sel = *l;

                                        delete c;
                                }

                                this->avails.ForceRebuild();
                                /* FALL THROUGH */
                        case GOID_NEWGRF_LIST_EDITED:
                                this->preset = -1;
                                /* FALL THROUGH */
                        case GOID_NEWGRF_PRESET_LOADED: {
                                /* Update scrollbars */
                                int i = 0;
                                for (const GRFConfig *c = this->actives; c != NULL; c = c->next, i++) {}

                                this->vscroll->SetCount(i + 1); // Reserve empty space for drag and drop handling.

                                if (this->avail_pos >= 0) this->vscroll2->ScrollTowards(this->avail_pos);
                                break;
                        }
                }

                this->BuildAvailables();

                this->SetWidgetsDisabledState(!this->editable,
                        WID_NS_PRESET_LIST,
                        WID_NS_APPLY_CHANGES,
                        WID_NS_TOGGLE_PALETTE,
                        WIDGET_LIST_END
                );
                this->SetWidgetDisabledState(WID_NS_ADD, !this->editable || this->avail_sel == NULL || HasBit(this->avail_sel->flags, GCF_INVALID));
                this->SetWidgetDisabledState(WID_NS_UPGRADE, !this->editable || this->actives == NULL || !this->CanUpgradeCurrent());

                bool disable_all = this->active_sel == NULL || !this->editable;
                this->SetWidgetsDisabledState(disable_all,
                        WID_NS_REMOVE,
                        WID_NS_MOVE_UP,
                        WID_NS_MOVE_DOWN,
                        WIDGET_LIST_END
                );

                const GRFConfig *c = (this->avail_sel == NULL) ? this->active_sel : this->avail_sel;
                for (TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
                        this->SetWidgetDisabledState (WID_NS_NEWGRF_TEXTFILE + tft,
                                c == NULL || !c->GetTextfile(tft).valid());
                }
                this->SetWidgetDisabledState(WID_NS_OPEN_URL, c == NULL || StrEmpty(c->GetURL()));

                this->SetWidgetDisabledState(WID_NS_SET_PARAMETERS, !this->show_params || this->active_sel == NULL || this->active_sel->num_valid_params == 0);
                this->SetWidgetDisabledState(WID_NS_VIEW_PARAMETERS, !this->show_params || this->active_sel == NULL || this->active_sel->num_valid_params == 0);
                this->SetWidgetDisabledState(WID_NS_TOGGLE_PALETTE, disable_all ||
                                (!(_settings_client.gui.newgrf_developer_tools || _settings_client.gui.scenario_developer) && ((c->palette & GRFP_GRF_MASK) != GRFP_GRF_UNSET)));

                if (!disable_all) {
                        /* All widgets are now enabled, so disable widgets we can't use */
                        if (this->active_sel == this->actives)    this->DisableWidget(WID_NS_MOVE_UP);
                        if (this->active_sel->next == NULL)       this->DisableWidget(WID_NS_MOVE_DOWN);
                        if (this->active_sel->IsOpenTTDBaseGRF()) this->DisableWidget(WID_NS_REMOVE);
                }

                this->SetWidgetDisabledState(WID_NS_PRESET_DELETE, this->preset == -1);

                bool has_missing = false;
                bool has_compatible = false;
                for (const GRFConfig *c = this->actives; !has_missing && c != NULL; c = c->next) {
                        has_missing    |= c->status == GCS_NOT_FOUND;
                        has_compatible |= HasBit(c->flags, GCF_COMPATIBLE);
                }
                uint32 widget_data;
                StringID tool_tip;
                if (has_missing || has_compatible) {
                        widget_data = STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON;
                        tool_tip    = STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP;
                } else {
                        widget_data = STR_INTRO_ONLINE_CONTENT;
                        tool_tip    = STR_INTRO_TOOLTIP_ONLINE_CONTENT;
                }
                this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD)->widget_data  = widget_data;
                this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD)->tool_tip     = tool_tip;
                this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD2)->widget_data = widget_data;
                this->GetWidget<NWidgetCore>(WID_NS_CONTENT_DOWNLOAD2)->tool_tip    = tool_tip;

                this->SetWidgetDisabledState(WID_NS_PRESET_SAVE, has_missing);
        }

        virtual EventState OnKeyPress(WChar key, uint16 keycode)
        {
                if (!this->editable) return ES_NOT_HANDLED;

                switch (keycode) {
                        case WKC_UP:
                                /* scroll up by one */
                                if (this->avail_pos > 0) this->avail_pos--;
                                break;

                        case WKC_DOWN:
                                /* scroll down by one */
                                if (this->avail_pos < (int)this->avails.Length() - 1) this->avail_pos++;
                                break;

                        case WKC_PAGEUP:
                                /* scroll up a page */
                                this->avail_pos = (this->avail_pos < this->vscroll2->GetCapacity()) ? 0 : this->avail_pos - this->vscroll2->GetCapacity();
                                break;

                        case WKC_PAGEDOWN:
                                /* scroll down a page */
                                this->avail_pos = min(this->avail_pos + this->vscroll2->GetCapacity(), (int)this->avails.Length() - 1);
                                break;

                        case WKC_HOME:
                                /* jump to beginning */
                                this->avail_pos = 0;
                                break;

                        case WKC_END:
                                /* jump to end */
                                this->avail_pos = this->avails.Length() - 1;
                                break;

                        default:
                                return ES_NOT_HANDLED;
                }

                if (this->avails.Length() == 0) this->avail_pos = -1;
                if (this->avail_pos >= 0) {
                        this->avail_sel = this->avails[this->avail_pos];
                        this->vscroll2->ScrollTowards(this->avail_pos);
                        this->InvalidateData(0);
                }

                return ES_HANDLED;
        }

        virtual void OnEditboxChanged(int wid)
        {
                if (!this->editable) return;

                string_filter.SetFilterTerm(this->filter_editbox.GetText());
                this->avails.SetFilterState(!string_filter.IsEmpty());
                this->avails.ForceRebuild();
                this->InvalidateData(0);
        }

        virtual void OnDragDrop(Point pt, int widget)
        {
                if (!this->editable) return;

                if (widget == WID_NS_FILE_LIST) {
                        if (this->active_sel != NULL) {
                                /* Get pointer to the selected file in the active list. */
                                int from_pos = 0;
                                GRFConfig **from_prev;
                                for (from_prev = &this->actives; *from_prev != this->active_sel; from_prev = &(*from_prev)->next, from_pos++) {}

                                /* Gets the drag-and-drop destination offset. Ignore the last dummy line. */
                                int to_pos = min(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST), this->vscroll->GetCount() - 2);
                                if (to_pos != from_pos) { // Don't move NewGRF file over itself.
                                        /* Get pointer to destination position. */
                                        GRFConfig **to_prev = &this->actives;
                                        for (int i = from_pos < to_pos ? -1 : 0; *to_prev != NULL && i < to_pos; to_prev = &(*to_prev)->next, i++) {}

                                        /* Detach NewGRF file from its original position. */
                                        *from_prev = this->active_sel->next;

                                        /* Attach NewGRF file to its new position. */
                                        this->active_sel->next = *to_prev;
                                        *to_prev = this->active_sel;

                                        this->vscroll->ScrollTowards(to_pos);
                                        this->preset = -1;
                                        this->InvalidateData();
                                }
                        } else if (this->avail_sel != NULL) {
                                int to_pos = min(this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST), this->vscroll->GetCount() - 1);
                                this->AddGRFToActive(to_pos);
                        }
                } else if (widget == WID_NS_AVAIL_LIST && this->active_sel != NULL) {
                        /* Remove active NewGRF file by dragging it over available list. */
                        Point dummy = {-1, -1};
                        this->OnClick(dummy, WID_NS_REMOVE, 1);
                }

                ResetPointerMode();

                if (this->active_over != -1) {
                        /* End of drag-and-drop, hide dragged destination highlight. */
                        this->SetWidgetDirty(this->active_over == -2 ? WID_NS_AVAIL_LIST : WID_NS_FILE_LIST);
                        this->active_over = -1;
                }
        }

        virtual void OnMouseDrag(Point pt, int widget)
        {
                if (!this->editable) return;

                if (widget == WID_NS_FILE_LIST && (this->active_sel != NULL || this->avail_sel != NULL)) {
                        /* An NewGRF file is dragged over the active list. */
                        int to_pos = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_NS_FILE_LIST);
                        /* Skip the last dummy line if the source is from the active list. */
                        to_pos = min(to_pos, this->vscroll->GetCount() - (this->active_sel != NULL ? 2 : 1));

                        if (to_pos != this->active_over) {
                                this->active_over = to_pos;
                                this->SetWidgetDirty(WID_NS_FILE_LIST);
                        }
                } else if (widget == WID_NS_AVAIL_LIST && this->active_sel != NULL) {
                        this->active_over = -2;
                        this->SetWidgetDirty(WID_NS_AVAIL_LIST);
                } else if (this->active_over != -1) {
                        this->SetWidgetDirty(this->active_over == -2 ? WID_NS_AVAIL_LIST : WID_NS_FILE_LIST);
                        this->active_over = -1;
                }
        }

private:
        /** Sort grfs by name. */
        static int CDECL NameSorter(const GRFConfig * const *a, const GRFConfig * const *b)
        {
                int i = strnatcmp((*a)->GetName(), (*b)->GetName(), true); // Sort by name (natural sorting).
                if (i != 0) return i;

                i = (*a)->version - (*b)->version;
                if (i != 0) return i;

                return memcmp((*a)->ident.md5sum, (*b)->ident.md5sum, lengthof((*b)->ident.md5sum));
        }

        /** Filter grfs by tags/name */
        static bool CDECL TagNameFilter(const GRFConfig * const *a, StringFilter &filter)
        {
                filter.ResetState();
                filter.AddLine((*a)->GetName());
                filter.AddLine((*a)->filename);
                filter.AddLine((*a)->GetDescription());
                return filter.GetState();;
        }

        void BuildAvailables()
        {
                if (!this->avails.NeedRebuild()) return;

                this->avails.Clear();

                for (const GRFConfig *c = _all_grfs; c != NULL; c = c->next) {
                        bool found = false;
                        for (const GRFConfig *grf = this->actives; grf != NULL && !found; grf = grf->next) found = grf->ident.matches (c->ident);
                        if (found) continue;

                        if (_settings_client.gui.newgrf_show_old_versions) {
                                *this->avails.Append() = c;
                        } else {
                                const GRFConfig *best = FindGRFConfig(c->ident.grfid, HasBit(c->flags, GCF_INVALID) ? FGCM_NEWEST : FGCM_NEWEST_VALID);
                                /*
                                 * If the best version is 0, then all NewGRF with this GRF ID
                                 * have version 0, so for backward compatibility reasons we
                                 * want to show them all.
                                 * If we are the best version, then we definitely want to
                                 * show that NewGRF!.
                                 */
                                if (best->version == 0 || best->ident.matches (c->ident)) {
                                        *this->avails.Append() = c;
                                }
                        }
                }

                this->avails.Filter(this->string_filter);
                this->avails.Compact();
                this->avails.RebuildDone();
                this->avails.Sort();

                if (this->avail_sel != NULL) {
                        this->avail_pos = this->avails.FindIndex(this->avail_sel);
                        if (this->avail_pos < 0) this->avail_sel = NULL;
                }

                this->vscroll2->SetCount(this->avails.Length()); // Update the scrollbar
        }

        /**
         * Insert a GRF into the active list.
         * @param ins_pos Insert GRF at this position.
         * @return True if the GRF was successfully added.
         */
        bool AddGRFToActive(int ins_pos = -1)
        {
                if (this->avail_sel == NULL || !this->editable || HasBit(this->avail_sel->flags, GCF_INVALID)) return false;

                int count = 0;
                GRFConfig **entry = NULL;
                GRFConfig **list;
                /* Find last entry in the list, checking for duplicate grfid on the way */
                for (list = &this->actives; *list != NULL; list = &(*list)->next, ins_pos--) {
                        if (ins_pos == 0) entry = list; // Insert position? Save.
                        if ((*list)->ident.grfid == this->avail_sel->ident.grfid) {
                                ShowErrorMessage(STR_NEWGRF_DUPLICATE_GRFID, INVALID_STRING_ID, WL_INFO);
                                return false;
                        }
                        count++;
                }
                if (entry == NULL) entry = list;
                if (count >= MAX_NEWGRFS) {
                        ShowErrorMessage(STR_NEWGRF_TOO_MANY_NEWGRFS, INVALID_STRING_ID, WL_INFO);
                        return false;
                }

                GRFConfig *c = new GRFConfig(*this->avail_sel); // Copy GRF details from scanned list.
                c->SetParameterDefaults();

                /* Insert GRF config to configuration list. */
                c->next = *entry;
                *entry = c;

                /* Select next (or previous, if last one) item in the list. */
                int new_pos = this->avail_pos + 1;
                if (new_pos >= (int)this->avails.Length()) new_pos = this->avail_pos - 1;
                this->avail_pos = new_pos;
                if (new_pos >= 0) this->avail_sel = this->avails[new_pos];

                this->avails.ForceRebuild();
                this->InvalidateData(GOID_NEWGRF_LIST_EDITED);
                return true;
        }
};

#if defined(ENABLE_NETWORK)
/**
 * Show the content list window with all missing grfs from the given list.
 * @param list The list of grfs to check for missing / not exactly matching ones.
 */
void ShowMissingContentWindow(const GRFConfig *list)
{
        /* Only show the things in the current list, or everything when nothing's selected */
        ContentVector cv;
        for (const GRFConfig *c = list; c != NULL; c = c->next) {
                if (c->status != GCS_NOT_FOUND && !HasBit(c->flags, GCF_COMPATIBLE)) continue;

                ContentInfo *ci = new ContentInfo();
                ci->type = CONTENT_TYPE_NEWGRF;
                ci->state = ContentInfo::DOES_NOT_EXIST;
                bstrcpy (ci->name, c->GetName());
                ci->unique_id = BSWAP32(c->ident.grfid);
                memcpy(ci->md5sum, HasBit(c->flags, GCF_COMPATIBLE) ? c->original_md5sum : c->ident.md5sum, sizeof(ci->md5sum));
                *cv.Append() = ci;
        }
        ShowNetworkContentListWindow(cv.Length() == 0 ? NULL : &cv, CONTENT_TYPE_NEWGRF);
}
#endif

Listing NewGRFWindow::last_sorting     = {false, 0};
Filtering NewGRFWindow::last_filtering = {false, 0};

NewGRFWindow::GUIGRFConfigList::SortFunction * const NewGRFWindow::sorter_funcs[] = {
        &NameSorter,
};

NewGRFWindow::GUIGRFConfigList::FilterFunction * const NewGRFWindow::filter_funcs[] = {
        &TagNameFilter,
};

/**
 * Custom nested widget container for the NewGRF gui.
 * Depending on the space in the gui, it uses either
 * - two column mode, put the #acs and the #avs underneath each other and the #info next to it, or
 * - three column mode, put the #avs, #acs, and #info each in its own column.
 */
class NWidgetNewGRFDisplay : public NWidgetContainer {
public:
        static const uint INTER_LIST_SPACING;      ///< Empty vertical space between both lists in the 2 column mode.
        static const uint INTER_COLUMN_SPACING;    ///< Empty horizontal space between two columns.
        static const uint MAX_EXTRA_INFO_WIDTH;    ///< Maximal additional width given to the panel.
        static const uint MIN_EXTRA_FOR_3_COLUMNS; ///< Minimal additional width needed before switching to 3 columns.

        NWidgetBase *avs; ///< Widget with the available grfs list and buttons.
        NWidgetBase *acs; ///< Widget with the active grfs list and buttons.
        NWidgetBase *inf; ///< Info panel.
        bool editable;    ///< Editable status of the parent NewGRF window (if \c false, drop all widgets that make the window editable).

        NWidgetNewGRFDisplay(NWidgetBase *avs, NWidgetBase *acs, NWidgetBase *inf) : NWidgetContainer(NWID_HORIZONTAL)
        {
                this->avs = avs;
                this->acs = acs;
                this->inf = inf;

                this->Add(this->avs);
                this->Add(this->acs);
                this->Add(this->inf);

                this->editable = true; // Temporary setting, 'real' value is set in SetupSmallestSize().
        }

        virtual void SetupSmallestSize(Window *w, bool init_array)
        {
                /* Copy state flag from the window. */
                assert(dynamic_cast<NewGRFWindow *>(w) != NULL);
                NewGRFWindow *ngw = (NewGRFWindow *)w;
                this->editable = ngw->editable;

                this->avs->SetupSmallestSize(w, init_array);
                this->acs->SetupSmallestSize(w, init_array);
                this->inf->SetupSmallestSize(w, init_array);

                uint min_avs_width = this->avs->smallest_x + this->avs->padding_left + this->avs->padding_right;
                uint min_acs_width = this->acs->smallest_x + this->acs->padding_left + this->acs->padding_right;
                uint min_inf_width = this->inf->smallest_x + this->inf->padding_left + this->inf->padding_right;

                uint min_avs_height = this->avs->smallest_y + this->avs->padding_top + this->avs->padding_bottom;
                uint min_acs_height = this->acs->smallest_y + this->acs->padding_top + this->acs->padding_bottom;
                uint min_inf_height = this->inf->smallest_y + this->inf->padding_top + this->inf->padding_bottom;

                /* Smallest window is in two column mode. */
                this->smallest_x = max(min_avs_width, min_acs_width) + INTER_COLUMN_SPACING + min_inf_width;
                this->smallest_y = max(min_inf_height, min_acs_height + INTER_LIST_SPACING + min_avs_height);

                /* Filling. */
                this->fill_x = LeastCommonMultiple(this->avs->fill_x, this->acs->fill_x);
                if (this->inf->fill_x > 0 && (this->fill_x == 0 || this->fill_x > this->inf->fill_x)) this->fill_x = this->inf->fill_x;

                this->fill_y = this->avs->fill_y;
                if (this->acs->fill_y > 0 && (this->fill_y == 0 || this->fill_y > this->acs->fill_y)) this->fill_y = this->acs->fill_y;
                this->fill_y = LeastCommonMultiple(this->fill_y, this->inf->fill_y);

                /* Resizing. */
                this->resize_x = LeastCommonMultiple(this->avs->resize_x, this->acs->resize_x);
                if (this->inf->resize_x > 0 && (this->resize_x == 0 || this->resize_x > this->inf->resize_x)) this->resize_x = this->inf->resize_x;

                this->resize_y = this->avs->resize_y;
                if (this->acs->resize_y > 0 && (this->resize_y == 0 || this->resize_y > this->acs->resize_y)) this->resize_y = this->acs->resize_y;
                this->resize_y = LeastCommonMultiple(this->resize_y, this->inf->resize_y);

                /* Make sure the height suits the 3 column (resp. not-editable) format; the 2 column format can easily fill space between the lists */
                this->smallest_y = ComputeMaxSize(min_acs_height, this->smallest_y + this->resize_y - 1, this->resize_y);
        }

        virtual void AssignSizePosition(SizingType sizing, uint x, uint y, uint given_width, uint given_height, bool rtl)
        {
                this->StoreSizePosition(sizing, x, y, given_width, given_height);

                uint min_avs_width = this->avs->smallest_x + this->avs->padding_left + this->avs->padding_right;
                uint min_acs_width = this->acs->smallest_x + this->acs->padding_left + this->acs->padding_right;
                uint min_inf_width = this->inf->smallest_x + this->inf->padding_left + this->inf->padding_right;

                uint min_list_width = max(min_avs_width, min_acs_width); // Smallest width of the lists such that they have equal width (incl padding).
                uint avs_extra_width = min_list_width - min_avs_width;   // Additional width needed for avs to reach min_list_width.
                uint acs_extra_width = min_list_width - min_acs_width;   // Additional width needed for acs to reach min_list_width.

                /* Use 2 or 3 columns? */
                uint min_three_columns = min_avs_width + min_acs_width + min_inf_width + 2 * INTER_COLUMN_SPACING;
                uint min_two_columns   = min_list_width + min_inf_width + INTER_COLUMN_SPACING;
                bool use_three_columns = this->editable && (min_three_columns + MIN_EXTRA_FOR_3_COLUMNS <= given_width);

                /* Info panel is a separate column in both modes. Compute its width first. */
                uint extra_width, inf_width;
                if (use_three_columns) {
                        extra_width = given_width - min_three_columns;
                        inf_width = min(MAX_EXTRA_INFO_WIDTH, extra_width / 2);
                } else {
                        extra_width = given_width - min_two_columns;
                        inf_width = min(MAX_EXTRA_INFO_WIDTH, extra_width / 2);
                }
                inf_width = ComputeMaxSize(this->inf->smallest_x, this->inf->smallest_x + inf_width, this->inf->GetHorizontalStepSize(sizing));
                extra_width -= inf_width - this->inf->smallest_x;

                uint inf_height = ComputeMaxSize(this->inf->smallest_y, given_height, this->inf->GetVerticalStepSize(sizing));

                if (use_three_columns) {
                        /* Three column display, first make both lists equally wide, then divide whatever is left between both lists.
                         * Only keep track of what avs gets, all other space goes to acs. */
                        uint avs_width = min(avs_extra_width, extra_width);
                        extra_width -= avs_width;
                        extra_width -= min(acs_extra_width, extra_width);
                        avs_width += extra_width / 2;

                        avs_width = ComputeMaxSize(this->avs->smallest_x, this->avs->smallest_x + avs_width, this->avs->GetHorizontalStepSize(sizing));

                        uint acs_width = given_width - // Remaining space, including horizontal padding.
                                        inf_width - this->inf->padding_left - this->inf->padding_right -
                                        avs_width - this->avs->padding_left - this->avs->padding_right - 2 * INTER_COLUMN_SPACING;
                        acs_width = ComputeMaxSize(min_acs_width, acs_width, this->acs->GetHorizontalStepSize(sizing)) -
                                        this->acs->padding_left - this->acs->padding_right;

                        /* Never use fill_y on these; the minimal size is chosen, so that the 3 column view looks nice */
                        uint avs_height = ComputeMaxSize(this->avs->smallest_y, given_height, this->avs->resize_y);
                        uint acs_height = ComputeMaxSize(this->acs->smallest_y, given_height, this->acs->resize_y);

                        /* Assign size and position to the children. */
                        if (rtl) {
                                x += this->inf->padding_left;
                                this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
                                x += inf_width + this->inf->padding_right + INTER_COLUMN_SPACING;
                        } else {
                                x += this->avs->padding_left;
                                this->avs->AssignSizePosition(sizing, x, y + this->avs->padding_top, avs_width, avs_height, rtl);
                                x += avs_width + this->avs->padding_right + INTER_COLUMN_SPACING;
                        }

                        x += this->acs->padding_left;
                        this->acs->AssignSizePosition(sizing, x, y + this->acs->padding_top, acs_width, acs_height, rtl);
                        x += acs_width + this->acs->padding_right + INTER_COLUMN_SPACING;

                        if (rtl) {
                                x += this->avs->padding_left;
                                this->avs->AssignSizePosition(sizing, x, y + this->avs->padding_top, avs_width, avs_height, rtl);
                        } else {
                                x += this->inf->padding_left;
                                this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
                        }
                } else {
                        /* Two columns, all space in extra_width goes to both lists. Since the lists are underneath each other,
                         * the column is min_list_width wide at least. */
                        uint avs_width = ComputeMaxSize(this->avs->smallest_x, this->avs->smallest_x + avs_extra_width + extra_width,
                                        this->avs->GetHorizontalStepSize(sizing));
                        uint acs_width = ComputeMaxSize(this->acs->smallest_x, this->acs->smallest_x + acs_extra_width + extra_width,
                                        this->acs->GetHorizontalStepSize(sizing));

                        uint min_avs_height = (!this->editable) ? 0 : this->avs->smallest_y + this->avs->padding_top + this->avs->padding_bottom + INTER_LIST_SPACING;
                        uint min_acs_height = this->acs->smallest_y + this->acs->padding_top + this->acs->padding_bottom;
                        uint extra_height = given_height - min_acs_height - min_avs_height;

                        /* Never use fill_y on these; instead use the INTER_LIST_SPACING as filler */
                        uint avs_height = ComputeMaxSize(this->avs->smallest_y, this->avs->smallest_y + extra_height / 2, this->avs->resize_y);
                        if (this->editable) extra_height -= avs_height - this->avs->smallest_y;
                        uint acs_height = ComputeMaxSize(this->acs->smallest_y, this->acs->smallest_y + extra_height, this->acs->resize_y);

                        /* Assign size and position to the children. */
                        if (rtl) {
                                x += this->inf->padding_left;
                                this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
                                x += inf_width + this->inf->padding_right + INTER_COLUMN_SPACING;

                                this->acs->AssignSizePosition(sizing, x + this->acs->padding_left, y + this->acs->padding_top, acs_width, acs_height, rtl);
                                if (this->editable) {
                                        this->avs->AssignSizePosition(sizing, x + this->avs->padding_left, y + given_height - avs_height - this->avs->padding_bottom, avs_width, avs_height, rtl);
                                } else {
                                        this->avs->AssignSizePosition(sizing, 0, 0, this->avs->smallest_x, this->avs->smallest_y, rtl);
                                }
                        } else {
                                this->acs->AssignSizePosition(sizing, x + this->acs->padding_left, y + this->acs->padding_top, acs_width, acs_height, rtl);
                                if (this->editable) {
                                        this->avs->AssignSizePosition(sizing, x + this->avs->padding_left, y + given_height - avs_height - this->avs->padding_bottom, avs_width, avs_height, rtl);
                                } else {
                                        this->avs->AssignSizePosition(sizing, 0, 0, this->avs->smallest_x, this->avs->smallest_y, rtl);
                                }
                                uint dx = this->acs->current_x + this->acs->padding_left + this->acs->padding_right;
                                if (this->editable) {
                                        dx = max(dx, this->avs->current_x + this->avs->padding_left + this->avs->padding_right);
                                }
                                x += dx + INTER_COLUMN_SPACING + this->inf->padding_left;
                                this->inf->AssignSizePosition(sizing, x, y + this->inf->padding_top, inf_width, inf_height, rtl);
                        }
                }
        }

        virtual NWidgetCore *GetWidgetFromPos(int x, int y)
        {
                if (!IsInsideBS(x, this->pos_x, this->current_x) || !IsInsideBS(y, this->pos_y, this->current_y)) return NULL;

                NWidgetCore *nw = (this->editable) ? this->avs->GetWidgetFromPos(x, y) : NULL;
                if (nw == NULL) nw = this->acs->GetWidgetFromPos(x, y);
                if (nw == NULL) nw = this->inf->GetWidgetFromPos(x, y);
                return nw;
        }

        void Draw (BlitArea *dpi, const Window *w) OVERRIDE
        {
                if (this->editable) this->avs->Draw (dpi, w);
                this->acs->Draw (dpi, w);
                this->inf->Draw (dpi, w);
        }
};

const uint NWidgetNewGRFDisplay::INTER_LIST_SPACING      = WD_RESIZEBOX_WIDTH + 1;
const uint NWidgetNewGRFDisplay::INTER_COLUMN_SPACING    = WD_RESIZEBOX_WIDTH;
const uint NWidgetNewGRFDisplay::MAX_EXTRA_INFO_WIDTH    = 150;
const uint NWidgetNewGRFDisplay::MIN_EXTRA_FOR_3_COLUMNS = 50;

static const NWidgetPart _nested_newgrf_actives_widgets[] = {
        /* Left side, presets. */
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_TEXT, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_SELECT_PRESET, STR_NULL),
                                SetPadding(0, WD_FRAMETEXT_RIGHT, 0, 0),
                NWidget(WWT_DROPDOWN, COLOUR_YELLOW, WID_NS_PRESET_LIST), SetFill(1, 0), SetResize(1, 0),
                                SetDataTip(STR_JUST_STRING, STR_NEWGRF_SETTINGS_PRESET_LIST_TOOLTIP),
        EndContainer(),
        NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_PRESET_SAVE), SetFill(1, 0), SetResize(1, 0),
                                SetDataTip(STR_NEWGRF_SETTINGS_PRESET_SAVE, STR_NEWGRF_SETTINGS_PRESET_SAVE_TOOLTIP),
                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_PRESET_DELETE), SetFill(1, 0), SetResize(1, 0),
                                SetDataTip(STR_NEWGRF_SETTINGS_PRESET_DELETE, STR_NEWGRF_SETTINGS_PRESET_DELETE_TOOLTIP),
        EndContainer(),

        NWidget(NWID_SPACER), SetMinimalSize(0, WD_RESIZEBOX_WIDTH), SetResize(1, 0), SetFill(1, 0),
        NWidget(WWT_PANEL, COLOUR_MAUVE),
                NWidget(WWT_LABEL, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_ACTIVE_LIST, STR_NULL),
                                SetFill(1, 0), SetResize(1, 0), SetPadding(3, WD_FRAMETEXT_RIGHT, 0, WD_FRAMETEXT_LEFT),
                /* Left side, active grfs. */
                NWidget(NWID_HORIZONTAL), SetPadding(0, 2, 0, 2),
                        NWidget(WWT_PANEL, COLOUR_MAUVE),
                                NWidget(WWT_INSET, COLOUR_MAUVE, WID_NS_FILE_LIST), SetMinimalSize(100, 1), SetPadding(2, 2, 2, 2),
                                                SetFill(1, 1), SetResize(1, 1), SetScrollbar(WID_NS_SCROLLBAR), SetDataTip(STR_NULL, STR_NEWGRF_SETTINGS_FILE_TOOLTIP),
                                EndContainer(),
                        EndContainer(),
                        NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_NS_SCROLLBAR),
                EndContainer(),
                /* Buttons. */
                NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NS_SHOW_REMOVE),
                        NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPadding(2, 2, 2, 2), SetPIP(0, WD_RESIZEBOX_WIDTH, 0),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_REMOVE), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_NEWGRF_SETTINGS_REMOVE, STR_NEWGRF_SETTINGS_REMOVE_TOOLTIP),
                                NWidget(NWID_VERTICAL),
                                        NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_MOVE_UP), SetFill(1, 0), SetResize(1, 0),
                                                        SetDataTip(STR_NEWGRF_SETTINGS_MOVEUP, STR_NEWGRF_SETTINGS_MOVEUP_TOOLTIP),
                                        NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_MOVE_DOWN), SetFill(1, 0), SetResize(1, 0),
                                                        SetDataTip(STR_NEWGRF_SETTINGS_MOVEDOWN, STR_NEWGRF_SETTINGS_MOVEDOWN_TOOLTIP),
                                EndContainer(),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_UPGRADE), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_NEWGRF_SETTINGS_UPGRADE, STR_NEWGRF_SETTINGS_UPGRADE_TOOLTIP),
                        EndContainer(),

                        NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPadding(2, 2, 2, 2),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_RESCAN_FILES2), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_NEWGRF_SETTINGS_RESCAN_FILES, STR_NEWGRF_SETTINGS_RESCAN_FILES_TOOLTIP),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_CONTENT_DOWNLOAD2), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
                        EndContainer(),
                EndContainer(),
        EndContainer(),
};

static const NWidgetPart _nested_newgrf_availables_widgets[] = {
        NWidget(WWT_PANEL, COLOUR_MAUVE),
                NWidget(WWT_LABEL, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_INACTIVE_LIST, STR_NULL),
                                SetFill(1, 0), SetResize(1, 0), SetPadding(3, WD_FRAMETEXT_RIGHT, 0, WD_FRAMETEXT_LEFT),
                /* Left side, available grfs, filter edit box. */
                NWidget(NWID_HORIZONTAL), SetPadding(WD_TEXTPANEL_TOP, 0, WD_TEXTPANEL_BOTTOM, 0),
                                SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_RIGHT),
                        NWidget(WWT_TEXT, COLOUR_MAUVE), SetFill(0, 1), SetDataTip(STR_NEWGRF_FILTER_TITLE, STR_NULL),
                        NWidget(WWT_EDITBOX, COLOUR_MAUVE, WID_NS_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
                                        SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
                EndContainer(),
                /* Left side, available grfs. */
                NWidget(NWID_HORIZONTAL), SetPadding(0, 2, 0, 2),
                        NWidget(WWT_PANEL, COLOUR_MAUVE),
                                NWidget(WWT_INSET, COLOUR_MAUVE, WID_NS_AVAIL_LIST), SetMinimalSize(100, 1), SetPadding(2, 2, 2, 2),
                                                SetFill(1, 1), SetResize(1, 1), SetScrollbar(WID_NS_SCROLL2BAR),
                                EndContainer(),
                        EndContainer(),
                        NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_NS_SCROLL2BAR),
                EndContainer(),
                /* Left side, available grfs, buttons. */
                NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPadding(2, 2, 2, 2), SetPIP(0, WD_RESIZEBOX_WIDTH, 0),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_ADD), SetFill(1, 0), SetResize(1, 0),
                                        SetDataTip(STR_NEWGRF_SETTINGS_ADD, STR_NEWGRF_SETTINGS_ADD_FILE_TOOLTIP),
                        NWidget(NWID_VERTICAL),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_RESCAN_FILES), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_NEWGRF_SETTINGS_RESCAN_FILES, STR_NEWGRF_SETTINGS_RESCAN_FILES_TOOLTIP),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_CONTENT_DOWNLOAD), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
                        EndContainer(),
                EndContainer(),
        EndContainer(),
};

static const NWidgetPart _nested_newgrf_infopanel_widgets[] = {
        /* Right side, info panel. */
        NWidget(NWID_VERTICAL), SetPadding(0, 0, 2, 0),
                NWidget(WWT_PANEL, COLOUR_MAUVE), SetPadding(0, 0, 2, 0),
                        NWidget(WWT_EMPTY, COLOUR_MAUVE, WID_NS_NEWGRF_INFO_TITLE), SetFill(1, 0), SetResize(1, 0),
                        NWidget(WWT_EMPTY, COLOUR_MAUVE, WID_NS_NEWGRF_INFO), SetFill(1, 1), SetResize(1, 1), SetMinimalSize(150, 100),
                EndContainer(),
                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_OPEN_URL), SetFill(1, 0), SetResize(1, 0),
                                SetDataTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_NEWGRF_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0),
                                SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
                NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_NEWGRF_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0),
                                        SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_NEWGRF_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0),
                                        SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
                EndContainer(),
        EndContainer(),
        NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NS_SHOW_APPLY),
                /* Right side, buttons. */
                NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(0, WD_RESIZEBOX_WIDTH, 0),
                        NWidget(NWID_VERTICAL),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_SET_PARAMETERS), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_NEWGRF_SETTINGS_SET_PARAMETERS, STR_NULL),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_TOGGLE_PALETTE), SetFill(1, 0), SetResize(1, 0),
                                                SetDataTip(STR_NEWGRF_SETTINGS_TOGGLE_PALETTE, STR_NEWGRF_SETTINGS_TOGGLE_PALETTE_TOOLTIP),
                        EndContainer(),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_APPLY_CHANGES), SetFill(1, 0), SetResize(1, 0),
                                        SetDataTip(STR_NEWGRF_SETTINGS_APPLY_CHANGES, STR_NULL),
                EndContainer(),
                NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NS_VIEW_PARAMETERS), SetFill(1, 0), SetResize(1, 0),
                        SetDataTip(STR_NEWGRF_SETTINGS_SHOW_PARAMETERS, STR_NULL),
        EndContainer(),
};

/** Construct nested container widget for managing the lists and the info panel of the NewGRF GUI. */
NWidgetBase* NewGRFDisplay(int *biggest_index)
{
        NWidgetBase *avs = MakeNWidgets(_nested_newgrf_availables_widgets, lengthof(_nested_newgrf_availables_widgets), biggest_index, NULL);

        int biggest2;
        NWidgetBase *acs = MakeNWidgets(_nested_newgrf_actives_widgets, lengthof(_nested_newgrf_actives_widgets), &biggest2, NULL);
        *biggest_index = max(*biggest_index, biggest2);

        NWidgetBase *inf = MakeNWidgets(_nested_newgrf_infopanel_widgets, lengthof(_nested_newgrf_infopanel_widgets), &biggest2, NULL);
        *biggest_index = max(*biggest_index, biggest2);

        return new NWidgetNewGRFDisplay(avs, acs, inf);
}

/* Widget definition of the manage newgrfs window */
static const NWidgetPart _nested_newgrf_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
                NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
        EndContainer(),
        NWidget(WWT_PANEL, COLOUR_MAUVE),
                NWidgetFunction(NewGRFDisplay), SetPadding(WD_RESIZEBOX_WIDTH, WD_RESIZEBOX_WIDTH, 2, WD_RESIZEBOX_WIDTH),
                /* Resize button. */
                NWidget(NWID_HORIZONTAL),
                        NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
                        NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
                EndContainer(),
        EndContainer(),
};

/* Window preferences of the manage newgrfs window */
static WindowDesc::Prefs _newgrf_prefs ("settings_newgrf");

/* Window definition of the manage newgrfs window */
static const WindowDesc _newgrf_desc(
        WDP_CENTER, 300, 263,
        WC_GAME_OPTIONS, WC_NONE,
        0,
        _nested_newgrf_widgets, lengthof(_nested_newgrf_widgets),
        &_newgrf_prefs
);

/**
 * Callback function for the newgrf 'apply changes' confirmation window
 * @param w Window which is calling this callback
 * @param confirmed boolean value, true when yes was clicked, false otherwise
 */
static void NewGRFConfirmationCallback(Window *w, bool confirmed)
{
        if (confirmed) {
                DeleteWindowByClass(WC_GRF_PARAMETERS);
                NewGRFWindow *nw = dynamic_cast<NewGRFWindow*>(w);

                GamelogGRFBegin();
                GamelogGRFUpdate(_grfconfig, nw->actives); // log GRF changes
                CopyGRFConfigList(nw->orig_list, nw->actives, false);
                ReloadNewGRFData();
                GamelogGRFEnd();

                /* Show new, updated list */
                GRFConfig *c;
                int i = 0;
                for (c = nw->actives; c != NULL && c != nw->active_sel; c = c->next, i++) {}
                CopyGRFConfigList(&nw->actives, *nw->orig_list, false);
                for (c = nw->actives; c != NULL && i > 0; c = c->next, i--) {}
                nw->active_sel = c;
                nw->avails.ForceRebuild();

                w->InvalidateData();

                ReInitAllWindows();
                DeleteWindowByClass(WC_BUILD_OBJECT);
        }
}



/**
 * Setup the NewGRF gui
 * @param editable allow the user to make changes to the grfconfig in the window
 * @param show_params show information about what parameters are set for the grf files
 * @param exec_changes if changes are made to the list (editable is true), apply these
 *        changes immediately or only update the list
 * @param config pointer to a linked-list of grfconfig's that will be shown
 */
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
{
        DeleteWindowByClass(WC_GAME_OPTIONS);
        new NewGRFWindow(&_newgrf_desc, editable, show_params, exec_changes, config);
}

/** Widget parts of the save preset window. */
static const NWidgetPart _nested_save_preset_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_GREY),
                NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_SAVE_PRESET_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
        EndContainer(),
        NWidget(WWT_PANEL, COLOUR_GREY),
                NWidget(NWID_HORIZONTAL),
                        NWidget(WWT_INSET, COLOUR_GREY, WID_SVP_PRESET_LIST), SetPadding(2, 1, 0, 2),
                                        SetDataTip(0x0, STR_SAVE_PRESET_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SVP_SCROLLBAR), EndContainer(),
                        NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_SVP_SCROLLBAR),
                EndContainer(),
                NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SVP_EDITBOX), SetPadding(3, 2, 2, 2), SetFill(1, 0), SetResize(1, 0),
                                SetDataTip(STR_SAVE_PRESET_TITLE, STR_SAVE_PRESET_EDITBOX_TOOLTIP),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SVP_CANCEL), SetDataTip(STR_SAVE_PRESET_CANCEL, STR_SAVE_PRESET_CANCEL_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SVP_SAVE), SetDataTip(STR_SAVE_PRESET_SAVE, STR_SAVE_PRESET_SAVE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                NWidget(WWT_RESIZEBOX, COLOUR_GREY),
        EndContainer(),
};

/** Window preferences of the preset save window. */
static WindowDesc::Prefs _save_preset_prefs ("save_preset");

/** Window description of the preset save window. */
static const WindowDesc _save_preset_desc(
        WDP_CENTER, 140, 110,
        WC_SAVE_PRESET, WC_GAME_OPTIONS,
        WDF_MODAL,
        _nested_save_preset_widgets, lengthof(_nested_save_preset_widgets),
        &_save_preset_prefs
);

/** Class for the save preset window. */
struct SavePresetWindow : public Window {
        QueryStringN<32> presetname_editbox; ///< Edit box of the save preset.
        GRFPresetList presets; ///< Available presets.
        Scrollbar *vscroll; ///< Pointer to the scrollbar widget.
        int selected; ///< Selected entry in the preset list, or \c -1 if none selected.

        /**
         * Constructor of the save preset window.
         * @param initial_text Initial text to display in the edit box, or \c NULL.
         */
        SavePresetWindow (const char *initial_text) :
                Window (&_save_preset_desc), presetname_editbox(),
                presets(), vscroll (NULL), selected (-1)
        {
                GetGRFPresetList(&this->presets);
                if (initial_text != NULL) {
                        for (uint i = 0; i < this->presets.Length(); i++) {
                                if (!strcmp(initial_text, this->presets[i])) {
                                        this->selected = i;
                                        break;
                                }
                        }
                }

                this->querystrings[WID_SVP_EDITBOX] = &this->presetname_editbox;
                this->presetname_editbox.ok_button = WID_SVP_SAVE;
                this->presetname_editbox.cancel_button = WID_SVP_CANCEL;

                this->CreateNestedTree();
                this->vscroll = this->GetScrollbar(WID_SVP_SCROLLBAR);
                this->InitNested(0);

                this->vscroll->SetCount(this->presets.Length());
                this->SetFocusedWidget(WID_SVP_EDITBOX);
                if (initial_text != NULL) this->presetname_editbox.Assign(initial_text);
        }

        ~SavePresetWindow()
        {
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_SVP_PRESET_LIST: {
                                resize->height = FONT_HEIGHT_NORMAL + 2U;
                                size->height = 0;
                                for (uint i = 0; i < this->presets.Length(); i++) {
                                        Dimension d = GetStringBoundingBox(this->presets[i]);
                                        size->width = max(size->width, d.width + WD_FRAMETEXT_LEFT + WD_FRAMETEXT_RIGHT);
                                        resize->height = max(resize->height, d.height);
                                }
                                size->height = ClampU(this->presets.Length(), 5, 20) * resize->height + 1;
                                break;
                        }
                }
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                switch (widget) {
                        case WID_SVP_PRESET_LIST: {
                                GfxFillRect (dpi, r.left + 1, r.top + 1, r.right - 1, r.bottom - 1, PC_BLACK);

                                uint step_height = this->GetWidget<NWidgetBase>(WID_SVP_PRESET_LIST)->resize_y;
                                int offset_y = (step_height - FONT_HEIGHT_NORMAL) / 2;
                                uint y = r.top + WD_FRAMERECT_TOP;
                                uint min_index = this->vscroll->GetPosition();
                                uint max_index = min(min_index + this->vscroll->GetCapacity(), this->presets.Length());

                                for (uint i = min_index; i < max_index; i++) {
                                        if ((int)i == this->selected) GfxFillRect (dpi, r.left + 1, y, r.right - 1, y + step_height - 2, PC_DARK_BLUE);

                                        const char *text = this->presets[i];
                                        DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right, y + offset_y, text, ((int)i == this->selected) ? TC_WHITE : TC_SILVER);
                                        y += step_height;
                                }
                                break;
                        }
                }
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                switch (widget) {
                        case WID_SVP_PRESET_LIST: {
                                uint row = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SVP_PRESET_LIST);
                                if (row < this->presets.Length()) {
                                        this->selected = row;
                                        this->presetname_editbox.Assign(this->presets[row]);
                                        this->SetWidgetDirty(WID_SVP_PRESET_LIST);
                                        this->SetWidgetDirty(WID_SVP_EDITBOX);
                                }
                                break;
                        }

                        case WID_SVP_CANCEL:
                                this->Delete();
                                break;

                        case WID_SVP_SAVE: {
                                Window *w = FindWindowById(WC_GAME_OPTIONS, WN_GAME_OPTIONS_NEWGRF_STATE);
                                if (w != NULL && !StrEmpty(this->presetname_editbox.GetText())) w->OnQueryTextFinished(this->presetname_editbox.buffer);
                                this->Delete();
                                break;
                        }
                }
        }

        virtual void OnResize()
        {
                this->vscroll->SetCapacityFromWidget(this, WID_SVP_PRESET_LIST);
        }
};

/**
 * Open the window for saving a preset.
 * @param initial_text Initial text to display in the edit box, or \c NULL.
 */
static void ShowSavePresetWindow(const char *initial_text)
{
        DeleteWindowByClass(WC_SAVE_PRESET);
        new SavePresetWindow(initial_text);
}

/** Widgets for the progress window. */
static const NWidgetPart _nested_scan_progress_widgets[] = {
        NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_NEWGRF_SCAN_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
        NWidget(WWT_PANEL, COLOUR_GREY),
                NWidget(NWID_HORIZONTAL), SetPIP(20, 0, 20),
                        NWidget(NWID_VERTICAL), SetPIP(11, 8, 11),
                                NWidget(WWT_LABEL, INVALID_COLOUR), SetDataTip(STR_NEWGRF_SCAN_MESSAGE, STR_NULL), SetFill(1, 0),
                                NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SP_PROGRESS_BAR), SetFill(1, 0),
                                NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SP_PROGRESS_TEXT), SetFill(1, 0),
                        EndContainer(),
                EndContainer(),
        EndContainer(),
};

/** Description of the widgets and other settings of the window. */
static const WindowDesc _scan_progress_desc(
        WDP_CENTER, 0, 0,
        WC_MODAL_PROGRESS, WC_NONE,
        0,
        _nested_scan_progress_widgets, lengthof(_nested_scan_progress_widgets)
);

/** Window for showing the progress of NewGRF scanning. */
struct ScanProgressWindow : public Window {
        char *last_name; ///< The name of the last 'seen' NewGRF.
        int scanned;     ///< The number of NewGRFs that we have seen.

        /** Create the window. */
        ScanProgressWindow() : Window(&_scan_progress_desc), last_name(NULL), scanned(0)
        {
                this->InitNested(1);
        }

        /** Free the last name buffer. */
        ~ScanProgressWindow()
        {
                free(last_name);
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_SP_PROGRESS_BAR: {
                                SetDParamMaxValue(0, 100);
                                *size = GetStringBoundingBox(STR_GENERATION_PROGRESS);
                                /* We need some spacing for the 'border' */
                                size->height += 8;
                                size->width += 8;
                                break;
                        }

                        case WID_SP_PROGRESS_TEXT:
                                SetDParamMaxDigits(0, 4);
                                SetDParamMaxDigits(1, 4);
                                /* We really don't know the width. We could determine it by scanning the NewGRFs,
                                 * but this is the status window for scanning them... */
                                size->width = max(400U, GetStringBoundingBox(STR_NEWGRF_SCAN_STATUS).width);
                                size->height = FONT_HEIGHT_NORMAL * 2 + WD_PAR_VSEP_NORMAL;
                                break;
                }
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                switch (widget) {
                        case WID_SP_PROGRESS_BAR: {
                                /* Draw the % complete with a bar and a text */
                                DrawFrameRect (dpi, r.left, r.top, r.right, r.bottom, COLOUR_GREY, FR_BORDERONLY);
                                uint percent = scanned * 100 / max(1U, _settings_client.gui.last_newgrf_count);
                                DrawFrameRect (dpi, r.left + 1, r.top + 1, (int)((r.right - r.left - 2) * percent / 100) + r.left + 1, r.bottom - 1, COLOUR_MAUVE, FR_NONE);
                                SetDParam(0, percent);
                                DrawString (dpi, r.left, r.right, r.top + 5, STR_GENERATION_PROGRESS, TC_FROMSTRING, SA_HOR_CENTER);
                                break;
                        }

                        case WID_SP_PROGRESS_TEXT:
                                SetDParam(0, this->scanned);
                                SetDParam(1, _settings_client.gui.last_newgrf_count);
                                DrawString (dpi, r.left, r.right, r.top, STR_NEWGRF_SCAN_STATUS, TC_FROMSTRING, SA_HOR_CENTER);

                                DrawString (dpi, r.left, r.right, r.top + FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL, this->last_name == NULL ? "" : this->last_name, TC_BLACK, SA_HOR_CENTER);
                                break;
                }
        }

        /**
         * Update the NewGRF scan status.
         * @param num  The number of NewGRFs scanned so far.
         * @param name The name of the last scanned NewGRF.
         */
        void UpdateNewGRFScanStatus(uint num, const char *name)
        {
                free(this->last_name);
                if (name == NULL) {
                        char buf[256];
                        GetString (buf, STR_NEWGRF_SCAN_ARCHIVES);
                        this->last_name = xstrdup(buf);
                } else {
                        this->last_name = xstrdup(name);
                }
                this->scanned = num;
                if (num > _settings_client.gui.last_newgrf_count) _settings_client.gui.last_newgrf_count = num;

                this->SetDirty();
        }
};

/**
 * Update the NewGRF scan status.
 * @param num  The number of NewGRFs scanned so far.
 * @param name The name of the last scanned NewGRF.
 */
void UpdateNewGRFScanStatus(uint num, const char *name)
{
        ScanProgressWindow *w  = dynamic_cast<ScanProgressWindow *>(FindWindowByClass(WC_MODAL_PROGRESS));
        if (w == NULL) w = new ScanProgressWindow();
        w->UpdateNewGRFScanStatus(num, name);
}