# 機能設計書 88-TextWrapped

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるTextWrapped関数の機能設計を定義する。TextWrappedは、ウィンドウの幅に合わせて自動的に折り返しを行うフォーマット付きテキストを表示する機能である。

### 本機能の処理概要

TextWrapped関数は、テキストがウィンドウの利用可能な幅を超えた場合に自動的に次の行に折り返して表示する機能を提供する。内部的にはPushTextWrapPos/PopTextWrapPosでテキスト折り返し位置を一時的に設定してText関数を呼び出すショートカット関数である。

**業務上の目的・背景**：GUIアプリケーションにおいて、長い説明文やヘルプテキストを表示する場合、ウィンドウ幅に合わせて自動的に折り返されることが期待される。TextWrappedを使用することで、ウィンドウサイズの変更にも動的に対応し、読みやすいテキスト表示を実現できる。

**機能の利用シーン**：
- ヘルプテキストや説明文を表示する場合
- ツールチップ内の長いテキストを表示する場合
- プロパティやオプションの詳細説明を表示する場合
- ユーザーへのメッセージを読みやすく表示する場合
- 固定幅のテキストエリアで折り返しを有効にする場合

**主要な処理内容**：
1. 既存の折り返し設定をバックアップするかどうか判定
2. PushTextWrapPos(0.0f)でウィンドウ右端での折り返しを設定
3. TextV関数でフォーマット付きテキストを描画
4. PopTextWrapPos()で設定を復元（バックアップが必要だった場合）

**関連システム・外部連携**：ImGuiContext、ImGuiWindowTempData（TextWrapPos）、ImDrawList

**権限による制御**：なし。すべてのImGuiユーザーが利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 全画面 | 補助機能 | 折り返しテキストの表示 |

## 機能種別

表示機能 / テキストウィジェット

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| fmt | const char* | Yes | printf形式のフォーマット文字列 | NULLチェックなし |
| ... | 可変長引数 | No | フォーマット引数 | フォーマット文字列に対応 |

### 入力データソース

- 呼び出し元コードからの直接入力
- 現在のウィンドウの利用可能幅（自動折り返し位置として使用）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (なし) | void | 戻り値なし。描画コマンドが生成される |

### 出力先

ImDrawList（ウィンドウの描画リスト）

## 処理フロー

### 処理シーケンス

```
1. 可変長引数の初期化
   └─ va_start(args, fmt)
2. TextWrappedV関数の呼び出し
   └─ 実際の処理をTextWrappedVに委譲
3. 可変長引数の終了
   └─ va_end(args)

TextWrappedV内部処理:
4. グローバルコンテキストの取得
   └─ ImGuiContext& g = *GImGui
5. バックアップ必要性の判定
   └─ 現在のTextWrapPosが0未満の場合はバックアップが必要
6. 折り返し位置のプッシュ（バックアップが必要な場合）
   └─ PushTextWrapPos(0.0f)
7. TextV関数の呼び出し
   └─ フォーマット付きテキストの描画
8. 折り返し位置のポップ（バックアップが必要だった場合）
   └─ PopTextWrapPos()
```

### フローチャート

```mermaid
flowchart TD
    A[TextWrapped開始] --> B[va_start]
    B --> C[TextWrappedV呼び出し]
    C --> D[GImGuiからコンテキスト取得]
    D --> E{TextWrapPos < 0?}
    E -->|Yes| F[need_backup = true]
    E -->|No| G[need_backup = false]
    F --> H[PushTextWrapPos 0.0f]
    G --> I[TextV呼び出し]
    H --> I
    I --> J{need_backup?}
    J -->|Yes| K[PopTextWrapPos]
    J -->|No| L[va_end]
    K --> L
    L --> M[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 折り返し位置 | 0.0fはウィンドウ右端での折り返しを意味する | 常時 |
| BR-02 | 既存設定の尊重 | 既に折り返し設定がある場合はそれを維持 | TextWrapPos >= 0の場合 |
| BR-03 | 自動リサイズ注意 | 自動リサイズウィンドウでは他のウィジェットが必要 | 自動リサイズ時 |

### 計算ロジック

- 折り返し幅はCalcWrapWidthForPos関数で計算される
- 0.0fはウィンドウの利用可能幅（ContentRegionAvail）を意味する

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

該当なし（メモリ内操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 通常エラーは発生しない | - |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- PushTextWrapPos/PopTextWrapPosのオーバーヘッドあり（微小）
- 折り返し計算のオーバーヘッドあり
- Text関数と同等のフォーマット処理オーバーヘッド
- 1フレーム内で多数回呼び出し可能

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

- Text関数と同様、ユーザー入力をフォーマット文字列として直接使用しないこと

## 備考

- 自動リサイズウィンドウ（ImGuiWindowFlags_AlwaysAutoResize）では、他のウィジェットがないと幅を広げる要素がないため、SetNextWindowSize()等でサイズを指定する必要がある
- PushTextWrapPos(0.0f) + Text(...) + PopTextWrapPos() のショートカット
- TextWrappedVはva_list版
- IM_FMTARGS(1)マクロによりコンパイラのフォーマット文字列チェックが有効
- 既にPushTextWrapPosで折り返しが設定されている場合、その設定が維持される

---

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

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

### 推奨読解順序

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

折り返し位置の管理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui_internal.h | `imgui_internal.h` | ImGuiWindowTempData構造体のTextWrapPosメンバ |

**読解のコツ**: TextWrapPosは負の値で「折り返しなし」、0以上で「折り返し有効」を意味する。0.0fはウィンドウ右端での折り返しを意味する。

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

TextWrapped関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | TextWrapped/TextWrappedV関数宣言（621-622行目） |
| 2-2 | imgui_widgets.cpp | `imgui_widgets.cpp` | TextWrapped/TextWrappedV関数実装（323-340行目） |

**主要処理フロー**:
1. **323-329行目**: TextWrapped関数 - va_startで可変長引数を初期化し、TextWrappedVを呼び出し、va_endで終了
2. **331-340行目**: TextWrappedV関数
   - **333行目**: ImGuiContext& g = *GImGui でグローバルコンテキストを取得
   - **334行目**: need_backup判定（現在のTextWrapPosが0未満の場合）
   - **335-336行目**: バックアップが必要ならPushTextWrapPos(0.0f)
   - **337行目**: TextVでテキスト描画
   - **338-339行目**: バックアップが必要だった場合はPopTextWrapPos()

#### Step 3: 折り返し処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | PushTextWrapPos/PopTextWrapPos関数 |
| 3-2 | imgui.cpp | `imgui.cpp` | CalcWrapWidthForPos関数 |

**主要処理フロー**:
- PushTextWrapPos: 折り返し位置をスタックにプッシュ
- CalcWrapWidthForPos: 実際の折り返し幅を計算

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

```
ImGui::TextWrapped(fmt, ...)
    │
    ├─ va_start(args, fmt)
    │
    └─ ImGui::TextWrappedV(fmt, args)
           │
           ├─ GImGui（グローバルコンテキスト）
           │
           ├─ need_backup = (TextWrapPos < 0.0f)
           │
           ├─ if(need_backup) PushTextWrapPos(0.0f)
           │
           ├─ TextV(fmt, args)
           │      │
           │      └─ TextEx() → CalcWrapWidthForPos() → RenderTextWrapped()
           │
           └─ if(need_backup) PopTextWrapPos()
```

### データフロー図

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

fmt + ...   ───▶ 折り返し設定 ───▶ TextV ───▶ 折り返し復元 ───▶ 描画コマンド
                      │
                      └── TextWrapPos スタック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | TextWrapped/TextWrappedV関数の宣言（621-622行目） |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | TextWrapped/TextWrappedV関数の実装（323-340行目） |
| imgui.cpp | `imgui.cpp` | ソース | PushTextWrapPos/PopTextWrapPos関数 |
| imgui_internal.h | `imgui_internal.h` | 内部ヘッダー | ImGuiWindowTempData構造体（TextWrapPos） |
