Linker::Format Class Reference

A class to encode a general file format. More...

#include <format.h>

Inheritance diagram for Linker::Format:

Public Member Functions
	Format (offset_t file_offset=0)
virtual void	Clear ()
	Resets all fields to their default values, deallocate memory.
virtual void	ReadFile (Reader &rd)=0
	Loads file into memory.
offset_t	WriteFile (Writer &wr) const override=0
	Stores data in memory to file.
virtual void	Dump (Dumper::Dumper &dump) const
	Display file contents in a nice manner.
offset_t	ImageSize () const override
	Retrieves size of stored data.
offset_t	WriteFile (Writer &wr, offset_t count, offset_t offset=0) const override
	Writes data of non-zero filled sections.
Public Member Functions inherited from Linker::Image
virtual std::shared_ptr< const ActualImage >	AsImage () const
	Retrieves a randomly accessible image.
std::shared_ptr< ActualImage >	AsImage ()
	Retrieves a randomly accessible image.

Public Attributes
offset_t	file_offset

Detailed Description

A class to encode a general file format.

Member Function Documentation

Clear()

void Format::Clear ( )

virtual

Resets all fields to their default values, deallocate memory.

Reimplemented in Binary::CommodoreFormat, Binary::CPM3Format, ARM::AIFFormat, Binary::GenericBinaryFormat, Binary::BinaryFormat, COFF::COFFFormat, DigitalResearch::CPM68KFormat, DigitalResearch::CPM86Format, DigitalResearch::CPM8KFormat, Microsoft::MZFormat, O65::O65Format, and Ergo::XPFormat.

Dump()

void Format::Dump ( Dumper::Dumper & dump ) const

virtual

Display file contents in a nice manner.

Reimplemented in Binary::AppleFormat, Binary::AtariFormat, Binary::CommodoreFormat, Binary::CPM3Format, Binary::FLEXFormat, Binary::PRLFormat, Binary::UZIFormat, Binary::UZI280Format, ARM::AIFFormat, AOut::AOutFormat, Archive::ArchiveFormat, AS86Obj::AS86ObjFormat, Binary::GenericBinaryFormat, Binary::BinaryFormat, DOS16M::BWFormat, COFF::COFFFormat, DigitalResearch::CPM68KFormat, DigitalResearch::CPM86Format, DigitalResearch::CPM8KFormat, SeychellDOS32::AdamFormat, BrocaD3X::D3X1Format, DX64::LVFormat, ELF::ELFFormat, ELF::FatELFFormat, GEOS::GeodeFormat, Apple::OMFFormat, X68000::HUFormat, Amiga::HunkFormat, Java::ClassFormat, Microsoft::LEFormat, MachO::MachOFormat, MachO::FatMachOFormat, Apple::AppleSingleDouble::Entry, Apple::AppleSingleDouble, Apple::ResourceFork::Resource, Apple::ResourceFork::GenericResource, Apple::ResourceFork::JumpTableCodeResource, Apple::ResourceFork::CodeResource, Apple::ResourceFork, Apple::RealName, Apple::FileInfo::Macintosh, Apple::FileInfo::ProDOS, Apple::FileInfo::MSDOS, Apple::FileInfo::AUX, Apple::FileDatesInfo, Apple::FinderInfo, Apple::MacintoshFileInfo, Apple::ProDOSFileInfo, Apple::MSDOSFileInfo, Apple::MacBinary, MINIX::MINIXFormat, Microsoft::MZFormat, Microsoft::NEFormat, O65::O65Format, OMF::OMFFormat, PCOS::CMDFormat, Microsoft::PEFormat, Apple::PEFFormat, PharLap::MPFormat, PharLap::P3Format, PharLap::P3Format::Flat, PharLap::P3Format::MultiSegmented, PharLap::P3FormatContainer, PMODE::PMW1Format, Microsoft::W3Format, Xenix::BOutFormat, Xenix::XOutFormat, and Ergo::XPFormat.

ImageSize()

offset_t Format::ImageSize ( ) const

overridevirtual

Retrieves size of stored data.

Implements Linker::Image.

Reimplemented in Binary::GenericBinaryFormat, Apple::OMFFormat, Amiga::HunkFormat, Apple::ResourceFork::GenericResource, Apple::ResourceFork::JumpTableCodeResource, Apple::ResourceFork, Apple::RealName, Apple::FileInfo::Macintosh, Apple::FileInfo::ProDOS, Apple::FileInfo::MSDOS, Apple::MacintoshFileInfo, Apple::ProDOSFileInfo, Apple::MSDOSFileInfo, MINIX::MINIXFormat, Microsoft::NEFormat, Ergo::XPFormat, and Apple::ResourceFork::Resource.

ReadFile()

virtual void Linker::Format::ReadFile ( Reader & rd )

pure virtual

Loads file into memory.

Implemented in Binary::AppleFormat, Binary::AtariFormat, Binary::CPM3Format, Binary::PRLFormat, ARM::AIFFormat, AOut::AOutFormat, Archive::ArchiveFormat, AS86Obj::AS86ObjFormat, Binary::GenericBinaryFormat, Binary::BinaryFormat, DOS16M::BWFormat, COFF::COFFFormat, DigitalResearch::CPM68KFormat, DigitalResearch::CPM86Format, DigitalResearch::CPM8KFormat, SeychellDOS32::AdamFormat, BrocaD3X::D3X1Format, DX64::LVFormat, ELF::ELFFormat, ELF::FatELFFormat, GEOS::GeodeFormat, Apple::OMFFormat, X68000::HUFormat, Amiga::HunkFormat, Java::ClassFormat, Microsoft::LEFormat, MachO::MachOFormat, MachO::FatMachOFormat, Apple::AppleSingleDouble, Apple::AppleSingleDouble::Entry, Apple::ResourceFork::Resource, Apple::MacDriver, MINIX::MINIXFormat, Microsoft::MZFormat, Microsoft::NEFormat, O65::O65Format, OMF::OMFFormat, PCOS::CMDFormat, Microsoft::PEFormat, Apple::PEFFormat, PharLap::MPFormat, PharLap::P3Format, PharLap::P3FormatContainer, PMODE::PMW1Format, Microsoft::W3Format, Xenix::BOutFormat, Xenix::XOutFormat, and Ergo::XPFormat.

WriteFile() [1/2]

offset_t Linker::Format::WriteFile ( Writer & wr ) const

overridepure virtual

Stores data in memory to file.

Reimplemented from Linker::Image.

Implemented in Apple::AppleSingleDouble::Entry, Binary::AppleFormat, Binary::AtariFormat, Binary::CommodoreFormat, Binary::CPM3Format, Binary::FLEXFormat, Binary::PRLFormat, Binary::UZIFormat, Binary::UZI280Format, ARM::AIFFormat, AOut::AOutFormat, Archive::ArchiveFormat, AS86Obj::AS86ObjFormat, Binary::GenericBinaryFormat, Binary::BinaryFormat, DOS16M::BWFormat, COFF::COFFFormat, DigitalResearch::CPM68KFormat, DigitalResearch::CPM86Format, DigitalResearch::CPM8KFormat, SeychellDOS32::AdamFormat, BrocaD3X::D3X1Format, DX64::LVFormat, ELF::ELFFormat, ELF::FatELFFormat, GEOS::GeodeFormat, Apple::OMFFormat, X68000::HUFormat, Amiga::HunkFormat, Java::ClassFormat, Microsoft::LEFormat, MachO::MachOFormat, MachO::FatMachOFormat, Apple::AppleSingleDouble, Apple::ResourceFork::Resource, Apple::ResourceFork::GenericResource, Apple::ResourceFork::JumpTableCodeResource, Apple::ResourceFork::CodeResource, Apple::ResourceFork, Apple::RealName, Apple::FileInfo::Macintosh, Apple::FileInfo::ProDOS, Apple::FileInfo::MSDOS, Apple::FileInfo::AUX, Apple::FileDatesInfo, Apple::FinderInfo, Apple::MacintoshFileInfo, Apple::ProDOSFileInfo, Apple::MSDOSFileInfo, Apple::MacBinary, Apple::MacDriver, MINIX::MINIXFormat, Microsoft::MZFormat, Microsoft::NEFormat, O65::O65Format, OMF::OMFFormat, PCOS::CMDFormat, Microsoft::PEFormat, Apple::PEFFormat, PharLap::MPFormat, PharLap::P3Format, PharLap::P3Format::Flat, PharLap::P3Format::MultiSegmented, PharLap::P3FormatContainer, PMODE::PMW1Format, Microsoft::W3Format, Xenix::BOutFormat, Xenix::XOutFormat, and Ergo::XPFormat.

WriteFile() [2/2]

offset_t Format::WriteFile ( Writer & wr, offset_t count, offset_t offset = 0 ) const

overridevirtual

Writes data of non-zero filled sections.

Implements Linker::Image.

---

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

• src/linker/format.h
• src/linker/format.cc