# 通知設計書 8-spacevim#debugging#InfoToClipboard

## 概要

本ドキュメントは、space-vimにおけるデバッグ情報クリップボードコピー通知関数 `spacevim#debugging#InfoToClipboard` の通知仕様を定義するものである。

### 本通知の処理概要

`spacevim#debugging#InfoToClipboard` は、space-vimのデバッグ情報をクリップボードにコピーし、コピー完了をユーザーに通知する関数である。内部で `spacevim#debugging#Info` を呼び出し、その出力をクリップボードレジスタに保存する。

**業務上の目的・背景**：space-vimで問題が発生した際、ユーザーがGitHub issueで問題を報告することがある。その際、環境情報や設定情報を正確に共有することが重要である。この関数により、デバッグ情報をワンクリックでクリップボードにコピーでき、issueへの貼り付けが容易になる。手動でのコピー操作の手間を省き、情報の正確性を保証する。

**通知の送信タイミング**：ユーザーがこの関数を呼び出す適切なコマンドを実行した際に通知が送信される。クリップボードへのコピーが完了した直後に通知される。

**通知の受信者**：Vimエディタを操作しているユーザー本人がメッセージの受信者となる。メッセージはVimのコマンドライン領域に表示される。

**通知内容の概要**：「[space-vim] space-vim info copied to your clipboard」というメッセージが表示され、情報がクリップボードにコピーされたことを通知する。

**期待されるアクション**：ユーザーはクリップボードの内容をGitHub issue、Slack、メールなどに貼り付けて、問題の報告や情報共有を行う。

## 通知種別

アプリ内通知（Vimコマンドライン表示）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低 |
| リトライ | 無し |

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

現在Vimエディタを操作しているユーザーのコマンドライン領域に直接表示される。特別な送信先決定ロジックは存在しない。

## 通知テンプレート

### アプリ内通知の場合

| 項目 | 内容 |
|-----|------|
| 表示位置 | Vimコマンドライン領域 |
| ハイライト | Type（プレフィックス）、Function（space-vim info）、Normal（メッセージ本文） |
| プレフィックス | [space-vim] |
| 形式 | テキスト |

### 本文テンプレート

```
[space-vim] space-vim info copied to your clipboard
```

### 添付ファイル

該当なし

## テンプレート変数

該当なし（固定メッセージ）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | spacevim#debugging#InfoToClipboard()の呼び出し | 常時（呼び出されたら実行） | ユーザーが手動で関数を呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | 関数が呼び出された場合は常に表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[InfoToClipboard呼び出し] --> B[redir => l:output開始]
    B --> C[spacevim#debugging#Info呼び出し]
    C --> D[出力をl:outputに格納]
    D --> E[redir END]
    E --> F[let @+ = l:output]
    F --> G[クリップボードにコピー完了]
    G --> H[成功メッセージ表示]
    H --> I[終了]
```

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

### 参照テーブル一覧

該当なし（spacevim#debugging#Info関数を呼び出し）

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| @+ | UPDATE | クリップボードレジスタに情報を書き込み |

#### クリップボードレジスタ

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | @+ | spacevim#debugging#Infoの出力 | システムクリップボード |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| クリップボード非対応 | +clipboardがないVim | エラーは発生しないが、@+への書き込みが無効 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（Vimが起動している間は常に表示可能）

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

- クリップボードにコピーされる情報にはファイルパスや設定値が含まれる
- クリップボードは他のアプリケーションからもアクセス可能なため、機密情報が含まれていないか確認が必要
- 外部への自動送信は行わない（ユーザーが手動で貼り付ける必要がある）

## 備考

- `redir` コマンドを使用して `spacevim#debugging#Info` の出力をキャプチャする
- `silent` キーワードで呼び出し時の表示を抑制し、出力のみをキャプチャする
- `@+` レジスタはシステムクリップボードを表す（+clipboardオプションが必要）
- メッセージには3種類のハイライトグループが使用され、視覚的に区別される

---

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

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

### 推奨読解順序

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

本関数は文字列出力をキャプチャしてクリップボードに格納する。データ構造は単純な文字列である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | debugging.vim | `core/autoload/spacevim/debugging.vim` | redirコマンドの使い方を確認 |

**読解のコツ**: Vim scriptの `redir => var` は以降のコマンド出力を変数にリダイレクトする。`redir END` でリダイレクトを終了する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | debugging.vim | `core/autoload/spacevim/debugging.vim` | spacevim#debugging#InfoToClipboard関数の定義（41-50行目） |

**主要処理フロー**:
1. **41行目**: `function! spacevim#debugging#InfoToClipboard() abort` - 関数定義
2. **42行目**: `redir => l:output` - 出力リダイレクト開始
3. **43行目**: `silent call spacevim#debugging#Info()` - Info関数をsilentで呼び出し
4. **44行目**: `redir END` - リダイレクト終了
5. **46行目**: `let @+ = l:output` - クリップボードにコピー
6. **47-49行目**: 成功メッセージを表示

#### Step 3: 通知メッセージの構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | debugging.vim | `core/autoload/spacevim/debugging.vim` | 成功メッセージの表示処理（47-49行目） |

**主要処理フロー**:
- **47行目**: `echohl Type | echo '[space-vim] ' | echohl NONE` - プレフィックス表示（Typeハイライト）
- **48行目**: `echohl Function | echon 'space-vim info' | echohl NONE` - 情報名表示（Functionハイライト）
- **49行目**: `echohl Normal | echon ' copied to your clipboard' | echohl NONE` - メッセージ本文表示（Normalハイライト）

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

```
spacevim#debugging#InfoToClipboard()
    │
    ├─ redir => l:output
    │      └─ 出力リダイレクト開始
    │
    ├─ silent call spacevim#debugging#Info()
    │      └─ デバッグ情報を生成（出力は l:output に格納）
    │
    ├─ redir END
    │      └─ リダイレクト終了
    │
    ├─ let @+ = l:output
    │      └─ システムクリップボードに書き込み
    │
    └─ echohl + echo/echon
           └─ 成功メッセージ表示（3種類のハイライト使用）
```

### データフロー図

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

なし ───▶ InfoToClipboard呼び出し
                    │
                    ▼
           spacevim#debugging#Info()
                    │
                    ▼
              出力キャプチャ
                    │
          ┌─────────┴─────────┐
          │                   │
          ▼                   ▼
   @+ レジスタ           成功メッセージ
   （クリップボード）    （コマンドライン）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| debugging.vim | `core/autoload/spacevim/debugging.vim` | ソース | Info/InfoToClipboard関数の実装 |
