src/utils.rs

   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.
   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 std::borrow::Cow;
  12
  13 use syntax::{abi, ptr};
  14 use syntax::ast::{self, Attribute, MetaItem, MetaItemKind, NestedMetaItem, NestedMetaItemKind,
  15                   Path, Visibility};
  16 use syntax::codemap::{BytePos, Span, NO_EXPANSION};
  17
  18 use rewrite::RewriteContext;
  19 use shape::Shape;
  20
  21 // When we get scoped annotations, we should have rustfmt::skip.
  22 const SKIP_ANNOTATION: &'static str = "rustfmt_skip";
  23
  24 // Computes the length of a string's last line, minus offset.
  25 pub fn extra_offset(text: &str, shape: Shape) -> usize {
  26     match text.rfind('\n') {
  27         // 1 for newline character
  28         Some(idx) => text.len()
  29             .checked_sub(idx + 1 + shape.used_width())
  30             .unwrap_or(0),
  31         None => text.len(),
  32     }
  33 }
  34
  35 // Uses Cow to avoid allocating in the common cases.
  36 pub fn format_visibility(vis: &Visibility) -> Cow<'static, str> {
  37     match *vis {
  38         Visibility::Public => Cow::from("pub "),
  39         Visibility::Inherited => Cow::from(""),
  40         Visibility::Crate(_) => Cow::from("pub(crate) "),
  41         Visibility::Restricted { ref path, .. } => {
  42             let Path { ref segments, .. } = **path;
  43             let mut segments_iter = segments.iter().map(|seg| seg.identifier.name.to_string());
  44             if path.is_global() {
  45                 segments_iter
  46                     .next()
  47                     .expect("Non-global path in pub(restricted)?");
  48             }
  49             let is_keyword = |s: &str| s == "self" || s == "super";
  50             let path = segments_iter.collect::<Vec<_>>().join("::");
  51             let in_str = if is_keyword(&path) { "" } else { "in " };
  52
  53             Cow::from(format!("pub({}{}) ", in_str, path))
  54         }
  55     }
  56 }
  57
  58 #[inline]
  59 pub fn format_constness(constness: ast::Constness) -> &'static str {
  60     match constness {
  61         ast::Constness::Const => "const ",
  62         ast::Constness::NotConst => "",
  63     }
  64 }
  65
  66 #[inline]
  67 pub fn format_defaultness(defaultness: ast::Defaultness) -> &'static str {
  68     match defaultness {
  69         ast::Defaultness::Default => "default ",
  70         ast::Defaultness::Final => "",
  71     }
  72 }
  73
  74 #[inline]
  75 pub fn format_unsafety(unsafety: ast::Unsafety) -> &'static str {
  76     match unsafety {
  77         ast::Unsafety::Unsafe => "unsafe ",
  78         ast::Unsafety::Normal => "",
  79     }
  80 }
  81
  82 #[inline]
  83 pub fn format_mutability(mutability: ast::Mutability) -> &'static str {
  84     match mutability {
  85         ast::Mutability::Mutable => "mut ",
  86         ast::Mutability::Immutable => "",
  87     }
  88 }
  89
  90 #[inline]
  91 pub fn format_abi(abi: abi::Abi, explicit_abi: bool, is_mod: bool) -> Cow<'static, str> {
  92     if abi == abi::Abi::Rust && !is_mod {
  93         Cow::from("")
  94     } else if abi == abi::Abi::C && !explicit_abi {
  95         Cow::from("extern ")
  96     } else {
  97         Cow::from(format!("extern {} ", abi))
  98     }
  99 }
 100
 101 #[inline]
 102 // Transform `Vec<syntax::ptr::P<T>>` into `Vec<&T>`
 103 pub fn ptr_vec_to_ref_vec<T>(vec: &[ptr::P<T>]) -> Vec<&T> {
 104     vec.iter().map(|x| &**x).collect::<Vec<_>>()
 105 }
 106
 107 #[inline]
 108 pub fn filter_attributes(attrs: &[ast::Attribute], style: ast::AttrStyle) -> Vec<ast::Attribute> {
 109     attrs
 110         .iter()
 111         .filter(|a| a.style == style)
 112         .cloned()
 113         .collect::<Vec<_>>()
 114 }
 115
 116 #[inline]
 117 pub fn inner_attributes(attrs: &[ast::Attribute]) -> Vec<ast::Attribute> {
 118     filter_attributes(attrs, ast::AttrStyle::Inner)
 119 }
 120
 121 #[inline]
 122 pub fn outer_attributes(attrs: &[ast::Attribute]) -> Vec<ast::Attribute> {
 123     filter_attributes(attrs, ast::AttrStyle::Outer)
 124 }
 125
 126 #[inline]
 127 pub fn last_line_contains_single_line_comment(s: &str) -> bool {
 128     s.lines().last().map_or(false, |l| l.contains("//"))
 129 }
 130
 131 #[inline]
 132 pub fn is_attributes_extendable(attrs_str: &str) -> bool {
 133     !attrs_str.contains('\n') && !last_line_contains_single_line_comment(attrs_str)
 134 }
 135
 136 // The width of the first line in s.
 137 #[inline]
 138 pub fn first_line_width(s: &str) -> usize {
 139     match s.find('\n') {
 140         Some(n) => n,
 141         None => s.len(),
 142     }
 143 }
 144
 145 // The width of the last line in s.
 146 #[inline]
 147 pub fn last_line_width(s: &str) -> usize {
 148     match s.rfind('\n') {
 149         Some(n) => s.len() - n - 1,
 150         None => s.len(),
 151     }
 152 }
 153
 154 // The total used width of the last line.
 155 #[inline]
 156 pub fn last_line_used_width(s: &str, offset: usize) -> usize {
 157     if s.contains('\n') {
 158         last_line_width(s)
 159     } else {
 160         offset + s.len()
 161     }
 162 }
 163
 164 #[inline]
 165 pub fn trimmed_last_line_width(s: &str) -> usize {
 166     match s.rfind('\n') {
 167         Some(n) => s[(n + 1)..].trim().len(),
 168         None => s.trim().len(),
 169     }
 170 }
 171
 172 #[inline]
 173 pub fn last_line_extendable(s: &str) -> bool {
 174     if s.ends_with("\"#") {
 175         return true;
 176     }
 177     for c in s.chars().rev() {
 178         match c {
 179             ')' | ']' | '}' | '?' => continue,
 180             '\n' => break,
 181             _ if c.is_whitespace() => continue,
 182             _ => return false,
 183         }
 184     }
 185     true
 186 }
 187
 188 #[inline]
 189 fn is_skip(meta_item: &MetaItem) -> bool {
 190     match meta_item.node {
 191         MetaItemKind::Word => meta_item.name == SKIP_ANNOTATION,
 192         MetaItemKind::List(ref l) => {
 193             meta_item.name == "cfg_attr" && l.len() == 2 && is_skip_nested(&l[1])
 194         }
 195         _ => false,
 196     }
 197 }
 198
 199 #[inline]
 200 fn is_skip_nested(meta_item: &NestedMetaItem) -> bool {
 201     match meta_item.node {
 202         NestedMetaItemKind::MetaItem(ref mi) => is_skip(mi),
 203         NestedMetaItemKind::Literal(_) => false,
 204     }
 205 }
 206
 207 #[inline]
 208 pub fn contains_skip(attrs: &[Attribute]) -> bool {
 209     attrs
 210         .iter()
 211         .any(|a| a.meta().map_or(false, |a| is_skip(&a)))
 212 }
 213
 214 // Find the end of a TyParam
 215 #[inline]
 216 pub fn end_typaram(typaram: &ast::TyParam) -> BytePos {
 217     typaram
 218         .bounds
 219         .last()
 220         .map_or(typaram.span, |bound| match *bound {
 221             ast::RegionTyParamBound(ref lt) => lt.span,
 222             ast::TraitTyParamBound(ref prt, _) => prt.span,
 223         })
 224         .hi()
 225 }
 226
 227 #[inline]
 228 pub fn semicolon_for_expr(context: &RewriteContext, expr: &ast::Expr) -> bool {
 229     match expr.node {
 230         ast::ExprKind::Ret(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Break(..) => {
 231             context.config.trailing_semicolon()
 232         }
 233         _ => false,
 234     }
 235 }
 236
 237 #[inline]
 238 pub fn semicolon_for_stmt(context: &RewriteContext, stmt: &ast::Stmt) -> bool {
 239     match stmt.node {
 240         ast::StmtKind::Semi(ref expr) => match expr.node {
 241             ast::ExprKind::While(..) |
 242             ast::ExprKind::WhileLet(..) |
 243             ast::ExprKind::Loop(..) |
 244             ast::ExprKind::ForLoop(..) => false,
 245             ast::ExprKind::Break(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Ret(..) => {
 246                 context.config.trailing_semicolon()
 247             }
 248             _ => true,
 249         },
 250         ast::StmtKind::Expr(..) => false,
 251         _ => true,
 252     }
 253 }
 254
 255 #[inline]
 256 pub fn stmt_expr(stmt: &ast::Stmt) -> Option<&ast::Expr> {
 257     match stmt.node {
 258         ast::StmtKind::Expr(ref expr) => Some(expr),
 259         _ => None,
 260     }
 261 }
 262
 263 #[inline]
 264 pub fn trim_newlines(input: &str) -> &str {
 265     match input.find(|c| c != '\n' && c != '\r') {
 266         Some(start) => {
 267             let end = input.rfind(|c| c != '\n' && c != '\r').unwrap_or(0) + 1;
 268             &input[start..end]
 269         }
 270         None => "",
 271     }
 272 }
 273
 274 // Macro for deriving implementations of Serialize/Deserialize for enums
 275 #[macro_export]
 276 macro_rules! impl_enum_serialize_and_deserialize {
 277     ( $e:ident, $( $x:ident ),* ) => {
 278         impl ::serde::ser::Serialize for $e {
 279             fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
 280                 where S: ::serde::ser::Serializer
 281             {
 282                 use serde::ser::Error;
 283
 284                 // We don't know whether the user of the macro has given us all options.
 285                 #[allow(unreachable_patterns)]
 286                 match *self {
 287                     $(
 288                         $e::$x => serializer.serialize_str(stringify!($x)),
 289                     )*
 290                     _ => {
 291                         Err(S::Error::custom(format!("Cannot serialize {:?}", self)))
 292                     }
 293                 }
 294             }
 295         }
 296
 297         impl<'de> ::serde::de::Deserialize<'de> for $e {
 298             fn deserialize<D>(d: D) -> Result<Self, D::Error>
 299                     where D: ::serde::Deserializer<'de> {
 300                 use std::ascii::AsciiExt;
 301                 use serde::de::{Error, Visitor};
 302                 use std::marker::PhantomData;
 303                 use std::fmt;
 304                 struct StringOnly<T>(PhantomData<T>);
 305                 impl<'de, T> Visitor<'de> for StringOnly<T>
 306                         where T: ::serde::Deserializer<'de> {
 307                     type Value = String;
 308                     fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
 309                         formatter.write_str("string")
 310                     }
 311                     fn visit_str<E>(self, value: &str) -> Result<String, E> {
 312                         Ok(String::from(value))
 313                     }
 314                 }
 315                 let s = d.deserialize_string(StringOnly::<D>(PhantomData))?;
 316                 $(
 317                     if stringify!($x).eq_ignore_ascii_case(&s) {
 318                       return Ok($e::$x);
 319                     }
 320                 )*
 321                 static ALLOWED: &'static[&str] = &[$(stringify!($x),)*];
 322                 Err(D::Error::unknown_variant(&s, ALLOWED))
 323             }
 324         }
 325
 326         impl ::std::str::FromStr for $e {
 327             type Err = &'static str;
 328
 329             fn from_str(s: &str) -> Result<Self, Self::Err> {
 330                 use std::ascii::AsciiExt;
 331                 $(
 332                     if stringify!($x).eq_ignore_ascii_case(s) {
 333                         return Ok($e::$x);
 334                     }
 335                 )*
 336                 Err("Bad variant")
 337             }
 338         }
 339
 340         impl ::config::ConfigType for $e {
 341             fn doc_hint() -> String {
 342                 let mut variants = Vec::new();
 343                 $(
 344                     variants.push(stringify!($x));
 345                 )*
 346                 format!("[{}]", variants.join("|"))
 347             }
 348         }
 349     };
 350 }
 351
 352 macro_rules! msg {
 353     ($($arg:tt)*) => (
 354         match writeln!(&mut ::std::io::stderr(), $($arg)* ) {
 355             Ok(_) => {},
 356             Err(x) => panic!("Unable to write to stderr: {}", x),
 357         }
 358     )
 359 }
 360
 361 // For format_missing and last_pos, need to use the source callsite (if applicable).
 362 // Required as generated code spans aren't guaranteed to follow on from the last span.
 363 macro_rules! source {
 364     ($this:ident, $sp: expr) => {
 365         $sp.source_callsite()
 366     }
 367 }
 368
 369 pub fn mk_sp(lo: BytePos, hi: BytePos) -> Span {
 370     Span::new(lo, hi, NO_EXPANSION)
 371 }
 372
 373 // Return true if the given span does not intersect with file lines.
 374 macro_rules! out_of_file_lines_range {
 375     ($self:ident, $span:expr) => {
 376         !$self.config
 377             .file_lines()
 378             .intersects(&$self.codemap.lookup_line_range($span))
 379     }
 380 }
 381
 382 macro_rules! skip_out_of_file_lines_range {
 383     ($self:ident, $span:expr) => {
 384         if out_of_file_lines_range!($self, $span) {
 385             return None;
 386         }
 387     }
 388 }
 389
 390 macro_rules! skip_out_of_file_lines_range_visitor {
 391     ($self:ident, $span:expr) => {
 392         if out_of_file_lines_range!($self, $span) {
 393             $self.push_rewrite($span, None);
 394             return;
 395         }
 396     }
 397 }
 398
 399 // Wraps String in an Option. Returns Some when the string adheres to the
 400 // Rewrite constraints defined for the Rewrite trait and else otherwise.
 401 pub fn wrap_str(s: String, max_width: usize, shape: Shape) -> Option<String> {
 402     if is_valid_str(&s, max_width, shape) {
 403         Some(s)
 404     } else {
 405         None
 406     }
 407 }
 408
 409 fn is_valid_str(snippet: &str, max_width: usize, shape: Shape) -> bool {
 410     if !snippet.is_empty() {
 411         // First line must fits with `shape.width`.
 412         if first_line_width(snippet) > shape.width {
 413             return false;
 414         }
 415         // If the snippet does not include newline, we are done.
 416         if first_line_width(snippet) == snippet.len() {
 417             return true;
 418         }
 419         // The other lines must fit within the maximum width.
 420         if snippet.lines().skip(1).any(|line| line.len() > max_width) {
 421             return false;
 422         }
 423         // A special check for the last line, since the caller may
 424         // place trailing characters on this line.
 425         if last_line_width(snippet) > shape.used_width() + shape.width {
 426             return false;
 427         }
 428     }
 429     true
 430 }
 431
 432 #[inline]
 433 pub fn colon_spaces(before: bool, after: bool) -> &'static str {
 434     match (before, after) {
 435         (true, true) => " : ",
 436         (true, false) => " :",
 437         (false, true) => ": ",
 438         (false, false) => ":",
 439     }
 440 }
 441
 442 #[inline]
 443 pub fn paren_overhead(context: &RewriteContext) -> usize {
 444     if context.config.spaces_within_parens() {
 445         4
 446     } else {
 447         2
 448     }
 449 }
 450
 451 pub fn left_most_sub_expr(e: &ast::Expr) -> &ast::Expr {
 452     match e.node {
 453         ast::ExprKind::InPlace(ref e, _) |
 454         ast::ExprKind::Call(ref e, _) |
 455         ast::ExprKind::Binary(_, ref e, _) |
 456         ast::ExprKind::Cast(ref e, _) |
 457         ast::ExprKind::Type(ref e, _) |
 458         ast::ExprKind::Assign(ref e, _) |
 459         ast::ExprKind::AssignOp(_, ref e, _) |
 460         ast::ExprKind::Field(ref e, _) |
 461         ast::ExprKind::TupField(ref e, _) |
 462         ast::ExprKind::Index(ref e, _) |
 463         ast::ExprKind::Range(Some(ref e), _, _) |
 464         ast::ExprKind::Try(ref e) => left_most_sub_expr(e),
 465         _ => e,
 466     }
 467 }
 468
 469 // isatty shamelessly adapted from cargo.
 470 #[cfg(unix)]
 471 pub fn isatty() -> bool {
 472     extern crate libc;
 473
 474     unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
 475 }
 476 #[cfg(windows)]
 477 pub fn isatty() -> bool {
 478     extern crate kernel32;
 479     extern crate winapi;
 480
 481     unsafe {
 482         let handle = kernel32::GetStdHandle(winapi::winbase::STD_OUTPUT_HANDLE);
 483         let mut out = 0;
 484         kernel32::GetConsoleMode(handle, &mut out) != 0
 485     }
 486 }
 487
 488 pub fn starts_with_newline(s: &str) -> bool {
 489     s.starts_with('\n') || s.starts_with("\r\n")
 490 }