src/libsyntax_pos/lib.rs

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