// Copyright 2015 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. use syntax::ast; use syntax::print::pprust; use syntax::codemap::{self, Span, BytePos, CodeMap}; use Indent; use lists::{itemize_list, write_list, ListFormatting}; use rewrite::{Rewrite, RewriteContext}; use utils::{extra_offset, span_after, format_mutability}; impl Rewrite for ast::Path { fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { rewrite_path(context, None, self, width, offset) } } // Does not wrap on simple segments. pub fn rewrite_path(context: &RewriteContext, qself: Option<&ast::QSelf>, path: &ast::Path, width: usize, offset: Indent) -> Option { let skip_count = qself.map(|x| x.position).unwrap_or(0); let mut result = if path.global { "::".to_owned() } else { String::new() }; let mut span_lo = path.span.lo; if let Some(ref qself) = qself { result.push('<'); result.push_str(&pprust::ty_to_string(&qself.ty)); if skip_count > 0 { result.push_str(" as "); let extra_offset = extra_offset(&result, offset); // 3 = ">::".len() let budget = try_opt!(width.checked_sub(extra_offset)) - 3; result = try_opt!(rewrite_path_segments(result, path.segments.iter().take(skip_count), span_lo, path.span.hi, context, budget, offset + extra_offset)); } result.push_str(">::"); span_lo = qself.ty.span.hi + BytePos(1); } let extra_offset = extra_offset(&result, offset); let budget = try_opt!(width.checked_sub(extra_offset)); rewrite_path_segments(result, path.segments.iter().skip(skip_count), span_lo, path.span.hi, context, budget, offset + extra_offset) } fn rewrite_path_segments<'a, I>(mut buffer: String, iter: I, mut span_lo: BytePos, span_hi: BytePos, context: &RewriteContext, width: usize, offset: Indent) -> Option where I: Iterator { let mut first = true; for segment in iter { if first { first = false; } else { buffer.push_str("::"); } let extra_offset = extra_offset(&buffer, offset); let remaining_width = try_opt!(width.checked_sub(extra_offset)); let new_offset = offset + extra_offset; let segment_string = try_opt!(rewrite_segment(segment, &mut span_lo, span_hi, context, remaining_width, new_offset)); buffer.push_str(&segment_string); } Some(buffer) } #[derive(Debug)] enum SegmentParam<'a> { LifeTime(&'a ast::Lifetime), Type(&'a ast::Ty), Binding(&'a ast::TypeBinding), } impl<'a> SegmentParam<'a> { fn get_span(&self) -> Span { match *self { SegmentParam::LifeTime(ref lt) => lt.span, SegmentParam::Type(ref ty) => ty.span, SegmentParam::Binding(ref binding) => binding.span, } } } impl<'a> Rewrite for SegmentParam<'a> { // FIXME: doesn't always use width, offset. fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { Some(match *self { SegmentParam::LifeTime(ref lt) => { pprust::lifetime_to_string(lt) } SegmentParam::Type(ref ty) => { try_opt!(ty.rewrite(context, width, offset)) } SegmentParam::Binding(ref binding) => { format!("{} = {}", binding.ident, try_opt!(binding.ty.rewrite(context, width, offset))) } }) } } // This is a dirty hack to determine if we're in an expression or not. Generic // parameters are passed differently in expressions and items. We'd declare // a struct with Foo, but call its functions with Foo::::f(). // We'd really rather not do this, but there doesn't seem to be an alternative // at this point. // FIXME: fails with spans containing comments with the characters < or : fn get_path_separator(codemap: &CodeMap, path_start: BytePos, segment_start: BytePos) -> &'static str { let span = codemap::mk_sp(path_start, segment_start); let snippet = codemap.span_to_snippet(span).unwrap(); for c in snippet.chars().rev() { if c == ':' { return "::"; } else if c.is_whitespace() || c == '<' { continue; } else { return ""; } } unreachable!(); } // Formats a path segment. There are some hacks involved to correctly determine // the segment's associated span since it's not part of the AST. // // The span_lo is assumed to be greater than the end of any previous segment's // parameters and lesser or equal than the start of current segment. // // span_hi is assumed equal to the end of the entire path. // // When the segment contains a positive number of parameters, we update span_lo // so that invariants described above will hold for the next segment. fn rewrite_segment(segment: &ast::PathSegment, span_lo: &mut BytePos, span_hi: BytePos, context: &RewriteContext, width: usize, offset: Indent) -> Option { let ident_len = segment.identifier.to_string().len(); let width = try_opt!(width.checked_sub(ident_len)); let offset = offset + ident_len; let params = match segment.parameters { ast::PathParameters::AngleBracketedParameters(ref data) if !data.lifetimes.is_empty() || !data.types.is_empty() || !data.bindings.is_empty() => { let param_list = data.lifetimes .iter() .map(SegmentParam::LifeTime) .chain(data.types.iter().map(|x| SegmentParam::Type(&*x))) .chain(data.bindings.iter().map(|x| SegmentParam::Binding(&*x))) .collect::>(); let next_span_lo = param_list.last().unwrap().get_span().hi + BytePos(1); let list_lo = span_after(codemap::mk_sp(*span_lo, span_hi), "<", context.codemap); let separator = get_path_separator(context.codemap, *span_lo, list_lo); // 1 for < let extra_offset = 1 + separator.len(); // 1 for > let list_width = try_opt!(width.checked_sub(extra_offset + 1)); let items = itemize_list(context.codemap, param_list.into_iter(), ">", |param| param.get_span().lo, |param| param.get_span().hi, // FIXME(#133): write_list should call // rewrite itself, because it has a better // context. |seg| { seg.rewrite(context, context.config.max_width, offset + extra_offset) .unwrap() }, list_lo, span_hi); let fmt = ListFormatting::for_item(list_width, offset + extra_offset, context.config); let list_str = try_opt!(write_list(&items.collect::>(), &fmt)); // Update position of last bracket. *span_lo = next_span_lo; format!("{}<{}>", separator, list_str) } ast::PathParameters::ParenthesizedParameters(ref data) => { let output = match data.output { Some(ref ty) => format!(" -> {}", pprust::ty_to_string(&*ty)), None => String::new(), }; let list_lo = span_after(data.span, "(", context.codemap); let items = itemize_list(context.codemap, data.inputs.iter(), ")", |ty| ty.span.lo, |ty| ty.span.hi, |ty| pprust::ty_to_string(ty), list_lo, span_hi); // 2 for () let budget = try_opt!(width.checked_sub(output.len() + 2)); // 1 for ( let fmt = ListFormatting::for_fn(budget, offset + 1, context.config); let list_str = try_opt!(write_list(&items.collect::>(), &fmt)); format!("({}){}", list_str, output) } _ => String::new(), }; Some(format!("{}{}", segment.identifier, params)) } impl Rewrite for ast::WherePredicate { fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { // TODO: dead spans? // TODO: don't assume we'll always fit on one line... Some(match *self { ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate { ref bound_lifetimes, ref bounded_ty, ref bounds, .. }) => { if !bound_lifetimes.is_empty() { let lifetime_str = bound_lifetimes.iter() .map(|lt| { lt.rewrite(context, width, offset) .unwrap() }) .collect::>() .join(", "); let type_str = pprust::ty_to_string(bounded_ty); // 8 = "for<> : ".len() let used_width = lifetime_str.len() + type_str.len() + 8; let bounds_str = bounds.iter() .map(|ty_bound| { ty_bound.rewrite(context, width - used_width, offset + used_width) .unwrap() }) .collect::>() .join(" + "); format!("for<{}> {}: {}", lifetime_str, type_str, bounds_str) } else { let type_str = pprust::ty_to_string(bounded_ty); // 2 = ": ".len() let used_width = type_str.len() + 2; let bounds_str = bounds.iter() .map(|ty_bound| { ty_bound.rewrite(context, width - used_width, offset + used_width) .unwrap() }) .collect::>() .join(" + "); format!("{}: {}", type_str, bounds_str) } } ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate { ref lifetime, ref bounds, .. }) => { format!("{}: {}", pprust::lifetime_to_string(lifetime), bounds.iter() .map(pprust::lifetime_to_string) .collect::>() .join(" + ")) } ast::WherePredicate::EqPredicate(ast::WhereEqPredicate { ref path, ref ty, .. }) => { let ty_str = pprust::ty_to_string(ty); // 3 = " = ".len() let used_width = 3 + ty_str.len(); let path_str = try_opt!(path.rewrite(context, width - used_width, offset + used_width)); format!("{} = {}", path_str, ty_str) } }) } } impl Rewrite for ast::LifetimeDef { fn rewrite(&self, _: &RewriteContext, _: usize, _: Indent) -> Option { if self.bounds.is_empty() { Some(pprust::lifetime_to_string(&self.lifetime)) } else { Some(format!("{}: {}", pprust::lifetime_to_string(&self.lifetime), self.bounds .iter() .map(pprust::lifetime_to_string) .collect::>() .join(" + "))) } } } impl Rewrite for ast::TyParamBound { fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { match *self { ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::None) => { tref.rewrite(context, width, offset) } ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::Maybe) => { Some(format!("?{}", try_opt!(tref.rewrite(context, width - 1, offset + 1)))) } ast::TyParamBound::RegionTyParamBound(ref l) => { Some(pprust::lifetime_to_string(l)) } } } } impl Rewrite for ast::TyParamBounds { fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { let strs: Vec<_> = self.iter() .map(|b| b.rewrite(context, width, offset).unwrap()) .collect(); Some(strs.join(" + ")) } } // FIXME: this assumes everything will fit on one line impl Rewrite for ast::TyParam { fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { let mut result = String::with_capacity(128); result.push_str(&self.ident.to_string()); if !self.bounds.is_empty() { result.push_str(": "); let bounds = self.bounds .iter() .map(|ty_bound| ty_bound.rewrite(context, width, offset).unwrap()) .collect::>() .join(" + "); result.push_str(&bounds); } if let Some(ref def) = self.default { result.push_str(" = "); result.push_str(&pprust::ty_to_string(&def)); } Some(result) } } // FIXME: this assumes everything will fit on one line impl Rewrite for ast::PolyTraitRef { fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { if !self.bound_lifetimes.is_empty() { let lifetime_str = self.bound_lifetimes .iter() .map(|lt| lt.rewrite(context, width, offset).unwrap()) .collect::>() .join(", "); // 6 is "for<> ".len() let extra_offset = lifetime_str.len() + 6; let max_path_width = try_opt!(width.checked_sub(extra_offset)); let path_str = try_opt!(self.trait_ref .path .rewrite(context, max_path_width, offset + extra_offset)); Some(format!("for<{}> {}", lifetime_str, path_str)) } else { self.trait_ref.path.rewrite(context, width, offset) } } } impl Rewrite for ast::Ty { // FIXME doesn't always use width, offset fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option { match self.node { ast::TyPath(None, ref p) => { p.rewrite(context, width, offset) } ast::TyObjectSum(ref ty, ref bounds) => { let ty_str = try_opt!(ty.rewrite(context, width, offset)); let overhead = ty_str.len() + 3; Some(format!("{} + {}", ty_str, try_opt!(bounds.rewrite(context, try_opt!(width.checked_sub(overhead)), offset + overhead)))) } ast::TyRptr(ref lifetime, ref mt) => { let mut_str = format_mutability(mt.mutbl); let mut_len = mut_str.len(); Some(match lifetime { &Some(ref lifetime) => { let lt_str = pprust::lifetime_to_string(lifetime); let lt_len = lt_str.len(); format!("&{} {}{}", lt_str, mut_str, try_opt!(mt.ty.rewrite(context, width - (2 + mut_len + lt_len), offset + 2 + mut_len + lt_len))) } &None => { format!("&{}{}", mut_str, try_opt!(mt.ty.rewrite(context, width - (1 + mut_len), offset + 1 + mut_len))) } }) } ast::TyParen(ref ty) => { ty.rewrite(context, width - 2, offset + 1).map(|ty_str| format!("({})", ty_str)) } _ => Some(pprust::ty_to_string(self)), } } }