settings.cpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
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 
00755 SettingType SettingDesc::GetType() const
00756 {
00757   if (this->desc.flags & SGF_PER_COMPANY) return ST_COMPANY;
00758   return (this->save.conv & SLF_NOT_IN_SAVE) ? ST_CLIENT : ST_GAME;
00759 }
00760 
00761 /* Begin - Callback Functions for the various settings. */
00762 
00764 static bool v_PositionMainToolbar(int32 p1)
00765 {
00766   if (_game_mode != GM_MENU) PositionMainToolbar(NULL);
00767   return true;
00768 }
00769 
00771 static bool v_PositionStatusbar(int32 p1)
00772 {
00773   if (_game_mode != GM_MENU) {
00774     PositionStatusbar(NULL);
00775     PositionNewsMessage(NULL);
00776     PositionNetworkChatWindow(NULL);
00777   }
00778   return true;
00779 }
00780 
00781 static bool PopulationInLabelActive(int32 p1)
00782 {
00783   UpdateAllTownVirtCoords();
00784   return true;
00785 }
00786 
00787 static bool RedrawScreen(int32 p1)
00788 {
00789   MarkWholeScreenDirty();
00790   return true;
00791 }
00792 
00798 static bool RedrawSmallmap(int32 p1)
00799 {
00800   BuildLandLegend();
00801   BuildOwnerLegend();
00802   SetWindowClassesDirty(WC_SMALLMAP);
00803   return true;
00804 }
00805 
00806 static bool InvalidateDetailsWindow(int32 p1)
00807 {
00808   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00809   return true;
00810 }
00811 
00812 static bool StationSpreadChanged(int32 p1)
00813 {
00814   InvalidateWindowData(WC_SELECT_STATION, 0);
00815   InvalidateWindowData(WC_BUILD_STATION, 0);
00816   return true;
00817 }
00818 
00819 static bool InvalidateBuildIndustryWindow(int32 p1)
00820 {
00821   InvalidateWindowData(WC_BUILD_INDUSTRY, 0);
00822   return true;
00823 }
00824 
00825 static bool CloseSignalGUI(int32 p1)
00826 {
00827   if (p1 == 0) {
00828     DeleteWindowByClass(WC_BUILD_SIGNAL);
00829   }
00830   return true;
00831 }
00832 
00833 static bool InvalidateTownViewWindow(int32 p1)
00834 {
00835   InvalidateWindowClassesData(WC_TOWN_VIEW, p1);
00836   return true;
00837 }
00838 
00839 static bool DeleteSelectStationWindow(int32 p1)
00840 {
00841   DeleteWindowById(WC_SELECT_STATION, 0);
00842   return true;
00843 }
00844 
00845 static bool UpdateConsists(int32 p1)
00846 {
00847   Train *t;
00848   FOR_ALL_TRAINS(t) {
00849     /* Update the consist of all trains so the maximum speed is set correctly. */
00850     if (t->IsFrontEngine() || t->IsFreeWagon()) t->ConsistChanged(true);
00851   }
00852   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00853   return true;
00854 }
00855 
00856 /* Check service intervals of vehicles, p1 is value of % or day based servicing */
00857 static bool CheckInterval(int32 p1)
00858 {
00859   VehicleDefaultSettings *vds;
00860   if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
00861     vds = &_settings_client.company.vehicle;
00862   } else {
00863     vds = &Company::Get(_current_company)->settings.vehicle;
00864   }
00865 
00866   if (p1 != 0) {
00867     vds->servint_trains   = 50;
00868     vds->servint_roadveh  = 50;
00869     vds->servint_aircraft = 50;
00870     vds->servint_ships    = 50;
00871   } else {
00872     vds->servint_trains   = 150;
00873     vds->servint_roadveh  = 150;
00874     vds->servint_aircraft = 100;
00875     vds->servint_ships    = 360;
00876   }
00877 
00878   InvalidateDetailsWindow(0);
00879 
00880   return true;
00881 }
00882 
00883 static bool TrainAccelerationModelChanged(int32 p1)
00884 {
00885   Train *t;
00886   FOR_ALL_TRAINS(t) {
00887     if (t->IsFrontEngine()) {
00888       t->tcache.cached_max_curve_speed = t->GetCurveSpeedLimit();
00889       t->UpdateAcceleration();
00890     }
00891   }
00892 
00893   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00894   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00895   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00896   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00897 
00898   return true;
00899 }
00900 
00906 static bool TrainSlopeSteepnessChanged(int32 p1)
00907 {
00908   Train *t;
00909   FOR_ALL_TRAINS(t) {
00910     if (t->IsFrontEngine()) t->CargoChanged();
00911   }
00912 
00913   return true;
00914 }
00915 
00921 static bool RoadVehAccelerationModelChanged(int32 p1)
00922 {
00923   if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) {
00924     RoadVehicle *rv;
00925     FOR_ALL_ROADVEHICLES(rv) {
00926       if (rv->IsFrontEngine()) {
00927         rv->CargoChanged();
00928       }
00929     }
00930   }
00931 
00932   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00933   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00934   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00935   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00936 
00937   return true;
00938 }
00939 
00945 static bool RoadVehSlopeSteepnessChanged(int32 p1)
00946 {
00947   RoadVehicle *rv;
00948   FOR_ALL_ROADVEHICLES(rv) {
00949     if (rv->IsFrontEngine()) rv->CargoChanged();
00950   }
00951 
00952   return true;
00953 }
00954 
00955 static bool DragSignalsDensityChanged(int32)
00956 {
00957   InvalidateWindowData(WC_BUILD_SIGNAL, 0);
00958 
00959   return true;
00960 }
00961 
00962 static bool TownFoundingChanged(int32 p1)
00963 {
00964   if (_game_mode != GM_EDITOR && _settings_game.economy.found_town == TF_FORBIDDEN) {
00965     DeleteWindowById(WC_FOUND_TOWN, 0);
00966     return true;
00967   }
00968   InvalidateWindowData(WC_FOUND_TOWN, 0);
00969   return true;
00970 }
00971 
00972 static bool InvalidateVehTimetableWindow(int32 p1)
00973 {
00974   InvalidateWindowClassesData(WC_VEHICLE_TIMETABLE, VIWD_MODIFY_ORDERS);
00975   return true;
00976 }
00977 
00978 static bool ZoomMinMaxChanged(int32 p1)
00979 {
00980   extern void ConstrainAllViewportsZoom();
00981   ConstrainAllViewportsZoom();
00982   GfxClearSpriteCache();
00983   return true;
00984 }
00985 
00993 static bool InvalidateNewGRFChangeWindows(int32 p1)
00994 {
00995   InvalidateWindowClassesData(WC_SAVELOAD);
00996   DeleteWindowByClass(WC_GAME_OPTIONS);
00997   ReInitAllWindows();
00998   return true;
00999 }
01000 
01001 static bool InvalidateCompanyLiveryWindow(int32 p1)
01002 {
01003   InvalidateWindowClassesData(WC_COMPANY_COLOUR);
01004   return RedrawScreen(p1);
01005 }
01006 
01007 static bool InvalidateIndustryViewWindow(int32 p1)
01008 {
01009   InvalidateWindowClassesData(WC_INDUSTRY_VIEW);
01010   return true;
01011 }
01012 
01013 static bool InvalidateAISettingsWindow(int32 p1)
01014 {
01015   InvalidateWindowClassesData(WC_AI_SETTINGS);
01016   return true;
01017 }
01018 
01024 static bool RedrawTownAuthority(int32 p1)
01025 {
01026   SetWindowClassesDirty(WC_TOWN_AUTHORITY);
01027   return true;
01028 }
01029 
01035 static bool InvalidateCompanyInfrastructureWindow(int32 p1)
01036 {
01037   InvalidateWindowClassesData(WC_COMPANY_INFRASTRUCTURE);
01038   return true;
01039 }
01040 
01046 static bool InvalidateCompanyWindow(int32 p1)
01047 {
01048   InvalidateWindowClassesData(WC_COMPANY);
01049   return true;
01050 }
01051 
01053 static void ValidateSettings()
01054 {
01055   /* Do not allow a custom sea level with the original land generator. */
01056   if (_settings_newgame.game_creation.land_generator == 0 &&
01057       _settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
01058     _settings_newgame.difficulty.quantity_sea_lakes = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE;
01059   }
01060 }
01061 
01062 static bool DifficultyNoiseChange(int32 i)
01063 {
01064   if (_game_mode == GM_NORMAL) {
01065     UpdateAirportsNoise();
01066     if (_settings_game.economy.station_noise_level) {
01067       InvalidateWindowClassesData(WC_TOWN_VIEW, 0);
01068     }
01069   }
01070 
01071   return true;
01072 }
01073 
01074 static bool MaxNoAIsChange(int32 i)
01075 {
01076   if (GetGameSettings().difficulty.max_no_competitors != 0 &&
01077       AI::GetInfoList()->size() == 0 &&
01078       (!_networking || _network_server)) {
01079     ShowErrorMessage(STR_WARNING_NO_SUITABLE_AI, INVALID_STRING_ID, WL_CRITICAL);
01080   }
01081 
01082   return true;
01083 }
01084 
01090 static bool CheckRoadSide(int p1)
01091 {
01092   extern bool RoadVehiclesAreBuilt();
01093   return _game_mode == GM_MENU || !RoadVehiclesAreBuilt();
01094 }
01095 
01103 static size_t ConvertLandscape(const char *value)
01104 {
01105   /* try with the old values */
01106   return LookupOneOfMany("normal|hilly|desert|candy", value);
01107 }
01108 
01109 static bool CheckFreeformEdges(int32 p1)
01110 {
01111   if (_game_mode == GM_MENU) return true;
01112   if (p1 != 0) {
01113     Ship *s;
01114     FOR_ALL_SHIPS(s) {
01115       /* Check if there is a ship on the northern border. */
01116       if (TileX(s->tile) == 0 || TileY(s->tile) == 0) {
01117         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01118         return false;
01119       }
01120     }
01121     BaseStation *st;
01122     FOR_ALL_BASE_STATIONS(st) {
01123       /* Check if there is a non-deleted buoy on the northern border. */
01124       if (st->IsInUse() && (TileX(st->xy) == 0 || TileY(st->xy) == 0)) {
01125         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01126         return false;
01127       }
01128     }
01129     for (uint i = 0; i < MapSizeX(); i++) MakeVoid(TileXY(i, 0));
01130     for (uint i = 0; i < MapSizeY(); i++) MakeVoid(TileXY(0, i));
01131   } else {
01132     for (uint i = 0; i < MapMaxX(); i++) {
01133       if (TileHeight(TileXY(i, 1)) != 0) {
01134         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01135         return false;
01136       }
01137     }
01138     for (uint i = 1; i < MapMaxX(); i++) {
01139       if (!IsTileType(TileXY(i, MapMaxY() - 1), MP_WATER) || TileHeight(TileXY(1, MapMaxY())) != 0) {
01140         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01141         return false;
01142       }
01143     }
01144     for (uint i = 0; i < MapMaxY(); i++) {
01145       if (TileHeight(TileXY(1, i)) != 0) {
01146         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01147         return false;
01148       }
01149     }
01150     for (uint i = 1; i < MapMaxY(); i++) {
01151       if (!IsTileType(TileXY(MapMaxX() - 1, i), MP_WATER) || TileHeight(TileXY(MapMaxX(), i)) != 0) {
01152         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01153         return false;
01154       }
01155     }
01156     /* Make tiles at the border water again. */
01157     for (uint i = 0; i < MapMaxX(); i++) {
01158       SetTileHeight(TileXY(i, 0), 0);
01159       SetTileType(TileXY(i, 0), MP_WATER);
01160     }
01161     for (uint i = 0; i < MapMaxY(); i++) {
01162       SetTileHeight(TileXY(0, i), 0);
01163       SetTileType(TileXY(0, i), MP_WATER);
01164     }
01165   }
01166   MarkWholeScreenDirty();
01167   return true;
01168 }
01169 
01174 static bool ChangeDynamicEngines(int32 p1)
01175 {
01176   if (_game_mode == GM_MENU) return true;
01177 
01178   if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
01179     ShowErrorMessage(STR_CONFIG_SETTING_DYNAMIC_ENGINES_EXISTING_VEHICLES, INVALID_STRING_ID, WL_ERROR);
01180     return false;
01181   }
01182 
01183   return true;
01184 }
01185 
01186 static bool StationCatchmentChanged(int32 p1)
01187 {
01188   Station::RecomputeIndustriesNearForAll();
01189   return true;
01190 }
01191 
01192 
01193 #ifdef ENABLE_NETWORK
01194 
01195 static bool UpdateClientName(int32 p1)
01196 {
01197   NetworkUpdateClientName();
01198   return true;
01199 }
01200 
01201 static bool UpdateServerPassword(int32 p1)
01202 {
01203   if (strcmp(_settings_client.network.server_password, "*") == 0) {
01204     _settings_client.network.server_password[0] = '\0';
01205   }
01206 
01207   return true;
01208 }
01209 
01210 static bool UpdateRconPassword(int32 p1)
01211 {
01212   if (strcmp(_settings_client.network.rcon_password, "*") == 0) {
01213     _settings_client.network.rcon_password[0] = '\0';
01214   }
01215 
01216   return true;
01217 }
01218 
01219 static bool UpdateClientConfigValues(int32 p1)
01220 {
01221   if (_network_server) NetworkServerSendConfigUpdate();
01222 
01223   return true;
01224 }
01225 
01226 #endif /* ENABLE_NETWORK */
01227 
01228 
01229 /* End - Callback Functions */
01230 
01234 static void PrepareOldDiffCustom()
01235 {
01236   memset(_old_diff_custom, 0, sizeof(_old_diff_custom));
01237 }
01238 
01245 static void HandleOldDiffCustom(bool savegame)
01246 {
01247   uint options_to_load = GAME_DIFFICULTY_NUM - ((savegame && IsSavegameVersionBefore(4)) ? 1 : 0);
01248 
01249   if (!savegame) {
01250     /* If we did read to old_diff_custom, then at least one value must be non 0. */
01251     bool old_diff_custom_used = false;
01252     for (uint i = 0; i < options_to_load && !old_diff_custom_used; i++) {
01253       old_diff_custom_used = (_old_diff_custom[i] != 0);
01254     }
01255 
01256     if (!old_diff_custom_used) return;
01257   }
01258 
01259   for (uint i = 0; i < options_to_load; i++) {
01260     const SettingDesc *sd = &_settings[i];
01261     /* Skip deprecated options */
01262     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01263     void *var = GetVariableAddress(savegame ? &_settings_game : &_settings_newgame, &sd->save);
01264     Write_ValidateSetting(var, sd, (int32)((i == 4 ? 1000 : 1) * _old_diff_custom[i]));
01265   }
01266 }
01267 
01268 static void AILoadConfig(IniFile *ini, const char *grpname)
01269 {
01270   IniGroup *group = ini->GetGroup(grpname);
01271   IniItem *item;
01272 
01273   /* Clean any configured AI */
01274   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01275     AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01276   }
01277 
01278   /* If no group exists, return */
01279   if (group == NULL) return;
01280 
01281   CompanyID c = COMPANY_FIRST;
01282   for (item = group->item; c < MAX_COMPANIES && item != NULL; c++, item = item->next) {
01283     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01284 
01285     config->Change(item->name);
01286     if (!config->HasScript()) {
01287       if (strcmp(item->name, "none") != 0) {
01288         DEBUG(script, 0, "The AI by the name '%s' was no longer found, and removed from the list.", item->name);
01289         continue;
01290       }
01291     }
01292     if (item->value != NULL) config->StringToSettings(item->value);
01293   }
01294 }
01295 
01296 static void GameLoadConfig(IniFile *ini, const char *grpname)
01297 {
01298   IniGroup *group = ini->GetGroup(grpname);
01299   IniItem *item;
01300 
01301   /* Clean any configured GameScript */
01302   GameConfig::GetConfig(GameConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01303 
01304   /* If no group exists, return */
01305   if (group == NULL) return;
01306 
01307   item = group->item;
01308   if (item == NULL) return;
01309 
01310   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01311 
01312   config->Change(item->name);
01313   if (!config->HasScript()) {
01314     if (strcmp(item->name, "none") != 0) {
01315       DEBUG(script, 0, "The GameScript by the name '%s' was no longer found, and removed from the list.", item->name);
01316       return;
01317     }
01318   }
01319   if (item->value != NULL) config->StringToSettings(item->value);
01320 }
01321 
01328 static GRFConfig *GRFLoadConfig(IniFile *ini, const char *grpname, bool is_static)
01329 {
01330   IniGroup *group = ini->GetGroup(grpname);
01331   IniItem *item;
01332   GRFConfig *first = NULL;
01333   GRFConfig **curr = &first;
01334 
01335   if (group == NULL) return NULL;
01336 
01337   for (item = group->item; item != NULL; item = item->next) {
01338     GRFConfig *c = new GRFConfig(item->name);
01339 
01340     /* Parse parameters */
01341     if (!StrEmpty(item->value)) {
01342       c->num_params = ParseIntList(item->value, (int*)c->param, lengthof(c->param));
01343       if (c->num_params == (byte)-1) {
01344         SetDParamStr(0, item->name);
01345         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_ARRAY, WL_CRITICAL);
01346         c->num_params = 0;
01347       }
01348     }
01349 
01350     /* Check if item is valid */
01351     if (!FillGRFDetails(c, is_static) || HasBit(c->flags, GCF_INVALID)) {
01352       if (c->status == GCS_NOT_FOUND) {
01353         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_NOT_FOUND);
01354       } else if (HasBit(c->flags, GCF_UNSAFE)) {
01355         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNSAFE);
01356       } else if (HasBit(c->flags, GCF_SYSTEM)) {
01357         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_SYSTEM);
01358       } else if (HasBit(c->flags, GCF_INVALID)) {
01359         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_INCOMPATIBLE);
01360       } else {
01361         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNKNOWN);
01362       }
01363 
01364       SetDParamStr(0, item->name);
01365       ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_GRF, WL_CRITICAL);
01366       delete c;
01367       continue;
01368     }
01369 
01370     /* Check for duplicate GRFID (will also check for duplicate filenames) */
01371     bool duplicate = false;
01372     for (const GRFConfig *gc = first; gc != NULL; gc = gc->next) {
01373       if (gc->ident.grfid == c->ident.grfid) {
01374         SetDParamStr(0, item->name);
01375         SetDParamStr(1, gc->filename);
01376         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_DUPLICATE_GRFID, WL_CRITICAL);
01377         duplicate = true;
01378         break;
01379       }
01380     }
01381     if (duplicate) {
01382       delete c;
01383       continue;
01384     }
01385 
01386     /* Mark file as static to avoid saving in savegame. */
01387     if (is_static) SetBit(c->flags, GCF_STATIC);
01388 
01389     /* Add item to list */
01390     *curr = c;
01391     curr = &c->next;
01392   }
01393 
01394   return first;
01395 }
01396 
01397 static void AISaveConfig(IniFile *ini, const char *grpname)
01398 {
01399   IniGroup *group = ini->GetGroup(grpname);
01400 
01401   if (group == NULL) return;
01402   group->Clear();
01403 
01404   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01405     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01406     const char *name;
01407     char value[1024];
01408     config->SettingsToString(value, lengthof(value));
01409 
01410     if (config->HasScript()) {
01411       name = config->GetName();
01412     } else {
01413       name = "none";
01414     }
01415 
01416     IniItem *item = new IniItem(group, name, strlen(name));
01417     item->SetValue(value);
01418   }
01419 }
01420 
01421 static void GameSaveConfig(IniFile *ini, const char *grpname)
01422 {
01423   IniGroup *group = ini->GetGroup(grpname);
01424 
01425   if (group == NULL) return;
01426   group->Clear();
01427 
01428   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01429   const char *name;
01430   char value[1024];
01431   config->SettingsToString(value, lengthof(value));
01432 
01433   if (config->HasScript()) {
01434     name = config->GetName();
01435   } else {
01436     name = "none";
01437   }
01438 
01439   IniItem *item = new IniItem(group, name, strlen(name));
01440   item->SetValue(value);
01441 }
01442 
01447 static void SaveVersionInConfig(IniFile *ini)
01448 {
01449   IniGroup *group = ini->GetGroup("version");
01450 
01451   char version[9];
01452   snprintf(version, lengthof(version), "%08X", _openttd_newgrf_version);
01453 
01454   const char * const versions[][2] = {
01455     { "version_string", _openttd_revision },
01456     { "version_number", version }
01457   };
01458 
01459   for (uint i = 0; i < lengthof(versions); i++) {
01460     group->GetItem(versions[i][0], true)->SetValue(versions[i][1]);
01461   }
01462 }
01463 
01464 /* Save a GRF configuration to the given group name */
01465 static void GRFSaveConfig(IniFile *ini, const char *grpname, const GRFConfig *list)
01466 {
01467   ini->RemoveGroup(grpname);
01468   IniGroup *group = ini->GetGroup(grpname);
01469   const GRFConfig *c;
01470 
01471   for (c = list; c != NULL; c = c->next) {
01472     char params[512];
01473     GRFBuildParamList(params, c, lastof(params));
01474 
01475     group->GetItem(c->filename, true)->SetValue(params);
01476   }
01477 }
01478 
01479 /* Common handler for saving/loading variables to the configuration file */
01480 static void HandleSettingDescs(IniFile *ini, SettingDescProc *proc, SettingDescProcList *proc_list, bool basic_settings = true, bool other_settings = true)
01481 {
01482   if (basic_settings) {
01483     proc(ini, (const SettingDesc*)_misc_settings,    "misc",  NULL);
01484 #if defined(WIN32) && !defined(DEDICATED)
01485     proc(ini, (const SettingDesc*)_win32_settings,   "win32", NULL);
01486 #endif /* WIN32 */
01487   }
01488 
01489   if (other_settings) {
01490     proc(ini, _settings,         "patches",  &_settings_newgame);
01491     proc(ini, _currency_settings,"currency", &_custom_currency);
01492     proc(ini, _company_settings, "company",  &_settings_client.company);
01493 
01494 #ifdef ENABLE_NETWORK
01495     proc_list(ini, "server_bind_addresses", &_network_bind_list);
01496     proc_list(ini, "servers", &_network_host_list);
01497     proc_list(ini, "bans",    &_network_ban_list);
01498 #endif /* ENABLE_NETWORK */
01499   }
01500 }
01501 
01502 static IniFile *IniLoadConfig()
01503 {
01504   IniFile *ini = new IniFile(_list_group_names);
01505   ini->LoadFromDisk(_config_file, BASE_DIR);
01506   return ini;
01507 }
01508 
01513 void LoadFromConfig(bool minimal)
01514 {
01515   IniFile *ini = IniLoadConfig();
01516   if (!minimal) ResetCurrencies(false); // Initialize the array of currencies, without preserving the custom one
01517 
01518   /* Load basic settings only during bootstrap, load other settings not during bootstrap */
01519   HandleSettingDescs(ini, IniLoadSettings, IniLoadSettingList, minimal, !minimal);
01520 
01521   if (!minimal) {
01522     _grfconfig_newgame = GRFLoadConfig(ini, "newgrf", false);
01523     _grfconfig_static  = GRFLoadConfig(ini, "newgrf-static", true);
01524     AILoadConfig(ini, "ai_players");
01525     GameLoadConfig(ini, "game_scripts");
01526 
01527     PrepareOldDiffCustom();
01528     IniLoadSettings(ini, _gameopt_settings, "gameopt", &_settings_newgame);
01529     HandleOldDiffCustom(false);
01530 
01531     ValidateSettings();
01532 
01533     /* Display sheduled errors */
01534     extern void ScheduleErrorMessage(ErrorList &datas);
01535     ScheduleErrorMessage(_settings_error_list);
01536     if (FindWindowById(WC_ERRMSG, 0) == NULL) ShowFirstError();
01537   }
01538 
01539   delete ini;
01540 }
01541 
01543 void SaveToConfig()
01544 {
01545   IniFile *ini = IniLoadConfig();
01546 
01547   /* Remove some obsolete groups. These have all been loaded into other groups. */
01548   ini->RemoveGroup("patches");
01549   ini->RemoveGroup("yapf");
01550   ini->RemoveGroup("gameopt");
01551 
01552   HandleSettingDescs(ini, IniSaveSettings, IniSaveSettingList);
01553   GRFSaveConfig(ini, "newgrf", _grfconfig_newgame);
01554   GRFSaveConfig(ini, "newgrf-static", _grfconfig_static);
01555   AISaveConfig(ini, "ai_players");
01556   GameSaveConfig(ini, "game_scripts");
01557   SaveVersionInConfig(ini);
01558   ini->SaveToDisk(_config_file);
01559   delete ini;
01560 }
01561 
01566 void GetGRFPresetList(GRFPresetList *list)
01567 {
01568   list->Clear();
01569 
01570   IniFile *ini = IniLoadConfig();
01571   IniGroup *group;
01572   for (group = ini->group; group != NULL; group = group->next) {
01573     if (strncmp(group->name, "preset-", 7) == 0) {
01574       *list->Append() = strdup(group->name + 7);
01575     }
01576   }
01577 
01578   delete ini;
01579 }
01580 
01587 GRFConfig *LoadGRFPresetFromConfig(const char *config_name)
01588 {
01589   char *section = (char*)alloca(strlen(config_name) + 8);
01590   sprintf(section, "preset-%s", config_name);
01591 
01592   IniFile *ini = IniLoadConfig();
01593   GRFConfig *config = GRFLoadConfig(ini, section, false);
01594   delete ini;
01595 
01596   return config;
01597 }
01598 
01605 void SaveGRFPresetToConfig(const char *config_name, GRFConfig *config)
01606 {
01607   char *section = (char*)alloca(strlen(config_name) + 8);
01608   sprintf(section, "preset-%s", config_name);
01609 
01610   IniFile *ini = IniLoadConfig();
01611   GRFSaveConfig(ini, section, config);
01612   ini->SaveToDisk(_config_file);
01613   delete ini;
01614 }
01615 
01620 void DeleteGRFPresetFromConfig(const char *config_name)
01621 {
01622   char *section = (char*)alloca(strlen(config_name) + 8);
01623   sprintf(section, "preset-%s", config_name);
01624 
01625   IniFile *ini = IniLoadConfig();
01626   ini->RemoveGroup(section);
01627   ini->SaveToDisk(_config_file);
01628   delete ini;
01629 }
01630 
01631 const SettingDesc *GetSettingDescription(uint index)
01632 {
01633   if (index >= lengthof(_settings)) return NULL;
01634   return &_settings[index];
01635 }
01636 
01648 CommandCost CmdChangeSetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01649 {
01650   const SettingDesc *sd = GetSettingDescription(p1);
01651 
01652   if (sd == NULL) return CMD_ERROR;
01653   if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) return CMD_ERROR;
01654 
01655   if (!sd->IsEditable(true)) return CMD_ERROR;
01656 
01657   if (flags & DC_EXEC) {
01658     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01659 
01660     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01661     int32 newval = (int32)p2;
01662 
01663     Write_ValidateSetting(var, sd, newval);
01664     newval = (int32)ReadValue(var, sd->save.conv);
01665 
01666     if (oldval == newval) return CommandCost();
01667 
01668     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01669       WriteValue(var, sd->save.conv, (int64)oldval);
01670       return CommandCost();
01671     }
01672 
01673     if (sd->desc.flags & SGF_NO_NETWORK) {
01674       GamelogStartAction(GLAT_SETTING);
01675       GamelogSetting(sd->desc.name, oldval, newval);
01676       GamelogStopAction();
01677     }
01678 
01679     SetWindowClassesDirty(WC_GAME_OPTIONS);
01680   }
01681 
01682   return CommandCost();
01683 }
01684 
01695 CommandCost CmdChangeCompanySetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01696 {
01697   if (p1 >= lengthof(_company_settings)) return CMD_ERROR;
01698   const SettingDesc *sd = &_company_settings[p1];
01699 
01700   if (flags & DC_EXEC) {
01701     void *var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01702 
01703     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01704     int32 newval = (int32)p2;
01705 
01706     Write_ValidateSetting(var, sd, newval);
01707     newval = (int32)ReadValue(var, sd->save.conv);
01708 
01709     if (oldval == newval) return CommandCost();
01710 
01711     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01712       WriteValue(var, sd->save.conv, (int64)oldval);
01713       return CommandCost();
01714     }
01715 
01716     SetWindowClassesDirty(WC_GAME_OPTIONS);
01717   }
01718 
01719   return CommandCost();
01720 }
01721 
01729 bool SetSettingValue(uint index, int32 value, bool force_newgame)
01730 {
01731   const SettingDesc *sd = &_settings[index];
01732   /* If an item is company-based, we do not send it over the network
01733    * (if any) to change. Also *hack*hack* we update the _newgame version
01734    * of settings because changing a company-based setting in a game also
01735    * changes its defaults. At least that is the convention we have chosen */
01736   if (sd->save.conv & SLF_NO_NETWORK_SYNC) {
01737     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01738     Write_ValidateSetting(var, sd, value);
01739 
01740     if (_game_mode != GM_MENU) {
01741       void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01742       Write_ValidateSetting(var2, sd, value);
01743     }
01744     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01745 
01746     SetWindowClassesDirty(WC_GAME_OPTIONS);
01747 
01748     return true;
01749   }
01750 
01751   if (force_newgame) {
01752     void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01753     Write_ValidateSetting(var2, sd, value);
01754     return true;
01755   }
01756 
01757   /* send non-company-based settings over the network */
01758   if (!_networking || (_networking && _network_server)) {
01759     return DoCommandP(0, index, value, CMD_CHANGE_SETTING);
01760   }
01761   return false;
01762 }
01763 
01770 void SetCompanySetting(uint index, int32 value)
01771 {
01772   const SettingDesc *sd = &_company_settings[index];
01773   if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
01774     DoCommandP(0, index, value, CMD_CHANGE_COMPANY_SETTING);
01775   } else {
01776     void *var = GetVariableAddress(&_settings_client.company, &sd->save);
01777     Write_ValidateSetting(var, sd, value);
01778     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01779   }
01780 }
01781 
01785 void SetDefaultCompanySettings(CompanyID cid)
01786 {
01787   Company *c = Company::Get(cid);
01788   const SettingDesc *sd;
01789   for (sd = _company_settings; sd->save.cmd != SL_END; sd++) {
01790     void *var = GetVariableAddress(&c->settings, &sd->save);
01791     Write_ValidateSetting(var, sd, (int32)(size_t)sd->desc.def);
01792   }
01793 }
01794 
01795 #if defined(ENABLE_NETWORK)
01796 
01799 void SyncCompanySettings()
01800 {
01801   const SettingDesc *sd;
01802   uint i = 0;
01803   for (sd = _company_settings; sd->save.cmd != SL_END; sd++, i++) {
01804     const void *old_var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01805     const void *new_var = GetVariableAddress(&_settings_client.company, &sd->save);
01806     uint32 old_value = (uint32)ReadValue(old_var, sd->save.conv);
01807     uint32 new_value = (uint32)ReadValue(new_var, sd->save.conv);
01808     if (old_value != new_value) NetworkSendCommand(0, i, new_value, CMD_CHANGE_COMPANY_SETTING, NULL, NULL, _local_company);
01809   }
01810 }
01811 #endif /* ENABLE_NETWORK */
01812 
01818 uint GetCompanySettingIndex(const char *name)
01819 {
01820   uint i;
01821   const SettingDesc *sd = GetSettingFromName(name, &i);
01822   assert(sd != NULL && (sd->desc.flags & SGF_PER_COMPANY) != 0);
01823   return i;
01824 }
01825 
01833 bool SetSettingValue(uint index, const char *value, bool force_newgame)
01834 {
01835   const SettingDesc *sd = &_settings[index];
01836   assert(sd->save.conv & SLF_NO_NETWORK_SYNC);
01837 
01838   if (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) {
01839     char **var = (char**)GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01840     free(*var);
01841     *var = strcmp(value, "(null)") == 0 ? NULL : strdup(value);
01842   } else {
01843     char *var = (char*)GetVariableAddress(NULL, &sd->save);
01844     ttd_strlcpy(var, value, sd->save.length);
01845   }
01846   if (sd->desc.proc != NULL) sd->desc.proc(0);
01847 
01848   return true;
01849 }
01850 
01858 const SettingDesc *GetSettingFromName(const char *name, uint *i)
01859 {
01860   const SettingDesc *sd;
01861 
01862   /* First check all full names */
01863   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01864     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01865     if (strcmp(sd->desc.name, name) == 0) return sd;
01866   }
01867 
01868   /* Then check the shortcut variant of the name. */
01869   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01870     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01871     const char *short_name = strchr(sd->desc.name, '.');
01872     if (short_name != NULL) {
01873       short_name++;
01874       if (strcmp(short_name, name) == 0) return sd;
01875     }
01876   }
01877 
01878   if (strncmp(name, "company.", 8) == 0) name += 8;
01879   /* And finally the company-based settings */
01880   for (*i = 0, sd = _company_settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01881     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01882     if (strcmp(sd->desc.name, name) == 0) return sd;
01883   }
01884 
01885   return NULL;
01886 }
01887 
01888 /* Those 2 functions need to be here, else we have to make some stuff non-static
01889  * and besides, it is also better to keep stuff like this at the same place */
01890 void IConsoleSetSetting(const char *name, const char *value, bool force_newgame)
01891 {
01892   uint index;
01893   const SettingDesc *sd = GetSettingFromName(name, &index);
01894 
01895   if (sd == NULL) {
01896     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01897     return;
01898   }
01899 
01900   bool success;
01901   if (sd->desc.cmd == SDT_STRING) {
01902     success = SetSettingValue(index, value, force_newgame);
01903   } else {
01904     uint32 val;
01905     extern bool GetArgumentInteger(uint32 *value, const char *arg);
01906     success = GetArgumentInteger(&val, value);
01907     if (!success) {
01908       IConsolePrintF(CC_ERROR, "'%s' is not an integer.", value);
01909       return;
01910     }
01911 
01912     success = SetSettingValue(index, val, force_newgame);
01913   }
01914 
01915   if (!success) {
01916     if (_network_server) {
01917       IConsoleError("This command/variable is not available during network games.");
01918     } else {
01919       IConsoleError("This command/variable is only available to a network server.");
01920     }
01921   }
01922 }
01923 
01924 void IConsoleSetSetting(const char *name, int value)
01925 {
01926   uint index;
01927   const SettingDesc *sd = GetSettingFromName(name, &index);
01928   assert(sd != NULL);
01929   SetSettingValue(index, value);
01930 }
01931 
01937 void IConsoleGetSetting(const char *name, bool force_newgame)
01938 {
01939   char value[20];
01940   uint index;
01941   const SettingDesc *sd = GetSettingFromName(name, &index);
01942   const void *ptr;
01943 
01944   if (sd == NULL) {
01945     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01946     return;
01947   }
01948 
01949   ptr = GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01950 
01951   if (sd->desc.cmd == SDT_STRING) {
01952     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s'", name, (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
01953   } else {
01954     if (sd->desc.cmd == SDT_BOOLX) {
01955       snprintf(value, sizeof(value), (*(const bool*)ptr != 0) ? "on" : "off");
01956     } else {
01957       snprintf(value, sizeof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
01958     }
01959 
01960     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s' (min: %s%d, max: %u)",
01961       name, value, (sd->desc.flags & SGF_0ISDISABLED) ? "(0) " : "", sd->desc.min, sd->desc.max);
01962   }
01963 }
01964 
01970 void IConsoleListSettings(const char *prefilter)
01971 {
01972   IConsolePrintF(CC_WARNING, "All settings with their current value:");
01973 
01974   for (const SettingDesc *sd = _settings; sd->save.cmd != SL_END; sd++) {
01975     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01976     if (prefilter != NULL && strstr(sd->desc.name, prefilter) == NULL) continue;
01977     char value[80];
01978     const void *ptr = GetVariableAddress(&GetGameSettings(), &sd->save);
01979 
01980     if (sd->desc.cmd == SDT_BOOLX) {
01981       snprintf(value, lengthof(value), (*(const bool *)ptr != 0) ? "on" : "off");
01982     } else if (sd->desc.cmd == SDT_STRING) {
01983       snprintf(value, sizeof(value), "%s", (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
01984     } else {
01985       snprintf(value, lengthof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
01986     }
01987     IConsolePrintF(CC_DEFAULT, "%s = %s", sd->desc.name, value);
01988   }
01989 
01990   IConsolePrintF(CC_WARNING, "Use 'setting' command to change a value");
01991 }
01992 
01999 static void LoadSettings(const SettingDesc *osd, void *object)
02000 {
02001   for (; osd->save.cmd != SL_END; osd++) {
02002     const SaveLoad *sld = &osd->save;
02003     void *ptr = GetVariableAddress(object, sld);
02004 
02005     if (!SlObjectMember(ptr, sld)) continue;
02006     if (IsNumericType(sld->conv)) Write_ValidateSetting(ptr, osd, ReadValue(ptr, sld->conv));
02007   }
02008 }
02009 
02016 static void SaveSettings(const SettingDesc *sd, void *object)
02017 {
02018   /* We need to write the CH_RIFF header, but unfortunately can't call
02019    * SlCalcLength() because we have a different format. So do this manually */
02020   const SettingDesc *i;
02021   size_t length = 0;
02022   for (i = sd; i->save.cmd != SL_END; i++) {
02023     length += SlCalcObjMemberLength(object, &i->save);
02024   }
02025   SlSetLength(length);
02026 
02027   for (i = sd; i->save.cmd != SL_END; i++) {
02028     void *ptr = GetVariableAddress(object, &i->save);
02029     SlObjectMember(ptr, &i->save);
02030   }
02031 }
02032 
02033 static void Load_OPTS()
02034 {
02035   /* Copy over default setting since some might not get loaded in
02036    * a networking environment. This ensures for example that the local
02037    * autosave-frequency stays when joining a network-server */
02038   PrepareOldDiffCustom();
02039   LoadSettings(_gameopt_settings, &_settings_game);
02040   HandleOldDiffCustom(true);
02041 }
02042 
02043 static void Load_PATS()
02044 {
02045   /* Copy over default setting since some might not get loaded in
02046    * a networking environment. This ensures for example that the local
02047    * currency setting stays when joining a network-server */
02048   LoadSettings(_settings, &_settings_game);
02049 }
02050 
02051 static void Check_PATS()
02052 {
02053   LoadSettings(_settings, &_load_check_data.settings);
02054 }
02055 
02056 static void Save_PATS()
02057 {
02058   SaveSettings(_settings, &_settings_game);
02059 }
02060 
02061 void CheckConfig()
02062 {
02063   /*
02064    * Increase old default values for pf_maxdepth and pf_maxlength
02065    * to support big networks.
02066    */
02067   if (_settings_newgame.pf.opf.pf_maxdepth == 16 && _settings_newgame.pf.opf.pf_maxlength == 512) {
02068     _settings_newgame.pf.opf.pf_maxdepth = 48;
02069     _settings_newgame.pf.opf.pf_maxlength = 4096;
02070   }
02071 }
02072 
02073 extern const ChunkHandler _setting_chunk_handlers[] = {
02074   { 'OPTS', NULL,      Load_OPTS, NULL, NULL,       CH_RIFF},
02075   { 'PATS', Save_PATS, Load_PATS, NULL, Check_PATS, CH_RIFF | CH_LAST},
02076 };
02077 
02078 static bool IsSignedVarMemType(VarType vt)
02079 {
02080   switch (GetVarMemType(vt)) {
02081     case SLE_VAR_I8:
02082     case SLE_VAR_I16:
02083     case SLE_VAR_I32:
02084     case SLE_VAR_I64:
02085       return true;
02086   }
02087   return false;
02088 }