feat: definitions and references lsp hint (#1016)

Add goto definition support for LSP consumers. Adding support for it
directly in LSP server could *maybe* be doable, but unreliable (e.g.
templates are complicating things) and so a lot of parser logic would
need to be reimplemented for all edge cases, so I think this is better
added directly to kanata-parser.

.github/workflows/rust.yml

@@ -70,6 +70,9 @@ jobs:
  - name: Run clippy simulated output
  run: cargo clippy --all --features=simulated_output,cmd -- -D warnings
 
+ - name: Run clippy for parser with lsp feature
+ run: cargo clippy -p kanata-parser --features=lsp -- -D warnings
+
  build-test-clippy-windows:
  runs-on: ${{ matrix.os }}
  strategy:

parser/Cargo.toml

@@ -32,3 +32,4 @@ bytemuck = "1.15.0"
 cmd = []
 interception_driver = []
 gui = []
+lsp = []

parser/src/cfg/defcfg.rs

@@ -11,32 +11,23 @@ use crate::{anyhow_expr, anyhow_span, bail, bail_expr, bail_span};
 pub struct CfgOptionsGui {
  /// File name / path to the tray icon file.
  pub tray_icon: Option<String>,
- #[cfg(all(target_os = "windows", feature = "gui"))]
  /// Whether to match layer names to icon files without an explicit 'icon' field
  pub icon_match_layer_name: bool,
  /// Show tooltip on layer changes showing layer icons
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub tooltip_layer_changes: bool,
  /// Show tooltip on layer changes for the default/base layer
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub tooltip_no_base: bool,
  /// Show tooltip on layer changes even for layers without an icon
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub tooltip_show_blank: bool,
  /// Show tooltip on layer changes for this duration (ms)
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub tooltip_duration: u16,
  /// Show system notification message on config reload
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub notify_cfg_reload: bool,
  /// Disable sound for the system notification message on config reload
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub notify_cfg_reload_silent: bool,
  /// Show system notification message on errors
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub notify_error: bool,
  /// Set tooltip size (width, height)
- #[cfg(all(target_os = "windows", feature = "gui"))]
  pub tooltip_size: (u16, u16),
 }
 #[cfg(all(any(target_os = "windows", target_os = "unknown"), feature = "gui"))]

parser/src/cfg/deftemplate.rs

@@ -37,12 +37,15 @@ struct Template {
 ///
 /// Syntax of `deftemplate` is:
 ///
-/// `(deftemplate (<list of template vars>) <rest of template>)`
+/// `(deftemplate <template name> (<list of template vars>) <rest of template>)`
 ///
 /// Syntax of `template-expand` is:
 ///
 /// `(template-expand <template name> <template var substitutions>)`
-pub fn expand_templates(mut toplevel_exprs: Vec<TopLevel>) -> Result<Vec<TopLevel>> {
+pub fn expand_templates(
+ mut toplevel_exprs: Vec<TopLevel>,
+ lsp_hints: &mut LspHints,
+) -> Result<Vec<TopLevel>> {
  let mut templates: Vec<Template> = vec![];
 
  // Find defined templates
@@ -55,7 +58,7 @@ pub fn expand_templates(mut toplevel_exprs: Vec<TopLevel>) -> Result<Vec<TopLeve
  }
 
  // Parse template name
- let name = list
+ let (name, _name_span) = list
  .t
  .get(1)
  .ok_or_else(|| {
@@ -72,9 +75,14 @@ pub fn expand_templates(mut toplevel_exprs: Vec<TopLevel>) -> Result<Vec<TopLeve
  if templates.iter().any(|t| t.name == name) {
  bail_expr!(name_expr, "template name was already defined earlier");
  }
- Ok(name)
- })?
- .to_owned();
+ Ok((name, name_expr.span()))
+ })?;
+
+ #[cfg(feature = "lsp")]
+ lsp_hints
+ .definition_locations
+ .template
+ .insert(name.to_owned(), _name_span);
 
  // Parse template variable names
  let vars = list
@@ -130,7 +138,7 @@ pub fn expand_templates(mut toplevel_exprs: Vec<TopLevel>) -> Result<Vec<TopLeve
  }
 
  templates.push(Template {
- name,
+ name: name.to_string(),
  vars,
  vars_substitute_names,
  content,
@@ -147,7 +155,7 @@ pub fn expand_templates(mut toplevel_exprs: Vec<TopLevel>) -> Result<Vec<TopLeve
  })
  })
  .collect();
- expand(&mut toplevels, &templates)?;
+ expand(&mut toplevels, &templates, lsp_hints)?;
 
  toplevels.into_iter().try_fold(vec![], |mut tls, tl| {
  tls.push(match &tl {
@@ -169,7 +177,7 @@ struct Replacement {
  insert_index: usize,
 }
 
-fn expand(exprs: &mut Vec<SExpr>, templates: &[Template]) -> Result<()> {
+fn expand(exprs: &mut Vec<SExpr>, templates: &[Template], _lsp_hints: &mut LspHints) -> Result<()> {
  let mut replacements: Vec<Replacement> = vec![];
  for (expr_index, expr) in exprs.iter_mut().enumerate() {
  match expr {
@@ -179,7 +187,7 @@ fn expand(exprs: &mut Vec<SExpr>, templates: &[Template]) -> Result<()> {
  l.t.first().and_then(|expr| expr.atom(None)),
  Some("template-expand") | Some("t!")
  ) {
- expand(&mut l.t, templates)?;
+ expand(&mut l.t, templates, _lsp_hints)?;
  continue;
  }
 
@@ -196,6 +204,11 @@ fn expand(exprs: &mut Vec<SExpr>, templates: &[Template]) -> Result<()> {
  let name = name_expr.atom(None).ok_or_else(|| {
  anyhow_expr!(name_expr, "template name must be a string")
  })?;
+ #[cfg(feature = "lsp")]
+ _lsp_hints
+ .reference_locations
+ .template
+ .push(name, name_expr.span());
  templates.iter().find(|t| t.name == name).ok_or_else(|| {
  anyhow_expr!(
  name_expr,

parser/src/cfg/fake_key.rs

@@ -2,11 +2,28 @@ use super::*;
 
 use crate::{anyhow_expr, bail, bail_expr};
 
+#[allow(unused_variables)]
+fn set_virtual_key_reference_lsp_hint(vk_name_expr: &SExpr, s: &ParserState) {
+ #[cfg(feature = "lsp")]
+ {
+ let atom = match vk_name_expr {
+ SExpr::Atom(x) => x,
+ SExpr::List(_) => unreachable!("should be validated to be atom earlier"),
+ };
+ s.lsp_hints
+ .borrow_mut()
+ .reference_locations
+ .virtual_key
+ .push_from_atom(atom);
+ }
+}
+
 pub(crate) fn parse_on_press_fake_key_op(
  ac_params: &[SExpr],
  s: &ParserState,
 ) -> Result<&'static KanataAction> {
  let (coord, action) = parse_fake_key_op_coord_action(ac_params, s, ON_PRESS_FAKEKEY)?;
+ set_virtual_key_reference_lsp_hint(&ac_params[0], s);
  Ok(s.a.sref(Action::Custom(
  s.a.sref(s.a.sref_slice(CustomAction::FakeKey { coord, action })),
  )))
@@ -17,6 +34,7 @@ pub(crate) fn parse_on_release_fake_key_op(
  s: &ParserState,
 ) -> Result<&'static KanataAction> {
  let (coord, action) = parse_fake_key_op_coord_action(ac_params, s, ON_RELEASE_FAKEKEY)?;
+ set_virtual_key_reference_lsp_hint(&ac_params[0], s);
  Ok(s.a.sref(Action::Custom(s.a.sref(
  s.a.sref_slice(CustomAction::FakeKeyOnRelease { coord, action }),
  ))))
@@ -66,6 +84,7 @@ pub(crate) fn parse_on_idle_fakekey(
  })?;
  let (x, y) = get_fake_key_coords(y);
  let coord = Coord { x, y };
+ set_virtual_key_reference_lsp_hint(&ac_params[0], s);
  Ok(s.a.sref(Action::Custom(s.a.sref(s.a.sref_slice(
  CustomAction::FakeKeyOnIdle(FakeKeyOnIdle {
  coord,
@@ -115,6 +134,7 @@ fn parse_fake_key_op_coord_action(
  )
  })?;
  let (x, y) = get_fake_key_coords(y);
+ set_virtual_key_reference_lsp_hint(&ac_params[0], s);
  Ok((Coord { x, y }, action))
 }
 
@@ -168,6 +188,7 @@ fn parse_vkey_coord(param: &SExpr, s: &ParserState) -> Result<Coord> {
  None => bail_expr!(param, "unknown virtual key name: {name}",),
  };
  let coord = Coord { x: FAKE_KEY_ROW, y };
+ set_virtual_key_reference_lsp_hint(param, s);
  Ok(coord)
 }