# バッチ設計書 39-Makefile (example_sdl2_opengl2)

## 概要

本ドキュメントは、ImGuiプロジェクトにおけるSDL2 + OpenGL2サンプル「example_sdl2_opengl2」のMakefileビルドシステムの設計仕様を記述するものである。

### 本バッチの処理概要

このMakefileは、SDL2（Simple DirectMedia Layer 2）マルチメディアライブラリとOpenGL2グラフィックスAPIを組み合わせたImGuiサンプルアプリケーションをビルドするためのクロスプラットフォーム対応ビルドスクリプトである。Linux、macOS、Windows（MSYS2/MinGW）の3つの主要プラットフォームに対応し、sdl2-configコマンドまたはpkg-configを使用してSDL2の設定を自動検出する。

**業務上の目的・背景**：SDL2は広く使用されているクロスプラットフォームマルチメディアライブラリであり、ゲーム開発やマルチメディアアプリケーションで標準的に採用されている。OpenGL2との組み合わせは、レガシーハードウェアとの互換性を維持しながらSDL2の機能を活用するアプリケーションに適している。ImGuiをSDL2 + OpenGL2環境に統合するための標準的なリファレンス実装として重要である。

**バッチの実行タイミング**：開発者による手動実行、またはCI/CDパイプラインでの自動実行時。

**主要な処理内容**：
1. プラットフォーム検出（Linux/macOS/Windows）
2. SDL2ライブラリの検出とリンク設定（sdl2-config/pkg-config）
3. OpenGLライブラリのリンク設定
4. ImGuiコアおよびバックエンドソースのコンパイル
5. 実行可能ファイル「example_sdl2_opengl2」の生成

**前後の処理との関連**：SDL2ライブラリが事前にインストールされている必要がある。

**影響範囲**：ローカルビルド環境にexample_sdl2_opengl2実行ファイルとオブジェクトファイルを生成する。

## バッチ種別

ビルドスクリプト / Makefile

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / CI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| C++コンパイラ | g++またはclang++がインストールされていること |
| make | GNU Makeがインストールされていること |
| SDL2 | SDL2ライブラリがインストールされていること |
| OpenGL | OpenGLライブラリが利用可能であること |

### 実行可否判定

SDL2ライブラリとOpenGLライブラリが利用可能であれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CXX | 文字列 | No | システム依存 | C++コンパイラの指定（g++/clang++） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| main.cpp | C++ソース | サンプルアプリケーションのメインファイル |
| imgui.cpp | C++ソース | ImGuiコアライブラリ |
| imgui_demo.cpp | C++ソース | ImGuiデモ機能 |
| imgui_draw.cpp | C++ソース | ImGui描画機能 |
| imgui_tables.cpp | C++ソース | ImGuiテーブル機能 |
| imgui_widgets.cpp | C++ソース | ImGuiウィジェット機能 |
| imgui_impl_sdl2.cpp | C++ソース | SDL2バックエンド実装 |
| imgui_impl_opengl2.cpp | C++ソース | OpenGL2バックエンド実装 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| example_sdl2_opengl2 | 実行ファイル | ビルドされたサンプルアプリケーション |
| *.o | オブジェクトファイル | コンパイル中間生成物 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | example_sdl2_opengl2 |
| 出力先 | examples/example_sdl2_opengl2/ |
| 文字コード | バイナリ |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. プラットフォーム検出
   └─ uname -sでLinux/Darwin/Windows_NTを判定
2. SDL2ライブラリ設定
   └─ sdl2-configまたはpkg-configでSDL2設定を取得
3. OpenGLライブラリ設定
   └─ プラットフォーム固有のOpenGLリンク設定
4. コンパイルフラグ設定
   └─ C++11標準、インクルードパス、警告オプション
5. オブジェクトファイル生成
   └─ 各.cppファイルを.oにコンパイル
6. リンク処理
   └─ SDL2、OpenGLとリンクして実行ファイル生成
7. 完了メッセージ出力
   └─ "Build complete for [Platform]"
```

### フローチャート

```mermaid
flowchart TD
    A[make実行] --> B[プラットフォーム検出]
    B --> C{OS判定}
    C -->|Linux| D[Linux: sdl2-config + -lGL]
    C -->|macOS| E[macOS: sdl2-config + framework OpenGL]
    C -->|Windows| F[MinGW: pkg-config sdl2]
    D --> G[ソースコンパイル]
    E --> G
    F --> G
    G --> H[リンク処理]
    H --> I[example_sdl2_opengl2生成]
    I --> J[完了]
```

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

該当なし（データベース操作を行わないビルドスクリプト）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コンパイルエラー | ソースコードの構文エラー | エラーメッセージを確認し修正 |
| 1 | リンクエラー | SDL2/OpenGLライブラリ不足 | 必要なライブラリをインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

SDL2ライブラリのインストール状況を確認する。
- Linux: `apt-get install libsdl2-dev`
- macOS: `brew install sdl2`
- MSYS2: `pacman -S mingw-w64-i686-SDL2`

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

該当なし

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8ファイルのコンパイル |
| 目標処理時間 | 数秒〜1分程度 |
| メモリ使用量上限 | 通常のコンパイル処理に依存 |

## 排他制御

同一ディレクトリでの並列make実行は非推奨。`make -j`オプションで並列コンパイルは可能。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | ビルド完了時 | "Build complete for [Platform]" |
| エラーログ | エラー発生時 | コンパイラのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルド失敗 | 1回 | CI/CD通知 |

## 備考

- SDL2は広く使用されるクロスプラットフォームマルチメディアライブラリ
- Linux/macOSではsdl2-configコマンドで設定を取得
- WindowsではMinGW環境でpkg-configを使用
- Linuxでは-ldl（動的リンク）も必要
- macOSではCocoa/IOKit/CoreVideoフレームワークも必要
