# 通知設計書 41-ReadOnlyChanged

## 概要

本ドキュメントは、Windows Terminal における ReadOnlyChanged イベントの設計仕様を記述する。このイベントは、ターミナルペインの読み取り専用状態が変更された際に発火し、UI層に状態変更を伝搬する。

### 本通知の処理概要

ReadOnlyChangedイベントは、ターミナルの読み取り専用モードの切り替えをアプリケーション全体に通知するためのイベントである。ユーザー操作によりToggleReadOnly/SetReadOnlyが呼び出されると、ControlCoreの内部フラグ `_isReadOnly` が更新され、TermControl層からReadOnlyChangedイベントが発火する。このイベントはTerminalPaneContent、Tab層を経由して伝搬され、タブのUI表示更新などに使用される。

**業務上の目的・背景**：ターミナルの読み取り専用モードは、誤操作による入力を防止するための重要な安全機構である。ユーザーがログを監視しているだけの場合や、重要な出力を誤って消去しないようにする場合に使用される。この状態変更を適切に通知することで、タブアイコンの変更やコンテキストメニューの更新など、UI全体の整合性を保つ必要がある。

**通知の送信タイミング**：ユーザーがToggleReadOnly アクションを実行した時、またはSetReadOnly アクションにより明示的に読み取り専用状態を設定した時に発火する。

**通知の受信者**：TerminalPaneContent（IPaneContent実装）がTermControlからのイベントをハンドリングし、さらにTab層がIPaneContentのReadOnlyChangedイベントを購読する。最終的にタブUI更新やPaneの状態管理に反映される。

**通知内容の概要**：現在の読み取り専用状態（bool値）がboxed valueとして送信される。trueの場合は読み取り専用が有効、falseの場合は無効である。

**期待されるアクション**：受信側はタブのアイコンや表示状態を更新し、読み取り専用モードであることをユーザーに視覚的に伝える。また、入力がブロックされている旨をUIに反映する。

## 通知種別

アプリ内通知（WinRT イベント / C++ イベントハンドラ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無し |

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

TermControlが発火し、TerminalPaneContentがwinrt::auto_revokeで購読する。TerminalPaneContentはBasicPaneEventsのReadOnlyChangedイベントをさらに発火し、Tabがこれを購読する。イベント伝搬はオブザーバーパターンに基づく直接的なイベントチェーンで行われる。

## 通知テンプレート

### メール通知の場合

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

### 本文テンプレート

```
該当なし（WinRTイベント引数としてbool値が伝達される）
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| IsInReadOnlyMode | 読み取り専用状態 | ControlCore._isReadOnly | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ユーザー操作 | ToggleReadOnly アクション | 常に発火 | 読み取り専用モードのトグル操作 |
| ユーザー操作 | SetReadOnly アクション | 常に発火 | 読み取り専用モードの明示的設定 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 特になし | 状態変更時は常に発火する |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザー操作: ToggleReadOnly/SetReadOnly] --> B[TermControl::ToggleReadOnly/SetReadOnly]
    B --> C[ControlCore::ToggleReadOnlyMode/SetReadOnlyMode]
    C --> D[_isReadOnly フラグ更新]
    D --> E[TermControl: ReadOnlyChanged.raise]
    E --> F[TerminalPaneContent::_controlReadOnlyChanged]
    F --> G[BasicPaneEvents::ReadOnlyChanged.raise]
    G --> H[Tab層: イベントハンドラ]
    H --> I[タブUI更新]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 特になし | ReadOnlyChanged は単純なフラグ変更であり、エラーは通常発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

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

読み取り専用モードは入力をブロックする安全機構であるが、セキュリティ上の強制的な保護ではなく、ユーザーの利便性のための機能である。個人情報や機密情報の送受信は行われない。

## 備考

- ReadOnlyChangedイベントはTermControl.idlで `event Windows.Foundation.TypedEventHandler<Object, Object>` として定義されている
- ControlCoreレベルではイベントは定義されておらず、TermControlが直接フラグ変更後にイベントを発火する
- BasicPaneEventsでIPaneContent層にもReadOnlyChangedイベントが定義されており、Tab層まで伝搬される

---

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

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

### 推奨読解順序

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

ReadOnlyChangedは独自のEventArgsを持たない。bool値がboxed valueとしてイベント引数に渡される。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | `_isReadOnly` フィールド（424行目）が読み取り専用状態を保持する |
| 1-2 | TermControl.idl | `src/cascadia/TerminalControl/TermControl.idl` | 74行目: ReadOnlyChangedイベント定義、136-138行目: ReadOnly/ToggleReadOnly/SetReadOnly メソッド定義 |
| 1-3 | IPaneContent.idl | `src/cascadia/TerminalApp/IPaneContent.idl` | 29行目: ReadOnlyプロパティ、47行目: ReadOnlyChangedイベント定義 |

**読解のコツ**: WinRTのイベント定義はIDLファイルで宣言され、実装はC++ファイルに分離される。`til::typed_event<>` は引数なしイベント、`til::typed_event<IPaneContent>` は送信者型が指定されたイベントである。

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

TermControlのToggleReadOnly/SetReadOnlyが処理の起点となる。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ToggleReadOnly（3417-3421行目）、SetReadOnly（3425-3429行目）がエントリーポイント |

**主要処理フロー**:
1. **3419行目**: `_core.ToggleReadOnlyMode()` で ControlCore の内部フラグを切り替え
2. **3420行目**: `ReadOnlyChanged.raise(*this, winrt::box_value(_core.IsInReadOnlyMode()))` でイベント発火

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ToggleReadOnlyMode（2218-2221行目）: `_isReadOnly` のトグル。SetReadOnlyMode（2223-2226行目）: 明示的設定。IsInReadOnlyMode（2213-2216行目）: 現在の状態取得 |

**主要処理フロー**:
- **2220行目**: `_isReadOnly = !_isReadOnly;` でフラグをトグル
- **500行目**: `if (_isReadOnly)` で入力処理時に読み取り専用チェックが行われる

#### Step 4: イベント伝搬（TerminalPaneContent層）

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPaneContent.cpp | `src/cascadia/TerminalApp/TerminalPaneContent.cpp` | 43行目: イベント購読登録、176-178行目: _controlReadOnlyChanged ハンドラ |

**主要処理フロー**:
- **43行目**: `_controlEvents._ReadOnlyChanged = _control.ReadOnlyChanged(winrt::auto_revoke, ...)` でTermControlのイベントを購読
- **178行目**: `ReadOnlyChanged.raise(*this, nullptr)` でBasicPaneEventsのイベントを再発火

#### Step 5: イベント伝搬（Tab層）

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | 1112行目: IPaneContentのReadOnlyChangedイベントを購読 |

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

```
TermControl::ToggleReadOnly() / SetReadOnly()
    |
    +-- ControlCore::ToggleReadOnlyMode() / SetReadOnlyMode()
    |       |
    |       +-- _isReadOnly フラグ更新
    |
    +-- ReadOnlyChanged.raise(*this, boxed bool)
            |
            +-- TerminalPaneContent::_controlReadOnlyChanged()
                    |
                    +-- BasicPaneEvents::ReadOnlyChanged.raise(*this, nullptr)
                            |
                            +-- Tab イベントハンドラ
```

### データフロー図

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

ユーザー操作           TermControl                    TerminalPaneContent
(ToggleReadOnly)  ---->  ControlCore._isReadOnly更新  ---->  ReadOnlyChanged
                         ReadOnlyChanged.raise()             イベント伝搬
                                                       ---->  Tab UI更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | ソース | _isReadOnlyフラグ定義 |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | ToggleReadOnlyMode/SetReadOnlyMode/IsInReadOnlyMode実装 |
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL | ToggleReadOnlyMode/SetReadOnlyMode/IsInReadOnlyMode 宣言 |
| TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ソース | ToggleReadOnly/SetReadOnly実装とイベント発火 |
| TermControl.h | `src/cascadia/TerminalControl/TermControl.h` | ソース | ReadOnlyChangedイベント宣言 |
| TermControl.idl | `src/cascadia/TerminalControl/TermControl.idl` | IDL | ReadOnlyChangedイベント・ReadOnly関連メソッド定義 |
| TerminalPaneContent.cpp | `src/cascadia/TerminalApp/TerminalPaneContent.cpp` | ソース | ReadOnlyChangedイベント中継 |
| TerminalPaneContent.h | `src/cascadia/TerminalApp/TerminalPaneContent.h` | ソース | イベント中継宣言 |
| BasicPaneEvents.h | `src/cascadia/TerminalApp/BasicPaneEvents.h` | ソース | ReadOnlyChangedイベント定義（IPaneContent層） |
| IPaneContent.idl | `src/cascadia/TerminalApp/IPaneContent.idl` | IDL | ReadOnlyChanged / ReadOnlyプロパティ定義 |
| Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | ソース | ReadOnlyChangedイベント購読 |
