# 通知設計書 49-OutputIdle

## 概要

本ドキュメントは、Windows Terminal における OutputIdle イベントの設計仕様を記述する。このイベントは、ターミナルへの出力が一定時間（100ms）途絶えた際に発火し、パターン検出や検索結果の更新などのバッチ処理をトリガーする。

### 本通知の処理概要

OutputIdleイベントは、ターミナルからの出力が100ms以上途絶えた（アイドル状態になった）ことをUI層に通知するためのイベントである。ControlCoreの_setupDispatcherAndCallbacks内でtil::throttled_funcとして構成され、出力ハンドラ（_connectionOutputHandler）が呼ばれるたびにデバウンスタイマーがリセットされる。100ms間出力がなかった場合、バックグラウンドスレッドでTerminalのUpdatePatternsUnderLockを実行し、UIスレッドでOutputIdleイベントを発火する。

**業務上の目的・背景**：ターミナルへの出力はバースト的に発生するため、出力中にパターン検出（正規表現マッチ）や検索更新を行うのはパフォーマンス上好ましくない。出力が落ち着いた後にまとめてこれらの処理を行うことで、パフォーマンスとユーザー体験の両立を図る。GH#12607の対応として、パターン検出をバックグラウンドスレッドで行う設計が採用されている。

**通知の送信タイミング**：最後の出力から100ms経過後にデバウンスタイマーが発火する。trailing mode（最後の呼び出しから遅延後に発火）で動作する。

**通知の受信者**：TermControlの`_coreOutputIdle`ハンドラがControlCoreからのイベントを受信する。

**通知内容の概要**：イベント引数はnullptr（Object, Object型）。

**期待されるアクション**：TermControlは`_refreshSearch()`を呼び出して検索結果を更新する。これにより、新しい出力に対する検索マッチが反映される。

## 通知種別

アプリ内通知（WinRT イベント / デバウンスタイマー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（デバウンス100ms、バックグラウンドスレッドからUIスレッドにディスパッチ） |
| 優先度 | 低 |
| リトライ | 無し |

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

ControlCoreのthrottled_func（outputIdle）が100msのデバウンス後にUIスレッドでOutputIdle.raiseを呼び出し、TermControlがwinrt::auto_revokeで購読する。

## 通知テンプレート

### メール通知の場合

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

### 本文テンプレート

```
該当なし（イベント引数なし）
```

### 添付ファイル

該当なし

## テンプレート変数

該当なし（イベント引数にデータは含まれない）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| タイマー | デバウンスタイマー満了 | 最後の出力から100ms経過 | ターミナル出力のアイドル検出 |
| 出力ハンドラ | _connectionOutputHandler | 出力があるたびにタイマーリセット | 出力データ受信時にデバウンスタイマーを再起動 |
| 検索関連 | 検索パターン変更時 | outputIdleが手動で呼ばれる | Search実行後にOutputIdleを手動トリガー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| _IsClosing | ControlCoreがクロージング中の場合はスキップ |
| weak_ptr失効 | ControlCoreがすでに破棄されている場合はスキップ |
| Detach済み | Detach()でoutputIdleがresetされている場合は発火しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ターミナル出力受信] --> B[_connectionOutputHandler]
    B --> C[outputIdle タイマーリセット/開始]
    C --> D{100ms以内に次の出力?}
    D -->|Yes| B
    D -->|No| E[デバウンスタイマー満了]
    E --> F[バックグラウンドスレッド: Terminal::UpdatePatternsUnderLock]
    E --> G[UIスレッドにディスパッチ]
    G --> H{ControlCore有効?}
    H -->|No| I[スキップ]
    H -->|Yes| J[OutputIdle.raise]
    J --> K[TermControl::_coreOutputIdle]
    K --> L[_refreshSearch]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| weak_ptr失効 | ControlCoreがすでに破棄されている場合 | weakThis.get()のnullチェックでスキップ |
| _IsClosing | クロージング中 | _IsClosing()チェックでスキップ |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| デバウンス間隔 | 100ms（trailing mode） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

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

OutputIdleイベントは純粋なタイミング通知であり、個人情報や機密情報を含まない。

## 備考

- ControlCore.idlではOutputIdleは「UIスレッドから常に呼び出される」カテゴリに分類されている
- til::throttled_funcのオプション: `delay=100ms`, `debounce=true`, `trailing=true`
- デバウンスタイマーの満了時、2つの処理が並行して行われる：(1) UIスレッドでOutputIdle.raise、(2) バックグラウンドスレッドでUpdatePatternsUnderLock
- Detach()時にoutputIdleはresetされ、AttachToNewControl()で再セットアップされる
- Search実行後やInitialize後にもoutputIdleが手動で呼び出される（1229-1235行目、2250-2252行目）

---

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

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

### 推奨読解順序

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

OutputIdleは独自のEventArgsを持たない。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | 212行目: `event ... OutputIdle` - Object, Object型イベント |
| 1-2 | ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | 290行目: `til::typed_event<> OutputIdle` |
| 1-3 | ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | 308行目: `std::unique_ptr<til::throttled_func<>> outputIdle` - SharedState内のデバウンスタイマー |

**読解のコツ**: `til::throttled_func<>` はテンプレート引数なしで、引数を取らないコールバック関数のデバウンスラッパーである。`debounce=true` は呼び出しのたびにタイマーをリセットし、`trailing=true` は最後の呼び出しから遅延後に発火する。

#### Step 2: セットアップを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | 189-215行目: _setupDispatcherAndCallbacks内でoutputIdleを構築 |

**主要処理フロー**:
1. **194行目**: `shared->outputIdle = std::make_unique<til::throttled_func<>>(...)` でデバウンスタイマー作成
2. **195-198行目**: オプション設定: delay=100ms, debounce=true, trailing=true
3. **200-205行目**: UIスレッドでOutputIdle.raiseをディスパッチ
4. **213-214行目**: バックグラウンドでTerminal::UpdatePatternsUnderLockを実行

#### Step 3: トリガー箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | 738-740行目: _connectionOutputHandler内で `(*shared->outputIdle)()` を呼ぶ |
| 3-2 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | 1229-1235行目: Search関連でoutputIdleを手動呼び出し |
| 3-3 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | 2250-2252行目: Initialize後のoutputIdle呼び出し |

**主要処理フロー**:
- **738-740行目**: 出力データを処理した後、outputIdleを呼び出してデバウンスタイマーを再起動/開始
- **1233-1235行目**: 検索実行後にoutputIdleを呼び出して検索結果の更新を遅延させる

#### Step 4: クリーンアップ

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | 280行目: Detach内で `shared->outputIdle.reset()` |

#### Step 5: TermControl側ハンドラ

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | 314行目: イベント購読 |
| 5-2 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | 3820-3823行目: _coreOutputIdle - _refreshSearch()呼び出し |

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

```
Connection (出力受信)
    |
    +-- ControlCore::_connectionOutputHandler(str)
            |
            +-- (*shared->outputIdle)() [デバウンスタイマー開始/リセット]
                    |
                    +-- [100ms後] til::throttled_func コールバック
                            |
                            +-- [UIスレッド] OutputIdle.raise(*self, nullptr)
                            |       |
                            |       +-- TermControl::_coreOutputIdle()
                            |               |
                            |               +-- _refreshSearch()
                            |
                            +-- [バックグラウンド] _terminal->UpdatePatternsUnderLock()
```

### データフロー図

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

ターミナル出力          outputIdle                     TermControl
(char16_t[])       -->  デバウンスタイマー              -->  _refreshSearch()
                        (100ms trailing)                    検索結果更新
                   -->  UpdatePatternsUnderLock()
                        正規表現パターン更新              -->  パターンハイライト更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL | OutputIdleイベント宣言 |
| ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | ソース | OutputIdleイベント定義、SharedState::outputIdle |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | outputIdleセットアップ、トリガー、クリーンアップ |
| TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ソース | _coreOutputIdleハンドラ |
| TermControl.h | `src/cascadia/TerminalControl/TermControl.h` | ソース | ハンドラ宣言 |
