RetroLinker
Linker for several 8-bit, 16-bit and 32-bit formats
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Linker::LinkerManager Class Reference

A helper class to collect sections into segments. More...

#include <linker.h>

Inheritance diagram for Linker::LinkerManager:
AOut::AOutFormat Amiga::HunkFormat Apple::OMFFormat Apple::PEFFormat Apple::ResourceFork Binary::GenericBinaryFormat COFF::COFFFormat DOS16M::BWFormat DigitalResearch::CPM68KFormat DigitalResearch::CPM86Format DigitalResearch::CPM8KFormat ELF::ELFFormat Ergo::XPFormat GEOS::GeodeFormat MINIX::MINIXFormat MachO::MachOFormat Microsoft::LEFormat Microsoft::MZFormat Microsoft::NEFormat O65::O65Format PMODE::PMW1Format PharLap::MPFormat PharLap::P3Format X68000::HUFormat Xenix::BOutFormat Xenix::XOutFormat

Public Member Functions

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::ListGetScript (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< SegmentAppendSegment (std::string name)
 Terminates the current segment (if there is one), creates a new segment and attaches it to the image.
 
std::shared_ptr< SegmentFetchSegment (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 Attributes

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< Segmentcurrent_segment
 Currently processed segment.
 
std::map< std::string, Locationlinker_parameters
 Parameters that permit customizing the linker script.
 
std::string linker_script
 Contents of the linker script.
 

Protected Attributes

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 helper class to collect sections into segments.

Member Function Documentation

◆ AppendSegment()

std::shared_ptr< Segment > LinkerManager::AppendSegment ( std::string name)

Terminates the current segment (if there is one), creates a new segment and attaches it to the image.

Parameters
nameThe name of the new segment

◆ OnNewSegment()

void LinkerManager::OnNewSegment ( std::shared_ptr< Segment > segment)
virtual

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 in Binary::PRLFormat, Binary::UZI280Format, AOut::AOutFormat, Binary::GenericBinaryFormat, COFF::COFFFormat, DigitalResearch::CPM68KFormat, X68000::HUFormat, Amiga::HunkFormat, Microsoft::LEFormat, Apple::ResourceFork, MINIX::MINIXFormat, Microsoft::MZFormat, PharLap::MPFormat, and PharLap::P3Format::Flat.

Member Data Documentation

◆ current_base

offset_t Linker::LinkerManager::current_base = 0

The base address of the current section.

By default, sections within a segment are assumed to have the same segment base. This variable stores the segment base, as valid for the currently processed section.


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