# 通知設計書 119-hintUserRaw

## 概要

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

### 本通知の処理概要

`hintUserRaw`は、ユーザーが生成したヒントメッセージを、通常のヒントタグ([User])なしで出力するための通知である。hintUserとは異なり、メッセージの種類を示すタグが付加されないため、よりクリーンな出力が得られる。

**業務上の目的・背景**：特定のコンパイラ機能（アセンブリ出力、Macアプリバンドル作成、オーバーロード解決のデバッグなど）において、ユーザーに情報を提供する際に、標準のヒントタグを付けずにメッセージを出力したい場合に使用される。hintUserと違い、内部的なコンパイラ機能からの情報提供に使用されることが多い。

**通知の送信タイミング**：以下のケースで送信される：
1. アセンブリファイル生成時（extccomp.nim）
2. Macアプリバンドル作成時（extccomp.nim）
3. オーバーロード解決のexplainモード時（semcall.nim）

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

**通知内容の概要**：コンパイラ内部機能からの情報メッセージが、タグなしで通知される。

**期待されるアクション**：開発者は出力されたメッセージを確認し、アセンブリファイルの場所やバンドルの作成結果などの情報を把握する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラの標準出力または標準エラー出力へ送信。hintUserRawの特徴として、メッセージ種類タグ([UserRaw])が出力に付加されない。

## 通知テンプレート

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

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

### 本文テンプレート

```
Hint: {メッセージ}
```

注：通常のヒントとは異なり、[UserRaw]タグは付加されない。

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 情報メッセージ | 動的生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| アセンブリ生成 | getCompileCFileCmd | optProduceAsm in conf.globalOptions && produceOutput | アセンブリファイル生成時 |
| バンドル作成 | createAppBundle | 常に | Macアプリバンドル作成完了時 |
| オーバーロード解決 | semOverloadedCall | errors.len > 0 && r.state == csMatch | explainモード時のマッチング情報 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル処理] --> B{メッセージ発行元?}
    B -->|アセンブリ| C[extccomp.nim getCompileCFileCmd]
    B -->|バンドル| D[extccomp.nim createAppBundle]
    B -->|オーバーロード| E[semcall.nim semOverloadedCall]
    C --> F[rawMessage hintUserRaw発行]
    D --> F
    E --> G[message hintUserRaw発行]
    F --> H[終了]
    G --> H
```

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

### 参照テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

ファイルパス情報が出力される場合があるため、CI/CDログの公開時には注意が必要。

## 備考

- hintUserとの違い：hintUserRawは[User]タグが付加されない（msgs.nim:550で特別扱い）
- rawMessage関数経由での発行が主
- `--hint:UserRaw:on/off`オプションで個別に制御可能

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: hintUserRawは"$1"テンプレートを持つが、msgs.nimで特別扱いされ、タグが付加されない。

#### Step 2: 特別扱いの処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | liMessage関数でのhintUserRaw特別扱い（550行目） |

**主要処理フロー**:
- **550行目**: `let kind = if msg in warnMin..hintMax and msg != hintUserRaw: $msg else: ""`でタグを空にする

#### Step 3: アセンブリ出力での使用を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | extccomp.nim | `compiler/extccomp.nim` | getCompileCFileCmd関数（649-654行目）、createAppBundle関数（864行目） |

**主要処理フロー**:
- **650行目**: `rawMessage(conf, hintUserRaw, "Produced assembler here: " & asmfile)`
- **653行目**: `rawMessage(conf, hintUserRaw, "Couldn't produce assembler listing...")`
- **864行目**: `rawMessage(conf, hintUserRaw, "Created Mac app bundle: " & appBundlePath)`

#### Step 4: オーバーロード解決での使用を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | semcall.nim | `compiler/semcall.nim` | semOverloadedCall関数（924-926行目） |

**主要処理フロー**:
- **924-926行目**: explainモード時に非マッチング候補の情報を出力

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

```
コンパイル処理
    │
    ├─ C/C++コンパイル (extccomp.nim)
    │      │
    │      ├─ getCompileCFileCmd
    │      │      └─ rawMessage(hintUserRaw)
    │      │
    │      └─ createAppBundle
    │             └─ rawMessage(hintUserRaw)
    │
    └─ オーバーロード解決 (semcall.nim)
           │
           └─ semOverloadedCall
                  └─ message(hintUserRaw)
```

### データフロー図

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

--asm オプション ───────▶ extccomp.nim ─────────▶ ヒント出力
                                                 "Produced assembler..."

Mac build ──────────────▶ createAppBundle ─────▶ ヒント出力
                                                 "Created Mac app bundle..."

{.explain.}プラグマ ───▶ semcall.nim ───────────▶ ヒント出力
                                                 "Non-matching candidates..."
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート |
| msgs.nim | `compiler/msgs.nim` | ソース | liMessage関数でのhintUserRaw特別扱い |
| extccomp.nim | `compiler/extccomp.nim` | ソース | アセンブリ出力、Macバンドル作成 |
| semcall.nim | `compiler/semcall.nim` | ソース | オーバーロード解決のexplainモード |
