Trait ra_ap_hir_expand::db::AstDatabase
source · [−]pub trait AstDatabase: Database + HasQueryGroup<AstDatabaseStorage> + SourceDatabase {
fn ast_id_map(&self, file_id: HirFileId) -> Arc<AstIdMap>;
fn parse_or_expand(&self, file_id: HirFileId) -> Option<SyntaxNode>;
fn parse_macro_expansion(
&self,
macro_file: MacroFile
) -> ExpandResult<Option<(Parse<SyntaxNode>, Arc<TokenMap>)>>;
fn intern_macro_call(&self, macro_call: MacroCallLoc) -> MacroCallId;
fn lookup_intern_macro_call(&self, key: MacroCallId) -> MacroCallLoc;
fn macro_arg(&self, id: MacroCallId) -> Option<Arc<(Subtree, TokenMap)>>;
fn macro_arg_text(&self, id: MacroCallId) -> Option<GreenNode>;
fn macro_def(
&self,
id: MacroDefId
) -> Result<Arc<TokenExpander>, ParseError>;
fn macro_expand(
&self,
macro_call: MacroCallId
) -> ExpandResult<Option<Arc<Subtree>>>;
fn expand_proc_macro(&self, call: MacroCallId) -> ExpandResult<Subtree>;
fn macro_expand_error(&self, macro_call: MacroCallId) -> Option<ExpandError>;
fn hygiene_frame(&self, file_id: HirFileId) -> Arc<HygieneFrame>;
}
Required methods
fn ast_id_map(&self, file_id: HirFileId) -> Arc<AstIdMap>
fn parse_or_expand(&self, file_id: HirFileId) -> Option<SyntaxNode>
fn parse_or_expand(&self, file_id: HirFileId) -> Option<SyntaxNode>
Main public API – parses a hir file, not caring whether it’s a real file or a macro expansion.
fn parse_macro_expansion(
&self,
macro_file: MacroFile
) -> ExpandResult<Option<(Parse<SyntaxNode>, Arc<TokenMap>)>>
fn parse_macro_expansion(
&self,
macro_file: MacroFile
) -> ExpandResult<Option<(Parse<SyntaxNode>, Arc<TokenMap>)>>
Implementation for the macro case.
fn intern_macro_call(&self, macro_call: MacroCallLoc) -> MacroCallId
fn intern_macro_call(&self, macro_call: MacroCallLoc) -> MacroCallId
Macro ids. That’s probably the tricksiest bit in rust-analyzer, and the reason why we use salsa at all.
We encode macro definitions into ids of macro calls, this what allows us to be incremental.
fn lookup_intern_macro_call(&self, key: MacroCallId) -> MacroCallLoc
Lowers syntactic macro call to a token tree representation.
fn macro_arg_text(&self, id: MacroCallId) -> Option<GreenNode>
fn macro_arg_text(&self, id: MacroCallId) -> Option<GreenNode>
Extracts syntax node, corresponding to a macro call. That’s a firewall query, only typing in the macro call itself changes the returned subtree.
fn macro_def(&self, id: MacroDefId) -> Result<Arc<TokenExpander>, ParseError>
fn macro_def(&self, id: MacroDefId) -> Result<Arc<TokenExpander>, ParseError>
Gets the expander for this macro. This compiles declarative macros, and just fetches procedural ones.
fn macro_expand(
&self,
macro_call: MacroCallId
) -> ExpandResult<Option<Arc<Subtree>>>
fn macro_expand(
&self,
macro_call: MacroCallId
) -> ExpandResult<Option<Arc<Subtree>>>
Expand macro call to a token tree. This query is LRUed (we keep 128 or so results in memory)
fn expand_proc_macro(&self, call: MacroCallId) -> ExpandResult<Subtree>
fn expand_proc_macro(&self, call: MacroCallId) -> ExpandResult<Subtree>
Special case of the previous query for procedural macros. We can’t LRU proc macros, since they are not deterministic in general, and non-determinism breaks salsa in a very, very, very bad way. @edwin0cheng heroically debugged this once!
fn macro_expand_error(&self, macro_call: MacroCallId) -> Option<ExpandError>
fn macro_expand_error(&self, macro_call: MacroCallId) -> Option<ExpandError>
Firewall query that returns the error from the macro_expand
query.