# 機能設計書 17-omz reload

## 概要

本ドキュメントは、Oh My Zshの`omz reload`コマンドの機能設計について記載する。このコマンドは補完キャッシュを削除してzshセッションをリスタートする機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：zshの設定変更後、変更を反映させるためにはシェルを再起動する必要がある。また、補完キャッシュ（zcompdump）が古くなると補完機能が正しく動作しないことがある。本機能は、補完キャッシュを削除し、新しいzshセッションを開始することで、設定変更の反映と補完機能のリフレッシュを一度に行う。

**機能の利用シーン**：
- `.zshrc`を編集した後に変更を反映させたい場合
- プラグインを追加・削除した後にリロードしたい場合
- 補完が正しく動作しない場合にキャッシュをクリアしたい場合
- Oh My Zshをアップデートした後に新しい設定を読み込みたい場合

**主要な処理内容**：
1. 補完キャッシュファイル（`$_comp_dumpfile`、`$ZSH_COMPDUMP`）を削除
2. 現在のzsh実行ファイルパスを取得
3. ログインシェルかどうかを判定
4. `exec`コマンドで新しいzshプロセスを起動

**関連システム・外部連携**：特になし。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 14 | omz reload | 主画面 | 補完キャッシュを削除してzshセッションをリスタート |

## 機能種別

システム制御・セッション管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| - | - | - | パラメータなし | - |

### 入力データソース

- `$_comp_dumpfile`: 補完キャッシュファイルのパス
- `$ZSH_COMPDUMP`: 補完dumpファイルのパス（設定されている場合）
- `$ZSH_ARGZERO`: 現在のzsh実行ファイルパス
- `$functrace`: 関数呼び出しスタック（ZSH_ARGZEROがない場合のフォールバック）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | - | 標準出力への出力はなし |

### 出力先

- ファイルシステム: 補完キャッシュファイルの削除
- プロセス: 新しいzshセッションの起動

### 副作用

- 補完キャッシュファイルが削除される
- 現在のシェルプロセスが新しいzshプロセスに置き換わる
- 現在のシェル変数・関数・エイリアスは失われる（`.zshrc`から再読み込み）

## 処理フロー

### 処理シーケンス

```
1. 補完キャッシュの削除
   ├─ $_comp_dumpfileを削除
   └─ $ZSH_COMPDUMPを削除

2. zsh実行ファイルパスの取得
   ├─ $ZSH_ARGZEROを使用（優先）
   └─ $functrace[-1]から取得（フォールバック）

3. ログインシェル判定
   ├─ $zshが'-'で始まる場合 → ログインシェル
   └─ -o loginオプションが設定されている場合 → ログインシェル

4. 新しいzshを起動
   ├─ ログインシェルの場合: exec -l "${zsh#-}"
   └─ 非ログインシェルの場合: exec "$zsh"
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[rm -f $_comp_dumpfile $ZSH_COMPDUMP]
    B --> C{$ZSH_ARGZEROが設定されている?}
    C -->|Yes| D[zsh = $ZSH_ARGZERO]
    C -->|No| E[zsh = $functrace[-1]から取得]
    D --> F{ログインシェル?}
    E --> F
    F -->|Yes| G[exec -l "${zsh#-}"]
    F -->|No| H[exec "$zsh"]
    G --> I[新しいzshセッション開始]
    H --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | キャッシュ完全削除 | `$_comp_dumpfile`と`$ZSH_COMPDUMP`の両方を削除 | 常時 |
| BR-02 | ログインシェル保持 | 元のセッションがログインシェルの場合、新しいセッションもログインシェルとして起動 | ログインシェル時 |
| BR-03 | パス正規化 | ログインシェルの場合、先頭の'-'を除去してから`-l`オプションで起動 | ログインシェル時 |
| BR-04 | execによる置換 | `exec`を使用して現在のプロセスを置き換え（戻らない） | 常時 |

### 計算ロジック

特になし。

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

本機能ではデータベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル削除失敗 | 補完キャッシュファイルの削除に失敗 | `rm -f`を使用しているため、エラーは無視される |
| - | exec失敗 | zsh実行ファイルが見つからない | execが失敗した場合、現在のシェルは継続（ただし稀） |

### リトライ仕様

リトライは行わない。

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

該当なし。`exec`コマンドは成功した場合戻らないため、アトミックな操作となる。

## パフォーマンス要件

- 即座に実行されること（通常数十ミリ秒以内）
- 新しいzshの起動時間は`.zshrc`の内容に依存

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

- 補完キャッシュファイルの削除権限が必要
- 新しいzshプロセスはユーザーの権限で起動される
- `.zshrc`が再読み込みされるため、設定ファイルの整合性が重要

## 備考

- 本機能は他のコマンド（`omz plugin enable/disable`、`omz theme set`、`omz update`等）からも内部的に呼び出される
- 非インタラクティブセッションからは呼び出されないよう、呼び出し元でチェックされている
- `exec`を使用するため、この関数から戻ることはない

---

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

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

### 推奨読解順序

#### Step 1: 関数の全体構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | cli.zsh | `lib/cli.zsh` | `_omz::reload`関数の定義位置（735-743行目）を確認 |

**読解のコツ**: この関数はシンプルだが、`exec`コマンドの理解が重要。`exec`はプロセスを置き換えるため戻らない。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | cli.zsh | `lib/cli.zsh` | omz関数（3-21行目）からのコマンドディスパッチを確認 |

**主要処理フロー**:
1. **3-21行目**: `omz`関数がコマンドライン引数を解析し、`_omz::$command`を呼び出す
2. **735-743行目**: `_omz::reload`関数が直接呼び出される

#### Step 3: 補完キャッシュ関連を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | completion.zsh | `lib/completion.zsh` | `$_comp_dumpfile`変数の設定を確認 |

**主要処理フロー**:
- **735-737行目**: `_omz::reload`関数の開始
- **737行目**: 補完キャッシュファイルの削除
- **739-740行目**: zsh実行ファイルパスの取得
- **741-742行目**: ログインシェル判定とexec実行

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

```
omz (3-21行目)
    │
    └─ _omz::reload (735-743行目)
           │
           ├─ rm -f $_comp_dumpfile $ZSH_COMPDUMP
           │
           └─ exec [-l] $zsh

内部呼び出し元:
    ├─ _omz::plugin::disable (321行目)
    ├─ _omz::plugin::enable (415行目)
    ├─ _omz::theme::set (859行目)
    └─ _omz::update (916-920行目)
```

### データフロー図

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

$_comp_dumpfile     ───▶ rm -f                       ───▶ ファイル削除
$ZSH_COMPDUMP                │
                             ▼
$ZSH_ARGZERO        ───▶ zshパス決定
$functrace                   │
                             ▼
$zsh, -o login      ───▶ ログインシェル判定
                             │
                             ▼
                         exec $zsh               ───▶ 新しいzshプロセス
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| cli.zsh | `lib/cli.zsh` | ソース | omzコマンドのCLI実装。_omz::reload関数を含む |
| completion.zsh | `lib/completion.zsh` | ソース | 補完システムの初期化と$_comp_dumpfile変数の設定 |
| oh-my-zsh.sh | `oh-my-zsh.sh` | ソース | $ZSH_COMPDUMPのデフォルト設定 |
