1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use ast::{P, StaticRegionTyParamBound, OtherRegionTyParamBound};
13 use ast::{TraitTyParamBound, UnboxedFnTyParamBound, Required, Provided};
16 use owned_slice::OwnedSlice;
17 use attr::{AttrMetaMethods, AttributeMethods};
18 use codemap::{CodeMap, BytePos};
21 use parse::classify::expr_is_simple_block;
23 use parse::lexer::comments;
25 use print::pp::{break_offset, word, space, zerobreak, hardbreak};
26 use print::pp::{Breaks, Consistent, Inconsistent, eof};
30 use std::io::{IoResult, MemWriter};
35 pub enum AnnNode<'a> {
36 NodeBlock(&'a ast::Block),
37 NodeItem(&'a ast::Item),
38 NodeExpr(&'a ast::Expr),
39 NodePat(&'a ast::Pat),
43 fn pre(&self, _state: &mut State, _node: AnnNode) -> IoResult<()> { Ok(()) }
44 fn post(&self, _state: &mut State, _node: AnnNode) -> IoResult<()> { Ok(()) }
49 impl PpAnn for NoAnn {}
51 pub struct CurrentCommentAndLiteral {
56 pub struct State<'a> {
58 cm: Option<&'a CodeMap>,
59 comments: Option<Vec<comments::Comment> >,
60 literals: Option<Vec<comments::Literal> >,
61 cur_cmnt_and_lit: CurrentCommentAndLiteral,
62 boxes: Vec<pp::Breaks>,
66 pub fn rust_printer(writer: Box<io::Writer>) -> State<'static> {
67 static NO_ANN: NoAnn = NoAnn;
68 rust_printer_annotated(writer, &NO_ANN)
71 pub fn rust_printer_annotated<'a>(writer: Box<io::Writer>,
72 ann: &'a PpAnn) -> State<'a> {
74 s: pp::mk_printer(writer, default_columns),
78 cur_cmnt_and_lit: CurrentCommentAndLiteral {
87 pub static indent_unit: uint = 4u;
89 pub static default_columns: uint = 78u;
91 /// Requires you to pass an input filename and reader so that
92 /// it can scan the input text for comments and literals to
94 pub fn print_crate<'a>(cm: &'a CodeMap,
95 span_diagnostic: &diagnostic::SpanHandler,
98 input: &mut io::Reader,
101 is_expanded: bool) -> IoResult<()> {
102 let (cmnts, lits) = comments::gather_comments_and_literals(
108 s: pp::mk_printer(out, default_columns),
110 comments: Some(cmnts),
111 // If the code is post expansion, don't use the table of
112 // literals, since it doesn't correspond with the literals
113 // in the AST anymore.
114 literals: if is_expanded {
119 cur_cmnt_and_lit: CurrentCommentAndLiteral {
126 try!(s.print_mod(&krate.module, krate.attrs.as_slice()));
127 try!(s.print_remaining_comments());
131 pub fn to_string(f: |&mut State| -> IoResult<()>) -> String {
132 let mut s = rust_printer(box MemWriter::new());
134 eof(&mut s.s).unwrap();
136 // FIXME(pcwalton): A nasty function to extract the string from an `io::Writer`
137 // that we "know" to be a `MemWriter` that works around the lack of checked
139 let (_, wr): (uint, Box<MemWriter>) = mem::transmute_copy(&s.s.out);
141 str::from_utf8_owned(Vec::from_slice(wr.get_ref())).unwrap();
147 pub fn ty_to_string(ty: &ast::Ty) -> String {
148 to_string(|s| s.print_type(ty))
151 pub fn pat_to_string(pat: &ast::Pat) -> String {
152 to_string(|s| s.print_pat(pat))
155 pub fn expr_to_string(e: &ast::Expr) -> String {
156 to_string(|s| s.print_expr(e))
159 pub fn lifetime_to_string(e: &ast::Lifetime) -> String {
160 to_string(|s| s.print_lifetime(e))
163 pub fn tt_to_string(tt: &ast::TokenTree) -> String {
164 to_string(|s| s.print_tt(tt))
167 pub fn tts_to_string(tts: &[ast::TokenTree]) -> String {
168 to_string(|s| s.print_tts(tts))
171 pub fn stmt_to_string(stmt: &ast::Stmt) -> String {
172 to_string(|s| s.print_stmt(stmt))
175 pub fn item_to_string(i: &ast::Item) -> String {
176 to_string(|s| s.print_item(i))
179 pub fn generics_to_string(generics: &ast::Generics) -> String {
180 to_string(|s| s.print_generics(generics))
183 pub fn ty_method_to_string(p: &ast::TypeMethod) -> String {
184 to_string(|s| s.print_ty_method(p))
187 pub fn method_to_string(p: &ast::Method) -> String {
188 to_string(|s| s.print_method(p))
191 pub fn fn_block_to_string(p: &ast::FnDecl) -> String {
192 to_string(|s| s.print_fn_block_args(p))
195 pub fn path_to_string(p: &ast::Path) -> String {
196 to_string(|s| s.print_path(p, false))
199 pub fn ident_to_string(id: &ast::Ident) -> String {
200 to_string(|s| s.print_ident(*id))
203 pub fn fun_to_string(decl: &ast::FnDecl, fn_style: ast::FnStyle, name: ast::Ident,
204 opt_explicit_self: Option<ast::ExplicitSelf_>,
205 generics: &ast::Generics) -> String {
207 try!(s.print_fn(decl, Some(fn_style), abi::Rust,
208 name, generics, opt_explicit_self, ast::Inherited));
209 try!(s.end()); // Close the head box
210 s.end() // Close the outer box
214 pub fn block_to_string(blk: &ast::Block) -> String {
216 // containing cbox, will be closed by print-block at }
217 try!(s.cbox(indent_unit));
218 // head-ibox, will be closed by print-block after {
224 pub fn meta_item_to_string(mi: &ast::MetaItem) -> String {
225 to_string(|s| s.print_meta_item(mi))
228 pub fn attribute_to_string(attr: &ast::Attribute) -> String {
229 to_string(|s| s.print_attribute(attr))
232 pub fn lit_to_string(l: &ast::Lit) -> String {
233 to_string(|s| s.print_literal(l))
236 pub fn explicit_self_to_string(explicit_self: ast::ExplicitSelf_) -> String {
237 to_string(|s| s.print_explicit_self(explicit_self, ast::MutImmutable).map(|_| {}))
240 pub fn variant_to_string(var: &ast::Variant) -> String {
241 to_string(|s| s.print_variant(var))
244 pub fn arg_to_string(arg: &ast::Arg) -> String {
245 to_string(|s| s.print_arg(arg))
248 pub fn visibility_qualified(vis: ast::Visibility, s: &str) -> String {
250 ast::Public => format!("pub {}", s),
251 ast::Inherited => s.to_string()
255 fn needs_parentheses(expr: &ast::Expr) -> bool {
257 ast::ExprAssign(..) | ast::ExprBinary(..) |
258 ast::ExprFnBlock(..) | ast::ExprProc(..) |
259 ast::ExprAssignOp(..) | ast::ExprCast(..) => true,
265 pub fn ibox(&mut self, u: uint) -> IoResult<()> {
266 self.boxes.push(pp::Inconsistent);
267 pp::ibox(&mut self.s, u)
270 pub fn end(&mut self) -> IoResult<()> {
271 self.boxes.pop().unwrap();
275 pub fn cbox(&mut self, u: uint) -> IoResult<()> {
276 self.boxes.push(pp::Consistent);
277 pp::cbox(&mut self.s, u)
281 pub fn rbox(&mut self, u: uint, b: pp::Breaks) -> IoResult<()> {
283 pp::rbox(&mut self.s, u, b)
286 pub fn nbsp(&mut self) -> IoResult<()> { word(&mut self.s, " ") }
288 pub fn word_nbsp(&mut self, w: &str) -> IoResult<()> {
289 try!(word(&mut self.s, w));
293 pub fn word_space(&mut self, w: &str) -> IoResult<()> {
294 try!(word(&mut self.s, w));
298 pub fn popen(&mut self) -> IoResult<()> { word(&mut self.s, "(") }
300 pub fn pclose(&mut self) -> IoResult<()> { word(&mut self.s, ")") }
302 pub fn head(&mut self, w: &str) -> IoResult<()> {
303 // outer-box is consistent
304 try!(self.cbox(indent_unit));
305 // head-box is inconsistent
306 try!(self.ibox(w.len() + 1));
307 // keyword that starts the head
309 try!(self.word_nbsp(w));
314 pub fn bopen(&mut self) -> IoResult<()> {
315 try!(word(&mut self.s, "{"));
316 self.end() // close the head-box
319 pub fn bclose_(&mut self, span: codemap::Span,
320 indented: uint) -> IoResult<()> {
321 self.bclose_maybe_open(span, indented, true)
323 pub fn bclose_maybe_open (&mut self, span: codemap::Span,
324 indented: uint, close_box: bool) -> IoResult<()> {
325 try!(self.maybe_print_comment(span.hi));
326 try!(self.break_offset_if_not_bol(1u, -(indented as int)));
327 try!(word(&mut self.s, "}"));
329 try!(self.end()); // close the outer-box
333 pub fn bclose(&mut self, span: codemap::Span) -> IoResult<()> {
334 self.bclose_(span, indent_unit)
337 pub fn is_begin(&mut self) -> bool {
338 match self.s.last_token() { pp::Begin(_) => true, _ => false }
341 pub fn is_end(&mut self) -> bool {
342 match self.s.last_token() { pp::End => true, _ => false }
345 pub fn is_bol(&mut self) -> bool {
346 self.s.last_token().is_eof() || self.s.last_token().is_hardbreak_tok()
349 pub fn in_cbox(&self) -> bool {
350 match self.boxes.last() {
351 Some(&last_box) => last_box == pp::Consistent,
356 pub fn hardbreak_if_not_bol(&mut self) -> IoResult<()> {
358 try!(hardbreak(&mut self.s))
362 pub fn space_if_not_bol(&mut self) -> IoResult<()> {
363 if !self.is_bol() { try!(space(&mut self.s)); }
366 pub fn break_offset_if_not_bol(&mut self, n: uint,
367 off: int) -> IoResult<()> {
369 break_offset(&mut self.s, n, off)
371 if off != 0 && self.s.last_token().is_hardbreak_tok() {
372 // We do something pretty sketchy here: tuck the nonzero
373 // offset-adjustment we were going to deposit along with the
374 // break into the previous hardbreak.
375 self.s.replace_last_token(pp::hardbreak_tok_offset(off));
381 // Synthesizes a comment that was not textually present in the original source
383 pub fn synth_comment(&mut self, text: String) -> IoResult<()> {
384 try!(word(&mut self.s, "/*"));
385 try!(space(&mut self.s));
386 try!(word(&mut self.s, text.as_slice()));
387 try!(space(&mut self.s));
388 word(&mut self.s, "*/")
391 pub fn commasep<T>(&mut self, b: Breaks, elts: &[T],
392 op: |&mut State, &T| -> IoResult<()>)
394 try!(self.rbox(0u, b));
395 let mut first = true;
396 for elt in elts.iter() {
397 if first { first = false; } else { try!(self.word_space(",")); }
404 pub fn commasep_cmnt<T>(
408 op: |&mut State, &T| -> IoResult<()>,
409 get_span: |&T| -> codemap::Span) -> IoResult<()> {
410 try!(self.rbox(0u, b));
411 let len = elts.len();
413 for elt in elts.iter() {
414 try!(self.maybe_print_comment(get_span(elt).hi));
418 try!(word(&mut self.s, ","));
419 try!(self.maybe_print_trailing_comment(get_span(elt),
420 Some(get_span(&elts[i]).hi)));
421 try!(self.space_if_not_bol());
427 pub fn commasep_exprs(&mut self, b: Breaks,
428 exprs: &[Gc<ast::Expr>]) -> IoResult<()> {
429 self.commasep_cmnt(b, exprs, |s, e| s.print_expr(&**e), |e| e.span)
432 pub fn print_mod(&mut self, _mod: &ast::Mod,
433 attrs: &[ast::Attribute]) -> IoResult<()> {
434 try!(self.print_inner_attributes(attrs));
435 for vitem in _mod.view_items.iter() {
436 try!(self.print_view_item(vitem));
438 for item in _mod.items.iter() {
439 try!(self.print_item(&**item));
444 pub fn print_foreign_mod(&mut self, nmod: &ast::ForeignMod,
445 attrs: &[ast::Attribute]) -> IoResult<()> {
446 try!(self.print_inner_attributes(attrs));
447 for vitem in nmod.view_items.iter() {
448 try!(self.print_view_item(vitem));
450 for item in nmod.items.iter() {
451 try!(self.print_foreign_item(&**item));
456 pub fn print_opt_lifetime(&mut self,
457 lifetime: &Option<ast::Lifetime>) -> IoResult<()> {
458 for l in lifetime.iter() {
459 try!(self.print_lifetime(l));
465 pub fn print_type(&mut self, ty: &ast::Ty) -> IoResult<()> {
466 try!(self.maybe_print_comment(ty.span.lo));
469 ast::TyNil => try!(word(&mut self.s, "()")),
470 ast::TyBot => try!(word(&mut self.s, "!")),
471 ast::TyBox(ref ty) => {
472 try!(word(&mut self.s, "@"));
473 try!(self.print_type(&**ty));
475 ast::TyUniq(ref ty) => {
476 try!(word(&mut self.s, "~"));
477 try!(self.print_type(&**ty));
479 ast::TyVec(ref ty) => {
480 try!(word(&mut self.s, "["));
481 try!(self.print_type(&**ty));
482 try!(word(&mut self.s, "]"));
484 ast::TyPtr(ref mt) => {
485 try!(word(&mut self.s, "*"));
487 ast::MutMutable => try!(self.word_nbsp("mut")),
488 ast::MutImmutable => try!(self.word_nbsp("const")),
490 try!(self.print_type(&*mt.ty));
492 ast::TyRptr(ref lifetime, ref mt) => {
493 try!(word(&mut self.s, "&"));
494 try!(self.print_opt_lifetime(lifetime));
495 try!(self.print_mt(mt));
497 ast::TyTup(ref elts) => {
499 try!(self.commasep(Inconsistent, elts.as_slice(),
500 |s, ty| s.print_type_ref(ty)));
502 try!(word(&mut self.s, ","));
506 ast::TyParen(ref typ) => {
508 try!(self.print_type(&**typ));
511 ast::TyBareFn(f) => {
512 let generics = ast::Generics {
513 lifetimes: f.lifetimes.clone(),
514 ty_params: OwnedSlice::empty()
516 try!(self.print_ty_fn(Some(f.abi),
528 ast::TyClosure(f, ref region) => {
529 let generics = ast::Generics {
530 lifetimes: f.lifetimes.clone(),
531 ty_params: OwnedSlice::empty()
533 try!(self.print_ty_fn(None,
545 ast::TyProc(ref f) => {
546 let generics = ast::Generics {
547 lifetimes: f.lifetimes.clone(),
548 ty_params: OwnedSlice::empty()
550 try!(self.print_ty_fn(None,
562 ast::TyUnboxedFn(f) => {
563 try!(self.print_ty_fn(None,
575 ast::TyPath(ref path, ref bounds, _) => {
576 try!(self.print_bounded_path(path, bounds));
578 ast::TyFixedLengthVec(ref ty, ref v) => {
579 try!(word(&mut self.s, "["));
580 try!(self.print_type(&**ty));
581 try!(word(&mut self.s, ", .."));
582 try!(self.print_expr(&**v));
583 try!(word(&mut self.s, "]"));
585 ast::TyTypeof(ref e) => {
586 try!(word(&mut self.s, "typeof("));
587 try!(self.print_expr(&**e));
588 try!(word(&mut self.s, ")"));
591 try!(word(&mut self.s, "_"));
597 pub fn print_type_ref(&mut self, ty: &P<ast::Ty>) -> IoResult<()> {
598 self.print_type(&**ty)
601 pub fn print_foreign_item(&mut self,
602 item: &ast::ForeignItem) -> IoResult<()> {
603 try!(self.hardbreak_if_not_bol());
604 try!(self.maybe_print_comment(item.span.lo));
605 try!(self.print_outer_attributes(item.attrs.as_slice()));
607 ast::ForeignItemFn(ref decl, ref generics) => {
608 try!(self.print_fn(&**decl, None, abi::Rust, item.ident, generics,
610 try!(self.end()); // end head-ibox
611 try!(word(&mut self.s, ";"));
612 self.end() // end the outer fn box
614 ast::ForeignItemStatic(ref t, m) => {
615 try!(self.head(visibility_qualified(item.vis,
616 "static").as_slice()));
618 try!(self.word_space("mut"));
620 try!(self.print_ident(item.ident));
621 try!(self.word_space(":"));
622 try!(self.print_type(&**t));
623 try!(word(&mut self.s, ";"));
624 try!(self.end()); // end the head-ibox
625 self.end() // end the outer cbox
630 pub fn print_item(&mut self, item: &ast::Item) -> IoResult<()> {
631 try!(self.hardbreak_if_not_bol());
632 try!(self.maybe_print_comment(item.span.lo));
633 try!(self.print_outer_attributes(item.attrs.as_slice()));
634 try!(self.ann.pre(self, NodeItem(item)));
636 ast::ItemStatic(ref ty, m, ref expr) => {
637 try!(self.head(visibility_qualified(item.vis,
638 "static").as_slice()));
639 if m == ast::MutMutable {
640 try!(self.word_space("mut"));
642 try!(self.print_ident(item.ident));
643 try!(self.word_space(":"));
644 try!(self.print_type(&**ty));
645 try!(space(&mut self.s));
646 try!(self.end()); // end the head-ibox
648 try!(self.word_space("="));
649 try!(self.print_expr(&**expr));
650 try!(word(&mut self.s, ";"));
651 try!(self.end()); // end the outer cbox
653 ast::ItemFn(ref decl, fn_style, abi, ref typarams, ref body) => {
663 try!(word(&mut self.s, " "));
664 try!(self.print_block_with_attrs(&**body, item.attrs.as_slice()));
666 ast::ItemMod(ref _mod) => {
667 try!(self.head(visibility_qualified(item.vis,
669 try!(self.print_ident(item.ident));
672 try!(self.print_mod(_mod, item.attrs.as_slice()));
673 try!(self.bclose(item.span));
675 ast::ItemForeignMod(ref nmod) => {
676 try!(self.head("extern"));
677 try!(self.word_nbsp(nmod.abi.to_string().as_slice()));
679 try!(self.print_foreign_mod(nmod, item.attrs.as_slice()));
680 try!(self.bclose(item.span));
682 ast::ItemTy(ref ty, ref params) => {
683 try!(self.ibox(indent_unit));
685 try!(self.word_nbsp(visibility_qualified(item.vis,
686 "type").as_slice()));
687 try!(self.print_ident(item.ident));
688 try!(self.print_generics(params));
689 try!(self.end()); // end the inner ibox
691 try!(space(&mut self.s));
692 try!(self.word_space("="));
693 try!(self.print_type(&**ty));
694 try!(word(&mut self.s, ";"));
695 try!(self.end()); // end the outer ibox
697 ast::ItemEnum(ref enum_definition, ref params) => {
698 try!(self.print_enum_def(
706 ast::ItemStruct(ref struct_def, ref generics) => {
707 if struct_def.is_virtual {
708 try!(self.word_space("virtual"));
710 try!(self.head(visibility_qualified(item.vis,
711 "struct").as_slice()));
712 try!(self.print_struct(&**struct_def, generics, item.ident,
716 ast::ItemImpl(ref generics, ref opt_trait, ref ty, ref methods) => {
717 try!(self.head(visibility_qualified(item.vis,
718 "impl").as_slice()));
719 if generics.is_parameterized() {
720 try!(self.print_generics(generics));
721 try!(space(&mut self.s));
726 try!(self.print_trait_ref(t));
727 try!(space(&mut self.s));
728 try!(self.word_space("for"));
733 try!(self.print_type(&**ty));
735 try!(space(&mut self.s));
737 try!(self.print_inner_attributes(item.attrs.as_slice()));
738 for meth in methods.iter() {
739 try!(self.print_method(&**meth));
741 try!(self.bclose(item.span));
743 ast::ItemTrait(ref generics, ref unbound, ref traits, ref methods) => {
744 try!(self.head(visibility_qualified(item.vis,
745 "trait").as_slice()));
746 try!(self.print_ident(item.ident));
747 try!(self.print_generics(generics));
749 &Some(TraitTyParamBound(ref tref)) => {
750 try!(space(&mut self.s));
751 try!(self.word_space("for"));
752 try!(self.print_trait_ref(tref));
753 try!(word(&mut self.s, "?"));
757 if traits.len() != 0u {
758 try!(word(&mut self.s, ":"));
759 for (i, trait_) in traits.iter().enumerate() {
762 try!(self.word_space("+"));
764 try!(self.print_path(&trait_.path, false));
767 try!(word(&mut self.s, " "));
769 for meth in methods.iter() {
770 try!(self.print_trait_method(meth));
772 try!(self.bclose(item.span));
774 // I think it's reasonable to hide the context here:
775 ast::ItemMac(codemap::Spanned { node: ast::MacInvocTT(ref pth, ref tts, _),
777 try!(self.print_visibility(item.vis));
778 try!(self.print_path(pth, false));
779 try!(word(&mut self.s, "! "));
780 try!(self.print_ident(item.ident));
781 try!(self.cbox(indent_unit));
783 try!(self.print_tts(tts.as_slice()));
788 self.ann.post(self, NodeItem(item))
791 fn print_trait_ref(&mut self, t: &ast::TraitRef) -> IoResult<()> {
792 self.print_path(&t.path, false)
795 pub fn print_enum_def(&mut self, enum_definition: &ast::EnumDef,
796 generics: &ast::Generics, ident: ast::Ident,
798 visibility: ast::Visibility) -> IoResult<()> {
799 try!(self.head(visibility_qualified(visibility, "enum").as_slice()));
800 try!(self.print_ident(ident));
801 try!(self.print_generics(generics));
802 try!(space(&mut self.s));
803 self.print_variants(enum_definition.variants.as_slice(), span)
806 pub fn print_variants(&mut self,
807 variants: &[P<ast::Variant>],
808 span: codemap::Span) -> IoResult<()> {
810 for v in variants.iter() {
811 try!(self.space_if_not_bol());
812 try!(self.maybe_print_comment(v.span.lo));
813 try!(self.print_outer_attributes(v.node.attrs.as_slice()));
814 try!(self.ibox(indent_unit));
815 try!(self.print_variant(&**v));
816 try!(word(&mut self.s, ","));
818 try!(self.maybe_print_trailing_comment(v.span, None));
823 pub fn print_visibility(&mut self, vis: ast::Visibility) -> IoResult<()> {
825 ast::Public => self.word_nbsp("pub"),
826 ast::Inherited => Ok(())
830 pub fn print_struct(&mut self,
831 struct_def: &ast::StructDef,
832 generics: &ast::Generics,
834 span: codemap::Span) -> IoResult<()> {
835 try!(self.print_ident(ident));
836 try!(self.print_generics(generics));
837 match struct_def.super_struct {
839 try!(self.word_space(":"));
840 try!(self.print_type(&**t));
844 if ast_util::struct_def_is_tuple_like(struct_def) {
845 if !struct_def.fields.is_empty() {
848 Inconsistent, struct_def.fields.as_slice(),
850 match field.node.kind {
851 ast::NamedField(..) => fail!("unexpected named field"),
852 ast::UnnamedField(vis) => {
853 try!(s.print_visibility(vis));
854 try!(s.maybe_print_comment(field.span.lo));
855 s.print_type(&*field.node.ty)
862 try!(word(&mut self.s, ";"));
864 self.end() // close the outer-box
868 try!(self.hardbreak_if_not_bol());
870 for field in struct_def.fields.iter() {
871 match field.node.kind {
872 ast::UnnamedField(..) => fail!("unexpected unnamed field"),
873 ast::NamedField(ident, visibility) => {
874 try!(self.hardbreak_if_not_bol());
875 try!(self.maybe_print_comment(field.span.lo));
876 try!(self.print_outer_attributes(field.node.attrs.as_slice()));
877 try!(self.print_visibility(visibility));
878 try!(self.print_ident(ident));
879 try!(self.word_nbsp(":"));
880 try!(self.print_type(&*field.node.ty));
881 try!(word(&mut self.s, ","));
890 /// This doesn't deserve to be called "pretty" printing, but it should be
891 /// meaning-preserving. A quick hack that might help would be to look at the
892 /// spans embedded in the TTs to decide where to put spaces and newlines.
893 /// But it'd be better to parse these according to the grammar of the
894 /// appropriate macro, transcribe back into the grammar we just parsed from,
895 /// and then pretty-print the resulting AST nodes (so, e.g., we print
896 /// expression arguments as expressions). It can be done! I think.
897 pub fn print_tt(&mut self, tt: &ast::TokenTree) -> IoResult<()> {
899 ast::TTDelim(ref tts) => self.print_tts(tts.as_slice()),
900 ast::TTTok(_, ref tk) => {
901 try!(word(&mut self.s, parse::token::to_string(tk).as_slice()));
903 parse::token::DOC_COMMENT(..) => {
904 hardbreak(&mut self.s)
909 ast::TTSeq(_, ref tts, ref sep, zerok) => {
910 try!(word(&mut self.s, "$("));
911 for tt_elt in (*tts).iter() {
912 try!(self.print_tt(tt_elt));
914 try!(word(&mut self.s, ")"));
917 try!(word(&mut self.s,
918 parse::token::to_string(tk).as_slice()));
922 word(&mut self.s, if zerok { "*" } else { "+" })
924 ast::TTNonterminal(_, name) => {
925 try!(word(&mut self.s, "$"));
926 self.print_ident(name)
931 pub fn print_tts(&mut self, tts: &[ast::TokenTree]) -> IoResult<()> {
933 for (i, tt) in tts.iter().enumerate() {
935 try!(space(&mut self.s));
937 try!(self.print_tt(tt));
942 pub fn print_variant(&mut self, v: &ast::Variant) -> IoResult<()> {
943 try!(self.print_visibility(v.node.vis));
945 ast::TupleVariantKind(ref args) => {
946 try!(self.print_ident(v.node.name));
947 if !args.is_empty() {
949 try!(self.commasep(Consistent,
951 |s, arg| s.print_type(&*arg.ty)));
955 ast::StructVariantKind(ref struct_def) => {
957 let generics = ast_util::empty_generics();
958 try!(self.print_struct(&**struct_def, &generics, v.node.name, v.span));
961 match v.node.disr_expr {
963 try!(space(&mut self.s));
964 try!(self.word_space("="));
965 self.print_expr(&**d)
971 pub fn print_ty_method(&mut self, m: &ast::TypeMethod) -> IoResult<()> {
972 try!(self.hardbreak_if_not_bol());
973 try!(self.maybe_print_comment(m.span.lo));
974 try!(self.print_outer_attributes(m.attrs.as_slice()));
975 try!(self.print_ty_fn(None,
984 Some(m.explicit_self.node),
986 word(&mut self.s, ";")
989 pub fn print_trait_method(&mut self,
990 m: &ast::TraitMethod) -> IoResult<()> {
992 Required(ref ty_m) => self.print_ty_method(ty_m),
993 Provided(ref m) => self.print_method(&**m)
997 pub fn print_method(&mut self, meth: &ast::Method) -> IoResult<()> {
998 try!(self.hardbreak_if_not_bol());
999 try!(self.maybe_print_comment(meth.span.lo));
1000 try!(self.print_outer_attributes(meth.attrs.as_slice()));
1001 try!(self.print_fn(&*meth.decl, Some(meth.fn_style), abi::Rust,
1002 meth.ident, &meth.generics, Some(meth.explicit_self.node),
1004 try!(word(&mut self.s, " "));
1005 self.print_block_with_attrs(&*meth.body, meth.attrs.as_slice())
1008 pub fn print_outer_attributes(&mut self,
1009 attrs: &[ast::Attribute]) -> IoResult<()> {
1011 for attr in attrs.iter() {
1012 match attr.node.style {
1014 try!(self.print_attribute(attr));
1017 _ => {/* fallthrough */ }
1021 try!(self.hardbreak_if_not_bol());
1026 pub fn print_inner_attributes(&mut self,
1027 attrs: &[ast::Attribute]) -> IoResult<()> {
1029 for attr in attrs.iter() {
1030 match attr.node.style {
1032 try!(self.print_attribute(attr));
1035 _ => {/* fallthrough */ }
1039 try!(self.hardbreak_if_not_bol());
1044 pub fn print_attribute(&mut self, attr: &ast::Attribute) -> IoResult<()> {
1045 try!(self.hardbreak_if_not_bol());
1046 try!(self.maybe_print_comment(attr.span.lo));
1047 if attr.node.is_sugared_doc {
1048 word(&mut self.s, attr.value_str().unwrap().get())
1050 match attr.node.style {
1051 ast::AttrInner => try!(word(&mut self.s, "#![")),
1052 ast::AttrOuter => try!(word(&mut self.s, "#[")),
1054 try!(self.print_meta_item(&*attr.meta()));
1055 word(&mut self.s, "]")
1060 pub fn print_stmt(&mut self, st: &ast::Stmt) -> IoResult<()> {
1061 try!(self.maybe_print_comment(st.span.lo));
1063 ast::StmtDecl(ref decl, _) => {
1064 try!(self.print_decl(&**decl));
1066 ast::StmtExpr(ref expr, _) => {
1067 try!(self.space_if_not_bol());
1068 try!(self.print_expr(&**expr));
1070 ast::StmtSemi(ref expr, _) => {
1071 try!(self.space_if_not_bol());
1072 try!(self.print_expr(&**expr));
1073 try!(word(&mut self.s, ";"));
1075 ast::StmtMac(ref mac, semi) => {
1076 try!(self.space_if_not_bol());
1077 try!(self.print_mac(mac));
1079 try!(word(&mut self.s, ";"));
1083 if parse::classify::stmt_ends_with_semi(st) {
1084 try!(word(&mut self.s, ";"));
1086 self.maybe_print_trailing_comment(st.span, None)
1089 pub fn print_block(&mut self, blk: &ast::Block) -> IoResult<()> {
1090 self.print_block_with_attrs(blk, &[])
1093 pub fn print_block_unclosed(&mut self, blk: &ast::Block) -> IoResult<()> {
1094 self.print_block_unclosed_indent(blk, indent_unit)
1097 pub fn print_block_unclosed_indent(&mut self, blk: &ast::Block,
1098 indented: uint) -> IoResult<()> {
1099 self.print_block_maybe_unclosed(blk, indented, &[], false)
1102 pub fn print_block_with_attrs(&mut self,
1104 attrs: &[ast::Attribute]) -> IoResult<()> {
1105 self.print_block_maybe_unclosed(blk, indent_unit, attrs, true)
1108 pub fn print_block_maybe_unclosed(&mut self,
1111 attrs: &[ast::Attribute],
1112 close_box: bool) -> IoResult<()> {
1114 ast::UnsafeBlock(..) => try!(self.word_space("unsafe")),
1115 ast::DefaultBlock => ()
1117 try!(self.maybe_print_comment(blk.span.lo));
1118 try!(self.ann.pre(self, NodeBlock(blk)));
1121 try!(self.print_inner_attributes(attrs));
1123 for vi in blk.view_items.iter() {
1124 try!(self.print_view_item(vi));
1126 for st in blk.stmts.iter() {
1127 try!(self.print_stmt(&**st));
1131 try!(self.space_if_not_bol());
1132 try!(self.print_expr(&**expr));
1133 try!(self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi)));
1137 try!(self.bclose_maybe_open(blk.span, indented, close_box));
1138 self.ann.post(self, NodeBlock(blk))
1141 fn print_else(&mut self, els: Option<Gc<ast::Expr>>) -> IoResult<()> {
1145 // "another else-if"
1146 ast::ExprIf(ref i, ref t, e) => {
1147 try!(self.cbox(indent_unit - 1u));
1148 try!(self.ibox(0u));
1149 try!(word(&mut self.s, " else if "));
1150 try!(self.print_expr(&**i));
1151 try!(space(&mut self.s));
1152 try!(self.print_block(&**t));
1156 ast::ExprBlock(ref b) => {
1157 try!(self.cbox(indent_unit - 1u));
1158 try!(self.ibox(0u));
1159 try!(word(&mut self.s, " else "));
1160 self.print_block(&**b)
1162 // BLEAH, constraints would be great here
1164 fail!("print_if saw if with weird alternative");
1172 pub fn print_if(&mut self, test: &ast::Expr, blk: &ast::Block,
1173 elseopt: Option<Gc<ast::Expr>>, chk: bool) -> IoResult<()> {
1174 try!(self.head("if"));
1175 if chk { try!(self.word_nbsp("check")); }
1176 try!(self.print_expr(test));
1177 try!(space(&mut self.s));
1178 try!(self.print_block(blk));
1179 self.print_else(elseopt)
1182 pub fn print_mac(&mut self, m: &ast::Mac) -> IoResult<()> {
1184 // I think it's reasonable to hide the ctxt here:
1185 ast::MacInvocTT(ref pth, ref tts, _) => {
1186 try!(self.print_path(pth, false));
1187 try!(word(&mut self.s, "!"));
1189 try!(self.print_tts(tts.as_slice()));
1195 pub fn print_expr_vstore(&mut self, t: ast::ExprVstore) -> IoResult<()> {
1197 ast::ExprVstoreUniq => word(&mut self.s, "box "),
1198 ast::ExprVstoreSlice => word(&mut self.s, "&"),
1199 ast::ExprVstoreMutSlice => {
1200 try!(word(&mut self.s, "&"));
1201 word(&mut self.s, "mut")
1206 fn print_call_post(&mut self, args: &[Gc<ast::Expr>]) -> IoResult<()> {
1208 try!(self.commasep_exprs(Inconsistent, args));
1212 pub fn print_expr_maybe_paren(&mut self, expr: &ast::Expr) -> IoResult<()> {
1213 let needs_par = needs_parentheses(expr);
1217 try!(self.print_expr(expr));
1219 try!(self.pclose());
1224 pub fn print_expr(&mut self, expr: &ast::Expr) -> IoResult<()> {
1225 try!(self.maybe_print_comment(expr.span.lo));
1226 try!(self.ibox(indent_unit));
1227 try!(self.ann.pre(self, NodeExpr(expr)));
1229 ast::ExprVstore(ref e, v) => {
1230 try!(self.print_expr_vstore(v));
1231 try!(self.print_expr(&**e));
1233 ast::ExprBox(ref p, ref e) => {
1234 try!(word(&mut self.s, "box"));
1235 try!(word(&mut self.s, "("));
1236 try!(self.print_expr(&**p));
1237 try!(self.word_space(")"));
1238 try!(self.print_expr(&**e));
1240 ast::ExprVec(ref exprs) => {
1241 try!(self.ibox(indent_unit));
1242 try!(word(&mut self.s, "["));
1243 try!(self.commasep_exprs(Inconsistent, exprs.as_slice()));
1244 try!(word(&mut self.s, "]"));
1248 ast::ExprRepeat(ref element, ref count) => {
1249 try!(self.ibox(indent_unit));
1250 try!(word(&mut self.s, "["));
1251 try!(self.print_expr(&**element));
1252 try!(word(&mut self.s, ","));
1253 try!(word(&mut self.s, ".."));
1254 try!(self.print_expr(&**count));
1255 try!(word(&mut self.s, "]"));
1259 ast::ExprStruct(ref path, ref fields, wth) => {
1260 try!(self.print_path(path, true));
1261 try!(word(&mut self.s, "{"));
1262 try!(self.commasep_cmnt(
1266 try!(s.ibox(indent_unit));
1267 try!(s.print_ident(field.ident.node));
1268 try!(s.word_space(":"));
1269 try!(s.print_expr(&*field.expr));
1275 try!(self.ibox(indent_unit));
1276 if !fields.is_empty() {
1277 try!(word(&mut self.s, ","));
1278 try!(space(&mut self.s));
1280 try!(word(&mut self.s, ".."));
1281 try!(self.print_expr(&**expr));
1284 _ => try!(word(&mut self.s, ","))
1286 try!(word(&mut self.s, "}"));
1288 ast::ExprTup(ref exprs) => {
1290 try!(self.commasep_exprs(Inconsistent, exprs.as_slice()));
1291 if exprs.len() == 1 {
1292 try!(word(&mut self.s, ","));
1294 try!(self.pclose());
1296 ast::ExprCall(ref func, ref args) => {
1297 try!(self.print_expr_maybe_paren(&**func));
1298 try!(self.print_call_post(args.as_slice()));
1300 ast::ExprMethodCall(ident, ref tys, ref args) => {
1301 let base_args = args.slice_from(1);
1302 try!(self.print_expr(&**args.get(0)));
1303 try!(word(&mut self.s, "."));
1304 try!(self.print_ident(ident.node));
1306 try!(word(&mut self.s, "::<"));
1307 try!(self.commasep(Inconsistent, tys.as_slice(),
1308 |s, ty| s.print_type_ref(ty)));
1309 try!(word(&mut self.s, ">"));
1311 try!(self.print_call_post(base_args));
1313 ast::ExprBinary(op, ref lhs, ref rhs) => {
1314 try!(self.print_expr(&**lhs));
1315 try!(space(&mut self.s));
1316 try!(self.word_space(ast_util::binop_to_string(op)));
1317 try!(self.print_expr(&**rhs));
1319 ast::ExprUnary(op, ref expr) => {
1320 try!(word(&mut self.s, ast_util::unop_to_string(op)));
1321 try!(self.print_expr_maybe_paren(&**expr));
1323 ast::ExprAddrOf(m, ref expr) => {
1324 try!(word(&mut self.s, "&"));
1325 try!(self.print_mutability(m));
1326 try!(self.print_expr_maybe_paren(&**expr));
1328 ast::ExprLit(ref lit) => try!(self.print_literal(&**lit)),
1329 ast::ExprCast(ref expr, ref ty) => {
1330 try!(self.print_expr(&**expr));
1331 try!(space(&mut self.s));
1332 try!(self.word_space("as"));
1333 try!(self.print_type(&**ty));
1335 ast::ExprIf(ref test, ref blk, elseopt) => {
1336 try!(self.print_if(&**test, &**blk, elseopt, false));
1338 ast::ExprWhile(ref test, ref blk) => {
1339 try!(self.head("while"));
1340 try!(self.print_expr(&**test));
1341 try!(space(&mut self.s));
1342 try!(self.print_block(&**blk));
1344 ast::ExprForLoop(ref pat, ref iter, ref blk, opt_ident) => {
1345 for ident in opt_ident.iter() {
1346 try!(self.print_ident(*ident));
1347 try!(self.word_space(":"));
1349 try!(self.head("for"));
1350 try!(self.print_pat(&**pat));
1351 try!(space(&mut self.s));
1352 try!(self.word_space("in"));
1353 try!(self.print_expr(&**iter));
1354 try!(space(&mut self.s));
1355 try!(self.print_block(&**blk));
1357 ast::ExprLoop(ref blk, opt_ident) => {
1358 for ident in opt_ident.iter() {
1359 try!(self.print_ident(*ident));
1360 try!(self.word_space(":"));
1362 try!(self.head("loop"));
1363 try!(space(&mut self.s));
1364 try!(self.print_block(&**blk));
1366 ast::ExprMatch(ref expr, ref arms) => {
1367 try!(self.cbox(indent_unit));
1369 try!(self.word_nbsp("match"));
1370 try!(self.print_expr(&**expr));
1371 try!(space(&mut self.s));
1373 let len = arms.len();
1374 for (i, arm) in arms.iter().enumerate() {
1375 // I have no idea why this check is necessary, but here it
1377 if arm.attrs.is_empty() {
1378 try!(space(&mut self.s));
1380 try!(self.cbox(indent_unit));
1381 try!(self.ibox(0u));
1382 try!(self.print_outer_attributes(arm.attrs.as_slice()));
1383 let mut first = true;
1384 for p in arm.pats.iter() {
1388 try!(space(&mut self.s));
1389 try!(self.word_space("|"));
1391 try!(self.print_pat(&**p));
1393 try!(space(&mut self.s));
1396 try!(self.word_space("if"));
1397 try!(self.print_expr(&**e));
1398 try!(space(&mut self.s));
1402 try!(self.word_space("=>"));
1404 match arm.body.node {
1405 ast::ExprBlock(ref blk) => {
1406 // the block will close the pattern's ibox
1407 try!(self.print_block_unclosed_indent(&**blk,
1411 try!(self.end()); // close the ibox for the pattern
1412 try!(self.print_expr(&*arm.body));
1415 if !expr_is_simple_block(expr.clone())
1417 try!(word(&mut self.s, ","));
1419 try!(self.end()); // close enclosing cbox
1421 try!(self.bclose_(expr.span, indent_unit));
1423 ast::ExprFnBlock(ref decl, ref body) => {
1424 // in do/for blocks we don't want to show an empty
1425 // argument list, but at this point we don't know which
1428 // if !decl.inputs.is_empty() {
1429 try!(self.print_fn_block_args(&**decl));
1430 try!(space(&mut self.s));
1433 if !body.stmts.is_empty() || !body.expr.is_some() {
1434 try!(self.print_block_unclosed(&**body));
1436 // we extract the block, so as not to create another set of boxes
1437 match body.expr.unwrap().node {
1438 ast::ExprBlock(ref blk) => {
1439 try!(self.print_block_unclosed(&**blk));
1442 // this is a bare expression
1443 try!(self.print_expr(&*body.expr.unwrap()));
1444 try!(self.end()); // need to close a box
1448 // a box will be closed by print_expr, but we didn't want an overall
1449 // wrapper so we closed the corresponding opening. so create an
1450 // empty box to satisfy the close.
1453 ast::ExprProc(ref decl, ref body) => {
1454 // in do/for blocks we don't want to show an empty
1455 // argument list, but at this point we don't know which
1458 // if !decl.inputs.is_empty() {
1459 try!(self.print_proc_args(&**decl));
1460 try!(space(&mut self.s));
1462 assert!(body.stmts.is_empty());
1463 assert!(body.expr.is_some());
1464 // we extract the block, so as not to create another set of boxes
1465 match body.expr.unwrap().node {
1466 ast::ExprBlock(ref blk) => {
1467 try!(self.print_block_unclosed(&**blk));
1470 // this is a bare expression
1471 try!(self.print_expr(&*body.expr.unwrap()));
1472 try!(self.end()); // need to close a box
1475 // a box will be closed by print_expr, but we didn't want an overall
1476 // wrapper so we closed the corresponding opening. so create an
1477 // empty box to satisfy the close.
1480 ast::ExprBlock(ref blk) => {
1481 // containing cbox, will be closed by print-block at }
1482 try!(self.cbox(indent_unit));
1483 // head-box, will be closed by print-block after {
1484 try!(self.ibox(0u));
1485 try!(self.print_block(&**blk));
1487 ast::ExprAssign(ref lhs, ref rhs) => {
1488 try!(self.print_expr(&**lhs));
1489 try!(space(&mut self.s));
1490 try!(self.word_space("="));
1491 try!(self.print_expr(&**rhs));
1493 ast::ExprAssignOp(op, ref lhs, ref rhs) => {
1494 try!(self.print_expr(&**lhs));
1495 try!(space(&mut self.s));
1496 try!(word(&mut self.s, ast_util::binop_to_string(op)));
1497 try!(self.word_space("="));
1498 try!(self.print_expr(&**rhs));
1500 ast::ExprField(ref expr, id, ref tys) => {
1501 try!(self.print_expr(&**expr));
1502 try!(word(&mut self.s, "."));
1503 try!(self.print_ident(id.node));
1505 try!(word(&mut self.s, "::<"));
1507 Inconsistent, tys.as_slice(),
1508 |s, ty| s.print_type_ref(ty)));
1509 try!(word(&mut self.s, ">"));
1512 ast::ExprIndex(ref expr, ref index) => {
1513 try!(self.print_expr(&**expr));
1514 try!(word(&mut self.s, "["));
1515 try!(self.print_expr(&**index));
1516 try!(word(&mut self.s, "]"));
1518 ast::ExprPath(ref path) => try!(self.print_path(path, true)),
1519 ast::ExprBreak(opt_ident) => {
1520 try!(word(&mut self.s, "break"));
1521 try!(space(&mut self.s));
1522 for ident in opt_ident.iter() {
1523 try!(self.print_ident(*ident));
1524 try!(space(&mut self.s));
1527 ast::ExprAgain(opt_ident) => {
1528 try!(word(&mut self.s, "continue"));
1529 try!(space(&mut self.s));
1530 for ident in opt_ident.iter() {
1531 try!(self.print_ident(*ident));
1532 try!(space(&mut self.s))
1535 ast::ExprRet(ref result) => {
1536 try!(word(&mut self.s, "return"));
1539 try!(word(&mut self.s, " "));
1540 try!(self.print_expr(&**expr));
1545 ast::ExprInlineAsm(ref a) => {
1547 try!(word(&mut self.s, "__volatile__ asm!"));
1549 try!(word(&mut self.s, "asm!"));
1552 try!(self.print_string(a.asm.get(), a.asm_str_style));
1553 try!(self.word_space(":"));
1555 try!(self.commasep(Inconsistent, a.outputs.as_slice(),
1556 |s, &(ref co, ref o)| {
1557 try!(s.print_string(co.get(), ast::CookedStr));
1559 try!(s.print_expr(&**o));
1563 try!(space(&mut self.s));
1564 try!(self.word_space(":"));
1566 try!(self.commasep(Inconsistent, a.inputs.as_slice(),
1567 |s, &(ref co, ref o)| {
1568 try!(s.print_string(co.get(), ast::CookedStr));
1570 try!(s.print_expr(&**o));
1574 try!(space(&mut self.s));
1575 try!(self.word_space(":"));
1577 try!(self.print_string(a.clobbers.get(), ast::CookedStr));
1578 try!(self.pclose());
1580 ast::ExprMac(ref m) => try!(self.print_mac(m)),
1581 ast::ExprParen(ref e) => {
1583 try!(self.print_expr(&**e));
1584 try!(self.pclose());
1587 try!(self.ann.post(self, NodeExpr(expr)));
1591 pub fn print_local_decl(&mut self, loc: &ast::Local) -> IoResult<()> {
1592 try!(self.print_pat(&*loc.pat));
1594 ast::TyInfer => Ok(()),
1596 try!(self.word_space(":"));
1597 self.print_type(&*loc.ty)
1602 pub fn print_decl(&mut self, decl: &ast::Decl) -> IoResult<()> {
1603 try!(self.maybe_print_comment(decl.span.lo));
1605 ast::DeclLocal(ref loc) => {
1606 try!(self.space_if_not_bol());
1607 try!(self.ibox(indent_unit));
1608 try!(self.word_nbsp("let"));
1610 try!(self.ibox(indent_unit));
1611 try!(self.print_local_decl(&**loc));
1616 try!(self.word_space("="));
1617 try!(self.print_expr(&**init));
1623 ast::DeclItem(ref item) => self.print_item(&**item)
1627 pub fn print_ident(&mut self, ident: ast::Ident) -> IoResult<()> {
1628 word(&mut self.s, token::get_ident(ident).get())
1631 pub fn print_name(&mut self, name: ast::Name) -> IoResult<()> {
1632 word(&mut self.s, token::get_name(name).get())
1635 pub fn print_for_decl(&mut self, loc: &ast::Local,
1636 coll: &ast::Expr) -> IoResult<()> {
1637 try!(self.print_local_decl(loc));
1638 try!(space(&mut self.s));
1639 try!(self.word_space("in"));
1640 self.print_expr(coll)
1643 fn print_path_(&mut self,
1645 colons_before_params: bool,
1646 opt_bounds: &Option<OwnedSlice<ast::TyParamBound>>)
1648 try!(self.maybe_print_comment(path.span.lo));
1650 try!(word(&mut self.s, "::"));
1653 let mut first = true;
1654 for segment in path.segments.iter() {
1658 try!(word(&mut self.s, "::"))
1661 try!(self.print_ident(segment.identifier));
1663 if !segment.lifetimes.is_empty() || !segment.types.is_empty() {
1664 if colons_before_params {
1665 try!(word(&mut self.s, "::"))
1667 try!(word(&mut self.s, "<"));
1669 let mut comma = false;
1670 for lifetime in segment.lifetimes.iter() {
1672 try!(self.word_space(","))
1674 try!(self.print_lifetime(lifetime));
1678 if !segment.types.is_empty() {
1680 try!(self.word_space(","))
1684 segment.types.as_slice(),
1685 |s, ty| s.print_type_ref(ty)));
1688 try!(word(&mut self.s, ">"))
1694 Some(ref bounds) => self.print_bounds(&None, bounds, true, true),
1698 fn print_path(&mut self, path: &ast::Path,
1699 colons_before_params: bool) -> IoResult<()> {
1700 self.print_path_(path, colons_before_params, &None)
1703 fn print_bounded_path(&mut self, path: &ast::Path,
1704 bounds: &Option<OwnedSlice<ast::TyParamBound>>)
1706 self.print_path_(path, false, bounds)
1709 pub fn print_pat(&mut self, pat: &ast::Pat) -> IoResult<()> {
1710 try!(self.maybe_print_comment(pat.span.lo));
1711 try!(self.ann.pre(self, NodePat(pat)));
1712 /* Pat isn't normalized, but the beauty of it
1713 is that it doesn't matter */
1715 ast::PatWild => try!(word(&mut self.s, "_")),
1716 ast::PatWildMulti => try!(word(&mut self.s, "..")),
1717 ast::PatIdent(binding_mode, ref path1, sub) => {
1718 match binding_mode {
1719 ast::BindByRef(mutbl) => {
1720 try!(self.word_nbsp("ref"));
1721 try!(self.print_mutability(mutbl));
1723 ast::BindByValue(ast::MutImmutable) => {}
1724 ast::BindByValue(ast::MutMutable) => {
1725 try!(self.word_nbsp("mut"));
1728 try!(self.print_ident(path1.node));
1731 try!(word(&mut self.s, "@"));
1732 try!(self.print_pat(&**p));
1737 ast::PatEnum(ref path, ref args_) => {
1738 try!(self.print_path(path, true));
1740 None => try!(word(&mut self.s, "(..)")),
1742 if !args.is_empty() {
1744 try!(self.commasep(Inconsistent, args.as_slice(),
1745 |s, p| s.print_pat(&**p)));
1746 try!(self.pclose());
1751 ast::PatStruct(ref path, ref fields, etc) => {
1752 try!(self.print_path(path, true));
1754 try!(self.word_space("{"));
1755 try!(self.commasep_cmnt(
1756 Consistent, fields.as_slice(),
1758 try!(s.cbox(indent_unit));
1759 try!(s.print_ident(f.ident));
1760 try!(s.word_nbsp(":"));
1761 try!(s.print_pat(&*f.pat));
1766 if fields.len() != 0u { try!(self.word_space(",")); }
1767 try!(word(&mut self.s, ".."));
1769 try!(space(&mut self.s));
1770 try!(word(&mut self.s, "}"));
1772 ast::PatTup(ref elts) => {
1774 try!(self.commasep(Inconsistent,
1776 |s, p| s.print_pat(&**p)));
1777 if elts.len() == 1 {
1778 try!(word(&mut self.s, ","));
1780 try!(self.pclose());
1782 ast::PatBox(ref inner) => {
1783 try!(word(&mut self.s, "box "));
1784 try!(self.print_pat(&**inner));
1786 ast::PatRegion(ref inner) => {
1787 try!(word(&mut self.s, "&"));
1788 try!(self.print_pat(&**inner));
1790 ast::PatLit(ref e) => try!(self.print_expr(&**e)),
1791 ast::PatRange(ref begin, ref end) => {
1792 try!(self.print_expr(&**begin));
1793 try!(space(&mut self.s));
1794 try!(word(&mut self.s, ".."));
1795 try!(self.print_expr(&**end));
1797 ast::PatVec(ref before, slice, ref after) => {
1798 try!(word(&mut self.s, "["));
1799 try!(self.commasep(Inconsistent,
1801 |s, p| s.print_pat(&**p)));
1802 for p in slice.iter() {
1803 if !before.is_empty() { try!(self.word_space(",")); }
1805 ast::Pat { node: ast::PatWildMulti, .. } => {
1806 // this case is handled by print_pat
1808 _ => try!(word(&mut self.s, "..")),
1810 try!(self.print_pat(&**p));
1811 if !after.is_empty() { try!(self.word_space(",")); }
1813 try!(self.commasep(Inconsistent,
1815 |s, p| s.print_pat(&**p)));
1816 try!(word(&mut self.s, "]"));
1818 ast::PatMac(ref m) => try!(self.print_mac(m)),
1820 self.ann.post(self, NodePat(pat))
1823 // Returns whether it printed anything
1824 fn print_explicit_self(&mut self,
1825 explicit_self: ast::ExplicitSelf_,
1826 mutbl: ast::Mutability) -> IoResult<bool> {
1827 try!(self.print_mutability(mutbl));
1828 match explicit_self {
1829 ast::SelfStatic => { return Ok(false); }
1830 ast::SelfValue(_) => {
1831 try!(word(&mut self.s, "self"));
1833 ast::SelfUniq(_) => {
1834 try!(word(&mut self.s, "~self"));
1836 ast::SelfRegion(ref lt, m, _) => {
1837 try!(word(&mut self.s, "&"));
1838 try!(self.print_opt_lifetime(lt));
1839 try!(self.print_mutability(m));
1840 try!(word(&mut self.s, "self"));
1846 pub fn print_fn(&mut self,
1848 fn_style: Option<ast::FnStyle>,
1851 generics: &ast::Generics,
1852 opt_explicit_self: Option<ast::ExplicitSelf_>,
1853 vis: ast::Visibility) -> IoResult<()> {
1854 try!(self.head(""));
1855 try!(self.print_fn_header_info(opt_explicit_self, fn_style, abi, vis));
1857 try!(self.print_ident(name));
1858 try!(self.print_generics(generics));
1859 self.print_fn_args_and_ret(decl, opt_explicit_self)
1862 pub fn print_fn_args(&mut self, decl: &ast::FnDecl,
1863 opt_explicit_self: Option<ast::ExplicitSelf_>)
1865 // It is unfortunate to duplicate the commasep logic, but we want the
1866 // self type and the args all in the same box.
1867 try!(self.rbox(0u, Inconsistent));
1868 let mut first = true;
1869 for &explicit_self in opt_explicit_self.iter() {
1870 let m = match explicit_self {
1871 ast::SelfStatic => ast::MutImmutable,
1872 _ => match decl.inputs.get(0).pat.node {
1873 ast::PatIdent(ast::BindByValue(m), _, _) => m,
1874 _ => ast::MutImmutable
1877 first = !try!(self.print_explicit_self(explicit_self, m));
1880 // HACK(eddyb) ignore the separately printed self argument.
1881 let args = if first {
1882 decl.inputs.as_slice()
1884 decl.inputs.slice_from(1)
1887 for arg in args.iter() {
1888 if first { first = false; } else { try!(self.word_space(",")); }
1889 try!(self.print_arg(arg));
1895 pub fn print_fn_args_and_ret(&mut self, decl: &ast::FnDecl,
1896 opt_explicit_self: Option<ast::ExplicitSelf_>)
1899 try!(self.print_fn_args(decl, opt_explicit_self));
1901 try!(word(&mut self.s, ", ..."));
1903 try!(self.pclose());
1905 try!(self.maybe_print_comment(decl.output.span.lo));
1906 match decl.output.node {
1907 ast::TyNil => Ok(()),
1909 try!(self.space_if_not_bol());
1910 try!(self.word_space("->"));
1911 self.print_type(&*decl.output)
1916 pub fn print_fn_block_args(&mut self,
1917 decl: &ast::FnDecl) -> IoResult<()> {
1918 try!(word(&mut self.s, "|"));
1919 try!(self.print_fn_args(decl, None));
1920 try!(word(&mut self.s, "|"));
1922 match decl.output.node {
1925 try!(self.space_if_not_bol());
1926 try!(self.word_space("->"));
1927 try!(self.print_type(&*decl.output));
1931 self.maybe_print_comment(decl.output.span.lo)
1934 pub fn print_proc_args(&mut self, decl: &ast::FnDecl) -> IoResult<()> {
1935 try!(word(&mut self.s, "proc"));
1936 try!(word(&mut self.s, "("));
1937 try!(self.print_fn_args(decl, None));
1938 try!(word(&mut self.s, ")"));
1940 match decl.output.node {
1943 try!(self.space_if_not_bol());
1944 try!(self.word_space("->"));
1945 try!(self.print_type(&*decl.output));
1949 self.maybe_print_comment(decl.output.span.lo)
1952 pub fn print_bounds(&mut self,
1953 region: &Option<ast::Lifetime>,
1954 bounds: &OwnedSlice<ast::TyParamBound>,
1955 print_colon_anyway: bool,
1956 print_plus_before_bounds: bool)
1958 let separator = if print_plus_before_bounds {
1963 if !bounds.is_empty() || region.is_some() {
1964 try!(word(&mut self.s, separator));
1965 let mut first = true;
1968 let token = token::get_name(lt.name);
1969 if token.get() != "'static" {
1972 try!(self.print_lifetime(lt));
1977 for bound in bounds.iter() {
1982 try!(self.word_space("+"));
1986 TraitTyParamBound(ref tref) => self.print_trait_ref(tref),
1987 StaticRegionTyParamBound => word(&mut self.s, "'static"),
1988 UnboxedFnTyParamBound(ref unboxed_function_type) => {
1989 self.print_ty_fn(None,
1994 &*unboxed_function_type.decl,
2001 OtherRegionTyParamBound(_) => Ok(())
2005 } else if print_colon_anyway {
2006 word(&mut self.s, separator)
2012 pub fn print_lifetime(&mut self,
2013 lifetime: &ast::Lifetime) -> IoResult<()> {
2014 self.print_name(lifetime.name)
2017 pub fn print_generics(&mut self,
2018 generics: &ast::Generics) -> IoResult<()> {
2019 let total = generics.lifetimes.len() + generics.ty_params.len();
2021 try!(word(&mut self.s, "<"));
2023 let mut ints = Vec::new();
2024 for i in range(0u, total) {
2029 Inconsistent, ints.as_slice(),
2031 if idx < generics.lifetimes.len() {
2032 let lifetime = generics.lifetimes.get(idx);
2033 s.print_lifetime(lifetime)
2035 let idx = idx - generics.lifetimes.len();
2036 let param = generics.ty_params.get(idx);
2037 match param.unbound {
2038 Some(TraitTyParamBound(ref tref)) => {
2039 try!(s.print_trait_ref(tref));
2040 try!(s.word_space("?"));
2044 try!(s.print_ident(param.ident));
2045 try!(s.print_bounds(&None,
2049 match param.default {
2050 Some(ref default) => {
2051 try!(space(&mut s.s));
2052 try!(s.word_space("="));
2053 s.print_type(&**default)
2059 word(&mut self.s, ">")
2065 pub fn print_meta_item(&mut self, item: &ast::MetaItem) -> IoResult<()> {
2066 try!(self.ibox(indent_unit));
2068 ast::MetaWord(ref name) => {
2069 try!(word(&mut self.s, name.get()));
2071 ast::MetaNameValue(ref name, ref value) => {
2072 try!(self.word_space(name.get()));
2073 try!(self.word_space("="));
2074 try!(self.print_literal(value));
2076 ast::MetaList(ref name, ref items) => {
2077 try!(word(&mut self.s, name.get()));
2079 try!(self.commasep(Consistent,
2081 |s, i| s.print_meta_item(&**i)));
2082 try!(self.pclose());
2088 pub fn print_view_path(&mut self, vp: &ast::ViewPath) -> IoResult<()> {
2090 ast::ViewPathSimple(ident, ref path, _) => {
2091 // FIXME(#6993) can't compare identifiers directly here
2092 if path.segments.last().unwrap().identifier.name != ident.name {
2093 try!(self.print_ident(ident));
2094 try!(space(&mut self.s));
2095 try!(self.word_space("="));
2097 self.print_path(path, false)
2100 ast::ViewPathGlob(ref path, _) => {
2101 try!(self.print_path(path, false));
2102 word(&mut self.s, "::*")
2105 ast::ViewPathList(ref path, ref idents, _) => {
2106 if path.segments.is_empty() {
2107 try!(word(&mut self.s, "{"));
2109 try!(self.print_path(path, false));
2110 try!(word(&mut self.s, "::{"));
2112 try!(self.commasep(Inconsistent, idents.as_slice(), |s, w| {
2113 s.print_ident(w.node.name)
2115 word(&mut self.s, "}")
2120 pub fn print_view_item(&mut self, item: &ast::ViewItem) -> IoResult<()> {
2121 try!(self.hardbreak_if_not_bol());
2122 try!(self.maybe_print_comment(item.span.lo));
2123 try!(self.print_outer_attributes(item.attrs.as_slice()));
2124 try!(self.print_visibility(item.vis));
2126 ast::ViewItemExternCrate(id, ref optional_path, _) => {
2127 try!(self.head("extern crate"));
2128 try!(self.print_ident(id));
2129 for &(ref p, style) in optional_path.iter() {
2130 try!(space(&mut self.s));
2131 try!(word(&mut self.s, "="));
2132 try!(space(&mut self.s));
2133 try!(self.print_string(p.get(), style));
2137 ast::ViewItemUse(ref vp) => {
2138 try!(self.head("use"));
2139 try!(self.print_view_path(&**vp));
2142 try!(word(&mut self.s, ";"));
2143 try!(self.end()); // end inner head-block
2144 self.end() // end outer head-block
2147 pub fn print_mutability(&mut self,
2148 mutbl: ast::Mutability) -> IoResult<()> {
2150 ast::MutMutable => self.word_nbsp("mut"),
2151 ast::MutImmutable => Ok(()),
2155 pub fn print_mt(&mut self, mt: &ast::MutTy) -> IoResult<()> {
2156 try!(self.print_mutability(mt.mutbl));
2157 self.print_type(&*mt.ty)
2160 pub fn print_arg(&mut self, input: &ast::Arg) -> IoResult<()> {
2161 try!(self.ibox(indent_unit));
2162 match input.ty.node {
2163 ast::TyInfer => try!(self.print_pat(&*input.pat)),
2165 match input.pat.node {
2166 ast::PatIdent(_, ref path1, _) if
2168 parse::token::special_idents::invalid.name => {
2172 try!(self.print_pat(&*input.pat));
2173 try!(word(&mut self.s, ":"));
2174 try!(space(&mut self.s));
2177 try!(self.print_type(&*input.ty));
2183 pub fn print_ty_fn(&mut self,
2184 opt_abi: Option<abi::Abi>,
2185 opt_sigil: Option<char>,
2186 opt_region: &Option<ast::Lifetime>,
2187 fn_style: ast::FnStyle,
2188 onceness: ast::Onceness,
2190 id: Option<ast::Ident>,
2191 opt_bounds: &Option<OwnedSlice<ast::TyParamBound>>,
2192 generics: Option<&ast::Generics>,
2193 opt_explicit_self: Option<ast::ExplicitSelf_>,
2196 try!(self.ibox(indent_unit));
2198 // Duplicates the logic in `print_fn_header_info()`. This is because that
2199 // function prints the sigil in the wrong place. That should be fixed.
2200 if opt_sigil == Some('~') && onceness == ast::Once {
2201 try!(word(&mut self.s, "proc"));
2202 } else if opt_sigil == Some('&') {
2203 try!(self.print_fn_style(fn_style));
2204 try!(self.print_extern_opt_abi(opt_abi));
2205 try!(self.print_onceness(onceness));
2207 assert!(opt_sigil.is_none());
2208 try!(self.print_fn_style(fn_style));
2209 try!(self.print_opt_abi_and_extern_if_nondefault(opt_abi));
2210 try!(self.print_onceness(onceness));
2212 try!(word(&mut self.s, "fn"));
2218 try!(word(&mut self.s, " "));
2219 try!(self.print_ident(id));
2224 match generics { Some(g) => try!(self.print_generics(g)), _ => () }
2225 try!(zerobreak(&mut self.s));
2227 if is_unboxed || opt_sigil == Some('&') {
2228 try!(word(&mut self.s, "|"));
2234 try!(word(&mut self.s, "&mut"));
2235 try!(self.word_space(":"));
2238 try!(self.print_fn_args(decl, opt_explicit_self));
2240 if is_unboxed || opt_sigil == Some('&') {
2241 try!(word(&mut self.s, "|"));
2244 try!(word(&mut self.s, ", ..."));
2246 try!(self.pclose());
2249 opt_bounds.as_ref().map(|bounds| {
2250 self.print_bounds(opt_region, bounds, true, false)
2253 try!(self.maybe_print_comment(decl.output.span.lo));
2255 match decl.output.node {
2258 try!(self.space_if_not_bol());
2259 try!(self.ibox(indent_unit));
2260 try!(self.word_space("->"));
2261 if decl.cf == ast::NoReturn {
2262 try!(self.word_nbsp("!"));
2264 try!(self.print_type(&*decl.output));
2273 pub fn maybe_print_trailing_comment(&mut self, span: codemap::Span,
2274 next_pos: Option<BytePos>)
2276 let cm = match self.cm {
2280 match self.next_comment() {
2282 if (*cmnt).style != comments::Trailing { return Ok(()) }
2283 let span_line = cm.lookup_char_pos(span.hi);
2284 let comment_line = cm.lookup_char_pos((*cmnt).pos);
2285 let mut next = (*cmnt).pos + BytePos(1);
2286 match next_pos { None => (), Some(p) => next = p }
2287 if span.hi < (*cmnt).pos && (*cmnt).pos < next &&
2288 span_line.line == comment_line.line {
2289 try!(self.print_comment(cmnt));
2290 self.cur_cmnt_and_lit.cur_cmnt += 1u;
2298 pub fn print_remaining_comments(&mut self) -> IoResult<()> {
2299 // If there aren't any remaining comments, then we need to manually
2300 // make sure there is a line break at the end.
2301 if self.next_comment().is_none() {
2302 try!(hardbreak(&mut self.s));
2305 match self.next_comment() {
2307 try!(self.print_comment(cmnt));
2308 self.cur_cmnt_and_lit.cur_cmnt += 1u;
2316 pub fn print_literal(&mut self, lit: &ast::Lit) -> IoResult<()> {
2317 try!(self.maybe_print_comment(lit.span.lo));
2318 match self.next_lit(lit.span.lo) {
2320 return word(&mut self.s, (*ltrl).lit.as_slice());
2325 ast::LitStr(ref st, style) => self.print_string(st.get(), style),
2326 ast::LitByte(byte) => {
2327 let mut res = String::from_str("b'");
2328 (byte as char).escape_default(|c| res.push_char(c));
2329 res.push_char('\'');
2330 word(&mut self.s, res.as_slice())
2332 ast::LitChar(ch) => {
2333 let mut res = String::from_str("'");
2334 ch.escape_default(|c| res.push_char(c));
2335 res.push_char('\'');
2336 word(&mut self.s, res.as_slice())
2338 ast::LitInt(i, t) => {
2340 ast_util::int_ty_to_string(t, Some(i)).as_slice())
2342 ast::LitUint(u, t) => {
2344 ast_util::uint_ty_to_string(t, Some(u)).as_slice())
2346 ast::LitIntUnsuffixed(i) => {
2347 word(&mut self.s, format!("{}", i).as_slice())
2349 ast::LitFloat(ref f, t) => {
2354 ast_util::float_ty_to_string(t).as_slice()).as_slice())
2356 ast::LitFloatUnsuffixed(ref f) => word(&mut self.s, f.get()),
2357 ast::LitNil => word(&mut self.s, "()"),
2358 ast::LitBool(val) => {
2359 if val { word(&mut self.s, "true") } else { word(&mut self.s, "false") }
2361 ast::LitBinary(ref v) => {
2362 let escaped: String = v.iter().map(|&b| b as char).collect();
2363 word(&mut self.s, format!("b\"{}\"", escaped.escape_default()).as_slice())
2368 pub fn next_lit(&mut self, pos: BytePos) -> Option<comments::Literal> {
2369 match self.literals {
2371 while self.cur_cmnt_and_lit.cur_lit < lits.len() {
2372 let ltrl = (*(*lits).get(self.cur_cmnt_and_lit.cur_lit)).clone();
2373 if ltrl.pos > pos { return None; }
2374 self.cur_cmnt_and_lit.cur_lit += 1u;
2375 if ltrl.pos == pos { return Some(ltrl); }
2383 pub fn maybe_print_comment(&mut self, pos: BytePos) -> IoResult<()> {
2385 match self.next_comment() {
2387 if (*cmnt).pos < pos {
2388 try!(self.print_comment(cmnt));
2389 self.cur_cmnt_and_lit.cur_cmnt += 1u;
2398 pub fn print_comment(&mut self,
2399 cmnt: &comments::Comment) -> IoResult<()> {
2401 comments::Mixed => {
2402 assert_eq!(cmnt.lines.len(), 1u);
2403 try!(zerobreak(&mut self.s));
2404 try!(word(&mut self.s, cmnt.lines.get(0).as_slice()));
2405 zerobreak(&mut self.s)
2407 comments::Isolated => {
2408 try!(self.hardbreak_if_not_bol());
2409 for line in cmnt.lines.iter() {
2410 // Don't print empty lines because they will end up as trailing
2412 if !line.is_empty() {
2413 try!(word(&mut self.s, line.as_slice()));
2415 try!(hardbreak(&mut self.s));
2419 comments::Trailing => {
2420 try!(word(&mut self.s, " "));
2421 if cmnt.lines.len() == 1u {
2422 try!(word(&mut self.s, cmnt.lines.get(0).as_slice()));
2423 hardbreak(&mut self.s)
2425 try!(self.ibox(0u));
2426 for line in cmnt.lines.iter() {
2427 if !line.is_empty() {
2428 try!(word(&mut self.s, line.as_slice()));
2430 try!(hardbreak(&mut self.s));
2435 comments::BlankLine => {
2436 // We need to do at least one, possibly two hardbreaks.
2437 let is_semi = match self.s.last_token() {
2438 pp::String(s, _) => ";" == s.as_slice(),
2441 if is_semi || self.is_begin() || self.is_end() {
2442 try!(hardbreak(&mut self.s));
2444 hardbreak(&mut self.s)
2449 pub fn print_string(&mut self, st: &str,
2450 style: ast::StrStyle) -> IoResult<()> {
2451 let st = match style {
2453 (format!("\"{}\"", st.escape_default()))
2456 (format!("r{delim}\"{string}\"{delim}",
2457 delim="#".repeat(n),
2461 word(&mut self.s, st.as_slice())
2464 pub fn next_comment(&mut self) -> Option<comments::Comment> {
2465 match self.comments {
2466 Some(ref cmnts) => {
2467 if self.cur_cmnt_and_lit.cur_cmnt < cmnts.len() {
2468 Some((*cmnts.get(self.cur_cmnt_and_lit.cur_cmnt)).clone())
2477 pub fn print_opt_fn_style(&mut self,
2478 opt_fn_style: Option<ast::FnStyle>) -> IoResult<()> {
2479 match opt_fn_style {
2480 Some(fn_style) => self.print_fn_style(fn_style),
2485 pub fn print_opt_abi_and_extern_if_nondefault(&mut self,
2486 opt_abi: Option<abi::Abi>)
2489 Some(abi::Rust) => Ok(()),
2491 try!(self.word_nbsp("extern"));
2492 self.word_nbsp(abi.to_string().as_slice())
2498 pub fn print_extern_opt_abi(&mut self,
2499 opt_abi: Option<abi::Abi>) -> IoResult<()> {
2502 try!(self.word_nbsp("extern"));
2503 self.word_nbsp(abi.to_string().as_slice())
2509 pub fn print_fn_header_info(&mut self,
2510 _opt_explicit_self: Option<ast::ExplicitSelf_>,
2511 opt_fn_style: Option<ast::FnStyle>,
2513 vis: ast::Visibility) -> IoResult<()> {
2514 try!(word(&mut self.s, visibility_qualified(vis, "").as_slice()));
2515 try!(self.print_opt_fn_style(opt_fn_style));
2517 if abi != abi::Rust {
2518 try!(self.word_nbsp("extern"));
2519 try!(self.word_nbsp(abi.to_string().as_slice()));
2522 word(&mut self.s, "fn")
2525 pub fn print_fn_style(&mut self, s: ast::FnStyle) -> IoResult<()> {
2527 ast::NormalFn => Ok(()),
2528 ast::UnsafeFn => self.word_nbsp("unsafe"),
2532 pub fn print_onceness(&mut self, o: ast::Onceness) -> IoResult<()> {
2534 ast::Once => self.word_nbsp("once"),
2550 fn test_fun_to_string() {
2551 let abba_ident = token::str_to_ident("abba");
2553 let decl = ast::FnDecl {
2555 output: ast::P(ast::Ty {id: 0,
2557 span: codemap::DUMMY_SP}),
2561 let generics = ast_util::empty_generics();
2562 assert_eq!(&fun_to_string(&decl, ast::NormalFn, abba_ident,
2564 &"fn abba()".to_string());
2568 fn test_variant_to_string() {
2569 let ident = token::str_to_ident("principal_skinner");
2571 let var = codemap::respan(codemap::DUMMY_SP, ast::Variant_ {
2574 // making this up as I go.... ?
2575 kind: ast::TupleVariantKind(Vec::new()),
2581 let varstr = variant_to_string(&var);
2582 assert_eq!(&varstr,&"pub principal_skinner".to_string());