Elaztek Developer Hub
Blamite Game Engine - Strings  00390.07.02.23.1947.blamite
A library containing general purpose utilities and classes for use in multiple projects.
config.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <map>
4 #include <string>
5 #include <Windows.h>
6 
9 
10 #ifdef STRINGS_EXPORTS
11 #define STRINGS_API __declspec(dllexport)
12 #else
13 #define STRINGS_API __declspec(dllimport)
14 #endif
15 
21 #define EDITOR_CONFIG_DEFAULT_NAME "editor_common.cfg"
22 
23 #define CONFIG_DUMMY_SECTION_NAME "#___default"
24 
29 {
30  String,
31  Boolean,
32  Float,
33  Int,
34  Color,
35  Comment,
36  Invalid
37 };
38 
43 {
44 private:
45  std::string filename = "";
46  std::string comment_delimeter = "";
47  int line_number = 0;
48 
49  std::string value = "";
50  bool value_bool = false;
51  float value_float = 0.0f;
52  int value_int = 0;
53  BlamColor value_color = BlamColor(255, 255, 255);
54 
55  bool valid = false;
56 public:
57  std::string id = "unspecified";
59 
70  BlamConfigurationSetting(std::string line, int _line_number, std::string _comment_delimeter, std::string _filename);
71 
75  void ParseValue();
76 
82  bool IsValid();
83 
89  std::string* AsString();
90 
97  bool* AsBool();
98 
105  float* AsFloat();
106 
113  int* AsInt();
114 
121  BlamColor* AsColor();
122 
128  std::string ConvertRawValueToString();
129 
133  void UpdateValue(std::string new_value);
134 
138  std::string* GetRawValue();
139 
155  std::string GetDisplayNameString();
156 
172  std::string GetDescriptionString();
173 
179  BlamConfigurationSetting* Copy();
180 
186  std::string CreateConfigFileLine();
187 
198  std::map<std::string, std::string> GetEnumeratorOptions();
199 };
200 
208 {
209 private:
210  std::string filename;
211 
212 public:
213  std::map<std::string, BlamConfigurationSetting*> settings;
214  std::map<std::string, BlamConfigurationSetting*> default_settings;
215  std::string name;
216 
223  BlamConfigurationSection(std::string _name, std::string _filename);
224 
229 
235  void AddNewSetting(BlamConfigurationSetting* new_setting);
236 
242  void AddNewDefaultSetting(BlamConfigurationSetting* new_setting);
243 
251  bool HasOption(std::string option);
252 
261  std::string* GetString(std::string option);
262 
271  bool* GetBool(std::string option);
272 
281  float* GetFloat(std::string option);
282 
291  int* GetInt(std::string option);
292 
301  BlamColor* GetColor(std::string option);
302 
318  std::string GetDisplayNameString();
319 
323  void RestoreDefaultSettings();
324 };
325 
327 {
328 private:
329  bool loaded = false;
330 
334  void ClearSections();
335 
336 public:
337  std::map<std::string, BlamConfigurationSection*> sections;
338 
339  std::string filename = "";
340  std::string defaults_filename = "";
341  std::string comment_delimeter = "";
342 
351  BlamConfigurationFile(std::string _filename, std::string _comment_delimeter);
352 
357 
363  BlamResult LoadDefaults(std::string _filename);
364 
370  BlamResult Load();
371 
379  BlamResult Load(std::string _filename);
380 
386  BlamResult Reload();
387 
393  void Save();
394 
400  bool IsLoaded();
401 
405  void AddNewSection(BlamConfigurationSection* section);
406 
414  bool HasConfigurationSection(std::string section_name);
415 
421  BlamConfigurationSection* GetConfigurationSection(std::string section_name);
422 
438  std::string GetDisplayNameString();
439 
443  void RestoreDefaultSettings();
444 
454  std::string* GetString(std::string section_name, std::string option);
455 
465  bool* GetBool(std::string section_name, std::string option);
466 
476  float* GetFloat(std::string section_name, std::string option);
477 
487  int* GetInt(std::string section_name, std::string option);
488 
498  BlamColor* GetColor(std::string section_name, std::string option);
499 };
500 
501 namespace BlamStrings
502 {
506  namespace Settings::Config
507  {
517  STRINGS_API BlamResult LoadConfiguration(std::string filename, std::string comment_delimeter, OUT BlamConfigurationFile** file);
518 
528  STRINGS_API BlamResult LoadConfiguration(std::string filename, std::string defaults_filename, std::string comment_delimeter, OUT BlamConfigurationFile** file);
529  }
530 }
BlamConfigurationSetting::AsColor
BlamColor * AsColor()
Retrieves the setting value as a color.
Definition: BlamConfigurationSetting.cpp:241
logger.h
BlamConfigurationSection::RestoreDefaultSettings
void RestoreDefaultSettings()
Restores all settings to their default values.
Definition: BlamConfigurationSection.cpp:250
BlamConfigurationFile::HasConfigurationSection
bool HasConfigurationSection(std::string section_name)
Checks whether or not a given configuration section exists in the file.
Definition: BlamConfigurationFile.cpp:387
BlamStrings::Utils::String::Split
STRINGS_API std::vector< std::string > Split(std::string string, std::string splitter)
Splits a string around any instance of a substring.
Definition: string.cpp:136
BlamConfigurationSection::HasOption
bool HasOption(std::string option)
Checks whether or not a given configuration setting exists in this section.
Definition: BlamConfigurationSection.cpp:79
BlamConfigurationSection
Structure representing a configuration section.
Definition: config.h:207
BlamStrings::Settings::Config::LoadConfiguration
STRINGS_API BlamResult LoadConfiguration(std::string filename, std::string comment_delimeter, OUT BlamConfigurationFile **file)
Loads a new configuration file from disk.
Definition: config.cpp:6
BlamConfigurationSection::name
std::string name
The name of this configuration section.
Definition: config.h:215
BlamConfigurationSettingType::Comment
@ Comment
Used to indicate a comment within the file.
BlamConfigurationSection::settings
std::map< std::string, BlamConfigurationSetting * > settings
The list of configuration settings within this section.
Definition: config.h:213
BlamConfigurationFile::GetBool
bool * GetBool(std::string section_name, std::string option)
Retrieves a configuration setting as a bool.
Definition: BlamConfigurationFile.cpp:457
BlamColor::b
byte b
The Blue value of the color.
Definition: BlamColor.h:27
hooks.h
BlamStrings
Namespace for Blamite's shared C++ library.
Definition: events.h:172
BlamConfigurationSection::GetInt
int * GetInt(std::string option)
Retrieves a configuration setting as an int.
Definition: BlamConfigurationSection.cpp:181
BlamConfigurationSetting::AsFloat
float * AsFloat()
Retrieves the setting value as a float.
Definition: BlamConfigurationSetting.cpp:215
BlamConfigurationSettingType::Boolean
@ Boolean
Indicates the setting stores a bool.
string.h
BlamConfigurationSetting::GetDescriptionString
std::string GetDescriptionString()
Generates a description for the configuration setting for use in a user-friendly settings dialog.
Definition: BlamConfigurationSetting.cpp:325
STRINGS_API
#define STRINGS_API
Definition: config.h:13
BlamConfigurationSettingType::Color
@ Color
Indicates the setting stores a color.
BlamConfigurationFile::GetColor
BlamColor * GetColor(std::string section_name, std::string option)
Retrieves a configuration setting as a color.
Definition: BlamConfigurationFile.cpp:493
BlamConfigurationSetting
Class representing a configuration setting.
Definition: config.h:42
BlamStrings::Logger::LogEvent
STRINGS_API void LogEvent(BlamBasicLogMessage message)
Logs an event to the logger.
Definition: logger.cpp:41
BlamConfigurationFile::AddNewSection
void AddNewSection(BlamConfigurationSection *section)
Adds a new configuration section to the file.
Definition: BlamConfigurationFile.cpp:371
BlamConfigurationFile::RestoreDefaultSettings
void RestoreDefaultSettings()
Resets all configuration values to default.
Definition: BlamConfigurationFile.cpp:430
BlamConfigurationSetting::GetDisplayNameString
std::string GetDisplayNameString()
Generates a display name for the configuration setting for use in a user-friendly settings dialog.
Definition: BlamConfigurationSetting.cpp:310
BlamConfigurationFile::Load
BlamResult Load()
Loads the configuration file from disk.
Definition: BlamConfigurationFile.cpp:39
BlamConfigurationSection::default_settings
std::map< std::string, BlamConfigurationSetting * > default_settings
The list of default settings within this section.
Definition: config.h:214
BlamColor.h
errors.h
BlamConfigurationSection::BlamConfigurationSection
BlamConfigurationSection(std::string _name, std::string _filename)
Prepares a new configuration section.
Definition: BlamConfigurationSection.cpp:9
BlamConfigurationSetting::AsString
std::string * AsString()
Retrieves the setting value as a string.
Definition: BlamConfigurationSetting.cpp:192
BlamConfigurationFile::sections
std::map< std::string, BlamConfigurationSection * > sections
The list of configuration sections contained within the file.
Definition: config.h:337
BlamConfigurationFile::Save
void Save()
Saves the configuration file back to disk.
Definition: BlamConfigurationFile.cpp:249
BlamStrings::Resources::Strings::StringExists
STRINGS_API bool StringExists(std::string id)
Looks through the list of loaded engine strings to see if a given string has been loaded.
Definition: strings.cpp:251
Error_FileNotFound
@ Error_FileNotFound
Definition: errors.h:13
BlamConfigurationSetting::ParseValue
void ParseValue()
Parses the raw setting value depending on the setting type.
Definition: BlamConfigurationSetting.cpp:13
BlamResult
BlamResult
Enumerator containing any and all result codes used throughout the engine.
Definition: errors.h:9
BlamConfigurationFile
Definition: config.h:326
BlamStrings::Utils::String::ToLower
STRINGS_API std::string ToLower(std::string string)
Transforms a string to all-lowercase.
Definition: string.cpp:76
BlamConfigurationSetting::type
BlamConfigurationSettingType type
The type of setting that's being stored.
Definition: config.h:58
BlamConfigurationSetting::ConvertRawValueToString
std::string ConvertRawValueToString()
Converts the raw setting value to a string, with no placeholders expanded.
Definition: BlamConfigurationSetting.cpp:254
Success_OK
@ Success_OK
Definition: errors.h:11
BlamConfigurationSetting::Copy
BlamConfigurationSetting * Copy()
Creates a new copy of this setting.
Definition: BlamConfigurationSetting.cpp:340
BlamStrings::Utils::IO::CreateNewFile
STRINGS_API bool CreateNewFile(std::string filename, std::string file_contents)
Creates a file with the specified contents, or overwrites an existing file if it already exists.
Definition: io.cpp:76
BlamConfigurationSection::~BlamConfigurationSection
~BlamConfigurationSection()
Destructor.
Definition: BlamConfigurationSection.cpp:16
BlamConfigurationSection::GetColor
BlamColor * GetColor(std::string option)
Retrieves a configuration setting as a color.
Definition: BlamConfigurationSection.cpp:208
BlamConfigurationSetting::AsInt
int * AsInt()
Retrieves the setting value as an int.
Definition: BlamConfigurationSetting.cpp:228
BlamConfigurationFile::GetDisplayNameString
std::string GetDisplayNameString()
Generates a display name for the configuration file for use in a user-friendly settings dialog.
Definition: BlamConfigurationFile.cpp:415
BlamConfigurationSetting::GetRawValue
std::string * GetRawValue()
Retrieves the raw value of the setting, with no placeholders expanded.
Definition: BlamConfigurationSetting.cpp:305
BlamConfigurationSection::GetBool
bool * GetBool(std::string option)
Retrieves a configuration setting as a bool.
Definition: BlamConfigurationSection.cpp:127
BlamStrings::Utils::IO::GetEngineDataRoot
STRINGS_API std::string GetEngineDataRoot()
Retrieves the root folder for all game engine and editing kit user data files.
Definition: io.cpp:371
BlamConfigurationFile::IsLoaded
bool IsLoaded()
Whether or not this configuration file has been loaded.
Definition: BlamConfigurationFile.cpp:366
BlamConfigurationSection::GetFloat
float * GetFloat(std::string option)
Retrieves a configuration setting as a float.
Definition: BlamConfigurationSection.cpp:154
BlamStrings::Utils::String::Replace
STRINGS_API std::string Replace(std::string orig, std::string to_replace, std::string replace_with)
Replaces part of a string with another string.
Definition: string.cpp:94
BlamConfigurationFile::GetString
std::string * GetString(std::string section_name, std::string option)
Retrieves a configuration setting as a string.
Definition: BlamConfigurationFile.cpp:445
BlamColor::a
byte a
The Alpha value of the color.
Definition: BlamColor.h:28
BlamConfigurationSetting::UpdateValue
void UpdateValue(std::string new_value)
Updates the configuration setting with a new value.
Definition: BlamConfigurationSetting.cpp:299
BlamConfigurationFile::GetInt
int * GetInt(std::string section_name, std::string option)
Retrieves a configuration setting as an int.
Definition: BlamConfigurationFile.cpp:481
CONFIG_DUMMY_SECTION_NAME
#define CONFIG_DUMMY_SECTION_NAME
Definition: config.h:23
BlamConfigurationSetting::BlamConfigurationSetting
BlamConfigurationSetting(std::string line, int _line_number, std::string _comment_delimeter, std::string _filename)
Prepares a new configuration setting.
Definition: BlamConfigurationSetting.cpp:110
BlamStringsInternal::Hooks::NotifyConfigurationReload
STRINGS_INTERNAL void NotifyConfigurationReload(std::string filename)
Definition: hooks.cpp:23
BlamLogLevel::Error
@ Error
Indicates an error that could cause engine instability.
res.h
BlamConfigurationSection::AddNewDefaultSetting
void AddNewDefaultSetting(BlamConfigurationSetting *new_setting)
Adds a new default configuration setting to the section.
Definition: BlamConfigurationSection.cpp:66
BlamStrings::Utils::IO::GetFileName
STRINGS_API std::string GetFileName(std::string path)
Retrieves the name of the file or folder that a given path refers to.
Definition: io.cpp:287
BlamConfigurationSetting::AsBool
bool * AsBool()
Retrieves the setting value as a bool.
Definition: BlamConfigurationSetting.cpp:202
BlamConfigurationSection::AddNewSetting
void AddNewSetting(BlamConfigurationSetting *new_setting)
Adds a new configuration setting to the section.
Definition: BlamConfigurationSection.cpp:38
BlamStrings::Utils::IO::GetFileContentsAsString
STRINGS_API std::string GetFileContentsAsString(std::string path)
Reads a file as a string.
Definition: io.cpp:138
strings.h
BlamLogLevel::None
@ None
Indicates no severity, and is displayed with no formatting.
BlamConfigurationSettingType::Invalid
@ Invalid
Indicates the setting type was invalid.
BlamStrings::Utils::IO::IsFile
STRINGS_API bool IsFile(std::string path)
Checks if a given path refers to a regular file.
Definition: io.cpp:42
BlamConfigurationFile::filename
std::string filename
The file path of the configuration file.
Definition: config.h:339
BlamConfigurationFile::LoadDefaults
BlamResult LoadDefaults(std::string _filename)
Load the list of default sections.
Definition: BlamConfigurationFile.cpp:139
BlamConfigurationFile::GetConfigurationSection
BlamConfigurationSection * GetConfigurationSection(std::string section_name)
Retrieves a configuration section from the configuration file.
Definition: BlamConfigurationFile.cpp:399
BlamStrings::Utils::IO::FileExists
STRINGS_API bool FileExists(std::string name)
Checks if the specified file or directory exists.
Definition: io.cpp:26
BlamConfigurationFile::BlamConfigurationFile
BlamConfigurationFile(std::string _filename, std::string _comment_delimeter)
Prepares a new configuration file to be loaded.
Definition: BlamConfigurationFile.cpp:13
BlamConfigurationSettingType::String
@ String
Indicates the setting stores a string.
BR_SUCCEEDED
#define BR_SUCCEEDED(result)
Macro to check if a BlamResult indicates a successful operation.
Definition: errors.h:4
BlamConfigurationSection::GetDisplayNameString
std::string GetDisplayNameString()
Generates a display name for the configuration section for use in a user-friendly settings dialog.
Definition: BlamConfigurationSection.cpp:235
BlamConfigurationFile::defaults_filename
std::string defaults_filename
The file path of the configuration file used to store default settings.
Definition: config.h:340
uuids::to_string
std::basic_string< CharT, Traits, Allocator > to_string(uuid const &id)
Definition: uuid.h:581
BlamConfigurationFile::~BlamConfigurationFile
~BlamConfigurationFile()
Destructor.
Definition: BlamConfigurationFile.cpp:20
io.h
BlamConfigurationSettingType::Float
@ Float
Indicates the setting stores a float.
BlamConfigurationSetting::IsValid
bool IsValid()
Whether or not the provided file line was able to be interpreted as a valid setting.
Definition: BlamConfigurationSetting.cpp:187
BlamColor::ToString
std::string ToString()
Converts the color value to a string.
Definition: BlamColor.cpp:49
config.h
BlamColor::g
byte g
The Green value of the color.
Definition: BlamColor.h:26
BlamConfigurationSetting::CreateConfigFileLine
std::string CreateConfigFileLine()
Generates a string containing the setting as a config line, ready to be written to a config file.
Definition: BlamConfigurationSetting.cpp:346
BlamConfigurationSetting::id
std::string id
The name of the setting.
Definition: config.h:57
BlamColor::FromString
bool FromString(std::string string)
Attempts to set color information from a string.
Definition: BlamColor.cpp:110
converters.h
BlamStrings::Resources::Strings::LookupString
STRINGS_API std::string LookupString(std::string id)
Finds a string with a given ID.
Definition: strings.cpp:213
Error_FileInvalid
@ Error_FileInvalid
Definition: errors.h:15
BlamConfigurationFile::GetFloat
float * GetFloat(std::string section_name, std::string option)
Retrieves a configuration setting as a float.
Definition: BlamConfigurationFile.cpp:469
BlamColor
Class representing a color.
Definition: BlamColor.h:19
BlamColor::r
byte r
The Red value of the color.
Definition: BlamColor.h:25
BlamConfigurationSettingType::Int
@ Int
Indicates the setting stores an integer.
BlamStrings::Utils::String::ContainsChar
STRINGS_API bool ContainsChar(std::string string, char contains)
Determines whether or not a string contains the specified character.
Definition: string.cpp:165
BlamConfigurationSetting::GetEnumeratorOptions
std::map< std::string, std::string > GetEnumeratorOptions()
Generates a list of enumerator options for the setting.
Definition: BlamConfigurationSetting.cpp:395
BlamConfigurationSection::GetString
std::string * GetString(std::string option)
Retrieves a configuration setting as a string.
Definition: BlamConfigurationSection.cpp:100
BlamLogLevel::Warning
@ Warning
Indicates a warning message. Not something critical, but something that could cause unexpected behavi...
BlamConfigurationFile::Reload
BlamResult Reload()
Cleans up old data and reloads the configuration file from disk.
Definition: BlamConfigurationFile.cpp:233
BlamConfigurationFile::comment_delimeter
std::string comment_delimeter
The character or string used to indicate a comment within the file.
Definition: config.h:341
BlamConfigurationSettingType
BlamConfigurationSettingType
Enumerator defining all possible configuration setting types.
Definition: config.h:28