1 //! A bunch of methods and structures more or less related to resolving macros and
2 //! interface provided by `Resolver` to macro expander.
4 use crate::imports::ImportResolver;
5 use crate::Namespace::*;
6 use crate::{AmbiguityError, AmbiguityErrorMisc, AmbiguityKind, Determinacy};
7 use crate::{CrateLint, ParentScope, ResolutionError, Resolver, Scope, ScopeSet, Weak};
8 use crate::{ModuleKind, ModuleOrUniformRoot, NameBinding, PathResult, Segment, ToNameBinding};
9 use rustc::middle::stability;
10 use rustc::{span_bug, ty};
11 use rustc_ast::ast::{self, Ident, NodeId};
12 use rustc_ast_pretty::pprust;
13 use rustc_attr::{self as attr, StabilityLevel};
14 use rustc_data_structures::fx::FxHashSet;
15 use rustc_expand::base::SyntaxExtension;
16 use rustc_expand::base::{self, Indeterminate, InvocationRes};
17 use rustc_expand::compile_declarative_macro;
18 use rustc_expand::expand::{AstFragment, AstFragmentKind, Invocation, InvocationKind};
19 use rustc_feature::is_builtin_attr_name;
20 use rustc_hir::def::{self, DefKind, NonMacroAttrKind};
21 use rustc_hir::def_id;
22 use rustc_session::lint::builtin::UNUSED_MACROS;
23 use rustc_session::parse::feature_err;
24 use rustc_session::Session;
25 use rustc_span::edition::Edition;
26 use rustc_span::hygiene::{self, ExpnData, ExpnId, ExpnKind};
27 use rustc_span::symbol::{kw, sym, Symbol};
28 use rustc_span::{Span, DUMMY_SP};
30 use rustc_data_structures::sync::Lrc;
31 use rustc_span::hygiene::{AstPass, MacroKind};
34 type Res = def::Res<NodeId>;
36 /// Binding produced by a `macro_rules` item.
37 /// Not modularized, can shadow previous `macro_rules` bindings, etc.
39 pub struct MacroRulesBinding<'a> {
40 crate binding: &'a NameBinding<'a>,
41 /// `macro_rules` scope into which the `macro_rules` item was planted.
42 crate parent_macro_rules_scope: MacroRulesScope<'a>,
46 /// The scope introduced by a `macro_rules!` macro.
47 /// This starts at the macro's definition and ends at the end of the macro's parent
48 /// module (named or unnamed), or even further if it escapes with `#[macro_use]`.
49 /// Some macro invocations need to introduce `macro_rules` scopes too because they
50 /// can potentially expand into macro definitions.
51 #[derive(Copy, Clone, Debug)]
52 pub enum MacroRulesScope<'a> {
53 /// Empty "root" scope at the crate start containing no names.
55 /// The scope introduced by a `macro_rules!` macro definition.
56 Binding(&'a MacroRulesBinding<'a>),
57 /// The scope introduced by a macro invocation that can potentially
58 /// create a `macro_rules!` macro definition.
62 // Macro namespace is separated into two sub-namespaces, one for bang macros and
63 // one for attribute-like macros (attributes, derives).
64 // We ignore resolutions from one sub-namespace when searching names in scope for another.
65 fn sub_namespace_match(candidate: Option<MacroKind>, requirement: Option<MacroKind>) -> bool {
71 let sub_ns = |kind| match kind {
72 MacroKind::Bang => SubNS::Bang,
73 MacroKind::Attr | MacroKind::Derive => SubNS::AttrLike,
75 let candidate = candidate.map(sub_ns);
76 let requirement = requirement.map(sub_ns);
77 // "No specific sub-namespace" means "matches anything" for both requirements and candidates.
78 candidate.is_none() || requirement.is_none() || candidate == requirement
81 // We don't want to format a path using pretty-printing,
82 // `format!("{}", path)`, because that tries to insert
83 // line-breaks and is slow.
84 fn fast_print_path(path: &ast::Path) -> Symbol {
85 if path.segments.len() == 1 {
86 return path.segments[0].ident.name;
88 let mut path_str = String::with_capacity(64);
89 for (i, segment) in path.segments.iter().enumerate() {
91 path_str.push_str("::");
93 if segment.ident.name != kw::PathRoot {
94 path_str.push_str(&segment.ident.as_str())
97 Symbol::intern(&path_str)
101 /// The code common between processing `#![register_tool]` and `#![register_attr]`.
102 fn registered_idents(
104 attrs: &[ast::Attribute],
107 ) -> FxHashSet<Ident> {
108 let mut registered = FxHashSet::default();
109 for attr in attr::filter_by_name(attrs, attr_name) {
110 for nested_meta in attr.meta_item_list().unwrap_or_default() {
111 match nested_meta.ident() {
113 if let Some(old_ident) = registered.replace(ident) {
114 let msg = format!("{} `{}` was already registered", descr, ident);
115 sess.struct_span_err(ident.span, &msg)
116 .span_label(old_ident.span, "already registered here")
121 let msg = format!("`{}` only accepts identifiers", attr_name);
122 let span = nested_meta.span();
123 sess.struct_span_err(span, &msg).span_label(span, "not an identifier").emit();
131 crate fn registered_attrs_and_tools(
133 attrs: &[ast::Attribute],
134 ) -> (FxHashSet<Ident>, FxHashSet<Ident>) {
135 let registered_attrs = registered_idents(sess, attrs, sym::register_attr, "attribute");
136 let mut registered_tools = registered_idents(sess, attrs, sym::register_tool, "tool");
137 // We implicitly add `rustfmt` and `clippy` to known tools,
138 // but it's not an error to register them explicitly.
139 let predefined_tools = [sym::clippy, sym::rustfmt];
140 registered_tools.extend(predefined_tools.iter().cloned().map(Ident::with_dummy_span));
141 (registered_attrs, registered_tools)
144 impl<'a> base::Resolver for Resolver<'a> {
145 fn next_node_id(&mut self) -> NodeId {
149 fn resolve_dollar_crates(&mut self) {
150 hygiene::update_dollar_crate_names(|ctxt| {
151 let ident = Ident::new(kw::DollarCrate, DUMMY_SP.with_ctxt(ctxt));
152 match self.resolve_crate_root(ident).kind {
153 ModuleKind::Def(.., name) if name != kw::Invalid => name,
159 fn visit_ast_fragment_with_placeholders(&mut self, expansion: ExpnId, fragment: &AstFragment) {
160 // Integrate the new AST fragment into all the definition and module structures.
161 // We are inside the `expansion` now, but other parent scope components are still the same.
162 let parent_scope = ParentScope { expansion, ..self.invocation_parent_scopes[&expansion] };
163 let output_macro_rules_scope = self.build_reduced_graph(fragment, parent_scope);
164 self.output_macro_rules_scopes.insert(expansion, output_macro_rules_scope);
166 parent_scope.module.unexpanded_invocations.borrow_mut().remove(&expansion);
169 fn register_builtin_macro(&mut self, ident: ast::Ident, ext: SyntaxExtension) {
170 if self.builtin_macros.insert(ident.name, ext).is_some() {
172 .span_err(ident.span, &format!("built-in macro `{}` was already defined", ident));
176 // Create a new Expansion with a definition site of the provided module, or
177 // a fake empty `#[no_implicit_prelude]` module if no module is provided.
178 fn expansion_for_ast_pass(
183 parent_module_id: Option<NodeId>,
185 let expn_id = ExpnId::fresh(Some(ExpnData::allow_unstable(
186 ExpnKind::AstPass(pass),
188 self.session.edition(),
192 let parent_scope = if let Some(module_id) = parent_module_id {
193 let parent_def_id = self.definitions.local_def_id(module_id);
194 self.definitions.add_parent_module_of_macro_def(expn_id, parent_def_id);
195 self.module_map[&parent_def_id]
197 self.definitions.add_parent_module_of_macro_def(
199 def_id::DefId::local(def_id::CRATE_DEF_INDEX),
203 self.ast_transform_scopes.insert(expn_id, parent_scope);
207 fn resolve_imports(&mut self) {
208 ImportResolver { r: self }.resolve_imports()
211 fn resolve_macro_invocation(
214 eager_expansion_root: ExpnId,
216 ) -> Result<InvocationRes, Indeterminate> {
217 let invoc_id = invoc.expansion_data.id;
218 let parent_scope = match self.invocation_parent_scopes.get(&invoc_id) {
219 Some(parent_scope) => *parent_scope,
221 // If there's no entry in the table, then we are resolving an eagerly expanded
222 // macro, which should inherit its parent scope from its eager expansion root -
223 // the macro that requested this eager expansion.
224 let parent_scope = *self
225 .invocation_parent_scopes
226 .get(&eager_expansion_root)
227 .expect("non-eager expansion without a parent scope");
228 self.invocation_parent_scopes.insert(invoc_id, parent_scope);
233 let (path, kind, derives, after_derive) = match invoc.kind {
234 InvocationKind::Attr { ref attr, ref derives, after_derive, .. } => (
235 &attr.get_normal_item().path,
237 self.arenas.alloc_ast_paths(derives),
240 InvocationKind::Bang { ref mac, .. } => (&mac.path, MacroKind::Bang, &[][..], false),
241 InvocationKind::Derive { ref path, .. } => (path, MacroKind::Derive, &[][..], false),
242 InvocationKind::DeriveContainer { ref derives, .. } => {
243 // Block expansion of the container until we resolve all derives in it.
244 // This is required for two reasons:
245 // - Derive helper attributes are in scope for the item to which the `#[derive]`
246 // is applied, so they have to be produced by the container's expansion rather
247 // than by individual derives.
248 // - Derives in the container need to know whether one of them is a built-in `Copy`.
249 // FIXME: Try to avoid repeated resolutions for derives here and in expansion.
250 let mut exts = Vec::new();
251 let mut helper_attrs = Vec::new();
252 for path in derives {
254 match self.resolve_macro_path(
256 Some(MacroKind::Derive),
261 Ok((Some(ext), _)) => {
268 .normalize_to_macros_2_0();
270 ext.helper_attrs.iter().map(|name| Ident::new(*name, span)),
272 if ext.is_derive_copy {
273 self.add_derive_copy(invoc_id);
277 Ok(_) | Err(Determinacy::Determined) => {
278 self.dummy_ext(MacroKind::Derive)
280 Err(Determinacy::Undetermined) => return Err(Indeterminate),
284 self.helper_attrs.insert(invoc_id, helper_attrs);
285 return Ok(InvocationRes::DeriveContainer(exts));
289 // Derives are not included when `invocations` are collected, so we have to add them here.
290 let parent_scope = &ParentScope { derives, ..parent_scope };
291 let (ext, res) = self.smart_resolve_macro_path(path, kind, parent_scope, force)?;
293 let span = invoc.span();
294 invoc_id.set_expn_data(ext.expn_data(parent_scope.expansion, span, fast_print_path(path)));
296 if let Res::Def(_, def_id) = res {
298 self.session.span_err(span, "macro attributes must be placed before `#[derive]`");
300 self.macro_defs.insert(invoc_id, def_id);
301 let normal_module_def_id = self.macro_def_scope(invoc_id).normal_ancestor_id;
302 self.definitions.add_parent_module_of_macro_def(invoc_id, normal_module_def_id);
305 match invoc.fragment_kind {
306 AstFragmentKind::Arms
307 | AstFragmentKind::Fields
308 | AstFragmentKind::FieldPats
309 | AstFragmentKind::GenericParams
310 | AstFragmentKind::Params
311 | AstFragmentKind::StructFields
312 | AstFragmentKind::Variants => {
313 if let Res::Def(..) = res {
314 self.session.span_err(
317 "expected an inert attribute, found {} {}",
322 return Ok(InvocationRes::Single(self.dummy_ext(kind)));
328 Ok(InvocationRes::Single(ext))
331 fn check_unused_macros(&mut self) {
332 for (&node_id, &span) in self.unused_macros.iter() {
333 self.lint_buffer.buffer_lint(UNUSED_MACROS, node_id, span, "unused macro definition");
337 fn has_derive_copy(&self, expn_id: ExpnId) -> bool {
338 self.containers_deriving_copy.contains(&expn_id)
341 fn add_derive_copy(&mut self, expn_id: ExpnId) {
342 self.containers_deriving_copy.insert(expn_id);
345 // The function that implements the resolution logic of `#[cfg_accessible(path)]`.
346 // Returns true if the path can certainly be resolved in one of three namespaces,
347 // returns false if the path certainly cannot be resolved in any of the three namespaces.
348 // Returns `Indeterminate` if we cannot give a certain answer yet.
349 fn cfg_accessible(&mut self, expn_id: ExpnId, path: &ast::Path) -> Result<bool, Indeterminate> {
350 let span = path.span;
351 let path = &Segment::from_path(path);
352 let parent_scope = self.invocation_parent_scopes[&expn_id];
354 let mut indeterminate = false;
355 for ns in [TypeNS, ValueNS, MacroNS].iter().copied() {
356 match self.resolve_path(path, Some(ns), &parent_scope, false, span, CrateLint::No) {
357 PathResult::Module(ModuleOrUniformRoot::Module(_)) => return Ok(true),
358 PathResult::NonModule(partial_res) if partial_res.unresolved_segments() == 0 => {
361 PathResult::Indeterminate => indeterminate = true,
362 // FIXME: `resolve_path` is not ready to report partially resolved paths
363 // correctly, so we just report an error if the path was reported as unresolved.
364 // This needs to be fixed for `cfg_accessible` to be useful.
365 PathResult::NonModule(..) | PathResult::Failed { .. } => {}
366 PathResult::Module(_) => panic!("unexpected path resolution"),
371 return Err(Indeterminate);
375 .struct_span_err(span, "not sure whether the path is accessible or not")
376 .span_note(span, "`cfg_accessible` is not fully implemented")
382 impl<'a> Resolver<'a> {
383 /// Resolve macro path with error reporting and recovery.
384 fn smart_resolve_macro_path(
388 parent_scope: &ParentScope<'a>,
390 ) -> Result<(Lrc<SyntaxExtension>, Res), Indeterminate> {
391 let (ext, res) = match self.resolve_macro_path(path, Some(kind), parent_scope, true, force)
393 Ok((Some(ext), res)) => (ext, res),
394 // Use dummy syntax extensions for unresolved macros for better recovery.
395 Ok((None, res)) => (self.dummy_ext(kind), res),
396 Err(Determinacy::Determined) => (self.dummy_ext(kind), Res::Err),
397 Err(Determinacy::Undetermined) => return Err(Indeterminate),
400 // Report errors and enforce feature gates for the resolved macro.
401 let features = self.session.features_untracked();
402 for segment in &path.segments {
403 if let Some(args) = &segment.args {
404 self.session.span_err(args.span(), "generic arguments in macro path");
406 if kind == MacroKind::Attr
407 && !features.rustc_attrs
408 && segment.ident.as_str().starts_with("rustc")
411 "attributes starting with `rustc` are reserved for use by the `rustc` compiler";
412 feature_err(&self.session.parse_sess, sym::rustc_attrs, segment.ident.span, msg)
418 Res::Def(DefKind::Macro(_), def_id) => {
419 if let Some(node_id) = self.definitions.as_local_node_id(def_id) {
420 self.unused_macros.remove(&node_id);
421 if self.proc_macro_stubs.contains(&node_id) {
422 self.session.span_err(
424 "can't use a procedural macro from the same crate that defines it",
429 Res::NonMacroAttr(..) | Res::Err => {}
430 _ => panic!("expected `DefKind::Macro` or `Res::NonMacroAttr`"),
433 self.check_stability_and_deprecation(&ext, path);
435 Ok(if ext.macro_kind() != kind {
436 let expected = kind.descr_expected();
437 let path_str = pprust::path_to_string(path);
438 let msg = format!("expected {}, found {} `{}`", expected, res.descr(), path_str);
440 .struct_span_err(path.span, &msg)
441 .span_label(path.span, format!("not {} {}", kind.article(), expected))
443 // Use dummy syntax extensions for unexpected macro kinds for better recovery.
444 (self.dummy_ext(kind), Res::Err)
450 pub fn resolve_macro_path(
453 kind: Option<MacroKind>,
454 parent_scope: &ParentScope<'a>,
457 ) -> Result<(Option<Lrc<SyntaxExtension>>, Res), Determinacy> {
458 let path_span = path.span;
459 let mut path = Segment::from_path(path);
461 // Possibly apply the macro helper hack
462 if kind == Some(MacroKind::Bang)
464 && path[0].ident.span.ctxt().outer_expn_data().local_inner_macros
466 let root = Ident::new(kw::DollarCrate, path[0].ident.span);
467 path.insert(0, Segment::from_ident(root));
470 let res = if path.len() > 1 {
471 let res = match self.resolve_path(
479 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 => {
480 Ok(path_res.base_res())
482 PathResult::Indeterminate if !force => return Err(Determinacy::Undetermined),
483 PathResult::NonModule(..)
484 | PathResult::Indeterminate
485 | PathResult::Failed { .. } => Err(Determinacy::Determined),
486 PathResult::Module(..) => unreachable!(),
490 let kind = kind.expect("macro kind must be specified if tracing is enabled");
491 self.multi_segment_macro_resolutions.push((
500 self.prohibit_imported_non_macro_attrs(None, res.ok(), path_span);
503 let scope_set = kind.map_or(ScopeSet::All(MacroNS, false), ScopeSet::Macro);
504 let binding = self.early_resolve_ident_in_lexical_scope(
512 if let Err(Determinacy::Undetermined) = binding {
513 return Err(Determinacy::Undetermined);
517 let kind = kind.expect("macro kind must be specified if tracing is enabled");
518 self.single_segment_macro_resolutions.push((
526 let res = binding.map(|binding| binding.res());
527 self.prohibit_imported_non_macro_attrs(binding.ok(), res.ok(), path_span);
531 res.map(|res| (self.get_macro(res), res))
534 // Resolve an identifier in lexical scope.
535 // This is a variation of `fn resolve_ident_in_lexical_scope` that can be run during
536 // expansion and import resolution (perhaps they can be merged in the future).
537 // The function is used for resolving initial segments of macro paths (e.g., `foo` in
538 // `foo::bar!(); or `foo!();`) and also for import paths on 2018 edition.
539 crate fn early_resolve_ident_in_lexical_scope(
543 parent_scope: &ParentScope<'a>,
547 ) -> Result<&'a NameBinding<'a>, Determinacy> {
548 bitflags::bitflags! {
550 const MACRO_RULES = 1 << 0;
551 const MODULE = 1 << 1;
552 const DERIVE_HELPER_COMPAT = 1 << 2;
553 const MISC_SUGGEST_CRATE = 1 << 3;
554 const MISC_SUGGEST_SELF = 1 << 4;
555 const MISC_FROM_PRELUDE = 1 << 5;
559 assert!(force || !record_used); // `record_used` implies `force`
561 // Make sure `self`, `super` etc produce an error when passed to here.
562 if orig_ident.is_path_segment_keyword() {
563 return Err(Determinacy::Determined);
566 let (ns, macro_kind, is_import) = match scope_set {
567 ScopeSet::All(ns, is_import) => (ns, None, is_import),
568 ScopeSet::AbsolutePath(ns) => (ns, None, false),
569 ScopeSet::Macro(macro_kind) => (MacroNS, Some(macro_kind), false),
572 // This is *the* result, resolution from the scope closest to the resolved identifier.
573 // However, sometimes this result is "weak" because it comes from a glob import or
574 // a macro expansion, and in this case it cannot shadow names from outer scopes, e.g.
575 // mod m { ... } // solution in outer scope
577 // use prefix::*; // imports another `m` - innermost solution
578 // // weak, cannot shadow the outer `m`, need to report ambiguity error
581 // So we have to save the innermost solution and continue searching in outer scopes
582 // to detect potential ambiguities.
583 let mut innermost_result: Option<(&NameBinding<'_>, Flags)> = None;
584 let mut determinacy = Determinacy::Determined;
586 // Go through all the scopes and try to resolve the name.
587 let break_result = self.visit_scopes(
591 |this, scope, use_prelude, ident| {
592 let ok = |res, span, arenas| {
594 (res, ty::Visibility::Public, span, ExpnId::root()).to_name_binding(arenas),
598 let result = match scope {
599 Scope::DeriveHelpers(expn_id) => {
600 if let Some(attr) = this
603 .and_then(|attrs| attrs.iter().rfind(|i| ident == **i))
606 Res::NonMacroAttr(NonMacroAttrKind::DeriveHelper),
607 ty::Visibility::Public,
611 .to_name_binding(this.arenas);
612 Ok((binding, Flags::empty()))
614 Err(Determinacy::Determined)
617 Scope::DeriveHelpersCompat => {
618 let mut result = Err(Determinacy::Determined);
619 for derive in parent_scope.derives {
620 let parent_scope = &ParentScope { derives: &[], ..*parent_scope };
621 match this.resolve_macro_path(
623 Some(MacroKind::Derive),
628 Ok((Some(ext), _)) => {
629 if ext.helper_attrs.contains(&ident.name) {
631 Res::NonMacroAttr(NonMacroAttrKind::DeriveHelper),
632 ty::Visibility::Public,
636 .to_name_binding(this.arenas);
637 result = Ok((binding, Flags::DERIVE_HELPER_COMPAT));
641 Ok(_) | Err(Determinacy::Determined) => {}
642 Err(Determinacy::Undetermined) => {
643 result = Err(Determinacy::Undetermined)
649 Scope::MacroRules(macro_rules_scope) => match macro_rules_scope {
650 MacroRulesScope::Binding(macro_rules_binding)
651 if ident == macro_rules_binding.ident =>
653 Ok((macro_rules_binding.binding, Flags::MACRO_RULES))
655 MacroRulesScope::Invocation(invoc_id)
656 if !this.output_macro_rules_scopes.contains_key(&invoc_id) =>
658 Err(Determinacy::Undetermined)
660 _ => Err(Determinacy::Determined),
662 Scope::CrateRoot => {
663 let root_ident = Ident::new(kw::PathRoot, ident.span);
664 let root_module = this.resolve_crate_root(root_ident);
665 let binding = this.resolve_ident_in_module_ext(
666 ModuleOrUniformRoot::Module(root_module),
674 Ok(binding) => Ok((binding, Flags::MODULE | Flags::MISC_SUGGEST_CRATE)),
675 Err((Determinacy::Undetermined, Weak::No)) => {
676 return Some(Err(Determinacy::determined(force)));
678 Err((Determinacy::Undetermined, Weak::Yes)) => {
679 Err(Determinacy::Undetermined)
681 Err((Determinacy::Determined, _)) => Err(Determinacy::Determined),
684 Scope::Module(module) => {
685 let adjusted_parent_scope = &ParentScope { module, ..*parent_scope };
686 let binding = this.resolve_ident_in_module_unadjusted_ext(
687 ModuleOrUniformRoot::Module(module),
690 adjusted_parent_scope,
697 let misc_flags = if ptr::eq(module, this.graph_root) {
698 Flags::MISC_SUGGEST_CRATE
699 } else if module.is_normal() {
700 Flags::MISC_SUGGEST_SELF
704 Ok((binding, Flags::MODULE | misc_flags))
706 Err((Determinacy::Undetermined, Weak::No)) => {
707 return Some(Err(Determinacy::determined(force)));
709 Err((Determinacy::Undetermined, Weak::Yes)) => {
710 Err(Determinacy::Undetermined)
712 Err((Determinacy::Determined, _)) => Err(Determinacy::Determined),
715 Scope::RegisteredAttrs => match this.registered_attrs.get(&ident).cloned() {
717 Res::NonMacroAttr(NonMacroAttrKind::Registered),
721 None => Err(Determinacy::Determined),
723 Scope::MacroUsePrelude => {
724 match this.macro_use_prelude.get(&ident.name).cloned() {
725 Some(binding) => Ok((binding, Flags::MISC_FROM_PRELUDE)),
726 None => Err(Determinacy::determined(
727 this.graph_root.unexpanded_invocations.borrow().is_empty(),
731 Scope::BuiltinAttrs => {
732 if is_builtin_attr_name(ident.name) {
733 ok(Res::NonMacroAttr(NonMacroAttrKind::Builtin), DUMMY_SP, this.arenas)
735 Err(Determinacy::Determined)
738 Scope::ExternPrelude => match this.extern_prelude_get(ident, !record_used) {
739 Some(binding) => Ok((binding, Flags::empty())),
740 None => Err(Determinacy::determined(
741 this.graph_root.unexpanded_invocations.borrow().is_empty(),
744 Scope::ToolPrelude => match this.registered_tools.get(&ident).cloned() {
745 Some(ident) => ok(Res::ToolMod, ident.span, this.arenas),
746 None => Err(Determinacy::Determined),
748 Scope::StdLibPrelude => {
749 let mut result = Err(Determinacy::Determined);
750 if let Some(prelude) = this.prelude {
751 if let Ok(binding) = this.resolve_ident_in_module_unadjusted(
752 ModuleOrUniformRoot::Module(prelude),
759 if use_prelude || this.is_builtin_macro(binding.res()) {
760 result = Ok((binding, Flags::MISC_FROM_PRELUDE));
766 Scope::BuiltinTypes => {
767 match this.primitive_type_table.primitive_types.get(&ident.name).cloned() {
768 Some(prim_ty) => ok(Res::PrimTy(prim_ty), DUMMY_SP, this.arenas),
769 None => Err(Determinacy::Determined),
776 if sub_namespace_match(binding.macro_kind(), macro_kind) =>
779 return Some(Ok(binding));
782 if let Some((innermost_binding, innermost_flags)) = innermost_result {
783 // Found another solution, if the first one was "weak", report an error.
784 let (res, innermost_res) = (binding.res(), innermost_binding.res());
785 if res != innermost_res {
786 let builtin = Res::NonMacroAttr(NonMacroAttrKind::Builtin);
787 let is_derive_helper_compat = |res, flags: Flags| {
788 res == Res::NonMacroAttr(NonMacroAttrKind::DeriveHelper)
789 && flags.contains(Flags::DERIVE_HELPER_COMPAT)
792 let ambiguity_error_kind = if is_import {
793 Some(AmbiguityKind::Import)
794 } else if innermost_res == builtin || res == builtin {
795 Some(AmbiguityKind::BuiltinAttr)
796 } else if is_derive_helper_compat(innermost_res, innermost_flags)
797 || is_derive_helper_compat(res, flags)
799 Some(AmbiguityKind::DeriveHelper)
800 } else if innermost_flags.contains(Flags::MACRO_RULES)
801 && flags.contains(Flags::MODULE)
802 && !this.disambiguate_macro_rules_vs_modularized(
806 || flags.contains(Flags::MACRO_RULES)
807 && innermost_flags.contains(Flags::MODULE)
808 && !this.disambiguate_macro_rules_vs_modularized(
813 Some(AmbiguityKind::MacroRulesVsModularized)
814 } else if innermost_binding.is_glob_import() {
815 Some(AmbiguityKind::GlobVsOuter)
816 } else if innermost_binding
817 .may_appear_after(parent_scope.expansion, binding)
819 Some(AmbiguityKind::MoreExpandedVsOuter)
823 if let Some(kind) = ambiguity_error_kind {
824 let misc = |f: Flags| {
825 if f.contains(Flags::MISC_SUGGEST_CRATE) {
826 AmbiguityErrorMisc::SuggestCrate
827 } else if f.contains(Flags::MISC_SUGGEST_SELF) {
828 AmbiguityErrorMisc::SuggestSelf
829 } else if f.contains(Flags::MISC_FROM_PRELUDE) {
830 AmbiguityErrorMisc::FromPrelude
832 AmbiguityErrorMisc::None
835 this.ambiguity_errors.push(AmbiguityError {
838 b1: innermost_binding,
840 misc1: misc(innermost_flags),
843 return Some(Ok(innermost_binding));
847 // Found the first solution.
848 innermost_result = Some((binding, flags));
851 Ok(..) | Err(Determinacy::Determined) => {}
852 Err(Determinacy::Undetermined) => determinacy = Determinacy::Undetermined,
859 if let Some(break_result) = break_result {
863 // The first found solution was the only one, return it.
864 if let Some((binding, _)) = innermost_result {
868 Err(Determinacy::determined(determinacy == Determinacy::Determined || force))
871 crate fn finalize_macro_resolutions(&mut self) {
872 let check_consistency = |this: &mut Self,
876 initial_res: Option<Res>,
878 if let Some(initial_res) = initial_res {
879 if res != initial_res && res != Res::Err && this.ambiguity_errors.is_empty() {
880 // Make sure compilation does not succeed if preferred macro resolution
881 // has changed after the macro had been expanded. In theory all such
882 // situations should be reported as ambiguity errors, so this is a bug.
883 span_bug!(span, "inconsistent resolution for a macro");
886 // It's possible that the macro was unresolved (indeterminate) and silently
887 // expanded into a dummy fragment for recovery during expansion.
888 // Now, post-expansion, the resolution may succeed, but we can't change the
889 // past and need to report an error.
890 // However, non-speculative `resolve_path` can successfully return private items
891 // even if speculative `resolve_path` returned nothing previously, so we skip this
892 // less informative error if the privacy error is reported elsewhere.
893 if this.privacy_errors.is_empty() {
895 "cannot determine resolution for the {} `{}`",
897 Segment::names_to_string(path)
899 let msg_note = "import resolution is stuck, try simplifying macro imports";
900 this.session.struct_span_err(span, &msg).note(msg_note).emit();
905 let macro_resolutions = mem::take(&mut self.multi_segment_macro_resolutions);
906 for (mut path, path_span, kind, parent_scope, initial_res) in macro_resolutions {
907 // FIXME: Path resolution will ICE if segment IDs present.
908 for seg in &mut path {
911 match self.resolve_path(
919 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 => {
920 let res = path_res.base_res();
921 check_consistency(self, &path, path_span, kind, initial_res, res);
923 path_res @ PathResult::NonModule(..) | path_res @ PathResult::Failed { .. } => {
924 let (span, label) = if let PathResult::Failed { span, label, .. } = path_res {
930 "partially resolved path in {} {}",
938 ResolutionError::FailedToResolve { label, suggestion: None },
941 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
945 let macro_resolutions = mem::take(&mut self.single_segment_macro_resolutions);
946 for (ident, kind, parent_scope, initial_binding) in macro_resolutions {
947 match self.early_resolve_ident_in_lexical_scope(
949 ScopeSet::Macro(kind),
956 let initial_res = initial_binding.map(|initial_binding| {
957 self.record_use(ident, MacroNS, initial_binding, false);
958 initial_binding.res()
960 let res = binding.res();
961 let seg = Segment::from_ident(ident);
962 check_consistency(self, &[seg], ident.span, kind, initial_res, res);
965 let expected = kind.descr_expected();
966 let msg = format!("cannot find {} `{}` in this scope", expected, ident);
967 let mut err = self.session.struct_span_err(ident.span, &msg);
968 self.unresolved_macro_suggestions(&mut err, kind, &parent_scope, ident);
974 let builtin_attrs = mem::take(&mut self.builtin_attrs);
975 for (ident, parent_scope) in builtin_attrs {
976 let _ = self.early_resolve_ident_in_lexical_scope(
978 ScopeSet::Macro(MacroKind::Attr),
987 fn check_stability_and_deprecation(&mut self, ext: &SyntaxExtension, path: &ast::Path) {
988 let span = path.span;
989 if let Some(stability) = &ext.stability {
990 if let StabilityLevel::Unstable { reason, issue, is_soft } = stability.level {
991 let feature = stability.feature;
992 if !self.active_features.contains(&feature) && !span.allows_unstable(feature) {
993 let node_id = ast::CRATE_NODE_ID;
994 let lint_buffer = &mut self.lint_buffer;
996 |lint, span, msg: &_| lint_buffer.buffer_lint(lint, node_id, span, msg);
997 stability::report_unstable(
1008 if let Some(depr) = &stability.rustc_depr {
1009 let path = pprust::path_to_string(path);
1010 let (message, lint) = stability::rustc_deprecation_message(depr, &path);
1011 stability::early_report_deprecation(
1012 &mut self.lint_buffer,
1020 if let Some(depr) = &ext.deprecation {
1021 let path = pprust::path_to_string(&path);
1022 let (message, lint) = stability::deprecation_message(depr, &path);
1023 stability::early_report_deprecation(&mut self.lint_buffer, &message, None, lint, span);
1027 fn prohibit_imported_non_macro_attrs(
1029 binding: Option<&'a NameBinding<'a>>,
1033 if let Some(Res::NonMacroAttr(kind)) = res {
1034 if kind != NonMacroAttrKind::Tool && binding.map_or(true, |b| b.is_import()) {
1036 format!("cannot use {} {} through an import", kind.article(), kind.descr());
1037 let mut err = self.session.struct_span_err(span, &msg);
1038 if let Some(binding) = binding {
1039 err.span_note(binding.span, &format!("the {} imported here", kind.descr()));
1046 crate fn check_reserved_macro_name(&mut self, ident: Ident, res: Res) {
1047 // Reserve some names that are not quite covered by the general check
1048 // performed on `Resolver::builtin_attrs`.
1049 if ident.name == sym::cfg || ident.name == sym::cfg_attr || ident.name == sym::derive {
1050 let macro_kind = self.get_macro(res).map(|ext| ext.macro_kind());
1051 if macro_kind.is_some() && sub_namespace_match(macro_kind, Some(MacroKind::Attr)) {
1052 self.session.span_err(
1054 &format!("name `{}` is reserved in attribute namespace", ident),
1060 /// Compile the macro into a `SyntaxExtension` and possibly replace
1061 /// its expander to a pre-defined one for built-in macros.
1062 crate fn compile_macro(&mut self, item: &ast::Item, edition: Edition) -> SyntaxExtension {
1063 let mut result = compile_declarative_macro(
1064 &self.session.parse_sess,
1065 self.session.features_untracked(),
1070 if result.is_builtin {
1071 // The macro was marked with `#[rustc_builtin_macro]`.
1072 if let Some(ext) = self.builtin_macros.remove(&item.ident.name) {
1073 // The macro is a built-in, replace its expander function
1074 // while still taking everything else from the source code.
1075 result.kind = ext.kind;
1077 let msg = format!("cannot find a built-in macro with name `{}`", item.ident);
1078 self.session.span_err(item.span, &msg);