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