# 機能設計書 8-ドキュメントの保存 (textDocument/didSave)

## 概要

本ドキュメントは、lua-language-serverにおけるドキュメント保存通知の処理を記載したものである。エディタでファイルが保存された際に送信される`textDocument/didSave`通知を受信し、保存イベントを処理する。

### 本機能の処理概要

**業務上の目的・背景**：LSPプロトコルでは、クライアント（エディタ）がファイルを保存した際に`textDocument/didSave`通知を送信できる。サーバーはこの通知を受けて、ファイルの永続化を認識し、保存時に実行すべき処理（例：診断の更新、ビルドのトリガー等）を行う。本実装では、ファイルウォッチャーに保存イベントを通知する。

**機能の利用シーン**：ユーザーがエディタでLuaファイルを保存した時（Ctrl+S、:w等）に自動的に呼び出される。

**主要な処理内容**：
1. didSave通知の受信とパラメータ解析
2. URIの正規化（files.getRealUri）
3. ファイルウォッチャーへの保存イベント通知（files.onWatch('save', uri)）

**関連システム・外部連携**：LSPクライアント、ファイルウォッチャー

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は直接的な画面表示を持たない |

## 機能種別

テキスト同期 / ファイル保存通知

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| textDocument | TextDocumentIdentifier | Yes | 保存されたドキュメントの識別子 | - |
| textDocument.uri | string | Yes | ドキュメントのURI | 有効なURI形式 |
| text | string | No | 保存時のドキュメント内容（capability設定による） | - |

### 入力データソース

LSPクライアントからのJSON-RPC通知

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | - | 通知のため戻り値なし |

### 出力先

なし（内部イベント発火のみ）

## 処理フロー

### 処理シーケンス

```
1. didSave通知の受信
   └─ JSON-RPCでクライアントから通知を受信

2. パラメータの解析
   └─ textDocumentを取得

3. URIの正規化
   └─ files.getRealUri(doc.uri)でURIを正規化

4. 保存イベントの発火
   └─ files.onWatch('save', uri)を実行
   └─ 登録されたウォッチャーに通知
```

### フローチャート

```mermaid
flowchart TD
    A[didSave通知受信] --> B[URI正規化]
    B --> C[files.onWatch save]
    C --> D[処理完了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 保存時テキスト非送信 | capability設定でincludeText: falseを指定 | 常時 |
| BR-002 | イベント通知 | 登録されたファイルウォッチャーに保存イベントを通知 | 常時 |

### 計算ロジック

特になし

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

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

本機能はデータベースを使用しない

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ不要

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

トランザクション管理なし

## パフォーマンス要件

即座に処理すること

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

特になし

## 備考

- capability設定で`textDocumentSync.save.includeText: false`を指定しており、保存時のテキスト内容は送信されない
- 非同期処理（async）として実装されている

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | provider.lua | `script/provider/provider.lua` | `m.register 'textDocument/didSave'`でハンドラを登録 |

**主要処理フロー**:
1. **324-338行目**: `textDocument/didSave`ハンドラの定義
2. **325-331行目**: capabilityの設定（save.includeText: false）
3. **334行目**: `params.textDocument`からドキュメント情報を取得
4. **335行目**: `files.getRealUri(doc.uri)`でURIを正規化
5. **336行目**: `files.onWatch('save', uri)`で保存イベントを発火

**読解のコツ**: このハンドラはcapability設定も含むm.register呼び出しの例。`capability`フィールドで保存通知の設定を宣言している。

#### Step 2: capability設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | provider.lua | `script/provider/provider.lua` | didSaveのcapability設定 |

**capability設定**:
```lua
capability = {
    textDocumentSync = {
        save = {
            includeText = false,
        },
    }
}
```

#### Step 3: ファイルウォッチ処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | files.lua | `script/files.lua` | files.onWatchの実装 |

**主要処理フロー**:
- **1015-1027行目**: `m.onWatch(ev, uri)`関数
- **1021-1026行目**: 登録されたコールバックを非同期で呼び出し

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

```
m.register 'textDocument/didSave' (provider.lua:324-338)
    |
    +-- capability設定
    |       └─ textDocumentSync.save.includeText = false
    |
    +-- files.getRealUri(doc.uri) (files.lua:82-116)
    |       └─ URI正規化
    |
    +-- files.onWatch('save', uri) (files.lua:1015-1027)
            +-- watchList内の各コールバックを呼び出し
            └─ await.call(callback)
```

### データフロー図

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

DidSaveParams ─────────> provider.lua                      (イベント発火)
  - textDocument           m.register 'textDocument/didSave'
    - uri                  |
                           +-- files.getRealUri()
                           |     (URI正規化)
                           |
                           +-- files.onWatch('save', uri)
                                 +-- watchList[1](ev, uri)
                                 +-- watchList[2](ev, uri)
                                 +-- ...
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| provider.lua | `script/provider/provider.lua` | ソース | LSP通知ハンドラの登録・実行 |
| files.lua | `script/files.lua` | ソース | ファイル管理、イベント通知 |
| file-uri.lua | `script/file-uri.lua` | ソース | ファイルURIの変換処理 |
| await.lua | `script/await.lua` | ソース | 非同期処理ユーティリティ |
