# 通知設計書 51-warnUnreachableElse

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnUnreachableElse」（到達不能なelse節）の設計仕様を記載する。この警告は、case文やオブジェクトバリアント（判別共用体）において、else節が存在するが全ての分岐が既にカバーされており、そのelse節に到達することが不可能な場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、開発者がcase文やオブジェクトバリアントの分岐条件を記述する際に、冗長なelse節を検出することを目的としている。すべてのケースが網羅されている状態でelse節を記述することは、デッドコードを生成するだけでなく、後のメンテナンス時に混乱を招く可能性がある。また、列挙型の値が追加された場合にコンパイラが警告を出さなくなるため、潜在的なバグの原因となりうる。

**通知の送信タイミング**：コンパイル時の意味解析フェーズ（セマンティックアナリシス）において、case文またはオブジェクトバリアントの分岐解析時に発生する。具体的には、`semtypes.nim`でのレコード型（オブジェクトバリアント）解析時、および`semstmts.nim`でのcase式解析時にチェックが行われる。

**通知の受信者**：この警告はコンパイルを実行した開発者に対して、標準エラー出力またはコンパイラが設定した出力先に通知される。IDEやエディタの言語サーバープロトコル（LSP）を通じてインライン警告として表示されることもある。

**通知内容の概要**：警告メッセージ「unreachable else, all cases are already covered」（到達不能なelse、全てのケースは既にカバーされています）が、問題のあるelse節のソースコード位置と共に表示される。

**期待されるアクション**：開発者は不要なelse節を削除するか、意図的に残す場合はその理由をコメントで明記することが推奨される。また、将来の拡張を見据えてelse節を残す場合は、`{.warning[UnreachableElse]:off.}`プラグマを使用して警告を抑制することも可能である。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: unreachable else, all cases are already covered [UnreachableElse]
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | case文のelse節解析 | covered == toCover(c, n[0].typ) かつ else節が存在 | case式で全ケースがカバー済みでelse節がある |
| コンパイル処理 | オブジェクトバリアント解析 | covered == toCover(c, a[0].typ) かつ else節が存在 | レコード型の判別式で全ケースがカバー済み |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[UnreachableElse]:off.}` | プラグマによる警告抑制 |
| `--warning:UnreachableElse:off` | コマンドラインオプションによる抑制 |
| `--warnings:off` | 全警告の抑制 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[case文/オブジェクトバリアント解析開始] --> B[分岐条件の収集]
    B --> C[カバレッジ計算]
    C --> D{else節が存在?}
    D -->|No| E[解析終了]
    D -->|Yes| F{全ケースカバー済み?}
    F -->|No| E
    F -->|Yes| G[warnUnreachableElse発行]
    G --> H[message関数呼び出し]
    H --> I[ログ出力]
    I --> E
```

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

### 参照テーブル一覧

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

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PType | 型情報（判別式の型） | covered計算に使用 |
| PNode | AST（抽象構文木） | 分岐条件の解析に使用 |
| BiggestInt (covered) | カバレッジカウンタ | 処理済み分岐数 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- この警告は`NotesVerbosity`の設定により、verbosityレベル1以上で有効
- 列挙型を完全にカバーするcase文では、else節を省略することが推奨される
- 将来の列挙値追加に備える場合は、else節ではなく明示的なケースを追加することが推奨される

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: `TMsgKind`は全ての警告・エラー・ヒントを定義する列挙型。`MsgKindToStr`配列でメッセージテンプレートとの対応を確認できる。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semtypes.nim | `compiler/semtypes.nim` | オブジェクトバリアント（レコード型のcase）解析処理 |
| 2-2 | semstmts.nim | `compiler/semstmts.nim` | case式の意味解析処理 |

**主要処理フロー (semtypes.nim)**:
1. **839-844行目**: nkElse分岐の処理で、`covered == toCover(c, a[0].typ)`の条件をチェック
2. **842行目**: 条件が真の場合、`message(c.config, b.info, warnUnreachableElse)`を呼び出し

**主要処理フロー (semstmts.nim)**:
1. **1377-1386行目**: case式のelse分岐処理
2. **1383-1384行目**: `(chckCovered and covered == toCover(c, n[0].typ)) or hasElse`の条件で警告発行

#### Step 3: メッセージ出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | `message`プロシージャの実装を確認 |

**主要処理フロー**:
- `message`プロシージャが`TMsgKind`と位置情報を受け取り、フォーマットして出力

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

```
semtypes.nim::semRecordNodeAux (オブジェクトバリアント)
    │
    └─ message(c.config, b.info, warnUnreachableElse)
           └─ msgs.nim::rawMessage
                  └─ 出力処理

semstmts.nim::semCase (case式)
    │
    └─ message(c.config, x.info, warnUnreachableElse)
           └─ msgs.nim::rawMessage
                  └─ 出力処理
```

### データフロー図

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

case文/オブジェクト    ───▶ semCase/semRecordNodeAux   ───▶ 警告メッセージ
バリアントのAST              │                              (stderr)
                            ├─ カバレッジ計算
                            ├─ else節検出
                            └─ message()呼び出し
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| semtypes.nim | `compiler/semtypes.nim` | ソース | 型解析（オブジェクトバリアント） |
| semstmts.nim | `compiler/semstmts.nim` | ソース | 文解析（case式） |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | コンパイラオプション管理 |
