2010-11-20 10:37:14 +00:00
|
|
|
/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
|
|
|
|
|
/* If you are missing that file, acquire a complete release at teeworlds.com. */
|
2011-04-13 18:22:10 +00:00
|
|
|
#ifndef ENGINE_SHARED_CONFIG_H
|
|
|
|
|
#define ENGINE_SHARED_CONFIG_H
|
2010-05-29 07:25:38 +00:00
|
|
|
|
2020-10-07 06:06:26 +00:00
|
|
|
#include <base/detect.h>
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
|
2021-01-10 12:47:07 +00:00
|
|
|
#include <engine/config.h>
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
#include <engine/console.h>
|
|
|
|
|
#include <engine/shared/memheap.h>
|
2020-10-07 06:06:26 +00:00
|
|
|
|
2023-11-11 17:53:15 +00:00
|
|
|
#include <vector>
|
|
|
|
|
|
2022-12-13 18:29:48 +00:00
|
|
|
// include protocol for MAX_CLIENT used in config_variables
|
|
|
|
|
#include <engine/shared/protocol.h>
|
|
|
|
|
|
2015-07-22 16:23:40 +00:00
|
|
|
#define CONFIG_FILE "settings_ddnet.cfg"
|
2015-08-12 11:49:16 +00:00
|
|
|
#define AUTOEXEC_FILE "autoexec.cfg"
|
|
|
|
|
#define AUTOEXEC_CLIENT_FILE "autoexec_client.cfg"
|
|
|
|
|
#define AUTOEXEC_SERVER_FILE "autoexec_server.cfg"
|
2015-07-22 16:23:40 +00:00
|
|
|
|
2021-01-10 12:47:07 +00:00
|
|
|
class CConfig
|
2011-04-13 18:37:12 +00:00
|
|
|
{
|
2021-01-10 12:47:07 +00:00
|
|
|
public:
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
#define MACRO_CONFIG_INT(Name, ScriptName, Def, Min, Max, Flags, Desc) \
|
2022-12-13 18:29:48 +00:00
|
|
|
static constexpr int ms_##Name = Def; \
|
|
|
|
|
int m_##Name;
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
#define MACRO_CONFIG_COL(Name, ScriptName, Def, Flags, Desc) \
|
2022-12-13 18:29:48 +00:00
|
|
|
static constexpr unsigned ms_##Name = Def; \
|
|
|
|
|
unsigned m_##Name;
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
#define MACRO_CONFIG_STR(Name, ScriptName, Len, Def, Flags, Desc) \
|
2022-12-13 18:29:48 +00:00
|
|
|
static constexpr const char *ms_p##Name = Def; \
|
|
|
|
|
char m_##Name[Len]; // Flawfinder: ignore
|
2020-09-26 19:41:58 +00:00
|
|
|
#include "config_variables.h"
|
|
|
|
|
#undef MACRO_CONFIG_INT
|
|
|
|
|
#undef MACRO_CONFIG_COL
|
|
|
|
|
#undef MACRO_CONFIG_STR
|
2010-05-29 07:25:38 +00:00
|
|
|
};
|
|
|
|
|
|
2021-01-10 12:47:07 +00:00
|
|
|
extern CConfig g_Config;
|
2010-05-29 07:25:38 +00:00
|
|
|
|
|
|
|
|
enum
|
|
|
|
|
{
|
2020-09-26 19:41:58 +00:00
|
|
|
CFGFLAG_SAVE = 1 << 0,
|
|
|
|
|
CFGFLAG_CLIENT = 1 << 1,
|
|
|
|
|
CFGFLAG_SERVER = 1 << 2,
|
|
|
|
|
CFGFLAG_STORE = 1 << 3,
|
|
|
|
|
CFGFLAG_MASTER = 1 << 4,
|
|
|
|
|
CFGFLAG_ECON = 1 << 5,
|
2020-10-11 13:59:57 +00:00
|
|
|
// DDRace
|
2020-10-17 15:29:33 +00:00
|
|
|
|
2020-10-11 14:27:28 +00:00
|
|
|
CMDFLAG_TEST = 1 << 6,
|
2020-09-26 19:41:58 +00:00
|
|
|
CFGFLAG_CHAT = 1 << 7,
|
|
|
|
|
CFGFLAG_GAME = 1 << 8,
|
|
|
|
|
CFGFLAG_NONTEEHISTORIC = 1 << 9,
|
|
|
|
|
CFGFLAG_COLLIGHT = 1 << 10,
|
|
|
|
|
CFGFLAG_COLALPHA = 1 << 11,
|
2022-01-31 02:11:47 +00:00
|
|
|
CFGFLAG_INSENSITIVE = 1 << 12,
|
2010-05-29 07:25:38 +00:00
|
|
|
};
|
|
|
|
|
|
2023-12-18 01:08:12 +00:00
|
|
|
struct SConfigVariable
|
|
|
|
|
{
|
|
|
|
|
enum EVariableType
|
|
|
|
|
{
|
|
|
|
|
VAR_INT,
|
|
|
|
|
VAR_COLOR,
|
|
|
|
|
VAR_STRING,
|
|
|
|
|
};
|
|
|
|
|
IConsole *m_pConsole;
|
|
|
|
|
const char *m_pScriptName;
|
|
|
|
|
EVariableType m_Type;
|
|
|
|
|
int m_Flags;
|
|
|
|
|
const char *m_pHelp;
|
|
|
|
|
// Note that this only applies to the console command and the SetValue function,
|
|
|
|
|
// but the underlying config variable can still be modified programatically.
|
|
|
|
|
bool m_ReadOnly = false;
|
|
|
|
|
|
|
|
|
|
SConfigVariable(IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp) :
|
|
|
|
|
m_pConsole(pConsole),
|
|
|
|
|
m_pScriptName(pScriptName),
|
|
|
|
|
m_Type(Type),
|
|
|
|
|
m_Flags(Flags),
|
|
|
|
|
m_pHelp(pHelp)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
virtual ~SConfigVariable() = default;
|
|
|
|
|
|
|
|
|
|
virtual void Register() = 0;
|
|
|
|
|
virtual bool IsDefault() const = 0;
|
|
|
|
|
virtual void Serialize(char *pOut, size_t Size) const = 0;
|
|
|
|
|
virtual void ResetToDefault() = 0;
|
|
|
|
|
virtual void ResetToOld() = 0;
|
|
|
|
|
|
|
|
|
|
protected:
|
2023-12-23 13:31:19 +00:00
|
|
|
void ExecuteLine(const char *pLine) const;
|
|
|
|
|
bool CheckReadOnly() const;
|
2023-12-18 01:08:12 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct SIntConfigVariable : public SConfigVariable
|
|
|
|
|
{
|
|
|
|
|
int *m_pVariable;
|
|
|
|
|
int m_Default;
|
|
|
|
|
int m_Min;
|
|
|
|
|
int m_Max;
|
|
|
|
|
int m_OldValue;
|
|
|
|
|
|
|
|
|
|
SIntConfigVariable(IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp, int *pVariable, int Default, int Min, int Max) :
|
|
|
|
|
SConfigVariable(pConsole, pScriptName, Type, Flags, pHelp),
|
|
|
|
|
m_pVariable(pVariable),
|
|
|
|
|
m_Default(Default),
|
|
|
|
|
m_Min(Min),
|
|
|
|
|
m_Max(Max),
|
|
|
|
|
m_OldValue(Default)
|
|
|
|
|
{
|
|
|
|
|
*m_pVariable = m_Default;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
~SIntConfigVariable() override = default;
|
|
|
|
|
|
2023-12-23 13:31:19 +00:00
|
|
|
static void CommandCallback(IConsole::IResult *pResult, void *pUserData);
|
|
|
|
|
void Register() override;
|
|
|
|
|
bool IsDefault() const override;
|
|
|
|
|
void Serialize(char *pOut, size_t Size, int Value) const;
|
|
|
|
|
void Serialize(char *pOut, size_t Size) const override;
|
|
|
|
|
void SetValue(int Value);
|
|
|
|
|
void ResetToDefault() override;
|
|
|
|
|
void ResetToOld() override;
|
2023-12-18 01:08:12 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct SColorConfigVariable : public SConfigVariable
|
|
|
|
|
{
|
|
|
|
|
unsigned *m_pVariable;
|
|
|
|
|
unsigned m_Default;
|
|
|
|
|
bool m_Light;
|
|
|
|
|
bool m_Alpha;
|
|
|
|
|
unsigned m_OldValue;
|
|
|
|
|
|
|
|
|
|
SColorConfigVariable(IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp, unsigned *pVariable, unsigned Default) :
|
|
|
|
|
SConfigVariable(pConsole, pScriptName, Type, Flags, pHelp),
|
|
|
|
|
m_pVariable(pVariable),
|
|
|
|
|
m_Default(Default),
|
|
|
|
|
m_Light(Flags & CFGFLAG_COLLIGHT),
|
|
|
|
|
m_Alpha(Flags & CFGFLAG_COLALPHA),
|
|
|
|
|
m_OldValue(Default)
|
|
|
|
|
{
|
|
|
|
|
*m_pVariable = m_Default;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
~SColorConfigVariable() override = default;
|
|
|
|
|
|
2023-12-23 13:31:19 +00:00
|
|
|
static void CommandCallback(IConsole::IResult *pResult, void *pUserData);
|
|
|
|
|
void Register() override;
|
|
|
|
|
bool IsDefault() const override;
|
|
|
|
|
void Serialize(char *pOut, size_t Size, unsigned Value) const;
|
|
|
|
|
void Serialize(char *pOut, size_t Size) const override;
|
|
|
|
|
void SetValue(unsigned Value);
|
|
|
|
|
void ResetToDefault() override;
|
|
|
|
|
void ResetToOld() override;
|
2023-12-18 01:08:12 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct SStringConfigVariable : public SConfigVariable
|
|
|
|
|
{
|
|
|
|
|
char *m_pStr;
|
|
|
|
|
const char *m_pDefault;
|
|
|
|
|
size_t m_MaxSize;
|
|
|
|
|
char *m_pOldValue;
|
|
|
|
|
|
2023-12-23 13:31:19 +00:00
|
|
|
SStringConfigVariable(IConsole *pConsole, const char *pScriptName, EVariableType Type, int Flags, const char *pHelp, char *pStr, const char *pDefault, size_t MaxSize, char *pOldValue);
|
2023-12-18 01:08:12 +00:00
|
|
|
~SStringConfigVariable() override = default;
|
|
|
|
|
|
2023-12-23 13:31:19 +00:00
|
|
|
static void CommandCallback(IConsole::IResult *pResult, void *pUserData);
|
|
|
|
|
void Register() override;
|
|
|
|
|
bool IsDefault() const override;
|
|
|
|
|
void Serialize(char *pOut, size_t Size, const char *pValue) const;
|
|
|
|
|
void Serialize(char *pOut, size_t Size) const override;
|
|
|
|
|
void SetValue(const char *pValue);
|
|
|
|
|
void ResetToDefault() override;
|
|
|
|
|
void ResetToOld() override;
|
2023-12-18 01:08:12 +00:00
|
|
|
};
|
|
|
|
|
|
2021-01-10 12:47:07 +00:00
|
|
|
class CConfigManager : public IConfigManager
|
|
|
|
|
{
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
IConsole *m_pConsole;
|
|
|
|
|
class IStorage *m_pStorage;
|
2021-01-10 12:47:07 +00:00
|
|
|
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
IOHANDLE m_ConfigFile;
|
|
|
|
|
bool m_Failed;
|
|
|
|
|
|
|
|
|
|
struct SCallback
|
2021-01-10 12:47:07 +00:00
|
|
|
{
|
|
|
|
|
SAVECALLBACKFUNC m_pfnFunc;
|
|
|
|
|
void *m_pUserData;
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
|
|
|
|
|
SCallback(SAVECALLBACKFUNC pfnFunc, void *pUserData) :
|
|
|
|
|
m_pfnFunc(pfnFunc),
|
|
|
|
|
m_pUserData(pUserData)
|
|
|
|
|
{
|
|
|
|
|
}
|
2021-01-10 12:47:07 +00:00
|
|
|
};
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
std::vector<SCallback> m_vCallbacks;
|
2021-01-10 12:47:07 +00:00
|
|
|
|
2023-12-18 01:08:12 +00:00
|
|
|
std::vector<SConfigVariable *> m_vpAllVariables;
|
|
|
|
|
std::vector<SConfigVariable *> m_vpGameVariables;
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
std::vector<const char *> m_vpUnknownCommands;
|
|
|
|
|
CHeap m_ConfigHeap;
|
2021-01-10 12:47:07 +00:00
|
|
|
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
static void Con_Reset(IConsole::IResult *pResult, void *pUserData);
|
|
|
|
|
static void Con_Toggle(IConsole::IResult *pResult, void *pUserData);
|
|
|
|
|
static void Con_ToggleStroke(IConsole::IResult *pResult, void *pUserData);
|
2023-11-11 17:53:15 +00:00
|
|
|
|
2021-01-10 12:47:07 +00:00
|
|
|
public:
|
|
|
|
|
CConfigManager();
|
|
|
|
|
|
2022-05-17 20:13:44 +00:00
|
|
|
void Init() override;
|
|
|
|
|
void Reset(const char *pScriptName) override;
|
Refactor config manager, move config variable handling
Move all code for handling of config variables from console to config manager. The console no longer depends on the config manager, instead the config manager now depends on the console.
Add `struct`s to manage config variables of different types (int, color and string). The config manager now keeps a list of all config variables, so usage of the preprocessor can be avoided except for code to initially create all config variables. Additionally, a separate list of just the game config variables (config variables with `CFGFLAG_GAME`) is kept to optimize the `ResetGameSettings` function, as this function is called whenever connecting to a server and should be fast. Previously, this function was even less efficient because it preformed a linear search for every individual game config variable to find the respective command data.
Move console commands that opperate only on config variables (`reset`, `toggle` and `+toggle`) to config manager. Ensure that these commands only opperate on the desired config variables (client or server, respectively) by checking `IConsole::FlagMask`.
Add `IConfigManager::SetReadOnly` function to set/unset config variables as read-only instead of manually overriding the command handlers for the `sv_rescue` and `sv_test_cmds` config variables. This also fixes that read-only config variables could still be changed by using the `reset` command. A console message is now printed when trying to change a read-only config variable. Removing the special handling for these two config variables is additionally useful so the console does not need to keep a pointer to config values and manager.
Use a `CHeap` for the config variables, their help texts and the previous values of string config variables to avoid many separate allocations as well usage of static variables. Also use the heap to store the unknown commands instead of using `std::string`s.
Properly trigger command chain when resetting config variables with the `reset` command and when resetting game settings on map loading. Closes #7461.
Format default value for color variables as RGB/RGBA hex with dollar sign prefix. Closes #5523.
Add log message when using `reset` with a variable that does not exist. Use `log_error` instead of `dbg_msg` when saving config file fails.
Support unlimited number of config save callbacks instead of at most 16. The code also becomes more readable by using an `std::vector` instead of a fixed-size array and a separate num variable.
Consistently name `MACRO_CONFIG_*` parameters when declaring the macros.
Add `IConsole::CMDLINE_LENGTH` constant to represent the maximum length of the console input and thereby reduce usage of magic numbers for buffer sizes.
2023-11-22 22:07:08 +00:00
|
|
|
void ResetGameSettings() override;
|
|
|
|
|
void SetReadOnly(const char *pScriptName, bool ReadOnly) override;
|
2022-05-17 20:13:44 +00:00
|
|
|
bool Save() override;
|
|
|
|
|
CConfig *Values() override { return &g_Config; }
|
2021-01-10 12:47:07 +00:00
|
|
|
|
2022-05-17 20:13:44 +00:00
|
|
|
void RegisterCallback(SAVECALLBACKFUNC pfnFunc, void *pUserData) override;
|
2021-01-10 12:47:07 +00:00
|
|
|
|
2022-05-17 20:13:44 +00:00
|
|
|
void WriteLine(const char *pLine) override;
|
2023-11-11 17:53:15 +00:00
|
|
|
|
|
|
|
|
void StoreUnknownCommand(const char *pCommand) override;
|
2023-12-18 01:08:12 +00:00
|
|
|
|
|
|
|
|
void PossibleConfigVariables(const char *pStr, int FlagMask, POSSIBLECFGFUNC pfnCallback, void *pUserData) override;
|
2021-01-10 12:47:07 +00:00
|
|
|
};
|
|
|
|
|
|
2010-05-29 07:25:38 +00:00
|
|
|
#endif
|
