# 機能設計書 49-先頭にスクロール

## 概要

本ドキュメントは、Windows Terminal における「先頭にスクロール（ScrollToTop）」機能の設計を記述する。ターミナルバッファのビューポートをバッファの先頭（最も古い出力位置）まで一気にスクロールする機能である。

### 本機能の処理概要

ユーザーの操作（キーバインド）に応じて、ターミナルのビューポートをバッファの先頭位置まで一気に移動する。_ScrollToBufferEdge関数を使用し、INT_MAX行分のスクロールデルタを上方向に適用することで、バッファの先頭に到達させる。

**業務上の目的・背景**：長時間のターミナルセッションでは、スクロールバックバッファに大量のテキストが蓄積される。コマンド実行の最初の出力や、セッション開始時の情報を確認するために、バッファの先頭に素早く移動する機能は重要である。ページスクロールを何度も繰り返す必要がなく、ワンアクションで先頭に到達できる。

**機能の利用シーン**：
- セッション開始時のメッセージやログを確認する場合
- 長いスクロールバックの最初の出力を確認する場合
- バッファ内の最も古い情報に素早くアクセスする場合
- Ctrl+Homeに相当する操作を実行する場合

**主要な処理内容**：
1. ScrollToTopアクションを受け付ける（引数なし）
2. _ScrollToBufferEdge(ScrollUp)を呼び出す
3. INT_MAX行分のスクロールデルタ（負値）を計算する
4. Tab::Scrollでビューポートを移動する（ClampAddにより先頭で停止）

**関連システム・外部連携**：なし。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | TerminalPage（メイン画面） | 主画面 | _HandleScrollToTopによりバッファ先頭へスクロール |

## 機能種別

ビューポート操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| （なし） | - | - | ScrollToTopアクションには引数がない | - |

### 入力データソース

- キーバインド設定からのScrollToTopアクション

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| スクロール位置 | int | ビューポートの新しいスクロール位置（バッファ先頭） |

### 出力先

TermControlのスクロールバーおよびビューポート位置の更新。

## 処理フロー

### 処理シーケンス

```
1. ユーザーがScrollToTopアクションを実行
   └─ _HandleScrollToTop (AppActionHandlers.cpp) が呼ばれる
2. _ScrollToBufferEdge(ScrollUp)を呼び出し
   └─ フォーカスされたタブを取得
3. スクロールデルタを計算
   └─ _ComputeScrollDelta(ScrollUp, INT_MAX) → -INT_MAX
4. タブのScrollを実行
   └─ Tab::Scroll(scrollDelta)
5. ClampAddにより先頭位置でクランプ
   └─ base::ClampAdd(currentOffset, -INT_MAX) → バッファ先頭
```

### フローチャート

```mermaid
flowchart TD
    A[ScrollToTopアクション発火] --> B[_ScrollToBufferEdge呼び出し]
    B --> C{フォーカスタブ存在?}
    C -->|No| D[何もしない]
    C -->|Yes| E[_ComputeScrollDelta]
    E --> F[Tab::Scroll実行]
    F --> G[base::ClampAddで先頭にクランプ]
    G --> H[ScrollViewport更新]
    H --> I[終了]
    D --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-49-01 | 最大デルタ | INT_MAX行分のデルタを使用することでバッファの端に到達する | 常時 |
| BR-49-02 | クランプ | base::ClampAddによりオーバーフローが防止され、バッファ先頭で停止する | 常時 |
| BR-49-03 | 方向 | ScrollUp方向でINT_MAXを使用するため、デルタは-INT_MAX | 常時 |

### 計算ロジック

- デルタ計算: `scrollDelta = _ComputeScrollDelta(ScrollUp, INT_MAX) = -1 * INT_MAX = -INT_MAX`
- 新位置: `base::ClampAdd(currentOffset, -INT_MAX)` → バッファ先頭（0またはバッファ最小位置）

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

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

本機能ではデータベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 無操作 | フォーカスされたタブが存在しない | 何も起こらずに終了 |

### リトライ仕様

リトライは不要。

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

なし。

## パフォーマンス要件

即時応答。デルタの計算は定数演算であり、ScrollViewportの呼び出しも即時。

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

特になし。

## 備考

- _ScrollToBufferEdgeはScrollToTop（No.49）とScrollToBottom（No.50）で共有される関数である。
- INT_MAXを使用することで、バッファサイズに関係なく常に端まで到達する設計となっている。

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | _HandleScrollToTop関数（367-372行目）- 引数なし、_ScrollToBufferEdge(ScrollUp)を呼び出す |

**主要処理フロー**:
1. **370行目**: _ScrollToBufferEdge(ScrollUp) を呼び出し

#### Step 2: _ScrollToBufferEdge関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | _ScrollToBufferEdge関数（2817-2824行目）- INT_MAXをrowsToScrollとして使用 |

**主要処理フロー**:
- **2819行目**: フォーカスされたタブを取得
- **2821行目**: _ComputeScrollDelta(scrollDirection, INT_MAX)でデルタ算出
- **2822行目**: Tab::Scroll(scrollDelta)で実行

**読解のコツ**: INT_MAXを行数として使用する設計は、具体的なバッファサイズを知らなくても確実にバッファの端に到達できるエレガントなアプローチである。base::ClampAddがオーバーフローを防止する。

#### Step 3: 共通処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | _ComputeScrollDelta関数（4397-4400行目） |
| 3-2 | Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | Tab::Scroll関数（513-520行目） |
| 3-3 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ScrollViewport関数（2669-2672行目） |

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

```
TerminalPage::_HandleScrollToTop (AppActionHandlers.cpp:367)
    └─ TerminalPage::_ScrollToBufferEdge(ScrollUp) (TerminalPage.cpp:2817)
           ├─ _GetFocusedTabImpl() → タブ取得
           ├─ _ComputeScrollDelta(ScrollUp, INT_MAX) → -INT_MAX
           └─ Tab::Scroll (Tab.cpp:513)
                  ├─ base::ClampAdd(currentOffset, -INT_MAX) → 先頭位置
                  └─ TermControl::ScrollViewport (TermControl.cpp:2669)
```

### データフロー図

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

ScrollToTopアクション   →  _HandleScrollToTop           →  スクロール位置更新
  (引数なし)                └─ _ScrollToBufferEdge(ScrollUp)  （バッファ先頭へ）
                                 ├─ _ComputeScrollDelta
                                 │   (ScrollUp, INT_MAX)
                                 │   → -INT_MAX
                                 └─ Tab::Scroll
                                      └─ ClampAdd → 先頭で停止
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleScrollToTopアクションハンドラー |
| TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | ソース | _ScrollToBufferEdge関数 |
| Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | ソース | Tab::Scroll関数 |
| TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ソース | ScrollViewport |
| AllShortcutActions.h | `src/cascadia/TerminalSettingsModel/AllShortcutActions.h` | ヘッダー | ScrollToTopアクション登録 |
