A Macintosh resource fork. More...

#include <macos.h>

Inheritance diagram for Apple::MacintoshResourceFileFormat:

Classes
class	CodeFragmentResource
	Stores a 'cfrg'0 resource, used to store PowerPC and CFM-68K code fragments. More...

class	CodeResource
	Stores as 68K code segment, found in 'CODE' resources. More...

class	GenericResource
	Stores a resource with no specific format, as as sequence of raw bytes. More...

class	JumpTable
	Represents the information stored in a jump table. More...

class	JumpTableCodeResource
	Stores a 68K jump table, found in 'CODE'0 resources. More...

struct	Location
	Convenience structure to handle locations occuring in Macintosh 68K binaries. More...

class	MacintoshOptionCollector

class	Resource
	A single resource in the resource file. More...

class	ResourceInformation
	Interface for the resource manager. More...

class	ResourceIterator

struct	ResourceReference

struct	ResourceType

class	SizeResource
	Stores a 'SIZE'-1 resource, containing information related to program behavior, such as being able to run in 32-bit clean mode. More...

Public Types
enum	memory_model_t { MODEL_DEFAULT , MODEL_TINY }

Public Member Functions
bool	FormatSupportsResources () const override
	Whether the format supports resources.

bool	FormatSupportsEntryTable () const override
	Whether the format supports a structure containing addresses of methods.

std::shared_ptr< Linker::OptionCollector >	GetOptions () override
	Returns object containing a sequence of option fields provided with the -S command line flag.

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)

std::shared_ptr< Resource >	FindResource (const OSType &type, uint16_t id)

ResourceReference *	FindResourceReference (const OSType &type, uint16_t id)

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	ProcessRelocations (Linker::Module &module)

void	AllocateJumpTableEntries (JumpTableCodeResource::JumpTableFormat format)

void	AllocateTransitionVectors (JumpTableCodeResource::JumpTableFormat format)

void	BuildNearModelJumpTable (std::shared_ptr< CodeResource > entry_segment, uint32_t entry_offset)

void	BuildFarModelJumpTable (std::shared_ptr< CodeResource > init_segment, uint32_t init_offset, std::shared_ptr< CodeResource > entry_segment, uint32_t entry_offset)

void	BuildCFM68KJumpTable (std::shared_ptr< CodeResource > init_segment, uint32_t init_offset, std::shared_ptr< CodeResource > entry_segment, uint32_t entry_offset, std::optional< uint32_t > seg_loader_section, uint32_t seg_loader_offset, std::optional< uint32_t > a5_section, uint32_t a5_offset)

void	ProcessModule (Linker::Module &module) override
	Processes the module object and initializes format fields.

void	CalculateValues () override
	Intermediate step between processing module and generating output file to set up headers and management sections It is expected that after a module is processed, additional steps are required to evaluate the final values of the fields.

offset_t	ImageSize () const override
	Retrieves the offset of the byte after the last one belonging to this format from the first one.

void	ReadFile (const std::shared_ptr< Linker::Reader > &rd) override
	Loads file into memory.

offset_t	WriteFile (const std::shared_ptr< 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.

Runtime::ResourceIterable &	Iterate () override

std::shared_ptr< Runtime::ResourceIterator >	BeginIteration () override

std::shared_ptr< Runtime::ResourceIterator >	EndOfIteration () override

std::shared_ptr< Runtime::ResourceIterator >	FindResource (const Runtime::Value &value) override

bool	UpdateResource (std::shared_ptr< Runtime::Resource > resource) override

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.

virtual void	OnCallDirective (Module &module, std::string identifier)
	Callback function for the CALL directive.

std::shared_ptr< Segment >	AppendSegment (std::string name)
	Creates a new segment and attaches it to the image.

void	AppendSegment (std::shared_ptr< Segment > segment)
	Attaches the segment 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.

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	FormatSupportsTransitionVectors () const
	Whether the format supports generating transition vectors.

virtual bool	FormatSupportsLibraries () const
	Whether the format supports libraries.

virtual unsigned	FormatAdditionalSectionFlags (std::string section_name) const

virtual void	AllocateSymbols (Module &module) const
	Instructs the module to allocate any unallocated local symbols.

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.

virtual void	SetFileOffset (offset_t new_offset)
	Attempts to alter the offset to the first byte of the format from the beginning of the file.

Public Member Functions inherited from Linker::Contents
virtual std::shared_ptr< const Image >	AsImage () const
	Retrieves a randomly accessible image.

std::shared_ptr< Image >	AsImage ()
	Retrieves a randomly accessible image.

Public Member Functions inherited from Runtime::ResourceManager
const ResourceIterable &	Iterate () const

std::shared_ptr< const ResourceIterator >	FindResource (const Value &value) const

virtual bool	UpdateResource (std::shared_ptr< Resource > resource)=0

Static Public Member Functions
static std::shared_ptr< Resource >	ReadResource (const std::shared_ptr< Linker::Reader > &rd, const ResourceType &type, const ResourceReference &reference)

static bool	CheckA5Relative (Linker::Relocation &rel)
	Checks if this relocation belongs to an A5-relative addressing mode.

Public Attributes
memory_model_t	memory_model = MODEL_DEFAULT

uint16_t	attributes = 0

bool	use_far_segments = false

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 > >	segment_to_resource_map

std::shared_ptr< Linker::Segment >	a5world

std::shared_ptr< SizeResource >	size_resource = nullptr

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.

Public Attributes inherited from Linker::Format
offset_t	file_offset
	The offset of the first byte used by this format in the file it is stored in.

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

Additional Inherited Members
Protected Member Functions inherited from Runtime::ResourceIterable
std::shared_ptr< const ResourceIterator >	BeginIteration () const

std::shared_ptr< const ResourceIterator >	EndOfIteration () const

ConstIterator	begin () const

ConstIterator	end () const

Iterator	begin ()

Iterator	end ()

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_head = false
	Set during evaluation of `guard` in a `for <guard> { <body> }` statement.

bool	current_is_template = false
	Set during evaluation of `body` in a `for <guard> { <body> }` statement.

offset_t	template_counter = 0
	Counts how many times a `for` statement has been invoked.

bool	condition_failed = false
	Condition to signal end of current `for` statement.

std::string	current_template_name
	Records the name of the currently generating segment for a `for` statement.

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 Enumeration Documentation

◆ memory_model_t

enum Apple::MacintoshResourceFileFormat::memory_model_t

Enumerator
MODEL_DEFAULT	Each non-zero section becomes its own CODE segment, except .code/.text/.data/.rodata becomes its own section.
MODEL_TINY	Create a single CODE segment containing all executable, non-zero filled and zero filled data, as well as .a5world and any resources.

Member Function Documentation

◆ BeginIteration()

std::shared_ptr< Runtime::ResourceIterator > MacintoshResourceFileFormat::BeginIteration ( )

overridevirtual

Implements Runtime::ResourceIterable.

◆ CalculateValues()

void MacintoshResourceFileFormat::CalculateValues ( )

overridevirtual

Intermediate step between processing module and generating output file to set up headers and management sections It is expected that after a module is processed, additional steps are required to evaluate the final values of the fields.

Reimplemented from Linker::OutputFormat.

◆ Dump()

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

overridevirtual

Display file contents in a nice manner.

Reimplemented from Linker::Format.

◆ EndOfIteration()

std::shared_ptr< Runtime::ResourceIterator > MacintoshResourceFileFormat::EndOfIteration ( )

overridevirtual

Implements Runtime::ResourceIterable.

◆ FindResource()

std::shared_ptr< Runtime::ResourceIterator > MacintoshResourceFileFormat::FindResource ( const Runtime::Value & value )

overridevirtual

Implements Runtime::ResourceManager.

◆ FormatSupportsEntryTable()

bool MacintoshResourceFileFormat::FormatSupportsEntryTable ( ) const

overridevirtual

Whether the format supports a structure containing addresses of methods.

Formats such as NE, LE/LX and the Macintosh classic support an ordinal table or jump table that contains the addresses of certain methods.

Reimplemented from Linker::OutputFormat.

◆ FormatSupportsResources()

bool MacintoshResourceFileFormat::FormatSupportsResources ( ) const

overridevirtual

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 MacintoshResourceFileFormat::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 MacintoshResourceFileFormat::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 > > MacintoshResourceFileFormat::GetMemoryModelNames ( )

overridevirtual

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

Reimplemented from Linker::OutputFormat.

◆ GetOptions()

std::shared_ptr< Linker::OptionCollector > MacintoshResourceFileFormat::GetOptions ( )

overridevirtual

Returns object containing a sequence of option fields provided with the -S command line flag.

Reimplemented from Linker::OutputFormat.

◆ ImageSize()

offset_t MacintoshResourceFileFormat::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

Reimplemented from Linker::Format.

◆ Iterate()

Runtime::ResourceIterable & MacintoshResourceFileFormat::Iterate ( )

overridevirtual

Implements Runtime::ResourceManager.

◆ OnNewSegment()

void MacintoshResourceFileFormat::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 MacintoshResourceFileFormat::ProcessModule ( Linker::Module & object )

overridevirtual

Processes the module object and initializes format fields.

Reimplemented from Linker::OutputFormat.

◆ ReadFile()

void MacintoshResourceFileFormat::ReadFile ( const std::shared_ptr< Linker::Reader > & rd )

overridevirtual

Loads file into memory.

Implements Linker::Format.

◆ SetModel()

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

overridevirtual

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

Reimplemented from Linker::OutputFormat.

◆ SetOptions()

void MacintoshResourceFileFormat::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 MacintoshResourceFileFormat::WriteFile ( const std::shared_ptr< Linker::Writer > & wr ) const

overridevirtual

Stores data in memory to file.

Implements Linker::Format.

Member Data Documentation

◆ MemoryModelNames

std::vector< Linker::OptionDescription< void > > MacintoshResourceFileFormat::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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ memory_model_t

Member Function Documentation

◆ BeginIteration()

◆ CalculateValues()

◆ Dump()

◆ EndOfIteration()

◆ FindResource()

◆ FormatSupportsEntryTable()

◆ FormatSupportsResources()

◆ GenerateFile()

◆ GetDefaultExtension()

◆ GetMemoryModelNames()

◆ GetOptions()

◆ ImageSize()

◆ Iterate()

◆ OnNewSegment()

◆ ProcessModule()

◆ ReadFile()

◆ SetModel()

◆ SetOptions()

◆ WriteFile()

Member Data Documentation

◆ MemoryModelNames