# バッチ設計書 4-core.rake

## 概要

本ドキュメントは、mrubyコアソースファイル（`src/*.c`）をコンパイルするRakeタスク定義ファイル `tasks/core.rake` の設計仕様を記述する。

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

`core.rake` は、mrubyのコアランタイム実装であるCソースファイル群（`src/*.c`）をオブジェクトファイルにコンパイルし、`libmruby_core_objs` に登録するタスクを定義する。CXX例外が有効な場合は特定のファイルをC++としてコンパイルする条件分岐も含む。

**業務上の目的・背景**：mrubyのコアランタイム（VM、GC、エラー処理、パーサー、コード生成等）はCで実装されている。これらのソースファイルをオブジェクトファイルにコンパイルすることで、最終的な静的ライブラリ（libmruby_core.a）の構成要素を生成する。C++例外機能を有効にした場合、vm.c、error.c、gc.cの3ファイルはC++としてコンパイルする必要があり、この条件分岐も本タスクで処理される。

**バッチの実行タイミング**：`rake build` の依存関係解決時に、libmruby_core_staticの生成に必要なオブジェクトファイルとして自動的にコンパイルが実行される。

**主要な処理内容**：
1. `src/*.c` のCソースファイル一覧を `Dir.glob` で取得する
2. 各ソースファイルについて、CXX例外が有効かつ対象ファイル（vm.c, error.c, gc.c）の場合はC++としてコンパイルする
3. それ以外のファイルは通常のCコンパイルでオブジェクトファイルを生成する
4. 生成されたオブジェクトファイルリストを `self.libmruby_core_objs` に追加する

**前後の処理との関連**：`:gensym`（No.3）で生成されたpresymヘッダーがインクルードされる。生成されたオブジェクトファイルは libmruby.rake（No.8）で `libmruby_core.a` に結合される。

**影響範囲**：`build/{target}/src/` ディレクトリにオブジェクトファイルが生成される。

## バッチ種別

ビルド処理（コアソースコンパイル）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド時に自動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Rakeの依存関係解決により自動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Cコンパイラ | GCC または Clang 等のCコンパイラがインストールされていること |
| C++コンパイラ | CXX例外有効時はC++コンパイラが必要 |
| presymヘッダー | `:gensym` タスクにより生成済みであること |
| src/*.c | mrubyコアのソースファイルが存在すること |

### 実行可否判定

`Dir.glob("#{MRUBY_ROOT}/src/*.c")` で対象ファイルが見つかること。Rakeのタイムスタンプ比較により、ソースファイルがオブジェクトファイルより新しい場合にコンパイルが実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| cxx_exception_enabled? | Boolean（ビルド設定） | No | false | CXX例外を有効にするかどうか |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| src/*.c | Cソースファイル | mrubyコアのソースコード |
| include/ | ヘッダーファイル | mrubyのヘッダーファイル群 |
| build/{target}/include/ | ヘッダーファイル | presymにより生成されたヘッダーファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/{target}/src/*.o | オブジェクトファイル | コンパイル済みオブジェクト |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | `{ソースファイル名}.o`（拡張子変換） |
| 出力先 | `build/{target}/src/` |
| 文字コード | バイナリ |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. ソースファイル一覧取得
   └─ Dir.glob("#{MRUBY_ROOT}/src/*.c") で全Cソースを取得
2. CXX例外対象ファイルの判定
   └─ as_cxx_srcs = %w[vm error gc].map{|name| "#{MRUBY_ROOT}/src/#{name}.c"}
3. 各ソースファイルのコンパイル
   └─ CXX例外有効 かつ as_cxx_srcs に含まれる → compile_as_cxx(src)
   └─ それ以外 → objfile(src.pathmap("#{build_dir}/src/%n"))
4. オブジェクトリストの登録
   └─ self.libmruby_core_objs << objs
```

### フローチャート

```mermaid
flowchart TD
    A[core.rake 処理開始] --> B[src/*.c ファイル一覧取得]
    B --> C{各ソースファイルを処理}
    C --> D{CXX例外が有効?}
    D -->|はい| E{vm.c/error.c/gc.c?}
    E -->|はい| F[C++としてコンパイル]
    E -->|いいえ| G[Cとしてコンパイル]
    D -->|いいえ| G
    F --> H[オブジェクトファイル生成]
    G --> H
    H --> C
    C -->|全ファイル処理完了| I[libmruby_core_objs に追加]
    I --> J[core.rake 処理終了]
```

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

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

本バッチではデータベース操作は発生しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンパイルエラー | Cソースコードの構文エラー等 | エラーメッセージに従いソースコードを修正 |
| - | ヘッダー不在エラー | インクルードファイルが見つからない | インクルードパスとヘッダーファイルを確認 |

### リトライ仕様

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

### 障害時対応

コンパイルエラーの場合はエラーメッセージを確認し、該当ソースコードを修正する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | src/ 配下のCソースファイル数（約20-30ファイル） |
| 目標処理時間 | 環境依存（各ファイル数秒以内） |
| メモリ使用量上限 | コンパイラ依存 |

## 排他制御

同一ビルドターゲットに対する同時実行は想定されていない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各ファイルコンパイル時 | コンパイル対象ファイル名（`_pp` による出力） |
| エラーログ | コンパイルエラー時 | コンパイラのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプラインの通知設定に依存 |

## 備考

- CXX例外の対象となるファイルは `vm.c`、`error.c`、`gc.c` の3ファイルのみである。これらのファイルはC++例外によるエラーハンドリングが必要なため、C++としてコンパイルされる。
- `MRuby.each_target` により、全ビルドターゲットに対して同じルールが適用される。
- `libmruby_core_objs` はフラット化されて `libmruby_core_static`（libmruby_core.a）の入力となる。
