# バッチ設計書 49-Makefile (example_sdl3_metal)

## 概要

本ドキュメントは、ImGuiライブラリのSDL3 + MetalサンプルをビルドするためのmacOS専用Makefileについて記述したバッチ設計書である。

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

このMakefileは、SDL3をウィンドウシステムとして、AppleのMetalをグラフィックスバックエンドとして使用するImGuiサンプルアプリケーションをビルドする処理を行う。macOS専用のビルド設定となっている。

**業務上の目的・背景**：SDL3は次世代のSDLライブラリであり、MetalはAppleが開発した高性能グラフィックスAPIである。ImGuiをSDL3とMetal環境で使用する開発者向けに、参照実装を提供することで、最新のSDL3とMetalを組み合わせたmacOS上でのImGui活用方法を示す。SDL3はまだ開発中であるが、将来のSDL3正式リリースに備えた実装を提供している。

**バッチの実行タイミング**：開発者による手動実行（make）。主にImGuiのSDL3/Metalバックエンド開発・テスト時、SDL3+Metal対応macOSアプリケーション開発の参照として使用される。

**主要な処理内容**：
1. main.mm（Objective-C++）およびImGuiコアソースファイルのコンパイル
2. SDL3バックエンドファイルのコンパイル
3. Metalバックエンドファイル（imgui_impl_metal.mm）のコンパイル
4. Metalフレームワークおよびその他macOSフレームワークとのリンク
5. 実行ファイル（example_sdl3_metal）の生成

**前後の処理との関連**：単独で実行可能。SDL3ライブラリの事前インストールが必要（brew install sdl3またはソースからビルド）。macOS上でのみ実行可能。

**影響範囲**：カレントディレクトリに生成されるexample_sdl3_metal実行ファイルおよびオブジェクトファイル（.o）。

## バッチ種別

ビルド処理 / ネイティブコンパイル（macOS専用）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動（make） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| macOS環境 | macOS上でのみ実行可能 |
| SDL3ライブラリ | SDL3がインストールされていること（brew install sdl3またはソースビルド） |
| pkg-config | sdl3のpkg-config設定が利用可能であること |
| Xcodeコマンドラインツール | clang++が利用可能であること |
| ImGuiソースコード | ../..の位置にImGuiのソースコードが存在すること |

### 実行可否判定

macOS環境であり、SDL3のpkg-config設定が利用可能であり、clang++コンパイラが実行可能であること。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| main.mm | Objective-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ウィジェットソースファイル |
| ../../backends/imgui_impl_sdl3.cpp | C++ソース | SDL3バックエンド実装 |
| ../../backends/imgui_impl_metal.mm | Objective-C++ソース | Metalバックエンド実装 |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | example_sdl3_metal |
| 出力先 | カレントディレクトリ |
| 文字コード | バイナリ |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. pkg-configによるSDL3設定取得
   └─ sdl3のcflags/libsを取得
2. コンパイルフラグの設定
   └─ C++11標準、Metalフレームワーク参照の設定
3. C++ソースファイルのコンパイル
   └─ ImGuiコアおよびSDL3バックエンドの.cppを.oにコンパイル
4. Objective-C++ソースファイルのコンパイル
   └─ main.mmおよびimgui_impl_metal.mmを-ObjC++ -fobjc-arc付きでコンパイル
5. リンク処理
   └─ オブジェクトファイルとフレームワークをリンクして実行ファイルを生成
6. ビルド完了メッセージの出力
   └─ "Build complete"
```

### フローチャート

```mermaid
flowchart TD
    A[make実行開始] --> B[pkg-config sdl3実行]
    B --> C[コンパイルフラグ設定]
    C --> D[C++ソースコンパイル]
    D --> E[imgui.oの生成]
    E --> F[imgui_impl_sdl3.oの生成]
    F --> G[Obj-C++ソースコンパイル]
    G --> H[main.oの生成]
    H --> I[imgui_impl_metal.oの生成]
    I --> J[リンク処理]
    J --> K[example_sdl3_metal生成]
    K --> L[ビルド完了]
```

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

### 操作別データベース影響一覧

本バッチはデータベースを使用しない。

### テーブル別操作詳細

N/A（データベース操作なし）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コンパイルエラー | ソースコードに構文エラーがある場合 | エラーメッセージを確認し、ソースコードを修正 |
| N/A | リンクエラー | フレームワーク不足、シンボル未定義の場合 | Xcodeコマンドラインツールのインストール状況を確認 |
| N/A | pkg-configエラー | SDL3の設定が見つからない場合 | SDL3をインストール（brew install sdl3またはソースからビルド） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A（手動リトライ） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

ビルドエラー発生時は、コンパイラ出力のエラーメッセージを確認し、依存ライブラリのインストール状況やソースコードを修正後、再度makeを実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8ソースファイル |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 通常のC++/Obj-C++コンパイルに必要なメモリ |

## 排他制御

同一ディレクトリで同時に複数のmakeプロセスを実行しないこと。オブジェクトファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | コンパイル時 | 各ソースファイルのコンパイルコマンド |
| 終了ログ | ビルド完了時 | "Build complete" |
| エラーログ | エラー発生時 | コンパイラ/リンカーのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行のため監視対象外） |

## 備考

- macOS専用のMakefile（Linux/Windowsでは使用不可）
- SDL3ライブラリの取得にpkg-config --libs/--cflags sdl3を使用
- Metalフレームワーク、MetalKitフレームワークを使用
- Cocoa、IOKit、CoreVideo、QuartzCoreフレームワークをリンク
- Objective-C++ファイルは-ObjC++ -fobjc-weak -fobjc-arcオプション付きでコンパイル
- ARC（Automatic Reference Counting）を使用
- C++11標準を使用（-std=c++11）
- SDL2版（example_sdl2_metal）とは異なり、pkg-configでSDL3を取得
