EDoc-0.2.1: EDoc::TextPersistence Class Reference

This implementation of PersistenceIFace was created primarily for debugging purposes. The files it generates are orders of magnitude larger than the BinaryPersistence class, however the format it uses provides key name, type and value validation upon reading. It also provides ability to write in a highly verbose mode where whenever an integer index is written to the file it will also write an un-used string that shows which data type that integer indexes. This makes reading .edc files mush easier.

This limits the string to be saved to string that only contain text values and NOT CR/LF characters. This isnt a problem for EDoc currently but may in the future be replaced with a format where the value is a string escaped using standard unix like escape sequence conventions (i.e. based on backslash char).

Constructor & Destructor Documentation

EDoc::TextPersistence::TextPersistence	(	bool	read,
		std::string	filename
	)

Create an instance that represents a text file for reading OR writing (But not both at once).

Note: This does not open the file for reading/writing but just creates an instance of this class that is prepared for reading/writing to the file.

Parameters:

	read	If true then the file is considered an input file and can only be used for reading. Otherwise it will be considered an output file and will only be available for writing to.
	filename	The name of the file to open.

Definition at line 38 of file TextPersistence.cpp.

EDoc::TextPersistence::~TextPersistence ( ) [virtual]

Closes the file upon destruction.

Note:: EDoc++ data included.

Definition at line 45 of file TextPersistence.cpp.

References Close().

Member Function Documentation

EDoc::TextPersistence::Open ( ) [virtual]

See PersistenceIFace::Open().

Note:: EDoc++ data included.

Exceptions:

	EDoc::EOFException	Originating from: EDoc::TextPersistence::GetNextLine(char const, char const) E: EDoc::TextPersistence::GetNextLine(char const, char const)
	EDoc::FileIOException	Originating from: EDoc::TextPersistence::Open() O: EDoc::TextPersistence::Open()


Public Member Functions
	TextPersistence (bool read, std::string filename)
	Create an instance that represents a text file for reading OR writing (But not both at once).
virtual	~TextPersistence ()
	Closes the file upon destruction.
virtual void	Open ()
	See PersistenceIFace::Open().
virtual void	Close ()
	See PersistenceIFace::Close().
virtual std::string	ReadString (const char *key)
	See PersistenceIFace::ReadString().
virtual bool	ReadBoolean (const char *key)
	See PersistenceIFace::ReadBoolean().
virtual uint8_t	ReadUInt8 (const char *key)
	See PersistenceIFace::ReadUInt8().
virtual int32_t	ReadInt32 (const char *key)
	See PersistenceIFace::ReadInt32().
virtual uint32_t	ReadUInt32 (const char *key)
	See PersistenceIFace::ReadUInt32().
virtual uint8_t	ReadRecordType ()
	See PersistenceIFace::ReadRecordType().
virtual void	WriteString (const char *key, std::string value)
	See PersistenceIFace::WriteString().
virtual void	WriteBoolean (const char *key, bool value)
	See PersistenceIFace::WriteBoolean().
virtual void	WriteUInt8 (const char *key, uint8_t value)
	See PersistenceIFace::WriteUInt8().
virtual void	WriteInt32 (const char *key, int32_t value)
	See PersistenceIFace::WriteInt32().
virtual void	WriteUInt32 (const char *key, uint32_t value)
	See PersistenceIFace::WriteUInt32().
virtual void	WriteUInt32Debug (const char *key, uint32_t value, std::string debug_text)
	See PersistenceIFace::WriteUInt32Debug().
virtual void	WriteInt32Debug (const char *key, int32_t value, std::string debug_text)
	See PersistenceIFace::WriteInt32Debug().
virtual void	WriteRecordType (uint8_t value)
	See PersistenceIFace::WriteRecordType().
Data Fields
int	ref_count
	Is a integer that can be used for reference counting.
Private Member Functions
std::string	ReadValue (const char key_in, const char type_in)
	Reads a line of data extracting the value string for that line.
std::string	GetNextLine (const char key_in="", const char type_in="")
	Reads the next line of data from the file.
Static Private Member Functions
static bool	ContainsData (const std::string &data)
	Returns true if the given string contains any characters that are not whitespaces.
Private Attributes
std::fstream	file
	The file stream used for writing/reading to/from.
bool	reading
	True if opened for reading.
size_t	line_count
	Current number of lines read from the file.
std::string	filename
	Name of file being operated on.

EDoc::TextPersistence::WriteString	(	const char *	key,
		std::string	value
	)			`[virtual]`

EDoc::TextPersistence::WriteBoolean	(	const char *	key,
		bool	value
	)			`[virtual]`

EDoc::TextPersistence::WriteUInt8	(	const char *	key,
		uint8_t	value
	)			`[virtual]`

EDoc::TextPersistence::WriteInt32	(	const char *	key,
		int32_t	value
	)			`[virtual]`

EDoc::TextPersistence::WriteUInt32	(	const char *	key,
		uint32_t	value
	)			`[virtual]`

EDoc::TextPersistence::WriteUInt32Debug	(	const char *	key,
		uint32_t	value,
		std::string	debug_text
	)			`[virtual]`

EDoc::TextPersistence::WriteInt32Debug	(	const char *	key,
		int32_t	value,
		std::string	debug_text
	)			`[virtual]`

EDoc::TextPersistence::ReadValue	(	const char *	key_in,
		const char *	type_in
	)			`[private]`

EDoc::TextPersistence::GetNextLine	(	const char *	key_in = `""`,
		const char *	type_in = `""`
	)			`[private]`

EDoc::TextPersistence Class Reference

Detailed Description

Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation