Configuration document (text or versioned binary). More...

#include <config.hxx>

Collaboration diagram for StormByte::Config::Config:

[legend]

Public Member Functions
Construction
	Config ()
	Default constructor.

	Config (const Config &config)=default
	Copy constructor.

	Config (Config &&config) noexcept=default
	Move constructor.

Config &	operator= (const Config &config)=default
	Copy assignment operator.

Config &	operator= (Config &&config) noexcept=default
	Move assignment operator.

virtual	~Config ()=default
	Destructor.

Access
Item::Base &	operator[] (const std::string &path)
	Gets a reference to an item by path.

const Item::Base &	operator[] (const std::string &path) const
	Gets a const reference to an item by path.

Item::Base &	operator[] (const size_t &index)
	Gets a reference to an item by index.

const Item::Base &	operator[] (const size_t &index) const
	Gets a const reference to an item by index.

bool	operator== (const Config &config) const noexcept
	Equality operator.

bool	operator!= (const Config &config) const noexcept
	Inequality operator.

Items
Item::Base &	Add (const Item::Base &item)
	Adds an item to the configuration.

Item::Base &	Add (Item::Base &&item)
	Adds an item to the configuration (move).

void	Clear () noexcept
	Clears all configuration items.

bool	Exists (const std::string &path) const
	Checks if an item exists by path.

void	Remove (const std::string &path)
	Removes an item by path.

void	Remove (const size_t &index)
	Removes an item by index.

virtual constexpr size_t	Size () const noexcept
	Gets the number of items in the current level.

virtual size_t	Count () const noexcept
	Gets the full number of items (including nested).

constexpr std::span< Item::Base::PointerType >	Items () noexcept
	Gets the items in the current level.

constexpr std::span< const Item::Base::PointerType >	Items () const noexcept
	Gets the items in the current level (const).

Policy
void	OnExistingAction (const OnExistingAction &on_existing)
	Sets the action to take when an item name/identity collision occurs. The policy is applied to the root container and will be inherited by all nested containers.

constexpr void	OnParseFailure (OnFailureHook hook)
	Sets a function to execute on parse failure.

constexpr void	AddHookBeforeRead (HookFunction hook)
	Adds a hook executed before reading starts. Hooks run in order.

constexpr void	AddHookAfterRead (HookFunction hook)
	Adds a hook executed after a successful read. Hooks run in order.

Protected Attributes
Item::Group	m_root
	Root group.

HookFunctions	m_before_read_hooks
	Hooks executed before reading.

HookFunctions	m_after_read_hooks
	Hooks executed after successful reading.

OptionalFailureHook	m_on_parse_failure_hook
	Hook executed on failure.

StormByte::Config::OnExistingAction	m_on_existing_action
	Collision policy.

Friends
class	Binary::Reader

class	Binary::Writer

Input
STORMBYTE_CONFIG_PUBLIC Config &	operator>> (std::istream &istream, Config &file)
	Initializes configuration when istream is on the left-hand side.

STORMBYTE_CONFIG_PUBLIC Config &	operator>> (const std::string &str, Config &file)
	Initializes configuration when string is on the left-hand side.

Config &	operator<< (const Config &source)
	Import data from another configuration.

void	operator<< (std::istream &istream)
	Initialize configuration from an input stream (text mode).

void	operator<< (const std::string &str)
	Initialize configuration from a string (text mode).

Output
STORMBYTE_CONFIG_PUBLIC std::ostream &	operator<< (std::ostream &ostream, const Config &file)
	Output configuration when ostream is on the left-hand side.

STORMBYTE_CONFIG_PUBLIC std::string &	operator<< (std::string &, const Config &)
	Output configuration when string is on the left-hand side.

Config &	operator>> (Config &dest) const
	Output current configuration into another configuration.

std::ostream &	operator>> (std::ostream &ostream) const
	Output configuration serialized to an output stream (text).

std::string &	operator>> (std::string &str) const
	Output configuration serialized to a string (text).

	operator std::string () const
	Converts the current configuration to a string (text form).

void	Save (std::ostream &stream, Mode mode=Mode::Text) const
	Write this document to an output stream.

static ExpectedConfig	Load (std::istream &stream, Mode mode=Mode::Text)
	Read a document from an input stream.

Detailed Description

Configuration document (text or versioned binary).

A document holds:

Boolean, double, integer, string and binary values
Comments (single-line or multi-line)
Groups and lists

Constructor & Destructor Documentation

◆ Config() [1/2]

StormByte::Config::Config::Config ( const Config & config )

default

Copy constructor.

Parameters

config Configuration to copy.

◆ Config() [2/2]

StormByte::Config::Config::Config ( Config && config )

defaultnoexcept

Move constructor.

Parameters

config Configuration to move.

Member Function Documentation

◆ Add() [1/2]

Item::Base & StormByte::Config::Config::Add ( const Item::Base & item )

inline

Adds an item to the configuration.

Parameters

item	The item to add.

Exceptions

ItemNameAlreadyExists if the item's name already exists.

Returns: A reference to the added item.

◆ Add() [2/2]

Item::Base & StormByte::Config::Config::Add ( Item::Base && item )

inline

Adds an item to the configuration (move).

Parameters

item	Item to add.

Exceptions

ItemNameAlreadyExists if item name already exists.

Returns: Reference to the added item.

◆ AddHookAfterRead()

constexpr void StormByte::Config::Config::AddHookAfterRead ( HookFunction hook )

inlineconstexpr

Adds a hook executed after a successful read. Hooks run in order.

Parameters

hook	Hook function.

◆ AddHookBeforeRead()

constexpr void StormByte::Config::Config::AddHookBeforeRead ( HookFunction hook )

inlineconstexpr

Adds a hook executed before reading starts. Hooks run in order.

Parameters

hook	Hook function.

◆ Count()

virtual size_t StormByte::Config::Config::Count ( ) const

inlinevirtualnoexcept

Gets the full number of items (including nested).

Returns: Total number of items.

◆ Exists()

bool StormByte::Config::Config::Exists ( const std::string & path ) const

inline

Checks if an item exists by path.

Parameters

path	Path to the item.

Returns: true if the item exists.

◆ Items() [1/2]

constexpr std::span< const Item::Base::PointerType > StormByte::Config::Config::Items ( ) const

inlineconstexprnoexcept

Gets the items in the current level (const).

Returns: Const span of items.

◆ Items() [2/2]

constexpr std::span< Item::Base::PointerType > StormByte::Config::Config::Items ( )

inlineconstexprnoexcept

Gets the items in the current level.

Returns: Span of items.

◆ Load()

static ExpectedConfig StormByte::Config::Config::Load	(	std::istream &	stream,
		Mode	mode = `Mode::Text`
	)

static

Read a document from an input stream.

Parameters

stream	Source (file, stringstream, etc.).
mode	Text (default): config syntax; Binary: versioned wire format.

Returns: Config on success, or a StormByte::Exception derivative on failure.

◆ OnExistingAction()

void StormByte::Config::Config::OnExistingAction ( const OnExistingAction & on_existing )

inline

Sets the action to take when an item name/identity collision occurs. The policy is applied to the root container and will be inherited by all nested containers.

Parameters

on_existing The policy to use.

◆ OnParseFailure()

constexpr void StormByte::Config::Config::OnParseFailure ( OnFailureHook hook )

inlineconstexpr

Sets a function to execute on parse failure.

Parameters

hook	Function to execute.

◆ operator std::string()

StormByte::Config::Config::operator std::string ( ) const

Converts the current configuration to a string (text form).

Returns: Serialized configuration text.

◆ operator!=()

bool StormByte::Config::Config::operator!= ( const Config & config ) const

inlinenoexcept

Inequality operator.

Parameters

config Configuration to compare.

Returns: true if not equal.

◆ operator<<() [1/3]

Config & StormByte::Config::Config::operator<< ( const Config & source )

Import data from another configuration.

Parameters

source Source configuration to import.

Returns: Reference to this configuration.

◆ operator<<() [2/3]

void StormByte::Config::Config::operator<< ( const std::string & str )

Initialize configuration from a string (text mode).

Parameters

str	Input string.

◆ operator<<() [3/3]

void StormByte::Config::Config::operator<< ( std::istream & istream )

Initialize configuration from an input stream (text mode).

Parameters

istream Input stream.

◆ operator=() [1/2]

Config & StormByte::Config::Config::operator= ( Config && config )

defaultnoexcept

Move assignment operator.

Parameters

config Configuration to move.

Returns: Reference to this Config.

◆ operator=() [2/2]

Config & StormByte::Config::Config::operator= ( const Config & config )

default

Copy assignment operator.

Parameters

config Configuration to assign.

Returns: Reference to this Config.

◆ operator==()

bool StormByte::Config::Config::operator== ( const Config & config ) const

inlinenoexcept

Equality operator.

Parameters

config Configuration to compare.

Returns: true if equal.

◆ operator>>() [1/3]

Config & StormByte::Config::Config::operator>> ( Config & dest ) const

Output current configuration into another configuration.

Parameters

dest	Destination configuration.

Returns: Reference to the destination configuration.

◆ operator>>() [2/3]

std::ostream & StormByte::Config::Config::operator>> ( std::ostream & ostream ) const

Output configuration serialized to an output stream (text).

Parameters

ostream Output stream.

Returns: Reference to the output stream.

◆ operator>>() [3/3]

std::string & StormByte::Config::Config::operator>> ( std::string & str ) const

Output configuration serialized to a string (text).

Parameters

str	Output string.

Returns: Reference to the string.

◆ operator[]() [1/4]

Item::Base & StormByte::Config::Config::operator[] ( const size_t & index )

inline

Gets a reference to an item by index.

Parameters

index Index of the item.

Exceptions

OutOfBounds if index is out of bounds.

Returns: Item reference.

◆ operator[]() [2/4]

const Item::Base & StormByte::Config::Config::operator[] ( const size_t & index ) const

inline

Gets a const reference to an item by index.

Parameters

index Index of the item.

Exceptions

OutOfBounds if index is out of bounds.

Returns: Item const reference.

◆ operator[]() [3/4]

Item::Base & StormByte::Config::Config::operator[] ( const std::string & path )

inline

Gets a reference to an item by path.

Parameters

path	Path to the item.

Returns: Item reference.

◆ operator[]() [4/4]

const Item::Base & StormByte::Config::Config::operator[] ( const std::string & path ) const

inline

Gets a const reference to an item by path.

Parameters

path	Path to the item.

Returns: Item const reference.

◆ Remove() [1/2]

void StormByte::Config::Config::Remove ( const size_t & index )

inline

Removes an item by index.

Parameters

index Index of the item.

Exceptions

OutOfBounds if index is out of bounds.

◆ Remove() [2/2]

void StormByte::Config::Config::Remove ( const std::string & path )

inline

Removes an item by path.

Parameters

path	Item path.

Exceptions

ItemNotFound if item is not found.

◆ Save()

void StormByte::Config::Config::Save	(	std::ostream &	stream,
		Mode	mode = `Mode::Text`
	)		const

Write this document to an output stream.

Parameters

stream	Destination (file, stringstream, etc.).
mode	Text (default): config syntax; Binary: versioned wire format.

◆ Size()

virtual constexpr size_t StormByte::Config::Config::Size ( ) const

inlineconstexprvirtualnoexcept

Gets the number of items in the current level.

Returns: Number of items.

Friends And Related Symbol Documentation

◆ operator<< [1/2]

STORMBYTE_CONFIG_PUBLIC std::ostream & operator<<	(	std::ostream &	ostream,
		const Config &	file
	)

friend

Output configuration when ostream is on the left-hand side.

Parameters

ostream	Output stream.
file	Config to get data from.

Returns: Reference to the output stream.

◆ operator<< [2/2]

STORMBYTE_CONFIG_PUBLIC std::string & operator<<	(	std::string &	,
		const Config &
	)

friend

Output configuration when string is on the left-hand side.

Parameters

str	Output string.
file	Config to get data from.

Returns: Reference to the string.

◆ operator>> [1/2]

STORMBYTE_CONFIG_PUBLIC Config & operator>>	(	const std::string &	str,
		Config &	file
	)

friend

Initializes configuration when string is on the left-hand side.

Parameters

str	Input string.
file	Config to put data into.

Returns: Reference to the Config.

◆ operator>> [2/2]

STORMBYTE_CONFIG_PUBLIC Config & operator>>	(	std::istream &	istream,
		Config &	file
	)

friend

Initializes configuration when istream is on the left-hand side.

Parameters

istream	Input stream.
file	Config to put data into.

Returns: Reference to the Config.

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

/home/runner/work/StormByte-Config/StormByte-Config/lib/public/StormByte/config/config.hxx

Public Member Functions

Protected Attributes

Friends

Input

Output

Detailed Description

Constructor & Destructor Documentation

◆ Config() [1/2]

◆ Config() [2/2]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddHookAfterRead()

◆ AddHookBeforeRead()

◆ Count()

◆ Exists()

◆ Items() [1/2]

◆ Items() [2/2]

◆ Load()

◆ OnExistingAction()

◆ OnParseFailure()

◆ operator std::string()

◆ operator!=()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>>() [1/3]

◆ operator>>() [2/3]

◆ operator>>() [3/3]

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ Save()

◆ Size()

Friends And Related Symbol Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

◆ operator>> [1/2]

◆ operator>> [2/2]