src/patterns.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 config::lists::*;
  12 use syntax::ast::{self, BindingMode, FieldPat, Pat, PatKind, RangeEnd, RangeSyntax};
  13 use syntax::codemap::{self, BytePos, Span};
  14 use syntax::ptr;
  15
  16 use codemap::SpanUtils;
  17 use comment::FindUncommented;
  18 use expr::{
  19     can_be_overflowed_expr, rewrite_pair, rewrite_unary_prefix, wrap_struct_field, PairParts,
  20 };
  21 use lists::{
  22     itemize_list, shape_for_tactic, struct_lit_formatting, struct_lit_shape, struct_lit_tactic,
  23     write_list,
  24 };
  25 use macros::{rewrite_macro, MacroPosition};
  26 use overflow;
  27 use rewrite::{Rewrite, RewriteContext};
  28 use shape::Shape;
  29 use spanned::Spanned;
  30 use types::{rewrite_path, PathContext};
  31 use utils::{format_mutability, mk_sp};
  32
  33 /// Returns true if the given pattern is short. A short pattern is defined by the following grammer:
  34 ///
  35 /// [small, ntp]:
  36 ///     - single token
  37 ///     - `&[single-line, ntp]`
  38 ///
  39 /// [small]:
  40 ///     - `[small, ntp]`
  41 ///     - unary tuple constructor `([small, ntp])`
  42 ///     - `&[small]`
  43 pub fn is_short_pattern(pat: &ast::Pat, pat_str: &str) -> bool {
  44     // We also require that the pattern is reasonably 'small' with its literal width.
  45     pat_str.len() <= 20 && !pat_str.contains('\n') && is_short_pattern_inner(pat)
  46 }
  47
  48 fn is_short_pattern_inner(pat: &ast::Pat) -> bool {
  49     match pat.node {
  50         ast::PatKind::Wild | ast::PatKind::Lit(_) => true,
  51         ast::PatKind::Ident(_, _, ref pat) => pat.is_none(),
  52         ast::PatKind::Struct(..)
  53         | ast::PatKind::Mac(..)
  54         | ast::PatKind::Slice(..)
  55         | ast::PatKind::Path(..)
  56         | ast::PatKind::Range(..) => false,
  57         ast::PatKind::Tuple(ref subpats, _) => subpats.len() <= 1,
  58         ast::PatKind::TupleStruct(ref path, ref subpats, _) => {
  59             path.segments.len() <= 1 && subpats.len() <= 1
  60         }
  61         ast::PatKind::Box(ref p) | ast::PatKind::Ref(ref p, _) | ast::PatKind::Paren(ref p) => {
  62             is_short_pattern_inner(&*p)
  63         }
  64     }
  65 }
  66
  67 impl Rewrite for Pat {
  68     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  69         match self.node {
  70             PatKind::Box(ref pat) => rewrite_unary_prefix(context, "box ", &**pat, shape),
  71             PatKind::Ident(binding_mode, ident, ref sub_pat) => {
  72                 let (prefix, mutability) = match binding_mode {
  73                     BindingMode::ByRef(mutability) => ("ref ", mutability),
  74                     BindingMode::ByValue(mutability) => ("", mutability),
  75                 };
  76                 let mut_infix = format_mutability(mutability);
  77                 let id_str = ident.name.to_string();
  78                 let sub_pat = match *sub_pat {
  79                     Some(ref p) => {
  80                         // 3 - ` @ `.
  81                         let width = shape
  82                             .width
  83                             .checked_sub(prefix.len() + mut_infix.len() + id_str.len() + 3)?;
  84                         format!(
  85                             " @ {}",
  86                             p.rewrite(context, Shape::legacy(width, shape.indent))?
  87                         )
  88                     }
  89                     None => "".to_owned(),
  90                 };
  91
  92                 Some(format!("{}{}{}{}", prefix, mut_infix, id_str, sub_pat))
  93             }
  94             PatKind::Wild => {
  95                 if 1 <= shape.width {
  96                     Some("_".to_owned())
  97                 } else {
  98                     None
  99                 }
 100             }
 101             PatKind::Range(ref lhs, ref rhs, ref end_kind) => {
 102                 let infix = match *end_kind {
 103                     RangeEnd::Included(RangeSyntax::DotDotDot) => "...",
 104                     RangeEnd::Included(RangeSyntax::DotDotEq) => "..=",
 105                     RangeEnd::Excluded => "..",
 106                 };
 107                 let infix = if context.config.spaces_around_ranges() {
 108                     format!(" {} ", infix)
 109                 } else {
 110                     infix.to_owned()
 111                 };
 112                 rewrite_pair(
 113                     &**lhs,
 114                     &**rhs,
 115                     PairParts::new("", &infix, ""),
 116                     context,
 117                     shape,
 118                     SeparatorPlace::Front,
 119                 )
 120             }
 121             PatKind::Ref(ref pat, mutability) => {
 122                 let prefix = format!("&{}", format_mutability(mutability));
 123                 rewrite_unary_prefix(context, &prefix, &**pat, shape)
 124             }
 125             PatKind::Tuple(ref items, dotdot_pos) => {
 126                 rewrite_tuple_pat(items, dotdot_pos, None, self.span, context, shape)
 127             }
 128             PatKind::Path(ref q_self, ref path) => {
 129                 rewrite_path(context, PathContext::Expr, q_self.as_ref(), path, shape)
 130             }
 131             PatKind::TupleStruct(ref path, ref pat_vec, dotdot_pos) => {
 132                 let path_str = rewrite_path(context, PathContext::Expr, None, path, shape)?;
 133                 rewrite_tuple_pat(
 134                     pat_vec,
 135                     dotdot_pos,
 136                     Some(path_str),
 137                     self.span,
 138                     context,
 139                     shape,
 140                 )
 141             }
 142             PatKind::Lit(ref expr) => expr.rewrite(context, shape),
 143             PatKind::Slice(ref prefix, ref slice_pat, ref suffix) => {
 144                 // Rewrite all the sub-patterns.
 145                 let prefix = prefix.iter().map(|p| p.rewrite(context, shape));
 146                 let slice_pat = slice_pat
 147                     .as_ref()
 148                     .map(|p| Some(format!("{}..", p.rewrite(context, shape)?)));
 149                 let suffix = suffix.iter().map(|p| p.rewrite(context, shape));
 150
 151                 // Munge them together.
 152                 let pats: Option<Vec<String>> =
 153                     prefix.chain(slice_pat.into_iter()).chain(suffix).collect();
 154
 155                 // Check that all the rewrites succeeded, and if not return None.
 156                 let pats = pats?;
 157
 158                 // Unwrap all the sub-strings and join them with commas.
 159                 let result = if context.config.spaces_within_parens_and_brackets() {
 160                     format!("[ {} ]", pats.join(", "))
 161                 } else {
 162                     format!("[{}]", pats.join(", "))
 163                 };
 164                 Some(result)
 165             }
 166             PatKind::Struct(ref path, ref fields, ellipsis) => {
 167                 rewrite_struct_pat(path, fields, ellipsis, self.span, context, shape)
 168             }
 169             PatKind::Mac(ref mac) => rewrite_macro(mac, None, context, shape, MacroPosition::Pat),
 170             PatKind::Paren(ref pat) => pat.rewrite(context, shape.offset_left(1)?.sub_width(1)?)
 171                 .map(|inner_pat| format!("({})", inner_pat)),
 172         }
 173     }
 174 }
 175
 176 fn rewrite_struct_pat(
 177     path: &ast::Path,
 178     fields: &[codemap::Spanned<ast::FieldPat>],
 179     ellipsis: bool,
 180     span: Span,
 181     context: &RewriteContext,
 182     shape: Shape,
 183 ) -> Option<String> {
 184     // 2 =  ` {`
 185     let path_shape = shape.sub_width(2)?;
 186     let path_str = rewrite_path(context, PathContext::Expr, None, path, path_shape)?;
 187
 188     if fields.is_empty() && !ellipsis {
 189         return Some(format!("{} {{}}", path_str));
 190     }
 191
 192     let (ellipsis_str, terminator) = if ellipsis { (", ..", "..") } else { ("", "}") };
 193
 194     // 3 = ` { `, 2 = ` }`.
 195     let (h_shape, v_shape) =
 196         struct_lit_shape(shape, context, path_str.len() + 3, ellipsis_str.len() + 2)?;
 197
 198     let items = itemize_list(
 199         context.snippet_provider,
 200         fields.iter(),
 201         terminator,
 202         ",",
 203         |f| f.span.lo(),
 204         |f| f.span.hi(),
 205         |f| f.node.rewrite(context, v_shape),
 206         context.snippet_provider.span_after(span, "{"),
 207         span.hi(),
 208         false,
 209     );
 210     let item_vec = items.collect::<Vec<_>>();
 211
 212     let tactic = struct_lit_tactic(h_shape, context, &item_vec);
 213     let nested_shape = shape_for_tactic(tactic, h_shape, v_shape);
 214     let fmt = struct_lit_formatting(nested_shape, tactic, context, false);
 215
 216     let mut fields_str = write_list(&item_vec, &fmt)?;
 217     let one_line_width = h_shape.map_or(0, |shape| shape.width);
 218
 219     if ellipsis {
 220         if fields_str.contains('\n') || fields_str.len() > one_line_width {
 221             // Add a missing trailing comma.
 222             if fmt.trailing_separator == SeparatorTactic::Never {
 223                 fields_str.push_str(",");
 224             }
 225             fields_str.push_str("\n");
 226             fields_str.push_str(&nested_shape.indent.to_string(context.config));
 227             fields_str.push_str("..");
 228         } else {
 229             if !fields_str.is_empty() {
 230                 // there are preceding struct fields being matched on
 231                 if fmt.tactic == DefinitiveListTactic::Vertical {
 232                     // if the tactic is Vertical, write_list already added a trailing ,
 233                     fields_str.push_str(" ");
 234                 } else {
 235                     fields_str.push_str(", ");
 236                 }
 237             }
 238             fields_str.push_str("..");
 239         }
 240     }
 241
 242     let fields_str = wrap_struct_field(context, &fields_str, shape, v_shape, one_line_width);
 243     Some(format!("{} {{{}}}", path_str, fields_str))
 244 }
 245
 246 impl Rewrite for FieldPat {
 247     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
 248         let pat = self.pat.rewrite(context, shape);
 249         if self.is_shorthand {
 250             pat
 251         } else {
 252             let pat_str = pat?;
 253             let id_str = self.ident.to_string();
 254             let one_line_width = id_str.len() + 2 + pat_str.len();
 255             if one_line_width <= shape.width {
 256                 Some(format!("{}: {}", id_str, pat_str))
 257             } else {
 258                 let nested_shape = shape.block_indent(context.config.tab_spaces());
 259                 let pat_str = self.pat.rewrite(context, nested_shape)?;
 260                 Some(format!(
 261                     "{}:\n{}{}",
 262                     id_str,
 263                     nested_shape.indent.to_string(context.config),
 264                     pat_str,
 265                 ))
 266             }
 267         }
 268     }
 269 }
 270
 271 pub enum TuplePatField<'a> {
 272     Pat(&'a ptr::P<ast::Pat>),
 273     Dotdot(Span),
 274 }
 275
 276 impl<'a> Rewrite for TuplePatField<'a> {
 277     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
 278         match *self {
 279             TuplePatField::Pat(p) => p.rewrite(context, shape),
 280             TuplePatField::Dotdot(_) => Some("..".to_string()),
 281         }
 282     }
 283 }
 284
 285 impl<'a> Spanned for TuplePatField<'a> {
 286     fn span(&self) -> Span {
 287         match *self {
 288             TuplePatField::Pat(p) => p.span(),
 289             TuplePatField::Dotdot(span) => span,
 290         }
 291     }
 292 }
 293
 294 pub fn can_be_overflowed_pat(context: &RewriteContext, pat: &TuplePatField, len: usize) -> bool {
 295     match *pat {
 296         TuplePatField::Pat(pat) => match pat.node {
 297             ast::PatKind::Path(..)
 298             | ast::PatKind::Tuple(..)
 299             | ast::PatKind::Struct(..)
 300             | ast::PatKind::TupleStruct(..) => context.use_block_indent() && len == 1,
 301             ast::PatKind::Ref(ref p, _) | ast::PatKind::Box(ref p) => {
 302                 can_be_overflowed_pat(context, &TuplePatField::Pat(p), len)
 303             }
 304             ast::PatKind::Lit(ref expr) => can_be_overflowed_expr(context, expr, len),
 305             _ => false,
 306         },
 307         TuplePatField::Dotdot(..) => false,
 308     }
 309 }
 310
 311 fn rewrite_tuple_pat(
 312     pats: &[ptr::P<ast::Pat>],
 313     dotdot_pos: Option<usize>,
 314     path_str: Option<String>,
 315     span: Span,
 316     context: &RewriteContext,
 317     shape: Shape,
 318 ) -> Option<String> {
 319     let mut pat_vec: Vec<_> = pats.into_iter().map(|x| TuplePatField::Pat(x)).collect();
 320
 321     if let Some(pos) = dotdot_pos {
 322         let prev = if pos == 0 {
 323             span.lo()
 324         } else {
 325             pats[pos - 1].span().hi()
 326         };
 327         let next = if pos + 1 >= pats.len() {
 328             span.hi()
 329         } else {
 330             pats[pos + 1].span().lo()
 331         };
 332         let dot_span = mk_sp(prev, next);
 333         let snippet = context.snippet(dot_span);
 334         let lo = dot_span.lo() + BytePos(snippet.find_uncommented("..").unwrap() as u32);
 335         let dotdot = TuplePatField::Dotdot(Span::new(
 336             lo,
 337             // 2 == "..".len()
 338             lo + BytePos(2),
 339             codemap::NO_EXPANSION,
 340         ));
 341         pat_vec.insert(pos, dotdot);
 342     }
 343
 344     if pat_vec.is_empty() {
 345         return Some(format!("{}()", path_str.unwrap_or_default()));
 346     }
 347
 348     let wildcard_suffix_len = count_wildcard_suffix_len(context, &pat_vec, span, shape);
 349     let (pat_vec, span) = if context.config.condense_wildcard_suffixes() && wildcard_suffix_len >= 2
 350     {
 351         let new_item_count = 1 + pat_vec.len() - wildcard_suffix_len;
 352         let sp = pat_vec[new_item_count - 1].span();
 353         let snippet = context.snippet(sp);
 354         let lo = sp.lo() + BytePos(snippet.find_uncommented("_").unwrap() as u32);
 355         pat_vec[new_item_count - 1] = TuplePatField::Dotdot(mk_sp(lo, lo + BytePos(1)));
 356         (
 357             &pat_vec[..new_item_count],
 358             mk_sp(span.lo(), lo + BytePos(1)),
 359         )
 360     } else {
 361         (&pat_vec[..], span)
 362     };
 363
 364     // add comma if `(x,)`
 365     let add_comma = path_str.is_none() && pat_vec.len() == 1 && dotdot_pos.is_none();
 366     let path_str = path_str.unwrap_or_default();
 367     let pat_ref_vec = pat_vec.iter().collect::<Vec<_>>();
 368
 369     overflow::rewrite_with_parens(
 370         &context,
 371         &path_str,
 372         &pat_ref_vec,
 373         shape,
 374         span,
 375         context.config.max_width(),
 376         if add_comma {
 377             Some(SeparatorTactic::Always)
 378         } else {
 379             None
 380         },
 381     )
 382 }
 383
 384 fn count_wildcard_suffix_len(
 385     context: &RewriteContext,
 386     patterns: &[TuplePatField],
 387     span: Span,
 388     shape: Shape,
 389 ) -> usize {
 390     let mut suffix_len = 0;
 391
 392     let items: Vec<_> = itemize_list(
 393         context.snippet_provider,
 394         patterns.iter(),
 395         ")",
 396         ",",
 397         |item| item.span().lo(),
 398         |item| item.span().hi(),
 399         |item| item.rewrite(context, shape),
 400         context.snippet_provider.span_after(span, "("),
 401         span.hi() - BytePos(1),
 402         false,
 403     ).collect();
 404
 405     for item in items.iter().rev().take_while(|i| match i.item {
 406         Some(ref internal_string) if internal_string == "_" => true,
 407         _ => false,
 408     }) {
 409         suffix_len += 1;
 410
 411         if item.has_comment() {
 412             break;
 413         }
 414     }
 415
 416     suffix_len
 417 }