# 機能設計書 58-PopStyleVar

## 概要

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

### 本機能の処理概要

PopStyleVar関数は、スタイル変数スタックから指定された数だけスタイル設定を復元する。デフォルトでは1つの設定を復元するが、countパラメータで複数の設定を一度に復元できる。変数の型（float/ImVec2）を自動判別して適切に復元する。

**業務上の目的・背景**：GUIアプリケーションでは、PushStyleVarで一時的に変更したスタイル設定を元に戻す必要がある。スタックベースの管理により、ネストされたスタイル変更を正しく復元でき、コードの可読性と保守性が向上する。複数のPushStyleVarを一度のPopStyleVar呼び出しで復元できることで、コードが簡潔になる。

**機能の利用シーン**：
- PushStyleVarで変更したスタイル設定を元に戻す場合
- スコープを抜ける際にすべてのスタイル変更を復元する場合
- 複数のスタイル変更を一括で復元する場合

**主要な処理内容**：
1. スタイル変数スタックのアンダーフローチェック
2. 指定された数だけスタックから状態を取得
3. 変数の型を判別して適切に復元
4. スタックからポップ

**関連システム・外部連携**：PushStyleVar関数と連携し、スタックベースのスタイル管理を実現する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 6 | Style Editor | 補助機能 | スタイル調整後の復元 |

## 機能種別

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| count | int | No | 復元するスタイル設定の数（デフォルト: 1） | count >= 0, count <= StyleVarStack.Size |

### 入力データソース

- ImGuiContext.StyleVarStack（スタイル変数スタック）

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiStyle内の対応する変数（復元）
- ImGuiContext.StyleVarStack（スタイル変数スタック - n要素削除）

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ グローバルコンテキストGImGuiを参照
2. スタックアンダーフローチェック
   └─ StyleVarStack.Size < countの場合、警告を出しcountを調整
3. countの数だけループ処理
   └─ スタック末尾からバックアップを取得
   └─ GetStyleVarInfoで変数情報を取得
   └─ 変数の型に応じて復元（float[1]またはfloat[2]）
   └─ スタックからポップ
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{StyleVarStack.Size < count?}
    B -->|Yes| C[警告: PopStyleVar too many times]
    C --> D[count = StyleVarStack.Size]
    B -->|No| E[ループ開始]
    D --> E
    E --> F{count > 0?}
    F -->|Yes| G[backup = StyleVarStack.back]
    G --> H[var_info = GetStyleVarInfo]
    H --> I{Count == 1?}
    I -->|Yes| J[float復元]
    I -->|No| K[ImVec2復元]
    J --> L[StyleVarStack.pop_back]
    K --> L
    L --> M[count--]
    M --> F
    F -->|No| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-58-01 | Push/Popペアリング | PopStyleVarは対応するPushStyleVarの後にのみ呼び出す | 常時 |
| BR-58-02 | スタック非空 | PopStyleVar呼び出し時にスタイル変数スタックが十分な要素を持つこと | 常時 |
| BR-58-03 | 順序保持 | 複数のPushStyleVarに対してはLIFO順で復元される | ネスト使用時 |
| BR-58-04 | 一括復元 | count指定により複数の変更を一度に復元可能 | count > 1 |
| BR-58-05 | 自動型判別 | 変数の型（float/ImVec2）を自動判別して復元 | 常時 |

### 計算ロジック

型判別と復元ロジック：
```
if (var_info->Count == 1) {
    // float変数の復元
    ((float*)data)[0] = backup.BackupFloat[0];
} else {
    // ImVec2変数の復元
    ((float*)data)[0] = backup.BackupFloat[0];
    ((float*)data)[1] = backup.BackupFloat[1];
}
```

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT_USER_ERROR | 警告 | StyleVarStack.Size < count | PushStyleVarとPopStyleVarのペアリングを確認 |

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

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

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

- スタックアンダーフローによるメモリ破壊を防止するためのガード処理

## 備考

- PushStyleVarと同数だけ呼び出す必要がある（合計count数）
- PushStyleVarX/YはPushStyleVar(ImVec2)と同じ復元処理
- フレーム終了時にスタックが空でない場合、警告が出る可能性がある

---

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

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

### 推奨読解順序

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

スタイル変数管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiStyleMod構造体（922-929行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiStyleVarInfo構造体（906-912行目） |

**読解のコツ**: ImGuiStyleModのBackupFloat[2]は、float変数では[0]のみ、ImVec2変数では[0][1]両方を使用する。

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

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

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

**主要処理フロー**:
1. **3688-3693行目**: スタックアンダーフローチェックとcount調整
2. **3694行目**: whileループ開始
3. **3697行目**: スタック末尾のバックアップ取得
4. **3698行目**: GetStyleVarInfoで変数情報取得
5. **3699行目**: GetVarPtrで変数アドレス取得
6. **3700-3701行目**: 型に応じた復元処理
7. **3702行目**: スタックからポップ

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | PushStyleVar実装（3646-3684行目） |

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

```
ImGui::PopStyleVar(int count)
    │
    ├─ IM_ASSERT_USER_ERROR(...)     // スタックチェック
    │
    └─ while (count > 0)
           │
           ├─ g.StyleVarStack.back()    // バックアップ取得
           │
           ├─ GetStyleVarInfo(VarIdx)   // 変数情報取得
           │
           ├─ var_info->GetVarPtr()     // アドレス取得
           │
           ├─ 型判別して復元            // float or ImVec2
           │
           └─ g.StyleVarStack.pop_back() // ポップ
```

### データフロー図

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

int count         ───▶ ループ回数の決定            ───▶ 制御フロー
                              │
StyleVarStack     ───▶ バックアップ取得            ───▶ 復元データ
                              │
backup.VarIdx     ───▶ GetStyleVarInfo            ───▶ 変数情報
                              │
var_info          ───▶ GetVarPtr                  ───▶ 変数アドレス
                              │
BackupFloat[]     ───▶ 型判別・復元               ───▶ Style内変数
                              │
StyleVarStack     ───▶ pop_back()                 ───▶ StyleVarStack（縮小）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PopStyleVar関数の宣言（535行目） |
| imgui.cpp | `imgui.cpp` | ソース | PopStyleVar関数の実装（3686-3705行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiStyleMod/ImGuiStyleVarInfo構造体（906-929行目） |
