# 通知設計書 18-errGenerated

## 概要

本ドキュメントは、Nimコンパイラにおける汎用生成エラー通知「errGenerated」の設計について記述する。

### 本通知の処理概要

errGeneratedは、コンパイラ内部で動的に生成されるエラーメッセージを出力するための汎用エラー種別である。特定のエラーカテゴリに分類されない、または複雑なエラー条件を持つ様々なコンパイルエラーで使用される。

**業務上の目的・背景**：コンパイラは多種多様なエラー状況に対応する必要があるが、すべてのエラーに専用のTMsgKindを定義することは現実的ではない。errGeneratedは、カスタムメッセージを柔軟に出力できる汎用エラー機構として機能し、globalError/localErrorテンプレートの文字列引数版で使用される。

**通知の送信タイミング**：コンパイラの様々なフェーズで、特定のエラー種別では表現しきれないエラー状況が検出された際に発生する。主な発生源は：
1. globalError(conf, info, "エラーメッセージ") 形式の呼び出し
2. localError(conf, info, "エラーメッセージ") 形式の呼び出し
3. globalAssertテンプレートでのアサーション失敗

**通知の受信者**：Nimコンパイラを使用する開発者。

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号、および動的に生成されたエラーメッセージを含む。

**期待されるアクション**：開発者はエラーメッセージの内容に基づいてコードを修正する。エラーメッセージは具体的な問題と対処方法を示すことが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。IDEツールモードでは構造化エラーフックを通じて送信される。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: {動的メッセージ}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 動的に生成されたエラーメッセージ | 呼び出し元から渡される文字列 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | 様々なエラー状況 | 専用エラー種別がない場合 | globalError/localErrorの文字列版 |
| コンパイル | アサーション失敗 | globalAssertの条件不成立 | 内部検証エラー |
| ドキュメント生成 | runnableExamples位置エラー | コメント以外の文の後に配置 | docgen.nim |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ignoreMsgBecauseOfIdeTools | IDEツールモードかつoptIdeDebug無効の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル処理] --> B{エラー検出}
    B -->|専用エラー種別あり| C[専用エラー発行]
    B -->|専用エラー種別なし| D[errGenerated使用]
    D --> E[globalError/localError呼び出し]
    E --> F[liMessage関数]
    F --> G{IDEツールモード?}
    G -->|Yes| H{optIdeDebug?}
    H -->|Yes| I[エラー出力]
    H -->|No| J[出力抑止]
    G -->|No| I
    I --> K[stderr / 構造化フック]
    C --> K
    J --> L[終了]
    K --> L
```

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 様々 | 状況依存 | エラーメッセージに従う |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 特になし

## 備考

- errGeneratedはメッセージテンプレートが「$1」のみであり、引数がそのままメッセージになる
- コンパイラコードベース全体で広く使用されている汎用エラー機構
- IDEツールモードでの特別な処理（ignoreMsgBecauseOfIdeTools）が存在する

---

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

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

### 推奨読解順序

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

errGeneratedの定義と使用方法を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrGenerated定義（47行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | エラーメッセージテンプレート「$1」（138行目） |

**読解のコツ**: メッセージテンプレートが「$1」のみであることから、引数がそのまま出力されることがわかる。

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

globalError/localErrorの文字列版を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | globalErrorテンプレート（632-633行目） |
| 2-2 | msgs.nim | `compiler/msgs.nim` | localErrorテンプレート（638-639行目） |
| 2-3 | msgs.nim | `compiler/msgs.nim` | globalAssertテンプレート（620-625行目） |

**主要処理フロー**:
1. **632-633行目**: globalError(conf, info, arg: string)がerrGeneratedで呼び出す
2. **638-639行目**: localError(conf, info, arg: string)がerrGeneratedで呼び出す
3. **625行目**: globalAssertがerrGeneratedで条件失敗を報告

#### Step 3: IDEツールモード特別処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | ignoreMsgBecauseOfIdeTools関数（492-493行目） |

**主要処理フロー**:
- **492-493行目**: errGenerated以上かつcmdIdeToolsかつoptIdeDebug無効なら抑止

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

```
コンパイラ各所
    │
    ├─ globalError(conf, info, "message")
    │      │
    │      └─ liMessage(conf, info, errGenerated, "message", doRaise, instLoc())
    │
    ├─ localError(conf, info, "message")
    │      │
    │      └─ liMessage(conf, info, errGenerated, "message", doNothing, instLoc())
    │
    └─ globalAssert(conf, cond, info, arg)
           │
           └─ liMessage(conf, info, errGenerated, arg2, doRaise, instLoc())

liMessage
    │
    ├─ ignoreMsgBecauseOfIdeTools チェック
    │
    └─ handleError (エラーカウント、終了処理)
```

### データフロー図

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

呼び出し元のエラーメッセージ ───▶ globalError/localError
                                       │
                                       ▼
                                  liMessage
                                       │
                                       ▼ [errGenerated]
                                  getMessageStr(errGenerated, arg)
                                       │
                                       ▼
                                  "Error: {arg}"
                                       │
                                       ▼
                                  stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | globalError/localError/globalAssert定義 |
| docgen.nim | `compiler/docgen.nim` | ソース | runnableExamplesエラーでerrUser使用 |
| pragmas.nim | `compiler/pragmas.nim` | ソース | {.error.}プラグマでerrUser使用 |
