# 機能設計書 61-サラウンド操作

## 概要

本ドキュメントは、space-vimにおけるサラウンド操作機能の設計について記載する。vim-surroundプラグインによる囲み文字（括弧、引用符、HTMLタグ等）の追加・変更・削除操作を提供する機能である。

### 本機能の処理概要

サラウンド操作機能は、テキストオブジェクトの周囲を囲む文字を効率的に操作するための機能を提供する。コード編集時に頻繁に必要となる括弧や引用符の追加・変更・削除を、少ないキーストロークで実現する。

**業務上の目的・背景**：プログラミングにおいて、文字列の引用符変更（シングルクォートからダブルクォートへの変更等）や、関数呼び出しの括弧追加、HTMLタグの編集は日常的に発生する作業である。従来の方法では、手動で文字を削除・挿入する必要があり、時間がかかり誤りも発生しやすかった。この機能により、セマンティックな操作として囲み文字を扱えるようになり、編集効率が大幅に向上する。

**機能の利用シーン**：
- 文字列リテラルの引用符タイプを変更する場合（'hello' を "hello" に変換）
- 変数や式に括弧を追加する場合（variable を (variable) に変換）
- HTMLタグの変更や削除を行う場合（`<div>text</div>` を `<span>text</span>` に変換）
- 関数呼び出しから引数部分だけを取り出す場合

**主要な処理内容**：
1. `ys{motion}{char}` - 指定したモーションで選択されるテキストを指定文字で囲む
2. `cs{old}{new}` - 既存の囲み文字を別の文字に変更する
3. `ds{char}` - 指定した囲み文字を削除する
4. `S{char}` - ビジュアルモードで選択したテキストを指定文字で囲む

**関連システム・外部連携**：tpope/vim-surroundプラグインにより全機能が提供される。space-vimの+programming/editingレイヤーの一部として自動的にインストールされる。

**権限による制御**：特になし。すべてのユーザーが利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | テキストエディタ全般 | 主画面 | 編集中のテキストに対してサラウンド操作を実行 |

## 機能種別

テキスト編集操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| motion | キーストローク | Yes（ysコマンド時） | テキストオブジェクトを指定するモーション | Vim標準のモーションコマンド |
| old_char | 文字 | Yes（cs/dsコマンド時） | 変更/削除対象の囲み文字 | 対応する囲み文字が存在すること |
| new_char | 文字 | Yes（ys/cs/Sコマンド時） | 新しく追加する囲み文字 | サポートされる囲み文字であること |

### 入力データソース

キーボード入力（ノーマルモード/ビジュアルモードのコマンド）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 変更後テキスト | String | サラウンド操作が適用されたテキスト |

### 出力先

編集中のバッファ（テキストファイル）

## 処理フロー

### 処理シーケンス

```
1. ユーザーがサラウンドコマンドを入力
   └─ ys/cs/ds/S のいずれかで開始

2. コマンドタイプの判定
   └─ ys: 追加、cs: 変更、ds: 削除、S: ビジュアル選択囲み

3. 対象範囲の特定
   └─ ys: モーションで範囲決定
   └─ cs/ds: 指定文字のペアを検索
   └─ S: ビジュアル選択範囲

4. 囲み文字の処理
   └─ 削除または追加/変更処理を実行

5. カーソル位置の調整
   └─ 操作後の適切な位置にカーソルを移動
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド入力開始] --> B{コマンドタイプ}
    B -->|ys| C[モーション入力待ち]
    B -->|cs| D[変更元文字入力待ち]
    B -->|ds| E[削除対象文字入力待ち]
    B -->|S| F[ビジュアル選択確認]
    C --> G[新しい囲み文字入力]
    D --> H[新しい囲み文字入力]
    E --> I[囲み文字を削除]
    F --> G
    G --> J[囲み文字を追加]
    H --> K[囲み文字を変更]
    I --> L[完了]
    J --> L
    K --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 括弧の対応 | 開き括弧を指定すると対応する閉じ括弧が自動的に使用される | ys/cs/Sコマンド時 |
| BR-02 | スペース処理 | `(`と`)`は内側にスペースを追加、`b`と`)`は追加しない | 括弧系文字指定時 |
| BR-03 | タグ対応 | `t`でHTMLタグ操作、`<`で新しいタグ入力を促す | HTMLタグ操作時 |

### 計算ロジック

特になし（テキスト操作のみ）

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

該当なし（ファイルバッファ操作のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 対象なし | ds/csで指定した囲み文字がカーソル周辺に存在しない | 何も実行されず、ベル音が鳴る |
| - | 無効なモーション | ysで無効なモーションを指定 | コマンドがキャンセルされる |

### リトライ仕様

特になし（undo/redoで操作の取り消し・再実行が可能）

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

Vimのundo履歴に1操作として記録される。`u`コマンドで元に戻すことが可能。

## パフォーマンス要件

即時実行（ユーザーが知覚できる遅延なし）

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

特になし

## 備考

- vim-surroundはVimの標準的なテキストオブジェクト概念を拡張する
- `.`コマンドによる繰り返しが可能
- カスタムサラウンドの定義も可能（`let g:surround_*`）

---

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

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

### 推奨読解順序

#### Step 1: プラグイン登録を理解する

vim-surroundプラグインがどのように登録されているかを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | packages.vim | `layers/+programming/editing/packages.vim` | vim-surroundの登録方法を確認 |

**読解のコツ**: `MP`マクロはspace-vim独自のプラグイン登録関数。引数なしで即時ロードされる。

**主要処理フロー**:
1. **1行目**: `MP 'tpope/vim-surround'` でプラグインを登録

#### Step 2: レイヤー構成を理解する

editingレイヤーの全体構成を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | config.vim | `layers/+programming/editing/config.vim` | 他の編集系プラグインとの関係を確認 |

**主要処理フロー**:
- **1-9行目**: nerdcommenterの設定
- **11-16行目**: vim-multiple-cursorsの設定（別機能）
- vim-surroundはデフォルト設定で使用されるため、専用の設定はない

#### Step 3: レイヤーマニフェストを確認する

レイヤー全体の構成を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | LAYERS.md | `layers/LAYERS.md` | editingレイヤーに含まれるプラグイン一覧を確認 |

**主要処理フロー**:
- **44行目**: editingレイヤーにvim-surroundが含まれることを確認

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

```
space-vim起動
    │
    └─ spacevim#bootstrap()
           │
           └─ +programming/editing レイヤー読み込み
                  │
                  ├─ packages.vim
                  │      └─ MP 'tpope/vim-surround'
                  │
                  └─ vim-plug によるプラグインロード
                         │
                         └─ vim-surround 初期化
                                │
                                └─ サラウンドマッピング有効化
                                       (ys, cs, ds, S)
```

### データフロー図

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

ysコマンド                vim-surround                   囲み文字追加済み
 + モーション      ───▶   プラグイン処理    ───▶         テキスト
 + 囲み文字

csコマンド                vim-surround                   囲み文字変更済み
 + 元の文字        ───▶   プラグイン処理    ───▶         テキスト
 + 新しい文字

dsコマンド                vim-surround                   囲み文字削除済み
 + 削除対象文字    ───▶   プラグイン処理    ───▶         テキスト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| packages.vim | `layers/+programming/editing/packages.vim` | 設定 | プラグイン登録 |
| config.vim | `layers/+programming/editing/config.vim` | 設定 | レイヤー設定 |
| LAYERS.md | `layers/LAYERS.md` | ドキュメント | レイヤー一覧 |
| vim-surround | 外部プラグイン（tpope/vim-surround） | プラグイン | 機能本体 |
