// 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 std::iter::ExactSizeIterator; use std::ops::Deref; use syntax::ast::{self, FunctionRetTy, Mutability}; use syntax::codemap::{self, BytePos, Span}; use syntax::print::pprust; use syntax::symbol::keywords; use spanned::Spanned; use codemap::SpanUtils; use config::{IndentStyle, TypeDensity}; use expr::{rewrite_pair, rewrite_tuple, rewrite_unary_prefix, wrap_args_with_parens, PairParts}; use items::{format_generics_item_list, generics_shape_from_config}; use lists::{definitive_tactic, itemize_list, write_list, ListFormatting, ListTactic, Separator, SeparatorPlace, SeparatorTactic}; use rewrite::{Rewrite, RewriteContext}; use shape::Shape; use utils::{colon_spaces, extra_offset, first_line_width, format_abi, format_mutability, last_line_width, mk_sp}; #[derive(Copy, Clone, Debug, Eq, PartialEq)] pub enum PathContext { Expr, Type, Import, } // Does not wrap on simple segments. pub fn rewrite_path( context: &RewriteContext, path_context: PathContext, qself: Option<&ast::QSelf>, path: &ast::Path, shape: Shape, ) -> Option { let skip_count = qself.map_or(0, |x| x.position); let mut result = if path.is_global() && qself.is_none() && path_context != PathContext::Import { "::".to_owned() } else { String::new() }; let mut span_lo = path.span.lo(); if let Some(qself) = qself { result.push('<'); if context.config.spaces_within_parens_and_brackets() { result.push_str(" ") } let fmt_ty = qself.ty.rewrite(context, shape)?; result.push_str(&fmt_ty); if skip_count > 0 { result.push_str(" as "); if path.is_global() && path_context != PathContext::Import { result.push_str("::"); } // 3 = ">::".len() let shape = shape.sub_width(3)?; result = rewrite_path_segments( PathContext::Type, result, path.segments.iter().take(skip_count), span_lo, path.span.hi(), context, shape, )?; } if context.config.spaces_within_parens_and_brackets() { result.push_str(" ") } result.push_str(">::"); span_lo = qself.ty.span.hi() + BytePos(1); } rewrite_path_segments( path_context, result, path.segments.iter().skip(skip_count), span_lo, path.span.hi(), context, shape, ) } fn rewrite_path_segments<'a, I>( path_context: PathContext, mut buffer: String, iter: I, mut span_lo: BytePos, span_hi: BytePos, context: &RewriteContext, shape: Shape, ) -> Option where I: Iterator, { let mut first = true; let shape = shape.visual_indent(0); for segment in iter { // Indicates a global path, shouldn't be rendered. if segment.identifier.name == keywords::CrateRoot.name() { continue; } if first { first = false; } else { buffer.push_str("::"); } let extra_offset = extra_offset(&buffer, shape); let new_shape = shape.shrink_left(extra_offset)?; let segment_string = rewrite_segment( path_context, segment, &mut span_lo, span_hi, context, new_shape, )?; 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(lt) => lt.span, SegmentParam::Type(ty) => ty.span, SegmentParam::Binding(binding) => binding.span, } } } impl<'a> Rewrite for SegmentParam<'a> { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { match *self { SegmentParam::LifeTime(lt) => lt.rewrite(context, shape), SegmentParam::Type(ty) => ty.rewrite(context, shape), SegmentParam::Binding(binding) => { let mut result = match context.config.type_punctuation_density() { TypeDensity::Wide => format!("{} = ", binding.ident), TypeDensity::Compressed => format!("{}=", binding.ident), }; let budget = shape.width.checked_sub(result.len())?; let rewrite = binding .ty .rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?; result.push_str(&rewrite); Some(result) } } } } // 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( path_context: PathContext, segment: &ast::PathSegment, span_lo: &mut BytePos, span_hi: BytePos, context: &RewriteContext, shape: Shape, ) -> Option { let ident_len = segment.identifier.to_string().len(); let shape = shape.shrink_left(ident_len)?; let params = if let Some(ref params) = segment.parameters { match **params { ast::PathParameters::AngleBracketed(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 = context.codemap.span_after(mk_sp(*span_lo, span_hi), "<"); let separator = if path_context == PathContext::Expr { "::" } else { "" }; let generics_shape = generics_shape_from_config(context.config, shape, separator.len())?; let one_line_width = shape.width.checked_sub(separator.len() + 2)?; let items = itemize_list( context.codemap, param_list.into_iter(), ">", ",", |param| param.get_span().lo(), |param| param.get_span().hi(), |seg| seg.rewrite(context, generics_shape), list_lo, span_hi, false, ); let generics_str = format_generics_item_list(context, items, generics_shape, one_line_width)?; // Update position of last bracket. *span_lo = next_span_lo; format!("{}{}", separator, generics_str) } ast::PathParameters::Parenthesized(ref data) => { let output = match data.output { Some(ref ty) => FunctionRetTy::Ty(ty.clone()), None => FunctionRetTy::Default(codemap::DUMMY_SP), }; format_function_type( data.inputs.iter().map(|x| &**x), &output, false, data.span, context, shape, )? } _ => String::new(), } } else { String::new() }; Some(format!("{}{}", segment.identifier, params)) } fn format_function_type<'a, I>( inputs: I, output: &FunctionRetTy, variadic: bool, span: Span, context: &RewriteContext, shape: Shape, ) -> Option where I: ExactSizeIterator, ::Item: Deref, ::Target: Rewrite + Spanned + 'a, { // Code for handling variadics is somewhat duplicated for items, but they // are different enough to need some serious refactoring to share code. enum ArgumentKind where T: Deref, ::Target: Rewrite + Spanned, { Regular(Box), Variadic(BytePos), } let variadic_arg = if variadic { let variadic_start = context.codemap.span_before(span, "..."); Some(ArgumentKind::Variadic(variadic_start)) } else { None }; // 2 for () let budget = shape.width.checked_sub(2)?; // 1 for ( let offset = match context.config.indent_style() { IndentStyle::Block => { shape .block() .block_indent(context.config.tab_spaces()) .indent } IndentStyle::Visual => shape.indent + 1, }; let list_shape = Shape::legacy(budget, offset); let list_lo = context.codemap.span_after(span, "("); let items = itemize_list( context.codemap, // FIXME Would be nice to avoid this allocation, // but I couldn't get the types to work out. inputs .map(|i| ArgumentKind::Regular(Box::new(i))) .chain(variadic_arg), ")", ",", |arg| match *arg { ArgumentKind::Regular(ref ty) => ty.span().lo(), ArgumentKind::Variadic(start) => start, }, |arg| match *arg { ArgumentKind::Regular(ref ty) => ty.span().hi(), ArgumentKind::Variadic(start) => start + BytePos(3), }, |arg| match *arg { ArgumentKind::Regular(ref ty) => ty.rewrite(context, list_shape), ArgumentKind::Variadic(_) => Some("...".to_owned()), }, list_lo, span.hi(), false, ); let item_vec: Vec<_> = items.collect(); let tactic = definitive_tactic( &*item_vec, ListTactic::HorizontalVertical, Separator::Comma, budget, ); let fmt = ListFormatting { tactic: tactic, separator: ",", trailing_separator: if !context.use_block_indent() || variadic { SeparatorTactic::Never } else { context.config.trailing_comma() }, separator_place: SeparatorPlace::Back, shape: list_shape, ends_with_newline: tactic.ends_with_newline(context.config.indent_style()), preserve_newline: true, config: context.config, }; let list_str = write_list(&item_vec, &fmt)?; let ty_shape = match context.config.indent_style() { // 4 = " -> " IndentStyle::Block => shape.offset_left(4)?, IndentStyle::Visual => shape.block_left(4)?, }; let output = match *output { FunctionRetTy::Ty(ref ty) => { let type_str = ty.rewrite(context, ty_shape)?; format!(" -> {}", type_str) } FunctionRetTy::Default(..) => String::new(), }; let extendable = (!list_str.contains('\n') || list_str.is_empty()) && !output.contains("\n"); let args = wrap_args_with_parens( context, &list_str, extendable, shape.sub_width(first_line_width(&output))?, Shape::indented(offset, context.config), ); if last_line_width(&args) + first_line_width(&output) <= shape.width { Some(format!("{}{}", args, output)) } else { Some(format!( "{}\n{}{}", args, offset.to_string(context.config), output.trim_left() )) } } fn type_bound_colon(context: &RewriteContext) -> &'static str { colon_spaces( context.config.space_before_colon(), context.config.space_after_colon(), ) } impl Rewrite for ast::WherePredicate { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { // TODO: dead spans? let result = match *self { ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate { ref bound_lifetimes, ref bounded_ty, ref bounds, .. }) => { let type_str = bounded_ty.rewrite(context, shape)?; let colon = type_bound_colon(context); if !bound_lifetimes.is_empty() { let lifetime_str: String = bound_lifetimes .iter() .map(|lt| lt.rewrite(context, shape)) .collect::>>()? .join(", "); // 6 = "for<> ".len() let used_width = lifetime_str.len() + type_str.len() + colon.len() + 6; let ty_shape = shape.offset_left(used_width)?; let bounds = bounds .iter() .map(|ty_bound| ty_bound.rewrite(context, ty_shape)) .collect::>>()?; let bounds_str = join_bounds(context, ty_shape, &bounds); if context.config.spaces_within_parens_and_brackets() && !lifetime_str.is_empty() { format!( "for< {} > {}{}{}", lifetime_str, type_str, colon, bounds_str ) } else { format!("for<{}> {}{}{}", lifetime_str, type_str, colon, bounds_str) } } else { let used_width = type_str.len() + colon.len(); let ty_shape = match context.config.indent_style() { IndentStyle::Visual => shape.block_left(used_width)?, IndentStyle::Block => shape, }; let bounds = bounds .iter() .map(|ty_bound| ty_bound.rewrite(context, ty_shape)) .collect::>>()?; let overhead = type_str.len() + colon.len(); let bounds_str = join_bounds(context, ty_shape.sub_width(overhead)?, &bounds); format!("{}{}{}", type_str, colon, bounds_str) } } ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate { ref lifetime, ref bounds, .. }) => rewrite_bounded_lifetime(lifetime, bounds.iter(), context, shape)?, ast::WherePredicate::EqPredicate(ast::WhereEqPredicate { ref lhs_ty, ref rhs_ty, .. }) => { let lhs_ty_str = lhs_ty.rewrite(context, shape)?; // 3 = " = ".len() let used_width = 3 + lhs_ty_str.len(); let budget = shape.width.checked_sub(used_width)?; let rhs_ty_str = rhs_ty.rewrite(context, Shape::legacy(budget, shape.indent + used_width))?; format!("{} = {}", lhs_ty_str, rhs_ty_str) } }; Some(result) } } impl Rewrite for ast::LifetimeDef { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { rewrite_bounded_lifetime(&self.lifetime, self.bounds.iter(), context, shape) } } fn rewrite_bounded_lifetime<'b, I>( lt: &ast::Lifetime, bounds: I, context: &RewriteContext, shape: Shape, ) -> Option where I: ExactSizeIterator, { let result = lt.rewrite(context, shape)?; if bounds.len() == 0 { Some(result) } else { let appendix = bounds .into_iter() .map(|b| b.rewrite(context, shape)) .collect::>>()?; let colon = type_bound_colon(context); let overhead = last_line_width(&result) + colon.len(); let result = format!( "{}{}{}", result, colon, join_bounds(context, shape.sub_width(overhead)?, &appendix) ); Some(result) } } impl Rewrite for ast::TyParamBound { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { match *self { ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::None) => { tref.rewrite(context, shape) } ast::TyParamBound::TraitTyParamBound(ref tref, ast::TraitBoundModifier::Maybe) => { Some(format!( "?{}", tref.rewrite(context, shape.offset_left(1)?)? )) } ast::TyParamBound::RegionTyParamBound(ref l) => l.rewrite(context, shape), } } } impl Rewrite for ast::Lifetime { fn rewrite(&self, _: &RewriteContext, _: Shape) -> Option { Some(pprust::lifetime_to_string(self)) } } impl Rewrite for ast::TyParamBounds { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { let strs = self.iter() .map(|b| b.rewrite(context, shape)) .collect::>>()?; Some(join_bounds(context, shape, &strs)) } } impl Rewrite for ast::TyParam { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { let mut result = String::with_capacity(128); // FIXME: If there are more than one attributes, this will force multiline. match self.attrs.rewrite(context, shape) { Some(ref rw) if !rw.is_empty() => result.push_str(&format!("{} ", rw)), _ => (), } result.push_str(&self.ident.to_string()); if !self.bounds.is_empty() { result.push_str(type_bound_colon(context)); let strs = self.bounds .iter() .map(|ty_bound| ty_bound.rewrite(context, shape)) .collect::>>()?; result.push_str(&join_bounds(context, shape, &strs)); } if let Some(ref def) = self.default { let eq_str = match context.config.type_punctuation_density() { TypeDensity::Compressed => "=", TypeDensity::Wide => " = ", }; result.push_str(eq_str); let budget = shape.width.checked_sub(result.len())?; let rewrite = def.rewrite(context, Shape::legacy(budget, shape.indent + result.len()))?; result.push_str(&rewrite); } Some(result) } } impl Rewrite for ast::PolyTraitRef { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { if !self.bound_lifetimes.is_empty() { let lifetime_str: String = self.bound_lifetimes .iter() .map(|lt| lt.rewrite(context, shape)) .collect::>>()? .join(", "); // 6 is "for<> ".len() let extra_offset = lifetime_str.len() + 6; let path_str = self.trait_ref .rewrite(context, shape.offset_left(extra_offset)?)?; Some( if context.config.spaces_within_parens_and_brackets() && !lifetime_str.is_empty() { format!("for< {} > {}", lifetime_str, path_str) } else { format!("for<{}> {}", lifetime_str, path_str) }, ) } else { self.trait_ref.rewrite(context, shape) } } } impl Rewrite for ast::TraitRef { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { rewrite_path(context, PathContext::Type, None, &self.path, shape) } } impl Rewrite for ast::Ty { fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option { match self.node { ast::TyKind::TraitObject(ref bounds, ..) => bounds.rewrite(context, shape), ast::TyKind::Ptr(ref mt) => { let prefix = match mt.mutbl { Mutability::Mutable => "*mut ", Mutability::Immutable => "*const ", }; rewrite_unary_prefix(context, prefix, &*mt.ty, shape) } ast::TyKind::Rptr(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_budget = shape.width.checked_sub(2 + mut_len)?; let lt_str = lifetime.rewrite( context, Shape::legacy(lt_budget, shape.indent + 2 + mut_len), )?; let lt_len = lt_str.len(); let budget = shape.width.checked_sub(2 + mut_len + lt_len)?; format!( "&{} {}{}", lt_str, mut_str, mt.ty.rewrite( context, Shape::legacy(budget, shape.indent + 2 + mut_len + lt_len) )? ) } None => { let budget = shape.width.checked_sub(1 + mut_len)?; format!( "&{}{}", mut_str, mt.ty.rewrite( context, Shape::legacy(budget, shape.indent + 1 + mut_len) )? ) } }) } // FIXME: we drop any comments here, even though it's a silly place to put // comments. ast::TyKind::Paren(ref ty) => { let budget = shape.width.checked_sub(2)?; ty.rewrite(context, Shape::legacy(budget, shape.indent + 1)) .map(|ty_str| { if context.config.spaces_within_parens_and_brackets() { format!("( {} )", ty_str) } else { format!("({})", ty_str) } }) } ast::TyKind::Slice(ref ty) => { let budget = if context.config.spaces_within_parens_and_brackets() { shape.width.checked_sub(4)? } else { shape.width.checked_sub(2)? }; ty.rewrite(context, Shape::legacy(budget, shape.indent + 1)) .map(|ty_str| { if context.config.spaces_within_parens_and_brackets() { format!("[ {} ]", ty_str) } else { format!("[{}]", ty_str) } }) } ast::TyKind::Tup(ref items) => rewrite_tuple( context, &::utils::ptr_vec_to_ref_vec(items), self.span, shape, ), ast::TyKind::Path(ref q_self, ref path) => { rewrite_path(context, PathContext::Type, q_self.as_ref(), path, shape) } ast::TyKind::Array(ref ty, ref repeats) => { let use_spaces = context.config.spaces_within_parens_and_brackets(); let lbr = if use_spaces { "[ " } else { "[" }; let rbr = if use_spaces { " ]" } else { "]" }; rewrite_pair( &**ty, &**repeats, PairParts::new(lbr, "; ", rbr), context, shape, SeparatorPlace::Back, ) } ast::TyKind::Infer => if shape.width >= 1 { Some("_".to_owned()) } else { None }, ast::TyKind::BareFn(ref bare_fn) => rewrite_bare_fn(bare_fn, self.span, context, shape), ast::TyKind::Never => Some(String::from("!")), ast::TyKind::Mac(..) => None, ast::TyKind::ImplicitSelf => Some(String::from("")), ast::TyKind::ImplTrait(ref it) => it.rewrite(context, shape) .map(|it_str| format!("impl {}", it_str)), ast::TyKind::Err | ast::TyKind::Typeof(..) => unreachable!(), } } } fn rewrite_bare_fn( bare_fn: &ast::BareFnTy, span: Span, context: &RewriteContext, shape: Shape, ) -> Option { let mut result = String::with_capacity(128); if !bare_fn.lifetimes.is_empty() { result.push_str("for<"); // 6 = "for<> ".len(), 4 = "for<". // This doesn't work out so nicely for mutliline situation with lots of // rightward drift. If that is a problem, we could use the list stuff. result.push_str(&bare_fn .lifetimes .iter() .map(|l| { l.rewrite( context, Shape::legacy(shape.width.checked_sub(6)?, shape.indent + 4), ) }) .collect::>>()? .join(", ")); result.push_str("> "); } result.push_str(::utils::format_unsafety(bare_fn.unsafety)); result.push_str(&format_abi( bare_fn.abi, context.config.force_explicit_abi(), false, )); result.push_str("fn"); let func_ty_shape = shape.offset_left(result.len())?; let rewrite = format_function_type( bare_fn.decl.inputs.iter(), &bare_fn.decl.output, bare_fn.decl.variadic, span, context, func_ty_shape, )?; result.push_str(&rewrite); Some(result) } pub fn join_bounds(context: &RewriteContext, shape: Shape, type_strs: &[String]) -> String { // Try to join types in a single line let joiner = match context.config.type_punctuation_density() { TypeDensity::Compressed => "+", TypeDensity::Wide => " + ", }; let result = type_strs.join(joiner); if result.contains('\n') || result.len() > shape.width { let joiner_indent = shape.indent.block_indent(context.config); let joiner = format!("\n{}+ ", joiner_indent.to_string(context.config)); type_strs.join(&joiner) } else { result } } pub fn can_be_overflowed_type(context: &RewriteContext, ty: &ast::Ty, len: usize) -> bool { match ty.node { ast::TyKind::Path(..) | ast::TyKind::Tup(..) => context.use_block_indent() && len == 1, ast::TyKind::Rptr(_, ref mutty) | ast::TyKind::Ptr(ref mutty) => { can_be_overflowed_type(context, &*mutty.ty, len) } _ => false, } }