# 通知設計書 47-warnUnsafeDefault

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnUnsafeDefault`（安全でないデフォルト値警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimプログラムにおいて`default(T)`関数を使用した際、型`T`が有効なデフォルト値を持たない場合に発生する警告メッセージです。`requiresInit`プラグマを持つ型など、明示的な初期化が必要な型に対してデフォルト値を要求した場合に通知されます。

**業務上の目的・背景**：`default(T)`は型`T`のデフォルト値（ゼロ初期化された値）を返す組み込み関数です。しかし、一部の型は`requiresInit`プラグマによって明示的な初期化が必要と宣言されており、そのような型に対して`default`を使用することは、型の設計意図に反する可能性があります。この警告により、開発者はデフォルト値の安全性に注意を払い、適切な初期化方法を選択することができます。

**通知の送信タイミング**：コンパイル時のセマンティック解析フェーズ（semmagic.nim）において、`mDefault`または`mZeroDefault`マジック関数の呼び出しを解析する際に、対象の型が`requiresInit`を持つ場合に警告が発生します。

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

**通知内容の概要**：「The '型名' type doesn't have a valid default value」というメッセージが表示され、デフォルト値が安全でない可能性があることを通知します。

**期待されるアクション**：開発者は、該当する型に対して明示的な初期化を行うか、型の設計を見直してデフォルト値が安全に使用できるようにすることが期待されます。または、意図的に`default`を使用する場合は、その後すぐに適切な値で初期化することを検討すべきです。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: The '{型名}' type doesn't have a valid default value [UnsafeDefault]
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行（default呼び出しの行） | n.info.line | Yes |
| 列番号 | 警告発生列 | n.info.col | Yes |
| 型名 | デフォルト値を要求された型名 | typeToString(constructed) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | default(T)呼び出し解析 | 型がrequiresInit | semmagic.nim:583-588行目で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[UnsafeDefault]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[UnsafeDefault]:off.}` | プラグマで警告を無効化 |
| 型がrequiresInitでない場合 | デフォルト値が有効な場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[default/zeroDefault呼び出し解析] --> B[checkDefault関数呼び出し]
    B --> C[constructed型取得]
    C --> D{constructed.requiresInit?}
    D -->|No| E[通常処理]
    D -->|Yes| F[warnUnsafeDefault発行]
    F --> E
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 不適切なデフォルト値の使用は、予期しない動作やセキュリティ脆弱性につながる可能性がある
- 特に、`not nil`制約を持つ参照型のデフォルト値はnilとなり、NilAccessDefectを引き起こす可能性がある
- この警告に注意を払うことで、より安全なコードを書くことができる

## 備考

- `default(T)`は型`T`のゼロ初期化された値を返す
- `zeroDefault(T)`も同様に処理される
- `requiresInit`プラグマは、明示的な初期化が必要な型を定義するために使用される
- mDefaultとmZeroDefaultの両方で同じcheckDefault関数が使用される

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: メッセージテンプレートの`$1`は型名（typeToString(constructed)）で置換されます。

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

警告を発生させるcheckDefault関数のコードを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semmagic.nim | `compiler/semmagic.nim` | checkDefault関数（583-588行目）で警告発生条件を確認 |

**主要処理フロー**:
1. **583行目**: checkDefault関数の定義
2. **584行目**: `result = n`で結果を初期化
3. **585行目**: `result[1].typ.kind == tyTypeDesc`をアサート
4. **586行目**: `constructed = result[1].typ.base`で対象型を取得
5. **587行目**: `constructed.requiresInit`でチェック
6. **588行目**: 条件を満たす場合にwarnUnsafeDefault警告を発行

#### Step 3: magicsAfterOverloadResolutionでの呼び出しを理解する

checkDefaultがどこから呼ばれるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | semmagic.nim | `compiler/semmagic.nim` | 677-684行目でmDefault、mZeroDefaultの処理を確認 |

**主要処理フロー**:
- **677行目**: `of mDefault:`でmDefaultマジックの処理
- **678行目**: `result = checkDefault(c, n)`でcheckDefault関数を呼び出し
- **683行目**: `of mZeroDefault:`でmZeroDefaultマジックの処理
- **684行目**: `result = checkDefault(c, n)`でcheckDefault関数を呼び出し

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

```
semmagic.nim::magicsAfterOverloadResolution()
    │
    ├─ of mDefault:（677行目）
    │      │
    │      └─ checkDefault(c, n)（678行目）
    │             │
    │             ├─ constructed取得（586行目）
    │             │
    │             └─ requiresInit?（587行目）
    │                    │
    │                    └─ message(warnUnsafeDefault)（588行目）
    │
    └─ of mZeroDefault:（683行目）
           │
           └─ checkDefault(c, n)（684行目）
                  │
                  └─ （同上の処理）
```

### データフロー図

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

default(MyType)
        │
        ▼
n[1].typ ───▶ tyTypeDesc確認 ───▶ typ.base取得 ───▶ constructed
                                                        │
                                                        └─ requiresInit?
                                                               │
                                                               ▼
                                              typeToString(constructed) ───▶ 警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| semmagic.nim | `compiler/semmagic.nim` | ソース | checkDefault関数と警告発生ロジック |
| types.nim | `compiler/types.nim` | ソース | requiresInit判定ロジック |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
