Interface to generate files required for the Classic 68K Mac OS runtime. More...

#include <macos.h>

Inheritance diagram for Apple::Classic68KDriver:

Public Member Functions
	Classic68KDriver (target_format_t target=TARGET_DATA_FORK)

	Classic68KDriver (target_format_t target, int produce)

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	SetLinkScript (std::string script_file, std::map< std::string, std::string > &options) override
	Selects a script file to use for linking.

void	GenerateFile (std::string filename, Linker::Module &module) override
	The main function that handles processing, calculating and generating the final image.

void	ReadFile (Linker::Reader &rd) override
	Loads file into memory.

std::string	GetDefaultExtension (Linker::Module &module) const override
	Provides a default filename for the output file.

std::string	GetDefaultExtension (Linker::Module &module, std::string filename) const override
	Appends a default extension to the filename.

Public Member Functions inherited from Apple::MacintoshOutput
	MacintoshOutput (target_format_t target=TARGET_DATA_FORK)

	MacintoshOutput (target_format_t target, int produce)

bool	AddSupplementaryOutputFormat (std::string subformat) override
	If the output format actually drives multiple output formats (resource file, apple double, etc.), specify multiple types, return false if unknown.

void	GenerateFiles (std::string filename, std::shared_ptr< Contents > data_fork, std::shared_ptr< Contents > resource_fork)
	Tasked to create all the requested files.

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.

Public Member Functions inherited from Linker::OutputFormat
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 void	ProcessModule (Module &object)
	Processes the module object and initializes format fields.

virtual void	CalculateValues ()
	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.

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

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.

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::Contents
virtual std::shared_ptr< const Image >	AsImage () const
	Retrieves a randomly accessible image.

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

Protected Member Functions
void	OnContainerCreated () override
	Called after the container is created.

void	OnCalculateValues () override
	Called if there is no container allocated.

void	OnReadFile (Linker::Reader &rd) override
	Called if there is no container allocated.

offset_t	OnWriteFile (Linker::Writer &wr) const override
	Called if there is no container allocated.

void	OnDump (Dumper::Dumper &dump) const override
	Called if there is no container allocated.

Additional Inherited Members
Public Types inherited from Apple::MacintoshOutput
enum	target_format_t { TARGET_NONE , TARGET_DATA_FORK , TARGET_RESOURCE_FORK , TARGET_APPLE_SINGLE , TARGET_APPLE_DOUBLE , TARGET_MAC_BINARY }
	Represents the file type of the main file. More...

enum	produce_format_t { PRODUCE_RESOURCE_FORK = 1 << 0 , PRODUCE_FINDER_INFO = 1 << 1 , PRODUCE_APPLE_DOUBLE = 1 << 2 , PRODUCE_MAC_BINARY = 1 << 3 }
	Represents what additional files should be generated. More...

Public Attributes inherited from Apple::MacintoshOutput
target_format_t	target
	Format of "filename".

produce_format_t	produce
	Bitset of other files to produce.

unsigned	apple_single_double_version = 2

AppleSingleDouble::hfs_type	home_file_system = AppleSingleDouble::HFS_UNDEFINED

MacBinary::version_t	macbinary_version = MacBinary::MACBIN3

MacBinary::version_t	macbinary_minimum_version = MacBinary::MACBIN2

Public Attributes inherited from Linker::Format
offset_t	file_offset

Protected Types inherited from Apple::MacintoshOutput
enum	container_format_t { CONTAINER_NONE , CONTAINER_APPLE_SINGLE , CONTAINER_MAC_BINARY }
	Format of container stored in memory. More...

Protected Attributes inherited from Apple::MacintoshOutput
container_format_t	container = CONTAINER_NONE
	The container type used to store metainformation while processing.

std::shared_ptr< AppleSingleDouble >	apple_single
	Container for all the necessary additional information.

std::shared_ptr< MacBinary >	mac_binary
	Container for MacBinary.

Detailed Description

Interface to generate files required for the Classic 68K Mac OS runtime.

Member Function Documentation

◆ FormatSupportsResources()

bool Classic68KDriver::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.