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::parse::ParseSess;
  14 use syntax::source_map::{SourceMap, Span};
  15
  16 use config::{Config, IndentStyle};
  17 use shape::Shape;
  18 use visitor::SnippetProvider;
  19 use FormatReport;
  20
  21 use std::cell::RefCell;
  22
  23 pub trait Rewrite {
  24     /// Rewrite self into shape.
  25     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String>;
  26 }
  27
  28 #[derive(Clone)]
  29 pub struct RewriteContext<'a> {
  30     pub parse_session: &'a ParseSess,
  31     pub source_map: &'a SourceMap,
  32     pub config: &'a Config,
  33     pub inside_macro: RefCell<bool>,
  34     // Force block indent style even if we are using visual indent style.
  35     pub use_block: RefCell<bool>,
  36     // When `format_if_else_cond_comment` is true, unindent the comment on top
  37     // of the `else` or `else if`.
  38     pub is_if_else_block: RefCell<bool>,
  39     // When rewriting chain, veto going multi line except the last element
  40     pub force_one_line_chain: RefCell<bool>,
  41     pub snippet_provider: &'a SnippetProvider<'a>,
  42     // Used for `format_snippet`
  43     pub(crate) macro_rewrite_failure: RefCell<bool>,
  44     pub(crate) report: FormatReport,
  45 }
  46
  47 impl<'a> RewriteContext<'a> {
  48     pub fn snippet(&self, span: Span) -> &str {
  49         self.snippet_provider.span_to_snippet(span).unwrap()
  50     }
  51
  52     /// Return true if we should use block indent style for rewriting function call.
  53     pub fn use_block_indent(&self) -> bool {
  54         self.config.indent_style() == IndentStyle::Block || *self.use_block.borrow()
  55     }
  56
  57     pub fn budget(&self, used_width: usize) -> usize {
  58         self.config.max_width().saturating_sub(used_width)
  59     }
  60
  61     pub fn inside_macro(&self) -> bool {
  62         *self.inside_macro.borrow()
  63     }
  64
  65     pub fn is_if_else_block(&self) -> bool {
  66         *self.is_if_else_block.borrow()
  67     }
  68 }