# 機能設計書 81-PushID

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるPushID関数の機能設計を定義する。PushIDは、ウィジェットの一意識別のためにIDスタックに識別子をプッシュする機能である。

### 本機能の処理概要

PushID関数は、ImGuiのIDスタックシステムにおいて新しいIDをスタックにプッシュし、後続のウィジェットが一意の識別子を持てるようにする機能を提供する。

**業務上の目的・背景**：Dear ImGuiでは、すべてのウィジェットが一意のIDを持つ必要がある。ループ内で同じラベルのウィジェットを複数作成する場合や、同一ウィンドウ内で同じ名前のウィジェットを区別する必要がある場合に、PushIDを使用してスコープを作成し、ID衝突を防ぐ。これにより、同じラベルを持つボタンやチェックボックスが正しく動作し、ユーザー入力が期待通りに処理される。

**機能の利用シーン**：
- ループ内で動的にウィジェットを生成する場合（例：リスト要素ごとのボタン）
- 同じラベルを持つ複数のウィジェットを区別する場合
- 階層的なUIコンポーネントで名前空間を分離する場合
- カスタムウィジェットの実装でIDスコープを制御する場合

**主要な処理内容**：
1. 現在のウィンドウコンテキストを取得
2. 渡された識別子（文字列/ポインタ/整数）から新しいIDをハッシュ計算
3. 計算されたIDをウィンドウのIDスタックにプッシュ
4. 以降のウィジェットはこの新しいIDをベースとして一意識別子を生成

**関連システム・外部連携**：ImGuiコンテキスト（GImGui）、ImGuiWindow構造体のIDStack、ハッシュ関数（ImHashStr, ImHashData）

**権限による制御**：なし。すべてのImGuiユーザーが利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全ウィジェット | 補助機能 | ウィジェットID生成の基盤機能として使用 |

## 機能種別

ユーティリティ機能 / IDスタック操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| str_id | const char* | Yes（オーバーロード1） | スタックにプッシュする文字列ID | NULLチェックなし（NULLは許容） |
| str_id_begin | const char* | Yes（オーバーロード2） | 文字列IDの開始ポインタ | - |
| str_id_end | const char* | Yes（オーバーロード2） | 文字列IDの終了ポインタ | - |
| ptr_id | const void* | Yes（オーバーロード3） | スタックにプッシュするポインタ | - |
| int_id | int | Yes（オーバーロード4） | スタックにプッシュする整数 | - |

### 入力データソース

呼び出し元コードからの直接入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (なし) | void | 戻り値なし。IDスタックが更新される |

### 出力先

ImGuiWindow::IDStack（内部データ構造）

## 処理フロー

### 処理シーケンス

```
1. ImGuiコンテキストの取得
   └─ GImGuiからグローバルコンテキストを参照
2. 現在のウィンドウの取得
   └─ g.CurrentWindowから現在のウィンドウを参照
3. IDの計算
   └─ window->GetID()を呼び出し、現在のIDスタックトップと入力値からハッシュを計算
4. IDスタックへのプッシュ
   └─ window->IDStack.push_back(id)で新しいIDをスタックに追加
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GImGuiからコンテキスト取得]
    B --> C[g.CurrentWindowを取得]
    C --> D{入力型の判定}
    D -->|文字列| E[ImHashStrでハッシュ計算]
    D -->|ポインタ| F[ImHashDataでハッシュ計算]
    D -->|整数| G[ImHashDataでハッシュ計算]
    E --> H[window->GetID呼び出し]
    F --> H
    G --> H
    H --> I[IDStack.push_back]
    I --> J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Push/Popペアリング | PushIDは必ず対応するPopIDとペアで使用する必要がある | 常時 |
| BR-02 | IDスタックの一貫性 | フレーム終了時にIDスタックは初期状態に戻る必要がある | 常時 |

### 計算ロジック

IDはImHashStr/ImHashData関数を使用して計算される。ハッシュ計算はシード値（現在のIDスタックトップ）を基に行われ、入力値と組み合わせて一意のIDを生成する。

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション | PopIDをPushID以上に呼び出した場合 | デバッグビルドでアサーション発生 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- ハッシュ計算は軽量で、1フレーム内で多数回呼び出しても性能に影響しない
- O(1)の時間計算量でスタック操作を実行

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

特になし。内部メモリ操作のみで外部との通信なし。

## 備考

- PushIDで作成したスコープは、PopIDで終了する必要がある
- 同じIDを持つウィジェットが存在すると、予期しない動作が発生する可能性がある
- デバッグ時はImGui::ShowIDStackToolWindow()でIDスタックの状態を確認可能

---

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

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

### 推奨読解順序

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

まず、IDスタックとImGuiIDの基本構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiIDの型定義（160行目: `typedef unsigned int ImGuiID`） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow構造体のIDStackメンバ（2708行目） |

**読解のコツ**: ImGuiIDはunsigned intのtypedefであり、すべてのウィジェット識別に使用される32ビット値である。

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

PushID関数のオーバーロード群を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | PushID関数宣言（603-606行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | PushID関数実装（9160-9190行目） |

**主要処理フロー**:
1. **9160-9166行目**: 文字列版PushID - コンテキストとウィンドウを取得し、GetIDでハッシュを計算後、IDStack.push_back
2. **9168-9174行目**: 文字列範囲版PushID - 同様の処理で文字列範囲をハッシュ
3. **9176-9182行目**: ポインタ版PushID - ポインタ値をハッシュ
4. **9184-9190行目**: 整数版PushID - 整数値をハッシュ

#### Step 3: ハッシュ計算を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_internal.h | `imgui_internal.h` | ImHashStr/ImHashData関数宣言（366-367行目） |
| 3-2 | imgui.cpp | `imgui.cpp` | ImGuiWindow::GetID実装 |

**主要処理フロー**:
- **ImHashStr**: 文字列をハッシュ化。シード値と組み合わせて一意のIDを生成
- **ImHashData**: 任意のバイナリデータをハッシュ化

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

```
ImGui::PushID(const char* str_id)
    │
    ├─ GImGui（グローバルコンテキスト参照）
    │
    ├─ window->GetID(str_id)
    │      └─ ImHashStr(str_id, 0, IDStack.back())
    │
    └─ window->IDStack.push_back(id)
```

### データフロー図

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

str_id/ptr_id/int_id ───▶ GetID() ───▶ IDStack.push_back()
                              │
                              ├── IDStack.back()（現在のシード値）
                              │
                              └── ImHashStr/ImHashData
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | PushID関数の宣言、ImGuiID型定義 |
| imgui.cpp | `imgui.cpp` | ソース | PushID関数の実装（9160-9190行目） |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiWindow構造体、IDStack定義 |
