# 通知設計書 30-warnRstRedefinitionOfLabel

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnRstRedefinitionOfLabel」の設計仕様を定義する。この警告は、reStructuredText（RST）またはMarkdownドキュメント内でラベル（参照先）が重複定義された場合に発生する警告である。

### 本通知の処理概要

この通知は、Nimのドキュメント生成システム（nim doc）がRSTまたはMarkdown形式のドキュメントを処理中に、同じ名前のラベル（アンカー、リファレンス先）が複数回定義されたことを検出した場合に発生する。ドキュメント内のリンク解決に影響を与える可能性があるため、警告を発して開発者に通知する。

**業務上の目的・背景**：ドキュメント内のラベルは、文書内の特定の位置への参照（内部リンク）を可能にする重要な機能である。同じラベルが複数回定義されると、リンクの解決が曖昧になり、予期しない箇所への参照が発生する可能性がある。この警告により、ドキュメント作成者は重複を早期に発見し、明確な参照構造を維持できる。

**通知の送信タイミング**：`nim doc`コマンド実行時のドキュメント解析フェーズで、RST/Markdownパーサーが同一名のラベルを複数検出した場合に送信される。

**通知の受信者**：ドキュメントを生成している開発者（標準エラー出力またはIDEツール経由）。

**通知内容の概要**：「redefinition of label '$1'」というメッセージが出力され、$1には重複定義されたラベル名が代入される。

**期待されるアクション**：開発者はドキュメント内の重複ラベルを確認し、一意の名前に変更するか、不要な重複定義を削除する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

標準エラー出力（stderr）に出力される。`nim doc`コマンドでは、RST警告のデフォルト設定によって出力が制御される。特定のコマンド（例：`nim rst2html`）では、この警告がデフォルトで無効化される場合がある。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: redefinition of label '{ラベル名}' [RedefinitionOfLabel]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 重複定義されたラベル名 | RSTパーサーのラベル管理 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| nim doc | RST/Markdown解析 | 同一名のラベルが2回以上定義された | docgen.nim経由でRSTパーサーから通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:RedefinitionOfLabel:off | この特定の警告が無効化されている場合 |
| --warnings:off | 全ての警告が無効化されている場合 |
| 特定コマンドでのデフォルト無効化 | main.nim:334, 346行目での設定 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc実行] --> B[RSTパーサー起動]
    B --> C[ラベル定義検出]
    C --> D{ラベルテーブルに存在?}
    D -->|No| E[ラベルテーブルに登録]
    D -->|Yes| F[mwRedefinitionOfLabel送出]
    F --> G[docgen.nimでメッセージ変換]
    G --> H[warnRstRedefinitionOfLabel発行]
    H --> I[message呼び出し]
    I --> J[liMessage呼び出し]
    J --> K[styledMsgWriteln出力]
    E --> L[次のラベル処理]
    K --> L
```

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

### 参照テーブル一覧

該当なし（メモリ上のラベルテーブルを参照）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| - | この警告自体はエラーではない | 警告を出力し処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ラベル名がメッセージに含まれるが、ドキュメント内容の一部であり機密情報とは通常考えられない
- セキュリティリスクは低い

## 備考

- この警告は`rstWarnings`セット（lineinfos.nim:257）に含まれている
- `rstWarnings`は`warnRstRedefinitionOfLabel`から`warnRstStyle`までの範囲
- 特定のドキュメント生成コマンドではデフォルトで無効化される（main.nim参照）
- RSTパーサーの内部メッセージ種別（mwRedefinitionOfLabel）がdocgen.nimで変換される

---

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

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

### 推奨読解順序

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

まず、メッセージ種別の定義と警告メッセージの文字列を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstRedefinitionOfLabelの定義（56行目）、MsgKindToStr配列でメッセージ文字列の定義（150行目）、rstWarningsセットの定義（257行目） |

**読解のコツ**: warnRstRedefinitionOfLabelは「RedefinitionOfLabel」という文字列キーを持つ。rstWarningsセットの開始点であり、RST関連の警告群の最初に位置する。

#### Step 2: メッセージ変換を理解する

RSTパーサーの内部メッセージからコンパイラ警告への変換処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | docgen.nim | `compiler/docgen.nim` | docgenMsgHandler関数内（259行目）でmwRedefinitionOfLabelからwarnRstRedefinitionOfLabelへの変換 |

**主要処理フロー**:
- **259行目**: `of mwRedefinitionOfLabel: k = warnRstRedefinitionOfLabel` でメッセージ種別を変換

#### Step 3: デフォルト設定を理解する

特定コマンドでの警告無効化設定を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | main.nim | `compiler/main.nim` | setNoteDefaults呼び出し（334行目、346行目）で特定コマンド時に警告を無効化 |

**主要処理フロー**:
- **334行目**: `conf.setNoteDefaults(warnRstRedefinitionOfLabel, false)` でrst2htmlコマンド等での無効化
- **346行目**: 同様の設定（issue #13218対応）

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

```
nim doc実行
    │
    ├─ RSTパーサー
    │      └─ ラベル管理
    │             └─ 重複検出 → mwRedefinitionOfLabel
    │
    └─ docgen.docgenMsgHandler (compiler/docgen.nim:259)
           │
           └─ メッセージ種別変換
                  │
                  └─ globalError/liMessage (compiler/msgs.nim)
                         │
                         └─ styledMsgWriteln (compiler/msgs.nim:401)
```

### データフロー図

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

RST/Markdown ───▶ RSTパーサー ───▶ docgenMsgHandler ───▶ warnRstRedefinitionOfLabel
    │                   │                │                        │
    └─ ラベル定義 ──────┘                │                        └─ stderr
                                          │
              mwRedefinitionOfLabel ──────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型、メッセージ文字列、rstWarningsセット定義 |
| docgen.nim | `compiler/docgen.nim` | ソース | docgenMsgHandler関数（RSTメッセージ変換） |
| main.nim | `compiler/main.nim` | ソース | 特定コマンドでの警告無効化設定 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RSTパーサー本体（外部パッケージ） |
