# 通知設計書 1-errUnknown

## 概要

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

### 本通知の処理概要

errUnknownは、Nimコンパイラで予期しない未知のエラーが発生した場合に出力される致命的エラー（Fatal Error）通知である。

**業務上の目的・背景**：コンパイラは複雑なソフトウェアであり、予測不能な状況が発生する可能性がある。errUnknownは、他のエラーカテゴリに分類できない未知の状況が発生した際に、ユーザーに問題の発生を通知し、コンパイルプロセスを安全に終了させる目的で設計されている。このエラーは、コンパイラのバグや未対応のエッジケースを検出するための最終防衛線として機能する。

**通知の送信タイミング**：コンパイラ内部で予期しないエラー条件が発生し、他の具体的なエラー種別に該当しない場合にトリガーされる。具体的には、TinyC（tccgen.nim）でのコード実行時にエラーが発生した場合などがある。

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

**通知内容の概要**：「unknown error」という固定メッセージが出力される。パラメータは含まれず、詳細情報は提供されない。

**期待されるアクション**：開発者は、このエラーが発生した場合、コンパイラのバグレポートを提出するか、コードを見直して問題の原因を特定することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行},{列}) Error: unknown error
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | MsgKindToStr[errUnknown] | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイラ内部処理 | TinyCコンパイル実行エラー | tcc.run()が非ゼロを返却 | tccgen.nimでの処理失敗時 |
| コンパイラ内部処理 | 未知のエラー条件 | 他のエラー種別に該当しない | 汎用エラーハンドリング |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | Fatal Errorのため常に出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[エラー条件発生] --> B{エラー種別判定}
    B -->|未知のエラー| C[errUnknown選択]
    C --> D[rawMessage呼び出し]
    D --> E[liMessage処理]
    E --> F[handleError処理]
    F --> G{fatalMsgs判定}
    G -->|Yes| H[quit処理]
    H --> I[コンパイラ終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

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

## 備考

- errUnknownは`fatalMsgs`セット（errUnknown..errInternal）に含まれる
- このエラーが発生するとコンパイラは即座に終了する（exit code: 1）
- IDEツールモード（cmdIdeTools）では特別な処理が行われる場合がある

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: TMsgKindはNimの列挙型で、コンパイラの全メッセージ種別を定義している。errUnknownは最初の要素であり、Fatal Errorカテゴリに属する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | rawMessageテンプレートが通知の起点（610-615行目） |
| 2-2 | tccgen.nim | `compiler/tccgen.nim` | errUnknownを使用する具体例（88行目） |

**主要処理フロー**:
1. **88行目（tccgen.nim）**: TinyCの実行結果がエラーの場合、rawMessage(conf, errUnknown, "")を呼び出し
2. **610-615行目（msgs.nim）**: rawMessageテンプレートがliMessageを呼び出し

#### 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` | quit関数でプログラム終了（432-443行目） |

**主要処理フロー**:
- **536行目**: liMessage関数開始、メッセージ種別に応じた処理
- **545-548行目**: fatalMsgsの場合、errorOutputsを強制設定
- **604-605行目**: handleError呼び出し
- **446-449行目**: fatalMsgsの場合、quit処理を実行

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

```
tccgen.nim::runCCode (88行目)
    │
    └─ rawMessage(conf, errUnknown, "")
           │
           └─ liMessage(conf, unknownLineInfo, errUnknown, ...)
                  │
                  ├─ styledMsgWriteln (メッセージ出力)
                  │
                  └─ handleError
                         │
                         └─ quit(conf, msg)
                                │
                                └─ quit 1 (プログラム終了)
```

### データフロー図

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

TinyC実行結果 ───▶ tccgen.runCCode ───▶ 標準エラー出力
(err = true)        │                     "unknown error"
                    ▼
              rawMessage
                    │
                    ▼
              liMessage
                    │
                    ▼
              handleError
                    │
                    ▼
                 quit(1)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージ文字列定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理、エラーハンドリング |
| tccgen.nim | `compiler/tccgen.nim` | ソース | errUnknownの使用例（TinyCコード生成） |
| options.nim | `compiler/options.nim` | ソース | ConfigRef定義（設定情報） |
