# 機能設計書 13-補完アイテム解決 (completionItem/resolve)

## 概要

本ドキュメントは、serve-d LSPサーバーにおける「補完アイテム解決」機能の設計を記述する。LSPの `completionItem/resolve` リクエストを処理し、補完候補の詳細情報を遅延解決する機能である。

### 本機能の処理概要

補完リストで選択された候補アイテムについて、スニペットの解決、自動インポートの追加テキスト編集生成、dfmtによるコードフォーマットなどの詳細情報を遅延的に解決して返却する。

**業務上の目的・背景**：補完候補リストの生成時にすべての詳細情報を計算すると応答が遅延するため、LSPプロトコルではアイテム選択時に詳細情報を遅延解決する仕組みが提供されている。本機能はこの仕組みを活用し、スニペットの最終形解決、自動インポート文の挿入編集の生成、コードフォーマットの適用を、ユーザーがアイテムを選択した時点で実行する。

**機能の利用シーン**：開発者が補完候補リストからアイテムを選択（ホバーまたはハイライト）した際に自動的にトリガーされる。特にスニペットのプレビュー表示時や、自動インポートが必要な補完候補の詳細確認時に利用される。

**主要な処理内容**：
1. 補完アイテムのdata属性からメタデータ（URI、位置、インポート情報、フォーマット情報）を抽出
2. 未解決スニペットの場合、SnippetsComponentで最終形を解決
3. 自動インポート情報がある場合、ImporterComponentで挿入編集を生成
4. フォーマット情報がある場合、dfmt引数でコードを整形

**関連システム・外部連携**：SnippetsComponent、ImporterComponent、dfmt（コードフォーマッタ）

**権限による制御**：特になし。補完候補のdata属性の内容に応じて処理が分岐する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 18 | 補完アイテム解決（completionItem/resolve） | 主機能 | 選択された補完アイテムの詳細情報を遅延解決する |

## 機能種別

データ変換処理 / コードフォーマット

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| item | CompletionItem | Yes | 解決対象の補完アイテム | - |
| item.data | JsonValue | No | 遅延解決用メタデータ | オブジェクト型 |
| item.data.uri | string | No | ドキュメントURI | - |
| item.data.line | int | No | 補完要求時の行番号 | - |
| item.data.column | int | No | 補完要求時の列番号 | - |
| item.data.resolved | bool | No | スニペット解決済みフラグ | - |
| item.data.imports | JsonValue[] | No | 追加インポートモジュール名リスト | - |
| item.data.format | string | No | dfmtフォーマット引数（タブ区切り） | - |
| item.data.level | string | No | スニペットレベル（global/method/value） | - |

### 入力データソース

LSPクライアントからの `completionItem/resolve` リクエスト（補完候補アイテム）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (CompletionItem) | CompletionItem | 解決済みの補完アイテム |
| additionalTextEdits | TextEdit[] | 自動インポート文の挿入編集（ある場合） |
| insertText | string | フォーマット適用済みの挿入テキスト |

### 出力先

LSPクライアントへのレスポンスメッセージ

## 処理フロー

### 処理シーケンス

```
1. CompletionItem の data 属性を確認
   └─ data が None の場合、そのまま返却
2. data からメタデータ（uri, line, column等）を抽出
3. スニペット解決（resolved == false の場合）
   3-1. SnippetsComponent でスニペットを最終形に解決
   3-2. 解決結果を CompletionItem に反映
4. 自動インポート解決（imports がある場合）
   4-1. ImporterComponent で各モジュールのインポート文テキスト編集を生成
   4-2. additionalTextEdits に追加
   4-3. ソート順で編集を整理（後方から前方へ）
5. フォーマット適用（format がある場合）
   5-1. snippet 形式の場合: formatSnippet で整形
   5-2. plainText 形式の場合: formatCode で整形
6. 解決済み CompletionItem を返却
```

### フローチャート

```mermaid
flowchart TD
    A[completionItem/resolve 受信] --> B{data が None?}
    B -->|Yes| C[そのまま返却]
    B -->|No| D[メタデータ抽出]
    D --> E{resolved == false?}
    E -->|Yes| F[SnippetsComponent.resolveSnippet]
    E -->|No| G{imports あり?}
    F --> G
    G -->|Yes| H[ImporterComponent.add でインポート編集生成]
    G -->|No| I{format あり?}
    H --> I
    I -->|Yes| J{snippet形式?}
    I -->|No| K[CompletionItem 返却]
    J -->|Yes| L[formatSnippet適用]
    J -->|No| M[formatCode適用]
    L --> K
    M --> K
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-13-01 | スニペット遅延解決 | resolved=falseのスニペットはSnippetsComponentで解決する | data.resolved == false |
| BR-13-02 | 自動インポート編集生成 | imports配列のモジュールに対しインポート文挿入編集を生成する | data.imports が存在 |
| BR-13-03 | 編集ソート順 | additionalTextEditsは開始位置の降順でソートする | 編集追加後 |
| BR-13-04 | フォーマット分岐 | insertTextFormatに応じてformatSnippetまたはformatCodeを使用する | data.format が存在 |

### 計算ロジック

特になし

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンポーネント不在 | SnippetsComponent/ImporterComponent未ロード | 該当処理をスキップ |
| - | データ不整合 | data属性のキーが不足 | 処理をスキップしアイテムをそのまま返却 |

### リトライ仕様

リトライなし。

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

トランザクション管理なし。

## パフォーマンス要件

補完アイテム選択時のリアルタイム処理。スニペット解決はgetYieldで非同期結果を取得。

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

特になし。

## 備考

- data属性はtextDocument/completionレスポンスで設定されたもの
- additionalTextEditsのソートは `sort!"a.range.start>b.range.start"` で行う（後方の編集を先に適用するため）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | complete.d | `source/served/commands/complete.d` | `snippetToCompletionItem`（1021-1050行目）と`snippetFromCompletionItem`（1052-1081行目）でdata属性の構造を理解する |

**読解のコツ**: data属性はJsonValueのオブジェクトで、"resolved", "id", "providerId", "data" 等のキーを持つ。スニペット用とインポート用で異なる構造を持つ。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | complete.d | `source/served/commands/complete.d` | `resolveCompletionItem`関数（940-1019行目）がエントリーポイント |

**主要処理フロー**:
1. **940行目**: `@protocolMethod("completionItem/resolve")` でLSPメソッド登録
2. **943-951行目**: data属性からuri, line, column等を抽出
3. **963-973行目**: 未解決スニペットの解決（resolveSnippet呼び出し）
4. **975-994行目**: 自動インポートの追加テキスト編集生成
5. **997-1011行目**: dfmtフォーマットの適用（snippet/plainTextで分岐）

#### Step 3: スニペット変換ユーティリティ

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | complete.d | `source/served/commands/complete.d` | `snippetToCompletionItem`（1021行目）と`snippetFromCompletionItem`（1052行目）の変換ロジック |
| 3-2 | format.d | `source/served/commands/format.d` | `formatCode`と`formatSnippet`関数のフォーマット処理 |

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

```
resolveCompletionItem (complete.d:941)
    │
    ├─ snippetFromCompletionItem (complete.d:1052)
    │      └─ Snippet構造体への変換
    │
    ├─ SnippetsComponent.resolveSnippet
    │      └─ snippetToCompletionItem (complete.d:1021)
    │
    ├─ ImporterComponent.add
    │      └─ TextEdit[] 生成
    │
    └─ formatSnippet / formatCode (format.d)
```

### データフロー図

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

CompletionItem ──────▶ resolveCompletionItem ──────────▶ CompletionItem (解決済み)
  └─ data: {             │                                    ├─ insertText (フォーマット済み)
       uri, line,        ├── SnippetsComponent ──▶ snippet解決  └─ additionalTextEdits
       column,           ├── ImporterComponent ──▶ import編集         (インポート文挿入)
       imports,          └── formatSnippet/Code ──▶ 整形
       format
     }
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| complete.d | `source/served/commands/complete.d` | ソース | resolveCompletionItem, snippet変換関数 |
| format.d | `source/served/commands/format.d` | ソース | formatCode, formatSnippet関数 |
| extension.d | `source/served/extension.d` | ソース | コマンド登録・エクスポート |
