PWToolBox::Configuration::INIConfigurationWriter Class Reference

Writes a configuration in INI format. More...

#include <INIConfigurationWriter.h>

Inheritance diagram for PWToolBox::Configuration::INIConfigurationWriter:

[legend]List of all members.

Public Member Functions
	INIConfigurationWriter (std::ostream &outputStream, bool const ignoreEmptySections=true)
virtual	~INIConfigurationWriter ()
virtual bool	_writeSectionBegin (ConfigurationSection const &configuration, std::string const &key, ConfigurationSetting::AttributeList const &attrs)
	This is called at the beginning of each section.
virtual bool	_writeSettingBegin (ConfigurationSection const &configuration, std::string const &key, ConfigurationSetting::AttributeList const &attrs)
	This is called at the beginning of each setting.
virtual bool	_writeData (ConfigurationSection const &configuration, std::string const &data)
	This is called when writing the data.
virtual bool	_writeSectionEnd (ConfigurationSection const &configuration, std::string const &key)
	This is called at the end of each section.
virtual bool	_writeSettingEnd (ConfigurationSection const &configuration, std::string const &key)
	This is called at the end of each setting.
virtual void	_writeComment (ConfigurationSection const &configuration, std::string const &comment)
	This is called for each comment.
Protected Attributes
std::string	m_keyStack
	Essentially this will be a stack where each element is separated by a '.'.
bool	m_firstLine
	This is used just for formatting to avoid a blank line at the top.
bool	m_firstSection
	The first section will be the root section, so no section names should be written.
bool const	m_ignoreEmptySections
	Determines if sections without settings will have the section name written.

---

Detailed Description

Writes a configuration in INI format.

---

Constructor & Destructor Documentation

PWToolBox::Configuration::INIConfigurationWriter::INIConfigurationWriter	(	std::ostream &	outputStream,
		bool const	ignoreEmptySections = true
	)			[inline]

Parameters:

outputStream

The output stream to use for writing.

Parameters:

ignoreEmptySections

If true, sections that have no settings will not have the section name written

virtual PWToolBox::Configuration::INIConfigurationWriter::~INIConfigurationWriter

(

)

[inline, virtual]

---

Member Function Documentation

virtual bool PWToolBox::Configuration::INIConfigurationWriter::_writeSectionBegin	(	ConfigurationSection const &	configuration,
		std::string const &	key,
		ConfigurationSetting::AttributeList const &	attrs
	)			[virtual]

This is called at the beginning of each section.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The section name
	attrs	The attributes of the section

Returns:

true if writing should continue, false otherwise

Reimplemented from PWToolBox::Configuration::ConfigurationWriter.

virtual bool PWToolBox::Configuration::INIConfigurationWriter::_writeSettingBegin	(	ConfigurationSection const &	configuration,
		std::string const &	key,
		ConfigurationSetting::AttributeList const &	attrs
	)			[virtual]

This is called at the beginning of each setting.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The setting name
	attrs	The attributes of the section

Returns:

true if writing should continue, false otherwise

Reimplemented from PWToolBox::Configuration::ConfigurationWriter.

virtual bool PWToolBox::Configuration::INIConfigurationWriter::_writeData	(	ConfigurationSection const &	configuration,
		std::string const &	data
	)			[virtual]

This is called when writing the data.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	data	The data to write

Returns:

true if writing should continue, false otherwise

Reimplemented from PWToolBox::Configuration::ConfigurationWriter.

virtual bool PWToolBox::Configuration::INIConfigurationWriter::_writeSectionEnd	(	ConfigurationSection const &	configuration,
		std::string const &	key
	)			[virtual]

This is called at the end of each section.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The section name

Returns:

true if writing should continue, false otherwise

Reimplemented from PWToolBox::Configuration::ConfigurationWriter.

virtual bool PWToolBox::Configuration::INIConfigurationWriter::_writeSettingEnd	(	ConfigurationSection const &	configuration,
		std::string const &	key
	)			[virtual]

This is called at the end of each setting.

This function should not be called directly.

Parameters:

	configuration	The ConfigurationSection being written
	key	The setting name

Returns:

true if writing should continue, false otherwise

Reimplemented from PWToolBox::Configuration::ConfigurationWriter.

virtual void PWToolBox::Configuration::INIConfigurationWriter::_writeComment	(	ConfigurationSection const &	configuration,
		std::string const &	comment
	)			[virtual]

This is called for each comment.

This function is not supported yet

Parameters:

	configuration	The ConfigurationSection being written
	comment	The comment being written

Reimplemented from PWToolBox::Configuration::ConfigurationWriter.

---

Member Data Documentation

std::string PWToolBox::Configuration::INIConfigurationWriter::m_keyStack [protected]

Essentially this will be a stack where each element is separated by a '.'.

bool PWToolBox::Configuration::INIConfigurationWriter::m_firstLine [protected]

This is used just for formatting to avoid a blank line at the top.

bool PWToolBox::Configuration::INIConfigurationWriter::m_firstSection [protected]

The first section will be the root section, so no section names should be written.

bool const PWToolBox::Configuration::INIConfigurationWriter::m_ignoreEmptySections [protected]

Determines if sections without settings will have the section name written.

---

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

• INIConfigurationWriter.h

---