# 機能設計書 13-暗黙のオブジェクトリテラル

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「暗黙のオブジェクトリテラル」機能の設計を記述する。この機能はRewriterの一部として実装され、ブレース（波括弧）なしで記述されたオブジェクトリテラルに暗黙のブレースを追加する処理を担当する。

### 本機能の処理概要

暗黙のオブジェクトリテラル機能は、CoffeeScriptの特徴的な構文であるブレース省略をサポートするための中核的な機能である。

**業務上の目的・背景**：CoffeeScriptでは、オブジェクトリテラルのブレースを省略できる構文が許可されている。例えば、`{a: 1, b: 2}` は `a: 1, b: 2` と簡潔に記述できる。また、インデントベースのオブジェクト定義も可能である。この省略構文は、設定ファイルやオプションオブジェクトの記述をシンプルにし、コードの可読性を向上させる。パーサーで直接処理するには文法が複雑になるため、Rewriterでトークン列を前処理し、暗黙のブレースを明示的な`{`/`}`トークンとして挿入する。

**機能の利用シーン**：以下のようなブレース省略パターンで使用される。
- 関数引数としてのオブジェクト: `func a: 1, b: 2`
- インデントベースのオブジェクト定義:
  ```coffeescript
  config =
    host: 'localhost'
    port: 3000
  ```
- 代入文の右辺: `obj = a: 1, b: 2`
- 配列要素としてのオブジェクト: `[a: 1, b: 2]`

**主要な処理内容**：
1. コロン（`:`）トークンの検出による暗黙オブジェクトの開始判定
2. オブジェクトの開始位置の特定（キーの開始位置）
3. 暗黙のブレース開始トークン（`{`）の挿入
4. オブジェクトの終端検出（カンマ後の非オブジェクト形式、行末など）
5. 暗黙のブレース終了トークン（`}`）の挿入
6. ネストされた暗黙オブジェクトの正しいスタック管理
7. 明示的なブレースとの混在処理

**関連システム・外部連携**：Rewriter内のaddImplicitBracesAndParensメソッドの一部として実装されている。暗黙の関数呼び出し処理と同じメソッド内で処理され、相互に影響する。

**権限による制御**：特になし。コンパイル処理全体に一律適用される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 13 | Annotated Source - Rewriter | 主画面 | 暗黙のブレース追加処理の解説を含む |
| 28 | Annotated Source - Rewriter | 主画面 | 暗黙のブレース追加処理の解説を含む（v2） |

## 機能種別

データ変換処理 / トークン列書き換え

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| tokens | Array | Yes | Lexerが生成したトークン配列（Rewriter内部で処理） | 有効なトークン配列 |

### 入力データソース

Rewriterのrewriteメソッドで管理されるトークン配列（@tokens）を直接操作する。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| tokens | Array | 暗黙のブレースが挿入されたトークン配列 |

### 出力先

Rewriter内部のトークン配列に直接書き込み、後続の処理パスに渡す。

## 処理フロー

### 処理シーケンス

```
1. scanTokensでトークン列をスキャン
   └─ 各トークンに対して以下を判定

2. コロントークンの検出
   └─ tag is ':' の場合、暗黙オブジェクト処理を開始

3. オブジェクトの開始位置を特定
   ├─ 前のトークンがEXPRESSION_ENDの場合、対応する開始位置を使用
   ├─ 2つ前のトークンが@の場合、そこを開始位置とする
   └─ それ以外は1つ前のトークンを開始位置とする

4. 既存のオブジェクト内かどうかを判定
   └─ 既存の明示的/暗黙的オブジェクト内なら処理をスキップ

5. 暗黙のブレース開始トークン（{）を挿入
   └─ startImplicitObject(s, {startsLine, continuationLineIndent})

6. オブジェクトの終端を検出
   ├─ TERMINATOR後に非オブジェクト形式が続く場合
   ├─ カンマ後に非オブジェクト形式が続く場合
   └─ IMPLICIT_ENDトークンの検出

7. 暗黙のブレース終了トークン（}）を挿入
   └─ endImplicitObject()
```

### フローチャート

```mermaid
flowchart TD
    A[トークンをスキャン] --> B{tag is ':'か?}
    B -->|No| A
    B -->|Yes| C[開始位置sを特定]
    C --> D{既存オブジェクト内か?}
    D -->|Yes| E{行頭開始またはカンマ/ブレース後か?}
    E -->|Yes| A
    E -->|No| A
    D -->|No| F[startImplicitObjectで開始ブレース挿入]
    F --> G[継続スキャン]
    G --> H{終了条件を満たすか?}
    H -->|No| G
    H -->|Yes| I[endImplicitObjectで終了ブレース挿入]
    I --> A
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-13-01 | コロン検出 | コロン（:）トークンを検出したら暗黙オブジェクトの開始を判定 | `key: value` パターン |
| BR-13-02 | 開始位置特定 | キーの開始位置を特定し、そこに開始ブレースを挿入 | コロンの前のトークンを基準に特定 |
| BR-13-03 | 明示的ブレース優先 | 既に明示的なブレース内にある場合は暗黙ブレースを追加しない | `{ key: value }` パターン |
| BR-13-04 | 同一行継続 | 同一行でカンマ区切りの場合、オブジェクトを継続 | `a: 1, b: 2` パターン |
| BR-13-05 | 行末終了 | TERMINATORの後に非オブジェクト形式が続いたら終了 | `a: 1\nx = 2` パターン |
| BR-13-06 | カンマ後終了 | カンマの後に非オブジェクト形式が続いたら終了 | `func a: 1, arg2` パターン |
| BR-13-07 | ネスト管理 | ネストされた暗黙オブジェクトはスタックで管理 | `{outer: inner: value}` パターン |

### 計算ロジック

オブジェクト開始位置の特定ロジック:
```coffeescript
s = switch
  when @tag(i - 1) in EXPRESSION_END
    [startTag, startIndex] = start
    if startTag is '[' and startIndex > 0 and @tag(startIndex - 1) is '@'
      startIndex - 1
    else
      startIndex
  when @tag(i - 2) is '@' then i - 2
  else i - 1
```

looksObjectishメソッドによるオブジェクト形式判定:
```coffeescript
looksObjectish: (j) ->
  return yes if @indexOfTag(j, '@', null, ':') isnt -1 or @indexOfTag(j, null, ':') isnt -1
  # EXPRESSION_STARTの後の内容も確認
```

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

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

データベースは使用しない。

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 暗黙のオブジェクトリテラル処理自体はエラーを発生させない | - |

### リトライ仕様

該当なし。

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

トランザクションは使用しない。

## パフォーマンス要件

特に定められていない。トークン列のシングルパススキャンで処理される。

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

特になし。

## 備考

- 暗黙のオブジェクトはスタックで`sameLine`プロパティを追跡し、行をまたぐ場合の処理を制御
- `startsLine`プロパティで行頭から開始したかどうかを追跡
- `continuationLineIndent`で継続行のインデントレベルを追跡

---

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

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

### 推奨読解順序

#### Step 1: ヘルパー関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | rewriter.coffee | `src/rewriter.coffee` | 151-158行目のlooksObjectishメソッドを理解する |

**読解のコツ**: looksObjectishは、指定位置から見てオブジェクトリテラルの形式（`key:`または`@key:`）かどうかを判定する。

#### Step 2: スタック管理とヘルパー関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rewriter.coffee | `src/rewriter.coffee` | 193-198行目のisImplicitObject、inImplicitObject関数を理解する |
| 2-2 | rewriter.coffee | `src/rewriter.coffee` | 212-222行目のstartImplicitObject、endImplicitObject関数を理解する |

**主要処理フロー**:
- **194行目**: `isImplicitObject` でスタックトップが暗黙オブジェクトかを判定
- **212-216行目**: `startImplicitObject` で暗黙ブレースを挿入
- **218-222行目**: `endImplicitObject` で終了ブレースを挿入

#### Step 3: コロン検出とオブジェクト開始処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rewriter.coffee | `src/rewriter.coffee` | 331-359行目のコロン検出と暗黙オブジェクト開始処理を理解する |

**主要処理フロー**:
- **331行目**: `if tag is ':'` でコロンを検出
- **333-341行目**: オブジェクトの開始位置`s`を特定
- **343行目**: `startsLine` で行頭開始かどうかを判定
- **346-355行目**: 既存オブジェクト内かどうかを判定
- **358行目**: `startImplicitObject(s, ...)` で暗黙ブレースを挿入

#### Step 4: オブジェクト終了条件を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | rewriter.coffee | `src/rewriter.coffee` | 398-413行目の暗黙オブジェクト終了条件を理解する |
| 4-2 | rewriter.coffee | `src/rewriter.coffee` | 428-437行目のカンマ後の終了条件を理解する |

**主要処理フロー**:
- **400-403行目**: TERMINATOR以外でprevTag is ':'以外の場合に終了判定
- **407-409行目**: TERMINATOR後に非オブジェクト形式が続く場合に終了
- **428-437行目**: カンマ後に非オブジェクト形式が続く場合に終了

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

```
Rewriter.rewrite() (rewriter.coffee:43)
    │
    └─ addImplicitBracesAndParens() (rewriter.coffee:176)
           │
           ├─ scanTokens() (rewriter.coffee:71)
           │      │
           │      └─ 各トークンに対して判定処理を実行
           │
           ├─ looksObjectish() (rewriter.coffee:151)
           │      └─ オブジェクト形式かどうかを判定
           │
           ├─ startImplicitObject() (rewriter.coffee:212)
           │      └─ generate('{', ...) でトークン生成
           │
           ├─ endImplicitObject() (rewriter.coffee:218)
           │      └─ generate('}', ...) でトークン生成
           │
           └─ implicitObjectContinues() (rewriter.coffee:224)
                  └─ 次の行もオブジェクト形式かを判定
```

### データフロー図

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

トークン列              暗黙のオブジェクト処理           変換後トークン列

[IDENTIFIER,            ├─ コロン検出                    ['{',
 'a']                   ├─ 開始位置特定                    generated: true]
[':']                   ├─ startImplicitObject           [IDENTIFIER,
[NUMBER,                ├─ 終端検出                         'a']
 '1']          ───▶    └─ endImplicitObject      ───▶   [':']
[',']                                                    [NUMBER,
[IDENTIFIER,                                               '1']
 'b']                                                    [',']
[':']                                                    [IDENTIFIER,
[NUMBER,                                                   'b']
 '2']                                                    [':']
                                                         [NUMBER,
                                                           '2']
                                                         ['}',
                                                           generated: true]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| rewriter.coffee | `src/rewriter.coffee` | ソース | addImplicitBracesAndParensメソッドの実装 |
| lexer.coffee | `src/lexer.coffee` | ソース | コロントークンを生成するLexer |
| grammar.coffee | `src/grammar.coffee` | ソース | ブレースを処理する文法定義 |
| helpers.coffee | `src/helpers.coffee` | ソース | ヘルパー関数 |
