Allows you to read, write and manipulate JSON config files. More...

#include <Config.hpp>

Collaboration diagram for galaxy::Config:

Public Member Functions
	Config () noexcept
	Constructor.

	Config (std::string_view file) noexcept
	Argument constructor.

	~Config () noexcept
	Destructor.

void	load (std::string_view file)
	Loads config json from disk.

void	save ()
	Save the config file. Must be opened first.

template<meta::standard_type Value>
void	set (const std::string &key, const Value &value) noexcept
	Set a new key-value pair for the config.

template<meta::standard_type Value>
void	set (const std::string &key, const Value &value, const std::string &section, const std::string &delim=".")
	Sets a new key-value pair in a section. Can use a delimiter to seperate sections.

template<meta::standard_type Value>
void	restore (const std::string &key, const Value &value) noexcept
	Sets a new setting, only if key or value does not already exist.

template<meta::standard_type Value>
void	restore (const std::string &key, const Value &value, const std::string &section, const std::string &delim=".")
	Sets a new setting, only if key or value does not already exist.

bool	has (const std::string &key) noexcept
	Check if the config file actually has a value.

bool	has (const std::string &key, const std::string &section, const std::string &delim=".")
	Check if the config file actually has a value.

template<meta::standard_type Value>
std::optional< Value >	get (const std::string &key)
	Retrieve a root config value.

template<meta::standard_type Value>
std::optional< Value >	get (const std::string &key, const std::string &section, const std::string &delim=".")
	Retrieve a config value in a section.

bool	empty () const
	Is the config file blank.

void	raw (const nlohmann::json &json) noexcept
	Set as external json object.

const nlohmann::json &	raw () const noexcept
	Get raw json object.

Private Member Functions
	Config (const Config &)=delete
	Copy constructor.

	Config (Config &&)=delete
	Move constructor.

Config &	operator= (const Config &)=delete
	Copy assignment operator.

Config &	operator= (Config &&)=delete
	Move assignment operator.

Private Attributes
nlohmann::json	m_config
	Config file as JSON.

std::string	m_path
	Filepath.

Detailed Description

Allows you to read, write and manipulate JSON config files.

Definition at line 22 of file Config.hpp.

Constructor & Destructor Documentation

◆ Config() [1/4]

galaxy::Config::Config ( )

noexcept

Constructor.

Definition at line 14 of file Config.cpp.

◆ Config() [2/4]

galaxy::Config::Config ( std::string_view file )

noexcept

Argument constructor.

Calls load().

Parameters

file	Path to config to open / use (does not matter if does not exist). This is relative to the app.

Definition at line 19 of file Config.cpp.

◆ ~Config()

galaxy::Config::~Config ( )

noexcept

Destructor.

Definition at line 25 of file Config.cpp.

◆ Config() [3/4]

galaxy::Config::Config ( const Config & )

privatedelete

Copy constructor.

◆ Config() [4/4]

galaxy::Config::Config ( Config && )

privatedelete

Move constructor.

Member Function Documentation

◆ load()

void galaxy::Config::load ( std::string_view file )

Loads config json from disk.

Will override any existing configuration.

Parameters

file	Path to config to open / use (does not matter if does not exist). This is relative to the app.

Definition at line 30 of file Config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

void galaxy::Config::save ( )

Save the config file. Must be opened first.

Definition at line 59 of file Config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set() [1/2]

template<meta::standard_type Value>

void galaxy::Config::set	(	const std::string &	key,
		const Value &	value )

inlinenoexcept

Set a new key-value pair for the config.

Will create if not exist, otherwise update.

Template Parameters

Value Standard JSON type to use.

Parameters

key	Name of the variable.
value	The variable value to set.

Definition at line 217 of file Config.hpp.

Here is the caller graph for this function:

◆ set() [2/2]

template<meta::standard_type Value>

void galaxy::Config::set	(	const std::string &	key,
		const Value &	value,
		const std::string &	section,
		const std::string &	delim = "." )

inline

Sets a new key-value pair in a section. Can use a delimiter to seperate sections.

Will create if not exist, otherwise update.

Template Parameters

Value Standard JSON type to use.

Parameters

key	Name of the variable.
value	The variable value to set.
section	Section of the config file to use. Can use a delimiter to seperate sections.
delim	Delimiter to seperate sections with. Optional.

Definition at line 223 of file Config.hpp.

Here is the call graph for this function:

◆ restore() [1/2]

template<meta::standard_type Value>

void galaxy::Config::restore	(	const std::string &	key,
		const Value &	value )

inlinenoexcept

Sets a new setting, only if key or value does not already exist.

Template Parameters

Value Standard JSON type to use.

Parameters

key	Name of the variable.
value	The variable value to set.

Definition at line 250 of file Config.hpp.

Here is the caller graph for this function:

◆ restore() [2/2]

template<meta::standard_type Value>

void galaxy::Config::restore	(	const std::string &	key,
		const Value &	value,
		const std::string &	section,
		const std::string &	delim = "." )

inline

Sets a new setting, only if key or value does not already exist.

Template Parameters

Value Standard JSON type to use.

Parameters

key	Name of the variable.
value	The variable value to set.
section	Section of the config file to use. Can use a delimiter to seperate sections.
delim	Delimiter to seperate sections with. Optional.

Definition at line 259 of file Config.hpp.

Here is the call graph for this function:

◆ has() [1/2]

bool galaxy::Config::has ( const std::string & key )

nodiscardnoexcept

Check if the config file actually has a value.

Parameters

key	Name of the value to check.

Returns: True if the value exists.

Definition at line 68 of file Config.cpp.

Here is the caller graph for this function:

◆ has() [2/2]

bool galaxy::Config::has	(	const std::string &	key,
		const std::string &	section,
		const std::string &	delim = "." )

nodiscard

Check if the config file actually has a value.

Parameters

key	Key to lookup value.
section	Delimiter seperated sections.
delim	Delimiter to use. Optional.

Returns: True if the value exists.

Definition at line 73 of file Config.cpp.

Here is the call graph for this function:

◆ get() [1/2]

template<meta::standard_type Value>

std::optional< Value > galaxy::Config::get ( const std::string & key )

inlinenodiscard

Retrieve a root config value.

Template Parameters

Value Standard JSON type to use.

Parameters

key	Name of the value to retrieve.

Returns: Returns the value retrieved from the key.

Definition at line 268 of file Config.hpp.

Here is the caller graph for this function:

◆ get() [2/2]

template<meta::standard_type Value>

std::optional< Value > galaxy::Config::get	(	const std::string &	key,
		const std::string &	section,
		const std::string &	delim = "." )

inlinenodiscard

Retrieve a config value in a section.

Template Parameters

Value Standard JSON type to use.

Parameters

key	Key to lookup value.
section	Delimiter seperated sections.
delim	Delimiter to use. Optional.

Returns: Returns the value retrieved from the key.

Definition at line 281 of file Config.hpp.

Here is the call graph for this function:

◆ empty()

bool galaxy::Config::empty ( ) const

nodiscard

Is the config file blank.

Returns: True if theres no config data.

Definition at line 106 of file Config.cpp.

Here is the caller graph for this function:

◆ raw() [1/2]

void galaxy::Config::raw ( const nlohmann::json & json )

noexcept

Set as external json object.

Parameters

json	New json config data to set.

Definition at line 111 of file Config.cpp.

◆ raw() [2/2]

const nlohmann::json & galaxy::Config::raw ( ) const

nodiscardnoexcept

Get raw json object.

Returns: Const reference to internal json object.

Definition at line 116 of file Config.cpp.

◆ operator=() [1/2]

Config & galaxy::Config::operator= ( const Config & )

privatedelete

Copy assignment operator.

◆ operator=() [2/2]

Config & galaxy::Config::operator= ( Config && )

privatedelete

Move assignment operator.

Member Data Documentation

◆ m_config

nlohmann::json galaxy::Config::m_config

private

Config file as JSON.

Definition at line 208 of file Config.hpp.

◆ m_path

std::string galaxy::Config::m_path

private

Filepath.

Definition at line 213 of file Config.hpp.

The documentation for this class was generated from the following files:

galaxy/src/galaxy/core/Config.hpp
galaxy/src/galaxy/core/Config.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Config() [1/4]

◆ Config() [2/4]

◆ ~Config()

◆ Config() [3/4]

◆ Config() [4/4]

Member Function Documentation

◆ load()

◆ save()

◆ set() [1/2]

◆ set() [2/2]

◆ restore() [1/2]

◆ restore() [2/2]

◆ has() [1/2]

◆ has() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ empty()

◆ raw() [1/2]

◆ raw() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ m_config

◆ m_path