Struct swc_common::source_map::SourceMap [−][src]
pub struct SourceMap { /* fields omitted */ }
Expand description
The interner for spans.
As most spans are simply stored, we store them as interend 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
pub fn with_file_loader(
file_loader: Box<dyn FileLoader + Sync + Send>,
path_mapping: FilePathMapping
) -> SourceMap
pub fn source_file_by_stable_id(
&self,
stable_id: StableSourceFileId
) -> Option<Lrc<SourceFile>>
Creates a new source_file. This does not ensure that only one SourceFile exists per file name.
Lookup source information about a BytePos
If the relevant source_file is empty, we don’t return a line number.
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
Return the source snippet as String
corresponding to the given Span
pub fn with_span_to_prev_source<F, Ret>(
&self,
sp: Span,
op: F
) -> Result<Ret, SpanSnippetError> where
F: FnOnce(&str) -> Ret,
pub fn with_span_to_prev_source<F, Ret>(
&self,
sp: Span,
op: F
) -> Result<Ret, SpanSnippetError> where
F: FnOnce(&str) -> Ret,
Calls the given closure with the source snippet before the given Span
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, SpanSnippetError> where
F: FnOnce(&str) -> Ret,
pub fn with_span_to_next_source<F, Ret>(
&self,
sp: Span,
op: F
) -> Result<Ret, SpanSnippetError> where
F: FnOnce(&str) -> Ret,
Calls the given closure with the source snippet after the given Span
Return the source snippet as String
after the given 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.
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.
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.
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.
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.
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.
Given a Span
, get a shorter one until predicate
yields false.
Returns a new span representing just the start-point of this span
Returns a new span representing just the end-point of this span
Returns a new span representing the next character after the end-point of this span
For a global BytePos compute the local offset within the containing SourceFile
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
Auto Trait Implementations
impl !RefUnwindSafe for SourceMap
impl !UnwindSafe for SourceMap
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more