# 通知設計書 82-warnIgnoredSymbolInjection

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnIgnoredSymbolInjection」（無視されたシンボル注入警告）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、テンプレートやマクロ展開時に注入されたシンボルが、現在のスコープで既に定義されているシンボルと衝突し、注入されたシンボルが無視される場合に開発者に警告するものである。

**業務上の目的・背景**：Nimのテンプレート展開において、展開元で定義されたシンボルがテンプレート呼び出し元のスコープに「注入」される。しかし、呼び出し元に同名のシンボルが既に存在する場合、どちらを使用すべきか曖昧になる。この警告は、シンボル解決の曖昧さを開発者に通知し、明示的なバインディングを促すことで、意図しない動作を防止する。

**通知の送信タイミング**：セマンティック解析フェーズにおいて、オープンシンボル（nkOpenSymChoice）を解決する際（semexprs.nim内）に、注入されたシンボルと既存シンボルの衝突を検出した時点で発行される。

**通知の受信者**：コンパイルを実行している開発者。ターミナルまたはIDEの出力ウィンドウに表示される。

**通知内容の概要**：「captured symbol '{シンボル名}' is injected from template/macro '{展開元}'; {既存シンボルの説明}; either enable --experimental:openSym to use the injected symbol, or `bind` this symbol explicitly」という形式で、衝突の詳細と解決策を示す。

**期待されるアクション**：開発者は警告を確認し、以下のいずれかの対応を行うことが期待される：(1) `--experimental:openSym`オプションを有効にして注入されたシンボルを使用する、(2) `bind`キーワードを使用してシンボルを明示的にバインドする、(3) シンボル名を変更して衝突を回避する。

## 通知種別

コンパイラ警告（Warning） - ターミナル/IDE出力

## 送信仕様

### 基本情報

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

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

コンパイラの標準エラー出力（stderr）または設定されたwritelnHookに出力される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: {詳細メッセージ} [IgnoredSymbolInjection]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 警告メッセージ本文 | semexprs.nim内で動的生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | オープンシンボル解決 | 注入シンボルと既存シンボルが衝突 | semexprs.nim内でのシンボル解決時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:IgnoredSymbolInjection:off | コマンドラインオプションで抑制可能 |
| {.warning[IgnoredSymbolInjection]:off.} | プラグマで抑制可能 |
| --experimental:openSym | このオプション有効時は別の解決方法が使用される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[オープンシンボル解決開始] --> B{nfDisabledOpenSymフラグあり?}
    B -->|No| C[通常処理]
    B -->|Yes| D{外側スコープに同名シンボル存在?}
    D -->|No| C
    D -->|Yes| E[警告メッセージ生成]
    E --> F[message関数呼び出し]
    F --> G[styledMsgWriteln出力]
    G --> H[処理継続]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

### 更新テーブル一覧

本通知はデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | この警告自体はエラーではない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

なし。コンパイラ警告メッセージであり、機密情報を含まない。

## 備考

- テンプレート/マクロのシンボル解決に関連
- --experimental:openSymオプションと関連
- 警告IDは "IgnoredSymbolInjection"

---

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

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

### 推奨読解順序

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

警告メッセージの種類と定義を理解する。

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

**読解のコツ**: メッセージテンプレートは "$1" であり、実際のメッセージはsemexprs.nimで動的に構築される。

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

警告が発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semexprs.nim | `compiler/semexprs.nim` | 180-187行目でシンボル衝突を検出し、警告メッセージを生成してmessage関数を呼び出す |

**主要処理フロー**:
1. **180-181行目**: 単一シンボルの場合のメッセージ構築
2. **183-186行目**: オーバーロードの場合のメッセージ構築
3. **187行目**: message関数呼び出しで警告を出力

#### Step 3: シンボル解決コンテキストを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | semexprs.nim | `compiler/semexprs.nim` | semOpenSym関数全体（約150-195行目）を確認し、シンボル解決の文脈を理解する |

**主要処理フロー**:
- **nfDisabledOpenSymフラグ**: 注入されたシンボルが無効化されていることを示す
- **外側スコープの検索**: 同名シンボルを持つ外側スコープを探索
- **警告発行条件**: 衝突が検出された場合

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

```
semexprs.nim: semSymChoice (シンボル選択処理)
    │
    └─ semexprs.nim: semOpenSym (オープンシンボル解決)
           │
           ├─ シンボル衝突検出
           │
           └─ msgs.nim: message (警告発行)
                  │
                  └─ msgs.nim: liMessage (メッセージ処理)
```

### データフロー図

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

nkOpenSymChoice ───▶ semexprs.nim ───▶ シンボル衝突検出
    ノード                semOpenSym         │
                                            ▼
                                     msgs.nim ───▶ stderr/stdout
                                  (message関数)     (警告メッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義とメッセージテンプレート |
| semexprs.nim | `compiler/semexprs.nim` | ソース | 式のセマンティック解析、警告発行トリガー |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | experimental:openSymオプション管理 |
