# 通知設計書 118-hintUser

## 概要

本ドキュメントは、Nimコンパイラにおける`hintUser`（ユーザー定義ヒント）通知の設計について記述する。

### 本通知の処理概要

`hintUser`は、ユーザーがソースコード内で明示的に定義したヒントメッセージを出力するための通知である。`{.hint: "message".}`プラグマやVM実行時のhint()呼び出しにより発行される。

**業務上の目的・背景**：開発者がコンパイル時に任意のヒントメッセージを出力することで、コンパイル状況の確認、デバッグ情報の出力、条件付きコンパイルの確認などを行えるようにする。ビルドプロセスの可視化やマクロ・テンプレートのデバッグに活用される。

**通知の送信タイミング**：以下の3つのケースで送信される：
1. `{.hint: "message".}`プラグマがパースされた時
2. コンパイル時にVM上でhint()プロシージャが呼び出された時
3. エフェクトシステム（sempass2.nim）でlistEffects関数が呼び出された時

**通知の受信者**：コンパイルを実行している開発者。コンソール出力またはIDE経由でメッセージを受け取る。

**通知内容の概要**：ユーザーが指定した任意のメッセージが通知される。

**期待されるアクション**：開発者は出力されたヒントメッセージを確認し、コンパイル状況やデバッグ情報を把握する。

## 通知種別

コンパイラ出力（コンソール / IDE統合）

## 送信仕様

### 基本情報

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

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

コンパイラの標準出力または標準エラー出力へ送信。デフォルトで有効。foreignPackageNotesDefaultにも含まれる。

## 通知テンプレート

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

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

### 本文テンプレート

```
Hint: {ユーザーメッセージ} [User]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | ユーザー定義メッセージ | プラグマ引数 / hint()引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プラグマ | wHintプラグマ処理 | 常に | {.hint: "msg".}の処理 |
| VM実行 | opcNHint命令 | 常に | コンパイル時hint()呼び出し |
| エフェクト | listEffects関数 | 常に | 例外・タグ・forbidsの列挙 |
| ICリプレイ | replayPragma関数 | 記録されたhintプラグマ | インクリメンタルコンパイル時のリプレイ |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| optHints notin conf.options | ヒント全体が無効化されている場合 |
| hintUser not in conf.notes | ユーザーヒントが無効化されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード解析] --> B{ヒント発行元?}
    B -->|プラグマ| C[pragmas.nim wHint処理]
    B -->|VM| D[vm.nim opcNHint処理]
    B -->|エフェクト| E[sempass2.nim listEffects]
    C --> F[message hintUser発行]
    D --> F
    E --> F
    F --> G[終了]
```

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

### 参照テーブル一覧

該当なし（コンパイラ内部処理のみ）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | このヒント自体はエラーを発生させない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし |

### 配信時間帯

制限なし

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

ユーザーが任意のメッセージを出力できるため、ログ出力時には機密情報が含まれないよう注意が必要。

## 備考

- デフォルトで有効
- `--hint:User:on/off`オプションで個別に制御可能
- foreignPackageNotesDefaultに含まれるため、外部パッケージでも有効
- hintUserとhintUserRawの違い：hintUserRawは[User]タグが付かない

---

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

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

### 推奨読解順序

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

まず、通知の定義と設定について理解する。

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

**読解のコツ**: hintUserは"$1"テンプレートを持ち、ユーザー指定のメッセージがそのまま出力される。

#### Step 2: プラグマ処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pragmas.nim | `compiler/pragmas.nim` | wHintプラグマの処理（1124-1127行目） |

**主要処理フロー**:
1. **1125行目**: expectStrLit(c, it)でメッセージ文字列を取得
2. **1126行目**: recordPragma(c, it, "hint", s)でプラグマを記録
3. **1127行目**: `message(c.config, it.info, hintUser, s)`でヒント発行

#### Step 3: VM処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | vm.nim | `compiler/vm.nim` | opcNHint命令の処理（1985-1986行目） |

**主要処理フロー**:
- **1985行目**: elif instr.opcode == opcNHint
- **1986行目**: `message(c.config, info, hintUser, a.strVal)`でヒント発行

#### Step 4: エフェクト処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | sempass2.nim | `compiler/sempass2.nim` | listEffects関数（514-517行目） |

**主要処理フロー**:
- **515-517行目**: 例外、タグ、forbidsの型を列挙してhintUser発行

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

```
ソースコード解析
    │
    ├─ プラグマ処理 (pragmas.nim)
    │      │
    │      └─ wHint
    │             └─ message(hintUser)
    │
    ├─ VM処理 (vm.nim)
    │      │
    │      └─ opcNHint
    │             └─ message(hintUser)
    │
    └─ エフェクト処理 (sempass2.nim)
           │
           └─ listEffects
                  └─ message(hintUser)
```

### データフロー図

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

{.hint: "msg".} ──────▶ pragmas.nim ───────────▶ ヒント出力
                                                 "Hint: msg [User]"

hint("msg") ───────────▶ vm.nim ───────────────▶ ヒント出力
(コンパイル時)                                    "Hint: msg [User]"

listEffects ───────────▶ sempass2.nim ─────────▶ ヒント出力
                                                 "Hint: TypeName [User]"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート |
| pragmas.nim | `compiler/pragmas.nim` | ソース | {.hint.}プラグマ処理 |
| vm.nim | `compiler/vm.nim` | ソース | VM上でのhint()呼び出し処理 |
| sempass2.nim | `compiler/sempass2.nim` | ソース | listEffects関数 |
| ic/replayer.nim | `compiler/ic/replayer.nim` | ソース | インクリメンタルコンパイル時のリプレイ |
| options.nim | `compiler/options.nim` | ソース | foreignPackageNotesDefault定義 |
