# 通知設計書 31-warnRstUnknownSubstitutionX

## 概要

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

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメントコメント処理時に、定義されていない置換参照（substitution reference）が検出された場合に開発者へ通知するものである。

**業務上の目的・背景**：RSTドキュメントでは`|置換名|`の形式で置換参照を使用し、`.. |置換名| replace:: 置換内容`で定義する。未定義の置換参照があると、生成されるドキュメントに不完全な内容が含まれる可能性がある。この警告により、ドキュメント作成者は置換定義の漏れを早期に発見し、品質の高いドキュメントを維持できる。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、RSTパーサーのパス2（resolveSubs関数）において、置換参照の解決を試みた際に該当する置換定義が見つからない場合にトリガーされる。

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

**通知内容の概要**：「unknown substitution '$1'」形式で、未知の置換参照名が通知される。$1には置換参照名（例：`|version|`の場合は`version`）が入る。

**期待されるアクション**：開発者は指摘された置換参照に対応する置換定義（`.. |置換名| replace:: 値`）をドキュメント内に追加するか、置換参照のスペルミスを修正する必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

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

```
{ファイルパス}({行},{列}) Warning: unknown substitution '{置換参照名}' [UnknownSubstitutionX]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 未知の置換参照名 | RSTパーサー（rnSubstitutionReferences.sons[0].text） | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | 置換参照が未定義 | RSTパス2のresolveSubs関数で発生 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー パス1]
    B --> C[RSTパーサー パス2 resolveSubs]
    C --> D{rnSubstitutionReferences?}
    D -->|Yes| E[置換名を取得]
    E --> F{置換定義が存在?}
    F -->|No| G[環境変数チェック]
    G --> H{環境変数存在?}
    H -->|No| I[mwUnknownSubstitution警告発行]
    H -->|Yes| J[環境変数値で置換]
    F -->|Yes| K[定義値で置換]
    I --> L[compilerMsgHandler呼び出し]
    L --> M[warnRstUnknownSubstitutionXに変換]
    M --> N[警告メッセージ出力]
    D -->|No| O[次のノード処理]
    J --> O
    K --> O
    N --> O
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| PRstSharedState.subs | 置換定義の格納 | メモリ内データ構造 |

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

#### PRstSharedState.subs

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| key（置換名） | 置換参照の解決 | 置換参照ノード検出時 |
| value（置換内容） | ドキュメント生成 | key存在時 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 置換未定義 | 置換参照に対応する定義なし | 警告出力、処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 環境変数からの置換値取得はサンドボックスモード（roSandboxDisabledなし）では無効化される
- ファイルパスの出力によりディレクトリ構造が露出する可能性があるが、開発時のみの使用を想定

## 備考

- RST仕様に準拠した置換機能の実装
- Markdown優先モード（roPreferMarkdown）でも同様に動作
- 環境変数による置換（`|$ENV_VAR|`形式）もサポート

---

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

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

### 推奨読解順序

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

まず、警告の種類定義と、RSTパーサーのメッセージ種別を理解することが重要。

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

**読解のコツ**: Nimの列挙型は文字列値を持てる。`warnRstUnknownSubstitutionX = "UnknownSubstitutionX"`のように定義され、コマンドラインオプションで参照される。

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

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

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

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

#### Step 3: RSTパーサーの置換解決処理を理解する

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

**主要処理フロー**:
- **3779-3784行目**: rnSubstitutionReferencesノードの処理、環境変数フォールバック、警告発行

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [260行目]
    │             │
    │             └─ rstParsePass2
    │                    └─ resolveSubs (rst.nim:3767)
    │                           └─ rstMessage [3784行目]
    │                                  └─ msgHandler (= compilerMsgHandler)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

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

PRstNode ───▶ resolveSubs (パス2) ───▶ 置換解決済みAST
                   │
                   ├─ 置換定義検索
                   │      │
                   │      └─ 未発見 ───▶ rstMessage ───▶ 警告出力
                   │                         │              (stderr)
                   └─ 環境変数検索           │
                          │                  │
                          └─ 未発見 ─────────┘
```

### 関連ファイル一覧

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