# 通知設計書 1-doom-debug-mode通知

## 概要

本ドキュメントは、Doom Emacsにおける`doom-debug-mode`通知機能の設計を記載する。この通知は、デバッグモードの有効化・無効化時にユーザーに状態を通知する機能である。

### 本通知の処理概要

doom-debug-mode通知は、Doom Emacsのデバッグモード状態変更をユーザーに伝えるためのシステム通知機能である。

**業務上の目的・背景**：開発者やパワーユーザーがDoom Emacsの内部動作をデバッグする際、デバッグモードの状態を明確に把握する必要がある。この通知により、現在のデバッグレベルと、詳細なログ出力が有効になっていることをユーザーが即座に認識できる。特に問題診断時に、デバッグモードが正しく有効化されているかを確認するために重要である。

**通知の送信タイミング**：`doom-debug-mode`がトグルされた時点で即座に通知が送信される。具体的には、`M-x doom-debug-mode`コマンドの実行時、または`(doom-debug-mode +1)`/`(doom-debug-mode -1)`がプログラムから呼び出された時に発動する。

**通知の受信者**：Emacsを操作している現在のユーザー。ミニバッファ/エコーエリアへのメッセージとして表示される。

**通知内容の概要**：デバッグモードの有効化時には「Debug mode level N enabled! (Run 'M-x view-echo-area-messages' to open the log buffer)」というメッセージが表示される。無効化時には「Debug mode disabled!」と表示される。Nは現在のログレベル（1-3）を示す。

**期待されるアクション**：ユーザーは通知を確認後、必要に応じて`*Messages*`バッファを確認してデバッグログを参照する。問題が解決したらデバッグモードを無効化する。

## 通知種別

アプリ内通知（Emacsエコーエリア/ミニバッファ）

## 送信仕様

### 基本情報

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

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

現在のEmacsフレームのエコーエリアに直接表示。マルチフレーム環境では、`doom-debug-mode`がグローバルマイナーモードであるため、全フレームのモードラインに反映される。

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| 表示先 | エコーエリア（ミニバッファ） |
| 形式 | プレーンテキスト |

### 本文テンプレート

```
Debug mode level %d enabled! (Run 'M-x view-echo-area-messages' to open the log buffer)
```

または

```
Debug mode disabled!
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| doom-log-level | 現在のログレベル（1-3） | doom-log-level変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | doom-debug-modeコマンド | 常に送信 | M-x doom-debug-mode実行時 |
| プログラム呼び出し | (doom-debug-mode +1/-1) | 対話モード時のみ | Lispコードからの呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| noninteractive | バッチモード時は通知を抑止 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[doom-debug-modeトグル] --> B{doom-debug-mode有効?}
    B -->|Yes| C[doom-log-level設定]
    C --> D[doom-debug--variables設定]
    D --> E{noninteractive?}
    E -->|No| F[有効化メッセージ表示]
    E -->|Yes| G[メッセージ抑止]
    B -->|No| H[変数リセット]
    H --> I[無効化メッセージ表示]
    F --> J[終了]
    G --> J
    I --> J
```

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

### 参照テーブル一覧

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

### 変数参照詳細

| 変数名 | 用途 | 取得条件 |
|--------|------|---------|
| doom-debug-mode | モード状態 | 常時参照可能 |
| doom-log-level | ログレベル | doom-debug-mode有効時に1-3の値 |
| doom-debug--variables | デバッグ変数リスト | 内部管理用 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | メッセージ表示は失敗しない設計 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | ユーザー操作に応じて即座に表示 |

### 配信時間帯

制限なし

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

- デバッグモードはシステム内部情報を`*Messages*`バッファに出力するため、機密情報が含まれる可能性がある
- デバッグ出力はローカルバッファにのみ記録され、外部送信されない

## 備考

- ログレベルは`current-prefix-arg`で指定可能（C-u 2 M-x doom-debug-mode で level 2）
- レベル3は最も詳細なデバッグ情報を出力

---

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

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

### 推奨読解順序

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

doom-debug-modeに関連する変数定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | debug.el | `lisp/lib/debug.el` | doom-debug--variables変数定義（9-26行目）を確認 |
| 1-2 | doom-lib.el | `lisp/doom-lib.el` | doom-log-level変数定義（41-54行目）を確認 |

**読解のコツ**: Emacs Lispの`defvar`でグローバル変数を定義。`alist`形式でデバッグ変数とその値を管理している。

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

doom-debug-modeコマンドの定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | debug.el | `lisp/lib/debug.el` | doom-debug-mode定義（83-123行目）を確認 |

**主要処理フロー**:
1. **83行目**: `define-minor-mode doom-debug-mode`でマイナーモード定義
2. **86-92行目**: モード有効化時のdoom-log-level設定
3. **93行目**: デバッグログ出力
4. **94行目**: デバッグ変数の設定
5. **98-107行目**: 有効化時のadvice追加とフック設定
6. **113-123行目**: 無効化時のクリーンアップとメッセージ表示

#### Step 3: 変数設定処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | debug.el | `lisp/lib/debug.el` | doom-debug--set-var関数（41-57行目）を確認 |

**主要処理フロー**:
- **42-52行目**: リスト形式のspec処理、変数値の設定/復元
- **54-57行目**: シンボル形式のspec処理

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

```
doom-debug-mode (コマンド)
    |
    +-- doom-debug--set-var (各デバッグ変数の設定)
    |       |
    |       +-- set-default (Emacs組み込み)
    |       +-- set-default-toplevel-value (Emacs組み込み)
    |
    +-- advice-add #'run-hooks #'doom-run-hooks
    |
    +-- advice-add #'message #'doom-debug--timestamped-message-a
    |
    +-- message (通知表示)
```

### データフロー図

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

current-prefix-arg ──▶ doom-debug-mode ──▶ エコーエリアメッセージ
                            │
                            ├──▶ doom-log-level設定
                            │
                            └──▶ doom-debug--variables反映
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| debug.el | `lisp/lib/debug.el` | ソース | doom-debug-modeのメイン実装 |
| doom-lib.el | `lisp/doom-lib.el` | ソース | doom-log関連の定義 |
| doom.el | `lisp/doom.el` | ソース | 初期化時のdoom-debug-mode呼び出し |
