# 機能設計書 58-Zsh統合

## 概要

本ドキュメントは、GhosttyターミナルエミュレータのZshシェル統合機能の設計仕様を記載する。

### 本機能の処理概要

Zsh統合機能は、ZshシェルとGhosttyの連携を実現するシェルスクリプトである。プロンプトマーキング、カーソルスタイル変更、ウィンドウタイトル更新、SSH統合、sudo統合など、ターミナルとシェルの高度な連携機能を提供する。Zshの豊富なフック機構を活用した堅牢な実装。

**業務上の目的・背景**：ZshはmacOSのデフォルトシェルであり、多くの開発者に利用されている。Ghosttyはシェル統合によりOSC 133を活用したセマンティックプロンプト機能を実現し、プロンプト間ジャンプやコマンド完了通知などの生産性向上機能を提供する。Zshのzleウィジェットやprecmdフックとネイティブに統合。

**機能の利用シーン**：
- プロンプト間のジャンプ機能の利用
- viモード時のカーソルスタイル自動切り替え
- SSH接続時のterminfoの自動セットアップ
- sudoコマンド実行時のTERMINFO環境変数の維持

**主要な処理内容**：
1. ZDOTDIR経由での自動シェル統合
2. OSC 133によるプロンプトマーキング（precmd/preexec）
3. zle-line-init/keymap-selectによるカーソルスタイル動的変更
4. chpwd_functionsによるカレントディレクトリ報告
5. SSH統合によるterminfo自動インストール
6. sudo統合によるTERMINFO維持

**関連システム・外部連携**：Zsh 5.1以上、SSH、sudo

**権限による制御**：特になし。全ユーザーが実行可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインターミナルウィンドウ | 主機能 | プロンプトマーキング、タイトル更新、カーソル変更 |

## 機能種別

シェル統合 / イベントフック

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| GHOSTTY_SHELL_FEATURES | 環境変数 | No | 有効な統合機能（カンマ区切り） | - |
| GHOSTTY_BIN_DIR | 環境変数 | No | Ghosttyバイナリのディレクトリパス | - |
| GHOSTTY_RESOURCES_DIR | 環境変数 | No | Ghosttyリソースディレクトリパス | - |
| TERMINFO | 環境変数 | No | terminfoデータベースパス | - |

### 入力データソース

- 環境変数
- Zshの起動設定ファイル（.zshenv、.zshrc等）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| OSC 133シーケンス | エスケープシーケンス | プロンプト/コマンドの境界マーカー |
| OSC 7シーケンス | エスケープシーケンス | カレントディレクトリ情報 |
| OSC 2シーケンス | エスケープシーケンス | ウィンドウタイトル |
| カーソルシーケンス | エスケープシーケンス | カーソルスタイル変更 |

### 出力先

- ターミナル（tty）: _ghostty_fd経由でO_CLOEXECファイルディスクリプタ使用

## 処理フロー

### 処理シーケンス

```
1. .zshenvからの自動ソース
   └─ ZDOTDIR復元、ユーザーの.zshenvソース
2. ghostty-integration関数のautoload
   └─ 対話モードの場合のみ
3. _entrypoint関数の実行
   └─ Zsh 5.1+確認、_ghostty_state初期化
   └─ _ghostty_fd設定（O_CLOEXEC）
4. _ghostty_deferred_init関数の登録
   └─ precmd_functionsに追加、初回プロンプトで実行
5. 各機能の初期化
   └─ _ghostty_precmd/_ghostty_preexec定義
   └─ chpwd_functions、zle-line-init等のフック設定
```

### フローチャート

```mermaid
flowchart TD
    A[Zsh起動] --> B[.zshenv自動ソース]
    B --> C[ZDOTDIR復元]
    C --> D[ユーザー.zshenvソース]
    D --> E{対話モード?}
    E -->|No| F[終了]
    E -->|Yes| G[ghostty-integration autoload]
    G --> H[_entrypoint実行]
    H --> I{Zsh 5.1+?}
    I -->|No| J[エラーメッセージ]
    J --> F
    I -->|Yes| K[_ghostty_fd設定]
    K --> L[_ghostty_deferred_init登録]
    L --> M[初回プロンプト]
    M --> N[遅延初期化実行]
    N --> O[precmd/preexec定義]
    O --> P[chpwd_functions設定]
    P --> Q{cursor機能?}
    Q -->|Yes| R[zleウィジェット設定]
    Q -->|No| S{sudo機能?}
    R --> S
    S -->|Yes| T[sudoラッパー定義]
    S -->|No| U{ssh機能?}
    T --> U
    U -->|Yes| V[sshラッパー定義]
    U -->|No| W[統合完了]
    V --> W
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-58-1 | Zshバージョン要件 | 5.1以上が必要（functions_source、introspection arrays等） | 常時 |
| BR-58-2 | O_CLOEXEC使用 | 子プロセスへのfd漏洩防止のためsysopenでO_CLOEXECを使用 | tty書き込み時 |
| BR-58-3 | 遅延初期化 | precmd_functionsを使用して初回プロンプト時に初期化 | 常時 |
| BR-58-4 | PS1/PS2修飾 | precmdが最後に実行される場合のみPS1/PS2にマーカーを追加 | precmd_functions確認時 |

### 計算ロジック

特になし

## データベース操作仕様

### 操作別データベース影響一覧

データベース操作なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | バージョン不足 | Zsh 5.1未満 | エラーメッセージを出力し統合をスキップ |
| - | sysopen失敗 | /dev/ttyを開けない | stdout(fd=1)にフォールバック |

### リトライ仕様

リトライなし

## トランザクション仕様

該当なし

## パフォーマンス要件

シェルの起動と各コマンド実行に顕著な遅延を与えないこと

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

- sudoラッパーは--preserve-env=TERMINFOのみを追加
- O_CLOEXECにより子プロセスへのfd漏洩を防止

## 備考

- GPLv3ライセンス（Kittyの統合スクリプトをベースとしている）
- .zshrcの手動source時やexec zsh実行時は再統合が必要
- add-zle-hook-widgetがある場合はそれを使用、ない場合は直接zleウィジェットを置換

---

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

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

### 推奨読解順序

#### Step 1: 自動インジェクションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | .zshenv | `src/shell-integration/zsh/.zshenv` | ZDOTDIRによる自動ソースの起点 |

**読解のコツ**: ZDOTDIRをGhosttyのディレクトリに設定することで、このファイルが自動的にソースされる。元のZDOTDIRは復元される。

#### Step 2: メイン統合スクリプトを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ghostty-integration | `src/shell-integration/zsh/ghostty-integration` | メイン統合ロジック |

**主要処理フロー**:
- **40-91行目**: _entrypoint関数 - バージョンチェック、_ghostty_fd設定
- **93-413行目**: _ghostty_deferred_init関数 - 各機能の初期化
- **415行目**: _entrypoint呼び出し

#### Step 3: precmd/preexec実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ghostty-integration | `src/shell-integration/zsh/ghostty-integration` | 97-204行目: _ghostty_precmd/_ghostty_preexec |

**主要処理フロー**:
- **97-180行目**: _ghostty_precmd - OSC 133 A/B/Dの出力、PS1/PS2修飾
- **182-204行目**: _ghostty_preexec - PS1/PS2復元、OSC 133 C出力

#### Step 4: カーソルスタイルとzle統合を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | ghostty-integration | `src/shell-integration/zsh/ghostty-integration` | 224-240行目、361-394行目: カーソルスタイル、zleウィジェット |

**主要処理フロー**:
- **229-236行目**: _ghostty_zle_line_init等 - keymapに応じたカーソル変更
- **361-394行目**: zleウィジェットの設定（add-zle-hook-widget対応）

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

```
Zsh起動
    │
    ├─ .zshenv ソース（ZDOTDIR経由）
    │      │
    │      ├─ ZDOTDIR復元
    │      ├─ ユーザー.zshenvソース
    │      └─ ghostty-integration autoload
    │
    └─ ghostty-integration実行
           │
           ├─ _entrypoint()
           │      ├─ is-at-least 5.1 チェック
           │      ├─ _ghostty_state初期化
           │      ├─ sysopen で _ghostty_fd設定
           │      └─ precmd_functions += _ghostty_deferred_init
           │
           └─ _ghostty_deferred_init() [初回プロンプト時]
                  │
                  ├─ _ghostty_precmd定義
                  │      └─ OSC 133 A/B/D, PS1/PS2修飾
                  │
                  ├─ _ghostty_preexec定義
                  │      └─ PS1/PS2復元, OSC 133 C
                  │
                  ├─ _ghostty_report_pwd定義
                  │      └─ chpwd_functions, OSC 7
                  │
                  ├─ title機能
                  │      └─ OSC 2 (precmd/preexec追加)
                  │
                  ├─ cursor機能
                  │      └─ zle-line-init/finish/keymap-select
                  │
                  ├─ sudo機能
                  │      └─ sudoラッパー関数
                  │
                  └─ ssh機能
                         └─ sshラッパー関数
```

### データフロー図

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

環境変数 ───────▶ 機能フラグ解析 ───────▶ 関数定義
(GHOSTTY_SHELL_FEATURES)

プロンプト表示 ──▶ _ghostty_precmd()
                         │
                         ├──▶ OSC 133;D （前コマンド終了）
                         ├──▶ PS1/PS2修飾 （OSC 133;A/B追加）
                         └──▶ OSC 2 （タイトル: PWD短縮形）

コマンド実行 ────▶ _ghostty_preexec()
                         │
                         ├──▶ PS1/PS2復元
                         ├──▶ OSC 2 （タイトル: コマンド）
                         └──▶ OSC 133;C （コマンド開始）

ディレクトリ変更 ─▶ _ghostty_report_pwd()
                         │
                         └──▶ OSC 7 （CWD報告）

viモード切替 ────▶ _ghostty_zle_keymap_select()
                         │
                         └──▶ カーソルスタイル変更
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| .zshenv | `src/shell-integration/zsh/.zshenv` | シェルスクリプト | 自動インジェクション起点 |
| ghostty-integration | `src/shell-integration/zsh/ghostty-integration` | シェルスクリプト | メイン統合スクリプト |
