# バッチ設計書 38-Makefile (example_glut_opengl2)

## 概要

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

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

このMakefileは、GLUT（OpenGL Utility Toolkit）ウィンドウシステムとOpenGL2グラフィックスAPIを組み合わせたImGuiサンプルアプリケーションをビルドするためのクロスプラットフォーム対応ビルドスクリプトである。Linux、macOS、Windows（MSYS2/MinGW）の3つの主要プラットフォームに対応し、GLUTまたはfreeglutライブラリを使用する。

**業務上の目的・背景**：GLUTは古典的なOpenGLウィンドウシステムライブラリであり、教育目的やシンプルなOpenGLアプリケーションで広く使用されてきた。GLFWやSDLに比べて機能は限定的だが、レガシーコードとの互換性や学習目的での利用に適している。ImGuiをGLUT環境に統合するための参考実装として、このサンプルは古いコードベースのモダナイゼーションに役立つ。

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

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

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

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

## バッチ種別

ビルドスクリプト / Makefile

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

GLUTライブラリと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_glut.cpp | C++ソース | GLUTバックエンド実装 |
| imgui_impl_opengl2.cpp | C++ソース | OpenGL2バックエンド実装 |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

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

### フローチャート

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

GLUTライブラリのインストール状況を確認する。
- Linux: `apt-get install freeglut3-dev`

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

該当なし

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- GLUTは古典的なウィンドウシステムライブラリでシンプルな実装
- Linux: `apt-get install freeglut3-dev`でインストール可能
- macOSではGLUTフレームワークを使用
- WindowsではMinGW環境でpkg-config経由またはfallbackで-lglutを使用
- GLFWやSDLに比べて機能が限定的だが、レガシー互換性に優れる
