# 通知設計書 62-warnCaseTransition

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnCaseTransition` の設計仕様を定義する。この警告は、オブジェクトバリアント型のcase分岐（判別フィールド）への代入により、オブジェクトの状態遷移が発生する可能性がある場合に出力される。

### 本通知の処理概要

この警告は、Cコード生成フェーズにおいて、オブジェクトバリアント型の判別フィールドへの代入を検出し、潜在的なオブジェクト状態遷移のリスクを開発者に通知する機能を提供する。

**業務上の目的・背景**：Nimのオブジェクトバリアント型は、case文によって異なるフィールドセットを持つことができる。判別フィールド（discriminator）の値を変更すると、アクティブなフィールドセットが切り替わり、以前のフィールドに格納されていたデータが無効になる可能性がある。これはメモリ安全性に関わる問題であり、予期しないデータ破損やクラッシュを引き起こす可能性がある。この警告により、開発者はこのような危険な操作を認識し、代わりに新しいオブジェクトインスタンスを作成することが推奨される。

**通知の送信タイミング**：コンパイラのCコード生成フェーズで、判別フィールドへの代入が検出された時点で警告が発生する。具体的には、`asgnFieldDiscriminant`関数内で`genDiscriminantCheck`の後に出力される。

**通知の受信者**：Nimコンパイラを使用してソースコードをコンパイルしている開発者。コンパイル時の警告メッセージとして標準エラー出力またはビルドログに表示される。

**通知内容の概要**：「Potential object case transition, instantiate new object instead」（オブジェクトのcase遷移の可能性があります。代わりに新しいオブジェクトをインスタンス化してください）というメッセージが出力される。

**期待されるアクション**：開発者は、既存のオブジェクトの判別フィールドを直接変更する代わりに、新しいオブジェクトインスタンスを作成して適切な判別フィールド値で初期化することを検討する。または、`{.uncheckedAssign.}`プラグマを使用してこのチェックを意図的に無効化する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

警告は、コンパイラオプションで `warnCaseTransition`（短縮形: `CaseTransition`）が有効で、かつ`optFieldCheck`が有効になっている場合に出力される。また、`{.uncheckedAssign.}`ブロック内では出力されない（`p.inUncheckedAssignSection == 0`の条件）。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {カラム番号}) Warning: Potential object case transition, instantiate new object instead [CaseTransition]
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイルパス | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行 | TLineInfo.line | Yes |
| カラム番号 | 警告発生カラム | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 判別フィールドへの代入 | optFieldCheck有効かつinUncheckedAssignSection==0 | オブジェクトバリアントの判別フィールドへの代入を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:CaseTransition:off | コマンドラインオプションで明示的に無効化 |
| {.warning[CaseTransition]:off.} | プラグマで無効化 |
| {.uncheckedAssign.} | uncheckedAssignブロック内での代入 |
| optFieldCheck無効 | フィールドチェックオプションが無効 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[genAsgn関数呼び出し] --> B{optFieldCheck有効?}
    B -->|No| C[通常の代入処理]
    B -->|Yes| D{isDiscriminantField?}
    D -->|No| C
    D -->|Yes| E[asgnFieldDiscriminant呼び出し]
    E --> F{inUncheckedAssignSection == 0?}
    F -->|No| G[代入処理のみ]
    F -->|Yes| H[genDiscriminantCheck呼び出し]
    H --> I[message - warnCaseTransition]
    I --> J[genAssignment呼び出し]
    G --> J
    J --> K[終了]
    C --> K
```

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

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

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

この警告は、メモリ安全性に関わる潜在的な問題を開発者に通知するもの。判別フィールドの不適切な変更は、未初期化メモリへのアクセスや型の不整合を引き起こす可能性があるため、警告を無視せず適切に対処することが重要。

## 備考

- オブジェクトバリアント型はNimの強力な機能だが、判別フィールドの変更には注意が必要
- `{.uncheckedAssign.}`プラグマを使用することで、このチェックを意図的に無効化できるが、メモリ安全性を理解した上で使用すること
- 新しいオブジェクトインスタンスの作成を推奨する理由は、適切に初期化されたフィールドを保証するため

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種別とオブジェクトバリアント型の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnCaseTransitionの定義（76行目）とメッセージテンプレート（184行目）を確認 |
| 1-2 | ast.nim | `compiler/ast.nim` | オブジェクトバリアント型のAST表現を確認 |

**読解のコツ**: オブジェクトバリアント型は、`nkRecCase`ノードでAST上に表現される。判別フィールドは最初の子ノードに格納される。

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

Cコード生成における代入処理の起点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ccgstmts.nim | `compiler/ccgstmts.nim` | genAsgn関数（1936-1956行目）で代入処理を確認 |
| 2-2 | ccgstmts.nim | `compiler/ccgstmts.nim` | asgnFieldDiscriminant関数（1924-1934行目）で判別フィールド代入処理を確認 |

**主要処理フロー**:
1. **1936行目**: `proc genAsgn(p: BProc, e: PNode, fastAsgn: bool)` - 代入生成関数
2. **1940行目**: `elif optFieldCheck in p.options and isDiscriminantField(e[0]):` - 判別フィールドかどうかの判定
3. **1942行目**: `asgnFieldDiscriminant(p, e)` - 判別フィールド代入処理の呼び出し

#### Step 3: 警告出力処理を理解する

警告メッセージがどのように出力されるかを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ccgstmts.nim | `compiler/ccgstmts.nim` | asgnFieldDiscriminant内の警告出力（1933行目）を確認 |

**主要処理フロー**:
- **1930行目**: `if p.inUncheckedAssignSection == 0:` - uncheckedAssignブロック外かどうかの判定
- **1932行目**: `genDiscriminantCheck(p, a, tmp, dotExpr[0].typ, field)` - 判別チェック生成
- **1933行目**: `message(p.config, e.info, warnCaseTransition)` - 警告出力

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

```
ccgstmts.nim::genStmts（文のCコード生成）
    │
    ├─ ccgstmts.nim::genAsgn（代入生成）
    │      │
    │      └─ ccgstmts.nim::asgnFieldDiscriminant（判別フィールド代入）
    │              │
    │              ├─ ccgstmts.nim::genDiscriminantCheck（判別チェック生成）
    │              │
    │              ├─ msgs.nim::message（警告出力 - warnCaseTransition）
    │              │
    │              └─ cgen.nim::genAssignment（代入コード生成）
    │
    └─ 他の文の処理
```

### データフロー図

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

AST代入ノード ───▶ genAsgn
                          │
                          ▼
                 ┌─────────────────────┐
                 │ isDiscriminantField? │
                 └──────────┬──────────┘
                            │Yes
                            ▼
                 asgnFieldDiscriminant
                 ┌──────────────────────┐
                 │ inUncheckedAssign==0?│
                 └──────────┬───────────┘
                            │Yes
                            ▼
                    message ───▶ stderr（警告出力）
                            │
                            ▼
                    genAssignment ───▶ Cコード生成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義とメッセージテンプレート |
| ccgstmts.nim | `compiler/ccgstmts.nim` | ソース | 文のCコード生成、genAsgn関数、asgnFieldDiscriminant関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数 |
| cgen.nim | `compiler/cgen.nim` | ソース | Cコード生成メイン処理 |
| ast.nim | `compiler/ast.nim` | ソース | AST定義、オブジェクトバリアント関連 |
