# 機能設計書 82-PopID

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるPopID関数の機能設計を定義する。PopIDは、PushIDでプッシュされたIDをIDスタックからポップする機能である。

### 本機能の処理概要

PopID関数は、ImGuiのIDスタックシステムにおいて、以前PushIDでプッシュされたIDをスタックからポップし、IDスコープを終了する機能を提供する。

**業務上の目的・背景**：PushIDで開始されたIDスコープを正しく終了するために必要な関数である。PushIDとPopIDは必ずペアで使用される必要があり、この対応関係を守ることでIDスタックの整合性が保たれる。フレーム終了時にIDスタックが正しい状態（ウィンドウIDのみがスタックに存在）に戻ることが期待される。

**機能の利用シーン**：
- PushIDで開始したIDスコープを終了する場合
- ループ内で動的に生成したウィジェット群のスコープを閉じる場合
- 階層的なUIコンポーネントのネストを終了する場合
- カスタムウィジェット実装でIDスコープ管理を行う場合

**主要な処理内容**：
1. 現在のウィンドウコンテキストを取得
2. IDスタックのサイズを検証（最低1つは残す必要がある）
3. IDスタックから最後の要素をポップ

**関連システム・外部連携**：ImGuiコンテキスト（GImGui）、ImGuiWindow構造体のIDStack

**権限による制御**：なし。すべてのImGuiユーザーが利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全ウィジェット | 補助機能 | ウィジェットID生成の基盤機能として使用 |

## 機能種別

ユーティリティ機能 / IDスタック操作

## 入力仕様

### 入力パラメータ

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

### 入力データソース

なし（現在のIDスタック状態のみを参照）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (なし) | void | 戻り値なし。IDスタックが更新される |

### 出力先

ImGuiWindow::IDStack（内部データ構造）

## 処理フロー

### 処理シーケンス

```
1. 現在のウィンドウの取得
   └─ GImGui->CurrentWindowから現在のウィンドウを参照
2. IDスタックサイズの検証
   └─ IDStack.Size > 1 であることを確認（アサーション）
3. IDスタックからのポップ
   └─ window->IDStack.pop_back()で最後の要素を削除
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GImGuiからCurrentWindowを取得]
    B --> C{IDStack.Size > 1?}
    C -->|Yes| D[IDStack.pop_back]
    C -->|No| E[アサーションエラー]
    D --> F[終了]
    E --> F
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Push/Popペアリング | PopIDは対応するPushIDの後に呼び出す必要がある | 常時 |
| BR-02 | スタック最小サイズ | IDスタックには常に最低1つの要素（ウィンドウID）が必要 | 常時 |
| BR-03 | 呼び出し回数制限 | PopIDはPushIDより多く呼び出してはならない | 常時 |

### 計算ロジック

特になし。単純なスタックポップ操作。

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション | IDStack.Size <= 1 の状態でPopIDを呼び出した場合 | デバッグビルドでアサーション発生、メッセージ："Calling PopID() too many times!" |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- O(1)の時間計算量でスタック操作を実行
- メモリの再割り当ては発生しない（pop操作のみ）

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

特になし。内部メモリ操作のみで外部との通信なし。

## 備考

- PushIDと必ずペアで使用すること
- フレーム終了時にPush/Popの回数が一致していない場合、次フレームで問題が発生する可能性がある
- IM_ASSERT_USER_ERROR_RETマクロにより、リリースビルドでもエラー時は早期リターンする

---

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

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

### 推奨読解順序

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

PushIDと同様にIDStackの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow構造体のIDStackメンバ（2708行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiID型定義（160行目） |

**読解のコツ**: IDStackはImVector<ImGuiID>型であり、push_back/pop_back操作が可能な動的配列である。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | PopID関数宣言（607行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | PopID関数実装（9229-9234行目） |

**主要処理フロー**:
1. **9231行目**: `GImGui->CurrentWindow`から現在のウィンドウを取得
2. **9232行目**: `IM_ASSERT_USER_ERROR_RET`でスタックサイズを検証。Size <= 1 の場合エラー
3. **9233行目**: `IDStack.pop_back()`でスタックから最後の要素を削除

#### Step 3: エラー処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | IM_ASSERT_USER_ERROR_RETマクロの使用（9232行目） |

**主要処理フロー**:
- **IM_ASSERT_USER_ERROR_RET**: 条件が偽の場合、アサーションを発生させ、さらに関数から早期リターンする

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

```
ImGui::PopID()
    │
    ├─ GImGui->CurrentWindow（ウィンドウ参照）
    │
    ├─ IM_ASSERT_USER_ERROR_RET（検証）
    │      └─ IDStack.Size > 1 の確認
    │
    └─ window->IDStack.pop_back()
```

### データフロー図

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

(なし)          ───▶ IDStack.pop_back() ───▶ IDStack更新
                              │
                              └── IDStack.Size検証
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PopID関数の宣言（607行目） |
| imgui.cpp | `imgui.cpp` | ソース | PopID関数の実装（9229-9234行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiWindow構造体、IDStack定義 |
