EDocBFD Namespace Reference

Data Structures
class	ExtractedBFDFile
	Used to cleanup when usage of an extracted BFD file is complete. More...
class	BFDArchive
	Factory for inserting/extracting files to/from the .edoc section of a binary file. More...
class	BFDException
class	Section
	Used to simplify writing/reading to/from bfd sections. More...
Functions
void	InitialiseBFD ()
	Must be called before using any bfd related functions.
bfd *	OpenBFDFile (std::string filename)
	Opens the given file using bfd.
void	ProcessReadBFD (std::list< EDoc::ManagedFile > &input_files, struct bfd *abfd, const EDoc::ManagedFile &filename)
	Reads the contens of a binary file and extracts all relevant EDoc information from them if there is any.
std::list< EDoc::ManagedFile >	HandleEDocSection (bfd *abfd, asection *asect, const EDoc::ManagedFile &arch)
	Returns a list of temporary files that have been populated with the contents of an EDoc section.
void	EmbedFileInBinary (const std::string &file_to_embed, const std::string embedded_name, const std::string &binary_file, std::string section)
	Embeds the contents of the given file into the given section of a binary file.
Variables
bool	bfd_initialised = false

---

Function Documentation

EDocBFD::EmbedFileInBinary	(	const std::string &	file_to_embed,
		const std::string	embedded_name,
		const std::string &	binary_file,
		std::string	section
	)

Embeds the contents of the given file into the given section of a binary file.

Note:

EDoc++ data included.

Exceptions:

EDocBFD::BFDException

Originating from: EDocBFD::EmbedFileInBinary(std::string const&, std::string const, std::string const&, std::string) O: EDocBFD::EmbedFileInBinary(std::string const&, std::string const, std::string const&, std::string)

Definition at line 264 of file bfd_utils.cpp.

References EDoc::CreateTempFilename(), EDOC_THROW_EXCEPTION, and EDoc::RunProgram().

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

EDocBFD::HandleEDocSection	(	bfd *	abfd,
		asection *	asect,
		const EDoc::ManagedFile &	arch
	)

Returns a list of temporary files that have been populated with the contents of an EDoc section.

Note:

EDoc++ data included.

Exceptions:

	EDoc::EOFException	Originating from: EDocBFD::Section::Read(void*, size_t) E: EDocBFD::Section::ReadEx(size_t) Rethrown: 1 times. Lines: ?? E: EDocBFD::Section::ReadEx(void*, size_t) Rethrown: 1 times. Lines: ??
	EDocBFD::BFDException	Originating from: EDocBFD::EmbedFileInBinary(std::string const&, std::string const, std::string const&, std::string) P: EDocBFD::ExtractedBFDFile::ExtractedBFDFile(std::string&) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) O: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::Section::Read(void*, size_t) E: EDocBFD::Section::ReadEx(size_t) Rethrown: 1 times. Lines: ?? E: EDocBFD::Section::ReadEx(void*, size_t) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::Section::ReadEx(void*, size_t) E: EDocBFD::Section::ReadEx(void*, size_t) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::Section::ReadEx(size_t) E: EDocBFD::Section::ReadEx(size_t) Rethrown: 1 times. Lines: ??

Definition at line 178 of file bfd_utils.cpp.

References EDoc::CreateTempFilename(), EDOC_Debug, EDOC_Finest, EDOC_THROW_EXCEPTION, EDoc::Erase(), EDoc::ManagedFile::GetIdentifier(), EDocBFD::Section::IsEof(), and EDocBFD::Section::ReadEx().

Referenced by ProcessReadBFD().

EDocBFD::InitialiseBFD

(

)

Must be called before using any bfd related functions.

Note:

EDoc++ data included.

Definition at line 134 of file bfd_utils.cpp.

References bfd_initialised.

Referenced by EDocBFD::BFDArchive::BFDArchive(), and OpenBFDFile().

EDocBFD::OpenBFDFile

(

std::string

filename

)

Opens the given file using bfd.

Note:

EDoc++ data included.

Exceptions:

EDocBFD::BFDException

Originating from: EDocBFD::OpenBFDFile(std::string) O: EDocBFD::OpenBFDFile(std::string)

Definition at line 143 of file bfd_utils.cpp.

References EDOC_Debug, EDOC_THROW_EXCEPTION, and InitialiseBFD().

Referenced by EDocBFD::BFDArchive::HandlesType(), and EDocBFD::BFDArchive::ReadExtractAll().

EDocBFD::ProcessReadBFD	(	std::list< EDoc::ManagedFile > &	input_files,
		struct bfd *	abfd,
		const EDoc::ManagedFile &	filename
	)

Reads the contens of a binary file and extracts all relevant EDoc information from them if there is any.

Note:

EDoc++ data included.

Exceptions:

	EDoc::EOFException	Originating from: EDocBFD::Section::Read(void*, size_t) E: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ??
	EDocBFD::BFDException	Originating from: EDocBFD::ProcessReadBFD(std::list<EDoc::ManagedFile,std::allocator<EDoc::ManagedFile> >&, bfd*, EDoc::ManagedFile const&) O: EDocBFD::ProcessReadBFD(std::list<EDoc::ManagedFile,std::allocator<EDoc::ManagedFile> >&, bfd*, EDoc::ManagedFile const&) E: EDocBFD::ProcessReadBFD(std::list<EDoc::ManagedFile,std::allocator<EDoc::ManagedFile> >&, bfd*, EDoc::ManagedFile const&) Originating from: EDocBFD::EmbedFileInBinary(std::string const&, std::string const, std::string const&, std::string) P: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) E: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::Section::Read(void*, size_t) E: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::Section::ReadEx(void*, size_t) E: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ?? Originating from: EDocBFD::Section::ReadEx(size_t) E: EDocBFD::HandleEDocSection(bfd*, asection*, EDoc::ManagedFile const&) Rethrown: 1 times. Lines: ??

Definition at line 59 of file bfd_utils.cpp.

References EDoc::Append(), EDOC_Debug, EDOC_Fine, EDOC_SECTION_NAME, EDOC_THROW_EXCEPTION, EDoc::Erase(), EDoc::ManagedFile::GetFileNameRep(), and HandleEDocSection().

Referenced by EDocBFD::BFDArchive::ReadExtractAll().

---

Variable Documentation

bool EDocBFD::bfd_initialised = false

Definition at line 56 of file bfd_utils.cpp.

Referenced by InitialiseBFD().

---