# 機能設計書 6-GetPlatformIO

## 概要

本ドキュメントはDear ImGuiライブラリのGetPlatformIO関数に関する機能設計書である。GetPlatformIOはImGuiPlatformIO構造体への参照を取得し、プラットフォーム/レンダラーバックエンドとの接続インターフェースにアクセスする関数である。

### 本機能の処理概要

GetPlatformIO関数は、現在のImGuiコンテキストに含まれるImGuiPlatformIO構造体への参照を返す。この構造体はプラットフォーム固有のフック（クリップボード、IME等）やバックエンド連携機能へのアクセスを提供する。

**業務上の目的・背景**：ImGuiライブラリはプラットフォーム非依存で設計されており、クリップボードアクセスやIME（入力メソッドエディタ）などのプラットフォーム固有機能はPlatformIO構造体を通じてフック関数として提供される。これにより、バックエンド実装者はプラットフォーム固有の機能をImGuiに統合できる。Dockingブランチではマルチビューポートサポートのために拡張されている。

**機能の利用シーン**：
- クリップボード操作のカスタム実装設定
- IME（Input Method Editor）のカスタム実装設定
- マルチビューポートのプラットフォーム連携（Dockingブランチ）
- プラットフォーム固有コールバックの登録

**主要な処理内容**：
1. 現在のコンテキストの存在確認（アサート）
2. GImGui->PlatformIOへの参照を返す

**関連システム・外部連携**：
- OSクリップボード機能
- IME（日本語入力等）
- マルチビューポート（Dockingブランチ）
- プラットフォームバックエンド

**権限による制御**：特になし

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 全ての画面のプラットフォーム連携基盤 |

## 機能種別

データアクセス / プラットフォーム連携

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | 引数なし | - |

### 入力データソース

- GImGuiグローバル変数（現在のコンテキスト）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImGuiPlatformIO& | 現在のコンテキストのImGuiPlatformIO構造体への参照 |

### 出力先

- 呼び出し元への参照返却

## 処理フロー

### 処理シーケンス

```
1. コンテキスト存在確認
   └─ IM_ASSERTでGImGui != NULLを確認

2. PlatformIO構造体参照を返す
   └─ return GImGui->PlatformIO;
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{GImGui != NULL?}
    B -->|Yes| C[GImGui->PlatformIOを返す]
    B -->|No| D[アサート失敗]
    C --> E[終了]
    D --> F[プログラム停止]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | コンテキスト必須 | CreateContextが呼ばれていない場合、アサート失敗 | GImGui == NULL |
| BR-02 | 参照返却 | コピーではなく参照を返すため、変更が即座に反映される | 常に |
| BR-03 | マルチスレッド対応 | コンテキスト引数付きオーバーロード(GetPlatformIO(ctx))が存在 | マルチスレッド時 |

### 計算ロジック

特になし

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT | アサート失敗 | コンテキストが存在しない | CreateContext()を呼び出す |

### リトライ仕様

特になし

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

該当なし

## パフォーマンス要件

- インライン可能な非常に軽量な関数
- バックエンド初期化時に主に使用

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

- クリップボード操作は機密情報に関わる可能性があるため注意

## 備考

- ImGuiPlatformIOはImGuiIOを拡張する構造体
- Dockingブランチではマルチビューポート関連の機能が追加されている
- プラットフォームバックエンドの実装者向けの機能

---

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

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

### 推奨読解順序

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

ImGuiPlatformIO構造体はプラットフォーム連携のためのフック関数を保持する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiPlatformIO構造体の定義。Platform_XXX, Renderer_XXXメンバ |

**読解のコツ**: ImGuiPlatformIOは以下のカテゴリに分類される:
- **プラットフォームフック**: Platform_GetClipboardText, Platform_SetClipboardText, Platform_SetImeDataFn等
- **レンダラーフック**: Renderer_XXX関数（Dockingブランチ）
- **ビューポート関連**: Viewports配列等（Dockingブランチ）

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 399行目: GetPlatformIOのAPI宣言 |
| 2-2 | imgui.cpp | `imgui.cpp` | 5120-5124行目: GetPlatformIO関数の実装 |

**主要処理フロー**:
1. **5122行目**: コンテキスト確認 `IM_ASSERT(GImGui != NULL && "No current context...")`
2. **5123行目**: PlatformIO返却 `return GImGui->PlatformIO;`

#### Step 3: マルチスレッド対応オーバーロードを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 5127-5131行目: GetPlatformIO(ImGuiContext* ctx)オーバーロード |

**読解のコツ**:
- GetIO同様、マルチスレッド環境向けのオーバーロードが提供されている

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

```
ImGui::GetPlatformIO()
    │
    ├─ IM_ASSERT(GImGui != NULL)
    │
    └─ return GImGui->PlatformIO
```

### データフロー図

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

（なし）                  GetPlatformIO() ─────────────────▶ ImGuiPlatformIO&
                                   │                         (GImGui->PlatformIOの参照)
                                   │
                                   ▼
                          GImGui->PlatformIOへの
                          参照を返す
```

### ImGuiPlatformIO構造体の主要メンバ

| カテゴリ | メンバ名 | 説明 |
|---------|---------|------|
| クリップボード | Platform_GetClipboardTextFn | クリップボードテキスト取得関数 |
| クリップボード | Platform_SetClipboardTextFn | クリップボードテキスト設定関数 |
| IME | Platform_SetImeDataFn | IMEデータ設定関数 |
| ユーザーデータ | Platform_ClipboardUserData | クリップボード用ユーザーデータ |

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | パブリックAPI宣言（399行目）、ImGuiPlatformIO構造体定義 |
| imgui.cpp | `imgui.cpp` | ソース | 実装（5120-5124行目） |
| imgui.cpp | `imgui.cpp` | ソース | マルチスレッド版（5127-5131行目） |
