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