src/codemap.rs

   1 // Copyright 2016 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 //! This module contains utilities that work with the `CodeMap` from libsyntax / syntex_syntax.
  12 //! This includes extension traits and methods for looking up spans and line ranges for AST nodes.
  13
  14 use std::rc::Rc;
  15
  16 use syntax::codemap::{BytePos, CodeMap, FileMap, Span};
  17
  18 use comment::FindUncommented;
  19
  20 /// A range of lines in a file, inclusive of both ends.
  21 pub struct LineRange {
  22     pub file: Rc<FileMap>,
  23     pub lo: usize,
  24     pub hi: usize,
  25 }
  26
  27 impl LineRange {
  28     pub fn file_name(&self) -> &str {
  29         self.file.as_ref().name.as_str()
  30     }
  31 }
  32
  33 pub trait SpanUtils {
  34     fn span_after(&self, original: Span, needle: &str) -> BytePos;
  35     fn span_after_last(&self, original: Span, needle: &str) -> BytePos;
  36     fn span_before(&self, original: Span, needle: &str) -> BytePos;
  37 }
  38
  39 pub trait LineRangeUtils {
  40     /// Returns the `LineRange` that corresponds to `span` in `self`.
  41     ///
  42     /// # Panics
  43     ///
  44     /// Panics if `span` crosses a file boundary, which shouldn't happen.
  45     fn lookup_line_range(&self, span: Span) -> LineRange;
  46 }
  47
  48 impl SpanUtils for CodeMap {
  49     fn span_after(&self, original: Span, needle: &str) -> BytePos {
  50         let snippet = self.span_to_snippet(original).unwrap();
  51         let offset = snippet.find_uncommented(needle).unwrap() + needle.len();
  52
  53         original.lo + BytePos(offset as u32)
  54     }
  55
  56     fn span_after_last(&self, original: Span, needle: &str) -> BytePos {
  57         let snippet = self.span_to_snippet(original).unwrap();
  58         let mut offset = 0;
  59
  60         while let Some(additional_offset) = snippet[offset..].find_uncommented(needle) {
  61             offset += additional_offset + needle.len();
  62         }
  63
  64         original.lo + BytePos(offset as u32)
  65     }
  66
  67     fn span_before(&self, original: Span, needle: &str) -> BytePos {
  68         let snippet = self.span_to_snippet(original).unwrap();
  69         let offset = snippet.find_uncommented(needle).unwrap();
  70
  71         original.lo + BytePos(offset as u32)
  72     }
  73 }
  74
  75 impl LineRangeUtils for CodeMap {
  76     fn lookup_line_range(&self, span: Span) -> LineRange {
  77         let lo = self.lookup_char_pos(span.lo);
  78         let hi = self.lookup_char_pos(span.hi);
  79
  80         assert!(lo.file.name == hi.file.name,
  81                 "span crossed file boundary: lo: {:?}, hi: {:?}",
  82                 lo,
  83                 hi);
  84
  85         LineRange {
  86             file: lo.file.clone(),
  87             lo: lo.line,
  88             hi: hi.line,
  89         }
  90     }
  91 }