# 機能設計書 26-ペインの読み取り専用切替

## 概要

本ドキュメントは、Windows Terminal における「ペインの読み取り専用切替（TogglePaneReadOnly）」機能の設計を記述する。現在フォーカスされたペイン（親ペインの場合は全子ペイン）の読み取り専用モードのオン/オフを切り替える機能である。

### 本機能の処理概要

**業務上の目的・背景**：ターミナルセッションで重要なプロセスを実行中に、誤った入力でプロセスを中断してしまうリスクがある。読み取り専用モードを有効にすることで、ユーザーの入力がターミナルに送信されなくなり、誤操作を防止できる。ログ監視など出力のみを確認するセッションでも有用である。

**機能の利用シーン**：長時間のビルドやデプロイメント中に誤ってCtrl+Cを押さないようにしたい場合、またはログ監視用のペインで入力を受け付けないようにしたい場合に利用する。タブヘッダーにロックアイコンが表示され、読み取り専用状態が視覚的に確認できる。

**主要な処理内容**：
1. TogglePaneReadOnlyアクションが発火する
2. アクティブタブのアクティブペインを対象とする
3. ペインが親ペイン（子を持つ）の場合は、全子ペインの読み取り専用状態を調査する
4. 全ペインが同一状態（全て読み取り専用/全て非読み取り専用）の場合はトグルする
5. 混在状態（一部のみ読み取り専用）の場合は全て読み取り専用にする
6. TerminalControl の ReadOnly フラグを変更する

**関連システム・外部連携**：TerminalControl の ControlCore 層で _isReadOnly フラグを管理する。読み取り専用時に入力があるとユーザーに通知（"Read-only" メッセージ）が表示される。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | TerminalPage（メイン画面） | 主画面 | _HandleTogglePaneReadOnlyにより読み取り専用を切替 |
| 3 | TabHeaderControl（タブヘッダー） | 補助画面 | HeaderLockIconにより読み取り専用状態を表示 |
| 16 | CloseReadOnlyDialog（読み取り専用警告） | 補助画面 | 読み取り専用セッション閉じの警告表示 |

## 機能種別

UI操作（ペイン入力制御）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| （なし） | - | - | 引数なしのトグル操作 | - |

### 入力データソース

キーバインド設定。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Handled | bool | 常にtrue |

### 出力先

TerminalControl の _isReadOnly フラグ更新。タブヘッダーのロックアイコン更新。

## 処理フロー

### 処理シーケンス

```
1. _HandleTogglePaneReadOnly が ActionEventArgs を受信
   └─ _senderOrFocusedTab でアクティブタブを取得
2. Tab::TogglePaneReadOnly() を呼び出し
3. _activePane の WalkTree で全子ペインの読み取り専用状態を調査
   └─ hasReadOnly: 読み取り専用ペインが1つ以上あるか
   └─ allReadOnly: 全ペインが読み取り専用か
4. 再度 WalkTree で状態を設定
   └─ allReadOnly または !hasReadOnly の場合: ToggleReadOnly（反転）
   └─ それ以外（混在状態）: 非読み取り専用のペインを読み取り専用にする
5. Handled = true
```

### フローチャート

```mermaid
flowchart TD
    A[TogglePaneReadOnly アクション発火] --> B[アクティブタブ取得]
    B --> C[Tab::TogglePaneReadOnly 呼び出し]
    C --> D[WalkTree: hasReadOnly / allReadOnly 判定]
    D --> E{全ペインが同一状態?}
    E -->|Yes: allReadOnly or !hasReadOnly| F[全ペインの ReadOnly をトグル]
    E -->|No: 混在状態| G[非読み取り専用ペインを読み取り専用に]
    F --> H[Handled = true]
    G --> H
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-26-01 | 統一状態時のトグル | 全ペインが同一の読み取り専用状態の場合は一括でトグルする | allReadOnly or !hasReadOnly |
| BR-26-02 | 混在状態時の統一化 | 読み取り専用と非読み取り専用が混在する場合は全て読み取り専用にする | hasReadOnly and !allReadOnly |
| BR-26-03 | 読み取り専用時の入力警告 | 読み取り専用のペインに入力があった場合は通知メッセージを表示する | _isReadOnly == true |
| BR-26-04 | 閉じる時の警告 | 読み取り専用ペインを閉じようとすると警告ダイアログが表示される | 読み取り専用ペインの閉じ操作 |

### 計算ロジック

状態判定ロジック：
- 1回目のWalkTree: `hasReadOnly |= control.ReadOnly()` / `allReadOnly &= control.ReadOnly()` で状態集約
- 2回目のWalkTree: 集約結果に基づいて各ペインの読み取り専用を設定

## データベース操作仕様

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | スキップ | アクティブタブが存在しない | 何もしない |

### リトライ仕様

リトライは不要。

## トランザクション仕様

該当なし。

## パフォーマンス要件

ペインツリーの走査（2回）は即座に完了する。

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

読み取り専用モードは入力制御のみであり、セキュリティ機能としては設計されていない。管理者権限の制御とは無関係。

## 備考

- 親ペインが選択されている場合は、全子ペインの状態が一括で変更される。
- ControlCore 層の `_isReadOnly` フラグが実際の入力ブロックを制御する。
- 読み取り専用時に入力すると "TermControlReadOnly" メッセージが通知される。

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | **320-329行目**: `_HandleTogglePaneReadOnly` メソッド。アクティブタブのTogglePaneReadOnlyを呼び出す |

#### Step 2: Tab層の読み取り専用トグル

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | **2036-2064行目**: `TogglePaneReadOnly` メソッド。2段階のWalkTreeで状態判定と設定を行う |

**主要処理フロー**:
- **2040-2048行目**: 1回目のWalkTree: hasReadOnly / allReadOnly の判定
- **2049-2063行目**: 2回目のWalkTree: 状態に基づく設定

#### Step 3: ControlCore層の読み取り専用制御

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | **2218-2221行目**: `ToggleReadOnlyMode` メソッド。_isReadOnly フラグの反転 |
| 3-2 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | **500-503行目**: 読み取り専用時の入力ブロックと警告表示 |
| 3-3 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | **2228-2232行目**: `_raiseReadOnlyWarning` メソッド。通知イベントの発行 |

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

```
TerminalPage::_HandleTogglePaneReadOnly (AppActionHandlers.cpp:320)
    |
    +-- Tab::TogglePaneReadOnly (Tab.cpp:2036)
            |
            +-- [1st WalkTree] 状態判定
            |       +-- TermControl::ReadOnly() 読み取り
            |
            +-- [2nd WalkTree] 状態設定
                    +-- TermControl::ToggleReadOnly()
                            |
                            +-- ControlCore::ToggleReadOnlyMode (ControlCore.cpp:2218)
```

### データフロー図

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

キーバインド ──> _HandleTogglePaneReadOnly
                        |
               Tab::TogglePaneReadOnly
                        |
            [1st WalkTree] ──> hasReadOnly, allReadOnly
                        |
            [2nd WalkTree] ──> ToggleReadOnly / SetReadOnly
                        |
            ControlCore::_isReadOnly 更新 ──> 入力ブロック有効化/無効化
                                              タブヘッダー ロックアイコン更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleTogglePaneReadOnly アクションハンドラ |
| Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | ソース | TogglePaneReadOnly の実装 |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | ToggleReadOnlyMode / _isReadOnly / _raiseReadOnlyWarning |
| Pane.cpp | `src/cascadia/TerminalApp/Pane.cpp` | ソース | WalkTree / ContainsReadOnly |
| Pane.h | `src/cascadia/TerminalApp/Pane.h` | ヘッダー | ContainsReadOnly 宣言 |
| ActionAndArgs.cpp | `src/cascadia/TerminalSettingsModel/ActionAndArgs.cpp` | ソース | TogglePaneReadOnly アクションの登録 |
