1 // Copyright 2018 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.
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.
11 //! Format attributes and meta items.
13 use comment::{contains_comment, rewrite_doc_comment, CommentStyle};
15 use config::IndentStyle;
16 use expr::rewrite_literal;
17 use lists::{definitive_tactic, itemize_list, write_list, ListFormatting, Separator};
19 use rewrite::{Rewrite, RewriteContext};
21 use types::{rewrite_path, PathContext};
22 use utils::{count_newlines, mk_sp};
25 use syntax::source_map::{BytePos, Span, DUMMY_SP};
27 /// Returns attributes on the given statement.
28 pub fn get_attrs_from_stmt(stmt: &ast::Stmt) -> &[ast::Attribute] {
30 ast::StmtKind::Local(ref local) => &local.attrs,
31 ast::StmtKind::Item(ref item) => &item.attrs,
32 ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => &expr.attrs,
33 ast::StmtKind::Mac(ref mac) => &mac.2,
37 /// Returns attributes that are within `outer_span`.
38 pub fn filter_inline_attrs(attrs: &[ast::Attribute], outer_span: Span) -> Vec<ast::Attribute> {
41 .filter(|a| outer_span.lo() <= a.span.lo() && a.span.hi() <= outer_span.hi())
46 fn is_derive(attr: &ast::Attribute) -> bool {
47 attr.check_name("derive")
50 /// Returns the arguments of `#[derive(...)]`.
51 fn get_derive_spans(attr: &ast::Attribute) -> Option<Vec<Span>> {
52 attr.meta_item_list().map(|meta_item_list| {
55 .map(|nested_meta_item| nested_meta_item.span)
60 // The shape of the arguments to a function-like attribute.
66 context: &RewriteContext,
68 match context.config.indent_style() {
69 IndentStyle::Block => {
71 shape.offset_left(left)
75 .block_indent(context.config.tab_spaces())
76 .with_max_width(context.config),
80 IndentStyle::Visual => shape
83 .and_then(|s| s.sub_width(right)),
91 context: &RewriteContext,
93 let mut result = String::with_capacity(128);
94 result.push_str(prefix);
95 result.push_str("[derive(");
97 let argument_shape = argument_shape(10 + prefix.len(), 2, false, shape, context)?;
98 let item_str = format_arg_list(
102 |sp| Some(context.snippet(**sp).to_owned()),
106 // 10 = "[derive()]", 3 = "()" and "]"
107 shape.offset_left(10 + prefix.len())?.sub_width(3)?,
112 result.push_str(&item_str);
113 if item_str.starts_with('\n') {
115 result.push_str(&shape.indent.to_string_with_newline(context.config));
117 result.push_str(")]");
121 /// Returns the first group of attributes that fills the given predicate.
122 /// We consider two doc comments are in different group if they are separated by normal comments.
123 fn take_while_with_pred<'a, P>(
124 context: &RewriteContext,
125 attrs: &'a [ast::Attribute],
127 ) -> &'a [ast::Attribute]
129 P: Fn(&ast::Attribute) -> bool,
132 let mut iter = attrs.iter().peekable();
134 while let Some(attr) = iter.next() {
140 if let Some(next_attr) = iter.peek() {
141 // Extract comments between two attributes.
142 let span_between_attr = mk_sp(attr.span.hi(), next_attr.span.lo());
143 let snippet = context.snippet(span_between_attr);
144 if count_newlines(snippet) >= 2 || snippet.contains('/') {
153 /// Rewrite the any doc comments which come before any other attributes.
154 fn rewrite_initial_doc_comments(
155 context: &RewriteContext,
156 attrs: &[ast::Attribute],
158 ) -> Option<(usize, Option<String>)> {
159 if attrs.is_empty() {
160 return Some((0, None));
162 // Rewrite doc comments
163 let sugared_docs = take_while_with_pred(context, attrs, |a| a.is_sugared_doc);
164 if !sugared_docs.is_empty() {
165 let snippet = sugared_docs
167 .map(|a| context.snippet(a.span))
172 Some(rewrite_doc_comment(
174 shape.comment(context.config),
183 impl Rewrite for ast::NestedMetaItem {
184 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
186 ast::NestedMetaItemKind::MetaItem(ref meta_item) => meta_item.rewrite(context, shape),
187 ast::NestedMetaItemKind::Literal(ref l) => rewrite_literal(context, l, shape),
192 fn has_newlines_before_after_comment(comment: &str) -> (&str, &str) {
193 // Look at before and after comment and see if there are any empty lines.
194 let comment_begin = comment.find('/');
195 let len = comment_begin.unwrap_or_else(|| comment.len());
196 let mlb = count_newlines(&comment[..len]) > 1;
197 let mla = if comment_begin.is_none() {
203 .take_while(|c| c.is_whitespace())
204 .filter(|&c| c == '\n')
208 (if mlb { "\n" } else { "" }, if mla { "\n" } else { "" })
211 impl Rewrite for ast::MetaItem {
212 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
213 Some(match self.node {
214 ast::MetaItemKind::Word => {
215 rewrite_path(context, PathContext::Type, None, &self.ident, shape)?
217 ast::MetaItemKind::List(ref list) => {
218 let path = rewrite_path(context, PathContext::Type, None, &self.ident, shape)?;
219 let has_trailing_comma = ::expr::span_ends_with_comma(context, self.span);
220 overflow::rewrite_with_parens(
227 context.config.width_heuristics().attr_fn_like_width,
228 Some(if has_trailing_comma {
229 SeparatorTactic::Always
231 SeparatorTactic::Never
235 ast::MetaItemKind::NameValue(ref literal) => {
236 let path = rewrite_path(context, PathContext::Type, None, &self.ident, shape)?;
238 let lit_shape = shape.shrink_left(path.len() + 3)?;
239 // `rewrite_literal` returns `None` when `literal` exceeds max
240 // width. Since a literal is basically unformattable unless it
241 // is a string literal (and only if `format_strings` is set),
242 // we might be better off ignoring the fact that the attribute
243 // is longer than the max width and contiue on formatting.
244 // See #2479 for example.
245 let value = rewrite_literal(context, literal, lit_shape)
246 .unwrap_or_else(|| context.snippet(literal.span).to_owned());
247 format!("{} = {}", path, value)
253 fn format_arg_list<I, T, F1, F2, F3>(
259 context: &RewriteContext,
261 one_line_shape: Shape,
262 one_line_limit: Option<usize>,
266 I: Iterator<Item = T>,
267 F1: Fn(&T) -> BytePos,
268 F2: Fn(&T) -> BytePos,
269 F3: Fn(&T) -> Option<String>,
271 let items = itemize_list(
272 context.snippet_provider,
283 let item_vec = items.collect::<Vec<_>>();
284 let tactic = if let Some(limit) = one_line_limit {
285 ListTactic::LimitedHorizontalVertical(limit)
287 ListTactic::HorizontalVertical
290 let tactic = definitive_tactic(&item_vec, tactic, Separator::Comma, shape.width);
291 let fmt = ListFormatting::new(shape, context.config)
293 .ends_with_newline(false);
294 let item_str = write_list(&item_vec, &fmt)?;
296 let one_line_budget = one_line_shape.width;
297 if context.config.indent_style() == IndentStyle::Visual
299 || (!item_str.contains('\n') && item_str.len() <= one_line_budget)
303 let nested_indent = shape.indent.to_string_with_newline(context.config);
304 Some(format!("{}{}", nested_indent, item_str))
308 impl Rewrite for ast::Attribute {
309 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
310 let snippet = context.snippet(self.span);
311 if self.is_sugared_doc {
312 rewrite_doc_comment(snippet, shape.comment(context.config), context.config)
314 let prefix = attr_prefix(self);
316 if contains_comment(snippet) {
317 return Some(snippet.to_owned());
320 if let Some(ref meta) = self.meta() {
321 // This attribute is possibly a doc attribute needing normalization to a doc comment
322 if context.config.normalize_doc_attributes() && meta.check_name("doc") {
323 if let Some(ref literal) = meta.value_str() {
324 let comment_style = match self.style {
325 ast::AttrStyle::Inner => CommentStyle::Doc,
326 ast::AttrStyle::Outer => CommentStyle::TripleSlash,
329 // Remove possible whitespace from the `CommentStyle::opener()` so that
330 // the literal itself has control over the comment's leading spaces.
331 let opener = comment_style.opener().trim_end();
333 let doc_comment = format!("{}{}", opener, literal);
334 return rewrite_doc_comment(
336 shape.comment(context.config),
343 let shape = shape.offset_left(prefix.len() + 1)?;
345 meta.rewrite(context, shape)
346 .map_or_else(|| snippet.to_owned(), |rw| format!("{}[{}]", prefix, rw)),
349 Some(snippet.to_owned())
355 impl<'a> Rewrite for [ast::Attribute] {
356 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
358 return Some(String::new());
361 // The current remaining attributes.
362 let mut attrs = self;
363 let mut result = String::new();
365 // This is not just a simple map because we need to handle doc comments
366 // (where we take as many doc comment attributes as possible) and possibly
367 // merging derives into a single attribute.
369 if attrs.is_empty() {
373 // Handle doc comments.
374 let (doc_comment_len, doc_comment_str) =
375 rewrite_initial_doc_comments(context, attrs, shape)?;
376 if doc_comment_len > 0 {
377 let doc_comment_str = doc_comment_str.expect("doc comments, but no result");
378 result.push_str(&doc_comment_str);
380 let missing_span = attrs
381 .get(doc_comment_len)
382 .map(|next| mk_sp(attrs[doc_comment_len - 1].span.hi(), next.span.lo()));
383 if let Some(missing_span) = missing_span {
384 let snippet = context.snippet(missing_span);
385 let (mla, mlb) = has_newlines_before_after_comment(snippet);
386 let comment = ::comment::recover_missing_comment_in_span(
388 shape.with_max_width(context.config),
392 let comment = if comment.is_empty() {
395 format!("{}{}\n{}", mla, comment, mlb)
397 result.push_str(&comment);
398 result.push_str(&shape.indent.to_string(context.config));
401 attrs = &attrs[doc_comment_len..];
406 // Handle derives if we will merge them.
407 if context.config.merge_derives() && is_derive(&attrs[0]) {
408 let derives = take_while_with_pred(context, attrs, is_derive);
409 let mut derive_spans = vec![];
410 for derive in derives {
411 derive_spans.append(&mut get_derive_spans(derive)?);
414 format_derive(&derive_spans, attr_prefix(&attrs[0]), shape, context)?;
415 result.push_str(&derive_str);
417 let missing_span = attrs
419 .map(|next| mk_sp(attrs[derives.len() - 1].span.hi(), next.span.lo()));
420 if let Some(missing_span) = missing_span {
421 let comment = ::comment::recover_missing_comment_in_span(
423 shape.with_max_width(context.config),
427 result.push_str(&comment);
428 if let Some(next) = attrs.get(derives.len()) {
429 if next.is_sugared_doc {
430 let snippet = context.snippet(missing_span);
431 let (_, mlb) = has_newlines_before_after_comment(snippet);
432 result.push_str(&mlb);
436 result.push_str(&shape.indent.to_string(context.config));
439 attrs = &attrs[derives.len()..];
444 // If we get here, then we have a regular attribute, just handle one
447 let formatted_attr = attrs[0].rewrite(context, shape)?;
448 result.push_str(&formatted_attr);
450 let missing_span = attrs
452 .map(|next| mk_sp(attrs[0].span.hi(), next.span.lo()));
453 if let Some(missing_span) = missing_span {
454 let comment = ::comment::recover_missing_comment_in_span(
456 shape.with_max_width(context.config),
460 result.push_str(&comment);
461 if let Some(next) = attrs.get(1) {
462 if next.is_sugared_doc {
463 let snippet = context.snippet(missing_span);
464 let (_, mlb) = has_newlines_before_after_comment(snippet);
465 result.push_str(&mlb);
469 result.push_str(&shape.indent.to_string(context.config));
477 fn attr_prefix(attr: &ast::Attribute) -> &'static str {
479 ast::AttrStyle::Inner => "#!",
480 ast::AttrStyle::Outer => "#",