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.
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.
11 use config::config_type::ConfigType;
13 use config::{Config, FileName};
15 use isatty::stdout_isatty;
17 use std::collections::HashSet;
18 use std::path::{Path, PathBuf};
20 /// Macro for deriving implementations of Serialize/Deserialize for enums
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
28 use serde::ser::Error;
30 // We don't know whether the user of the macro has given us all options.
31 #[allow(unreachable_patterns)]
34 $e::$x => serializer.serialize_str(stringify!($x)),
37 Err(S::Error::custom(format!("Cannot serialize {:?}", self)))
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;
49 struct StringOnly<T>(PhantomData<T>);
50 impl<'de, T> Visitor<'de> for StringOnly<T>
51 where T: ::serde::Deserializer<'de> {
53 fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
54 formatter.write_str("string")
56 fn visit_str<E>(self, value: &str) -> Result<String, E> {
57 Ok(String::from(value))
60 let s = d.deserialize_string(StringOnly::<D>(PhantomData))?;
62 if stringify!($x).eq_ignore_ascii_case(&s) {
66 static ALLOWED: &'static[&str] = &[$(stringify!($x),)*];
67 Err(D::Error::unknown_variant(&s, ALLOWED))
71 impl ::std::str::FromStr for $e {
72 type Err = &'static str;
74 fn from_str(s: &str) -> Result<Self, Self::Err> {
76 if stringify!($x).eq_ignore_ascii_case(s) {
84 impl ConfigType for $e {
85 fn doc_hint() -> String {
86 let mut variants = Vec::new();
88 variants.push(stringify!($x));
90 format!("[{}]", variants.join("|"))
96 macro_rules! configuration_option_enum{
97 ($e:ident: $( $x:ident ),+ $(,)*) => {
98 #[derive(Copy, Clone, Eq, PartialEq, Debug)]
103 impl_enum_serialize_and_deserialize!($e, $( $x ),+);
107 configuration_option_enum! { NewlineStyle:
110 Native, // \r\n in Windows, \n on other platforms
113 configuration_option_enum! { BraceStyle:
116 // Prefer same line except where there is a where clause, in which case force
117 // the brace to the next line.
121 configuration_option_enum! { ControlBraceStyle:
122 // K&R style, Rust community default
130 configuration_option_enum! { IndentStyle:
131 // First line on the same line as the opening brace, all lines aligned with
134 // First line is on a new line and all lines align with block indent.
138 configuration_option_enum! { Density:
139 // Fit as much on one line as possible.
143 // Place every item on a separate line.
147 configuration_option_enum! { TypeDensity:
148 // No spaces around "=" and "+"
150 // Spaces around " = " and " + "
155 pub fn to_list_tactic(self) -> ListTactic {
157 Density::Compressed => ListTactic::Mixed,
158 Density::Tall => ListTactic::HorizontalVertical,
159 Density::Vertical => ListTactic::Vertical,
164 configuration_option_enum! { ReportTactic:
170 // What Rustfmt should emit. Mostly corresponds to the `--emit` command line
172 configuration_option_enum! { EmitMode:
175 // Writes the output to stdout.
177 // Displays how much of the input file was processed
181 // Output the changed lines (for internal value only)
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`.
189 // Client-preference for coloured output.
190 configuration_option_enum! { Color:
191 // Always use color, whether it is a piped or terminal output
195 // Automatically use color, if supported by terminal
200 /// Whether we should use a coloured terminal.
201 pub fn use_colored_tty(&self) -> bool {
203 Color::Always => true,
204 Color::Never => false,
205 Color::Auto => stdout_isatty(),
210 // How chatty should Rustfmt be?
211 configuration_option_enum! { Verbosity:
215 // Emit as little as possible.
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
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,
240 impl WidthHeuristics {
241 // Using this WidthHeuristics means we ignore heuristics.
242 pub fn null() -> WidthHeuristics {
244 fn_call_width: usize::max_value(),
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,
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
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,
274 impl ::std::str::FromStr for WidthHeuristics {
275 type Err = &'static str;
277 fn from_str(_: &str) -> Result<Self, Self::Err> {
278 Err("WidthHeuristics is not parsable")
282 impl Default for EmitMode {
283 fn default() -> EmitMode {
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>);
293 pub fn add_prefix(&mut self, dir: &Path) {
301 let mut path = PathBuf::from(dir);
309 fn skip_file_inner(&self, file: &Path) -> bool {
310 self.0.iter().any(|path| file.starts_with(path))
313 pub fn skip_file(&self, file: &FileName) -> bool {
314 if let FileName::Real(ref path) = file {
315 self.skip_file_inner(path)
322 impl ::std::str::FromStr for IgnoreList {
323 type Err = &'static str;
325 fn from_str(_: &str) -> Result<Self, Self::Err> {
326 Err("IgnoreList is not parsable")
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>;