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.
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 use std::iter::ExactSizeIterator;
15 use syntax::ast::{self, FunctionRetTy, Mutability};
16 use syntax::source_map::{self, BytePos, Span};
17 use syntax::symbol::keywords;
19 use config::{IndentStyle, TypeDensity};
20 use expr::{rewrite_assign_rhs, rewrite_tuple, rewrite_unary_prefix};
21 use lists::{definitive_tactic, itemize_list, write_list, ListFormatting, Separator};
22 use macros::{rewrite_macro, MacroPosition};
24 use pairs::{rewrite_pair, PairParts};
25 use rewrite::{Rewrite, RewriteContext};
27 use source_map::SpanUtils;
30 colon_spaces, extra_offset, first_line_width, format_abi, format_mutability,
31 last_line_extendable, last_line_width, mk_sp, rewrite_ident,
34 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
35 pub enum PathContext {
41 // Does not wrap on simple segments.
43 context: &RewriteContext,
44 path_context: PathContext,
45 qself: Option<&ast::QSelf>,
49 let skip_count = qself.map_or(0, |x| x.position);
51 let mut result = if path.is_global() && qself.is_none() && path_context != PathContext::Import {
57 let mut span_lo = path.span.lo();
59 if let Some(qself) = qself {
62 let fmt_ty = qself.ty.rewrite(context, shape)?;
63 result.push_str(&fmt_ty);
66 result.push_str(" as ");
67 if path.is_global() && path_context != PathContext::Import {
68 result.push_str("::");
72 let shape = shape.sub_width(3)?;
74 result = rewrite_path_segments(
77 path.segments.iter().take(skip_count),
85 result.push_str(">::");
86 span_lo = qself.ty.span.hi() + BytePos(1);
89 rewrite_path_segments(
92 path.segments.iter().skip(skip_count),
100 fn rewrite_path_segments<'a, I>(
101 path_context: PathContext,
104 mut span_lo: BytePos,
106 context: &RewriteContext,
110 I: Iterator<Item = &'a ast::PathSegment>,
112 let mut first = true;
113 let shape = shape.visual_indent(0);
115 for segment in iter {
116 // Indicates a global path, shouldn't be rendered.
117 if segment.ident.name == keywords::CrateRoot.name() {
123 buffer.push_str("::");
126 let extra_offset = extra_offset(&buffer, shape);
127 let new_shape = shape.shrink_left(extra_offset)?;
128 let segment_string = rewrite_segment(
137 buffer.push_str(&segment_string);
144 pub enum SegmentParam<'a> {
145 LifeTime(&'a ast::Lifetime),
147 Binding(&'a ast::TypeBinding),
150 impl<'a> SegmentParam<'a> {
151 fn from_generic_arg(arg: &ast::GenericArg) -> SegmentParam {
153 ast::GenericArg::Lifetime(ref lt) => SegmentParam::LifeTime(lt),
154 ast::GenericArg::Type(ref ty) => SegmentParam::Type(ty),
159 impl<'a> Spanned for SegmentParam<'a> {
160 fn span(&self) -> Span {
162 SegmentParam::LifeTime(lt) => lt.ident.span,
163 SegmentParam::Type(ty) => ty.span,
164 SegmentParam::Binding(binding) => binding.span,
169 impl<'a> Rewrite for SegmentParam<'a> {
170 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
172 SegmentParam::LifeTime(lt) => lt.rewrite(context, shape),
173 SegmentParam::Type(ty) => ty.rewrite(context, shape),
174 SegmentParam::Binding(binding) => {
175 let mut result = match context.config.type_punctuation_density() {
176 TypeDensity::Wide => format!("{} = ", rewrite_ident(context, binding.ident)),
177 TypeDensity::Compressed => {
178 format!("{}=", rewrite_ident(context, binding.ident))
181 let budget = shape.width.checked_sub(result.len())?;
182 let rewrite = binding
184 .rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
185 result.push_str(&rewrite);
192 // Formats a path segment. There are some hacks involved to correctly determine
193 // the segment's associated span since it's not part of the AST.
195 // The span_lo is assumed to be greater than the end of any previous segment's
196 // parameters and lesser or equal than the start of current segment.
198 // span_hi is assumed equal to the end of the entire path.
200 // When the segment contains a positive number of parameters, we update span_lo
201 // so that invariants described above will hold for the next segment.
203 path_context: PathContext,
204 segment: &ast::PathSegment,
205 span_lo: &mut BytePos,
207 context: &RewriteContext,
209 ) -> Option<String> {
210 let mut result = String::with_capacity(128);
211 result.push_str(rewrite_ident(context, segment.ident));
213 let ident_len = result.len();
214 let shape = if context.use_block_indent() {
215 shape.offset_left(ident_len)?
217 shape.shrink_left(ident_len)?
220 if let Some(ref args) = segment.args {
222 ast::GenericArgs::AngleBracketed(ref data)
223 if !data.args.is_empty() || !data.bindings.is_empty() =>
225 let param_list = data
228 .map(SegmentParam::from_generic_arg)
229 .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x)))
230 .collect::<Vec<_>>();
232 let force_separator =
233 context.inside_macro() && context.snippet(data.span).starts_with("::");
234 let separator = if path_context == PathContext::Expr || force_separator {
239 result.push_str(separator);
241 let generics_str = overflow::rewrite_with_angle_brackets(
246 mk_sp(*span_lo, span_hi),
249 // Update position of last bracket.
252 .span_after(mk_sp(*span_lo, span_hi), "<");
254 result.push_str(&generics_str)
256 ast::GenericArgs::Parenthesized(ref data) => {
257 let output = match data.output {
258 Some(ref ty) => FunctionRetTy::Ty(ty.clone()),
259 None => FunctionRetTy::Default(source_map::DUMMY_SP),
261 result.push_str(&format_function_type(
262 data.inputs.iter().map(|x| &**x),
277 fn format_function_type<'a, I>(
279 output: &FunctionRetTy,
282 context: &RewriteContext,
286 I: ExactSizeIterator,
287 <I as Iterator>::Item: Deref,
288 <I::Item as Deref>::Target: Rewrite + Spanned + 'a,
290 debug!("format_function_type {:#?}", shape);
292 // Code for handling variadics is somewhat duplicated for items, but they
293 // are different enough to need some serious refactoring to share code.
297 <T as Deref>::Target: Rewrite + Spanned,
303 let variadic_arg = if variadic {
304 let variadic_start = context.snippet_provider.span_before(span, "...");
305 Some(ArgumentKind::Variadic(variadic_start))
311 let budget = shape.width.checked_sub(2)?;
313 let offset = match context.config.indent_style() {
314 IndentStyle::Block => {
317 .block_indent(context.config.tab_spaces())
320 IndentStyle::Visual => shape.indent + 1,
322 let list_shape = Shape::legacy(budget, offset);
323 let list_lo = context.snippet_provider.span_after(span, "(");
324 let items = itemize_list(
325 context.snippet_provider,
326 inputs.map(ArgumentKind::Regular).chain(variadic_arg),
330 ArgumentKind::Regular(ref ty) => ty.span().lo(),
331 ArgumentKind::Variadic(start) => start,
334 ArgumentKind::Regular(ref ty) => ty.span().hi(),
335 ArgumentKind::Variadic(start) => start + BytePos(3),
338 ArgumentKind::Regular(ref ty) => ty.rewrite(context, list_shape),
339 ArgumentKind::Variadic(_) => Some("...".to_owned()),
346 let item_vec: Vec<_> = items.collect();
348 let tactic = definitive_tactic(
350 ListTactic::HorizontalVertical,
354 let trailing_separator = if !context.use_block_indent() || variadic {
355 SeparatorTactic::Never
357 context.config.trailing_comma()
360 let fmt = ListFormatting::new(list_shape, context.config)
362 .trailing_separator(trailing_separator)
363 .ends_with_newline(tactic.ends_with_newline(context.config.indent_style()))
364 .preserve_newline(true);
365 let list_str = write_list(&item_vec, &fmt)?;
367 let ty_shape = match context.config.indent_style() {
369 IndentStyle::Block => shape.offset_left(4)?,
370 IndentStyle::Visual => shape.block_left(4)?,
372 let output = match *output {
373 FunctionRetTy::Ty(ref ty) => {
374 let type_str = ty.rewrite(context, ty_shape)?;
375 format!(" -> {}", type_str)
377 FunctionRetTy::Default(..) => String::new(),
380 let args = if (!list_str.contains('\n') || list_str.is_empty()) && !output.contains('\n')
381 || !context.use_block_indent()
383 format!("({})", list_str)
387 offset.to_string_with_newline(context.config),
389 shape.block().indent.to_string_with_newline(context.config),
392 if output.is_empty() || last_line_width(&args) + first_line_width(&output) <= shape.width {
393 Some(format!("{}{}", args, output))
398 offset.to_string(context.config),
404 fn type_bound_colon(context: &RewriteContext) -> &'static str {
406 context.config.space_before_colon(),
407 context.config.space_after_colon(),
411 impl Rewrite for ast::WherePredicate {
412 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
413 // FIXME: dead spans?
414 let result = match *self {
415 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate {
416 ref bound_generic_params,
421 let type_str = bounded_ty.rewrite(context, shape)?;
422 let colon = type_bound_colon(context).trim_right();
423 let lhs = if let Some(lifetime_str) =
424 rewrite_lifetime_param(context, shape, bound_generic_params)
426 format!("for<{}> {}{}", lifetime_str, type_str, colon)
428 format!("{}{}", type_str, colon)
431 rewrite_assign_rhs(context, lhs, bounds, shape)?
433 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate {
437 }) => rewrite_bounded_lifetime(lifetime, bounds, context, shape)?,
438 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate {
443 let lhs_ty_str = lhs_ty.rewrite(context, shape).map(|lhs| lhs + " =")?;
444 rewrite_assign_rhs(context, lhs_ty_str, &**rhs_ty, shape)?
452 impl Rewrite for ast::GenericArg {
453 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
455 ast::GenericArg::Lifetime(ref lt) => lt.rewrite(context, shape),
456 ast::GenericArg::Type(ref ty) => ty.rewrite(context, shape),
461 fn rewrite_bounded_lifetime(
463 bounds: &[ast::GenericBound],
464 context: &RewriteContext,
466 ) -> Option<String> {
467 let result = lt.rewrite(context, shape)?;
469 if bounds.is_empty() {
472 let colon = type_bound_colon(context);
473 let overhead = last_line_width(&result) + colon.len();
474 let result = format!(
478 join_bounds(context, shape.sub_width(overhead)?, bounds, true)?
484 impl Rewrite for ast::Lifetime {
485 fn rewrite(&self, context: &RewriteContext, _: Shape) -> Option<String> {
486 Some(rewrite_ident(context, self.ident).to_owned())
490 impl Rewrite for ast::GenericBound {
491 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
493 ast::GenericBound::Trait(ref poly_trait_ref, trait_bound_modifier) => {
494 let snippet = context.snippet(self.span());
495 let has_paren = snippet.starts_with("(") && snippet.ends_with(")");
496 let rewrite = match trait_bound_modifier {
497 ast::TraitBoundModifier::None => poly_trait_ref.rewrite(context, shape),
498 ast::TraitBoundModifier::Maybe => poly_trait_ref
499 .rewrite(context, shape.offset_left(1)?)
500 .map(|s| format!("?{}", s)),
502 rewrite.map(|s| if has_paren { format!("({})", s) } else { s })
504 ast::GenericBound::Outlives(ref lifetime) => lifetime.rewrite(context, shape),
509 impl Rewrite for ast::GenericBounds {
510 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
512 return Some(String::new());
515 join_bounds(context, shape, self, true)
519 impl Rewrite for ast::GenericParam {
520 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
521 let mut result = String::with_capacity(128);
522 // FIXME: If there are more than one attributes, this will force multiline.
523 match self.attrs.rewrite(context, shape) {
524 Some(ref rw) if !rw.is_empty() => result.push_str(&format!("{} ", rw)),
527 result.push_str(rewrite_ident(context, self.ident));
528 if !self.bounds.is_empty() {
529 result.push_str(type_bound_colon(context));
530 result.push_str(&self.bounds.rewrite(context, shape)?)
532 if let ast::GenericParamKind::Type {
533 default: Some(ref def),
536 let eq_str = match context.config.type_punctuation_density() {
537 TypeDensity::Compressed => "=",
538 TypeDensity::Wide => " = ",
540 result.push_str(eq_str);
541 let budget = shape.width.checked_sub(result.len())?;
543 def.rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
544 result.push_str(&rewrite);
551 impl Rewrite for ast::PolyTraitRef {
552 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
553 if let Some(lifetime_str) =
554 rewrite_lifetime_param(context, shape, &self.bound_generic_params)
556 // 6 is "for<> ".len()
557 let extra_offset = lifetime_str.len() + 6;
560 .rewrite(context, shape.offset_left(extra_offset)?)?;
562 Some(format!("for<{}> {}", lifetime_str, path_str))
564 self.trait_ref.rewrite(context, shape)
569 impl Rewrite for ast::TraitRef {
570 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
571 rewrite_path(context, PathContext::Type, None, &self.path, shape)
575 impl Rewrite for ast::Ty {
576 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
578 ast::TyKind::TraitObject(ref bounds, tobj_syntax) => {
579 // we have to consider 'dyn' keyword is used or not!!!
580 let is_dyn = tobj_syntax == ast::TraitObjectSyntax::Dyn;
581 // 4 is length of 'dyn '
582 let shape = if is_dyn { shape.offset_left(4)? } else { shape };
583 let res = bounds.rewrite(context, shape)?;
585 Some(format!("dyn {}", res))
590 ast::TyKind::Ptr(ref mt) => {
591 let prefix = match mt.mutbl {
592 Mutability::Mutable => "*mut ",
593 Mutability::Immutable => "*const ",
596 rewrite_unary_prefix(context, prefix, &*mt.ty, shape)
598 ast::TyKind::Rptr(ref lifetime, ref mt) => {
599 let mut_str = format_mutability(mt.mutbl);
600 let mut_len = mut_str.len();
601 Some(match *lifetime {
602 Some(ref lifetime) => {
603 let lt_budget = shape.width.checked_sub(2 + mut_len)?;
604 let lt_str = lifetime.rewrite(
606 Shape::legacy(lt_budget, shape.indent + 2 + mut_len),
608 let lt_len = lt_str.len();
609 let budget = shape.width.checked_sub(2 + mut_len + lt_len)?;
616 Shape::legacy(budget, shape.indent + 2 + mut_len + lt_len)
621 let budget = shape.width.checked_sub(1 + mut_len)?;
627 Shape::legacy(budget, shape.indent + 1 + mut_len)
633 // FIXME: we drop any comments here, even though it's a silly place to put
635 ast::TyKind::Paren(ref ty) => {
636 let budget = shape.width.checked_sub(2)?;
637 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
638 .map(|ty_str| format!("({})", ty_str))
640 ast::TyKind::Slice(ref ty) => {
641 let budget = shape.width.checked_sub(4)?;
642 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
643 .map(|ty_str| format!("[{}]", ty_str))
645 ast::TyKind::Tup(ref items) => {
646 rewrite_tuple(context, items.iter(), self.span, shape, items.len() == 1)
648 ast::TyKind::Path(ref q_self, ref path) => {
649 rewrite_path(context, PathContext::Type, q_self.as_ref(), path, shape)
651 ast::TyKind::Array(ref ty, ref repeats) => rewrite_pair(
654 PairParts::new("[", "; ", "]"),
657 SeparatorPlace::Back,
659 ast::TyKind::Infer => {
660 if shape.width >= 1 {
666 ast::TyKind::BareFn(ref bare_fn) => rewrite_bare_fn(bare_fn, self.span, context, shape),
667 ast::TyKind::Never => Some(String::from("!")),
668 ast::TyKind::Mac(ref mac) => {
669 rewrite_macro(mac, None, context, shape, MacroPosition::Expression)
671 ast::TyKind::ImplicitSelf => Some(String::from("")),
672 ast::TyKind::ImplTrait(_, ref it) => it
673 .rewrite(context, shape)
674 .map(|it_str| format!("impl {}", it_str)),
675 ast::TyKind::Err | ast::TyKind::Typeof(..) => unreachable!(),
681 bare_fn: &ast::BareFnTy,
683 context: &RewriteContext,
685 ) -> Option<String> {
686 debug!("rewrite_bare_fn {:#?}", shape);
688 let mut result = String::with_capacity(128);
690 if let Some(ref lifetime_str) = rewrite_lifetime_param(context, shape, &bare_fn.generic_params)
692 result.push_str("for<");
693 // 6 = "for<> ".len(), 4 = "for<".
694 // This doesn't work out so nicely for multiline situation with lots of
695 // rightward drift. If that is a problem, we could use the list stuff.
696 result.push_str(lifetime_str);
697 result.push_str("> ");
700 result.push_str(::utils::format_unsafety(bare_fn.unsafety));
702 result.push_str(&format_abi(
704 context.config.force_explicit_abi(),
708 result.push_str("fn");
710 let func_ty_shape = if context.use_block_indent() {
711 shape.offset_left(result.len())?
713 shape.visual_indent(result.len()).sub_width(result.len())?
716 let rewrite = format_function_type(
717 bare_fn.decl.inputs.iter(),
718 &bare_fn.decl.output,
719 bare_fn.decl.variadic,
725 result.push_str(&rewrite);
730 fn is_generic_bounds_in_order(generic_bounds: &[ast::GenericBound]) -> bool {
731 let is_trait = |b: &ast::GenericBound| match b {
732 ast::GenericBound::Outlives(..) => false,
733 ast::GenericBound::Trait(..) => true,
735 let is_lifetime = |b: &ast::GenericBound| !is_trait(b);
736 let last_trait_index = generic_bounds.iter().rposition(is_trait);
737 let first_lifetime_index = generic_bounds.iter().position(is_lifetime);
738 match (last_trait_index, first_lifetime_index) {
739 (Some(last_trait_index), Some(first_lifetime_index)) => {
740 last_trait_index < first_lifetime_index
747 context: &RewriteContext,
749 items: &[ast::GenericBound],
751 ) -> Option<String> {
752 debug_assert!(!items.is_empty());
754 // Try to join types in a single line
755 let joiner = match context.config.type_punctuation_density() {
756 TypeDensity::Compressed => "+",
757 TypeDensity::Wide => " + ",
759 let type_strs = items
761 .map(|item| item.rewrite(context, shape))
762 .collect::<Option<Vec<_>>>()?;
763 let result = type_strs.join(joiner);
764 if items.len() <= 1 || (!result.contains('\n') && result.len() <= shape.width) {
768 // We need to use multiple lines.
769 let (type_strs, offset) = if need_indent {
770 // Rewrite with additional indentation.
771 let nested_shape = shape.block_indent(context.config.tab_spaces());
772 let type_strs = items
774 .map(|item| item.rewrite(context, nested_shape))
775 .collect::<Option<Vec<_>>>()?;
776 (type_strs, nested_shape.indent)
778 (type_strs, shape.indent)
781 let is_bound_extendable = |s: &str, b: &ast::GenericBound| match b {
782 ast::GenericBound::Outlives(..) => true,
783 ast::GenericBound::Trait(..) => last_line_extendable(s),
785 let mut result = String::with_capacity(128);
786 result.push_str(&type_strs[0]);
787 let mut can_be_put_on_the_same_line = is_bound_extendable(&result, &items[0]);
788 let generic_bounds_in_order = is_generic_bounds_in_order(items);
789 for (bound, bound_str) in items[1..].iter().zip(type_strs[1..].iter()) {
790 if generic_bounds_in_order && can_be_put_on_the_same_line {
791 result.push_str(joiner);
793 result.push_str(&offset.to_string_with_newline(context.config));
794 result.push_str("+ ");
796 result.push_str(bound_str);
797 can_be_put_on_the_same_line = is_bound_extendable(bound_str, bound);
803 pub fn can_be_overflowed_type(context: &RewriteContext, ty: &ast::Ty, len: usize) -> bool {
805 ast::TyKind::Tup(..) => context.use_block_indent() && len == 1,
806 ast::TyKind::Rptr(_, ref mutty) | ast::TyKind::Ptr(ref mutty) => {
807 can_be_overflowed_type(context, &*mutty.ty, len)
813 /// Returns `None` if there is no `LifetimeDef` in the given generic parameters.
814 fn rewrite_lifetime_param(
815 context: &RewriteContext,
817 generic_params: &[ast::GenericParam],
818 ) -> Option<String> {
819 let result = generic_params
821 .filter(|p| match p.kind {
822 ast::GenericParamKind::Lifetime => true,
825 .map(|lt| lt.rewrite(context, shape))
826 .collect::<Option<Vec<_>>>()?
828 if result.is_empty() {