src/visitor.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 use syntax::ast;
  12 use syntax::codemap::{self, CodeMap, Span, BytePos};
  13 use syntax::visit;
  14
  15 use utils;
  16
  17 use SKIP_ANNOTATION;
  18 use changes::ChangeSet;
  19
  20 pub struct FmtVisitor<'a> {
  21     pub codemap: &'a CodeMap,
  22     pub changes: ChangeSet<'a>,
  23     pub last_pos: BytePos,
  24     // TODO RAII util for indenting
  25     pub block_indent: usize,
  26 }
  27
  28 impl<'a, 'v> visit::Visitor<'v> for FmtVisitor<'a> {
  29     fn visit_expr(&mut self, ex: &'v ast::Expr) {
  30         debug!("visit_expr: {:?} {:?}",
  31                self.codemap.lookup_char_pos(ex.span.lo),
  32                self.codemap.lookup_char_pos(ex.span.hi));
  33         self.format_missing(ex.span.lo);
  34         let offset = self.changes.cur_offset_span(ex.span);
  35         let new_str = self.rewrite_expr(ex, config!(max_width) - offset, offset);
  36         self.changes.push_str_span(ex.span, &new_str);
  37         self.last_pos = ex.span.hi;
  38     }
  39
  40     fn visit_stmt(&mut self, stmt: &'v ast::Stmt) {
  41         // If the stmt is actually an item, then we'll handle any missing spans
  42         // there. This is important because of annotations.
  43         // Although it might make more sense for the statement span to include
  44         // any annotations on the item.
  45         let skip_missing = match stmt.node {
  46             ast::Stmt_::StmtDecl(ref decl, _) => {
  47                 match decl.node {
  48                     ast::Decl_::DeclItem(_) => true,
  49                     _ => false,
  50                 }
  51             }
  52             _ => false,
  53         };
  54         if !skip_missing {
  55             self.format_missing_with_indent(stmt.span.lo);
  56         }
  57         visit::walk_stmt(self, stmt);
  58     }
  59
  60     fn visit_block(&mut self, b: &'v ast::Block) {
  61         debug!("visit_block: {:?} {:?}",
  62                self.codemap.lookup_char_pos(b.span.lo),
  63                self.codemap.lookup_char_pos(b.span.hi));
  64         self.format_missing(b.span.lo);
  65
  66         self.changes.push_str_span(b.span, "{");
  67         self.last_pos = self.last_pos + BytePos(1);
  68         self.block_indent += config!(tab_spaces);
  69
  70         for stmt in &b.stmts {
  71             self.visit_stmt(&stmt)
  72         }
  73         match b.expr {
  74             Some(ref e) => {
  75                 self.format_missing_with_indent(e.span.lo);
  76                 self.visit_expr(e);
  77             }
  78             None => {}
  79         }
  80
  81         self.block_indent -= config!(tab_spaces);
  82         // TODO we should compress any newlines here to just one
  83         self.format_missing_with_indent(b.span.hi - BytePos(1));
  84         self.changes.push_str_span(b.span, "}");
  85         self.last_pos = b.span.hi;
  86     }
  87
  88     // Note that this only gets called for function definitions. Required methods
  89     // on traits do not get handled here.
  90     fn visit_fn(&mut self,
  91                 fk: visit::FnKind<'v>,
  92                 fd: &'v ast::FnDecl,
  93                 b: &'v ast::Block,
  94                 s: Span,
  95                 _: ast::NodeId) {
  96         self.format_missing_with_indent(s.lo);
  97         self.last_pos = s.lo;
  98
  99         let indent = self.block_indent;
 100         match fk {
 101             visit::FkItemFn(ident, ref generics, ref unsafety, ref abi, vis) => {
 102                 let new_fn = self.rewrite_fn(indent,
 103                                              ident,
 104                                              fd,
 105                                              None,
 106                                              generics,
 107                                              unsafety,
 108                                              abi,
 109                                              vis,
 110                                              b.span.lo);
 111                 self.changes.push_str_span(s, &new_fn);
 112             }
 113             visit::FkMethod(ident, ref sig, vis) => {
 114                 let new_fn = self.rewrite_fn(indent,
 115                                              ident,
 116                                              fd,
 117                                              Some(&sig.explicit_self),
 118                                              &sig.generics,
 119                                              &sig.unsafety,
 120                                              &sig.abi,
 121                                              vis.unwrap_or(ast::Visibility::Inherited),
 122                                              b.span.lo);
 123                 self.changes.push_str_span(s, &new_fn);
 124             }
 125             visit::FkFnBlock(..) => {}
 126         }
 127
 128         self.last_pos = b.span.lo;
 129         self.visit_block(b)
 130     }
 131
 132     fn visit_item(&mut self, item: &'v ast::Item) {
 133         // Don't look at attributes for modules.
 134         // We want to avoid looking at attributes in another file, which the AST
 135         // doesn't distinguish. FIXME This is overly conservative and means we miss
 136         // attributes on inline modules.
 137         match item.node {
 138             ast::Item_::ItemMod(_) => {}
 139             _ => {
 140                 if self.visit_attrs(&item.attrs) {
 141                     return;
 142                 }
 143             }
 144         }
 145
 146         match item.node {
 147             ast::Item_::ItemUse(ref vp) => {
 148                 self.format_missing_with_indent(item.span.lo);
 149                 match vp.node {
 150                     ast::ViewPath_::ViewPathList(ref path, ref path_list) => {
 151                         let block_indent = self.block_indent;
 152                         let one_line_budget = config!(max_width) - block_indent;
 153                         let multi_line_budget = config!(ideal_width) - block_indent;
 154                         let new_str = self.rewrite_use_list(block_indent,
 155                                                             one_line_budget,
 156                                                             multi_line_budget,
 157                                                             path,
 158                                                             path_list,
 159                                                             item.vis);
 160                         self.changes.push_str_span(item.span, &new_str);
 161                         self.last_pos = item.span.hi;
 162                     }
 163                     ast::ViewPath_::ViewPathGlob(_) => {
 164                         // FIXME convert to list?
 165                     }
 166                     ast::ViewPath_::ViewPathSimple(_,_) => {}
 167                 }
 168                 visit::walk_item(self, item);
 169             }
 170             ast::Item_::ItemImpl(..) |
 171             ast::Item_::ItemMod(_) |
 172             ast::Item_::ItemTrait(..) => {
 173                 self.block_indent += config!(tab_spaces);
 174                 visit::walk_item(self, item);
 175                 self.block_indent -= config!(tab_spaces);
 176             }
 177             ast::Item_::ItemExternCrate(_) => {
 178                 self.format_missing_with_indent(item.span.lo);
 179                 let new_str = self.snippet(item.span);
 180                 self.changes.push_str_span(item.span, &new_str);
 181                 self.last_pos = item.span.hi;
 182             }
 183             ast::Item_::ItemStruct(ref def, ref generics) => {
 184                 self.format_missing_with_indent(item.span.lo);
 185                 self.visit_struct(item.ident,
 186                                   item.vis,
 187                                   def,
 188                                   generics,
 189                                   item.span);
 190                 self.last_pos = item.span.hi;
 191             }
 192             _ => {
 193                 visit::walk_item(self, item);
 194             }
 195         }
 196     }
 197
 198     fn visit_trait_item(&mut self, ti: &'v ast::TraitItem) {
 199         if self.visit_attrs(&ti.attrs) {
 200             return;
 201         }
 202
 203         if let ast::TraitItem_::MethodTraitItem(ref sig, None) = ti.node {
 204             self.format_missing_with_indent(ti.span.lo);
 205
 206             let indent = self.block_indent;
 207             let new_fn = self.rewrite_required_fn(indent,
 208                                                   ti.ident,
 209                                                   sig,
 210                                                   ti.span);
 211
 212             self.changes.push_str_span(ti.span, &new_fn);
 213             self.last_pos = ti.span.hi;
 214         }
 215         // TODO format trait types
 216
 217         visit::walk_trait_item(self, ti)
 218     }
 219
 220     fn visit_impl_item(&mut self, ii: &'v ast::ImplItem) {
 221         if self.visit_attrs(&ii.attrs) {
 222             return;
 223         }
 224         visit::walk_impl_item(self, ii)
 225     }
 226
 227     fn visit_mac(&mut self, mac: &'v ast::Mac) {
 228         visit::walk_mac(self, mac)
 229     }
 230
 231     fn visit_mod(&mut self, m: &'v ast::Mod, s: Span, _: ast::NodeId) {
 232         // Only visit inline mods here.
 233         if self.codemap.lookup_char_pos(s.lo).file.name !=
 234            self.codemap.lookup_char_pos(m.inner.lo).file.name {
 235             return;
 236         }
 237         visit::walk_mod(self, m);
 238     }
 239 }
 240
 241 impl<'a> FmtVisitor<'a> {
 242     pub fn from_codemap<'b>(codemap: &'b CodeMap) -> FmtVisitor<'b> {
 243         FmtVisitor {
 244             codemap: codemap,
 245             changes: ChangeSet::from_codemap(codemap),
 246             last_pos: BytePos(0),
 247             block_indent: 0,
 248         }
 249     }
 250
 251     pub fn snippet(&self, span: Span) -> String {
 252         match self.codemap.span_to_snippet(span) {
 253             Ok(s) => s,
 254             Err(_) => {
 255                 println!("Couldn't make snippet for span {:?}->{:?}",
 256                          self.codemap.lookup_char_pos(span.lo),
 257                          self.codemap.lookup_char_pos(span.hi));
 258                 "".to_owned()
 259             }
 260         }
 261     }
 262
 263     // Returns true if we should skip the following item.
 264     pub fn visit_attrs(&mut self, attrs: &[ast::Attribute]) -> bool {
 265         if attrs.len() == 0 {
 266             return false;
 267         }
 268
 269         let first = &attrs[0];
 270         self.format_missing_with_indent(first.span.lo);
 271
 272         match self.rewrite_attrs(attrs, self.block_indent) {
 273             Some(s) => {
 274                 self.changes.push_str_span(first.span, &s);
 275                 let last = attrs.last().unwrap();
 276                 self.last_pos = last.span.hi;
 277                 false
 278             }
 279             None => true
 280         }
 281     }
 282
 283     fn rewrite_attrs(&self, attrs: &[ast::Attribute], indent: usize) -> Option<String> {
 284         let mut result = String::new();
 285         let indent = utils::make_indent(indent);
 286
 287         for (i, a) in attrs.iter().enumerate() {
 288             if is_skip(&a.node.value) {
 289                 return None;
 290             }
 291
 292             let a_str = self.snippet(a.span);
 293
 294             if i > 0 {
 295                 let comment = self.snippet(codemap::mk_sp(attrs[i-1].span.hi, a.span.lo));
 296                 // This particular horror show is to preserve line breaks in between doc
 297                 // comments. An alternative would be to force such line breaks to start
 298                 // with the usual doc comment token.
 299                 let multi_line = a_str.starts_with("//") && comment.matches('\n').count() > 1;
 300                 let comment = comment.trim();
 301                 if comment.len() > 0 {
 302                     result.push_str(&indent);
 303                     result.push_str(comment);
 304                     result.push('\n');
 305                 } else if multi_line {
 306                     result.push('\n');
 307                 }
 308                 result.push_str(&indent);
 309             }
 310
 311             result.push_str(&a_str);
 312
 313             if i < attrs.len() -1 {
 314                 result.push('\n');
 315             }
 316         }
 317
 318         Some(result)
 319     }
 320 }
 321
 322 fn is_skip(meta_item: &ast::MetaItem) -> bool {
 323     match meta_item.node {
 324         ast::MetaItem_::MetaWord(ref s) => *s == SKIP_ANNOTATION,
 325         _ => false,
 326     }
 327 }