# 機能設計書 60-clippaste

## 概要

本ドキュメントは、Oh My Zshの`clippaste`関数の機能設計を記載する。この関数は、クロスプラットフォーム対応でシステムクリップボードからデータを取得（貼り付け）するユーティリティ関数である。

### 本機能の処理概要

`clippaste`関数は、実行環境に応じた適切なクリップボードコマンドを使用してシステムクリップボードからデータを取得し、標準出力に出力する。macOS、Linux（X11/Wayland）、Windows（Cygwin/WSL/MSYS）、SSH経由など、様々な環境に対応している。

**業務上の目的・背景**：開発作業において、クリップボードの内容をコマンドラインで使用したい場面は頻繁にある。各プラットフォームではクリップボードへのアクセス方法が異なるため、統一的なインターフェースを提供することで、環境を意識せずにクリップボード操作を行えるようにする。clipcopy関数と対をなし、クリップボードとのデータ交換を完結させる。

**機能の利用シーン**：
- クリップボードの内容をコマンドの引数として使用する場合
- クリップボードの内容をファイルに保存する場合
- クリップボードの内容をパイプラインで加工する場合
- SSH接続先でローカルのクリップボード内容を取得する場合

**主要な処理内容**：
1. detect-clipboard関数でプラットフォームを検出
2. 検出されたプラットフォームに応じてclippaste関数を再定義
3. プラットフォーム固有のコマンドでクリップボードからデータを取得
4. 標準出力にデータを出力

**関連システム・外部連携**：
- macOS: pbpaste
- Linux X11: xsel, xclip
- Linux Wayland: wl-paste
- Windows: powershell.exe Get-Clipboard, /dev/clipboard
- SSH: lemonade, doitclient
- tmux: tmux save-buffer

**権限による制御**：特にロールによる制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLIユーティリティ関数のため関連画面なし |

## 機能種別

クリップボード操作 / プラットフォーム抽象化 / ユーティリティ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | clippaste関数は引数を取らない | - |

### 入力データソース

- システムクリップボード

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 標準出力 | バイナリ/テキスト | クリップボードの内容 |
| 戻り値 | integer | 0: 成功、1: エラー（プラットフォーム非対応等） |

### 出力先

- 標準出力（クリップボードの内容）
- 標準エラー出力（エラーメッセージ）

## 処理フロー

### 処理シーケンス

```
1. 初回呼び出し時の処理
   └─ clipcopy/clippaste関数を未定義化
   └─ detect-clipboard関数を呼び出し
2. プラットフォーム検出（detect-clipboard）
   └─ 環境変数とコマンド存在チェックで判定
3. 関数再定義
   └─ 検出されたプラットフォームに応じたclippaste関数を定義
4. データ取得
   └─ プラットフォーム固有のコマンドでクリップボードから取得
   └─ 標準出力に出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{初回呼び出し?}
    B -->|Yes| C[clipcopy/clippaste を未定義化]
    C --> D[detect-clipboard 呼び出し]
    B -->|No| E[clippaste 実行]
    D --> F{プラットフォーム検出}
    F -->|macOS| G[pbpaste使用]
    F -->|Linux X11| H[xsel/xclip使用]
    F -->|Linux Wayland| I[wl-paste使用]
    F -->|Windows| J[Get-Clipboard/cat /dev/clipboard使用]
    F -->|SSH| K[lemonade/doitclient使用]
    F -->|tmux| L[tmux save-buffer使用]
    F -->|不明| M[リトライ or エラー]
    G --> N[clippaste再定義]
    H --> N
    I --> N
    J --> N
    K --> N
    L --> N
    N --> E
    E --> O[クリップボードからデータ取得]
    O --> P[標準出力に出力]
    P --> Q[終了]
    M --> R[エラー出力]
    R --> Q
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-60-1 | 遅延初期化 | 初回呼び出し時にプラットフォーム検出を行う | 初回呼び出し時 |
| BR-60-2 | プラットフォーム優先順位 | macOS > Cygwin/MSYS > WSL > Wayland > X11の順で検出 | 常時 |
| BR-60-3 | 標準出力 | 取得したデータは標準出力に出力される | 常時 |
| BR-60-4 | リトライ機能 | 検出失敗時、次回呼び出しで再検出を試みる | 初回検出失敗時 |
| BR-60-5 | 改行除去 | Wayland (wl-paste)では末尾の改行を除去する | Wayland環境 |

### 計算ロジック

プラットフォームごとのclippaste実装：
```zsh
# macOS
function clippaste() { pbpaste; }

# Cygwin/MSYS
function clippaste() { cat /dev/clipboard; }

# WSL
function clippaste() { powershell.exe -noprofile -command Get-Clipboard; }

# Wayland
function clippaste() { wl-paste --no-newline; }

# X11 xsel
function clippaste() { xsel --clipboard --output; }

# X11 xclip
function clippaste() { xclip -out -selection clipboard; }

# SSH lemonade
function clippaste() { lemonade paste; }

# SSH doitclient
function clippaste() { doitclient wclip -r; }

# win32yank
function clippaste() { win32yank -o; }

# Termux
function clippaste() { termux-clipboard-get; }

# tmux
function clippaste() { tmux save-buffer -; }
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | プラットフォーム非対応 | クリップボードコマンドが見つからない | xclip/xselのインストール、または環境変数の設定 |
| - | クリップボード空 | クリップボードにデータがない | 事前にデータをコピー |

### リトライ仕様

初回検出失敗時、次回呼び出しで再度detect-clipboardを実行する。

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

該当なし。

## パフォーマンス要件

クリップボードのデータサイズに比例した線形時間。

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

- クリップボードの内容は他のアプリケーションからも変更される可能性がある
- 機密情報がクリップボードに残っている可能性があることに注意
- SSH経由のクリップボード操作（lemonade/doitclient）はネットワーク経由でデータが送信される

## 備考

- clipcopy関数とペアで使用される
- detect-clipboard関数で実際の関数実装が動的に定義される
- Wayland環境では`--no-newline`オプションで末尾の改行を除去

---

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

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

### 推奨読解順序

#### Step 1: ファイル全体の構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | clipboard.zsh | `lib/clipboard.zsh` | ファイル全体の構成（1-108行目） |

**読解のコツ**: このファイルはclipcopyと共有される。clippaste固有の部分に注目：
1. コメント/ドキュメント（32-50行目）- clippaste使用方法
2. detect-clipboard関数内の各clippaste定義
3. 初期化用のスタブ関数（103-107行目）

#### Step 2: 使用方法のドキュメントを読む

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | clipboard.zsh | `lib/clipboard.zsh` | clippaste関連のコメント（32-50行目） |

**ドキュメントコメントの内容**:
- stdoutへの出力
- パイプラインでの使用例（`clippaste | grep foo`）
- ファイルへのリダイレクト（`clippaste > file.txt`）

#### Step 3: プラットフォームごとのclippaste実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | clipboard.zsh | `lib/clipboard.zsh` | detect-clipboard関数内のclippaste定義 |

**主要処理フロー**:
- **56行目**: macOS - `function clippaste() { pbpaste; }`
- **59行目**: Cygwin/MSYS - `function clippaste() { cat /dev/clipboard; }`
- **62行目**: WSL - `function clippaste() { powershell.exe -noprofile -command Get-Clipboard; }`
- **65行目**: Wayland - `function clippaste() { wl-paste --no-newline; }`
- **68行目**: X11 xsel - `function clippaste() { xsel --clipboard --output; }`
- **71行目**: X11 xclip - `function clippaste() { xclip -out -selection clipboard; }`
- **74行目**: lemonade - `function clippaste() { lemonade paste; }`
- **77行目**: doitclient - `function clippaste() { doitclient wclip -r; }`
- **80行目**: win32yank - `function clippaste() { win32yank -o; }`
- **83行目**: Termux - `function clippaste() { termux-clipboard-get; }`
- **86行目**: tmux - `function clippaste() { tmux save-buffer -; }`

#### Step 4: 初期化処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | clipboard.zsh | `lib/clipboard.zsh` | スタブ関数（103-107行目） |

**主要処理フロー**:
- clipcopyと同じスタブ関数でclippasteも初期化される
- `function clipcopy clippaste {` で両方同時に定義

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

```
clippaste() [初回呼び出し]
    │
    ├─ unfunction clipcopy clippaste
    │
    ├─ detect-clipboard()
    │       │
    │       ├─ [macOS] → clippaste() { pbpaste }
    │       ├─ [Cygwin] → clippaste() { cat /dev/clipboard }
    │       ├─ [WSL] → clippaste() { powershell.exe Get-Clipboard }
    │       ├─ [Wayland] → clippaste() { wl-paste --no-newline }
    │       ├─ [X11] → clippaste() { xsel/xclip }
    │       ├─ [SSH] → clippaste() { lemonade/doitclient }
    │       ├─ [tmux] → clippaste() { tmux save-buffer }
    │       └─ [不明] → _retry_clipboard_detection_or_fail
    │
    └─ "$0" "$@" [再定義されたclippasteを呼び出し]
            │
            └─ プラットフォーム固有のコマンド実行
```

### データフロー図

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

システム            プラットフォーム固有
クリップボード ─────▶ コマンド実行 ─────────▶ 標準出力
                           │
                           ├─ pbpaste
                           ├─ cat /dev/clipboard
                           ├─ powershell.exe Get-Clipboard
                           ├─ wl-paste
                           ├─ xsel/xclip
                           ├─ lemonade paste
                           ├─ doitclient wclip -r
                           ├─ win32yank -o
                           ├─ termux-clipboard-get
                           └─ tmux save-buffer -
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| clipboard.zsh | `lib/clipboard.zsh` | ソース | clipcopy/clippaste関数およびdetect-clipboard関数の定義 |
| oh-my-zsh.sh | `oh-my-zsh.sh` | ソース | lib/clipboard.zshを読み込むエントリポイント |
