# 通知設計書 6-echo-keystrokes通知

## 概要

本ドキュメントは、Doom Emacsにおける`echo-keystrokes`機能によるキーシーケンス表示機能の設計を記載する。この機能は、ユーザーが入力中のキーシーケンスをエコーエリアに表示するEmacs標準機能である。

### 本通知の処理概要

echo-keystrokes通知は、ユーザーが入力中のキーシーケンスをリアルタイムでエコーエリアに表示する機能である。Doom EmacsではVimスタイルのキーバインディングを多用するため、この機能は特に重要である。

**業務上の目的・背景**：VimスタイルのキーバインディングやEmacsのプレフィックスキー（C-x, C-c等）を使用する際、ユーザーが現在入力中のキーシーケンスを視覚的に確認できることは重要である。これにより、コマンド入力中の状態を把握し、入力ミスを早期に発見できる。Doom Emacsでは`echo-keystrokes`を0.02秒に設定し、非常に短い遅延でキーシーケンスを表示する。

**通知の送信タイミング**：キー入力から`echo-keystrokes`秒（デフォルト0.02秒）経過後、まだキーシーケンスが完了していない場合に表示される。

**通知の受信者**：Emacsを操作している現在のユーザー。エコーエリアに表示される。

**通知内容の概要**：現在入力中のキーシーケンス。例えば「C-x」や「SPC f」などが表示される。

**期待されるアクション**：ユーザーはキーシーケンスを確認し、続きのキーを入力するか、C-gでキャンセルする。

## 通知種別

アプリ内通知（Emacsエコーエリア）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（タイマーベース） |
| 優先度 | 低 |
| リトライ | 無 |

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

Emacsのエコーエリアに直接表示。ミニバッファが使用中の場合は表示されない場合がある。

## 通知テンプレート

### キーシーケンス表示の場合

| 項目 | 内容 |
|-----|------|
| 表示先 | エコーエリア |
| 形式 | キーシーケンス文字列 |

### 本文テンプレート

```
C-x-
```

```
SPC f-
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| echo-keystrokes | 表示までの遅延秒数 | Emacs変数 | Yes |
| current-key-sequence | 現在のキーシーケンス | Emacs内部 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| タイマー発火 | echo-keystrokes秒経過 | キーシーケンス未完了 | 遅延後に表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| echo-keystrokes = 0 | 機能無効 |
| キーシーケンス完了 | コマンド実行済み |
| ミニバッファ使用中 | ミニバッファにフォーカス時 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[キー入力] --> B[キーシーケンス蓄積]
    B --> C{コマンド完了?}
    C -->|Yes| D[コマンド実行]
    C -->|No| E[タイマー開始]
    E --> F{echo-keystrokes経過?}
    F -->|No| G[次のキー待機]
    F -->|Yes| H[エコーエリアに表示]
    G --> B
    H --> G
    D --> I[エコーエリアクリア]
    I --> J[終了]
```

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

### 参照テーブル一覧

該当なし（Emacs内部状態のみ参照）

### 変数参照詳細

| 変数名 | 用途 | 取得条件 |
|--------|------|---------|
| echo-keystrokes | 表示遅延秒数 | 常時参照可能 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | Emacs標準機能のためエラーなし |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| echo-keystrokes | 0.02秒（Doom Emacs設定） |

### 配信時間帯

制限なし

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

- キー入力内容がエコーエリアに表示されるが、パスワード入力時は別の仕組みで非表示にされる
- ローカル表示のみで外部送信はない

## 備考

- Doom Emacsではデフォルト0.02秒に設定（通常のEmacsデフォルトは1秒）
- Vimユーザー向けの短い遅延設定
- `resize-mini-windows`が`grow-only`に設定されているため、複数行のキーシーケンスも表示可能

---

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

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

### 推奨読解順序

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

echo-keystrokesの設定を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | doom-ui.el | `lisp/doom-ui.el` | echo-keystrokes設定（321行目）を確認 |

**読解のコツ**: `setq echo-keystrokes 0.02`で0.02秒の遅延を設定。

#### Step 2: 関連設定を理解する

ミニバッファ・エコーエリアの関連設定を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | doom-ui.el | `lisp/doom-ui.el` | resize-mini-windows設定（325-326行目）を確認 |
| 2-2 | doom-ui.el | `lisp/doom-ui.el` | tooltip-resize-echo-area設定（326行目）を確認 |

**主要処理フロー**:
1. **321行目**: `echo-keystrokes`を0.02秒に設定
2. **325行目**: `resize-mini-windows`を`grow-only`に設定
3. **326行目**: `tooltip-resize-echo-area`をtに設定

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

```
[Emacs標準機能]
    |
    +-- command-execute (コマンド実行)
            |
            +-- [キーシーケンス監視]
                    |
                    +-- echo-keystrokes タイマー
                            |
                            +-- エコーエリア表示
```

### データフロー図

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

キー入力 ─────────────▶ キーシーケンス蓄積
                              │
                              ▼
                    [echo-keystrokes経過判定]
                              │
                              ▼
echo-keystrokes値 ───▶ タイマー処理 ──▶ エコーエリア表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| doom-ui.el | `lisp/doom-ui.el` | ソース | echo-keystrokes設定の定義 |
