# 機能設計書 65-ジェネレーター

## 概要

本ドキュメントは、CoffeeScriptのジェネレーター（Generator）機能の設計を記述する。ジェネレーターは`yield`キーワードを使用して、一時停止と再開が可能な関数を定義する言語機能である。

### 本機能の処理概要

CoffeeScriptのジェネレーターは、ES2015で導入されたジェネレーター関数をサポートする機能である。関数内で`yield`キーワードを使用することで、その関数は自動的にジェネレーター関数となり、イテレータプロトコルに準拠したオブジェクトを返す。`yield`で値を生成（yield）し、`yield from`（`yield*`）で別のイテラブルに委譲することができる。

**業務上の目的・背景**：
ジェネレーターは、遅延評価、無限シーケンス、非同期処理の制御フロー、コルーチンスタイルのプログラミングなど、様々なユースケースで有用である。特に、メモリ効率の良いデータ処理や、複雑な非同期処理の記述において、コードの可読性と保守性を向上させる。

**機能の利用シーン**：
- 遅延評価によるシーケンス生成（例：フィボナッチ数列）
- 大量データのストリーム処理（メモリ効率の改善）
- 複雑なイテレーション制御
- コルーチンベースの非同期処理（async/awaitの基盤）
- ツリー走査やグラフ探索のイテレータ実装

**主要な処理内容**：
1. `yield`キーワードの解析とYieldノード生成
2. `yield from`（`yield*`）の解析と委譲処理
3. 関数内での`yield`使用の検出
4. 関数を`function*`ジェネレーター形式に変換
5. バウンド関数（`=>`）内でのyield使用エラー検出
6. 返り値のラップ（式として使用時は`yield*`でラップ）

**関連システム・外部連携**：
ジェネレーターはgrammar.coffeeのYield規則で解析され、Opノード（operator: 'yield'または'yield*'）として表現される。コンパイル時に、yieldを含む関数は`function*`形式に変換される。

**権限による制御**：
本機能はコンパイル時の言語機能であり、権限による制御は適用されない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面関連なし（言語機能） |

## 機能種別

言語構文変換 / 制御フロー

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| expression | Expression | No | yield対象の式（省略時は空のyield） | 有効な式 |
| operator | String | Yes | 演算子（`yield`または`yield*`） | - |
| first | Expression | Yes | Opノードの第1オペランド（yield対象） | - |

### 入力データソース

CoffeeScriptソースコード内の`yield`式

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| JavaScript | String | `yield`または`yield*`式 |
| function | Generator | ジェネレーター関数（`function*`形式） |
| iterator | Object | イテレータオブジェクト（実行時） |

### 出力先

JavaScriptコード（標準出力またはファイル）

## 処理フロー

### 処理シーケンス

```
1. yield式の解析
   └─ grammar.coffeeのYield規則でトークン列を解析
2. Opノード生成
   └─ operator: 'yield' または 'yield*'を設定
3. 関数のジェネレーター判定
   └─ Codeノードで、body内にyieldが含まれるか確認
4. バリデーション
   └─ 4.1 トップレベル（関数外）でのyieldをエラー
   └─ 4.2 バウンド関数（=>）内でのyieldをエラー
5. コンパイル処理
   └─ 5.1 compileContinuation()でyield式を生成
   └─ 5.2 関数ヘッダーに`*`を追加
   └─ 5.3 式として使用時は`yield*`でラップ
```

### フローチャート

```mermaid
flowchart TD
    A[yield式の開始] --> B{yield from?}
    B -->|Yes| C[operator = yield*]
    B -->|No| D[operator = yield]
    C --> E[Opノード生成]
    D --> E
    E --> F{関数内?}
    F -->|No| G[エラー: can only occur inside functions]
    F -->|Yes| H{バウンド関数内?}
    H -->|Yes| I[エラー: cannot occur inside bound functions]
    H -->|No| J[関数をisGenerator = trueに設定]
    J --> K{式として使用?}
    K -->|Yes| L[yield* でラップ]
    K -->|No| M[そのままyield出力]
    L --> N[function* 形式で出力]
    M --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-65-1 | 関数内限定 | yieldは関数内でのみ使用可能 | スコープの親がない場合エラー |
| BR-65-2 | バウンド関数制約 | yieldはバウンド関数（`=>`）内で使用不可 | 関数がboundかつisGenerator |
| BR-65-3 | 自動ジェネレーター化 | yieldを含む関数は自動的にジェネレーターになる | - |
| BR-65-4 | yield return | `yield return`で値を返しつつジェネレーターを終了 | YieldReturnノード |
| BR-65-5 | 式としての評価 | ジェネレーター関数を式として評価する場合、`yield*`でラップ | compileClosure時 |

### 計算ロジック

- ジェネレーター検出: `@body.contains (node) -> node instanceof Op and node.operator is 'yield'`
- operator変換: `'yieldfrom'` → `'yield*'`

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

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| SyntaxError | 構文エラー | yield can only occur inside functions | yieldを関数内に移動 |
| SyntaxError | 構文エラー | yield cannot occur inside bound (fat arrow) functions | 通常の関数（`->`）に変更 |

### リトライ仕様

コンパイル時エラーのため、リトライは適用されない。

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

本機能はデータベーストランザクションを使用しない。

## パフォーマンス要件

- コンパイル時間: 通常の関数と同等
- 実行時: ジェネレーターはオンデマンドで値を生成するため、メモリ効率が良い

## セキュリティ考慮事項

- ジェネレーター自体にセキュリティ上の特別な考慮事項はない
- 外部入力を基にしたジェネレーターロジックでは、無限ループに注意

## 備考

- ES2015ジェネレーターの完全サポート
- `yield`は予約語ではなく、識別子としても使用可能（非推奨）
- async/awaitはジェネレーターを基盤としている

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: 文法定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | grammar.coffee | `src/grammar.coffee` | Yield規則の定義（167-172行目） |

**読解のコツ**:
- 168行目: `YIELD` - 空のyield
- 169行目: `YIELD Expression` - 式をyield
- 171行目: `YIELD FROM Expression` - yield from（委譲）

**主要処理フロー**:
1. **168行目**: `YIELD` → `new Op $1, new Value new Literal ''`
2. **169行目**: `YIELD Expression` → `new Op $1, $2`
3. **171行目**: `YIELD FROM Expression` → `new Op $1.concat($2), $3`

#### Step 2: Opノードのyield処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | nodes.coffee | `src/nodes.coffee` | OpクラスのisYield、compileContinuation（4625-4894行目） |

**主要処理フロー**:
- **4654行目**: `'yieldfrom': 'yield*'` - 演算子の正規化
- **4671行目**: `isYield`メソッド - yield演算子かどうか判定
- **4752行目**: `compileContinuation`呼び出し
- **4806-4818行目**: `compileContinuation`メソッド - yield式のコンパイル
- **4820-4824行目**: `checkContinuation`メソッド - エラーチェック

#### Step 3: Codeノードのジェネレーター処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | nodes.coffee | `src/nodes.coffee` | CodeクラスのisGenerator判定 |

**読解のコツ**:
- 関数内でyieldが使用されているかを`contains`メソッドで検出
- isGeneratorフラグにより、`function*`形式で出力

### プログラム呼び出し階層図

```
CoffeeScript.compile()
    │
    ├─ Lexer.tokenize()
    │      └─ YIELDトークン生成
    │
    ├─ parser.parse()
    │      └─ Yield規則でOpノード生成
    │             └─ new Op('yield', expression)
    │
    └─ Code.compileNode()
           ├─ isGenerator判定
           │      └─ body.contains (node) -> node.operator is 'yield'
           ├─ バウンド関数チェック
           │      └─ エラー: yield cannot occur inside bound functions
           └─ function* 形式で出力
                  └─ Op.compileContinuation()
```

### データフロー図

```
[入力]                          [処理]                              [出力]

CoffeeScript           Lexer           Parser              Compiler
yield式            →  トークン列  →   Opノード       →    JavaScript
                                    (operator:yield)     yield式/function*

例:
fn = -> yield 1
    ↓
['IDENTIFIER', '->', 'YIELD', 'NUMBER']
    ↓
Code {
  body: Block([
    Op { operator: 'yield', first: NumberLiteral(1) }
  ]),
  isGenerator: true
}
    ↓
var fn = function*() {
  return yield 1;
};
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| grammar.coffee | `src/grammar.coffee` | ソース | Yield規則の定義（167-172行目）、YieldReturn（318-321行目） |
| nodes.coffee | `src/nodes.coffee` | ソース | Opクラスのyield処理、CodeクラスのisGenerator判定 |
| lexer.coffee | `src/lexer.coffee` | ソース | YIELDトークンの生成、FROM識別子の特殊処理（137-139行目） |
