config.h File Reference

#include <map>
#include <string>
#include <Windows.h>
#include "Strings/components/diagnostics/errors/errors.h"
#include "Strings/components/resources/color/BlamColor.h"

Include dependency graph for config.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	BlamConfigurationSetting
	Class representing a configuration setting. More...
class	BlamConfigurationSection
	Structure representing a configuration section. More...
class	BlamConfigurationFile

Namespaces
	BlamStrings
	Namespace containing general-purpose utilities.
	BlamStrings::Settings
	BlamStrings::Settings::Config
	Namespace for anything related to configuration files.

Macros
#define	STRINGS_API   __declspec(dllimport)
#define	EDITOR_CONFIG_DEFAULT_NAME   "editor_common.cfg"
	The default filename for the common editor configuration file. More...
#define	CONFIG_DUMMY_SECTION_NAME   "#___default"

Enumerations
enum	BlamConfigurationSettingType {   BlamConfigurationSettingType::String, BlamConfigurationSettingType::Boolean, BlamConfigurationSettingType::Float, BlamConfigurationSettingType::Int,   BlamConfigurationSettingType::Color, BlamConfigurationSettingType::Comment, BlamConfigurationSettingType::Invalid }
	Enumerator defining all possible configuration setting types. More...

Functions
STRINGS_API BlamResult	BlamStrings::Settings::Config::LoadConfiguration (std::string filename, std::string comment_delimeter, BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...
STRINGS_API BlamResult	BlamStrings::Settings::Config::LoadConfiguration (std::string filename, std::string defaults_filename, std::string comment_delimeter, BlamConfigurationFile **file)
	Loads a new configuration file from disk. More...

Macro Definition Documentation

CONFIG_DUMMY_SECTION_NAME

#define CONFIG_DUMMY_SECTION_NAME   "#___default"

EDITOR_CONFIG_DEFAULT_NAME

#define EDITOR_CONFIG_DEFAULT_NAME   "editor_common.cfg"

The default filename for the common editor configuration file.

Deprecated:

Do not use.

STRINGS_API

#define STRINGS_API   __declspec(dllimport)

Enumeration Type Documentation

BlamConfigurationSettingType

enum BlamConfigurationSettingType

strong

Enumerator defining all possible configuration setting types.

Enumerator
String	Indicates the setting stores a string.
Boolean	Indicates the setting stores a bool.
Float	Indicates the setting stores a float.
Int	Indicates the setting stores an integer.
Color	Indicates the setting stores a color.
Comment	Used to indicate a comment within the file.
Invalid	Indicates the setting type was invalid.