1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 pub use self::AnnNode::*;
15 use syntax::codemap::{CodeMap, Spanned};
16 use syntax::parse::ParseSess;
17 use syntax::parse::lexer::comments;
18 use syntax::print::pp::{self, Breaks};
19 use syntax::print::pp::Breaks::{Consistent, Inconsistent};
20 use syntax::print::pprust::PrintState;
22 use syntax::symbol::keywords;
23 use syntax::util::parser::{self, AssocOp, Fixity};
24 use syntax_pos::{self, BytePos, FileName};
27 use hir::{PatKind, RegionTyParamBound, TraitTyParamBound, TraitBoundModifier, RangeEnd};
30 use std::io::{self, Write, Read};
31 use std::iter::Peekable;
34 pub enum AnnNode<'a> {
35 NodeName(&'a ast::Name),
36 NodeBlock(&'a hir::Block),
37 NodeItem(&'a hir::Item),
38 NodeSubItem(ast::NodeId),
39 NodeExpr(&'a hir::Expr),
40 NodePat(&'a hir::Pat),
45 TraitItem(hir::TraitItemId),
46 ImplItem(hir::ImplItemId),
48 BodyArgPat(hir::BodyId, usize)
52 fn nested(&self, _state: &mut State, _nested: Nested) -> io::Result<()> {
55 fn pre(&self, _state: &mut State, _node: AnnNode) -> io::Result<()> {
58 fn post(&self, _state: &mut State, _node: AnnNode) -> io::Result<()> {
64 impl PpAnn for NoAnn {}
65 pub const NO_ANN: &'static PpAnn = &NoAnn;
67 impl PpAnn for hir::Crate {
68 fn nested(&self, state: &mut State, nested: Nested) -> io::Result<()> {
70 Nested::Item(id) => state.print_item(self.item(id.id)),
71 Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
72 Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
73 Nested::Body(id) => state.print_expr(&self.body(id).value),
74 Nested::BodyArgPat(id, i) => state.print_pat(&self.body(id).arguments[i].pat)
79 pub struct State<'a> {
80 pub s: pp::Printer<'a>,
81 cm: Option<&'a CodeMap>,
82 comments: Option<Vec<comments::Comment>>,
83 literals: Peekable<vec::IntoIter<comments::Literal>>,
85 boxes: Vec<pp::Breaks>,
86 ann: &'a (PpAnn + 'a),
89 impl<'a> PrintState<'a> for State<'a> {
90 fn writer(&mut self) -> &mut pp::Printer<'a> {
94 fn boxes(&mut self) -> &mut Vec<pp::Breaks> {
98 fn comments(&mut self) -> &mut Option<Vec<comments::Comment>> {
102 fn cur_cmnt(&mut self) -> &mut usize {
106 fn cur_lit(&mut self) -> Option<&comments::Literal> {
110 fn bump_lit(&mut self) -> Option<comments::Literal> {
115 #[allow(non_upper_case_globals)]
116 pub const indent_unit: usize = 4;
118 #[allow(non_upper_case_globals)]
119 pub const default_columns: usize = 78;
122 /// Requires you to pass an input filename and reader so that
123 /// it can scan the input text for comments and literals to
125 pub fn print_crate<'a>(cm: &'a CodeMap,
130 out: Box<Write + 'a>,
134 let mut s = State::new_from_input(cm, sess, filename, input, out, ann, is_expanded);
136 // When printing the AST, we sometimes need to inject `#[no_std]` here.
137 // Since you can't compile the HIR, it's not necessary.
139 s.print_mod(&krate.module, &krate.attrs)?;
140 s.print_remaining_comments()?;
145 pub fn new_from_input(cm: &'a CodeMap,
149 out: Box<Write + 'a>,
153 let (cmnts, lits) = comments::gather_comments_and_literals(sess, filename, input);
159 // If the code is post expansion, don't use the table of
160 // literals, since it doesn't correspond with the literals
161 // in the AST anymore.
169 pub fn new(cm: &'a CodeMap,
170 out: Box<Write + 'a>,
172 comments: Option<Vec<comments::Comment>>,
173 literals: Option<Vec<comments::Literal>>)
176 s: pp::mk_printer(out, default_columns),
178 comments: comments.clone(),
179 literals: literals.unwrap_or_default().into_iter().peekable(),
187 pub fn to_string<F>(ann: &PpAnn, f: F) -> String
188 where F: FnOnce(&mut State) -> io::Result<()>
190 let mut wr = Vec::new();
192 let mut printer = State {
193 s: pp::mk_printer(Box::new(&mut wr), default_columns),
196 literals: vec![].into_iter().peekable(),
201 f(&mut printer).unwrap();
202 printer.s.eof().unwrap();
204 String::from_utf8(wr).unwrap()
207 pub fn visibility_qualified(vis: &hir::Visibility, w: &str) -> String {
208 to_string(NO_ANN, |s| {
209 s.print_visibility(vis)?;
215 pub fn cbox(&mut self, u: usize) -> io::Result<()> {
216 self.boxes.push(pp::Breaks::Consistent);
220 pub fn nbsp(&mut self) -> io::Result<()> {
224 pub fn word_nbsp(&mut self, w: &str) -> io::Result<()> {
229 pub fn head(&mut self, w: &str) -> io::Result<()> {
230 // outer-box is consistent
231 self.cbox(indent_unit)?;
232 // head-box is inconsistent
233 self.ibox(w.len() + 1)?;
234 // keyword that starts the head
241 pub fn bopen(&mut self) -> io::Result<()> {
243 self.end() // close the head-box
246 pub fn bclose_(&mut self, span: syntax_pos::Span, indented: usize) -> io::Result<()> {
247 self.bclose_maybe_open(span, indented, true)
249 pub fn bclose_maybe_open(&mut self,
250 span: syntax_pos::Span,
254 self.maybe_print_comment(span.hi())?;
255 self.break_offset_if_not_bol(1, -(indented as isize))?;
258 self.end()?; // close the outer-box
262 pub fn bclose(&mut self, span: syntax_pos::Span) -> io::Result<()> {
263 self.bclose_(span, indent_unit)
266 pub fn in_cbox(&self) -> bool {
267 match self.boxes.last() {
268 Some(&last_box) => last_box == pp::Breaks::Consistent,
272 pub fn space_if_not_bol(&mut self) -> io::Result<()> {
278 pub fn break_offset_if_not_bol(&mut self, n: usize, off: isize) -> io::Result<()> {
280 self.s.break_offset(n, off)
282 if off != 0 && self.s.last_token().is_hardbreak_tok() {
283 // We do something pretty sketchy here: tuck the nonzero
284 // offset-adjustment we were going to deposit along with the
285 // break into the previous hardbreak.
286 self.s.replace_last_token(pp::Printer::hardbreak_tok_offset(off));
292 // Synthesizes a comment that was not textually present in the original source
294 pub fn synth_comment(&mut self, text: String) -> io::Result<()> {
297 self.s.word(&text[..])?;
303 pub fn commasep_cmnt<T, F, G>(&mut self,
309 where F: FnMut(&mut State, &T) -> io::Result<()>,
310 G: FnMut(&T) -> syntax_pos::Span
313 let len = elts.len();
316 self.maybe_print_comment(get_span(elt).hi())?;
321 self.maybe_print_trailing_comment(get_span(elt), Some(get_span(&elts[i]).hi()))?;
322 self.space_if_not_bol()?;
328 pub fn commasep_exprs(&mut self, b: Breaks, exprs: &[hir::Expr]) -> io::Result<()> {
329 self.commasep_cmnt(b, exprs, |s, e| s.print_expr(&e), |e| e.span)
332 pub fn print_mod(&mut self, _mod: &hir::Mod, attrs: &[ast::Attribute]) -> io::Result<()> {
333 self.print_inner_attributes(attrs)?;
334 for &item_id in &_mod.item_ids {
335 self.ann.nested(self, Nested::Item(item_id))?;
340 pub fn print_foreign_mod(&mut self,
341 nmod: &hir::ForeignMod,
342 attrs: &[ast::Attribute])
344 self.print_inner_attributes(attrs)?;
345 for item in &nmod.items {
346 self.print_foreign_item(item)?;
351 pub fn print_opt_lifetime(&mut self, lifetime: &hir::Lifetime) -> io::Result<()> {
352 if !lifetime.is_elided() {
353 self.print_lifetime(lifetime)?;
359 pub fn print_type(&mut self, ty: &hir::Ty) -> io::Result<()> {
360 self.maybe_print_comment(ty.span.lo())?;
363 hir::TySlice(ref ty) => {
365 self.print_type(&ty)?;
368 hir::TyPtr(ref mt) => {
371 hir::MutMutable => self.word_nbsp("mut")?,
372 hir::MutImmutable => self.word_nbsp("const")?,
374 self.print_type(&mt.ty)?;
376 hir::TyRptr(ref lifetime, ref mt) => {
378 self.print_opt_lifetime(lifetime)?;
384 hir::TyTup(ref elts) => {
386 self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(&ty))?;
392 hir::TyBareFn(ref f) => {
393 self.print_ty_fn(f.abi, f.unsafety, &f.decl, None, &f.generic_params,
396 hir::TyPath(ref qpath) => {
397 self.print_qpath(qpath, false)?
399 hir::TyTraitObject(ref bounds, ref lifetime) => {
400 let mut first = true;
401 for bound in bounds {
406 self.word_space("+")?;
408 self.print_poly_trait_ref(bound)?;
410 if !lifetime.is_elided() {
412 self.word_space("+")?;
413 self.print_lifetime(lifetime)?;
416 hir::TyImplTraitExistential(ref existty, ref _lifetimes) => {
417 self.print_bounds("impl", &existty.bounds[..])?;
419 hir::TyArray(ref ty, v) => {
421 self.print_type(&ty)?;
423 self.ann.nested(self, Nested::Body(v))?;
426 hir::TyTypeof(e) => {
427 self.s.word("typeof(")?;
428 self.ann.nested(self, Nested::Body(e))?;
441 pub fn print_foreign_item(&mut self, item: &hir::ForeignItem) -> io::Result<()> {
442 self.hardbreak_if_not_bol()?;
443 self.maybe_print_comment(item.span.lo())?;
444 self.print_outer_attributes(&item.attrs)?;
446 hir::ForeignItemFn(ref decl, ref arg_names, ref generics) => {
449 hir::Unsafety::Normal,
450 hir::Constness::NotConst,
457 self.end()?; // end head-ibox
459 self.end() // end the outer fn box
461 hir::ForeignItemStatic(ref t, m) => {
462 self.head(&visibility_qualified(&item.vis, "static"))?;
464 self.word_space("mut")?;
466 self.print_name(item.name)?;
467 self.word_space(":")?;
468 self.print_type(&t)?;
470 self.end()?; // end the head-ibox
471 self.end() // end the outer cbox
473 hir::ForeignItemType => {
474 self.head(&visibility_qualified(&item.vis, "type"))?;
475 self.print_name(item.name)?;
477 self.end()?; // end the head-ibox
478 self.end() // end the outer cbox
483 fn print_associated_const(&mut self,
486 default: Option<hir::BodyId>,
487 vis: &hir::Visibility)
489 self.s.word(&visibility_qualified(vis, ""))?;
490 self.word_space("const")?;
491 self.print_name(name)?;
492 self.word_space(":")?;
493 self.print_type(ty)?;
494 if let Some(expr) = default {
496 self.word_space("=")?;
497 self.ann.nested(self, Nested::Body(expr))?;
502 fn print_associated_type(&mut self,
504 bounds: Option<&hir::TyParamBounds>,
505 ty: Option<&hir::Ty>)
507 self.word_space("type")?;
508 self.print_name(name)?;
509 if let Some(bounds) = bounds {
510 self.print_bounds(":", bounds)?;
512 if let Some(ty) = ty {
514 self.word_space("=")?;
515 self.print_type(ty)?;
520 /// Pretty-print an item
521 pub fn print_item(&mut self, item: &hir::Item) -> io::Result<()> {
522 self.hardbreak_if_not_bol()?;
523 self.maybe_print_comment(item.span.lo())?;
524 self.print_outer_attributes(&item.attrs)?;
525 self.ann.pre(self, NodeItem(item))?;
527 hir::ItemExternCrate(ref optional_path) => {
528 self.head(&visibility_qualified(&item.vis, "extern crate"))?;
529 if let Some(p) = *optional_path {
530 let val = p.as_str();
531 if val.contains("-") {
532 self.print_string(&val, ast::StrStyle::Cooked)?;
540 self.print_name(item.name)?;
542 self.end()?; // end inner head-block
543 self.end()?; // end outer head-block
545 hir::ItemUse(ref path, kind) => {
546 self.head(&visibility_qualified(&item.vis, "use"))?;
547 self.print_path(path, false)?;
550 hir::UseKind::Single => {
551 if path.segments.last().unwrap().name != item.name {
553 self.word_space("as")?;
554 self.print_name(item.name)?;
558 hir::UseKind::Glob => self.s.word("::*;")?,
559 hir::UseKind::ListStem => self.s.word("::{};")?
561 self.end()?; // end inner head-block
562 self.end()?; // end outer head-block
564 hir::ItemStatic(ref ty, m, expr) => {
565 self.head(&visibility_qualified(&item.vis, "static"))?;
566 if m == hir::MutMutable {
567 self.word_space("mut")?;
569 self.print_name(item.name)?;
570 self.word_space(":")?;
571 self.print_type(&ty)?;
573 self.end()?; // end the head-ibox
575 self.word_space("=")?;
576 self.ann.nested(self, Nested::Body(expr))?;
578 self.end()?; // end the outer cbox
580 hir::ItemConst(ref ty, expr) => {
581 self.head(&visibility_qualified(&item.vis, "const"))?;
582 self.print_name(item.name)?;
583 self.word_space(":")?;
584 self.print_type(&ty)?;
586 self.end()?; // end the head-ibox
588 self.word_space("=")?;
589 self.ann.nested(self, Nested::Body(expr))?;
591 self.end()?; // end the outer cbox
593 hir::ItemFn(ref decl, unsafety, constness, abi, ref typarams, body) => {
605 self.end()?; // need to close a box
606 self.end()?; // need to close a box
607 self.ann.nested(self, Nested::Body(body))?;
609 hir::ItemMod(ref _mod) => {
610 self.head(&visibility_qualified(&item.vis, "mod"))?;
611 self.print_name(item.name)?;
614 self.print_mod(_mod, &item.attrs)?;
615 self.bclose(item.span)?;
617 hir::ItemForeignMod(ref nmod) => {
618 self.head("extern")?;
619 self.word_nbsp(&nmod.abi.to_string())?;
621 self.print_foreign_mod(nmod, &item.attrs)?;
622 self.bclose(item.span)?;
624 hir::ItemGlobalAsm(ref ga) => {
625 self.head(&visibility_qualified(&item.vis, "global asm"))?;
626 self.s.word(&ga.asm.as_str())?;
629 hir::ItemTy(ref ty, ref generics) => {
630 self.ibox(indent_unit)?;
632 self.word_nbsp(&visibility_qualified(&item.vis, "type"))?;
633 self.print_name(item.name)?;
634 self.print_generic_params(&generics.params)?;
635 self.end()?; // end the inner ibox
637 self.print_where_clause(&generics.where_clause)?;
639 self.word_space("=")?;
640 self.print_type(&ty)?;
642 self.end()?; // end the outer ibox
644 hir::ItemEnum(ref enum_definition, ref params) => {
645 self.print_enum_def(enum_definition, params, item.name, item.span, &item.vis)?;
647 hir::ItemStruct(ref struct_def, ref generics) => {
648 self.head(&visibility_qualified(&item.vis, "struct"))?;
649 self.print_struct(struct_def, generics, item.name, item.span, true)?;
651 hir::ItemUnion(ref struct_def, ref generics) => {
652 self.head(&visibility_qualified(&item.vis, "union"))?;
653 self.print_struct(struct_def, generics, item.name, item.span, true)?;
655 hir::ItemAutoImpl(unsafety, ref trait_ref) => {
657 self.print_visibility(&item.vis)?;
658 self.print_unsafety(unsafety)?;
659 self.word_nbsp("impl")?;
660 self.print_trait_ref(trait_ref)?;
662 self.word_space("for")?;
663 self.word_space("..")?;
665 self.bclose(item.span)?;
667 hir::ItemImpl(unsafety,
675 self.print_visibility(&item.vis)?;
676 self.print_defaultness(defaultness)?;
677 self.print_unsafety(unsafety)?;
678 self.word_nbsp("impl")?;
680 if !generics.params.is_empty() {
681 self.print_generic_params(&generics.params)?;
686 hir::ImplPolarity::Negative => {
694 self.print_trait_ref(t)?;
696 self.word_space("for")?;
701 self.print_type(&ty)?;
702 self.print_where_clause(&generics.where_clause)?;
706 self.print_inner_attributes(&item.attrs)?;
707 for impl_item in impl_items {
708 self.ann.nested(self, Nested::ImplItem(impl_item.id))?;
710 self.bclose(item.span)?;
712 hir::ItemTrait(is_auto, unsafety, ref generics, ref bounds, ref trait_items) => {
714 self.print_visibility(&item.vis)?;
715 self.print_is_auto(is_auto)?;
716 self.print_unsafety(unsafety)?;
717 self.word_nbsp("trait")?;
718 self.print_name(item.name)?;
719 self.print_generic_params(&generics.params)?;
720 let mut real_bounds = Vec::with_capacity(bounds.len());
721 for b in bounds.iter() {
722 if let TraitTyParamBound(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
724 self.word_space("for ?")?;
725 self.print_trait_ref(&ptr.trait_ref)?;
727 real_bounds.push(b.clone());
730 self.print_bounds(":", &real_bounds[..])?;
731 self.print_where_clause(&generics.where_clause)?;
734 for trait_item in trait_items {
735 self.ann.nested(self, Nested::TraitItem(trait_item.id))?;
737 self.bclose(item.span)?;
739 hir::ItemTraitAlias(ref generics, ref bounds) => {
741 self.print_visibility(&item.vis)?;
742 self.word_nbsp("trait")?;
743 self.print_name(item.name)?;
744 self.print_generic_params(&generics.params)?;
745 let mut real_bounds = Vec::with_capacity(bounds.len());
746 // FIXME(durka) this seems to be some quite outdated syntax
747 for b in bounds.iter() {
748 if let TraitTyParamBound(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
750 self.word_space("for ?")?;
751 self.print_trait_ref(&ptr.trait_ref)?;
753 real_bounds.push(b.clone());
757 self.print_bounds("=", &real_bounds[..])?;
758 self.print_where_clause(&generics.where_clause)?;
762 self.ann.post(self, NodeItem(item))
765 pub fn print_trait_ref(&mut self, t: &hir::TraitRef) -> io::Result<()> {
766 self.print_path(&t.path, false)
769 fn print_formal_generic_params(
771 generic_params: &[hir::GenericParam]
772 ) -> io::Result<()> {
773 if !generic_params.is_empty() {
775 self.print_generic_params(generic_params)?;
781 fn print_poly_trait_ref(&mut self, t: &hir::PolyTraitRef) -> io::Result<()> {
782 self.print_formal_generic_params(&t.bound_generic_params)?;
783 self.print_trait_ref(&t.trait_ref)
786 pub fn print_enum_def(&mut self,
787 enum_definition: &hir::EnumDef,
788 generics: &hir::Generics,
790 span: syntax_pos::Span,
791 visibility: &hir::Visibility)
793 self.head(&visibility_qualified(visibility, "enum"))?;
794 self.print_name(name)?;
795 self.print_generic_params(&generics.params)?;
796 self.print_where_clause(&generics.where_clause)?;
798 self.print_variants(&enum_definition.variants, span)
801 pub fn print_variants(&mut self,
802 variants: &[hir::Variant],
803 span: syntax_pos::Span)
807 self.space_if_not_bol()?;
808 self.maybe_print_comment(v.span.lo())?;
809 self.print_outer_attributes(&v.node.attrs)?;
810 self.ibox(indent_unit)?;
811 self.print_variant(v)?;
814 self.maybe_print_trailing_comment(v.span, None)?;
819 pub fn print_visibility(&mut self, vis: &hir::Visibility) -> io::Result<()> {
821 hir::Public => self.word_nbsp("pub"),
822 hir::Visibility::Crate => self.word_nbsp("pub(crate)"),
823 hir::Visibility::Restricted { ref path, .. } => {
824 self.s.word("pub(")?;
825 self.print_path(path, false)?;
828 hir::Inherited => Ok(()),
832 pub fn print_defaultness(&mut self, defaultness: hir::Defaultness) -> io::Result<()> {
834 hir::Defaultness::Default { .. } => self.word_nbsp("default")?,
835 hir::Defaultness::Final => (),
840 pub fn print_struct(&mut self,
841 struct_def: &hir::VariantData,
842 generics: &hir::Generics,
844 span: syntax_pos::Span,
845 print_finalizer: bool)
847 self.print_name(name)?;
848 self.print_generic_params(&generics.params)?;
849 if !struct_def.is_struct() {
850 if struct_def.is_tuple() {
852 self.commasep(Inconsistent, struct_def.fields(), |s, field| {
853 s.maybe_print_comment(field.span.lo())?;
854 s.print_outer_attributes(&field.attrs)?;
855 s.print_visibility(&field.vis)?;
856 s.print_type(&field.ty)
860 self.print_where_clause(&generics.where_clause)?;
865 self.end() // close the outer-box
867 self.print_where_clause(&generics.where_clause)?;
870 self.hardbreak_if_not_bol()?;
872 for field in struct_def.fields() {
873 self.hardbreak_if_not_bol()?;
874 self.maybe_print_comment(field.span.lo())?;
875 self.print_outer_attributes(&field.attrs)?;
876 self.print_visibility(&field.vis)?;
877 self.print_name(field.name)?;
878 self.word_nbsp(":")?;
879 self.print_type(&field.ty)?;
887 pub fn print_variant(&mut self, v: &hir::Variant) -> io::Result<()> {
889 let generics = hir::Generics::empty();
890 self.print_struct(&v.node.data, &generics, v.node.name, v.span, false)?;
891 if let Some(d) = v.node.disr_expr {
893 self.word_space("=")?;
894 self.ann.nested(self, Nested::Body(d))?;
898 pub fn print_method_sig(&mut self,
901 generics: &hir::Generics,
902 vis: &hir::Visibility,
903 arg_names: &[Spanned<ast::Name>],
904 body_id: Option<hir::BodyId>)
906 self.print_fn(&m.decl,
917 pub fn print_trait_item(&mut self, ti: &hir::TraitItem) -> io::Result<()> {
918 self.ann.pre(self, NodeSubItem(ti.id))?;
919 self.hardbreak_if_not_bol()?;
920 self.maybe_print_comment(ti.span.lo())?;
921 self.print_outer_attributes(&ti.attrs)?;
923 hir::TraitItemKind::Const(ref ty, default) => {
924 self.print_associated_const(ti.name, &ty, default, &hir::Inherited)?;
926 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Required(ref arg_names)) => {
927 self.print_method_sig(ti.name, sig, &ti.generics, &hir::Inherited, arg_names,
931 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Provided(body)) => {
933 self.print_method_sig(ti.name, sig, &ti.generics, &hir::Inherited, &[],
936 self.end()?; // need to close a box
937 self.end()?; // need to close a box
938 self.ann.nested(self, Nested::Body(body))?;
940 hir::TraitItemKind::Type(ref bounds, ref default) => {
941 self.print_associated_type(ti.name,
943 default.as_ref().map(|ty| &**ty))?;
946 self.ann.post(self, NodeSubItem(ti.id))
949 pub fn print_impl_item(&mut self, ii: &hir::ImplItem) -> io::Result<()> {
950 self.ann.pre(self, NodeSubItem(ii.id))?;
951 self.hardbreak_if_not_bol()?;
952 self.maybe_print_comment(ii.span.lo())?;
953 self.print_outer_attributes(&ii.attrs)?;
954 self.print_defaultness(ii.defaultness)?;
957 hir::ImplItemKind::Const(ref ty, expr) => {
958 self.print_associated_const(ii.name, &ty, Some(expr), &ii.vis)?;
960 hir::ImplItemKind::Method(ref sig, body) => {
962 self.print_method_sig(ii.name, sig, &ii.generics, &ii.vis, &[], Some(body))?;
964 self.end()?; // need to close a box
965 self.end()?; // need to close a box
966 self.ann.nested(self, Nested::Body(body))?;
968 hir::ImplItemKind::Type(ref ty) => {
969 self.print_associated_type(ii.name, None, Some(ty))?;
972 self.ann.post(self, NodeSubItem(ii.id))
975 pub fn print_stmt(&mut self, st: &hir::Stmt) -> io::Result<()> {
976 self.maybe_print_comment(st.span.lo())?;
978 hir::StmtDecl(ref decl, _) => {
979 self.print_decl(&decl)?;
981 hir::StmtExpr(ref expr, _) => {
982 self.space_if_not_bol()?;
983 self.print_expr(&expr)?;
985 hir::StmtSemi(ref expr, _) => {
986 self.space_if_not_bol()?;
987 self.print_expr(&expr)?;
991 if stmt_ends_with_semi(&st.node) {
994 self.maybe_print_trailing_comment(st.span, None)
997 pub fn print_block(&mut self, blk: &hir::Block) -> io::Result<()> {
998 self.print_block_with_attrs(blk, &[])
1001 pub fn print_block_unclosed(&mut self, blk: &hir::Block) -> io::Result<()> {
1002 self.print_block_unclosed_indent(blk, indent_unit)
1005 pub fn print_block_unclosed_indent(&mut self,
1009 self.print_block_maybe_unclosed(blk, indented, &[], false)
1012 pub fn print_block_with_attrs(&mut self,
1014 attrs: &[ast::Attribute])
1016 self.print_block_maybe_unclosed(blk, indent_unit, attrs, true)
1019 pub fn print_block_maybe_unclosed(&mut self,
1022 attrs: &[ast::Attribute],
1026 hir::UnsafeBlock(..) => self.word_space("unsafe")?,
1027 hir::PushUnsafeBlock(..) => self.word_space("push_unsafe")?,
1028 hir::PopUnsafeBlock(..) => self.word_space("pop_unsafe")?,
1029 hir::DefaultBlock => (),
1031 self.maybe_print_comment(blk.span.lo())?;
1032 self.ann.pre(self, NodeBlock(blk))?;
1035 self.print_inner_attributes(attrs)?;
1037 for st in &blk.stmts {
1038 self.print_stmt(st)?;
1042 self.space_if_not_bol()?;
1043 self.print_expr(&expr)?;
1044 self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi()))?;
1048 self.bclose_maybe_open(blk.span, indented, close_box)?;
1049 self.ann.post(self, NodeBlock(blk))
1052 fn print_else(&mut self, els: Option<&hir::Expr>) -> io::Result<()> {
1056 // "another else-if"
1057 hir::ExprIf(ref i, ref then, ref e) => {
1058 self.cbox(indent_unit - 1)?;
1060 self.s.word(" else if ")?;
1061 self.print_expr_as_cond(&i)?;
1063 self.print_expr(&then)?;
1064 self.print_else(e.as_ref().map(|e| &**e))
1067 hir::ExprBlock(ref b) => {
1068 self.cbox(indent_unit - 1)?;
1070 self.s.word(" else ")?;
1071 self.print_block(&b)
1073 // BLEAH, constraints would be great here
1075 panic!("print_if saw if with weird alternative");
1083 pub fn print_if(&mut self,
1086 elseopt: Option<&hir::Expr>)
1089 self.print_expr_as_cond(test)?;
1091 self.print_expr(blk)?;
1092 self.print_else(elseopt)
1095 pub fn print_if_let(&mut self,
1099 elseopt: Option<&hir::Expr>)
1101 self.head("if let")?;
1102 self.print_pat(pat)?;
1104 self.word_space("=")?;
1105 self.print_expr_as_cond(expr)?;
1107 self.print_block(blk)?;
1108 self.print_else(elseopt)
1112 fn print_call_post(&mut self, args: &[hir::Expr]) -> io::Result<()> {
1114 self.commasep_exprs(Inconsistent, args)?;
1118 pub fn print_expr_maybe_paren(&mut self, expr: &hir::Expr, prec: i8) -> io::Result<()> {
1119 let needs_par = expr_precedence(expr) < prec;
1123 self.print_expr(expr)?;
1130 /// Print an expr using syntax that's acceptable in a condition position, such as the `cond` in
1131 /// `if cond { ... }`.
1132 pub fn print_expr_as_cond(&mut self, expr: &hir::Expr) -> io::Result<()> {
1133 let needs_par = match expr.node {
1134 // These cases need parens due to the parse error observed in #26461: `if return {}`
1135 // parses as the erroneous construct `if (return {})`, not `if (return) {}`.
1136 hir::ExprClosure(..) |
1138 hir::ExprBreak(..) => true,
1140 _ => contains_exterior_struct_lit(expr),
1146 self.print_expr(expr)?;
1153 fn print_expr_vec(&mut self, exprs: &[hir::Expr]) -> io::Result<()> {
1154 self.ibox(indent_unit)?;
1156 self.commasep_exprs(Inconsistent, exprs)?;
1161 fn print_expr_repeat(&mut self, element: &hir::Expr, count: hir::BodyId) -> io::Result<()> {
1162 self.ibox(indent_unit)?;
1164 self.print_expr(element)?;
1165 self.word_space(";")?;
1166 self.ann.nested(self, Nested::Body(count))?;
1171 fn print_expr_struct(&mut self,
1173 fields: &[hir::Field],
1174 wth: &Option<P<hir::Expr>>)
1176 self.print_qpath(qpath, true)?;
1178 self.commasep_cmnt(Consistent,
1181 s.ibox(indent_unit)?;
1182 if !field.is_shorthand {
1183 s.print_name(field.name.node)?;
1186 s.print_expr(&field.expr)?;
1192 self.ibox(indent_unit)?;
1193 if !fields.is_empty() {
1198 self.print_expr(&expr)?;
1201 _ => if !fields.is_empty() {
1209 fn print_expr_tup(&mut self, exprs: &[hir::Expr]) -> io::Result<()> {
1211 self.commasep_exprs(Inconsistent, exprs)?;
1212 if exprs.len() == 1 {
1218 fn print_expr_call(&mut self, func: &hir::Expr, args: &[hir::Expr]) -> io::Result<()> {
1221 hir::ExprField(..) |
1222 hir::ExprTupField(..) => parser::PREC_FORCE_PAREN,
1223 _ => parser::PREC_POSTFIX,
1226 self.print_expr_maybe_paren(func, prec)?;
1227 self.print_call_post(args)
1230 fn print_expr_method_call(&mut self,
1231 segment: &hir::PathSegment,
1234 let base_args = &args[1..];
1235 self.print_expr_maybe_paren(&args[0], parser::PREC_POSTFIX)?;
1237 self.print_name(segment.name)?;
1239 segment.with_parameters(|parameters| {
1240 if !parameters.lifetimes.is_empty() ||
1241 !parameters.types.is_empty() ||
1242 !parameters.bindings.is_empty()
1244 self.print_path_parameters(¶meters, segment.infer_types, true)
1249 self.print_call_post(base_args)
1252 fn print_expr_binary(&mut self,
1257 let assoc_op = bin_op_to_assoc_op(op.node);
1258 let prec = assoc_op.precedence() as i8;
1259 let fixity = assoc_op.fixity();
1261 let (left_prec, right_prec) = match fixity {
1262 Fixity::Left => (prec, prec + 1),
1263 Fixity::Right => (prec + 1, prec),
1264 Fixity::None => (prec + 1, prec + 1),
1267 let left_prec = match (&lhs.node, op.node) {
1268 // These cases need parens: `x as i32 < y` has the parser thinking that `i32 < y` is
1269 // the beginning of a path type. It starts trying to parse `x as (i32 < y ...` instead
1270 // of `(x as i32) < ...`. We need to convince it _not_ to do that.
1271 (&hir::ExprCast { .. }, hir::BinOp_::BiLt) |
1272 (&hir::ExprCast { .. }, hir::BinOp_::BiShl) => parser::PREC_FORCE_PAREN,
1276 self.print_expr_maybe_paren(lhs, left_prec)?;
1278 self.word_space(op.node.as_str())?;
1279 self.print_expr_maybe_paren(rhs, right_prec)
1282 fn print_expr_unary(&mut self, op: hir::UnOp, expr: &hir::Expr) -> io::Result<()> {
1283 self.s.word(op.as_str())?;
1284 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1287 fn print_expr_addr_of(&mut self,
1288 mutability: hir::Mutability,
1292 self.print_mutability(mutability)?;
1293 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1296 pub fn print_expr(&mut self, expr: &hir::Expr) -> io::Result<()> {
1297 self.maybe_print_comment(expr.span.lo())?;
1298 self.print_outer_attributes(&expr.attrs)?;
1299 self.ibox(indent_unit)?;
1300 self.ann.pre(self, NodeExpr(expr))?;
1302 hir::ExprBox(ref expr) => {
1303 self.word_space("box")?;
1304 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)?;
1306 hir::ExprArray(ref exprs) => {
1307 self.print_expr_vec(exprs)?;
1309 hir::ExprRepeat(ref element, count) => {
1310 self.print_expr_repeat(&element, count)?;
1312 hir::ExprStruct(ref qpath, ref fields, ref wth) => {
1313 self.print_expr_struct(qpath, &fields[..], wth)?;
1315 hir::ExprTup(ref exprs) => {
1316 self.print_expr_tup(exprs)?;
1318 hir::ExprCall(ref func, ref args) => {
1319 self.print_expr_call(&func, args)?;
1321 hir::ExprMethodCall(ref segment, _, ref args) => {
1322 self.print_expr_method_call(segment, args)?;
1324 hir::ExprBinary(op, ref lhs, ref rhs) => {
1325 self.print_expr_binary(op, &lhs, &rhs)?;
1327 hir::ExprUnary(op, ref expr) => {
1328 self.print_expr_unary(op, &expr)?;
1330 hir::ExprAddrOf(m, ref expr) => {
1331 self.print_expr_addr_of(m, &expr)?;
1333 hir::ExprLit(ref lit) => {
1334 self.print_literal(&lit)?;
1336 hir::ExprCast(ref expr, ref ty) => {
1337 let prec = AssocOp::As.precedence() as i8;
1338 self.print_expr_maybe_paren(&expr, prec)?;
1340 self.word_space("as")?;
1341 self.print_type(&ty)?;
1343 hir::ExprType(ref expr, ref ty) => {
1344 let prec = AssocOp::Colon.precedence() as i8;
1345 self.print_expr_maybe_paren(&expr, prec)?;
1346 self.word_space(":")?;
1347 self.print_type(&ty)?;
1349 hir::ExprIf(ref test, ref blk, ref elseopt) => {
1350 self.print_if(&test, &blk, elseopt.as_ref().map(|e| &**e))?;
1352 hir::ExprWhile(ref test, ref blk, opt_sp_name) => {
1353 if let Some(sp_name) = opt_sp_name {
1354 self.print_name(sp_name.node)?;
1355 self.word_space(":")?;
1357 self.head("while")?;
1358 self.print_expr_as_cond(&test)?;
1360 self.print_block(&blk)?;
1362 hir::ExprLoop(ref blk, opt_sp_name, _) => {
1363 if let Some(sp_name) = opt_sp_name {
1364 self.print_name(sp_name.node)?;
1365 self.word_space(":")?;
1369 self.print_block(&blk)?;
1371 hir::ExprMatch(ref expr, ref arms, _) => {
1372 self.cbox(indent_unit)?;
1374 self.word_nbsp("match")?;
1375 self.print_expr_as_cond(&expr)?;
1379 self.print_arm(arm)?;
1381 self.bclose_(expr.span, indent_unit)?;
1383 hir::ExprClosure(capture_clause, ref decl, body, _fn_decl_span, _gen) => {
1384 self.print_capture_clause(capture_clause)?;
1386 self.print_closure_args(&decl, body)?;
1389 // this is a bare expression
1390 self.ann.nested(self, Nested::Body(body))?;
1391 self.end()?; // need to close a box
1393 // a box will be closed by print_expr, but we didn't want an overall
1394 // wrapper so we closed the corresponding opening. so create an
1395 // empty box to satisfy the close.
1398 hir::ExprBlock(ref blk) => {
1399 // containing cbox, will be closed by print-block at }
1400 self.cbox(indent_unit)?;
1401 // head-box, will be closed by print-block after {
1403 self.print_block(&blk)?;
1405 hir::ExprAssign(ref lhs, ref rhs) => {
1406 let prec = AssocOp::Assign.precedence() as i8;
1407 self.print_expr_maybe_paren(&lhs, prec + 1)?;
1409 self.word_space("=")?;
1410 self.print_expr_maybe_paren(&rhs, prec)?;
1412 hir::ExprAssignOp(op, ref lhs, ref rhs) => {
1413 let prec = AssocOp::Assign.precedence() as i8;
1414 self.print_expr_maybe_paren(&lhs, prec + 1)?;
1416 self.s.word(op.node.as_str())?;
1417 self.word_space("=")?;
1418 self.print_expr_maybe_paren(&rhs, prec)?;
1420 hir::ExprField(ref expr, name) => {
1421 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX)?;
1423 self.print_name(name.node)?;
1425 hir::ExprTupField(ref expr, id) => {
1426 self.print_expr_maybe_paren(&expr, parser::PREC_POSTFIX)?;
1428 self.print_usize(id.node)?;
1430 hir::ExprIndex(ref expr, ref index) => {
1431 self.print_expr_maybe_paren(&expr, parser::PREC_POSTFIX)?;
1433 self.print_expr(&index)?;
1436 hir::ExprPath(ref qpath) => {
1437 self.print_qpath(qpath, true)?
1439 hir::ExprBreak(label, ref opt_expr) => {
1440 self.s.word("break")?;
1442 if let Some(label_ident) = label.ident {
1443 self.print_name(label_ident.node.name)?;
1446 if let Some(ref expr) = *opt_expr {
1447 self.print_expr_maybe_paren(expr, parser::PREC_JUMP)?;
1451 hir::ExprAgain(label) => {
1452 self.s.word("continue")?;
1454 if let Some(label_ident) = label.ident {
1455 self.print_name(label_ident.node.name)?;
1459 hir::ExprRet(ref result) => {
1460 self.s.word("return")?;
1464 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP)?;
1469 hir::ExprInlineAsm(ref a, ref outputs, ref inputs) => {
1470 self.s.word("asm!")?;
1472 self.print_string(&a.asm.as_str(), a.asm_str_style)?;
1473 self.word_space(":")?;
1475 let mut out_idx = 0;
1476 self.commasep(Inconsistent, &a.outputs, |s, out| {
1477 let constraint = out.constraint.as_str();
1478 let mut ch = constraint.chars();
1480 Some('=') if out.is_rw => {
1481 s.print_string(&format!("+{}", ch.as_str()),
1482 ast::StrStyle::Cooked)?
1484 _ => s.print_string(&constraint, ast::StrStyle::Cooked)?,
1487 s.print_expr(&outputs[out_idx])?;
1493 self.word_space(":")?;
1496 self.commasep(Inconsistent, &a.inputs, |s, co| {
1497 s.print_string(&co.as_str(), ast::StrStyle::Cooked)?;
1499 s.print_expr(&inputs[in_idx])?;
1505 self.word_space(":")?;
1507 self.commasep(Inconsistent, &a.clobbers, |s, co| {
1508 s.print_string(&co.as_str(), ast::StrStyle::Cooked)?;
1512 let mut options = vec![];
1514 options.push("volatile");
1517 options.push("alignstack");
1519 if a.dialect == ast::AsmDialect::Intel {
1520 options.push("intel");
1523 if !options.is_empty() {
1525 self.word_space(":")?;
1526 self.commasep(Inconsistent, &options, |s, &co| {
1527 s.print_string(co, ast::StrStyle::Cooked)?;
1534 hir::ExprYield(ref expr) => {
1535 self.word_space("yield")?;
1536 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP)?;
1539 self.ann.post(self, NodeExpr(expr))?;
1543 pub fn print_local_decl(&mut self, loc: &hir::Local) -> io::Result<()> {
1544 self.print_pat(&loc.pat)?;
1545 if let Some(ref ty) = loc.ty {
1546 self.word_space(":")?;
1547 self.print_type(&ty)?;
1552 pub fn print_decl(&mut self, decl: &hir::Decl) -> io::Result<()> {
1553 self.maybe_print_comment(decl.span.lo())?;
1555 hir::DeclLocal(ref loc) => {
1556 self.space_if_not_bol()?;
1557 self.ibox(indent_unit)?;
1558 self.word_nbsp("let")?;
1560 self.ibox(indent_unit)?;
1561 self.print_local_decl(&loc)?;
1563 if let Some(ref init) = loc.init {
1565 self.word_space("=")?;
1566 self.print_expr(&init)?;
1570 hir::DeclItem(item) => {
1571 self.ann.nested(self, Nested::Item(item))
1576 pub fn print_usize(&mut self, i: usize) -> io::Result<()> {
1577 self.s.word(&i.to_string())
1580 pub fn print_name(&mut self, name: ast::Name) -> io::Result<()> {
1581 self.s.word(&name.as_str())?;
1582 self.ann.post(self, NodeName(&name))
1585 pub fn print_for_decl(&mut self, loc: &hir::Local, coll: &hir::Expr) -> io::Result<()> {
1586 self.print_local_decl(loc)?;
1588 self.word_space("in")?;
1589 self.print_expr(coll)
1592 pub fn print_path(&mut self,
1594 colons_before_params: bool)
1596 self.maybe_print_comment(path.span.lo())?;
1598 for (i, segment) in path.segments.iter().enumerate() {
1602 if segment.name != keywords::CrateRoot.name() &&
1603 segment.name != keywords::DollarCrate.name() {
1604 self.print_name(segment.name)?;
1605 segment.with_parameters(|parameters| {
1606 self.print_path_parameters(parameters,
1607 segment.infer_types,
1608 colons_before_params)
1616 pub fn print_qpath(&mut self,
1618 colons_before_params: bool)
1621 hir::QPath::Resolved(None, ref path) => {
1622 self.print_path(path, colons_before_params)
1624 hir::QPath::Resolved(Some(ref qself), ref path) => {
1626 self.print_type(qself)?;
1628 self.word_space("as")?;
1630 for (i, segment) in path.segments[..path.segments.len() - 1].iter().enumerate() {
1634 if segment.name != keywords::CrateRoot.name() &&
1635 segment.name != keywords::DollarCrate.name() {
1636 self.print_name(segment.name)?;
1637 segment.with_parameters(|parameters| {
1638 self.print_path_parameters(parameters,
1639 segment.infer_types,
1640 colons_before_params)
1647 let item_segment = path.segments.last().unwrap();
1648 self.print_name(item_segment.name)?;
1649 item_segment.with_parameters(|parameters| {
1650 self.print_path_parameters(parameters,
1651 item_segment.infer_types,
1652 colons_before_params)
1655 hir::QPath::TypeRelative(ref qself, ref item_segment) => {
1657 self.print_type(qself)?;
1660 self.print_name(item_segment.name)?;
1661 item_segment.with_parameters(|parameters| {
1662 self.print_path_parameters(parameters,
1663 item_segment.infer_types,
1664 colons_before_params)
1670 fn print_path_parameters(&mut self,
1671 parameters: &hir::PathParameters,
1673 colons_before_params: bool)
1675 if parameters.parenthesized {
1677 self.commasep(Inconsistent, parameters.inputs(), |s, ty| s.print_type(&ty))?;
1680 self.space_if_not_bol()?;
1681 self.word_space("->")?;
1682 self.print_type(¶meters.bindings[0].ty)?;
1684 let start = if colons_before_params { "::<" } else { "<" };
1685 let empty = Cell::new(true);
1686 let start_or_comma = |this: &mut Self| {
1691 this.word_space(",")
1695 if !parameters.lifetimes.iter().all(|lt| lt.is_elided()) {
1696 for lifetime in ¶meters.lifetimes {
1697 start_or_comma(self)?;
1698 self.print_lifetime(lifetime)?;
1702 if !parameters.types.is_empty() {
1703 start_or_comma(self)?;
1704 self.commasep(Inconsistent, ¶meters.types, |s, ty| s.print_type(&ty))?;
1707 // FIXME(eddyb) This would leak into error messages, e.g.:
1708 // "non-exhaustive patterns: `Some::<..>(_)` not covered".
1709 if infer_types && false {
1710 start_or_comma(self)?;
1714 for binding in parameters.bindings.iter() {
1715 start_or_comma(self)?;
1716 self.print_name(binding.name)?;
1718 self.word_space("=")?;
1719 self.print_type(&binding.ty)?;
1730 pub fn print_pat(&mut self, pat: &hir::Pat) -> io::Result<()> {
1731 self.maybe_print_comment(pat.span.lo())?;
1732 self.ann.pre(self, NodePat(pat))?;
1733 // Pat isn't normalized, but the beauty of it
1734 // is that it doesn't matter
1736 PatKind::Wild => self.s.word("_")?,
1737 PatKind::Binding(binding_mode, _, ref path1, ref sub) => {
1738 match binding_mode {
1739 hir::BindingAnnotation::Ref => {
1740 self.word_nbsp("ref")?;
1741 self.print_mutability(hir::MutImmutable)?;
1743 hir::BindingAnnotation::RefMut => {
1744 self.word_nbsp("ref")?;
1745 self.print_mutability(hir::MutMutable)?;
1747 hir::BindingAnnotation::Unannotated => {}
1748 hir::BindingAnnotation::Mutable => {
1749 self.word_nbsp("mut")?;
1752 self.print_name(path1.node)?;
1753 if let Some(ref p) = *sub {
1755 self.print_pat(&p)?;
1758 PatKind::TupleStruct(ref qpath, ref elts, ddpos) => {
1759 self.print_qpath(qpath, true)?;
1761 if let Some(ddpos) = ddpos {
1762 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p))?;
1764 self.word_space(",")?;
1767 if ddpos != elts.len() {
1769 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p))?;
1772 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))?;
1776 PatKind::Path(ref qpath) => {
1777 self.print_qpath(qpath, true)?;
1779 PatKind::Struct(ref qpath, ref fields, etc) => {
1780 self.print_qpath(qpath, true)?;
1782 self.word_space("{")?;
1783 self.commasep_cmnt(Consistent,
1786 s.cbox(indent_unit)?;
1787 if !f.node.is_shorthand {
1788 s.print_name(f.node.name)?;
1791 s.print_pat(&f.node.pat)?;
1794 |f| f.node.pat.span)?;
1796 if !fields.is_empty() {
1797 self.word_space(",")?;
1804 PatKind::Tuple(ref elts, ddpos) => {
1806 if let Some(ddpos) = ddpos {
1807 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p))?;
1809 self.word_space(",")?;
1812 if ddpos != elts.len() {
1814 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p))?;
1817 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))?;
1818 if elts.len() == 1 {
1824 PatKind::Box(ref inner) => {
1825 self.s.word("box ")?;
1826 self.print_pat(&inner)?;
1828 PatKind::Ref(ref inner, mutbl) => {
1830 if mutbl == hir::MutMutable {
1831 self.s.word("mut ")?;
1833 self.print_pat(&inner)?;
1835 PatKind::Lit(ref e) => self.print_expr(&e)?,
1836 PatKind::Range(ref begin, ref end, ref end_kind) => {
1837 self.print_expr(&begin)?;
1840 RangeEnd::Included => self.s.word("...")?,
1841 RangeEnd::Excluded => self.s.word("..")?,
1843 self.print_expr(&end)?;
1845 PatKind::Slice(ref before, ref slice, ref after) => {
1847 self.commasep(Inconsistent, &before[..], |s, p| s.print_pat(&p))?;
1848 if let Some(ref p) = *slice {
1849 if !before.is_empty() {
1850 self.word_space(",")?;
1852 if p.node != PatKind::Wild {
1853 self.print_pat(&p)?;
1856 if !after.is_empty() {
1857 self.word_space(",")?;
1860 self.commasep(Inconsistent, &after[..], |s, p| s.print_pat(&p))?;
1864 self.ann.post(self, NodePat(pat))
1867 fn print_arm(&mut self, arm: &hir::Arm) -> io::Result<()> {
1868 // I have no idea why this check is necessary, but here it
1870 if arm.attrs.is_empty() {
1873 self.cbox(indent_unit)?;
1875 self.print_outer_attributes(&arm.attrs)?;
1876 let mut first = true;
1877 for p in &arm.pats {
1882 self.word_space("|")?;
1884 self.print_pat(&p)?;
1887 if let Some(ref e) = arm.guard {
1888 self.word_space("if")?;
1889 self.print_expr(&e)?;
1892 self.word_space("=>")?;
1894 match arm.body.node {
1895 hir::ExprBlock(ref blk) => {
1896 // the block will close the pattern's ibox
1897 self.print_block_unclosed_indent(&blk, indent_unit)?;
1899 // If it is a user-provided unsafe block, print a comma after it
1900 if let hir::UnsafeBlock(hir::UserProvided) = blk.rules {
1905 self.end()?; // close the ibox for the pattern
1906 self.print_expr(&arm.body)?;
1910 self.end() // close enclosing cbox
1913 pub fn print_fn(&mut self,
1915 unsafety: hir::Unsafety,
1916 constness: hir::Constness,
1918 name: Option<ast::Name>,
1919 generics: &hir::Generics,
1920 vis: &hir::Visibility,
1921 arg_names: &[Spanned<ast::Name>],
1922 body_id: Option<hir::BodyId>)
1924 self.print_fn_header_info(unsafety, constness, abi, vis)?;
1926 if let Some(name) = name {
1928 self.print_name(name)?;
1930 self.print_generic_params(&generics.params)?;
1934 // Make sure we aren't supplied *both* `arg_names` and `body_id`.
1935 assert!(arg_names.is_empty() || body_id.is_none());
1936 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
1937 s.ibox(indent_unit)?;
1938 if let Some(name) = arg_names.get(i) {
1939 s.s.word(&name.node.as_str())?;
1942 } else if let Some(body_id) = body_id {
1943 s.ann.nested(s, Nested::BodyArgPat(body_id, i))?;
1952 self.s.word(", ...")?;
1956 self.print_fn_output(decl)?;
1957 self.print_where_clause(&generics.where_clause)
1960 fn print_closure_args(&mut self, decl: &hir::FnDecl, body_id: hir::BodyId) -> io::Result<()> {
1963 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
1964 s.ibox(indent_unit)?;
1966 s.ann.nested(s, Nested::BodyArgPat(body_id, i))?;
1969 if ty.node != hir::TyInfer {
1978 if let hir::DefaultReturn(..) = decl.output {
1982 self.space_if_not_bol()?;
1983 self.word_space("->")?;
1985 hir::Return(ref ty) => {
1986 self.print_type(&ty)?;
1987 self.maybe_print_comment(ty.span.lo())
1989 hir::DefaultReturn(..) => unreachable!(),
1993 pub fn print_capture_clause(&mut self, capture_clause: hir::CaptureClause) -> io::Result<()> {
1994 match capture_clause {
1995 hir::CaptureByValue => self.word_space("move"),
1996 hir::CaptureByRef => Ok(()),
2000 pub fn print_bounds(&mut self, prefix: &str, bounds: &[hir::TyParamBound]) -> io::Result<()> {
2001 if !bounds.is_empty() {
2002 self.s.word(prefix)?;
2003 let mut first = true;
2004 for bound in bounds {
2005 if !(first && prefix.is_empty()) {
2011 self.word_space("+")?;
2015 TraitTyParamBound(tref, modifier) => {
2016 if modifier == &TraitBoundModifier::Maybe {
2019 self.print_poly_trait_ref(tref)?;
2021 RegionTyParamBound(lt) => {
2022 self.print_lifetime(lt)?;
2030 pub fn print_lifetime(&mut self, lifetime: &hir::Lifetime) -> io::Result<()> {
2031 self.print_name(lifetime.name.name())
2034 pub fn print_lifetime_def(&mut self, lifetime: &hir::LifetimeDef) -> io::Result<()> {
2035 self.print_lifetime(&lifetime.lifetime)?;
2037 for v in &lifetime.bounds {
2039 self.print_lifetime(v)?;
2045 pub fn print_generic_params(&mut self, generic_params: &[hir::GenericParam]) -> io::Result<()> {
2046 if !generic_params.is_empty() {
2049 self.commasep(Inconsistent, generic_params, |s, param| {
2051 hir::GenericParam::Lifetime(ref ld) => s.print_lifetime_def(ld),
2052 hir::GenericParam::Type(ref tp) => s.print_ty_param(tp),
2061 pub fn print_ty_param(&mut self, param: &hir::TyParam) -> io::Result<()> {
2062 self.print_name(param.name)?;
2063 self.print_bounds(":", ¶m.bounds)?;
2064 match param.default {
2065 Some(ref default) => {
2067 self.word_space("=")?;
2068 self.print_type(&default)
2074 pub fn print_where_clause(&mut self, where_clause: &hir::WhereClause) -> io::Result<()> {
2075 if where_clause.predicates.is_empty() {
2080 self.word_space("where")?;
2082 for (i, predicate) in where_clause.predicates.iter().enumerate() {
2084 self.word_space(",")?;
2088 &hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
2089 ref bound_generic_params,
2094 self.print_formal_generic_params(bound_generic_params)?;
2095 self.print_type(&bounded_ty)?;
2096 self.print_bounds(":", bounds)?;
2098 &hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate{ref lifetime,
2101 self.print_lifetime(lifetime)?;
2104 for (i, bound) in bounds.iter().enumerate() {
2105 self.print_lifetime(bound)?;
2112 &hir::WherePredicate::EqPredicate(hir::WhereEqPredicate{ref lhs_ty,
2115 self.print_type(lhs_ty)?;
2117 self.word_space("=")?;
2118 self.print_type(rhs_ty)?;
2126 pub fn print_mutability(&mut self, mutbl: hir::Mutability) -> io::Result<()> {
2128 hir::MutMutable => self.word_nbsp("mut"),
2129 hir::MutImmutable => Ok(()),
2133 pub fn print_mt(&mut self, mt: &hir::MutTy) -> io::Result<()> {
2134 self.print_mutability(mt.mutbl)?;
2135 self.print_type(&mt.ty)
2138 pub fn print_fn_output(&mut self, decl: &hir::FnDecl) -> io::Result<()> {
2139 if let hir::DefaultReturn(..) = decl.output {
2143 self.space_if_not_bol()?;
2144 self.ibox(indent_unit)?;
2145 self.word_space("->")?;
2147 hir::DefaultReturn(..) => unreachable!(),
2148 hir::Return(ref ty) => self.print_type(&ty)?,
2153 hir::Return(ref output) => self.maybe_print_comment(output.span.lo()),
2158 pub fn print_ty_fn(&mut self,
2160 unsafety: hir::Unsafety,
2162 name: Option<ast::Name>,
2163 generic_params: &[hir::GenericParam],
2164 arg_names: &[Spanned<ast::Name>])
2166 self.ibox(indent_unit)?;
2167 if !generic_params.is_empty() {
2168 self.s.word("for")?;
2169 self.print_generic_params(generic_params)?;
2171 let generics = hir::Generics {
2172 params: hir::HirVec::new(),
2173 where_clause: hir::WhereClause {
2174 id: ast::DUMMY_NODE_ID,
2175 predicates: hir::HirVec::new(),
2177 span: syntax_pos::DUMMY_SP,
2181 hir::Constness::NotConst,
2191 pub fn maybe_print_trailing_comment(&mut self,
2192 span: syntax_pos::Span,
2193 next_pos: Option<BytePos>)
2195 let cm = match self.cm {
2199 if let Some(ref cmnt) = self.next_comment() {
2200 if (*cmnt).style != comments::Trailing {
2203 let span_line = cm.lookup_char_pos(span.hi());
2204 let comment_line = cm.lookup_char_pos((*cmnt).pos);
2205 let mut next = (*cmnt).pos + BytePos(1);
2206 if let Some(p) = next_pos {
2209 if span.hi() < (*cmnt).pos && (*cmnt).pos < next &&
2210 span_line.line == comment_line.line {
2211 self.print_comment(cmnt)?;
2217 pub fn print_remaining_comments(&mut self) -> io::Result<()> {
2218 // If there aren't any remaining comments, then we need to manually
2219 // make sure there is a line break at the end.
2220 if self.next_comment().is_none() {
2221 self.s.hardbreak()?;
2224 match self.next_comment() {
2226 self.print_comment(cmnt)?;
2234 pub fn print_opt_abi_and_extern_if_nondefault(&mut self,
2235 opt_abi: Option<Abi>)
2238 Some(Abi::Rust) => Ok(()),
2240 self.word_nbsp("extern")?;
2241 self.word_nbsp(&abi.to_string())
2247 pub fn print_extern_opt_abi(&mut self, opt_abi: Option<Abi>) -> io::Result<()> {
2250 self.word_nbsp("extern")?;
2251 self.word_nbsp(&abi.to_string())
2257 pub fn print_fn_header_info(&mut self,
2258 unsafety: hir::Unsafety,
2259 constness: hir::Constness,
2261 vis: &hir::Visibility)
2263 self.s.word(&visibility_qualified(vis, ""))?;
2264 self.print_unsafety(unsafety)?;
2267 hir::Constness::NotConst => {}
2268 hir::Constness::Const => self.word_nbsp("const")?,
2271 if abi != Abi::Rust {
2272 self.word_nbsp("extern")?;
2273 self.word_nbsp(&abi.to_string())?;
2279 pub fn print_unsafety(&mut self, s: hir::Unsafety) -> io::Result<()> {
2281 hir::Unsafety::Normal => Ok(()),
2282 hir::Unsafety::Unsafe => self.word_nbsp("unsafe"),
2286 pub fn print_is_auto(&mut self, s: hir::IsAuto) -> io::Result<()> {
2288 hir::IsAuto::Yes => self.word_nbsp("auto"),
2289 hir::IsAuto::No => Ok(()),
2294 // Dup'ed from parse::classify, but adapted for the HIR.
2295 /// Does this expression require a semicolon to be treated
2296 /// as a statement? The negation of this: 'can this expression
2297 /// be used as a statement without a semicolon' -- is used
2298 /// as an early-bail-out in the parser so that, for instance,
2299 /// if true {...} else {...}
2301 /// isn't parsed as (if true {...} else {...} | x) | 5
2302 fn expr_requires_semi_to_be_stmt(e: &hir::Expr) -> bool {
2305 hir::ExprMatch(..) |
2307 hir::ExprWhile(..) |
2308 hir::ExprLoop(..) => false,
2313 /// this statement requires a semicolon after it.
2314 /// note that in one case (stmt_semi), we've already
2315 /// seen the semicolon, and thus don't need another.
2316 fn stmt_ends_with_semi(stmt: &hir::Stmt_) -> bool {
2318 hir::StmtDecl(ref d, _) => {
2320 hir::DeclLocal(_) => true,
2321 hir::DeclItem(_) => false,
2324 hir::StmtExpr(ref e, _) => {
2325 expr_requires_semi_to_be_stmt(&e)
2327 hir::StmtSemi(..) => {
2334 fn expr_precedence(expr: &hir::Expr) -> i8 {
2335 use syntax::util::parser::*;
2338 hir::ExprClosure(..) => PREC_CLOSURE,
2340 hir::ExprBreak(..) |
2341 hir::ExprAgain(..) |
2343 hir::ExprYield(..) => PREC_JUMP,
2345 // Binop-like expr kinds, handled by `AssocOp`.
2346 hir::ExprBinary(op, _, _) => bin_op_to_assoc_op(op.node).precedence() as i8,
2348 hir::ExprCast(..) => AssocOp::As.precedence() as i8,
2349 hir::ExprType(..) => AssocOp::Colon.precedence() as i8,
2351 hir::ExprAssign(..) |
2352 hir::ExprAssignOp(..) => AssocOp::Assign.precedence() as i8,
2356 hir::ExprAddrOf(..) |
2357 hir::ExprUnary(..) => PREC_PREFIX,
2361 hir::ExprMethodCall(..) |
2362 hir::ExprField(..) |
2363 hir::ExprTupField(..) |
2364 hir::ExprIndex(..) |
2365 hir::ExprInlineAsm(..) => PREC_POSTFIX,
2367 // Never need parens
2368 hir::ExprArray(..) |
2369 hir::ExprRepeat(..) |
2374 hir::ExprWhile(..) |
2376 hir::ExprMatch(..) |
2377 hir::ExprBlock(..) |
2378 hir::ExprStruct(..) => PREC_PAREN,
2382 fn bin_op_to_assoc_op(op: hir::BinOp_) -> AssocOp {
2385 BiAdd => AssocOp::Add,
2386 BiSub => AssocOp::Subtract,
2387 BiMul => AssocOp::Multiply,
2388 BiDiv => AssocOp::Divide,
2389 BiRem => AssocOp::Modulus,
2391 BiAnd => AssocOp::LAnd,
2392 BiOr => AssocOp::LOr,
2394 BiBitXor => AssocOp::BitXor,
2395 BiBitAnd => AssocOp::BitAnd,
2396 BiBitOr => AssocOp::BitOr,
2397 BiShl => AssocOp::ShiftLeft,
2398 BiShr => AssocOp::ShiftRight,
2400 BiEq => AssocOp::Equal,
2401 BiLt => AssocOp::Less,
2402 BiLe => AssocOp::LessEqual,
2403 BiNe => AssocOp::NotEqual,
2404 BiGe => AssocOp::GreaterEqual,
2405 BiGt => AssocOp::Greater,
2409 /// Expressions that syntactically contain an "exterior" struct literal i.e. not surrounded by any
2410 /// parens or other delimiters, e.g. `X { y: 1 }`, `X { y: 1 }.method()`, `foo == X { y: 1 }` and
2411 /// `X { y: 1 } == foo` all do, but `(X { y: 1 }) == foo` does not.
2412 fn contains_exterior_struct_lit(value: &hir::Expr) -> bool {
2414 hir::ExprStruct(..) => true,
2416 hir::ExprAssign(ref lhs, ref rhs) |
2417 hir::ExprAssignOp(_, ref lhs, ref rhs) |
2418 hir::ExprBinary(_, ref lhs, ref rhs) => {
2419 // X { y: 1 } + X { y: 2 }
2420 contains_exterior_struct_lit(&lhs) || contains_exterior_struct_lit(&rhs)
2422 hir::ExprUnary(_, ref x) |
2423 hir::ExprCast(ref x, _) |
2424 hir::ExprType(ref x, _) |
2425 hir::ExprField(ref x, _) |
2426 hir::ExprTupField(ref x, _) |
2427 hir::ExprIndex(ref x, _) => {
2428 // &X { y: 1 }, X { y: 1 }.y
2429 contains_exterior_struct_lit(&x)
2432 hir::ExprMethodCall(.., ref exprs) => {
2433 // X { y: 1 }.bar(...)
2434 contains_exterior_struct_lit(&exprs[0])