settings_internal.h

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 
00012 #ifndef SETTINGS_INTERNAL_H
00013 #define SETTINGS_INTERNAL_H
00014 
00015 #include "saveload/saveload.h"
00016 
00023 enum SettingDescTypeLong {
00024   /* 4 bytes allocated a maximum of 16 types for GenericType */
00025   SDT_BEGIN       = 0,
00026   SDT_NUMX        = 0, 
00027   SDT_BOOLX       = 1, 
00028   SDT_ONEOFMANY   = 2, 
00029   SDT_MANYOFMANY  = 3, 
00030   SDT_INTLIST     = 4, 
00031   SDT_STRING      = 5, 
00032   SDT_END,
00033   /* 10 more possible primitives */
00034 };
00035 typedef SimpleTinyEnumT<SettingDescTypeLong, byte> SettingDescType;
00036 
00037 
00038 enum SettingGuiFlagLong {
00039   /* 1 byte allocated for a maximum of 8 flags
00040    * Flags directing saving/loading of a variable */
00041   SGF_NONE = 0,
00042   SGF_0ISDISABLED  = 1 << 0, 
00043   SGF_DISPLAY_ABS  = 1 << 1, 
00044   SGF_MULTISTRING  = 1 << 2, 
00045   SGF_NETWORK_ONLY = 1 << 3, 
00046   SGF_CURRENCY     = 1 << 4, 
00047   SGF_NO_NETWORK   = 1 << 5, 
00048   SGF_NEWGAME_ONLY = 1 << 6, 
00049   SGF_SCENEDIT_TOO = 1 << 7, 
00050   SGF_PER_COMPANY  = 1 << 8, 
00051 };
00052 DECLARE_ENUM_AS_BIT_SET(SettingGuiFlagLong)
00053 typedef SimpleTinyEnumT<SettingGuiFlagLong, uint16> SettingGuiFlag;
00054 
00063 enum SettingCategory {
00064   SC_NONE = 0,
00065 
00066   /* Filters for the list */
00067   SC_BASIC_LIST      = 1 << 0,    
00068   SC_ADVANCED_LIST   = 1 << 1,    
00069   SC_EXPERT_LIST     = 1 << 2,    
00070 
00071   /* Setting classification */
00072   SC_BASIC           = SC_BASIC_LIST | SC_ADVANCED_LIST | SC_EXPERT_LIST,  
00073   SC_ADVANCED        = SC_ADVANCED_LIST | SC_EXPERT_LIST,                  
00074   SC_EXPERT          = SC_EXPERT_LIST,                                     
00075 
00076   SC_END,
00077 };
00078 
00082 enum SettingType {
00083   ST_GAME,      
00084   ST_COMPANY,   
00085   ST_CLIENT,    
00086 
00087   ST_ALL,       
00088 };
00089 
00090 typedef bool OnChange(int32 var);           
00091 typedef size_t OnConvert(const char *value); 
00092 
00094 struct SettingDescBase {
00095   const char *name;       
00096   const void *def;        
00097   SettingDescType cmd;    
00098   SettingGuiFlag flags;   
00099   int32 min;              
00100   uint32 max;             
00101   int32 interval;         
00102   const char *many;       
00103   StringID str;           
00104   StringID str_help;      
00105   StringID str_val;       
00106   OnChange *proc;         
00107   OnConvert *proc_cnvt;   
00108   SettingCategory cat;    
00109 };
00110 
00111 struct SettingDesc {
00112   SettingDescBase desc;   
00113   SaveLoad save;          
00114 
00115   bool IsEditable(bool do_command = false) const;
00116   SettingType GetType() const;
00117 };
00118 
00119 /* NOTE: The only difference between SettingDesc and SettingDescGlob is
00120  * that one uses global variables as a source and the other offsets
00121  * in a struct which are bound to a certain variable during runtime.
00122  * The only way to differentiate between these two is to check if an object
00123  * has been passed to the function or not. If not, then it is a global variable
00124  * and save->variable has its address, otherwise save->variable only holds the
00125  * offset in a certain struct */
00126 typedef SettingDesc SettingDescGlobVarList;
00127 
00128 const SettingDesc *GetSettingFromName(const char *name, uint *i);
00129 bool SetSettingValue(uint index, int32 value, bool force_newgame = false);
00130 bool SetSettingValue(uint index, const char *value, bool force_newgame = false);
00131 void SetCompanySetting(uint index, int32 value);
00132 
00133 #endif /* SETTINGS_INTERNAL_H */