# 通知設計書 20-errUser

## 概要

本ドキュメントは、Nimコンパイラにおけるユーザー定義エラー通知「errUser」の設計について記述する。

### 本通知の処理概要

errUserは、Nimソースコード内で開発者が明示的に定義・発行するエラー通知である。`{.error: "メッセージ".}`プラグマを使用することで、コンパイル時にカスタムエラーを発生させることができる。

**業務上の目的・背景**：開発者がコンパイル時にエラーを発生させる手段を提供する。主な用途：
1. 特定のコード構成やコンパイル設定を禁止するためのガード
2. テンプレート/ジェネリック内での静的アサーション
3. 非推奨機能の使用防止
4. プラットフォーム/設定に依存するコードの制御

**通知の送信タイミング**：コンパイル時に`{.error: "メッセージ".}`プラグマが評価された際に発生する。また、インクリメンタルコンパイルのリプレイ時にも発生する。

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

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号、およびユーザーが定義したエラーメッセージを含む。

**期待されるアクション**：開発者はエラーメッセージに基づいて、コードを修正するか、コンパイル設定を変更する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（pragmas/ic replayer） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: {ユーザー定義メッセージ}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | ユーザー定義エラーメッセージ | {.error: "...".}プラグマの引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | {.error.}プラグマ評価 | プラグマに文字列引数がある | pragmas.nim wErrorハンドラ |
| コンパイル | ICリプレイ | recordPragmaでerror記録済み | ic/replayer.nim |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 引数なし | {.error.}が引数なしの場合は別の処理（シンボルにsfErrorを設定） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル開始] --> B[プラグマ解析]
    B --> C{{.error.}プラグマ?}
    C -->|No| D[他のプラグマ処理]
    C -->|Yes| E{文字列引数あり?}
    E -->|No| F[sfErrorフラグ設定]
    E -->|Yes| G[recordPragma呼び出し]
    G --> H[localError - errUser]
    H --> I[エラー出力]
    D --> J[終了]
    F --> J
    I --> J
```

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし（インクリメンタルコンパイル時に記録される）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ユーザー定義エラー | {.error: "msg".}プラグマ | エラーメッセージに従い対処 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 特になし

## 備考

- `{.error.}`プラグマに引数がない場合は、シンボルにsfErrorフラグを設定する（シンボル使用時にエラー発生）
- `{.fatal: "msg".}`プラグマも存在し、これは即座にコンパイルを停止する致命的エラーを発生させる
- インクリメンタルコンパイル時には、recordPragmaで記録された情報がリプレイされる

---

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

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

### 推奨読解順序

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

errUserの定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrUser定義（49行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | エラーメッセージテンプレート「$1」（140行目） |
| 1-3 | lineinfos.nim | `compiler/lineinfos.nim` | errMax = errUser（252行目）- エラー範囲の上限 |

**読解のコツ**: errUserはエラーカテゴリの最後のエントリ（errMax）であり、ユーザー定義エラーの終端マーカーでもある。

#### Step 2: エラー発行箇所を理解する

errUserの発行箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pragmas.nim | `compiler/pragmas.nim` | wErrorハンドラ（1139-1144行目） |
| 2-2 | ic/replayer.nim | `compiler/ic/replayer.nim` | ICリプレイでのerror処理（35行目） |

**主要処理フロー**:
1. **1139-1144行目**: {.error.}プラグマ処理でerrUser発行
2. **35行目**: ICリプレイでrecordPragmaの"error"をerrUserとして再発行

#### Step 3: 関連プラグマを理解する

{.error.}プラグマと関連プラグマの処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | pragmas.nim | `compiler/pragmas.nim` | wFatalハンドラ（1145行目） |
| 3-2 | pragmas.nim | `compiler/pragmas.nim` | recordPragma呼び出し（1143行目） |

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

```
nim c (コンパイルコマンド)
    │
    ├─ pragmas.nim::singlePragma
    │      │
    │      └─ case w of wError (1139-1144行目)
    │             │
    │             ├─ 引数なし
    │             │      └─ incl(sym, sfError)
    │             │
    │             └─ 引数あり
    │                    │
    │                    ├─ expectStrLit(c, it)
    │                    │
    │                    ├─ recordPragma(c, it, "error", s)
    │                    │
    │                    └─ localError(c.config, it.info, errUser, s)
    │
    └─ ic/replayer.nim::replayPragmas
           │
           └─ case "error" (35行目)
                  │
                  └─ localError(g.config, n.info, errUser, n[1].strVal)
```

### データフロー図

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

Nimソースファイル ───▶ pragmas.nim::singlePragma ───▶ プラグマ解析
("{.error: "msg".}")           │
                               ▼
                         wErrorケース処理
                               │
                               ▼
                         expectStrLit (文字列取得)
                               │
                               ▼
                         recordPragma (IC用記録)
                               │
                               ▼
                         localError(errUser, s)
                               │
                               ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| pragmas.nim | `compiler/pragmas.nim` | ソース | プラグマ処理、{.error.}ハンドラ |
| ic/replayer.nim | `compiler/ic/replayer.nim` | ソース | インクリメンタルコンパイルリプレイ |
| msgs.nim | `compiler/msgs.nim` | ソース | コンパイラメッセージシステム |
| docgen.nim | `compiler/docgen.nim` | ソース | runnableExamplesでerrUser使用 |
