# バッチ設計書 10-lovr-api.lua

## 概要

本ドキュメントは、LOVR APIのLua定義ファイルを生成するツール「lovr-api.lua」の設計仕様を定義するものである。

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

lovr-api.luaは、LOVR（Lua Virtual Reality）フレームワークの公式APIドキュメント（lovr-api）からLua Language Server用のメタデータファイルを生成するツールである。LOVRの全モジュール、関数、オブジェクト、コールバック、enumを解析し、LuaDoc形式のアノテーション付きスタブファイルを出力する。

**業務上の目的・背景**：LOVRはLuaベースのVR開発フレームワークである。lua-language-serverでLOVR開発者に適切なコード補完、型チェック、ドキュメント表示を提供するため、APIのメタデータが必要である。このツールにより、LOVRのAPIを自動的にLua Language Serverで利用可能な形式に変換できる。

**バッチの実行タイミング**：手動実行。LOVRの新バージョンがリリースされ、APIが更新された場合に実行する。

**主要な処理内容**：
1. 3rd/lovr-api/api/init.luaからAPI定義を読み込み
2. 各モジュール（lovr.audio、lovr.graphics等）について処理
3. 関数の引数、戻り値、オーバーロードをLuaDocアノテーションに変換
4. オブジェクト（クラス）の継承関係、メソッドを定義
5. コールバック関数の型を定義（別ファイル：callback.lua）
6. enum値を型エイリアスとして定義
7. meta/3rd/lovr/library/配下にファイル出力

**前後の処理との関連**：build-3rd-meta.luaから呼び出される。生成されたファイルは言語サーバーが参照する。

**影響範囲**：meta/3rd/lovr/library/配下のファイルが更新される。

## バッチ種別

メタデータ生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 / build-3rd-meta.lua |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Luaランタイム | Luaインタープリタが利用可能であること |
| lovr-apiサブモジュール | 3rd/lovr-api/が初期化済みであること |

### 実行可否判定

プロジェクトルートディレクトリで実行すること。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 3rd/lovr-api/api/init.lua | Lua | LOVR API定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| meta/3rd/lovr/library/lovr/*.lua | Lua | モジュールメタデータ |
| meta/3rd/lovr/library/callback.lua | Lua | コールバック定義 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | {モジュール名}.lua / callback.lua |
| 出力先 | meta/3rd/lovr/library/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. API定義読み込み
   └─ dofileで3rd/lovr-api/api/init.luaを読み込み
2. 出力ディレクトリ作成
   └─ meta/3rd/lovr/libraryを作成
3. 型名マッピング定義
   └─ knownTypes（nil、any、boolean、number等）を定義
4. コールバックファイル生成
   └─ buildCallback(api)を呼び出し
   └─ callback.luaに出力
5. モジュールループ
   └─ api.modulesを走査
   └─ 各モジュールについてbuildFileを呼び出し
6. ファイル生成（buildFile関数）
   └─ ---@metaヘッダ出力
   └─ ---@class定義出力
   └─ 関数定義出力（buildFunction）
   └─ オブジェクト定義出力
   └─ enum定義出力
7. ファイル保存
   └─ fsu.saveFileで出力
```

### フローチャート

```mermaid
flowchart TD
    A[lovr-api.lua開始] --> B[init.lua読み込み]
    B --> C[出力ディレクトリ作成]
    C --> D[knownTypes定義]
    D --> E[callback.lua生成]
    E --> F[モジュールループ開始]
    F --> G[クラス定義出力]
    G --> H[関数定義ループ]
    H --> I[オーバーロード処理]
    I --> J[パラメータ処理]
    J --> K[戻り値処理]
    K --> L[オブジェクト定義ループ]
    L --> M[継承関係処理]
    M --> N[メソッド処理]
    N --> O[enum処理]
    O --> P[ファイル保存]
    P --> Q{次のモジュールあり?}
    Q -->|Yes| F
    Q -->|No| R[完了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | API読み込みエラー | init.luaが見つからない | サブモジュールを初期化 |
| - | ディレクトリ作成失敗 | 書き込み権限がない | 権限を確認 |

### リトライ仕様

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

### 障害時対応

エラーメッセージを確認し、lovr-apiサブモジュールが正しく取得されているか確認する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | モジュール数 × 関数数 |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | Luaランタイム依存 |

## 排他制御

同一ディレクトリでの同時実行は非推奨。出力ファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | なし | - |
| 標準エラー | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | 該当なし | 該当なし |

## 備考

- love-api.luaと異なり、dofileで直接APIを読み込み（lua51互換環境不要）
- 型名は"lovr."プレフィックスを付けて出力（例: lovr.Model）
- '*'型は"any"にマッピング
- LOVRではtypesの代わりにobjectsを使用、functionsの代わりにmethodsを使用
- コールバックは別ファイル（callback.lua）に出力
- コールバックは---@typeアノテーションで定義（loveの---@aliasとは異なる）
- func.keyを使用して関数名を出力（loveのfunc.nameとは異なる）
- enumのconstantsの代わりにvaluesを使用
