# バッチ設計書 4-build-native.sh

## 概要

本ドキュメントは、Avaloniaプロジェクトにおける macOS 用ネイティブコード（Avalonia.Native）ビルドスクリプト `build-native.sh` のバッチ設計書です。

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

このシェルスクリプトは、macOS環境においてAvaloniaのネイティブライブラリ（Avalonia.Native）をビルドするためのスクリプトです。CMakeを使用してネイティブコードのビルド設定を行い、ビルドおよびインストールを実行します。

**業務上の目的・背景**：AvaloniaはmacOS上でネイティブなユーザーインターフェースを提供するために、Objective-C/C++で実装されたネイティブライブラリを必要とします。このスクリプトは、そのネイティブライブラリのビルドプロセスを自動化し、開発者が容易にネイティブコンポーネントを再ビルドできるようにします。主にNukeビルドシステムのCompileNativeターゲットから呼び出されますが、単独での実行も可能です。

**バッチの実行タイミング**：ネイティブコードの変更時、またはmacOS用のリリースビルド作成時に実行されます。Nukeビルドシステムを通じて自動的に呼び出されることもあります。

**主要な処理内容**：
1. native-buildディレクトリの作成
2. native-buildディレクトリへの移動
3. CMakeによるビルド設定の生成（../nativeディレクトリを参照）
4. CMakeによるビルド実行とインストール

**前後の処理との関連**：このスクリプトはNukeビルドターゲットのCompileNativeから呼び出されることがあります。ビルド成果物は後続のマネージドコードビルドで参照されます。GenerateCppHeadersターゲットが事前に実行されることが推奨されます。

**影響範囲**：native-buildディレクトリの作成、ネイティブライブラリのビルド成果物（.dylibなど）の生成に影響します。

## バッチ種別

ビルドスクリプト / ネイティブコードビルド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行またはNukeターゲット経由） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動 / Nukeビルドターゲット（CompileNative） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| OS | macOS |
| CMake | インストール済み |
| Xcode Command Line Tools | インストール済み |
| C/C++コンパイラ | clang/clang++（Xcodeに含まれる） |

### 実行可否判定

- macOS環境であること
- CMakeがPATHに含まれていること
- nativeディレクトリにCMakeLists.txtが存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $1 | string | Yes | - | ビルド構成（Debug/Release） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| native/CMakeLists.txt | CMake | CMakeビルド設定ファイル |
| native/Avalonia.Native/ | ソースコード | ネイティブソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| native-build/ | ディレクトリ | CMakeビルドディレクトリ |
| インストール先 | バイナリ | ビルドされたネイティブライブラリ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | CMake設定によるインストール先に依存 |
| 出力先 | installターゲットで定義された場所 |
| 形式 | .dylib（macOS動的ライブラリ） |

## 処理フロー

### 処理シーケンス

```
1. ビルドディレクトリ作成
   └─ mkdir native-build
2. ディレクトリ移動
   └─ cd native-build
3. CMake設定生成
   └─ cmake -DCMAKE_BUILD_TYPE=$1 ../native
4. ビルドとインストール
   └─ cmake --build . --target install
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[native-buildディレクトリ作成]
    B --> C[native-buildに移動]
    C --> D[CMake設定生成]
    D --> E[ビルド実行]
    E --> F[インストール実行]
    F --> G[スクリプト終了]
```

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

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

本バッチはデータベース操作を行いません。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非ゼロ終了 | CMake設定エラー | CMakeが設定生成に失敗 | CMakeエラーメッセージを確認 |
| 非ゼロ終了 | コンパイルエラー | ソースコードのコンパイル失敗 | エラーメッセージを確認し、コードを修正 |
| 非ゼロ終了 | リンクエラー | ライブラリのリンク失敗 | 依存関係を確認 |

### リトライ仕様

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

### 障害時対応

1. CMakeエラーメッセージを確認
2. native-buildディレクトリを削除して再実行
3. Xcode Command Line Toolsのインストールを確認
4. CMakeのバージョンを確認

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 1-5分（ネイティブコードの規模に依存） |
| メモリ使用量上限 | コンパイラに依存 |

## 排他制御

同一native-buildディレクトリでの複数同時実行は推奨されません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | CMake実行時 | CMake設定およびビルドの進捗 |
| エラーログ | エラー発生時 | コンパイラ/リンカのエラー出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非ゼロ | 手動確認 |

## 備考

- このスクリプトはmacOS専用です
- Nukeビルドシステム（Build.cs）のCompileNativeターゲットとは独立して動作しますが、同様の目的を持ちます
- CMAKE_BUILD_TYPEパラメータにはDebugまたはReleaseを指定します
- ビルド成果物のインストール先はCMakeLists.txtで定義されています
- 再ビルド時はnative-buildディレクトリを削除するか、インクリメンタルビルドが行われます
