# 通知設計書 15-errRstFootnoteMismatch

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（docgen）およびRST/Markdownパーサーにおける脚注不一致エラー通知「errRstFootnoteMismatch」の設計について記述する。

### 本通知の処理概要

errRstFootnoteMismatchは、reStructuredText（RST）またはMarkdownドキュメント内で、自動番号脚注または自動シンボル脚注の定義数と参照数が一致しない場合に発生するエラー通知である。

**業務上の目的・背景**：RSTでは脚注を `[#]_` （自動番号）または `[*]_` （自動シンボル）形式で参照し、対応する脚注定義 `.. [#]` または `.. [*]` を記述する。脚注の参照と定義の数が一致しないと、正しくレンダリングできないため、このエラーでユーザーに修正を促す。

**通知の送信タイミング**：ドキュメント全体のパースが完了し、脚注の置換処理（resolveSubstitutions関数）が実行される際に、脚注定義数と参照数の不一致がチェックされる。

**通知の受信者**：Nimコンパイラを使用してドキュメント生成（nim doc）を実行している開発者。

**通知内容の概要**：エラーが発生したファイル名、行番号情報、および脚注定義と参照のそれぞれの数と行番号リストを含むエラーメッセージ。

**期待されるアクション**：開発者はエラーメッセージに基づいて、欠落している脚注定義を追加するか、使用されていない脚注参照を削除して、数を一致させる。

## 通知種別

コンパイラ標準エラー出力（stderr）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（docgen/rst） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: number of footnotes and their references don't match: {詳細情報}
```

詳細情報の例：
```
2 (lines 10, 20) != 3 (lines 5, 15, 25) for auto-numbered footnotes
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 脚注定義/参照の数と行番号の不一致情報 | resolveSubstitutions関数の比較結果 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | 脚注置換処理 | 自動番号脚注の数不一致 | lineFootnoteNum.len != lineFootnoteNumRef.len |
| ドキュメント生成 | 脚注置換処理 | 自動シンボル脚注の数不一致 | lineFootnoteSym.len != lineFootnoteSymRef.len |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| errorsAsWarnings | roPreferMarkdownオプション有効かつスタンドアロンドキュメントでない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[RST/Markdownパース完了] --> B[resolveSubstitutions呼び出し]
    B --> C{自動番号脚注チェック}
    C -->|定義数 != 参照数| D[meFootnoteMismatch発行]
    C -->|一致| E{自動シンボル脚注チェック}
    E -->|定義数 != 参照数| D
    E -->|一致| F[脚注置換実行]
    D --> G[docgen.compilerMsgHandler]
    G --> H[errRstFootnoteMismatchに変換]
    H --> I[globalErrorとして出力]
    F --> J[終了]
    I --> J
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 自動番号脚注不一致 | `[#]_` 参照数と `.. [#]` 定義数が異なる | 欠落した脚注定義を追加、または不要な参照を削除 |
| 自動シンボル脚注不一致 | `[*]_` 参照数と `.. [*]` 定義数が異なる | 欠落した脚注定義を追加、または不要な参照を削除 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（コンパイル実行時に即時出力）

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

- 特になし

## 備考

- 自動番号脚注（`[#]_`）と自動シンボル脚注（`[*]_`）は別々にカウントされる
- 名前付き脚注（`[footnote_name]_`）はこのエラーの対象外
- エラーメッセージには脚注定義と参照の両方の行番号が含まれるため、デバッグが容易

---

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

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

### 推奨読解順序

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

脚注管理に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型のmeFootnoteMismatch定義（70行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrRstFootnoteMismatch定義（44行目） |
| 1-3 | rst.nim | `lib/packages/docutils/rst.nim` | PRstSharedState型の脚注関連フィールド（lineFootnoteNum, lineFootnoteNumRef等） |

**読解のコツ**: 脚注は定義（lineFootnoteNum/Sym）と参照（lineFootnoteNumRef/SymRef）で別々に管理され、最終的に数が一致する必要がある。

#### Step 2: エラー発行箇所を理解する

脚注検証とエラー発行の箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rst.nim | `lib/packages/docutils/rst.nim` | resolveSubstitutions関数（956-977行目付近） |
| 2-2 | rst.nim | `lib/packages/docutils/rst.nim` | listFootnotes関数（脚注情報のフォーマット） |

**主要処理フロー**:
1. **956-965行目**: listFootnotes関数で脚注情報を文字列にフォーマット
2. **966-970行目**: lineFootnoteNum.len != lineFootnoteNumRef.lenの場合にmeFootnoteMismatch発行
3. **971-975行目**: lineFootnoteSym.len != lineFootnoteSymRef.lenの場合にmeFootnoteMismatch発行

#### Step 3: メッセージ変換レイヤーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（257行目）でメッセージ変換 |

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

```
nim doc (ドキュメント生成コマンド)
    │
    ├─ docgen.nim::generateDoc
    │      │
    │      └─ rst.nim::rstParse
    │             │
    │             ├─ parseDoc (ドキュメントパース)
    │             │      └─ 脚注定義/参照の収集
    │             │
    │             └─ resolveSubstitutions (956-977行目)
    │                    │
    │                    ├─ listFootnotes (脚注情報フォーマット)
    │                    │
    │                    ├─ 自動番号脚注チェック (966-970行目)
    │                    │      └─ rstMessage(meFootnoteMismatch)
    │                    │
    │                    └─ 自動シンボル脚注チェック (971-975行目)
    │                           └─ rstMessage(meFootnoteMismatch)
    │
    └─ docgen.nim::compilerMsgHandler (257行目)
           │
           └─ msgs.nim::globalError (errRstFootnoteMismatch)
```

### データフロー図

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

RST/Markdownファイル ───▶ parseDoc ───▶ 脚注定義/参照を収集
                              │
                              ▼
                         lineFootnoteNum/Ref (自動番号)
                         lineFootnoteSym/Ref (自動シンボル)
                              │
                              ▼
                         resolveSubstitutions
                              │
                              ▼ [数が一致しない場合]
                         rstMessage(meFootnoteMismatch)
                              │
                              ▼
                         docgen.nim::compilerMsgHandler
                              │
                              ▼
                         TMsgKind(errRstFootnoteMismatch)
                              │
                              ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RST/Markdownパーサー、脚注処理 |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成器、メッセージハンドラ |
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | コンパイラメッセージシステム |
