// SPDX-FileCopyrightText: 2018 - 2022 UnionTech Software Technology Co., Ltd.
//
// SPDX-License-Identifier: GPL-3.0-or-later

// key.go 处理键盘按键和修饰键
// 提供按键表示、字符串转换和X11抓取功能
package shortcuts

import (
	"fmt"
	"strings"

	x "github.com/linuxdeepin/go-x11-client"
	"github.com/linuxdeepin/go-x11-client/util/keybind"
	"github.com/linuxdeepin/go-x11-client/util/keysyms"
)

// Keycode 表示键盘按键的物理编码
// 对应X11协议中的Keycode类型
type Keycode x.Keycode

// Modifiers 表示键盘修饰键的状态
// 使用位掩码表示多个修饰键的组合状态
type Modifiers uint16

// String 返回修饰键的可读字符串表示
// 格式为"[状态值|修饰键列表]"，例如"[1|Shift-Alt]"
func (mods Modifiers) String() string {
	var keys []string
	if mods&keysyms.ModMaskShift > 0 {
		keys = append(keys, "Shift")
	}
	if mods&keysyms.ModMaskCapsLock > 0 {
		keys = append(keys, "CapsLock")
	}
	if mods&keysyms.ModMaskControl > 0 {
		keys = append(keys, "Control")
	}
	if mods&keysyms.ModMaskAlt > 0 {
		keys = append(keys, "Alt")
	}
	if mods&keysyms.ModMaskNumLock > 0 {
		keys = append(keys, "NumLock")
	}
	if mods&x.ModMask3 > 0 {
		keys = append(keys, "Mod3")
	}
	if mods&keysyms.ModMaskSuper > 0 {
		keys = append(keys, "Super")
	}
	if mods&keysyms.ModMaskModeSwitch > 0 {
		keys = append(keys, "ModeSwitch")
	}
	return fmt.Sprintf("[%d|%s]", uint16(mods), strings.Join(keys, "-"))
}

// Key 表示一个物理按键及其修饰键状态
// 用于表示一个完整的键盘按键事件
type Key struct {
	Mods Modifiers // 修饰键状态（Shift/Ctrl/Alt等）
	Code Keycode   // 物理按键编码（X11键码）
}

// String 返回Key的可读字符串表示
// 格式为"Key<Mods=[状态值|修饰键列表] Code=键码>"
func (k Key) String() string {
	return fmt.Sprintf("Key<Mods=%s Code=%d>", k.Mods, k.Code)
}

// ToKeystroke 将Key转换为Keystroke对象
// 参数:
//   keySymbols - 键盘符号映射表
// 返回值: 转换后的Keystroke对象，如果转换失败返回nil
func (k Key) ToKeystroke(keySymbols *keysyms.KeySymbols) *Keystroke {
	mods := k.Mods
	mods &^= keysyms.ModMaskShift // 移除Shift修饰键
	str, ok := keySymbols.LookupString(x.Keycode(k.Code), uint16(mods))
	if !ok {
		return nil // 查找键符号失败
	}
	// 如果LookupString成功，StringToKeysym必须成功
	sym, _ := keysyms.StringToKeysym(str)
	ks := Keystroke{
		Mods:   k.Mods,
		Keystr: str,
		Keysym: sym,
	}
	return ks.fix() // 返回修正后的Keystroke
}

// Ungrab 释放X11键盘抓取
// 参数:
//   conn - X11连接对象
func (k Key) Ungrab(conn *x.Conn) {
	rootWin := conn.GetDefaultScreen().Root // 获取根窗口
	keybind.Ungrab(conn, rootWin, uint16(k.Mods), x.Keycode(k.Code))
}

// Grab 尝试抓取X11键盘事件
// 参数:
//   conn - X11连接对象
// 返回值: 抓取成功返回nil，否则返回错误
func (k Key) Grab(conn *x.Conn) error {
	rootWin := conn.GetDefaultScreen().Root // 获取根窗口
	return keybind.GrabChecked(conn, rootWin, uint16(k.Mods), x.Keycode(k.Code))
}
