use std::borrow::Cow; use bytecount; use rustc_target::spec::abi; use syntax::ast::{ self, Attribute, CrateSugar, MetaItem, MetaItemKind, NestedMetaItem, NestedMetaItemKind, NodeId, Path, Visibility, VisibilityKind, }; use syntax::ptr; use syntax::source_map::{BytePos, Span, NO_EXPANSION}; use syntax_pos::Mark; use unicode_width::UnicodeWidthStr; use crate::comment::{filter_normal_code, CharClasses, FullCodeCharKind, LineClasses}; use crate::config::{Config, Version}; use crate::rewrite::RewriteContext; use crate::shape::{Indent, Shape}; pub const DEPR_SKIP_ANNOTATION: &str = "rustfmt_skip"; pub const SKIP_ANNOTATION: &str = "rustfmt::skip"; pub fn rewrite_ident<'a>(context: &'a RewriteContext<'_>, ident: ast::Ident) -> &'a str { context.snippet(ident.span) } // Computes the length of a string's last line, minus offset. pub fn extra_offset(text: &str, shape: Shape) -> usize { match text.rfind('\n') { // 1 for newline character Some(idx) => text.len().saturating_sub(idx + 1 + shape.used_width()), None => text.len(), } } pub fn is_same_visibility(a: &Visibility, b: &Visibility) -> bool { match (&a.node, &b.node) { ( VisibilityKind::Restricted { path: p, .. }, VisibilityKind::Restricted { path: q, .. }, ) => p.to_string() == q.to_string(), (VisibilityKind::Public, VisibilityKind::Public) | (VisibilityKind::Inherited, VisibilityKind::Inherited) | ( VisibilityKind::Crate(CrateSugar::PubCrate), VisibilityKind::Crate(CrateSugar::PubCrate), ) | ( VisibilityKind::Crate(CrateSugar::JustCrate), VisibilityKind::Crate(CrateSugar::JustCrate), ) => true, _ => false, } } // Uses Cow to avoid allocating in the common cases. pub fn format_visibility(context: &RewriteContext<'_>, vis: &Visibility) -> Cow<'static, str> { match vis.node { VisibilityKind::Public => Cow::from("pub "), VisibilityKind::Inherited => Cow::from(""), VisibilityKind::Crate(CrateSugar::PubCrate) => Cow::from("pub(crate) "), VisibilityKind::Crate(CrateSugar::JustCrate) => Cow::from("crate "), VisibilityKind::Restricted { ref path, .. } => { let Path { ref segments, .. } = **path; let mut segments_iter = segments.iter().map(|seg| rewrite_ident(context, seg.ident)); if path.is_global() { segments_iter .next() .expect("Non-global path in pub(restricted)?"); } let is_keyword = |s: &str| s == "self" || s == "super"; let path = segments_iter.collect::>().join("::"); let in_str = if is_keyword(&path) { "" } else { "in " }; Cow::from(format!("pub({}{}) ", in_str, path)) } } } #[inline] pub fn format_async(is_async: ast::IsAsync) -> &'static str { match is_async { ast::IsAsync::Async { .. } => "async ", ast::IsAsync::NotAsync => "", } } #[inline] pub fn format_constness(constness: ast::Constness) -> &'static str { match constness { ast::Constness::Const => "const ", ast::Constness::NotConst => "", } } #[inline] pub fn format_defaultness(defaultness: ast::Defaultness) -> &'static str { match defaultness { ast::Defaultness::Default => "default ", ast::Defaultness::Final => "", } } #[inline] pub fn format_unsafety(unsafety: ast::Unsafety) -> &'static str { match unsafety { ast::Unsafety::Unsafe => "unsafe ", ast::Unsafety::Normal => "", } } #[inline] pub fn format_auto(is_auto: ast::IsAuto) -> &'static str { match is_auto { ast::IsAuto::Yes => "auto ", ast::IsAuto::No => "", } } #[inline] pub fn format_mutability(mutability: ast::Mutability) -> &'static str { match mutability { ast::Mutability::Mutable => "mut ", ast::Mutability::Immutable => "", } } #[inline] pub fn format_abi(abi: abi::Abi, explicit_abi: bool, is_mod: bool) -> Cow<'static, str> { if abi == abi::Abi::Rust && !is_mod { Cow::from("") } else if abi == abi::Abi::C && !explicit_abi { Cow::from("extern ") } else { Cow::from(format!("extern {} ", abi)) } } #[inline] // Transform `Vec>` into `Vec<&T>` pub fn ptr_vec_to_ref_vec(vec: &[ptr::P]) -> Vec<&T> { vec.iter().map(|x| &**x).collect::>() } #[inline] pub fn filter_attributes(attrs: &[ast::Attribute], style: ast::AttrStyle) -> Vec { attrs .iter() .filter(|a| a.style == style) .cloned() .collect::>() } #[inline] pub fn inner_attributes(attrs: &[ast::Attribute]) -> Vec { filter_attributes(attrs, ast::AttrStyle::Inner) } #[inline] pub fn outer_attributes(attrs: &[ast::Attribute]) -> Vec { filter_attributes(attrs, ast::AttrStyle::Outer) } #[inline] pub fn is_single_line(s: &str) -> bool { s.chars().find(|&c| c == '\n').is_none() } #[inline] pub fn first_line_contains_single_line_comment(s: &str) -> bool { s.lines().next().map_or(false, |l| l.contains("//")) } #[inline] pub fn last_line_contains_single_line_comment(s: &str) -> bool { s.lines().last().map_or(false, |l| l.contains("//")) } #[inline] pub fn is_attributes_extendable(attrs_str: &str) -> bool { !attrs_str.contains('\n') && !last_line_contains_single_line_comment(attrs_str) } // The width of the first line in s. #[inline] pub fn first_line_width(s: &str) -> usize { unicode_str_width(s.splitn(2, '\n').next().unwrap_or("")) } // The width of the last line in s. #[inline] pub fn last_line_width(s: &str) -> usize { unicode_str_width(s.rsplitn(2, '\n').next().unwrap_or("")) } // The total used width of the last line. #[inline] pub fn last_line_used_width(s: &str, offset: usize) -> usize { if s.contains('\n') { last_line_width(s) } else { offset + unicode_str_width(s) } } #[inline] pub fn trimmed_last_line_width(s: &str) -> usize { unicode_str_width(match s.rfind('\n') { Some(n) => s[(n + 1)..].trim(), None => s.trim(), }) } #[inline] pub fn last_line_extendable(s: &str) -> bool { if s.ends_with("\"#") { return true; } for c in s.chars().rev() { match c { '(' | ')' | ']' | '}' | '?' | '>' => continue, '\n' => break, _ if c.is_whitespace() => continue, _ => return false, } } true } #[inline] fn is_skip(meta_item: &MetaItem) -> bool { match meta_item.node { MetaItemKind::Word => { let path_str = meta_item.ident.to_string(); path_str == SKIP_ANNOTATION || path_str == DEPR_SKIP_ANNOTATION } MetaItemKind::List(ref l) => { meta_item.name() == "cfg_attr" && l.len() == 2 && is_skip_nested(&l[1]) } _ => false, } } #[inline] fn is_skip_nested(meta_item: &NestedMetaItem) -> bool { match meta_item.node { NestedMetaItemKind::MetaItem(ref mi) => is_skip(mi), NestedMetaItemKind::Literal(_) => false, } } #[inline] pub fn contains_skip(attrs: &[Attribute]) -> bool { attrs .iter() .any(|a| a.meta().map_or(false, |a| is_skip(&a))) } #[inline] pub fn semicolon_for_expr(context: &RewriteContext<'_>, expr: &ast::Expr) -> bool { match expr.node { ast::ExprKind::Ret(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Break(..) => { context.config.trailing_semicolon() } _ => false, } } #[inline] pub fn semicolon_for_stmt(context: &RewriteContext<'_>, stmt: &ast::Stmt) -> bool { match stmt.node { ast::StmtKind::Semi(ref expr) => match expr.node { ast::ExprKind::While(..) | ast::ExprKind::WhileLet(..) | ast::ExprKind::Loop(..) | ast::ExprKind::ForLoop(..) => false, ast::ExprKind::Break(..) | ast::ExprKind::Continue(..) | ast::ExprKind::Ret(..) => { context.config.trailing_semicolon() } _ => true, }, ast::StmtKind::Expr(..) => false, _ => true, } } #[inline] pub fn stmt_expr(stmt: &ast::Stmt) -> Option<&ast::Expr> { match stmt.node { ast::StmtKind::Expr(ref expr) => Some(expr), _ => None, } } #[inline] pub fn count_newlines(input: &str) -> usize { // Using bytes to omit UTF-8 decoding bytecount::count(input.as_bytes(), b'\n') } // For format_missing and last_pos, need to use the source callsite (if applicable). // Required as generated code spans aren't guaranteed to follow on from the last span. macro_rules! source { ($this:ident, $sp:expr) => { $sp.source_callsite() }; } pub fn mk_sp(lo: BytePos, hi: BytePos) -> Span { Span::new(lo, hi, NO_EXPANSION) } // Returns `true` if the given span does not intersect with file lines. macro_rules! out_of_file_lines_range { ($self:ident, $span:expr) => { !$self.config.file_lines().is_all() && !$self .config .file_lines() .intersects(&$self.source_map.lookup_line_range($span)) }; } macro_rules! skip_out_of_file_lines_range { ($self:ident, $span:expr) => { if out_of_file_lines_range!($self, $span) { return None; } }; } macro_rules! skip_out_of_file_lines_range_visitor { ($self:ident, $span:expr) => { if out_of_file_lines_range!($self, $span) { $self.push_rewrite($span, None); return; } }; } // Wraps String in an Option. Returns Some when the string adheres to the // Rewrite constraints defined for the Rewrite trait and None otherwise. pub fn wrap_str(s: String, max_width: usize, shape: Shape) -> Option { if is_valid_str(&filter_normal_code(&s), max_width, shape) { Some(s) } else { None } } fn is_valid_str(snippet: &str, max_width: usize, shape: Shape) -> bool { if !snippet.is_empty() { // First line must fits with `shape.width`. if first_line_width(snippet) > shape.width { return false; } // If the snippet does not include newline, we are done. if is_single_line(snippet) { return true; } // The other lines must fit within the maximum width. if snippet .lines() .skip(1) .any(|line| unicode_str_width(line) > max_width) { return false; } // A special check for the last line, since the caller may // place trailing characters on this line. if last_line_width(snippet) > shape.used_width() + shape.width { return false; } } true } #[inline] pub fn colon_spaces(config: &Config) -> &'static str { let before = config.space_before_colon(); let after = config.space_after_colon(); match (before, after) { (true, true) => " : ", (true, false) => " :", (false, true) => ": ", (false, false) => ":", } } #[inline] pub fn left_most_sub_expr(e: &ast::Expr) -> &ast::Expr { match e.node { ast::ExprKind::Call(ref e, _) | ast::ExprKind::Binary(_, ref e, _) | ast::ExprKind::Cast(ref e, _) | ast::ExprKind::Type(ref e, _) | ast::ExprKind::Assign(ref e, _) | ast::ExprKind::AssignOp(_, ref e, _) | ast::ExprKind::Field(ref e, _) | ast::ExprKind::Index(ref e, _) | ast::ExprKind::Range(Some(ref e), _, _) | ast::ExprKind::Try(ref e) => left_most_sub_expr(e), _ => e, } } #[inline] pub fn starts_with_newline(s: &str) -> bool { s.starts_with('\n') || s.starts_with("\r\n") } #[inline] pub fn first_line_ends_with(s: &str, c: char) -> bool { s.lines().next().map_or(false, |l| l.ends_with(c)) } // States whether an expression's last line exclusively consists of closing // parens, braces, and brackets in its idiomatic formatting. pub fn is_block_expr(context: &RewriteContext<'_>, expr: &ast::Expr, repr: &str) -> bool { match expr.node { ast::ExprKind::Mac(..) | ast::ExprKind::Call(..) | ast::ExprKind::MethodCall(..) | ast::ExprKind::Array(..) | ast::ExprKind::Struct(..) | ast::ExprKind::While(..) | ast::ExprKind::WhileLet(..) | ast::ExprKind::If(..) | ast::ExprKind::IfLet(..) | ast::ExprKind::Block(..) | ast::ExprKind::Loop(..) | ast::ExprKind::ForLoop(..) | ast::ExprKind::Match(..) => repr.contains('\n'), ast::ExprKind::Paren(ref expr) | ast::ExprKind::Binary(_, _, ref expr) | ast::ExprKind::Index(_, ref expr) | ast::ExprKind::Unary(_, ref expr) | ast::ExprKind::Closure(_, _, _, _, ref expr, _) | ast::ExprKind::Try(ref expr) | ast::ExprKind::Yield(Some(ref expr)) => is_block_expr(context, expr, repr), // This can only be a string lit ast::ExprKind::Lit(_) => { repr.contains('\n') && trimmed_last_line_width(repr) <= context.config.tab_spaces() } _ => false, } } /// Removes trailing spaces from the specified snippet. We do not remove spaces /// inside strings or comments. pub fn remove_trailing_white_spaces(text: &str) -> String { let mut buffer = String::with_capacity(text.len()); let mut space_buffer = String::with_capacity(128); for (char_kind, c) in CharClasses::new(text.chars()) { match c { '\n' => { if char_kind == FullCodeCharKind::InString { buffer.push_str(&space_buffer); } space_buffer.clear(); buffer.push('\n'); } _ if c.is_whitespace() => { space_buffer.push(c); } _ => { if !space_buffer.is_empty() { buffer.push_str(&space_buffer); space_buffer.clear(); } buffer.push(c); } } } buffer } /// Indent each line according to the specified `indent`. /// e.g. /// /// ```rust,ignore /// foo!{ /// x, /// y, /// foo( /// a, /// b, /// c, /// ), /// } /// ``` /// /// will become /// /// ```rust,ignore /// foo!{ /// x, /// y, /// foo( /// a, /// b, /// c, /// ), /// } /// ``` pub fn trim_left_preserve_layout(orig: &str, indent: Indent, config: &Config) -> Option { let mut lines = LineClasses::new(orig); let first_line = lines.next().map(|(_, s)| s.trim_end().to_owned())?; let mut trimmed_lines = Vec::with_capacity(16); let mut veto_trim = false; let min_prefix_space_width = lines .filter_map(|(kind, line)| { let mut trimmed = true; let prefix_space_width = if is_empty_line(&line) { None } else { Some(get_prefix_space_width(config, &line)) }; // just InString{Commented} in order to allow the start of a string to be indented let new_veto_trim_value = (kind == FullCodeCharKind::InString || (config.version() == Version::Two && kind == FullCodeCharKind::InStringCommented)) && !line.ends_with('\\'); let line = if veto_trim || new_veto_trim_value { veto_trim = new_veto_trim_value; trimmed = false; line } else { line.trim().to_owned() }; trimmed_lines.push((trimmed, line, prefix_space_width)); // Because there is a veto against trimming and indenting lines within a string, // such lines should not be taken into account when computing the minimum. match kind { FullCodeCharKind::InStringCommented | FullCodeCharKind::EndStringCommented if config.version() == Version::Two => { None } FullCodeCharKind::InString | FullCodeCharKind::EndString => None, _ => prefix_space_width, } }) .min()?; Some( first_line + "\n" + &trimmed_lines .iter() .map( |&(trimmed, ref line, prefix_space_width)| match prefix_space_width { _ if !trimmed => line.to_owned(), Some(original_indent_width) => { let new_indent_width = indent.width() + original_indent_width.saturating_sub(min_prefix_space_width); let new_indent = Indent::from_width(config, new_indent_width); format!("{}{}", new_indent.to_string(config), line) } None => String::new(), }, ) .collect::>() .join("\n"), ) } /// Based on the given line, determine if the next line can be indented or not. /// This allows to preserve the indentation of multi-line literals. pub fn indent_next_line(kind: FullCodeCharKind, line: &str, config: &Config) -> bool { !(kind.is_string() || (config.version() == Version::Two && kind.is_commented_string())) || line.ends_with('\\') } pub fn is_empty_line(s: &str) -> bool { s.is_empty() || s.chars().all(char::is_whitespace) } fn get_prefix_space_width(config: &Config, s: &str) -> usize { let mut width = 0; for c in s.chars() { match c { ' ' => width += 1, '\t' => width += config.tab_spaces(), _ => return width, } } width } pub(crate) trait NodeIdExt { fn root() -> Self; } impl NodeIdExt for NodeId { fn root() -> NodeId { NodeId::placeholder_from_mark(Mark::root()) } } pub(crate) fn unicode_str_width(s: &str) -> usize { s.width() } pub fn get_skip_macro_names(attrs: &[ast::Attribute]) -> Vec { let mut skip_macro_names = vec![]; for attr in attrs { // syntax::ast::Path is implemented partialEq // but it is designed for segments.len() == 1 if format!("{}", attr.path) != "rustfmt::skip::macros" { continue; } if let Some(list) = attr.meta_item_list() { for spanned in list { if let Some(name) = spanned.name() { skip_macro_names.push(name.to_string()); } } } } skip_macro_names } #[cfg(test)] mod test { use super::*; #[test] fn test_remove_trailing_white_spaces() { let s = " r#\"\n test\n \"#"; assert_eq!(remove_trailing_white_spaces(&s), s); } #[test] fn test_trim_left_preserve_layout() { let s = "aaa\n\tbbb\n ccc"; let config = Config::default(); let indent = Indent::new(4, 0); assert_eq!( trim_left_preserve_layout(&s, indent, &config), Some("aaa\n bbb\n ccc".to_string()) ); } }