# 機能設計書 163-BeginPopupModal

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける `BeginPopupModal` 関数の機能設計書である。この関数は、モーダルポップアップウィンドウを開始し、背後のすべての操作をブロックする排他的なダイアログを作成する。

### 本機能の処理概要

`BeginPopupModal`は、ユーザーの注意を強制的に引き付け、明示的な操作（確認/キャンセル等）を要求するモーダルダイアログを実装するための関数である。通常のポップアップとは異なり、外部クリックで閉じることができず、背景がディミング（暗く）表示される。

**業務上の目的・背景**：GUIアプリケーションにおいて、重要な確認や選択を強制する場面は頻繁に発生する。ファイルの削除確認、未保存データの警告、エラー通知など、ユーザーが見落としてはならない情報を提示する際にモーダルダイアログが使用される。`BeginPopupModal`は、このようなモーダルUIパターンを標準的な方法で実装することを可能にし、ユーザーが重要な決定を意識的に行えるようにする。

**機能の利用シーン**：
- ファイル削除や上書きの確認ダイアログ
- 未保存変更の警告ダイアログ
- アプリケーション終了確認
- エラーや警告の通知
- 設定変更の適用確認
- ライセンス同意画面

**主要な処理内容**：
1. ポップアップIDを使用して、モーダルが現在開いているかを確認
2. 開いていない場合はp_openをfalseに設定しfalseを返す
3. 開いている場合は、モーダル固有のフラグを付与してBegin関数を呼び出し
4. デフォルトでビューポート中央に配置
5. p_openが指定されている場合、閉じるボタンを表示

**関連システム・外部連携**：
- `OpenPopup`: モーダルを開く関数（BeginPopupModalの前に呼び出す必要がある）
- `EndPopup`: モーダルを終了する関数（BeginPopupModalがtrueを返した場合に必ず呼び出す）
- `CloseCurrentPopup`: モーダル内から閉じる場合に使用

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 25 | Popups | 主機能 | モーダルポップアップの開始 |

## 機能種別

UI制御機能（モーダルダイアログ管理）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| name | const char* | Yes | モーダルウィンドウのタイトル/識別子 | NULLポインタ禁止 |
| p_open | bool* | No | 閉じるボタン用の状態ポインタ（デフォルト: NULL） | NULLまたは有効なbool* |
| flags | ImGuiWindowFlags | No | ウィンドウフラグ（デフォルト: 0） | 有効なImGuiWindowFlagsの組み合わせ |

### 入力データソース

- 呼び出し元コードから提供される名前/タイトル文字列
- 内部的に`g.OpenPopupStack`（開いているポップアップのスタック）を参照

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | モーダルが開いていてコンテンツを追加できる場合はtrue |
| *p_open | bool | モーダルが開いているか（p_open != NULLの場合に更新） |

### 出力先

- 画面上にモーダルウィンドウとして表示
- 背景のディミング効果を描画
- `g.BeginPopupStack`にポップアップ情報をプッシュ

## 処理フロー

### 処理シーケンス

```
1. ポップアップID計算
   └─ CurrentWindow->GetID(name) でIDを生成
2. ポップアップ状態確認
   └─ IsPopupOpen(id, ImGuiPopupFlags_None) で確認
3. 開いていない場合
   └─ NextWindowDataをクリア
   └─ p_open != NULL && *p_openの場合、*p_open = falseに設定
   └─ falseを返す
4. ウィンドウ位置設定（初回のみ）
   └─ ビューポート中央に配置
5. ウィンドウフラグ設定
   └─ Popup | Modal | NoCollapse を追加
6. Begin関数呼び出し
   └─ name, p_open, flags でウィンドウを開始
7. 結果処理
   └─ 閉じられた場合はEndPopup + ClosePopupToLevel
   └─ 開いていればtrueを返す
```

### フローチャート

```mermaid
flowchart TD
    A[BeginPopupModal開始] --> B[ID = GetID name]
    B --> C{IsPopupOpen?}
    C -->|No| D[NextWindowData.ClearFlags]
    D --> E{p_open && *p_open?}
    E -->|Yes| F[*p_open = false]
    E -->|No| G[return false]
    F --> G
    C -->|Yes| H{位置設定済み?}
    H -->|No| I[中央配置設定]
    H -->|Yes| J[フラグ追加]
    I --> J
    J --> K[Begin name, p_open, flags]
    K --> L{is_open && *p_open?}
    L -->|No| M[EndPopup]
    M --> N{is_open?}
    N -->|Yes| O[ClosePopupToLevel]
    N -->|No| P[return false]
    O --> P
    L -->|Yes| Q[return true]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-163-01 | 排他制御 | モーダルが開いている間、背後のすべての操作がブロックされる | 常時 |
| BR-163-02 | 明示的閉じ | 外部クリックでは閉じず、CloseCurrentPopupまたは閉じるボタンが必要 | 常時 |
| BR-163-03 | 中央配置 | 初回表示時はビューポート中央に配置される | 位置未指定時 |
| BR-163-04 | タイトルバー | 通常のポップアップと異なり、タイトルバーが表示される | 常時 |
| BR-163-05 | スタック可能 | モーダルは他のモーダルの上にスタック可能 | ネストされたモーダル使用時 |

### 計算ロジック

- ポップアップID: `CurrentWindow->IDStack`に基づいてnameからハッシュ計算
- 中央配置: `viewport->GetCenter()`からサイズの半分をオフセット

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

該当なし（データベース操作は行わない）。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 未定義動作 | nameがNULL | NULLを渡さない |
| - | 論理エラー | OpenPopupを呼ばずにBeginPopupModal | OpenPopupを先に呼び出す |
| - | アサーション失敗 | EndPopupの呼び忘れ | デバッグビルドで検出 |

### リトライ仕様

リトライ不要（毎フレーム呼び出し）。

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

該当なし。

## パフォーマンス要件

- 処理時間: 即時
- モーダルが閉じている場合は早期リターン

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

- 重要な操作（削除、送信等）の確認にモーダルを使用することを推奨
- モーダルの閉じるボタン（p_open）を適切に処理し、意図しない操作を防止

## 備考

- `BeginPopup`との違い: BeginPopupModalは外部クリックで閉じず、背景がディミングされる
- p_openを指定すると、ウィンドウ右上に閉じるボタンが表示される
- ImGuiWindowFlags_NoCollapseが自動付与され、折りたたみボタンは非表示

---

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

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

### 推奨読解順序

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

ポップアップ/モーダル管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiPopupData構造体（1471-1483行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiWindowFlags_Modal定義（1193行目） |

**読解のコツ**: モーダルは`ImGuiWindowFlags_Modal`フラグで識別される。このフラグが背景ブロッキングや自動クローズ無効化の判定に使用される。

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

`BeginPopupModal`関数の実装を確認する。

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

**主要処理フロー**:
1. **12405-12412行目**: ポップアップID計算と開状態確認
2. **12414-12421行目**: 初回表示時のビューポート中央配置設定
3. **12423行目**: Popup | Modal | NoCollapseフラグを追加
4. **12424行目**: Begin関数呼び出し
5. **12425-12431行目**: 閉じられた場合の処理

#### Step 3: 背景ブロッキングを理解する

モーダルによる背景操作のブロック機構を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | FindBlockingModal関数（12132-12153行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | GetTopMostPopupModal関数（12097-12105行目） |

**主要処理フロー**:
- FindBlockingModalは指定ウィンドウをブロックするモーダルを検索
- GetTopMostPopupModalは最上位のモーダルを取得

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

```
BeginPopupModal(name, p_open, flags)
    │
    ├─ CurrentWindow->GetID(name)
    │      └─ IDスタックからハッシュ計算
    │
    ├─ IsPopupOpen(id, ImGuiPopupFlags_None)
    │      └─ ポップアップスタックを検索
    │
    ├─ GetMainViewport()
    │      └─ メインビューポート取得
    │
    ├─ SetNextWindowPos(center, ...)
    │      └─ 中央配置設定
    │
    └─ Begin(name, p_open, flags | Modal)
           │
           ├─ ウィンドウ作成/更新
           │
           └─ 閉じるボタン処理（p_open != NULLの場合）
```

### データフロー図

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

name (文字列)   ───▶ BeginPopupModal()   ───▶ bool (開いているか)
p_open (bool*)       │                         │
flags (フラグ)       ├─ ID計算                 ├─▶ モーダルウィンドウ
                     │   └─ GetID()            │    （画面上に描画）
                     │                         │
                     ├─ ポップアップ状態確認   └─▶ *p_open更新
                     │   └─ g.OpenPopupStack       （閉じるボタン押下時）
                     │
                     └─ 中央配置 + フラグ設定
                         └─ Begin()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 関数宣言（846行目）、ImGuiWindowFlags_Modal定義 |
| imgui.cpp | `imgui.cpp` | ソース | BeginPopupModal実装（12401-12433行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダ | ImGuiPopupData構造体定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（5440行目、5462行目、5488行目等） |
