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