# 通知設計書 4-reserved_word_assignment_error

## 概要

本ドキュメントは、CoffeeScriptコンパイラがJavaScriptの予約語に代入しようとした際に発生する構文エラー「reserved word assignment error」の通知仕様を定義する。

### 本通知の処理概要

CoffeeScriptコンパイラのレキサー（字句解析器）において、JavaScriptで予約されている語（case、function、var、void、with、const、let、enum、native、implements、interface、package、private、protected、public、static）に代入を試みた場合に、構文エラーとして通知を行う処理である。

**業務上の目的・背景**：JavaScriptの予約語は将来の言語拡張のために予約されており、これらに代入を行うコードは仕様に違反する。CoffeeScriptがJavaScriptにコンパイルされる際、予約語への代入は実行時エラーを引き起こす可能性がある。この通知により、開発者はコンパイル時点で問題を発見・修正できる。

**通知の送信タイミング**：レキサーのliteralToken()メソッドにおいて、代入演算子が検出され、その直前のトークンがRESERVED配列に含まれることが判明した時点で発生する。

**通知の受信者**：CoffeeScriptソースコードをコンパイルしている開発者。

**通知内容の概要**：エラーメッセージとして「reserved word '{word}' can't be assigned」という形式で、問題となった予約語を特定できるようにしている。

**期待されるアクション**：開発者は該当する予約語を変数名として使用せず、別の識別子名に変更する。

## 通知種別

コンパイラ出力（標準エラー出力 / SyntaxError例外）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に発生） |
| 優先度 | 高（コンパイルを中断） |
| リトライ | 無（即時エラーとして処理） |

### 送信先決定ロジック

CoffeeScriptコンパイラを呼び出しているコンテキストに依存する。

## 通知テンプレート

### エラーメッセージ形式

| 項目 | 内容 |
|-----|------|
| 形式 | テキスト |

### 本文テンプレート

```
[filename]:[line]:[column]: error: reserved word '{word}' can't be assigned
[source_code_line]
[marker]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| word | 代入を試みられた予約語 | isUnassignable関数 | Yes |
| filename | ソースファイル名 | コンパイルオプション | No |
| line | エラー発生行番号 | locationData.first_line | Yes |
| column | エラー発生列番号 | locationData.first_column | Yes |
| source_code_line | エラーが発生した行のソースコード | 入力ソースコード | Yes |
| marker | エラー位置を示すマーカー | 計算により生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | literalToken()メソッド実行中 | 代入演算子の直前トークンがRESERVEDに含まれる場合 | 代入演算子検出時に予約語チェック |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| PROPERTYタグ | プロパティアクセスの場合は抑止 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[literalToken開始] --> B{代入演算子か?}
    B -->|No| C[通常処理継続]
    B -->|Yes| D{直前トークンがPROPERTYか?}
    D -->|Yes| C
    D -->|No| E[isUnassignable呼び出し]
    E --> F{RESERVEDに含まれるか?}
    F -->|No| G[他のチェック継続]
    F -->|Yes| H[error関数呼び出し]
    H --> I[throwSyntaxError実行]
    I --> J[SyntaxError例外発生]
    J --> K[コンパイル中断]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし

### 内部データ構造

| 構造名 | 用途 | 備考 |
|--------|------|------|
| RESERVED配列 | 予約語リスト | lexer.coffeeで定義（1258-1262行目） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | 予約語への代入を試みた | 開発者が変数名を変更 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

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

- エラーメッセージにはソースコードの一部が含まれる

## 備考

- RESERVED配列の内容：'case', 'function', 'var', 'void', 'with', 'const', 'let', 'enum', 'native', 'implements', 'interface', 'package', 'private', 'protected', 'public', 'static'
- No.1（reserved word）は識別子としての使用を禁止、本通知（No.4）は代入を禁止という違いがある

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | RESERVED配列（1258-1262行目） |

**読解のコツ**: RESERVED配列はJavaScriptの予約語を格納しており、これらへの代入は禁止されている。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.coffee | `src/lexer.coffee` | isUnassignable()関数（1190-1198行目） |

**主要処理フロー**:
1. **1195-1196行目**: RESERVEDに含まれるかチェック
2. **1196行目**: 含まれている場合「reserved word '{displayName}' can't be assigned」を返す

#### Step 3: 呼び出し元を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` | literalToken()メソッド（778-781行目） |

**主要処理フロー**:
- **779-780行目**: isUnassignableの結果を取得し、エラーメッセージがあればerrorを呼び出す

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

```
Lexer.tokenize()
    |
    +-- literalToken()
           |
           +-- 代入演算子検出
           |       |
           |       +-- isUnassignable()
           |               |
           |               +-- RESERVED チェック (1195-1196行目)
           |               |
           |               +-- [予約語の場合] エラーメッセージ返却
           |
           +-- error()
                   |
                   +-- throwSyntaxError()
```

### データフロー図

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

ソースコード  -----> literalToken()     -----> トークンストリーム
    |                     |
    |                     v
    |               代入演算子検出
    |                     |
    |                     v
    |            isUnassignable()
    |                     |
    |              [RESERVED に含まれる場合]
    |                     |
    |                     v
    +------------> error() + throwSyntaxError()
                          |
                          v
                   SyntaxError例外
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | RESERVED配列定義とisUnassignable関数 |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数 |
| error_messages.coffee | `test/error_messages.coffee` | テスト | エラーメッセージテスト |
