# 通知設計書 52-warnUnreachableCode

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnUnreachableCode」（到達不能なコード）の設計仕様を記載する。この警告は、`return`文や`{.noReturn.}`プラグマが付与されたプロシージャの呼び出し後に、実行されることのないコードが存在する場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、開発者がデッドコード（到達不能コード）を検出することを目的としている。return文や例外を発生させて処理を終了するプロシージャの後に記述されたコードは実行されることがなく、メンテナンス性を低下させる原因となる。また、意図しないロジックエラーの発見にも貢献する。例えば、条件分岐内でreturnを記述した後に、誤って後続処理を追加してしまった場合などを検出できる。

**通知の送信タイミング**：コンパイル時の意味解析フェーズ（セマンティックアナリシス）において、文リスト（statement list）の解析時に発生する。具体的には、`semstmts.nim`の`semStmtList`プロシージャ内で、各文の解析後に後続文が到達不能かどうかをチェックする。

**通知の受信者**：この警告はコンパイルを実行した開発者に対して、標準エラー出力またはコンパイラが設定した出力先に通知される。IDEやエディタのビルド結果としても表示される。

**通知内容の概要**：警告メッセージ「unreachable code after 'return' statement or '{.noReturn.}' proc」（'return'文または'{.noReturn.}'プロシージャの後に到達不能なコード）が、到達不能なコードのソースコード位置と共に表示される。

**期待されるアクション**：開発者は到達不能なコードを削除するか、ロジックを見直して意図した処理フローに修正することが推奨される。デバッグ用のコードや将来の実装予定としてコードを残す場合は、コメントアウトするか`{.warning[UnreachableCode]:off.}`プラグマで警告を抑制する。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

標準エラー出力（stderr）に出力される。コンパイラの`--verbosity`オプションや`--warning[UnreachableCode]:off`オプションにより出力を制御可能。

## 通知テンプレート

### コンパイラ出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（nim c） |
| 重大度 | Warning |
| メッセージキー | UnreachableCode |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: unreachable code after 'return' statement or '{.noReturn.}' proc [UnreachableCode]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイルパス | ソースファイルの絶対または相対パス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告箇所の行番号 | TLineInfo.line | Yes |
| 列番号 | 警告箇所の列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 文リスト解析 | endsInNoReturn(m)がtrueかつ後続文が存在 | return文や{.noReturn.}proc後のコード |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[UnreachableCode]:off.}` | プラグマによる警告抑制 |
| `--warning:UnreachableCode:off` | コマンドラインオプションによる抑制 |
| 後続がnkPragma, nkCommentStmt, nkNilLit, nkEmpty, nkState | これらのノード種別は警告対象外 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[文リスト解析開始] --> B[各文を順次解析]
    B --> C{endsInNoReturn?}
    C -->|No| D[次の文へ]
    C -->|Yes| E{後続文が存在?}
    E -->|No| F[解析終了]
    E -->|Yes| G{後続がPragma/Comment等?}
    G -->|Yes| D
    G -->|No| H[warnUnreachableCode発行]
    H --> I[message関数呼び出し]
    I --> D
    D --> B
```

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

### 参照テーブル一覧

この警告はコンパイラ内部のデータ構造を参照するため、外部データベースは使用しない。

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PNode | AST（抽象構文木） | 文リストの解析に使用 |
| TNodeKind | ノード種別 | 後続文の種別判定に使用 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | この警告自体はエラーではない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（発生箇所ごとに1回出力） |

### 配信時間帯

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

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

- ソースコードのパスが出力に含まれるため、ビルドログを公開する際はパス情報に注意が必要
- 警告メッセージにはユーザーの機密情報は含まれない

## 備考

- この警告は`NotesVerbosity`の設定により、verbosityレベル1以上で有効
- `endsInNoReturn`関数は、文が`return`、`raise`、または`{.noReturn.}`プロシージャ呼び出しで終わるかを判定
- テンプレート展開やマクロ処理後のASTに対しても検査が行われる
- nkPragma, nkCommentStmt, nkNilLit, nkEmpty, nkStateは意図的に除外されている

---

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

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

### 推奨読解順序

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

警告メッセージの種類とメッセージテンプレートを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnUnreachableCodeの定義（71行目）とメッセージテンプレート（174行目）を確認 |

**読解のコツ**: メッセージテンプレート内の`'return'`と`'{.noReturn.}'`は、どのような状況で警告が発生するかを示している。

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

警告が発生する主要な場所を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semstmts.nim | `compiler/semstmts.nim` | semStmtList関数での文リスト解析処理 |

**主要処理フロー (semstmts.nim)**:
1. **2993-2996行目**: 文リストの各要素を順次処理し、ネストされた文リストを展開
2. **2996行目**: `endsInNoReturn(m)`で現在の文が終端処理かチェック
3. **2997-3000行目**: 後続文が存在する場合、種別をチェックして警告を発行
4. **2999行目**: nkPragma, nkCommentStmt等は警告対象外として除外
5. **3000行目**: それ以外の後続文に対して`message(c.config, n[j].info, warnUnreachableCode)`を呼び出し

#### Step 3: endsInNoReturn関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ast.nim | `compiler/ast.nim` | endsInNoReturn関数の実装を確認 |

**主要処理フロー**:
- 文が`nkReturnStmt`（return文）で終わるかチェック
- 呼び出し先が`{.noReturn.}`プラグマを持つかチェック
- `raise`文かどうかをチェック

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

```
semstmts.nim::semStmtList
    │
    ├─ 各文の解析
    │      └─ semExpr/semStmt
    │
    ├─ endsInNoReturn(m) チェック
    │      └─ ast.nim::endsInNoReturn
    │
    └─ 後続文の検査
           └─ message(c.config, n[j].info, warnUnreachableCode)
                  └─ msgs.nim::rawMessage
                         └─ 出力処理
```

### データフロー図

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

文リスト(nkStmtList) ───▶ semStmtList                ───▶ 警告メッセージ
                          │                              (stderr)
                          ├─ 各文の意味解析
                          ├─ endsInNoReturn判定
                          ├─ 後続文種別チェック
                          └─ message()呼び出し
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| semstmts.nim | `compiler/semstmts.nim` | ソース | 文リスト解析・警告発行 |
| ast.nim | `compiler/ast.nim` | ソース | endsInNoReturn関数定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | コンパイラオプション管理 |
