|
| 1 | +use rowan::{NodeOrToken, TextRange}; |
| 2 | +use salsa::Database as Db; |
| 3 | +use squawk_syntax::{ |
| 4 | + SyntaxKind, |
| 5 | + ast::{self, AstNode}, |
| 6 | +}; |
| 7 | + |
| 8 | +use crate::db::{File, parse}; |
| 9 | + |
| 10 | +/// A semantic token with its position and classification. |
| 11 | +#[derive(Debug, Clone, PartialEq, Eq)] |
| 12 | +pub struct SemanticToken { |
| 13 | + pub range: TextRange, |
| 14 | + pub token_type: SemanticTokenType, |
| 15 | + pub modifiers: Option<SemanticTokenModifier>, |
| 16 | +} |
| 17 | + |
| 18 | +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| 19 | +#[repr(u8)] |
| 20 | +pub enum SemanticTokenModifier { |
| 21 | + Definition = 0, |
| 22 | + Readonly, |
| 23 | + Documentation, |
| 24 | +} |
| 25 | + |
| 26 | +/// Semantic token types supported by the language server. |
| 27 | +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] |
| 28 | +pub enum SemanticTokenType { |
| 29 | + Keyword, |
| 30 | + String, |
| 31 | + Bool, |
| 32 | + Number, |
| 33 | + Function, |
| 34 | + Operator, |
| 35 | + Punctuation, |
| 36 | + Name, |
| 37 | + NameRef, |
| 38 | + Comment, |
| 39 | + Type, |
| 40 | + Parameter, |
| 41 | + PositionalParam, |
| 42 | +} |
| 43 | + |
| 44 | +#[salsa::tracked] |
| 45 | +pub fn semantic_tokens( |
| 46 | + db: &dyn Db, |
| 47 | + file: File, |
| 48 | + range_to_highlight: Option<TextRange>, |
| 49 | +) -> Vec<SemanticToken> { |
| 50 | + let parse = parse(db, file); |
| 51 | + let tree = parse.tree(); |
| 52 | + let root = tree.syntax(); |
| 53 | + |
| 54 | + // Determine the root based on the given range. |
| 55 | + let (root, range_to_highlight) = { |
| 56 | + let source_file = root; |
| 57 | + match range_to_highlight { |
| 58 | + Some(range) => { |
| 59 | + let node = match source_file.covering_element(range) { |
| 60 | + NodeOrToken::Node(it) => it, |
| 61 | + NodeOrToken::Token(it) => it.parent().unwrap_or_else(|| source_file.clone()), |
| 62 | + }; |
| 63 | + (node, range) |
| 64 | + } |
| 65 | + None => (source_file.clone(), source_file.text_range()), |
| 66 | + } |
| 67 | + }; |
| 68 | + |
| 69 | + let mut out = vec![]; |
| 70 | + |
| 71 | + // Taken from: https://github.com/rust-lang/rust-analyzer/blob/2efc80078029894eec0699f62ec8d5c1a56af763/crates/ide/src/syntax_highlighting.rs#L267C21-L267C21 |
| 72 | + let preorder = root.preorder_with_tokens(); |
| 73 | + for event in preorder { |
| 74 | + use rowan::WalkEvent::{Enter, Leave}; |
| 75 | + |
| 76 | + let range = match &event { |
| 77 | + Enter(it) | Leave(it) => it.text_range(), |
| 78 | + }; |
| 79 | + |
| 80 | + // Element outside of the viewport, no need to highlight |
| 81 | + if range_to_highlight.intersect(range).is_none() { |
| 82 | + continue; |
| 83 | + } |
| 84 | + |
| 85 | + match event { |
| 86 | + Enter(NodeOrToken::Node(node)) => { |
| 87 | + if let Some(target) = ast::Target::cast(node) |
| 88 | + && let Some(as_name) = target.as_name() |
| 89 | + && let Some(name) = as_name.name() |
| 90 | + { |
| 91 | + let range = name.syntax().text_range(); |
| 92 | + out.push(SemanticToken { |
| 93 | + range, |
| 94 | + token_type: SemanticTokenType::Name, |
| 95 | + modifiers: None, |
| 96 | + }); |
| 97 | + }; |
| 98 | + } |
| 99 | + Enter(NodeOrToken::Token(token)) => { |
| 100 | + if token.kind() == SyntaxKind::WHITESPACE { |
| 101 | + continue; |
| 102 | + } |
| 103 | + if token.kind() == SyntaxKind::POSITIONAL_PARAM { |
| 104 | + out.push(SemanticToken { |
| 105 | + range: token.text_range(), |
| 106 | + token_type: SemanticTokenType::PositionalParam, |
| 107 | + modifiers: None, |
| 108 | + }) |
| 109 | + } |
| 110 | + } |
| 111 | + Leave(_) => {} |
| 112 | + } |
| 113 | + } |
| 114 | + out |
| 115 | +} |
| 116 | + |
| 117 | +#[cfg(test)] |
| 118 | +mod test { |
| 119 | + use crate::db::{Database, File}; |
| 120 | + use insta::assert_snapshot; |
| 121 | + use std::fmt::Write; |
| 122 | + |
| 123 | + fn semantic_tokens(sql: &str) -> String { |
| 124 | + let db = Database::default(); |
| 125 | + let file = File::new(&db, sql.to_string().into()); |
| 126 | + let tokens = super::semantic_tokens(&db, file, None); |
| 127 | + |
| 128 | + let mut result = String::new(); |
| 129 | + for token in tokens { |
| 130 | + let start: usize = token.range.start().into(); |
| 131 | + let end: usize = token.range.end().into(); |
| 132 | + let token_text = &sql[start..end]; |
| 133 | + // TODO: once we get modfifiers, we'll need to update this |
| 134 | + let modifiers_text = ""; |
| 135 | + writeln!( |
| 136 | + result, |
| 137 | + "{:?} @ {}..{}: {:?}{}", |
| 138 | + token_text, start, end, token.token_type, modifiers_text |
| 139 | + ) |
| 140 | + .unwrap(); |
| 141 | + } |
| 142 | + result |
| 143 | + } |
| 144 | + |
| 145 | + #[test] |
| 146 | + fn create_function() { |
| 147 | + assert_snapshot!(semantic_tokens(" |
| 148 | +create function add(a int, b int) returns int |
| 149 | + as 'select $1 + $2' |
| 150 | + language sql; |
| 151 | +"), @""); |
| 152 | + } |
| 153 | + |
| 154 | + #[test] |
| 155 | + fn select_keywords() { |
| 156 | + assert_snapshot!(semantic_tokens(" |
| 157 | +select 1 and, 2 select; |
| 158 | +"), @r#" |
| 159 | + "and" @ 10..13: Name |
| 160 | + "select" @ 17..23: Name |
| 161 | + "#) |
| 162 | + } |
| 163 | + |
| 164 | + #[test] |
| 165 | + fn positional_param() { |
| 166 | + assert_snapshot!(semantic_tokens(" |
| 167 | +select $1, $2; |
| 168 | +"), @r#" |
| 169 | + "$1" @ 8..10: PositionalParam |
| 170 | + "$2" @ 12..14: PositionalParam |
| 171 | + "#) |
| 172 | + } |
| 173 | +} |
0 commit comments