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.
12 use std::iter::ExactSizeIterator;
14 use syntax::ast::{self, Mutability, FunctionRetTy};
15 use syntax::print::pprust;
16 use syntax::codemap::{self, Span, BytePos};
19 use {Indent, Spanned};
20 use codemap::SpanUtils;
21 use lists::{format_item_list, itemize_list, format_fn_args};
22 use rewrite::{Rewrite, RewriteContext};
23 use utils::{extra_offset, format_mutability, wrap_str};
24 use expr::{rewrite_unary_prefix, rewrite_pair, rewrite_tuple};
25 use config::TypeDensity;
27 // Does not wrap on simple segments.
28 pub fn rewrite_path(context: &RewriteContext,
30 qself: Option<&ast::QSelf>,
35 let skip_count = qself.map_or(0, |x| x.position);
37 let mut result = if path.global && qself.is_none() {
43 let mut span_lo = path.span.lo;
45 if let Some(ref qself) = qself {
47 let fmt_ty = try_opt!(qself.ty.rewrite(context, width, offset));
48 result.push_str(&fmt_ty);
51 result.push_str(" as ");
53 result.push_str("::");
56 let extra_offset = extra_offset(&result, offset);
58 let budget = try_opt!(width.checked_sub(extra_offset + 3));
60 result = try_opt!(rewrite_path_segments(false,
62 path.segments.iter().take(skip_count),
67 offset + extra_offset));
70 result.push_str(">::");
71 span_lo = qself.ty.span.hi + BytePos(1);
74 let extra_offset = extra_offset(&result, offset);
75 let budget = try_opt!(width.checked_sub(extra_offset));
76 rewrite_path_segments(expr_context,
78 path.segments.iter().skip(skip_count),
83 offset + extra_offset)
86 fn rewrite_path_segments<'a, I>(expr_context: bool,
91 context: &RewriteContext,
95 where I: Iterator<Item = &'a ast::PathSegment>
103 buffer.push_str("::");
106 let extra_offset = extra_offset(&buffer, offset);
107 let remaining_width = try_opt!(width.checked_sub(extra_offset));
108 let new_offset = offset + extra_offset;
109 let segment_string = try_opt!(rewrite_segment(expr_context,
117 buffer.push_str(&segment_string);
124 enum SegmentParam<'a> {
125 LifeTime(&'a ast::Lifetime),
127 Binding(&'a ast::TypeBinding),
130 impl<'a> SegmentParam<'a> {
131 fn get_span(&self) -> Span {
133 SegmentParam::LifeTime(ref lt) => lt.span,
134 SegmentParam::Type(ref ty) => ty.span,
135 SegmentParam::Binding(ref binding) => binding.span,
140 impl<'a> Rewrite for SegmentParam<'a> {
141 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
143 SegmentParam::LifeTime(ref lt) => lt.rewrite(context, width, offset),
144 SegmentParam::Type(ref ty) => ty.rewrite(context, width, offset),
145 SegmentParam::Binding(ref binding) => {
146 let mut result = format!("{} = ", binding.ident);
147 let budget = try_opt!(width.checked_sub(result.len()));
148 let rewrite = try_opt!(binding.ty.rewrite(context, budget, offset + result.len()));
149 result.push_str(&rewrite);
156 // Formats a path segment. There are some hacks involved to correctly determine
157 // the segment's associated span since it's not part of the AST.
159 // The span_lo is assumed to be greater than the end of any previous segment's
160 // parameters and lesser or equal than the start of current segment.
162 // span_hi is assumed equal to the end of the entire path.
164 // When the segment contains a positive number of parameters, we update span_lo
165 // so that invariants described above will hold for the next segment.
166 fn rewrite_segment(expr_context: bool,
167 segment: &ast::PathSegment,
168 span_lo: &mut BytePos,
170 context: &RewriteContext,
174 let ident_len = segment.identifier.to_string().len();
175 let width = try_opt!(width.checked_sub(ident_len));
176 let offset = offset + ident_len;
178 let params = match segment.parameters {
179 ast::PathParameters::AngleBracketed(ref data) if !data.lifetimes.is_empty() ||
180 !data.types.is_empty() ||
181 !data.bindings.is_empty() => {
182 let param_list = data.lifetimes
184 .map(SegmentParam::LifeTime)
185 .chain(data.types.iter().map(|x| SegmentParam::Type(&*x)))
186 .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x)))
187 .collect::<Vec<_>>();
189 let next_span_lo = param_list.last().unwrap().get_span().hi + BytePos(1);
190 let list_lo = context.codemap.span_after(codemap::mk_sp(*span_lo, span_hi), "<");
191 let separator = if expr_context { "::" } else { "" };
194 let extra_offset = 1 + separator.len();
196 let list_width = try_opt!(width.checked_sub(extra_offset + 1));
198 let items = itemize_list(context.codemap,
199 param_list.into_iter(),
201 |param| param.get_span().lo,
202 |param| param.get_span().hi,
203 |seg| seg.rewrite(context, list_width, offset + extra_offset),
206 let list_str = try_opt!(format_item_list(items,
208 offset + extra_offset,
211 // Update position of last bracket.
212 *span_lo = next_span_lo;
214 format!("{}<{}>", separator, list_str)
216 ast::PathParameters::Parenthesized(ref data) => {
217 let output = match data.output {
218 Some(ref ty) => FunctionRetTy::Ty(ty.clone()),
219 None => FunctionRetTy::Default(codemap::DUMMY_SP),
221 try_opt!(format_function_type(data.inputs.iter().map(|x| &**x),
232 Some(format!("{}{}", segment.identifier, params))
235 fn format_function_type<'a, I>(inputs: I,
236 output: &FunctionRetTy,
239 context: &RewriteContext,
243 where I: ExactSizeIterator,
244 <I as Iterator>::Item: Deref,
245 <I::Item as Deref>::Target: Rewrite + Spanned + 'a
247 // Code for handling variadics is somewhat duplicated for items, but they
248 // are different enough to need some serious refactoring to share code.
251 <T as Deref>::Target: Rewrite + Spanned
257 let variadic_arg = if variadic {
258 let variadic_start = context.codemap.span_before(span, "...");
259 Some(ArgumentKind::Variadic(variadic_start))
265 let budget = try_opt!(width.checked_sub(2));
267 let offset = offset + 1;
268 let list_lo = context.codemap.span_after(span, "(");
269 let items = itemize_list(context.codemap,
270 // FIXME Would be nice to avoid this allocation,
271 // but I couldn't get the types to work out.
272 inputs.map(|i| ArgumentKind::Regular(Box::new(i)))
273 .chain(variadic_arg),
277 ArgumentKind::Regular(ref ty) => ty.span().lo,
278 ArgumentKind::Variadic(start) => start,
283 ArgumentKind::Regular(ref ty) => ty.span().hi,
284 ArgumentKind::Variadic(start) => start + BytePos(3),
289 ArgumentKind::Regular(ref ty) => ty.rewrite(context, budget, offset),
290 ArgumentKind::Variadic(_) => Some("...".to_owned()),
296 let list_str = try_opt!(format_fn_args(items, budget, offset, context.config));
298 let output = match *output {
299 FunctionRetTy::Ty(ref ty) => {
300 let budget = try_opt!(width.checked_sub(4));
301 let type_str = try_opt!(ty.rewrite(context, budget, offset + 4));
302 format!(" -> {}", type_str)
304 FunctionRetTy::None(..) => " -> !".to_owned(),
305 FunctionRetTy::Default(..) => String::new(),
308 let infix = if output.len() > 0 && output.len() + list_str.len() > width {
309 format!("\n{}", (offset - 1).to_string(context.config))
314 Some(format!("({}){}{}", list_str, infix, output))
317 impl Rewrite for ast::WherePredicate {
318 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
320 let result = match *self {
321 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate { ref bound_lifetimes,
325 let type_str = try_opt!(bounded_ty.rewrite(context, width, offset));
327 if !bound_lifetimes.is_empty() {
328 let lifetime_str = try_opt!(bound_lifetimes.iter()
334 .collect::<Option<Vec<_>>>())
336 // 8 = "for<> : ".len()
337 let used_width = lifetime_str.len() + type_str.len() + 8;
338 let budget = try_opt!(width.checked_sub(used_width));
339 let bounds_str = try_opt!(bounds.iter()
341 ty_bound.rewrite(context,
345 .collect::<Option<Vec<_>>>())
348 format!("for<{}> {}: {}", lifetime_str, type_str, bounds_str)
351 let used_width = type_str.len() + 2;
352 let budget = try_opt!(width.checked_sub(used_width));
353 let bounds_str = try_opt!(bounds.iter()
355 ty_bound.rewrite(context,
359 .collect::<Option<Vec<_>>>())
362 format!("{}: {}", type_str, bounds_str)
365 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate { ref lifetime,
368 try_opt!(rewrite_bounded_lifetime(lifetime, bounds.iter(), context, width, offset))
370 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate { ref path, ref ty, .. }) => {
371 let ty_str = try_opt!(ty.rewrite(context, width, offset));
373 let used_width = 3 + ty_str.len();
374 let budget = try_opt!(width.checked_sub(used_width));
376 try_opt!(rewrite_path(context, false, None, path, budget, offset + used_width));
377 format!("{} = {}", path_str, ty_str)
381 wrap_str(result, context.config.max_width, width, offset)
385 impl Rewrite for ast::LifetimeDef {
386 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
387 rewrite_bounded_lifetime(&self.lifetime, self.bounds.iter(), context, width, offset)
391 fn rewrite_bounded_lifetime<'b, I>(lt: &ast::Lifetime,
393 context: &RewriteContext,
397 where I: ExactSizeIterator<Item = &'b ast::Lifetime>
399 let result = try_opt!(lt.rewrite(context, width, offset));
401 if bounds.len() == 0 {
404 let appendix: Vec<_> = try_opt!(bounds.into_iter()
405 .map(|b| b.rewrite(context, width, offset))
407 let result = format!("{}: {}", result, appendix.join(" + "));
408 wrap_str(result, context.config.max_width, width, offset)
412 impl Rewrite for ast::TyParamBound {
413 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
415 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::None) => {
416 tref.rewrite(context, width, offset)
418 ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::Maybe) => {
419 let budget = try_opt!(width.checked_sub(1));
420 Some(format!("?{}", try_opt!(tref.rewrite(context, budget, offset + 1))))
422 ast::TyParamBound::RegionTyParamBound(ref l) => l.rewrite(context, width, offset),
427 impl Rewrite for ast::Lifetime {
428 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
429 wrap_str(pprust::lifetime_to_string(self),
430 context.config.max_width,
436 impl Rewrite for ast::TyParamBounds {
437 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
438 let strs: Vec<_> = try_opt!(self.iter()
439 .map(|b| b.rewrite(context, width, offset))
441 wrap_str(strs.join(" + "), context.config.max_width, width, offset)
445 impl Rewrite for ast::TyParam {
446 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
447 let mut result = String::with_capacity(128);
448 result.push_str(&self.ident.to_string());
449 if !self.bounds.is_empty() {
450 result.push_str(": ");
452 let bounds = try_opt!(self.bounds
454 .map(|ty_bound| ty_bound.rewrite(context, width, offset))
455 .collect::<Option<Vec<_>>>())
458 result.push_str(&bounds);
460 if let Some(ref def) = self.default {
462 let eq_str = match context.config.type_punctuation_density {
463 TypeDensity::Compressed => "=",
464 TypeDensity::Wide => " = ",
466 result.push_str(eq_str);
467 let budget = try_opt!(width.checked_sub(result.len()));
468 let rewrite = try_opt!(def.rewrite(context, budget, offset + result.len()));
469 result.push_str(&rewrite);
472 wrap_str(result, context.config.max_width, width, offset)
476 impl Rewrite for ast::PolyTraitRef {
477 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
478 if !self.bound_lifetimes.is_empty() {
479 let lifetime_str = try_opt!(self.bound_lifetimes
481 .map(|lt| lt.rewrite(context, width, offset))
482 .collect::<Option<Vec<_>>>())
484 // 6 is "for<> ".len()
485 let extra_offset = lifetime_str.len() + 6;
486 let max_path_width = try_opt!(width.checked_sub(extra_offset));
487 let path_str = try_opt!(self.trait_ref
488 .rewrite(context, max_path_width, offset + extra_offset));
490 Some(format!("for<{}> {}", lifetime_str, path_str))
492 self.trait_ref.rewrite(context, width, offset)
497 impl Rewrite for ast::TraitRef {
498 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
499 rewrite_path(context, false, None, &self.path, width, offset)
503 impl Rewrite for ast::Ty {
504 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
506 ast::TyKind::ObjectSum(ref ty, ref bounds) => {
507 let ty_str = try_opt!(ty.rewrite(context, width, offset));
508 let overhead = ty_str.len() + 3;
509 let plus_str = match context.config.type_punctuation_density {
510 TypeDensity::Compressed => "+",
511 TypeDensity::Wide => " + ",
513 Some(format!("{}{}{}",
516 try_opt!(bounds.rewrite(context,
517 try_opt!(width.checked_sub(overhead)),
518 offset + overhead))))
520 ast::TyKind::Ptr(ref mt) => {
521 let prefix = match mt.mutbl {
522 Mutability::Mutable => "*mut ",
523 Mutability::Immutable => "*const ",
526 rewrite_unary_prefix(context, prefix, &*mt.ty, width, offset)
528 ast::TyKind::Rptr(ref lifetime, ref mt) => {
529 let mut_str = format_mutability(mt.mutbl);
530 let mut_len = mut_str.len();
531 Some(match *lifetime {
532 Some(ref lifetime) => {
533 let lt_budget = try_opt!(width.checked_sub(2 + mut_len));
535 try_opt!(lifetime.rewrite(context, lt_budget, offset + 2 + mut_len));
536 let lt_len = lt_str.len();
537 let budget = try_opt!(width.checked_sub(2 + mut_len + lt_len));
542 .rewrite(context, budget, offset + 2 + mut_len + lt_len)))
545 let budget = try_opt!(width.checked_sub(1 + mut_len));
548 try_opt!(mt.ty.rewrite(context, budget, offset + 1 + mut_len)))
552 // FIXME: we drop any comments here, even though it's a silly place to put
554 ast::TyKind::Paren(ref ty) => {
555 let budget = try_opt!(width.checked_sub(2));
556 ty.rewrite(context, budget, offset + 1).map(|ty_str| format!("({})", ty_str))
558 ast::TyKind::Vec(ref ty) => {
559 let budget = try_opt!(width.checked_sub(2));
560 ty.rewrite(context, budget, offset + 1).map(|ty_str| format!("[{}]", ty_str))
562 ast::TyKind::Tup(ref items) => {
563 rewrite_tuple(context,
564 items.iter().map(|x| &**x),
569 ast::TyKind::PolyTraitRef(ref trait_ref) => trait_ref.rewrite(context, width, offset),
570 ast::TyKind::Path(ref q_self, ref path) => {
571 rewrite_path(context, false, q_self.as_ref(), path, width, offset)
573 ast::TyKind::FixedLengthVec(ref ty, ref repeats) => {
574 rewrite_pair(&**ty, &**repeats, "[", "; ", "]", context, width, offset)
576 ast::TyKind::Infer => {
583 ast::TyKind::BareFn(ref bare_fn) => {
584 rewrite_bare_fn(bare_fn, self.span, context, width, offset)
586 ast::TyKind::Mac(..) |
587 ast::TyKind::Typeof(..) => unreachable!(),
588 ast::TyKind::ImplicitSelf => Some(String::from("")),
593 fn rewrite_bare_fn(bare_fn: &ast::BareFnTy,
595 context: &RewriteContext,
599 let mut result = String::with_capacity(128);
601 if !bare_fn.lifetimes.is_empty() {
602 result.push_str("for<");
603 // 6 = "for<> ".len(), 4 = "for<".
604 // This doesn't work out so nicely for mutliline situation with lots of
605 // rightward drift. If that is a problem, we could use the list stuff.
606 result.push_str(&try_opt!(bare_fn.lifetimes
608 .map(|l| l.rewrite(context, try_opt!(width.checked_sub(6)), offset + 4))
609 .collect::<Option<Vec<_>>>())
611 result.push_str("> ");
614 result.push_str(&::utils::format_unsafety(bare_fn.unsafety));
616 if bare_fn.abi != abi::Abi::Rust {
617 result.push_str(&::utils::format_abi(bare_fn.abi, context.config.force_explicit_abi));
620 result.push_str("fn");
622 let budget = try_opt!(width.checked_sub(result.len()));
623 let indent = offset + result.len();
625 let rewrite = try_opt!(format_function_type(bare_fn.decl.inputs.iter(),
626 &bare_fn.decl.output,
627 bare_fn.decl.variadic,
633 result.push_str(&rewrite);