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::ast::{self, Attribute, CrateSugar, MetaItem, MetaItemKind, NestedMetaItem,
  14                   NestedMetaItemKind, Path, Visibility, VisibilityKind};
  15 use syntax::codemap::{BytePos, Span, NO_EXPANSION};
  16 use syntax::{abi, ptr};
  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.node {
  39         VisibilityKind::Public => Cow::from("pub "),
  40         VisibilityKind::Inherited => Cow::from(""),
  41         VisibilityKind::Crate(CrateSugar::PubCrate) => Cow::from("pub(crate) "),
  42         VisibilityKind::Crate(CrateSugar::JustCrate) => Cow::from("crate "),
  43         VisibilityKind::Restricted { ref path, .. } => {
  44             let Path { ref segments, .. } = **path;
  45             let mut segments_iter = segments.iter().map(|seg| seg.ident.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_auto(is_auto: ast::IsAuto) -> &'static str {
  86     match is_auto {
  87         ast::IsAuto::Yes => "auto ",
  88         ast::IsAuto::No => "",
  89     }
  90 }
  91
  92 #[inline]
  93 pub fn format_mutability(mutability: ast::Mutability) -> &'static str {
  94     match mutability {
  95         ast::Mutability::Mutable => "mut ",
  96         ast::Mutability::Immutable => "",
  97     }
  98 }
  99
 100 #[inline]
 101 pub fn format_abi(abi: abi::Abi, explicit_abi: bool, is_mod: bool) -> Cow<'static, str> {
 102     if abi == abi::Abi::Rust && !is_mod {
 103         Cow::from("")
 104     } else if abi == abi::Abi::C && !explicit_abi {
 105         Cow::from("extern ")
 106     } else {
 107         Cow::from(format!("extern {} ", abi))
 108     }
 109 }
 110
 111 #[inline]
 112 // Transform `Vec<syntax::ptr::P<T>>` into `Vec<&T>`
 113 pub fn ptr_vec_to_ref_vec<T>(vec: &[ptr::P<T>]) -> Vec<&T> {
 114     vec.iter().map(|x| &**x).collect::<Vec<_>>()
 115 }
 116
 117 #[inline]
 118 pub fn filter_attributes(attrs: &[ast::Attribute], style: ast::AttrStyle) -> Vec<ast::Attribute> {
 119     attrs
 120         .iter()
 121         .filter(|a| a.style == style)
 122         .cloned()
 123         .collect::<Vec<_>>()
 124 }
 125
 126 #[inline]
 127 pub fn inner_attributes(attrs: &[ast::Attribute]) -> Vec<ast::Attribute> {
 128     filter_attributes(attrs, ast::AttrStyle::Inner)
 129 }
 130
 131 #[inline]
 132 pub fn outer_attributes(attrs: &[ast::Attribute]) -> Vec<ast::Attribute> {
 133     filter_attributes(attrs, ast::AttrStyle::Outer)
 134 }
 135
 136 #[inline]
 137 pub fn last_line_contains_single_line_comment(s: &str) -> bool {
 138     s.lines().last().map_or(false, |l| l.contains("//"))
 139 }
 140
 141 #[inline]
 142 pub fn is_attributes_extendable(attrs_str: &str) -> bool {
 143     !attrs_str.contains('\n') && !last_line_contains_single_line_comment(attrs_str)
 144 }
 145
 146 // The width of the first line in s.
 147 #[inline]
 148 pub fn first_line_width(s: &str) -> usize {
 149     match s.find('\n') {
 150         Some(n) => n,
 151         None => s.len(),
 152     }
 153 }
 154
 155 // The width of the last line in s.
 156 #[inline]
 157 pub fn last_line_width(s: &str) -> usize {
 158     match s.rfind('\n') {
 159         Some(n) => s.len() - n - 1,
 160         None => s.len(),
 161     }
 162 }
 163
 164 // The total used width of the last line.
 165 #[inline]
 166 pub fn last_line_used_width(s: &str, offset: usize) -> usize {
 167     if s.contains('\n') {
 168         last_line_width(s)
 169     } else {
 170         offset + s.len()
 171     }
 172 }
 173
 174 #[inline]
 175 pub fn trimmed_last_line_width(s: &str) -> usize {
 176     match s.rfind('\n') {
 177         Some(n) => s[(n + 1)..].trim().len(),
 178         None => s.trim().len(),
 179     }
 180 }
 181
 182 #[inline]
 183 pub fn last_line_extendable(s: &str) -> bool {
 184     if s.ends_with("\"#") {
 185         return true;
 186     }
 187     for c in s.chars().rev() {
 188         match c {
 189             '(' | ')' | ']' | '}' | '?' | '>' => continue,
 190             '\n' => break,
 191             _ if c.is_whitespace() => continue,
 192             _ => return false,
 193         }
 194     }
 195     true
 196 }
 197
 198 #[inline]
 199 fn is_skip(meta_item: &MetaItem) -> bool {
 200     match meta_item.node {
 201         MetaItemKind::Word => meta_item.ident.name == SKIP_ANNOTATION,
 202         MetaItemKind::List(ref l) => {
 203             meta_item.ident.name == "cfg_attr" && l.len() == 2 && is_skip_nested(&l[1])
 204         }
 205         _ => false,
 206     }
 207 }
 208
 209 #[inline]
 210 fn is_skip_nested(meta_item: &NestedMetaItem) -> bool {
 211     match meta_item.node {
 212         NestedMetaItemKind::MetaItem(ref mi) => is_skip(mi),
 213         NestedMetaItemKind::Literal(_) => false,
 214     }
 215 }
 216
 217 #[inline]
 218 pub fn contains_skip(attrs: &[Attribute]) -> bool {
 219     attrs
 220         .iter()
 221         .any(|a| a.meta().map_or(false, |a| is_skip(&a)))
 222 }
 223
 224 #[inline]
 225 pub fn semicolon_for_expr(context: &RewriteContext, expr: &ast::Expr) -> bool {
 226     match expr.node {
 227         ast::ExprKind::Ret(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Break(..) => {
 228             context.config.trailing_semicolon()
 229         }
 230         _ => false,
 231     }
 232 }
 233
 234 #[inline]
 235 pub fn semicolon_for_stmt(context: &RewriteContext, stmt: &ast::Stmt) -> bool {
 236     match stmt.node {
 237         ast::StmtKind::Semi(ref expr) => match expr.node {
 238             ast::ExprKind::While(..)
 239             | ast::ExprKind::WhileLet(..)
 240             | ast::ExprKind::Loop(..)
 241             | ast::ExprKind::ForLoop(..) => false,
 242             ast::ExprKind::Break(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Ret(..) => {
 243                 context.config.trailing_semicolon()
 244             }
 245             _ => true,
 246         },
 247         ast::StmtKind::Expr(..) => false,
 248         _ => true,
 249     }
 250 }
 251
 252 #[inline]
 253 pub fn stmt_expr(stmt: &ast::Stmt) -> Option<&ast::Expr> {
 254     match stmt.node {
 255         ast::StmtKind::Expr(ref expr) => Some(expr),
 256         _ => None,
 257     }
 258 }
 259
 260 #[inline]
 261 pub fn count_newlines(input: &str) -> usize {
 262     // Using `as_bytes` to omit UTF-8 decoding
 263     input.as_bytes().iter().filter(|&&c| c == b'\n').count()
 264 }
 265
 266 // For format_missing and last_pos, need to use the source callsite (if applicable).
 267 // Required as generated code spans aren't guaranteed to follow on from the last span.
 268 macro_rules! source {
 269     ($this:ident, $sp:expr) => {
 270         $sp.source_callsite()
 271     };
 272 }
 273
 274 pub fn mk_sp(lo: BytePos, hi: BytePos) -> Span {
 275     Span::new(lo, hi, NO_EXPANSION)
 276 }
 277
 278 // Return true if the given span does not intersect with file lines.
 279 macro_rules! out_of_file_lines_range {
 280     ($self:ident, $span:expr) => {
 281         !$self.config.file_lines().is_all()
 282             && !$self
 283                 .config
 284                 .file_lines()
 285                 .intersects(&$self.codemap.lookup_line_range($span))
 286     };
 287 }
 288
 289 macro_rules! skip_out_of_file_lines_range {
 290     ($self:ident, $span:expr) => {
 291         if out_of_file_lines_range!($self, $span) {
 292             return None;
 293         }
 294     };
 295 }
 296
 297 macro_rules! skip_out_of_file_lines_range_visitor {
 298     ($self:ident, $span:expr) => {
 299         if out_of_file_lines_range!($self, $span) {
 300             $self.push_rewrite($span, None);
 301             return;
 302         }
 303     };
 304 }
 305
 306 // Wraps String in an Option. Returns Some when the string adheres to the
 307 // Rewrite constraints defined for the Rewrite trait and else otherwise.
 308 pub fn wrap_str(s: String, max_width: usize, shape: Shape) -> Option<String> {
 309     if is_valid_str(&s, max_width, shape) {
 310         Some(s)
 311     } else {
 312         None
 313     }
 314 }
 315
 316 fn is_valid_str(snippet: &str, max_width: usize, shape: Shape) -> bool {
 317     if !snippet.is_empty() {
 318         // First line must fits with `shape.width`.
 319         if first_line_width(snippet) > shape.width {
 320             return false;
 321         }
 322         // If the snippet does not include newline, we are done.
 323         if first_line_width(snippet) == snippet.len() {
 324             return true;
 325         }
 326         // The other lines must fit within the maximum width.
 327         if snippet.lines().skip(1).any(|line| line.len() > max_width) {
 328             return false;
 329         }
 330         // A special check for the last line, since the caller may
 331         // place trailing characters on this line.
 332         if last_line_width(snippet) > shape.used_width() + shape.width {
 333             return false;
 334         }
 335     }
 336     true
 337 }
 338
 339 #[inline]
 340 pub fn colon_spaces(before: bool, after: bool) -> &'static str {
 341     match (before, after) {
 342         (true, true) => " : ",
 343         (true, false) => " :",
 344         (false, true) => ": ",
 345         (false, false) => ":",
 346     }
 347 }
 348
 349 #[inline]
 350 pub fn paren_overhead(context: &RewriteContext) -> usize {
 351     if context.config.spaces_within_parens_and_brackets() {
 352         4
 353     } else {
 354         2
 355     }
 356 }
 357
 358 pub fn left_most_sub_expr(e: &ast::Expr) -> &ast::Expr {
 359     match e.node {
 360         ast::ExprKind::Call(ref e, _)
 361         | ast::ExprKind::Binary(_, ref e, _)
 362         | ast::ExprKind::Cast(ref e, _)
 363         | ast::ExprKind::Type(ref e, _)
 364         | ast::ExprKind::Assign(ref e, _)
 365         | ast::ExprKind::AssignOp(_, ref e, _)
 366         | ast::ExprKind::Field(ref e, _)
 367         | ast::ExprKind::Index(ref e, _)
 368         | ast::ExprKind::Range(Some(ref e), _, _)
 369         | ast::ExprKind::Try(ref e) => left_most_sub_expr(e),
 370         _ => e,
 371     }
 372 }
 373
 374 // isatty shamelessly adapted from cargo.
 375 #[cfg(unix)]
 376 pub fn isatty() -> bool {
 377     extern crate libc;
 378
 379     unsafe { libc::isatty(libc::STDOUT_FILENO) != 0 }
 380 }
 381 #[cfg(windows)]
 382 pub fn isatty() -> bool {
 383     extern crate winapi;
 384
 385     unsafe {
 386         let handle = winapi::um::processenv::GetStdHandle(winapi::um::winbase::STD_OUTPUT_HANDLE);
 387         let mut out = 0;
 388         winapi::um::consoleapi::GetConsoleMode(handle, &mut out) != 0
 389     }
 390 }
 391
 392 pub fn use_colored_tty(color: Color) -> bool {
 393     match color {
 394         Color::Always => true,
 395         Color::Never => false,
 396         Color::Auto => isatty(),
 397     }
 398 }
 399
 400 pub fn starts_with_newline(s: &str) -> bool {
 401     s.starts_with('\n') || s.starts_with("\r\n")
 402 }