# 通知設計書 19-invalid escape sequence

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「invalid escape sequence」（無効なエスケープシーケンスエラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内の文字列または正規表現リテラルで無効なエスケープシーケンス（例: `\x7g`, `\uA02`, `\u{}`）が使用された場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：JavaScriptのエスケープシーケンスには厳格な形式がある。ヘキサエスケープ（`\xHH`）は2桁の16進数、Unicodeエスケープ（`\uHHHH`）は4桁の16進数、Unicodeコードポイントエスケープ（`\u{HHHH}`）は1桁以上の16進数を中括弧内に持つ必要がある。不完全または不正な形式のエスケープシーケンスは実行時エラーになるため、コンパイル時にこれを検出することで、開発者は早期に問題を発見できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`validateEscapes`メソッドが文字列または正規表現リテラル内のエスケープシーケンスを検証する際に発生する。STRING_INVALID_ESCAPEまたはREGEX_INVALID_ESCAPEパターンにマッチし、かつ8進エスケープでない場合に検出される。

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

**通知内容の概要**：エラーメッセージ「invalid escape sequence {sequence}」と、該当するソースコード内の位置情報（行番号・列番号）、および無効なエスケープシーケンスが含まれる。

**期待されるアクション**：開発者は該当するエスケープシーケンスを正しい形式に修正する必要がある。(1) ヘキサエスケープは`\xHH`（2桁）、(2) Unicodeエスケープは`\uHHHH`（4桁）、(3) Unicodeコードポイントエスケープは`\u{H...}`（中括弧内に16進数）。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | `[ファイル名]:行:列: error: invalid escape sequence {sequence}` |
| 形式 | テキスト |

### 本文テンプレート

```
[stdin]:1:10: error: invalid escape sequence \x7g
"a\0\tb\\\x7g"
         ^^^^
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| sequence | 無効なエスケープシーケンス（例: `\x7g`, `\uA02`） | invalidEscapeRegexマッチ結果 | Yes |
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | validateEscapesメソッド実行 | `hex`, `unicodeCodePoint`, `unicode`のいずれかがマッチ | 不正なヘキサ/Unicodeエスケープを検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 有効なエスケープ | 正しい形式のエスケープシーケンスはエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[stringTokenまたはregexToken呼び出し]
    B --> C[validateEscapesメソッド呼び出し]
    C --> D[invalidEscapeRegex.exec str]
    D --> E{octalがマッチ?}
    E -->|Yes| F[octal escape error]
    E -->|No| G{hex, unicodeCodePoint, unicodeがマッチ?}
    G -->|Yes| H[error 'invalid escape sequence' 呼び出し]
    G -->|No| I[通常処理継続]
    H --> J[throwSyntaxError]
    J --> K[コンパイル停止]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | ヘキサエスケープが2桁未満（例: `\x7g`, `\x0`） | 正しい2桁の16進数を指定 |
| SyntaxError | Unicodeエスケープが4桁未満（例: `\uA02`, `\u`） | 正しい4桁の16進数を指定 |
| SyntaxError | Unicodeコードポイントエスケープが不正（例: `\u{}`, `\u{G02}`） | 正しい16進数を中括弧内に指定 |
| SyntaxError | Unicodeコードポイントエスケープが閉じられていない（例: `\u{01abc`） | 閉じ中括弧を追加 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

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

## 備考

- ヘキサエスケープ: `\xHH`（H = 16進数字）
- Unicodeエスケープ: `\uHHHH`（H = 16進数字）
- Unicodeコードポイントエスケープ: `\u{H...}`（H = 16進数字、1文字以上）
- Issue #3795およびIssue #4248に関連
- STRING_INVALID_ESCAPEの正規表現パターン:
  - `(x(?![\da-fA-F]{2}).{0,2})` - 不正なヘキサエスケープ
  - `(u\{(?![\da-fA-F]{1,}\})[^}]*\}?)` - 不正なUnicodeコードポイントエスケープ
  - `(u(?!\{|[\da-fA-F]{4}).{0,4})` - 不正なUnicodeエスケープ

---

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

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

### 推奨読解順序

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

エスケープシーケンス検証用の正規表現を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | STRING_INVALID_ESCAPE定数（1402-1410行目）を確認 |
| 1-2 | lexer.coffee | `src/lexer.coffee` | REGEX_INVALID_ESCAPE定数（1411-1419行目）を確認 |

**読解のコツ**:
- `(x(?![\da-fA-F]{2}).{0,2})`は2桁の16進数が続かない`\x`をキャプチャ
- `(u\{(?![\da-fA-F]{1,}\})[^}]*\}?)`は不正なUnicodeコードポイントエスケープをキャプチャ
- `(u(?!\{|[\da-fA-F]{4}).{0,4})`は4桁の16進数が続かない`\u`をキャプチャ

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

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

**主要処理フロー**:
1. **1151行目**: `validateEscapes`メソッド開始
2. **1153-1157行目**: `isRegex`オプションに基づいて使用する正規表現を選択
3. **1158行目**: `invalidEscapeRegex.exec str`でマッチング

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (1160-1169行) | エラーメッセージ生成と通知 |

**主要処理フロー**:
- **1160行目**: `[[], before, octal, hex, unicodeCodePoint, unicode] = match`で分解
- **1161-1165行目**: `if octal`で8進エスケープか判定、そうでなければ`"invalid escape sequence"`
- **1166行目**: `invalidEscape = "\\#{octal or hex or unicodeCodePoint or unicode}"`でエスケープ文字列を構築
- **1167-1169行目**: エラーを発生

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ stringToken()
           │      └─ validateEscapes(str)
           │
           ├─ regexToken()
           │      └─ validateEscapes(body, isRegex: yes)
           │
           └─ validateEscapes()
                  ├─ invalidEscapeRegex選択
                  ├─ invalidEscapeRegex.exec(str)
                  └─ if hex or unicodeCodePoint or unicode
                         └─ error('invalid escape sequence...')
                                └─ throwSyntaxError()
```

### データフロー図

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

"a\x7g" ─────────▶ Lexer.validateEscapes() ───▶ SyntaxError例外
     │                    │
     │              STRING_INVALID_ESCAPE.exec()
     │                    ↓
     │              [before, octal, hex, ...] = match
     │                    ↓
     │              hex = "x7g"
     │                    ↓
     └────────────▶ エラーメッセージ生成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器本体、validateEscapesメソッド（1151-1169行目） |
| lexer.coffee | `src/lexer.coffee` | ソース | STRING_INVALID_ESCAPE定数（1402-1410行目） |
| lexer.coffee | `src/lexer.coffee` | ソース | REGEX_INVALID_ESCAPE定数（1411-1419行目） |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数の定義 |
| error_messages.coffee | `test/error_messages.coffee` | テスト | invalid escapesのテストケース（509-566行目、1546-1570行目） |
