# 通知設計書 111-hintDependency

## 概要

本ドキュメントは、Nimコンパイラにおける`hintDependency`（依存関係ヒント）通知の設計について記述する。

### 本通知の処理概要

`hintDependency`は、コンパイル時に外部動的ライブラリへの依存関係が検出された際に、開発者に情報を提供するためのヒント通知である。

**業務上の目的・背景**：Nimプログラムが外部の動的ライブラリ（DLL、so、dylibなど）に依存している場合、その依存関係を明確にすることで、デプロイ時やデバッグ時に必要なライブラリを把握できるようにする。特にFFI（Foreign Function Interface）を使用する際に重要となる。

**通知の送信タイミング**：コード生成フェーズ（cgen）において、動的ライブラリをロードする処理が生成される際に送信される。具体的には、`{.dynlib.}`プラグマが指定されたプロシージャが使用される場合にトリガーされる。

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

**通知内容の概要**：依存している動的ライブラリのパス（名前）が通知される。フォーマットは`$1`で、ライブラリパスがそのまま出力される。

**期待されるアクション**：開発者は通知された依存ライブラリが実行環境に存在することを確認し、必要に応じてデプロイ計画に含める。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラの標準出力または標準エラー出力へ送信。`--verbosity`オプションの設定により制御される。verbosity レベル1以下ではデフォルトで無効化されている。

## 通知テンプレート

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

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

### 本文テンプレート

```
Hint: {ライブラリパス} [Dependency]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 依存ライブラリのパス | lib.path.strVal | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コード生成 | 動的ライブラリロード処理生成 | lib.path.kind in {nkStrLit..nkTripleStrLit} | 文字列リテラルでライブラリパスが指定された場合 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[dynlibプラグマ検出] --> B[loadDynamicLib関数呼び出し]
    B --> C{lib.path.kind確認}
    C -->|文字列リテラル| D[libCandidates関数でパス候補取得]
    D --> E[rawMessage hintDependency発行]
    E --> F[動的ライブラリロードコード生成]
    C -->|その他| G[式評価後ロード]
    F --> H[終了]
    G --> H
```

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

### 参照テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

ライブラリパスには機密情報が含まれる可能性があるため、ログ出力やCI/CD環境での取り扱いに注意が必要。

## 備考

- verbosity レベル2以上で有効になる
- `--hint:Dependency:on/off`オプションで個別に制御可能

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: TMsgKind列挙型は通知種別の定義元。MsgKindToStrは各通知のメッセージフォーマットを定義している。

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

処理の起点となるコード生成処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | cgen.nim | `compiler/cgen.nim` | loadDynamicLib関数（905-954行目付近）、rawMessage呼び出し（912行目） |

**主要処理フロー**:
1. **905行目**: loadDynamicLib関数開始、ライブラリ名の設定
2. **909行目**: lib.path.kindの確認（文字列リテラルかどうか）
3. **911行目**: libCandidates関数でライブラリパス候補を取得
4. **912行目**: `rawMessage(m.config, hintDependency, lib.path.strVal)`でヒント発行

#### Step 3: メッセージ処理層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | rawMessageテンプレート（610-615行目）、liMessage関数（536-608行目） |

**主要処理フロー**:
- **610-612行目**: rawMessageテンプレートがliMessageを呼び出す
- **574-583行目**: ヒントの場合の処理分岐

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

```
loadDynamicLib (cgen.nim:905)
    │
    ├─ libCandidates (ライブラリパス候補取得)
    │
    └─ rawMessage (msgs.nim:610)
           └─ liMessage (msgs.nim:536)
                  └─ styledMsgWriteln (メッセージ出力)
```

### データフロー図

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

{.dynlib.}プラグマ ───▶ loadDynamicLib ───▶ コンソール出力
       │                      │                 "Hint: xxx [Dependency]"
       │                      │
lib.path.strVal ─────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ送信処理 |
| cgen.nim | `compiler/cgen.nim` | ソース | コード生成、動的ライブラリロード処理 |
| options.nim | `compiler/options.nim` | ソース | verbosity設定、NotesVerbosity定義 |
