# 通知設計書 12-indentation mismatch

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「indentation mismatch」（インデント不一致エラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内で新しい行のインデント文字列が、既存のインデント文字列と異なるスタイル（スペースとタブの混在パターン）で構成されている場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：CoffeeScriptはインデントベースの言語であり、ブロック構造をインデントで定義する。同一のコードブロック内では、インデントの「先頭部分」が一貫している必要がある。例えば、最初の行がスペース2つでインデントされている場合、次の行もスペースで始まる必要がある。この通知により、開発者は意図しないインデントスタイルの変更を検出でき、コードの構造的な整合性を維持できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`lineToken`メソッドが改行とインデントを処理する際に発生する。新しいインデント文字列の先頭部分と、現在のインデント文字列の先頭部分が一致しない場合に検出される。

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

**通知内容の概要**：エラーメッセージ「indentation mismatch」と、該当するソースコード内の位置情報（行番号・列番号）が含まれる。

**期待されるアクション**：開発者は該当行のインデントを確認し、前の行と同じインデントスタイルに統一する必要がある。具体的には、スペースで始まるインデントの後にタブで始まる行がある場合、どちらかに統一する。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### エラーメッセージ

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

### 本文テンプレート

```
[stdin]:3:1: error: indentation mismatch
new Layer
 x: 0
	y: 1
^
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | lineTokenメソッド実行 | `newIndentLiteral[...minLiteralLength] isnt @indentLiteral[...minLiteralLength]` | インデント先頭部分の不一致を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 先頭一致 | 新しいインデントと現在のインデントの先頭部分が一致する場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[lineTokenメソッド呼び出し]
    B --> C[改行・インデント検出]
    C --> D[newIndentLiteral取得]
    D --> E[minLiteralLength計算]
    E --> F{先頭部分の比較}
    F -->|不一致| G[error 'indentation mismatch' 呼び出し]
    F -->|一致| H[通常処理継続]
    G --> I[throwSyntaxError]
    I --> J[コンパイル停止]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | インデント先頭部分の不一致 | インデントスタイルを統一する |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

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

## 備考

- 「mixed indentation」エラーとは異なり、このエラーは同一行内での混在ではなく、行間でのスタイル変更を検出する
- 各トップレベルブロックは異なるインデントスタイルを使用可能だが、ネストされたブロック内では一貫性が必要

---

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

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

### 推奨読解順序

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

Lexerクラスの状態管理変数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | `@indentLiteral`変数（44行目）が現在のインデント文字列を保持 |

**読解のコツ**: `@indentLiteral`は現在のブロックで使用されているインデント文字列を追跡する。新しい行のインデントはこれと比較される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.coffee | `src/lexer.coffee` | tokenizeメソッド（37行目〜）内でlineToken呼び出し |

**主要処理フロー**:
1. **44行目**: `@indentLiteral = ''`で初期化
2. **74行目**: `@lineToken()`が呼び出される

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (532-535行) | インデント先頭部分の比較ロジック |

**主要処理フロー**:
- **527行目**: `newIndentLiteral`で新しい行のインデント文字列を取得
- **532行目**: `minLiteralLength = Math.min newIndentLiteral.length, @indentLiteral.length`で比較する長さを決定
- **533-535行目**: 先頭部分の比較を行い、不一致なら`'indentation mismatch'`エラー

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ lineToken()
           │      ├─ newIndentLiteral取得
           │      ├─ minLiteralLength計算
           │      └─ 先頭部分比較
           │             └─ error('indentation mismatch')
           │                    └─ throwSyntaxError()
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

ソースコード ───▶ Lexer.lineToken() ───▶ SyntaxError例外
     │                    │
     │              newIndentLiteral
     │                    ↓
     │              minLiteralLength計算
     │                    ↓
@indentLiteral ────▶ 先頭部分比較
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器本体、エラー検出ロジック（532-535行目） |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数の定義 |
| formatting.coffee | `test/formatting.coffee` | テスト | indentation mismatchのテストケース（311-320行目） |
