# 通知設計書 121-hintUnknownRaises

## 概要

本ドキュメントは、Nimコンパイラの通知種別「hintUnknownRaises」（No.121）に関する設計仕様を定義する。この通知は、明示的な`.raises`プラグマが指定されていない前方宣言が、例外を発生させる可能性があることをコンパイラが仮定した際に出力されるヒント通知である。

### 本通知の処理概要

hintUnknownRaisesは、Nimコンパイラのエフェクトシステムにおける例外追跡機能の一部として使用されるヒント通知である。この通知により、開発者に対して前方宣言されたプロシージャが潜在的な例外源であることを警告し、コードの安全性向上を促す。

**業務上の目的・背景**：Nimコンパイラはエフェクトシステムにより、プロシージャが発生させる可能性のある例外を追跡する。前方宣言（forward declaration）のみで実装が存在しない、または`.raises`プラグマで明示的に例外が指定されていないプロシージャが呼び出される場合、コンパイラはそのプロシージャがあらゆる例外を発生させる可能性があると仮定する必要がある。この通知は、そのような状況を開発者に知らせ、明示的な`.raises`指定を促すことで、より安全で予測可能なエラーハンドリングを実現する。

**通知の送信タイミング**：セマンティック解析の第2パス（sempass2）において、プロシージャのエフェクトチェックが行われる際に送信される。具体的には、`.raises`プラグマが指定されたプロシージャ内で、明示的な`.raises`を持たない前方宣言されたプロシージャを呼び出している場合に、例外仕様の不一致が検出された時点で通知される。

**通知の受信者**：Nimコンパイラを使用してコードをコンパイルする開発者。特に、エフェクトシステムを活用して例外安全なコードを記述しようとしている開発者に向けた情報提供。

**通知内容の概要**：前方宣言されたプロシージャ名と、そのプロシージャに明示的な`.raises`プラグマがないため、あらゆる例外を発生させる可能性があると仮定されている旨を通知する。

**期待されるアクション**：開発者は、指摘された前方宣言に対して適切な`.raises`プラグマを追加するか、プロシージャの実装を確認して例外仕様を明示化することが期待される。

## 通知種別

コンパイラヒント（Hint）- コンソール出力

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時に即座に出力） |
| 優先度 | 低（ヒント） |
| リトライ | 無し |

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

コンパイラの標準エラー出力（stderr）または標準出力（stdout、`--stdout`オプション指定時）に対して送信される。`--verbosity:2`以上、または明示的に`--hint:UnknownRaises:on`が指定されている場合に有効となる。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（`--stdout`指定時） |
| 形式 | プレーンテキスト / カラー出力（`--colors:on`指定時） |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Hint: {プロシージャ名} is a forward declaration without explicit .raises, assuming it can raise anything [UnknownRaises]
```

### 出力例

```
/path/to/file.nim(42, 5) Hint: someForwardProc is a forward declaration without explicit .raises, assuming it can raise anything [UnknownRaises]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 前方宣言されたプロシージャ名 | PSym.name.s（シンボルテーブル） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | propagateEffects関数実行 | 前方宣言で.raisesが未指定 | セマンティック解析第2パスでのエフェクト伝播時 |
| コンパイル処理 | checkRaisesSpec関数実行 | unknownRaises配列に要素が存在 | raises仕様の検証時に未知の例外源を報告 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--hint:UnknownRaises:off` | ヒントが明示的に無効化されている場合 |
| `--verbosity:0` または `--verbosity:1` | 冗長性レベルが低い場合（デフォルトでは無効） |
| `.raises`プラグマが指定されている場合 | 前方宣言に明示的な例外仕様がある場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[プロシージャ呼び出しの解析] --> B{呼び出し先は前方宣言?}
    B -->|No| C[通常のエフェクト解析]
    B -->|Yes| D{.raisesプラグマあり?}
    D -->|Yes| E[指定された例外をマージ]
    D -->|No| F[unknownRaisesに追加]
    F --> G[checkRaisesSpec実行]
    G --> H{raises仕様違反あり?}
    H -->|Yes| I[hintUnknownRaisesを出力]
    H -->|No| J[処理続行]
    I --> K[エラー/警告メッセージ出力]
    K --> L[終了]
    E --> L
    C --> L
    J --> L
```

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

### 参照テーブル一覧

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

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| TEffects.unknownRaises | 未知の例外を発生させるプロシージャのリスト | seq[(PSym, TLineInfo)]型 |
| PSym | プロシージャシンボル情報 | シンボルテーブルのエントリ |
| TLineInfo | ソースコード位置情報 | ファイル・行・列番号 |

### テーブル別参照項目詳細

#### TEffects構造体

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| unknownRaises | 前方宣言で.raisesがないプロシージャのリスト | propagateEffects実行時に追加 |
| config | コンパイラ設定 | ヒント出力可否の判定 |
| graph | モジュールグラフ | メッセージ出力用 |

### 更新テーブル一覧

該当なし（読み取り専用）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | 本通知はヒントであり、エラーではない |

### リトライ仕様

該当なし

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（発生するごとに出力） |

### 配信時間帯

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

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

- 本通知はソースコードのファイルパス、行番号、プロシージャ名を出力するため、CI/CDログなどで公開される場合はソースコード構造が推測される可能性がある
- 機密性の高いプロジェクトでは、ログ出力の管理に注意が必要

## 備考

- Nim 1.0以降で導入されたエフェクトシステムの一部
- `--panics:on`オプションと組み合わせて使用することで、より厳密な例外チェックが可能
- 将来のバージョンでは、コールグラフ解析による精度向上が検討されている（ソースコードコメント参照）

---

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

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

### 推奨読解順序

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

まず、エフェクトトラッキングに使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のhintUnknownRaises定義（115行目）とMsgKindToStr配列の対応メッセージ（244行目）を確認 |
| 1-2 | sempass2.nim | `compiler/sempass2.nim` | TEffects型の定義、特にunknownRaisesフィールド（89行目）を確認 |

**読解のコツ**: Nimコンパイラでは、メッセージ種別はTMsgKind列挙型で定義され、対応するメッセージテンプレートはMsgKindToStr配列で管理されている。

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sempass2.nim | `compiler/sempass2.nim` | propagateEffects関数（689-703行目）がエフェクト伝播の起点 |

**主要処理フロー**:
1. **689行目**: propagateEffects関数の定義開始
2. **691行目**: プラグマから.raises仕様を取得
3. **692-693行目**: 前方宣言で.raisesがない場合、unknownRaisesに追加
4. **694行目**: mergeRaisesで例外をマージ

#### Step 3: ヒント出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sempass2.nim | `compiler/sempass2.nim` | checkRaisesSpec関数（1603-1632行目）で実際のヒント出力が行われる |

**主要処理フロー**:
- **1605行目**: unknownRaisesパラメータの受け取り
- **1622-1623行目**: unknownRaisesの各要素に対してhintUnknownRaisesを出力

#### Step 4: メッセージ出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | msgs.nim | `compiler/msgs.nim` | message関数（641-642行目）でヒント出力が実行される |
| 4-2 | msgs.nim | `compiler/msgs.nim` | liMessage関数（536-608行目）で実際のフォーマットと出力処理 |

**主要処理フロー**:
- **574-583行目**: ヒントメッセージの場合の処理分岐
- **596-597行目**: スタイル付きメッセージの出力

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

```
trackProc (sempass2.nim)
    │
    ├─ track (sempass2.nim)
    │      └─ trackCall (sempass2.nim)
    │              └─ propagateEffects (sempass2.nim:689-703)
    │                      └─ [前方宣言で.raisesなし] → unknownRaises.add
    │
    └─ checkRaisesSpec (sempass2.nim:1603-1632)
            │
            └─ message (msgs.nim:641-642)
                    └─ liMessage (msgs.nim:536-608)
                            └─ styledMsgWriteln (msgs.nim:401-417)
```

### データフロー図

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

プロシージャAST ───▶ propagateEffects ───▶ unknownRaises配列
                            │
                            ▼
                    checkRaisesSpec
                            │
                            ▼
                       message関数 ───▶ コンソール出力（Hint）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート |
| sempass2.nim | `compiler/sempass2.nim` | ソース | エフェクトシステム、例外追跡処理 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | コンパイラオプション、ヒント有効化判定 |
