# 通知設計書 3-errInternal

## 概要

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

### 本通知の処理概要

errInternalは、コンパイラ内部で予期しないプログラミングエラーや異常状態が検出された場合に出力されるFatal Error通知である。これはコンパイラ自体のバグを示す可能性が高い。

**業務上の目的・背景**：コンパイラは複雑なソフトウェアであり、内部的な整合性チェックが必要である。errInternalは、コンパイラ開発者がバグを特定するための重要な情報を提供し、ユーザーにはコンパイラのバグである可能性を通知する。スタックトレースの出力を促すことで、バグレポートに必要な情報を収集できるようにする。

**通知の送信タイミング**：internalError/internalAssertテンプレート・関数が呼び出された時点で発行される。コンパイラ内部の整合性チェック失敗、予期しない状態の検出時にトリガーされる。

**通知の受信者**：Nimソースコードをコンパイルしている開発者、およびコンパイラ開発者。標準エラー出力を通じてメッセージを受け取る。

**通知内容の概要**：「internal error: {詳細メッセージ}」という形式で出力される。debugモードまたはhintStackTraceが有効な場合、スタックトレースも出力される。

**期待されるアクション**：ユーザーは、このエラーが発生した場合、コンパイラのバグレポートを提出することが期待される。スタックトレースを取得するための再コンパイル手順も提示される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

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

スタックトレースが利用できない場合：
```
No stack traceback available
To create a stacktrace, rerun compilation with './koch temp {コマンド} <file>', see {URL} for details
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイラ内部処理 | 内部整合性チェック失敗 | internalError呼び出し | 予期しない状態検出 |
| コンパイラ内部処理 | internalAssert失敗 | アサーション条件がfalse | 内部条件違反 |
| パーサー処理 | skipComment異常 | node == nil時のコメント処理 | parser.nim 212行目 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| IDEツール/チェックモード | cmdIdeTools/cmdCheckでstructuredErrorHookがnilの場合、処理をスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[内部エラー検出] --> B[internalErrorImpl呼び出し]
    B --> C{cmdIdeTools/cmdCheck?}
    C -->|Yes かつ hook無し| D[処理スキップ]
    C -->|No| E[writeContext呼び出し]
    E --> F[liMessage処理]
    F --> G[メッセージ出力]
    G --> H{スタックトレース?}
    H -->|利用可能| I[writeStackTrace]
    H -->|利用不可| J[再コンパイル手順表示]
    I --> K[quit処理]
    J --> K
    K --> L[コンパイラ終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- エラーメッセージにはファイルパスや行番号が含まれる
- スタックトレースにはコンパイラ内部の関数名が含まれる
- ローカル開発環境での使用を想定

## 備考

- errInternalは`fatalMsgs`セット（errUnknown..errInternal）に含まれる
- debugビルドまたは`hintStackTrace`有効時にスタックトレースを出力
- `nimDebug`定義時はquitOrRaiseを使用（デバッグ用）
- quit関数内でerrInternalの特別処理あり（434行目）

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: errInternalはfatalMsgsの最後の要素（errUnknown..errInternal）であり、最も重要な内部エラー通知である。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | internalErrorImplが実装の中核（647-650行目） |
| 2-2 | msgs.nim | `compiler/msgs.nim` | internalErrorテンプレート（652-656行目） |
| 2-3 | msgs.nim | `compiler/msgs.nim` | internalAssertテンプレート（658-663行目） |

**主要処理フロー**:
1. **647-650行目**: internalErrorImpl - IDEモードチェック後、liMessage呼び出し
2. **652-653行目**: internalError(info, errMsg) - 位置情報付きエラー
3. **655-656行目**: internalError(errMsg) - 位置情報なしエラー

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | quit関数でerrInternalの特別処理（432-443行目） |
| 3-2 | msgs.nim | `compiler/msgs.nim` | スタックトレース出力ロジック（434-442行目） |

**主要処理フロー**:
- **434行目**: `msg == errInternal`の条件でスタックトレース出力を決定
- **436-437行目**: スタックトレースが利用可能な場合、writeStackTrace()
- **439-442行目**: 利用不可な場合、再コンパイル手順を表示

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

```
各種コンパイラモジュール
    │
    ├─ internalError(conf, info, errMsg)
    │      │
    │      └─ internalErrorImpl(conf, info, errMsg, instLoc())
    │
    └─ internalAssert(conf, cond)
           │
           └─ internalErrorImpl (condがfalseの場合)
                  │
                  └─ writeContext(conf, info)
                         │
                         └─ liMessage(conf, info, errInternal, errMsg, doAbort, ...)
                                │
                                └─ handleError → quit
                                       │
                                       ├─ writeStackTrace() (if available)
                                       │
                                       └─ quit 1
```

### データフロー図

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

内部エラー情報 ───▶ internalErrorImpl ────▶ 標準エラー出力
(info, errMsg)      │                        "internal error: {errMsg}"
                    ▼
              writeContext                   スタックトレース
                    │                        (利用可能な場合)
                    ▼
              liMessage
                    │
                    ▼
              quit(conf, errInternal)
                    │
                    ▼
              writeStackTrace()
                    │
                    ▼
                 quit(1)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージ文字列定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | internalError関連テンプレート・関数 |
| parser.nim | `compiler/parser.nim` | ソース | errInternalの使用例（skipComment） |
| options.nim | `compiler/options.nim` | ソース | ConfigRef定義、コマンドモード定義 |
