1 use super::{AnonymousLifetimeMode, LoweringContext, ParamMode};
2 use super::{ImplTraitContext, ImplTraitPosition, ImplTraitTypeIdVisitor};
4 use rustc::arena::Arena;
6 use rustc_error_codes::*;
7 use rustc_errors::struct_span_err;
9 use rustc_hir::def::{DefKind, Res};
10 use rustc_hir::def_id::DefId;
11 use rustc_session::node_id::NodeMap;
12 use rustc_span::source_map::{respan, DesugaringKind};
13 use rustc_span::symbol::{kw, sym};
15 use rustc_target::spec::abi;
18 use syntax::visit::{self, Visitor};
21 use smallvec::{smallvec, SmallVec};
22 use std::collections::BTreeSet;
24 pub(super) struct ItemLowerer<'a, 'lowering, 'hir> {
25 pub(super) lctx: &'a mut LoweringContext<'lowering, 'hir>,
28 impl ItemLowerer<'_, '_, '_> {
29 fn with_trait_impl_ref(&mut self, impl_ref: &Option<TraitRef>, f: impl FnOnce(&mut Self)) {
30 let old = self.lctx.is_in_trait_impl;
31 self.lctx.is_in_trait_impl = if let &None = impl_ref { false } else { true };
33 self.lctx.is_in_trait_impl = old;
37 impl<'a> Visitor<'a> for ItemLowerer<'a, '_, '_> {
38 fn visit_mod(&mut self, m: &'a Mod, _s: Span, _attrs: &[Attribute], n: NodeId) {
39 let hir_id = self.lctx.lower_node_id(n);
41 self.lctx.modules.insert(
44 items: BTreeSet::new(),
45 trait_items: BTreeSet::new(),
46 impl_items: BTreeSet::new(),
50 let old = self.lctx.current_module;
51 self.lctx.current_module = hir_id;
52 visit::walk_mod(self, m);
53 self.lctx.current_module = old;
56 fn visit_item(&mut self, item: &'a Item) {
57 let mut item_hir_id = None;
58 self.lctx.with_hir_id_owner(item.id, |lctx| {
59 lctx.without_in_scope_lifetime_defs(|lctx| {
60 if let Some(hir_item) = lctx.lower_item(item) {
61 item_hir_id = Some(hir_item.hir_id);
62 lctx.insert_item(hir_item);
67 if let Some(hir_id) = item_hir_id {
68 self.lctx.with_parent_item_lifetime_defs(hir_id, |this| {
69 let this = &mut ItemLowerer { lctx: this };
70 if let ItemKind::Impl { constness, ref of_trait, .. } = item.kind {
71 if constness == Constness::Const {
74 .span_err(item.span, "const trait impls are not yet implemented");
77 this.with_trait_impl_ref(of_trait, |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 { of_trait: 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(&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<'hir>,
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(ty, m, self.lower_const_body(span, Some(e)))
283 ItemKind::Const(ref t, ref e) => {
284 let ty = self.lower_ty(
286 if self.sess.features_untracked().impl_trait_in_bindings {
287 ImplTraitContext::OpaqueTy(None)
289 ImplTraitContext::Disallowed(ImplTraitPosition::Binding)
292 hir::ItemKind::Const(ty, self.lower_const_body(span, Some(e)))
294 ItemKind::Fn(FnSig { ref decl, header }, ref generics, ref body) => {
295 let fn_def_id = self.resolver.definitions().local_def_id(id);
296 self.with_new_scopes(|this| {
297 this.current_item = Some(ident.span);
299 // Note: we don't need to change the return type from `T` to
300 // `impl Future<Output = T>` here because lower_body
301 // only cares about the input argument patterns in the function
302 // declaration (decl), not the return types.
304 this.lower_maybe_async_body(span, &decl, header.asyncness.node, Some(body));
306 let (generics, decl) = this.add_in_band_defs(
309 AnonymousLifetimeMode::PassThrough,
313 Some((fn_def_id, idty)),
315 header.asyncness.node.opt_return_id(),
319 let sig = hir::FnSig { decl, header: this.lower_fn_header(header) };
320 hir::ItemKind::Fn(sig, generics, body_id)
323 ItemKind::Mod(ref m) => hir::ItemKind::Mod(self.lower_mod(m)),
324 ItemKind::ForeignMod(ref nm) => hir::ItemKind::ForeignMod(self.lower_foreign_mod(nm)),
325 ItemKind::GlobalAsm(ref ga) => hir::ItemKind::GlobalAsm(self.lower_global_asm(ga)),
326 ItemKind::TyAlias(ref ty, ref generics) => match ty.kind.opaque_top_hack() {
328 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
329 let generics = self.lower_generics(generics, ImplTraitContext::disallowed());
330 hir::ItemKind::TyAlias(ty, generics)
333 let ty = hir::OpaqueTy {
334 generics: self.lower_generics(generics, ImplTraitContext::OpaqueTy(None)),
335 bounds: self.lower_param_bounds(bounds, ImplTraitContext::OpaqueTy(None)),
337 origin: hir::OpaqueTyOrigin::TypeAlias,
339 hir::ItemKind::OpaqueTy(ty)
342 ItemKind::Enum(ref enum_definition, ref generics) => hir::ItemKind::Enum(
344 variants: self.arena.alloc_from_iter(
345 enum_definition.variants.iter().map(|x| self.lower_variant(x)),
348 self.lower_generics(generics, ImplTraitContext::disallowed()),
350 ItemKind::Struct(ref struct_def, ref generics) => {
351 let struct_def = self.lower_variant_data(struct_def);
352 hir::ItemKind::Struct(
354 self.lower_generics(generics, ImplTraitContext::disallowed()),
357 ItemKind::Union(ref vdata, ref generics) => {
358 let vdata = self.lower_variant_data(vdata);
359 hir::ItemKind::Union(
361 self.lower_generics(generics, ImplTraitContext::disallowed()),
369 generics: ref ast_generics,
370 of_trait: ref trait_ref,
372 items: ref impl_items,
374 let def_id = self.resolver.definitions().local_def_id(id);
376 // Lower the "impl header" first. This ordering is important
377 // for in-band lifetimes! Consider `'a` here:
379 // impl Foo<'a> for u32 {
380 // fn method(&'a self) { .. }
383 // Because we start by lowering the `Foo<'a> for u32`
384 // part, we will add `'a` to the list of generics on
385 // the impl. When we then encounter it later in the
386 // method, it will not be considered an in-band
387 // lifetime to be added, but rather a reference to a
389 let lowered_trait_impl_id = self.lower_node_id(id);
390 let (generics, (trait_ref, lowered_ty)) = self.add_in_band_defs(
393 AnonymousLifetimeMode::CreateParameter,
395 let trait_ref = trait_ref.as_ref().map(|trait_ref| {
396 this.lower_trait_ref(trait_ref, ImplTraitContext::disallowed())
399 if let Some(ref trait_ref) = trait_ref {
400 if let Res::Def(DefKind::Trait, def_id) = trait_ref.path.res {
404 .push(lowered_trait_impl_id);
408 let lowered_ty = this.lower_ty(ty, ImplTraitContext::disallowed());
410 (trait_ref, lowered_ty)
415 self.with_in_scope_lifetime_defs(&ast_generics.params, |this| {
416 this.arena.alloc_from_iter(
417 impl_items.iter().map(|item| this.lower_impl_item_ref(item)),
421 hir::ItemKind::Impl {
424 defaultness: self.lower_defaultness(defaultness, true /* [1] */),
429 items: new_impl_items,
432 ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref items) => {
433 let bounds = self.lower_param_bounds(bounds, ImplTraitContext::disallowed());
436 .alloc_from_iter(items.iter().map(|item| self.lower_trait_item_ref(item)));
437 hir::ItemKind::Trait(
440 self.lower_generics(generics, ImplTraitContext::disallowed()),
445 ItemKind::TraitAlias(ref generics, ref bounds) => hir::ItemKind::TraitAlias(
446 self.lower_generics(generics, ImplTraitContext::disallowed()),
447 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
449 ItemKind::MacroDef(..) | ItemKind::Mac(..) => {
450 bug!("`TyMac` should have been expanded by now")
454 // [1] `defaultness.has_value()` is never called for an `impl`, always `true` in order to
455 // not cause an assertion failure inside the `lower_defaultness` function.
463 vis: &mut hir::Visibility<'hir>,
465 attrs: &'hir [Attribute],
466 ) -> hir::ItemKind<'hir> {
467 debug!("lower_use_tree(tree={:?})", tree);
468 debug!("lower_use_tree: vis = {:?}", vis);
470 let path = &tree.prefix;
471 let segments = prefix.segments.iter().chain(path.segments.iter()).cloned().collect();
474 UseTreeKind::Simple(rename, id1, id2) => {
475 *ident = tree.ident();
477 // First, apply the prefix to the path.
478 let mut path = Path { segments, span: path.span };
480 // Correctly resolve `self` imports.
481 if path.segments.len() > 1
482 && path.segments.last().unwrap().ident.name == kw::SelfLower
484 let _ = path.segments.pop();
485 if rename.is_none() {
486 *ident = path.segments.last().unwrap().ident;
490 let mut resolutions = self.expect_full_res_from_use(id);
491 // We want to return *something* from this function, so hold onto the first item
493 let ret_res = self.lower_res(resolutions.next().unwrap_or(Res::Err));
495 // Here, we are looping over namespaces, if they exist for the definition
496 // being imported. We only handle type and value namespaces because we
497 // won't be dealing with macros in the rest of the compiler.
498 // Essentially a single `use` which imports two names is desugared into
500 for (res, &new_node_id) in resolutions.zip([id1, id2].iter()) {
502 let mut path = path.clone();
503 for seg in &mut path.segments {
504 seg.id = self.resolver.next_node_id();
506 let span = path.span;
508 self.with_hir_id_owner(new_node_id, |this| {
509 let new_id = this.lower_node_id(new_node_id);
510 let res = this.lower_res(res);
511 let path = this.lower_path_extra(res, &path, ParamMode::Explicit, None);
512 let kind = hir::ItemKind::Use(path, hir::UseKind::Single);
513 let vis = this.rebuild_vis(&vis);
515 this.insert_item(hir::Item {
526 let path = self.lower_path_extra(ret_res, &path, ParamMode::Explicit, None);
527 hir::ItemKind::Use(path, hir::UseKind::Single)
529 UseTreeKind::Glob => {
531 self.lower_path(id, &Path { segments, span: path.span }, ParamMode::Explicit);
532 hir::ItemKind::Use(path, hir::UseKind::Glob)
534 UseTreeKind::Nested(ref trees) => {
535 // Nested imports are desugared into simple imports.
536 // So, if we start with
539 // pub(x) use foo::{a, b};
542 // we will create three items:
545 // pub(x) use foo::a;
546 // pub(x) use foo::b;
547 // pub(x) use foo::{}; // <-- this is called the `ListStem`
550 // The first two are produced by recursively invoking
551 // `lower_use_tree` (and indeed there may be things
552 // like `use foo::{a::{b, c}}` and so forth). They
553 // wind up being directly added to
554 // `self.items`. However, the structure of this
555 // function also requires us to return one item, and
556 // for that we return the `{}` import (called the
559 let prefix = Path { segments, span: prefix.span.to(path.span) };
561 // Add all the nested `PathListItem`s to the HIR.
562 for &(ref use_tree, id) in trees {
563 let new_hir_id = self.lower_node_id(id);
565 let mut prefix = prefix.clone();
567 // Give the segments new node-ids since they are being cloned.
568 for seg in &mut prefix.segments {
569 seg.id = self.resolver.next_node_id();
572 // Each `use` import is an item and thus are owners of the
573 // names in the path. Up to this point the nested import is
574 // the current owner, since we want each desugared import to
575 // own its own names, we have to adjust the owner before
576 // lowering the rest of the import.
577 self.with_hir_id_owner(id, |this| {
578 let mut vis = this.rebuild_vis(&vis);
579 let mut ident = *ident;
582 this.lower_use_tree(use_tree, &prefix, id, &mut vis, &mut ident, attrs);
584 this.insert_item(hir::Item {
595 // Subtle and a bit hacky: we lower the privacy level
596 // of the list stem to "private" most of the time, but
597 // not for "restricted" paths. The key thing is that
598 // we don't want it to stay as `pub` (with no caveats)
599 // because that affects rustdoc and also the lints
600 // about `pub` items. But we can't *always* make it
601 // private -- particularly not for restricted paths --
602 // because it contains node-ids that would then be
603 // unused, failing the check that HirIds are "densely
606 hir::VisibilityKind::Public
607 | hir::VisibilityKind::Crate(_)
608 | hir::VisibilityKind::Inherited => {
609 *vis = respan(prefix.span.shrink_to_lo(), hir::VisibilityKind::Inherited);
611 hir::VisibilityKind::Restricted { .. } => {
612 // Do nothing here, as described in the comment on the match.
616 let res = self.expect_full_res_from_use(id).next().unwrap_or(Res::Err);
617 let res = self.lower_res(res);
618 let path = self.lower_path_extra(res, &prefix, ParamMode::Explicit, None);
619 hir::ItemKind::Use(path, hir::UseKind::ListStem)
624 /// Paths like the visibility path in `pub(super) use foo::{bar, baz}` are repeated
625 /// many times in the HIR tree; for each occurrence, we need to assign distinct
626 /// `NodeId`s. (See, e.g., #56128.)
627 fn rebuild_use_path(&mut self, path: &hir::Path<'hir>) -> &'hir hir::Path<'hir> {
628 debug!("rebuild_use_path(path = {:?})", path);
630 self.arena.alloc_from_iter(path.segments.iter().map(|seg| hir::PathSegment {
632 hir_id: seg.hir_id.map(|_| self.next_id()),
635 infer_args: seg.infer_args,
637 self.arena.alloc(hir::Path { span: path.span, res: path.res, segments })
640 fn rebuild_vis(&mut self, vis: &hir::Visibility<'hir>) -> hir::Visibility<'hir> {
641 let vis_kind = match vis.node {
642 hir::VisibilityKind::Public => hir::VisibilityKind::Public,
643 hir::VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
644 hir::VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
645 hir::VisibilityKind::Restricted { ref path, hir_id: _ } => {
646 hir::VisibilityKind::Restricted {
647 path: self.rebuild_use_path(path),
648 hir_id: self.next_id(),
652 respan(vis.span, vis_kind)
655 fn lower_foreign_item(&mut self, i: &ForeignItem) -> hir::ForeignItem<'hir> {
656 let def_id = self.resolver.definitions().local_def_id(i.id);
658 hir_id: self.lower_node_id(i.id),
660 attrs: self.lower_attrs(&i.attrs),
662 ForeignItemKind::Fn(ref fdec, ref generics) => {
663 let (generics, (fn_dec, fn_args)) = self.add_in_band_defs(
666 AnonymousLifetimeMode::PassThrough,
669 // Disallow `impl Trait` in foreign items.
670 this.lower_fn_decl(fdec, None, false, None),
671 this.lower_fn_params_to_names(fdec),
676 hir::ForeignItemKind::Fn(fn_dec, fn_args, generics)
678 ForeignItemKind::Static(ref t, m) => {
679 let ty = self.lower_ty(t, ImplTraitContext::disallowed());
680 hir::ForeignItemKind::Static(ty, m)
682 ForeignItemKind::Ty => hir::ForeignItemKind::Type,
683 ForeignItemKind::Macro(_) => panic!("macro shouldn't exist here"),
685 vis: self.lower_visibility(&i.vis, None),
690 fn lower_foreign_mod(&mut self, fm: &ForeignMod) -> hir::ForeignMod<'hir> {
692 abi: fm.abi.map_or(abi::Abi::C, |abi| self.lower_abi(abi)),
693 items: self.arena.alloc_from_iter(fm.items.iter().map(|x| self.lower_foreign_item(x))),
697 fn lower_global_asm(&mut self, ga: &GlobalAsm) -> &'hir hir::GlobalAsm {
698 self.arena.alloc(hir::GlobalAsm { asm: ga.asm })
701 fn lower_variant(&mut self, v: &Variant) -> hir::Variant<'hir> {
703 attrs: self.lower_attrs(&v.attrs),
704 data: self.lower_variant_data(&v.data),
705 disr_expr: v.disr_expr.as_ref().map(|e| self.lower_anon_const(e)),
706 id: self.lower_node_id(v.id),
712 fn lower_variant_data(&mut self, vdata: &VariantData) -> hir::VariantData<'hir> {
714 VariantData::Struct(ref fields, recovered) => hir::VariantData::Struct(
716 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
719 VariantData::Tuple(ref fields, id) => hir::VariantData::Tuple(
721 .alloc_from_iter(fields.iter().enumerate().map(|f| self.lower_struct_field(f))),
722 self.lower_node_id(id),
724 VariantData::Unit(id) => hir::VariantData::Unit(self.lower_node_id(id)),
728 fn lower_struct_field(&mut self, (index, f): (usize, &StructField)) -> hir::StructField<'hir> {
729 let ty = if let TyKind::Path(ref qself, ref path) = f.ty.kind {
730 let t = self.lower_path_ty(
734 ParamMode::ExplicitNamed, // no `'_` in declarations (Issue #61124)
735 ImplTraitContext::disallowed(),
739 self.lower_ty(&f.ty, ImplTraitContext::disallowed())
743 hir_id: self.lower_node_id(f.id),
744 ident: match f.ident {
745 Some(ident) => ident,
746 // FIXME(jseyfried): positional field hygiene.
747 None => Ident::new(sym::integer(index), f.span),
749 vis: self.lower_visibility(&f.vis, None),
751 attrs: self.lower_attrs(&f.attrs),
755 fn lower_trait_item(&mut self, i: &AssocItem) -> hir::TraitItem<'hir> {
756 let trait_item_def_id = self.resolver.definitions().local_def_id(i.id);
758 let (generics, kind) = match i.kind {
759 AssocItemKind::Const(ref ty, ref default) => {
760 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
761 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
764 hir::TraitItemKind::Const(
766 default.as_ref().map(|x| self.lower_const_body(i.span, Some(x))),
770 AssocItemKind::Fn(ref sig, None) => {
771 let names = self.lower_fn_params_to_names(&sig.decl);
772 let (generics, sig) =
773 self.lower_method_sig(&i.generics, sig, trait_item_def_id, false, None);
774 (generics, hir::TraitItemKind::Method(sig, hir::TraitMethod::Required(names)))
776 AssocItemKind::Fn(ref sig, Some(ref body)) => {
777 let body_id = self.lower_fn_body_block(i.span, &sig.decl, Some(body));
778 let (generics, sig) =
779 self.lower_method_sig(&i.generics, sig, trait_item_def_id, false, None);
780 (generics, hir::TraitItemKind::Method(sig, hir::TraitMethod::Provided(body_id)))
782 AssocItemKind::TyAlias(ref bounds, ref default) => {
783 let ty = default.as_ref().map(|x| self.lower_ty(x, ImplTraitContext::disallowed()));
784 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
785 let kind = hir::TraitItemKind::Type(
786 self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
792 AssocItemKind::Macro(..) => bug!("macro item shouldn't exist at this point"),
796 hir_id: self.lower_node_id(i.id),
798 attrs: self.lower_attrs(&i.attrs),
805 fn lower_trait_item_ref(&mut self, i: &AssocItem) -> hir::TraitItemRef {
806 let (kind, has_default) = match i.kind {
807 AssocItemKind::Const(_, ref default) => (hir::AssocItemKind::Const, default.is_some()),
808 AssocItemKind::TyAlias(_, ref default) => (hir::AssocItemKind::Type, default.is_some()),
809 AssocItemKind::Fn(ref sig, ref default) => {
810 (hir::AssocItemKind::Method { has_self: sig.decl.has_self() }, default.is_some())
812 AssocItemKind::Macro(..) => unimplemented!(),
815 id: hir::TraitItemId { hir_id: self.lower_node_id(i.id) },
818 defaultness: self.lower_defaultness(Defaultness::Default, has_default),
823 /// Construct `ExprKind::Err` for the given `span`.
824 fn expr_err(&mut self, span: Span) -> hir::Expr<'hir> {
825 self.expr(span, hir::ExprKind::Err, AttrVec::new())
828 fn lower_impl_item(&mut self, i: &AssocItem) -> hir::ImplItem<'hir> {
829 let impl_item_def_id = self.resolver.definitions().local_def_id(i.id);
831 let (generics, kind) = match i.kind {
832 AssocItemKind::Const(ref ty, ref expr) => {
833 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
834 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
837 hir::ImplItemKind::Const(ty, self.lower_const_body(i.span, expr.as_deref())),
840 AssocItemKind::Fn(ref sig, ref body) => {
841 self.current_item = Some(i.span);
842 let body_id = self.lower_maybe_async_body(
845 sig.header.asyncness.node,
848 let impl_trait_return_allow = !self.is_in_trait_impl;
849 let (generics, sig) = self.lower_method_sig(
853 impl_trait_return_allow,
854 sig.header.asyncness.node.opt_return_id(),
857 (generics, hir::ImplItemKind::Method(sig, body_id))
859 AssocItemKind::TyAlias(_, ref ty) => {
860 let generics = self.lower_generics(&i.generics, ImplTraitContext::disallowed());
861 let kind = match ty {
863 let ty = self.arena.alloc(self.ty(i.span, hir::TyKind::Err));
864 hir::ImplItemKind::TyAlias(ty)
866 Some(ty) => match ty.kind.opaque_top_hack() {
868 let ty = self.lower_ty(ty, ImplTraitContext::disallowed());
869 hir::ImplItemKind::TyAlias(ty)
872 let bs = self.lower_param_bounds(bs, ImplTraitContext::disallowed());
873 hir::ImplItemKind::OpaqueTy(bs)
879 AssocItemKind::Macro(..) => bug!("`TyMac` should have been expanded by now"),
883 hir_id: self.lower_node_id(i.id),
885 attrs: self.lower_attrs(&i.attrs),
887 vis: self.lower_visibility(&i.vis, None),
888 defaultness: self.lower_defaultness(i.defaultness, true /* [1] */),
893 // [1] since `default impl` is not yet implemented, this is always true in impls
896 fn lower_impl_item_ref(&mut self, i: &AssocItem) -> hir::ImplItemRef<'hir> {
898 id: hir::ImplItemId { hir_id: self.lower_node_id(i.id) },
901 vis: self.lower_visibility(&i.vis, Some(i.id)),
902 defaultness: self.lower_defaultness(i.defaultness, true /* [1] */),
903 kind: match &i.kind {
904 AssocItemKind::Const(..) => hir::AssocItemKind::Const,
905 AssocItemKind::TyAlias(_, ty) => {
906 match ty.as_deref().and_then(|ty| ty.kind.opaque_top_hack()) {
907 None => hir::AssocItemKind::Type,
908 Some(_) => hir::AssocItemKind::OpaqueTy,
911 AssocItemKind::Fn(sig, _) => {
912 hir::AssocItemKind::Method { has_self: sig.decl.has_self() }
914 AssocItemKind::Macro(..) => unimplemented!(),
918 // [1] since `default impl` is not yet implemented, this is always true in impls
921 /// If an `explicit_owner` is given, this method allocates the `HirId` in
922 /// the address space of that item instead of the item currently being
923 /// lowered. This can happen during `lower_impl_item_ref()` where we need to
924 /// lower a `Visibility` value although we haven't lowered the owning
925 /// `ImplItem` in question yet.
929 explicit_owner: Option<NodeId>,
930 ) -> hir::Visibility<'hir> {
931 let node = match v.node {
932 VisibilityKind::Public => hir::VisibilityKind::Public,
933 VisibilityKind::Crate(sugar) => hir::VisibilityKind::Crate(sugar),
934 VisibilityKind::Restricted { ref path, id } => {
935 debug!("lower_visibility: restricted path id = {:?}", id);
936 let lowered_id = if let Some(owner) = explicit_owner {
937 self.lower_node_id_with_owner(id, owner)
939 self.lower_node_id(id)
941 let res = self.expect_full_res(id);
942 let res = self.lower_res(res);
943 hir::VisibilityKind::Restricted {
944 path: self.lower_path_extra(res, path, ParamMode::Explicit, explicit_owner),
948 VisibilityKind::Inherited => hir::VisibilityKind::Inherited,
953 fn lower_defaultness(&self, d: Defaultness, has_value: bool) -> hir::Defaultness {
955 Defaultness::Default => hir::Defaultness::Default { has_value: has_value },
956 Defaultness::Final => {
958 hir::Defaultness::Final
965 params: &'hir [hir::Param<'hir>],
966 value: hir::Expr<'hir>,
968 let body = hir::Body { generator_kind: self.generator_kind, params, value };
970 self.bodies.insert(id, body);
976 f: impl FnOnce(&mut Self) -> (&'hir [hir::Param<'hir>], hir::Expr<'hir>),
978 let prev_gen_kind = self.generator_kind.take();
979 let (parameters, result) = f(self);
980 let body_id = self.record_body(parameters, result);
981 self.generator_kind = prev_gen_kind;
985 fn lower_param(&mut self, param: &Param) -> hir::Param<'hir> {
987 attrs: self.lower_attrs(¶m.attrs),
988 hir_id: self.lower_node_id(param.id),
989 pat: self.lower_pat(¶m.pat),
994 pub(super) fn lower_fn_body(
997 body: impl FnOnce(&mut Self) -> hir::Expr<'hir>,
999 self.lower_body(|this| {
1001 this.arena.alloc_from_iter(decl.inputs.iter().map(|x| this.lower_param(x))),
1007 fn lower_fn_body_block(
1011 body: Option<&Block>,
1013 self.lower_fn_body(decl, |this| this.lower_block_expr_opt(span, body))
1016 fn lower_block_expr_opt(&mut self, span: Span, block: Option<&Block>) -> hir::Expr<'hir> {
1018 Some(block) => self.lower_block_expr(block),
1019 None => self.expr_err(span),
1023 pub(super) fn lower_const_body(&mut self, span: Span, expr: Option<&Expr>) -> hir::BodyId {
1024 self.lower_body(|this| {
1028 Some(expr) => this.lower_expr_mut(expr),
1029 None => this.expr_err(span),
1035 fn lower_maybe_async_body(
1040 body: Option<&Block>,
1042 let closure_id = match asyncness {
1043 IsAsync::Async { closure_id, .. } => closure_id,
1044 IsAsync::NotAsync => return self.lower_fn_body_block(span, decl, body),
1047 self.lower_body(|this| {
1048 let mut parameters: Vec<hir::Param<'_>> = Vec::new();
1049 let mut statements: Vec<hir::Stmt<'_>> = Vec::new();
1051 // Async function parameters are lowered into the closure body so that they are
1052 // captured and so that the drop order matches the equivalent non-async functions.
1056 // async fn foo(<pattern>: <ty>, <pattern>: <ty>, <pattern>: <ty>) {
1062 // fn foo(__arg0: <ty>, __arg1: <ty>, __arg2: <ty>) {
1064 // let __arg2 = __arg2;
1065 // let <pattern> = __arg2;
1066 // let __arg1 = __arg1;
1067 // let <pattern> = __arg1;
1068 // let __arg0 = __arg0;
1069 // let <pattern> = __arg0;
1070 // drop-temps { <body> } // see comments later in fn for details
1074 // If `<pattern>` is a simple ident, then it is lowered to a single
1075 // `let <pattern> = <pattern>;` statement as an optimization.
1077 // Note that the body is embedded in `drop-temps`; an
1078 // equivalent desugaring would be `return { <body>
1079 // };`. The key point is that we wish to drop all the
1080 // let-bound variables and temporaries created in the body
1081 // (and its tail expression!) before we drop the
1082 // parameters (c.f. rust-lang/rust#64512).
1083 for (index, parameter) in decl.inputs.iter().enumerate() {
1084 let parameter = this.lower_param(parameter);
1085 let span = parameter.pat.span;
1087 // Check if this is a binding pattern, if so, we can optimize and avoid adding a
1088 // `let <pat> = __argN;` statement. In this case, we do not rename the parameter.
1089 let (ident, is_simple_parameter) = match parameter.pat.kind {
1090 hir::PatKind::Binding(hir::BindingAnnotation::Unannotated, _, ident, _) => {
1094 // Replace the ident for bindings that aren't simple.
1095 let name = format!("__arg{}", index);
1096 let ident = Ident::from_str(&name);
1102 let desugared_span = this.mark_span_with_reason(DesugaringKind::Async, span, None);
1104 // Construct a parameter representing `__argN: <ty>` to replace the parameter of the
1107 // If this is the simple case, this parameter will end up being the same as the
1108 // original parameter, but with a different pattern id.
1109 let mut stmt_attrs = AttrVec::new();
1110 stmt_attrs.extend(parameter.attrs.iter().cloned());
1111 let (new_parameter_pat, new_parameter_id) = this.pat_ident(desugared_span, ident);
1112 let new_parameter = hir::Param {
1113 attrs: parameter.attrs,
1114 hir_id: parameter.hir_id,
1115 pat: new_parameter_pat,
1116 span: parameter.span,
1119 if is_simple_parameter {
1120 // If this is the simple case, then we only insert one statement that is
1121 // `let <pat> = <pat>;`. We re-use the original argument's pattern so that
1122 // `HirId`s are densely assigned.
1123 let expr = this.expr_ident(desugared_span, ident, new_parameter_id);
1124 let stmt = this.stmt_let_pat(
1129 hir::LocalSource::AsyncFn,
1131 statements.push(stmt);
1133 // If this is not the simple case, then we construct two statements:
1136 // let __argN = __argN;
1137 // let <pat> = __argN;
1140 // The first statement moves the parameter into the closure and thus ensures
1141 // that the drop order is correct.
1143 // The second statement creates the bindings that the user wrote.
1145 // Construct the `let mut __argN = __argN;` statement. It must be a mut binding
1146 // because the user may have specified a `ref mut` binding in the next
1148 let (move_pat, move_id) = this.pat_ident_binding_mode(
1151 hir::BindingAnnotation::Mutable,
1153 let move_expr = this.expr_ident(desugared_span, ident, new_parameter_id);
1154 let move_stmt = this.stmt_let_pat(
1159 hir::LocalSource::AsyncFn,
1162 // Construct the `let <pat> = __argN;` statement. We re-use the original
1163 // parameter's pattern so that `HirId`s are densely assigned.
1164 let pattern_expr = this.expr_ident(desugared_span, ident, move_id);
1165 let pattern_stmt = this.stmt_let_pat(
1170 hir::LocalSource::AsyncFn,
1173 statements.push(move_stmt);
1174 statements.push(pattern_stmt);
1177 parameters.push(new_parameter);
1180 let body_span = body.map_or(span, |b| b.span);
1181 let async_expr = this.make_async_expr(
1186 hir::AsyncGeneratorKind::Fn,
1188 // Create a block from the user's function body:
1189 let user_body = this.lower_block_expr_opt(body_span, body);
1191 // Transform into `drop-temps { <user-body> }`, an expression:
1192 let desugared_span =
1193 this.mark_span_with_reason(DesugaringKind::Async, user_body.span, None);
1194 let user_body = this.expr_drop_temps(
1196 this.arena.alloc(user_body),
1200 // As noted above, create the final block like
1204 // let $param_pattern = $raw_param;
1206 // drop-temps { <user-body> }
1209 let body = this.block_all(
1211 this.arena.alloc_from_iter(statements),
1215 this.expr_block(body, AttrVec::new())
1220 this.arena.alloc_from_iter(parameters),
1221 this.expr(body_span, async_expr, AttrVec::new()),
1226 fn lower_method_sig(
1228 generics: &Generics,
1231 impl_trait_return_allow: bool,
1232 is_async: Option<NodeId>,
1233 ) -> (hir::Generics<'hir>, hir::FnSig<'hir>) {
1234 let header = self.lower_fn_header(sig.header);
1235 let (generics, decl) = self.add_in_band_defs(
1238 AnonymousLifetimeMode::PassThrough,
1242 Some((fn_def_id, idty)),
1243 impl_trait_return_allow,
1248 (generics, hir::FnSig { header, decl })
1251 fn lower_fn_header(&mut self, h: FnHeader) -> hir::FnHeader {
1253 unsafety: h.unsafety,
1254 asyncness: self.lower_asyncness(h.asyncness.node),
1255 constness: h.constness.node,
1256 abi: self.lower_extern(h.ext),
1260 pub(super) fn lower_abi(&mut self, abi: StrLit) -> abi::Abi {
1261 abi::lookup(&abi.symbol_unescaped.as_str()).unwrap_or_else(|| {
1262 self.error_on_invalid_abi(abi);
1267 pub(super) fn lower_extern(&mut self, ext: Extern) -> abi::Abi {
1269 Extern::None => abi::Abi::Rust,
1270 Extern::Implicit => abi::Abi::C,
1271 Extern::Explicit(abi) => self.lower_abi(abi),
1275 fn error_on_invalid_abi(&self, abi: StrLit) {
1276 struct_span_err!(self.sess, abi.span, E0703, "invalid ABI: found `{}`", abi.symbol)
1277 .span_label(abi.span, "invalid ABI")
1278 .help(&format!("valid ABIs: {}", abi::all_names().join(", ")))
1282 fn lower_asyncness(&mut self, a: IsAsync) -> hir::IsAsync {
1284 IsAsync::Async { .. } => hir::IsAsync::Async,
1285 IsAsync::NotAsync => hir::IsAsync::NotAsync,
1289 pub(super) fn lower_generics_mut(
1291 generics: &Generics,
1292 itctx: ImplTraitContext<'_, 'hir>,
1293 ) -> GenericsCtor<'hir> {
1294 // Collect `?Trait` bounds in where clause and move them to parameter definitions.
1295 // FIXME: this could probably be done with less rightward drift. It also looks like two
1296 // control paths where `report_error` is called are the only paths that advance to after the
1297 // match statement, so the error reporting could probably just be moved there.
1298 let mut add_bounds: NodeMap<Vec<_>> = Default::default();
1299 for pred in &generics.where_clause.predicates {
1300 if let WherePredicate::BoundPredicate(ref bound_pred) = *pred {
1301 'next_bound: for bound in &bound_pred.bounds {
1302 if let GenericBound::Trait(_, TraitBoundModifier::Maybe) = *bound {
1303 let report_error = |this: &mut Self| {
1304 this.diagnostic().span_err(
1305 bound_pred.bounded_ty.span,
1306 "`?Trait` bounds are only permitted at the \
1307 point where a type parameter is declared",
1310 // Check if the where clause type is a plain type parameter.
1311 match bound_pred.bounded_ty.kind {
1312 TyKind::Path(None, ref path)
1313 if path.segments.len() == 1
1314 && bound_pred.bound_generic_params.is_empty() =>
1316 if let Some(Res::Def(DefKind::TyParam, def_id)) = self
1318 .get_partial_res(bound_pred.bounded_ty.id)
1319 .map(|d| d.base_res())
1321 if let Some(node_id) =
1322 self.resolver.definitions().as_local_node_id(def_id)
1324 for param in &generics.params {
1326 GenericParamKind::Type { .. } => {
1327 if node_id == param.id {
1331 .push(bound.clone());
1332 continue 'next_bound;
1342 _ => report_error(self),
1350 params: self.lower_generic_params_mut(&generics.params, &add_bounds, itctx).collect(),
1351 where_clause: self.lower_where_clause(&generics.where_clause),
1352 span: generics.span,
1356 pub(super) fn lower_generics(
1358 generics: &Generics,
1359 itctx: ImplTraitContext<'_, 'hir>,
1360 ) -> hir::Generics<'hir> {
1361 let generics_ctor = self.lower_generics_mut(generics, itctx);
1362 generics_ctor.into_generics(self.arena)
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.lower_generic_params(
1387 bound_generic_params,
1388 &NodeMap::default(),
1389 ImplTraitContext::disallowed(),
1391 bounded_ty: this.lower_ty(bounded_ty, ImplTraitContext::disallowed()),
1392 bounds: this.arena.alloc_from_iter(bounds.iter().filter_map(|bound| {
1394 // Ignore `?Trait` bounds.
1395 // They were copied into type parameters already.
1396 GenericBound::Trait(_, TraitBoundModifier::Maybe) => None,
1398 this.lower_param_bound(bound, ImplTraitContext::disallowed()),
1406 WherePredicate::RegionPredicate(WhereRegionPredicate {
1410 }) => hir::WherePredicate::RegionPredicate(hir::WhereRegionPredicate {
1412 lifetime: self.lower_lifetime(lifetime),
1413 bounds: self.lower_param_bounds(bounds, ImplTraitContext::disallowed()),
1415 WherePredicate::EqPredicate(WhereEqPredicate { id, ref lhs_ty, ref rhs_ty, span }) => {
1416 hir::WherePredicate::EqPredicate(hir::WhereEqPredicate {
1417 hir_id: self.lower_node_id(id),
1418 lhs_ty: self.lower_ty(lhs_ty, ImplTraitContext::disallowed()),
1419 rhs_ty: self.lower_ty(rhs_ty, ImplTraitContext::disallowed()),
1427 /// Helper struct for delayed construction of Generics.
1428 pub(super) struct GenericsCtor<'hir> {
1429 pub(super) params: SmallVec<[hir::GenericParam<'hir>; 4]>,
1430 where_clause: hir::WhereClause<'hir>,
1434 impl<'hir> GenericsCtor<'hir> {
1435 pub(super) fn into_generics(self, arena: &'hir Arena<'hir>) -> hir::Generics<'hir> {
1437 params: arena.alloc_from_iter(self.params),
1438 where_clause: self.where_clause,