# 機能設計書 41-設定一覧取得 (served/listConfigurations)

## 概要

本ドキュメントは、serve-d LSPサーバーが提供するカスタムLSPメソッド `served/listConfigurations` の機能設計を記述する。このメソッドは、アクティブなDUBプロジェクトで利用可能なビルド設定（configuration）の一覧を返却する。

### 本機能の処理概要

**業務上の目的・背景**：DUBプロジェクトは複数のビルド設定（例：application、library、unittest等）を持つことがある。開発者がエディタ上でビルド設定を切り替えるためには、まず利用可能な設定の一覧を取得する必要がある。本機能はその一覧取得を担い、UI上でのビルド設定選択のドロップダウンやコマンドパレットなどの基盤を提供する。

**機能の利用シーン**：エディタ（VS Code等）のステータスバーやコマンドパレットからDUBビルド設定を選択する際に呼び出される。クライアント拡張機能が設定選択UIを表示する前に、サーバーから利用可能な設定一覧を取得する。

**主要な処理内容**：
1. アクティブなワークスペースインスタンスの存在確認
2. DubComponentの有効性チェック
3. DUBプロジェクトで定義されたビルド設定一覧の取得・返却

**関連システム・外部連携**：DUBビルドシステム（dub.json/dub.sdl）のプロジェクト設定を参照する。workspace-dサブパッケージのDubComponentを介してDUBのプロジェクト情報にアクセスする。

**権限による制御**：特に権限制御はない。ただしアクティブインスタンスが未設定、またはDubComponentが読み込まれていない場合はnullを返却する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 42 | 設定一覧取得（served/listConfigurations） | 主画面 | アクティブなDUBプロジェクトの利用可能なビルド設定一覧を返却する |

## 機能種別

データ取得（READ）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | パラメータなし | - |

### 入力データソース

LSPクライアントからの `served/listConfigurations` リクエスト。パラメータは不要。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | string[] \| null | ビルド設定名の配列。アクティブインスタンスまたはDubComponentが存在しない場合はnull |

### 出力先

LSPクライアントへのJSON-RPCレスポンスとして返却。

## 処理フロー

### 処理シーケンス

```
1. アクティブインスタンスの確認
   └─ activeInstanceがnullの場合、nullを返却して終了
2. DubComponentの有効性確認
   └─ activeInstance.has!DubComponentがfalseの場合、nullを返却して終了
3. ビルド設定一覧の取得
   └─ activeInstance.get!DubComponent.configurationsプロパティを呼び出す
4. 結果の返却
   └─ string[]（ビルド設定名の配列）をクライアントに返却
```

### フローチャート

```mermaid
flowchart TD
    A[served/listConfigurations リクエスト受信] --> B{activeInstance が有効か?}
    B -->|No| C[null を返却]
    B -->|Yes| D{DubComponent が有効か?}
    D -->|No| C
    D -->|Yes| E[DubComponent.configurations を取得]
    E --> F[string[] を返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-41-01 | アクティブインスタンス必須 | アクティブなワークスペースインスタンスが存在しない場合はnullを返す | 常時 |
| BR-41-02 | DubComponent必須 | DubComponentがロードされていない場合はnullを返す | 常時 |
| BR-41-03 | 設定一覧の取得元 | DUBプロジェクトのconfigurationsプロパティから取得する | DubComponentが有効な場合 |

### 計算ロジック

特別な計算ロジックはない。DUBプロジェクトのconfigurationsプロパティをそのまま返却する。

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

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

本機能はデータベースを使用しない。DUBプロジェクトのインメモリ状態から情報を取得する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 暗黙的エラー | activeInstanceがnull | nullを返却（エラー通知なし） |
| - | 暗黙的エラー | DubComponentが未ロード | nullを返却（エラー通知なし） |

### リトライ仕様

リトライ処理はない。

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

トランザクション制御はない（読み取り専用操作）。

## パフォーマンス要件

DUBプロジェクトのインメモリ状態からの単純な読み取りであり、即時応答が期待される。

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

特になし。ローカルプロジェクト情報の読み取りのみ。

## 備考

- この機能はDUB管理カテゴリに属し、No.42（設定切り替え）・No.43（現在設定取得）と組み合わせて使用される。
- configurationsプロパティは `_dub.project.configurations` を返しており、これはDUBプロジェクト定義ファイル（dub.json/dub.sdl）内で宣言された設定一覧である。

---

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

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

### 推奨読解順序

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

DUBの設定一覧は単純な文字列配列（string[]）として表現される。特別なデータ構造はない。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protoext.d | `source/served/lsp/protoext.d` | SwitchConfigParams構造体（491-494行目）を確認し、設定名がstring型で扱われることを理解する |

**読解のコツ**: D言語の `@protocolMethod` UDAは、LSPプロトコルのカスタムメソッドをルーティングするためのアノテーション。関数名がそのままLSPメソッド名にマッピングされる。

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

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

**主要処理フロー**:
1. **25行目**: `@protocolMethod("served/listConfigurations")` でLSPメソッドとして登録
2. **28行目**: `activeInstance` と `DubComponent` の存在確認（ガード節）
3. **30行目**: `activeInstance.get!DubComponent.configurations` でDubComponentから設定一覧を取得

#### Step 3: DubComponentの実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | dub.d | `workspace-d/source/workspaced/com/dub.d` | DubComponentクラス（36-848行目）の全体構造 |
| 3-2 | dub.d | `workspace-d/source/workspaced/com/dub.d` | configurationsプロパティ（487-491行目）がDUBプロジェクトのconfigurationsを返す |

**主要処理フロー**:
- **488-490行目**: `_dub.project.configurations` を直接返却。_dubはServedDub型のDUBエンジンインスタンス

#### Step 4: activeInstanceの管理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | types.d | `source/served/types.d` | activeInstanceプロパティ（463-474行目）でWorkspaceD.Instanceの管理を理解する |

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

```
served/listConfigurations (LSPリクエスト)
    │
    └─ listConfigurations() [source/served/commands/dub.d:26-31]
           │
           ├─ activeInstance (null チェック) [source/served/types.d:471-474]
           │
           ├─ activeInstance.has!DubComponent (コンポーネント有効性チェック)
           │
           └─ activeInstance.get!DubComponent.configurations
                  │
                  └─ DubComponent.configurations() [workspace-d/source/workspaced/com/dub.d:488-490]
                         │
                         └─ _dub.project.configurations (DUBプロジェクトの設定一覧)
```

### データフロー図

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

LSPリクエスト ───> listConfigurations() ───> string[] (設定名一覧)
(パラメータなし)         │                        または null
                         │
                    DubComponent
                         │
                    _dub.project
                    .configurations
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| dub.d | `source/served/commands/dub.d` | ソース | LSPメソッドのエントリーポイント（listConfigurations関数） |
| dub.d | `workspace-d/source/workspaced/com/dub.d` | ソース | DubComponentのconfigurations プロパティの実装 |
| protoext.d | `source/served/lsp/protoext.d` | ソース | 関連する型定義（SwitchConfigParams等） |
| types.d | `source/served/types.d` | ソース | activeInstance、backend等のグローバル状態管理 |
| extension.d | `source/served/extension.d` | ソース | コマンドモジュールのpublic import（dub.dを含む） |
