# 通知設計書 112-hintSource

## 概要

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

### 本通知の処理概要

`hintSource`は、エラーや警告メッセージと共に該当するソースコード行を表示するためのヒント通知である。エラーメッセージの文脈を理解しやすくするための補助情報として機能する。

**業務上の目的・背景**：コンパイルエラーや警告が発生した際、該当箇所のソースコードを直接表示することで、開発者が問題箇所を素早く特定し、修正作業を効率化できるようにする。IDEを使用していない環境やCLI環境でのデバッグ作業において特に有用である。

**通知の送信タイミング**：エラー、警告、またはヒントメッセージが出力される際に、関連するソースコード行も同時に表示される。`getSurroundingSrc`関数を通じて、メッセージ出力の一部として送信される。

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

**通知内容の概要**：問題が発生したソースコードの該当行と、その位置を示すキャレット（^）マーカーが表示される。

**期待されるアクション**：開発者は表示されたソースコードを確認し、エラーや警告の原因を特定して修正を行う。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラの標準出力または標準エラー出力へ送信。他のメッセージ（エラー、警告、ヒント）の付随情報として出力される。verbosity レベル1以下ではデフォルトで無効化されている。

## 通知テンプレート

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

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

### 本文テンプレート

```
  {ソースコード行}
  {スペース}{^キャレット}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | ソースコード情報 | sourceLine(conf, info) | Yes |
| col | カラム位置 | info.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| メッセージ出力 | liMessage関数呼び出し | conf.hasHint(hintSource) && info != unknownLineInfo | ヒントが有効で位置情報がある場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| verbosity <= 1 | デフォルトのverbosityレベルでは抑止 |
| hintSource not in conf.notes | ヒントが無効化されている場合 |
| info == unknownLineInfo | 位置情報が不明な場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[liMessage関数呼び出し] --> B{hintSource有効?}
    B -->|Yes| C{info != unknownLineInfo?}
    B -->|No| G[ソース表示なし]
    C -->|Yes| D[getSurroundingSrc呼び出し]
    C -->|No| G
    D --> E[sourceLine取得]
    E --> F[インデント付きソース + キャレット出力]
    F --> H[終了]
    G --> H
```

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

### 参照テーブル一覧

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

### 参照項目詳細

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| conf.m.fileInfos[].lines | ソースコード行の取得 | fileIndex, line番号で指定 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル読み込み失敗 | ソースファイルが読み込めない | 空文字列を返す |
| 行番号範囲外 | 指定行がファイル行数を超える | 空文字列を返す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

ソースコードが出力されるため、機密性の高いコードを扱う場合はログ出力の取り扱いに注意が必要。

## 備考

- verbosity レベル2以上で有効になる
- `--hint:Source:on/off`オプションで個別に制御可能
- options.nimのhasHint関数で「hintSourceも特別な扱いが可能」とコメントされている

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: hintSourceは"$1"テンプレートを持つが、実際にはgetSurroundingSrc関数で特別な処理がされる。

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

処理の起点となるメッセージ出力処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | getSurroundingSrc関数（520-527行目）、liMessage関数での呼び出し（596-597行目） |

**主要処理フロー**:
1. **520行目**: getSurroundingSrc関数開始
2. **521行目**: `conf.hasHint(hintSource) and info != unknownLineInfo`の条件確認
3. **523行目**: sourceLine(conf, info)でソースコード取得
4. **524-525行目**: キャレット位置の計算と出力
5. **596-597行目**: styledMsgWritelnでメッセージと共に出力

#### Step 3: ソースコード取得処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | sourceLine関数（510-518行目）、numLines関数（498-508行目） |

**主要処理フロー**:
- **510-518行目**: ファイルインデックスと行番号から該当行を取得
- **498-508行目**: 必要に応じてファイルを読み込みキャッシュ

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

```
liMessage (msgs.nim:536)
    │
    ├─ getSurroundingSrc (msgs.nim:520)
    │      │
    │      └─ sourceLine (msgs.nim:510)
    │             └─ numLines (msgs.nim:498)
    │
    └─ styledMsgWriteln (メッセージ出力)
```

### データフロー図

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

TLineInfo ─────────────▶ getSurroundingSrc ───▶ インデント付きソース
    │                          │                 + キャレットマーカー
    │                          │
fileIndex, line ──────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ送信処理、getSurroundingSrc関数 |
| options.nim | `compiler/options.nim` | ソース | hasHint関数、hintSourceの特別扱いコメント（490行目） |
