Struct swc_common::source_map::SourceMap

source ·
pub struct SourceMap { /* private fields */ }
Expand description

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§

source§

impl SourceMap

source

pub fn new(path_mapping: FilePathMapping) -> SourceMap

source

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

source

pub fn path_mapping(&self) -> &FilePathMapping

source

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

source

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

source

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

source

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

source

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

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

source

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

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

src should not have UTF8 BOM

source

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

source

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

source

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

Lookup source information about a BytePos

source

pub fn try_lookup_char_pos( &self, pos: BytePos, ) -> Result<Loc, SourceMapLookupError>

Lookup source information about a BytePos

source

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.

source

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

source

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
source

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

source

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

source

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

source

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

source

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

source

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.

source

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

source

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

source

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

Return the source snippet as String before the given Span

source

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

source

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

Return the source snippet as String after the given Span

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

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

source

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

source

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

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

source

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

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

source

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

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

source

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

source

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

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

source

pub fn try_lookup_byte_offset( &self, bpos: BytePos, ) -> Result<SourceFileAndBytePos, SourceMapLookupError>

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

source

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.

source

pub fn count_lines(&self) -> usize

source

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

source

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.

source

pub fn build_source_map(&self, mappings: &[(BytePos, LineCol)]) -> SourceMap

Available on crate feature sourcemap only.
source

pub fn build_source_map_from( &self, mappings: &[(BytePos, LineCol)], orig: Option<SourceMap>, ) -> SourceMap

Available on crate feature sourcemap only.

Creates a .map file.

source

pub fn build_source_map_with_config( &self, mappings: &[(BytePos, LineCol)], orig: Option<SourceMap>, config: impl SourceMapGenConfig, ) -> SourceMap

Available on crate feature sourcemap only.

Trait Implementations§

source§

impl Default for SourceMap

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl SourceMapper for SourceMap

source§

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

Return the source snippet as String corresponding to the given Span

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more