# 画面設計書 13-Annotated Source - Rewriter

## 概要

本ドキュメントは、CoffeeScript v1のソースコード解説ページ「Annotated Source - Rewriter」の画面設計書である。Doccoを使用して自動生成されたドキュメントページで、rewriter.coffeeのソースコードとその解説を並列表示する。

### 本画面の処理概要

この画面は、CoffeeScriptコンパイラのトークン書き換え処理を行うrewriter.coffeeのソースコードを、コメントと実装コードを並列表示する形式で解説するドキュメントページである。Rewriterは、字句解析（Lexer）と構文解析（Parser）の間に位置し、暗黙的な構文をより明示的な形に変換する役割を持つ。

**業務上の目的・背景**：CoffeeScriptの暗黙的な構文（省略記法）がどのように処理されるかを理解するために必要な画面である。CoffeeScriptでは、括弧やブレースの多くを省略できるが、Rewriterがこれらの省略された要素を補完してパーサーに渡す。言語設計やコンパイラ実装を学ぶ開発者にとって、この前処理の仕組みを理解することは重要である。

**画面へのアクセス方法**：v1ドキュメントページ（docs/v1/index.html）のAnnotated Sourceセクション、またはAnnotated Source - Index（docs/v1/annotated-source/index.html）から「rewriter.coffee」リンクをクリックしてアクセスする。直接URL（docs/v1/annotated-source/rewriter.html）でもアクセス可能である。

**主要な操作・処理内容**：
1. ソースコードとコメントの並列表示を閲覧する
2. 「Jump To...」メニューから他のソースファイル解説ページへ遷移する
3. セクション番号リンク（pilcrow）をクリックして特定のコードセクションへの直接リンクを取得する
4. rewriteメソッドの各パス処理（removeLeadingNewlines、closeOpenCalls、addImplicitBracesAndParens等）の解説を確認する

**画面遷移**：
- 遷移元: v1ドキュメント（docs/v1/index.html）、Annotated Source - Index（docs/v1/annotated-source/index.html）、他のAnnotated Sourceページ
- 遷移先: Jump Toメニューから他のすべてのAnnotated Sourceページ

**権限による表示制御**：本画面は静的HTMLファイルであり、認証・認可の仕組みは存在しない。すべてのユーザーが同一の内容を閲覧できる。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 11 | Rewriter | 主機能 | トークン書き換えrewriter.coffeeのソースコード解説表示 |
| 12 | 暗黙の関数呼び出し | 補助機能 | addImplicitBracesAndParensの解説を含む |
| 13 | 暗黙のオブジェクトリテラル | 補助機能 | 暗黙のブレース追加処理の解説を含む |

## 画面種別

詳細（ドキュメント閲覧画面）

## URL/ルーティング

- URL: `/docs/v1/annotated-source/rewriter.html`
- 静的HTMLファイルとして配置

## 入出力項目

本画面は静的HTMLであり、ユーザー入力項目は存在しない。

| 項目名 | 入出力 | 型 | 必須 | 説明 |
|--------|--------|-----|------|------|
| - | - | - | - | 入力項目なし |

## 表示項目

| 項目名 | データ型 | 説明 |
|--------|----------|------|
| ページタイトル | テキスト | "rewriter.coffee" |
| ソースコード | HTML（ハイライト済み） | rewriter.coffeeの全ソースコード |
| コメント/解説 | HTML | 各コードセクションに対応する解説テキスト |
| Jump Toメニュー | リンクリスト | 他のソースファイルへのナビゲーション |
| セクションリンク | アンカーリンク | 各セクションへの直接リンク（#section-N形式） |

## イベント仕様

### 1-Jump Toメニュークリック

Jump Toリンクをクリックすると、対応するソースコード解説ページへ遷移する。

- イベントタイプ: クリック
- 対象要素: `#jump_to a.source`
- 処理内容: 指定されたHTMLファイルへのページ遷移

### 2-セクションリンククリック

各セクションの段落記号（pilcrow: &#182;）をクリックすると、そのセクションへの直接リンクがブラウザのURLバーに表示される。

- イベントタイプ: クリック
- 対象要素: `a.pilcrow`
- 処理内容: URLハッシュの変更（#section-N）

## データベース更新仕様

### 操作別データベース影響一覧

本画面は静的HTMLファイルであり、データベース操作は発生しない。

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| - | - | - | データベース操作なし |

## メッセージ仕様

本画面は静的HTMLであり、動的なメッセージ表示機能は存在しない。

| メッセージID | 種別 | メッセージ内容 | 表示条件 |
|-------------|------|---------------|----------|
| - | - | - | - |

## 例外処理

本画面は静的HTMLであり、アプリケーションレベルの例外処理は存在しない。
- HTTPレベル: 404 Not Found（ファイルが存在しない場合）
- HTTPレベル: 500 Internal Server Error（サーバー設定エラー等）

## 備考

- 本画面はDoccoツールによって自動生成されたHTMLファイルである
- ソースコードはsrc/rewriter.coffeeから生成される
- RewriterはLexerから直接呼び出される
- スタイルシートはdocco.cssを使用
- v2系にも同様のページ（docs/v2/annotated-source/rewriter.html）が存在する

---

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

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

### 推奨読解順序

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

Rewriterが操作するトークン配列の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | rewriter.coffee | `src/rewriter.coffee` | 行27-32: `generate`関数 - 生成トークンの作成 |
| 1-2 | rewriter.coffee | `src/rewriter.coffee` | 行10-23: `moveComments`関数 - コメントの移動処理 |

**読解のコツ**: トークンは`[tag, value, locationData]`の形式の配列である。`generated`プロパティがtrueのトークンは、Rewriterによって生成されたものである。

#### Step 2: メインの処理フローを理解する

rewriteメソッドで実行される各パスの役割を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rewriter.coffee | `src/rewriter.coffee` | 行43-64: `rewrite`メソッド - 全体の処理フロー |
| 2-2 | rewriter.coffee | `src/rewriter.coffee` | 行50: `removeLeadingNewlines` - 先頭改行削除 |
| 2-3 | rewriter.coffee | `src/rewriter.coffee` | 行51-52: `closeOpenCalls/Indexes` - 括弧閉じ |
| 2-4 | rewriter.coffee | `src/rewriter.coffee` | 行55: `addImplicitBracesAndParens` - 暗黙要素追加 |

**主要処理フロー**:
1. **行50**: `removeLeadingNewlines()` - 先頭のTERMINATORトークンを削除
2. **行51**: `closeOpenCalls()` - CALL_STARTに対応するCALL_ENDを追加
3. **行52**: `closeOpenIndexes()` - INDEX_STARTに対応するINDEX_ENDを追加
4. **行53**: `normalizeLines()` - 行の正規化
5. **行54**: `tagPostfixConditionals()` - 後置条件のタグ付け
6. **行55**: `addImplicitBracesAndParens()` - 暗黙の括弧とブレースを追加

#### Step 3: 暗黙的構文の処理を理解する

最も複雑な`addImplicitBracesAndParens`メソッドの動作を詳細に把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rewriter.coffee | `src/rewriter.coffee` | `addImplicitBracesAndParens`メソッド |
| 3-2 | rewriter.coffee | `src/rewriter.coffee` | スタック管理による入れ子構造の追跡 |

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

```
rewriter.html (生成されたHTML)
    |
    +-- rewriter.coffee (ソースファイル)
           |
           +-- helpers.coffee
           |      +-- throwSyntaxError
           |      +-- extractAllCommentTokens
           |
           +-- (呼び出し元) lexer.coffee
                  +-- Lexer.prototype.rewrite
                         +-- Rewriter.prototype.rewrite
```

### データフロー図

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

Lexer.tokenize()    --->   Rewriter.rewrite()    --->   修正済みトークン配列
       |                           |
       |                           +-- removeLeadingNewlines
       |                           +-- closeOpenCalls
       |                           +-- closeOpenIndexes
       |                           +-- normalizeLines
       |                           +-- tagPostfixConditionals
       |                           +-- addImplicitBracesAndParens
       |
       +-- トークン配列
       +-- [tag, value, locationData]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| rewriter.html | `docs/v1/annotated-source/rewriter.html` | 生成HTML | 本画面のHTMLファイル |
| rewriter.coffee | `src/rewriter.coffee` | ソース | トークン書き換え処理 |
| lexer.coffee | `src/lexer.coffee` | ソース | Rewriterの呼び出し元 |
| helpers.coffee | `src/helpers.coffee` | ソース | 依存モジュール（エラー処理） |
| docco.css | `docs/v1/annotated-source/docco.css` | スタイル | ページスタイル定義 |
