# 機能設計書 60-PopItemFlag

## 概要

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

### 本機能の処理概要

PopItemFlag関数は、アイテムフラグスタックから以前のフラグ状態を取り出し、現在のアイテムフラグを復元する。PushItemFlagとペアで使用することで、スコープベースのフラグ管理を実現する。

**業務上の目的・背景**：GUIアプリケーションでは、PushItemFlagで一時的に変更したフラグ設定を元に戻す必要がある。スタックベースの管理により、ネストされたフラグ変更を正しく復元でき、コードの可読性と保守性が向上する。フラグの状態管理を自動化することで、プログラマの負担を軽減する。

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

**主要な処理内容**：
1. アイテムフラグスタックのアンダーフローチェック
2. スタックからポップ
3. スタック末尾の値で現在のフラグを更新

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | すべての画面 | 補助機能 | アイテムフラグの復元 |

## 機能種別

スタック操作 / 動作フラグ変更

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- ImGuiContext.ItemFlagsStack（アイテムフラグスタック）

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiContext.CurrentItemFlags（現在のアイテムフラグ - 復元）
- ImGuiContext.ItemFlagsStack（アイテムフラグスタック - 1要素削除）

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ グローバルコンテキストGImGuiを参照
2. スタックアンダーフローチェック
   └─ ItemFlagsStack.Size > 1 であることを確認（最低1要素は保持）
3. スタックからポップ
   └─ ItemFlagsStack.pop_back()
4. 現在のフラグを更新
   └─ g.CurrentItemFlags = g.ItemFlagsStack.back()
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{ItemFlagsStack.Size > 1?}
    B -->|No| C[アサーションエラー: PopItemFlag too many times]
    B -->|Yes| D[ItemFlagsStack.pop_back]
    C --> E[終了]
    D --> F[CurrentItemFlags = ItemFlagsStack.back]
    F --> E
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-60-01 | Push/Popペアリング | PopItemFlagは対応するPushItemFlagの後にのみ呼び出す | 常時 |
| BR-60-02 | スタック非空 | PopItemFlag呼び出し時にアイテムフラグスタックが2要素以上あること | 常時 |
| BR-60-03 | 順序保持 | 複数のPushItemFlagに対してはLIFO順でPopItemFlagを呼び出す | ネスト使用時 |
| BR-60-04 | 最低1要素保持 | スタックは常に最低1要素（初期状態）を保持する | 常時 |

### 計算ロジック

特になし。スタックからのポップと値の復元のみ。

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT_USER_ERROR | アサーション | ItemFlagsStack.Size <= 1 | PushItemFlagとPopItemFlagのペアリングを確認 |

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

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

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

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

## 備考

- PushItemFlagと同数だけ呼び出す必要がある
- スタックの最初の要素は初期状態を保持しており、ポップしてはならない
- フレーム終了時にスタックが初期状態でない場合、警告が出る可能性がある

---

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

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

### 推奨読解順序

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

アイテムフラグ管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiItemFlags_列挙型（1233-1243行目） |

**読解のコツ**: ItemFlagsStackは常に最低1要素を保持し、初期フラグ状態を維持している。

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

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

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

**主要処理フロー**:
1. **8220行目**: グローバルコンテキストの取得
2. **8221行目**: スタックアンダーフローチェック（Size > 1）
3. **8222行目**: スタックからポップ
4. **8223行目**: CurrentItemFlagsをスタック末尾の値で更新

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

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

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

**主要処理フロー**:
- PushItemFlagで追加される状態がPopItemFlagで正しく復元されることを確認

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

```
ImGui::PopItemFlag()
    │
    ├─ IM_ASSERT_USER_ERROR_RET(...)  // スタックチェック (Size > 1)
    │
    ├─ g.ItemFlagsStack.pop_back()     // スタックポップ
    │
    └─ g.CurrentItemFlags = g.ItemFlagsStack.back()  // フラグ復元
```

### データフロー図

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

ItemFlagsStack    ───▶ pop_back()              ───▶ ItemFlagsStack（縮小）
                              │
ItemFlagsStack.back()───▶ CurrentItemFlags設定 ───▶ CurrentItemFlags
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PopItemFlag関数の宣言（537行目） |
| imgui.cpp | `imgui.cpp` | ソース | PopItemFlag関数の実装（8218-8224行目） |
| imgui.h | `imgui.h` | ヘッダー | ImGuiItemFlags_列挙型（1233-1243行目） |
