]> git.proxmox.com Git - rustc.git/blame - compiler/rustc_ast_lowering/src/item.rs
New upstream version 1.49.0+dfsg1
[rustc.git] / compiler / rustc_ast_lowering / src / item.rs
CommitLineData
dfeec247 1use super::{AnonymousLifetimeMode, LoweringContext, ParamMode};
f035d41b 2use super::{ImplTraitContext, ImplTraitPosition};
ba9703b0 3use crate::Arena;
dfeec247 4
74b04a01 5use rustc_ast::node_id::NodeMap;
ba9703b0 6use rustc_ast::ptr::P;
3dfed10e
XL
7use rustc_ast::visit::{self, AssocCtxt, FnCtxt, FnKind, Visitor};
8use rustc_ast::*;
f035d41b 9use rustc_data_structures::fx::FxHashSet;
dfeec247
XL
10use rustc_errors::struct_span_err;
11use rustc_hir as hir;
12use rustc_hir::def::{DefKind, Res};
ba9703b0 13use rustc_hir::def_id::LocalDefId;
dfeec247 14use rustc_span::source_map::{respan, DesugaringKind};
f9f354fc 15use rustc_span::symbol::{kw, sym, Ident};
dfeec247 16use rustc_span::Span;
60c5eb7d 17use rustc_target::spec::abi;
416331ca 18
dfeec247
XL
19use smallvec::{smallvec, SmallVec};
20use std::collections::BTreeSet;
3dfed10e 21use tracing::debug;
60c5eb7d 22
dfeec247
XL
23pub(super) struct ItemLowerer<'a, 'lowering, 'hir> {
24 pub(super) lctx: &'a mut LoweringContext<'lowering, 'hir>,
416331ca
XL
25}
26
dfeec247
XL
27impl ItemLowerer<'_, '_, '_> {
28 fn with_trait_impl_ref(&mut self, impl_ref: &Option<TraitRef>, f: impl FnOnce(&mut Self)) {
416331ca 29 let old = self.lctx.is_in_trait_impl;
1b1a35ee 30 self.lctx.is_in_trait_impl = impl_ref.is_some();
416331ca
XL
31 f(self);
32 self.lctx.is_in_trait_impl = old;
33 }
34}
35
dfeec247
XL
36impl<'a> Visitor<'a> for ItemLowerer<'a, '_, '_> {
37 fn visit_mod(&mut self, m: &'a Mod, _s: Span, _attrs: &[Attribute], n: NodeId) {
e74abb32
XL
38 let hir_id = self.lctx.lower_node_id(n);
39
dfeec247
XL
40 self.lctx.modules.insert(
41 hir_id,
42 hir::ModuleItems {
43 items: BTreeSet::new(),
44 trait_items: BTreeSet::new(),
45 impl_items: BTreeSet::new(),
46 },
47 );
416331ca
XL
48
49 let old = self.lctx.current_module;
e74abb32 50 self.lctx.current_module = hir_id;
416331ca
XL
51 visit::walk_mod(self, m);
52 self.lctx.current_module = old;
53 }
54
dfeec247 55 fn visit_item(&mut self, item: &'a Item) {
416331ca
XL
56 let mut item_hir_id = None;
57 self.lctx.with_hir_id_owner(item.id, |lctx| {
e1599b0c
XL
58 lctx.without_in_scope_lifetime_defs(|lctx| {
59 if let Some(hir_item) = lctx.lower_item(item) {
60 item_hir_id = Some(hir_item.hir_id);
61 lctx.insert_item(hir_item);
62 }
63 })
416331ca
XL
64 });
65
66 if let Some(hir_id) = item_hir_id {
67 self.lctx.with_parent_item_lifetime_defs(hir_id, |this| {
68 let this = &mut ItemLowerer { lctx: this };
74b04a01 69 if let ItemKind::Impl { ref of_trait, .. } = item.kind {
dfeec247 70 this.with_trait_impl_ref(of_trait, |this| visit::walk_item(this, item));
416331ca
XL
71 } else {
72 visit::walk_item(this, item);
73 }
74 });
75 }
76 }
77
3dfed10e
XL
78 fn visit_fn(&mut self, fk: FnKind<'a>, sp: Span, _: NodeId) {
79 match fk {
80 FnKind::Fn(FnCtxt::Foreign, _, sig, _, _) => {
81 self.visit_fn_header(&sig.header);
82 visit::walk_fn_decl(self, &sig.decl);
83 // Don't visit the foreign function body even if it has one, since lowering the
84 // body would have no meaning and will have already been caught as a parse error.
85 }
86 _ => visit::walk_fn(self, fk, sp),
87 }
88 }
89
74b04a01
XL
90 fn visit_assoc_item(&mut self, item: &'a AssocItem, ctxt: AssocCtxt) {
91 self.lctx.with_hir_id_owner(item.id, |lctx| match ctxt {
92 AssocCtxt::Trait => {
93 let hir_item = lctx.lower_trait_item(item);
94 let id = hir::TraitItemId { hir_id: hir_item.hir_id };
95 lctx.trait_items.insert(id, hir_item);
96 lctx.modules.get_mut(&lctx.current_module).unwrap().trait_items.insert(id);
97 }
98 AssocCtxt::Impl => {
99 let hir_item = lctx.lower_impl_item(item);
100 let id = hir::ImplItemId { hir_id: hir_item.hir_id };
101 lctx.impl_items.insert(id, hir_item);
102 lctx.modules.get_mut(&lctx.current_module).unwrap().impl_items.insert(id);
103 }
416331ca
XL
104 });
105
74b04a01 106 visit::walk_assoc_item(self, item, ctxt);
416331ca
XL
107 }
108}
109
dfeec247 110impl<'hir> LoweringContext<'_, 'hir> {
416331ca
XL
111 // Same as the method above, but accepts `hir::GenericParam`s
112 // instead of `ast::GenericParam`s.
113 // This should only be used with generics that have already had their
114 // in-band lifetimes added. In practice, this means that this function is
115 // only used when lowering a child item of a trait or impl.
116 fn with_parent_item_lifetime_defs<T>(
117 &mut self,
118 parent_hir_id: hir::HirId,
dfeec247 119 f: impl FnOnce(&mut LoweringContext<'_, '_>) -> T,
416331ca
XL
120 ) -> T {
121 let old_len = self.in_scope_lifetimes.len();
122
e74abb32 123 let parent_generics = match self.items.get(&parent_hir_id).unwrap().kind {
dfeec247
XL
124 hir::ItemKind::Impl { ref generics, .. }
125 | hir::ItemKind::Trait(_, _, ref generics, ..) => &generics.params[..],
416331ca
XL
126 _ => &[],
127 };
128 let lt_def_names = parent_generics.iter().filter_map(|param| match param.kind {
ba9703b0 129 hir::GenericParamKind::Lifetime { .. } => Some(param.name.normalize_to_macros_2_0()),
416331ca
XL
130 _ => None,
131 });
132 self.in_scope_lifetimes.extend(lt_def_names);
133
134 let res = f(self);
135
136 self.in_scope_lifetimes.truncate(old_len);
137 res
138 }
139
e1599b0c
XL
140 // Clears (and restores) the `in_scope_lifetimes` field. Used when
141 // visiting nested items, which never inherit in-scope lifetimes
142 // from their surrounding environment.
143 fn without_in_scope_lifetime_defs<T>(
144 &mut self,
dfeec247 145 f: impl FnOnce(&mut LoweringContext<'_, '_>) -> T,
e1599b0c
XL
146 ) -> T {
147 let old_in_scope_lifetimes = std::mem::replace(&mut self.in_scope_lifetimes, vec![]);
148
149 // this vector is only used when walking over impl headers,
150 // input types, and the like, and should not be non-empty in
151 // between items
152 assert!(self.lifetimes_to_define.is_empty());
153
154 let res = f(self);
155
156 assert!(self.in_scope_lifetimes.is_empty());
157 self.in_scope_lifetimes = old_in_scope_lifetimes;
158
159 res
160 }
161
dfeec247 162 pub(super) fn lower_mod(&mut self, m: &Mod) -> hir::Mod<'hir> {
416331ca
XL
163 hir::Mod {
164 inner: m.inner,
dfeec247
XL
165 item_ids: self
166 .arena
167 .alloc_from_iter(m.items.iter().flat_map(|x| self.lower_item_id(x))),
416331ca
XL
168 }
169 }
170
171 pub(super) fn lower_item_id(&mut self, i: &Item) -> SmallVec<[hir::ItemId; 1]> {
e74abb32 172 let node_ids = match i.kind {
416331ca
XL
173 ItemKind::Use(ref use_tree) => {
174 let mut vec = smallvec![i.id];
175 self.lower_item_id_use_tree(use_tree, i.id, &mut vec);
176 vec
177 }
178 ItemKind::MacroDef(..) => SmallVec::new(),
dfeec247 179 ItemKind::Fn(..) | ItemKind::Impl { of_trait: None, .. } => smallvec![i.id],
416331ca
XL
180 _ => smallvec![i.id],
181 };
182
dfeec247
XL
183 node_ids
184 .into_iter()
185 .map(|node_id| hir::ItemId { id: self.allocate_hir_id_counter(node_id) })
186 .collect()
416331ca
XL
187 }
188
189 fn lower_item_id_use_tree(
190 &mut self,
191 tree: &UseTree,
192 base_id: NodeId,
dfeec247 193 vec: &mut SmallVec<[NodeId; 1]>,
416331ca
XL
194 ) {
195 match tree.kind {
dfeec247
XL
196 UseTreeKind::Nested(ref nested_vec) => {
197 for &(ref nested, id) in nested_vec {
198 vec.push(id);
199 self.lower_item_id_use_tree(nested, id, vec);
200 }
201 }
416331ca
XL
202 UseTreeKind::Glob => {}
203 UseTreeKind::Simple(_, id1, id2) => {
dfeec247
XL
204 for (_, &id) in
205 self.expect_full_res_from_use(base_id).skip(1).zip([id1, id2].iter())
416331ca
XL
206 {
207 vec.push(id);
208 }
dfeec247 209 }
416331ca
XL
210 }
211 }
212
dfeec247 213 pub fn lower_item(&mut self, i: &Item) -> Option<hir::Item<'hir>> {
416331ca
XL
214 let mut ident = i.ident;
215 let mut vis = self.lower_visibility(&i.vis, None);
60c5eb7d 216 let attrs = self.lower_attrs(&i.attrs);
416331ca 217
ba9703b0 218 if let ItemKind::MacroDef(MacroDef { ref body, macro_rules }) = i.kind {
3dfed10e 219 if !macro_rules || self.sess.contains_name(&i.attrs, sym::macro_export) {
416331ca 220 let hir_id = self.lower_node_id(i.id);
ba9703b0 221 let body = P(self.lower_mac_args(body));
416331ca 222 self.exported_macros.push(hir::MacroDef {
ba9703b0 223 ident,
416331ca
XL
224 vis,
225 attrs,
226 hir_id,
227 span: i.span,
ba9703b0 228 ast: MacroDef { body, macro_rules },
416331ca
XL
229 });
230 } else {
dfeec247 231 self.non_exported_macro_attrs.extend(attrs.iter().cloned());
416331ca
XL
232 }
233 return None;
234 }
235
dfeec247 236 let kind = self.lower_item_kind(i.span, i.id, &mut ident, attrs, &mut vis, &i.kind);
416331ca 237
dfeec247 238 Some(hir::Item { hir_id: self.lower_node_id(i.id), ident, attrs, kind, vis, span: i.span })
416331ca
XL
239 }
240
241 fn lower_item_kind(
242 &mut self,
dfeec247 243 span: Span,
416331ca
XL
244 id: NodeId,
245 ident: &mut Ident,
dfeec247
XL
246 attrs: &'hir [Attribute],
247 vis: &mut hir::Visibility<'hir>,
416331ca 248 i: &ItemKind,
dfeec247 249 ) -> hir::ItemKind<'hir> {
416331ca
XL
250 match *i {
251 ItemKind::ExternCrate(orig_name) => hir::ItemKind::ExternCrate(orig_name),
252 ItemKind::Use(ref use_tree) => {
253 // Start with an empty prefix.
1b1a35ee 254 let prefix = Path { segments: vec![], span: use_tree.span, tokens: None };
416331ca
XL
255
256 self.lower_use_tree(use_tree, &prefix, id, vis, ident, attrs)
257 }
258 ItemKind::Static(ref t, m, ref e) => {
74b04a01
XL
259 let (ty, body_id) = self.lower_const_item(t, span, e.as_deref());
260 hir::ItemKind::Static(ty, m, body_id)
416331ca 261 }
74b04a01
XL
262 ItemKind::Const(_, ref t, ref e) => {
263 let (ty, body_id) = self.lower_const_item(t, span, e.as_deref());
264 hir::ItemKind::Const(ty, body_id)
416331ca 265 }
3dfed10e
XL
266 ItemKind::Fn(
267 _,
268 FnSig { ref decl, header, span: fn_sig_span },
269 ref generics,
270 ref body,
271 ) => {
f035d41b 272 let fn_def_id = self.resolver.local_def_id(id);
416331ca
XL
273 self.with_new_scopes(|this| {
274 this.current_item = Some(ident.span);
275
276 // Note: we don't need to change the return type from `T` to
277 // `impl Future<Output = T>` here because lower_body
278 // only cares about the input argument patterns in the function
279 // declaration (decl), not the return types.
74b04a01 280 let asyncness = header.asyncness;
dfeec247 281 let body_id =
74b04a01 282 this.lower_maybe_async_body(span, &decl, asyncness, body.as_deref());
416331ca 283
60c5eb7d 284 let (generics, decl) = this.add_in_band_defs(
416331ca
XL
285 generics,
286 fn_def_id,
287 AnonymousLifetimeMode::PassThrough,
dfeec247 288 |this, idty| {
74b04a01 289 let ret_id = asyncness.opt_return_id();
ba9703b0
XL
290 this.lower_fn_decl(
291 &decl,
292 Some((fn_def_id.to_def_id(), idty)),
293 true,
294 ret_id,
295 )
dfeec247 296 },
416331ca 297 );
3dfed10e
XL
298 let sig = hir::FnSig {
299 decl,
300 header: this.lower_fn_header(header),
301 span: fn_sig_span,
302 };
60c5eb7d 303 hir::ItemKind::Fn(sig, generics, body_id)
416331ca
XL
304 })
305 }
306 ItemKind::Mod(ref m) => hir::ItemKind::Mod(self.lower_mod(m)),
307 ItemKind::ForeignMod(ref nm) => hir::ItemKind::ForeignMod(self.lower_foreign_mod(nm)),
308 ItemKind::GlobalAsm(ref ga) => hir::ItemKind::GlobalAsm(self.lower_global_asm(ga)),
f035d41b
XL
309 ItemKind::TyAlias(_, ref gen, _, Some(ref ty)) => {
310 // We lower
311 //
312 // type Foo = impl Trait
313 //
314 // to
315 //
316 // type Foo = Foo1
317 // opaque type Foo1: Trait
318 let ty = self.lower_ty(
319 ty,
320 ImplTraitContext::OtherOpaqueTy {
321 capturable_lifetimes: &mut FxHashSet::default(),
322 origin: hir::OpaqueTyOrigin::Misc,
323 },
324 );
325 let generics = self.lower_generics(gen, ImplTraitContext::disallowed());
326 hir::ItemKind::TyAlias(ty, generics)
327 }
74b04a01
XL
328 ItemKind::TyAlias(_, ref generics, _, None) => {
329 let ty = self.arena.alloc(self.ty(span, hir::TyKind::Err));
330 let generics = self.lower_generics(generics, ImplTraitContext::disallowed());
331 hir::ItemKind::TyAlias(ty, generics)
332 }
dfeec247
XL
333 ItemKind::Enum(ref enum_definition, ref generics) => hir::ItemKind::Enum(
334 hir::EnumDef {
335 variants: self.arena.alloc_from_iter(
336 enum_definition.variants.iter().map(|x| self.lower_variant(x)),
337 ),
338 },
339 self.lower_generics(generics, ImplTraitContext::disallowed()),
340 ),
416331ca
XL
341 ItemKind::Struct(ref struct_def, ref generics) => {
342 let struct_def = self.lower_variant_data(struct_def);
343 hir::ItemKind::Struct(
344 struct_def,
345 self.lower_generics(generics, ImplTraitContext::disallowed()),
346 )
347 }
348 ItemKind::Union(ref vdata, ref generics) => {
349 let vdata = self.lower_variant_data(vdata);
350 hir::ItemKind::Union(
351 vdata,
352 self.lower_generics(generics, ImplTraitContext::disallowed()),
353 )
354 }
dfeec247 355 ItemKind::Impl {
416331ca
XL
356 unsafety,
357 polarity,
358 defaultness,
dfeec247
XL
359 constness,
360 generics: ref ast_generics,
361 of_trait: ref trait_ref,
362 self_ty: ref ty,
363 items: ref impl_items,
364 } => {
f035d41b 365 let def_id = self.resolver.local_def_id(id);
416331ca
XL
366
367 // Lower the "impl header" first. This ordering is important
368 // for in-band lifetimes! Consider `'a` here:
369 //
370 // impl Foo<'a> for u32 {
371 // fn method(&'a self) { .. }
372 // }
373 //
374 // Because we start by lowering the `Foo<'a> for u32`
375 // part, we will add `'a` to the list of generics on
376 // the impl. When we then encounter it later in the
377 // method, it will not be considered an in-band
378 // lifetime to be added, but rather a reference to a
379 // parent lifetime.
380 let lowered_trait_impl_id = self.lower_node_id(id);
381 let (generics, (trait_ref, lowered_ty)) = self.add_in_band_defs(
382 ast_generics,
383 def_id,
384 AnonymousLifetimeMode::CreateParameter,
385 |this, _| {
386 let trait_ref = trait_ref.as_ref().map(|trait_ref| {
387 this.lower_trait_ref(trait_ref, ImplTraitContext::disallowed())
388 });
389
390 if let Some(ref trait_ref) = trait_ref {
391 if let Res::Def(DefKind::Trait, def_id) = trait_ref.path.res {
dfeec247
XL
392 this.trait_impls
393 .entry(def_id)
394 .or_default()
395 .push(lowered_trait_impl_id);
416331ca
XL
396 }
397 }
398
399 let lowered_ty = this.lower_ty(ty, ImplTraitContext::disallowed());
400
401 (trait_ref, lowered_ty)
402 },
403 );
404
dfeec247
XL
405 let new_impl_items =
406 self.with_in_scope_lifetime_defs(&ast_generics.params, |this| {
407 this.arena.alloc_from_iter(
408 impl_items.iter().map(|item| this.lower_impl_item_ref(item)),
409 )
410 });
416331ca 411
ba9703b0
XL
412 // `defaultness.has_value()` is never called for an `impl`, always `true` in order
413 // to not cause an assertion failure inside the `lower_defaultness` function.
414 let has_val = true;
415 let (defaultness, defaultness_span) = self.lower_defaultness(defaultness, has_val);
dfeec247 416 hir::ItemKind::Impl {
74b04a01 417 unsafety: self.lower_unsafety(unsafety),
60c5eb7d 418 polarity,
ba9703b0
XL
419 defaultness,
420 defaultness_span,
74b04a01 421 constness: self.lower_constness(constness),
416331ca 422 generics,
dfeec247
XL
423 of_trait: trait_ref,
424 self_ty: lowered_ty,
425 items: new_impl_items,
426 }
416331ca
XL
427 }
428 ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref items) => {
429 let bounds = self.lower_param_bounds(bounds, ImplTraitContext::disallowed());
dfeec247
XL
430 let items = self
431 .arena
432 .alloc_from_iter(items.iter().map(|item| self.lower_trait_item_ref(item)));
416331ca 433 hir::ItemKind::Trait(
60c5eb7d 434 is_auto,
74b04a01 435 self.lower_unsafety(unsafety),
416331ca
XL
436 self.lower_generics(generics, ImplTraitContext::disallowed()),
437 bounds,
438 items,
439 )
440 }
441 ItemKind::TraitAlias(ref generics, ref bounds) => hir::ItemKind::TraitAlias(
442 self.lower_generics(generics, ImplTraitContext::disallowed()),
443 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
444 ),
ba9703b0
XL
445 ItemKind::MacroDef(..) | ItemKind::MacCall(..) => {
446 panic!("`TyMac` should have been expanded by now")
dfeec247 447 }
416331ca 448 }
416331ca
XL
449 }
450
74b04a01
XL
451 fn lower_const_item(
452 &mut self,
453 ty: &Ty,
454 span: Span,
455 body: Option<&Expr>,
456 ) -> (&'hir hir::Ty<'hir>, hir::BodyId) {
f035d41b 457 let mut capturable_lifetimes;
74b04a01 458 let itctx = if self.sess.features_untracked().impl_trait_in_bindings {
f035d41b
XL
459 capturable_lifetimes = FxHashSet::default();
460 ImplTraitContext::OtherOpaqueTy {
461 capturable_lifetimes: &mut capturable_lifetimes,
462 origin: hir::OpaqueTyOrigin::Misc,
463 }
74b04a01
XL
464 } else {
465 ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
466 };
467 let ty = self.lower_ty(ty, itctx);
468 (ty, self.lower_const_body(span, body))
469 }
470
416331ca
XL
471 fn lower_use_tree(
472 &mut self,
473 tree: &UseTree,
474 prefix: &Path,
475 id: NodeId,
dfeec247 476 vis: &mut hir::Visibility<'hir>,
416331ca 477 ident: &mut Ident,
dfeec247
XL
478 attrs: &'hir [Attribute],
479 ) -> hir::ItemKind<'hir> {
416331ca
XL
480 debug!("lower_use_tree(tree={:?})", tree);
481 debug!("lower_use_tree: vis = {:?}", vis);
482
483 let path = &tree.prefix;
dfeec247 484 let segments = prefix.segments.iter().chain(path.segments.iter()).cloned().collect();
416331ca
XL
485
486 match tree.kind {
487 UseTreeKind::Simple(rename, id1, id2) => {
488 *ident = tree.ident();
489
490 // First, apply the prefix to the path.
1b1a35ee 491 let mut path = Path { segments, span: path.span, tokens: None };
416331ca
XL
492
493 // Correctly resolve `self` imports.
494 if path.segments.len() > 1
495 && path.segments.last().unwrap().ident.name == kw::SelfLower
496 {
497 let _ = path.segments.pop();
498 if rename.is_none() {
499 *ident = path.segments.last().unwrap().ident;
500 }
501 }
502
503 let mut resolutions = self.expect_full_res_from_use(id);
504 // We want to return *something* from this function, so hold onto the first item
505 // for later.
506 let ret_res = self.lower_res(resolutions.next().unwrap_or(Res::Err));
507
508 // Here, we are looping over namespaces, if they exist for the definition
509 // being imported. We only handle type and value namespaces because we
510 // won't be dealing with macros in the rest of the compiler.
511 // Essentially a single `use` which imports two names is desugared into
512 // two imports.
513 for (res, &new_node_id) in resolutions.zip([id1, id2].iter()) {
514 let ident = *ident;
515 let mut path = path.clone();
516 for seg in &mut path.segments {
60c5eb7d 517 seg.id = self.resolver.next_node_id();
416331ca
XL
518 }
519 let span = path.span;
520
521 self.with_hir_id_owner(new_node_id, |this| {
522 let new_id = this.lower_node_id(new_node_id);
523 let res = this.lower_res(res);
dfeec247
XL
524 let path = this.lower_path_extra(res, &path, ParamMode::Explicit, None);
525 let kind = hir::ItemKind::Use(path, hir::UseKind::Single);
416331ca
XL
526 let vis = this.rebuild_vis(&vis);
527
dfeec247
XL
528 this.insert_item(hir::Item {
529 hir_id: new_id,
530 ident,
531 attrs,
532 kind,
533 vis,
534 span,
535 });
416331ca
XL
536 });
537 }
538
dfeec247 539 let path = self.lower_path_extra(ret_res, &path, ParamMode::Explicit, None);
416331ca
XL
540 hir::ItemKind::Use(path, hir::UseKind::Single)
541 }
542 UseTreeKind::Glob => {
1b1a35ee
XL
543 let path = self.lower_path(
544 id,
545 &Path { segments, span: path.span, tokens: None },
546 ParamMode::Explicit,
547 );
416331ca
XL
548 hir::ItemKind::Use(path, hir::UseKind::Glob)
549 }
550 UseTreeKind::Nested(ref trees) => {
551 // Nested imports are desugared into simple imports.
552 // So, if we start with
553 //
554 // ```
555 // pub(x) use foo::{a, b};
556 // ```
557 //
558 // we will create three items:
559 //
560 // ```
561 // pub(x) use foo::a;
562 // pub(x) use foo::b;
563 // pub(x) use foo::{}; // <-- this is called the `ListStem`
564 // ```
565 //
566 // The first two are produced by recursively invoking
567 // `lower_use_tree` (and indeed there may be things
568 // like `use foo::{a::{b, c}}` and so forth). They
569 // wind up being directly added to
570 // `self.items`. However, the structure of this
571 // function also requires us to return one item, and
572 // for that we return the `{}` import (called the
573 // `ListStem`).
574
1b1a35ee 575 let prefix = Path { segments, span: prefix.span.to(path.span), tokens: None };
416331ca
XL
576
577 // Add all the nested `PathListItem`s to the HIR.
578 for &(ref use_tree, id) in trees {
579 let new_hir_id = self.lower_node_id(id);
580
581 let mut prefix = prefix.clone();
582
583 // Give the segments new node-ids since they are being cloned.
584 for seg in &mut prefix.segments {
60c5eb7d 585 seg.id = self.resolver.next_node_id();
416331ca
XL
586 }
587
588 // Each `use` import is an item and thus are owners of the
589 // names in the path. Up to this point the nested import is
590 // the current owner, since we want each desugared import to
591 // own its own names, we have to adjust the owner before
592 // lowering the rest of the import.
593 self.with_hir_id_owner(id, |this| {
594 let mut vis = this.rebuild_vis(&vis);
595 let mut ident = *ident;
596
dfeec247
XL
597 let kind =
598 this.lower_use_tree(use_tree, &prefix, id, &mut vis, &mut ident, attrs);
599
600 this.insert_item(hir::Item {
601 hir_id: new_hir_id,
602 ident,
603 attrs,
604 kind,
605 vis,
606 span: use_tree.span,
607 });
416331ca
XL
608 });
609 }
610
611 // Subtle and a bit hacky: we lower the privacy level
612 // of the list stem to "private" most of the time, but
613 // not for "restricted" paths. The key thing is that
614 // we don't want it to stay as `pub` (with no caveats)
615 // because that affects rustdoc and also the lints
616 // about `pub` items. But we can't *always* make it
617 // private -- particularly not for restricted paths --
618 // because it contains node-ids that would then be
619 // unused, failing the check that HirIds are "densely
620 // assigned".
621 match vis.node {
dfeec247
XL
622 hir::VisibilityKind::Public
623 | hir::VisibilityKind::Crate(_)
624 | hir::VisibilityKind::Inherited => {
416331ca
XL
625 *vis = respan(prefix.span.shrink_to_lo(), hir::VisibilityKind::Inherited);
626 }
627 hir::VisibilityKind::Restricted { .. } => {
628 // Do nothing here, as described in the comment on the match.
629 }
630 }
631
632 let res = self.expect_full_res_from_use(id).next().unwrap_or(Res::Err);
633 let res = self.lower_res(res);
dfeec247 634 let path = self.lower_path_extra(res, &prefix, ParamMode::Explicit, None);
416331ca
XL
635 hir::ItemKind::Use(path, hir::UseKind::ListStem)
636 }
637 }
638 }
639
640 /// Paths like the visibility path in `pub(super) use foo::{bar, baz}` are repeated
641 /// many times in the HIR tree; for each occurrence, we need to assign distinct
642 /// `NodeId`s. (See, e.g., #56128.)
dfeec247 643 fn rebuild_use_path(&mut self, path: &hir::Path<'hir>) -> &'hir hir::Path<'hir> {
416331ca 644 debug!("rebuild_use_path(path = {:?})", path);
dfeec247
XL
645 let segments =
646 self.arena.alloc_from_iter(path.segments.iter().map(|seg| hir::PathSegment {
647 ident: seg.ident,
648 hir_id: seg.hir_id.map(|_| self.next_id()),
649 res: seg.res,
650 args: None,
651 infer_args: seg.infer_args,
652 }));
653 self.arena.alloc(hir::Path { span: path.span, res: path.res, segments })
416331ca
XL
654 }
655
dfeec247 656 fn rebuild_vis(&mut self, vis: &hir::Visibility<'hir>) -> hir::Visibility<'hir> {
416331ca
XL
657 let vis_kind = match vis.node {
658 hir::VisibilityKind::Public => hir::VisibilityKind::Public,
659 hir::VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
660 hir::VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
661 hir::VisibilityKind::Restricted { ref path, hir_id: _ } => {
662 hir::VisibilityKind::Restricted {
dfeec247 663 path: self.rebuild_use_path(path),
416331ca
XL
664 hir_id: self.next_id(),
665 }
666 }
667 };
668 respan(vis.span, vis_kind)
669 }
670
dfeec247 671 fn lower_foreign_item(&mut self, i: &ForeignItem) -> hir::ForeignItem<'hir> {
f035d41b 672 let def_id = self.resolver.local_def_id(i.id);
416331ca
XL
673 hir::ForeignItem {
674 hir_id: self.lower_node_id(i.id),
675 ident: i.ident,
676 attrs: self.lower_attrs(&i.attrs),
e74abb32 677 kind: match i.kind {
74b04a01
XL
678 ForeignItemKind::Fn(_, ref sig, ref generics, _) => {
679 let fdec = &sig.decl;
416331ca
XL
680 let (generics, (fn_dec, fn_args)) = self.add_in_band_defs(
681 generics,
682 def_id,
683 AnonymousLifetimeMode::PassThrough,
684 |this, _| {
685 (
e1599b0c 686 // Disallow `impl Trait` in foreign items.
416331ca 687 this.lower_fn_decl(fdec, None, false, None),
e1599b0c 688 this.lower_fn_params_to_names(fdec),
416331ca
XL
689 )
690 },
691 );
692
693 hir::ForeignItemKind::Fn(fn_dec, fn_args, generics)
694 }
74b04a01 695 ForeignItemKind::Static(ref t, m, _) => {
dfeec247
XL
696 let ty = self.lower_ty(t, ImplTraitContext::disallowed());
697 hir::ForeignItemKind::Static(ty, m)
416331ca 698 }
74b04a01 699 ForeignItemKind::TyAlias(..) => hir::ForeignItemKind::Type,
ba9703b0 700 ForeignItemKind::MacCall(_) => panic!("macro shouldn't exist here"),
416331ca
XL
701 },
702 vis: self.lower_visibility(&i.vis, None),
703 span: i.span,
704 }
705 }
706
dfeec247 707 fn lower_foreign_mod(&mut self, fm: &ForeignMod) -> hir::ForeignMod<'hir> {
416331ca 708 hir::ForeignMod {
60c5eb7d 709 abi: fm.abi.map_or(abi::Abi::C, |abi| self.lower_abi(abi)),
dfeec247 710 items: self.arena.alloc_from_iter(fm.items.iter().map(|x| self.lower_foreign_item(x))),
416331ca
XL
711 }
712 }
713
dfeec247
XL
714 fn lower_global_asm(&mut self, ga: &GlobalAsm) -> &'hir hir::GlobalAsm {
715 self.arena.alloc(hir::GlobalAsm { asm: ga.asm })
416331ca
XL
716 }
717
dfeec247 718 fn lower_variant(&mut self, v: &Variant) -> hir::Variant<'hir> {
e1599b0c
XL
719 hir::Variant {
720 attrs: self.lower_attrs(&v.attrs),
721 data: self.lower_variant_data(&v.data),
722 disr_expr: v.disr_expr.as_ref().map(|e| self.lower_anon_const(e)),
723 id: self.lower_node_id(v.id),
724 ident: v.ident,
416331ca
XL
725 span: v.span,
726 }
727 }
728
dfeec247 729 fn lower_variant_data(&mut self, vdata: &VariantData) -> hir::VariantData<'hir> {
416331ca
XL
730 match *vdata {
731 VariantData::Struct(ref fields, recovered) => hir::VariantData::Struct(
dfeec247
XL
732 self.arena
733 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
416331ca
XL
734 recovered,
735 ),
dfeec247
XL
736 VariantData::Tuple(ref fields, id) => hir::VariantData::Tuple(
737 self.arena
738 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
739 self.lower_node_id(id),
740 ),
741 VariantData::Unit(id) => hir::VariantData::Unit(self.lower_node_id(id)),
416331ca
XL
742 }
743 }
744
dfeec247 745 fn lower_struct_field(&mut self, (index, f): (usize, &StructField)) -> hir::StructField<'hir> {
e74abb32 746 let ty = if let TyKind::Path(ref qself, ref path) = f.ty.kind {
416331ca
XL
747 let t = self.lower_path_ty(
748 &f.ty,
749 qself,
750 path,
751 ParamMode::ExplicitNamed, // no `'_` in declarations (Issue #61124)
dfeec247 752 ImplTraitContext::disallowed(),
416331ca 753 );
dfeec247 754 self.arena.alloc(t)
416331ca
XL
755 } else {
756 self.lower_ty(&f.ty, ImplTraitContext::disallowed())
757 };
758 hir::StructField {
759 span: f.span,
760 hir_id: self.lower_node_id(f.id),
761 ident: match f.ident {
762 Some(ident) => ident,
763 // FIXME(jseyfried): positional field hygiene.
764 None => Ident::new(sym::integer(index), f.span),
765 },
766 vis: self.lower_visibility(&f.vis, None),
767 ty,
768 attrs: self.lower_attrs(&f.attrs),
769 }
770 }
771
dfeec247 772 fn lower_trait_item(&mut self, i: &AssocItem) -> hir::TraitItem<'hir> {
f035d41b 773 let trait_item_def_id = self.resolver.local_def_id(i.id);
416331ca 774
e74abb32 775 let (generics, kind) = match i.kind {
74b04a01 776 AssocItemKind::Const(_, ref ty, ref default) => {
dfeec247 777 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
74b04a01
XL
778 let body = default.as_ref().map(|x| self.lower_const_body(i.span, Some(x)));
779 (hir::Generics::empty(), hir::TraitItemKind::Const(ty, body))
dfeec247 780 }
74b04a01 781 AssocItemKind::Fn(_, ref sig, ref generics, None) => {
e1599b0c 782 let names = self.lower_fn_params_to_names(&sig.decl);
dfeec247 783 let (generics, sig) =
74b04a01 784 self.lower_method_sig(generics, sig, trait_item_def_id, false, None);
ba9703b0 785 (generics, hir::TraitItemKind::Fn(sig, hir::TraitFn::Required(names)))
416331ca 786 }
74b04a01 787 AssocItemKind::Fn(_, ref sig, ref generics, Some(ref body)) => {
dfeec247
XL
788 let body_id = self.lower_fn_body_block(i.span, &sig.decl, Some(body));
789 let (generics, sig) =
74b04a01 790 self.lower_method_sig(generics, sig, trait_item_def_id, false, None);
ba9703b0 791 (generics, hir::TraitItemKind::Fn(sig, hir::TraitFn::Provided(body_id)))
416331ca 792 }
74b04a01 793 AssocItemKind::TyAlias(_, ref generics, ref bounds, ref default) => {
dfeec247 794 let ty = default.as_ref().map(|x| self.lower_ty(x, ImplTraitContext::disallowed()));
74b04a01 795 let generics = self.lower_generics(generics, ImplTraitContext::disallowed());
e74abb32 796 let kind = hir::TraitItemKind::Type(
416331ca 797 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
dfeec247 798 ty,
416331ca
XL
799 );
800
e74abb32 801 (generics, kind)
dfeec247 802 }
ba9703b0 803 AssocItemKind::MacCall(..) => panic!("macro item shouldn't exist at this point"),
416331ca
XL
804 };
805
806 hir::TraitItem {
807 hir_id: self.lower_node_id(i.id),
808 ident: i.ident,
809 attrs: self.lower_attrs(&i.attrs),
810 generics,
e74abb32 811 kind,
416331ca
XL
812 span: i.span,
813 }
814 }
815
dfeec247 816 fn lower_trait_item_ref(&mut self, i: &AssocItem) -> hir::TraitItemRef {
74b04a01
XL
817 let (kind, has_default) = match &i.kind {
818 AssocItemKind::Const(_, _, default) => (hir::AssocItemKind::Const, default.is_some()),
819 AssocItemKind::TyAlias(_, _, _, default) => {
820 (hir::AssocItemKind::Type, default.is_some())
821 }
822 AssocItemKind::Fn(_, sig, _, default) => {
ba9703b0 823 (hir::AssocItemKind::Fn { has_self: sig.decl.has_self() }, default.is_some())
416331ca 824 }
ba9703b0 825 AssocItemKind::MacCall(..) => unimplemented!(),
416331ca 826 };
74b04a01
XL
827 let id = hir::TraitItemId { hir_id: self.lower_node_id(i.id) };
828 let defaultness = hir::Defaultness::Default { has_value: has_default };
829 hir::TraitItemRef { id, ident: i.ident, span: i.span, defaultness, kind }
416331ca
XL
830 }
831
dfeec247 832 /// Construct `ExprKind::Err` for the given `span`.
ba9703b0 833 crate fn expr_err(&mut self, span: Span) -> hir::Expr<'hir> {
dfeec247
XL
834 self.expr(span, hir::ExprKind::Err, AttrVec::new())
835 }
836
837 fn lower_impl_item(&mut self, i: &AssocItem) -> hir::ImplItem<'hir> {
f035d41b 838 let impl_item_def_id = self.resolver.local_def_id(i.id);
416331ca 839
74b04a01
XL
840 let (generics, kind) = match &i.kind {
841 AssocItemKind::Const(_, ty, expr) => {
dfeec247
XL
842 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
843 (
74b04a01 844 hir::Generics::empty(),
dfeec247
XL
845 hir::ImplItemKind::Const(ty, self.lower_const_body(i.span, expr.as_deref())),
846 )
847 }
74b04a01 848 AssocItemKind::Fn(_, sig, generics, body) => {
416331ca 849 self.current_item = Some(i.span);
74b04a01
XL
850 let asyncness = sig.header.asyncness;
851 let body_id =
852 self.lower_maybe_async_body(i.span, &sig.decl, asyncness, body.as_deref());
416331ca
XL
853 let impl_trait_return_allow = !self.is_in_trait_impl;
854 let (generics, sig) = self.lower_method_sig(
74b04a01 855 generics,
416331ca
XL
856 sig,
857 impl_item_def_id,
858 impl_trait_return_allow,
74b04a01 859 asyncness.opt_return_id(),
416331ca
XL
860 );
861
ba9703b0 862 (generics, hir::ImplItemKind::Fn(sig, body_id))
416331ca 863 }
74b04a01
XL
864 AssocItemKind::TyAlias(_, generics, _, ty) => {
865 let generics = self.lower_generics(generics, ImplTraitContext::disallowed());
dfeec247 866 let kind = match ty {
60c5eb7d 867 None => {
dfeec247 868 let ty = self.arena.alloc(self.ty(i.span, hir::TyKind::Err));
60c5eb7d
XL
869 hir::ImplItemKind::TyAlias(ty)
870 }
f035d41b
XL
871 Some(ty) => {
872 let ty = self.lower_ty(
873 ty,
874 ImplTraitContext::OtherOpaqueTy {
875 capturable_lifetimes: &mut FxHashSet::default(),
876 origin: hir::OpaqueTyOrigin::Misc,
877 },
878 );
879 hir::ImplItemKind::TyAlias(ty)
880 }
60c5eb7d
XL
881 };
882 (generics, kind)
dfeec247 883 }
ba9703b0 884 AssocItemKind::MacCall(..) => panic!("`TyMac` should have been expanded by now"),
416331ca
XL
885 };
886
ba9703b0
XL
887 // Since `default impl` is not yet implemented, this is always true in impls.
888 let has_value = true;
889 let (defaultness, _) = self.lower_defaultness(i.kind.defaultness(), has_value);
416331ca
XL
890 hir::ImplItem {
891 hir_id: self.lower_node_id(i.id),
892 ident: i.ident,
893 attrs: self.lower_attrs(&i.attrs),
894 generics,
895 vis: self.lower_visibility(&i.vis, None),
ba9703b0 896 defaultness,
e74abb32 897 kind,
416331ca
XL
898 span: i.span,
899 }
416331ca
XL
900 }
901
dfeec247 902 fn lower_impl_item_ref(&mut self, i: &AssocItem) -> hir::ImplItemRef<'hir> {
ba9703b0
XL
903 // Since `default impl` is not yet implemented, this is always true in impls.
904 let has_value = true;
905 let (defaultness, _) = self.lower_defaultness(i.kind.defaultness(), has_value);
416331ca
XL
906 hir::ImplItemRef {
907 id: hir::ImplItemId { hir_id: self.lower_node_id(i.id) },
908 ident: i.ident,
909 span: i.span,
910 vis: self.lower_visibility(&i.vis, Some(i.id)),
ba9703b0 911 defaultness,
60c5eb7d 912 kind: match &i.kind {
dfeec247 913 AssocItemKind::Const(..) => hir::AssocItemKind::Const,
f035d41b 914 AssocItemKind::TyAlias(..) => hir::AssocItemKind::Type,
74b04a01 915 AssocItemKind::Fn(_, sig, ..) => {
ba9703b0 916 hir::AssocItemKind::Fn { has_self: sig.decl.has_self() }
dfeec247 917 }
ba9703b0 918 AssocItemKind::MacCall(..) => unimplemented!(),
416331ca
XL
919 },
920 }
416331ca
XL
921 }
922
923 /// If an `explicit_owner` is given, this method allocates the `HirId` in
924 /// the address space of that item instead of the item currently being
925 /// lowered. This can happen during `lower_impl_item_ref()` where we need to
926 /// lower a `Visibility` value although we haven't lowered the owning
927 /// `ImplItem` in question yet.
928 fn lower_visibility(
929 &mut self,
930 v: &Visibility,
931 explicit_owner: Option<NodeId>,
dfeec247 932 ) -> hir::Visibility<'hir> {
1b1a35ee 933 let node = match v.kind {
416331ca
XL
934 VisibilityKind::Public => hir::VisibilityKind::Public,
935 VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
936 VisibilityKind::Restricted { ref path, id } => {
937 debug!("lower_visibility: restricted path id = {:?}", id);
938 let lowered_id = if let Some(owner) = explicit_owner {
939 self.lower_node_id_with_owner(id, owner)
940 } else {
941 self.lower_node_id(id)
942 };
943 let res = self.expect_full_res(id);
944 let res = self.lower_res(res);
945 hir::VisibilityKind::Restricted {
dfeec247 946 path: self.lower_path_extra(res, path, ParamMode::Explicit, explicit_owner),
416331ca
XL
947 hir_id: lowered_id,
948 }
dfeec247 949 }
416331ca
XL
950 VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
951 };
952 respan(v.span, node)
953 }
954
ba9703b0
XL
955 fn lower_defaultness(
956 &self,
957 d: Defaultness,
958 has_value: bool,
959 ) -> (hir::Defaultness, Option<Span>) {
416331ca 960 match d {
ba9703b0 961 Defaultness::Default(sp) => (hir::Defaultness::Default { has_value }, Some(sp)),
416331ca
XL
962 Defaultness::Final => {
963 assert!(has_value);
ba9703b0 964 (hir::Defaultness::Final, None)
416331ca
XL
965 }
966 }
967 }
968
dfeec247
XL
969 fn record_body(
970 &mut self,
971 params: &'hir [hir::Param<'hir>],
972 value: hir::Expr<'hir>,
973 ) -> hir::BodyId {
974 let body = hir::Body { generator_kind: self.generator_kind, params, value };
416331ca
XL
975 let id = body.id();
976 self.bodies.insert(id, body);
977 id
978 }
979
ba9703b0 980 pub(super) fn lower_body(
416331ca 981 &mut self,
dfeec247 982 f: impl FnOnce(&mut Self) -> (&'hir [hir::Param<'hir>], hir::Expr<'hir>),
416331ca
XL
983 ) -> hir::BodyId {
984 let prev_gen_kind = self.generator_kind.take();
ba9703b0 985 let task_context = self.task_context.take();
e1599b0c
XL
986 let (parameters, result) = f(self);
987 let body_id = self.record_body(parameters, result);
ba9703b0 988 self.task_context = task_context;
416331ca
XL
989 self.generator_kind = prev_gen_kind;
990 body_id
991 }
992
dfeec247 993 fn lower_param(&mut self, param: &Param) -> hir::Param<'hir> {
e1599b0c
XL
994 hir::Param {
995 attrs: self.lower_attrs(&param.attrs),
996 hir_id: self.lower_node_id(param.id),
997 pat: self.lower_pat(&param.pat),
3dfed10e 998 ty_span: param.ty.span,
e1599b0c 999 span: param.span,
416331ca
XL
1000 }
1001 }
1002
1003 pub(super) fn lower_fn_body(
1004 &mut self,
1005 decl: &FnDecl,
dfeec247 1006 body: impl FnOnce(&mut Self) -> hir::Expr<'hir>,
416331ca 1007 ) -> hir::BodyId {
dfeec247
XL
1008 self.lower_body(|this| {
1009 (
1010 this.arena.alloc_from_iter(decl.inputs.iter().map(|x| this.lower_param(x))),
1011 body(this),
1012 )
1013 })
416331ca
XL
1014 }
1015
dfeec247
XL
1016 fn lower_fn_body_block(
1017 &mut self,
1018 span: Span,
1019 decl: &FnDecl,
1020 body: Option<&Block>,
1021 ) -> hir::BodyId {
1022 self.lower_fn_body(decl, |this| this.lower_block_expr_opt(span, body))
416331ca
XL
1023 }
1024
dfeec247
XL
1025 fn lower_block_expr_opt(&mut self, span: Span, block: Option<&Block>) -> hir::Expr<'hir> {
1026 match block {
1027 Some(block) => self.lower_block_expr(block),
1028 None => self.expr_err(span),
1029 }
1030 }
1031
1032 pub(super) fn lower_const_body(&mut self, span: Span, expr: Option<&Expr>) -> hir::BodyId {
1033 self.lower_body(|this| {
1034 (
1035 &[],
1036 match expr {
1037 Some(expr) => this.lower_expr_mut(expr),
1038 None => this.expr_err(span),
1039 },
1040 )
1041 })
416331ca
XL
1042 }
1043
1044 fn lower_maybe_async_body(
1045 &mut self,
dfeec247 1046 span: Span,
416331ca 1047 decl: &FnDecl,
74b04a01 1048 asyncness: Async,
dfeec247 1049 body: Option<&Block>,
416331ca
XL
1050 ) -> hir::BodyId {
1051 let closure_id = match asyncness {
74b04a01
XL
1052 Async::Yes { closure_id, .. } => closure_id,
1053 Async::No => return self.lower_fn_body_block(span, decl, body),
416331ca
XL
1054 };
1055
1056 self.lower_body(|this| {
dfeec247
XL
1057 let mut parameters: Vec<hir::Param<'_>> = Vec::new();
1058 let mut statements: Vec<hir::Stmt<'_>> = Vec::new();
416331ca 1059
e1599b0c 1060 // Async function parameters are lowered into the closure body so that they are
416331ca
XL
1061 // captured and so that the drop order matches the equivalent non-async functions.
1062 //
1063 // from:
1064 //
1065 // async fn foo(<pattern>: <ty>, <pattern>: <ty>, <pattern>: <ty>) {
e1599b0c 1066 // <body>
416331ca
XL
1067 // }
1068 //
1069 // into:
1070 //
1071 // fn foo(__arg0: <ty>, __arg1: <ty>, __arg2: <ty>) {
1072 // async move {
1073 // let __arg2 = __arg2;
1074 // let <pattern> = __arg2;
1075 // let __arg1 = __arg1;
1076 // let <pattern> = __arg1;
1077 // let __arg0 = __arg0;
1078 // let <pattern> = __arg0;
e1599b0c 1079 // drop-temps { <body> } // see comments later in fn for details
416331ca
XL
1080 // }
1081 // }
1082 //
1083 // If `<pattern>` is a simple ident, then it is lowered to a single
1084 // `let <pattern> = <pattern>;` statement as an optimization.
e1599b0c
XL
1085 //
1086 // Note that the body is embedded in `drop-temps`; an
1087 // equivalent desugaring would be `return { <body>
1088 // };`. The key point is that we wish to drop all the
1089 // let-bound variables and temporaries created in the body
1090 // (and its tail expression!) before we drop the
1091 // parameters (c.f. rust-lang/rust#64512).
1092 for (index, parameter) in decl.inputs.iter().enumerate() {
1093 let parameter = this.lower_param(parameter);
1094 let span = parameter.pat.span;
416331ca
XL
1095
1096 // Check if this is a binding pattern, if so, we can optimize and avoid adding a
e1599b0c 1097 // `let <pat> = __argN;` statement. In this case, we do not rename the parameter.
e74abb32 1098 let (ident, is_simple_parameter) = match parameter.pat.kind {
29967ef6
XL
1099 hir::PatKind::Binding(
1100 hir::BindingAnnotation::Unannotated | hir::BindingAnnotation::Mutable,
1101 _,
1102 ident,
1103 _,
1104 ) => (ident, true),
1105 // For `ref mut` or wildcard arguments, we can't reuse the binding, but
1106 // we can keep the same name for the parameter.
1107 // This lets rustdoc render it correctly in documentation.
1108 hir::PatKind::Binding(_, _, ident, _) => (ident, false),
1109 hir::PatKind::Wild => {
1110 (Ident::with_dummy_span(rustc_span::symbol::kw::Underscore), false)
dfeec247 1111 }
416331ca
XL
1112 _ => {
1113 // Replace the ident for bindings that aren't simple.
1114 let name = format!("__arg{}", index);
1115 let ident = Ident::from_str(&name);
1116
1117 (ident, false)
dfeec247 1118 }
416331ca
XL
1119 };
1120
dfeec247 1121 let desugared_span = this.mark_span_with_reason(DesugaringKind::Async, span, None);
416331ca 1122
e1599b0c 1123 // Construct a parameter representing `__argN: <ty>` to replace the parameter of the
416331ca
XL
1124 // async function.
1125 //
e1599b0c
XL
1126 // If this is the simple case, this parameter will end up being the same as the
1127 // original parameter, but with a different pattern id.
dfeec247 1128 let mut stmt_attrs = AttrVec::new();
e1599b0c
XL
1129 stmt_attrs.extend(parameter.attrs.iter().cloned());
1130 let (new_parameter_pat, new_parameter_id) = this.pat_ident(desugared_span, ident);
1131 let new_parameter = hir::Param {
1132 attrs: parameter.attrs,
1133 hir_id: parameter.hir_id,
1134 pat: new_parameter_pat,
3dfed10e 1135 ty_span: parameter.ty_span,
e1599b0c 1136 span: parameter.span,
416331ca
XL
1137 };
1138
e1599b0c 1139 if is_simple_parameter {
416331ca
XL
1140 // If this is the simple case, then we only insert one statement that is
1141 // `let <pat> = <pat>;`. We re-use the original argument's pattern so that
1142 // `HirId`s are densely assigned.
e1599b0c 1143 let expr = this.expr_ident(desugared_span, ident, new_parameter_id);
416331ca
XL
1144 let stmt = this.stmt_let_pat(
1145 stmt_attrs,
1146 desugared_span,
dfeec247 1147 Some(expr),
e1599b0c 1148 parameter.pat,
dfeec247 1149 hir::LocalSource::AsyncFn,
416331ca
XL
1150 );
1151 statements.push(stmt);
1152 } else {
1153 // If this is not the simple case, then we construct two statements:
1154 //
1155 // ```
1156 // let __argN = __argN;
1157 // let <pat> = __argN;
1158 // ```
1159 //
e1599b0c 1160 // The first statement moves the parameter into the closure and thus ensures
416331ca
XL
1161 // that the drop order is correct.
1162 //
1163 // The second statement creates the bindings that the user wrote.
1164
1165 // Construct the `let mut __argN = __argN;` statement. It must be a mut binding
1166 // because the user may have specified a `ref mut` binding in the next
1167 // statement.
1168 let (move_pat, move_id) = this.pat_ident_binding_mode(
dfeec247
XL
1169 desugared_span,
1170 ident,
1171 hir::BindingAnnotation::Mutable,
1172 );
e1599b0c 1173 let move_expr = this.expr_ident(desugared_span, ident, new_parameter_id);
416331ca 1174 let move_stmt = this.stmt_let_pat(
dfeec247 1175 AttrVec::new(),
416331ca 1176 desugared_span,
dfeec247 1177 Some(move_expr),
416331ca 1178 move_pat,
dfeec247 1179 hir::LocalSource::AsyncFn,
416331ca
XL
1180 );
1181
1182 // Construct the `let <pat> = __argN;` statement. We re-use the original
e1599b0c 1183 // parameter's pattern so that `HirId`s are densely assigned.
416331ca
XL
1184 let pattern_expr = this.expr_ident(desugared_span, ident, move_id);
1185 let pattern_stmt = this.stmt_let_pat(
1186 stmt_attrs,
1187 desugared_span,
dfeec247 1188 Some(pattern_expr),
e1599b0c 1189 parameter.pat,
dfeec247 1190 hir::LocalSource::AsyncFn,
416331ca
XL
1191 );
1192
1193 statements.push(move_stmt);
1194 statements.push(pattern_stmt);
1195 };
1196
e1599b0c 1197 parameters.push(new_parameter);
416331ca
XL
1198 }
1199
dfeec247 1200 let body_span = body.map_or(span, |b| b.span);
416331ca 1201 let async_expr = this.make_async_expr(
e74abb32
XL
1202 CaptureBy::Value,
1203 closure_id,
1204 None,
dfeec247 1205 body_span,
e74abb32 1206 hir::AsyncGeneratorKind::Fn,
416331ca 1207 |this| {
e1599b0c 1208 // Create a block from the user's function body:
dfeec247 1209 let user_body = this.lower_block_expr_opt(body_span, body);
e1599b0c
XL
1210
1211 // Transform into `drop-temps { <user-body> }`, an expression:
dfeec247
XL
1212 let desugared_span =
1213 this.mark_span_with_reason(DesugaringKind::Async, user_body.span, None);
e1599b0c
XL
1214 let user_body = this.expr_drop_temps(
1215 desugared_span,
dfeec247
XL
1216 this.arena.alloc(user_body),
1217 AttrVec::new(),
e1599b0c
XL
1218 );
1219
1220 // As noted above, create the final block like
1221 //
1222 // ```
1223 // {
1224 // let $param_pattern = $raw_param;
1225 // ...
1226 // drop-temps { <user-body> }
1227 // }
1228 // ```
1229 let body = this.block_all(
1230 desugared_span,
dfeec247
XL
1231 this.arena.alloc_from_iter(statements),
1232 Some(user_body),
e1599b0c 1233 );
dfeec247
XL
1234
1235 this.expr_block(body, AttrVec::new())
1236 },
1237 );
1238
1239 (
1240 this.arena.alloc_from_iter(parameters),
1241 this.expr(body_span, async_expr, AttrVec::new()),
1242 )
416331ca
XL
1243 })
1244 }
1245
1246 fn lower_method_sig(
1247 &mut self,
1248 generics: &Generics,
60c5eb7d 1249 sig: &FnSig,
ba9703b0 1250 fn_def_id: LocalDefId,
416331ca
XL
1251 impl_trait_return_allow: bool,
1252 is_async: Option<NodeId>,
dfeec247 1253 ) -> (hir::Generics<'hir>, hir::FnSig<'hir>) {
416331ca
XL
1254 let header = self.lower_fn_header(sig.header);
1255 let (generics, decl) = self.add_in_band_defs(
1256 generics,
1257 fn_def_id,
1258 AnonymousLifetimeMode::PassThrough,
dfeec247
XL
1259 |this, idty| {
1260 this.lower_fn_decl(
1261 &sig.decl,
ba9703b0 1262 Some((fn_def_id.to_def_id(), idty)),
dfeec247
XL
1263 impl_trait_return_allow,
1264 is_async,
1265 )
1266 },
416331ca 1267 );
3dfed10e 1268 (generics, hir::FnSig { header, decl, span: sig.span })
416331ca
XL
1269 }
1270
1271 fn lower_fn_header(&mut self, h: FnHeader) -> hir::FnHeader {
1272 hir::FnHeader {
74b04a01
XL
1273 unsafety: self.lower_unsafety(h.unsafety),
1274 asyncness: self.lower_asyncness(h.asyncness),
1275 constness: self.lower_constness(h.constness),
60c5eb7d 1276 abi: self.lower_extern(h.ext),
416331ca
XL
1277 }
1278 }
1279
60c5eb7d
XL
1280 pub(super) fn lower_abi(&mut self, abi: StrLit) -> abi::Abi {
1281 abi::lookup(&abi.symbol_unescaped.as_str()).unwrap_or_else(|| {
1282 self.error_on_invalid_abi(abi);
1283 abi::Abi::Rust
1284 })
416331ca
XL
1285 }
1286
60c5eb7d
XL
1287 pub(super) fn lower_extern(&mut self, ext: Extern) -> abi::Abi {
1288 match ext {
1289 Extern::None => abi::Abi::Rust,
1290 Extern::Implicit => abi::Abi::C,
1291 Extern::Explicit(abi) => self.lower_abi(abi),
416331ca
XL
1292 }
1293 }
1294
60c5eb7d 1295 fn error_on_invalid_abi(&self, abi: StrLit) {
dfeec247
XL
1296 struct_span_err!(self.sess, abi.span, E0703, "invalid ABI: found `{}`", abi.symbol)
1297 .span_label(abi.span, "invalid ABI")
1298 .help(&format!("valid ABIs: {}", abi::all_names().join(", ")))
1299 .emit();
60c5eb7d
XL
1300 }
1301
74b04a01 1302 fn lower_asyncness(&mut self, a: Async) -> hir::IsAsync {
416331ca 1303 match a {
74b04a01
XL
1304 Async::Yes { .. } => hir::IsAsync::Async,
1305 Async::No => hir::IsAsync::NotAsync,
1306 }
1307 }
1308
1309 fn lower_constness(&mut self, c: Const) -> hir::Constness {
1310 match c {
1311 Const::Yes(_) => hir::Constness::Const,
1312 Const::No => hir::Constness::NotConst,
1313 }
1314 }
1315
1316 pub(super) fn lower_unsafety(&mut self, u: Unsafe) -> hir::Unsafety {
1317 match u {
1318 Unsafe::Yes(_) => hir::Unsafety::Unsafe,
1319 Unsafe::No => hir::Unsafety::Normal,
416331ca
XL
1320 }
1321 }
1322
dfeec247 1323 pub(super) fn lower_generics_mut(
416331ca
XL
1324 &mut self,
1325 generics: &Generics,
dfeec247
XL
1326 itctx: ImplTraitContext<'_, 'hir>,
1327 ) -> GenericsCtor<'hir> {
416331ca
XL
1328 // Collect `?Trait` bounds in where clause and move them to parameter definitions.
1329 // FIXME: this could probably be done with less rightward drift. It also looks like two
1330 // control paths where `report_error` is called are the only paths that advance to after the
1331 // match statement, so the error reporting could probably just be moved there.
1332 let mut add_bounds: NodeMap<Vec<_>> = Default::default();
1333 for pred in &generics.where_clause.predicates {
1334 if let WherePredicate::BoundPredicate(ref bound_pred) = *pred {
1335 'next_bound: for bound in &bound_pred.bounds {
1336 if let GenericBound::Trait(_, TraitBoundModifier::Maybe) = *bound {
1337 let report_error = |this: &mut Self| {
1338 this.diagnostic().span_err(
1339 bound_pred.bounded_ty.span,
1340 "`?Trait` bounds are only permitted at the \
1341 point where a type parameter is declared",
1342 );
1343 };
1344 // Check if the where clause type is a plain type parameter.
e74abb32 1345 match bound_pred.bounded_ty.kind {
416331ca
XL
1346 TyKind::Path(None, ref path)
1347 if path.segments.len() == 1
1348 && bound_pred.bound_generic_params.is_empty() =>
1349 {
dfeec247
XL
1350 if let Some(Res::Def(DefKind::TyParam, def_id)) = self
1351 .resolver
416331ca
XL
1352 .get_partial_res(bound_pred.bounded_ty.id)
1353 .map(|d| d.base_res())
1354 {
f9f354fc 1355 if let Some(def_id) = def_id.as_local() {
416331ca 1356 for param in &generics.params {
ba9703b0 1357 if let GenericParamKind::Type { .. } = param.kind {
f035d41b 1358 if def_id == self.resolver.local_def_id(param.id) {
ba9703b0
XL
1359 add_bounds
1360 .entry(param.id)
1361 .or_default()
1362 .push(bound.clone());
1363 continue 'next_bound;
416331ca 1364 }
416331ca
XL
1365 }
1366 }
1367 }
1368 }
1369 report_error(self)
1370 }
1371 _ => report_error(self),
1372 }
1373 }
1374 }
1375 }
1376 }
1377
dfeec247
XL
1378 GenericsCtor {
1379 params: self.lower_generic_params_mut(&generics.params, &add_bounds, itctx).collect(),
416331ca
XL
1380 where_clause: self.lower_where_clause(&generics.where_clause),
1381 span: generics.span,
1382 }
1383 }
1384
dfeec247
XL
1385 pub(super) fn lower_generics(
1386 &mut self,
1387 generics: &Generics,
1388 itctx: ImplTraitContext<'_, 'hir>,
1389 ) -> hir::Generics<'hir> {
1390 let generics_ctor = self.lower_generics_mut(generics, itctx);
1391 generics_ctor.into_generics(self.arena)
1392 }
1393
1394 fn lower_where_clause(&mut self, wc: &WhereClause) -> hir::WhereClause<'hir> {
1395 self.with_anonymous_lifetime_mode(AnonymousLifetimeMode::ReportError, |this| {
1396 hir::WhereClause {
1397 predicates: this.arena.alloc_from_iter(
1398 wc.predicates.iter().map(|predicate| this.lower_where_predicate(predicate)),
1399 ),
1400 span: wc.span,
1401 }
1402 })
416331ca
XL
1403 }
1404
dfeec247 1405 fn lower_where_predicate(&mut self, pred: &WherePredicate) -> hir::WherePredicate<'hir> {
416331ca
XL
1406 match *pred {
1407 WherePredicate::BoundPredicate(WhereBoundPredicate {
1408 ref bound_generic_params,
1409 ref bounded_ty,
1410 ref bounds,
1411 span,
1412 }) => {
dfeec247
XL
1413 self.with_in_scope_lifetime_defs(&bound_generic_params, |this| {
1414 hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
1415 bound_generic_params: this.lower_generic_params(
1416 bound_generic_params,
1417 &NodeMap::default(),
1418 ImplTraitContext::disallowed(),
1419 ),
1420 bounded_ty: this.lower_ty(bounded_ty, ImplTraitContext::disallowed()),
1421 bounds: this.arena.alloc_from_iter(bounds.iter().filter_map(|bound| {
1422 match *bound {
1423 // Ignore `?Trait` bounds.
1424 // They were copied into type parameters already.
1425 GenericBound::Trait(_, TraitBoundModifier::Maybe) => None,
1426 _ => Some(
1427 this.lower_param_bound(bound, ImplTraitContext::disallowed()),
1428 ),
1429 }
1430 })),
1431 span,
1432 })
1433 })
416331ca
XL
1434 }
1435 WherePredicate::RegionPredicate(WhereRegionPredicate {
1436 ref lifetime,
1437 ref bounds,
1438 span,
1439 }) => hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate {
1440 span,
1441 lifetime: self.lower_lifetime(lifetime),
1442 bounds: self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
1443 }),
dfeec247 1444 WherePredicate::EqPredicate(WhereEqPredicate { id, ref lhs_ty, ref rhs_ty, span }) => {
416331ca
XL
1445 hir::WherePredicate::EqPredicate(hir::WhereEqPredicate {
1446 hir_id: self.lower_node_id(id),
1447 lhs_ty: self.lower_ty(lhs_ty, ImplTraitContext::disallowed()),
1448 rhs_ty: self.lower_ty(rhs_ty, ImplTraitContext::disallowed()),
1449 span,
1450 })
dfeec247
XL
1451 }
1452 }
1453 }
1454}
1455
1456/// Helper struct for delayed construction of Generics.
1457pub(super) struct GenericsCtor<'hir> {
1458 pub(super) params: SmallVec<[hir::GenericParam<'hir>; 4]>,
1459 where_clause: hir::WhereClause<'hir>,
1460 span: Span,
1461}
1462
1463impl<'hir> GenericsCtor<'hir> {
1464 pub(super) fn into_generics(self, arena: &'hir Arena<'hir>) -> hir::Generics<'hir> {
1465 hir::Generics {
1466 params: arena.alloc_from_iter(self.params),
1467 where_clause: self.where_clause,
1468 span: self.span,
416331ca
XL
1469 }
1470 }
1471}