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 #![crate_name = "syntax_pos"]
  18 #![unstable(feature = "rustc_private", issue = "27812")]
  19 #![crate_type = "dylib"]
  20 #![crate_type = "rlib"]
  21 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  22       html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  23       html_root_url = "https://doc.rust-lang.org/nightly/")]
  24 #![deny(warnings)]
  25
  26 #![feature(const_fn)]
  27 #![feature(custom_attribute)]
  28 #![feature(optin_builtin_traits)]
  29 #![allow(unused_attributes)]
  30 #![feature(rustc_private)]
  31 #![feature(staged_api)]
  32 #![feature(specialization)]
  33
  34 use std::cell::{Cell, RefCell};
  35 use std::ops::{Add, Sub};
  36 use std::rc::Rc;
  37 use std::cmp;
  38
  39 use std::fmt;
  40
  41 use serialize::{Encodable, Decodable, Encoder, Decoder};
  42
  43 extern crate serialize;
  44 extern crate serialize as rustc_serialize; // used by deriving
  45
  46 pub mod hygiene;
  47 pub use hygiene::{SyntaxContext, ExpnInfo, ExpnFormat, NameAndSpan};
  48
  49 pub mod symbol;
  50
  51 pub type FileName = String;
  52
  53 /// Spans represent a region of code, used for error reporting. Positions in spans
  54 /// are *absolute* positions from the beginning of the codemap, not positions
  55 /// relative to FileMaps. Methods on the CodeMap can be used to relate spans back
  56 /// to the original source.
  57 /// You must be careful if the span crosses more than one file - you will not be
  58 /// able to use many of the functions on spans in codemap and you cannot assume
  59 /// that the length of the span = hi - lo; there may be space in the BytePos
  60 /// range between files.
  61 #[derive(Clone, Copy, Hash, PartialEq, Eq, Ord, PartialOrd)]
  62 pub struct Span {
  63     pub lo: BytePos,
  64     pub hi: BytePos,
  65     /// Information about where the macro came from, if this piece of
  66     /// code was created by a macro expansion.
  67     pub ctxt: SyntaxContext,
  68 }
  69
  70 /// A collection of spans. Spans have two orthogonal attributes:
  71 ///
  72 /// - they can be *primary spans*. In this case they are the locus of
  73 ///   the error, and would be rendered with `^^^`.
  74 /// - they can have a *label*. In this case, the label is written next
  75 ///   to the mark in the snippet when we render.
  76 #[derive(Clone, Debug, Hash, PartialEq, Eq, RustcEncodable, RustcDecodable)]
  77 pub struct MultiSpan {
  78     primary_spans: Vec<Span>,
  79     span_labels: Vec<(Span, String)>,
  80 }
  81
  82 impl Span {
  83     /// Returns a new span representing just the end-point of this span
  84     pub fn end_point(self) -> Span {
  85         let lo = cmp::max(self.hi.0 - 1, self.lo.0);
  86         Span { lo: BytePos(lo), ..self }
  87     }
  88
  89     /// Returns a new span representing the next character after the end-point of this span
  90     pub fn next_point(self) -> Span {
  91         let lo = cmp::max(self.hi.0, self.lo.0 + 1);
  92         Span { lo: BytePos(lo), hi: BytePos(lo + 1), ..self }
  93     }
  94
  95     /// Returns `self` if `self` is not the dummy span, and `other` otherwise.
  96     pub fn substitute_dummy(self, other: Span) -> Span {
  97         if self.source_equal(&DUMMY_SP) { other } else { self }
  98     }
  99
 100     pub fn contains(self, other: Span) -> bool {
 101         self.lo <= other.lo && other.hi <= self.hi
 102     }
 103
 104     /// Return true if the spans are equal with regards to the source text.
 105     ///
 106     /// Use this instead of `==` when either span could be generated code,
 107     /// and you only care that they point to the same bytes of source text.
 108     pub fn source_equal(&self, other: &Span) -> bool {
 109         self.lo == other.lo && self.hi == other.hi
 110     }
 111
 112     /// Returns `Some(span)`, where the start is trimmed by the end of `other`
 113     pub fn trim_start(self, other: Span) -> Option<Span> {
 114         if self.hi > other.hi {
 115             Some(Span { lo: cmp::max(self.lo, other.hi), .. self })
 116         } else {
 117             None
 118         }
 119     }
 120
 121     /// Return the source span - this is either the supplied span, or the span for
 122     /// the macro callsite that expanded to it.
 123     pub fn source_callsite(self) -> Span {
 124         self.ctxt.outer().expn_info().map(|info| info.call_site.source_callsite()).unwrap_or(self)
 125     }
 126
 127     /// Return the source callee.
 128     ///
 129     /// Returns None if the supplied span has no expansion trace,
 130     /// else returns the NameAndSpan for the macro definition
 131     /// corresponding to the source callsite.
 132     pub fn source_callee(self) -> Option<NameAndSpan> {
 133         fn source_callee(info: ExpnInfo) -> NameAndSpan {
 134             match info.call_site.ctxt.outer().expn_info() {
 135                 Some(info) => source_callee(info),
 136                 None => info.callee,
 137             }
 138         }
 139         self.ctxt.outer().expn_info().map(source_callee)
 140     }
 141
 142     /// Check if a span is "internal" to a macro in which #[unstable]
 143     /// items can be used (that is, a macro marked with
 144     /// `#[allow_internal_unstable]`).
 145     pub fn allows_unstable(&self) -> bool {
 146         match self.ctxt.outer().expn_info() {
 147             Some(info) => info.callee.allow_internal_unstable,
 148             None => false,
 149         }
 150     }
 151
 152     pub fn macro_backtrace(mut self) -> Vec<MacroBacktrace> {
 153         let mut prev_span = DUMMY_SP;
 154         let mut result = vec![];
 155         loop {
 156             let info = match self.ctxt.outer().expn_info() {
 157                 Some(info) => info,
 158                 None => break,
 159             };
 160
 161             let (pre, post) = match info.callee.format {
 162                 ExpnFormat::MacroAttribute(..) => ("#[", "]"),
 163                 ExpnFormat::MacroBang(..) => ("", "!"),
 164                 ExpnFormat::CompilerDesugaring(..) => ("desugaring of `", "`"),
 165             };
 166             let macro_decl_name = format!("{}{}{}", pre, info.callee.name(), post);
 167             let def_site_span = info.callee.span;
 168
 169             // Don't print recursive invocations
 170             if !info.call_site.source_equal(&prev_span) {
 171                 result.push(MacroBacktrace {
 172                     call_site: info.call_site,
 173                     macro_decl_name: macro_decl_name,
 174                     def_site_span: def_site_span,
 175                 });
 176             }
 177
 178             prev_span = self;
 179             self = info.call_site;
 180         }
 181         result
 182     }
 183
 184     pub fn to(self, end: Span) -> Span {
 185         // FIXME(jseyfried): self.ctxt should always equal end.ctxt here (c.f. issue #23480)
 186         if end.ctxt == SyntaxContext::empty() {
 187             Span { lo: self.lo, ..end }
 188         } else {
 189             Span { hi: end.hi, ..self }
 190         }
 191     }
 192
 193     pub fn between(self, end: Span) -> Span {
 194         Span {
 195             lo: self.hi,
 196             hi: end.lo,
 197             ctxt: if end.ctxt == SyntaxContext::empty() {
 198                 end.ctxt
 199             } else {
 200                 self.ctxt
 201             }
 202         }
 203     }
 204
 205     pub fn until(self, end: Span) -> Span {
 206         Span {
 207             lo: self.lo,
 208             hi: end.lo,
 209             ctxt: if end.ctxt == SyntaxContext::empty() {
 210                 end.ctxt
 211             } else {
 212                 self.ctxt
 213             }
 214         }
 215     }
 216 }
 217
 218 #[derive(Clone, Debug)]
 219 pub struct SpanLabel {
 220     /// The span we are going to include in the final snippet.
 221     pub span: Span,
 222
 223     /// Is this a primary span? This is the "locus" of the message,
 224     /// and is indicated with a `^^^^` underline, versus `----`.
 225     pub is_primary: bool,
 226
 227     /// What label should we attach to this span (if any)?
 228     pub label: Option<String>,
 229 }
 230
 231 impl serialize::UseSpecializedEncodable for Span {
 232     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 233         s.emit_struct("Span", 2, |s| {
 234             s.emit_struct_field("lo", 0, |s| {
 235                 self.lo.encode(s)
 236             })?;
 237
 238             s.emit_struct_field("hi", 1, |s| {
 239                 self.hi.encode(s)
 240             })
 241         })
 242     }
 243 }
 244
 245 impl serialize::UseSpecializedDecodable for Span {
 246     fn default_decode<D: Decoder>(d: &mut D) -> Result<Span, D::Error> {
 247         d.read_struct("Span", 2, |d| {
 248             let lo = d.read_struct_field("lo", 0, Decodable::decode)?;
 249             let hi = d.read_struct_field("hi", 1, Decodable::decode)?;
 250             Ok(Span { lo: lo, hi: hi, ctxt: NO_EXPANSION })
 251         })
 252     }
 253 }
 254
 255 fn default_span_debug(span: Span, f: &mut fmt::Formatter) -> fmt::Result {
 256     write!(f, "Span {{ lo: {:?}, hi: {:?}, ctxt: {:?} }}",
 257            span.lo, span.hi, span.ctxt)
 258 }
 259
 260 impl fmt::Debug for Span {
 261     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 262         SPAN_DEBUG.with(|span_debug| span_debug.get()(*self, f))
 263     }
 264 }
 265
 266 pub const DUMMY_SP: Span = Span { lo: BytePos(0), hi: BytePos(0), ctxt: NO_EXPANSION };
 267
 268 impl MultiSpan {
 269     pub fn new() -> MultiSpan {
 270         MultiSpan {
 271             primary_spans: vec![],
 272             span_labels: vec![]
 273         }
 274     }
 275
 276     pub fn from_span(primary_span: Span) -> MultiSpan {
 277         MultiSpan {
 278             primary_spans: vec![primary_span],
 279             span_labels: vec![]
 280         }
 281     }
 282
 283     pub fn from_spans(vec: Vec<Span>) -> MultiSpan {
 284         MultiSpan {
 285             primary_spans: vec,
 286             span_labels: vec![]
 287         }
 288     }
 289
 290     pub fn push_span_label(&mut self, span: Span, label: String) {
 291         self.span_labels.push((span, label));
 292     }
 293
 294     /// Selects the first primary span (if any)
 295     pub fn primary_span(&self) -> Option<Span> {
 296         self.primary_spans.first().cloned()
 297     }
 298
 299     /// Returns all primary spans.
 300     pub fn primary_spans(&self) -> &[Span] {
 301         &self.primary_spans
 302     }
 303
 304     /// Replaces all occurances of one Span with another. Used to move Spans in areas that don't
 305     /// display well (like std macros). Returns true if replacements occurred.
 306     pub fn replace(&mut self, before: Span, after: Span) -> bool {
 307         let mut replacements_occurred = false;
 308         for primary_span in &mut self.primary_spans {
 309             if *primary_span == before {
 310                 *primary_span = after;
 311                 replacements_occurred = true;
 312             }
 313         }
 314         for span_label in &mut self.span_labels {
 315             if span_label.0 == before {
 316                 span_label.0 = after;
 317                 replacements_occurred = true;
 318             }
 319         }
 320         replacements_occurred
 321     }
 322
 323     /// Returns the strings to highlight. We always ensure that there
 324     /// is an entry for each of the primary spans -- for each primary
 325     /// span P, if there is at least one label with span P, we return
 326     /// those labels (marked as primary). But otherwise we return
 327     /// `SpanLabel` instances with empty labels.
 328     pub fn span_labels(&self) -> Vec<SpanLabel> {
 329         let is_primary = |span| self.primary_spans.contains(&span);
 330         let mut span_labels = vec![];
 331
 332         for &(span, ref label) in &self.span_labels {
 333             span_labels.push(SpanLabel {
 334                 span: span,
 335                 is_primary: is_primary(span),
 336                 label: Some(label.clone())
 337             });
 338         }
 339
 340         for &span in &self.primary_spans {
 341             if !span_labels.iter().any(|sl| sl.span == span) {
 342                 span_labels.push(SpanLabel {
 343                     span: span,
 344                     is_primary: true,
 345                     label: None
 346                 });
 347             }
 348         }
 349
 350         span_labels
 351     }
 352 }
 353
 354 impl From<Span> for MultiSpan {
 355     fn from(span: Span) -> MultiSpan {
 356         MultiSpan::from_span(span)
 357     }
 358 }
 359
 360 pub const NO_EXPANSION: SyntaxContext = SyntaxContext::empty();
 361
 362 /// Identifies an offset of a multi-byte character in a FileMap
 363 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Eq, PartialEq)]
 364 pub struct MultiByteChar {
 365     /// The absolute offset of the character in the CodeMap
 366     pub pos: BytePos,
 367     /// The number of bytes, >=2
 368     pub bytes: usize,
 369 }
 370
 371 /// A single source in the CodeMap.
 372 pub struct FileMap {
 373     /// The name of the file that the source came from, source that doesn't
 374     /// originate from files has names between angle brackets by convention,
 375     /// e.g. `<anon>`
 376     pub name: FileName,
 377     /// The absolute path of the file that the source came from.
 378     pub abs_path: Option<FileName>,
 379     /// The complete source code
 380     pub src: Option<Rc<String>>,
 381     /// The start position of this source in the CodeMap
 382     pub start_pos: BytePos,
 383     /// The end position of this source in the CodeMap
 384     pub end_pos: BytePos,
 385     /// Locations of lines beginnings in the source code
 386     pub lines: RefCell<Vec<BytePos>>,
 387     /// Locations of multi-byte characters in the source code
 388     pub multibyte_chars: RefCell<Vec<MultiByteChar>>,
 389 }
 390
 391 impl Encodable for FileMap {
 392     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 393         s.emit_struct("FileMap", 6, |s| {
 394             s.emit_struct_field("name", 0, |s| self.name.encode(s))?;
 395             s.emit_struct_field("abs_path", 1, |s| self.abs_path.encode(s))?;
 396             s.emit_struct_field("start_pos", 2, |s| self.start_pos.encode(s))?;
 397             s.emit_struct_field("end_pos", 3, |s| self.end_pos.encode(s))?;
 398             s.emit_struct_field("lines", 4, |s| {
 399                 let lines = self.lines.borrow();
 400                 // store the length
 401                 s.emit_u32(lines.len() as u32)?;
 402
 403                 if !lines.is_empty() {
 404                     // In order to preserve some space, we exploit the fact that
 405                     // the lines list is sorted and individual lines are
 406                     // probably not that long. Because of that we can store lines
 407                     // as a difference list, using as little space as possible
 408                     // for the differences.
 409                     let max_line_length = if lines.len() == 1 {
 410                         0
 411                     } else {
 412                         lines.windows(2)
 413                              .map(|w| w[1] - w[0])
 414                              .map(|bp| bp.to_usize())
 415                              .max()
 416                              .unwrap()
 417                     };
 418
 419                     let bytes_per_diff: u8 = match max_line_length {
 420                         0 ... 0xFF => 1,
 421                         0x100 ... 0xFFFF => 2,
 422                         _ => 4
 423                     };
 424
 425                     // Encode the number of bytes used per diff.
 426                     bytes_per_diff.encode(s)?;
 427
 428                     // Encode the first element.
 429                     lines[0].encode(s)?;
 430
 431                     let diff_iter = (&lines[..]).windows(2)
 432                                                 .map(|w| (w[1] - w[0]));
 433
 434                     match bytes_per_diff {
 435                         1 => for diff in diff_iter { (diff.0 as u8).encode(s)? },
 436                         2 => for diff in diff_iter { (diff.0 as u16).encode(s)? },
 437                         4 => for diff in diff_iter { diff.0.encode(s)? },
 438                         _ => unreachable!()
 439                     }
 440                 }
 441
 442                 Ok(())
 443             })?;
 444             s.emit_struct_field("multibyte_chars", 5, |s| {
 445                 (*self.multibyte_chars.borrow()).encode(s)
 446             })
 447         })
 448     }
 449 }
 450
 451 impl Decodable for FileMap {
 452     fn decode<D: Decoder>(d: &mut D) -> Result<FileMap, D::Error> {
 453
 454         d.read_struct("FileMap", 6, |d| {
 455             let name: String = d.read_struct_field("name", 0, |d| Decodable::decode(d))?;
 456             let abs_path: Option<String> =
 457                 d.read_struct_field("abs_path", 1, |d| Decodable::decode(d))?;
 458             let start_pos: BytePos = d.read_struct_field("start_pos", 2, |d| Decodable::decode(d))?;
 459             let end_pos: BytePos = d.read_struct_field("end_pos", 3, |d| Decodable::decode(d))?;
 460             let lines: Vec<BytePos> = d.read_struct_field("lines", 4, |d| {
 461                 let num_lines: u32 = Decodable::decode(d)?;
 462                 let mut lines = Vec::with_capacity(num_lines as usize);
 463
 464                 if num_lines > 0 {
 465                     // Read the number of bytes used per diff.
 466                     let bytes_per_diff: u8 = Decodable::decode(d)?;
 467
 468                     // Read the first element.
 469                     let mut line_start: BytePos = Decodable::decode(d)?;
 470                     lines.push(line_start);
 471
 472                     for _ in 1..num_lines {
 473                         let diff = match bytes_per_diff {
 474                             1 => d.read_u8()? as u32,
 475                             2 => d.read_u16()? as u32,
 476                             4 => d.read_u32()?,
 477                             _ => unreachable!()
 478                         };
 479
 480                         line_start = line_start + BytePos(diff);
 481
 482                         lines.push(line_start);
 483                     }
 484                 }
 485
 486                 Ok(lines)
 487             })?;
 488             let multibyte_chars: Vec<MultiByteChar> =
 489                 d.read_struct_field("multibyte_chars", 5, |d| Decodable::decode(d))?;
 490             Ok(FileMap {
 491                 name: name,
 492                 abs_path: abs_path,
 493                 start_pos: start_pos,
 494                 end_pos: end_pos,
 495                 src: None,
 496                 lines: RefCell::new(lines),
 497                 multibyte_chars: RefCell::new(multibyte_chars)
 498             })
 499         })
 500     }
 501 }
 502
 503 impl fmt::Debug for FileMap {
 504     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 505         write!(fmt, "FileMap({})", self.name)
 506     }
 507 }
 508
 509 impl FileMap {
 510     /// EFFECT: register a start-of-line offset in the
 511     /// table of line-beginnings.
 512     /// UNCHECKED INVARIANT: these offsets must be added in the right
 513     /// order and must be in the right places; there is shared knowledge
 514     /// about what ends a line between this file and parse.rs
 515     /// WARNING: pos param here is the offset relative to start of CodeMap,
 516     /// and CodeMap will append a newline when adding a filemap without a newline at the end,
 517     /// so the safe way to call this is with value calculated as
 518     /// filemap.start_pos + newline_offset_relative_to_the_start_of_filemap.
 519     pub fn next_line(&self, pos: BytePos) {
 520         // the new charpos must be > the last one (or it's the first one).
 521         let mut lines = self.lines.borrow_mut();
 522         let line_len = lines.len();
 523         assert!(line_len == 0 || ((*lines)[line_len - 1] < pos));
 524         lines.push(pos);
 525     }
 526
 527     /// get a line from the list of pre-computed line-beginnings.
 528     /// line-number here is 0-based.
 529     pub fn get_line(&self, line_number: usize) -> Option<&str> {
 530         match self.src {
 531             Some(ref src) => {
 532                 let lines = self.lines.borrow();
 533                 lines.get(line_number).map(|&line| {
 534                     let begin: BytePos = line - self.start_pos;
 535                     let begin = begin.to_usize();
 536                     // We can't use `lines.get(line_number+1)` because we might
 537                     // be parsing when we call this function and thus the current
 538                     // line is the last one we have line info for.
 539                     let slice = &src[begin..];
 540                     match slice.find('\n') {
 541                         Some(e) => &slice[..e],
 542                         None => slice
 543                     }
 544                 })
 545             }
 546             None => None
 547         }
 548     }
 549
 550     pub fn record_multibyte_char(&self, pos: BytePos, bytes: usize) {
 551         assert!(bytes >=2 && bytes <= 4);
 552         let mbc = MultiByteChar {
 553             pos: pos,
 554             bytes: bytes,
 555         };
 556         self.multibyte_chars.borrow_mut().push(mbc);
 557     }
 558
 559     pub fn is_real_file(&self) -> bool {
 560         !(self.name.starts_with("<") &&
 561           self.name.ends_with(">"))
 562     }
 563
 564     pub fn is_imported(&self) -> bool {
 565         self.src.is_none()
 566     }
 567
 568     pub fn byte_length(&self) -> u32 {
 569         self.end_pos.0 - self.start_pos.0
 570     }
 571     pub fn count_lines(&self) -> usize {
 572         self.lines.borrow().len()
 573     }
 574
 575     /// Find the line containing the given position. The return value is the
 576     /// index into the `lines` array of this FileMap, not the 1-based line
 577     /// number. If the filemap is empty or the position is located before the
 578     /// first line, None is returned.
 579     pub fn lookup_line(&self, pos: BytePos) -> Option<usize> {
 580         let lines = self.lines.borrow();
 581         if lines.len() == 0 {
 582             return None;
 583         }
 584
 585         let line_index = lookup_line(&lines[..], pos);
 586         assert!(line_index < lines.len() as isize);
 587         if line_index >= 0 {
 588             Some(line_index as usize)
 589         } else {
 590             None
 591         }
 592     }
 593
 594     pub fn line_bounds(&self, line_index: usize) -> (BytePos, BytePos) {
 595         if self.start_pos == self.end_pos {
 596             return (self.start_pos, self.end_pos);
 597         }
 598
 599         let lines = self.lines.borrow();
 600         assert!(line_index < lines.len());
 601         if line_index == (lines.len() - 1) {
 602             (lines[line_index], self.end_pos)
 603         } else {
 604             (lines[line_index], lines[line_index + 1])
 605         }
 606     }
 607 }
 608
 609 // _____________________________________________________________________________
 610 // Pos, BytePos, CharPos
 611 //
 612
 613 pub trait Pos {
 614     fn from_usize(n: usize) -> Self;
 615     fn to_usize(&self) -> usize;
 616 }
 617
 618 /// A byte offset. Keep this small (currently 32-bits), as AST contains
 619 /// a lot of them.
 620 #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)]
 621 pub struct BytePos(pub u32);
 622
 623 /// A character offset. Because of multibyte utf8 characters, a byte offset
 624 /// is not equivalent to a character offset. The CodeMap will convert BytePos
 625 /// values to CharPos values as necessary.
 626 #[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)]
 627 pub struct CharPos(pub usize);
 628
 629 // FIXME: Lots of boilerplate in these impls, but so far my attempts to fix
 630 // have been unsuccessful
 631
 632 impl Pos for BytePos {
 633     fn from_usize(n: usize) -> BytePos { BytePos(n as u32) }
 634     fn to_usize(&self) -> usize { let BytePos(n) = *self; n as usize }
 635 }
 636
 637 impl Add for BytePos {
 638     type Output = BytePos;
 639
 640     fn add(self, rhs: BytePos) -> BytePos {
 641         BytePos((self.to_usize() + rhs.to_usize()) as u32)
 642     }
 643 }
 644
 645 impl Sub for BytePos {
 646     type Output = BytePos;
 647
 648     fn sub(self, rhs: BytePos) -> BytePos {
 649         BytePos((self.to_usize() - rhs.to_usize()) as u32)
 650     }
 651 }
 652
 653 impl Encodable for BytePos {
 654     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 655         s.emit_u32(self.0)
 656     }
 657 }
 658
 659 impl Decodable for BytePos {
 660     fn decode<D: Decoder>(d: &mut D) -> Result<BytePos, D::Error> {
 661         Ok(BytePos(d.read_u32()?))
 662     }
 663 }
 664
 665 impl Pos for CharPos {
 666     fn from_usize(n: usize) -> CharPos { CharPos(n) }
 667     fn to_usize(&self) -> usize { let CharPos(n) = *self; n }
 668 }
 669
 670 impl Add for CharPos {
 671     type Output = CharPos;
 672
 673     fn add(self, rhs: CharPos) -> CharPos {
 674         CharPos(self.to_usize() + rhs.to_usize())
 675     }
 676 }
 677
 678 impl Sub for CharPos {
 679     type Output = CharPos;
 680
 681     fn sub(self, rhs: CharPos) -> CharPos {
 682         CharPos(self.to_usize() - rhs.to_usize())
 683     }
 684 }
 685
 686 // _____________________________________________________________________________
 687 // Loc, LocWithOpt, FileMapAndLine, FileMapAndBytePos
 688 //
 689
 690 /// A source code location used for error reporting
 691 #[derive(Debug, Clone)]
 692 pub struct Loc {
 693     /// Information about the original source
 694     pub file: Rc<FileMap>,
 695     /// The (1-based) line number
 696     pub line: usize,
 697     /// The (0-based) column offset
 698     pub col: CharPos
 699 }
 700
 701 /// A source code location used as the result of lookup_char_pos_adj
 702 // Actually, *none* of the clients use the filename *or* file field;
 703 // perhaps they should just be removed.
 704 #[derive(Debug)]
 705 pub struct LocWithOpt {
 706     pub filename: FileName,
 707     pub line: usize,
 708     pub col: CharPos,
 709     pub file: Option<Rc<FileMap>>,
 710 }
 711
 712 // used to be structural records. Better names, anyone?
 713 #[derive(Debug)]
 714 pub struct FileMapAndLine { pub fm: Rc<FileMap>, pub line: usize }
 715 #[derive(Debug)]
 716 pub struct FileMapAndBytePos { pub fm: Rc<FileMap>, pub pos: BytePos }
 717
 718 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 719 pub struct LineInfo {
 720     /// Index of line, starting from 0.
 721     pub line_index: usize,
 722
 723     /// Column in line where span begins, starting from 0.
 724     pub start_col: CharPos,
 725
 726     /// Column in line where span ends, starting from 0, exclusive.
 727     pub end_col: CharPos,
 728 }
 729
 730 pub struct FileLines {
 731     pub file: Rc<FileMap>,
 732     pub lines: Vec<LineInfo>
 733 }
 734
 735 thread_local!(pub static SPAN_DEBUG: Cell<fn(Span, &mut fmt::Formatter) -> fmt::Result> =
 736                 Cell::new(default_span_debug));
 737
 738 pub struct MacroBacktrace {
 739     /// span where macro was applied to generate this code
 740     pub call_site: Span,
 741
 742     /// name of macro that was applied (e.g., "foo!" or "#[derive(Eq)]")
 743     pub macro_decl_name: String,
 744
 745     /// span where macro was defined (if known)
 746     pub def_site_span: Option<Span>,
 747 }
 748
 749 // _____________________________________________________________________________
 750 // SpanLinesError, SpanSnippetError, DistinctSources, MalformedCodemapPositions
 751 //
 752
 753 pub type FileLinesResult = Result<FileLines, SpanLinesError>;
 754
 755 #[derive(Clone, PartialEq, Eq, Debug)]
 756 pub enum SpanLinesError {
 757     IllFormedSpan(Span),
 758     DistinctSources(DistinctSources),
 759 }
 760
 761 #[derive(Clone, PartialEq, Eq, Debug)]
 762 pub enum SpanSnippetError {
 763     IllFormedSpan(Span),
 764     DistinctSources(DistinctSources),
 765     MalformedForCodemap(MalformedCodemapPositions),
 766     SourceNotAvailable { filename: String }
 767 }
 768
 769 #[derive(Clone, PartialEq, Eq, Debug)]
 770 pub struct DistinctSources {
 771     pub begin: (String, BytePos),
 772     pub end: (String, BytePos)
 773 }
 774
 775 #[derive(Clone, PartialEq, Eq, Debug)]
 776 pub struct MalformedCodemapPositions {
 777     pub name: String,
 778     pub source_len: usize,
 779     pub begin_pos: BytePos,
 780     pub end_pos: BytePos
 781 }
 782
 783 // Given a slice of line start positions and a position, returns the index of
 784 // the line the position is on. Returns -1 if the position is located before
 785 // the first line.
 786 fn lookup_line(lines: &[BytePos], pos: BytePos) -> isize {
 787     match lines.binary_search(&pos) {
 788         Ok(line) => line as isize,
 789         Err(line) => line as isize - 1
 790     }
 791 }
 792
 793 #[cfg(test)]
 794 mod tests {
 795     use super::{lookup_line, BytePos};
 796
 797     #[test]
 798     fn test_lookup_line() {
 799
 800         let lines = &[BytePos(3), BytePos(17), BytePos(28)];
 801
 802         assert_eq!(lookup_line(lines, BytePos(0)), -1);
 803         assert_eq!(lookup_line(lines, BytePos(3)),  0);
 804         assert_eq!(lookup_line(lines, BytePos(4)),  0);
 805
 806         assert_eq!(lookup_line(lines, BytePos(16)), 0);
 807         assert_eq!(lookup_line(lines, BytePos(17)), 1);
 808         assert_eq!(lookup_line(lines, BytePos(18)), 1);
 809
 810         assert_eq!(lookup_line(lines, BytePos(28)), 2);
 811         assert_eq!(lookup_line(lines, BytePos(29)), 2);
 812     }
 813 }