# 通知設計書 56-warnUninit

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnUninit」（明示的な初期化を使用すること）の設計仕様を記載する。この警告は、変数が明示的に初期化されずに使用される可能性がある場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、未初期化変数の使用によるバグを防ぐことを目的としている。Nimでは変数は自動的にゼロ初期化されるが、コードの意図を明確にするために明示的な初期化が推奨される。特に`strictDefs`機能（`{.experimental: "strictDefs".}`）が有効な場合、この警告はより積極的に発行され、変数の初期化忘れを検出する。

**通知の送信タイミング**：コンパイル時のエフェクト解析フェーズ（sempass2.nim）において、変数の使用時に初期化状態をチェックする際に発生する。具体的には、`useVar`関数内で変数が`init`セット（初期化済み変数の集合）に含まれていない場合にチェックが行われる。

**通知の受信者**：この警告はコンパイルを実行した開発者に対して、標準エラー出力またはコンパイラが設定した出力先に通知される。

**通知内容の概要**：警告メッセージ「use explicit initialization of '{変数名}' for clarity」（明確性のために'{変数名}'を明示的に初期化してください）が、変数使用箇所のソースコード位置と共に表示される。

**期待されるアクション**：開発者は変数宣言時に初期値を指定するか、使用前に明示的に値を代入することが推奨される。例えば、`var x: int`を`var x = 0`や`var x: int = 0`に変更する。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: use explicit initialization of '{変数名}' for clarity [Uninit]
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 変数使用時 | strictDefs有効かつs.id notin a.initかつleftPartOfAsgn <= 0 | strictDefs機能での未初期化変数使用 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[Uninit]:off.}` | プラグマによる警告抑制 |
| `--warning:Uninit:off` | コマンドラインオプションによる抑制 |
| sfNoInit in s.flags | `{.noinit.}`プラグマが付いた変数 |
| leftPartOfAsgn > 0 | 代入の左辺として使用されている場合 |
| s.kind == skLet | let変数の場合はerrLetNeedsInitエラー |
| strictDefs未有効 | 実験的機能が有効でない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[変数使用検出] --> B{ローカル変数?}
    B -->|No| C[チェックスキップ]
    B -->|Yes| D{sfNoInit?}
    D -->|Yes| E[initに追加して終了]
    D -->|No| F{init済み?}
    F -->|Yes| C
    F -->|No| G{型がrequiresInit?}
    G -->|Yes| H[warnProveInit発行]
    G -->|No| I{leftPartOfAsgn <= 0?}
    I -->|No| C
    I -->|Yes| J{strictDefs有効?}
    J -->|No| C
    J -->|Yes| K{skLet?}
    K -->|Yes| L[errLetNeedsInitエラー]
    K -->|No| M[warnUninit発行]
    M --> N[initに追加]
    E --> O[終了]
    H --> N
    L --> N
    N --> O
    C --> O
```

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

### 参照テーブル一覧

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

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PEffects.init | 初期化済み変数IDセット | IntSet型 |
| PSym | シンボル情報 | 変数の情報を保持 |
| PSym.flags | シンボルフラグ | sfNoInitをチェック |
| c.features | コンパイラ機能セット | strictDefsの有効性をチェック |

### 更新テーブル一覧

| データ構造 | 操作 | 概要 |
|-----------|------|------|
| PEffects.init | UPDATE | 警告後に変数IDを追加（重複警告防止） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| errLetNeedsInit | let変数が未初期化の場合 | 警告ではなくエラーとして処理 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | 同一変数につき1回のみ（initに追加後は警告しない） |

### 配信時間帯

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

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

- ソースコードのパスが出力に含まれるため、ビルドログを公開する際はパス情報に注意が必要
- 変数名が出力に含まれるが、通常は機密情報ではない

## 備考

- この警告はデフォルトでは控えめに動作し、`strictDefs`機能が有効な場合にのみ積極的に発行される
- `{.noinit.}`プラグマを使用することで、意図的に初期化をスキップできる
- let変数の場合は警告ではなくエラー（errLetNeedsInit）が発生する
- 警告発行後は同一変数への重複警告を防ぐためinitセットに追加される

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: メッセージテンプレート「use explicit initialization of '$1' for clarity」の$1には変数名が入る。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sempass2.nim | `compiler/sempass2.nim` | useVar関数 |

**主要処理フロー (sempass2.nim)**:
1. **406行目**: useVar関数の定義開始
2. **408行目**: isLocalSym(a, s)でローカル変数かチェック
3. **411-413行目**: sfNoInitの場合はinitに追加してスキップ
4. **414行目**: s.id notin a.initで初期化済みかチェック
5. **417-418行目**: requiresInitの場合はwarnProveInit
6. **419行目**: leftPartOfAsgn <= 0で代入の左辺でないことを確認
7. **420行目**: strictDefs in a.c.featuresで機能有効性を確認
8. **421-424行目**: skLetならエラー、そうでなければwarnUninit
9. **426行目**: initに追加して重複警告を防止

#### Step 3: strictDefs機能を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | options.nim | `compiler/options.nim` | strictDefs機能の定義 |

**主要処理フロー**:
- `{.experimental: "strictDefs".}`で有効化
- c.featuresセットにstrictDefsが含まれる

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

```
sempass2.nim::track (エフェクト追跡)
    │
    └─ nkSym処理
           │
           └─ useVar(a, n)
                  │
                  ├─ isLocalSym(a, s) チェック
                  │
                  ├─ sfNoInit チェック
                  │
                  ├─ s.id notin a.init チェック
                  │
                  ├─ requiresInit チェック
                  │      └─ warnProveInit (別の警告)
                  │
                  └─ strictDefs チェック
                         ├─ skLet: localError(errLetNeedsInit)
                         └─ その他: message(warnUninit)
```

### データフロー図

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

変数使用（nkSym）     ───▶ useVar                      ───▶ 警告メッセージ
                            │                              (stderr)
                            ├─ ローカル変数判定
                            ├─ sfNoInitチェック
                            ├─ init済みチェック
                            ├─ strictDefsチェック
                            └─ message()呼び出し

                    ───▶ PEffects.init更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | useVar関数実装 |
| options.nim | `compiler/options.nim` | ソース | strictDefs機能定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
