]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_hir_pretty/src/lib.rs
Rollup merge of #83644 - lnicola:rust-analyzer-2021-03-29, r=jonas-schievink
[rust.git] / compiler / rustc_hir_pretty / src / lib.rs
1 #![cfg_attr(bootstrap, feature(or_patterns))]
2 #![recursion_limit = "256"]
3
4 use rustc_ast as ast;
5 use rustc_ast::util::parser::{self, AssocOp, Fixity};
6 use rustc_ast_pretty::pp::Breaks::{Consistent, Inconsistent};
7 use rustc_ast_pretty::pp::{self, Breaks};
8 use rustc_ast_pretty::pprust::{Comments, PrintState};
9 use rustc_hir as hir;
10 use rustc_hir::{GenericArg, GenericParam, GenericParamKind, Node};
11 use rustc_hir::{GenericBound, PatKind, RangeEnd, TraitBoundModifier};
12 use rustc_span::source_map::{SourceMap, Spanned};
13 use rustc_span::symbol::{kw, Ident, IdentPrinter, Symbol};
14 use rustc_span::{self, BytePos, FileName};
15 use rustc_target::spec::abi::Abi;
16
17 use std::borrow::Cow;
18 use std::cell::Cell;
19 use std::collections::BTreeMap;
20 use std::vec;
21
22 pub fn id_to_string(map: &dyn rustc_hir::intravisit::Map<'_>, hir_id: hir::HirId) -> String {
23     to_string(&map, |s| s.print_node(map.find(hir_id).unwrap()))
24 }
25
26 pub enum AnnNode<'a> {
27     Name(&'a Symbol),
28     Block(&'a hir::Block<'a>),
29     Item(&'a hir::Item<'a>),
30     SubItem(hir::HirId),
31     Expr(&'a hir::Expr<'a>),
32     Pat(&'a hir::Pat<'a>),
33     Arm(&'a hir::Arm<'a>),
34 }
35
36 pub enum Nested {
37     Item(hir::ItemId),
38     TraitItem(hir::TraitItemId),
39     ImplItem(hir::ImplItemId),
40     ForeignItem(hir::ForeignItemId),
41     Body(hir::BodyId),
42     BodyParamPat(hir::BodyId, usize),
43 }
44
45 pub trait PpAnn {
46     fn nested(&self, _state: &mut State<'_>, _nested: Nested) {}
47     fn pre(&self, _state: &mut State<'_>, _node: AnnNode<'_>) {}
48     fn post(&self, _state: &mut State<'_>, _node: AnnNode<'_>) {}
49 }
50
51 pub struct NoAnn;
52 impl PpAnn for NoAnn {}
53 pub const NO_ANN: &dyn PpAnn = &NoAnn;
54
55 impl PpAnn for hir::Crate<'_> {
56     fn nested(&self, state: &mut State<'_>, nested: Nested) {
57         match nested {
58             Nested::Item(id) => state.print_item(self.item(id)),
59             Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
60             Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
61             Nested::ForeignItem(id) => state.print_foreign_item(self.foreign_item(id)),
62             Nested::Body(id) => state.print_expr(&self.body(id).value),
63             Nested::BodyParamPat(id, i) => state.print_pat(&self.body(id).params[i].pat),
64         }
65     }
66 }
67
68 /// Identical to the `PpAnn` implementation for `hir::Crate`,
69 /// except it avoids creating a dependency on the whole crate.
70 impl PpAnn for &dyn rustc_hir::intravisit::Map<'_> {
71     fn nested(&self, state: &mut State<'_>, nested: Nested) {
72         match nested {
73             Nested::Item(id) => state.print_item(self.item(id)),
74             Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
75             Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
76             Nested::ForeignItem(id) => state.print_foreign_item(self.foreign_item(id)),
77             Nested::Body(id) => state.print_expr(&self.body(id).value),
78             Nested::BodyParamPat(id, i) => state.print_pat(&self.body(id).params[i].pat),
79         }
80     }
81 }
82
83 pub struct State<'a> {
84     pub s: pp::Printer,
85     comments: Option<Comments<'a>>,
86     attrs: &'a BTreeMap<hir::HirId, &'a [ast::Attribute]>,
87     ann: &'a (dyn PpAnn + 'a),
88 }
89
90 impl<'a> State<'a> {
91     pub fn print_node(&mut self, node: Node<'_>) {
92         match node {
93             Node::Param(a) => self.print_param(&a),
94             Node::Item(a) => self.print_item(&a),
95             Node::ForeignItem(a) => self.print_foreign_item(&a),
96             Node::TraitItem(a) => self.print_trait_item(a),
97             Node::ImplItem(a) => self.print_impl_item(a),
98             Node::Variant(a) => self.print_variant(&a),
99             Node::AnonConst(a) => self.print_anon_const(&a),
100             Node::Expr(a) => self.print_expr(&a),
101             Node::Stmt(a) => self.print_stmt(&a),
102             Node::PathSegment(a) => self.print_path_segment(&a),
103             Node::Ty(a) => self.print_type(&a),
104             Node::TraitRef(a) => self.print_trait_ref(&a),
105             Node::Binding(a) | Node::Pat(a) => self.print_pat(&a),
106             Node::Arm(a) => self.print_arm(&a),
107             Node::Block(a) => {
108                 // Containing cbox, will be closed by print-block at `}`.
109                 self.cbox(INDENT_UNIT);
110                 // Head-ibox, will be closed by print-block after `{`.
111                 self.ibox(0);
112                 self.print_block(&a)
113             }
114             Node::Lifetime(a) => self.print_lifetime(&a),
115             Node::Visibility(a) => self.print_visibility(&a),
116             Node::GenericParam(_) => panic!("cannot print Node::GenericParam"),
117             Node::Field(_) => panic!("cannot print Node::Field"),
118             // These cases do not carry enough information in the
119             // `hir_map` to reconstruct their full structure for pretty
120             // printing.
121             Node::Ctor(..) => panic!("cannot print isolated Ctor"),
122             Node::Local(a) => self.print_local_decl(&a),
123             Node::MacroDef(_) => panic!("cannot print MacroDef"),
124             Node::Crate(..) => panic!("cannot print Crate"),
125         }
126     }
127 }
128
129 impl std::ops::Deref for State<'_> {
130     type Target = pp::Printer;
131     fn deref(&self) -> &Self::Target {
132         &self.s
133     }
134 }
135
136 impl std::ops::DerefMut for State<'_> {
137     fn deref_mut(&mut self) -> &mut Self::Target {
138         &mut self.s
139     }
140 }
141
142 impl<'a> PrintState<'a> for State<'a> {
143     fn comments(&mut self) -> &mut Option<Comments<'a>> {
144         &mut self.comments
145     }
146
147     fn print_ident(&mut self, ident: Ident) {
148         self.s.word(IdentPrinter::for_ast_ident(ident, ident.is_raw_guess()).to_string());
149         self.ann.post(self, AnnNode::Name(&ident.name))
150     }
151
152     fn print_generic_args(&mut self, _: &ast::GenericArgs, _colons_before_params: bool) {
153         panic!("AST generic args printed by HIR pretty-printer");
154     }
155 }
156
157 pub const INDENT_UNIT: usize = 4;
158
159 /// Requires you to pass an input filename and reader so that
160 /// it can scan the input text for comments to copy forward.
161 pub fn print_crate<'a>(
162     sm: &'a SourceMap,
163     krate: &hir::Crate<'_>,
164     filename: FileName,
165     input: String,
166     ann: &'a dyn PpAnn,
167 ) -> String {
168     let mut s = State::new_from_input(sm, filename, input, &krate.attrs, ann);
169
170     // When printing the AST, we sometimes need to inject `#[no_std]` here.
171     // Since you can't compile the HIR, it's not necessary.
172
173     s.print_mod(&krate.item.module, s.attrs(hir::CRATE_HIR_ID));
174     s.print_remaining_comments();
175     s.s.eof()
176 }
177
178 impl<'a> State<'a> {
179     pub fn new_from_input(
180         sm: &'a SourceMap,
181         filename: FileName,
182         input: String,
183         attrs: &'a BTreeMap<hir::HirId, &[ast::Attribute]>,
184         ann: &'a dyn PpAnn,
185     ) -> State<'a> {
186         State {
187             s: pp::mk_printer(),
188             comments: Some(Comments::new(sm, filename, input)),
189             attrs,
190             ann,
191         }
192     }
193
194     fn attrs(&self, id: hir::HirId) -> &'a [ast::Attribute] {
195         self.attrs.get(&id).map_or(&[], |la| *la)
196     }
197 }
198
199 pub fn to_string<F>(ann: &dyn PpAnn, f: F) -> String
200 where
201     F: FnOnce(&mut State<'_>),
202 {
203     let mut printer =
204         State { s: pp::mk_printer(), comments: None, attrs: &BTreeMap::default(), ann };
205     f(&mut printer);
206     printer.s.eof()
207 }
208
209 pub fn visibility_qualified<S: Into<Cow<'static, str>>>(vis: &hir::Visibility<'_>, w: S) -> String {
210     to_string(NO_ANN, |s| {
211         s.print_visibility(vis);
212         s.s.word(w)
213     })
214 }
215
216 pub fn generic_params_to_string(generic_params: &[GenericParam<'_>]) -> String {
217     to_string(NO_ANN, |s| s.print_generic_params(generic_params))
218 }
219
220 pub fn bounds_to_string<'b>(bounds: impl IntoIterator<Item = &'b hir::GenericBound<'b>>) -> String {
221     to_string(NO_ANN, |s| s.print_bounds("", bounds))
222 }
223
224 pub fn ty_to_string(ty: &hir::Ty<'_>) -> String {
225     to_string(NO_ANN, |s| s.print_type(ty))
226 }
227
228 pub fn path_segment_to_string(segment: &hir::PathSegment<'_>) -> String {
229     to_string(NO_ANN, |s| s.print_path_segment(segment))
230 }
231
232 pub fn path_to_string(segment: &hir::Path<'_>) -> String {
233     to_string(NO_ANN, |s| s.print_path(segment, false))
234 }
235
236 pub fn fn_to_string(
237     decl: &hir::FnDecl<'_>,
238     header: hir::FnHeader,
239     name: Option<Symbol>,
240     generics: &hir::Generics<'_>,
241     vis: &hir::Visibility<'_>,
242     arg_names: &[Ident],
243     body_id: Option<hir::BodyId>,
244 ) -> String {
245     to_string(NO_ANN, |s| s.print_fn(decl, header, name, generics, vis, arg_names, body_id))
246 }
247
248 pub fn enum_def_to_string(
249     enum_definition: &hir::EnumDef<'_>,
250     generics: &hir::Generics<'_>,
251     name: Symbol,
252     span: rustc_span::Span,
253     visibility: &hir::Visibility<'_>,
254 ) -> String {
255     to_string(NO_ANN, |s| s.print_enum_def(enum_definition, generics, name, span, visibility))
256 }
257
258 impl<'a> State<'a> {
259     pub fn cbox(&mut self, u: usize) {
260         self.s.cbox(u);
261     }
262
263     pub fn nbsp(&mut self) {
264         self.s.word(" ")
265     }
266
267     pub fn word_nbsp<S: Into<Cow<'static, str>>>(&mut self, w: S) {
268         self.s.word(w);
269         self.nbsp()
270     }
271
272     pub fn head<S: Into<Cow<'static, str>>>(&mut self, w: S) {
273         let w = w.into();
274         // outer-box is consistent
275         self.cbox(INDENT_UNIT);
276         // head-box is inconsistent
277         self.ibox(w.len() + 1);
278         // keyword that starts the head
279         if !w.is_empty() {
280             self.word_nbsp(w);
281         }
282     }
283
284     pub fn bopen(&mut self) {
285         self.s.word("{");
286         self.end(); // close the head-box
287     }
288
289     pub fn bclose_maybe_open(&mut self, span: rustc_span::Span, close_box: bool) {
290         self.maybe_print_comment(span.hi());
291         self.break_offset_if_not_bol(1, -(INDENT_UNIT as isize));
292         self.s.word("}");
293         if close_box {
294             self.end(); // close the outer-box
295         }
296     }
297
298     pub fn bclose(&mut self, span: rustc_span::Span) {
299         self.bclose_maybe_open(span, true)
300     }
301
302     pub fn space_if_not_bol(&mut self) {
303         if !self.s.is_beginning_of_line() {
304             self.s.space();
305         }
306     }
307
308     pub fn break_offset_if_not_bol(&mut self, n: usize, off: isize) {
309         if !self.s.is_beginning_of_line() {
310             self.s.break_offset(n, off)
311         } else if off != 0 && self.s.last_token().is_hardbreak_tok() {
312             // We do something pretty sketchy here: tuck the nonzero
313             // offset-adjustment we were going to deposit along with the
314             // break into the previous hardbreak.
315             self.s.replace_last_token(pp::Printer::hardbreak_tok_offset(off));
316         }
317     }
318
319     // Synthesizes a comment that was not textually present in the original source
320     // file.
321     pub fn synth_comment(&mut self, text: String) {
322         self.s.word("/*");
323         self.s.space();
324         self.s.word(text);
325         self.s.space();
326         self.s.word("*/")
327     }
328
329     pub fn commasep_cmnt<T, F, G>(&mut self, b: Breaks, elts: &[T], mut op: F, mut get_span: G)
330     where
331         F: FnMut(&mut State<'_>, &T),
332         G: FnMut(&T) -> rustc_span::Span,
333     {
334         self.rbox(0, b);
335         let len = elts.len();
336         let mut i = 0;
337         for elt in elts {
338             self.maybe_print_comment(get_span(elt).hi());
339             op(self, elt);
340             i += 1;
341             if i < len {
342                 self.s.word(",");
343                 self.maybe_print_trailing_comment(get_span(elt), Some(get_span(&elts[i]).hi()));
344                 self.space_if_not_bol();
345             }
346         }
347         self.end();
348     }
349
350     pub fn commasep_exprs(&mut self, b: Breaks, exprs: &[hir::Expr<'_>]) {
351         self.commasep_cmnt(b, exprs, |s, e| s.print_expr(&e), |e| e.span)
352     }
353
354     pub fn print_mod(&mut self, _mod: &hir::Mod<'_>, attrs: &[ast::Attribute]) {
355         self.print_inner_attributes(attrs);
356         for &item_id in _mod.item_ids {
357             self.ann.nested(self, Nested::Item(item_id));
358         }
359     }
360
361     pub fn print_opt_lifetime(&mut self, lifetime: &hir::Lifetime) {
362         if !lifetime.is_elided() {
363             self.print_lifetime(lifetime);
364             self.nbsp();
365         }
366     }
367
368     pub fn print_type(&mut self, ty: &hir::Ty<'_>) {
369         self.maybe_print_comment(ty.span.lo());
370         self.ibox(0);
371         match ty.kind {
372             hir::TyKind::Slice(ref ty) => {
373                 self.s.word("[");
374                 self.print_type(&ty);
375                 self.s.word("]");
376             }
377             hir::TyKind::Ptr(ref mt) => {
378                 self.s.word("*");
379                 self.print_mt(mt, true);
380             }
381             hir::TyKind::Rptr(ref lifetime, ref mt) => {
382                 self.s.word("&");
383                 self.print_opt_lifetime(lifetime);
384                 self.print_mt(mt, false);
385             }
386             hir::TyKind::Never => {
387                 self.s.word("!");
388             }
389             hir::TyKind::Tup(ref elts) => {
390                 self.popen();
391                 self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(&ty));
392                 if elts.len() == 1 {
393                     self.s.word(",");
394                 }
395                 self.pclose();
396             }
397             hir::TyKind::BareFn(ref f) => {
398                 self.print_ty_fn(
399                     f.abi,
400                     f.unsafety,
401                     &f.decl,
402                     None,
403                     &f.generic_params,
404                     f.param_names,
405                 );
406             }
407             hir::TyKind::OpaqueDef(..) => self.s.word("/*impl Trait*/"),
408             hir::TyKind::Path(ref qpath) => self.print_qpath(qpath, false),
409             hir::TyKind::TraitObject(bounds, ref lifetime, syntax) => {
410                 if syntax == ast::TraitObjectSyntax::Dyn {
411                     self.word_space("dyn");
412                 }
413                 let mut first = true;
414                 for bound in bounds {
415                     if first {
416                         first = false;
417                     } else {
418                         self.nbsp();
419                         self.word_space("+");
420                     }
421                     self.print_poly_trait_ref(bound);
422                 }
423                 if !lifetime.is_elided() {
424                     self.nbsp();
425                     self.word_space("+");
426                     self.print_lifetime(lifetime);
427                 }
428             }
429             hir::TyKind::Array(ref ty, ref length) => {
430                 self.s.word("[");
431                 self.print_type(&ty);
432                 self.s.word("; ");
433                 self.print_anon_const(length);
434                 self.s.word("]");
435             }
436             hir::TyKind::Typeof(ref e) => {
437                 self.s.word("typeof(");
438                 self.print_anon_const(e);
439                 self.s.word(")");
440             }
441             hir::TyKind::Infer => {
442                 self.s.word("_");
443             }
444             hir::TyKind::Err => {
445                 self.popen();
446                 self.s.word("/*ERROR*/");
447                 self.pclose();
448             }
449         }
450         self.end()
451     }
452
453     pub fn print_foreign_item(&mut self, item: &hir::ForeignItem<'_>) {
454         self.hardbreak_if_not_bol();
455         self.maybe_print_comment(item.span.lo());
456         self.print_outer_attributes(self.attrs(item.hir_id()));
457         match item.kind {
458             hir::ForeignItemKind::Fn(ref decl, ref arg_names, ref generics) => {
459                 self.head("");
460                 self.print_fn(
461                     decl,
462                     hir::FnHeader {
463                         unsafety: hir::Unsafety::Normal,
464                         constness: hir::Constness::NotConst,
465                         abi: Abi::Rust,
466                         asyncness: hir::IsAsync::NotAsync,
467                     },
468                     Some(item.ident.name),
469                     generics,
470                     &item.vis,
471                     arg_names,
472                     None,
473                 );
474                 self.end(); // end head-ibox
475                 self.s.word(";");
476                 self.end() // end the outer fn box
477             }
478             hir::ForeignItemKind::Static(ref t, m) => {
479                 self.head(visibility_qualified(&item.vis, "static"));
480                 if m == hir::Mutability::Mut {
481                     self.word_space("mut");
482                 }
483                 self.print_ident(item.ident);
484                 self.word_space(":");
485                 self.print_type(&t);
486                 self.s.word(";");
487                 self.end(); // end the head-ibox
488                 self.end() // end the outer cbox
489             }
490             hir::ForeignItemKind::Type => {
491                 self.head(visibility_qualified(&item.vis, "type"));
492                 self.print_ident(item.ident);
493                 self.s.word(";");
494                 self.end(); // end the head-ibox
495                 self.end() // end the outer cbox
496             }
497         }
498     }
499
500     fn print_associated_const(
501         &mut self,
502         ident: Ident,
503         ty: &hir::Ty<'_>,
504         default: Option<hir::BodyId>,
505         vis: &hir::Visibility<'_>,
506     ) {
507         self.s.word(visibility_qualified(vis, ""));
508         self.word_space("const");
509         self.print_ident(ident);
510         self.word_space(":");
511         self.print_type(ty);
512         if let Some(expr) = default {
513             self.s.space();
514             self.word_space("=");
515             self.ann.nested(self, Nested::Body(expr));
516         }
517         self.s.word(";")
518     }
519
520     fn print_associated_type(
521         &mut self,
522         ident: Ident,
523         generics: &hir::Generics<'_>,
524         bounds: Option<hir::GenericBounds<'_>>,
525         ty: Option<&hir::Ty<'_>>,
526     ) {
527         self.word_space("type");
528         self.print_ident(ident);
529         self.print_generic_params(&generics.params);
530         if let Some(bounds) = bounds {
531             self.print_bounds(":", bounds);
532         }
533         self.print_where_clause(&generics.where_clause);
534         if let Some(ty) = ty {
535             self.s.space();
536             self.word_space("=");
537             self.print_type(ty);
538         }
539         self.s.word(";")
540     }
541
542     fn print_item_type(
543         &mut self,
544         item: &hir::Item<'_>,
545         generics: &hir::Generics<'_>,
546         inner: impl Fn(&mut Self),
547     ) {
548         self.head(visibility_qualified(&item.vis, "type"));
549         self.print_ident(item.ident);
550         self.print_generic_params(&generics.params);
551         self.end(); // end the inner ibox
552
553         self.print_where_clause(&generics.where_clause);
554         self.s.space();
555         inner(self);
556         self.s.word(";");
557         self.end(); // end the outer ibox
558     }
559
560     /// Pretty-print an item
561     pub fn print_item(&mut self, item: &hir::Item<'_>) {
562         self.hardbreak_if_not_bol();
563         self.maybe_print_comment(item.span.lo());
564         let attrs = self.attrs(item.hir_id());
565         self.print_outer_attributes(attrs);
566         self.ann.pre(self, AnnNode::Item(item));
567         match item.kind {
568             hir::ItemKind::ExternCrate(orig_name) => {
569                 self.head(visibility_qualified(&item.vis, "extern crate"));
570                 if let Some(orig_name) = orig_name {
571                     self.print_name(orig_name);
572                     self.s.space();
573                     self.s.word("as");
574                     self.s.space();
575                 }
576                 self.print_ident(item.ident);
577                 self.s.word(";");
578                 self.end(); // end inner head-block
579                 self.end(); // end outer head-block
580             }
581             hir::ItemKind::Use(ref path, kind) => {
582                 self.head(visibility_qualified(&item.vis, "use"));
583                 self.print_path(path, false);
584
585                 match kind {
586                     hir::UseKind::Single => {
587                         if path.segments.last().unwrap().ident != item.ident {
588                             self.s.space();
589                             self.word_space("as");
590                             self.print_ident(item.ident);
591                         }
592                         self.s.word(";");
593                     }
594                     hir::UseKind::Glob => self.s.word("::*;"),
595                     hir::UseKind::ListStem => self.s.word("::{};"),
596                 }
597                 self.end(); // end inner head-block
598                 self.end(); // end outer head-block
599             }
600             hir::ItemKind::Static(ref ty, m, expr) => {
601                 self.head(visibility_qualified(&item.vis, "static"));
602                 if m == hir::Mutability::Mut {
603                     self.word_space("mut");
604                 }
605                 self.print_ident(item.ident);
606                 self.word_space(":");
607                 self.print_type(&ty);
608                 self.s.space();
609                 self.end(); // end the head-ibox
610
611                 self.word_space("=");
612                 self.ann.nested(self, Nested::Body(expr));
613                 self.s.word(";");
614                 self.end(); // end the outer cbox
615             }
616             hir::ItemKind::Const(ref ty, expr) => {
617                 self.head(visibility_qualified(&item.vis, "const"));
618                 self.print_ident(item.ident);
619                 self.word_space(":");
620                 self.print_type(&ty);
621                 self.s.space();
622                 self.end(); // end the head-ibox
623
624                 self.word_space("=");
625                 self.ann.nested(self, Nested::Body(expr));
626                 self.s.word(";");
627                 self.end(); // end the outer cbox
628             }
629             hir::ItemKind::Fn(ref sig, ref param_names, body) => {
630                 self.head("");
631                 self.print_fn(
632                     &sig.decl,
633                     sig.header,
634                     Some(item.ident.name),
635                     param_names,
636                     &item.vis,
637                     &[],
638                     Some(body),
639                 );
640                 self.s.word(" ");
641                 self.end(); // need to close a box
642                 self.end(); // need to close a box
643                 self.ann.nested(self, Nested::Body(body));
644             }
645             hir::ItemKind::Mod(ref _mod) => {
646                 self.head(visibility_qualified(&item.vis, "mod"));
647                 self.print_ident(item.ident);
648                 self.nbsp();
649                 self.bopen();
650                 self.print_mod(_mod, attrs);
651                 self.bclose(item.span);
652             }
653             hir::ItemKind::ForeignMod { abi, items } => {
654                 self.head("extern");
655                 self.word_nbsp(abi.to_string());
656                 self.bopen();
657                 self.print_inner_attributes(self.attrs(item.hir_id()));
658                 for item in items {
659                     self.ann.nested(self, Nested::ForeignItem(item.id));
660                 }
661                 self.bclose(item.span);
662             }
663             hir::ItemKind::GlobalAsm(ref ga) => {
664                 self.head(visibility_qualified(&item.vis, "global asm"));
665                 self.s.word(ga.asm.to_string());
666                 self.end()
667             }
668             hir::ItemKind::TyAlias(ref ty, ref generics) => {
669                 self.print_item_type(item, &generics, |state| {
670                     state.word_space("=");
671                     state.print_type(&ty);
672                 });
673             }
674             hir::ItemKind::OpaqueTy(ref opaque_ty) => {
675                 self.print_item_type(item, &opaque_ty.generics, |state| {
676                     let mut real_bounds = Vec::with_capacity(opaque_ty.bounds.len());
677                     for b in opaque_ty.bounds.iter() {
678                         if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
679                             state.s.space();
680                             state.word_space("for ?");
681                             state.print_trait_ref(&ptr.trait_ref);
682                         } else {
683                             real_bounds.push(b);
684                         }
685                     }
686                     state.print_bounds("= impl", real_bounds);
687                 });
688             }
689             hir::ItemKind::Enum(ref enum_definition, ref params) => {
690                 self.print_enum_def(enum_definition, params, item.ident.name, item.span, &item.vis);
691             }
692             hir::ItemKind::Struct(ref struct_def, ref generics) => {
693                 self.head(visibility_qualified(&item.vis, "struct"));
694                 self.print_struct(struct_def, generics, item.ident.name, item.span, true);
695             }
696             hir::ItemKind::Union(ref struct_def, ref generics) => {
697                 self.head(visibility_qualified(&item.vis, "union"));
698                 self.print_struct(struct_def, generics, item.ident.name, item.span, true);
699             }
700             hir::ItemKind::Impl(hir::Impl {
701                 unsafety,
702                 polarity,
703                 defaultness,
704                 constness,
705                 defaultness_span: _,
706                 ref generics,
707                 ref of_trait,
708                 ref self_ty,
709                 items,
710             }) => {
711                 self.head("");
712                 self.print_visibility(&item.vis);
713                 self.print_defaultness(defaultness);
714                 self.print_unsafety(unsafety);
715                 self.word_nbsp("impl");
716
717                 if !generics.params.is_empty() {
718                     self.print_generic_params(&generics.params);
719                     self.s.space();
720                 }
721
722                 if constness == hir::Constness::Const {
723                     self.word_nbsp("const");
724                 }
725
726                 if let hir::ImplPolarity::Negative(_) = polarity {
727                     self.s.word("!");
728                 }
729
730                 if let Some(ref t) = of_trait {
731                     self.print_trait_ref(t);
732                     self.s.space();
733                     self.word_space("for");
734                 }
735
736                 self.print_type(&self_ty);
737                 self.print_where_clause(&generics.where_clause);
738
739                 self.s.space();
740                 self.bopen();
741                 self.print_inner_attributes(attrs);
742                 for impl_item in items {
743                     self.ann.nested(self, Nested::ImplItem(impl_item.id));
744                 }
745                 self.bclose(item.span);
746             }
747             hir::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, trait_items) => {
748                 self.head("");
749                 self.print_visibility(&item.vis);
750                 self.print_is_auto(is_auto);
751                 self.print_unsafety(unsafety);
752                 self.word_nbsp("trait");
753                 self.print_ident(item.ident);
754                 self.print_generic_params(&generics.params);
755                 let mut real_bounds = Vec::with_capacity(bounds.len());
756                 for b in bounds.iter() {
757                     if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
758                         self.s.space();
759                         self.word_space("for ?");
760                         self.print_trait_ref(&ptr.trait_ref);
761                     } else {
762                         real_bounds.push(b);
763                     }
764                 }
765                 self.print_bounds(":", real_bounds);
766                 self.print_where_clause(&generics.where_clause);
767                 self.s.word(" ");
768                 self.bopen();
769                 for trait_item in trait_items {
770                     self.ann.nested(self, Nested::TraitItem(trait_item.id));
771                 }
772                 self.bclose(item.span);
773             }
774             hir::ItemKind::TraitAlias(ref generics, ref bounds) => {
775                 self.head("");
776                 self.print_visibility(&item.vis);
777                 self.word_nbsp("trait");
778                 self.print_ident(item.ident);
779                 self.print_generic_params(&generics.params);
780                 let mut real_bounds = Vec::with_capacity(bounds.len());
781                 // FIXME(durka) this seems to be some quite outdated syntax
782                 for b in bounds.iter() {
783                     if let GenericBound::Trait(ref ptr, hir::TraitBoundModifier::Maybe) = *b {
784                         self.s.space();
785                         self.word_space("for ?");
786                         self.print_trait_ref(&ptr.trait_ref);
787                     } else {
788                         real_bounds.push(b);
789                     }
790                 }
791                 self.nbsp();
792                 self.print_bounds("=", real_bounds);
793                 self.print_where_clause(&generics.where_clause);
794                 self.s.word(";");
795             }
796         }
797         self.ann.post(self, AnnNode::Item(item))
798     }
799
800     pub fn print_trait_ref(&mut self, t: &hir::TraitRef<'_>) {
801         self.print_path(&t.path, false)
802     }
803
804     fn print_formal_generic_params(&mut self, generic_params: &[hir::GenericParam<'_>]) {
805         if !generic_params.is_empty() {
806             self.s.word("for");
807             self.print_generic_params(generic_params);
808             self.nbsp();
809         }
810     }
811
812     fn print_poly_trait_ref(&mut self, t: &hir::PolyTraitRef<'_>) {
813         self.print_formal_generic_params(&t.bound_generic_params);
814         self.print_trait_ref(&t.trait_ref)
815     }
816
817     pub fn print_enum_def(
818         &mut self,
819         enum_definition: &hir::EnumDef<'_>,
820         generics: &hir::Generics<'_>,
821         name: Symbol,
822         span: rustc_span::Span,
823         visibility: &hir::Visibility<'_>,
824     ) {
825         self.head(visibility_qualified(visibility, "enum"));
826         self.print_name(name);
827         self.print_generic_params(&generics.params);
828         self.print_where_clause(&generics.where_clause);
829         self.s.space();
830         self.print_variants(&enum_definition.variants, span)
831     }
832
833     pub fn print_variants(&mut self, variants: &[hir::Variant<'_>], span: rustc_span::Span) {
834         self.bopen();
835         for v in variants {
836             self.space_if_not_bol();
837             self.maybe_print_comment(v.span.lo());
838             self.print_outer_attributes(self.attrs(v.id));
839             self.ibox(INDENT_UNIT);
840             self.print_variant(v);
841             self.s.word(",");
842             self.end();
843             self.maybe_print_trailing_comment(v.span, None);
844         }
845         self.bclose(span)
846     }
847
848     pub fn print_visibility(&mut self, vis: &hir::Visibility<'_>) {
849         match vis.node {
850             hir::VisibilityKind::Public => self.word_nbsp("pub"),
851             hir::VisibilityKind::Crate(ast::CrateSugar::JustCrate) => self.word_nbsp("crate"),
852             hir::VisibilityKind::Crate(ast::CrateSugar::PubCrate) => self.word_nbsp("pub(crate)"),
853             hir::VisibilityKind::Restricted { ref path, .. } => {
854                 self.s.word("pub(");
855                 if path.segments.len() == 1 && path.segments[0].ident.name == kw::Super {
856                     // Special case: `super` can print like `pub(super)`.
857                     self.s.word("super");
858                 } else {
859                     // Everything else requires `in` at present.
860                     self.word_nbsp("in");
861                     self.print_path(path, false);
862                 }
863                 self.word_nbsp(")");
864             }
865             hir::VisibilityKind::Inherited => (),
866         }
867     }
868
869     pub fn print_defaultness(&mut self, defaultness: hir::Defaultness) {
870         match defaultness {
871             hir::Defaultness::Default { .. } => self.word_nbsp("default"),
872             hir::Defaultness::Final => (),
873         }
874     }
875
876     pub fn print_struct(
877         &mut self,
878         struct_def: &hir::VariantData<'_>,
879         generics: &hir::Generics<'_>,
880         name: Symbol,
881         span: rustc_span::Span,
882         print_finalizer: bool,
883     ) {
884         self.print_name(name);
885         self.print_generic_params(&generics.params);
886         match struct_def {
887             hir::VariantData::Tuple(..) | hir::VariantData::Unit(..) => {
888                 if let hir::VariantData::Tuple(..) = struct_def {
889                     self.popen();
890                     self.commasep(Inconsistent, struct_def.fields(), |s, field| {
891                         s.maybe_print_comment(field.span.lo());
892                         s.print_outer_attributes(s.attrs(field.hir_id));
893                         s.print_visibility(&field.vis);
894                         s.print_type(&field.ty)
895                     });
896                     self.pclose();
897                 }
898                 self.print_where_clause(&generics.where_clause);
899                 if print_finalizer {
900                     self.s.word(";");
901                 }
902                 self.end();
903                 self.end() // close the outer-box
904             }
905             hir::VariantData::Struct(..) => {
906                 self.print_where_clause(&generics.where_clause);
907                 self.nbsp();
908                 self.bopen();
909                 self.hardbreak_if_not_bol();
910
911                 for field in struct_def.fields() {
912                     self.hardbreak_if_not_bol();
913                     self.maybe_print_comment(field.span.lo());
914                     self.print_outer_attributes(self.attrs(field.hir_id));
915                     self.print_visibility(&field.vis);
916                     self.print_ident(field.ident);
917                     self.word_nbsp(":");
918                     self.print_type(&field.ty);
919                     self.s.word(",");
920                 }
921
922                 self.bclose(span)
923             }
924         }
925     }
926
927     pub fn print_variant(&mut self, v: &hir::Variant<'_>) {
928         self.head("");
929         let generics = hir::Generics::empty();
930         self.print_struct(&v.data, &generics, v.ident.name, v.span, false);
931         if let Some(ref d) = v.disr_expr {
932             self.s.space();
933             self.word_space("=");
934             self.print_anon_const(d);
935         }
936     }
937     pub fn print_method_sig(
938         &mut self,
939         ident: Ident,
940         m: &hir::FnSig<'_>,
941         generics: &hir::Generics<'_>,
942         vis: &hir::Visibility<'_>,
943         arg_names: &[Ident],
944         body_id: Option<hir::BodyId>,
945     ) {
946         self.print_fn(&m.decl, m.header, Some(ident.name), generics, vis, arg_names, body_id)
947     }
948
949     pub fn print_trait_item(&mut self, ti: &hir::TraitItem<'_>) {
950         self.ann.pre(self, AnnNode::SubItem(ti.hir_id()));
951         self.hardbreak_if_not_bol();
952         self.maybe_print_comment(ti.span.lo());
953         self.print_outer_attributes(self.attrs(ti.hir_id()));
954         match ti.kind {
955             hir::TraitItemKind::Const(ref ty, default) => {
956                 let vis =
957                     Spanned { span: rustc_span::DUMMY_SP, node: hir::VisibilityKind::Inherited };
958                 self.print_associated_const(ti.ident, &ty, default, &vis);
959             }
960             hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Required(ref arg_names)) => {
961                 let vis =
962                     Spanned { span: rustc_span::DUMMY_SP, node: hir::VisibilityKind::Inherited };
963                 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, arg_names, None);
964                 self.s.word(";");
965             }
966             hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
967                 let vis =
968                     Spanned { span: rustc_span::DUMMY_SP, node: hir::VisibilityKind::Inherited };
969                 self.head("");
970                 self.print_method_sig(ti.ident, sig, &ti.generics, &vis, &[], Some(body));
971                 self.nbsp();
972                 self.end(); // need to close a box
973                 self.end(); // need to close a box
974                 self.ann.nested(self, Nested::Body(body));
975             }
976             hir::TraitItemKind::Type(ref bounds, ref default) => {
977                 self.print_associated_type(
978                     ti.ident,
979                     &ti.generics,
980                     Some(bounds),
981                     default.as_ref().map(|ty| &**ty),
982                 );
983             }
984         }
985         self.ann.post(self, AnnNode::SubItem(ti.hir_id()))
986     }
987
988     pub fn print_impl_item(&mut self, ii: &hir::ImplItem<'_>) {
989         self.ann.pre(self, AnnNode::SubItem(ii.hir_id()));
990         self.hardbreak_if_not_bol();
991         self.maybe_print_comment(ii.span.lo());
992         self.print_outer_attributes(self.attrs(ii.hir_id()));
993         self.print_defaultness(ii.defaultness);
994
995         match ii.kind {
996             hir::ImplItemKind::Const(ref ty, expr) => {
997                 self.print_associated_const(ii.ident, &ty, Some(expr), &ii.vis);
998             }
999             hir::ImplItemKind::Fn(ref sig, body) => {
1000                 self.head("");
1001                 self.print_method_sig(ii.ident, sig, &ii.generics, &ii.vis, &[], Some(body));
1002                 self.nbsp();
1003                 self.end(); // need to close a box
1004                 self.end(); // need to close a box
1005                 self.ann.nested(self, Nested::Body(body));
1006             }
1007             hir::ImplItemKind::TyAlias(ref ty) => {
1008                 self.print_associated_type(ii.ident, &ii.generics, None, Some(ty));
1009             }
1010         }
1011         self.ann.post(self, AnnNode::SubItem(ii.hir_id()))
1012     }
1013
1014     pub fn print_local(&mut self, init: Option<&hir::Expr<'_>>, decl: impl Fn(&mut Self)) {
1015         self.space_if_not_bol();
1016         self.ibox(INDENT_UNIT);
1017         self.word_nbsp("let");
1018
1019         self.ibox(INDENT_UNIT);
1020         decl(self);
1021         self.end();
1022
1023         if let Some(ref init) = init {
1024             self.nbsp();
1025             self.word_space("=");
1026             self.print_expr(&init);
1027         }
1028         self.end()
1029     }
1030
1031     pub fn print_stmt(&mut self, st: &hir::Stmt<'_>) {
1032         self.maybe_print_comment(st.span.lo());
1033         match st.kind {
1034             hir::StmtKind::Local(ref loc) => {
1035                 self.print_local(loc.init.as_deref(), |this| this.print_local_decl(&loc));
1036             }
1037             hir::StmtKind::Item(item) => self.ann.nested(self, Nested::Item(item)),
1038             hir::StmtKind::Expr(ref expr) => {
1039                 self.space_if_not_bol();
1040                 self.print_expr(&expr);
1041             }
1042             hir::StmtKind::Semi(ref expr) => {
1043                 self.space_if_not_bol();
1044                 self.print_expr(&expr);
1045                 self.s.word(";");
1046             }
1047         }
1048         if stmt_ends_with_semi(&st.kind) {
1049             self.s.word(";");
1050         }
1051         self.maybe_print_trailing_comment(st.span, None)
1052     }
1053
1054     pub fn print_block(&mut self, blk: &hir::Block<'_>) {
1055         self.print_block_with_attrs(blk, &[])
1056     }
1057
1058     pub fn print_block_unclosed(&mut self, blk: &hir::Block<'_>) {
1059         self.print_block_maybe_unclosed(blk, &[], false)
1060     }
1061
1062     pub fn print_block_with_attrs(&mut self, blk: &hir::Block<'_>, attrs: &[ast::Attribute]) {
1063         self.print_block_maybe_unclosed(blk, attrs, true)
1064     }
1065
1066     pub fn print_block_maybe_unclosed(
1067         &mut self,
1068         blk: &hir::Block<'_>,
1069         attrs: &[ast::Attribute],
1070         close_box: bool,
1071     ) {
1072         match blk.rules {
1073             hir::BlockCheckMode::UnsafeBlock(..) => self.word_space("unsafe"),
1074             hir::BlockCheckMode::PushUnsafeBlock(..) => self.word_space("push_unsafe"),
1075             hir::BlockCheckMode::PopUnsafeBlock(..) => self.word_space("pop_unsafe"),
1076             hir::BlockCheckMode::DefaultBlock => (),
1077         }
1078         self.maybe_print_comment(blk.span.lo());
1079         self.ann.pre(self, AnnNode::Block(blk));
1080         self.bopen();
1081
1082         self.print_inner_attributes(attrs);
1083
1084         for st in blk.stmts {
1085             self.print_stmt(st);
1086         }
1087         if let Some(ref expr) = blk.expr {
1088             self.space_if_not_bol();
1089             self.print_expr(&expr);
1090             self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi()));
1091         }
1092         self.bclose_maybe_open(blk.span, close_box);
1093         self.ann.post(self, AnnNode::Block(blk))
1094     }
1095
1096     fn print_else(&mut self, els: Option<&hir::Expr<'_>>) {
1097         match els {
1098             Some(_else) => {
1099                 match _else.kind {
1100                     // "another else-if"
1101                     hir::ExprKind::If(ref i, ref then, ref e) => {
1102                         self.cbox(INDENT_UNIT - 1);
1103                         self.ibox(0);
1104                         self.s.word(" else if ");
1105                         self.print_expr_as_cond(&i);
1106                         self.s.space();
1107                         self.print_expr(&then);
1108                         self.print_else(e.as_ref().map(|e| &**e))
1109                     }
1110                     // "final else"
1111                     hir::ExprKind::Block(ref b, _) => {
1112                         self.cbox(INDENT_UNIT - 1);
1113                         self.ibox(0);
1114                         self.s.word(" else ");
1115                         self.print_block(&b)
1116                     }
1117                     // BLEAH, constraints would be great here
1118                     _ => {
1119                         panic!("print_if saw if with weird alternative");
1120                     }
1121                 }
1122             }
1123             _ => {}
1124         }
1125     }
1126
1127     pub fn print_if(
1128         &mut self,
1129         test: &hir::Expr<'_>,
1130         blk: &hir::Expr<'_>,
1131         elseopt: Option<&hir::Expr<'_>>,
1132     ) {
1133         self.head("if");
1134         self.print_expr_as_cond(test);
1135         self.s.space();
1136         self.print_expr(blk);
1137         self.print_else(elseopt)
1138     }
1139
1140     pub fn print_anon_const(&mut self, constant: &hir::AnonConst) {
1141         self.ann.nested(self, Nested::Body(constant.body))
1142     }
1143
1144     fn print_call_post(&mut self, args: &[hir::Expr<'_>]) {
1145         self.popen();
1146         self.commasep_exprs(Inconsistent, args);
1147         self.pclose()
1148     }
1149
1150     pub fn print_expr_maybe_paren(&mut self, expr: &hir::Expr<'_>, prec: i8) {
1151         let needs_par = expr.precedence().order() < prec;
1152         if needs_par {
1153             self.popen();
1154         }
1155         self.print_expr(expr);
1156         if needs_par {
1157             self.pclose();
1158         }
1159     }
1160
1161     /// Print an expr using syntax that's acceptable in a condition position, such as the `cond` in
1162     /// `if cond { ... }`.
1163     pub fn print_expr_as_cond(&mut self, expr: &hir::Expr<'_>) {
1164         let needs_par = match expr.kind {
1165             // These cases need parens due to the parse error observed in #26461: `if return {}`
1166             // parses as the erroneous construct `if (return {})`, not `if (return) {}`.
1167             hir::ExprKind::Closure(..) | hir::ExprKind::Ret(..) | hir::ExprKind::Break(..) => true,
1168
1169             _ => contains_exterior_struct_lit(expr),
1170         };
1171
1172         if needs_par {
1173             self.popen();
1174         }
1175         self.print_expr(expr);
1176         if needs_par {
1177             self.pclose();
1178         }
1179     }
1180
1181     fn print_expr_vec(&mut self, exprs: &[hir::Expr<'_>]) {
1182         self.ibox(INDENT_UNIT);
1183         self.s.word("[");
1184         self.commasep_exprs(Inconsistent, exprs);
1185         self.s.word("]");
1186         self.end()
1187     }
1188
1189     fn print_expr_anon_const(&mut self, anon_const: &hir::AnonConst) {
1190         self.ibox(INDENT_UNIT);
1191         self.s.word_space("const");
1192         self.print_anon_const(anon_const);
1193         self.end()
1194     }
1195
1196     fn print_expr_repeat(&mut self, element: &hir::Expr<'_>, count: &hir::AnonConst) {
1197         self.ibox(INDENT_UNIT);
1198         self.s.word("[");
1199         self.print_expr(element);
1200         self.word_space(";");
1201         self.print_anon_const(count);
1202         self.s.word("]");
1203         self.end()
1204     }
1205
1206     fn print_expr_struct(
1207         &mut self,
1208         qpath: &hir::QPath<'_>,
1209         fields: &[hir::ExprField<'_>],
1210         wth: &Option<&hir::Expr<'_>>,
1211     ) {
1212         self.print_qpath(qpath, true);
1213         self.s.word("{");
1214         self.commasep_cmnt(
1215             Consistent,
1216             fields,
1217             |s, field| {
1218                 s.ibox(INDENT_UNIT);
1219                 if !field.is_shorthand {
1220                     s.print_ident(field.ident);
1221                     s.word_space(":");
1222                 }
1223                 s.print_expr(&field.expr);
1224                 s.end()
1225             },
1226             |f| f.span,
1227         );
1228         match *wth {
1229             Some(ref expr) => {
1230                 self.ibox(INDENT_UNIT);
1231                 if !fields.is_empty() {
1232                     self.s.word(",");
1233                     self.s.space();
1234                 }
1235                 self.s.word("..");
1236                 self.print_expr(&expr);
1237                 self.end();
1238             }
1239             _ => {
1240                 if !fields.is_empty() {
1241                     self.s.word(",")
1242                 }
1243             }
1244         }
1245         self.s.word("}");
1246     }
1247
1248     fn print_expr_tup(&mut self, exprs: &[hir::Expr<'_>]) {
1249         self.popen();
1250         self.commasep_exprs(Inconsistent, exprs);
1251         if exprs.len() == 1 {
1252             self.s.word(",");
1253         }
1254         self.pclose()
1255     }
1256
1257     fn print_expr_call(&mut self, func: &hir::Expr<'_>, args: &[hir::Expr<'_>]) {
1258         let prec = match func.kind {
1259             hir::ExprKind::Field(..) => parser::PREC_FORCE_PAREN,
1260             _ => parser::PREC_POSTFIX,
1261         };
1262
1263         self.print_expr_maybe_paren(func, prec);
1264         self.print_call_post(args)
1265     }
1266
1267     fn print_expr_method_call(&mut self, segment: &hir::PathSegment<'_>, args: &[hir::Expr<'_>]) {
1268         let base_args = &args[1..];
1269         self.print_expr_maybe_paren(&args[0], parser::PREC_POSTFIX);
1270         self.s.word(".");
1271         self.print_ident(segment.ident);
1272
1273         let generic_args = segment.args();
1274         if !generic_args.args.is_empty() || !generic_args.bindings.is_empty() {
1275             self.print_generic_args(generic_args, segment.infer_args, true);
1276         }
1277
1278         self.print_call_post(base_args)
1279     }
1280
1281     fn print_expr_binary(&mut self, op: hir::BinOp, lhs: &hir::Expr<'_>, rhs: &hir::Expr<'_>) {
1282         let assoc_op = bin_op_to_assoc_op(op.node);
1283         let prec = assoc_op.precedence() as i8;
1284         let fixity = assoc_op.fixity();
1285
1286         let (left_prec, right_prec) = match fixity {
1287             Fixity::Left => (prec, prec + 1),
1288             Fixity::Right => (prec + 1, prec),
1289             Fixity::None => (prec + 1, prec + 1),
1290         };
1291
1292         let left_prec = match (&lhs.kind, op.node) {
1293             // These cases need parens: `x as i32 < y` has the parser thinking that `i32 < y` is
1294             // the beginning of a path type. It starts trying to parse `x as (i32 < y ...` instead
1295             // of `(x as i32) < ...`. We need to convince it _not_ to do that.
1296             (&hir::ExprKind::Cast { .. }, hir::BinOpKind::Lt | hir::BinOpKind::Shl) => {
1297                 parser::PREC_FORCE_PAREN
1298             }
1299             _ => left_prec,
1300         };
1301
1302         self.print_expr_maybe_paren(lhs, left_prec);
1303         self.s.space();
1304         self.word_space(op.node.as_str());
1305         self.print_expr_maybe_paren(rhs, right_prec)
1306     }
1307
1308     fn print_expr_unary(&mut self, op: hir::UnOp, expr: &hir::Expr<'_>) {
1309         self.s.word(op.as_str());
1310         self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1311     }
1312
1313     fn print_expr_addr_of(
1314         &mut self,
1315         kind: hir::BorrowKind,
1316         mutability: hir::Mutability,
1317         expr: &hir::Expr<'_>,
1318     ) {
1319         self.s.word("&");
1320         match kind {
1321             hir::BorrowKind::Ref => self.print_mutability(mutability, false),
1322             hir::BorrowKind::Raw => {
1323                 self.word_nbsp("raw");
1324                 self.print_mutability(mutability, true);
1325             }
1326         }
1327         self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1328     }
1329
1330     fn print_literal(&mut self, lit: &hir::Lit) {
1331         self.maybe_print_comment(lit.span.lo());
1332         self.word(lit.node.to_lit_token().to_string())
1333     }
1334
1335     pub fn print_expr(&mut self, expr: &hir::Expr<'_>) {
1336         self.maybe_print_comment(expr.span.lo());
1337         self.print_outer_attributes(self.attrs(expr.hir_id));
1338         self.ibox(INDENT_UNIT);
1339         self.ann.pre(self, AnnNode::Expr(expr));
1340         match expr.kind {
1341             hir::ExprKind::Box(ref expr) => {
1342                 self.word_space("box");
1343                 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX);
1344             }
1345             hir::ExprKind::Array(ref exprs) => {
1346                 self.print_expr_vec(exprs);
1347             }
1348             hir::ExprKind::ConstBlock(ref anon_const) => {
1349                 self.print_expr_anon_const(anon_const);
1350             }
1351             hir::ExprKind::Repeat(ref element, ref count) => {
1352                 self.print_expr_repeat(&element, count);
1353             }
1354             hir::ExprKind::Struct(ref qpath, fields, ref wth) => {
1355                 self.print_expr_struct(qpath, fields, wth);
1356             }
1357             hir::ExprKind::Tup(ref exprs) => {
1358                 self.print_expr_tup(exprs);
1359             }
1360             hir::ExprKind::Call(ref func, ref args) => {
1361                 self.print_expr_call(&func, args);
1362             }
1363             hir::ExprKind::MethodCall(ref segment, _, ref args, _) => {
1364                 self.print_expr_method_call(segment, args);
1365             }
1366             hir::ExprKind::Binary(op, ref lhs, ref rhs) => {
1367                 self.print_expr_binary(op, &lhs, &rhs);
1368             }
1369             hir::ExprKind::Unary(op, ref expr) => {
1370                 self.print_expr_unary(op, &expr);
1371             }
1372             hir::ExprKind::AddrOf(k, m, ref expr) => {
1373                 self.print_expr_addr_of(k, m, &expr);
1374             }
1375             hir::ExprKind::Lit(ref lit) => {
1376                 self.print_literal(&lit);
1377             }
1378             hir::ExprKind::Cast(ref expr, ref ty) => {
1379                 let prec = AssocOp::As.precedence() as i8;
1380                 self.print_expr_maybe_paren(&expr, prec);
1381                 self.s.space();
1382                 self.word_space("as");
1383                 self.print_type(&ty);
1384             }
1385             hir::ExprKind::Type(ref expr, ref ty) => {
1386                 let prec = AssocOp::Colon.precedence() as i8;
1387                 self.print_expr_maybe_paren(&expr, prec);
1388                 self.word_space(":");
1389                 self.print_type(&ty);
1390             }
1391             hir::ExprKind::DropTemps(ref init) => {
1392                 // Print `{`:
1393                 self.cbox(INDENT_UNIT);
1394                 self.ibox(0);
1395                 self.bopen();
1396
1397                 // Print `let _t = $init;`:
1398                 let temp = Ident::from_str("_t");
1399                 self.print_local(Some(init), |this| this.print_ident(temp));
1400                 self.s.word(";");
1401
1402                 // Print `_t`:
1403                 self.space_if_not_bol();
1404                 self.print_ident(temp);
1405
1406                 // Print `}`:
1407                 self.bclose_maybe_open(expr.span, true);
1408             }
1409             hir::ExprKind::If(ref test, ref blk, ref elseopt) => {
1410                 self.print_if(&test, &blk, elseopt.as_ref().map(|e| &**e));
1411             }
1412             hir::ExprKind::Loop(ref blk, opt_label, _, _) => {
1413                 if let Some(label) = opt_label {
1414                     self.print_ident(label.ident);
1415                     self.word_space(":");
1416                 }
1417                 self.head("loop");
1418                 self.s.space();
1419                 self.print_block(&blk);
1420             }
1421             hir::ExprKind::Match(ref expr, arms, _) => {
1422                 self.cbox(INDENT_UNIT);
1423                 self.ibox(INDENT_UNIT);
1424                 self.word_nbsp("match");
1425                 self.print_expr_as_cond(&expr);
1426                 self.s.space();
1427                 self.bopen();
1428                 for arm in arms {
1429                     self.print_arm(arm);
1430                 }
1431                 self.bclose(expr.span);
1432             }
1433             hir::ExprKind::Closure(capture_clause, ref decl, body, _fn_decl_span, _gen) => {
1434                 self.print_capture_clause(capture_clause);
1435
1436                 self.print_closure_params(&decl, body);
1437                 self.s.space();
1438
1439                 // This is a bare expression.
1440                 self.ann.nested(self, Nested::Body(body));
1441                 self.end(); // need to close a box
1442
1443                 // A box will be closed by `print_expr`, but we didn't want an overall
1444                 // wrapper so we closed the corresponding opening. so create an
1445                 // empty box to satisfy the close.
1446                 self.ibox(0);
1447             }
1448             hir::ExprKind::Block(ref blk, opt_label) => {
1449                 if let Some(label) = opt_label {
1450                     self.print_ident(label.ident);
1451                     self.word_space(":");
1452                 }
1453                 // containing cbox, will be closed by print-block at `}`
1454                 self.cbox(INDENT_UNIT);
1455                 // head-box, will be closed by print-block after `{`
1456                 self.ibox(0);
1457                 self.print_block(&blk);
1458             }
1459             hir::ExprKind::Assign(ref lhs, ref rhs, _) => {
1460                 let prec = AssocOp::Assign.precedence() as i8;
1461                 self.print_expr_maybe_paren(&lhs, prec + 1);
1462                 self.s.space();
1463                 self.word_space("=");
1464                 self.print_expr_maybe_paren(&rhs, prec);
1465             }
1466             hir::ExprKind::AssignOp(op, ref lhs, ref rhs) => {
1467                 let prec = AssocOp::Assign.precedence() as i8;
1468                 self.print_expr_maybe_paren(&lhs, prec + 1);
1469                 self.s.space();
1470                 self.s.word(op.node.as_str());
1471                 self.word_space("=");
1472                 self.print_expr_maybe_paren(&rhs, prec);
1473             }
1474             hir::ExprKind::Field(ref expr, ident) => {
1475                 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX);
1476                 self.s.word(".");
1477                 self.print_ident(ident);
1478             }
1479             hir::ExprKind::Index(ref expr, ref index) => {
1480                 self.print_expr_maybe_paren(&expr, parser::PREC_POSTFIX);
1481                 self.s.word("[");
1482                 self.print_expr(&index);
1483                 self.s.word("]");
1484             }
1485             hir::ExprKind::Path(ref qpath) => self.print_qpath(qpath, true),
1486             hir::ExprKind::Break(destination, ref opt_expr) => {
1487                 self.s.word("break");
1488                 self.s.space();
1489                 if let Some(label) = destination.label {
1490                     self.print_ident(label.ident);
1491                     self.s.space();
1492                 }
1493                 if let Some(ref expr) = *opt_expr {
1494                     self.print_expr_maybe_paren(expr, parser::PREC_JUMP);
1495                     self.s.space();
1496                 }
1497             }
1498             hir::ExprKind::Continue(destination) => {
1499                 self.s.word("continue");
1500                 self.s.space();
1501                 if let Some(label) = destination.label {
1502                     self.print_ident(label.ident);
1503                     self.s.space()
1504                 }
1505             }
1506             hir::ExprKind::Ret(ref result) => {
1507                 self.s.word("return");
1508                 if let Some(ref expr) = *result {
1509                     self.s.word(" ");
1510                     self.print_expr_maybe_paren(&expr, parser::PREC_JUMP);
1511                 }
1512             }
1513             hir::ExprKind::InlineAsm(ref a) => {
1514                 enum AsmArg<'a> {
1515                     Template(String),
1516                     Operand(&'a hir::InlineAsmOperand<'a>),
1517                     Options(ast::InlineAsmOptions),
1518                 }
1519
1520                 let mut args = vec![];
1521                 args.push(AsmArg::Template(ast::InlineAsmTemplatePiece::to_string(&a.template)));
1522                 args.extend(a.operands.iter().map(|(o, _)| AsmArg::Operand(o)));
1523                 if !a.options.is_empty() {
1524                     args.push(AsmArg::Options(a.options));
1525                 }
1526
1527                 self.word("asm!");
1528                 self.popen();
1529                 self.commasep(Consistent, &args, |s, arg| match arg {
1530                     AsmArg::Template(template) => s.print_string(&template, ast::StrStyle::Cooked),
1531                     AsmArg::Operand(op) => match op {
1532                         hir::InlineAsmOperand::In { reg, expr } => {
1533                             s.word("in");
1534                             s.popen();
1535                             s.word(format!("{}", reg));
1536                             s.pclose();
1537                             s.space();
1538                             s.print_expr(expr);
1539                         }
1540                         hir::InlineAsmOperand::Out { reg, late, expr } => {
1541                             s.word(if *late { "lateout" } else { "out" });
1542                             s.popen();
1543                             s.word(format!("{}", reg));
1544                             s.pclose();
1545                             s.space();
1546                             match expr {
1547                                 Some(expr) => s.print_expr(expr),
1548                                 None => s.word("_"),
1549                             }
1550                         }
1551                         hir::InlineAsmOperand::InOut { reg, late, expr } => {
1552                             s.word(if *late { "inlateout" } else { "inout" });
1553                             s.popen();
1554                             s.word(format!("{}", reg));
1555                             s.pclose();
1556                             s.space();
1557                             s.print_expr(expr);
1558                         }
1559                         hir::InlineAsmOperand::SplitInOut { reg, late, in_expr, out_expr } => {
1560                             s.word(if *late { "inlateout" } else { "inout" });
1561                             s.popen();
1562                             s.word(format!("{}", reg));
1563                             s.pclose();
1564                             s.space();
1565                             s.print_expr(in_expr);
1566                             s.space();
1567                             s.word_space("=>");
1568                             match out_expr {
1569                                 Some(out_expr) => s.print_expr(out_expr),
1570                                 None => s.word("_"),
1571                             }
1572                         }
1573                         hir::InlineAsmOperand::Const { expr } => {
1574                             s.word("const");
1575                             s.space();
1576                             s.print_expr(expr);
1577                         }
1578                         hir::InlineAsmOperand::Sym { expr } => {
1579                             s.word("sym");
1580                             s.space();
1581                             s.print_expr(expr);
1582                         }
1583                     },
1584                     AsmArg::Options(opts) => {
1585                         s.word("options");
1586                         s.popen();
1587                         let mut options = vec![];
1588                         if opts.contains(ast::InlineAsmOptions::PURE) {
1589                             options.push("pure");
1590                         }
1591                         if opts.contains(ast::InlineAsmOptions::NOMEM) {
1592                             options.push("nomem");
1593                         }
1594                         if opts.contains(ast::InlineAsmOptions::READONLY) {
1595                             options.push("readonly");
1596                         }
1597                         if opts.contains(ast::InlineAsmOptions::PRESERVES_FLAGS) {
1598                             options.push("preserves_flags");
1599                         }
1600                         if opts.contains(ast::InlineAsmOptions::NORETURN) {
1601                             options.push("noreturn");
1602                         }
1603                         if opts.contains(ast::InlineAsmOptions::NOSTACK) {
1604                             options.push("nostack");
1605                         }
1606                         if opts.contains(ast::InlineAsmOptions::ATT_SYNTAX) {
1607                             options.push("att_syntax");
1608                         }
1609                         s.commasep(Inconsistent, &options, |s, &opt| {
1610                             s.word(opt);
1611                         });
1612                         s.pclose();
1613                     }
1614                 });
1615                 self.pclose();
1616             }
1617             hir::ExprKind::LlvmInlineAsm(ref a) => {
1618                 let i = &a.inner;
1619                 self.s.word("llvm_asm!");
1620                 self.popen();
1621                 self.print_symbol(i.asm, i.asm_str_style);
1622                 self.word_space(":");
1623
1624                 let mut out_idx = 0;
1625                 self.commasep(Inconsistent, &i.outputs, |s, out| {
1626                     let constraint = out.constraint.as_str();
1627                     let mut ch = constraint.chars();
1628                     match ch.next() {
1629                         Some('=') if out.is_rw => {
1630                             s.print_string(&format!("+{}", ch.as_str()), ast::StrStyle::Cooked)
1631                         }
1632                         _ => s.print_string(&constraint, ast::StrStyle::Cooked),
1633                     }
1634                     s.popen();
1635                     s.print_expr(&a.outputs_exprs[out_idx]);
1636                     s.pclose();
1637                     out_idx += 1;
1638                 });
1639                 self.s.space();
1640                 self.word_space(":");
1641
1642                 let mut in_idx = 0;
1643                 self.commasep(Inconsistent, &i.inputs, |s, &co| {
1644                     s.print_symbol(co, ast::StrStyle::Cooked);
1645                     s.popen();
1646                     s.print_expr(&a.inputs_exprs[in_idx]);
1647                     s.pclose();
1648                     in_idx += 1;
1649                 });
1650                 self.s.space();
1651                 self.word_space(":");
1652
1653                 self.commasep(Inconsistent, &i.clobbers, |s, &co| {
1654                     s.print_symbol(co, ast::StrStyle::Cooked);
1655                 });
1656
1657                 let mut options = vec![];
1658                 if i.volatile {
1659                     options.push("volatile");
1660                 }
1661                 if i.alignstack {
1662                     options.push("alignstack");
1663                 }
1664                 if i.dialect == ast::LlvmAsmDialect::Intel {
1665                     options.push("intel");
1666                 }
1667
1668                 if !options.is_empty() {
1669                     self.s.space();
1670                     self.word_space(":");
1671                     self.commasep(Inconsistent, &options, |s, &co| {
1672                         s.print_string(co, ast::StrStyle::Cooked);
1673                     });
1674                 }
1675
1676                 self.pclose();
1677             }
1678             hir::ExprKind::Yield(ref expr, _) => {
1679                 self.word_space("yield");
1680                 self.print_expr_maybe_paren(&expr, parser::PREC_JUMP);
1681             }
1682             hir::ExprKind::Err => {
1683                 self.popen();
1684                 self.s.word("/*ERROR*/");
1685                 self.pclose();
1686             }
1687         }
1688         self.ann.post(self, AnnNode::Expr(expr));
1689         self.end()
1690     }
1691
1692     pub fn print_local_decl(&mut self, loc: &hir::Local<'_>) {
1693         self.print_pat(&loc.pat);
1694         if let Some(ref ty) = loc.ty {
1695             self.word_space(":");
1696             self.print_type(&ty);
1697         }
1698     }
1699
1700     pub fn print_name(&mut self, name: Symbol) {
1701         self.print_ident(Ident::with_dummy_span(name))
1702     }
1703
1704     pub fn print_path(&mut self, path: &hir::Path<'_>, colons_before_params: bool) {
1705         self.maybe_print_comment(path.span.lo());
1706
1707         for (i, segment) in path.segments.iter().enumerate() {
1708             if i > 0 {
1709                 self.s.word("::")
1710             }
1711             if segment.ident.name != kw::PathRoot {
1712                 self.print_ident(segment.ident);
1713                 self.print_generic_args(segment.args(), segment.infer_args, colons_before_params);
1714             }
1715         }
1716     }
1717
1718     pub fn print_path_segment(&mut self, segment: &hir::PathSegment<'_>) {
1719         if segment.ident.name != kw::PathRoot {
1720             self.print_ident(segment.ident);
1721             self.print_generic_args(segment.args(), segment.infer_args, false);
1722         }
1723     }
1724
1725     pub fn print_qpath(&mut self, qpath: &hir::QPath<'_>, colons_before_params: bool) {
1726         match *qpath {
1727             hir::QPath::Resolved(None, ref path) => self.print_path(path, colons_before_params),
1728             hir::QPath::Resolved(Some(ref qself), ref path) => {
1729                 self.s.word("<");
1730                 self.print_type(qself);
1731                 self.s.space();
1732                 self.word_space("as");
1733
1734                 for (i, segment) in path.segments[..path.segments.len() - 1].iter().enumerate() {
1735                     if i > 0 {
1736                         self.s.word("::")
1737                     }
1738                     if segment.ident.name != kw::PathRoot {
1739                         self.print_ident(segment.ident);
1740                         self.print_generic_args(
1741                             segment.args(),
1742                             segment.infer_args,
1743                             colons_before_params,
1744                         );
1745                     }
1746                 }
1747
1748                 self.s.word(">");
1749                 self.s.word("::");
1750                 let item_segment = path.segments.last().unwrap();
1751                 self.print_ident(item_segment.ident);
1752                 self.print_generic_args(
1753                     item_segment.args(),
1754                     item_segment.infer_args,
1755                     colons_before_params,
1756                 )
1757             }
1758             hir::QPath::TypeRelative(ref qself, ref item_segment) => {
1759                 // If we've got a compound-qualified-path, let's push an additional pair of angle
1760                 // brackets, so that we pretty-print `<<A::B>::C>` as `<A::B>::C`, instead of just
1761                 // `A::B::C` (since the latter could be ambiguous to the user)
1762                 if let hir::TyKind::Path(hir::QPath::Resolved(None, _)) = &qself.kind {
1763                     self.print_type(qself);
1764                 } else {
1765                     self.s.word("<");
1766                     self.print_type(qself);
1767                     self.s.word(">");
1768                 }
1769
1770                 self.s.word("::");
1771                 self.print_ident(item_segment.ident);
1772                 self.print_generic_args(
1773                     item_segment.args(),
1774                     item_segment.infer_args,
1775                     colons_before_params,
1776                 )
1777             }
1778             hir::QPath::LangItem(lang_item, span) => {
1779                 self.s.word("#[lang = \"");
1780                 self.print_ident(Ident::new(lang_item.name(), span));
1781                 self.s.word("\"]");
1782             }
1783         }
1784     }
1785
1786     fn print_generic_args(
1787         &mut self,
1788         generic_args: &hir::GenericArgs<'_>,
1789         infer_args: bool,
1790         colons_before_params: bool,
1791     ) {
1792         if generic_args.parenthesized {
1793             self.s.word("(");
1794             self.commasep(Inconsistent, generic_args.inputs(), |s, ty| s.print_type(&ty));
1795             self.s.word(")");
1796
1797             self.space_if_not_bol();
1798             self.word_space("->");
1799             self.print_type(generic_args.bindings[0].ty());
1800         } else {
1801             let start = if colons_before_params { "::<" } else { "<" };
1802             let empty = Cell::new(true);
1803             let start_or_comma = |this: &mut Self| {
1804                 if empty.get() {
1805                     empty.set(false);
1806                     this.s.word(start)
1807                 } else {
1808                     this.word_space(",")
1809                 }
1810             };
1811
1812             let mut nonelided_generic_args: bool = false;
1813             let elide_lifetimes = generic_args.args.iter().all(|arg| match arg {
1814                 GenericArg::Lifetime(lt) => lt.is_elided(),
1815                 _ => {
1816                     nonelided_generic_args = true;
1817                     true
1818                 }
1819             });
1820
1821             if nonelided_generic_args {
1822                 start_or_comma(self);
1823                 self.commasep(
1824                     Inconsistent,
1825                     &generic_args.args,
1826                     |s, generic_arg| match generic_arg {
1827                         GenericArg::Lifetime(lt) if !elide_lifetimes => s.print_lifetime(lt),
1828                         GenericArg::Lifetime(_) => {}
1829                         GenericArg::Type(ty) => s.print_type(ty),
1830                         GenericArg::Const(ct) => s.print_anon_const(&ct.value),
1831                     },
1832                 );
1833             }
1834
1835             // FIXME(eddyb): this would leak into error messages (e.g.,
1836             // "non-exhaustive patterns: `Some::<..>(_)` not covered").
1837             if infer_args && false {
1838                 start_or_comma(self);
1839                 self.s.word("..");
1840             }
1841
1842             for binding in generic_args.bindings.iter() {
1843                 start_or_comma(self);
1844                 self.print_ident(binding.ident);
1845                 self.print_generic_args(binding.gen_args, false, false);
1846                 self.s.space();
1847                 match generic_args.bindings[0].kind {
1848                     hir::TypeBindingKind::Equality { ref ty } => {
1849                         self.word_space("=");
1850                         self.print_type(ty);
1851                     }
1852                     hir::TypeBindingKind::Constraint { bounds } => {
1853                         self.print_bounds(":", bounds);
1854                     }
1855                 }
1856             }
1857
1858             if !empty.get() {
1859                 self.s.word(">")
1860             }
1861         }
1862     }
1863
1864     pub fn print_pat(&mut self, pat: &hir::Pat<'_>) {
1865         self.maybe_print_comment(pat.span.lo());
1866         self.ann.pre(self, AnnNode::Pat(pat));
1867         // Pat isn't normalized, but the beauty of it
1868         // is that it doesn't matter
1869         match pat.kind {
1870             PatKind::Wild => self.s.word("_"),
1871             PatKind::Binding(binding_mode, _, ident, ref sub) => {
1872                 match binding_mode {
1873                     hir::BindingAnnotation::Ref => {
1874                         self.word_nbsp("ref");
1875                         self.print_mutability(hir::Mutability::Not, false);
1876                     }
1877                     hir::BindingAnnotation::RefMut => {
1878                         self.word_nbsp("ref");
1879                         self.print_mutability(hir::Mutability::Mut, false);
1880                     }
1881                     hir::BindingAnnotation::Unannotated => {}
1882                     hir::BindingAnnotation::Mutable => {
1883                         self.word_nbsp("mut");
1884                     }
1885                 }
1886                 self.print_ident(ident);
1887                 if let Some(ref p) = *sub {
1888                     self.s.word("@");
1889                     self.print_pat(&p);
1890                 }
1891             }
1892             PatKind::TupleStruct(ref qpath, ref elts, ddpos) => {
1893                 self.print_qpath(qpath, true);
1894                 self.popen();
1895                 if let Some(ddpos) = ddpos {
1896                     self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p));
1897                     if ddpos != 0 {
1898                         self.word_space(",");
1899                     }
1900                     self.s.word("..");
1901                     if ddpos != elts.len() {
1902                         self.s.word(",");
1903                         self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p));
1904                     }
1905                 } else {
1906                     self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p));
1907                 }
1908                 self.pclose();
1909             }
1910             PatKind::Path(ref qpath) => {
1911                 self.print_qpath(qpath, true);
1912             }
1913             PatKind::Struct(ref qpath, ref fields, etc) => {
1914                 self.print_qpath(qpath, true);
1915                 self.nbsp();
1916                 self.word_space("{");
1917                 self.commasep_cmnt(
1918                     Consistent,
1919                     &fields[..],
1920                     |s, f| {
1921                         s.cbox(INDENT_UNIT);
1922                         if !f.is_shorthand {
1923                             s.print_ident(f.ident);
1924                             s.word_nbsp(":");
1925                         }
1926                         s.print_pat(&f.pat);
1927                         s.end()
1928                     },
1929                     |f| f.pat.span,
1930                 );
1931                 if etc {
1932                     if !fields.is_empty() {
1933                         self.word_space(",");
1934                     }
1935                     self.s.word("..");
1936                 }
1937                 self.s.space();
1938                 self.s.word("}");
1939             }
1940             PatKind::Or(ref pats) => {
1941                 self.strsep("|", true, Inconsistent, &pats[..], |s, p| s.print_pat(&p));
1942             }
1943             PatKind::Tuple(ref elts, ddpos) => {
1944                 self.popen();
1945                 if let Some(ddpos) = ddpos {
1946                     self.commasep(Inconsistent, &elts[..ddpos], |s, p| s.print_pat(&p));
1947                     if ddpos != 0 {
1948                         self.word_space(",");
1949                     }
1950                     self.s.word("..");
1951                     if ddpos != elts.len() {
1952                         self.s.word(",");
1953                         self.commasep(Inconsistent, &elts[ddpos..], |s, p| s.print_pat(&p));
1954                     }
1955                 } else {
1956                     self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(&p));
1957                     if elts.len() == 1 {
1958                         self.s.word(",");
1959                     }
1960                 }
1961                 self.pclose();
1962             }
1963             PatKind::Box(ref inner) => {
1964                 let is_range_inner = matches!(inner.kind, PatKind::Range(..));
1965                 self.s.word("box ");
1966                 if is_range_inner {
1967                     self.popen();
1968                 }
1969                 self.print_pat(&inner);
1970                 if is_range_inner {
1971                     self.pclose();
1972                 }
1973             }
1974             PatKind::Ref(ref inner, mutbl) => {
1975                 let is_range_inner = matches!(inner.kind, PatKind::Range(..));
1976                 self.s.word("&");
1977                 self.s.word(mutbl.prefix_str());
1978                 if is_range_inner {
1979                     self.popen();
1980                 }
1981                 self.print_pat(&inner);
1982                 if is_range_inner {
1983                     self.pclose();
1984                 }
1985             }
1986             PatKind::Lit(ref e) => self.print_expr(&e),
1987             PatKind::Range(ref begin, ref end, ref end_kind) => {
1988                 if let Some(expr) = begin {
1989                     self.print_expr(expr);
1990                     self.s.space();
1991                 }
1992                 match *end_kind {
1993                     RangeEnd::Included => self.s.word("..."),
1994                     RangeEnd::Excluded => self.s.word(".."),
1995                 }
1996                 if let Some(expr) = end {
1997                     self.print_expr(expr);
1998                 }
1999             }
2000             PatKind::Slice(ref before, ref slice, ref after) => {
2001                 self.s.word("[");
2002                 self.commasep(Inconsistent, &before[..], |s, p| s.print_pat(&p));
2003                 if let Some(ref p) = *slice {
2004                     if !before.is_empty() {
2005                         self.word_space(",");
2006                     }
2007                     if let PatKind::Wild = p.kind {
2008                         // Print nothing.
2009                     } else {
2010                         self.print_pat(&p);
2011                     }
2012                     self.s.word("..");
2013                     if !after.is_empty() {
2014                         self.word_space(",");
2015                     }
2016                 }
2017                 self.commasep(Inconsistent, &after[..], |s, p| s.print_pat(&p));
2018                 self.s.word("]");
2019             }
2020         }
2021         self.ann.post(self, AnnNode::Pat(pat))
2022     }
2023
2024     pub fn print_param(&mut self, arg: &hir::Param<'_>) {
2025         self.print_outer_attributes(self.attrs(arg.hir_id));
2026         self.print_pat(&arg.pat);
2027     }
2028
2029     pub fn print_arm(&mut self, arm: &hir::Arm<'_>) {
2030         // I have no idea why this check is necessary, but here it
2031         // is :(
2032         if self.attrs(arm.hir_id).is_empty() {
2033             self.s.space();
2034         }
2035         self.cbox(INDENT_UNIT);
2036         self.ann.pre(self, AnnNode::Arm(arm));
2037         self.ibox(0);
2038         self.print_outer_attributes(&self.attrs(arm.hir_id));
2039         self.print_pat(&arm.pat);
2040         self.s.space();
2041         if let Some(ref g) = arm.guard {
2042             match g {
2043                 hir::Guard::If(e) => {
2044                     self.word_space("if");
2045                     self.print_expr(&e);
2046                     self.s.space();
2047                 }
2048                 hir::Guard::IfLet(pat, e) => {
2049                     self.word_nbsp("if");
2050                     self.word_nbsp("let");
2051                     self.print_pat(&pat);
2052                     self.s.space();
2053                     self.word_space("=");
2054                     self.print_expr(&e);
2055                     self.s.space();
2056                 }
2057             }
2058         }
2059         self.word_space("=>");
2060
2061         match arm.body.kind {
2062             hir::ExprKind::Block(ref blk, opt_label) => {
2063                 if let Some(label) = opt_label {
2064                     self.print_ident(label.ident);
2065                     self.word_space(":");
2066                 }
2067                 // the block will close the pattern's ibox
2068                 self.print_block_unclosed(&blk);
2069
2070                 // If it is a user-provided unsafe block, print a comma after it
2071                 if let hir::BlockCheckMode::UnsafeBlock(hir::UnsafeSource::UserProvided) = blk.rules
2072                 {
2073                     self.s.word(",");
2074                 }
2075             }
2076             _ => {
2077                 self.end(); // close the ibox for the pattern
2078                 self.print_expr(&arm.body);
2079                 self.s.word(",");
2080             }
2081         }
2082         self.ann.post(self, AnnNode::Arm(arm));
2083         self.end() // close enclosing cbox
2084     }
2085
2086     pub fn print_fn(
2087         &mut self,
2088         decl: &hir::FnDecl<'_>,
2089         header: hir::FnHeader,
2090         name: Option<Symbol>,
2091         generics: &hir::Generics<'_>,
2092         vis: &hir::Visibility<'_>,
2093         arg_names: &[Ident],
2094         body_id: Option<hir::BodyId>,
2095     ) {
2096         self.print_fn_header_info(header, vis);
2097
2098         if let Some(name) = name {
2099             self.nbsp();
2100             self.print_name(name);
2101         }
2102         self.print_generic_params(&generics.params);
2103
2104         self.popen();
2105         let mut i = 0;
2106         // Make sure we aren't supplied *both* `arg_names` and `body_id`.
2107         assert!(arg_names.is_empty() || body_id.is_none());
2108         self.commasep(Inconsistent, &decl.inputs, |s, ty| {
2109             s.ibox(INDENT_UNIT);
2110             if let Some(arg_name) = arg_names.get(i) {
2111                 s.s.word(arg_name.to_string());
2112                 s.s.word(":");
2113                 s.s.space();
2114             } else if let Some(body_id) = body_id {
2115                 s.ann.nested(s, Nested::BodyParamPat(body_id, i));
2116                 s.s.word(":");
2117                 s.s.space();
2118             }
2119             i += 1;
2120             s.print_type(ty);
2121             s.end()
2122         });
2123         if decl.c_variadic {
2124             self.s.word(", ...");
2125         }
2126         self.pclose();
2127
2128         self.print_fn_output(decl);
2129         self.print_where_clause(&generics.where_clause)
2130     }
2131
2132     fn print_closure_params(&mut self, decl: &hir::FnDecl<'_>, body_id: hir::BodyId) {
2133         self.s.word("|");
2134         let mut i = 0;
2135         self.commasep(Inconsistent, &decl.inputs, |s, ty| {
2136             s.ibox(INDENT_UNIT);
2137
2138             s.ann.nested(s, Nested::BodyParamPat(body_id, i));
2139             i += 1;
2140
2141             if let hir::TyKind::Infer = ty.kind {
2142                 // Print nothing.
2143             } else {
2144                 s.s.word(":");
2145                 s.s.space();
2146                 s.print_type(ty);
2147             }
2148             s.end();
2149         });
2150         self.s.word("|");
2151
2152         if let hir::FnRetTy::DefaultReturn(..) = decl.output {
2153             return;
2154         }
2155
2156         self.space_if_not_bol();
2157         self.word_space("->");
2158         match decl.output {
2159             hir::FnRetTy::Return(ref ty) => {
2160                 self.print_type(&ty);
2161                 self.maybe_print_comment(ty.span.lo())
2162             }
2163             hir::FnRetTy::DefaultReturn(..) => unreachable!(),
2164         }
2165     }
2166
2167     pub fn print_capture_clause(&mut self, capture_clause: hir::CaptureBy) {
2168         match capture_clause {
2169             hir::CaptureBy::Value => self.word_space("move"),
2170             hir::CaptureBy::Ref => {}
2171         }
2172     }
2173
2174     pub fn print_bounds<'b>(
2175         &mut self,
2176         prefix: &'static str,
2177         bounds: impl IntoIterator<Item = &'b hir::GenericBound<'b>>,
2178     ) {
2179         let mut first = true;
2180         for bound in bounds {
2181             if first {
2182                 self.s.word(prefix);
2183             }
2184             if !(first && prefix.is_empty()) {
2185                 self.nbsp();
2186             }
2187             if first {
2188                 first = false;
2189             } else {
2190                 self.word_space("+");
2191             }
2192
2193             match bound {
2194                 GenericBound::Trait(tref, modifier) => {
2195                     if modifier == &TraitBoundModifier::Maybe {
2196                         self.s.word("?");
2197                     }
2198                     self.print_poly_trait_ref(tref);
2199                 }
2200                 GenericBound::LangItemTrait(lang_item, span, ..) => {
2201                     self.s.word("#[lang = \"");
2202                     self.print_ident(Ident::new(lang_item.name(), *span));
2203                     self.s.word("\"]");
2204                 }
2205                 GenericBound::Outlives(lt) => {
2206                     self.print_lifetime(lt);
2207                 }
2208             }
2209         }
2210     }
2211
2212     pub fn print_generic_params(&mut self, generic_params: &[GenericParam<'_>]) {
2213         if !generic_params.is_empty() {
2214             self.s.word("<");
2215
2216             self.commasep(Inconsistent, generic_params, |s, param| s.print_generic_param(param));
2217
2218             self.s.word(">");
2219         }
2220     }
2221
2222     pub fn print_generic_param(&mut self, param: &GenericParam<'_>) {
2223         if let GenericParamKind::Const { .. } = param.kind {
2224             self.word_space("const");
2225         }
2226
2227         self.print_ident(param.name.ident());
2228
2229         match param.kind {
2230             GenericParamKind::Lifetime { .. } => {
2231                 let mut sep = ":";
2232                 for bound in param.bounds {
2233                     match bound {
2234                         GenericBound::Outlives(ref lt) => {
2235                             self.s.word(sep);
2236                             self.print_lifetime(lt);
2237                             sep = "+";
2238                         }
2239                         _ => panic!(),
2240                     }
2241                 }
2242             }
2243             GenericParamKind::Type { ref default, .. } => {
2244                 self.print_bounds(":", param.bounds);
2245                 if let Some(default) = default {
2246                     self.s.space();
2247                     self.word_space("=");
2248                     self.print_type(&default)
2249                 }
2250             }
2251             GenericParamKind::Const { ref ty, ref default } => {
2252                 self.word_space(":");
2253                 self.print_type(ty);
2254                 if let Some(ref default) = default {
2255                     self.s.space();
2256                     self.word_space("=");
2257                     self.print_anon_const(&default)
2258                 }
2259             }
2260         }
2261     }
2262
2263     pub fn print_lifetime(&mut self, lifetime: &hir::Lifetime) {
2264         self.print_ident(lifetime.name.ident())
2265     }
2266
2267     pub fn print_where_clause(&mut self, where_clause: &hir::WhereClause<'_>) {
2268         if where_clause.predicates.is_empty() {
2269             return;
2270         }
2271
2272         self.s.space();
2273         self.word_space("where");
2274
2275         for (i, predicate) in where_clause.predicates.iter().enumerate() {
2276             if i != 0 {
2277                 self.word_space(",");
2278             }
2279
2280             match predicate {
2281                 hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
2282                     bound_generic_params,
2283                     bounded_ty,
2284                     bounds,
2285                     ..
2286                 }) => {
2287                     self.print_formal_generic_params(bound_generic_params);
2288                     self.print_type(&bounded_ty);
2289                     self.print_bounds(":", *bounds);
2290                 }
2291                 hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate {
2292                     lifetime,
2293                     bounds,
2294                     ..
2295                 }) => {
2296                     self.print_lifetime(lifetime);
2297                     self.s.word(":");
2298
2299                     for (i, bound) in bounds.iter().enumerate() {
2300                         match bound {
2301                             GenericBound::Outlives(lt) => {
2302                                 self.print_lifetime(lt);
2303                             }
2304                             _ => panic!(),
2305                         }
2306
2307                         if i != 0 {
2308                             self.s.word(":");
2309                         }
2310                     }
2311                 }
2312                 hir::WherePredicate::EqPredicate(hir::WhereEqPredicate {
2313                     lhs_ty, rhs_ty, ..
2314                 }) => {
2315                     self.print_type(lhs_ty);
2316                     self.s.space();
2317                     self.word_space("=");
2318                     self.print_type(rhs_ty);
2319                 }
2320             }
2321         }
2322     }
2323
2324     pub fn print_mutability(&mut self, mutbl: hir::Mutability, print_const: bool) {
2325         match mutbl {
2326             hir::Mutability::Mut => self.word_nbsp("mut"),
2327             hir::Mutability::Not => {
2328                 if print_const {
2329                     self.word_nbsp("const")
2330                 }
2331             }
2332         }
2333     }
2334
2335     pub fn print_mt(&mut self, mt: &hir::MutTy<'_>, print_const: bool) {
2336         self.print_mutability(mt.mutbl, print_const);
2337         self.print_type(&mt.ty)
2338     }
2339
2340     pub fn print_fn_output(&mut self, decl: &hir::FnDecl<'_>) {
2341         if let hir::FnRetTy::DefaultReturn(..) = decl.output {
2342             return;
2343         }
2344
2345         self.space_if_not_bol();
2346         self.ibox(INDENT_UNIT);
2347         self.word_space("->");
2348         match decl.output {
2349             hir::FnRetTy::DefaultReturn(..) => unreachable!(),
2350             hir::FnRetTy::Return(ref ty) => self.print_type(&ty),
2351         }
2352         self.end();
2353
2354         if let hir::FnRetTy::Return(ref output) = decl.output {
2355             self.maybe_print_comment(output.span.lo())
2356         }
2357     }
2358
2359     pub fn print_ty_fn(
2360         &mut self,
2361         abi: Abi,
2362         unsafety: hir::Unsafety,
2363         decl: &hir::FnDecl<'_>,
2364         name: Option<Symbol>,
2365         generic_params: &[hir::GenericParam<'_>],
2366         arg_names: &[Ident],
2367     ) {
2368         self.ibox(INDENT_UNIT);
2369         if !generic_params.is_empty() {
2370             self.s.word("for");
2371             self.print_generic_params(generic_params);
2372         }
2373         let generics = hir::Generics {
2374             params: &[],
2375             where_clause: hir::WhereClause { predicates: &[], span: rustc_span::DUMMY_SP },
2376             span: rustc_span::DUMMY_SP,
2377         };
2378         self.print_fn(
2379             decl,
2380             hir::FnHeader {
2381                 unsafety,
2382                 abi,
2383                 constness: hir::Constness::NotConst,
2384                 asyncness: hir::IsAsync::NotAsync,
2385             },
2386             name,
2387             &generics,
2388             &Spanned { span: rustc_span::DUMMY_SP, node: hir::VisibilityKind::Inherited },
2389             arg_names,
2390             None,
2391         );
2392         self.end();
2393     }
2394
2395     pub fn maybe_print_trailing_comment(
2396         &mut self,
2397         span: rustc_span::Span,
2398         next_pos: Option<BytePos>,
2399     ) {
2400         if let Some(cmnts) = self.comments() {
2401             if let Some(cmnt) = cmnts.trailing_comment(span, next_pos) {
2402                 self.print_comment(&cmnt);
2403             }
2404         }
2405     }
2406
2407     pub fn print_remaining_comments(&mut self) {
2408         // If there aren't any remaining comments, then we need to manually
2409         // make sure there is a line break at the end.
2410         if self.next_comment().is_none() {
2411             self.s.hardbreak();
2412         }
2413         while let Some(ref cmnt) = self.next_comment() {
2414             self.print_comment(cmnt)
2415         }
2416     }
2417
2418     pub fn print_fn_header_info(&mut self, header: hir::FnHeader, vis: &hir::Visibility<'_>) {
2419         self.s.word(visibility_qualified(vis, ""));
2420
2421         match header.constness {
2422             hir::Constness::NotConst => {}
2423             hir::Constness::Const => self.word_nbsp("const"),
2424         }
2425
2426         match header.asyncness {
2427             hir::IsAsync::NotAsync => {}
2428             hir::IsAsync::Async => self.word_nbsp("async"),
2429         }
2430
2431         self.print_unsafety(header.unsafety);
2432
2433         if header.abi != Abi::Rust {
2434             self.word_nbsp("extern");
2435             self.word_nbsp(header.abi.to_string());
2436         }
2437
2438         self.s.word("fn")
2439     }
2440
2441     pub fn print_unsafety(&mut self, s: hir::Unsafety) {
2442         match s {
2443             hir::Unsafety::Normal => {}
2444             hir::Unsafety::Unsafe => self.word_nbsp("unsafe"),
2445         }
2446     }
2447
2448     pub fn print_is_auto(&mut self, s: hir::IsAuto) {
2449         match s {
2450             hir::IsAuto::Yes => self.word_nbsp("auto"),
2451             hir::IsAuto::No => {}
2452         }
2453     }
2454 }
2455
2456 /// Does this expression require a semicolon to be treated
2457 /// as a statement? The negation of this: 'can this expression
2458 /// be used as a statement without a semicolon' -- is used
2459 /// as an early-bail-out in the parser so that, for instance,
2460 ///     if true {...} else {...}
2461 ///      |x| 5
2462 /// isn't parsed as (if true {...} else {...} | x) | 5
2463 //
2464 // Duplicated from `parse::classify`, but adapted for the HIR.
2465 fn expr_requires_semi_to_be_stmt(e: &hir::Expr<'_>) -> bool {
2466     !matches!(
2467         e.kind,
2468         hir::ExprKind::If(..)
2469             | hir::ExprKind::Match(..)
2470             | hir::ExprKind::Block(..)
2471             | hir::ExprKind::Loop(..)
2472     )
2473 }
2474
2475 /// This statement requires a semicolon after it.
2476 /// note that in one case (stmt_semi), we've already
2477 /// seen the semicolon, and thus don't need another.
2478 fn stmt_ends_with_semi(stmt: &hir::StmtKind<'_>) -> bool {
2479     match *stmt {
2480         hir::StmtKind::Local(_) => true,
2481         hir::StmtKind::Item(_) => false,
2482         hir::StmtKind::Expr(ref e) => expr_requires_semi_to_be_stmt(&e),
2483         hir::StmtKind::Semi(..) => false,
2484     }
2485 }
2486
2487 fn bin_op_to_assoc_op(op: hir::BinOpKind) -> AssocOp {
2488     use crate::hir::BinOpKind::*;
2489     match op {
2490         Add => AssocOp::Add,
2491         Sub => AssocOp::Subtract,
2492         Mul => AssocOp::Multiply,
2493         Div => AssocOp::Divide,
2494         Rem => AssocOp::Modulus,
2495
2496         And => AssocOp::LAnd,
2497         Or => AssocOp::LOr,
2498
2499         BitXor => AssocOp::BitXor,
2500         BitAnd => AssocOp::BitAnd,
2501         BitOr => AssocOp::BitOr,
2502         Shl => AssocOp::ShiftLeft,
2503         Shr => AssocOp::ShiftRight,
2504
2505         Eq => AssocOp::Equal,
2506         Lt => AssocOp::Less,
2507         Le => AssocOp::LessEqual,
2508         Ne => AssocOp::NotEqual,
2509         Ge => AssocOp::GreaterEqual,
2510         Gt => AssocOp::Greater,
2511     }
2512 }
2513
2514 /// Expressions that syntactically contain an "exterior" struct literal, i.e., not surrounded by any
2515 /// parens or other delimiters, e.g., `X { y: 1 }`, `X { y: 1 }.method()`, `foo == X { y: 1 }` and
2516 /// `X { y: 1 } == foo` all do, but `(X { y: 1 }) == foo` does not.
2517 fn contains_exterior_struct_lit(value: &hir::Expr<'_>) -> bool {
2518     match value.kind {
2519         hir::ExprKind::Struct(..) => true,
2520
2521         hir::ExprKind::Assign(ref lhs, ref rhs, _)
2522         | hir::ExprKind::AssignOp(_, ref lhs, ref rhs)
2523         | hir::ExprKind::Binary(_, ref lhs, ref rhs) => {
2524             // `X { y: 1 } + X { y: 2 }`
2525             contains_exterior_struct_lit(&lhs) || contains_exterior_struct_lit(&rhs)
2526         }
2527         hir::ExprKind::Unary(_, ref x)
2528         | hir::ExprKind::Cast(ref x, _)
2529         | hir::ExprKind::Type(ref x, _)
2530         | hir::ExprKind::Field(ref x, _)
2531         | hir::ExprKind::Index(ref x, _) => {
2532             // `&X { y: 1 }, X { y: 1 }.y`
2533             contains_exterior_struct_lit(&x)
2534         }
2535
2536         hir::ExprKind::MethodCall(.., ref exprs, _) => {
2537             // `X { y: 1 }.bar(...)`
2538             contains_exterior_struct_lit(&exprs[0])
2539         }
2540
2541         _ => false,
2542     }
2543 }