# 通知設計書 114-hintStackTrace

## 概要

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

### 本通知の処理概要

`hintStackTrace`は、致命的エラー発生時やコンパイラ内部エラー発生時にスタックトレース情報の出力を制御するためのヒント通知である。デバッグビルドや明示的な有効化時に、エラー発生箇所のコールスタック情報を提供する。

**業務上の目的・背景**：コンパイラのバグ報告やデバッグ作業において、エラー発生時の呼び出し履歴を把握することは問題の特定に不可欠である。このヒントを有効にすることで、コンパイラ開発者やバグ報告者がより詳細な診断情報を得ることができる。

**通知の送信タイミング**：コンパイラがquit関数を呼び出す際（致命的エラー、内部エラー発生時）に、スタックトレースの出力要否を判定するために使用される。

**通知の受信者**：コンパイルを実行している開発者またはコンパイラ開発者。コンソール出力経由でスタックトレースを受け取る。

**通知内容の概要**：スタックトレース情報（関数呼び出し履歴）が出力される。

**期待されるアクション**：開発者はスタックトレースを分析し、エラーの原因を特定する。バグ報告時には、このスタックトレースを含めることで、問題の再現と修正が容易になる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラの標準出力または標準エラー出力へ送信。verbosity レベル2以下ではデフォルトで無効化されている。デバッグビルドでは常に有効。

## 通知テンプレート

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

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

### 本文テンプレート

```
{スタックトレース情報}
```

または、スタックトレースが利用不可の場合：

```
No stack traceback available
To create a stacktrace, rerun compilation with './koch temp $1 <file>', see {ドキュメントURL} for details
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | スタックトレースまたはメッセージ | writeStackTrace() / 動的生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| エラー処理 | quit関数呼び出し | defined(debug) or msg == errInternal or conf.hasHint(hintStackTrace) | 致命的エラー発生時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| verbosity <= 2 | デフォルトのverbosityレベル2以下では抑止 |
| hintStackTrace not in conf.notes | ヒントが無効化されている場合 |
| リリースビルド | defined(debug)がfalseの場合（明示的有効化が必要） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[quit関数呼び出し] --> B{nimDebug定義?}
    B -->|Yes| C[quitOrRaise呼び出し]
    B -->|No| D{debug or errInternal or hasHint?}
    D -->|Yes| E{stackTraceAvailable?}
    D -->|No| I[通常終了]
    E -->|Yes| F[writeStackTrace呼び出し]
    E -->|No| G[スタックトレース不可メッセージ出力]
    F --> H[quit 1]
    G --> H
    C --> H
    I --> H
```

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

### 参照テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| スタックトレース不可 | リリースビルドなど | 代替メッセージを表示 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（終了時のみ発生） |

### 配信時間帯

制限なし

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

スタックトレースには内部的な関数名やファイルパスが含まれるため、本番環境でのログ公開時には注意が必要。

## 備考

- verbosity レベル3で有効になる
- `--hint:StackTrace:on/off`オプションで個別に制御可能
- デバッグビルド（`-d:debug`）では自動的に有効
- errInternal発生時は常に有効

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: hintStackTraceは"$1"テンプレートを持ち、スタックトレース情報またはメッセージがそのまま出力される。

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

処理の起点となるquit関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | msgs.nim | `compiler/msgs.nim` | quit関数（432-443行目）、hasHint(hintStackTrace)の条件確認（434行目） |

**主要処理フロー**:
1. **432行目**: quit関数開始
2. **433行目**: `conf.isDefined("nimDebug")`の確認
3. **434行目**: `defined(debug) or msg == errInternal or conf.hasHint(hintStackTrace)`の条件確認
4. **436行目**: `stackTraceAvailable()`の確認
5. **437行目**: `writeStackTrace()`でスタックトレース出力
6. **439-442行目**: スタックトレース不可時の代替メッセージ

#### Step 3: verbosity設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lineinfos.nim | `compiler/lineinfos.nim` | computeNotesVerbosity関数（263-271行目）、レベル2からhintStackTraceを除外（266行目） |

**主要処理フロー**:
- **266行目**: result[2]からhintStackTraceを除外（つまりレベル3以上で有効）

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

```
handleError (msgs.nim:445)
    │
    └─ quit (msgs.nim:432)
           │
           ├─ quitOrRaise (nimDebug時)
           │
           └─ stackTraceAvailable()
                  │
                  ├─ writeStackTrace() [available]
                  │
                  └─ styledMsgWriteln (代替メッセージ) [not available]
```

### データフロー図

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

致命的エラー ──────────▶ quit ─────────────▶ スタックトレース
内部エラー                  │                    または
                           │                 代替メッセージ
                           │
hasHint(hintStackTrace) ───┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート、verbosity設定 |
| msgs.nim | `compiler/msgs.nim` | ソース | quit関数、スタックトレース出力処理 |
| options.nim | `compiler/options.nim` | ソース | hasHint関数 |
