src/formatting.rs

   1 // High level formatting functions.
   2
   3 use std::collections::HashMap;
   4 use std::io::{self, Write};
   5 use std::panic::{catch_unwind, AssertUnwindSafe};
   6 use std::rc::Rc;
   7 use std::time::{Duration, Instant};
   8
   9 use syntax::ast;
  10 use syntax::errors::emitter::{ColorConfig, EmitterWriter};
  11 use syntax::errors::Handler;
  12 use syntax::parse::{self, ParseSess};
  13 use syntax::source_map::{FilePathMapping, SourceMap, Span};
  14
  15 use comment::{CharClasses, FullCodeCharKind};
  16 use config::{Config, FileName, Verbosity};
  17 use issues::BadIssueSeeker;
  18 use visitor::{FmtVisitor, SnippetProvider};
  19 use {modules, source_file, ErrorKind, FormatReport, Input, Session};
  20
  21 // A map of the files of a crate, with their new content
  22 pub(crate) type SourceFile = Vec<FileRecord>;
  23 pub(crate) type FileRecord = (FileName, String);
  24
  25 impl<'b, T: Write + 'b> Session<'b, T> {
  26     pub(crate) fn format_input_inner(&mut self, input: Input) -> Result<FormatReport, ErrorKind> {
  27         if !self.config.version_meets_requirement() {
  28             return Err(ErrorKind::VersionMismatch);
  29         }
  30
  31         syntax::with_globals(|| {
  32             syntax_pos::hygiene::set_default_edition(
  33                 self.config.edition().to_libsyntax_pos_edition(),
  34             );
  35
  36             if self.config.disable_all_formatting() {
  37                 // When the input is from stdin, echo back the input.
  38                 if let Input::Text(ref buf) = input {
  39                     if let Err(e) = io::stdout().write_all(buf.as_bytes()) {
  40                         return Err(From::from(e));
  41                     }
  42                 }
  43                 return Ok(FormatReport::new());
  44             }
  45
  46             let config = &self.config.clone();
  47             let format_result = format_project(input, config, self);
  48
  49             format_result.map(|report| {
  50                 {
  51                     let new_errors = &report.internal.borrow().1;
  52
  53                     self.errors.add(new_errors);
  54                 }
  55                 report
  56             })
  57         })
  58     }
  59 }
  60
  61 // Format an entire crate (or subset of the module tree).
  62 fn format_project<T: FormatHandler>(
  63     input: Input,
  64     config: &Config,
  65     handler: &mut T,
  66 ) -> Result<FormatReport, ErrorKind> {
  67     let mut timer = Timer::start();
  68
  69     let main_file = input.file_name();
  70     let input_is_stdin = main_file == FileName::Stdin;
  71
  72     // Parse the crate.
  73     let source_map = Rc::new(SourceMap::new(FilePathMapping::empty()));
  74     let mut parse_session = make_parse_sess(source_map.clone(), config);
  75     let mut report = FormatReport::new();
  76     let krate = parse_crate(input, &parse_session, config, &mut report)?;
  77     timer = timer.done_parsing();
  78
  79     // Suppress error output if we have to do any further parsing.
  80     let silent_emitter = silent_emitter(source_map);
  81     parse_session.span_diagnostic = Handler::with_emitter(true, false, silent_emitter);
  82
  83     let mut context = FormatContext::new(&krate, report, parse_session, config, handler);
  84
  85     let files = modules::list_files(&krate, context.parse_session.source_map())?;
  86     for (path, module) in files {
  87         if (config.skip_children() && path != main_file) || config.ignore().skip_file(&path) {
  88             continue;
  89         }
  90         should_emit_verbose(input_is_stdin, config, || println!("Formatting {}", path));
  91         let is_root = path == main_file;
  92         context.format_file(path, module, is_root)?;
  93     }
  94     timer = timer.done_formatting();
  95
  96     should_emit_verbose(input_is_stdin, config, || {
  97         println!(
  98             "Spent {0:.3} secs in the parsing phase, and {1:.3} secs in the formatting phase",
  99             timer.get_parse_time(),
 100             timer.get_format_time(),
 101         )
 102     });
 103
 104     Ok(context.report)
 105 }
 106
 107 // Used for formatting files.
 108 #[derive(new)]
 109 struct FormatContext<'a, T: FormatHandler + 'a> {
 110     krate: &'a ast::Crate,
 111     report: FormatReport,
 112     parse_session: ParseSess,
 113     config: &'a Config,
 114     handler: &'a mut T,
 115 }
 116
 117 impl<'a, T: FormatHandler + 'a> FormatContext<'a, T> {
 118     // Formats a single file/module.
 119     fn format_file(
 120         &mut self,
 121         path: FileName,
 122         module: &ast::Mod,
 123         is_root: bool,
 124     ) -> Result<(), ErrorKind> {
 125         let source_file = self
 126             .parse_session
 127             .source_map()
 128             .lookup_char_pos(module.inner.lo())
 129             .file;
 130         let big_snippet = source_file.src.as_ref().unwrap();
 131         let snippet_provider = SnippetProvider::new(source_file.start_pos, big_snippet);
 132         let mut visitor = FmtVisitor::from_source_map(
 133             &self.parse_session,
 134             &self.config,
 135             &snippet_provider,
 136             self.report.clone(),
 137         );
 138
 139         // Format inner attributes if available.
 140         if !self.krate.attrs.is_empty() && is_root {
 141             visitor.skip_empty_lines(source_file.end_pos);
 142             if visitor.visit_attrs(&self.krate.attrs, ast::AttrStyle::Inner) {
 143                 visitor.push_rewrite(module.inner, None);
 144             } else {
 145                 visitor.format_separate_mod(module, &*source_file);
 146             }
 147         } else {
 148             visitor.last_pos = source_file.start_pos;
 149             visitor.skip_empty_lines(source_file.end_pos);
 150             visitor.format_separate_mod(module, &*source_file);
 151         };
 152
 153         debug_assert_eq!(
 154             visitor.line_number,
 155             ::utils::count_newlines(&visitor.buffer)
 156         );
 157
 158         // For some reason, the source_map does not include terminating
 159         // newlines so we must add one on for each file. This is sad.
 160         source_file::append_newline(&mut visitor.buffer);
 161
 162         format_lines(
 163             &mut visitor.buffer,
 164             &path,
 165             &visitor.skipped_range,
 166             &self.config,
 167             &self.report,
 168         );
 169         self.config
 170             .newline_style()
 171             .apply(&mut visitor.buffer, &big_snippet);
 172
 173         if visitor.macro_rewrite_failure {
 174             self.report.add_macro_format_failure();
 175         }
 176
 177         self.handler
 178             .handle_formatted_file(path, visitor.buffer.to_owned(), &mut self.report)
 179     }
 180 }
 181
 182 // Handle the results of formatting.
 183 trait FormatHandler {
 184     fn handle_formatted_file(
 185         &mut self,
 186         path: FileName,
 187         result: String,
 188         report: &mut FormatReport,
 189     ) -> Result<(), ErrorKind>;
 190 }
 191
 192 impl<'b, T: Write + 'b> FormatHandler for Session<'b, T> {
 193     // Called for each formatted file.
 194     fn handle_formatted_file(
 195         &mut self,
 196         path: FileName,
 197         result: String,
 198         report: &mut FormatReport,
 199     ) -> Result<(), ErrorKind> {
 200         if let Some(ref mut out) = self.out {
 201             match source_file::write_file(&result, &path, out, &self.config) {
 202                 Ok(b) if b => report.add_diff(),
 203                 Err(e) => {
 204                     // Create a new error with path_str to help users see which files failed
 205                     let err_msg = format!("{}: {}", path, e);
 206                     return Err(io::Error::new(e.kind(), err_msg).into());
 207                 }
 208                 _ => {}
 209             }
 210         }
 211
 212         self.source_file.push((path, result));
 213         Ok(())
 214     }
 215 }
 216
 217 pub(crate) struct FormattingError {
 218     pub(crate) line: usize,
 219     pub(crate) kind: ErrorKind,
 220     is_comment: bool,
 221     is_string: bool,
 222     pub(crate) line_buffer: String,
 223 }
 224
 225 impl FormattingError {
 226     pub(crate) fn from_span(
 227         span: Span,
 228         source_map: &SourceMap,
 229         kind: ErrorKind,
 230     ) -> FormattingError {
 231         FormattingError {
 232             line: source_map.lookup_char_pos(span.lo()).line,
 233             is_comment: kind.is_comment(),
 234             kind,
 235             is_string: false,
 236             line_buffer: source_map
 237                 .span_to_lines(span)
 238                 .ok()
 239                 .and_then(|fl| {
 240                     fl.file
 241                         .get_line(fl.lines[0].line_index)
 242                         .map(|l| l.into_owned())
 243                 })
 244                 .unwrap_or_else(String::new),
 245         }
 246     }
 247
 248     pub(crate) fn msg_prefix(&self) -> &str {
 249         match self.kind {
 250             ErrorKind::LineOverflow(..)
 251             | ErrorKind::TrailingWhitespace
 252             | ErrorKind::IoError(_)
 253             | ErrorKind::ParseError
 254             | ErrorKind::LostComment => "internal error:",
 255             ErrorKind::LicenseCheck | ErrorKind::BadAttr | ErrorKind::VersionMismatch => "error:",
 256             ErrorKind::BadIssue(_) | ErrorKind::DeprecatedAttr => "warning:",
 257         }
 258     }
 259
 260     pub(crate) fn msg_suffix(&self) -> &str {
 261         if self.is_comment || self.is_string {
 262             "set `error_on_unformatted = false` to suppress \
 263              the warning against comments or string literals\n"
 264         } else {
 265             ""
 266         }
 267     }
 268
 269     // (space, target)
 270     pub(crate) fn format_len(&self) -> (usize, usize) {
 271         match self.kind {
 272             ErrorKind::LineOverflow(found, max) => (max, found - max),
 273             ErrorKind::TrailingWhitespace
 274             | ErrorKind::DeprecatedAttr
 275             | ErrorKind::BadIssue(_)
 276             | ErrorKind::BadAttr
 277             | ErrorKind::LostComment => {
 278                 let trailing_ws_start = self
 279                     .line_buffer
 280                     .rfind(|c: char| !c.is_whitespace())
 281                     .map(|pos| pos + 1)
 282                     .unwrap_or(0);
 283                 (
 284                     trailing_ws_start,
 285                     self.line_buffer.len() - trailing_ws_start,
 286                 )
 287             }
 288             _ => unreachable!(),
 289         }
 290     }
 291 }
 292
 293 pub(crate) type FormatErrorMap = HashMap<FileName, Vec<FormattingError>>;
 294
 295 #[derive(Default, Debug)]
 296 pub(crate) struct ReportedErrors {
 297     // Encountered e.g. an IO error.
 298     pub(crate) has_operational_errors: bool,
 299
 300     // Failed to reformat code because of parsing errors.
 301     pub(crate) has_parsing_errors: bool,
 302
 303     // Code is valid, but it is impossible to format it properly.
 304     pub(crate) has_formatting_errors: bool,
 305
 306     // Code contains macro call that was unable to format.
 307     pub(crate) has_macro_format_failure: bool,
 308
 309     // Failed a check, such as the license check or other opt-in checking.
 310     pub(crate) has_check_errors: bool,
 311
 312     /// Formatted code differs from existing code (--check only).
 313     pub(crate) has_diff: bool,
 314 }
 315
 316 impl ReportedErrors {
 317     /// Combine two summaries together.
 318     pub fn add(&mut self, other: &ReportedErrors) {
 319         self.has_operational_errors |= other.has_operational_errors;
 320         self.has_parsing_errors |= other.has_parsing_errors;
 321         self.has_formatting_errors |= other.has_formatting_errors;
 322         self.has_macro_format_failure |= other.has_macro_format_failure;
 323         self.has_check_errors |= other.has_check_errors;
 324         self.has_diff |= other.has_diff;
 325     }
 326 }
 327
 328 /// A single span of changed lines, with 0 or more removed lines
 329 /// and a vector of 0 or more inserted lines.
 330 #[derive(Debug, PartialEq, Eq)]
 331 pub(crate) struct ModifiedChunk {
 332     /// The first to be removed from the original text
 333     pub line_number_orig: u32,
 334     /// The number of lines which have been replaced
 335     pub lines_removed: u32,
 336     /// The new lines
 337     pub lines: Vec<String>,
 338 }
 339
 340 /// Set of changed sections of a file.
 341 #[derive(Debug, PartialEq, Eq)]
 342 pub(crate) struct ModifiedLines {
 343     /// The set of changed chunks.
 344     pub chunks: Vec<ModifiedChunk>,
 345 }
 346
 347 #[derive(Clone, Copy, Debug)]
 348 enum Timer {
 349     Disabled,
 350     Initialized(Instant),
 351     DoneParsing(Instant, Instant),
 352     DoneFormatting(Instant, Instant, Instant),
 353 }
 354
 355 impl Timer {
 356     fn start() -> Timer {
 357         if cfg!(target_arch = "wasm32") {
 358             Timer::Disabled
 359         } else {
 360             Timer::Initialized(Instant::now())
 361         }
 362     }
 363     fn done_parsing(self) -> Self {
 364         match self {
 365             Timer::Disabled => Timer::Disabled,
 366             Timer::Initialized(init_time) => Timer::DoneParsing(init_time, Instant::now()),
 367             _ => panic!("Timer can only transition to DoneParsing from Initialized state"),
 368         }
 369     }
 370
 371     fn done_formatting(self) -> Self {
 372         match self {
 373             Timer::Disabled => Timer::Disabled,
 374             Timer::DoneParsing(init_time, parse_time) => {
 375                 Timer::DoneFormatting(init_time, parse_time, Instant::now())
 376             }
 377             _ => panic!("Timer can only transition to DoneFormatting from DoneParsing state"),
 378         }
 379     }
 380
 381     /// Returns the time it took to parse the source files in seconds.
 382     fn get_parse_time(&self) -> f32 {
 383         match *self {
 384             Timer::Disabled => panic!("this platform cannot time execution"),
 385             Timer::DoneParsing(init, parse_time) | Timer::DoneFormatting(init, parse_time, _) => {
 386                 // This should never underflow since `Instant::now()` guarantees monotonicity.
 387                 Self::duration_to_f32(parse_time.duration_since(init))
 388             }
 389             Timer::Initialized(..) => unreachable!(),
 390         }
 391     }
 392
 393     /// Returns the time it took to go from the parsed AST to the formatted output. Parsing time is
 394     /// not included.
 395     fn get_format_time(&self) -> f32 {
 396         match *self {
 397             Timer::Disabled => panic!("this platform cannot time execution"),
 398             Timer::DoneFormatting(_init, parse_time, format_time) => {
 399                 Self::duration_to_f32(format_time.duration_since(parse_time))
 400             }
 401             Timer::DoneParsing(..) | Timer::Initialized(..) => unreachable!(),
 402         }
 403     }
 404
 405     fn duration_to_f32(d: Duration) -> f32 {
 406         d.as_secs() as f32 + d.subsec_nanos() as f32 / 1_000_000_000f32
 407     }
 408 }
 409
 410 // Formatting done on a char by char or line by line basis.
 411 // FIXME(#20) other stuff for parity with make tidy
 412 fn format_lines(
 413     text: &mut String,
 414     name: &FileName,
 415     skipped_range: &[(usize, usize)],
 416     config: &Config,
 417     report: &FormatReport,
 418 ) {
 419     let mut formatter = FormatLines::new(name, skipped_range, config);
 420     formatter.check_license(text);
 421     formatter.iterate(text);
 422
 423     if formatter.newline_count > 1 {
 424         debug!("track truncate: {} {}", text.len(), formatter.newline_count);
 425         let line = text.len() - formatter.newline_count + 1;
 426         text.truncate(line);
 427     }
 428
 429     report.append(name.clone(), formatter.errors);
 430 }
 431
 432 struct FormatLines<'a> {
 433     name: &'a FileName,
 434     skipped_range: &'a [(usize, usize)],
 435     last_was_space: bool,
 436     line_len: usize,
 437     cur_line: usize,
 438     newline_count: usize,
 439     errors: Vec<FormattingError>,
 440     issue_seeker: BadIssueSeeker,
 441     line_buffer: String,
 442     // true if the current line contains a string literal.
 443     is_string: bool,
 444     format_line: bool,
 445     allow_issue_seek: bool,
 446     config: &'a Config,
 447 }
 448
 449 impl<'a> FormatLines<'a> {
 450     fn new(
 451         name: &'a FileName,
 452         skipped_range: &'a [(usize, usize)],
 453         config: &'a Config,
 454     ) -> FormatLines<'a> {
 455         let issue_seeker = BadIssueSeeker::new(config.report_todo(), config.report_fixme());
 456         FormatLines {
 457             name,
 458             skipped_range,
 459             last_was_space: false,
 460             line_len: 0,
 461             cur_line: 1,
 462             newline_count: 0,
 463             errors: vec![],
 464             allow_issue_seek: !issue_seeker.is_disabled(),
 465             issue_seeker,
 466             line_buffer: String::with_capacity(config.max_width() * 2),
 467             is_string: false,
 468             format_line: config.file_lines().contains_line(name, 1),
 469             config,
 470         }
 471     }
 472
 473     fn check_license(&mut self, text: &mut String) {
 474         if let Some(ref license_template) = self.config.license_template {
 475             if !license_template.is_match(text) {
 476                 self.errors.push(FormattingError {
 477                     line: self.cur_line,
 478                     kind: ErrorKind::LicenseCheck,
 479                     is_comment: false,
 480                     is_string: false,
 481                     line_buffer: String::new(),
 482                 });
 483             }
 484         }
 485     }
 486
 487     // Iterate over the chars in the file map.
 488     fn iterate(&mut self, text: &mut String) {
 489         for (kind, c) in CharClasses::new(text.chars()) {
 490             if c == '\r' {
 491                 continue;
 492             }
 493
 494             if self.allow_issue_seek && self.format_line {
 495                 // Add warnings for bad todos/ fixmes
 496                 if let Some(issue) = self.issue_seeker.inspect(c) {
 497                     self.push_err(ErrorKind::BadIssue(issue), false, false);
 498                 }
 499             }
 500
 501             if c == '\n' {
 502                 self.new_line(kind);
 503             } else {
 504                 self.char(c, kind);
 505             }
 506         }
 507     }
 508
 509     fn new_line(&mut self, kind: FullCodeCharKind) {
 510         if self.format_line {
 511             // Check for (and record) trailing whitespace.
 512             if self.last_was_space {
 513                 if self.should_report_error(kind, &ErrorKind::TrailingWhitespace)
 514                     && !self.is_skipped_line()
 515                 {
 516                     self.push_err(
 517                         ErrorKind::TrailingWhitespace,
 518                         kind.is_comment(),
 519                         kind.is_string(),
 520                     );
 521                 }
 522                 self.line_len -= 1;
 523             }
 524
 525             // Check for any line width errors we couldn't correct.
 526             let error_kind = ErrorKind::LineOverflow(self.line_len, self.config.max_width());
 527             if self.line_len > self.config.max_width()
 528                 && !self.is_skipped_line()
 529                 && self.should_report_error(kind, &error_kind)
 530             {
 531                 self.push_err(error_kind, kind.is_comment(), self.is_string);
 532             }
 533         }
 534
 535         self.line_len = 0;
 536         self.cur_line += 1;
 537         self.format_line = self
 538             .config
 539             .file_lines()
 540             .contains_line(self.name, self.cur_line);
 541         self.newline_count += 1;
 542         self.last_was_space = false;
 543         self.line_buffer.clear();
 544         self.is_string = false;
 545     }
 546
 547     fn char(&mut self, c: char, kind: FullCodeCharKind) {
 548         self.newline_count = 0;
 549         self.line_len += if c == '\t' {
 550             self.config.tab_spaces()
 551         } else {
 552             1
 553         };
 554         self.last_was_space = c.is_whitespace();
 555         self.line_buffer.push(c);
 556         if kind.is_string() {
 557             self.is_string = true;
 558         }
 559     }
 560
 561     fn push_err(&mut self, kind: ErrorKind, is_comment: bool, is_string: bool) {
 562         self.errors.push(FormattingError {
 563             line: self.cur_line,
 564             kind,
 565             is_comment,
 566             is_string,
 567             line_buffer: self.line_buffer.clone(),
 568         });
 569     }
 570
 571     fn should_report_error(&self, char_kind: FullCodeCharKind, error_kind: &ErrorKind) -> bool {
 572         let allow_error_report =
 573             if char_kind.is_comment() || self.is_string || error_kind.is_comment() {
 574                 self.config.error_on_unformatted()
 575             } else {
 576                 true
 577             };
 578
 579         match error_kind {
 580             ErrorKind::LineOverflow(..) => {
 581                 self.config.error_on_line_overflow() && allow_error_report
 582             }
 583             ErrorKind::TrailingWhitespace | ErrorKind::LostComment => allow_error_report,
 584             _ => true,
 585         }
 586     }
 587
 588     /// Returns true if the line with the given line number was skipped by `#[rustfmt::skip]`.
 589     fn is_skipped_line(&self) -> bool {
 590         self.skipped_range
 591             .iter()
 592             .any(|&(lo, hi)| lo <= self.cur_line && self.cur_line <= hi)
 593     }
 594 }
 595
 596 fn parse_crate(
 597     input: Input,
 598     parse_session: &ParseSess,
 599     config: &Config,
 600     report: &mut FormatReport,
 601 ) -> Result<ast::Crate, ErrorKind> {
 602     let input_is_stdin = input.is_text();
 603
 604     let mut parser = match input {
 605         Input::File(file) => parse::new_parser_from_file(parse_session, &file),
 606         Input::Text(text) => parse::new_parser_from_source_str(
 607             parse_session,
 608             syntax::source_map::FileName::Custom("stdin".to_owned()),
 609             text,
 610         ),
 611     };
 612
 613     parser.cfg_mods = false;
 614     if config.skip_children() {
 615         parser.recurse_into_file_modules = false;
 616     }
 617
 618     let mut parser = AssertUnwindSafe(parser);
 619     let result = catch_unwind(move || parser.0.parse_crate_mod());
 620
 621     match result {
 622         Ok(Ok(c)) => {
 623             if !parse_session.span_diagnostic.has_errors() {
 624                 return Ok(c);
 625             }
 626         }
 627         Ok(Err(mut e)) => e.emit(),
 628         Err(_) => {
 629             // Note that if you see this message and want more information,
 630             // then run the `parse_crate_mod` function above without
 631             // `catch_unwind` so rustfmt panics and you can get a backtrace.
 632             should_emit_verbose(input_is_stdin, config, || {
 633                 println!("The Rust parser panicked")
 634             });
 635         }
 636     }
 637
 638     report.add_parsing_error();
 639     Err(ErrorKind::ParseError)
 640 }
 641
 642 fn silent_emitter(source_map: Rc<SourceMap>) -> Box<EmitterWriter> {
 643     Box::new(EmitterWriter::new(
 644         Box::new(Vec::new()),
 645         Some(source_map),
 646         false,
 647         false,
 648     ))
 649 }
 650
 651 fn make_parse_sess(source_map: Rc<SourceMap>, config: &Config) -> ParseSess {
 652     let tty_handler = if config.hide_parse_errors() {
 653         let silent_emitter = silent_emitter(source_map.clone());
 654         Handler::with_emitter(true, false, silent_emitter)
 655     } else {
 656         let supports_color = term::stderr().map_or(false, |term| term.supports_color());
 657         let color_cfg = if supports_color {
 658             ColorConfig::Auto
 659         } else {
 660             ColorConfig::Never
 661         };
 662         Handler::with_tty_emitter(color_cfg, true, false, Some(source_map.clone()))
 663     };
 664
 665     ParseSess::with_span_handler(tty_handler, source_map)
 666 }
 667
 668 fn should_emit_verbose<F>(is_stdin: bool, config: &Config, f: F)
 669 where
 670     F: Fn(),
 671 {
 672     if config.verbose() == Verbosity::Verbose && !is_stdin {
 673         f();
 674     }
 675 }