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;
  14
  15 use config::Config;
  16
  17 pub trait Rewrite {
  18     /// Rewrite self into offset and width.
  19     /// `offset` is the indentation of the first line. The next lines
  20     /// should begin with a least `offset` spaces (except backwards
  21     /// indentation). The first line should not begin with indentation.
  22     /// `width` is the maximum number of characters on the last line
  23     /// (excluding offset). The width of other lines is not limited by
  24     /// `width`.
  25     fn rewrite(&self, context: &RewriteContext, width: usize, offset: usize) -> Option<String>;
  26 }
  27
  28 pub struct RewriteContext<'a> {
  29     pub codemap: &'a CodeMap,
  30     pub config: &'a Config,
  31     pub block_indent: usize,
  32 }