Main configuration parser class to inherit from in your code. More...

#include <ConfigParser.hpp>

Inheritance diagram for ffd::ConfigParser:

Public Member Functions
	ConfigParser (std::string path)
	Construct a new Config Parser object. More...

std::string	dump_str (void) const
	Dump config to stdout as a string. More...

template<class T >
T	get (const std::string &key) const
	Get value from config map using ffd::get(). This can throw. Use this in a try...catch block. More...

template<class T >
T	get (const std::string &key, const T &fallback) const noexcept
	Try to get value from config, default to fallback if fails. Guaranteed no-throw. More...

template<class T >
T	get (const std::string &key, bool *fail_flag) const noexcept
	Try to get value from config. If ffd::get fails, return T() or 0 and set fail_flag. Guaranteed no-throw. Prints message to std::cerr to explain error. More...

template<class T >
T	get_from (const std::string &section, const std::string &key)
	Adapter for ffd::get(). Sets config_map_ptr_ to address of sub config with name section. This can throw. More...

template<class T >
T	get_from (const std::string &section, const std::string &key, const T &fallback) noexcept
	Get value from config subsection using ConfigParser::get(const std::string&,const T&) const noexcept, return fallback if the subsection DNE. More...

template<class T >
T	get_from (const std::string &section, const std::string &key, bool *fail_flag) noexcept
	Get value from config subsection using ConfigParser::get(const std::string&,bool*) const noexcept, set fail_flag if the subsection DNE. More...

Quota	get_quota (const std::string &key, const Bytes &max) const
	Get quota from config map using ffd::get(). This can throw. Use this in a try...catch block. More...

Quota	get_quota (const std::string &key, const Bytes &max, const Quota &fallback) const noexcept
	Try to get Quota from config, default to fallback if fails. Guaranteed no-throw. More...

Quota	get_quota (const std::string &key, const Bytes &max, bool *fail_flag) const noexcept
	Try to get Quota from config. If ffd::get fails, return Quota(void) and set fail_flag. Guaranteed no-throw. Prints message to std::cerr to explain error. More...

Quota	get_quota_from (const std::string &section, const std::string &key, const Bytes &max)
	Adapter for ffd::get(). Sets config_map_ptr_ to address of sub config with name section. This can throw. More...

Quota	get_quota_from (const std::string &section, const std::string &key, const Bytes &max, const Quota &fallback) noexcept
	Get value from config subsection using ConfigParser::get(const std::string&,const T&) const noexcept, return fallback if the subsection DNE. More...

Quota	get_quota_from (const std::string &section, const std::string &key, const Bytes &max, bool *fail_flag) noexcept
	Get value from config subsection using ConfigParser::get(const std::string&,bool*) const noexcept, set fail_flag if the subsection DNE. More...

Protected Attributes
std::vector< ConfigNode * >	sub_confs_
	Vector of config subsections.

std::string	current_section_
	Name of current section, set by set_subsection()

Private Member Functions
void	parse (std::ifstream &file)
	Iterate each line of config file and determine how to parse with l::check_record_type() More...

void	parse_entry (const std::string &line)
	Extract value from config line and insert ConfigNode into config_map_. More...

void	parse_heading (const std::string &line)
	Create new subconfig. More...

void	set_subsection (const std::string &section)
	Update config_map_ptr_ to the subconfig map for section. More...

void	reset_subsection (void) noexcept
	Set config_map_ptr_ back to the address of config_map_. More...

void	report_error (const std::string &message) const noexcept
	Print error message to stderr, conditionally prepended with current subsection name. More...

Private Attributes
bool	guarded_
	true if a ConfigSubsectionGuard is in scope Set in ConfigSubsectionGuard::ConfigSubsectionGuard() Cleared in ConfigSubsectionGuard::~ConfigSubsectionGuard()

std::unordered_map< std::string, ConfigNode > *	config_map_ptr_
	Pointer to current config map.

std::string	path_
	Path to config file.

std::unordered_map< std::string, ConfigNode >	config_map_
	Map of config keys (std::string) to values (ConfigNode)

Friends
class	ConfigSubsectionGuard
	Guard to change config subsection within a scope: ConfigSubsectionGuard.

Detailed Description

Main configuration parser class to inherit from in your code.

Example usage:

Constructor & Destructor Documentation

◆ ConfigParser()

ffd::ConfigParser::ConfigParser ( std::string path )

Construct a new Config Parser object.

Opens file at path as an std::ifstream and calls ConfigParser::parse()

Parameters

path	Path to config file

Member Function Documentation

◆ dump_str()

std::string ffd::ConfigParser::dump_str ( void ) const

Dump config to stdout as a string.

Returns: std::string String containing config_map_ contents

◆ get() [1/3]

template<class T >

T ffd::ConfigParser::get ( const std::string & key ) const

inline

Get value from config map using ffd::get(). This can throw. Use this in a try...catch block.

try {
    int integer = get<int>("Field");
} catch (const ffd::ConfigException &err) {
    std::cerr << err.what();
}

Template Parameters

T	Type of variable to get

Parameters

key	Key to index config_map_

Returns: T Value returned from config

◆ get() [2/3]

template<class T >

T ffd::ConfigParser::get	(	const std::string &	key,
		bool *	fail_flag
	)		const

inlinenoexcept

Try to get value from config. If ffd::get fails, return T() or 0 and set fail_flag. Guaranteed no-throw. Prints message to std::cerr to explain error.

Example:

Template Parameters

T	Type of variable to return

Parameters

key	Key to index config_map_
fail_flag	Pointer to flag to set if ffd::get() fails

Returns: T Value returned from config

◆ get() [3/3]

template<class T >

T ffd::ConfigParser::get	(	const std::string &	key,
		const T &	fallback
	)		const

inlinenoexcept

Try to get value from config, default to fallback if fails. Guaranteed no-throw.

Example:

Template Parameters

T	Type of variable to return

Parameters

key	Key to index config_map_
fallback	Default value to return if ffd::get() fails.

Returns: T Value returned from config

◆ get_from() [1/3]

template<class T >

T ffd::ConfigParser::get_from	(	const std::string &	section,
		const std::string &	key
	)

inline

Adapter for ffd::get(). Sets config_map_ptr_ to address of sub config with name section. This can throw.

Template Parameters

T	Type of variable to get

Parameters

section	Subsection heading from config
key	Key to index config_map_

Returns: T Value returned from config

◆ get_from() [2/3]

template<class T >

T ffd::ConfigParser::get_from	(	const std::string &	section,
		const std::string &	key,
		bool *	fail_flag
	)

inlinenoexcept

Get value from config subsection using ConfigParser::get(const std::string&,bool*) const noexcept, set fail_flag if the subsection DNE.

Template Parameters

T	Type to return

Parameters

section	Config section name to get value from
key	Key identifying value in config
fail_flag	Pointer to flag to be set if error or DNE

Returns: T Value returned from config or T() or 0

◆ get_from() [3/3]

template<class T >

T ffd::ConfigParser::get_from	(	const std::string &	section,
		const std::string &	key,
		const T &	fallback
	)

inlinenoexcept

Get value from config subsection using ConfigParser::get(const std::string&,const T&) const noexcept, return fallback if the subsection DNE.

Example:

Template Parameters

T	Type to return

Parameters

section	Config section name to get value from
key	Key identifying value in config
fallback	Returned if error or DNE

Returns: T Value returned from config or fallback

◆ get_quota() [1/3]

Quota ffd::ConfigParser::get_quota	(	const std::string &	key,
		const Bytes &	max
	)		const

inline

Get quota from config map using ffd::get(). This can throw. Use this in a try...catch block.

ffd::Bytes total(1024);
try {
    ffd::Quota quota = get("Quota", total);
} catch (const ffd::ConfigException &err) {
    std::cerr << err.what();
}

Parameters

key	Key to index config_map_
max	Maximum number of bytes

Returns: ffd::Quota Value returned from config

◆ get_quota() [2/3]

Quota ffd::ConfigParser::get_quota	(	const std::string &	key,
		const Bytes &	max,
		bool *	fail_flag
	)		const

inlinenoexcept

Try to get Quota from config. If ffd::get fails, return Quota(void) and set fail_flag. Guaranteed no-throw. Prints message to std::cerr to explain error.

Parameters

key	Key to index config_map_
max	Maximum number of bytes
fail_flag	Pointer to flag to set if ffd::get() fails

Returns: T Value returned from config

◆ get_quota() [3/3]

Quota ffd::ConfigParser::get_quota	(	const std::string &	key,
		const Bytes &	max,
		const Quota &	fallback
	)		const

inlinenoexcept

Try to get Quota from config, default to fallback if fails. Guaranteed no-throw.

Parameters

key	Key to index config_map_
max	Maximum number of bytes
fallback	Default value to return if ffd::get() fails.

Returns: T Value returned from config

◆ get_quota_from() [1/3]

Quota ffd::ConfigParser::get_quota_from	(	const std::string &	section,
		const std::string &	key,
		const Bytes &	max
	)

inline

Adapter for ffd::get(). Sets config_map_ptr_ to address of sub config with name section. This can throw.

Parameters

section	Subsection heading from config
key	Key to index config_map_
max	Maximum number of bytes

Returns: Quota Value returned from config

◆ get_quota_from() [2/3]

Quota ffd::ConfigParser::get_quota_from	(	const std::string &	section,
		const std::string &	key,
		const Bytes &	max,
		bool *	fail_flag
	)

inlinenoexcept

Get value from config subsection using ConfigParser::get(const std::string&,bool*) const noexcept, set fail_flag if the subsection DNE.

Parameters

section	Config section name to get value from
key	Key identifying value in config
max	Maximum number of bytes
fail_flag	Pointer to flag to be set if error or DNE

Returns: Quota Value returned from config or T() or 0

◆ get_quota_from() [3/3]

Quota ffd::ConfigParser::get_quota_from	(	const std::string &	section,
		const std::string &	key,
		const Bytes &	max,
		const Quota &	fallback
	)

inlinenoexcept

Get value from config subsection using ConfigParser::get(const std::string&,const T&) const noexcept, return fallback if the subsection DNE.

Example:

Parameters

section	Config section name to get value from
key	Key identifying value in config
max	Maximum number of bytes
fallback	Returned if error or DNE

Returns: Quota Value returned from config or fallback

◆ parse()

void ffd::ConfigParser::parse ( std::ifstream & file )

private

Iterate each line of config file and determine how to parse with l::check_record_type()

Case	Function Called
l::RecordType::UNK	prints error message and continues
l::RecordType::ENTRY	ConfigParser::parse_entry()
l::RecordType::HEADING	ConfigParser::parse_heading()
l::RecordType::EMPTY	continues

Parameters

file	Opened file stream for config file

◆ parse_entry()

void ffd::ConfigParser::parse_entry ( const std::string & line )

private

Extract value from config line and insert ConfigNode into config_map_.

Parameters

line	String containing some form of "key = value"

◆ parse_heading()

void ffd::ConfigParser::parse_heading ( const std::string & line )

private

Create new subconfig.

construct new ConfigNode containing name and new config map, assign config_map_ptr_ to address of new config map, place into global config_map_, push address of new ConfigNode into sub_confs_

Parameters

line	String containing some form of "[Section Name]"

◆ report_error()

void ffd::ConfigParser::report_error ( const std::string & message ) const

inlineprivatenoexcept

Print error message to stderr, conditionally prepended with current subsection name.

Parameters

message

◆ reset_subsection()

void ffd::ConfigParser::reset_subsection ( void )

inlineprivatenoexcept

Set config_map_ptr_ back to the address of config_map_.

◆ set_subsection()

void ffd::ConfigParser::set_subsection ( const std::string & section )

inlineprivate

Update config_map_ptr_ to the subconfig map for section.

Parameters

section The config section to set to

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

/usr/include/45d/config/ConfigParser.hpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ConfigParser()

Member Function Documentation

◆ dump_str()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ get_from() [1/3]

◆ get_from() [2/3]

◆ get_from() [3/3]

◆ get_quota() [1/3]

◆ get_quota() [2/3]

◆ get_quota() [3/3]

◆ get_quota_from() [1/3]

◆ get_quota_from() [2/3]

◆ get_quota_from() [3/3]

◆ parse()

◆ parse_entry()

◆ parse_heading()

◆ report_error()

◆ reset_subsection()

◆ set_subsection()