# 機能設計書 5-実装へジャンプ

## 概要

本ドキュメントは、Clojure LSP サーバーにおける実装へジャンプ機能の設計仕様を記載する。この機能は LSP プロトコルの `textDocument/implementation` リクエストに対応し、プロトコルやインターフェースの実装位置への移動を実現する。

### 本機能の処理概要

**業務上の目的・背景**：Clojure では defprotocol や defmulti を使用してポリモーフィズムを実現する。プロトコルメソッドや defmulti から、その具体的な実装（extend-type、defmethod 等）を素早く見つけることは、大規模なプロジェクトのコード理解において非常に重要である。本機能は、インターフェース定義から全ての実装位置を一覧表示し、効率的なコードナビゲーションを支援する。

**機能の利用シーン**：開発者が defprotocol のメソッド定義、defmulti 定義、またはこれらの使用箇所にカーソルを置き、「実装へジャンプ」コマンドを実行した際に本機能が呼び出される。プロジェクト全体から該当する全ての実装位置がリスト表示される。

**主要な処理内容**：
1. カーソル位置のシンボル要素を特定
2. 要素の種類（var-definitions または var-usages）に応じた実装検索
3. protocol-impls または defmethod の使用箇所を全て収集
4. 実装位置のリストを Location 配列として返却

**関連システム・外部連携**：特になし

**権限による制御**：本機能に権限による実行制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 該当なし | - | 本プロジェクトは LSP サーバー実装であり、UI 画面は存在しない。エディタの実装ジャンプ機能から呼び出される。 |

## 機能種別

データ検索処理 / ナビゲーション処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| text-document.uri | string | Yes | 対象ドキュメントの URI | 有効な file:// URI |
| position.line | integer | Yes | カーソル行位置（0-indexed） | 0 以上 |
| position.character | integer | Yes | カーソル列位置（0-indexed） | 0 以上 |

### 入力データソース

- clj-kondo による静的解析結果（db の :analysis）
- 依存グラフ（:dep-graph）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (配列) | Location[] | 実装位置のリスト |
| [].uri | string | 実装位置のドキュメント URI |
| [].range | Range | 実装位置の範囲 |

### 出力先

LSP プロトコルを通じてエディタクライアントへ Location 配列として返却

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ handlers/implementation が textDocument/implementation を受信

2. カーソル位置の要素特定
   └─ q/find-element-under-cursor でカーソル下の要素を取得

3. 実装検索
   └─ q/find-implementations (multimethod) で要素種別に応じた検索

4. 位置変換
   └─ 各要素を element->location で Location に変換

5. レスポンス返却
   └─ Location 配列を返却
```

### フローチャート

```mermaid
flowchart TD
    A[implementation リクエスト受信] --> B[find-element-under-cursor]
    B --> C{要素あり?}
    C -->|No| D[空配列返却]
    C -->|Yes| E{要素の bucket?}
    E -->|var-definitions| F{defined-by?}
    E -->|var-usages| G{defmethod?}
    E -->|その他| H[空配列返却]
    F -->|defprotocol| I[protocol-impls 検索]
    F -->|defmulti| J[defmethod 使用箇所検索]
    F -->|その他| K[空配列返却]
    G -->|Yes| L[他の defmethod 検索]
    G -->|No| M[protocol-impls + defmethod 検索]
    I --> N[Location 配列生成]
    J --> N
    L --> N
    M --> N
    N --> O[Location 配列返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | プロトコルメソッド | defprotocol で :protocol-name があれば protocol-impls を検索 | var-definitions + defprotocol |
| BR-02 | プロトコル名 | defprotocol/definterface で protocol-name がなければ var-usages を検索 | var-definitions + defprotocol |
| BR-03 | defmulti | defmulti 定義からは :defmethod フラグ付きの var-usages を検索 | var-definitions + defmulti |
| BR-04 | defmethod 間ナビゲーション | defmethod 使用箇所から他の defmethod を検索 | var-usages + :defmethod |
| BR-05 | 言語一致 | 同じ言語（clj/cljs）の実装を優先 | 全検索 |
| BR-06 | 重複除去 | uri, name, row, col で重複を除去 | 全結果 |

### 計算ロジック

- 実装検索: find-implementations マルチメソッドにより、要素の :bucket と :defined-by に応じた検索を実行
- 検索範囲: ns-and-dependents-analysis により、対象名前空間とその依存者を検索

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 要素検索 | db :analysis | SELECT | カーソル位置の要素を検索 |
| 実装検索 | db :analysis | SELECT | 依存者を含む広範囲から実装を検索 |

### テーブル別操作詳細

#### db :analysis

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | :protocol-impls | :protocol-ns, :method-name でマッチング | プロトコル実装検索 |
| SELECT | :var-usages | :to, :name, :defmethod でマッチング | defmethod 検索 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 空配列返却 | カーソル位置に要素がない | 空配列を返却 |
| - | 空配列返却 | 実装が見つからない | 空配列を返却 |
| - | 空配列返却 | :clj-kondo/unknown-namespace の場合 | 空配列を返却 |

### リトライ仕様

リトライは行わない。

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

本機能は読み取り専用であり、トランザクション管理は不要。

## パフォーマンス要件

- 応答時間: 通常 100ms 以内
- 依存者全体を検索するため、大規模プロジェクトでは時間がかかる可能性あり

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

- 外部ネットワーク通信なし
- ファイルシステムアクセスは解析対象ファイルのみ

## 備考

- defprotocol、definterface、defmulti の定義に対してのみ実装検索が有効
- 通常の関数定義からの呼び出し元検索は「参照検索」機能を使用

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | queries.clj | `lib/src/clojure_lsp/queries.clj` | find-implementations defmulti（413-415行目）で実装検索の分岐を確認 |

**読解のコツ**: :defined-by フィールドで定義元（defprotocol, defmulti 等）を判定している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | handlers.clj | `lib/src/clojure_lsp/handlers.clj` | implementation 関数（304-310行目）が LSP リクエストのエントリーポイント |

**主要処理フロー**:
1. **306-307行目**: position を row, col に変換
2. **309行目**: q/find-implementations-from-cursor を呼び出し
3. **310行目**: mapv で各要素を element->location に変換

#### Step 3: 実装検索のマルチメソッドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | queries.clj | `lib/src/clojure_lsp/queries.clj` | find-implementations defmulti（413-415行目）で分岐ポイントを確認 |
| 3-2 | queries.clj | `lib/src/clojure_lsp/queries.clj` | var-definitions の実装検索（417-448行目） |
| 3-3 | queries.clj | `lib/src/clojure_lsp/queries.clj` | var-usages の実装検索（450-472行目） |
| 3-4 | queries.clj | `lib/src/clojure_lsp/queries.clj` | default（474行目）で空配列返却 |

**主要処理フロー**:
- **419-426行目**: defprotocol + :protocol-name の場合は protocol-impls を検索
- **428-432行目**: defprotocol/definterface で protocol-name なしの場合は var-usages を検索
- **434-438行目**: defmulti の場合は :defmethod フラグ付き var-usages を検索
- **454-466行目**: var-usages の場合は protocol-impls と defmethod を両方検索

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

```
handlers/implementation
    │
    ├─ shared/position->row-col
    │
    └─ q/find-implementations-from-cursor
           │
           ├─ q/find-element-under-cursor
           │
           └─ q/find-implementations (multimethod)
                  │
                  ├─ :var-definitions
                  │      ├─ (defprotocol + protocol-name)
                  │      │      └─ xf-analysis->protocol-impls
                  │      ├─ (defprotocol/definterface)
                  │      │      └─ xf-analysis->var-usages
                  │      └─ (defmulti)
                  │             └─ xf-analysis->var-usages + :defmethod
                  │
                  ├─ :var-usages
                  │      └─ protocol-impls + defmethod 検索
                  │
                  └─ :default
                         └─ 空配列返却
```

### データフロー図

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

textDocument/implementation ──▶ handlers/implementation ──▶ Location[]
  - uri                          │
  - position (line, char)        ▼
                            find-implementations-from-cursor
                                 │
                                 ├──▶ find-element-under-cursor
                                 │      └─ db :analysis[uri]
                                 │
                                 ├──▶ find-implementations (multimethod)
                                 │      └─ ns-and-dependents-analysis
                                 │         (protocol-impls, var-usages)
                                 │
                                 └──▶ mapv element->location
                                        │
                                        ▼
                                   Location[] {uri, range}
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| handlers.clj | `lib/src/clojure_lsp/handlers.clj` | ソース | LSP リクエストハンドラー（implementation 関数） |
| queries.clj | `lib/src/clojure_lsp/queries.clj` | ソース | 実装検索のマルチメソッド（find-implementations） |
| dep_graph.clj | `lib/src/clojure_lsp/dep_graph.clj` | ソース | 依存グラフによる検索範囲計算 |
| shared.clj | `lib/src/clojure_lsp/shared.clj` | ソース | 位置変換ユーティリティ |
| implementation_test.clj | `cli/integration-test/integration/implementation_test.clj` | テスト | 統合テスト |
