src/rewrite.rs

   1 // Copyright 2015 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 // A generic trait to abstract the rewriting of an element (of the AST).
  12
  13 use syntax::codemap::{CodeMap, Span};
  14 use syntax::parse::ParseSess;
  15
  16 use Indent;
  17 use config::Config;
  18
  19 pub trait Rewrite {
  20     /// Rewrite self into offset and width.
  21     /// `offset` is the indentation of the first line. The next lines
  22     /// should begin with a least `offset` spaces (except backwards
  23     /// indentation). The first line should not begin with indentation.
  24     /// `width` is the maximum number of characters on the last line
  25     /// (excluding offset). The width of other lines is not limited by
  26     /// `width`.
  27     fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String>;
  28 }
  29
  30 pub struct RewriteContext<'a> {
  31     pub parse_session: &'a ParseSess,
  32     pub codemap: &'a CodeMap,
  33     pub config: &'a Config,
  34     // Indentation due to nesting of blocks.
  35     pub block_indent: Indent,
  36 }
  37
  38 impl<'a> RewriteContext<'a> {
  39     pub fn nested_context(&self) -> RewriteContext<'a> {
  40         RewriteContext {
  41             parse_session: self.parse_session,
  42             codemap: self.codemap,
  43             config: self.config,
  44             block_indent: self.block_indent.block_indent(self.config),
  45         }
  46     }
  47
  48     pub fn snippet(&self, span: Span) -> String {
  49         self.codemap.span_to_snippet(span).unwrap()
  50     }
  51 }