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() || !data.types.is_empty()
234 || !data.bindings.is_empty() =>
236 let param_list = data.lifetimes
238 .map(SegmentParam::LifeTime)
239 .chain(data.types.iter().map(|x| SegmentParam::Type(&*x)))
240 .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x)))
241 .collect::<Vec<_>>();
243 let separator = if path_context == PathContext::Expr {
248 result.push_str(separator);
250 let generics_str = overflow::rewrite_with_angle_brackets(
253 ¶m_list.iter().map(|e| &*e).collect::<Vec<_>>(),
255 mk_sp(*span_lo, span_hi),
258 // Update position of last bracket.
261 .span_after(mk_sp(*span_lo, span_hi), "<");
263 result.push_str(&generics_str)
265 ast::PathParameters::Parenthesized(ref data) => {
266 let output = match data.output {
267 Some(ref ty) => FunctionRetTy::Ty(ty.clone()),
268 None => FunctionRetTy::Default(codemap::DUMMY_SP),
270 result.push_str(&format_function_type(
271 data.inputs.iter().map(|x| &**x),
286 fn format_function_type<'a, I>(
288 output: &FunctionRetTy,
291 context: &RewriteContext,
295 I: ExactSizeIterator,
296 <I as Iterator>::Item: Deref,
297 <I::Item as Deref>::Target: Rewrite + Spanned + 'a,
299 // Code for handling variadics is somewhat duplicated for items, but they
300 // are different enough to need some serious refactoring to share code.
304 <T as Deref>::Target: Rewrite + Spanned,
310 let variadic_arg = if variadic {
311 let variadic_start = context.snippet_provider.span_before(span, "...");
312 Some(ArgumentKind::Variadic(variadic_start))
318 let budget = shape.width.checked_sub(2)?;
320 let offset = match context.config.indent_style() {
321 IndentStyle::Block => {
324 .block_indent(context.config.tab_spaces())
327 IndentStyle::Visual => shape.indent + 1,
329 let list_shape = Shape::legacy(budget, offset);
330 let list_lo = context.snippet_provider.span_after(span, "(");
331 let items = itemize_list(
332 context.snippet_provider,
333 // FIXME Would be nice to avoid this allocation,
334 // but I couldn't get the types to work out.
336 .map(|i| ArgumentKind::Regular(Box::new(i)))
337 .chain(variadic_arg),
341 ArgumentKind::Regular(ref ty) => ty.span().lo(),
342 ArgumentKind::Variadic(start) => start,
345 ArgumentKind::Regular(ref ty) => ty.span().hi(),
346 ArgumentKind::Variadic(start) => start + BytePos(3),
349 ArgumentKind::Regular(ref ty) => ty.rewrite(context, list_shape),
350 ArgumentKind::Variadic(_) => Some("...".to_owned()),
357 let item_vec: Vec<_> = items.collect();
359 let tactic = definitive_tactic(
361 ListTactic::HorizontalVertical,
366 let fmt = ListFormatting {
369 trailing_separator: if !context.use_block_indent() || variadic {
370 SeparatorTactic::Never
372 context.config.trailing_comma()
374 separator_place: SeparatorPlace::Back,
376 ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
377 preserve_newline: true,
378 config: context.config,
381 let list_str = write_list(&item_vec, &fmt)?;
383 let ty_shape = match context.config.indent_style() {
385 IndentStyle::Block => shape.offset_left(4)?,
386 IndentStyle::Visual => shape.block_left(4)?,
388 let output = match *output {
389 FunctionRetTy::Ty(ref ty) => {
390 let type_str = ty.rewrite(context, ty_shape)?;
391 format!(" -> {}", type_str)
393 FunctionRetTy::Default(..) => String::new(),
396 let args = if (!list_str.contains('\n') || list_str.is_empty()) && !output.contains('\n')
397 || !context.use_block_indent()
399 format!("({})", list_str)
403 offset.to_string_with_newline(context.config),
405 shape.block().indent.to_string_with_newline(context.config),
408 if last_line_width(&args) + first_line_width(&output) <= shape.width {
409 Some(format!("{}{}", args, output))
414 offset.to_string(context.config),
420 fn type_bound_colon(context: &RewriteContext) -> &'static str {
422 context.config.space_before_colon(),
423 context.config.space_after_colon(),
427 impl Rewrite for ast::WherePredicate {
428 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
430 let result = match *self {
431 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate {
432 ref bound_generic_params,
437 let type_str = bounded_ty.rewrite(context, shape)?;
438 let colon = type_bound_colon(context).trim_right();
439 let lhs = if let Some(lifetime_str) =
440 rewrite_lifetime_param(context, shape, bound_generic_params)
442 if context.config.spaces_within_parens_and_brackets()
443 && !lifetime_str.is_empty()
445 format!("for< {} > {}{}", lifetime_str, type_str, colon)
447 format!("for<{}> {}{}", lifetime_str, type_str, colon)
450 format!("{}{}", type_str, colon)
453 rewrite_assign_rhs(context, lhs, bounds, shape)?
455 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate {
459 }) => rewrite_bounded_lifetime(lifetime, bounds, context, shape)?,
460 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate {
465 let lhs_ty_str = lhs_ty.rewrite(context, shape).map(|lhs| lhs + " =")?;
466 rewrite_assign_rhs(context, lhs_ty_str, &**rhs_ty, shape)?
474 impl Rewrite for ast::LifetimeDef {
475 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
476 rewrite_bounded_lifetime(&self.lifetime, &self.bounds, context, shape)
480 fn rewrite_bounded_lifetime(
482 bounds: &[ast::Lifetime],
483 context: &RewriteContext,
485 ) -> Option<String> {
486 let result = lt.rewrite(context, shape)?;
488 if bounds.is_empty() {
491 let colon = type_bound_colon(context);
492 let overhead = last_line_width(&result) + colon.len();
493 let result = format!(
497 join_bounds(context, shape.sub_width(overhead)?, bounds, true)?
503 impl Rewrite for ast::TyParamBound {
504 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
506 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::None) => {
507 tref.rewrite(context, shape)
509 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::Maybe) => Some(
510 format!("?{}", tref.rewrite(context, shape.offset_left(1)?)?),
512 ast::TyParamBound::RegionTyParamBound(ref l) => l.rewrite(context, shape),
517 impl Rewrite for ast::Lifetime {
518 fn rewrite(&self, _: &RewriteContext, _: Shape) -> Option<String> {
519 Some(self.ident.to_string())
523 /// A simple wrapper over type param bounds in trait.
525 pub struct TraitTyParamBounds<'a> {
526 inner: &'a ast::TyParamBounds,
529 impl<'a> Rewrite for TraitTyParamBounds<'a> {
530 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
531 join_bounds(context, shape, self.inner, false)
535 impl Rewrite for ast::TyParamBounds {
536 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
537 join_bounds(context, shape, self, true)
541 impl Rewrite for ast::TyParam {
542 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
543 let mut result = String::with_capacity(128);
544 // FIXME: If there are more than one attributes, this will force multiline.
545 match self.attrs.rewrite(context, shape) {
546 Some(ref rw) if !rw.is_empty() => result.push_str(&format!("{} ", rw)),
549 result.push_str(&self.ident.to_string());
550 if !self.bounds.is_empty() {
551 result.push_str(type_bound_colon(context));
552 result.push_str(&self.bounds.rewrite(context, shape)?)
554 if let Some(ref def) = self.default {
555 let eq_str = match context.config.type_punctuation_density() {
556 TypeDensity::Compressed => "=",
557 TypeDensity::Wide => " = ",
559 result.push_str(eq_str);
560 let budget = shape.width.checked_sub(result.len())?;
561 let rewrite = def.rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
562 result.push_str(&rewrite);
569 impl Rewrite for ast::PolyTraitRef {
570 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
571 if let Some(lifetime_str) =
572 rewrite_lifetime_param(context, shape, &self.bound_generic_params)
574 // 6 is "for<> ".len()
575 let extra_offset = lifetime_str.len() + 6;
576 let path_str = self.trait_ref
577 .rewrite(context, shape.offset_left(extra_offset)?)?;
580 if context.config.spaces_within_parens_and_brackets() && !lifetime_str.is_empty() {
581 format!("for< {} > {}", lifetime_str, path_str)
583 format!("for<{}> {}", lifetime_str, path_str)
587 self.trait_ref.rewrite(context, shape)
592 impl Rewrite for ast::TraitRef {
593 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
594 rewrite_path(context, PathContext::Type, None, &self.path, shape)
598 impl Rewrite for ast::Ty {
599 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
601 ast::TyKind::TraitObject(ref bounds, tobj_syntax) => {
602 // we have to consider 'dyn' keyword is used or not!!!
603 let is_dyn = tobj_syntax == ast::TraitObjectSyntax::Dyn;
604 // 4 is length of 'dyn '
605 let shape = if is_dyn { shape.offset_left(4)? } else { shape };
606 let res = bounds.rewrite(context, shape)?;
608 Some(format!("dyn {}", res))
613 ast::TyKind::Ptr(ref mt) => {
614 let prefix = match mt.mutbl {
615 Mutability::Mutable => "*mut ",
616 Mutability::Immutable => "*const ",
619 rewrite_unary_prefix(context, prefix, &*mt.ty, shape)
621 ast::TyKind::Rptr(ref lifetime, ref mt) => {
622 let mut_str = format_mutability(mt.mutbl);
623 let mut_len = mut_str.len();
624 Some(match *lifetime {
625 Some(ref lifetime) => {
626 let lt_budget = shape.width.checked_sub(2 + mut_len)?;
627 let lt_str = lifetime.rewrite(
629 Shape::legacy(lt_budget, shape.indent + 2 + mut_len),
631 let lt_len = lt_str.len();
632 let budget = shape.width.checked_sub(2 + mut_len + lt_len)?;
639 Shape::legacy(budget, shape.indent + 2 + mut_len + lt_len)
644 let budget = shape.width.checked_sub(1 + mut_len)?;
650 Shape::legacy(budget, shape.indent + 1 + mut_len)
656 // FIXME: we drop any comments here, even though it's a silly place to put
658 ast::TyKind::Paren(ref ty) => {
659 let budget = shape.width.checked_sub(2)?;
660 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
662 if context.config.spaces_within_parens_and_brackets() {
663 format!("( {} )", ty_str)
665 format!("({})", ty_str)
669 ast::TyKind::Slice(ref ty) => {
670 let budget = if context.config.spaces_within_parens_and_brackets() {
671 shape.width.checked_sub(4)?
673 shape.width.checked_sub(2)?
675 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
677 if context.config.spaces_within_parens_and_brackets() {
678 format!("[ {} ]", ty_str)
680 format!("[{}]", ty_str)
684 ast::TyKind::Tup(ref items) => rewrite_tuple(
686 &::utils::ptr_vec_to_ref_vec(items),
690 ast::TyKind::Path(ref q_self, ref path) => {
691 rewrite_path(context, PathContext::Type, q_self.as_ref(), path, shape)
693 ast::TyKind::Array(ref ty, ref repeats) => {
694 let use_spaces = context.config.spaces_within_parens_and_brackets();
695 let lbr = if use_spaces { "[ " } else { "[" };
696 let rbr = if use_spaces { " ]" } else { "]" };
700 PairParts::new(lbr, "; ", rbr),
703 SeparatorPlace::Back,
706 ast::TyKind::Infer => {
707 if shape.width >= 1 {
713 ast::TyKind::BareFn(ref bare_fn) => rewrite_bare_fn(bare_fn, self.span, context, shape),
714 ast::TyKind::Never => Some(String::from("!")),
715 ast::TyKind::Mac(ref mac) => {
716 rewrite_macro(mac, None, context, shape, MacroPosition::Expression)
718 ast::TyKind::ImplicitSelf => Some(String::from("")),
719 ast::TyKind::ImplTrait(ref it) => it.rewrite(context, shape)
720 .map(|it_str| format!("impl {}", it_str)),
721 ast::TyKind::Err | ast::TyKind::Typeof(..) => unreachable!(),
727 bare_fn: &ast::BareFnTy,
729 context: &RewriteContext,
731 ) -> Option<String> {
732 let mut result = String::with_capacity(128);
734 if let Some(ref lifetime_str) = rewrite_lifetime_param(context, shape, &bare_fn.generic_params)
736 result.push_str("for<");
737 // 6 = "for<> ".len(), 4 = "for<".
738 // This doesn't work out so nicely for multiline situation with lots of
739 // rightward drift. If that is a problem, we could use the list stuff.
740 result.push_str(lifetime_str);
741 result.push_str("> ");
744 result.push_str(::utils::format_unsafety(bare_fn.unsafety));
746 result.push_str(&format_abi(
748 context.config.force_explicit_abi(),
752 result.push_str("fn");
754 let func_ty_shape = shape.offset_left(result.len())?;
756 let rewrite = format_function_type(
757 bare_fn.decl.inputs.iter(),
758 &bare_fn.decl.output,
759 bare_fn.decl.variadic,
765 result.push_str(&rewrite);
771 context: &RewriteContext,
779 // Try to join types in a single line
780 let joiner = match context.config.type_punctuation_density() {
781 TypeDensity::Compressed => "+",
782 TypeDensity::Wide => " + ",
784 let type_strs = items
786 .map(|item| item.rewrite(context, shape))
787 .collect::<Option<Vec<_>>>()?;
788 let result = type_strs.join(joiner);
789 if items.len() == 1 || (!result.contains('\n') && result.len() <= shape.width) {
793 // We need to use multiple lines.
794 let (type_strs, offset) = if need_indent {
795 // Rewrite with additional indentation.
796 let nested_shape = shape.block_indent(context.config.tab_spaces());
797 let type_strs = items
799 .map(|item| item.rewrite(context, nested_shape))
800 .collect::<Option<Vec<_>>>()?;
801 (type_strs, nested_shape.indent)
803 (type_strs, shape.indent)
806 let joiner = format!("{}+ ", offset.to_string_with_newline(context.config));
807 Some(type_strs.join(&joiner))
810 pub fn can_be_overflowed_type(context: &RewriteContext, ty: &ast::Ty, len: usize) -> bool {
812 ast::TyKind::Tup(..) => context.use_block_indent() && len == 1,
813 ast::TyKind::Rptr(_, ref mutty) | ast::TyKind::Ptr(ref mutty) => {
814 can_be_overflowed_type(context, &*mutty.ty, len)
820 /// Returns `None` if there is no `LifetimeDef` in the given generic parameters.
821 fn rewrite_lifetime_param(
822 context: &RewriteContext,
824 generic_params: &[ast::GenericParam],
825 ) -> Option<String> {
826 let result = generic_params
828 .filter(|p| p.is_lifetime_param())
829 .map(|lt| lt.rewrite(context, shape))
830 .collect::<Option<Vec<_>>>()?
832 if result.is_empty() {