# 通知設計書 33-WINDOW_PROCESSING_RENAME

## 概要

本ドキュメントは、Lua Language Serverにおける「名前変更処理中」通知（WINDOW_PROCESSING_RENAME）の設計を記載する。

### 本通知の処理概要

この通知は、ユーザーがエディタ上で「シンボルの名前変更（リファクタリング）」機能を実行した際に、Language Serverがその処理を実行中であることをユーザーに視覚的に伝えるための進捗表示通知である。

**業務上の目的・背景**：名前変更（リネーム）操作は、ワークスペース全体のシンボル参照を検索し、全ての参照箇所を一括で変更するため、処理時間が長くなる可能性がある。この通知により、ユーザーはリファクタリングが安全に進行中であることを把握でき、処理完了前に編集操作を行うことによる不整合を防ぐことができる。

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

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

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

**期待されるアクション**：ユーザーは処理完了を待つ。処理完了後、エディタは全てのファイルに対する変更をWorkspaceEditとして受け取り、一括適用する。

## 通知種別

LSP進捗通知（window/workDoneProgress）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### LSP進捗通知

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

### 本文テンプレート

```
名前変更を処理しています...
```

英語版:
```
Processing rename...
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[textDocument/renameリクエスト受信] --> B[workspace.awaitReady]
    B --> C[progress.create呼び出し]
    C --> D{0.5秒経過?}
    D -->|Yes| E[window/workDoneProgress/create送信]
    E --> F[$/progress begin通知]
    F --> G[名前変更処理]
    G --> H{処理完了?}
    H -->|Yes| I[$/progress end通知]
    H -->|No| J[$/progress report通知]
    J --> G
    I --> K[WorkspaceEdit返却]
    D -->|No| L{処理完了?}
    L -->|Yes| K
    L -->|No| D
```

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

### 参照テーブル一覧

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

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル未読込 | 対象ファイルが解析されていない | nilを返却 |
| ワークスペース未準備 | ワークスペースの準備が未完了 | awaitReadyで待機 |
| 不正な名前 | 新しい名前が無効（予約語等） | nilを返却 |
| メタファイル | 対象がメタファイル内 | 変更をスキップ |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 進捗通知には機密情報を含めない
- ファイルパスやコード内容は通知メッセージに含まれない

## 備考

- 進捗表示の遅延時間（0.5秒）は固定値で、設定変更不可
- メタファイル内の定義は名前変更対象から除外される
- ライブラリファイル内の参照は通常除外される

---

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

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

### 推奨読解順序

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

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

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

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

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

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

**主要処理フロー**:
1. **559-598行目**: `textDocument/rename`メソッドの登録
2. **570行目**: `progress.create(uri, lang.script.WINDOW_PROCESSING_RENAME, 0.5)`で進捗オブジェクト作成
3. **575-577行目**: `core.rename`モジュールを呼び出して名前変更

#### Step 3: 名前変更コアロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rename.lua | `script/core/rename.lua` | 名前変更のメインロジック |

**主要処理フロー**:
- **391-442行目**: rename関数。参照を検索し変更を生成
- **209行目**: `vm.getRefs(source)`で参照を取得
- **417-419行目**: メタファイルの除外処理

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

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

**主要処理フロー**:
- **534-535行目**: `WINDOW_PROCESSING_RENAME`の日本語定義

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

```
textDocument/rename (provider.lua:559-598)
    │
    ├─ workspace.awaitReady(uri)
    │      └─ ワークスペース準備待機
    │
    ├─ progress.create(uri, title, delay)  (progress.lua:155-168)
    │      └─ 進捗オブジェクト生成
    │          └─ update() → window/workDoneProgress/create
    │                      → $/progress (begin/report/end)
    │
    ├─ files.getState(uri)
    │      └─ ファイルのAST取得
    │
    └─ core.rename(uri, pos, newName)  (rename.lua:391-442)
           ├─ findSource() - ソース位置特定
           ├─ rename() - タイプ別変更処理
           │    ├─ ofLocal() - ローカル変数
           │    ├─ ofField() - フィールド
           │    ├─ ofGlobal() - グローバル
           │    └─ ofDocTypeName() - ドキュメント型名
           └─ vm.isMetaFile() - メタファイル除外
```

### データフロー図

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

textDocument/            provider.lua                   WorkspaceEdit
  rename       ───────▶ ├─ progress.create() ───▶     {changes: {
  リクエスト              │    └─ 進捗通知                  [uri]: TextEdit[]
    │                    ├─ rename.lua                  }}
    │                    │    └─ vm.getRefs()
    │                    └─ 結果変換
    │
    └── params:          進捗通知:                      変更情報:
        ├─ textDocument   ├─ $/progress (begin)         ├─ uri
        │   └─ uri        ├─ $/progress (report)        └─ TextEdit[]
        ├─ position       └─ $/progress (end)               ├─ range
        └─ newName                                          └─ newText
```

### 関連ファイル一覧

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