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 config::{Config, IndentStyle};
  17 use shape::Shape;
  18 use visitor::SnippetProvider;
  19
  20 pub trait Rewrite {
  21     /// Rewrite self into shape.
  22     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String>;
  23 }
  24
  25 #[derive(Clone)]
  26 pub struct RewriteContext<'a> {
  27     pub parse_session: &'a ParseSess,
  28     pub codemap: &'a CodeMap,
  29     pub config: &'a Config,
  30     pub inside_macro: bool,
  31     // Force block indent style even if we are using visual indent style.
  32     pub use_block: bool,
  33     // When `format_if_else_cond_comment` is true, unindent the comment on top
  34     // of the `else` or `else if`.
  35     pub is_if_else_block: bool,
  36     // When rewriting chain, veto going multi line except the last element
  37     pub force_one_line_chain: bool,
  38     pub snippet_provider: &'a SnippetProvider<'a>,
  39 }
  40
  41 impl<'a> RewriteContext<'a> {
  42     pub fn snippet(&self, span: Span) -> &str {
  43         self.snippet_provider.span_to_snippet(span).unwrap()
  44     }
  45
  46     /// Return true if we should use block indent style for rewriting function call.
  47     pub fn use_block_indent(&self) -> bool {
  48         self.config.indent_style() == IndentStyle::Block || self.use_block
  49     }
  50
  51     pub fn budget(&self, used_width: usize) -> usize {
  52         self.config.max_width().checked_sub(used_width).unwrap_or(0)
  53     }
  54 }