configuration::ini_configurator Class Reference

Supports a configurator-based interface on text initialization files. More...

#include <ini_configurator.h>

Inheritance diagram for configuration::ini_configurator:

[legend]

Collaboration diagram for configuration::ini_configurator:

[legend]

List of all members.

Public Types
enum	file_location_default { APPLICATION_DIRECTORY, OS_DIRECTORY, ALL_USERS_DIRECTORY }
	chooses where the ini file is located if no path to it is provided. More...
Public Member Functions
	ini_configurator (const basis::astring &ini_filename, treatment_of_defaults behavior=RETURN_ONLY, file_location_default where=ALL_USERS_DIRECTORY)
	creates an ini_configurator that stores entries into "ini_filename".
virtual	~ini_configurator ()
	DEFINE_CLASS_NAME ("ini_configurator")
void	refresh ()
	useful mainly on unix/linux, where the file is parsed and held in memory.
basis::astring	name () const
	observes the name of the file used for ini entries.
void	name (const basis::astring &name)
	modifies the name of the file used for ini entries.
virtual bool	get (const basis::astring &section, const basis::astring &entry, basis::astring &found)
	implements the configurator retrieval function.
virtual void	sections (structures::string_array &list)
	retrieves the section names into "list".
virtual bool	section_exists (const basis::astring &section)
	returns true if the "section" was found in the file.
virtual bool	put (const basis::astring &section, const basis::astring &entry, const basis::astring &to_store)
	implements the configurator storage function.
virtual bool	delete_section (const basis::astring &section)
	removes the entire "section" specified.
virtual bool	delete_entry (const basis::astring &section, const basis::astring &entry)
	removes the entry specified by the "section" and "entry" name.
virtual bool	get_section (const basis::astring &section, structures::string_table &info)
	reads the entire "section" into a table called "info".
virtual bool	put_section (const basis::astring &section, const structures::string_table &info)
	writes a table called "info" into the "section" in the INI file.
bool	add_spaces () const
void	add_spaces (bool add_them)

Detailed Description

Supports a configurator-based interface on text initialization files.

Definition at line 32 of file ini_configurator.h.

Member Enumeration Documentation

enum configuration::ini_configurator::file_location_default

chooses where the ini file is located if no path to it is provided.

the ini file being manipulated will be stored in either the same directory as the program being executed (APPLICATION_DIRECTORY) or in the directory where the operating system resides (OS_DIRECTORY). however, the OS_DIRECTORY choice only really makes sense on windows. if the flag is instead ALL_USERS_DIRECTORY, then the directory pointed at by the $ALLUSERSPROFILE variable will be used on windows; otherwise, the default is the same as for APPLICATION_DIRECTORY.

Enumerator:

APPLICATION_DIRECTORY	config files live with application.
OS_DIRECTORY	config files live in operating system directory.
ALL_USERS_DIRECTORY	config files live in the "all users" account.

Definition at line 43 of file ini_configurator.h.

Constructor & Destructor Documentation

configuration::ini_configurator::ini_configurator	(	const basis::astring &	ini_filename,
		treatment_of_defaults	behavior = `RETURN_ONLY`,
		file_location_default	where = `ALL_USERS_DIRECTORY`
	)

creates an ini_configurator that stores entries into "ini_filename".

the ini config will have the "behavior" specified for how to handle missing items. "where" dictates the file's location if no path is specified as part of the "ini_filename".

Definition at line 50 of file ini_configurator.cpp.

configuration::ini_configurator::~ini_configurator ( ) [virtual]

Definition at line 63 of file ini_configurator.cpp.

References basis::WHACK().