# 機能設計書 38-補完システム初期化

## 概要

本ドキュメントは、Oh My Zshの補完システム初期化機能の設計について記載する。この機能は、ZSHの補完システム（compinit）を設定し、メニュー選択、大文字小文字区別なし補完、キャッシュなどを初期化する。

### 本機能の処理概要

**業務上の目的・背景**：ZSHの強力な補完システムを最大限に活用するためには、適切な初期設定が必要である。Oh My Zshは、一般的なユースケースに最適化された補完設定を提供し、ユーザーが快適なコマンドライン体験を得られるようにする。

**機能の利用シーン**：シェル起動時に自動的に読み込まれ、以降のすべての補完操作に影響する。コマンド、ファイル名、オプション、ユーザー名など、あらゆる補完シーンで利用される。

**主要な処理内容**：
1. zsh/complistモジュールのロード
2. シェルオプションの設定（auto_menu、complete_in_word、always_to_end）
3. メニュー選択モードの有効化
4. 大文字小文字区別なし補完の設定（CASE_SENSITIVE/HYPHEN_INSENSITIVE変数に依存）
5. 補完結果の色設定
6. プロセス補完の設定
7. 補完キャッシュの設定
8. 不要なユーザーの補完除外
9. bashcompinit（bash補完関数の互換性）のロード

**関連システム・外部連携**：ZSHの補完システム（compsys）と連携する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | ターミナル | 結果表示画面 | TABキーによる補完操作時に設定が適用される |

## 機能種別

設定・初期化処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| CASE_SENSITIVE | string | No | "true"の場合、大文字小文字を区別する | - |
| HYPHEN_INSENSITIVE | string | No | "true"の場合、ハイフンとアンダースコアを区別しない | - |
| COMPLETION_WAITING_DOTS | string/bool | No | 補完中の待機インジケータ設定 | - |

### 入力データソース

- **環境変数**: CASE_SENSITIVE、HYPHEN_INSENSITIVE、COMPLETION_WAITING_DOTS、OSTYPE、USERNAME
- **グローバル変数**: $ZSH_CACHE_DIR

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| シェルオプション | - | auto_menu、complete_in_word、always_to_endが有効化 |
| zstyle設定 | - | 補完システムの各種スタイル設定 |
| キーバインド | - | ^oがaccept-and-infer-next-historyにバインド |

### 出力先

ZSHシェル環境（オプション、zstyle、キーバインド）

## 処理フロー

### 処理シーケンス

```
1. zsh/complistモジュールのロード
2. WORDCHARS変数の初期化（空文字列）
3. シェルオプションの設定
   └─ unsetopt: menu_complete, flowcontrol
   └─ setopt: auto_menu, complete_in_word, always_to_end
4. メニュー選択モードのキーバインド設定
5. メニュー選択スタイルの設定
6. 大文字小文字補完マッチャーの設定
   └─ CASE_SENSITIVE/HYPHEN_INSENSITIVEに基づく
7. 特殊ディレクトリ(.、..)の補完設定
8. リスト色設定
9. プロセス補完コマンドの設定（OS依存）
10. cdコマンドの補完設定
11. キャッシュ設定
12. ユーザー補完の除外設定
13. 待機インジケータの設定（COMPLETION_WAITING_DOTSが有効時）
14. bashcompinitのロード
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[zsh/complistロード]
    B --> C[シェルオプション設定]
    C --> D{CASE_SENSITIVE?}
    D -->|true| E[大文字小文字区別あり]
    D -->|false| F{HYPHEN_INSENSITIVE?}
    F -->|true| G[ハイフン区別なし]
    F -->|false| H[デフォルト補完]
    E --> I[その他の補完設定]
    G --> I
    H --> I
    I --> J{COMPLETION_WAITING_DOTS?}
    J -->|有効| K[待機インジケータ設定]
    J -->|無効| L[bashcompinitロード]
    K --> L
    L --> M[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-38-1 | 大文字小文字補完 | デフォルトで大文字小文字を区別しない補完 | CASE_SENSITIVEがtrueでない場合 |
| BR-38-2 | ハイフン補完 | HYPHEN_INSENSITIVEがtrueの場合、ハイフンとアンダースコアを同一視 | 設定時 |
| BR-38-3 | OS依存プロセス補完 | Solarisとその他OSでpsコマンドのオプションが異なる | 常時 |
| BR-38-4 | システムユーザー除外 | システムアカウント（daemon、root等）を補完候補から除外 | ユーザー補完時 |

### 計算ロジック

補完マッチャーの優先度:
1. CASE_SENSITIVE=true: `'r:|=*' 'l:|=* r:|=*'`
2. HYPHEN_INSENSITIVE=true: `'m:{[:lower:][:upper:]-_}={[:upper:][:lower:]_-}' 'r:|=*' 'l:|=* r:|=*'`
3. デフォルト: `'m:{[:lower:][:upper:]}={[:upper:][:lower:]}' 'r:|=*' 'l:|=* r:|=*'`

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | モジュールエラー | zsh/complistがロードできない | ZSH組み込みなので通常発生しない |

### リトライ仕様

リトライは実装されていない

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

該当なし

## パフォーマンス要件

- シェル起動時に1回のみ実行
- 補完キャッシュを有効化して後続の補完を高速化

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

- システムアカウントを補完候補から除外することでセキュリティを向上
- `_*`パターンで内部ユーザーを除外

## 備考

- WORDCHARS=''により、単語区切りがより細かくなる
- bashcompinitにより、bash用の補完関数も利用可能

---

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

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

### 推奨読解順序

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

補完システムで使用される環境変数とzstyleを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | completion.zsh | `lib/completion.zsh` | 環境変数の使用方法を確認 |

**読解のコツ**:
- zstyleはZSHのスタイル設定システムで、`zstyle 'パターン' スタイル名 値`の形式
- 補完関連のパターンは`:completion:*`で始まる

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | completion.zsh | `lib/completion.zsh` | ファイル全体（1-79行目） |

**主要処理フロー**:
1. **2行目**: `zmodload -i zsh/complist` - complistモジュールロード
2. **4行目**: `WORDCHARS=''` - 単語区切り文字設定
3. **6-10行目**: シェルオプション設定
4. **13-14行目**: メニュー選択のキーバインドとスタイル
5. **17-26行目**: 大文字小文字補完の設定（CASE_SENSITIVE/HYPHEN_INSENSITIVE分岐）
6. **28-45行目**: 各種補完スタイル設定
7. **47-56行目**: ユーザー補完の除外リスト
8. **61-75行目**: 待機インジケータ設定（COMPLETION_WAITING_DOTS）
9. **78行目**: bashcompinit

#### Step 3: 待機インジケータ機能を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | completion.zsh | `lib/completion.zsh` | `expand-or-complete-with-dots`関数（62-69行目） |

**主要処理フロー**:
- **64行目**: COMPLETION_WAITING_DOTSのデフォルト値設定
- **66行目**: 待機インジケータ表示
- **67行目**: `zle expand-or-complete` - 実際の補完実行
- **68行目**: `zle redisplay` - 画面再描画

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

```
lib/completion.zsh (シェル起動時にsource)
    │
    ├─ zmodload -i zsh/complist
    │
    ├─ setopt auto_menu complete_in_word always_to_end
    │
    ├─ zstyle ':completion:*' ...
    │      ├─ menu select
    │      ├─ matcher-list ...
    │      ├─ special-dirs true
    │      ├─ list-colors ''
    │      ├─ use-cache yes
    │      └─ cache-path $ZSH_CACHE_DIR
    │
    ├─ expand-or-complete-with-dots (COMPLETION_WAITING_DOTS有効時)
    │      └─ bindkey -M emacs/viins/vicmd "^I"
    │
    └─ autoload -U +X bashcompinit && bashcompinit
```

### データフロー図

```
[環境変数]              [処理]                    [出力]

CASE_SENSITIVE ─────▶ zstyle設定 ─────────▶ 補完マッチャー
HYPHEN_INSENSITIVE ──▶
                              │
ZSH_CACHE_DIR ─────────▶ キャッシュ設定 ────▶ 補完キャッシュパス
                              │
COMPLETION_WAITING_DOTS ▶ 待機インジケータ ─▶ ^Iキーバインド
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| completion.zsh | `lib/completion.zsh` | ソース | 補完システム初期化の定義元 |
| oh-my-zsh.sh | `oh-my-zsh.sh` | ソース | lib/completion.zshを読み込むメインスクリプト |
