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 rustc_target::spec::abi;
  14 use syntax::ast::{
  15     self, Attribute, CrateSugar, MetaItem, MetaItemKind, NestedMetaItem, NestedMetaItemKind, Path,
  16     Visibility, VisibilityKind,
  17 };
  18 use syntax::codemap::{BytePos, Span, NO_EXPANSION};
  19 use syntax::ptr;
  20
  21 use rewrite::RewriteContext;
  22 use shape::Shape;
  23
  24 pub const DEPR_SKIP_ANNOTATION: &str = "rustfmt_skip";
  25 pub const SKIP_ANNOTATION: &str = "rustfmt::skip";
  26
  27 // Computes the length of a string's last line, minus offset.
  28 pub fn extra_offset(text: &str, shape: Shape) -> usize {
  29     match text.rfind('\n') {
  30         // 1 for newline character
  31         Some(idx) => text.len().saturating_sub(idx + 1 + shape.used_width()),
  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 is_single_line(s: &str) -> bool {
 138     s.chars().find(|&c| c == '\n').is_none()
 139 }
 140
 141 #[inline]
 142 pub fn first_line_contains_single_line_comment(s: &str) -> bool {
 143     s.lines().next().map_or(false, |l| l.contains("//"))
 144 }
 145
 146 #[inline]
 147 pub fn last_line_contains_single_line_comment(s: &str) -> bool {
 148     s.lines().last().map_or(false, |l| l.contains("//"))
 149 }
 150
 151 #[inline]
 152 pub fn is_attributes_extendable(attrs_str: &str) -> bool {
 153     !attrs_str.contains('\n') && !last_line_contains_single_line_comment(attrs_str)
 154 }
 155
 156 // The width of the first line in s.
 157 #[inline]
 158 pub fn first_line_width(s: &str) -> usize {
 159     match s.find('\n') {
 160         Some(n) => n,
 161         None => s.len(),
 162     }
 163 }
 164
 165 // The width of the last line in s.
 166 #[inline]
 167 pub fn last_line_width(s: &str) -> usize {
 168     match s.rfind('\n') {
 169         Some(n) => s.len() - n - 1,
 170         None => s.len(),
 171     }
 172 }
 173
 174 // The total used width of the last line.
 175 #[inline]
 176 pub fn last_line_used_width(s: &str, offset: usize) -> usize {
 177     if s.contains('\n') {
 178         last_line_width(s)
 179     } else {
 180         offset + s.len()
 181     }
 182 }
 183
 184 #[inline]
 185 pub fn trimmed_last_line_width(s: &str) -> usize {
 186     match s.rfind('\n') {
 187         Some(n) => s[(n + 1)..].trim().len(),
 188         None => s.trim().len(),
 189     }
 190 }
 191
 192 #[inline]
 193 pub fn last_line_extendable(s: &str) -> bool {
 194     if s.ends_with("\"#") {
 195         return true;
 196     }
 197     for c in s.chars().rev() {
 198         match c {
 199             '(' | ')' | ']' | '}' | '?' | '>' => continue,
 200             '\n' => break,
 201             _ if c.is_whitespace() => continue,
 202             _ => return false,
 203         }
 204     }
 205     true
 206 }
 207
 208 #[inline]
 209 fn is_skip(meta_item: &MetaItem) -> bool {
 210     match meta_item.node {
 211         MetaItemKind::Word => {
 212             let path_str = meta_item.ident.to_string();
 213             path_str == SKIP_ANNOTATION || path_str == DEPR_SKIP_ANNOTATION
 214         }
 215         MetaItemKind::List(ref l) => {
 216             meta_item.name() == "cfg_attr" && l.len() == 2 && is_skip_nested(&l[1])
 217         }
 218         _ => false,
 219     }
 220 }
 221
 222 #[inline]
 223 fn is_skip_nested(meta_item: &NestedMetaItem) -> bool {
 224     match meta_item.node {
 225         NestedMetaItemKind::MetaItem(ref mi) => is_skip(mi),
 226         NestedMetaItemKind::Literal(_) => false,
 227     }
 228 }
 229
 230 #[inline]
 231 pub fn contains_skip(attrs: &[Attribute]) -> bool {
 232     attrs
 233         .iter()
 234         .any(|a| a.meta().map_or(false, |a| is_skip(&a)))
 235 }
 236
 237 #[inline]
 238 pub fn semicolon_for_expr(context: &RewriteContext, expr: &ast::Expr) -> bool {
 239     match expr.node {
 240         ast::ExprKind::Ret(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Break(..) => {
 241             context.config.trailing_semicolon()
 242         }
 243         _ => false,
 244     }
 245 }
 246
 247 #[inline]
 248 pub fn semicolon_for_stmt(context: &RewriteContext, stmt: &ast::Stmt) -> bool {
 249     match stmt.node {
 250         ast::StmtKind::Semi(ref expr) => match expr.node {
 251             ast::ExprKind::While(..)
 252             | ast::ExprKind::WhileLet(..)
 253             | ast::ExprKind::Loop(..)
 254             | ast::ExprKind::ForLoop(..) => false,
 255             ast::ExprKind::Break(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Ret(..) => {
 256                 context.config.trailing_semicolon()
 257             }
 258             _ => true,
 259         },
 260         ast::StmtKind::Expr(..) => false,
 261         _ => true,
 262     }
 263 }
 264
 265 #[inline]
 266 pub fn stmt_expr(stmt: &ast::Stmt) -> Option<&ast::Expr> {
 267     match stmt.node {
 268         ast::StmtKind::Expr(ref expr) => Some(expr),
 269         _ => None,
 270     }
 271 }
 272
 273 #[inline]
 274 pub fn count_newlines(input: &str) -> usize {
 275     // Using `as_bytes` to omit UTF-8 decoding
 276     input.as_bytes().iter().filter(|&&c| c == b'\n').count()
 277 }
 278
 279 // For format_missing and last_pos, need to use the source callsite (if applicable).
 280 // Required as generated code spans aren't guaranteed to follow on from the last span.
 281 macro_rules! source {
 282     ($this:ident, $sp:expr) => {
 283         $sp.source_callsite()
 284     };
 285 }
 286
 287 pub fn mk_sp(lo: BytePos, hi: BytePos) -> Span {
 288     Span::new(lo, hi, NO_EXPANSION)
 289 }
 290
 291 // Return true if the given span does not intersect with file lines.
 292 macro_rules! out_of_file_lines_range {
 293     ($self:ident, $span:expr) => {
 294         !$self.config.file_lines().is_all()
 295             && !$self
 296                 .config
 297                 .file_lines()
 298                 .intersects(&$self.codemap.lookup_line_range($span))
 299     };
 300 }
 301
 302 macro_rules! skip_out_of_file_lines_range {
 303     ($self:ident, $span:expr) => {
 304         if out_of_file_lines_range!($self, $span) {
 305             return None;
 306         }
 307     };
 308 }
 309
 310 macro_rules! skip_out_of_file_lines_range_visitor {
 311     ($self:ident, $span:expr) => {
 312         if out_of_file_lines_range!($self, $span) {
 313             $self.push_rewrite($span, None);
 314             return;
 315         }
 316     };
 317 }
 318
 319 // Wraps String in an Option. Returns Some when the string adheres to the
 320 // Rewrite constraints defined for the Rewrite trait and else otherwise.
 321 pub fn wrap_str(s: String, max_width: usize, shape: Shape) -> Option<String> {
 322     if is_valid_str(&s, max_width, shape) {
 323         Some(s)
 324     } else {
 325         None
 326     }
 327 }
 328
 329 fn is_valid_str(snippet: &str, max_width: usize, shape: Shape) -> bool {
 330     if !snippet.is_empty() {
 331         // First line must fits with `shape.width`.
 332         if first_line_width(snippet) > shape.width {
 333             return false;
 334         }
 335         // If the snippet does not include newline, we are done.
 336         if first_line_width(snippet) == snippet.len() {
 337             return true;
 338         }
 339         // The other lines must fit within the maximum width.
 340         if snippet.lines().skip(1).any(|line| line.len() > max_width) {
 341             return false;
 342         }
 343         // A special check for the last line, since the caller may
 344         // place trailing characters on this line.
 345         if last_line_width(snippet) > shape.used_width() + shape.width {
 346             return false;
 347         }
 348     }
 349     true
 350 }
 351
 352 #[inline]
 353 pub fn colon_spaces(before: bool, after: bool) -> &'static str {
 354     match (before, after) {
 355         (true, true) => " : ",
 356         (true, false) => " :",
 357         (false, true) => ": ",
 358         (false, false) => ":",
 359     }
 360 }
 361
 362 pub fn left_most_sub_expr(e: &ast::Expr) -> &ast::Expr {
 363     match e.node {
 364         ast::ExprKind::Call(ref e, _)
 365         | ast::ExprKind::Binary(_, ref e, _)
 366         | ast::ExprKind::Cast(ref e, _)
 367         | ast::ExprKind::Type(ref e, _)
 368         | ast::ExprKind::Assign(ref e, _)
 369         | ast::ExprKind::AssignOp(_, ref e, _)
 370         | ast::ExprKind::Field(ref e, _)
 371         | ast::ExprKind::Index(ref e, _)
 372         | ast::ExprKind::Range(Some(ref e), _, _)
 373         | ast::ExprKind::Try(ref e) => left_most_sub_expr(e),
 374         _ => e,
 375     }
 376 }
 377
 378 pub fn starts_with_newline(s: &str) -> bool {
 379     s.starts_with('\n') || s.starts_with("\r\n")
 380 }