//! This modules handles hygiene information. //! //! Specifically, `ast` + `Hygiene` allows you to create a `Name`. Note that, at //! this moment, this is horribly incomplete and handles only `$crate`. use std::sync::Arc; use base_db::CrateId; use db::TokenExpander; use either::Either; use mbe::Origin; use syntax::{ ast::{self, HasDocComments}, AstNode, SyntaxKind, SyntaxNode, TextRange, TextSize, }; use crate::{ db::{self, AstDatabase}, fixup, name::{AsName, Name}, HirFileId, InFile, MacroCallKind, MacroCallLoc, MacroDefKind, MacroFile, }; #[derive(Clone, Debug)] pub struct Hygiene { frames: Option, } impl Hygiene { pub fn new(db: &dyn AstDatabase, file_id: HirFileId) -> Hygiene { Hygiene { frames: Some(HygieneFrames::new(db, file_id)) } } pub fn new_unhygienic() -> Hygiene { Hygiene { frames: None } } // FIXME: this should just return name pub fn name_ref_to_name( &self, db: &dyn AstDatabase, name_ref: ast::NameRef, ) -> Either { if let Some(frames) = &self.frames { if name_ref.text() == "$crate" { if let Some(krate) = frames.root_crate(db, name_ref.syntax()) { return Either::Right(krate); } } } Either::Left(name_ref.as_name()) } pub fn local_inner_macros(&self, db: &dyn AstDatabase, path: ast::Path) -> Option { let mut token = path.syntax().first_token()?.text_range(); let frames = self.frames.as_ref()?; let mut current = &frames.0; loop { let (mapped, origin) = current.expansion.as_ref()?.map_ident_up(db, token)?; if origin == Origin::Def { return if current.local_inner { frames.root_crate(db, path.syntax()) } else { None }; } current = current.call_site.as_ref()?; token = mapped.value; } } } #[derive(Clone, Debug)] struct HygieneFrames(Arc); #[derive(Clone, Debug, Eq, PartialEq)] pub struct HygieneFrame { expansion: Option, // Indicate this is a local inner macro local_inner: bool, krate: Option, call_site: Option>, def_site: Option>, } impl HygieneFrames { fn new(db: &dyn AstDatabase, file_id: HirFileId) -> Self { // Note that this intentionally avoids the `hygiene_frame` query to avoid blowing up memory // usage. The query is only helpful for nested `HygieneFrame`s as it avoids redundant work. HygieneFrames(Arc::new(HygieneFrame::new(db, file_id))) } fn root_crate(&self, db: &dyn AstDatabase, node: &SyntaxNode) -> Option { let mut token = node.first_token()?.text_range(); let mut result = self.0.krate; let mut current = self.0.clone(); while let Some((mapped, origin)) = current.expansion.as_ref().and_then(|it| it.map_ident_up(db, token)) { result = current.krate; let site = match origin { Origin::Def => ¤t.def_site, Origin::Call => ¤t.call_site, }; let site = match site { None => break, Some(it) => it, }; current = site.clone(); token = mapped.value; } result } } #[derive(Debug, Clone, PartialEq, Eq)] struct HygieneInfo { file: MacroFile, /// The start offset of the `macro_rules!` arguments or attribute input. attr_input_or_mac_def_start: Option>, macro_def: Arc, macro_arg: Arc<(crate::tt::Subtree, mbe::TokenMap, fixup::SyntaxFixupUndoInfo)>, macro_arg_shift: mbe::Shift, exp_map: Arc, } impl HygieneInfo { fn map_ident_up( &self, db: &dyn AstDatabase, token: TextRange, ) -> Option<(InFile, Origin)> { let token_id = self.exp_map.token_by_range(token)?; let (mut token_id, origin) = self.macro_def.map_id_up(token_id); let loc = db.lookup_intern_macro_call(self.file.macro_call_id); let (token_map, tt) = match &loc.kind { MacroCallKind::Attr { attr_args, .. } => match self.macro_arg_shift.unshift(token_id) { Some(unshifted) => { token_id = unshifted; (&attr_args.1, self.attr_input_or_mac_def_start?) } None => ( &self.macro_arg.1, InFile::new(loc.kind.file_id(), loc.kind.arg(db)?.text_range().start()), ), }, _ => match origin { mbe::Origin::Call => ( &self.macro_arg.1, InFile::new(loc.kind.file_id(), loc.kind.arg(db)?.text_range().start()), ), mbe::Origin::Def => match (&*self.macro_def, &self.attr_input_or_mac_def_start) { (TokenExpander::DeclarativeMacro { def_site_token_map, .. }, Some(tt)) => { (def_site_token_map, *tt) } _ => panic!("`Origin::Def` used with non-`macro_rules!` macro"), }, }, }; let range = token_map.first_range_by_token(token_id, SyntaxKind::IDENT)?; Some((tt.with_value(range + tt.value), origin)) } } fn make_hygiene_info( db: &dyn AstDatabase, macro_file: MacroFile, loc: &MacroCallLoc, ) -> Option { let def = loc.def.ast_id().left().and_then(|id| { let def_tt = match id.to_node(db) { ast::Macro::MacroRules(mac) => mac.token_tree()?, ast::Macro::MacroDef(mac) => mac.body()?, }; Some(InFile::new(id.file_id, def_tt)) }); let attr_input_or_mac_def = def.or_else(|| match loc.kind { MacroCallKind::Attr { ast_id, invoc_attr_index, .. } => { let tt = ast_id .to_node(db) .doc_comments_and_attrs() .nth(invoc_attr_index.ast_index()) .and_then(Either::left)? .token_tree()?; Some(InFile::new(ast_id.file_id, tt)) } _ => None, }); let macro_def = db.macro_def(loc.def).ok()?; let (_, exp_map) = db.parse_macro_expansion(macro_file).value?; let macro_arg = db.macro_arg(macro_file.macro_call_id)?; Some(HygieneInfo { file: macro_file, attr_input_or_mac_def_start: attr_input_or_mac_def .map(|it| it.map(|tt| tt.syntax().text_range().start())), macro_arg_shift: mbe::Shift::new(¯o_arg.0), macro_arg, macro_def, exp_map, }) } impl HygieneFrame { pub(crate) fn new(db: &dyn AstDatabase, file_id: HirFileId) -> HygieneFrame { let (info, krate, local_inner) = match file_id.macro_file() { None => (None, None, false), Some(macro_file) => { let loc = db.lookup_intern_macro_call(macro_file.macro_call_id); let info = make_hygiene_info(db, macro_file, &loc).map(|info| (loc.kind.file_id(), info)); match loc.def.kind { MacroDefKind::Declarative(_) => { (info, Some(loc.def.krate), loc.def.local_inner) } MacroDefKind::BuiltIn(..) => (info, Some(loc.def.krate), false), MacroDefKind::BuiltInAttr(..) => (info, None, false), MacroDefKind::BuiltInDerive(..) => (info, None, false), MacroDefKind::BuiltInEager(..) => (info, None, false), MacroDefKind::ProcMacro(..) => (info, None, false), } } }; let (calling_file, info) = match info { None => { return HygieneFrame { expansion: None, local_inner, krate, call_site: None, def_site: None, }; } Some(it) => it, }; let def_site = info.attr_input_or_mac_def_start.map(|it| db.hygiene_frame(it.file_id)); let call_site = Some(db.hygiene_frame(calling_file)); HygieneFrame { expansion: Some(info), local_inner, krate, call_site, def_site } } }