# 通知設計書 48-warnProveInit

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnProveInit`（初期化証明警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimコンパイラが変数の初期化を静的に証明できない場合に発生する警告メッセージです。未初期化の変数を使用すると、予期しない動作やランタイムエラーの原因となる可能性があることを開発者に通知します。

**業務上の目的・背景**：プログラムの安全性を確保するために、すべての変数は使用前に適切に初期化されている必要があります。Nimコンパイラは静的解析によって変数の初期化状態を追跡しますが、制御フローが複雑な場合やすべてのパスで初期化が保証されない場合、初期化を証明できないことがあります。この警告により、開発者は潜在的な未初期化変数の問題を早期に発見し、明示的な初期化を追加することができます。将来のNimバージョンでは、この警告がコンパイルエラーに昇格する可能性があることも通知されます。

**通知の送信タイミング**：コンパイル時のエフェクト解析フェーズ（sempass2.nim）において、以下の状況で警告が発生します：
- requiresInit型の変数が初期化されていない状態で使用された場合
- newSeqで確保されたシーケンスの要素が初期化を必要とする場合
- outパラメータが関数終了時に初期化されていない場合
- result変数が関数終了時に初期化されていない場合

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

**通知内容の概要**：「Cannot prove that '変数名' is initialized. This will become a compile time error in the future.」というメッセージが表示され、初期化を証明できない変数を特定します。

**期待されるアクション**：開発者は、該当する変数に明示的な初期化を追加するか、すべての制御パスで確実に初期化されるようにコードを修正することが期待されます。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時） |
| 優先度 | 高（将来エラーに昇格予定） |
| リトライ | なし |

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: Cannot prove that '{変数名}' is initialized. This will become a compile time error in the future. [ProveInit]
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行 | TLineInfo.line | Yes |
| 列番号 | 警告発生列 | TLineInfo.col | Yes |
| 変数名 | 初期化を証明できない変数名 | s.name.s または $arg | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | 変数使用解析 | requiresInit型で未初期化 | sempass2.nim:418行目 |
| コンパイル時 | newSeq呼び出し | 要素がrequiresInit | sempass2.nim:1136行目 |
| コンパイル時 | 関数終了解析 | outパラメータ未初期化 | sempass2.nim:1763行目 |
| コンパイル時 | 関数終了解析 | result未初期化 | sempass2.nim:1775行目 |
| コンパイル時 | グローバル変数解析 | requiresInit型で未初期化 | semstmts.nim:503,505行目 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[ProveInit]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[ProveInit]:off.}` | プラグマで警告を無効化 |
| sfNoInitフラグが設定されている場合 | `.noinit`プラグマで明示的に抑止 |
| 変数が初期化済み（init配列に含まれる）の場合 | 既に初期化が証明されている |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[変数使用検出] --> B{初期化済み?}
    B -->|Yes| C[通常処理]
    B -->|No| D{sfNoInit?}
    D -->|Yes| E[initに追加して継続]
    D -->|No| F{requiresInit型?}
    F -->|No| G{strictDefs?}
    F -->|Yes| H[warnProveInit発行]
    G -->|Yes| I[warnUninit発行]
    G -->|No| C
    H --> E
    I --> E
    E --> C
```

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

### 参照テーブル一覧

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

### 内部データ構造

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| a.init | 初期化済み変数IDのシーケンス | IntSetではなくseq[int] |

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし（警告のみ） | - | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 未初期化変数の使用は、メモリ安全性の問題やセキュリティ脆弱性につながる可能性がある
- 以前のメモリ内容が漏洩する情報漏洩のリスクがある
- この警告に注意を払うことで、より安全なコードを書くことができる
- 将来のバージョンではコンパイルエラーになるため、早期対応が推奨される

## 備考

- この警告は将来コンパイルエラーに昇格する予定
- `strictDefs`機能が有効な場合、より厳密な初期化チェックが行われる
- `.noinit`プラグマを使用すると、明示的に初期化チェックをスキップできる
- result変数の初期化チェックは、returnがないパスでも必要

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: メッセージには「This will become a compile time error in the future.」という将来の変更予告が含まれています。

#### Step 2: 変数使用時のチェックを理解する

useVar関数での初期化チェックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sempass2.nim | `compiler/sempass2.nim` | useVar関数（406-427行目）で初期化チェックを確認 |

**主要処理フロー**:
1. **406行目**: useVar関数の定義
2. **411-413行目**: sfNoInitフラグのチェック
3. **414行目**: `s.id notin a.init`で未初期化チェック
4. **417行目**: `s.typ.requiresInit`でrequiresInit型チェック
5. **418行目**: warnProveInit警告を発行

#### Step 3: newSeqでのチェックを理解する

newSeq呼び出し時の初期化チェックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sempass2.nim | `compiler/sempass2.nim` | 1126-1136行目でnewSeqの特別処理を確認 |

**主要処理フロー**:
- **1126行目**: mNew, mNewFinalize, mNewSeqマジックの処理
- **1130行目**: `tfRequiresInit`フラグのチェック
- **1131-1132行目**: newSeqでサイズ0の場合は例外
- **1136行目**: warnProveInit警告を発行

#### Step 4: 関数終了時のチェックを理解する

outパラメータとresultの初期化チェックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | sempass2.nim | `compiler/sempass2.nim` | 1762-1763行目でoutパラメータのチェック |
| 4-2 | sempass2.nim | `compiler/sempass2.nim` | 1770-1775行目でresultのチェック |

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

```
sempass2.nim::trackProc() / track()
    │
    ├─ useVar()（406行目）
    │      │
    │      └─ s.typ.requiresInit?（417行目）
    │             │
    │             └─ message(warnProveInit)（418行目）
    │
    ├─ trackCall()（newSeq処理）
    │      │
    │      └─ tfRequiresInit in arg.typ.elementType.flags?（1130行目）
    │             │
    │             └─ message(warnProveInit)（1136行目）
    │
    └─ trackProc終了処理
           │
           ├─ outパラメータチェック（1762-1763行目）
           │      │
           │      └─ message(warnProveInit)（1763行目）
           │
           └─ resultチェック（1770-1775行目）
                  │
                  └─ message(warnProveInit)（1775行目）
```

### データフロー図

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

変数定義 ───▶ sempass2::track()
                    │
                    ├─ init配列（初期化追跡）
                    │
                    └─ useVar()
                           │
                           ├─ s.id in init? ───▶ 初期化済み
                           │
                           └─ s.id notin init?
                                  │
                                  └─ requiresInit? ───▶ 警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| sempass2.nim | `compiler/sempass2.nim` | ソース | エフェクト解析と初期化追跡 |
| semstmts.nim | `compiler/semstmts.nim` | ソース | グローバル変数の初期化チェック |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
