settings_gui.cpp

Go to the documentation of this file.
00001 /* $Id: settings_gui.cpp 24846 2012-12-23 21:09:09Z frosch $ */
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 static int SETTING_HEIGHT = 11;    
00686 static const int LEVEL_WIDTH = 15; 
00687 
00692 enum SettingEntryFlags {
00693   SEF_LEFT_DEPRESSED  = 0x01, 
00694   SEF_RIGHT_DEPRESSED = 0x02, 
00695   SEF_BUTTONS_MASK = (SEF_LEFT_DEPRESSED | SEF_RIGHT_DEPRESSED), 
00696 
00697   SEF_LAST_FIELD = 0x04, 
00698   SEF_FILTERED   = 0x08, 
00699 
00700   /* Entry kind */
00701   SEF_SETTING_KIND = 0x10, 
00702   SEF_SUBTREE_KIND = 0x20, 
00703   SEF_KIND_MASK    = (SEF_SETTING_KIND | SEF_SUBTREE_KIND), 
00704 };
00705 
00706 struct SettingsPage; // Forward declaration
00707 
00709 struct SettingEntrySubtree {
00710   SettingsPage *page; 
00711   bool folded;        
00712   StringID title;     
00713 };
00714 
00716 struct SettingEntrySetting {
00717   const char *name;           
00718   const SettingDesc *setting; 
00719   uint index;                 
00720 };
00721 
00723 enum RestrictionMode {
00724   RM_BASIC,                            
00725   RM_ADVANCED,                         
00726   RM_ALL,                              
00727   RM_CHANGED_AGAINST_DEFAULT,          
00728   RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL, 
00729   RM_CHANGED_AGAINST_NEW,              
00730   RM_END,                              
00731 };
00732 
00734 struct SettingEntry {
00735   byte flags; 
00736   byte level; 
00737   union {
00738     SettingEntrySetting entry; 
00739     SettingEntrySubtree sub;   
00740   } d; 
00741 
00742   SettingEntry(const char *nm);
00743   SettingEntry(SettingsPage *sub, StringID title);
00744 
00745   void Init(byte level);
00746   void FoldAll();
00747   void UnFoldAll();
00748   void SetButtons(byte new_val);
00749 
00754   void SetLastField(bool last_field) { if (last_field) SETBITS(this->flags, SEF_LAST_FIELD); else CLRBITS(this->flags, SEF_LAST_FIELD); }
00755 
00756   uint Length() const;
00757   void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
00758   bool IsVisible(const SettingEntry *item) const;
00759   SettingEntry *FindEntry(uint row, uint *cur_row);
00760   uint GetMaxHelpHeight(int maxw);
00761 
00762   bool IsFiltered() const;
00763   bool UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode);
00764 
00765   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);
00766 
00771   inline StringID GetHelpText()
00772   {
00773     assert((this->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
00774     return this->d.entry.setting->desc.str_help;
00775   }
00776 
00777   void SetValueDParams(uint first_param, int32 value);
00778 
00779 private:
00780   void DrawSetting(GameSettings *settings_ptr, int x, int y, int max_x, int state, bool highlight);
00781   bool IsVisibleByRestrictionMode(RestrictionMode mode) const;
00782 };
00783 
00785 struct SettingsPage {
00786   SettingEntry *entries; 
00787   byte num;              
00788 
00789   void Init(byte level = 0);
00790   void FoldAll();
00791   void UnFoldAll();
00792 
00793   uint Length() const;
00794   void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
00795   bool IsVisible(const SettingEntry *item) const;
00796   SettingEntry *FindEntry(uint row, uint *cur_row) const;
00797   uint GetMaxHelpHeight(int maxw);
00798 
00799   bool UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode);
00800 
00801   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;
00802 };
00803 
00804 
00805 /* == SettingEntry methods == */
00806 
00811 SettingEntry::SettingEntry(const char *nm)
00812 {
00813   this->flags = SEF_SETTING_KIND;
00814   this->level = 0;
00815   this->d.entry.name = nm;
00816   this->d.entry.setting = NULL;
00817   this->d.entry.index = 0;
00818 }
00819 
00825 SettingEntry::SettingEntry(SettingsPage *sub, StringID title)
00826 {
00827   this->flags = SEF_SUBTREE_KIND;
00828   this->level = 0;
00829   this->d.sub.page = sub;
00830   this->d.sub.folded = true;
00831   this->d.sub.title = title;
00832 }
00833 
00838 void SettingEntry::Init(byte level)
00839 {
00840   this->level = level;
00841 
00842   switch (this->flags & SEF_KIND_MASK) {
00843     case SEF_SETTING_KIND:
00844       this->d.entry.setting = GetSettingFromName(this->d.entry.name, &this->d.entry.index);
00845       assert(this->d.entry.setting != NULL);
00846       break;
00847     case SEF_SUBTREE_KIND:
00848       this->d.sub.page->Init(level + 1);
00849       break;
00850     default: NOT_REACHED();
00851   }
00852 }
00853 
00855 void SettingEntry::FoldAll()
00856 {
00857   if (this->IsFiltered()) return;
00858   switch (this->flags & SEF_KIND_MASK) {
00859     case SEF_SETTING_KIND:
00860       break;
00861 
00862     case SEF_SUBTREE_KIND:
00863       this->d.sub.folded = true;
00864       this->d.sub.page->FoldAll();
00865       break;
00866 
00867     default: NOT_REACHED();
00868   }
00869 }
00870 
00872 void SettingEntry::UnFoldAll()
00873 {
00874   if (this->IsFiltered()) return;
00875   switch (this->flags & SEF_KIND_MASK) {
00876     case SEF_SETTING_KIND:
00877       break;
00878 
00879     case SEF_SUBTREE_KIND:
00880       this->d.sub.folded = false;
00881       this->d.sub.page->UnFoldAll();
00882       break;
00883 
00884     default: NOT_REACHED();
00885   }
00886 }
00887 
00893 void SettingEntry::GetFoldingState(bool &all_folded, bool &all_unfolded) const
00894 {
00895   if (this->IsFiltered()) return;
00896   switch (this->flags & SEF_KIND_MASK) {
00897     case SEF_SETTING_KIND:
00898       break;
00899 
00900     case SEF_SUBTREE_KIND:
00901       if (this->d.sub.folded) {
00902         all_unfolded = false;
00903       } else {
00904         all_folded = false;
00905       }
00906       this->d.sub.page->GetFoldingState(all_folded, all_unfolded);
00907       break;
00908 
00909     default: NOT_REACHED();
00910   }
00911 }
00912 
00919 bool SettingEntry::IsVisible(const SettingEntry *item) const
00920 {
00921   if (this->IsFiltered()) return false;
00922   if (this == item) return true;
00923 
00924   switch (this->flags & SEF_KIND_MASK) {
00925     case SEF_SETTING_KIND:
00926       return false;
00927 
00928     case SEF_SUBTREE_KIND:
00929       return !this->d.sub.folded && this->d.sub.page->IsVisible(item);
00930 
00931     default: NOT_REACHED();
00932   }
00933 }
00934 
00940 void SettingEntry::SetButtons(byte new_val)
00941 {
00942   assert((new_val & ~SEF_BUTTONS_MASK) == 0); // Should not touch any flags outside the buttons
00943   this->flags = (this->flags & ~SEF_BUTTONS_MASK) | new_val;
00944 }
00945 
00947 uint SettingEntry::Length() const
00948 {
00949   if (this->IsFiltered()) return 0;
00950   switch (this->flags & SEF_KIND_MASK) {
00951     case SEF_SETTING_KIND:
00952       return 1;
00953     case SEF_SUBTREE_KIND:
00954       if (this->d.sub.folded) return 1; // Only displaying the title
00955 
00956       return 1 + this->d.sub.page->Length(); // 1 extra row for the title
00957     default: NOT_REACHED();
00958   }
00959 }
00960 
00967 SettingEntry *SettingEntry::FindEntry(uint row_num, uint *cur_row)
00968 {
00969   if (this->IsFiltered()) return NULL;
00970   if (row_num == *cur_row) return this;
00971 
00972   switch (this->flags & SEF_KIND_MASK) {
00973     case SEF_SETTING_KIND:
00974       (*cur_row)++;
00975       break;
00976     case SEF_SUBTREE_KIND:
00977       (*cur_row)++; // add one for row containing the title
00978       if (this->d.sub.folded) {
00979         break;
00980       }
00981 
00982       /* sub-page is visible => search it too */
00983       return this->d.sub.page->FindEntry(row_num, cur_row);
00984     default: NOT_REACHED();
00985   }
00986   return NULL;
00987 }
00988 
00994 uint SettingEntry::GetMaxHelpHeight(int maxw)
00995 {
00996   switch (this->flags & SEF_KIND_MASK) {
00997     case SEF_SETTING_KIND: return GetStringHeight(this->GetHelpText(), maxw);
00998     case SEF_SUBTREE_KIND: return this->d.sub.page->GetMaxHelpHeight(maxw);
00999     default:               NOT_REACHED();
01000   }
01001 }
01002 
01007 bool SettingEntry::IsFiltered() const
01008 {
01009   return (this->flags & SEF_FILTERED) != 0;
01010 }
01011 
01017 bool SettingEntry::IsVisibleByRestrictionMode(RestrictionMode mode) const
01018 {
01019   /* There shall not be any restriction, i.e. all settings shall be visible. */
01020   if (mode == RM_ALL) return true;
01021 
01022   GameSettings *settings_ptr = &GetGameSettings();
01023   assert((this->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
01024   const SettingDesc *sd = this->d.entry.setting;
01025 
01026   if (mode == RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL && (sd->save.conv & SLF_NO_NETWORK_SYNC) != 0) {
01027     /* Hide local settings when comparing our settings against those of the server. */
01028     return false;
01029   }
01030 
01031   if (mode == RM_BASIC) return (this->d.entry.setting->desc.cat & SC_BASIC_LIST) != 0;
01032   if (mode == RM_ADVANCED) return (this->d.entry.setting->desc.cat & SC_ADVANCED_LIST) != 0;
01033 
01034   /* Read the current value. */
01035   const void *var = ResolveVariableAddress(settings_ptr, sd);
01036   int64 current_value = ReadValue(var, sd->save.conv);
01037 
01038   int64 filter_value;
01039 
01040   if (mode == RM_CHANGED_AGAINST_DEFAULT || mode == RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL) {
01041     /* This entry shall only be visible, if the value deviates from its default value. */
01042 
01043     /* Read the default value. */
01044     filter_value = ReadValue(&sd->desc.def, sd->save.conv);
01045   } else {
01046     assert(mode == RM_CHANGED_AGAINST_NEW);
01047     /* This entry shall only be visible, if the value deviates from
01048      * its value is used when starting a new game. */
01049 
01050     /* Make sure we're not comparing the new game settings against itself. */
01051     assert(settings_ptr != &_settings_newgame);
01052 
01053     /* Read the new game's value. */
01054     var = ResolveVariableAddress(&_settings_newgame, sd);
01055     filter_value = ReadValue(var, sd->save.conv);
01056   }
01057 
01058   return current_value != filter_value;
01059 }
01060 
01068 bool SettingEntry::UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode)
01069 {
01070   CLRBITS(this->flags, SEF_FILTERED);
01071 
01072   bool visible = true;
01073   switch (this->flags & SEF_KIND_MASK) {
01074     case SEF_SETTING_KIND: {
01075       if (!force_visible && !filter.IsEmpty()) {
01076         /* Process the search text filter for this item. */
01077         filter.ResetState();
01078 
01079         const SettingDesc *sd = this->d.entry.setting;
01080         const SettingDescBase *sdb = &sd->desc;
01081 
01082         SetDParam(0, STR_EMPTY);
01083         filter.AddLine(sdb->str);
01084         filter.AddLine(this->GetHelpText());
01085 
01086         visible = filter.GetState();
01087       }
01088       visible = visible && this->IsVisibleByRestrictionMode(mode);
01089       break;
01090     }
01091     case SEF_SUBTREE_KIND: {
01092       if (!force_visible && !filter.IsEmpty()) {
01093         filter.ResetState();
01094         filter.AddLine(this->d.sub.title);
01095         force_visible = filter.GetState();
01096       }
01097       visible = this->d.sub.page->UpdateFilterState(filter, force_visible, mode);
01098       break;
01099     }
01100     default: NOT_REACHED();
01101   }
01102 
01103   if (!visible) SETBITS(this->flags, SEF_FILTERED);
01104   return visible;
01105 }
01106 
01107 
01108 
01136 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)
01137 {
01138   if (this->IsFiltered()) return cur_row;
01139   if (cur_row >= max_row) return cur_row;
01140 
01141   bool rtl = _current_text_dir == TD_RTL;
01142   int offset = rtl ? -4 : 4;
01143   int level_width = rtl ? -LEVEL_WIDTH : LEVEL_WIDTH;
01144 
01145   int x = rtl ? right : left;
01146   int y = base_y;
01147   if (cur_row >= first_row) {
01148     int colour = _colour_gradient[COLOUR_ORANGE][4];
01149     y = base_y + (cur_row - first_row) * SETTING_HEIGHT; // Compute correct y start position
01150 
01151     /* Draw vertical for parent nesting levels */
01152     for (uint lvl = 0; lvl < this->level; lvl++) {
01153       if (!HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y + SETTING_HEIGHT - 1, colour);
01154       x += level_width;
01155     }
01156     /* draw own |- prefix */
01157     int halfway_y = y + SETTING_HEIGHT / 2;
01158     int bottom_y = (flags & SEF_LAST_FIELD) ? halfway_y : y + SETTING_HEIGHT - 1;
01159     GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
01160     /* Small horizontal line from the last vertical line */
01161     GfxDrawLine(x + offset, halfway_y, x + level_width - offset, halfway_y, colour);
01162     x += level_width;
01163   }
01164 
01165   switch (this->flags & SEF_KIND_MASK) {
01166     case SEF_SETTING_KIND:
01167       if (cur_row >= first_row) {
01168         this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y, this->flags & SEF_BUTTONS_MASK,
01169             this == selected);
01170       }
01171       cur_row++;
01172       break;
01173     case SEF_SUBTREE_KIND:
01174       if (cur_row >= first_row) {
01175         DrawSprite((this->d.sub.folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED), PAL_NONE, rtl ? x - 8 : x, y + (SETTING_HEIGHT - 11) / 2);
01176         DrawString(rtl ? left : x + 12, rtl ? x - 12 : right, y, this->d.sub.title);
01177       }
01178       cur_row++;
01179       if (!this->d.sub.folded) {
01180         if (this->flags & SEF_LAST_FIELD) {
01181           assert(this->level < sizeof(parent_last));
01182           SetBit(parent_last, this->level); // Add own last-field state
01183         }
01184 
01185         cur_row = this->d.sub.page->Draw(settings_ptr, left, right, base_y, first_row, max_row, selected, cur_row, parent_last);
01186       }
01187       break;
01188     default: NOT_REACHED();
01189   }
01190   return cur_row;
01191 }
01192 
01193 static const void *ResolveVariableAddress(const GameSettings *settings_ptr, const SettingDesc *sd)
01194 {
01195   if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
01196     if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
01197       return GetVariableAddress(&Company::Get(_local_company)->settings, &sd->save);
01198     } else {
01199       return GetVariableAddress(&_settings_client.company, &sd->save);
01200     }
01201   } else {
01202     return GetVariableAddress(settings_ptr, &sd->save);
01203   }
01204 }
01205 
01211 void SettingEntry::SetValueDParams(uint first_param, int32 value)
01212 {
01213   assert((this->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
01214   const SettingDescBase *sdb = &this->d.entry.setting->desc;
01215   if (sdb->cmd == SDT_BOOLX) {
01216     SetDParam(first_param++, value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
01217   } else {
01218     if ((sdb->flags & SGF_MULTISTRING) != 0) {
01219       SetDParam(first_param++, sdb->str_val - sdb->min + value);
01220     } else if ((sdb->flags & SGF_DISPLAY_ABS) != 0) {
01221       SetDParam(first_param++, sdb->str_val + ((value >= 0) ? 1 : 0));
01222       value = abs(value);
01223     } else {
01224       SetDParam(first_param++, sdb->str_val + ((value == 0 && (sdb->flags & SGF_0ISDISABLED) != 0) ? 1 : 0));
01225     }
01226     SetDParam(first_param++, value);
01227   }
01228 }
01229 
01239 void SettingEntry::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, int state, bool highlight)
01240 {
01241   const SettingDesc *sd = this->d.entry.setting;
01242   const SettingDescBase *sdb = &sd->desc;
01243   const void *var = ResolveVariableAddress(settings_ptr, sd);
01244 
01245   bool rtl = _current_text_dir == TD_RTL;
01246   uint buttons_left = rtl ? right + 1 - SETTING_BUTTON_WIDTH : left;
01247   uint text_left  = left + (rtl ? 0 : SETTING_BUTTON_WIDTH + 5);
01248   uint text_right = right - (rtl ? SETTING_BUTTON_WIDTH + 5 : 0);
01249   uint button_y = y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
01250 
01251   /* We do not allow changes of some items when we are a client in a networkgame */
01252   bool editable = sd->IsEditable();
01253 
01254   SetDParam(0, highlight ? STR_ORANGE_STRING1_WHITE : STR_ORANGE_STRING1_LTBLUE);
01255   int32 value = (int32)ReadValue(var, sd->save.conv);
01256   if (sdb->cmd == SDT_BOOLX) {
01257     /* Draw checkbox for boolean-value either on/off */
01258     DrawBoolButton(buttons_left, button_y, value != 0, editable);
01259   } else if ((sdb->flags & SGF_MULTISTRING) != 0) {
01260     /* Draw [v] button for settings of an enum-type */
01261     DrawDropDownButton(buttons_left, button_y, COLOUR_YELLOW, state != 0, editable);
01262   } else {
01263     /* Draw [<][>] boxes for settings of an integer-type */
01264     DrawArrowButtons(buttons_left, button_y, COLOUR_YELLOW, state,
01265         editable && value != (sdb->flags & SGF_0ISDISABLED ? 0 : sdb->min), editable && (uint32)value != sdb->max);
01266   }
01267   this->SetValueDParams(1, value);
01268   DrawString(text_left, text_right, y, sdb->str, highlight ? TC_WHITE : TC_LIGHT_BLUE);
01269 }
01270 
01271 
01272 /* == SettingsPage methods == */
01273 
01278 void SettingsPage::Init(byte level)
01279 {
01280   for (uint field = 0; field < this->num; field++) {
01281     this->entries[field].Init(level);
01282   }
01283 }
01284 
01286 void SettingsPage::FoldAll()
01287 {
01288   for (uint field = 0; field < this->num; field++) {
01289     this->entries[field].FoldAll();
01290   }
01291 }
01292 
01294 void SettingsPage::UnFoldAll()
01295 {
01296   for (uint field = 0; field < this->num; field++) {
01297     this->entries[field].UnFoldAll();
01298   }
01299 }
01300 
01306 void SettingsPage::GetFoldingState(bool &all_folded, bool &all_unfolded) const
01307 {
01308   for (uint field = 0; field < this->num; field++) {
01309     this->entries[field].GetFoldingState(all_folded, all_unfolded);
01310   }
01311 }
01312 
01320 bool SettingsPage::UpdateFilterState(StringFilter &filter, bool force_visible, RestrictionMode mode)
01321 {
01322   bool visible = false;
01323   bool first_visible = true;
01324   for (int field = this->num - 1; field >= 0; field--) {
01325     visible |= this->entries[field].UpdateFilterState(filter, force_visible, mode);
01326     this->entries[field].SetLastField(first_visible);
01327     if (visible && first_visible) first_visible = false;
01328   }
01329   return visible;
01330 }
01331 
01332 
01339 bool SettingsPage::IsVisible(const SettingEntry *item) const
01340 {
01341   for (uint field = 0; field < this->num; field++) {
01342     if (this->entries[field].IsVisible(item)) return true;
01343   }
01344   return false;
01345 }
01346 
01348 uint SettingsPage::Length() const
01349 {
01350   uint length = 0;
01351   for (uint field = 0; field < this->num; field++) {
01352     length += this->entries[field].Length();
01353   }
01354   return length;
01355 }
01356 
01363 SettingEntry *SettingsPage::FindEntry(uint row_num, uint *cur_row) const
01364 {
01365   SettingEntry *pe = NULL;
01366 
01367   for (uint field = 0; field < this->num; field++) {
01368     pe = this->entries[field].FindEntry(row_num, cur_row);
01369     if (pe != NULL) {
01370       break;
01371     }
01372   }
01373   return pe;
01374 }
01375 
01381 uint SettingsPage::GetMaxHelpHeight(int maxw)
01382 {
01383   uint biggest = 0;
01384   for (uint field = 0; field < this->num; field++) {
01385     biggest = max(biggest, this->entries[field].GetMaxHelpHeight(maxw));
01386   }
01387   return biggest;
01388 }
01389 
01408 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
01409 {
01410   if (cur_row >= max_row) return cur_row;
01411 
01412   for (uint i = 0; i < this->num; i++) {
01413     cur_row = this->entries[i].Draw(settings_ptr, left, right, base_y, first_row, max_row, cur_row, parent_last, selected);
01414     if (cur_row >= max_row) {
01415       break;
01416     }
01417   }
01418   return cur_row;
01419 }
01420 
01421 
01422 static SettingEntry _settings_ui_display[] = {
01423   SettingEntry("gui.date_format_in_default_names"),
01424   SettingEntry("gui.population_in_label"),
01425   SettingEntry("gui.measure_tooltip"),
01426   SettingEntry("gui.loading_indicators"),
01427   SettingEntry("gui.liveries"),
01428   SettingEntry("gui.show_track_reservation"),
01429   SettingEntry("gui.expenses_layout"),
01430   SettingEntry("gui.smallmap_land_colour"),
01431   SettingEntry("gui.zoom_min"),
01432   SettingEntry("gui.zoom_max"),
01433   SettingEntry("gui.graph_line_thickness"),
01434 };
01436 static SettingsPage _settings_ui_display_page = {_settings_ui_display, lengthof(_settings_ui_display)};
01437 
01438 static SettingEntry _settings_ui_interaction[] = {
01439   SettingEntry("gui.window_snap_radius"),
01440   SettingEntry("gui.window_soft_limit"),
01441   SettingEntry("gui.link_terraform_toolbar"),
01442   SettingEntry("gui.prefer_teamchat"),
01443   SettingEntry("gui.auto_scrolling"),
01444   SettingEntry("gui.reverse_scroll"),
01445   SettingEntry("gui.smooth_scroll"),
01446   SettingEntry("gui.left_mouse_btn_scrolling"),
01447   /* While the horizontal scrollwheel scrolling is written as general code, only
01448    *  the cocoa (OSX) driver generates input for it.
01449    *  Since it's also able to completely disable the scrollwheel will we display it on all platforms anyway */
01450   SettingEntry("gui.scrollwheel_scrolling"),
01451   SettingEntry("gui.scrollwheel_multiplier"),
01452   SettingEntry("gui.osk_activation"),
01453 #ifdef __APPLE__
01454   /* We might need to emulate a right mouse button on mac */
01455   SettingEntry("gui.right_mouse_btn_emulation"),
01456 #endif
01457 };
01459 static SettingsPage _settings_ui_interaction_page = {_settings_ui_interaction, lengthof(_settings_ui_interaction)};
01460 
01461 static SettingEntry _settings_ui_sound[] = {
01462   SettingEntry("sound.click_beep"),
01463   SettingEntry("sound.confirm"),
01464   SettingEntry("sound.news_ticker"),
01465   SettingEntry("sound.news_full"),
01466   SettingEntry("sound.new_year"),
01467   SettingEntry("sound.disaster"),
01468   SettingEntry("sound.vehicle"),
01469   SettingEntry("sound.ambient"),
01470 };
01472 static SettingsPage _settings_ui_sound_page = {_settings_ui_sound, lengthof(_settings_ui_sound)};
01473 
01474 static SettingEntry _settings_ui_news[] = {
01475   SettingEntry("news_display.arrival_player"),
01476   SettingEntry("news_display.arrival_other"),
01477   SettingEntry("news_display.accident"),
01478   SettingEntry("news_display.company_info"),
01479   SettingEntry("news_display.open"),
01480   SettingEntry("news_display.close"),
01481   SettingEntry("news_display.economy"),
01482   SettingEntry("news_display.production_player"),
01483   SettingEntry("news_display.production_other"),
01484   SettingEntry("news_display.production_nobody"),
01485   SettingEntry("news_display.advice"),
01486   SettingEntry("news_display.new_vehicles"),
01487   SettingEntry("news_display.acceptance"),
01488   SettingEntry("news_display.subsidies"),
01489   SettingEntry("news_display.general"),
01490   SettingEntry("gui.coloured_news_year"),
01491 };
01493 static SettingsPage _settings_ui_news_page = {_settings_ui_news, lengthof(_settings_ui_news)};
01494 
01495 static SettingEntry _settings_ui[] = {
01496   SettingEntry(&_settings_ui_display_page, STR_CONFIG_SETTING_DISPLAY_OPTIONS),
01497   SettingEntry(&_settings_ui_interaction_page, STR_CONFIG_SETTING_INTERACTION),
01498   SettingEntry(&_settings_ui_sound_page, STR_CONFIG_SETTING_SOUND),
01499   SettingEntry(&_settings_ui_news_page, STR_CONFIG_SETTING_NEWS),
01500   SettingEntry("gui.show_finances"),
01501   SettingEntry("gui.errmsg_duration"),
01502   SettingEntry("gui.hover_delay"),
01503   SettingEntry("gui.toolbar_pos"),
01504   SettingEntry("gui.statusbar_pos"),
01505   SettingEntry("gui.newgrf_default_palette"),
01506   SettingEntry("gui.pause_on_newgame"),
01507   SettingEntry("gui.advanced_vehicle_list"),
01508   SettingEntry("gui.timetable_in_ticks"),
01509   SettingEntry("gui.timetable_arrival_departure"),
01510   SettingEntry("gui.quick_goto"),
01511   SettingEntry("gui.default_rail_type"),
01512   SettingEntry("gui.disable_unsuitable_building"),
01513   SettingEntry("gui.persistent_buildingtools"),
01514 };
01516 static SettingsPage _settings_ui_page = {_settings_ui, lengthof(_settings_ui)};
01517 
01518 static SettingEntry _settings_construction_signals[] = {
01519   SettingEntry("construction.train_signal_side"),
01520   SettingEntry("gui.enable_signal_gui"),
01521   SettingEntry("gui.drag_signals_fixed_distance"),
01522   SettingEntry("gui.semaphore_build_before"),
01523   SettingEntry("gui.default_signal_type"),
01524   SettingEntry("gui.cycle_signal_types"),
01525 };
01527 static SettingsPage _settings_construction_signals_page = {_settings_construction_signals, lengthof(_settings_construction_signals)};
01528 
01529 static SettingEntry _settings_construction[] = {
01530   SettingEntry(&_settings_construction_signals_page, STR_CONFIG_SETTING_CONSTRUCTION_SIGNALS),
01531   SettingEntry("construction.build_on_slopes"),
01532   SettingEntry("construction.autoslope"),
01533   SettingEntry("construction.extra_dynamite"),
01534   SettingEntry("construction.max_bridge_length"),
01535   SettingEntry("construction.max_tunnel_length"),
01536   SettingEntry("station.never_expire_airports"),
01537   SettingEntry("construction.freeform_edges"),
01538   SettingEntry("construction.extra_tree_placement"),
01539   SettingEntry("construction.command_pause_level"),
01540 };
01542 static SettingsPage _settings_construction_page = {_settings_construction, lengthof(_settings_construction)};
01543 
01544 static SettingEntry _settings_stations_cargo[] = {
01545   SettingEntry("order.improved_load"),
01546   SettingEntry("order.gradual_loading"),
01547   SettingEntry("order.selectgoods"),
01548 };
01550 static SettingsPage _settings_stations_cargo_page = {_settings_stations_cargo, lengthof(_settings_stations_cargo)};
01551 
01552 static SettingEntry _settings_stations[] = {
01553   SettingEntry(&_settings_stations_cargo_page, STR_CONFIG_SETTING_STATIONS_CARGOHANDLING),
01554   SettingEntry("station.adjacent_stations"),
01555   SettingEntry("station.distant_join_stations"),
01556   SettingEntry("station.station_spread"),
01557   SettingEntry("economy.station_noise_level"),
01558   SettingEntry("station.modified_catchment"),
01559   SettingEntry("construction.road_stop_on_town_road"),
01560   SettingEntry("construction.road_stop_on_competitor_road"),
01561 };
01563 static SettingsPage _settings_stations_page = {_settings_stations, lengthof(_settings_stations)};
01564 
01565 static SettingEntry _settings_economy_towns[] = {
01566   SettingEntry("difficulty.town_council_tolerance"),
01567   SettingEntry("economy.bribe"),
01568   SettingEntry("economy.exclusive_rights"),
01569   SettingEntry("economy.fund_roads"),
01570   SettingEntry("economy.fund_buildings"),
01571   SettingEntry("economy.town_layout"),
01572   SettingEntry("economy.allow_town_roads"),
01573   SettingEntry("economy.allow_town_level_crossings"),
01574   SettingEntry("economy.found_town"),
01575   SettingEntry("economy.mod_road_rebuild"),
01576   SettingEntry("economy.town_growth_rate"),
01577   SettingEntry("economy.larger_towns"),
01578   SettingEntry("economy.initial_city_size"),
01579 };
01581 static SettingsPage _settings_economy_towns_page = {_settings_economy_towns, lengthof(_settings_economy_towns)};
01582 
01583 static SettingEntry _settings_economy_industries[] = {
01584   SettingEntry("construction.raw_industry_construction"),
01585   SettingEntry("construction.industry_platform"),
01586   SettingEntry("economy.multiple_industry_per_town"),
01587   SettingEntry("game_creation.oil_refinery_limit"),
01588 };
01590 static SettingsPage _settings_economy_industries_page = {_settings_economy_industries, lengthof(_settings_economy_industries)};
01591 
01592 
01593 static SettingEntry _settings_economy[] = {
01594   SettingEntry(&_settings_economy_towns_page, STR_CONFIG_SETTING_ECONOMY_TOWNS),
01595   SettingEntry(&_settings_economy_industries_page, STR_CONFIG_SETTING_ECONOMY_INDUSTRIES),
01596   SettingEntry("economy.inflation"),
01597   SettingEntry("difficulty.initial_interest"),
01598   SettingEntry("difficulty.max_loan"),
01599   SettingEntry("difficulty.subsidy_multiplier"),
01600   SettingEntry("difficulty.economy"),
01601   SettingEntry("economy.smooth_economy"),
01602   SettingEntry("economy.feeder_payment_share"),
01603   SettingEntry("economy.infrastructure_maintenance"),
01604   SettingEntry("difficulty.vehicle_costs"),
01605   SettingEntry("difficulty.construction_cost"),
01606   SettingEntry("difficulty.disasters"),
01607 };
01609 static SettingsPage _settings_economy_page = {_settings_economy, lengthof(_settings_economy)};
01610 
01611 static SettingEntry _settings_ai_npc[] = {
01612   SettingEntry("script.settings_profile"),
01613   SettingEntry("script.script_max_opcode_till_suspend"),
01614   SettingEntry("difficulty.competitor_speed"),
01615   SettingEntry("ai.ai_in_multiplayer"),
01616   SettingEntry("ai.ai_disable_veh_train"),
01617   SettingEntry("ai.ai_disable_veh_roadveh"),
01618   SettingEntry("ai.ai_disable_veh_aircraft"),
01619   SettingEntry("ai.ai_disable_veh_ship"),
01620 };
01622 static SettingsPage _settings_ai_npc_page = {_settings_ai_npc, lengthof(_settings_ai_npc)};
01623 
01624 static SettingEntry _settings_ai[] = {
01625   SettingEntry(&_settings_ai_npc_page, STR_CONFIG_SETTING_AI_NPC),
01626   SettingEntry("economy.give_money"),
01627   SettingEntry("economy.allow_shares"),
01628 };
01630 static SettingsPage _settings_ai_page = {_settings_ai, lengthof(_settings_ai)};
01631 
01632 static SettingEntry _settings_vehicles_routing[] = {
01633   SettingEntry("pf.pathfinder_for_trains"),
01634   SettingEntry("pf.forbid_90_deg"),
01635   SettingEntry("pf.pathfinder_for_roadvehs"),
01636   SettingEntry("pf.roadveh_queue"),
01637   SettingEntry("pf.pathfinder_for_ships"),
01638 };
01640 static SettingsPage _settings_vehicles_routing_page = {_settings_vehicles_routing, lengthof(_settings_vehicles_routing)};
01641 
01642 static SettingEntry _settings_vehicles_autorenew[] = {
01643   SettingEntry("company.engine_renew"),
01644   SettingEntry("company.engine_renew_months"),
01645   SettingEntry("company.engine_renew_money"),
01646 };
01648 static SettingsPage _settings_vehicles_autorenew_page = {_settings_vehicles_autorenew, lengthof(_settings_vehicles_autorenew)};
01649 
01650 static SettingEntry _settings_vehicles_servicing[] = {
01651   SettingEntry("vehicle.servint_ispercent"),
01652   SettingEntry("vehicle.servint_trains"),
01653   SettingEntry("vehicle.servint_roadveh"),
01654   SettingEntry("vehicle.servint_ships"),
01655   SettingEntry("vehicle.servint_aircraft"),
01656   SettingEntry("difficulty.vehicle_breakdowns"),
01657   SettingEntry("order.no_servicing_if_no_breakdowns"),
01658   SettingEntry("order.serviceathelipad"),
01659 };
01661 static SettingsPage _settings_vehicles_servicing_page = {_settings_vehicles_servicing, lengthof(_settings_vehicles_servicing)};
01662 
01663 static SettingEntry _settings_vehicles_trains[] = {
01664   SettingEntry("difficulty.line_reverse_mode"),
01665   SettingEntry("pf.reverse_at_signals"),
01666   SettingEntry("vehicle.train_acceleration_model"),
01667   SettingEntry("vehicle.train_slope_steepness"),
01668   SettingEntry("vehicle.max_train_length"),
01669   SettingEntry("vehicle.wagon_speed_limits"),
01670   SettingEntry("vehicle.disable_elrails"),
01671   SettingEntry("vehicle.freight_trains"),
01672   SettingEntry("gui.stop_location"),
01673 };
01675 static SettingsPage _settings_vehicles_trains_page = {_settings_vehicles_trains, lengthof(_settings_vehicles_trains)};
01676 
01677 static SettingEntry _settings_vehicles[] = {
01678   SettingEntry(&_settings_vehicles_routing_page, STR_CONFIG_SETTING_VEHICLES_ROUTING),
01679   SettingEntry(&_settings_vehicles_autorenew_page, STR_CONFIG_SETTING_VEHICLES_AUTORENEW),
01680   SettingEntry(&_settings_vehicles_servicing_page, STR_CONFIG_SETTING_VEHICLES_SERVICING),
01681   SettingEntry(&_settings_vehicles_trains_page, STR_CONFIG_SETTING_VEHICLES_TRAINS),
01682   SettingEntry("gui.new_nonstop"),
01683   SettingEntry("gui.order_review_system"),
01684   SettingEntry("gui.vehicle_income_warn"),
01685   SettingEntry("gui.lost_vehicle_warn"),
01686   SettingEntry("vehicle.never_expire_vehicles"),
01687   SettingEntry("vehicle.max_trains"),
01688   SettingEntry("vehicle.max_roadveh"),
01689   SettingEntry("vehicle.max_aircraft"),
01690   SettingEntry("vehicle.max_ships"),
01691   SettingEntry("vehicle.plane_speed"),
01692   SettingEntry("vehicle.plane_crashes"),
01693   SettingEntry("vehicle.dynamic_engines"),
01694   SettingEntry("vehicle.roadveh_acceleration_model"),
01695   SettingEntry("vehicle.roadveh_slope_steepness"),
01696   SettingEntry("vehicle.smoke_amount"),
01697 };
01699 static SettingsPage _settings_vehicles_page = {_settings_vehicles, lengthof(_settings_vehicles)};
01700 
01701 static SettingEntry _settings_main[] = {
01702   SettingEntry(&_settings_ui_page,           STR_CONFIG_SETTING_GUI),
01703   SettingEntry(&_settings_construction_page, STR_CONFIG_SETTING_CONSTRUCTION),
01704   SettingEntry(&_settings_vehicles_page,     STR_CONFIG_SETTING_VEHICLES),
01705   SettingEntry(&_settings_stations_page,     STR_CONFIG_SETTING_STATIONS),
01706   SettingEntry(&_settings_economy_page,      STR_CONFIG_SETTING_ECONOMY),
01707   SettingEntry(&_settings_ai_page,           STR_CONFIG_SETTING_AI),
01708 };
01709 
01711 static SettingsPage _settings_main_page = {_settings_main, lengthof(_settings_main)};
01712 
01713 static const StringID _game_settings_restrict_dropdown[] = {
01714   STR_CONFIG_SETTING_RESTRICT_BASIC,                            // RM_BASIC
01715   STR_CONFIG_SETTING_RESTRICT_ADVANCED,                         // RM_ADVANCED
01716   STR_CONFIG_SETTING_RESTRICT_ALL,                              // RM_ALL
01717   STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT,          // RM_CHANGED_AGAINST_DEFAULT
01718   STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT_WO_LOCAL, // RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL
01719   STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW,              // RM_CHANGED_AGAINST_NEW
01720 };
01721 assert_compile(lengthof(_game_settings_restrict_dropdown) == RM_END);
01722 
01723 struct GameSettingsWindow : Window {
01724   static const int SETTINGTREE_LEFT_OFFSET   = 5; 
01725   static const int SETTINGTREE_RIGHT_OFFSET  = 5; 
01726   static const int SETTINGTREE_TOP_OFFSET    = 5; 
01727   static const int SETTINGTREE_BOTTOM_OFFSET = 5; 
01728 
01729   static GameSettings *settings_ptr; 
01730 
01731   SettingEntry *valuewindow_entry;   
01732   SettingEntry *clicked_entry;       
01733   SettingEntry *last_clicked;        
01734   SettingEntry *valuedropdown_entry; 
01735   bool closing_dropdown;             
01736 
01737   StringFilter string_filter;        
01738   QueryString filter_editbox;        
01739   bool manually_changed_folding;     
01740 
01741   RestrictionMode cur_restriction_mode; 
01742 
01743   Scrollbar *vscroll;
01744 
01745   GameSettingsWindow(const WindowDesc *desc) : filter_editbox(50), cur_restriction_mode((RestrictionMode)_settings_client.gui.settings_restriction_mode)
01746   {
01747     static bool first_time = true;
01748 
01749     settings_ptr = &GetGameSettings();
01750 
01751     /* Build up the dynamic settings-array only once per OpenTTD session */
01752     if (first_time) {
01753       _settings_main_page.Init();
01754       first_time = false;
01755     } else {
01756       _settings_main_page.FoldAll(); // Close all sub-pages
01757     }
01758 
01759     this->valuewindow_entry = NULL; // No setting entry for which a entry window is opened
01760     this->clicked_entry = NULL; // No numeric setting buttons are depressed
01761     this->last_clicked = NULL;
01762     this->valuedropdown_entry = NULL;
01763     this->closing_dropdown = false;
01764     this->manually_changed_folding = false;
01765 
01766     this->CreateNestedTree(desc);
01767     this->vscroll = this->GetScrollbar(WID_GS_SCROLLBAR);
01768     this->FinishInitNested(desc, WN_GAME_OPTIONS_GAME_SETTINGS);
01769 
01770     this->querystrings[WID_GS_FILTER] = &this->filter_editbox;
01771     this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
01772     this->SetFocusedWidget(WID_GS_FILTER);
01773 
01774     this->InvalidateData();
01775   }
01776 
01777   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
01778   {
01779     switch (widget) {
01780       case WID_GS_OPTIONSPANEL:
01781         resize->height = SETTING_HEIGHT = max(11, FONT_HEIGHT_NORMAL + 1);
01782         resize->width  = 1;
01783 
01784         size->height = 5 * resize->height + SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET;
01785         break;
01786 
01787       case WID_GS_HELP_TEXT: {
01788         static const StringID setting_types[] = {
01789           STR_CONFIG_SETTING_TYPE_CLIENT,
01790           STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
01791           STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
01792         };
01793         for (uint i = 0; i < lengthof(setting_types); i++) {
01794           SetDParam(0, setting_types[i]);
01795           size->width = max(size->width, GetStringBoundingBox(STR_CONFIG_SETTING_TYPE).width);
01796         }
01797         size->height = 2 * FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL +
01798             max(size->height, _settings_main_page.GetMaxHelpHeight(size->width));
01799         break;
01800       }
01801 
01802       default:
01803         break;
01804     }
01805   }
01806 
01807   virtual void OnPaint()
01808   {
01809     if (this->closing_dropdown) {
01810       this->closing_dropdown = false;
01811       assert(this->valuedropdown_entry != NULL);
01812       this->valuedropdown_entry->SetButtons(0);
01813       this->valuedropdown_entry = NULL;
01814     }
01815     this->DrawWidgets();
01816   }
01817 
01818   virtual void SetStringParameters(int widget) const
01819   {
01820     switch (widget) {
01821       case WID_GS_RESTRICT_DROPDOWN:
01822         SetDParam(0, _game_settings_restrict_dropdown[this->cur_restriction_mode]);
01823         break;
01824     }
01825   }
01826 
01827   DropDownList *BuildDropDownList(int widget) const
01828   {
01829     DropDownList *list = NULL;
01830     switch (widget) {
01831       case WID_GS_RESTRICT_DROPDOWN:
01832         list = new DropDownList();
01833 
01834         for (int mode = 0; mode != RM_END; mode++) {
01835           /* If we are in adv. settings screen for the new game's settings,
01836            * we don't want to allow comparing with new game's settings. */
01837           bool disabled = mode == RM_CHANGED_AGAINST_NEW && settings_ptr == &_settings_newgame;
01838 
01839           list->push_back(new DropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
01840         }
01841         break;
01842     }
01843     return list;
01844   }
01845 
01846   virtual void DrawWidget(const Rect &r, int widget) const
01847   {
01848     switch (widget) {
01849       case WID_GS_OPTIONSPANEL:
01850         _settings_main_page.Draw(settings_ptr, r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, r.top + SETTINGTREE_TOP_OFFSET,
01851             this->vscroll->GetPosition(), this->vscroll->GetPosition() + this->vscroll->GetCapacity(), this->last_clicked);
01852         break;
01853 
01854       case WID_GS_HELP_TEXT:
01855         if (this->last_clicked != NULL) {
01856           const SettingDesc *sd = this->last_clicked->d.entry.setting;
01857 
01858           int y = r.top;
01859           if (sd->desc.flags & SGF_PER_COMPANY) {
01860             SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME);
01861           } else if (sd->save.conv & SLF_NOT_IN_SAVE) {
01862             SetDParam(0, STR_CONFIG_SETTING_TYPE_CLIENT);
01863           } else {
01864             SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME);
01865           }
01866           DrawString(r.left, r.right, y, STR_CONFIG_SETTING_TYPE);
01867           y += FONT_HEIGHT_NORMAL;
01868 
01869           int32 default_value = ReadValue(&sd->desc.def, sd->save.conv);
01870           this->last_clicked->SetValueDParams(0, default_value);
01871           DrawString(r.left, r.right, y, STR_CONFIG_SETTING_DEFAULT_VALUE);
01872           y += FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
01873 
01874           DrawStringMultiLine(r.left, r.right, y, r.bottom, this->last_clicked->GetHelpText(), TC_WHITE);
01875         }
01876         break;
01877 
01878       default:
01879         break;
01880     }
01881   }
01882 
01887   void SetDisplayedHelpText(SettingEntry *pe)
01888   {
01889     if (this->last_clicked != pe) this->SetDirty();
01890     this->last_clicked = pe;
01891   }
01892 
01893   virtual void OnClick(Point pt, int widget, int click_count)
01894   {
01895     switch (widget) {
01896       case WID_GS_EXPAND_ALL:
01897         this->manually_changed_folding = true;
01898         _settings_main_page.UnFoldAll();
01899         this->InvalidateData();
01900         break;
01901 
01902       case WID_GS_COLLAPSE_ALL:
01903         this->manually_changed_folding = true;
01904         _settings_main_page.FoldAll();
01905         this->InvalidateData();
01906         break;
01907 
01908       case WID_GS_RESTRICT_DROPDOWN: {
01909         DropDownList *list = this->BuildDropDownList(widget);
01910         if (list != NULL) {
01911           ShowDropDownList(this, list, this->cur_restriction_mode, widget);
01912         }
01913       }
01914     }
01915 
01916     if (widget != WID_GS_OPTIONSPANEL) return;
01917 
01918     uint btn = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GS_OPTIONSPANEL, SETTINGTREE_TOP_OFFSET);
01919     if (btn == INT_MAX) return;
01920 
01921     uint cur_row = 0;
01922     SettingEntry *pe = _settings_main_page.FindEntry(btn, &cur_row);
01923 
01924     if (pe == NULL) return;  // Clicked below the last setting of the page
01925 
01926     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
01927     if (x < 0) return;  // Clicked left of the entry
01928 
01929     if ((pe->flags & SEF_KIND_MASK) == SEF_SUBTREE_KIND) {
01930       this->SetDisplayedHelpText(NULL);
01931       pe->d.sub.folded = !pe->d.sub.folded; // Flip 'folded'-ness of the sub-page
01932 
01933       this->manually_changed_folding = true;
01934 
01935       this->InvalidateData();
01936       return;
01937     }
01938 
01939     assert((pe->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
01940     const SettingDesc *sd = pe->d.entry.setting;
01941 
01942     /* return if action is only active in network, or only settable by server */
01943     if (!sd->IsEditable()) {
01944       this->SetDisplayedHelpText(pe);
01945       return;
01946     }
01947 
01948     const void *var = ResolveVariableAddress(settings_ptr, sd);
01949     int32 value = (int32)ReadValue(var, sd->save.conv);
01950 
01951     /* clicked on the icon on the left side. Either scroller, bool on/off or dropdown */
01952     if (x < SETTING_BUTTON_WIDTH && (sd->desc.flags & SGF_MULTISTRING)) {
01953       const SettingDescBase *sdb = &sd->desc;
01954       this->SetDisplayedHelpText(pe);
01955 
01956       if (this->valuedropdown_entry == pe) {
01957         /* unclick the dropdown */
01958         HideDropDownMenu(this);
01959         this->closing_dropdown = false;
01960         this->valuedropdown_entry->SetButtons(0);
01961         this->valuedropdown_entry = NULL;
01962       } else {
01963         if (this->valuedropdown_entry != NULL) this->valuedropdown_entry->SetButtons(0);
01964         this->closing_dropdown = false;
01965 
01966         const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GS_OPTIONSPANEL);
01967         int rel_y = (pt.y - (int)wid->pos_y - SETTINGTREE_TOP_OFFSET) % wid->resize_y;
01968 
01969         Rect wi_rect;
01970         wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
01971         wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
01972         wi_rect.top = pt.y - rel_y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
01973         wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
01974 
01975         /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
01976         if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
01977           this->valuedropdown_entry = pe;
01978           this->valuedropdown_entry->SetButtons(SEF_LEFT_DEPRESSED);
01979 
01980           DropDownList *list = new DropDownList();
01981           for (int i = sdb->min; i <= (int)sdb->max; i++) {
01982             list->push_back(new DropDownListStringItem(sdb->str_val + i - sdb->min, i, false));
01983           }
01984 
01985           ShowDropDownListAt(this, list, value, -1, wi_rect, COLOUR_ORANGE, true);
01986         }
01987       }
01988       this->SetDirty();
01989     } else if (x < SETTING_BUTTON_WIDTH) {
01990       this->SetDisplayedHelpText(pe);
01991       const SettingDescBase *sdb = &sd->desc;
01992       int32 oldvalue = value;
01993 
01994       switch (sdb->cmd) {
01995         case SDT_BOOLX: value ^= 1; break;
01996         case SDT_ONEOFMANY:
01997         case SDT_NUMX: {
01998           /* Add a dynamic step-size to the scroller. In a maximum of
01999            * 50-steps you should be able to get from min to max,
02000            * unless specified otherwise in the 'interval' variable
02001            * of the current setting. */
02002           uint32 step = (sdb->interval == 0) ? ((sdb->max - sdb->min) / 50) : sdb->interval;
02003           if (step == 0) step = 1;
02004 
02005           /* don't allow too fast scrolling */
02006           if ((this->flags & WF_TIMEOUT) && this->timeout_timer > 1) {
02007             _left_button_clicked = false;
02008             return;
02009           }
02010 
02011           /* Increase or decrease the value and clamp it to extremes */
02012           if (x >= SETTING_BUTTON_WIDTH / 2) {
02013             value += step;
02014             if (sdb->min < 0) {
02015               assert((int32)sdb->max >= 0);
02016               if (value > (int32)sdb->max) value = (int32)sdb->max;
02017             } else {
02018               if ((uint32)value > sdb->max) value = (int32)sdb->max;
02019             }
02020             if (value < sdb->min) value = sdb->min; // skip between "disabled" and minimum
02021           } else {
02022             value -= step;
02023             if (value < sdb->min) value = (sdb->flags & SGF_0ISDISABLED) ? 0 : sdb->min;
02024           }
02025 
02026           /* Set up scroller timeout for numeric values */
02027           if (value != oldvalue) {
02028             if (this->clicked_entry != NULL) { // Release previous buttons if any
02029               this->clicked_entry->SetButtons(0);
02030             }
02031             this->clicked_entry = pe;
02032             this->clicked_entry->SetButtons((x >= SETTING_BUTTON_WIDTH / 2) != (_current_text_dir == TD_RTL) ? SEF_RIGHT_DEPRESSED : SEF_LEFT_DEPRESSED);
02033             this->SetTimeout();
02034             _left_button_clicked = false;
02035           }
02036           break;
02037         }
02038 
02039         default: NOT_REACHED();
02040       }
02041 
02042       if (value != oldvalue) {
02043         if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
02044           SetCompanySetting(pe->d.entry.index, value);
02045         } else {
02046           SetSettingValue(pe->d.entry.index, value);
02047         }
02048         this->SetDirty();
02049       }
02050     } else {
02051       /* Only open editbox if clicked for the second time, and only for types where it is sensible for. */
02052       if (this->last_clicked == pe && sd->desc.cmd != SDT_BOOLX && !(sd->desc.flags & SGF_MULTISTRING)) {
02053         /* Show the correct currency-translated value */
02054         if (sd->desc.flags & SGF_CURRENCY) value *= _currency->rate;
02055 
02056         this->valuewindow_entry = pe;
02057         SetDParam(0, value);
02058         ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 10, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
02059       }
02060       this->SetDisplayedHelpText(pe);
02061     }
02062   }
02063 
02064   virtual void OnTimeout()
02065   {
02066     if (this->clicked_entry != NULL) { // On timeout, release any depressed buttons
02067       this->clicked_entry->SetButtons(0);
02068       this->clicked_entry = NULL;
02069       this->SetDirty();
02070     }
02071   }
02072 
02073   virtual void OnQueryTextFinished(char *str)
02074   {
02075     /* The user pressed cancel */
02076     if (str == NULL) return;
02077 
02078     assert(this->valuewindow_entry != NULL);
02079     assert((this->valuewindow_entry->flags & SEF_KIND_MASK) == SEF_SETTING_KIND);
02080     const SettingDesc *sd = this->valuewindow_entry->d.entry.setting;
02081 
02082     int32 value;
02083     if (!StrEmpty(str)) {
02084       value = atoi(str);
02085 
02086       /* Save the correct currency-translated value */
02087       if (sd->desc.flags & SGF_CURRENCY) value /= _currency->rate;
02088     } else {
02089       value = (int32)(size_t)sd->desc.def;
02090     }
02091 
02092     if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
02093       SetCompanySetting(this->valuewindow_entry->d.entry.index, value);
02094     } else {
02095       SetSettingValue(this->valuewindow_entry->d.entry.index, value);
02096     }
02097     this->SetDirty();
02098   }
02099 
02100   virtual void OnDropdownSelect(int widget, int index)
02101   {
02102     if (widget == WID_GS_RESTRICT_DROPDOWN) {
02103       this->cur_restriction_mode = (RestrictionMode)index;
02104       if (this->cur_restriction_mode == RM_CHANGED_AGAINST_DEFAULT ||
02105           this->cur_restriction_mode == RM_CHANGED_AGAINST_DEFAULT_WO_LOCAL ||
02106           this->cur_restriction_mode == RM_CHANGED_AGAINST_NEW) {
02107 
02108         if (!this->manually_changed_folding) {
02109           /* Expand all when selecting 'changes'. Update the filter state first, in case it becomes less restrictive in some cases. */
02110           _settings_main_page.UpdateFilterState(string_filter, false, this->cur_restriction_mode);
02111           _settings_main_page.UnFoldAll();
02112         }
02113       } else {
02114         /* Non-'changes' filter. Save as default. */
02115         _settings_client.gui.settings_restriction_mode = this->cur_restriction_mode;
02116       }
02117       this->InvalidateData();
02118       return;
02119     }
02120 
02121     /* Deal with drop down boxes on the panel. */
02122     assert(this->valuedropdown_entry != NULL);
02123     const SettingDesc *sd = this->valuedropdown_entry->d.entry.setting;
02124     assert(sd->desc.flags & SGF_MULTISTRING);
02125 
02126     if ((sd->desc.flags & SGF_PER_COMPANY) != 0) {
02127       SetCompanySetting(this->valuedropdown_entry->d.entry.index, index);
02128     } else {
02129       SetSettingValue(this->valuedropdown_entry->d.entry.index, index);
02130     }
02131 
02132     this->SetDirty();
02133   }
02134 
02135   virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
02136   {
02137     if (widget == WID_GS_RESTRICT_DROPDOWN) {
02138       /* Normally the default implementation of OnDropdownClose() takes care of
02139        * a few things. We want that behaviour here too, but only for this one
02140        * "normal" dropdown box. The special dropdown boxes added for every
02141        * setting that needs one can't have this call. */
02142       Window::OnDropdownClose(pt, widget, index, instant_close);
02143       return;
02144     }
02145 
02146     /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
02147      * the same dropdown button was clicked again, and then not open the dropdown again.
02148      * So, we only remember that it was closed, and process it on the next OnPaint, which is
02149      * after OnClick. */
02150     assert(this->valuedropdown_entry != NULL);
02151     this->closing_dropdown = true;
02152     this->SetDirty();
02153   }
02154 
02155   virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
02156   {
02157     if (!gui_scope) return;
02158 
02159     _settings_main_page.UpdateFilterState(string_filter, false, this->cur_restriction_mode);
02160 
02161     this->vscroll->SetCount(_settings_main_page.Length());
02162 
02163     if (this->last_clicked != NULL && !_settings_main_page.IsVisible(this->last_clicked)) {
02164       this->SetDisplayedHelpText(NULL);
02165     }
02166 
02167     bool all_folded = true;
02168     bool all_unfolded = true;
02169     _settings_main_page.GetFoldingState(all_folded, all_unfolded);
02170     this->SetWidgetDisabledState(WID_GS_EXPAND_ALL, all_unfolded);
02171     this->SetWidgetDisabledState(WID_GS_COLLAPSE_ALL, all_folded);
02172   }
02173 
02174   virtual void OnEditboxChanged(int wid)
02175   {
02176     if (wid == WID_GS_FILTER) {
02177       string_filter.SetFilterTerm(this->filter_editbox.text.buf);
02178       if (!string_filter.IsEmpty() && !this->manually_changed_folding) {
02179         /* User never expanded/collapsed single pages and entered a filter term.
02180          * Expand everything, to save weird expand clicks, */
02181         _settings_main_page.UnFoldAll();
02182       }
02183       this->InvalidateData();
02184     }
02185   }
02186 
02187   virtual void OnResize()
02188   {
02189     this->vscroll->SetCapacityFromWidget(this, WID_GS_OPTIONSPANEL, SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET);
02190   }
02191 };
02192 
02193 GameSettings *GameSettingsWindow::settings_ptr = NULL;
02194 
02195 static const NWidgetPart _nested_settings_selection_widgets[] = {
02196   NWidget(NWID_HORIZONTAL),
02197     NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
02198     NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_CONFIG_SETTING_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
02199   EndContainer(),
02200   NWidget(WWT_PANEL, COLOUR_MAUVE),
02201     NWidget(NWID_HORIZONTAL), SetPadding(WD_TEXTPANEL_TOP, 0, WD_TEXTPANEL_BOTTOM, 0),
02202         SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_RIGHT),
02203       NWidget(WWT_TEXT, COLOUR_MAUVE, WID_GS_RESTRICT_LABEL), SetDataTip(STR_CONFIG_SETTING_RESTRICT_LABEL, STR_NULL),
02204       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),
02205     EndContainer(),
02206     NWidget(NWID_HORIZONTAL), SetPadding(0, 0, WD_TEXTPANEL_BOTTOM, 0),
02207         SetPIP(WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_RIGHT),
02208       NWidget(WWT_TEXT, COLOUR_MAUVE), SetFill(0, 1), SetDataTip(STR_CONFIG_SETTING_FILTER_TITLE, STR_NULL),
02209       NWidget(WWT_EDITBOX, COLOUR_MAUVE, WID_GS_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
02210           SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
02211     EndContainer(),
02212   EndContainer(),
02213   NWidget(NWID_HORIZONTAL),
02214     NWidget(WWT_PANEL, COLOUR_MAUVE, WID_GS_OPTIONSPANEL), SetMinimalSize(400, 174), SetScrollbar(WID_GS_SCROLLBAR), EndContainer(),
02215     NWidget(NWID_VERTICAL),
02216       NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_GS_SCROLLBAR),
02217     EndContainer(),
02218   EndContainer(),
02219   NWidget(WWT_PANEL, COLOUR_MAUVE), SetMinimalSize(400, 40),
02220     NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GS_HELP_TEXT), SetMinimalSize(300, 25), SetFill(1, 1), SetResize(1, 0),
02221         SetPadding(WD_FRAMETEXT_TOP, WD_FRAMETEXT_RIGHT, WD_FRAMETEXT_BOTTOM, WD_FRAMETEXT_LEFT),
02222     NWidget(NWID_HORIZONTAL),
02223       NWidget(WWT_PANEL, COLOUR_MAUVE),
02224         NWidget(NWID_HORIZONTAL),
02225           NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_EXPAND_ALL), SetDataTip(STR_CONFIG_SETTING_EXPAND_ALL, STR_NULL),
02226           NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_COLLAPSE_ALL), SetDataTip(STR_CONFIG_SETTING_COLLAPSE_ALL, STR_NULL),
02227           NWidget(NWID_SPACER, INVALID_COLOUR), SetFill(1, 1), SetResize(1, 0),
02228         EndContainer(),
02229       EndContainer(),
02230       NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
02231     EndContainer(),
02232   EndContainer(),
02233 };
02234 
02235 static const WindowDesc _settings_selection_desc(
02236   WDP_CENTER, 510, 450,
02237   WC_GAME_OPTIONS, WC_NONE,
02238   0,
02239   _nested_settings_selection_widgets, lengthof(_nested_settings_selection_widgets)
02240 );
02241 
02243 void ShowGameSettings()
02244 {
02245   DeleteWindowByClass(WC_GAME_OPTIONS);
02246   new GameSettingsWindow(&_settings_selection_desc);
02247 }
02248 
02249 
02259 void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
02260 {
02261   int colour = _colour_gradient[button_colour][2];
02262 
02263   DrawFrameRect(x,                            y, x + SETTING_BUTTON_WIDTH / 2 - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, (state == 1) ? FR_LOWERED : FR_NONE);
02264   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);
02265   DrawSprite(SPR_ARROW_LEFT, PAL_NONE, x + WD_IMGBTN_LEFT, y + WD_IMGBTN_TOP);
02266   DrawSprite(SPR_ARROW_RIGHT, PAL_NONE, x + WD_IMGBTN_LEFT + SETTING_BUTTON_WIDTH / 2, y + WD_IMGBTN_TOP);
02267 
02268   /* Grey out the buttons that aren't clickable */
02269   bool rtl = _current_text_dir == TD_RTL;
02270   if (rtl ? !clickable_right : !clickable_left) {
02271     GfxFillRect(x                            + 1, y, x + SETTING_BUTTON_WIDTH / 2 - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
02272   }
02273   if (rtl ? !clickable_left : !clickable_right) {
02274     GfxFillRect(x + SETTING_BUTTON_WIDTH / 2 + 1, y, x + SETTING_BUTTON_WIDTH     - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
02275   }
02276 }
02277 
02286 void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
02287 {
02288   static const char *DOWNARROW = "\xEE\x8A\xAA";
02289 
02290   int colour = _colour_gradient[button_colour][2];
02291 
02292   DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, state ? FR_LOWERED : FR_NONE);
02293   DrawString(x + (state ? 1 : 0), x + SETTING_BUTTON_WIDTH - (state ? 0 : 1), y + (state ? 2 : 1), DOWNARROW, TC_BLACK, SA_HOR_CENTER);
02294 
02295   if (!clickable) {
02296     GfxFillRect(x +  1, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
02297   }
02298 }
02299 
02307 void DrawBoolButton(int x, int y, bool state, bool clickable)
02308 {
02309   static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
02310   DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, _bool_ctabs[state][clickable], state ? FR_LOWERED : FR_NONE);
02311 }
02312 
02313 struct CustomCurrencyWindow : Window {
02314   int query_widget;
02315 
02316   CustomCurrencyWindow(const WindowDesc *desc) : Window()
02317   {
02318     this->InitNested(desc);
02319 
02320     SetButtonState();
02321   }
02322 
02323   void SetButtonState()
02324   {
02325     this->SetWidgetDisabledState(WID_CC_RATE_DOWN, _custom_currency.rate == 1);
02326     this->SetWidgetDisabledState(WID_CC_RATE_UP, _custom_currency.rate == UINT16_MAX);
02327     this->SetWidgetDisabledState(WID_CC_YEAR_DOWN, _custom_currency.to_euro == CF_NOEURO);
02328     this->SetWidgetDisabledState(WID_CC_YEAR_UP, _custom_currency.to_euro == MAX_YEAR);
02329   }
02330 
02331   virtual void SetStringParameters(int widget) const
02332   {
02333     switch (widget) {
02334       case WID_CC_RATE:      SetDParam(0, 1); SetDParam(1, 1);            break;
02335       case WID_CC_SEPARATOR: SetDParamStr(0, _custom_currency.separator); break;
02336       case WID_CC_PREFIX:    SetDParamStr(0, _custom_currency.prefix);    break;
02337       case WID_CC_SUFFIX:    SetDParamStr(0, _custom_currency.suffix);    break;
02338       case WID_CC_YEAR:
02339         SetDParam(0, (_custom_currency.to_euro != CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER);
02340         SetDParam(1, _custom_currency.to_euro);
02341         break;
02342 
02343       case WID_CC_PREVIEW:
02344         SetDParam(0, 10000);
02345         break;
02346     }
02347   }
02348 
02349   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
02350   {
02351     switch (widget) {
02352       /* Set the appropriate width for the edit 'buttons' */
02353       case WID_CC_SEPARATOR_EDIT:
02354       case WID_CC_PREFIX_EDIT:
02355       case WID_CC_SUFFIX_EDIT:
02356         size->width  = this->GetWidget<NWidgetBase>(WID_CC_RATE_DOWN)->smallest_x + this->GetWidget<NWidgetBase>(WID_CC_RATE_UP)->smallest_x;
02357         break;
02358 
02359       /* Make sure the window is wide enough for the widest exchange rate */
02360       case WID_CC_RATE:
02361         SetDParam(0, 1);
02362         SetDParam(1, INT32_MAX);
02363         *size = GetStringBoundingBox(STR_CURRENCY_EXCHANGE_RATE);
02364         break;
02365     }
02366   }
02367 
02368   virtual void OnClick(Point pt, int widget, int click_count)
02369   {
02370     int line = 0;
02371     int len = 0;
02372     StringID str = 0;
02373     CharSetFilter afilter = CS_ALPHANUMERAL;
02374 
02375     switch (widget) {
02376       case WID_CC_RATE_DOWN:
02377         if (_custom_currency.rate > 1) _custom_currency.rate--;
02378         if (_custom_currency.rate == 1) this->DisableWidget(WID_CC_RATE_DOWN);
02379         this->EnableWidget(WID_CC_RATE_UP);
02380         break;
02381 
02382       case WID_CC_RATE_UP:
02383         if (_custom_currency.rate < UINT16_MAX) _custom_currency.rate++;
02384         if (_custom_currency.rate == UINT16_MAX) this->DisableWidget(WID_CC_RATE_UP);
02385         this->EnableWidget(WID_CC_RATE_DOWN);
02386         break;
02387 
02388       case WID_CC_RATE:
02389         SetDParam(0, _custom_currency.rate);
02390         str = STR_JUST_INT;
02391         len = 5;
02392         line = WID_CC_RATE;
02393         afilter = CS_NUMERAL;
02394         break;
02395 
02396       case WID_CC_SEPARATOR_EDIT:
02397       case WID_CC_SEPARATOR:
02398         SetDParamStr(0, _custom_currency.separator);
02399         str = STR_JUST_RAW_STRING;
02400         len = 1;
02401         line = WID_CC_SEPARATOR;
02402         break;
02403 
02404       case WID_CC_PREFIX_EDIT:
02405       case WID_CC_PREFIX:
02406         SetDParamStr(0, _custom_currency.prefix);
02407         str = STR_JUST_RAW_STRING;
02408         len = 12;
02409         line = WID_CC_PREFIX;
02410         break;
02411 
02412       case WID_CC_SUFFIX_EDIT:
02413       case WID_CC_SUFFIX:
02414         SetDParamStr(0, _custom_currency.suffix);
02415         str = STR_JUST_RAW_STRING;
02416         len = 12;
02417         line = WID_CC_SUFFIX;
02418         break;
02419 
02420       case WID_CC_YEAR_DOWN:
02421         _custom_currency.to_euro = (_custom_currency.to_euro <= 2000) ? CF_NOEURO : _custom_currency.to_euro - 1;
02422         if (_custom_currency.to_euro == CF_NOEURO) this->DisableWidget(WID_CC_YEAR_DOWN);
02423         this->EnableWidget(WID_CC_YEAR_UP);
02424         break;
02425 
02426       case WID_CC_YEAR_UP:
02427         _custom_currency.to_euro = Clamp(_custom_currency.to_euro + 1, 2000, MAX_YEAR);
02428         if (_custom_currency.to_euro == MAX_YEAR) this->DisableWidget(WID_CC_YEAR_UP);
02429         this->EnableWidget(WID_CC_YEAR_DOWN);
02430         break;
02431 
02432       case WID_CC_YEAR:
02433         SetDParam(0, _custom_currency.to_euro);
02434         str = STR_JUST_INT;
02435         len = 7;
02436         line = WID_CC_YEAR;
02437         afilter = CS_NUMERAL;
02438         break;
02439     }
02440 
02441     if (len != 0) {
02442       this->query_widget = line;
02443       ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1, this, afilter, QSF_NONE);
02444     }
02445 
02446     this->SetTimeout();
02447     this->SetDirty();
02448   }
02449 
02450   virtual void OnQueryTextFinished(char *str)
02451   {
02452     if (str == NULL) return;
02453 
02454     switch (this->query_widget) {
02455       case WID_CC_RATE:
02456         _custom_currency.rate = Clamp(atoi(str), 1, UINT16_MAX);
02457         break;
02458 
02459       case WID_CC_SEPARATOR: // Thousands seperator
02460         strecpy(_custom_currency.separator, str, lastof(_custom_currency.separator));
02461         break;
02462 
02463       case WID_CC_PREFIX:
02464         strecpy(_custom_currency.prefix, str, lastof(_custom_currency.prefix));
02465         break;
02466 
02467       case WID_CC_SUFFIX:
02468         strecpy(_custom_currency.suffix, str, lastof(_custom_currency.suffix));
02469         break;
02470 
02471       case WID_CC_YEAR: { // Year to switch to euro
02472         int val = atoi(str);
02473 
02474         _custom_currency.to_euro = (val < 2000 ? CF_NOEURO : min(val, MAX_YEAR));
02475         break;
02476       }
02477     }
02478     MarkWholeScreenDirty();
02479     SetButtonState();
02480   }
02481 
02482   virtual void OnTimeout()
02483   {
02484     this->SetDirty();
02485   }
02486 };
02487 
02488 static const NWidgetPart _nested_cust_currency_widgets[] = {
02489   NWidget(NWID_HORIZONTAL),
02490     NWidget(WWT_CLOSEBOX, COLOUR_GREY),
02491     NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CURRENCY_WINDOW, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
02492   EndContainer(),
02493   NWidget(WWT_PANEL, COLOUR_GREY),
02494     NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(7, 3, 0),
02495       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
02496         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_EXCHANGE_RATE_TOOLTIP),
02497         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_EXCHANGE_RATE_TOOLTIP),
02498         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
02499         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_RATE), SetDataTip(STR_CURRENCY_EXCHANGE_RATE, STR_CURRENCY_SET_EXCHANGE_RATE_TOOLTIP), SetFill(1, 0),
02500       EndContainer(),
02501       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
02502         NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SEPARATOR_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(0, 1),
02503         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
02504         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SEPARATOR), SetDataTip(STR_CURRENCY_SEPARATOR, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(1, 0),
02505       EndContainer(),
02506       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
02507         NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_PREFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(0, 1),
02508         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
02509         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_PREFIX), SetDataTip(STR_CURRENCY_PREFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(1, 0),
02510       EndContainer(),
02511       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
02512         NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SUFFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(0, 1),
02513         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
02514         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SUFFIX), SetDataTip(STR_CURRENCY_SUFFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(1, 0),
02515       EndContainer(),
02516       NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
02517         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
02518         NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
02519         NWidget(NWID_SPACER), SetMinimalSize(5, 0),
02520         NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_YEAR), SetDataTip(STR_JUST_STRING, STR_CURRENCY_SET_CUSTOM_CURRENCY_TO_EURO_TOOLTIP), SetFill(1, 0),
02521       EndContainer(),
02522     EndContainer(),
02523     NWidget(WWT_LABEL, COLOUR_BLUE, WID_CC_PREVIEW),
02524                 SetDataTip(STR_CURRENCY_PREVIEW, STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP), SetPadding(15, 1, 18, 2),
02525   EndContainer(),
02526 };
02527 
02528 static const WindowDesc _cust_currency_desc(
02529   WDP_CENTER, 0, 0,
02530   WC_CUSTOM_CURRENCY, WC_NONE,
02531   0,
02532   _nested_cust_currency_widgets, lengthof(_nested_cust_currency_widgets)
02533 );
02534 
02536 static void ShowCustCurrency()
02537 {
02538   DeleteWindowById(WC_CUSTOM_CURRENCY, 0);
02539   new CustomCurrencyWindow(&_cust_currency_desc);
02540 }