EDoc-0.2.1: EDoc::Persistence Class Reference

Type representing what format (Text/Binary) the .edc file is encoded in.

Enumerator:

UNKNOWN
TEXT
BINARY

Definition at line 53 of file Persistence.h.

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

Destructor.

Will delete any open temporary files.

Definition at line 274 of file Persistence.cpp.

References DecRef().

EDoc::Persistence::Persistence ( const Persistence & right )

Copy constructor.

Note:: EDoc++ data included.

Definition at line 168 of file Persistence.cpp.

References IncRef().

Referenced by WriteOpen().

EDoc::Persistence::Persistence	(	bool	read,
		ManagedFile	file_in,
		EncodingType	format_in
	)			`[private]`

Private constructor.

Users interface with the Open() and OpenSingle() calls which call this.

Definition at line 178 of file Persistence.cpp.

References BINARY, EDOC_ASSERT, EDOC_THROW_EXCEPTION, file, format, EDoc::ManagedFile::GetWorkFileName(), impl, IncRef(), TEXT, and UNKNOWN.

EDoc::Persistence::AddTempFile ( std::string filename ) [static]

Adds a new temporary file to the temp_files list.

Note:: EDoc++ data included.

Definition at line 60 of file Persistence.cpp.

References EDOC_Warning, and temp_files.

Referenced by EDocBFD::ExtractedBFDFile::ExtractedBFDFile().

EDoc::Persistence::RemoveTempFile ( std::string filename ) [static]

Adds a temporary file from the temp_files list after it has been deleted.

For atomicity you should only call this AFTER the temp file has been unlinked.

Definition at line 72 of file Persistence.cpp.

References EDOC_Warning, and temp_files.

Referenced by EDocBFD::ExtractedBFDFile::~ExtractedBFDFile().

EDoc::Persistence::AddArchiveFactory ( EDoc::ArchiveIFace * factory ) [static]

Adds new archive format that can be used for reading/writing.

Note:: EDoc++ data included.

Definition at line 84 of file Persistence.cpp.

References archive_formats.

EDoc::Persistence::ReadExtract ( ManagedFile filename ) [static]

Will extract a list of managed files from a given file if it is a known archive type.

If it is not a known archive type then will return an empty list.

Definition at line 89 of file Persistence.cpp.

References EDoc::Append(), archive_formats, EDOC_Fine, EDOC_FOREACH, and EDoc::ManagedFile::GetName().

Referenced by ReadOpen().

EDoc::Persistence::ReadOpen ( std::string filename ) [static]

Opens the given file for reading from.

If filename is an archive file, then this may extract more than one .edc file from it. This will automatically determine if the file being read is an archive, and when opening the .edc files will automatically determine if it is opening a binary or text edc file.

Definition at line 118 of file Persistence.cpp.

References EDOC_Debug, EDOC_Fine, EDOC_FOREACH, ReadExtract(), UNKNOWN, and EDoc::Throwable::what().

EDoc::Persistence::WriteOpen	(	std::string	filename,
		EncodingType	format = `TEXT`,
		std::string	item_name = `"default.edc"`
	)			`[static]`

Opens the given file for writing to.

If filename references a file that already exists this will first check to see if it is a known archive type, in which case it will insert a new edc file into that archive. Otherwise if the file exists but is not a valid known archive type, then this will overwrite the existing file.

Parameters:

	filename	The name of the file or archive to write to.
	format	The .edc file format type to use for writing the edc file. One of TEXT or BINARY.
	item_name	If filename is an archive this can optionally be a name to give the .edc file within that archive. By default EDoc will use the name default.edc

Note: Some archive formats will not ADD the edc file to the archive but effectivly overwrite all existing .edc files in the archive with this new .edc file. This si what the BFd implementation currently does.

Definition at line 147 of file Persistence.cpp.

References archive_formats, EDOC_FOREACH, and Persistence().

EDoc::Persistence::GetFilenameRep ( ) const

Returns a representation of the name of the file being used.

This is a string to will indicate the source AND work files if they differ.

Definition at line 300 of file Persistence.cpp.

References file, and EDoc::ManagedFile::GetFileNameRep().

EDoc::Persistence::Open ( ) [inline, virtual]

See PersistenceIFace::Open().

Note:: EDoc++ data included.

Exceptions:

	EDoc::EOFException	Originating from: EDoc::TextPersistence::GetNextLine(char const, char const) P: EDoc::PersistenceIFace::Open()
	EDoc::FileIOException	Originating from: EDoc::TextPersistence::Open() P: EDoc::PersistenceIFace::Open() Originating from: EDoc::BinaryPersistence::Open() P: EDoc::PersistenceIFace::Open()


Public Types
enum	EncodingType { UNKNOWN = 0, TEXT, BINARY }
	Type representing what format (Text/Binary) the .edc file is encoded in. More...
Public Member Functions
std::string	GetFilenameRep () const
	Returns a representation of the name of the file being used.
virtual	~Persistence ()
	Destructor.
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().
	Persistence (const Persistence &right)
	Copy constructor.
Persistence &	operator= (const Persistence &right)
	Assignment operator.
Static Public Member Functions
static void	AddTempFile (std::string filename)
	Adds a new temporary file to the temp_files list.
static void	RemoveTempFile (std::string filename)
	Adds a temporary file from the temp_files list after it has been deleted.
static void	AddArchiveFactory (ArchiveIFace *factory)
	Adds new archive format that can be used for reading/writing.
static std::list< ManagedFile >	ReadExtract (ManagedFile filename)
	Will extract a list of managed files from a given file if it is a known archive type.
static std::list< Persistence >	ReadOpen (std::string filename)
	Opens the given file for reading from.
static Persistence	WriteOpen (std::string filename, EncodingType format=TEXT, std::string item_name="default.edc")
	Opens the given file for writing to.
Data Fields
int	ref_count
	Is a integer that can be used for reference counting.
Static Public Attributes
static std::list< std::string >	temp_files
	List of all currently open temporary files.
Private Member Functions
	Persistence (bool read, ManagedFile file_in, EncodingType format_in)
	Private constructor.
void	IncRef ()
	Increases the reference count of impl.
void	DecRef ()
	Decreases the reference count of impl andwill delete it if reference count reaches 0.
Private Attributes
ManagedFile	file
	A reference to the managed file that is the source for this persistence.
EncodingType	format
	The format declared to use for encoding/decoding the file.
PersistenceIFace *	impl
	A pointer to the particular persistence layer to use.
Static Private Attributes
static std::list< ArchiveIFace * >	archive_formats
	A list of "factories" for all archive formats that can be understood.

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

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

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

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

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

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

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

EDoc::Persistence Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation