# 通知設計書 65-warnStrictNotNil

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnStrictNotNil` の設計仕様を定義する。この警告は、nilチェック機能が有効な場合に、nilまたはnilの可能性がある値をデリファレンス（参照解除）しようとした際に出力される。

### 本通知の処理概要

この警告は、コンパイラのnilチェック解析フェーズにおいて、参照型の値がnilであるか、nilである可能性がある場合にデリファレンスを検出し、開発者に通知する機能を提供する。

**業務上の目的・背景**：nilポインタへのアクセスは、実行時クラッシュやセグメンテーション違反の最も一般的な原因の一つである。Nimの`--experimental:strictNotNil`機能を使用することで、コンパイル時にnilデリファレンスの可能性を静的に検出し、実行時エラーを未然に防ぐことができる。この警告により、開発者はnilの可能性があるコードパスを認識し、適切なnilチェックを追加するか、型システムを活用して安全性を保証できる。

**通知の送信タイミング**：コンパイラのnilチェック解析フェーズ（`nilcheck.nim`）で、デリファレンス操作や戻り値の検査時に、nilabilityがNil、MaybeNil、またはUnreachableである場合に警告が発生する。

**通知の受信者**：Nimコンパイラを使用してソースコードをコンパイルしている開発者。`--experimental:strictNotNil`オプションを有効にした場合にコンパイル時の警告メッセージとして表示される。

**通知内容の概要**：メッセージは動的に生成され、状況に応じて以下のような内容が出力される：
- "can't deref {変数名}, it is nil"
- "can't deref {変数名}, it might be nil"
- "return value is nil"
- "return value might be nil"

**期待されるアクション**：開発者は該当箇所にnilチェックを追加するか、`not nil`型注釈を使用して型レベルでnil安全性を保証するか、コードロジックを見直してnilが発生しないことを保証する。

## 通知種別

コンパイラ警告メッセージ（stderr/ビルドログ出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に出力） |
| 優先度 | 中（Warning） |
| リトライ | 無（コンパイル時の一度きりの出力） |

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

警告は、`--experimental:strictNotNil`オプションが有効で、かつコンパイラオプションで `warnStrictNotNil`（短縮形: `StrictNotNil`）が有効になっている場合に出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| メッセージ種別 | Warning |
| 形式 | テキスト |

### 本文テンプレート

デリファレンス警告：
```
{ファイルパス}({行番号}, {カラム番号}) Warning: can't deref {変数名}, {理由} [StrictNotNil]
```

戻り値警告：
```
{ファイルパス}({行番号}, {カラム番号}) Warning: return value is nil [StrictNotNil]
{ファイルパス}({行番号}, {カラム番号}) Warning: return value might be nil [StrictNotNil]
{ファイルパス}({行番号}, {カラム番号}) Warning: return value is unreachable [StrictNotNil]
```

### 添付ファイル

なし（コンパイラ出力のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 動的に生成されるメッセージ | nilcheck.nim内で構築 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | デリファレンス操作 | nilability in {Nil, MaybeNil, Unreachable} | デリファレンス対象がnilまたはnilの可能性あり |
| コンパイル処理 | 関数戻り値 | resultNilability in {Nil, MaybeNil, Unreachable} | 戻り値がnilまたはnilの可能性あり |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:StrictNotNil:off | コマンドラインオプションで明示的に無効化 |
| {.warning[StrictNotNil]:off.} | プラグマで無効化 |
| strictNotNil未使用 | --experimental:strictNotNilが有効でない |
| 同一位置の重複警告 | ctx.warningLocations.incl(n.info)で抑止 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nilcheck解析開始] --> B[式の解析]
    B --> C{デリファレンス操作?}
    C -->|Yes| D[checkDeref呼び出し]
    C -->|No| E{戻り値?}
    D --> F[handleNilability呼び出し]
    F --> G{nilability種別?}
    G -->|Nil| H[derefWarning - it is nil]
    G -->|MaybeNil| I[derefWarning - it might be nil]
    G -->|Unreachable| J[derefWarning - it is unreachable]
    G -->|Safe| K[処理継続]
    E -->|Yes| L[checkResult呼び出し]
    L --> M{resultNilability種別?}
    M -->|Nil| N[message - return value is nil]
    M -->|MaybeNil| O[message - return value might be nil]
    M -->|Unreachable| P[message - return value is unreachable]
    M -->|Safe| K
    E -->|No| K
    H --> K
    I --> K
    J --> K
    N --> K
    O --> K
    P --> K
```

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

本警告はコンパイラ内部処理であり、データベースは使用しない。

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 警告メッセージのため、エラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

nilポインタのデリファレンスは、セキュリティ脆弱性の原因となる可能性がある。この警告を活用することで、潜在的なnullポインタ参照の脆弱性を事前に検出できる。

## 備考

- `--experimental:strictNotNil`オプションは実験的機能であり、将来変更される可能性がある
- Nilability解析は制御フロー解析に基づいており、すべてのケースを完全に検出できるわけではない
- `not nil`型注釈を活用することで、型レベルでnil安全性を保証できる
- 警告には変数の「履歴」（どこでnilになったか）も含まれることがある

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種別とNilability解析に関連するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnStrictNotNilの定義（78行目）とメッセージテンプレート（187行目）を確認 |
| 1-2 | nilcheck.nim | `compiler/nilcheck.nim` | Nilability列挙型（Nil, MaybeNil, Safe, Unreachable, Parent）の定義を確認 |

**読解のコツ**: Nilabilityは5つの状態を持つ。Nil（確実にnil）、MaybeNil（nilかもしれない）、Safe（確実にnilでない）、Unreachable（到達不能）、Parent（親スコープから継承）。

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

nilチェック解析の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | nilcheck.nim | `compiler/nilcheck.nim` | derefWarning関数（560-579行目）で警告出力処理を確認 |
| 2-2 | nilcheck.nim | `compiler/nilcheck.nim` | checkResult関数（1180-1190行目）で戻り値チェック処理を確認 |

**主要処理フロー**:
1. **560行目**: `proc derefWarning(...)` - デリファレンス警告関数
2. **569-573行目**: case文でNilability種別に応じたメッセージを構築
3. **579行目**: `message(ctx.config, n.info, warnStrictNotNil, res)` - 警告出力

#### Step 3: 戻り値チェック処理を理解する

関数の戻り値に対するnilチェック処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | nilcheck.nim | `compiler/nilcheck.nim` | checkResult関数（1180-1190行目）を確認 |

**主要処理フロー**:
- **1183-1184行目**: `of Nil: message(ctx.config, n.info, warnStrictNotNil, "return value is nil")`
- **1185-1186行目**: `of MaybeNil: message(ctx.config, n.info, warnStrictNotNil, "return value might be nil")`
- **1187-1188行目**: `of Unreachable: message(ctx.config, n.info, warnStrictNotNil, "return value is unreachable")`

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

```
nilcheck.nim::check（メイン解析関数）
    │
    ├─ nilcheck.nim::checkDeref（デリファレンスチェック）
    │      │
    │      └─ nilcheck.nim::handleNilability（Nilability処理）
    │              │
    │              └─ nilcheck.nim::derefWarning（警告出力）
    │                      │
    │                      └─ msgs.nim::message（warnStrictNotNil）
    │
    ├─ nilcheck.nim::checkResult（戻り値チェック）
    │      │
    │      └─ msgs.nim::message（warnStrictNotNil）
    │
    └─ 他のチェック処理
```

### データフロー図

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

AST式ノード ───▶ check
                    │
                    ▼
            ┌─────────────────┐
            │ Nilability解析   │
            │ (制御フロー分析) │
            └────────┬────────┘
                     │
                     ▼
            ┌─────────────────────┐
            │ Nilability種別判定   │
            │ Nil/MaybeNil/Safe   │
            └──────────┬──────────┘
                       │Nil/MaybeNil
                       ▼
                 derefWarning
                       │
                       ▼
                  message ───▶ stderr（警告出力）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義とメッセージテンプレート |
| nilcheck.nim | `compiler/nilcheck.nim` | ソース | nilチェック解析、derefWarning関数、checkResult関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | nilチェック解析の呼び出し元 |
