# バッチ設計書 2-build_win32.bat (example_null)

## 概要

本ドキュメントは、ImGuiプロジェクトにおけるテスト用nullバックエンドサンプル（example_null）のVisual Studio 32bitビルドスクリプトの設計書である。

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

このバッチは、ImGuiのテスト・検証用に作成されたnullバックエンドサンプルアプリケーションをMicrosoft Visual C++コンパイラ（MSVC cl.exe）を使用してビルドする。

**業務上の目的・背景**：example_nullはImGuiの基本動作テストおよびCI/CDパイプラインでの検証に使用される最小構成のサンプルである。グラフィックスAPIに依存しないnullバックエンドを使用することで、レンダリング環境がない状態でもImGuiのコア機能をテストできる。開発者がビルド環境の検証を行う際にも使用される。

**バッチの実行タイミング**：開発者がローカル環境でテストビルドを実行する際、またはImGuiのコア機能変更後の動作確認時に手動で実行される。

**主要な処理内容**：
1. Debugディレクトリを作成
2. Visual C++コンパイラ（cl.exe）を使用してC++ソースファイルをコンパイル
3. ImGuiコアライブラリとサンプルアプリケーションをリンク
4. example_null.exeとしてDebugディレクトリに出力

**前後の処理との関連**：実行前にvcvars32.batまたはvcvarsall.batを実行してコマンドラインコンパイラ環境を設定する必要がある。本バッチで生成されたexeファイルは、ImGuiの基本動作テストに使用される。

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

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Visual Studio | Visual Studioがインストールされていること |
| vcvars32.bat実行済み | コマンドラインコンパイラ環境が設定されていること |
| 実行ディレクトリ | examples/example_null ディレクトリで実行すること |

### 実行可否判定

バッチスクリプトは特に前提条件のチェックを行わない。cl.exeが利用可能でない場合、コンパイルエラーが発生する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| %* | 文字列 | No | なし | cl.exeに渡す追加オプション |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| *.cpp | C++ソースファイル | サンプルアプリケーションのソースコード |
| ..\..\*.cpp | C++ソースファイル | ImGuiコアライブラリのソースコード |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. Debugディレクトリの作成
   └─ mkdir Debug
2. C++ソースファイルのコンパイルとリンク
   └─ cl.exe でソースファイルをコンパイル
   └─ gdi32.lib, shell32.lib, imm32.lib とリンク
3. 実行可能ファイルの出力
   └─ Debug/example_null.exe として出力
```

### フローチャート

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

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

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

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

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

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

## 備考

- コンパイルオプション説明：
  - `/nologo`: コピーライトメッセージを抑制
  - `/Zi`: デバッグ情報を生成
  - `/MD`: マルチスレッドDLLランタイムを使用
  - `/utf-8`: ソースファイルをUTF-8として解釈
  - `/I`: インクルードパスを指定
  - `/Fe`: 出力実行ファイル名を指定
  - `/Fo`: オブジェクトファイル出力先を指定
- リンクライブラリ：gdi32.lib（GDI関数）、shell32.lib（シェル関数）、imm32.lib（IME関数）
