# 通知設計書 58-ShowWindowChanged

## 概要

本ドキュメントは、Windows Terminal における ShowWindowChanged イベント通知の設計仕様を記述する。ターミナルプロセス（PTY）からウィンドウの表示/非表示状態の変更が要求された際に発火し、ホストウィンドウの表示状態を制御するためのアクション通知である。

### 本通知の処理概要

ShowWindowChanged は、ターミナルプロセスが VT エスケープシーケンスを通じてウィンドウの表示/非表示を要求した際に、Terminal コア層から ControlCore、TermControl、TerminalPage、AppHost を経て最終的に IslandWindow の ShowWindow API 呼び出しに至るイベントチェーンである。PTY の状態変更要求をホストウィンドウに伝搬させる役割を持つ。

**業務上の目的・背景**：VT エスケープシーケンスの一部として、ターミナルプロセスがホストウィンドウの最小化/復元を要求する機能がある。これは xterm 互換の XTWINOPS（CSI t）シーケンスの一部であり、ターミナルアプリケーション内からウィンドウ状態を制御するユースケースを実現する。ShowWindowChanged イベントはこの要求を Terminal コアからUIホスト層まで安全に伝搬するための仕組みである。

**通知の送信タイミング**：Terminal::ShowWindow メソッドが呼び出された際に _pfnShowWindowChanged コールバックが実行され、ControlCore の _terminalShowWindowChanged を経由して ShowWindowChanged イベントが発火する。最終的に AppHost でスロットリングされた後に IslandWindow の ShowWindowChanged が呼び出される。

**通知の受信者**：TermControl、TerminalPage、TerminalWindow、AppHost と多段に伝搬する。AppHost がスロットリングを行い、最終的に IslandWindow で実際のウィンドウ表示/非表示処理を実行する。

**通知内容の概要**：ShowWindowArgs オブジェクトが渡され、ShowOrHide プロパティ（Boolean）でウィンドウの表示（true）または非表示（false）を指定する。

**期待されるアクション**：AppHost は _showHideWindowThrottler を使ってスロットリングし、IslandWindow::ShowWindowChanged を呼び出す。IslandWindow は ShowWindow Win32 API を使用してウィンドウの表示/非表示を切り替える。

## 通知種別

アプリ内イベント通知（WinRT TypedEventHandler）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（バックグラウンドスレッドから発火、スロットリングあり） |
| 優先度 | 中 |
| リトライ | 無（スロットリングによる遅延あり） |

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

Terminal コア -> ControlCore -> TermControl -> TerminalPage -> TerminalWindow -> AppHost -> IslandWindow の順にイベントチェーンで伝搬する。AppHost で200msのスロットリングが適用される。

## 通知テンプレート

### イベント引数

| 項目 | 内容 |
|-----|------|
| イベント型 | `TypedEventHandler<Object, ShowWindowArgs>` |
| 定義元 | `ControlCore.idl` L198, `EventArgs.idl` L115-118 |
| プロパティ | ShowOrHide (Boolean) |

### イベントデータ構造

```cpp
// EventArgs.idl
runtimeclass ShowWindowArgs
{
    Boolean ShowOrHide { get; };
}

// EventArgs.h
struct ShowWindowArgs : public ShowWindowArgsT<ShowWindowArgs>
{
    ShowWindowArgs(const bool showOrHide) : _ShowOrHide(showOrHide) {}
    WINRT_PROPERTY(bool, ShowOrHide);
};
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ShowOrHide | ウィンドウ表示（true）/ 非表示（false） | Terminal::ShowWindow の引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| VTエスケープシーケンス | Terminal::ShowWindow | _pfnShowWindowChanged コールバックが設定済み | TerminalApi.cpp L337-342: PTYからのウィンドウ表示/非表示要求 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| コールバック未設定 | _pfnShowWindowChanged が null の場合はイベント不発火 |
| スロットリング | AppHost で200msの trailing throttle が適用され、頻繁な状態変更が集約される（GH#13147対応） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[VTエスケープシーケンス: CSI t] --> B[Terminal::ShowWindow]
    B --> C{_pfnShowWindowChanged?}
    C -->|設定済| D[_pfnShowWindowChanged コールバック]
    C -->|未設定| E[処理なし]
    D --> F[ControlCore::_terminalShowWindowChanged]
    F --> G[ShowWindowArgs 生成]
    G --> H[ShowWindowChanged.raise]
    H --> I[TermControl バブリング]
    I --> J[TerminalPage::_ShowWindowChangedHandler]
    J --> K[ShowWindowChanged.raise 再発火]
    K --> L[AppHost::_ShowWindowChanged]
    L --> M[_showHideWindowThrottler.Run]
    M --> N[IslandWindow::ShowWindowChanged]
    N --> O[ShowWindow Win32 API]
```

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

### 参照テーブル一覧

該当なし（データベースは使用しない）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ウィンドウハンドル無効 | ウィンドウが既に破棄されている | IslandWindow 内の hwnd null チェック |
| 状態デシンク | PTY と ウィンドウの状態が不一致になる | スロットリングによるレート制限で軽減（GH#13147） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし。スロットリングで対応） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| スロットリング間隔 | 200ms（trailing モード） |
| 動作 | 200ms以内の複数の要求は最後の要求のみ実行される |

### 配信時間帯

制限なし

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

- VT エスケープシーケンスによるウィンドウ操作は、悪意あるターミナルプロセスがウィンドウを非表示にする攻撃に利用される可能性がある
- スロットリングにより、最小化/復元の無限ループ（GH#13147）を防止している
- IslandWindow::ShowWindowChanged のコメントに「IMPORTANT!」とマークされた処理があり、特別な注意が必要

## 備考

- ShowWindowChanged イベントは ControlCore.idl のコメントで「These events are called from some background thread」に分類されている（L190）
- AppHost での200msスロットリングは GH#13147 の対策として実装された。PTY のウィンドウ状態と Terminal のウィンドウ状態がデシンクし、最小化/復元が無限ループする問題を防止する
- TerminalApi.cpp L337-342 が Terminal コア層での ShowWindow 実装。_pfnShowWindowChanged コールバックを呼び出す
- Terminal.cpp L1184-1186 の SetShowWindowCallback でコールバックが設定される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | EventArgs.idl | `src/cascadia/TerminalControl/EventArgs.idl` | L115-118: ShowWindowArgs の WinRT 定義。ShowOrHide(Boolean) プロパティ |
| 1-2 | EventArgs.h | `src/cascadia/TerminalControl/EventArgs.h` | L172-181: ShowWindowArgs の C++ 実装 |

#### Step 2: Terminal コア層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | TerminalApi.cpp | `src/cascadia/TerminalCore/TerminalApi.cpp` | L337-342: Terminal::ShowWindow。_pfnShowWindowChanged コールバック呼び出し |
| 2-2 | Terminal.cpp | `src/cascadia/TerminalCore/Terminal.cpp` | L1184-1186: SetShowWindowCallback。コールバック設定 |
| 2-3 | Terminal.hpp | `src/cascadia/TerminalCore/Terminal.hpp` | L229, L337: コールバック宣言とメンバ変数 |

#### Step 3: ControlCore 層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | L124-125: SetShowWindowCallback でコールバック登録 |
| 3-2 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | L1650-1653: _terminalShowWindowChanged で ShowWindowArgs 生成・イベント発火 |

#### Step 4: 伝搬・最終処理層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | L1978: ShowWindowChanged ハンドラ登録 |
| 4-2 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | L3229-3232: _ShowWindowChangedHandler で再発火 |
| 4-3 | AppHost.cpp | `src/cascadia/WindowsTerminal/AppHost.cpp` | L270, L1040-1048: _ShowWindowChanged ハンドラ。_showHideWindowThrottler でスロットリング |
| 4-4 | AppHost.cpp | `src/cascadia/WindowsTerminal/AppHost.cpp` | L293-299: スロットリング設定。200ms、trailing モード |
| 4-5 | IslandWindow.cpp | `src/cascadia/WindowsTerminal/IslandWindow.cpp` | L893: ShowWindowChanged で ShowWindow API 呼び出し |

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

```
Terminal::ShowWindow (VT エスケープ)
    |
    +-- _pfnShowWindowChanged(showOrHide)
            |
            v
ControlCore::_terminalShowWindowChanged
    |
    +-- ShowWindowArgs 生成
    +-- ShowWindowChanged.raise
            |
            v
TermControl (バブリング)
            |
            v
TerminalPage::_ShowWindowChangedHandler
    |
    +-- ShowWindowChanged.raise (再発火)
            |
            v
AppHost::_ShowWindowChanged
    |
    +-- _showHideWindowThrottler.Run(showOrHide)
            |  (200ms trailing throttle)
            v
IslandWindow::ShowWindowChanged
    |
    +-- ShowWindow(hwnd, ...)
```

### データフロー図

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

VT CSI t シーケンス --> Terminal::ShowWindow          Win32 ShowWindow
(PTYプロセス)             |                           (ウィンドウ状態変更)
                          v                                ^
                    ControlCore                            |
                    (ShowWindowArgs)                       |
                          |                                |
                          v                                |
                    TermControl -> TerminalPage            |
                          |                                |
                          v                                |
                    AppHost (200ms throttle)                |
                          |                                |
                          v                                |
                    IslandWindow ---- ShowWindow() ------->|
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| EventArgs.idl | `src/cascadia/TerminalControl/EventArgs.idl` | IDL定義 | ShowWindowArgs の WinRT 定義 |
| EventArgs.h | `src/cascadia/TerminalControl/EventArgs.h` | ソース | ShowWindowArgs の C++ 実装 |
| TerminalApi.cpp | `src/cascadia/TerminalCore/TerminalApi.cpp` | ソース | Terminal::ShowWindow 実装 |
| Terminal.cpp | `src/cascadia/TerminalCore/Terminal.cpp` | ソース | SetShowWindowCallback 実装 |
| Terminal.hpp | `src/cascadia/TerminalCore/Terminal.hpp` | ヘッダ | コールバック宣言 |
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL定義 | ShowWindowChanged イベント宣言 |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | コールバック登録・イベント発火 |
| TermControl.idl | `src/cascadia/TerminalControl/TermControl.idl` | IDL定義 | ShowWindowChanged バブリング宣言（L95） |
| TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | ソース | ShowWindowChanged 伝搬 |
| TerminalPage.idl | `src/cascadia/TerminalApp/TerminalPage.idl` | IDL定義 | ShowWindowChanged 再宣言 |
| TerminalWindow.idl | `src/cascadia/TerminalApp/TerminalWindow.idl` | IDL定義 | ShowWindowChanged 宣言 |
| AppHost.cpp | `src/cascadia/WindowsTerminal/AppHost.cpp` | ソース | スロットリング処理・最終ハンドラ |
| AppHost.h | `src/cascadia/WindowsTerminal/AppHost.h` | ヘッダ | AppHost クラス宣言 |
| IslandWindow.cpp | `src/cascadia/WindowsTerminal/IslandWindow.cpp` | ソース | Win32 ShowWindow API 呼び出し |
| IslandWindow.h | `src/cascadia/WindowsTerminal/IslandWindow.h` | ヘッダ | IslandWindow クラス宣言 |
