# 機能設計書 77-バッファのクリア

## 概要

本ドキュメントは、Windows Terminalにおけるバッファクリア機能の設計を記述する。ターミナルの画面バッファまたはスクロールバックバッファをクリアする機能である。

### 本機能の処理概要

ClearBufferアクションは、ターミナルバッファの内容をクリアする機能である。クリアの対象として、画面（Screen）、スクロールバック（Scrollback）、またはその両方（All）を選択できる。

**業務上の目的・背景**：ターミナルの画面を整理し、視認性を向上させたい場合に利用する。大量の出力後に画面をリセットしたい場合や、スクロールバックバッファが肥大化してメモリを消費している場合にクリアを行う。`clear`コマンドとは異なり、スクロールバックバッファも含めたクリアが可能。

**機能の利用シーン**：大量のログ出力後に画面を整理する場合、プレゼンテーション前にターミナルをクリーンにする場合、メモリ使用量を削減する場合に利用される。

**主要な処理内容**：
1. ClearBufferアクションの受信とクリア対象の判定
2. アクティブなすべてのコントロールに対するクリア操作の適用
3. ConPTY接続経由でのバッファクリア実行

**関連システム・外部連携**：ConPTY接続、TerminalCore のバッファ管理との連携。

**権限による制御**：特になし。すべてのユーザーが利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | TerminalPage（メイン画面） | 主画面 | _HandleClearBufferによりバッファをクリア |

## 機能種別

データ操作 / バッファ管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Clear | ClearBufferType | No | クリア対象（Screen/Scrollback/All） | 列挙型の範囲内であること |

### 入力データソース

キーバインドまたはコマンドパレットからのアクション発行。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | - | バッファの内容がクリアされる（副作用） |

### 出力先

ターミナルバッファ（画面バッファおよび/またはスクロールバックバッファ）

## 処理フロー

### 処理シーケンス

```
1. ClearBufferアクション受信
   └─ _HandleClearBufferハンドラが呼び出される
2. ClearBufferArgs の取得
   └─ Clear パラメータ（クリア対象）の判定
3. _ApplyToActiveControls の呼び出し
   └─ アクティブな全コントロールに対してクリア操作を適用
4. TermControl.ClearBuffer(clearType) の呼び出し
   └─ 各コントロールのバッファをクリア
5. ConPTY接続のClearBuffer
   └─ ConptyConnection::ClearBuffer でバッファをクリア
```

### フローチャート

```mermaid
flowchart TD
    A[ClearBufferアクション受信] --> B[_HandleClearBuffer]
    B --> C{ClearBufferArgs取得成功?}
    C -->|Yes| D[Clear タイプ取得]
    C -->|No| E[処理終了]
    D --> F[_ApplyToActiveControls]
    F --> G[TermControl.ClearBuffer]
    G --> H{Clear タイプ}
    H -->|Screen| I[画面バッファクリア]
    H -->|Scrollback| J[スクロールバックバッファクリア]
    H -->|All| K[両方クリア]
    I --> L[処理完了]
    J --> L
    K --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-77-01 | クリア対象選択 | Screen/Scrollback/All の3種類から選択 | ClearBufferArgs.Clear パラメータ |
| BR-77-02 | 全コントロール適用 | ブロードキャストモード時は全アクティブコントロールに適用 | _ApplyToActiveControls使用 |
| BR-77-03 | カーソル行保持 | ClearBufferでカーソル行を保持するかどうかをオプションで制御 | ConptyConnection::ClearBuffer(keepCursorRow) |

### 計算ロジック

特になし。

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

### 操作別データベース影響一覧

本機能にデータベース操作はない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Args取得失敗 | ClearBufferArgsへのキャスト失敗 | ハンドラ内で何もせずリターン |
| - | コントロールなし | アクティブコントロールが存在しない場合 | _ApplyToActiveControlsがfalseを返す |

### リトライ仕様

リトライは不要。

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

本機能にトランザクション処理はない。

## パフォーマンス要件

バッファクリア操作は即座に完了すること。大容量スクロールバックバッファのクリアでもUIの応答性を維持する。

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

特になし。

## 備考

- `clear`コマンドは画面のみクリアするが、ClearBufferアクションはスクロールバックバッファもクリア可能
- ConptyConnection::ClearBuffer(keepCursorRow) パラメータで、カーソル行の保持を制御

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ActionArgs.h | `src/cascadia/TerminalSettingsModel/ActionArgs.h` | ClearBufferArgs のClearプロパティ |
| 1-2 | ActionArgs.idl | `src/cascadia/TerminalSettingsModel/ActionArgs.idl` | ClearBufferType列挙型（Screen/Scrollback/All） |

**読解のコツ**: ClearBufferType は列挙型で、TerminalSettingsSerializationHelpers.h にJSON名とのマッピングが定義されている。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | _HandleClearBuffer（1224-1235行目） |

**主要処理フロー**:
1. **1224行目**: _HandleClearBufferハンドラ定義
2. **1229行目**: ClearBufferArgsへのキャスト
3. **1231行目**: _ApplyToActiveControlsで全コントロールに適用
4. **1232行目**: control.ClearBuffer(realArgs.Clear()) 呼び出し

#### Step 3: 接続層でのクリア処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ConptyConnection.h | `src/cascadia/TerminalConnection/ConptyConnection.h` | ClearBuffer(bool keepCursorRow) メソッド宣言（28行目） |
| 3-2 | ConptyConnection.cpp | `src/cascadia/TerminalConnection/ConptyConnection.cpp` | ClearBuffer実装 |

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

```
TerminalPage::_HandleClearBuffer (AppActionHandlers.cpp:1224)
    │
    └─ _ApplyToActiveControls([&](auto& control) { ... })
           │
           └─ TermControl::ClearBuffer(clearType)
                  │
                  └─ ControlCore::ClearBuffer(clearType)
                         │
                         └─ ConptyConnection::ClearBuffer(keepCursorRow)
```

### データフロー図

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

ClearBufferArgs ──────▶ _HandleClearBuffer
(Clear: Screen/          │
 Scrollback/All)         ▼
                   _ApplyToActiveControls
                         │
                         ▼
                   TermControl.ClearBuffer ──▶ バッファクリア
                         │                    (画面/スクロールバック)
                         ▼
                   ConptyConnection.ClearBuffer
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | ClearBufferアクションハンドラ |
| ConptyConnection.h | `src/cascadia/TerminalConnection/ConptyConnection.h` | ヘッダー | ClearBuffer宣言 |
| ConptyConnection.cpp | `src/cascadia/TerminalConnection/ConptyConnection.cpp` | ソース | ClearBuffer実装 |
| ActionArgs.h | `src/cascadia/TerminalSettingsModel/ActionArgs.h` | ヘッダー | ClearBufferArgs定義 |
| ActionArgs.idl | `src/cascadia/TerminalSettingsModel/ActionArgs.idl` | IDL | ClearBufferType列挙型定義 |
