# 通知設計書 43-warnUnusedImportX

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnUnusedImportX`（未使用インポート警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimプログラムにおいてインポートされたモジュールが実際には使用されていない場合に発生する警告メッセージです。コードの品質向上と不要な依存関係の削減を支援します。

**業務上の目的・背景**：プログラムの保守性と可読性を向上させるため、使用されていないインポート文を検出することは重要です。未使用のインポートは、コードベースの肥大化、コンパイル時間の増加、不必要な依存関係の維持につながります。この警告により、開発者は不要なインポートを早期に発見し、クリーンなコードベースを維持できます。

**通知の送信タイミング**：コンパイル終了時（closePContext関数内のreportUnusedModules関数）において、各インポートされたモジュールのシンボルに`sfUsed`フラグが設定されているかをチェックし、設定されていない場合に警告が発生します。

**通知の受信者**：Nimプログラムをコンパイルする開発者がこの警告を受け取ります。コンパイラの標準出力または標準エラー出力に警告メッセージが表示されます。

**通知内容の概要**：「imported and not used: 'モジュール名'」というメッセージが表示され、どのモジュールが未使用かを具体的に示します。

**期待されるアクション**：開発者は該当するimport文を削除するか、本当に必要な場合はモジュール内の機能を使用するようコードを修正することが期待されます。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時） |
| 優先度 | 中（警告レベル） |
| リトライ | なし |

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

コンパイラを実行している開発者のコンソールに直接出力されます。警告の有効/無効は `--warning[UnusedImport]:on/off` オプションで制御可能です。

## 通知テンプレート

### コンパイラ警告の場合

| 項目 | 内容 |
|-----|------|
| メッセージID | UnusedImport |
| 警告レベル | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: imported and not used: '{モジュール名}' [UnusedImport]
```

### 添付ファイル

該当なし（コンパイラ警告のため添付ファイルは存在しない）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo（unusedImportsから取得） | Yes |
| 行番号 | import文の行 | TLineInfo.line | Yes |
| 列番号 | import文の列 | TLineInfo.col | Yes |
| モジュール名 | インポートされたモジュール名 | s.name.s（シンボルの名前） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル終了時 | モジュールスコープ終了 | sfUsedフラグなし | sem.nim:893-897行目で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[UnusedImport]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[UnusedImport]:off.}` | プラグマで警告を無効化 |
| `cmdM`コマンドの場合 | マルチプロジェクトモードでは警告を出さない |
| モジュールが使用された場合 | sfUsedフラグが設定されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル開始] --> B[importモジュール追跡開始]
    B --> C[インポート時にunusedImportsに追加]
    C --> D[モジュール内シンボル使用時にsfUsed設定]
    D --> E[コンパイル終了]
    E --> F[reportUnusedModules呼び出し]
    F --> G{cmdM?}
    G -->|Yes| H[警告スキップ]
    G -->|No| I[unusedImportsをループ]
    I --> J{sfUsed設定?}
    J -->|Yes| K[次のモジュール]
    J -->|No| L[warnUnusedImportX発行]
    L --> K
    K --> M{全モジュール処理完了?}
    M -->|No| I
    M -->|Yes| N[終了]
    H --> N
```

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

### 参照テーブル一覧

該当なし（コンパイラ内部処理のため外部データベース参照なし）

### 内部データ構造

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| c.unusedImports | インポートされたモジュールの追跡 | (PSym, TLineInfo)のシーケンス |

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

コンパイル実行時に即座に出力される（時間帯制限なし）

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

- 警告メッセージにはソースコードのファイルパスとモジュール名が含まれる
- 本警告自体はセキュリティに直接影響しないが、不要な依存関係を減らすことでアタックサーフェスを削減する効果がある

## 備考

- インポートの追跡は`trackUnusedImport`フラグで制御される（importer.nim:291行目）
- `sfUsed`フラグは、モジュールのシンボル（関数、変数、型など）が使用された際に設定される
- マルチプロジェクトモード（cmdM）では、クロスモジュール依存関係の解析が複雑なため警告が無効化される

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種類を定義するデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnUnusedImportXの定義を確認（67行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列で警告メッセージテンプレートを確認（163行目） |

**読解のコツ**: メッセージテンプレートの`$1`はモジュール名（s.name.s）で置換されます。

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

警告を発生させるreportUnusedModules関数を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sem.nim | `compiler/sem.nim` | reportUnusedModules関数（893-897行目）で警告発生ロジックを確認 |

**主要処理フロー**:
1. **893行目**: reportUnusedModules関数の定義
2. **894行目**: cmdMコマンドの場合は早期リターン
3. **895行目**: unusedImportsをループ処理
4. **896行目**: sfUsedフラグがないかチェック
5. **897行目**: 条件を満たす場合にwarnUnusedImportX警告を発行

#### Step 3: インポート追跡の仕組みを理解する

インポート時にどのようにモジュールが追跡されるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | importer.nim | `compiler/importer.nim` | 291行目でtrackUnusedImportフラグの設定を確認 |

**主要処理フロー**:
- **291行目**: warnUnusedImportXがnotesに含まれる場合にtrackUnusedImportをtrueに設定

#### Step 4: 呼び出し元を理解する

reportUnusedModulesがどこから呼ばれるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | sem.nim | `compiler/sem.nim` | closePContext関数（899行目以降）でreportUnusedModulesが呼ばれる |

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

```
sem.nim::closePContext()（899行目）
    │
    └─ reportUnusedModules(c)（904行目で呼び出し）
           │
           ├─ cmdM チェック（894行目）
           │
           └─ for (s, info) in c.unusedImports:（895行目）
                  │
                  └─ sfUsed notin s.flags?（896行目）
                         │
                         └─ message(warnUnusedImportX)（897行目）
                                │
                                └─ コンソール出力
```

### データフロー図

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

import文 ───▶ importer.nim::myImportModule()
                    │
                    └─ trackUnusedImport設定
                           │
                           └─ unusedImportsに(s, info)追加
                                  │
                                  ▼
モジュール使用 ───▶ sfUsedフラグ設定
                                  │
                                  ▼
コンパイル終了 ───▶ reportUnusedModules()
                           │
                           └─ sfUsedなし? ───▶ 警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| sem.nim | `compiler/sem.nim` | ソース | reportUnusedModules関数の実装 |
| importer.nim | `compiler/importer.nim` | ソース | インポート追跡のフラグ設定 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
