Module source_map
Available on crate feature
__common only.Expand description
The SourceMap tracks all the source code used within a single crate.
The mapping from integer byte positions to the original source code location
is stored in spans.
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§
- An archived
BytePos - An archived
CharPos - An archived
DistinctSources - An archived
FilePos - An archived
LineInfo - An archived
MalformedSourceMapPositions - An archived
MultiByteChar - An archived
MultiSpan - An archived
PartialFileLines - An archived
PartialLoc - An archived
PrimarySpanLabel - An archived
SourceFile - An archived
SourceFileAnalysis - An archived
SourceFileAndBytePos - An archived
Span - A byte offset. Keep this small (currently 32-bits), as AST contains a lot of them.
- The resolver for an archived
BytePos - 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.
- The resolver for an archived
CharPos - The resolver for an archived
DistinctSources - A wrapper that attempts to convert a type to and from UTF-8.
- A wrapper that attempts to convert a Url to and from String.
- A struct to represent lines of a source file.
- The resolver for an archived
FilePos - Used to create a
.mapfile. - The resolver for an archived
LineInfo - A source code location used for error reporting.
- A source code location used as the result of
lookup_char_pos_adj - The resolver for an archived
MalformedSourceMapPositions - A mark is a unique id associated with a macro expansion.
- Identifies an offset of a multi-byte character in a SourceFile
- The resolver for an archived
MultiByteChar - A collection of spans. Spans have two orthogonal attributes:
- The resolver for an archived
MultiSpan - A struct to exchange
FileLineswith omitting SourceFile as needed. This is internal struct between plugins to the host, not a public interface. - The resolver for an archived
PartialFileLines - A struct to exchange
Locwith omitting SourceFile as needed. This is internal struct between plugins to the host, not a public interface. - The resolver for an archived
PartialLoc - The resolver for an archived
PrimarySpanLabel - A FileLoader that uses std::fs to load real files.
- A single source in the SourceMap.
- The resolver for an archived
SourceFileAnalysis - The resolver for an archived
SourceFileAndBytePos - The resolver for an archived
SourceFile - The interner for spans.
- Spans represent a region of code, used for error reporting.
- The resolver for an archived
Span - A SyntaxContext represents a chain of macro expansions (represented by marks).
Enums§
- An archived
FileName - An archived
NonNarrowChar - An archived
SourceMapLookupError - An archived
SpanLinesError - An archived
SpanSnippetError - The resolver for an archived
FileName - Identifies an offset of a non-narrow character in a SourceFile
- The resolver for an archived
NonNarrowChar - An error type for looking up source maps.
- The resolver for an archived
SourceMapLookupError - The resolver for an archived
SpanLinesError - The resolver for an archived
SpanSnippetError
Constants§
- Dummy span, both position and length are zero, syntax context is zero as well.
- Used for some special cases. e.g. mark the generated AST.
- PURE span, will emit
/* #__PURE__ */comment in codegen.
Statics§
- Storage for span hygiene data.
Traits§
- An abstraction over the fs operations used by the Parser.