# 機能設計書 171-IsPopupOpen

## 概要

本ドキュメントは、ImGuiライブラリにおける`IsPopupOpen`関数の機能設計を記載する。この関数は、指定されたポップアップが現在開いているかどうかを判定するための機能である。

### 本機能の処理概要

**業務上の目的・背景**：GUIアプリケーションにおいて、ポップアップメニューやモーダルダイアログの表示状態を確認する必要がある場面は多い。例えば、複数のポップアップが同時に存在する場合に優先度を制御したり、特定のポップアップが開いている間は他の処理を抑制したりする必要がある。`IsPopupOpen`関数は、このようなポップアップの状態管理を可能にし、複雑なUI制御を実現するための基盤機能を提供する。

**機能の利用シーン**：
- コンテキストメニューが既に開いているかを確認し、重複して開くことを防止する場合
- モーダルダイアログの表示状態に応じて、背景のUI操作を無効化する場合
- ネストされたポップアップ（ポップアップ内のサブメニュー等）の管理
- カスタムポップアップロジックの実装時に、現在のポップアップスタックの状態を確認する場合

**主要な処理内容**：
1. 文字列IDからImGuiIDを計算する（文字列版のオーバーロード）
2. ポップアップフラグに応じた判定モードの選択
3. `ImGuiPopupFlags_AnyPopupId`フラグの場合、任意のポップアップが開いているかを確認
4. `ImGuiPopupFlags_AnyPopupLevel`フラグの場合、スタック全体を検索
5. 特定のIDに対するポップアップの開閉状態を返却

**関連システム・外部連携**：ImGuiの内部コンテキスト（`GImGui`）のポップアップスタック（`OpenPopupStack`、`BeginPopupStack`）と連携して状態を判定する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 25 | Popups | 主画面 | ポップアップの開閉状態確認 |

## 機能種別

状態照会機能（Query/Read）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| str_id | const char* | Yes | ポップアップを識別する文字列ID | NULLの場合はImGuiPopupFlags_AnyPopupIdと併用 |
| popup_flags | ImGuiPopupFlags | No（デフォルト:0） | 判定方法を制御するフラグ | ImGuiPopupFlags_AnyPopupIdとImGuiPopupFlags_AnyPopupLevelの組み合わせは不可 |

### ImGuiPopupFlagsの詳細

| フラグ | 説明 |
|--------|------|
| ImGuiPopupFlags_AnyPopupId | 任意のポップアップIDを対象とする（str_idは0になる） |
| ImGuiPopupFlags_AnyPopupLevel | 現在のレベルだけでなく、スタック全体で検索する |

### 入力データソース

ImGuiコンテキスト内部のポップアップスタック

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | ポップアップが開いている場合true、閉じている場合false |

### 出力先

呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. 文字列IDからImGuiIDを計算
   └─ ImGuiPopupFlags_AnyPopupIdの場合はID=0
2. ImGuiPopupFlags_AnyPopupIdの判定
   ├─ trueの場合
   │   ├─ ImGuiPopupFlags_AnyPopupLevelの場合
   │   │   └─ OpenPopupStack.Size > 0 を返却
   │   └─ それ以外
   │       └─ OpenPopupStack.Size > BeginPopupStack.Size を返却
   └─ falseの場合
       ├─ ImGuiPopupFlags_AnyPopupLevelの場合
       │   └─ OpenPopupStack全体を走査し、一致するIDがあればtrue
       └─ それ以外
           └─ 現在のBeginPopupレベルでIDが一致すればtrue
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{ImGuiPopupFlags_AnyPopupId?}
    B -->|Yes| C{ImGuiPopupFlags_AnyPopupLevel?}
    C -->|Yes| D[OpenPopupStack.Size > 0 を返却]
    C -->|No| E[OpenPopupStack.Size > BeginPopupStack.Size を返却]
    B -->|No| F{ImGuiPopupFlags_AnyPopupLevel?}
    F -->|Yes| G[OpenPopupStack全体を走査]
    G --> H{IDが一致?}
    H -->|Yes| I[true を返却]
    H -->|No| J[false を返却]
    F -->|No| K[現在のBeginPopupレベルでID比較]
    K --> L{一致?}
    L -->|Yes| M[true を返却]
    L -->|No| N[false を返却]
    D --> Z[終了]
    E --> Z
    I --> Z
    J --> Z
    M --> Z
    N --> Z
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-171-01 | AnyPopupId/AnyPopupLevel制約 | 文字列IDとImGuiPopupFlags_AnyPopupLevelを同時に使用することはできない | str_idが指定されている場合 |
| BR-171-02 | スタックレベル判定 | 通常の判定はBeginPopupスタックの現在のレベルで行う | ImGuiPopupFlags_AnyPopupLevelが未指定の場合 |

### 計算ロジック

特になし

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

該当なし（メモリ上のデータ構造のみを参照）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | アサーション失敗 | str_idとImGuiPopupFlags_AnyPopupLevelの同時使用 | デバッグビルドでアサートが発生し停止 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- O(1)の計算量（AnyPopupLevelフラグ未使用時）
- O(n)の計算量（AnyPopupLevelフラグ使用時、nはポップアップスタックの深さ）

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

特になし

## 備考

- 本関数は読み取り専用であり、ポップアップの状態を変更しない
- 内部的にはIDベースのオーバーロードも存在し、ImGui内部で使用される

---

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

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

### 推奨読解順序

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

ポップアップスタックの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiPopupData構造体の定義を確認 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiContextのOpenPopupStack、BeginPopupStackメンバを確認 |

**読解のコツ**: ImGuiのポップアップは、OpenPopupStackとBeginPopupStackという2つのスタックで管理される。OpenPopupStackは開いているポップアップの状態を保持し、BeginPopupStackはBeginPopup()呼び出しの深さを追跡する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 878行目: 公開APIの宣言を確認 |
| 2-2 | imgui.cpp | `imgui.cpp` | 12087行目: 文字列ID版の実装 |

**主要処理フロー**:
1. **12087-12093行目**: 文字列IDからImGuiIDを計算し、ID版を呼び出し
2. **12091-12092行目**: AnyPopupLevelと文字列IDの同時使用時のアサート

#### Step 3: 内部ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 12056行目: ID版IsPopupOpenの実装 |

**主要処理フロー**:
- **12059-12068行目**: AnyPopupIdフラグ時の処理
- **12071-12084行目**: 特定ID指定時の処理

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

```
IsPopupOpen(const char* str_id, ImGuiPopupFlags)
    │
    ├─ GetID(str_id)
    │      └─ IDスタックとstr_idからハッシュ値を計算
    │
    └─ IsPopupOpen(ImGuiID id, ImGuiPopupFlags)  [内部版]
           │
           ├─ AnyPopupId判定
           │      └─ OpenPopupStack.Sizeの確認
           │
           └─ 特定ID判定
                  └─ OpenPopupStack内のPopupId検索
```

### データフロー図

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

str_id ───────▶ GetID() ───────────┐
                                    │
popup_flags ───────────────────────┤
                                    ▼
                         ┌─────────────────────┐
                         │ IsPopupOpen(id)      │
                         │   - スタック検索     │
                         │   - レベル判定       │
                         └──────────┬──────────┘
                                    │
                                    ▼
                              [bool 戻り値]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 公開API宣言 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | 内部API宣言、データ構造定義 |
| imgui.cpp | `imgui.cpp` | ソース | 実装本体 |
