1 use super::AnonymousLifetimeMode;
2 use super::ImplTraitContext;
3 use super::ImplTraitPosition;
4 use super::ImplTraitTypeIdVisitor;
5 use super::LoweringContext;
9 use crate::hir::def::{DefKind, Res};
10 use crate::hir::def_id::DefId;
11 use crate::util::nodemap::NodeMap;
13 use rustc_target::spec::abi;
15 use smallvec::SmallVec;
16 use std::collections::BTreeSet;
19 use syntax::source_map::{respan, DesugaringKind};
20 use syntax::symbol::{kw, sym};
21 use syntax::visit::{self, Visitor};
24 use rustc_error_codes::*;
26 pub(super) struct ItemLowerer<'a, 'lowering, 'hir> {
27 pub(super) lctx: &'a mut LoweringContext<'lowering, 'hir>,
30 impl<'a, 'lowering, 'hir> ItemLowerer<'a, 'lowering, 'hir> {
31 fn with_trait_impl_ref<F>(&mut self, trait_impl_ref: &Option<TraitRef>, f: F)
35 let old = self.lctx.is_in_trait_impl;
36 self.lctx.is_in_trait_impl = if let &None = trait_impl_ref { false } else { true };
38 self.lctx.is_in_trait_impl = old;
42 impl<'a, 'lowering, 'hir> Visitor<'a> for ItemLowerer<'a, 'lowering, 'hir> {
43 fn visit_mod(&mut self, m: &'a Mod, _s: Span, _attrs: &[Attribute], n: NodeId) {
44 let hir_id = self.lctx.lower_node_id(n);
46 self.lctx.modules.insert(
49 items: BTreeSet::new(),
50 trait_items: BTreeSet::new(),
51 impl_items: BTreeSet::new(),
55 let old = self.lctx.current_module;
56 self.lctx.current_module = hir_id;
57 visit::walk_mod(self, m);
58 self.lctx.current_module = old;
61 fn visit_item(&mut self, item: &'a Item) {
62 let mut item_hir_id = None;
63 self.lctx.with_hir_id_owner(item.id, |lctx| {
64 lctx.without_in_scope_lifetime_defs(|lctx| {
65 if let Some(hir_item) = lctx.lower_item(item) {
66 item_hir_id = Some(hir_item.hir_id);
67 lctx.insert_item(hir_item);
72 if let Some(hir_id) = item_hir_id {
73 self.lctx.with_parent_item_lifetime_defs(hir_id, |this| {
74 let this = &mut ItemLowerer { lctx: this };
75 if let ItemKind::Impl(.., ref opt_trait_ref, _, _) = item.kind {
76 this.with_trait_impl_ref(opt_trait_ref, |this| visit::walk_item(this, item));
78 visit::walk_item(this, item);
84 fn visit_trait_item(&mut self, item: &'a AssocItem) {
85 self.lctx.with_hir_id_owner(item.id, |lctx| {
86 let hir_item = lctx.lower_trait_item(item);
87 let id = hir::TraitItemId { hir_id: hir_item.hir_id };
88 lctx.trait_items.insert(id, hir_item);
89 lctx.modules.get_mut(&lctx.current_module).unwrap().trait_items.insert(id);
92 visit::walk_trait_item(self, item);
95 fn visit_impl_item(&mut self, item: &'a AssocItem) {
96 self.lctx.with_hir_id_owner(item.id, |lctx| {
97 let hir_item = lctx.lower_impl_item(item);
98 let id = hir::ImplItemId { hir_id: hir_item.hir_id };
99 lctx.impl_items.insert(id, hir_item);
100 lctx.modules.get_mut(&lctx.current_module).unwrap().impl_items.insert(id);
102 visit::walk_impl_item(self, item);
106 impl<'hir> LoweringContext<'_, 'hir> {
107 // Same as the method above, but accepts `hir::GenericParam`s
108 // instead of `ast::GenericParam`s.
109 // This should only be used with generics that have already had their
110 // in-band lifetimes added. In practice, this means that this function is
111 // only used when lowering a child item of a trait or impl.
112 fn with_parent_item_lifetime_defs<T>(
114 parent_hir_id: hir::HirId,
115 f: impl FnOnce(&mut LoweringContext<'_, '_>) -> T,
117 let old_len = self.in_scope_lifetimes.len();
119 let parent_generics = match self.items.get(&parent_hir_id).unwrap().kind {
120 hir::ItemKind::Impl(_, _, _, ref generics, ..)
121 | hir::ItemKind::Trait(_, _, ref generics, ..) => &generics.params[..],
124 let lt_def_names = parent_generics.iter().filter_map(|param| match param.kind {
125 hir::GenericParamKind::Lifetime { .. } => Some(param.name.modern()),
128 self.in_scope_lifetimes.extend(lt_def_names);
132 self.in_scope_lifetimes.truncate(old_len);
136 // Clears (and restores) the `in_scope_lifetimes` field. Used when
137 // visiting nested items, which never inherit in-scope lifetimes
138 // from their surrounding environment.
139 fn without_in_scope_lifetime_defs<T>(
141 f: impl FnOnce(&mut LoweringContext<'_, '_>) -> T,
143 let old_in_scope_lifetimes = std::mem::replace(&mut self.in_scope_lifetimes, vec![]);
145 // this vector is only used when walking over impl headers,
146 // input types, and the like, and should not be non-empty in
148 assert!(self.lifetimes_to_define.is_empty());
152 assert!(self.in_scope_lifetimes.is_empty());
153 self.in_scope_lifetimes = old_in_scope_lifetimes;
158 pub(super) fn lower_mod(&mut self, m: &Mod) -> hir::Mod<'hir> {
163 .alloc_from_iter(m.items.iter().flat_map(|x| self.lower_item_id(x))),
167 pub(super) fn lower_item_id(&mut self, i: &Item) -> SmallVec<[hir::ItemId; 1]> {
168 let node_ids = match i.kind {
169 ItemKind::Use(ref use_tree) => {
170 let mut vec = smallvec![i.id];
171 self.lower_item_id_use_tree(use_tree, i.id, &mut vec);
174 ItemKind::MacroDef(..) => SmallVec::new(),
175 ItemKind::Fn(..) | ItemKind::Impl(.., None, _, _) => smallvec![i.id],
176 ItemKind::Static(ref ty, ..) => {
177 let mut ids = smallvec![i.id];
178 if self.sess.features_untracked().impl_trait_in_bindings {
179 let mut visitor = ImplTraitTypeIdVisitor { ids: &mut ids };
180 visitor.visit_ty(ty);
184 ItemKind::Const(ref ty, ..) => {
185 let mut ids = smallvec![i.id];
186 if self.sess.features_untracked().impl_trait_in_bindings {
187 let mut visitor = ImplTraitTypeIdVisitor { ids: &mut ids };
188 visitor.visit_ty(ty);
192 _ => smallvec![i.id],
197 .map(|node_id| hir::ItemId { id: self.allocate_hir_id_counter(node_id) })
201 fn lower_item_id_use_tree(
205 vec: &mut SmallVec<[NodeId; 1]>,
208 UseTreeKind::Nested(ref nested_vec) => {
209 for &(ref nested, id) in nested_vec {
211 self.lower_item_id_use_tree(nested, id, vec);
214 UseTreeKind::Glob => {}
215 UseTreeKind::Simple(_, id1, id2) => {
217 self.expect_full_res_from_use(base_id).skip(1).zip([id1, id2].iter())
225 pub fn lower_item(&mut self, i: &Item) -> Option<hir::Item<'hir>> {
226 let mut ident = i.ident;
227 let mut vis = self.lower_visibility(&i.vis, None);
228 let attrs = self.lower_attrs_arena(&i.attrs);
230 if let ItemKind::MacroDef(ref def) = i.kind {
231 if !def.legacy || attr::contains_name(&i.attrs, sym::macro_export) {
232 let body = self.lower_token_stream(def.body.inner_tokens());
233 let hir_id = self.lower_node_id(i.id);
234 self.exported_macros.push(hir::MacroDef {
244 self.non_exported_macro_attrs.extend(attrs.iter().cloned());
249 let kind = self.lower_item_kind(i.span, i.id, &mut ident, attrs, &mut vis, &i.kind);
251 Some(hir::Item { hir_id: self.lower_node_id(i.id), ident, attrs, kind, vis, span: i.span })
259 attrs: &'hir [Attribute],
260 vis: &mut hir::Visibility<'hir>,
262 ) -> hir::ItemKind<'hir> {
264 ItemKind::ExternCrate(orig_name) => hir::ItemKind::ExternCrate(orig_name),
265 ItemKind::Use(ref use_tree) => {
266 // Start with an empty prefix.
267 let prefix = Path { segments: vec![], span: use_tree.span };
269 self.lower_use_tree(use_tree, &prefix, id, vis, ident, attrs)
271 ItemKind::Static(ref t, m, ref e) => {
272 let ty = self.lower_ty(
274 if self.sess.features_untracked().impl_trait_in_bindings {
275 ImplTraitContext::OpaqueTy(None)
277 ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
280 hir::ItemKind::Static(ty, m, self.lower_const_body(span, Some(e)))
282 ItemKind::Const(ref t, ref e) => {
283 let ty = self.lower_ty(
285 if self.sess.features_untracked().impl_trait_in_bindings {
286 ImplTraitContext::OpaqueTy(None)
288 ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
291 hir::ItemKind::Const(ty, self.lower_const_body(span, Some(e)))
293 ItemKind::Fn(FnSig { ref decl, header }, ref generics, ref body) => {
294 let fn_def_id = self.resolver.definitions().local_def_id(id);
295 self.with_new_scopes(|this| {
296 this.current_item = Some(ident.span);
298 // Note: we don't need to change the return type from `T` to
299 // `impl Future<Output = T>` here because lower_body
300 // only cares about the input argument patterns in the function
301 // declaration (decl), not the return types.
303 this.lower_maybe_async_body(span, &decl, header.asyncness.node, Some(body));
305 let (generics, decl) = this.add_in_band_defs(
308 AnonymousLifetimeMode::PassThrough,
312 Some((fn_def_id, idty)),
314 header.asyncness.node.opt_return_id(),
318 let sig = hir::FnSig { decl, header: this.lower_fn_header(header) };
319 hir::ItemKind::Fn(sig, generics, body_id)
322 ItemKind::Mod(ref m) => hir::ItemKind::Mod(self.lower_mod(m)),
323 ItemKind::ForeignMod(ref nm) => hir::ItemKind::ForeignMod(self.lower_foreign_mod(nm)),
324 ItemKind::GlobalAsm(ref ga) => hir::ItemKind::GlobalAsm(self.lower_global_asm(ga)),
325 ItemKind::TyAlias(ref ty, ref generics) => match ty.kind.opaque_top_hack() {
327 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
328 let generics = self.lower_generics(generics, ImplTraitContext::disallowed());
329 hir::ItemKind::TyAlias(ty, generics)
332 let ty = hir::OpaqueTy {
333 generics: self.lower_generics(generics, ImplTraitContext::OpaqueTy(None)),
334 bounds: self.lower_param_bounds(bounds, ImplTraitContext::OpaqueTy(None)),
336 origin: hir::OpaqueTyOrigin::TypeAlias,
338 hir::ItemKind::OpaqueTy(ty)
341 ItemKind::Enum(ref enum_definition, ref generics) => hir::ItemKind::Enum(
343 variants: self.arena.alloc_from_iter(
344 enum_definition.variants.iter().map(|x| self.lower_variant(x)),
347 self.lower_generics(generics, ImplTraitContext::disallowed()),
349 ItemKind::Struct(ref struct_def, ref generics) => {
350 let struct_def = self.lower_variant_data(struct_def);
351 hir::ItemKind::Struct(
353 self.lower_generics(generics, ImplTraitContext::disallowed()),
356 ItemKind::Union(ref vdata, ref generics) => {
357 let vdata = self.lower_variant_data(vdata);
358 hir::ItemKind::Union(
360 self.lower_generics(generics, ImplTraitContext::disallowed()),
372 let def_id = self.resolver.definitions().local_def_id(id);
374 // Lower the "impl header" first. This ordering is important
375 // for in-band lifetimes! Consider `'a` here:
377 // impl Foo<'a> for u32 {
378 // fn method(&'a self) { .. }
381 // Because we start by lowering the `Foo<'a> for u32`
382 // part, we will add `'a` to the list of generics on
383 // the impl. When we then encounter it later in the
384 // method, it will not be considered an in-band
385 // lifetime to be added, but rather a reference to a
387 let lowered_trait_impl_id = self.lower_node_id(id);
388 let (generics, (trait_ref, lowered_ty)) = self.add_in_band_defs(
391 AnonymousLifetimeMode::CreateParameter,
393 let trait_ref = trait_ref.as_ref().map(|trait_ref| {
394 this.lower_trait_ref(trait_ref, ImplTraitContext::disallowed())
397 if let Some(ref trait_ref) = trait_ref {
398 if let Res::Def(DefKind::Trait, def_id) = trait_ref.path.res {
402 .push(lowered_trait_impl_id);
406 let lowered_ty = this.lower_ty(ty, ImplTraitContext::disallowed());
408 (trait_ref, lowered_ty)
413 self.with_in_scope_lifetime_defs(&ast_generics.params, |this| {
414 this.arena.alloc_from_iter(
415 impl_items.iter().map(|item| this.lower_impl_item_ref(item)),
422 self.lower_defaultness(defaultness, true /* [1] */),
429 ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref items) => {
430 let bounds = self.lower_param_bounds(bounds, ImplTraitContext::disallowed());
433 .alloc_from_iter(items.iter().map(|item| self.lower_trait_item_ref(item)));
434 hir::ItemKind::Trait(
437 self.lower_generics(generics, ImplTraitContext::disallowed()),
442 ItemKind::TraitAlias(ref generics, ref bounds) => hir::ItemKind::TraitAlias(
443 self.lower_generics(generics, ImplTraitContext::disallowed()),
444 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
446 ItemKind::MacroDef(..) | ItemKind::Mac(..) => {
447 bug!("`TyMac` should have been expanded by now")
451 // [1] `defaultness.has_value()` is never called for an `impl`, always `true` in order to
452 // not cause an assertion failure inside the `lower_defaultness` function.
460 vis: &mut hir::Visibility<'hir>,
462 attrs: &'hir [Attribute],
463 ) -> hir::ItemKind<'hir> {
464 debug!("lower_use_tree(tree={:?})", tree);
465 debug!("lower_use_tree: vis = {:?}", vis);
467 let path = &tree.prefix;
468 let segments = prefix.segments.iter().chain(path.segments.iter()).cloned().collect();
471 UseTreeKind::Simple(rename, id1, id2) => {
472 *ident = tree.ident();
474 // First, apply the prefix to the path.
475 let mut path = Path { segments, span: path.span };
477 // Correctly resolve `self` imports.
478 if path.segments.len() > 1
479 && path.segments.last().unwrap().ident.name == kw::SelfLower
481 let _ = path.segments.pop();
482 if rename.is_none() {
483 *ident = path.segments.last().unwrap().ident;
487 let mut resolutions = self.expect_full_res_from_use(id);
488 // We want to return *something* from this function, so hold onto the first item
490 let ret_res = self.lower_res(resolutions.next().unwrap_or(Res::Err));
492 // Here, we are looping over namespaces, if they exist for the definition
493 // being imported. We only handle type and value namespaces because we
494 // won't be dealing with macros in the rest of the compiler.
495 // Essentially a single `use` which imports two names is desugared into
497 for (res, &new_node_id) in resolutions.zip([id1, id2].iter()) {
499 let mut path = path.clone();
500 for seg in &mut path.segments {
501 seg.id = self.resolver.next_node_id();
503 let span = path.span;
505 self.with_hir_id_owner(new_node_id, |this| {
506 let new_id = this.lower_node_id(new_node_id);
507 let res = this.lower_res(res);
508 let path = this.lower_path_extra(res, &path, ParamMode::Explicit, None);
509 let kind = hir::ItemKind::Use(this.arena.alloc(path), hir::UseKind::Single);
510 let vis = this.rebuild_vis(&vis);
512 this.insert_item(hir::Item {
523 let path = self.lower_path_extra(ret_res, &path, ParamMode::Explicit, None);
524 let path = self.arena.alloc(path);
525 hir::ItemKind::Use(path, hir::UseKind::Single)
527 UseTreeKind::Glob => {
528 let path = self.arena.alloc(self.lower_path(
530 &Path { segments, span: path.span },
533 hir::ItemKind::Use(path, hir::UseKind::Glob)
535 UseTreeKind::Nested(ref trees) => {
536 // Nested imports are desugared into simple imports.
537 // So, if we start with
540 // pub(x) use foo::{a, b};
543 // we will create three items:
546 // pub(x) use foo::a;
547 // pub(x) use foo::b;
548 // pub(x) use foo::{}; // <-- this is called the `ListStem`
551 // The first two are produced by recursively invoking
552 // `lower_use_tree` (and indeed there may be things
553 // like `use foo::{a::{b, c}}` and so forth). They
554 // wind up being directly added to
555 // `self.items`. However, the structure of this
556 // function also requires us to return one item, and
557 // for that we return the `{}` import (called the
560 let prefix = Path { segments, span: prefix.span.to(path.span) };
562 // Add all the nested `PathListItem`s to the HIR.
563 for &(ref use_tree, id) in trees {
564 let new_hir_id = self.lower_node_id(id);
566 let mut prefix = prefix.clone();
568 // Give the segments new node-ids since they are being cloned.
569 for seg in &mut prefix.segments {
570 seg.id = self.resolver.next_node_id();
573 // Each `use` import is an item and thus are owners of the
574 // names in the path. Up to this point the nested import is
575 // the current owner, since we want each desugared import to
576 // own its own names, we have to adjust the owner before
577 // lowering the rest of the import.
578 self.with_hir_id_owner(id, |this| {
579 let mut vis = this.rebuild_vis(&vis);
580 let mut ident = *ident;
583 this.lower_use_tree(use_tree, &prefix, id, &mut vis, &mut ident, attrs);
585 this.insert_item(hir::Item {
596 // Subtle and a bit hacky: we lower the privacy level
597 // of the list stem to "private" most of the time, but
598 // not for "restricted" paths. The key thing is that
599 // we don't want it to stay as `pub` (with no caveats)
600 // because that affects rustdoc and also the lints
601 // about `pub` items. But we can't *always* make it
602 // private -- particularly not for restricted paths --
603 // because it contains node-ids that would then be
604 // unused, failing the check that HirIds are "densely
607 hir::VisibilityKind::Public
608 | hir::VisibilityKind::Crate(_)
609 | hir::VisibilityKind::Inherited => {
610 *vis = respan(prefix.span.shrink_to_lo(), hir::VisibilityKind::Inherited);
612 hir::VisibilityKind::Restricted { .. } => {
613 // Do nothing here, as described in the comment on the match.
617 let res = self.expect_full_res_from_use(id).next().unwrap_or(Res::Err);
618 let res = self.lower_res(res);
619 let path = self.lower_path_extra(res, &prefix, ParamMode::Explicit, None);
620 let path = self.arena.alloc(path);
621 hir::ItemKind::Use(path, hir::UseKind::ListStem)
626 /// Paths like the visibility path in `pub(super) use foo::{bar, baz}` are repeated
627 /// many times in the HIR tree; for each occurrence, we need to assign distinct
628 /// `NodeId`s. (See, e.g., #56128.)
629 fn rebuild_use_path(&mut self, path: &hir::Path<'hir>) -> hir::Path<'hir> {
630 debug!("rebuild_use_path(path = {:?})", path);
632 self.arena.alloc_from_iter(path.segments.iter().map(|seg| hir::PathSegment {
634 hir_id: seg.hir_id.map(|_| self.next_id()),
637 infer_args: seg.infer_args,
639 hir::Path { span: path.span, res: path.res, segments }
642 fn rebuild_vis(&mut self, vis: &hir::Visibility<'hir>) -> hir::Visibility<'hir> {
643 let vis_kind = match vis.node {
644 hir::VisibilityKind::Public => hir::VisibilityKind::Public,
645 hir::VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
646 hir::VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
647 hir::VisibilityKind::Restricted { ref path, hir_id: _ } => {
648 hir::VisibilityKind::Restricted {
649 path: self.arena.alloc(self.rebuild_use_path(path)),
650 hir_id: self.next_id(),
654 respan(vis.span, vis_kind)
657 fn lower_foreign_item(&mut self, i: &ForeignItem) -> hir::ForeignItem<'hir> {
658 let def_id = self.resolver.definitions().local_def_id(i.id);
660 hir_id: self.lower_node_id(i.id),
662 attrs: self.lower_attrs_arena(&i.attrs),
664 ForeignItemKind::Fn(ref fdec, ref generics) => {
665 let (generics, (fn_dec, fn_args)) = self.add_in_band_defs(
668 AnonymousLifetimeMode::PassThrough,
671 // Disallow `impl Trait` in foreign items.
672 this.lower_fn_decl(fdec, None, false, None),
673 this.lower_fn_params_to_names(fdec),
677 let fn_args = self.arena.alloc_from_iter(fn_args.into_iter());
679 hir::ForeignItemKind::Fn(fn_dec, fn_args, generics)
681 ForeignItemKind::Static(ref t, m) => {
682 let ty = self.lower_ty(t, ImplTraitContext::disallowed());
683 hir::ForeignItemKind::Static(ty, m)
685 ForeignItemKind::Ty => hir::ForeignItemKind::Type,
686 ForeignItemKind::Macro(_) => panic!("macro shouldn't exist here"),
688 vis: self.lower_visibility(&i.vis, None),
693 fn lower_foreign_mod(&mut self, fm: &ForeignMod) -> hir::ForeignMod<'hir> {
695 abi: fm.abi.map_or(abi::Abi::C, |abi| self.lower_abi(abi)),
696 items: self.arena.alloc_from_iter(fm.items.iter().map(|x| self.lower_foreign_item(x))),
700 fn lower_global_asm(&mut self, ga: &GlobalAsm) -> &'hir hir::GlobalAsm {
701 self.arena.alloc(hir::GlobalAsm { asm: ga.asm })
704 fn lower_variant(&mut self, v: &Variant) -> hir::Variant<'hir> {
706 attrs: self.lower_attrs_arena(&v.attrs),
707 data: self.lower_variant_data(&v.data),
708 disr_expr: v.disr_expr.as_ref().map(|e| self.lower_anon_const(e)),
709 id: self.lower_node_id(v.id),
715 fn lower_variant_data(&mut self, vdata: &VariantData) -> hir::VariantData<'hir> {
717 VariantData::Struct(ref fields, recovered) => hir::VariantData::Struct(
719 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
722 VariantData::Tuple(ref fields, id) => hir::VariantData::Tuple(
724 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
725 self.lower_node_id(id),
727 VariantData::Unit(id) => hir::VariantData::Unit(self.lower_node_id(id)),
731 fn lower_struct_field(&mut self, (index, f): (usize, &StructField)) -> hir::StructField<'hir> {
732 let ty = if let TyKind::Path(ref qself, ref path) = f.ty.kind {
733 let t = self.lower_path_ty(
737 ParamMode::ExplicitNamed, // no `'_` in declarations (Issue #61124)
738 ImplTraitContext::disallowed(),
742 self.lower_ty(&f.ty, ImplTraitContext::disallowed())
746 hir_id: self.lower_node_id(f.id),
747 ident: match f.ident {
748 Some(ident) => ident,
749 // FIXME(jseyfried): positional field hygiene.
750 None => Ident::new(sym::integer(index), f.span),
752 vis: self.lower_visibility(&f.vis, None),
754 attrs: self.lower_attrs_arena(&f.attrs),
758 fn lower_trait_item(&mut self, i: &AssocItem) -> hir::TraitItem<'hir> {
759 let trait_item_def_id = self.resolver.definitions().local_def_id(i.id);
761 let (generics, kind) = match i.kind {
762 AssocItemKind::Const(ref ty, ref default) => {
763 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
764 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
767 hir::TraitItemKind::Const(
769 default.as_ref().map(|x| self.lower_const_body(i.span, Some(x))),
773 AssocItemKind::Fn(ref sig, None) => {
774 let names = self.lower_fn_params_to_names(&sig.decl);
775 let names: &[Ident] = self.arena.alloc_from_iter(names.into_iter());
776 let (generics, sig) =
777 self.lower_method_sig(&i.generics, sig, trait_item_def_id, false, None);
778 (generics, hir::TraitItemKind::Method(sig, hir::TraitMethod::Required(names)))
780 AssocItemKind::Fn(ref sig, Some(ref body)) => {
781 let body_id = self.lower_fn_body_block(i.span, &sig.decl, Some(body));
782 let (generics, sig) =
783 self.lower_method_sig(&i.generics, sig, trait_item_def_id, false, None);
784 (generics, hir::TraitItemKind::Method(sig, hir::TraitMethod::Provided(body_id)))
786 AssocItemKind::TyAlias(ref bounds, ref default) => {
787 let ty = default.as_ref().map(|x| self.lower_ty(x, ImplTraitContext::disallowed()));
788 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
789 let kind = hir::TraitItemKind::Type(
790 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
796 AssocItemKind::Macro(..) => bug!("macro item shouldn't exist at this point"),
800 hir_id: self.lower_node_id(i.id),
802 attrs: self.lower_attrs_arena(&i.attrs),
809 fn lower_trait_item_ref(&mut self, i: &AssocItem) -> hir::TraitItemRef {
810 let (kind, has_default) = match i.kind {
811 AssocItemKind::Const(_, ref default) => (hir::AssocItemKind::Const, default.is_some()),
812 AssocItemKind::TyAlias(_, ref default) => (hir::AssocItemKind::Type, default.is_some()),
813 AssocItemKind::Fn(ref sig, ref default) => {
814 (hir::AssocItemKind::Method { has_self: sig.decl.has_self() }, default.is_some())
816 AssocItemKind::Macro(..) => unimplemented!(),
819 id: hir::TraitItemId { hir_id: self.lower_node_id(i.id) },
822 defaultness: self.lower_defaultness(Defaultness::Default, has_default),
827 /// Construct `ExprKind::Err` for the given `span`.
828 fn expr_err(&mut self, span: Span) -> hir::Expr<'hir> {
829 self.expr(span, hir::ExprKind::Err, AttrVec::new())
832 fn lower_impl_item(&mut self, i: &AssocItem) -> hir::ImplItem<'hir> {
833 let impl_item_def_id = self.resolver.definitions().local_def_id(i.id);
835 let (generics, kind) = match i.kind {
836 AssocItemKind::Const(ref ty, ref expr) => {
837 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
838 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
841 hir::ImplItemKind::Const(ty, self.lower_const_body(i.span, expr.as_deref())),
844 AssocItemKind::Fn(ref sig, ref body) => {
845 self.current_item = Some(i.span);
846 let body_id = self.lower_maybe_async_body(
849 sig.header.asyncness.node,
852 let impl_trait_return_allow = !self.is_in_trait_impl;
853 let (generics, sig) = self.lower_method_sig(
857 impl_trait_return_allow,
858 sig.header.asyncness.node.opt_return_id(),
861 (generics, hir::ImplItemKind::Method(sig, body_id))
863 AssocItemKind::TyAlias(_, ref ty) => {
864 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
865 let kind = match ty {
867 let ty = self.arena.alloc(self.ty(i.span, hir::TyKind::Err));
868 hir::ImplItemKind::TyAlias(ty)
870 Some(ty) => match ty.kind.opaque_top_hack() {
872 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
873 hir::ImplItemKind::TyAlias(ty)
876 let bs = self.lower_param_bounds(bs, ImplTraitContext::disallowed());
877 hir::ImplItemKind::OpaqueTy(bs)
883 AssocItemKind::Macro(..) => bug!("`TyMac` should have been expanded by now"),
887 hir_id: self.lower_node_id(i.id),
889 attrs: self.lower_attrs_arena(&i.attrs),
891 vis: self.lower_visibility(&i.vis, None),
892 defaultness: self.lower_defaultness(i.defaultness, true /* [1] */),
897 // [1] since `default impl` is not yet implemented, this is always true in impls
900 fn lower_impl_item_ref(&mut self, i: &AssocItem) -> hir::ImplItemRef<'hir> {
902 id: hir::ImplItemId { hir_id: self.lower_node_id(i.id) },
905 vis: self.lower_visibility(&i.vis, Some(i.id)),
906 defaultness: self.lower_defaultness(i.defaultness, true /* [1] */),
907 kind: match &i.kind {
908 AssocItemKind::Const(..) => hir::AssocItemKind::Const,
909 AssocItemKind::TyAlias(_, ty) => {
910 match ty.as_deref().and_then(|ty| ty.kind.opaque_top_hack()) {
911 None => hir::AssocItemKind::Type,
912 Some(_) => hir::AssocItemKind::OpaqueTy,
915 AssocItemKind::Fn(sig, _) => {
916 hir::AssocItemKind::Method { has_self: sig.decl.has_self() }
918 AssocItemKind::Macro(..) => unimplemented!(),
922 // [1] since `default impl` is not yet implemented, this is always true in impls
925 /// If an `explicit_owner` is given, this method allocates the `HirId` in
926 /// the address space of that item instead of the item currently being
927 /// lowered. This can happen during `lower_impl_item_ref()` where we need to
928 /// lower a `Visibility` value although we haven't lowered the owning
929 /// `ImplItem` in question yet.
933 explicit_owner: Option<NodeId>,
934 ) -> hir::Visibility<'hir> {
935 let node = match v.node {
936 VisibilityKind::Public => hir::VisibilityKind::Public,
937 VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
938 VisibilityKind::Restricted { ref path, id } => {
939 debug!("lower_visibility: restricted path id = {:?}", id);
940 let lowered_id = if let Some(owner) = explicit_owner {
941 self.lower_node_id_with_owner(id, owner)
943 self.lower_node_id(id)
945 let res = self.expect_full_res(id);
946 let res = self.lower_res(res);
947 hir::VisibilityKind::Restricted {
948 path: self.arena.alloc(self.lower_path_extra(
957 VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
962 fn lower_defaultness(&self, d: Defaultness, has_value: bool) -> hir::Defaultness {
964 Defaultness::Default => hir::Defaultness::Default { has_value: has_value },
965 Defaultness::Final => {
967 hir::Defaultness::Final
974 params: &'hir [hir::Param<'hir>],
975 value: hir::Expr<'hir>,
977 let body = hir::Body { generator_kind: self.generator_kind, params, value };
979 self.bodies.insert(id, body);
985 f: impl FnOnce(&mut Self) -> (&'hir [hir::Param<'hir>], hir::Expr<'hir>),
987 let prev_gen_kind = self.generator_kind.take();
988 let (parameters, result) = f(self);
989 let body_id = self.record_body(parameters, result);
990 self.generator_kind = prev_gen_kind;
994 fn lower_param(&mut self, param: &Param) -> hir::Param<'hir> {
996 attrs: self.lower_attrs_arena(¶m.attrs),
997 hir_id: self.lower_node_id(param.id),
998 pat: self.lower_pat(¶m.pat),
1003 pub(super) fn lower_fn_body(
1006 body: impl FnOnce(&mut Self) -> hir::Expr<'hir>,
1008 self.lower_body(|this| {
1010 this.arena.alloc_from_iter(decl.inputs.iter().map(|x| this.lower_param(x))),
1016 fn lower_fn_body_block(
1020 body: Option<&Block>,
1022 self.lower_fn_body(decl, |this| this.lower_block_expr_opt(span, body))
1025 fn lower_block_expr_opt(&mut self, span: Span, block: Option<&Block>) -> hir::Expr<'hir> {
1027 Some(block) => self.lower_block_expr(block),
1028 None => self.expr_err(span),
1032 pub(super) fn lower_const_body(&mut self, span: Span, expr: Option<&Expr>) -> hir::BodyId {
1033 self.lower_body(|this| {
1037 Some(expr) => this.lower_expr_mut(expr),
1038 None => this.expr_err(span),
1044 fn lower_maybe_async_body(
1049 body: Option<&Block>,
1051 let closure_id = match asyncness {
1052 IsAsync::Async { closure_id, .. } => closure_id,
1053 IsAsync::NotAsync => return self.lower_fn_body_block(span, decl, body),
1056 self.lower_body(|this| {
1057 let mut parameters: Vec<hir::Param<'_>> = Vec::new();
1058 let mut statements: Vec<hir::Stmt<'_>> = Vec::new();
1060 // Async function parameters are lowered into the closure body so that they are
1061 // captured and so that the drop order matches the equivalent non-async functions.
1065 // async fn foo(<pattern>: <ty>, <pattern>: <ty>, <pattern>: <ty>) {
1071 // fn foo(__arg0: <ty>, __arg1: <ty>, __arg2: <ty>) {
1073 // let __arg2 = __arg2;
1074 // let <pattern> = __arg2;
1075 // let __arg1 = __arg1;
1076 // let <pattern> = __arg1;
1077 // let __arg0 = __arg0;
1078 // let <pattern> = __arg0;
1079 // drop-temps { <body> } // see comments later in fn for details
1083 // If `<pattern>` is a simple ident, then it is lowered to a single
1084 // `let <pattern> = <pattern>;` statement as an optimization.
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;
1096 // Check if this is a binding pattern, if so, we can optimize and avoid adding a
1097 // `let <pat> = __argN;` statement. In this case, we do not rename the parameter.
1098 let (ident, is_simple_parameter) = match parameter.pat.kind {
1099 hir::PatKind::Binding(hir::BindingAnnotation::Unannotated, _, ident, _) => {
1103 // Replace the ident for bindings that aren't simple.
1104 let name = format!("__arg{}", index);
1105 let ident = Ident::from_str(&name);
1111 let desugared_span = this.mark_span_with_reason(DesugaringKind::Async, span, None);
1113 // Construct a parameter representing `__argN: <ty>` to replace the parameter of the
1116 // If this is the simple case, this parameter will end up being the same as the
1117 // original parameter, but with a different pattern id.
1118 let mut stmt_attrs = AttrVec::new();
1119 stmt_attrs.extend(parameter.attrs.iter().cloned());
1120 let (new_parameter_pat, new_parameter_id) = this.pat_ident(desugared_span, ident);
1121 let new_parameter = hir::Param {
1122 attrs: parameter.attrs,
1123 hir_id: parameter.hir_id,
1124 pat: new_parameter_pat,
1125 span: parameter.span,
1128 if is_simple_parameter {
1129 // If this is the simple case, then we only insert one statement that is
1130 // `let <pat> = <pat>;`. We re-use the original argument's pattern so that
1131 // `HirId`s are densely assigned.
1132 let expr = this.expr_ident(desugared_span, ident, new_parameter_id);
1133 let stmt = this.stmt_let_pat(
1136 Some(this.arena.alloc(expr)),
1138 hir::LocalSource::AsyncFn,
1140 statements.push(stmt);
1142 // If this is not the simple case, then we construct two statements:
1145 // let __argN = __argN;
1146 // let <pat> = __argN;
1149 // The first statement moves the parameter into the closure and thus ensures
1150 // that the drop order is correct.
1152 // The second statement creates the bindings that the user wrote.
1154 // Construct the `let mut __argN = __argN;` statement. It must be a mut binding
1155 // because the user may have specified a `ref mut` binding in the next
1157 let (move_pat, move_id) = this.pat_ident_binding_mode(
1160 hir::BindingAnnotation::Mutable,
1162 let move_expr = this.expr_ident(desugared_span, ident, new_parameter_id);
1163 let move_stmt = this.stmt_let_pat(
1166 Some(this.arena.alloc(move_expr)),
1168 hir::LocalSource::AsyncFn,
1171 // Construct the `let <pat> = __argN;` statement. We re-use the original
1172 // parameter's pattern so that `HirId`s are densely assigned.
1173 let pattern_expr = this.expr_ident(desugared_span, ident, move_id);
1174 let pattern_stmt = this.stmt_let_pat(
1177 Some(this.arena.alloc(pattern_expr)),
1179 hir::LocalSource::AsyncFn,
1182 statements.push(move_stmt);
1183 statements.push(pattern_stmt);
1186 parameters.push(new_parameter);
1189 let body_span = body.map_or(span, |b| b.span);
1190 let async_expr = this.make_async_expr(
1195 hir::AsyncGeneratorKind::Fn,
1197 // Create a block from the user's function body:
1198 let user_body = this.lower_block_expr_opt(body_span, body);
1200 // Transform into `drop-temps { <user-body> }`, an expression:
1201 let desugared_span =
1202 this.mark_span_with_reason(DesugaringKind::Async, user_body.span, None);
1203 let user_body = this.expr_drop_temps(
1205 this.arena.alloc(user_body),
1209 // As noted above, create the final block like
1213 // let $param_pattern = $raw_param;
1215 // drop-temps { <user-body> }
1218 let body = this.block_all(
1220 this.arena.alloc_from_iter(statements),
1224 this.expr_block(body, AttrVec::new())
1229 this.arena.alloc_from_iter(parameters),
1230 this.expr(body_span, async_expr, AttrVec::new()),
1235 fn lower_method_sig(
1237 generics: &Generics,
1240 impl_trait_return_allow: bool,
1241 is_async: Option<NodeId>,
1242 ) -> (hir::Generics<'hir>, hir::FnSig<'hir>) {
1243 let header = self.lower_fn_header(sig.header);
1244 let (generics, decl) = self.add_in_band_defs(
1247 AnonymousLifetimeMode::PassThrough,
1251 Some((fn_def_id, idty)),
1252 impl_trait_return_allow,
1257 (generics, hir::FnSig { header, decl })
1260 fn lower_fn_header(&mut self, h: FnHeader) -> hir::FnHeader {
1262 unsafety: h.unsafety,
1263 asyncness: self.lower_asyncness(h.asyncness.node),
1264 constness: h.constness.node,
1265 abi: self.lower_extern(h.ext),
1269 pub(super) fn lower_abi(&mut self, abi: StrLit) -> abi::Abi {
1270 abi::lookup(&abi.symbol_unescaped.as_str()).unwrap_or_else(|| {
1271 self.error_on_invalid_abi(abi);
1276 pub(super) fn lower_extern(&mut self, ext: Extern) -> abi::Abi {
1278 Extern::None => abi::Abi::Rust,
1279 Extern::Implicit => abi::Abi::C,
1280 Extern::Explicit(abi) => self.lower_abi(abi),
1284 fn error_on_invalid_abi(&self, abi: StrLit) {
1285 struct_span_err!(self.sess, abi.span, E0703, "invalid ABI: found `{}`", abi.symbol)
1286 .span_label(abi.span, "invalid ABI")
1287 .help(&format!("valid ABIs: {}", abi::all_names().join(", ")))
1291 fn lower_asyncness(&mut self, a: IsAsync) -> hir::IsAsync {
1293 IsAsync::Async { .. } => hir::IsAsync::Async,
1294 IsAsync::NotAsync => hir::IsAsync::NotAsync,
1298 pub(super) fn lower_generics(
1300 generics: &Generics,
1301 itctx: ImplTraitContext<'_, 'hir>,
1302 ) -> hir::Generics<'hir> {
1303 // Collect `?Trait` bounds in where clause and move them to parameter definitions.
1304 // FIXME: this could probably be done with less rightward drift. It also looks like two
1305 // control paths where `report_error` is called are the only paths that advance to after the
1306 // match statement, so the error reporting could probably just be moved there.
1307 let mut add_bounds: NodeMap<Vec<_>> = Default::default();
1308 for pred in &generics.where_clause.predicates {
1309 if let WherePredicate::BoundPredicate(ref bound_pred) = *pred {
1310 'next_bound: for bound in &bound_pred.bounds {
1311 if let GenericBound::Trait(_, TraitBoundModifier::Maybe) = *bound {
1312 let report_error = |this: &mut Self| {
1313 this.diagnostic().span_err(
1314 bound_pred.bounded_ty.span,
1315 "`?Trait` bounds are only permitted at the \
1316 point where a type parameter is declared",
1319 // Check if the where clause type is a plain type parameter.
1320 match bound_pred.bounded_ty.kind {
1321 TyKind::Path(None, ref path)
1322 if path.segments.len() == 1
1323 && bound_pred.bound_generic_params.is_empty() =>
1325 if let Some(Res::Def(DefKind::TyParam, def_id)) = self
1327 .get_partial_res(bound_pred.bounded_ty.id)
1328 .map(|d| d.base_res())
1330 if let Some(node_id) =
1331 self.resolver.definitions().as_local_node_id(def_id)
1333 for param in &generics.params {
1335 GenericParamKind::Type { .. } => {
1336 if node_id == param.id {
1340 .push(bound.clone());
1341 continue 'next_bound;
1351 _ => report_error(self),
1359 params: self.lower_generic_params(&generics.params, &add_bounds, itctx),
1360 where_clause: self.lower_where_clause(&generics.where_clause),
1361 span: generics.span,
1365 fn lower_where_clause(&mut self, wc: &WhereClause) -> hir::WhereClause<'hir> {
1366 self.with_anonymous_lifetime_mode(AnonymousLifetimeMode::ReportError, |this| {
1368 predicates: this.arena.alloc_from_iter(
1369 wc.predicates.iter().map(|predicate| this.lower_where_predicate(predicate)),
1376 fn lower_where_predicate(&mut self, pred: &WherePredicate) -> hir::WherePredicate<'hir> {
1378 WherePredicate::BoundPredicate(WhereBoundPredicate {
1379 ref bound_generic_params,
1384 self.with_in_scope_lifetime_defs(&bound_generic_params, |this| {
1385 hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
1386 bound_generic_params: this.arena.alloc_from_iter(
1387 this.lower_generic_params(
1388 bound_generic_params,
1389 &NodeMap::default(),
1390 ImplTraitContext::disallowed(),
1394 bounded_ty: this.lower_ty(bounded_ty, ImplTraitContext::disallowed()),
1395 bounds: this.arena.alloc_from_iter(bounds.iter().filter_map(|bound| {
1397 // Ignore `?Trait` bounds.
1398 // They were copied into type parameters already.
1399 GenericBound::Trait(_, TraitBoundModifier::Maybe) => None,
1401 this.lower_param_bound(bound, ImplTraitContext::disallowed()),
1409 WherePredicate::RegionPredicate(WhereRegionPredicate {
1413 }) => hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate {
1415 lifetime: self.lower_lifetime(lifetime),
1416 bounds: self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
1418 WherePredicate::EqPredicate(WhereEqPredicate { id, ref lhs_ty, ref rhs_ty, span }) => {
1419 hir::WherePredicate::EqPredicate(hir::WhereEqPredicate {
1420 hir_id: self.lower_node_id(id),
1421 lhs_ty: self.lower_ty(lhs_ty, ImplTraitContext::disallowed()),
1422 rhs_ty: self.lower_ty(rhs_ty, ImplTraitContext::disallowed()),