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 config::config_type::ConfigType;
  12 use config::lists::*;
  13 use config::{Config, FileName};
  14
  15 use isatty::stdout_isatty;
  16
  17 use std::collections::HashSet;
  18 use std::path::{Path, PathBuf};
  19
  20 /// Macro for deriving implementations of Serialize/Deserialize for enums
  21 #[macro_export]
  22 macro_rules! impl_enum_serialize_and_deserialize {
  23     ( $e:ident, $( $x:ident ),* ) => {
  24         impl ::serde::ser::Serialize for $e {
  25             fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
  26                 where S: ::serde::ser::Serializer
  27             {
  28                 use serde::ser::Error;
  29
  30                 // We don't know whether the user of the macro has given us all options.
  31                 #[allow(unreachable_patterns)]
  32                 match *self {
  33                     $(
  34                         $e::$x => serializer.serialize_str(stringify!($x)),
  35                     )*
  36                     _ => {
  37                         Err(S::Error::custom(format!("Cannot serialize {:?}", self)))
  38                     }
  39                 }
  40             }
  41         }
  42
  43         impl<'de> ::serde::de::Deserialize<'de> for $e {
  44             fn deserialize<D>(d: D) -> Result<Self, D::Error>
  45                     where D: ::serde::Deserializer<'de> {
  46                 use serde::de::{Error, Visitor};
  47                 use std::marker::PhantomData;
  48                 use std::fmt;
  49                 struct StringOnly<T>(PhantomData<T>);
  50                 impl<'de, T> Visitor<'de> for StringOnly<T>
  51                         where T: ::serde::Deserializer<'de> {
  52                     type Value = String;
  53                     fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
  54                         formatter.write_str("string")
  55                     }
  56                     fn visit_str<E>(self, value: &str) -> Result<String, E> {
  57                         Ok(String::from(value))
  58                     }
  59                 }
  60                 let s = d.deserialize_string(StringOnly::<D>(PhantomData))?;
  61                 $(
  62                     if stringify!($x).eq_ignore_ascii_case(&s) {
  63                       return Ok($e::$x);
  64                     }
  65                 )*
  66                 static ALLOWED: &'static[&str] = &[$(stringify!($x),)*];
  67                 Err(D::Error::unknown_variant(&s, ALLOWED))
  68             }
  69         }
  70
  71         impl ::std::str::FromStr for $e {
  72             type Err = &'static str;
  73
  74             fn from_str(s: &str) -> Result<Self, Self::Err> {
  75                 $(
  76                     if stringify!($x).eq_ignore_ascii_case(s) {
  77                         return Ok($e::$x);
  78                     }
  79                 )*
  80                 Err("Bad variant")
  81             }
  82         }
  83
  84         impl ConfigType for $e {
  85             fn doc_hint() -> String {
  86                 let mut variants = Vec::new();
  87                 $(
  88                     variants.push(stringify!($x));
  89                 )*
  90                 format!("[{}]", variants.join("|"))
  91             }
  92         }
  93     };
  94 }
  95
  96 macro_rules! configuration_option_enum{
  97     ($e:ident: $( $x:ident ),+ $(,)*) => {
  98         #[derive(Copy, Clone, Eq, PartialEq, Debug)]
  99         pub enum $e {
 100             $( $x ),+
 101         }
 102
 103         impl_enum_serialize_and_deserialize!($e, $( $x ),+);
 104     }
 105 }
 106
 107 configuration_option_enum! { NewlineStyle:
 108     Windows, // \r\n
 109     Unix, // \n
 110     Native, // \r\n in Windows, \n on other platforms
 111 }
 112
 113 configuration_option_enum! { BraceStyle:
 114     AlwaysNextLine,
 115     PreferSameLine,
 116     // Prefer same line except where there is a where clause, in which case force
 117     // the brace to the next line.
 118     SameLineWhere,
 119 }
 120
 121 configuration_option_enum! { ControlBraceStyle:
 122     // K&R style, Rust community default
 123     AlwaysSameLine,
 124     // Stroustrup style
 125     ClosingNextLine,
 126     // Allman style
 127     AlwaysNextLine,
 128 }
 129
 130 configuration_option_enum! { IndentStyle:
 131     // First line on the same line as the opening brace, all lines aligned with
 132     // the first line.
 133     Visual,
 134     // First line is on a new line and all lines align with block indent.
 135     Block,
 136 }
 137
 138 configuration_option_enum! { Density:
 139     // Fit as much on one line as possible.
 140     Compressed,
 141     // Use more lines.
 142     Tall,
 143     // Place every item on a separate line.
 144     Vertical,
 145 }
 146
 147 configuration_option_enum! { TypeDensity:
 148     // No spaces around "=" and "+"
 149     Compressed,
 150     // Spaces around " = " and " + "
 151     Wide,
 152 }
 153
 154 impl Density {
 155     pub fn to_list_tactic(self) -> ListTactic {
 156         match self {
 157             Density::Compressed => ListTactic::Mixed,
 158             Density::Tall => ListTactic::HorizontalVertical,
 159             Density::Vertical => ListTactic::Vertical,
 160         }
 161     }
 162 }
 163
 164 configuration_option_enum! { ReportTactic:
 165     Always,
 166     Unnumbered,
 167     Never,
 168 }
 169
 170 // What Rustfmt should emit. Mostly corresponds to the `--emit` command line
 171 // option.
 172 configuration_option_enum! { EmitMode:
 173     // Emits to files.
 174     Files,
 175     // Writes the output to stdout.
 176     Stdout,
 177     // Displays how much of the input file was processed
 178     Coverage,
 179     // Unfancy stdout
 180     Checkstyle,
 181     // Output the changed lines (for internal value only)
 182     ModifiedLines,
 183     // Checks if a diff can be generated. If so, rustfmt outputs a diff and quits with exit code 1.
 184     // This option is designed to be run in CI where a non-zero exit signifies non-standard code
 185     // formatting. Used for `--check`.
 186     Diff,
 187 }
 188
 189 // Client-preference for coloured output.
 190 configuration_option_enum! { Color:
 191     // Always use color, whether it is a piped or terminal output
 192     Always,
 193     // Never use color
 194     Never,
 195     // Automatically use color, if supported by terminal
 196     Auto,
 197 }
 198
 199 impl Color {
 200     /// Whether we should use a coloured terminal.
 201     pub fn use_colored_tty(&self) -> bool {
 202         match self {
 203             Color::Always => true,
 204             Color::Never => false,
 205             Color::Auto => stdout_isatty(),
 206         }
 207     }
 208 }
 209
 210 // How chatty should Rustfmt be?
 211 configuration_option_enum! { Verbosity:
 212     // Emit more.
 213     Verbose,
 214     Normal,
 215     // Emit as little as possible.
 216     Quiet,
 217 }
 218
 219 #[derive(Deserialize, Serialize, Clone, Debug)]
 220 pub struct WidthHeuristics {
 221     // Maximum width of the args of a function call before falling back
 222     // to vertical formatting.
 223     pub fn_call_width: usize,
 224     // Maximum width in the body of a struct lit before falling back to
 225     // vertical formatting.
 226     pub struct_lit_width: usize,
 227     // Maximum width in the body of a struct variant before falling back
 228     // to vertical formatting.
 229     pub struct_variant_width: usize,
 230     // Maximum width of an array literal before falling back to vertical
 231     // formatting.
 232     pub array_width: usize,
 233     // Maximum length of a chain to fit on a single line.
 234     pub chain_width: usize,
 235     // Maximum line length for single line if-else expressions. A value
 236     // of zero means always break if-else expressions.
 237     pub single_line_if_else_max_width: usize,
 238 }
 239
 240 impl WidthHeuristics {
 241     // Using this WidthHeuristics means we ignore heuristics.
 242     pub fn null() -> WidthHeuristics {
 243         WidthHeuristics {
 244             fn_call_width: usize::max_value(),
 245             struct_lit_width: 0,
 246             struct_variant_width: 0,
 247             array_width: usize::max_value(),
 248             chain_width: usize::max_value(),
 249             single_line_if_else_max_width: 0,
 250         }
 251     }
 252
 253     // scale the default WidthHeuristics according to max_width
 254     pub fn scaled(max_width: usize) -> WidthHeuristics {
 255         const DEFAULT_MAX_WIDTH: usize = 100;
 256         let max_width_ratio = if max_width > DEFAULT_MAX_WIDTH {
 257             let ratio = max_width as f32 / DEFAULT_MAX_WIDTH as f32;
 258             // round to the closest 0.1
 259             (ratio * 10.0).round() / 10.0
 260         } else {
 261             1.0
 262         };
 263         WidthHeuristics {
 264             fn_call_width: (60.0 * max_width_ratio).round() as usize,
 265             struct_lit_width: (18.0 * max_width_ratio).round() as usize,
 266             struct_variant_width: (35.0 * max_width_ratio).round() as usize,
 267             array_width: (60.0 * max_width_ratio).round() as usize,
 268             chain_width: (60.0 * max_width_ratio).round() as usize,
 269             single_line_if_else_max_width: (50.0 * max_width_ratio).round() as usize,
 270         }
 271     }
 272 }
 273
 274 impl ::std::str::FromStr for WidthHeuristics {
 275     type Err = &'static str;
 276
 277     fn from_str(_: &str) -> Result<Self, Self::Err> {
 278         Err("WidthHeuristics is not parsable")
 279     }
 280 }
 281
 282 impl Default for EmitMode {
 283     fn default() -> EmitMode {
 284         EmitMode::Files
 285     }
 286 }
 287
 288 /// A set of directories, files and modules that rustfmt should ignore.
 289 #[derive(Default, Deserialize, Serialize, Clone, Debug)]
 290 pub struct IgnoreList(HashSet<PathBuf>);
 291
 292 impl IgnoreList {
 293     pub fn add_prefix(&mut self, dir: &Path) {
 294         self.0 = self
 295             .0
 296             .iter()
 297             .map(|s| {
 298                 if s.has_root() {
 299                     s.clone()
 300                 } else {
 301                     let mut path = PathBuf::from(dir);
 302                     path.push(s);
 303                     path
 304                 }
 305             })
 306             .collect();
 307     }
 308
 309     fn skip_file_inner(&self, file: &Path) -> bool {
 310         self.0.iter().any(|path| file.starts_with(path))
 311     }
 312
 313     pub fn skip_file(&self, file: &FileName) -> bool {
 314         if let FileName::Real(ref path) = file {
 315             self.skip_file_inner(path)
 316         } else {
 317             false
 318         }
 319     }
 320 }
 321
 322 impl ::std::str::FromStr for IgnoreList {
 323     type Err = &'static str;
 324
 325     fn from_str(_: &str) -> Result<Self, Self::Err> {
 326         Err("IgnoreList is not parsable")
 327     }
 328 }
 329
 330 /// Maps client-supplied options to Rustfmt's internals, mostly overriding
 331 /// values in a config with values from the command line.
 332 pub trait CliOptions {
 333     fn apply_to(self, config: &mut Config);
 334     fn config_path(&self) -> Option<&Path>;
 335 }