EDoc-0.2.1: EDoc::ManagedFile Class Reference

This implements an internal reference counting pattern where when no more copies of this managed file exist it will perform a cleanup action. This cleanup action is done on calling the virtual destructor of: ManagedFileCleanupIFace::~ManagedFileCleanupIFace() a derived class for ManagedFileCleanupIFace will implement various actions that need to be performed in order to cleanup the file correctly. This may include: Do nothing. Delete temporary file, Write temporary file into archive before delete.

Definition at line 42 of file ManagedFile.h.


Public Member Functions
	ManagedFile (std::list< std::string > identifier_in)
	Create a new managed file that is identified by the given list of archives.
	ManagedFile (std::string identifier_in)
	Create a new managed file for the given filename.
	ManagedFile (std::list< std::string > identifier_in, std::string work_file_name_in, ManagedFileCleanupIFace *cleanup_in)
	Create a new managed file that is operating on a given temporary file and has a given cleanup callback that needs to be called when we are finsihed using it.
	ManagedFile (const ManagedFile &right)
	Copy constructor.
ManagedFile &	operator= (const ManagedFile &right)
	Assignment operator.
virtual	~ManagedFile ()
	Destructor.
const std::string &	GetWorkFileName () const
	Retruns the name of the file that is to be used for reading/writing operations.
const std::list< std::string > &	GetIdentifier () const
	Returns the identifier for this file.
const std::string &	GetName () const
	Returns the name of the final file this represents without any archive context.
std::string	GetFileNameRep () const
	Returns a string that represents the name of the file including its archive context.
Private Member Functions
void	IncRef ()
	Increment the reference count to the cleanup instance.
void	DecRef ()
	Decrement the reference count to the cleanup instance and perform any cleanup operations if necessary when the reference count reaches 0.
Private Attributes
ManagedFileCleanupIFace *	cleanup
	Reference to object that implementes operations to perform to close/cleanup the file.
std::string	work_file_name
	Reference to a temporary file that all work is to be performed on.
std::list< std::string >	identifier
	List of identifiers used to identify this file within an abrbitrary list of archives.

Constructor & Destructor Documentation

EDoc::ManagedFile::ManagedFile ( std::list< std::string > identifier_in ) [explicit]

Create a new managed file that is identified by the given list of archives.

If the list contains just a single member then that is a direct filename, otheriwse the list contains the identifiers for recursive archives. For example if this was managing a file called Blah.edc inside a zipfile call foo.zip which itself was part of another zip file bar.zip you would pass the following:

bar.zip
foo.zip
Blah.edc

Definition at line 30 of file ManagedFile.cpp.

References IncRef().

EDoc::ManagedFile::ManagedFile ( std::string identifier_in ) [explicit]

Create a new managed file for the given filename.

This is just a wrapper around the above constructor.

Definition at line 37 of file ManagedFile.cpp.

References identifier, and IncRef().

EDoc::ManagedFile::ManagedFile	(	std::list< std::string >	identifier_in,
		std::string	work_file_name_in,
		EDoc::ManagedFileCleanupIFace *	cleanup_in
	)

Create a new managed file that is operating on a given temporary file and has a given cleanup callback that needs to be called when we are finsihed using it.

Note:: EDoc++ data included.

Definition at line 44 of file ManagedFile.cpp.

References IncRef().

EDoc::ManagedFile::ManagedFile ( const ManagedFile & right )

Copy constructor.

Note:: EDoc++ data included.

Definition at line 55 of file ManagedFile.cpp.

References IncRef().

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

Destructor.

If this is the last reference to the particular file being managed then it will perform any cleanup operations that may have been associated with the file. For example this could include adding it to a zip archive or deleteing a temporary file etc.

Definition at line 79 of file ManagedFile.cpp.

References DecRef().

Member Function Documentation

EDoc::ManagedFile::operator= ( const ManagedFile & right )

Assignment operator.