# 通知設計書 27-WINDOW_COMPILING

## 概要

本ドキュメントは、Lua Language Serverにおけるコンパイル中通知（WINDOW_COMPILING）の設計について記述する。

### 本通知の処理概要

この通知は、Luaファイルのコンパイル（構文解析・AST構築）処理中であることをユーザーに示すプログレスバー表示に使用される。

**業務上の目的・背景**：Lua Language Serverはファイルを読み込む際に構文解析を行い、抽象構文木（AST）を構築する。大規模なファイルや複雑なコードの場合、この処理に時間がかかることがある。ユーザーに処理状況を可視化することで、サーバーが応答していることを示し、待機中の不安を軽減する。

**通知の送信タイミング**：files.compileState関数でファイルのコンパイル処理を開始する際、progress.createによりプログレスバーが作成される。一定時間（0.5秒）以上処理が継続する場合に表示される。

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

**通知内容の概要**：「Compiling」というタイトルのプログレスバーと、処理中のファイルパスがメッセージとして表示される。

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

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### LSP通知の場合

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

### 本文テンプレート

英語版:
```
Compiling
```

日本語版:
```
コンパイル中です
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | 処理中のファイルパス | ws.getRelativePath(uri) | No |
| percentage | 進捗率 | 計算値 | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイルコンパイル | compileState呼び出し | 処理時間が0.5秒を超える場合 | ファイルの構文解析時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Lua.window.progressBar == false | 設定でプログレスバーが無効の場合 |
| 処理時間が0.5秒未満 | 短時間で完了する場合は表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[compileState呼び出し] --> B[progress.create呼び出し]
    B --> C{delay経過?}
    C -->|No| D[プログレス非表示]
    C -->|Yes| E[window/workDoneProgress/create送信]
    E --> F[$/progress begin送信]
    F --> G[コンパイル処理実行]
    G --> H{処理完了?}
    H -->|No| I[$/progress report送信]
    I --> G
    H -->|Yes| J[$/progress end送信]
    J --> K[プログレス終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| コンパイルエラー | 構文エラー | プログレス終了後、診断として報告 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- ファイルパスが表示されるが、ユーザー本人の作業ファイルのためセキュリティリスクは低い

## 備考

- progress.createの第3引数（delay）で表示遅延を設定可能
- 短時間で完了する処理では表示されない設計

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: シンプルな固定文言として定義されている。

#### Step 2: プログレスシステムを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | progress.lua | `script/progress.lua` | プログレスモジュール全体構造 |
| 2-2 | progress.lua | `script/progress.lua` | create関数（155-168行目） |
| 2-3 | progress.lua | `script/progress.lua` | update関数（81-133行目） |

**主要処理フロー**:
1. **155-168行目**: プログレスバー作成
2. **88-111行目**: 遅延後の表示開始（begin）
3. **124-132行目**: 進捗更新（report）
4. **30-47行目**: プログレス終了（end）

#### Step 3: 使用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | files.lua | `script/files.lua` | compileState関数（673-725行目） |

**主要処理フロー**:
- **697行目**: progress.create呼び出し（WINDOW_COMPILING）
- **698行目**: setMessageでファイルパス設定

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

```
files.compileState (script/files.lua:673)
    │
    └─ progress.create (script/progress.lua:155)
           │
           ├─ [delay後]
           │      │
           │      ├─ proto.request('window/workDoneProgress/create')
           │      │
           │      └─ proto.notify('$/progress', {kind='begin'})
           │
           ├─ [進捗更新時]
           │      │
           │      └─ proto.notify('$/progress', {kind='report'})
           │
           └─ [完了時]
                  │
                  └─ proto.notify('$/progress', {kind='end'})
```

### データフロー図

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

ファイルURI      ───▶  compileState           ───▶  parser.state
                           │
                           ▼
                    progress.create
                    (WINDOW_COMPILING)
                           │
                           ▼
                    [delay経過]
                           │
                           ▼
                    $/progress ────────────▶  LSPクライアント
                    (begin/report/end)         (プログレスバー表示)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| progress.lua | `script/progress.lua` | ソース | プログレスバー管理 |
| files.lua | `script/files.lua` | ソース | ファイル管理、コンパイル処理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| proto.lua | `script/proto/proto.lua` | ソース | LSPプロトコル通信 |
