rust/crates/syntax/src/ptr.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

99 lines
2.8 KiB
Rust
Raw Normal View History

2021-05-22 08:53:47 -05:00
//! In rust-analyzer, syntax trees are transient objects.
//!
//! That means that we create trees when we need them, and tear them down to
//! save memory. In this architecture, hanging on to a particular syntax node
//! for a long time is ill-advisable, as that keeps the whole tree resident.
//!
//! Instead, we provide a [`SyntaxNodePtr`] type, which stores information about
//! *location* of a particular syntax node in a tree. Its a small type which can
//! be cheaply stored, and which can be resolved to a real [`SyntaxNode`] when
//! necessary.
use std::{
hash::{Hash, Hasher},
marker::PhantomData,
};
2019-01-23 08:37:10 -06:00
2021-12-30 01:48:53 -06:00
use crate::{syntax_node::RustLanguage, AstNode, SyntaxNode};
2019-07-18 11:23:05 -05:00
2021-12-30 01:48:53 -06:00
/// A "pointer" to a [`SyntaxNode`], via location in the source code.
pub type SyntaxNodePtr = rowan::ast::SyntaxNodePtr<RustLanguage>;
2019-01-23 08:37:10 -06:00
2021-12-30 01:48:53 -06:00
/// Like `SyntaxNodePtr`, but remembers the type of node.
#[derive(Debug)]
2019-01-23 09:26:02 -06:00
pub struct AstPtr<N: AstNode> {
2019-01-24 04:40:36 -06:00
raw: SyntaxNodePtr,
_ty: PhantomData<fn() -> N>,
2019-01-23 09:26:02 -06:00
}
impl<N: AstNode> Clone for AstPtr<N> {
fn clone(&self) -> AstPtr<N> {
2020-04-10 17:27:00 -05:00
AstPtr { raw: self.raw.clone(), _ty: PhantomData }
2019-01-23 09:26:02 -06:00
}
}
impl<N: AstNode> Eq for AstPtr<N> {}
impl<N: AstNode> PartialEq for AstPtr<N> {
fn eq(&self, other: &AstPtr<N>) -> bool {
self.raw == other.raw
}
}
impl<N: AstNode> Hash for AstPtr<N> {
fn hash<H: Hasher>(&self, state: &mut H) {
self.raw.hash(state);
}
}
2019-01-23 09:26:02 -06:00
impl<N: AstNode> AstPtr<N> {
pub fn new(node: &N) -> AstPtr<N> {
2019-02-08 05:49:43 -06:00
AstPtr { raw: SyntaxNodePtr::new(node.syntax()), _ty: PhantomData }
2019-01-23 09:26:02 -06:00
}
2020-04-10 17:27:00 -05:00
pub fn to_node(&self, root: &SyntaxNode) -> N {
2019-05-13 11:39:06 -05:00
let syntax_node = self.raw.to_node(root);
2019-01-23 09:26:02 -06:00
N::cast(syntax_node).unwrap()
}
2020-04-10 17:27:00 -05:00
pub fn syntax_node_ptr(&self) -> SyntaxNodePtr {
self.raw.clone()
2019-01-23 09:26:02 -06:00
}
2019-07-19 10:22:00 -05:00
pub fn cast<U: AstNode>(self) -> Option<AstPtr<U>> {
2021-12-30 01:48:53 -06:00
if !U::can_cast(self.raw.kind()) {
return None;
}
Some(AstPtr { raw: self.raw, _ty: PhantomData })
}
2021-12-30 01:48:53 -06:00
pub fn upcast<M: AstNode>(self) -> AstPtr<M>
where
N: Into<M>,
{
AstPtr { raw: self.raw, _ty: PhantomData }
}
2021-12-30 01:48:53 -06:00
/// Like `SyntaxNodePtr::cast` but the trait bounds work out.
pub fn try_from_raw(raw: SyntaxNodePtr) -> Option<AstPtr<N>> {
N::can_cast(raw.kind()).then(|| AstPtr { raw, _ty: PhantomData })
}
2019-01-23 09:26:02 -06:00
}
2019-03-23 08:28:47 -05:00
impl<N: AstNode> From<AstPtr<N>> for SyntaxNodePtr {
fn from(ptr: AstPtr<N>) -> SyntaxNodePtr {
ptr.raw
}
}
2019-01-23 08:37:10 -06:00
#[test]
fn test_local_syntax_ptr() {
2019-05-13 11:39:06 -05:00
use crate::{ast, AstNode, SourceFile};
2019-01-23 08:37:10 -06:00
2019-05-28 09:34:28 -05:00
let file = SourceFile::parse("struct Foo { f: u32, }").ok().unwrap();
2020-07-30 09:49:13 -05:00
let field = file.syntax().descendants().find_map(ast::RecordField::cast).unwrap();
2019-01-23 08:37:10 -06:00
let ptr = SyntaxNodePtr::new(field.syntax());
2019-05-13 11:39:06 -05:00
let field_syntax = ptr.to_node(file.syntax());
2019-07-18 11:23:05 -05:00
assert_eq!(field.syntax(), &field_syntax);
2019-01-23 08:37:10 -06:00
}