# 機能設計書 253-MemFree

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるメモリ解放機能（MemFree）の設計仕様を定義する。

### 本機能の処理概要

MemFree関数は、ImGuiが内部で使用するメモリ解放関数を提供する。設定されたフリー関数を呼び出し、デバッグツールが有効な場合は解放情報を追跡する。

**業務上の目的・背景**：
ImGuiライブラリ内部では、動的に確保されたメモリの適切な解放が必要となる。MemFree関数は、MemAllocと対になるメモリ解放処理を一元化し、カスタムアロケータのサポートとデバッグ機能の統合を実現する。DLL境界を跨ぐ場合、同一のアロケータで確保・解放することが重要であり、本関数はその仕組みの一部として機能する。

**機能の利用シーン**：
- ImGuiウィジェットの内部データ構造の解放
- ImVector等のコンテナのバッファ解放
- フォントアトラス、テクスチャデータの解放
- ユーザーがImGuiのメモリ管理システムを利用してMemAllocで確保したメモリの解放
- IM_FREEマクロ経由での呼び出し
- IM_DELETEマクロ経由でのオブジェクト破棄

**主要な処理内容**：
1. デバッグツールが有効でポインタがNULLでない場合、DebugAllocHookを呼び出して解放情報を記録
2. グローバルに設定されたフリー関数（GImAllocatorFreeFunc）を呼び出してメモリを解放

**関連システム・外部連携**：
- SetAllocatorFunctions: アロケータ関数の設定
- GetAllocatorFunctions: アロケータ関数の取得
- MemAlloc: メモリの確保

**権限による制御**：
権限による制御は存在しない。全ての呼び出し元から使用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は画面に直接関連しない内部API |

## 機能種別

メモリ管理処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ptr | void* | No | 解放するメモリへのポインタ | NULLの場合は何もしない（アロケータ依存） |

### 入力データソース

- グローバル変数`GImAllocatorFreeFunc`: メモリ解放関数
- グローバル変数`GImAllocatorUserData`: アロケータに渡すユーザーデータ
- グローバルコンテキスト`GImGui`: デバッグ情報記録用（オプション）

## 出力仕様

### 出力データ

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

### 出力先

なし（メモリを解放するのみ）

## 処理フロー

### 処理シーケンス

```
1. デバッグ情報記録（IMGUI_DISABLE_DEBUG_TOOLS未定義時）
   ├─ ポインタがNULLでないか確認
   ├─ GImGuiコンテキストの存在確認
   └─ DebugAllocHookを呼び出して解放情報を記録（size=-1で解放を示す）
2. フリー関数呼び出し
   └─ GImAllocatorFreeFunc(ptr, GImAllocatorUserData)でメモリ解放
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{デバッグツール有効?}
    B -->|Yes| C{ptr != NULL?}
    B -->|No| F[GImAllocatorFreeFunc呼び出し]
    C -->|Yes| D{GImGui != NULL?}
    C -->|No| F
    D -->|Yes| E[DebugAllocHook呼び出し]
    D -->|No| F
    E --> F
    F --> G[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-253-01 | デフォルトフリー | 未設定時はfree関数を使用 | SetAllocatorFunctions未呼び出し時 |
| BR-253-02 | コンテキスト非依存 | フリー呼び出し自体はコンテキスト不要 | 常に適用 |
| BR-253-03 | デバッグ追跡 | IMGUI_DISABLE_DEBUG_TOOLS未定義時のみ追跡 | コンパイル時設定 |
| BR-253-04 | ペア確保 | MemFreeで解放するメモリはMemAllocで確保 | 常に適用 |
| BR-253-05 | NULLチェック | デバッグ追跡前にNULLチェックを行う | デバッグモード時 |

### 計算ロジック

特になし（メモリ解放の委譲のみ）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 二重解放 | 同じポインタを2回解放 | 未定義動作（呼び出し元で防止） |
| - | 不正ポインタ | MemAlloc以外で確保したポインタを解放 | 未定義動作（呼び出し元で防止） |

### リトライ仕様

リトライ機能なし。

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

トランザクション管理なし

## パフォーマンス要件

- 基本的にO(1)の時間計算量（アロケータ実装依存）
- デバッグモードでは追加のオーバーヘッドあり

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

- 解放後のポインタ使用（Use-After-Free）は呼び出し元の責任で防止
- 二重解放の防止は呼び出し元の責任
- カスタムアロケータのセキュリティは設定者の責任

## 備考

- IM_FREEマクロは本関数のラッパーとして定義されている
- IM_DELETEマクロは本関数を使用してデストラクタ呼び出し後にメモリ解放
- メトリクスウィンドウで解放数を確認可能

---

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

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

### 推奨読解順序

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

デバッグ用アロケーション情報の構造を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiMemFreeFunc型定義（289行目） |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiDebugAllocInfo構造体（デバッグ用） |

**読解のコツ**: ImGuiMemFreeFuncは`void (*)(void* ptr, void* user_data)`という関数ポインタ型。

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

MemFree関数の宣言と実装を確認する。

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

**主要処理フロー**:
1. **5052行目**: MemFree関数定義開始
2. **5054-5057行目**: デバッグツール有効時のフック処理（ptr != NULL時）
3. **5059行目**: GImAllocatorFreeFunc呼び出しでメモリ解放

#### Step 3: マクロ定義を理解する

IM_FREE/IM_DELETEマクロの関係を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.h | `imgui.h` | IM_FREEマクロ定義（2185行目） |
| 3-2 | imgui.h | `imgui.h` | IM_DELETEテンプレート定義（2188行目） |

**主要処理フロー**:
- **2185行目**: `#define IM_FREE(_PTR) ImGui::MemFree(_PTR)`
- **2188行目**: `template<typename T> void IM_DELETE(T* p) { if (p) { p->~T(); ImGui::MemFree(p); } }`

#### Step 4: デバッグフックを理解する

解放追跡の仕組みを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | imgui.cpp | `imgui.cpp` | DebugAllocHook関数（5063-5085行目） |

**主要処理フロー**:
- **5074行目**: size == (size_t)-1 の場合は解放として処理
- **5082-5084行目**: FreeCount++、TotalFreeCount++

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

```
MemFree(ptr)
    │
    ├─ DebugAllocHook (デバッグモード時、ptr != NULL時)
    │      └─ ImGuiDebugAllocInfo更新
    │
    └─ GImAllocatorFreeFunc(ptr, user_data)
           └─ FreeWrapper (デフォルト) または カスタムフリー関数
```

### データフロー図

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

ptr      ───────▶ DebugAllocHook (記録)  ───────▶ (なし)
                           │
                           ▼
                  ImGuiDebugAllocInfo
                  (TotalFreeCount++)
                           │
                           ▼
                  GImAllocatorFreeFunc
                  (メモリ解放)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、マクロ定義 |
| imgui.cpp | `imgui.cpp` | ソース | 関数実装、デバッグフック |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | デバッグ用構造体定義 |
