# 機能設計書 56-PopStyleColor

## 概要

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

### 本機能の処理概要

PopStyleColor関数は、カラースタックから指定された数だけカラー設定を復元する。デフォルトでは1つの設定を復元するが、countパラメータで複数の設定を一度に復元できる。

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

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

**主要な処理内容**：
1. カラースタックのアンダーフローチェック
2. 指定された数だけスタックから状態を取得して復元
3. スタックからポップ

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 6 | Style Editor | 補助機能 | カラー編集後の復元 |

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiContext.ColorStack（カラースタック）

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiContext.Style.Colors（スタイルカラー配列 - 復元）
- ImGuiContext.ColorStack（カラースタック - n要素削除）

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ グローバルコンテキストGImGuiを参照
2. スタックアンダーフローチェック
   └─ ColorStack.Size < countの場合、警告を出しcountを調整
3. countの数だけループ処理
   └─ スタック末尾からバックアップを取得
   └─ Colors[backup.Col] = backup.BackupValueで復元
   └─ スタックからポップ
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{ColorStack.Size < count?}
    B -->|Yes| C[警告: PopStyleColor too many times]
    C --> D[count = ColorStack.Size]
    B -->|No| E[ループ開始]
    D --> E
    E --> F{count > 0?}
    F -->|Yes| G[backup = ColorStack.back]
    G --> H[Colors backup.Col = BackupValue]
    H --> I[ColorStack.pop_back]
    I --> J[count--]
    J --> F
    F -->|No| K[終了]
```

## ビジネスルール

### 業務ルール

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

### 計算ロジック

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

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

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

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

## 備考

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

---

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

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

### 推奨読解順序

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

カラー管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiColorMod構造体（915-919行目） |

**読解のコツ**: ImGuiColorModのCol（対象インデックス）とBackupValue（復元値）がPopStyleColorで使用される。

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

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

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

**主要処理フロー**:
1. **3580-3585行目**: スタックアンダーフローチェックとcount調整
2. **3586行目**: whileループ開始
3. **3588行目**: スタック末尾のバックアップ取得
4. **3589行目**: Colors[backup.Col]に復元値を設定
5. **3590行目**: スタックからポップ
6. **3591行目**: countデクリメント

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

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

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

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

```
ImGui::PopStyleColor(int count)
    │
    ├─ IM_ASSERT_USER_ERROR(...)   // スタックチェック
    │
    └─ while (count > 0)
           │
           ├─ g.ColorStack.back()       // バックアップ取得
           │
           ├─ g.Style.Colors[Col] = BackupValue  // 復元
           │
           └─ g.ColorStack.pop_back()   // ポップ
```

### データフロー図

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

int count         ───▶ ループ回数の決定            ───▶ 制御フロー
                              │
ColorStack        ───▶ バックアップ取得            ───▶ 復元データ
                              │
backup.BackupValue───▶ Colors[backup.Col]に設定    ───▶ Style.Colors[]
                              │
ColorStack        ───▶ pop_back()                 ───▶ ColorStack（縮小）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PopStyleColor関数の宣言（530行目） |
| imgui.cpp | `imgui.cpp` | ソース | PopStyleColor関数の実装（3578-3593行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiColorMod構造体（915-919行目） |
