# 通知設計書 8-EndPopup

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるEndPopup API関数の設計・動作仕様を記載したものである。EndPopupはBeginPopup()/BeginPopupModal()/BeginPopupContextXXX()で開始されたポップアップウィンドウを終了するためのAPI関数である。

### 本通知の処理概要

EndPopupは、BeginPopupXXX()関数で開始されたポップアップウィンドウを終了し、内部的にEnd()を呼び出してウィンドウスタックをポップする。さらに、BeginPopupStackからポップアップ参照を削除する。

**業務上の目的・背景**：ポップアップウィンドウのライフサイクル管理において、開始と終了のペアリングは重要である。EndPopupは、BeginPopupXXX()で開始されたウィンドウコンテキストを適切に終了し、ポップアップスタックの整合性を保つ。Begin/Endパターンを遵守することで、ウィンドウスタックとポップアップスタックの破損を防止する。

**通知の送信タイミング**：BeginPopupXXX()がtrueを返した後、ポップアップ内のコンテンツ描画が完了したタイミングで呼び出される。必ずBeginPopupXXX()とペアで呼び出す必要がある。

**通知の受信者**：Dear ImGuiの内部ウィンドウ管理システムとポップアップスタック管理システム。EndPopupの呼び出しにより、現在のウィンドウコンテキストが終了し、BeginPopupStackからポップアップがポップされる。

**通知内容の概要**：ポップアップウィンドウの終了通知。内部的にEnd()関数を呼び出し、ウィンドウのレンダリング処理を完了させ、ポップアップスタックを更新する。

**期待されるアクション**：ImGuiウィンドウシステムは、現在のポップアップウィンドウを終了し、親ウィンドウコンテキストに復帰する。ポップアップスタックが適切に更新される。

## 通知種別

UI内部通知（ImGuiウィンドウシステム内での状態変更通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無 |

### 送信先決定ロジック

EndPopupの呼び出しは、グローバルImGuiコンテキスト（GImGui）の現在のポップアップウィンドウに対して行われる。送信先は固定で、BeginPopupStackのトップにあるポップアップである。

## 通知テンプレート

### API関数シグネチャ

| 項目 | 内容 |
|-----|------|
| 関数名 | EndPopup |
| 戻り値 | void |
| 引数 | なし |
| 定義場所 | imgui.h:847 |

### 本文テンプレート

```cpp
// BeginPopup()がtrueを返した場合のみ呼び出す
if (ImGui::BeginPopup("my_popup"))
{
    ImGui::Text("ポップアップの内容");
    ImGui::EndPopup();  // 必須
}

// BeginPopupModal()の場合も同様
if (ImGui::BeginPopupModal("確認"))
{
    ImGui::Text("モーダルダイアログ");
    ImGui::EndPopup();  // 必須
}

// BeginPopupContextItem()の場合も同様
if (ImGui::BeginPopupContextItem())
{
    ImGui::MenuItem("アイテム1");
    ImGui::EndPopup();  // 必須
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | - | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | EndPopup()呼び出し | 現在のウィンドウがポップアップフラグを持ち、BeginPopupStack.Size > 0 | 開発者によるAPI呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ポップアップウィンドウでない場合 | IM_ASSERT_USER_ERROR_RETによりエラーが発生する |
| BeginPopupStack.Size == 0の場合 | IM_ASSERT_USER_ERROR_RETによりエラーが発生する |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[EndPopup呼び出し] --> B{現在ウィンドウは<br/>ポップアップ?}
    B -->|Yes| C{BeginPopupStack.Size<br/>> 0?}
    B -->|No| D[IM_ASSERT_USER_ERROR_RET]
    C -->|Yes| E[End呼び出し]
    C -->|No| D
    E --> F[BeginPopupStackからポップ]
    F --> G[終了]
    D --> G
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiContext (GImGui) | 現在のウィンドウ取得 | g.CurrentWindow |
| BeginPopupStack | ポップアップスタック確認 | g.BeginPopupStack.Size |

### テーブル別参照項目詳細

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| CurrentWindow | 現在のウィンドウコンテキスト | g.CurrentWindow |
| CurrentWindow->Flags | ウィンドウフラグ確認 | ImGuiWindowFlags_Popup検証 |
| BeginPopupStack | ポップアップスタック | サイズ確認 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ウィンドウスタック | POP | End()による自動処理 |
| BeginPopupStack | POP | ポップアップ参照の削除 |

#### スタック操作

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| POP | CurrentWindowStack | スタックから削除 | End()内部処理 |
| POP | BeginPopupStack | スタックから削除 | EndPopup内部処理 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| アサーション失敗 | 現在ウィンドウがポップアップでない | BeginPopup/EndPopupのペア確認 |
| アサーション失敗 | BeginPopupStack.Size == 0 | BeginPopup/EndPopupのペア確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0 |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（即座に実行される同期処理）

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

特になし。ローカルUIレンダリング処理のため、外部通信やデータ永続化は行わない。

## 備考

- BeginPopupXXX()がtrueを返した場合のみEndPopup()を呼び出すこと
- Begin/Endペアの不一致はアサーション失敗を引き起こす
- 内部的にはEnd()関数を呼び出し、その後BeginPopupStackからポップする
- BeginPopup、BeginPopupModal、BeginPopupContextXXXのすべてに対応

---

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

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

### 推奨読解順序

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

ImGuiのウィンドウフラグとポップアップスタックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiWindowFlags_Popupの定義（1192行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | BeginPopupStackの役割 |

**読解のコツ**: BeginPopupStackはBegin済みのポップアップを追跡し、OpenPopupStackとは別に管理される。

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

EndPopupの宣言と実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | EndPopup API宣言（847行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | EndPopup実装（12435-12439行目付近） |

**主要処理フロー**:
1. **12437行目**: g.CurrentWindow取得
2. **12438行目**: CurrentWindow取得
3. **12439行目**: IM_ASSERT_USER_ERROR_RETによるフラグ検証
4. End()呼び出し
5. BeginPopupStack.pop_back()

#### Step 3: End関数との関係を理解する

End()関数がウィンドウをどのように終了するか確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | End関数（ウィンドウ終了処理） |

**主要処理フロー**:
- ウィンドウスタックのポップ処理
- レンダリング完了処理

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

```
EndPopup() [imgui.cpp:12435]
    │
    ├─ g.CurrentWindow取得
    │
    ├─ IM_ASSERT_USER_ERROR_RET()
    │       │
    │       ├─ (Flags & ImGuiWindowFlags_Popup) != 0 検証
    │       │
    │       └─ BeginPopupStack.Size > 0 検証
    │
    ├─ End() [imgui.cpp]
    │       │
    │       ├─ ウィンドウレンダリング完了
    │       │
    │       └─ ウィンドウスタックポップ
    │
    └─ BeginPopupStack.pop_back()
           └─ ポップアップ参照削除
```

### データフロー図

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

なし               ───▶ EndPopup()               ───▶ void
                          │
                          ▼
CurrentWindow      ───▶ フラグ検証
  │                       │
  └─ Flags                ▼
                       End()                    ───▶ ウィンドウ終了
                          │
                          ▼
BeginPopupStack    ◀─── pop_back()              ───▶ スタック更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ソース | API宣言・フラグ定義 |
| imgui.cpp | `imgui.cpp` | ソース | 実装本体 |
