Microsoft::LEFormat::SegmentPage Class Reference

An image instance for a single page within a complete object image. More...

#include <leexe.h>

Inheritance diagram for Microsoft::LEFormat::SegmentPage:

Public Member Functions
	SegmentPage (std::shared_ptr< Linker::Image > image, offset_t offset, offset_t size)
offset_t	ImageSize () const override
	Retrieves the offset of the byte after the last one belonging to this format from the first one.
offset_t	WriteFile (const std::shared_ptr< Linker::Writer > &wr, offset_t count, offset_t offset=0) const override
	Writes data of non-zero filled sections.
size_t	ReadData (size_t bytes, offset_t offset, void *buffer) const override
	Attempts to fill a buffer with data.
std::shared_ptr< const Linker::Image >	AsImage () const override
	Retrieves a randomly accessible image.
Public Member Functions inherited from Linker::Image
uint64_t	ReadUnsigned (size_t bytes, offset_t offset, EndianType endiantype) const
	Reads an unsigned number at a specific offset.
uint64_t	ReadUnsigned (size_t bytes, offset_t offset) const
	Reads an unsigned number at a specific offset with the default endianness.
int64_t	ReadSigned (size_t bytes, offset_t offset, EndianType endiantype) const
	Reads a signed number at a specific offset.
int64_t	ReadSigned (size_t bytes, offset_t offset) const
	Reads a signed number at a specific offset with the default endianness.
int	GetByte (offset_t offset) const
	Retrieve byte at a certain offset (optional, might not be defined)
offset_t	WriteFile (const std::shared_ptr< Writer > &wr) const override
	Writes data of non-zero filled sections.
virtual offset_t	WriteFile (const std::shared_ptr< Writer > &wr) const=0
	Writes data of non-zero filled sections.
Public Member Functions inherited from Linker::Contents
std::shared_ptr< Image >	AsImage ()
	Retrieves a randomly accessible image.

Public Attributes
std::shared_ptr< Linker::Image >	image
offset_t	offset = 0
offset_t	size = 0

Detailed Description

An image instance for a single page within a complete object image.

When writing an LE/LX binary image, the object data needs to be split up into sections called pages (typically 4 KiB in size). This class implements the Image interface but instead gives a restricted window into the full data image, to be stored as a single page image.

Member Function Documentation

AsImage()

std::shared_ptr< const Linker::Image > LEFormat::SegmentPage::AsImage ( ) const

overridevirtual

Retrieves a randomly accessible image.

Reimplemented from Linker::Image.

ImageSize()

offset_t LEFormat::SegmentPage::ImageSize ( ) const

overridevirtual

Retrieves the offset of the byte after the last one belonging to this format from the first one.

Returns

The size of the image, or offset_t(-1) if it cannot be determined before writing to the file

Implements Linker::Contents.

ReadData()

size_t LEFormat::SegmentPage::ReadData ( size_t  bytes, offset_t  offset, void *  buffer  ) const

overridevirtual

Attempts to fill a buffer with data.

Parameters

bytes	The (maximum) number of bytes to place in buffer
offset	The offset in the image to start reading the data
buffer	A byte buffer

Returns

Actual number of bytes copied into buffer

Implements Linker::Image.

WriteFile()

offset_t LEFormat::SegmentPage::WriteFile ( const std::shared_ptr< Linker::Writer > &  wr, offset_t  count, offset_t  offset = 0  ) const

overridevirtual

Writes data of non-zero filled sections.

Reimplemented from Linker::Image.

---

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

• src/format/leexe.h
• src/format/leexe.cc