# 通知設計書 36-CompletionsChangedEventArgs

## 概要

本ドキュメントは、Windows Terminal におけるコマンド補完候補変更通知（CompletionsChangedEventArgs）の設計仕様を記述する。CompletionsChangedEventArgs は、シェルからコマンド補完候補（シェルコンプリーション）が提供された際に発火するイベントであり、JSON 形式のメニューデータと置換文字数の情報を含む。

### 本通知の処理概要

CompletionsChangedEventArgs は、シェル統合機能の一部として、ターミナル上のシェルがコマンド補完候補を提供した際に、その候補データをアプリケーション層に伝達する通知機構である。

**業務上の目的・背景**：モダンなシェル（PowerShell 等）はコマンド補完機能を提供するが、Windows Terminal はこの補完データをネイティブの補完メニューとして表示する機能（シェルコンプリーション）をサポートしている。CompletionsChangedEventArgs は、シェルから VT シーケンス経由で送られた補完候補データを、Windows Terminal のネイティブ UI メニューとして表示するための橋渡しを行う。

**通知の送信タイミング**：Terminal コアが VT シーケンスを解析し、シェルコンプリーションデータ（JSON 形式）を受信した際に CompletionsChangedCallback 経由で発火する。ControlCore の `_terminalCompletionsChanged` メソッドを経由して CompletionsChanged イベントが発火される。

**通知の受信者**：TermControl が ControlCore の CompletionsChanged イベントをバブルし、TerminalPage の `_ControlCompletionsChangedHandler` が受信する。ただし、Feature_ShellCompletions フラグが有効かつ設定で EnableShellCompletionMenu が有効な場合にのみ処理される。

**通知内容の概要**：JSON 形式の補完メニューデータ（MenuJson, hstring型）と、補完時に置換する文字数（ReplacementLength, UInt32型）の2つの情報を含む。

**期待されるアクション**：TerminalPage は JSON データをパースして補完メニューを構築し、ユーザーに表示する。ユーザーが補完候補を選択すると、ReplacementLength 分の文字を置換して補完を実行する。

## 通知種別

アプリ内通知（WinRT イベント + 補完メニュー UI）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（UIスレッドへのディスパッチ） |
| 優先度 | 中（ユーザー補助機能） |
| リトライ | なし |

### 送信先決定ロジック

Terminal コアが VT シーケンスからシェルコンプリーションデータを受信した際に、CompletionsChangedCallback で設定されたコールバックを経由して ControlCore に通知される。ControlCore は CompletionsChanged イベントを raise し、TermControl の BUBBLED_FORWARDED_TYPED_EVENT マクロによりバブルされ、TerminalPage に伝達される。

## 通知テンプレート

### メール通知の場合

該当なし（アプリ内イベント通知）

### 本文テンプレート

該当なし（JSON 形式の構造化データとしてイベント引数を伝達）

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| MenuJson | JSON 形式の補完メニューデータ（hstring） | Terminal コアの VT シーケンス解析結果 | Yes |
| ReplacementLength | 補完時に置換する文字数（UInt32） | Terminal コアの VT シーケンス解析結果 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| VT シーケンス受信 | シェルからの補完データ送信 | Terminal コアが補完データを解析した場合 | シェルコンプリーション VT シーケンスの受信 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Feature_ShellCompletions 無効 | コンパイル時フラグが無効の場合、イベントハンドラー自体が登録されない |
| EnableShellCompletionMenu 無効 | ユーザー設定で無効の場合、ハンドラー内で co_return |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[シェルが VT シーケンスで補完データを送信] --> B[Terminal コアが VT シーケンスを解析]
    B --> C[CompletionsChangedCallback 呼び出し]
    C --> D[ControlCore._terminalCompletionsChanged]
    D --> E[CompletionsChanged.raise<br/>MenuJson + ReplacementLength]
    E --> F[TermControl バブル処理<br/>BUBBLED_FORWARDED_TYPED_EVENT]
    F --> G[TerminalPage._ControlCompletionsChangedHandler]
    G --> H{Feature_ShellCompletions 有効?}
    H -->|No| I[イベント未登録]
    H -->|Yes| J{EnableShellCompletionMenu 有効?}
    J -->|No| K[co_return]
    J -->|Yes| L[JSON パースと補完メニュー表示]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（インメモリイベント処理のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| JSON パースエラー | MenuJson が不正な JSON 形式の場合 | 補完メニューを表示しない |
| 空のメニューデータ | MenuJson が空文字列の場合 | 補完メニューを表示しない |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（シェルの補完データ送信頻度に依存） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

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

- JSON メニューデータはシェルプロセスから受信するため、信頼できるシェルからのデータのみを想定
- VT シーケンス経由のため、悪意のあるターミナル出力による偽装の可能性がある（ただし、ローカルプロセスのみ）

## 備考

- CompletionsChangedEventArgs の MenuJson プロパティはデフォルト値として空文字列 `L""` が設定されている
- Feature_ShellCompletions はコンパイル時の Velocity フラグで制御される
- TermControl では BUBBLED_FORWARDED_TYPED_EVENT マクロを使用してイベントをバブルしている（行230）
- TerminalPage でのイベント登録は `if constexpr (Feature_ShellCompletions::IsEnabled())` で条件付き

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | EventArgs.idl | `src/cascadia/TerminalControl/EventArgs.idl` | CompletionsChangedEventArgs の IDL 定義（行125-129）。MenuJson と ReplacementLength |
| 1-2 | EventArgs.h | `src/cascadia/TerminalControl/EventArgs.h` | C++ 実装（行194-205）。コンストラクタで hstring と unsigned int を受け取る |

**読解のコツ**: MenuJson のデフォルト値が `L""` であることに注意。ReplacementLength は補完適用時にカーソル前の何文字を置換するかを示す。

#### Step 2: Terminal コアからのコールバック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Terminal.hpp | `src/cascadia/TerminalCore/Terminal.hpp` | CompletionsChangedCallback の宣言（行231） |
| 2-2 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | コールバック設定（行130-131）とハンドラー（行2684-2687） |

**主要処理フロー**:
1. **行130-131**: pfnCompletionsChanged ラムダ設定
2. **行2684-2687**: _terminalCompletionsChanged で CompletionsChangedEventArgs を生成しイベント発火

#### Step 3: TermControl でのバブル処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | TermControl.h | `src/cascadia/TerminalControl/TermControl.h` | BUBBLED_FORWARDED_TYPED_EVENT マクロ（行230）による CompletionsChanged バブル |
| 3-2 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | イベント登録（行328） |

#### Step 4: TerminalPage でのハンドリング

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | _ControlCompletionsChangedHandler（行5177-5188）。Feature フラグチェックと設定チェック |
| 4-2 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | イベント登録（行1983-1986）。Feature_ShellCompletions::IsEnabled() による条件付き登録 |

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

```
シェル (VT シーケンスで補完データ送信)
    |
    +-- Terminal コア (VT シーケンス解析)
           |
           +-- CompletionsChangedCallback (ラムダ)
                  |
                  +-- ControlCore::_terminalCompletionsChanged(menuJson, replaceLength)
                         |
                         +-- CompletionsChanged.raise(CompletionsChangedEventArgs)
                                |
                                +-- TermControl::BUBBLED_FORWARDED_TYPED_EVENT
                                       |
                                       +-- TerminalPage::_ControlCompletionsChangedHandler
                                              |
                                              +-- JSON パース -> 補完メニュー表示
```

### データフロー図

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

シェル VT シーケンス          Terminal コア -> ControlCore         TerminalPage / UI
(JSON menuData,       -->  CompletionsChangedCallback     -->  _ControlCompletionsChangedHandler
 replaceLength)            CompletionsChangedEventArgs生成      JSON パース
                           バブル処理                            補完メニュー表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| EventArgs.idl | `src/cascadia/TerminalControl/EventArgs.idl` | IDL定義 | CompletionsChangedEventArgs の WinRT インターフェース定義 |
| EventArgs.h | `src/cascadia/TerminalControl/EventArgs.h` | ソース | CompletionsChangedEventArgs の C++ 実装 |
| Terminal.hpp | `src/cascadia/TerminalCore/Terminal.hpp` | ソース | CompletionsChangedCallback の宣言 |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | コールバック設定とイベント発火 |
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL定義 | CompletionsChanged イベント宣言 |
| TermControl.idl | `src/cascadia/TerminalControl/TermControl.idl` | IDL定義 | CompletionsChanged イベント宣言（TermControl レベル） |
| TermControl.h | `src/cascadia/TerminalControl/TermControl.h` | ソース | BUBBLED_FORWARDED_TYPED_EVENT マクロ |
| TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | ソース | _ControlCompletionsChangedHandler 実装 |
