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 InvalidateStationBuildWindow(int32 p1)
00813 {
00814   SetWindowDirty(WC_BUILD_STATION, 0);
00815   return true;
00816 }
00817 
00818 static bool InvalidateBuildIndustryWindow(int32 p1)
00819 {
00820   InvalidateWindowData(WC_BUILD_INDUSTRY, 0);
00821   return true;
00822 }
00823 
00824 static bool CloseSignalGUI(int32 p1)
00825 {
00826   if (p1 == 0) {
00827     DeleteWindowByClass(WC_BUILD_SIGNAL);
00828   }
00829   return true;
00830 }
00831 
00832 static bool InvalidateTownViewWindow(int32 p1)
00833 {
00834   InvalidateWindowClassesData(WC_TOWN_VIEW, p1);
00835   return true;
00836 }
00837 
00838 static bool DeleteSelectStationWindow(int32 p1)
00839 {
00840   DeleteWindowById(WC_SELECT_STATION, 0);
00841   return true;
00842 }
00843 
00844 static bool UpdateConsists(int32 p1)
00845 {
00846   Train *t;
00847   FOR_ALL_TRAINS(t) {
00848     /* Update the consist of all trains so the maximum speed is set correctly. */
00849     if (t->IsFrontEngine() || t->IsFreeWagon()) t->ConsistChanged(true);
00850   }
00851   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00852   return true;
00853 }
00854 
00855 /* Check service intervals of vehicles, p1 is value of % or day based servicing */
00856 static bool CheckInterval(int32 p1)
00857 {
00858   VehicleDefaultSettings *vds;
00859   if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
00860     vds = &_settings_client.company.vehicle;
00861   } else {
00862     vds = &Company::Get(_current_company)->settings.vehicle;
00863   }
00864 
00865   if (p1 != 0) {
00866     vds->servint_trains   = 50;
00867     vds->servint_roadveh  = 50;
00868     vds->servint_aircraft = 50;
00869     vds->servint_ships    = 50;
00870   } else {
00871     vds->servint_trains   = 150;
00872     vds->servint_roadveh  = 150;
00873     vds->servint_aircraft = 100;
00874     vds->servint_ships    = 360;
00875   }
00876 
00877   InvalidateDetailsWindow(0);
00878 
00879   return true;
00880 }
00881 
00882 static bool TrainAccelerationModelChanged(int32 p1)
00883 {
00884   Train *t;
00885   FOR_ALL_TRAINS(t) {
00886     if (t->IsFrontEngine()) {
00887       t->tcache.cached_max_curve_speed = t->GetCurveSpeedLimit();
00888       t->UpdateAcceleration();
00889     }
00890   }
00891 
00892   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00893   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00894   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00895   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00896 
00897   return true;
00898 }
00899 
00905 static bool TrainSlopeSteepnessChanged(int32 p1)
00906 {
00907   Train *t;
00908   FOR_ALL_TRAINS(t) {
00909     if (t->IsFrontEngine()) t->CargoChanged();
00910   }
00911 
00912   return true;
00913 }
00914 
00920 static bool RoadVehAccelerationModelChanged(int32 p1)
00921 {
00922   if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) {
00923     RoadVehicle *rv;
00924     FOR_ALL_ROADVEHICLES(rv) {
00925       if (rv->IsFrontEngine()) {
00926         rv->CargoChanged();
00927       }
00928     }
00929   }
00930 
00931   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00932   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00933   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00934   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00935 
00936   return true;
00937 }
00938 
00944 static bool RoadVehSlopeSteepnessChanged(int32 p1)
00945 {
00946   RoadVehicle *rv;
00947   FOR_ALL_ROADVEHICLES(rv) {
00948     if (rv->IsFrontEngine()) rv->CargoChanged();
00949   }
00950 
00951   return true;
00952 }
00953 
00954 static bool DragSignalsDensityChanged(int32)
00955 {
00956   InvalidateWindowData(WC_BUILD_SIGNAL, 0);
00957 
00958   return true;
00959 }
00960 
00961 static bool TownFoundingChanged(int32 p1)
00962 {
00963   if (_game_mode != GM_EDITOR && _settings_game.economy.found_town == TF_FORBIDDEN) {
00964     DeleteWindowById(WC_FOUND_TOWN, 0);
00965     return true;
00966   }
00967   InvalidateWindowData(WC_FOUND_TOWN, 0);
00968   return true;
00969 }
00970 
00971 static bool InvalidateVehTimetableWindow(int32 p1)
00972 {
00973   InvalidateWindowClassesData(WC_VEHICLE_TIMETABLE, VIWD_MODIFY_ORDERS);
00974   return true;
00975 }
00976 
00977 static bool ZoomMinMaxChanged(int32 p1)
00978 {
00979   extern void ConstrainAllViewportsZoom();
00980   ConstrainAllViewportsZoom();
00981   GfxClearSpriteCache();
00982   return true;
00983 }
00984 
00992 static bool InvalidateNewGRFChangeWindows(int32 p1)
00993 {
00994   InvalidateWindowClassesData(WC_SAVELOAD);
00995   DeleteWindowByClass(WC_GAME_OPTIONS);
00996   ReInitAllWindows();
00997   return true;
00998 }
00999 
01000 static bool InvalidateCompanyLiveryWindow(int32 p1)
01001 {
01002   InvalidateWindowClassesData(WC_COMPANY_COLOUR);
01003   return RedrawScreen(p1);
01004 }
01005 
01006 static bool InvalidateIndustryViewWindow(int32 p1)
01007 {
01008   InvalidateWindowClassesData(WC_INDUSTRY_VIEW);
01009   return true;
01010 }
01011 
01012 static bool InvalidateAISettingsWindow(int32 p1)
01013 {
01014   InvalidateWindowClassesData(WC_AI_SETTINGS);
01015   return true;
01016 }
01017 
01023 static bool RedrawTownAuthority(int32 p1)
01024 {
01025   SetWindowClassesDirty(WC_TOWN_AUTHORITY);
01026   return true;
01027 }
01028 
01034 static bool InvalidateCompanyInfrastructureWindow(int32 p1)
01035 {
01036   InvalidateWindowClassesData(WC_COMPANY_INFRASTRUCTURE);
01037   return true;
01038 }
01039 
01041 static void ValidateSettings()
01042 {
01043   /* Do not allow a custom sea level with the original land generator. */
01044   if (_settings_newgame.game_creation.land_generator == 0 &&
01045       _settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
01046     _settings_newgame.difficulty.quantity_sea_lakes = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE;
01047   }
01048 }
01049 
01050 static bool DifficultyNoiseChange(int32 i)
01051 {
01052   if (_game_mode == GM_NORMAL) {
01053     UpdateAirportsNoise();
01054     if (_settings_game.economy.station_noise_level) {
01055       InvalidateWindowClassesData(WC_TOWN_VIEW, 0);
01056     }
01057   }
01058 
01059   return true;
01060 }
01061 
01062 static bool MaxNoAIsChange(int32 i)
01063 {
01064   if (GetGameSettings().difficulty.max_no_competitors != 0 &&
01065       AI::GetInfoList()->size() == 0 &&
01066       (!_networking || _network_server)) {
01067     ShowErrorMessage(STR_WARNING_NO_SUITABLE_AI, INVALID_STRING_ID, WL_CRITICAL);
01068   }
01069 
01070   return true;
01071 }
01072 
01078 static bool CheckRoadSide(int p1)
01079 {
01080   extern bool RoadVehiclesAreBuilt();
01081   return _game_mode == GM_MENU || !RoadVehiclesAreBuilt();
01082 }
01083 
01091 static size_t ConvertLandscape(const char *value)
01092 {
01093   /* try with the old values */
01094   return LookupOneOfMany("normal|hilly|desert|candy", value);
01095 }
01096 
01097 static bool CheckFreeformEdges(int32 p1)
01098 {
01099   if (_game_mode == GM_MENU) return true;
01100   if (p1 != 0) {
01101     Ship *s;
01102     FOR_ALL_SHIPS(s) {
01103       /* Check if there is a ship on the northern border. */
01104       if (TileX(s->tile) == 0 || TileY(s->tile) == 0) {
01105         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01106         return false;
01107       }
01108     }
01109     BaseStation *st;
01110     FOR_ALL_BASE_STATIONS(st) {
01111       /* Check if there is a non-deleted buoy on the northern border. */
01112       if (st->IsInUse() && (TileX(st->xy) == 0 || TileY(st->xy) == 0)) {
01113         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01114         return false;
01115       }
01116     }
01117     for (uint i = 0; i < MapSizeX(); i++) MakeVoid(TileXY(i, 0));
01118     for (uint i = 0; i < MapSizeY(); i++) MakeVoid(TileXY(0, i));
01119   } else {
01120     for (uint i = 0; i < MapMaxX(); i++) {
01121       if (TileHeight(TileXY(i, 1)) != 0) {
01122         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01123         return false;
01124       }
01125     }
01126     for (uint i = 1; i < MapMaxX(); i++) {
01127       if (!IsTileType(TileXY(i, MapMaxY() - 1), MP_WATER) || TileHeight(TileXY(1, MapMaxY())) != 0) {
01128         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01129         return false;
01130       }
01131     }
01132     for (uint i = 0; i < MapMaxY(); i++) {
01133       if (TileHeight(TileXY(1, i)) != 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 < MapMaxY(); i++) {
01139       if (!IsTileType(TileXY(MapMaxX() - 1, i), MP_WATER) || TileHeight(TileXY(MapMaxX(), i)) != 0) {
01140         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01141         return false;
01142       }
01143     }
01144     /* Make tiles at the border water again. */
01145     for (uint i = 0; i < MapMaxX(); i++) {
01146       SetTileHeight(TileXY(i, 0), 0);
01147       SetTileType(TileXY(i, 0), MP_WATER);
01148     }
01149     for (uint i = 0; i < MapMaxY(); i++) {
01150       SetTileHeight(TileXY(0, i), 0);
01151       SetTileType(TileXY(0, i), MP_WATER);
01152     }
01153   }
01154   MarkWholeScreenDirty();
01155   return true;
01156 }
01157 
01162 static bool ChangeDynamicEngines(int32 p1)
01163 {
01164   if (_game_mode == GM_MENU) return true;
01165 
01166   if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
01167     ShowErrorMessage(STR_CONFIG_SETTING_DYNAMIC_ENGINES_EXISTING_VEHICLES, INVALID_STRING_ID, WL_ERROR);
01168     return false;
01169   }
01170 
01171   return true;
01172 }
01173 
01174 static bool StationCatchmentChanged(int32 p1)
01175 {
01176   Station::RecomputeIndustriesNearForAll();
01177   return true;
01178 }
01179 
01180 
01181 #ifdef ENABLE_NETWORK
01182 
01183 static bool UpdateClientName(int32 p1)
01184 {
01185   NetworkUpdateClientName();
01186   return true;
01187 }
01188 
01189 static bool UpdateServerPassword(int32 p1)
01190 {
01191   if (strcmp(_settings_client.network.server_password, "*") == 0) {
01192     _settings_client.network.server_password[0] = '\0';
01193   }
01194 
01195   return true;
01196 }
01197 
01198 static bool UpdateRconPassword(int32 p1)
01199 {
01200   if (strcmp(_settings_client.network.rcon_password, "*") == 0) {
01201     _settings_client.network.rcon_password[0] = '\0';
01202   }
01203 
01204   return true;
01205 }
01206 
01207 static bool UpdateClientConfigValues(int32 p1)
01208 {
01209   if (_network_server) NetworkServerSendConfigUpdate();
01210 
01211   return true;
01212 }
01213 
01214 #endif /* ENABLE_NETWORK */
01215 
01216 
01217 /* End - Callback Functions */
01218 
01222 static void PrepareOldDiffCustom()
01223 {
01224   memset(_old_diff_custom, 0, sizeof(_old_diff_custom));
01225 }
01226 
01233 static void HandleOldDiffCustom(bool savegame)
01234 {
01235   uint options_to_load = GAME_DIFFICULTY_NUM - ((savegame && IsSavegameVersionBefore(4)) ? 1 : 0);
01236 
01237   if (!savegame) {
01238     /* If we did read to old_diff_custom, then at least one value must be non 0. */
01239     bool old_diff_custom_used = false;
01240     for (uint i = 0; i < options_to_load && !old_diff_custom_used; i++) {
01241       old_diff_custom_used = (_old_diff_custom[i] != 0);
01242     }
01243 
01244     if (!old_diff_custom_used) return;
01245   }
01246 
01247   for (uint i = 0; i < options_to_load; i++) {
01248     const SettingDesc *sd = &_settings[i];
01249     /* Skip deprecated options */
01250     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01251     void *var = GetVariableAddress(savegame ? &_settings_game : &_settings_newgame, &sd->save);
01252     Write_ValidateSetting(var, sd, (int32)((i == 4 ? 1000 : 1) * _old_diff_custom[i]));
01253   }
01254 }
01255 
01256 static void AILoadConfig(IniFile *ini, const char *grpname)
01257 {
01258   IniGroup *group = ini->GetGroup(grpname);
01259   IniItem *item;
01260 
01261   /* Clean any configured AI */
01262   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01263     AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01264   }
01265 
01266   /* If no group exists, return */
01267   if (group == NULL) return;
01268 
01269   CompanyID c = COMPANY_FIRST;
01270   for (item = group->item; c < MAX_COMPANIES && item != NULL; c++, item = item->next) {
01271     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01272 
01273     config->Change(item->name);
01274     if (!config->HasScript()) {
01275       if (strcmp(item->name, "none") != 0) {
01276         DEBUG(script, 0, "The AI by the name '%s' was no longer found, and removed from the list.", item->name);
01277         continue;
01278       }
01279     }
01280     if (item->value != NULL) config->StringToSettings(item->value);
01281   }
01282 }
01283 
01284 static void GameLoadConfig(IniFile *ini, const char *grpname)
01285 {
01286   IniGroup *group = ini->GetGroup(grpname);
01287   IniItem *item;
01288 
01289   /* Clean any configured GameScript */
01290   GameConfig::GetConfig(GameConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01291 
01292   /* If no group exists, return */
01293   if (group == NULL) return;
01294 
01295   item = group->item;
01296   if (item == NULL) return;
01297 
01298   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01299 
01300   config->Change(item->name);
01301   if (!config->HasScript()) {
01302     if (strcmp(item->name, "none") != 0) {
01303       DEBUG(script, 0, "The GameScript by the name '%s' was no longer found, and removed from the list.", item->name);
01304       return;
01305     }
01306   }
01307   if (item->value != NULL) config->StringToSettings(item->value);
01308 }
01309 
01316 static GRFConfig *GRFLoadConfig(IniFile *ini, const char *grpname, bool is_static)
01317 {
01318   IniGroup *group = ini->GetGroup(grpname);
01319   IniItem *item;
01320   GRFConfig *first = NULL;
01321   GRFConfig **curr = &first;
01322 
01323   if (group == NULL) return NULL;
01324 
01325   for (item = group->item; item != NULL; item = item->next) {
01326     GRFConfig *c = new GRFConfig(item->name);
01327 
01328     /* Parse parameters */
01329     if (!StrEmpty(item->value)) {
01330       c->num_params = ParseIntList(item->value, (int*)c->param, lengthof(c->param));
01331       if (c->num_params == (byte)-1) {
01332         SetDParamStr(0, item->name);
01333         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_ARRAY, WL_CRITICAL);
01334         c->num_params = 0;
01335       }
01336     }
01337 
01338     /* Check if item is valid */
01339     if (!FillGRFDetails(c, is_static) || HasBit(c->flags, GCF_INVALID)) {
01340       if (c->status == GCS_NOT_FOUND) {
01341         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_NOT_FOUND);
01342       } else if (HasBit(c->flags, GCF_UNSAFE)) {
01343         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNSAFE);
01344       } else if (HasBit(c->flags, GCF_SYSTEM)) {
01345         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_SYSTEM);
01346       } else if (HasBit(c->flags, GCF_INVALID)) {
01347         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_INCOMPATIBLE);
01348       } else {
01349         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNKNOWN);
01350       }
01351 
01352       SetDParamStr(0, item->name);
01353       ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_GRF, WL_CRITICAL);
01354       delete c;
01355       continue;
01356     }
01357 
01358     /* Check for duplicate GRFID (will also check for duplicate filenames) */
01359     bool duplicate = false;
01360     for (const GRFConfig *gc = first; gc != NULL; gc = gc->next) {
01361       if (gc->ident.grfid == c->ident.grfid) {
01362         SetDParamStr(0, item->name);
01363         SetDParamStr(1, gc->filename);
01364         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_DUPLICATE_GRFID, WL_CRITICAL);
01365         duplicate = true;
01366         break;
01367       }
01368     }
01369     if (duplicate) {
01370       delete c;
01371       continue;
01372     }
01373 
01374     /* Mark file as static to avoid saving in savegame. */
01375     if (is_static) SetBit(c->flags, GCF_STATIC);
01376 
01377     /* Add item to list */
01378     *curr = c;
01379     curr = &c->next;
01380   }
01381 
01382   return first;
01383 }
01384 
01385 static void AISaveConfig(IniFile *ini, const char *grpname)
01386 {
01387   IniGroup *group = ini->GetGroup(grpname);
01388 
01389   if (group == NULL) return;
01390   group->Clear();
01391 
01392   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01393     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01394     const char *name;
01395     char value[1024];
01396     config->SettingsToString(value, lengthof(value));
01397 
01398     if (config->HasScript()) {
01399       name = config->GetName();
01400     } else {
01401       name = "none";
01402     }
01403 
01404     IniItem *item = new IniItem(group, name, strlen(name));
01405     item->SetValue(value);
01406   }
01407 }
01408 
01409 static void GameSaveConfig(IniFile *ini, const char *grpname)
01410 {
01411   IniGroup *group = ini->GetGroup(grpname);
01412 
01413   if (group == NULL) return;
01414   group->Clear();
01415 
01416   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01417   const char *name;
01418   char value[1024];
01419   config->SettingsToString(value, lengthof(value));
01420 
01421   if (config->HasScript()) {
01422     name = config->GetName();
01423   } else {
01424     name = "none";
01425   }
01426 
01427   IniItem *item = new IniItem(group, name, strlen(name));
01428   item->SetValue(value);
01429 }
01430 
01435 static void SaveVersionInConfig(IniFile *ini)
01436 {
01437   IniGroup *group = ini->GetGroup("version");
01438 
01439   char version[9];
01440   snprintf(version, lengthof(version), "%08X", _openttd_newgrf_version);
01441 
01442   const char * const versions[][2] = {
01443     { "version_string", _openttd_revision },
01444     { "version_number", version }
01445   };
01446 
01447   for (uint i = 0; i < lengthof(versions); i++) {
01448     group->GetItem(versions[i][0], true)->SetValue(versions[i][1]);
01449   }
01450 }
01451 
01452 /* Save a GRF configuration to the given group name */
01453 static void GRFSaveConfig(IniFile *ini, const char *grpname, const GRFConfig *list)
01454 {
01455   ini->RemoveGroup(grpname);
01456   IniGroup *group = ini->GetGroup(grpname);
01457   const GRFConfig *c;
01458 
01459   for (c = list; c != NULL; c = c->next) {
01460     char params[512];
01461     GRFBuildParamList(params, c, lastof(params));
01462 
01463     group->GetItem(c->filename, true)->SetValue(params);
01464   }
01465 }
01466 
01467 /* Common handler for saving/loading variables to the configuration file */
01468 static void HandleSettingDescs(IniFile *ini, SettingDescProc *proc, SettingDescProcList *proc_list, bool basic_settings = true, bool other_settings = true)
01469 {
01470   if (basic_settings) {
01471     proc(ini, (const SettingDesc*)_misc_settings,    "misc",  NULL);
01472 #if defined(WIN32) && !defined(DEDICATED)
01473     proc(ini, (const SettingDesc*)_win32_settings,   "win32", NULL);
01474 #endif /* WIN32 */
01475   }
01476 
01477   if (other_settings) {
01478     proc(ini, _settings,         "patches",  &_settings_newgame);
01479     proc(ini, _currency_settings,"currency", &_custom_currency);
01480     proc(ini, _company_settings, "company",  &_settings_client.company);
01481 
01482 #ifdef ENABLE_NETWORK
01483     proc_list(ini, "server_bind_addresses", &_network_bind_list);
01484     proc_list(ini, "servers", &_network_host_list);
01485     proc_list(ini, "bans",    &_network_ban_list);
01486 #endif /* ENABLE_NETWORK */
01487   }
01488 }
01489 
01490 static IniFile *IniLoadConfig()
01491 {
01492   IniFile *ini = new IniFile(_list_group_names);
01493   ini->LoadFromDisk(_config_file, BASE_DIR);
01494   return ini;
01495 }
01496 
01501 void LoadFromConfig(bool minimal)
01502 {
01503   IniFile *ini = IniLoadConfig();
01504   if (!minimal) ResetCurrencies(false); // Initialize the array of curencies, without preserving the custom one
01505 
01506   /* Load basic settings only during bootstrap, load other settings not during bootstrap */
01507   HandleSettingDescs(ini, IniLoadSettings, IniLoadSettingList, minimal, !minimal);
01508 
01509   if (!minimal) {
01510     _grfconfig_newgame = GRFLoadConfig(ini, "newgrf", false);
01511     _grfconfig_static  = GRFLoadConfig(ini, "newgrf-static", true);
01512     AILoadConfig(ini, "ai_players");
01513     GameLoadConfig(ini, "game_scripts");
01514 
01515     PrepareOldDiffCustom();
01516     IniLoadSettings(ini, _gameopt_settings, "gameopt", &_settings_newgame);
01517     HandleOldDiffCustom(false);
01518 
01519     ValidateSettings();
01520 
01521     /* Display sheduled errors */
01522     extern void ScheduleErrorMessage(ErrorList &datas);
01523     ScheduleErrorMessage(_settings_error_list);
01524     if (FindWindowById(WC_ERRMSG, 0) == NULL) ShowFirstError();
01525   }
01526 
01527   delete ini;
01528 }
01529 
01531 void SaveToConfig()
01532 {
01533   IniFile *ini = IniLoadConfig();
01534 
01535   /* Remove some obsolete groups. These have all been loaded into other groups. */
01536   ini->RemoveGroup("patches");
01537   ini->RemoveGroup("yapf");
01538   ini->RemoveGroup("gameopt");
01539 
01540   HandleSettingDescs(ini, IniSaveSettings, IniSaveSettingList);
01541   GRFSaveConfig(ini, "newgrf", _grfconfig_newgame);
01542   GRFSaveConfig(ini, "newgrf-static", _grfconfig_static);
01543   AISaveConfig(ini, "ai_players");
01544   GameSaveConfig(ini, "game_scripts");
01545   SaveVersionInConfig(ini);
01546   ini->SaveToDisk(_config_file);
01547   delete ini;
01548 }
01549 
01554 void GetGRFPresetList(GRFPresetList *list)
01555 {
01556   list->Clear();
01557 
01558   IniFile *ini = IniLoadConfig();
01559   IniGroup *group;
01560   for (group = ini->group; group != NULL; group = group->next) {
01561     if (strncmp(group->name, "preset-", 7) == 0) {
01562       *list->Append() = strdup(group->name + 7);
01563     }
01564   }
01565 
01566   delete ini;
01567 }
01568 
01575 GRFConfig *LoadGRFPresetFromConfig(const char *config_name)
01576 {
01577   char *section = (char*)alloca(strlen(config_name) + 8);
01578   sprintf(section, "preset-%s", config_name);
01579 
01580   IniFile *ini = IniLoadConfig();
01581   GRFConfig *config = GRFLoadConfig(ini, section, false);
01582   delete ini;
01583 
01584   return config;
01585 }
01586 
01593 void SaveGRFPresetToConfig(const char *config_name, GRFConfig *config)
01594 {
01595   char *section = (char*)alloca(strlen(config_name) + 8);
01596   sprintf(section, "preset-%s", config_name);
01597 
01598   IniFile *ini = IniLoadConfig();
01599   GRFSaveConfig(ini, section, config);
01600   ini->SaveToDisk(_config_file);
01601   delete ini;
01602 }
01603 
01608 void DeleteGRFPresetFromConfig(const char *config_name)
01609 {
01610   char *section = (char*)alloca(strlen(config_name) + 8);
01611   sprintf(section, "preset-%s", config_name);
01612 
01613   IniFile *ini = IniLoadConfig();
01614   ini->RemoveGroup(section);
01615   ini->SaveToDisk(_config_file);
01616   delete ini;
01617 }
01618 
01619 const SettingDesc *GetSettingDescription(uint index)
01620 {
01621   if (index >= lengthof(_settings)) return NULL;
01622   return &_settings[index];
01623 }
01624 
01636 CommandCost CmdChangeSetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01637 {
01638   const SettingDesc *sd = GetSettingDescription(p1);
01639 
01640   if (sd == NULL) return CMD_ERROR;
01641   if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) return CMD_ERROR;
01642 
01643   if (!sd->IsEditable(true)) return CMD_ERROR;
01644 
01645   if (flags & DC_EXEC) {
01646     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01647 
01648     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01649     int32 newval = (int32)p2;
01650 
01651     Write_ValidateSetting(var, sd, newval);
01652     newval = (int32)ReadValue(var, sd->save.conv);
01653 
01654     if (oldval == newval) return CommandCost();
01655 
01656     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01657       WriteValue(var, sd->save.conv, (int64)oldval);
01658       return CommandCost();
01659     }
01660 
01661     if (sd->desc.flags & SGF_NO_NETWORK) {
01662       GamelogStartAction(GLAT_SETTING);
01663       GamelogSetting(sd->desc.name, oldval, newval);
01664       GamelogStopAction();
01665     }
01666 
01667     SetWindowClassesDirty(WC_GAME_OPTIONS);
01668   }
01669 
01670   return CommandCost();
01671 }
01672 
01683 CommandCost CmdChangeCompanySetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01684 {
01685   if (p1 >= lengthof(_company_settings)) return CMD_ERROR;
01686   const SettingDesc *sd = &_company_settings[p1];
01687 
01688   if (flags & DC_EXEC) {
01689     void *var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01690 
01691     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01692     int32 newval = (int32)p2;
01693 
01694     Write_ValidateSetting(var, sd, newval);
01695     newval = (int32)ReadValue(var, sd->save.conv);
01696 
01697     if (oldval == newval) return CommandCost();
01698 
01699     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01700       WriteValue(var, sd->save.conv, (int64)oldval);
01701       return CommandCost();
01702     }
01703 
01704     SetWindowClassesDirty(WC_GAME_OPTIONS);
01705   }
01706 
01707   return CommandCost();
01708 }
01709 
01717 bool SetSettingValue(uint index, int32 value, bool force_newgame)
01718 {
01719   const SettingDesc *sd = &_settings[index];
01720   /* If an item is company-based, we do not send it over the network
01721    * (if any) to change. Also *hack*hack* we update the _newgame version
01722    * of settings because changing a company-based setting in a game also
01723    * changes its defaults. At least that is the convention we have chosen */
01724   if (sd->save.conv & SLF_NO_NETWORK_SYNC) {
01725     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01726     Write_ValidateSetting(var, sd, value);
01727 
01728     if (_game_mode != GM_MENU) {
01729       void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01730       Write_ValidateSetting(var2, sd, value);
01731     }
01732     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01733 
01734     SetWindowClassesDirty(WC_GAME_OPTIONS);
01735 
01736     return true;
01737   }
01738 
01739   if (force_newgame) {
01740     void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01741     Write_ValidateSetting(var2, sd, value);
01742     return true;
01743   }
01744 
01745   /* send non-company-based settings over the network */
01746   if (!_networking || (_networking && _network_server)) {
01747     return DoCommandP(0, index, value, CMD_CHANGE_SETTING);
01748   }
01749   return false;
01750 }
01751 
01758 void SetCompanySetting(uint index, int32 value)
01759 {
01760   const SettingDesc *sd = &_company_settings[index];
01761   if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
01762     DoCommandP(0, index, value, CMD_CHANGE_COMPANY_SETTING);
01763   } else {
01764     void *var = GetVariableAddress(&_settings_client.company, &sd->save);
01765     Write_ValidateSetting(var, sd, value);
01766     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01767   }
01768 }
01769 
01773 void SetDefaultCompanySettings(CompanyID cid)
01774 {
01775   Company *c = Company::Get(cid);
01776   const SettingDesc *sd;
01777   for (sd = _company_settings; sd->save.cmd != SL_END; sd++) {
01778     void *var = GetVariableAddress(&c->settings, &sd->save);
01779     Write_ValidateSetting(var, sd, (int32)(size_t)sd->desc.def);
01780   }
01781 }
01782 
01783 #if defined(ENABLE_NETWORK)
01784 
01787 void SyncCompanySettings()
01788 {
01789   const SettingDesc *sd;
01790   uint i = 0;
01791   for (sd = _company_settings; sd->save.cmd != SL_END; sd++, i++) {
01792     const void *old_var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01793     const void *new_var = GetVariableAddress(&_settings_client.company, &sd->save);
01794     uint32 old_value = (uint32)ReadValue(old_var, sd->save.conv);
01795     uint32 new_value = (uint32)ReadValue(new_var, sd->save.conv);
01796     if (old_value != new_value) NetworkSendCommand(0, i, new_value, CMD_CHANGE_COMPANY_SETTING, NULL, NULL, _local_company);
01797   }
01798 }
01799 #endif /* ENABLE_NETWORK */
01800 
01806 uint GetCompanySettingIndex(const char *name)
01807 {
01808   uint i;
01809   const SettingDesc *sd = GetSettingFromName(name, &i);
01810   assert(sd != NULL && (sd->desc.flags & SGF_PER_COMPANY) != 0);
01811   return i;
01812 }
01813 
01821 bool SetSettingValue(uint index, const char *value, bool force_newgame)
01822 {
01823   const SettingDesc *sd = &_settings[index];
01824   assert(sd->save.conv & SLF_NO_NETWORK_SYNC);
01825 
01826   if (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) {
01827     char **var = (char**)GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01828     free(*var);
01829     *var = strcmp(value, "(null)") == 0 ? NULL : strdup(value);
01830   } else {
01831     char *var = (char*)GetVariableAddress(NULL, &sd->save);
01832     ttd_strlcpy(var, value, sd->save.length);
01833   }
01834   if (sd->desc.proc != NULL) sd->desc.proc(0);
01835 
01836   return true;
01837 }
01838 
01846 const SettingDesc *GetSettingFromName(const char *name, uint *i)
01847 {
01848   const SettingDesc *sd;
01849 
01850   /* First check all full names */
01851   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01852     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01853     if (strcmp(sd->desc.name, name) == 0) return sd;
01854   }
01855 
01856   /* Then check the shortcut variant of the name. */
01857   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01858     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01859     const char *short_name = strchr(sd->desc.name, '.');
01860     if (short_name != NULL) {
01861       short_name++;
01862       if (strcmp(short_name, name) == 0) return sd;
01863     }
01864   }
01865 
01866   if (strncmp(name, "company.", 8) == 0) name += 8;
01867   /* And finally the company-based settings */
01868   for (*i = 0, sd = _company_settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01869     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01870     if (strcmp(sd->desc.name, name) == 0) return sd;
01871   }
01872 
01873   return NULL;
01874 }
01875 
01876 /* Those 2 functions need to be here, else we have to make some stuff non-static
01877  * and besides, it is also better to keep stuff like this at the same place */
01878 void IConsoleSetSetting(const char *name, const char *value, bool force_newgame)
01879 {
01880   uint index;
01881   const SettingDesc *sd = GetSettingFromName(name, &index);
01882 
01883   if (sd == NULL) {
01884     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01885     return;
01886   }
01887 
01888   bool success;
01889   if (sd->desc.cmd == SDT_STRING) {
01890     success = SetSettingValue(index, value, force_newgame);
01891   } else {
01892     uint32 val;
01893     extern bool GetArgumentInteger(uint32 *value, const char *arg);
01894     success = GetArgumentInteger(&val, value);
01895     if (!success) {
01896       IConsolePrintF(CC_ERROR, "'%s' is not an integer.", value);
01897       return;
01898     }
01899 
01900     success = SetSettingValue(index, val, force_newgame);
01901   }
01902 
01903   if (!success) {
01904     if (_network_server) {
01905       IConsoleError("This command/variable is not available during network games.");
01906     } else {
01907       IConsoleError("This command/variable is only available to a network server.");
01908     }
01909   }
01910 }
01911 
01912 void IConsoleSetSetting(const char *name, int value)
01913 {
01914   uint index;
01915   const SettingDesc *sd = GetSettingFromName(name, &index);
01916   assert(sd != NULL);
01917   SetSettingValue(index, value);
01918 }
01919 
01925 void IConsoleGetSetting(const char *name, bool force_newgame)
01926 {
01927   char value[20];
01928   uint index;
01929   const SettingDesc *sd = GetSettingFromName(name, &index);
01930   const void *ptr;
01931 
01932   if (sd == NULL) {
01933     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01934     return;
01935   }
01936 
01937   ptr = GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01938 
01939   if (sd->desc.cmd == SDT_STRING) {
01940     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s'", name, (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
01941   } else {
01942     if (sd->desc.cmd == SDT_BOOLX) {
01943       snprintf(value, sizeof(value), (*(const bool*)ptr != 0) ? "on" : "off");
01944     } else {
01945       snprintf(value, sizeof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
01946     }
01947 
01948     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s' (min: %s%d, max: %u)",
01949       name, value, (sd->desc.flags & SGF_0ISDISABLED) ? "(0) " : "", sd->desc.min, sd->desc.max);
01950   }
01951 }
01952 
01958 void IConsoleListSettings(const char *prefilter)
01959 {
01960   IConsolePrintF(CC_WARNING, "All settings with their current value:");
01961 
01962   for (const SettingDesc *sd = _settings; sd->save.cmd != SL_END; sd++) {
01963     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01964     if (prefilter != NULL && strstr(sd->desc.name, prefilter) == NULL) continue;
01965     char value[80];
01966     const void *ptr = GetVariableAddress(&GetGameSettings(), &sd->save);
01967 
01968     if (sd->desc.cmd == SDT_BOOLX) {
01969       snprintf(value, lengthof(value), (*(const bool *)ptr != 0) ? "on" : "off");
01970     } else if (sd->desc.cmd == SDT_STRING) {
01971       snprintf(value, sizeof(value), "%s", (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
01972     } else {
01973       snprintf(value, lengthof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
01974     }
01975     IConsolePrintF(CC_DEFAULT, "%s = %s", sd->desc.name, value);
01976   }
01977 
01978   IConsolePrintF(CC_WARNING, "Use 'setting' command to change a value");
01979 }
01980 
01987 static void LoadSettings(const SettingDesc *osd, void *object)
01988 {
01989   for (; osd->save.cmd != SL_END; osd++) {
01990     const SaveLoad *sld = &osd->save;
01991     void *ptr = GetVariableAddress(object, sld);
01992 
01993     if (!SlObjectMember(ptr, sld)) continue;
01994     if (IsNumericType(sld->conv)) Write_ValidateSetting(ptr, osd, ReadValue(ptr, sld->conv));
01995   }
01996 }
01997 
02004 static void SaveSettings(const SettingDesc *sd, void *object)
02005 {
02006   /* We need to write the CH_RIFF header, but unfortunately can't call
02007    * SlCalcLength() because we have a different format. So do this manually */
02008   const SettingDesc *i;
02009   size_t length = 0;
02010   for (i = sd; i->save.cmd != SL_END; i++) {
02011     length += SlCalcObjMemberLength(object, &i->save);
02012   }
02013   SlSetLength(length);
02014 
02015   for (i = sd; i->save.cmd != SL_END; i++) {
02016     void *ptr = GetVariableAddress(object, &i->save);
02017     SlObjectMember(ptr, &i->save);
02018   }
02019 }
02020 
02021 static void Load_OPTS()
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    * autosave-frequency stays when joining a network-server */
02026   PrepareOldDiffCustom();
02027   LoadSettings(_gameopt_settings, &_settings_game);
02028   HandleOldDiffCustom(true);
02029 }
02030 
02031 static void Load_PATS()
02032 {
02033   /* Copy over default setting since some might not get loaded in
02034    * a networking environment. This ensures for example that the local
02035    * currency setting stays when joining a network-server */
02036   LoadSettings(_settings, &_settings_game);
02037 }
02038 
02039 static void Check_PATS()
02040 {
02041   LoadSettings(_settings, &_load_check_data.settings);
02042 }
02043 
02044 static void Save_PATS()
02045 {
02046   SaveSettings(_settings, &_settings_game);
02047 }
02048 
02049 void CheckConfig()
02050 {
02051   /*
02052    * Increase old default values for pf_maxdepth and pf_maxlength
02053    * to support big networks.
02054    */
02055   if (_settings_newgame.pf.opf.pf_maxdepth == 16 && _settings_newgame.pf.opf.pf_maxlength == 512) {
02056     _settings_newgame.pf.opf.pf_maxdepth = 48;
02057     _settings_newgame.pf.opf.pf_maxlength = 4096;
02058   }
02059 }
02060 
02061 extern const ChunkHandler _setting_chunk_handlers[] = {
02062   { 'OPTS', NULL,      Load_OPTS, NULL, NULL,       CH_RIFF},
02063   { 'PATS', Save_PATS, Load_PATS, NULL, Check_PATS, CH_RIFF | CH_LAST},
02064 };
02065 
02066 static bool IsSignedVarMemType(VarType vt)
02067 {
02068   switch (GetVarMemType(vt)) {
02069     case SLE_VAR_I8:
02070     case SLE_VAR_I16:
02071     case SLE_VAR_I32:
02072     case SLE_VAR_I64:
02073       return true;
02074   }
02075   return false;
02076 }