EDoc::ArchiveIFace Class Reference

#include <include/EDoc/ArchiveIFace.h>

Inheritance diagram for EDoc::ArchiveIFace:

---

Detailed Description

Standard interface for accessing files inside different types of archives.

An archive is considerd a group of one or more files. Current existing archives used for EDoc might include:

• BFD : Binary File Archive with data stored in .EDoc section
• Directory : A directory of files
• Zip : A zip file that may contain .edc files (Currently un-implemented).

Definition at line 41 of file ArchiveIFace.h.

Public Member Functions
virtual	~ArchiveIFace ()
	Destructor.
virtual bool	HandlesType (const ManagedFile &arch_filename)=0
	Returns true if this factory type can process the given archive.
virtual std::list< ManagedFile >	ReadExtractAll (const ManagedFile &arch_filename)=0
	Extracts all files from archive and returns a list of ManagedFile object to those extracted files.
virtual ManagedFile	WriteOpen (const ManagedFile &arch_filename, std::string item_filename="default.edc")=0
	Returns a ManagedFile instance for a file that can be written to in the archive.

---

Constructor & Destructor Documentation

EDoc::ArchiveIFace::~ArchiveIFace

(

)

[inline, virtual]

Destructor.

Note:

EDoc++ data included.

Definition at line 48 of file ArchiveIFace.h.

---

Member Function Documentation

EDoc::ArchiveIFace::HandlesType

(

const ManagedFile &

arch_filename

)

[pure virtual]

Returns true if this factory type can process the given archive.

Implemented in EDoc::DirectoryArchive, and EDocBFD::BFDArchive.

EDoc::ArchiveIFace::ReadExtractAll

(

const ManagedFile &

arch_filename

)

[pure virtual]

Extracts all files from archive and returns a list of ManagedFile object to those extracted files.

Exceptions:

	EDoc::EOFException	Originating from: EDocBFD::Section::Read(void*, size_t) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&)
	EDoc::FileIOException	Originating from: EDoc::GetAllFiles(EDoc::ManagedFile const&, std::string&) P: EDoc::DirectoryArchive::ReadExtractAll(EDoc::ManagedFile const&)
	EDocBFD::BFDException	Originating from: EDocBFD::OpenBFDFile(std::string) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&) Originating from: EDocBFD::ProcessReadBFD(std::list<EDoc::ManagedFile,std::allocator<EDoc::ManagedFile> >&, bfd*, EDoc::ManagedFile const&) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&) Originating from: EDocBFD::EmbedFileInBinary(std::string const&, std::string const, std::string const&, std::string) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&) Originating from: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&) Originating from: EDocBFD::Section::Read(void*, size_t) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&) Originating from: EDocBFD::Section::ReadEx(void*, size_t) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&) Originating from: EDocBFD::Section::ReadEx(size_t) P: EDocBFD::BFDArchive::ReadExtractAll(EDoc::ManagedFile const&)

Implemented in EDoc::DirectoryArchive, and EDocBFD::BFDArchive.

EDoc::ArchiveIFace::WriteOpen	(	const ManagedFile &	arch_filename,
		std::string	item_filename = "default.edc"
	)			[pure virtual]

Returns a ManagedFile instance for a file that can be written to in the archive.

Many archive formats will return a temporary file that can be written to and will then insert the contents of the temporay file into the archive when the ManagedFile object is destroyed. This is not always the case though for example the DirectoryArchive will just return a reference to a writable file itself.

Implemented in EDoc::DirectoryArchive, and EDocBFD::BFDArchive.

---

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

• include/EDoc/ArchiveIFace.h
• libs.dox

---