# バッチ設計書 27-GenerateCppHeaders

## 概要

本ドキュメントは、Avalonia UIフレームワークのNukeビルドシステムにおける「GenerateCppHeaders」ターゲットの設計を記述したものである。このターゲットは、MicroComのIDLファイルからC++ヘッダーファイルを生成する。

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

GenerateCppHeadersターゲットは、Avalonia.NativeのMicroCom IDL（Interface Definition Language）ファイルを解析し、macOS向けネイティブライブラリ（Avalonia.Native）が使用するC++ヘッダーファイルを自動生成するターゲットである。

**業務上の目的・背景**：Avalonia UIフレームワークのmacOS向けネイティブライブラリは、.NETとネイティブコード（Objective-C/C++）間の相互運用を実現するためにMicroComを使用している。IDLファイルでインターフェースを定義し、そこからC++ヘッダーを自動生成することで、.NET側とネイティブ側の整合性を維持し、手動でのヘッダー作成によるエラーを防止する。

**バッチの実行タイミング**：CompileNativeターゲットの依存関係として自動実行される。また、IDLファイルを変更した際に手動で実行することも可能。

**主要な処理内容**：
1. src/Avalonia.Native/avn.idl ファイルの読み込み
2. MicroComCodeGenerator.Parse() によるIDL解析
3. GenerateCppHeader() によるC++ヘッダーコード生成
4. native/Avalonia.Native/inc/avalonia-native.h への書き込み

**前後の処理との関連**：CompileNativeターゲットから依存されており、ネイティブライブラリのビルド前に実行される。

**影響範囲**：生成されたヘッダーファイルはAvalonia.NativeのXcodeプロジェクトで使用される。

## バッチ種別

コード生成 / ビルド前処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド時/手動実行） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | CompileNative依存 / 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ソースコード | src/Avalonia.Native/avn.idl が存在すること |
| MicroCom.CodeGenerator | NuGetパッケージとして利用可能であること |

### 実行可否判定

特に条件なし。任意のプラットフォームで実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| src/Avalonia.Native/avn.idl | IDL | MicroComインターフェース定義ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| native/Avalonia.Native/inc/avalonia-native.h | C++ヘッダー | 生成されたC++ヘッダーファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | avalonia-native.h |
| 出力先 | native/Avalonia.Native/inc |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. avn.idlファイルの読み込み
   └─ File.ReadAllText(RootDirectory / "src" / "Avalonia.Native" / "avn.idl")
2. IDL解析
   └─ MicroComCodeGenerator.Parse()
3. C++ヘッダー生成
   └─ file.GenerateCppHeader()
4. ヘッダーファイル出力
   └─ File.WriteAllText(RootDirectory / "native" / "Avalonia.Native" / "inc" / "avalonia-native.h")
```

### フローチャート

```mermaid
flowchart TD
    A[GenerateCppHeaders開始] --> B[avn.idl読み込み]
    B --> C[MicroComCodeGenerator.Parse]
    C --> D[GenerateCppHeader]
    D --> E[avalonia-native.h出力]
    E --> F[GenerateCppHeaders完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル読み込みエラー | avn.idlが存在しない | ファイルの存在確認 |
| - | パースエラー | IDL構文エラー | avn.idlの構文修正 |
| - | ファイル書き込みエラー | 出力先に書き込み不可 | 権限の確認 |

### リトライ仕様

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

### 障害時対応

IDL構文エラーの場合は、avn.idlファイルの構文を確認し修正する。MicroComのIDL仕様に従った記述が必要。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行の制御は特になし。出力ファイルへの同時書き込みは発生しない想定。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ターゲット開始時 | Nukeの標準ログ |
| 終了ログ | ターゲット完了時 | Nukeの標準ログ |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- MicroComはAvalonia独自のCOM相互運用ライブラリ
- avn.idlファイルにはIAvnWindow、IAvnAppなどのインターフェースが定義されている
- 生成されるavalonia-native.hはObjective-C++コードから参照される
- CompileNativeターゲットはGenerateCppHeadersに依存しており、macOSビルド時に自動的にヘッダーが更新される
- IDL変更時は、このターゲットを実行後、ネイティブコードの実装を更新する必要がある
