# 通知設計書 33-ConfigDebugHighlightIdConflicts

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるConfigDebugHighlightIdConflictsフラグによる「ID競合検出・通知」機能の設計を定義する。この機能は、プログラマーがよく犯すID重複エラーを検出し、視覚的なハイライトとエラーメッセージポップアップで通知する開発支援ツールである。

### 本通知の処理概要

ConfigDebugHighlightIdConflictsは、ImGuiIO構造体内のbool設定フラグであり、同一IDを持つ複数のUIアイテムが存在する場合に、視覚的なハイライト（赤い枠）とエラーメッセージポップアップを表示して開発者に通知する機能を制御する。

**業務上の目的・背景**：Dear ImGuiでは、各UIアイテムは一意のIDを持つ必要がある。しかし、初心者プログラマーがループ内でPushID/PopIDを使わずに同じラベルのボタンを作成したり、空ラベル（Button("")）を使用するなどして、意図せずID競合を発生させることが非常に多い。この機能は、そのような最も一般的なプログラミングミスを検出し、開発者に即座にフィードバックすることで、デバッグ時間を大幅に短縮する。

**通知の送信タイミング**：ホバー中のアイテムが前フレームで複数回使用されたIDを持つ場合（HoveredIdPreviousFrameItemCount > 1）に、自動的に検出・通知される。フレームごとにホバー状態が評価される。

**通知の受信者**：開発者が受信者となる。エラーツールチップが画面上に表示され、競合するアイテムが赤枠でハイライトされる。Ctrlキーを押し続けることで、Item Pickerやアサート有効化などの追加アクションを実行できる。

**通知内容の概要**：「Programmer error: X visible items with conflicting ID!」というメッセージと共に、以下の情報が提供される：
- PushID()/PopID()をループで使用すべきという助言
- "##xx"識別子の使用を推奨
- 空ラベルButton("")の問題点の説明
- FAQ記事へのリンク

**期待されるアクション**：開発者は、通知を確認し、PushID()/PopID()の追加、"##"サフィックスの使用、または他のID重複回避策を実装してコードを修正する。

## 通知種別

アプリ内通知（視覚的ハイライト + エラーツールチップ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（フレーム内で即時表示） |
| 優先度 | 高（開発時エラー） |
| リトライ | 無（毎フレーム再評価） |

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

以下の条件がすべて満たされた場合に通知が表示される：
1. io.ConfigDebugHighlightIdConflictsがtrue（デフォルトtrue）
2. ホバー中のアイテムのIDが前フレームで複数回使用されていた
3. Item Pickerが非アクティブ
4. アイテムにImGuiItemFlags_AllowDuplicateIdフラグが設定されていない

## 通知テンプレート

### フラグ仕様

| 項目 | 内容 |
|-----|------|
| フラグ名 | ConfigDebugHighlightIdConflicts |
| 型 | bool |
| 所属構造体 | ImGuiIO |
| デフォルト値 | true |

### 関連フラグ

| 項目 | 内容 |
|-----|------|
| フラグ名 | ConfigDebugHighlightIdConflictsShowItemPicker |
| 型 | bool |
| デフォルト値 | true |
| 説明 | エラーポップアップ内でItem Pickerボタンを表示するかどうか |

### エラーメッセージテンプレート

```
Programmer error: X visible items with conflicting ID!
- Code should use PushID()/PopID() in loops, or append "##xx" to same-label identifiers!
- Empty label e.g. Button("") == same ID as parent widget/node. Use Button("##xx") instead!
- Set io.ConfigDebugHighlightIdConflicts=false to disable this warning in non-programmers builds.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ConfigDebugHighlightIdConflicts | 機能有効/無効 | ImGuiIO | Yes |
| DebugDrawIdConflictsCount | 競合アイテム数 | ImGuiContext | Yes |
| DebugDrawIdConflictsId | 競合ID | ImGuiContext | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ホバー | アイテムにマウスホバー | HoveredIdPreviousFrameItemCount > 1 | 同一IDの複数アイテムがホバーされた |
| フレーム開始 | 毎フレーム評価 | ConfigDebugHighlightIdConflicts == true | 機能が有効 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ConfigDebugHighlightIdConflicts == false | 機能が無効化されている |
| Item Picker アクティブ | g.DebugItemPickerActive == true |
| ImGuiItemFlags_AllowDuplicateId | アイテムが意図的に重複IDを許可している |
| Ctrlキー押下中 | カウントがロックされ、ツールチップがインタラクティブになる |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[フレーム開始] --> B{ConfigDebugHighlightIdConflicts?}
    B -->|false| C[検出スキップ]
    B -->|true| D[ホバーID監視]
    D --> E{HoveredIdPreviousFrameItemCount > 1?}
    E -->|No| F[次フレームへ]
    E -->|Yes| G[DebugDrawIdConflictsId設定]
    G --> H[競合アイテムを赤枠でハイライト]
    H --> I{Item Picker非アクティブ?}
    I -->|No| F
    I -->|Yes| J[BeginErrorTooltip]
    J --> K[エラーメッセージ表示]
    K --> L{ShowItemPicker設定?}
    L -->|Yes| M[Item Pickerボタン表示]
    L -->|No| N[FAQリンク表示]
    M --> N
    N --> O[EndErrorTooltip]
    O --> F
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiIO | 設定参照 | ConfigDebugHighlightIdConflicts |
| ImGuiContext | 状態管理 | HoveredIdPreviousFrameItemCount等 |

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

#### ImGuiIO

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ConfigDebugHighlightIdConflicts | 機能有効判定 | 常時 |
| ConfigDebugHighlightIdConflictsShowItemPicker | Item Picker表示判定 | 常時 |
| KeyCtrl | カウントロック判定 | キー入力 |

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| HoveredIdPreviousFrame | 前フレームホバーID | 毎フレーム更新 |
| HoveredIdPreviousFrameItemCount | 同一ID使用回数 | 毎フレーム更新 |
| DebugDrawIdConflictsId | 競合表示対象ID | 競合検出時 |
| DebugDrawIdConflictsCount | 競合アイテム数 | Ctrlキーでロック可能 |
| DebugItemPickerActive | Item Picker状態 | 常時 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ImGuiContext | UPDATE | DebugDrawIdConflictsId/Count設定 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ID競合検出 | 同一IDの複数アイテム | 赤枠ハイライト + ツールチップ表示 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（毎フレーム再評価） |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | フレームレートに依存（毎フレーム評価） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（開発時常時有効）

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

- 開発者向けデバッグ機能のため、本番ビルドでは無効化を検討
- 非プログラマー向けビルドではio.ConfigDebugHighlightIdConflicts=falseを設定

## 備考

- v1.91.2（2024年9月）で追加された機能
- デフォルトでtrueのため、特に設定なしで動作する
- IMGUI_DEBUG_HIGHLIGHT_ALL_ID_CONFLICTSマクロを定義すると、ホバーなしでも全ID競合を検出（パフォーマンス低下あり）
- 意図的にID重複を使用する場合はPushItemFlag(ImGuiItemFlags_AllowDuplicateId, true)で警告を抑制可能

---

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

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

### 推奨読解順序

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

まず、関連するデータ構造とフラグの定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | 2477-2478行目：ConfigDebugHighlightIdConflictsフラグの定義とコメント |
| 1-2 | imgui.h | `imgui.h` | 1241行目：ImGuiItemFlags_AllowDuplicateIdフラグ |
| 1-3 | imgui_internal.h | `imgui_internal.h` | 2244行目：DebugDrawIdConflictsId定義 |
| 1-4 | imgui_internal.h | `imgui_internal.h` | 2538行目：DebugDrawIdConflictsCount定義 |

**読解のコツ**: ConfigDebugHighlightIdConflictsはImGuiIO構造体の「Debug Tools」セクションに属しており、ID競合検出専用の設定群の一部。

#### Step 2: 初期化を理解する

フラグの初期化処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | 1627-1628行目：ImGuiIOコンストラクタでのデフォルト値設定（true） |

**主要処理フロー**:
- **1627行目**: ConfigDebugHighlightIdConflicts = true
- **1628行目**: ConfigDebugHighlightIdConflictsShowItemPicker = true

#### Step 3: 検出ロジックを理解する

ID競合の検出処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 4896-4903行目：ItemAdd内での重複検出 |
| 3-2 | imgui.cpp | `imgui.cpp` | 5509-5513行目：フレーム更新時のDebugDrawIdConflictsId設定 |

**主要処理フロー**:
- **4898行目**: 前フレームのホバーIDと現在のIDを比較
- **4900行目**: 重複カウントをインクリメント
- **4901-4902行目**: 競合IDならば赤枠描画

#### Step 4: 通知表示ロジックを理解する

エラーツールチップの表示処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | imgui.cpp | `imgui.cpp` | 11071-11102行目：ErrorCheckEndFrameFinalizeErrorTooltip関数 |

**主要処理フロー**:
- **11075行目**: カウントロック処理（Ctrlキー非押下時のみ更新）
- **11077行目**: BeginErrorTooltipでツールチップ開始
- **11079-11083行目**: エラーメッセージとガイダンス表示
- **11085-11099行目**: Item Pickerボタンとリンク表示

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

```
[フレーム処理]
    |
    +-- ItemAdd() (imgui.cpp:4896)
    |       |
    |       +-- ID重複検出
    |       |
    |       +-- HoveredIdPreviousFrameItemCount++
    |       |
    |       +-- 赤枠描画（DebugDrawIdConflictsId一致時）
    |
    +-- UpdateHoveredWindowAndCaptureFlags() (imgui.cpp:5509)
    |       |
    |       +-- DebugDrawIdConflictsId設定
    |       |
    |       +-- (HoveredIdPreviousFrameItemCount > 1の場合)
    |
    +-- ErrorCheckEndFrameFinalizeErrorTooltip() (imgui.cpp:11071)
            |
            +-- BeginErrorTooltip()
            |
            +-- エラーメッセージ表示
            |
            +-- Item Picker / FAQリンク
            |
            +-- EndErrorTooltip()
```

### データフロー図

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

アイテムID --------> ItemAdd ----------------> HoveredIdPreviousFrameItemCount
  (各ウィジェット)      |
                       v
                  重複カウント
                       |
                       v
HoveredId ---------> UpdateHoveredWindow ----> DebugDrawIdConflictsId
                       |
                       v
                  競合判定
                       |
                       v
ConfigDebug* -----> ErrorCheckEnd... -------> エラーツールチップ
                       |                       赤枠ハイライト
                       v
                  BeginErrorTooltip
                       |
                       v
                  メッセージ表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | ConfigDebugHighlightIdConflicts定義（2477行目） |
| imgui.h | `imgui.h` | ヘッダー | ImGuiItemFlags_AllowDuplicateId定義（1241行目） |
| imgui.cpp | `imgui.cpp` | ソース | 初期化（1627行目）、検出（4896行目）、通知（11071行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | DebugDrawIdConflictsId/Count定義 |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | ButtonBehavior内のID競合コメント（536行目） |
| imgui_demo.cpp | `imgui_demo.cpp` | サンプル | 設定UI（557行目、709行目） |
| imconfig.h | `imconfig.h` | 設定 | IMGUI_DEBUG_HIGHLIGHT_ALL_ID_CONFLICTSマクロ（134行目） |
