src/config/options.rs

   1 // Copyright 2018 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::codemap::FileName;
  12
  13 use config::config_type::ConfigType;
  14 use config::file_lines::FileLines;
  15 use config::lists::*;
  16 use config::Config;
  17 use {FmtResult, WRITE_MODE_LIST};
  18
  19 use failure::err_msg;
  20
  21 use getopts::Matches;
  22 use std::collections::HashSet;
  23 use std::path::{Path, PathBuf};
  24 use std::str::FromStr;
  25
  26 /// Macro for deriving implementations of Serialize/Deserialize for enums
  27 #[macro_export]
  28 macro_rules! impl_enum_serialize_and_deserialize {
  29     ( $e:ident, $( $x:ident ),* ) => {
  30         impl ::serde::ser::Serialize for $e {
  31             fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
  32                 where S: ::serde::ser::Serializer
  33             {
  34                 use serde::ser::Error;
  35
  36                 // We don't know whether the user of the macro has given us all options.
  37                 #[allow(unreachable_patterns)]
  38                 match *self {
  39                     $(
  40                         $e::$x => serializer.serialize_str(stringify!($x)),
  41                     )*
  42                     _ => {
  43                         Err(S::Error::custom(format!("Cannot serialize {:?}", self)))
  44                     }
  45                 }
  46             }
  47         }
  48
  49         impl<'de> ::serde::de::Deserialize<'de> for $e {
  50             fn deserialize<D>(d: D) -> Result<Self, D::Error>
  51                     where D: ::serde::Deserializer<'de> {
  52                 use serde::de::{Error, Visitor};
  53                 use std::marker::PhantomData;
  54                 use std::fmt;
  55                 struct StringOnly<T>(PhantomData<T>);
  56                 impl<'de, T> Visitor<'de> for StringOnly<T>
  57                         where T: ::serde::Deserializer<'de> {
  58                     type Value = String;
  59                     fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
  60                         formatter.write_str("string")
  61                     }
  62                     fn visit_str<E>(self, value: &str) -> Result<String, E> {
  63                         Ok(String::from(value))
  64                     }
  65                 }
  66                 let s = d.deserialize_string(StringOnly::<D>(PhantomData))?;
  67                 $(
  68                     if stringify!($x).eq_ignore_ascii_case(&s) {
  69                       return Ok($e::$x);
  70                     }
  71                 )*
  72                 static ALLOWED: &'static[&str] = &[$(stringify!($x),)*];
  73                 Err(D::Error::unknown_variant(&s, ALLOWED))
  74             }
  75         }
  76
  77         impl ::std::str::FromStr for $e {
  78             type Err = &'static str;
  79
  80             fn from_str(s: &str) -> Result<Self, Self::Err> {
  81                 $(
  82                     if stringify!($x).eq_ignore_ascii_case(s) {
  83                         return Ok($e::$x);
  84                     }
  85                 )*
  86                 Err("Bad variant")
  87             }
  88         }
  89
  90         impl ConfigType for $e {
  91             fn doc_hint() -> String {
  92                 let mut variants = Vec::new();
  93                 $(
  94                     variants.push(stringify!($x));
  95                 )*
  96                 format!("[{}]", variants.join("|"))
  97             }
  98         }
  99     };
 100 }
 101
 102 macro_rules! configuration_option_enum{
 103     ($e:ident: $( $x:ident ),+ $(,)*) => {
 104         #[derive(Copy, Clone, Eq, PartialEq, Debug)]
 105         pub enum $e {
 106             $( $x ),+
 107         }
 108
 109         impl_enum_serialize_and_deserialize!($e, $( $x ),+);
 110     }
 111 }
 112
 113 configuration_option_enum! { NewlineStyle:
 114     Windows, // \r\n
 115     Unix, // \n
 116     Native, // \r\n in Windows, \n on other platforms
 117 }
 118
 119 configuration_option_enum! { BraceStyle:
 120     AlwaysNextLine,
 121     PreferSameLine,
 122     // Prefer same line except where there is a where clause, in which case force
 123     // the brace to the next line.
 124     SameLineWhere,
 125 }
 126
 127 configuration_option_enum! { ControlBraceStyle:
 128     // K&R style, Rust community default
 129     AlwaysSameLine,
 130     // Stroustrup style
 131     ClosingNextLine,
 132     // Allman style
 133     AlwaysNextLine,
 134 }
 135
 136 configuration_option_enum! { IndentStyle:
 137     // First line on the same line as the opening brace, all lines aligned with
 138     // the first line.
 139     Visual,
 140     // First line is on a new line and all lines align with block indent.
 141     Block,
 142 }
 143
 144 configuration_option_enum! { Density:
 145     // Fit as much on one line as possible.
 146     Compressed,
 147     // Use more lines.
 148     Tall,
 149     // Place every item on a separate line.
 150     Vertical,
 151 }
 152
 153 configuration_option_enum! { TypeDensity:
 154     // No spaces around "=" and "+"
 155     Compressed,
 156     // Spaces around " = " and " + "
 157     Wide,
 158 }
 159
 160 impl Density {
 161     pub fn to_list_tactic(self) -> ListTactic {
 162         match self {
 163             Density::Compressed => ListTactic::Mixed,
 164             Density::Tall => ListTactic::HorizontalVertical,
 165             Density::Vertical => ListTactic::Vertical,
 166         }
 167     }
 168 }
 169
 170 configuration_option_enum! { ReportTactic:
 171     Always,
 172     Unnumbered,
 173     Never,
 174 }
 175
 176 configuration_option_enum! { WriteMode:
 177     // Backs the original file up and overwrites the original.
 178     Replace,
 179     // Overwrites original file without backup.
 180     Overwrite,
 181     // Writes the output to stdout.
 182     Display,
 183     // Writes the diff to stdout.
 184     Diff,
 185     // Displays how much of the input file was processed
 186     Coverage,
 187     // Unfancy stdout
 188     Plain,
 189     // Outputs a checkstyle XML file.
 190     Checkstyle,
 191     // Output the changed lines (for internal value only)
 192     Modified,
 193     // Checks if a diff can be generated. If so, rustfmt outputs a diff and quits with exit code 1.
 194     // This option is designed to be run in CI where a non-zero exit signifies non-standard code formatting.
 195     Check,
 196     // Rustfmt shouldn't output anything formatting-like (e.g., emit a help message).
 197     None,
 198 }
 199
 200 configuration_option_enum! { Color:
 201     // Always use color, whether it is a piped or terminal output
 202     Always,
 203     // Never use color
 204     Never,
 205     // Automatically use color, if supported by terminal
 206     Auto,
 207 }
 208
 209 #[derive(Deserialize, Serialize, Clone, Debug)]
 210 pub struct WidthHeuristics {
 211     // Maximum width of the args of a function call before falling back
 212     // to vertical formatting.
 213     pub fn_call_width: usize,
 214     // Maximum width in the body of a struct lit before falling back to
 215     // vertical formatting.
 216     pub struct_lit_width: usize,
 217     // Maximum width in the body of a struct variant before falling back
 218     // to vertical formatting.
 219     pub struct_variant_width: usize,
 220     // Maximum width of an array literal before falling back to vertical
 221     // formatting.
 222     pub array_width: usize,
 223     // Maximum length of a chain to fit on a single line.
 224     pub chain_width: usize,
 225     // Maximum line length for single line if-else expressions. A value
 226     // of zero means always break if-else expressions.
 227     pub single_line_if_else_max_width: usize,
 228 }
 229
 230 impl WidthHeuristics {
 231     // Using this WidthHeuristics means we ignore heuristics.
 232     pub fn null() -> WidthHeuristics {
 233         WidthHeuristics {
 234             fn_call_width: usize::max_value(),
 235             struct_lit_width: 0,
 236             struct_variant_width: 0,
 237             array_width: usize::max_value(),
 238             chain_width: usize::max_value(),
 239             single_line_if_else_max_width: 0,
 240         }
 241     }
 242
 243     // scale the default WidthHeuristics according to max_width
 244     pub fn scaled(max_width: usize) -> WidthHeuristics {
 245         let mut max_width_ratio: f32 = max_width as f32 / 100.0; // 100 is the default width -> default ratio is 1
 246         max_width_ratio = (max_width_ratio * 10.0).round() / 10.0; // round to the closest 0.1
 247         WidthHeuristics {
 248             fn_call_width: (60.0 * max_width_ratio).round() as usize,
 249             struct_lit_width: (18.0 * max_width_ratio).round() as usize,
 250             struct_variant_width: (35.0 * max_width_ratio).round() as usize,
 251             array_width: (60.0 * max_width_ratio).round() as usize,
 252             chain_width: (60.0 * max_width_ratio).round() as usize,
 253             single_line_if_else_max_width: (50.0 * max_width_ratio).round() as usize,
 254         }
 255     }
 256 }
 257
 258 impl ::std::str::FromStr for WidthHeuristics {
 259     type Err = &'static str;
 260
 261     fn from_str(_: &str) -> Result<Self, Self::Err> {
 262         Err("WidthHeuristics is not parsable")
 263     }
 264 }
 265
 266 impl Default for WriteMode {
 267     fn default() -> WriteMode {
 268         WriteMode::Overwrite
 269     }
 270 }
 271
 272 /// A set of directories, files and modules that rustfmt should ignore.
 273 #[derive(Default, Deserialize, Serialize, Clone, Debug)]
 274 pub struct IgnoreList(HashSet<PathBuf>);
 275
 276 impl IgnoreList {
 277     pub fn add_prefix(&mut self, dir: &Path) {
 278         self.0 = self.0
 279             .iter()
 280             .map(|s| {
 281                 if s.has_root() {
 282                     s.clone()
 283                 } else {
 284                     let mut path = PathBuf::from(dir);
 285                     path.push(s);
 286                     path
 287                 }
 288             })
 289             .collect();
 290     }
 291
 292     fn skip_file_inner(&self, file: &Path) -> bool {
 293         self.0.iter().any(|path| file.starts_with(path))
 294     }
 295
 296     pub fn skip_file(&self, file: &FileName) -> bool {
 297         if let FileName::Real(ref path) = file {
 298             self.skip_file_inner(path)
 299         } else {
 300             false
 301         }
 302     }
 303 }
 304
 305 impl ::std::str::FromStr for IgnoreList {
 306     type Err = &'static str;
 307
 308     fn from_str(_: &str) -> Result<Self, Self::Err> {
 309         Err("IgnoreList is not parsable")
 310     }
 311 }
 312
 313 /// Parsed command line options.
 314 #[derive(Clone, Debug, Default)]
 315 pub struct CliOptions {
 316     skip_children: Option<bool>,
 317     verbose: bool,
 318     verbose_diff: bool,
 319     pub(super) config_path: Option<PathBuf>,
 320     write_mode: Option<WriteMode>,
 321     color: Option<Color>,
 322     file_lines: FileLines, // Default is all lines in all files.
 323     unstable_features: bool,
 324     error_on_unformatted: Option<bool>,
 325 }
 326
 327 impl CliOptions {
 328     pub fn from_matches(matches: &Matches) -> FmtResult<CliOptions> {
 329         let mut options = CliOptions::default();
 330         options.verbose = matches.opt_present("verbose");
 331         options.verbose_diff = matches.opt_present("verbose-diff");
 332
 333         let unstable_features = matches.opt_present("unstable-features");
 334         let rust_nightly = option_env!("CFG_RELEASE_CHANNEL")
 335             .map(|c| c == "nightly")
 336             .unwrap_or(false);
 337         if unstable_features && !rust_nightly {
 338             return Err(format_err!(
 339                 "Unstable features are only available on Nightly channel"
 340             ));
 341         } else {
 342             options.unstable_features = unstable_features;
 343         }
 344
 345         options.config_path = matches.opt_str("config-path").map(PathBuf::from);
 346
 347         if let Some(ref write_mode) = matches.opt_str("write-mode") {
 348             if let Ok(write_mode) = WriteMode::from_str(write_mode) {
 349                 options.write_mode = Some(write_mode);
 350             } else {
 351                 return Err(format_err!(
 352                     "Invalid write-mode: {}, expected one of {}",
 353                     write_mode,
 354                     WRITE_MODE_LIST
 355                 ));
 356             }
 357         }
 358
 359         if let Some(ref color) = matches.opt_str("color") {
 360             match Color::from_str(color) {
 361                 Ok(color) => options.color = Some(color),
 362                 _ => return Err(format_err!("Invalid color: {}", color)),
 363             }
 364         }
 365
 366         if let Some(ref file_lines) = matches.opt_str("file-lines") {
 367             options.file_lines = file_lines.parse().map_err(err_msg)?;
 368         }
 369
 370         if matches.opt_present("skip-children") {
 371             options.skip_children = Some(true);
 372         }
 373         if matches.opt_present("error-on-unformatted") {
 374             options.error_on_unformatted = Some(true);
 375         }
 376
 377         Ok(options)
 378     }
 379
 380     pub fn apply_to(self, config: &mut Config) {
 381         config.set().verbose(self.verbose);
 382         config.set().verbose_diff(self.verbose_diff);
 383         config.set().file_lines(self.file_lines);
 384         config.set().unstable_features(self.unstable_features);
 385         if let Some(skip_children) = self.skip_children {
 386             config.set().skip_children(skip_children);
 387         }
 388         if let Some(error_on_unformatted) = self.error_on_unformatted {
 389             config.set().error_on_unformatted(error_on_unformatted);
 390         }
 391         if let Some(write_mode) = self.write_mode {
 392             config.set().write_mode(write_mode);
 393         }
 394         if let Some(color) = self.color {
 395             config.set().color(color);
 396         }
 397     }
 398
 399     pub fn verify_file_lines(&self, files: &[PathBuf]) {
 400         for f in self.file_lines.files() {
 401             match *f {
 402                 FileName::Real(ref f) if files.contains(f) => {}
 403                 FileName::Real(_) => {
 404                     eprintln!("Warning: Extra file listed in file_lines option '{}'", f)
 405                 }
 406                 _ => eprintln!("Warning: Not a file '{}'", f),
 407             }
 408         }
 409     }
 410 }