Module swc_common::source_map
source · [−]Expand description
The SourceMap tracks all the source code used within a single crate, mapping
from integer byte positions to the original source code location. Each bit
of source parsed during crate parsing (typically files, in-memory strings,
or various bits of macro expansion) cover a continuous range of bytes in the
SourceMap and are represented by SourceFiles. Byte positions are stored in
spans and used pervasively in the compiler. They are absolute positions
within the SourceMap, which upon request can be converted to line and column
information, source code snippets, etc.
Modules
Machinery for hygienic macros, inspired by the
MTWT[1] paper.Structs
A byte offset. Keep this small (currently 32-bits), as AST contains
a lot of them.
Stores the state of the last conversion between BytePos and CharPos.
A character offset. Because of multibyte utf8 characters, a byte offset
is not equivalent to a character offset. The SourceMap will convert BytePos
values to CharPos values as necessary.
Note: This struct intentionally does not implement rkyv’s archieve
to avoid redundant data copy (https://github.com/swc-project/swc/issues/5471)
source_map_proxy constructs plugin-side Loc instead with shared SourceFile
instance.
Used to create a
.map file.A source code location used for error reporting
Note: This struct intentionally does not implement rkyv’s archieve
to avoid redundant data copy (https://github.com/swc-project/swc/issues/5471)
source_map_proxy constructs plugin-side Loc instead with shared SourceFile
instance.
A source code location used as the result of
lookup_char_pos_adjA mark is a unique id associated with a macro expansion.
Identifies an offset of a multi-byte character in a SourceFile
A collection of spans. Spans have two orthogonal attributes:
A struct to exchange
FileLines with omitting SourceFile as needed.
This is internal struct between plugins to the host, not a public interface.A struct to exchange
Loc with omitting SourceFile as needed.
This is internal struct between plugins to the host, not a public interface.A FileLoader that uses std::fs to load real files.
A single source in the SourceMap.
The interner for spans.
Spans represent a region of code, used for error reporting. Positions in
spans are absolute positions from the beginning of the
source_map, not
positions relative to SourceFiles. Methods on the SourceMap can be used
to relate spans back to the original source.
You must be careful if the span crosses more than one file - you will not be
able to use many of the functions on spans in source_map and you cannot
assume that the length of the span = hi - lo; there may be space in the
BytePos range between files.A SyntaxContext represents a chain of macro expansions (represented by
marks).
Enums
Identifies an offset of a non-narrow character in a SourceFile
Constants
Dummy span, both position and length are zero, syntax context is zero as
well.
Statics
Storage for span hygiene data.