# バッチ設計書 53-Makefile (example_glfw_metal)

## 概要

本ドキュメントは、GLFW + Apple Metalを使用したImGuiサンプルアプリケーションをmacOS向けにビルドするためのMakefileバッチ処理について定義する設計書である。

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

このMakefileは、GLFWウィンドウシステムライブラリとApple Metalレンダリングバックエンドを組み合わせたImGuiサンプルアプリケーションをmacOS環境でビルドするためのビルドスクリプトである。

**業務上の目的・背景**：Apple MetalはmacOS/iOS向けの低レベルグラフィックスAPIであり、OpenGLに比べて高いパフォーマンスを実現する。GLFWと組み合わせることで、クロスプラットフォームのウィンドウ管理とMacネイティブの高速レンダリングを両立したImGuiアプリケーションの開発が可能となる。開発者がImGuiをGLFW+Metal環境で利用する際のリファレンス実装を提供するために本バッチが必要である。

**バッチの実行タイミング**：手動トリガーによる随時実行。開発者がサンプルのビルド・テストを行う際に実行する。CI/CDパイプラインからも実行される。

**主要な処理内容**：
1. ImGuiコアソースファイル（imgui.cpp, imgui_demo.cpp, imgui_draw.cpp, imgui_tables.cpp, imgui_widgets.cpp）のコンパイル
2. GLFWプラットフォームバックエンド（imgui_impl_glfw.cpp）のコンパイル
3. Metalレンダリングバックエンド（imgui_impl_metal.mm）のObjective-C++コンパイル
4. サンプルアプリケーションmain.mmのコンパイル
5. Appleフレームワークとのリンク、実行ファイル生成

**前後の処理との関連**：前提としてGLFWライブラリがHomebrewなどでインストールされている必要がある。macOS専用であり、他のOSでは動作しない。

**影響範囲**：ローカルディレクトリ内に実行ファイル（example_glfw_metal）とオブジェクトファイル（.o）が生成される。システム全体への影響はない。

## バッチ種別

ビルドスクリプト / コンパイル処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| macOS | macOSが動作していること |
| GLFW | GLFWライブラリがインストールされていること |
| Xcode Command Line Tools | clang++が利用可能であること |
| Metal対応ハードウェア | Metal対応のMac（2012年以降のMac） |

### 実行可否判定

- macOS環境であること
- `/usr/local/lib`または`/opt/homebrew/lib`にGLFWライブラリが存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CXX | 環境変数 | No | システムデフォルト | C++コンパイラ（g++/clang++） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| main.mm | ソースファイル | サンプルアプリケーションのエントリポイント（Objective-C++） |
| imgui.cpp | ソースファイル | ImGuiコアライブラリ |
| imgui_demo.cpp | ソースファイル | ImGuiデモウィンドウ |
| imgui_draw.cpp | ソースファイル | ImGui描画処理 |
| imgui_tables.cpp | ソースファイル | ImGuiテーブル機能 |
| imgui_widgets.cpp | ソースファイル | ImGuiウィジェット |
| imgui_impl_glfw.cpp | ソースファイル | GLFWプラットフォームバックエンド |
| imgui_impl_metal.mm | ソースファイル | Metalレンダリングバックエンド（Objective-C++） |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | example_glfw_metal |
| 出力先 | examples/example_glfw_metal/ |
| 形式 | macOS実行ファイル（Mach-O） |

## 処理フロー

### 処理シーケンス

```
1. コンパイルフラグ設定
   └─ C++11標準、インクルードパス設定
2. フレームワーク設定
   └─ Metal, MetalKit, Cocoa, IOKit, CoreVideo, QuartzCore
3. ライブラリパス設定
   └─ /usr/local/lib, /opt/homebrew/lib, /opt/local/lib
4. C++ソースファイルコンパイル
   └─ imgui*.cppを.oファイルにコンパイル
5. Objective-C++ソースファイルコンパイル
   └─ .mmファイルをARCおよびweak参照対応でコンパイル
6. リンク処理
   └─ 全オブジェクトファイルとフレームワークをリンク
7. ビルド完了メッセージ出力
   └─ "Build complete" を表示
```

### フローチャート

```mermaid
flowchart TD
    A[make 実行開始] --> B[コンパイルフラグ設定]
    B --> C[フレームワーク/ライブラリパス設定]
    C --> D[C++ソースコンパイル]
    D --> E[Objective-C++ソースコンパイル]
    E --> F[オブジェクトファイル生成]
    F --> G[リンク処理]
    G --> H[実行ファイル生成]
    H --> I[ビルド完了]
```

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

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

該当なし（本バッチはファイルシステム操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | ソースコードの構文エラー | ソースコードの修正 |
| - | リンクエラー | GLFWライブラリが見つからない | `brew install glfw`を実行 |
| - | フレームワークエラー | Metal非対応環境 | Metal対応Macを使用 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. GLFWのインストール確認（`brew install glfw`）
3. Xcode Command Line Toolsのインストール確認

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

該当なし（ファイルシステム操作のみ）

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8ソースファイル |
| 目標処理時間 | 数分以内 |
| メモリ使用量上限 | コンパイラ依存 |

## 排他制御

同一ディレクトリでの同時ビルドは推奨されない。オブジェクトファイルの競合が発生する可能性がある。

## ログ出力

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

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

手動実行のため、自動監視は設定されていない。

## 備考

- macOS専用のMakefileであり、他のOSでは動作しない
- Objective-C++ファイル（.mm）はARC（-fobjc-arc）および弱参照（-fobjc-weak）を有効にしてコンパイル
- GLFWはHomebrewでインストール可能（`brew install glfw`）
- Apple Silicon Mac（M1/M2等）では`/opt/homebrew/lib`パスが使用される
- Intel Mac では`/usr/local/lib`パスが使用される
- `make clean`コマンドで生成ファイルの削除が可能
- 使用フレームワーク：Metal, MetalKit, Cocoa, IOKit, CoreVideo, QuartzCore
