# 機能設計書 31-折りたたみ範囲 (textDocument/foldingRange)

## 概要

本ドキュメントは、LSPプロトコルの `textDocument/foldingRange` リクエストに対応する折りたたみ範囲提供機能の設計を記述する。エディタがコードの折りたたみ可能な領域を表示するために必要な情報を返却する。

### 本機能の処理概要

**業務上の目的・背景**：大規模なD言語ソースファイルを編集する際、コメントブロック、インポート文群、制御構造、関数定義等の論理的なまとまりを折りたたむことで、コード全体の見通しを良くし、開発者の生産性を向上させる。LSP仕様の `textDocument/foldingRange` に準拠し、エディタの折りたたみ機能と連携する。

**機能の利用シーン**：開発者がエディタ上でD言語ソースファイルを開いた際に、エディタがバックグラウンドでこのリクエストを送信し、折りたたみ可能な範囲の一覧を取得する。エディタはこの情報を基に折りたたみガターアイコンを表示する。

**主要な処理内容**：
1. リクエストパラメータからテキストドキュメントを特定し、ドキュメントオブジェクトを取得する
2. DCDExtComponentが利用可能か確認する
3. DCDExtComponentの `getFoldingRanges` を呼び出し、バイトオフセットベースの折りたたみ範囲を取得する
4. バイトオフセットをLSPのPosition（行・文字位置）に変換する
5. 折りたたみ範囲の種別（comment/imports/region）をLSP仕様のFoldingRangeKindにマッピングする

**関連システム・外部連携**：DCDExtComponent（workspace-dサブパッケージ）が折りたたみ範囲の解析を担当する。DCDExtComponentはlibdparseを使用してD言語ソースコードのAST解析を行い、折りたたみ範囲を検出する。

**権限による制御**：特になし。全てのドキュメントに対して同一の処理が適用される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 31 | 折りたたみ（textDocument/foldingRange） | 主画面 | コメント・インポート・リージョン等の折りたたみ可能な範囲を返却する |

## 機能種別

データ取得処理（ソースコード解析結果の取得・変換）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| params.textDocument | TextDocumentIdentifier | Yes | 対象ドキュメントの識別子（URI） | ドキュメントが管理下に存在すること |

### 入力データソース

LSPクライアントからの `textDocument/foldingRange` リクエスト。テキストドキュメントの生テキストはDocumentManagerから取得する。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | Nullable!(FoldingRange[]) | 折りたたみ範囲の配列。DCDExtComponentが利用不可の場合はnull |
| FoldingRange.startLine | uint | 折りたたみ開始行（0-based） |
| FoldingRange.endLine | uint | 折りたたみ終了行（0-based） |
| FoldingRange.startCharacter | Optional!uint | 折りたたみ開始文字位置 |
| FoldingRange.endCharacter | Optional!uint | 折りたたみ終了文字位置 |
| FoldingRange.kind | Optional!FoldingRangeKind | 折りたたみ種別（comment/imports/region） |

### 出力先

LSPクライアントへのレスポンスとして返却する。

## 処理フロー

### 処理シーケンス

```
1. ドキュメント取得
   └─ params.textDocument.uriからdocumentsコレクションでドキュメントを取得
2. DCDExtComponent利用可能性チェック
   └─ backend.hasBest!DCDExtComponentでファイルに対応するインスタンスがあるか確認
   └─ 存在しない場合、Nullable.initを返却して終了
3. 折りたたみ範囲の取得
   └─ backend.best!DCDExtComponent(file).getFoldingRanges(codeText)を呼び出し
   └─ DCDExtComponent内部でlibdparseによるAST解析、コメント検出、インポートブロック検出を実施
4. バイトオフセットからPositionへの変換
   └─ 各範囲のstart/endバイトオフセットをdocument.nextPositionBytesで行・文字位置に変換
   └─ キャッシュ付き変換（cachePos, cacheBytes）で効率的に処理
5. 種別マッピング
   └─ mapFoldingRangeKindでFoldingRangeType（workspace-d内部型）をFoldingRangeKind（LSP型）に変換
6. 結果返却
   └─ 変換済みFoldingRange配列をNullable型で返却
```

### フローチャート

```mermaid
flowchart TD
    A[textDocument/foldingRange リクエスト受信] --> B[ドキュメント取得]
    B --> C{DCDExtComponent利用可能?}
    C -->|No| D[null を返却]
    C -->|Yes| E[getFoldingRanges 呼び出し]
    E --> F[バイトオフセット→Position変換]
    F --> G[FoldingRangeType→FoldingRangeKind変換]
    G --> H[FoldingRange配列を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-31-01 | DCDExt必須 | DCDExtComponentが利用不可の場合は空の結果を返却する | 常時 |
| BR-31-02 | 種別マッピング | comment→comment, imports→imports, region→regionの固定マッピング | 常時 |
| BR-31-03 | キャッシュ付き変換 | バイトオフセットの変換は前回の位置をキャッシュとして利用し、順方向に効率的に処理する | 常時 |

### 計算ロジック

特になし。バイトオフセットから行・文字位置への変換はDocumentクラスの `nextPositionBytes` メソッドが担当する。

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

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

本機能にデータベース操作は存在しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コンポーネント未初期化 | DCDExtComponentがバックエンドに登録されていない | Nullable.initを返却（空レスポンス） |

### リトライ仕様

リトライは行わない。DCDExtComponentが利用できない場合はnullを返し、エディタ側が折りたたみ表示を無効化する。

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

トランザクション管理は不要（読み取り専用処理）。

## パフォーマンス要件

ファイルサイズに依存するが、libdparseによるAST解析が含まれるため、大規模ファイルでは数百ミリ秒程度の処理時間が発生する可能性がある。キャッシュ付きのPosition変換により、変換処理自体は線形時間で完了する。

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

特になし。ローカルファイルの読み取り専用処理のみ。

## 備考

- DCDExtComponentはlibdparseを使用してAST解析を行い、コメント・インポートブロック・制御構造（if/else, foreach, while, for, switch/case等）・関数定義・構造体定義・列挙型定義・ユニットテスト等、多様なコード構造の折りたたみ範囲を検出する。
- サーバー初期化時（initialize）にFoldingRangeOptionsが空のオブジェクトとしてサーバーケイパビリティに登録される。

---

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

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

### 推奨読解順序

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

まず、LSPプロトコルで定義されるFoldingRange関連の型を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protocol.d | `protocol/source/served/lsp/protocol.d` | FoldingRangeParams（3755行目）、FoldingRangeKind（3761行目）、FoldingRange（3769行目）の構造体定義を確認 |
| 1-2 | dcdext.d | `workspace-d/source/workspaced/com/dcdext.d` | FoldingRangeType（1361行目）列挙型とworkspace-d内部のFoldingRange構造体（1373行目）を確認 |

**読解のコツ**: LSPプロトコルの型（protocol.d）とworkspace-d内部の型（dcdext.d）は同名の `FoldingRange` が存在するが別の型である。protocol.dの方は行・文字位置ベース、dcdext.dの方はバイトオフセットベースである。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | folding.d | `source/served/commands/folding.d` | `provideFoldingRange` 関数（12-40行目）がLSPリクエストハンドラ |

**主要処理フロー**:
1. **14行目**: `documents[params.textDocument.uri]` でドキュメント取得
2. **17-18行目**: `backend.hasBest!DCDExtComponent(file)` でコンポーネント利用可能性チェック
3. **26行目**: `backend.best!DCDExtComponent(file).getFoldingRanges(codeText)` で範囲取得
4. **28-29行目**: `document.nextPositionBytes` でバイトオフセット→Position変換
5. **35行目**: `mapFoldingRangeKind` で種別マッピング

#### Step 3: 折りたたみ範囲の解析処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | dcdext.d | `workspace-d/source/workspaced/com/dcdext.d` | `getFoldingRanges` メソッド（986行目）が実際の解析処理。コメント検出、AST解析、インポートブロック検出の3段階で処理 |

**主要処理フロー**:
- **1003-1009行目**: 複数行コメントを FoldingRangeType.comment として検出
- **1022-1027行目**: libdparseでASTを解析し、FoldingRangeGeneratorビジターで各種構文の折りたたみ範囲を収集
- **1032-1034行目**: ImporterComponentでインポートブロックを検出し、FoldingRangeType.imports として追加

#### Step 4: 種別マッピングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | folding.d | `source/served/commands/folding.d` | `mapFoldingRangeKind` 関数（42-50行目）。final switchで3種別を1対1マッピング |

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

```
provideFoldingRange (folding.d:12)
    |
    +-- documents[uri] (テキストドキュメント取得)
    |
    +-- backend.hasBest!DCDExtComponent(file)
    |       (コンポーネント利用可能性チェック)
    |
    +-- backend.best!DCDExtComponent(file).getFoldingRanges(codeText)
    |       |
    |       +-- コメントトークン検出 (dcdext.d:1003-1009)
    |       +-- libdparse.parseModule (dcdext.d:1024)
    |       +-- FoldingRangeGenerator.visit (dcdext.d:1026-1027)
    |       +-- ImporterComponent.findImportCodeSlices (dcdext.d:1032-1034)
    |
    +-- document.nextPositionBytes (バイト→Position変換)
    |
    +-- mapFoldingRangeKind (folding.d:42)
```

### データフロー図

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

FoldingRangeParams    ──▶  provideFoldingRange           ──▶  FoldingRange[] (LSP型)
  .textDocument.uri         |
                            +-- Document取得
                            +-- DCDExtComponent
                            |     .getFoldingRanges()
                            |     (バイトオフセット範囲)
                            +-- nextPositionBytes()
                            |     (行・文字位置に変換)
                            +-- mapFoldingRangeKind()
                                  (種別マッピング)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| folding.d | `source/served/commands/folding.d` | ソース | LSPリクエストハンドラ（メイン処理） |
| protocol.d | `protocol/source/served/lsp/protocol.d` | ソース | FoldingRange/FoldingRangeParams等のLSP型定義 |
| dcdext.d | `workspace-d/source/workspaced/com/dcdext.d` | ソース | getFoldingRanges実装（AST解析・範囲検出） |
| extension.d | `source/served/extension.d` | ソース | サーバーケイパビリティにfoldingRangeProviderを登録（300, 313行目） |
| types.d | `source/served/types.d` | ソース | 共通型定義・backend/documentsへのアクセス |
