# 通知設計書 11-ConEmuメッセージボックス

## 概要

本ドキュメントは、Ghosttyターミナルエミュレーターにおける「ConEmuメッセージボックス」通知機能の設計を記載するものである。OSC 9;2エスケープシーケンスを通じて、ConEmu互換のGUIメッセージボックス表示をリクエストする機能について詳述する。

### 本通知の処理概要

**業務上の目的・背景**：ConEmuメッセージボックス通知は、ConEmuターミナルエミュレーターとの互換性を提供するために実装されている。シェルスクリプトやCLIアプリケーションが、OSC 9;2エスケープシーケンスを通じてユーザーにモーダルなメッセージダイアログを表示することを可能にする。これにより、バッチ処理の完了通知、エラーメッセージの表示、ユーザーへの確認要求など、明示的な注目を必要とする情報の伝達が可能となる。

**通知の送信タイミング**：アプリケーションまたはシェルスクリプトがOSC 9;2;message形式のエスケープシーケンスをターミナルに出力した時点でトリガーされる。具体的には`\033]9;2;表示したいメッセージ\007`または`\033]9;2;表示したいメッセージ\033\\`の形式である。

**通知の受信者**：当該ターミナルウィンドウを操作しているユーザーが受信者となる。メッセージボックスはGUIダイアログとして表示されることが想定されており、ユーザーの明示的な操作（確認ボタンのクリック等）を必要とする場合がある。

**通知内容の概要**：OSC 9;2シーケンスで指定された任意のテキストメッセージがメッセージボックスの内容として表示される。メッセージは文字列形式で、UTF-8エンコーディングがサポートされる。

**期待されるアクション**：ユーザーはメッセージボックスの内容を確認し、必要に応じてダイアログを閉じる操作を行う。現在のGhostty実装では、この機能は未実装（unimplemented）であり、OSCコマンドはログに記録されるのみである。

## 通知種別

GUIメッセージボックス（モーダルダイアログ） / デスクトップ通知（将来的な実装候補）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（OSCパース時に即座に処理） |
| 優先度 | 中（現在は未実装のためログ出力のみ） |
| リトライ | 無し |

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

送信元ターミナルサーフェスを所有するウィンドウがメッセージボックスの表示対象となる。メッセージボックスは当該ウィンドウのモーダルダイアログとして表示されることが想定される。

## 通知テンプレート

### メッセージボックス通知の場合

| 項目 | 内容 |
|-----|------|
| タイトル | アプリケーション依存（未定義） |
| 本文 | OSC 9;2で指定されたメッセージ |
| ボタン | OK（想定） |

### 本文テンプレート

```
{OSC 9;2で指定されたメッセージ文字列}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | メッセージボックスは添付ファイルをサポートしない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | 表示するメッセージ文字列 | OSC 9;2パラメータ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| エスケープシーケンス | OSC 9;2;message受信 | OSCパーサーが有効なOSC 9;2シーケンスを検出 | ConEmu互換メッセージボックス表示リクエスト |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 無効なOSC形式 | セミコロン区切りが正しくない場合はデスクトップ通知にフォールバック |
| 現在の実装状態 | 未実装のためログ出力のみで実際のメッセージボックスは表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ターミナル入力受信] --> B[OSCパーサー処理]
    B --> C{OSC 9?}
    C -->|Yes| D{サブコマンド確認}
    C -->|No| E[他のOSC処理]
    D -->|9;2;| F[メッセージ抽出]
    D -->|その他| G[対応するConEmu処理]
    F --> H[conemu_show_message_boxコマンド生成]
    H --> I[Streamハンドラ呼び出し]
    I --> J{実装済み?}
    J -->|No| K[デバッグログ出力]
    J -->|Yes| L[メッセージボックス表示]
    K --> M[終了]
    L --> M
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | データベースは使用しない |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | データベースは使用しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パースエラー | OSC 9;2形式が不正 | iTerm2デスクトップ通知としてフォールバック処理 |
| バッファオーバーフロー | メッセージが2048バイトを超過 | パーサー状態をinvalidに設定し処理中断 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（OSC受信時に即座に処理）

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

- メッセージ内容はサニタイズされずそのまま表示されるため、悪意のあるコンテンツが含まれる可能性がある
- ユーザーインタラクションを必要とするモーダルダイアログは、DoS攻撃のベクターとなる可能性があるため、将来的な実装時にはレート制限の検討が必要
- メッセージボックスの内容は機密情報を含む可能性があるため、スクリーンキャプチャ等への配慮が必要

## 備考

- 現在のGhostty実装（2025年時点）では、この機能は「unimplemented」としてログ出力されるのみ
- ConEmuの完全な互換性を目指す場合、将来的にGUIメッセージボックス表示の実装が必要
- OSC 9シーケンスは複数のサブコマンドを持ち、9;2以外にも9;1（sleep）、9;3（タブタイトル変更）、9;4（進捗報告）等がある

---

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

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

### 推奨読解順序

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

OSCコマンドの定義とConEmuメッセージボックスのデータ構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | osc.zig | `src/terminal/osc.zig` | Command union内のconemu_show_message_boxフィールド（行115）を確認 |

**読解のコツ**: Zigのunion型定義において、`conemu_show_message_box: [:0]const u8`は、ヌル終端文字列へのポインタを保持することを示す。

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

OSCシーケンスのパース処理の入口を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | osc9.zig | `src/terminal/osc/parsers/osc9.zig` | parse関数がOSC 9の解析を行う |

**主要処理フロー**:
1. **行7-11**: parse関数のエントリーポイント、writerの取得
2. **行107-119**: OSC 9;2（メッセージボックス）のパース処理
3. **行116-118**: conemu_show_message_boxコマンドの生成

#### Step 3: コマンド実行層を理解する

パースされたコマンドがどのように処理されるかを追跡する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | stream.zig | `src/terminal/stream.zig` | OSCコマンドのディスパッチ処理 |

**主要処理フロー**:
- **行2041**: conemu_show_message_boxは現在unimplemented扱い
- **行2053**: デバッグログへの出力のみ

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

```
ターミナル入力
    |
    +-- Stream.next() [stream.zig]
           |
           +-- osc.Parser.next() [osc.zig]
                  |
                  +-- osc9.parse() [osc/parsers/osc9.zig]
                         |
                         +-- Command生成 (conemu_show_message_box)
                                |
                                +-- [未実装] ログ出力
```

### データフロー図

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

OSC 9;2;message   --->  OSCパーサー        --->   Command構造体
シーケンス               (osc9.zig)               (conemu_show_message_box)
                                                         |
                                                         v
                                                  Streamハンドラ
                                                  (stream.zig)
                                                         |
                                                         v
                                                  [現在] ログ出力
                                                  [将来] GUIダイアログ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| osc.zig | `src/terminal/osc.zig` | ソース | OSCコマンド定義とパーサー基盤 |
| osc9.zig | `src/terminal/osc/parsers/osc9.zig` | ソース | OSC 9（ConEmu/iTerm2）パーサー実装 |
| stream.zig | `src/terminal/stream.zig` | ソース | ターミナルストリーム処理とコマンドディスパッチ |
| action.zig | `src/apprt/action.zig` | ソース | アプリケーションアクション定義（将来的な拡張ポイント） |
