# 通知設計書 2-errFatal

## 概要

本ドキュメントは、Nimコンパイラにおける致命的エラー通知「errFatal」の設計仕様を定義する。

### 本通知の処理概要

errFatalは、コンパイル処理を続行することが不可能な致命的エラーが発生した場合に出力されるFatal Error通知である。

**業務上の目的・背景**：コンパイル処理において、回復不能な状態が発生した場合に、明確なエラーメッセージとともにコンパイルを安全に終了させる必要がある。errFatalは、ユーザーに具体的なエラー理由を伝え、問題解決のための情報を提供することを目的としている。`{.fatal.}`プラグマによってユーザーが意図的にコンパイルを停止させる場合にも使用される。

**通知の送信タイミング**：コンパイラがコンパイル続行不可能と判断した時点、または`{.fatal.}`プラグマが処理された時点で発行される。`fatal`テンプレート（msgs.nim 617行目）を通じて呼び出される。

**通知の受信者**：Nimソースコードをコンパイルしている開発者。標準エラー出力（stderr）または標準出力（stdout）を通じてメッセージを受け取る。

**通知内容の概要**：「fatal error: {詳細メッセージ}」という形式で出力される。$1プレースホルダーに具体的なエラー理由が挿入される。

**期待されるアクション**：開発者は、エラーメッセージの内容を確認し、ソースコードの問題を修正するか、コンパイルオプションを調整することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 最高（Fatal Error） |
| リトライ | なし（即座に終了） |

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

コンパイラオプション`--stdout`が指定されている場合はstdoutに、それ以外はstderrに出力される。

## 通知テンプレート

### コンソール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| メッセージ種別 | Error |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行},{列}) Error: fatal error: {詳細メッセージ}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | エラー詳細メッセージ | fatal呼び出し時のarg引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プラグマ処理 | {.fatal.}プラグマ | プラグマ検出時 | ユーザー定義の致命的エラー |
| コンパイラ内部処理 | 回復不能エラー | コンパイル続行不可 | 内部状態異常 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| IDEツールモード | cmdIdeToolsの場合、errFatal以外のfatalMsgsでもquitしない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[致命的エラー発生] --> B[fatalテンプレート呼び出し]
    B --> C[liMessage処理]
    C --> D[メッセージ出力]
    D --> E[handleError処理]
    E --> F{cmdIdeTools?}
    F -->|No| G[quit処理]
    F -->|Yes かつ errFatal| G
    F -->|Yes かつ errFatal以外| H[継続処理]
    G --> I[コンパイラ終了]
```

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

### 参照テーブル一覧

該当なし（ファイルベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | このエラー自体が最終的なエラー通知 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- エラーメッセージにはユーザー定義の文字列が含まれる可能性がある
- ファイルパス情報が含まれる可能性があるが、ローカル開発環境での使用を想定

## 備考

- errFatalは`fatalMsgs`セット（errUnknown..errInternal）に含まれる
- IDEツールモードではerrFatalの場合のみquit処理が実行される（handleError 448行目）
- `tryConstExpr`内で発生した場合でも、メッセージ出力は抑制されない（546-548行目）

---

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

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

### 推奨読解順序

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

errFatal通知の基盤となるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でerrFatalの定義を確認（32行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列でメッセージ文字列を確認（122行目） |
| 1-3 | lineinfos.nim | `compiler/lineinfos.nim` | fatalMsgs定数でFatal Errorの範囲を確認（250行目） |

**読解のコツ**: errFatalのメッセージテンプレートは"fatal error: $1"であり、$1に具体的なエラー内容が挿入される。

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

通知発行の起点となるファイル・関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | fatalテンプレートが通知の主要起点（617-618行目） |

**主要処理フロー**:
1. **617行目**: `fatal`テンプレート定義 - `msg = errFatal`がデフォルト
2. **618行目**: liMessage呼び出しで`doAbort`を指定

#### Step 3: メッセージ処理を理解する

メッセージの出力処理の流れを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | liMessage関数でメッセージ出力処理（536-608行目） |
| 3-2 | msgs.nim | `compiler/msgs.nim` | handleError関数でエラー処理（445-465行目） |
| 3-3 | msgs.nim | `compiler/msgs.nim` | IDEツールモードでのerrFatal特別処理（448行目） |

**主要処理フロー**:
- **545-548行目**: fatalMsgsの場合、errorOutputsを強制設定（ギャグを無効化）
- **448行目**: `conf.cmd != cmdIdeTools or msg != errFatal` - IDEモードでもerrFatalはquit

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

```
各種コンパイラモジュール
    │
    └─ fatal(conf, info, arg, errFatal)
           │
           └─ liMessage(conf, info, errFatal, arg, doAbort, ...)
                  │
                  ├─ styledMsgWriteln (メッセージ出力)
                  │
                  └─ handleError
                         │
                         └─ quit(conf, msg)
                                │
                                └─ quit 1 (プログラム終了)
```

### データフロー図

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

エラー情報 ─────▶ fatal(conf, info, arg) ───▶ 標準エラー出力
(info, arg)         │                         "fatal error: {arg}"
                    ▼
              liMessage
                    │
                    ▼
              handleError
                    │
                    ▼
                 quit(1)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージ文字列定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | fatalテンプレート、メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | ConfigRef定義、cmdIdeTools定義 |
