# 通知設計書 30-WINDOW_PROCESSING_HOVER

## 概要

本ドキュメントは、Lua Language Serverにおけるホバー処理中通知（WINDOW_PROCESSING_HOVER）の設計について記述する。

### 本通知の処理概要

この通知は、ホバー情報（マウスオーバー時のヒント）の処理中であることをユーザーに示すプログレスバー表示に使用される。

**業務上の目的・背景**：エディタでシンボルにマウスをホバーすると、Lua Language Serverは型情報、ドキュメント、関数シグネチャなどを解析して返す。複雑なコードや大きなファイルでは解析に時間がかかることがあり、ユーザーに処理状況を可視化することで、サーバーが応答処理中であることを示す。

**通知の送信タイミング**：textDocument/hoverリクエストを処理する際、progress.createによりプログレスバーが作成される。一定時間（0.5秒）以上処理が継続する場合に表示される。

**通知の受信者**：エディタを使用しているユーザー（開発者）。LSPクライアント経由で$/progress通知として受信する。

**通知内容の概要**：「Processing hover...」というタイトルのプログレスバーが表示される。

**期待されるアクション**：ユーザーは処理完了を待つ。プログレスバーは自動的に消える。

## 通知種別

LSP $/progress通知（プログレスバー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（LSP notification） |
| 優先度 | 低（情報表示） |
| リトライ | なし |

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

LSPクライアント（エディタ）に対して$/progress通知を送信する。受信者はエディタを操作しているユーザー。

## 通知テンプレート

### LSP通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | $/progress |
| プログレスKind | begin / report / end |

### 本文テンプレート

英語版:
```
Processing hover...
```

日本語版:
```
ホバーヒントを処理中しています...
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | 進捗メッセージ | 設定なし | No |
| percentage | 進捗率 | 設定なし | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ホバーリクエスト | textDocument/hover受信 | 処理時間が0.5秒を超える場合 | マウスホバー時の情報取得 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Lua.window.progressBar == false | 設定でプログレスバーが無効の場合 |
| 処理時間が0.5秒未満 | 短時間で完了する場合は表示されない |
| Lua.hover.enable == false | ホバー機能が無効の場合（処理自体が行われない） |
| ワークスペース未準備 | workspace.isReady(uri) == falseの場合（別のメッセージを返す） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[textDocument/hover受信] --> B{hover有効?}
    B -->|No| C[処理終了]
    B -->|Yes| D{ワークスペース準備完了?}
    D -->|No| E[ローディングメッセージ返却]
    D -->|Yes| F[progress.create呼び出し]
    F --> G{delay経過?}
    G -->|No| H[プログレス非表示]
    G -->|Yes| I[window/workDoneProgress/create送信]
    I --> J[$/progress begin送信]
    J --> K[ホバー情報解析]
    K --> L[core.hover.byUri呼び出し]
    L --> M[$/progress end送信]
    M --> N[ホバー結果返却]
```

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

### 参照テーブル一覧

該当なし（インメモリ処理のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル状態なし | files.getState(uri)がnil | nilを返却 |
| ホバー情報なし | core.byUriが結果なし | nilを返却 |
| 空の結果 | hover文字列が空 | nilを返却 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 更新間隔 | 50ms以上 |

### 配信時間帯

制限なし

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

- 処理状態の表示のみであり、セキュリティリスクは低い

## 備考

- progress.createの第3引数（delay）で表示遅延を設定可能（0.5秒）
- abortByFileUpdate = trueにより、ファイル更新時にリクエストが中断される
- ホバー結果にはmaxLevelパラメータが含まれ、詳細レベルを制御可能

---

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

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

### 推奨読解順序

#### Step 1: メッセージ定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | WINDOW_PROCESSING_HOVER定義（528-529行目） |

**読解のコツ**: 「Processing hover...」という固定文言として定義されている。

#### Step 2: ホバーハンドラを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | provider.lua | `script/provider/provider.lua` | textDocument/hoverハンドラ（340-385行目） |

**主要処理フロー（textDocument/hover）**:
1. **349行目**: config.get(uri, 'Lua.hover.enable')でホバー有効性チェック
2. **352-359行目**: ワークスペース準備中の場合はローディングメッセージを返却
3. **361行目**: progress.create呼び出し（WINDOW_PROCESSING_HOVER、0.5秒遅延）
4. **362行目**: core.hoverモジュールをrequire
5. **363-367行目**: ファイル状態取得とポジション変換
6. **368行目**: core.byUri(uri, pos, params.level)でホバー情報取得
7. **376-383行目**: 結果をMarkdown形式で返却

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

```
m.register 'textDocument/hover' (script/provider/provider.lua:340)
    │
    ├─ config.get(uri, 'Lua.hover.enable') - 有効性チェック
    │
    ├─ workspace.isReady(uri) - 準備状態チェック
    │
    └─ progress.create (script/progress.lua:155)
           │
           ├─ [delay後]
           │      │
           │      ├─ proto.request('window/workDoneProgress/create')
           │      │
           │      └─ proto.notify('$/progress', {kind='begin'})
           │
           └─ [完了時 - <close>メタメソッド]
                  │
                  └─ proto.notify('$/progress', {kind='end'})

ホバー処理:
    ├─ files.getState(uri) - ファイル状態取得
    ├─ converter.unpackPosition(state, params.position) - 位置変換
    └─ core.byUri(uri, pos, level) - ホバー情報解析
           │
           └─ hover結果（型情報、ドキュメント等）
```

### データフロー図

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

textDocument/hover ──▶  hoverハンドラ          ──▶  ホバー情報
    リクエスト                │                      (Markdown)
        │                    ▼
        │           progress.create
        │           (WINDOW_PROCESSING_HOVER)
        │                    │
        │                    ▼
        │           [delay経過]
        │                    │
        │                    ▼
        │           $/progress ────────────▶  LSPクライアント
        │           (begin/end)               (プログレスバー表示)
        │
        └──────────▶ core.hover.byUri ──────▶  型解析・ドキュメント収集
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| provider.lua | `script/provider/provider.lua` | ソース | LSPハンドラ |
| progress.lua | `script/progress.lua` | ソース | プログレスバー管理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| hover.lua | `script/core/hover/init.lua` | ソース | ホバー情報解析コア |
| files.lua | `script/files.lua` | ソース | ファイル状態管理 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理 |
