Show layer icon near mouse pointer (win-tray)

Cargo.toml

@@ -94,13 +94,19 @@ windows-sys = { version = "0.52.0", features = [
     "Win32_System_Threading",
     "Win32_UI_Controls",
     "Win32_UI_Shell",
+    "Win32_UI_HiDpi",
     "Win32_UI_WindowsAndMessaging",
+    "Win32_System_SystemInformation",
+    "Wdk",
+    "Wdk_System",
+    "Wdk_System_SystemServices",
 ], optional=true }
 win_dbg_logger = { path = "win_dbg_logger", optional = true }
 native-windows-gui = { version = "1.0.13", default_features = false}
 native-windows-derive = { version = "1.0.5", default_features = false, optional = true }
 regex = { version = "1.10.4", optional = true }
 kanata-interception = { version = "0.2.0", optional = true }
+muldiv = { version = "1.0.1", optional = true }
 
 [target.'cfg(target_os = "windows")'.build-dependencies]
 embed-resource = { version = "2.4.2", optional = true }
@@ -120,7 +126,7 @@ simulated_output = ["indoc"]
 simulated_input = ["indoc"]
 passthru_ahk = ["simulated_input","simulated_output"]
 wasm = [ "instant/wasm-bindgen" ]
-gui = ["win_manifest","native-windows-derive","win_dbg_logger","win_dbg_logger/simple_shared","kanata-parser/gui","native-windows-gui/tray-notification","native-windows-gui/message-window","native-windows-gui/menu","native-windows-gui/cursor","native-windows-gui/high-dpi","native-windows-gui/embed-resource","native-windows-gui/image-decoder","native-windows-gui/notice","dep:windows-sys","win_sendinput_send_scancodes","win_llhook_read_scancodes"]
+gui = ["win_manifest","native-windows-derive","win_dbg_logger","win_dbg_logger/simple_shared","kanata-parser/gui","native-windows-gui/tray-notification","native-windows-gui/message-window","native-windows-gui/menu","native-windows-gui/cursor","native-windows-gui/high-dpi","native-windows-gui/embed-resource","native-windows-gui/image-decoder","native-windows-gui/notice","native-windows-gui/animation-timer","muldiv","dep:windows-sys","win_sendinput_send_scancodes","win_llhook_read_scancodes"]
 
 [profile.release]
 opt-level = "z"

cfg_samples/tray-icon/tray-icon.kbd

@@ -3,6 +3,10 @@
   log-layer-changes    	yes	;;|no| overhead
   tray-icon "./_custom-icons/s.png" ;; should activate for layers without icons like '5no-icn'
   icon-match-layer-name yes ;;|yes| match layer name to icon files even without an explicit (icon name.ico) config
+  tooltip-layer-changes	yes  	;;|false|
+  tooltip-show-blank   	yes  	;;|no|
+  tooltip-duration     	500  	;;|500|
+  tooltip-size         	24,24	;;|24 24|
 )
 (defalias l1 (layer-while-held 1emoji))
 (defalias l2 (layer-while-held 2icon-quote))

docs/config.adoc

@@ -2501,6 +2501,48 @@ Show a custom tray icon that matches the name of the active layer if it doesn't
 Otherwise <<tray-icon>> will be used. Defaults to true. File search rules are the same as in <<tray-icon>>.
 See https://github.com/jtroo/kanata/blob/main/cfg_samples/tray-icon/tray-icon.kbd[example config] for more details.
 
+[[windows-only-tooltip-layer-changes]]
+=== Windows only: tooltip-layer-changes
+<<table-of-contents,Back to ToC>>
+
+Show a custom layer icon near the mouse pointer position. Defaults to false. Requires <<windows-only-win-tray>> gui-enabled build.
+
+[[windows-only-tooltip-show-blank]]
+=== Windows only: tooltip-show-blank
+<<table-of-contents,Back to ToC>>
+
+Show a blank square when instead of an icon if a layer isn't configured to have one. Defaults to false. Requires <<windows-only-win-tray>> gui-enabled build.
+
+[[windows-only-tooltip-no-base]]
+=== Windows only: tooltip-no-base
+<<table-of-contents,Back to ToC>>
+
+Don't show a tooltip layer icon for the base layer (1st deflayer). Defaults to true. Requires <<windows-only-win-tray>> gui-enabled build.
+
+[[windows-only-tooltip-duration]]
+=== Windows only: tooltip-duration
+<<table-of-contents,Back to ToC>>
+
+Set duration (in ms) for showing a custom layer icon near the mouse pointer position. 0 to never hide. Defaults to 500. Requires <<windows-only-win-tray>> gui-enabled build.
+
+[[windows-only-tooltip-size]]
+=== Windows only: tooltip-size
+<<table-of-contents,Back to ToC>>
+
+Set the size (comma-separated Width,Height without spaces) for a custom layer icon near the mouse pointer position. Defaults to 24,24. Requires <<windows-only-win-tray>> gui-enabled build.
+
+[[windows-only-notify-cfg-reload]]
+=== Windows only: notify-cfg-reload
+<<table-of-contents,Back to ToC>>
+
+Show system notification message on config reload. Defaults to true. Requires <<windows-only-win-tray>> gui-enabled build.
+
+[[windows-only-notify-cfg-reload-silent]]
+=== Windows only: notify-cfg-reload-silent
+<<table-of-contents,Back to ToC>>
+
+Disable sound for the system notification message on config reload. Defaults to false. Requires <<windows-only-win-tray>> gui-enabled build.
+
 [[using-multiple-defcfg-options]]
 === Using multiple defcfg options
 <<table-of-contents,Back to ToC>>

justfile

@@ -19,6 +19,8 @@ build_release_windows output_dir:
   cargo build --release --features win_manifest,cmd; cp target/release/kanata.exe "{{output_dir}}\kanata_cmd_allowed.exe"
   cargo build --release --features win_manifest,cmd,interception_driver; cp target/release/kanata.exe "{{output_dir}}\kanata_wintercept_cmd_allowed.exe"
   cargo build --release --features passthru_ahk --package=simulated_passthru; cp target/release/kanata_passthru.dll "{{output_dir}}\kanata_passthru.dll"
+  cargo build --release --features win_manifest,gui    ; cp target/release/kanata.exe "{{output_dir}}\kanata_gui.exe"
+  cargo build --release --features win_manifest,gui,cmd; cp target/release/kanata.exe "{{output_dir}}\kanata_gui_cmd_allowed.exe"
   cp cfg_samples/kanata.kbd "{{output_dir}}"
 
 # Generate the sha256sums for all files in the output directory

parser/src/cfg/defcfg.rs

@@ -6,6 +6,53 @@ use crate::custom_action::*;
 #[allow(unused)]
 use crate::{anyhow_expr, anyhow_span, bail, bail_expr, bail_span};
 
+#[cfg(all(any(target_os = "windows", target_os = "unknown"), feature = "gui"))]
+#[derive(Debug, Clone)]
+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,
+    /// 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"))]
+impl Default for CfgOptionsGui {
+    fn default() -> Self {
+        Self {
+            tray_icon: None,
+            icon_match_layer_name: true,
+            tooltip_layer_changes: false,
+            tooltip_show_blank: false,
+            tooltip_no_base: true,
+            tooltip_duration: 500,
+            notify_cfg_reload: true,
+            notify_cfg_reload_silent: false,
+            tooltip_size: (24, 24),
+        }
+    }
+}
+
 #[derive(Debug)]
 pub struct CfgOptions {
     pub process_unmapped_keys: bool,
@@ -56,9 +103,7 @@ pub struct CfgOptions {
     #[cfg(any(target_os = "macos", target_os = "unknown"))]
     pub macos_dev_names_include: Option<Vec<String>>,
     #[cfg(all(any(target_os = "windows", target_os = "unknown"), feature = "gui"))]
-    pub tray_icon: Option<String>,
-    #[cfg(all(any(target_os = "windows", target_os = "unknown"), feature = "gui"))]
-    pub icon_match_layer_name: bool,
+    pub gui_opts: CfgOptionsGui,
 }
 
 impl Default for CfgOptions {
@@ -114,9 +159,7 @@ impl Default for CfgOptions {
             #[cfg(any(target_os = "macos", target_os = "unknown"))]
             macos_dev_names_include: None,
             #[cfg(all(any(target_os = "windows",target_os = "unknown"), feature = "gui"))]
-            tray_icon: None,
-            #[cfg(all(any(target_os = "windows",target_os = "unknown"), feature = "gui"))]
-            icon_match_layer_name: true,
+            gui_opts: Default::default(),
         }
     }
 }
@@ -417,7 +460,7 @@ pub fn parse_defcfg(expr: &[SExpr]) -> Result<CfgOptions> {
                             if icon_path.is_empty() {
                                 log::warn!("tray-icon is empty");
                             }
-                            cfg.tray_icon = Some(icon_path.to_string());
+                            cfg.gui_opts.tray_icon = Some(icon_path.to_string());
                         }
                     }
                     "icon-match-layer-name" => {
@@ -426,7 +469,86 @@ pub fn parse_defcfg(expr: &[SExpr]) -> Result<CfgOptions> {
                             feature = "gui"
                         ))]
                         {
-                            cfg.icon_match_layer_name = parse_defcfg_val_bool(val, label)?
+                            cfg.gui_opts.icon_match_layer_name = parse_defcfg_val_bool(val, label)?
+                        }
+                    }
+                    "tooltip-layer-changes" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            cfg.gui_opts.tooltip_layer_changes = parse_defcfg_val_bool(val, label)?
+                        }
+                    }
+                    "tooltip-show-blank" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            cfg.gui_opts.tooltip_show_blank = parse_defcfg_val_bool(val, label)?
+                        }
+                    }
+                    "tooltip-no-base" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            cfg.gui_opts.tooltip_no_base = parse_defcfg_val_bool(val, label)?
+                        }
+                    }
+                    "tooltip-duration" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            cfg.gui_opts.tooltip_duration = parse_cfg_val_u16(val, label, false)?
+                        }
+                    }
+                    "notify-cfg-reload" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            cfg.gui_opts.notify_cfg_reload = parse_defcfg_val_bool(val, label)?
+                        }
+                    }
+                    "notify-cfg-reload-silent" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            cfg.gui_opts.notify_cfg_reload_silent =
+                                parse_defcfg_val_bool(val, label)?
+                        }
+                    }
+                    "tooltip-size" => {
+                        #[cfg(all(
+                            any(target_os = "windows", target_os = "unknown"),
+                            feature = "gui"
+                        ))]
+                        {
+                            let v = sexpr_to_str_or_err(val, label)?;
+                            let tooltip_size = v.split(',').collect::<Vec<_>>();
+                            const ERRMSG: &str = "Invalid value for tooltip-size.\nExpected two numbers 0-65535 separated by a comma, e.g. 24,24";
+                            if tooltip_size.len() != 2 {
+                                bail_expr!(val, "{}", ERRMSG)
+                            }
+                            cfg.gui_opts.tooltip_size = (
+                                match str::parse::<u16>(tooltip_size[0]) {
+                                    Ok(w) => w,
+                                    Err(_) => bail_expr!(val, "{}", ERRMSG),
+                                },
+                                match str::parse::<u16>(tooltip_size[1]) {
+                                    Ok(h) => h,
+                                    Err(_) => bail_expr!(val, "{}", ERRMSG),
+                                },
+                            );
                         }
                     }
 

parser/src/cfg/tests.rs

@@ -1290,6 +1290,13 @@ fn parse_all_defcfg() {
   linux-x11-repeat-delay-rate 400,50
   tray-icon symbols.ico
   icon-match-layer-name no
+  tooltip-layer-changes yes
+  tooltip-show-blank yes
+  tooltip-no-base yes
+  tooltip-duration 300
+  tooltip-size 24,24
+  notify-cfg-reload yes
+  notify-cfg-reload-silent no
   windows-altgr add-lctl-release
   windows-interception-mouse-hwid "70, 0, 60, 0"
   windows-interception-mouse-hwids ("0, 0, 0" "1, 1, 1")
@@ -1890,3 +1897,15 @@ fn layer_name_allows_var() {
         .map_err(|e| eprintln!("{:?}", miette::Error::from(e)))
         .expect("parse succeeds");
 }
+
+#[test]
+fn disallow_whitespace_in_tooltip_size() {
+    let source = "
+(defcfg
+  tooltip-size 24 24	;; should be 24,24
+)
+(defsrc 1)
+(deflayer test 1)
+";
+    parse_cfg(source).map(|_| ()).expect_err("fails");
+}

src/gui/mod.rs

@@ -10,3 +10,4 @@ use parking_lot::Mutex;
 use std::sync::{Arc, OnceLock};
 pub static CFG: OnceLock<Arc<Mutex<Kanata>>> = OnceLock::new();
 pub static GUI_TX: OnceLock<native_windows_gui::NoticeSender> = OnceLock::new();
+pub static GUI_CFG_TX: OnceLock<native_windows_gui::NoticeSender> = OnceLock::new();