# 通知設計書 32-warnRstAmbiguousLink

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（nim doc）において、RST/Markdownドキュメント内のドキュメントリンクが複数のターゲットに一致し曖昧である場合に出力される警告「warnRstAmbiguousLink」の設計仕様を記述する。

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメント内で使用されているリンク参照（`proc名`_や`` `シンボル名` ``など）が、複数の異なるターゲット（同名のプロシージャ、型、モジュールなど）に一致する場合に開発者へ通知するものである。

**業務上の目的・背景**：Nimのドキュメントシステムでは、バッククォートで囲んだシンボル名やRSTのハイパーリンク参照を使用してAPIドキュメント内の他のシンボルへリンクできる。オーバーロードされた関数や同名の異なるシンボルが存在する場合、リンク先が曖昧になる。この警告により、ドキュメント作成者は明確なリンクターゲットを指定し、読者が正しいドキュメントに到達できるようにする。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、RSTパーサーのパス2（resolveLink関数）において、リンク参照の解決を試みた際に複数の候補が見つかった場合にトリガーされる。

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

**通知内容の概要**：「ambiguous doc link $1」形式で、曖昧なリンク参照と候補となるターゲットの一覧が通知される。$1にはリンク参照名と衝突するターゲットの詳細情報が含まれる。

**期待されるアクション**：開発者は指摘されたリンク参照をより具体的な形式（例：`proc search(x: int)`のようにシグネチャを含める、モジュール名を明示するなど）に修正し、一意に解決できるようにする必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

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

```
{ファイルパス}({行},{列}) Warning: ambiguous doc link `{リンク参照名}`
  clash:
({行1}, {列1}): {ターゲット1のツールチップ}
({行2}, {列2}): {ターゲット2のツールチップ} [AmbiguousLink]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| aliasStr | 曖昧なリンク参照名 | RSTパーサー（rnRstRef/rnPandocRefノード） | Yes |
| targets | 衝突するターゲット一覧 | AnchorSubstTable検索結果 | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | リンク参照が複数ターゲットに一致 | RSTパス2のresolveLink関数で発生 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー パス1]
    B --> C[RSTパーサー パス2 resolveSubs]
    C --> D{rnRstRef/rnPandocRef?}
    D -->|Yes| E[resolveLink呼び出し]
    E --> F[AnchorSubstTableで検索]
    F --> G{検索結果数}
    G -->|>1| H[mwAmbiguousLink警告発行]
    G -->|=1| I[リンク解決成功]
    G -->|=0| J[mwBrokenLink警告]
    H --> K[ターゲット一覧を構築]
    K --> L[compilerMsgHandler呼び出し]
    L --> M[warnRstAmbiguousLinkに変換]
    M --> N[警告メッセージ出力]
    D -->|No| O[次のノード処理]
    I --> O
    J --> O
    N --> O
```

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

### 参照テーブル一覧

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

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

#### AnchorSubstTable

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| リンク曖昧 | 複数ターゲットに一致 | 警告出力、最初のターゲットを使用して処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 警告メッセージにシンボル名やファイルパスが含まれるが、開発環境での使用を想定しており問題なし
- 外部インポートされた.idxファイルの内容が警告に反映される可能性がある

## 備考

- Nim独自のドキュメントリンク機能（バッククォート記法）とRST標準のリンク記法の両方に対応
- オーバーロードされた関数へのリンクでは、シグネチャを含めることで一意に解決可能
- importdocディレクティブで外部ドキュメントをインポートした場合も検索対象に含まれる

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstAmbiguousLinkの定義（58行目）とメッセージ文字列（152行目）を確認 |
| 1-2 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型でmwAmbiguousLinkの定義（73行目）を確認 |
| 1-3 | rstidx.nim | `lib/packages/docutils/rstidx.nim` | AnchorSubst型、AnchorSubstTable型の定義を確認 |

**読解のコツ**: AnchorSubstTableは「正規化されたシンボル名」から「アンカー情報のシーケンス」へのマッピング。同じキーに複数のアンカーが登録されている場合が曖昧リンクの原因。

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

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

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

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rst.nim | `lib/packages/docutils/rst.nim` | resolveLink関数（3740行目以降）でリンク参照の解決処理を確認 |

**主要処理フロー**:
- **3756-3762行目**: 検索結果が複数ある場合のターゲット一覧構築と警告発行

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [261行目]
    │             │
    │             └─ rstParsePass2
    │                    └─ resolveSubs (rst.nim:3767)
    │                           └─ resolveLink [3740行目]
    │                                  │
    │                                  ├─ AnchorSubstTable検索
    │                                  │
    │                                  └─ rstMessage [3760行目]
    │                                         └─ msgHandler (= compilerMsgHandler)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

.nim/.rst/.md ───▶ RSTパーサー パス1 ───▶ PRstNode (AST)
     ファイル              (構文解析)

PRstNode ───▶ resolveSubs (パス2) ───▶ リンク解決済みAST
                   │
                   ├─ rnRstRef/rnPandocRef検出
                   │      │
                   │      └─ resolveLink
                   │             │
                   │             ├─ AnchorSubstTable検索
                   │             │      │
                   │             │      └─ 結果 > 1 ───▶ mwAmbiguousLink ───▶ 警告出力
                   │             │                                              (stderr)
                   │             └─ ターゲット一覧構築
                   │
                   └─ 処理継続（最初のターゲットを使用）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | メッセージ出力機能 |
