]> git.lizzy.rs Git - rust.git/blob - src/librustc_ast_lowering/lib.rs
99de4b88fd3c4c007de72a88b2b1f6c9b5df9b1e
[rust.git] / src / librustc_ast_lowering / lib.rs
1 //! Lowers the AST to the HIR.
2 //!
3 //! Since the AST and HIR are fairly similar, this is mostly a simple procedure,
4 //! much like a fold. Where lowering involves a bit more work things get more
5 //! interesting and there are some invariants you should know about. These mostly
6 //! concern spans and IDs.
7 //!
8 //! Spans are assigned to AST nodes during parsing and then are modified during
9 //! expansion to indicate the origin of a node and the process it went through
10 //! being expanded. IDs are assigned to AST nodes just before lowering.
11 //!
12 //! For the simpler lowering steps, IDs and spans should be preserved. Unlike
13 //! expansion we do not preserve the process of lowering in the spans, so spans
14 //! should not be modified here. When creating a new node (as opposed to
15 //! 'folding' an existing one), then you create a new ID using `next_id()`.
16 //!
17 //! You must ensure that IDs are unique. That means that you should only use the
18 //! ID from an AST node in a single HIR node (you can assume that AST node-IDs
19 //! are unique). Every new node must have a unique ID. Avoid cloning HIR nodes.
20 //! If you do, you must then set the new node's ID to a fresh one.
21 //!
22 //! Spans are used for error messages and for tools to map semantics back to
23 //! source code. It is therefore not as important with spans as IDs to be strict
24 //! about use (you can't break the compiler by screwing up a span). Obviously, a
25 //! HIR node can only have a single span. But multiple nodes can have the same
26 //! span and spans don't need to be kept in order, etc. Where code is preserved
27 //! by lowering, it should have the same span as in the AST. Where HIR nodes are
28 //! new it is probably best to give a span for the whole AST node being lowered.
29 //! All nodes should have real spans, don't use dummy spans. Tools are likely to
30 //! get confused if the spans from leaf AST nodes occur in multiple places
31 //! in the HIR, especially for multiple identifiers.
32
33 #![feature(array_value_iter)]
34 #![feature(crate_visibility_modifier)]
35 #![recursion_limit = "256"]
36
37 use rustc::arena::Arena;
38 use rustc::dep_graph::DepGraph;
39 use rustc::hir::map::definitions::{DefKey, DefPathData, Definitions};
40 use rustc::hir::map::Map;
41 use rustc::{bug, span_bug};
42 use rustc_ast_pretty::pprust;
43 use rustc_data_structures::captures::Captures;
44 use rustc_data_structures::fx::FxHashSet;
45 use rustc_data_structures::sync::Lrc;
46 use rustc_errors::struct_span_err;
47 use rustc_hir as hir;
48 use rustc_hir::def::{DefKind, Namespace, PartialRes, PerNS, Res};
49 use rustc_hir::def_id::{DefId, DefIdMap, DefIndex, CRATE_DEF_INDEX};
50 use rustc_hir::intravisit;
51 use rustc_hir::{ConstArg, GenericArg, ParamName};
52 use rustc_index::vec::IndexVec;
53 use rustc_session::config::nightly_options;
54 use rustc_session::lint::{builtin::BARE_TRAIT_OBJECTS, BuiltinLintDiagnostics, LintBuffer};
55 use rustc_session::parse::ParseSess;
56 use rustc_session::Session;
57 use rustc_span::hygiene::ExpnId;
58 use rustc_span::source_map::{respan, DesugaringKind, ExpnData, ExpnKind};
59 use rustc_span::symbol::{kw, sym, Symbol};
60 use rustc_span::Span;
61 use syntax::ast;
62 use syntax::ast::*;
63 use syntax::attr;
64 use syntax::node_id::NodeMap;
65 use syntax::token::{self, Nonterminal, Token};
66 use syntax::tokenstream::{TokenStream, TokenTree};
67 use syntax::visit::{self, AssocCtxt, Visitor};
68 use syntax::walk_list;
69
70 use log::{debug, trace};
71 use smallvec::{smallvec, SmallVec};
72 use std::collections::BTreeMap;
73 use std::mem;
74
75 macro_rules! arena_vec {
76     ($this:expr; $($x:expr),*) => ({
77         let a = [$($x),*];
78         $this.arena.alloc_from_iter(std::array::IntoIter::new(a))
79     });
80 }
81
82 mod expr;
83 mod item;
84 mod pat;
85 mod path;
86
87 const HIR_ID_COUNTER_LOCKED: u32 = 0xFFFFFFFF;
88
89 struct LoweringContext<'a, 'hir: 'a> {
90     crate_root: Option<Symbol>,
91
92     /// Used to assign IDs to HIR nodes that do not directly correspond to AST nodes.
93     sess: &'a Session,
94
95     resolver: &'a mut dyn Resolver,
96
97     /// HACK(Centril): there is a cyclic dependency between the parser and lowering
98     /// if we don't have this function pointer. To avoid that dependency so that
99     /// librustc is independent of the parser, we use dynamic dispatch here.
100     nt_to_tokenstream: NtToTokenstream,
101
102     /// Used to allocate HIR nodes
103     arena: &'hir Arena<'hir>,
104
105     /// The items being lowered are collected here.
106     items: BTreeMap<hir::HirId, hir::Item<'hir>>,
107
108     trait_items: BTreeMap<hir::TraitItemId, hir::TraitItem<'hir>>,
109     impl_items: BTreeMap<hir::ImplItemId, hir::ImplItem<'hir>>,
110     bodies: BTreeMap<hir::BodyId, hir::Body<'hir>>,
111     exported_macros: Vec<hir::MacroDef<'hir>>,
112     non_exported_macro_attrs: Vec<ast::Attribute>,
113
114     trait_impls: BTreeMap<DefId, Vec<hir::HirId>>,
115
116     modules: BTreeMap<hir::HirId, hir::ModuleItems>,
117
118     generator_kind: Option<hir::GeneratorKind>,
119
120     /// Used to get the current `fn`'s def span to point to when using `await`
121     /// outside of an `async fn`.
122     current_item: Option<Span>,
123
124     catch_scopes: Vec<NodeId>,
125     loop_scopes: Vec<NodeId>,
126     is_in_loop_condition: bool,
127     is_in_trait_impl: bool,
128     is_in_dyn_type: bool,
129
130     /// What to do when we encounter either an "anonymous lifetime
131     /// reference". The term "anonymous" is meant to encompass both
132     /// `'_` lifetimes as well as fully elided cases where nothing is
133     /// written at all (e.g., `&T` or `std::cell::Ref<T>`).
134     anonymous_lifetime_mode: AnonymousLifetimeMode,
135
136     /// Used to create lifetime definitions from in-band lifetime usages.
137     /// e.g., `fn foo(x: &'x u8) -> &'x u8` to `fn foo<'x>(x: &'x u8) -> &'x u8`
138     /// When a named lifetime is encountered in a function or impl header and
139     /// has not been defined
140     /// (i.e., it doesn't appear in the in_scope_lifetimes list), it is added
141     /// to this list. The results of this list are then added to the list of
142     /// lifetime definitions in the corresponding impl or function generics.
143     lifetimes_to_define: Vec<(Span, ParamName)>,
144
145     /// `true` if in-band lifetimes are being collected. This is used to
146     /// indicate whether or not we're in a place where new lifetimes will result
147     /// in in-band lifetime definitions, such a function or an impl header,
148     /// including implicit lifetimes from `impl_header_lifetime_elision`.
149     is_collecting_in_band_lifetimes: bool,
150
151     /// Currently in-scope lifetimes defined in impl headers, fn headers, or HRTB.
152     /// When `is_collectin_in_band_lifetimes` is true, each lifetime is checked
153     /// against this list to see if it is already in-scope, or if a definition
154     /// needs to be created for it.
155     ///
156     /// We always store a `modern()` version of the param-name in this
157     /// vector.
158     in_scope_lifetimes: Vec<ParamName>,
159
160     current_module: hir::HirId,
161
162     type_def_lifetime_params: DefIdMap<usize>,
163
164     current_hir_id_owner: Vec<(DefIndex, u32)>,
165     item_local_id_counters: NodeMap<u32>,
166     node_id_to_hir_id: IndexVec<NodeId, hir::HirId>,
167
168     allow_try_trait: Option<Lrc<[Symbol]>>,
169     allow_gen_future: Option<Lrc<[Symbol]>>,
170 }
171
172 pub trait Resolver {
173     fn def_key(&mut self, id: DefId) -> DefKey;
174
175     fn item_generics_num_lifetimes(&self, def: DefId, sess: &Session) -> usize;
176
177     /// Obtains resolution for a `NodeId` with a single resolution.
178     fn get_partial_res(&mut self, id: NodeId) -> Option<PartialRes>;
179
180     /// Obtains per-namespace resolutions for `use` statement with the given `NodeId`.
181     fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res<NodeId>>>;
182
183     /// Obtains resolution for a label with the given `NodeId`.
184     fn get_label_res(&mut self, id: NodeId) -> Option<NodeId>;
185
186     /// We must keep the set of definitions up to date as we add nodes that weren't in the AST.
187     /// This should only return `None` during testing.
188     fn definitions(&mut self) -> &mut Definitions;
189
190     /// Given suffix `["b", "c", "d"]`, creates an AST path for `[::crate_root]::b::c::d` and
191     /// resolves it based on `is_value`.
192     fn resolve_str_path(
193         &mut self,
194         span: Span,
195         crate_root: Option<Symbol>,
196         components: &[Symbol],
197         ns: Namespace,
198     ) -> (ast::Path, Res<NodeId>);
199
200     fn lint_buffer(&mut self) -> &mut LintBuffer;
201
202     fn next_node_id(&mut self) -> NodeId;
203 }
204
205 type NtToTokenstream = fn(&Nonterminal, &ParseSess, Span) -> TokenStream;
206
207 /// Context of `impl Trait` in code, which determines whether it is allowed in an HIR subtree,
208 /// and if so, what meaning it has.
209 #[derive(Debug)]
210 enum ImplTraitContext<'b, 'a> {
211     /// Treat `impl Trait` as shorthand for a new universal generic parameter.
212     /// Example: `fn foo(x: impl Debug)`, where `impl Debug` is conceptually
213     /// equivalent to a fresh universal parameter like `fn foo<T: Debug>(x: T)`.
214     ///
215     /// Newly generated parameters should be inserted into the given `Vec`.
216     Universal(&'b mut Vec<hir::GenericParam<'a>>),
217
218     /// Treat `impl Trait` as shorthand for a new opaque type.
219     /// Example: `fn foo() -> impl Debug`, where `impl Debug` is conceptually
220     /// equivalent to a new opaque type like `type T = impl Debug; fn foo() -> T`.
221     ///
222     /// We optionally store a `DefId` for the parent item here so we can look up necessary
223     /// information later. It is `None` when no information about the context should be stored
224     /// (e.g., for consts and statics).
225     OpaqueTy(Option<DefId> /* fn def-ID */, hir::OpaqueTyOrigin),
226
227     /// `impl Trait` is not accepted in this position.
228     Disallowed(ImplTraitPosition),
229 }
230
231 /// Position in which `impl Trait` is disallowed.
232 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
233 enum ImplTraitPosition {
234     /// Disallowed in `let` / `const` / `static` bindings.
235     Binding,
236
237     /// All other posiitons.
238     Other,
239 }
240
241 impl<'a> ImplTraitContext<'_, 'a> {
242     #[inline]
243     fn disallowed() -> Self {
244         ImplTraitContext::Disallowed(ImplTraitPosition::Other)
245     }
246
247     fn reborrow<'this>(&'this mut self) -> ImplTraitContext<'this, 'a> {
248         use self::ImplTraitContext::*;
249         match self {
250             Universal(params) => Universal(params),
251             OpaqueTy(fn_def_id, origin) => OpaqueTy(*fn_def_id, *origin),
252             Disallowed(pos) => Disallowed(*pos),
253         }
254     }
255 }
256
257 pub fn lower_crate<'a, 'hir>(
258     sess: &'a Session,
259     dep_graph: &'a DepGraph,
260     krate: &'a Crate,
261     resolver: &'a mut dyn Resolver,
262     nt_to_tokenstream: NtToTokenstream,
263     arena: &'hir Arena<'hir>,
264 ) -> hir::Crate<'hir> {
265     // We're constructing the HIR here; we don't care what we will
266     // read, since we haven't even constructed the *input* to
267     // incr. comp. yet.
268     dep_graph.assert_ignored();
269
270     let _prof_timer = sess.prof.verbose_generic_activity("hir_lowering");
271
272     LoweringContext {
273         crate_root: sess.parse_sess.injected_crate_name.try_get().copied(),
274         sess,
275         resolver,
276         nt_to_tokenstream,
277         arena,
278         items: BTreeMap::new(),
279         trait_items: BTreeMap::new(),
280         impl_items: BTreeMap::new(),
281         bodies: BTreeMap::new(),
282         trait_impls: BTreeMap::new(),
283         modules: BTreeMap::new(),
284         exported_macros: Vec::new(),
285         non_exported_macro_attrs: Vec::new(),
286         catch_scopes: Vec::new(),
287         loop_scopes: Vec::new(),
288         is_in_loop_condition: false,
289         is_in_trait_impl: false,
290         is_in_dyn_type: false,
291         anonymous_lifetime_mode: AnonymousLifetimeMode::PassThrough,
292         type_def_lifetime_params: Default::default(),
293         current_module: hir::CRATE_HIR_ID,
294         current_hir_id_owner: vec![(CRATE_DEF_INDEX, 0)],
295         item_local_id_counters: Default::default(),
296         node_id_to_hir_id: IndexVec::new(),
297         generator_kind: None,
298         current_item: None,
299         lifetimes_to_define: Vec::new(),
300         is_collecting_in_band_lifetimes: false,
301         in_scope_lifetimes: Vec::new(),
302         allow_try_trait: Some([sym::try_trait][..].into()),
303         allow_gen_future: Some([sym::gen_future][..].into()),
304     }
305     .lower_crate(krate)
306 }
307
308 #[derive(Copy, Clone, PartialEq)]
309 enum ParamMode {
310     /// Any path in a type context.
311     Explicit,
312     /// Path in a type definition, where the anonymous lifetime `'_` is not allowed.
313     ExplicitNamed,
314     /// The `module::Type` in `module::Type::method` in an expression.
315     Optional,
316 }
317
318 enum ParenthesizedGenericArgs {
319     Ok,
320     Err,
321 }
322
323 /// What to do when we encounter an **anonymous** lifetime
324 /// reference. Anonymous lifetime references come in two flavors. You
325 /// have implicit, or fully elided, references to lifetimes, like the
326 /// one in `&T` or `Ref<T>`, and you have `'_` lifetimes, like `&'_ T`
327 /// or `Ref<'_, T>`. These often behave the same, but not always:
328 ///
329 /// - certain usages of implicit references are deprecated, like
330 ///   `Ref<T>`, and we sometimes just give hard errors in those cases
331 ///   as well.
332 /// - for object bounds there is a difference: `Box<dyn Foo>` is not
333 ///   the same as `Box<dyn Foo + '_>`.
334 ///
335 /// We describe the effects of the various modes in terms of three cases:
336 ///
337 /// - **Modern** -- includes all uses of `'_`, but also the lifetime arg
338 ///   of a `&` (e.g., the missing lifetime in something like `&T`)
339 /// - **Dyn Bound** -- if you have something like `Box<dyn Foo>`,
340 ///   there is an elided lifetime bound (`Box<dyn Foo + 'X>`). These
341 ///   elided bounds follow special rules. Note that this only covers
342 ///   cases where *nothing* is written; the `'_` in `Box<dyn Foo +
343 ///   '_>` is a case of "modern" elision.
344 /// - **Deprecated** -- this coverse cases like `Ref<T>`, where the lifetime
345 ///   parameter to ref is completely elided. `Ref<'_, T>` would be the modern,
346 ///   non-deprecated equivalent.
347 ///
348 /// Currently, the handling of lifetime elision is somewhat spread out
349 /// between HIR lowering and -- as described below -- the
350 /// `resolve_lifetime` module. Often we "fallthrough" to that code by generating
351 /// an "elided" or "underscore" lifetime name. In the future, we probably want to move
352 /// everything into HIR lowering.
353 #[derive(Copy, Clone, Debug)]
354 enum AnonymousLifetimeMode {
355     /// For **Modern** cases, create a new anonymous region parameter
356     /// and reference that.
357     ///
358     /// For **Dyn Bound** cases, pass responsibility to
359     /// `resolve_lifetime` code.
360     ///
361     /// For **Deprecated** cases, report an error.
362     CreateParameter,
363
364     /// Give a hard error when either `&` or `'_` is written. Used to
365     /// rule out things like `where T: Foo<'_>`. Does not imply an
366     /// error on default object bounds (e.g., `Box<dyn Foo>`).
367     ReportError,
368
369     /// Pass responsibility to `resolve_lifetime` code for all cases.
370     PassThrough,
371 }
372
373 struct ImplTraitTypeIdVisitor<'a> {
374     ids: &'a mut SmallVec<[NodeId; 1]>,
375 }
376
377 impl Visitor<'_> for ImplTraitTypeIdVisitor<'_> {
378     fn visit_ty(&mut self, ty: &Ty) {
379         match ty.kind {
380             TyKind::Typeof(_) | TyKind::BareFn(_) => return,
381
382             TyKind::ImplTrait(id, _) => self.ids.push(id),
383             _ => {}
384         }
385         visit::walk_ty(self, ty);
386     }
387
388     fn visit_path_segment(&mut self, path_span: Span, path_segment: &PathSegment) {
389         if let Some(ref p) = path_segment.args {
390             if let GenericArgs::Parenthesized(_) = **p {
391                 return;
392             }
393         }
394         visit::walk_path_segment(self, path_span, path_segment)
395     }
396 }
397
398 impl<'a, 'hir> LoweringContext<'a, 'hir> {
399     fn lower_crate(mut self, c: &Crate) -> hir::Crate<'hir> {
400         /// Full-crate AST visitor that inserts into a fresh
401         /// `LoweringContext` any information that may be
402         /// needed from arbitrary locations in the crate,
403         /// e.g., the number of lifetime generic parameters
404         /// declared for every type and trait definition.
405         struct MiscCollector<'tcx, 'lowering, 'hir> {
406             lctx: &'tcx mut LoweringContext<'lowering, 'hir>,
407             hir_id_owner: Option<NodeId>,
408         }
409
410         impl MiscCollector<'_, '_, '_> {
411             fn allocate_use_tree_hir_id_counters(&mut self, tree: &UseTree, owner: DefIndex) {
412                 match tree.kind {
413                     UseTreeKind::Simple(_, id1, id2) => {
414                         for &id in &[id1, id2] {
415                             self.lctx.resolver.definitions().create_def_with_parent(
416                                 owner,
417                                 id,
418                                 DefPathData::Misc,
419                                 ExpnId::root(),
420                                 tree.prefix.span,
421                             );
422                             self.lctx.allocate_hir_id_counter(id);
423                         }
424                     }
425                     UseTreeKind::Glob => (),
426                     UseTreeKind::Nested(ref trees) => {
427                         for &(ref use_tree, id) in trees {
428                             let hir_id = self.lctx.allocate_hir_id_counter(id);
429                             self.allocate_use_tree_hir_id_counters(use_tree, hir_id.owner);
430                         }
431                     }
432                 }
433             }
434
435             fn with_hir_id_owner<T>(
436                 &mut self,
437                 owner: Option<NodeId>,
438                 f: impl FnOnce(&mut Self) -> T,
439             ) -> T {
440                 let old = mem::replace(&mut self.hir_id_owner, owner);
441                 let r = f(self);
442                 self.hir_id_owner = old;
443                 r
444             }
445         }
446
447         impl<'tcx> Visitor<'tcx> for MiscCollector<'tcx, '_, '_> {
448             fn visit_pat(&mut self, p: &'tcx Pat) {
449                 if let PatKind::Paren(..) | PatKind::Rest = p.kind {
450                     // Doesn't generate a HIR node
451                 } else if let Some(owner) = self.hir_id_owner {
452                     self.lctx.lower_node_id_with_owner(p.id, owner);
453                 }
454
455                 visit::walk_pat(self, p)
456             }
457
458             fn visit_item(&mut self, item: &'tcx Item) {
459                 let hir_id = self.lctx.allocate_hir_id_counter(item.id);
460
461                 match item.kind {
462                     ItemKind::Struct(_, ref generics)
463                     | ItemKind::Union(_, ref generics)
464                     | ItemKind::Enum(_, ref generics)
465                     | ItemKind::TyAlias(_, ref generics)
466                     | ItemKind::Trait(_, _, ref generics, ..) => {
467                         let def_id = self.lctx.resolver.definitions().local_def_id(item.id);
468                         let count = generics
469                             .params
470                             .iter()
471                             .filter(|param| match param.kind {
472                                 ast::GenericParamKind::Lifetime { .. } => true,
473                                 _ => false,
474                             })
475                             .count();
476                         self.lctx.type_def_lifetime_params.insert(def_id, count);
477                     }
478                     ItemKind::Use(ref use_tree) => {
479                         self.allocate_use_tree_hir_id_counters(use_tree, hir_id.owner);
480                     }
481                     _ => {}
482                 }
483
484                 self.with_hir_id_owner(Some(item.id), |this| {
485                     visit::walk_item(this, item);
486                 });
487             }
488
489             fn visit_assoc_item(&mut self, item: &'tcx AssocItem, ctxt: AssocCtxt) {
490                 self.lctx.allocate_hir_id_counter(item.id);
491                 let owner = match (&item.kind, ctxt) {
492                     // Ignore patterns in trait methods without bodies.
493                     (AssocItemKind::Fn(_, None), AssocCtxt::Trait) => None,
494                     _ => Some(item.id),
495                 };
496                 self.with_hir_id_owner(owner, |this| visit::walk_assoc_item(this, item, ctxt));
497             }
498
499             fn visit_foreign_item(&mut self, i: &'tcx ForeignItem) {
500                 // Ignore patterns in foreign items
501                 self.with_hir_id_owner(None, |this| visit::walk_foreign_item(this, i));
502             }
503
504             fn visit_ty(&mut self, t: &'tcx Ty) {
505                 match t.kind {
506                     // Mirrors the case in visit::walk_ty
507                     TyKind::BareFn(ref f) => {
508                         walk_list!(self, visit_generic_param, &f.generic_params);
509                         // Mirrors visit::walk_fn_decl
510                         for parameter in &f.decl.inputs {
511                             // We don't lower the ids of argument patterns
512                             self.with_hir_id_owner(None, |this| {
513                                 this.visit_pat(&parameter.pat);
514                             });
515                             self.visit_ty(&parameter.ty)
516                         }
517                         self.visit_fn_ret_ty(&f.decl.output)
518                     }
519                     _ => visit::walk_ty(self, t),
520                 }
521             }
522         }
523
524         self.lower_node_id(CRATE_NODE_ID);
525         debug_assert!(self.node_id_to_hir_id[CRATE_NODE_ID] == hir::CRATE_HIR_ID);
526
527         visit::walk_crate(&mut MiscCollector { lctx: &mut self, hir_id_owner: None }, c);
528         visit::walk_crate(&mut item::ItemLowerer { lctx: &mut self }, c);
529
530         let module = self.lower_mod(&c.module);
531         let attrs = self.lower_attrs(&c.attrs);
532         let body_ids = body_ids(&self.bodies);
533
534         self.resolver.definitions().init_node_id_to_hir_id_mapping(self.node_id_to_hir_id);
535
536         hir::Crate {
537             module,
538             attrs,
539             span: c.span,
540             exported_macros: self.arena.alloc_from_iter(self.exported_macros),
541             non_exported_macro_attrs: self.arena.alloc_from_iter(self.non_exported_macro_attrs),
542             items: self.items,
543             trait_items: self.trait_items,
544             impl_items: self.impl_items,
545             bodies: self.bodies,
546             body_ids,
547             trait_impls: self.trait_impls,
548             modules: self.modules,
549         }
550     }
551
552     fn insert_item(&mut self, item: hir::Item<'hir>) {
553         let id = item.hir_id;
554         // FIXME: Use `debug_asset-rt`.
555         assert_eq!(id.local_id, hir::ItemLocalId::from_u32(0));
556         self.items.insert(id, item);
557         self.modules.get_mut(&self.current_module).unwrap().items.insert(id);
558     }
559
560     fn allocate_hir_id_counter(&mut self, owner: NodeId) -> hir::HirId {
561         // Set up the counter if needed.
562         self.item_local_id_counters.entry(owner).or_insert(0);
563         // Always allocate the first `HirId` for the owner itself.
564         let lowered = self.lower_node_id_with_owner(owner, owner);
565         debug_assert_eq!(lowered.local_id.as_u32(), 0);
566         lowered
567     }
568
569     fn lower_node_id_generic(
570         &mut self,
571         ast_node_id: NodeId,
572         alloc_hir_id: impl FnOnce(&mut Self) -> hir::HirId,
573     ) -> hir::HirId {
574         if ast_node_id == DUMMY_NODE_ID {
575             return hir::DUMMY_HIR_ID;
576         }
577
578         let min_size = ast_node_id.as_usize() + 1;
579
580         if min_size > self.node_id_to_hir_id.len() {
581             self.node_id_to_hir_id.resize(min_size, hir::DUMMY_HIR_ID);
582         }
583
584         let existing_hir_id = self.node_id_to_hir_id[ast_node_id];
585
586         if existing_hir_id == hir::DUMMY_HIR_ID {
587             // Generate a new `HirId`.
588             let hir_id = alloc_hir_id(self);
589             self.node_id_to_hir_id[ast_node_id] = hir_id;
590
591             hir_id
592         } else {
593             existing_hir_id
594         }
595     }
596
597     fn with_hir_id_owner<T>(&mut self, owner: NodeId, f: impl FnOnce(&mut Self) -> T) -> T {
598         let counter = self
599             .item_local_id_counters
600             .insert(owner, HIR_ID_COUNTER_LOCKED)
601             .unwrap_or_else(|| panic!("no `item_local_id_counters` entry for {:?}", owner));
602         let def_index = self.resolver.definitions().opt_def_index(owner).unwrap();
603         self.current_hir_id_owner.push((def_index, counter));
604         let ret = f(self);
605         let (new_def_index, new_counter) = self.current_hir_id_owner.pop().unwrap();
606
607         debug_assert!(def_index == new_def_index);
608         debug_assert!(new_counter >= counter);
609
610         let prev = self.item_local_id_counters.insert(owner, new_counter).unwrap();
611         debug_assert!(prev == HIR_ID_COUNTER_LOCKED);
612         ret
613     }
614
615     /// This method allocates a new `HirId` for the given `NodeId` and stores it in
616     /// the `LoweringContext`'s `NodeId => HirId` map.
617     /// Take care not to call this method if the resulting `HirId` is then not
618     /// actually used in the HIR, as that would trigger an assertion in the
619     /// `HirIdValidator` later on, which makes sure that all `NodeId`s got mapped
620     /// properly. Calling the method twice with the same `NodeId` is fine though.
621     fn lower_node_id(&mut self, ast_node_id: NodeId) -> hir::HirId {
622         self.lower_node_id_generic(ast_node_id, |this| {
623             let &mut (def_index, ref mut local_id_counter) =
624                 this.current_hir_id_owner.last_mut().unwrap();
625             let local_id = *local_id_counter;
626             *local_id_counter += 1;
627             hir::HirId { owner: def_index, local_id: hir::ItemLocalId::from_u32(local_id) }
628         })
629     }
630
631     fn lower_node_id_with_owner(&mut self, ast_node_id: NodeId, owner: NodeId) -> hir::HirId {
632         self.lower_node_id_generic(ast_node_id, |this| {
633             let local_id_counter = this
634                 .item_local_id_counters
635                 .get_mut(&owner)
636                 .expect("called `lower_node_id_with_owner` before `allocate_hir_id_counter`");
637             let local_id = *local_id_counter;
638
639             // We want to be sure not to modify the counter in the map while it
640             // is also on the stack. Otherwise we'll get lost updates when writing
641             // back from the stack to the map.
642             debug_assert!(local_id != HIR_ID_COUNTER_LOCKED);
643
644             *local_id_counter += 1;
645             let def_index = this.resolver.definitions().opt_def_index(owner).expect(
646                 "you forgot to call `create_def_with_parent` or are lowering node-IDs \
647                          that do not belong to the current owner",
648             );
649
650             hir::HirId { owner: def_index, local_id: hir::ItemLocalId::from_u32(local_id) }
651         })
652     }
653
654     fn next_id(&mut self) -> hir::HirId {
655         let node_id = self.resolver.next_node_id();
656         self.lower_node_id(node_id)
657     }
658
659     fn lower_res(&mut self, res: Res<NodeId>) -> Res {
660         res.map_id(|id| {
661             self.lower_node_id_generic(id, |_| {
662                 panic!("expected `NodeId` to be lowered already for res {:#?}", res);
663             })
664         })
665     }
666
667     fn expect_full_res(&mut self, id: NodeId) -> Res<NodeId> {
668         self.resolver.get_partial_res(id).map_or(Res::Err, |pr| {
669             if pr.unresolved_segments() != 0 {
670                 bug!("path not fully resolved: {:?}", pr);
671             }
672             pr.base_res()
673         })
674     }
675
676     fn expect_full_res_from_use(&mut self, id: NodeId) -> impl Iterator<Item = Res<NodeId>> {
677         self.resolver.get_import_res(id).present_items()
678     }
679
680     fn diagnostic(&self) -> &rustc_errors::Handler {
681         self.sess.diagnostic()
682     }
683
684     /// Reuses the span but adds information like the kind of the desugaring and features that are
685     /// allowed inside this span.
686     fn mark_span_with_reason(
687         &self,
688         reason: DesugaringKind,
689         span: Span,
690         allow_internal_unstable: Option<Lrc<[Symbol]>>,
691     ) -> Span {
692         span.fresh_expansion(ExpnData {
693             allow_internal_unstable,
694             ..ExpnData::default(ExpnKind::Desugaring(reason), span, self.sess.edition())
695         })
696     }
697
698     fn with_anonymous_lifetime_mode<R>(
699         &mut self,
700         anonymous_lifetime_mode: AnonymousLifetimeMode,
701         op: impl FnOnce(&mut Self) -> R,
702     ) -> R {
703         debug!(
704             "with_anonymous_lifetime_mode(anonymous_lifetime_mode={:?})",
705             anonymous_lifetime_mode,
706         );
707         let old_anonymous_lifetime_mode = self.anonymous_lifetime_mode;
708         self.anonymous_lifetime_mode = anonymous_lifetime_mode;
709         let result = op(self);
710         self.anonymous_lifetime_mode = old_anonymous_lifetime_mode;
711         debug!(
712             "with_anonymous_lifetime_mode: restoring anonymous_lifetime_mode={:?}",
713             old_anonymous_lifetime_mode
714         );
715         result
716     }
717
718     /// Creates a new `hir::GenericParam` for every new lifetime and
719     /// type parameter encountered while evaluating `f`. Definitions
720     /// are created with the parent provided. If no `parent_id` is
721     /// provided, no definitions will be returned.
722     ///
723     /// Presuming that in-band lifetimes are enabled, then
724     /// `self.anonymous_lifetime_mode` will be updated to match the
725     /// parameter while `f` is running (and restored afterwards).
726     fn collect_in_band_defs<T>(
727         &mut self,
728         parent_id: DefId,
729         anonymous_lifetime_mode: AnonymousLifetimeMode,
730         f: impl FnOnce(&mut Self) -> (Vec<hir::GenericParam<'hir>>, T),
731     ) -> (Vec<hir::GenericParam<'hir>>, T) {
732         assert!(!self.is_collecting_in_band_lifetimes);
733         assert!(self.lifetimes_to_define.is_empty());
734         let old_anonymous_lifetime_mode = self.anonymous_lifetime_mode;
735
736         self.anonymous_lifetime_mode = anonymous_lifetime_mode;
737         self.is_collecting_in_band_lifetimes = true;
738
739         let (in_band_ty_params, res) = f(self);
740
741         self.is_collecting_in_band_lifetimes = false;
742         self.anonymous_lifetime_mode = old_anonymous_lifetime_mode;
743
744         let lifetimes_to_define = self.lifetimes_to_define.split_off(0);
745
746         let params = lifetimes_to_define
747             .into_iter()
748             .map(|(span, hir_name)| self.lifetime_to_generic_param(span, hir_name, parent_id.index))
749             .chain(in_band_ty_params.into_iter())
750             .collect();
751
752         (params, res)
753     }
754
755     /// Converts a lifetime into a new generic parameter.
756     fn lifetime_to_generic_param(
757         &mut self,
758         span: Span,
759         hir_name: ParamName,
760         parent_index: DefIndex,
761     ) -> hir::GenericParam<'hir> {
762         let node_id = self.resolver.next_node_id();
763
764         // Get the name we'll use to make the def-path. Note
765         // that collisions are ok here and this shouldn't
766         // really show up for end-user.
767         let (str_name, kind) = match hir_name {
768             ParamName::Plain(ident) => (ident.name, hir::LifetimeParamKind::InBand),
769             ParamName::Fresh(_) => (kw::UnderscoreLifetime, hir::LifetimeParamKind::Elided),
770             ParamName::Error => (kw::UnderscoreLifetime, hir::LifetimeParamKind::Error),
771         };
772
773         // Add a definition for the in-band lifetime def.
774         self.resolver.definitions().create_def_with_parent(
775             parent_index,
776             node_id,
777             DefPathData::LifetimeNs(str_name),
778             ExpnId::root(),
779             span,
780         );
781
782         hir::GenericParam {
783             hir_id: self.lower_node_id(node_id),
784             name: hir_name,
785             attrs: &[],
786             bounds: &[],
787             span,
788             pure_wrt_drop: false,
789             kind: hir::GenericParamKind::Lifetime { kind },
790         }
791     }
792
793     /// When there is a reference to some lifetime `'a`, and in-band
794     /// lifetimes are enabled, then we want to push that lifetime into
795     /// the vector of names to define later. In that case, it will get
796     /// added to the appropriate generics.
797     fn maybe_collect_in_band_lifetime(&mut self, ident: Ident) {
798         if !self.is_collecting_in_band_lifetimes {
799             return;
800         }
801
802         if !self.sess.features_untracked().in_band_lifetimes {
803             return;
804         }
805
806         if self.in_scope_lifetimes.contains(&ParamName::Plain(ident.modern())) {
807             return;
808         }
809
810         let hir_name = ParamName::Plain(ident);
811
812         if self.lifetimes_to_define.iter().any(|(_, lt_name)| lt_name.modern() == hir_name.modern())
813         {
814             return;
815         }
816
817         self.lifetimes_to_define.push((ident.span, hir_name));
818     }
819
820     /// When we have either an elided or `'_` lifetime in an impl
821     /// header, we convert it to an in-band lifetime.
822     fn collect_fresh_in_band_lifetime(&mut self, span: Span) -> ParamName {
823         assert!(self.is_collecting_in_band_lifetimes);
824         let index = self.lifetimes_to_define.len() + self.in_scope_lifetimes.len();
825         let hir_name = ParamName::Fresh(index);
826         self.lifetimes_to_define.push((span, hir_name));
827         hir_name
828     }
829
830     // Evaluates `f` with the lifetimes in `params` in-scope.
831     // This is used to track which lifetimes have already been defined, and
832     // which are new in-band lifetimes that need to have a definition created
833     // for them.
834     fn with_in_scope_lifetime_defs<T>(
835         &mut self,
836         params: &[GenericParam],
837         f: impl FnOnce(&mut Self) -> T,
838     ) -> T {
839         let old_len = self.in_scope_lifetimes.len();
840         let lt_def_names = params.iter().filter_map(|param| match param.kind {
841             GenericParamKind::Lifetime { .. } => Some(ParamName::Plain(param.ident.modern())),
842             _ => None,
843         });
844         self.in_scope_lifetimes.extend(lt_def_names);
845
846         let res = f(self);
847
848         self.in_scope_lifetimes.truncate(old_len);
849         res
850     }
851
852     /// Appends in-band lifetime defs and argument-position `impl
853     /// Trait` defs to the existing set of generics.
854     ///
855     /// Presuming that in-band lifetimes are enabled, then
856     /// `self.anonymous_lifetime_mode` will be updated to match the
857     /// parameter while `f` is running (and restored afterwards).
858     fn add_in_band_defs<T>(
859         &mut self,
860         generics: &Generics,
861         parent_id: DefId,
862         anonymous_lifetime_mode: AnonymousLifetimeMode,
863         f: impl FnOnce(&mut Self, &mut Vec<hir::GenericParam<'hir>>) -> T,
864     ) -> (hir::Generics<'hir>, T) {
865         let (in_band_defs, (mut lowered_generics, res)) =
866             self.with_in_scope_lifetime_defs(&generics.params, |this| {
867                 this.collect_in_band_defs(parent_id, anonymous_lifetime_mode, |this| {
868                     let mut params = Vec::new();
869                     // Note: it is necessary to lower generics *before* calling `f`.
870                     // When lowering `async fn`, there's a final step when lowering
871                     // the return type that assumes that all in-scope lifetimes have
872                     // already been added to either `in_scope_lifetimes` or
873                     // `lifetimes_to_define`. If we swapped the order of these two,
874                     // in-band-lifetimes introduced by generics or where-clauses
875                     // wouldn't have been added yet.
876                     let generics =
877                         this.lower_generics_mut(generics, ImplTraitContext::Universal(&mut params));
878                     let res = f(this, &mut params);
879                     (params, (generics, res))
880                 })
881             });
882
883         let mut lowered_params: Vec<_> =
884             lowered_generics.params.into_iter().chain(in_band_defs).collect();
885
886         // FIXME(const_generics): the compiler doesn't always cope with
887         // unsorted generic parameters at the moment, so we make sure
888         // that they're ordered correctly here for now. (When we chain
889         // the `in_band_defs`, we might make the order unsorted.)
890         lowered_params.sort_by_key(|param| match param.kind {
891             hir::GenericParamKind::Lifetime { .. } => ParamKindOrd::Lifetime,
892             hir::GenericParamKind::Type { .. } => ParamKindOrd::Type,
893             hir::GenericParamKind::Const { .. } => ParamKindOrd::Const,
894         });
895
896         lowered_generics.params = lowered_params.into();
897
898         let lowered_generics = lowered_generics.into_generics(self.arena);
899         (lowered_generics, res)
900     }
901
902     fn with_dyn_type_scope<T>(&mut self, in_scope: bool, f: impl FnOnce(&mut Self) -> T) -> T {
903         let was_in_dyn_type = self.is_in_dyn_type;
904         self.is_in_dyn_type = in_scope;
905
906         let result = f(self);
907
908         self.is_in_dyn_type = was_in_dyn_type;
909
910         result
911     }
912
913     fn with_new_scopes<T>(&mut self, f: impl FnOnce(&mut Self) -> T) -> T {
914         let was_in_loop_condition = self.is_in_loop_condition;
915         self.is_in_loop_condition = false;
916
917         let catch_scopes = mem::take(&mut self.catch_scopes);
918         let loop_scopes = mem::take(&mut self.loop_scopes);
919         let ret = f(self);
920         self.catch_scopes = catch_scopes;
921         self.loop_scopes = loop_scopes;
922
923         self.is_in_loop_condition = was_in_loop_condition;
924
925         ret
926     }
927
928     fn lower_attrs(&mut self, attrs: &[Attribute]) -> &'hir [Attribute] {
929         self.arena.alloc_from_iter(attrs.iter().map(|a| self.lower_attr(a)))
930     }
931
932     fn lower_attr(&mut self, attr: &Attribute) -> Attribute {
933         // Note that we explicitly do not walk the path. Since we don't really
934         // lower attributes (we use the AST version) there is nowhere to keep
935         // the `HirId`s. We don't actually need HIR version of attributes anyway.
936         let kind = match attr.kind {
937             AttrKind::Normal(ref item) => AttrKind::Normal(AttrItem {
938                 path: item.path.clone(),
939                 args: self.lower_mac_args(&item.args),
940             }),
941             AttrKind::DocComment(comment) => AttrKind::DocComment(comment),
942         };
943
944         Attribute { kind, id: attr.id, style: attr.style, span: attr.span }
945     }
946
947     fn lower_mac_args(&mut self, args: &MacArgs) -> MacArgs {
948         match *args {
949             MacArgs::Empty => MacArgs::Empty,
950             MacArgs::Delimited(dspan, delim, ref tokens) => {
951                 MacArgs::Delimited(dspan, delim, self.lower_token_stream(tokens.clone()))
952             }
953             MacArgs::Eq(eq_span, ref tokens) => {
954                 MacArgs::Eq(eq_span, self.lower_token_stream(tokens.clone()))
955             }
956         }
957     }
958
959     fn lower_token_stream(&mut self, tokens: TokenStream) -> TokenStream {
960         tokens.into_trees().flat_map(|tree| self.lower_token_tree(tree).into_trees()).collect()
961     }
962
963     fn lower_token_tree(&mut self, tree: TokenTree) -> TokenStream {
964         match tree {
965             TokenTree::Token(token) => self.lower_token(token),
966             TokenTree::Delimited(span, delim, tts) => {
967                 TokenTree::Delimited(span, delim, self.lower_token_stream(tts)).into()
968             }
969         }
970     }
971
972     fn lower_token(&mut self, token: Token) -> TokenStream {
973         match token.kind {
974             token::Interpolated(nt) => {
975                 let tts = (self.nt_to_tokenstream)(&nt, &self.sess.parse_sess, token.span);
976                 self.lower_token_stream(tts)
977             }
978             _ => TokenTree::Token(token).into(),
979         }
980     }
981
982     /// Given an associated type constraint like one of these:
983     ///
984     /// ```
985     /// T: Iterator<Item: Debug>
986     ///             ^^^^^^^^^^^
987     /// T: Iterator<Item = Debug>
988     ///             ^^^^^^^^^^^^
989     /// ```
990     ///
991     /// returns a `hir::TypeBinding` representing `Item`.
992     fn lower_assoc_ty_constraint(
993         &mut self,
994         constraint: &AssocTyConstraint,
995         itctx: ImplTraitContext<'_, 'hir>,
996     ) -> hir::TypeBinding<'hir> {
997         debug!("lower_assoc_ty_constraint(constraint={:?}, itctx={:?})", constraint, itctx);
998
999         let kind = match constraint.kind {
1000             AssocTyConstraintKind::Equality { ref ty } => {
1001                 hir::TypeBindingKind::Equality { ty: self.lower_ty(ty, itctx) }
1002             }
1003             AssocTyConstraintKind::Bound { ref bounds } => {
1004                 // Piggy-back on the `impl Trait` context to figure out the correct behavior.
1005                 let (desugar_to_impl_trait, itctx) = match itctx {
1006                     // We are in the return position:
1007                     //
1008                     //     fn foo() -> impl Iterator<Item: Debug>
1009                     //
1010                     // so desugar to
1011                     //
1012                     //     fn foo() -> impl Iterator<Item = impl Debug>
1013                     ImplTraitContext::OpaqueTy(..) => (true, itctx),
1014
1015                     // We are in the argument position, but within a dyn type:
1016                     //
1017                     //     fn foo(x: dyn Iterator<Item: Debug>)
1018                     //
1019                     // so desugar to
1020                     //
1021                     //     fn foo(x: dyn Iterator<Item = impl Debug>)
1022                     ImplTraitContext::Universal(..) if self.is_in_dyn_type => (true, itctx),
1023
1024                     // In `type Foo = dyn Iterator<Item: Debug>` we desugar to
1025                     // `type Foo = dyn Iterator<Item = impl Debug>` but we have to override the
1026                     // "impl trait context" to permit `impl Debug` in this position (it desugars
1027                     // then to an opaque type).
1028                     //
1029                     // FIXME: this is only needed until `impl Trait` is allowed in type aliases.
1030                     ImplTraitContext::Disallowed(_) if self.is_in_dyn_type => {
1031                         (true, ImplTraitContext::OpaqueTy(None, hir::OpaqueTyOrigin::Misc))
1032                     }
1033
1034                     // We are in the parameter position, but not within a dyn type:
1035                     //
1036                     //     fn foo(x: impl Iterator<Item: Debug>)
1037                     //
1038                     // so we leave it as is and this gets expanded in astconv to a bound like
1039                     // `<T as Iterator>::Item: Debug` where `T` is the type parameter for the
1040                     // `impl Iterator`.
1041                     _ => (false, itctx),
1042                 };
1043
1044                 if desugar_to_impl_trait {
1045                     // Desugar `AssocTy: Bounds` into `AssocTy = impl Bounds`. We do this by
1046                     // constructing the HIR for `impl bounds...` and then lowering that.
1047
1048                     let impl_trait_node_id = self.resolver.next_node_id();
1049                     let parent_def_index = self.current_hir_id_owner.last().unwrap().0;
1050                     self.resolver.definitions().create_def_with_parent(
1051                         parent_def_index,
1052                         impl_trait_node_id,
1053                         DefPathData::ImplTrait,
1054                         ExpnId::root(),
1055                         constraint.span,
1056                     );
1057
1058                     self.with_dyn_type_scope(false, |this| {
1059                         let node_id = this.resolver.next_node_id();
1060                         let ty = this.lower_ty(
1061                             &Ty {
1062                                 id: node_id,
1063                                 kind: TyKind::ImplTrait(impl_trait_node_id, bounds.clone()),
1064                                 span: constraint.span,
1065                             },
1066                             itctx,
1067                         );
1068
1069                         hir::TypeBindingKind::Equality { ty }
1070                     })
1071                 } else {
1072                     // Desugar `AssocTy: Bounds` into a type binding where the
1073                     // later desugars into a trait predicate.
1074                     let bounds = self.lower_param_bounds(bounds, itctx);
1075
1076                     hir::TypeBindingKind::Constraint { bounds }
1077                 }
1078             }
1079         };
1080
1081         hir::TypeBinding {
1082             hir_id: self.lower_node_id(constraint.id),
1083             ident: constraint.ident,
1084             kind,
1085             span: constraint.span,
1086         }
1087     }
1088
1089     fn lower_generic_arg(
1090         &mut self,
1091         arg: &ast::GenericArg,
1092         itctx: ImplTraitContext<'_, 'hir>,
1093     ) -> hir::GenericArg<'hir> {
1094         match arg {
1095             ast::GenericArg::Lifetime(lt) => GenericArg::Lifetime(self.lower_lifetime(&lt)),
1096             ast::GenericArg::Type(ty) => {
1097                 // We parse const arguments as path types as we cannot distiguish them durring
1098                 // parsing. We try to resolve that ambiguity by attempting resolution in both the
1099                 // type and value namespaces. If we resolved the path in the value namespace, we
1100                 // transform it into a generic const argument.
1101                 if let TyKind::Path(ref qself, ref path) = ty.kind {
1102                     if let Some(partial_res) = self.resolver.get_partial_res(ty.id) {
1103                         let res = partial_res.base_res();
1104                         if !res.matches_ns(Namespace::TypeNS) {
1105                             debug!(
1106                                 "lower_generic_arg: Lowering type argument as const argument: {:?}",
1107                                 ty,
1108                             );
1109
1110                             // Construct a AnonConst where the expr is the "ty"'s path.
1111
1112                             let parent_def_index = self.current_hir_id_owner.last().unwrap().0;
1113                             let node_id = self.resolver.next_node_id();
1114
1115                             // Add a definition for the in-band const def.
1116                             self.resolver.definitions().create_def_with_parent(
1117                                 parent_def_index,
1118                                 node_id,
1119                                 DefPathData::AnonConst,
1120                                 ExpnId::root(),
1121                                 ty.span,
1122                             );
1123
1124                             let path_expr = Expr {
1125                                 id: ty.id,
1126                                 kind: ExprKind::Path(qself.clone(), path.clone()),
1127                                 span: ty.span,
1128                                 attrs: AttrVec::new(),
1129                             };
1130
1131                             let ct = self.with_new_scopes(|this| hir::AnonConst {
1132                                 hir_id: this.lower_node_id(node_id),
1133                                 body: this.lower_const_body(path_expr.span, Some(&path_expr)),
1134                             });
1135                             return GenericArg::Const(ConstArg { value: ct, span: ty.span });
1136                         }
1137                     }
1138                 }
1139                 GenericArg::Type(self.lower_ty_direct(&ty, itctx))
1140             }
1141             ast::GenericArg::Const(ct) => GenericArg::Const(ConstArg {
1142                 value: self.lower_anon_const(&ct),
1143                 span: ct.value.span,
1144             }),
1145         }
1146     }
1147
1148     fn lower_ty(&mut self, t: &Ty, itctx: ImplTraitContext<'_, 'hir>) -> &'hir hir::Ty<'hir> {
1149         self.arena.alloc(self.lower_ty_direct(t, itctx))
1150     }
1151
1152     fn lower_path_ty(
1153         &mut self,
1154         t: &Ty,
1155         qself: &Option<QSelf>,
1156         path: &Path,
1157         param_mode: ParamMode,
1158         itctx: ImplTraitContext<'_, 'hir>,
1159     ) -> hir::Ty<'hir> {
1160         let id = self.lower_node_id(t.id);
1161         let qpath = self.lower_qpath(t.id, qself, path, param_mode, itctx);
1162         let ty = self.ty_path(id, t.span, qpath);
1163         if let hir::TyKind::TraitObject(..) = ty.kind {
1164             self.maybe_lint_bare_trait(t.span, t.id, qself.is_none() && path.is_global());
1165         }
1166         ty
1167     }
1168
1169     fn ty(&mut self, span: Span, kind: hir::TyKind<'hir>) -> hir::Ty<'hir> {
1170         hir::Ty { hir_id: self.next_id(), kind, span }
1171     }
1172
1173     fn ty_tup(&mut self, span: Span, tys: &'hir [hir::Ty<'hir>]) -> hir::Ty<'hir> {
1174         self.ty(span, hir::TyKind::Tup(tys))
1175     }
1176
1177     fn lower_ty_direct(&mut self, t: &Ty, mut itctx: ImplTraitContext<'_, 'hir>) -> hir::Ty<'hir> {
1178         let kind = match t.kind {
1179             TyKind::Infer => hir::TyKind::Infer,
1180             TyKind::Err => hir::TyKind::Err,
1181             TyKind::Slice(ref ty) => hir::TyKind::Slice(self.lower_ty(ty, itctx)),
1182             TyKind::Ptr(ref mt) => hir::TyKind::Ptr(self.lower_mt(mt, itctx)),
1183             TyKind::Rptr(ref region, ref mt) => {
1184                 let span = self.sess.source_map().next_point(t.span.shrink_to_lo());
1185                 let lifetime = match *region {
1186                     Some(ref lt) => self.lower_lifetime(lt),
1187                     None => self.elided_ref_lifetime(span),
1188                 };
1189                 hir::TyKind::Rptr(lifetime, self.lower_mt(mt, itctx))
1190             }
1191             TyKind::BareFn(ref f) => self.with_in_scope_lifetime_defs(&f.generic_params, |this| {
1192                 this.with_anonymous_lifetime_mode(AnonymousLifetimeMode::PassThrough, |this| {
1193                     hir::TyKind::BareFn(this.arena.alloc(hir::BareFnTy {
1194                         generic_params: this.lower_generic_params(
1195                             &f.generic_params,
1196                             &NodeMap::default(),
1197                             ImplTraitContext::disallowed(),
1198                         ),
1199                         unsafety: this.lower_unsafety(f.unsafety),
1200                         abi: this.lower_extern(f.ext),
1201                         decl: this.lower_fn_decl(&f.decl, None, false, None),
1202                         param_names: this.lower_fn_params_to_names(&f.decl),
1203                     }))
1204                 })
1205             }),
1206             TyKind::Never => hir::TyKind::Never,
1207             TyKind::Tup(ref tys) => {
1208                 hir::TyKind::Tup(self.arena.alloc_from_iter(
1209                     tys.iter().map(|ty| self.lower_ty_direct(ty, itctx.reborrow())),
1210                 ))
1211             }
1212             TyKind::Paren(ref ty) => {
1213                 return self.lower_ty_direct(ty, itctx);
1214             }
1215             TyKind::Path(ref qself, ref path) => {
1216                 return self.lower_path_ty(t, qself, path, ParamMode::Explicit, itctx);
1217             }
1218             TyKind::ImplicitSelf => {
1219                 let res = self.expect_full_res(t.id);
1220                 let res = self.lower_res(res);
1221                 hir::TyKind::Path(hir::QPath::Resolved(
1222                     None,
1223                     self.arena.alloc(hir::Path {
1224                         res,
1225                         segments: arena_vec![self; hir::PathSegment::from_ident(
1226                             Ident::with_dummy_span(kw::SelfUpper)
1227                         )],
1228                         span: t.span,
1229                     }),
1230                 ))
1231             }
1232             TyKind::Array(ref ty, ref length) => {
1233                 hir::TyKind::Array(self.lower_ty(ty, itctx), self.lower_anon_const(length))
1234             }
1235             TyKind::Typeof(ref expr) => hir::TyKind::Typeof(self.lower_anon_const(expr)),
1236             TyKind::TraitObject(ref bounds, kind) => {
1237                 let mut lifetime_bound = None;
1238                 let (bounds, lifetime_bound) = self.with_dyn_type_scope(true, |this| {
1239                     let bounds =
1240                         this.arena.alloc_from_iter(bounds.iter().filter_map(
1241                             |bound| match *bound {
1242                                 GenericBound::Trait(ref ty, TraitBoundModifier::None)
1243                                 | GenericBound::Trait(ref ty, TraitBoundModifier::MaybeConst) => {
1244                                     Some(this.lower_poly_trait_ref(ty, itctx.reborrow()))
1245                                 }
1246                                 // `?const ?Bound` will cause an error during AST validation
1247                                 // anyways, so treat it like `?Bound` as compilation proceeds.
1248                                 GenericBound::Trait(_, TraitBoundModifier::Maybe)
1249                                 | GenericBound::Trait(_, TraitBoundModifier::MaybeConstMaybe) => {
1250                                     None
1251                                 }
1252                                 GenericBound::Outlives(ref lifetime) => {
1253                                     if lifetime_bound.is_none() {
1254                                         lifetime_bound = Some(this.lower_lifetime(lifetime));
1255                                     }
1256                                     None
1257                                 }
1258                             },
1259                         ));
1260                     let lifetime_bound =
1261                         lifetime_bound.unwrap_or_else(|| this.elided_dyn_bound(t.span));
1262                     (bounds, lifetime_bound)
1263                 });
1264                 if kind != TraitObjectSyntax::Dyn {
1265                     self.maybe_lint_bare_trait(t.span, t.id, false);
1266                 }
1267                 hir::TyKind::TraitObject(bounds, lifetime_bound)
1268             }
1269             TyKind::ImplTrait(def_node_id, ref bounds) => {
1270                 let span = t.span;
1271                 match itctx {
1272                     ImplTraitContext::OpaqueTy(fn_def_id, origin) => {
1273                         self.lower_opaque_impl_trait(span, fn_def_id, origin, def_node_id, |this| {
1274                             this.lower_param_bounds(bounds, itctx)
1275                         })
1276                     }
1277                     ImplTraitContext::Universal(in_band_ty_params) => {
1278                         // Add a definition for the in-band `Param`.
1279                         let def_index =
1280                             self.resolver.definitions().opt_def_index(def_node_id).unwrap();
1281
1282                         let hir_bounds = self.lower_param_bounds(
1283                             bounds,
1284                             ImplTraitContext::Universal(in_band_ty_params),
1285                         );
1286                         // Set the name to `impl Bound1 + Bound2`.
1287                         let ident = Ident::from_str_and_span(&pprust::ty_to_string(t), span);
1288                         in_band_ty_params.push(hir::GenericParam {
1289                             hir_id: self.lower_node_id(def_node_id),
1290                             name: ParamName::Plain(ident),
1291                             pure_wrt_drop: false,
1292                             attrs: &[],
1293                             bounds: hir_bounds,
1294                             span,
1295                             kind: hir::GenericParamKind::Type {
1296                                 default: None,
1297                                 synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
1298                             },
1299                         });
1300
1301                         hir::TyKind::Path(hir::QPath::Resolved(
1302                             None,
1303                             self.arena.alloc(hir::Path {
1304                                 span,
1305                                 res: Res::Def(DefKind::TyParam, DefId::local(def_index)),
1306                                 segments: arena_vec![self; hir::PathSegment::from_ident(ident)],
1307                             }),
1308                         ))
1309                     }
1310                     ImplTraitContext::Disallowed(pos) => {
1311                         let allowed_in = if self.sess.features_untracked().impl_trait_in_bindings {
1312                             "bindings or function and inherent method return types"
1313                         } else {
1314                             "function and inherent method return types"
1315                         };
1316                         let mut err = struct_span_err!(
1317                             self.sess,
1318                             t.span,
1319                             E0562,
1320                             "`impl Trait` not allowed outside of {}",
1321                             allowed_in,
1322                         );
1323                         if pos == ImplTraitPosition::Binding && nightly_options::is_nightly_build()
1324                         {
1325                             err.help(
1326                                 "add `#![feature(impl_trait_in_bindings)]` to the crate \
1327                                    attributes to enable",
1328                             );
1329                         }
1330                         err.emit();
1331                         hir::TyKind::Err
1332                     }
1333                 }
1334             }
1335             TyKind::Mac(_) => bug!("`TyKind::Mac` should have been expanded by now"),
1336             TyKind::CVarArgs => {
1337                 self.sess.delay_span_bug(
1338                     t.span,
1339                     "`TyKind::CVarArgs` should have been handled elsewhere",
1340                 );
1341                 hir::TyKind::Err
1342             }
1343         };
1344
1345         hir::Ty { kind, span: t.span, hir_id: self.lower_node_id(t.id) }
1346     }
1347
1348     fn lower_opaque_impl_trait(
1349         &mut self,
1350         span: Span,
1351         fn_def_id: Option<DefId>,
1352         origin: hir::OpaqueTyOrigin,
1353         opaque_ty_node_id: NodeId,
1354         lower_bounds: impl FnOnce(&mut Self) -> hir::GenericBounds<'hir>,
1355     ) -> hir::TyKind<'hir> {
1356         debug!(
1357             "lower_opaque_impl_trait(fn_def_id={:?}, opaque_ty_node_id={:?}, span={:?})",
1358             fn_def_id, opaque_ty_node_id, span,
1359         );
1360
1361         // Make sure we know that some funky desugaring has been going on here.
1362         // This is a first: there is code in other places like for loop
1363         // desugaring that explicitly states that we don't want to track that.
1364         // Not tracking it makes lints in rustc and clippy very fragile, as
1365         // frequently opened issues show.
1366         let opaque_ty_span = self.mark_span_with_reason(DesugaringKind::OpaqueTy, span, None);
1367
1368         let opaque_ty_def_index =
1369             self.resolver.definitions().opt_def_index(opaque_ty_node_id).unwrap();
1370
1371         self.allocate_hir_id_counter(opaque_ty_node_id);
1372
1373         let hir_bounds = self.with_hir_id_owner(opaque_ty_node_id, lower_bounds);
1374
1375         let (lifetimes, lifetime_defs) = self.lifetimes_from_impl_trait_bounds(
1376             opaque_ty_node_id,
1377             opaque_ty_def_index,
1378             &hir_bounds,
1379         );
1380
1381         debug!("lower_opaque_impl_trait: lifetimes={:#?}", lifetimes,);
1382
1383         debug!("lower_opaque_impl_trait: lifetime_defs={:#?}", lifetime_defs,);
1384
1385         self.with_hir_id_owner(opaque_ty_node_id, move |lctx| {
1386             let opaque_ty_item = hir::OpaqueTy {
1387                 generics: hir::Generics {
1388                     params: lifetime_defs,
1389                     where_clause: hir::WhereClause { predicates: &[], span },
1390                     span,
1391                 },
1392                 bounds: hir_bounds,
1393                 impl_trait_fn: fn_def_id,
1394                 origin,
1395             };
1396
1397             trace!("lower_opaque_impl_trait: {:#?}", opaque_ty_def_index);
1398             let opaque_ty_id =
1399                 lctx.generate_opaque_type(opaque_ty_node_id, opaque_ty_item, span, opaque_ty_span);
1400
1401             // `impl Trait` now just becomes `Foo<'a, 'b, ..>`.
1402             hir::TyKind::Def(hir::ItemId { id: opaque_ty_id }, lifetimes)
1403         })
1404     }
1405
1406     /// Registers a new opaque type with the proper `NodeId`s and
1407     /// returns the lowered node-ID for the opaque type.
1408     fn generate_opaque_type(
1409         &mut self,
1410         opaque_ty_node_id: NodeId,
1411         opaque_ty_item: hir::OpaqueTy<'hir>,
1412         span: Span,
1413         opaque_ty_span: Span,
1414     ) -> hir::HirId {
1415         let opaque_ty_item_kind = hir::ItemKind::OpaqueTy(opaque_ty_item);
1416         let opaque_ty_id = self.lower_node_id(opaque_ty_node_id);
1417         // Generate an `type Foo = impl Trait;` declaration.
1418         trace!("registering opaque type with id {:#?}", opaque_ty_id);
1419         let opaque_ty_item = hir::Item {
1420             hir_id: opaque_ty_id,
1421             ident: Ident::invalid(),
1422             attrs: Default::default(),
1423             kind: opaque_ty_item_kind,
1424             vis: respan(span.shrink_to_lo(), hir::VisibilityKind::Inherited),
1425             span: opaque_ty_span,
1426         };
1427
1428         // Insert the item into the global item list. This usually happens
1429         // automatically for all AST items. But this opaque type item
1430         // does not actually exist in the AST.
1431         self.insert_item(opaque_ty_item);
1432         opaque_ty_id
1433     }
1434
1435     fn lifetimes_from_impl_trait_bounds(
1436         &mut self,
1437         opaque_ty_id: NodeId,
1438         parent_index: DefIndex,
1439         bounds: hir::GenericBounds<'hir>,
1440     ) -> (&'hir [hir::GenericArg<'hir>], &'hir [hir::GenericParam<'hir>]) {
1441         debug!(
1442             "lifetimes_from_impl_trait_bounds(opaque_ty_id={:?}, \
1443              parent_index={:?}, \
1444              bounds={:#?})",
1445             opaque_ty_id, parent_index, bounds,
1446         );
1447
1448         // This visitor walks over `impl Trait` bounds and creates defs for all lifetimes that
1449         // appear in the bounds, excluding lifetimes that are created within the bounds.
1450         // E.g., `'a`, `'b`, but not `'c` in `impl for<'c> SomeTrait<'a, 'b, 'c>`.
1451         struct ImplTraitLifetimeCollector<'r, 'a, 'hir> {
1452             context: &'r mut LoweringContext<'a, 'hir>,
1453             parent: DefIndex,
1454             opaque_ty_id: NodeId,
1455             collect_elided_lifetimes: bool,
1456             currently_bound_lifetimes: Vec<hir::LifetimeName>,
1457             already_defined_lifetimes: FxHashSet<hir::LifetimeName>,
1458             output_lifetimes: Vec<hir::GenericArg<'hir>>,
1459             output_lifetime_params: Vec<hir::GenericParam<'hir>>,
1460         }
1461
1462         impl<'r, 'a, 'v, 'hir> intravisit::Visitor<'v> for ImplTraitLifetimeCollector<'r, 'a, 'hir> {
1463             type Map = Map<'v>;
1464
1465             fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<'_, Self::Map> {
1466                 intravisit::NestedVisitorMap::None
1467             }
1468
1469             fn visit_generic_args(&mut self, span: Span, parameters: &'v hir::GenericArgs<'v>) {
1470                 // Don't collect elided lifetimes used inside of `Fn()` syntax.
1471                 if parameters.parenthesized {
1472                     let old_collect_elided_lifetimes = self.collect_elided_lifetimes;
1473                     self.collect_elided_lifetimes = false;
1474                     intravisit::walk_generic_args(self, span, parameters);
1475                     self.collect_elided_lifetimes = old_collect_elided_lifetimes;
1476                 } else {
1477                     intravisit::walk_generic_args(self, span, parameters);
1478                 }
1479             }
1480
1481             fn visit_ty(&mut self, t: &'v hir::Ty<'v>) {
1482                 // Don't collect elided lifetimes used inside of `fn()` syntax.
1483                 if let hir::TyKind::BareFn(_) = t.kind {
1484                     let old_collect_elided_lifetimes = self.collect_elided_lifetimes;
1485                     self.collect_elided_lifetimes = false;
1486
1487                     // Record the "stack height" of `for<'a>` lifetime bindings
1488                     // to be able to later fully undo their introduction.
1489                     let old_len = self.currently_bound_lifetimes.len();
1490                     intravisit::walk_ty(self, t);
1491                     self.currently_bound_lifetimes.truncate(old_len);
1492
1493                     self.collect_elided_lifetimes = old_collect_elided_lifetimes;
1494                 } else {
1495                     intravisit::walk_ty(self, t)
1496                 }
1497             }
1498
1499             fn visit_poly_trait_ref(
1500                 &mut self,
1501                 trait_ref: &'v hir::PolyTraitRef<'v>,
1502                 modifier: hir::TraitBoundModifier,
1503             ) {
1504                 // Record the "stack height" of `for<'a>` lifetime bindings
1505                 // to be able to later fully undo their introduction.
1506                 let old_len = self.currently_bound_lifetimes.len();
1507                 intravisit::walk_poly_trait_ref(self, trait_ref, modifier);
1508                 self.currently_bound_lifetimes.truncate(old_len);
1509             }
1510
1511             fn visit_generic_param(&mut self, param: &'v hir::GenericParam<'v>) {
1512                 // Record the introduction of 'a in `for<'a> ...`.
1513                 if let hir::GenericParamKind::Lifetime { .. } = param.kind {
1514                     // Introduce lifetimes one at a time so that we can handle
1515                     // cases like `fn foo<'d>() -> impl for<'a, 'b: 'a, 'c: 'b + 'd>`.
1516                     let lt_name = hir::LifetimeName::Param(param.name);
1517                     self.currently_bound_lifetimes.push(lt_name);
1518                 }
1519
1520                 intravisit::walk_generic_param(self, param);
1521             }
1522
1523             fn visit_lifetime(&mut self, lifetime: &'v hir::Lifetime) {
1524                 let name = match lifetime.name {
1525                     hir::LifetimeName::Implicit | hir::LifetimeName::Underscore => {
1526                         if self.collect_elided_lifetimes {
1527                             // Use `'_` for both implicit and underscore lifetimes in
1528                             // `type Foo<'_> = impl SomeTrait<'_>;`.
1529                             hir::LifetimeName::Underscore
1530                         } else {
1531                             return;
1532                         }
1533                     }
1534                     hir::LifetimeName::Param(_) => lifetime.name,
1535
1536                     // Refers to some other lifetime that is "in
1537                     // scope" within the type.
1538                     hir::LifetimeName::ImplicitObjectLifetimeDefault => return,
1539
1540                     hir::LifetimeName::Error | hir::LifetimeName::Static => return,
1541                 };
1542
1543                 if !self.currently_bound_lifetimes.contains(&name)
1544                     && !self.already_defined_lifetimes.contains(&name)
1545                 {
1546                     self.already_defined_lifetimes.insert(name);
1547
1548                     self.output_lifetimes.push(hir::GenericArg::Lifetime(hir::Lifetime {
1549                         hir_id: self.context.next_id(),
1550                         span: lifetime.span,
1551                         name,
1552                     }));
1553
1554                     let def_node_id = self.context.resolver.next_node_id();
1555                     let hir_id =
1556                         self.context.lower_node_id_with_owner(def_node_id, self.opaque_ty_id);
1557                     self.context.resolver.definitions().create_def_with_parent(
1558                         self.parent,
1559                         def_node_id,
1560                         DefPathData::LifetimeNs(name.ident().name),
1561                         ExpnId::root(),
1562                         lifetime.span,
1563                     );
1564
1565                     let (name, kind) = match name {
1566                         hir::LifetimeName::Underscore => (
1567                             hir::ParamName::Plain(Ident::with_dummy_span(kw::UnderscoreLifetime)),
1568                             hir::LifetimeParamKind::Elided,
1569                         ),
1570                         hir::LifetimeName::Param(param_name) => {
1571                             (param_name, hir::LifetimeParamKind::Explicit)
1572                         }
1573                         _ => bug!("expected `LifetimeName::Param` or `ParamName::Plain`"),
1574                     };
1575
1576                     self.output_lifetime_params.push(hir::GenericParam {
1577                         hir_id,
1578                         name,
1579                         span: lifetime.span,
1580                         pure_wrt_drop: false,
1581                         attrs: &[],
1582                         bounds: &[],
1583                         kind: hir::GenericParamKind::Lifetime { kind },
1584                     });
1585                 }
1586             }
1587         }
1588
1589         let mut lifetime_collector = ImplTraitLifetimeCollector {
1590             context: self,
1591             parent: parent_index,
1592             opaque_ty_id,
1593             collect_elided_lifetimes: true,
1594             currently_bound_lifetimes: Vec::new(),
1595             already_defined_lifetimes: FxHashSet::default(),
1596             output_lifetimes: Vec::new(),
1597             output_lifetime_params: Vec::new(),
1598         };
1599
1600         for bound in bounds {
1601             intravisit::walk_param_bound(&mut lifetime_collector, &bound);
1602         }
1603
1604         let ImplTraitLifetimeCollector { output_lifetimes, output_lifetime_params, .. } =
1605             lifetime_collector;
1606
1607         (
1608             self.arena.alloc_from_iter(output_lifetimes),
1609             self.arena.alloc_from_iter(output_lifetime_params),
1610         )
1611     }
1612
1613     fn lower_local(&mut self, l: &Local) -> (hir::Local<'hir>, SmallVec<[NodeId; 1]>) {
1614         let mut ids = SmallVec::<[NodeId; 1]>::new();
1615         if self.sess.features_untracked().impl_trait_in_bindings {
1616             if let Some(ref ty) = l.ty {
1617                 let mut visitor = ImplTraitTypeIdVisitor { ids: &mut ids };
1618                 visitor.visit_ty(ty);
1619             }
1620         }
1621         let parent_def_id = DefId::local(self.current_hir_id_owner.last().unwrap().0);
1622         let ty = l.ty.as_ref().map(|t| {
1623             self.lower_ty(
1624                 t,
1625                 if self.sess.features_untracked().impl_trait_in_bindings {
1626                     ImplTraitContext::OpaqueTy(Some(parent_def_id), hir::OpaqueTyOrigin::Misc)
1627                 } else {
1628                     ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
1629                 },
1630             )
1631         });
1632         let init = l.init.as_ref().map(|e| self.lower_expr(e));
1633         (
1634             hir::Local {
1635                 hir_id: self.lower_node_id(l.id),
1636                 ty,
1637                 pat: self.lower_pat(&l.pat),
1638                 init,
1639                 span: l.span,
1640                 attrs: l.attrs.clone(),
1641                 source: hir::LocalSource::Normal,
1642             },
1643             ids,
1644         )
1645     }
1646
1647     fn lower_fn_params_to_names(&mut self, decl: &FnDecl) -> &'hir [Ident] {
1648         // Skip the `...` (`CVarArgs`) trailing arguments from the AST,
1649         // as they are not explicit in HIR/Ty function signatures.
1650         // (instead, the `c_variadic` flag is set to `true`)
1651         let mut inputs = &decl.inputs[..];
1652         if decl.c_variadic() {
1653             inputs = &inputs[..inputs.len() - 1];
1654         }
1655         self.arena.alloc_from_iter(inputs.iter().map(|param| match param.pat.kind {
1656             PatKind::Ident(_, ident, _) => ident,
1657             _ => Ident::new(kw::Invalid, param.pat.span),
1658         }))
1659     }
1660
1661     // Lowers a function declaration.
1662     //
1663     // `decl`: the unlowered (AST) function declaration.
1664     // `fn_def_id`: if `Some`, impl Trait arguments are lowered into generic parameters on the
1665     //      given DefId, otherwise impl Trait is disallowed. Must be `Some` if
1666     //      `make_ret_async` is also `Some`.
1667     // `impl_trait_return_allow`: determines whether `impl Trait` can be used in return position.
1668     //      This guards against trait declarations and implementations where `impl Trait` is
1669     //      disallowed.
1670     // `make_ret_async`: if `Some`, converts `-> T` into `-> impl Future<Output = T>` in the
1671     //      return type. This is used for `async fn` declarations. The `NodeId` is the ID of the
1672     //      return type `impl Trait` item.
1673     fn lower_fn_decl(
1674         &mut self,
1675         decl: &FnDecl,
1676         mut in_band_ty_params: Option<(DefId, &mut Vec<hir::GenericParam<'hir>>)>,
1677         impl_trait_return_allow: bool,
1678         make_ret_async: Option<NodeId>,
1679     ) -> &'hir hir::FnDecl<'hir> {
1680         debug!(
1681             "lower_fn_decl(\
1682             fn_decl: {:?}, \
1683             in_band_ty_params: {:?}, \
1684             impl_trait_return_allow: {}, \
1685             make_ret_async: {:?})",
1686             decl, in_band_ty_params, impl_trait_return_allow, make_ret_async,
1687         );
1688         let lt_mode = if make_ret_async.is_some() {
1689             // In `async fn`, argument-position elided lifetimes
1690             // must be transformed into fresh generic parameters so that
1691             // they can be applied to the opaque `impl Trait` return type.
1692             AnonymousLifetimeMode::CreateParameter
1693         } else {
1694             self.anonymous_lifetime_mode
1695         };
1696
1697         let c_variadic = decl.c_variadic();
1698
1699         // Remember how many lifetimes were already around so that we can
1700         // only look at the lifetime parameters introduced by the arguments.
1701         let inputs = self.with_anonymous_lifetime_mode(lt_mode, |this| {
1702             // Skip the `...` (`CVarArgs`) trailing arguments from the AST,
1703             // as they are not explicit in HIR/Ty function signatures.
1704             // (instead, the `c_variadic` flag is set to `true`)
1705             let mut inputs = &decl.inputs[..];
1706             if c_variadic {
1707                 inputs = &inputs[..inputs.len() - 1];
1708             }
1709             this.arena.alloc_from_iter(inputs.iter().map(|param| {
1710                 if let Some((_, ibty)) = &mut in_band_ty_params {
1711                     this.lower_ty_direct(&param.ty, ImplTraitContext::Universal(ibty))
1712                 } else {
1713                     this.lower_ty_direct(&param.ty, ImplTraitContext::disallowed())
1714                 }
1715             }))
1716         });
1717
1718         let output = if let Some(ret_id) = make_ret_async {
1719             self.lower_async_fn_ret_ty(
1720                 &decl.output,
1721                 in_band_ty_params.expect("`make_ret_async` but no `fn_def_id`").0,
1722                 ret_id,
1723             )
1724         } else {
1725             match decl.output {
1726                 FunctionRetTy::Ty(ref ty) => {
1727                     let context = match in_band_ty_params {
1728                         Some((def_id, _)) if impl_trait_return_allow => {
1729                             ImplTraitContext::OpaqueTy(Some(def_id), hir::OpaqueTyOrigin::FnReturn)
1730                         }
1731                         _ => ImplTraitContext::disallowed(),
1732                     };
1733                     hir::FunctionRetTy::Return(self.lower_ty(ty, context))
1734                 }
1735                 FunctionRetTy::Default(span) => hir::FunctionRetTy::DefaultReturn(span),
1736             }
1737         };
1738
1739         self.arena.alloc(hir::FnDecl {
1740             inputs,
1741             output,
1742             c_variadic,
1743             implicit_self: decl.inputs.get(0).map_or(hir::ImplicitSelfKind::None, |arg| {
1744                 let is_mutable_pat = match arg.pat.kind {
1745                     PatKind::Ident(BindingMode::ByValue(mt), _, _)
1746                     | PatKind::Ident(BindingMode::ByRef(mt), _, _) => mt == Mutability::Mut,
1747                     _ => false,
1748                 };
1749
1750                 match arg.ty.kind {
1751                     TyKind::ImplicitSelf if is_mutable_pat => hir::ImplicitSelfKind::Mut,
1752                     TyKind::ImplicitSelf => hir::ImplicitSelfKind::Imm,
1753                     // Given we are only considering `ImplicitSelf` types, we needn't consider
1754                     // the case where we have a mutable pattern to a reference as that would
1755                     // no longer be an `ImplicitSelf`.
1756                     TyKind::Rptr(_, ref mt)
1757                         if mt.ty.kind.is_implicit_self() && mt.mutbl == ast::Mutability::Mut =>
1758                     {
1759                         hir::ImplicitSelfKind::MutRef
1760                     }
1761                     TyKind::Rptr(_, ref mt) if mt.ty.kind.is_implicit_self() => {
1762                         hir::ImplicitSelfKind::ImmRef
1763                     }
1764                     _ => hir::ImplicitSelfKind::None,
1765                 }
1766             }),
1767         })
1768     }
1769
1770     // Transforms `-> T` for `async fn` into `-> OpaqueTy { .. }`
1771     // combined with the following definition of `OpaqueTy`:
1772     //
1773     //     type OpaqueTy<generics_from_parent_fn> = impl Future<Output = T>;
1774     //
1775     // `inputs`: lowered types of parameters to the function (used to collect lifetimes)
1776     // `output`: unlowered output type (`T` in `-> T`)
1777     // `fn_def_id`: `DefId` of the parent function (used to create child impl trait definition)
1778     // `opaque_ty_node_id`: `NodeId` of the opaque `impl Trait` type that should be created
1779     // `elided_lt_replacement`: replacement for elided lifetimes in the return type
1780     fn lower_async_fn_ret_ty(
1781         &mut self,
1782         output: &FunctionRetTy,
1783         fn_def_id: DefId,
1784         opaque_ty_node_id: NodeId,
1785     ) -> hir::FunctionRetTy<'hir> {
1786         debug!(
1787             "lower_async_fn_ret_ty(\
1788              output={:?}, \
1789              fn_def_id={:?}, \
1790              opaque_ty_node_id={:?})",
1791             output, fn_def_id, opaque_ty_node_id,
1792         );
1793
1794         let span = output.span();
1795
1796         let opaque_ty_span = self.mark_span_with_reason(DesugaringKind::Async, span, None);
1797
1798         let opaque_ty_def_index =
1799             self.resolver.definitions().opt_def_index(opaque_ty_node_id).unwrap();
1800
1801         self.allocate_hir_id_counter(opaque_ty_node_id);
1802
1803         // When we create the opaque type for this async fn, it is going to have
1804         // to capture all the lifetimes involved in the signature (including in the
1805         // return type). This is done by introducing lifetime parameters for:
1806         //
1807         // - all the explicitly declared lifetimes from the impl and function itself;
1808         // - all the elided lifetimes in the fn arguments;
1809         // - all the elided lifetimes in the return type.
1810         //
1811         // So for example in this snippet:
1812         //
1813         // ```rust
1814         // impl<'a> Foo<'a> {
1815         //   async fn bar<'b>(&self, x: &'b Vec<f64>, y: &str) -> &u32 {
1816         //   //               ^ '0                       ^ '1     ^ '2
1817         //   // elided lifetimes used below
1818         //   }
1819         // }
1820         // ```
1821         //
1822         // we would create an opaque type like:
1823         //
1824         // ```
1825         // type Bar<'a, 'b, '0, '1, '2> = impl Future<Output = &'2 u32>;
1826         // ```
1827         //
1828         // and we would then desugar `bar` to the equivalent of:
1829         //
1830         // ```rust
1831         // impl<'a> Foo<'a> {
1832         //   fn bar<'b, '0, '1>(&'0 self, x: &'b Vec<f64>, y: &'1 str) -> Bar<'a, 'b, '0, '1, '_>
1833         // }
1834         // ```
1835         //
1836         // Note that the final parameter to `Bar` is `'_`, not `'2` --
1837         // this is because the elided lifetimes from the return type
1838         // should be figured out using the ordinary elision rules, and
1839         // this desugaring achieves that.
1840         //
1841         // The variable `input_lifetimes_count` tracks the number of
1842         // lifetime parameters to the opaque type *not counting* those
1843         // lifetimes elided in the return type. This includes those
1844         // that are explicitly declared (`in_scope_lifetimes`) and
1845         // those elided lifetimes we found in the arguments (current
1846         // content of `lifetimes_to_define`). Next, we will process
1847         // the return type, which will cause `lifetimes_to_define` to
1848         // grow.
1849         let input_lifetimes_count = self.in_scope_lifetimes.len() + self.lifetimes_to_define.len();
1850
1851         let (opaque_ty_id, lifetime_params) = self.with_hir_id_owner(opaque_ty_node_id, |this| {
1852             // We have to be careful to get elision right here. The
1853             // idea is that we create a lifetime parameter for each
1854             // lifetime in the return type.  So, given a return type
1855             // like `async fn foo(..) -> &[&u32]`, we lower to `impl
1856             // Future<Output = &'1 [ &'2 u32 ]>`.
1857             //
1858             // Then, we will create `fn foo(..) -> Foo<'_, '_>`, and
1859             // hence the elision takes place at the fn site.
1860             let future_bound = this
1861                 .with_anonymous_lifetime_mode(AnonymousLifetimeMode::CreateParameter, |this| {
1862                     this.lower_async_fn_output_type_to_future_bound(output, fn_def_id, span)
1863                 });
1864
1865             debug!("lower_async_fn_ret_ty: future_bound={:#?}", future_bound);
1866
1867             // Calculate all the lifetimes that should be captured
1868             // by the opaque type. This should include all in-scope
1869             // lifetime parameters, including those defined in-band.
1870             //
1871             // Note: this must be done after lowering the output type,
1872             // as the output type may introduce new in-band lifetimes.
1873             let lifetime_params: Vec<(Span, ParamName)> = this
1874                 .in_scope_lifetimes
1875                 .iter()
1876                 .cloned()
1877                 .map(|name| (name.ident().span, name))
1878                 .chain(this.lifetimes_to_define.iter().cloned())
1879                 .collect();
1880
1881             debug!("lower_async_fn_ret_ty: in_scope_lifetimes={:#?}", this.in_scope_lifetimes);
1882             debug!("lower_async_fn_ret_ty: lifetimes_to_define={:#?}", this.lifetimes_to_define);
1883             debug!("lower_async_fn_ret_ty: lifetime_params={:#?}", lifetime_params);
1884
1885             let generic_params =
1886                 this.arena.alloc_from_iter(lifetime_params.iter().map(|(span, hir_name)| {
1887                     this.lifetime_to_generic_param(*span, *hir_name, opaque_ty_def_index)
1888                 }));
1889
1890             let opaque_ty_item = hir::OpaqueTy {
1891                 generics: hir::Generics {
1892                     params: generic_params,
1893                     where_clause: hir::WhereClause { predicates: &[], span },
1894                     span,
1895                 },
1896                 bounds: arena_vec![this; future_bound],
1897                 impl_trait_fn: Some(fn_def_id),
1898                 origin: hir::OpaqueTyOrigin::AsyncFn,
1899             };
1900
1901             trace!("exist ty from async fn def index: {:#?}", opaque_ty_def_index);
1902             let opaque_ty_id =
1903                 this.generate_opaque_type(opaque_ty_node_id, opaque_ty_item, span, opaque_ty_span);
1904
1905             (opaque_ty_id, lifetime_params)
1906         });
1907
1908         // As documented above on the variable
1909         // `input_lifetimes_count`, we need to create the lifetime
1910         // arguments to our opaque type. Continuing with our example,
1911         // we're creating the type arguments for the return type:
1912         //
1913         // ```
1914         // Bar<'a, 'b, '0, '1, '_>
1915         // ```
1916         //
1917         // For the "input" lifetime parameters, we wish to create
1918         // references to the parameters themselves, including the
1919         // "implicit" ones created from parameter types (`'a`, `'b`,
1920         // '`0`, `'1`).
1921         //
1922         // For the "output" lifetime parameters, we just want to
1923         // generate `'_`.
1924         let mut generic_args: Vec<_> = lifetime_params[..input_lifetimes_count]
1925             .iter()
1926             .map(|&(span, hir_name)| {
1927                 // Input lifetime like `'a` or `'1`:
1928                 GenericArg::Lifetime(hir::Lifetime {
1929                     hir_id: self.next_id(),
1930                     span,
1931                     name: hir::LifetimeName::Param(hir_name),
1932                 })
1933             })
1934             .collect();
1935         generic_args.extend(lifetime_params[input_lifetimes_count..].iter().map(|&(span, _)|
1936             // Output lifetime like `'_`.
1937             GenericArg::Lifetime(hir::Lifetime {
1938                 hir_id: self.next_id(),
1939                 span,
1940                 name: hir::LifetimeName::Implicit,
1941             })));
1942         let generic_args = self.arena.alloc_from_iter(generic_args);
1943
1944         // Create the `Foo<...>` reference itself. Note that the `type
1945         // Foo = impl Trait` is, internally, created as a child of the
1946         // async fn, so the *type parameters* are inherited.  It's
1947         // only the lifetime parameters that we must supply.
1948         let opaque_ty_ref = hir::TyKind::Def(hir::ItemId { id: opaque_ty_id }, generic_args);
1949         let opaque_ty = self.ty(opaque_ty_span, opaque_ty_ref);
1950         hir::FunctionRetTy::Return(self.arena.alloc(opaque_ty))
1951     }
1952
1953     /// Transforms `-> T` into `Future<Output = T>`
1954     fn lower_async_fn_output_type_to_future_bound(
1955         &mut self,
1956         output: &FunctionRetTy,
1957         fn_def_id: DefId,
1958         span: Span,
1959     ) -> hir::GenericBound<'hir> {
1960         // Compute the `T` in `Future<Output = T>` from the return type.
1961         let output_ty = match output {
1962             FunctionRetTy::Ty(ty) => {
1963                 // Not `OpaqueTyOrigin::AsyncFn`: that's only used for the
1964                 // `impl Future` opaque type that `async fn` implicitly
1965                 // generates.
1966                 let context =
1967                     ImplTraitContext::OpaqueTy(Some(fn_def_id), hir::OpaqueTyOrigin::FnReturn);
1968                 self.lower_ty(ty, context)
1969             }
1970             FunctionRetTy::Default(ret_ty_span) => self.arena.alloc(self.ty_tup(*ret_ty_span, &[])),
1971         };
1972
1973         // "<Output = T>"
1974         let future_params = self.arena.alloc(hir::GenericArgs {
1975             args: &[],
1976             bindings: arena_vec![self; self.output_ty_binding(span, output_ty)],
1977             parenthesized: false,
1978         });
1979
1980         // ::std::future::Future<future_params>
1981         let future_path =
1982             self.std_path(span, &[sym::future, sym::Future], Some(future_params), false);
1983
1984         hir::GenericBound::Trait(
1985             hir::PolyTraitRef {
1986                 trait_ref: hir::TraitRef { path: future_path, hir_ref_id: self.next_id() },
1987                 bound_generic_params: &[],
1988                 span,
1989             },
1990             hir::TraitBoundModifier::None,
1991         )
1992     }
1993
1994     fn lower_param_bound(
1995         &mut self,
1996         tpb: &GenericBound,
1997         itctx: ImplTraitContext<'_, 'hir>,
1998     ) -> hir::GenericBound<'hir> {
1999         match *tpb {
2000             GenericBound::Trait(ref ty, modifier) => hir::GenericBound::Trait(
2001                 self.lower_poly_trait_ref(ty, itctx),
2002                 self.lower_trait_bound_modifier(modifier),
2003             ),
2004             GenericBound::Outlives(ref lifetime) => {
2005                 hir::GenericBound::Outlives(self.lower_lifetime(lifetime))
2006             }
2007         }
2008     }
2009
2010     fn lower_lifetime(&mut self, l: &Lifetime) -> hir::Lifetime {
2011         let span = l.ident.span;
2012         match l.ident {
2013             ident if ident.name == kw::StaticLifetime => {
2014                 self.new_named_lifetime(l.id, span, hir::LifetimeName::Static)
2015             }
2016             ident if ident.name == kw::UnderscoreLifetime => match self.anonymous_lifetime_mode {
2017                 AnonymousLifetimeMode::CreateParameter => {
2018                     let fresh_name = self.collect_fresh_in_band_lifetime(span);
2019                     self.new_named_lifetime(l.id, span, hir::LifetimeName::Param(fresh_name))
2020                 }
2021
2022                 AnonymousLifetimeMode::PassThrough => {
2023                     self.new_named_lifetime(l.id, span, hir::LifetimeName::Underscore)
2024                 }
2025
2026                 AnonymousLifetimeMode::ReportError => self.new_error_lifetime(Some(l.id), span),
2027             },
2028             ident => {
2029                 self.maybe_collect_in_band_lifetime(ident);
2030                 let param_name = ParamName::Plain(ident);
2031                 self.new_named_lifetime(l.id, span, hir::LifetimeName::Param(param_name))
2032             }
2033         }
2034     }
2035
2036     fn new_named_lifetime(
2037         &mut self,
2038         id: NodeId,
2039         span: Span,
2040         name: hir::LifetimeName,
2041     ) -> hir::Lifetime {
2042         hir::Lifetime { hir_id: self.lower_node_id(id), span, name }
2043     }
2044
2045     fn lower_generic_params_mut<'s>(
2046         &'s mut self,
2047         params: &'s [GenericParam],
2048         add_bounds: &'s NodeMap<Vec<GenericBound>>,
2049         mut itctx: ImplTraitContext<'s, 'hir>,
2050     ) -> impl Iterator<Item = hir::GenericParam<'hir>> + Captures<'a> + Captures<'s> {
2051         params
2052             .iter()
2053             .map(move |param| self.lower_generic_param(param, add_bounds, itctx.reborrow()))
2054     }
2055
2056     fn lower_generic_params(
2057         &mut self,
2058         params: &[GenericParam],
2059         add_bounds: &NodeMap<Vec<GenericBound>>,
2060         itctx: ImplTraitContext<'_, 'hir>,
2061     ) -> &'hir [hir::GenericParam<'hir>] {
2062         self.arena.alloc_from_iter(self.lower_generic_params_mut(params, add_bounds, itctx))
2063     }
2064
2065     fn lower_generic_param(
2066         &mut self,
2067         param: &GenericParam,
2068         add_bounds: &NodeMap<Vec<GenericBound>>,
2069         mut itctx: ImplTraitContext<'_, 'hir>,
2070     ) -> hir::GenericParam<'hir> {
2071         let mut bounds: Vec<_> = self
2072             .with_anonymous_lifetime_mode(AnonymousLifetimeMode::ReportError, |this| {
2073                 this.lower_param_bounds_mut(&param.bounds, itctx.reborrow()).collect()
2074             });
2075
2076         let (name, kind) = match param.kind {
2077             GenericParamKind::Lifetime => {
2078                 let was_collecting_in_band = self.is_collecting_in_band_lifetimes;
2079                 self.is_collecting_in_band_lifetimes = false;
2080
2081                 let lt = self
2082                     .with_anonymous_lifetime_mode(AnonymousLifetimeMode::ReportError, |this| {
2083                         this.lower_lifetime(&Lifetime { id: param.id, ident: param.ident })
2084                     });
2085                 let param_name = match lt.name {
2086                     hir::LifetimeName::Param(param_name) => param_name,
2087                     hir::LifetimeName::Implicit
2088                     | hir::LifetimeName::Underscore
2089                     | hir::LifetimeName::Static => hir::ParamName::Plain(lt.name.ident()),
2090                     hir::LifetimeName::ImplicitObjectLifetimeDefault => {
2091                         span_bug!(
2092                             param.ident.span,
2093                             "object-lifetime-default should not occur here",
2094                         );
2095                     }
2096                     hir::LifetimeName::Error => ParamName::Error,
2097                 };
2098
2099                 let kind =
2100                     hir::GenericParamKind::Lifetime { kind: hir::LifetimeParamKind::Explicit };
2101
2102                 self.is_collecting_in_band_lifetimes = was_collecting_in_band;
2103
2104                 (param_name, kind)
2105             }
2106             GenericParamKind::Type { ref default, .. } => {
2107                 let add_bounds = add_bounds.get(&param.id).map_or(&[][..], |x| &x);
2108                 if !add_bounds.is_empty() {
2109                     let params = self.lower_param_bounds_mut(add_bounds, itctx.reborrow());
2110                     bounds.extend(params);
2111                 }
2112
2113                 let kind = hir::GenericParamKind::Type {
2114                     default: default.as_ref().map(|x| {
2115                         self.lower_ty(
2116                             x,
2117                             ImplTraitContext::OpaqueTy(None, hir::OpaqueTyOrigin::Misc),
2118                         )
2119                     }),
2120                     synthetic: param
2121                         .attrs
2122                         .iter()
2123                         .filter(|attr| attr.check_name(sym::rustc_synthetic))
2124                         .map(|_| hir::SyntheticTyParamKind::ImplTrait)
2125                         .next(),
2126                 };
2127
2128                 (hir::ParamName::Plain(param.ident), kind)
2129             }
2130             GenericParamKind::Const { ref ty } => {
2131                 let ty = self
2132                     .with_anonymous_lifetime_mode(AnonymousLifetimeMode::ReportError, |this| {
2133                         this.lower_ty(&ty, ImplTraitContext::disallowed())
2134                     });
2135
2136                 (hir::ParamName::Plain(param.ident), hir::GenericParamKind::Const { ty })
2137             }
2138         };
2139
2140         hir::GenericParam {
2141             hir_id: self.lower_node_id(param.id),
2142             name,
2143             span: param.ident.span,
2144             pure_wrt_drop: attr::contains_name(&param.attrs, sym::may_dangle),
2145             attrs: self.lower_attrs(&param.attrs),
2146             bounds: self.arena.alloc_from_iter(bounds),
2147             kind,
2148         }
2149     }
2150
2151     fn lower_trait_ref(
2152         &mut self,
2153         p: &TraitRef,
2154         itctx: ImplTraitContext<'_, 'hir>,
2155     ) -> hir::TraitRef<'hir> {
2156         let path = match self.lower_qpath(p.ref_id, &None, &p.path, ParamMode::Explicit, itctx) {
2157             hir::QPath::Resolved(None, path) => path,
2158             qpath => bug!("lower_trait_ref: unexpected QPath `{:?}`", qpath),
2159         };
2160         hir::TraitRef { path, hir_ref_id: self.lower_node_id(p.ref_id) }
2161     }
2162
2163     fn lower_poly_trait_ref(
2164         &mut self,
2165         p: &PolyTraitRef,
2166         mut itctx: ImplTraitContext<'_, 'hir>,
2167     ) -> hir::PolyTraitRef<'hir> {
2168         let bound_generic_params = self.lower_generic_params(
2169             &p.bound_generic_params,
2170             &NodeMap::default(),
2171             itctx.reborrow(),
2172         );
2173         let trait_ref = self.with_in_scope_lifetime_defs(&p.bound_generic_params, |this| {
2174             this.lower_trait_ref(&p.trait_ref, itctx)
2175         });
2176
2177         hir::PolyTraitRef { bound_generic_params, trait_ref, span: p.span }
2178     }
2179
2180     fn lower_mt(&mut self, mt: &MutTy, itctx: ImplTraitContext<'_, 'hir>) -> hir::MutTy<'hir> {
2181         hir::MutTy { ty: self.lower_ty(&mt.ty, itctx), mutbl: mt.mutbl }
2182     }
2183
2184     fn lower_param_bounds(
2185         &mut self,
2186         bounds: &[GenericBound],
2187         itctx: ImplTraitContext<'_, 'hir>,
2188     ) -> hir::GenericBounds<'hir> {
2189         self.arena.alloc_from_iter(self.lower_param_bounds_mut(bounds, itctx))
2190     }
2191
2192     fn lower_param_bounds_mut<'s>(
2193         &'s mut self,
2194         bounds: &'s [GenericBound],
2195         mut itctx: ImplTraitContext<'s, 'hir>,
2196     ) -> impl Iterator<Item = hir::GenericBound<'hir>> + Captures<'s> + Captures<'a> {
2197         bounds.iter().map(move |bound| self.lower_param_bound(bound, itctx.reborrow()))
2198     }
2199
2200     fn lower_block(&mut self, b: &Block, targeted_by_break: bool) -> &'hir hir::Block<'hir> {
2201         self.arena.alloc(self.lower_block_noalloc(b, targeted_by_break))
2202     }
2203
2204     fn lower_block_noalloc(&mut self, b: &Block, targeted_by_break: bool) -> hir::Block<'hir> {
2205         let mut stmts = vec![];
2206         let mut expr: Option<&'hir _> = None;
2207
2208         for (index, stmt) in b.stmts.iter().enumerate() {
2209             if index == b.stmts.len() - 1 {
2210                 if let StmtKind::Expr(ref e) = stmt.kind {
2211                     expr = Some(self.lower_expr(e));
2212                 } else {
2213                     stmts.extend(self.lower_stmt(stmt));
2214                 }
2215             } else {
2216                 stmts.extend(self.lower_stmt(stmt));
2217             }
2218         }
2219
2220         hir::Block {
2221             hir_id: self.lower_node_id(b.id),
2222             stmts: self.arena.alloc_from_iter(stmts),
2223             expr,
2224             rules: self.lower_block_check_mode(&b.rules),
2225             span: b.span,
2226             targeted_by_break,
2227         }
2228     }
2229
2230     /// Lowers a block directly to an expression, presuming that it
2231     /// has no attributes and is not targeted by a `break`.
2232     fn lower_block_expr(&mut self, b: &Block) -> hir::Expr<'hir> {
2233         let block = self.lower_block(b, false);
2234         self.expr_block(block, AttrVec::new())
2235     }
2236
2237     fn lower_anon_const(&mut self, c: &AnonConst) -> hir::AnonConst {
2238         self.with_new_scopes(|this| hir::AnonConst {
2239             hir_id: this.lower_node_id(c.id),
2240             body: this.lower_const_body(c.value.span, Some(&c.value)),
2241         })
2242     }
2243
2244     fn lower_stmt(&mut self, s: &Stmt) -> SmallVec<[hir::Stmt<'hir>; 1]> {
2245         let kind = match s.kind {
2246             StmtKind::Local(ref l) => {
2247                 let (l, item_ids) = self.lower_local(l);
2248                 let mut ids: SmallVec<[hir::Stmt<'hir>; 1]> = item_ids
2249                     .into_iter()
2250                     .map(|item_id| {
2251                         let item_id = hir::ItemId { id: self.lower_node_id(item_id) };
2252                         self.stmt(s.span, hir::StmtKind::Item(item_id))
2253                     })
2254                     .collect();
2255                 ids.push({
2256                     hir::Stmt {
2257                         hir_id: self.lower_node_id(s.id),
2258                         kind: hir::StmtKind::Local(self.arena.alloc(l)),
2259                         span: s.span,
2260                     }
2261                 });
2262                 return ids;
2263             }
2264             StmtKind::Item(ref it) => {
2265                 // Can only use the ID once.
2266                 let mut id = Some(s.id);
2267                 return self
2268                     .lower_item_id(it)
2269                     .into_iter()
2270                     .map(|item_id| {
2271                         let hir_id = id
2272                             .take()
2273                             .map(|id| self.lower_node_id(id))
2274                             .unwrap_or_else(|| self.next_id());
2275
2276                         hir::Stmt { hir_id, kind: hir::StmtKind::Item(item_id), span: s.span }
2277                     })
2278                     .collect();
2279             }
2280             StmtKind::Expr(ref e) => hir::StmtKind::Expr(self.lower_expr(e)),
2281             StmtKind::Semi(ref e) => hir::StmtKind::Semi(self.lower_expr(e)),
2282             StmtKind::Mac(..) => panic!("shouldn't exist here"),
2283         };
2284         smallvec![hir::Stmt { hir_id: self.lower_node_id(s.id), kind, span: s.span }]
2285     }
2286
2287     fn lower_block_check_mode(&mut self, b: &BlockCheckMode) -> hir::BlockCheckMode {
2288         match *b {
2289             BlockCheckMode::Default => hir::BlockCheckMode::DefaultBlock,
2290             BlockCheckMode::Unsafe(u) => {
2291                 hir::BlockCheckMode::UnsafeBlock(self.lower_unsafe_source(u))
2292             }
2293         }
2294     }
2295
2296     fn lower_unsafe_source(&mut self, u: UnsafeSource) -> hir::UnsafeSource {
2297         match u {
2298             CompilerGenerated => hir::UnsafeSource::CompilerGenerated,
2299             UserProvided => hir::UnsafeSource::UserProvided,
2300         }
2301     }
2302
2303     fn lower_trait_bound_modifier(&mut self, f: TraitBoundModifier) -> hir::TraitBoundModifier {
2304         match f {
2305             TraitBoundModifier::None => hir::TraitBoundModifier::None,
2306             TraitBoundModifier::MaybeConst => hir::TraitBoundModifier::MaybeConst,
2307
2308             // `MaybeConstMaybe` will cause an error during AST validation, but we need to pick a
2309             // placeholder for compilation to proceed.
2310             TraitBoundModifier::MaybeConstMaybe | TraitBoundModifier::Maybe => {
2311                 hir::TraitBoundModifier::Maybe
2312             }
2313         }
2314     }
2315
2316     // Helper methods for building HIR.
2317
2318     fn stmt(&mut self, span: Span, kind: hir::StmtKind<'hir>) -> hir::Stmt<'hir> {
2319         hir::Stmt { span, kind, hir_id: self.next_id() }
2320     }
2321
2322     fn stmt_expr(&mut self, span: Span, expr: hir::Expr<'hir>) -> hir::Stmt<'hir> {
2323         self.stmt(span, hir::StmtKind::Expr(self.arena.alloc(expr)))
2324     }
2325
2326     fn stmt_let_pat(
2327         &mut self,
2328         attrs: AttrVec,
2329         span: Span,
2330         init: Option<&'hir hir::Expr<'hir>>,
2331         pat: &'hir hir::Pat<'hir>,
2332         source: hir::LocalSource,
2333     ) -> hir::Stmt<'hir> {
2334         let local = hir::Local { attrs, hir_id: self.next_id(), init, pat, source, span, ty: None };
2335         self.stmt(span, hir::StmtKind::Local(self.arena.alloc(local)))
2336     }
2337
2338     fn block_expr(&mut self, expr: &'hir hir::Expr<'hir>) -> &'hir hir::Block<'hir> {
2339         self.block_all(expr.span, &[], Some(expr))
2340     }
2341
2342     fn block_all(
2343         &mut self,
2344         span: Span,
2345         stmts: &'hir [hir::Stmt<'hir>],
2346         expr: Option<&'hir hir::Expr<'hir>>,
2347     ) -> &'hir hir::Block<'hir> {
2348         let blk = hir::Block {
2349             stmts,
2350             expr,
2351             hir_id: self.next_id(),
2352             rules: hir::BlockCheckMode::DefaultBlock,
2353             span,
2354             targeted_by_break: false,
2355         };
2356         self.arena.alloc(blk)
2357     }
2358
2359     /// Constructs a `true` or `false` literal pattern.
2360     fn pat_bool(&mut self, span: Span, val: bool) -> &'hir hir::Pat<'hir> {
2361         let expr = self.expr_bool(span, val);
2362         self.pat(span, hir::PatKind::Lit(expr))
2363     }
2364
2365     fn pat_ok(&mut self, span: Span, pat: &'hir hir::Pat<'hir>) -> &'hir hir::Pat<'hir> {
2366         self.pat_std_enum(span, &[sym::result, sym::Result, sym::Ok], arena_vec![self; pat])
2367     }
2368
2369     fn pat_err(&mut self, span: Span, pat: &'hir hir::Pat<'hir>) -> &'hir hir::Pat<'hir> {
2370         self.pat_std_enum(span, &[sym::result, sym::Result, sym::Err], arena_vec![self; pat])
2371     }
2372
2373     fn pat_some(&mut self, span: Span, pat: &'hir hir::Pat<'hir>) -> &'hir hir::Pat<'hir> {
2374         self.pat_std_enum(span, &[sym::option, sym::Option, sym::Some], arena_vec![self; pat])
2375     }
2376
2377     fn pat_none(&mut self, span: Span) -> &'hir hir::Pat<'hir> {
2378         self.pat_std_enum(span, &[sym::option, sym::Option, sym::None], &[])
2379     }
2380
2381     fn pat_std_enum(
2382         &mut self,
2383         span: Span,
2384         components: &[Symbol],
2385         subpats: &'hir [&'hir hir::Pat<'hir>],
2386     ) -> &'hir hir::Pat<'hir> {
2387         let path = self.std_path(span, components, None, true);
2388         let qpath = hir::QPath::Resolved(None, path);
2389         let pt = if subpats.is_empty() {
2390             hir::PatKind::Path(qpath)
2391         } else {
2392             hir::PatKind::TupleStruct(qpath, subpats, None)
2393         };
2394         self.pat(span, pt)
2395     }
2396
2397     fn pat_ident(&mut self, span: Span, ident: Ident) -> (&'hir hir::Pat<'hir>, hir::HirId) {
2398         self.pat_ident_binding_mode(span, ident, hir::BindingAnnotation::Unannotated)
2399     }
2400
2401     fn pat_ident_binding_mode(
2402         &mut self,
2403         span: Span,
2404         ident: Ident,
2405         bm: hir::BindingAnnotation,
2406     ) -> (&'hir hir::Pat<'hir>, hir::HirId) {
2407         let hir_id = self.next_id();
2408
2409         (
2410             self.arena.alloc(hir::Pat {
2411                 hir_id,
2412                 kind: hir::PatKind::Binding(bm, hir_id, ident.with_span_pos(span), None),
2413                 span,
2414             }),
2415             hir_id,
2416         )
2417     }
2418
2419     fn pat_wild(&mut self, span: Span) -> &'hir hir::Pat<'hir> {
2420         self.pat(span, hir::PatKind::Wild)
2421     }
2422
2423     fn pat(&mut self, span: Span, kind: hir::PatKind<'hir>) -> &'hir hir::Pat<'hir> {
2424         self.arena.alloc(hir::Pat { hir_id: self.next_id(), kind, span })
2425     }
2426
2427     /// Given a suffix `["b", "c", "d"]`, returns path `::std::b::c::d` when
2428     /// `fld.cx.use_std`, and `::core::b::c::d` otherwise.
2429     /// The path is also resolved according to `is_value`.
2430     fn std_path(
2431         &mut self,
2432         span: Span,
2433         components: &[Symbol],
2434         params: Option<&'hir hir::GenericArgs<'hir>>,
2435         is_value: bool,
2436     ) -> &'hir hir::Path<'hir> {
2437         let ns = if is_value { Namespace::ValueNS } else { Namespace::TypeNS };
2438         let (path, res) = self.resolver.resolve_str_path(span, self.crate_root, components, ns);
2439
2440         let mut segments: Vec<_> = path
2441             .segments
2442             .iter()
2443             .map(|segment| {
2444                 let res = self.expect_full_res(segment.id);
2445                 hir::PathSegment {
2446                     ident: segment.ident,
2447                     hir_id: Some(self.lower_node_id(segment.id)),
2448                     res: Some(self.lower_res(res)),
2449                     infer_args: true,
2450                     args: None,
2451                 }
2452             })
2453             .collect();
2454         segments.last_mut().unwrap().args = params;
2455
2456         self.arena.alloc(hir::Path {
2457             span,
2458             res: res.map_id(|_| panic!("unexpected `NodeId`")),
2459             segments: self.arena.alloc_from_iter(segments),
2460         })
2461     }
2462
2463     fn ty_path(
2464         &mut self,
2465         mut hir_id: hir::HirId,
2466         span: Span,
2467         qpath: hir::QPath<'hir>,
2468     ) -> hir::Ty<'hir> {
2469         let kind = match qpath {
2470             hir::QPath::Resolved(None, path) => {
2471                 // Turn trait object paths into `TyKind::TraitObject` instead.
2472                 match path.res {
2473                     Res::Def(DefKind::Trait, _) | Res::Def(DefKind::TraitAlias, _) => {
2474                         let principal = hir::PolyTraitRef {
2475                             bound_generic_params: &[],
2476                             trait_ref: hir::TraitRef { path, hir_ref_id: hir_id },
2477                             span,
2478                         };
2479
2480                         // The original ID is taken by the `PolyTraitRef`,
2481                         // so the `Ty` itself needs a different one.
2482                         hir_id = self.next_id();
2483                         hir::TyKind::TraitObject(
2484                             arena_vec![self; principal],
2485                             self.elided_dyn_bound(span),
2486                         )
2487                     }
2488                     _ => hir::TyKind::Path(hir::QPath::Resolved(None, path)),
2489                 }
2490             }
2491             _ => hir::TyKind::Path(qpath),
2492         };
2493
2494         hir::Ty { hir_id, kind, span }
2495     }
2496
2497     /// Invoked to create the lifetime argument for a type `&T`
2498     /// with no explicit lifetime.
2499     fn elided_ref_lifetime(&mut self, span: Span) -> hir::Lifetime {
2500         match self.anonymous_lifetime_mode {
2501             // Intercept when we are in an impl header or async fn and introduce an in-band
2502             // lifetime.
2503             // Hence `impl Foo for &u32` becomes `impl<'f> Foo for &'f u32` for some fresh
2504             // `'f`.
2505             AnonymousLifetimeMode::CreateParameter => {
2506                 let fresh_name = self.collect_fresh_in_band_lifetime(span);
2507                 hir::Lifetime {
2508                     hir_id: self.next_id(),
2509                     span,
2510                     name: hir::LifetimeName::Param(fresh_name),
2511                 }
2512             }
2513
2514             AnonymousLifetimeMode::ReportError => self.new_error_lifetime(None, span),
2515
2516             AnonymousLifetimeMode::PassThrough => self.new_implicit_lifetime(span),
2517         }
2518     }
2519
2520     /// Report an error on illegal use of `'_` or a `&T` with no explicit lifetime;
2521     /// return a "error lifetime".
2522     fn new_error_lifetime(&mut self, id: Option<NodeId>, span: Span) -> hir::Lifetime {
2523         let (id, msg, label) = match id {
2524             Some(id) => (id, "`'_` cannot be used here", "`'_` is a reserved lifetime name"),
2525
2526             None => (
2527                 self.resolver.next_node_id(),
2528                 "`&` without an explicit lifetime name cannot be used here",
2529                 "explicit lifetime name needed here",
2530             ),
2531         };
2532
2533         let mut err = struct_span_err!(self.sess, span, E0637, "{}", msg,);
2534         err.span_label(span, label);
2535         err.emit();
2536
2537         self.new_named_lifetime(id, span, hir::LifetimeName::Error)
2538     }
2539
2540     /// Invoked to create the lifetime argument(s) for a path like
2541     /// `std::cell::Ref<T>`; note that implicit lifetimes in these
2542     /// sorts of cases are deprecated. This may therefore report a warning or an
2543     /// error, depending on the mode.
2544     fn elided_path_lifetimes<'s>(
2545         &'s mut self,
2546         span: Span,
2547         count: usize,
2548     ) -> impl Iterator<Item = hir::Lifetime> + Captures<'a> + Captures<'s> + Captures<'hir> {
2549         (0..count).map(move |_| self.elided_path_lifetime(span))
2550     }
2551
2552     fn elided_path_lifetime(&mut self, span: Span) -> hir::Lifetime {
2553         match self.anonymous_lifetime_mode {
2554             AnonymousLifetimeMode::CreateParameter => {
2555                 // We should have emitted E0726 when processing this path above
2556                 self.sess
2557                     .delay_span_bug(span, "expected 'implicit elided lifetime not allowed' error");
2558                 let id = self.resolver.next_node_id();
2559                 self.new_named_lifetime(id, span, hir::LifetimeName::Error)
2560             }
2561             // `PassThrough` is the normal case.
2562             // `new_error_lifetime`, which would usually be used in the case of `ReportError`,
2563             // is unsuitable here, as these can occur from missing lifetime parameters in a
2564             // `PathSegment`, for which there is no associated `'_` or `&T` with no explicit
2565             // lifetime. Instead, we simply create an implicit lifetime, which will be checked
2566             // later, at which point a suitable error will be emitted.
2567             AnonymousLifetimeMode::PassThrough | AnonymousLifetimeMode::ReportError => {
2568                 self.new_implicit_lifetime(span)
2569             }
2570         }
2571     }
2572
2573     /// Invoked to create the lifetime argument(s) for an elided trait object
2574     /// bound, like the bound in `Box<dyn Debug>`. This method is not invoked
2575     /// when the bound is written, even if it is written with `'_` like in
2576     /// `Box<dyn Debug + '_>`. In those cases, `lower_lifetime` is invoked.
2577     fn elided_dyn_bound(&mut self, span: Span) -> hir::Lifetime {
2578         match self.anonymous_lifetime_mode {
2579             // NB. We intentionally ignore the create-parameter mode here.
2580             // and instead "pass through" to resolve-lifetimes, which will apply
2581             // the object-lifetime-defaulting rules. Elided object lifetime defaults
2582             // do not act like other elided lifetimes. In other words, given this:
2583             //
2584             //     impl Foo for Box<dyn Debug>
2585             //
2586             // we do not introduce a fresh `'_` to serve as the bound, but instead
2587             // ultimately translate to the equivalent of:
2588             //
2589             //     impl Foo for Box<dyn Debug + 'static>
2590             //
2591             // `resolve_lifetime` has the code to make that happen.
2592             AnonymousLifetimeMode::CreateParameter => {}
2593
2594             AnonymousLifetimeMode::ReportError => {
2595                 // ReportError applies to explicit use of `'_`.
2596             }
2597
2598             // This is the normal case.
2599             AnonymousLifetimeMode::PassThrough => {}
2600         }
2601
2602         let r = hir::Lifetime {
2603             hir_id: self.next_id(),
2604             span,
2605             name: hir::LifetimeName::ImplicitObjectLifetimeDefault,
2606         };
2607         debug!("elided_dyn_bound: r={:?}", r);
2608         r
2609     }
2610
2611     fn new_implicit_lifetime(&mut self, span: Span) -> hir::Lifetime {
2612         hir::Lifetime { hir_id: self.next_id(), span, name: hir::LifetimeName::Implicit }
2613     }
2614
2615     fn maybe_lint_bare_trait(&mut self, span: Span, id: NodeId, is_global: bool) {
2616         // FIXME(davidtwco): This is a hack to detect macros which produce spans of the
2617         // call site which do not have a macro backtrace. See #61963.
2618         let is_macro_callsite = self
2619             .sess
2620             .source_map()
2621             .span_to_snippet(span)
2622             .map(|snippet| snippet.starts_with("#["))
2623             .unwrap_or(true);
2624         if !is_macro_callsite {
2625             self.resolver.lint_buffer().buffer_lint_with_diagnostic(
2626                 BARE_TRAIT_OBJECTS,
2627                 id,
2628                 span,
2629                 "trait objects without an explicit `dyn` are deprecated",
2630                 BuiltinLintDiagnostics::BareTraitObject(span, is_global),
2631             )
2632         }
2633     }
2634 }
2635
2636 fn body_ids(bodies: &BTreeMap<hir::BodyId, hir::Body<'_>>) -> Vec<hir::BodyId> {
2637     // Sorting by span ensures that we get things in order within a
2638     // file, and also puts the files in a sensible order.
2639     let mut body_ids: Vec<_> = bodies.keys().cloned().collect();
2640     body_ids.sort_by_key(|b| bodies[b].value.span);
2641     body_ids
2642 }
2643
2644 /// Helper struct for delayed construction of GenericArgs.
2645 struct GenericArgsCtor<'hir> {
2646     args: SmallVec<[hir::GenericArg<'hir>; 4]>,
2647     bindings: &'hir [hir::TypeBinding<'hir>],
2648     parenthesized: bool,
2649 }
2650
2651 impl<'hir> GenericArgsCtor<'hir> {
2652     fn is_empty(&self) -> bool {
2653         self.args.is_empty() && self.bindings.is_empty() && !self.parenthesized
2654     }
2655
2656     fn into_generic_args(self, arena: &'hir Arena<'hir>) -> hir::GenericArgs<'hir> {
2657         hir::GenericArgs {
2658             args: arena.alloc_from_iter(self.args),
2659             bindings: self.bindings,
2660             parenthesized: self.parenthesized,
2661         }
2662     }
2663 }