# 機能設計書 64-omz_termsupport_preexec

## 概要

本ドキュメントは、Oh My Zshのターミナルサポート機能における`omz_termsupport_preexec`関数の設計を記載する。この関数は、zshのpreexecフック（コマンド実行直前に実行）として登録され、実行中のコマンド名をターミナルタイトルに設定する。

### 本機能の処理概要

**業務上の目的・背景**：長時間実行されるコマンド（ビルド、テスト、データ処理等）を実行している際、ターミナルタイトルに実行中のコマンド名が表示されることで、ユーザーは他の作業をしながらもコマンドの進行状況を把握できる。特に複数のターミナルタブを使用する場合、どのタブでどのコマンドが実行中かを一目で識別できることは生産性向上に大きく寄与する。

**機能の利用シーン**：
- makeやnpmビルドなどの長時間コマンド実行時
- SSH経由でリモートコマンドを実行時
- バックグラウンドジョブをfgで復帰させた時
- 複数ターミナルで異なる作業を並行して行う時

**主要な処理内容**：
1. 自動タイトル設定が有効かどうかを確認する
2. 実行されるコマンドを解析し、コマンド名を抽出する
3. fgコマンドの場合、対象のジョブからコマンド名を取得する
4. title関数を呼び出してコマンド名をタイトルに設定する

**関連システム・外部連携**：
- title関数（機能No.62）を呼び出し
- zshのpreexecフックシステム（add-zsh-hook）
- zshのジョブ管理機能（$jobstates、$jobtexts）

**権限による制御**：`DISABLE_AUTO_TITLE`環境変数がtrueの場合、この機能は無効化される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLIコマンドのため関連画面なし |

## 機能種別

フック処理 / ターミナル制御 / コマンド解析

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $1 | string | Yes | 実行されるコマンド（展開後） | なし |
| $2 | string | Yes | 実行されるコマンド（展開前、ユーザー入力のまま） | なし |

### 入力データソース

- preexecフック引数: `$1`（展開後のコマンド）、`$2`（展開前のコマンド）
- 環境変数: `$DISABLE_AUTO_TITLE`
- シェル変数: `$jobstates`, `$jobtexts`（fgコマンド時）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | integer | 常に0 |
| 副作用 | - | title関数経由でターミナルタイトルを設定 |

### 出力先

- ターミナルエミュレータ（title関数経由）

## 処理フロー

### 処理シーケンス

```
1. DISABLE_AUTO_TITLEチェック
   └─ trueなら即座にreturn 0
2. ローカルオプション設定
   └─ emulate -L zsh, setopt extended_glob
3. コマンド配列に分割
   └─ cmdargs=("${(z)2}")
4. fgコマンド判定
   ├─ fgなら対象ジョブのコマンドを取得
   │   ├─ %<number>: 指定番号のジョブ
   │   ├─ %%, %+, 空: 現在のジョブ（+マーク）
   │   ├─ %-: 前のジョブ（-マーク）
   │   ├─ %?string: 部分一致検索
   │   └─ %string: 前方一致検索
   └─ $1, $2をジョブのコマンドで上書き
5. コマンド名抽出
   └─ sudo, ssh, mosh, rake, 環境変数設定、オプションを除いたコマンド名
6. title関数呼び出し
   └─ コマンド名（短縮）と完全コマンドライン（100文字制限）
```

### フローチャート

```mermaid
flowchart TD
    A[omz_termsupport_preexec開始] --> B{DISABLE_AUTO_TITLE == true?}
    B -->|Yes| C[return 0]
    B -->|No| D[ローカルオプション設定]
    D --> E[コマンドを配列に分割]
    E --> F{コマンドがfg?}
    F -->|Yes| G[ジョブIDを解析]
    G --> H[jobtextsからコマンドを取得]
    H --> I[$1, $2を上書き]
    F -->|No| J[コマンド名を抽出]
    I --> J
    J --> K[sudo/ssh/mosh/rake/-*/=*を除外]
    K --> L[%を%%にエスケープ]
    L --> M[title関数呼び出し]
    M --> N[終了]
    C --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 自動タイトル無効化 | DISABLE_AUTO_TITLEがtrueの場合、タイトル設定を行わない | 環境変数設定時 |
| BR-02 | fgジョブ解決 | fgコマンドの場合、対象ジョブのコマンドを表示 | fgコマンド実行時 |
| BR-03 | コマンド名フィルタリング | sudo, ssh, mosh, rake, 環境変数設定(-*=*)、オプション(-*)を除いた最初のワードを表示 | 常時 |
| BR-04 | コマンドライン切り詰め | ウィンドウタイトルは100文字で右側を切り詰め | 常時 |
| BR-05 | %エスケープ | %文字は%%に変換してプロンプト展開を防止 | 常時 |

### 計算ロジック

**ジョブID解決ロジック**:
```
%<number>  → $jobstates[number]を参照
%%、%+、空 → $jobstates[(r)*:+:*]（+マーク付きジョブ）
%-         → $jobstates[(r)*:-:*]（-マーク付きジョブ）
%?string   → $jobtexts[(r)*${string}*]（部分一致）
%string    → $jobtexts[(r)${string}*]（前方一致）
```

**コマンド名抽出ロジック**:
```
${1[(wr)^(*=*|sudo|ssh|mosh|rake|-*)]}
```
- `(w)`: 配列として単語分割
- `(r)`: 逆マッチ（パターンに一致しない最初の要素）
- `^(...)`: 否定パターン

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

該当なし（データベースを使用しない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | エラーは発生しない設計 | - |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- コマンド実行直前に実行されるため、数ミリ秒以内で完了すること
- ユーザーのコマンド実行体験に影響しないレベルの高速性が必要

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

- コマンドライン引数がターミナルタイトルに表示されるため、パスワード等の機密情報を引数に含むコマンドは注意が必要
- %文字はエスケープされ、悪意あるプロンプト展開を防止

## 備考

- 完全なコマンドラインは100文字に制限されるが、コマンド名（タブタイトル）は制限なし
- zshの`(z)`フラグによりコマンドラインを適切に単語分割

---

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

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

### 推奨読解順序

#### Step 1: preexecフック引数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | - | - | zshのpreexecフックは$1に展開後、$2に展開前のコマンドを受け取る |

**読解のコツ**:
- `$1`: エイリアスや変数が展開された後のコマンド
- `$2`: ユーザーが入力したままのコマンド（展開前）
- 通常は`$2`を使用してユーザーの意図を表示

#### Step 2: omz_termsupport_preexec関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | termsupport.zsh | `lib/termsupport.zsh` | 54-103行目のomz_termsupport_preexec関数 |

**主要処理フロー**:
- **55-56行目**: DISABLE_AUTO_TITLEチェック
- **58-59行目**: ローカルオプション設定（extended_glob有効化）
- **61-63行目**: コマンドを配列に分割（`${(z)2}`）
- **64-96行目**: fgコマンドの特別処理
- **98-100行目**: コマンド名とコマンドライン抽出
- **102行目**: title関数呼び出し

#### Step 3: fgジョブ解決ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | termsupport.zsh | `lib/termsupport.zsh` | 65-96行目のfgコマンド処理 |

**主要処理フロー**:
- **65行目**: `if [[ "${cmdargs[1]}" = fg ]]` - fgコマンド判定
- **67行目**: `local job_id jobspec="${cmdargs[2]#%}"` - ジョブ指定子から%を除去
- **71-89行目**: case文でジョブ指定子の種類を判定
  - **72-74行目**: `<->)` - 数値指定
  - **75-78行目**: `""|%|+)` - 現在のジョブ
  - **79-82行目**: `-)` - 前のジョブ
  - **83-85行目**: `[?]*)` - 部分一致検索
  - **86-88行目**: `*)` - 前方一致検索
- **92-95行目**: ジョブのコマンドで$1, $2を上書き

**読解のコツ**:
- `$jobstates`: ジョブの状態（running, suspended等）を含む連想配列
- `$jobtexts`: ジョブのコマンドテキストを含む連想配列
- `${(k)array[(r)pattern]}`: パターンにマッチする値を持つキーを取得

#### Step 4: コマンド名抽出を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | termsupport.zsh | `lib/termsupport.zsh` | 98-100行目のコマンド名抽出 |

**主要処理フロー**:
- **99行目**: `local CMD="${1[(wr)^(*=*|sudo|ssh|mosh|rake|-*)]:gs/%/%%}"`
  - `[(wr)^(...)]`: 指定パターンに一致しない最初の単語
  - `:gs/%/%%`: %を%%にグローバル置換
- **100行目**: `local LINE="${2:gs/%/%%}"`
  - コマンドライン全体の%をエスケープ

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

```
zshコマンド実行直前
    │
    └─ preexecフック実行
           │
           └─ omz_termsupport_preexec($1, $2)
                  │
                  ├─ DISABLE_AUTO_TITLEチェック
                  │
                  ├─ fgコマンド?
                  │      │
                  │      └─ ジョブ解決（$jobstates, $jobtexts参照）
                  │
                  ├─ コマンド名抽出
                  │      └─ sudo/ssh/mosh/rake/オプション除外
                  │
                  └─ title($CMD, "%100>...>${LINE}%<<")
                         │
                         └─ エスケープシーケンス出力
```

### データフロー図

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

$1 (展開後コマンド) ───────────▶                                ┌─ タブタイトル
                                                                │   "make"
$2 (展開前コマンド) ───────────▶  omz_termsupport_preexec()    │
                                  コマンド解析 ────────────────▶│
$jobstates, $jobtexts ────────▶  (fgの場合ジョブ解決)          └─ ウィンドウタイトル
                                                                    "make -j4 all"

$DISABLE_AUTO_TITLE ──────────▶  有効/無効判定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| termsupport.zsh | `lib/termsupport.zsh` | ソース | omz_termsupport_preexec関数およびターミナルサポートのメイン実装 |
