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;
14 use syntax::ast::{self, FunctionRetTy, Mutability};
15 use syntax::codemap::{self, BytePos, Span};
16 use syntax::print::pprust;
17 use syntax::symbol::keywords;
20 use codemap::SpanUtils;
21 use config::{IndentStyle, TypeDensity};
22 use expr::{rewrite_pair, rewrite_tuple, rewrite_unary_prefix, wrap_args_with_parens, PairParts};
23 use items::{format_generics_item_list, generics_shape_from_config};
24 use lists::{definitive_tactic, itemize_list, write_list, ListFormatting, ListTactic, Separator,
25 SeparatorPlace, SeparatorTactic};
26 use rewrite::{Rewrite, RewriteContext};
28 use utils::{colon_spaces, extra_offset, first_line_width, format_abi, format_mutability,
29 last_line_width, mk_sp};
31 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
32 pub enum PathContext {
38 // Does not wrap on simple segments.
40 context: &RewriteContext,
41 path_context: PathContext,
42 qself: Option<&ast::QSelf>,
46 let skip_count = qself.map_or(0, |x| x.position);
48 let mut result = if path.is_global() && qself.is_none() && path_context != PathContext::Import {
54 let mut span_lo = path.span.lo();
56 if let Some(qself) = qself {
58 if context.config.spaces_within_parens_and_brackets() {
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 if context.config.spaces_within_parens_and_brackets() {
89 result.push_str(">::");
90 span_lo = qself.ty.span.hi() + BytePos(1);
93 rewrite_path_segments(
96 path.segments.iter().skip(skip_count),
104 fn rewrite_path_segments<'a, I>(
105 path_context: PathContext,
108 mut span_lo: BytePos,
110 context: &RewriteContext,
114 I: Iterator<Item = &'a ast::PathSegment>,
116 let mut first = true;
117 let shape = shape.visual_indent(0);
119 for segment in iter {
120 // Indicates a global path, shouldn't be rendered.
121 if segment.identifier.name == keywords::CrateRoot.name() {
127 buffer.push_str("::");
130 let extra_offset = extra_offset(&buffer, shape);
131 let new_shape = shape.shrink_left(extra_offset)?;
132 let segment_string = rewrite_segment(
141 buffer.push_str(&segment_string);
148 enum SegmentParam<'a> {
149 LifeTime(&'a ast::Lifetime),
151 Binding(&'a ast::TypeBinding),
154 impl<'a> SegmentParam<'a> {
155 fn get_span(&self) -> Span {
157 SegmentParam::LifeTime(lt) => lt.span,
158 SegmentParam::Type(ty) => ty.span,
159 SegmentParam::Binding(binding) => binding.span,
164 impl<'a> Rewrite for SegmentParam<'a> {
165 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
167 SegmentParam::LifeTime(lt) => lt.rewrite(context, shape),
168 SegmentParam::Type(ty) => ty.rewrite(context, shape),
169 SegmentParam::Binding(binding) => {
170 let mut result = match context.config.type_punctuation_density() {
171 TypeDensity::Wide => format!("{} = ", binding.ident),
172 TypeDensity::Compressed => format!("{}=", binding.ident),
174 let budget = shape.width.checked_sub(result.len())?;
175 let rewrite = binding
177 .rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
178 result.push_str(&rewrite);
185 // Formats a path segment. There are some hacks involved to correctly determine
186 // the segment's associated span since it's not part of the AST.
188 // The span_lo is assumed to be greater than the end of any previous segment's
189 // parameters and lesser or equal than the start of current segment.
191 // span_hi is assumed equal to the end of the entire path.
193 // When the segment contains a positive number of parameters, we update span_lo
194 // so that invariants described above will hold for the next segment.
196 path_context: PathContext,
197 segment: &ast::PathSegment,
198 span_lo: &mut BytePos,
200 context: &RewriteContext,
202 ) -> Option<String> {
203 let ident_len = segment.identifier.to_string().len();
204 let shape = shape.shrink_left(ident_len)?;
206 let params = if let Some(ref params) = segment.parameters {
208 ast::PathParameters::AngleBracketed(ref data)
209 if !data.lifetimes.is_empty() || !data.types.is_empty()
210 || !data.bindings.is_empty() =>
212 let param_list = data.lifetimes
214 .map(SegmentParam::LifeTime)
215 .chain(data.types.iter().map(|x| SegmentParam::Type(&*x)))
216 .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x)))
217 .collect::<Vec<_>>();
219 let next_span_lo = param_list.last().unwrap().get_span().hi() + BytePos(1);
220 let list_lo = context.codemap.span_after(mk_sp(*span_lo, span_hi), "<");
221 let separator = if path_context == PathContext::Expr {
228 generics_shape_from_config(context.config, shape, separator.len())?;
229 let one_line_width = shape.width.checked_sub(separator.len() + 2)?;
230 let items = itemize_list(
232 param_list.into_iter(),
235 |param| param.get_span().lo(),
236 |param| param.get_span().hi(),
237 |seg| seg.rewrite(context, generics_shape),
243 format_generics_item_list(context, items, generics_shape, one_line_width)?;
245 // Update position of last bracket.
246 *span_lo = next_span_lo;
248 format!("{}{}", separator, generics_str)
250 ast::PathParameters::Parenthesized(ref data) => {
251 let output = match data.output {
252 Some(ref ty) => FunctionRetTy::Ty(ty.clone()),
253 None => FunctionRetTy::Default(codemap::DUMMY_SP),
255 format_function_type(
256 data.inputs.iter().map(|x| &**x),
270 Some(format!("{}{}", segment.identifier, params))
273 fn format_function_type<'a, I>(
275 output: &FunctionRetTy,
278 context: &RewriteContext,
282 I: ExactSizeIterator,
283 <I as Iterator>::Item: Deref,
284 <I::Item as Deref>::Target: Rewrite + Spanned + 'a,
286 // Code for handling variadics is somewhat duplicated for items, but they
287 // are different enough to need some serious refactoring to share code.
291 <T as Deref>::Target: Rewrite + Spanned,
297 let variadic_arg = if variadic {
298 let variadic_start = context.codemap.span_before(span, "...");
299 Some(ArgumentKind::Variadic(variadic_start))
305 let budget = shape.width.checked_sub(2)?;
307 let offset = match context.config.indent_style() {
308 IndentStyle::Block => {
311 .block_indent(context.config.tab_spaces())
314 IndentStyle::Visual => shape.indent + 1,
316 let list_shape = Shape::legacy(budget, offset);
317 let list_lo = context.codemap.span_after(span, "(");
318 let items = itemize_list(
320 // FIXME Would be nice to avoid this allocation,
321 // but I couldn't get the types to work out.
323 .map(|i| ArgumentKind::Regular(Box::new(i)))
324 .chain(variadic_arg),
328 ArgumentKind::Regular(ref ty) => ty.span().lo(),
329 ArgumentKind::Variadic(start) => start,
332 ArgumentKind::Regular(ref ty) => ty.span().hi(),
333 ArgumentKind::Variadic(start) => start + BytePos(3),
336 ArgumentKind::Regular(ref ty) => ty.rewrite(context, list_shape),
337 ArgumentKind::Variadic(_) => Some("...".to_owned()),
344 let item_vec: Vec<_> = items.collect();
346 let tactic = definitive_tactic(
348 ListTactic::HorizontalVertical,
353 let fmt = ListFormatting {
356 trailing_separator: if !context.use_block_indent() || variadic {
357 SeparatorTactic::Never
359 context.config.trailing_comma()
361 separator_place: SeparatorPlace::Back,
363 ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
364 preserve_newline: true,
365 config: context.config,
368 let list_str = write_list(&item_vec, &fmt)?;
370 let ty_shape = match context.config.indent_style() {
372 IndentStyle::Block => shape.offset_left(4)?,
373 IndentStyle::Visual => shape.block_left(4)?,
375 let output = match *output {
376 FunctionRetTy::Ty(ref ty) => {
377 let type_str = ty.rewrite(context, ty_shape)?;
378 format!(" -> {}", type_str)
380 FunctionRetTy::Default(..) => String::new(),
383 let extendable = (!list_str.contains('\n') || list_str.is_empty()) && !output.contains('\n');
384 let args = wrap_args_with_parens(
388 shape.sub_width(first_line_width(&output))?,
389 Shape::indented(offset, context.config),
391 if last_line_width(&args) + first_line_width(&output) <= shape.width {
392 Some(format!("{}{}", args, output))
397 offset.to_string(context.config),
403 fn type_bound_colon(context: &RewriteContext) -> &'static str {
405 context.config.space_before_colon(),
406 context.config.space_after_colon(),
410 impl Rewrite for ast::WherePredicate {
411 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
413 let result = match *self {
414 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate {
420 let type_str = bounded_ty.rewrite(context, shape)?;
422 let colon = type_bound_colon(context);
424 if !bound_lifetimes.is_empty() {
425 let lifetime_str: String = bound_lifetimes
427 .map(|lt| lt.rewrite(context, shape))
428 .collect::<Option<Vec<_>>>()?
431 // 6 = "for<> ".len()
432 let used_width = lifetime_str.len() + type_str.len() + colon.len() + 6;
433 let ty_shape = shape.offset_left(used_width)?;
436 .map(|ty_bound| ty_bound.rewrite(context, ty_shape))
437 .collect::<Option<Vec<_>>>()?;
438 let bounds_str = join_bounds(context, ty_shape, &bounds);
440 if context.config.spaces_within_parens_and_brackets()
441 && !lifetime_str.is_empty()
445 lifetime_str, type_str, colon, bounds_str
448 format!("for<{}> {}{}{}", lifetime_str, type_str, colon, bounds_str)
451 let used_width = type_str.len() + colon.len();
452 let ty_shape = match context.config.indent_style() {
453 IndentStyle::Visual => shape.block_left(used_width)?,
454 IndentStyle::Block => shape,
458 .map(|ty_bound| ty_bound.rewrite(context, ty_shape))
459 .collect::<Option<Vec<_>>>()?;
460 let overhead = type_str.len() + colon.len();
461 let bounds_str = join_bounds(context, ty_shape.sub_width(overhead)?, &bounds);
463 format!("{}{}{}", type_str, colon, bounds_str)
466 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate {
470 }) => rewrite_bounded_lifetime(lifetime, bounds.iter(), context, shape)?,
471 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate {
476 let lhs_ty_str = lhs_ty.rewrite(context, shape)?;
478 let used_width = 3 + lhs_ty_str.len();
479 let budget = shape.width.checked_sub(used_width)?;
481 rhs_ty.rewrite(context, Shape::legacy(budget, shape.indent + used_width))?;
482 format!("{} = {}", lhs_ty_str, rhs_ty_str)
490 impl Rewrite for ast::LifetimeDef {
491 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
492 rewrite_bounded_lifetime(&self.lifetime, self.bounds.iter(), context, shape)
496 fn rewrite_bounded_lifetime<'b, I>(
499 context: &RewriteContext,
503 I: ExactSizeIterator<Item = &'b ast::Lifetime>,
505 let result = lt.rewrite(context, shape)?;
507 if bounds.len() == 0 {
510 let appendix = bounds
512 .map(|b| b.rewrite(context, shape))
513 .collect::<Option<Vec<_>>>()?;
514 let colon = type_bound_colon(context);
515 let overhead = last_line_width(&result) + colon.len();
516 let result = format!(
520 join_bounds(context, shape.sub_width(overhead)?, &appendix)
526 impl Rewrite for ast::TyParamBound {
527 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
529 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::None) => {
530 tref.rewrite(context, shape)
532 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::Maybe) => {
535 tref.rewrite(context, shape.offset_left(1)?)?
538 ast::TyParamBound::RegionTyParamBound(ref l) => l.rewrite(context, shape),
543 impl Rewrite for ast::Lifetime {
544 fn rewrite(&self, _: &RewriteContext, _: Shape) -> Option<String> {
545 Some(pprust::lifetime_to_string(self))
549 impl Rewrite for ast::TyParamBounds {
550 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
551 let strs = self.iter()
552 .map(|b| b.rewrite(context, shape))
553 .collect::<Option<Vec<_>>>()?;
554 Some(join_bounds(context, shape, &strs))
558 impl Rewrite for ast::TyParam {
559 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
560 let mut result = String::with_capacity(128);
561 // FIXME: If there are more than one attributes, this will force multiline.
562 match self.attrs.rewrite(context, shape) {
563 Some(ref rw) if !rw.is_empty() => result.push_str(&format!("{} ", rw)),
566 result.push_str(&self.ident.to_string());
567 if !self.bounds.is_empty() {
568 result.push_str(type_bound_colon(context));
569 let strs = self.bounds
571 .map(|ty_bound| ty_bound.rewrite(context, shape))
572 .collect::<Option<Vec<_>>>()?;
573 result.push_str(&join_bounds(context, shape, &strs));
575 if let Some(ref def) = self.default {
576 let eq_str = match context.config.type_punctuation_density() {
577 TypeDensity::Compressed => "=",
578 TypeDensity::Wide => " = ",
580 result.push_str(eq_str);
581 let budget = shape.width.checked_sub(result.len())?;
582 let rewrite = def.rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?;
583 result.push_str(&rewrite);
590 impl Rewrite for ast::PolyTraitRef {
591 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
592 if !self.bound_lifetimes.is_empty() {
593 let lifetime_str: String = self.bound_lifetimes
595 .map(|lt| lt.rewrite(context, shape))
596 .collect::<Option<Vec<_>>>()?
599 // 6 is "for<> ".len()
600 let extra_offset = lifetime_str.len() + 6;
601 let path_str = self.trait_ref
602 .rewrite(context, shape.offset_left(extra_offset)?)?;
605 if context.config.spaces_within_parens_and_brackets() && !lifetime_str.is_empty() {
606 format!("for< {} > {}", lifetime_str, path_str)
608 format!("for<{}> {}", lifetime_str, path_str)
612 self.trait_ref.rewrite(context, shape)
617 impl Rewrite for ast::TraitRef {
618 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
619 rewrite_path(context, PathContext::Type, None, &self.path, shape)
623 impl Rewrite for ast::Ty {
624 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
626 ast::TyKind::TraitObject(ref bounds, ..) => bounds.rewrite(context, shape),
627 ast::TyKind::Ptr(ref mt) => {
628 let prefix = match mt.mutbl {
629 Mutability::Mutable => "*mut ",
630 Mutability::Immutable => "*const ",
633 rewrite_unary_prefix(context, prefix, &*mt.ty, shape)
635 ast::TyKind::Rptr(ref lifetime, ref mt) => {
636 let mut_str = format_mutability(mt.mutbl);
637 let mut_len = mut_str.len();
638 Some(match *lifetime {
639 Some(ref lifetime) => {
640 let lt_budget = shape.width.checked_sub(2 + mut_len)?;
641 let lt_str = lifetime.rewrite(
643 Shape::legacy(lt_budget, shape.indent + 2 + mut_len),
645 let lt_len = lt_str.len();
646 let budget = shape.width.checked_sub(2 + mut_len + lt_len)?;
653 Shape::legacy(budget, shape.indent + 2 + mut_len + lt_len)
658 let budget = shape.width.checked_sub(1 + mut_len)?;
664 Shape::legacy(budget, shape.indent + 1 + mut_len)
670 // FIXME: we drop any comments here, even though it's a silly place to put
672 ast::TyKind::Paren(ref ty) => {
673 let budget = shape.width.checked_sub(2)?;
674 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
676 if context.config.spaces_within_parens_and_brackets() {
677 format!("( {} )", ty_str)
679 format!("({})", ty_str)
683 ast::TyKind::Slice(ref ty) => {
684 let budget = if context.config.spaces_within_parens_and_brackets() {
685 shape.width.checked_sub(4)?
687 shape.width.checked_sub(2)?
689 ty.rewrite(context, Shape::legacy(budget, shape.indent + 1))
691 if context.config.spaces_within_parens_and_brackets() {
692 format!("[ {} ]", ty_str)
694 format!("[{}]", ty_str)
698 ast::TyKind::Tup(ref items) => rewrite_tuple(
700 &::utils::ptr_vec_to_ref_vec(items),
704 ast::TyKind::Path(ref q_self, ref path) => {
705 rewrite_path(context, PathContext::Type, q_self.as_ref(), path, shape)
707 ast::TyKind::Array(ref ty, ref repeats) => {
708 let use_spaces = context.config.spaces_within_parens_and_brackets();
709 let lbr = if use_spaces { "[ " } else { "[" };
710 let rbr = if use_spaces { " ]" } else { "]" };
714 PairParts::new(lbr, "; ", rbr),
717 SeparatorPlace::Back,
720 ast::TyKind::Infer => {
721 if shape.width >= 1 {
727 ast::TyKind::BareFn(ref bare_fn) => rewrite_bare_fn(bare_fn, self.span, context, shape),
728 ast::TyKind::Never => Some(String::from("!")),
729 ast::TyKind::Mac(..) => None,
730 ast::TyKind::ImplicitSelf => Some(String::from("")),
731 ast::TyKind::ImplTrait(ref it) => it.rewrite(context, shape)
732 .map(|it_str| format!("impl {}", it_str)),
733 ast::TyKind::Err | ast::TyKind::Typeof(..) => unreachable!(),
739 bare_fn: &ast::BareFnTy,
741 context: &RewriteContext,
743 ) -> Option<String> {
744 let mut result = String::with_capacity(128);
746 if !bare_fn.lifetimes.is_empty() {
747 result.push_str("for<");
748 // 6 = "for<> ".len(), 4 = "for<".
749 // This doesn't work out so nicely for mutliline situation with lots of
750 // rightward drift. If that is a problem, we could use the list stuff.
751 result.push_str(&bare_fn
757 Shape::legacy(shape.width.checked_sub(6)?, shape.indent + 4),
760 .collect::<Option<Vec<_>>>()?
762 result.push_str("> ");
765 result.push_str(::utils::format_unsafety(bare_fn.unsafety));
767 result.push_str(&format_abi(
769 context.config.force_explicit_abi(),
773 result.push_str("fn");
775 let func_ty_shape = shape.offset_left(result.len())?;
777 let rewrite = format_function_type(
778 bare_fn.decl.inputs.iter(),
779 &bare_fn.decl.output,
780 bare_fn.decl.variadic,
786 result.push_str(&rewrite);
791 pub fn join_bounds(context: &RewriteContext, shape: Shape, type_strs: &[String]) -> String {
792 // Try to join types in a single line
793 let joiner = match context.config.type_punctuation_density() {
794 TypeDensity::Compressed => "+",
795 TypeDensity::Wide => " + ",
797 let result = type_strs.join(joiner);
798 if result.contains('\n') || result.len() > shape.width {
799 let joiner_indent = shape.indent.block_indent(context.config);
800 let joiner = format!("\n{}+ ", joiner_indent.to_string(context.config));
801 type_strs.join(&joiner)
807 pub fn can_be_overflowed_type(context: &RewriteContext, ty: &ast::Ty, len: usize) -> bool {
809 ast::TyKind::Path(..) | 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)