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};
21 use expr::{rewrite_assign_rhs, rewrite_tuple, rewrite_unary_prefix, ToExpr};
22 use lists::{definitive_tactic, itemize_list, write_list, ListFormatting, Separator};
23 use macros::{rewrite_macro, MacroPosition};
25 use pairs::{rewrite_pair, PairParts};
26 use rewrite::{Rewrite, RewriteContext};
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 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> ToExpr for SegmentParam<'a> {
170 fn to_expr(&self) -> Option<&ast::Expr> {
174 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool {
176 SegmentParam::Type(ty) => ty.can_be_overflowed(context, len),
182 impl<'a> Rewrite for SegmentParam<'a> {
183 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
185 SegmentParam::LifeTime(lt) => lt.rewrite(context, shape),
186 SegmentParam::Type(ty) => ty.rewrite(context, shape),
187 SegmentParam::Binding(binding) => {
188 let mut result = match context.config.type_punctuation_density() {
189 TypeDensity::Wide => format!("{} = ", rewrite_ident(context, binding.ident)),
190 TypeDensity::Compressed => {
191 format!("{}=", rewrite_ident(context, binding.ident))
194 let budget = shape.width.checked_sub(result.len())?;
195 let rewrite = binding
197 .rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
198 result.push_str(&rewrite);
205 // Formats a path segment. There are some hacks involved to correctly determine
206 // the segment's associated span since it's not part of the AST.
208 // The span_lo is assumed to be greater than the end of any previous segment's
209 // parameters and lesser or equal than the start of current segment.
211 // span_hi is assumed equal to the end of the entire path.
213 // When the segment contains a positive number of parameters, we update span_lo
214 // so that invariants described above will hold for the next segment.
216 path_context: PathContext,
217 segment: &ast::PathSegment,
218 span_lo: &mut BytePos,
220 context: &RewriteContext,
222 ) -> Option<String> {
223 let mut result = String::with_capacity(128);
224 result.push_str(rewrite_ident(context, segment.ident));
226 let ident_len = result.len();
227 let shape = if context.use_block_indent() {
228 shape.offset_left(ident_len)?
230 shape.shrink_left(ident_len)?
233 if let Some(ref args) = segment.args {
235 ast::GenericArgs::AngleBracketed(ref data)
236 if !data.args.is_empty() || !data.bindings.is_empty() =>
238 let param_list = data
241 .map(SegmentParam::from_generic_arg)
242 .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x)))
243 .collect::<Vec<_>>();
245 let separator = if path_context == PathContext::Expr {
250 result.push_str(separator);
252 let generics_str = overflow::rewrite_with_angle_brackets(
255 ¶m_list.iter().map(|e| &*e).collect::<Vec<_>>(),
257 mk_sp(*span_lo, span_hi),
260 // Update position of last bracket.
263 .span_after(mk_sp(*span_lo, span_hi), "<");
265 result.push_str(&generics_str)
267 ast::GenericArgs::Parenthesized(ref data) => {
268 let output = match data.output {
269 Some(ref ty) => FunctionRetTy::Ty(ty.clone()),
270 None => FunctionRetTy::Default(codemap::DUMMY_SP),
272 result.push_str(&format_function_type(
273 data.inputs.iter().map(|x| &**x),
288 fn format_function_type<'a, I>(
290 output: &FunctionRetTy,
293 context: &RewriteContext,
297 I: ExactSizeIterator,
298 <I as Iterator>::Item: Deref,
299 <I::Item as Deref>::Target: Rewrite + Spanned + 'a,
301 // Code for handling variadics is somewhat duplicated for items, but they
302 // are different enough to need some serious refactoring to share code.
306 <T as Deref>::Target: Rewrite + Spanned,
312 let variadic_arg = if variadic {
313 let variadic_start = context.snippet_provider.span_before(span, "...");
314 Some(ArgumentKind::Variadic(variadic_start))
320 let budget = shape.width.checked_sub(2)?;
322 let offset = match context.config.indent_style() {
323 IndentStyle::Block => {
326 .block_indent(context.config.tab_spaces())
329 IndentStyle::Visual => shape.indent + 1,
331 let list_shape = Shape::legacy(budget, offset);
332 let list_lo = context.snippet_provider.span_after(span, "(");
333 let items = itemize_list(
334 context.snippet_provider,
335 inputs.map(ArgumentKind::Regular).chain(variadic_arg),
339 ArgumentKind::Regular(ref ty) => ty.span().lo(),
340 ArgumentKind::Variadic(start) => start,
343 ArgumentKind::Regular(ref ty) => ty.span().hi(),
344 ArgumentKind::Variadic(start) => start + BytePos(3),
347 ArgumentKind::Regular(ref ty) => ty.rewrite(context, list_shape),
348 ArgumentKind::Variadic(_) => Some("...".to_owned()),
355 let item_vec: Vec<_> = items.collect();
357 let tactic = definitive_tactic(
359 ListTactic::HorizontalVertical,
364 let fmt = ListFormatting {
367 trailing_separator: if !context.use_block_indent() || variadic {
368 SeparatorTactic::Never
370 context.config.trailing_comma()
372 separator_place: SeparatorPlace::Back,
374 ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
375 preserve_newline: true,
377 config: context.config,
380 let list_str = write_list(&item_vec, &fmt)?;
382 let ty_shape = match context.config.indent_style() {
384 IndentStyle::Block => shape.offset_left(4)?,
385 IndentStyle::Visual => shape.block_left(4)?,
387 let output = match *output {
388 FunctionRetTy::Ty(ref ty) => {
389 let type_str = ty.rewrite(context, ty_shape)?;
390 format!(" -> {}", type_str)
392 FunctionRetTy::Default(..) => String::new(),
395 let args = if (!list_str.contains('\n') || list_str.is_empty()) && !output.contains('\n')
396 || !context.use_block_indent()
398 format!("({})", list_str)
402 offset.to_string_with_newline(context.config),
404 shape.block().indent.to_string_with_newline(context.config),
407 if last_line_width(&args) + first_line_width(&output) <= shape.width {
408 Some(format!("{}{}", args, output))
413 offset.to_string(context.config),
419 fn type_bound_colon(context: &RewriteContext) -> &'static str {
421 context.config.space_before_colon(),
422 context.config.space_after_colon(),
426 impl Rewrite for ast::WherePredicate {
427 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
428 // FIXME: dead spans?
429 let result = match *self {
430 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate {
431 ref bound_generic_params,
436 let type_str = bounded_ty.rewrite(context, shape)?;
437 let colon = type_bound_colon(context).trim_right();
438 let lhs = if let Some(lifetime_str) =
439 rewrite_lifetime_param(context, shape, bound_generic_params)
441 format!("for<{}> {}{}", lifetime_str, type_str, colon)
443 format!("{}{}", type_str, colon)
446 rewrite_assign_rhs(context, lhs, bounds, shape)?
448 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate {
452 }) => rewrite_bounded_lifetime(lifetime, bounds, context, shape)?,
453 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate {
458 let lhs_ty_str = lhs_ty.rewrite(context, shape).map(|lhs| lhs + " =")?;
459 rewrite_assign_rhs(context, lhs_ty_str, &**rhs_ty, shape)?
467 impl Rewrite for ast::GenericArg {
468 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
470 ast::GenericArg::Lifetime(ref lt) => lt.rewrite(context, shape),
471 ast::GenericArg::Type(ref ty) => ty.rewrite(context, shape),
476 fn rewrite_bounded_lifetime(
478 bounds: &[ast::GenericBound],
479 context: &RewriteContext,
481 ) -> Option<String> {
482 let result = lt.rewrite(context, shape)?;
484 if bounds.is_empty() {
487 let colon = type_bound_colon(context);
488 let overhead = last_line_width(&result) + colon.len();
489 let result = format!(
493 join_bounds(context, shape.sub_width(overhead)?, bounds, true)?
499 impl Rewrite for ast::Lifetime {
500 fn rewrite(&self, context: &RewriteContext, _: Shape) -> Option<String> {
501 Some(rewrite_ident(context, self.ident).to_owned())
505 impl Rewrite for ast::GenericBound {
506 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
508 ast::GenericBound::Trait(ref poly_trait_ref, trait_bound_modifier) => {
509 match trait_bound_modifier {
510 ast::TraitBoundModifier::None => poly_trait_ref.rewrite(context, shape),
511 ast::TraitBoundModifier::Maybe => {
512 let rw = poly_trait_ref.rewrite(context, shape.offset_left(1)?)?;
513 Some(format!("?{}", rw))
517 ast::GenericBound::Outlives(ref lifetime) => lifetime.rewrite(context, shape),
522 impl Rewrite for ast::GenericBounds {
523 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
524 join_bounds(context, shape, self, true)
528 impl Rewrite for ast::GenericParam {
529 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
530 let mut result = String::with_capacity(128);
531 // FIXME: If there are more than one attributes, this will force multiline.
532 match self.attrs.rewrite(context, shape) {
533 Some(ref rw) if !rw.is_empty() => result.push_str(&format!("{} ", rw)),
536 result.push_str(rewrite_ident(context, self.ident));
537 if !self.bounds.is_empty() {
538 result.push_str(type_bound_colon(context));
539 result.push_str(&self.bounds.rewrite(context, shape)?)
541 if let ast::GenericParamKind::Type {
542 default: Some(ref def),
545 let eq_str = match context.config.type_punctuation_density() {
546 TypeDensity::Compressed => "=",
547 TypeDensity::Wide => " = ",
549 result.push_str(eq_str);
550 let budget = shape.width.checked_sub(result.len())?;
552 def.rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
553 result.push_str(&rewrite);
560 impl Rewrite for ast::PolyTraitRef {
561 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
562 if let Some(lifetime_str) =
563 rewrite_lifetime_param(context, shape, &self.bound_generic_params)
565 // 6 is "for<> ".len()
566 let extra_offset = lifetime_str.len() + 6;
569 .rewrite(context, shape.offset_left(extra_offset)?)?;
571 Some(format!("for<{}> {}", lifetime_str, path_str))
573 self.trait_ref.rewrite(context, shape)
578 impl Rewrite for ast::TraitRef {
579 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
580 rewrite_path(context, PathContext::Type, None, &self.path, shape)
584 impl Rewrite for ast::Ty {
585 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
587 ast::TyKind::TraitObject(ref bounds, tobj_syntax) => {
588 // we have to consider 'dyn' keyword is used or not!!!
589 let is_dyn = tobj_syntax == ast::TraitObjectSyntax::Dyn;
590 // 4 is length of 'dyn '
591 let shape = if is_dyn { shape.offset_left(4)? } else { shape };
592 let res = bounds.rewrite(context, shape)?;
594 Some(format!("dyn {}", res))
599 ast::TyKind::Ptr(ref mt) => {
600 let prefix = match mt.mutbl {
601 Mutability::Mutable => "*mut ",
602 Mutability::Immutable => "*const ",
605 rewrite_unary_prefix(context, prefix, &*mt.ty, shape)
607 ast::TyKind::Rptr(ref lifetime, ref mt) => {
608 let mut_str = format_mutability(mt.mutbl);
609 let mut_len = mut_str.len();
610 Some(match *lifetime {
611 Some(ref lifetime) => {
612 let lt_budget = shape.width.checked_sub(2 + mut_len)?;
613 let lt_str = lifetime.rewrite(
615 Shape::legacy(lt_budget, shape.indent + 2 + mut_len),
617 let lt_len = lt_str.len();
618 let budget = shape.width.checked_sub(2 + mut_len + lt_len)?;
625 Shape::legacy(budget, shape.indent + 2 + mut_len + lt_len)
630 let budget = shape.width.checked_sub(1 + mut_len)?;
636 Shape::legacy(budget, shape.indent + 1 + mut_len)
642 // FIXME: we drop any comments here, even though it's a silly place to put
644 ast::TyKind::Paren(ref ty) => {
645 let budget = shape.width.checked_sub(2)?;
646 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
647 .map(|ty_str| format!("({})", ty_str))
649 ast::TyKind::Slice(ref ty) => {
650 let budget = shape.width.checked_sub(4)?;
651 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
652 .map(|ty_str| format!("[{}]", ty_str))
654 ast::TyKind::Tup(ref items) => rewrite_tuple(
656 &::utils::ptr_vec_to_ref_vec(items),
660 ast::TyKind::Path(ref q_self, ref path) => {
661 rewrite_path(context, PathContext::Type, q_self.as_ref(), path, shape)
663 ast::TyKind::Array(ref ty, ref repeats) => rewrite_pair(
666 PairParts::new("[", "; ", "]"),
669 SeparatorPlace::Back,
671 ast::TyKind::Infer => {
672 if shape.width >= 1 {
678 ast::TyKind::BareFn(ref bare_fn) => rewrite_bare_fn(bare_fn, self.span, context, shape),
679 ast::TyKind::Never => Some(String::from("!")),
680 ast::TyKind::Mac(ref mac) => {
681 rewrite_macro(mac, None, context, shape, MacroPosition::Expression)
683 ast::TyKind::ImplicitSelf => Some(String::from("")),
684 ast::TyKind::ImplTrait(_, ref it) => it
685 .rewrite(context, shape)
686 .map(|it_str| format!("impl {}", it_str)),
687 ast::TyKind::Err | ast::TyKind::Typeof(..) => unreachable!(),
693 bare_fn: &ast::BareFnTy,
695 context: &RewriteContext,
697 ) -> Option<String> {
698 let mut result = String::with_capacity(128);
700 if let Some(ref lifetime_str) = rewrite_lifetime_param(context, shape, &bare_fn.generic_params)
702 result.push_str("for<");
703 // 6 = "for<> ".len(), 4 = "for<".
704 // This doesn't work out so nicely for multiline situation with lots of
705 // rightward drift. If that is a problem, we could use the list stuff.
706 result.push_str(lifetime_str);
707 result.push_str("> ");
710 result.push_str(::utils::format_unsafety(bare_fn.unsafety));
712 result.push_str(&format_abi(
714 context.config.force_explicit_abi(),
718 result.push_str("fn");
720 let func_ty_shape = shape.offset_left(result.len())?;
722 let rewrite = format_function_type(
723 bare_fn.decl.inputs.iter(),
724 &bare_fn.decl.output,
725 bare_fn.decl.variadic,
731 result.push_str(&rewrite);
736 fn is_generic_bounds_in_order(generic_bounds: &[ast::GenericBound]) -> bool {
737 let is_trait = |b: &ast::GenericBound| match b {
738 ast::GenericBound::Outlives(..) => false,
739 ast::GenericBound::Trait(..) => true,
741 let is_lifetime = |b: &ast::GenericBound| !is_trait(b);
742 let last_trait_index = generic_bounds.iter().rposition(is_trait);
743 let first_lifetime_index = generic_bounds.iter().position(is_lifetime);
744 match (last_trait_index, first_lifetime_index) {
745 (Some(last_trait_index), Some(first_lifetime_index)) => {
746 last_trait_index < first_lifetime_index
753 context: &RewriteContext,
755 items: &[ast::GenericBound],
757 ) -> Option<String> {
758 // Try to join types in a single line
759 let joiner = match context.config.type_punctuation_density() {
760 TypeDensity::Compressed => "+",
761 TypeDensity::Wide => " + ",
763 let type_strs = items
765 .map(|item| item.rewrite(context, shape))
766 .collect::<Option<Vec<_>>>()?;
767 let result = type_strs.join(joiner);
768 if items.len() <= 1 || (!result.contains('\n') && result.len() <= shape.width) {
772 // We need to use multiple lines.
773 let (type_strs, offset) = if need_indent {
774 // Rewrite with additional indentation.
775 let nested_shape = shape.block_indent(context.config.tab_spaces());
776 let type_strs = items
778 .map(|item| item.rewrite(context, nested_shape))
779 .collect::<Option<Vec<_>>>()?;
780 (type_strs, nested_shape.indent)
782 (type_strs, shape.indent)
785 let is_bound_extendable = |s: &str, b: &ast::GenericBound| match b {
786 ast::GenericBound::Outlives(..) => true,
787 ast::GenericBound::Trait(..) => last_line_extendable(s),
789 let mut result = String::with_capacity(128);
790 result.push_str(&type_strs[0]);
791 let mut can_be_put_on_the_same_line = is_bound_extendable(&result, &items[0]);
792 let generic_bounds_in_order = is_generic_bounds_in_order(items);
793 for (bound, bound_str) in items[1..].iter().zip(type_strs[1..].iter()) {
794 if generic_bounds_in_order && can_be_put_on_the_same_line {
795 result.push_str(joiner);
797 result.push_str(&offset.to_string_with_newline(context.config));
798 result.push_str("+ ");
800 result.push_str(bound_str);
801 can_be_put_on_the_same_line = is_bound_extendable(bound_str, bound);
807 pub fn can_be_overflowed_type(context: &RewriteContext, ty: &ast::Ty, len: usize) -> bool {
809 ast::TyKind::Tup(..) => context.use_block_indent() && len == 1,
810 ast::TyKind::Rptr(_, ref mutty) | ast::TyKind::Ptr(ref mutty) => {
811 can_be_overflowed_type(context, &*mutty.ty, len)
817 /// Returns `None` if there is no `LifetimeDef` in the given generic parameters.
818 fn rewrite_lifetime_param(
819 context: &RewriteContext,
821 generic_params: &[ast::GenericParam],
822 ) -> Option<String> {
823 let result = generic_params
825 .filter(|p| match p.kind {
826 ast::GenericParamKind::Lifetime => true,
828 }).map(|lt| lt.rewrite(context, shape))
829 .collect::<Option<Vec<_>>>()?
831 if result.is_empty() {