# 機能設計書 52-PopFont

## 概要

本ドキュメントは、ImGuiライブラリのPopFont関数の設計仕様を定義する。PopFontはフォントスタックから以前の状態を復元し、PushFontで変更したフォント設定を元に戻すための機能である。

### 本機能の処理概要

PopFont関数は、フォントスタックから以前のフォント状態を取り出し、現在のフォント設定を復元する。PushFontとペアで使用することで、スコープベースのフォント管理を実現する。

**業務上の目的・背景**：GUIアプリケーションでは、特定のUI領域だけ異なるフォントを使用した後、元のフォントに戻す必要がある。スタックベースの管理により、ネストされたフォント変更を正しく復元でき、コードの可読性と保守性が向上する。PushFont/PopFontのペアリングにより、フォント状態の一貫性が保証される。

**機能の利用シーン**：
- PushFontで変更したフォント設定を元に戻す場合
- スコープを抜ける際にフォント状態を復元する場合
- 複数のネストされたフォント変更を順序正しく解除する場合

**主要な処理内容**：
1. フォントスタックのアンダーフローチェック
2. スタックから以前のフォント状態を取得
3. SetCurrentFont関数で以前のフォント状態を復元
4. スタックから状態をポップ

**関連システム・外部連携**：PushFont関数と連携し、スタックベースのフォント管理を実現する。

**権限による制御**：特になし。すべてのコンテキストで利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 8 | Font Atlas | 主機能 | フォントのポップ |

## 機能種別

スタック操作 / スタイル変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | パラメータなし | - |

### 入力データソース

- ImGuiContext.FontStack（フォントスタック）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | void | 戻り値なし |

### 出力先

- ImGuiContext.Font（現在のフォント）
- ImGuiContext.FontSizeBase（スケーリング前のフォントサイズ）
- ImGuiContext.FontSize（スケーリング後のフォントサイズ）
- ImGuiContext.FontStack（フォントスタック - 1要素削除）

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ グローバルコンテキストGImGuiを参照
2. スタックアンダーフローチェック
   └─ FontStack.Size > 0 であることを確認
3. スタックの末尾から状態を取得
   └─ Font, FontSizeBeforeScaling, FontSizeAfterScalingを取得
4. 以前のフォント状態を復元
   └─ SetCurrentFont関数で復元
5. スタックからポップ
   └─ FontStack.pop_back()
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{FontStack.Size > 0?}
    B -->|No| C[アサーションエラー]
    B -->|Yes| D[スタック末尾から状態取得]
    C --> E[終了]
    D --> F[SetCurrentFontで状態復元]
    F --> G[FontStack.pop_back]
    G --> E
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-52-01 | Push/Popペアリング | PopFontは対応するPushFontの後にのみ呼び出す | 常時 |
| BR-52-02 | スタック非空 | PopFont呼び出し時にフォントスタックが空でないこと | 常時 |
| BR-52-03 | 順序保持 | 複数のPushFontに対してはLIFO順でPopFontを呼び出す | ネスト使用時 |

### 計算ロジック

特になし。スタックからの状態復元のみ。

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

該当なし（メモリ内操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT_USER_ERROR | アサーション | FontStack.Size == 0 | PushFontとPopFontのペアリングを確認 |

### リトライ仕様

該当なし

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

該当なし（メモリ内操作のみ）

## パフォーマンス要件

- スタック操作のため、O(1)の時間計算量
- フレームごとに複数回呼び出されることを想定した軽量実装

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

- スタックアンダーフローによるメモリ破壊を防止するためのアサーション

## 備考

- PushFontと同数だけ呼び出す必要がある
- フレーム終了時にスタックが空でない場合、警告が出る可能性がある

---

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

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

### 推奨読解順序

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

フォントスタックの管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImFontStackData構造体の定義（895-900行目） |

**読解のコツ**: ImFontStackDataの3つのメンバがPopFont時にどのように使用されるかを理解する。

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

PopFont関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | PopFont関数の実装（9089-9096行目） |

**主要処理フロー**:
1. **9091行目**: グローバルコンテキストの取得
2. **9092行目**: スタックアンダーフローチェック（IM_ASSERT_USER_ERROR_RET）
3. **9093行目**: スタック末尾の参照取得
4. **9094行目**: SetCurrentFontで状態復元
5. **9095行目**: スタックからポップ

#### Step 3: 関連関数を理解する

PushFont関数との関係を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | PushFont関数の実装（9075-9087行目） |

**主要処理フロー**:
- PushFontで保存される状態がPopFontで正しく復元されることを確認

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

```
ImGui::PopFont()
    │
    ├─ IM_ASSERT_USER_ERROR_RET(...)  // スタックチェック
    │
    ├─ g.FontStack.back()              // 状態取得
    │
    ├─ SetCurrentFont(...)             // 状態復元
    │
    └─ g.FontStack.pop_back()          // スタックポップ
```

### データフロー図

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

g.FontStack.back() ───▶ SetCurrentFont呼び出し    ───▶ g.Font
                             │                            g.FontSizeBase
                             │                            g.FontSize
                             ▼
                       pop_back()             ───▶ g.FontStack（1要素削除）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PopFont関数の宣言（522行目） |
| imgui.cpp | `imgui.cpp` | ソース | PopFont関数の実装（9089-9096行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImFontStackData構造体の定義（895-900行目） |
