# 通知設計書 17-カレントディレクトリ通知（OSC 7）

## 概要

本ドキュメントは、Oh My Zshのターミナルサポート機能における、OSC 7エスケープシーケンスを使用したカレントディレクトリ通知の設計を記載する。

### 本通知の処理概要

この通知は、OSC 7（Operating System Command 7）エスケープシーケンスを使用して、現在の作業ディレクトリをfile:// URI形式でターミナルエミュレータに通知する機能である。これにより、ターミナルエミュレータは「新しいタブを同じディレクトリで開く」などの機能を正しく動作させることができる。

**業務上の目的・背景**：多くのモダンなターミナルエミュレータは、新しいタブやウィンドウを開く際に、現在のタブと同じディレクトリで開始するオプションを提供している。しかし、シェルがディレクトリを変更してもターミナルエミュレータはその情報を自動的に取得できない。OSC 7を使用することで、シェルからターミナルエミュレータに現在のディレクトリを明示的に通知でき、ユーザー体験が向上する。

**通知の送信タイミング**：precmdフック（プロンプト表示前）に呼び出され、毎回のコマンド実行後に現在のディレクトリを通知する。

**通知の受信者**：ターミナルエミュレータ。OSC 7エスケープシーケンスを解釈して内部的にカレントディレクトリ情報を保持する。

**通知内容の概要**：`file://hostname/path/to/directory`形式のURIをOSC 7シーケンスで送信する。パス内の特殊文字（スペース等）はパーセントエンコードされる。

**期待されるアクション**：ターミナルエミュレータがOSC 7を受信し、カレントディレクトリ情報を更新する。ユーザーが「新しいタブを同じディレクトリで開く」などの操作を行った際に正しいディレクトリが使用される。

## 通知種別

ターミナルエスケープシーケンス（OSC 7）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（フック実行時に即座に送信） |
| 優先度 | 低（表示最適化のための補助機能） |
| リトライ | なし |

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

対応ターミナルでのみエスケープシーケンスを出力する。Emacs内、SSH接続時、非対応ターミナルでは出力しない。

## 通知テンプレート

### エスケープシーケンス形式

| 項目 | 内容 |
|-----|------|
| 送信元 | termsupport.zsh |
| エスケープシーケンス | `\e]7;file://${URL_HOST}${URL_PATH}\e\\` |
| 対応ターミナル | xterm, putty, rxvt, konsole, mlterm, alacritty, screen, tmux, contour, foot, Apple Terminal, iTerm2 |

### 本文テンプレート

```
\e]7;file://hostname/path/to/directory\e\\
```

展開例：`\e]7;file://myhost/home/user/my%20project\e\\`（スペースは%20にエンコード）

### URI形式の詳細

```
file://[host][path]
```

- **host**：ホスト名（omz_urlencodeでエンコード）
- **path**：パス（omz_urlencodeでエンコード、先頭の/は保持）

### Konsole特別処理

Konsoleターミナルではホスト名を含めるとエラーになるため、URL_HOSTを空にする。

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | エスケープシーケンスのため添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| URL_HOST | ホスト名（エンコード済み） | $HOST + omz_urlencode | Yes |
| URL_PATH | パス（エンコード済み） | $PWD + omz_urlencode | Yes |
| KONSOLE_PROFILE_NAME | Konsole判定用 | 環境変数 | No |
| KONSOLE_DBUS_SESSION | Konsole判定用 | 環境変数 | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| フック | precmd | 対応ターミナルかつ非SSH | プロンプト表示前 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| INSIDE_EMACS != "" | Emacs内では出力しない |
| SSH_CLIENT != "" または SSH_TTY != "" | SSH接続時は出力しない |
| 非対応ターミナル | $TERMが対応ターミナルでない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[precmdフック実行] --> B{INSIDE_EMACS?}
    B -->|Yes| C[処理終了]
    B -->|No| D{SSH接続?}
    D -->|Yes| C
    D -->|No| E{対応ターミナル?}
    E -->|No| C
    E -->|Yes| F[omz_termsupport_cwd関数呼び出し]
    F --> G[URL_HOST = omz_urlencode $HOST]
    G --> H[URL_PATH = omz_urlencode $PWD]
    H --> I{Konsole?}
    I -->|Yes| J[URL_HOST = 空]
    I -->|No| K[URL_HOSTそのまま]
    J --> L[OSC 7出力]
    K --> L
    L --> M[終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| omz_urlencode失敗 | エンコード処理でエラー | return 1で処理中断 |
| ターミナル非対応 | OSC 7を解釈できないターミナル | 早期リターンで出力しない |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | precmdごとに1回のみ実行 |

### 配信時間帯

制限なし（precmd実行時に即座に送信）

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

- ディレクトリパスがターミナルエミュレータに送信される
- SSH接続時は無効化（リモートのディレクトリ情報がローカルターミナルに送信されるのを防止）
- omz_urlencodeでパスをエンコードし、不正なエスケープシーケンスの注入を防止

## 備考

- OSC 7は2012年以前のlibvteでは未知のOSCとして表示されるバグがあった
- 現在の多くのターミナル（mlterm, PuTTY, rxvt, screen, termux, xterm）は未知のOSCを無視する
- chpwdフックではなくprecmdフックを使用する理由は、`cd -q`でディレクトリ変更した場合にchpwdが呼ばれず、スクリプト/関数の出力に干渉する可能性があるため

---

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

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

### 推奨読解順序

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

まず、URI形式とエンコード処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | termsupport.zsh | `lib/termsupport.zsh` | omz_termsupport_cwd関数内の変数定義（147-152行目） |

**読解のコツ**: `omz_urlencode -P`は「パス」モードでエンコード（先頭の/を保持し、特殊文字をパーセントエンコード）。

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

処理の起点となる条件判定とフック登録を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | termsupport.zsh | `lib/termsupport.zsh` | 環境判定と早期リターン（124-140行目） |
| 2-2 | termsupport.zsh | `lib/termsupport.zsh` | フック登録（164行目） |

**主要処理フロー**:
1. **125行目**: INSIDE_EMACS判定
2. **125行目**: SSH_CLIENT/SSH_TTY判定
3. **130-140行目**: $TERMと$TERM_PROGRAMによる対応ターミナル判定
4. **164行目**: `add-zsh-hook precmd omz_termsupport_cwd`でフック登録

#### Step 3: OSC 7出力処理を理解する

実際のエスケープシーケンス出力を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | termsupport.zsh | `lib/termsupport.zsh` | omz_termsupport_cwd関数（147-159行目） |

**主要処理フロー**:
- **148行目**: `setopt localoptions unset`でローカルオプション設定
- **151行目**: `URL_HOST="$(omz_urlencode -P $HOST)"`でホスト名エンコード
- **152行目**: `URL_PATH="$(omz_urlencode -P $PWD)"`でパスエンコード
- **155行目**: Konsole判定でURL_HOSTを空に
- **158行目**: `printf "\e]7;file://%s%s\e\\"` でOSC 7出力

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

```
シェル起動
    │
    └─ lib/termsupport.zsh (source)
           │
           ├─ 環境判定 (125-140行目)
           │      ├─ [INSIDE_EMACS] → return
           │      ├─ [SSH接続] → return
           │      └─ [非対応ターミナル] → return
           │
           └─ add-zsh-hook precmd omz_termsupport_cwd (164行目)
                  │
                  └─ omz_termsupport_cwd (147-159行目)
                         │
                         ├─ omz_urlencode -P $HOST (151行目)
                         │
                         ├─ omz_urlencode -P $PWD (152行目)
                         │
                         ├─ [Konsole] URL_HOST="" (155行目)
                         │
                         └─ printf "\e]7;file://%s%s\e\\" (158行目)
```

### データフロー図

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

$HOST ───────────▶ omz_urlencode -P ────▶ URL_HOST
                                               │
$PWD ────────────▶ omz_urlencode -P ────▶ URL_PATH
                                               │
                                               ▼
                   printf ──────────────▶ \e]7;file://myhost/home/user/my%20project\e\\
                                               │
                                               ▼
                                    ターミナルエミュレータ
                                    （カレントディレクトリ情報更新）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| termsupport.zsh | `lib/termsupport.zsh` | ソース | OSC 7出力のメイン実装 |
| functions.zsh | `lib/functions.zsh` | ソース | omz_urlencode関数の定義 |
