Struct swc_common::source_map::SourceMap

pub struct SourceMap { /* private fields */ }

The interner for spans.

As most spans are simply stored, we store them as interned form.

• Each ast node only stores pointer to actual data (BytePos).
• The pointers (BytePos) can be converted to file name, line and column using this struct.

Note

This struct should be shared. swc_common uses crate::sync::Lrc, which is std::rc::Rc or std::sync::Arc, depending on the compile option, for this purpose.

Note for bundler authors

If you are bundling modules, you should share this struct while parsing modules. Otherwise, you have to implement a code generator which accepts multiple SourceMap.

Implementations

impl SourceMap

pub fn new(path_mapping: FilePathMapping) -> SourceMap

pub fn with_file_loader(
    file_loader: Box<dyn FileLoader + Sync + Send>,
    path_mapping: FilePathMapping
) -> SourceMap

pub fn path_mapping(&self) -> &FilePathMapping

pub fn file_exists(&self, path: &Path) -> bool

pub fn load_file(&self, path: &Path) -> Result<Lrc<SourceFile>>

pub fn files(&self) -> MappedLockGuard<'_, Vec<Lrc<SourceFile>>>

pub fn source_file_by_stable_id(
    &self,
    stable_id: StableSourceFileId
) -> Option<Lrc<SourceFile>>

pub fn new_source_file(&self, filename: FileName, src: String) -> Lrc<SourceFile>

Creates a new source_file. This does not ensure that only one SourceFile exists per file name.

pub fn mk_substr_filename(&self, sp: Span) -> String

pub fn doctest_offset_line(&self, orig: usize) -> usize

pub fn lookup_char_pos(&self, pos: BytePos) -> Loc

Lookup source information about a BytePos

pub fn lookup_line(
    &self,
    pos: BytePos
) -> Result<SourceFileAndLine, Lrc<SourceFile>>

If the relevant source_file is empty, we don’t return a line number.

pub fn lookup_char_pos_adj(&self, pos: BytePos) -> LocWithOpt

pub fn merge_spans(&self, sp_lhs: Span, sp_rhs: Span) -> Option<Span>

Returns Some(span), a union of the lhs and rhs span. The lhs must precede the rhs. If there are gaps between lhs and rhs, the resulting union will cross these gaps. For this to work, the spans have to be:

• the ctxt of both spans much match
• the lhs span needs to end on the same line the rhs span begins
• the lhs span must start at or before the rhs span

pub fn span_to_string(&self, sp: Span) -> String

pub fn span_to_filename(&self, sp: Span) -> FileName

pub fn span_to_unmapped_path(&self, sp: Span) -> FileName

pub fn is_multiline(&self, sp: Span) -> bool

pub fn span_to_lines(&self, sp: Span) -> FileLinesResult

pub fn with_snippet_of_span<F, Ret>(
    &self,
    sp: Span,
    op: F
) -> Result<Ret, Box<SpanSnippetError>>where
    F: FnOnce(&str) -> Ret,

Calls op with the source code located at sp.

pub fn span_to_margin(&self, sp: Span) -> Option<usize>

pub fn with_span_to_prev_source<F, Ret>(
    &self,
    sp: Span,
    op: F
) -> Result<Ret, Box<SpanSnippetError>>where
    F: FnOnce(&str) -> Ret,

Calls the given closure with the source snippet before the given Span

pub fn span_to_prev_source(
    &self,
    sp: Span
) -> Result<String, Box<SpanSnippetError>>

Return the source snippet as String before the given Span

pub fn with_span_to_next_source<F, Ret>(
    &self,
    sp: Span,
    op: F
) -> Result<Ret, Box<SpanSnippetError>>where
    F: FnOnce(&str) -> Ret,

Calls the given closure with the source snippet after the given Span

pub fn span_to_next_source(
    &self,
    sp: Span
) -> Result<String, Box<SpanSnippetError>>

Return the source snippet as String after the given Span

pub fn span_extend_to_prev_char(&self, sp: Span, c: char) -> Span

Extend the given Span to just after the previous occurrence of c. Return the same span if no character could be found or if an error occurred while retrieving the code snippet.

pub fn span_extend_to_prev_str(
    &self,
    sp: Span,
    pat: &str,
    accept_newlines: bool
) -> Span

Extend the given Span to just after the previous occurrence of pat when surrounded by whitespace. Return the same span if no character could be found or if an error occurred while retrieving the code snippet.

pub fn span_extend_to_next_char(&self, sp: Span, c: char) -> Span

Extend the given Span to just after the next occurrence of c. Return the same span if no character could be found or if an error occurred while retrieving the code snippet.

pub fn span_extend_to_next_str(
    &self,
    sp: Span,
    pat: &str,
    accept_newlines: bool
) -> Span

Extend the given Span to just after the next occurrence of pat when surrounded by whitespace. Return the same span if no character could be found or if an error occurred while retrieving the code snippet.

pub fn span_until_char(&self, sp: Span, c: char) -> Span

Given a Span, try to get a shorter span ending before the first occurrence of c char

Notes

This method returns a dummy span for a dummy span.

pub fn span_through_char(&self, sp: Span, c: char) -> Span

Given a Span, try to get a shorter span ending just after the first occurrence of char c.

Notes

This method returns a dummy span for a dummy span.

pub fn span_until_non_whitespace(&self, sp: Span) -> Span

Given a Span, get a new Span covering the first token and all its trailing whitespace or the original Span.

If sp points to "let mut x", then a span pointing at "let " will be returned.

pub fn span_until_whitespace(&self, sp: Span) -> Span

Given a Span, get a new Span covering the first token without its trailing whitespace or the original Span in case of error.

If sp points to "let mut x", then a span pointing at "let" will be returned.

pub fn span_take_while<P>(&self, sp: Span, predicate: P) -> Spanwhere
    P: for<'r> FnMut(&'r char) -> bool,

Given a Span, get a shorter one until predicate yields false.

pub fn def_span(&self, sp: Span) -> Span

pub fn start_point(&self, sp: Span) -> Span

Returns a new span representing just the start-point of this span

pub fn end_point(&self, sp: Span) -> Span

Returns a new span representing just the end-point of this span

pub fn next_point(&self, sp: Span) -> Span

Returns a new span representing the next character after the end-point of this span

pub fn get_source_file(&self, filename: &FileName) -> Option<Lrc<SourceFile>>

pub fn lookup_byte_offset(&self, bpos: BytePos) -> SourceFileAndBytePos

For a global BytePos compute the local offset within the containing SourceFile

pub fn span_to_char_offset(&self, file: &SourceFile, span: Span) -> (u32, u32)

Converts a span of absolute BytePos to a CharPos relative to the source_file.

pub fn count_lines(&self) -> usize

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

pub fn generate_local_type_param_snippet(
    &self,
    span: Span
) -> Option<(Span, String)>

Take the span of a type parameter in a function signature and try to generate a span for the function name (with generics) and a new snippet for this span with the pointed type parameter as a new local type parameter.

For instance:

// Given span
fn my_function(param: T)
//                    ^ Original span

// Result
fn my_function(param: T)
// ^^^^^^^^^^^ Generated span with snippet `my_function<T>`

Attention: The method used is very fragile since it essentially duplicates the work of the parser. If you need to use this function or something similar, please consider updating the source_map functions and this function to something more robust.

Trait Implementations

impl Default for SourceMap

fn default() -> Self

Returns the “default value” for a type.

impl SourceMapper for SourceMap

fn span_to_snippet(&self, sp: Span) -> Result<String, Box<SpanSnippetError>>

Return the source snippet as String corresponding to the given Span

fn lookup_char_pos(&self, pos: BytePos) -> Loc

fn span_to_lines(&self, sp: Span) -> FileLinesResult

fn span_to_string(&self, sp: Span) -> String

fn span_to_filename(&self, sp: Span) -> FileName

fn merge_spans(&self, sp_lhs: Span, sp_rhs: Span) -> Option<Span>

fn call_span_if_macro(&self, sp: Span) -> Span

fn doctest_offset_line(&self, line: usize) -> usize