# 画面設計書 12-Annotated Source - Grammar

## 概要

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

### 本画面の処理概要

この画面は、CoffeeScriptコンパイラの文法定義を行うgrammar.coffeeのソースコードを、コメントと実装コードを並列表示する形式で解説するドキュメントページである。Jisonパーサージェネレータ用の文法ルールが定義されている。

**業務上の目的・背景**：CoffeeScriptの文法構造を理解するために必要な画面である。CoffeeScriptがどのような構文規則を持ち、どのようにパース処理が行われるかを学ぶことができる。言語拡張やカスタムトランスパイラの開発者にとって、この文法定義の理解は不可欠である。Jisonを使用したボトムアップパーサーの実装方法を学ぶ教材としても有用である。

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

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

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

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 14 | Grammar | 主機能 | 文法定義grammar.coffeeのソースコード解説表示 |
| 15 | パーサー生成 | 補助機能 | Jisonパーサー生成の解説を含む |

## 画面種別

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

## URL/ルーティング

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

## 入出力項目

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

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

## 表示項目

| 項目名 | データ型 | 説明 |
|--------|----------|------|
| ページタイトル | テキスト | "grammar.coffee" |
| ソースコード | HTML（ハイライト済み） | grammar.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/grammar.coffeeから生成される
- Jisonパーサージェネレータを使用してparser.jsを生成する
- `cake build:parser`コマンドでパーサーを再生成可能
- スタイルシートはdocco.cssを使用
- v2系にも同様のページ（docs/v2/annotated-source/grammar.html）が存在する

---

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

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

### 推奨読解順序

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

まず、Jisonの文法定義形式と、grammar.coffeeで定義される構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | grammar.coffee | `src/grammar.coffee` | 行18: `{Parser} = require 'jison'` - Jisonへの依存 |
| 1-2 | grammar.coffee | `src/grammar.coffee` | 行26: `unwrap`正規表現 - 関数ラッパー最適化 |
| 1-3 | grammar.coffee | `src/grammar.coffee` | 行33-85: `o`関数 - DSLヘルパー関数 |

**読解のコツ**: `o`関数はJisonの文法ルールを定義するDSL（Domain Specific Language）である。`patternString`がマッチングルール、`action`がマッチ時に実行されるコードを表す。

#### Step 2: 文法ルールを理解する

grammarオブジェクトで定義される各非終端記号の役割を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | grammar.coffee | `src/grammar.coffee` | 行100: `grammar`オブジェクト開始 |
| 2-2 | grammar.coffee | `src/grammar.coffee` | Root: プログラム全体のエントリーポイント |
| 2-3 | grammar.coffee | `src/grammar.coffee` | Body: 文のシーケンス |
| 2-4 | grammar.coffee | `src/grammar.coffee` | Expression: 式の定義 |

**主要処理フロー**:
1. **行1-16**: Jisonとパーサー生成の概要説明
2. **行17-18**: Jisonパーサーのインポート
3. **行26-85**: DSLヘルパー関数`o`の定義
4. **行100以降**: 文法ルール定義

#### Step 3: パーサー生成プロセスを理解する

grammar.coffeeからparser.jsが生成されるプロセスを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | grammar.coffee | `src/grammar.coffee` | 末尾: exports.parser定義 |
| 3-2 | Cakefile | `Cakefile` | build:parserタスク |

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

```
grammar.html (生成されたHTML)
    |
    +-- grammar.coffee (ソースファイル)
           |
           +-- jison (パーサージェネレータ)
           |      +-- Parser クラス
           |
           +-- (生成物) parser.js
                  |
                  +-- nodes.coffee (ノード生成)
                         +-- 各ASTノードクラス
```

### データフロー図

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

src/grammar.coffee   --->   Jison Parser Generator    --->   lib/parser.js
       |                           |
       |                           +-- LALR(1)パース表生成
       |                           +-- アクション関数埋め込み
       |
       +-- 文法ルール定義
       +-- アクション（ノード生成）
       +-- 演算子優先順位
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| grammar.html | `docs/v1/annotated-source/grammar.html` | 生成HTML | 本画面のHTMLファイル |
| grammar.coffee | `src/grammar.coffee` | ソース | 文法定義ファイル |
| parser.js | `lib/parser.js` | 生成JS | 生成されたパーサー |
| nodes.coffee | `src/nodes.coffee` | ソース | 文法アクションで使用するノードクラス |
| docco.css | `docs/v1/annotated-source/docco.css` | スタイル | ページスタイル定義 |
| Cakefile | `Cakefile` | ビルド | パーサー生成タスク定義 |
