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::hir::ptr::P;
12 use crate::util::nodemap::NodeMap;
14 use rustc_target::spec::abi;
16 use smallvec::SmallVec;
17 use std::collections::BTreeSet;
20 use syntax::source_map::{respan, DesugaringKind};
21 use syntax::symbol::{kw, sym};
22 use syntax::visit::{self, Visitor};
25 use rustc_error_codes::*;
27 pub(super) struct ItemLowerer<'a, 'lowering, 'hir> {
28 pub(super) lctx: &'a mut LoweringContext<'lowering, 'hir>,
31 impl<'a, 'lowering, 'hir> ItemLowerer<'a, 'lowering, 'hir> {
32 fn with_trait_impl_ref<F>(&mut self, trait_impl_ref: &Option<TraitRef>, f: F)
36 let old = self.lctx.is_in_trait_impl;
37 self.lctx.is_in_trait_impl = if let &None = trait_impl_ref { false } else { true };
39 self.lctx.is_in_trait_impl = old;
43 impl<'a, 'lowering, 'hir> Visitor<'a> for ItemLowerer<'a, 'lowering, 'hir> {
44 fn visit_mod(&mut self, m: &'a Mod, _s: Span, _attrs: &[Attribute], n: NodeId) {
45 let hir_id = self.lctx.lower_node_id(n);
47 self.lctx.modules.insert(
50 items: BTreeSet::new(),
51 trait_items: BTreeSet::new(),
52 impl_items: BTreeSet::new(),
56 let old = self.lctx.current_module;
57 self.lctx.current_module = hir_id;
58 visit::walk_mod(self, m);
59 self.lctx.current_module = old;
62 fn visit_item(&mut self, item: &'a Item) {
63 let mut item_hir_id = None;
64 self.lctx.with_hir_id_owner(item.id, |lctx| {
65 lctx.without_in_scope_lifetime_defs(|lctx| {
66 if let Some(hir_item) = lctx.lower_item(item) {
67 item_hir_id = Some(hir_item.hir_id);
68 lctx.insert_item(hir_item);
73 if let Some(hir_id) = item_hir_id {
74 self.lctx.with_parent_item_lifetime_defs(hir_id, |this| {
75 let this = &mut ItemLowerer { lctx: this };
76 if let ItemKind::Impl(.., ref opt_trait_ref, _, _) = item.kind {
77 this.with_trait_impl_ref(opt_trait_ref, |this| visit::walk_item(this, item));
79 visit::walk_item(this, item);
85 fn visit_trait_item(&mut self, item: &'a AssocItem) {
86 self.lctx.with_hir_id_owner(item.id, |lctx| {
87 let hir_item = lctx.lower_trait_item(item);
88 let id = hir::TraitItemId { hir_id: hir_item.hir_id };
89 lctx.trait_items.insert(id, hir_item);
90 lctx.modules.get_mut(&lctx.current_module).unwrap().trait_items.insert(id);
93 visit::walk_trait_item(self, item);
96 fn visit_impl_item(&mut self, item: &'a AssocItem) {
97 self.lctx.with_hir_id_owner(item.id, |lctx| {
98 let hir_item = lctx.lower_impl_item(item);
99 let id = hir::ImplItemId { hir_id: hir_item.hir_id };
100 lctx.impl_items.insert(id, hir_item);
101 lctx.modules.get_mut(&lctx.current_module).unwrap().impl_items.insert(id);
103 visit::walk_impl_item(self, item);
107 impl<'hir> LoweringContext<'_, 'hir> {
108 // Same as the method above, but accepts `hir::GenericParam`s
109 // instead of `ast::GenericParam`s.
110 // This should only be used with generics that have already had their
111 // in-band lifetimes added. In practice, this means that this function is
112 // only used when lowering a child item of a trait or impl.
113 fn with_parent_item_lifetime_defs<T>(
115 parent_hir_id: hir::HirId,
116 f: impl FnOnce(&mut LoweringContext<'_, '_>) -> T,
118 let old_len = self.in_scope_lifetimes.len();
120 let parent_generics = match self.items.get(&parent_hir_id).unwrap().kind {
121 hir::ItemKind::Impl(_, _, _, ref generics, ..)
122 | hir::ItemKind::Trait(_, _, ref generics, ..) => &generics.params[..],
125 let lt_def_names = parent_generics.iter().filter_map(|param| match param.kind {
126 hir::GenericParamKind::Lifetime { .. } => Some(param.name.modern()),
129 self.in_scope_lifetimes.extend(lt_def_names);
133 self.in_scope_lifetimes.truncate(old_len);
137 // Clears (and restores) the `in_scope_lifetimes` field. Used when
138 // visiting nested items, which never inherit in-scope lifetimes
139 // from their surrounding environment.
140 fn without_in_scope_lifetime_defs<T>(
142 f: impl FnOnce(&mut LoweringContext<'_, '_>) -> T,
144 let old_in_scope_lifetimes = std::mem::replace(&mut self.in_scope_lifetimes, vec![]);
146 // this vector is only used when walking over impl headers,
147 // input types, and the like, and should not be non-empty in
149 assert!(self.lifetimes_to_define.is_empty());
153 assert!(self.in_scope_lifetimes.is_empty());
154 self.in_scope_lifetimes = old_in_scope_lifetimes;
159 pub(super) fn lower_mod(&mut self, m: &Mod) -> hir::Mod<'hir> {
164 .alloc_from_iter(m.items.iter().flat_map(|x| self.lower_item_id(x))),
168 pub(super) fn lower_item_id(&mut self, i: &Item) -> SmallVec<[hir::ItemId; 1]> {
169 let node_ids = match i.kind {
170 ItemKind::Use(ref use_tree) => {
171 let mut vec = smallvec![i.id];
172 self.lower_item_id_use_tree(use_tree, i.id, &mut vec);
175 ItemKind::MacroDef(..) => SmallVec::new(),
176 ItemKind::Fn(..) | ItemKind::Impl(.., None, _, _) => smallvec![i.id],
177 ItemKind::Static(ref ty, ..) => {
178 let mut ids = smallvec![i.id];
179 if self.sess.features_untracked().impl_trait_in_bindings {
180 let mut visitor = ImplTraitTypeIdVisitor { ids: &mut ids };
181 visitor.visit_ty(ty);
185 ItemKind::Const(ref ty, ..) => {
186 let mut ids = smallvec![i.id];
187 if self.sess.features_untracked().impl_trait_in_bindings {
188 let mut visitor = ImplTraitTypeIdVisitor { ids: &mut ids };
189 visitor.visit_ty(ty);
193 _ => smallvec![i.id],
198 .map(|node_id| hir::ItemId { id: self.allocate_hir_id_counter(node_id) })
202 fn lower_item_id_use_tree(
206 vec: &mut SmallVec<[NodeId; 1]>,
209 UseTreeKind::Nested(ref nested_vec) => {
210 for &(ref nested, id) in nested_vec {
212 self.lower_item_id_use_tree(nested, id, vec);
215 UseTreeKind::Glob => {}
216 UseTreeKind::Simple(_, id1, id2) => {
218 self.expect_full_res_from_use(base_id).skip(1).zip([id1, id2].iter())
226 pub fn lower_item(&mut self, i: &Item) -> Option<hir::Item<'hir>> {
227 let mut ident = i.ident;
228 let mut vis = self.lower_visibility(&i.vis, None);
229 let attrs = self.lower_attrs_arena(&i.attrs);
231 if let ItemKind::MacroDef(ref def) = i.kind {
232 if !def.legacy || attr::contains_name(&i.attrs, sym::macro_export) {
233 let body = self.lower_token_stream(def.body.inner_tokens());
234 let hir_id = self.lower_node_id(i.id);
235 self.exported_macros.push(hir::MacroDef {
245 self.non_exported_macro_attrs.extend(attrs.iter().cloned());
250 let kind = self.lower_item_kind(i.span, i.id, &mut ident, attrs, &mut vis, &i.kind);
252 Some(hir::Item { hir_id: self.lower_node_id(i.id), ident, attrs, kind, vis, span: i.span })
260 attrs: &'hir [Attribute],
261 vis: &mut hir::Visibility,
263 ) -> hir::ItemKind<'hir> {
265 ItemKind::ExternCrate(orig_name) => hir::ItemKind::ExternCrate(orig_name),
266 ItemKind::Use(ref use_tree) => {
267 // Start with an empty prefix.
268 let prefix = Path { segments: vec![], span: use_tree.span };
270 self.lower_use_tree(use_tree, &prefix, id, vis, ident, attrs)
272 ItemKind::Static(ref t, m, ref e) => {
273 let ty = self.lower_ty(
275 if self.sess.features_untracked().impl_trait_in_bindings {
276 ImplTraitContext::OpaqueTy(None)
278 ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
281 hir::ItemKind::Static(
282 self.arena.alloc(ty.into_inner()),
284 self.lower_const_body(span, Some(e)),
287 ItemKind::Const(ref t, ref e) => {
288 let ty = self.lower_ty(
290 if self.sess.features_untracked().impl_trait_in_bindings {
291 ImplTraitContext::OpaqueTy(None)
293 ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
296 hir::ItemKind::Const(
297 self.arena.alloc(ty.into_inner()),
298 self.lower_const_body(span, Some(e)),
301 ItemKind::Fn(FnSig { ref decl, header }, ref generics, ref body) => {
302 let fn_def_id = self.resolver.definitions().local_def_id(id);
303 self.with_new_scopes(|this| {
304 this.current_item = Some(ident.span);
306 // Note: we don't need to change the return type from `T` to
307 // `impl Future<Output = T>` here because lower_body
308 // only cares about the input argument patterns in the function
309 // declaration (decl), not the return types.
311 this.lower_maybe_async_body(span, &decl, header.asyncness.node, Some(body));
313 let (generics, decl) = this.add_in_band_defs(
316 AnonymousLifetimeMode::PassThrough,
320 Some((fn_def_id, idty)),
322 header.asyncness.node.opt_return_id(),
326 let decl = this.arena.alloc(decl.into_inner());
327 let sig = hir::FnSig { decl, header: this.lower_fn_header(header) };
328 hir::ItemKind::Fn(sig, generics, body_id)
331 ItemKind::Mod(ref m) => hir::ItemKind::Mod(self.lower_mod(m)),
332 ItemKind::ForeignMod(ref nm) => hir::ItemKind::ForeignMod(self.lower_foreign_mod(nm)),
333 ItemKind::GlobalAsm(ref ga) => hir::ItemKind::GlobalAsm(self.lower_global_asm(ga)),
334 ItemKind::TyAlias(ref ty, ref generics) => match ty.kind.opaque_top_hack() {
336 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
337 let generics = self.lower_generics(generics, ImplTraitContext::disallowed());
338 hir::ItemKind::TyAlias(self.arena.alloc(ty.into_inner()), generics)
341 let ty = hir::OpaqueTy {
342 generics: self.lower_generics(generics, ImplTraitContext::OpaqueTy(None)),
343 bounds: self.lower_param_bounds(bounds, ImplTraitContext::OpaqueTy(None)),
345 origin: hir::OpaqueTyOrigin::TypeAlias,
347 hir::ItemKind::OpaqueTy(ty)
350 ItemKind::Enum(ref enum_definition, ref generics) => hir::ItemKind::Enum(
352 variants: self.arena.alloc_from_iter(
353 enum_definition.variants.iter().map(|x| self.lower_variant(x)),
356 self.lower_generics(generics, ImplTraitContext::disallowed()),
358 ItemKind::Struct(ref struct_def, ref generics) => {
359 let struct_def = self.lower_variant_data(struct_def);
360 hir::ItemKind::Struct(
362 self.lower_generics(generics, ImplTraitContext::disallowed()),
365 ItemKind::Union(ref vdata, ref generics) => {
366 let vdata = self.lower_variant_data(vdata);
367 hir::ItemKind::Union(
369 self.lower_generics(generics, ImplTraitContext::disallowed()),
381 let def_id = self.resolver.definitions().local_def_id(id);
383 // Lower the "impl header" first. This ordering is important
384 // for in-band lifetimes! Consider `'a` here:
386 // impl Foo<'a> for u32 {
387 // fn method(&'a self) { .. }
390 // Because we start by lowering the `Foo<'a> for u32`
391 // part, we will add `'a` to the list of generics on
392 // the impl. When we then encounter it later in the
393 // method, it will not be considered an in-band
394 // lifetime to be added, but rather a reference to a
396 let lowered_trait_impl_id = self.lower_node_id(id);
397 let (generics, (trait_ref, lowered_ty)) = self.add_in_band_defs(
400 AnonymousLifetimeMode::CreateParameter,
402 let trait_ref = trait_ref.as_ref().map(|trait_ref| {
403 this.lower_trait_ref(trait_ref, ImplTraitContext::disallowed())
406 if let Some(ref trait_ref) = trait_ref {
407 if let Res::Def(DefKind::Trait, def_id) = trait_ref.path.res {
411 .push(lowered_trait_impl_id);
415 let lowered_ty = this.lower_ty(ty, ImplTraitContext::disallowed());
417 (trait_ref, lowered_ty)
422 self.with_in_scope_lifetime_defs(&ast_generics.params, |this| {
423 this.arena.alloc_from_iter(
424 impl_items.iter().map(|item| this.lower_impl_item_ref(item)),
431 self.lower_defaultness(defaultness, true /* [1] */),
434 self.arena.alloc(lowered_ty.into_inner()),
438 ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref items) => {
439 let bounds = self.lower_param_bounds(bounds, ImplTraitContext::disallowed());
442 .alloc_from_iter(items.iter().map(|item| self.lower_trait_item_ref(item)));
443 hir::ItemKind::Trait(
446 self.lower_generics(generics, ImplTraitContext::disallowed()),
451 ItemKind::TraitAlias(ref generics, ref bounds) => hir::ItemKind::TraitAlias(
452 self.lower_generics(generics, ImplTraitContext::disallowed()),
453 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
455 ItemKind::MacroDef(..) | ItemKind::Mac(..) => {
456 bug!("`TyMac` should have been expanded by now")
460 // [1] `defaultness.has_value()` is never called for an `impl`, always `true` in order to
461 // not cause an assertion failure inside the `lower_defaultness` function.
469 vis: &mut hir::Visibility,
471 attrs: &'hir [Attribute],
472 ) -> hir::ItemKind<'hir> {
473 debug!("lower_use_tree(tree={:?})", tree);
474 debug!("lower_use_tree: vis = {:?}", vis);
476 let path = &tree.prefix;
477 let segments = prefix.segments.iter().chain(path.segments.iter()).cloned().collect();
480 UseTreeKind::Simple(rename, id1, id2) => {
481 *ident = tree.ident();
483 // First, apply the prefix to the path.
484 let mut path = Path { segments, span: path.span };
486 // Correctly resolve `self` imports.
487 if path.segments.len() > 1
488 && path.segments.last().unwrap().ident.name == kw::SelfLower
490 let _ = path.segments.pop();
491 if rename.is_none() {
492 *ident = path.segments.last().unwrap().ident;
496 let mut resolutions = self.expect_full_res_from_use(id);
497 // We want to return *something* from this function, so hold onto the first item
499 let ret_res = self.lower_res(resolutions.next().unwrap_or(Res::Err));
501 // Here, we are looping over namespaces, if they exist for the definition
502 // being imported. We only handle type and value namespaces because we
503 // won't be dealing with macros in the rest of the compiler.
504 // Essentially a single `use` which imports two names is desugared into
506 for (res, &new_node_id) in resolutions.zip([id1, id2].iter()) {
508 let mut path = path.clone();
509 for seg in &mut path.segments {
510 seg.id = self.resolver.next_node_id();
512 let span = path.span;
514 self.with_hir_id_owner(new_node_id, |this| {
515 let new_id = this.lower_node_id(new_node_id);
516 let res = this.lower_res(res);
517 let path = this.lower_path_extra(res, &path, ParamMode::Explicit, None);
518 let kind = hir::ItemKind::Use(this.arena.alloc(path), hir::UseKind::Single);
519 let vis = this.rebuild_vis(&vis);
521 this.insert_item(hir::Item {
532 let path = self.lower_path_extra(ret_res, &path, ParamMode::Explicit, None);
533 let path = self.arena.alloc(path);
534 hir::ItemKind::Use(path, hir::UseKind::Single)
536 UseTreeKind::Glob => {
537 let path = self.arena.alloc(self.lower_path(
539 &Path { segments, span: path.span },
542 hir::ItemKind::Use(path, hir::UseKind::Glob)
544 UseTreeKind::Nested(ref trees) => {
545 // Nested imports are desugared into simple imports.
546 // So, if we start with
549 // pub(x) use foo::{a, b};
552 // we will create three items:
555 // pub(x) use foo::a;
556 // pub(x) use foo::b;
557 // pub(x) use foo::{}; // <-- this is called the `ListStem`
560 // The first two are produced by recursively invoking
561 // `lower_use_tree` (and indeed there may be things
562 // like `use foo::{a::{b, c}}` and so forth). They
563 // wind up being directly added to
564 // `self.items`. However, the structure of this
565 // function also requires us to return one item, and
566 // for that we return the `{}` import (called the
569 let prefix = Path { segments, span: prefix.span.to(path.span) };
571 // Add all the nested `PathListItem`s to the HIR.
572 for &(ref use_tree, id) in trees {
573 let new_hir_id = self.lower_node_id(id);
575 let mut prefix = prefix.clone();
577 // Give the segments new node-ids since they are being cloned.
578 for seg in &mut prefix.segments {
579 seg.id = self.resolver.next_node_id();
582 // Each `use` import is an item and thus are owners of the
583 // names in the path. Up to this point the nested import is
584 // the current owner, since we want each desugared import to
585 // own its own names, we have to adjust the owner before
586 // lowering the rest of the import.
587 self.with_hir_id_owner(id, |this| {
588 let mut vis = this.rebuild_vis(&vis);
589 let mut ident = *ident;
592 this.lower_use_tree(use_tree, &prefix, id, &mut vis, &mut ident, attrs);
594 this.insert_item(hir::Item {
605 // Subtle and a bit hacky: we lower the privacy level
606 // of the list stem to "private" most of the time, but
607 // not for "restricted" paths. The key thing is that
608 // we don't want it to stay as `pub` (with no caveats)
609 // because that affects rustdoc and also the lints
610 // about `pub` items. But we can't *always* make it
611 // private -- particularly not for restricted paths --
612 // because it contains node-ids that would then be
613 // unused, failing the check that HirIds are "densely
616 hir::VisibilityKind::Public
617 | hir::VisibilityKind::Crate(_)
618 | hir::VisibilityKind::Inherited => {
619 *vis = respan(prefix.span.shrink_to_lo(), hir::VisibilityKind::Inherited);
621 hir::VisibilityKind::Restricted { .. } => {
622 // Do nothing here, as described in the comment on the match.
626 let res = self.expect_full_res_from_use(id).next().unwrap_or(Res::Err);
627 let res = self.lower_res(res);
628 let path = self.lower_path_extra(res, &prefix, ParamMode::Explicit, None);
629 let path = self.arena.alloc(path);
630 hir::ItemKind::Use(path, hir::UseKind::ListStem)
635 /// Paths like the visibility path in `pub(super) use foo::{bar, baz}` are repeated
636 /// many times in the HIR tree; for each occurrence, we need to assign distinct
637 /// `NodeId`s. (See, e.g., #56128.)
638 fn rebuild_use_path(&mut self, path: &hir::Path) -> hir::Path {
639 debug!("rebuild_use_path(path = {:?})", path);
643 .map(|seg| hir::PathSegment {
645 hir_id: seg.hir_id.map(|_| self.next_id()),
648 infer_args: seg.infer_args,
651 hir::Path { span: path.span, res: path.res, segments }
654 fn rebuild_vis(&mut self, vis: &hir::Visibility) -> hir::Visibility {
655 let vis_kind = match vis.node {
656 hir::VisibilityKind::Public => hir::VisibilityKind::Public,
657 hir::VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
658 hir::VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
659 hir::VisibilityKind::Restricted { ref path, hir_id: _ } => {
660 hir::VisibilityKind::Restricted {
661 path: P(self.rebuild_use_path(path)),
662 hir_id: self.next_id(),
666 respan(vis.span, vis_kind)
669 fn lower_foreign_item(&mut self, i: &ForeignItem) -> hir::ForeignItem<'hir> {
670 let def_id = self.resolver.definitions().local_def_id(i.id);
672 hir_id: self.lower_node_id(i.id),
674 attrs: self.lower_attrs_arena(&i.attrs),
676 ForeignItemKind::Fn(ref fdec, ref generics) => {
677 let (generics, (fn_dec, fn_args)) = self.add_in_band_defs(
680 AnonymousLifetimeMode::PassThrough,
683 // Disallow `impl Trait` in foreign items.
684 this.lower_fn_decl(fdec, None, false, None),
685 this.lower_fn_params_to_names(fdec),
689 let fn_dec = self.arena.alloc(fn_dec.into_inner());
690 let fn_args = self.arena.alloc_from_iter(fn_args.into_iter());
692 hir::ForeignItemKind::Fn(fn_dec, fn_args, generics)
694 ForeignItemKind::Static(ref t, m) => {
695 let ty = self.lower_ty(t, ImplTraitContext::disallowed());
696 hir::ForeignItemKind::Static(self.arena.alloc(ty.into_inner()), m)
698 ForeignItemKind::Ty => hir::ForeignItemKind::Type,
699 ForeignItemKind::Macro(_) => panic!("macro shouldn't exist here"),
701 vis: self.lower_visibility(&i.vis, None),
706 fn lower_foreign_mod(&mut self, fm: &ForeignMod) -> hir::ForeignMod<'hir> {
708 abi: fm.abi.map_or(abi::Abi::C, |abi| self.lower_abi(abi)),
709 items: self.arena.alloc_from_iter(fm.items.iter().map(|x| self.lower_foreign_item(x))),
713 fn lower_global_asm(&mut self, ga: &GlobalAsm) -> &'hir hir::GlobalAsm {
714 self.arena.alloc(hir::GlobalAsm { asm: ga.asm })
717 fn lower_variant(&mut self, v: &Variant) -> hir::Variant<'hir> {
719 attrs: self.lower_attrs_arena(&v.attrs),
720 data: self.lower_variant_data(&v.data),
721 disr_expr: v.disr_expr.as_ref().map(|e| self.lower_anon_const(e)),
722 id: self.lower_node_id(v.id),
728 fn lower_variant_data(&mut self, vdata: &VariantData) -> hir::VariantData<'hir> {
730 VariantData::Struct(ref fields, recovered) => hir::VariantData::Struct(
732 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
735 VariantData::Tuple(ref fields, id) => hir::VariantData::Tuple(
737 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
738 self.lower_node_id(id),
740 VariantData::Unit(id) => hir::VariantData::Unit(self.lower_node_id(id)),
744 fn lower_struct_field(&mut self, (index, f): (usize, &StructField)) -> hir::StructField<'hir> {
745 let ty = if let TyKind::Path(ref qself, ref path) = f.ty.kind {
746 let t = self.lower_path_ty(
750 ParamMode::ExplicitNamed, // no `'_` in declarations (Issue #61124)
751 ImplTraitContext::disallowed(),
755 let t = self.lower_ty(&f.ty, ImplTraitContext::disallowed());
756 self.arena.alloc(t.into_inner())
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),
766 vis: self.lower_visibility(&f.vis, None),
768 attrs: self.lower_attrs_arena(&f.attrs),
772 fn lower_trait_item(&mut self, i: &AssocItem) -> hir::TraitItem<'hir> {
773 let trait_item_def_id = self.resolver.definitions().local_def_id(i.id);
775 let (generics, kind) = match i.kind {
776 AssocItemKind::Const(ref ty, ref default) => {
777 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
778 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
779 let ty = self.arena.alloc(ty.into_inner());
782 hir::TraitItemKind::Const(
784 default.as_ref().map(|x| self.lower_const_body(i.span, Some(x))),
788 AssocItemKind::Fn(ref sig, None) => {
789 let names = self.lower_fn_params_to_names(&sig.decl);
790 let (generics, sig) =
791 self.lower_method_sig(&i.generics, sig, trait_item_def_id, false, None);
792 (generics, hir::TraitItemKind::Method(sig, hir::TraitMethod::Required(names)))
794 AssocItemKind::Fn(ref sig, Some(ref body)) => {
795 let body_id = self.lower_fn_body_block(i.span, &sig.decl, Some(body));
796 let (generics, sig) =
797 self.lower_method_sig(&i.generics, sig, trait_item_def_id, false, None);
798 (generics, hir::TraitItemKind::Method(sig, hir::TraitMethod::Provided(body_id)))
800 AssocItemKind::TyAlias(ref bounds, ref default) => {
801 let ty = default.as_ref().map(|x| {
804 .alloc(self.lower_ty(x, ImplTraitContext::disallowed()).into_inner())
806 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
807 let kind = hir::TraitItemKind::Type(
808 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
814 AssocItemKind::Macro(..) => bug!("macro item shouldn't exist at this point"),
818 hir_id: self.lower_node_id(i.id),
820 attrs: self.lower_attrs_arena(&i.attrs),
827 fn lower_trait_item_ref(&mut self, i: &AssocItem) -> hir::TraitItemRef {
828 let (kind, has_default) = match i.kind {
829 AssocItemKind::Const(_, ref default) => (hir::AssocItemKind::Const, default.is_some()),
830 AssocItemKind::TyAlias(_, ref default) => (hir::AssocItemKind::Type, default.is_some()),
831 AssocItemKind::Fn(ref sig, ref default) => {
832 (hir::AssocItemKind::Method { has_self: sig.decl.has_self() }, default.is_some())
834 AssocItemKind::Macro(..) => unimplemented!(),
837 id: hir::TraitItemId { hir_id: self.lower_node_id(i.id) },
840 defaultness: self.lower_defaultness(Defaultness::Default, has_default),
845 /// Construct `ExprKind::Err` for the given `span`.
846 fn expr_err(&mut self, span: Span) -> hir::Expr<'hir> {
847 self.expr(span, hir::ExprKind::Err, AttrVec::new())
850 fn lower_impl_item(&mut self, i: &AssocItem) -> hir::ImplItem<'hir> {
851 let impl_item_def_id = self.resolver.definitions().local_def_id(i.id);
853 let (generics, kind) = match i.kind {
854 AssocItemKind::Const(ref ty, ref expr) => {
855 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
856 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
857 let ty = self.arena.alloc(ty.into_inner());
860 hir::ImplItemKind::Const(ty, self.lower_const_body(i.span, expr.as_deref())),
863 AssocItemKind::Fn(ref sig, ref body) => {
864 self.current_item = Some(i.span);
865 let body_id = self.lower_maybe_async_body(
868 sig.header.asyncness.node,
871 let impl_trait_return_allow = !self.is_in_trait_impl;
872 let (generics, sig) = self.lower_method_sig(
876 impl_trait_return_allow,
877 sig.header.asyncness.node.opt_return_id(),
880 (generics, hir::ImplItemKind::Method(sig, body_id))
882 AssocItemKind::TyAlias(_, ref ty) => {
883 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
884 let kind = match ty {
886 let ty = self.arena.alloc(self.ty(i.span, hir::TyKind::Err));
887 hir::ImplItemKind::TyAlias(ty)
889 Some(ty) => match ty.kind.opaque_top_hack() {
891 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
892 let ty = self.arena.alloc(ty.into_inner());
893 hir::ImplItemKind::TyAlias(ty)
896 let bs = self.lower_param_bounds(bs, ImplTraitContext::disallowed());
897 hir::ImplItemKind::OpaqueTy(bs)
903 AssocItemKind::Macro(..) => bug!("`TyMac` should have been expanded by now"),
907 hir_id: self.lower_node_id(i.id),
909 attrs: self.lower_attrs_arena(&i.attrs),
911 vis: self.lower_visibility(&i.vis, None),
912 defaultness: self.lower_defaultness(i.defaultness, true /* [1] */),
917 // [1] since `default impl` is not yet implemented, this is always true in impls
920 fn lower_impl_item_ref(&mut self, i: &AssocItem) -> hir::ImplItemRef {
922 id: hir::ImplItemId { hir_id: self.lower_node_id(i.id) },
925 vis: self.lower_visibility(&i.vis, Some(i.id)),
926 defaultness: self.lower_defaultness(i.defaultness, true /* [1] */),
927 kind: match &i.kind {
928 AssocItemKind::Const(..) => hir::AssocItemKind::Const,
929 AssocItemKind::TyAlias(_, ty) => {
930 match ty.as_deref().and_then(|ty| ty.kind.opaque_top_hack()) {
931 None => hir::AssocItemKind::Type,
932 Some(_) => hir::AssocItemKind::OpaqueTy,
935 AssocItemKind::Fn(sig, _) => {
936 hir::AssocItemKind::Method { has_self: sig.decl.has_self() }
938 AssocItemKind::Macro(..) => unimplemented!(),
942 // [1] since `default impl` is not yet implemented, this is always true in impls
945 /// If an `explicit_owner` is given, this method allocates the `HirId` in
946 /// the address space of that item instead of the item currently being
947 /// lowered. This can happen during `lower_impl_item_ref()` where we need to
948 /// lower a `Visibility` value although we haven't lowered the owning
949 /// `ImplItem` in question yet.
953 explicit_owner: Option<NodeId>,
954 ) -> hir::Visibility {
955 let node = match v.node {
956 VisibilityKind::Public => hir::VisibilityKind::Public,
957 VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
958 VisibilityKind::Restricted { ref path, id } => {
959 debug!("lower_visibility: restricted path id = {:?}", id);
960 let lowered_id = if let Some(owner) = explicit_owner {
961 self.lower_node_id_with_owner(id, owner)
963 self.lower_node_id(id)
965 let res = self.expect_full_res(id);
966 let res = self.lower_res(res);
967 hir::VisibilityKind::Restricted {
968 path: P(self.lower_path_extra(res, path, ParamMode::Explicit, explicit_owner)),
972 VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
977 fn lower_defaultness(&self, d: Defaultness, has_value: bool) -> hir::Defaultness {
979 Defaultness::Default => hir::Defaultness::Default { has_value: has_value },
980 Defaultness::Final => {
982 hir::Defaultness::Final
989 params: &'hir [hir::Param<'hir>],
990 value: hir::Expr<'hir>,
992 let body = hir::Body { generator_kind: self.generator_kind, params, value };
994 self.bodies.insert(id, body);
1000 f: impl FnOnce(&mut Self) -> (&'hir [hir::Param<'hir>], hir::Expr<'hir>),
1002 let prev_gen_kind = self.generator_kind.take();
1003 let (parameters, result) = f(self);
1004 let body_id = self.record_body(parameters, result);
1005 self.generator_kind = prev_gen_kind;
1009 fn lower_param(&mut self, param: &Param) -> hir::Param<'hir> {
1011 attrs: self.lower_attrs_arena(¶m.attrs),
1012 hir_id: self.lower_node_id(param.id),
1013 pat: self.lower_pat(¶m.pat),
1018 pub(super) fn lower_fn_body(
1021 body: impl FnOnce(&mut Self) -> hir::Expr<'hir>,
1023 self.lower_body(|this| {
1025 this.arena.alloc_from_iter(decl.inputs.iter().map(|x| this.lower_param(x))),
1031 fn lower_fn_body_block(
1035 body: Option<&Block>,
1037 self.lower_fn_body(decl, |this| this.lower_block_expr_opt(span, body))
1040 fn lower_block_expr_opt(&mut self, span: Span, block: Option<&Block>) -> hir::Expr<'hir> {
1042 Some(block) => self.lower_block_expr(block),
1043 None => self.expr_err(span),
1047 pub(super) fn lower_const_body(&mut self, span: Span, expr: Option<&Expr>) -> hir::BodyId {
1048 self.lower_body(|this| {
1052 Some(expr) => this.lower_expr_mut(expr),
1053 None => this.expr_err(span),
1059 fn lower_maybe_async_body(
1064 body: Option<&Block>,
1066 let closure_id = match asyncness {
1067 IsAsync::Async { closure_id, .. } => closure_id,
1068 IsAsync::NotAsync => return self.lower_fn_body_block(span, decl, body),
1071 self.lower_body(|this| {
1072 let mut parameters: Vec<hir::Param<'_>> = Vec::new();
1073 let mut statements: Vec<hir::Stmt<'_>> = Vec::new();
1075 // Async function parameters are lowered into the closure body so that they are
1076 // captured and so that the drop order matches the equivalent non-async functions.
1080 // async fn foo(<pattern>: <ty>, <pattern>: <ty>, <pattern>: <ty>) {
1086 // fn foo(__arg0: <ty>, __arg1: <ty>, __arg2: <ty>) {
1088 // let __arg2 = __arg2;
1089 // let <pattern> = __arg2;
1090 // let __arg1 = __arg1;
1091 // let <pattern> = __arg1;
1092 // let __arg0 = __arg0;
1093 // let <pattern> = __arg0;
1094 // drop-temps { <body> } // see comments later in fn for details
1098 // If `<pattern>` is a simple ident, then it is lowered to a single
1099 // `let <pattern> = <pattern>;` statement as an optimization.
1101 // Note that the body is embedded in `drop-temps`; an
1102 // equivalent desugaring would be `return { <body>
1103 // };`. The key point is that we wish to drop all the
1104 // let-bound variables and temporaries created in the body
1105 // (and its tail expression!) before we drop the
1106 // parameters (c.f. rust-lang/rust#64512).
1107 for (index, parameter) in decl.inputs.iter().enumerate() {
1108 let parameter = this.lower_param(parameter);
1109 let span = parameter.pat.span;
1111 // Check if this is a binding pattern, if so, we can optimize and avoid adding a
1112 // `let <pat> = __argN;` statement. In this case, we do not rename the parameter.
1113 let (ident, is_simple_parameter) = match parameter.pat.kind {
1114 hir::PatKind::Binding(hir::BindingAnnotation::Unannotated, _, ident, _) => {
1118 // Replace the ident for bindings that aren't simple.
1119 let name = format!("__arg{}", index);
1120 let ident = Ident::from_str(&name);
1126 let desugared_span = this.mark_span_with_reason(DesugaringKind::Async, span, None);
1128 // Construct a parameter representing `__argN: <ty>` to replace the parameter of the
1131 // If this is the simple case, this parameter will end up being the same as the
1132 // original parameter, but with a different pattern id.
1133 let mut stmt_attrs = AttrVec::new();
1134 stmt_attrs.extend(parameter.attrs.iter().cloned());
1135 let (new_parameter_pat, new_parameter_id) = this.pat_ident(desugared_span, ident);
1136 let new_parameter = hir::Param {
1137 attrs: parameter.attrs,
1138 hir_id: parameter.hir_id,
1139 pat: new_parameter_pat,
1140 span: parameter.span,
1143 if is_simple_parameter {
1144 // If this is the simple case, then we only insert one statement that is
1145 // `let <pat> = <pat>;`. We re-use the original argument's pattern so that
1146 // `HirId`s are densely assigned.
1147 let expr = this.expr_ident(desugared_span, ident, new_parameter_id);
1148 let stmt = this.stmt_let_pat(
1151 Some(this.arena.alloc(expr)),
1153 hir::LocalSource::AsyncFn,
1155 statements.push(stmt);
1157 // If this is not the simple case, then we construct two statements:
1160 // let __argN = __argN;
1161 // let <pat> = __argN;
1164 // The first statement moves the parameter into the closure and thus ensures
1165 // that the drop order is correct.
1167 // The second statement creates the bindings that the user wrote.
1169 // Construct the `let mut __argN = __argN;` statement. It must be a mut binding
1170 // because the user may have specified a `ref mut` binding in the next
1172 let (move_pat, move_id) = this.pat_ident_binding_mode(
1175 hir::BindingAnnotation::Mutable,
1177 let move_expr = this.expr_ident(desugared_span, ident, new_parameter_id);
1178 let move_stmt = this.stmt_let_pat(
1181 Some(this.arena.alloc(move_expr)),
1183 hir::LocalSource::AsyncFn,
1186 // Construct the `let <pat> = __argN;` statement. We re-use the original
1187 // parameter's pattern so that `HirId`s are densely assigned.
1188 let pattern_expr = this.expr_ident(desugared_span, ident, move_id);
1189 let pattern_stmt = this.stmt_let_pat(
1192 Some(this.arena.alloc(pattern_expr)),
1194 hir::LocalSource::AsyncFn,
1197 statements.push(move_stmt);
1198 statements.push(pattern_stmt);
1201 parameters.push(new_parameter);
1204 let body_span = body.map_or(span, |b| b.span);
1205 let async_expr = this.make_async_expr(
1210 hir::AsyncGeneratorKind::Fn,
1212 // Create a block from the user's function body:
1213 let user_body = this.lower_block_expr_opt(body_span, body);
1215 // Transform into `drop-temps { <user-body> }`, an expression:
1216 let desugared_span =
1217 this.mark_span_with_reason(DesugaringKind::Async, user_body.span, None);
1218 let user_body = this.expr_drop_temps(
1220 this.arena.alloc(user_body),
1224 // As noted above, create the final block like
1228 // let $param_pattern = $raw_param;
1230 // drop-temps { <user-body> }
1233 let body = this.block_all(
1235 this.arena.alloc_from_iter(statements),
1239 this.expr_block(body, AttrVec::new())
1244 this.arena.alloc_from_iter(parameters),
1245 this.expr(body_span, async_expr, AttrVec::new()),
1250 fn lower_method_sig(
1252 generics: &Generics,
1255 impl_trait_return_allow: bool,
1256 is_async: Option<NodeId>,
1257 ) -> (hir::Generics, hir::FnSig<'hir>) {
1258 let header = self.lower_fn_header(sig.header);
1259 let (generics, decl) = self.add_in_band_defs(
1262 AnonymousLifetimeMode::PassThrough,
1266 Some((fn_def_id, idty)),
1267 impl_trait_return_allow,
1272 let decl = self.arena.alloc(decl.into_inner());
1273 (generics, hir::FnSig { header, decl })
1276 fn lower_fn_header(&mut self, h: FnHeader) -> hir::FnHeader {
1278 unsafety: h.unsafety,
1279 asyncness: self.lower_asyncness(h.asyncness.node),
1280 constness: h.constness.node,
1281 abi: self.lower_extern(h.ext),
1285 pub(super) fn lower_abi(&mut self, abi: StrLit) -> abi::Abi {
1286 abi::lookup(&abi.symbol_unescaped.as_str()).unwrap_or_else(|| {
1287 self.error_on_invalid_abi(abi);
1292 pub(super) fn lower_extern(&mut self, ext: Extern) -> abi::Abi {
1294 Extern::None => abi::Abi::Rust,
1295 Extern::Implicit => abi::Abi::C,
1296 Extern::Explicit(abi) => self.lower_abi(abi),
1300 fn error_on_invalid_abi(&self, abi: StrLit) {
1301 struct_span_err!(self.sess, abi.span, E0703, "invalid ABI: found `{}`", abi.symbol)
1302 .span_label(abi.span, "invalid ABI")
1303 .help(&format!("valid ABIs: {}", abi::all_names().join(", ")))
1307 fn lower_asyncness(&mut self, a: IsAsync) -> hir::IsAsync {
1309 IsAsync::Async { .. } => hir::IsAsync::Async,
1310 IsAsync::NotAsync => hir::IsAsync::NotAsync,
1314 pub(super) fn lower_generics(
1316 generics: &Generics,
1317 itctx: ImplTraitContext<'_>,
1318 ) -> hir::Generics {
1319 // Collect `?Trait` bounds in where clause and move them to parameter definitions.
1320 // FIXME: this could probably be done with less rightward drift. It also looks like two
1321 // control paths where `report_error` is called are the only paths that advance to after the
1322 // match statement, so the error reporting could probably just be moved there.
1323 let mut add_bounds: NodeMap<Vec<_>> = Default::default();
1324 for pred in &generics.where_clause.predicates {
1325 if let WherePredicate::BoundPredicate(ref bound_pred) = *pred {
1326 'next_bound: for bound in &bound_pred.bounds {
1327 if let GenericBound::Trait(_, TraitBoundModifier::Maybe) = *bound {
1328 let report_error = |this: &mut Self| {
1329 this.diagnostic().span_err(
1330 bound_pred.bounded_ty.span,
1331 "`?Trait` bounds are only permitted at the \
1332 point where a type parameter is declared",
1335 // Check if the where clause type is a plain type parameter.
1336 match bound_pred.bounded_ty.kind {
1337 TyKind::Path(None, ref path)
1338 if path.segments.len() == 1
1339 && bound_pred.bound_generic_params.is_empty() =>
1341 if let Some(Res::Def(DefKind::TyParam, def_id)) = self
1343 .get_partial_res(bound_pred.bounded_ty.id)
1344 .map(|d| d.base_res())
1346 if let Some(node_id) =
1347 self.resolver.definitions().as_local_node_id(def_id)
1349 for param in &generics.params {
1351 GenericParamKind::Type { .. } => {
1352 if node_id == param.id {
1356 .push(bound.clone());
1357 continue 'next_bound;
1367 _ => report_error(self),
1375 params: self.lower_generic_params(&generics.params, &add_bounds, itctx),
1376 where_clause: self.lower_where_clause(&generics.where_clause),
1377 span: generics.span,
1381 fn lower_where_clause(&mut self, wc: &WhereClause) -> hir::WhereClause {
1382 self.with_anonymous_lifetime_mode(AnonymousLifetimeMode::ReportError, |this| {
1387 .map(|predicate| this.lower_where_predicate(predicate))
1394 fn lower_where_predicate(&mut self, pred: &WherePredicate) -> hir::WherePredicate {
1396 WherePredicate::BoundPredicate(WhereBoundPredicate {
1397 ref bound_generic_params,
1402 self.with_in_scope_lifetime_defs(&bound_generic_params, |this| {
1403 hir::WherePredicate::BoundPredicate(hir::WhereBoundPredicate {
1404 bound_generic_params: this.lower_generic_params(
1405 bound_generic_params,
1406 &NodeMap::default(),
1407 ImplTraitContext::disallowed(),
1409 bounded_ty: this.lower_ty(bounded_ty, ImplTraitContext::disallowed()),
1412 .filter_map(|bound| match *bound {
1413 // Ignore `?Trait` bounds.
1414 // They were copied into type parameters already.
1415 GenericBound::Trait(_, TraitBoundModifier::Maybe) => None,
1417 this.lower_param_bound(bound, ImplTraitContext::disallowed()),
1425 WherePredicate::RegionPredicate(WhereRegionPredicate {
1429 }) => hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate {
1431 lifetime: self.lower_lifetime(lifetime),
1432 bounds: self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
1434 WherePredicate::EqPredicate(WhereEqPredicate { id, ref lhs_ty, ref rhs_ty, span }) => {
1435 hir::WherePredicate::EqPredicate(hir::WhereEqPredicate {
1436 hir_id: self.lower_node_id(id),
1437 lhs_ty: self.lower_ty(lhs_ty, ImplTraitContext::disallowed()),
1438 rhs_ty: self.lower_ty(rhs_ty, ImplTraitContext::disallowed()),