# 機能設計書 251-GetAllocatorFunctions

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるメモリアロケータ関数取得機能（GetAllocatorFunctions）の設計仕様を定義する。

### 本機能の処理概要

GetAllocatorFunctions関数は、現在設定されているImGuiのメモリアロケータ関数（割り当て関数、解放関数）とユーザーデータを取得する機能を提供する。

**業務上の目的・背景**：
DLL境界を跨ぐアプリケーションやプラグインシステムにおいて、各モジュール間でメモリアロケータを共有する必要がある。DLLとEXE、または複数のDLL間ではヒープやグローバル変数が共有されないため、一方のモジュールで確保したメモリを別のモジュールで解放しようとすると問題が発生する。本機能により、メインの実行ファイルで使用しているアロケータ関数を取得し、DLL側に設定することで、メモリ管理の一貫性を保証する。

**機能の利用シーン**：
- DLLプラグインシステムでImGuiを使用する場合のアロケータ共有
- 複数のDLLでImGuiコンテキストを使用する場合
- ホットリロード機能を持つアプリケーションでのメモリ管理
- デバッグ目的でのアロケータ関数の確認

**主要な処理内容**：
1. グローバル変数GImAllocatorAllocFuncから現在の割り当て関数ポインタを取得
2. グローバル変数GImAllocatorFreeFuncから現在の解放関数ポインタを取得
3. グローバル変数GImAllocatorUserDataから現在のユーザーデータを取得
4. 引数で渡されたポインタに各値を格納

**関連システム・外部連携**：
本機能はDLL/共有ライブラリとの連携において重要な役割を果たす。SetAllocatorFunctions関数と対になって使用される。

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

## 関連画面

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

## 機能種別

データ取得処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| p_alloc_func | ImGuiMemAllocFunc* | Yes | 割り当て関数ポインタを受け取るポインタ | 非NULL必須 |
| p_free_func | ImGuiMemFreeFunc* | Yes | 解放関数ポインタを受け取るポインタ | 非NULL必須 |
| p_user_data | void** | Yes | ユーザーデータを受け取るポインタ | 非NULL必須 |

### 入力データソース

グローバル変数から取得：
- `GImAllocatorAllocFunc`: 現在の割り当て関数
- `GImAllocatorFreeFunc`: 現在の解放関数
- `GImAllocatorUserData`: 現在のユーザーデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| *p_alloc_func | ImGuiMemAllocFunc | 現在設定されているメモリ割り当て関数 |
| *p_free_func | ImGuiMemFreeFunc | 現在設定されているメモリ解放関数 |
| *p_user_data | void* | アロケータ関数に渡されるユーザーデータ |

### 出力先

呼び出し元が渡したポインタに格納

## 処理フロー

### 処理シーケンス

```
1. 引数チェック
   └─ 引数はすべて非NULLであることが前提
2. p_alloc_funcにGImAllocatorAllocFuncの値を格納
   └─ グローバル変数から直接コピー
3. p_free_funcにGImAllocatorFreeFuncの値を格納
   └─ グローバル変数から直接コピー
4. p_user_dataにGImAllocatorUserDataの値を格納
   └─ グローバル変数から直接コピー
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[p_alloc_funcに割り当て関数を格納]
    B --> C[p_free_funcに解放関数を格納]
    C --> D[p_user_dataにユーザーデータを格納]
    D --> E[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-251-01 | コンテキスト非依存 | 本関数はImGuiコンテキストに依存しない | 常に適用 |
| BR-251-02 | グローバル変数参照 | アロケータ設定はグローバル変数に保持される | 常に適用 |
| BR-251-03 | DLL境界考慮 | DLL毎にグローバル変数は独立している | DLL使用時 |

### 計算ロジック

特になし（単純なデータ取得のみ）

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 引数がNULLの場合は未定義動作 | 呼び出し元で非NULLを保証する |

### リトライ仕様

リトライ不要（同期処理、副作用なし）

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

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

## パフォーマンス要件

3つのポインタ代入のみのため、O(1)で完了。パフォーマンス上の懸念なし。

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

- メモリアロケータ関数は任意のコードを実行できるため、信頼できるソースからのみ設定すること
- DLL境界を跨ぐ場合、悪意あるDLLが不正なアロケータを設定する可能性を考慮すること

## 備考

- SetAllocatorFunctions関数と対で使用される
- デフォルトのアロケータはmallocとfreeのラッパー
- IMGUI_DISABLE_DEFAULT_ALLOCATORSが定義されている場合、デフォルトアロケータはアサーションを発生させる

---

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

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

### 推奨読解順序

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

メモリアロケータ関数の型定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiMemAllocFunc/ImGuiMemFreeFunc型定義（288-289行目） |

**読解のコツ**: 関数ポインタ型の定義に注目。ImGuiMemAllocFuncは`void* (*)(size_t sz, void* user_data)`、ImGuiMemFreeFunc は`void (*)(void* ptr, void* user_data)`という形式。

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

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

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

**主要処理フロー**:
1. **4069行目**: 関数シグネチャ定義
2. **4071行目**: GImAllocatorAllocFuncをp_alloc_funcに格納
3. **4072行目**: GImAllocatorFreeFuncをp_free_funcに格納
4. **4073行目**: GImAllocatorUserDataをp_user_dataに格納

#### Step 3: グローバル変数を理解する

アロケータ情報を保持するグローバル変数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | グローバル変数定義（1427-1435行目） |

**主要処理フロー**:
- **1427-1428行目**: デフォルトアロケータ関数（MallocWrapper/FreeWrapper）
- **1433行目**: GImAllocatorAllocFunc変数定義
- **1434行目**: GImAllocatorFreeFunc変数定義
- **1435行目**: GImAllocatorUserData変数定義

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

```
GetAllocatorFunctions(p_alloc_func, p_free_func, p_user_data)
    │
    ├─ GImAllocatorAllocFunc (グローバル変数参照)
    ├─ GImAllocatorFreeFunc (グローバル変数参照)
    └─ GImAllocatorUserData (グローバル変数参照)
```

### データフロー図

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

GImAllocatorAllocFunc ──▶ GetAllocatorFunctions ──▶ *p_alloc_func
GImAllocatorFreeFunc  ──▶                        ──▶ *p_free_func
GImAllocatorUserData  ──▶                        ──▶ *p_user_data
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、型定義 |
| imgui.cpp | `imgui.cpp` | ソース | 関数実装、グローバル変数定義 |
