# 通知設計書 3-doom-hook-error警告

## 概要

本ドキュメントは、Doom Emacsにおける`doom-hook-error`警告通知機能の設計を記載する。この通知は、フック実行時にエラーが発生した場合に`lwarn`で警告を表示する機能である。

### 本通知の処理概要

doom-hook-error警告は、Emacsのフック関数実行中に発生したエラーを捕捉し、ユーザーに視認性の高い警告として通知する機能である。

**業務上の目的・背景**：Emacsのフックシステムは、特定のイベント発生時に複数の関数を実行する仕組みだが、フック関数内でエラーが発生すると、残りのフック関数が実行されず、問題の特定も困難になる。doom-hook-errorは、エラーを適切に捕捉・報告しながら、可能な限り処理を継続させることで、ユーザー体験の向上と問題診断の効率化を実現する。

**通知の送信タイミング**：`doom-run-hooks`または`doom-run-hook`がフック関数を実行中にエラーを検出した時点で即座に警告が発行される。

**通知の受信者**：Emacsを操作している現在のユーザー。`*Warnings*`バッファへの記録と、必要に応じてポップアップ表示される。

**通知内容の概要**：警告には、エラーが発生したフック名、問題のフック関数名、およびエラーメッセージが含まれる。フォーマットは「Error running hook HOOK-NAME because: ERROR-MESSAGE」。

**期待されるアクション**：ユーザーは警告を確認し、問題のあるフック関数を特定して修正するか、一時的に無効化する。

## 通知種別

アプリ内通知（Emacs警告システム / `*Warnings*`バッファ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | 無 |

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

`lwarn`関数を使用し、`*Warnings*`バッファに記録。警告レベルは`:error`で、重大な問題として表示される。

## 通知テンプレート

### 警告メッセージの場合

| 項目 | 内容 |
|-----|------|
| 表示先 | *Warnings*バッファ / ポップアップ |
| 警告レベル | :error |
| 形式 | テキスト |

### 本文テンプレート

```
Error running hook %S because: %s
```

例：
```
Error running hook doom-after-init-hook because: (void-function my-broken-function)
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| hook | エラーが発生したフック名 | doom--hook変数 / フック引数 | Yes |
| hook-fn | 問題のフック関数名またはシンボル | condition-caseで捕捉 | Yes |
| error | エラーメッセージ | エラーオブジェクト | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| エラー発生 | doom-run-hook内でエラー | doom-hook-errorシグナル | 単一フック関数でのエラー |
| エラー発生 | doom-run-hooks内でエラー | debug-on-error = nil | 複数フック実行中のエラー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| debug-on-error = t | デバッガに制御を渡すため警告を抑止 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[doom-run-hooks呼び出し] --> B[doom-run-hook実行]
    B --> C{エラー発生?}
    C -->|No| D[次のフック関数へ]
    C -->|Yes| E[doom-hook-errorシグナル]
    E --> F{debug-on-error?}
    F -->|Yes| G[デバッガ起動]
    F -->|No| H[lwarnで警告出力]
    H --> I[doom-hook-error再シグナル]
    D --> J{全フック完了?}
    J -->|No| B
    J -->|Yes| K[終了]
    G --> K
    I --> K
```

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

### 参照テーブル一覧

該当なし（Emacs Lisp変数のみ使用）

### 変数参照詳細

| 変数名 | 用途 | 取得条件 |
|--------|------|---------|
| doom--hook | 現在実行中のフック名 | doom-run-hooks内でlet束縛 |
| debug-on-error | デバッグモードフラグ | 常時参照可能 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| doom-hook-error | フック関数内でエラー | lwarnで警告後、元のエラーを再シグナル |
| その他のerror | 予期しないエラー | doom-hook-errorとして包装 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | エラー発生ごとに警告を出力 |

### 配信時間帯

制限なし

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

- 警告メッセージにはフック関数名とエラー内容が含まれる
- 機密情報が含まれる可能性は低いが、内部実装の詳細が露出する
- *Warnings*バッファはローカルのみでアクセス可能

## 備考

- `doom-hook-error`は`doom-error`のサブタイプとして定義されている
- doom-debug-modeが有効な場合、`run-hooks`が`doom-run-hooks`に置き換えられる

---

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

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

### 推奨読解順序

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

エラータイプの定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | doom-lib.el | `lisp/doom-lib.el` | doom-hook-errorの定義（12行目）を確認 |

**読解のコツ**: `define-error`でカスタムエラータイプを定義。`doom-error`を親として継承している。

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

フック実行関数の定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | doom-lib.el | `lisp/doom-lib.el` | doom-run-hook関数（246-255行目）を確認 |
| 2-2 | doom-lib.el | `lisp/doom-lib.el` | doom-run-hooks関数（257-271行目）を確認 |

**主要処理フロー**:
1. **246行目**: `doom-run-hook`定義開始
2. **249行目**: ログ出力
3. **250-253行目**: `condition-case-unless-debug`でエラー捕捉
4. **257行目**: `doom-run-hooks`定義開始
5. **261-263行目**: `doom--hook`変数の設定と`run-hook-wrapped`呼び出し
6. **264-271行目**: `doom-hook-error`の処理とlwarn呼び出し

#### Step 3: 警告出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | doom-lib.el | `lisp/doom-lib.el` | lwarn呼び出し（266-270行目）を確認 |

**主要処理フロー**:
- **265行目**: `unless debug-on-error`でデバッガ優先判定
- **266-270行目**: `lwarn`でエラーレベルの警告を出力
- **271行目**: `doom-hook-error`を再シグナル

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

```
doom-run-hooks (エントリーポイント)
    |
    +-- run-hook-wrapped
            |
            +-- doom-run-hook (各フック関数用)
                    |
                    +-- funcall (フック関数実行)
                    |
                    +-- [エラー発生時]
                            |
                            +-- signal 'doom-hook-error
    |
    +-- [doom-hook-error捕捉]
            |
            +-- lwarn (警告出力)
            |
            +-- signal 'doom-hook-error (再シグナル)
```

### データフロー図

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

hooks ─────────────────┐
                       │
                       ├──▶ doom-run-hooks ──▶ doom-run-hook
                       │           │                │
                       │           │      [エラー発生]
                       │           │                │
                       │           ▼                ▼
                       │    doom-hook-error ◀── signal
                       │           │
                       │           ▼
                       └──▶ lwarn ──▶ *Warnings*バッファ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| doom-lib.el | `lisp/doom-lib.el` | ソース | doom-run-hooks/doom-run-hook/doom-hook-errorの定義 |
| debug.el | `lisp/lib/debug.el` | ソース | doom-debug-modeでrun-hooksをdoom-run-hooksに置換 |
