# 機能設計書 95-ターミナル入力処理

## 概要

本ドキュメントは、Windows Terminal / Console Host におけるターミナル入力処理（TerminalInput）の機能設計を記述する。キーボード・マウス入力をVTエスケープシーケンスに変換する処理の構造と動作を解説する。

### 本機能の処理概要

TerminalInput クラスは、Windowsのキーボード入力イベント（INPUT_RECORD）やマウス入力イベントを、VTエスケープシーケンス文字列に変換する。生成されたシーケンスはシェルプロセスに送信され、シェル側でキー入力として解釈される。

**業務上の目的・背景**：Windowsのネイティブ入力イベントモデル（INPUT_RECORD / KEY_EVENT_RECORD）と、Unixベースのターミナルが使用するVTエスケープシーケンスの間にはギャップがある。TerminalInputはこのギャップを埋め、VTモードで動作するアプリケーション（vim, tmux等）がWindowsキーボード入力を正しく受け取れるようにする。

**機能の利用シーン**：ユーザーがキーボードで文字を入力、特殊キー（矢印、ファンクションキー等）を押下、またはマウスで操作するたびに呼び出される。Win32入力モード（CSI ? 9001 h）では、INPUT_RECORD全体をそのままエンコードして送信する特殊モードもサポートする。

**主要な処理内容**：
1. キーボード入力のVTシーケンス変換（HandleKey）
2. マウス入力のVTシーケンス変換（HandleMouse）- Default/UTF-8/SGR の3エンコーディング
3. フォーカスイベントのVTシーケンス生成（HandleFocus）
4. 入力モード管理（カーソルキーモード、キーパッドモード、マウストラッキング等）
5. Win32入力モード対応（KEY_EVENT_RECORDの全フィールドをVTシーケンスにエンコード）
6. サロゲートペア対応
7. AltGr（右Alt）キー処理

**関連システム・外部連携**：InputBuffer クラスから呼び出される。ConPTY接続を通じてシェルプロセスにVTシーケンスを送信する。

**権限による制御**：ForceDisableWin32InputMode によりWin32入力モードの強制無効化が可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 6 | TermControl（ターミナル表示） | 主画面 | キーボード・マウス入力のVTシーケンス変換 |

## 機能種別

データ変換処理 / 入力ハンドリング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| pInEvent | INPUT_RECORD | Yes | Windowsの入力レコード | KEY_EVENT型であること |
| position | til::point | Yes | マウス位置（文字座標） | - |
| button | unsigned int | Yes | マウスボタン（WM_LBUTTONDOWN等） | 有効なWMメッセージ |
| modifierKeyState | short | Yes | 修飾キー状態 | - |
| delta | short | Yes | ホイールデルタ | - |
| state | MouseButtonState | Yes | マウスボタン押下状態 | - |
| focused | bool | Yes | フォーカス状態 | - |

### 入力データソース

- Windows メッセージループからの INPUT_RECORD
- TermControl からのマウスイベント通知

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| VTシーケンス | OutputType (optional\<wstring\>) | 変換されたVTエスケープシーケンス |

### 出力先

ConPTY接続経由でシェルプロセスに送信

## 処理フロー

### 処理シーケンス

```
1. HandleKey(INPUT_RECORD) - キー入力処理
   └─ Win32入力モードの場合: _makeWin32Output()でIR全体をエンコード
   └─ 通常モード: _keyMapによるVTシーケンスルックアップ
   └─ マッチなし: ToUnicodeExで文字変換、_makeCharOutput()
2. HandleMouse(position, button, ...) - マウス入力処理
   └─ トラッキングモード判定
   └─ エンコーディング選択: Default/UTF-8/SGR
   └─ 対応シーケンス生成
3. HandleFocus(focused) - フォーカスイベント処理
   └─ FocusEventモード有効時のみシーケンス生成
```

### フローチャート

```mermaid
flowchart TD
    A[HandleKey] --> B{Win32入力モード?}
    B -->|Yes| C[_makeWin32Output]
    B -->|No| D{_keyMapにマッチ?}
    D -->|Yes| E[マップされたVTシーケンス返却]
    D -->|No| F{文字変換可能?}
    F -->|Yes| G[_makeCharOutput]
    F -->|No| H[MakeUnhandled返却]
    C --> I[OutputType返却]
    E --> I
    G --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-95-01 | マウストラッキング排他 | Default/ButtonEvent/AnyEventの3モードは排他的 | モード変更時 |
| BR-95-02 | マウスエンコーディング排他 | UTF-8/SGRエンコーディングは新モード有効化時に排他切替 | エンコーディング変更時 |
| BR-95-03 | AltGr処理 | 右AltとCtrlの同時押下はAltGrとして扱い、Alt修飾を適用しない | 入力処理時 |
| BR-95-04 | サロゲートペア | 上位サロゲートは_leadingSurrogateに保存し、下位サロゲート到着時にペア結合 | Unicode入力時 |
| BR-95-05 | 代替スクロール | AlternateScrollモード有効かつ代替バッファ時、ホイールをカーソルキーに変換 | マウスホイール時 |

### 計算ロジック

- マウス座標のエンコード（Defaultモード）: `position + 1 + 32` でASCII文字に変換（最大座標94）
- SGRエンコード: `ESC[<button;x;y{M|m}` 形式（座標は1-origin）

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| MakeUnhandled | 未処理 | キーマップにマッチせず文字変換も不可 | 上位層にハンドリングを委譲 |

### リトライ仕様

リトライは行わない。

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

該当なし。

## パフォーマンス要件

- _keyMapはunordered_mapで高速ルックアップ
- _initKeyboardMap()はモード変更時のみ再構築

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

- ForceDisableWin32InputMode によりWin32入力モードの強制無効化が可能（信頼されないアプリケーションからの悪用防止）

## 備考

- TerminalInput は状態を持つクラスであり、マウスの前回位置やサロゲートペアの上位バイトを記憶する
- mouseInput.cpp と mouseInputState.cpp にマウス関連処理が分離されている

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | terminalInput.hpp | `src/terminal/input/terminalInput.hpp` | TerminalInputクラス定義。Mode列挙体（15モード）、MouseButtonState構造体 |

**読解のコツ**: Mode列挙体には入力モード（LineFeed/Ansi/Keypad等）、マウスエンコーディング（Utf8/Sgr）、マウストラッキング（Default/ButtonEvent/AnyEvent）が混在している。

**主要処理フロー**:
1. **8-9行目**: TerminalInput は final クラス
2. **27-48行目**: Mode列挙体の全15モード
3. **69-78行目**: プライベートメンバー（_leadingSurrogate, _lastVirtualKeyCode, _keyMap等）
4. **98-104行目**: MouseInputState内部構造体

#### Step 2: キーボード入力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | terminalInput.cpp | `src/terminal/input/terminalInput.cpp` | キーボード入力のVTシーケンス変換 |

**主要処理フロー**:
- **29-32行目**: コンストラクタ。_initKeyboardMap()の呼び出し
- **34-61行目**: SetInputMode() - モード変更と_keyMapの再構築条件
- **68-74行目**: ResetInputModes() - デフォルトモードへのリセット

#### Step 3: マウス入力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | mouseInput.cpp | `src/terminal/input/mouseInput.cpp` | マウス入力のVTシーケンス変換 |
| 3-2 | mouseInputState.cpp | `src/terminal/input/mouseInputState.cpp` | マウス状態管理（代替バッファ切替） |

**主要処理フロー**:
- **12行目**: s_MaxDefaultCoordinate = 94（Defaultエンコーディングの最大座標）
- **22-41行目**: _isButtonMsg() - ボタンイベント判定
- **49-52行目**: _isHoverMsg() - ホバーイベント判定
- **60-63行目**: _isWheelMsg() - ホイールイベント判定

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

```
InputBuffer::Write() / TermControl::_KeyHandler()
    │
    └─ TerminalInput::HandleKey(INPUT_RECORD)
           │
           ├─ _makeWin32Output()          → Win32入力モード
           │
           ├─ _keyMap.find()              → VTシーケンスルックアップ
           │
           ├─ _makeCharOutput()           → 文字出力生成
           │      └─ _escapeOutput()      → Alt修飾時のESCプレフィックス
           │
           └─ MakeUnhandled()             → 未処理

InputBuffer::WriteMouseEvent()
    │
    └─ TerminalInput::HandleMouse(position, button, ...)
           │
           ├─ _GenerateDefaultSequence()  → Default エンコーディング
           ├─ _GenerateUtf8Sequence()     → UTF-8 エンコーディング
           └─ _GenerateSGRSequence()      → SGR エンコーディング
```

### データフロー図

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

INPUT_RECORD        ───▶ TerminalInput             ───▶ VTシーケンス文字列
(キーイベント)             (HandleKey)                     (ESC[A 等)
                           │
マウスイベント       ───▶ HandleMouse               ───▶ VTシーケンス文字列
(WM_LBUTTONDOWN等)         (エンコーディング選択)          (ESC[<0;1;1M 等)
                           │
フォーカスイベント   ───▶ HandleFocus               ───▶ VTシーケンス文字列
(true/false)               (FocusEventモード判定)          (ESC[I / ESC[O)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| terminalInput.hpp | `src/terminal/input/terminalInput.hpp` | ソース | TerminalInputクラス定義 |
| terminalInput.cpp | `src/terminal/input/terminalInput.cpp` | ソース | キーボード入力処理実装 |
| mouseInput.cpp | `src/terminal/input/mouseInput.cpp` | ソース | マウス入力処理実装 |
| mouseInputState.cpp | `src/terminal/input/mouseInputState.cpp` | ソース | マウス状態管理実装 |
