# バッチ設計書 32-Makefile (example_null)

## 概要

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

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

このMakefileは、ImGuiのテスト用nullバックエンドサンプルアプリケーション「example_null」をビルドするためのクロスプラットフォーム対応ビルドスクリプトである。nullバックエンドは可視的な出力やインタラクションを持たないテスト専用の実装であり、主にCI/CD環境での継続的インテグレーションテストやコンパイル検証に使用される。

**業務上の目的・背景**：ImGuiライブラリの品質保証において、実際のグラフィックスバックエンドを必要としないビルド・テスト環境が重要である。nullバックエンドはグラフィックスAPI（OpenGL、Vulkan等）への依存なしにImGuiコアの機能をテストできるため、CI/CDパイプラインでの自動テストや、グラフィックス環境のないサーバー上でのビルド検証に最適である。また、追加の警告オプションやFreeTypeサポートのテストにも利用される。

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

**主要な処理内容**：
1. プラットフォーム検出（Linux/macOS/Windows）
2. コンパイラフラグの設定（C++11標準、警告オプション）
3. オプション機能の有効化（WITH_EXTRA_WARNINGS、WITH_FREETYPE）
4. ImGuiコアソースファイルのコンパイル
5. 実行可能ファイル「example_null」の生成

**前後の処理との関連**：このMakefileは単独で動作し、他のビルドシステムへの依存はない。CI/CDワークフロー（build.yml等）から呼び出されることを想定している。

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

## バッチ種別

ビルドスクリプト / Makefile

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| C++コンパイラ | g++またはclang++がインストールされていること |
| make | GNU Makeがインストールされていること |
| FreeType（オプション） | WITH_FREETYPE=1使用時はfreetype2がインストールされていること |

### 実行可否判定

ソースファイルが存在し、コンパイラが利用可能であれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| WITH_EXTRA_WARNINGS | 整数 | No | 0 | 追加の警告オプションを有効化（CI用） |
| WITH_FREETYPE | 整数 | No | 0 | FreeTypeサポートをテストビルドに含める |
| CXX | 文字列 | No | システム依存 | C++コンパイラの指定 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 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_freetype.cpp | C++ソース | FreeType統合（オプション） |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. プラットフォーム検出
   └─ uname -sでLinux/Darwin/Windows_NTを判定
2. コンパイルフラグ設定
   └─ C++11標準、デバッグ情報、警告オプション
3. オプション機能の適用
   └─ WITH_EXTRA_WARNINGS、WITH_FREETYPEの処理
4. オブジェクトファイル生成
   └─ 各.cppファイルを.oにコンパイル
5. リンク処理
   └─ オブジェクトファイルを結合して実行ファイル生成
6. 完了メッセージ出力
   └─ "Build complete for [Platform]"
```

### フローチャート

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

エラーメッセージを確認し、不足している依存関係をインストールするか、ソースコードを修正する。

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

該当なし

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- このサンプルは可視的な出力を持たないテスト用バックエンドである
- エンドユーザー向けではなく、CI/CDおよびテスト目的で使用される
- WITH_EXTRA_WARNINGSフラグはCI環境での警告検出に使用される
- WITH_FREETYPEフラグはLinux環境でのみサポートされる
