# 通知設計書 11-mixed indentation

## 概要

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

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内でインデントにスペースとタブが混在している場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：CoffeeScriptはインデントベースの言語であり、コードブロックの範囲をインデントで判断する。スペースとタブが同一のインデントレベルで混在すると、コードの構造を正しく解釈できなくなる。この通知により、開発者はインデントの一貫性を保つことができ、意図しない動作やコンパイルエラーを防止できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`lineToken`メソッドが改行とインデントを処理する際に発生する。具体的には、現在行のインデント文字列が単一の文字種（スペースのみ、またはタブのみ）で構成されていない場合に検出される。

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

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

**期待されるアクション**：開発者は該当行のインデントを確認し、スペースまたはタブのいずれか一方に統一する必要がある。エディタの設定で「タブをスペースに変換」などの機能を利用することが推奨される。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### エラーメッセージ

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

### 本文テンプレート

```
[stdin]:1:5: error: mixed indentation
new Layer
    ^
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | lineTokenメソッド実行 | インデント文字列が `/^(.?)\1*$/` にマッチしない | スペースとタブの混在を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 正規パターンマッチ | インデントが単一文字種のみで構成されている場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[lineTokenメソッド呼び出し]
    B --> C[改行・インデント検出]
    C --> D{インデント文字列取得}
    D --> E{正規表現チェック /^(.?)\1*$/}
    E -->|マッチしない| F[error 'mixed indentation' 呼び出し]
    E -->|マッチ| G[通常処理継続]
    F --> H[throwSyntaxError]
    H --> I[コンパイル停止]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | スペースとタブの混在 | インデント文字を統一する |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

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

## 備考

- CoffeeScriptは各トップレベルブロックごとに異なるインデントスタイル（スペースまたはタブ）を使用可能
- 同一ブロック内では一貫したインデント文字を使用する必要がある

---

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

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

### 推奨読解順序

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

Lexerクラスの状態管理とトークン構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | Lexerクラスの状態変数（indent, indentLiteral等）を確認 |

**読解のコツ**: CoffeeScriptの`@`は`this.`の省略形。`@indent`は現在のインデントレベルを示す。

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

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

**主要処理フロー**:
1. **37行目**: `tokenize`メソッドで初期化
2. **44行目**: `@indentLiteral = ''`でインデント文字列を初期化
3. **74行目**: `@lineToken()`が呼び出される

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (514-535行) | lineTokenメソッドでのインデント処理 |

**主要処理フロー**:
- **524行目**: `size = indent.length - 1 - indent.lastIndexOf '\n'`でインデントサイズを計算
- **527行目**: `newIndentLiteral = if size > 0 then indent[-size..] else ''`で新しいインデント文字列を取得
- **528-530行目**: `/^(.?)\1*$/`の正規表現でインデント文字の一貫性をチェック。マッチしない場合に`'mixed indentation'`エラー

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ lineToken()
           │      └─ 正規表現チェック /^(.?)\1*$/
           │             └─ error('mixed indentation')
           │                    └─ throwSyntaxError()
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

ソースコード ───▶ Lexer.lineToken() ───▶ SyntaxError例外
     │                    │
     │              正規表現チェック
     │              /^(.?)\1*$/
     └─ インデント ─────┘
        文字列
```

### 関連ファイル一覧

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