mirror of
https://github.com/rust-lang/rust-analyzer
synced 2024-12-25 12:33:33 +00:00
hir_expand: propagate expansion errors
This commit is contained in:
parent
d2f398cd76
commit
d5e9bf80f9
4 changed files with 92 additions and 47 deletions
|
@ -57,8 +57,8 @@ pub use hir_def::{
|
||||||
visibility::Visibility,
|
visibility::Visibility,
|
||||||
};
|
};
|
||||||
pub use hir_expand::{
|
pub use hir_expand::{
|
||||||
name::known, name::AsName, name::Name, HirFileId, InFile, MacroCallId, MacroCallLoc,
|
db::MacroResult, name::known, name::AsName, name::Name, HirFileId, InFile, MacroCallId,
|
||||||
/* FIXME */ MacroDefId, MacroFile, Origin,
|
MacroCallLoc, /* FIXME */ MacroDefId, MacroFile, Origin,
|
||||||
};
|
};
|
||||||
pub use hir_ty::display::HirDisplay;
|
pub use hir_ty::display::HirDisplay;
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,19 @@ use crate::{
|
||||||
MacroFile, ProcMacroExpander,
|
MacroFile, ProcMacroExpander,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// A result of some macro expansion.
|
||||||
|
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||||
|
pub struct MacroResult<T> {
|
||||||
|
/// The result of the expansion. Might be `None` when error recovery was impossible and no
|
||||||
|
/// usable result was produced.
|
||||||
|
pub value: Option<T>,
|
||||||
|
|
||||||
|
/// The error that occurred during expansion or processing.
|
||||||
|
///
|
||||||
|
/// Since we do error recovery, getting an error here does not mean that `value` will be absent.
|
||||||
|
pub error: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Eq, PartialEq)]
|
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||||
pub enum TokenExpander {
|
pub enum TokenExpander {
|
||||||
MacroRules(mbe::MacroRules),
|
MacroRules(mbe::MacroRules),
|
||||||
|
@ -75,9 +88,11 @@ pub trait AstDatabase: SourceDatabase {
|
||||||
#[salsa::transparent]
|
#[salsa::transparent]
|
||||||
fn macro_arg(&self, id: MacroCallId) -> Option<Arc<(tt::Subtree, mbe::TokenMap)>>;
|
fn macro_arg(&self, id: MacroCallId) -> Option<Arc<(tt::Subtree, mbe::TokenMap)>>;
|
||||||
fn macro_def(&self, id: MacroDefId) -> Option<Arc<(TokenExpander, mbe::TokenMap)>>;
|
fn macro_def(&self, id: MacroDefId) -> Option<Arc<(TokenExpander, mbe::TokenMap)>>;
|
||||||
fn parse_macro(&self, macro_file: MacroFile)
|
fn parse_macro(
|
||||||
-> Option<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)>;
|
&self,
|
||||||
fn macro_expand(&self, macro_call: MacroCallId) -> (Option<Arc<tt::Subtree>>, Option<String>);
|
macro_file: MacroFile,
|
||||||
|
) -> MacroResult<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)>;
|
||||||
|
fn macro_expand(&self, macro_call: MacroCallId) -> MacroResult<Arc<tt::Subtree>>;
|
||||||
|
|
||||||
#[salsa::interned]
|
#[salsa::interned]
|
||||||
fn intern_eager_expansion(&self, eager: EagerCallLoc) -> EagerMacroId;
|
fn intern_eager_expansion(&self, eager: EagerCallLoc) -> EagerMacroId;
|
||||||
|
@ -85,6 +100,20 @@ pub trait AstDatabase: SourceDatabase {
|
||||||
fn expand_proc_macro(&self, call: MacroCallId) -> Result<tt::Subtree, mbe::ExpandError>;
|
fn expand_proc_macro(&self, call: MacroCallId) -> Result<tt::Subtree, mbe::ExpandError>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<T> MacroResult<T> {
|
||||||
|
fn error(message: String) -> Self {
|
||||||
|
Self { value: None, error: Some(message) }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn map<U>(self, f: impl FnOnce(T) -> U) -> MacroResult<U> {
|
||||||
|
MacroResult { value: self.value.map(f), error: self.error }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn drop_value<U>(self) -> MacroResult<U> {
|
||||||
|
MacroResult { value: None, error: self.error }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// This expands the given macro call, but with different arguments. This is
|
/// This expands the given macro call, but with different arguments. This is
|
||||||
/// used for completion, where we want to see what 'would happen' if we insert a
|
/// used for completion, where we want to see what 'would happen' if we insert a
|
||||||
/// token. The `token_to_map` mapped down into the expansion, with the mapped
|
/// token. The `token_to_map` mapped down into the expansion, with the mapped
|
||||||
|
@ -102,7 +131,7 @@ pub fn expand_hypothetical(
|
||||||
let token_id = tmap_1.token_by_range(range)?;
|
let token_id = tmap_1.token_by_range(range)?;
|
||||||
let macro_def = expander(db, actual_macro_call)?;
|
let macro_def = expander(db, actual_macro_call)?;
|
||||||
let (node, tmap_2) =
|
let (node, tmap_2) =
|
||||||
parse_macro_with_arg(db, macro_file, Some(std::sync::Arc::new((tt, tmap_1))))?;
|
parse_macro_with_arg(db, macro_file, Some(std::sync::Arc::new((tt, tmap_1)))).value?;
|
||||||
let token_id = macro_def.0.map_id_down(token_id);
|
let token_id = macro_def.0.map_id_down(token_id);
|
||||||
let range = tmap_2.range_by_token(token_id)?.by_kind(token_to_map.kind())?;
|
let range = tmap_2.range_by_token(token_id)?.by_kind(token_to_map.kind())?;
|
||||||
let token = syntax::algo::find_covering_element(&node.syntax_node(), range).into_token()?;
|
let token = syntax::algo::find_covering_element(&node.syntax_node(), range).into_token()?;
|
||||||
|
@ -171,10 +200,7 @@ pub(crate) fn macro_arg(
|
||||||
Some(Arc::new((tt, tmap)))
|
Some(Arc::new((tt, tmap)))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn macro_expand(
|
pub(crate) fn macro_expand(db: &dyn AstDatabase, id: MacroCallId) -> MacroResult<Arc<tt::Subtree>> {
|
||||||
db: &dyn AstDatabase,
|
|
||||||
id: MacroCallId,
|
|
||||||
) -> (Option<Arc<tt::Subtree>>, Option<String>) {
|
|
||||||
macro_expand_with_arg(db, id, None)
|
macro_expand_with_arg(db, id, None)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -195,17 +221,19 @@ fn macro_expand_with_arg(
|
||||||
db: &dyn AstDatabase,
|
db: &dyn AstDatabase,
|
||||||
id: MacroCallId,
|
id: MacroCallId,
|
||||||
arg: Option<Arc<(tt::Subtree, mbe::TokenMap)>>,
|
arg: Option<Arc<(tt::Subtree, mbe::TokenMap)>>,
|
||||||
) -> (Option<Arc<tt::Subtree>>, Option<String>) {
|
) -> MacroResult<Arc<tt::Subtree>> {
|
||||||
let lazy_id = match id {
|
let lazy_id = match id {
|
||||||
MacroCallId::LazyMacro(id) => id,
|
MacroCallId::LazyMacro(id) => id,
|
||||||
MacroCallId::EagerMacro(id) => {
|
MacroCallId::EagerMacro(id) => {
|
||||||
if arg.is_some() {
|
if arg.is_some() {
|
||||||
return (
|
return MacroResult::error(
|
||||||
None,
|
"hypothetical macro expansion not implemented for eager macro".to_owned(),
|
||||||
Some("hypothetical macro expansion not implemented for eager macro".to_owned()),
|
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
return (Some(db.lookup_intern_eager_expansion(id).subtree), None);
|
return MacroResult {
|
||||||
|
value: Some(db.lookup_intern_eager_expansion(id).subtree),
|
||||||
|
error: None,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -213,20 +241,21 @@ fn macro_expand_with_arg(
|
||||||
let loc = db.lookup_intern_macro(lazy_id);
|
let loc = db.lookup_intern_macro(lazy_id);
|
||||||
let macro_arg = match arg.or_else(|| db.macro_arg(id)) {
|
let macro_arg = match arg.or_else(|| db.macro_arg(id)) {
|
||||||
Some(it) => it,
|
Some(it) => it,
|
||||||
None => return (None, Some("Fail to args in to tt::TokenTree".into())),
|
None => return MacroResult::error("Fail to args in to tt::TokenTree".into()),
|
||||||
};
|
};
|
||||||
|
|
||||||
let macro_rules = match db.macro_def(loc.def) {
|
let macro_rules = match db.macro_def(loc.def) {
|
||||||
Some(it) => it,
|
Some(it) => it,
|
||||||
None => return (None, Some("Fail to find macro definition".into())),
|
None => return MacroResult::error("Fail to find macro definition".into()),
|
||||||
};
|
};
|
||||||
let ExpandResult(tt, err) = macro_rules.0.expand(db, lazy_id, ¯o_arg.0);
|
let ExpandResult(tt, err) = macro_rules.0.expand(db, lazy_id, ¯o_arg.0);
|
||||||
// Set a hard limit for the expanded tt
|
// Set a hard limit for the expanded tt
|
||||||
let count = tt.count();
|
let count = tt.count();
|
||||||
if count > 262144 {
|
if count > 262144 {
|
||||||
return (None, Some(format!("Total tokens count exceed limit : count = {}", count)));
|
return MacroResult::error(format!("Total tokens count exceed limit : count = {}", count));
|
||||||
}
|
}
|
||||||
(Some(Arc::new(tt)), err.map(|e| format!("{:?}", e)))
|
|
||||||
|
MacroResult { value: Some(Arc::new(tt)), error: err.map(|e| format!("{:?}", e)) }
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn expand_proc_macro(
|
pub(crate) fn expand_proc_macro(
|
||||||
|
@ -260,7 +289,7 @@ pub(crate) fn parse_or_expand(db: &dyn AstDatabase, file_id: HirFileId) -> Optio
|
||||||
match file_id.0 {
|
match file_id.0 {
|
||||||
HirFileIdRepr::FileId(file_id) => Some(db.parse(file_id).tree().syntax().clone()),
|
HirFileIdRepr::FileId(file_id) => Some(db.parse(file_id).tree().syntax().clone()),
|
||||||
HirFileIdRepr::MacroFile(macro_file) => {
|
HirFileIdRepr::MacroFile(macro_file) => {
|
||||||
db.parse_macro(macro_file).map(|(it, _)| it.syntax_node())
|
db.parse_macro(macro_file).map(|(it, _)| it.syntax_node()).value
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -268,7 +297,7 @@ pub(crate) fn parse_or_expand(db: &dyn AstDatabase, file_id: HirFileId) -> Optio
|
||||||
pub(crate) fn parse_macro(
|
pub(crate) fn parse_macro(
|
||||||
db: &dyn AstDatabase,
|
db: &dyn AstDatabase,
|
||||||
macro_file: MacroFile,
|
macro_file: MacroFile,
|
||||||
) -> Option<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)> {
|
) -> MacroResult<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)> {
|
||||||
parse_macro_with_arg(db, macro_file, None)
|
parse_macro_with_arg(db, macro_file, None)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -276,16 +305,16 @@ pub fn parse_macro_with_arg(
|
||||||
db: &dyn AstDatabase,
|
db: &dyn AstDatabase,
|
||||||
macro_file: MacroFile,
|
macro_file: MacroFile,
|
||||||
arg: Option<Arc<(tt::Subtree, mbe::TokenMap)>>,
|
arg: Option<Arc<(tt::Subtree, mbe::TokenMap)>>,
|
||||||
) -> Option<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)> {
|
) -> MacroResult<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)> {
|
||||||
let _p = profile::span("parse_macro_query");
|
let _p = profile::span("parse_macro_query");
|
||||||
|
|
||||||
let macro_call_id = macro_file.macro_call_id;
|
let macro_call_id = macro_file.macro_call_id;
|
||||||
let (tt, err) = if let Some(arg) = arg {
|
let result = if let Some(arg) = arg {
|
||||||
macro_expand_with_arg(db, macro_call_id, Some(arg))
|
macro_expand_with_arg(db, macro_call_id, Some(arg))
|
||||||
} else {
|
} else {
|
||||||
db.macro_expand(macro_call_id)
|
db.macro_expand(macro_call_id)
|
||||||
};
|
};
|
||||||
if let Some(err) = &err {
|
if let Some(err) = &result.error {
|
||||||
// Note:
|
// Note:
|
||||||
// The final goal we would like to make all parse_macro success,
|
// The final goal we would like to make all parse_macro success,
|
||||||
// such that the following log will not call anyway.
|
// such that the following log will not call anyway.
|
||||||
|
@ -313,30 +342,44 @@ pub fn parse_macro_with_arg(
|
||||||
log::warn!("fail on macro_parse: (reason: {})", err);
|
log::warn!("fail on macro_parse: (reason: {})", err);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
let tt = match result.value {
|
||||||
|
Some(tt) => tt,
|
||||||
|
None => return result.drop_value(),
|
||||||
};
|
};
|
||||||
let tt = tt?;
|
|
||||||
|
|
||||||
let fragment_kind = to_fragment_kind(db, macro_call_id);
|
let fragment_kind = to_fragment_kind(db, macro_call_id);
|
||||||
|
|
||||||
let (parse, rev_token_map) = mbe::token_tree_to_syntax_node(&tt, fragment_kind).ok()?;
|
let (parse, rev_token_map) = match mbe::token_tree_to_syntax_node(&tt, fragment_kind) {
|
||||||
|
Ok(it) => it,
|
||||||
if err.is_none() {
|
Err(err) => {
|
||||||
Some((parse, Arc::new(rev_token_map)))
|
return MacroResult::error(format!("{:?}", err));
|
||||||
} else {
|
|
||||||
// FIXME:
|
|
||||||
// In future, we should propagate the actual error with recovery information
|
|
||||||
// instead of ignore the error here.
|
|
||||||
|
|
||||||
// Safe check for recurisve identity macro
|
|
||||||
let node = parse.syntax_node();
|
|
||||||
let file: HirFileId = macro_file.into();
|
|
||||||
let call_node = file.call_node(db)?;
|
|
||||||
|
|
||||||
if !diff(&node, &call_node.value).is_empty() {
|
|
||||||
Some((parse, Arc::new(rev_token_map)))
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
}
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
match result.error {
|
||||||
|
Some(error) => {
|
||||||
|
// FIXME:
|
||||||
|
// In future, we should propagate the actual error with recovery information
|
||||||
|
// instead of ignore the error here.
|
||||||
|
|
||||||
|
// Safe check for recurisve identity macro
|
||||||
|
let node = parse.syntax_node();
|
||||||
|
let file: HirFileId = macro_file.into();
|
||||||
|
let call_node = match file.call_node(db) {
|
||||||
|
Some(it) => it,
|
||||||
|
None => {
|
||||||
|
return MacroResult::error(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
if !diff(&node, &call_node.value).is_empty() {
|
||||||
|
MacroResult { value: Some((parse, Arc::new(rev_token_map))), error: None }
|
||||||
|
} else {
|
||||||
|
return MacroResult::error(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => MacroResult { value: Some((parse, Arc::new(rev_token_map))), error: None },
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -144,7 +144,7 @@ impl HirFileId {
|
||||||
let def_tt = loc.def.ast_id?.to_node(db).token_tree()?;
|
let def_tt = loc.def.ast_id?.to_node(db).token_tree()?;
|
||||||
|
|
||||||
let macro_def = db.macro_def(loc.def)?;
|
let macro_def = db.macro_def(loc.def)?;
|
||||||
let (parse, exp_map) = db.parse_macro(macro_file)?;
|
let (parse, exp_map) = db.parse_macro(macro_file).value?;
|
||||||
let macro_arg = db.macro_arg(macro_file.macro_call_id)?;
|
let macro_arg = db.macro_arg(macro_file.macro_call_id)?;
|
||||||
|
|
||||||
Some(ExpansionInfo {
|
Some(ExpansionInfo {
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
use std::{fmt, iter::FromIterator, sync::Arc};
|
use std::{fmt, iter::FromIterator, sync::Arc};
|
||||||
|
|
||||||
use hir::MacroFile;
|
use hir::{MacroFile, MacroResult};
|
||||||
use ide_db::base_db::{
|
use ide_db::base_db::{
|
||||||
salsa::debug::{DebugQueryTable, TableEntry},
|
salsa::debug::{DebugQueryTable, TableEntry},
|
||||||
CrateId, FileId, FileTextQuery, SourceDatabase, SourceRootId,
|
CrateId, FileId, FileTextQuery, SourceDatabase, SourceRootId,
|
||||||
|
@ -115,10 +115,12 @@ impl FromIterator<TableEntry<FileId, Parse<ast::SourceFile>>> for SyntaxTreeStat
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<M> FromIterator<TableEntry<MacroFile, Option<(Parse<SyntaxNode>, M)>>> for SyntaxTreeStats {
|
impl<M> FromIterator<TableEntry<MacroFile, MacroResult<(Parse<SyntaxNode>, M)>>>
|
||||||
|
for SyntaxTreeStats
|
||||||
|
{
|
||||||
fn from_iter<T>(iter: T) -> SyntaxTreeStats
|
fn from_iter<T>(iter: T) -> SyntaxTreeStats
|
||||||
where
|
where
|
||||||
T: IntoIterator<Item = TableEntry<MacroFile, Option<(Parse<SyntaxNode>, M)>>>,
|
T: IntoIterator<Item = TableEntry<MacroFile, MacroResult<(Parse<SyntaxNode>, M)>>>,
|
||||||
{
|
{
|
||||||
let mut res = SyntaxTreeStats::default();
|
let mut res = SyntaxTreeStats::default();
|
||||||
for entry in iter {
|
for entry in iter {
|
||||||
|
|
Loading…
Reference in a new issue