# 通知設計書 16-regex start error

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「regular expressions cannot begin with {character}」（正規表現開始文字エラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内で正規表現リテラルが無効な文字（特に`*`）で始まっている場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：JavaScriptの正規表現では、量指定子（`*`, `+`, `?`, `{n}`など）はパターンの先頭に配置できない。これらは前の要素の繰り返しを指定するものであり、先頭に配置すると「何を繰り返すか」が不明になる。この通知により、開発者は正規表現の構文エラーを早期に発見できる。また、`/*`はコメント開始と誤解される可能性があるため、明確なエラーメッセージで問題を特定できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`regexToken`メソッドが正規表現リテラルを処理する際に発生する。REGEX_ILLEGAL正規表現でマッチした場合に検出される。

**通知の受信者**：CoffeeScriptコードをコンパイルしている開発者。コマンドラインツール、REPL、またはプログラムからの呼び出し時に、標準エラー出力またはエラーオブジェクトとして通知される。

**通知内容の概要**：エラーメッセージ「regular expressions cannot begin with {character}」と、該当するソースコード内の位置情報（行番号・列番号）、および無効な開始文字が含まれる。

**期待されるアクション**：開発者は該当する正規表現の先頭文字を確認し、量指定子を削除するか、適切なパターンに修正する必要がある。先頭に`*`をリテラルとしてマッチさせたい場合は`\*`のようにエスケープする。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時即時） |
| 優先度 | 高（コンパイル停止） |
| リトライ | なし |

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

コンパイラ呼び出し元に対してエラーがスローされる。CLIの場合は標準エラー出力、プログラムAPIの場合は例外としてスローされる。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | `[ファイル名]:行:列: error: regular expressions cannot begin with {character}` |
| 形式 | テキスト |

### 本文テンプレート

```
[stdin]:1:2: error: regular expressions cannot begin with *
/* foo/
 ^
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| character | 無効な開始文字（例: `*`） | REGEX_ILLEGALマッチ結果 | Yes |
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | regexTokenメソッド実行 | `REGEX_ILLEGAL.exec @chunk`がマッチ | 正規表現が無効な文字で始まっている |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効な開始 | 正規表現が有効な文字で始まっている場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[regexTokenメソッド呼び出し]
    B --> C{REGEX_ILLEGAL.exec @chunk}
    C -->|マッチ| D[error 'regular expressions cannot begin with' 呼び出し]
    C -->|マッチしない| E[通常処理継続]
    D --> F[throwSyntaxError]
    F --> G[コンパイル停止]
```

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

### 参照テーブル一覧

該当なし（ファイルベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | `/*`で始まる正規表現 | 先頭の`*`を削除またはエスケープ |
| SyntaxError | ヒアドキュメント形式で`* `から始まる | 先頭の`*`を削除またはエスケープ |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし（即時エラー通知）

### 配信時間帯

制限なし

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

特になし。ソースコードの内容がエラーメッセージに含まれる可能性があるが、開発時のみ表示されるため問題なし。

## 備考

- REGEX_ILLEGAL定数で無効な正規表現開始パターンを定義
- 主に`*`が対象だが、他の量指定子も同様に検出される可能性がある
- ヒアドキュメント形式の正規表現（`///`）でも同様のチェックが適用される

---

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

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

### 推奨読解順序

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

正規表現関連の定数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | REGEX_ILLEGAL定数の定義を確認 |

**読解のコツ**: REGEX_ILLEGALは無効な正規表現開始パターンを検出する正規表現。マッチ結果の`match[2]`に無効な文字が含まれる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.coffee | `src/lexer.coffee` | regexTokenメソッド（444行目〜）がエントリーポイント |

**主要処理フロー**:
1. **444行目**: `regexToken`メソッド開始
2. **445行目**: `switch`文で複数のケースを処理
3. **446行目**: `when match = REGEX_ILLEGAL.exec @chunk`で無効なパターンをチェック

#### Step 3: 実際のエラー検出ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (446-448行) | REGEX_ILLEGALマッチとエラー発生 |

**主要処理フロー**:
- **446行目**: `when match = REGEX_ILLEGAL.exec @chunk`でマッチ判定
- **447-448行目**: `@error "regular expressions cannot begin with #{match[2]}"`でエラー発生
- **offset: match.index + match[1].length**でエラー位置を指定

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ regexToken()
           │      └─ switch文
           │             └─ when REGEX_ILLEGAL.exec @chunk
           │                    └─ error('regular expressions cannot begin with')
           │                           └─ throwSyntaxError()
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

/* foo/ ─────────▶ Lexer.regexToken() ───▶ SyntaxError例外
     │                    │
     │              REGEX_ILLEGAL.exec()
     │                    ↓
     │              match[2] = "*"
     │                    ↓
     └────────────▶ エラーメッセージ生成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器本体、regexTokenメソッド（444-502行目） |
| lexer.coffee | `src/lexer.coffee` | ソース | REGEX_ILLEGAL定数定義 |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数の定義 |
| error_messages.coffee | `test/error_messages.coffee` | テスト | regex start errorのテストケース（568-584行目） |
