# 機能設計書 27-ペインの読み取り専用を有効化

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：No.26のTogglePaneReadOnlyはトグル操作であるため、現在の状態に依存して結果が変わる。確実に読み取り専用を有効にしたい場合（スクリプトやマクロからの呼び出し時など）に、明示的な有効化アクションが必要となる。

**機能の利用シーン**：スクリプトやMultipleActionsで複数のアクションを連続実行する際に、確実に読み取り専用を有効にしたい場合に利用する。現在の状態がどちらであっても結果が保証される。

**主要な処理内容**：
1. EnablePaneReadOnlyアクションが発火する
2. アクティブタブの SetPaneReadOnly(true) を呼び出す
3. 全子ペインの読み取り専用状態を調査し、指定状態（true）に統一する
4. 統一状態の場合は SetReadOnly(true) を設定
5. 混在状態の場合は非読み取り専用のペインを読み取り専用にする

**関連システム・外部連携**：TerminalControl の ControlCore 層で _isReadOnly フラグを管理する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | TerminalPage（メイン画面） | 主画面 | _HandleEnablePaneReadOnlyにより読み取り専用を有効化 |
| 3 | TabHeaderControl（タブヘッダー） | 補助画面 | HeaderLockIconにより読み取り専用状態を表示 |

## 機能種別

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| （なし） | - | - | 引数なし。常に読み取り専用を有効化する | - |

### 入力データソース

キーバインド設定。

## 出力仕様

### 出力データ

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

### 出力先

TerminalControl の _isReadOnly フラグを true に設定。

## 処理フロー

### 処理シーケンス

```
1. _HandleEnablePaneReadOnly が ActionEventArgs を受信
   └─ _senderOrFocusedTab でアクティブタブを取得
2. Tab::SetPaneReadOnly(true) を呼び出し
3. _activePane の WalkTree で全子ペインの読み取り専用状態を調査
4. 再度 WalkTree で SetReadOnly(true) を設定
   └─ 統一状態（allReadOnly or !hasReadOnly）の場合: SetReadOnly(true)
   └─ 混在状態の場合: 非読み取り専用のペインに SetReadOnly(true)
5. Handled = true
```

### フローチャート

```mermaid
flowchart TD
    A[EnablePaneReadOnly アクション発火] --> B[アクティブタブ取得]
    B --> C[Tab::SetPaneReadOnly true]
    C --> D[WalkTree: 状態判定]
    D --> E[WalkTree: SetReadOnly true 設定]
    E --> F[Handled = true]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-27-01 | 冪等性 | 既に読み取り専用のペインに対しては状態が変化しない | allReadOnly の場合 |
| BR-27-02 | 統一設定 | 親ペインが選択されている場合は全子ペインが対象 | 常時 |

### 計算ロジック

No.26 の TogglePaneReadOnly と同様の2段階WalkTreeロジックを使用するが、第2段階で SetReadOnly(readOnlyState) を呼び出す点が異なる。

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

該当なし。

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライは不要。

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

該当なし。

## パフォーマンス要件

即座に完了する。

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

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

## 備考

- No.26（TogglePaneReadOnly）との違いは、状態に関係なく常に読み取り専用を有効にする点。
- Tab::SetPaneReadOnly メソッドを readOnlyState=true で呼び出す。

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | **331-340行目**: `_HandleEnablePaneReadOnly` メソッド。SetPaneReadOnly(true) を呼び出す |

**主要処理フロー**:
1. **334行目**: `_senderOrFocusedTab(sender)` でアクティブタブ取得
2. **336行目**: `activeTab->SetPaneReadOnly(true)` 呼び出し

#### Step 2: Tab層の読み取り専用設定

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | **2070-2096行目**: `SetPaneReadOnly` メソッド。readOnlyState パラメータで明示的に状態を指定する |

**主要処理フロー**:
- **2074-2080行目**: 1回目のWalkTree: 状態調査
- **2081-2095行目**: 2回目のWalkTree: SetReadOnly(readOnlyState) で状態設定

#### Step 3: ControlCore層

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | **2223-2226行目**: `SetReadOnlyMode` メソッド。_isReadOnly を引数値に直接設定 |

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

```
TerminalPage::_HandleEnablePaneReadOnly (AppActionHandlers.cpp:331)
    |
    +-- Tab::SetPaneReadOnly(true) (Tab.cpp:2070)
            |
            +-- [1st WalkTree] 状態判定
            |
            +-- [2nd WalkTree] 状態設定
                    +-- TermControl::SetReadOnly(true)
                            |
                            +-- ControlCore::SetReadOnlyMode(true) (ControlCore.cpp:2223)
```

### データフロー図

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

キーバインド ──> _HandleEnablePaneReadOnly
                        |
              Tab::SetPaneReadOnly(true)
                        |
              [WalkTree] ──> SetReadOnly(true) ──> _isReadOnly = true
                                                     タブヘッダー更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleEnablePaneReadOnly アクションハンドラ |
| Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | ソース | SetPaneReadOnly メソッドの実装 |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | SetReadOnlyMode メソッド |
| ActionAndArgs.cpp | `src/cascadia/TerminalSettingsModel/ActionAndArgs.cpp` | ソース | EnablePaneReadOnly アクションの登録 |
