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, CrateSugar, MetaItem, MetaItemKind, NestedMetaItem,
  15                   NestedMetaItemKind, Path, Visibility};
  16 use syntax::codemap::{BytePos, Span, NO_EXPANSION};
  17
  18 use config::Color;
  19 use rewrite::RewriteContext;
  20 use shape::Shape;
  21
  22 // When we get scoped annotations, we should have rustfmt::skip.
  23 const SKIP_ANNOTATION: &str = "rustfmt_skip";
  24
  25 // Computes the length of a string's last line, minus offset.
  26 pub fn extra_offset(text: &str, shape: Shape) -> usize {
  27     match text.rfind('\n') {
  28         // 1 for newline character
  29         Some(idx) => text.len()
  30             .checked_sub(idx + 1 + shape.used_width())
  31             .unwrap_or(0),
  32         None => text.len(),
  33     }
  34 }
  35
  36 // Uses Cow to avoid allocating in the common cases.
  37 pub fn format_visibility(vis: &Visibility) -> Cow<'static, str> {
  38     match *vis {
  39         Visibility::Public => Cow::from("pub "),
  40         Visibility::Inherited => Cow::from(""),
  41         Visibility::Crate(_, CrateSugar::PubCrate) => Cow::from("pub(crate) "),
  42         Visibility::Crate(_, CrateSugar::JustCrate) => Cow::from("crate "),
  43         Visibility::Restricted { ref path, .. } => {
  44             let Path { ref segments, .. } = **path;
  45             let mut segments_iter = segments.iter().map(|seg| seg.identifier.name.to_string());
  46             if path.is_global() {
  47                 segments_iter
  48                     .next()
  49                     .expect("Non-global path in pub(restricted)?");
  50             }
  51             let is_keyword = |s: &str| s == "self" || s == "super";
  52             let path = segments_iter.collect::<Vec<_>>().join("::");
  53             let in_str = if is_keyword(&path) { "" } else { "in " };
  54
  55             Cow::from(format!("pub({}{}) ", in_str, path))
  56         }
  57     }
  58 }
  59
  60 #[inline]
  61 pub fn format_constness(constness: ast::Constness) -> &'static str {
  62     match constness {
  63         ast::Constness::Const => "const ",
  64         ast::Constness::NotConst => "",
  65     }
  66 }
  67
  68 #[inline]
  69 pub fn format_defaultness(defaultness: ast::Defaultness) -> &'static str {
  70     match defaultness {
  71         ast::Defaultness::Default => "default ",
  72         ast::Defaultness::Final => "",
  73     }
  74 }
  75
  76 #[inline]
  77 pub fn format_unsafety(unsafety: ast::Unsafety) -> &'static str {
  78     match unsafety {
  79         ast::Unsafety::Unsafe => "unsafe ",
  80         ast::Unsafety::Normal => "",
  81     }
  82 }
  83
  84 #[inline]
  85 pub fn format_mutability(mutability: ast::Mutability) -> &'static str {
  86     match mutability {
  87         ast::Mutability::Mutable => "mut ",
  88         ast::Mutability::Immutable => "",
  89     }
  90 }
  91
  92 #[inline]
  93 pub fn format_abi(abi: abi::Abi, explicit_abi: bool, is_mod: bool) -> Cow<'static, str> {
  94     if abi == abi::Abi::Rust && !is_mod {
  95         Cow::from("")
  96     } else if abi == abi::Abi::C && !explicit_abi {
  97         Cow::from("extern ")
  98     } else {
  99         Cow::from(format!("extern {} ", abi))
 100     }
 101 }
 102
 103 #[inline]
 104 // Transform `Vec<syntax::ptr::P<T>>` into `Vec<&T>`
 105 pub fn ptr_vec_to_ref_vec<T>(vec: &[ptr::P<T>]) -> Vec<&T> {
 106     vec.iter().map(|x| &**x).collect::<Vec<_>>()
 107 }
 108
 109 #[inline]
 110 pub fn filter_attributes(attrs: &[ast::Attribute], style: ast::AttrStyle) -> Vec<ast::Attribute> {
 111     attrs
 112         .iter()
 113         .filter(|a| a.style == style)
 114         .cloned()
 115         .collect::<Vec<_>>()
 116 }
 117
 118 #[inline]
 119 pub fn inner_attributes(attrs: &[ast::Attribute]) -> Vec<ast::Attribute> {
 120     filter_attributes(attrs, ast::AttrStyle::Inner)
 121 }
 122
 123 #[inline]
 124 pub fn outer_attributes(attrs: &[ast::Attribute]) -> Vec<ast::Attribute> {
 125     filter_attributes(attrs, ast::AttrStyle::Outer)
 126 }
 127
 128 #[inline]
 129 pub fn last_line_contains_single_line_comment(s: &str) -> bool {
 130     s.lines().last().map_or(false, |l| l.contains("//"))
 131 }
 132
 133 #[inline]
 134 pub fn is_attributes_extendable(attrs_str: &str) -> bool {
 135     !attrs_str.contains('\n') && !last_line_contains_single_line_comment(attrs_str)
 136 }
 137
 138 // The width of the first line in s.
 139 #[inline]
 140 pub fn first_line_width(s: &str) -> usize {
 141     match s.find('\n') {
 142         Some(n) => n,
 143         None => s.len(),
 144     }
 145 }
 146
 147 // The width of the last line in s.
 148 #[inline]
 149 pub fn last_line_width(s: &str) -> usize {
 150     match s.rfind('\n') {
 151         Some(n) => s.len() - n - 1,
 152         None => s.len(),
 153     }
 154 }
 155
 156 // The total used width of the last line.
 157 #[inline]
 158 pub fn last_line_used_width(s: &str, offset: usize) -> usize {
 159     if s.contains('\n') {
 160         last_line_width(s)
 161     } else {
 162         offset + s.len()
 163     }
 164 }
 165
 166 #[inline]
 167 pub fn trimmed_last_line_width(s: &str) -> usize {
 168     match s.rfind('\n') {
 169         Some(n) => s[(n + 1)..].trim().len(),
 170         None => s.trim().len(),
 171     }
 172 }
 173
 174 #[inline]
 175 pub fn last_line_extendable(s: &str) -> bool {
 176     if s.ends_with("\"#") {
 177         return true;
 178     }
 179     for c in s.chars().rev() {
 180         match c {
 181             ')' | ']' | '}' | '?' => continue,
 182             '\n' => break,
 183             _ if c.is_whitespace() => continue,
 184             _ => return false,
 185         }
 186     }
 187     true
 188 }
 189
 190 #[inline]
 191 fn is_skip(meta_item: &MetaItem) -> bool {
 192     match meta_item.node {
 193         MetaItemKind::Word => meta_item.name == SKIP_ANNOTATION,
 194         MetaItemKind::List(ref l) => {
 195             meta_item.name == "cfg_attr" && l.len() == 2 && is_skip_nested(&l[1])
 196         }
 197         _ => false,
 198     }
 199 }
 200
 201 #[inline]
 202 fn is_skip_nested(meta_item: &NestedMetaItem) -> bool {
 203     match meta_item.node {
 204         NestedMetaItemKind::MetaItem(ref mi) => is_skip(mi),
 205         NestedMetaItemKind::Literal(_) => false,
 206     }
 207 }
 208
 209 #[inline]
 210 pub fn contains_skip(attrs: &[Attribute]) -> bool {
 211     attrs
 212         .iter()
 213         .any(|a| a.meta().map_or(false, |a| is_skip(&a)))
 214 }
 215
 216 // Find the end of a TyParam
 217 #[inline]
 218 pub fn end_typaram(typaram: &ast::TyParam) -> BytePos {
 219     typaram
 220         .bounds
 221         .last()
 222         .map_or(typaram.span, |bound| match *bound {
 223             ast::RegionTyParamBound(ref lt) => lt.span,
 224             ast::TraitTyParamBound(ref prt, _) => prt.span,
 225         })
 226         .hi()
 227 }
 228
 229 #[inline]
 230 pub fn semicolon_for_expr(context: &RewriteContext, expr: &ast::Expr) -> bool {
 231     match expr.node {
 232         ast::ExprKind::Ret(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Break(..) => {
 233             context.config.trailing_semicolon()
 234         }
 235         _ => false,
 236     }
 237 }
 238
 239 #[inline]
 240 pub fn semicolon_for_stmt(context: &RewriteContext, stmt: &ast::Stmt) -> bool {
 241     match stmt.node {
 242         ast::StmtKind::Semi(ref expr) => match expr.node {
 243             ast::ExprKind::While(..) |
 244             ast::ExprKind::WhileLet(..) |
 245             ast::ExprKind::Loop(..) |
 246             ast::ExprKind::ForLoop(..) => false,
 247             ast::ExprKind::Break(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Ret(..) => {
 248                 context.config.trailing_semicolon()
 249             }
 250             _ => true,
 251         },
 252         ast::StmtKind::Expr(..) => false,
 253         _ => true,
 254     }
 255 }
 256
 257 #[inline]
 258 pub fn stmt_expr(stmt: &ast::Stmt) -> Option<&ast::Expr> {
 259     match stmt.node {
 260         ast::StmtKind::Expr(ref expr) => Some(expr),
 261         _ => None,
 262     }
 263 }
 264
 265 #[inline]
 266 pub fn trim_newlines(input: &str) -> &str {
 267     match input.find(|c| c != '\n' && c != '\r') {
 268         Some(start) => {
 269             let end = input.rfind(|c| c != '\n' && c != '\r').unwrap_or(0) + 1;
 270             &input[start..end]
 271         }
 272         None => "",
 273     }
 274 }
 275
 276 // Macro for deriving implementations of Serialize/Deserialize for enums
 277 #[macro_export]
 278 macro_rules! impl_enum_serialize_and_deserialize {
 279     ( $e:ident, $( $x:ident ),* ) => {
 280         impl ::serde::ser::Serialize for $e {
 281             fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
 282                 where S: ::serde::ser::Serializer
 283             {
 284                 use serde::ser::Error;
 285
 286                 // We don't know whether the user of the macro has given us all options.
 287                 #[allow(unreachable_patterns)]
 288                 match *self {
 289                     $(
 290                         $e::$x => serializer.serialize_str(stringify!($x)),
 291                     )*
 292                     _ => {
 293                         Err(S::Error::custom(format!("Cannot serialize {:?}", self)))
 294                     }
 295                 }
 296             }
 297         }
 298
 299         impl<'de> ::serde::de::Deserialize<'de> for $e {
 300             fn deserialize<D>(d: D) -> Result<Self, D::Error>
 301                     where D: ::serde::Deserializer<'de> {
 302                 use serde::de::{Error, Visitor};
 303                 use std::marker::PhantomData;
 304                 use std::fmt;
 305                 struct StringOnly<T>(PhantomData<T>);
 306                 impl<'de, T> Visitor<'de> for StringOnly<T>
 307                         where T: ::serde::Deserializer<'de> {
 308                     type Value = String;
 309                     fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
 310                         formatter.write_str("string")
 311                     }
 312                     fn visit_str<E>(self, value: &str) -> Result<String, E> {
 313                         Ok(String::from(value))
 314                     }
 315                 }
 316                 let s = d.deserialize_string(StringOnly::<D>(PhantomData))?;
 317                 $(
 318                     if stringify!($x).eq_ignore_ascii_case(&s) {
 319                       return Ok($e::$x);
 320                     }
 321                 )*
 322                 static ALLOWED: &'static[&str] = &[$(stringify!($x),)*];
 323                 Err(D::Error::unknown_variant(&s, ALLOWED))
 324             }
 325         }
 326
 327         impl ::std::str::FromStr for $e {
 328             type Err = &'static str;
 329
 330             fn from_str(s: &str) -> Result<Self, Self::Err> {
 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_and_brackets() {
 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 use_colored_tty(color: Color) -> bool {
 489     match color {
 490         Color::Always => true,
 491         Color::Never => false,
 492         Color::Auto => isatty(),
 493     }
 494 }
 495
 496 pub fn starts_with_newline(s: &str) -> bool {
 497     s.starts_with('\n') || s.starts_with("\r\n")
 498 }