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
  15 use Indent;
  16 use config::Config;
  17
  18 pub trait Rewrite {
  19     /// Rewrite self into offset and width.
  20     /// `offset` is the indentation of the first line. The next lines
  21     /// should begin with a least `offset` spaces (except backwards
  22     /// indentation). The first line should not begin with indentation.
  23     /// `width` is the maximum number of characters on the last line
  24     /// (excluding offset). The width of other lines is not limited by
  25     /// `width`.
  26     fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String>;
  27 }
  28
  29 pub struct RewriteContext<'a> {
  30     pub codemap: &'a CodeMap,
  31     pub config: &'a Config,
  32
  33     // Indentation due to nesting of blocks.
  34     pub block_indent: Indent,
  35     // *Extra* indentation due to overflowing to the next line, e.g.,
  36     // let foo =
  37     //     bar();
  38     // The extra 4 spaces when formatting `bar()` is overflow_indent.
  39     pub overflow_indent: Indent,
  40 }
  41
  42 impl<'a> RewriteContext<'a> {
  43     pub fn nested_context(&self) -> RewriteContext<'a> {
  44         RewriteContext {
  45             codemap: self.codemap,
  46             config: self.config,
  47             block_indent: self.block_indent.block_indent(self.config),
  48             overflow_indent: self.overflow_indent,
  49         }
  50     }
  51
  52     pub fn overflow_context(&self, overflow: Indent) -> RewriteContext<'a> {
  53         RewriteContext {
  54             codemap: self.codemap,
  55             config: self.config,
  56             block_indent: self.block_indent,
  57             overflow_indent: overflow,
  58         }
  59     }
  60
  61     pub fn snippet(&self, span: Span) -> String {
  62         self.codemap.span_to_snippet(span).unwrap()
  63     }
  64 }