# 機能設計書 53-インポート追加

## 概要

本ドキュメントは、serve-dのLSPカスタムリクエスト `served/addImport` の機能設計を記述する。ソースコードにインポート文を追加するためのテキスト編集を生成する機能である。

### 本機能の処理概要

**業務上の目的・背景**：D言語の開発では、モジュールをimport文で明示的にインポートする必要がある。コードアクション（No.26）や自動補完（No.15）と連携して、未インポートのモジュールを自動的にインポート文として追加する編集を生成することで、開発者の手作業を削減する。

**機能の利用シーン**：コードアクションで「このモジュールをインポート」を選択した場合や、自動補完で未インポートのシンボルを選択した場合に、適切な位置にインポート文を挿入するテキスト編集が生成される。

**主要な処理内容**：
1. クライアントから `served/addImport` リクエストを受信する
2. テキストドキュメントを取得し、カーソル位置をバイトオフセットに変換する
3. ImporterComponentの `add` メソッドを呼び出してインポート追加のテキスト編集を生成する
4. 生成されたテキスト編集を返却する

**関連システム・外部連携**：workspace-dサブパッケージのImporterComponentに処理を委譲する。テキストドキュメントマネージャからドキュメントのrawTextを取得する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 53 | インポート追加（served/addImport） | 主画面 | ソースコードにインポート文を追加するためのテキスト編集を生成する |

## 機能種別

テキスト編集生成処理（インポート文の追加位置決定と編集生成）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| textDocument | TextDocumentIdentifier | Yes | 対象のテキストドキュメント識別子（URI） | ドキュメントマネージャに存在すること |
| name | string | Yes | 追加するインポート名（例: "std.stdio"） | なし |
| location | int | Yes | カーソル位置の標準オフセット | なし |
| insertOutermost | bool | No | trueの場合、最も外側のブロックにインポートを追加する。デフォルトtrue | なし |

### 入力データソース

LSPクライアントからのJSON-RPCリクエスト（AddImportParams構造体）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | auto（ImporterComponent.addの返却型） | インポート文を追加するためのテキスト編集情報 |

### 出力先

LSPクライアントへのJSON-RPCレスポンス

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ AddImportParamsとしてデシリアライズ
2. ドキュメント取得
   └─ documents[params.textDocument.uri] でテキストドキュメントを取得
3. オフセット変換
   └─ document.offsetToBytes(params.location) でカーソル位置をバイトオフセットに変換
4. インポート追加編集生成
   └─ backend.get!ImporterComponent.add(name, rawText, offset, insertOutermost) を呼出
5. 結果返却
   └─ テキスト編集情報を返却
```

### フローチャート

```mermaid
flowchart TD
    A[served/addImport リクエスト受信] --> B[テキストドキュメント取得]
    B --> C[カーソル位置をバイトオフセットに変換]
    C --> D[ImporterComponent.add を呼出]
    D --> E[テキスト編集情報を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-53-01 | デフォルト最外挿入 | insertOutermostがデフォルトtrueであり、明示的に指定しない限り最も外側のブロックにインポートが追加される | 常時 |
| BR-53-02 | バイトオフセット変換 | クライアントから受け取ったキャラクタオフセットをバイトオフセットに変換してImporterComponentに渡す | 常時 |
| BR-53-03 | イミュータブルコピー | name パラメータは `.idup` により不変コピーが作成される | 常時 |

### 計算ロジック

特になし。ImporterComponentがインポート文の挿入位置を計算する。

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

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

本機能はデータベースを使用しない。テキストドキュメントの内容を解析してテキスト編集を生成する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 例外 | 指定されたURIのドキュメントが見つからない場合 | ドキュメントマネージャの例外処理に委譲 |

### リトライ仕様

リトライは不要。

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

トランザクション管理は不要。テキスト編集の生成のみで、ドキュメントの直接変更は行わない。

## パフォーマンス要件

即時応答が期待される。ドキュメントの解析処理はインメモリで行われる。

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

特になし。

## 備考

- 本機能はコードアクション（No.26）や自動インポート補完（No.15）から内部的に呼び出されることもある
- `name.idup` によりstring型の不変コピーが作成されるのは、D言語のスライスの安全性確保のため
- InsertOutermostのデフォルトがtrueであるため、通常はファイルのトップレベルスコープにインポートが追加される

---

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

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

### 推奨読解順序

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

AddImportParams構造体のフィールドを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protoext.d | `source/served/lsp/protoext.d` | AddImportParams構造体（12-22行目）のフィールド定義。textDocument, name, location, insertOutermostの各フィールドを確認 |

**読解のコツ**: `@serdeOptional bool insertOutermost = true` はmir.serdeのデシリアライズ時にフィールドが省略された場合のデフォルト値を指定する。

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

addImport関数の実装を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | dub.d | `source/served/commands/dub.d` | addImport関数（204-210行目）のエントリーポイント |

**主要処理フロー**:
1. **204行目**: `@protocolMethod("served/addImport")` - LSPメソッド登録
2. **205行目**: `auto addImport(AddImportParams params)` - auto戻り値型（ImporterComponent.addの返却型を推論）
3. **207行目**: `documents[params.textDocument.uri]` - テキストドキュメントの取得
4. **208行目**: `backend.get!ImporterComponent.add(...)` - ImporterComponentへの委譲
5. **209行目**: `document.offsetToBytes(params.location)` - キャラクタオフセットからバイトオフセットへの変換

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

```
addImport(AddImportParams) [source/served/commands/dub.d:205]
    |
    +-- documents[textDocument.uri] [テキストドキュメントマネージャ]
    |       |
    |       +-- document.rawText [ドキュメントの生テキスト取得]
    |       +-- document.offsetToBytes(location) [オフセット変換]
    |
    +-- backend.get!ImporterComponent [workspace-d API]
            |
            +-- ImporterComponent.add(name, rawText, byteOffset, insertOutermost) [workspace-d内部]
```

### データフロー図

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

AddImportParams              -->  addImport()                  -->  テキスト編集情報
  textDocument.uri                 |
  name ("std.stdio")               +-- ドキュメント取得
  location (int)                   +-- オフセット変換
  insertOutermost (bool)           +-- ImporterComponent.add()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| dub.d | `source/served/commands/dub.d` | ソース | addImport関数の実装（204-210行目） |
| protoext.d | `source/served/lsp/protoext.d` | ソース | AddImportParams構造体定義（12-22行目） |
| types.d | `source/served/types.d` | ソース | documents別名、backend定義 |
| extension.d | `source/served/extension.d` | ソース | LSPプロトコルメソッドのルーティング基盤 |
