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