Struct SourceMap

pub struct SourceMap<T: CompileTarget> {
    pub compiled: T,
    pub source_map: HashMap<u16, Span>,
    /* private fields */
}

Captures line number information produced during the compilation process and produces a mapping from memory locations into source assembly line numbers.

Line numbers for both instructions and symbols are included.

Fields

compiled: T

The actual artifact of the compilation.

source_map: HashMap<u16, Span>

Map from memory locations into source assembly line numbers.

Trait Implementations

impl<T> CompileTarget for SourceMap<T>

where T: CompileTarget, T::Location: Hash + Eq + Clone,

type Location = <T as CompileTarget>::Location

Represents a position in the data structure. This should not change even if new instructions or data is pushed to the data structure. The actual address of this location in the produced memory dump can change.

fn create(symbol_table: SymbolTable) -> Self

Create an empty instance of itself.

fn symbol_table_mut(&mut self) -> &mut SymbolTable

fn set_word(&mut self, loc: &Self::Location, word: i32)

Sets the word in the location addr to value word.

fn push_word( &mut self, span: Option<Span>, word: i32, segment: SegmentType, ) -> Self::Location

Pushes a new word to the data structure. The only requirement for the location of the word is that words pushed with segment type SegmentType::Text need to be in consecutive addresses.

fn set_symbol(&mut self, id: SymbolId, loc: &Self::Location)

Declares a new symbol with label label in location address.

fn get_symbol_mut(&mut self, label: SymbolId) -> &mut SymbolInfo

fn to_address(&self, loc: &Self::Location) -> u16

Translates the location loc into a word offset in the memory dump. The location can change after calls to push_word.

fn finish(self) -> Self

Finalize the compilation. The compiler will not modify the data structure after this.

fn with_capacity(symbol_table: SymbolTable, _size: u16) -> Self

Create an empty instance of itself with reserved capacity for size words of data. This is just a request or a hint, so this doesn’t need to be actually implemented if the data structure doesn’t support this.