]> git.lizzy.rs Git - rust.git/blob - src/librustc_ast_pretty/pprust.rs
Rollup merge of #68460 - sinkuu:emit_mir_buffered, r=Mark-Simulacrum
[rust.git] / src / librustc_ast_pretty / pprust.rs
1 use crate::pp::Breaks::{Consistent, Inconsistent};
2 use crate::pp::{self, Breaks};
3
4 use rustc_span::edition::Edition;
5 use rustc_span::source_map::{dummy_spanned, SourceMap, Spanned};
6 use rustc_span::symbol::{kw, sym};
7 use rustc_span::{BytePos, FileName, Span};
8 use syntax::ast::{self, BlockCheckMode, PatKind, RangeEnd, RangeSyntax};
9 use syntax::ast::{Attribute, GenericArg, MacArgs};
10 use syntax::ast::{GenericBound, SelfKind, TraitBoundModifier};
11 use syntax::attr;
12 use syntax::ptr::P;
13 use syntax::token::{self, BinOpToken, DelimToken, Nonterminal, Token, TokenKind};
14 use syntax::tokenstream::{self, TokenStream, TokenTree};
15 use syntax::util::parser::{self, AssocOp, Fixity};
16 use syntax::util::{classify, comments};
17
18 use std::borrow::Cow;
19
20 #[cfg(test)]
21 mod tests;
22
23 pub enum MacHeader<'a> {
24     Path(&'a ast::Path),
25     Keyword(&'static str),
26 }
27
28 pub enum AnnNode<'a> {
29     Ident(&'a ast::Ident),
30     Name(&'a ast::Name),
31     Block(&'a ast::Block),
32     Item(&'a ast::Item),
33     SubItem(ast::NodeId),
34     Expr(&'a ast::Expr),
35     Pat(&'a ast::Pat),
36     Crate(&'a ast::Crate),
37 }
38
39 pub trait PpAnn {
40     fn pre(&self, _state: &mut State<'_>, _node: AnnNode<'_>) {}
41     fn post(&self, _state: &mut State<'_>, _node: AnnNode<'_>) {}
42 }
43
44 #[derive(Copy, Clone)]
45 pub struct NoAnn;
46
47 impl PpAnn for NoAnn {}
48
49 pub struct Comments<'a> {
50     cm: &'a SourceMap,
51     comments: Vec<comments::Comment>,
52     current: usize,
53 }
54
55 impl<'a> Comments<'a> {
56     pub fn new(cm: &'a SourceMap, filename: FileName, input: String) -> Comments<'a> {
57         let comments = comments::gather_comments(cm, filename, input);
58         Comments { cm, comments, current: 0 }
59     }
60
61     pub fn next(&self) -> Option<comments::Comment> {
62         self.comments.get(self.current).cloned()
63     }
64
65     pub fn trailing_comment(
66         &mut self,
67         span: rustc_span::Span,
68         next_pos: Option<BytePos>,
69     ) -> Option<comments::Comment> {
70         if let Some(cmnt) = self.next() {
71             if cmnt.style != comments::Trailing {
72                 return None;
73             }
74             let span_line = self.cm.lookup_char_pos(span.hi());
75             let comment_line = self.cm.lookup_char_pos(cmnt.pos);
76             let next = next_pos.unwrap_or_else(|| cmnt.pos + BytePos(1));
77             if span.hi() < cmnt.pos && cmnt.pos < next && span_line.line == comment_line.line {
78                 return Some(cmnt);
79             }
80         }
81
82         None
83     }
84 }
85
86 pub struct State<'a> {
87     pub s: pp::Printer,
88     comments: Option<Comments<'a>>,
89     ann: &'a (dyn PpAnn + 'a),
90     is_expanded: bool,
91 }
92
93 crate const INDENT_UNIT: usize = 4;
94
95 /// Requires you to pass an input filename and reader so that
96 /// it can scan the input text for comments to copy forward.
97 pub fn print_crate<'a>(
98     cm: &'a SourceMap,
99     krate: &ast::Crate,
100     filename: FileName,
101     input: String,
102     ann: &'a dyn PpAnn,
103     is_expanded: bool,
104     edition: Edition,
105     has_injected_crate: bool,
106 ) -> String {
107     let mut s = State {
108         s: pp::mk_printer(),
109         comments: Some(Comments::new(cm, filename, input)),
110         ann,
111         is_expanded,
112     };
113
114     if is_expanded && has_injected_crate {
115         // We need to print `#![no_std]` (and its feature gate) so that
116         // compiling pretty-printed source won't inject libstd again.
117         // However, we don't want these attributes in the AST because
118         // of the feature gate, so we fake them up here.
119
120         // `#![feature(prelude_import)]`
121         let pi_nested = attr::mk_nested_word_item(ast::Ident::with_dummy_span(sym::prelude_import));
122         let list = attr::mk_list_item(ast::Ident::with_dummy_span(sym::feature), vec![pi_nested]);
123         let fake_attr = attr::mk_attr_inner(list);
124         s.print_attribute(&fake_attr);
125
126         // Currently, in Rust 2018 we don't have `extern crate std;` at the crate
127         // root, so this is not needed, and actually breaks things.
128         if edition == Edition::Edition2015 {
129             // `#![no_std]`
130             let no_std_meta = attr::mk_word_item(ast::Ident::with_dummy_span(sym::no_std));
131             let fake_attr = attr::mk_attr_inner(no_std_meta);
132             s.print_attribute(&fake_attr);
133         }
134     }
135
136     s.print_mod(&krate.module, &krate.attrs);
137     s.print_remaining_comments();
138     s.ann.post(&mut s, AnnNode::Crate(krate));
139     s.s.eof()
140 }
141
142 pub fn to_string(f: impl FnOnce(&mut State<'_>)) -> String {
143     let mut printer =
144         State { s: pp::mk_printer(), comments: None, ann: &NoAnn, is_expanded: false };
145     f(&mut printer);
146     printer.s.eof()
147 }
148
149 // This makes comma-separated lists look slightly nicer,
150 // and also addresses a specific regression described in issue #63896.
151 fn tt_prepend_space(tt: &TokenTree) -> bool {
152     match tt {
153         TokenTree::Token(token) => match token.kind {
154             token::Comma => false,
155             _ => true,
156         },
157         _ => true,
158     }
159 }
160
161 fn binop_to_string(op: BinOpToken) -> &'static str {
162     match op {
163         token::Plus => "+",
164         token::Minus => "-",
165         token::Star => "*",
166         token::Slash => "/",
167         token::Percent => "%",
168         token::Caret => "^",
169         token::And => "&",
170         token::Or => "|",
171         token::Shl => "<<",
172         token::Shr => ">>",
173     }
174 }
175
176 pub fn literal_to_string(lit: token::Lit) -> String {
177     let token::Lit { kind, symbol, suffix } = lit;
178     let mut out = match kind {
179         token::Byte => format!("b'{}'", symbol),
180         token::Char => format!("'{}'", symbol),
181         token::Str => format!("\"{}\"", symbol),
182         token::StrRaw(n) => {
183             format!("r{delim}\"{string}\"{delim}", delim = "#".repeat(n as usize), string = symbol)
184         }
185         token::ByteStr => format!("b\"{}\"", symbol),
186         token::ByteStrRaw(n) => {
187             format!("br{delim}\"{string}\"{delim}", delim = "#".repeat(n as usize), string = symbol)
188         }
189         token::Integer | token::Float | token::Bool | token::Err => symbol.to_string(),
190     };
191
192     if let Some(suffix) = suffix {
193         out.push_str(&suffix.as_str())
194     }
195
196     out
197 }
198
199 /// Print an ident from AST, `$crate` is converted into its respective crate name.
200 pub fn ast_ident_to_string(ident: ast::Ident, is_raw: bool) -> String {
201     ident_to_string(ident.name, is_raw, Some(ident.span))
202 }
203
204 // AST pretty-printer is used as a fallback for turning AST structures into token streams for
205 // proc macros. Additionally, proc macros may stringify their input and expect it survive the
206 // stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
207 // So we need to somehow pretty-print `$crate` in a way preserving at least some of its
208 // hygiene data, most importantly name of the crate it refers to.
209 // As a result we print `$crate` as `crate` if it refers to the local crate
210 // and as `::other_crate_name` if it refers to some other crate.
211 // Note, that this is only done if the ident token is printed from inside of AST pretty-pringing,
212 // but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
213 // so we should not perform this lossy conversion if the top level call to the pretty-printer was
214 // done for a token stream or a single token.
215 fn ident_to_string(name: ast::Name, is_raw: bool, convert_dollar_crate: Option<Span>) -> String {
216     if is_raw {
217         format!("r#{}", name)
218     } else {
219         if name == kw::DollarCrate {
220             if let Some(span) = convert_dollar_crate {
221                 let converted = span.ctxt().dollar_crate_name();
222                 return if converted.is_path_segment_keyword() {
223                     converted.to_string()
224                 } else {
225                     format!("::{}", converted)
226                 };
227             }
228         }
229         name.to_string()
230     }
231 }
232
233 /// Print the token kind precisely, without converting `$crate` into its respective crate name.
234 pub fn token_kind_to_string(tok: &TokenKind) -> String {
235     token_kind_to_string_ext(tok, None)
236 }
237
238 fn token_kind_to_string_ext(tok: &TokenKind, convert_dollar_crate: Option<Span>) -> String {
239     match *tok {
240         token::Eq => "=".to_string(),
241         token::Lt => "<".to_string(),
242         token::Le => "<=".to_string(),
243         token::EqEq => "==".to_string(),
244         token::Ne => "!=".to_string(),
245         token::Ge => ">=".to_string(),
246         token::Gt => ">".to_string(),
247         token::Not => "!".to_string(),
248         token::Tilde => "~".to_string(),
249         token::OrOr => "||".to_string(),
250         token::AndAnd => "&&".to_string(),
251         token::BinOp(op) => binop_to_string(op).to_string(),
252         token::BinOpEq(op) => format!("{}=", binop_to_string(op)),
253
254         /* Structural symbols */
255         token::At => "@".to_string(),
256         token::Dot => ".".to_string(),
257         token::DotDot => "..".to_string(),
258         token::DotDotDot => "...".to_string(),
259         token::DotDotEq => "..=".to_string(),
260         token::Comma => ",".to_string(),
261         token::Semi => ";".to_string(),
262         token::Colon => ":".to_string(),
263         token::ModSep => "::".to_string(),
264         token::RArrow => "->".to_string(),
265         token::LArrow => "<-".to_string(),
266         token::FatArrow => "=>".to_string(),
267         token::OpenDelim(token::Paren) => "(".to_string(),
268         token::CloseDelim(token::Paren) => ")".to_string(),
269         token::OpenDelim(token::Bracket) => "[".to_string(),
270         token::CloseDelim(token::Bracket) => "]".to_string(),
271         token::OpenDelim(token::Brace) => "{".to_string(),
272         token::CloseDelim(token::Brace) => "}".to_string(),
273         token::OpenDelim(token::NoDelim) | token::CloseDelim(token::NoDelim) => " ".to_string(),
274         token::Pound => "#".to_string(),
275         token::Dollar => "$".to_string(),
276         token::Question => "?".to_string(),
277         token::SingleQuote => "'".to_string(),
278
279         /* Literals */
280         token::Literal(lit) => literal_to_string(lit),
281
282         /* Name components */
283         token::Ident(s, is_raw) => ident_to_string(s, is_raw, convert_dollar_crate),
284         token::Lifetime(s) => s.to_string(),
285
286         /* Other */
287         token::DocComment(s) => s.to_string(),
288         token::Eof => "<eof>".to_string(),
289         token::Whitespace => " ".to_string(),
290         token::Comment => "/* */".to_string(),
291         token::Shebang(s) => format!("/* shebang: {}*/", s),
292         token::Unknown(s) => s.to_string(),
293
294         token::Interpolated(ref nt) => nonterminal_to_string(nt),
295     }
296 }
297
298 /// Print the token precisely, without converting `$crate` into its respective crate name.
299 pub fn token_to_string(token: &Token) -> String {
300     token_to_string_ext(token, false)
301 }
302
303 fn token_to_string_ext(token: &Token, convert_dollar_crate: bool) -> String {
304     let convert_dollar_crate = convert_dollar_crate.then_some(token.span);
305     token_kind_to_string_ext(&token.kind, convert_dollar_crate)
306 }
307
308 pub fn nonterminal_to_string(nt: &Nonterminal) -> String {
309     match *nt {
310         token::NtExpr(ref e) => expr_to_string(e),
311         token::NtMeta(ref e) => attr_item_to_string(e),
312         token::NtTy(ref e) => ty_to_string(e),
313         token::NtPath(ref e) => path_to_string(e),
314         token::NtItem(ref e) => item_to_string(e),
315         token::NtBlock(ref e) => block_to_string(e),
316         token::NtStmt(ref e) => stmt_to_string(e),
317         token::NtPat(ref e) => pat_to_string(e),
318         token::NtIdent(e, is_raw) => ast_ident_to_string(e, is_raw),
319         token::NtLifetime(e) => e.to_string(),
320         token::NtLiteral(ref e) => expr_to_string(e),
321         token::NtTT(ref tree) => tt_to_string(tree.clone()),
322         // FIXME(Centril): merge these variants.
323         token::NtImplItem(ref e) | token::NtTraitItem(ref e) => assoc_item_to_string(e),
324         token::NtVis(ref e) => vis_to_string(e),
325         token::NtForeignItem(ref e) => foreign_item_to_string(e),
326     }
327 }
328
329 pub fn ty_to_string(ty: &ast::Ty) -> String {
330     to_string(|s| s.print_type(ty))
331 }
332
333 pub fn bounds_to_string(bounds: &[ast::GenericBound]) -> String {
334     to_string(|s| s.print_type_bounds("", bounds))
335 }
336
337 pub fn pat_to_string(pat: &ast::Pat) -> String {
338     to_string(|s| s.print_pat(pat))
339 }
340
341 pub fn expr_to_string(e: &ast::Expr) -> String {
342     to_string(|s| s.print_expr(e))
343 }
344
345 pub fn tt_to_string(tt: tokenstream::TokenTree) -> String {
346     to_string(|s| s.print_tt(tt, false))
347 }
348
349 pub fn tts_to_string(tokens: TokenStream) -> String {
350     to_string(|s| s.print_tts(tokens, false))
351 }
352
353 pub fn stmt_to_string(stmt: &ast::Stmt) -> String {
354     to_string(|s| s.print_stmt(stmt))
355 }
356
357 pub fn item_to_string(i: &ast::Item) -> String {
358     to_string(|s| s.print_item(i))
359 }
360
361 fn assoc_item_to_string(i: &ast::AssocItem) -> String {
362     to_string(|s| s.print_assoc_item(i))
363 }
364
365 pub fn generic_params_to_string(generic_params: &[ast::GenericParam]) -> String {
366     to_string(|s| s.print_generic_params(generic_params))
367 }
368
369 pub fn path_to_string(p: &ast::Path) -> String {
370     to_string(|s| s.print_path(p, false, 0))
371 }
372
373 pub fn path_segment_to_string(p: &ast::PathSegment) -> String {
374     to_string(|s| s.print_path_segment(p, false))
375 }
376
377 pub fn vis_to_string(v: &ast::Visibility) -> String {
378     to_string(|s| s.print_visibility(v))
379 }
380
381 fn block_to_string(blk: &ast::Block) -> String {
382     to_string(|s| {
383         // Containing cbox, will be closed by `print_block` at `}`.
384         s.cbox(INDENT_UNIT);
385         // Head-ibox, will be closed by `print_block` after `{`.
386         s.ibox(0);
387         s.print_block(blk)
388     })
389 }
390
391 pub fn meta_list_item_to_string(li: &ast::NestedMetaItem) -> String {
392     to_string(|s| s.print_meta_list_item(li))
393 }
394
395 fn attr_item_to_string(ai: &ast::AttrItem) -> String {
396     to_string(|s| s.print_attr_item(ai, ai.path.span))
397 }
398
399 pub fn attribute_to_string(attr: &ast::Attribute) -> String {
400     to_string(|s| s.print_attribute(attr))
401 }
402
403 pub fn param_to_string(arg: &ast::Param) -> String {
404     to_string(|s| s.print_param(arg, false))
405 }
406
407 fn foreign_item_to_string(arg: &ast::ForeignItem) -> String {
408     to_string(|s| s.print_foreign_item(arg))
409 }
410
411 fn visibility_qualified(vis: &ast::Visibility, s: &str) -> String {
412     format!("{}{}", to_string(|s| s.print_visibility(vis)), s)
413 }
414
415 impl std::ops::Deref for State<'_> {
416     type Target = pp::Printer;
417     fn deref(&self) -> &Self::Target {
418         &self.s
419     }
420 }
421
422 impl std::ops::DerefMut for State<'_> {
423     fn deref_mut(&mut self) -> &mut Self::Target {
424         &mut self.s
425     }
426 }
427
428 pub trait PrintState<'a>: std::ops::Deref<Target = pp::Printer> + std::ops::DerefMut {
429     fn comments(&mut self) -> &mut Option<Comments<'a>>;
430     fn print_ident(&mut self, ident: ast::Ident);
431     fn print_generic_args(&mut self, args: &ast::GenericArgs, colons_before_params: bool);
432
433     fn strsep<T, F>(
434         &mut self,
435         sep: &'static str,
436         space_before: bool,
437         b: Breaks,
438         elts: &[T],
439         mut op: F,
440     ) where
441         F: FnMut(&mut Self, &T),
442     {
443         self.rbox(0, b);
444         if let Some((first, rest)) = elts.split_first() {
445             op(self, first);
446             for elt in rest {
447                 if space_before {
448                     self.space();
449                 }
450                 self.word_space(sep);
451                 op(self, elt);
452             }
453         }
454         self.end();
455     }
456
457     fn commasep<T, F>(&mut self, b: Breaks, elts: &[T], op: F)
458     where
459         F: FnMut(&mut Self, &T),
460     {
461         self.strsep(",", false, b, elts, op)
462     }
463
464     fn maybe_print_comment(&mut self, pos: BytePos) {
465         while let Some(ref cmnt) = self.next_comment() {
466             if cmnt.pos < pos {
467                 self.print_comment(cmnt);
468             } else {
469                 break;
470             }
471         }
472     }
473
474     fn print_comment(&mut self, cmnt: &comments::Comment) {
475         match cmnt.style {
476             comments::Mixed => {
477                 assert_eq!(cmnt.lines.len(), 1);
478                 self.zerobreak();
479                 self.word(cmnt.lines[0].clone());
480                 self.zerobreak()
481             }
482             comments::Isolated => {
483                 self.hardbreak_if_not_bol();
484                 for line in &cmnt.lines {
485                     // Don't print empty lines because they will end up as trailing
486                     // whitespace.
487                     if !line.is_empty() {
488                         self.word(line.clone());
489                     }
490                     self.hardbreak();
491                 }
492             }
493             comments::Trailing => {
494                 if !self.is_beginning_of_line() {
495                     self.word(" ");
496                 }
497                 if cmnt.lines.len() == 1 {
498                     self.word(cmnt.lines[0].clone());
499                     self.hardbreak()
500                 } else {
501                     self.ibox(0);
502                     for line in &cmnt.lines {
503                         if !line.is_empty() {
504                             self.word(line.clone());
505                         }
506                         self.hardbreak();
507                     }
508                     self.end();
509                 }
510             }
511             comments::BlankLine => {
512                 // We need to do at least one, possibly two hardbreaks.
513                 let twice = match self.last_token() {
514                     pp::Token::String(s) => ";" == s,
515                     pp::Token::Begin(_) => true,
516                     pp::Token::End => true,
517                     _ => false,
518                 };
519                 if twice {
520                     self.hardbreak();
521                 }
522                 self.hardbreak();
523             }
524         }
525         if let Some(cm) = self.comments() {
526             cm.current += 1;
527         }
528     }
529
530     fn next_comment(&mut self) -> Option<comments::Comment> {
531         self.comments().as_mut().and_then(|c| c.next())
532     }
533
534     fn print_literal(&mut self, lit: &ast::Lit) {
535         self.maybe_print_comment(lit.span.lo());
536         self.word(lit.token.to_string())
537     }
538
539     fn print_string(&mut self, st: &str, style: ast::StrStyle) {
540         let st = match style {
541             ast::StrStyle::Cooked => (format!("\"{}\"", st.escape_debug())),
542             ast::StrStyle::Raw(n) => {
543                 format!("r{delim}\"{string}\"{delim}", delim = "#".repeat(n as usize), string = st)
544             }
545         };
546         self.word(st)
547     }
548
549     fn print_inner_attributes(&mut self, attrs: &[ast::Attribute]) {
550         self.print_either_attributes(attrs, ast::AttrStyle::Inner, false, true)
551     }
552
553     fn print_inner_attributes_no_trailing_hardbreak(&mut self, attrs: &[ast::Attribute]) {
554         self.print_either_attributes(attrs, ast::AttrStyle::Inner, false, false)
555     }
556
557     fn print_outer_attributes(&mut self, attrs: &[ast::Attribute]) {
558         self.print_either_attributes(attrs, ast::AttrStyle::Outer, false, true)
559     }
560
561     fn print_inner_attributes_inline(&mut self, attrs: &[ast::Attribute]) {
562         self.print_either_attributes(attrs, ast::AttrStyle::Inner, true, true)
563     }
564
565     fn print_outer_attributes_inline(&mut self, attrs: &[ast::Attribute]) {
566         self.print_either_attributes(attrs, ast::AttrStyle::Outer, true, true)
567     }
568
569     fn print_either_attributes(
570         &mut self,
571         attrs: &[ast::Attribute],
572         kind: ast::AttrStyle,
573         is_inline: bool,
574         trailing_hardbreak: bool,
575     ) {
576         let mut count = 0;
577         for attr in attrs {
578             if attr.style == kind {
579                 self.print_attribute_inline(attr, is_inline);
580                 if is_inline {
581                     self.nbsp();
582                 }
583                 count += 1;
584             }
585         }
586         if count > 0 && trailing_hardbreak && !is_inline {
587             self.hardbreak_if_not_bol();
588         }
589     }
590
591     fn print_attribute(&mut self, attr: &ast::Attribute) {
592         self.print_attribute_inline(attr, false)
593     }
594
595     fn print_attribute_inline(&mut self, attr: &ast::Attribute, is_inline: bool) {
596         if !is_inline {
597             self.hardbreak_if_not_bol();
598         }
599         self.maybe_print_comment(attr.span.lo());
600         match attr.kind {
601             ast::AttrKind::Normal(ref item) => {
602                 match attr.style {
603                     ast::AttrStyle::Inner => self.word("#!["),
604                     ast::AttrStyle::Outer => self.word("#["),
605                 }
606                 self.print_attr_item(&item, attr.span);
607                 self.word("]");
608             }
609             ast::AttrKind::DocComment(comment) => {
610                 self.word(comment.to_string());
611                 self.hardbreak()
612             }
613         }
614     }
615
616     fn print_attr_item(&mut self, item: &ast::AttrItem, span: Span) {
617         self.ibox(0);
618         match &item.args {
619             MacArgs::Delimited(_, delim, tokens) => self.print_mac_common(
620                 Some(MacHeader::Path(&item.path)),
621                 false,
622                 None,
623                 delim.to_token(),
624                 tokens.clone(),
625                 true,
626                 span,
627             ),
628             MacArgs::Empty | MacArgs::Eq(..) => {
629                 self.print_path(&item.path, false, 0);
630                 if let MacArgs::Eq(_, tokens) = &item.args {
631                     self.space();
632                     self.word_space("=");
633                     self.print_tts(tokens.clone(), true);
634                 }
635             }
636         }
637         self.end();
638     }
639
640     fn print_meta_list_item(&mut self, item: &ast::NestedMetaItem) {
641         match item {
642             ast::NestedMetaItem::MetaItem(ref mi) => self.print_meta_item(mi),
643             ast::NestedMetaItem::Literal(ref lit) => self.print_literal(lit),
644         }
645     }
646
647     fn print_meta_item(&mut self, item: &ast::MetaItem) {
648         self.ibox(INDENT_UNIT);
649         match item.kind {
650             ast::MetaItemKind::Word => self.print_path(&item.path, false, 0),
651             ast::MetaItemKind::NameValue(ref value) => {
652                 self.print_path(&item.path, false, 0);
653                 self.space();
654                 self.word_space("=");
655                 self.print_literal(value);
656             }
657             ast::MetaItemKind::List(ref items) => {
658                 self.print_path(&item.path, false, 0);
659                 self.popen();
660                 self.commasep(Consistent, &items[..], |s, i| s.print_meta_list_item(i));
661                 self.pclose();
662             }
663         }
664         self.end();
665     }
666
667     /// This doesn't deserve to be called "pretty" printing, but it should be
668     /// meaning-preserving. A quick hack that might help would be to look at the
669     /// spans embedded in the TTs to decide where to put spaces and newlines.
670     /// But it'd be better to parse these according to the grammar of the
671     /// appropriate macro, transcribe back into the grammar we just parsed from,
672     /// and then pretty-print the resulting AST nodes (so, e.g., we print
673     /// expression arguments as expressions). It can be done! I think.
674     fn print_tt(&mut self, tt: tokenstream::TokenTree, convert_dollar_crate: bool) {
675         match tt {
676             TokenTree::Token(ref token) => {
677                 self.word(token_to_string_ext(&token, convert_dollar_crate));
678                 match token.kind {
679                     token::DocComment(..) => self.hardbreak(),
680                     _ => {}
681                 }
682             }
683             TokenTree::Delimited(dspan, delim, tts) => {
684                 self.print_mac_common(
685                     None,
686                     false,
687                     None,
688                     delim,
689                     tts,
690                     convert_dollar_crate,
691                     dspan.entire(),
692                 );
693             }
694         }
695     }
696
697     fn print_tts(&mut self, tts: tokenstream::TokenStream, convert_dollar_crate: bool) {
698         for (i, tt) in tts.into_trees().enumerate() {
699             if i != 0 && tt_prepend_space(&tt) {
700                 self.space();
701             }
702             self.print_tt(tt, convert_dollar_crate);
703         }
704     }
705
706     fn print_mac_common(
707         &mut self,
708         header: Option<MacHeader<'_>>,
709         has_bang: bool,
710         ident: Option<ast::Ident>,
711         delim: DelimToken,
712         tts: TokenStream,
713         convert_dollar_crate: bool,
714         span: Span,
715     ) {
716         if delim == DelimToken::Brace {
717             self.cbox(INDENT_UNIT);
718         }
719         match header {
720             Some(MacHeader::Path(path)) => self.print_path(path, false, 0),
721             Some(MacHeader::Keyword(kw)) => self.word(kw),
722             None => {}
723         }
724         if has_bang {
725             self.word("!");
726         }
727         if let Some(ident) = ident {
728             self.nbsp();
729             self.print_ident(ident);
730         }
731         match delim {
732             DelimToken::Brace => {
733                 if header.is_some() || has_bang || ident.is_some() {
734                     self.nbsp();
735                 }
736                 self.word("{");
737                 if !tts.is_empty() {
738                     self.space();
739                 }
740             }
741             _ => self.word(token_kind_to_string(&token::OpenDelim(delim))),
742         }
743         self.ibox(0);
744         self.print_tts(tts, convert_dollar_crate);
745         self.end();
746         match delim {
747             DelimToken::Brace => self.bclose(span),
748             _ => self.word(token_kind_to_string(&token::CloseDelim(delim))),
749         }
750     }
751
752     fn print_path(&mut self, path: &ast::Path, colons_before_params: bool, depth: usize) {
753         self.maybe_print_comment(path.span.lo());
754
755         for (i, segment) in path.segments[..path.segments.len() - depth].iter().enumerate() {
756             if i > 0 {
757                 self.word("::")
758             }
759             self.print_path_segment(segment, colons_before_params);
760         }
761     }
762
763     fn print_path_segment(&mut self, segment: &ast::PathSegment, colons_before_params: bool) {
764         if segment.ident.name != kw::PathRoot {
765             self.print_ident(segment.ident);
766             if let Some(ref args) = segment.args {
767                 self.print_generic_args(args, colons_before_params);
768             }
769         }
770     }
771
772     fn head<S: Into<Cow<'static, str>>>(&mut self, w: S) {
773         let w = w.into();
774         // Outer-box is consistent.
775         self.cbox(INDENT_UNIT);
776         // Head-box is inconsistent.
777         self.ibox(w.len() + 1);
778         // Keyword that starts the head.
779         if !w.is_empty() {
780             self.word_nbsp(w);
781         }
782     }
783
784     fn bopen(&mut self) {
785         self.word("{");
786         self.end(); // Close the head-box.
787     }
788
789     fn bclose_maybe_open(&mut self, span: rustc_span::Span, close_box: bool) {
790         self.maybe_print_comment(span.hi());
791         self.break_offset_if_not_bol(1, -(INDENT_UNIT as isize));
792         self.word("}");
793         if close_box {
794             self.end(); // Close the outer-box.
795         }
796     }
797
798     fn bclose(&mut self, span: rustc_span::Span) {
799         self.bclose_maybe_open(span, true)
800     }
801
802     fn break_offset_if_not_bol(&mut self, n: usize, off: isize) {
803         if !self.is_beginning_of_line() {
804             self.break_offset(n, off)
805         } else {
806             if off != 0 && self.last_token().is_hardbreak_tok() {
807                 // We do something pretty sketchy here: tuck the nonzero
808                 // offset-adjustment we were going to deposit along with the
809                 // break into the previous hardbreak.
810                 self.replace_last_token(pp::Printer::hardbreak_tok_offset(off));
811             }
812         }
813     }
814 }
815
816 impl<'a> PrintState<'a> for State<'a> {
817     fn comments(&mut self) -> &mut Option<Comments<'a>> {
818         &mut self.comments
819     }
820
821     fn print_ident(&mut self, ident: ast::Ident) {
822         self.s.word(ast_ident_to_string(ident, ident.is_raw_guess()));
823         self.ann.post(self, AnnNode::Ident(&ident))
824     }
825
826     fn print_generic_args(&mut self, args: &ast::GenericArgs, colons_before_params: bool) {
827         if colons_before_params {
828             self.s.word("::")
829         }
830
831         match *args {
832             ast::GenericArgs::AngleBracketed(ref data) => {
833                 self.s.word("<");
834
835                 self.commasep(Inconsistent, &data.args, |s, generic_arg| {
836                     s.print_generic_arg(generic_arg)
837                 });
838
839                 let mut comma = data.args.len() != 0;
840
841                 for constraint in data.constraints.iter() {
842                     if comma {
843                         self.word_space(",")
844                     }
845                     self.print_ident(constraint.ident);
846                     self.s.space();
847                     match constraint.kind {
848                         ast::AssocTyConstraintKind::Equality { ref ty } => {
849                             self.word_space("=");
850                             self.print_type(ty);
851                         }
852                         ast::AssocTyConstraintKind::Bound { ref bounds } => {
853                             self.print_type_bounds(":", &*bounds);
854                         }
855                     }
856                     comma = true;
857                 }
858
859                 self.s.word(">")
860             }
861
862             ast::GenericArgs::Parenthesized(ref data) => {
863                 self.s.word("(");
864                 self.commasep(Inconsistent, &data.inputs, |s, ty| s.print_type(ty));
865                 self.s.word(")");
866                 self.print_fn_ret_ty(&data.output);
867             }
868         }
869     }
870 }
871
872 impl<'a> State<'a> {
873     // Synthesizes a comment that was not textually present in the original source
874     // file.
875     pub fn synth_comment(&mut self, text: String) {
876         self.s.word("/*");
877         self.s.space();
878         self.s.word(text);
879         self.s.space();
880         self.s.word("*/")
881     }
882
883     crate fn commasep_cmnt<T, F, G>(&mut self, b: Breaks, elts: &[T], mut op: F, mut get_span: G)
884     where
885         F: FnMut(&mut State<'_>, &T),
886         G: FnMut(&T) -> rustc_span::Span,
887     {
888         self.rbox(0, b);
889         let len = elts.len();
890         let mut i = 0;
891         for elt in elts {
892             self.maybe_print_comment(get_span(elt).hi());
893             op(self, elt);
894             i += 1;
895             if i < len {
896                 self.s.word(",");
897                 self.maybe_print_trailing_comment(get_span(elt), Some(get_span(&elts[i]).hi()));
898                 self.space_if_not_bol();
899             }
900         }
901         self.end();
902     }
903
904     crate fn commasep_exprs(&mut self, b: Breaks, exprs: &[P<ast::Expr>]) {
905         self.commasep_cmnt(b, exprs, |s, e| s.print_expr(e), |e| e.span)
906     }
907
908     pub fn print_mod(&mut self, _mod: &ast::Mod, attrs: &[ast::Attribute]) {
909         self.print_inner_attributes(attrs);
910         for item in &_mod.items {
911             self.print_item(item);
912         }
913     }
914
915     crate fn print_foreign_mod(&mut self, nmod: &ast::ForeignMod, attrs: &[ast::Attribute]) {
916         self.print_inner_attributes(attrs);
917         for item in &nmod.items {
918             self.print_foreign_item(item);
919         }
920     }
921
922     pub fn print_opt_lifetime(&mut self, lifetime: &Option<ast::Lifetime>) {
923         if let Some(lt) = *lifetime {
924             self.print_lifetime(lt);
925             self.nbsp();
926         }
927     }
928
929     crate fn print_generic_arg(&mut self, generic_arg: &GenericArg) {
930         match generic_arg {
931             GenericArg::Lifetime(lt) => self.print_lifetime(*lt),
932             GenericArg::Type(ty) => self.print_type(ty),
933             GenericArg::Const(ct) => self.print_expr(&ct.value),
934         }
935     }
936
937     pub fn print_type(&mut self, ty: &ast::Ty) {
938         self.maybe_print_comment(ty.span.lo());
939         self.ibox(0);
940         match ty.kind {
941             ast::TyKind::Slice(ref ty) => {
942                 self.s.word("[");
943                 self.print_type(ty);
944                 self.s.word("]");
945             }
946             ast::TyKind::Ptr(ref mt) => {
947                 self.s.word("*");
948                 self.print_mt(mt, true);
949             }
950             ast::TyKind::Rptr(ref lifetime, ref mt) => {
951                 self.s.word("&");
952                 self.print_opt_lifetime(lifetime);
953                 self.print_mt(mt, false);
954             }
955             ast::TyKind::Never => {
956                 self.s.word("!");
957             }
958             ast::TyKind::Tup(ref elts) => {
959                 self.popen();
960                 self.commasep(Inconsistent, &elts[..], |s, ty| s.print_type(ty));
961                 if elts.len() == 1 {
962                     self.s.word(",");
963                 }
964                 self.pclose();
965             }
966             ast::TyKind::Paren(ref typ) => {
967                 self.popen();
968                 self.print_type(typ);
969                 self.pclose();
970             }
971             ast::TyKind::BareFn(ref f) => {
972                 self.print_ty_fn(f.ext, f.unsafety, &f.decl, None, &f.generic_params);
973             }
974             ast::TyKind::Path(None, ref path) => {
975                 self.print_path(path, false, 0);
976             }
977             ast::TyKind::Path(Some(ref qself), ref path) => self.print_qpath(path, qself, false),
978             ast::TyKind::TraitObject(ref bounds, syntax) => {
979                 let prefix = if syntax == ast::TraitObjectSyntax::Dyn { "dyn" } else { "" };
980                 self.print_type_bounds(prefix, &bounds[..]);
981             }
982             ast::TyKind::ImplTrait(_, ref bounds) => {
983                 self.print_type_bounds("impl", &bounds[..]);
984             }
985             ast::TyKind::Array(ref ty, ref length) => {
986                 self.s.word("[");
987                 self.print_type(ty);
988                 self.s.word("; ");
989                 self.print_expr(&length.value);
990                 self.s.word("]");
991             }
992             ast::TyKind::Typeof(ref e) => {
993                 self.s.word("typeof(");
994                 self.print_expr(&e.value);
995                 self.s.word(")");
996             }
997             ast::TyKind::Infer => {
998                 self.s.word("_");
999             }
1000             ast::TyKind::Err => {
1001                 self.popen();
1002                 self.s.word("/*ERROR*/");
1003                 self.pclose();
1004             }
1005             ast::TyKind::ImplicitSelf => {
1006                 self.s.word("Self");
1007             }
1008             ast::TyKind::Mac(ref m) => {
1009                 self.print_mac(m);
1010             }
1011             ast::TyKind::CVarArgs => {
1012                 self.s.word("...");
1013             }
1014         }
1015         self.end();
1016     }
1017
1018     crate fn print_foreign_item(&mut self, item: &ast::ForeignItem) {
1019         self.hardbreak_if_not_bol();
1020         self.maybe_print_comment(item.span.lo());
1021         self.print_outer_attributes(&item.attrs);
1022         match item.kind {
1023             ast::ForeignItemKind::Fn(ref decl, ref generics) => {
1024                 self.head("");
1025                 self.print_fn(
1026                     decl,
1027                     ast::FnHeader::default(),
1028                     Some(item.ident),
1029                     generics,
1030                     &item.vis,
1031                 );
1032                 self.end(); // end head-ibox
1033                 self.s.word(";");
1034                 self.end(); // end the outer fn box
1035             }
1036             ast::ForeignItemKind::Static(ref t, m) => {
1037                 self.head(visibility_qualified(&item.vis, "static"));
1038                 if m == ast::Mutability::Mut {
1039                     self.word_space("mut");
1040                 }
1041                 self.print_ident(item.ident);
1042                 self.word_space(":");
1043                 self.print_type(t);
1044                 self.s.word(";");
1045                 self.end(); // end the head-ibox
1046                 self.end(); // end the outer cbox
1047             }
1048             ast::ForeignItemKind::Ty => {
1049                 self.head(visibility_qualified(&item.vis, "type"));
1050                 self.print_ident(item.ident);
1051                 self.s.word(";");
1052                 self.end(); // end the head-ibox
1053                 self.end(); // end the outer cbox
1054             }
1055             ast::ForeignItemKind::Macro(ref m) => {
1056                 self.print_mac(m);
1057                 if m.args.need_semicolon() {
1058                     self.s.word(";");
1059                 }
1060             }
1061         }
1062     }
1063
1064     fn print_associated_const(
1065         &mut self,
1066         ident: ast::Ident,
1067         ty: &ast::Ty,
1068         default: Option<&ast::Expr>,
1069         vis: &ast::Visibility,
1070     ) {
1071         self.s.word(visibility_qualified(vis, ""));
1072         self.word_space("const");
1073         self.print_ident(ident);
1074         self.word_space(":");
1075         self.print_type(ty);
1076         if let Some(expr) = default {
1077             self.s.space();
1078             self.word_space("=");
1079             self.print_expr(expr);
1080         }
1081         self.s.word(";")
1082     }
1083
1084     fn print_associated_type(
1085         &mut self,
1086         ident: ast::Ident,
1087         bounds: &ast::GenericBounds,
1088         ty: Option<&ast::Ty>,
1089     ) {
1090         self.word_space("type");
1091         self.print_ident(ident);
1092         self.print_type_bounds(":", bounds);
1093         if let Some(ty) = ty {
1094             self.s.space();
1095             self.word_space("=");
1096             self.print_type(ty);
1097         }
1098         self.s.word(";")
1099     }
1100
1101     /// Pretty-prints an item.
1102     crate fn print_item(&mut self, item: &ast::Item) {
1103         self.hardbreak_if_not_bol();
1104         self.maybe_print_comment(item.span.lo());
1105         self.print_outer_attributes(&item.attrs);
1106         self.ann.pre(self, AnnNode::Item(item));
1107         match item.kind {
1108             ast::ItemKind::ExternCrate(orig_name) => {
1109                 self.head(visibility_qualified(&item.vis, "extern crate"));
1110                 if let Some(orig_name) = orig_name {
1111                     self.print_name(orig_name);
1112                     self.s.space();
1113                     self.s.word("as");
1114                     self.s.space();
1115                 }
1116                 self.print_ident(item.ident);
1117                 self.s.word(";");
1118                 self.end(); // end inner head-block
1119                 self.end(); // end outer head-block
1120             }
1121             ast::ItemKind::Use(ref tree) => {
1122                 self.head(visibility_qualified(&item.vis, "use"));
1123                 self.print_use_tree(tree);
1124                 self.s.word(";");
1125                 self.end(); // end inner head-block
1126                 self.end(); // end outer head-block
1127             }
1128             ast::ItemKind::Static(ref ty, m, ref expr) => {
1129                 self.head(visibility_qualified(&item.vis, "static"));
1130                 if m == ast::Mutability::Mut {
1131                     self.word_space("mut");
1132                 }
1133                 self.print_ident(item.ident);
1134                 self.word_space(":");
1135                 self.print_type(ty);
1136                 self.s.space();
1137                 self.end(); // end the head-ibox
1138
1139                 self.word_space("=");
1140                 self.print_expr(expr);
1141                 self.s.word(";");
1142                 self.end(); // end the outer cbox
1143             }
1144             ast::ItemKind::Const(ref ty, ref expr) => {
1145                 self.head(visibility_qualified(&item.vis, "const"));
1146                 self.print_ident(item.ident);
1147                 self.word_space(":");
1148                 self.print_type(ty);
1149                 self.s.space();
1150                 self.end(); // end the head-ibox
1151
1152                 self.word_space("=");
1153                 self.print_expr(expr);
1154                 self.s.word(";");
1155                 self.end(); // end the outer cbox
1156             }
1157             ast::ItemKind::Fn(ref sig, ref param_names, ref body) => {
1158                 self.head("");
1159                 self.print_fn(&sig.decl, sig.header, Some(item.ident), param_names, &item.vis);
1160                 self.s.word(" ");
1161                 self.print_block_with_attrs(body, &item.attrs);
1162             }
1163             ast::ItemKind::Mod(ref _mod) => {
1164                 self.head(visibility_qualified(&item.vis, "mod"));
1165                 self.print_ident(item.ident);
1166
1167                 if _mod.inline || self.is_expanded {
1168                     self.nbsp();
1169                     self.bopen();
1170                     self.print_mod(_mod, &item.attrs);
1171                     self.bclose(item.span);
1172                 } else {
1173                     self.s.word(";");
1174                     self.end(); // end inner head-block
1175                     self.end(); // end outer head-block
1176                 }
1177             }
1178             ast::ItemKind::ForeignMod(ref nmod) => {
1179                 self.head("extern");
1180                 if let Some(abi) = nmod.abi {
1181                     self.print_literal(&abi.as_lit());
1182                     self.nbsp();
1183                 }
1184                 self.bopen();
1185                 self.print_foreign_mod(nmod, &item.attrs);
1186                 self.bclose(item.span);
1187             }
1188             ast::ItemKind::GlobalAsm(ref ga) => {
1189                 self.head(visibility_qualified(&item.vis, "global_asm!"));
1190                 self.s.word(ga.asm.to_string());
1191                 self.end();
1192             }
1193             ast::ItemKind::TyAlias(ref ty, ref generics) => {
1194                 self.head(visibility_qualified(&item.vis, "type"));
1195                 self.print_ident(item.ident);
1196                 self.print_generic_params(&generics.params);
1197                 self.end(); // end the inner ibox
1198
1199                 self.print_where_clause(&generics.where_clause);
1200                 self.s.space();
1201                 self.word_space("=");
1202                 self.print_type(ty);
1203                 self.s.word(";");
1204                 self.end(); // end the outer ibox
1205             }
1206             ast::ItemKind::Enum(ref enum_definition, ref params) => {
1207                 self.print_enum_def(enum_definition, params, item.ident, item.span, &item.vis);
1208             }
1209             ast::ItemKind::Struct(ref struct_def, ref generics) => {
1210                 self.head(visibility_qualified(&item.vis, "struct"));
1211                 self.print_struct(struct_def, generics, item.ident, item.span, true);
1212             }
1213             ast::ItemKind::Union(ref struct_def, ref generics) => {
1214                 self.head(visibility_qualified(&item.vis, "union"));
1215                 self.print_struct(struct_def, generics, item.ident, item.span, true);
1216             }
1217             ast::ItemKind::Impl {
1218                 unsafety,
1219                 polarity,
1220                 defaultness,
1221                 constness,
1222                 ref generics,
1223                 ref of_trait,
1224                 ref self_ty,
1225                 ref items,
1226             } => {
1227                 self.head("");
1228                 self.print_visibility(&item.vis);
1229                 self.print_defaultness(defaultness);
1230                 self.print_unsafety(unsafety);
1231                 self.word_nbsp("impl");
1232                 self.print_constness(constness);
1233
1234                 if !generics.params.is_empty() {
1235                     self.print_generic_params(&generics.params);
1236                     self.s.space();
1237                 }
1238
1239                 if polarity == ast::ImplPolarity::Negative {
1240                     self.s.word("!");
1241                 }
1242
1243                 if let Some(ref t) = *of_trait {
1244                     self.print_trait_ref(t);
1245                     self.s.space();
1246                     self.word_space("for");
1247                 }
1248
1249                 self.print_type(self_ty);
1250                 self.print_where_clause(&generics.where_clause);
1251
1252                 self.s.space();
1253                 self.bopen();
1254                 self.print_inner_attributes(&item.attrs);
1255                 for impl_item in items {
1256                     self.print_assoc_item(impl_item);
1257                 }
1258                 self.bclose(item.span);
1259             }
1260             ast::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref trait_items) => {
1261                 self.head("");
1262                 self.print_visibility(&item.vis);
1263                 self.print_unsafety(unsafety);
1264                 self.print_is_auto(is_auto);
1265                 self.word_nbsp("trait");
1266                 self.print_ident(item.ident);
1267                 self.print_generic_params(&generics.params);
1268                 let mut real_bounds = Vec::with_capacity(bounds.len());
1269                 for b in bounds.iter() {
1270                     if let GenericBound::Trait(ref ptr, ast::TraitBoundModifier::Maybe) = *b {
1271                         self.s.space();
1272                         self.word_space("for ?");
1273                         self.print_trait_ref(&ptr.trait_ref);
1274                     } else {
1275                         real_bounds.push(b.clone());
1276                     }
1277                 }
1278                 self.print_type_bounds(":", &real_bounds[..]);
1279                 self.print_where_clause(&generics.where_clause);
1280                 self.s.word(" ");
1281                 self.bopen();
1282                 for trait_item in trait_items {
1283                     self.print_assoc_item(trait_item);
1284                 }
1285                 self.bclose(item.span);
1286             }
1287             ast::ItemKind::TraitAlias(ref generics, ref bounds) => {
1288                 self.head("");
1289                 self.print_visibility(&item.vis);
1290                 self.word_nbsp("trait");
1291                 self.print_ident(item.ident);
1292                 self.print_generic_params(&generics.params);
1293                 let mut real_bounds = Vec::with_capacity(bounds.len());
1294                 // FIXME(durka) this seems to be some quite outdated syntax
1295                 for b in bounds.iter() {
1296                     if let GenericBound::Trait(ref ptr, ast::TraitBoundModifier::Maybe) = *b {
1297                         self.s.space();
1298                         self.word_space("for ?");
1299                         self.print_trait_ref(&ptr.trait_ref);
1300                     } else {
1301                         real_bounds.push(b.clone());
1302                     }
1303                 }
1304                 self.nbsp();
1305                 self.print_type_bounds("=", &real_bounds[..]);
1306                 self.print_where_clause(&generics.where_clause);
1307                 self.s.word(";");
1308             }
1309             ast::ItemKind::Mac(ref mac) => {
1310                 self.print_mac(mac);
1311                 if mac.args.need_semicolon() {
1312                     self.s.word(";");
1313                 }
1314             }
1315             ast::ItemKind::MacroDef(ref macro_def) => {
1316                 let (kw, has_bang) = if macro_def.legacy {
1317                     ("macro_rules", true)
1318                 } else {
1319                     self.print_visibility(&item.vis);
1320                     ("macro", false)
1321                 };
1322                 self.print_mac_common(
1323                     Some(MacHeader::Keyword(kw)),
1324                     has_bang,
1325                     Some(item.ident),
1326                     macro_def.body.delim(),
1327                     macro_def.body.inner_tokens(),
1328                     true,
1329                     item.span,
1330                 );
1331             }
1332         }
1333         self.ann.post(self, AnnNode::Item(item))
1334     }
1335
1336     fn print_trait_ref(&mut self, t: &ast::TraitRef) {
1337         self.print_path(&t.path, false, 0)
1338     }
1339
1340     fn print_formal_generic_params(&mut self, generic_params: &[ast::GenericParam]) {
1341         if !generic_params.is_empty() {
1342             self.s.word("for");
1343             self.print_generic_params(generic_params);
1344             self.nbsp();
1345         }
1346     }
1347
1348     fn print_poly_trait_ref(&mut self, t: &ast::PolyTraitRef) {
1349         self.print_formal_generic_params(&t.bound_generic_params);
1350         self.print_trait_ref(&t.trait_ref)
1351     }
1352
1353     crate fn print_enum_def(
1354         &mut self,
1355         enum_definition: &ast::EnumDef,
1356         generics: &ast::Generics,
1357         ident: ast::Ident,
1358         span: rustc_span::Span,
1359         visibility: &ast::Visibility,
1360     ) {
1361         self.head(visibility_qualified(visibility, "enum"));
1362         self.print_ident(ident);
1363         self.print_generic_params(&generics.params);
1364         self.print_where_clause(&generics.where_clause);
1365         self.s.space();
1366         self.print_variants(&enum_definition.variants, span)
1367     }
1368
1369     crate fn print_variants(&mut self, variants: &[ast::Variant], span: rustc_span::Span) {
1370         self.bopen();
1371         for v in variants {
1372             self.space_if_not_bol();
1373             self.maybe_print_comment(v.span.lo());
1374             self.print_outer_attributes(&v.attrs);
1375             self.ibox(INDENT_UNIT);
1376             self.print_variant(v);
1377             self.s.word(",");
1378             self.end();
1379             self.maybe_print_trailing_comment(v.span, None);
1380         }
1381         self.bclose(span)
1382     }
1383
1384     crate fn print_visibility(&mut self, vis: &ast::Visibility) {
1385         match vis.node {
1386             ast::VisibilityKind::Public => self.word_nbsp("pub"),
1387             ast::VisibilityKind::Crate(sugar) => match sugar {
1388                 ast::CrateSugar::PubCrate => self.word_nbsp("pub(crate)"),
1389                 ast::CrateSugar::JustCrate => self.word_nbsp("crate"),
1390             },
1391             ast::VisibilityKind::Restricted { ref path, .. } => {
1392                 let path = to_string(|s| s.print_path(path, false, 0));
1393                 if path == "self" || path == "super" {
1394                     self.word_nbsp(format!("pub({})", path))
1395                 } else {
1396                     self.word_nbsp(format!("pub(in {})", path))
1397                 }
1398             }
1399             ast::VisibilityKind::Inherited => {}
1400         }
1401     }
1402
1403     crate fn print_defaultness(&mut self, defaultness: ast::Defaultness) {
1404         if let ast::Defaultness::Default = defaultness {
1405             self.word_nbsp("default");
1406         }
1407     }
1408
1409     crate fn print_struct(
1410         &mut self,
1411         struct_def: &ast::VariantData,
1412         generics: &ast::Generics,
1413         ident: ast::Ident,
1414         span: rustc_span::Span,
1415         print_finalizer: bool,
1416     ) {
1417         self.print_ident(ident);
1418         self.print_generic_params(&generics.params);
1419         match struct_def {
1420             ast::VariantData::Tuple(..) | ast::VariantData::Unit(..) => {
1421                 if let ast::VariantData::Tuple(..) = struct_def {
1422                     self.popen();
1423                     self.commasep(Inconsistent, struct_def.fields(), |s, field| {
1424                         s.maybe_print_comment(field.span.lo());
1425                         s.print_outer_attributes(&field.attrs);
1426                         s.print_visibility(&field.vis);
1427                         s.print_type(&field.ty)
1428                     });
1429                     self.pclose();
1430                 }
1431                 self.print_where_clause(&generics.where_clause);
1432                 if print_finalizer {
1433                     self.s.word(";");
1434                 }
1435                 self.end();
1436                 self.end(); // Close the outer-box.
1437             }
1438             ast::VariantData::Struct(..) => {
1439                 self.print_where_clause(&generics.where_clause);
1440                 self.nbsp();
1441                 self.bopen();
1442                 self.hardbreak_if_not_bol();
1443
1444                 for field in struct_def.fields() {
1445                     self.hardbreak_if_not_bol();
1446                     self.maybe_print_comment(field.span.lo());
1447                     self.print_outer_attributes(&field.attrs);
1448                     self.print_visibility(&field.vis);
1449                     self.print_ident(field.ident.unwrap());
1450                     self.word_nbsp(":");
1451                     self.print_type(&field.ty);
1452                     self.s.word(",");
1453                 }
1454
1455                 self.bclose(span)
1456             }
1457         }
1458     }
1459
1460     crate fn print_variant(&mut self, v: &ast::Variant) {
1461         self.head("");
1462         self.print_visibility(&v.vis);
1463         let generics = ast::Generics::default();
1464         self.print_struct(&v.data, &generics, v.ident, v.span, false);
1465         match v.disr_expr {
1466             Some(ref d) => {
1467                 self.s.space();
1468                 self.word_space("=");
1469                 self.print_expr(&d.value)
1470             }
1471             _ => {}
1472         }
1473     }
1474
1475     crate fn print_assoc_item(&mut self, item: &ast::AssocItem) {
1476         self.ann.pre(self, AnnNode::SubItem(item.id));
1477         self.hardbreak_if_not_bol();
1478         self.maybe_print_comment(item.span.lo());
1479         self.print_outer_attributes(&item.attrs);
1480         self.print_defaultness(item.defaultness);
1481         match &item.kind {
1482             ast::AssocItemKind::Const(ty, expr) => {
1483                 self.print_associated_const(item.ident, ty, expr.as_deref(), &item.vis);
1484             }
1485             ast::AssocItemKind::Fn(sig, body) => {
1486                 if body.is_some() {
1487                     self.head("");
1488                 }
1489                 self.print_fn(&sig.decl, sig.header, Some(item.ident), &item.generics, &item.vis);
1490                 if let Some(body) = body {
1491                     self.nbsp();
1492                     self.print_block_with_attrs(body, &item.attrs);
1493                 } else {
1494                     self.s.word(";");
1495                 }
1496             }
1497             ast::AssocItemKind::TyAlias(bounds, ty) => {
1498                 self.print_associated_type(item.ident, bounds, ty.as_deref());
1499             }
1500             ast::AssocItemKind::Macro(mac) => {
1501                 self.print_mac(mac);
1502                 if mac.args.need_semicolon() {
1503                     self.s.word(";");
1504                 }
1505             }
1506         }
1507         self.ann.post(self, AnnNode::SubItem(item.id))
1508     }
1509
1510     crate fn print_stmt(&mut self, st: &ast::Stmt) {
1511         self.maybe_print_comment(st.span.lo());
1512         match st.kind {
1513             ast::StmtKind::Local(ref loc) => {
1514                 self.print_outer_attributes(&loc.attrs);
1515                 self.space_if_not_bol();
1516                 self.ibox(INDENT_UNIT);
1517                 self.word_nbsp("let");
1518
1519                 self.ibox(INDENT_UNIT);
1520                 self.print_local_decl(loc);
1521                 self.end();
1522                 if let Some(ref init) = loc.init {
1523                     self.nbsp();
1524                     self.word_space("=");
1525                     self.print_expr(init);
1526                 }
1527                 self.s.word(";");
1528                 self.end();
1529             }
1530             ast::StmtKind::Item(ref item) => self.print_item(item),
1531             ast::StmtKind::Expr(ref expr) => {
1532                 self.space_if_not_bol();
1533                 self.print_expr_outer_attr_style(expr, false);
1534                 if classify::expr_requires_semi_to_be_stmt(expr) {
1535                     self.s.word(";");
1536                 }
1537             }
1538             ast::StmtKind::Semi(ref expr) => {
1539                 match expr.kind {
1540                     // Filter out empty `Tup` exprs created for the `redundant_semicolon`
1541                     // lint, as they shouldn't be visible and interact poorly
1542                     // with proc macros.
1543                     ast::ExprKind::Tup(ref exprs) if exprs.is_empty() && expr.attrs.is_empty() => {
1544                         ()
1545                     }
1546                     _ => {
1547                         self.space_if_not_bol();
1548                         self.print_expr_outer_attr_style(expr, false);
1549                         self.s.word(";");
1550                     }
1551                 }
1552             }
1553             ast::StmtKind::Mac(ref mac) => {
1554                 let (ref mac, style, ref attrs) = **mac;
1555                 self.space_if_not_bol();
1556                 self.print_outer_attributes(attrs);
1557                 self.print_mac(mac);
1558                 if style == ast::MacStmtStyle::Semicolon {
1559                     self.s.word(";");
1560                 }
1561             }
1562         }
1563         self.maybe_print_trailing_comment(st.span, None)
1564     }
1565
1566     crate fn print_block(&mut self, blk: &ast::Block) {
1567         self.print_block_with_attrs(blk, &[])
1568     }
1569
1570     crate fn print_block_unclosed_indent(&mut self, blk: &ast::Block) {
1571         self.print_block_maybe_unclosed(blk, &[], false)
1572     }
1573
1574     crate fn print_block_with_attrs(&mut self, blk: &ast::Block, attrs: &[ast::Attribute]) {
1575         self.print_block_maybe_unclosed(blk, attrs, true)
1576     }
1577
1578     crate fn print_block_maybe_unclosed(
1579         &mut self,
1580         blk: &ast::Block,
1581         attrs: &[ast::Attribute],
1582         close_box: bool,
1583     ) {
1584         match blk.rules {
1585             BlockCheckMode::Unsafe(..) => self.word_space("unsafe"),
1586             BlockCheckMode::Default => (),
1587         }
1588         self.maybe_print_comment(blk.span.lo());
1589         self.ann.pre(self, AnnNode::Block(blk));
1590         self.bopen();
1591
1592         self.print_inner_attributes(attrs);
1593
1594         for (i, st) in blk.stmts.iter().enumerate() {
1595             match st.kind {
1596                 ast::StmtKind::Expr(ref expr) if i == blk.stmts.len() - 1 => {
1597                     self.maybe_print_comment(st.span.lo());
1598                     self.space_if_not_bol();
1599                     self.print_expr_outer_attr_style(expr, false);
1600                     self.maybe_print_trailing_comment(expr.span, Some(blk.span.hi()));
1601                 }
1602                 _ => self.print_stmt(st),
1603             }
1604         }
1605
1606         self.bclose_maybe_open(blk.span, close_box);
1607         self.ann.post(self, AnnNode::Block(blk))
1608     }
1609
1610     /// Print a `let pat = scrutinee` expression.
1611     crate fn print_let(&mut self, pat: &ast::Pat, scrutinee: &ast::Expr) {
1612         self.s.word("let ");
1613
1614         self.print_pat(pat);
1615         self.s.space();
1616
1617         self.word_space("=");
1618         self.print_expr_cond_paren(
1619             scrutinee,
1620             Self::cond_needs_par(scrutinee)
1621                 || parser::needs_par_as_let_scrutinee(scrutinee.precedence().order()),
1622         )
1623     }
1624
1625     fn print_else(&mut self, els: Option<&ast::Expr>) {
1626         if let Some(_else) = els {
1627             match _else.kind {
1628                 // Another `else if` block.
1629                 ast::ExprKind::If(ref i, ref then, ref e) => {
1630                     self.cbox(INDENT_UNIT - 1);
1631                     self.ibox(0);
1632                     self.s.word(" else if ");
1633                     self.print_expr_as_cond(i);
1634                     self.s.space();
1635                     self.print_block(then);
1636                     self.print_else(e.as_deref())
1637                 }
1638                 // Final `else` block.
1639                 ast::ExprKind::Block(ref b, _) => {
1640                     self.cbox(INDENT_UNIT - 1);
1641                     self.ibox(0);
1642                     self.s.word(" else ");
1643                     self.print_block(b)
1644                 }
1645                 // Constraints would be great here!
1646                 _ => {
1647                     panic!("print_if saw if with weird alternative");
1648                 }
1649             }
1650         }
1651     }
1652
1653     crate fn print_if(&mut self, test: &ast::Expr, blk: &ast::Block, elseopt: Option<&ast::Expr>) {
1654         self.head("if");
1655
1656         self.print_expr_as_cond(test);
1657         self.s.space();
1658
1659         self.print_block(blk);
1660         self.print_else(elseopt)
1661     }
1662
1663     crate fn print_mac(&mut self, m: &ast::Mac) {
1664         self.print_mac_common(
1665             Some(MacHeader::Path(&m.path)),
1666             true,
1667             None,
1668             m.args.delim(),
1669             m.args.inner_tokens(),
1670             true,
1671             m.span(),
1672         );
1673     }
1674
1675     fn print_call_post(&mut self, args: &[P<ast::Expr>]) {
1676         self.popen();
1677         self.commasep_exprs(Inconsistent, args);
1678         self.pclose()
1679     }
1680
1681     crate fn print_expr_maybe_paren(&mut self, expr: &ast::Expr, prec: i8) {
1682         self.print_expr_cond_paren(expr, expr.precedence().order() < prec)
1683     }
1684
1685     /// Prints an expr using syntax that's acceptable in a condition position, such as the `cond` in
1686     /// `if cond { ... }`.
1687     crate fn print_expr_as_cond(&mut self, expr: &ast::Expr) {
1688         self.print_expr_cond_paren(expr, Self::cond_needs_par(expr))
1689     }
1690
1691     /// Does `expr` need parenthesis when printed in a condition position?
1692     fn cond_needs_par(expr: &ast::Expr) -> bool {
1693         match expr.kind {
1694             // These cases need parens due to the parse error observed in #26461: `if return {}`
1695             // parses as the erroneous construct `if (return {})`, not `if (return) {}`.
1696             ast::ExprKind::Closure(..) | ast::ExprKind::Ret(..) | ast::ExprKind::Break(..) => true,
1697
1698             _ => parser::contains_exterior_struct_lit(expr),
1699         }
1700     }
1701
1702     /// Prints `expr` or `(expr)` when `needs_par` holds.
1703     fn print_expr_cond_paren(&mut self, expr: &ast::Expr, needs_par: bool) {
1704         if needs_par {
1705             self.popen();
1706         }
1707         self.print_expr(expr);
1708         if needs_par {
1709             self.pclose();
1710         }
1711     }
1712
1713     fn print_expr_vec(&mut self, exprs: &[P<ast::Expr>], attrs: &[Attribute]) {
1714         self.ibox(INDENT_UNIT);
1715         self.s.word("[");
1716         self.print_inner_attributes_inline(attrs);
1717         self.commasep_exprs(Inconsistent, &exprs[..]);
1718         self.s.word("]");
1719         self.end();
1720     }
1721
1722     fn print_expr_repeat(
1723         &mut self,
1724         element: &ast::Expr,
1725         count: &ast::AnonConst,
1726         attrs: &[Attribute],
1727     ) {
1728         self.ibox(INDENT_UNIT);
1729         self.s.word("[");
1730         self.print_inner_attributes_inline(attrs);
1731         self.print_expr(element);
1732         self.word_space(";");
1733         self.print_expr(&count.value);
1734         self.s.word("]");
1735         self.end();
1736     }
1737
1738     fn print_expr_struct(
1739         &mut self,
1740         path: &ast::Path,
1741         fields: &[ast::Field],
1742         wth: &Option<P<ast::Expr>>,
1743         attrs: &[Attribute],
1744     ) {
1745         self.print_path(path, true, 0);
1746         self.s.word("{");
1747         self.print_inner_attributes_inline(attrs);
1748         self.commasep_cmnt(
1749             Consistent,
1750             &fields[..],
1751             |s, field| {
1752                 s.ibox(INDENT_UNIT);
1753                 if !field.is_shorthand {
1754                     s.print_ident(field.ident);
1755                     s.word_space(":");
1756                 }
1757                 s.print_expr(&field.expr);
1758                 s.end();
1759             },
1760             |f| f.span,
1761         );
1762         match *wth {
1763             Some(ref expr) => {
1764                 self.ibox(INDENT_UNIT);
1765                 if !fields.is_empty() {
1766                     self.s.word(",");
1767                     self.s.space();
1768                 }
1769                 self.s.word("..");
1770                 self.print_expr(expr);
1771                 self.end();
1772             }
1773             _ => {
1774                 if !fields.is_empty() {
1775                     self.s.word(",")
1776                 }
1777             }
1778         }
1779         self.s.word("}");
1780     }
1781
1782     fn print_expr_tup(&mut self, exprs: &[P<ast::Expr>], attrs: &[Attribute]) {
1783         self.popen();
1784         self.print_inner_attributes_inline(attrs);
1785         self.commasep_exprs(Inconsistent, &exprs[..]);
1786         if exprs.len() == 1 {
1787             self.s.word(",");
1788         }
1789         self.pclose()
1790     }
1791
1792     fn print_expr_call(&mut self, func: &ast::Expr, args: &[P<ast::Expr>]) {
1793         let prec = match func.kind {
1794             ast::ExprKind::Field(..) => parser::PREC_FORCE_PAREN,
1795             _ => parser::PREC_POSTFIX,
1796         };
1797
1798         self.print_expr_maybe_paren(func, prec);
1799         self.print_call_post(args)
1800     }
1801
1802     fn print_expr_method_call(&mut self, segment: &ast::PathSegment, args: &[P<ast::Expr>]) {
1803         let base_args = &args[1..];
1804         self.print_expr_maybe_paren(&args[0], parser::PREC_POSTFIX);
1805         self.s.word(".");
1806         self.print_ident(segment.ident);
1807         if let Some(ref args) = segment.args {
1808             self.print_generic_args(args, true);
1809         }
1810         self.print_call_post(base_args)
1811     }
1812
1813     fn print_expr_binary(&mut self, op: ast::BinOp, lhs: &ast::Expr, rhs: &ast::Expr) {
1814         let assoc_op = AssocOp::from_ast_binop(op.node);
1815         let prec = assoc_op.precedence() as i8;
1816         let fixity = assoc_op.fixity();
1817
1818         let (left_prec, right_prec) = match fixity {
1819             Fixity::Left => (prec, prec + 1),
1820             Fixity::Right => (prec + 1, prec),
1821             Fixity::None => (prec + 1, prec + 1),
1822         };
1823
1824         let left_prec = match (&lhs.kind, op.node) {
1825             // These cases need parens: `x as i32 < y` has the parser thinking that `i32 < y` is
1826             // the beginning of a path type. It starts trying to parse `x as (i32 < y ...` instead
1827             // of `(x as i32) < ...`. We need to convince it _not_ to do that.
1828             (&ast::ExprKind::Cast { .. }, ast::BinOpKind::Lt)
1829             | (&ast::ExprKind::Cast { .. }, ast::BinOpKind::Shl) => parser::PREC_FORCE_PAREN,
1830             // We are given `(let _ = a) OP b`.
1831             //
1832             // - When `OP <= LAnd` we should print `let _ = a OP b` to avoid redundant parens
1833             //   as the parser will interpret this as `(let _ = a) OP b`.
1834             //
1835             // - Otherwise, e.g. when we have `(let a = b) < c` in AST,
1836             //   parens are required since the parser would interpret `let a = b < c` as
1837             //   `let a = (b < c)`. To achieve this, we force parens.
1838             (&ast::ExprKind::Let { .. }, _) if !parser::needs_par_as_let_scrutinee(prec) => {
1839                 parser::PREC_FORCE_PAREN
1840             }
1841             _ => left_prec,
1842         };
1843
1844         self.print_expr_maybe_paren(lhs, left_prec);
1845         self.s.space();
1846         self.word_space(op.node.to_string());
1847         self.print_expr_maybe_paren(rhs, right_prec)
1848     }
1849
1850     fn print_expr_unary(&mut self, op: ast::UnOp, expr: &ast::Expr) {
1851         self.s.word(ast::UnOp::to_string(op));
1852         self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1853     }
1854
1855     fn print_expr_addr_of(
1856         &mut self,
1857         kind: ast::BorrowKind,
1858         mutability: ast::Mutability,
1859         expr: &ast::Expr,
1860     ) {
1861         self.s.word("&");
1862         match kind {
1863             ast::BorrowKind::Ref => self.print_mutability(mutability, false),
1864             ast::BorrowKind::Raw => {
1865                 self.word_nbsp("raw");
1866                 self.print_mutability(mutability, true);
1867             }
1868         }
1869         self.print_expr_maybe_paren(expr, parser::PREC_PREFIX)
1870     }
1871
1872     pub fn print_expr(&mut self, expr: &ast::Expr) {
1873         self.print_expr_outer_attr_style(expr, true)
1874     }
1875
1876     fn print_expr_outer_attr_style(&mut self, expr: &ast::Expr, is_inline: bool) {
1877         self.maybe_print_comment(expr.span.lo());
1878
1879         let attrs = &expr.attrs;
1880         if is_inline {
1881             self.print_outer_attributes_inline(attrs);
1882         } else {
1883             self.print_outer_attributes(attrs);
1884         }
1885
1886         self.ibox(INDENT_UNIT);
1887         self.ann.pre(self, AnnNode::Expr(expr));
1888         match expr.kind {
1889             ast::ExprKind::Box(ref expr) => {
1890                 self.word_space("box");
1891                 self.print_expr_maybe_paren(expr, parser::PREC_PREFIX);
1892             }
1893             ast::ExprKind::Array(ref exprs) => {
1894                 self.print_expr_vec(&exprs[..], attrs);
1895             }
1896             ast::ExprKind::Repeat(ref element, ref count) => {
1897                 self.print_expr_repeat(element, count, attrs);
1898             }
1899             ast::ExprKind::Struct(ref path, ref fields, ref wth) => {
1900                 self.print_expr_struct(path, &fields[..], wth, attrs);
1901             }
1902             ast::ExprKind::Tup(ref exprs) => {
1903                 self.print_expr_tup(&exprs[..], attrs);
1904             }
1905             ast::ExprKind::Call(ref func, ref args) => {
1906                 self.print_expr_call(func, &args[..]);
1907             }
1908             ast::ExprKind::MethodCall(ref segment, ref args) => {
1909                 self.print_expr_method_call(segment, &args[..]);
1910             }
1911             ast::ExprKind::Binary(op, ref lhs, ref rhs) => {
1912                 self.print_expr_binary(op, lhs, rhs);
1913             }
1914             ast::ExprKind::Unary(op, ref expr) => {
1915                 self.print_expr_unary(op, expr);
1916             }
1917             ast::ExprKind::AddrOf(k, m, ref expr) => {
1918                 self.print_expr_addr_of(k, m, expr);
1919             }
1920             ast::ExprKind::Lit(ref lit) => {
1921                 self.print_literal(lit);
1922             }
1923             ast::ExprKind::Cast(ref expr, ref ty) => {
1924                 let prec = AssocOp::As.precedence() as i8;
1925                 self.print_expr_maybe_paren(expr, prec);
1926                 self.s.space();
1927                 self.word_space("as");
1928                 self.print_type(ty);
1929             }
1930             ast::ExprKind::Type(ref expr, ref ty) => {
1931                 let prec = AssocOp::Colon.precedence() as i8;
1932                 self.print_expr_maybe_paren(expr, prec);
1933                 self.word_space(":");
1934                 self.print_type(ty);
1935             }
1936             ast::ExprKind::Let(ref pat, ref scrutinee) => {
1937                 self.print_let(pat, scrutinee);
1938             }
1939             ast::ExprKind::If(ref test, ref blk, ref elseopt) => {
1940                 self.print_if(test, blk, elseopt.as_deref())
1941             }
1942             ast::ExprKind::While(ref test, ref blk, opt_label) => {
1943                 if let Some(label) = opt_label {
1944                     self.print_ident(label.ident);
1945                     self.word_space(":");
1946                 }
1947                 self.head("while");
1948                 self.print_expr_as_cond(test);
1949                 self.s.space();
1950                 self.print_block_with_attrs(blk, attrs);
1951             }
1952             ast::ExprKind::ForLoop(ref pat, ref iter, ref blk, opt_label) => {
1953                 if let Some(label) = opt_label {
1954                     self.print_ident(label.ident);
1955                     self.word_space(":");
1956                 }
1957                 self.head("for");
1958                 self.print_pat(pat);
1959                 self.s.space();
1960                 self.word_space("in");
1961                 self.print_expr_as_cond(iter);
1962                 self.s.space();
1963                 self.print_block_with_attrs(blk, attrs);
1964             }
1965             ast::ExprKind::Loop(ref blk, opt_label) => {
1966                 if let Some(label) = opt_label {
1967                     self.print_ident(label.ident);
1968                     self.word_space(":");
1969                 }
1970                 self.head("loop");
1971                 self.s.space();
1972                 self.print_block_with_attrs(blk, attrs);
1973             }
1974             ast::ExprKind::Match(ref expr, ref arms) => {
1975                 self.cbox(INDENT_UNIT);
1976                 self.ibox(INDENT_UNIT);
1977                 self.word_nbsp("match");
1978                 self.print_expr_as_cond(expr);
1979                 self.s.space();
1980                 self.bopen();
1981                 self.print_inner_attributes_no_trailing_hardbreak(attrs);
1982                 for arm in arms {
1983                     self.print_arm(arm);
1984                 }
1985                 self.bclose(expr.span);
1986             }
1987             ast::ExprKind::Closure(
1988                 capture_clause,
1989                 asyncness,
1990                 movability,
1991                 ref decl,
1992                 ref body,
1993                 _,
1994             ) => {
1995                 self.print_movability(movability);
1996                 self.print_asyncness(asyncness);
1997                 self.print_capture_clause(capture_clause);
1998
1999                 self.print_fn_params_and_ret(decl, true);
2000                 self.s.space();
2001                 self.print_expr(body);
2002                 self.end(); // need to close a box
2003
2004                 // a box will be closed by print_expr, but we didn't want an overall
2005                 // wrapper so we closed the corresponding opening. so create an
2006                 // empty box to satisfy the close.
2007                 self.ibox(0);
2008             }
2009             ast::ExprKind::Block(ref blk, opt_label) => {
2010                 if let Some(label) = opt_label {
2011                     self.print_ident(label.ident);
2012                     self.word_space(":");
2013                 }
2014                 // containing cbox, will be closed by print-block at }
2015                 self.cbox(INDENT_UNIT);
2016                 // head-box, will be closed by print-block after {
2017                 self.ibox(0);
2018                 self.print_block_with_attrs(blk, attrs);
2019             }
2020             ast::ExprKind::Async(capture_clause, _, ref blk) => {
2021                 self.word_nbsp("async");
2022                 self.print_capture_clause(capture_clause);
2023                 self.s.space();
2024                 // cbox/ibox in analogy to the `ExprKind::Block` arm above
2025                 self.cbox(INDENT_UNIT);
2026                 self.ibox(0);
2027                 self.print_block_with_attrs(blk, attrs);
2028             }
2029             ast::ExprKind::Await(ref expr) => {
2030                 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX);
2031                 self.s.word(".await");
2032             }
2033             ast::ExprKind::Assign(ref lhs, ref rhs, _) => {
2034                 let prec = AssocOp::Assign.precedence() as i8;
2035                 self.print_expr_maybe_paren(lhs, prec + 1);
2036                 self.s.space();
2037                 self.word_space("=");
2038                 self.print_expr_maybe_paren(rhs, prec);
2039             }
2040             ast::ExprKind::AssignOp(op, ref lhs, ref rhs) => {
2041                 let prec = AssocOp::Assign.precedence() as i8;
2042                 self.print_expr_maybe_paren(lhs, prec + 1);
2043                 self.s.space();
2044                 self.s.word(op.node.to_string());
2045                 self.word_space("=");
2046                 self.print_expr_maybe_paren(rhs, prec);
2047             }
2048             ast::ExprKind::Field(ref expr, ident) => {
2049                 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX);
2050                 self.s.word(".");
2051                 self.print_ident(ident);
2052             }
2053             ast::ExprKind::Index(ref expr, ref index) => {
2054                 self.print_expr_maybe_paren(expr, parser::PREC_POSTFIX);
2055                 self.s.word("[");
2056                 self.print_expr(index);
2057                 self.s.word("]");
2058             }
2059             ast::ExprKind::Range(ref start, ref end, limits) => {
2060                 // Special case for `Range`.  `AssocOp` claims that `Range` has higher precedence
2061                 // than `Assign`, but `x .. x = x` gives a parse error instead of `x .. (x = x)`.
2062                 // Here we use a fake precedence value so that any child with lower precedence than
2063                 // a "normal" binop gets parenthesized.  (`LOr` is the lowest-precedence binop.)
2064                 let fake_prec = AssocOp::LOr.precedence() as i8;
2065                 if let Some(ref e) = *start {
2066                     self.print_expr_maybe_paren(e, fake_prec);
2067                 }
2068                 if limits == ast::RangeLimits::HalfOpen {
2069                     self.s.word("..");
2070                 } else {
2071                     self.s.word("..=");
2072                 }
2073                 if let Some(ref e) = *end {
2074                     self.print_expr_maybe_paren(e, fake_prec);
2075                 }
2076             }
2077             ast::ExprKind::Path(None, ref path) => self.print_path(path, true, 0),
2078             ast::ExprKind::Path(Some(ref qself), ref path) => self.print_qpath(path, qself, true),
2079             ast::ExprKind::Break(opt_label, ref opt_expr) => {
2080                 self.s.word("break");
2081                 self.s.space();
2082                 if let Some(label) = opt_label {
2083                     self.print_ident(label.ident);
2084                     self.s.space();
2085                 }
2086                 if let Some(ref expr) = *opt_expr {
2087                     self.print_expr_maybe_paren(expr, parser::PREC_JUMP);
2088                     self.s.space();
2089                 }
2090             }
2091             ast::ExprKind::Continue(opt_label) => {
2092                 self.s.word("continue");
2093                 self.s.space();
2094                 if let Some(label) = opt_label {
2095                     self.print_ident(label.ident);
2096                     self.s.space()
2097                 }
2098             }
2099             ast::ExprKind::Ret(ref result) => {
2100                 self.s.word("return");
2101                 if let Some(ref expr) = *result {
2102                     self.s.word(" ");
2103                     self.print_expr_maybe_paren(expr, parser::PREC_JUMP);
2104                 }
2105             }
2106             ast::ExprKind::InlineAsm(ref a) => {
2107                 self.s.word("asm!");
2108                 self.popen();
2109                 self.print_string(&a.asm.as_str(), a.asm_str_style);
2110                 self.word_space(":");
2111
2112                 self.commasep(Inconsistent, &a.outputs, |s, out| {
2113                     let constraint = out.constraint.as_str();
2114                     let mut ch = constraint.chars();
2115                     match ch.next() {
2116                         Some('=') if out.is_rw => {
2117                             s.print_string(&format!("+{}", ch.as_str()), ast::StrStyle::Cooked)
2118                         }
2119                         _ => s.print_string(&constraint, ast::StrStyle::Cooked),
2120                     }
2121                     s.popen();
2122                     s.print_expr(&out.expr);
2123                     s.pclose();
2124                 });
2125                 self.s.space();
2126                 self.word_space(":");
2127
2128                 self.commasep(Inconsistent, &a.inputs, |s, &(co, ref o)| {
2129                     s.print_string(&co.as_str(), ast::StrStyle::Cooked);
2130                     s.popen();
2131                     s.print_expr(o);
2132                     s.pclose();
2133                 });
2134                 self.s.space();
2135                 self.word_space(":");
2136
2137                 self.commasep(Inconsistent, &a.clobbers, |s, co| {
2138                     s.print_string(&co.as_str(), ast::StrStyle::Cooked);
2139                 });
2140
2141                 let mut options = vec![];
2142                 if a.volatile {
2143                     options.push("volatile");
2144                 }
2145                 if a.alignstack {
2146                     options.push("alignstack");
2147                 }
2148                 if a.dialect == ast::AsmDialect::Intel {
2149                     options.push("intel");
2150                 }
2151
2152                 if !options.is_empty() {
2153                     self.s.space();
2154                     self.word_space(":");
2155                     self.commasep(Inconsistent, &options, |s, &co| {
2156                         s.print_string(co, ast::StrStyle::Cooked);
2157                     });
2158                 }
2159
2160                 self.pclose();
2161             }
2162             ast::ExprKind::Mac(ref m) => self.print_mac(m),
2163             ast::ExprKind::Paren(ref e) => {
2164                 self.popen();
2165                 self.print_inner_attributes_inline(attrs);
2166                 self.print_expr(e);
2167                 self.pclose();
2168             }
2169             ast::ExprKind::Yield(ref e) => {
2170                 self.s.word("yield");
2171                 match *e {
2172                     Some(ref expr) => {
2173                         self.s.space();
2174                         self.print_expr_maybe_paren(expr, parser::PREC_JUMP);
2175                     }
2176                     _ => (),
2177                 }
2178             }
2179             ast::ExprKind::Try(ref e) => {
2180                 self.print_expr_maybe_paren(e, parser::PREC_POSTFIX);
2181                 self.s.word("?")
2182             }
2183             ast::ExprKind::TryBlock(ref blk) => {
2184                 self.head("try");
2185                 self.s.space();
2186                 self.print_block_with_attrs(blk, attrs)
2187             }
2188             ast::ExprKind::Err => {
2189                 self.popen();
2190                 self.s.word("/*ERROR*/");
2191                 self.pclose()
2192             }
2193         }
2194         self.ann.post(self, AnnNode::Expr(expr));
2195         self.end();
2196     }
2197
2198     crate fn print_local_decl(&mut self, loc: &ast::Local) {
2199         self.print_pat(&loc.pat);
2200         if let Some(ref ty) = loc.ty {
2201             self.word_space(":");
2202             self.print_type(ty);
2203         }
2204     }
2205
2206     pub fn print_usize(&mut self, i: usize) {
2207         self.s.word(i.to_string())
2208     }
2209
2210     crate fn print_name(&mut self, name: ast::Name) {
2211         self.s.word(name.to_string());
2212         self.ann.post(self, AnnNode::Name(&name))
2213     }
2214
2215     fn print_qpath(&mut self, path: &ast::Path, qself: &ast::QSelf, colons_before_params: bool) {
2216         self.s.word("<");
2217         self.print_type(&qself.ty);
2218         if qself.position > 0 {
2219             self.s.space();
2220             self.word_space("as");
2221             let depth = path.segments.len() - qself.position;
2222             self.print_path(path, false, depth);
2223         }
2224         self.s.word(">");
2225         self.s.word("::");
2226         let item_segment = path.segments.last().unwrap();
2227         self.print_ident(item_segment.ident);
2228         match item_segment.args {
2229             Some(ref args) => self.print_generic_args(args, colons_before_params),
2230             None => {}
2231         }
2232     }
2233
2234     crate fn print_pat(&mut self, pat: &ast::Pat) {
2235         self.maybe_print_comment(pat.span.lo());
2236         self.ann.pre(self, AnnNode::Pat(pat));
2237         /* Pat isn't normalized, but the beauty of it
2238         is that it doesn't matter */
2239         match pat.kind {
2240             PatKind::Wild => self.s.word("_"),
2241             PatKind::Ident(binding_mode, ident, ref sub) => {
2242                 match binding_mode {
2243                     ast::BindingMode::ByRef(mutbl) => {
2244                         self.word_nbsp("ref");
2245                         self.print_mutability(mutbl, false);
2246                     }
2247                     ast::BindingMode::ByValue(ast::Mutability::Not) => {}
2248                     ast::BindingMode::ByValue(ast::Mutability::Mut) => {
2249                         self.word_nbsp("mut");
2250                     }
2251                 }
2252                 self.print_ident(ident);
2253                 if let Some(ref p) = *sub {
2254                     self.s.space();
2255                     self.s.word_space("@");
2256                     self.print_pat(p);
2257                 }
2258             }
2259             PatKind::TupleStruct(ref path, ref elts) => {
2260                 self.print_path(path, true, 0);
2261                 self.popen();
2262                 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(p));
2263                 self.pclose();
2264             }
2265             PatKind::Or(ref pats) => {
2266                 self.strsep("|", true, Inconsistent, &pats[..], |s, p| s.print_pat(p));
2267             }
2268             PatKind::Path(None, ref path) => {
2269                 self.print_path(path, true, 0);
2270             }
2271             PatKind::Path(Some(ref qself), ref path) => {
2272                 self.print_qpath(path, qself, false);
2273             }
2274             PatKind::Struct(ref path, ref fields, etc) => {
2275                 self.print_path(path, true, 0);
2276                 self.nbsp();
2277                 self.word_space("{");
2278                 self.commasep_cmnt(
2279                     Consistent,
2280                     &fields[..],
2281                     |s, f| {
2282                         s.cbox(INDENT_UNIT);
2283                         if !f.is_shorthand {
2284                             s.print_ident(f.ident);
2285                             s.word_nbsp(":");
2286                         }
2287                         s.print_pat(&f.pat);
2288                         s.end();
2289                     },
2290                     |f| f.pat.span,
2291                 );
2292                 if etc {
2293                     if !fields.is_empty() {
2294                         self.word_space(",");
2295                     }
2296                     self.s.word("..");
2297                 }
2298                 self.s.space();
2299                 self.s.word("}");
2300             }
2301             PatKind::Tuple(ref elts) => {
2302                 self.popen();
2303                 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(p));
2304                 if elts.len() == 1 {
2305                     self.s.word(",");
2306                 }
2307                 self.pclose();
2308             }
2309             PatKind::Box(ref inner) => {
2310                 self.s.word("box ");
2311                 self.print_pat(inner);
2312             }
2313             PatKind::Ref(ref inner, mutbl) => {
2314                 self.s.word("&");
2315                 if mutbl == ast::Mutability::Mut {
2316                     self.s.word("mut ");
2317                 }
2318                 self.print_pat(inner);
2319             }
2320             PatKind::Lit(ref e) => self.print_expr(&**e),
2321             PatKind::Range(ref begin, ref end, Spanned { node: ref end_kind, .. }) => {
2322                 if let Some(e) = begin {
2323                     self.print_expr(e);
2324                     self.s.space();
2325                 }
2326                 match *end_kind {
2327                     RangeEnd::Included(RangeSyntax::DotDotDot) => self.s.word("..."),
2328                     RangeEnd::Included(RangeSyntax::DotDotEq) => self.s.word("..="),
2329                     RangeEnd::Excluded => self.s.word(".."),
2330                 }
2331                 if let Some(e) = end {
2332                     self.print_expr(e);
2333                 }
2334             }
2335             PatKind::Slice(ref elts) => {
2336                 self.s.word("[");
2337                 self.commasep(Inconsistent, &elts[..], |s, p| s.print_pat(p));
2338                 self.s.word("]");
2339             }
2340             PatKind::Rest => self.s.word(".."),
2341             PatKind::Paren(ref inner) => {
2342                 self.popen();
2343                 self.print_pat(inner);
2344                 self.pclose();
2345             }
2346             PatKind::Mac(ref m) => self.print_mac(m),
2347         }
2348         self.ann.post(self, AnnNode::Pat(pat))
2349     }
2350
2351     fn print_arm(&mut self, arm: &ast::Arm) {
2352         // Note, I have no idea why this check is necessary, but here it is.
2353         if arm.attrs.is_empty() {
2354             self.s.space();
2355         }
2356         self.cbox(INDENT_UNIT);
2357         self.ibox(0);
2358         self.maybe_print_comment(arm.pat.span.lo());
2359         self.print_outer_attributes(&arm.attrs);
2360         self.print_pat(&arm.pat);
2361         self.s.space();
2362         if let Some(ref e) = arm.guard {
2363             self.word_space("if");
2364             self.print_expr(e);
2365             self.s.space();
2366         }
2367         self.word_space("=>");
2368
2369         match arm.body.kind {
2370             ast::ExprKind::Block(ref blk, opt_label) => {
2371                 if let Some(label) = opt_label {
2372                     self.print_ident(label.ident);
2373                     self.word_space(":");
2374                 }
2375
2376                 // The block will close the pattern's ibox.
2377                 self.print_block_unclosed_indent(blk);
2378
2379                 // If it is a user-provided unsafe block, print a comma after it.
2380                 if let BlockCheckMode::Unsafe(ast::UserProvided) = blk.rules {
2381                     self.s.word(",");
2382                 }
2383             }
2384             _ => {
2385                 self.end(); // Close the ibox for the pattern.
2386                 self.print_expr(&arm.body);
2387                 self.s.word(",");
2388             }
2389         }
2390         self.end(); // Close enclosing cbox.
2391     }
2392
2393     fn print_explicit_self(&mut self, explicit_self: &ast::ExplicitSelf) {
2394         match explicit_self.node {
2395             SelfKind::Value(m) => {
2396                 self.print_mutability(m, false);
2397                 self.s.word("self")
2398             }
2399             SelfKind::Region(ref lt, m) => {
2400                 self.s.word("&");
2401                 self.print_opt_lifetime(lt);
2402                 self.print_mutability(m, false);
2403                 self.s.word("self")
2404             }
2405             SelfKind::Explicit(ref typ, m) => {
2406                 self.print_mutability(m, false);
2407                 self.s.word("self");
2408                 self.word_space(":");
2409                 self.print_type(typ)
2410             }
2411         }
2412     }
2413
2414     crate fn print_fn(
2415         &mut self,
2416         decl: &ast::FnDecl,
2417         header: ast::FnHeader,
2418         name: Option<ast::Ident>,
2419         generics: &ast::Generics,
2420         vis: &ast::Visibility,
2421     ) {
2422         self.print_fn_header_info(header, vis);
2423
2424         if let Some(name) = name {
2425             self.nbsp();
2426             self.print_ident(name);
2427         }
2428         self.print_generic_params(&generics.params);
2429         self.print_fn_params_and_ret(decl, false);
2430         self.print_where_clause(&generics.where_clause)
2431     }
2432
2433     crate fn print_fn_params_and_ret(&mut self, decl: &ast::FnDecl, is_closure: bool) {
2434         let (open, close) = if is_closure { ("|", "|") } else { ("(", ")") };
2435         self.word(open);
2436         self.commasep(Inconsistent, &decl.inputs, |s, param| s.print_param(param, is_closure));
2437         self.word(close);
2438         self.print_fn_ret_ty(&decl.output)
2439     }
2440
2441     crate fn print_movability(&mut self, movability: ast::Movability) {
2442         match movability {
2443             ast::Movability::Static => self.word_space("static"),
2444             ast::Movability::Movable => {}
2445         }
2446     }
2447
2448     crate fn print_asyncness(&mut self, asyncness: ast::IsAsync) {
2449         if asyncness.is_async() {
2450             self.word_nbsp("async");
2451         }
2452     }
2453
2454     crate fn print_capture_clause(&mut self, capture_clause: ast::CaptureBy) {
2455         match capture_clause {
2456             ast::CaptureBy::Value => self.word_space("move"),
2457             ast::CaptureBy::Ref => {}
2458         }
2459     }
2460
2461     pub fn print_type_bounds(&mut self, prefix: &'static str, bounds: &[ast::GenericBound]) {
2462         if !bounds.is_empty() {
2463             self.s.word(prefix);
2464             let mut first = true;
2465             for bound in bounds {
2466                 if !(first && prefix.is_empty()) {
2467                     self.nbsp();
2468                 }
2469                 if first {
2470                     first = false;
2471                 } else {
2472                     self.word_space("+");
2473                 }
2474
2475                 match bound {
2476                     GenericBound::Trait(tref, modifier) => {
2477                         if modifier == &TraitBoundModifier::Maybe {
2478                             self.s.word("?");
2479                         }
2480                         self.print_poly_trait_ref(tref);
2481                     }
2482                     GenericBound::Outlives(lt) => self.print_lifetime(*lt),
2483                 }
2484             }
2485         }
2486     }
2487
2488     crate fn print_lifetime(&mut self, lifetime: ast::Lifetime) {
2489         self.print_name(lifetime.ident.name)
2490     }
2491
2492     crate fn print_lifetime_bounds(
2493         &mut self,
2494         lifetime: ast::Lifetime,
2495         bounds: &ast::GenericBounds,
2496     ) {
2497         self.print_lifetime(lifetime);
2498         if !bounds.is_empty() {
2499             self.s.word(": ");
2500             for (i, bound) in bounds.iter().enumerate() {
2501                 if i != 0 {
2502                     self.s.word(" + ");
2503                 }
2504                 match bound {
2505                     ast::GenericBound::Outlives(lt) => self.print_lifetime(*lt),
2506                     _ => panic!(),
2507                 }
2508             }
2509         }
2510     }
2511
2512     crate fn print_generic_params(&mut self, generic_params: &[ast::GenericParam]) {
2513         if generic_params.is_empty() {
2514             return;
2515         }
2516
2517         self.s.word("<");
2518
2519         self.commasep(Inconsistent, &generic_params, |s, param| {
2520             s.print_outer_attributes_inline(&param.attrs);
2521
2522             match param.kind {
2523                 ast::GenericParamKind::Lifetime => {
2524                     let lt = ast::Lifetime { id: param.id, ident: param.ident };
2525                     s.print_lifetime_bounds(lt, &param.bounds)
2526                 }
2527                 ast::GenericParamKind::Type { ref default } => {
2528                     s.print_ident(param.ident);
2529                     s.print_type_bounds(":", &param.bounds);
2530                     if let Some(ref default) = default {
2531                         s.s.space();
2532                         s.word_space("=");
2533                         s.print_type(default)
2534                     }
2535                 }
2536                 ast::GenericParamKind::Const { ref ty } => {
2537                     s.word_space("const");
2538                     s.print_ident(param.ident);
2539                     s.s.space();
2540                     s.word_space(":");
2541                     s.print_type(ty);
2542                     s.print_type_bounds(":", &param.bounds)
2543                 }
2544             }
2545         });
2546
2547         self.s.word(">");
2548     }
2549
2550     crate fn print_where_clause(&mut self, where_clause: &ast::WhereClause) {
2551         if where_clause.predicates.is_empty() {
2552             return;
2553         }
2554
2555         self.s.space();
2556         self.word_space("where");
2557
2558         for (i, predicate) in where_clause.predicates.iter().enumerate() {
2559             if i != 0 {
2560                 self.word_space(",");
2561             }
2562
2563             match *predicate {
2564                 ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate {
2565                     ref bound_generic_params,
2566                     ref bounded_ty,
2567                     ref bounds,
2568                     ..
2569                 }) => {
2570                     self.print_formal_generic_params(bound_generic_params);
2571                     self.print_type(bounded_ty);
2572                     self.print_type_bounds(":", bounds);
2573                 }
2574                 ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate {
2575                     ref lifetime,
2576                     ref bounds,
2577                     ..
2578                 }) => {
2579                     self.print_lifetime_bounds(*lifetime, bounds);
2580                 }
2581                 ast::WherePredicate::EqPredicate(ast::WhereEqPredicate {
2582                     ref lhs_ty,
2583                     ref rhs_ty,
2584                     ..
2585                 }) => {
2586                     self.print_type(lhs_ty);
2587                     self.s.space();
2588                     self.word_space("=");
2589                     self.print_type(rhs_ty);
2590                 }
2591             }
2592         }
2593     }
2594
2595     crate fn print_use_tree(&mut self, tree: &ast::UseTree) {
2596         match tree.kind {
2597             ast::UseTreeKind::Simple(rename, ..) => {
2598                 self.print_path(&tree.prefix, false, 0);
2599                 if let Some(rename) = rename {
2600                     self.s.space();
2601                     self.word_space("as");
2602                     self.print_ident(rename);
2603                 }
2604             }
2605             ast::UseTreeKind::Glob => {
2606                 if !tree.prefix.segments.is_empty() {
2607                     self.print_path(&tree.prefix, false, 0);
2608                     self.s.word("::");
2609                 }
2610                 self.s.word("*");
2611             }
2612             ast::UseTreeKind::Nested(ref items) => {
2613                 if tree.prefix.segments.is_empty() {
2614                     self.s.word("{");
2615                 } else {
2616                     self.print_path(&tree.prefix, false, 0);
2617                     self.s.word("::{");
2618                 }
2619                 self.commasep(Inconsistent, &items[..], |this, &(ref tree, _)| {
2620                     this.print_use_tree(tree)
2621                 });
2622                 self.s.word("}");
2623             }
2624         }
2625     }
2626
2627     pub fn print_mutability(&mut self, mutbl: ast::Mutability, print_const: bool) {
2628         match mutbl {
2629             ast::Mutability::Mut => self.word_nbsp("mut"),
2630             ast::Mutability::Not => {
2631                 if print_const {
2632                     self.word_nbsp("const");
2633                 }
2634             }
2635         }
2636     }
2637
2638     crate fn print_mt(&mut self, mt: &ast::MutTy, print_const: bool) {
2639         self.print_mutability(mt.mutbl, print_const);
2640         self.print_type(&mt.ty)
2641     }
2642
2643     crate fn print_param(&mut self, input: &ast::Param, is_closure: bool) {
2644         self.ibox(INDENT_UNIT);
2645
2646         self.print_outer_attributes_inline(&input.attrs);
2647
2648         match input.ty.kind {
2649             ast::TyKind::Infer if is_closure => self.print_pat(&input.pat),
2650             _ => {
2651                 if let Some(eself) = input.to_self() {
2652                     self.print_explicit_self(&eself);
2653                 } else {
2654                     let invalid = if let PatKind::Ident(_, ident, _) = input.pat.kind {
2655                         ident.name == kw::Invalid
2656                     } else {
2657                         false
2658                     };
2659                     if !invalid {
2660                         self.print_pat(&input.pat);
2661                         self.s.word(":");
2662                         self.s.space();
2663                     }
2664                     self.print_type(&input.ty);
2665                 }
2666             }
2667         }
2668         self.end();
2669     }
2670
2671     crate fn print_fn_ret_ty(&mut self, fn_ret_ty: &ast::FunctionRetTy) {
2672         if let ast::FunctionRetTy::Ty(ty) = fn_ret_ty {
2673             self.space_if_not_bol();
2674             self.ibox(INDENT_UNIT);
2675             self.word_space("->");
2676             self.print_type(ty);
2677             self.end();
2678             self.maybe_print_comment(ty.span.lo());
2679         }
2680     }
2681
2682     crate fn print_ty_fn(
2683         &mut self,
2684         ext: ast::Extern,
2685         unsafety: ast::Unsafety,
2686         decl: &ast::FnDecl,
2687         name: Option<ast::Ident>,
2688         generic_params: &[ast::GenericParam],
2689     ) {
2690         self.ibox(INDENT_UNIT);
2691         if !generic_params.is_empty() {
2692             self.s.word("for");
2693             self.print_generic_params(generic_params);
2694         }
2695         let generics = ast::Generics {
2696             params: Vec::new(),
2697             where_clause: ast::WhereClause { predicates: Vec::new(), span: rustc_span::DUMMY_SP },
2698             span: rustc_span::DUMMY_SP,
2699         };
2700         self.print_fn(
2701             decl,
2702             ast::FnHeader { unsafety, ext, ..ast::FnHeader::default() },
2703             name,
2704             &generics,
2705             &dummy_spanned(ast::VisibilityKind::Inherited),
2706         );
2707         self.end();
2708     }
2709
2710     crate fn maybe_print_trailing_comment(
2711         &mut self,
2712         span: rustc_span::Span,
2713         next_pos: Option<BytePos>,
2714     ) {
2715         if let Some(cmnts) = self.comments() {
2716             if let Some(cmnt) = cmnts.trailing_comment(span, next_pos) {
2717                 self.print_comment(&cmnt);
2718             }
2719         }
2720     }
2721
2722     crate fn print_remaining_comments(&mut self) {
2723         // If there aren't any remaining comments, then we need to manually
2724         // make sure there is a line break at the end.
2725         if self.next_comment().is_none() {
2726             self.s.hardbreak();
2727         }
2728         while let Some(ref cmnt) = self.next_comment() {
2729             self.print_comment(cmnt);
2730         }
2731     }
2732
2733     crate fn print_fn_header_info(&mut self, header: ast::FnHeader, vis: &ast::Visibility) {
2734         self.s.word(visibility_qualified(vis, ""));
2735
2736         match header.constness.node {
2737             ast::Constness::NotConst => {}
2738             ast::Constness::Const => self.word_nbsp("const"),
2739         }
2740
2741         self.print_asyncness(header.asyncness.node);
2742         self.print_unsafety(header.unsafety);
2743
2744         match header.ext {
2745             ast::Extern::None => {}
2746             ast::Extern::Implicit => {
2747                 self.word_nbsp("extern");
2748             }
2749             ast::Extern::Explicit(abi) => {
2750                 self.word_nbsp("extern");
2751                 self.print_literal(&abi.as_lit());
2752                 self.nbsp();
2753             }
2754         }
2755
2756         self.s.word("fn")
2757     }
2758
2759     crate fn print_unsafety(&mut self, s: ast::Unsafety) {
2760         match s {
2761             ast::Unsafety::Normal => {}
2762             ast::Unsafety::Unsafe => self.word_nbsp("unsafe"),
2763         }
2764     }
2765
2766     crate fn print_constness(&mut self, s: ast::Constness) {
2767         match s {
2768             ast::Constness::Const => self.word_nbsp("const"),
2769             ast::Constness::NotConst => {}
2770         }
2771     }
2772
2773     crate fn print_is_auto(&mut self, s: ast::IsAuto) {
2774         match s {
2775             ast::IsAuto::Yes => self.word_nbsp("auto"),
2776             ast::IsAuto::No => {}
2777         }
2778     }
2779 }