# 機能設計書 8-ドキュメントオープン (textDocument/didOpen)

## 概要

本ドキュメントは、serve-d LSPサーバーにおけるドキュメントオープン (textDocument/didOpen) 機能の設計を記述する。テキストドキュメントのオープン通知を処理し、設定に応じてリント処理を実行する。

### 本機能の処理概要

LSPプロトコルの `textDocument/didOpen` 通知を処理する。テキストドキュメントがエディタで開かれた際に、設定（`d.lintOnFileOpen`）に基づいてリント処理（DScanner静的解析・dfmtリント）をトリガーするかどうかを判定し、必要に応じてonDidChangeDocumentを委譲呼び出しする。

**業務上の目的・背景**：D言語開発者がファイルを開いた直後に、コード品質の問題（未使用インポート、フォーマット違反等）を即座に把握できることが望ましい。ファイルオープン時のリント実行により、修正箇所の発見を待ち時間なく行える。ただし、全ファイルで常にリントを実行するとパフォーマンスに影響するため、設定で制御可能にしている。

**機能の利用シーン**：エディタでD言語ファイルを開いた際に自動的に通知される。

**主要な処理内容**：
1. 設定`d.lintOnFileOpen`の値を取得
2. "always"の場合: 常にリント実行
3. "project"の場合: ファイルがワークスペースに属する場合のみリント実行
4. リント実行が必要な場合、onDidChangeDocumentにパラメータを変換して委譲

**関連システム・外部連携**：LSPクライアント。DScanner、dfmtリンター。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | ドキュメントオープン単独の画面は画面機能マッピングに定義されていない |

## 機能種別

イベントハンドリング（ドキュメントライフサイクル管理）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| params | DidOpenTextDocumentParams | Yes | オープンされたテキストドキュメント情報 | LSPプロトコル仕様に準拠 |
| params.textDocument.uri | DocumentUri | Yes | ドキュメントのURI | file://形式 |
| params.textDocument.version_ | int | Yes | ドキュメントのバージョン番号 | - |

### 入力データソース

LSPクライアントからのJSON-RPC通知（メソッド名: "textDocument/didOpen"）

## 出力仕様

### 出力データ

通知処理のため、レスポンスは返却しない。リント結果はtextDocument/publishDiagnostics通知として別途送信される。

### 出力先

診断マネージャ経由でLSPクライアントへpublishDiagnostics通知が送信される。

## 処理フロー

### 処理シーケンス

```
1. リント設定の取得
   └─ config(params.textDocument.uri).d.lintOnFileOpenの値を取得
2. リント実行判定
   └─ "always": shouldLint = true
   └─ "project": workspaceIndex(uri) != size_t.maxの場合shouldLint = true
   └─ それ以外（暗黙的に "never"）: shouldLint = false
3. リント実行（条件付き）
   └─ shouldLint = trueの場合:
      └─ DidChangeTextDocumentParamsを構築
      └─ onDidChangeDocument()を呼び出し（DScanner + dfmtリント）
```

### フローチャート

```mermaid
flowchart TD
    A[didOpen通知受信] --> B[lintOnFileOpen設定取得]
    B --> C{lintOnFileOpen値}
    C -->|always| D[shouldLint = true]
    C -->|project| E{ワークスペース内?}
    C -->|その他| F[shouldLint = false]
    E -->|Yes| D
    E -->|No| F
    D --> G[onDidChangeDocument委譲]
    F --> H[処理終了]
    G --> H
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | lintOnFileOpen=always | ファイルオープン時に常にリントを実行する | lintOnFileOpen設定が"always"の場合 |
| BR-02 | lintOnFileOpen=project | ファイルがワークスペースフォルダ内にある場合のみリントを実行する | lintOnFileOpen設定が"project"の場合 |
| BR-03 | lintOnFileOpen=never（デフォルト以外） | ファイルオープン時にリントを実行しない | lintOnFileOpen設定が"always"/"project"以外の場合 |
| BR-04 | onDidChangeDocument委譲 | リント実行にはonDidChangeDocumentを再利用する。DidChangeTextDocumentParamsにuri・versionのみ渡す | shouldLint=true |

### 計算ロジック

特になし。

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

本機能ではデータベース操作は発生しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | - | エラーケースは存在しない | - |

### リトライ仕様

リトライは不要。

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

トランザクションは存在しない。

## パフォーマンス要件

リント処理はonDidChangeDocument経由で実行されるため、DScanner解析とdfmtリントのデバウンスが適用される。

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

特になし。

## 備考

- Configuration.D.lintOnFileOpenのデフォルト値は"project"（types.d 115行目）。
- workspaceIndex関数（types.d 356-374行目）は、URIがどのワークスペースに属するかを判定し、見つからない場合はsize_t.maxを返す。

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | types.d | `source/served/types.d` | Configuration.D.lintOnFileOpen（115行目）: デフォルト値"project" |
| 1-2 | types.d | `source/served/types.d` | workspaceIndex関数（356-374行目）: URIからワークスペースインデックスを特定 |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | extension.d | `source/served/extension.d` | onDidOpenDocument関数（1114-1127行目）: @protocolNotification("textDocument/didOpen")ハンドラ |

**主要処理フロー**:
1. **1117行目**: lintOnFileOpen設定の取得
2. **1119-1122行目**: "always"と"project"による条件分岐
3. **1124-1126行目**: onDidChangeDocumentへの委譲呼び出し

#### Step 3: 委譲先を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | extension.d | `source/served/extension.d` | onDidChangeDocument関数（1148-1165行目）: DScanner + dfmtリントを実行する処理（機能No.9で詳述） |

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

```
onDidOpenDocument(DidOpenTextDocumentParams)  [@protocolNotification("textDocument/didOpen")]
    |
    +-- config(uri).d.lintOnFileOpen  ... 設定取得
    +-- workspaceIndex(uri)           ... ワークスペース判定
    |
    +-- [shouldLint=true] onDidChangeDocument(DidChangeTextDocumentParams)
            |
            +-- doDscanner(...)         ... DScanner静的解析
            +-- served.linters.dfmt.lint(...)  ... dfmtリント
```

### データフロー図

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

DidOpenTextDocumentParams ─────> onDidOpenDocument()
  .textDocument.uri       ─────>   lintOnFileOpen判定
  .textDocument.version_  ─────>   workspaceIndex判定
                                   [shouldLint=true]
                                   onDidChangeDocument() ──────> publishDiagnostics通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| extension.d | `source/served/extension.d` | ソース | onDidOpenDocument関数の実装 |
| types.d | `source/served/types.d` | ソース | Configuration.D.lintOnFileOpen、workspaceIndex関数の定義 |
| dscanner.d | `source/served/linters/dscanner.d` | ソース | DScanner静的解析リンター（onDidChangeDocument経由で呼ばれる） |
| dfmt.d | `source/served/linters/dfmt.d` | ソース | dfmtリンター（onDidChangeDocument経由で呼ばれる） |
