sf::IniProfile Class Reference

Class for reading and writing ini-profiles. More...

#include <IniProfile.h>

Collaboration diagram for sf::IniProfile:

Classes
class	Entry
	Internal storage class for keys. More...
class	Section
	Internal storage class for sections. More...

Public Types
typedef TVector< Entry * >	EntryVector
	Internally used type.
typedef EntryVector::size_type	size_type
	Type definition for the used size.
typedef std::unordered_map< std::string, std::string >	KeyValueMap
	Type for retrieving key and values.

Public Member Functions
	IniProfile ()
	Default constructor for empty instance.
	IniProfile (const std::string &path)
	Initializing constructor.
	IniProfile (const IniProfile &)=delete
	Copying this class is not possible.
	IniProfile (const IniProfile &&)=delete
	No move constructor either.
IniProfile &	operator= (IniProfile &)=delete
	No copy operator either.
IniProfile &	operator= (IniProfile &&)=delete
	No move operator either.
	IniProfile (const std::string &section, const std::string &path)
	Initializing constructor. If the filename is empty, the startup path is selected.
	IniProfile (const std::string_view &data)
	Initializing constructor using string. Create by reading from std::istream current position.
	IniProfile (std::istream &is)
	Initializing constructor. Create by reading from std::istream current position.
virtual	~IniProfile ()
	Virtual destructor writes to filepath when dirty.
bool	getStringByRef (const std::string &key, std::string &value, const std::string &defaultString={}) const
	Works the same as TProfile from OWL.
void	flush ()
	Flushes/Removes all sections from this instance.
void	setKeyPrefix (const std::string &prefix={})
	Prepends prefix to key if prefix not null.
std::string	getString (const std::string &key, const std::string &defaultString={}) const
	Gets a string class value.
bool	setString (const std::string &key, const std::string &value)
	Sets a string class value making the Dirty flag true.
bool	setInt (const std::string &key, int value)
	Sets an integer value and sets the Dirty flag to true.
int	getInt (const std::string &key, int defaultInt=0) const
	Gets an integer value.
bool	setFloat (const std::string &key, double value)
	Gets a boolean value.
double	getFloat (const std::string &key, double defaultFloat=0.0) const
	Sets a double value and sets the Dirty flag to true.
bool	setBool (const std::string &key, bool value)
	Sets a boolean value and sets the Dirty flag to true.
bool	getBool (const std::string &key, bool defaultBool=false) const
	Gets a boolean value.
bool	setSection (const std::string &section, bool create=true)
	Sets the current section.
bool	selectSection (const std::string &section) const
bool	setSection (size_type index)
	Sets the current section by index.
size_type	getSectionCount () const
	Gets the section count.
std::string	getSection (size_type p=npos) const
	Gets the current or specific section name where p is the index in the section list.
string_list	getSections () const
	Get all section names in a std::string vector.
size_type	findSection (const std::string &section) const
	Finds current or specific section location in the list.
bool	sectionExists (const std::string &section) const
	Returns whether the passed section exists in the profile.
bool	keyExists (const std::string &key) const
	Returns whether the passed key exists in the current selected in the section of the profile.
bool	removeSection (const std::string &section)
	Removes a section by name.
bool	removeSection (size_type p)
	Removes a section by position.
bool	removeKeys (size_type section=npos)
	Removes all keys from a section by position or the current selected one if none has been passed.
bool	insertComment (const std::string &key, const std::string &comment)
	Inserts comment before existing key.
size_type	getEntryCount () const
	Gets the number of entries in the current section.
size_type	findEntry (const std::string &key)
	Finds in the current section the key, on failure it returns npos.
std::string	getEntryKey (size_type pos)
	Gets the value in the current section from the given pos position. In the case of a comment-line, it returns a string of length zero when pos is the index to comment-line.
string_list	getKeys (const std::string &section) const
	Gets all keys from the given section.
string_list	getKeys (size_type section=npos) const
	Gets the keys of the current section or of the passed section index.
void	setMap (const KeyValueMap &map, size_type section=npos)
	Replaces the section with the given value map.
KeyValueMap	getMap (size_type section=npos) const
	Gets the key value map from the current selected section by default or the section provided.
std::string	getEntryValue (size_type p)
	Gets entry value string in the current section by the given pos position.
bool	removeKey (const std::string &key)
	Removes entry by key name.
bool	removeEntry (size_type p)
	Removes entry or comment by position.
bool	setFilepath (const std::string &path)
	Set the path of this instance. When the current dirty-flag has been set, it is first written to disk before loading this file.
const std::string &	getFilepath () const
bool	exists () const
	Checks the existence of the associated file.
void	setWriteOnDirty (bool enable)
	Set the write-on-dirty flag so changes are written on destruction. The default is true.
bool	sync ()
	Syncs the content to file when the dirty-flag has been set. If the instance was created using a filepath the content is written when the dirty flag was set.
virtual std::ostream &	write (std::ostream &os) const
	read to std::ostream 'os' current position.
std::ostream &	writeSection (std::ostream &os) const
	Writes the current section to an 'ostream'.
bool	isDirty () const
	Tells if there write functions are used or not.
bool	read (std::istream &is)
	Add sections from other std::istream.

Static Public Attributes
static constexpr size_t	npos = EntryVector::npos
	Index-not-found return value.

Protected Types
typedef TVector< Section * >	SectionVector
	Internally used type.

Protected Member Functions
void	initialize ()
	Function called in any constructor.
bool	load (const std::string &filepath)
	Initialize the base from the filepath.
bool	load (std::istream &is)
	Initialize the base from the input stream.
Entry *	getEntry (EntryVector::size_type p)
	Gets nullptr if not exist.

Protected Attributes
class _MISC_CLASS	Entry
	Forward declaration and also having export attributes.
class _MISC_CLASS	Section
	Forward declaration and also having export attributes.
SectionVector	_sections
	Vector holding all sections.
SectionVector::size_type	_sectionIndex {npos}
	Current index to section.
std::string	_path
	Path to file if it was created with one otherwise 'length' is zero.
bool	_dirty {false}
	Is Set to true if an entry has been changed.
bool	_flagClearOnRead {true}
	If this flag is set, all fields read with 'ReadType' will be cleared.
bool	_writeOnDirty {true}
	When true, the profile is written to the filepath that was used to read it.
std::string	_prefix
	olds the prefix for all entered 'key's'.

Detailed Description

Class for reading and writing ini-profiles.

Member Typedef Documentation

EntryVector

typedef TVector<Entry*> sf::IniProfile::EntryVector

Internally used type.

KeyValueMap

typedef std::unordered_map<std::string, std::string> sf::IniProfile::KeyValueMap

Type for retrieving key and values.

SectionVector

typedef TVector<Section*> sf::IniProfile::SectionVector

protected

Internally used type.

size_type

typedef EntryVector::size_type sf::IniProfile::size_type

Type definition for the used size.

Constructor & Destructor Documentation

IniProfile() [1/7]

sf::IniProfile::IniProfile

(

)

Default constructor for empty instance.

IniProfile() [2/7]

sf::IniProfile::IniProfile ( const std::string &  path )

explicit

Initializing constructor.

Parameters

path	Filepath to the ini-file.

IniProfile() [3/7]

sf::IniProfile::IniProfile ( const IniProfile &  )

delete

Copying this class is not possible.

Todo:

Need to make this class copyable.

IniProfile() [4/7]

sf::IniProfile::IniProfile ( const IniProfile &&  )

delete

No move constructor either.

Todo:

Need to make this class copyable.

IniProfile() [5/7]

sf::IniProfile::IniProfile	(	const std::string &	section,
		const std::string &	path
	)

Initializing constructor. If the filename is empty, the startup path is selected.

IniProfile() [6/7]

sf::IniProfile::IniProfile ( const std::string_view &  data )

explicit

Initializing constructor using string. Create by reading from std::istream current position.

IniProfile() [7/7]

sf::IniProfile::IniProfile ( std::istream &  is )

explicit

Initializing constructor. Create by reading from std::istream current position.

~IniProfile()

virtual sf::IniProfile::~IniProfile ( )

virtual

Virtual destructor writes to filepath when dirty.

Member Function Documentation

exists()

bool sf::IniProfile::exists

(

)

const

Checks the existence of the associated file.

Returns

True when the file exists and when the file path is empty.

findEntry()

size_type sf::IniProfile::findEntry

(

const std::string &

key

)

Finds in the current section the key, on failure it returns npos.

findSection()

size_type sf::IniProfile::findSection

(

const std::string &

section

)

const

Finds current or specific section location in the list.

Returns

npos on not found.

flush()

void sf::IniProfile::flush

(

)

Flushes/Removes all sections from this instance.

getBool()

bool sf::IniProfile::getBool	(	const std::string &	key,
		bool	defaultBool = false
	)		const

Gets a boolean value.

getEntry()

Entry * sf::IniProfile::getEntry ( EntryVector::size_type  p )

protected

Gets nullptr if not exist.

getEntryCount()

size_type sf::IniProfile::getEntryCount

(

)

const

Gets the number of entries in the current section.

getEntryKey()

std::string sf::IniProfile::getEntryKey

(

size_type

pos

)

Gets the value in the current section from the given pos position. In the case of a comment-line, it returns a string of length zero when pos is the index to comment-line.

Returns

Key value.

getEntryValue()

std::string sf::IniProfile::getEntryValue

(

size_type

p

)

Gets entry value string in the current section by the given pos position.

Returns

Key or comment string.

getFilepath()

const std::string & sf::IniProfile::getFilepath

(

)

const

Gets the file path when it is set.

Returns

The ini filepath.

getFloat()

double sf::IniProfile::getFloat	(	const std::string &	key,
		double	defaultFloat = 0.0
	)		const

Sets a double value and sets the Dirty flag to true.

getInt()

int sf::IniProfile::getInt	(	const std::string &	key,
		int	defaultInt = 0
	)		const

Gets an integer value.

getKeys() [1/2]

string_list sf::IniProfile::getKeys

(

const std::string &

section

)

const

Gets all keys from the given section.

Parameters

section

Returns

List of strings.

getKeys() [2/2]

string_list sf::IniProfile::getKeys

(

size_type

section = npos

)

const

Gets the keys of the current section or of the passed section index.

Parameters

section

Section index where npos indicates the current selected one.

Returns

Vector key strings.

getMap()

KeyValueMap sf::IniProfile::getMap

(

size_type

section = npos

)

const

Gets the key value map from the current selected section by default or the section provided.

Parameters

section

Index of the section (default 'npos' = current)

Returns

Map of keys and values.

getSection()

std::string sf::IniProfile::getSection

(

size_type

p = npos

)

const

Gets the current or specific section name where p is the index in the section list.

getSectionCount()

size_type sf::IniProfile::getSectionCount

(

)

const

Gets the section count.

Returns

Number of sections.

getSections()

string_list sf::IniProfile::getSections

(

)

const

Get all section names in a std::string vector.

getString()

std::string sf::IniProfile::getString	(	const std::string &	key,
		const std::string &	defaultString = {}
	)		const

Gets a string class value.

getStringByRef()

bool sf::IniProfile::getStringByRef	(	const std::string &	key,
		std::string &	value,
		const std::string &	defaultString = {}
	)		const

Works the same as TProfile from OWL.

initialize()

void sf::IniProfile::initialize ( )

protected

Function called in any constructor.

insertComment()

bool sf::IniProfile::insertComment	(	const std::string &	key,
		const std::string &	comment
	)

Inserts comment before existing key.

isDirty()

bool sf::IniProfile::isDirty ( ) const

inline

Tells if there write functions are used or not.

keyExists()

bool sf::IniProfile::keyExists

(

const std::string &

key

)

const

Returns whether the passed key exists in the current selected in the section of the profile.

Parameters

key

Key name.

Returns

True when it exists.

load() [1/2]

bool sf::IniProfile::load ( const std::string &  filepath )

protected

Initialize the base from the filepath.

load() [2/2]

bool sf::IniProfile::load ( std::istream &  is )

protected

Initialize the base from the input stream.

operator=() [1/2]

IniProfile & sf::IniProfile::operator= ( IniProfile &&  )

delete

No move operator either.

Todo:

Need to make this class copyable.

operator=() [2/2]

IniProfile & sf::IniProfile::operator= ( IniProfile &  )

delete

No copy operator either.

Todo:

Need to make this class copyable.

read()

bool sf::IniProfile::read

(

std::istream &

is

)

Add sections from other std::istream.

removeEntry()

bool sf::IniProfile::removeEntry

(

size_type

p

)

Removes entry or comment by position.

removeKey()

bool sf::IniProfile::removeKey

(

const std::string &

key

)

Removes entry by key name.

removeKeys()

bool sf::IniProfile::removeKeys

(

size_type

section = npos

)

Removes all keys from a section by position or the current selected one if none has been passed.

removeSection() [1/2]

bool sf::IniProfile::removeSection

(

const std::string &

section

)

Removes a section by name.

removeSection() [2/2]

bool sf::IniProfile::removeSection

(

size_type

p

)

Removes a section by position.

sectionExists()

bool sf::IniProfile::sectionExists

(

const std::string &

section

)

const

Returns whether the passed section exists in the profile.

Parameters

section

Section name.

Returns

True when it exists.

selectSection()

bool sf::IniProfile::selectSection

(

const std::string &

section

)

const

Selects the section without creating.

Parameters

section

Section to set for reading or writing.

Returns

True when the section exists.

setBool()

bool sf::IniProfile::setBool	(	const std::string &	key,
		bool	value
	)

Sets a boolean value and sets the Dirty flag to true.

setFilepath()

bool sf::IniProfile::setFilepath

(

const std::string &

path

)

Set the path of this instance. When the current dirty-flag has been set, it is first written to disk before loading this file.

Parameters

path	Filepath to the ini-file.

Returns

True on successful loading of the passed file.

setFloat()

bool sf::IniProfile::setFloat	(	const std::string &	key,
		double	value
	)

Gets a boolean value.

setInt()

bool sf::IniProfile::setInt	(	const std::string &	key,
		int	value
	)

Sets an integer value and sets the Dirty flag to true.

setKeyPrefix()

void sf::IniProfile::setKeyPrefix

(

const std::string &

prefix = {}

)

Prepends prefix to key if prefix not null.

setMap()

void sf::IniProfile::setMap	(	const KeyValueMap &	map,
		size_type	section = npos
	)

Replaces the section with the given value map.

Parameters

map	Map of keys and values.
section	Index of the section (default 'npos' = current)

setSection() [1/2]

bool sf::IniProfile::setSection	(	const std::string &	section,
		bool	create = true
	)

Sets the current section.

Parameters

section	Section to create.
create	When true, it creates the section when it does not exist.

Returns

True, if the section exists or is created.

setSection() [2/2]

bool sf::IniProfile::setSection

(

size_type

index

)

Sets the current section by index.

Parameters

index

Section index.

Returns

True if the section exists.

setString()

bool sf::IniProfile::setString	(	const std::string &	key,
		const std::string &	value
	)

Sets a string class value making the Dirty flag true.

setWriteOnDirty()

void sf::IniProfile::setWriteOnDirty ( bool  enable )

inline

Set the write-on-dirty flag so changes are written on destruction. The default is true.

See also

write()

Parameters

enable

sync()

bool sf::IniProfile::sync

(

)

Syncs the content to file when the dirty-flag has been set. If the instance was created using a filepath the content is written when the dirty flag was set.

Returns

True on success or when no filepath assigned.

write()

virtual std::ostream & sf::IniProfile::write ( std::ostream &  os ) const

virtual

read to std::ostream 'os' current position.

writeSection()

std::ostream & sf::IniProfile::writeSection

(

std::ostream &

os

)

const

Writes the current section to an 'ostream'.

Member Data Documentation

_dirty

bool sf::IniProfile::_dirty {false}

protected

Is Set to true if an entry has been changed.

_flagClearOnRead

bool sf::IniProfile::_flagClearOnRead {true}

protected

If this flag is set, all fields read with 'ReadType' will be cleared.

_path

std::string sf::IniProfile::_path

protected

Path to file if it was created with one otherwise 'length' is zero.

_prefix

std::string sf::IniProfile::_prefix

protected

olds the prefix for all entered 'key's'.

H

_sectionIndex

SectionVector::size_type sf::IniProfile::_sectionIndex {npos}

protected

Current index to section.

_sections

SectionVector sf::IniProfile::_sections

protected

Vector holding all sections.

_writeOnDirty

bool sf::IniProfile::_writeOnDirty {true}

protected

When true, the profile is written to the filepath that was used to read it.

Entry

class _MISC_CLASS sf::IniProfile::Entry

protected

Forward declaration and also having export attributes.

npos

constexpr size_t sf::IniProfile::npos = EntryVector::npos

staticconstexpr

Index-not-found return value.

Section

class _MISC_CLASS sf::IniProfile::Section

protected

Forward declaration and also having export attributes.

---

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

• IniProfile.h