# 通知設計書 48-WINDOW_LUA_STATUS_WORKSPACE

## 概要

本ドキュメントは、lua-language-serverにおける「ワークスペース情報」通知（WINDOW_LUA_STATUS_WORKSPACE）の設計仕様を定義する。この通知は、ステータスバーのツールチップに現在のワークスペース情報を表示するためのテンプレートメッセージを提供する。

### 本通知の処理概要

この通知は、IDEのステータスバーに表示される「Lua」アイコンのツールチップコンテンツの一部として使用される。現在開いているワークスペースのパス情報を表示し、ユーザーが作業中の環境を把握できるようにする。

**業務上の目的・背景**：マルチワークスペース環境やLuaプロジェクトの開発において、現在の言語サーバーがどのワークスペースを認識しているかを確認できることは重要である。この情報により、ユーザーは設定の適用範囲や言語サービスの対象を把握でき、問題のデバッグやトラブルシューティングに役立つ。

**通知の送信タイミング**：`m.reportStatus`関数が呼び出されるたびに、ステータス情報の一部として送信される。これはサービスのメインループで定期的に実行され、ステータスバーを更新する。

**通知の受信者**：VSCode等のIDEを使用している開発者。ステータスバーの「Lua」アイコンにマウスをホバーした際に表示される。

**通知内容の概要**：「Workspace : {path}」（日本語：「ワークスペース：{path}」）という形式で、各ワークスペースのパスが表示される。複数のワークスペースがある場合は、それぞれの行として表示される。

**期待されるアクション**：ユーザーはこの情報を参照して、現在の言語サーバーの状態を確認する。特別なアクションは不要。

## 通知種別

LSPカスタム通知（`$/status/report`）のツールチップコンテンツ

## 送信仕様

### 基本情報

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

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

LSPクライアントに対して`$/status/report`通知として送信される。`statusBar`オプションが有効な場合にのみ送信される。

## 通知テンプレート

### ステータスツールチップの場合

| 項目 | 内容 |
|-----|------|
| 通知種別 | $/status/report |
| 用途 | ツールチップ内ワークスペース情報 |
| 形式 | テキスト（パラメータ付き） |

### 本文テンプレート

```
英語: Workspace   : {}
日本語: ワークスペース：{}
中国語(簡体): 工作区：{}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {} | ワークスペースパス | furi.decode(scp.uri) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 定期実行 | m.reportStatus | statusBar オプション有効 | サービスメインループ |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| statusBar オプション無効 | クライアントがステータスバーをサポートしない場合 |
| 前回と同じ内容 | util.equal(m.lastInfo, info)がtrueの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[m.reportStatus呼び出し] --> B{statusBar有効?}
    B -->|No| C[return - 処理終了]
    B -->|Yes| D[info構築開始]
    D --> E[ws.foldersをループ]
    E --> F[WINDOW_LUA_STATUS_WORKSPACE展開]
    F --> G[tooltipsに追加]
    G --> H{全ワークスペース処理完了?}
    H -->|No| E
    H -->|Yes| I[WINDOW_LUA_STATUS_CACHED_FILES追加]
    I --> J[WINDOW_LUA_STATUS_MEMORY_COUNT追加]
    J --> K{前回と同じ内容?}
    K -->|Yes| C
    K -->|No| L[proto.notify $/status/report]
    L --> M[終了]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | N/A | データベース不使用 |

### メモリ内データ参照

| 変数/テーブル | 用途 | 説明 |
|--------------|------|------|
| ws.folders | ワークスペース一覧 | scopeオブジェクトの配列 |
| scp.uri | ワークスペースURI | 各ワークスペースのURI |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| URI変換失敗 | furi.decodeが失敗した場合 | ログ記録、エラーメッセージ表示 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 更新間隔 | サービスメインループの実行間隔に依存 |
| 重複排除 | util.equalによる前回値との比較 |

### 配信時間帯

制限なし（サービス稼働中は常時）

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

- ワークスペースパス（ローカルファイルパス）が表示される
- 外部ネットワークには送信されない（クライアント-サーバー間のローカル通信）
- 機密性の高いパスが含まれる可能性があるため、共有環境では注意

## 備考

- 複数のワークスペースがある場合、それぞれの行として表示される
- 関連する通知：WINDOW_LUA_STATUS_CACHED_FILES、WINDOW_LUA_STATUS_MEMORY_COUNT、WINDOW_LUA_STATUS_TIP
- statusBarオプションはクライアントの初期化時に設定される

---

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

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

### 推奨読解順序

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

reportStatus関数の全体構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | service.lua | `script/service/service.lua` | 211-245行目：reportStatus関数全体 |

**読解のコツ**: この関数はステータスバー情報を構築してLSPクライアントに送信する。`client.getOption('statusBar')`でサポート確認を行う。

#### Step 2: ワークスペース情報の収集を理解する

ワークスペースパスの取得と表示を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | service.lua | `script/service/service.lua` | 230-232行目：ワークスペースループ |

**主要処理フロー**:
1. **230行目**: `for i, scp in ipairs(ws.folders) do` - ワークスペースループ
2. **231行目**: `lang.script('WINDOW_LUA_STATUS_WORKSPACE', furi.decode(scp.uri))` - パス展開

#### Step 3: ツールチップの構築を理解する

全体のツールチップ内容の構築を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | service.lua | `script/service/service.lua` | 224-237行目：tooltips配列の構築 |
| 3-2 | service.lua | `script/service/service.lua` | 239行目：table.concatで結合 |

**主要処理フロー**:
- **231行目**: WINDOW_LUA_STATUS_WORKSPACEを追加
- **233行目**: WINDOW_LUA_STATUS_CACHED_FILESを追加
- **234行目**: WINDOW_LUA_STATUS_MEMORY_COUNTを追加
- **239行目**: `table.concat(tooltips, '\n')`で改行区切りで結合

#### Step 4: 送信処理を理解する

LSP通知の送信を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | service.lua | `script/service/service.lua` | 240-244行目：送信処理 |

**主要処理フロー**:
- **240-242行目**: `util.equal(m.lastInfo, info)`で前回との比較
- **244行目**: `proto.notify('$/status/report', info)`で送信

#### Step 5: 言語リソースを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | script.lua | `locale/en-us/script.lua` | 564-565行目：英語メッセージ |
| 5-2 | script.lua | `locale/ja-jp/script.lua` | 564-565行目：日本語メッセージ |

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

```
m.reportStatus (service.lua:211)
    |
    +-- client.getOption('statusBar') (212行目)
    |
    +-- [info構築] (215-222行目)
    |       +-- m.workingClock / m.sleeping に基づくtext設定
    |
    +-- [tooltips構築] (224-237行目)
    |       |
    |       +-- for i, scp in ipairs(ws.folders) (230行目)
    |       |       |
    |       |       +-- lang.script('WINDOW_LUA_STATUS_WORKSPACE', furi.decode(scp.uri))
    |       |
    |       +-- lang.script('WINDOW_LUA_STATUS_CACHED_FILES', params) (233行目)
    |       +-- lang.script('WINDOW_LUA_STATUS_MEMORY_COUNT', params) (234行目)
    |
    +-- table.concat(tooltips, '\n') (239行目)
    |
    +-- util.equal(m.lastInfo, info) (240行目)
    |
    +-- proto.notify('$/status/report', info) (244行目)
```

### データフロー図

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

ws.folders       ───▶  reportStatus関数
                            |
scp.uri          ───▶  furi.decode          ───▶  パス文字列
                            |
                            ▼
                       lang.script展開       ───▶  "Workspace : /path/to/project"
                            |
                            ▼
                       table.concat          ───▶  ツールチップ文字列
                            |
                            ▼
                       proto.notify          ───▶  $/status/report通知
                       '$/status/report'
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| service.lua | `script/service/service.lua` | ソース | サービスメイン処理 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理（ws.folders） |
| file-uri.lua | `script/file-uri.lua` | ソース | URI変換（furi.decode） |
| proto.lua | `script/proto/proto.lua` | ソース | LSP通知送信 |
| script.lua | `locale/en-us/script.lua` | 言語リソース | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
