# 機能設計書 59-PushItemFlag

## 概要

本ドキュメントは、ImGuiライブラリのPushItemFlag関数の設計仕様を定義する。PushItemFlagは共有アイテムフラグを一時的に変更し、アイテムフラグスタックにプッシュするための機能である。

### 本機能の処理概要

PushItemFlag関数は、指定された共有アイテムフラグ（ImGuiItemFlags）を有効化または無効化する。フラグの変更はアイテムフラグスタックにプッシュされ、PopItemFlagで復元できる。このフラグはすべてのサブmitted アイテムに影響する。

**業務上の目的・背景**：GUIアプリケーションでは、特定のUI領域でウィジェットの動作を一時的に変更したい場合がある。例えば、キーボードナビゲーションを無効にしたり、ボタンのリピート動作を有効にしたりする。PushItemFlag/PopItemFlagのスタック機構により、一時的なフラグ変更を安全に管理でき、元の状態への復元が保証される。

**機能の利用シーン**：
- 特定のアイテムでタブストップを無効にする場合（ImGuiItemFlags_NoTabStop）
- キーボード/ゲームパッドナビゲーションを無効にする場合（ImGuiItemFlags_NoNav）
- ボタンのリピート動作を有効にする場合（ImGuiItemFlags_ButtonRepeat）
- メニューアイテムの自動ポップアップクローズを制御する場合（ImGuiItemFlags_AutoClosePopups）
- 重複IDの警告を抑制する場合（ImGuiItemFlags_AllowDuplicateId）

**主要な処理内容**：
1. 現在のアイテムフラグを取得
2. 指定されたフラグを有効化または無効化
3. 新しいフラグ値をスタックにプッシュ
4. 現在のアイテムフラグを更新

**関連システム・外部連携**：ナビゲーションシステム、入力処理システムと連携し、ウィジェットの動作を制御する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | すべての画面 | 補助機能 | アイテムの動作制御 |

## 機能種別

スタック操作 / 動作フラグ変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| option | ImGuiItemFlags | Yes | 変更するフラグ | 有効なImGuiItemFlags値 |
| enabled | bool | Yes | フラグを有効にするか無効にするか | true/false |

### 入力データソース

- ImGuiItemFlags列挙型（7つのフラグ定義）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | void | 戻り値なし |

### 出力先

- ImGuiContext.ItemFlagsStack（アイテムフラグスタック）
- ImGuiContext.CurrentItemFlags（現在のアイテムフラグ）

## 処理フロー

### 処理シーケンス

```
1. コンテキストの取得
   └─ グローバルコンテキストGImGuiを参照
2. 現在のフラグを取得
   └─ item_flags = g.CurrentItemFlags
3. アサーションチェック
   └─ item_flags == g.ItemFlagsStack.back()であることを確認
4. フラグの変更
   └─ enabled ? (item_flags |= option) : (item_flags &= ~option)
5. 現在フラグの更新
   └─ g.CurrentItemFlags = item_flags
6. スタックにプッシュ
   └─ g.ItemFlagsStack.push_back(item_flags)
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[item_flags = g.CurrentItemFlags]
    B --> C[ASSERT: item_flags == ItemFlagsStack.back]
    C --> D{enabled?}
    D -->|Yes| E[item_flags OR= option]
    D -->|No| F[item_flags AND= ~option]
    E --> G[g.CurrentItemFlags = item_flags]
    F --> G
    G --> H[ItemFlagsStack.push_back]
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-59-01 | Push/Popペアリング | PushItemFlagは必ずPopItemFlagとペアで使用する | 常時 |
| BR-59-02 | ビットフラグ操作 | フラグはビット演算で追加/削除される | 常時 |
| BR-59-03 | 即時適用 | フラグ変更は即座にCurrentItemFlagsに反映 | 常時 |

### 計算ロジック

フラグ操作：
```cpp
if (enabled)
    item_flags |= option;  // フラグを追加
else
    item_flags &= ~option; // フラグを削除
```

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

該当なし（メモリ内操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT | アサーション | CurrentItemFlagsとスタック末尾が不一致 | スタック操作の整合性を確認 |

### リトライ仕様

該当なし

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

該当なし（メモリ内操作のみ）

## パフォーマンス要件

- スタック操作のため、O(1)の時間計算量
- フレームごとに複数回呼び出されることを想定した軽量実装

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

特になし

## 備考

- ImGuiItemFlags_Disabledは内部フラグであり、BeginDisabled/EndDisabledで使用される
- BeginDisabled()とPushItemFlag(ImGuiItemFlags_Disabled)の混用は現在サポートされていない

---

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

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

### 推奨読解順序

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

アイテムフラグ管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiItemFlags_列挙型（1233-1243行目） |
| 1-2 | imgui.h | `imgui.h` | PushItemFlag関数シグネチャ（536行目） |

**読解のコツ**: ImGuiItemFlags_はビットフラグとして設計されており、複数のフラグを組み合わせて使用できる。各フラグの意味とデフォルト値（true/false）を確認する。

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

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

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

**主要処理フロー**:
1. **8207行目**: グローバルコンテキストの取得
2. **8208行目**: 現在のアイテムフラグを取得
3. **8209行目**: スタック整合性のアサーション
4. **8210-8213行目**: 条件分岐によるフラグ操作
5. **8214行目**: CurrentItemFlagsの更新
6. **8215行目**: ItemFlagsStackにプッシュ

#### Step 3: 関連関数を理解する

PopItemFlag関数とBeginDisabled関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | PopItemFlag実装（8218-8224行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | BeginDisabled実装（8233行目以降） |

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

```
ImGui::PushItemFlag(ImGuiItemFlags option, bool enabled)
    │
    ├─ item_flags = g.CurrentItemFlags
    │
    ├─ IM_ASSERT(...)                  // 整合性チェック
    │
    ├─ ビット演算（OR / AND NOT）       // フラグ操作
    │
    ├─ g.CurrentItemFlags = item_flags // 更新
    │
    └─ g.ItemFlagsStack.push_back(...)  // スタックプッシュ
```

### データフロー図

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

ImGuiItemFlags option ───▶ ビット演算               ───▶ 新しいフラグ値
                              │
bool enabled          ───▶ OR または AND NOT        ───▶ 制御
                              │
CurrentItemFlags      ───▶ フラグ適用               ───▶ CurrentItemFlags
                              │
ItemFlagsStack        ───▶ push_back               ───▶ ItemFlagsStack
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PushItemFlag関数の宣言（536行目） |
| imgui.h | `imgui.h` | ヘッダー | ImGuiItemFlags_列挙型（1233-1243行目） |
| imgui.cpp | `imgui.cpp` | ソース | PushItemFlag関数の実装（8205-8216行目） |
