# 通知設計書 32-WantSaveIniSettings

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるWantSaveIniSettingsフラグによる「INI設定保存要求通知」機能の設計を定義する。この通知機能は、手動INI管理モード（io.IniFilename == NULL）使用時に、アプリケーションに対してINI設定を保存すべきタイミングを伝達するためのものである。

### 本通知の処理概要

WantSaveIniSettingsは、ImGuiIO構造体内のboolフラグであり、ImGuiがアプリケーションに対して「INI設定を保存すべきタイミングである」ことを通知する役割を担う。このフラグはio.IniFilenameがNULL（自動ファイル保存が無効）の場合にのみ有効となる。

**業務上の目的・背景**：Dear ImGuiは通常、io.IniFilenameで指定されたファイルにウィンドウ位置やサイズなどの設定を自動保存する。しかし、Webアプリケーション、暗号化ストレージ、クラウド保存など、ファイルシステム以外への保存が必要な場合がある。このような場合、アプリケーション側でINI設定の保存タイミングを知る必要があり、WantSaveIniSettingsフラグがその通知手段となる。

**通知の送信タイミング**：設定に変更が加えられてから一定時間（io.IniSavingRate、デフォルト5秒）経過後、io.IniFilenameがNULLの場合に自動的にtrueに設定される。具体的には、SettingsDirtyTimerが0になったタイミングで設定される。

**通知の受信者**：アプリケーション開発者が受信者となる。アプリケーションはメインループ内でこのフラグを監視し、trueになった場合にSaveIniSettingsToMemory()を呼び出して設定を取得し、独自の方法で保存する。

**通知内容の概要**：フラグ自体はbool値のみを持つ。アプリケーションはSaveIniSettingsToMemory()を呼び出すことで、実際のINI設定文字列を取得できる。

**期待されるアクション**：アプリケーションは、このフラグがtrueになったことを検知したら、SaveIniSettingsToMemory()を呼び出してINIデータを取得し、独自のストレージ（ローカルストレージ、データベース、クラウドなど）に保存する。保存完了後、アプリケーションは必ずio.WantSaveIniSettingsをfalseにクリアする必要がある。

## 通知種別

アプリ内通知（フラグベース通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（フラグ監視型） |
| 優先度 | 中 |
| リトライ | 無（フラグは手動クリアまで維持） |

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

io.IniFilenameがNULLに設定されている場合のみ、フラグが設定される。ファイル名が指定されている場合は自動ファイル保存が行われるため、このフラグは使用されない。

## 通知テンプレート

### フラグ仕様

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

### 使用例

```cpp
// メインループ内でフラグを監視
if (io.WantSaveIniSettings)
{
    // INIデータを取得
    const char* ini_data = ImGui::SaveIniSettingsToMemory();

    // 独自の保存処理（例：ローカルストレージに保存）
    SaveToStorage(ini_data);

    // 重要：フラグをクリア
    io.WantSaveIniSettings = false;
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| WantSaveIniSettings | 保存要求フラグ | ImGuiIO | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| タイマー | SettingsDirtyTimer == 0 | io.IniFilename == NULL | 設定変更後、一定時間経過 |
| 設定変更 | ウィンドウ移動/リサイズ等 | MarkIniSettingsDirty()呼び出し後 | 設定ダーティフラグが立つ |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| io.IniFilenameが設定されている | 自動ファイル保存が有効な場合、このフラグは使用されない |
| 設定に変更がない | SettingsDirtyTimerが設定されていない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[設定変更発生] --> B[MarkIniSettingsDirty呼び出し]
    B --> C[SettingsDirtyTimer = IniSavingRate]
    C --> D[毎フレームタイマー減算]
    D --> E{SettingsDirtyTimer <= 0?}
    E -->|No| D
    E -->|Yes| F{io.IniFilename != NULL?}
    F -->|Yes| G[SaveIniSettingsToDisk]
    F -->|No| H[WantSaveIniSettings = true]
    G --> I[SettingsDirtyTimer = 0]
    H --> I
    I --> J[アプリがフラグ監視]
    J --> K{WantSaveIniSettings?}
    K -->|No| J
    K -->|Yes| L[SaveIniSettingsToMemory呼び出し]
    L --> M[独自保存処理]
    M --> N[WantSaveIniSettings = false]
    N --> O[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ImGuiIO | I/O設定 | WantSaveIniSettingsフラグ |
| ImGuiContext | コンテキスト | SettingsDirtyTimer管理 |

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

#### ImGuiIO

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| IniFilename | 自動保存有効判定 | NULLかどうか |
| IniSavingRate | 保存遅延時間 | タイマー初期値 |

#### ImGuiContext

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| SettingsDirtyTimer | 保存タイミング管理 | 毎フレーム減算 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ImGuiIO | UPDATE | WantSaveIniSettingsフラグを設定 |
| ImGuiContext | UPDATE | SettingsDirtyTimerをリセット |

#### ImGuiIO更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | WantSaveIniSettings | true | ImGui内部で設定 |
| UPDATE | WantSaveIniSettings | false | アプリケーション側でクリア必須 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| フラグ未クリア | アプリがフラグをクリアしない | 次回変更まで通知が滞留する（データ損失のリスク） |
| 保存失敗 | SaveIniSettingsToMemory失敗 | アプリケーション側でリトライ処理を実装 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | アプリケーション実装に依存 |
| リトライ間隔 | アプリケーション実装に依存 |
| リトライ対象エラー | 保存先ストレージエラー等 |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | io.IniSavingRate（デフォルト5秒）に依存 |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（設定変更後の遅延時間経過後に発生）

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

- INI設定には個人情報は含まれないが、ウィンドウ配置情報などのユーザー行動が推測可能な情報が含まれる
- 暗号化ストレージへの保存が必要な場合は、アプリケーション側で暗号化を実装

## 備考

- アプリケーションは必ずフラグをクリアする責任を負う
- フラグをクリアしないと、次の設定変更まで通知が再発行されない
- SaveIniSettingsToMemory()で返される文字列はImGuiが所有しており、次のSave呼び出しまで有効
- 通常はNewFrame()の前にフラグを確認し、処理するのが推奨される

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | 2540行目：WantSaveIniSettingsフラグの定義とコメント |
| 1-2 | imgui.h | `imgui.h` | 1124-1131行目：Settings/.Ini Utilitiesセクションの説明 |
| 1-3 | imgui_internal.h | `imgui_internal.h` | SettingsDirtyTimer、SettingsIniDataの定義 |

**読解のコツ**: WantSaveIniSettingsはImGuiIO構造体の「Output」セクション（NewFrame/EndFrameで更新される部分）に属している。

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

フラグが設定される処理の起点を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | 15324-15337行目：UpdateSettings関数内でのフラグ設定処理 |
| 2-2 | imgui.cpp | `imgui.cpp` | 15339-15344行目：MarkIniSettingsDirty関数 |

**主要処理フロー**:
1. **15325行目**: SettingsDirtyTimerが0より大きいか確認
2. **15327行目**: タイマーからDeltaTimeを減算
3. **15328行目**: タイマーが0以下になったか確認
4. **15330-15333行目**: IniFilenameがNULLならWantSaveIniSettingsをtrue、そうでなければファイル保存

#### Step 3: 関連APIを理解する

フラグと連携して使用されるAPI関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.h | `imgui.h` | 1131行目：SaveIniSettingsToMemory関数宣言 |
| 3-2 | imgui.cpp | `imgui.cpp` | SaveIniSettingsToMemory関数実装 |

**主要処理フロー**:
- SaveIniSettingsToMemory()はWantSaveIniSettingsがtrueの時に呼び出すべき関数
- 返却される文字列でINIデータを取得し、独自の方法で保存

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

```
[設定変更発生]
    |
    +-- MarkIniSettingsDirty()
            |
            +-- SettingsDirtyTimer = IniSavingRate (5秒)
                    |
                    [毎フレーム]
                    |
                    +-- UpdateSettings() (imgui.cpp:15324)
                            |
                            +-- SettingsDirtyTimer -= DeltaTime
                            |
                            +-- if (SettingsDirtyTimer <= 0)
                                    |
                                    +-- if (IniFilename != NULL)
                                    |       |
                                    |       +-- SaveIniSettingsToDisk()
                                    |
                                    +-- else
                                            |
                                            +-- WantSaveIniSettings = true
                                                    |
                                                    [アプリケーション側]
                                                    |
                                                    +-- SaveIniSettingsToMemory()
                                                    +-- 独自保存処理
                                                    +-- WantSaveIniSettings = false
```

### データフロー図

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

設定変更 ---------> MarkIniSettingsDirty ---> SettingsDirtyTimer設定
                           |
                           v
                    UpdateSettings
                           |
                           +-- タイマー減算
                           |
                           v
                    タイマー == 0
                           |
                    +------+------+
                    |             |
                    v             v
            IniFilename      IniFilename
            != NULL          == NULL
                    |             |
                    v             v
            ファイル保存   WantSaveIniSettings = true
                                  |
                                  v
                          [アプリケーション]
                                  |
                                  v
                          SaveIniSettingsToMemory()
                                  |
                                  v
                          独自ストレージへ保存
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | WantSaveIniSettings定義（2540行目）、SaveIniSettingsToMemory宣言（1131行目） |
| imgui.cpp | `imgui.cpp` | ソース | UpdateSettings実装（15324-15337行目）、フラグ設定処理 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | SettingsDirtyTimer、SettingsIniData定義 |
