# 機能設計書 17-補完機能

## 概要

本ドキュメントは、F#コンパイラサービスのコード補完機能（IntelliSense補完）の設計を記述する。この機能は、エディタでユーザーがコードを入力する際に、利用可能な識別子、メソッド、プロパティなどの候補リストを提供する。

### 本機能の処理概要

補完機能は、カーソル位置のコンテキストを解析し、その位置で有効な補完候補（メンバー、関数、型など）を生成してIDEに提供する。

**業務上の目的・背景**：開発者の生産性向上のため、コード入力時に適切な補完候補を提示する。正確な型情報に基づく候補提示により、タイプミスの防止とAPI探索を支援する。

**機能の利用シーン**：
- ドット（.）入力後のメンバー補完
- 識別子入力時のシンボル補完
- open文後の名前空間/モジュール補完
- 属性名の補完
- パターンマッチング内の補完

**主要な処理内容**：
1. カーソル位置のコンテキスト解析
2. 名前解決環境からの候補収集
3. アクセシビリティフィルタリング
4. 重複排除と優先度付け
5. ToolTip情報の生成
6. 補完項目のフォーマット

**関連システム・外部連携**：
- FSharpChecker（型チェック結果の提供）
- NameResolution（名前解決）
- Visual Studio / VS Code（候補表示）

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 2 | テキストエディタ | 主機能 | コード補完候補の表示 |

## 機能種別

IntelliSense / コード補完 / 名前解決

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| parseResults | FSharpParseFileResults | Yes | パース結果 | - |
| checkFileResults | FSharpCheckFileResults | Yes | 型チェック結果 | - |
| line | int | Yes | カーソル行 | 正の整数 |
| column | int | Yes | カーソル列 | 正の整数 |
| lineText | string | Yes | 現在行のテキスト | - |

### 入力データソース

- 型チェック結果（TcResolutions）
- 名前解決環境（NameResolutionEnv）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| CompletionItem[] | CompletionItem[] | 補完候補アイテムのリスト |
| ToolTipText | ToolTipText | ツールチップ情報 |

### 出力先

- IDE補完UIへの返却

## 処理フロー

### 処理シーケンス

```
1. コンテキスト解析
   └─ カーソル位置から補完タイプを判定
2. 名前解決環境取得
   └─ その位置で有効なシンボルを収集
3. 候補フィルタリング
   └─ アクセシビリティ、関連性でフィルタ
4. 重複排除
   └─ 同名シンボルのマージ
5. 優先度付け
   └─ ローカル > メンバー > 外部の順
6. フォーマット
   └─ 表示名、アイコン、詳細情報の生成
```

### フローチャート

```mermaid
flowchart TD
    A[カーソル位置] --> B[コンテキスト解析]
    B --> C{補完タイプ?}
    C -->|メンバー| D[ドット補完]
    C -->|識別子| E[シンボル補完]
    C -->|属性| F[属性補完]
    D --> G[候補収集]
    E --> G
    F --> G
    G --> H[フィルタリング]
    H --> I[重複排除]
    I --> J[優先度付け]
    J --> K[CompletionItem生成]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | アクセシビリティ | プライベートメンバーは適切なスコープでのみ表示 | 常時 |
| BR-02 | 重複排除 | 同名オーバーロードは1つにまとめる | メソッド補完時 |
| BR-03 | 優先度 | IsOwnMember > MinorPriority順でソート | 候補表示時 |
| BR-04 | 抑制項目 | 明示的に抑制されたシンボルは除外 | RemoveExplicitlySuppressed |

### 計算ロジック

補完候補の優先度:
1. 現在のスコープ内の定義
2. 親スコープの定義
3. openされたモジュール/名前空間
4. 外部アセンブリの公開メンバー

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型チェック未完了 | チェック結果がない | 空の候補リストを返却 |
| - | ToolTip生成失敗 | フォーマットエラー | CompositionErrorを返却 |

### リトライ仕様

型チェック完了待機後に再試行。

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

該当なし

## パフォーマンス要件

- 候補生成: 100ms以内
- 初回補完はキャッシュがないため遅い可能性あり

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

特になし

## 備考

- カスタム操作（CustomOperation）の補完もサポート
- 未解決シンボルの提案機能あり

---

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | ToolTipElementData型（37-47行目） |
| 1-2 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | CompletionItem型（84-93行目） |
| 1-3 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | CompletionItemKind型（69-77行目） |

**主要フィールド**:
- **ToolTipElementData**: MainDescription, XmlDoc, TypeMapping, Remarks
- **CompletionItem**: ItemWithInst, Kind, IsOwnMember, MinorPriority, Type
- **CompletionItemKind**: Field, Property, Method, Event等

#### Step 2: ToolTip生成を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | FormatOverloadsToList（102-118行目） |
| 2-2 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | FormatItemDescriptionToToolTipElement（158行目以降） |

**主要処理フロー**:
- **102-118行目**: オーバーロードメソッドのレイアウト生成
- **158行目以降**: 各種シンボルの説明フォーマット

#### Step 3: 候補フィルタリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | RemoveDuplicateCompletionItems（129-131行目） |
| 3-2 | ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | RemoveExplicitlySuppressedCompletionItems（134-135行目） |

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

```
GetDeclarationListInfo (API)
    │
    ├─ コンテキスト解析
    │      └─ カーソル位置の補完タイプ判定
    │
    ├─ 候補収集
    │      ├─ 名前解決環境から取得
    │      └─ メンバー/シンボル/属性の区別
    │
    ├─ フィルタリング
    │      ├─ RemoveDuplicateCompletionItems
    │      └─ RemoveExplicitlySuppressedCompletionItems
    │
    └─ フォーマット
           ├─ FormatItemDescriptionToToolTipElement
           └─ FormatOverloadsToList
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ServiceDeclarationLists.fs | `src/Compiler/Service/ServiceDeclarationLists.fs` | ソース | 補完候補生成のコア実装 |
| NameResolution.fs | `src/Compiler/Checking/NameResolution.fs` | ソース | 名前解決 |
| Symbols.fs | `src/Compiler/Symbols/Symbols.fs` | ソース | シンボル表現 |
| NicePrint.fs | `src/Compiler/Checking/NicePrint.fs` | ソース | 表示用フォーマット |
