1 use rustc_target::spec::abi::Abi;
3 use syntax::source_map::{SourceMap, Spanned};
4 use syntax::parse::ParseSess;
5 use syntax::parse::lexer::comments;
6 use syntax::print::pp::{self, Breaks};
7 use syntax::print::pp::Breaks::{Consistent, Inconsistent};
8 use syntax::print::pprust::PrintState;
10 use syntax::symbol::keywords;
11 use syntax::util::parser::{self, AssocOp, Fixity};
12 use syntax_pos::{self, BytePos, FileName};
15 use crate::hir::{PatKind, GenericBound, TraitBoundModifier, RangeEnd};
16 use crate::hir::{GenericParam, GenericParamKind, GenericArg};
20 use std::io::{self, Write, Read};
21 use std::iter::Peekable;
24 pub enum AnnNode<'a> {
26 Block(&'a hir::Block),
35 TraitItem(hir::TraitItemId),
36 ImplItem(hir::ImplItemId),
38 BodyArgPat(hir::BodyId, usize)
42 fn nested(&self, _state: &mut State<'_>, _nested: Nested) -> io::Result<()> {
45 fn pre(&self, _state: &mut State<'_>, _node: AnnNode<'_>) -> io::Result<()> {
48 fn post(&self, _state: &mut State<'_>, _node: AnnNode<'_>) -> io::Result<()> {
51 fn try_fetch_item(&self, _: ast::NodeId) -> Option<&hir::Item> {
57 impl PpAnn for NoAnn {}
58 pub const NO_ANN: &dyn PpAnn = &NoAnn;
60 impl PpAnn for hir::Crate {
61 fn try_fetch_item(&self, item: ast::NodeId) -> Option<&hir::Item> {
64 fn nested(&self, state: &mut State<'_>, nested: Nested) -> io::Result<()> {
66 Nested::Item(id) => state.print_item(self.item(id.id)),
67 Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
68 Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
69 Nested::Body(id) => state.print_expr(&self.body(id).value),
70 Nested::BodyArgPat(id, i) => state.print_pat(&self.body(id).arguments[i].pat)
75 pub struct State<'a> {
76 pub s: pp::Printer<'a>,
77 cm: Option<&'a SourceMap>,
78 comments: Option<Vec<comments::Comment>>,
79 literals: Peekable<vec::IntoIter<comments::Literal>>,
81 boxes: Vec<pp::Breaks>,
82 ann: &'a (dyn PpAnn + 'a),
85 impl<'a> PrintState<'a> for State<'a> {
86 fn writer(&mut self) -> &mut pp::Printer<'a> {
90 fn boxes(&mut self) -> &mut Vec<pp::Breaks> {
94 fn comments(&mut self) -> &mut Option<Vec<comments::Comment>> {
98 fn cur_cmnt(&mut self) -> &mut usize {
102 fn cur_lit(&mut self) -> Option<&comments::Literal> {
106 fn bump_lit(&mut self) -> Option<comments::Literal> {
111 #[allow(non_upper_case_globals)]
112 pub const indent_unit: usize = 4;
114 #[allow(non_upper_case_globals)]
115 pub const default_columns: usize = 78;
118 /// Requires you to pass an input filename and reader so that
119 /// it can scan the input text for comments and literals to
121 pub fn print_crate<'a>(cm: &'a SourceMap,
125 input: &mut dyn Read,
126 out: Box<dyn Write + 'a>,
130 let mut s = State::new_from_input(cm, sess, filename, input, out, ann, is_expanded);
132 // When printing the AST, we sometimes need to inject `#[no_std]` here.
133 // Since you can't compile the HIR, it's not necessary.
135 s.print_mod(&krate.module, &krate.attrs)?;
136 s.print_remaining_comments()?;
141 pub fn new_from_input(cm: &'a SourceMap,
144 input: &mut dyn Read,
145 out: Box<dyn Write + 'a>,
149 let (cmnts, lits) = comments::gather_comments_and_literals(sess, filename, input);
155 // If the code is post expansion, don't use the table of
156 // literals, since it doesn't correspond with the literals
157 // in the AST anymore.
165 pub fn new(cm: &'a SourceMap,
166 out: Box<dyn Write + 'a>,
168 comments: Option<Vec<comments::Comment>>,
169 literals: Option<Vec<comments::Literal>>)
172 s: pp::mk_printer(out, default_columns),
175 literals: literals.unwrap_or_default().into_iter().peekable(),
183 pub fn to_string<F>(ann: &dyn PpAnn, f: F) -> String
184 where F: FnOnce(&mut State<'_>) -> io::Result<()>
186 let mut wr = Vec::new();
188 let mut printer = State {
189 s: pp::mk_printer(Box::new(&mut wr), default_columns),
192 literals: vec![].into_iter().peekable(),
197 f(&mut printer).unwrap();
198 printer.s.eof().unwrap();
200 String::from_utf8(wr).unwrap()
203 pub fn visibility_qualified<S: Into<Cow<'static, str>>>(vis: &hir::Visibility, w: S) -> String {
204 to_string(NO_ANN, |s| {
205 s.print_visibility(vis)?;
211 pub fn cbox(&mut self, u: usize) -> io::Result<()> {
212 self.boxes.push(pp::Breaks::Consistent);
216 pub fn nbsp(&mut self) -> io::Result<()> {
220 pub fn word_nbsp<S: Into<Cow<'static, str>>>(&mut self, w: S) -> io::Result<()> {
225 pub fn head<S: Into<Cow<'static, str>>>(&mut self, w: S) -> io::Result<()> {
227 // outer-box is consistent
228 self.cbox(indent_unit)?;
229 // head-box is inconsistent
230 self.ibox(w.len() + 1)?;
231 // keyword that starts the head
238 pub fn bopen(&mut self) -> io::Result<()> {
240 self.end() // close the head-box
243 pub fn bclose_(&mut self, span: syntax_pos::Span, indented: usize) -> io::Result<()> {
244 self.bclose_maybe_open(span, indented, true)
247 pub fn bclose_maybe_open(&mut self,
248 span: syntax_pos::Span,
252 self.maybe_print_comment(span.hi())?;
253 self.break_offset_if_not_bol(1, -(indented as isize))?;
256 self.end()?; // close the outer-box
261 pub fn bclose(&mut self, span: syntax_pos::Span) -> io::Result<()> {
262 self.bclose_(span, indent_unit)
265 pub fn in_cbox(&self) -> bool {
266 match self.boxes.last() {
267 Some(&last_box) => last_box == pp::Breaks::Consistent,
272 pub fn space_if_not_bol(&mut self) -> io::Result<()> {
279 pub fn break_offset_if_not_bol(&mut self, n: usize, off: isize) -> io::Result<()> {
281 self.s.break_offset(n, off)
283 if off != 0 && self.s.last_token().is_hardbreak_tok() {
284 // We do something pretty sketchy here: tuck the nonzero
285 // offset-adjustment we were going to deposit along with the
286 // break into the previous hardbreak.
287 self.s.replace_last_token(pp::Printer::hardbreak_tok_offset(off));
293 // Synthesizes a comment that was not textually present in the original source
295 pub fn synth_comment(&mut self, text: String) -> io::Result<()> {
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::TyKind::Slice(ref ty) => {
365 self.print_type(&ty)?;
368 hir::TyKind::Ptr(ref mt) => {
371 hir::MutMutable => self.word_nbsp("mut")?,
372 hir::MutImmutable => self.word_nbsp("const")?,
374 self.print_type(&mt.ty)?;
376 hir::TyKind::Rptr(ref lifetime, ref mt) => {
378 self.print_opt_lifetime(lifetime)?;
381 hir::TyKind::Never => {
384 hir::TyKind::Tup(ref elts) => {
386 self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(&ty))?;
392 hir::TyKind::BareFn(ref f) => {
393 self.print_ty_fn(f.abi, f.unsafety, &f.decl, None, &f.generic_params,
396 hir::TyKind::Def(..) => {},
397 hir::TyKind::Path(ref qpath) => {
398 self.print_qpath(qpath, false)?
400 hir::TyKind::TraitObject(ref bounds, ref lifetime) => {
401 let mut first = true;
402 for bound in bounds {
407 self.word_space("+")?;
409 self.print_poly_trait_ref(bound)?;
411 if !lifetime.is_elided() {
413 self.word_space("+")?;
414 self.print_lifetime(lifetime)?;
417 hir::TyKind::Array(ref ty, ref length) => {
419 self.print_type(&ty)?;
421 self.print_anon_const(length)?;
424 hir::TyKind::Typeof(ref e) => {
425 self.s.word("typeof(")?;
426 self.print_anon_const(e)?;
429 hir::TyKind::Infer => {
432 hir::TyKind::Err => {
434 self.s.word("/*ERROR*/")?;
437 hir::TyKind::CVarArgs(_) => {
444 pub fn print_foreign_item(&mut self, item: &hir::ForeignItem) -> io::Result<()> {
445 self.hardbreak_if_not_bol()?;
446 self.maybe_print_comment(item.span.lo())?;
447 self.print_outer_attributes(&item.attrs)?;
449 hir::ForeignItemKind::Fn(ref decl, ref arg_names, ref generics) => {
453 unsafety: hir::Unsafety::Normal,
454 constness: hir::Constness::NotConst,
456 asyncness: hir::IsAsync::NotAsync,
458 Some(item.ident.name),
463 self.end()?; // end head-ibox
465 self.end() // end the outer fn box
467 hir::ForeignItemKind::Static(ref t, m) => {
468 self.head(visibility_qualified(&item.vis, "static"))?;
470 self.word_space("mut")?;
472 self.print_ident(item.ident)?;
473 self.word_space(":")?;
474 self.print_type(&t)?;
476 self.end()?; // end the head-ibox
477 self.end() // end the outer cbox
479 hir::ForeignItemKind::Type => {
480 self.head(visibility_qualified(&item.vis, "type"))?;
481 self.print_ident(item.ident)?;
483 self.end()?; // end the head-ibox
484 self.end() // end the outer cbox
489 fn print_associated_const(&mut self,
492 default: Option<hir::BodyId>,
493 vis: &hir::Visibility)
495 self.s.word(visibility_qualified(vis, ""))?;
496 self.word_space("const")?;
497 self.print_ident(ident)?;
498 self.word_space(":")?;
499 self.print_type(ty)?;
500 if let Some(expr) = default {
502 self.word_space("=")?;
503 self.ann.nested(self, Nested::Body(expr))?;
508 fn print_associated_type(&mut self,
510 bounds: Option<&hir::GenericBounds>,
511 ty: Option<&hir::Ty>)
513 self.word_space("type")?;
514 self.print_ident(ident)?;
515 if let Some(bounds) = bounds {
516 self.print_bounds(":", bounds)?;
518 if let Some(ty) = ty {
520 self.word_space("=")?;
521 self.print_type(ty)?;
526 /// Pretty-print an item
527 pub fn print_item(&mut self, item: &hir::Item) -> io::Result<()> {
528 self.hardbreak_if_not_bol()?;
529 self.maybe_print_comment(item.span.lo())?;
530 self.print_outer_attributes(&item.attrs)?;
531 self.ann.pre(self, AnnNode::Item(item))?;
533 hir::ItemKind::ExternCrate(orig_name) => {
534 self.head(visibility_qualified(&item.vis, "extern crate"))?;
535 if let Some(orig_name) = orig_name {
536 self.print_name(orig_name)?;
541 self.print_ident(item.ident)?;
543 self.end()?; // end inner head-block
544 self.end()?; // end outer head-block
546 hir::ItemKind::Use(ref path, kind) => {
547 self.head(visibility_qualified(&item.vis, "use"))?;
548 self.print_path(path, false)?;
551 hir::UseKind::Single => {
552 if path.segments.last().unwrap().ident != item.ident {
554 self.word_space("as")?;
555 self.print_ident(item.ident)?;
559 hir::UseKind::Glob => self.s.word("::*;")?,
560 hir::UseKind::ListStem => self.s.word("::{};")?
562 self.end()?; // end inner head-block
563 self.end()?; // end outer head-block
565 hir::ItemKind::Static(ref ty, m, expr) => {
566 self.head(visibility_qualified(&item.vis, "static"))?;
567 if m == hir::MutMutable {
568 self.word_space("mut")?;
570 self.print_ident(item.ident)?;
571 self.word_space(":")?;
572 self.print_type(&ty)?;
574 self.end()?; // end the head-ibox
576 self.word_space("=")?;
577 self.ann.nested(self, Nested::Body(expr))?;
579 self.end()?; // end the outer cbox
581 hir::ItemKind::Const(ref ty, expr) => {
582 self.head(visibility_qualified(&item.vis, "const"))?;
583 self.print_ident(item.ident)?;
584 self.word_space(":")?;
585 self.print_type(&ty)?;
587 self.end()?; // end the head-ibox
589 self.word_space("=")?;
590 self.ann.nested(self, Nested::Body(expr))?;
592 self.end()?; // end the outer cbox
594 hir::ItemKind::Fn(ref decl, header, ref param_names, body) => {
598 Some(item.ident.name),
604 self.end()?; // need to close a box
605 self.end()?; // need to close a box
606 self.ann.nested(self, Nested::Body(body))?;
608 hir::ItemKind::Mod(ref _mod) => {
609 self.head(visibility_qualified(&item.vis, "mod"))?;
610 self.print_ident(item.ident)?;
613 self.print_mod(_mod, &item.attrs)?;
614 self.bclose(item.span)?;
616 hir::ItemKind::ForeignMod(ref nmod) => {
617 self.head("extern")?;
618 self.word_nbsp(nmod.abi.to_string())?;
620 self.print_foreign_mod(nmod, &item.attrs)?;
621 self.bclose(item.span)?;
623 hir::ItemKind::GlobalAsm(ref ga) => {
624 self.head(visibility_qualified(&item.vis, "global asm"))?;
625 self.s.word(ga.asm.as_str().get())?;
628 hir::ItemKind::Ty(ref ty, ref generics) => {
629 self.head(visibility_qualified(&item.vis, "type"))?;
630 self.print_ident(item.ident)?;
631 self.print_generic_params(&generics.params)?;
632 self.end()?; // end the inner ibox
634 self.print_where_clause(&generics.where_clause)?;
636 self.word_space("=")?;
637 self.print_type(&ty)?;
639 self.end()?; // end the outer ibox
641 hir::ItemKind::Existential(ref exist) => {
642 self.head(visibility_qualified(&item.vis, "existential type"))?;
643 self.print_ident(item.ident)?;
644 self.print_generic_params(&exist.generics.params)?;
645 self.end()?; // end the inner ibox
647 self.print_where_clause(&exist.generics.where_clause)?;
649 self.word_space(":")?;
650 let mut real_bounds = Vec::with_capacity(exist.bounds.len());
651 for b in exist.bounds.iter() {
652 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
654 self.word_space("for ?")?;
655 self.print_trait_ref(&ptr.trait_ref)?;
657 real_bounds.push(b.clone());
660 self.print_bounds(":", &real_bounds[..])?;
662 self.end()?; // end the outer ibox
664 hir::ItemKind::Enum(ref enum_definition, ref params) => {
665 self.print_enum_def(enum_definition, params, item.ident.name, item.span,
668 hir::ItemKind::Struct(ref struct_def, ref generics) => {
669 self.head(visibility_qualified(&item.vis, "struct"))?;
670 self.print_struct(struct_def, generics, item.ident.name, item.span, true)?;
672 hir::ItemKind::Union(ref struct_def, ref generics) => {
673 self.head(visibility_qualified(&item.vis, "union"))?;
674 self.print_struct(struct_def, generics, item.ident.name, item.span, true)?;
676 hir::ItemKind::Impl(unsafety,
684 self.print_visibility(&item.vis)?;
685 self.print_defaultness(defaultness)?;
686 self.print_unsafety(unsafety)?;
687 self.word_nbsp("impl")?;
689 if !generics.params.is_empty() {
690 self.print_generic_params(&generics.params)?;
694 if let hir::ImplPolarity::Negative = polarity {
698 if let Some(ref t) = opt_trait {
699 self.print_trait_ref(t)?;
701 self.word_space("for")?;
704 self.print_type(&ty)?;
705 self.print_where_clause(&generics.where_clause)?;
709 self.print_inner_attributes(&item.attrs)?;
710 for impl_item in impl_items {
711 self.ann.nested(self, Nested::ImplItem(impl_item.id))?;
713 self.bclose(item.span)?;
715 hir::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref trait_items) => {
717 self.print_visibility(&item.vis)?;
718 self.print_is_auto(is_auto)?;
719 self.print_unsafety(unsafety)?;
720 self.word_nbsp("trait")?;
721 self.print_ident(item.ident)?;
722 self.print_generic_params(&generics.params)?;
723 let mut real_bounds = Vec::with_capacity(bounds.len());
724 for b in bounds.iter() {
725 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
727 self.word_space("for ?")?;
728 self.print_trait_ref(&ptr.trait_ref)?;
730 real_bounds.push(b.clone());
733 self.print_bounds(":", &real_bounds[..])?;
734 self.print_where_clause(&generics.where_clause)?;
737 for trait_item in trait_items {
738 self.ann.nested(self, Nested::TraitItem(trait_item.id))?;
740 self.bclose(item.span)?;
742 hir::ItemKind::TraitAlias(ref generics, ref bounds) => {
744 self.print_visibility(&item.vis)?;
745 self.word_nbsp("trait")?;
746 self.print_ident(item.ident)?;
747 self.print_generic_params(&generics.params)?;
748 let mut real_bounds = Vec::with_capacity(bounds.len());
749 // FIXME(durka) this seems to be some quite outdated syntax
750 for b in bounds.iter() {
751 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
753 self.word_space("for ?")?;
754 self.print_trait_ref(&ptr.trait_ref)?;
756 real_bounds.push(b.clone());
760 self.print_bounds("=", &real_bounds[..])?;
761 self.print_where_clause(&generics.where_clause)?;
765 self.ann.post(self, AnnNode::Item(item))
768 pub fn print_trait_ref(&mut self, t: &hir::TraitRef) -> io::Result<()> {
769 self.print_path(&t.path, false)
772 fn print_formal_generic_params(
774 generic_params: &[hir::GenericParam]
775 ) -> io::Result<()> {
776 if !generic_params.is_empty() {
778 self.print_generic_params(generic_params)?;
784 fn print_poly_trait_ref(&mut self, t: &hir::PolyTraitRef) -> io::Result<()> {
785 self.print_formal_generic_params(&t.bound_generic_params)?;
786 self.print_trait_ref(&t.trait_ref)
789 pub fn print_enum_def(&mut self,
790 enum_definition: &hir::EnumDef,
791 generics: &hir::Generics,
793 span: syntax_pos::Span,
794 visibility: &hir::Visibility)
796 self.head(visibility_qualified(visibility, "enum"))?;
797 self.print_name(name)?;
798 self.print_generic_params(&generics.params)?;
799 self.print_where_clause(&generics.where_clause)?;
801 self.print_variants(&enum_definition.variants, span)
804 pub fn print_variants(&mut self,
805 variants: &[hir::Variant],
806 span: syntax_pos::Span)
810 self.space_if_not_bol()?;
811 self.maybe_print_comment(v.span.lo())?;
812 self.print_outer_attributes(&v.node.attrs)?;
813 self.ibox(indent_unit)?;
814 self.print_variant(v)?;
817 self.maybe_print_trailing_comment(v.span, None)?;
822 pub fn print_visibility(&mut self, vis: &hir::Visibility) -> io::Result<()> {
824 hir::VisibilityKind::Public => self.word_nbsp("pub")?,
825 hir::VisibilityKind::Crate(ast::CrateSugar::JustCrate) => self.word_nbsp("crate")?,
826 hir::VisibilityKind::Crate(ast::CrateSugar::PubCrate) => self.word_nbsp("pub(crate)")?,
827 hir::VisibilityKind::Restricted { ref path, .. } => {
828 self.s.word("pub(")?;
829 if path.segments.len() == 1 &&
830 path.segments[0].ident.name == keywords::Super.name() {
831 // Special case: `super` can print like `pub(super)`.
832 self.s.word("super")?;
834 // Everything else requires `in` at present.
835 self.word_nbsp("in")?;
836 self.print_path(path, false)?;
838 self.word_nbsp(")")?;
840 hir::VisibilityKind::Inherited => ()
846 pub fn print_defaultness(&mut self, defaultness: hir::Defaultness) -> io::Result<()> {
848 hir::Defaultness::Default { .. } => self.word_nbsp("default")?,
849 hir::Defaultness::Final => (),
854 pub fn print_struct(&mut self,
855 struct_def: &hir::VariantData,
856 generics: &hir::Generics,
858 span: syntax_pos::Span,
859 print_finalizer: bool)
861 self.print_name(name)?;
862 self.print_generic_params(&generics.params)?;
864 hir::VariantData::Tuple(..) | hir::VariantData::Unit(..) => {
865 if let hir::VariantData::Tuple(..) = struct_def {
867 self.commasep(Inconsistent, struct_def.fields(), |s, field| {
868 s.maybe_print_comment(field.span.lo())?;
869 s.print_outer_attributes(&field.attrs)?;
870 s.print_visibility(&field.vis)?;
871 s.print_type(&field.ty)
875 self.print_where_clause(&generics.where_clause)?;
880 self.end() // close the outer-box
882 hir::VariantData::Struct(..) => {
883 self.print_where_clause(&generics.where_clause)?;
886 self.hardbreak_if_not_bol()?;
888 for field in struct_def.fields() {
889 self.hardbreak_if_not_bol()?;
890 self.maybe_print_comment(field.span.lo())?;
891 self.print_outer_attributes(&field.attrs)?;
892 self.print_visibility(&field.vis)?;
893 self.print_ident(field.ident)?;
894 self.word_nbsp(":")?;
895 self.print_type(&field.ty)?;
904 pub fn print_variant(&mut self, v: &hir::Variant) -> io::Result<()> {
906 let generics = hir::Generics::empty();
907 self.print_struct(&v.node.data, &generics, v.node.ident.name, v.span, false)?;
908 if let Some(ref d) = v.node.disr_expr {
910 self.word_space("=")?;
911 self.print_anon_const(d)?;
915 pub fn print_method_sig(&mut self,
918 generics: &hir::Generics,
919 vis: &hir::Visibility,
920 arg_names: &[ast::Ident],
921 body_id: Option<hir::BodyId>)
923 self.print_fn(&m.decl,
932 pub fn print_trait_item(&mut self, ti: &hir::TraitItem) -> io::Result<()> {
933 self.ann.pre(self, AnnNode::SubItem(ti.hir_id))?;
934 self.hardbreak_if_not_bol()?;
935 self.maybe_print_comment(ti.span.lo())?;
936 self.print_outer_attributes(&ti.attrs)?;
938 hir::TraitItemKind::Const(ref ty, default) => {
939 let vis = Spanned { span: syntax_pos::DUMMY_SP,
940 node: hir::VisibilityKind::Inherited };
941 self.print_associated_const(ti.ident, &ty, default, &vis)?;
943 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Required(ref arg_names)) => {
944 let vis = Spanned { span: syntax_pos::DUMMY_SP,
945 node: hir::VisibilityKind::Inherited };
946 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, arg_names, None)?;
949 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Provided(body)) => {
950 let vis = Spanned { span: syntax_pos::DUMMY_SP,
951 node: hir::VisibilityKind::Inherited };
953 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, &[], Some(body))?;
955 self.end()?; // need to close a box
956 self.end()?; // need to close a box
957 self.ann.nested(self, Nested::Body(body))?;
959 hir::TraitItemKind::Type(ref bounds, ref default) => {
960 self.print_associated_type(ti.ident,
962 default.as_ref().map(|ty| &**ty))?;
965 self.ann.post(self, AnnNode::SubItem(ti.hir_id))
968 pub fn print_impl_item(&mut self, ii: &hir::ImplItem) -> io::Result<()> {
969 self.ann.pre(self, AnnNode::SubItem(ii.hir_id))?;
970 self.hardbreak_if_not_bol()?;
971 self.maybe_print_comment(ii.span.lo())?;
972 self.print_outer_attributes(&ii.attrs)?;
973 self.print_defaultness(ii.defaultness)?;
976 hir::ImplItemKind::Const(ref ty, expr) => {
977 self.print_associated_const(ii.ident, &ty, Some(expr), &ii.vis)?;
979 hir::ImplItemKind::Method(ref sig, body) => {
981 self.print_method_sig(ii.ident, sig, &ii.generics, &ii.vis, &[], Some(body))?;
983 self.end()?; // need to close a box
984 self.end()?; // need to close a box
985 self.ann.nested(self, Nested::Body(body))?;
987 hir::ImplItemKind::Type(ref ty) => {
988 self.print_associated_type(ii.ident, None, Some(ty))?;
990 hir::ImplItemKind::Existential(ref bounds) => {
991 self.word_space("existential")?;
992 self.print_associated_type(ii.ident, Some(bounds), None)?;
995 self.ann.post(self, AnnNode::SubItem(ii.hir_id))
998 pub fn print_stmt(&mut self, st: &hir::Stmt) -> io::Result<()> {
999 self.maybe_print_comment(st.span.lo())?;
1001 hir::StmtKind::Local(ref loc) => {
1002 self.space_if_not_bol()?;
1003 self.ibox(indent_unit)?;
1004 self.word_nbsp("let")?;
1006 self.ibox(indent_unit)?;
1007 self.print_local_decl(&loc)?;
1009 if let Some(ref init) = loc.init {
1011 self.word_space("=")?;
1012 self.print_expr(&init)?;
1016 hir::StmtKind::Item(item) => {
1017 self.ann.nested(self, Nested::Item(item))?
1019 hir::StmtKind::Expr(ref expr) => {
1020 self.space_if_not_bol()?;
1021 self.print_expr(&expr)?;
1023 hir::StmtKind::Semi(ref expr) => {
1024 self.space_if_not_bol()?;
1025 self.print_expr(&expr)?;
1029 if stmt_ends_with_semi(&st.node) {
1032 self.maybe_print_trailing_comment(st.span, None)
1035 pub fn print_block(&mut self, blk: &hir::Block) -> io::Result<()> {
1036 self.print_block_with_attrs(blk, &[])
1039 pub fn print_block_unclosed(&mut self, blk: &hir::Block) -> io::Result<()> {
1040 self.print_block_unclosed_indent(blk, indent_unit)
1043 pub fn print_block_unclosed_indent(&mut self,
1047 self.print_block_maybe_unclosed(blk, indented, &[], false)
1050 pub fn print_block_with_attrs(&mut self,
1052 attrs: &[ast::Attribute])
1054 self.print_block_maybe_unclosed(blk, indent_unit, attrs, true)
1057 pub fn print_block_maybe_unclosed(&mut self,
1060 attrs: &[ast::Attribute],
1064 hir::UnsafeBlock(..) => self.word_space("unsafe")?,
1065 hir::PushUnsafeBlock(..) => self.word_space("push_unsafe")?,
1066 hir::PopUnsafeBlock(..) => self.word_space("pop_unsafe")?,
1067 hir::DefaultBlock => (),
1069 self.maybe_print_comment(blk.span.lo())?;
1070 self.ann.pre(self, AnnNode::Block(blk))?;
1073 self.print_inner_attributes(attrs)?;
1075 for st in &blk.stmts {
1076 self.print_stmt(st)?;
1078 if let Some(ref expr) = blk.expr {
1079 self.space_if_not_bol()?;
1080 self.print_expr(&expr)?;
1081 self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi()))?;
1083 self.bclose_maybe_open(blk.span, indented, close_box)?;
1084 self.ann.post(self, AnnNode::Block(blk))
1087 fn print_else(&mut self, els: Option<&hir::Expr>) -> io::Result<()> {
1091 // "another else-if"
1092 hir::ExprKind::If(ref i, ref then, ref e) => {
1093 self.cbox(indent_unit - 1)?;
1095 self.s.word(" else if ")?;
1096 self.print_expr_as_cond(&i)?;
1098 self.print_expr(&then)?;
1099 self.print_else(e.as_ref().map(|e| &**e))
1102 hir::ExprKind::Block(ref b, _) => {
1103 self.cbox(indent_unit - 1)?;
1105 self.s.word(" else ")?;
1106 self.print_block(&b)
1108 // BLEAH, constraints would be great here
1110 panic!("print_if saw if with weird alternative");
1118 pub fn print_if(&mut self,
1121 elseopt: Option<&hir::Expr>)
1124 self.print_expr_as_cond(test)?;
1126 self.print_expr(blk)?;
1127 self.print_else(elseopt)
1130 pub fn print_if_let(&mut self,
1134 elseopt: Option<&hir::Expr>)
1136 self.head("if let")?;
1137 self.print_pat(pat)?;
1139 self.word_space("=")?;
1140 self.print_expr_as_cond(expr)?;
1142 self.print_block(blk)?;
1143 self.print_else(elseopt)
1146 pub fn print_anon_const(&mut self, constant: &hir::AnonConst) -> io::Result<()> {
1147 self.ann.nested(self, Nested::Body(constant.body))
1150 fn print_call_post(&mut self, args: &[hir::Expr]) -> io::Result<()> {
1152 self.commasep_exprs(Inconsistent, args)?;
1156 pub fn print_expr_maybe_paren(&mut self, expr: &hir::Expr, prec: i8) -> io::Result<()> {
1157 let needs_par = expr.precedence().order() < prec;
1161 self.print_expr(expr)?;
1168 /// Print an expr using syntax that's acceptable in a condition position, such as the `cond` in
1169 /// `if cond { ... }`.
1170 pub fn print_expr_as_cond(&mut self, expr: &hir::Expr) -> io::Result<()> {
1171 let needs_par = match expr.node {
1172 // These cases need parens due to the parse error observed in #26461: `if return {}`
1173 // parses as the erroneous construct `if (return {})`, not `if (return) {}`.
1174 hir::ExprKind::Closure(..) |
1175 hir::ExprKind::Ret(..) |
1176 hir::ExprKind::Break(..) => true,
1178 _ => contains_exterior_struct_lit(expr),
1184 self.print_expr(expr)?;
1191 fn print_expr_vec(&mut self, exprs: &[hir::Expr]) -> io::Result<()> {
1192 self.ibox(indent_unit)?;
1194 self.commasep_exprs(Inconsistent, exprs)?;
1199 fn print_expr_repeat(&mut self, element: &hir::Expr, count: &hir::AnonConst) -> io::Result<()> {
1200 self.ibox(indent_unit)?;
1202 self.print_expr(element)?;
1203 self.word_space(";")?;
1204 self.print_anon_const(count)?;
1209 fn print_expr_struct(&mut self,
1211 fields: &[hir::Field],
1212 wth: &Option<P<hir::Expr>>)
1214 self.print_qpath(qpath, true)?;
1216 self.commasep_cmnt(Consistent,
1219 s.ibox(indent_unit)?;
1220 if !field.is_shorthand {
1221 s.print_ident(field.ident)?;
1224 s.print_expr(&field.expr)?;
1230 self.ibox(indent_unit)?;
1231 if !fields.is_empty() {
1236 self.print_expr(&expr)?;
1239 _ => if !fields.is_empty() {
1247 fn print_expr_tup(&mut self, exprs: &[hir::Expr]) -> io::Result<()> {
1249 self.commasep_exprs(Inconsistent, exprs)?;
1250 if exprs.len() == 1 {
1256 fn print_expr_call(&mut self, func: &hir::Expr, args: &[hir::Expr]) -> io::Result<()> {
1259 hir::ExprKind::Field(..) => parser::PREC_FORCE_PAREN,
1260 _ => parser::PREC_POSTFIX,
1263 self.print_expr_maybe_paren(func, prec)?;
1264 self.print_call_post(args)
1267 fn print_expr_method_call(&mut self,
1268 segment: &hir::PathSegment,
1271 let base_args = &args[1..];
1272 self.print_expr_maybe_paren(&args[0], parser::PREC_POSTFIX)?;
1274 self.print_ident(segment.ident)?;
1276 segment.with_generic_args(|generic_args| {
1277 if !generic_args.args.is_empty() || !generic_args.bindings.is_empty() {
1278 return self.print_generic_args(&generic_args, segment.infer_types, true);
1282 self.print_call_post(base_args)
1285 fn print_expr_binary(&mut self,
1290 let assoc_op = bin_op_to_assoc_op(op.node);
1291 let prec = assoc_op.precedence() as i8;
1292 let fixity = assoc_op.fixity();
1294 let (left_prec, right_prec) = match fixity {
1295 Fixity::Left => (prec, prec + 1),
1296 Fixity::Right => (prec + 1, prec),
1297 Fixity::None => (prec + 1, prec + 1),
1300 let left_prec = match (&lhs.node, op.node) {
1301 // These cases need parens: `x as i32 < y` has the parser thinking that `i32 < y` is
1302 // the beginning of a path type. It starts trying to parse `x as (i32 < y ...` instead
1303 // of `(x as i32) < ...`. We need to convince it _not_ to do that.
1304 (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Lt) |
1305 (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Shl) => parser::PREC_FORCE_PAREN,
1309 self.print_expr_maybe_paren(lhs, left_prec)?;
1311 self.word_space(op.node.as_str())?;
1312 self.print_expr_maybe_paren(rhs, right_prec)
1315 fn print_expr_unary(&mut self, op: hir::UnOp, expr: &hir::Expr) -> io::Result<()> {
1316 self.s.word(op.as_str())?;
1317 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1320 fn print_expr_addr_of(&mut self,
1321 mutability: hir::Mutability,
1325 self.print_mutability(mutability)?;
1326 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1329 pub fn print_expr(&mut self, expr: &hir::Expr) -> io::Result<()> {
1330 self.maybe_print_comment(expr.span.lo())?;
1331 self.print_outer_attributes(&expr.attrs)?;
1332 self.ibox(indent_unit)?;
1333 self.ann.pre(self, AnnNode::Expr(expr))?;
1335 hir::ExprKind::Box(ref expr) => {
1336 self.word_space("box")?;
1337 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)?;
1339 hir::ExprKind::Array(ref exprs) => {
1340 self.print_expr_vec(exprs)?;
1342 hir::ExprKind::Repeat(ref element, ref count) => {
1343 self.print_expr_repeat(&element, count)?;
1345 hir::ExprKind::Struct(ref qpath, ref fields, ref wth) => {
1346 self.print_expr_struct(qpath, &fields[..], wth)?;
1348 hir::ExprKind::Tup(ref exprs) => {
1349 self.print_expr_tup(exprs)?;
1351 hir::ExprKind::Call(ref func, ref args) => {
1352 self.print_expr_call(&func, args)?;
1354 hir::ExprKind::MethodCall(ref segment, _, ref args) => {
1355 self.print_expr_method_call(segment, args)?;
1357 hir::ExprKind::Binary(op, ref lhs, ref rhs) => {
1358 self.print_expr_binary(op, &lhs, &rhs)?;
1360 hir::ExprKind::Unary(op, ref expr) => {
1361 self.print_expr_unary(op, &expr)?;
1363 hir::ExprKind::AddrOf(m, ref expr) => {
1364 self.print_expr_addr_of(m, &expr)?;
1366 hir::ExprKind::Lit(ref lit) => {
1367 self.print_literal(&lit)?;
1369 hir::ExprKind::Cast(ref expr, ref ty) => {
1370 let prec = AssocOp::As.precedence() as i8;
1371 self.print_expr_maybe_paren(&expr, prec)?;
1373 self.word_space("as")?;
1374 self.print_type(&ty)?;
1376 hir::ExprKind::Type(ref expr, ref ty) => {
1377 let prec = AssocOp::Colon.precedence() as i8;
1378 self.print_expr_maybe_paren(&expr, prec)?;
1379 self.word_space(":")?;
1380 self.print_type(&ty)?;
1382 hir::ExprKind::If(ref test, ref blk, ref elseopt) => {
1383 self.print_if(&test, &blk, elseopt.as_ref().map(|e| &**e))?;
1385 hir::ExprKind::While(ref test, ref blk, opt_label) => {
1386 if let Some(label) = opt_label {
1387 self.print_ident(label.ident)?;
1388 self.word_space(":")?;
1390 self.head("while")?;
1391 self.print_expr_as_cond(&test)?;
1393 self.print_block(&blk)?;
1395 hir::ExprKind::Loop(ref blk, opt_label, _) => {
1396 if let Some(label) = opt_label {
1397 self.print_ident(label.ident)?;
1398 self.word_space(":")?;
1402 self.print_block(&blk)?;
1404 hir::ExprKind::Match(ref expr, ref arms, _) => {
1405 self.cbox(indent_unit)?;
1407 self.word_nbsp("match")?;
1408 self.print_expr_as_cond(&expr)?;
1412 self.print_arm(arm)?;
1414 self.bclose_(expr.span, indent_unit)?;
1416 hir::ExprKind::Closure(capture_clause, ref decl, body, _fn_decl_span, _gen) => {
1417 self.print_capture_clause(capture_clause)?;
1419 self.print_closure_args(&decl, body)?;
1422 // this is a bare expression
1423 self.ann.nested(self, Nested::Body(body))?;
1424 self.end()?; // need to close a box
1426 // a box will be closed by print_expr, but we didn't want an overall
1427 // wrapper so we closed the corresponding opening. so create an
1428 // empty box to satisfy the close.
1431 hir::ExprKind::Block(ref blk, opt_label) => {
1432 if let Some(label) = opt_label {
1433 self.print_ident(label.ident)?;
1434 self.word_space(":")?;
1436 // containing cbox, will be closed by print-block at }
1437 self.cbox(indent_unit)?;
1438 // head-box, will be closed by print-block after {
1440 self.print_block(&blk)?;
1442 hir::ExprKind::Assign(ref lhs, ref rhs) => {
1443 let prec = AssocOp::Assign.precedence() as i8;
1444 self.print_expr_maybe_paren(&lhs, prec + 1)?;
1446 self.word_space("=")?;
1447 self.print_expr_maybe_paren(&rhs, prec)?;
1449 hir::ExprKind::AssignOp(op, ref lhs, ref rhs) => {
1450 let prec = AssocOp::Assign.precedence() as i8;
1451 self.print_expr_maybe_paren(&lhs, prec + 1)?;
1453 self.s.word(op.node.as_str())?;
1454 self.word_space("=")?;
1455 self.print_expr_maybe_paren(&rhs, prec)?;
1457 hir::ExprKind::Field(ref expr, ident) => {
1458 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX)?;
1460 self.print_ident(ident)?;
1462 hir::ExprKind::Index(ref expr, ref index) => {
1463 self.print_expr_maybe_paren(&expr, parser::PREC_POSTFIX)?;
1465 self.print_expr(&index)?;
1468 hir::ExprKind::Path(ref qpath) => {
1469 self.print_qpath(qpath, true)?
1471 hir::ExprKind::Break(destination, ref opt_expr) => {
1472 self.s.word("break")?;
1474 if let Some(label) = destination.label {
1475 self.print_ident(label.ident)?;
1478 if let Some(ref expr) = *opt_expr {
1479 self.print_expr_maybe_paren(expr, parser::PREC_JUMP)?;
1483 hir::ExprKind::Continue(destination) => {
1484 self.s.word("continue")?;
1486 if let Some(label) = destination.label {
1487 self.print_ident(label.ident)?;
1491 hir::ExprKind::Ret(ref result) => {
1492 self.s.word("return")?;
1493 if let Some(ref expr) = *result {
1495 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP)?;
1498 hir::ExprKind::InlineAsm(ref a, ref outputs, ref inputs) => {
1499 self.s.word("asm!")?;
1501 self.print_string(&a.asm.as_str(), a.asm_str_style)?;
1502 self.word_space(":")?;
1504 let mut out_idx = 0;
1505 self.commasep(Inconsistent, &a.outputs, |s, out| {
1506 let constraint = out.constraint.as_str();
1507 let mut ch = constraint.chars();
1509 Some('=') if out.is_rw => {
1510 s.print_string(&format!("+{}", ch.as_str()),
1511 ast::StrStyle::Cooked)?
1513 _ => s.print_string(&constraint, ast::StrStyle::Cooked)?,
1516 s.print_expr(&outputs[out_idx])?;
1522 self.word_space(":")?;
1525 self.commasep(Inconsistent, &a.inputs, |s, co| {
1526 s.print_string(&co.as_str(), ast::StrStyle::Cooked)?;
1528 s.print_expr(&inputs[in_idx])?;
1534 self.word_space(":")?;
1536 self.commasep(Inconsistent, &a.clobbers, |s, co| {
1537 s.print_string(&co.as_str(), ast::StrStyle::Cooked)?;
1541 let mut options = vec![];
1543 options.push("volatile");
1546 options.push("alignstack");
1548 if a.dialect == ast::AsmDialect::Intel {
1549 options.push("intel");
1552 if !options.is_empty() {
1554 self.word_space(":")?;
1555 self.commasep(Inconsistent, &options, |s, &co| {
1556 s.print_string(co, ast::StrStyle::Cooked)?;
1563 hir::ExprKind::Yield(ref expr) => {
1564 self.word_space("yield")?;
1565 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP)?;
1567 hir::ExprKind::Err => {
1569 self.s.word("/*ERROR*/")?;
1573 self.ann.post(self, AnnNode::Expr(expr))?;
1577 pub fn print_local_decl(&mut self, loc: &hir::Local) -> io::Result<()> {
1578 self.print_pat(&loc.pat)?;
1579 if let Some(ref ty) = loc.ty {
1580 self.word_space(":")?;
1581 self.print_type(&ty)?;
1586 pub fn print_usize(&mut self, i: usize) -> io::Result<()> {
1587 self.s.word(i.to_string())
1590 pub fn print_ident(&mut self, ident: ast::Ident) -> io::Result<()> {
1591 if ident.is_raw_guess() {
1592 self.s.word(format!("r#{}", ident.name))?;
1594 self.s.word(ident.as_str().get())?;
1596 self.ann.post(self, AnnNode::Name(&ident.name))
1599 pub fn print_name(&mut self, name: ast::Name) -> io::Result<()> {
1600 self.print_ident(ast::Ident::with_empty_ctxt(name))
1603 pub fn print_for_decl(&mut self, loc: &hir::Local, coll: &hir::Expr) -> io::Result<()> {
1604 self.print_local_decl(loc)?;
1606 self.word_space("in")?;
1607 self.print_expr(coll)
1610 pub fn print_path(&mut self,
1612 colons_before_params: bool)
1614 self.maybe_print_comment(path.span.lo())?;
1616 for (i, segment) in path.segments.iter().enumerate() {
1620 if segment.ident.name != keywords::PathRoot.name() {
1621 self.print_ident(segment.ident)?;
1622 segment.with_generic_args(|generic_args| {
1623 self.print_generic_args(generic_args, segment.infer_types,
1624 colons_before_params)
1632 pub fn print_path_segment(&mut self, segment: &hir::PathSegment) -> io::Result<()> {
1633 if segment.ident.name != keywords::PathRoot.name() {
1634 self.print_ident(segment.ident)?;
1635 segment.with_generic_args(|generic_args| {
1636 self.print_generic_args(generic_args, segment.infer_types, false)
1642 pub fn print_qpath(&mut self,
1644 colons_before_params: bool)
1647 hir::QPath::Resolved(None, ref path) => {
1648 self.print_path(path, colons_before_params)
1650 hir::QPath::Resolved(Some(ref qself), ref path) => {
1652 self.print_type(qself)?;
1654 self.word_space("as")?;
1656 for (i, segment) in path.segments[..path.segments.len() - 1].iter().enumerate() {
1660 if segment.ident.name != keywords::PathRoot.name() {
1661 self.print_ident(segment.ident)?;
1662 segment.with_generic_args(|generic_args| {
1663 self.print_generic_args(generic_args,
1664 segment.infer_types,
1665 colons_before_params)
1672 let item_segment = path.segments.last().unwrap();
1673 self.print_ident(item_segment.ident)?;
1674 item_segment.with_generic_args(|generic_args| {
1675 self.print_generic_args(generic_args,
1676 item_segment.infer_types,
1677 colons_before_params)
1680 hir::QPath::TypeRelative(ref qself, ref item_segment) => {
1682 self.print_type(qself)?;
1685 self.print_ident(item_segment.ident)?;
1686 item_segment.with_generic_args(|generic_args| {
1687 self.print_generic_args(generic_args,
1688 item_segment.infer_types,
1689 colons_before_params)
1695 fn print_generic_args(&mut self,
1696 generic_args: &hir::GenericArgs,
1698 colons_before_params: bool)
1700 if generic_args.parenthesized {
1702 self.commasep(Inconsistent, generic_args.inputs(), |s, ty| s.print_type(&ty))?;
1705 self.space_if_not_bol()?;
1706 self.word_space("->")?;
1707 self.print_type(&generic_args.bindings[0].ty)?;
1709 let start = if colons_before_params { "::<" } else { "<" };
1710 let empty = Cell::new(true);
1711 let start_or_comma = |this: &mut Self| {
1716 this.word_space(",")
1720 let mut nonelided_generic_args: bool = false;
1721 let elide_lifetimes = generic_args.args.iter().all(|arg| match arg {
1722 GenericArg::Lifetime(lt) => lt.is_elided(),
1724 nonelided_generic_args = true;
1729 if nonelided_generic_args {
1730 start_or_comma(self)?;
1731 self.commasep(Inconsistent, &generic_args.args, |s, generic_arg| {
1733 GenericArg::Lifetime(lt) if !elide_lifetimes => s.print_lifetime(lt),
1734 GenericArg::Lifetime(_) => Ok(()),
1735 GenericArg::Type(ty) => s.print_type(ty),
1736 GenericArg::Const(ct) => s.print_anon_const(&ct.value),
1741 // FIXME(eddyb) This would leak into error messages, e.g.:
1742 // "non-exhaustive patterns: `Some::<..>(_)` not covered".
1743 if infer_types && false {
1744 start_or_comma(self)?;
1748 for binding in generic_args.bindings.iter() {
1749 start_or_comma(self)?;
1750 self.print_ident(binding.ident)?;
1752 self.word_space("=")?;
1753 self.print_type(&binding.ty)?;
1764 pub fn print_pat(&mut self, pat: &hir::Pat) -> io::Result<()> {
1765 self.maybe_print_comment(pat.span.lo())?;
1766 self.ann.pre(self, AnnNode::Pat(pat))?;
1767 // Pat isn't normalized, but the beauty of it
1768 // is that it doesn't matter
1770 PatKind::Wild => self.s.word("_")?,
1771 PatKind::Binding(binding_mode, _, ident, ref sub) => {
1772 match binding_mode {
1773 hir::BindingAnnotation::Ref => {
1774 self.word_nbsp("ref")?;
1775 self.print_mutability(hir::MutImmutable)?;
1777 hir::BindingAnnotation::RefMut => {
1778 self.word_nbsp("ref")?;
1779 self.print_mutability(hir::MutMutable)?;
1781 hir::BindingAnnotation::Unannotated => {}
1782 hir::BindingAnnotation::Mutable => {
1783 self.word_nbsp("mut")?;
1786 self.print_ident(ident)?;
1787 if let Some(ref p) = *sub {
1789 self.print_pat(&p)?;
1792 PatKind::TupleStruct(ref qpath, ref elts, ddpos) => {
1793 self.print_qpath(qpath, true)?;
1795 if let Some(ddpos) = ddpos {
1796 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p))?;
1798 self.word_space(",")?;
1801 if ddpos != elts.len() {
1803 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p))?;
1806 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))?;
1810 PatKind::Path(ref qpath) => {
1811 self.print_qpath(qpath, true)?;
1813 PatKind::Struct(ref qpath, ref fields, etc) => {
1814 self.print_qpath(qpath, true)?;
1816 self.word_space("{")?;
1817 self.commasep_cmnt(Consistent,
1820 s.cbox(indent_unit)?;
1821 if !f.node.is_shorthand {
1822 s.print_ident(f.node.ident)?;
1825 s.print_pat(&f.node.pat)?;
1828 |f| f.node.pat.span)?;
1830 if !fields.is_empty() {
1831 self.word_space(",")?;
1838 PatKind::Tuple(ref elts, ddpos) => {
1840 if let Some(ddpos) = ddpos {
1841 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p))?;
1843 self.word_space(",")?;
1846 if ddpos != elts.len() {
1848 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p))?;
1851 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p))?;
1852 if elts.len() == 1 {
1858 PatKind::Box(ref inner) => {
1859 let is_range_inner = match inner.node {
1860 PatKind::Range(..) => true,
1863 self.s.word("box ")?;
1867 self.print_pat(&inner)?;
1872 PatKind::Ref(ref inner, mutbl) => {
1873 let is_range_inner = match inner.node {
1874 PatKind::Range(..) => true,
1878 if mutbl == hir::MutMutable {
1879 self.s.word("mut ")?;
1884 self.print_pat(&inner)?;
1889 PatKind::Lit(ref e) => self.print_expr(&e)?,
1890 PatKind::Range(ref begin, ref end, ref end_kind) => {
1891 self.print_expr(&begin)?;
1894 RangeEnd::Included => self.s.word("...")?,
1895 RangeEnd::Excluded => self.s.word("..")?,
1897 self.print_expr(&end)?;
1899 PatKind::Slice(ref before, ref slice, ref after) => {
1901 self.commasep(Inconsistent, &before[..], |s, p| s.print_pat(&p))?;
1902 if let Some(ref p) = *slice {
1903 if !before.is_empty() {
1904 self.word_space(",")?;
1906 if let PatKind::Wild = p.node {
1909 self.print_pat(&p)?;
1912 if !after.is_empty() {
1913 self.word_space(",")?;
1916 self.commasep(Inconsistent, &after[..], |s, p| s.print_pat(&p))?;
1920 self.ann.post(self, AnnNode::Pat(pat))
1923 fn print_arm(&mut self, arm: &hir::Arm) -> io::Result<()> {
1924 // I have no idea why this check is necessary, but here it
1926 if arm.attrs.is_empty() {
1929 self.cbox(indent_unit)?;
1931 self.print_outer_attributes(&arm.attrs)?;
1932 let mut first = true;
1933 for p in &arm.pats {
1938 self.word_space("|")?;
1940 self.print_pat(&p)?;
1943 if let Some(ref g) = arm.guard {
1945 hir::Guard::If(e) => {
1946 self.word_space("if")?;
1947 self.print_expr(&e)?;
1952 self.word_space("=>")?;
1954 match arm.body.node {
1955 hir::ExprKind::Block(ref blk, opt_label) => {
1956 if let Some(label) = opt_label {
1957 self.print_ident(label.ident)?;
1958 self.word_space(":")?;
1960 // the block will close the pattern's ibox
1961 self.print_block_unclosed_indent(&blk, indent_unit)?;
1963 // If it is a user-provided unsafe block, print a comma after it
1964 if let hir::UnsafeBlock(hir::UserProvided) = blk.rules {
1969 self.end()?; // close the ibox for the pattern
1970 self.print_expr(&arm.body)?;
1974 self.end() // close enclosing cbox
1977 pub fn print_fn(&mut self,
1979 header: hir::FnHeader,
1980 name: Option<ast::Name>,
1981 generics: &hir::Generics,
1982 vis: &hir::Visibility,
1983 arg_names: &[ast::Ident],
1984 body_id: Option<hir::BodyId>)
1986 self.print_fn_header_info(header, vis)?;
1988 if let Some(name) = name {
1990 self.print_name(name)?;
1992 self.print_generic_params(&generics.params)?;
1996 // Make sure we aren't supplied *both* `arg_names` and `body_id`.
1997 assert!(arg_names.is_empty() || body_id.is_none());
1998 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
1999 s.ibox(indent_unit)?;
2000 if let Some(arg_name) = arg_names.get(i) {
2001 s.s.word(arg_name.as_str().get())?;
2004 } else if let Some(body_id) = body_id {
2005 s.ann.nested(s, Nested::BodyArgPat(body_id, i))?;
2013 if decl.c_variadic {
2014 self.s.word(", ...")?;
2018 self.print_fn_output(decl)?;
2019 self.print_where_clause(&generics.where_clause)
2022 fn print_closure_args(&mut self, decl: &hir::FnDecl, body_id: hir::BodyId) -> io::Result<()> {
2025 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
2026 s.ibox(indent_unit)?;
2028 s.ann.nested(s, Nested::BodyArgPat(body_id, i))?;
2031 if let hir::TyKind::Infer = ty.node {
2042 if let hir::DefaultReturn(..) = decl.output {
2046 self.space_if_not_bol()?;
2047 self.word_space("->")?;
2049 hir::Return(ref ty) => {
2050 self.print_type(&ty)?;
2051 self.maybe_print_comment(ty.span.lo())
2053 hir::DefaultReturn(..) => unreachable!(),
2057 pub fn print_capture_clause(&mut self, capture_clause: hir::CaptureClause) -> io::Result<()> {
2058 match capture_clause {
2059 hir::CaptureByValue => self.word_space("move"),
2060 hir::CaptureByRef => Ok(()),
2064 pub fn print_bounds(&mut self, prefix: &'static str, bounds: &[hir::GenericBound])
2066 if !bounds.is_empty() {
2067 self.s.word(prefix)?;
2068 let mut first = true;
2069 for bound in bounds {
2070 if !(first && prefix.is_empty()) {
2076 self.word_space("+")?;
2080 GenericBound::Trait(tref, modifier) => {
2081 if modifier == &TraitBoundModifier::Maybe {
2084 self.print_poly_trait_ref(tref)?;
2086 GenericBound::Outlives(lt) => {
2087 self.print_lifetime(lt)?;
2095 pub fn print_generic_params(&mut self, generic_params: &[GenericParam]) -> io::Result<()> {
2096 if !generic_params.is_empty() {
2099 self.commasep(Inconsistent, generic_params, |s, param| {
2100 s.print_generic_param(param)
2108 pub fn print_generic_param(&mut self, param: &GenericParam) -> io::Result<()> {
2109 if let GenericParamKind::Const { .. } = param.kind {
2110 self.word_space("const")?;
2113 self.print_ident(param.name.ident())?;
2116 GenericParamKind::Lifetime { .. } => {
2118 for bound in ¶m.bounds {
2120 GenericBound::Outlives(lt) => {
2122 self.print_lifetime(lt)?;
2130 GenericParamKind::Type { ref default, .. } => {
2131 self.print_bounds(":", ¶m.bounds)?;
2135 self.word_space("=")?;
2136 self.print_type(&default)
2141 GenericParamKind::Const { ref ty } => {
2142 self.word_space(":")?;
2148 pub fn print_lifetime(&mut self, lifetime: &hir::Lifetime) -> io::Result<()> {
2149 self.print_ident(lifetime.name.ident())
2152 pub fn print_where_clause(&mut self, where_clause: &hir::WhereClause) -> io::Result<()> {
2153 if where_clause.predicates.is_empty() {
2158 self.word_space("where")?;
2160 for (i, predicate) in where_clause.predicates.iter().enumerate() {
2162 self.word_space(",")?;
2166 &hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
2167 ref bound_generic_params,
2172 self.print_formal_generic_params(bound_generic_params)?;
2173 self.print_type(&bounded_ty)?;
2174 self.print_bounds(":", bounds)?;
2176 &hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate{ref lifetime,
2179 self.print_lifetime(lifetime)?;
2182 for (i, bound) in bounds.iter().enumerate() {
2184 GenericBound::Outlives(lt) => {
2185 self.print_lifetime(lt)?;
2195 &hir::WherePredicate::EqPredicate(hir::WhereEqPredicate{ref lhs_ty,
2198 self.print_type(lhs_ty)?;
2200 self.word_space("=")?;
2201 self.print_type(rhs_ty)?;
2209 pub fn print_mutability(&mut self, mutbl: hir::Mutability) -> io::Result<()> {
2211 hir::MutMutable => self.word_nbsp("mut"),
2212 hir::MutImmutable => Ok(()),
2216 pub fn print_mt(&mut self, mt: &hir::MutTy) -> io::Result<()> {
2217 self.print_mutability(mt.mutbl)?;
2218 self.print_type(&mt.ty)
2221 pub fn print_fn_output(&mut self, decl: &hir::FnDecl) -> io::Result<()> {
2222 if let hir::DefaultReturn(..) = decl.output {
2226 self.space_if_not_bol()?;
2227 self.ibox(indent_unit)?;
2228 self.word_space("->")?;
2230 hir::DefaultReturn(..) => unreachable!(),
2231 hir::Return(ref ty) => self.print_type(&ty)?,
2236 hir::Return(ref output) => self.maybe_print_comment(output.span.lo()),
2241 pub fn print_ty_fn(&mut self,
2243 unsafety: hir::Unsafety,
2245 name: Option<ast::Name>,
2246 generic_params: &[hir::GenericParam],
2247 arg_names: &[ast::Ident])
2249 self.ibox(indent_unit)?;
2250 if !generic_params.is_empty() {
2251 self.s.word("for")?;
2252 self.print_generic_params(generic_params)?;
2254 let generics = hir::Generics {
2255 params: hir::HirVec::new(),
2256 where_clause: hir::WhereClause {
2257 hir_id: hir::DUMMY_HIR_ID,
2258 predicates: hir::HirVec::new(),
2260 span: syntax_pos::DUMMY_SP,
2266 constness: hir::Constness::NotConst,
2267 asyncness: hir::IsAsync::NotAsync,
2271 &Spanned { span: syntax_pos::DUMMY_SP,
2272 node: hir::VisibilityKind::Inherited },
2278 pub fn maybe_print_trailing_comment(&mut self,
2279 span: syntax_pos::Span,
2280 next_pos: Option<BytePos>)
2282 let cm = match self.cm {
2286 if let Some(ref cmnt) = self.next_comment() {
2287 if (*cmnt).style != comments::Trailing {
2290 let span_line = cm.lookup_char_pos(span.hi());
2291 let comment_line = cm.lookup_char_pos((*cmnt).pos);
2292 let mut next = (*cmnt).pos + BytePos(1);
2293 if let Some(p) = next_pos {
2296 if span.hi() < (*cmnt).pos && (*cmnt).pos < next &&
2297 span_line.line == comment_line.line {
2298 self.print_comment(cmnt)?;
2304 pub fn print_remaining_comments(&mut self) -> io::Result<()> {
2305 // If there aren't any remaining comments, then we need to manually
2306 // make sure there is a line break at the end.
2307 if self.next_comment().is_none() {
2308 self.s.hardbreak()?;
2310 while let Some(ref cmnt) = self.next_comment() {
2311 self.print_comment(cmnt)?
2316 pub fn print_opt_abi_and_extern_if_nondefault(&mut self,
2317 opt_abi: Option<Abi>)
2320 Some(Abi::Rust) => Ok(()),
2322 self.word_nbsp("extern")?;
2323 self.word_nbsp(abi.to_string())
2329 pub fn print_extern_opt_abi(&mut self, opt_abi: Option<Abi>) -> io::Result<()> {
2332 self.word_nbsp("extern")?;
2333 self.word_nbsp(abi.to_string())
2339 pub fn print_fn_header_info(&mut self,
2340 header: hir::FnHeader,
2341 vis: &hir::Visibility)
2343 self.s.word(visibility_qualified(vis, ""))?;
2345 match header.constness {
2346 hir::Constness::NotConst => {}
2347 hir::Constness::Const => self.word_nbsp("const")?,
2350 match header.asyncness {
2351 hir::IsAsync::NotAsync => {}
2352 hir::IsAsync::Async => self.word_nbsp("async")?,
2355 self.print_unsafety(header.unsafety)?;
2357 if header.abi != Abi::Rust {
2358 self.word_nbsp("extern")?;
2359 self.word_nbsp(header.abi.to_string())?;
2365 pub fn print_unsafety(&mut self, s: hir::Unsafety) -> io::Result<()> {
2367 hir::Unsafety::Normal => Ok(()),
2368 hir::Unsafety::Unsafe => self.word_nbsp("unsafe"),
2372 pub fn print_is_auto(&mut self, s: hir::IsAuto) -> io::Result<()> {
2374 hir::IsAuto::Yes => self.word_nbsp("auto"),
2375 hir::IsAuto::No => Ok(()),
2380 // Dup'ed from parse::classify, but adapted for the HIR.
2381 /// Does this expression require a semicolon to be treated
2382 /// as a statement? The negation of this: 'can this expression
2383 /// be used as a statement without a semicolon' -- is used
2384 /// as an early-bail-out in the parser so that, for instance,
2385 /// if true {...} else {...}
2387 /// isn't parsed as (if true {...} else {...} | x) | 5
2388 fn expr_requires_semi_to_be_stmt(e: &hir::Expr) -> bool {
2390 hir::ExprKind::If(..) |
2391 hir::ExprKind::Match(..) |
2392 hir::ExprKind::Block(..) |
2393 hir::ExprKind::While(..) |
2394 hir::ExprKind::Loop(..) => false,
2399 /// this statement requires a semicolon after it.
2400 /// note that in one case (stmt_semi), we've already
2401 /// seen the semicolon, and thus don't need another.
2402 fn stmt_ends_with_semi(stmt: &hir::StmtKind) -> bool {
2404 hir::StmtKind::Local(_) => true,
2405 hir::StmtKind::Item(_) => false,
2406 hir::StmtKind::Expr(ref e) => expr_requires_semi_to_be_stmt(&e),
2407 hir::StmtKind::Semi(..) => false,
2411 fn bin_op_to_assoc_op(op: hir::BinOpKind) -> AssocOp {
2412 use crate::hir::BinOpKind::*;
2414 Add => AssocOp::Add,
2415 Sub => AssocOp::Subtract,
2416 Mul => AssocOp::Multiply,
2417 Div => AssocOp::Divide,
2418 Rem => AssocOp::Modulus,
2420 And => AssocOp::LAnd,
2423 BitXor => AssocOp::BitXor,
2424 BitAnd => AssocOp::BitAnd,
2425 BitOr => AssocOp::BitOr,
2426 Shl => AssocOp::ShiftLeft,
2427 Shr => AssocOp::ShiftRight,
2429 Eq => AssocOp::Equal,
2430 Lt => AssocOp::Less,
2431 Le => AssocOp::LessEqual,
2432 Ne => AssocOp::NotEqual,
2433 Ge => AssocOp::GreaterEqual,
2434 Gt => AssocOp::Greater,
2438 /// Expressions that syntactically contain an "exterior" struct literal i.e., not surrounded by any
2439 /// parens or other delimiters, e.g., `X { y: 1 }`, `X { y: 1 }.method()`, `foo == X { y: 1 }` and
2440 /// `X { y: 1 } == foo` all do, but `(X { y: 1 }) == foo` does not.
2441 fn contains_exterior_struct_lit(value: &hir::Expr) -> bool {
2443 hir::ExprKind::Struct(..) => true,
2445 hir::ExprKind::Assign(ref lhs, ref rhs) |
2446 hir::ExprKind::AssignOp(_, ref lhs, ref rhs) |
2447 hir::ExprKind::Binary(_, ref lhs, ref rhs) => {
2448 // X { y: 1 } + X { y: 2 }
2449 contains_exterior_struct_lit(&lhs) || contains_exterior_struct_lit(&rhs)
2451 hir::ExprKind::Unary(_, ref x) |
2452 hir::ExprKind::Cast(ref x, _) |
2453 hir::ExprKind::Type(ref x, _) |
2454 hir::ExprKind::Field(ref x, _) |
2455 hir::ExprKind::Index(ref x, _) => {
2456 // &X { y: 1 }, X { y: 1 }.y
2457 contains_exterior_struct_lit(&x)
2460 hir::ExprKind::MethodCall(.., ref exprs) => {
2461 // X { y: 1 }.bar(...)
2462 contains_exterior_struct_lit(&exprs[0])