O65::O65Format Class Reference

Output format for the 6502 assembler xa. More...

#include <o65.h>

Inheritance diagram for O65::O65Format:

Classes
class	Module
	A object file typically contains a single module. More...

Public Member Functions
offset_t	GetModuleCount ()
std::unique_ptr< O65Format::Module > &	GetModule (offset_t index)
std::unique_ptr< O65Format::Module > &	AddModule ()
void	Clear () override
	Resets all fields to their default values, deallocate memory.
void	ReadFile (Linker::Reader &rd) override
	Loads file into memory.
void	WriteFile (Linker::Writer &wr) override
	Stores data in memory to file.
void	ProduceModule (Linker::Module &module, Linker::Reader &rd) override
	Reads a file and loads the information into a module object.
Public Member Functions inherited from Linker::InputFormat
virtual void	SetupOptions (std::shared_ptr< OutputFormat > format)
	Initializes the reader for linking purposes.
virtual bool	FormatProvidesSegmentation () const
	Whether the format enables multiple x86 segments.
virtual bool	FormatRequiresDataStreamFix () const
	Whether the generated file might contain bugs that require fixing.
virtual bool	FormatProvidesResources () const
	Whether the format supports resources.
virtual bool	FormatProvidesLibraries () const
	Whether the format enables importing/exporting libraries.
Public Member Functions inherited from Linker::Format
	Format (offset_t file_offset=0)
virtual void	Dump (Dumper::Dumper &dump)
	Display file contents in a nice manner.
Public Member Functions inherited from Linker::LinkerManager
void	ClearLinkerManager ()
void	SetLinkScript (std::string script_file, std::map< std::string, std::string > &options)
	Sets up the linker script and linker parameters.
bool	SetLinkerParameter (std::map< std::string, std::string > &options, std::string key)
	Sets a single linker parameter, if inside options.
bool	SetLinkerParameter (std::map< std::string, std::string > &options, std::string key, std::string variable)
	Sets a single linker parameter, if inside options.
std::unique_ptr< Script::List >	GetScript (Linker::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	OnNewSegment (std::shared_ptr< Segment > segment)
	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::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)

Protected Attributes
std::vector< std::unique_ptr< Module > >	modules
Protected Attributes inherited from Linker::LinkerManager
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

Additional Inherited Members
Public Attributes inherited from Linker::Format
offset_t	file_offset
Public Attributes inherited from Linker::LinkerManager
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.

Detailed Description

Output format for the 6502 assembler xa.

Documented here: http://www.6502.org/users/andre/o65/fileformat.html

Member Function Documentation

Clear()

void O65Format::Clear ( )

overridevirtual

Resets all fields to their default values, deallocate memory.

Reimplemented from Linker::Format.

ProduceModule()

void O65Format::ProduceModule ( Linker::Module & module, Linker::Reader & rd )

overridevirtual

Reads a file and loads the information into a module object.

Implements Linker::InputFormat.

ReadFile()

void O65Format::ReadFile ( Linker::Reader & in )

overridevirtual

Loads file into memory.

Implements Linker::Format.

WriteFile()

void O65Format::WriteFile ( Linker::Writer & out )

overridevirtual

Stores data in memory to file.

Implements Linker::Format.

---

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

• src/format/o65.h
• src/format/o65.cc