// Copyright 2012-2014 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. pub use self::AnnNode::*; use abi::{self, Abi}; use ast::{self, TokenTree, BlockCheckMode, PatKind}; use ast::{RegionTyParamBound, TraitTyParamBound, TraitBoundModifier}; use ast::Attribute; use attr::ThinAttributesExt; use util::parser::AssocOp; use attr; use attr::{AttrMetaMethods, AttributeMethods}; use codemap::{self, CodeMap, BytePos}; use errors; use parse::token::{self, BinOpToken, Token, InternedString}; use parse::lexer::comments; use parse; use print::pp::{self, break_offset, word, space, zerobreak, hardbreak}; use print::pp::{Breaks, eof}; use print::pp::Breaks::{Consistent, Inconsistent}; use ptr::P; use std_inject; use std::ascii; use std::io::{self, Write, Read}; use std::iter; pub enum AnnNode<'a> { NodeIdent(&'a ast::Ident), NodeName(&'a ast::Name), NodeBlock(&'a ast::Block), NodeItem(&'a ast::Item), NodeSubItem(ast::NodeId), NodeExpr(&'a ast::Expr), NodePat(&'a ast::Pat), } pub trait PpAnn { fn pre(&self, _state: &mut State, _node: AnnNode) -> io::Result<()> { Ok(()) } fn post(&self, _state: &mut State, _node: AnnNode) -> io::Result<()> { Ok(()) } } #[derive(Copy, Clone)] pub struct NoAnn; impl PpAnn for NoAnn {} #[derive(Copy, Clone)] pub struct CurrentCommentAndLiteral { pub cur_cmnt: usize, pub cur_lit: usize, } pub struct State<'a> { pub s: pp::Printer<'a>, cm: Option<&'a CodeMap>, comments: Option >, literals: Option >, cur_cmnt_and_lit: CurrentCommentAndLiteral, boxes: Vec, ann: &'a (PpAnn+'a), } pub fn rust_printer<'a>(writer: Box) -> State<'a> { static NO_ANN: NoAnn = NoAnn; rust_printer_annotated(writer, &NO_ANN) } pub fn rust_printer_annotated<'a>(writer: Box, ann: &'a PpAnn) -> State<'a> { State { s: pp::mk_printer(writer, DEFAULT_COLUMNS), cm: None, comments: None, literals: None, cur_cmnt_and_lit: CurrentCommentAndLiteral { cur_cmnt: 0, cur_lit: 0 }, boxes: Vec::new(), ann: ann, } } pub const INDENT_UNIT: usize = 4; pub const DEFAULT_COLUMNS: usize = 78; /// Requires you to pass an input filename and reader so that /// it can scan the input text for comments and literals to /// copy forward. pub fn print_crate<'a>(cm: &'a CodeMap, span_diagnostic: &errors::Handler, krate: &ast::Crate, filename: String, input: &mut Read, out: Box, ann: &'a PpAnn, is_expanded: bool) -> io::Result<()> { let mut s = State::new_from_input(cm, span_diagnostic, filename, input, out, ann, is_expanded); if is_expanded && !std_inject::no_std(krate) { // We need to print `#![no_std]` (and its feature gate) so that // compiling pretty-printed source won't inject libstd again. // However we don't want these attributes in the AST because // of the feature gate, so we fake them up here. // #![feature(prelude_import)] let prelude_import_meta = attr::mk_word_item(InternedString::new("prelude_import")); let list = attr::mk_list_item(InternedString::new("feature"), vec![prelude_import_meta]); let fake_attr = attr::mk_attr_inner(attr::mk_attr_id(), list); try!(s.print_attribute(&fake_attr)); // #![no_std] let no_std_meta = attr::mk_word_item(InternedString::new("no_std")); let fake_attr = attr::mk_attr_inner(attr::mk_attr_id(), no_std_meta); try!(s.print_attribute(&fake_attr)); } try!(s.print_mod(&krate.module, &krate.attrs)); try!(s.print_remaining_comments()); eof(&mut s.s) } impl<'a> State<'a> { pub fn new_from_input(cm: &'a CodeMap, span_diagnostic: &errors::Handler, filename: String, input: &mut Read, out: Box, ann: &'a PpAnn, is_expanded: bool) -> State<'a> { let (cmnts, lits) = comments::gather_comments_and_literals( span_diagnostic, filename, input); State::new( cm, out, ann, Some(cmnts), // If the code is post expansion, don't use the table of // literals, since it doesn't correspond with the literals // in the AST anymore. if is_expanded { None } else { Some(lits) }) } pub fn new(cm: &'a CodeMap, out: Box, ann: &'a PpAnn, comments: Option>, literals: Option>) -> State<'a> { State { s: pp::mk_printer(out, DEFAULT_COLUMNS), cm: Some(cm), comments: comments, literals: literals, cur_cmnt_and_lit: CurrentCommentAndLiteral { cur_cmnt: 0, cur_lit: 0 }, boxes: Vec::new(), ann: ann, } } } pub fn to_string(f: F) -> String where F: FnOnce(&mut State) -> io::Result<()>, { let mut wr = Vec::new(); { let mut printer = rust_printer(Box::new(&mut wr)); f(&mut printer).unwrap(); eof(&mut printer.s).unwrap(); } String::from_utf8(wr).unwrap() } pub fn binop_to_string(op: BinOpToken) -> &'static str { match op { token::Plus => "+", token::Minus => "-", token::Star => "*", token::Slash => "/", token::Percent => "%", token::Caret => "^", token::And => "&", token::Or => "|", token::Shl => "<<", token::Shr => ">>", } } pub fn token_to_string(tok: &Token) -> String { match *tok { token::Eq => "=".to_string(), token::Lt => "<".to_string(), token::Le => "<=".to_string(), token::EqEq => "==".to_string(), token::Ne => "!=".to_string(), token::Ge => ">=".to_string(), token::Gt => ">".to_string(), token::Not => "!".to_string(), token::Tilde => "~".to_string(), token::OrOr => "||".to_string(), token::AndAnd => "&&".to_string(), token::BinOp(op) => binop_to_string(op).to_string(), token::BinOpEq(op) => format!("{}=", binop_to_string(op)), /* Structural symbols */ token::At => "@".to_string(), token::Dot => ".".to_string(), token::DotDot => "..".to_string(), token::DotDotDot => "...".to_string(), token::Comma => ",".to_string(), token::Semi => ";".to_string(), token::Colon => ":".to_string(), token::ModSep => "::".to_string(), token::RArrow => "->".to_string(), token::LArrow => "<-".to_string(), token::FatArrow => "=>".to_string(), token::OpenDelim(token::Paren) => "(".to_string(), token::CloseDelim(token::Paren) => ")".to_string(), token::OpenDelim(token::Bracket) => "[".to_string(), token::CloseDelim(token::Bracket) => "]".to_string(), token::OpenDelim(token::Brace) => "{".to_string(), token::CloseDelim(token::Brace) => "}".to_string(), token::Pound => "#".to_string(), token::Dollar => "$".to_string(), token::Question => "?".to_string(), /* Literals */ token::Literal(lit, suf) => { let mut out = match lit { token::Byte(b) => format!("b'{}'", b), token::Char(c) => format!("'{}'", c), token::Float(c) => c.to_string(), token::Integer(c) => c.to_string(), token::Str_(s) => format!("\"{}\"", s), token::StrRaw(s, n) => format!("r{delim}\"{string}\"{delim}", delim=repeat("#", n), string=s), token::ByteStr(v) => format!("b\"{}\"", v), token::ByteStrRaw(s, n) => format!("br{delim}\"{string}\"{delim}", delim=repeat("#", n), string=s), }; if let Some(s) = suf { out.push_str(&s.as_str()) } out } /* Name components */ token::Ident(s, _) => s.to_string(), token::Lifetime(s) => s.to_string(), token::Underscore => "_".to_string(), /* Other */ token::DocComment(s) => s.to_string(), token::SubstNt(s, _) => format!("${}", s), token::MatchNt(s, t, _, _) => format!("${}:{}", s, t), token::Eof => "".to_string(), token::Whitespace => " ".to_string(), token::Comment => "/* */".to_string(), token::Shebang(s) => format!("/* shebang: {}*/", s), token::SpecialVarNt(var) => format!("${}", var.as_str()), token::Interpolated(ref nt) => match *nt { token::NtExpr(ref e) => expr_to_string(&e), token::NtMeta(ref e) => meta_item_to_string(&e), token::NtTy(ref e) => ty_to_string(&e), token::NtPath(ref e) => path_to_string(&e), token::NtItem(ref e) => item_to_string(&e), token::NtBlock(ref e) => block_to_string(&e), token::NtStmt(ref e) => stmt_to_string(&e), token::NtPat(ref e) => pat_to_string(&e), token::NtIdent(ref e, _) => ident_to_string(e.node), token::NtTT(ref e) => tt_to_string(&e), token::NtArm(ref e) => arm_to_string(&e), token::NtImplItem(ref e) => impl_item_to_string(&e), token::NtTraitItem(ref e) => trait_item_to_string(&e), token::NtGenerics(ref e) => generics_to_string(&e), token::NtWhereClause(ref e) => where_clause_to_string(&e), token::NtArg(ref e) => arg_to_string(&e), } } } pub fn ty_to_string(ty: &ast::Ty) -> String { to_string(|s| s.print_type(ty)) } pub fn bounds_to_string(bounds: &[ast::TyParamBound]) -> String { to_string(|s| s.print_bounds("", bounds)) } pub fn pat_to_string(pat: &ast::Pat) -> String { to_string(|s| s.print_pat(pat)) } pub fn arm_to_string(arm: &ast::Arm) -> String { to_string(|s| s.print_arm(arm)) } pub fn expr_to_string(e: &ast::Expr) -> String { to_string(|s| s.print_expr(e)) } pub fn lifetime_to_string(e: &ast::Lifetime) -> String { to_string(|s| s.print_lifetime(e)) } pub fn tt_to_string(tt: &ast::TokenTree) -> String { to_string(|s| s.print_tt(tt)) } pub fn tts_to_string(tts: &[ast::TokenTree]) -> String { to_string(|s| s.print_tts(tts)) } pub fn stmt_to_string(stmt: &ast::Stmt) -> String { to_string(|s| s.print_stmt(stmt)) } pub fn attr_to_string(attr: &ast::Attribute) -> String { to_string(|s| s.print_attribute(attr)) } pub fn item_to_string(i: &ast::Item) -> String { to_string(|s| s.print_item(i)) } pub fn impl_item_to_string(i: &ast::ImplItem) -> String { to_string(|s| s.print_impl_item(i)) } pub fn trait_item_to_string(i: &ast::TraitItem) -> String { to_string(|s| s.print_trait_item(i)) } pub fn generics_to_string(generics: &ast::Generics) -> String { to_string(|s| s.print_generics(generics)) } pub fn where_clause_to_string(i: &ast::WhereClause) -> String { to_string(|s| s.print_where_clause(i)) } pub fn fn_block_to_string(p: &ast::FnDecl) -> String { to_string(|s| s.print_fn_block_args(p)) } pub fn path_to_string(p: &ast::Path) -> String { to_string(|s| s.print_path(p, false, 0)) } pub fn ident_to_string(id: ast::Ident) -> String { to_string(|s| s.print_ident(id)) } pub fn fun_to_string(decl: &ast::FnDecl, unsafety: ast::Unsafety, constness: ast::Constness, name: ast::Ident, opt_explicit_self: Option<&ast::SelfKind>, generics: &ast::Generics) -> String { to_string(|s| { try!(s.head("")); try!(s.print_fn(decl, unsafety, constness, Abi::Rust, Some(name), generics, opt_explicit_self, ast::Visibility::Inherited)); try!(s.end()); // Close the head box s.end() // Close the outer box }) } pub fn block_to_string(blk: &ast::Block) -> String { to_string(|s| { // containing cbox, will be closed by print-block at } try!(s.cbox(INDENT_UNIT)); // head-ibox, will be closed by print-block after { try!(s.ibox(0)); s.print_block(blk) }) } pub fn meta_item_to_string(mi: &ast::MetaItem) -> String { to_string(|s| s.print_meta_item(mi)) } pub fn attribute_to_string(attr: &ast::Attribute) -> String { to_string(|s| s.print_attribute(attr)) } pub fn lit_to_string(l: &ast::Lit) -> String { to_string(|s| s.print_literal(l)) } pub fn explicit_self_to_string(explicit_self: &ast::SelfKind) -> String { to_string(|s| s.print_explicit_self(explicit_self, ast::Mutability::Immutable).map(|_| {})) } pub fn variant_to_string(var: &ast::Variant) -> String { to_string(|s| s.print_variant(var)) } pub fn arg_to_string(arg: &ast::Arg) -> String { to_string(|s| s.print_arg(arg, false)) } pub fn mac_to_string(arg: &ast::Mac) -> String { to_string(|s| s.print_mac(arg, ::parse::token::Paren)) } pub fn visibility_qualified(vis: ast::Visibility, s: &str) -> String { match vis { ast::Visibility::Public => format!("pub {}", s), ast::Visibility::Inherited => s.to_string() } } fn needs_parentheses(expr: &ast::Expr) -> bool { match expr.node { ast::ExprKind::Assign(..) | ast::ExprKind::Binary(..) | ast::ExprKind::Closure(..) | ast::ExprKind::AssignOp(..) | ast::ExprKind::Cast(..) | ast::ExprKind::InPlace(..) | ast::ExprKind::Type(..) => true, _ => false, } } pub trait PrintState<'a> { fn writer(&mut self) -> &mut pp::Printer<'a>; fn boxes(&mut self) -> &mut Vec; fn comments(&mut self) -> &mut Option>; fn cur_cmnt_and_lit(&mut self) -> &mut CurrentCommentAndLiteral; fn literals(&self) -> &Option>; fn word_space(&mut self, w: &str) -> io::Result<()> { try!(word(self.writer(), w)); space(self.writer()) } fn popen(&mut self) -> io::Result<()> { word(self.writer(), "(") } fn pclose(&mut self) -> io::Result<()> { word(self.writer(), ")") } fn is_begin(&mut self) -> bool { match self.writer().last_token() { pp::Token::Begin(_) => true, _ => false, } } fn is_end(&mut self) -> bool { match self.writer().last_token() { pp::Token::End => true, _ => false, } } // is this the beginning of a line? fn is_bol(&mut self) -> bool { self.writer().last_token().is_eof() || self.writer().last_token().is_hardbreak_tok() } fn hardbreak_if_not_bol(&mut self) -> io::Result<()> { if !self.is_bol() { try!(hardbreak(self.writer())) } Ok(()) } // "raw box" fn rbox(&mut self, u: usize, b: pp::Breaks) -> io::Result<()> { self.boxes().push(b); pp::rbox(self.writer(), u, b) } fn ibox(&mut self, u: usize) -> io::Result<()> { self.boxes().push(pp::Breaks::Inconsistent); pp::ibox(self.writer(), u) } fn end(&mut self) -> io::Result<()> { self.boxes().pop().unwrap(); pp::end(self.writer()) } fn commasep(&mut self, b: Breaks, elts: &[T], mut op: F) -> io::Result<()> where F: FnMut(&mut Self, &T) -> io::Result<()>, { try!(self.rbox(0, b)); let mut first = true; for elt in elts { if first { first = false; } else { try!(self.word_space(",")); } try!(op(self, elt)); } self.end() } fn next_lit(&mut self, pos: BytePos) -> Option { let mut cur_lit = self.cur_cmnt_and_lit().cur_lit; let mut result = None; if let &Some(ref lits) = self.literals() { while cur_lit < lits.len() { let ltrl = (*lits)[cur_lit].clone(); if ltrl.pos > pos { break; } cur_lit += 1; if ltrl.pos == pos { result = Some(ltrl); break; } } } self.cur_cmnt_and_lit().cur_lit = cur_lit; result } fn maybe_print_comment(&mut self, pos: BytePos) -> io::Result<()> { loop { match self.next_comment() { Some(ref cmnt) => { if (*cmnt).pos < pos { try!(self.print_comment(cmnt)); self.cur_cmnt_and_lit().cur_cmnt += 1; } else { break; } } _ => break } } Ok(()) } fn print_comment(&mut self, cmnt: &comments::Comment) -> io::Result<()> { match cmnt.style { comments::Mixed => { assert_eq!(cmnt.lines.len(), 1); try!(zerobreak(self.writer())); try!(word(self.writer(), &cmnt.lines[0])); zerobreak(self.writer()) } comments::Isolated => { try!(self.hardbreak_if_not_bol()); for line in &cmnt.lines { // Don't print empty lines because they will end up as trailing // whitespace if !line.is_empty() { try!(word(self.writer(), &line[..])); } try!(hardbreak(self.writer())); } Ok(()) } comments::Trailing => { try!(word(self.writer(), " ")); if cmnt.lines.len() == 1 { try!(word(self.writer(), &cmnt.lines[0])); hardbreak(self.writer()) } else { try!(self.ibox(0)); for line in &cmnt.lines { if !line.is_empty() { try!(word(self.writer(), &line[..])); } try!(hardbreak(self.writer())); } self.end() } } comments::BlankLine => { // We need to do at least one, possibly two hardbreaks. let is_semi = match self.writer().last_token() { pp::Token::String(s, _) => ";" == s, _ => false }; if is_semi || self.is_begin() || self.is_end() { try!(hardbreak(self.writer())); } hardbreak(self.writer()) } } } fn next_comment(&mut self) -> Option { let cur_cmnt = self.cur_cmnt_and_lit().cur_cmnt; match *self.comments() { Some(ref cmnts) => { if cur_cmnt < cmnts.len() { Some(cmnts[cur_cmnt].clone()) } else { None } } _ => None } } fn print_literal(&mut self, lit: &ast::Lit) -> io::Result<()> { try!(self.maybe_print_comment(lit.span.lo)); match self.next_lit(lit.span.lo) { Some(ref ltrl) => { return word(self.writer(), &(*ltrl).lit); } _ => () } match lit.node { ast::LitKind::Str(ref st, style) => self.print_string(&st, style), ast::LitKind::Byte(byte) => { let mut res = String::from("b'"); res.extend(ascii::escape_default(byte).map(|c| c as char)); res.push('\''); word(self.writer(), &res[..]) } ast::LitKind::Char(ch) => { let mut res = String::from("'"); res.extend(ch.escape_default()); res.push('\''); word(self.writer(), &res[..]) } ast::LitKind::Int(i, t) => { match t { ast::LitIntType::Signed(st) => { word(self.writer(), &st.val_to_string(i as i64)) } ast::LitIntType::Unsigned(ut) => { word(self.writer(), &ut.val_to_string(i)) } ast::LitIntType::Unsuffixed => { word(self.writer(), &format!("{}", i)) } } } ast::LitKind::Float(ref f, t) => { word(self.writer(), &format!( "{}{}", &f, t.ty_to_string())) } ast::LitKind::FloatUnsuffixed(ref f) => word(self.writer(), &f[..]), ast::LitKind::Bool(val) => { if val { word(self.writer(), "true") } else { word(self.writer(), "false") } } ast::LitKind::ByteStr(ref v) => { let mut escaped: String = String::new(); for &ch in v.iter() { escaped.extend(ascii::escape_default(ch) .map(|c| c as char)); } word(self.writer(), &format!("b\"{}\"", escaped)) } } } fn print_string(&mut self, st: &str, style: ast::StrStyle) -> io::Result<()> { let st = match style { ast::StrStyle::Cooked => { (format!("\"{}\"", st.escape_default())) } ast::StrStyle::Raw(n) => { (format!("r{delim}\"{string}\"{delim}", delim=repeat("#", n), string=st)) } }; word(self.writer(), &st[..]) } fn print_inner_attributes(&mut self, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_either_attributes(attrs, ast::AttrStyle::Inner, false, true) } fn print_inner_attributes_no_trailing_hardbreak(&mut self, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_either_attributes(attrs, ast::AttrStyle::Inner, false, false) } fn print_outer_attributes(&mut self, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_either_attributes(attrs, ast::AttrStyle::Outer, false, true) } fn print_inner_attributes_inline(&mut self, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_either_attributes(attrs, ast::AttrStyle::Inner, true, true) } fn print_outer_attributes_inline(&mut self, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_either_attributes(attrs, ast::AttrStyle::Outer, true, true) } fn print_either_attributes(&mut self, attrs: &[ast::Attribute], kind: ast::AttrStyle, is_inline: bool, trailing_hardbreak: bool) -> io::Result<()> { let mut count = 0; for attr in attrs { if attr.node.style == kind { try!(self.print_attribute_inline(attr, is_inline)); if is_inline { try!(self.nbsp()); } count += 1; } } if count > 0 && trailing_hardbreak && !is_inline { try!(self.hardbreak_if_not_bol()); } Ok(()) } fn print_attribute(&mut self, attr: &ast::Attribute) -> io::Result<()> { self.print_attribute_inline(attr, false) } fn print_attribute_inline(&mut self, attr: &ast::Attribute, is_inline: bool) -> io::Result<()> { if !is_inline { try!(self.hardbreak_if_not_bol()); } try!(self.maybe_print_comment(attr.span.lo)); if attr.node.is_sugared_doc { try!(word(self.writer(), &attr.value_str().unwrap())); hardbreak(self.writer()) } else { match attr.node.style { ast::AttrStyle::Inner => try!(word(self.writer(), "#![")), ast::AttrStyle::Outer => try!(word(self.writer(), "#[")), } try!(self.print_meta_item(&attr.meta())); word(self.writer(), "]") } } fn print_meta_item(&mut self, item: &ast::MetaItem) -> io::Result<()> { try!(self.ibox(INDENT_UNIT)); match item.node { ast::MetaItemKind::Word(ref name) => { try!(word(self.writer(), &name)); } ast::MetaItemKind::NameValue(ref name, ref value) => { try!(self.word_space(&name[..])); try!(self.word_space("=")); try!(self.print_literal(value)); } ast::MetaItemKind::List(ref name, ref items) => { try!(word(self.writer(), &name)); try!(self.popen()); try!(self.commasep(Consistent, &items[..], |s, i| s.print_meta_item(&i))); try!(self.pclose()); } } self.end() } fn space_if_not_bol(&mut self) -> io::Result<()> { if !self.is_bol() { try!(space(self.writer())); } Ok(()) } fn nbsp(&mut self) -> io::Result<()> { word(self.writer(), " ") } } impl<'a> PrintState<'a> for State<'a> { fn writer(&mut self) -> &mut pp::Printer<'a> { &mut self.s } fn boxes(&mut self) -> &mut Vec { &mut self.boxes } fn comments(&mut self) -> &mut Option> { &mut self.comments } fn cur_cmnt_and_lit(&mut self) -> &mut CurrentCommentAndLiteral { &mut self.cur_cmnt_and_lit } fn literals(&self) -> &Option> { &self.literals } } impl<'a> State<'a> { pub fn cbox(&mut self, u: usize) -> io::Result<()> { self.boxes.push(pp::Breaks::Consistent); pp::cbox(&mut self.s, u) } pub fn word_nbsp(&mut self, w: &str) -> io::Result<()> { try!(word(&mut self.s, w)); self.nbsp() } pub fn head(&mut self, w: &str) -> io::Result<()> { // outer-box is consistent try!(self.cbox(INDENT_UNIT)); // head-box is inconsistent try!(self.ibox(w.len() + 1)); // keyword that starts the head if !w.is_empty() { try!(self.word_nbsp(w)); } Ok(()) } pub fn bopen(&mut self) -> io::Result<()> { try!(word(&mut self.s, "{")); self.end() // close the head-box } pub fn bclose_(&mut self, span: codemap::Span, indented: usize) -> io::Result<()> { self.bclose_maybe_open(span, indented, true) } pub fn bclose_maybe_open(&mut self, span: codemap::Span, indented: usize, close_box: bool) -> io::Result<()> { try!(self.maybe_print_comment(span.hi)); try!(self.break_offset_if_not_bol(1, -(indented as isize))); try!(word(&mut self.s, "}")); if close_box { try!(self.end()); // close the outer-box } Ok(()) } pub fn bclose(&mut self, span: codemap::Span) -> io::Result<()> { self.bclose_(span, INDENT_UNIT) } pub fn in_cbox(&self) -> bool { match self.boxes.last() { Some(&last_box) => last_box == pp::Breaks::Consistent, None => false } } pub fn break_offset_if_not_bol(&mut self, n: usize, off: isize) -> io::Result<()> { if !self.is_bol() { break_offset(&mut self.s, n, off) } else { if off != 0 && self.s.last_token().is_hardbreak_tok() { // We do something pretty sketchy here: tuck the nonzero // offset-adjustment we were going to deposit along with the // break into the previous hardbreak. self.s.replace_last_token(pp::hardbreak_tok_offset(off)); } Ok(()) } } // Synthesizes a comment that was not textually present in the original source // file. pub fn synth_comment(&mut self, text: String) -> io::Result<()> { try!(word(&mut self.s, "/*")); try!(space(&mut self.s)); try!(word(&mut self.s, &text[..])); try!(space(&mut self.s)); word(&mut self.s, "*/") } pub fn commasep_cmnt(&mut self, b: Breaks, elts: &[T], mut op: F, mut get_span: G) -> io::Result<()> where F: FnMut(&mut State, &T) -> io::Result<()>, G: FnMut(&T) -> codemap::Span, { try!(self.rbox(0, b)); let len = elts.len(); let mut i = 0; for elt in elts { try!(self.maybe_print_comment(get_span(elt).hi)); try!(op(self, elt)); i += 1; if i < len { try!(word(&mut self.s, ",")); try!(self.maybe_print_trailing_comment(get_span(elt), Some(get_span(&elts[i]).hi))); try!(self.space_if_not_bol()); } } self.end() } pub fn commasep_exprs(&mut self, b: Breaks, exprs: &[P]) -> io::Result<()> { self.commasep_cmnt(b, exprs, |s, e| s.print_expr(&e), |e| e.span) } pub fn print_mod(&mut self, _mod: &ast::Mod, attrs: &[ast::Attribute]) -> io::Result<()> { try!(self.print_inner_attributes(attrs)); for item in &_mod.items { try!(self.print_item(&item)); } Ok(()) } pub fn print_foreign_mod(&mut self, nmod: &ast::ForeignMod, attrs: &[ast::Attribute]) -> io::Result<()> { try!(self.print_inner_attributes(attrs)); for item in &nmod.items { try!(self.print_foreign_item(item)); } Ok(()) } pub fn print_opt_lifetime(&mut self, lifetime: &Option) -> io::Result<()> { if let Some(l) = *lifetime { try!(self.print_lifetime(&l)); try!(self.nbsp()); } Ok(()) } pub fn print_type(&mut self, ty: &ast::Ty) -> io::Result<()> { try!(self.maybe_print_comment(ty.span.lo)); try!(self.ibox(0)); match ty.node { ast::TyKind::Vec(ref ty) => { try!(word(&mut self.s, "[")); try!(self.print_type(&ty)); try!(word(&mut self.s, "]")); } ast::TyKind::Ptr(ref mt) => { try!(word(&mut self.s, "*")); match mt.mutbl { ast::Mutability::Mutable => try!(self.word_nbsp("mut")), ast::Mutability::Immutable => try!(self.word_nbsp("const")), } try!(self.print_type(&mt.ty)); } ast::TyKind::Rptr(ref lifetime, ref mt) => { try!(word(&mut self.s, "&")); try!(self.print_opt_lifetime(lifetime)); try!(self.print_mt(mt)); } ast::TyKind::Tup(ref elts) => { try!(self.popen()); try!(self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(&ty))); if elts.len() == 1 { try!(word(&mut self.s, ",")); } try!(self.pclose()); } ast::TyKind::Paren(ref typ) => { try!(self.popen()); try!(self.print_type(&typ)); try!(self.pclose()); } ast::TyKind::BareFn(ref f) => { let generics = ast::Generics { lifetimes: f.lifetimes.clone(), ty_params: P::empty(), where_clause: ast::WhereClause { id: ast::DUMMY_NODE_ID, predicates: Vec::new(), }, }; try!(self.print_ty_fn(f.abi, f.unsafety, &f.decl, None, &generics, None)); } ast::TyKind::Path(None, ref path) => { try!(self.print_path(path, false, 0)); } ast::TyKind::Path(Some(ref qself), ref path) => { try!(self.print_qpath(path, qself, false)) } ast::TyKind::ObjectSum(ref ty, ref bounds) => { try!(self.print_type(&ty)); try!(self.print_bounds("+", &bounds[..])); } ast::TyKind::PolyTraitRef(ref bounds) => { try!(self.print_bounds("", &bounds[..])); } ast::TyKind::FixedLengthVec(ref ty, ref v) => { try!(word(&mut self.s, "[")); try!(self.print_type(&ty)); try!(word(&mut self.s, "; ")); try!(self.print_expr(&v)); try!(word(&mut self.s, "]")); } ast::TyKind::Typeof(ref e) => { try!(word(&mut self.s, "typeof(")); try!(self.print_expr(&e)); try!(word(&mut self.s, ")")); } ast::TyKind::Infer => { try!(word(&mut self.s, "_")); } ast::TyKind::Mac(ref m) => { try!(self.print_mac(m, token::Paren)); } } self.end() } pub fn print_foreign_item(&mut self, item: &ast::ForeignItem) -> io::Result<()> { try!(self.hardbreak_if_not_bol()); try!(self.maybe_print_comment(item.span.lo)); try!(self.print_outer_attributes(&item.attrs)); match item.node { ast::ForeignItemKind::Fn(ref decl, ref generics) => { try!(self.head("")); try!(self.print_fn(decl, ast::Unsafety::Normal, ast::Constness::NotConst, Abi::Rust, Some(item.ident), generics, None, item.vis)); try!(self.end()); // end head-ibox try!(word(&mut self.s, ";")); self.end() // end the outer fn box } ast::ForeignItemKind::Static(ref t, m) => { try!(self.head(&visibility_qualified(item.vis, "static"))); if m { try!(self.word_space("mut")); } try!(self.print_ident(item.ident)); try!(self.word_space(":")); try!(self.print_type(&t)); try!(word(&mut self.s, ";")); try!(self.end()); // end the head-ibox self.end() // end the outer cbox } } } fn print_associated_const(&mut self, ident: ast::Ident, ty: &ast::Ty, default: Option<&ast::Expr>, vis: ast::Visibility) -> io::Result<()> { try!(word(&mut self.s, &visibility_qualified(vis, ""))); try!(self.word_space("const")); try!(self.print_ident(ident)); try!(self.word_space(":")); try!(self.print_type(ty)); if let Some(expr) = default { try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_expr(expr)); } word(&mut self.s, ";") } fn print_associated_type(&mut self, ident: ast::Ident, bounds: Option<&ast::TyParamBounds>, ty: Option<&ast::Ty>) -> io::Result<()> { try!(self.word_space("type")); try!(self.print_ident(ident)); if let Some(bounds) = bounds { try!(self.print_bounds(":", bounds)); } if let Some(ty) = ty { try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_type(ty)); } word(&mut self.s, ";") } /// Pretty-print an item pub fn print_item(&mut self, item: &ast::Item) -> io::Result<()> { try!(self.hardbreak_if_not_bol()); try!(self.maybe_print_comment(item.span.lo)); try!(self.print_outer_attributes(&item.attrs)); try!(self.ann.pre(self, NodeItem(item))); match item.node { ast::ItemKind::ExternCrate(ref optional_path) => { try!(self.head(&visibility_qualified(item.vis, "extern crate"))); if let Some(p) = *optional_path { let val = p.as_str(); if val.contains("-") { try!(self.print_string(&val, ast::StrStyle::Cooked)); } else { try!(self.print_name(p)); } try!(space(&mut self.s)); try!(word(&mut self.s, "as")); try!(space(&mut self.s)); } try!(self.print_ident(item.ident)); try!(word(&mut self.s, ";")); try!(self.end()); // end inner head-block try!(self.end()); // end outer head-block } ast::ItemKind::Use(ref vp) => { try!(self.head(&visibility_qualified(item.vis, "use"))); try!(self.print_view_path(&vp)); try!(word(&mut self.s, ";")); try!(self.end()); // end inner head-block try!(self.end()); // end outer head-block } ast::ItemKind::Static(ref ty, m, ref expr) => { try!(self.head(&visibility_qualified(item.vis, "static"))); if m == ast::Mutability::Mutable { try!(self.word_space("mut")); } try!(self.print_ident(item.ident)); try!(self.word_space(":")); try!(self.print_type(&ty)); try!(space(&mut self.s)); try!(self.end()); // end the head-ibox try!(self.word_space("=")); try!(self.print_expr(&expr)); try!(word(&mut self.s, ";")); try!(self.end()); // end the outer cbox } ast::ItemKind::Const(ref ty, ref expr) => { try!(self.head(&visibility_qualified(item.vis, "const"))); try!(self.print_ident(item.ident)); try!(self.word_space(":")); try!(self.print_type(&ty)); try!(space(&mut self.s)); try!(self.end()); // end the head-ibox try!(self.word_space("=")); try!(self.print_expr(&expr)); try!(word(&mut self.s, ";")); try!(self.end()); // end the outer cbox } ast::ItemKind::Fn(ref decl, unsafety, constness, abi, ref typarams, ref body) => { try!(self.head("")); try!(self.print_fn( decl, unsafety, constness, abi, Some(item.ident), typarams, None, item.vis )); try!(word(&mut self.s, " ")); try!(self.print_block_with_attrs(&body, &item.attrs)); } ast::ItemKind::Mod(ref _mod) => { try!(self.head(&visibility_qualified(item.vis, "mod"))); try!(self.print_ident(item.ident)); try!(self.nbsp()); try!(self.bopen()); try!(self.print_mod(_mod, &item.attrs)); try!(self.bclose(item.span)); } ast::ItemKind::ForeignMod(ref nmod) => { try!(self.head("extern")); try!(self.word_nbsp(&nmod.abi.to_string())); try!(self.bopen()); try!(self.print_foreign_mod(nmod, &item.attrs)); try!(self.bclose(item.span)); } ast::ItemKind::Ty(ref ty, ref params) => { try!(self.ibox(INDENT_UNIT)); try!(self.ibox(0)); try!(self.word_nbsp(&visibility_qualified(item.vis, "type"))); try!(self.print_ident(item.ident)); try!(self.print_generics(params)); try!(self.end()); // end the inner ibox try!(self.print_where_clause(¶ms.where_clause)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_type(&ty)); try!(word(&mut self.s, ";")); try!(self.end()); // end the outer ibox } ast::ItemKind::Enum(ref enum_definition, ref params) => { try!(self.print_enum_def( enum_definition, params, item.ident, item.span, item.vis )); } ast::ItemKind::Struct(ref struct_def, ref generics) => { try!(self.head(&visibility_qualified(item.vis,"struct"))); try!(self.print_struct(&struct_def, generics, item.ident, item.span, true)); } ast::ItemKind::DefaultImpl(unsafety, ref trait_ref) => { try!(self.head("")); try!(self.print_visibility(item.vis)); try!(self.print_unsafety(unsafety)); try!(self.word_nbsp("impl")); try!(self.print_trait_ref(trait_ref)); try!(space(&mut self.s)); try!(self.word_space("for")); try!(self.word_space("..")); try!(self.bopen()); try!(self.bclose(item.span)); } ast::ItemKind::Impl(unsafety, polarity, ref generics, ref opt_trait, ref ty, ref impl_items) => { try!(self.head("")); try!(self.print_visibility(item.vis)); try!(self.print_unsafety(unsafety)); try!(self.word_nbsp("impl")); if generics.is_parameterized() { try!(self.print_generics(generics)); try!(space(&mut self.s)); } match polarity { ast::ImplPolarity::Negative => { try!(word(&mut self.s, "!")); }, _ => {} } match *opt_trait { Some(ref t) => { try!(self.print_trait_ref(t)); try!(space(&mut self.s)); try!(self.word_space("for")); } None => {} } try!(self.print_type(&ty)); try!(self.print_where_clause(&generics.where_clause)); try!(space(&mut self.s)); try!(self.bopen()); try!(self.print_inner_attributes(&item.attrs)); for impl_item in impl_items { try!(self.print_impl_item(impl_item)); } try!(self.bclose(item.span)); } ast::ItemKind::Trait(unsafety, ref generics, ref bounds, ref trait_items) => { try!(self.head("")); try!(self.print_visibility(item.vis)); try!(self.print_unsafety(unsafety)); try!(self.word_nbsp("trait")); try!(self.print_ident(item.ident)); try!(self.print_generics(generics)); let mut real_bounds = Vec::with_capacity(bounds.len()); for b in bounds.iter() { if let TraitTyParamBound(ref ptr, ast::TraitBoundModifier::Maybe) = *b { try!(space(&mut self.s)); try!(self.word_space("for ?")); try!(self.print_trait_ref(&ptr.trait_ref)); } else { real_bounds.push(b.clone()); } } try!(self.print_bounds(":", &real_bounds[..])); try!(self.print_where_clause(&generics.where_clause)); try!(word(&mut self.s, " ")); try!(self.bopen()); for trait_item in trait_items { try!(self.print_trait_item(trait_item)); } try!(self.bclose(item.span)); } ast::ItemKind::Mac(codemap::Spanned { ref node, .. }) => { try!(self.print_visibility(item.vis)); try!(self.print_path(&node.path, false, 0)); try!(word(&mut self.s, "! ")); try!(self.print_ident(item.ident)); try!(self.cbox(INDENT_UNIT)); try!(self.popen()); try!(self.print_tts(&node.tts[..])); try!(self.pclose()); try!(word(&mut self.s, ";")); try!(self.end()); } } self.ann.post(self, NodeItem(item)) } fn print_trait_ref(&mut self, t: &ast::TraitRef) -> io::Result<()> { self.print_path(&t.path, false, 0) } fn print_formal_lifetime_list(&mut self, lifetimes: &[ast::LifetimeDef]) -> io::Result<()> { if !lifetimes.is_empty() { try!(word(&mut self.s, "for<")); let mut comma = false; for lifetime_def in lifetimes { if comma { try!(self.word_space(",")) } try!(self.print_lifetime_def(lifetime_def)); comma = true; } try!(word(&mut self.s, ">")); } Ok(()) } fn print_poly_trait_ref(&mut self, t: &ast::PolyTraitRef) -> io::Result<()> { try!(self.print_formal_lifetime_list(&t.bound_lifetimes)); self.print_trait_ref(&t.trait_ref) } pub fn print_enum_def(&mut self, enum_definition: &ast::EnumDef, generics: &ast::Generics, ident: ast::Ident, span: codemap::Span, visibility: ast::Visibility) -> io::Result<()> { try!(self.head(&visibility_qualified(visibility, "enum"))); try!(self.print_ident(ident)); try!(self.print_generics(generics)); try!(self.print_where_clause(&generics.where_clause)); try!(space(&mut self.s)); self.print_variants(&enum_definition.variants, span) } pub fn print_variants(&mut self, variants: &[ast::Variant], span: codemap::Span) -> io::Result<()> { try!(self.bopen()); for v in variants { try!(self.space_if_not_bol()); try!(self.maybe_print_comment(v.span.lo)); try!(self.print_outer_attributes(&v.node.attrs)); try!(self.ibox(INDENT_UNIT)); try!(self.print_variant(v)); try!(word(&mut self.s, ",")); try!(self.end()); try!(self.maybe_print_trailing_comment(v.span, None)); } self.bclose(span) } pub fn print_visibility(&mut self, vis: ast::Visibility) -> io::Result<()> { match vis { ast::Visibility::Public => self.word_nbsp("pub"), ast::Visibility::Inherited => Ok(()) } } pub fn print_struct(&mut self, struct_def: &ast::VariantData, generics: &ast::Generics, ident: ast::Ident, span: codemap::Span, print_finalizer: bool) -> io::Result<()> { try!(self.print_ident(ident)); try!(self.print_generics(generics)); if !struct_def.is_struct() { if struct_def.is_tuple() { try!(self.popen()); try!(self.commasep( Inconsistent, struct_def.fields(), |s, field| { match field.node.kind { ast::NamedField(..) => panic!("unexpected named field"), ast::UnnamedField(vis) => { try!(s.print_visibility(vis)); try!(s.maybe_print_comment(field.span.lo)); s.print_type(&field.node.ty) } } } )); try!(self.pclose()); } try!(self.print_where_clause(&generics.where_clause)); if print_finalizer { try!(word(&mut self.s, ";")); } try!(self.end()); self.end() // close the outer-box } else { try!(self.print_where_clause(&generics.where_clause)); try!(self.nbsp()); try!(self.bopen()); try!(self.hardbreak_if_not_bol()); for field in struct_def.fields() { match field.node.kind { ast::UnnamedField(..) => panic!("unexpected unnamed field"), ast::NamedField(ident, visibility) => { try!(self.hardbreak_if_not_bol()); try!(self.maybe_print_comment(field.span.lo)); try!(self.print_outer_attributes(&field.node.attrs)); try!(self.print_visibility(visibility)); try!(self.print_ident(ident)); try!(self.word_nbsp(":")); try!(self.print_type(&field.node.ty)); try!(word(&mut self.s, ",")); } } } self.bclose(span) } } /// This doesn't deserve to be called "pretty" printing, but it should be /// meaning-preserving. A quick hack that might help would be to look at the /// spans embedded in the TTs to decide where to put spaces and newlines. /// But it'd be better to parse these according to the grammar of the /// appropriate macro, transcribe back into the grammar we just parsed from, /// and then pretty-print the resulting AST nodes (so, e.g., we print /// expression arguments as expressions). It can be done! I think. pub fn print_tt(&mut self, tt: &ast::TokenTree) -> io::Result<()> { match *tt { TokenTree::Token(_, ref tk) => { try!(word(&mut self.s, &token_to_string(tk))); match *tk { parse::token::DocComment(..) => { hardbreak(&mut self.s) } _ => Ok(()) } } TokenTree::Delimited(_, ref delimed) => { try!(word(&mut self.s, &token_to_string(&delimed.open_token()))); try!(space(&mut self.s)); try!(self.print_tts(&delimed.tts)); try!(space(&mut self.s)); word(&mut self.s, &token_to_string(&delimed.close_token())) }, TokenTree::Sequence(_, ref seq) => { try!(word(&mut self.s, "$(")); for tt_elt in &seq.tts { try!(self.print_tt(tt_elt)); } try!(word(&mut self.s, ")")); match seq.separator { Some(ref tk) => { try!(word(&mut self.s, &token_to_string(tk))); } None => {}, } match seq.op { ast::KleeneOp::ZeroOrMore => word(&mut self.s, "*"), ast::KleeneOp::OneOrMore => word(&mut self.s, "+"), } } } } pub fn print_tts(&mut self, tts: &[ast::TokenTree]) -> io::Result<()> { try!(self.ibox(0)); let mut suppress_space = false; for (i, tt) in tts.iter().enumerate() { if i != 0 && !suppress_space { try!(space(&mut self.s)); } try!(self.print_tt(tt)); // There should be no space between the module name and the following `::` in paths, // otherwise imported macros get re-parsed from crate metadata incorrectly (#20701) suppress_space = match *tt { TokenTree::Token(_, token::Ident(_, token::ModName)) | TokenTree::Token(_, token::MatchNt(_, _, _, token::ModName)) | TokenTree::Token(_, token::SubstNt(_, token::ModName)) => true, _ => false } } self.end() } pub fn print_variant(&mut self, v: &ast::Variant) -> io::Result<()> { try!(self.head("")); let generics = ast::Generics::default(); try!(self.print_struct(&v.node.data, &generics, v.node.name, v.span, false)); match v.node.disr_expr { Some(ref d) => { try!(space(&mut self.s)); try!(self.word_space("=")); self.print_expr(&d) } _ => Ok(()) } } pub fn print_method_sig(&mut self, ident: ast::Ident, m: &ast::MethodSig, vis: ast::Visibility) -> io::Result<()> { self.print_fn(&m.decl, m.unsafety, m.constness, m.abi, Some(ident), &m.generics, Some(&m.explicit_self.node), vis) } pub fn print_trait_item(&mut self, ti: &ast::TraitItem) -> io::Result<()> { try!(self.ann.pre(self, NodeSubItem(ti.id))); try!(self.hardbreak_if_not_bol()); try!(self.maybe_print_comment(ti.span.lo)); try!(self.print_outer_attributes(&ti.attrs)); match ti.node { ast::TraitItemKind::Const(ref ty, ref default) => { try!(self.print_associated_const(ti.ident, &ty, default.as_ref().map(|expr| &**expr), ast::Visibility::Inherited)); } ast::TraitItemKind::Method(ref sig, ref body) => { if body.is_some() { try!(self.head("")); } try!(self.print_method_sig(ti.ident, sig, ast::Visibility::Inherited)); if let Some(ref body) = *body { try!(self.nbsp()); try!(self.print_block_with_attrs(body, &ti.attrs)); } else { try!(word(&mut self.s, ";")); } } ast::TraitItemKind::Type(ref bounds, ref default) => { try!(self.print_associated_type(ti.ident, Some(bounds), default.as_ref().map(|ty| &**ty))); } } self.ann.post(self, NodeSubItem(ti.id)) } pub fn print_impl_item(&mut self, ii: &ast::ImplItem) -> io::Result<()> { try!(self.ann.pre(self, NodeSubItem(ii.id))); try!(self.hardbreak_if_not_bol()); try!(self.maybe_print_comment(ii.span.lo)); try!(self.print_outer_attributes(&ii.attrs)); if let ast::Defaultness::Default = ii.defaultness { try!(self.word_nbsp("default")); } match ii.node { ast::ImplItemKind::Const(ref ty, ref expr) => { try!(self.print_associated_const(ii.ident, &ty, Some(&expr), ii.vis)); } ast::ImplItemKind::Method(ref sig, ref body) => { try!(self.head("")); try!(self.print_method_sig(ii.ident, sig, ii.vis)); try!(self.nbsp()); try!(self.print_block_with_attrs(body, &ii.attrs)); } ast::ImplItemKind::Type(ref ty) => { try!(self.print_associated_type(ii.ident, None, Some(ty))); } ast::ImplItemKind::Macro(codemap::Spanned { ref node, .. }) => { // code copied from ItemKind::Mac: try!(self.print_path(&node.path, false, 0)); try!(word(&mut self.s, "! ")); try!(self.cbox(INDENT_UNIT)); try!(self.popen()); try!(self.print_tts(&node.tts[..])); try!(self.pclose()); try!(word(&mut self.s, ";")); try!(self.end()) } } self.ann.post(self, NodeSubItem(ii.id)) } pub fn print_stmt(&mut self, st: &ast::Stmt) -> io::Result<()> { try!(self.maybe_print_comment(st.span.lo)); match st.node { ast::StmtKind::Decl(ref decl, _) => { try!(self.print_decl(&decl)); } ast::StmtKind::Expr(ref expr, _) => { try!(self.space_if_not_bol()); try!(self.print_expr_outer_attr_style(&expr, false)); } ast::StmtKind::Semi(ref expr, _) => { try!(self.space_if_not_bol()); try!(self.print_expr_outer_attr_style(&expr, false)); try!(word(&mut self.s, ";")); } ast::StmtKind::Mac(ref mac, style, ref attrs) => { try!(self.space_if_not_bol()); try!(self.print_outer_attributes(attrs.as_attr_slice())); let delim = match style { ast::MacStmtStyle::Braces => token::Brace, _ => token::Paren }; try!(self.print_mac(&mac, delim)); match style { ast::MacStmtStyle::Braces => {} _ => try!(word(&mut self.s, ";")), } } } if parse::classify::stmt_ends_with_semi(&st.node) { try!(word(&mut self.s, ";")); } self.maybe_print_trailing_comment(st.span, None) } pub fn print_block(&mut self, blk: &ast::Block) -> io::Result<()> { self.print_block_with_attrs(blk, &[]) } pub fn print_block_unclosed(&mut self, blk: &ast::Block) -> io::Result<()> { self.print_block_unclosed_indent(blk, INDENT_UNIT) } pub fn print_block_unclosed_with_attrs(&mut self, blk: &ast::Block, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_block_maybe_unclosed(blk, INDENT_UNIT, attrs, false) } pub fn print_block_unclosed_indent(&mut self, blk: &ast::Block, indented: usize) -> io::Result<()> { self.print_block_maybe_unclosed(blk, indented, &[], false) } pub fn print_block_with_attrs(&mut self, blk: &ast::Block, attrs: &[ast::Attribute]) -> io::Result<()> { self.print_block_maybe_unclosed(blk, INDENT_UNIT, attrs, true) } pub fn print_block_maybe_unclosed(&mut self, blk: &ast::Block, indented: usize, attrs: &[ast::Attribute], close_box: bool) -> io::Result<()> { match blk.rules { BlockCheckMode::Unsafe(..) => try!(self.word_space("unsafe")), BlockCheckMode::Default => () } try!(self.maybe_print_comment(blk.span.lo)); try!(self.ann.pre(self, NodeBlock(blk))); try!(self.bopen()); try!(self.print_inner_attributes(attrs)); for st in &blk.stmts { try!(self.print_stmt(st)); } match blk.expr { Some(ref expr) => { try!(self.space_if_not_bol()); try!(self.print_expr_outer_attr_style(&expr, false)); try!(self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi))); } _ => () } try!(self.bclose_maybe_open(blk.span, indented, close_box)); self.ann.post(self, NodeBlock(blk)) } fn print_else(&mut self, els: Option<&ast::Expr>) -> io::Result<()> { match els { Some(_else) => { match _else.node { // "another else-if" ast::ExprKind::If(ref i, ref then, ref e) => { try!(self.cbox(INDENT_UNIT - 1)); try!(self.ibox(0)); try!(word(&mut self.s, " else if ")); try!(self.print_expr(&i)); try!(space(&mut self.s)); try!(self.print_block(&then)); self.print_else(e.as_ref().map(|e| &**e)) } // "another else-if-let" ast::ExprKind::IfLet(ref pat, ref expr, ref then, ref e) => { try!(self.cbox(INDENT_UNIT - 1)); try!(self.ibox(0)); try!(word(&mut self.s, " else if let ")); try!(self.print_pat(&pat)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_expr(&expr)); try!(space(&mut self.s)); try!(self.print_block(&then)); self.print_else(e.as_ref().map(|e| &**e)) } // "final else" ast::ExprKind::Block(ref b) => { try!(self.cbox(INDENT_UNIT - 1)); try!(self.ibox(0)); try!(word(&mut self.s, " else ")); self.print_block(&b) } // BLEAH, constraints would be great here _ => { panic!("print_if saw if with weird alternative"); } } } _ => Ok(()) } } pub fn print_if(&mut self, test: &ast::Expr, blk: &ast::Block, elseopt: Option<&ast::Expr>) -> io::Result<()> { try!(self.head("if")); try!(self.print_expr(test)); try!(space(&mut self.s)); try!(self.print_block(blk)); self.print_else(elseopt) } pub fn print_if_let(&mut self, pat: &ast::Pat, expr: &ast::Expr, blk: &ast::Block, elseopt: Option<&ast::Expr>) -> io::Result<()> { try!(self.head("if let")); try!(self.print_pat(pat)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_expr(expr)); try!(space(&mut self.s)); try!(self.print_block(blk)); self.print_else(elseopt) } pub fn print_mac(&mut self, m: &ast::Mac, delim: token::DelimToken) -> io::Result<()> { try!(self.print_path(&m.node.path, false, 0)); try!(word(&mut self.s, "!")); match delim { token::Paren => try!(self.popen()), token::Bracket => try!(word(&mut self.s, "[")), token::Brace => { try!(self.head("")); try!(self.bopen()); } } try!(self.print_tts(&m.node.tts)); match delim { token::Paren => self.pclose(), token::Bracket => word(&mut self.s, "]"), token::Brace => self.bclose(m.span), } } fn print_call_post(&mut self, args: &[P]) -> io::Result<()> { try!(self.popen()); try!(self.commasep_exprs(Inconsistent, args)); self.pclose() } pub fn check_expr_bin_needs_paren(&mut self, sub_expr: &ast::Expr, binop: ast::BinOp) -> bool { match sub_expr.node { ast::ExprKind::Binary(ref sub_op, _, _) => { if AssocOp::from_ast_binop(sub_op.node).precedence() < AssocOp::from_ast_binop(binop.node).precedence() { true } else { false } } _ => true } } pub fn print_expr_maybe_paren(&mut self, expr: &ast::Expr) -> io::Result<()> { let needs_par = needs_parentheses(expr); if needs_par { try!(self.popen()); } try!(self.print_expr(expr)); if needs_par { try!(self.pclose()); } Ok(()) } fn print_expr_in_place(&mut self, place: &ast::Expr, expr: &ast::Expr) -> io::Result<()> { try!(self.print_expr_maybe_paren(place)); try!(space(&mut self.s)); try!(self.word_space("<-")); self.print_expr_maybe_paren(expr) } fn print_expr_vec(&mut self, exprs: &[P], attrs: &[Attribute]) -> io::Result<()> { try!(self.ibox(INDENT_UNIT)); try!(word(&mut self.s, "[")); try!(self.print_inner_attributes_inline(attrs)); try!(self.commasep_exprs(Inconsistent, &exprs[..])); try!(word(&mut self.s, "]")); self.end() } fn print_expr_repeat(&mut self, element: &ast::Expr, count: &ast::Expr, attrs: &[Attribute]) -> io::Result<()> { try!(self.ibox(INDENT_UNIT)); try!(word(&mut self.s, "[")); try!(self.print_inner_attributes_inline(attrs)); try!(self.print_expr(element)); try!(self.word_space(";")); try!(self.print_expr(count)); try!(word(&mut self.s, "]")); self.end() } fn print_expr_struct(&mut self, path: &ast::Path, fields: &[ast::Field], wth: &Option>, attrs: &[Attribute]) -> io::Result<()> { try!(self.print_path(path, true, 0)); try!(word(&mut self.s, "{")); try!(self.print_inner_attributes_inline(attrs)); try!(self.commasep_cmnt( Consistent, &fields[..], |s, field| { try!(s.ibox(INDENT_UNIT)); try!(s.print_ident(field.ident.node)); try!(s.word_space(":")); try!(s.print_expr(&field.expr)); s.end() }, |f| f.span)); match *wth { Some(ref expr) => { try!(self.ibox(INDENT_UNIT)); if !fields.is_empty() { try!(word(&mut self.s, ",")); try!(space(&mut self.s)); } try!(word(&mut self.s, "..")); try!(self.print_expr(&expr)); try!(self.end()); } _ => if !fields.is_empty() { try!(word(&mut self.s, ",")) } } try!(word(&mut self.s, "}")); Ok(()) } fn print_expr_tup(&mut self, exprs: &[P], attrs: &[Attribute]) -> io::Result<()> { try!(self.popen()); try!(self.print_inner_attributes_inline(attrs)); try!(self.commasep_exprs(Inconsistent, &exprs[..])); if exprs.len() == 1 { try!(word(&mut self.s, ",")); } self.pclose() } fn print_expr_call(&mut self, func: &ast::Expr, args: &[P]) -> io::Result<()> { try!(self.print_expr_maybe_paren(func)); self.print_call_post(args) } fn print_expr_method_call(&mut self, ident: ast::SpannedIdent, tys: &[P], args: &[P]) -> io::Result<()> { let base_args = &args[1..]; try!(self.print_expr(&args[0])); try!(word(&mut self.s, ".")); try!(self.print_ident(ident.node)); if !tys.is_empty() { try!(word(&mut self.s, "::<")); try!(self.commasep(Inconsistent, tys, |s, ty| s.print_type(&ty))); try!(word(&mut self.s, ">")); } self.print_call_post(base_args) } fn print_expr_binary(&mut self, op: ast::BinOp, lhs: &ast::Expr, rhs: &ast::Expr) -> io::Result<()> { if self.check_expr_bin_needs_paren(lhs, op) { try!(self.print_expr_maybe_paren(lhs)); } else { try!(self.print_expr(lhs)); } try!(space(&mut self.s)); try!(self.word_space(op.node.to_string())); if self.check_expr_bin_needs_paren(rhs, op) { self.print_expr_maybe_paren(rhs) } else { self.print_expr(rhs) } } fn print_expr_unary(&mut self, op: ast::UnOp, expr: &ast::Expr) -> io::Result<()> { try!(word(&mut self.s, ast::UnOp::to_string(op))); self.print_expr_maybe_paren(expr) } fn print_expr_addr_of(&mut self, mutability: ast::Mutability, expr: &ast::Expr) -> io::Result<()> { try!(word(&mut self.s, "&")); try!(self.print_mutability(mutability)); self.print_expr_maybe_paren(expr) } pub fn print_expr(&mut self, expr: &ast::Expr) -> io::Result<()> { self.print_expr_outer_attr_style(expr, true) } fn print_expr_outer_attr_style(&mut self, expr: &ast::Expr, is_inline: bool) -> io::Result<()> { try!(self.maybe_print_comment(expr.span.lo)); let attrs = expr.attrs.as_attr_slice(); if is_inline { try!(self.print_outer_attributes_inline(attrs)); } else { try!(self.print_outer_attributes(attrs)); } try!(self.ibox(INDENT_UNIT)); try!(self.ann.pre(self, NodeExpr(expr))); match expr.node { ast::ExprKind::Box(ref expr) => { try!(self.word_space("box")); try!(self.print_expr(expr)); } ast::ExprKind::InPlace(ref place, ref expr) => { try!(self.print_expr_in_place(place, expr)); } ast::ExprKind::Vec(ref exprs) => { try!(self.print_expr_vec(&exprs[..], attrs)); } ast::ExprKind::Repeat(ref element, ref count) => { try!(self.print_expr_repeat(&element, &count, attrs)); } ast::ExprKind::Struct(ref path, ref fields, ref wth) => { try!(self.print_expr_struct(path, &fields[..], wth, attrs)); } ast::ExprKind::Tup(ref exprs) => { try!(self.print_expr_tup(&exprs[..], attrs)); } ast::ExprKind::Call(ref func, ref args) => { try!(self.print_expr_call(&func, &args[..])); } ast::ExprKind::MethodCall(ident, ref tys, ref args) => { try!(self.print_expr_method_call(ident, &tys[..], &args[..])); } ast::ExprKind::Binary(op, ref lhs, ref rhs) => { try!(self.print_expr_binary(op, &lhs, &rhs)); } ast::ExprKind::Unary(op, ref expr) => { try!(self.print_expr_unary(op, &expr)); } ast::ExprKind::AddrOf(m, ref expr) => { try!(self.print_expr_addr_of(m, &expr)); } ast::ExprKind::Lit(ref lit) => { try!(self.print_literal(&lit)); } ast::ExprKind::Cast(ref expr, ref ty) => { if let ast::ExprKind::Cast(..) = expr.node { try!(self.print_expr(&expr)); } else { try!(self.print_expr_maybe_paren(&expr)); } try!(space(&mut self.s)); try!(self.word_space("as")); try!(self.print_type(&ty)); } ast::ExprKind::Type(ref expr, ref ty) => { try!(self.print_expr(&expr)); try!(self.word_space(":")); try!(self.print_type(&ty)); } ast::ExprKind::If(ref test, ref blk, ref elseopt) => { try!(self.print_if(&test, &blk, elseopt.as_ref().map(|e| &**e))); } ast::ExprKind::IfLet(ref pat, ref expr, ref blk, ref elseopt) => { try!(self.print_if_let(&pat, &expr, &blk, elseopt.as_ref().map(|e| &**e))); } ast::ExprKind::While(ref test, ref blk, opt_ident) => { if let Some(ident) = opt_ident { try!(self.print_ident(ident)); try!(self.word_space(":")); } try!(self.head("while")); try!(self.print_expr(&test)); try!(space(&mut self.s)); try!(self.print_block_with_attrs(&blk, attrs)); } ast::ExprKind::WhileLet(ref pat, ref expr, ref blk, opt_ident) => { if let Some(ident) = opt_ident { try!(self.print_ident(ident)); try!(self.word_space(":")); } try!(self.head("while let")); try!(self.print_pat(&pat)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_expr(&expr)); try!(space(&mut self.s)); try!(self.print_block_with_attrs(&blk, attrs)); } ast::ExprKind::ForLoop(ref pat, ref iter, ref blk, opt_ident) => { if let Some(ident) = opt_ident { try!(self.print_ident(ident)); try!(self.word_space(":")); } try!(self.head("for")); try!(self.print_pat(&pat)); try!(space(&mut self.s)); try!(self.word_space("in")); try!(self.print_expr(&iter)); try!(space(&mut self.s)); try!(self.print_block_with_attrs(&blk, attrs)); } ast::ExprKind::Loop(ref blk, opt_ident) => { if let Some(ident) = opt_ident { try!(self.print_ident(ident)); try!(self.word_space(":")); } try!(self.head("loop")); try!(space(&mut self.s)); try!(self.print_block_with_attrs(&blk, attrs)); } ast::ExprKind::Match(ref expr, ref arms) => { try!(self.cbox(INDENT_UNIT)); try!(self.ibox(4)); try!(self.word_nbsp("match")); try!(self.print_expr(&expr)); try!(space(&mut self.s)); try!(self.bopen()); try!(self.print_inner_attributes_no_trailing_hardbreak(attrs)); for arm in arms { try!(self.print_arm(arm)); } try!(self.bclose_(expr.span, INDENT_UNIT)); } ast::ExprKind::Closure(capture_clause, ref decl, ref body) => { try!(self.print_capture_clause(capture_clause)); try!(self.print_fn_block_args(&decl)); try!(space(&mut self.s)); let default_return = match decl.output { ast::FunctionRetTy::Default(..) => true, _ => false }; if !default_return || !body.stmts.is_empty() || body.expr.is_none() { try!(self.print_block_unclosed(&body)); } else { // we extract the block, so as not to create another set of boxes let i_expr = body.expr.as_ref().unwrap(); match i_expr.node { ast::ExprKind::Block(ref blk) => { try!(self.print_block_unclosed_with_attrs( &blk, i_expr.attrs.as_attr_slice())); } _ => { // this is a bare expression try!(self.print_expr(&i_expr)); try!(self.end()); // need to close a box } } } // a box will be closed by print_expr, but we didn't want an overall // wrapper so we closed the corresponding opening. so create an // empty box to satisfy the close. try!(self.ibox(0)); } ast::ExprKind::Block(ref blk) => { // containing cbox, will be closed by print-block at } try!(self.cbox(INDENT_UNIT)); // head-box, will be closed by print-block after { try!(self.ibox(0)); try!(self.print_block_with_attrs(&blk, attrs)); } ast::ExprKind::Assign(ref lhs, ref rhs) => { try!(self.print_expr(&lhs)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_expr(&rhs)); } ast::ExprKind::AssignOp(op, ref lhs, ref rhs) => { try!(self.print_expr(&lhs)); try!(space(&mut self.s)); try!(word(&mut self.s, op.node.to_string())); try!(self.word_space("=")); try!(self.print_expr(&rhs)); } ast::ExprKind::Field(ref expr, id) => { try!(self.print_expr(&expr)); try!(word(&mut self.s, ".")); try!(self.print_ident(id.node)); } ast::ExprKind::TupField(ref expr, id) => { try!(self.print_expr(&expr)); try!(word(&mut self.s, ".")); try!(self.print_usize(id.node)); } ast::ExprKind::Index(ref expr, ref index) => { try!(self.print_expr(&expr)); try!(word(&mut self.s, "[")); try!(self.print_expr(&index)); try!(word(&mut self.s, "]")); } ast::ExprKind::Range(ref start, ref end, limits) => { if let &Some(ref e) = start { try!(self.print_expr(&e)); } if limits == ast::RangeLimits::HalfOpen { try!(word(&mut self.s, "..")); } else { try!(word(&mut self.s, "...")); } if let &Some(ref e) = end { try!(self.print_expr(&e)); } } ast::ExprKind::Path(None, ref path) => { try!(self.print_path(path, true, 0)) } ast::ExprKind::Path(Some(ref qself), ref path) => { try!(self.print_qpath(path, qself, true)) } ast::ExprKind::Break(opt_ident) => { try!(word(&mut self.s, "break")); try!(space(&mut self.s)); if let Some(ident) = opt_ident { try!(self.print_ident(ident.node)); try!(space(&mut self.s)); } } ast::ExprKind::Again(opt_ident) => { try!(word(&mut self.s, "continue")); try!(space(&mut self.s)); if let Some(ident) = opt_ident { try!(self.print_ident(ident.node)); try!(space(&mut self.s)) } } ast::ExprKind::Ret(ref result) => { try!(word(&mut self.s, "return")); match *result { Some(ref expr) => { try!(word(&mut self.s, " ")); try!(self.print_expr(&expr)); } _ => () } } ast::ExprKind::InlineAsm(ref a) => { try!(word(&mut self.s, "asm!")); try!(self.popen()); try!(self.print_string(&a.asm, a.asm_str_style)); try!(self.word_space(":")); try!(self.commasep(Inconsistent, &a.outputs, |s, out| { match out.constraint.slice_shift_char() { Some(('=', operand)) if out.is_rw => { try!(s.print_string(&format!("+{}", operand), ast::StrStyle::Cooked)) } _ => try!(s.print_string(&out.constraint, ast::StrStyle::Cooked)) } try!(s.popen()); try!(s.print_expr(&out.expr)); try!(s.pclose()); Ok(()) })); try!(space(&mut self.s)); try!(self.word_space(":")); try!(self.commasep(Inconsistent, &a.inputs, |s, &(ref co, ref o)| { try!(s.print_string(&co, ast::StrStyle::Cooked)); try!(s.popen()); try!(s.print_expr(&o)); try!(s.pclose()); Ok(()) })); try!(space(&mut self.s)); try!(self.word_space(":")); try!(self.commasep(Inconsistent, &a.clobbers, |s, co| { try!(s.print_string(&co, ast::StrStyle::Cooked)); Ok(()) })); let mut options = vec!(); if a.volatile { options.push("volatile"); } if a.alignstack { options.push("alignstack"); } if a.dialect == ast::AsmDialect::Intel { options.push("intel"); } if !options.is_empty() { try!(space(&mut self.s)); try!(self.word_space(":")); try!(self.commasep(Inconsistent, &options, |s, &co| { try!(s.print_string(co, ast::StrStyle::Cooked)); Ok(()) })); } try!(self.pclose()); } ast::ExprKind::Mac(ref m) => try!(self.print_mac(m, token::Paren)), ast::ExprKind::Paren(ref e) => { try!(self.popen()); try!(self.print_inner_attributes_inline(attrs)); try!(self.print_expr(&e)); try!(self.pclose()); }, ast::ExprKind::Try(ref e) => { try!(self.print_expr(e)); try!(word(&mut self.s, "?")) } } try!(self.ann.post(self, NodeExpr(expr))); self.end() } pub fn print_local_decl(&mut self, loc: &ast::Local) -> io::Result<()> { try!(self.print_pat(&loc.pat)); if let Some(ref ty) = loc.ty { try!(self.word_space(":")); try!(self.print_type(&ty)); } Ok(()) } pub fn print_decl(&mut self, decl: &ast::Decl) -> io::Result<()> { try!(self.maybe_print_comment(decl.span.lo)); match decl.node { ast::DeclKind::Local(ref loc) => { try!(self.print_outer_attributes(loc.attrs.as_attr_slice())); try!(self.space_if_not_bol()); try!(self.ibox(INDENT_UNIT)); try!(self.word_nbsp("let")); try!(self.ibox(INDENT_UNIT)); try!(self.print_local_decl(&loc)); try!(self.end()); if let Some(ref init) = loc.init { try!(self.nbsp()); try!(self.word_space("=")); try!(self.print_expr(&init)); } self.end() } ast::DeclKind::Item(ref item) => self.print_item(&item) } } pub fn print_ident(&mut self, ident: ast::Ident) -> io::Result<()> { try!(word(&mut self.s, &ident.name.as_str())); self.ann.post(self, NodeIdent(&ident)) } pub fn print_usize(&mut self, i: usize) -> io::Result<()> { word(&mut self.s, &i.to_string()) } pub fn print_name(&mut self, name: ast::Name) -> io::Result<()> { try!(word(&mut self.s, &name.as_str())); self.ann.post(self, NodeName(&name)) } pub fn print_for_decl(&mut self, loc: &ast::Local, coll: &ast::Expr) -> io::Result<()> { try!(self.print_local_decl(loc)); try!(space(&mut self.s)); try!(self.word_space("in")); self.print_expr(coll) } fn print_path(&mut self, path: &ast::Path, colons_before_params: bool, depth: usize) -> io::Result<()> { try!(self.maybe_print_comment(path.span.lo)); let mut first = !path.global; for segment in &path.segments[..path.segments.len()-depth] { if first { first = false } else { try!(word(&mut self.s, "::")) } try!(self.print_ident(segment.identifier)); try!(self.print_path_parameters(&segment.parameters, colons_before_params)); } Ok(()) } fn print_qpath(&mut self, path: &ast::Path, qself: &ast::QSelf, colons_before_params: bool) -> io::Result<()> { try!(word(&mut self.s, "<")); try!(self.print_type(&qself.ty)); if qself.position > 0 { try!(space(&mut self.s)); try!(self.word_space("as")); let depth = path.segments.len() - qself.position; try!(self.print_path(&path, false, depth)); } try!(word(&mut self.s, ">")); try!(word(&mut self.s, "::")); let item_segment = path.segments.last().unwrap(); try!(self.print_ident(item_segment.identifier)); self.print_path_parameters(&item_segment.parameters, colons_before_params) } fn print_path_parameters(&mut self, parameters: &ast::PathParameters, colons_before_params: bool) -> io::Result<()> { if parameters.is_empty() { return Ok(()); } if colons_before_params { try!(word(&mut self.s, "::")) } match *parameters { ast::PathParameters::AngleBracketed(ref data) => { try!(word(&mut self.s, "<")); let mut comma = false; for lifetime in &data.lifetimes { if comma { try!(self.word_space(",")) } try!(self.print_lifetime(lifetime)); comma = true; } if !data.types.is_empty() { if comma { try!(self.word_space(",")) } try!(self.commasep( Inconsistent, &data.types, |s, ty| s.print_type(&ty))); comma = true; } for binding in data.bindings.iter() { if comma { try!(self.word_space(",")) } try!(self.print_ident(binding.ident)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_type(&binding.ty)); comma = true; } try!(word(&mut self.s, ">")) } ast::PathParameters::Parenthesized(ref data) => { try!(word(&mut self.s, "(")); try!(self.commasep( Inconsistent, &data.inputs, |s, ty| s.print_type(&ty))); try!(word(&mut self.s, ")")); match data.output { None => { } Some(ref ty) => { try!(self.space_if_not_bol()); try!(self.word_space("->")); try!(self.print_type(&ty)); } } } } Ok(()) } pub fn print_pat(&mut self, pat: &ast::Pat) -> io::Result<()> { try!(self.maybe_print_comment(pat.span.lo)); try!(self.ann.pre(self, NodePat(pat))); /* Pat isn't normalized, but the beauty of it is that it doesn't matter */ match pat.node { PatKind::Wild => try!(word(&mut self.s, "_")), PatKind::Ident(binding_mode, ref path1, ref sub) => { match binding_mode { ast::BindingMode::ByRef(mutbl) => { try!(self.word_nbsp("ref")); try!(self.print_mutability(mutbl)); } ast::BindingMode::ByValue(ast::Mutability::Immutable) => {} ast::BindingMode::ByValue(ast::Mutability::Mutable) => { try!(self.word_nbsp("mut")); } } try!(self.print_ident(path1.node)); match *sub { Some(ref p) => { try!(word(&mut self.s, "@")); try!(self.print_pat(&p)); } None => () } } PatKind::TupleStruct(ref path, ref args_) => { try!(self.print_path(path, true, 0)); match *args_ { None => try!(word(&mut self.s, "(..)")), Some(ref args) => { try!(self.popen()); try!(self.commasep(Inconsistent, &args[..], |s, p| s.print_pat(&p))); try!(self.pclose()); } } } PatKind::Path(ref path) => { try!(self.print_path(path, true, 0)); } PatKind::QPath(ref qself, ref path) => { try!(self.print_qpath(path, qself, false)); } PatKind::Struct(ref path, ref fields, etc) => { try!(self.print_path(path, true, 0)); try!(self.nbsp()); try!(self.word_space("{")); try!(self.commasep_cmnt( Consistent, &fields[..], |s, f| { try!(s.cbox(INDENT_UNIT)); if !f.node.is_shorthand { try!(s.print_ident(f.node.ident)); try!(s.word_nbsp(":")); } try!(s.print_pat(&f.node.pat)); s.end() }, |f| f.node.pat.span)); if etc { if !fields.is_empty() { try!(self.word_space(",")); } try!(word(&mut self.s, "..")); } try!(space(&mut self.s)); try!(word(&mut self.s, "}")); } PatKind::Tup(ref elts) => { try!(self.popen()); try!(self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))); if elts.len() == 1 { try!(word(&mut self.s, ",")); } try!(self.pclose()); } PatKind::Box(ref inner) => { try!(word(&mut self.s, "box ")); try!(self.print_pat(&inner)); } PatKind::Ref(ref inner, mutbl) => { try!(word(&mut self.s, "&")); if mutbl == ast::Mutability::Mutable { try!(word(&mut self.s, "mut ")); } try!(self.print_pat(&inner)); } PatKind::Lit(ref e) => try!(self.print_expr(&**e)), PatKind::Range(ref begin, ref end) => { try!(self.print_expr(&begin)); try!(space(&mut self.s)); try!(word(&mut self.s, "...")); try!(self.print_expr(&end)); } PatKind::Vec(ref before, ref slice, ref after) => { try!(word(&mut self.s, "[")); try!(self.commasep(Inconsistent, &before[..], |s, p| s.print_pat(&p))); if let Some(ref p) = *slice { if !before.is_empty() { try!(self.word_space(",")); } if p.node != PatKind::Wild { try!(self.print_pat(&p)); } try!(word(&mut self.s, "..")); if !after.is_empty() { try!(self.word_space(",")); } } try!(self.commasep(Inconsistent, &after[..], |s, p| s.print_pat(&p))); try!(word(&mut self.s, "]")); } PatKind::Mac(ref m) => try!(self.print_mac(m, token::Paren)), } self.ann.post(self, NodePat(pat)) } fn print_arm(&mut self, arm: &ast::Arm) -> io::Result<()> { // I have no idea why this check is necessary, but here it // is :( if arm.attrs.is_empty() { try!(space(&mut self.s)); } try!(self.cbox(INDENT_UNIT)); try!(self.ibox(0)); try!(self.print_outer_attributes(&arm.attrs)); let mut first = true; for p in &arm.pats { if first { first = false; } else { try!(space(&mut self.s)); try!(self.word_space("|")); } try!(self.print_pat(&p)); } try!(space(&mut self.s)); if let Some(ref e) = arm.guard { try!(self.word_space("if")); try!(self.print_expr(&e)); try!(space(&mut self.s)); } try!(self.word_space("=>")); match arm.body.node { ast::ExprKind::Block(ref blk) => { // the block will close the pattern's ibox try!(self.print_block_unclosed_indent(&blk, INDENT_UNIT)); // If it is a user-provided unsafe block, print a comma after it if let BlockCheckMode::Unsafe(ast::UserProvided) = blk.rules { try!(word(&mut self.s, ",")); } } _ => { try!(self.end()); // close the ibox for the pattern try!(self.print_expr(&arm.body)); try!(word(&mut self.s, ",")); } } self.end() // close enclosing cbox } // Returns whether it printed anything fn print_explicit_self(&mut self, explicit_self: &ast::SelfKind, mutbl: ast::Mutability) -> io::Result { try!(self.print_mutability(mutbl)); match *explicit_self { ast::SelfKind::Static => { return Ok(false); } ast::SelfKind::Value(_) => { try!(word(&mut self.s, "self")); } ast::SelfKind::Region(ref lt, m, _) => { try!(word(&mut self.s, "&")); try!(self.print_opt_lifetime(lt)); try!(self.print_mutability(m)); try!(word(&mut self.s, "self")); } ast::SelfKind::Explicit(ref typ, _) => { try!(word(&mut self.s, "self")); try!(self.word_space(":")); try!(self.print_type(&typ)); } } return Ok(true); } pub fn print_fn(&mut self, decl: &ast::FnDecl, unsafety: ast::Unsafety, constness: ast::Constness, abi: abi::Abi, name: Option, generics: &ast::Generics, opt_explicit_self: Option<&ast::SelfKind>, vis: ast::Visibility) -> io::Result<()> { try!(self.print_fn_header_info(unsafety, constness, abi, vis)); if let Some(name) = name { try!(self.nbsp()); try!(self.print_ident(name)); } try!(self.print_generics(generics)); try!(self.print_fn_args_and_ret(decl, opt_explicit_self)); self.print_where_clause(&generics.where_clause) } pub fn print_fn_args(&mut self, decl: &ast::FnDecl, opt_explicit_self: Option<&ast::SelfKind>, is_closure: bool) -> io::Result<()> { // It is unfortunate to duplicate the commasep logic, but we want the // self type and the args all in the same box. try!(self.rbox(0, Inconsistent)); let mut first = true; if let Some(explicit_self) = opt_explicit_self { let m = match *explicit_self { ast::SelfKind::Static => ast::Mutability::Immutable, _ => match decl.inputs[0].pat.node { PatKind::Ident(ast::BindingMode::ByValue(m), _, _) => m, _ => ast::Mutability::Immutable } }; first = !try!(self.print_explicit_self(explicit_self, m)); } // HACK(eddyb) ignore the separately printed self argument. let args = if first { &decl.inputs[..] } else { &decl.inputs[1..] }; for arg in args { if first { first = false; } else { try!(self.word_space(",")); } try!(self.print_arg(arg, is_closure)); } self.end() } pub fn print_fn_args_and_ret(&mut self, decl: &ast::FnDecl, opt_explicit_self: Option<&ast::SelfKind>) -> io::Result<()> { try!(self.popen()); try!(self.print_fn_args(decl, opt_explicit_self, false)); if decl.variadic { try!(word(&mut self.s, ", ...")); } try!(self.pclose()); self.print_fn_output(decl) } pub fn print_fn_block_args( &mut self, decl: &ast::FnDecl) -> io::Result<()> { try!(word(&mut self.s, "|")); try!(self.print_fn_args(decl, None, true)); try!(word(&mut self.s, "|")); if let ast::FunctionRetTy::Default(..) = decl.output { return Ok(()); } try!(self.space_if_not_bol()); try!(self.word_space("->")); match decl.output { ast::FunctionRetTy::Ty(ref ty) => { try!(self.print_type(&ty)); self.maybe_print_comment(ty.span.lo) } ast::FunctionRetTy::Default(..) => unreachable!(), ast::FunctionRetTy::None(span) => { try!(self.word_nbsp("!")); self.maybe_print_comment(span.lo) } } } pub fn print_capture_clause(&mut self, capture_clause: ast::CaptureBy) -> io::Result<()> { match capture_clause { ast::CaptureBy::Value => self.word_space("move"), ast::CaptureBy::Ref => Ok(()), } } pub fn print_bounds(&mut self, prefix: &str, bounds: &[ast::TyParamBound]) -> io::Result<()> { if !bounds.is_empty() { try!(word(&mut self.s, prefix)); let mut first = true; for bound in bounds { try!(self.nbsp()); if first { first = false; } else { try!(self.word_space("+")); } try!(match *bound { TraitTyParamBound(ref tref, TraitBoundModifier::None) => { self.print_poly_trait_ref(tref) } TraitTyParamBound(ref tref, TraitBoundModifier::Maybe) => { try!(word(&mut self.s, "?")); self.print_poly_trait_ref(tref) } RegionTyParamBound(ref lt) => { self.print_lifetime(lt) } }) } Ok(()) } else { Ok(()) } } pub fn print_lifetime(&mut self, lifetime: &ast::Lifetime) -> io::Result<()> { self.print_name(lifetime.name) } pub fn print_lifetime_def(&mut self, lifetime: &ast::LifetimeDef) -> io::Result<()> { try!(self.print_lifetime(&lifetime.lifetime)); let mut sep = ":"; for v in &lifetime.bounds { try!(word(&mut self.s, sep)); try!(self.print_lifetime(v)); sep = "+"; } Ok(()) } pub fn print_generics(&mut self, generics: &ast::Generics) -> io::Result<()> { let total = generics.lifetimes.len() + generics.ty_params.len(); if total == 0 { return Ok(()); } try!(word(&mut self.s, "<")); let mut ints = Vec::new(); for i in 0..total { ints.push(i); } try!(self.commasep(Inconsistent, &ints[..], |s, &idx| { if idx < generics.lifetimes.len() { let lifetime = &generics.lifetimes[idx]; s.print_lifetime_def(lifetime) } else { let idx = idx - generics.lifetimes.len(); let param = &generics.ty_params[idx]; s.print_ty_param(param) } })); try!(word(&mut self.s, ">")); Ok(()) } pub fn print_ty_param(&mut self, param: &ast::TyParam) -> io::Result<()> { try!(self.print_ident(param.ident)); try!(self.print_bounds(":", ¶m.bounds)); match param.default { Some(ref default) => { try!(space(&mut self.s)); try!(self.word_space("=")); self.print_type(&default) } _ => Ok(()) } } pub fn print_where_clause(&mut self, where_clause: &ast::WhereClause) -> io::Result<()> { if where_clause.predicates.is_empty() { return Ok(()) } try!(space(&mut self.s)); try!(self.word_space("where")); for (i, predicate) in where_clause.predicates.iter().enumerate() { if i != 0 { try!(self.word_space(",")); } match *predicate { ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate{ref bound_lifetimes, ref bounded_ty, ref bounds, ..}) => { try!(self.print_formal_lifetime_list(bound_lifetimes)); try!(self.print_type(&bounded_ty)); try!(self.print_bounds(":", bounds)); } ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate{ref lifetime, ref bounds, ..}) => { try!(self.print_lifetime(lifetime)); try!(word(&mut self.s, ":")); for (i, bound) in bounds.iter().enumerate() { try!(self.print_lifetime(bound)); if i != 0 { try!(word(&mut self.s, ":")); } } } ast::WherePredicate::EqPredicate(ast::WhereEqPredicate{ref path, ref ty, ..}) => { try!(self.print_path(path, false, 0)); try!(space(&mut self.s)); try!(self.word_space("=")); try!(self.print_type(&ty)); } } } Ok(()) } pub fn print_view_path(&mut self, vp: &ast::ViewPath) -> io::Result<()> { match vp.node { ast::ViewPathSimple(ident, ref path) => { try!(self.print_path(path, false, 0)); if path.segments.last().unwrap().identifier.name != ident.name { try!(space(&mut self.s)); try!(self.word_space("as")); try!(self.print_ident(ident)); } Ok(()) } ast::ViewPathGlob(ref path) => { try!(self.print_path(path, false, 0)); word(&mut self.s, "::*") } ast::ViewPathList(ref path, ref idents) => { if path.segments.is_empty() { try!(word(&mut self.s, "{")); } else { try!(self.print_path(path, false, 0)); try!(word(&mut self.s, "::{")); } try!(self.commasep(Inconsistent, &idents[..], |s, w| { match w.node { ast::PathListItemKind::Ident { name, rename, .. } => { try!(s.print_ident(name)); if let Some(ident) = rename { try!(space(&mut s.s)); try!(s.word_space("as")); try!(s.print_ident(ident)); } Ok(()) }, ast::PathListItemKind::Mod { rename, .. } => { try!(word(&mut s.s, "self")); if let Some(ident) = rename { try!(space(&mut s.s)); try!(s.word_space("as")); try!(s.print_ident(ident)); } Ok(()) } } })); word(&mut self.s, "}") } } } pub fn print_mutability(&mut self, mutbl: ast::Mutability) -> io::Result<()> { match mutbl { ast::Mutability::Mutable => self.word_nbsp("mut"), ast::Mutability::Immutable => Ok(()), } } pub fn print_mt(&mut self, mt: &ast::MutTy) -> io::Result<()> { try!(self.print_mutability(mt.mutbl)); self.print_type(&mt.ty) } pub fn print_arg(&mut self, input: &ast::Arg, is_closure: bool) -> io::Result<()> { try!(self.ibox(INDENT_UNIT)); match input.ty.node { ast::TyKind::Infer if is_closure => try!(self.print_pat(&input.pat)), _ => { match input.pat.node { PatKind::Ident(_, ref path1, _) if path1.node.name == parse::token::special_idents::invalid.name => { // Do nothing. } _ => { try!(self.print_pat(&input.pat)); try!(word(&mut self.s, ":")); try!(space(&mut self.s)); } } try!(self.print_type(&input.ty)); } } self.end() } pub fn print_fn_output(&mut self, decl: &ast::FnDecl) -> io::Result<()> { if let ast::FunctionRetTy::Default(..) = decl.output { return Ok(()); } try!(self.space_if_not_bol()); try!(self.ibox(INDENT_UNIT)); try!(self.word_space("->")); match decl.output { ast::FunctionRetTy::None(_) => try!(self.word_nbsp("!")), ast::FunctionRetTy::Default(..) => unreachable!(), ast::FunctionRetTy::Ty(ref ty) => try!(self.print_type(&ty)) } try!(self.end()); match decl.output { ast::FunctionRetTy::Ty(ref output) => self.maybe_print_comment(output.span.lo), _ => Ok(()) } } pub fn print_ty_fn(&mut self, abi: abi::Abi, unsafety: ast::Unsafety, decl: &ast::FnDecl, name: Option, generics: &ast::Generics, opt_explicit_self: Option<&ast::SelfKind>) -> io::Result<()> { try!(self.ibox(INDENT_UNIT)); if !generics.lifetimes.is_empty() || !generics.ty_params.is_empty() { try!(word(&mut self.s, "for")); try!(self.print_generics(generics)); } let generics = ast::Generics { lifetimes: Vec::new(), ty_params: P::empty(), where_clause: ast::WhereClause { id: ast::DUMMY_NODE_ID, predicates: Vec::new(), }, }; try!(self.print_fn(decl, unsafety, ast::Constness::NotConst, abi, name, &generics, opt_explicit_self, ast::Visibility::Inherited)); self.end() } pub fn maybe_print_trailing_comment(&mut self, span: codemap::Span, next_pos: Option) -> io::Result<()> { let cm = match self.cm { Some(cm) => cm, _ => return Ok(()) }; match self.next_comment() { Some(ref cmnt) => { if (*cmnt).style != comments::Trailing { return Ok(()) } let span_line = cm.lookup_char_pos(span.hi); let comment_line = cm.lookup_char_pos((*cmnt).pos); let mut next = (*cmnt).pos + BytePos(1); match next_pos { None => (), Some(p) => next = p } if span.hi < (*cmnt).pos && (*cmnt).pos < next && span_line.line == comment_line.line { try!(self.print_comment(cmnt)); self.cur_cmnt_and_lit.cur_cmnt += 1; } } _ => () } Ok(()) } pub fn print_remaining_comments(&mut self) -> io::Result<()> { // If there aren't any remaining comments, then we need to manually // make sure there is a line break at the end. if self.next_comment().is_none() { try!(hardbreak(&mut self.s)); } loop { match self.next_comment() { Some(ref cmnt) => { try!(self.print_comment(cmnt)); self.cur_cmnt_and_lit.cur_cmnt += 1; } _ => break } } Ok(()) } pub fn print_opt_abi_and_extern_if_nondefault(&mut self, opt_abi: Option) -> io::Result<()> { match opt_abi { Some(Abi::Rust) => Ok(()), Some(abi) => { try!(self.word_nbsp("extern")); self.word_nbsp(&abi.to_string()) } None => Ok(()) } } pub fn print_extern_opt_abi(&mut self, opt_abi: Option) -> io::Result<()> { match opt_abi { Some(abi) => { try!(self.word_nbsp("extern")); self.word_nbsp(&abi.to_string()) } None => Ok(()) } } pub fn print_fn_header_info(&mut self, unsafety: ast::Unsafety, constness: ast::Constness, abi: Abi, vis: ast::Visibility) -> io::Result<()> { try!(word(&mut self.s, &visibility_qualified(vis, ""))); match constness { ast::Constness::NotConst => {} ast::Constness::Const => try!(self.word_nbsp("const")) } try!(self.print_unsafety(unsafety)); if abi != Abi::Rust { try!(self.word_nbsp("extern")); try!(self.word_nbsp(&abi.to_string())); } word(&mut self.s, "fn") } pub fn print_unsafety(&mut self, s: ast::Unsafety) -> io::Result<()> { match s { ast::Unsafety::Normal => Ok(()), ast::Unsafety::Unsafe => self.word_nbsp("unsafe"), } } } fn repeat(s: &str, n: usize) -> String { iter::repeat(s).take(n).collect() } #[cfg(test)] mod tests { use super::*; use ast; use codemap; use parse::token; #[test] fn test_fun_to_string() { let abba_ident = token::str_to_ident("abba"); let decl = ast::FnDecl { inputs: Vec::new(), output: ast::FunctionRetTy::Default(codemap::DUMMY_SP), variadic: false }; let generics = ast::Generics::default(); assert_eq!(fun_to_string(&decl, ast::Unsafety::Normal, ast::Constness::NotConst, abba_ident, None, &generics), "fn abba()"); } #[test] fn test_variant_to_string() { let ident = token::str_to_ident("principal_skinner"); let var = codemap::respan(codemap::DUMMY_SP, ast::Variant_ { name: ident, attrs: Vec::new(), // making this up as I go.... ? data: ast::VariantData::Unit(ast::DUMMY_NODE_ID), disr_expr: None, }); let varstr = variant_to_string(&var); assert_eq!(varstr, "principal_skinner"); } }