settings.cpp

Go to the documentation of this file.
00001 /* $Id: settings.cpp 25358 2013-06-09 13:02:05Z fonsinchen $ */
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 
00741 void IniLoadWindowSettings(IniFile *ini, const char *grpname, void *desc)
00742 {
00743   IniLoadSettings(ini, _window_settings, grpname, desc);
00744 }
00745 
00752 void IniSaveWindowSettings(IniFile *ini, const char *grpname, void *desc)
00753 {
00754   IniSaveSettings(ini, _window_settings, grpname, desc);
00755 }
00756 
00762 bool SettingDesc::IsEditable(bool do_command) const
00763 {
00764   if (!do_command && !(this->save.conv & SLF_NO_NETWORK_SYNC) && _networking && !_network_server && !(this->desc.flags & SGF_PER_COMPANY)) return false;
00765   if ((this->desc.flags & SGF_NETWORK_ONLY) && !_networking && _game_mode != GM_MENU) return false;
00766   if ((this->desc.flags & SGF_NO_NETWORK) && _networking) return false;
00767   if ((this->desc.flags & SGF_NEWGAME_ONLY) &&
00768       (_game_mode == GM_NORMAL ||
00769       (_game_mode == GM_EDITOR && !(this->desc.flags & SGF_SCENEDIT_TOO)))) return false;
00770   return true;
00771 }
00772 
00777 SettingType SettingDesc::GetType() const
00778 {
00779   if (this->desc.flags & SGF_PER_COMPANY) return ST_COMPANY;
00780   return (this->save.conv & SLF_NOT_IN_SAVE) ? ST_CLIENT : ST_GAME;
00781 }
00782 
00783 /* Begin - Callback Functions for the various settings. */
00784 
00786 static bool v_PositionMainToolbar(int32 p1)
00787 {
00788   if (_game_mode != GM_MENU) PositionMainToolbar(NULL);
00789   return true;
00790 }
00791 
00793 static bool v_PositionStatusbar(int32 p1)
00794 {
00795   if (_game_mode != GM_MENU) {
00796     PositionStatusbar(NULL);
00797     PositionNewsMessage(NULL);
00798     PositionNetworkChatWindow(NULL);
00799   }
00800   return true;
00801 }
00802 
00803 static bool PopulationInLabelActive(int32 p1)
00804 {
00805   UpdateAllTownVirtCoords();
00806   return true;
00807 }
00808 
00809 static bool RedrawScreen(int32 p1)
00810 {
00811   MarkWholeScreenDirty();
00812   return true;
00813 }
00814 
00820 static bool RedrawSmallmap(int32 p1)
00821 {
00822   BuildLandLegend();
00823   BuildOwnerLegend();
00824   SetWindowClassesDirty(WC_SMALLMAP);
00825   return true;
00826 }
00827 
00828 static bool InvalidateDetailsWindow(int32 p1)
00829 {
00830   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00831   return true;
00832 }
00833 
00834 static bool StationSpreadChanged(int32 p1)
00835 {
00836   InvalidateWindowData(WC_SELECT_STATION, 0);
00837   InvalidateWindowData(WC_BUILD_STATION, 0);
00838   return true;
00839 }
00840 
00841 static bool InvalidateBuildIndustryWindow(int32 p1)
00842 {
00843   InvalidateWindowData(WC_BUILD_INDUSTRY, 0);
00844   return true;
00845 }
00846 
00847 static bool CloseSignalGUI(int32 p1)
00848 {
00849   if (p1 == 0) {
00850     DeleteWindowByClass(WC_BUILD_SIGNAL);
00851   }
00852   return true;
00853 }
00854 
00855 static bool InvalidateTownViewWindow(int32 p1)
00856 {
00857   InvalidateWindowClassesData(WC_TOWN_VIEW, p1);
00858   return true;
00859 }
00860 
00861 static bool DeleteSelectStationWindow(int32 p1)
00862 {
00863   DeleteWindowById(WC_SELECT_STATION, 0);
00864   return true;
00865 }
00866 
00867 static bool UpdateConsists(int32 p1)
00868 {
00869   Train *t;
00870   FOR_ALL_TRAINS(t) {
00871     /* Update the consist of all trains so the maximum speed is set correctly. */
00872     if (t->IsFrontEngine() || t->IsFreeWagon()) t->ConsistChanged(true);
00873   }
00874   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00875   return true;
00876 }
00877 
00878 /* Check service intervals of vehicles, p1 is value of % or day based servicing */
00879 static bool CheckInterval(int32 p1)
00880 {
00881   bool update_vehicles;
00882   VehicleDefaultSettings *vds;
00883   if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
00884     vds = &_settings_client.company.vehicle;
00885     update_vehicles = false;
00886   } else {
00887     vds = &Company::Get(_current_company)->settings.vehicle;
00888     update_vehicles = true;
00889   }
00890 
00891   if (p1 != 0) {
00892     vds->servint_trains   = 50;
00893     vds->servint_roadveh  = 50;
00894     vds->servint_aircraft = 50;
00895     vds->servint_ships    = 50;
00896   } else {
00897     vds->servint_trains   = 150;
00898     vds->servint_roadveh  = 150;
00899     vds->servint_aircraft = 100;
00900     vds->servint_ships    = 360;
00901   }
00902 
00903   if (update_vehicles) {
00904     const Company *c = Company::Get(_current_company);
00905     Vehicle *v;
00906     FOR_ALL_VEHICLES(v) {
00907       if (v->owner == _current_company && v->IsPrimaryVehicle() && !v->ServiceIntervalIsCustom()) {
00908         v->SetServiceInterval(CompanyServiceInterval(c, v->type));
00909         v->SetServiceIntervalIsPercent(p1 != 0);
00910       }
00911     }
00912   }
00913 
00914   InvalidateDetailsWindow(0);
00915 
00916   return true;
00917 }
00918 
00919 static bool UpdateInterval(VehicleType type, int32 p1)
00920 {
00921   bool update_vehicles;
00922   VehicleDefaultSettings *vds;
00923   if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
00924     vds = &_settings_client.company.vehicle;
00925     update_vehicles = false;
00926   } else {
00927     vds = &Company::Get(_current_company)->settings.vehicle;
00928     update_vehicles = true;
00929   }
00930 
00931   /* Test if the interval is valid */
00932   uint16 interval = GetServiceIntervalClamped(p1, vds->servint_ispercent);
00933   if (interval != p1) return false;
00934 
00935   if (update_vehicles) {
00936     Vehicle *v;
00937     FOR_ALL_VEHICLES(v) {
00938       if (v->owner == _current_company && v->type == type && v->IsPrimaryVehicle() && !v->ServiceIntervalIsCustom()) {
00939         v->SetServiceInterval(p1);
00940       }
00941     }
00942   }
00943 
00944   InvalidateDetailsWindow(0);
00945 
00946   return true;
00947 }
00948 
00949 static bool UpdateIntervalTrains(int32 p1)
00950 {
00951   return UpdateInterval(VEH_TRAIN, p1);
00952 }
00953 
00954 static bool UpdateIntervalRoadVeh(int32 p1)
00955 {
00956   return UpdateInterval(VEH_ROAD, p1);
00957 }
00958 
00959 static bool UpdateIntervalShips(int32 p1)
00960 {
00961   return UpdateInterval(VEH_SHIP, p1);
00962 }
00963 
00964 static bool UpdateIntervalAircraft(int32 p1)
00965 {
00966   return UpdateInterval(VEH_AIRCRAFT, p1);
00967 }
00968 
00969 static bool TrainAccelerationModelChanged(int32 p1)
00970 {
00971   Train *t;
00972   FOR_ALL_TRAINS(t) {
00973     if (t->IsFrontEngine()) {
00974       t->tcache.cached_max_curve_speed = t->GetCurveSpeedLimit();
00975       t->UpdateAcceleration();
00976     }
00977   }
00978 
00979   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
00980   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
00981   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
00982   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
00983 
00984   return true;
00985 }
00986 
00992 static bool TrainSlopeSteepnessChanged(int32 p1)
00993 {
00994   Train *t;
00995   FOR_ALL_TRAINS(t) {
00996     if (t->IsFrontEngine()) t->CargoChanged();
00997   }
00998 
00999   return true;
01000 }
01001 
01007 static bool RoadVehAccelerationModelChanged(int32 p1)
01008 {
01009   if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) {
01010     RoadVehicle *rv;
01011     FOR_ALL_ROADVEHICLES(rv) {
01012       if (rv->IsFrontEngine()) {
01013         rv->CargoChanged();
01014       }
01015     }
01016   }
01017 
01018   /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
01019   SetWindowClassesDirty(WC_ENGINE_PREVIEW);
01020   InvalidateWindowClassesData(WC_BUILD_VEHICLE, 0);
01021   SetWindowClassesDirty(WC_VEHICLE_DETAILS);
01022 
01023   return true;
01024 }
01025 
01031 static bool RoadVehSlopeSteepnessChanged(int32 p1)
01032 {
01033   RoadVehicle *rv;
01034   FOR_ALL_ROADVEHICLES(rv) {
01035     if (rv->IsFrontEngine()) rv->CargoChanged();
01036   }
01037 
01038   return true;
01039 }
01040 
01041 static bool DragSignalsDensityChanged(int32)
01042 {
01043   InvalidateWindowData(WC_BUILD_SIGNAL, 0);
01044 
01045   return true;
01046 }
01047 
01048 static bool TownFoundingChanged(int32 p1)
01049 {
01050   if (_game_mode != GM_EDITOR && _settings_game.economy.found_town == TF_FORBIDDEN) {
01051     DeleteWindowById(WC_FOUND_TOWN, 0);
01052     return true;
01053   }
01054   InvalidateWindowData(WC_FOUND_TOWN, 0);
01055   return true;
01056 }
01057 
01058 static bool InvalidateVehTimetableWindow(int32 p1)
01059 {
01060   InvalidateWindowClassesData(WC_VEHICLE_TIMETABLE, VIWD_MODIFY_ORDERS);
01061   return true;
01062 }
01063 
01064 static bool ZoomMinMaxChanged(int32 p1)
01065 {
01066   extern void ConstrainAllViewportsZoom();
01067   ConstrainAllViewportsZoom();
01068   GfxClearSpriteCache();
01069   return true;
01070 }
01071 
01079 static bool InvalidateNewGRFChangeWindows(int32 p1)
01080 {
01081   InvalidateWindowClassesData(WC_SAVELOAD);
01082   DeleteWindowByClass(WC_GAME_OPTIONS);
01083   ReInitAllWindows();
01084   return true;
01085 }
01086 
01087 static bool InvalidateCompanyLiveryWindow(int32 p1)
01088 {
01089   InvalidateWindowClassesData(WC_COMPANY_COLOUR);
01090   return RedrawScreen(p1);
01091 }
01092 
01093 static bool InvalidateIndustryViewWindow(int32 p1)
01094 {
01095   InvalidateWindowClassesData(WC_INDUSTRY_VIEW);
01096   return true;
01097 }
01098 
01099 static bool InvalidateAISettingsWindow(int32 p1)
01100 {
01101   InvalidateWindowClassesData(WC_AI_SETTINGS);
01102   return true;
01103 }
01104 
01110 static bool RedrawTownAuthority(int32 p1)
01111 {
01112   SetWindowClassesDirty(WC_TOWN_AUTHORITY);
01113   return true;
01114 }
01115 
01121 static bool InvalidateCompanyInfrastructureWindow(int32 p1)
01122 {
01123   InvalidateWindowClassesData(WC_COMPANY_INFRASTRUCTURE);
01124   return true;
01125 }
01126 
01132 static bool InvalidateCompanyWindow(int32 p1)
01133 {
01134   InvalidateWindowClassesData(WC_COMPANY);
01135   return true;
01136 }
01137 
01139 static void ValidateSettings()
01140 {
01141   /* Do not allow a custom sea level with the original land generator. */
01142   if (_settings_newgame.game_creation.land_generator == 0 &&
01143       _settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
01144     _settings_newgame.difficulty.quantity_sea_lakes = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE;
01145   }
01146 }
01147 
01148 static bool DifficultyNoiseChange(int32 i)
01149 {
01150   if (_game_mode == GM_NORMAL) {
01151     UpdateAirportsNoise();
01152     if (_settings_game.economy.station_noise_level) {
01153       InvalidateWindowClassesData(WC_TOWN_VIEW, 0);
01154     }
01155   }
01156 
01157   return true;
01158 }
01159 
01160 static bool MaxNoAIsChange(int32 i)
01161 {
01162   if (GetGameSettings().difficulty.max_no_competitors != 0 &&
01163       AI::GetInfoList()->size() == 0 &&
01164       (!_networking || _network_server)) {
01165     ShowErrorMessage(STR_WARNING_NO_SUITABLE_AI, INVALID_STRING_ID, WL_CRITICAL);
01166   }
01167 
01168   return true;
01169 }
01170 
01176 static bool CheckRoadSide(int p1)
01177 {
01178   extern bool RoadVehiclesAreBuilt();
01179   return _game_mode == GM_MENU || !RoadVehiclesAreBuilt();
01180 }
01181 
01189 static size_t ConvertLandscape(const char *value)
01190 {
01191   /* try with the old values */
01192   return LookupOneOfMany("normal|hilly|desert|candy", value);
01193 }
01194 
01195 static bool CheckFreeformEdges(int32 p1)
01196 {
01197   if (_game_mode == GM_MENU) return true;
01198   if (p1 != 0) {
01199     Ship *s;
01200     FOR_ALL_SHIPS(s) {
01201       /* Check if there is a ship on the northern border. */
01202       if (TileX(s->tile) == 0 || TileY(s->tile) == 0) {
01203         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01204         return false;
01205       }
01206     }
01207     BaseStation *st;
01208     FOR_ALL_BASE_STATIONS(st) {
01209       /* Check if there is a non-deleted buoy on the northern border. */
01210       if (st->IsInUse() && (TileX(st->xy) == 0 || TileY(st->xy) == 0)) {
01211         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_EMPTY, INVALID_STRING_ID, WL_ERROR);
01212         return false;
01213       }
01214     }
01215     for (uint i = 0; i < MapSizeX(); i++) MakeVoid(TileXY(i, 0));
01216     for (uint i = 0; i < MapSizeY(); i++) MakeVoid(TileXY(0, i));
01217   } else {
01218     for (uint i = 0; i < MapMaxX(); i++) {
01219       if (TileHeight(TileXY(i, 1)) != 0) {
01220         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01221         return false;
01222       }
01223     }
01224     for (uint i = 1; i < MapMaxX(); i++) {
01225       if (!IsTileType(TileXY(i, MapMaxY() - 1), MP_WATER) || TileHeight(TileXY(1, MapMaxY())) != 0) {
01226         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01227         return false;
01228       }
01229     }
01230     for (uint i = 0; i < MapMaxY(); i++) {
01231       if (TileHeight(TileXY(1, i)) != 0) {
01232         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01233         return false;
01234       }
01235     }
01236     for (uint i = 1; i < MapMaxY(); i++) {
01237       if (!IsTileType(TileXY(MapMaxX() - 1, i), MP_WATER) || TileHeight(TileXY(MapMaxX(), i)) != 0) {
01238         ShowErrorMessage(STR_CONFIG_SETTING_EDGES_NOT_WATER, INVALID_STRING_ID, WL_ERROR);
01239         return false;
01240       }
01241     }
01242     /* Make tiles at the border water again. */
01243     for (uint i = 0; i < MapMaxX(); i++) {
01244       SetTileHeight(TileXY(i, 0), 0);
01245       SetTileType(TileXY(i, 0), MP_WATER);
01246     }
01247     for (uint i = 0; i < MapMaxY(); i++) {
01248       SetTileHeight(TileXY(0, i), 0);
01249       SetTileType(TileXY(0, i), MP_WATER);
01250     }
01251   }
01252   MarkWholeScreenDirty();
01253   return true;
01254 }
01255 
01260 static bool ChangeDynamicEngines(int32 p1)
01261 {
01262   if (_game_mode == GM_MENU) return true;
01263 
01264   if (!EngineOverrideManager::ResetToCurrentNewGRFConfig()) {
01265     ShowErrorMessage(STR_CONFIG_SETTING_DYNAMIC_ENGINES_EXISTING_VEHICLES, INVALID_STRING_ID, WL_ERROR);
01266     return false;
01267   }
01268 
01269   return true;
01270 }
01271 
01272 static bool StationCatchmentChanged(int32 p1)
01273 {
01274   Station::RecomputeIndustriesNearForAll();
01275   return true;
01276 }
01277 
01278 
01279 #ifdef ENABLE_NETWORK
01280 
01281 static bool UpdateClientName(int32 p1)
01282 {
01283   NetworkUpdateClientName();
01284   return true;
01285 }
01286 
01287 static bool UpdateServerPassword(int32 p1)
01288 {
01289   if (strcmp(_settings_client.network.server_password, "*") == 0) {
01290     _settings_client.network.server_password[0] = '\0';
01291   }
01292 
01293   return true;
01294 }
01295 
01296 static bool UpdateRconPassword(int32 p1)
01297 {
01298   if (strcmp(_settings_client.network.rcon_password, "*") == 0) {
01299     _settings_client.network.rcon_password[0] = '\0';
01300   }
01301 
01302   return true;
01303 }
01304 
01305 static bool UpdateClientConfigValues(int32 p1)
01306 {
01307   if (_network_server) NetworkServerSendConfigUpdate();
01308 
01309   return true;
01310 }
01311 
01312 #endif /* ENABLE_NETWORK */
01313 
01314 
01315 /* End - Callback Functions */
01316 
01320 static void PrepareOldDiffCustom()
01321 {
01322   memset(_old_diff_custom, 0, sizeof(_old_diff_custom));
01323 }
01324 
01331 static void HandleOldDiffCustom(bool savegame)
01332 {
01333   uint options_to_load = GAME_DIFFICULTY_NUM - ((savegame && IsSavegameVersionBefore(4)) ? 1 : 0);
01334 
01335   if (!savegame) {
01336     /* If we did read to old_diff_custom, then at least one value must be non 0. */
01337     bool old_diff_custom_used = false;
01338     for (uint i = 0; i < options_to_load && !old_diff_custom_used; i++) {
01339       old_diff_custom_used = (_old_diff_custom[i] != 0);
01340     }
01341 
01342     if (!old_diff_custom_used) return;
01343   }
01344 
01345   for (uint i = 0; i < options_to_load; i++) {
01346     const SettingDesc *sd = &_settings[i];
01347     /* Skip deprecated options */
01348     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01349     void *var = GetVariableAddress(savegame ? &_settings_game : &_settings_newgame, &sd->save);
01350     Write_ValidateSetting(var, sd, (int32)((i == 4 ? 1000 : 1) * _old_diff_custom[i]));
01351   }
01352 }
01353 
01354 static void AILoadConfig(IniFile *ini, const char *grpname)
01355 {
01356   IniGroup *group = ini->GetGroup(grpname);
01357   IniItem *item;
01358 
01359   /* Clean any configured AI */
01360   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01361     AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01362   }
01363 
01364   /* If no group exists, return */
01365   if (group == NULL) return;
01366 
01367   CompanyID c = COMPANY_FIRST;
01368   for (item = group->item; c < MAX_COMPANIES && item != NULL; c++, item = item->next) {
01369     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01370 
01371     config->Change(item->name);
01372     if (!config->HasScript()) {
01373       if (strcmp(item->name, "none") != 0) {
01374         DEBUG(script, 0, "The AI by the name '%s' was no longer found, and removed from the list.", item->name);
01375         continue;
01376       }
01377     }
01378     if (item->value != NULL) config->StringToSettings(item->value);
01379   }
01380 }
01381 
01382 static void GameLoadConfig(IniFile *ini, const char *grpname)
01383 {
01384   IniGroup *group = ini->GetGroup(grpname);
01385   IniItem *item;
01386 
01387   /* Clean any configured GameScript */
01388   GameConfig::GetConfig(GameConfig::SSS_FORCE_NEWGAME)->Change(NULL);
01389 
01390   /* If no group exists, return */
01391   if (group == NULL) return;
01392 
01393   item = group->item;
01394   if (item == NULL) return;
01395 
01396   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01397 
01398   config->Change(item->name);
01399   if (!config->HasScript()) {
01400     if (strcmp(item->name, "none") != 0) {
01401       DEBUG(script, 0, "The GameScript by the name '%s' was no longer found, and removed from the list.", item->name);
01402       return;
01403     }
01404   }
01405   if (item->value != NULL) config->StringToSettings(item->value);
01406 }
01407 
01414 static GRFConfig *GRFLoadConfig(IniFile *ini, const char *grpname, bool is_static)
01415 {
01416   IniGroup *group = ini->GetGroup(grpname);
01417   IniItem *item;
01418   GRFConfig *first = NULL;
01419   GRFConfig **curr = &first;
01420 
01421   if (group == NULL) return NULL;
01422 
01423   for (item = group->item; item != NULL; item = item->next) {
01424     GRFConfig *c = new GRFConfig(item->name);
01425 
01426     /* Parse parameters */
01427     if (!StrEmpty(item->value)) {
01428       c->num_params = ParseIntList(item->value, (int*)c->param, lengthof(c->param));
01429       if (c->num_params == (byte)-1) {
01430         SetDParamStr(0, item->name);
01431         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_ARRAY, WL_CRITICAL);
01432         c->num_params = 0;
01433       }
01434     }
01435 
01436     /* Check if item is valid */
01437     if (!FillGRFDetails(c, is_static) || HasBit(c->flags, GCF_INVALID)) {
01438       if (c->status == GCS_NOT_FOUND) {
01439         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_NOT_FOUND);
01440       } else if (HasBit(c->flags, GCF_UNSAFE)) {
01441         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNSAFE);
01442       } else if (HasBit(c->flags, GCF_SYSTEM)) {
01443         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_SYSTEM);
01444       } else if (HasBit(c->flags, GCF_INVALID)) {
01445         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_INCOMPATIBLE);
01446       } else {
01447         SetDParam(1, STR_CONFIG_ERROR_INVALID_GRF_UNKNOWN);
01448       }
01449 
01450       SetDParamStr(0, item->name);
01451       ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_INVALID_GRF, WL_CRITICAL);
01452       delete c;
01453       continue;
01454     }
01455 
01456     /* Check for duplicate GRFID (will also check for duplicate filenames) */
01457     bool duplicate = false;
01458     for (const GRFConfig *gc = first; gc != NULL; gc = gc->next) {
01459       if (gc->ident.grfid == c->ident.grfid) {
01460         SetDParamStr(0, item->name);
01461         SetDParamStr(1, gc->filename);
01462         ShowErrorMessage(STR_CONFIG_ERROR, STR_CONFIG_ERROR_DUPLICATE_GRFID, WL_CRITICAL);
01463         duplicate = true;
01464         break;
01465       }
01466     }
01467     if (duplicate) {
01468       delete c;
01469       continue;
01470     }
01471 
01472     /* Mark file as static to avoid saving in savegame. */
01473     if (is_static) SetBit(c->flags, GCF_STATIC);
01474 
01475     /* Add item to list */
01476     *curr = c;
01477     curr = &c->next;
01478   }
01479 
01480   return first;
01481 }
01482 
01483 static void AISaveConfig(IniFile *ini, const char *grpname)
01484 {
01485   IniGroup *group = ini->GetGroup(grpname);
01486 
01487   if (group == NULL) return;
01488   group->Clear();
01489 
01490   for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
01491     AIConfig *config = AIConfig::GetConfig(c, AIConfig::SSS_FORCE_NEWGAME);
01492     const char *name;
01493     char value[1024];
01494     config->SettingsToString(value, lengthof(value));
01495 
01496     if (config->HasScript()) {
01497       name = config->GetName();
01498     } else {
01499       name = "none";
01500     }
01501 
01502     IniItem *item = new IniItem(group, name, strlen(name));
01503     item->SetValue(value);
01504   }
01505 }
01506 
01507 static void GameSaveConfig(IniFile *ini, const char *grpname)
01508 {
01509   IniGroup *group = ini->GetGroup(grpname);
01510 
01511   if (group == NULL) return;
01512   group->Clear();
01513 
01514   GameConfig *config = GameConfig::GetConfig(AIConfig::SSS_FORCE_NEWGAME);
01515   const char *name;
01516   char value[1024];
01517   config->SettingsToString(value, lengthof(value));
01518 
01519   if (config->HasScript()) {
01520     name = config->GetName();
01521   } else {
01522     name = "none";
01523   }
01524 
01525   IniItem *item = new IniItem(group, name, strlen(name));
01526   item->SetValue(value);
01527 }
01528 
01533 static void SaveVersionInConfig(IniFile *ini)
01534 {
01535   IniGroup *group = ini->GetGroup("version");
01536 
01537   char version[9];
01538   snprintf(version, lengthof(version), "%08X", _openttd_newgrf_version);
01539 
01540   const char * const versions[][2] = {
01541     { "version_string", _openttd_revision },
01542     { "version_number", version }
01543   };
01544 
01545   for (uint i = 0; i < lengthof(versions); i++) {
01546     group->GetItem(versions[i][0], true)->SetValue(versions[i][1]);
01547   }
01548 }
01549 
01550 /* Save a GRF configuration to the given group name */
01551 static void GRFSaveConfig(IniFile *ini, const char *grpname, const GRFConfig *list)
01552 {
01553   ini->RemoveGroup(grpname);
01554   IniGroup *group = ini->GetGroup(grpname);
01555   const GRFConfig *c;
01556 
01557   for (c = list; c != NULL; c = c->next) {
01558     char params[512];
01559     GRFBuildParamList(params, c, lastof(params));
01560 
01561     group->GetItem(c->filename, true)->SetValue(params);
01562   }
01563 }
01564 
01565 /* Common handler for saving/loading variables to the configuration file */
01566 static void HandleSettingDescs(IniFile *ini, SettingDescProc *proc, SettingDescProcList *proc_list, bool basic_settings = true, bool other_settings = true)
01567 {
01568   if (basic_settings) {
01569     proc(ini, (const SettingDesc*)_misc_settings,    "misc",  NULL);
01570 #if defined(WIN32) && !defined(DEDICATED)
01571     proc(ini, (const SettingDesc*)_win32_settings,   "win32", NULL);
01572 #endif /* WIN32 */
01573   }
01574 
01575   if (other_settings) {
01576     proc(ini, _settings,         "patches",  &_settings_newgame);
01577     proc(ini, _currency_settings,"currency", &_custom_currency);
01578     proc(ini, _company_settings, "company",  &_settings_client.company);
01579 
01580 #ifdef ENABLE_NETWORK
01581     proc_list(ini, "server_bind_addresses", &_network_bind_list);
01582     proc_list(ini, "servers", &_network_host_list);
01583     proc_list(ini, "bans",    &_network_ban_list);
01584 #endif /* ENABLE_NETWORK */
01585   }
01586 }
01587 
01588 static IniFile *IniLoadConfig()
01589 {
01590   IniFile *ini = new IniFile(_list_group_names);
01591   ini->LoadFromDisk(_config_file, BASE_DIR);
01592   return ini;
01593 }
01594 
01599 void LoadFromConfig(bool minimal)
01600 {
01601   IniFile *ini = IniLoadConfig();
01602   if (!minimal) ResetCurrencies(false); // Initialize the array of currencies, without preserving the custom one
01603 
01604   /* Load basic settings only during bootstrap, load other settings not during bootstrap */
01605   HandleSettingDescs(ini, IniLoadSettings, IniLoadSettingList, minimal, !minimal);
01606 
01607   if (!minimal) {
01608     _grfconfig_newgame = GRFLoadConfig(ini, "newgrf", false);
01609     _grfconfig_static  = GRFLoadConfig(ini, "newgrf-static", true);
01610     AILoadConfig(ini, "ai_players");
01611     GameLoadConfig(ini, "game_scripts");
01612 
01613     PrepareOldDiffCustom();
01614     IniLoadSettings(ini, _gameopt_settings, "gameopt", &_settings_newgame);
01615     HandleOldDiffCustom(false);
01616 
01617     ValidateSettings();
01618 
01619     /* Display sheduled errors */
01620     extern void ScheduleErrorMessage(ErrorList &datas);
01621     ScheduleErrorMessage(_settings_error_list);
01622     if (FindWindowById(WC_ERRMSG, 0) == NULL) ShowFirstError();
01623   }
01624 
01625   delete ini;
01626 }
01627 
01629 void SaveToConfig()
01630 {
01631   IniFile *ini = IniLoadConfig();
01632 
01633   /* Remove some obsolete groups. These have all been loaded into other groups. */
01634   ini->RemoveGroup("patches");
01635   ini->RemoveGroup("yapf");
01636   ini->RemoveGroup("gameopt");
01637 
01638   HandleSettingDescs(ini, IniSaveSettings, IniSaveSettingList);
01639   GRFSaveConfig(ini, "newgrf", _grfconfig_newgame);
01640   GRFSaveConfig(ini, "newgrf-static", _grfconfig_static);
01641   AISaveConfig(ini, "ai_players");
01642   GameSaveConfig(ini, "game_scripts");
01643   SaveVersionInConfig(ini);
01644   ini->SaveToDisk(_config_file);
01645   delete ini;
01646 }
01647 
01652 void GetGRFPresetList(GRFPresetList *list)
01653 {
01654   list->Clear();
01655 
01656   IniFile *ini = IniLoadConfig();
01657   IniGroup *group;
01658   for (group = ini->group; group != NULL; group = group->next) {
01659     if (strncmp(group->name, "preset-", 7) == 0) {
01660       *list->Append() = strdup(group->name + 7);
01661     }
01662   }
01663 
01664   delete ini;
01665 }
01666 
01673 GRFConfig *LoadGRFPresetFromConfig(const char *config_name)
01674 {
01675   char *section = (char*)alloca(strlen(config_name) + 8);
01676   sprintf(section, "preset-%s", config_name);
01677 
01678   IniFile *ini = IniLoadConfig();
01679   GRFConfig *config = GRFLoadConfig(ini, section, false);
01680   delete ini;
01681 
01682   return config;
01683 }
01684 
01691 void SaveGRFPresetToConfig(const char *config_name, GRFConfig *config)
01692 {
01693   char *section = (char*)alloca(strlen(config_name) + 8);
01694   sprintf(section, "preset-%s", config_name);
01695 
01696   IniFile *ini = IniLoadConfig();
01697   GRFSaveConfig(ini, section, config);
01698   ini->SaveToDisk(_config_file);
01699   delete ini;
01700 }
01701 
01706 void DeleteGRFPresetFromConfig(const char *config_name)
01707 {
01708   char *section = (char*)alloca(strlen(config_name) + 8);
01709   sprintf(section, "preset-%s", config_name);
01710 
01711   IniFile *ini = IniLoadConfig();
01712   ini->RemoveGroup(section);
01713   ini->SaveToDisk(_config_file);
01714   delete ini;
01715 }
01716 
01717 const SettingDesc *GetSettingDescription(uint index)
01718 {
01719   if (index >= lengthof(_settings)) return NULL;
01720   return &_settings[index];
01721 }
01722 
01734 CommandCost CmdChangeSetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01735 {
01736   const SettingDesc *sd = GetSettingDescription(p1);
01737 
01738   if (sd == NULL) return CMD_ERROR;
01739   if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) return CMD_ERROR;
01740 
01741   if (!sd->IsEditable(true)) return CMD_ERROR;
01742 
01743   if (flags & DC_EXEC) {
01744     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01745 
01746     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01747     int32 newval = (int32)p2;
01748 
01749     Write_ValidateSetting(var, sd, newval);
01750     newval = (int32)ReadValue(var, sd->save.conv);
01751 
01752     if (oldval == newval) return CommandCost();
01753 
01754     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01755       WriteValue(var, sd->save.conv, (int64)oldval);
01756       return CommandCost();
01757     }
01758 
01759     if (sd->desc.flags & SGF_NO_NETWORK) {
01760       GamelogStartAction(GLAT_SETTING);
01761       GamelogSetting(sd->desc.name, oldval, newval);
01762       GamelogStopAction();
01763     }
01764 
01765     SetWindowClassesDirty(WC_GAME_OPTIONS);
01766   }
01767 
01768   return CommandCost();
01769 }
01770 
01781 CommandCost CmdChangeCompanySetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
01782 {
01783   if (p1 >= lengthof(_company_settings)) return CMD_ERROR;
01784   const SettingDesc *sd = &_company_settings[p1];
01785 
01786   if (flags & DC_EXEC) {
01787     void *var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01788 
01789     int32 oldval = (int32)ReadValue(var, sd->save.conv);
01790     int32 newval = (int32)p2;
01791 
01792     Write_ValidateSetting(var, sd, newval);
01793     newval = (int32)ReadValue(var, sd->save.conv);
01794 
01795     if (oldval == newval) return CommandCost();
01796 
01797     if (sd->desc.proc != NULL && !sd->desc.proc(newval)) {
01798       WriteValue(var, sd->save.conv, (int64)oldval);
01799       return CommandCost();
01800     }
01801 
01802     SetWindowClassesDirty(WC_GAME_OPTIONS);
01803   }
01804 
01805   return CommandCost();
01806 }
01807 
01815 bool SetSettingValue(uint index, int32 value, bool force_newgame)
01816 {
01817   const SettingDesc *sd = &_settings[index];
01818   /* If an item is company-based, we do not send it over the network
01819    * (if any) to change. Also *hack*hack* we update the _newgame version
01820    * of settings because changing a company-based setting in a game also
01821    * changes its defaults. At least that is the convention we have chosen */
01822   if (sd->save.conv & SLF_NO_NETWORK_SYNC) {
01823     void *var = GetVariableAddress(&GetGameSettings(), &sd->save);
01824     Write_ValidateSetting(var, sd, value);
01825 
01826     if (_game_mode != GM_MENU) {
01827       void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01828       Write_ValidateSetting(var2, sd, value);
01829     }
01830     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01831 
01832     SetWindowClassesDirty(WC_GAME_OPTIONS);
01833 
01834     return true;
01835   }
01836 
01837   if (force_newgame) {
01838     void *var2 = GetVariableAddress(&_settings_newgame, &sd->save);
01839     Write_ValidateSetting(var2, sd, value);
01840     return true;
01841   }
01842 
01843   /* send non-company-based settings over the network */
01844   if (!_networking || (_networking && _network_server)) {
01845     return DoCommandP(0, index, value, CMD_CHANGE_SETTING);
01846   }
01847   return false;
01848 }
01849 
01856 void SetCompanySetting(uint index, int32 value)
01857 {
01858   const SettingDesc *sd = &_company_settings[index];
01859   if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
01860     DoCommandP(0, index, value, CMD_CHANGE_COMPANY_SETTING);
01861   } else {
01862     void *var = GetVariableAddress(&_settings_client.company, &sd->save);
01863     Write_ValidateSetting(var, sd, value);
01864     if (sd->desc.proc != NULL) sd->desc.proc((int32)ReadValue(var, sd->save.conv));
01865   }
01866 }
01867 
01871 void SetDefaultCompanySettings(CompanyID cid)
01872 {
01873   Company *c = Company::Get(cid);
01874   const SettingDesc *sd;
01875   for (sd = _company_settings; sd->save.cmd != SL_END; sd++) {
01876     void *var = GetVariableAddress(&c->settings, &sd->save);
01877     Write_ValidateSetting(var, sd, (int32)(size_t)sd->desc.def);
01878   }
01879 }
01880 
01881 #if defined(ENABLE_NETWORK)
01882 
01885 void SyncCompanySettings()
01886 {
01887   const SettingDesc *sd;
01888   uint i = 0;
01889   for (sd = _company_settings; sd->save.cmd != SL_END; sd++, i++) {
01890     const void *old_var = GetVariableAddress(&Company::Get(_current_company)->settings, &sd->save);
01891     const void *new_var = GetVariableAddress(&_settings_client.company, &sd->save);
01892     uint32 old_value = (uint32)ReadValue(old_var, sd->save.conv);
01893     uint32 new_value = (uint32)ReadValue(new_var, sd->save.conv);
01894     if (old_value != new_value) NetworkSendCommand(0, i, new_value, CMD_CHANGE_COMPANY_SETTING, NULL, NULL, _local_company);
01895   }
01896 }
01897 #endif /* ENABLE_NETWORK */
01898 
01904 uint GetCompanySettingIndex(const char *name)
01905 {
01906   uint i;
01907   const SettingDesc *sd = GetSettingFromName(name, &i);
01908   assert(sd != NULL && (sd->desc.flags & SGF_PER_COMPANY) != 0);
01909   return i;
01910 }
01911 
01919 bool SetSettingValue(uint index, const char *value, bool force_newgame)
01920 {
01921   const SettingDesc *sd = &_settings[index];
01922   assert(sd->save.conv & SLF_NO_NETWORK_SYNC);
01923 
01924   if (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) {
01925     char **var = (char**)GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
01926     free(*var);
01927     *var = strcmp(value, "(null)") == 0 ? NULL : strdup(value);
01928   } else {
01929     char *var = (char*)GetVariableAddress(NULL, &sd->save);
01930     ttd_strlcpy(var, value, sd->save.length);
01931   }
01932   if (sd->desc.proc != NULL) sd->desc.proc(0);
01933 
01934   return true;
01935 }
01936 
01944 const SettingDesc *GetSettingFromName(const char *name, uint *i)
01945 {
01946   const SettingDesc *sd;
01947 
01948   /* First check all full names */
01949   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01950     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01951     if (strcmp(sd->desc.name, name) == 0) return sd;
01952   }
01953 
01954   /* Then check the shortcut variant of the name. */
01955   for (*i = 0, sd = _settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01956     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01957     const char *short_name = strchr(sd->desc.name, '.');
01958     if (short_name != NULL) {
01959       short_name++;
01960       if (strcmp(short_name, name) == 0) return sd;
01961     }
01962   }
01963 
01964   if (strncmp(name, "company.", 8) == 0) name += 8;
01965   /* And finally the company-based settings */
01966   for (*i = 0, sd = _company_settings; sd->save.cmd != SL_END; sd++, (*i)++) {
01967     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
01968     if (strcmp(sd->desc.name, name) == 0) return sd;
01969   }
01970 
01971   return NULL;
01972 }
01973 
01974 /* Those 2 functions need to be here, else we have to make some stuff non-static
01975  * and besides, it is also better to keep stuff like this at the same place */
01976 void IConsoleSetSetting(const char *name, const char *value, bool force_newgame)
01977 {
01978   uint index;
01979   const SettingDesc *sd = GetSettingFromName(name, &index);
01980 
01981   if (sd == NULL) {
01982     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
01983     return;
01984   }
01985 
01986   bool success;
01987   if (sd->desc.cmd == SDT_STRING) {
01988     success = SetSettingValue(index, value, force_newgame);
01989   } else {
01990     uint32 val;
01991     extern bool GetArgumentInteger(uint32 *value, const char *arg);
01992     success = GetArgumentInteger(&val, value);
01993     if (!success) {
01994       IConsolePrintF(CC_ERROR, "'%s' is not an integer.", value);
01995       return;
01996     }
01997 
01998     success = SetSettingValue(index, val, force_newgame);
01999   }
02000 
02001   if (!success) {
02002     if (_network_server) {
02003       IConsoleError("This command/variable is not available during network games.");
02004     } else {
02005       IConsoleError("This command/variable is only available to a network server.");
02006     }
02007   }
02008 }
02009 
02010 void IConsoleSetSetting(const char *name, int value)
02011 {
02012   uint index;
02013   const SettingDesc *sd = GetSettingFromName(name, &index);
02014   assert(sd != NULL);
02015   SetSettingValue(index, value);
02016 }
02017 
02023 void IConsoleGetSetting(const char *name, bool force_newgame)
02024 {
02025   char value[20];
02026   uint index;
02027   const SettingDesc *sd = GetSettingFromName(name, &index);
02028   const void *ptr;
02029 
02030   if (sd == NULL) {
02031     IConsolePrintF(CC_WARNING, "'%s' is an unknown setting.", name);
02032     return;
02033   }
02034 
02035   ptr = GetVariableAddress((_game_mode == GM_MENU || force_newgame) ? &_settings_newgame : &_settings_game, &sd->save);
02036 
02037   if (sd->desc.cmd == SDT_STRING) {
02038     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s'", name, (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
02039   } else {
02040     if (sd->desc.cmd == SDT_BOOLX) {
02041       snprintf(value, sizeof(value), (*(const bool*)ptr != 0) ? "on" : "off");
02042     } else {
02043       snprintf(value, sizeof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
02044     }
02045 
02046     IConsolePrintF(CC_WARNING, "Current value for '%s' is: '%s' (min: %s%d, max: %u)",
02047       name, value, (sd->desc.flags & SGF_0ISDISABLED) ? "(0) " : "", sd->desc.min, sd->desc.max);
02048   }
02049 }
02050 
02056 void IConsoleListSettings(const char *prefilter)
02057 {
02058   IConsolePrintF(CC_WARNING, "All settings with their current value:");
02059 
02060   for (const SettingDesc *sd = _settings; sd->save.cmd != SL_END; sd++) {
02061     if (!SlIsObjectCurrentlyValid(sd->save.version_from, sd->save.version_to)) continue;
02062     if (prefilter != NULL && strstr(sd->desc.name, prefilter) == NULL) continue;
02063     char value[80];
02064     const void *ptr = GetVariableAddress(&GetGameSettings(), &sd->save);
02065 
02066     if (sd->desc.cmd == SDT_BOOLX) {
02067       snprintf(value, lengthof(value), (*(const bool *)ptr != 0) ? "on" : "off");
02068     } else if (sd->desc.cmd == SDT_STRING) {
02069       snprintf(value, sizeof(value), "%s", (GetVarMemType(sd->save.conv) == SLE_VAR_STRQ) ? *(const char * const *)ptr : (const char *)ptr);
02070     } else {
02071       snprintf(value, lengthof(value), sd->desc.min < 0 ? "%d" : "%u", (int32)ReadValue(ptr, sd->save.conv));
02072     }
02073     IConsolePrintF(CC_DEFAULT, "%s = %s", sd->desc.name, value);
02074   }
02075 
02076   IConsolePrintF(CC_WARNING, "Use 'setting' command to change a value");
02077 }
02078 
02085 static void LoadSettings(const SettingDesc *osd, void *object)
02086 {
02087   for (; osd->save.cmd != SL_END; osd++) {
02088     const SaveLoad *sld = &osd->save;
02089     void *ptr = GetVariableAddress(object, sld);
02090 
02091     if (!SlObjectMember(ptr, sld)) continue;
02092     if (IsNumericType(sld->conv)) Write_ValidateSetting(ptr, osd, ReadValue(ptr, sld->conv));
02093   }
02094 }
02095 
02102 static void SaveSettings(const SettingDesc *sd, void *object)
02103 {
02104   /* We need to write the CH_RIFF header, but unfortunately can't call
02105    * SlCalcLength() because we have a different format. So do this manually */
02106   const SettingDesc *i;
02107   size_t length = 0;
02108   for (i = sd; i->save.cmd != SL_END; i++) {
02109     length += SlCalcObjMemberLength(object, &i->save);
02110   }
02111   SlSetLength(length);
02112 
02113   for (i = sd; i->save.cmd != SL_END; i++) {
02114     void *ptr = GetVariableAddress(object, &i->save);
02115     SlObjectMember(ptr, &i->save);
02116   }
02117 }
02118 
02119 static void Load_OPTS()
02120 {
02121   /* Copy over default setting since some might not get loaded in
02122    * a networking environment. This ensures for example that the local
02123    * autosave-frequency stays when joining a network-server */
02124   PrepareOldDiffCustom();
02125   LoadSettings(_gameopt_settings, &_settings_game);
02126   HandleOldDiffCustom(true);
02127 }
02128 
02129 static void Load_PATS()
02130 {
02131   /* Copy over default setting since some might not get loaded in
02132    * a networking environment. This ensures for example that the local
02133    * currency setting stays when joining a network-server */
02134   LoadSettings(_settings, &_settings_game);
02135 }
02136 
02137 static void Check_PATS()
02138 {
02139   LoadSettings(_settings, &_load_check_data.settings);
02140 }
02141 
02142 static void Save_PATS()
02143 {
02144   SaveSettings(_settings, &_settings_game);
02145 }
02146 
02147 void CheckConfig()
02148 {
02149   /*
02150    * Increase old default values for pf_maxdepth and pf_maxlength
02151    * to support big networks.
02152    */
02153   if (_settings_newgame.pf.opf.pf_maxdepth == 16 && _settings_newgame.pf.opf.pf_maxlength == 512) {
02154     _settings_newgame.pf.opf.pf_maxdepth = 48;
02155     _settings_newgame.pf.opf.pf_maxlength = 4096;
02156   }
02157 }
02158 
02159 extern const ChunkHandler _setting_chunk_handlers[] = {
02160   { 'OPTS', NULL,      Load_OPTS, NULL, NULL,       CH_RIFF},
02161   { 'PATS', Save_PATS, Load_PATS, NULL, Check_PATS, CH_RIFF | CH_LAST},
02162 };
02163 
02164 static bool IsSignedVarMemType(VarType vt)
02165 {
02166   switch (GetVarMemType(vt)) {
02167     case SLE_VAR_I8:
02168     case SLE_VAR_I16:
02169     case SLE_VAR_I32:
02170     case SLE_VAR_I64:
02171       return true;
02172   }
02173   return false;
02174 }