# 通知設計書 86-warnUser

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnUser」（ユーザー定義警告）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、ユーザーが `{.warning: "メッセージ".}` プラグマを使用してカスタム警告メッセージを出力するための機能である。コンパイル時にユーザー定義のメッセージを表示し、開発者間のコミュニケーションやコードの注意点の通知に使用される。

**業務上の目的・背景**：開発プロジェクトでは、コードの特定部分に注意を促したり、一時的な回避策を使用していることを示したり、将来の改善が必要な箇所をマークしたりする必要がある。`{.warning.}` プラグマを使用することで、コンパイル時にこれらのメッセージを表示し、開発者の注意を引くことができる。TODOコメントとは異なり、コンパイル時に必ず表示されるため、見落としを防止できる。

**通知の送信タイミング**：プラグマ処理フェーズ（pragmas.nim内）において、`{.warning: "メッセージ".}` プラグマを検出した時点で発行される。また、コンパイラ内部の複数箇所でも使用されている（reorder.nim、hlo.nim、vm.nimなど）。

**通知の受信者**：コンパイルを実行している開発者。ターミナルまたはIDEの出力ウィンドウに表示される。

**通知内容の概要**：プラグマで指定されたユーザー定義のメッセージがそのまま表示される。

**期待されるアクション**：開発者は警告メッセージを確認し、必要に応じて対処を行う。メッセージの内容に応じて、コードの修正、確認、または将来のタスクとして記録することが期待される。

## 通知種別

コンパイラ警告（Warning） - ターミナル/IDE出力

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に出力） |
| 優先度 | 中（Warning） |
| リトライ | なし |

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

コンパイラの標準エラー出力（stderr）または設定されたwritelnHookに出力される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

### コンパイラ出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: {ユーザー定義メッセージ} [User]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | ユーザー定義メッセージ | プラグマの文字列引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プラグマ処理 | {.warning: "msg".}プラグマ検出 | 常に発行 | pragmas.nim内でのプラグマ処理時 |
| コンパイラ内部 | 特定条件検出 | 内部ロジックによる | reorder.nim、hlo.nim、vm.nimなど |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:User:off | コマンドラインオプションで抑制可能 |
| {.warning[User]:off.} | プラグマで抑制可能 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[プラグマ解析] --> B{wWarningプラグマ?}
    B -->|No| C[他のプラグマ処理]
    B -->|Yes| D[メッセージ文字列を取得]
    D --> E[recordPragma呼び出し]
    E --> F[message関数呼び出し]
    F --> G[styledMsgWriteln出力]
    G --> H[処理継続]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

### 更新テーブル一覧

本通知はデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | この警告自体はエラーではない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

なし。コンパイラ警告メッセージであり、ユーザー定義のメッセージが表示される。

## 備考

- 警告IDは "User"
- `{.hint: "msg".}` と対になるユーザー定義警告機能
- コンパイラ内部でも使用されている（循環インポート検出、マクロ展開深度制限など）
- --styleCheck時にwarnUserが使用されることがある（msgs.nim 668行目）

---

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

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

### 推奨読解順序

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

警告メッセージの種類と定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnUserの定義（99行目）、MsgKindToStr配列でメッセージテンプレート（208行目）を確認 |

**読解のコツ**: メッセージテンプレートは "$1" であり、ユーザー定義のメッセージがそのまま出力される。

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

警告が発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pragmas.nim | `compiler/pragmas.nim` | 1128-1131行目でwWarningプラグマを処理し、message関数を呼び出す |

**主要処理フロー**:
1. **1129行目**: expectStrLitでメッセージ文字列を取得
2. **1130行目**: recordPragmaでプラグマを記録
3. **1131行目**: message関数呼び出しでwarnUserを出力

#### Step 3: コンパイラ内部での使用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | reorder.nim | `compiler/reorder.nim` | 212行目で循環インポート検出時にwarnUserを使用 |
| 3-2 | hlo.nim | `compiler/hlo.nim` | 67行目でマクロ展開深度超過時にwarnUserを使用 |
| 3-3 | vm.nim | `compiler/vm.nim` | 1984行目でVM実行中の警告にwarnUserを使用 |

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

```
pragmas.nim: singlePragma (プラグマ処理)
    │
    ├─ pragmas.nim: expectStrLit (文字列取得)
    │
    ├─ pragmas.nim: recordPragma (プラグマ記録)
    │
    └─ msgs.nim: message (警告発行)
           │
           └─ msgs.nim: liMessage (メッセージ処理)
```

### データフロー図

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

{.warning: "msg".} ───▶ pragmas.nim ───▶ 文字列抽出
    プラグマ             singlePragma         │
                                              ▼
                                       msgs.nim ───▶ stderr/stdout
                                    (message関数)     (警告メッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義とメッセージテンプレート |
| pragmas.nim | `compiler/pragmas.nim` | ソース | プラグマ処理、警告発行トリガー |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| reorder.nim | `compiler/reorder.nim` | ソース | インポート順序処理（warnUser使用） |
| hlo.nim | `compiler/hlo.nim` | ソース | 高レベル最適化（warnUser使用） |
| vm.nim | `compiler/vm.nim` | ソース | 仮想マシン実行（warnUser使用） |
| options.nim | `compiler/options.nim` | ソース | foreignPackageNotesにwarnUserを含む（549行目） |
