# 通知設計書 12-BeginPopupContextItem

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける`BeginPopupContextItem()`関数の設計仕様を記載する。この関数は、直前のアイテムがクリックされた時にコンテキストメニュー（ポップアップ）を開く機能を提供する。

### 本通知の処理概要

`BeginPopupContextItem()`は、直前に描画されたアイテム（ボタン、テキスト等）上でマウスボタンがリリースされた時に自動的にポップアップを開き、BeginPopup処理を実行するヘルパー関数である。OpenPopupOnItemClick()とBeginPopup()を組み合わせた処理を一つの関数で提供する。

**業務上の目的・背景**：GUIアプリケーションにおいて、右クリックコンテキストメニューは一般的なUI操作パターンである。この関数は、アイテム固有のコンテキストメニューを簡単に実装するための標準的な手段を提供し、コードの簡潔化とUI一貫性の維持を実現する。

**通知の送信タイミング**：直前のアイテム上でマウスボタン（デフォルトは右クリック）がリリースされた時。IsItemHovered()とIsMouseReleased()の条件が両方満たされた時にポップアップが開かれる。

**通知の受信者**：ImGuiの内部ポップアップスタック管理システム。OpenPopupStackにポップアップエントリが追加され、新しいウィンドウ描画コンテキストが開始される。

**通知内容の概要**：対象アイテムに関連付けられたポップアップIDで新しいポップアップウィンドウを開く指示。ポップアップが既に開いている場合はその内容を描画するためのコンテキストを提供する。

**期待されるアクション**：戻り値がtrueの場合、開発者はポップアップ内のUIコンテンツを描画し、最後にEndPopup()を呼び出す。

## 通知種別

内部API呼び出し / コンテキストメニュー通知

## 送信仕様

### 基本情報

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

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

1. str_idがNULLの場合、g.LastItemData.IDを使用（直前のアイテムのID）
2. str_idが指定された場合、window->GetID(str_id)でIDを生成
3. ImGuiPopupFlagsからマウスボタンを取得（デフォルトは右ボタン）
4. IsMouseReleased()とIsItemHovered()の両方がtrueの場合にOpenPopupEx()を呼び出し

## 通知テンプレート

### API呼び出し形式

| 項目 | 内容 |
|-----|------|
| 関数名 | BeginPopupContextItem(const char* str_id, ImGuiPopupFlags popup_flags) |
| 戻り値 | bool（ポップアップが開いている場合true） |
| 引数1 | str_id: ポップアップID（NULLの場合は直前のアイテムIDを使用） |
| 引数2 | popup_flags: ポップアップフラグ（デフォルト0=右クリック） |

### 使用例

```cpp
// ボタン後にコンテキストメニュー（NULLでボタンのIDを使用）
if (ImGui::Button("Options"))
{
    // ボタンの左クリック処理
}
if (ImGui::BeginPopupContextItem()) // 右クリックでポップアップ
{
    if (ImGui::MenuItem("Edit")) { /* 編集処理 */ }
    if (ImGui::MenuItem("Delete")) { /* 削除処理 */ }
    ImGui::EndPopup();
}

// Text()など識別子を持たないアイテムの場合
ImGui::Text("Right-click me!");
if (ImGui::BeginPopupContextItem("my popup"))
{
    ImGui::Text("This is a context menu");
    ImGui::EndPopup();
}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | N/A | N/A | この通知には添付ファイルは存在しない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| id | ポップアップID | str_id ? GetID(str_id) : g.LastItemData.ID | Yes |
| mouse_button | トリガーマウスボタン | GetMouseButtonFromPopupFlags(popup_flags) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| マウス操作 | マウスボタンリリース | IsMouseReleased(button) && IsItemHovered() | 直前のアイテム上でのクリック |
| 継続状態 | ポップアップ表示中 | IsPopupOpen(id) | 開いているポップアップの描画継続 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| window->SkipItems | 現在のウィンドウがスキップ状態の場合 |
| id == 0 | str_idがNULLかつ直前アイテムにIDがない場合（アサート発生） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginPopupContextItem呼び出し] --> B{window->SkipItems?}
    B -->|Yes| C[return false]
    B -->|No| D[ID決定]
    D --> E{str_id指定?}
    E -->|Yes| F[window->GetID使用]
    E -->|No| G[g.LastItemData.ID使用]
    F --> H[マウスボタン取得]
    G --> H
    H --> I{IsMouseReleased && IsItemHovered?}
    I -->|Yes| J[OpenPopupEx呼び出し]
    I -->|No| K[BeginPopupEx呼び出し]
    J --> K
    K --> L{ポップアップ開いている?}
    L -->|Yes| M[return true]
    L -->|No| N[return false]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| g.LastItemData | 直前アイテム情報 | IDの取得に使用 |
| g.IO.MousePos | マウス位置 | ホバー判定に使用 |
| g.OpenPopupStack | ポップアップスタック | 開閉状態確認 |

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

#### g.LastItemData

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ID | ポップアップIDとして使用 | str_id == NULL の場合 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| g.OpenPopupStack | INSERT | クリック時に新規ポップアップ追加 |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| DEBUG_LOG | OpenPopupEx | 0x%08X | ポップアップID |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| アサート失敗 | id == 0（IDなしアイテムでstr_id省略） | str_idを明示的に指定 |
| スキップ状態 | window->SkipItemsがtrue | false返却で処理スキップ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

即座に実行される同期処理のため、配信時間帯の制限なし。

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

この関数は内部状態の更新のみを行い、外部リソースへのアクセスや機密情報の処理は行わない。ユーザー入力（マウスクリック）に基づくため、意図しないポップアップ表示の可能性はあるが、セキュリティ上のリスクは最小限。

## 備考

- str_idをNULLにした場合、直前のアイテムのIDを使用するため、Text()等のIDを持たないアイテムでは使用できない
- Text()のようなIDを持たないアイテムには明示的にstr_idを指定する必要がある
- バージョン1.92.6でデフォルトのマウスボタンが変更された（詳細はAPI BREAKING CHANGES参照）

---

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

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

### 推奨読解順序

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

ポップアップフラグとマウスボタンの関係を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiPopupFlags_列挙型（1337-1352行） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiLastItemData構造体 |

**読解のコツ**: MouseButtonLeftは1<<2=4、MouseButtonRightは2<<2=8として定義されている。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | BeginPopupContextItem関数（12497行目） |

**主要処理フロー**:
1. **12501-12502行**: SkipItemsチェック
2. **12503行**: ID決定（str_id or LastItemData.ID）
3. **12504行**: IDが0でないことのアサート
4. **12505行**: マウスボタン取得
5. **12506行**: クリック判定とOpenPopupEx呼び出し
6. **12508行**: BeginPopupEx呼び出し

#### Step 3: 補助関数を理解する

GetMouseButtonFromPopupFlagsとOpenPopupExの動作を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetMouseButtonFromPopupFlags（12453行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | OpenPopupEx（12172行目） |

**主要処理フロー**:
- フラグからマウスボタン値を抽出
- デフォルトはImGuiMouseButton_Right

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

```
BeginPopupContextItem()  [imgui.cpp:12497]
    |
    +-- GetMouseButtonFromPopupFlags()  [imgui.cpp:12453]
    |       +-- フラグからマウスボタン抽出
    |
    +-- IsMouseReleased() / IsItemHovered()
    |
    +-- OpenPopupEx()  [imgui.cpp:12172] (条件付き)
    |       +-- ポップアップスタック更新
    |
    +-- BeginPopupEx()  [imgui.cpp:12345]
            +-- IsPopupOpen()確認
            +-- Begin()でウィンドウ開始
```

### データフロー図

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

str_id / NULL ─────▶ ID決定 ────────────────────▶ popup_id
                          |
g.LastItemData.ID ────────┘

popup_flags ───────▶ GetMouseButtonFromPopupFlags ──▶ mouse_button
                          |
IsMouseReleased ───▶ クリック判定 ──▶ OpenPopupEx ──▶ ポップアップ状態
IsItemHovered  ────────┘
                          |
                    BeginPopupEx ──▶ bool (表示中か否か)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | BeginPopupContextItem関数宣言（870行目） |
| imgui.cpp | `imgui.cpp` | ソース | BeginPopupContextItem実装（12497行目） |
| imgui.cpp | `imgui.cpp` | ソース | コメントによる使用方法説明（12481-12496行） |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（5365, 5384, 5414行目等） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | ColorEdit等での使用例（1551行目） |
