# 通知設計書 34-WINDOW_PROCESSING_COMPLETION

## 概要

本ドキュメントは、Lua Language Serverにおける「オートコンプリート処理中」通知（WINDOW_PROCESSING_COMPLETION）の設計を記載する。

### 本通知の処理概要

この通知は、ユーザーがエディタ上でコード補完（オートコンプリート）機能を使用した際に、Language Serverがその処理を実行中であることをユーザーに視覚的に伝えるための進捗表示通知である。

**業務上の目的・背景**：コード補完はユーザーが最も頻繁に使用する機能の一つである。複雑なコードベースや大量のシンボルを持つプロジェクトでは、補完候補の生成に時間がかかる場合がある。この通知により、ユーザーは補完処理が進行中であることを把握でき、エディタが応答していないと誤解することを防ぐ。

**通知の送信タイミング**：`textDocument/completion` LSPリクエストを受信し、処理を開始してから0.5秒（500ミリ秒）経過後も処理が継続している場合に進捗バーが表示される。処理が0.5秒以内に完了した場合は通知は表示されない。

**通知の受信者**：LSPクライアント（VSCode等のエディタ）が受信し、ステータスバーや進捗インジケーターとしてユーザーに表示される。

**通知内容の概要**：「オートコンプリートを処理しています...」というメッセージが表示される。日本語ロケールの場合は日本語で、それ以外の場合は各言語に対応したメッセージが表示される。

**期待されるアクション**：ユーザーは処理完了を待ち、表示された補完候補リストから適切な候補を選択する。

## 通知種別

LSP進捗通知（window/workDoneProgress）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期 |
| 優先度 | 中 |
| リトライ | なし |

### 送信先決定ロジック

LSPクライアントに対して一律送信。進捗バーの表示は `Lua.window.progressBar` 設定に依存する。

## 通知テンプレート

### LSP進捗通知

| 項目 | 内容 |
|-----|------|
| プロトコル | LSP `$/progress` |
| トークン | 自動生成される一意のトークン |
| 種別 | begin / report / end |

### 本文テンプレート

```
オートコンプリートを処理しています...
```

英語版:
```
Processing completion...
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| title | 進捗タイトル | lang.script.WINDOW_PROCESSING_COMPLETION | Yes |
| percentage | 進捗率 | 処理状況 | No |
| message | 追加メッセージ | 処理内容 | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| LSPリクエスト | textDocument/completion | 処理開始から0.5秒経過 | 補完リクエスト受信時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 処理時間が0.5秒未満 | 短時間で完了した場合は表示しない |
| progressBar設定がfalse | ユーザーが進捗バーを無効化している場合 |
| 補完機能が無効 | Lua.completion.enable設定がfalse |
| ワークスペース未準備 | ワークスペースの準備が未完了 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[textDocument/completionリクエスト受信] --> B{補完機能有効?}
    B -->|No| Z[nil返却]
    B -->|Yes| C{ワークスペース準備完了?}
    C -->|No| Z
    C -->|Yes| D[progress.create呼び出し]
    D --> E{0.5秒経過?}
    E -->|Yes| F[window/workDoneProgress/create送信]
    F --> G[$/progress begin通知]
    G --> H[補完候補生成処理]
    H --> I{処理完了?}
    I -->|Yes| J[$/progress end通知]
    I -->|No| K[$/progress report通知]
    K --> H
    J --> L[補完リスト返却]
    E -->|No| M{処理完了?}
    M -->|Yes| L
    M -->|No| E
```

## データベース参照・更新仕様

### 参照テーブル一覧

本通知はデータベースを使用しない。ファイルシステム上のソースコードを解析する。

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル未読込 | 対象ファイルが解析されていない | nilを返却 |
| 補完機能無効 | 設定で補完が無効化されている | nilを返却 |
| ワークスペース未準備 | ワークスペースの準備が未完了 | nilを返却 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（リアルタイム通知）

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

- 進捗通知には機密情報を含めない
- コード内容は通知メッセージに含まれない

## 備考

- 進捗表示の遅延時間（0.5秒）は固定値で、設定変更不可
- 補完処理に0.1秒以上かかった場合は警告ログが出力される
- 補完結果はincomplete/completeの状態を持つ

---

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

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

### 推奨読解順序

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

まず、進捗管理に関するデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | progress.lua | `script/progress.lua` | 進捗オブジェクトの構造 |

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

処理の起点となるプロバイダーファイルを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | provider.lua | `script/provider/provider.lua` | textDocument/completionハンドラの登録と実装 |

**主要処理フロー**:
1. **621-730行目**: `textDocument/completion`メソッドの登録
2. **631行目**: `progress.create(uri, lang.script.WINDOW_PROCESSING_COMPLETION, 0.5)`で進捗オブジェクト作成
3. **633行目**: `core.completion`モジュールを呼び出して補完候補生成

#### Step 3: 補完コアロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | completion.lua | `script/core/completion/completion.lua` | 補完のメインロジック |

**主要処理フロー**:
- **2379-2397行目**: completion関数。補完候補を生成
- **2357-2376行目**: tryCompletions関数で各種補完処理を実行

#### Step 4: ローカライズを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/ja-jp/script.lua` | 日本語メッセージ定義 |

**主要処理フロー**:
- **536-537行目**: `WINDOW_PROCESSING_COMPLETION`の日本語定義

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

```
textDocument/completion (provider.lua:621-730)
    │
    ├─ config.get(uri, 'Lua.completion.enable')
    │      └─ 補完機能有効性チェック
    │
    ├─ workspace.isReady(uri)
    │      └─ ワークスペース準備確認
    │
    ├─ progress.create(uri, title, delay)  (progress.lua:155-168)
    │      └─ 進捗オブジェクト生成
    │          └─ update() → window/workDoneProgress/create
    │                      → $/progress (begin/report/end)
    │
    ├─ files.getState(uri)
    │      └─ ファイルのAST取得
    │
    └─ core.completion(uri, pos, triggerCharacter)  (completion.lua:2379-2397)
           ├─ tryCompletions() - 各種補完処理
           │    ├─ tryWord() - 単語補完
           │    ├─ trySymbol() - シンボル補完
           │    ├─ tryTable() - テーブル補完
           │    └─ tryLuaDoc() - ドキュメント補完
           └─ 結果フィルタリング・ソート
```

### データフロー図

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

textDocument/            provider.lua                   CompletionList
  completion   ───────▶ ├─ progress.create() ───▶     {isIncomplete,
  リクエスト              │    └─ 進捗通知                items: []}
    │                    ├─ completion.lua
    │                    │    └─ tryCompletions()
    │                    └─ 結果変換
    │
    └── params:          進捗通知:                      補完候補:
        ├─ textDocument   ├─ $/progress (begin)         ├─ label
        │   └─ uri        ├─ $/progress (report)        ├─ kind
        ├─ position       └─ $/progress (end)           ├─ detail
        └─ context                                       └─ insertText
            └─ triggerCharacter
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| provider.lua | `script/provider/provider.lua` | ソース | LSPリクエストハンドラ |
| progress.lua | `script/progress.lua` | ソース | 進捗管理モジュール |
| completion.lua | `script/core/completion/completion.lua` | ソース | 補完コアロジック |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ |
