Struct SourceMap 

pub struct SourceMap<'a> { /* private fields */ }

Maps virtual byte offsets to source files.

SourceMap places all source files into a virtual byte address space, enabling Span values from different files to coexist without modification. Files are separated by 1-byte gaps to prevent spans from accidentally straddling file boundaries.

Example

# use orrery_parser::source_map::SourceMap;
let mut map = SourceMap::new();

let base = map.add_file("main.orr", "diagram component;\nbox: Rectangle;", None);

let file = map.lookup_file(base).unwrap();
assert_eq!(file.name(), "main.orr");

Implementations

impl<'a> SourceMap<'a>

pub fn new() -> Self

Create a new, empty source map.

pub fn add_file( &mut self, name: impl Into<String>, source: &'a str, imported_at: Option<Span>, ) -> usize

Registers a source file in the virtual address space.

The file is placed at the next available offset, separated from the previous file by a 1-byte gap.

Arguments

• name - Human-readable name for the file (typically its path).
• source - The full source text.
• imported_at - The span of the import declaration that triggered loading this file, or None for the root file.

Returns

The base_offset at which this file starts in the virtual address space.

pub fn lookup_file(&self, offset: usize) -> Option<&SourceFile<'a>>

Looks up the source file containing the given virtual offset.

Uses binary search for O(log n) performance.

Arguments

• offset - A byte offset in the virtual address space.

Returns

The SourceFile containing offset, or None if the offset falls in a gap between files or is out of range.

pub fn lookup_file_by_span(&self, span: Span) -> Option<&SourceFile<'a>>

Looks up the source file containing the given Span.

This verifies that the entire span (not just its start offset) falls within a single file.

Arguments

• span - A Span in the virtual address space.

Returns

The SourceFile containing the full span, or None if the span crosses a file boundary, falls in a gap, or is out of range.

pub fn source_slice(&self, span: Span) -> Option<&str>

Extracts the source text corresponding to a span.

Arguments

• span - A Span in the virtual address space.

Returns

The source text slice, or None if the span crosses a file boundary, falls in a gap, or is out of range.

pub fn file_count(&self) -> usize

Returns the number of registered source files.

pub fn files(&self) -> &[SourceFile<'a>]

Returns all registered source files.

Trait Implementations

impl<'a> Debug for SourceMap<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for SourceMap<'a>

fn default() -> SourceMap<'a>

Returns the “default value” for a type.