src/libsyntax_pos/lib.rs

   1 //! The source positions and related helper functions.
   2 //!
   3 //! ## Note
   4 //!
   5 //! This API is completely unstable and subject to change.
   6
   7 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
   8
   9 #![deny(rust_2018_idioms)]
  10 #![deny(internal)]
  11
  12 #![feature(const_fn)]
  13 #![feature(crate_visibility_modifier)]
  14 #![feature(custom_attribute)]
  15 #![feature(nll)]
  16 #![feature(non_exhaustive)]
  17 #![feature(optin_builtin_traits)]
  18 #![feature(rustc_attrs)]
  19 #![feature(proc_macro_hygiene)]
  20 #![feature(specialization)]
  21 #![feature(step_trait)]
  22
  23 use serialize::{Encodable, Decodable, Encoder, Decoder};
  24
  25 #[allow(unused_extern_crates)]
  26 extern crate serialize as rustc_serialize; // used by deriving
  27
  28 pub mod edition;
  29 use edition::Edition;
  30 pub mod hygiene;
  31 pub use hygiene::{Mark, SyntaxContext, ExpnInfo, ExpnFormat, CompilerDesugaringKind};
  32
  33 mod span_encoding;
  34 pub use span_encoding::{Span, DUMMY_SP};
  35
  36 pub mod symbol;
  37 pub use symbol::{Symbol, sym};
  38
  39 mod analyze_source_file;
  40
  41 use rustc_data_structures::stable_hasher::StableHasher;
  42 use rustc_data_structures::sync::{Lrc, Lock};
  43
  44 use std::borrow::Cow;
  45 use std::cell::Cell;
  46 use std::cmp::{self, Ordering};
  47 use std::fmt;
  48 use std::hash::{Hasher, Hash};
  49 use std::ops::{Add, Sub};
  50 use std::path::PathBuf;
  51
  52 pub struct Globals {
  53     symbol_interner: Lock<symbol::Interner>,
  54     span_interner: Lock<span_encoding::SpanInterner>,
  55     hygiene_data: Lock<hygiene::HygieneData>,
  56     edition: Edition,
  57 }
  58
  59 impl Globals {
  60     pub fn new(edition: Edition) -> Globals {
  61         Globals {
  62             symbol_interner: Lock::new(symbol::Interner::fresh()),
  63             span_interner: Lock::new(span_encoding::SpanInterner::default()),
  64             hygiene_data: Lock::new(hygiene::HygieneData::new()),
  65             edition,
  66         }
  67     }
  68 }
  69
  70 scoped_tls::scoped_thread_local!(pub static GLOBALS: Globals);
  71
  72 /// Differentiates between real files and common virtual files.
  73 #[derive(Debug, Eq, PartialEq, Clone, Ord, PartialOrd, Hash, RustcDecodable, RustcEncodable)]
  74 pub enum FileName {
  75     Real(PathBuf),
  76     /// A macro. This includes the full name of the macro, so that there are no clashes.
  77     Macros(String),
  78     /// Call to `quote!`.
  79     QuoteExpansion(u64),
  80     /// Command line.
  81     Anon(u64),
  82     /// Hack in `src/libsyntax/parse.rs`.
  83     // FIXME(jseyfried)
  84     MacroExpansion(u64),
  85     ProcMacroSourceCode(u64),
  86     /// Strings provided as `--cfg [cfgspec]` stored in a `crate_cfg`.
  87     CfgSpec(u64),
  88     /// Strings provided as crate attributes in the CLI.
  89     CliCrateAttr(u64),
  90     /// Custom sources for explicit parser calls from plugins and drivers.
  91     Custom(String),
  92     DocTest(PathBuf, isize),
  93 }
  94
  95 impl std::fmt::Display for FileName {
  96     fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  97         use FileName::*;
  98         match *self {
  99             Real(ref path) => write!(fmt, "{}", path.display()),
 100             Macros(ref name) => write!(fmt, "<{} macros>", name),
 101             QuoteExpansion(_) => write!(fmt, "<quote expansion>"),
 102             MacroExpansion(_) => write!(fmt, "<macro expansion>"),
 103             Anon(_) => write!(fmt, "<anon>"),
 104             ProcMacroSourceCode(_) =>
 105                 write!(fmt, "<proc-macro source code>"),
 106             CfgSpec(_) => write!(fmt, "<cfgspec>"),
 107             CliCrateAttr(_) => write!(fmt, "<crate attribute>"),
 108             Custom(ref s) => write!(fmt, "<{}>", s),
 109             DocTest(ref path, _) => write!(fmt, "{}", path.display()),
 110         }
 111     }
 112 }
 113
 114 impl From<PathBuf> for FileName {
 115     fn from(p: PathBuf) -> Self {
 116         assert!(!p.to_string_lossy().ends_with('>'));
 117         FileName::Real(p)
 118     }
 119 }
 120
 121 impl FileName {
 122     pub fn is_real(&self) -> bool {
 123         use FileName::*;
 124         match *self {
 125             Real(_) => true,
 126             Macros(_) |
 127             Anon(_) |
 128             MacroExpansion(_) |
 129             ProcMacroSourceCode(_) |
 130             CfgSpec(_) |
 131             CliCrateAttr(_) |
 132             Custom(_) |
 133             QuoteExpansion(_) |
 134             DocTest(_, _) => false,
 135         }
 136     }
 137
 138     pub fn is_macros(&self) -> bool {
 139         use FileName::*;
 140         match *self {
 141             Real(_) |
 142             Anon(_) |
 143             MacroExpansion(_) |
 144             ProcMacroSourceCode(_) |
 145             CfgSpec(_) |
 146             CliCrateAttr(_) |
 147             Custom(_) |
 148             QuoteExpansion(_) |
 149             DocTest(_, _) => false,
 150             Macros(_) => true,
 151         }
 152     }
 153
 154     pub fn quote_expansion_source_code(src: &str) -> FileName {
 155         let mut hasher = StableHasher::new();
 156         src.hash(&mut hasher);
 157         FileName::QuoteExpansion(hasher.finish())
 158     }
 159
 160     pub fn macro_expansion_source_code(src: &str) -> FileName {
 161         let mut hasher = StableHasher::new();
 162         src.hash(&mut hasher);
 163         FileName::MacroExpansion(hasher.finish())
 164     }
 165
 166     pub fn anon_source_code(src: &str) -> FileName {
 167         let mut hasher = StableHasher::new();
 168         src.hash(&mut hasher);
 169         FileName::Anon(hasher.finish())
 170     }
 171
 172     pub fn proc_macro_source_code(src: &str) -> FileName {
 173         let mut hasher = StableHasher::new();
 174         src.hash(&mut hasher);
 175         FileName::ProcMacroSourceCode(hasher.finish())
 176     }
 177
 178     pub fn cfg_spec_source_code(src: &str) -> FileName {
 179         let mut hasher = StableHasher::new();
 180         src.hash(&mut hasher);
 181         FileName::QuoteExpansion(hasher.finish())
 182     }
 183
 184     pub fn cli_crate_attr_source_code(src: &str) -> FileName {
 185         let mut hasher = StableHasher::new();
 186         src.hash(&mut hasher);
 187         FileName::CliCrateAttr(hasher.finish())
 188     }
 189
 190     pub fn doc_test_source_code(path: PathBuf, line: isize) -> FileName{
 191         FileName::DocTest(path, line)
 192     }
 193 }
 194
 195 /// Spans represent a region of code, used for error reporting. Positions in spans
 196 /// are *absolute* positions from the beginning of the source_map, not positions
 197 /// relative to `SourceFile`s. Methods on the `SourceMap` can be used to relate spans back
 198 /// to the original source.
 199 /// You must be careful if the span crosses more than one file - you will not be
 200 /// able to use many of the functions on spans in source_map and you cannot assume
 201 /// that the length of the `span = hi - lo`; there may be space in the `BytePos`
 202 /// range between files.
 203 ///
 204 /// `SpanData` is public because `Span` uses a thread-local interner and can't be
 205 /// sent to other threads, but some pieces of performance infra run in a separate thread.
 206 /// Using `Span` is generally preferred.
 207 #[derive(Clone, Copy, Hash, PartialEq, Eq, Ord, PartialOrd)]
 208 pub struct SpanData {
 209     pub lo: BytePos,
 210     pub hi: BytePos,
 211     /// Information about where the macro came from, if this piece of
 212     /// code was created by a macro expansion.
 213     pub ctxt: SyntaxContext,
 214 }
 215
 216 impl SpanData {
 217     #[inline]
 218     pub fn with_lo(&self, lo: BytePos) -> Span {
 219         Span::new(lo, self.hi, self.ctxt)
 220     }
 221     #[inline]
 222     pub fn with_hi(&self, hi: BytePos) -> Span {
 223         Span::new(self.lo, hi, self.ctxt)
 224     }
 225     #[inline]
 226     pub fn with_ctxt(&self, ctxt: SyntaxContext) -> Span {
 227         Span::new(self.lo, self.hi, ctxt)
 228     }
 229 }
 230
 231 // The interner is pointed to by a thread local value which is only set on the main thread
 232 // with parallelization is disabled. So we don't allow `Span` to transfer between threads
 233 // to avoid panics and other errors, even though it would be memory safe to do so.
 234 #[cfg(not(parallel_compiler))]
 235 impl !Send for Span {}
 236 #[cfg(not(parallel_compiler))]
 237 impl !Sync for Span {}
 238
 239 impl PartialOrd for Span {
 240     fn partial_cmp(&self, rhs: &Self) -> Option<Ordering> {
 241         PartialOrd::partial_cmp(&self.data(), &rhs.data())
 242     }
 243 }
 244 impl Ord for Span {
 245     fn cmp(&self, rhs: &Self) -> Ordering {
 246         Ord::cmp(&self.data(), &rhs.data())
 247     }
 248 }
 249
 250 /// A collection of spans. Spans have two orthogonal attributes:
 251 ///
 252 /// - They can be *primary spans*. In this case they are the locus of
 253 ///   the error, and would be rendered with `^^^`.
 254 /// - They can have a *label*. In this case, the label is written next
 255 ///   to the mark in the snippet when we render.
 256 #[derive(Clone, Debug, Hash, PartialEq, Eq, RustcEncodable, RustcDecodable)]
 257 pub struct MultiSpan {
 258     primary_spans: Vec<Span>,
 259     span_labels: Vec<(Span, String)>,
 260 }
 261
 262 impl Span {
 263     #[inline]
 264     pub fn lo(self) -> BytePos {
 265         self.data().lo
 266     }
 267     #[inline]
 268     pub fn with_lo(self, lo: BytePos) -> Span {
 269         self.data().with_lo(lo)
 270     }
 271     #[inline]
 272     pub fn hi(self) -> BytePos {
 273         self.data().hi
 274     }
 275     #[inline]
 276     pub fn with_hi(self, hi: BytePos) -> Span {
 277         self.data().with_hi(hi)
 278     }
 279     #[inline]
 280     pub fn ctxt(self) -> SyntaxContext {
 281         self.data().ctxt
 282     }
 283     #[inline]
 284     pub fn with_ctxt(self, ctxt: SyntaxContext) -> Span {
 285         self.data().with_ctxt(ctxt)
 286     }
 287
 288     /// Returns `true` if this is a dummy span with any hygienic context.
 289     #[inline]
 290     pub fn is_dummy(self) -> bool {
 291         let span = self.data();
 292         span.lo.0 == 0 && span.hi.0 == 0
 293     }
 294
 295     /// Returns a new span representing an empty span at the beginning of this span
 296     #[inline]
 297     pub fn shrink_to_lo(self) -> Span {
 298         let span = self.data();
 299         span.with_hi(span.lo)
 300     }
 301     /// Returns a new span representing an empty span at the end of this span.
 302     #[inline]
 303     pub fn shrink_to_hi(self) -> Span {
 304         let span = self.data();
 305         span.with_lo(span.hi)
 306     }
 307
 308     /// Returns `self` if `self` is not the dummy span, and `other` otherwise.
 309     pub fn substitute_dummy(self, other: Span) -> Span {
 310         if self.is_dummy() { other } else { self }
 311     }
 312
 313     /// Returns `true` if `self` fully encloses `other`.
 314     pub fn contains(self, other: Span) -> bool {
 315         let span = self.data();
 316         let other = other.data();
 317         span.lo <= other.lo && other.hi <= span.hi
 318     }
 319
 320     /// Returns `true` if `self` touches `other`.
 321     pub fn overlaps(self, other: Span) -> bool {
 322         let span = self.data();
 323         let other = other.data();
 324         span.lo < other.hi && other.lo < span.hi
 325     }
 326
 327     /// Returns `true` if the spans are equal with regards to the source text.
 328     ///
 329     /// Use this instead of `==` when either span could be generated code,
 330     /// and you only care that they point to the same bytes of source text.
 331     pub fn source_equal(&self, other: &Span) -> bool {
 332         let span = self.data();
 333         let other = other.data();
 334         span.lo == other.lo && span.hi == other.hi
 335     }
 336
 337     /// Returns `Some(span)`, where the start is trimmed by the end of `other`.
 338     pub fn trim_start(self, other: Span) -> Option<Span> {
 339         let span = self.data();
 340         let other = other.data();
 341         if span.hi > other.hi {
 342             Some(span.with_lo(cmp::max(span.lo, other.hi)))
 343         } else {
 344             None
 345         }
 346     }
 347
 348     /// Returns the source span -- this is either the supplied span, or the span for
 349     /// the macro callsite that expanded to it.
 350     pub fn source_callsite(self) -> Span {
 351         self.ctxt().outer_expn_info().map(|info| info.call_site.source_callsite()).unwrap_or(self)
 352     }
 353
 354     /// The `Span` for the tokens in the previous macro expansion from which `self` was generated,
 355     /// if any.
 356     pub fn parent(self) -> Option<Span> {
 357         self.ctxt().outer_expn_info().map(|i| i.call_site)
 358     }
 359
 360     /// Edition of the crate from which this span came.
 361     pub fn edition(self) -> edition::Edition {
 362         self.ctxt().outer_expn_info().map_or_else(|| {
 363             Edition::from_session()
 364         }, |einfo| einfo.edition)
 365     }
 366
 367     #[inline]
 368     pub fn rust_2015(&self) -> bool {
 369         self.edition() == edition::Edition::Edition2015
 370     }
 371
 372     #[inline]
 373     pub fn rust_2018(&self) -> bool {
 374         self.edition() >= edition::Edition::Edition2018
 375     }
 376
 377     /// Returns the source callee.
 378     ///
 379     /// Returns `None` if the supplied span has no expansion trace,
 380     /// else returns the `ExpnInfo` for the macro definition
 381     /// corresponding to the source callsite.
 382     pub fn source_callee(self) -> Option<ExpnInfo> {
 383         fn source_callee(info: ExpnInfo) -> ExpnInfo {
 384             match info.call_site.ctxt().outer_expn_info() {
 385                 Some(info) => source_callee(info),
 386                 None => info,
 387             }
 388         }
 389         self.ctxt().outer_expn_info().map(source_callee)
 390     }
 391
 392     /// Checks if a span is "internal" to a macro in which `#[unstable]`
 393     /// items can be used (that is, a macro marked with
 394     /// `#[allow_internal_unstable]`).
 395     pub fn allows_unstable(&self, feature: Symbol) -> bool {
 396         match self.ctxt().outer_expn_info() {
 397             Some(info) => info
 398                 .allow_internal_unstable
 399                 .map_or(false, |features| features.iter().any(|&f|
 400                     f == feature || f == sym::allow_internal_unstable_backcompat_hack
 401                 )),
 402             None => false,
 403         }
 404     }
 405
 406     /// Checks if this span arises from a compiler desugaring of kind `kind`.
 407     pub fn is_compiler_desugaring(&self, kind: CompilerDesugaringKind) -> bool {
 408         match self.ctxt().outer_expn_info() {
 409             Some(info) => match info.format {
 410                 ExpnFormat::CompilerDesugaring(k) => k == kind,
 411                 _ => false,
 412             },
 413             None => false,
 414         }
 415     }
 416
 417     /// Returns the compiler desugaring that created this span, or `None`
 418     /// if this span is not from a desugaring.
 419     pub fn compiler_desugaring_kind(&self) -> Option<CompilerDesugaringKind> {
 420         match self.ctxt().outer_expn_info() {
 421             Some(info) => match info.format {
 422                 ExpnFormat::CompilerDesugaring(k) => Some(k),
 423                 _ => None
 424             },
 425             None => None
 426         }
 427     }
 428
 429     /// Checks if a span is "internal" to a macro in which `unsafe`
 430     /// can be used without triggering the `unsafe_code` lint
 431     //  (that is, a macro marked with `#[allow_internal_unsafe]`).
 432     pub fn allows_unsafe(&self) -> bool {
 433         match self.ctxt().outer_expn_info() {
 434             Some(info) => info.allow_internal_unsafe,
 435             None => false,
 436         }
 437     }
 438
 439     pub fn macro_backtrace(mut self) -> Vec<MacroBacktrace> {
 440         let mut prev_span = DUMMY_SP;
 441         let mut result = vec![];
 442         while let Some(info) = self.ctxt().outer_expn_info() {
 443             // Don't print recursive invocations.
 444             if !info.call_site.source_equal(&prev_span) {
 445                 let (pre, post) = match info.format {
 446                     ExpnFormat::MacroAttribute(..) => ("#[", "]"),
 447                     ExpnFormat::MacroBang(..) => ("", "!"),
 448                     ExpnFormat::CompilerDesugaring(..) => ("desugaring of `", "`"),
 449                 };
 450                 result.push(MacroBacktrace {
 451                     call_site: info.call_site,
 452                     macro_decl_name: format!("{}{}{}", pre, info.format.name(), post),
 453                     def_site_span: info.def_site,
 454                 });
 455             }
 456
 457             prev_span = self;
 458             self = info.call_site;
 459         }
 460         result
 461     }
 462
 463     /// Returns a `Span` that would enclose both `self` and `end`.
 464     pub fn to(self, end: Span) -> Span {
 465         let span_data = self.data();
 466         let end_data = end.data();
 467         // FIXME(jseyfried): `self.ctxt` should always equal `end.ctxt` here (cf. issue #23480).
 468         // Return the macro span on its own to avoid weird diagnostic output. It is preferable to
 469         // have an incomplete span than a completely nonsensical one.
 470         if span_data.ctxt != end_data.ctxt {
 471             if span_data.ctxt == SyntaxContext::empty() {
 472                 return end;
 473             } else if end_data.ctxt == SyntaxContext::empty() {
 474                 return self;
 475             }
 476             // Both spans fall within a macro.
 477             // FIXME(estebank): check if it is the *same* macro.
 478         }
 479         Span::new(
 480             cmp::min(span_data.lo, end_data.lo),
 481             cmp::max(span_data.hi, end_data.hi),
 482             if span_data.ctxt == SyntaxContext::empty() { end_data.ctxt } else { span_data.ctxt },
 483         )
 484     }
 485
 486     /// Returns a `Span` between the end of `self` to the beginning of `end`.
 487     pub fn between(self, end: Span) -> Span {
 488         let span = self.data();
 489         let end = end.data();
 490         Span::new(
 491             span.hi,
 492             end.lo,
 493             if end.ctxt == SyntaxContext::empty() { end.ctxt } else { span.ctxt },
 494         )
 495     }
 496
 497     /// Returns a `Span` between the beginning of `self` to the beginning of `end`.
 498     pub fn until(self, end: Span) -> Span {
 499         let span = self.data();
 500         let end = end.data();
 501         Span::new(
 502             span.lo,
 503             end.lo,
 504             if end.ctxt == SyntaxContext::empty() { end.ctxt } else { span.ctxt },
 505         )
 506     }
 507
 508     pub fn from_inner_byte_pos(self, start: usize, end: usize) -> Span {
 509         let span = self.data();
 510         Span::new(span.lo + BytePos::from_usize(start),
 511                   span.lo + BytePos::from_usize(end),
 512                   span.ctxt)
 513     }
 514
 515     #[inline]
 516     pub fn apply_mark(self, mark: Mark) -> Span {
 517         let span = self.data();
 518         span.with_ctxt(span.ctxt.apply_mark(mark))
 519     }
 520
 521     #[inline]
 522     pub fn remove_mark(&mut self) -> Mark {
 523         let mut span = self.data();
 524         let mark = span.ctxt.remove_mark();
 525         *self = Span::new(span.lo, span.hi, span.ctxt);
 526         mark
 527     }
 528
 529     #[inline]
 530     pub fn adjust(&mut self, expansion: Mark) -> Option<Mark> {
 531         let mut span = self.data();
 532         let mark = span.ctxt.adjust(expansion);
 533         *self = Span::new(span.lo, span.hi, span.ctxt);
 534         mark
 535     }
 536
 537     #[inline]
 538     pub fn glob_adjust(&mut self, expansion: Mark, glob_span: Span) -> Option<Option<Mark>> {
 539         let mut span = self.data();
 540         let mark = span.ctxt.glob_adjust(expansion, glob_span);
 541         *self = Span::new(span.lo, span.hi, span.ctxt);
 542         mark
 543     }
 544
 545     #[inline]
 546     pub fn reverse_glob_adjust(&mut self, expansion: Mark, glob_span: Span)
 547                                -> Option<Option<Mark>> {
 548         let mut span = self.data();
 549         let mark = span.ctxt.reverse_glob_adjust(expansion, glob_span);
 550         *self = Span::new(span.lo, span.hi, span.ctxt);
 551         mark
 552     }
 553
 554     #[inline]
 555     pub fn modern(self) -> Span {
 556         let span = self.data();
 557         span.with_ctxt(span.ctxt.modern())
 558     }
 559
 560     #[inline]
 561     pub fn modern_and_legacy(self) -> Span {
 562         let span = self.data();
 563         span.with_ctxt(span.ctxt.modern_and_legacy())
 564     }
 565 }
 566
 567 #[derive(Clone, Debug)]
 568 pub struct SpanLabel {
 569     /// The span we are going to include in the final snippet.
 570     pub span: Span,
 571
 572     /// Is this a primary span? This is the "locus" of the message,
 573     /// and is indicated with a `^^^^` underline, versus `----`.
 574     pub is_primary: bool,
 575
 576     /// What label should we attach to this span (if any)?
 577     pub label: Option<String>,
 578 }
 579
 580 impl Default for Span {
 581     fn default() -> Self {
 582         DUMMY_SP
 583     }
 584 }
 585
 586 impl serialize::UseSpecializedEncodable for Span {
 587     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 588         let span = self.data();
 589         s.emit_struct("Span", 2, |s| {
 590             s.emit_struct_field("lo", 0, |s| {
 591                 span.lo.encode(s)
 592             })?;
 593
 594             s.emit_struct_field("hi", 1, |s| {
 595                 span.hi.encode(s)
 596             })
 597         })
 598     }
 599 }
 600
 601 impl serialize::UseSpecializedDecodable for Span {
 602     fn default_decode<D: Decoder>(d: &mut D) -> Result<Span, D::Error> {
 603         d.read_struct("Span", 2, |d| {
 604             let lo = d.read_struct_field("lo", 0, Decodable::decode)?;
 605             let hi = d.read_struct_field("hi", 1, Decodable::decode)?;
 606             Ok(Span::new(lo, hi, NO_EXPANSION))
 607         })
 608     }
 609 }
 610
 611 pub fn default_span_debug(span: Span, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 612     f.debug_struct("Span")
 613         .field("lo", &span.lo())
 614         .field("hi", &span.hi())
 615         .field("ctxt", &span.ctxt())
 616         .finish()
 617 }
 618
 619 impl fmt::Debug for Span {
 620     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 621         SPAN_DEBUG.with(|span_debug| span_debug.get()(*self, f))
 622     }
 623 }
 624
 625 impl fmt::Debug for SpanData {
 626     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 627         SPAN_DEBUG.with(|span_debug| span_debug.get()(Span::new(self.lo, self.hi, self.ctxt), f))
 628     }
 629 }
 630
 631 impl MultiSpan {
 632     #[inline]
 633     pub fn new() -> MultiSpan {
 634         MultiSpan {
 635             primary_spans: vec![],
 636             span_labels: vec![]
 637         }
 638     }
 639
 640     pub fn from_span(primary_span: Span) -> MultiSpan {
 641         MultiSpan {
 642             primary_spans: vec![primary_span],
 643             span_labels: vec![]
 644         }
 645     }
 646
 647     pub fn from_spans(vec: Vec<Span>) -> MultiSpan {
 648         MultiSpan {
 649             primary_spans: vec,
 650             span_labels: vec![]
 651         }
 652     }
 653
 654     pub fn push_span_label(&mut self, span: Span, label: String) {
 655         self.span_labels.push((span, label));
 656     }
 657
 658     /// Selects the first primary span (if any).
 659     pub fn primary_span(&self) -> Option<Span> {
 660         self.primary_spans.first().cloned()
 661     }
 662
 663     /// Returns all primary spans.
 664     pub fn primary_spans(&self) -> &[Span] {
 665         &self.primary_spans
 666     }
 667
 668     /// Returns `true` if any of the primary spans are displayable.
 669     pub fn has_primary_spans(&self) -> bool {
 670         self.primary_spans.iter().any(|sp| !sp.is_dummy())
 671     }
 672
 673     /// Returns `true` if this contains only a dummy primary span with any hygienic context.
 674     pub fn is_dummy(&self) -> bool {
 675         let mut is_dummy = true;
 676         for span in &self.primary_spans {
 677             if !span.is_dummy() {
 678                 is_dummy = false;
 679             }
 680         }
 681         is_dummy
 682     }
 683
 684     /// Replaces all occurrences of one Span with another. Used to move `Span`s in areas that don't
 685     /// display well (like std macros). Returns whether replacements occurred.
 686     pub fn replace(&mut self, before: Span, after: Span) -> bool {
 687         let mut replacements_occurred = false;
 688         for primary_span in &mut self.primary_spans {
 689             if *primary_span == before {
 690                 *primary_span = after;
 691                 replacements_occurred = true;
 692             }
 693         }
 694         for span_label in &mut self.span_labels {
 695             if span_label.0 == before {
 696                 span_label.0 = after;
 697                 replacements_occurred = true;
 698             }
 699         }
 700         replacements_occurred
 701     }
 702
 703     /// Returns the strings to highlight. We always ensure that there
 704     /// is an entry for each of the primary spans -- for each primary
 705     /// span `P`, if there is at least one label with span `P`, we return
 706     /// those labels (marked as primary). But otherwise we return
 707     /// `SpanLabel` instances with empty labels.
 708     pub fn span_labels(&self) -> Vec<SpanLabel> {
 709         let is_primary = |span| self.primary_spans.contains(&span);
 710
 711         let mut span_labels = self.span_labels.iter().map(|&(span, ref label)|
 712             SpanLabel {
 713                 span,
 714                 is_primary: is_primary(span),
 715                 label: Some(label.clone())
 716             }
 717         ).collect::<Vec<_>>();
 718
 719         for &span in &self.primary_spans {
 720             if !span_labels.iter().any(|sl| sl.span == span) {
 721                 span_labels.push(SpanLabel {
 722                     span,
 723                     is_primary: true,
 724                     label: None
 725                 });
 726             }
 727         }
 728
 729         span_labels
 730     }
 731
 732     /// Returns `true` if any of the span labels is displayable.
 733     pub fn has_span_labels(&self) -> bool {
 734         self.span_labels.iter().any(|(sp, _)| !sp.is_dummy())
 735     }
 736 }
 737
 738 impl From<Span> for MultiSpan {
 739     fn from(span: Span) -> MultiSpan {
 740         MultiSpan::from_span(span)
 741     }
 742 }
 743
 744 impl From<Vec<Span>> for MultiSpan {
 745     fn from(spans: Vec<Span>) -> MultiSpan {
 746         MultiSpan::from_spans(spans)
 747     }
 748 }
 749
 750 pub const NO_EXPANSION: SyntaxContext = SyntaxContext::empty();
 751
 752 /// Identifies an offset of a multi-byte character in a `SourceFile`.
 753 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Eq, PartialEq, Debug)]
 754 pub struct MultiByteChar {
 755     /// The absolute offset of the character in the `SourceMap`.
 756     pub pos: BytePos,
 757     /// The number of bytes, `>= 2`.
 758     pub bytes: u8,
 759 }
 760
 761 /// Identifies an offset of a non-narrow character in a `SourceFile`.
 762 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Eq, PartialEq, Debug)]
 763 pub enum NonNarrowChar {
 764     /// Represents a zero-width character.
 765     ZeroWidth(BytePos),
 766     /// Represents a wide (full-width) character.
 767     Wide(BytePos),
 768     /// Represents a tab character, represented visually with a width of 4 characters.
 769     Tab(BytePos),
 770 }
 771
 772 impl NonNarrowChar {
 773     fn new(pos: BytePos, width: usize) -> Self {
 774         match width {
 775             0 => NonNarrowChar::ZeroWidth(pos),
 776             2 => NonNarrowChar::Wide(pos),
 777             4 => NonNarrowChar::Tab(pos),
 778             _ => panic!("width {} given for non-narrow character", width),
 779         }
 780     }
 781
 782     /// Returns the absolute offset of the character in the `SourceMap`.
 783     pub fn pos(&self) -> BytePos {
 784         match *self {
 785             NonNarrowChar::ZeroWidth(p) |
 786             NonNarrowChar::Wide(p) |
 787             NonNarrowChar::Tab(p) => p,
 788         }
 789     }
 790
 791     /// Returns the width of the character, 0 (zero-width) or 2 (wide).
 792     pub fn width(&self) -> usize {
 793         match *self {
 794             NonNarrowChar::ZeroWidth(_) => 0,
 795             NonNarrowChar::Wide(_) => 2,
 796             NonNarrowChar::Tab(_) => 4,
 797         }
 798     }
 799 }
 800
 801 impl Add<BytePos> for NonNarrowChar {
 802     type Output = Self;
 803
 804     fn add(self, rhs: BytePos) -> Self {
 805         match self {
 806             NonNarrowChar::ZeroWidth(pos) => NonNarrowChar::ZeroWidth(pos + rhs),
 807             NonNarrowChar::Wide(pos) => NonNarrowChar::Wide(pos + rhs),
 808             NonNarrowChar::Tab(pos) => NonNarrowChar::Tab(pos + rhs),
 809         }
 810     }
 811 }
 812
 813 impl Sub<BytePos> for NonNarrowChar {
 814     type Output = Self;
 815
 816     fn sub(self, rhs: BytePos) -> Self {
 817         match self {
 818             NonNarrowChar::ZeroWidth(pos) => NonNarrowChar::ZeroWidth(pos - rhs),
 819             NonNarrowChar::Wide(pos) => NonNarrowChar::Wide(pos - rhs),
 820             NonNarrowChar::Tab(pos) => NonNarrowChar::Tab(pos - rhs),
 821         }
 822     }
 823 }
 824
 825 /// The state of the lazy external source loading mechanism of a `SourceFile`.
 826 #[derive(PartialEq, Eq, Clone)]
 827 pub enum ExternalSource {
 828     /// The external source has been loaded already.
 829     Present(String),
 830     /// No attempt has been made to load the external source.
 831     AbsentOk,
 832     /// A failed attempt has been made to load the external source.
 833     AbsentErr,
 834     /// No external source has to be loaded, since the `SourceFile` represents a local crate.
 835     Unneeded,
 836 }
 837
 838 impl ExternalSource {
 839     pub fn is_absent(&self) -> bool {
 840         match *self {
 841             ExternalSource::Present(_) => false,
 842             _ => true,
 843         }
 844     }
 845
 846     pub fn get_source(&self) -> Option<&str> {
 847         match *self {
 848             ExternalSource::Present(ref src) => Some(src),
 849             _ => None,
 850         }
 851     }
 852 }
 853
 854 /// A single source in the `SourceMap`.
 855 #[derive(Clone)]
 856 pub struct SourceFile {
 857     /// The name of the file that the source came from, source that doesn't
 858     /// originate from files has names between angle brackets by convention
 859     /// (e.g., `<anon>`).
 860     pub name: FileName,
 861     /// `true` if the `name` field above has been modified by `--remap-path-prefix`.
 862     pub name_was_remapped: bool,
 863     /// The unmapped path of the file that the source came from.
 864     /// Set to `None` if the `SourceFile` was imported from an external crate.
 865     pub unmapped_path: Option<FileName>,
 866     /// Indicates which crate this `SourceFile` was imported from.
 867     pub crate_of_origin: u32,
 868     /// The complete source code.
 869     pub src: Option<Lrc<String>>,
 870     /// The source code's hash.
 871     pub src_hash: u128,
 872     /// The external source code (used for external crates, which will have a `None`
 873     /// value as `self.src`.
 874     pub external_src: Lock<ExternalSource>,
 875     /// The start position of this source in the `SourceMap`.
 876     pub start_pos: BytePos,
 877     /// The end position of this source in the `SourceMap`.
 878     pub end_pos: BytePos,
 879     /// Locations of lines beginnings in the source code.
 880     pub lines: Vec<BytePos>,
 881     /// Locations of multi-byte characters in the source code.
 882     pub multibyte_chars: Vec<MultiByteChar>,
 883     /// Width of characters that are not narrow in the source code.
 884     pub non_narrow_chars: Vec<NonNarrowChar>,
 885     /// A hash of the filename, used for speeding up hashing in incremental compilation.
 886     pub name_hash: u128,
 887 }
 888
 889 impl Encodable for SourceFile {
 890     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 891         s.emit_struct("SourceFile", 8, |s| {
 892             s.emit_struct_field("name", 0, |s| self.name.encode(s))?;
 893             s.emit_struct_field("name_was_remapped", 1, |s| self.name_was_remapped.encode(s))?;
 894             s.emit_struct_field("src_hash", 2, |s| self.src_hash.encode(s))?;
 895             s.emit_struct_field("start_pos", 4, |s| self.start_pos.encode(s))?;
 896             s.emit_struct_field("end_pos", 5, |s| self.end_pos.encode(s))?;
 897             s.emit_struct_field("lines", 6, |s| {
 898                 let lines = &self.lines[..];
 899                 // Store the length.
 900                 s.emit_u32(lines.len() as u32)?;
 901
 902                 if !lines.is_empty() {
 903                     // In order to preserve some space, we exploit the fact that
 904                     // the lines list is sorted and individual lines are
 905                     // probably not that long. Because of that we can store lines
 906                     // as a difference list, using as little space as possible
 907                     // for the differences.
 908                     let max_line_length = if lines.len() == 1 {
 909                         0
 910                     } else {
 911                         lines.windows(2)
 912                              .map(|w| w[1] - w[0])
 913                              .map(|bp| bp.to_usize())
 914                              .max()
 915                              .unwrap()
 916                     };
 917
 918                     let bytes_per_diff: u8 = match max_line_length {
 919                         0 ..= 0xFF => 1,
 920                         0x100 ..= 0xFFFF => 2,
 921                         _ => 4
 922                     };
 923
 924                     // Encode the number of bytes used per diff.
 925                     bytes_per_diff.encode(s)?;
 926
 927                     // Encode the first element.
 928                     lines[0].encode(s)?;
 929
 930                     let diff_iter = (&lines[..]).windows(2)
 931                                                 .map(|w| (w[1] - w[0]));
 932
 933                     match bytes_per_diff {
 934                         1 => for diff in diff_iter { (diff.0 as u8).encode(s)? },
 935                         2 => for diff in diff_iter { (diff.0 as u16).encode(s)? },
 936                         4 => for diff in diff_iter { diff.0.encode(s)? },
 937                         _ => unreachable!()
 938                     }
 939                 }
 940
 941                 Ok(())
 942             })?;
 943             s.emit_struct_field("multibyte_chars", 7, |s| {
 944                 self.multibyte_chars.encode(s)
 945             })?;
 946             s.emit_struct_field("non_narrow_chars", 8, |s| {
 947                 self.non_narrow_chars.encode(s)
 948             })?;
 949             s.emit_struct_field("name_hash", 9, |s| {
 950                 self.name_hash.encode(s)
 951             })
 952         })
 953     }
 954 }
 955
 956 impl Decodable for SourceFile {
 957     fn decode<D: Decoder>(d: &mut D) -> Result<SourceFile, D::Error> {
 958
 959         d.read_struct("SourceFile", 8, |d| {
 960             let name: FileName = d.read_struct_field("name", 0, |d| Decodable::decode(d))?;
 961             let name_was_remapped: bool =
 962                 d.read_struct_field("name_was_remapped", 1, |d| Decodable::decode(d))?;
 963             let src_hash: u128 =
 964                 d.read_struct_field("src_hash", 2, |d| Decodable::decode(d))?;
 965             let start_pos: BytePos =
 966                 d.read_struct_field("start_pos", 4, |d| Decodable::decode(d))?;
 967             let end_pos: BytePos = d.read_struct_field("end_pos", 5, |d| Decodable::decode(d))?;
 968             let lines: Vec<BytePos> = d.read_struct_field("lines", 6, |d| {
 969                 let num_lines: u32 = Decodable::decode(d)?;
 970                 let mut lines = Vec::with_capacity(num_lines as usize);
 971
 972                 if num_lines > 0 {
 973                     // Read the number of bytes used per diff.
 974                     let bytes_per_diff: u8 = Decodable::decode(d)?;
 975
 976                     // Read the first element.
 977                     let mut line_start: BytePos = Decodable::decode(d)?;
 978                     lines.push(line_start);
 979
 980                     for _ in 1..num_lines {
 981                         let diff = match bytes_per_diff {
 982                             1 => d.read_u8()? as u32,
 983                             2 => d.read_u16()? as u32,
 984                             4 => d.read_u32()?,
 985                             _ => unreachable!()
 986                         };
 987
 988                         line_start = line_start + BytePos(diff);
 989
 990                         lines.push(line_start);
 991                     }
 992                 }
 993
 994                 Ok(lines)
 995             })?;
 996             let multibyte_chars: Vec<MultiByteChar> =
 997                 d.read_struct_field("multibyte_chars", 7, |d| Decodable::decode(d))?;
 998             let non_narrow_chars: Vec<NonNarrowChar> =
 999                 d.read_struct_field("non_narrow_chars", 8, |d| Decodable::decode(d))?;
1000             let name_hash: u128 =
1001                 d.read_struct_field("name_hash", 9, |d| Decodable::decode(d))?;
1002             Ok(SourceFile {
1003                 name,
1004                 name_was_remapped,
1005                 unmapped_path: None,
1006                 // `crate_of_origin` has to be set by the importer.
1007                 // This value matches up with rustc::hir::def_id::INVALID_CRATE.
1008                 // That constant is not available here unfortunately :(
1009                 crate_of_origin: std::u32::MAX - 1,
1010                 start_pos,
1011                 end_pos,
1012                 src: None,
1013                 src_hash,
1014                 external_src: Lock::new(ExternalSource::AbsentOk),
1015                 lines,
1016                 multibyte_chars,
1017                 non_narrow_chars,
1018                 name_hash,
1019             })
1020         })
1021     }
1022 }
1023
1024 impl fmt::Debug for SourceFile {
1025     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1026         write!(fmt, "SourceFile({})", self.name)
1027     }
1028 }
1029
1030 impl SourceFile {
1031     pub fn new(name: FileName,
1032                name_was_remapped: bool,
1033                unmapped_path: FileName,
1034                mut src: String,
1035                start_pos: BytePos) -> SourceFile {
1036         remove_bom(&mut src);
1037
1038         let src_hash = {
1039             let mut hasher: StableHasher<u128> = StableHasher::new();
1040             hasher.write(src.as_bytes());
1041             hasher.finish()
1042         };
1043         let name_hash = {
1044             let mut hasher: StableHasher<u128> = StableHasher::new();
1045             name.hash(&mut hasher);
1046             hasher.finish()
1047         };
1048         let end_pos = start_pos.to_usize() + src.len();
1049
1050         let (lines, multibyte_chars, non_narrow_chars) =
1051             analyze_source_file::analyze_source_file(&src[..], start_pos);
1052
1053         SourceFile {
1054             name,
1055             name_was_remapped,
1056             unmapped_path: Some(unmapped_path),
1057             crate_of_origin: 0,
1058             src: Some(Lrc::new(src)),
1059             src_hash,
1060             external_src: Lock::new(ExternalSource::Unneeded),
1061             start_pos,
1062             end_pos: Pos::from_usize(end_pos),
1063             lines,
1064             multibyte_chars,
1065             non_narrow_chars,
1066             name_hash,
1067         }
1068     }
1069
1070     /// Returns the `BytePos` of the beginning of the current line.
1071     pub fn line_begin_pos(&self, pos: BytePos) -> BytePos {
1072         let line_index = self.lookup_line(pos).unwrap();
1073         self.lines[line_index]
1074     }
1075
1076     /// Add externally loaded source.
1077     /// If the hash of the input doesn't match or no input is supplied via None,
1078     /// it is interpreted as an error and the corresponding enum variant is set.
1079     /// The return value signifies whether some kind of source is present.
1080     pub fn add_external_src<F>(&self, get_src: F) -> bool
1081         where F: FnOnce() -> Option<String>
1082     {
1083         if *self.external_src.borrow() == ExternalSource::AbsentOk {
1084             let src = get_src();
1085             let mut external_src = self.external_src.borrow_mut();
1086             // Check that no-one else have provided the source while we were getting it
1087             if *external_src == ExternalSource::AbsentOk {
1088                 if let Some(src) = src {
1089                     let mut hasher: StableHasher<u128> = StableHasher::new();
1090                     hasher.write(src.as_bytes());
1091
1092                     if hasher.finish() == self.src_hash {
1093                         *external_src = ExternalSource::Present(src);
1094                         return true;
1095                     }
1096                 } else {
1097                     *external_src = ExternalSource::AbsentErr;
1098                 }
1099
1100                 false
1101             } else {
1102                 self.src.is_some() || external_src.get_source().is_some()
1103             }
1104         } else {
1105             self.src.is_some() || self.external_src.borrow().get_source().is_some()
1106         }
1107     }
1108
1109     /// Gets a line from the list of pre-computed line-beginnings.
1110     /// The line number here is 0-based.
1111     pub fn get_line(&self, line_number: usize) -> Option<Cow<'_, str>> {
1112         fn get_until_newline(src: &str, begin: usize) -> &str {
1113             // We can't use `lines.get(line_number+1)` because we might
1114             // be parsing when we call this function and thus the current
1115             // line is the last one we have line info for.
1116             let slice = &src[begin..];
1117             match slice.find('\n') {
1118                 Some(e) => &slice[..e],
1119                 None => slice
1120             }
1121         }
1122
1123         let begin = {
1124             let line = if let Some(line) = self.lines.get(line_number) {
1125                 line
1126             } else {
1127                 return None;
1128             };
1129             let begin: BytePos = *line - self.start_pos;
1130             begin.to_usize()
1131         };
1132
1133         if let Some(ref src) = self.src {
1134             Some(Cow::from(get_until_newline(src, begin)))
1135         } else if let Some(src) = self.external_src.borrow().get_source() {
1136             Some(Cow::Owned(String::from(get_until_newline(src, begin))))
1137         } else {
1138             None
1139         }
1140     }
1141
1142     pub fn is_real_file(&self) -> bool {
1143         self.name.is_real()
1144     }
1145
1146     pub fn is_imported(&self) -> bool {
1147         self.src.is_none()
1148     }
1149
1150     pub fn byte_length(&self) -> u32 {
1151         self.end_pos.0 - self.start_pos.0
1152     }
1153     pub fn count_lines(&self) -> usize {
1154         self.lines.len()
1155     }
1156
1157     /// Finds the line containing the given position. The return value is the
1158     /// index into the `lines` array of this `SourceFile`, not the 1-based line
1159     /// number. If the source_file is empty or the position is located before the
1160     /// first line, `None` is returned.
1161     pub fn lookup_line(&self, pos: BytePos) -> Option<usize> {
1162         if self.lines.len() == 0 {
1163             return None;
1164         }
1165
1166         let line_index = lookup_line(&self.lines[..], pos);
1167         assert!(line_index < self.lines.len() as isize);
1168         if line_index >= 0 {
1169             Some(line_index as usize)
1170         } else {
1171             None
1172         }
1173     }
1174
1175     pub fn line_bounds(&self, line_index: usize) -> (BytePos, BytePos) {
1176         if self.start_pos == self.end_pos {
1177             return (self.start_pos, self.end_pos);
1178         }
1179
1180         assert!(line_index < self.lines.len());
1181         if line_index == (self.lines.len() - 1) {
1182             (self.lines[line_index], self.end_pos)
1183         } else {
1184             (self.lines[line_index], self.lines[line_index + 1])
1185         }
1186     }
1187
1188     #[inline]
1189     pub fn contains(&self, byte_pos: BytePos) -> bool {
1190         byte_pos >= self.start_pos && byte_pos <= self.end_pos
1191     }
1192 }
1193
1194 /// Removes UTF-8 BOM, if any.
1195 fn remove_bom(src: &mut String) {
1196     if src.starts_with("\u{feff}") {
1197         src.drain(..3);
1198     }
1199 }
1200
1201 // _____________________________________________________________________________
1202 // Pos, BytePos, CharPos
1203 //
1204
1205 pub trait Pos {
1206     fn from_usize(n: usize) -> Self;
1207     fn to_usize(&self) -> usize;
1208     fn from_u32(n: u32) -> Self;
1209     fn to_u32(&self) -> u32;
1210 }
1211
1212 /// A byte offset. Keep this small (currently 32-bits), as AST contains
1213 /// a lot of them.
1214 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)]
1215 pub struct BytePos(pub u32);
1216
1217 /// A character offset. Because of multibyte UTF-8 characters, a byte offset
1218 /// is not equivalent to a character offset. The `SourceMap` will convert `BytePos`
1219 /// values to `CharPos` values as necessary.
1220 #[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)]
1221 pub struct CharPos(pub usize);
1222
1223 // FIXME: lots of boilerplate in these impls, but so far my attempts to fix
1224 // have been unsuccessful.
1225
1226 impl Pos for BytePos {
1227     #[inline(always)]
1228     fn from_usize(n: usize) -> BytePos { BytePos(n as u32) }
1229
1230     #[inline(always)]
1231     fn to_usize(&self) -> usize { self.0 as usize }
1232
1233     #[inline(always)]
1234     fn from_u32(n: u32) -> BytePos { BytePos(n) }
1235
1236     #[inline(always)]
1237     fn to_u32(&self) -> u32 { self.0 }
1238 }
1239
1240 impl Add for BytePos {
1241     type Output = BytePos;
1242
1243     #[inline(always)]
1244     fn add(self, rhs: BytePos) -> BytePos {
1245         BytePos((self.to_usize() + rhs.to_usize()) as u32)
1246     }
1247 }
1248
1249 impl Sub for BytePos {
1250     type Output = BytePos;
1251
1252     #[inline(always)]
1253     fn sub(self, rhs: BytePos) -> BytePos {
1254         BytePos((self.to_usize() - rhs.to_usize()) as u32)
1255     }
1256 }
1257
1258 impl Encodable for BytePos {
1259     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1260         s.emit_u32(self.0)
1261     }
1262 }
1263
1264 impl Decodable for BytePos {
1265     fn decode<D: Decoder>(d: &mut D) -> Result<BytePos, D::Error> {
1266         Ok(BytePos(d.read_u32()?))
1267     }
1268 }
1269
1270 impl Pos for CharPos {
1271     #[inline(always)]
1272     fn from_usize(n: usize) -> CharPos { CharPos(n) }
1273
1274     #[inline(always)]
1275     fn to_usize(&self) -> usize { self.0 }
1276
1277     #[inline(always)]
1278     fn from_u32(n: u32) -> CharPos { CharPos(n as usize) }
1279
1280     #[inline(always)]
1281     fn to_u32(&self) -> u32 { self.0 as u32}
1282 }
1283
1284 impl Add for CharPos {
1285     type Output = CharPos;
1286
1287     #[inline(always)]
1288     fn add(self, rhs: CharPos) -> CharPos {
1289         CharPos(self.to_usize() + rhs.to_usize())
1290     }
1291 }
1292
1293 impl Sub for CharPos {
1294     type Output = CharPos;
1295
1296     #[inline(always)]
1297     fn sub(self, rhs: CharPos) -> CharPos {
1298         CharPos(self.to_usize() - rhs.to_usize())
1299     }
1300 }
1301
1302 // _____________________________________________________________________________
1303 // Loc, SourceFileAndLine, SourceFileAndBytePos
1304 //
1305
1306 /// A source code location used for error reporting.
1307 #[derive(Debug, Clone)]
1308 pub struct Loc {
1309     /// Information about the original source.
1310     pub file: Lrc<SourceFile>,
1311     /// The (1-based) line number.
1312     pub line: usize,
1313     /// The (0-based) column offset.
1314     pub col: CharPos,
1315     /// The (0-based) column offset when displayed.
1316     pub col_display: usize,
1317 }
1318
1319 // Used to be structural records.
1320 #[derive(Debug)]
1321 pub struct SourceFileAndLine { pub sf: Lrc<SourceFile>, pub line: usize }
1322 #[derive(Debug)]
1323 pub struct SourceFileAndBytePos { pub sf: Lrc<SourceFile>, pub pos: BytePos }
1324
1325 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
1326 pub struct LineInfo {
1327     /// Index of line, starting from 0.
1328     pub line_index: usize,
1329
1330     /// Column in line where span begins, starting from 0.
1331     pub start_col: CharPos,
1332
1333     /// Column in line where span ends, starting from 0, exclusive.
1334     pub end_col: CharPos,
1335 }
1336
1337 pub struct FileLines {
1338     pub file: Lrc<SourceFile>,
1339     pub lines: Vec<LineInfo>
1340 }
1341
1342 thread_local!(pub static SPAN_DEBUG: Cell<fn(Span, &mut fmt::Formatter<'_>) -> fmt::Result> =
1343                 Cell::new(default_span_debug));
1344
1345 #[derive(Debug)]
1346 pub struct MacroBacktrace {
1347     /// span where macro was applied to generate this code
1348     pub call_site: Span,
1349
1350     /// name of macro that was applied (e.g., "foo!" or "#[derive(Eq)]")
1351     pub macro_decl_name: String,
1352
1353     /// span where macro was defined (if known)
1354     pub def_site_span: Option<Span>,
1355 }
1356
1357 // _____________________________________________________________________________
1358 // SpanLinesError, SpanSnippetError, DistinctSources, MalformedSourceMapPositions
1359 //
1360
1361 pub type FileLinesResult = Result<FileLines, SpanLinesError>;
1362
1363 #[derive(Clone, PartialEq, Eq, Debug)]
1364 pub enum SpanLinesError {
1365     IllFormedSpan(Span),
1366     DistinctSources(DistinctSources),
1367 }
1368
1369 #[derive(Clone, PartialEq, Eq, Debug)]
1370 pub enum SpanSnippetError {
1371     IllFormedSpan(Span),
1372     DistinctSources(DistinctSources),
1373     MalformedForSourcemap(MalformedSourceMapPositions),
1374     SourceNotAvailable { filename: FileName }
1375 }
1376
1377 #[derive(Clone, PartialEq, Eq, Debug)]
1378 pub struct DistinctSources {
1379     pub begin: (FileName, BytePos),
1380     pub end: (FileName, BytePos)
1381 }
1382
1383 #[derive(Clone, PartialEq, Eq, Debug)]
1384 pub struct MalformedSourceMapPositions {
1385     pub name: FileName,
1386     pub source_len: usize,
1387     pub begin_pos: BytePos,
1388     pub end_pos: BytePos
1389 }
1390
1391 // Given a slice of line start positions and a position, returns the index of
1392 // the line the position is on. Returns -1 if the position is located before
1393 // the first line.
1394 fn lookup_line(lines: &[BytePos], pos: BytePos) -> isize {
1395     match lines.binary_search(&pos) {
1396         Ok(line) => line as isize,
1397         Err(line) => line as isize - 1
1398     }
1399 }
1400
1401 #[cfg(test)]
1402 mod tests {
1403     use super::{lookup_line, BytePos};
1404
1405     #[test]
1406     fn test_lookup_line() {
1407
1408         let lines = &[BytePos(3), BytePos(17), BytePos(28)];
1409
1410         assert_eq!(lookup_line(lines, BytePos(0)), -1);
1411         assert_eq!(lookup_line(lines, BytePos(3)),  0);
1412         assert_eq!(lookup_line(lines, BytePos(4)),  0);
1413
1414         assert_eq!(lookup_line(lines, BytePos(16)), 0);
1415         assert_eq!(lookup_line(lines, BytePos(17)), 1);
1416         assert_eq!(lookup_line(lines, BytePos(18)), 1);
1417
1418         assert_eq!(lookup_line(lines, BytePos(28)), 2);
1419         assert_eq!(lookup_line(lines, BytePos(29)), 2);
1420     }
1421 }