# 通知設計書 33-warnRstBrokenLink

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（nim doc）において、RST/Markdownドキュメント内のリンク参照が解決できない（壊れたリンク）場合に出力される警告「warnRstBrokenLink」の設計仕様を記述する。

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメント内で使用されているリンク参照が、どのターゲット（プロシージャ、型、モジュール、外部URLなど）にも一致せず解決できない場合に開発者へ通知するものである。

**業務上の目的・背景**：ドキュメント内のリンクはAPIの相互参照やナビゲーションに不可欠である。リンク先が見つからない「壊れたリンク」は、ドキュメントの品質と利用者の体験を著しく損なう。この警告により、ドキュメント作成者は無効なリンクを早期に発見し、正しいリンク先に修正できる。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、以下の2つの場面でトリガーされる：
1. RSTパーサーのパス2（resolveLink関数）において、リンク参照の解決を試みた際にターゲットが見つからない場合
2. Markdownパーサーにおいて、URLプロトコルが無効（安全でない）と判定された場合

**通知の受信者**：Nimソースコードまたはスタンドアロンのドキュメントファイル（.rst/.md）を編集している開発者・ドキュメント作成者。

**通知内容の概要**：「broken link '$1'」形式で、解決できなかったリンク参照名が通知される。$1にはリンク参照名またはURLが入る。

**期待されるアクション**：開発者は指摘されたリンク参照のスペルミスを修正する、存在するシンボルへのリンクに変更する、外部URLの有効性を確認する、またはリンク自体を削除する必要がある。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Warning） |
| リトライ | 無 |

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

コンパイラの設定に基づき、標準エラー出力へ警告メッセージを出力する。`--warning[BrokenLink]:off`オプションで抑止可能。

## 通知テンプレート

### コンパイラ警告メッセージの場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準エラー出力 |
| 重要度 | Warning |
| メッセージID | BrokenLink |
| 形式 | テキスト |

### メッセージテンプレート

```
{ファイルパス}({行},{列}) Warning: broken link '{リンク参照名}' [BrokenLink]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 壊れたリンク参照名またはURL | RSTパーサー（リンクノード） | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | リンク参照のターゲットが見つからない | RSTパス2のresolveLink関数で発生 |
| ドキュメント生成 | nim doc コマンド実行 | URLプロトコルが無効 | Markdownリンク解析時に発生 |
| ドキュメント生成 | nim doc コマンド実行 | 見出し参照のターゲットが見つからない | rnInternalRef解決時に発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning[BrokenLink]:off | コマンドラインオプションで警告を無効化 |
| {.warning[BrokenLink]:off.} | ソースコード内プラグマで警告を無効化 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー パス1]
    B --> C[RSTパーサー パス2 resolveSubs]
    C --> D{リンクノード種別}
    D -->|rnRstRef/rnPandocRef| E[resolveLink呼び出し]
    D -->|rnInternalRef| F[見出し参照解決]
    D -->|Markdownリンク| G[URLプロトコル検証]
    E --> H{ターゲット存在?}
    H -->|No| I[mwBrokenLink警告発行]
    H -->|Yes| J[リンク解決成功]
    F --> K{見出し存在?}
    K -->|No| I
    K -->|Yes| J
    G --> L{プロトコル有効?}
    L -->|No| I
    L -->|Yes| J
    I --> M[compilerMsgHandler呼び出し]
    M --> N[warnRstBrokenLinkに変換]
    N --> O[警告メッセージ出力]
    J --> P[次のノード処理]
    O --> P
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| AnchorSubstTable | アンカー・シンボル名の解決 | メモリ内データ構造 |
| PRstSharedState.anchors | 内部アンカー（見出し）の解決 | メモリ内データ構造 |
| idxImports | インポートされたドキュメントのインデックス | 外部.idxファイル由来 |

### テーブル別参照項目詳細

#### AnchorSubstTable

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| key（正規化されたシンボル名） | リンク参照の解決 | リンク参照ノード検出時 |
| value（AnchorSubstSeq） | ターゲットアンカー情報 | key存在時 |

### 更新テーブル一覧

なし（読み取り専用処理）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| リンク未解決 | ターゲットが見つからない | 警告出力、リンクテキストのみ出力して処理継続 |
| 無効プロトコル | URLプロトコルが許可されていない | 警告出力、リンクを無効化して処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- URLプロトコルの検証（safeProtocol関数）により、危険なプロトコル（javascript:など）を含むリンクは警告される
- 外部URLへのリンクはドキュメント生成時には検証されない（実行時のリンク切れは検出されない）

## 備考

- RST標準のリンク記法（`` `リンク名`_ ``）とMarkdown記法（`[テキスト](URL)`）の両方に対応
- importdocディレクティブで外部ドキュメントをインポートした場合、インポート先のシンボルも検索対象に含まれる
- 見出しへの内部リンク（`#見出し名`形式）も解決対象

---

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

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

### 推奨読解順序

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

まず、警告の種類定義とリンク解決に使用されるデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstBrokenLinkの定義（59行目）とメッセージ文字列（153行目）を確認 |
| 1-2 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型でmwBrokenLinkの定義（74行目）を確認 |

**読解のコツ**: BrokenLinkは複数の箇所から発行される可能性がある。resolveLink関数（パス2）とMarkdownリンク解析（パス1）の両方を確認する。

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

処理の起点となるドキュメント生成モジュールを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（242-277行目）でRSTメッセージをコンパイラ警告に変換 |

**主要処理フロー**:
1. **262行目**: `of mwBrokenLink: k = warnRstBrokenLink` - メッセージ種別のマッピング
2. **271-277行目**: `globalError`または`liMessage`で警告出力

#### Step 3: リンク解決処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rst.nim | `lib/packages/docutils/rst.nim` | resolveLink関数（3740行目以降）で、ターゲットが見つからない場合の処理（3763-3765行目）を確認 |
| 3-2 | rst.nim | `lib/packages/docutils/rst.nim` | Markdownリンク解析（1278-1282行目、1667-1671行目）でのmwBrokenLink発行を確認 |
| 3-3 | rst.nim | `lib/packages/docutils/rst.nim` | rnInternalRef解決（3834-3837行目）での見出し参照解決失敗処理を確認 |

**主要処理フロー**:
- **3763-3765行目**: リンクターゲットが見つからない場合のmwBrokenLink警告発行
- **1281行目**: Markdownリンクでプロトコルが無効な場合のmwBrokenLink警告発行
- **3837行目**: 内部参照のターゲットが見つからない場合のmwBrokenLink警告発行

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [262行目]
    │             │
    │             ├─ rstParsePass1 (Markdownリンク解析)
    │             │      └─ rstMessage [1281行目, 1670行目]
    │             │
    │             └─ rstParsePass2
    │                    └─ resolveSubs (rst.nim:3767)
    │                           ├─ resolveLink [3763-3765行目]
    │                           │      └─ rstMessage (mwBrokenLink)
    │                           │
    │                           └─ rnInternalRef解決 [3837行目]
    │                                  └─ rstMessage (mwBrokenLink)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

.nim/.rst/.md ───▶ RSTパーサー パス1 ───▶ PRstNode (AST)
     ファイル         │   (構文解析)
                      │
                      └─ Markdownリンク検出
                             │
                             └─ プロトコル検証
                                    │
                                    └─ 無効 ───▶ mwBrokenLink ───▶ 警告出力

PRstNode ───▶ resolveSubs (パス2) ───▶ リンク解決済みAST
                   │
                   ├─ rnRstRef/rnPandocRef検出
                   │      │
                   │      └─ resolveLink
                   │             │
                   │             └─ ターゲット未発見 ───▶ mwBrokenLink ───▶ 警告出力
                   │
                   └─ rnInternalRef検出
                          │
                          └─ 見出し未発見 ───▶ mwBrokenLink ───▶ 警告出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義（TMsgKind） |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成、メッセージハンドラ |
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RSTパーサー本体、resolveLink関数 |
| rstidx.nim | `lib/packages/docutils/rstidx.nim` | ソース | アンカーインデックス管理 |
| rstast.nim | `lib/packages/docutils/rstast.nim` | ソース | RST AST定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
