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, ptr, visit};
  12 use syntax::codemap::{self, CodeMap, Span, BytePos};
  13 use syntax::parse::ParseSess;
  14
  15 use strings::string_buffer::StringBuffer;
  16
  17 use Indent;
  18 use utils;
  19 use codemap::{LineRangeUtils, SpanUtils};
  20 use config::Config;
  21 use rewrite::{Rewrite, RewriteContext};
  22 use comment::rewrite_comment;
  23 use macros::rewrite_macro;
  24 use items::{rewrite_static, rewrite_associated_type, rewrite_type_alias, format_impl, format_trait};
  25
  26 fn is_use_item(item: &ast::Item) -> bool {
  27     match item.node {
  28         ast::ItemKind::Use(_) => true,
  29         _ => false,
  30     }
  31 }
  32
  33 pub struct FmtVisitor<'a> {
  34     pub parse_session: &'a ParseSess,
  35     pub codemap: &'a CodeMap,
  36     pub buffer: StringBuffer,
  37     pub last_pos: BytePos,
  38     // FIXME: use an RAII util or closure for indenting
  39     pub block_indent: Indent,
  40     pub config: &'a Config,
  41 }
  42
  43 impl<'a> FmtVisitor<'a> {
  44     fn visit_stmt(&mut self, stmt: &ast::Stmt) {
  45         debug!("visit_stmt: {:?} {:?}",
  46                self.codemap.lookup_char_pos(stmt.span.lo),
  47                self.codemap.lookup_char_pos(stmt.span.hi));
  48
  49         // FIXME(#434): Move this check to somewhere more central, eg Rewrite.
  50         if !self.config.file_lines.contains(&self.codemap.lookup_line_range(stmt.span)) {
  51             return;
  52         }
  53
  54         match stmt.node {
  55             ast::StmtKind::Item(ref item) => {
  56                 self.visit_item(item);
  57             }
  58             ast::StmtKind::Local(..) |
  59             ast::StmtKind::Expr(..) |
  60             ast::StmtKind::Semi(..) => {
  61                 let rewrite = stmt.rewrite(&self.get_context(),
  62                                            self.config.max_width - self.block_indent.width(),
  63                                            self.block_indent);
  64
  65                 self.push_rewrite(stmt.span, rewrite);
  66             }
  67             ast::StmtKind::Mac(ref mac) => {
  68                 let (ref mac, _macro_style, _) = **mac;
  69                 self.visit_mac(mac, None);
  70             }
  71         }
  72     }
  73
  74     pub fn visit_block(&mut self, b: &ast::Block) {
  75         debug!("visit_block: {:?} {:?}",
  76                self.codemap.lookup_char_pos(b.span.lo),
  77                self.codemap.lookup_char_pos(b.span.hi));
  78
  79         // Check if this block has braces.
  80         let snippet = self.snippet(b.span);
  81         let has_braces = snippet.starts_with('{') || snippet.starts_with("unsafe");
  82         let brace_compensation = if has_braces { BytePos(1) } else { BytePos(0) };
  83
  84         self.last_pos = self.last_pos + brace_compensation;
  85         self.block_indent = self.block_indent.block_indent(self.config);
  86         self.buffer.push_str("{");
  87
  88         for stmt in &b.stmts {
  89             self.visit_stmt(stmt)
  90         }
  91
  92         if !b.stmts.is_empty() {
  93             if let Some(expr) = utils::stmt_expr(&b.stmts[b.stmts.len() - 1]) {
  94                 if utils::semicolon_for_expr(expr) {
  95                     self.buffer.push_str(";");
  96                 }
  97             }
  98         }
  99
 100         // FIXME: we should compress any newlines here to just one
 101         self.format_missing_with_indent(source!(self, b.span).hi - brace_compensation);
 102         self.close_block();
 103         self.last_pos = source!(self, b.span).hi;
 104     }
 105
 106     // FIXME: this is a terrible hack to indent the comments between the last
 107     // item in the block and the closing brace to the block's level.
 108     // The closing brace itself, however, should be indented at a shallower
 109     // level.
 110     fn close_block(&mut self) {
 111         let total_len = self.buffer.len;
 112         let chars_too_many = if self.config.hard_tabs {
 113             1
 114         } else {
 115             self.config.tab_spaces
 116         };
 117         self.buffer.truncate(total_len - chars_too_many);
 118         self.buffer.push_str("}");
 119         self.block_indent = self.block_indent.block_unindent(self.config);
 120     }
 121
 122     // Note that this only gets called for function definitions. Required methods
 123     // on traits do not get handled here.
 124     fn visit_fn(&mut self,
 125                 fk: visit::FnKind,
 126                 fd: &ast::FnDecl,
 127                 b: &ast::Block,
 128                 s: Span,
 129                 _: ast::NodeId,
 130                 defaultness: ast::Defaultness) {
 131         let indent = self.block_indent;
 132         let rewrite = match fk {
 133             visit::FnKind::ItemFn(ident, generics, unsafety, constness, abi, vis) => {
 134                 self.rewrite_fn(indent,
 135                                 ident,
 136                                 fd,
 137                                 generics,
 138                                 unsafety,
 139                                 constness.node,
 140                                 defaultness,
 141                                 abi,
 142                                 vis,
 143                                 codemap::mk_sp(s.lo, b.span.lo),
 144                                 b)
 145             }
 146             visit::FnKind::Method(ident, sig, vis) => {
 147                 self.rewrite_fn(indent,
 148                                 ident,
 149                                 fd,
 150                                 &sig.generics,
 151                                 sig.unsafety,
 152                                 sig.constness.node,
 153                                 defaultness,
 154                                 sig.abi,
 155                                 vis.unwrap_or(&ast::Visibility::Inherited),
 156                                 codemap::mk_sp(s.lo, b.span.lo),
 157                                 b)
 158             }
 159             visit::FnKind::Closure => None,
 160         };
 161
 162         if let Some(fn_str) = rewrite {
 163             self.format_missing_with_indent(source!(self, s).lo);
 164             self.buffer.push_str(&fn_str);
 165             if let Some(c) = fn_str.chars().last() {
 166                 if c == '}' {
 167                     self.last_pos = source!(self, b.span).hi;
 168                     return;
 169                 }
 170             }
 171         } else {
 172             self.format_missing(source!(self, b.span).lo);
 173         }
 174
 175         self.last_pos = source!(self, b.span).lo;
 176         self.visit_block(b)
 177     }
 178
 179     pub fn visit_item(&mut self, item: &ast::Item) {
 180         // This is where we bail out if there is a skip attribute. This is only
 181         // complex in the module case. It is complex because the module could be
 182         // in a seperate file and there might be attributes in both files, but
 183         // the AST lumps them all together.
 184         match item.node {
 185             ast::ItemKind::Mod(ref m) => {
 186                 let outer_file = self.codemap.lookup_char_pos(item.span.lo).file;
 187                 let inner_file = self.codemap.lookup_char_pos(m.inner.lo).file;
 188                 if outer_file.name == inner_file.name {
 189                     // Module is inline, in this case we treat modules like any
 190                     // other item.
 191                     if self.visit_attrs(&item.attrs) {
 192                         self.push_rewrite(item.span, None);
 193                         return;
 194                     }
 195                 } else if utils::contains_skip(&item.attrs) {
 196                     // Module is not inline, but should be skipped.
 197                     return;
 198                 } else {
 199                     // Module is not inline and should not be skipped. We want
 200                     // to process only the attributes in the current file.
 201                     let attrs = item.attrs
 202                         .iter()
 203                         .filter_map(|a| {
 204                             let attr_file = self.codemap.lookup_char_pos(a.span.lo).file;
 205                             if attr_file.name == outer_file.name {
 206                                 Some(a.clone())
 207                             } else {
 208                                 None
 209                             }
 210                         })
 211                         .collect::<Vec<_>>();
 212                     // Assert because if we should skip it should be caught by
 213                     // the above case.
 214                     assert!(!self.visit_attrs(&attrs));
 215                 }
 216             }
 217             _ => {
 218                 if self.visit_attrs(&item.attrs) {
 219                     self.push_rewrite(item.span, None);
 220                     return;
 221                 }
 222             }
 223         }
 224
 225         match item.node {
 226             ast::ItemKind::Use(ref vp) => {
 227                 self.format_import(&item.vis, vp, item.span);
 228             }
 229             ast::ItemKind::Impl(..) => {
 230                 self.format_missing_with_indent(source!(self, item.span).lo);
 231                 if let Some(impl_str) = format_impl(&self.get_context(), item, self.block_indent) {
 232                     self.buffer.push_str(&impl_str);
 233                     self.last_pos = source!(self, item.span).hi;
 234                 }
 235             }
 236             ast::ItemKind::Trait(..) => {
 237                 self.format_missing_with_indent(item.span.lo);
 238                 if let Some(trait_str) = format_trait(&self.get_context(),
 239                                                       item,
 240                                                       self.block_indent) {
 241                     self.buffer.push_str(&trait_str);
 242                     self.last_pos = source!(self, item.span).hi;
 243                 }
 244             }
 245             ast::ItemKind::ExternCrate(_) => {
 246                 self.format_missing_with_indent(source!(self, item.span).lo);
 247                 let new_str = self.snippet(item.span);
 248                 self.buffer.push_str(&new_str);
 249                 self.last_pos = source!(self, item.span).hi;
 250             }
 251             ast::ItemKind::Struct(ref def, ref generics) => {
 252                 let rewrite = {
 253                     let indent = self.block_indent;
 254                     let context = self.get_context();
 255                     ::items::format_struct(&context,
 256                                            "struct ",
 257                                            item.ident,
 258                                            &item.vis,
 259                                            def,
 260                                            Some(generics),
 261                                            item.span,
 262                                            indent,
 263                                            None)
 264                         .map(|s| {
 265                             match *def {
 266                                 ast::VariantData::Tuple(..) => s + ";",
 267                                 _ => s,
 268                             }
 269                         })
 270                 };
 271                 self.push_rewrite(item.span, rewrite);
 272             }
 273             ast::ItemKind::Enum(ref def, ref generics) => {
 274                 self.format_missing_with_indent(source!(self, item.span).lo);
 275                 self.visit_enum(item.ident, &item.vis, def, generics, item.span);
 276                 self.last_pos = source!(self, item.span).hi;
 277             }
 278             ast::ItemKind::Mod(ref module) => {
 279                 self.format_missing_with_indent(source!(self, item.span).lo);
 280                 self.format_mod(module, &item.vis, item.span, item.ident);
 281             }
 282             ast::ItemKind::Mac(ref mac) => {
 283                 self.visit_mac(mac, Some(item.ident));
 284             }
 285             ast::ItemKind::ForeignMod(ref foreign_mod) => {
 286                 self.format_missing_with_indent(source!(self, item.span).lo);
 287                 self.format_foreign_mod(foreign_mod, item.span);
 288             }
 289             ast::ItemKind::Static(ref ty, mutability, ref expr) => {
 290                 let rewrite = rewrite_static("static",
 291                                              &item.vis,
 292                                              item.ident,
 293                                              ty,
 294                                              mutability,
 295                                              Some(expr),
 296                                              &self.get_context());
 297                 self.push_rewrite(item.span, rewrite);
 298             }
 299             ast::ItemKind::Const(ref ty, ref expr) => {
 300                 let rewrite = rewrite_static("const",
 301                                              &item.vis,
 302                                              item.ident,
 303                                              ty,
 304                                              ast::Mutability::Immutable,
 305                                              Some(expr),
 306                                              &self.get_context());
 307                 self.push_rewrite(item.span, rewrite);
 308             }
 309             ast::ItemKind::DefaultImpl(..) => {
 310                 // FIXME(#78): format impl definitions.
 311             }
 312             ast::ItemKind::Fn(ref decl, unsafety, constness, abi, ref generics, ref body) => {
 313                 self.visit_fn(visit::FnKind::ItemFn(item.ident,
 314                                                     generics,
 315                                                     unsafety,
 316                                                     constness,
 317                                                     abi,
 318                                                     &item.vis),
 319                               decl,
 320                               body,
 321                               item.span,
 322                               item.id,
 323                               ast::Defaultness::Final)
 324             }
 325             ast::ItemKind::Ty(ref ty, ref generics) => {
 326                 let rewrite = rewrite_type_alias(&self.get_context(),
 327                                                  self.block_indent,
 328                                                  item.ident,
 329                                                  ty,
 330                                                  generics,
 331                                                  &item.vis,
 332                                                  item.span);
 333                 self.push_rewrite(item.span, rewrite);
 334             }
 335             ast::ItemKind::Union(..) => {
 336                 // FIXME(#1157): format union definitions.
 337             }
 338         }
 339     }
 340
 341     pub fn visit_trait_item(&mut self, ti: &ast::TraitItem) {
 342         if self.visit_attrs(&ti.attrs) {
 343             self.push_rewrite(ti.span, None);
 344             return;
 345         }
 346
 347         match ti.node {
 348             ast::TraitItemKind::Const(ref ty, ref expr_opt) => {
 349                 let rewrite = rewrite_static("const",
 350                                              &ast::Visibility::Inherited,
 351                                              ti.ident,
 352                                              ty,
 353                                              ast::Mutability::Immutable,
 354                                              expr_opt.as_ref(),
 355                                              &self.get_context());
 356                 self.push_rewrite(ti.span, rewrite);
 357             }
 358             ast::TraitItemKind::Method(ref sig, None) => {
 359                 let indent = self.block_indent;
 360                 let rewrite = self.rewrite_required_fn(indent, ti.ident, sig, ti.span);
 361                 self.push_rewrite(ti.span, rewrite);
 362             }
 363             ast::TraitItemKind::Method(ref sig, Some(ref body)) => {
 364                 self.visit_fn(visit::FnKind::Method(ti.ident, sig, None),
 365                               &sig.decl,
 366                               body,
 367                               ti.span,
 368                               ti.id,
 369                               ast::Defaultness::Final);
 370             }
 371             ast::TraitItemKind::Type(ref type_param_bounds, _) => {
 372                 let rewrite = rewrite_associated_type(ti.ident,
 373                                                       None,
 374                                                       Some(type_param_bounds),
 375                                                       &self.get_context(),
 376                                                       self.block_indent);
 377                 self.push_rewrite(ti.span, rewrite);
 378             }
 379             ast::TraitItemKind::Macro(..) => {
 380                 // FIXME(#1158) Macros in trait item position
 381             }
 382         }
 383     }
 384
 385     pub fn visit_impl_item(&mut self, ii: &ast::ImplItem) {
 386         if self.visit_attrs(&ii.attrs) {
 387             self.push_rewrite(ii.span, None);
 388             return;
 389         }
 390
 391         match ii.node {
 392             ast::ImplItemKind::Method(ref sig, ref body) => {
 393                 self.visit_fn(visit::FnKind::Method(ii.ident, sig, Some(&ii.vis)),
 394                               &sig.decl,
 395                               body,
 396                               ii.span,
 397                               ii.id,
 398                               ii.defaultness);
 399             }
 400             ast::ImplItemKind::Const(ref ty, ref expr) => {
 401                 let rewrite = rewrite_static("const",
 402                                              &ii.vis,
 403                                              ii.ident,
 404                                              ty,
 405                                              ast::Mutability::Immutable,
 406                                              Some(expr),
 407                                              &self.get_context());
 408                 self.push_rewrite(ii.span, rewrite);
 409             }
 410             ast::ImplItemKind::Type(ref ty) => {
 411                 let rewrite = rewrite_associated_type(ii.ident,
 412                                                       Some(ty),
 413                                                       None,
 414                                                       &self.get_context(),
 415                                                       self.block_indent);
 416                 self.push_rewrite(ii.span, rewrite);
 417             }
 418             ast::ImplItemKind::Macro(ref mac) => {
 419                 self.visit_mac(mac, Some(ii.ident));
 420             }
 421         }
 422     }
 423
 424     fn visit_mac(&mut self, mac: &ast::Mac, ident: Option<ast::Ident>) {
 425         // 1 = ;
 426         let width = self.config.max_width - self.block_indent.width() - 1;
 427         let rewrite = rewrite_macro(mac, ident, &self.get_context(), width, self.block_indent);
 428         self.push_rewrite(mac.span, rewrite);
 429     }
 430
 431     fn push_rewrite(&mut self, span: Span, rewrite: Option<String>) {
 432         self.format_missing_with_indent(source!(self, span).lo);
 433         let result = rewrite.unwrap_or_else(|| self.snippet(span));
 434         self.buffer.push_str(&result);
 435         self.last_pos = source!(self, span).hi;
 436     }
 437
 438     pub fn from_codemap(parse_session: &'a ParseSess, config: &'a Config) -> FmtVisitor<'a> {
 439         FmtVisitor {
 440             parse_session: parse_session,
 441             codemap: parse_session.codemap(),
 442             buffer: StringBuffer::new(),
 443             last_pos: BytePos(0),
 444             block_indent: Indent {
 445                 block_indent: 0,
 446                 alignment: 0,
 447             },
 448             config: config,
 449         }
 450     }
 451
 452     pub fn snippet(&self, span: Span) -> String {
 453         match self.codemap.span_to_snippet(span) {
 454             Ok(s) => s,
 455             Err(_) => {
 456                 println!("Couldn't make snippet for span {:?}->{:?}",
 457                          self.codemap.lookup_char_pos(span.lo),
 458                          self.codemap.lookup_char_pos(span.hi));
 459                 "".to_owned()
 460             }
 461         }
 462     }
 463
 464     // Returns true if we should skip the following item.
 465     pub fn visit_attrs(&mut self, attrs: &[ast::Attribute]) -> bool {
 466         if utils::contains_skip(attrs) {
 467             return true;
 468         }
 469
 470         let outers: Vec<_> = attrs.iter()
 471             .filter(|a| a.node.style == ast::AttrStyle::Outer)
 472             .cloned()
 473             .collect();
 474         if outers.is_empty() {
 475             return false;
 476         }
 477
 478         let first = &outers[0];
 479         self.format_missing_with_indent(source!(self, first.span).lo);
 480
 481         let rewrite = outers.rewrite(&self.get_context(),
 482                      self.config.max_width - self.block_indent.width(),
 483                      self.block_indent)
 484             .unwrap();
 485         self.buffer.push_str(&rewrite);
 486         let last = outers.last().unwrap();
 487         self.last_pos = source!(self, last.span).hi;
 488         false
 489     }
 490
 491     fn walk_mod_items(&mut self, m: &ast::Mod) {
 492         let mut items_left: &[ptr::P<ast::Item>] = &m.items;
 493         while !items_left.is_empty() {
 494             // If the next item is a `use` declaration, then extract it and any subsequent `use`s
 495             // to be potentially reordered within `format_imports`. Otherwise, just format the
 496             // next item for output.
 497             if self.config.reorder_imports && is_use_item(&*items_left[0]) {
 498                 let use_item_length =
 499                     items_left.iter().take_while(|ppi| is_use_item(&***ppi)).count();
 500                 let (use_items, rest) = items_left.split_at(use_item_length);
 501                 self.format_imports(use_items);
 502                 items_left = rest;
 503             } else {
 504                 // `unwrap()` is safe here because we know `items_left`
 505                 // has elements from the loop condition
 506                 let (item, rest) = items_left.split_first().unwrap();
 507                 self.visit_item(item);
 508                 items_left = rest;
 509             }
 510         }
 511     }
 512
 513     fn format_mod(&mut self, m: &ast::Mod, vis: &ast::Visibility, s: Span, ident: ast::Ident) {
 514         // Decide whether this is an inline mod or an external mod.
 515         let local_file_name = self.codemap.span_to_filename(s);
 516         let is_internal = local_file_name == self.codemap.span_to_filename(source!(self, m.inner));
 517
 518         self.buffer.push_str(&*utils::format_visibility(vis));
 519         self.buffer.push_str("mod ");
 520         self.buffer.push_str(&ident.to_string());
 521
 522         if is_internal {
 523             self.buffer.push_str(" {");
 524             // Hackery to account for the closing }.
 525             let mod_lo = self.codemap.span_after(source!(self, s), "{");
 526             let body_snippet =
 527                 self.snippet(codemap::mk_sp(mod_lo, source!(self, m.inner).hi - BytePos(1)));
 528             let body_snippet = body_snippet.trim();
 529             if body_snippet.is_empty() {
 530                 self.buffer.push_str("}");
 531             } else {
 532                 self.last_pos = mod_lo;
 533                 self.block_indent = self.block_indent.block_indent(self.config);
 534                 self.walk_mod_items(m);
 535                 self.format_missing_with_indent(source!(self, m.inner).hi - BytePos(1));
 536                 self.close_block();
 537             }
 538             self.last_pos = source!(self, m.inner).hi;
 539         } else {
 540             self.buffer.push_str(";");
 541             self.last_pos = source!(self, s).hi;
 542         }
 543     }
 544
 545     pub fn format_separate_mod(&mut self, m: &ast::Mod) {
 546         let filemap = self.codemap.lookup_char_pos(source!(self, m.inner).lo).file;
 547         self.last_pos = filemap.start_pos;
 548         self.block_indent = Indent::empty();
 549         self.walk_mod_items(m);
 550         self.format_missing_with_indent(filemap.end_pos);
 551     }
 552
 553     pub fn get_context(&self) -> RewriteContext {
 554         RewriteContext {
 555             parse_session: self.parse_session,
 556             codemap: self.codemap,
 557             config: self.config,
 558             block_indent: self.block_indent,
 559         }
 560     }
 561 }
 562
 563 impl<'a> Rewrite for [ast::Attribute] {
 564     fn rewrite(&self, context: &RewriteContext, _: usize, offset: Indent) -> Option<String> {
 565         let mut result = String::new();
 566         if self.is_empty() {
 567             return Some(result);
 568         }
 569         let indent = offset.to_string(context.config);
 570
 571         for (i, a) in self.iter().enumerate() {
 572             let mut a_str = context.snippet(a.span);
 573
 574             // Write comments and blank lines between attributes.
 575             if i > 0 {
 576                 let comment = context.snippet(codemap::mk_sp(self[i - 1].span.hi, a.span.lo));
 577                 // This particular horror show is to preserve line breaks in between doc
 578                 // comments. An alternative would be to force such line breaks to start
 579                 // with the usual doc comment token.
 580                 let multi_line = a_str.starts_with("//") && comment.matches('\n').count() > 1;
 581                 let comment = comment.trim();
 582                 if !comment.is_empty() {
 583                     let comment = try_opt!(rewrite_comment(comment,
 584                                                            false,
 585                                                            context.config.ideal_width -
 586                                                            offset.width(),
 587                                                            offset,
 588                                                            context.config));
 589                     result.push_str(&indent);
 590                     result.push_str(&comment);
 591                     result.push('\n');
 592                 } else if multi_line {
 593                     result.push('\n');
 594                 }
 595                 result.push_str(&indent);
 596             }
 597
 598             if a_str.starts_with("//") {
 599                 a_str = try_opt!(rewrite_comment(&a_str,
 600                                                  false,
 601                                                  context.config.ideal_width - offset.width(),
 602                                                  offset,
 603                                                  context.config));
 604             }
 605
 606             // Write the attribute itself.
 607             result.push_str(&a_str);
 608
 609             if i < self.len() - 1 {
 610                 result.push('\n');
 611             }
 612         }
 613
 614         Some(result)
 615     }
 616 }