# 機能設計書 19-キーバインド

## 概要

本ドキュメントは、Ghosttyのキーバインド設定機能の設計について記述する。カスタマイズ可能なキーバインドにより、キー入力をアクションにマッピングする機能である。

### 本機能の処理概要

**業務上の目的・背景**：
ターミナルアプリケーションでは、効率的な操作のためにキーボードショートカットが重要である。本機能は、ユーザーがキーの組み合わせ（トリガー）を様々なアクション（コピー、ペースト、タブ操作など）にマッピングできるようにする。

**機能の利用シーン**：
- コピー＆ペースト操作
- タブ・ウィンドウ・スプリット操作
- フォントサイズ変更
- 検索操作
- テキスト送信
- グローバルホットキー

**主要な処理内容**：
1. キーバインド文字列のパース
2. トリガー（キー＋修飾キー）の解析
3. アクション（実行する操作）の解析
4. フラグ（consumed, global, all等）の処理
5. バインディングセットへの登録
6. キー入力時のマッチング

**関連システム・外部連携**：
- 設定システム（keybind設定）
- 入力システム（キーイベント）
- プラットフォームAPI（グローバルキー）

**権限による制御**：
グローバルキーはシステム権限が必要な場合あり。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインターミナルウィンドウ | 主画面 | キーバインドによる操作 |

## 機能種別

入力処理 / キーマッピング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| input | []const u8 | Yes | キーバインド設定文字列 | trigger=action形式 |

### 入力データソース

- 設定ファイル（keybind設定）

### 構文例

```
ctrl+c=copy_to_clipboard           # 基本形式
ctrl+shift+c=copy_to_clipboard     # 複数修飾キー
super+t=new_tab                    # Superキー（Cmd/Win）
global:super+`=toggle_quick_terminal  # グローバルキー
unconsumed:ctrl+c=copy_to_clipboard   # 非消費
all:ctrl+q=quit                    # 全サーフェス
ctrl+a>ctrl+b=new_tab              # シーケンス（後述）
escape=unbind                      # バインド解除
```

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| trigger | Trigger | キー＋修飾キーの組み合わせ |
| action | Action | 実行するアクション |
| flags | Flags | バインディングフラグ |

### 出力先

キーバインドセット（Set構造体）

## 処理フロー

### 処理シーケンス

```
1. 文字列パース
   └─ Parser.init()でパーサー初期化
2. フラグ抽出
   └─ parseFlags()で"global:", "all:"等を処理
3. トリガー・アクション分離
   └─ "="で分割
4. トリガーパース
   └─ Trigger.parse()で修飾キーとキーを解析
5. アクションパース
   └─ Action.parse()でアクションと引数を解析
6. バインディング生成
   └─ Binding構造体を生成
```

### フローチャート

```mermaid
flowchart TD
    A[設定文字列] --> B{フラグあり?}
    B -->|Yes| C[フラグ抽出]
    B -->|No| D[トリガー=アクション分離]
    C --> D
    D --> E[トリガーパース]
    E --> F{修飾キー?}
    F -->|ctrl/alt/shift/super| G[mods設定]
    F -->|キー名| H[key設定]
    G --> F
    H --> I[アクションパース]
    I --> J{パラメータあり?}
    J -->|Yes| K[パラメータ解析]
    J -->|No| L[Binding生成]
    K --> L
    L --> M[Setに登録]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 修飾キー順序 | 順序は任意（ctrl+alt = alt+ctrl） | 常時 |
| BR-02 | 消費デフォルト | consumed=trueがデフォルト | 常時 |
| BR-03 | unbind | 既存バインドの無効化 | unbindアクション時 |
| BR-04 | ignore | キー無視（子プロセスにも送信しない） | ignoreアクション時 |
| BR-05 | グローバル | システム全体で有効 | global:プレフィックス時 |

### 修飾キー

| 修飾キー | エイリアス | 説明 |
|---------|-----------|------|
| ctrl | control | Controlキー |
| alt | option, opt | Alt/Optionキー |
| shift | - | Shiftキー |
| super | cmd, command, win | Command/Windowsキー |

## データベース操作仕様

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| InvalidFormat | パースエラー | 構文エラー | 設定スキップ |
| InvalidAction | アクションエラー | 不明なアクション | 設定スキップ |

### リトライ仕様

リトライなし。エラー時は該当バインドをスキップ。

## トランザクション仕様

該当なし

## パフォーマンス要件

- キー入力時のマッチングはO(1)に近い（ハッシュマップ使用）
- パースは設定ロード時のみ

## セキュリティ考慮事項

- グローバルキーはシステムレベルの権限が必要
- text:アクションで任意のテキストを送信可能（ユーザー責任）

## 備考

- W3Cキーコードに準拠
- 後方互換性のため旧キー名もサポート（1.1.x互換）

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Binding.zig | `src/input/Binding.zig` | Binding構造体（1-28行目） |
| 1-2 | Binding.zig | `src/input/Binding.zig` | Flags packed struct（31-70行目） |
| 1-3 | Binding.zig | `src/input/Binding.zig` | Trigger構造体（1608-1992行目） |
| 1-4 | Binding.zig | `src/input/Binding.zig` | Action union（302-926行目） |

**読解のコツ**: BindingはTrigger（何を押すか）とAction（何をするか）とFlags（オプション）の組み合わせ。Triggerはキーと修飾キー、ActionはコピーやタブなどのVariant。

#### Step 2: パーサー実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Binding.zig | `src/input/Binding.zig` | Parser構造体（74-214行目） |
| 2-2 | Binding.zig | `src/input/Binding.zig` | parseFlags関数（148-187行目） |
| 2-3 | Binding.zig | `src/input/Binding.zig` | SequenceIterator（220-240行目） |
| 2-4 | Binding.zig | `src/input/Binding.zig` | Trigger.parse（1658-1755行目） |
| 2-5 | Binding.zig | `src/input/Binding.zig` | Action.parse（1207-1271行目） |

**主要処理フロー**:
1. **94-146行目**: Parser.init()で文字列解析を開始
2. **148-187行目**: フラグ（global:, all:, unconsumed:）をパース
3. **101-126行目**: =記号の検出（トリガーとアクションの分離）
4. **1662-1752行目**: +区切りで修飾キーとキーをパース
5. **1207-1271行目**: :区切りでアクションとパラメータをパース

#### Step 3: アクション詳細を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Binding.zig | `src/input/Binding.zig` | Action各バリアント（303-926行目） |
| 3-2 | Binding.zig | `src/input/Binding.zig` | Action.scope関数（1281-1384行目） |

**主要アクション**:
- **309-316行目**: ignore/unbind（基本）
- **317-333行目**: csi/esc/text（入力送信）
- **349-378行目**: コピー＆ペースト
- **528-594行目**: タブ・スプリット操作
- **700-709行目**: フルスクリーン・ウィンドウ操作

### プログラム呼び出し階層図

```
設定ロード
    │
    └─ keybind設定の読み込み
           │
           └─ Parser.init(raw_input)
                  │
                  ├─ parseFlags() ─▶ Flags{consumed, all, global, performable}
                  │
                  ├─ SequenceIterator構築
                  │
                  └─ Action.parse()

Parser.next()
    │
    ├─ SequenceIterator.next() ─▶ Trigger
    │      │
    │      └─ Trigger.parse()
    │             ├─ 修飾キー検出（ctrl, alt, shift, super）
    │             └─ キー検出（物理キー or Unicode）
    │
    └─ [最後のトリガー]
           └─ Binding{trigger, action, flags}を返す

キー入力時
    │
    └─ Set.get(trigger)
           └─ ハッシュマップ検索 ─▶ Action
```

### データフロー図

```
[入力]                    [処理]                      [出力]

"global:ctrl+c=copy"
        │
        ├─▶ parseFlags() ───▶ Flags{global=true}
        │
        ├─▶ Trigger.parse() ─▶ Trigger{
        │                        key: .physical(.c),
        │                        mods: {ctrl=true}
        │                      }
        │
        └─▶ Action.parse() ──▶ Action.copy_to_clipboard

Binding ────────────────────▶ Set.put() ────▶ HashMap
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Binding.zig | `src/input/Binding.zig` | ソース | バインディング定義とパーサー |
| key.zig | `src/input/key.zig` | ソース | キー定義 |
| key_mods.zig | `src/input/key_mods.zig` | ソース | 修飾キー定義とエイリアス |
| Config.zig | `src/config/Config.zig` | ソース | keybind設定定義 |
