1 #![feature(rustc_private)]
2 #![deny(rust_2018_idioms)]
3 #![warn(unreachable_pub)]
4 #![recursion_limit = "256"]
5 #![allow(clippy::match_like_matches_macro)]
6 #![allow(unreachable_pub)]
9 extern crate derive_new;
12 extern crate lazy_static;
16 // N.B. these crates are loaded from the sysroot, so they need extern crate.
17 extern crate rustc_ast;
18 extern crate rustc_ast_pretty;
19 extern crate rustc_builtin_macros;
20 extern crate rustc_data_structures;
21 extern crate rustc_errors;
22 extern crate rustc_expand;
23 extern crate rustc_parse;
24 extern crate rustc_session;
25 extern crate rustc_span;
27 use std::cell::RefCell;
28 use std::collections::HashMap;
30 use std::io::{self, Write};
33 use std::path::PathBuf;
37 use rustc_span::symbol;
40 use crate::comment::LineClasses;
41 use crate::emitter::Emitter;
42 use crate::formatting::{FormatErrorMap, FormattingError, ReportedErrors, SourceFile};
43 use crate::modules::ModuleResolutionError;
44 use crate::parse::parser::DirectoryOwnership;
45 use crate::shape::Indent;
46 use crate::utils::indent_next_line;
48 pub use crate::config::{
49 load_config, CliOptions, Color, Config, Edition, EmitMode, FileLines, FileName, NewlineStyle,
53 pub use crate::format_report_formatter::{FormatReportFormatter, FormatReportFormatterBuilder};
55 pub use crate::rustfmt_diff::{ModifiedChunk, ModifiedLines};
64 pub(crate) mod config;
68 mod format_report_formatter;
69 pub(crate) mod formatting;
77 pub(crate) mod modules;
85 pub(crate) mod rustfmt_diff;
88 pub(crate) mod source_file;
89 pub(crate) mod source_map;
97 pub(crate) mod visitor;
99 /// The various errors that can occur during formatting. Note that not all of
100 /// these can currently be propagated to clients.
101 #[derive(Error, Debug)]
103 /// Line has exceeded character limit (found, maximum).
105 "line formatted, but exceeded maximum width \
106 (maximum: {1} (see `max_width` option), found: {0})"
108 LineOverflow(usize, usize),
109 /// Line ends in whitespace.
110 #[error("left behind trailing whitespace")]
112 /// Used deprecated skip attribute.
113 #[error("`rustfmt_skip` is deprecated; use `rustfmt::skip`")]
115 /// Used a rustfmt:: attribute other than skip or skip::macros.
116 #[error("invalid attribute")]
118 /// An io error during reading or writing.
119 #[error("io error: {0}")]
121 /// Error during module resolution.
123 ModuleResolutionError(#[from] ModuleResolutionError),
124 /// Parse error occurred when parsing the input.
125 #[error("parse error")]
127 /// The user mandated a version and the current version of Rustfmt does not
128 /// satisfy that requirement.
129 #[error("version mismatch")]
131 /// If we had formatted the given node, then we would have lost a comment.
132 #[error("not formatted because a comment would be lost")]
134 /// Invalid glob pattern in `ignore` configuration option.
135 #[error("Invalid glob pattern found in ignore list: {0}")]
136 InvalidGlobPattern(ignore::Error),
140 fn is_comment(&self) -> bool {
141 matches!(self, ErrorKind::LostComment)
145 impl From<io::Error> for ErrorKind {
146 fn from(e: io::Error) -> ErrorKind {
147 ErrorKind::IoError(e)
151 /// Result of formatting a snippet of code along with ranges of lines that didn't get formatted,
152 /// i.e., that got returned as they were originally.
154 struct FormattedSnippet {
156 non_formatted_ranges: Vec<(usize, usize)>,
159 impl FormattedSnippet {
160 /// In case the snippet needed to be wrapped in a function, this shifts down the ranges of
161 /// non-formatted code.
162 fn unwrap_code_block(&mut self) {
163 self.non_formatted_ranges
165 .for_each(|(low, high)| {
171 /// Returns `true` if the line n did not get formatted.
172 fn is_line_non_formatted(&self, n: usize) -> bool {
173 self.non_formatted_ranges
175 .any(|(low, high)| *low <= n && n <= *high)
179 /// Reports on any issues that occurred during a run of Rustfmt.
181 /// Can be reported to the user using the `Display` impl on [`FormatReportFormatter`].
183 pub struct FormatReport {
184 // Maps stringified file paths to their associated formatting errors.
185 internal: Rc<RefCell<(FormatErrorMap, ReportedErrors)>>,
186 non_formatted_ranges: Vec<(usize, usize)>,
190 fn new() -> FormatReport {
192 internal: Rc::new(RefCell::new((HashMap::new(), ReportedErrors::default()))),
193 non_formatted_ranges: Vec::new(),
197 fn add_non_formatted_ranges(&mut self, mut ranges: Vec<(usize, usize)>) {
198 self.non_formatted_ranges.append(&mut ranges);
201 fn append(&self, f: FileName, mut v: Vec<FormattingError>) {
202 self.track_errors(&v);
207 .and_modify(|fe| fe.append(&mut v))
211 fn track_errors(&self, new_errors: &[FormattingError]) {
212 let errs = &mut self.internal.borrow_mut().1;
213 if !new_errors.is_empty() {
214 errs.has_formatting_errors = true;
216 if errs.has_operational_errors && errs.has_check_errors && errs.has_unformatted_code_errors
220 for err in new_errors {
222 ErrorKind::LineOverflow(..) => {
223 errs.has_operational_errors = true;
225 ErrorKind::TrailingWhitespace => {
226 errs.has_operational_errors = true;
227 errs.has_unformatted_code_errors = true;
229 ErrorKind::LostComment => {
230 errs.has_unformatted_code_errors = true;
232 ErrorKind::DeprecatedAttr | ErrorKind::BadAttr | ErrorKind::VersionMismatch => {
233 errs.has_check_errors = true;
240 fn add_diff(&mut self) {
241 self.internal.borrow_mut().1.has_diff = true;
244 fn add_macro_format_failure(&mut self) {
245 self.internal.borrow_mut().1.has_macro_format_failure = true;
248 fn add_parsing_error(&mut self) {
249 self.internal.borrow_mut().1.has_parsing_errors = true;
252 fn warning_count(&self) -> usize {
257 .map(|(_, errors)| errors.len())
261 /// Whether any warnings or errors are present in the report.
262 pub fn has_warnings(&self) -> bool {
263 self.internal.borrow().1.has_formatting_errors
266 /// Print the report to a terminal using colours and potentially other
268 #[deprecated(note = "Use FormatReportFormatter with colors enabled instead")]
271 mut t: Box<dyn term::Terminal<Output = io::Stderr>>,
272 ) -> Result<(), term::Error> {
276 FormatReportFormatterBuilder::new(self)
284 /// Deprecated - Use FormatReportFormatter instead
285 // https://github.com/rust-lang/rust/issues/78625
286 // https://github.com/rust-lang/rust/issues/39935
287 impl fmt::Display for FormatReport {
288 // Prints all the formatting errors.
289 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
290 write!(fmt, "{}", FormatReportFormatterBuilder::new(self).build())?;
295 /// Format the given snippet. The snippet is expected to be *complete* code.
296 /// When we cannot parse the given snippet, this function returns `None`.
297 fn format_snippet(snippet: &str, config: &Config, is_macro_def: bool) -> Option<FormattedSnippet> {
298 let mut config = config.clone();
299 panic::catch_unwind(|| {
300 let mut out: Vec<u8> = Vec::with_capacity(snippet.len() * 2);
301 config.set().emit_mode(config::EmitMode::Stdout);
302 config.set().verbose(Verbosity::Quiet);
303 config.set().hide_parse_errors(true);
305 config.set().error_on_unformatted(true);
308 let (formatting_error, result) = {
309 let input = Input::Text(snippet.into());
310 let mut session = Session::new(config, Some(&mut out));
311 let result = session.format_input_inner(input, is_macro_def);
313 session.errors.has_macro_format_failure
314 || session.out.as_ref().unwrap().is_empty() && !snippet.is_empty()
316 || (is_macro_def && session.has_unformatted_code_errors()),
320 if formatting_error {
323 String::from_utf8(out).ok().map(|snippet| FormattedSnippet {
325 non_formatted_ranges: result.unwrap().non_formatted_ranges,
329 // Discard panics encountered while formatting the snippet
330 // The ? operator is needed to remove the extra Option
334 /// Format the given code block. Mainly targeted for code block in comment.
335 /// The code block may be incomplete (i.e., parser may be unable to parse it).
336 /// To avoid panic in parser, we wrap the code block with a dummy function.
337 /// The returned code block does **not** end with newline.
338 fn format_code_block(
342 ) -> Option<FormattedSnippet> {
343 const FN_MAIN_PREFIX: &str = "fn main() {\n";
345 fn enclose_in_main_block(s: &str, config: &Config) -> String {
346 let indent = Indent::from_width(config, config.tab_spaces());
347 let mut result = String::with_capacity(s.len() * 2);
348 result.push_str(FN_MAIN_PREFIX);
349 let mut need_indent = true;
350 for (kind, line) in LineClasses::new(s) {
352 result.push_str(&indent.to_string(config));
354 result.push_str(&line);
356 need_indent = indent_next_line(kind, &line, config);
362 // Wrap the given code block with `fn main()` if it does not have one.
363 let snippet = enclose_in_main_block(code_snippet, config);
364 let mut result = String::with_capacity(snippet.len());
365 let mut is_first = true;
367 // While formatting the code, ignore the config's newline style setting and always use "\n"
368 // instead of "\r\n" for the newline characters. This is ok because the output here is
369 // not directly outputted by rustfmt command, but used by the comment formatter's input.
370 // We have output-file-wide "\n" ==> "\r\n" conversion process after here if it's necessary.
371 let mut config_with_unix_newline = config.clone();
372 config_with_unix_newline
374 .newline_style(NewlineStyle::Unix);
375 let mut formatted = format_snippet(&snippet, &config_with_unix_newline, is_macro_def)?;
376 // Remove wrapping main block
377 formatted.unwrap_code_block();
379 // Trim "fn main() {" on the first line and "}" on the last line,
380 // then unindent the whole code block.
381 let block_len = formatted
384 .unwrap_or_else(|| formatted.snippet.len());
385 let mut is_indented = true;
386 let indent_str = Indent::from_width(config, config.tab_spaces()).to_string(config);
387 for (kind, ref line) in LineClasses::new(&formatted.snippet[FN_MAIN_PREFIX.len()..block_len]) {
393 let trimmed_line = if !is_indented {
395 } else if line.len() > config.max_width() {
396 // If there are lines that are larger than max width, we cannot tell
397 // whether we have succeeded but have some comments or strings that
398 // are too long, or we have failed to format code block. We will be
399 // conservative and just return `None` in this case.
401 } else if line.len() > indent_str.len() {
402 // Make sure that the line has leading whitespaces.
403 if line.starts_with(indent_str.as_ref()) {
404 let offset = if config.hard_tabs() {
416 result.push_str(trimmed_line);
417 is_indented = indent_next_line(kind, line, config);
419 Some(FormattedSnippet {
421 non_formatted_ranges: formatted.non_formatted_ranges,
425 /// A session is a run of rustfmt across a single or multiple inputs.
426 pub struct Session<'b, T: Write> {
428 pub out: Option<&'b mut T>,
429 pub(crate) errors: ReportedErrors,
430 source_file: SourceFile,
431 emitter: Box<dyn Emitter + 'b>,
434 impl<'b, T: Write + 'b> Session<'b, T> {
435 pub fn new(config: Config, mut out: Option<&'b mut T>) -> Session<'b, T> {
436 let emitter = create_emitter(&config);
438 if let Some(ref mut out) = out {
439 let _ = emitter.emit_header(out);
446 errors: ReportedErrors::default(),
447 source_file: SourceFile::new(),
451 /// The main entry point for Rustfmt. Formats the given input according to the
452 /// given config. `out` is only necessary if required by the configuration.
453 pub fn format(&mut self, input: Input) -> Result<FormatReport, ErrorKind> {
454 self.format_input_inner(input, false)
457 pub fn override_config<F, U>(&mut self, mut config: Config, f: F) -> U
459 F: FnOnce(&mut Session<'b, T>) -> U,
461 mem::swap(&mut config, &mut self.config);
462 let result = f(self);
463 mem::swap(&mut config, &mut self.config);
467 pub fn add_operational_error(&mut self) {
468 self.errors.has_operational_errors = true;
471 pub fn has_operational_errors(&self) -> bool {
472 self.errors.has_operational_errors
475 pub fn has_parsing_errors(&self) -> bool {
476 self.errors.has_parsing_errors
479 pub fn has_formatting_errors(&self) -> bool {
480 self.errors.has_formatting_errors
483 pub fn has_check_errors(&self) -> bool {
484 self.errors.has_check_errors
487 pub fn has_diff(&self) -> bool {
491 pub fn has_unformatted_code_errors(&self) -> bool {
492 self.errors.has_unformatted_code_errors
495 pub fn has_no_errors(&self) -> bool {
496 !(self.has_operational_errors()
497 || self.has_parsing_errors()
498 || self.has_formatting_errors()
499 || self.has_check_errors()
501 || self.has_unformatted_code_errors()
502 || self.errors.has_macro_format_failure)
506 pub(crate) fn create_emitter<'a>(config: &Config) -> Box<dyn Emitter + 'a> {
507 match config.emit_mode() {
508 EmitMode::Files if config.make_backup() => {
509 Box::new(emitter::FilesWithBackupEmitter::default())
511 EmitMode::Files => Box::new(emitter::FilesEmitter::new(
512 config.print_misformatted_file_names(),
514 EmitMode::Stdout | EmitMode::Coverage => {
515 Box::new(emitter::StdoutEmitter::new(config.verbose()))
517 EmitMode::Json => Box::new(emitter::JsonEmitter::default()),
518 EmitMode::ModifiedLines => Box::new(emitter::ModifiedLinesEmitter::default()),
519 EmitMode::Checkstyle => Box::new(emitter::CheckstyleEmitter::default()),
520 EmitMode::Diff => Box::new(emitter::DiffEmitter::new(config.clone())),
524 impl<'b, T: Write + 'b> Drop for Session<'b, T> {
526 if let Some(ref mut out) = self.out {
527 let _ = self.emitter.emit_footer(out);
539 fn file_name(&self) -> FileName {
541 Input::File(ref file) => FileName::Real(file.clone()),
542 Input::Text(..) => FileName::Stdin,
546 fn to_directory_ownership(&self) -> Option<DirectoryOwnership> {
548 Input::File(ref file) => {
549 // If there exists a directory with the same name as an input,
550 // then the input should be parsed as a sub module.
551 let file_stem = file.file_stem()?;
552 if file.parent()?.to_path_buf().join(file_stem).is_dir() {
553 Some(DirectoryOwnership::Owned {
554 relative: file_stem.to_str().map(symbol::Ident::from_str),
570 fn test_no_panic_on_format_snippet_and_format_code_block() {
571 // `format_snippet()` and `format_code_block()` should not panic
572 // even when we cannot parse the given snippet.
574 assert!(format_snippet(snippet, &Config::default(), false).is_none());
575 assert!(format_code_block(snippet, &Config::default(), false).is_none());
578 fn test_format_inner<F>(formatter: F, input: &str, expected: &str) -> bool
580 F: Fn(&str, &Config, bool) -> Option<FormattedSnippet>,
582 let output = formatter(input, &Config::default(), false);
583 output.is_some() && output.unwrap().snippet == expected
587 fn test_format_snippet() {
588 let snippet = "fn main() { println!(\"hello, world\"); }";
590 let expected = "fn main() {\n \
591 println!(\"hello, world\");\n\
594 let expected = "fn main() {\r\n \
595 println!(\"hello, world\");\r\n\
597 assert!(test_format_inner(format_snippet, snippet, expected));
601 fn test_format_code_block_fail() {
603 let code_block = "this_line_is_100_characters_long_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx(x, y, z);";
604 assert!(format_code_block(code_block, &Config::default(), false).is_none());
608 fn test_format_code_block() {
610 let code_block = "let x=3;";
611 let expected = "let x = 3;";
612 assert!(test_format_inner(format_code_block, code_block, expected));
614 // more complex code block, taken from chains.rs.
616 "let (nested_shape, extend) = if !parent_rewrite_contains_newline && is_continuable(&parent) {
618 chain_indent(context, shape.add_offset(parent_rewrite.len())),
619 context.config.indent_style() == IndentStyle::Visual || is_small_parent,
621 } else if is_block_expr(context, &parent, &parent_rewrite) {
622 match context.config.indent_style() {
623 // Try to put the first child on the same line with parent's last line
624 IndentStyle::Block => (parent_shape.block_indent(context.config.tab_spaces()), true),
625 // The parent is a block, so align the rest of the chain with the closing
627 IndentStyle::Visual => (parent_shape, false),
631 chain_indent(context, shape.add_offset(parent_rewrite.len())),
637 "let (nested_shape, extend) = if !parent_rewrite_contains_newline && is_continuable(&parent) {
639 chain_indent(context, shape.add_offset(parent_rewrite.len())),
640 context.config.indent_style() == IndentStyle::Visual || is_small_parent,
642 } else if is_block_expr(context, &parent, &parent_rewrite) {
643 match context.config.indent_style() {
644 // Try to put the first child on the same line with parent's last line
645 IndentStyle::Block => (parent_shape.block_indent(context.config.tab_spaces()), true),
646 // The parent is a block, so align the rest of the chain with the closing
648 IndentStyle::Visual => (parent_shape, false),
652 chain_indent(context, shape.add_offset(parent_rewrite.len())),
656 assert!(test_format_inner(format_code_block, code_block, expected));