# 通知設計書 1-WindowIdToast

## 概要

本ドキュメントは、Windows Terminal におけるウィンドウID表示トースト通知（WindowIdToast）の設計仕様を定義する。ウィンドウの識別番号と名前をユーザーに一時的に表示するための TeachingTip ベースの通知機能である。

### 本通知の処理概要

WindowIdToast は、ユーザーが複数のWindows Terminalウィンドウを使用している際に、現在のウィンドウを識別するための情報を一時的に画面上に表示するトースト通知である。

**業務上の目的・背景**：Windows Terminal は複数ウィンドウの同時利用をサポートしており、各ウィンドウには一意のIDと任意の名前が付与される。ユーザーが多数のウィンドウを開いている場合、どのウィンドウが何番であるかを素早く確認する必要がある。本通知はその識別情報をオーバーレイ表示することで、ウィンドウ管理の効率化を実現する。

**通知の送信タイミング**：ユーザーが `identifyWindow` アクション（キーバインド等）を実行した時に表示される。`_HandleIdentifyWindow` アクションハンドラを経由して `TerminalPage::IdentifyWindow()` が呼び出される。また、`identifyWindows`（複数形）アクションでは、全ウィンドウに対して一斉にこの通知が発行される。

**通知の受信者**：現在のウィンドウを操作しているユーザー自身。アプリ内UI通知としてウィンドウ上にオーバーレイ表示される。

**通知内容の概要**：ウィンドウIDの表示値（`WindowIdForDisplay`）が TeachingTip の Title として表示され、ウィンドウ名の表示値（`WindowNameForDisplay`）が Subtitle として表示される。

**期待されるアクション**：ユーザーは表示された情報を確認し、ウィンドウの識別に利用する。3秒後に自動的に消去されるため、特別な操作は不要である。ライトディスミス（通知外クリック）による手動消去も可能。

## 通知種別

アプリ内通知（TeachingTip ベースの Toast 通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（UIスレッド上で即時表示） |
| 優先度 | 中 |
| リトライ | 無し |

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

アクションを実行したウィンドウのTerminalPage上に直接表示される。送信先の決定は不要で、アクションのコンテキストウィンドウに対して表示される。

## 通知テンプレート

### アプリ内通知（TeachingTip）の場合

| 項目 | 内容 |
|-----|------|
| UIコントロール | `Microsoft.UI.Xaml.Controls.TeachingTip` |
| 名前 | `WindowIdToast` |
| IsLightDismissEnabled | True（XAML定義時）。ただしコード内で `false` に変更される（マルチウィンドウ干渉回避のため） |

### 本文テンプレート

```
Title: {WindowProperties.WindowIdForDisplay}
Subtitle: {WindowProperties.WindowNameForDisplay}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| WindowIdForDisplay | ウィンドウIDの表示用文字列 | WindowProperties.WindowIdForDisplay | Yes |
| WindowNameForDisplay | ウィンドウ名の表示用文字列 | WindowProperties.WindowNameForDisplay（Mode=OneWay） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ユーザーアクション | `identifyWindow` アクション | 無条件 | 単一ウィンドウの識別情報を表示 |
| ユーザーアクション | `identifyWindows` アクション | 無条件 | 全ウィンドウに対して識別情報を一斉表示（Monarch経由） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| TeachingTip の FindName 失敗 | XAML要素が見つからない場合、Toast オブジェクトが生成されず表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがidentifyWindowアクション実行] --> B[_HandleIdentifyWindow]
    B --> C[TerminalPage::IdentifyWindow]
    C --> D{_windowIdToast == nullptr?}
    D -->|Yes| E[FindName でTeachingTip取得]
    E --> F[Toast オブジェクト生成]
    F --> G[IsLightDismissEnabled を false に設定]
    G --> H[Closed コールバック登録]
    D -->|No| I[テーマ更新]
    H --> I
    I --> J{_windowIdToast != nullptr?}
    J -->|Yes| K[Toast::Open 呼び出し]
    J -->|No| L[表示スキップ]
    K --> M[TeachingTip.IsOpen = true]
    M --> N[タイマー開始（3秒）]
    N --> O[3秒後自動消去]
    O --> P[_FocusActiveControl コールバック]
    L --> Q[終了]
    P --> Q
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| XAML要素未発見 | FindName(L"WindowIdToast") が null を返す場合 | Toast オブジェクトが生成されず、通知は表示されない（サイレント失敗） |
| 弱参照消失 | Toast::Open 内のタイマーコールバック実行時にオブジェクトが破棄済みの場合 | weak_ptr.lock() が失敗し、コールバックは安全にスキップされる |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | 特になし（ユーザーアクション駆動のため） |

### 配信時間帯

制限なし（アプリケーション稼働中はいつでも表示可能）

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

特になし。表示される情報はウィンドウIDと名前のみであり、個人情報や機密情報は含まれない。

## 備考

- TeachingTip の `IsLightDismissEnabled` は XAML 上では `True` に設定されているが、コード上で `false` に変更される。これは、マルチウィンドウ環境で別ウィンドウの TeachingTip が開かれた際に即座にディスミスされてしまうバグ（MUX#4382）を回避するためである。
- Toast クラスは `std::enable_shared_from_this` を継承しており、`std::shared_ptr` での管理が必須である。
- 自動消去時間は `ToastDuration`（3000ミリ秒 = 3秒）で定義されている。
- 閉じた後は `_FocusActiveControl` コールバックによりアクティブなターミナルコントロールにフォーカスが戻る。

---

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

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

### 推奨読解順序

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

まず、Toast クラスのデータ構造と TeachingTip の関係を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Toast.h | `src/cascadia/TerminalApp/Toast.h` | Toast クラスの定義。`std::enable_shared_from_this` の継承、`TeachingTip` と `SafeDispatcherTimer` のメンバを確認（行29-38） |
| 1-2 | Toast.cpp | `src/cascadia/TerminalApp/Toast.cpp` | `ToastDuration`（3000ms）の定義（行12）と `Open()` メソッドの実装（行27-40） |

**読解のコツ**: Toast クラスは WinUI の `TeachingTip` コントロールをラップし、タイマーによる自動消去機能を付加するヘルパークラスである。`shared_from_this()` による弱参照パターンに注目。

#### Step 2: エントリーポイントを理解する

処理の起点となるアクションハンドラを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | `_HandleIdentifyWindow` メソッド（行1000-1003）がアクションのエントリーポイント |

**主要処理フロー**:
1. **行1000**: `_HandleIdentifyWindow` がアクションディスパッチャーから呼び出される
2. **行1003**: `IdentifyWindow()` を呼び出してトースト表示を開始

#### Step 3: Toast 表示処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | `IdentifyWindow()` メソッド（行4521-4542）。遅延ロード、TeachingTip の初期化、Toast の Open を実行 |

**主要処理フロー**:
- **行4525**: `_windowIdToast` が null かチェック（初回のみ初期化）
- **行4527**: `FindName` で XAML の `WindowIdToast` TeachingTip を遅延ロード
- **行4529**: `std::make_shared<Toast>(tip)` で Toast オブジェクトを生成
- **行4532**: `IsLightDismissEnabled(false)` でマルチウィンドウバグを回避
- **行4534**: `tip.Closed` コールバックに `_FocusActiveControl` を登録
- **行4537**: テーマを更新
- **行4541**: `_windowIdToast->Open()` でトーストを表示

#### Step 4: XAML定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPage.xaml | `src/cascadia/TerminalApp/TerminalPage.xaml` | `WindowIdToast` TeachingTip の定義（行183-187）。Title と Subtitle のバインディングを確認 |

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

```
ユーザーアクション (identifyWindow)
    |
    +-- AppActionHandlers::_HandleIdentifyWindow (行1000)
           |
           +-- TerminalPage::IdentifyWindow() (行4521)
                  |
                  +-- FindName("WindowIdToast") ... 初回のみ (行4527)
                  |      |
                  |      +-- std::make_shared<Toast>(tip) (行4529)
                  |      +-- tip.IsLightDismissEnabled(false) (行4532)
                  |      +-- tip.Closed += _FocusActiveControl (行4534)
                  |
                  +-- _UpdateTeachingTipTheme() (行4537)
                  |
                  +-- Toast::Open() (行4541)
                         |
                         +-- TeachingTip.IsOpen(true) (Toast.cpp 行29)
                         +-- SafeDispatcherTimer.Start() (Toast.cpp 行39)
                                |
                                +-- [3秒後] TeachingTip.IsOpen(false) (Toast.cpp 行36)
```

### データフロー図

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

identifyWindow          TerminalPage::IdentifyWindow()      TeachingTip 表示
アクション       --->    Toast オブジェクト初期化・Open  --->  (3秒後自動消去)

WindowProperties        x:Bind (XAML DataBinding)           Title: WindowIdForDisplay
.WindowIdForDisplay --> TerminalPage.xaml TeachingTip  -->   Subtitle: WindowNameForDisplay
.WindowNameForDisplay
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Toast.h | `src/cascadia/TerminalApp/Toast.h` | ソース | Toast ヘルパークラスのヘッダ定義 |
| Toast.cpp | `src/cascadia/TerminalApp/Toast.cpp` | ソース | Toast クラスの実装（Open、タイマー制御） |
| TerminalPage.xaml | `src/cascadia/TerminalApp/TerminalPage.xaml` | XAML | WindowIdToast TeachingTip のUI定義 |
| TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | ソース | IdentifyWindow() メソッドの実装 |
| TerminalPage.h | `src/cascadia/TerminalApp/TerminalPage.h` | ソース | _windowIdToast メンバの宣言 |
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleIdentifyWindow アクションハンドラ |
| TerminalPage.idl | `src/cascadia/TerminalApp/TerminalPage.idl` | IDL | IdentifyWindow() の公開インターフェース定義 |
