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::codemap::{self, BytePos, Span};
17 use syntax::symbol::keywords;
19 use codemap::SpanUtils;
20 use config::{IndentStyle, TypeDensity};
22 rewrite_assign_rhs, rewrite_pair, rewrite_tuple, rewrite_unary_prefix, PairParts, ToExpr,
24 use lists::{definitive_tactic, itemize_list, write_list, ListFormatting, Separator};
25 use macros::{rewrite_macro, MacroPosition};
27 use rewrite::{Rewrite, RewriteContext};
31 colon_spaces, extra_offset, first_line_width, format_abi, format_mutability, last_line_width,
35 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
36 pub enum PathContext {
42 // Does not wrap on simple segments.
44 context: &RewriteContext,
45 path_context: PathContext,
46 qself: Option<&ast::QSelf>,
50 let skip_count = qself.map_or(0, |x| x.position);
52 let mut result = if path.is_global() && qself.is_none() && path_context != PathContext::Import {
58 let mut span_lo = path.span.lo();
60 if let Some(qself) = qself {
62 if context.config.spaces_within_parens_and_brackets() {
66 let fmt_ty = qself.ty.rewrite(context, shape)?;
67 result.push_str(&fmt_ty);
70 result.push_str(" as ");
71 if path.is_global() && path_context != PathContext::Import {
72 result.push_str("::");
76 let shape = shape.sub_width(3)?;
78 result = rewrite_path_segments(
81 path.segments.iter().take(skip_count),
89 if context.config.spaces_within_parens_and_brackets() {
93 result.push_str(">::");
94 span_lo = qself.ty.span.hi() + BytePos(1);
97 rewrite_path_segments(
100 path.segments.iter().skip(skip_count),
108 fn rewrite_path_segments<'a, I>(
109 path_context: PathContext,
112 mut span_lo: BytePos,
114 context: &RewriteContext,
118 I: Iterator<Item = &'a ast::PathSegment>,
120 let mut first = true;
121 let shape = shape.visual_indent(0);
123 for segment in iter {
124 // Indicates a global path, shouldn't be rendered.
125 if segment.ident.name == keywords::CrateRoot.name() {
131 buffer.push_str("::");
134 let extra_offset = extra_offset(&buffer, shape);
135 let new_shape = shape.shrink_left(extra_offset)?;
136 let segment_string = rewrite_segment(
145 buffer.push_str(&segment_string);
152 enum SegmentParam<'a> {
153 LifeTime(&'a ast::Lifetime),
155 Binding(&'a ast::TypeBinding),
158 impl<'a> Spanned for SegmentParam<'a> {
159 fn span(&self) -> Span {
161 SegmentParam::LifeTime(lt) => lt.ident.span,
162 SegmentParam::Type(ty) => ty.span,
163 SegmentParam::Binding(binding) => binding.span,
168 impl<'a> ToExpr for SegmentParam<'a> {
169 fn to_expr(&self) -> Option<&ast::Expr> {
173 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool {
175 SegmentParam::Type(ty) => ty.can_be_overflowed(context, len),
181 impl<'a> Rewrite for SegmentParam<'a> {
182 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
184 SegmentParam::LifeTime(lt) => lt.rewrite(context, shape),
185 SegmentParam::Type(ty) => ty.rewrite(context, shape),
186 SegmentParam::Binding(binding) => {
187 let mut result = match context.config.type_punctuation_density() {
188 TypeDensity::Wide => format!("{} = ", binding.ident),
189 TypeDensity::Compressed => format!("{}=", binding.ident),
191 let budget = shape.width.checked_sub(result.len())?;
192 let rewrite = binding
194 .rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
195 result.push_str(&rewrite);
202 // Formats a path segment. There are some hacks involved to correctly determine
203 // the segment's associated span since it's not part of the AST.
205 // The span_lo is assumed to be greater than the end of any previous segment's
206 // parameters and lesser or equal than the start of current segment.
208 // span_hi is assumed equal to the end of the entire path.
210 // When the segment contains a positive number of parameters, we update span_lo
211 // so that invariants described above will hold for the next segment.
213 path_context: PathContext,
214 segment: &ast::PathSegment,
215 span_lo: &mut BytePos,
217 context: &RewriteContext,
219 ) -> Option<String> {
220 let mut result = String::with_capacity(128);
221 result.push_str(&segment.ident.name.as_str());
223 let ident_len = result.len();
224 let shape = if context.use_block_indent() {
225 shape.offset_left(ident_len)?
227 shape.shrink_left(ident_len)?
230 if let Some(ref params) = segment.parameters {
232 ast::PathParameters::AngleBracketed(ref data)
233 if !data.lifetimes.is_empty()
234 || !data.types.is_empty()
235 || !data.bindings.is_empty() =>
237 let param_list = data.lifetimes
239 .map(SegmentParam::LifeTime)
240 .chain(data.types.iter().map(|x| SegmentParam::Type(&*x)))
241 .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x)))
242 .collect::<Vec<_>>();
244 let separator = if path_context == PathContext::Expr {
249 result.push_str(separator);
251 let generics_str = overflow::rewrite_with_angle_brackets(
254 ¶m_list.iter().map(|e| &*e).collect::<Vec<_>>(),
256 mk_sp(*span_lo, span_hi),
259 // Update position of last bracket.
262 .span_after(mk_sp(*span_lo, span_hi), "<");
264 result.push_str(&generics_str)
266 ast::PathParameters::Parenthesized(ref data) => {
267 let output = match data.output {
268 Some(ref ty) => FunctionRetTy::Ty(ty.clone()),
269 None => FunctionRetTy::Default(codemap::DUMMY_SP),
271 result.push_str(&format_function_type(
272 data.inputs.iter().map(|x| &**x),
287 fn format_function_type<'a, I>(
289 output: &FunctionRetTy,
292 context: &RewriteContext,
296 I: ExactSizeIterator,
297 <I as Iterator>::Item: Deref,
298 <I::Item as Deref>::Target: Rewrite + Spanned + 'a,
300 // Code for handling variadics is somewhat duplicated for items, but they
301 // are different enough to need some serious refactoring to share code.
305 <T as Deref>::Target: Rewrite + Spanned,
311 let variadic_arg = if variadic {
312 let variadic_start = context.snippet_provider.span_before(span, "...");
313 Some(ArgumentKind::Variadic(variadic_start))
319 let budget = shape.width.checked_sub(2)?;
321 let offset = match context.config.indent_style() {
322 IndentStyle::Block => {
325 .block_indent(context.config.tab_spaces())
328 IndentStyle::Visual => shape.indent + 1,
330 let list_shape = Shape::legacy(budget, offset);
331 let list_lo = context.snippet_provider.span_after(span, "(");
332 let items = itemize_list(
333 context.snippet_provider,
334 // FIXME Would be nice to avoid this allocation,
335 // but I couldn't get the types to work out.
337 .map(|i| ArgumentKind::Regular(Box::new(i)))
338 .chain(variadic_arg),
342 ArgumentKind::Regular(ref ty) => ty.span().lo(),
343 ArgumentKind::Variadic(start) => start,
346 ArgumentKind::Regular(ref ty) => ty.span().hi(),
347 ArgumentKind::Variadic(start) => start + BytePos(3),
350 ArgumentKind::Regular(ref ty) => ty.rewrite(context, list_shape),
351 ArgumentKind::Variadic(_) => Some("...".to_owned()),
358 let item_vec: Vec<_> = items.collect();
360 let tactic = definitive_tactic(
362 ListTactic::HorizontalVertical,
367 let fmt = ListFormatting {
370 trailing_separator: if !context.use_block_indent() || variadic {
371 SeparatorTactic::Never
373 context.config.trailing_comma()
375 separator_place: SeparatorPlace::Back,
377 ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
378 preserve_newline: true,
379 config: context.config,
382 let list_str = write_list(&item_vec, &fmt)?;
384 let ty_shape = match context.config.indent_style() {
386 IndentStyle::Block => shape.offset_left(4)?,
387 IndentStyle::Visual => shape.block_left(4)?,
389 let output = match *output {
390 FunctionRetTy::Ty(ref ty) => {
391 let type_str = ty.rewrite(context, ty_shape)?;
392 format!(" -> {}", type_str)
394 FunctionRetTy::Default(..) => String::new(),
397 let args = if (!list_str.contains('\n') || list_str.is_empty()) && !output.contains('\n')
398 || !context.use_block_indent()
400 format!("({})", list_str)
404 offset.to_string_with_newline(context.config),
406 shape.block().indent.to_string_with_newline(context.config),
409 if last_line_width(&args) + first_line_width(&output) <= shape.width {
410 Some(format!("{}{}", args, output))
415 offset.to_string(context.config),
421 fn type_bound_colon(context: &RewriteContext) -> &'static str {
423 context.config.space_before_colon(),
424 context.config.space_after_colon(),
428 impl Rewrite for ast::WherePredicate {
429 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
431 let result = match *self {
432 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate {
433 ref bound_generic_params,
438 let type_str = bounded_ty.rewrite(context, shape)?;
439 let colon = type_bound_colon(context).trim_right();
440 let lhs = if let Some(lifetime_str) =
441 rewrite_lifetime_param(context, shape, bound_generic_params)
443 if context.config.spaces_within_parens_and_brackets()
444 && !lifetime_str.is_empty()
446 format!("for< {} > {}{}", lifetime_str, type_str, colon)
448 format!("for<{}> {}{}", lifetime_str, type_str, colon)
451 format!("{}{}", type_str, colon)
454 rewrite_assign_rhs(context, lhs, bounds, shape)?
456 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate {
460 }) => rewrite_bounded_lifetime(lifetime, bounds, context, shape)?,
461 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate {
466 let lhs_ty_str = lhs_ty.rewrite(context, shape).map(|lhs| lhs + " =")?;
467 rewrite_assign_rhs(context, lhs_ty_str, &**rhs_ty, shape)?
475 impl Rewrite for ast::LifetimeDef {
476 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
477 rewrite_bounded_lifetime(&self.lifetime, &self.bounds, context, shape)
481 fn rewrite_bounded_lifetime(
483 bounds: &[ast::Lifetime],
484 context: &RewriteContext,
486 ) -> Option<String> {
487 let result = lt.rewrite(context, shape)?;
489 if bounds.is_empty() {
492 let colon = type_bound_colon(context);
493 let overhead = last_line_width(&result) + colon.len();
494 let result = format!(
498 join_bounds(context, shape.sub_width(overhead)?, bounds, true)?
504 impl Rewrite for ast::TyParamBound {
505 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
507 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::None) => {
508 tref.rewrite(context, shape)
510 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::Maybe) => Some(
511 format!("?{}", tref.rewrite(context, shape.offset_left(1)?)?),
513 ast::TyParamBound::RegionTyParamBound(ref l) => l.rewrite(context, shape),
518 impl Rewrite for ast::Lifetime {
519 fn rewrite(&self, _: &RewriteContext, _: Shape) -> Option<String> {
520 Some(self.ident.to_string())
524 /// A simple wrapper over type param bounds in trait.
526 pub struct TraitTyParamBounds<'a> {
527 inner: &'a ast::TyParamBounds,
530 impl<'a> Rewrite for TraitTyParamBounds<'a> {
531 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
532 join_bounds(context, shape, self.inner, false)
536 impl Rewrite for ast::TyParamBounds {
537 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
538 join_bounds(context, shape, self, true)
542 impl Rewrite for ast::TyParam {
543 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
544 let mut result = String::with_capacity(128);
545 // FIXME: If there are more than one attributes, this will force multiline.
546 match self.attrs.rewrite(context, shape) {
547 Some(ref rw) if !rw.is_empty() => result.push_str(&format!("{} ", rw)),
550 result.push_str(&self.ident.to_string());
551 if !self.bounds.is_empty() {
552 result.push_str(type_bound_colon(context));
553 result.push_str(&self.bounds.rewrite(context, shape)?)
555 if let Some(ref def) = self.default {
556 let eq_str = match context.config.type_punctuation_density() {
557 TypeDensity::Compressed => "=",
558 TypeDensity::Wide => " = ",
560 result.push_str(eq_str);
561 let budget = shape.width.checked_sub(result.len())?;
562 let rewrite = def.rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
563 result.push_str(&rewrite);
570 impl Rewrite for ast::PolyTraitRef {
571 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
572 if let Some(lifetime_str) =
573 rewrite_lifetime_param(context, shape, &self.bound_generic_params)
575 // 6 is "for<> ".len()
576 let extra_offset = lifetime_str.len() + 6;
577 let path_str = self.trait_ref
578 .rewrite(context, shape.offset_left(extra_offset)?)?;
581 if context.config.spaces_within_parens_and_brackets() && !lifetime_str.is_empty() {
582 format!("for< {} > {}", lifetime_str, path_str)
584 format!("for<{}> {}", lifetime_str, path_str)
588 self.trait_ref.rewrite(context, shape)
593 impl Rewrite for ast::TraitRef {
594 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
595 rewrite_path(context, PathContext::Type, None, &self.path, shape)
599 impl Rewrite for ast::Ty {
600 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
602 ast::TyKind::TraitObject(ref bounds, tobj_syntax) => {
603 // we have to consider 'dyn' keyword is used or not!!!
604 let is_dyn = tobj_syntax == ast::TraitObjectSyntax::Dyn;
605 // 4 is length of 'dyn '
606 let shape = if is_dyn { shape.offset_left(4)? } else { shape };
607 let res = bounds.rewrite(context, shape)?;
609 Some(format!("dyn {}", res))
614 ast::TyKind::Ptr(ref mt) => {
615 let prefix = match mt.mutbl {
616 Mutability::Mutable => "*mut ",
617 Mutability::Immutable => "*const ",
620 rewrite_unary_prefix(context, prefix, &*mt.ty, shape)
622 ast::TyKind::Rptr(ref lifetime, ref mt) => {
623 let mut_str = format_mutability(mt.mutbl);
624 let mut_len = mut_str.len();
625 Some(match *lifetime {
626 Some(ref lifetime) => {
627 let lt_budget = shape.width.checked_sub(2 + mut_len)?;
628 let lt_str = lifetime.rewrite(
630 Shape::legacy(lt_budget, shape.indent + 2 + mut_len),
632 let lt_len = lt_str.len();
633 let budget = shape.width.checked_sub(2 + mut_len + lt_len)?;
640 Shape::legacy(budget, shape.indent + 2 + mut_len + lt_len)
645 let budget = shape.width.checked_sub(1 + mut_len)?;
651 Shape::legacy(budget, shape.indent + 1 + mut_len)
657 // FIXME: we drop any comments here, even though it's a silly place to put
659 ast::TyKind::Paren(ref ty) => {
660 let budget = shape.width.checked_sub(2)?;
661 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
663 if context.config.spaces_within_parens_and_brackets() {
664 format!("( {} )", ty_str)
666 format!("({})", ty_str)
670 ast::TyKind::Slice(ref ty) => {
671 let budget = if context.config.spaces_within_parens_and_brackets() {
672 shape.width.checked_sub(4)?
674 shape.width.checked_sub(2)?
676 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
678 if context.config.spaces_within_parens_and_brackets() {
679 format!("[ {} ]", ty_str)
681 format!("[{}]", ty_str)
685 ast::TyKind::Tup(ref items) => rewrite_tuple(
687 &::utils::ptr_vec_to_ref_vec(items),
691 ast::TyKind::Path(ref q_self, ref path) => {
692 rewrite_path(context, PathContext::Type, q_self.as_ref(), path, shape)
694 ast::TyKind::Array(ref ty, ref repeats) => {
695 let use_spaces = context.config.spaces_within_parens_and_brackets();
696 let lbr = if use_spaces { "[ " } else { "[" };
697 let rbr = if use_spaces { " ]" } else { "]" };
701 PairParts::new(lbr, "; ", rbr),
704 SeparatorPlace::Back,
707 ast::TyKind::Infer => {
708 if shape.width >= 1 {
714 ast::TyKind::BareFn(ref bare_fn) => rewrite_bare_fn(bare_fn, self.span, context, shape),
715 ast::TyKind::Never => Some(String::from("!")),
716 ast::TyKind::Mac(ref mac) => {
717 rewrite_macro(mac, None, context, shape, MacroPosition::Expression)
719 ast::TyKind::ImplicitSelf => Some(String::from("")),
720 ast::TyKind::ImplTrait(ref it) => it.rewrite(context, shape)
721 .map(|it_str| format!("impl {}", it_str)),
722 ast::TyKind::Err | ast::TyKind::Typeof(..) => unreachable!(),
728 bare_fn: &ast::BareFnTy,
730 context: &RewriteContext,
732 ) -> Option<String> {
733 let mut result = String::with_capacity(128);
735 if let Some(ref lifetime_str) = rewrite_lifetime_param(context, shape, &bare_fn.generic_params)
737 result.push_str("for<");
738 // 6 = "for<> ".len(), 4 = "for<".
739 // This doesn't work out so nicely for multiline situation with lots of
740 // rightward drift. If that is a problem, we could use the list stuff.
741 result.push_str(lifetime_str);
742 result.push_str("> ");
745 result.push_str(::utils::format_unsafety(bare_fn.unsafety));
747 result.push_str(&format_abi(
749 context.config.force_explicit_abi(),
753 result.push_str("fn");
755 let func_ty_shape = shape.offset_left(result.len())?;
757 let rewrite = format_function_type(
758 bare_fn.decl.inputs.iter(),
759 &bare_fn.decl.output,
760 bare_fn.decl.variadic,
766 result.push_str(&rewrite);
772 context: &RewriteContext,
780 // Try to join types in a single line
781 let joiner = match context.config.type_punctuation_density() {
782 TypeDensity::Compressed => "+",
783 TypeDensity::Wide => " + ",
785 let type_strs = items
787 .map(|item| item.rewrite(context, shape))
788 .collect::<Option<Vec<_>>>()?;
789 let result = type_strs.join(joiner);
790 if items.len() == 1 || (!result.contains('\n') && result.len() <= shape.width) {
794 // We need to use multiple lines.
795 let (type_strs, offset) = if need_indent {
796 // Rewrite with additional indentation.
797 let nested_shape = shape.block_indent(context.config.tab_spaces());
798 let type_strs = items
800 .map(|item| item.rewrite(context, nested_shape))
801 .collect::<Option<Vec<_>>>()?;
802 (type_strs, nested_shape.indent)
804 (type_strs, shape.indent)
807 let joiner = format!("{}+ ", offset.to_string_with_newline(context.config));
808 Some(type_strs.join(&joiner))
811 pub fn can_be_overflowed_type(context: &RewriteContext, ty: &ast::Ty, len: usize) -> bool {
813 ast::TyKind::Tup(..) => context.use_block_indent() && len == 1,
814 ast::TyKind::Rptr(_, ref mutty) | ast::TyKind::Ptr(ref mutty) => {
815 can_be_overflowed_type(context, &*mutty.ty, len)
821 /// Returns `None` if there is no `LifetimeDef` in the given generic parameters.
822 fn rewrite_lifetime_param(
823 context: &RewriteContext,
825 generic_params: &[ast::GenericParam],
826 ) -> Option<String> {
827 let result = generic_params
829 .filter(|p| p.is_lifetime_param())
830 .map(|lt| lt.rewrite(context, shape))
831 .collect::<Option<Vec<_>>>()?
833 if result.is_empty() {