# 機能設計書 249-SaveIniSettingsToMemory

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるSaveIniSettingsToMemory関数の機能設計について記述する。この関数はImGuiの設定をメモリ上のINI形式文字列として取得するためのユーティリティ関数である。

### 本機能の処理概要

SaveIniSettingsToMemory関数は、ImGuiの現在の状態（ウィンドウ位置、サイズ、折りたたみ状態など）をINI形式のNULL終端文字列としてメモリ上に生成し、そのポインタを返す機能を提供する。カスタムストレージへの保存や、他の保存形式への変換に使用できる。

**業務上の目的・背景**：アプリケーションによっては、設定データを独自の方式で管理したい場合がある。例えば、ユーザープロファイルの一部として保存したり、クラウドストレージと同期したり、暗号化して保存したりする場合である。この関数は、INIデータを任意の方法で保存するための中間データを提供する。

**機能の利用シーン**：カスタムストレージへの設定保存、ネットワーク経由での設定送信、設定データの暗号化保存、複数の設定プロファイル管理、設定のエクスポート機能などに使用される。

**主要な処理内容**：
1. ダーティタイマーをリセット
2. 設定バッファを初期化
3. 各設定ハンドラのWriteAllFnコールバックを呼び出し
4. 生成されたINIデータのサイズを返却
5. NULL終端文字列へのポインタを返却

**関連システム・外部連携**：内部的にImGuiSettingsHandler機構を使用し、ウィンドウ設定やカスタム設定のシリアライズを行う。

**権限による制御**：本機能に権限による制御は存在しない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全ウィンドウ | 主機能 | ウィンドウ位置・サイズの取得 |

## 機能種別

読取処理 / メモリ出力 / 設定シリアライズ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| out_ini_size | size_t* | No (デフォルト: NULL) | 出力サイズの格納先 | - |

### 入力データソース

- ImGuiContext内の設定データ（ウィンドウ位置、サイズ等）
- 各ImGuiSettingsHandlerからの設定データ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | const char* | NULL終端のINI形式文字列 |
| *out_ini_size | size_t | 出力データのサイズ（NULL終端含まず） |

### 出力先

- 呼び出し元への戻り値として返却
- データはg.SettingsIniDataバッファに格納される

## 処理フロー

### 処理シーケンス

```
1. ダーティタイマーリセット
   └─ g.SettingsDirtyTimer = 0.0f
2. 出力バッファ初期化
   └─ g.SettingsIniData.Buf.resize(0)
   └─ g.SettingsIniData.Buf.push_back(0) - 空文字列として初期化
3. 各ハンドラのWriteAllFn呼び出し
   └─ foreach (SettingsHandler) handler.WriteAllFn()
4. サイズ出力（要求時）
   └─ *out_ini_size = g.SettingsIniData.size()
5. 文字列ポインタ返却
   └─ return g.SettingsIniData.c_str()
```

### フローチャート

```mermaid
flowchart TD
    A[SaveIniSettingsToMemory呼び出し] --> B[g.SettingsDirtyTimer = 0.0f]
    B --> C[バッファ初期化]
    C --> D[foreach SettingsHandler]
    D --> E[WriteAllFn呼び出し]
    E --> F{全ハンドラ処理完了?}
    F -->|No| D
    F -->|Yes| G{out_ini_size != NULL?}
    G -->|Yes| H[*out_ini_size = size]
    G -->|No| I[サイズ出力スキップ]
    H --> J[c_str を返却]
    I --> J
    J --> K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-249-1 | 手動保存トリガー | io.WantSaveIniSettingsがtrueの時に呼び出すべき | 手動管理時 |
| BR-249-2 | フラグクリア責任 | 呼び出し後にio.WantSaveIniSettingsをクリアする責任は呼び出し元にある | 手動管理時 |
| BR-249-3 | データ所有権 | 返却される文字列はImGuiが所有（次のSave呼び出しまで有効） | 常時 |
| BR-249-4 | 内部バッファ使用 | g.SettingsIniDataバッファを使用するためスレッドセーフでない | 常時 |

### 計算ロジック

INIデータ生成：
- 各SettingsHandlerのWriteAllFnが呼び出される
- WriteAllFnはImGuiTextBufferにINIテキストを追記
- 最終的にNULL終端文字列として返却

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

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンテキスト未初期化 | GImGuiがNULL | CreateContext()を先に呼び出す |

### リトライ仕様

リトライ処理は不要。

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

本機能はトランザクション処理を行わない。

## パフォーマンス要件

- 処理時間: 設定量に比例
- メモリ使用: INIデータサイズに比例（g.SettingsIniDataバッファ）
- 呼び出し頻度: 保存要求時

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

- INIデータにはユーザーのウィンドウレイアウト情報が含まれる
- 返却される文字列の保存方法は呼び出し元の責任
- 暗号化が必要な場合は呼び出し元で実装

## 備考

- 返却される文字列は次のSaveIniSettingsToMemory呼び出しまで有効
- 長期間保持する場合はコピーを取ること
- io.IniFilename = NULLに設定した場合の手動保存に使用

---

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

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

### 推奨読解順序

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

INI設定の保存に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiContext::SettingsIniData - INIデータバッファ |
| 1-2 | imgui.h | `imgui.h` | ImGuiIO::WantSaveIniSettings - 保存要求フラグ |
| 1-3 | imgui_internal.h | `imgui_internal.h` | ImGuiTextBuffer - テキストバッファ構造 |

**読解のコツ**: ImGuiTextBufferはImVector<char>をラップした文字列バッファ。動的に拡張可能で、appendf等のメソッドを持つ。

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

関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | SaveIniSettingsToMemory関数の実装（15488-15499行目） |

**主要処理フロー**:
1. **15490行目**: グローバルコンテキスト取得
2. **15491行目**: g.SettingsDirtyTimer = 0.0f でダーティフラグをクリア
3. **15492-15493行目**: バッファを空にして空文字列で初期化
4. **15494-15495行目**: 各ハンドラのWriteAllFnを呼び出し
5. **15496-15497行目**: out_ini_sizeが指定されている場合サイズを設定
6. **15498行目**: c_str()でNULL終端文字列を返却

#### Step 3: 設定ハンドラのWriteAllFnを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | SettingsHandlerWindow_WriteAll関数 - ウィンドウ設定の書き込み |
| 3-2 | imgui_internal.h | `imgui_internal.h` | ImGuiSettingsHandler::WriteAllFn定義 |

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

```
SaveIniSettingsToMemory(out_ini_size)
    │
    ├─ g.SettingsDirtyTimer = 0.0f
    │
    ├─ g.SettingsIniData.Buf.resize(0)
    │
    ├─ g.SettingsIniData.Buf.push_back(0)
    │
    ├─ foreach (SettingsHandler)
    │      └─ WriteAllFn(&g, &handler, &g.SettingsIniData)
    │             │
    │             ├─ SettingsHandlerWindow_WriteAll
    │             │      └─ [Window][Name] セクション出力
    │             │
    │             └─ カスタムハンドラのWriteAllFn
    │
    └─ return g.SettingsIniData.c_str()
```

### データフロー図

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

ImGuiContext               SaveIniSettingsToMemory()      呼び出し元
    │                            │                           │
    ├─ SettingsWindows ─────────▶ │                           │
    ├─ SettingsHandlers ────────▶ │ WriteAllFn呼び出し        │
    └─ その他設定 ───────────────▶ │         │                 │
                                  │         ▼                 │
                                  │ g.SettingsIniData生成     │
                                  │         │                 │
                                  └─────────┴────────────────▶ const char*
                                                              (INI文字列)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、WantSaveIniSettings定義 |
| imgui.cpp | `imgui.cpp` | ソース | SaveIniSettingsToMemory実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiTextBuffer定義 |
