Struct syntex_syntax::codemap::CodeMap

pub struct CodeMap {
    pub files: RefCell<Vec<Rc<FileMap>>>,
    // some fields omitted
}

Fields

files: RefCell<Vec<Rc<FileMap>>>

Methods

impl CodeMap

fn new() -> CodeMap

fn with_file_loader(file_loader: Box<FileLoader>) -> CodeMap

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

fn load_file(&self, path: &Path) -> Result<Rc<FileMap>>

fn new_filemap(&self,
               filename: FileName,
               abs_path: Option<FileName>,
               src: String)
               -> Rc<FileMap>

Creates a new filemap without setting its line information. If you don't intend to set the line information yourself, you should use new_filemap_and_lines.

fn new_filemap_and_lines(&self,
                         filename: &str,
                         abs_path: Option<&str>,
                         src: &str)
                         -> Rc<FileMap>

Creates a new filemap and sets its line information.

fn new_imported_filemap(&self,
                        filename: FileName,
                        abs_path: Option<FileName>,
                        source_len: usize,
                        file_local_lines: Vec<BytePos>,
                        file_local_multibyte_chars: Vec<MultiByteChar>)
                        -> Rc<FileMap>

Allocates a new FileMap representing a source file from an external crate. The source code of such an "imported filemap" is not available, but we still know enough to generate accurate debuginfo location information for things inlined from other crates.

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

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

Lookup source information about a BytePos

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

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 expn_id 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

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

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

Returns a formatted string showing the expansion chain of a span

Spans are printed in the following format:

filename:start_line:col: end_line:col snippet Callee: Callee span Callsite: Callsite span

Callees and callsites are printed recursively (if available, otherwise header and span is omitted), expanding into their own callee/callsite spans. Each layer of recursion has an increased indent, and snippets are truncated to at most 50 characters. Finally, recursive calls to the same macro are squashed, with '...' used to represent any number of recursive calls.

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

Return the source span - this is either the supplied span, or the span for the macro callsite that expanded to it.

fn source_callee(&self, sp: Span) -> Option<NameAndSpan>

Return the source callee.

Returns None if the supplied span has no expansion trace, else returns the NameAndSpan for the macro definition corresponding to the source callsite.

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

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

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

fn get_filemap(&self, filename: &str) -> Option<Rc<FileMap>>

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

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

fn bytepos_to_file_charpos(&self, bpos: BytePos) -> CharPos

Converts an absolute BytePos to a CharPos relative to the filemap.

fn lookup_filemap_idx(&self, pos: BytePos) -> usize

fn record_expansion(&self, expn_info: ExpnInfo) -> ExpnId

fn with_expn_info<T, F>(&self, id: ExpnId, f: F) -> T where F: FnOnce(Option<&ExpnInfo>) -> T

fn span_allows_unstable(&self, span: Span) -> bool

Check if a span is "internal" to a macro in which #[unstable] items can be used (that is, a macro marked with #[allow_internal_unstable]).

fn count_lines(&self) -> usize

fn macro_backtrace(&self, span: Span) -> Vec<MacroBacktrace>

Trait Implementations

impl CodeMapper for CodeMap

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

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

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

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

fn macro_backtrace(&self, span: Span) -> Vec<MacroBacktrace>

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