crates/ra_syntax/src/syntax_node.rs

   1 //! This module defines Concrete Syntax Tree (CST), used by rust-analyzer.
   2 //!
   3 //! The CST includes comments and whitespace, provides a single node type,
   4 //! `SyntaxNode`, and a basic traversal API (parent, children, siblings).
   5 //!
   6 //! The *real* implementation is in the (language-agnostic) `rowan` crate, this
   7 //! module just wraps its API.
   8
   9 use rowan::{GreenNodeBuilder, Language};
  10
  11 use crate::{Parse, SmolStr, SyntaxError, SyntaxKind, TextSize};
  12
  13 pub use rowan::GreenNode;
  14
  15 pub(crate) use rowan::GreenToken;
  16
  17 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
  18 pub enum RustLanguage {}
  19 impl Language for RustLanguage {
  20     type Kind = SyntaxKind;
  21
  22     fn kind_from_raw(raw: rowan::SyntaxKind) -> SyntaxKind {
  23         SyntaxKind::from(raw.0)
  24     }
  25
  26     fn kind_to_raw(kind: SyntaxKind) -> rowan::SyntaxKind {
  27         rowan::SyntaxKind(kind.into())
  28     }
  29 }
  30
  31 pub type SyntaxNode = rowan::SyntaxNode<RustLanguage>;
  32 pub type SyntaxToken = rowan::SyntaxToken<RustLanguage>;
  33 pub type SyntaxElement = rowan::SyntaxElement<RustLanguage>;
  34 pub type SyntaxNodeChildren = rowan::SyntaxNodeChildren<RustLanguage>;
  35 pub type SyntaxElementChildren = rowan::SyntaxElementChildren<RustLanguage>;
  36
  37 pub use rowan::{Direction, NodeOrToken};
  38
  39 #[derive(Default)]
  40 pub struct SyntaxTreeBuilder {
  41     errors: Vec<SyntaxError>,
  42     inner: GreenNodeBuilder<'static>,
  43 }
  44
  45 impl SyntaxTreeBuilder {
  46     pub(crate) fn finish_raw(self) -> (GreenNode, Vec<SyntaxError>) {
  47         let green = self.inner.finish();
  48         (green, self.errors)
  49     }
  50
  51     pub fn finish(self) -> Parse<SyntaxNode> {
  52         let (green, errors) = self.finish_raw();
  53         if cfg!(debug_assertions) {
  54             let node = SyntaxNode::new_root(green.clone());
  55             crate::validation::validate_block_structure(&node);
  56         }
  57         Parse::new(green, errors)
  58     }
  59
  60     pub fn token(&mut self, kind: SyntaxKind, text: SmolStr) {
  61         let kind = RustLanguage::kind_to_raw(kind);
  62         self.inner.token(kind, text)
  63     }
  64
  65     pub fn start_node(&mut self, kind: SyntaxKind) {
  66         let kind = RustLanguage::kind_to_raw(kind);
  67         self.inner.start_node(kind)
  68     }
  69
  70     pub fn finish_node(&mut self) {
  71         self.inner.finish_node()
  72     }
  73
  74     pub fn error(&mut self, error: ra_parser::ParseError, text_pos: TextSize) {
  75         self.errors.push(SyntaxError::new_at_offset(*error.0, text_pos))
  76     }
  77 }