1 use rustc_target::spec::abi::Abi;
3 use syntax::source_map::{SourceMap, Spanned};
4 use syntax::parse::ParseSess;
5 use syntax::print::pp::{self, Breaks};
6 use syntax::print::pp::Breaks::{Consistent, Inconsistent};
7 use syntax::print::pprust::{self, Comments, PrintState};
8 use syntax::symbol::kw;
9 use syntax::util::parser::{self, AssocOp, Fixity};
10 use syntax_pos::{self, BytePos, FileName};
13 use crate::hir::{PatKind, GenericBound, TraitBoundModifier, RangeEnd};
14 use crate::hir::{GenericParam, GenericParamKind, GenericArg};
15 use crate::hir::ptr::P;
21 pub enum AnnNode<'a> {
23 Block(&'a hir::Block),
33 TraitItem(hir::TraitItemId),
34 ImplItem(hir::ImplItemId),
36 BodyParamPat(hir::BodyId, usize)
40 fn nested(&self, _state: &mut State<'_>, _nested: Nested) {
42 fn pre(&self, _state: &mut State<'_>, _node: AnnNode<'_>) {
44 fn post(&self, _state: &mut State<'_>, _node: AnnNode<'_>) {
46 fn try_fetch_item(&self, _: hir::HirId) -> Option<&hir::Item> {
52 impl PpAnn for NoAnn {}
53 pub const NO_ANN: &dyn PpAnn = &NoAnn;
55 impl PpAnn for hir::Crate {
56 fn try_fetch_item(&self, item: hir::HirId) -> Option<&hir::Item> {
59 fn nested(&self, state: &mut State<'_>, nested: Nested) {
61 Nested::Item(id) => state.print_item(self.item(id.id)),
62 Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
63 Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
64 Nested::Body(id) => state.print_expr(&self.body(id).value),
65 Nested::BodyParamPat(id, i) => state.print_pat(&self.body(id).params[i].pat)
70 pub struct State<'a> {
72 comments: Option<Comments<'a>>,
73 ann: &'a (dyn PpAnn + 'a),
76 impl std::ops::Deref for State<'_> {
77 type Target = pp::Printer;
78 fn deref(&self) -> &Self::Target {
83 impl std::ops::DerefMut for State<'_> {
84 fn deref_mut(&mut self) -> &mut Self::Target {
89 impl<'a> PrintState<'a> for State<'a> {
90 fn comments(&mut self) -> &mut Option<Comments<'a>> {
94 fn print_ident(&mut self, ident: ast::Ident) {
95 self.s.word(pprust::ast_ident_to_string(ident, ident.is_raw_guess()));
96 self.ann.post(self, AnnNode::Name(&ident.name))
99 fn print_generic_args(&mut self, args: &ast::GenericArgs, _colons_before_params: bool) {
100 span_bug!(args.span(), "AST generic args printed by HIR pretty-printer");
104 pub const INDENT_UNIT: usize = 4;
106 /// Requires you to pass an input filename and reader so that
107 /// it can scan the input text for comments to copy forward.
108 pub fn print_crate<'a>(cm: &'a SourceMap,
113 ann: &'a dyn PpAnn) -> String {
114 let mut s = State::new_from_input(cm, sess, filename, input, ann);
116 // When printing the AST, we sometimes need to inject `#[no_std]` here.
117 // Since you can't compile the HIR, it's not necessary.
119 s.print_mod(&krate.module, &krate.attrs);
120 s.print_remaining_comments();
125 pub fn new_from_input(cm: &'a SourceMap,
133 comments: Some(Comments::new(cm, sess, filename, input)),
139 pub fn to_string<F>(ann: &dyn PpAnn, f: F) -> String
140 where F: FnOnce(&mut State<'_>)
142 let mut printer = State {
151 pub fn visibility_qualified<S: Into<Cow<'static, str>>>(vis: &hir::Visibility, w: S) -> String {
152 to_string(NO_ANN, |s| {
153 s.print_visibility(vis);
159 pub fn cbox(&mut self, u: usize) {
163 pub fn nbsp(&mut self) {
167 pub fn word_nbsp<S: Into<Cow<'static, str>>>(&mut self, w: S) {
172 pub fn head<S: Into<Cow<'static, str>>>(&mut self, w: S) {
174 // outer-box is consistent
175 self.cbox(INDENT_UNIT);
176 // head-box is inconsistent
177 self.ibox(w.len() + 1);
178 // keyword that starts the head
184 pub fn bopen(&mut self) {
186 self.end(); // close the head-box
189 pub fn bclose_maybe_open(&mut self,
190 span: syntax_pos::Span,
193 self.maybe_print_comment(span.hi());
194 self.break_offset_if_not_bol(1, -(INDENT_UNIT as isize));
197 self.end(); // close the outer-box
201 pub fn bclose(&mut self, span: syntax_pos::Span) {
202 self.bclose_maybe_open(span, true)
205 pub fn space_if_not_bol(&mut self) {
206 if !self.s.is_beginning_of_line() {
211 pub fn break_offset_if_not_bol(&mut self, n: usize, off: isize) {
212 if !self.s.is_beginning_of_line() {
213 self.s.break_offset(n, off)
215 if off != 0 && self.s.last_token().is_hardbreak_tok() {
216 // We do something pretty sketchy here: tuck the nonzero
217 // offset-adjustment we were going to deposit along with the
218 // break into the previous hardbreak.
219 self.s.replace_last_token(pp::Printer::hardbreak_tok_offset(off));
224 // Synthesizes a comment that was not textually present in the original source
226 pub fn synth_comment(&mut self, text: String) {
234 pub fn commasep_cmnt<T, F, G>(&mut self,
239 where F: FnMut(&mut State<'_>, &T),
240 G: FnMut(&T) -> syntax_pos::Span
243 let len = elts.len();
246 self.maybe_print_comment(get_span(elt).hi());
251 self.maybe_print_trailing_comment(get_span(elt), Some(get_span(&elts[i]).hi()));
252 self.space_if_not_bol();
258 pub fn commasep_exprs(&mut self, b: Breaks, exprs: &[hir::Expr]) {
259 self.commasep_cmnt(b, exprs, |s, e| s.print_expr(&e), |e| e.span)
262 pub fn print_mod(&mut self, _mod: &hir::Mod, attrs: &[ast::Attribute]) {
263 self.print_inner_attributes(attrs);
264 for &item_id in &_mod.item_ids {
265 self.ann.nested(self, Nested::Item(item_id));
269 pub fn print_foreign_mod(&mut self,
270 nmod: &hir::ForeignMod,
271 attrs: &[ast::Attribute])
273 self.print_inner_attributes(attrs);
274 for item in &nmod.items {
275 self.print_foreign_item(item);
279 pub fn print_opt_lifetime(&mut self, lifetime: &hir::Lifetime) {
280 if !lifetime.is_elided() {
281 self.print_lifetime(lifetime);
286 pub fn print_type(&mut self, ty: &hir::Ty) {
287 self.maybe_print_comment(ty.span.lo());
290 hir::TyKind::Slice(ref ty) => {
292 self.print_type(&ty);
295 hir::TyKind::Ptr(ref mt) => {
298 hir::MutMutable => self.word_nbsp("mut"),
299 hir::MutImmutable => self.word_nbsp("const"),
301 self.print_type(&mt.ty);
303 hir::TyKind::Rptr(ref lifetime, ref mt) => {
305 self.print_opt_lifetime(lifetime);
308 hir::TyKind::Never => {
311 hir::TyKind::Tup(ref elts) => {
313 self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(&ty));
319 hir::TyKind::BareFn(ref f) => {
320 self.print_ty_fn(f.abi, f.unsafety, &f.decl, None, &f.generic_params,
323 hir::TyKind::Def(..) => {},
324 hir::TyKind::Path(ref qpath) => {
325 self.print_qpath(qpath, false)
327 hir::TyKind::TraitObject(ref bounds, ref lifetime) => {
328 let mut first = true;
329 for bound in bounds {
334 self.word_space("+");
336 self.print_poly_trait_ref(bound);
338 if !lifetime.is_elided() {
340 self.word_space("+");
341 self.print_lifetime(lifetime);
344 hir::TyKind::Array(ref ty, ref length) => {
346 self.print_type(&ty);
348 self.print_anon_const(length);
351 hir::TyKind::Typeof(ref e) => {
352 self.s.word("typeof(");
353 self.print_anon_const(e);
356 hir::TyKind::Infer => {
359 hir::TyKind::Err => {
361 self.s.word("/*ERROR*/");
364 hir::TyKind::CVarArgs(_) => {
371 pub fn print_foreign_item(&mut self, item: &hir::ForeignItem) {
372 self.hardbreak_if_not_bol();
373 self.maybe_print_comment(item.span.lo());
374 self.print_outer_attributes(&item.attrs);
376 hir::ForeignItemKind::Fn(ref decl, ref arg_names, ref generics) => {
380 unsafety: hir::Unsafety::Normal,
381 constness: hir::Constness::NotConst,
383 asyncness: hir::IsAsync::NotAsync,
385 Some(item.ident.name),
390 self.end(); // end head-ibox
392 self.end() // end the outer fn box
394 hir::ForeignItemKind::Static(ref t, m) => {
395 self.head(visibility_qualified(&item.vis, "static"));
396 if m == hir::MutMutable {
397 self.word_space("mut");
399 self.print_ident(item.ident);
400 self.word_space(":");
403 self.end(); // end the head-ibox
404 self.end() // end the outer cbox
406 hir::ForeignItemKind::Type => {
407 self.head(visibility_qualified(&item.vis, "type"));
408 self.print_ident(item.ident);
410 self.end(); // end the head-ibox
411 self.end() // end the outer cbox
416 fn print_associated_const(&mut self,
419 default: Option<hir::BodyId>,
420 vis: &hir::Visibility)
422 self.s.word(visibility_qualified(vis, ""));
423 self.word_space("const");
424 self.print_ident(ident);
425 self.word_space(":");
427 if let Some(expr) = default {
429 self.word_space("=");
430 self.ann.nested(self, Nested::Body(expr));
435 fn print_associated_type(&mut self,
437 bounds: Option<&hir::GenericBounds>,
438 ty: Option<&hir::Ty>)
440 self.word_space("type");
441 self.print_ident(ident);
442 if let Some(bounds) = bounds {
443 self.print_bounds(":", bounds);
445 if let Some(ty) = ty {
447 self.word_space("=");
456 generics: &hir::Generics,
457 inner: impl Fn(&mut Self),
459 self.head(visibility_qualified(&item.vis, "type"));
460 self.print_ident(item.ident);
461 self.print_generic_params(&generics.params);
462 self.end(); // end the inner ibox
464 self.print_where_clause(&generics.where_clause);
468 self.end(); // end the outer ibox
471 /// Pretty-print an item
472 pub fn print_item(&mut self, item: &hir::Item) {
473 self.hardbreak_if_not_bol();
474 self.maybe_print_comment(item.span.lo());
475 self.print_outer_attributes(&item.attrs);
476 self.ann.pre(self, AnnNode::Item(item));
478 hir::ItemKind::ExternCrate(orig_name) => {
479 self.head(visibility_qualified(&item.vis, "extern crate"));
480 if let Some(orig_name) = orig_name {
481 self.print_name(orig_name);
486 self.print_ident(item.ident);
488 self.end(); // end inner head-block
489 self.end(); // end outer head-block
491 hir::ItemKind::Use(ref path, kind) => {
492 self.head(visibility_qualified(&item.vis, "use"));
493 self.print_path(path, false);
496 hir::UseKind::Single => {
497 if path.segments.last().unwrap().ident != item.ident {
499 self.word_space("as");
500 self.print_ident(item.ident);
504 hir::UseKind::Glob => self.s.word("::*;"),
505 hir::UseKind::ListStem => self.s.word("::{};")
507 self.end(); // end inner head-block
508 self.end(); // end outer head-block
510 hir::ItemKind::Static(ref ty, m, expr) => {
511 self.head(visibility_qualified(&item.vis, "static"));
512 if m == hir::MutMutable {
513 self.word_space("mut");
515 self.print_ident(item.ident);
516 self.word_space(":");
517 self.print_type(&ty);
519 self.end(); // end the head-ibox
521 self.word_space("=");
522 self.ann.nested(self, Nested::Body(expr));
524 self.end(); // end the outer cbox
526 hir::ItemKind::Const(ref ty, expr) => {
527 self.head(visibility_qualified(&item.vis, "const"));
528 self.print_ident(item.ident);
529 self.word_space(":");
530 self.print_type(&ty);
532 self.end(); // end the head-ibox
534 self.word_space("=");
535 self.ann.nested(self, Nested::Body(expr));
537 self.end(); // end the outer cbox
539 hir::ItemKind::Fn(ref decl, header, ref param_names, body) => {
543 Some(item.ident.name),
549 self.end(); // need to close a box
550 self.end(); // need to close a box
551 self.ann.nested(self, Nested::Body(body));
553 hir::ItemKind::Mod(ref _mod) => {
554 self.head(visibility_qualified(&item.vis, "mod"));
555 self.print_ident(item.ident);
558 self.print_mod(_mod, &item.attrs);
559 self.bclose(item.span);
561 hir::ItemKind::ForeignMod(ref nmod) => {
563 self.word_nbsp(nmod.abi.to_string());
565 self.print_foreign_mod(nmod, &item.attrs);
566 self.bclose(item.span);
568 hir::ItemKind::GlobalAsm(ref ga) => {
569 self.head(visibility_qualified(&item.vis, "global asm"));
570 self.s.word(ga.asm.as_str().to_string());
573 hir::ItemKind::TyAlias(ref ty, ref generics) => {
574 self.print_item_type(item, &generics, |state| {
575 state.word_space("=");
576 state.print_type(&ty);
579 hir::ItemKind::OpaqueTy(ref opaque_ty) => {
580 self.print_item_type(item, &opaque_ty.generics, |state| {
581 let mut real_bounds = Vec::with_capacity(opaque_ty.bounds.len());
582 for b in opaque_ty.bounds.iter() {
583 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
585 state.word_space("for ?");
586 state.print_trait_ref(&ptr.trait_ref);
591 state.print_bounds("= impl", real_bounds);
594 hir::ItemKind::Enum(ref enum_definition, ref params) => {
595 self.print_enum_def(enum_definition, params, item.ident.name, item.span, &item.vis);
597 hir::ItemKind::Struct(ref struct_def, ref generics) => {
598 self.head(visibility_qualified(&item.vis, "struct"));
599 self.print_struct(struct_def, generics, item.ident.name, item.span, true);
601 hir::ItemKind::Union(ref struct_def, ref generics) => {
602 self.head(visibility_qualified(&item.vis, "union"));
603 self.print_struct(struct_def, generics, item.ident.name, item.span, true);
605 hir::ItemKind::Impl(unsafety,
613 self.print_visibility(&item.vis);
614 self.print_defaultness(defaultness);
615 self.print_unsafety(unsafety);
616 self.word_nbsp("impl");
618 if !generics.params.is_empty() {
619 self.print_generic_params(&generics.params);
623 if let hir::ImplPolarity::Negative = polarity {
627 if let Some(ref t) = opt_trait {
628 self.print_trait_ref(t);
630 self.word_space("for");
633 self.print_type(&ty);
634 self.print_where_clause(&generics.where_clause);
638 self.print_inner_attributes(&item.attrs);
639 for impl_item in impl_items {
640 self.ann.nested(self, Nested::ImplItem(impl_item.id));
642 self.bclose(item.span);
644 hir::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref trait_items) => {
646 self.print_visibility(&item.vis);
647 self.print_is_auto(is_auto);
648 self.print_unsafety(unsafety);
649 self.word_nbsp("trait");
650 self.print_ident(item.ident);
651 self.print_generic_params(&generics.params);
652 let mut real_bounds = Vec::with_capacity(bounds.len());
653 for b in bounds.iter() {
654 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
656 self.word_space("for ?");
657 self.print_trait_ref(&ptr.trait_ref);
662 self.print_bounds(":", real_bounds);
663 self.print_where_clause(&generics.where_clause);
666 for trait_item in trait_items {
667 self.ann.nested(self, Nested::TraitItem(trait_item.id));
669 self.bclose(item.span);
671 hir::ItemKind::TraitAlias(ref generics, ref bounds) => {
673 self.print_visibility(&item.vis);
674 self.word_nbsp("trait");
675 self.print_ident(item.ident);
676 self.print_generic_params(&generics.params);
677 let mut real_bounds = Vec::with_capacity(bounds.len());
678 // FIXME(durka) this seems to be some quite outdated syntax
679 for b in bounds.iter() {
680 if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
682 self.word_space("for ?");
683 self.print_trait_ref(&ptr.trait_ref);
689 self.print_bounds("=", real_bounds);
690 self.print_where_clause(&generics.where_clause);
694 self.ann.post(self, AnnNode::Item(item))
697 pub fn print_trait_ref(&mut self, t: &hir::TraitRef) {
698 self.print_path(&t.path, false)
701 fn print_formal_generic_params(
703 generic_params: &[hir::GenericParam]
705 if !generic_params.is_empty() {
707 self.print_generic_params(generic_params);
712 fn print_poly_trait_ref(&mut self, t: &hir::PolyTraitRef) {
713 self.print_formal_generic_params(&t.bound_generic_params);
714 self.print_trait_ref(&t.trait_ref)
717 pub fn print_enum_def(&mut self,
718 enum_definition: &hir::EnumDef,
719 generics: &hir::Generics,
721 span: syntax_pos::Span,
722 visibility: &hir::Visibility)
724 self.head(visibility_qualified(visibility, "enum"));
725 self.print_name(name);
726 self.print_generic_params(&generics.params);
727 self.print_where_clause(&generics.where_clause);
729 self.print_variants(&enum_definition.variants, span)
732 pub fn print_variants(&mut self,
733 variants: &[hir::Variant],
734 span: syntax_pos::Span)
738 self.space_if_not_bol();
739 self.maybe_print_comment(v.span.lo());
740 self.print_outer_attributes(&v.attrs);
741 self.ibox(INDENT_UNIT);
742 self.print_variant(v);
745 self.maybe_print_trailing_comment(v.span, None);
750 pub fn print_visibility(&mut self, vis: &hir::Visibility) {
752 hir::VisibilityKind::Public => self.word_nbsp("pub"),
753 hir::VisibilityKind::Crate(ast::CrateSugar::JustCrate) => self.word_nbsp("crate"),
754 hir::VisibilityKind::Crate(ast::CrateSugar::PubCrate) => self.word_nbsp("pub(crate)"),
755 hir::VisibilityKind::Restricted { ref path, .. } => {
757 if path.segments.len() == 1 &&
758 path.segments[0].ident.name == kw::Super {
759 // Special case: `super` can print like `pub(super)`.
760 self.s.word("super");
762 // Everything else requires `in` at present.
763 self.word_nbsp("in");
764 self.print_path(path, false);
768 hir::VisibilityKind::Inherited => ()
772 pub fn print_defaultness(&mut self, defaultness: hir::Defaultness) {
774 hir::Defaultness::Default { .. } => self.word_nbsp("default"),
775 hir::Defaultness::Final => (),
779 pub fn print_struct(&mut self,
780 struct_def: &hir::VariantData,
781 generics: &hir::Generics,
783 span: syntax_pos::Span,
784 print_finalizer: bool)
786 self.print_name(name);
787 self.print_generic_params(&generics.params);
789 hir::VariantData::Tuple(..) | hir::VariantData::Unit(..) => {
790 if let hir::VariantData::Tuple(..) = struct_def {
792 self.commasep(Inconsistent, struct_def.fields(), |s, field| {
793 s.maybe_print_comment(field.span.lo());
794 s.print_outer_attributes(&field.attrs);
795 s.print_visibility(&field.vis);
796 s.print_type(&field.ty)
800 self.print_where_clause(&generics.where_clause);
805 self.end() // close the outer-box
807 hir::VariantData::Struct(..) => {
808 self.print_where_clause(&generics.where_clause);
811 self.hardbreak_if_not_bol();
813 for field in struct_def.fields() {
814 self.hardbreak_if_not_bol();
815 self.maybe_print_comment(field.span.lo());
816 self.print_outer_attributes(&field.attrs);
817 self.print_visibility(&field.vis);
818 self.print_ident(field.ident);
820 self.print_type(&field.ty);
829 pub fn print_variant(&mut self, v: &hir::Variant) {
831 let generics = hir::Generics::empty();
832 self.print_struct(&v.data, &generics, v.ident.name, v.span, false);
833 if let Some(ref d) = v.disr_expr {
835 self.word_space("=");
836 self.print_anon_const(d);
839 pub fn print_method_sig(&mut self,
842 generics: &hir::Generics,
843 vis: &hir::Visibility,
844 arg_names: &[ast::Ident],
845 body_id: Option<hir::BodyId>)
847 self.print_fn(&m.decl,
856 pub fn print_trait_item(&mut self, ti: &hir::TraitItem) {
857 self.ann.pre(self, AnnNode::SubItem(ti.hir_id));
858 self.hardbreak_if_not_bol();
859 self.maybe_print_comment(ti.span.lo());
860 self.print_outer_attributes(&ti.attrs);
862 hir::TraitItemKind::Const(ref ty, default) => {
863 let vis = Spanned { span: syntax_pos::DUMMY_SP,
864 node: hir::VisibilityKind::Inherited };
865 self.print_associated_const(ti.ident, &ty, default, &vis);
867 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Required(ref arg_names)) => {
868 let vis = Spanned { span: syntax_pos::DUMMY_SP,
869 node: hir::VisibilityKind::Inherited };
870 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, arg_names, None);
873 hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Provided(body)) => {
874 let vis = Spanned { span: syntax_pos::DUMMY_SP,
875 node: hir::VisibilityKind::Inherited };
877 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, &[], Some(body));
879 self.end(); // need to close a box
880 self.end(); // need to close a box
881 self.ann.nested(self, Nested::Body(body));
883 hir::TraitItemKind::Type(ref bounds, ref default) => {
884 self.print_associated_type(ti.ident,
886 default.as_ref().map(|ty| &**ty));
889 self.ann.post(self, AnnNode::SubItem(ti.hir_id))
892 pub fn print_impl_item(&mut self, ii: &hir::ImplItem) {
893 self.ann.pre(self, AnnNode::SubItem(ii.hir_id));
894 self.hardbreak_if_not_bol();
895 self.maybe_print_comment(ii.span.lo());
896 self.print_outer_attributes(&ii.attrs);
897 self.print_defaultness(ii.defaultness);
900 hir::ImplItemKind::Const(ref ty, expr) => {
901 self.print_associated_const(ii.ident, &ty, Some(expr), &ii.vis);
903 hir::ImplItemKind::Method(ref sig, body) => {
905 self.print_method_sig(ii.ident, sig, &ii.generics, &ii.vis, &[], Some(body));
907 self.end(); // need to close a box
908 self.end(); // need to close a box
909 self.ann.nested(self, Nested::Body(body));
911 hir::ImplItemKind::TyAlias(ref ty) => {
912 self.print_associated_type(ii.ident, None, Some(ty));
914 hir::ImplItemKind::OpaqueTy(ref bounds) => {
915 self.word_space("type");
916 self.print_ident(ii.ident);
917 self.print_bounds("= impl", bounds);
921 self.ann.post(self, AnnNode::SubItem(ii.hir_id))
926 init: Option<&hir::Expr>,
927 decl: impl Fn(&mut Self)
929 self.space_if_not_bol();
930 self.ibox(INDENT_UNIT);
931 self.word_nbsp("let");
933 self.ibox(INDENT_UNIT);
937 if let Some(ref init) = init {
939 self.word_space("=");
940 self.print_expr(&init);
945 pub fn print_stmt(&mut self, st: &hir::Stmt) {
946 self.maybe_print_comment(st.span.lo());
948 hir::StmtKind::Local(ref loc) => {
949 self.print_local(loc.init.as_deref(), |this| this.print_local_decl(&loc));
951 hir::StmtKind::Item(item) => {
952 self.ann.nested(self, Nested::Item(item))
954 hir::StmtKind::Expr(ref expr) => {
955 self.space_if_not_bol();
956 self.print_expr(&expr);
958 hir::StmtKind::Semi(ref expr) => {
959 self.space_if_not_bol();
960 self.print_expr(&expr);
964 if stmt_ends_with_semi(&st.kind) {
967 self.maybe_print_trailing_comment(st.span, None)
970 pub fn print_block(&mut self, blk: &hir::Block) {
971 self.print_block_with_attrs(blk, &[])
974 pub fn print_block_unclosed(&mut self, blk: &hir::Block) {
975 self.print_block_maybe_unclosed(blk, &[], false)
978 pub fn print_block_with_attrs(&mut self,
980 attrs: &[ast::Attribute])
982 self.print_block_maybe_unclosed(blk, attrs, true)
985 pub fn print_block_maybe_unclosed(&mut self,
987 attrs: &[ast::Attribute],
991 hir::UnsafeBlock(..) => self.word_space("unsafe"),
992 hir::PushUnsafeBlock(..) => self.word_space("push_unsafe"),
993 hir::PopUnsafeBlock(..) => self.word_space("pop_unsafe"),
994 hir::DefaultBlock => (),
996 self.maybe_print_comment(blk.span.lo());
997 self.ann.pre(self, AnnNode::Block(blk));
1000 self.print_inner_attributes(attrs);
1002 for st in &blk.stmts {
1003 self.print_stmt(st);
1005 if let Some(ref expr) = blk.expr {
1006 self.space_if_not_bol();
1007 self.print_expr(&expr);
1008 self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi()));
1010 self.bclose_maybe_open(blk.span, close_box);
1011 self.ann.post(self, AnnNode::Block(blk))
1014 pub fn print_anon_const(&mut self, constant: &hir::AnonConst) {
1015 self.ann.nested(self, Nested::Body(constant.body))
1018 fn print_call_post(&mut self, args: &[hir::Expr]) {
1020 self.commasep_exprs(Inconsistent, args);
1024 pub fn print_expr_maybe_paren(&mut self, expr: &hir::Expr, prec: i8) {
1025 let needs_par = expr.precedence().order() < prec;
1029 self.print_expr(expr);
1035 /// Print an expr using syntax that's acceptable in a condition position, such as the `cond` in
1036 /// `if cond { ... }`.
1037 pub fn print_expr_as_cond(&mut self, expr: &hir::Expr) {
1038 let needs_par = match expr.kind {
1039 // These cases need parens due to the parse error observed in #26461: `if return {}`
1040 // parses as the erroneous construct `if (return {})`, not `if (return) {}`.
1041 hir::ExprKind::Closure(..) |
1042 hir::ExprKind::Ret(..) |
1043 hir::ExprKind::Break(..) => true,
1045 _ => contains_exterior_struct_lit(expr),
1051 self.print_expr(expr);
1057 fn print_expr_vec(&mut self, exprs: &[hir::Expr]) {
1058 self.ibox(INDENT_UNIT);
1060 self.commasep_exprs(Inconsistent, exprs);
1065 fn print_expr_repeat(&mut self, element: &hir::Expr, count: &hir::AnonConst) {
1066 self.ibox(INDENT_UNIT);
1068 self.print_expr(element);
1069 self.word_space(";");
1070 self.print_anon_const(count);
1075 fn print_expr_struct(&mut self,
1077 fields: &[hir::Field],
1078 wth: &Option<P<hir::Expr>>)
1080 self.print_qpath(qpath, true);
1082 self.commasep_cmnt(Consistent,
1085 s.ibox(INDENT_UNIT);
1086 if !field.is_shorthand {
1087 s.print_ident(field.ident);
1090 s.print_expr(&field.expr);
1096 self.ibox(INDENT_UNIT);
1097 if !fields.is_empty() {
1102 self.print_expr(&expr);
1105 _ => if !fields.is_empty() {
1112 fn print_expr_tup(&mut self, exprs: &[hir::Expr]) {
1114 self.commasep_exprs(Inconsistent, exprs);
1115 if exprs.len() == 1 {
1121 fn print_expr_call(&mut self, func: &hir::Expr, args: &[hir::Expr]) {
1122 let prec = match func.kind {
1123 hir::ExprKind::Field(..) => parser::PREC_FORCE_PAREN,
1124 _ => parser::PREC_POSTFIX,
1127 self.print_expr_maybe_paren(func, prec);
1128 self.print_call_post(args)
1131 fn print_expr_method_call(&mut self,
1132 segment: &hir::PathSegment,
1135 let base_args = &args[1..];
1136 self.print_expr_maybe_paren(&args[0], parser::PREC_POSTFIX);
1138 self.print_ident(segment.ident);
1140 let generic_args = segment.generic_args();
1141 if !generic_args.args.is_empty() || !generic_args.bindings.is_empty() {
1142 self.print_generic_args(generic_args, segment.infer_args, true);
1145 self.print_call_post(base_args)
1148 fn print_expr_binary(&mut self,
1153 let assoc_op = bin_op_to_assoc_op(op.node);
1154 let prec = assoc_op.precedence() as i8;
1155 let fixity = assoc_op.fixity();
1157 let (left_prec, right_prec) = match fixity {
1158 Fixity::Left => (prec, prec + 1),
1159 Fixity::Right => (prec + 1, prec),
1160 Fixity::None => (prec + 1, prec + 1),
1163 let left_prec = match (&lhs.kind, op.node) {
1164 // These cases need parens: `x as i32 < y` has the parser thinking that `i32 < y` is
1165 // the beginning of a path type. It starts trying to parse `x as (i32 < y ...` instead
1166 // of `(x as i32) < ...`. We need to convince it _not_ to do that.
1167 (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Lt) |
1168 (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Shl) => parser::PREC_FORCE_PAREN,
1172 self.print_expr_maybe_paren(lhs, left_prec);
1174 self.word_space(op.node.as_str());
1175 self.print_expr_maybe_paren(rhs, right_prec)
1178 fn print_expr_unary(&mut self, op: hir::UnOp, expr: &hir::Expr) {
1179 self.s.word(op.as_str());
1180 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1183 fn print_expr_addr_of(&mut self,
1184 mutability: hir::Mutability,
1188 self.print_mutability(mutability);
1189 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1192 fn print_literal(&mut self, lit: &hir::Lit) {
1193 self.maybe_print_comment(lit.span.lo());
1194 self.word(lit.node.to_lit_token().to_string())
1197 pub fn print_expr(&mut self, expr: &hir::Expr) {
1198 self.maybe_print_comment(expr.span.lo());
1199 self.print_outer_attributes(&expr.attrs);
1200 self.ibox(INDENT_UNIT);
1201 self.ann.pre(self, AnnNode::Expr(expr));
1203 hir::ExprKind::Box(ref expr) => {
1204 self.word_space("box");
1205 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX);
1207 hir::ExprKind::Array(ref exprs) => {
1208 self.print_expr_vec(exprs);
1210 hir::ExprKind::Repeat(ref element, ref count) => {
1211 self.print_expr_repeat(&element, count);
1213 hir::ExprKind::Struct(ref qpath, ref fields, ref wth) => {
1214 self.print_expr_struct(qpath, &fields[..], wth);
1216 hir::ExprKind::Tup(ref exprs) => {
1217 self.print_expr_tup(exprs);
1219 hir::ExprKind::Call(ref func, ref args) => {
1220 self.print_expr_call(&func, args);
1222 hir::ExprKind::MethodCall(ref segment, _, ref args) => {
1223 self.print_expr_method_call(segment, args);
1225 hir::ExprKind::Binary(op, ref lhs, ref rhs) => {
1226 self.print_expr_binary(op, &lhs, &rhs);
1228 hir::ExprKind::Unary(op, ref expr) => {
1229 self.print_expr_unary(op, &expr);
1231 hir::ExprKind::AddrOf(m, ref expr) => {
1232 self.print_expr_addr_of(m, &expr);
1234 hir::ExprKind::Lit(ref lit) => {
1235 self.print_literal(&lit);
1237 hir::ExprKind::Cast(ref expr, ref ty) => {
1238 let prec = AssocOp::As.precedence() as i8;
1239 self.print_expr_maybe_paren(&expr, prec);
1241 self.word_space("as");
1242 self.print_type(&ty);
1244 hir::ExprKind::Type(ref expr, ref ty) => {
1245 let prec = AssocOp::Colon.precedence() as i8;
1246 self.print_expr_maybe_paren(&expr, prec);
1247 self.word_space(":");
1248 self.print_type(&ty);
1250 hir::ExprKind::DropTemps(ref init) => {
1252 self.cbox(INDENT_UNIT);
1256 // Print `let _t = $init;`:
1257 let temp = ast::Ident::from_str("_t");
1258 self.print_local(Some(init), |this| this.print_ident(temp));
1262 self.space_if_not_bol();
1263 self.print_ident(temp);
1266 self.bclose_maybe_open(expr.span, true);
1268 hir::ExprKind::Loop(ref blk, opt_label, _) => {
1269 if let Some(label) = opt_label {
1270 self.print_ident(label.ident);
1271 self.word_space(":");
1275 self.print_block(&blk);
1277 hir::ExprKind::Match(ref expr, ref arms, _) => {
1278 self.cbox(INDENT_UNIT);
1279 self.ibox(INDENT_UNIT);
1280 self.word_nbsp("match");
1281 self.print_expr_as_cond(&expr);
1285 self.print_arm(arm);
1287 self.bclose(expr.span);
1289 hir::ExprKind::Closure(capture_clause, ref decl, body, _fn_decl_span, _gen) => {
1290 self.print_capture_clause(capture_clause);
1292 self.print_closure_params(&decl, body);
1295 // This is a bare expression.
1296 self.ann.nested(self, Nested::Body(body));
1297 self.end(); // need to close a box
1299 // A box will be closed by `print_expr`, but we didn't want an overall
1300 // wrapper so we closed the corresponding opening. so create an
1301 // empty box to satisfy the close.
1304 hir::ExprKind::Block(ref blk, opt_label) => {
1305 if let Some(label) = opt_label {
1306 self.print_ident(label.ident);
1307 self.word_space(":");
1309 // containing cbox, will be closed by print-block at `}`
1310 self.cbox(INDENT_UNIT);
1311 // head-box, will be closed by print-block after `{`
1313 self.print_block(&blk);
1315 hir::ExprKind::Assign(ref lhs, ref rhs) => {
1316 let prec = AssocOp::Assign.precedence() as i8;
1317 self.print_expr_maybe_paren(&lhs, prec + 1);
1319 self.word_space("=");
1320 self.print_expr_maybe_paren(&rhs, prec);
1322 hir::ExprKind::AssignOp(op, ref lhs, ref rhs) => {
1323 let prec = AssocOp::Assign.precedence() as i8;
1324 self.print_expr_maybe_paren(&lhs, prec + 1);
1326 self.s.word(op.node.as_str());
1327 self.word_space("=");
1328 self.print_expr_maybe_paren(&rhs, prec);
1330 hir::ExprKind::Field(ref expr, ident) => {
1331 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX);
1333 self.print_ident(ident);
1335 hir::ExprKind::Index(ref expr, ref index) => {
1336 self.print_expr_maybe_paren(&expr, parser::PREC_POSTFIX);
1338 self.print_expr(&index);
1341 hir::ExprKind::Path(ref qpath) => {
1342 self.print_qpath(qpath, true)
1344 hir::ExprKind::Break(destination, ref opt_expr) => {
1345 self.s.word("break");
1347 if let Some(label) = destination.label {
1348 self.print_ident(label.ident);
1351 if let Some(ref expr) = *opt_expr {
1352 self.print_expr_maybe_paren(expr, parser::PREC_JUMP);
1356 hir::ExprKind::Continue(destination) => {
1357 self.s.word("continue");
1359 if let Some(label) = destination.label {
1360 self.print_ident(label.ident);
1364 hir::ExprKind::Ret(ref result) => {
1365 self.s.word("return");
1366 if let Some(ref expr) = *result {
1368 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP);
1371 hir::ExprKind::InlineAsm(ref a, ref outputs, ref inputs) => {
1372 self.s.word("asm!");
1374 self.print_string(&a.asm.as_str(), a.asm_str_style);
1375 self.word_space(":");
1377 let mut out_idx = 0;
1378 self.commasep(Inconsistent, &a.outputs, |s, out| {
1379 let constraint = out.constraint.as_str();
1380 let mut ch = constraint.chars();
1382 Some('=') if out.is_rw => {
1383 s.print_string(&format!("+{}", ch.as_str()),
1384 ast::StrStyle::Cooked)
1386 _ => s.print_string(&constraint, ast::StrStyle::Cooked),
1389 s.print_expr(&outputs[out_idx]);
1394 self.word_space(":");
1397 self.commasep(Inconsistent, &a.inputs, |s, co| {
1398 s.print_string(&co.as_str(), ast::StrStyle::Cooked);
1400 s.print_expr(&inputs[in_idx]);
1405 self.word_space(":");
1407 self.commasep(Inconsistent, &a.clobbers, |s, co| {
1408 s.print_string(&co.as_str(), ast::StrStyle::Cooked);
1411 let mut options = vec![];
1413 options.push("volatile");
1416 options.push("alignstack");
1418 if a.dialect == ast::AsmDialect::Intel {
1419 options.push("intel");
1422 if !options.is_empty() {
1424 self.word_space(":");
1425 self.commasep(Inconsistent, &options, |s, &co| {
1426 s.print_string(co, ast::StrStyle::Cooked);
1432 hir::ExprKind::Yield(ref expr, _) => {
1433 self.word_space("yield");
1434 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP);
1436 hir::ExprKind::Err => {
1438 self.s.word("/*ERROR*/");
1442 self.ann.post(self, AnnNode::Expr(expr));
1446 pub fn print_local_decl(&mut self, loc: &hir::Local) {
1447 self.print_pat(&loc.pat);
1448 if let Some(ref ty) = loc.ty {
1449 self.word_space(":");
1450 self.print_type(&ty);
1454 pub fn print_usize(&mut self, i: usize) {
1455 self.s.word(i.to_string())
1458 pub fn print_name(&mut self, name: ast::Name) {
1459 self.print_ident(ast::Ident::with_dummy_span(name))
1462 pub fn print_for_decl(&mut self, loc: &hir::Local, coll: &hir::Expr) {
1463 self.print_local_decl(loc);
1465 self.word_space("in");
1466 self.print_expr(coll)
1469 pub fn print_path(&mut self,
1471 colons_before_params: bool)
1473 self.maybe_print_comment(path.span.lo());
1475 for (i, segment) in path.segments.iter().enumerate() {
1479 if segment.ident.name != kw::PathRoot {
1480 self.print_ident(segment.ident);
1481 self.print_generic_args(segment.generic_args(), segment.infer_args,
1482 colons_before_params);
1487 pub fn print_path_segment(&mut self, segment: &hir::PathSegment) {
1488 if segment.ident.name != kw::PathRoot {
1489 self.print_ident(segment.ident);
1490 self.print_generic_args(segment.generic_args(), segment.infer_args, false);
1494 pub fn print_qpath(&mut self,
1496 colons_before_params: bool)
1499 hir::QPath::Resolved(None, ref path) => {
1500 self.print_path(path, colons_before_params)
1502 hir::QPath::Resolved(Some(ref qself), ref path) => {
1504 self.print_type(qself);
1506 self.word_space("as");
1508 for (i, segment) in path.segments[..path.segments.len() - 1].iter().enumerate() {
1512 if segment.ident.name != kw::PathRoot {
1513 self.print_ident(segment.ident);
1514 self.print_generic_args(segment.generic_args(),
1516 colons_before_params);
1522 let item_segment = path.segments.last().unwrap();
1523 self.print_ident(item_segment.ident);
1524 self.print_generic_args(item_segment.generic_args(),
1525 item_segment.infer_args,
1526 colons_before_params)
1528 hir::QPath::TypeRelative(ref qself, ref item_segment) => {
1530 self.print_type(qself);
1533 self.print_ident(item_segment.ident);
1534 self.print_generic_args(item_segment.generic_args(),
1535 item_segment.infer_args,
1536 colons_before_params)
1541 fn print_generic_args(&mut self,
1542 generic_args: &hir::GenericArgs,
1544 colons_before_params: bool)
1546 if generic_args.parenthesized {
1548 self.commasep(Inconsistent, generic_args.inputs(), |s, ty| s.print_type(&ty));
1551 self.space_if_not_bol();
1552 self.word_space("->");
1553 self.print_type(generic_args.bindings[0].ty());
1555 let start = if colons_before_params { "::<" } else { "<" };
1556 let empty = Cell::new(true);
1557 let start_or_comma = |this: &mut Self| {
1562 this.word_space(",")
1566 let mut nonelided_generic_args: bool = false;
1567 let elide_lifetimes = generic_args.args.iter().all(|arg| match arg {
1568 GenericArg::Lifetime(lt) => lt.is_elided(),
1570 nonelided_generic_args = true;
1575 if nonelided_generic_args {
1576 start_or_comma(self);
1577 self.commasep(Inconsistent, &generic_args.args, |s, generic_arg| {
1579 GenericArg::Lifetime(lt) if !elide_lifetimes => s.print_lifetime(lt),
1580 GenericArg::Lifetime(_) => {},
1581 GenericArg::Type(ty) => s.print_type(ty),
1582 GenericArg::Const(ct) => s.print_anon_const(&ct.value),
1587 // FIXME(eddyb): this would leak into error messages (e.g.,
1588 // "non-exhaustive patterns: `Some::<..>(_)` not covered").
1589 if infer_args && false {
1590 start_or_comma(self);
1594 for binding in generic_args.bindings.iter() {
1595 start_or_comma(self);
1596 self.print_ident(binding.ident);
1598 match generic_args.bindings[0].kind {
1599 hir::TypeBindingKind::Equality { ref ty } => {
1600 self.word_space("=");
1601 self.print_type(ty);
1603 hir::TypeBindingKind::Constraint { ref bounds } => {
1604 self.print_bounds(":", bounds);
1615 pub fn print_pat(&mut self, pat: &hir::Pat) {
1616 self.maybe_print_comment(pat.span.lo());
1617 self.ann.pre(self, AnnNode::Pat(pat));
1618 // Pat isn't normalized, but the beauty of it
1619 // is that it doesn't matter
1621 PatKind::Wild => self.s.word("_"),
1622 PatKind::Binding(binding_mode, _, ident, ref sub) => {
1623 match binding_mode {
1624 hir::BindingAnnotation::Ref => {
1625 self.word_nbsp("ref");
1626 self.print_mutability(hir::MutImmutable);
1628 hir::BindingAnnotation::RefMut => {
1629 self.word_nbsp("ref");
1630 self.print_mutability(hir::MutMutable);
1632 hir::BindingAnnotation::Unannotated => {}
1633 hir::BindingAnnotation::Mutable => {
1634 self.word_nbsp("mut");
1637 self.print_ident(ident);
1638 if let Some(ref p) = *sub {
1643 PatKind::TupleStruct(ref qpath, ref elts, ddpos) => {
1644 self.print_qpath(qpath, true);
1646 if let Some(ddpos) = ddpos {
1647 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p));
1649 self.word_space(",");
1652 if ddpos != elts.len() {
1654 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p));
1657 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p));
1661 PatKind::Path(ref qpath) => {
1662 self.print_qpath(qpath, true);
1664 PatKind::Struct(ref qpath, ref fields, etc) => {
1665 self.print_qpath(qpath, true);
1667 self.word_space("{");
1668 self.commasep_cmnt(Consistent,
1671 s.cbox(INDENT_UNIT);
1672 if !f.is_shorthand {
1673 s.print_ident(f.ident);
1676 s.print_pat(&f.pat);
1681 if !fields.is_empty() {
1682 self.word_space(",");
1689 PatKind::Or(ref pats) => {
1690 self.strsep("|", true, Inconsistent, &pats[..], |s, p| s.print_pat(&p));
1692 PatKind::Tuple(ref elts, ddpos) => {
1694 if let Some(ddpos) = ddpos {
1695 self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p));
1697 self.word_space(",");
1700 if ddpos != elts.len() {
1702 self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p));
1705 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p));
1706 if elts.len() == 1 {
1712 PatKind::Box(ref inner) => {
1713 let is_range_inner = match inner.kind {
1714 PatKind::Range(..) => true,
1717 self.s.word("box ");
1721 self.print_pat(&inner);
1726 PatKind::Ref(ref inner, mutbl) => {
1727 let is_range_inner = match inner.kind {
1728 PatKind::Range(..) => true,
1732 if mutbl == hir::MutMutable {
1733 self.s.word("mut ");
1738 self.print_pat(&inner);
1743 PatKind::Lit(ref e) => self.print_expr(&e),
1744 PatKind::Range(ref begin, ref end, ref end_kind) => {
1745 self.print_expr(&begin);
1748 RangeEnd::Included => self.s.word("..."),
1749 RangeEnd::Excluded => self.s.word(".."),
1751 self.print_expr(&end);
1753 PatKind::Slice(ref before, ref slice, ref after) => {
1755 self.commasep(Inconsistent, &before[..], |s, p| s.print_pat(&p));
1756 if let Some(ref p) = *slice {
1757 if !before.is_empty() {
1758 self.word_space(",");
1760 if let PatKind::Wild = p.kind {
1766 if !after.is_empty() {
1767 self.word_space(",");
1770 self.commasep(Inconsistent, &after[..], |s, p| s.print_pat(&p));
1774 self.ann.post(self, AnnNode::Pat(pat))
1777 pub fn print_param(&mut self, arg: &hir::Param) {
1778 self.print_outer_attributes(&arg.attrs);
1779 self.print_pat(&arg.pat);
1782 pub fn print_arm(&mut self, arm: &hir::Arm) {
1783 // I have no idea why this check is necessary, but here it
1785 if arm.attrs.is_empty() {
1788 self.cbox(INDENT_UNIT);
1789 self.ann.pre(self, AnnNode::Arm(arm));
1791 self.print_outer_attributes(&arm.attrs);
1792 self.print_pat(&arm.pat);
1794 if let Some(ref g) = arm.guard {
1796 hir::Guard::If(e) => {
1797 self.word_space("if");
1798 self.print_expr(&e);
1803 self.word_space("=>");
1805 match arm.body.kind {
1806 hir::ExprKind::Block(ref blk, opt_label) => {
1807 if let Some(label) = opt_label {
1808 self.print_ident(label.ident);
1809 self.word_space(":");
1811 // the block will close the pattern's ibox
1812 self.print_block_unclosed(&blk);
1814 // If it is a user-provided unsafe block, print a comma after it
1815 if let hir::UnsafeBlock(hir::UserProvided) = blk.rules {
1820 self.end(); // close the ibox for the pattern
1821 self.print_expr(&arm.body);
1825 self.ann.post(self, AnnNode::Arm(arm));
1826 self.end() // close enclosing cbox
1829 pub fn print_fn(&mut self,
1831 header: hir::FnHeader,
1832 name: Option<ast::Name>,
1833 generics: &hir::Generics,
1834 vis: &hir::Visibility,
1835 arg_names: &[ast::Ident],
1836 body_id: Option<hir::BodyId>)
1838 self.print_fn_header_info(header, vis);
1840 if let Some(name) = name {
1842 self.print_name(name);
1844 self.print_generic_params(&generics.params);
1848 // Make sure we aren't supplied *both* `arg_names` and `body_id`.
1849 assert!(arg_names.is_empty() || body_id.is_none());
1850 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
1851 s.ibox(INDENT_UNIT);
1852 if let Some(arg_name) = arg_names.get(i) {
1853 s.s.word(arg_name.as_str().to_string());
1856 } else if let Some(body_id) = body_id {
1857 s.ann.nested(s, Nested::BodyParamPat(body_id, i));
1865 if decl.c_variadic {
1866 self.s.word(", ...");
1870 self.print_fn_output(decl);
1871 self.print_where_clause(&generics.where_clause)
1874 fn print_closure_params(&mut self, decl: &hir::FnDecl, body_id: hir::BodyId) {
1877 self.commasep(Inconsistent, &decl.inputs, |s, ty| {
1878 s.ibox(INDENT_UNIT);
1880 s.ann.nested(s, Nested::BodyParamPat(body_id, i));
1883 if let hir::TyKind::Infer = ty.kind {
1894 if let hir::DefaultReturn(..) = decl.output {
1898 self.space_if_not_bol();
1899 self.word_space("->");
1901 hir::Return(ref ty) => {
1902 self.print_type(&ty);
1903 self.maybe_print_comment(ty.span.lo())
1905 hir::DefaultReturn(..) => unreachable!(),
1909 pub fn print_capture_clause(&mut self, capture_clause: hir::CaptureClause) {
1910 match capture_clause {
1911 hir::CaptureByValue => self.word_space("move"),
1912 hir::CaptureByRef => {},
1916 pub fn print_bounds<'b>(
1918 prefix: &'static str,
1919 bounds: impl IntoIterator<Item = &'b hir::GenericBound>,
1921 let mut first = true;
1922 for bound in bounds {
1924 self.s.word(prefix);
1926 if !(first && prefix.is_empty()) {
1932 self.word_space("+");
1936 GenericBound::Trait(tref, modifier) => {
1937 if modifier == &TraitBoundModifier::Maybe {
1940 self.print_poly_trait_ref(tref);
1942 GenericBound::Outlives(lt) => {
1943 self.print_lifetime(lt);
1949 pub fn print_generic_params(&mut self, generic_params: &[GenericParam]) {
1950 if !generic_params.is_empty() {
1953 self.commasep(Inconsistent, generic_params, |s, param| {
1954 s.print_generic_param(param)
1961 pub fn print_generic_param(&mut self, param: &GenericParam) {
1962 if let GenericParamKind::Const { .. } = param.kind {
1963 self.word_space("const");
1966 self.print_ident(param.name.ident());
1969 GenericParamKind::Lifetime { .. } => {
1971 for bound in ¶m.bounds {
1973 GenericBound::Outlives(lt) => {
1975 self.print_lifetime(lt);
1982 GenericParamKind::Type { ref default, .. } => {
1983 self.print_bounds(":", ¶m.bounds);
1987 self.word_space("=");
1988 self.print_type(&default)
1993 GenericParamKind::Const { ref ty } => {
1994 self.word_space(":");
2000 pub fn print_lifetime(&mut self, lifetime: &hir::Lifetime) {
2001 self.print_ident(lifetime.name.ident())
2004 pub fn print_where_clause(&mut self, where_clause: &hir::WhereClause) {
2005 if where_clause.predicates.is_empty() {
2010 self.word_space("where");
2012 for (i, predicate) in where_clause.predicates.iter().enumerate() {
2014 self.word_space(",");
2018 &hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
2019 ref bound_generic_params,
2024 self.print_formal_generic_params(bound_generic_params);
2025 self.print_type(&bounded_ty);
2026 self.print_bounds(":", bounds);
2028 &hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate{ref lifetime,
2031 self.print_lifetime(lifetime);
2034 for (i, bound) in bounds.iter().enumerate() {
2036 GenericBound::Outlives(lt) => {
2037 self.print_lifetime(lt);
2047 &hir::WherePredicate::EqPredicate(hir::WhereEqPredicate{ref lhs_ty,
2050 self.print_type(lhs_ty);
2052 self.word_space("=");
2053 self.print_type(rhs_ty);
2059 pub fn print_mutability(&mut self, mutbl: hir::Mutability) {
2061 hir::MutMutable => self.word_nbsp("mut"),
2062 hir::MutImmutable => {},
2066 pub fn print_mt(&mut self, mt: &hir::MutTy) {
2067 self.print_mutability(mt.mutbl);
2068 self.print_type(&mt.ty)
2071 pub fn print_fn_output(&mut self, decl: &hir::FnDecl) {
2072 if let hir::DefaultReturn(..) = decl.output {
2076 self.space_if_not_bol();
2077 self.ibox(INDENT_UNIT);
2078 self.word_space("->");
2080 hir::DefaultReturn(..) => unreachable!(),
2081 hir::Return(ref ty) => self.print_type(&ty),
2086 hir::Return(ref output) => self.maybe_print_comment(output.span.lo()),
2091 pub fn print_ty_fn(&mut self,
2093 unsafety: hir::Unsafety,
2095 name: Option<ast::Name>,
2096 generic_params: &[hir::GenericParam],
2097 arg_names: &[ast::Ident])
2099 self.ibox(INDENT_UNIT);
2100 if !generic_params.is_empty() {
2102 self.print_generic_params(generic_params);
2104 let generics = hir::Generics {
2105 params: hir::HirVec::new(),
2106 where_clause: hir::WhereClause {
2107 predicates: hir::HirVec::new(),
2108 span: syntax_pos::DUMMY_SP,
2110 span: syntax_pos::DUMMY_SP,
2116 constness: hir::Constness::NotConst,
2117 asyncness: hir::IsAsync::NotAsync,
2121 &Spanned { span: syntax_pos::DUMMY_SP,
2122 node: hir::VisibilityKind::Inherited },
2128 pub fn maybe_print_trailing_comment(&mut self,
2129 span: syntax_pos::Span,
2130 next_pos: Option<BytePos>)
2132 if let Some(cmnts) = self.comments() {
2133 if let Some(cmnt) = cmnts.trailing_comment(span, next_pos) {
2134 self.print_comment(&cmnt);
2139 pub fn print_remaining_comments(&mut self) {
2140 // If there aren't any remaining comments, then we need to manually
2141 // make sure there is a line break at the end.
2142 if self.next_comment().is_none() {
2145 while let Some(ref cmnt) = self.next_comment() {
2146 self.print_comment(cmnt)
2150 pub fn print_opt_abi_and_extern_if_nondefault(&mut self,
2151 opt_abi: Option<Abi>)
2154 Some(Abi::Rust) => {},
2156 self.word_nbsp("extern");
2157 self.word_nbsp(abi.to_string())
2163 pub fn print_extern_opt_abi(&mut self, opt_abi: Option<Abi>) {
2166 self.word_nbsp("extern");
2167 self.word_nbsp(abi.to_string())
2173 pub fn print_fn_header_info(&mut self,
2174 header: hir::FnHeader,
2175 vis: &hir::Visibility)
2177 self.s.word(visibility_qualified(vis, ""));
2179 match header.constness {
2180 hir::Constness::NotConst => {}
2181 hir::Constness::Const => self.word_nbsp("const"),
2184 match header.asyncness {
2185 hir::IsAsync::NotAsync => {}
2186 hir::IsAsync::Async => self.word_nbsp("async"),
2189 self.print_unsafety(header.unsafety);
2191 if header.abi != Abi::Rust {
2192 self.word_nbsp("extern");
2193 self.word_nbsp(header.abi.to_string());
2199 pub fn print_unsafety(&mut self, s: hir::Unsafety) {
2201 hir::Unsafety::Normal => {}
2202 hir::Unsafety::Unsafe => self.word_nbsp("unsafe"),
2206 pub fn print_is_auto(&mut self, s: hir::IsAuto) {
2208 hir::IsAuto::Yes => self.word_nbsp("auto"),
2209 hir::IsAuto::No => {},
2214 /// Does this expression require a semicolon to be treated
2215 /// as a statement? The negation of this: 'can this expression
2216 /// be used as a statement without a semicolon' -- is used
2217 /// as an early-bail-out in the parser so that, for instance,
2218 /// if true {...} else {...}
2220 /// isn't parsed as (if true {...} else {...} | x) | 5
2222 // Duplicated from `parse::classify`, but adapted for the HIR.
2223 fn expr_requires_semi_to_be_stmt(e: &hir::Expr) -> bool {
2225 hir::ExprKind::Match(..) |
2226 hir::ExprKind::Block(..) |
2227 hir::ExprKind::Loop(..) => false,
2232 /// This statement requires a semicolon after it.
2233 /// note that in one case (stmt_semi), we've already
2234 /// seen the semicolon, and thus don't need another.
2235 fn stmt_ends_with_semi(stmt: &hir::StmtKind) -> bool {
2237 hir::StmtKind::Local(_) => true,
2238 hir::StmtKind::Item(_) => false,
2239 hir::StmtKind::Expr(ref e) => expr_requires_semi_to_be_stmt(&e),
2240 hir::StmtKind::Semi(..) => false,
2244 fn bin_op_to_assoc_op(op: hir::BinOpKind) -> AssocOp {
2245 use crate::hir::BinOpKind::*;
2247 Add => AssocOp::Add,
2248 Sub => AssocOp::Subtract,
2249 Mul => AssocOp::Multiply,
2250 Div => AssocOp::Divide,
2251 Rem => AssocOp::Modulus,
2253 And => AssocOp::LAnd,
2256 BitXor => AssocOp::BitXor,
2257 BitAnd => AssocOp::BitAnd,
2258 BitOr => AssocOp::BitOr,
2259 Shl => AssocOp::ShiftLeft,
2260 Shr => AssocOp::ShiftRight,
2262 Eq => AssocOp::Equal,
2263 Lt => AssocOp::Less,
2264 Le => AssocOp::LessEqual,
2265 Ne => AssocOp::NotEqual,
2266 Ge => AssocOp::GreaterEqual,
2267 Gt => AssocOp::Greater,
2271 /// Expressions that syntactically contain an "exterior" struct literal, i.e., not surrounded by any
2272 /// parens or other delimiters, e.g., `X { y: 1 }`, `X { y: 1 }.method()`, `foo == X { y: 1 }` and
2273 /// `X { y: 1 } == foo` all do, but `(X { y: 1 }) == foo` does not.
2274 fn contains_exterior_struct_lit(value: &hir::Expr) -> bool {
2276 hir::ExprKind::Struct(..) => true,
2278 hir::ExprKind::Assign(ref lhs, ref rhs) |
2279 hir::ExprKind::AssignOp(_, ref lhs, ref rhs) |
2280 hir::ExprKind::Binary(_, ref lhs, ref rhs) => {
2281 // `X { y: 1 } + X { y: 2 }`
2282 contains_exterior_struct_lit(&lhs) || contains_exterior_struct_lit(&rhs)
2284 hir::ExprKind::Unary(_, ref x) |
2285 hir::ExprKind::Cast(ref x, _) |
2286 hir::ExprKind::Type(ref x, _) |
2287 hir::ExprKind::Field(ref x, _) |
2288 hir::ExprKind::Index(ref x, _) => {
2289 // `&X { y: 1 }, X { y: 1 }.y`
2290 contains_exterior_struct_lit(&x)
2293 hir::ExprKind::MethodCall(.., ref exprs) => {
2294 // `X { y: 1 }.bar(...)`
2295 contains_exterior_struct_lit(&exprs[0])