[−][src]Module syntax::source_map
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.
Re-exports
pub use self::ExpnFormat::*; |
Modules
edition | |
hygiene |
Machinery for hygienic macros, inspired by the |
symbol |
An "interner" is a data structure that associates values with usize tags and allows bidirectional lookup; i.e. given a value, one can easily find the type, and vice versa. |
Structs
BytePos |
A byte offset. Keep this small (currently 32-bits), as AST contains a lot of them. |
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. |
DistinctSources | |
ExpnInfo |
Extra information for tracking spans of macro and syntax sugar expansion |
FileLines | |
FilePathMapping | |
Globals | |
LineInfo | |
Loc |
A source code location used for error reporting |
LocWithOpt |
A source code location used as the result of lookup_char_pos_adj |
MacroBacktrace | |
MalformedCodemapPositions | |
MultiByteChar |
Identifies an offset of a multi-byte character in a SourceFile |
MultiSpan |
A collection of spans. Spans have two orthogonal attributes: |
RealFileLoader |
A FileLoader that uses std::fs to load real files. |
SourceFile |
A single source in the SourceMap. |
SourceFileAndBytePos | |
SourceFileAndLine | |
SourceMap | |
Span |
A compressed span.
Contains either fields of |
SpanData |
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. |
SpanLabel | |
Spanned | |
StableFilemapId |
Enums
ExpnFormat |
The source of expansion. |
ExternalSource |
The state of the lazy external source loading mechanism of a SourceFile. |
FileName |
Differentiates between real files and common virtual files |
NonNarrowChar |
Identifies an offset of a non-narrow character in a SourceFile |
SpanLinesError | |
SpanSnippetError |
Constants
DUMMY_SP |
Dummy span, both position and length are zero, syntax context is zero as well. This span is kept inline and encoded with format 0. |
NO_EXPANSION | |
SPAN_DEBUG |
Statics
GLOBALS |
Traits
FileLoader |
An abstraction over the fs operations used by the Parser. |
Pos |
Functions
dummy_spanned | |
original_sp |
Return the span itself if it doesn't come from a macro expansion,
otherwise return the call site span up to the |
respan |
Type Definitions
FileLinesResult |