# 通知設計書 36-warnRstUnusedImportdoc

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（nim doc）において、`importdoc`ディレクティブでインポートしたドキュメントが一度も参照されなかった場合に出力される警告「warnRstUnusedImportdoc」の設計仕様を記述する。

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメント内で`.. importdoc:: ファイル名`ディレクティブを使用して外部ドキュメントをインポートしたにもかかわらず、そのインポートされたドキュメント内のシンボルへのリンクが一度も使用されなかった場合に開発者へ通知するものである。

**業務上の目的・背景**：`importdoc`ディレクティブは、外部ドキュメント（.nimファイルから生成される.idxファイル）からシンボル情報をインポートし、現在のドキュメント内から参照できるようにする機能である。不要なインポートはドキュメント生成時間の増加や依存関係の複雑化を招く。この警告により、ドキュメント作成者は不要なインポートを削除し、ドキュメントの保守性を向上させることができる。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、RSTパーサーのパス2完了後（completePass2関数）において、インポートされたドキュメントの使用状況をチェックする際にトリガーされる。

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

**通知内容の概要**：「importdoc for '$1' is not used」形式で、使用されなかったインポートのファイル名が通知される。$1にはimportdocで指定されたファイル名が入る。

**期待されるアクション**：開発者は指摘されたimportdocディレクティブを削除するか、インポートしたドキュメント内のシンボルへの参照を追加する必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

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

```
{ファイルパス}({行},{列}) Warning: importdoc for '{インポート先ファイル名}' is not used [UnusedImportdoc]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 使用されなかったインポート先ファイル名 | PRstSharedState.idxImports | Yes |
| filename | ソースファイルパス（importdocの記述位置） | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | importdocが未使用 | completePass2関数で発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning[UnusedImportdoc]:off | コマンドラインオプションで警告を無効化 |
| {.warning[UnusedImportdoc]:off.} | ソースコード内プラグマで警告を無効化 |
| roSandboxDisabledなし | サンドボックスモードではimportdoc自体が無効 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー パス1]
    B --> C{importdocディレクティブ?}
    C -->|Yes| D[.idxファイル読み込み]
    D --> E[idxImportsに登録 used=false]
    C -->|No| F[通常パース処理]
    E --> F
    F --> G[RSTパーサー パス2]
    G --> H{リンク参照解決}
    H -->|インポート先シンボル使用| I[idxImports.used = true]
    H -->|その他| J[通常解決]
    I --> K[パス2完了]
    J --> K
    K --> L[completePass2呼び出し]
    L --> M[idxImports走査]
    M --> N{used == false?}
    N -->|Yes| O[mwUnusedImportdoc警告発行]
    N -->|No| P[次のエントリ]
    O --> Q[compilerMsgHandler呼び出し]
    Q --> R[warnRstUnusedImportdocに変換]
    R --> S[警告メッセージ出力]
    P --> T[ドキュメント生成継続]
    S --> T
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| PRstSharedState.idxImports | インポートされたドキュメントの管理 | Table[string, ImportdocInfo] |

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

#### PRstSharedState.idxImports

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| key（ファイル名） | インポート先の識別 | importdocディレクティブ処理時 |
| value.used | 使用状況フラグ | リンク解決時・警告チェック時 |
| value.fromInfo | importdoc記述位置 | 警告メッセージ出力時 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| PRstSharedState.idxImports | UPDATE | リンク解決時にusedフラグを更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| importdoc未使用 | インポート先シンボルへの参照なし | 警告出力、処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- importdocディレクティブはroSandboxDisabledオプションが有効な場合のみ使用可能
- サンドボックスモードでは外部ファイル読み込みが制限される

## 備考

- importdocは.idxファイル（ドキュメントインデックス）を読み込む
- .idxファイルはnim docコマンドで生成される
- 同一プロジェクト内の他モジュールへのドキュメントリンクに使用される
- rstWarnings集合に含まれる

---

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

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

### 推奨読解順序

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

まず、警告の種類定義とimportdoc管理のデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstUnusedImportdocの定義（62行目）とメッセージ文字列（156行目）を確認 |
| 1-2 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型でmwUnusedImportdocの定義（78行目）を確認 |
| 1-3 | rstidx.nim | `lib/packages/docutils/rstidx.nim` | ImportdocInfo型の定義を確認 |

**読解のコツ**: idxImportsはインポートされたドキュメントごとにエントリを持ち、usedフラグで参照状況を追跡する。

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

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

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

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

#### Step 3: importdoc処理と使用状況チェックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rst.nim | `lib/packages/docutils/rst.nim` | completePass2関数（3863-3866行目）でidxImportsの使用状況をチェックし、未使用の場合に警告発行 |

**主要処理フロー**:
- **3863-3866行目**: idxImportsを走査し、used==falseのエントリに対してmwUnusedImportdoc警告発行

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [265行目]
    │             │
    │             ├─ RSTパース パス1
    │             │      └─ importdocディレクティブ処理
    │             │             └─ idxImports登録 (used=false)
    │             │
    │             ├─ RSTパース パス2
    │             │      └─ resolveLink
    │             │             └─ インポート先シンボル参照時 idxImports.used=true
    │             │
    │             └─ completePass2 [3863行目]
    │                    └─ idxImports走査
    │                           └─ used==false時 rstMessage (mwUnusedImportdoc)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

.nim/.rst/.md ───▶ RSTパーサー パス1 ───▶ PRstNode (AST)
     ファイル         │
                      │
                      └─ importdocディレクティブ
                             │
                             └─ .idxファイル読み込み
                                    │
                                    └─ idxImports[filename] = {used: false, ...}

PRstNode ───▶ resolveSubs (パス2) ───▶ リンク解決
                   │
                   └─ インポート先シンボル参照
                          │
                          └─ idxImports[filename].used = true

パス2完了 ───▶ completePass2 ───▶ idxImports走査
                                      │
                                      └─ used==false ───▶ mwUnusedImportdoc ───▶ 警告出力
```

### 関連ファイル一覧

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