# 通知設計書 90-hintSuccessX

## 概要

本ドキュメントは、Nimコンパイラのヒント通知「hintSuccessX」（詳細な成功情報ヒント）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、コンパイルが成功した際に詳細なビルド情報を表示するものである。ビルド設定、コード行数、コンパイル時間、メモリ使用量、プロジェクト名、出力ファイル名などの包括的な情報を提供する。

**業務上の目的・背景**：コンパイルが正常に完了した際、開発者はビルドの詳細情報を確認したい場合がある。特にパフォーマンスチューニングやビルド設定の確認において、コンパイル時間、メモリ使用量、最適化設定などの情報は重要である。この詳細ヒントは、これらの情報を一箇所にまとめて表示し、開発者の利便性を向上させる。

**通知の送信タイミング**：コンパイル処理の最終段階（msgs.nim内のgenSuccessX関数）において、コンパイルが正常に完了した時点で発行される。

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

**通知内容の概要**：以下の情報を含む詳細なビルドサマリー：
- ビルド設定（メモリ管理方式、スレッド設定、最適化レベル）
- コンパイルした行数
- コンパイル時間（秒）
- メモリ使用量（ピークまたは合計）
- プロジェクト名
- 出力ファイル名

**期待されるアクション**：特になし。ビルド情報を確認し、必要に応じてビルド設定の調整やパフォーマンス分析に活用する。

## 通知種別

コンパイラヒント（Hint） - ターミナル/IDE出力

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Hint: {ビルド設定}
{行数} lines; {秒数}s; {メモリ}; proj: {プロジェクト名}; out: {出力ファイル} [SuccessX]
```

例：
```
Hint: mm: orc; threads: on; opt: speed; options: -d:release
12345 lines; 1.234s; 128.5MiB peakmem; proj: myproject; out: myproject [SuccessX]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $build | ビルド設定情報 | genSuccessX関数内で構築 | Yes |
| $loc | コンパイル行数 | conf.linesCompiled | Yes |
| ${sec} | コンパイル時間（秒） | epochTime() - conf.lastCmdTime | Yes |
| $mem | メモリ使用量 | getMaxMem() or getTotalMem() | Yes |
| $project | プロジェクト名 | conf.projectFull or conf.projectName | Yes |
| $output | 出力ファイル名 | conf.absOutFile | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル完了 | genSuccessX関数呼び出し | コンパイル成功時 | msgs.nim内 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --hint:SuccessX:off | コマンドラインオプションで抑制可能 |
| {.hint[SuccessX]:off.} | プラグマで抑制可能 |
| 低verbosityレベル | NotesVerbosity[0]から除外 |
| foreignPackageNotes | 外部パッケージコンパイル時に表示 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル完了] --> B[genSuccessX関数呼び出し]
    B --> C[メモリ使用量取得]
    C --> D[コンパイル時間計算]
    D --> E[ビルド設定文字列構築]
    E --> F{バックエンドタイプ?}
    F -->|C/C++| G[mm, threads, opt情報追加]
    F -->|JS| H[opt情報追加]
    G --> I[rawMessage関数呼び出し]
    H --> I
    I --> J[styledMsgWriteln出力]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

なし。コンパイラヒントメッセージであり、ビルド情報のみを含む。

## 備考

- ヒントIDは "SuccessX"
- hintSuccessと対になる詳細版
- NotesVerbosity[0]から除外されている（低verbosity時は非表示）
- testamentのisSuccess関数と同期を保つ必要がある
- foreignPackageNotesに含まれる（530行目）

---

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

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

### 推奨読解順序

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

ヒントメッセージの種類と定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でhintSuccessXの定義（103行目）、MsgKindToStr配列でメッセージテンプレート（213行目）を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | NotesVerbosity計算（270行目）でhintSuccessXがverbosity 0から除外されていることを確認 |

**読解のコツ**: メッセージテンプレートは "$build\n$loc lines; ${sec}s; $mem; proj: $project; out: $output" で、各変数は genSuccessX関数で設定される。

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

ヒントが発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | 690-742行目のgenSuccessX関数で詳細なビルド情報を構築し、rawMessageを呼び出す |

**主要処理フロー**:
1. **691-693行目**: メモリ使用量を取得（getMaxMem または getTotalMem）
2. **694行目**: コンパイル行数を取得
3. **695-718行目**: ビルド設定文字列を構築（mm, threads, opt, options）
4. **719行目**: コンパイル時間を計算
5. **720-732行目**: 出力ファイル名を決定
6. **734-741行目**: rawMessage関数呼び出しで各変数を渡す

#### Step 3: ビルド設定情報の構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | 696-718行目でバックエンド別のビルド設定文字列構築を確認 |

**C/C++バックエンドの場合**:
- mm: メモリ管理方式（selectedGC）
- threads: スレッド設定（on/off）
- opt: 最適化レベル（speed/size/debug）
- options: コンパイルオプション（-d:danger, -d:release）

**JSバックエンドの場合**:
- opt: 最適化レベル（speed/debug）

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

```
(コンパイル完了)
    │
    └─ msgs.nim: genSuccessX (ビルド情報構築)
           │
           ├─ getMaxMem / getTotalMem (メモリ取得)
           │
           ├─ epochTime (時間計算)
           │
           └─ msgs.nim: rawMessage (メッセージ発行)
                  │
                  └─ msgs.nim: liMessage (メッセージ処理)
```

### データフロー図

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

ConfigRef ───▶ genSuccessX ───▶ ビルド情報収集
                                      │
                                      ▼
                               メッセージ構築
                                      │
                                      ▼
                               rawMessage ───▶ stderr/stdout
                                              (詳細ヒント)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | ヒント種別定義とメッセージテンプレート |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理、genSuccessX関数 |
| options.nim | `compiler/options.nim` | ソース | ConfigRef定義（ビルド設定格納） |
| commands.nim | `compiler/commands.nim` | ソース | foreignPackageNotesにhintSuccessXを含む（530行目） |
