Apple::ResourceFork Class Reference

A Macintosh resource fork. More...

#include <macos.h>

Inheritance diagram for Apple::ResourceFork:

Classes
class	CodeResource
class	GenericResource
class	JumpTableCodeResource
class	Resource
struct	ResourceReference
struct	ResourceType

Public Types
enum	memory_model_t { MODEL_DEFAULT , MODEL_TINY }

Public Member Functions
bool	FormatSupportsResources () const override
	Whether the format supports resources.
void	SetOptions (std::map< std::string, std::string > &options) override
	Passes command line parameters as settings over to format object.
std::vector< Linker::OptionDescription< void > >	GetMemoryModelNames () override
	Returns a list of the supported memory models, used for documentation.
void	SetModel (std::string model) override
	Sets the way memory is organized, typically modifying a built-in script.
void	AddResource (std::shared_ptr< Resource > resource)
void	OnNewSegment (std::shared_ptr< Linker::Segment > segment) override
	Callback function when allocating a new segment When the linker script runs, it creates segments consecutively. Overriding this method permits the output format to handle the allocated segment.
std::unique_ptr< Script::List >	GetScript (Linker::Module &module)
void	Link (Linker::Module &module)
void	ProcessModule (Linker::Module &module) override
void	CalculateValues () override
offset_t	ImageSize () const override
	Retrieves size of stored data.
void	ReadFile (Linker::Reader &rd) override
	Loads file into memory.
offset_t	WriteFile (Linker::Writer &wr) const override
	Stores data in memory to file.
void	Dump (Dumper::Dumper &dump) const override
	Display file contents in a nice manner.
void	GenerateFile (std::string filename, Linker::Module &module) override
	The main function that handles processing, calculating and generating the final image.
std::string	GetDefaultExtension (Linker::Module &module) const override
	Provides a default filename for the output file.
Public Member Functions inherited from Apple::AppleSingleDouble::Entry
void	DumpEntry (Dumper::Dumper &dump, unsigned index) const
Public Member Functions inherited from Linker::Format
	Format (offset_t file_offset=0)
virtual void	Clear ()
	Resets all fields to their default values, deallocate memory.
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 Member Functions inherited from Linker::SegmentManager
void	ClearSegmentManager ()
void	SetLinkScript (std::string script_file, std::map< std::string, std::string > &options) override
	Sets up the linker script and linker parameters.
std::unique_ptr< Script::List >	GetScript (Module &module)
	Compiles the linker script into an internal format.
offset_t	GetCurrentAddress () const
	Retrieves current address pointer.
void	SetCurrentAddress (offset_t address)
	Moves the current address pointer further, and if the current segment already contains data, fill it up to the point.
void	AlignCurrentAddress (offset_t align)
	Aligns current address to alignment, using SetCurrentAddress.
void	SetLatestBase (offset_t address)
	Sets the base of the current section (the value from which offsets are counted from)
void	FinishCurrentSegment ()
	Closes the current segment, sets current_segment to null.
std::shared_ptr< Segment >	AppendSegment (std::string name)
	Terminates the current segment (if there is one), creates a new segment and attaches it to the image.
std::shared_ptr< Segment >	FetchSegment (std::string name)
	Attempts to fetch a segment, returns null if not found.
void	AppendSection (std::shared_ptr< Section > section)
	Adds a new section to the current segment, sets the base to the same as the segment.
void	ProcessScript (std::unique_ptr< Script::List > &directives, Module &module)
	Executes a parsed linker script on a module and collects segments The function OnNewSegment can be defined to handle each newly allocated segment.
void	ProcessAction (std::unique_ptr< Script::Node > &action, Module &module)
void	PostProcessAction (std::unique_ptr< Script::Node > &action, Module &module)
void	ProcessCommand (std::unique_ptr< Script::Node > &command, Module &module)
bool	CheckPredicate (std::unique_ptr< Script::Node > &predicate, std::shared_ptr< Section > section, Module &module)
offset_t	EvaluateExpression (std::unique_ptr< Script::Node > &expression, Module &module)
Public Member Functions inherited from Linker::OutputFormat
virtual bool	AddSupplementaryOutputFormat (std::string subformat)
	If the output format actually drives multiple output formats (resource file, apple double, etc.), specify multiple types, return false if unknown.
virtual std::vector< OptionDescription< void > * >	GetLinkerScriptParameterNames ()
	Returns a list of the parameters used in the linker scripts, used for documentation.
virtual std::vector< OptionDescription< void > >	GetSpecialSymbolNames ()
	Returns a list of special symbol names recognized by the format, used for documentation.
virtual std::shared_ptr< OptionCollector >	GetOptions ()
	Returns object containing a sequence of option fields provided with the -S command line flag.
std::optional< std::string >	FetchOption (std::map< std::string, std::string > &options, std::string name)
	Convenience method to look up option by name.
std::string	FetchOption (std::map< std::string, std::string > &options, std::string name, std::string default_value)
	Convenience method to look up option by name, returning default value if name is missing.
std::optional< offset_t >	FetchIntegerOption (std::map< std::string, std::string > &options, std::string name)
	Convenience method to look up option by name and convert it to integer.
virtual std::string	GetDefaultExtension (Module &module, std::string filename) const
	Appends a default extension to the filename.
virtual bool	FormatSupportsSegmentation () const
	Whether the format supports multiple segments.
virtual bool	FormatIs16bit () const
	Whether the format is 16-bit or not.
virtual bool	FormatIsProtectedMode () const
	Whether the format is in protected mode or not (x86 only)
virtual bool	FormatIsLinear () const
	Whether the address space is linear or segmented.
virtual bool	FormatSupportsLibraries () const
	Whether the format supports libraries.
virtual unsigned	FormatAdditionalSectionFlags (std::string section_name) const

Static Public Member Functions
static std::shared_ptr< Resource >	ReadResource (Linker::Reader &rd, const ResourceType &type, const ResourceReference &reference)
Static Public Member Functions inherited from Apple::AppleSingleDouble::Entry
static std::shared_ptr< Entry >	ReadEntry (Linker::Reader &rd, hfs_type home_file_system)

Public Attributes
memory_model_t	memory_model = MODEL_DEFAULT
uint16_t	attributes = 0
std::vector< ResourceType >	resource_types
	A list of all resource types, as stored in the file.
std::vector< std::string >	resource_names
	A list of all resource names, as stored in the file.
std::map< uint32_t, std::map< uint16_t, std::shared_ptr< Resource > > >	resources
	A convenient collection of resources.
uint32_t	data_offset = 0
uint32_t	data_length = 0
uint32_t	map_offset = 0
uint32_t	map_length = 0
uint16_t	resource_type_list_offset = 28
uint16_t	name_list_offset = 0
std::shared_ptr< JumpTableCodeResource >	jump_table
std::vector< std::shared_ptr< CodeResource > >	codes
std::map< std::shared_ptr< Linker::Segment >, std::shared_ptr< CodeResource > >	segments
std::shared_ptr< Linker::Segment >	a5world
Public Attributes inherited from Apple::AppleSingleDouble::Entry
const uint32_t	id
offset_t	file_offset = 0
offset_t	image_size = 0
Public Attributes inherited from Linker::Format
offset_t	file_offset
Public Attributes inherited from Linker::SegmentManager
offset_t	current_base = 0
	The base address of the current section.
std::vector< std::shared_ptr< Segment > >	segment_vector
	Ordered sequence of segments.
std::map< std::string, std::shared_ptr< Segment > >	segment_map
	Map of segments from their names.
std::shared_ptr< Segment >	current_segment
	Currently processed segment.
std::map< std::string, Location >	linker_parameters
	Parameters that permit customizing the linker script.
std::string	linker_script
	Contents of the linker script.

Static Public Attributes
static std::vector< Linker::OptionDescription< void > >	MemoryModelNames

Additional Inherited Members
Protected Member Functions inherited from Apple::AppleSingleDouble::Entry
	Entry (uint32_t id)
Protected Attributes inherited from Linker::SegmentManager
offset_t	current_address = 0
	Holds the current address value when there is no current_segment.
bool	current_is_template = false
bool	current_is_template_head = false
offset_t	template_counter = 0
std::string	current_template_name

Detailed Description

A Macintosh resource fork.

Macintosh classic applications are stored as CODE resources inside a file's resource fork. When generating a binary image, the resource fork is usually bundled up in an AppleSingle or AppleDouble file.

This format has been obsoleted in favor of the PEF format, used on PowerPC based Macintosh computers.

Member Function Documentation

CalculateValues()

void ResourceFork::CalculateValues ( )

overridevirtual

Reimplemented from Apple::AppleSingleDouble::Entry.

Dump()

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

overridevirtual

Display file contents in a nice manner.

Implements Apple::AppleSingleDouble::Entry.

FormatSupportsResources()

bool Apple::ResourceFork::FormatSupportsResources ( ) const

inlineoverridevirtual

Whether the format supports resources.

Formats such as NE, LE/LX, PE and the Macintosh classic support including resources in the final binary. To simplify writing resources, the ELF parser permits incorporating them directly in the binary image as $$RSRC$_<type>$<id>.

Reimplemented from Linker::OutputFormat.

GenerateFile()

void ResourceFork::GenerateFile ( std::string filename, Linker::Module & module )

overridevirtual

The main function that handles processing, calculating and generating the final image.

Reimplemented from Linker::OutputFormat.

GetDefaultExtension()

std::string ResourceFork::GetDefaultExtension ( Linker::Module & module ) const

overridevirtual

Provides a default filename for the output file.

Typically a.out or some other extension, such as a.exe.

Reimplemented from Linker::OutputFormat.

GetMemoryModelNames()

std::vector< Linker::OptionDescription< void > > ResourceFork::GetMemoryModelNames ( )

overridevirtual

Returns a list of the supported memory models, used for documentation.

Reimplemented from Linker::OutputFormat.

ImageSize()

offset_t ResourceFork::ImageSize ( ) const

overridevirtual

Retrieves size of stored data.

Implements Apple::AppleSingleDouble::Entry.

OnNewSegment()

void ResourceFork::OnNewSegment ( std::shared_ptr< Linker::Segment > segment )

overridevirtual

Callback function when allocating a new segment When the linker script runs, it creates segments consecutively. Overriding this method permits the output format to handle the allocated segment.

Reimplemented from Linker::SegmentManager.

ProcessModule()

void ResourceFork::ProcessModule ( Linker::Module & module )

overridevirtual

Reimplemented from Apple::AppleSingleDouble::Entry.

ReadFile()

void ResourceFork::ReadFile ( Linker::Reader & rd )

overridevirtual

Loads file into memory.

Implements Apple::AppleSingleDouble::Entry.

SetModel()

void ResourceFork::SetModel ( std::string model )

overridevirtual

Sets the way memory is organized, typically modifying a built-in script.

Reimplemented from Linker::OutputFormat.

SetOptions()

void ResourceFork::SetOptions ( std::map< std::string, std::string > & options )

overridevirtual

Passes command line parameters as settings over to format object.

Reimplemented from Linker::OutputFormat.

WriteFile()

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

overridevirtual

Stores data in memory to file.

Implements Apple::AppleSingleDouble::Entry.

Member Data Documentation

MemoryModelNames

std::vector< Linker::OptionDescription< void > > ResourceFork::MemoryModelNames

static

Initial value:

=
{
    Linker::OptionDescription<void>("default", "Normal model, symbols in zero-filled sectioned must be accessed as A5 relative addresses (\"A5 world\")"),
    Linker::OptionDescription<void>("tiny", "Tiny model, symbols in zero-filled sections are placed in the CODE segment"),
}

---

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

• src/format/macos.h
• src/format/macos.cc