# 機能設計書 121-InputTextMultiline

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける複数行テキスト入力機能「InputTextMultiline」の設計仕様を定義する。

### 本機能の処理概要

InputTextMultilineは、複数行のテキスト入力ボックスを作成するウィジェット関数である。単一行のInputTextとは異なり、改行を含むテキストの入力・編集が可能で、垂直スクロール機能を内蔵している。

**業務上の目的・背景**：GUIアプリケーションにおいて、複数行のテキストデータ（説明文、コメント、ソースコード、ログ等）を入力・編集する必要がある場面は頻繁に発生する。InputTextMultilineは、そのような複数行テキスト編集のニーズに対応するために設計された。独立したスクロール領域を持つため、大量のテキストでも効率的に編集できる。

**機能の利用シーン**：
- コンソールアプリケーションのログ表示・編集画面
- ソースコードエディタ
- 設定ファイルやINIファイルの編集
- 複数行のコメント・説明文入力フィールド
- チャットアプリケーションのメッセージ入力欄

**主要な処理内容**：
1. 複数行対応のテキスト入力ウィジェットを描画する
2. 子ウィンドウを作成し、独立したスクロール領域を提供する
3. キーボード入力をUTF-8テキストとして処理する
4. カーソル移動、選択、コピー&ペースト等の編集機能を提供する
5. ワードラップ機能をオプションで提供する（ImGuiInputTextFlags_WordWrap）

**関連システム・外部連携**：std::stringを使用する場合は、misc/cpp/imgui_stdlib.hのラッパー関数を利用可能。コールバック機能により、入力内容のフィルタリングやリサイズ処理をカスタマイズできる。

**権限による制御**：ImGuiInputTextFlags_ReadOnlyフラグにより読み取り専用モードを指定可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | Demo Window | 参照画面 | InputTextMultilineのデモ表示 |
| 10 | Console | 参照画面 | ログ表示領域として使用 |

## 機能種別

テキスト入力ウィジェット / 複数行対応

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| label | const char* | Yes | ウィジェットの識別ラベル | NULL不可 |
| buf | char* | Yes | テキストデータを格納するバッファ | NULL不可 |
| buf_size | size_t | Yes | バッファのサイズ（バイト数） | 1以上 |
| size | ImVec2 | No | ウィジェットの表示サイズ（デフォルト: 0,0 = 自動計算） | - |
| flags | ImGuiInputTextFlags | No | 入力動作を制御するフラグ | ImGuiInputTextFlags_Multilineは自動設定 |
| callback | ImGuiInputTextCallback | No | 入力イベントのコールバック関数 | - |
| user_data | void* | No | コールバックに渡すユーザーデータ | - |

### 入力データソース

ユーザーが提供するchar型バッファ（buf）に対して直接編集を行う。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | bool | テキストが変更された場合にtrue |
| buf | char* | 編集されたテキストデータ（入力パラメータを直接更新） |

### 出力先

提供されたバッファ（buf）に編集結果が直接書き込まれる。

## 処理フロー

### 処理シーケンス

```
1. InputTextMultiline呼び出し
   └─ ImGuiInputTextFlags_Multilineフラグを自動的に追加
2. InputTextEx内部関数を呼び出し
   └─ label, NULL(hint), buf, buf_size, size, flags | Multilineフラグを渡す
3. 子ウィンドウを作成しスクロール領域を確保
   └─ BeginChildFrame()でフレーム付き子ウィンドウを作成
4. テキスト編集処理
   └─ stb_texteditライブラリを使用した編集エンジン
5. 描画処理
   └─ テキストをレンダリングし、カーソルと選択範囲を表示
6. 入力変更の検出と戻り値の決定
   └─ テキストが変更された場合はtrueを返す
```

### フローチャート

```mermaid
flowchart TD
    A[InputTextMultiline開始] --> B[Multilineフラグを追加]
    B --> C[InputTextEx呼び出し]
    C --> D[子ウィンドウ作成]
    D --> E{キーボード入力あり?}
    E -->|Yes| F[テキスト編集処理]
    E -->|No| G[描画処理]
    F --> H{テキスト変更?}
    H -->|Yes| I[バッファ更新]
    H -->|No| G
    I --> G
    G --> J[戻り値を返す]
    J --> K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Multilineフラグ自動設定 | ImGuiInputTextFlags_Multilineフラグは関数内で自動的に追加される | 常に適用 |
| BR-02 | 改行文字の処理 | Enterキーで改行が挿入される（Ctrl+Enterモードの場合は逆） | ImGuiInputTextFlags_CtrlEnterForNewLineの有無 |
| BR-03 | ワードラップ | テキストが領域幅を超える場合に自動折り返し | ImGuiInputTextFlags_WordWrap指定時 |

### 計算ロジック

サイズが(0,0)で指定された場合、自動的に適切なサイズが計算される。

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション失敗 | 単一行用のInputText()でMultilineフラグが指定された場合 | InputTextMultiline()を使用する |
| - | バッファオーバーフロー | バッファサイズを超える入力 | CallbackResizeを使用してバッファを動的に拡張 |

### リトライ仕様

リトライ機能は提供されない。

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

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

## パフォーマンス要件

- ワードラップ機能（ImGuiInputTextFlags_WordWrap）使用時は、通常のテキストフィールドより処理コストが高くなる
- 参考値: 100KBのテキストバッファで最適化ビルド時+約0.3ms、デバッグビルド時+約1.0ms
- 処理コストはテキスト長にほぼ比例する

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

- ImGuiInputTextFlags_Passwordフラグを使用すると、全ての文字が'*'で表示される
- パスワードモード時はコピー操作が無効化される

## 備考

- std::stringを使用する場合は、misc/cpp/imgui_stdlib.hのInputTextMultilineラッパーを使用することを推奨
- ImGuiInputTextFlags_CallbackResizeを使用することで、動的なバッファサイズ変更に対応可能

---

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

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

### 推奨読解順序

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

まず、テキスト入力で使用されるデータ構造とフラグを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiInputTextFlags_の定義（行1253-1295）。特にMultiline、WordWrap、CtrlEnterForNewLineフラグを確認 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiInputTextState構造体。テキスト編集状態を管理するデータ構造 |

**読解のコツ**: ImGuiInputTextFlags_Multilineは内部フラグ（行1025）として定義されており、ユーザーが直接指定することは想定されていない。

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

処理の起点となるInputTextMultiline関数を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 関数宣言（行715）。パラメータと戻り値の仕様を確認 |
| 2-2 | imgui_widgets.cpp | `imgui_widgets.cpp` | InputTextMultiline実装（行3958-3961）。非常にシンプルなラッパー |

**主要処理フロー**:
1. **行3958-3961**: InputTextMultilineはInputTextExへのシンプルなラッパー
2. **行3960**: ImGuiInputTextFlags_Multilineフラグを自動追加してInputTextExを呼び出し

#### Step 3: コア実装を理解する

InputTextExが実際の処理を行う。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_widgets.cpp | `imgui_widgets.cpp` | InputTextEx関数。複数行処理、スクロール、テキスト編集の実装 |
| 3-2 | imstb_textedit.h | `imstb_textedit.h` | stb_texteditライブラリ。テキスト編集エンジン |

**主要処理フロー**:
- **行3982-4091**: stb_texteditのコールバック関数群（STB_TEXTEDIT_*）の実装
- **行4094-4166**: ワードラップ対応の行移動処理（STB_TEXTEDIT_MOVELINESTART_IMPL, STB_TEXTEDIT_MOVELINEEND_IMPL）

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

```
ImGui::InputTextMultiline()
    │
    └─ ImGui::InputTextEx()
           │
           ├─ BeginChildFrame() [Multiline時のみ]
           │      └─ スクロール可能な子ウィンドウを作成
           │
           ├─ ImStb名前空間
           │      ├─ STB_TEXTEDIT_STRINGLEN()
           │      ├─ STB_TEXTEDIT_GETCHAR()
           │      ├─ STB_TEXTEDIT_LAYOUTROW()
           │      └─ stb_textedit_*() [編集操作]
           │
           └─ EndChildFrame() [Multiline時のみ]
```

### データフロー図

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

char* buf      ───▶  InputTextMultiline()
(テキストバッファ)         │
                         ▼
                    InputTextEx()
                         │
ImVec2 size    ───▶     │
(ウィジェットサイズ)       │
                         ▼
                    子ウィンドウ作成
                         │
キーボード入力  ───▶     │
                         ▼
                    stb_textedit処理  ───▶  buf更新
                         │                   (テキスト変更)
                         ▼
                    描画処理        ───▶  画面表示
                         │
                         ▼
                    bool (変更有無)  ───▶  戻り値
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、ImGuiInputTextFlags定義 |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | InputTextMultiline、InputTextExの実装 |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiInputTextState構造体、内部フラグ定義 |
| imstb_textedit.h | `imstb_textedit.h` | ヘッダー | stb_texteditライブラリ（テキスト編集エンジン） |
| imgui_stdlib.h | `misc/cpp/imgui_stdlib.h` | ヘッダー | std::string用ラッパー宣言 |
| imgui_stdlib.cpp | `misc/cpp/imgui_stdlib.cpp` | ソース | std::string用ラッパー実装 |
