# バッチ設計書 3-build_win32.bat (example_glfw_opengl2)

## 概要

本ドキュメントは、ImGuiプロジェクトにおけるGLFW + OpenGL2サンプルアプリケーションのVisual Studio 32bitビルドスクリプトの設計書である。

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

このバッチは、GLFWウィンドウライブラリとOpenGL2レンダリングAPIを使用したImGuiサンプルアプリケーションをMicrosoft Visual C++コンパイラ（MSVC cl.exe）を使用してビルドする。

**業務上の目的・背景**：OpenGL2は広くサポートされた旧バージョンのOpenGL APIであり、古いハードウェアや互換性を重視する環境向けのサンプルとして提供されている。GLFWはクロスプラットフォームのウィンドウ管理ライブラリであり、本サンプルを通じてImGuiのGLFW+OpenGL2バックエンド統合を実証する目的がある。

**バッチの実行タイミング**：開発者がローカル環境でGLFW+OpenGL2サンプルをビルドする際、またはバックエンド変更後の動作確認時に手動で実行される。

**主要な処理内容**：
1. Debugディレクトリを作成
2. インクルードパス（ImGuiコア、backends、GLFW）を設定
3. ソースファイル（main.cpp、imgui_impl_opengl2.cpp、imgui_impl_glfw.cpp、ImGuiコア）をコンパイル
4. GLFW3ライブラリおよびOpenGL32ライブラリとリンク
5. example_glfw_opengl2.exeとしてDebugディレクトリに出力

**前後の処理との関連**：実行前にvcvars32.batまたはvcvarsall.batを実行してコマンドラインコンパイラ環境を設定する必要がある。また、GLFW3ライブラリがexamples/libs/glfw/lib-vc2010-32に配置されている必要がある。

**影響範囲**：example_glfw_opengl2サンプルのビルド成果物のみ。他のサンプルやImGuiコアライブラリには影響しない。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Visual Studio | Visual Studioがインストールされていること |
| vcvars32.bat実行済み | コマンドラインコンパイラ環境が設定されていること |
| GLFW3ライブラリ | examples/libs/glfw/lib-vc2010-32にglfw3.libが配置されていること |
| 実行ディレクトリ | examples/example_glfw_opengl2 ディレクトリで実行すること |

### 実行可否判定

バッチスクリプトは特に前提条件のチェックを行わない。必要なライブラリが存在しない場合、リンクエラーが発生する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| main.cpp | C++ソースファイル | サンプルアプリケーションのエントリポイント |
| imgui_impl_opengl2.cpp | C++ソースファイル | OpenGL2バックエンド実装 |
| imgui_impl_glfw.cpp | C++ソースファイル | GLFWバックエンド実装 |
| imgui*.cpp | C++ソースファイル | ImGuiコアライブラリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Debug/example_glfw_opengl2.exe | 実行可能ファイル | ビルドされたサンプルアプリケーション |
| Debug/*.obj | オブジェクトファイル | 中間コンパイル成果物 |
| Debug/*.pdb | デバッグ情報 | デバッグシンボルファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | example_glfw_opengl2.exe |
| 出力先 | Debug/ |
| アーキテクチャ | x86（32bit） |
| 構成 | Debug（デバッグ情報付き） |

## 処理フロー

### 処理シーケンス

```
1. 環境変数の設定
   └─ OUT_DIR=Debug, OUT_EXE=example_glfw_opengl2
   └─ INCLUDES, SOURCES, LIBS の設定
2. Debugディレクトリの作成
   └─ mkdir %OUT_DIR%
3. C++ソースファイルのコンパイルとリンク
   └─ cl.exe でソースファイルをコンパイル
   └─ glfw3.lib, opengl32.lib, gdi32.lib, shell32.lib とリンク
4. 実行可能ファイルの出力
   └─ Debug/example_glfw_opengl2.exe として出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[環境変数設定]
    B --> C[Debugディレクトリ作成]
    C --> D[cl.exeでコンパイル]
    D --> E{コンパイル成功?}
    E -->|成功| F[example_glfw_opengl2.exe出力]
    E -->|失敗| G[エラー終了]
    F --> H[バッチ終了]
    G --> H
```

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

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

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | コンパイルエラー | ソースコードに構文エラー | ソースコードを修正 |
| 非0 | リンクエラー | glfw3.libが見つからない | GLFWライブラリを配置 |
| 非0 | インクルードエラー | GLFWヘッダーが見つからない | GLFWインクルードパスを確認 |
| 1 | 環境エラー | cl.exeが見つからない | vcvars32.batを実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

コンパイルエラー発生時はcl.exeの出力メッセージを確認し、ソースコードの修正またはライブラリ配置を見直す。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | - |
| コミットタイミング | - |
| ロールバック条件 | - |

本バッチはファイルコンパイル処理のみでトランザクション管理は行わない。

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約10ファイル |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行の制御は行わない。同じディレクトリで複数のビルドが実行された場合、ファイル競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | コンパイル中 | コンパイル進捗（ファイル名） |
| 標準出力 | リンク中 | リンク処理の情報 |
| 標準エラー | エラー発生時 | コンパイル/リンクエラーの詳細 |

## 監視・アラート

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

開発時のローカル実行を想定しており、監視・アラート設定はない。

## 備考

- 使用ライブラリ：
  - glfw3.lib: GLFWウィンドウ管理ライブラリ（32bit版、Visual Studio 2010互換）
  - opengl32.lib: WindowsのOpenGL APIライブラリ
  - gdi32.lib: Windows GDI関数
  - shell32.lib: Windowsシェル関数
- GLFWライブラリはexamples/libs/glfw/に事前配置が必要
- OpenGL2は固定機能パイプラインを使用する旧式のAPIだが、互換性が高い
