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 use rustc_target::spec::abi::Abi;
13 use syntax::source_map::{SourceMap, Spanned};
14 use syntax::parse::ParseSess;
15 use syntax::parse::lexer::comments;
16 use syntax::print::pp::{self, Breaks};
17 use syntax::print::pp::Breaks::{Consistent, Inconsistent};
18 use syntax::print::pprust::PrintState;
20 use syntax::symbol::keywords;
21 use syntax::util::parser::{self, AssocOp, Fixity};
22 use syntax_pos::{self, BytePos, FileName};
25 use hir::{PatKind, GenericBound, TraitBoundModifier, RangeEnd};
26 use hir::{GenericParam, GenericParamKind, GenericArg};
30 use std::io::{self, Write, Read};
31 use std::iter::Peekable;
34 pub enum AnnNode<'a> {
36 Block(&'a hir::Block),
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<()> {
61 fn try_fetch_item(&self, _: ast::NodeId) -> Option<&hir::Item> {
67 impl PpAnn for NoAnn {}
68 pub const NO_ANN: &dyn PpAnn = &NoAnn;
70 impl PpAnn for hir::Crate {
71 fn try_fetch_item(&self, item: ast::NodeId) -> Option<&hir::Item> {
74 fn nested(&self, state: &mut State<'_>, nested: Nested) -> io::Result<()> {
76 Nested::Item(id) => state.print_item(self.item(id.id)),
77 Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
78 Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
79 Nested::Body(id) => state.print_expr(&self.body(id).value),
80 Nested::BodyArgPat(id, i) => state.print_pat(&self.body(id).arguments[i].pat)
85 pub struct State<'a> {
86 pub s: pp::Printer<'a>,
87 cm: Option<&'a SourceMap>,
88 comments: Option<Vec<comments::Comment>>,
89 literals: Peekable<vec::IntoIter<comments::Literal>>,
91 boxes: Vec<pp::Breaks>,
92 ann: &'a (dyn PpAnn + 'a),
95 impl<'a> PrintState<'a> for State<'a> {
96 fn writer(&mut self) -> &mut pp::Printer<'a> {
100 fn boxes(&mut self) -> &mut Vec<pp::Breaks> {
104 fn comments(&mut self) -> &mut Option<Vec<comments::Comment>> {
108 fn cur_cmnt(&mut self) -> &mut usize {
112 fn cur_lit(&mut self) -> Option<&comments::Literal> {
116 fn bump_lit(&mut self) -> Option<comments::Literal> {
121 #[allow(non_upper_case_globals)]
122 pub const indent_unit: usize = 4;
124 #[allow(non_upper_case_globals)]
125 pub const default_columns: usize = 78;
128 /// Requires you to pass an input filename and reader so that
129 /// it can scan the input text for comments and literals to
131 pub fn print_crate<'a>(cm: &'a SourceMap,
135 input: &mut dyn Read,
136 out: Box<dyn Write + 'a>,
140 let mut s = State::new_from_input(cm, sess, filename, input, out, ann, is_expanded);
142 // When printing the AST, we sometimes need to inject `#[no_std]` here.
143 // Since you can't compile the HIR, it's not necessary.
145 s.print_mod(&krate.module, &krate.attrs)?;
146 s.print_remaining_comments()?;
151 pub fn new_from_input(cm: &'a SourceMap,
154 input: &mut dyn Read,
155 out: Box<dyn Write + 'a>,
159 let (cmnts, lits) = comments::gather_comments_and_literals(sess, filename, input);
165 // If the code is post expansion, don't use the table of
166 // literals, since it doesn't correspond with the literals
167 // in the AST anymore.
175 pub fn new(cm: &'a SourceMap,
176 out: Box<dyn Write + 'a>,
178 comments: Option<Vec<comments::Comment>>,
179 literals: Option<Vec<comments::Literal>>)
182 s: pp::mk_printer(out, default_columns),
185 literals: literals.unwrap_or_default().into_iter().peekable(),
193 pub fn to_string<F>(ann: &dyn PpAnn, f: F) -> String
194 where F: FnOnce(&mut State<'_>) -> io::Result<()>
196 let mut wr = Vec::new();
198 let mut printer = State {
199 s: pp::mk_printer(Box::new(&mut wr), default_columns),
202 literals: vec![].into_iter().peekable(),
207 f(&mut printer).unwrap();
208 printer.s.eof().unwrap();
210 String::from_utf8(wr).unwrap()
213 pub fn visibility_qualified<S: Into<Cow<'static, str>>>(vis: &hir::Visibility, w: S) -> String {
214 to_string(NO_ANN, |s| {
215 s.print_visibility(vis)?;
221 pub fn cbox(&mut self, u: usize) -> io::Result<()> {
222 self.boxes.push(pp::Breaks::Consistent);
226 pub fn nbsp(&mut self) -> io::Result<()> {
230 pub fn word_nbsp<S: Into<Cow<'static, str>>>(&mut self, w: S) -> io::Result<()> {
235 pub fn head<S: Into<Cow<'static, str>>>(&mut self, w: S) -> io::Result<()> {
237 // outer-box is consistent
238 self.cbox(indent_unit)?;
239 // head-box is inconsistent
240 self.ibox(w.len() + 1)?;
241 // keyword that starts the head
248 pub fn bopen(&mut self) -> io::Result<()> {
250 self.end() // close the head-box
253 pub fn bclose_(&mut self, span: syntax_pos::Span, indented: usize) -> io::Result<()> {
254 self.bclose_maybe_open(span, indented, true)
257 pub fn bclose_maybe_open(&mut self,
258 span: syntax_pos::Span,
262 self.maybe_print_comment(span.hi())?;
263 self.break_offset_if_not_bol(1, -(indented as isize))?;
266 self.end()?; // close the outer-box
271 pub fn bclose(&mut self, span: syntax_pos::Span) -> io::Result<()> {
272 self.bclose_(span, indent_unit)
275 pub fn in_cbox(&self) -> bool {
276 match self.boxes.last() {
277 Some(&last_box) => last_box == pp::Breaks::Consistent,
282 pub fn space_if_not_bol(&mut self) -> io::Result<()> {
289 pub fn break_offset_if_not_bol(&mut self, n: usize, off: isize) -> io::Result<()> {
291 self.s.break_offset(n, off)
293 if off != 0 && self.s.last_token().is_hardbreak_tok() {
294 // We do something pretty sketchy here: tuck the nonzero
295 // offset-adjustment we were going to deposit along with the
296 // break into the previous hardbreak.
297 self.s.replace_last_token(pp::Printer::hardbreak_tok_offset(off));
303 // Synthesizes a comment that was not textually present in the original source
305 pub fn synth_comment(&mut self, text: String) -> io::Result<()> {
313 pub fn commasep_cmnt<T, F, G>(&mut self,
319 where F: FnMut(&mut State<'_>, &T) -> io::Result<()>,
320 G: FnMut(&T) -> syntax_pos::Span
323 let len = elts.len();
326 self.maybe_print_comment(get_span(elt).hi())?;
331 self.maybe_print_trailing_comment(get_span(elt), Some(get_span(&elts[i]).hi()))?;
332 self.space_if_not_bol()?;
338 pub fn commasep_exprs(&mut self, b: Breaks, exprs: &[hir::Expr]) -> io::Result<()> {
339 self.commasep_cmnt(b, exprs, |s, e| s.print_expr(&e), |e| e.span)
342 pub fn print_mod(&mut self, _mod: &hir::Mod, attrs: &[ast::Attribute]) -> io::Result<()> {
343 self.print_inner_attributes(attrs)?;
344 for &item_id in &_mod.item_ids {
345 self.ann.nested(self, Nested::Item(item_id))?;
350 pub fn print_foreign_mod(&mut self,
351 nmod: &hir::ForeignMod,
352 attrs: &[ast::Attribute])
354 self.print_inner_attributes(attrs)?;
355 for item in &nmod.items {
356 self.print_foreign_item(item)?;
361 pub fn print_opt_lifetime(&mut self, lifetime: &hir::Lifetime) -> io::Result<()> {
362 if !lifetime.is_elided() {
363 self.print_lifetime(lifetime)?;
369 pub fn print_type(&mut self, ty: &hir::Ty) -> io::Result<()> {
370 self.maybe_print_comment(ty.span.lo())?;
373 hir::TyKind::Slice(ref ty) => {
375 self.print_type(&ty)?;
378 hir::TyKind::Ptr(ref mt) => {
381 hir::MutMutable => self.word_nbsp("mut")?,
382 hir::MutImmutable => self.word_nbsp("const")?,
384 self.print_type(&mt.ty)?;
386 hir::TyKind::Rptr(ref lifetime, ref mt) => {
388 self.print_opt_lifetime(lifetime)?;
391 hir::TyKind::Never => {
394 hir::TyKind::Tup(ref elts) => {
396 self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(&ty))?;
402 hir::TyKind::BareFn(ref f) => {
403 self.print_ty_fn(f.abi, f.unsafety, &f.decl, None, &f.generic_params,
406 hir::TyKind::Def(..) => {},
407 hir::TyKind::Path(ref qpath) => {
408 self.print_qpath(qpath, false)?
410 hir::TyKind::TraitObject(ref bounds, ref lifetime) => {
411 let mut first = true;
412 for bound in bounds {
417 self.word_space("+")?;
419 self.print_poly_trait_ref(bound)?;
421 if !lifetime.is_elided() {
423 self.word_space("+")?;
424 self.print_lifetime(lifetime)?;
427 hir::TyKind::Array(ref ty, ref length) => {
429 self.print_type(&ty)?;
431 self.print_anon_const(length)?;
434 hir::TyKind::Typeof(ref e) => {
435 self.s.word("typeof(")?;
436 self.print_anon_const(e)?;
439 hir::TyKind::Infer => {
442 hir::TyKind::Err => {
449 pub fn print_foreign_item(&mut self, item: &hir::ForeignItem) -> io::Result<()> {
450 self.hardbreak_if_not_bol()?;
451 self.maybe_print_comment(item.span.lo())?;
452 self.print_outer_attributes(&item.attrs)?;
454 hir::ForeignItemKind::Fn(ref decl, ref arg_names, ref generics) => {
458 unsafety: hir::Unsafety::Normal,
459 constness: hir::Constness::NotConst,
461 asyncness: hir::IsAsync::NotAsync,
468 self.end()?; // end head-ibox
470 self.end() // end the outer fn box
472 hir::ForeignItemKind::Static(ref t, m) => {
473 self.head(visibility_qualified(&item.vis, "static"))?;
475 self.word_space("mut")?;
477 self.print_name(item.name)?;
478 self.word_space(":")?;
479 self.print_type(&t)?;
481 self.end()?; // end the head-ibox
482 self.end() // end the outer cbox
484 hir::ForeignItemKind::Type => {
485 self.head(visibility_qualified(&item.vis, "type"))?;
486 self.print_name(item.name)?;
488 self.end()?; // end the head-ibox
489 self.end() // end the outer cbox
494 fn print_associated_const(&mut self,
497 default: Option<hir::BodyId>,
498 vis: &hir::Visibility)
500 self.s.word(visibility_qualified(vis, ""))?;
501 self.word_space("const")?;
502 self.print_ident(ident)?;
503 self.word_space(":")?;
504 self.print_type(ty)?;
505 if let Some(expr) = default {
507 self.word_space("=")?;
508 self.ann.nested(self, Nested::Body(expr))?;
513 fn print_associated_type(&mut self,
515 bounds: Option<&hir::GenericBounds>,
516 ty: Option<&hir::Ty>)
518 self.word_space("type")?;
519 self.print_ident(ident)?;
520 if let Some(bounds) = bounds {
521 self.print_bounds(":", bounds)?;
523 if let Some(ty) = ty {
525 self.word_space("=")?;
526 self.print_type(ty)?;
531 /// Pretty-print an item
532 pub fn print_item(&mut self, item: &hir::Item) -> io::Result<()> {
533 self.hardbreak_if_not_bol()?;
534 self.maybe_print_comment(item.span.lo())?;
535 self.print_outer_attributes(&item.attrs)?;
536 self.ann.pre(self, AnnNode::Item(item))?;
538 hir::ItemKind::ExternCrate(orig_name) => {
539 self.head(visibility_qualified(&item.vis, "extern crate"))?;
540 if let Some(orig_name) = orig_name {
541 self.print_name(orig_name)?;
546 self.print_name(item.name)?;
548 self.end()?; // end inner head-block
549 self.end()?; // end outer head-block
551 hir::ItemKind::Use(ref path, kind) => {
552 self.head(visibility_qualified(&item.vis, "use"))?;
553 self.print_path(path, false)?;
556 hir::UseKind::Single => {
557 if path.segments.last().unwrap().ident.name != item.name {
559 self.word_space("as")?;
560 self.print_name(item.name)?;
564 hir::UseKind::Glob => self.s.word("::*;")?,
565 hir::UseKind::ListStem => self.s.word("::{};")?
567 self.end()?; // end inner head-block
568 self.end()?; // end outer head-block
570 hir::ItemKind::Static(ref ty, m, expr) => {
571 self.head(visibility_qualified(&item.vis, "static"))?;
572 if m == hir::MutMutable {
573 self.word_space("mut")?;
575 self.print_name(item.name)?;
576 self.word_space(":")?;
577 self.print_type(&ty)?;
579 self.end()?; // end the head-ibox
581 self.word_space("=")?;
582 self.ann.nested(self, Nested::Body(expr))?;
584 self.end()?; // end the outer cbox
586 hir::ItemKind::Const(ref ty, expr) => {
587 self.head(visibility_qualified(&item.vis, "const"))?;
588 self.print_name(item.name)?;
589 self.word_space(":")?;
590 self.print_type(&ty)?;
592 self.end()?; // end the head-ibox
594 self.word_space("=")?;
595 self.ann.nested(self, Nested::Body(expr))?;
597 self.end()?; // end the outer cbox
599 hir::ItemKind::Fn(ref decl, header, ref typarams, body) => {
609 self.end()?; // need to close a box
610 self.end()?; // need to close a box
611 self.ann.nested(self, Nested::Body(body))?;
613 hir::ItemKind::Mod(ref _mod) => {
614 self.head(visibility_qualified(&item.vis, "mod"))?;
615 self.print_name(item.name)?;
618 self.print_mod(_mod, &item.attrs)?;
619 self.bclose(item.span)?;
621 hir::ItemKind::ForeignMod(ref nmod) => {
622 self.head("extern")?;
623 self.word_nbsp(nmod.abi.to_string())?;
625 self.print_foreign_mod(nmod, &item.attrs)?;
626 self.bclose(item.span)?;
628 hir::ItemKind::GlobalAsm(ref ga) => {
629 self.head(visibility_qualified(&item.vis, "global asm"))?;
630 self.s.word(ga.asm.as_str().get())?;
633 hir::ItemKind::Ty(ref ty, ref generics) => {
634 self.head(visibility_qualified(&item.vis, "type"))?;
635 self.print_name(item.name)?;
636 self.print_generic_params(&generics.params)?;
637 self.end()?; // end the inner ibox
639 self.print_where_clause(&generics.where_clause)?;
641 self.word_space("=")?;
642 self.print_type(&ty)?;
644 self.end()?; // end the outer ibox
646 hir::ItemKind::Existential(ref exist) => {
647 self.head(visibility_qualified(&item.vis, "existential type"))?;
648 self.print_name(item.name)?;
649 self.print_generic_params(&exist.generics.params)?;
650 self.end()?; // end the inner ibox
652 self.print_where_clause(&exist.generics.where_clause)?;
654 self.word_space(":")?;
655 let mut real_bounds = Vec::with_capacity(exist.bounds.len());
656 for b in exist.bounds.iter() {
657 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
659 self.word_space("for ?")?;
660 self.print_trait_ref(&ptr.trait_ref)?;
662 real_bounds.push(b.clone());
665 self.print_bounds(":", &real_bounds[..])?;
667 self.end()?; // end the outer ibox
669 hir::ItemKind::Enum(ref enum_definition, ref params) => {
670 self.print_enum_def(enum_definition, params, item.name, item.span, &item.vis)?;
672 hir::ItemKind::Struct(ref struct_def, ref generics) => {
673 self.head(visibility_qualified(&item.vis, "struct"))?;
674 self.print_struct(struct_def, generics, item.name, item.span, true)?;
676 hir::ItemKind::Union(ref struct_def, ref generics) => {
677 self.head(visibility_qualified(&item.vis, "union"))?;
678 self.print_struct(struct_def, generics, item.name, item.span, true)?;
680 hir::ItemKind::Impl(unsafety,
688 self.print_visibility(&item.vis)?;
689 self.print_defaultness(defaultness)?;
690 self.print_unsafety(unsafety)?;
691 self.word_nbsp("impl")?;
693 if !generics.params.is_empty() {
694 self.print_generic_params(&generics.params)?;
698 if let hir::ImplPolarity::Negative = polarity {
702 if let Some(ref t) = opt_trait {
703 self.print_trait_ref(t)?;
705 self.word_space("for")?;
708 self.print_type(&ty)?;
709 self.print_where_clause(&generics.where_clause)?;
713 self.print_inner_attributes(&item.attrs)?;
714 for impl_item in impl_items {
715 self.ann.nested(self, Nested::ImplItem(impl_item.id))?;
717 self.bclose(item.span)?;
719 hir::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref trait_items) => {
721 self.print_visibility(&item.vis)?;
722 self.print_is_auto(is_auto)?;
723 self.print_unsafety(unsafety)?;
724 self.word_nbsp("trait")?;
725 self.print_name(item.name)?;
726 self.print_generic_params(&generics.params)?;
727 let mut real_bounds = Vec::with_capacity(bounds.len());
728 for b in bounds.iter() {
729 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
731 self.word_space("for ?")?;
732 self.print_trait_ref(&ptr.trait_ref)?;
734 real_bounds.push(b.clone());
737 self.print_bounds(":", &real_bounds[..])?;
738 self.print_where_clause(&generics.where_clause)?;
741 for trait_item in trait_items {
742 self.ann.nested(self, Nested::TraitItem(trait_item.id))?;
744 self.bclose(item.span)?;
746 hir::ItemKind::TraitAlias(ref generics, ref bounds) => {
748 self.print_visibility(&item.vis)?;
749 self.word_nbsp("trait")?;
750 self.print_name(item.name)?;
751 self.print_generic_params(&generics.params)?;
752 let mut real_bounds = Vec::with_capacity(bounds.len());
753 // FIXME(durka) this seems to be some quite outdated syntax
754 for b in bounds.iter() {
755 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
757 self.word_space("for ?")?;
758 self.print_trait_ref(&ptr.trait_ref)?;
760 real_bounds.push(b.clone());
764 self.print_bounds("=", &real_bounds[..])?;
765 self.print_where_clause(&generics.where_clause)?;
769 self.ann.post(self, AnnNode::Item(item))
772 pub fn print_trait_ref(&mut self, t: &hir::TraitRef) -> io::Result<()> {
773 self.print_path(&t.path, false)
776 fn print_formal_generic_params(
778 generic_params: &[hir::GenericParam]
779 ) -> io::Result<()> {
780 if !generic_params.is_empty() {
782 self.print_generic_params(generic_params)?;
788 fn print_poly_trait_ref(&mut self, t: &hir::PolyTraitRef) -> io::Result<()> {
789 self.print_formal_generic_params(&t.bound_generic_params)?;
790 self.print_trait_ref(&t.trait_ref)
793 pub fn print_enum_def(&mut self,
794 enum_definition: &hir::EnumDef,
795 generics: &hir::Generics,
797 span: syntax_pos::Span,
798 visibility: &hir::Visibility)
800 self.head(visibility_qualified(visibility, "enum"))?;
801 self.print_name(name)?;
802 self.print_generic_params(&generics.params)?;
803 self.print_where_clause(&generics.where_clause)?;
805 self.print_variants(&enum_definition.variants, span)
808 pub fn print_variants(&mut self,
809 variants: &[hir::Variant],
810 span: syntax_pos::Span)
814 self.space_if_not_bol()?;
815 self.maybe_print_comment(v.span.lo())?;
816 self.print_outer_attributes(&v.node.attrs)?;
817 self.ibox(indent_unit)?;
818 self.print_variant(v)?;
821 self.maybe_print_trailing_comment(v.span, None)?;
826 pub fn print_visibility(&mut self, vis: &hir::Visibility) -> io::Result<()> {
828 hir::VisibilityKind::Public => self.word_nbsp("pub")?,
829 hir::VisibilityKind::Crate(ast::CrateSugar::JustCrate) => self.word_nbsp("crate")?,
830 hir::VisibilityKind::Crate(ast::CrateSugar::PubCrate) => self.word_nbsp("pub(crate)")?,
831 hir::VisibilityKind::Restricted { ref path, .. } => {
832 self.s.word("pub(")?;
833 if path.segments.len() == 1 &&
834 path.segments[0].ident.name == keywords::Super.name() {
835 // Special case: `super` can print like `pub(super)`.
836 self.s.word("super")?;
838 // Everything else requires `in` at present.
839 self.word_nbsp("in")?;
840 self.print_path(path, false)?;
842 self.word_nbsp(")")?;
844 hir::VisibilityKind::Inherited => ()
850 pub fn print_defaultness(&mut self, defaultness: hir::Defaultness) -> io::Result<()> {
852 hir::Defaultness::Default { .. } => self.word_nbsp("default")?,
853 hir::Defaultness::Final => (),
858 pub fn print_struct(&mut self,
859 struct_def: &hir::VariantData,
860 generics: &hir::Generics,
862 span: syntax_pos::Span,
863 print_finalizer: bool)
865 self.print_name(name)?;
866 self.print_generic_params(&generics.params)?;
867 if !struct_def.is_struct() {
868 if struct_def.is_tuple() {
870 self.commasep(Inconsistent, struct_def.fields(), |s, field| {
871 s.maybe_print_comment(field.span.lo())?;
872 s.print_outer_attributes(&field.attrs)?;
873 s.print_visibility(&field.vis)?;
874 s.print_type(&field.ty)
878 self.print_where_clause(&generics.where_clause)?;
883 self.end() // close the outer-box
885 self.print_where_clause(&generics.where_clause)?;
888 self.hardbreak_if_not_bol()?;
890 for field in struct_def.fields() {
891 self.hardbreak_if_not_bol()?;
892 self.maybe_print_comment(field.span.lo())?;
893 self.print_outer_attributes(&field.attrs)?;
894 self.print_visibility(&field.vis)?;
895 self.print_ident(field.ident)?;
896 self.word_nbsp(":")?;
897 self.print_type(&field.ty)?;
905 pub fn print_variant(&mut self, v: &hir::Variant) -> io::Result<()> {
907 let generics = hir::Generics::empty();
908 self.print_struct(&v.node.data, &generics, v.node.name, v.span, false)?;
909 if let Some(ref d) = v.node.disr_expr {
911 self.word_space("=")?;
912 self.print_anon_const(d)?;
916 pub fn print_method_sig(&mut self,
919 generics: &hir::Generics,
920 vis: &hir::Visibility,
921 arg_names: &[ast::Ident],
922 body_id: Option<hir::BodyId>)
924 self.print_fn(&m.decl,
933 pub fn print_trait_item(&mut self, ti: &hir::TraitItem) -> io::Result<()> {
934 self.ann.pre(self, AnnNode::SubItem(ti.id))?;
935 self.hardbreak_if_not_bol()?;
936 self.maybe_print_comment(ti.span.lo())?;
937 self.print_outer_attributes(&ti.attrs)?;
939 hir::TraitItemKind::Const(ref ty, default) => {
940 let vis = Spanned { span: syntax_pos::DUMMY_SP,
941 node: hir::VisibilityKind::Inherited };
942 self.print_associated_const(ti.ident, &ty, default, &vis)?;
944 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Required(ref arg_names)) => {
945 let vis = Spanned { span: syntax_pos::DUMMY_SP,
946 node: hir::VisibilityKind::Inherited };
947 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, arg_names, None)?;
950 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Provided(body)) => {
951 let vis = Spanned { span: syntax_pos::DUMMY_SP,
952 node: hir::VisibilityKind::Inherited };
954 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, &[], Some(body))?;
956 self.end()?; // need to close a box
957 self.end()?; // need to close a box
958 self.ann.nested(self, Nested::Body(body))?;
960 hir::TraitItemKind::Type(ref bounds, ref default) => {
961 self.print_associated_type(ti.ident,
963 default.as_ref().map(|ty| &**ty))?;
966 self.ann.post(self, AnnNode::SubItem(ti.id))
969 pub fn print_impl_item(&mut self, ii: &hir::ImplItem) -> io::Result<()> {
970 self.ann.pre(self, AnnNode::SubItem(ii.id))?;
971 self.hardbreak_if_not_bol()?;
972 self.maybe_print_comment(ii.span.lo())?;
973 self.print_outer_attributes(&ii.attrs)?;
974 self.print_defaultness(ii.defaultness)?;
977 hir::ImplItemKind::Const(ref ty, expr) => {
978 self.print_associated_const(ii.ident, &ty, Some(expr), &ii.vis)?;
980 hir::ImplItemKind::Method(ref sig, body) => {
982 self.print_method_sig(ii.ident, sig, &ii.generics, &ii.vis, &[], Some(body))?;
984 self.end()?; // need to close a box
985 self.end()?; // need to close a box
986 self.ann.nested(self, Nested::Body(body))?;
988 hir::ImplItemKind::Type(ref ty) => {
989 self.print_associated_type(ii.ident, None, Some(ty))?;
991 hir::ImplItemKind::Existential(ref bounds) => {
992 self.word_space("existential")?;
993 self.print_associated_type(ii.ident, Some(bounds), None)?;
996 self.ann.post(self, AnnNode::SubItem(ii.id))
999 pub fn print_stmt(&mut self, st: &hir::Stmt) -> io::Result<()> {
1000 self.maybe_print_comment(st.span.lo())?;
1002 hir::StmtKind::Decl(ref decl, _) => {
1003 self.print_decl(&decl)?;
1005 hir::StmtKind::Expr(ref expr, _) => {
1006 self.space_if_not_bol()?;
1007 self.print_expr(&expr)?;
1009 hir::StmtKind::Semi(ref expr, _) => {
1010 self.space_if_not_bol()?;
1011 self.print_expr(&expr)?;
1015 if stmt_ends_with_semi(&st.node) {
1018 self.maybe_print_trailing_comment(st.span, None)
1021 pub fn print_block(&mut self, blk: &hir::Block) -> io::Result<()> {
1022 self.print_block_with_attrs(blk, &[])
1025 pub fn print_block_unclosed(&mut self, blk: &hir::Block) -> io::Result<()> {
1026 self.print_block_unclosed_indent(blk, indent_unit)
1029 pub fn print_block_unclosed_indent(&mut self,
1033 self.print_block_maybe_unclosed(blk, indented, &[], false)
1036 pub fn print_block_with_attrs(&mut self,
1038 attrs: &[ast::Attribute])
1040 self.print_block_maybe_unclosed(blk, indent_unit, attrs, true)
1043 pub fn print_block_maybe_unclosed(&mut self,
1046 attrs: &[ast::Attribute],
1050 hir::UnsafeBlock(..) => self.word_space("unsafe")?,
1051 hir::PushUnsafeBlock(..) => self.word_space("push_unsafe")?,
1052 hir::PopUnsafeBlock(..) => self.word_space("pop_unsafe")?,
1053 hir::DefaultBlock => (),
1055 self.maybe_print_comment(blk.span.lo())?;
1056 self.ann.pre(self, AnnNode::Block(blk))?;
1059 self.print_inner_attributes(attrs)?;
1061 for st in &blk.stmts {
1062 self.print_stmt(st)?;
1064 if let Some(ref expr) = blk.expr {
1065 self.space_if_not_bol()?;
1066 self.print_expr(&expr)?;
1067 self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi()))?;
1069 self.bclose_maybe_open(blk.span, indented, close_box)?;
1070 self.ann.post(self, AnnNode::Block(blk))
1073 fn print_else(&mut self, els: Option<&hir::Expr>) -> io::Result<()> {
1077 // "another else-if"
1078 hir::ExprKind::If(ref i, ref then, ref e) => {
1079 self.cbox(indent_unit - 1)?;
1081 self.s.word(" else if ")?;
1082 self.print_expr_as_cond(&i)?;
1084 self.print_expr(&then)?;
1085 self.print_else(e.as_ref().map(|e| &**e))
1088 hir::ExprKind::Block(ref b, _) => {
1089 self.cbox(indent_unit - 1)?;
1091 self.s.word(" else ")?;
1092 self.print_block(&b)
1094 // BLEAH, constraints would be great here
1096 panic!("print_if saw if with weird alternative");
1104 pub fn print_if(&mut self,
1107 elseopt: Option<&hir::Expr>)
1110 self.print_expr_as_cond(test)?;
1112 self.print_expr(blk)?;
1113 self.print_else(elseopt)
1116 pub fn print_if_let(&mut self,
1120 elseopt: Option<&hir::Expr>)
1122 self.head("if let")?;
1123 self.print_pat(pat)?;
1125 self.word_space("=")?;
1126 self.print_expr_as_cond(expr)?;
1128 self.print_block(blk)?;
1129 self.print_else(elseopt)
1132 pub fn print_anon_const(&mut self, constant: &hir::AnonConst) -> io::Result<()> {
1133 self.ann.nested(self, Nested::Body(constant.body))
1136 fn print_call_post(&mut self, args: &[hir::Expr]) -> io::Result<()> {
1138 self.commasep_exprs(Inconsistent, args)?;
1142 pub fn print_expr_maybe_paren(&mut self, expr: &hir::Expr, prec: i8) -> io::Result<()> {
1143 let needs_par = expr.precedence().order() < prec;
1147 self.print_expr(expr)?;
1154 /// Print an expr using syntax that's acceptable in a condition position, such as the `cond` in
1155 /// `if cond { ... }`.
1156 pub fn print_expr_as_cond(&mut self, expr: &hir::Expr) -> io::Result<()> {
1157 let needs_par = match expr.node {
1158 // These cases need parens due to the parse error observed in #26461: `if return {}`
1159 // parses as the erroneous construct `if (return {})`, not `if (return) {}`.
1160 hir::ExprKind::Closure(..) |
1161 hir::ExprKind::Ret(..) |
1162 hir::ExprKind::Break(..) => true,
1164 _ => contains_exterior_struct_lit(expr),
1170 self.print_expr(expr)?;
1177 fn print_expr_vec(&mut self, exprs: &[hir::Expr]) -> io::Result<()> {
1178 self.ibox(indent_unit)?;
1180 self.commasep_exprs(Inconsistent, exprs)?;
1185 fn print_expr_repeat(&mut self, element: &hir::Expr, count: &hir::AnonConst) -> io::Result<()> {
1186 self.ibox(indent_unit)?;
1188 self.print_expr(element)?;
1189 self.word_space(";")?;
1190 self.print_anon_const(count)?;
1195 fn print_expr_struct(&mut self,
1197 fields: &[hir::Field],
1198 wth: &Option<P<hir::Expr>>)
1200 self.print_qpath(qpath, true)?;
1202 self.commasep_cmnt(Consistent,
1205 s.ibox(indent_unit)?;
1206 if !field.is_shorthand {
1207 s.print_ident(field.ident)?;
1210 s.print_expr(&field.expr)?;
1216 self.ibox(indent_unit)?;
1217 if !fields.is_empty() {
1222 self.print_expr(&expr)?;
1225 _ => if !fields.is_empty() {
1233 fn print_expr_tup(&mut self, exprs: &[hir::Expr]) -> io::Result<()> {
1235 self.commasep_exprs(Inconsistent, exprs)?;
1236 if exprs.len() == 1 {
1242 fn print_expr_call(&mut self, func: &hir::Expr, args: &[hir::Expr]) -> io::Result<()> {
1245 hir::ExprKind::Field(..) => parser::PREC_FORCE_PAREN,
1246 _ => parser::PREC_POSTFIX,
1249 self.print_expr_maybe_paren(func, prec)?;
1250 self.print_call_post(args)
1253 fn print_expr_method_call(&mut self,
1254 segment: &hir::PathSegment,
1257 let base_args = &args[1..];
1258 self.print_expr_maybe_paren(&args[0], parser::PREC_POSTFIX)?;
1260 self.print_ident(segment.ident)?;
1262 segment.with_generic_args(|generic_args| {
1263 if !generic_args.args.is_empty() || !generic_args.bindings.is_empty() {
1264 return self.print_generic_args(&generic_args, segment.infer_types, true);
1268 self.print_call_post(base_args)
1271 fn print_expr_binary(&mut self,
1276 let assoc_op = bin_op_to_assoc_op(op.node);
1277 let prec = assoc_op.precedence() as i8;
1278 let fixity = assoc_op.fixity();
1280 let (left_prec, right_prec) = match fixity {
1281 Fixity::Left => (prec, prec + 1),
1282 Fixity::Right => (prec + 1, prec),
1283 Fixity::None => (prec + 1, prec + 1),
1286 let left_prec = match (&lhs.node, op.node) {
1287 // These cases need parens: `x as i32 < y` has the parser thinking that `i32 < y` is
1288 // the beginning of a path type. It starts trying to parse `x as (i32 < y ...` instead
1289 // of `(x as i32) < ...`. We need to convince it _not_ to do that.
1290 (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Lt) |
1291 (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Shl) => parser::PREC_FORCE_PAREN,
1295 self.print_expr_maybe_paren(lhs, left_prec)?;
1297 self.word_space(op.node.as_str())?;
1298 self.print_expr_maybe_paren(rhs, right_prec)
1301 fn print_expr_unary(&mut self, op: hir::UnOp, expr: &hir::Expr) -> io::Result<()> {
1302 self.s.word(op.as_str())?;
1303 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1306 fn print_expr_addr_of(&mut self,
1307 mutability: hir::Mutability,
1311 self.print_mutability(mutability)?;
1312 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1315 pub fn print_expr(&mut self, expr: &hir::Expr) -> io::Result<()> {
1316 self.maybe_print_comment(expr.span.lo())?;
1317 self.print_outer_attributes(&expr.attrs)?;
1318 self.ibox(indent_unit)?;
1319 self.ann.pre(self, AnnNode::Expr(expr))?;
1321 hir::ExprKind::Box(ref expr) => {
1322 self.word_space("box")?;
1323 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)?;
1325 hir::ExprKind::Array(ref exprs) => {
1326 self.print_expr_vec(exprs)?;
1328 hir::ExprKind::Repeat(ref element, ref count) => {
1329 self.print_expr_repeat(&element, count)?;
1331 hir::ExprKind::Struct(ref qpath, ref fields, ref wth) => {
1332 self.print_expr_struct(qpath, &fields[..], wth)?;
1334 hir::ExprKind::Tup(ref exprs) => {
1335 self.print_expr_tup(exprs)?;
1337 hir::ExprKind::Call(ref func, ref args) => {
1338 self.print_expr_call(&func, args)?;
1340 hir::ExprKind::MethodCall(ref segment, _, ref args) => {
1341 self.print_expr_method_call(segment, args)?;
1343 hir::ExprKind::Binary(op, ref lhs, ref rhs) => {
1344 self.print_expr_binary(op, &lhs, &rhs)?;
1346 hir::ExprKind::Unary(op, ref expr) => {
1347 self.print_expr_unary(op, &expr)?;
1349 hir::ExprKind::AddrOf(m, ref expr) => {
1350 self.print_expr_addr_of(m, &expr)?;
1352 hir::ExprKind::Lit(ref lit) => {
1353 self.print_literal(&lit)?;
1355 hir::ExprKind::Cast(ref expr, ref ty) => {
1356 let prec = AssocOp::As.precedence() as i8;
1357 self.print_expr_maybe_paren(&expr, prec)?;
1359 self.word_space("as")?;
1360 self.print_type(&ty)?;
1362 hir::ExprKind::Type(ref expr, ref ty) => {
1363 let prec = AssocOp::Colon.precedence() as i8;
1364 self.print_expr_maybe_paren(&expr, prec)?;
1365 self.word_space(":")?;
1366 self.print_type(&ty)?;
1368 hir::ExprKind::If(ref test, ref blk, ref elseopt) => {
1369 self.print_if(&test, &blk, elseopt.as_ref().map(|e| &**e))?;
1371 hir::ExprKind::While(ref test, ref blk, opt_label) => {
1372 if let Some(label) = opt_label {
1373 self.print_ident(label.ident)?;
1374 self.word_space(":")?;
1376 self.head("while")?;
1377 self.print_expr_as_cond(&test)?;
1379 self.print_block(&blk)?;
1381 hir::ExprKind::Loop(ref blk, opt_label, _) => {
1382 if let Some(label) = opt_label {
1383 self.print_ident(label.ident)?;
1384 self.word_space(":")?;
1388 self.print_block(&blk)?;
1390 hir::ExprKind::Match(ref expr, ref arms, _) => {
1391 self.cbox(indent_unit)?;
1393 self.word_nbsp("match")?;
1394 self.print_expr_as_cond(&expr)?;
1398 self.print_arm(arm)?;
1400 self.bclose_(expr.span, indent_unit)?;
1402 hir::ExprKind::Closure(capture_clause, ref decl, body, _fn_decl_span, _gen) => {
1403 self.print_capture_clause(capture_clause)?;
1405 self.print_closure_args(&decl, body)?;
1408 // this is a bare expression
1409 self.ann.nested(self, Nested::Body(body))?;
1410 self.end()?; // need to close a box
1412 // a box will be closed by print_expr, but we didn't want an overall
1413 // wrapper so we closed the corresponding opening. so create an
1414 // empty box to satisfy the close.
1417 hir::ExprKind::Block(ref blk, opt_label) => {
1418 if let Some(label) = opt_label {
1419 self.print_ident(label.ident)?;
1420 self.word_space(":")?;
1422 // containing cbox, will be closed by print-block at }
1423 self.cbox(indent_unit)?;
1424 // head-box, will be closed by print-block after {
1426 self.print_block(&blk)?;
1428 hir::ExprKind::Assign(ref lhs, ref rhs) => {
1429 let prec = AssocOp::Assign.precedence() as i8;
1430 self.print_expr_maybe_paren(&lhs, prec + 1)?;
1432 self.word_space("=")?;
1433 self.print_expr_maybe_paren(&rhs, prec)?;
1435 hir::ExprKind::AssignOp(op, ref lhs, ref rhs) => {
1436 let prec = AssocOp::Assign.precedence() as i8;
1437 self.print_expr_maybe_paren(&lhs, prec + 1)?;
1439 self.s.word(op.node.as_str())?;
1440 self.word_space("=")?;
1441 self.print_expr_maybe_paren(&rhs, prec)?;
1443 hir::ExprKind::Field(ref expr, ident) => {
1444 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX)?;
1446 self.print_ident(ident)?;
1448 hir::ExprKind::Index(ref expr, ref index) => {
1449 self.print_expr_maybe_paren(&expr, parser::PREC_POSTFIX)?;
1451 self.print_expr(&index)?;
1454 hir::ExprKind::Path(ref qpath) => {
1455 self.print_qpath(qpath, true)?
1457 hir::ExprKind::Break(destination, ref opt_expr) => {
1458 self.s.word("break")?;
1460 if let Some(label) = destination.label {
1461 self.print_ident(label.ident)?;
1464 if let Some(ref expr) = *opt_expr {
1465 self.print_expr_maybe_paren(expr, parser::PREC_JUMP)?;
1469 hir::ExprKind::Continue(destination) => {
1470 self.s.word("continue")?;
1472 if let Some(label) = destination.label {
1473 self.print_ident(label.ident)?;
1477 hir::ExprKind::Ret(ref result) => {
1478 self.s.word("return")?;
1479 if let Some(ref expr) = *result {
1481 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP)?;
1484 hir::ExprKind::InlineAsm(ref a, ref outputs, ref inputs) => {
1485 self.s.word("asm!")?;
1487 self.print_string(&a.asm.as_str(), a.asm_str_style)?;
1488 self.word_space(":")?;
1490 let mut out_idx = 0;
1491 self.commasep(Inconsistent, &a.outputs, |s, out| {
1492 let constraint = out.constraint.as_str();
1493 let mut ch = constraint.chars();
1495 Some('=') if out.is_rw => {
1496 s.print_string(&format!("+{}", ch.as_str()),
1497 ast::StrStyle::Cooked)?
1499 _ => s.print_string(&constraint, ast::StrStyle::Cooked)?,
1502 s.print_expr(&outputs[out_idx])?;
1508 self.word_space(":")?;
1511 self.commasep(Inconsistent, &a.inputs, |s, co| {
1512 s.print_string(&co.as_str(), ast::StrStyle::Cooked)?;
1514 s.print_expr(&inputs[in_idx])?;
1520 self.word_space(":")?;
1522 self.commasep(Inconsistent, &a.clobbers, |s, co| {
1523 s.print_string(&co.as_str(), ast::StrStyle::Cooked)?;
1527 let mut options = vec![];
1529 options.push("volatile");
1532 options.push("alignstack");
1534 if a.dialect == ast::AsmDialect::Intel {
1535 options.push("intel");
1538 if !options.is_empty() {
1540 self.word_space(":")?;
1541 self.commasep(Inconsistent, &options, |s, &co| {
1542 s.print_string(co, ast::StrStyle::Cooked)?;
1549 hir::ExprKind::Yield(ref expr) => {
1550 self.word_space("yield")?;
1551 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP)?;
1554 self.ann.post(self, AnnNode::Expr(expr))?;
1558 pub fn print_local_decl(&mut self, loc: &hir::Local) -> io::Result<()> {
1559 self.print_pat(&loc.pat)?;
1560 if let Some(ref ty) = loc.ty {
1561 self.word_space(":")?;
1562 self.print_type(&ty)?;
1567 pub fn print_decl(&mut self, decl: &hir::Decl) -> io::Result<()> {
1568 self.maybe_print_comment(decl.span.lo())?;
1570 hir::DeclKind::Local(ref loc) => {
1571 self.space_if_not_bol()?;
1572 self.ibox(indent_unit)?;
1573 self.word_nbsp("let")?;
1575 self.ibox(indent_unit)?;
1576 self.print_local_decl(&loc)?;
1578 if let Some(ref init) = loc.init {
1580 self.word_space("=")?;
1581 self.print_expr(&init)?;
1585 hir::DeclKind::Item(item) => {
1586 self.ann.nested(self, Nested::Item(item))
1591 pub fn print_usize(&mut self, i: usize) -> io::Result<()> {
1592 self.s.word(i.to_string())
1595 pub fn print_ident(&mut self, ident: ast::Ident) -> io::Result<()> {
1596 if ident.is_raw_guess() {
1597 self.s.word(format!("r#{}", ident.name))?;
1599 self.s.word(ident.as_str().get())?;
1601 self.ann.post(self, AnnNode::Name(&ident.name))
1604 pub fn print_name(&mut self, name: ast::Name) -> io::Result<()> {
1605 self.print_ident(ast::Ident::with_empty_ctxt(name))
1608 pub fn print_for_decl(&mut self, loc: &hir::Local, coll: &hir::Expr) -> io::Result<()> {
1609 self.print_local_decl(loc)?;
1611 self.word_space("in")?;
1612 self.print_expr(coll)
1615 pub fn print_path(&mut self,
1617 colons_before_params: bool)
1619 self.maybe_print_comment(path.span.lo())?;
1621 for (i, segment) in path.segments.iter().enumerate() {
1625 if segment.ident.name != keywords::PathRoot.name() &&
1626 segment.ident.name != keywords::DollarCrate.name() {
1627 self.print_ident(segment.ident)?;
1628 segment.with_generic_args(|generic_args| {
1629 self.print_generic_args(generic_args, segment.infer_types,
1630 colons_before_params)
1638 pub fn print_path_segment(&mut self, segment: &hir::PathSegment) -> io::Result<()> {
1639 if segment.ident.name != keywords::PathRoot.name() &&
1640 segment.ident.name != keywords::DollarCrate.name() {
1641 self.print_ident(segment.ident)?;
1642 segment.with_generic_args(|generic_args| {
1643 self.print_generic_args(generic_args, segment.infer_types, false)
1649 pub fn print_qpath(&mut self,
1651 colons_before_params: bool)
1654 hir::QPath::Resolved(None, ref path) => {
1655 self.print_path(path, colons_before_params)
1657 hir::QPath::Resolved(Some(ref qself), ref path) => {
1659 self.print_type(qself)?;
1661 self.word_space("as")?;
1663 for (i, segment) in path.segments[..path.segments.len() - 1].iter().enumerate() {
1667 if segment.ident.name != keywords::PathRoot.name() &&
1668 segment.ident.name != keywords::DollarCrate.name() {
1669 self.print_ident(segment.ident)?;
1670 segment.with_generic_args(|generic_args| {
1671 self.print_generic_args(generic_args,
1672 segment.infer_types,
1673 colons_before_params)
1680 let item_segment = path.segments.last().unwrap();
1681 self.print_ident(item_segment.ident)?;
1682 item_segment.with_generic_args(|generic_args| {
1683 self.print_generic_args(generic_args,
1684 item_segment.infer_types,
1685 colons_before_params)
1688 hir::QPath::TypeRelative(ref qself, ref item_segment) => {
1690 self.print_type(qself)?;
1693 self.print_ident(item_segment.ident)?;
1694 item_segment.with_generic_args(|generic_args| {
1695 self.print_generic_args(generic_args,
1696 item_segment.infer_types,
1697 colons_before_params)
1703 fn print_generic_args(&mut self,
1704 generic_args: &hir::GenericArgs,
1706 colons_before_params: bool)
1708 if generic_args.parenthesized {
1710 self.commasep(Inconsistent, generic_args.inputs(), |s, ty| s.print_type(&ty))?;
1713 self.space_if_not_bol()?;
1714 self.word_space("->")?;
1715 self.print_type(&generic_args.bindings[0].ty)?;
1717 let start = if colons_before_params { "::<" } else { "<" };
1718 let empty = Cell::new(true);
1719 let start_or_comma = |this: &mut Self| {
1724 this.word_space(",")
1728 let mut types = vec![];
1729 let mut elide_lifetimes = true;
1730 for arg in &generic_args.args {
1732 GenericArg::Lifetime(lt) => {
1733 if !lt.is_elided() {
1734 elide_lifetimes = false;
1737 GenericArg::Type(ty) => {
1742 if !elide_lifetimes {
1743 start_or_comma(self)?;
1744 self.commasep(Inconsistent, &generic_args.args, |s, generic_arg| {
1746 GenericArg::Lifetime(lt) => s.print_lifetime(lt),
1747 GenericArg::Type(ty) => s.print_type(ty),
1750 } else if !types.is_empty() {
1751 start_or_comma(self)?;
1752 self.commasep(Inconsistent, &types, |s, ty| s.print_type(&ty))?;
1755 // FIXME(eddyb) This would leak into error messages, e.g.:
1756 // "non-exhaustive patterns: `Some::<..>(_)` not covered".
1757 if infer_types && false {
1758 start_or_comma(self)?;
1762 for binding in generic_args.bindings.iter() {
1763 start_or_comma(self)?;
1764 self.print_ident(binding.ident)?;
1766 self.word_space("=")?;
1767 self.print_type(&binding.ty)?;
1778 pub fn print_pat(&mut self, pat: &hir::Pat) -> io::Result<()> {
1779 self.maybe_print_comment(pat.span.lo())?;
1780 self.ann.pre(self, AnnNode::Pat(pat))?;
1781 // Pat isn't normalized, but the beauty of it
1782 // is that it doesn't matter
1784 PatKind::Wild => self.s.word("_")?,
1785 PatKind::Binding(binding_mode, _, ident, ref sub) => {
1786 match binding_mode {
1787 hir::BindingAnnotation::Ref => {
1788 self.word_nbsp("ref")?;
1789 self.print_mutability(hir::MutImmutable)?;
1791 hir::BindingAnnotation::RefMut => {
1792 self.word_nbsp("ref")?;
1793 self.print_mutability(hir::MutMutable)?;
1795 hir::BindingAnnotation::Unannotated => {}
1796 hir::BindingAnnotation::Mutable => {
1797 self.word_nbsp("mut")?;
1800 self.print_ident(ident)?;
1801 if let Some(ref p) = *sub {
1803 self.print_pat(&p)?;
1806 PatKind::TupleStruct(ref qpath, ref elts, ddpos) => {
1807 self.print_qpath(qpath, true)?;
1809 if let Some(ddpos) = ddpos {
1810 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p))?;
1812 self.word_space(",")?;
1815 if ddpos != elts.len() {
1817 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p))?;
1820 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))?;
1824 PatKind::Path(ref qpath) => {
1825 self.print_qpath(qpath, true)?;
1827 PatKind::Struct(ref qpath, ref fields, etc) => {
1828 self.print_qpath(qpath, true)?;
1830 self.word_space("{")?;
1831 self.commasep_cmnt(Consistent,
1834 s.cbox(indent_unit)?;
1835 if !f.node.is_shorthand {
1836 s.print_ident(f.node.ident)?;
1839 s.print_pat(&f.node.pat)?;
1842 |f| f.node.pat.span)?;
1844 if !fields.is_empty() {
1845 self.word_space(",")?;
1852 PatKind::Tuple(ref elts, ddpos) => {
1854 if let Some(ddpos) = ddpos {
1855 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p))?;
1857 self.word_space(",")?;
1860 if ddpos != elts.len() {
1862 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p))?;
1865 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))?;
1866 if elts.len() == 1 {
1872 PatKind::Box(ref inner) => {
1873 let is_range_inner = match inner.node {
1874 PatKind::Range(..) => true,
1877 self.s.word("box ")?;
1881 self.print_pat(&inner)?;
1886 PatKind::Ref(ref inner, mutbl) => {
1887 let is_range_inner = match inner.node {
1888 PatKind::Range(..) => true,
1892 if mutbl == hir::MutMutable {
1893 self.s.word("mut ")?;
1898 self.print_pat(&inner)?;
1903 PatKind::Lit(ref e) => self.print_expr(&e)?,
1904 PatKind::Range(ref begin, ref end, ref end_kind) => {
1905 self.print_expr(&begin)?;
1908 RangeEnd::Included => self.s.word("...")?,
1909 RangeEnd::Excluded => self.s.word("..")?,
1911 self.print_expr(&end)?;
1913 PatKind::Slice(ref before, ref slice, ref after) => {
1915 self.commasep(Inconsistent, &before[..], |s, p| s.print_pat(&p))?;
1916 if let Some(ref p) = *slice {
1917 if !before.is_empty() {
1918 self.word_space(",")?;
1920 if let PatKind::Wild = p.node {
1923 self.print_pat(&p)?;
1926 if !after.is_empty() {
1927 self.word_space(",")?;
1930 self.commasep(Inconsistent, &after[..], |s, p| s.print_pat(&p))?;
1934 self.ann.post(self, AnnNode::Pat(pat))
1937 fn print_arm(&mut self, arm: &hir::Arm) -> io::Result<()> {
1938 // I have no idea why this check is necessary, but here it
1940 if arm.attrs.is_empty() {
1943 self.cbox(indent_unit)?;
1945 self.print_outer_attributes(&arm.attrs)?;
1946 let mut first = true;
1947 for p in &arm.pats {
1952 self.word_space("|")?;
1954 self.print_pat(&p)?;
1957 if let Some(ref g) = arm.guard {
1959 hir::Guard::If(e) => {
1960 self.word_space("if")?;
1961 self.print_expr(&e)?;
1966 self.word_space("=>")?;
1968 match arm.body.node {
1969 hir::ExprKind::Block(ref blk, opt_label) => {
1970 if let Some(label) = opt_label {
1971 self.print_ident(label.ident)?;
1972 self.word_space(":")?;
1974 // the block will close the pattern's ibox
1975 self.print_block_unclosed_indent(&blk, indent_unit)?;
1977 // If it is a user-provided unsafe block, print a comma after it
1978 if let hir::UnsafeBlock(hir::UserProvided) = blk.rules {
1983 self.end()?; // close the ibox for the pattern
1984 self.print_expr(&arm.body)?;
1988 self.end() // close enclosing cbox
1991 pub fn print_fn(&mut self,
1993 header: hir::FnHeader,
1994 name: Option<ast::Name>,
1995 generics: &hir::Generics,
1996 vis: &hir::Visibility,
1997 arg_names: &[ast::Ident],
1998 body_id: Option<hir::BodyId>)
2000 self.print_fn_header_info(header, vis)?;
2002 if let Some(name) = name {
2004 self.print_name(name)?;
2006 self.print_generic_params(&generics.params)?;
2010 // Make sure we aren't supplied *both* `arg_names` and `body_id`.
2011 assert!(arg_names.is_empty() || body_id.is_none());
2012 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
2013 s.ibox(indent_unit)?;
2014 if let Some(arg_name) = arg_names.get(i) {
2015 s.s.word(arg_name.as_str().get())?;
2018 } else if let Some(body_id) = body_id {
2019 s.ann.nested(s, Nested::BodyArgPat(body_id, i))?;
2028 self.s.word(", ...")?;
2032 self.print_fn_output(decl)?;
2033 self.print_where_clause(&generics.where_clause)
2036 fn print_closure_args(&mut self, decl: &hir::FnDecl, body_id: hir::BodyId) -> io::Result<()> {
2039 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
2040 s.ibox(indent_unit)?;
2042 s.ann.nested(s, Nested::BodyArgPat(body_id, i))?;
2045 if let hir::TyKind::Infer = ty.node {
2056 if let hir::DefaultReturn(..) = decl.output {
2060 self.space_if_not_bol()?;
2061 self.word_space("->")?;
2063 hir::Return(ref ty) => {
2064 self.print_type(&ty)?;
2065 self.maybe_print_comment(ty.span.lo())
2067 hir::DefaultReturn(..) => unreachable!(),
2071 pub fn print_capture_clause(&mut self, capture_clause: hir::CaptureClause) -> io::Result<()> {
2072 match capture_clause {
2073 hir::CaptureByValue => self.word_space("move"),
2074 hir::CaptureByRef => Ok(()),
2078 pub fn print_bounds(&mut self, prefix: &'static str, bounds: &[hir::GenericBound])
2080 if !bounds.is_empty() {
2081 self.s.word(prefix)?;
2082 let mut first = true;
2083 for bound in bounds {
2084 if !(first && prefix.is_empty()) {
2090 self.word_space("+")?;
2094 GenericBound::Trait(tref, modifier) => {
2095 if modifier == &TraitBoundModifier::Maybe {
2098 self.print_poly_trait_ref(tref)?;
2100 GenericBound::Outlives(lt) => {
2101 self.print_lifetime(lt)?;
2109 pub fn print_generic_params(&mut self, generic_params: &[GenericParam]) -> io::Result<()> {
2110 if !generic_params.is_empty() {
2113 self.commasep(Inconsistent, generic_params, |s, param| {
2114 s.print_generic_param(param)
2122 pub fn print_generic_param(&mut self, param: &GenericParam) -> io::Result<()> {
2123 self.print_ident(param.name.ident())?;
2125 GenericParamKind::Lifetime { .. } => {
2127 for bound in ¶m.bounds {
2129 GenericBound::Outlives(lt) => {
2131 self.print_lifetime(lt)?;
2139 GenericParamKind::Type { ref default, .. } => {
2140 self.print_bounds(":", ¶m.bounds)?;
2144 self.word_space("=")?;
2145 self.print_type(&default)
2153 pub fn print_lifetime(&mut self, lifetime: &hir::Lifetime) -> io::Result<()> {
2154 self.print_ident(lifetime.name.ident())
2157 pub fn print_where_clause(&mut self, where_clause: &hir::WhereClause) -> io::Result<()> {
2158 if where_clause.predicates.is_empty() {
2163 self.word_space("where")?;
2165 for (i, predicate) in where_clause.predicates.iter().enumerate() {
2167 self.word_space(",")?;
2171 &hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
2172 ref bound_generic_params,
2177 self.print_formal_generic_params(bound_generic_params)?;
2178 self.print_type(&bounded_ty)?;
2179 self.print_bounds(":", bounds)?;
2181 &hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate{ref lifetime,
2184 self.print_lifetime(lifetime)?;
2187 for (i, bound) in bounds.iter().enumerate() {
2189 GenericBound::Outlives(lt) => {
2190 self.print_lifetime(lt)?;
2200 &hir::WherePredicate::EqPredicate(hir::WhereEqPredicate{ref lhs_ty,
2203 self.print_type(lhs_ty)?;
2205 self.word_space("=")?;
2206 self.print_type(rhs_ty)?;
2214 pub fn print_mutability(&mut self, mutbl: hir::Mutability) -> io::Result<()> {
2216 hir::MutMutable => self.word_nbsp("mut"),
2217 hir::MutImmutable => Ok(()),
2221 pub fn print_mt(&mut self, mt: &hir::MutTy) -> io::Result<()> {
2222 self.print_mutability(mt.mutbl)?;
2223 self.print_type(&mt.ty)
2226 pub fn print_fn_output(&mut self, decl: &hir::FnDecl) -> io::Result<()> {
2227 if let hir::DefaultReturn(..) = decl.output {
2231 self.space_if_not_bol()?;
2232 self.ibox(indent_unit)?;
2233 self.word_space("->")?;
2235 hir::DefaultReturn(..) => unreachable!(),
2236 hir::Return(ref ty) => self.print_type(&ty)?,
2241 hir::Return(ref output) => self.maybe_print_comment(output.span.lo()),
2246 pub fn print_ty_fn(&mut self,
2248 unsafety: hir::Unsafety,
2250 name: Option<ast::Name>,
2251 generic_params: &[hir::GenericParam],
2252 arg_names: &[ast::Ident])
2254 self.ibox(indent_unit)?;
2255 if !generic_params.is_empty() {
2256 self.s.word("for")?;
2257 self.print_generic_params(generic_params)?;
2259 let generics = hir::Generics {
2260 params: hir::HirVec::new(),
2261 where_clause: hir::WhereClause {
2262 id: ast::DUMMY_NODE_ID,
2263 predicates: hir::HirVec::new(),
2265 span: syntax_pos::DUMMY_SP,
2271 constness: hir::Constness::NotConst,
2272 asyncness: hir::IsAsync::NotAsync,
2276 &Spanned { span: syntax_pos::DUMMY_SP,
2277 node: hir::VisibilityKind::Inherited },
2283 pub fn maybe_print_trailing_comment(&mut self,
2284 span: syntax_pos::Span,
2285 next_pos: Option<BytePos>)
2287 let cm = match self.cm {
2291 if let Some(ref cmnt) = self.next_comment() {
2292 if (*cmnt).style != comments::Trailing {
2295 let span_line = cm.lookup_char_pos(span.hi());
2296 let comment_line = cm.lookup_char_pos((*cmnt).pos);
2297 let mut next = (*cmnt).pos + BytePos(1);
2298 if let Some(p) = next_pos {
2301 if span.hi() < (*cmnt).pos && (*cmnt).pos < next &&
2302 span_line.line == comment_line.line {
2303 self.print_comment(cmnt)?;
2309 pub fn print_remaining_comments(&mut self) -> io::Result<()> {
2310 // If there aren't any remaining comments, then we need to manually
2311 // make sure there is a line break at the end.
2312 if self.next_comment().is_none() {
2313 self.s.hardbreak()?;
2315 while let Some(ref cmnt) = self.next_comment() {
2316 self.print_comment(cmnt)?
2321 pub fn print_opt_abi_and_extern_if_nondefault(&mut self,
2322 opt_abi: Option<Abi>)
2325 Some(Abi::Rust) => Ok(()),
2327 self.word_nbsp("extern")?;
2328 self.word_nbsp(abi.to_string())
2334 pub fn print_extern_opt_abi(&mut self, opt_abi: Option<Abi>) -> io::Result<()> {
2337 self.word_nbsp("extern")?;
2338 self.word_nbsp(abi.to_string())
2344 pub fn print_fn_header_info(&mut self,
2345 header: hir::FnHeader,
2346 vis: &hir::Visibility)
2348 self.s.word(visibility_qualified(vis, ""))?;
2350 match header.constness {
2351 hir::Constness::NotConst => {}
2352 hir::Constness::Const => self.word_nbsp("const")?,
2355 match header.asyncness {
2356 hir::IsAsync::NotAsync => {}
2357 hir::IsAsync::Async => self.word_nbsp("async")?,
2360 self.print_unsafety(header.unsafety)?;
2362 if header.abi != Abi::Rust {
2363 self.word_nbsp("extern")?;
2364 self.word_nbsp(header.abi.to_string())?;
2370 pub fn print_unsafety(&mut self, s: hir::Unsafety) -> io::Result<()> {
2372 hir::Unsafety::Normal => Ok(()),
2373 hir::Unsafety::Unsafe => self.word_nbsp("unsafe"),
2377 pub fn print_is_auto(&mut self, s: hir::IsAuto) -> io::Result<()> {
2379 hir::IsAuto::Yes => self.word_nbsp("auto"),
2380 hir::IsAuto::No => Ok(()),
2385 // Dup'ed from parse::classify, but adapted for the HIR.
2386 /// Does this expression require a semicolon to be treated
2387 /// as a statement? The negation of this: 'can this expression
2388 /// be used as a statement without a semicolon' -- is used
2389 /// as an early-bail-out in the parser so that, for instance,
2390 /// if true {...} else {...}
2392 /// isn't parsed as (if true {...} else {...} | x) | 5
2393 fn expr_requires_semi_to_be_stmt(e: &hir::Expr) -> bool {
2395 hir::ExprKind::If(..) |
2396 hir::ExprKind::Match(..) |
2397 hir::ExprKind::Block(..) |
2398 hir::ExprKind::While(..) |
2399 hir::ExprKind::Loop(..) => false,
2404 /// this statement requires a semicolon after it.
2405 /// note that in one case (stmt_semi), we've already
2406 /// seen the semicolon, and thus don't need another.
2407 fn stmt_ends_with_semi(stmt: &hir::StmtKind) -> bool {
2409 hir::StmtKind::Decl(ref d, _) => {
2411 hir::DeclKind::Local(_) => true,
2412 hir::DeclKind::Item(_) => false,
2415 hir::StmtKind::Expr(ref e, _) => {
2416 expr_requires_semi_to_be_stmt(&e)
2418 hir::StmtKind::Semi(..) => {
2424 fn bin_op_to_assoc_op(op: hir::BinOpKind) -> AssocOp {
2425 use hir::BinOpKind::*;
2427 Add => AssocOp::Add,
2428 Sub => AssocOp::Subtract,
2429 Mul => AssocOp::Multiply,
2430 Div => AssocOp::Divide,
2431 Rem => AssocOp::Modulus,
2433 And => AssocOp::LAnd,
2436 BitXor => AssocOp::BitXor,
2437 BitAnd => AssocOp::BitAnd,
2438 BitOr => AssocOp::BitOr,
2439 Shl => AssocOp::ShiftLeft,
2440 Shr => AssocOp::ShiftRight,
2442 Eq => AssocOp::Equal,
2443 Lt => AssocOp::Less,
2444 Le => AssocOp::LessEqual,
2445 Ne => AssocOp::NotEqual,
2446 Ge => AssocOp::GreaterEqual,
2447 Gt => AssocOp::Greater,
2451 /// Expressions that syntactically contain an "exterior" struct literal i.e. not surrounded by any
2452 /// parens or other delimiters, e.g. `X { y: 1 }`, `X { y: 1 }.method()`, `foo == X { y: 1 }` and
2453 /// `X { y: 1 } == foo` all do, but `(X { y: 1 }) == foo` does not.
2454 fn contains_exterior_struct_lit(value: &hir::Expr) -> bool {
2456 hir::ExprKind::Struct(..) => true,
2458 hir::ExprKind::Assign(ref lhs, ref rhs) |
2459 hir::ExprKind::AssignOp(_, ref lhs, ref rhs) |
2460 hir::ExprKind::Binary(_, ref lhs, ref rhs) => {
2461 // X { y: 1 } + X { y: 2 }
2462 contains_exterior_struct_lit(&lhs) || contains_exterior_struct_lit(&rhs)
2464 hir::ExprKind::Unary(_, ref x) |
2465 hir::ExprKind::Cast(ref x, _) |
2466 hir::ExprKind::Type(ref x, _) |
2467 hir::ExprKind::Field(ref x, _) |
2468 hir::ExprKind::Index(ref x, _) => {
2469 // &X { y: 1 }, X { y: 1 }.y
2470 contains_exterior_struct_lit(&x)
2473 hir::ExprKind::MethodCall(.., ref exprs) => {
2474 // X { y: 1 }.bar(...)
2475 contains_exterior_struct_lit(&exprs[0])