settings.cpp

Go to the documentation of this file.
00001 /* $Id: settings.cpp 24843 2012-12-23 21:07:12Z 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 
00026 #include "stdafx.h"
00027 #include "currency.h"
00028 #include "screenshot.h"
00029 #include "network/network.h"
00030 #include "network/network_func.h"
00031 #include "settings_internal.h"
00032 #include "command_func.h"
00033 #include "console_func.h"
00034 #include "pathfinder/pathfinder_type.h"
00035 #include "genworld.h"
00036 #include "train.h"
00037 #include "news_func.h"
00038 #include "window_func.h"
00039 #include "sound_func.h"
00040 #include "company_func.h"
00041 #include "rev.h"
00042 #ifdef WITH_FREETYPE
00043 #include "fontcache.h"
00044 #endif
00045 #include "textbuf_gui.h"
00046 #include "rail_gui.h"
00047 #include "elrail_func.h"
00048 #include "error.h"
00049 #include "town.h"
00050 #include "video/video_driver.hpp"
00051 #include "sound/sound_driver.hpp"
00052 #include "music/music_driver.hpp"
00053 #include "blitter/factory.hpp"
00054 #include "base_media_base.h"
00055 #include "gamelog.h"
00056 #include "settings_func.h"
00057 #include "ini_type.h"
00058 #include "ai/ai_config.hpp"
00059 #include "ai/ai.hpp"
00060 #include "game/game_config.hpp"
00061 #include "game/game.hpp"
00062 #include "ship.h"
00063 #include "smallmap_gui.h"
00064 #include "roadveh.h"
00065 #include "fios.h"
00066 #include "strings_func.h"
00067 
00068 #include "void_map.h"
00069 #include "station_base.h"
00070 
00071 #include "table/strings.h"
00072 #include "table/settings.h"
00073 
00074 ClientSettings _settings_client;
00075 GameSettings _settings_game;     
00076 GameSettings _settings_newgame;  
00077 VehicleDefaultSettings _old_vds; 
00078 char *_config_file; 
00079 
00080 typedef std::list<ErrorMessageData> ErrorList;
00081 static ErrorList _settings_error_list; 
00082 
00083 
00084 typedef void SettingDescProc(IniFile *ini, const SettingDesc *desc, const char *grpname, void *object);
00085 typedef void SettingDescProcList(IniFile *ini, const char *grpname, StringList *list);
00086 
00087 static bool IsSignedVarMemType(VarType vt);
00088 
00092 static const char * const _list_group_names[] = {
00093   "bans",
00094   "newgrf",
00095   "servers",
00096   "server_bind_addresses",
00097   NULL
00098 };
00099 
00107 static size_t LookupOneOfMany(const char *many, const char *one, size_t onelen = 0)
00108 {
00109   const char *s;
00110   size_t idx;
00111 
00112   if (onelen == 0) onelen = strlen(one);
00113 
00114   /* check if it's an integer */
00115   if (*one >= '0' && *one <= '9') return strtoul(one, NULL, 0);
00116 
00117   idx = 0;
00118   for (;;) {
00119     /* find end of item */
00120     s = many;
00121     while (*s != '|' && *s != 0) s++;
00122     if ((size_t)(s - many) == onelen && !memcmp(one, many, onelen)) return idx;
00123     if (*s == 0) return (size_t)-1;
00124     many = s + 1;
00125     idx++;
00126   }
00127 }
00128 
00136 static size_t LookupManyOfMany(const char *many, const char *str)
00137 {
00138   const char *s;
00139   size_t r;
00140   size_t res = 0;
00141 
00142   for (;;) {
00143     /* skip "whitespace" */
00144     while (*str == ' ' || *str == '\t' || *str == '|') str++;
00145     if (*str == 0) break;
00146 
00147     s = str;
00148     while (*s != 0 && *s != ' ' && *s != '\t' && *s != '|') s++;
00149 
00150     r = LookupOneOfMany(many, str, s - str);
00151     if (r == (size_t)-1) return r;
00152 
00153     SetBit(res, (uint8)r); // value found, set it
00154     if (*s == 0) break;
00155     str = s + 1;
00156   }
00157   return res;
00158 }
00159 
00168 static int ParseIntList(const char *p, int *items, int maxitems)
00169 {
00170   int n = 0; // number of items read so far
00171   bool comma = false; // do we accept comma?
00172 
00173   while (*p != '\0') {
00174     switch (*p) {
00175       case ',':
00176         /* Do not accept multiple commas between numbers */
00177         if (!comma) return -1;
00178         comma = false;
00179         /* FALL THROUGH */
00180       case ' ':
00181         p++;
00182         break;
00183 
00184       default: {
00185         if (n == maxitems) return -1; // we don't accept that many numbers
00186         char *end;
00187         long v = strtol(p, &end, 0);
00188         if (p == end) return -1; // invalid character (not a number)
00189         if (sizeof(int) < sizeof(long)) v = ClampToI32(v);
00190         items[n++] = v;
00191         p = end; // first non-number
00192         comma = true; // we accept comma now
00193         break;
00194       }
00195     }
00196   }
00197 
00198   /* If we have read comma but no number after it, fail.
00199    * We have read comma when (n != 0) and comma is not allowed */
00200   if (n != 0 && !comma) return -1;
00201 
00202   return n;
00203 }
00204 
00213 static bool LoadIntList(const char *str, void *array, int nelems, VarType type)
00214 {
00215   int items[64];
00216   int i, nitems;
00217 
00218   if (str == NULL) {
00219     memset(items, 0, sizeof(items));
00220     nitems = nelems;
00221   } else {
00222     nitems = ParseIntList(str, items, lengthof(items));
00223     if (nitems != nelems) return false;
00224   }
00225 
00226   switch (type) {
00227     case SLE_VAR_BL:
00228     case SLE_VAR_I8:
00229     case SLE_VAR_U8:
00230       for (i = 0; i != nitems; i++) ((byte*)array)[i] = items[i];
00231       break;
00232 
00233     case SLE_VAR_I16:
00234     case SLE_VAR_U16:
00235       for (i = 0; i != nitems; i++) ((uint16*)array)[i] = items[i];
00236       break;
00237 
00238     case SLE_VAR_I32:
00239     case SLE_VAR_U32:
00240       for (i = 0; i != nitems; i++) ((uint32*)array)[i] = items[i];
00241       break;
00242 
00243     default: NOT_REACHED();
00244   }
00245 
00246   return true;
00247 }
00248 
00258 static void MakeIntList(char *buf, const char *last, const void *array, int nelems, VarType type)
00259 {
00260   int i, v = 0;
00261   const byte *p = (const byte *)array;
00262 
00263   for (i = 0; i != nelems; i++) {
00264     switch (type) {
00265       case SLE_VAR_BL:
00266       case SLE_VAR_I8:  v = *(const   int8 *)p; p += 1; break;
00267       case SLE_VAR_U8:  v = *(const  uint8 *)p; p += 1; break;
00268       case SLE_VAR_I16: v = *(const  int16 *)p; p += 2; break;
00269       case SLE_VAR_U16: v = *(const uint16 *)p; p += 2; break;
00270       case SLE_VAR_I32: v = *(const  int32 *)p; p += 4; break;
00271       case SLE_VAR_U32: v = *(const uint32 *)p; p += 4; break;
00272       default: NOT_REACHED();
00273     }
00274     buf += seprintf(buf, last, (i == 0) ? "%d" : ",%d", v);
00275   }
00276 }
00277 
00285 static void MakeOneOfMany(char *buf, const char *last, const char *many, int id)
00286 {
00287   int orig_id = id;
00288 
00289   /* Look for the id'th element */
00290   while (--id >= 0) {
00291     for (; *many != '|'; many++) {
00292       if (*many == '\0') { // not found
00293         seprintf(buf, last, "%d", orig_id);
00294         return;
00295       }
00296     }
00297     many++; // pass the |-character
00298   }
00299 
00300   /* copy string until next item (|) or the end of the list if this is the last one */
00301   while (*many != '\0' && *many != '|' && buf < last) *buf++ = *many++;
00302   *buf = '\0';
00303 }
00304 
00313 static void MakeManyOfMany(char *buf, const char *last, const char *many, uint32 x)
00314 {
00315   const char *start;
00316   int i = 0;
00317   bool init = true;
00318 
00319   for (; x != 0; x >>= 1, i++) {
00320     start = many;
00321     while (*many != 0 && *many != '|') many++; // advance to the next element
00322 
00323     if (HasBit(x, 0)) { // item found, copy it
00324       if (!init) buf += seprintf(buf, last, "|");
00325       init = false;
00326       if (start == many) {
00327         buf += seprintf(buf, last, "%d", i);
00328       } else {
00329         memcpy(buf, start, many - start);
00330         buf += many - start;
00331       }
00332     }
00333 
00334     if (*many == '|') many++;
00335   }
00336 
00337   *buf = '\0';
00338 }
00339 
00346 static const void *StringToVal(const SettingDescBase *desc, const char *orig_str)
00347 {
00348   const char *str = orig_str == NULL ? "" : orig_str;
00349 
00350   switch (desc->cmd) {
00351     case SDT_NUMX: {
00352       char *end;
00353       size_t val = strtoul(str, &end, 0);
00354       if (end == str) {
00355         ErrorMessageData msg(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_VALUE);
00356         msg.SetDParamStr(0, str);
00357         msg.SetDParamStr(1, desc->name);
00358         _settings_error_list.push_back(msg);
00359         return desc->def;
00360       }
00361       if (*end != '\0') {
00362         ErrorMessageData msg(STR_CONFIG_ERROR, STR_CONFIG_ERROR_TRAILING_CHARACTERS);
00363         msg.SetDParamStr(0, desc->name);
00364         _settings_error_list.push_back(msg);
00365       }
00366       return (void*)val;
00367     }
00368 
00369     case SDT_ONEOFMANY: {
00370       size_t r = LookupOneOfMany(desc->many, str);
00371       /* if the first attempt of conversion from string to the appropriate value fails,
00372        * look if we have defined a converter from old value to new value. */
00373       if (r == (size_t)-1 && desc->proc_cnvt != NULL) r = desc->proc_cnvt(str);
00374       if (r != (size_t)-1) return (void*)r; // and here goes converted value
00375 
00376       ErrorMessageData msg(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_VALUE);
00377       msg.SetDParamStr(0, str);
00378       msg.SetDParamStr(1, desc->name);
00379       _settings_error_list.push_back(msg);
00380       return desc->def;
00381     }
00382 
00383     case SDT_MANYOFMANY: {
00384       size_t r = LookupManyOfMany(desc->many, str);
00385       if (r != (size_t)-1) return (void*)r;
00386       ErrorMessageData msg(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_VALUE);
00387       msg.SetDParamStr(0, str);
00388       msg.SetDParamStr(1, desc->name);
00389       _settings_error_list.push_back(msg);
00390       return desc->def;
00391     }
00392 
00393     case SDT_BOOLX: {
00394       if (strcmp(str, "true")  == 0 || strcmp(str, "on")  == 0 || strcmp(str, "1") == 0) return (void*)true;
00395       if (strcmp(str, "false") == 0 || strcmp(str, "off") == 0 || strcmp(str, "0") == 0) return (void*)false;
00396 
00397       ErrorMessageData msg(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_VALUE);
00398       msg.SetDParamStr(0, str);
00399       msg.SetDParamStr(1, desc->name);
00400       _settings_error_list.push_back(msg);
00401       return desc->def;
00402     }
00403 
00404     case SDT_STRING: return orig_str;
00405     case SDT_INTLIST: return str;
00406     default: break;
00407   }
00408 
00409   return NULL;
00410 }
00411 
00421 static void Write_ValidateSetting(void *ptr, const SettingDesc *sd, int32 val)
00422 {
00423   const SettingDescBase *sdb = &sd->desc;
00424 
00425   if (sdb->cmd != SDT_BOOLX &&
00426       sdb->cmd != SDT_NUMX &&
00427       sdb->cmd != SDT_ONEOFMANY &&
00428       sdb->cmd != SDT_MANYOFMANY) {
00429     return;
00430   }
00431 
00432   /* We cannot know the maximum value of a bitset variable, so just have faith */
00433   if (sdb->cmd != SDT_MANYOFMANY) {
00434     /* We need to take special care of the uint32 type as we receive from the function
00435      * a signed integer. While here also bail out on 64-bit settings as those are not
00436      * supported. Unsigned 8 and 16-bit variables are safe since they fit into a signed
00437      * 32-bit variable
00438      * TODO: Support 64-bit settings/variables */
00439     switch (GetVarMemType(sd->save.conv)) {
00440       case SLE_VAR_NULL: return;
00441       case SLE_VAR_BL:
00442       case SLE_VAR_I8:
00443       case SLE_VAR_U8:
00444       case SLE_VAR_I16:
00445       case SLE_VAR_U16:
00446       case SLE_VAR_I32: {
00447         /* Override the minimum value. No value below sdb->min, except special value 0 */
00448         if (!(sdb->flags & SGF_0ISDISABLED) || val != 0) val = Clamp(val, sdb->min, sdb->max);
00449         break;
00450       }
00451       case SLE_VAR_U32: {
00452         /* Override the minimum value. No value below sdb->min, except special value 0 */
00453         uint min = ((sdb->flags & SGF_0ISDISABLED) && (uint)val <= (uint)sdb->min) ? 0 : sdb->min;
00454         WriteValue(ptr, SLE_VAR_U32, (int64)ClampU(val, min, sdb->max));
00455         return;
00456       }
00457       case SLE_VAR_I64:
00458       case SLE_VAR_U64:
00459       default: NOT_REACHED();
00460     }
00461   }
00462 
00463   WriteValue(ptr, sd->save.conv, (int64)val);
00464 }
00465 
00474 static void IniLoadSettings(IniFile *ini, const SettingDesc *sd, const char *grpname, void *object)
00475 {
00476   IniGroup *group;
00477   IniGroup *group_def = ini->GetGroup(grpname);
00478   IniItem *item;
00479   const void *p;
00480   void *ptr;
00481   const char *s;
00482 
00483   for (; sd->save.cmd != SL_END; sd++) {
00484     const SettingDescBase *sdb = &sd->desc;
00485     const SaveLoad        *sld = &sd->save;
00486 
00487     if (!SlIsObjectCurrentlyValid(sld->version_from, sld->version_to)) continue;
00488 
00489     /* For settings.xx.yy load the settings from [xx] yy = ? */
00490     s = strchr(sdb->name, '.');
00491     if (s != NULL) {
00492       group = ini->GetGroup(sdb->name, s - sdb->name);
00493       s++;
00494     } else {
00495       s = sdb->name;
00496       group = group_def;
00497     }
00498 
00499     item = group->GetItem(s, false);
00500     if (item == NULL && group != group_def) {
00501       /* For settings.xx.yy load the settings from [settingss] yy = ? in case the previous
00502        * did not exist (e.g. loading old config files with a [settings] section */
00503       item = group_def->GetItem(s, false);
00504     }
00505     if (item == NULL) {
00506       /* For settings.xx.zz.yy load the settings from [zz] yy = ? in case the previous
00507        * did not exist (e.g. loading old config files with a [yapf] section */
00508       const char *sc = strchr(s, '.');
00509       if (sc != NULL) item = ini->GetGroup(s, sc - s)->GetItem(sc + 1, false);
00510     }
00511 
00512     p = (item == NULL) ? sdb->def : StringToVal(sdb, item->value);
00513     ptr = GetVariableAddress(object, sld);
00514 
00515     switch (sdb->cmd) {
00516       case SDT_BOOLX: // All four are various types of (integer) numbers
00517       case SDT_NUMX:
00518       case SDT_ONEOFMANY:
00519       case SDT_MANYOFMANY:
00520         Write_ValidateSetting(ptr, sd, (int32)(size_t)p);
00521         break;
00522 
00523       case SDT_STRING:
00524         switch (GetVarMemType(sld->conv)) {
00525           case SLE_VAR_STRB:
00526           case SLE_VAR_STRBQ:
00527             if (p != NULL) ttd_strlcpy((char*)ptr, (const char*)p, sld->length);
00528             break;
00529 
00530           case SLE_VAR_STR:
00531           case SLE_VAR_STRQ:
00532             free(*(char**)ptr);
00533             *(char**)ptr = p == NULL ? NULL : strdup((const char*)p);
00534             break;
00535 
00536           case SLE_VAR_CHAR: if (p != NULL) *(char *)ptr = *(const char *)p; break;
00537 
00538           default: NOT_REACHED();
00539         }
00540         break;
00541 
00542       case SDT_INTLIST: {
00543         if (!LoadIntList((const char*)p, ptr, sld->length, GetVarMemType(sld->conv))) {
00544           ErrorMessageData msg(STR_CONFIG_ERROR, STR_CONFIG_ERROR_ARRAY);
00545           msg.SetDParamStr(0, sdb->name);
00546           _settings_error_list.push_back(msg);
00547 
00548           /* Use default */
00549           LoadIntList((const char*)sdb->def, ptr, sld->length, GetVarMemType(sld->conv));
00550         } else if (sd->desc.proc_cnvt != NULL) {
00551           sd->desc.proc_cnvt((const char*)p);
00552         }
00553         break;
00554       }
00555       default: NOT_REACHED();
00556     }
00557   }
00558 }
00559 
00572 static void IniSaveSettings(IniFile *ini, const SettingDesc *sd, const char *grpname, void *object)
00573 {
00574   IniGroup *group_def = NULL, *group;
00575   IniItem *item;
00576   char buf[512];
00577   const char *s;
00578   void *ptr;
00579 
00580   for (; sd->save.cmd != SL_END; sd++) {
00581     const SettingDescBase *sdb = &sd->desc;
00582     const SaveLoad        *sld = &sd->save;
00583 
00584     /* If the setting is not saved to the configuration
00585      * file, just continue with the next setting */
00586     if (!SlIsObjectCurrentlyValid(sld->version_from, sld->version_to)) continue;
00587     if (sld->conv & SLF_NOT_IN_CONFIG) continue;
00588 
00589     /* XXX - wtf is this?? (group override?) */
00590     s = strchr(sdb->name, '.');
00591     if (s != NULL) {
00592       group = ini->GetGroup(sdb->name, s - sdb->name);
00593       s++;
00594     } else {
00595       if (group_def == NULL) group_def = ini->GetGroup(grpname);
00596       s = sdb->name;
00597       group = group_def;
00598     }
00599 
00600     item = group->GetItem(s, true);
00601     ptr = GetVariableAddress(object, sld);
00602 
00603     if (item->value != NULL) {
00604       /* check if the value is the same as the old value */
00605       const void *p = StringToVal(sdb, item->value);
00606 
00607       /* The main type of a variable/setting is in bytes 8-15
00608        * The subtype (what kind of numbers do we have there) is in 0-7 */
00609       switch (sdb->cmd) {
00610         case SDT_BOOLX:
00611         case SDT_NUMX:
00612         case SDT_ONEOFMANY:
00613         case SDT_MANYOFMANY:
00614           switch (GetVarMemType(sld->conv)) {
00615             case SLE_VAR_BL:
00616               if (*(bool*)ptr == (p != NULL)) continue;
00617               break;
00618 
00619             case SLE_VAR_I8:
00620             case SLE_VAR_U8:
00621               if (*(byte*)ptr == (byte)(size_t)p) continue;
00622               break;
00623 
00624             case SLE_VAR_I16:
00625             case SLE_VAR_U16:
00626               if (*(uint16*)ptr == (uint16)(size_t)p) continue;
00627               break;
00628 
00629             case SLE_VAR_I32:
00630             case SLE_VAR_U32:
00631               if (*(uint32*)ptr == (uint32)(size_t)p) continue;
00632               break;
00633 
00634             default: NOT_REACHED();
00635           }
00636           break;
00637 
00638         default: break; // Assume the other types are always changed
00639       }
00640     }
00641 
00642     /* Value has changed, get the new value and put it into a buffer */
00643     switch (sdb->cmd) {
00644       case SDT_BOOLX:
00645       case SDT_NUMX:
00646       case SDT_ONEOFMANY:
00647       case SDT_MANYOFMANY: {
00648         uint32 i = (uint32)ReadValue(ptr, sld->conv);
00649 
00650         switch (sdb->cmd) {
00651           case SDT_BOOLX:      strecpy(buf, (i != 0) ? "true" : "false", lastof(buf)); break;
00652           case SDT_NUMX:       seprintf(buf, lastof(buf), IsSignedVarMemType(sld->conv) ? "%d" : "%u", i); break;
00653           case SDT_ONEOFMANY:  MakeOneOfMany(buf, lastof(buf), sdb->many, i); break;
00654           case SDT_MANYOFMANY: MakeManyOfMany(buf, lastof(buf), sdb->many, i); break;
00655           default: NOT_REACHED();
00656         }
00657         break;
00658       }
00659 
00660       case SDT_STRING:
00661         switch (GetVarMemType(sld->conv)) {
00662           case SLE_VAR_STRB: strecpy(buf, (char*)ptr, lastof(buf)); break;
00663           case SLE_VAR_STRBQ:seprintf(buf, lastof(buf), "\"%s\"", (char*)ptr); break;
00664           case SLE_VAR_STR:  strecpy(buf, *(char**)ptr, lastof(buf)); break;
00665 
00666           case SLE_VAR_STRQ:
00667             if (*(char**)ptr == NULL) {
00668               buf[0] = '\0';
00669             } else {
00670               seprintf(buf, lastof(buf), "\"%s\"", *(char**)ptr);
00671             }
00672             break;
00673 
00674           case SLE_VAR_CHAR: buf[0] = *(char*)ptr; buf[1] = '\0'; break;
00675           default: NOT_REACHED();
00676         }
00677         break;
00678 
00679       case SDT_INTLIST:
00680         MakeIntList(buf, lastof(buf), ptr, sld->length, GetVarMemType(sld->conv));
00681         break;
00682 
00683       default: NOT_REACHED();
00684     }
00685 
00686     /* The value is different, that means we have to write it to the ini */
00687     free(item->value);
00688     item->value = strdup(buf);
00689   }
00690 }
00691 
00701 static void IniLoadSettingList(IniFile *ini, const char *grpname, StringList *list)
00702 {
00703   IniGroup *group = ini->GetGroup(grpname);
00704 
00705   if (group == NULL || list == NULL) return;
00706 
00707   list->Clear();
00708 
00709   for (const IniItem *item = group->item; item != NULL; item = item->next) {
00710     if (item->name != NULL) *list->Append() = strdup(item->name);
00711   }
00712 }
00713 
00723 static void IniSaveSettingList(IniFile *ini, const char *grpname, StringList *list)
00724 {
00725   IniGroup *group = ini->GetGroup(grpname);
00726 
00727   if (group == NULL || list == NULL) return;
00728   group->Clear();
00729 
00730   for (char **iter = list->Begin(); iter != list->End(); iter++) {
00731     group->GetItem(*iter, true)->SetValue("");
00732   }
00733 }
00734 
00740 bool SettingDesc::IsEditable(bool do_command) const
00741 {
00742   if (!do_command && !(this->save.conv & SLF_NO_NETWORK_SYNC) && _networking && !_network_server && !(this->desc.flags & SGF_PER_COMPANY)) return false;
00743   if ((this->desc.flags & SGF_NETWORK_ONLY) && !_networking && _game_mode != GM_MENU) return false;
00744   if ((this->desc.flags & SGF_NO_NETWORK) && _networking) return false;
00745   if ((this->desc.flags & SGF_NEWGAME_ONLY) &&
00746       (_game_mode == GM_NORMAL ||
00747       (_game_mode == GM_EDITOR && !(this->desc.flags & SGF_SCENEDIT_TOO)))) return false;
00748   return true;
00749 }
00750 
00751 /* Begin - Callback Functions for the various settings. */
00752 
00754 static bool v_PositionMainToolbar(int32 p1)
00755 {
00756   if (_game_mode != GM_MENU) PositionMainToolbar(NULL);
00757   return true;
00758 }
00759 
00761 static bool v_PositionStatusbar(int32 p1)
00762 {
00763   if (_game_mode != GM_MENU) {
00764     PositionStatusbar(NULL);
00765     PositionNewsMessage(NULL);
00766     PositionNetworkChatWindow(NULL);
00767   }
00768   return true;
00769 }
00770 
00771 static bool PopulationInLabelActive(int32 p1)
00772 {
00773   UpdateAllTownVirtCoords();
00774   return true;
00775 }
00776 
00777 static bool RedrawScreen(int32 p1)
00778 {
00779   MarkWholeScreenDirty();
00780   return true;
00781 }
00782 
00788 static bool RedrawSmallmap(int32 p1)
00789 {
00790   BuildLandLegend();
00791   BuildOwnerLegend();
00792   SetWindowClassesDirty(WC_SMALLMAP);
00793   return true;
00794 }
00795 
00796 static bool InvalidateDetailsWindow(int32 p1)
00797 {
00798   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00799   return true;
00800 }
00801 
00802 static bool InvalidateStationBuildWindow(int32 p1)
00803 {
00804   SetWindowDirty(WC_BUILD_STATION, 0);
00805   return true;
00806 }
00807 
00808 static bool InvalidateBuildIndustryWindow(int32 p1)
00809 {
00810   InvalidateWindowData(WC_BUILD_INDUSTRY, 0);
00811   return true;
00812 }
00813 
00814 static bool CloseSignalGUI(int32 p1)
00815 {
00816   if (p1 == 0) {
00817     DeleteWindowByClass(WC_BUILD_SIGNAL);
00818   }
00819   return true;
00820 }
00821 
00822 static bool InvalidateTownViewWindow(int32 p1)
00823 {
00824   InvalidateWindowClassesData(WC_TOWN_VIEW, p1);
00825   return true;
00826 }
00827 
00828 static bool DeleteSelectStationWindow(int32 p1)
00829 {
00830   DeleteWindowById(WC_SELECT_STATION, 0);
00831   return true;
00832 }
00833 
00834 static bool UpdateConsists(int32 p1)
00835 {
00836   Train *t;
00837   FOR_ALL_TRAINS(t) {
00838     /* Update the consist of all trains so the maximum speed is set correctly. */
00839     if (t->IsFrontEngine() || t->IsFreeWagon()) t->ConsistChanged(true);
00840   }
00841   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00842   return true;
00843 }
00844 
00845 /* Check service intervals of vehicles, p1 is value of % or day based servicing */
00846 static bool CheckInterval(int32 p1)
00847 {
00848   VehicleDefaultSettings *vds;
00849   if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
00850     vds = &_settings_client.company.vehicle;
00851   } else {
00852     vds = &Company::Get(_current_company)->settings.vehicle;
00853   }
00854 
00855   if (p1 != 0) {
00856     vds->servint_trains   = 50;
00857     vds->servint_roadveh  = 50;
00858     vds->servint_aircraft = 50;
00859     vds->servint_ships    = 50;
00860   } else {
00861     vds->servint_trains   = 150;
00862     vds->servint_roadveh  = 150;
00863     vds->servint_aircraft = 100;
00864     vds->servint_ships    = 360;
00865   }
00866 
00867   InvalidateDetailsWindow(0);
00868 
00869   return true;
00870 }
00871 
00872 static bool TrainAccelerationModelChanged(int32 p1)
00873 {
00874   Train *t;
00875   FOR_ALL_TRAINS(t) {
00876     if (t->IsFrontEngine()) {
00877       t->tcache.cached_max_curve_speed = t->GetCurveSpeedLimit();
00878       t->UpdateAcceleration();
00879     }
00880   }
00881 
00882   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00883   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00884   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00885   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00886 
00887   return true;
00888 }
00889 
00895 static bool TrainSlopeSteepnessChanged(int32 p1)
00896 {
00897   Train *t;
00898   FOR_ALL_TRAINS(t) {
00899     if (t->IsFrontEngine()) t->CargoChanged();
00900   }
00901 
00902   return true;
00903 }
00904 
00910 static bool RoadVehAccelerationModelChanged(int32 p1)
00911 {
00912   if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) {
00913     RoadVehicle *rv;
00914     FOR_ALL_ROADVEHICLES(rv) {
00915       if (rv->IsFrontEngine()) {
00916         rv->CargoChanged();
00917       }
00918     }
00919   }
00920 
00921   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00922   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00923   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00924   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00925 
00926   return true;
00927 }
00928 
00934 static bool RoadVehSlopeSteepnessChanged(int32 p1)
00935 {
00936   RoadVehicle *rv;
00937   FOR_ALL_ROADVEHICLES(rv) {
00938     if (rv->IsFrontEngine()) rv->CargoChanged();
00939   }
00940 
00941   return true;
00942 }
00943 
00944 static bool DragSignalsDensityChanged(int32)
00945 {
00946   InvalidateWindowData(WC_BUILD_SIGNAL, 0);
00947 
00948   return true;
00949 }
00950 
00951 static bool TownFoundingChanged(int32 p1)
00952 {
00953   if (_game_mode != GM_EDITOR && _settings_game.economy.found_town == TF_FORBIDDEN) {
00954     DeleteWindowById(WC_FOUND_TOWN, 0);
00955     return true;
00956   }
00957   InvalidateWindowData(WC_FOUND_TOWN, 0);
00958   return true;
00959 }
00960 
00961 static bool InvalidateVehTimetableWindow(int32 p1)
00962 {
00963   InvalidateWindowClassesData(WC_VEHICLE_TIMETABLE, VIWD_MODIFY_ORDERS);
00964   return true;
00965 }
00966 
00967 static bool ZoomMinMaxChanged(int32 p1)
00968 {
00969   extern void ConstrainAllViewportsZoom();
00970   ConstrainAllViewportsZoom();
00971   GfxClearSpriteCache();
00972   return true;
00973 }
00974 
00982 static bool InvalidateNewGRFChangeWindows(int32 p1)
00983 {
00984   InvalidateWindowClassesData(WC_SAVELOAD);
00985   DeleteWindowByClass(WC_GAME_OPTIONS);
00986   ReInitAllWindows();
00987   return true;
00988 }
00989 
00990 static bool InvalidateCompanyLiveryWindow(int32 p1)
00991 {
00992   InvalidateWindowClassesData(WC_COMPANY_COLOUR);
00993   return RedrawScreen(p1);
00994 }
00995 
00996 static bool InvalidateIndustryViewWindow(int32 p1)
00997 {
00998   InvalidateWindowClassesData(WC_INDUSTRY_VIEW);
00999   return true;
01000 }
01001 
01002 static bool InvalidateAISettingsWindow(int32 p1)
01003 {
01004   InvalidateWindowClassesData(WC_AI_SETTINGS);
01005   return true;
01006 }
01007 
01013 static bool RedrawTownAuthority(int32 p1)
01014 {
01015   SetWindowClassesDirty(WC_TOWN_AUTHORITY);
01016   return true;
01017 }
01018 
01024 static bool InvalidateCompanyInfrastructureWindow(int32 p1)
01025 {
01026   InvalidateWindowClassesData(WC_COMPANY_INFRASTRUCTURE);
01027   return true;
01028 }
01029 
01031 static void ValidateSettings()
01032 {
01033   /* Do not allow a custom sea level with the original land generator. */
01034   if (_settings_newgame.game_creation.land_generator == 0 &&
01035       _settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
01036     _settings_newgame.difficulty.quantity_sea_lakes = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE;
01037   }
01038 }
01039 
01040 static bool DifficultyNoiseChange(int32 i)
01041 {
01042   if (_game_mode == GM_NORMAL) {
01043     UpdateAirportsNoise();
01044     if (_settings_game.economy.station_noise_level) {
01045       InvalidateWindowClassesData(WC_TOWN_VIEW, 0);
01046     }
01047   }
01048 
01049   return true;
01050 }
01051 
01052 static bool MaxNoAIsChange(int32 i)
01053 {
01054   if (GetGameSettings().difficulty.max_no_competitors != 0 &&
01055       AI::GetInfoList()->size() == 0 &&
01056       (!_networking || _network_server)) {
01057     ShowErrorMessage(STR_WARNING_NO_SUITABLE_AI, INVALID_STRING_ID, WL_CRITICAL);
01058   }
01059 
01060   return true;
01061 }
01062 
01068 static bool CheckRoadSide(int p1)
01069 {
01070   extern bool RoadVehiclesAreBuilt();
01071   return _game_mode == GM_MENU || !RoadVehiclesAreBuilt();
01072 }
01073 
01081 static size_t ConvertLandscape(const char *value)
01082 {
01083   /* try with the old values */
01084   return LookupOneOfMany("normal|hilly|desert|candy", value);
01085 }
01086 
01087 static bool CheckFreeformEdges(int32 p1)
01088 {
01089   if (_game_mode == GM_MENU) return true;
01090   if (p1 != 0) {
01091     Ship *s;
01092     FOR_ALL_SHIPS(s) {
01093       /* Check if there is a ship on the northern border. */
01094       if (TileX(s->tile) == 0 || TileY(s->tile) == 0) {
01095         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01096         return false;
01097       }
01098     }
01099     BaseStation *st;
01100     FOR_ALL_BASE_STATIONS(st) {
01101       /* Check if there is a non-deleted buoy on the northern border. */
01102       if (st->IsInUse() && (TileX(st->xy) == 0 || TileY(st->xy) == 0)) {
01103         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01104         return false;
01105       }
01106     }
01107     for (uint i = 0; i < MapSizeX(); i++) MakeVoid(TileXY(i, 0));
01108     for (uint i = 0; i < MapSizeY(); i++) MakeVoid(TileXY(0, i));
01109   } else {
01110     for (uint i = 0; i < MapMaxX(); i++) {
01111       if (TileHeight(TileXY(i, 1)) != 0) {
01112         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01113         return false;
01114       }
01115     }
01116     for (uint i = 1; i < MapMaxX(); i++) {
01117       if (!IsTileType(TileXY(i, MapMaxY() - 1), MP_WATER) || TileHeight(TileXY(1, MapMaxY())) != 0) {
01118         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01119         return false;
01120       }
01121     }
01122     for (uint i = 0; i < MapMaxY(); i++) {
01123       if (TileHeight(TileXY(1, i)) != 0) {
01124         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01125         return false;
01126       }
01127     }
01128     for (uint i = 1; i < MapMaxY(); i++) {
01129       if (!IsTileType(TileXY(MapMaxX() - 1, i), MP_WATER) || TileHeight(TileXY(MapMaxX(), i)) != 0) {
01130         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01131         return false;
01132       }
01133     }
01134     /* Make tiles at the border water again. */
01135     for (uint i = 0; i < MapMaxX(); i++) {
01136       SetTileHeight(TileXY(i, 0), 0);
01137       SetTileType(TileXY(i, 0), MP_WATER);
01138     }
01139     for (uint i = 0; i < MapMaxY(); i++) {
01140       SetTileHeight(TileXY(0, i), 0);
01141       SetTileType(TileXY(0, i), MP_WATER);
01142     }
01143   }
01144   MarkWholeScreenDirty();
01145   return true;
01146 }
01147 
01152 static bool ChangeDynamicEngines(int32 p1)
01153 {
01154   if (_game_mode == GM_MENU) return true;
01155 
01156   if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
01157     ShowErrorMessage(STR_CONFIG_SETTING_DYNAMIC_ENGINES_EXISTING_VEHICLES, INVALID_STRING_ID, WL_ERROR);
01158     return false;
01159   }
01160 
01161   return true;
01162 }
01163 
01164 static bool StationCatchmentChanged(int32 p1)
01165 {
01166   Station::RecomputeIndustriesNearForAll();
01167   return true;
01168 }
01169 
01170 
01171 #ifdef ENABLE_NETWORK
01172 
01173 static bool UpdateClientName(int32 p1)
01174 {
01175   NetworkUpdateClientName();
01176   return true;
01177 }
01178 
01179 static bool UpdateServerPassword(int32 p1)
01180 {
01181   if (strcmp(_settings_client.network.server_password, "*") == 0) {
01182     _settings_client.network.server_password[0] = '\0';
01183   }
01184 
01185   return true;
01186 }
01187 
01188 static bool UpdateRconPassword(int32 p1)
01189 {
01190   if (strcmp(_settings_client.network.rcon_password, "*") == 0) {
01191     _settings_client.network.rcon_password[0] = '\0';
01192   }
01193 
01194   return true;
01195 }
01196 
01197 static bool UpdateClientConfigValues(int32 p1)
01198 {
01199   if (_network_server) NetworkServerSendConfigUpdate();
01200 
01201   return true;
01202 }
01203 
01204 #endif /* ENABLE_NETWORK */
01205 
01206 
01207 /* End - Callback Functions */
01208 
01212 static void PrepareOldDiffCustom()
01213 {
01214   memset(_old_diff_custom, 0, sizeof(_old_diff_custom));
01215 }
01216 
01223 static void HandleOldDiffCustom(bool savegame)
01224 {
01225   uint options_to_load = GAME_DIFFICULTY_NUM - ((savegame && IsSavegameVersionBefore(4)) ? 1 : 0);
01226 
01227   if (!savegame) {
01228     /* If we did read to old_diff_custom, then at least one value must be non 0. */
01229     bool old_diff_custom_used = false;
01230     for (uint i = 0; i < options_to_load && !old_diff_custom_used; i++) {
01231       old_diff_custom_used = (_old_diff_custom[i] != 0);
01232     }
01233 
01234     if (!old_diff_custom_used) return;
01235   }
01236 
01237   for (uint i = 0; i < options_to_load; i++) {
01238     const SettingDesc *sd = &_settings[i];
01239     /* Skip deprecated options */
01240     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01241     void *var = GetVariableAddress(savegame ? &_settings_game : &_settings_newgame, &sd->save);
01242     Write_ValidateSetting(var, sd, (int32)((i == 4 ? 1000 : 1) * _old_diff_custom[i]));
01243   }
01244 }
01245 
01246 static void AILoadConfig(IniFile *ini, const char *grpname)
01247 {
01248   IniGroup *group = ini->GetGroup(grpname);
01249   IniItem *item;
01250 
01251   /* Clean any configured AI */
01252   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01253     AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01254   }
01255 
01256   /* If no group exists, return */
01257   if (group == NULL) return;
01258 
01259   CompanyID c = COMPANY_FIRST;
01260   for (item = group->item; c < MAX_COMPANIES && item != NULL; c++, item = item->next) {
01261     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01262 
01263     config->Change(item->name);
01264     if (!config->HasScript()) {
01265       if (strcmp(item->name, "none") != 0) {
01266         DEBUG(script, 0, "The AI by the name '%s' was no longer found, and removed from the list.", item->name);
01267         continue;
01268       }
01269     }
01270     if (item->value != NULL) config->StringToSettings(item->value);
01271   }
01272 }
01273 
01274 static void GameLoadConfig(IniFile *ini, const char *grpname)
01275 {
01276   IniGroup *group = ini->GetGroup(grpname);
01277   IniItem *item;
01278 
01279   /* Clean any configured GameScript */
01280   GameConfig::GetConfig(GameConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01281 
01282   /* If no group exists, return */
01283   if (group == NULL) return;
01284 
01285   item = group->item;
01286   if (item == NULL) return;
01287 
01288   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01289 
01290   config->Change(item->name);
01291   if (!config->HasScript()) {
01292     if (strcmp(item->name, "none") != 0) {
01293       DEBUG(script, 0, "The GameScript by the name '%s' was no longer found, and removed from the list.", item->name);
01294       return;
01295     }
01296   }
01297   if (item->value != NULL) config->StringToSettings(item->value);
01298 }
01299 
01306 static GRFConfig *GRFLoadConfig(IniFile *ini, const char *grpname, bool is_static)
01307 {
01308   IniGroup *group = ini->GetGroup(grpname);
01309   IniItem *item;
01310   GRFConfig *first = NULL;
01311   GRFConfig **curr = &first;
01312 
01313   if (group == NULL) return NULL;
01314 
01315   for (item = group->item; item != NULL; item = item->next) {
01316     GRFConfig *c = new GRFConfig(item->name);
01317 
01318     /* Parse parameters */
01319     if (!StrEmpty(item->value)) {
01320       c->num_params = ParseIntList(item->value, (int*)c->param, lengthof(c->param));
01321       if (c->num_params == (byte)-1) {
01322         SetDParamStr(0, item->name);
01323         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_ARRAY, WL_CRITICAL);
01324         c->num_params = 0;
01325       }
01326     }
01327 
01328     /* Check if item is valid */
01329     if (!FillGRFDetails(c, is_static) || HasBit(c->flags, GCF_INVALID)) {
01330       if (c->status == GCS_NOT_FOUND) {
01331         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_NOT_FOUND);
01332       } else if (HasBit(c->flags, GCF_UNSAFE)) {
01333         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNSAFE);
01334       } else if (HasBit(c->flags, GCF_SYSTEM)) {
01335         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_SYSTEM);
01336       } else if (HasBit(c->flags, GCF_INVALID)) {
01337         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_INCOMPATIBLE);
01338       } else {
01339         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNKNOWN);
01340       }
01341 
01342       SetDParamStr(0, item->name);
01343       ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_GRF, WL_CRITICAL);
01344       delete c;
01345       continue;
01346     }
01347 
01348     /* Check for duplicate GRFID (will also check for duplicate filenames) */
01349     bool duplicate = false;
01350     for (const GRFConfig *gc = first; gc != NULL; gc = gc->next) {
01351       if (gc->ident.grfid == c->ident.grfid) {
01352         SetDParamStr(0, item->name);
01353         SetDParamStr(1, gc->filename);
01354         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_DUPLICATE_GRFID, WL_CRITICAL);
01355         duplicate = true;
01356         break;
01357       }
01358     }
01359     if (duplicate) {
01360       delete c;
01361       continue;
01362     }
01363 
01364     /* Mark file as static to avoid saving in savegame. */
01365     if (is_static) SetBit(c->flags, GCF_STATIC);
01366 
01367     /* Add item to list */
01368     *curr = c;
01369     curr = &c->next;
01370   }
01371 
01372   return first;
01373 }
01374 
01375 static void AISaveConfig(IniFile *ini, const char *grpname)
01376 {
01377   IniGroup *group = ini->GetGroup(grpname);
01378 
01379   if (group == NULL) return;
01380   group->Clear();
01381 
01382   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01383     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01384     const char *name;
01385     char value[1024];
01386     config->SettingsToString(value, lengthof(value));
01387 
01388     if (config->HasScript()) {
01389       name = config->GetName();
01390     } else {
01391       name = "none";
01392     }
01393 
01394     IniItem *item = new IniItem(group, name, strlen(name));
01395     item->SetValue(value);
01396   }
01397 }
01398 
01399 static void GameSaveConfig(IniFile *ini, const char *grpname)
01400 {
01401   IniGroup *group = ini->GetGroup(grpname);
01402 
01403   if (group == NULL) return;
01404   group->Clear();
01405 
01406   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01407   const char *name;
01408   char value[1024];
01409   config->SettingsToString(value, lengthof(value));
01410 
01411   if (config->HasScript()) {
01412     name = config->GetName();
01413   } else {
01414     name = "none";
01415   }
01416 
01417   IniItem *item = new IniItem(group, name, strlen(name));
01418   item->SetValue(value);
01419 }
01420 
01425 static void SaveVersionInConfig(IniFile *ini)
01426 {
01427   IniGroup *group = ini->GetGroup("version");
01428 
01429   char version[9];
01430   snprintf(version, lengthof(version), "%08X", _openttd_newgrf_version);
01431 
01432   const char * const versions[][2] = {
01433     { "version_string", _openttd_revision },
01434     { "version_number", version }
01435   };
01436 
01437   for (uint i = 0; i < lengthof(versions); i++) {
01438     group->GetItem(versions[i][0], true)->SetValue(versions[i][1]);
01439   }
01440 }
01441 
01442 /* Save a GRF configuration to the given group name */
01443 static void GRFSaveConfig(IniFile *ini, const char *grpname, const GRFConfig *list)
01444 {
01445   ini->RemoveGroup(grpname);
01446   IniGroup *group = ini->GetGroup(grpname);
01447   const GRFConfig *c;
01448 
01449   for (c = list; c != NULL; c = c->next) {
01450     char params[512];
01451     GRFBuildParamList(params, c, lastof(params));
01452 
01453     group->GetItem(c->filename, true)->SetValue(params);
01454   }
01455 }
01456 
01457 /* Common handler for saving/loading variables to the configuration file */
01458 static void HandleSettingDescs(IniFile *ini, SettingDescProc *proc, SettingDescProcList *proc_list, bool basic_settings = true, bool other_settings = true)
01459 {
01460   if (basic_settings) {
01461     proc(ini, (const SettingDesc*)_misc_settings,    "misc",  NULL);
01462 #if defined(WIN32) && !defined(DEDICATED)
01463     proc(ini, (const SettingDesc*)_win32_settings,   "win32", NULL);
01464 #endif /* WIN32 */
01465   }
01466 
01467   if (other_settings) {
01468     proc(ini, _settings,         "patches",  &_settings_newgame);
01469     proc(ini, _currency_settings,"currency", &_custom_currency);
01470     proc(ini, _company_settings, "company",  &_settings_client.company);
01471 
01472 #ifdef ENABLE_NETWORK
01473     proc_list(ini, "server_bind_addresses", &_network_bind_list);
01474     proc_list(ini, "servers", &_network_host_list);
01475     proc_list(ini, "bans",    &_network_ban_list);
01476 #endif /* ENABLE_NETWORK */
01477   }
01478 }
01479 
01480 static IniFile *IniLoadConfig()
01481 {
01482   IniFile *ini = new IniFile(_list_group_names);
01483   ini->LoadFromDisk(_config_file, BASE_DIR);
01484   return ini;
01485 }
01486 
01491 void LoadFromConfig(bool minimal)
01492 {
01493   IniFile *ini = IniLoadConfig();
01494   if (!minimal) ResetCurrencies(false); // Initialize the array of curencies, without preserving the custom one
01495 
01496   /* Load basic settings only during bootstrap, load other settings not during bootstrap */
01497   HandleSettingDescs(ini, IniLoadSettings, IniLoadSettingList, minimal, !minimal);
01498 
01499   if (!minimal) {
01500     _grfconfig_newgame = GRFLoadConfig(ini, "newgrf", false);
01501     _grfconfig_static  = GRFLoadConfig(ini, "newgrf-static", true);
01502     AILoadConfig(ini, "ai_players");
01503     GameLoadConfig(ini, "game_scripts");
01504 
01505     PrepareOldDiffCustom();
01506     IniLoadSettings(ini, _gameopt_settings, "gameopt", &_settings_newgame);
01507     HandleOldDiffCustom(false);
01508 
01509     ValidateSettings();
01510 
01511     /* Display sheduled errors */
01512     extern void ScheduleErrorMessage(ErrorList &datas);
01513     ScheduleErrorMessage(_settings_error_list);
01514     if (FindWindowById(WC_ERRMSG, 0) == NULL) ShowFirstError();
01515   }
01516 
01517   delete ini;
01518 }
01519 
01521 void SaveToConfig()
01522 {
01523   IniFile *ini = IniLoadConfig();
01524 
01525   /* Remove some obsolete groups. These have all been loaded into other groups. */
01526   ini->RemoveGroup("patches");
01527   ini->RemoveGroup("yapf");
01528   ini->RemoveGroup("gameopt");
01529 
01530   HandleSettingDescs(ini, IniSaveSettings, IniSaveSettingList);
01531   GRFSaveConfig(ini, "newgrf", _grfconfig_newgame);
01532   GRFSaveConfig(ini, "newgrf-static", _grfconfig_static);
01533   AISaveConfig(ini, "ai_players");
01534   GameSaveConfig(ini, "game_scripts");
01535   SaveVersionInConfig(ini);
01536   ini->SaveToDisk(_config_file);
01537   delete ini;
01538 }
01539 
01544 void GetGRFPresetList(GRFPresetList *list)
01545 {
01546   list->Clear();
01547 
01548   IniFile *ini = IniLoadConfig();
01549   IniGroup *group;
01550   for (group = ini->group; group != NULL; group = group->next) {
01551     if (strncmp(group->name, "preset-", 7) == 0) {
01552       *list->Append() = strdup(group->name + 7);
01553     }
01554   }
01555 
01556   delete ini;
01557 }
01558 
01565 GRFConfig *LoadGRFPresetFromConfig(const char *config_name)
01566 {
01567   char *section = (char*)alloca(strlen(config_name) + 8);
01568   sprintf(section, "preset-%s", config_name);
01569 
01570   IniFile *ini = IniLoadConfig();
01571   GRFConfig *config = GRFLoadConfig(ini, section, false);
01572   delete ini;
01573 
01574   return config;
01575 }
01576 
01583 void SaveGRFPresetToConfig(const char *config_name, GRFConfig *config)
01584 {
01585   char *section = (char*)alloca(strlen(config_name) + 8);
01586   sprintf(section, "preset-%s", config_name);
01587 
01588   IniFile *ini = IniLoadConfig();
01589   GRFSaveConfig(ini, section, config);
01590   ini->SaveToDisk(_config_file);
01591   delete ini;
01592 }
01593 
01598 void DeleteGRFPresetFromConfig(const char *config_name)
01599 {
01600   char *section = (char*)alloca(strlen(config_name) + 8);
01601   sprintf(section, "preset-%s", config_name);
01602 
01603   IniFile *ini = IniLoadConfig();
01604   ini->RemoveGroup(section);
01605   ini->SaveToDisk(_config_file);
01606   delete ini;
01607 }
01608 
01609 static const SettingDesc *GetSettingDescription(uint index)
01610 {
01611   if (index >= lengthof(_settings)) return NULL;
01612   return &_settings[index];
01613 }
01614 
01626 CommandCost CmdChangeSetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01627 {
01628   const SettingDesc *sd = GetSettingDescription(p1);
01629 
01630   if (sd == NULL) return CMD_ERROR;
01631   if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) return CMD_ERROR;
01632 
01633   if (!sd->IsEditable(true)) return CMD_ERROR;
01634 
01635   if (flags & DC_EXEC) {
01636     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01637 
01638     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01639     int32 newval = (int32)p2;
01640 
01641     Write_ValidateSetting(var, sd, newval);
01642     newval = (int32)ReadValue(var, sd->save.conv);
01643 
01644     if (oldval == newval) return CommandCost();
01645 
01646     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01647       WriteValue(var, sd->save.conv, (int64)oldval);
01648       return CommandCost();
01649     }
01650 
01651     if (sd->desc.flags & SGF_NO_NETWORK) {
01652       GamelogStartAction(GLAT_SETTING);
01653       GamelogSetting(sd->desc.name, oldval, newval);
01654       GamelogStopAction();
01655     }
01656 
01657     SetWindowClassesDirty(WC_GAME_OPTIONS);
01658   }
01659 
01660   return CommandCost();
01661 }
01662 
01673 CommandCost CmdChangeCompanySetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01674 {
01675   if (p1 >= lengthof(_company_settings)) return CMD_ERROR;
01676   const SettingDesc *sd = &_company_settings[p1];
01677 
01678   if (flags & DC_EXEC) {
01679     void *var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01680 
01681     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01682     int32 newval = (int32)p2;
01683 
01684     Write_ValidateSetting(var, sd, newval);
01685     newval = (int32)ReadValue(var, sd->save.conv);
01686 
01687     if (oldval == newval) return CommandCost();
01688 
01689     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01690       WriteValue(var, sd->save.conv, (int64)oldval);
01691       return CommandCost();
01692     }
01693 
01694     SetWindowClassesDirty(WC_GAME_OPTIONS);
01695   }
01696 
01697   return CommandCost();
01698 }
01699 
01707 bool SetSettingValue(uint index, int32 value, bool force_newgame)
01708 {
01709   const SettingDesc *sd = &_settings[index];
01710   /* If an item is company-based, we do not send it over the network
01711    * (if any) to change. Also *hack*hack* we update the _newgame version
01712    * of settings because changing a company-based setting in a game also
01713    * changes its defaults. At least that is the convention we have chosen */
01714   if (sd->save.conv & SLF_NO_NETWORK_SYNC) {
01715     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01716     Write_ValidateSetting(var, sd, value);
01717 
01718     if (_game_mode != GM_MENU) {
01719       void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01720       Write_ValidateSetting(var2, sd, value);
01721     }
01722     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01723 
01724     SetWindowClassesDirty(WC_GAME_OPTIONS);
01725 
01726     return true;
01727   }
01728 
01729   if (force_newgame) {
01730     void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01731     Write_ValidateSetting(var2, sd, value);
01732     return true;
01733   }
01734 
01735   /* send non-company-based settings over the network */
01736   if (!_networking || (_networking && _network_server)) {
01737     return DoCommandP(0, index, value, CMD_CHANGE_SETTING);
01738   }
01739   return false;
01740 }
01741 
01748 void SetCompanySetting(uint index, int32 value)
01749 {
01750   const SettingDesc *sd = &_company_settings[index];
01751   if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
01752     DoCommandP(0, index, value, CMD_CHANGE_COMPANY_SETTING);
01753   } else {
01754     void *var = GetVariableAddress(&_settings_client.company, &sd->save);
01755     Write_ValidateSetting(var, sd, value);
01756     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01757   }
01758 }
01759 
01763 void SetDefaultCompanySettings(CompanyID cid)
01764 {
01765   Company *c = Company::Get(cid);
01766   const SettingDesc *sd;
01767   for (sd = _company_settings; sd->save.cmd != SL_END; sd++) {
01768     void *var = GetVariableAddress(&c->settings, &sd->save);
01769     Write_ValidateSetting(var, sd, (int32)(size_t)sd->desc.def);
01770   }
01771 }
01772 
01773 #if defined(ENABLE_NETWORK)
01774 
01777 void SyncCompanySettings()
01778 {
01779   const SettingDesc *sd;
01780   uint i = 0;
01781   for (sd = _company_settings; sd->save.cmd != SL_END; sd++, i++) {
01782     const void *old_var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01783     const void *new_var = GetVariableAddress(&_settings_client.company, &sd->save);
01784     uint32 old_value = (uint32)ReadValue(old_var, sd->save.conv);
01785     uint32 new_value = (uint32)ReadValue(new_var, sd->save.conv);
01786     if (old_value != new_value) NetworkSendCommand(0, i, new_value, CMD_CHANGE_COMPANY_SETTING, NULL, NULL, _local_company);
01787   }
01788 }
01789 #endif /* ENABLE_NETWORK */
01790 
01796 uint GetCompanySettingIndex(const char *name)
01797 {
01798   uint i;
01799   const SettingDesc *sd = GetSettingFromName(name, &i);
01800   assert(sd != NULL && (sd->desc.flags & SGF_PER_COMPANY) != 0);
01801   return i;
01802 }
01803 
01811 bool SetSettingValue(uint index, const char *value, bool force_newgame)
01812 {
01813   const SettingDesc *sd = &_settings[index];
01814   assert(sd->save.conv & SLF_NO_NETWORK_SYNC);
01815 
01816   if (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) {
01817     char **var = (char**)GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01818     free(*var);
01819     *var = strcmp(value, "(null)") == 0 ? NULL : strdup(value);
01820   } else {
01821     char *var = (char*)GetVariableAddress(NULL, &sd->save);
01822     ttd_strlcpy(var, value, sd->save.length);
01823   }
01824   if (sd->desc.proc != NULL) sd->desc.proc(0);
01825 
01826   return true;
01827 }
01828 
01836 const SettingDesc *GetSettingFromName(const char *name, uint *i)
01837 {
01838   const SettingDesc *sd;
01839 
01840   /* First check all full names */
01841   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01842     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01843     if (strcmp(sd->desc.name, name) == 0) return sd;
01844   }
01845 
01846   /* Then check the shortcut variant of the name. */
01847   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01848     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01849     const char *short_name = strchr(sd->desc.name, '.');
01850     if (short_name != NULL) {
01851       short_name++;
01852       if (strcmp(short_name, name) == 0) return sd;
01853     }
01854   }
01855 
01856   if (strncmp(name, "company.", 8) == 0) name += 8;
01857   /* And finally the company-based settings */
01858   for (*i = 0, sd = _company_settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01859     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01860     if (strcmp(sd->desc.name, name) == 0) return sd;
01861   }
01862 
01863   return NULL;
01864 }
01865 
01866 /* Those 2 functions need to be here, else we have to make some stuff non-static
01867  * and besides, it is also better to keep stuff like this at the same place */
01868 void IConsoleSetSetting(const char *name, const char *value, bool force_newgame)
01869 {
01870   uint index;
01871   const SettingDesc *sd = GetSettingFromName(name, &index);
01872 
01873   if (sd == NULL) {
01874     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01875     return;
01876   }
01877 
01878   bool success;
01879   if (sd->desc.cmd == SDT_STRING) {
01880     success = SetSettingValue(index, value, force_newgame);
01881   } else {
01882     uint32 val;
01883     extern bool GetArgumentInteger(uint32 *value, const char *arg);
01884     success = GetArgumentInteger(&val, value);
01885     if (!success) {
01886       IConsolePrintF(CC_ERROR, "'%s' is not an integer.", value);
01887       return;
01888     }
01889 
01890     success = SetSettingValue(index, val, force_newgame);
01891   }
01892 
01893   if (!success) {
01894     if (_network_server) {
01895       IConsoleError("This command/variable is not available during network games.");
01896     } else {
01897       IConsoleError("This command/variable is only available to a network server.");
01898     }
01899   }
01900 }
01901 
01902 void IConsoleSetSetting(const char *name, int value)
01903 {
01904   uint index;
01905   const SettingDesc *sd = GetSettingFromName(name, &index);
01906   assert(sd != NULL);
01907   SetSettingValue(index, value);
01908 }
01909 
01915 void IConsoleGetSetting(const char *name, bool force_newgame)
01916 {
01917   char value[20];
01918   uint index;
01919   const SettingDesc *sd = GetSettingFromName(name, &index);
01920   const void *ptr;
01921 
01922   if (sd == NULL) {
01923     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01924     return;
01925   }
01926 
01927   ptr = GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01928 
01929   if (sd->desc.cmd == SDT_STRING) {
01930     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s'", name, (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
01931   } else {
01932     if (sd->desc.cmd == SDT_BOOLX) {
01933       snprintf(value, sizeof(value), (*(const bool*)ptr != 0) ? "on" : "off");
01934     } else {
01935       snprintf(value, sizeof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
01936     }
01937 
01938     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s' (min: %s%d, max: %u)",
01939       name, value, (sd->desc.flags & SGF_0ISDISABLED) ? "(0) " : "", sd->desc.min, sd->desc.max);
01940   }
01941 }
01942 
01948 void IConsoleListSettings(const char *prefilter)
01949 {
01950   IConsolePrintF(CC_WARNING, "All settings with their current value:");
01951 
01952   for (const SettingDesc *sd = _settings; sd->save.cmd != SL_END; sd++) {
01953     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01954     if (prefilter != NULL && strstr(sd->desc.name, prefilter) == NULL) continue;
01955     char value[80];
01956     const void *ptr = GetVariableAddress(&GetGameSettings(), &sd->save);
01957 
01958     if (sd->desc.cmd == SDT_BOOLX) {
01959       snprintf(value, lengthof(value), (*(const bool *)ptr != 0) ? "on" : "off");
01960     } else if (sd->desc.cmd == SDT_STRING) {
01961       snprintf(value, sizeof(value), "%s", (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
01962     } else {
01963       snprintf(value, lengthof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
01964     }
01965     IConsolePrintF(CC_DEFAULT, "%s = %s", sd->desc.name, value);
01966   }
01967 
01968   IConsolePrintF(CC_WARNING, "Use 'setting' command to change a value");
01969 }
01970 
01977 static void LoadSettings(const SettingDesc *osd, void *object)
01978 {
01979   for (; osd->save.cmd != SL_END; osd++) {
01980     const SaveLoad *sld = &osd->save;
01981     void *ptr = GetVariableAddress(object, sld);
01982 
01983     if (!SlObjectMember(ptr, sld)) continue;
01984     if (IsNumericType(sld->conv)) Write_ValidateSetting(ptr, osd, ReadValue(ptr, sld->conv));
01985   }
01986 }
01987 
01994 static void SaveSettings(const SettingDesc *sd, void *object)
01995 {
01996   /* We need to write the CH_RIFF header, but unfortunately can't call
01997    * SlCalcLength() because we have a different format. So do this manually */
01998   const SettingDesc *i;
01999   size_t length = 0;
02000   for (i = sd; i->save.cmd != SL_END; i++) {
02001     length += SlCalcObjMemberLength(object, &i->save);
02002   }
02003   SlSetLength(length);
02004 
02005   for (i = sd; i->save.cmd != SL_END; i++) {
02006     void *ptr = GetVariableAddress(object, &i->save);
02007     SlObjectMember(ptr, &i->save);
02008   }
02009 }
02010 
02011 static void Load_OPTS()
02012 {
02013   /* Copy over default setting since some might not get loaded in
02014    * a networking environment. This ensures for example that the local
02015    * autosave-frequency stays when joining a network-server */
02016   PrepareOldDiffCustom();
02017   LoadSettings(_gameopt_settings, &_settings_game);
02018   HandleOldDiffCustom(true);
02019 }
02020 
02021 static void Load_PATS()
02022 {
02023   /* Copy over default setting since some might not get loaded in
02024    * a networking environment. This ensures for example that the local
02025    * currency setting stays when joining a network-server */
02026   LoadSettings(_settings, &_settings_game);
02027 }
02028 
02029 static void Check_PATS()
02030 {
02031   LoadSettings(_settings, &_load_check_data.settings);
02032 }
02033 
02034 static void Save_PATS()
02035 {
02036   SaveSettings(_settings, &_settings_game);
02037 }
02038 
02039 void CheckConfig()
02040 {
02041   /*
02042    * Increase old default values for pf_maxdepth and pf_maxlength
02043    * to support big networks.
02044    */
02045   if (_settings_newgame.pf.opf.pf_maxdepth == 16 && _settings_newgame.pf.opf.pf_maxlength == 512) {
02046     _settings_newgame.pf.opf.pf_maxdepth = 48;
02047     _settings_newgame.pf.opf.pf_maxlength = 4096;
02048   }
02049 }
02050 
02051 extern const ChunkHandler _setting_chunk_handlers[] = {
02052   { 'OPTS', NULL,      Load_OPTS, NULL, NULL,       CH_RIFF},
02053   { 'PATS', Save_PATS, Load_PATS, NULL, Check_PATS, CH_RIFF | CH_LAST},
02054 };
02055 
02056 static bool IsSignedVarMemType(VarType vt)
02057 {
02058   switch (GetVarMemType(vt)) {
02059     case SLE_VAR_I8:
02060     case SLE_VAR_I16:
02061     case SLE_VAR_I32:
02062     case SLE_VAR_I64:
02063       return true;
02064   }
02065   return false;
02066 }