# 通知設計書 94-hintXCannotRaiseY

## 概要

本ドキュメントは、Nimコンパイラにおけるヒント通知「hintXCannotRaiseY」の設計を記載する。この通知は関数が特定の例外を発生させることができないことをユーザーに通知するためのものである。

### 本通知の処理概要

hintXCannotRaiseY（$1）は、.raisesプラグマで宣言された例外型のうち、実際には発生し得ない例外がある場合に発行されるヒントメッセージである。

**業務上の目的・背景**：例外仕様の正確性と保守性の向上を目的とする。.raisesプラグマは関数が発生させる可能性のある例外を明示的に宣言するが、コードの変更により実際には発生しなくなった例外が残っている場合がある。この通知により、開発者は不要な例外宣言を特定し、例外仕様を最新の状態に保つことができる。

**通知の送信タイミング**：セマンティック解析の第2パス（sempass2）において、関数の例外効果解析が完了した後に送信される。

**通知の受信者**：コンパイルを実行している開発者。標準エラー出力を通じて通知される。

**通知内容の概要**：「'{関数名}' cannot raise '{例外型}'」の形式で、発生し得ない例外型が通知される。

**期待されるアクション**：開発者は通知を受け、.raisesプラグマから不要な例外型を削除する。

## 通知種別

コンパイラコンソール出力（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（ヒント） |
| リトライ | 無 |

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

コンパイラを実行しているプロセスの標準エラー出力に直接出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| 出力先 | stderr |
| 形式 | テキスト |

### 本文テンプレート

```
'{関数名}' cannot raise '{例外型}'
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 完全なメッセージ | 動的生成 | Yes |
| 関数名 | 解析対象の関数名 | hintsArg（PNode） | Yes |
| 例外型 | 発生しない例外型 | spec[s]（例外仕様リスト） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 例外効果解析 | checkRaisesSpec実行時 | 宣言された例外が未使用 | .raises内の例外が実際に発生しない |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| hints = false | ヒント出力が無効な場合 |
| used.contains(s) | 例外が実際に使用される場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[trackProc呼び出し] --> B[例外効果解析]
    B --> C[checkRaisesSpec呼び出し]
    C --> D[spec各要素を反復]
    D --> E{used.contains?}
    E -->|Yes| D
    E -->|No| F{hints有効?}
    F -->|No| D
    F -->|Yes| G[message hintXCannotRaiseY]
    G --> D
    D --> H[終了]
```

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

### 参照テーブル一覧

コンパイラ内部の効果解析データを参照。データベースは使用しない。

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | stderr書き込みエラー | 処理継続（無視） |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

機密情報を含まない。関数名と例外型名が表示されるが、ローカル開発環境での使用が前提であり、特別なセキュリティ対策は不要。

## 備考

- Defect例外はチェック対象外（回復不能なエラーのため）
- --experimental:strictEffectsと組み合わせて使用可能
- メソッドの場合、基底クラスの例外仕様との整合性もチェックされる

---

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

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

### 推奨読解順序

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

まず、例外効果解析の構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintXCannotRaiseYの定義（106行目）とメッセージ（217行目） |
| 1-2 | sempass2.nim | `compiler/sempass2.nim` | TEffects構造体の定義（68-96行目） |

**読解のコツ**: TEffects.excが例外スタック、specが宣言された例外仕様を表す。

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

例外仕様チェックの呼び出し箇所を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sempass2.nim | `compiler/sempass2.nim` | checkRaisesSpec関数（1626-1632行目付近） |

**主要処理フロー**:
1. **1626行目**: popInfoContext後の処理
2. **1628-1632行目**: ヒント出力ループ

#### Step 3: ヒント出力ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sempass2.nim | `compiler/sempass2.nim` | 未使用例外のチェックと出力（1628-1632行目） |

**主要処理フロー**:
- **1628行目**: hints変数でヒント出力可否判定
- **1629-1630行目**: used.containsで使用済み判定
- **1631-1632行目**: message呼び出しでヒント出力

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

```
trackProc (sempass2.nim)
    │
    ├─ track (本体解析)
    │      └─ 例外効果の収集
    │
    └─ checkRaisesSpec (sempass2.nim)
           ├─ spec反復処理
           │      └─ used.contains チェック
           │
           └─ message(hintXCannotRaiseY)
                  └─ renderTree(hintsArg)
                  └─ renderTree(spec[s])
```

### データフロー図

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

.raisesプラグマ ───▶ checkRaisesSpec ───▶ stderr
      │                    │
      ├─ spec（宣言例外）   ├─ used集合と比較
      │                    └─ 未使用例外を検出
      │
      └─ 実際の例外効果 ───▶ used集合構築
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | hintXCannotRaiseY定義 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | 例外効果解析とヒント出力 |
| types.nim | `compiler/types.nim` | ソース | 例外型の比較処理 |
| msgs.nim | `compiler/msgs.nim` | ソース | message関数 |
