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.
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.
16 use std::io::{Error, ErrorKind, Read};
17 use std::path::{Path, PathBuf};
19 use file_lines::FileLines;
20 use lists::{ListTactic, SeparatorTactic};
22 macro_rules! configuration_option_enum{
23 ($e:ident: $( $x:ident ),+ $(,)*) => {
24 #[derive(Copy, Clone, Eq, PartialEq, Debug)]
29 impl_enum_serialize_and_deserialize!($e, $( $x ),+);
33 configuration_option_enum! { Style:
34 Rfc, // Follow the style RFCs style.
35 Legacy, // Follow the traditional Rustfmt style.
38 configuration_option_enum! { NewlineStyle:
41 Native, // \r\n in Windows, \n on other platforms
44 configuration_option_enum! { BraceStyle:
47 // Prefer same line except where there is a where clause, in which case force
48 // the brace to the next line.
52 configuration_option_enum! { ControlBraceStyle:
53 // K&R style, Rust community default
61 // How to indent a function's return type.
62 configuration_option_enum! { ReturnIndent:
63 // Aligned with the arguments
65 // Aligned with the where clause
69 configuration_option_enum! { IndentStyle:
70 // First line on the same line as the opening brace, all lines aligned with
73 // First line is on a new line and all lines align with block indent.
77 configuration_option_enum! { Density:
78 // Fit as much on one line as possible.
82 // Try to compress if the body is empty.
84 // Place every item on a separate line.
88 configuration_option_enum! { TypeDensity:
89 // No spaces around "=" and "+"
91 // Spaces around " = " and " + "
97 pub fn to_list_tactic(self) -> ListTactic {
99 Density::Compressed => ListTactic::Mixed,
100 Density::Tall | Density::CompressedIfEmpty => ListTactic::HorizontalVertical,
101 Density::Vertical => ListTactic::Vertical,
106 configuration_option_enum! { LicensePolicy:
107 // Do not place license text at top of files
109 // Use the text in "license" field as the license
111 // Use a text file as the license text
115 configuration_option_enum! { MultilineStyle:
116 // Use horizontal layout if it fits in one line, fall back to vertical
118 // Use vertical layout
122 impl MultilineStyle {
123 pub fn to_list_tactic(self) -> ListTactic {
125 MultilineStyle::PreferSingle => ListTactic::HorizontalVertical,
126 MultilineStyle::ForceMulti => ListTactic::Vertical,
131 configuration_option_enum! { ReportTactic:
137 configuration_option_enum! { WriteMode:
138 // Backs the original file up and overwrites the original.
140 // Overwrites original file without backup.
142 // Writes the output to stdout.
144 // Writes the diff to stdout.
146 // Displays how much of the input file was processed
150 // Outputs a checkstyle XML file.
154 /// Trait for types that can be used in `Config`.
155 pub trait ConfigType: Sized {
156 /// Returns hint text for use in `Config::print_docs()`. For enum types, this is a
157 /// pipe-separated list of variants; for other types it returns "<type>".
158 fn doc_hint() -> String;
161 impl ConfigType for bool {
162 fn doc_hint() -> String {
163 String::from("<boolean>")
167 impl ConfigType for usize {
168 fn doc_hint() -> String {
169 String::from("<unsigned integer>")
173 impl ConfigType for isize {
174 fn doc_hint() -> String {
175 String::from("<signed integer>")
179 impl ConfigType for String {
180 fn doc_hint() -> String {
181 String::from("<string>")
185 impl ConfigType for FileLines {
186 fn doc_hint() -> String {
187 String::from("<json>")
191 pub struct ConfigHelpItem {
192 option_name: &'static str,
193 doc_string: &'static str,
194 variant_names: String,
195 default: &'static str,
198 impl ConfigHelpItem {
199 pub fn option_name(&self) -> &'static str {
203 pub fn doc_string(&self) -> &'static str {
207 pub fn variant_names(&self) -> &String {
211 pub fn default(&self) -> &'static str {
216 macro_rules! create_config {
217 ($($i:ident: $ty:ty, $def:expr, $( $dstring:expr ),+ );+ $(;)*) => (
220 // For each config item, we store a bool indicating whether it has
221 // been accessed and the value, and a bool whether the option was
222 // manually initialised, or taken from the default,
223 $($i: (Cell<bool>, bool, $ty)),+
226 // Just like the Config struct but with each property wrapped
227 // as Option<T>. This is used to parse a rustfmt.toml that doesn't
228 // specity all properties of `Config`.
229 // We first parse into `PartialConfig`, then create a default `Config`
230 // and overwrite the properties with corresponding values from `PartialConfig`.
231 #[derive(Deserialize, Serialize, Clone)]
232 pub struct PartialConfig {
233 $(pub $i: Option<$ty>),+
237 pub fn to_toml(&self) -> Result<String, String> {
238 // file_lines can't be specified in TOML
239 let mut cloned = self.clone();
240 cloned.file_lines = None;
242 toml::to_string(&cloned)
243 .map_err(|e| format!("Could not output config: {}", e.to_string()))
247 // Macro hygiene won't allow us to make `set_$i()` methods on Config
248 // for each item, so this struct is used to give the API to set values:
249 // `config.get().option(false)`. It's pretty ugly. Consider replacing
250 // with `config.set_option(false)` if we ever get a stable/usable
251 // `concat_idents!()`.
252 pub struct ConfigSetter<'a>(&'a mut Config);
254 impl<'a> ConfigSetter<'a> {
256 pub fn $i(&mut self, value: $ty) {
257 (self.0).$i.2 = value;
262 // Query each option, returns true if the user set the option, false if
263 // a default was used.
264 pub struct ConfigWasSet<'a>(&'a Config);
266 impl<'a> ConfigWasSet<'a> {
268 pub fn $i(&self) -> bool {
277 pub fn $i(&self) -> $ty {
283 pub fn set<'a>(&'a mut self) -> ConfigSetter<'a> {
287 pub fn was_set<'a>(&'a self) -> ConfigWasSet<'a> {
291 fn fill_from_parsed_config(mut self, parsed: PartialConfig) -> Config {
293 if let Some(val) = parsed.$i {
301 pub fn from_toml(toml: &str) -> Result<Config, String> {
302 let parsed: toml::Value =
303 toml.parse().map_err(|e| format!("Could not parse TOML: {}", e))?;
304 let mut err: String = String::new();
308 .ok_or(String::from("Parsed config was not table"))?;
309 for (key, _) in table {
312 stringify!($i) => (),
316 &format!("Warning: Unknown configuration option `{}`\n",
323 match parsed.try_into() {
325 Ok(Config::default().fill_from_parsed_config(parsed_config)),
327 err.push_str("Error: Decoding config file failed:\n");
328 err.push_str(format!("{}\n", e).as_str());
329 err.push_str("Please check your config file.\n");
335 pub fn used_options(&self) -> PartialConfig {
338 $i: if self.$i.0.get() {
339 Some(self.$i.2.clone())
347 pub fn all_options(&self) -> PartialConfig {
350 $i: Some(self.$i.2.clone()),
355 pub fn override_value(&mut self, key: &str, val: &str)
360 self.$i.2 = val.parse::<$ty>()
361 .expect(&format!("Failed to parse override for {} (\"{}\") as a {}",
367 _ => panic!("Unknown config key in override: {}", key)
371 /// Construct a `Config` from the toml file specified at `file_path`.
373 /// This method only looks at the provided path, for a method that
374 /// searches parents for a `rustfmt.toml` see `from_resolved_toml_path`.
376 /// Return a `Config` if the config could be read and parsed from
377 /// the file, Error otherwise.
378 pub fn from_toml_path(file_path: &Path) -> Result<Config, Error> {
379 let mut file = File::open(&file_path)?;
380 let mut toml = String::new();
381 file.read_to_string(&mut toml)?;
382 Config::from_toml(&toml).map_err(|err| Error::new(ErrorKind::InvalidData, err))
385 /// Resolve the config for input in `dir`.
387 /// Searches for `rustfmt.toml` beginning with `dir`, and
388 /// recursively checking parents of `dir` if no config file is found.
389 /// If no config file exists in `dir` or in any parent, a
390 /// default `Config` will be returned (and the returned path will be empty).
392 /// Returns the `Config` to use, and the path of the project file if there was
394 pub fn from_resolved_toml_path(dir: &Path) -> Result<(Config, Option<PathBuf>), Error> {
396 /// Try to find a project file in the given directory and its parents.
397 /// Returns the path of a the nearest project file if one exists,
398 /// or `None` if no project file was found.
399 fn resolve_project_file(dir: &Path) -> Result<Option<PathBuf>, Error> {
400 let mut current = if dir.is_relative() {
401 env::current_dir()?.join(dir)
406 current = fs::canonicalize(current)?;
409 match get_toml_path(¤t) {
410 Ok(Some(path)) => return Ok(Some(path)),
411 Err(e) => return Err(e),
415 // If the current directory has no parent, we're done searching.
422 match resolve_project_file(dir)? {
423 None => Ok((Config::default(), None)),
424 Some(path) => Config::from_toml_path(&path).map(|config| (config, Some(path))),
429 pub fn print_docs() {
432 $( let max = cmp::max(max, stringify!($i).len()+1); )+
433 let mut space_str = String::with_capacity(max);
437 println!("Configuration Options:");
439 let name_raw = stringify!($i);
440 let mut name_out = String::with_capacity(max);
441 for _ in name_raw.len()..max-1 {
444 name_out.push_str(name_raw);
446 println!("{}{} Default: {:?}",
451 println!("{}{}", space_str, $dstring);
458 // Template for the default configuration
459 impl Default for Config {
460 fn default() -> Config {
463 $i: (Cell::new(false), false, $def),
471 /// Check for the presence of known config file names (`rustfmt.toml, `.rustfmt.toml`) in `dir`
473 /// Return the path if a config file exists, empty if no file exists, and Error for IO errors
474 pub fn get_toml_path(dir: &Path) -> Result<Option<PathBuf>, Error> {
475 const CONFIG_FILE_NAMES: [&'static str; 2] = [".rustfmt.toml", "rustfmt.toml"];
476 for config_file_name in &CONFIG_FILE_NAMES {
477 let config_file = dir.join(config_file_name);
478 match fs::metadata(&config_file) {
479 // Only return if it's a file to handle the unlikely situation of a directory named
481 Ok(ref md) if md.is_file() => return Ok(Some(config_file)),
482 // Return the error if it's something other than `NotFound`; otherwise we didn't
483 // find the project file yet, and continue searching.
484 Err(e) => if e.kind() != ErrorKind::NotFound {
496 verbose: bool, false, "Use verbose output";
497 disable_all_formatting: bool, false, "Don't reformat anything";
498 skip_children: bool, false, "Don't reformat out of line modules";
499 file_lines: FileLines, FileLines::all(),
500 "Lines to format; this is not supported in rustfmt.toml, and can only be specified \
501 via the --file-lines option";
502 max_width: usize, 100, "Maximum width of each line";
503 error_on_line_overflow: bool, true, "Error if unable to get all lines within max_width";
504 tab_spaces: usize, 4, "Number of spaces per tab";
505 fn_call_width: usize, 60,
506 "Maximum width of the args of a function call before falling back to vertical formatting";
507 struct_lit_width: usize, 18,
508 "Maximum width in the body of a struct lit before falling back to vertical formatting";
509 struct_variant_width: usize, 35,
510 "Maximum width in the body of a struct variant before falling back to vertical formatting";
511 force_explicit_abi: bool, true, "Always print the abi for extern items";
512 newline_style: NewlineStyle, NewlineStyle::Unix, "Unix or Windows line endings";
513 fn_brace_style: BraceStyle, BraceStyle::SameLineWhere, "Brace style for functions";
514 item_brace_style: BraceStyle, BraceStyle::SameLineWhere, "Brace style for structs and enums";
515 control_style: Style, Style::Rfc, "Indent style for control flow statements";
516 control_brace_style: ControlBraceStyle, ControlBraceStyle::AlwaysSameLine,
517 "Brace style for control flow constructs";
518 impl_empty_single_line: bool, true, "Put empty-body implementations on a single line";
519 trailing_comma: SeparatorTactic, SeparatorTactic::Vertical,
520 "How to handle trailing commas for lists";
521 trailing_semicolon: bool, true, "Add trailing semicolon after break, continue and return";
522 fn_empty_single_line: bool, true, "Put empty-body functions on a single line";
523 fn_single_line: bool, false, "Put single-expression functions on a single line";
524 fn_return_indent: ReturnIndent, ReturnIndent::WithArgs,
525 "Location of return type in function declaration";
526 fn_args_paren_newline: bool, false, "If function argument parenthesis goes on a newline";
527 fn_args_density: Density, Density::Tall, "Argument density in functions";
528 fn_args_layout: IndentStyle, IndentStyle::Block,
529 "Layout of function arguments and tuple structs";
530 array_layout: IndentStyle, IndentStyle::Block, "Indent on arrays";
531 array_width: usize, 60,
532 "Maximum width of an array literal before falling back to vertical formatting";
533 array_horizontal_layout_threshold: usize, 0,
534 "How many elements array must have before rustfmt uses horizontal layout.";
535 type_punctuation_density: TypeDensity, TypeDensity::Wide,
536 "Determines if '+' or '=' are wrapped in spaces in the punctuation of types";
537 where_style: Style, Style::Rfc, "Overall strategy for where clauses";
539 // 1. Should we at least try to put the where clause on the same line as the rest of the
541 // 2. Currently options `Tall` and `Vertical` produce the same output.
542 where_density: Density, Density::CompressedIfEmpty, "Density of a where clause";
543 where_layout: ListTactic, ListTactic::Vertical, "Element layout inside a where clause";
544 where_pred_indent: IndentStyle, IndentStyle::Visual,
545 "Indentation style of a where predicate";
546 generics_indent: IndentStyle, IndentStyle::Block, "Indentation of generics";
547 struct_lit_style: IndentStyle, IndentStyle::Block, "Style of struct definition";
548 struct_lit_multiline_style: MultilineStyle, MultilineStyle::PreferSingle,
549 "Multiline style on literal structs";
550 fn_call_style: IndentStyle, IndentStyle::Block, "Indentation for function calls, etc.";
551 report_todo: ReportTactic, ReportTactic::Never,
552 "Report all, none or unnumbered occurrences of TODO in source file comments";
553 report_fixme: ReportTactic, ReportTactic::Never,
554 "Report all, none or unnumbered occurrences of FIXME in source file comments";
555 chain_indent: IndentStyle, IndentStyle::Block, "Indentation of chain";
556 chain_one_line_max: usize, 60, "Maximum length of a chain to fit on a single line";
557 chain_split_single_child: bool, false, "Split a chain with a single child if its length \
558 exceeds `chain_one_line_max`";
559 imports_indent: IndentStyle, IndentStyle::Visual, "Indent of imports";
560 imports_layout: ListTactic, ListTactic::Mixed, "Item layout inside a import block";
561 reorder_imports: bool, false, "Reorder import statements alphabetically";
562 reorder_imports_in_group: bool, false, "Reorder import statements in group";
563 reorder_imported_names: bool, true,
564 "Reorder lists of names in import statements alphabetically";
565 single_line_if_else_max_width: usize, 50, "Maximum line length for single line if-else \
566 expressions. A value of zero means always break \
567 if-else expressions.";
568 format_strings: bool, false, "Format string literals where necessary";
569 force_format_strings: bool, false, "Always format string literals";
570 take_source_hints: bool, false, "Retain some formatting characteristics from the source code";
571 hard_tabs: bool, false, "Use tab characters for indentation, spaces for alignment";
572 wrap_comments: bool, false, "Break comments to fit on the line";
573 comment_width: usize, 80, "Maximum length of comments. No effect unless wrap_comments = true";
574 normalize_comments: bool, false, "Convert /* */ comments to // comments where possible";
575 wrap_match_arms: bool, true, "Wrap the body of arms in blocks when it does not fit on \
576 the same line with the pattern of arms";
577 match_block_trailing_comma: bool, false,
578 "Put a trailing comma after a block based match arm (non-block arms are not affected)";
579 indent_match_arms: bool, true, "Indent match arms instead of keeping them at the same \
580 indentation level as the match keyword";
581 closure_block_indent_threshold: isize, 7, "How many lines a closure must have before it is \
582 block indented. -1 means never use block indent.";
583 space_before_type_annotation: bool, false,
584 "Leave a space before the colon in a type annotation";
585 space_after_type_annotation_colon: bool, true,
586 "Leave a space after the colon in a type annotation";
587 space_before_struct_lit_field_colon: bool, false,
588 "Leave a space before the colon in a struct literal field";
589 space_after_struct_lit_field_colon: bool, true,
590 "Leave a space after the colon in a struct literal field";
591 space_before_bound: bool, false, "Leave a space before the colon in a trait or lifetime bound";
592 space_after_bound_colon: bool, true,
593 "Leave a space after the colon in a trait or lifetime bound";
594 spaces_around_ranges: bool, false, "Put spaces around the .. and ... range operators";
595 spaces_within_angle_brackets: bool, false, "Put spaces within non-empty generic arguments";
596 spaces_within_square_brackets: bool, false, "Put spaces within non-empty square brackets";
597 spaces_within_parens: bool, false, "Put spaces within non-empty parentheses";
598 use_try_shorthand: bool, false, "Replace uses of the try! macro by the ? shorthand";
599 write_mode: WriteMode, WriteMode::Replace,
600 "What Write Mode to use when none is supplied: Replace, Overwrite, Display, Diff, Coverage";
601 condense_wildcard_suffixes: bool, false, "Replace strings of _ wildcards by a single .. in \
603 combine_control_expr: bool, true, "Combine control expressions with funciton calls.";
604 struct_field_align_threshold: usize, 0, "Align struct fields if their diffs fits within \
613 fn test_config_set() {
614 let mut config = Config::default();
615 config.set().verbose(false);
616 assert_eq!(config.verbose(), false);
617 config.set().verbose(true);
618 assert_eq!(config.verbose(), true);
622 fn test_config_used_to_toml() {
623 let config = Config::default();
625 let verbose = config.verbose();
626 let skip_children = config.skip_children();
628 let used_options = config.used_options();
629 let toml = used_options.to_toml().unwrap();
632 format!("verbose = {}\nskip_children = {}\n", verbose, skip_children)
638 let config = Config::from_toml("hard_tabs = true").unwrap();
640 assert_eq!(config.was_set().hard_tabs(), true);
641 assert_eq!(config.was_set().verbose(), false);