# settings_gui.cpp

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #include "stdafx.h"
    00013 #include "currency.h"
    00014 #include "error.h"
    00015 #include "settings_gui.h"
    00016 #include "textbuf_gui.h"
    00017 #include "command_func.h"
    00018 #include "screenshot.h"
    00019 #include "network/network.h"
    00020 #include "town.h"
    00021 #include "settings_internal.h"
    00022 #include "newgrf_townname.h"
    00023 #include "strings_func.h"
    00024 #include "window_func.h"
    00025 #include "string_func.h"
    00026 #include "widgets/dropdown_type.h"
    00027 #include "widgets/dropdown_func.h"
    00028 #include "highscore.h"
    00029 #include "base_media_base.h"
    00030 #include "company_base.h"
    00031 #include "company_func.h"
    00032 #include "viewport_func.h"
    00033 #include "core/geometry_func.hpp"
    00034 #include "ai/ai.hpp"
    00035 #include "blitter/factory.hpp"
    00036 #include "language.h"
    00037 #include "textfile_gui.h"
    00038 #include "stringfilter_type.h"
    00039 #include "querystring_gui.h"
    00040
    00041
    00042 static const StringID _units_dropdown[] = {
    00043   STR_GAME_OPTIONS_MEASURING_UNITS_IMPERIAL,
    00044   STR_GAME_OPTIONS_MEASURING_UNITS_METRIC,
    00045   STR_GAME_OPTIONS_MEASURING_UNITS_SI,
    00046   INVALID_STRING_ID
    00047 };
    00048
    00049 static const StringID _driveside_dropdown[] = {
    00050   STR_GAME_OPTIONS_ROAD_VEHICLES_DROPDOWN_LEFT,
    00051   STR_GAME_OPTIONS_ROAD_VEHICLES_DROPDOWN_RIGHT,
    00052   INVALID_STRING_ID
    00053 };
    00054
    00055 static const StringID _autosave_dropdown[] = {
    00056   STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
    00057   STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_1_MONTH,
    00058   STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_3_MONTHS,
    00059   STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_6_MONTHS,
    00060   STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_12_MONTHS,
    00061   INVALID_STRING_ID,
    00062 };
    00063
    00064 int _nb_orig_names = SPECSTR_TOWNNAME_LAST - SPECSTR_TOWNNAME_START + 1;
    00065 static StringID *_grf_names = NULL;
    00066 static int _nb_grf_names = 0;
    00067
    00068 static const void *ResolveVariableAddress(const GameSettings *settings_ptr, const SettingDesc *sd);
    00069
    00071 void InitGRFTownGeneratorNames()
    00072 {
    00073   free(_grf_names);
    00074   _grf_names = GetGRFTownNameList();
    00075   _nb_grf_names = 0;
    00076   for (StringID *s = _grf_names; *s != INVALID_STRING_ID; s++) _nb_grf_names++;
    00077 }
    00078
    00084 static inline StringID TownName(int town_name)
    00085 {
    00086   if (town_name < _nb_orig_names) return STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + town_name;
    00087   town_name -= _nb_orig_names;
    00088   if (town_name < _nb_grf_names) return _grf_names[town_name];
    00089   return STR_UNDEFINED;
    00090 }
    00091
    00096 static int GetCurRes()
    00097 {
    00098   int i;
    00099
    00100   for (i = 0; i != _num_resolutions; i++) {
    00101     if ((int)_resolutions[i].width == _screen.width &&
    00102         (int)_resolutions[i].height == _screen.height) {
    00103       break;
    00104     }
    00105   }
    00106   return i;
    00107 }
    00108
    00109 static void ShowCustCurrency();
    00110
    00111 template <class T>
    00112 static DropDownList *BuiltSetDropDownList(int *selected_index)
    00113 {
    00114   int n = T::GetNumSets();
    00115   *selected_index = T::GetIndexOfUsedSet();
    00116
    00117   DropDownList *list = new DropDownList();
    00118   for (int i = 0; i < n; i++) {
    00119     list->push_back(new DropDownListCharStringItem(T::GetSet(i)->name, i, (_game_mode == GM_MENU) ? false : (*selected_index != i)));
    00120   }
    00121
    00122   return list;
    00123 }
    00124
    00126 template <class TBaseSet>
    00127 struct BaseSetTextfileWindow : public TextfileWindow {
    00128   const TBaseSet* baseset;
    00129   StringID content_type;
    00130
    00131   BaseSetTextfileWindow(TextfileType file_type, const TBaseSet* baseset, StringID content_type) : TextfileWindow(file_type), baseset(baseset), content_type(content_type)
    00132   {
    00133     const char *textfile = this->baseset->GetTextfile(file_type);
    00134     this->LoadTextfile(textfile, BASESET_DIR);
    00135   }
    00136
    00137   /* virtual */ void SetStringParameters(int widget) const
    00138   {
    00139     if (widget == WID_TF_CAPTION) {
    00140       SetDParam(0, content_type);
    00141       SetDParamStr(1, this->baseset->name);
    00142     }
    00143   }
    00144 };
    00145
    00152 template <class TBaseSet>
    00153 void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet* baseset, StringID content_type)
    00154 {
    00155   DeleteWindowByClass(WC_TEXTFILE);
    00156   new BaseSetTextfileWindow<TBaseSet>(file_type, baseset, content_type);
    00157 }
    00158
    00159 struct GameOptionsWindow : Window {
    00160   GameSettings *opt;
    00161   bool reload;
    00162
    00163   GameOptionsWindow(const WindowDesc *desc) : Window()
    00164   {
    00165     this->opt = &GetGameSettings();
    00166     this->reload = false;
    00167
    00168     this->InitNested(desc, WN_GAME_OPTIONS_GAME_OPTIONS);
    00169     this->OnInvalidateData(0);
    00170   }
    00171
    00172   ~GameOptionsWindow()
    00173   {
    00174     DeleteWindowById(WC_CUSTOM_CURRENCY, 0);
    00175     if (this->reload) _switch_mode = SM_MENU;
    00176   }
    00177
    00184   DropDownList *BuildDropDownList(int widget, int *selected_index) const
    00185   {
    00186     DropDownList *list = NULL;
    00187     switch (widget) {
    00188       case WID_GO_CURRENCY_DROPDOWN: { // Setup currencies dropdown
    00189         list = new DropDownList();
    00190         *selected_index = this->opt->locale.currency;
    00191         StringID *items = BuildCurrencyDropdown();
    00192         uint disabled = _game_mode == GM_MENU ? 0 : ~GetMaskOfAllowedCurrencies();
    00193         int custom_index = -1;
    00194
    00195         /* Add non-custom currencies; sorted naturally */
    00196         for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
    00197           if (*items == STR_GAME_OPTIONS_CURRENCY_CUSTOM) {
    00198             custom_index = i;
    00199           } else {
    00200             list->push_back(new DropDownListStringItem(*items, i, HasBit(disabled, i)));
    00201           }
    00202         }
    00203         list->sort(DropDownListStringItem::NatSortFunc);
    00204
    00205         /* Append custom currency at the end */
    00206         if (custom_index >= 0) {
    00207           list->push_back(new DropDownListItem(-1, false)); // separator line
    00208           list->push_back(new DropDownListStringItem(STR_GAME_OPTIONS_CURRENCY_CUSTOM, custom_index, HasBit(disabled, custom_index)));
    00209         }
    00210         break;
    00211       }
    00212
    00213       case WID_GO_DISTANCE_DROPDOWN: { // Setup distance unit dropdown
    00214         list = new DropDownList();
    00215         *selected_index = this->opt->locale.units;
    00216         const StringID *items = _units_dropdown;
    00217         for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
    00218           list->push_back(new DropDownListStringItem(*items, i, false));
    00219         }
    00220         break;
    00221       }
    00222
    00223       case WID_GO_ROADSIDE_DROPDOWN: { // Setup road-side dropdown
    00224         list = new DropDownList();
    00225         *selected_index = this->opt->vehicle.road_side;
    00226         const StringID *items = _driveside_dropdown;
    00227         uint disabled = 0;
    00228
    00229         /* You can only change the drive side if you are in the menu or ingame with
    00230          * no vehicles present. In a networking game only the server can change it */
    00231         extern bool RoadVehiclesAreBuilt();
    00232         if ((_game_mode != GM_MENU && RoadVehiclesAreBuilt()) || (_networking && !_network_server)) {
    00233           disabled = ~(1 << this->opt->vehicle.road_side); // disable the other value
    00234         }
    00235
    00236         for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
    00237           list->push_back(new DropDownListStringItem(*items, i, HasBit(disabled, i)));
    00238         }
    00239         break;
    00240       }
    00241
    00242       case WID_GO_TOWNNAME_DROPDOWN: { // Setup townname dropdown
    00243         list = new DropDownList();
    00244         *selected_index = this->opt->game_creation.town_name;
    00245
    00246         int enabled_item = (_game_mode == GM_MENU || Town::GetNumItems() == 0) ? -1 : *selected_index;
    00247
    00248         /* Add and sort original townnames generators */
    00249         for (int i = 0; i < _nb_orig_names; i++) {
    00250           list->push_back(new DropDownListStringItem(STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + i, i, enabled_item != i && enabled_item >= 0));
    00251         }
    00252         list->sort(DropDownListStringItem::NatSortFunc);
    00253
    00254         /* Add and sort newgrf townnames generators */
    00255         DropDownList newgrf_names;
    00256         for (int i = 0; i < _nb_grf_names; i++) {
    00257           int result = _nb_orig_names + i;
    00258           newgrf_names.push_back(new DropDownListStringItem(_grf_names[i], result, enabled_item != result && enabled_item >= 0));
    00259         }
    00260         newgrf_names.sort(DropDownListStringItem::NatSortFunc);
    00261
    00262         /* Insert newgrf_names at the top of the list */
    00263         if (newgrf_names.size() > 0) {
    00264           newgrf_names.push_back(new DropDownListItem(-1, false)); // separator line
    00265           list->splice(list->begin(), newgrf_names);
    00266         }
    00267         break;
    00268       }
    00269
    00270       case WID_GO_AUTOSAVE_DROPDOWN: { // Setup autosave dropdown
    00271         list = new DropDownList();
    00272         *selected_index = _settings_client.gui.autosave;
    00273         const StringID *items = _autosave_dropdown;
    00274         for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
    00275           list->push_back(new DropDownListStringItem(*items, i, false));
    00276         }
    00277         break;
    00278       }
    00279
    00280       case WID_GO_LANG_DROPDOWN: { // Setup interface language dropdown
    00281         list = new DropDownList();
    00282         for (uint i = 0; i < _languages.Length(); i++) {
    00283           if (&_languages[i] == _current_language) *selected_index = i;
    00284           list->push_back(new DropDownListStringItem(SPECSTR_LANGUAGE_START + i, i, false));
    00285         }
    00286         list->sort(DropDownListStringItem::NatSortFunc);
    00287         break;
    00288       }
    00289
    00290       case WID_GO_RESOLUTION_DROPDOWN: // Setup resolution dropdown
    00291         list = new DropDownList();
    00292         *selected_index = GetCurRes();
    00293         for (int i = 0; i < _num_resolutions; i++) {
    00294           list->push_back(new DropDownListStringItem(SPECSTR_RESOLUTION_START + i, i, false));
    00295         }
    00296         break;
    00297
    00298       case WID_GO_SCREENSHOT_DROPDOWN: // Setup screenshot format dropdown
    00299         list = new DropDownList();
    00300         *selected_index = _cur_screenshot_format;
    00301         for (uint i = 0; i < _num_screenshot_formats; i++) {
    00302           if (!GetScreenshotFormatSupports_32bpp(i) && BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth() == 32) continue;
    00303           list->push_back(new DropDownListStringItem(SPECSTR_SCREENSHOT_START + i, i, false));
    00304         }
    00305         break;
    00306
    00307       case WID_GO_BASE_GRF_DROPDOWN:
    00308         list = BuiltSetDropDownList<BaseGraphics>(selected_index);
    00309         break;
    00310
    00311       case WID_GO_BASE_SFX_DROPDOWN:
    00312         list = BuiltSetDropDownList<BaseSounds>(selected_index);
    00313         break;
    00314
    00315       case WID_GO_BASE_MUSIC_DROPDOWN:
    00316         list = BuiltSetDropDownList<BaseMusic>(selected_index);
    00317         break;
    00318
    00319       default:
    00320         return NULL;
    00321     }
    00322
    00323     return list;
    00324   }
    00325
    00326   virtual void SetStringParameters(int widget) const
    00327   {
    00328     switch (widget) {
    00329       case WID_GO_CURRENCY_DROPDOWN:   SetDParam(0, _currency_specs[this->opt->locale.currency].name); break;
    00330       case WID_GO_DISTANCE_DROPDOWN:   SetDParam(0, STR_GAME_OPTIONS_MEASURING_UNITS_IMPERIAL + this->opt->locale.units); break;
    00331       case WID_GO_ROADSIDE_DROPDOWN:   SetDParam(0, STR_GAME_OPTIONS_ROAD_VEHICLES_DROPDOWN_LEFT + this->opt->vehicle.road_side); break;
    00332       case WID_GO_TOWNNAME_DROPDOWN:   SetDParam(0, TownName(this->opt->game_creation.town_name)); break;
    00333       case WID_GO_AUTOSAVE_DROPDOWN:   SetDParam(0, _autosave_dropdown[_settings_client.gui.autosave]); break;
    00334       case WID_GO_LANG_DROPDOWN:       SetDParamStr(0, _current_language->own_name); break;
    00335       case WID_GO_RESOLUTION_DROPDOWN: SetDParam(0, GetCurRes() == _num_resolutions ? STR_GAME_OPTIONS_RESOLUTION_OTHER : SPECSTR_RESOLUTION_START + GetCurRes()); break;
    00336       case WID_GO_SCREENSHOT_DROPDOWN: SetDParam(0, SPECSTR_SCREENSHOT_START + _cur_screenshot_format); break;
    00337       case WID_GO_BASE_GRF_DROPDOWN:   SetDParamStr(0, BaseGraphics::GetUsedSet()->name); break;
    00338       case WID_GO_BASE_GRF_STATUS:     SetDParam(0, BaseGraphics::GetUsedSet()->GetNumInvalid()); break;
    00339       case WID_GO_BASE_SFX_DROPDOWN:   SetDParamStr(0, BaseSounds::GetUsedSet()->name); break;
    00340       case WID_GO_BASE_MUSIC_DROPDOWN: SetDParamStr(0, BaseMusic::GetUsedSet()->name); break;
    00341       case WID_GO_BASE_MUSIC_STATUS:   SetDParam(0, BaseMusic::GetUsedSet()->GetNumInvalid()); break;
    00342     }
    00343   }
    00344
    00345   virtual void DrawWidget(const Rect &r, int widget) const
    00346   {
    00347     switch (widget) {
    00348       case WID_GO_BASE_GRF_DESCRIPTION:
    00349         SetDParamStr(0, BaseGraphics::GetUsedSet()->GetDescription(GetCurrentLanguageIsoCode()));
    00350         DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
    00351         break;
    00352
    00353       case WID_GO_BASE_SFX_DESCRIPTION:
    00354         SetDParamStr(0, BaseSounds::GetUsedSet()->GetDescription(GetCurrentLanguageIsoCode()));
    00355         DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
    00356         break;
    00357
    00358       case WID_GO_BASE_MUSIC_DESCRIPTION:
    00359         SetDParamStr(0, BaseMusic::GetUsedSet()->GetDescription(GetCurrentLanguageIsoCode()));
    00360         DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
    00361         break;
    00362     }
    00363   }
    00364
    00365   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    00366   {
    00367     switch (widget) {
    00368       case WID_GO_BASE_GRF_DESCRIPTION:
    00369         /* Find the biggest description for the default size. */
    00370         for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
    00371           SetDParamStr(0, BaseGraphics::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
    00372           size->height = max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
    00373         }
    00374         break;
    00375
    00376       case WID_GO_BASE_GRF_STATUS:
    00377         /* Find the biggest description for the default size. */
    00378         for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
    00379           uint invalid_files = BaseGraphics::GetSet(i)->GetNumInvalid();
    00380           if (invalid_files == 0) continue;
    00381
    00382           SetDParam(0, invalid_files);
    00383           *size = maxdim(*size, GetStringBoundingBox(STR_GAME_OPTIONS_BASE_GRF_STATUS));
    00384         }
    00385         break;
    00386
    00387       case WID_GO_BASE_SFX_DESCRIPTION:
    00388         /* Find the biggest description for the default size. */
    00389         for (int i = 0; i < BaseSounds::GetNumSets(); i++) {
    00390           SetDParamStr(0, BaseSounds::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
    00391           size->height = max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
    00392         }
    00393         break;
    00394
    00395       case WID_GO_BASE_MUSIC_DESCRIPTION:
    00396         /* Find the biggest description for the default size. */
    00397         for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
    00398           SetDParamStr(0, BaseMusic::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
    00399           size->height = max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
    00400         }
    00401         break;
    00402
    00403       case WID_GO_BASE_MUSIC_STATUS:
    00404         /* Find the biggest description for the default size. */
    00405         for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
    00406           uint invalid_files = BaseMusic::GetSet(i)->GetNumInvalid();
    00407           if (invalid_files == 0) continue;
    00408
    00409           SetDParam(0, invalid_files);
    00410           *size = maxdim(*size, GetStringBoundingBox(STR_GAME_OPTIONS_BASE_MUSIC_STATUS));
    00411         }
    00412         break;
    00413
    00414       default: {
    00415         int selected;
    00416         DropDownList *list = this->BuildDropDownList(widget, &selected);
    00417         if (list != NULL) {
    00418           /* Find the biggest item for the default size. */
    00419           for (DropDownList::iterator it = list->begin(); it != list->end(); it++) {
    00420             static const Dimension extra = {WD_DROPDOWNTEXT_LEFT + WD_DROPDOWNTEXT_RIGHT, WD_DROPDOWNTEXT_TOP + WD_DROPDOWNTEXT_BOTTOM};
    00421             Dimension string_dim;
    00422             int width = (*it)->Width();
    00423             string_dim.width = width + extra.width;
    00424             string_dim.height = (*it)->Height(width) + extra.height;
    00425             *size = maxdim(*size, string_dim);
    00426             delete *it;
    00427           }
    00428           delete list;
    00429         }
    00430       }
    00431     }
    00432   }
    00433
    00434   virtual void OnClick(Point pt, int widget, int click_count)
    00435   {
    00436     if (widget >= WID_GO_BASE_GRF_TEXTFILE && widget < WID_GO_BASE_GRF_TEXTFILE + TFT_END) {
    00437       if (BaseGraphics::GetUsedSet() == NULL) return;
    00438
    00439       ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_GRF_TEXTFILE), BaseGraphics::GetUsedSet(), STR_CONTENT_TYPE_BASE_GRAPHICS);
    00440       return;
    00441     }
    00442     if (widget >= WID_GO_BASE_SFX_TEXTFILE && widget < WID_GO_BASE_SFX_TEXTFILE + TFT_END) {
    00443       if (BaseSounds::GetUsedSet() == NULL) return;
    00444
    00445       ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_SFX_TEXTFILE), BaseSounds::GetUsedSet(), STR_CONTENT_TYPE_BASE_SOUNDS);
    00446       return;
    00447     }
    00448     if (widget >= WID_GO_BASE_MUSIC_TEXTFILE && widget < WID_GO_BASE_MUSIC_TEXTFILE + TFT_END) {
    00449       if (BaseMusic::GetUsedSet() == NULL) return;
    00450
    00451       ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_MUSIC_TEXTFILE), BaseMusic::GetUsedSet(), STR_CONTENT_TYPE_BASE_MUSIC);
    00452       return;
    00453     }
    00454     switch (widget) {
    00455       case WID_GO_FULLSCREEN_BUTTON: // Click fullscreen on/off
    00456         /* try to toggle full-screen on/off */
    00457         if (!ToggleFullScreen(!_fullscreen)) {
    00458           ShowErrorMessage(STR_ERROR_FULLSCREEN_FAILED, INVALID_STRING_ID, WL_ERROR);
    00459         }
    00460         this->SetWidgetLoweredState(WID_GO_FULLSCREEN_BUTTON, _fullscreen);
    00461         this->SetDirty();
    00462         break;
    00463
    00464       default: {
    00465         int selected;
    00466         DropDownList *list = this->BuildDropDownList(widget, &selected);
    00467         if (list != NULL) {
    00468           ShowDropDownList(this, list, selected, widget);
    00469         }
    00470         break;
    00471       }
    00472     }
    00473   }
    00474
    00480   template <class T>
    00481   void SetMediaSet(int index)
    00482   {
    00483     if (_game_mode == GM_MENU) {
    00484       const char *name = T::GetSet(index)->name;
    00485
    00486       free(T::ini_set);
    00487       T::ini_set = strdup(name);
    00488
    00489       T::SetSet(name);
    00490       this->reload = true;
    00491       this->InvalidateData();
    00492     }
    00493   }
    00494
    00495   virtual void OnDropdownSelect(int widget, int index)
    00496   {
    00497     switch (widget) {
    00498       case WID_GO_CURRENCY_DROPDOWN: // Currency
    00499         if (index == CUSTOM_CURRENCY_ID) ShowCustCurrency();
    00500         this->opt->locale.currency = index;
    00501         ReInitAllWindows();
    00502         break;
    00503
    00504       case WID_GO_DISTANCE_DROPDOWN: // Measuring units
    00505         this->opt->locale.units = index;
    00506         MarkWholeScreenDirty();
    00507         break;
    00508
    00509       case WID_GO_ROADSIDE_DROPDOWN: // Road side
    00510         if (this->opt->vehicle.road_side != index) { // only change if setting changed
    00511           uint i;
    00512           if (GetSettingFromName("vehicle.road_side", &i) == NULL) NOT_REACHED();
    00513           SetSettingValue(i, index);
    00514           MarkWholeScreenDirty();
    00515         }
    00516         break;
    00517
    00518       case WID_GO_TOWNNAME_DROPDOWN: // Town names
    00519         if (_game_mode == GM_MENU || Town::GetNumItems() == 0) {
    00520           this->opt->game_creation.town_name = index;
    00521           SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_GAME_OPTIONS);
    00522         }
    00523         break;
    00524
    00525       case WID_GO_AUTOSAVE_DROPDOWN: // Autosave options
    00526         _settings_client.gui.autosave = index;
    00527         this->SetDirty();
    00528         break;
    00529
    00530       case WID_GO_LANG_DROPDOWN: // Change interface language
    00531         ReadLanguagePack(&_languages[index]);
    00532         DeleteWindowByClass(WC_QUERY_STRING);
    00533         CheckForMissingGlyphs();
    00534         UpdateAllVirtCoords();
    00535         ReInitAllWindows();
    00536         break;
    00537
    00538       case WID_GO_RESOLUTION_DROPDOWN: // Change resolution
    00539         if (index < _num_resolutions && ChangeResInGame(_resolutions[index].width, _resolutions[index].height)) {
    00540           this->SetDirty();
    00541         }
    00542         break;
    00543
    00544       case WID_GO_SCREENSHOT_DROPDOWN: // Change screenshot format
    00545         SetScreenshotFormat(index);
    00546         this->SetDirty();
    00547         break;
    00548
    00549       case WID_GO_BASE_GRF_DROPDOWN:
    00550         this->SetMediaSet<BaseGraphics>(index);
    00551         break;
    00552
    00553       case WID_GO_BASE_SFX_DROPDOWN:
    00554         this->SetMediaSet<BaseSounds>(index);
    00555         break;
    00556
    00557       case WID_GO_BASE_MUSIC_DROPDOWN:
    00558         this->SetMediaSet<BaseMusic>(index);
    00559         break;
    00560     }
    00561   }
    00562
    00568   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
    00569   {
    00570     if (!gui_scope) return;
    00571     this->SetWidgetLoweredState(WID_GO_FULLSCREEN_BUTTON, _fullscreen);
    00572
    00573     bool missing_files = BaseGraphics::GetUsedSet()->GetNumMissing() == 0;
    00574     this->GetWidget<NWidgetCore>(WID_GO_BASE_GRF_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_GRF_STATUS, STR_NULL);
    00575
    00576     for (TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
    00577       this->SetWidgetDisabledState(WID_GO_BASE_GRF_TEXTFILE + tft, BaseGraphics::GetUsedSet() == NULL || BaseGraphics::GetUsedSet()->GetTextfile(tft) == NULL);
    00578       this->SetWidgetDisabledState(WID_GO_BASE_SFX_TEXTFILE + tft, BaseSounds::GetUsedSet() == NULL || BaseSounds::GetUsedSet()->GetTextfile(tft) == NULL);
    00579       this->SetWidgetDisabledState(WID_GO_BASE_MUSIC_TEXTFILE + tft, BaseMusic::GetUsedSet() == NULL || BaseMusic::GetUsedSet()->GetTextfile(tft) == NULL);
    00580     }
    00581
    00582     missing_files = BaseMusic::GetUsedSet()->GetNumInvalid() == 0;
    00583     this->GetWidget<NWidgetCore>(WID_GO_BASE_MUSIC_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_MUSIC_STATUS, STR_NULL);
    00584   }
    00585 };
    00586
    00587 static const NWidgetPart _nested_game_options_widgets[] = {
    00588   NWidget(NWID_HORIZONTAL),
    00589     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    00590     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    00591   EndContainer(),
    00592   NWidget(WWT_PANEL, COLOUR_GREY, WID_GO_BACKGROUND), SetPIP(6, 6, 10),
    00593     NWidget(NWID_HORIZONTAL), SetPIP(10, 10, 10),
    00594       NWidget(NWID_VERTICAL), SetPIP(0, 6, 0),
    00595         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_CURRENCY_UNITS_FRAME, STR_NULL),
    00596           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_CURRENCY_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_CURRENCY_UNITS_DROPDOWN_TOOLTIP), SetFill(1, 0),
    00597         EndContainer(),
    00598         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_ROAD_VEHICLES_FRAME, STR_NULL),
    00599           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_ROADSIDE_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_ROAD_VEHICLES_DROPDOWN_TOOLTIP), SetFill(1, 0),
    00600         EndContainer(),
    00601         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_AUTOSAVE_FRAME, STR_NULL),
    00602           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_AUTOSAVE_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_TOOLTIP), SetFill(1, 0),
    00603         EndContainer(),
    00604         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_RESOLUTION, STR_NULL),
    00605           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_RESOLUTION_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_RESOLUTION_TOOLTIP), SetFill(1, 0), SetPadding(0, 0, 3, 0),
    00606           NWidget(NWID_HORIZONTAL),
    00607             NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 0), SetDataTip(STR_GAME_OPTIONS_FULLSCREEN, STR_NULL),
    00608             NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GO_FULLSCREEN_BUTTON), SetMinimalSize(21, 9), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_FULLSCREEN_TOOLTIP),
    00609           EndContainer(),
    00610         EndContainer(),
    00611       EndContainer(),
    00612
    00613       NWidget(NWID_VERTICAL), SetPIP(0, 6, 0),
    00614         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_MEASURING_UNITS_FRAME, STR_NULL),
    00615           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_DISTANCE_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_MEASURING_UNITS_DROPDOWN_TOOLTIP), SetFill(1, 0),
    00616         EndContainer(),
    00617         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_TOWN_NAMES_FRAME, STR_NULL),
    00618           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_TOWNNAME_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_TOWN_NAMES_DROPDOWN_TOOLTIP), SetFill(1, 0),
    00619         EndContainer(),
    00620         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_LANGUAGE, STR_NULL),
    00621           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_LANG_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_LANGUAGE_TOOLTIP), SetFill(1, 0),
    00622         EndContainer(),
    00623         NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_SCREENSHOT_FORMAT, STR_NULL),
    00624           NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_SCREENSHOT_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_SCREENSHOT_FORMAT_TOOLTIP), SetFill(1, 0),
    00625         EndContainer(),
    00626         NWidget(NWID_SPACER), SetMinimalSize(0, 0), SetFill(0, 1),
    00627       EndContainer(),
    00628     EndContainer(),
    00629
    00630     NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_GRF, STR_NULL), SetPadding(0, 10, 0, 10),
    00631       NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
    00632         NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_GRF_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_GRF_TOOLTIP),
    00633         NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_GRF_STATUS), SetMinimalSize(150, 12), SetDataTip(STR_EMPTY, STR_NULL), SetFill(1, 0),
    00634       EndContainer(),
    00635       NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_GRF_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_GRF_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
    00636       NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(7, 0, 7),
    00637         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
    00638         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
    00639         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
    00640       EndContainer(),
    00641     EndContainer(),
    00642
    00643     NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_SFX, STR_NULL), SetPadding(0, 10, 0, 10),
    00644       NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
    00645         NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_SFX_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_SFX_TOOLTIP),
    00646         NWidget(NWID_SPACER), SetFill(1, 0),
    00647       EndContainer(),
    00648       NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_SFX_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_SFX_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
    00649       NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(7, 0, 7),
    00650         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
    00651         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
    00652         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
    00653       EndContainer(),
    00654     EndContainer(),
    00655
    00656     NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_MUSIC, STR_NULL), SetPadding(0, 10, 0, 10),
    00657       NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
    00658         NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_MUSIC_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_MUSIC_TOOLTIP),
    00659         NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_MUSIC_STATUS), SetMinimalSize(150, 12), SetDataTip(STR_EMPTY, STR_NULL), SetFill(1, 0),
    00660       EndContainer(),
    00661       NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_MUSIC_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_MUSIC_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
    00662       NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(7, 0, 7),
    00663         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
    00664         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
    00665         NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
    00666       EndContainer(),
    00667     EndContainer(),
    00668   EndContainer(),
    00669 };
    00670
    00671 static const WindowDesc _game_options_desc(
    00672   WDP_CENTER, 0, 0,
    00673   WC_GAME_OPTIONS, WC_NONE,
    00674   0,
    00675   _nested_game_options_widgets, lengthof(_nested_game_options_widgets)
    00676 );
    00677
    00679 void ShowGameOptions()
    00680 {
    00681   DeleteWindowByClass(WC_GAME_OPTIONS);
    00682   new GameOptionsWindow(&_game_options_desc);
    00683 }
    00684
    00685 extern void StartupEconomy();
    00686
    00687 void SetDifficultyLevel(int mode, DifficultySettings *gm_opt);
    00688
    00689 class GameDifficultyWindow : public Window {
    00690 private:
    00691   /* Temporary holding place of values in the difficulty window until 'Save' is clicked */
    00692   GameSettings opt_mod_temp;
    00693
    00694 public:
    00696   static const uint GAME_DIFFICULTY_NUM = 18;
    00698   static const uint WIDGETS_PER_DIFFICULTY = 3;
    00699
    00700   GameDifficultyWindow(const WindowDesc *desc) : Window()
    00701   {
    00702     this->InitNested(desc, WN_GAME_OPTIONS_GAME_DIFFICULTY);
    00703
    00704     /* Setup disabled buttons when creating window
    00705      * disable all other difficulty buttons during gameplay except for 'custom' */
    00706     this->SetWidgetsDisabledState(_game_mode != GM_MENU,
    00707       WID_GD_LVL_EASY,
    00708       WID_GD_LVL_MEDIUM,
    00709       WID_GD_LVL_HARD,
    00710       WID_GD_LVL_CUSTOM,
    00711       WIDGET_LIST_END);
    00712     this->SetWidgetDisabledState(WID_GD_HIGHSCORE, _game_mode == GM_EDITOR || _networking); // highscore chart in multiplayer
    00713     this->SetWidgetDisabledState(WID_GD_ACCEPT, _networking && !_network_server); // Save-button in multiplayer (and if client)
    00714
    00715     /* Read data */
    00716     this->OnInvalidateData(GOID_DIFFICULTY_CHANGED);
    00717   }
    00718
    00719   virtual void SetStringParameters(int widget) const
    00720   {
    00721     widget -= WID_GD_OPTIONS_START;
    00722     if (widget < 0 || (widget % 3) != 2) return;
    00723
    00724     widget /= 3;
    00725
    00726     uint i;
    00727     const SettingDesc *sd = GetSettingFromName("difficulty.max_no_competitors", &i) + widget;
    00728     int32 value = (int32)ReadValue(GetVariableAddress(&this->opt_mod_temp, &sd->save), sd->save.conv);
    00729     SetDParam(0, sd->desc.str_val + value);
    00730   }
    00731
    00732   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    00733   {
    00734     /* Only for the 'descriptions' */
    00735     int index = widget - WID_GD_OPTIONS_START;
    00736     if (index < 0 || (index % 3) != 2) return;
    00737
    00738     index /= 3;
    00739
    00740     uint i;
    00741     const SettingDesc *sd = GetSettingFromName("difficulty.max_no_competitors", &i) + index;
    00742     const SettingDescBase *sdb = &sd->desc;
    00743
    00744     /* Get the string and try all strings from the smallest to the highest value */
    00745     StringID str = this->GetWidget<NWidgetCore>(widget)->widget_data;
    00746     for (int32 value = sdb->min; (uint32)value <= sdb->max; value += sdb->interval) {
    00747       SetDParam(0, sdb->str_val + value);
    00748       *size = maxdim(*size, GetStringBoundingBox(str));
    00749     }
    00750   }
    00751
    00752   virtual void OnClick(Point pt, int widget, int click_count)
    00753   {
    00754     if (widget >= WID_GD_OPTIONS_START) {
    00755       widget -= WID_GD_OPTIONS_START;
    00756       if ((widget % 3) == 2) return;
    00757
    00758       /* Don't allow clients to make any changes */
    00759       if (_networking && !_network_server) return;
    00760
    00761       uint i;
    00762       const SettingDesc *sd = GetSettingFromName("difficulty.max_no_competitors", &i) + (widget / 3);
    00763       const SettingDescBase *sdb = &sd->desc;
    00764
    00765       int32 val = (int32)ReadValue(GetVariableAddress(&this->opt_mod_temp, &sd->save), sd->save.conv);
    00766       if (widget % 3 == 1) {
    00767         /* Increase button clicked */
    00768         val = min(val + sdb->interval, (int32)sdb->max);
    00769       } else {
    00770         /* Decrease button clicked */
    00771         val -= sdb->interval;
    00772         val = max(val, sdb->min);
    00773       }
    00774
    00775       /* save value in temporary variable */
    00776       WriteValue(GetVariableAddress(&this->opt_mod_temp, &sd->save), sd->save.conv, val);
    00777       this->RaiseWidget(WID_GD_LVL_EASY + this->opt_mod_temp.difficulty.diff_level);
    00778       SetDifficultyLevel(3, &this->opt_mod_temp.difficulty); // set difficulty level to custom
    00779       this->LowerWidget(WID_GD_LVL_CUSTOM);
    00780       this->InvalidateData();
    00781
    00782       if (widget / 3 == 0 &&
    00783           AI::GetInfoList()->size() == 0 &&
    00784           this->opt_mod_temp.difficulty.max_no_competitors != 0) {
    00785         ShowErrorMessage(STR_WARNING_NO_SUITABLE_AI, INVALID_STRING_ID, WL_CRITICAL);
    00786       }
    00787       return;
    00788     }
    00789
    00790     switch (widget) {
    00791       case WID_GD_LVL_EASY:
    00792       case WID_GD_LVL_MEDIUM:
    00793       case WID_GD_LVL_HARD:
    00794       case WID_GD_LVL_CUSTOM:
    00795         /* temporarily change difficulty level */
    00796         this->RaiseWidget(WID_GD_LVL_EASY + this->opt_mod_temp.difficulty.diff_level);
    00797         SetDifficultyLevel(widget - WID_GD_LVL_EASY, &this->opt_mod_temp.difficulty);
    00798         this->LowerWidget(WID_GD_LVL_EASY + this->opt_mod_temp.difficulty.diff_level);
    00799         this->InvalidateData();
    00800         break;
    00801
    00802       case WID_GD_HIGHSCORE: // Highscore Table
    00803         ShowHighscoreTable(this->opt_mod_temp.difficulty.diff_level, -1);
    00804         break;
    00805
    00806       case WID_GD_ACCEPT: { // Save button - save changes
    00807         GameSettings *opt_ptr = &GetGameSettings();
    00808
    00809         uint i;
    00810         GetSettingFromName("difficulty.diff_level", &i);
    00811         DoCommandP(0, i, this->opt_mod_temp.difficulty.diff_level, CMD_CHANGE_SETTING);
    00812
    00813         const SettingDesc *sd = GetSettingFromName("difficulty.max_no_competitors", &i);
    00814         for (uint btn = 0; btn != GAME_DIFFICULTY_NUM; btn++, sd++) {
    00815           int32 new_val = (int32)ReadValue(GetVariableAddress(&this->opt_mod_temp, &sd->save), sd->save.conv);
    00816           int32 cur_val = (int32)ReadValue(GetVariableAddress(opt_ptr, &sd->save), sd->save.conv);
    00817           /* if setting has changed, change it */
    00818           if (new_val != cur_val) {
    00819             DoCommandP(0, i + btn, new_val, CMD_CHANGE_SETTING);
    00820           }
    00821         }
    00822         delete this;
    00823         /* If we are in the editor, we should reload the economy.
    00824          * This way when you load a game, the max loan and interest rate
    00825          * are loaded correctly. */
    00826         if (_game_mode == GM_EDITOR) StartupEconomy();
    00827         break;
    00828       }
    00829
    00830       case WID_GD_CANCEL: // Cancel button - close window, abandon changes
    00831         delete this;
    00832         break;
    00833     }
    00834   }
    00835
    00841   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
    00842   {
    00843     if (!gui_scope) return;
    00844
    00845     if (data == GOID_DIFFICULTY_CHANGED) {
    00846       /* Window was created or settings were changed on server. Reread everything. */
    00847
    00848       /* Copy current settings (ingame or in intro) to temporary holding place
    00849        * change that when setting stuff, copy back on clicking 'OK' */
    00850       this->opt_mod_temp = GetGameSettings();
    00851
    00852       this->LowerWidget(WID_GD_LVL_EASY + this->opt_mod_temp.difficulty.diff_level);
    00853     }
    00854
    00855     uint i;
    00856     const SettingDesc *sd = GetSettingFromName("difficulty.max_no_competitors", &i);
    00857     for (i = 0; i < GAME_DIFFICULTY_NUM; i++, sd++) {
    00858       const SettingDescBase *sdb = &sd->desc;
    00859       /* skip deprecated difficulty options */
    00860       if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
    00861       int32 value = (int32)ReadValue(GetVariableAddress(&this->opt_mod_temp, &sd->save), sd->save.conv);
    00862       bool disable = (sd->desc.flags & SGF_NEWGAME_ONLY) &&
    00863           (_game_mode == GM_NORMAL ||
    00864           (_game_mode == GM_EDITOR && (sd->desc.flags & SGF_SCENEDIT_TOO) == 0));
    00865
    00866       this->SetWidgetDisabledState(WID_GD_OPTIONS_START + i * 3 + 0, disable || sdb->min == value);
    00867       this->SetWidgetDisabledState(WID_GD_OPTIONS_START + i * 3 + 1, disable || sdb->max == (uint32)value);
    00868     }
    00869   }
    00870 };
    00871
    00872 static NWidgetBase *MakeDifficultyOptionsWidgets(int *biggest_index)
    00873 {
    00874   NWidgetVertical *vert_desc = new NWidgetVertical;
    00875
    00876   int widnum = WID_GD_OPTIONS_START;
    00877   uint i, j;
    00878   const SettingDesc *sd = GetSettingFromName("difficulty.max_no_competitors", &i);
    00879
    00880   for (i = 0, j = 0; i < GameDifficultyWindow::GAME_DIFFICULTY_NUM; i++, sd++, widnum += GameDifficultyWindow::WIDGETS_PER_DIFFICULTY) {
    00881     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
    00882
    00883     NWidgetHorizontal *hor = new NWidgetHorizontal;
    00884
    00885     /* [<] button. */
    00886     NWidgetLeaf *leaf = new NWidgetLeaf(WWT_PUSHARROWBTN, COLOUR_YELLOW, widnum, AWV_DECREASE, STR_TOOLTIP_HSCROLL_BAR_SCROLLS_LIST);
    00887     hor->Add(leaf);
    00888
    00889     /* [>] button. */
    00890     leaf = new NWidgetLeaf(WWT_PUSHARROWBTN, COLOUR_YELLOW, widnum + 1, AWV_INCREASE, STR_TOOLTIP_HSCROLL_BAR_SCROLLS_LIST);
    00891     hor->Add(leaf);
    00892
    00893     /* Some spacing between the text and the description */
    00894     NWidgetSpacer *spacer = new NWidgetSpacer(5, 0);
    00895     hor->Add(spacer);
    00896
    00897     /* Descriptive text. */
    00898     leaf = new NWidgetLeaf(WWT_TEXT, COLOUR_YELLOW, widnum + 2, STR_DIFFICULTY_LEVEL_SETTING_MAXIMUM_NO_COMPETITORS + (j++), STR_NULL);
    00899     leaf->SetFill(1, 0);
    00900     hor->Add(leaf);
    00901     vert_desc->Add(hor);
    00902
    00903     /* Space vertically */
    00904     vert_desc->Add(new NWidgetSpacer(0, 2));
    00905   }
    00906   *biggest_index = widnum - 1;
    00907   return vert_desc;
    00908 }
    00909
    00910
    00912 static const NWidgetPart _nested_game_difficulty_widgets[] = {
    00913   NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_DIFFICULTY_LEVEL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    00914   NWidget(WWT_PANEL, COLOUR_MAUVE),
    00915     NWidget(NWID_VERTICAL), SetPIP(2, 0, 2),
    00916       NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(10, 0, 10),
    00917         NWidget(WWT_TEXTBTN, COLOUR_YELLOW, WID_GD_LVL_EASY), SetDataTip(STR_DIFFICULTY_LEVEL_EASY, STR_NULL), SetFill(1, 0),
    00918         NWidget(WWT_TEXTBTN, COLOUR_YELLOW, WID_GD_LVL_MEDIUM), SetDataTip(STR_DIFFICULTY_LEVEL_MEDIUM, STR_NULL), SetFill(1, 0),
    00919         NWidget(WWT_TEXTBTN, COLOUR_YELLOW, WID_GD_LVL_HARD), SetDataTip(STR_DIFFICULTY_LEVEL_HARD, STR_NULL), SetFill(1, 0),
    00920         NWidget(WWT_TEXTBTN, COLOUR_YELLOW, WID_GD_LVL_CUSTOM), SetDataTip(STR_DIFFICULTY_LEVEL_CUSTOM, STR_NULL), SetFill(1, 0),
    00921       EndContainer(),
    00922       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 10),
    00923         NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_GD_HIGHSCORE), SetDataTip(STR_DIFFICULTY_LEVEL_HIGH_SCORE_BUTTON, STR_NULL), SetFill(1, 0),
    00924       EndContainer(),
    00925     EndContainer(),
    00926   EndContainer(),
    00927   NWidget(WWT_PANEL, COLOUR_MAUVE),
    00928     NWidget(NWID_VERTICAL), SetPIP(3, 0, 1),
    00929       NWidget(NWID_HORIZONTAL), SetPIP(5, 0, 5),
    00930         NWidgetFunction(MakeDifficultyOptionsWidgets),
    00931       EndContainer(),
    00932     EndContainer(),
    00933   EndContainer(),
    00934   NWidget(WWT_PANEL, COLOUR_MAUVE),
    00935     NWidget(NWID_VERTICAL), SetPIP(2, 0, 2),
    00936       NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(10, 0, 10),
    00937         NWidget(NWID_SPACER), SetFill(1, 0),
    00938         NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GD_ACCEPT), SetDataTip(STR_DIFFICULTY_LEVEL_SAVE, STR_NULL), SetFill(1, 0),
    00939         NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_GD_CANCEL), SetDataTip(STR_BUTTON_CANCEL, STR_NULL), SetFill(1, 0),
    00940         NWidget(NWID_SPACER), SetFill(1, 0),
    00941       EndContainer(),
    00942     EndContainer(),
    00943   EndContainer(),
    00944 };
    00945
    00947 static const WindowDesc _game_difficulty_desc(
    00948   WDP_CENTER, 0, 0,
    00949   WC_GAME_OPTIONS, WC_NONE,
    00950   0,
    00951   _nested_game_difficulty_widgets, lengthof(_nested_game_difficulty_widgets)
    00952 );
    00953
    00955 void ShowGameDifficulty()
    00956 {
    00957   DeleteWindowByClass(WC_GAME_OPTIONS);
    00958   new GameDifficultyWindow(&_game_difficulty_desc);
    00959 }
    00960
    00961 static int SETTING_HEIGHT = 11;
    00962 static const int LEVEL_WIDTH = 15;
    00963
    00968 enum SettingEntryFlags {
    00969   SEF_LEFT_DEPRESSED  = 0x01,
    00970   SEF_RIGHT_DEPRESSED = 0x02,
    00971   SEF_BUTTONS_MASK = (SEF_LEFT_DEPRESSED | SEF_RIGHT_DEPRESSED),
    00972
    00973   SEF_LAST_FIELD = 0x04,
    00974   SEF_FILTERED   = 0x08,
    00975
    00976   /* Entry kind */
    00977   SEF_SETTING_KIND = 0x10,
    00978   SEF_SUBTREE_KIND = 0x20,
    00979   SEF_KIND_MASK    = (SEF_SETTING_KIND | SEF_SUBTREE_KIND),
    00980 };
    00981
    00982 struct SettingsPage; // Forward declaration
    00983
    00985 struct SettingEntrySubtree {
    00986   SettingsPage *page;
    00987   bool folded;
    00988   StringID title;
    00989 };
    00990
    00992 struct SettingEntrySetting {
    00993   const char *name;
    00994   const SettingDesc *setting;
    00995   uint index;
    00996 };
    00997
    00999 enum RestrictionMode {
    01000   RM_BASIC,
    01001   RM_ADVANCED,
    01002   RM_ALL,
    01003   RM_CHANGED_AGAINST_DEFAULT,
    01004   RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL,
    01005   RM_CHANGED_AGAINST_NEW,
    01006   RM_END,
    01007 };
    01008
    01010 struct SettingEntry {
    01011   byte flags;
    01012   byte level;
    01013   union {
    01014     SettingEntrySetting entry;
    01015     SettingEntrySubtree sub;
    01016   } d;
    01017
    01018   SettingEntry(const char *nm);
    01019   SettingEntry(SettingsPage *sub, StringID title);
    01020
    01021   void Init(byte level);
    01022   void FoldAll();
    01023   void UnFoldAll();
    01024   void SetButtons(byte new_val);
    01025
    01030   void SetLastField(bool last_field) { if (last_field) SETBITS(this->flags, SEF_LAST_FIELD); else CLRBITS(this->flags, SEF_LAST_FIELD); }
    01031
    01032   uint Length() const;
    01033   void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
    01034   bool IsVisible(const SettingEntry *item) const;
    01035   SettingEntry *FindEntry(uint row, uint *cur_row);
    01036   uint GetMaxHelpHeight(int maxw);
    01037
    01038   bool IsFiltered() const;
    01039   bool UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode);
    01040
    01041   uint Draw(GameSettings *settings_ptr, int base_x, int base_y, int max_x, uint first_row, uint max_row, uint cur_row, uint parent_last, SettingEntry *selected);
    01042
    01047   inline StringID GetHelpText()
    01048   {
    01049     assert((this->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
    01050     return this->d.entry.setting->desc.str_help;
    01051   }
    01052
    01053   void SetValueDParams(uint first_param, int32 value);
    01054
    01055 private:
    01056   void DrawSetting(GameSettings *settings_ptr, int x, int y, int max_x, int state, bool highlight);
    01057   bool IsVisibleByRestrictionMode(RestrictionMode mode) const;
    01058 };
    01059
    01061 struct SettingsPage {
    01062   SettingEntry *entries;
    01063   byte num;
    01064
    01065   void Init(byte level = 0);
    01066   void FoldAll();
    01067   void UnFoldAll();
    01068
    01069   uint Length() const;
    01070   void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
    01071   bool IsVisible(const SettingEntry *item) const;
    01072   SettingEntry *FindEntry(uint row, uint *cur_row) const;
    01073   uint GetMaxHelpHeight(int maxw);
    01074
    01075   bool UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode);
    01076
    01077   uint Draw(GameSettings *settings_ptr, int base_x, int base_y, int max_x, uint first_row, uint max_row, SettingEntry *selected, uint cur_row = 0, uint parent_last = 0) const;
    01078 };
    01079
    01080
    01081 /* == SettingEntry methods == */
    01082
    01087 SettingEntry::SettingEntry(const char *nm)
    01088 {
    01089   this->flags = SEF_SETTING_KIND;
    01090   this->level = 0;
    01091   this->d.entry.name = nm;
    01092   this->d.entry.setting = NULL;
    01093   this->d.entry.index = 0;
    01094 }
    01095
    01101 SettingEntry::SettingEntry(SettingsPage *sub, StringID title)
    01102 {
    01103   this->flags = SEF_SUBTREE_KIND;
    01104   this->level = 0;
    01105   this->d.sub.page = sub;
    01106   this->d.sub.folded = true;
    01107   this->d.sub.title = title;
    01108 }
    01109
    01114 void SettingEntry::Init(byte level)
    01115 {
    01116   this->level = level;
    01117
    01118   switch (this->flags & SEF_KIND_MASK) {
    01119     case SEF_SETTING_KIND:
    01120       this->d.entry.setting = GetSettingFromName(this->d.entry.name, &this->d.entry.index);
    01121       assert(this->d.entry.setting != NULL);
    01122       break;
    01123     case SEF_SUBTREE_KIND:
    01124       this->d.sub.page->Init(level + 1);
    01125       break;
    01126     default: NOT_REACHED();
    01127   }
    01128 }
    01129
    01131 void SettingEntry::FoldAll()
    01132 {
    01133   if (this->IsFiltered()) return;
    01134   switch (this->flags & SEF_KIND_MASK) {
    01135     case SEF_SETTING_KIND:
    01136       break;
    01137
    01138     case SEF_SUBTREE_KIND:
    01139       this->d.sub.folded = true;
    01140       this->d.sub.page->FoldAll();
    01141       break;
    01142
    01143     default: NOT_REACHED();
    01144   }
    01145 }
    01146
    01148 void SettingEntry::UnFoldAll()
    01149 {
    01150   if (this->IsFiltered()) return;
    01151   switch (this->flags & SEF_KIND_MASK) {
    01152     case SEF_SETTING_KIND:
    01153       break;
    01154
    01155     case SEF_SUBTREE_KIND:
    01156       this->d.sub.folded = false;
    01157       this->d.sub.page->UnFoldAll();
    01158       break;
    01159
    01160     default: NOT_REACHED();
    01161   }
    01162 }
    01163
    01169 void SettingEntry::GetFoldingState(bool &all_folded, bool &all_unfolded) const
    01170 {
    01171   if (this->IsFiltered()) return;
    01172   switch (this->flags & SEF_KIND_MASK) {
    01173     case SEF_SETTING_KIND:
    01174       break;
    01175
    01176     case SEF_SUBTREE_KIND:
    01177       if (this->d.sub.folded) {
    01178         all_unfolded = false;
    01179       } else {
    01180         all_folded = false;
    01181       }
    01182       this->d.sub.page->GetFoldingState(all_folded, all_unfolded);
    01183       break;
    01184
    01185     default: NOT_REACHED();
    01186   }
    01187 }
    01188
    01195 bool SettingEntry::IsVisible(const SettingEntry *item) const
    01196 {
    01197   if (this->IsFiltered()) return false;
    01198   if (this == item) return true;
    01199
    01200   switch (this->flags & SEF_KIND_MASK) {
    01201     case SEF_SETTING_KIND:
    01202       return false;
    01203
    01204     case SEF_SUBTREE_KIND:
    01205       return !this->d.sub.folded && this->d.sub.page->IsVisible(item);
    01206
    01207     default: NOT_REACHED();
    01208   }
    01209 }
    01210
    01216 void SettingEntry::SetButtons(byte new_val)
    01217 {
    01218   assert((new_val & ~SEF_BUTTONS_MASK) == 0); // Should not touch any flags outside the buttons
    01219   this->flags = (this->flags & ~SEF_BUTTONS_MASK) | new_val;
    01220 }
    01221
    01223 uint SettingEntry::Length() const
    01224 {
    01225   if (this->IsFiltered()) return 0;
    01226   switch (this->flags & SEF_KIND_MASK) {
    01227     case SEF_SETTING_KIND:
    01228       return 1;
    01229     case SEF_SUBTREE_KIND:
    01230       if (this->d.sub.folded) return 1; // Only displaying the title
    01231
    01232       return 1 + this->d.sub.page->Length(); // 1 extra row for the title
    01233     default: NOT_REACHED();
    01234   }
    01235 }
    01236
    01243 SettingEntry *SettingEntry::FindEntry(uint row_num, uint *cur_row)
    01244 {
    01245   if (this->IsFiltered()) return NULL;
    01246   if (row_num == *cur_row) return this;
    01247
    01248   switch (this->flags & SEF_KIND_MASK) {
    01249     case SEF_SETTING_KIND:
    01250       (*cur_row)++;
    01251       break;
    01252     case SEF_SUBTREE_KIND:
    01253       (*cur_row)++; // add one for row containing the title
    01254       if (this->d.sub.folded) {
    01255         break;
    01256       }
    01257
    01258       /* sub-page is visible => search it too */
    01259       return this->d.sub.page->FindEntry(row_num, cur_row);
    01260     default: NOT_REACHED();
    01261   }
    01262   return NULL;
    01263 }
    01264
    01270 uint SettingEntry::GetMaxHelpHeight(int maxw)
    01271 {
    01272   switch (this->flags & SEF_KIND_MASK) {
    01273     case SEF_SETTING_KIND: return GetStringHeight(this->GetHelpText(), maxw);
    01274     case SEF_SUBTREE_KIND: return this->d.sub.page->GetMaxHelpHeight(maxw);
    01275     default:               NOT_REACHED();
    01276   }
    01277 }
    01278
    01283 bool SettingEntry::IsFiltered() const
    01284 {
    01285   return (this->flags & SEF_FILTERED) != 0;
    01286 }
    01287
    01293 bool SettingEntry::IsVisibleByRestrictionMode(RestrictionMode mode) const
    01294 {
    01295   /* There shall not be any restriction, i.e. all settings shall be visible. */
    01296   if (mode == RM_ALL) return true;
    01297
    01298   GameSettings *settings_ptr = &GetGameSettings();
    01299   assert((this->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
    01300   const SettingDesc *sd = this->d.entry.setting;
    01301
    01302   if (mode == RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL && (sd->save.conv & SLF_NO_NETWORK_SYNC) != 0) {
    01303     /* Hide local settings when comparing our settings against those of the server. */
    01304     return false;
    01305   }
    01306
    01307   if (mode == RM_BASIC) return (this->d.entry.setting->desc.cat & SC_BASIC_LIST) != 0;
    01308   if (mode == RM_ADVANCED) return (this->d.entry.setting->desc.cat & SC_ADVANCED_LIST) != 0;
    01309
    01310   /* Read the current value. */
    01311   const void *var = ResolveVariableAddress(settings_ptr, sd);
    01312   int64 current_value = ReadValue(var, sd->save.conv);
    01313
    01314   int64 filter_value;
    01315
    01316   if (mode == RM_CHANGED_AGAINST_DEFAULT || mode == RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL) {
    01317     /* This entry shall only be visible, if the value deviates from its default value. */
    01318
    01319     /* Read the default value. */
    01320     filter_value = ReadValue(&sd->desc.def, sd->save.conv);
    01321   } else {
    01322     assert(mode == RM_CHANGED_AGAINST_NEW);
    01323     /* This entry shall only be visible, if the value deviates from
    01324      * its value is used when starting a new game. */
    01325
    01326     /* Make sure we're not comparing the new game settings against itself. */
    01327     assert(settings_ptr != &_settings_newgame);
    01328
    01329     /* Read the new game's value. */
    01330     var = ResolveVariableAddress(&_settings_newgame, sd);
    01331     filter_value = ReadValue(var, sd->save.conv);
    01332   }
    01333
    01334   return current_value != filter_value;
    01335 }
    01336
    01344 bool SettingEntry::UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode)
    01345 {
    01346   CLRBITS(this->flags, SEF_FILTERED);
    01347
    01348   bool visible = true;
    01349   switch (this->flags & SEF_KIND_MASK) {
    01350     case SEF_SETTING_KIND: {
    01351       if (!force_visible && !filter.IsEmpty()) {
    01352         /* Process the search text filter for this item. */
    01353         filter.ResetState();
    01354
    01355         const SettingDesc *sd = this->d.entry.setting;
    01356         const SettingDescBase *sdb = &sd->desc;
    01357
    01358         SetDParam(0, STR_EMPTY);
    01359         filter.AddLine(sdb->str);
    01360         filter.AddLine(this->GetHelpText());
    01361
    01362         visible = filter.GetState();
    01363       }
    01364       visible = visible && this->IsVisibleByRestrictionMode(mode);
    01365       break;
    01366     }
    01367     case SEF_SUBTREE_KIND: {
    01368       if (!force_visible && !filter.IsEmpty()) {
    01369         filter.ResetState();
    01370         filter.AddLine(this->d.sub.title);
    01371         force_visible = filter.GetState();
    01372       }
    01373       visible = this->d.sub.page->UpdateFilterState(filter, force_visible, mode);
    01374       break;
    01375     }
    01376     default: NOT_REACHED();
    01377   }
    01378
    01379   if (!visible) SETBITS(this->flags, SEF_FILTERED);
    01380   return visible;
    01381 }
    01382
    01383
    01384
    01412 uint SettingEntry::Draw(GameSettings *settings_ptr, int left, int right, int base_y, uint first_row, uint max_row, uint cur_row, uint parent_last, SettingEntry *selected)
    01413 {
    01414   if (this->IsFiltered()) return cur_row;
    01415   if (cur_row >= max_row) return cur_row;
    01416
    01417   bool rtl = _current_text_dir == TD_RTL;
    01418   int offset = rtl ? -4 : 4;
    01419   int level_width = rtl ? -LEVEL_WIDTH : LEVEL_WIDTH;
    01420
    01421   int x = rtl ? right : left;
    01422   int y = base_y;
    01423   if (cur_row >= first_row) {
    01424     int colour = _colour_gradient[COLOUR_ORANGE][4];
    01425     y = base_y + (cur_row - first_row) * SETTING_HEIGHT; // Compute correct y start position
    01426
    01427     /* Draw vertical for parent nesting levels */
    01428     for (uint lvl = 0; lvl < this->level; lvl++) {
    01429       if (!HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y + SETTING_HEIGHT - 1, colour);
    01430       x += level_width;
    01431     }
    01432     /* draw own |- prefix */
    01433     int halfway_y = y + SETTING_HEIGHT / 2;
    01434     int bottom_y = (flags & SEF_LAST_FIELD) ? halfway_y : y + SETTING_HEIGHT - 1;
    01435     GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
    01436     /* Small horizontal line from the last vertical line */
    01437     GfxDrawLine(x + offset, halfway_y, x + level_width - offset, halfway_y, colour);
    01438     x += level_width;
    01439   }
    01440
    01441   switch (this->flags & SEF_KIND_MASK) {
    01442     case SEF_SETTING_KIND:
    01443       if (cur_row >= first_row) {
    01444         this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y, this->flags & SEF_BUTTONS_MASK,
    01445             this == selected);
    01446       }
    01447       cur_row++;
    01448       break;
    01449     case SEF_SUBTREE_KIND:
    01450       if (cur_row >= first_row) {
    01451         DrawSprite((this->d.sub.folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED), PAL_NONE, rtl ? x - 8 : x, y + (SETTING_HEIGHT - 11) / 2);
    01452         DrawString(rtl ? left : x + 12, rtl ? x - 12 : right, y, this->d.sub.title);
    01453       }
    01454       cur_row++;
    01455       if (!this->d.sub.folded) {
    01456         if (this->flags & SEF_LAST_FIELD) {
    01457           assert(this->level < sizeof(parent_last));
    01458           SetBit(parent_last, this->level); // Add own last-field state
    01459         }
    01460
    01461         cur_row = this->d.sub.page->Draw(settings_ptr, left, right, base_y, first_row, max_row, selected, cur_row, parent_last);
    01462       }
    01463       break;
    01464     default: NOT_REACHED();
    01465   }
    01466   return cur_row;
    01467 }
    01468
    01469 static const void *ResolveVariableAddress(const GameSettings *settings_ptr, const SettingDesc *sd)
    01470 {
    01471   if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
    01472     if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
    01473       return GetVariableAddress(&Company::Get(_local_company)->settings, &sd->save);
    01474     } else {
    01475       return GetVariableAddress(&_settings_client.company, &sd->save);
    01476     }
    01477   } else {
    01478     return GetVariableAddress(settings_ptr, &sd->save);
    01479   }
    01480 }
    01481
    01487 void SettingEntry::SetValueDParams(uint first_param, int32 value)
    01488 {
    01489   assert((this->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
    01490   const SettingDescBase *sdb = &this->d.entry.setting->desc;
    01491   if (sdb->cmd == SDT_BOOLX) {
    01492     SetDParam(first_param++, value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
    01493   } else {
    01494     if ((sdb->flags & SGF_MULTISTRING) != 0) {
    01495       SetDParam(first_param++, sdb->str_val - sdb->min + value);
    01496     } else if ((sdb->flags & SGF_DISPLAY_ABS) != 0) {
    01497       SetDParam(first_param++, sdb->str_val + ((value >= 0) ? 1 : 0));
    01498       value = abs(value);
    01499     } else {
    01500       SetDParam(first_param++, sdb->str_val + ((value == 0 && (sdb->flags & SGF_0ISDISABLED) != 0) ? 1 : 0));
    01501     }
    01502     SetDParam(first_param++, value);
    01503   }
    01504 }
    01505
    01515 void SettingEntry::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, int state, bool highlight)
    01516 {
    01517   const SettingDesc *sd = this->d.entry.setting;
    01518   const SettingDescBase *sdb = &sd->desc;
    01519   const void *var = ResolveVariableAddress(settings_ptr, sd);
    01520   bool editable = true;
    01521
    01522   bool rtl = _current_text_dir == TD_RTL;
    01523   uint buttons_left = rtl ? right + 1 - SETTING_BUTTON_WIDTH : left;
    01524   uint text_left  = left + (rtl ? 0 : SETTING_BUTTON_WIDTH + 5);
    01525   uint text_right = right - (rtl ? SETTING_BUTTON_WIDTH + 5 : 0);
    01526   uint button_y = y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
    01527
    01528   /* We do not allow changes of some items when we are a client in a networkgame */
    01529   if (!(sd->save.conv & SLF_NO_NETWORK_SYNC) && _networking && !_network_server && !(sdb->flags & SGF_PER_COMPANY)) editable = false;
    01530   if ((sdb->flags & SGF_NETWORK_ONLY) && !_networking) editable = false;
    01531   if ((sdb->flags & SGF_NO_NETWORK) && _networking) editable = false;
    01532
    01533   SetDParam(0, highlight ? STR_ORANGE_STRING1_WHITE : STR_ORANGE_STRING1_LTBLUE);
    01534   int32 value = (int32)ReadValue(var, sd->save.conv);
    01535   if (sdb->cmd == SDT_BOOLX) {
    01536     /* Draw checkbox for boolean-value either on/off */
    01537     DrawBoolButton(buttons_left, button_y, value != 0, editable);
    01538   } else if ((sdb->flags & SGF_MULTISTRING) != 0) {
    01539     /* Draw [v] button for settings of an enum-type */
    01540     DrawDropDownButton(buttons_left, button_y, COLOUR_YELLOW, state != 0, editable);
    01541   } else {
    01542     /* Draw [<][>] boxes for settings of an integer-type */
    01543     DrawArrowButtons(buttons_left, button_y, COLOUR_YELLOW, state,
    01544         editable && value != (sdb->flags & SGF_0ISDISABLED ? 0 : sdb->min), editable && (uint32)value != sdb->max);
    01545   }
    01546   this->SetValueDParams(1, value);
    01547   DrawString(text_left, text_right, y, sdb->str, highlight ? TC_WHITE : TC_LIGHT_BLUE);
    01548 }
    01549
    01550
    01551 /* == SettingsPage methods == */
    01552
    01557 void SettingsPage::Init(byte level)
    01558 {
    01559   for (uint field = 0; field < this->num; field++) {
    01560     this->entries[field].Init(level);
    01561   }
    01562 }
    01563
    01565 void SettingsPage::FoldAll()
    01566 {
    01567   for (uint field = 0; field < this->num; field++) {
    01568     this->entries[field].FoldAll();
    01569   }
    01570 }
    01571
    01573 void SettingsPage::UnFoldAll()
    01574 {
    01575   for (uint field = 0; field < this->num; field++) {
    01576     this->entries[field].UnFoldAll();
    01577   }
    01578 }
    01579
    01585 void SettingsPage::GetFoldingState(bool &all_folded, bool &all_unfolded) const
    01586 {
    01587   for (uint field = 0; field < this->num; field++) {
    01588     this->entries[field].GetFoldingState(all_folded, all_unfolded);
    01589   }
    01590 }
    01591
    01599 bool SettingsPage::UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode)
    01600 {
    01601   bool visible = false;
    01602   bool first_visible = true;
    01603   for (int field = this->num - 1; field >= 0; field--) {
    01604     visible |= this->entries[field].UpdateFilterState(filter, force_visible, mode);
    01605     this->entries[field].SetLastField(first_visible);
    01606     if (visible && first_visible) first_visible = false;
    01607   }
    01608   return visible;
    01609 }
    01610
    01611
    01618 bool SettingsPage::IsVisible(const SettingEntry *item) const
    01619 {
    01620   for (uint field = 0; field < this->num; field++) {
    01621     if (this->entries[field].IsVisible(item)) return true;
    01622   }
    01623   return false;
    01624 }
    01625
    01627 uint SettingsPage::Length() const
    01628 {
    01629   uint length = 0;
    01630   for (uint field = 0; field < this->num; field++) {
    01631     length += this->entries[field].Length();
    01632   }
    01633   return length;
    01634 }
    01635
    01642 SettingEntry *SettingsPage::FindEntry(uint row_num, uint *cur_row) const
    01643 {
    01644   SettingEntry *pe = NULL;
    01645
    01646   for (uint field = 0; field < this->num; field++) {
    01647     pe = this->entries[field].FindEntry(row_num, cur_row);
    01648     if (pe != NULL) {
    01649       break;
    01650     }
    01651   }
    01652   return pe;
    01653 }
    01654
    01660 uint SettingsPage::GetMaxHelpHeight(int maxw)
    01661 {
    01662   uint biggest = 0;
    01663   for (uint field = 0; field < this->num; field++) {
    01664     biggest = max(biggest, this->entries[field].GetMaxHelpHeight(maxw));
    01665   }
    01666   return biggest;
    01667 }
    01668
    01687 uint SettingsPage::Draw(GameSettings *settings_ptr, int left, int right, int base_y, uint first_row, uint max_row, SettingEntry *selected, uint cur_row, uint parent_last) const
    01688 {
    01689   if (cur_row >= max_row) return cur_row;
    01690
    01691   for (uint i = 0; i < this->num; i++) {
    01692     cur_row = this->entries[i].Draw(settings_ptr, left, right, base_y, first_row, max_row, cur_row, parent_last, selected);
    01693     if (cur_row >= max_row) {
    01694       break;
    01695     }
    01696   }
    01697   return cur_row;
    01698 }
    01699
    01700
    01701 static SettingEntry _settings_ui_display[] = {
    01702   SettingEntry("gui.date_format_in_default_names"),
    01703   SettingEntry("gui.population_in_label"),
    01704   SettingEntry("gui.measure_tooltip"),
    01705   SettingEntry("gui.loading_indicators"),
    01706   SettingEntry("gui.liveries"),
    01707   SettingEntry("gui.show_track_reservation"),
    01708   SettingEntry("gui.expenses_layout"),
    01709   SettingEntry("gui.smallmap_land_colour"),
    01710   SettingEntry("gui.zoom_min"),
    01711   SettingEntry("gui.zoom_max"),
    01712   SettingEntry("gui.graph_line_thickness"),
    01713 };
    01715 static SettingsPage _settings_ui_display_page = {_settings_ui_display, lengthof(_settings_ui_display)};
    01716
    01717 static SettingEntry _settings_ui_interaction[] = {
    01718   SettingEntry("gui.window_snap_radius"),
    01719   SettingEntry("gui.window_soft_limit"),
    01720   SettingEntry("gui.link_terraform_toolbar"),
    01721   SettingEntry("gui.prefer_teamchat"),
    01722   SettingEntry("gui.auto_scrolling"),
    01723   SettingEntry("gui.reverse_scroll"),
    01724   SettingEntry("gui.smooth_scroll"),
    01725   SettingEntry("gui.left_mouse_btn_scrolling"),
    01726   /* While the horizontal scrollwheel scrolling is written as general code, only
    01727    *  the cocoa (OSX) driver generates input for it.
    01728    *  Since it's also able to completely disable the scrollwheel will we display it on all platforms anyway */
    01729   SettingEntry("gui.scrollwheel_scrolling"),
    01730   SettingEntry("gui.scrollwheel_multiplier"),
    01731 #ifdef __APPLE__
    01732   /* We might need to emulate a right mouse button on mac */
    01733   SettingEntry("gui.right_mouse_btn_emulation"),
    01734 #endif
    01735 };
    01737 static SettingsPage _settings_ui_interaction_page = {_settings_ui_interaction, lengthof(_settings_ui_interaction)};
    01738
    01739 static SettingEntry _settings_ui[] = {
    01740   SettingEntry(&_settings_ui_display_page, STR_CONFIG_SETTING_DISPLAY_OPTIONS),
    01741   SettingEntry(&_settings_ui_interaction_page, STR_CONFIG_SETTING_INTERACTION),
    01742   SettingEntry("gui.show_finances"),
    01743   SettingEntry("gui.errmsg_duration"),
    01744   SettingEntry("gui.hover_delay"),
    01745   SettingEntry("gui.toolbar_pos"),
    01746   SettingEntry("gui.statusbar_pos"),
    01747   SettingEntry("gui.newgrf_default_palette"),
    01748   SettingEntry("gui.pause_on_newgame"),
    01749   SettingEntry("gui.advanced_vehicle_list"),
    01750   SettingEntry("gui.timetable_in_ticks"),
    01751   SettingEntry("gui.timetable_arrival_departure"),
    01752   SettingEntry("gui.quick_goto"),
    01753   SettingEntry("gui.default_rail_type"),
    01754   SettingEntry("gui.disable_unsuitable_building"),
    01755   SettingEntry("gui.persistent_buildingtools"),
    01756   SettingEntry("gui.coloured_news_year"),
    01757 };
    01759 static SettingsPage _settings_ui_page = {_settings_ui, lengthof(_settings_ui)};
    01760
    01761 static SettingEntry _settings_construction_signals[] = {
    01762   SettingEntry("construction.train_signal_side"),
    01763   SettingEntry("gui.enable_signal_gui"),
    01764   SettingEntry("gui.drag_signals_fixed_distance"),
    01765   SettingEntry("gui.semaphore_build_before"),
    01766   SettingEntry("gui.default_signal_type"),
    01767   SettingEntry("gui.cycle_signal_types"),
    01768 };
    01770 static SettingsPage _settings_construction_signals_page = {_settings_construction_signals, lengthof(_settings_construction_signals)};
    01771
    01772 static SettingEntry _settings_construction[] = {
    01773   SettingEntry(&_settings_construction_signals_page, STR_CONFIG_SETTING_CONSTRUCTION_SIGNALS),
    01774   SettingEntry("construction.build_on_slopes"),
    01775   SettingEntry("construction.autoslope"),
    01776   SettingEntry("construction.extra_dynamite"),
    01777   SettingEntry("construction.max_bridge_length"),
    01778   SettingEntry("construction.max_tunnel_length"),
    01779   SettingEntry("station.never_expire_airports"),
    01780   SettingEntry("construction.freeform_edges"),
    01781   SettingEntry("construction.extra_tree_placement"),
    01782   SettingEntry("construction.command_pause_level"),
    01783 };
    01785 static SettingsPage _settings_construction_page = {_settings_construction, lengthof(_settings_construction)};
    01786
    01787 static SettingEntry _settings_stations_cargo[] = {
    01788   SettingEntry("order.improved_load"),
    01789   SettingEntry("order.gradual_loading"),
    01790   SettingEntry("order.selectgoods"),
    01791 };
    01793 static SettingsPage _settings_stations_cargo_page = {_settings_stations_cargo, lengthof(_settings_stations_cargo)};
    01794
    01795 static SettingEntry _settings_stations[] = {
    01796   SettingEntry(&_settings_stations_cargo_page, STR_CONFIG_SETTING_STATIONS_CARGOHANDLING),
    01797   SettingEntry("station.adjacent_stations"),
    01798   SettingEntry("station.distant_join_stations"),
    01799   SettingEntry("station.station_spread"),
    01800   SettingEntry("economy.station_noise_level"),
    01801   SettingEntry("station.modified_catchment"),
    01802   SettingEntry("construction.road_stop_on_town_road"),
    01803   SettingEntry("construction.road_stop_on_competitor_road"),
    01804 };
    01806 static SettingsPage _settings_stations_page = {_settings_stations, lengthof(_settings_stations)};
    01807
    01808 static SettingEntry _settings_economy_towns[] = {
    01809   SettingEntry("economy.bribe"),
    01810   SettingEntry("economy.exclusive_rights"),
    01811   SettingEntry("economy.fund_roads"),
    01812   SettingEntry("economy.fund_buildings"),
    01813   SettingEntry("economy.town_layout"),
    01814   SettingEntry("economy.allow_town_roads"),
    01815   SettingEntry("economy.allow_town_level_crossings"),
    01816   SettingEntry("economy.found_town"),
    01817   SettingEntry("economy.mod_road_rebuild"),
    01818   SettingEntry("economy.town_growth_rate"),
    01819   SettingEntry("economy.larger_towns"),
    01820   SettingEntry("economy.initial_city_size"),
    01821 };
    01823 static SettingsPage _settings_economy_towns_page = {_settings_economy_towns, lengthof(_settings_economy_towns)};
    01824
    01825 static SettingEntry _settings_economy_industries[] = {
    01826   SettingEntry("construction.raw_industry_construction"),
    01827   SettingEntry("construction.industry_platform"),
    01828   SettingEntry("economy.multiple_industry_per_town"),
    01829   SettingEntry("game_creation.oil_refinery_limit"),
    01830 };
    01832 static SettingsPage _settings_economy_industries_page = {_settings_economy_industries, lengthof(_settings_economy_industries)};
    01833
    01834 static SettingEntry _settings_economy_scripts[] = {
    01835   SettingEntry("script.script_max_opcode_till_suspend"),
    01836 };
    01838 static SettingsPage _settings_economy_scripts_page = {_settings_economy_scripts, lengthof(_settings_economy_scripts)};
    01839
    01840 static SettingEntry _settings_economy[] = {
    01841   SettingEntry(&_settings_economy_towns_page, STR_CONFIG_SETTING_ECONOMY_TOWNS),
    01842   SettingEntry(&_settings_economy_industries_page, STR_CONFIG_SETTING_ECONOMY_INDUSTRIES),
    01843   SettingEntry(&_settings_economy_scripts_page, STR_CONFIG_SETTING_ECONOMY_SCRIPTS),
    01844   SettingEntry("economy.inflation"),
    01845   SettingEntry("economy.smooth_economy"),
    01846   SettingEntry("economy.feeder_payment_share"),
    01847   SettingEntry("economy.infrastructure_maintenance"),
    01848 };
    01850 static SettingsPage _settings_economy_page = {_settings_economy, lengthof(_settings_economy)};
    01851
    01852 static SettingEntry _settings_linkgraph[] = {
    01853   SettingEntry("linkgraph.recalc_interval"),
    01854   SettingEntry("linkgraph.distribution_pax"),
    01855   SettingEntry("linkgraph.distribution_mail"),
    01856   SettingEntry("linkgraph.distribution_armoured"),
    01857   SettingEntry("linkgraph.distribution_default"),
    01858   SettingEntry("linkgraph.accuracy"),
    01859   SettingEntry("linkgraph.demand_distance"),
    01860   SettingEntry("linkgraph.demand_size"),
    01861   SettingEntry("linkgraph.short_path_saturation"),
    01862 };
    01864 static SettingsPage _settings_linkgraph_page = {_settings_linkgraph, lengthof(_settings_linkgraph)};
    01865
    01866 static SettingEntry _settings_ai_npc[] = {
    01867   SettingEntry("ai.ai_in_multiplayer"),
    01868   SettingEntry("ai.ai_disable_veh_train"),
    01869   SettingEntry("ai.ai_disable_veh_roadveh"),
    01870   SettingEntry("ai.ai_disable_veh_aircraft"),
    01871   SettingEntry("ai.ai_disable_veh_ship"),
    01872 };
    01874 static SettingsPage _settings_ai_npc_page = {_settings_ai_npc, lengthof(_settings_ai_npc)};
    01875
    01876 static SettingEntry _settings_ai[] = {
    01877   SettingEntry(&_settings_ai_npc_page, STR_CONFIG_SETTING_AI_NPC),
    01878   SettingEntry("economy.give_money"),
    01879   SettingEntry("economy.allow_shares"),
    01880 };
    01882 static SettingsPage _settings_ai_page = {_settings_ai, lengthof(_settings_ai)};
    01883
    01884 static SettingEntry _settings_vehicles_routing[] = {
    01885   SettingEntry("pf.pathfinder_for_trains"),
    01886   SettingEntry("pf.forbid_90_deg"),
    01887   SettingEntry("pf.pathfinder_for_roadvehs"),
    01888   SettingEntry("pf.roadveh_queue"),
    01889   SettingEntry("pf.pathfinder_for_ships"),
    01890 };
    01892 static SettingsPage _settings_vehicles_routing_page = {_settings_vehicles_routing, lengthof(_settings_vehicles_routing)};
    01893
    01894 static SettingEntry _settings_vehicles_autorenew[] = {
    01895   SettingEntry("company.engine_renew"),
    01896   SettingEntry("company.engine_renew_months"),
    01897   SettingEntry("company.engine_renew_money"),
    01898 };
    01900 static SettingsPage _settings_vehicles_autorenew_page = {_settings_vehicles_autorenew, lengthof(_settings_vehicles_autorenew)};
    01901
    01902 static SettingEntry _settings_vehicles_servicing[] = {
    01903   SettingEntry("vehicle.servint_ispercent"),
    01904   SettingEntry("vehicle.servint_trains"),
    01905   SettingEntry("vehicle.servint_roadveh"),
    01906   SettingEntry("vehicle.servint_ships"),
    01907   SettingEntry("vehicle.servint_aircraft"),
    01908   SettingEntry("order.no_servicing_if_no_breakdowns"),
    01909   SettingEntry("order.serviceathelipad"),
    01910 };
    01912 static SettingsPage _settings_vehicles_servicing_page = {_settings_vehicles_servicing, lengthof(_settings_vehicles_servicing)};
    01913
    01914 static SettingEntry _settings_vehicles_trains[] = {
    01915   SettingEntry("pf.reverse_at_signals"),
    01916   SettingEntry("vehicle.train_acceleration_model"),
    01917   SettingEntry("vehicle.train_slope_steepness"),
    01918   SettingEntry("vehicle.max_train_length"),
    01919   SettingEntry("vehicle.wagon_speed_limits"),
    01920   SettingEntry("vehicle.disable_elrails"),
    01921   SettingEntry("vehicle.freight_trains"),
    01922   SettingEntry("gui.stop_location"),
    01923 };
    01925 static SettingsPage _settings_vehicles_trains_page = {_settings_vehicles_trains, lengthof(_settings_vehicles_trains)};
    01926
    01927 static SettingEntry _settings_vehicles[] = {
    01928   SettingEntry(&_settings_vehicles_routing_page, STR_CONFIG_SETTING_VEHICLES_ROUTING),
    01929   SettingEntry(&_settings_vehicles_autorenew_page, STR_CONFIG_SETTING_VEHICLES_AUTORENEW),
    01930   SettingEntry(&_settings_vehicles_servicing_page, STR_CONFIG_SETTING_VEHICLES_SERVICING),
    01931   SettingEntry(&_settings_vehicles_trains_page, STR_CONFIG_SETTING_VEHICLES_TRAINS),
    01932   SettingEntry("gui.new_nonstop"),
    01933   SettingEntry("gui.order_review_system"),
    01934   SettingEntry("gui.vehicle_income_warn"),
    01935   SettingEntry("gui.lost_vehicle_warn"),
    01936   SettingEntry("vehicle.never_expire_vehicles"),
    01937   SettingEntry("vehicle.max_trains"),
    01938   SettingEntry("vehicle.max_roadveh"),
    01939   SettingEntry("vehicle.max_aircraft"),
    01940   SettingEntry("vehicle.max_ships"),
    01941   SettingEntry("vehicle.plane_speed"),
    01942   SettingEntry("vehicle.plane_crashes"),
    01943   SettingEntry("vehicle.dynamic_engines"),
    01944   SettingEntry("vehicle.roadveh_acceleration_model"),
    01945   SettingEntry("vehicle.roadveh_slope_steepness"),
    01946   SettingEntry("vehicle.smoke_amount"),
    01947 };
    01949 static SettingsPage _settings_vehicles_page = {_settings_vehicles, lengthof(_settings_vehicles)};
    01950
    01951 static SettingEntry _settings_main[] = {
    01952   SettingEntry(&_settings_ui_page,           STR_CONFIG_SETTING_GUI),
    01953   SettingEntry(&_settings_construction_page, STR_CONFIG_SETTING_CONSTRUCTION),
    01954   SettingEntry(&_settings_vehicles_page,     STR_CONFIG_SETTING_VEHICLES),
    01955   SettingEntry(&_settings_stations_page,     STR_CONFIG_SETTING_STATIONS),
    01956   SettingEntry(&_settings_economy_page,      STR_CONFIG_SETTING_ECONOMY),
    01957   SettingEntry(&_settings_linkgraph_page,    STR_CONFIG_SETTING_LINKGRAPH),
    01958   SettingEntry(&_settings_ai_page,           STR_CONFIG_SETTING_AI),
    01959 };
    01960
    01962 static SettingsPage _settings_main_page = {_settings_main, lengthof(_settings_main)};
    01963
    01964 static const StringID _game_settings_restrict_dropdown[] = {
    01965   STR_CONFIG_SETTING_RESTRICT_BASIC,                            // RM_BASIC
    01966   STR_CONFIG_SETTING_RESTRICT_ADVANCED,                         // RM_ADVANCED
    01967   STR_CONFIG_SETTING_RESTRICT_ALL,                              // RM_ALL
    01968   STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT,          // RM_CHANGED_AGAINST_DEFAULT
    01969   STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT_WO_LOCAL, // RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL
    01970   STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW,              // RM_CHANGED_AGAINST_NEW
    01971 };
    01972 assert_compile(lengthof(_game_settings_restrict_dropdown) == RM_END);
    01973
    01974 struct GameSettingsWindow : Window {
    01975   static const int SETTINGTREE_LEFT_OFFSET   = 5;
    01976   static const int SETTINGTREE_RIGHT_OFFSET  = 5;
    01977   static const int SETTINGTREE_TOP_OFFSET    = 5;
    01978   static const int SETTINGTREE_BOTTOM_OFFSET = 5;
    01979
    01980   static GameSettings *settings_ptr;
    01981
    01982   SettingEntry *valuewindow_entry;
    01983   SettingEntry *clicked_entry;
    01984   SettingEntry *last_clicked;
    01985   SettingEntry *valuedropdown_entry;
    01986   bool closing_dropdown;
    01987
    01988   StringFilter string_filter;
    01989   QueryString filter_editbox;
    01990   bool manually_changed_folding;
    01991
    01992   RestrictionMode cur_restriction_mode;
    01993
    01994   Scrollbar *vscroll;
    01995
    01996   GameSettingsWindow(const WindowDesc *desc) : filter_editbox(50), cur_restriction_mode((RestrictionMode)_settings_client.gui.settings_restriction_mode)
    01997   {
    01998     static bool first_time = true;
    01999
    02000     settings_ptr = &GetGameSettings();
    02001
    02002     /* Build up the dynamic settings-array only once per OpenTTD session */
    02003     if (first_time) {
    02004       _settings_main_page.Init();
    02005       first_time = false;
    02006     } else {
    02007       _settings_main_page.FoldAll(); // Close all sub-pages
    02008     }
    02009
    02010     this->valuewindow_entry = NULL; // No setting entry for which a entry window is opened
    02011     this->clicked_entry = NULL; // No numeric setting buttons are depressed
    02012     this->last_clicked = NULL;
    02013     this->valuedropdown_entry = NULL;
    02014     this->closing_dropdown = false;
    02015     this->manually_changed_folding = false;
    02016
    02017     this->CreateNestedTree(desc);
    02018     this->vscroll = this->GetScrollbar(WID_GS_SCROLLBAR);
    02019     this->FinishInitNested(desc, WN_GAME_OPTIONS_GAME_SETTINGS);
    02020
    02021     this->querystrings[WID_GS_FILTER] = &this->filter_editbox;
    02022     this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
    02023     this->SetFocusedWidget(WID_GS_FILTER);
    02024
    02025     this->InvalidateData();
    02026   }
    02027
    02028   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    02029   {
    02030     switch (widget) {
    02031       case WID_GS_OPTIONSPANEL:
    02032         resize->height = SETTING_HEIGHT = max(11, FONT_HEIGHT_NORMAL + 1);
    02033         resize->width  = 1;
    02034
    02035         size->height = 5 * resize->height + SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET;
    02036         break;
    02037
    02038       case WID_GS_HELP_TEXT: {
    02039         static const StringID setting_types[] = {
    02040           STR_CONFIG_SETTING_TYPE_CLIENT,
    02041           STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
    02042           STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
    02043         };
    02044         for (uint i = 0; i < lengthof(setting_types); i++) {
    02045           SetDParam(0, setting_types[i]);
    02046           size->width = max(size->width, GetStringBoundingBox(STR_CONFIG_SETTING_TYPE).width);
    02047         }
    02048         size->height = 2 * FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL +
    02049             max(size->height, _settings_main_page.GetMaxHelpHeight(size->width));
    02050         break;
    02051       }
    02052
    02053       default:
    02054         break;
    02055     }
    02056   }
    02057
    02058   virtual void OnPaint()
    02059   {
    02060     if (this->closing_dropdown) {
    02061       this->closing_dropdown = false;
    02062       assert(this->valuedropdown_entry != NULL);
    02063       this->valuedropdown_entry->SetButtons(0);
    02064       this->valuedropdown_entry = NULL;
    02065     }
    02066     this->DrawWidgets();
    02067   }
    02068
    02069   virtual void SetStringParameters(int widget) const
    02070   {
    02071     switch (widget) {
    02072       case WID_GS_RESTRICT_DROPDOWN:
    02073         SetDParam(0, _game_settings_restrict_dropdown[this->cur_restriction_mode]);
    02074         break;
    02075     }
    02076   }
    02077
    02078   DropDownList *BuildDropDownList(int widget) const
    02079   {
    02080     DropDownList *list = NULL;
    02081     switch (widget) {
    02082       case WID_GS_RESTRICT_DROPDOWN:
    02083         list = new DropDownList();
    02084
    02085         for (int mode = 0; mode != RM_END; mode++) {
    02086           /* If we are in adv. settings screen for the new game's settings,
    02087            * we don't want to allow comparing with new game's settings. */
    02088           bool disabled = mode == RM_CHANGED_AGAINST_NEW && settings_ptr == &_settings_newgame;
    02089
    02090           list->push_back(new DropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
    02091         }
    02092         break;
    02093     }
    02094     return list;
    02095   }
    02096
    02097   virtual void DrawWidget(const Rect &r, int widget) const
    02098   {
    02099     switch (widget) {
    02100       case WID_GS_OPTIONSPANEL:
    02101         _settings_main_page.Draw(settings_ptr, r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, r.top + SETTINGTREE_TOP_OFFSET,
    02102             this->vscroll->GetPosition(), this->vscroll->GetPosition() + this->vscroll->GetCapacity(), this->last_clicked);
    02103         break;
    02104
    02105       case WID_GS_HELP_TEXT:
    02106         if (this->last_clicked != NULL) {
    02107           const SettingDesc *sd = this->last_clicked->d.entry.setting;
    02108
    02109           int y = r.top;
    02110           if (sd->desc.flags & SGF_PER_COMPANY) {
    02111             SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME);
    02112           } else if (sd->save.conv & SLF_NOT_IN_SAVE) {
    02113             SetDParam(0, STR_CONFIG_SETTING_TYPE_CLIENT);
    02114           } else {
    02115             SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME);
    02116           }
    02117           DrawString(r.left, r.right, y, STR_CONFIG_SETTING_TYPE);
    02118           y += FONT_HEIGHT_NORMAL;
    02119
    02120           int32 default_value = ReadValue(&sd->desc.def, sd->save.conv);
    02121           this->last_clicked->SetValueDParams(0, default_value);
    02122           DrawString(r.left, r.right, y, STR_CONFIG_SETTING_DEFAULT_VALUE);
    02123           y += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
    02124
    02125           DrawStringMultiLine(r.left, r.right, y, r.bottom, this->last_clicked->GetHelpText(), TC_WHITE);
    02126         }
    02127         break;
    02128
    02129       default:
    02130         break;
    02131     }
    02132   }
    02133
    02138   void SetDisplayedHelpText(SettingEntry *pe)
    02139   {
    02140     if (this->last_clicked != pe) this->SetDirty();
    02141     this->last_clicked = pe;
    02142   }
    02143
    02144   virtual void OnClick(Point pt, int widget, int click_count)
    02145   {
    02146     switch (widget) {
    02147       case WID_GS_EXPAND_ALL:
    02148         this->manually_changed_folding = true;
    02149         _settings_main_page.UnFoldAll();
    02150         this->InvalidateData();
    02151         break;
    02152
    02153       case WID_GS_COLLAPSE_ALL:
    02154         this->manually_changed_folding = true;
    02155         _settings_main_page.FoldAll();
    02156         this->InvalidateData();
    02157         break;
    02158
    02159       case WID_GS_RESTRICT_DROPDOWN: {
    02160         DropDownList *list = this->BuildDropDownList(widget);
    02161         if (list != NULL) {
    02162           ShowDropDownList(this, list, this->cur_restriction_mode, widget);
    02163         }
    02164       }
    02165     }
    02166
    02167     if (widget != WID_GS_OPTIONSPANEL) return;
    02168
    02169     uint btn = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GS_OPTIONSPANEL, SETTINGTREE_TOP_OFFSET);
    02170     if (btn == INT_MAX) return;
    02171
    02172     uint cur_row = 0;
    02173     SettingEntry *pe = _settings_main_page.FindEntry(btn, &cur_row);
    02174
    02175     if (pe == NULL) return;  // Clicked below the last setting of the page
    02176
    02177     int x = (_current_text_dir == TD_RTL ? this->width - 1 - pt.x : pt.x) - SETTINGTREE_LEFT_OFFSET - (pe->level + 1) * LEVEL_WIDTH;  // Shift x coordinate
    02178     if (x < 0) return;  // Clicked left of the entry
    02179
    02180     if ((pe->flags & SEF_KIND_MASK) == SEF_SUBTREE_KIND) {
    02181       this->SetDisplayedHelpText(NULL);
    02182       pe->d.sub.folded = !pe->d.sub.folded; // Flip 'folded'-ness of the sub-page
    02183
    02184       this->manually_changed_folding = true;
    02185
    02186       this->InvalidateData();
    02187       return;
    02188     }
    02189
    02190     assert((pe->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
    02191     const SettingDesc *sd = pe->d.entry.setting;
    02192
    02193     /* return if action is only active in network, or only settable by server */
    02194     if ((!(sd->save.conv & SLF_NO_NETWORK_SYNC) && _networking && !_network_server && !(sd->desc.flags & SGF_PER_COMPANY)) ||
    02195         ((sd->desc.flags & SGF_NETWORK_ONLY) && !_networking) || ((sd->desc.flags & SGF_NO_NETWORK) && _networking)) {
    02196       this->SetDisplayedHelpText(pe);
    02197       return;
    02198     }
    02199
    02200     const void *var = ResolveVariableAddress(settings_ptr, sd);
    02201     int32 value = (int32)ReadValue(var, sd->save.conv);
    02202
    02203     /* clicked on the icon on the left side. Either scroller, bool on/off or dropdown */
    02204     if (x < SETTING_BUTTON_WIDTH && (sd->desc.flags & SGF_MULTISTRING)) {
    02205       const SettingDescBase *sdb = &sd->desc;
    02206       this->SetDisplayedHelpText(pe);
    02207
    02208       if (this->valuedropdown_entry == pe) {
    02209         /* unclick the dropdown */
    02210         HideDropDownMenu(this);
    02211         this->closing_dropdown = false;
    02212         this->valuedropdown_entry->SetButtons(0);
    02213         this->valuedropdown_entry = NULL;
    02214       } else {
    02215         if (this->valuedropdown_entry != NULL) this->valuedropdown_entry->SetButtons(0);
    02216         this->closing_dropdown = false;
    02217
    02218         const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GS_OPTIONSPANEL);
    02219         int rel_y = (pt.y - (int)wid->pos_y - SETTINGTREE_TOP_OFFSET) % wid->resize_y;
    02220
    02221         Rect wi_rect;
    02222         wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
    02223         wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
    02224         wi_rect.top = pt.y - rel_y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
    02225         wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
    02226
    02227         /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
    02228         if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
    02229           this->valuedropdown_entry = pe;
    02230           this->valuedropdown_entry->SetButtons(SEF_LEFT_DEPRESSED);
    02231
    02232           DropDownList *list = new DropDownList();
    02233           for (int i = sdb->min; i <= (int)sdb->max; i++) {
    02234             list->push_back(new DropDownListStringItem(sdb->str_val + i - sdb->min, i, false));
    02235           }
    02236
    02237           ShowDropDownListAt(this, list, value, -1, wi_rect, COLOUR_ORANGE, true);
    02238         }
    02239       }
    02240       this->SetDirty();
    02241     } else if (x < SETTING_BUTTON_WIDTH) {
    02242       this->SetDisplayedHelpText(pe);
    02243       const SettingDescBase *sdb = &sd->desc;
    02244       int32 oldvalue = value;
    02245
    02246       switch (sdb->cmd) {
    02247         case SDT_BOOLX: value ^= 1; break;
    02248         case SDT_ONEOFMANY:
    02249         case SDT_NUMX: {
    02250           /* Add a dynamic step-size to the scroller. In a maximum of
    02251            * 50-steps you should be able to get from min to max,
    02252            * unless specified otherwise in the 'interval' variable
    02253            * of the current setting. */
    02254           uint32 step = (sdb->interval == 0) ? ((sdb->max - sdb->min) / 50) : sdb->interval;
    02255           if (step == 0) step = 1;
    02256
    02257           /* don't allow too fast scrolling */
    02258           if ((this->flags & WF_TIMEOUT) && this->timeout_timer > 1) {
    02259             _left_button_clicked = false;
    02260             return;
    02261           }
    02262
    02263           /* Increase or decrease the value and clamp it to extremes */
    02264           if (x >= SETTING_BUTTON_WIDTH / 2) {
    02265             value += step;
    02266             if (sdb->min < 0) {
    02267               assert((int32)sdb->max >= 0);
    02268               if (value > (int32)sdb->max) value = (int32)sdb->max;
    02269             } else {
    02270               if ((uint32)value > sdb->max) value = (int32)sdb->max;
    02271             }
    02272             if (value < sdb->min) value = sdb->min; // skip between "disabled" and minimum
    02273           } else {
    02274             value -= step;
    02275             if (value < sdb->min) value = (sdb->flags & SGF_0ISDISABLED) ? 0 : sdb->min;
    02276           }
    02277
    02278           /* Set up scroller timeout for numeric values */
    02279           if (value != oldvalue) {
    02280             if (this->clicked_entry != NULL) { // Release previous buttons if any
    02281               this->clicked_entry->SetButtons(0);
    02282             }
    02283             this->clicked_entry = pe;
    02284             this->clicked_entry->SetButtons((x >= SETTING_BUTTON_WIDTH / 2) != (_current_text_dir == TD_RTL) ? SEF_RIGHT_DEPRESSED : SEF_LEFT_DEPRESSED);
    02285             this->SetTimeout();
    02286             _left_button_clicked = false;
    02287           }
    02288           break;
    02289         }
    02290
    02291         default: NOT_REACHED();
    02292       }
    02293
    02294       if (value != oldvalue) {
    02295         if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
    02296           SetCompanySetting(pe->d.entry.index, value);
    02297         } else {
    02298           SetSettingValue(pe->d.entry.index, value);
    02299         }
    02300         this->SetDirty();
    02301       }
    02302     } else {
    02303       /* Only open editbox if clicked for the second time, and only for types where it is sensible for. */
    02304       if (this->last_clicked == pe && sd->desc.cmd != SDT_BOOLX && !(sd->desc.flags & SGF_MULTISTRING)) {
    02305         /* Show the correct currency-translated value */
    02306         if (sd->desc.flags & SGF_CURRENCY) value *= _currency->rate;
    02307
    02308         this->valuewindow_entry = pe;
    02309         SetDParam(0, value);
    02310         ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 10, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
    02311       }
    02312       this->SetDisplayedHelpText(pe);
    02313     }
    02314   }
    02315
    02316   virtual void OnTimeout()
    02317   {
    02318     if (this->clicked_entry != NULL) { // On timeout, release any depressed buttons
    02319       this->clicked_entry->SetButtons(0);
    02320       this->clicked_entry = NULL;
    02321       this->SetDirty();
    02322     }
    02323   }
    02324
    02325   virtual void OnQueryTextFinished(char *str)
    02326   {
    02327     /* The user pressed cancel */
    02328     if (str == NULL) return;
    02329
    02330     assert(this->valuewindow_entry != NULL);
    02331     assert((this->valuewindow_entry->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
    02332     const SettingDesc *sd = this->valuewindow_entry->d.entry.setting;
    02333
    02334     int32 value;
    02335     if (!StrEmpty(str)) {
    02336       value = atoi(str);
    02337
    02338       /* Save the correct currency-translated value */
    02339       if (sd->desc.flags & SGF_CURRENCY) value /= _currency->rate;
    02340     } else {
    02341       value = (int32)(size_t)sd->desc.def;
    02342     }
    02343
    02344     if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
    02345       SetCompanySetting(this->valuewindow_entry->d.entry.index, value);
    02346     } else {
    02347       SetSettingValue(this->valuewindow_entry->d.entry.index, value);
    02348     }
    02349     this->SetDirty();
    02350   }
    02351
    02352   virtual void OnDropdownSelect(int widget, int index)
    02353   {
    02354     if (widget == WID_GS_RESTRICT_DROPDOWN) {
    02355       this->cur_restriction_mode = (RestrictionMode)index;
    02356       if (this->cur_restriction_mode == RM_CHANGED_AGAINST_DEFAULT ||
    02357           this->cur_restriction_mode == RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL ||
    02358           this->cur_restriction_mode == RM_CHANGED_AGAINST_NEW) {
    02359
    02360         if (!this->manually_changed_folding) {
    02361           /* Expand all when selecting 'changes'. Update the filter state first, in case it becomes less restrictive in some cases. */
    02362           _settings_main_page.UpdateFilterState(string_filter, false, this->cur_restriction_mode);
    02363           _settings_main_page.UnFoldAll();
    02364         }
    02365       } else {
    02366         /* Non-'changes' filter. Save as default. */
    02367         _settings_client.gui.settings_restriction_mode = this->cur_restriction_mode;
    02368       }
    02369       this->InvalidateData();
    02370       return;
    02371     }
    02372
    02373     /* Deal with drop down boxes on the panel. */
    02374     assert(this->valuedropdown_entry != NULL);
    02375     const SettingDesc *sd = this->valuedropdown_entry->d.entry.setting;
    02376     assert(sd->desc.flags & SGF_MULTISTRING);
    02377
    02378     if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
    02379       SetCompanySetting(this->valuedropdown_entry->d.entry.index, index);
    02380     } else {
    02381       SetSettingValue(this->valuedropdown_entry->d.entry.index, index);
    02382     }
    02383
    02384     this->SetDirty();
    02385   }
    02386
    02387   virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
    02388   {
    02389     if (widget == WID_GS_RESTRICT_DROPDOWN) {
    02390       /* Normally the default implementation of OnDropdownClose() takes care of
    02391        * a few things. We want that behaviour here too, but only for this one
    02392        * "normal" dropdown box. The special dropdown boxes added for every
    02393        * setting that needs one can't have this call. */
    02394       Window::OnDropdownClose(pt, widget, index, instant_close);
    02395       return;
    02396     }
    02397
    02398     /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
    02399      * the same dropdown button was clicked again, and then not open the dropdown again.
    02400      * So, we only remember that it was closed, and process it on the next OnPaint, which is
    02401      * after OnClick. */
    02402     assert(this->valuedropdown_entry != NULL);
    02403     this->closing_dropdown = true;
    02404     this->SetDirty();
    02405   }
    02406
    02407   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
    02408   {
    02409     if (!gui_scope) return;
    02410
    02411     _settings_main_page.UpdateFilterState(string_filter, false, this->cur_restriction_mode);
    02412
    02413     this->vscroll->SetCount(_settings_main_page.Length());
    02414
    02415     if (this->last_clicked != NULL && !_settings_main_page.IsVisible(this->last_clicked)) {
    02416       this->SetDisplayedHelpText(NULL);
    02417     }
    02418
    02419     bool all_folded = true;
    02420     bool all_unfolded = true;
    02421     _settings_main_page.GetFoldingState(all_folded, all_unfolded);
    02422     this->SetWidgetDisabledState(WID_GS_EXPAND_ALL, all_unfolded);
    02423     this->SetWidgetDisabledState(WID_GS_COLLAPSE_ALL, all_folded);
    02424   }
    02425
    02426   virtual void OnEditboxChanged(int wid)
    02427   {
    02428     if (wid == WID_GS_FILTER) {
    02429       string_filter.SetFilterTerm(this->filter_editbox.text.buf);
    02430       if (!string_filter.IsEmpty() && !this->manually_changed_folding) {
    02431         /* User never expanded/collapsed single pages and entered a filter term.
    02432          * Expand everything, to save weird expand clicks, */
    02433         _settings_main_page.UnFoldAll();
    02434       }
    02435       this->InvalidateData();
    02436     }
    02437   }
    02438
    02439   virtual void OnResize()
    02440   {
    02441     this->vscroll->SetCapacityFromWidget(this, WID_GS_OPTIONSPANEL, SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET);
    02442   }
    02443 };
    02444
    02445 GameSettings *GameSettingsWindow::settings_ptr = NULL;
    02446
    02447 static const NWidgetPart _nested_settings_selection_widgets[] = {
    02448   NWidget(NWID_HORIZONTAL),
    02449     NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
    02450     NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_CONFIG_SETTING_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    02451   EndContainer(),
    02452   NWidget(WWT_PANEL, COLOUR_MAUVE),
    02453     NWidget(NWID_HORIZONTAL), SetPadding(WD_TEXTPANEL_TOP, 0, WD_TEXTPANEL_BOTTOM, 0),
    02454         SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_RIGHT),
    02455       NWidget(WWT_TEXT, COLOUR_MAUVE, WID_GS_RESTRICT_LABEL), SetDataTip(STR_CONFIG_SETTING_RESTRICT_LABEL, STR_NULL),
    02456       NWidget(WWT_DROPDOWN, COLOUR_MAUVE, WID_GS_RESTRICT_DROPDOWN), SetMinimalSize(100, 12), SetDataTip(STR_BLACK_STRING, STR_CONFIG_SETTING_RESTRICT_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
    02457     EndContainer(),
    02458     NWidget(NWID_HORIZONTAL), SetPadding(0, 0, WD_TEXTPANEL_BOTTOM, 0),
    02459         SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_RIGHT),
    02460       NWidget(WWT_TEXT, COLOUR_MAUVE), SetFill(0, 1), SetDataTip(STR_CONFIG_SETTING_FILTER_TITLE, STR_NULL),
    02461       NWidget(WWT_EDITBOX, COLOUR_MAUVE, WID_GS_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
    02462           SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
    02463     EndContainer(),
    02464   EndContainer(),
    02465   NWidget(NWID_HORIZONTAL),
    02466     NWidget(WWT_PANEL, COLOUR_MAUVE, WID_GS_OPTIONSPANEL), SetMinimalSize(400, 174), SetScrollbar(WID_GS_SCROLLBAR), EndContainer(),
    02467     NWidget(NWID_VERTICAL),
    02468       NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_GS_SCROLLBAR),
    02469     EndContainer(),
    02470   EndContainer(),
    02471   NWidget(WWT_PANEL, COLOUR_MAUVE), SetMinimalSize(400, 40),
    02472     NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GS_HELP_TEXT), SetMinimalSize(300, 25), SetFill(1, 1), SetResize(1, 0),
    02473         SetPadding(WD_FRAMETEXT_TOP, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_BOTTOM, WD_FRAMETEXT_LEFT),
    02474     NWidget(NWID_HORIZONTAL),
    02475       NWidget(WWT_PANEL, COLOUR_MAUVE),
    02476         NWidget(NWID_HORIZONTAL),
    02477           NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_EXPAND_ALL), SetDataTip(STR_CONFIG_SETTING_EXPAND_ALL, STR_NULL),
    02478           NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_COLLAPSE_ALL), SetDataTip(STR_CONFIG_SETTING_COLLAPSE_ALL, STR_NULL),
    02479           NWidget(NWID_SPACER, INVALID_COLOUR), SetFill(1, 1), SetResize(1, 0),
    02480         EndContainer(),
    02481       EndContainer(),
    02482       NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
    02483     EndContainer(),
    02484   EndContainer(),
    02485 };
    02486
    02487 static const WindowDesc _settings_selection_desc(
    02488   WDP_CENTER, 510, 450,
    02489   WC_GAME_OPTIONS, WC_NONE,
    02490   0,
    02491   _nested_settings_selection_widgets, lengthof(_nested_settings_selection_widgets)
    02492 );
    02493
    02495 void ShowGameSettings()
    02496 {
    02497   DeleteWindowByClass(WC_GAME_OPTIONS);
    02498   new GameSettingsWindow(&_settings_selection_desc);
    02499 }
    02500
    02501
    02511 void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
    02512 {
    02513   int colour = _colour_gradient[button_colour][2];
    02514
    02515   DrawFrameRect(x,                            y, x + SETTING_BUTTON_WIDTH / 2 - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, (state == 1) ? FR_LOWERED : FR_NONE);
    02516   DrawFrameRect(x + SETTING_BUTTON_WIDTH / 2, y, x + SETTING_BUTTON_WIDTH     - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, (state == 2) ? FR_LOWERED : FR_NONE);
    02517   DrawSprite(SPR_ARROW_LEFT, PAL_NONE, x + WD_IMGBTN_LEFT, y + WD_IMGBTN_TOP);
    02518   DrawSprite(SPR_ARROW_RIGHT, PAL_NONE, x + WD_IMGBTN_LEFT + SETTING_BUTTON_WIDTH / 2, y + WD_IMGBTN_TOP);
    02519
    02520   /* Grey out the buttons that aren't clickable */
    02521   bool rtl = _current_text_dir == TD_RTL;
    02522   if (rtl ? !clickable_right : !clickable_left) {
    02523     GfxFillRect(x                            + 1, y, x + SETTING_BUTTON_WIDTH / 2 - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
    02524   }
    02525   if (rtl ? !clickable_left : !clickable_right) {
    02526     GfxFillRect(x + SETTING_BUTTON_WIDTH / 2 + 1, y, x + SETTING_BUTTON_WIDTH     - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
    02527   }
    02528 }
    02529
    02538 void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
    02539 {
    02540   static const char *DOWNARROW = "\xEE\x8A\xAA";
    02541
    02542   int colour = _colour_gradient[button_colour][2];
    02543
    02544   DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, state ? FR_LOWERED : FR_NONE);
    02545   DrawString(x + (state ? 1 : 0), x + SETTING_BUTTON_WIDTH - (state ? 0 : 1), y + (state ? 2 : 1), DOWNARROW, TC_BLACK, SA_HOR_CENTER);
    02546
    02547   if (!clickable) {
    02548     GfxFillRect(x +  1, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
    02549   }
    02550 }
    02551
    02559 void DrawBoolButton(int x, int y, bool state, bool clickable)
    02560 {
    02561   static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
    02562   DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, _bool_ctabs[state][clickable], state ? FR_LOWERED : FR_NONE);
    02563 }
    02564
    02565 struct CustomCurrencyWindow : Window {
    02566   int query_widget;
    02567
    02568   CustomCurrencyWindow(const WindowDesc *desc) : Window()
    02569   {
    02570     this->InitNested(desc);
    02571
    02572     SetButtonState();
    02573   }
    02574
    02575   void SetButtonState()
    02576   {
    02577     this->SetWidgetDisabledState(WID_CC_RATE_DOWN, _custom_currency.rate == 1);
    02578     this->SetWidgetDisabledState(WID_CC_RATE_UP, _custom_currency.rate == UINT16_MAX);
    02579     this->SetWidgetDisabledState(WID_CC_YEAR_DOWN, _custom_currency.to_euro == CF_NOEURO);
    02580     this->SetWidgetDisabledState(WID_CC_YEAR_UP, _custom_currency.to_euro == MAX_YEAR);
    02581   }
    02582
    02583   virtual void SetStringParameters(int widget) const
    02584   {
    02585     switch (widget) {
    02586       case WID_CC_RATE:      SetDParam(0, 1); SetDParam(1, 1);            break;
    02587       case WID_CC_SEPARATOR: SetDParamStr(0, _custom_currency.separator); break;
    02588       case WID_CC_PREFIX:    SetDParamStr(0, _custom_currency.prefix);    break;
    02589       case WID_CC_SUFFIX:    SetDParamStr(0, _custom_currency.suffix);    break;
    02590       case WID_CC_YEAR:
    02591         SetDParam(0, (_custom_currency.to_euro != CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER);
    02592         SetDParam(1, _custom_currency.to_euro);
    02593         break;
    02594
    02595       case WID_CC_PREVIEW:
    02596         SetDParam(0, 10000);
    02597         break;
    02598     }
    02599   }
    02600
    02601   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    02602   {
    02603     switch (widget) {
    02604       /* Set the appropriate width for the edit 'buttons' */
    02605       case WID_CC_SEPARATOR_EDIT:
    02606       case WID_CC_PREFIX_EDIT:
    02607       case WID_CC_SUFFIX_EDIT:
    02608         size->width  = this->GetWidget<NWidgetBase>(WID_CC_RATE_DOWN)->smallest_x + this->GetWidget<NWidgetBase>(WID_CC_RATE_UP)->smallest_x;
    02609         break;
    02610
    02611       /* Make sure the window is wide enough for the widest exchange rate */
    02612       case WID_CC_RATE:
    02613         SetDParam(0, 1);
    02614         SetDParam(1, INT32_MAX);
    02615         *size = GetStringBoundingBox(STR_CURRENCY_EXCHANGE_RATE);
    02616         break;
    02617     }
    02618   }
    02619
    02620   virtual void OnClick(Point pt, int widget, int click_count)
    02621   {
    02622     int line = 0;
    02623     int len = 0;
    02624     StringID str = 0;
    02625     CharSetFilter afilter = CS_ALPHANUMERAL;
    02626
    02627     switch (widget) {
    02628       case WID_CC_RATE_DOWN:
    02629         if (_custom_currency.rate > 1) _custom_currency.rate--;
    02630         if (_custom_currency.rate == 1) this->DisableWidget(WID_CC_RATE_DOWN);
    02631         this->EnableWidget(WID_CC_RATE_UP);
    02632         break;
    02633
    02634       case WID_CC_RATE_UP:
    02635         if (_custom_currency.rate < UINT16_MAX) _custom_currency.rate++;
    02636         if (_custom_currency.rate == UINT16_MAX) this->DisableWidget(WID_CC_RATE_UP);
    02637         this->EnableWidget(WID_CC_RATE_DOWN);
    02638         break;
    02639
    02640       case WID_CC_RATE:
    02641         SetDParam(0, _custom_currency.rate);
    02642         str = STR_JUST_INT;
    02643         len = 5;
    02644         line = WID_CC_RATE;
    02645         afilter = CS_NUMERAL;
    02646         break;
    02647
    02648       case WID_CC_SEPARATOR_EDIT:
    02649       case WID_CC_SEPARATOR:
    02650         SetDParamStr(0, _custom_currency.separator);
    02651         str = STR_JUST_RAW_STRING;
    02652         len = 1;
    02653         line = WID_CC_SEPARATOR;
    02654         break;
    02655
    02656       case WID_CC_PREFIX_EDIT:
    02657       case WID_CC_PREFIX:
    02658         SetDParamStr(0, _custom_currency.prefix);
    02659         str = STR_JUST_RAW_STRING;
    02660         len = 12;
    02661         line = WID_CC_PREFIX;
    02662         break;
    02663
    02664       case WID_CC_SUFFIX_EDIT:
    02665       case WID_CC_SUFFIX:
    02666         SetDParamStr(0, _custom_currency.suffix);
    02667         str = STR_JUST_RAW_STRING;
    02668         len = 12;
    02669         line = WID_CC_SUFFIX;
    02670         break;
    02671
    02672       case WID_CC_YEAR_DOWN:
    02673         _custom_currency.to_euro = (_custom_currency.to_euro <= 2000) ? CF_NOEURO : _custom_currency.to_euro - 1;
    02674         if (_custom_currency.to_euro == CF_NOEURO) this->DisableWidget(WID_CC_YEAR_DOWN);
    02675         this->EnableWidget(WID_CC_YEAR_UP);
    02676         break;
    02677
    02678       case WID_CC_YEAR_UP:
    02679         _custom_currency.to_euro = Clamp(_custom_currency.to_euro + 1, 2000, MAX_YEAR);
    02680         if (_custom_currency.to_euro == MAX_YEAR) this->DisableWidget(WID_CC_YEAR_UP);
    02681         this->EnableWidget(WID_CC_YEAR_DOWN);
    02682         break;
    02683
    02684       case WID_CC_YEAR:
    02685         SetDParam(0, _custom_currency.to_euro);
    02686         str = STR_JUST_INT;
    02687         len = 7;
    02688         line = WID_CC_YEAR;
    02689         afilter = CS_NUMERAL;
    02690         break;
    02691     }
    02692
    02693     if (len != 0) {
    02694       this->query_widget = line;
    02695       ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1, this, afilter, QSF_NONE);
    02696     }
    02697
    02698     this->SetTimeout();
    02699     this->SetDirty();
    02700   }
    02701
    02702   virtual void OnQueryTextFinished(char *str)
    02703   {
    02704     if (str == NULL) return;
    02705
    02706     switch (this->query_widget) {
    02707       case WID_CC_RATE:
    02708         _custom_currency.rate = Clamp(atoi(str), 1, UINT16_MAX);
    02709         break;
    02710
    02711       case WID_CC_SEPARATOR: // Thousands seperator
    02712         strecpy(_custom_currency.separator, str, lastof(_custom_currency.separator));
    02713         break;
    02714
    02715       case WID_CC_PREFIX:
    02716         strecpy(_custom_currency.prefix, str, lastof(_custom_currency.prefix));
    02717         break;
    02718
    02719       case WID_CC_SUFFIX:
    02720         strecpy(_custom_currency.suffix, str, lastof(_custom_currency.suffix));
    02721         break;
    02722
    02723       case WID_CC_YEAR: { // Year to switch to euro
    02724         int val = atoi(str);
    02725
    02726         _custom_currency.to_euro = (val < 2000 ? CF_NOEURO : min(val, MAX_YEAR));
    02727         break;
    02728       }
    02729     }
    02730     MarkWholeScreenDirty();
    02731     SetButtonState();
    02732   }
    02733
    02734   virtual void OnTimeout()
    02735   {
    02736     this->SetDirty();
    02737   }
    02738 };
    02739
    02740 static const NWidgetPart _nested_cust_currency_widgets[] = {
    02741   NWidget(NWID_HORIZONTAL),
    02742     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    02743     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CURRENCY_WINDOW, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    02744   EndContainer(),
    02745   NWidget(WWT_PANEL, COLOUR_GREY),
    02746     NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(7, 3, 0),
    02747       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
    02748         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_EXCHANGE_RATE_TOOLTIP),
    02749         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_EXCHANGE_RATE_TOOLTIP),
    02750         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
    02751         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_RATE), SetDataTip(STR_CURRENCY_EXCHANGE_RATE, STR_CURRENCY_SET_EXCHANGE_RATE_TOOLTIP), SetFill(1, 0),
    02752       EndContainer(),
    02753       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
    02754         NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SEPARATOR_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(0, 1),
    02755         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
    02756         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SEPARATOR), SetDataTip(STR_CURRENCY_SEPARATOR, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(1, 0),
    02757       EndContainer(),
    02758       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
    02759         NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_PREFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(0, 1),
    02760         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
    02761         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_PREFIX), SetDataTip(STR_CURRENCY_PREFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(1, 0),
    02762       EndContainer(),
    02763       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
    02764         NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SUFFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(0, 1),
    02765         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
    02766         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SUFFIX), SetDataTip(STR_CURRENCY_SUFFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(1, 0),
    02767       EndContainer(),
    02768       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
    02769         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
    02770         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
    02771         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
    02772         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_YEAR), SetDataTip(STR_JUST_STRING, STR_CURRENCY_SET_CUSTOM_CURRENCY_TO_EURO_TOOLTIP), SetFill(1, 0),
    02773       EndContainer(),
    02774     EndContainer(),
    02775     NWidget(WWT_LABEL, COLOUR_BLUE, WID_CC_PREVIEW),
    02776                 SetDataTip(STR_CURRENCY_PREVIEW, STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP), SetPadding(15, 1, 18, 2),
    02777   EndContainer(),
    02778 };
    02779
    02780 static const WindowDesc _cust_currency_desc(
    02781   WDP_CENTER, 0, 0,
    02782   WC_CUSTOM_CURRENCY, WC_NONE,
    02783   0,
    02784   _nested_cust_currency_widgets, lengthof(_nested_cust_currency_widgets)
    02785 );
    02786
    02788 static void ShowCustCurrency()
    02789 {
    02790   DeleteWindowById(WC_CUSTOM_CURRENCY, 0);
    02791   new CustomCurrencyWindow(&_cust_currency_desc);
    02792 }