impl the js api

Author: jialeicui

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up libevdev
+        run: sudo apt-get install libevdev-dev
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.23'
+          cache-dependency-path: go.sum
+
+      - name: Build
+        run: |
+          make
+          cp keyswift keyswift-linux-amd64
+
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        with:
+          with:
+            files: keyswift-linux-amd64

.gitignore

@@ -1 +1,2 @@
 .vscode
+keyswift

Makefile

@@ -0,0 +1,2 @@
+build:
+	@go build -o keyswift cmd/keyswift/main.go

README.md

@@ -11,49 +11,50 @@ KeySwift is a keyboard remapping tool designed for Linux gnome desktop environme
 
 Download the latest release from the [Releases](https://github.com/jialeicui/keyswift/releases) page.
 
-Or install from source:
+Or build from source:
+
+**Dependencies**:
+- libevdev-dev
+- golang
+
 
 ```bash
 git clone https://github.com/jialeicui/keyswift.git
 cd keyswift
-make install
+make
 ```
 
 ## Configuration
 
-Create a configuration file at `~/.config/keyswift/config.yml`. Here's an example:
-
-```yaml
-# yaml-language-server: $schema=schema.json
-# KeySwift Configuration File
-
-mode_actions:
-  default:
-    if: "true"
-    triggers:
-      - source_event:
-          key_press_event:
-            key: "esc"
-        action:
-          set_value:
-            normal: true
-      - source_event:
-          window_focus_event:
-            window_class:
-              - kitty
-        action:
-          set_value:
-            terminal: true
-  normal:
-    if: normal
-    triggers:
-      - source_event:
-          key_press_event:
-            key: "j"
-        action:
-          map_to_keys:
-            keys:
-              - key: "down"
+Create a configuration file at `~/.config/keyswift/config.js`. Here's an example:
+
+```js
+const curWindowClass = KeySwift.getActiveWindowClass();
+const Terminals = ["kitty", "Gnome-terminal", "org.gnome.Terminal"];
+const inTerminal = Terminals.includes(curWindowClass);
+
+KeySwift.onKeyPress(["cmd", "v"], () => {
+    if (curWindowClass === "com.mitchellh.ghostty") {
+        KeySwift.sendKeys(["shift", "ctrl", "v"]);
+        return
+    }
+
+    if (inTerminal) {
+        KeySwift.sendKeys(["cmd", "shift", "v"]);
+    }
+});
+```
+
+You can also see more examples in the [examples](examples) directory.
+
+KeySwift's config is implemented based on [QuickJS](https://bellard.org/quickjs), and all available objects and functions are as follows:
+
+```js
+const KeySwift = {
+    getActiveWindowClass: () => string,
+    sendKeys: (keys: string[]) => void,
+    onKeyPress: (keys: string[], callback: () => void) => void,
+}
 ```
 
 ## Acknowledgments
@@ -66,6 +67,56 @@ KeySwift was inspired by several excellent projects:
 
 Thank you to the maintainers of these projects for your contributions to open-source keyboard customization tools!
 
+This project also draws inspiration from [AutoHotkey](https://www.autohotkey.com)'s design philosophy. Thanks to this amazing project
+
+## Tips
+
+### How to get the active window class
+
+You can use the `cmd+i` shortcut to print the active window class to the console with the following configuration:
+
+```js
+KeySwift.onKeyPress(["cmd", "i"], () => {
+    const curWindowClass = KeySwift.getActiveWindowClass();
+    console.log(curWindowClass);
+});
+```
+### How to run the program
+
+1. Install the keyswift gnome extension
+
+```bash
+# Clone the repository
+git clone https://github.com/jialeicui/keyswift-gnome-ext.git ~/.local/share/gnome-shell/extensions/keyswift@jialeicui.github.io
+# Enable the extension via gnome-extensions-app or gnome-extensions cli
+gnome-extensions enable keyswift@jialeicui.github.io
+# You may need to restart the gnome-shell
+```
+
+2. Get the input device permission for current user
+
+```bash
+sudo gpasswd -a $USER input
+echo 'KERNEL=="uinput", GROUP="input", TAG+="uaccess"' | sudo tee /etc/udev/rules.d/input.rules
+# You may need to restart the system to take effect
+```
+
+3. Run the program
+
+```bash
+# XXX is the substring of the keyboard device name
+./keyswift -keyboards XXX -config ~/.config/keyswift/config.js
+```
+- if you have multiple keyboards, you can use comma to separate them
+- if you don't know the device name, you can leave it blank and the program will print all the keyboard device names and you can select one of them
+
+**NOTE**: KeySwift does not support running with sudo, so you need to run the program with current user.
+
+## TODO
+
+- [ ] Support KDE
+- [ ] Support Mouse
+
 ## Getting Help
 
 If you encounter any issues or have questions, please [open an issue](https://github.com/jialeicui/keyswift/issues) on the GitHub repository.

cmd/keyswift/main.go

@@ -12,19 +12,18 @@ import (
 	"github.com/jialeicui/golibevdev"
 	"github.com/samber/lo"
 
-	"github.com/jialeicui/keyswift/pkg/conf"
-	"github.com/jialeicui/keyswift/pkg/dev"
+	"github.com/jialeicui/keyswift/pkg/bus"
 	"github.com/jialeicui/keyswift/pkg/evdev"
-	"github.com/jialeicui/keyswift/pkg/keys"
-	"github.com/jialeicui/keyswift/pkg/mode"
+	"github.com/jialeicui/keyswift/pkg/handler"
+	"github.com/jialeicui/keyswift/pkg/utils"
 	"github.com/jialeicui/keyswift/pkg/wininfo/dbus"
 )
 
 var (
-	flagKeyboards = flag.String("keyboards", "Apple", "Comma-separated list of keyboard device name substrings")
-	flagConfig    = flag.String("config", "", "Configuration file path (defaults to $XDG_CONFIG_HOME/keyswift/config.js)")
-	// TODO change this to false
-	flagVerbose = flag.Bool("verbose", true, "Enable verbose logging")
+	flagKeyboards        = flag.String("keyboards", "HHKB", "Comma-separated list of keyboard device name substrings")
+	flagConfig           = flag.String("config", "", "Configuration file path (defaults to $XDG_CONFIG_HOME/keyswift/config.js)")
+	flagVerbose          = flag.Bool("verbose", false, "Enable verbose logging")
+	flagOutputDeviceName = flag.String("output-device-name", "keyswift", "Name of the virtual keyboard device")
 )
 
 func main() {
@@ -40,7 +39,7 @@ func main() {
 	// Load configuration
 	configPath := *flagConfig
 	if configPath == "" {
-		configPath = conf.DefaultConfigPath()
+		configPath = utils.DefaultConfigPath()
 	}
 
 	// Initialize window info service
@@ -53,27 +52,26 @@ func main() {
 	slog.Info("Window Monitor service is running...")
 
 	// Initialize virtual keyboard for output
-	out, err := golibevdev.NewVirtualKeyboard("keyswift")
+	out, err := golibevdev.NewVirtualKeyboard(*flagOutputDeviceName)
 	if err != nil {
 		slog.Error("Failed to create virtual keyboard", "error", err)
 		os.Exit(1)
 	}
 	defer out.Close()
-	gnomeKeys := keys.NewGnomeKeys(out)
 
 	script, err := os.ReadFile(configPath)
 	if err != nil {
 		slog.Error("Failed to read configuration file", "error", err)
 		os.Exit(1)
 	}
 
-	// Initialize mode manager
-	modeManager, err := mode.NewManager(string(script), gnomeKeys, windowMonitor)
+	// Initialize bus manager
+	busMgr, err := bus.New(string(script), windowMonitor, out)
 	if err != nil {
-		slog.Error("Failed to initialize mode manager", "error", err)
+		slog.Error("Failed to initialize bus manager", "error", err)
 		os.Exit(1)
 	}
-	slog.Info("Mode manager initialized")
+	slog.Info("bus manager initialized")
 
 	// Find input devices
 	devs, err := evdev.NewOverviewImpl().ListInputDevices()
@@ -93,7 +91,7 @@ func main() {
 		}
 
 		matches := lo.Filter(devs, func(item *evdev.InputDevice, _ int) bool {
-			return strings.Contains(item.Name, pattern)
+			return strings.Contains(item.Name, pattern) && item.Name != *flagOutputDeviceName
 		})
 
 		matchedDevices = append(matchedDevices, matches...)
@@ -114,7 +112,7 @@ func main() {
 	}
 
 	// Initialize and set up the device manager
-	deviceManager := dev.NewInputDeviceManager()
+	deviceManager := handler.New()
 	defer deviceManager.Close()
 
 	// Add all matched devices to the manager
@@ -140,8 +138,8 @@ func main() {
 	}()
 
 	// Start processing events from all devices
-	slog.Info(fmt.Sprintf("Processing events from %d devices... Press Ctrl+C to exit\n", len(deviceManager.GetDevices())))
-	deviceManager.ProcessEvents(out, modeManager)
+	slog.Info(fmt.Sprintf("Processing events from %d devices... Press Ctrl+C to exit", len(deviceManager.GetDevices())))
+	deviceManager.ProcessEvents(out, busMgr)
 
 	// Wait for all processing to complete (typically won't reach here except on error)
 	deviceManager.Wait()