# 通知設計書 44-warnInheritFromException

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnInheritFromException`（例外継承警告）に関する設計書です。

### 本通知の処理概要

この警告は、Nimプログラムにおいて基底クラスの`Exception`から直接継承している場合に発生する警告メッセージです。より具体的な例外型（ValueError、IOError、OSErrorなど）からの継承を推奨します。

**業務上の目的・背景**：例外処理において、具体的な例外型を使用することで、エラーハンドリングの精度と可読性が向上します。基底の`Exception`型から直接継承すると、キャッチする側で例外の種類を区別しにくくなり、適切なエラー処理が困難になります。Nimの例外階層は、CatchableError（回復可能なエラー）とDefect（プログラムのバグ）に大別されており、新しい例外型はこれらの適切な基底クラスから継承すべきです。

**通知の送信タイミング**：コンパイル時のセマンティック解析フェーズ（semtypes.nim）において、オブジェクト型の継承関係を解析する際に、`Exception`（magic == mException）から直接継承していることが検出された場合に警告が発生します。

**通知の受信者**：Nimプログラムをコンパイルする開発者がこの警告を受け取ります。コンパイラの標準出力または標準エラー出力に警告メッセージが表示されます。

**通知内容の概要**：「inherit from a more precise exception type like ValueError, IOError or OSError. If these don't suit, inherit from CatchableError or Defect.」というメッセージが表示され、より具体的な例外型の使用を促します。

**期待されるアクション**：開発者は、新しい例外型の設計を見直し、CatchableError（回復可能なエラー用）またはDefect（プログラムバグ用）、あるいはより具体的な既存の例外型（ValueError、IOError、OSErrorなど）から継承するように変更することが期待されます。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

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

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

コンパイラを実行している開発者のコンソールに直接出力されます。警告の有効/無効は `--warning[InheritFromException]:on/off` オプションで制御可能です。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージID | InheritFromException |
| 警告レベル | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: inherit from a more precise exception type like ValueError, IOError or OSError. If these don't suit, inherit from CatchableError or Defect. [InheritFromException]
```

### 添付ファイル

該当なし（コンパイラ警告のため添付ファイルは存在しない）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイル名 | ソースファイルのパス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告発生行（オブジェクト定義の行） | TLineInfo.line | Yes |
| 列番号 | 警告発生列 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル時 | オブジェクト型定義解析 | Exceptionから直接継承 | semtypes.nim:1055-1057行目で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--warning[InheritFromException]:off` | コマンドラインオプションで警告を無効化 |
| `{.warning[InheritFromException]:off.}` | プラグマで警告を無効化 |
| systemモジュール内の場合 | sfSystemModule フラグが設定されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[オブジェクト型定義解析] --> B{継承元あり?}
    B -->|No| C[通常処理]
    B -->|Yes| D[継承元の型を取得]
    D --> E{tyObject?}
    E -->|No| C
    E -->|Yes| F{concreteBase.sym存在?}
    F -->|No| C
    F -->|Yes| G{magic == mException?}
    G -->|No| C
    G -->|Yes| H{systemモジュール内?}
    H -->|Yes| C
    H -->|No| I[warnInheritFromException発行]
    I --> C
```

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

### 参照テーブル一覧

該当なし（コンパイラ内部処理のため外部データベース参照なし）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

コンパイル実行時に即座に出力される（時間帯制限なし）

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

- 適切な例外階層を使用することで、エラーハンドリングの漏れを防ぎ、セキュリティ関連のエラーを適切に処理できる
- 汎用的なException型を使用すると、重要なエラーが見落とされる可能性がある

## 備考

- Nimの例外階層は以下の構造を持つ：
  - Exception（基底）
    - CatchableError（キャッチ可能なエラー）
      - ValueError、IOError、OSErrorなど
    - Defect（プログラムのバグ）
      - AssertionDefect、NilAccessDefectなど
- systemモジュール内では、標準ライブラリの例外型定義のためこの警告は発生しない
- この警告はコード品質の向上を目的としており、エラーにはならない

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種類を定義するデータ構造を理解することが重要です。

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

**読解のコツ**: メッセージは複数行にわたって定義されており、具体的な例外型の推奨が含まれています。

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

警告を発生させるsemObjectNode関連のコードを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semtypes.nim | `compiler/semtypes.nim` | 1054-1057行目でException継承チェックを確認 |

**主要処理フロー**:
1. **1054行目**: `if concreteBase.kind == tyObject:`でオブジェクト型かチェック
2. **1055行目**: `concreteBase.sym != nil`でシンボル存在確認
3. **1055行目**: `concreteBase.sym.magic == mException`でExceptionかチェック
4. **1056行目**: `sfSystemModule notin c.module.flags`でsystemモジュール外かチェック
5. **1057行目**: 条件を満たす場合にwarnInheritFromException警告を発行

#### Step 3: mExceptionマジックを理解する

Exceptionがどのように特別な型として認識されるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ast.nim | `compiler/ast.nim` | TMagicの定義でmExceptionを確認 |

**主要処理フロー**:
- mExceptionはsystemモジュールで定義されたException型を識別するためのマジック値

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

```
semtypes.nim::semObjectNode()
    │
    ├─ 継承元解析 (n[1].kind != nkEmpty)
    │      │
    │      └─ semTypeNode(c, n[1][0], nil)
    │             │
    │             └─ concreteBase取得
    │
    └─ tyObjectチェック（1054行目）
           │
           └─ magic == mException?（1055行目）
                  │
                  └─ sfSystemModule?（1056行目）
                         │
                         └─ message(warnInheritFromException)（1057行目）
                                │
                                └─ コンソール出力
```

### データフロー図

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

type MyError = object of Exception
        │
        ▼
オブジェクト型定義 ───▶ semObjectNode()
                           │
                           ├─ 継承元型取得
                           │       │
                           │       └─ concreteBase = Exception
                           │
                           └─ magic == mException? ───▶ 警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別の定義とメッセージテンプレート |
| semtypes.nim | `compiler/semtypes.nim` | ソース | オブジェクト型解析と警告発生ロジック |
| ast.nim | `compiler/ast.nim` | ソース | TMagic列挙型（mExceptionの定義） |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
