# 機能設計書 168-BeginPopupContextItem

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける `BeginPopupContextItem` 関数の機能設計書である。この関数は、直前のアイテムに対するコンテキストメニュー（右クリックメニュー）を簡単に実装するためのヘルパー関数である。

### 本機能の処理概要

`BeginPopupContextItem`は、`OpenPopupOnItemClick`と`BeginPopup`を組み合わせた便利なヘルパー関数である。直前のアイテムがクリック（デフォルト: 右クリック）されたときにポップアップを開き、開いている場合はポップアップウィンドウを開始する。一般的なコンテキストメニューパターンを1行で実装できる。

**業務上の目的・背景**：GUIアプリケーションにおいて、コンテキストメニュー（右クリックメニュー）は、特定のアイテムに対する操作を提供する標準的なUIパターンである。ファイルの操作（コピー、削除等）、テキストの編集（切り取り、貼り付け等）、オブジェクトのプロパティ表示など、多くの場面で使用される。`BeginPopupContextItem`は、このパターンを最小限のコードで実装することを可能にし、開発効率を向上させる。

**機能の利用シーン**：
- リストアイテムの右クリックメニュー
- ツリーノードのコンテキストメニュー
- ボタンやウィジェットへの追加操作メニュー
- テーブルセルのコンテキストメニュー
- 画像やサムネイルへのアクションメニュー

**主要な処理内容**：
1. ウィンドウがスキップ状態（非表示）ならfalseを返す
2. ポップアップIDを決定（str_idまたはLastItemID）
3. 指定されたマウスボタンがリリースされ、アイテムがホバーされている場合はOpenPopupEx
4. BeginPopupExを呼び出してポップアップを開始

**関連システム・外部連携**：
- `OpenPopupEx`: ポップアップを開く内部関数
- `BeginPopupEx`: ポップアップウィンドウを開始する内部関数
- `IsMouseReleased`: マウスボタンのリリース判定
- `IsItemHovered`: アイテムのホバー判定

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 10 | Console | 補助機能 | コンテキストメニューの表示 |
| 25 | Popups | 補助機能 | コンテキストメニューの表示 |

## 機能種別

UI制御機能（コンテキストメニューヘルパー）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| str_id | const char* | No | ポップアップの識別子文字列（デフォルト: NULL = LastItemIDを使用） | NULL許容 |
| popup_flags | ImGuiPopupFlags | No | ポップアップフラグ（デフォルト: 0 = 右クリック） | 有効なImGuiPopupFlagsの組み合わせ |

### 入力データソース

- 呼び出し元コードから提供される識別子（オプション）
- 内部的に`g.LastItemData`（直前のアイテム情報）を参照
- マウス入力状態

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | ポップアップが開いていてコンテンツを追加できる場合はtrue |

### 出力先

- 画面上にコンテキストメニューウィンドウとして表示
- `g.OpenPopupStack`/`g.BeginPopupStack`に情報追加

## 処理フロー

### 処理シーケンス

```
1. スキップ状態確認
   └─ window->SkipItemsがtrueならfalseを返す
2. ポップアップID決定
   └─ str_id != NULL: window->GetID(str_id)
   └─ str_id == NULL: g.LastItemData.ID
3. IDアサーション
   └─ id != 0 を確認（失敗するとText()等に対してstr_id未指定）
4. マウスボタン種類取得
   └─ GetMouseButtonFromPopupFlags(popup_flags)
5. ポップアップオープン判定
   └─ IsMouseReleased(mouse_button) && IsItemHovered(AllowWhenBlockedByPopup)
   └─ trueならOpenPopupEx(id, popup_flags)
6. BeginPopupEx呼び出し
   └─ AlwaysAutoResize | NoTitleBar | NoSavedSettingsフラグ付き
```

### フローチャート

```mermaid
flowchart TD
    A[BeginPopupContextItem開始] --> B{window->SkipItems?}
    B -->|Yes| C[return false]
    B -->|No| D{str_id != NULL?}
    D -->|Yes| E[id = GetID str_id]
    D -->|No| F[id = LastItemData.ID]
    E --> G{id != 0?}
    F --> G
    G -->|No| H[アサーション失敗]
    G -->|Yes| I[マウスボタン種類取得]
    I --> J{IsMouseReleased && IsItemHovered?}
    J -->|Yes| K[OpenPopupEx id]
    J -->|No| L[BeginPopupEx id]
    K --> L
    L --> M{ポップアップが開いている?}
    M -->|Yes| N[return true]
    M -->|No| O[return false]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-168-01 | LastItemID使用 | str_id = NULLの場合、直前のアイテムのIDをポップアップIDとして使用 | str_id未指定時 |
| BR-168-02 | ID必須 | str_id = NULLで直前のアイテムにIDがない場合（例: Text()）はアサーション失敗 | str_id=NULL時 |
| BR-168-03 | デフォルト右クリック | popup_flags = 0の場合、右クリックがトリガー | フラグ未指定時 |
| BR-168-04 | 自動リサイズ | ポップアップウィンドウはコンテンツに応じて自動リサイズ | 常時 |
| BR-168-05 | タイトルバーなし | ポップアップにはタイトルバーが表示されない | 常時 |

### 計算ロジック

- OpenPopupOnItemClick + BeginPopup を1つにまとめた処理
- 等価コード:
```cpp
id = str_id ? GetID(str_id) : GetItemID();
OpenPopupOnItemClick(str_id, popup_flags);
return BeginPopup(id);
```

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション失敗 | str_id = NULLで直前アイテムにIDがない | str_idを明示的に指定する |

### リトライ仕様

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

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

該当なし。

## パフォーマンス要件

- 処理時間: 即時
- 毎フレーム呼び出されるが、ホバー/クリック状態の確認は軽量

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

特になし。

## 備考

- trueを返した場合は必ず`EndPopup`を呼び出す
- Button等のIDを持つアイテムに対しては、str_id = NULLで使用可能
- Text()等のIDを持たないアイテムに対しては、str_idを明示的に指定する必要がある
- バージョン1.92.6でpopup_flagsのデフォルトが変更された（詳細はAPI BREAKING CHANGESを参照）

---

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

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

### 推奨読解順序

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

ポップアップフラグとアイテムデータを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiPopupFlags定義（1337-1353行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | LastItemData構造体 |

**読解のコツ**: `LastItemData.ID`が直前のアイテムの識別子を保持する。IDを持たないアイテム（Text等）はIDが0になる。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | BeginPopupContextItem実装（12497-12509行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | 関数上部のコメント（12481-12496行目） |

**主要処理フロー**:
1. **12501-12502行目**: スキップ状態確認
2. **12503行目**: ID決定（str_idまたはLastItemData.ID）
3. **12504行目**: ID != 0のアサーション
4. **12505行目**: マウスボタン種類取得
5. **12506-12507行目**: マウスリリース && ホバーでOpenPopupEx
6. **12508行目**: BeginPopupExを呼び出して結果を返す

#### Step 3: 使用例を理解する

imgui_demo.cppでの実際の使用パターンを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_demo.cpp | `imgui_demo.cpp` | 使用例（5365-5374行目、2272-2275行目等） |

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

```
BeginPopupContextItem(str_id, popup_flags)
    │
    ├─ SkipItems確認
    │      └─ window->SkipItemsで早期リターン
    │
    ├─ ID決定
    │      ├─ window->GetID(str_id)  [str_id != NULL]
    │      └─ g.LastItemData.ID      [str_id == NULL]
    │
    ├─ GetMouseButtonFromPopupFlags(popup_flags)
    │      └─ マウスボタン種類を計算
    │
    ├─ OpenPopupEx(id, popup_flags)  [条件付き]
    │      └─ IsMouseReleased && IsItemHovered
    │
    └─ BeginPopupEx(id, flags)
           └─ AlwaysAutoResize | NoTitleBar | NoSavedSettings
```

### データフロー図

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

str_id (文字列/NULL) ─▶ BeginPopupContextItem() ─▶ bool (開いているか)
popup_flags            │
                       ├─ ID決定
                       │   ├─ GetID()
                       │   └─ g.LastItemData.ID
                       │
                       ├─ クリック判定
                       │   ├─ IsMouseReleased
                       │   └─ IsItemHovered
                       │
                       └─ ポップアップ処理
                           ├─ OpenPopupEx()
                           └─ BeginPopupEx()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 関数宣言（870行目）、ImGuiPopupFlags定義 |
| imgui.cpp | `imgui.cpp` | ソース | BeginPopupContextItem実装（12497-12509行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダ | LastItemData構造体 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | 使用例（5365行目、2272行目、7099行目等） |
