# 通知設計書 23-warnXIsNeverRead

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnXIsNeverRead」の設計仕様を定義する。この警告は、宣言された変数が一度も読み取られない（使用されない）場合に発生する可能性がある警告である。

### 本通知の処理概要

この通知は、変数が宣言されたにもかかわらず、その値が一度も読み取られない場合にユーザーに警告を発するために設計されている。これは未使用変数検出の一形態であり、コードの品質向上に寄与する。

**業務上の目的・背景**：ソフトウェア開発において、未使用の変数は潜在的なバグの兆候であったり、不要なコードの残骸であったりする。この警告により、開発者は意図しない未使用変数を早期に発見し、コードをクリーンに保つことができる。また、不要な変数を削除することでコードの可読性と保守性が向上する。

**通知の送信タイミング**：コンパイル時の意味解析フェーズで、変数のスコープ終了時に使用状況が評価され、一度も読み取られていない変数が検出された場合に送信される可能性がある。

**通知の受信者**：Nimソースコードをコンパイルしている開発者（標準エラー出力またはIDEツール経由）。

**通知内容の概要**：「'$1' is never read」というメッセージが出力され、$1には読み取られなかった変数名が代入される。

**期待されるアクション**：開発者は該当する変数の使用意図を確認し、不要な場合は変数宣言を削除するか、必要な場合は変数を適切に使用するようコードを修正する。意図的に使用しない場合は、ディスカードパターン（`discard`）や`{.used.}`プラグマの使用を検討する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

標準エラー出力（stderr）に出力される。IDEツール（nimsuggest等）使用時は、構造化されたエラーフック経由でIDEに通知される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: '{変数名}' is never read [XIsNeverRead]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 読み取られなかった変数の名前 | シンボルテーブル | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | 意味解析フェーズ | 変数が宣言後一度も読み取られない | 使用状況追跡で読み取りアクセスが検出されない場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:XIsNeverRead:off | この特定の警告が無効化されている場合 |
| --warnings:off | 全ての警告が無効化されている場合 |
| {.used.}プラグマ | 変数に{.used.}プラグマが付与されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[変数宣言検出] --> B[使用状況追跡開始]
    B --> C[スコープ内の使用をチェック]
    C --> D{読み取りアクセスあり?}
    D -->|Yes| E[正常終了]
    D -->|No| F{.used.プラグマあり?}
    F -->|Yes| E
    F -->|No| G[warnXIsNeverRead発行]
    G --> H[message呼び出し]
    H --> I[liMessage呼び出し]
    I --> J[styledMsgWriteln出力]
```

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

### 参照テーブル一覧

該当なし（メモリ上のシンボルテーブルを参照）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 変数名がメッセージに含まれるが、ローカル環境でのコンパイル時のみ出力されるため、セキュリティリスクは低い
- 機密情報を含む変数名を使用している場合は注意が必要

## 備考

- 現在のNimコンパイラでは、この警告は定義されているが積極的に使用されていない可能性がある
- 類似の警告として`hintXDeclaredButNotUsed`（宣言されたが使用されていない）が存在する
- 将来のコンパイラバージョンでデータフロー解析が強化されると、より活用される可能性がある

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: warnXIsNeverReadは「XIsNeverRead」という文字列キーを持ち、コマンドラインで`--warning:XIsNeverRead:off`のように指定できる。メッセージテンプレートには`$1`変数が含まれ、変数名が代入される。

#### Step 2: 関連する警告を理解する

類似の警告との違いを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintXDeclaredButNotUsed（105行目）との違いを確認。こちらは「宣言されたが使用されていない」というより一般的な警告 |

**読解のコツ**: warnXIsNeverReadは「読み取られない」に焦点を当て、hintXDeclaredButNotUsedは「使用されていない」に焦点を当てている。前者はデータフロー解析の結果、後者はより単純な使用有無のチェックに基づく。

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

```
[意味解析フェーズ]
    │
    ├─ 変数宣言処理
    │      └─ 使用状況フラグ初期化
    │
    ├─ スコープ解析
    │      └─ 読み取りアクセス検出
    │
    └─ スコープ終了時
           │
           └─ message (compiler/msgs.nim:641)
                  │
                  └─ liMessage (compiler/msgs.nim:536)
                         │
                         └─ styledMsgWriteln (compiler/msgs.nim:401)
```

### データフロー図

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

変数宣言 ───▶ 使用状況追跡 ───▶ スコープ終了時評価 ───▶ warnXIsNeverRead
    │              │                    │                    │
    └─ 変数名 ────┘                    │                    └─ stderr
                                        │
                 読み取りアクセスなし ──┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型とメッセージ文字列の定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| semstmts.nim | `compiler/semstmts.nim` | ソース | 文の意味解析（変数宣言処理を含む可能性） |
| semexprs.nim | `compiler/semexprs.nim` | ソース | 式の意味解析（変数使用の追跡を含む可能性） |
