Initial commit

Author: jialeicui

.github/workflows/unit-test.yml

@@ -0,0 +1,30 @@
+name: build and test
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    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: go build -v ./...
+
+      - name: Test
+        run: sudo go test -v ./...

.gitignore

@@ -0,0 +1 @@
+.vscode

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jialei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cmd/keyswift/main.go

@@ -0,0 +1,81 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"log"
+	"strings"
+
+	"github.com/jialeicui/golibevdev"
+	"github.com/samber/lo"
+
+	"github.com/jialeicui/keyswift/pkg/conf"
+	"github.com/jialeicui/keyswift/pkg/evdev"
+	"github.com/jialeicui/keyswift/pkg/keys"
+	"github.com/jialeicui/keyswift/pkg/wininfo"
+	"github.com/jialeicui/keyswift/pkg/wininfo/dbus"
+)
+
+var (
+	flagKeyboard = flag.String("keyboard", "Apple", "")
+)
+
+func main() {
+	c, err := conf.LoadConfig(conf.DefaultConfigPath())
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	fmt.Printf("Loaded config: %+v\n", c)
+
+	r, err := dbus.New()
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer r.Close()
+
+	fmt.Println("Window Monitor service is running...")
+
+	r.OnActiveWindowChange(func(info *wininfo.WinInfo) {
+		fmt.Printf("Active window: %s - %s\n", info.Title, info.Class)
+	})
+
+	devs, err := evdev.NewOverviewImpl().ListInputDevices()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	dev, ok := lo.Find(devs, func(item *evdev.InputDevice) bool {
+		return strings.Contains(item.Name, *flagKeyboard)
+	})
+	if !ok {
+		log.Fatalf("Keyboard %s not found", *flagKeyboard)
+	}
+
+	out, err := golibevdev.NewVirtualKeyboard("keyswift")
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer out.Close()
+
+	in, err := golibevdev.NewInputDev(dev.Path)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer in.Close()
+
+	gnome := keys.NewGnomeKeys(out)
+
+	for {
+		ev, err := in.NextEvent(golibevdev.ReadFlagNormal)
+		if err != nil {
+			log.Fatal(err)
+		}
+		if ev.Type != golibevdev.EvKey {
+			continue
+		}
+		if ev.Code == golibevdev.KeyC {
+			gnome.Copy()
+		}
+	}
+}

examples/config.yaml

@@ -0,0 +1,83 @@
+# KeySwift Configuration File
+
+# Application Groups define categories of applications
+appGroups:
+  terminal:
+    name: Terminal Emulators
+    description: Command line terminal applications
+    appPatterns:
+      - "gnome-terminal-server"
+      - "konsole"
+      - "alacritty"
+      - "kitty"
+      - "com.mitchellh.ghostty"
+
+  jetbrains:
+    name: JetBrains IDEs
+    description: JetBrains integrated development environments
+    appPatterns:
+      - "jetbrains-idea"
+      - "jetbrains-clion"
+      - "jetbrains-pycharm"
+      - "jetbrains-webstorm"
+      - "jetbrains-goland"
+
+  browsers:
+    name: Web Browsers
+    description: Web browser applications
+    appPatterns:
+      - "*firefox*"
+      - "*chrome*"
+      - "*chromium*"
+      - "brave"
+
+# Keymap Groups define sets of keymappings that apply to specific app groups
+keymapGroups:
+  vim_navigation:
+    name: Vim-style Navigation
+    description: Vim-like navigation keys (hjkl)
+    enabled: true
+    appGroups:
+      - terminal
+      - jetbrains
+    keymaps:
+      - key: "Alt+h"
+        command: "Left"
+        description: "Move cursor left"
+        enabled: true
+
+      - key: "Alt+j"
+        command: "Down"
+        description: "Move cursor down"
+        enabled: true
+
+      - key: "Alt+k"
+        command: "Up"
+        description: "Move cursor up"
+        enabled: true
+
+      - key: "Alt+l"
+        command: "Right"
+        description: "Move cursor right"
+        enabled: true
+
+  media_controls:
+    name: Media Control Shortcuts
+    description: Global media playback controls
+    enabled: true
+    appGroups: [ ] # Empty means global (all applications)
+    keymaps:
+      - key: "Super+p"
+        command: "XF86AudioPlay"
+        description: "Play/Pause media"
+        enabled: true
+
+      - key: "Super+["
+        command: "XF86AudioPrev"
+        description: "Previous track"
+        enabled: true
+
+      - key: "Super+]"
+        command: "XF86AudioNext"
+        description: "Next track"
+        enabled: true

go.mod

@@ -0,0 +1,22 @@
+module github.com/jialeicui/keyswift
+
+go 1.23.0
+
+toolchain go1.23.4
+
+require (
+	github.com/godbus/dbus/v5 v5.1.0
+	github.com/stretchr/testify v1.10.0
+	gopkg.in/yaml.v3 v3.0.1
+)
+
+require (
+	github.com/samber/lo v1.49.1 // indirect
+	golang.org/x/text v0.23.0 // indirect
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/jialeicui/golibevdev v0.0.1
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+)

go.sum

@@ -0,0 +1,18 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
+github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
+github.com/jialeicui/golibevdev v0.0.1 h1:iwR1+KnJ97fCeWz5Ili4tVLJ21LtZVNFy0uMS7yetFU=
+github.com/jialeicui/golibevdev v0.0.1/go.mod h1:BIGi9TtzkWS9wHy3n+uGXeSfhiPWJUOVCvgg/Qh8tX8=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/samber/lo v1.49.1 h1:4BIFyVfuQSEpluc7Fua+j1NolZHiEHEpaSEKdsH0tew=
+github.com/samber/lo v1.49.1/go.mod h1:dO6KHFzUKXgP8LDhU0oI8d2hekjXnGOu0DB8Jecxd6o=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY=
+golang.org/x/text v0.23.0/go.mod h1:/BLNzu4aZCJ1+kcD0DNRotWKage4q2rGVAg4o22unh4=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/emacs/emacs.go

@@ -0,0 +1,8 @@
+package emacs
+
+// ctrl+b -> backward
+// ctrl+f -> forward
+// ctrl+n -> next
+// ctrl+p -> previous
+// ctrl+a -> beginning
+// ctrl+e -> end

pkg/conf/appgroup.go

@@ -0,0 +1,21 @@
+package conf
+
+import "path/filepath"
+
+// AppGroup represents a group of applications with similar characteristics
+type AppGroup struct {
+	Name        string   `yaml:"name"`
+	Description string   `yaml:"description"`
+	AppPatterns []string `yaml:"appPatterns"` // Window class patterns to match applications
+}
+
+// MatchesApp checks if the given window class/application matches this app group
+func (a *AppGroup) MatchesApp(windowClass string) bool {
+	for _, pattern := range a.AppPatterns {
+		matched, _ := filepath.Match(pattern, windowClass)
+		if matched {
+			return true
+		}
+	}
+	return false
+}

pkg/conf/config.go

@@ -0,0 +1,22 @@
+package conf
+
+import "fmt"
+
+// Config represents the root configuration for KeySwift
+type Config struct {
+	AppGroups    map[string]AppGroup    `yaml:"appGroups"`
+	KeymapGroups map[string]KeymapGroup `yaml:"keymapGroups"`
+}
+
+// Validate ensures the configuration is valid
+func (c *Config) Validate() error {
+	// Validate app groups references in keymap groups
+	for name, kmGroup := range c.KeymapGroups {
+		for _, appGroupName := range kmGroup.AppGroups {
+			if _, exists := c.AppGroups[appGroupName]; !exists {
+				return fmt.Errorf("keymap group '%s' references non-existent app group '%s'", name, appGroupName)
+			}
+		}
+	}
+	return nil
+}