# 通知設計書 3-bgnotify - ターミナルベル音

## 概要

本ドキュメントは、Oh My Zshのbgnotifyプラグインにおけるターミナルベル音通知機能について、その設計仕様を定義するものである。

### 本通知の処理概要

bgnotifyプラグインは、バックグラウンドで実行されたコマンドが完了した際に、デスクトップ通知と同時にターミナルベル音（\a）を鳴らす機能を提供する。この機能はデフォルトで有効化されている。

**業務上の目的・背景**：デスクトップ通知だけでなく、音声による通知を併用することで、視覚的な通知を見逃した場合でもコマンド完了を認識できる。特に複数のモニターや仮想デスクトップを使用している環境では、視覚的な通知が見えない位置にある可能性があるため、音声通知が有効である。

**通知の送信タイミング**：bgnotifyプラグインがデスクトップ通知を送信するタイミングと同時に、ベル音が出力される。具体的には、コマンド完了後、実行時間がしきい値以上であり、ターミナルがバックグラウンドにある場合にbgnotify_formatted関数内で出力される。

**通知の受信者**：コマンドを実行したユーザー自身。ターミナルエミュレータを通じて音声が出力されるため、システムの音声出力が有効な状態でのみ聞こえる。

**通知内容の概要**：ASCII BEL文字（\a、0x07）が標準出力に書き込まれ、ターミナルエミュレータがこれをシステムの警告音として再生する。

**期待されるアクション**：受信者はベル音を聞いてコマンドの完了を認識し、必要に応じてターミナルに戻る。

## 通知種別

ターミナルベル（システム警告音）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（printf '\a' による即時出力） |
| 優先度 | 中 |
| リトライ | 無し |

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

ベル音は標準出力に対して出力されるため、現在のターミナルセッションで出力される。ベル音の実際の再生はターミナルエミュレータの設定に依存する。

## 通知テンプレート

### ベル音の場合

| 項目 | 内容 |
|-----|------|
| 出力文字 | `\a`（ASCII BEL、0x07） |
| 出力方法 | `printf '\a'` |

### 本文テンプレート

```
\a
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| bgnotify_bell | ベル音有効化フラグ | シェル変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| シェルフック | precmd内のbgnotify_formatted呼び出し | bgnotify_bell=true | デスクトップ通知と同時にベル音を出力 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| bgnotify_bell=false | ユーザーがベル音を無効化した場合 |
| デスクトップ通知が抑止された場合 | bgnotify_end関数の条件チェックで抑止された場合、ベル音も出力されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[bgnotify_formatted呼び出し] --> B{bgnotify_bell = true?}
    B -->|Yes| C[printf '\a' 実行]
    B -->|No| D[スキップ]
    C --> E[デスクトップ通知送信]
    D --> E
    E --> F[終了]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。シェル変数のみで状態管理を行う。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | データベース不使用 |

### シェル変数一覧

| 変数名 | 用途 | デフォルト値 |
|--------|------|-------------|
| bgnotify_bell | ベル音有効化フラグ | true |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 音声出力無効 | システムの音声がミュートされている | ターミナルエミュレータ/OSの仕様に依存、エラーとはならない |
| ターミナルがベル非対応 | 一部のターミナルでベルが無効化されている | サイレント失敗 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間対応）

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

- ベル音は情報を含まないため、セキュリティ上の懸念はない
- ローカル出力のみであり、ネットワーク経由での送信は行われない

## 備考

- ベル音はデスクトップ通知より先に出力される（54行目で出力後、55行目以降でデスクトップ通知）
- ターミナルエミュレータによってはベル音を視覚的なフラッシュに変換する設定がある
- macOS Terminal.appではDock アイコンのバウンスに変換可能
- iTerm2では音声、視覚フラッシュ、Dock バッジなど複数の通知方法を設定可能

---

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

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

### 推奨読解順序

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

ベル音の有効/無効を制御する変数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | bgnotify.plugin.zsh | `plugins/bgnotify/bgnotify.plugin.zsh` | 138行目のbgnotify_bellデフォルト値設定を確認 |

**読解のコツ**: `${var:-default}` 記法でデフォルト値がtrueに設定されている。

#### Step 2: ベル音出力処理を理解する

実際にベル音を出力する処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | bgnotify.plugin.zsh | `plugins/bgnotify/bgnotify.plugin.zsh` | 54行目のprintf '\a'でベル音出力を確認 |

**主要処理フロー**:
- **54行目**: `[[ $bgnotify_bell = true ]] && printf '\a'` - 条件付きベル音出力

#### Step 3: 呼び出しコンテキストを理解する

ベル音がいつ出力されるかのコンテキストを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | bgnotify.plugin.zsh | `plugins/bgnotify/bgnotify.plugin.zsh` | 44-60行目のbgnotify_formatted関数全体を確認 |

**主要処理フロー**:
- **44行目**: 関数オーバーライド可能性チェック
- **50-52行目**: 実行時間の人間可読形式への変換
- **54行目**: ベル音出力
- **55-59行目**: デスクトップ通知呼び出し

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

```
[コマンド完了]
    │
    └─ bgnotify_end (precmdフック)
           │
           └─ bgnotify_formatted
                  │
                  ├─ [bgnotify_bell=true?] ──Yes──▶ printf '\a' ──▶ ベル音
                  │                         │
                  │                        No
                  │                         │
                  │                         ▼
                  │                      スキップ
                  │
                  └─ bgnotify (デスクトップ通知)
```

### データフロー図

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

bgnotify_bell ────────▶ bgnotify_formatted ────────▶ '\a' (BEL文字)
(true/false)                   │                          │
                               │                          ▼
                               │                    ターミナルエミュレータ
                               │                          │
                               │                          ▼
                               │                    システム警告音
                               │
                               └────────────────▶ デスクトップ通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| bgnotify.plugin.zsh | `plugins/bgnotify/bgnotify.plugin.zsh` | ソース | ベル音出力ロジックを含むメインファイル |
