# 機能設計書 122-InputTextWithHint

## 概要

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

### 本機能の処理概要

InputTextWithHintは、テキスト入力ボックスが空の状態でプレースホルダーテキスト（ヒント）を表示するウィジェット関数である。ユーザーがテキストを入力すると、ヒントは自動的に非表示となり、入力されたテキストが表示される。

**業務上の目的・背景**：ユーザーインターフェースにおいて、入力フィールドの用途や期待される入力形式をユーザーに示すことは、ユーザビリティ向上の重要な要素である。InputTextWithHintは、フィールドが空のときにグレーアウトされたヒントテキストを表示することで、ラベルを追加せずにフィールドの目的を伝えることができる。HTMLの`placeholder`属性と同等の機能を提供する。

**機能の利用シーン**：
- 検索ボックス（例：「検索キーワードを入力...」）
- フォーム入力（例：「メールアドレス」「パスワード」）
- フィルタリング入力（例：「incl,-excl」形式のフィルタ構文説明）
- コマンド入力（例：「コマンドを入力してください」）

**主要な処理内容**：
1. テキスト入力ウィジェットを描画する
2. バッファが空の場合、指定されたヒントテキストを薄い色で表示する
3. ユーザー入力時はヒントを非表示にし、入力テキストを表示する
4. 通常のInputTextと同様の編集機能を提供する

**関連システム・外部連携**：std::stringを使用する場合は、misc/cpp/imgui_stdlib.hのラッパー関数を利用可能。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | Demo Window | 参照画面 | InputTextWithHintのデモ表示 |
| 13 | Property Editor | 参照画面 | フィルター入力等での使用 |

## 機能種別

テキスト入力ウィジェット / ヒント表示対応

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| label | const char* | Yes | ウィジェットの識別ラベル | NULL不可 |
| hint | const char* | Yes | バッファが空のときに表示するヒントテキスト | NULL可（空の場合ヒントなし） |
| buf | char* | Yes | テキストデータを格納するバッファ | NULL不可 |
| buf_size | size_t | Yes | バッファのサイズ（バイト数） | 1以上 |
| flags | ImGuiInputTextFlags | No | 入力動作を制御するフラグ | ImGuiInputTextFlags_Multilineは使用不可 |
| callback | ImGuiInputTextCallback | No | 入力イベントのコールバック関数 | - |
| user_data | void* | No | コールバックに渡すユーザーデータ | - |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. InputTextWithHint呼び出し
   └─ パラメータの検証（Multilineフラグが指定されていないことを確認）
2. InputTextEx内部関数を呼び出し
   └─ label, hint, buf, buf_size, ImVec2(0,0), flagsを渡す
3. ヒント表示判定
   └─ バッファが空の場合、ヒントテキストを薄い色で描画
4. テキスト編集処理
   └─ 通常のテキスト入力処理を実行
5. 入力変更の検出と戻り値の決定
   └─ テキストが変更された場合はtrueを返す
```

### フローチャート

```mermaid
flowchart TD
    A[InputTextWithHint開始] --> B{Multilineフラグ?}
    B -->|Yes| C[アサーション失敗]
    B -->|No| D[InputTextEx呼び出し]
    D --> E{バッファ空?}
    E -->|Yes| F[ヒントテキスト表示]
    E -->|No| G[入力テキスト表示]
    F --> H[キーボード入力処理]
    G --> H
    H --> I{テキスト変更?}
    I -->|Yes| J[true返却]
    I -->|No| K[false返却]
    J --> L[終了]
    K --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Multiline不可 | InputTextWithHintでは複数行モードは使用不可 | 常に適用 |
| BR-02 | ヒント表示条件 | バッファが空の場合のみヒントが表示される | 常に適用 |
| BR-03 | ヒント色 | ヒントテキストは通常テキストより薄い色（ImGuiCol_TextDisabled）で表示 | 常に適用 |

### 計算ロジック

特別な計算ロジックは存在しない。

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | アサーション失敗 | ImGuiInputTextFlags_Multilineフラグが指定された場合 | Multiline+Hintが必要な場合はInputTextEx()を直接使用 |

### リトライ仕様

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

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

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

## パフォーマンス要件

通常のInputTextと同等のパフォーマンス。ヒント表示のオーバーヘッドは無視できる程度。

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

- ImGuiInputTextFlags_Passwordフラグを使用すると、入力文字が'*'で表示される
- ヒントテキスト自体はマスクされない（パスワードフィールドでもヒントは通常表示）

## 備考

- 複数行テキスト入力でヒントを使用したい場合は、InputTextEx()を直接呼び出す必要がある
- std::stringを使用する場合は、misc/cpp/imgui_stdlib.hのInputTextWithHintラッパーを使用することを推奨

---

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

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

### 推奨読解順序

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

テキスト入力フラグの定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiInputTextFlags_の定義（行1253-1295）。InputTextWithHintで使用可能なフラグを確認 |

**読解のコツ**: InputTextWithHintは単一行専用のため、ImGuiInputTextFlags_Multilineは使用できない。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 関数宣言（行716）。hintパラメータが追加されている点に注目 |
| 2-2 | imgui_widgets.cpp | `imgui_widgets.cpp` | InputTextWithHint実装（行3963-3967）。シンプルなラッパー実装 |

**主要処理フロー**:
1. **行3965**: Multilineフラグが指定されていないことをアサート
2. **行3966**: InputTextExにhintパラメータを渡して呼び出し

#### Step 3: std::string対応を理解する

std::string用のラッパー実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui_stdlib.h | `misc/cpp/imgui_stdlib.h` | std::string用InputTextWithHint宣言（行34） |
| 3-2 | imgui_stdlib.cpp | `misc/cpp/imgui_stdlib.cpp` | std::string用InputTextWithHint実装（行84-93） |

**主要処理フロー**:
- **行84-93**: CallbackResizeを使用した動的バッファサイズ対応

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

```
ImGui::InputTextWithHint()
    │
    ├─ IM_ASSERT() [Multilineフラグチェック]
    │
    └─ ImGui::InputTextEx()
           │
           ├─ ヒント表示処理
           │      └─ バッファ空判定 → ヒントテキスト描画
           │
           └─ テキスト編集処理
                  └─ stb_textedit使用
```

### データフロー図

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

char* buf      ───▶  InputTextWithHint()
(テキストバッファ)         │
                         ▼
const char* hint ───▶  InputTextEx()
(ヒントテキスト)          │
                         ├─ バッファ空? ─▶ ヒント表示
                         │
                         └─ 入力処理   ─▶ buf更新
                              │
                              ▼
                         bool (変更有無) ───▶ 戻り値
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | 関数宣言、ImGuiInputTextFlags定義 |
| imgui_widgets.cpp | `imgui_widgets.cpp` | ソース | InputTextWithHint、InputTextExの実装 |
| imgui_stdlib.h | `misc/cpp/imgui_stdlib.h` | ヘッダー | std::string用ラッパー宣言 |
| imgui_stdlib.cpp | `misc/cpp/imgui_stdlib.cpp` | ソース | std::string用ラッパー実装 |
