# 機能設計書 202-EndDisabled

## 概要

本ドキュメントは、ImGuiライブラリにおける `EndDisabled` 関数の機能設計を定義する。この関数は、`BeginDisabled`で開始された無効化状態を終了し、通常のユーザー操作を再び有効にするためのBETA APIである。

### 本機能の処理概要

EndDisabled関数は、BeginDisabledで開始された無効化ブロックを終了する。無効化スタックをポップし、必要に応じてAlpha値を元に戻すことで、以降のウィジェットが再び通常通りに操作可能となる。

**業務上の目的・背景**：BeginDisabledと対になる終了関数として、無効化ブロックの範囲を明確に定義するために必要である。ImGuiのスタックベースのアーキテクチャでは、Begin系関数には必ず対応するEnd系関数が必要であり、これによりスコープの整合性が保たれる。

**機能の利用シーン**：
- BeginDisabledで開始した無効化ブロックの終了
- 条件付き無効化の範囲指定の終端
- ネストした無効化ブロックからの部分的な復帰
- フレーム内での動的な有効/無効状態の切り替え終了

**主要な処理内容**：
1. DisabledStackSizeをデクリメントしてネスト追跡を更新
2. ItemFlagsStackから最新のフラグをポップ
3. 直前のフラグ状態からCurrentItemFlagsを復元
4. 無効化が完全に終了した場合、バックアップしたAlpha値を復元

**関連システム・外部連携**：BeginDisabled関数、ImGuiスタイルシステム、ItemFlagsスタックと連携する。DisabledStackSizeの追跡により、ネストの整合性を検証する。

**権限による制御**：本機能自体に権限制御はない。アプリケーションロジックでBeginDisabled/EndDisabledのペアを適切に管理する必要がある。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 6 | Style Editor | 参照画面 | 無効化状態の終了による通常表示への復帰 |
| 23 | Widgets | 参照画面 | 各種ウィジェットの無効化終了デモ |
| 1 | Demo Window | 参照画面 | デバッグオプションの無効化終了 |

## 機能種別

状態制御 / スタック操作 / ビジュアルエフェクト復元

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | パラメータなし | - |

### 入力データソース

ImGuiContext内部状態（DisabledStackSize、ItemFlagsStack、CurrentItemFlags）

## 出力仕様

### 出力データ

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

### 出力先

- ImGuiContext内部状態の更新（CurrentItemFlags、ItemFlagsStack、DisabledStackSize、Style.Alpha）
- 以降に描画されるウィジェットのビジュアル表示と入力応答の正常化

## 処理フロー

### 処理シーケンス

```
1. ImGuiContextの取得
   └─ グローバルコンテキスト（GImGui）を取得
2. スタックサイズの検証
   └─ DisabledStackSize > 0であることをアサート
3. DisabledStackSizeのデクリメント
   └─ ネスト追跡用カウンタを減少
4. 直前の無効化状態の保存
   └─ was_disabledに現在のImGuiItemFlags_Disabled状態を保存
5. ItemFlagsStackのポップ
   └─ スタックから最新のフラグを削除
   └─ CurrentItemFlagsを前の状態に復元
6. Alpha値の復元（必要な場合）
   └─ 無効化が完全に終了した場合、DisabledAlphaBackupからAlpha値を復元
```

### フローチャート

```mermaid
flowchart TD
    A[EndDisabled呼び出し] --> B{DisabledStackSize > 0?}
    B -->|No| C[アサート失敗]
    B -->|Yes| D[DisabledStackSize--]
    D --> E[was_disabled = 現在のDisabled状態]
    E --> F[ItemFlagsStack.pop_back]
    F --> G[CurrentItemFlags復元]
    G --> H{was_disabled && !現在Disabled?}
    H -->|Yes| I[Style.Alpha = DisabledAlphaBackup]
    H -->|No| J[終了]
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-202-1 | ペア呼び出し | BeginDisabledと必ずペアで呼び出す必要がある | 常時 |
| BR-202-2 | スタック整合性 | EndDisabledの呼び出し回数がBeginDisabledを超えてはならない | 常時 |
| BR-202-3 | Alpha復元条件 | 完全に無効化が終了した場合のみAlpha値を復元 | ネスト最外層終了時 |
| BR-202-4 | フレーム内完結 | 同一フレーム内でBegin/Endペアが完結する必要がある | 常時 |

### 計算ロジック

Alpha値の復元：
```
無効化終了判定 = was_disabled && (CurrentItemFlags & ImGuiItemFlags_Disabled) == 0
if (無効化終了判定):
    Style.Alpha = DisabledAlphaBackup
```

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

### 操作別データベース影響一覧

本機能はデータベース操作を行わない（純粋なUI制御機能）。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT | アサーション | DisabledStackSize <= 0の状態でEndDisabled呼び出し | "Calling EndDisabled() too many times!"エラー。対応するBeginDisabledを追加 |

### リトライ仕様

リトライ機能なし（即時処理）

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

トランザクション管理なし（UI状態のスタック操作）。BeginDisabled/EndDisabledは必ずペアで使用し、フレーム内でスタックを整合させる必要がある。

## パフォーマンス要件

- EndDisabledは軽量な処理で、スタック操作と条件付きのAlpha復元のみ
- オーバーヘッドは最小限

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

- スタック操作の整合性は重要だが、セキュリティ上のリスクはない
- 不正なEndDisabled呼び出しはアサートで検出される（デバッグビルド時）

## 備考

- BETA APIとして提供されており、将来のバージョンで仕様が変更される可能性がある
- BeginDisabled(false)に対応するEndDisabled()も呼び出し可能だが、実質的にフラグのポップのみ
- ImGuiのエラー回復機能により、リリースビルドではスタック不整合が自動修復される場合がある

---

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

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

### 推奨読解順序

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

まず、無効化機能で使用されるコンテキスト変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | DisabledAlphaBackup、DisabledStackSizeの定義（2484-2485行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ItemFlagsStackの定義 |

**読解のコツ**: DisabledStackSizeはshort型で、ネスト深度を追跡する。0になると完全に有効状態に戻る。

#### Step 2: API宣言を理解する

公開APIの宣言を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | EndDisabled関数の宣言（986行目） |

**主要処理フロー**:
- **986行目**: EndDisabled関数宣言（パラメータなし）

#### Step 3: 実装を理解する

EndDisabled関数の実装詳細を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | EndDisabled関数の実装（8248-8259行目） |

**主要処理フロー**:
- **8248行目**: 関数定義の開始
- **8251行目**: DisabledStackSize > 0のアサーション
- **8252行目**: DisabledStackSizeのデクリメント
- **8253行目**: was_disabled状態の保存
- **8255行目**: ItemFlagsStackのポップ
- **8256行目**: CurrentItemFlagsの復元
- **8257-8258行目**: 条件付きAlpha復元

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

```
EndDisabled()
    │
    ├─ GImGui（グローバルコンテキスト取得）
    │
    ├─ IM_ASSERT_USER_ERROR_RET()
    │      └─ DisabledStackSize検証
    │
    ├─ DisabledStackSize--
    │
    ├─ ItemFlagsStack.pop_back()
    │
    ├─ CurrentItemFlags復元
    │
    └─ Style.Alpha復元（条件付き）
           └─ DisabledAlphaBackup参照
```

### データフロー図

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

DisabledStackSize ─────▶ EndDisabled() ───────▶ DisabledStackSize更新
                              │
ItemFlagsStack ────────▶     │ ───────────────▶ ItemFlagsStack更新
                              │                            │
DisabledAlphaBackup ───▶     └─────────────────▶ Style.Alpha復元
                                                           │
                                                  CurrentItemFlags更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | 公開API宣言 |
| imgui.cpp | `imgui.cpp` | ソース | 実装コード |
| imgui_internal.h | `imgui_internal.h` | ヘッダ | 内部データ構造定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | ソース | 使用例（561行目、588行目など） |
