# 通知設計書 91-hintCC

## 概要

本ドキュメントは、Nimコンパイラにおけるヒント通知「hintCC」の設計を記載する。この通知はCコンパイラの呼び出し状況をユーザーに通知するためのものである。

### 本通知の処理概要

hintCC（CC: $1）は、Nimコンパイラがバックエンドで使用するCコンパイラを呼び出す際に、そのコンパイル処理の進捗状況をユーザーに通知するヒントメッセージである。

**業務上の目的・背景**：Nimコンパイラは中間コードとしてC言語コードを生成し、最終的にCコンパイラ（gcc、clang、vccなど）を呼び出して実行可能バイナリを生成する。この通知により、開発者はどのCファイルがコンパイルされているかをリアルタイムで把握でき、ビルドの進捗状況を確認できる。これは特に大規模なプロジェクトにおいて、ビルド時間の長さの原因特定やビルドプロセスの透明性確保に役立つ。

**通知の送信タイミング**：各Cファイルのコンパイルコマンドが実行される直前に送信される。Nimソースファイルから生成された.cファイルごとに、対応するCコンパイラの呼び出しが行われる際に通知が発行される。

**通知の受信者**：コンパイルを実行している開発者。標準出力（stderr）を通じて通知される。

**通知内容の概要**：「CC: {モジュール名}」の形式で、現在コンパイル中のモジュール（ファイル）名が通知される。オプションにより詳細なコンパイルコマンドも表示可能。

**期待されるアクション**：通常は情報提供のみで、アクション不要。ビルド進捗の確認やデバッグ時の参照情報として利用される。

## 通知種別

コンパイラコンソール出力（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（ヒント） |
| リトライ | 無 |

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

コンパイラを実行しているプロセスの標準エラー出力に直接出力される。verbosityレベルおよび`--hint:CC:on/off`オプションにより制御される。

## 通知テンプレート

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

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

### 本文テンプレート

```
CC: モジュール名
```

詳細モード（`--listCmd`または`verbosity > 1`）の場合：
```
CC: モジュール名: コンパイルコマンド全体
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | モジュール名（コンパイルコマンド） | Cfile.cname | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | Cファイルコンパイル実行前 | hintCC in conf.notes | 各Cファイルのコンパイル直前に発行 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--hint:CC:off` | ヒントを明示的にオフにした場合 |
| verbosity = 0 | 最小出力モードの場合 |
| optHints notin conf.options | ヒント全体が無効の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[callCCompiler開始] --> B[toCompileリストを反復]
    B --> C{キャッシュ済み?}
    C -->|Yes| B
    C -->|No| D[getCompileCFileCmd実行]
    D --> E[displayProgressCC呼び出し]
    E --> F{hintCC有効?}
    F -->|Yes| G[メッセージ生成]
    F -->|No| H[空文字列返却]
    G --> I{verbosity > 1 or listCmd?}
    I -->|Yes| J[モジュール名: コマンド全体]
    I -->|No| K[モジュール名のみ]
    J --> L[stderrに出力]
    K --> L
    L --> M[コンパイル実行]
    M --> B
    H --> M
```

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

### 参照テーブル一覧

コンパイラメッセージングシステムのため、データベースは使用しない。

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | stderr書き込みエラー | 処理継続（無視） |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

機密情報を含まない。ファイルパスが表示されるが、ローカル開発環境での使用が前提であり、特別なセキュリティ対策は不要。

## 備考

- verbosityレベル0では出力されない
- `--processing:dots`オプションでドット表示モードに切り替え可能
- 並列コンパイル時は複数のCCメッセージが混在して表示される可能性あり

---

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

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

### 推奨読解順序

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

まず、通知メッセージの定義とCファイル情報のデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintCCの定義（104行目）とメッセージテンプレート（214行目）を確認 |
| 1-2 | options.nim | `compiler/options.nim` | ConfigRefの構造とverbosity設定を理解 |

**読解のコツ**: TMsgKind enumの定義を確認し、hintCCがヒントカテゴリに属することを把握する。

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

処理の起点となるCコンパイラ呼び出し処理を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | extccomp.nim | `compiler/extccomp.nim` | callCCompilerプロシージャがエントリーポイント |

**主要処理フロー**:
1. **971行目**: callCCompiler開始
2. **984-994行目**: toCompileリストの反復処理
3. **990行目**: displayProgressCC呼び出しでメッセージ生成

#### Step 3: メッセージ生成ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | extccomp.nim | `compiler/extccomp.nim` | displayProgressCCプロシージャ（949-955行目） |
| 3-2 | msgs.nim | `compiler/msgs.nim` | rawMessage関数によるメッセージ出力 |

**主要処理フロー**:
- **949-955行目**: displayProgressCC関数でメッセージ文字列を生成
- **951行目**: hasHint(hintCC)でヒント有効性チェック
- **952-953行目**: verbosityに応じた出力形式の決定

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

```
callCCompiler (extccomp.nim:971)
    │
    ├─ getCompileCFileCmd (extccomp.nim:579)
    │      └─ コンパイルコマンド文字列生成
    │
    ├─ displayProgressCC (extccomp.nim:949)
    │      ├─ hasHint (options.nim)
    │      └─ MsgKindToStr[hintCC] (lineinfos.nim)
    │
    └─ execCmdsInParallel (extccomp.nim:877)
           └─ prettyCb (コールバック関数)
                  └─ writePrettyCmdsStderr
```

### データフロー図

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

Cfile構造体 ───▶ displayProgressCC ───▶ stderr
  │                    │
  ├─ cname             ├─ demangleModuleName
  │                    ├─ hasHint確認
  └─ nimname           └─ メッセージフォーマット
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | hintCC定義とメッセージテンプレート |
| extccomp.nim | `compiler/extccomp.nim` | ソース | Cコンパイラ呼び出しとメッセージ出力 |
| options.nim | `compiler/options.nim` | ソース | コンパイラオプションとverbosity管理 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
