# 通知設計書 37-WINDOW_PROCESSING_WS_SYMBOL

## 概要

本ドキュメントは、Lua Language Serverにおける「ワークスペースシンボル処理中」通知（WINDOW_PROCESSING_WS_SYMBOL）の設計を記載する。

### 本通知の処理概要

この通知は、ユーザーがエディタ上でワークスペースシンボル検索機能を使用した際に、Language Serverがその処理を実行中であることをユーザーに視覚的に伝えるための進捗表示通知である。

**業務上の目的・背景**：ワークスペースシンボル検索は、プロジェクト全体から関数、変数、クラス等のシンボルを検索する機能である。大規模なワークスペースでは、全ファイルを検索するため処理に時間がかかることがある。この通知により、ユーザーは処理が進行中であることを把握できる。

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

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

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

**期待されるアクション**：ユーザーは処理完了を待ち、表示されたシンボル一覧から目的のシンボルに移動する。

## 通知種別

LSP進捗通知（window/workDoneProgress）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### LSP進捗通知

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

### 本文テンプレート

```
ワークスペースシンボルを処理しています...
```

英語版:
```
Processing workspace symbols...
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| LSPリクエスト | workspace/symbol | 処理開始から0.5秒経過 | ワークスペースシンボル検索リクエスト受信時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 処理時間が0.5秒未満 | 短時間で完了した場合は表示しない |
| progressBar設定がfalse | ユーザーが進捗バーを無効化している場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[workspace/symbolリクエスト受信] --> B[progress.create呼び出し]
    B --> C{0.5秒経過?}
    C -->|Yes| D[window/workDoneProgress/create送信]
    D --> E[$/progress begin通知]
    E --> F[シンボル検索処理]
    F --> G{処理完了?}
    G -->|Yes| H[$/progress end通知]
    G -->|No| I[$/progress report通知]
    I --> F
    H --> J[シンボルリスト返却]
    C -->|No| K{処理完了?}
    K -->|Yes| J
    K -->|No| C
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。ワークスペース内の全ファイルを検索する。

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| シンボルなし | 検索結果が0件 | nilを返却 |
| ファイル未解析 | 対象ファイルのAST取得失敗 | スキップして継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 進捗通知には機密情報を含めない
- シンボル名やコード構造は通知メッセージに含まれない

## 備考

- 進捗表示の遅延時間（0.5秒）は固定値で、設定変更不可
- 検索結果は最大1000件に制限される（searchWords関数）
- グローバル変数、クラス、クラスフィールドを検索対象とする

---

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

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

### 推奨読解順序

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

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

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

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

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

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

**主要処理フロー**:
1. **1023-1066行目**: `workspace/symbol`メソッドの登録
2. **1030行目**: `progress.create(workspace.getFirstScope().uri, lang.script.WINDOW_PROCESSING_WS_SYMBOL, 0.5)`で進捗オブジェクト作成
3. **1033行目**: `core.workspace-symbol`モジュールを呼び出してシンボル検索

#### Step 3: ワークスペースシンボルコアロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | workspace-symbol.lua | `script/core/workspace-symbol.lua` | ワークスペースシンボルのメインロジック |

**主要処理フロー**:
- **151-161行目**: メイン関数。検索キーワードに基づきシンボルを検索
- **60-91行目**: searchGlobalAndClass関数でグローバル変数とクラスを検索
- **96-134行目**: searchClassField関数でクラスフィールドを検索
- **139-146行目**: searchWords関数でファイル内シンボルを検索

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

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

**主要処理フロー**:
- **542-543行目**: `WINDOW_PROCESSING_WS_SYMBOL`の日本語定義

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

```
workspace/symbol (provider.lua:1023-1066)
    │
    ├─ progress.create(uri, title, delay)  (progress.lua:155-168)
    │      └─ 進捗オブジェクト生成
    │          └─ update() → window/workDoneProgress/create
    │                      → $/progress (begin/report/end)
    │
    └─ core.workspace-symbol(query, suri, includeWords)  (workspace-symbol.lua:151-161)
           ├─ searchGlobalAndClass() - グローバル・クラス検索
           │    ├─ vm.getAllGlobals() - 全グローバル取得
           │    └─ matchKey() - キーワードマッチング
           ├─ searchClassField() - クラスフィールド検索
           │    ├─ vm.getGlobal() - グローバル取得
           │    └─ vm.getClassFields() - フィールド取得
           └─ searchWords() - ファイル内シンボル検索
                └─ searchFile() - 各ファイル検索
                     ├─ files.getState() - AST取得
                     └─ guide.eachSource() - ソース走査
```

### データフロー図

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

workspace/symbol ───────▶ provider.lua                   SymbolInformation[]
  リクエスト              ├─ progress.create() ───▶     [{name, kind, location}]
    │                    │    └─ 進捗通知
    │                    ├─ workspace-symbol.lua
    │                    │    ├─ searchGlobalAndClass()
    │                    │    ├─ searchClassField()
    │                    │    └─ searchWords()
    │                    └─ convert() - 形式変換
    │
    └── params:          進捗通知:                      シンボル:
        └─ query          ├─ $/progress (begin)         ├─ name
           (検索文字列)   ├─ $/progress (report)        ├─ kind
                          └─ $/progress (end)           └─ location
                                                             ├─ uri
                                                             └─ range
```

### 関連ファイル一覧

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