# 通知設計書 60-warnResultShadowed

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnResultShadowed」（特殊変数resultがシャドウイングされた）の設計仕様を記載する。この警告は、プロシージャ内で暗黙的に宣言される特殊変数`result`が、ローカル変数によってシャドウイング（隠蔽）された場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、Nimの特殊な戻り値メカニズムである`result`変数の誤用を防ぐことを目的としている。Nimでは、戻り値を持つプロシージャ内で暗黙的に`result`という名前の変数が宣言され、この変数に値を代入することで戻り値を設定できる。しかし、開発者が誤って同名のローカル変数を宣言すると、暗黙の`result`変数がシャドウイングされ、意図しない動作を引き起こす可能性がある。

**通知の送信タイミング**：コンパイル時の意味解析フェーズ（semstmts.nim）において、変数宣言の解析時に発生する。具体的には、`semVarOrLet`関数内で変数定義を処理する際に、`findShadowedVar`関数を使用してシャドウイングをチェックし、シャドウイングされた変数が`skResult`（result変数）である場合に警告を発行する。

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

**通知内容の概要**：警告メッセージ「Special variable 'result' is shadowed.」（特殊変数'result'がシャドウイングされています）が、問題のある変数宣言のソースコード位置と共に表示される。

**期待されるアクション**：開発者はローカル変数の名前を`result`以外に変更するか、意図的に`result`をシャドウイングしている場合はその理由を明確にする。意図的なシャドウイングの場合は、`{.warning[ResultShadowed]:off.}`プラグマで警告を抑制することも可能。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: Special variable 'result' is shadowed. [ResultShadowed]
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 変数宣言解析 | shadowed.kind == skResultかつsfGenSym notin v.flags | result変数と同名のローカル変数を宣言 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[ResultShadowed]:off.}` | プラグマによる警告抑制 |
| `--warning:ResultShadowed:off` | コマンドラインオプションによる抑制 |
| sfGenSym in v.flags | ジェネリックシンボル（マクロ生成シンボル）の場合 |
| inUnrolledContext > 0 | ループ展開コンテキストの場合（sfShadowedを設定するのみ） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[変数宣言解析] --> B{inUnrolledContext > 0?}
    B -->|Yes| C[sfShadowed設定のみ]
    B -->|No| D[findShadowedVar呼び出し]
    D --> E{shadowed != nil?}
    E -->|No| F[チェック終了]
    E -->|Yes| G[shadowed.incl sfShadowed]
    G --> H{shadowed.kind == skResult?}
    H -->|No| F
    H -->|Yes| I{sfGenSym notin v.flags?}
    I -->|No| F
    I -->|Yes| J[warnResultShadowed発行]
    J --> K[message関数呼び出し]
    K --> F
    C --> F
```

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

### 参照テーブル一覧

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

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PSym | シンボル情報 | 変数のシンボルkindをチェック |
| PSym.flags | シンボルフラグ | sfGenSym, sfShadowedをチェック |
| PContext.inUnrolledContext | 展開コンテキストカウンタ | ループ展開中かどうか |

### 更新テーブル一覧

| データ構造 | 操作 | 概要 |
|-----------|------|------|
| PSym.flags (shadowed) | UPDATE | sfShadowedフラグを追加 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（発生箇所ごとに1回出力） |

### 配信時間帯

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

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

- ソースコードのパスが出力に含まれるため、ビルドログを公開する際はパス情報に注意が必要

## 備考

- `result`はNimの特殊な暗黙変数であり、戻り値を持つプロシージャで自動的に宣言される
- `result`をシャドウイングすると、戻り値の設定に`return`文を使用する必要がある
- テンプレートやマクロで生成されるシンボル（sfGenSym）はこの警告の対象外
- oKeepVariableNamesコンパイラフラグが有効な場合にこのチェックが行われる

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: メッセージには「Special variable」という表現があり、`result`が通常の変数ではない特殊な変数であることを示している。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semstmts.nim | `compiler/semstmts.nim` | semVarOrLet関数内の変数宣言処理 |

**主要処理フロー (semstmts.nim)**:
1. **940-941行目**: `when oKeepVariableNames`コンパイル時フラグのチェック
2. **941行目**: inUnrolledContext > 0の場合はsfShadowedを設定するのみ
3. **943行目**: `findShadowedVar(c, v)`でシャドウイングされた変数を検索
4. **944-945行目**: shadowedがnilでない場合、sfShadowedフラグを設定
5. **946行目**: `shadowed.kind == skResult`かつ`sfGenSym notin v.flags`をチェック
6. **947行目**: 条件を満たす場合、`message(c.config, a.info, warnResultShadowed)`を呼び出し

#### Step 3: findShadowedVar関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lookups.nim | `compiler/lookups.nim` | findShadowedVar関数の実装 |

**主要処理フロー**:
- 現在のスコープより外側のスコープを検索
- 同名の変数が存在するかをチェック

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

```
semstmts.nim::semVarOrLet (変数宣言解析)
    │
    ├─ semIdentDef()で変数シンボル作成
    │
    ├─ oKeepVariableNamesチェック
    │      │
    │      ├─ inUnrolledContext > 0: sfShadowed設定のみ
    │      │
    │      └─ findShadowedVar(c, v)
    │             │
    │             └─ shadowed != nil
    │                    │
    │                    ├─ shadowed.incl(sfShadowed)
    │                    │
    │                    └─ shadowed.kind == skResult
    │                           └─ message(warnResultShadowed)
    │
    └─ 変数定義の継続処理
```

### データフロー図

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

変数宣言（var/let）  ───▶ semVarOrLet                  ───▶ 警告メッセージ
result: int = 0           │                              (stderr)
                          ├─ シンボル作成
                          ├─ findShadowedVar()
                          ├─ skResultチェック
                          └─ message()呼び出し

                    ───▶ PSym.flags更新 (sfShadowed)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| semstmts.nim | `compiler/semstmts.nim` | ソース | 変数宣言解析・警告発行 |
| lookups.nim | `compiler/lookups.nim` | ソース | findShadowedVar関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| ast.nim | `compiler/ast.nim` | ソース | PSym型・skResult定義 |
