# 通知設計書 49-WINDOW_LUA_STATUS_CACHED_FILES

## 概要

本ドキュメントは、lua-language-serverにおける「キャッシュファイル情報」通知（WINDOW_LUA_STATUS_CACHED_FILES）の設計仕様を定義する。この通知は、ステータスバーのツールチップにキャッシュされたファイル数を表示するためのテンプレートメッセージを提供する。

### 本通知の処理概要

この通知は、IDEのステータスバーに表示される「Lua」アイコンのツールチップコンテンツの一部として使用される。現在キャッシュされているLuaファイルの数と、設定されている最大ファイル数を表示し、言語サーバーの状態を把握できるようにする。

**業務上の目的・背景**：言語サーバーは解析したLuaファイルをメモリにキャッシュして、補完や定義ジャンプなどの機能を提供する。このキャッシュ状況を表示することで、ユーザーはプロジェクトのファイルがどの程度読み込まれているかを確認でき、パフォーマンスやリソース使用状況の把握に役立つ。特にプリロード上限に達した場合の診断にも有用である。

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

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

**通知内容の概要**：「Cached files: {ast}/{max}」（日本語：「キャッシュされたファイル：{ast}/{max}」）という形式で、現在のキャッシュファイル数（ast）と最大数（max）が表示される。

**期待されるアクション**：ユーザーはこの情報を参照して、キャッシュ状況を確認する。プリロード上限に達している場合は、設定変更を検討する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
英語: Cached files: {ast}/{max}
日本語: キャッシュされたファイル：{ast}/{max}
中国語(簡体): 缓存文件: {ast}/{max}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {ast} | キャッシュファイル数（解析済みAST数） | files.countStates() | Yes |
| {max} | 最大ファイル数 | files.fileCount | 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[params構築]
    D --> E[ast = files.countStates]
    E --> F[max = files.fileCount]
    F --> G[WINDOW_LUA_STATUS_CACHED_FILES展開]
    G --> H[tooltipsに追加]
    H --> I{前回と同じ内容?}
    I -->|Yes| C
    I -->|No| J[proto.notify $/status/report]
    J --> K[終了]
```

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

### 参照テーブル一覧

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

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

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

| 変数/関数 | 用途 | 説明 |
|----------|------|------|
| files.countStates() | キャッシュ数取得 | 解析済みASTの数を返す |
| files.fileCount | 最大ファイル数 | プリロードされたファイル総数 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 数値取得失敗 | files.countStates等が失敗した場合 | デフォルト値（0）を使用 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ファイル数のみを表示し、ファイル名やパスは含まれない
- 外部ネットワークには送信されない（クライアント-サーバー間のローカル通信）
- 機密情報は含まれない

## 備考

- astはAbstract Syntax Tree（抽象構文木）の略で、解析済みファイル数を示す
- maxはプリロード設定（Lua.workspace.maxPreload）によって制限される
- 関連する通知：WINDOW_LUA_STATUS_WORKSPACE、WINDOW_LUA_STATUS_MEMORY_COUNT

---

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

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

### 推奨読解順序

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

reportStatus関数でのパラメータ構築を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | service.lua | `script/service/service.lua` | 225-229行目：params構築 |

**主要処理フロー**:
1. **226行目**: `ast = files.countStates()` - キャッシュ数取得
2. **227行目**: `max = files.fileCount` - 最大ファイル数取得
3. **228行目**: `mem = collectgarbage('count') / 1000` - メモリ使用量取得

#### Step 2: メッセージ展開を理解する

テンプレートへのパラメータ挿入を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | service.lua | `script/service/service.lua` | 233行目：WINDOW_LUA_STATUS_CACHED_FILES展開 |

**主要処理フロー**:
- **233行目**: `lang.script('WINDOW_LUA_STATUS_CACHED_FILES', params)` - パラメータ付きで展開

#### Step 3: files.countStatesを理解する

キャッシュ数のカウント方法を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | files.lua | `script/files.lua` | countStates関数の定義箇所 |

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

テンプレート変数の形式を理解する。

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

**読解のコツ**: `{ast}`と`{max}`は名前付きプレースホルダー。params.astとparams.maxがそれぞれ挿入される。

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

```
m.reportStatus (service.lua:211)
    |
    +-- [params構築] (225-229行目)
    |       |
    |       +-- files.countStates() → params.ast
    |       +-- files.fileCount → params.max
    |       +-- collectgarbage('count') / 1000 → params.mem
    |
    +-- [tooltips構築] (224-237行目)
    |       |
    |       +-- lang.script('WINDOW_LUA_STATUS_CACHED_FILES', params) (233行目)
    |               |
    |               +-- "Cached files: {ast}/{max}" → "Cached files: 150/500"
    |
    +-- proto.notify('$/status/report', info) (244行目)
```

### データフロー図

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

files.countStates()  ───▶  params.ast = 150
                                |
files.fileCount      ───▶  params.max = 500
                                |
                                ▼
                           lang.script展開      ───▶  "Cached files: 150/500"
                                |
                                ▼
                           table.concat         ───▶  ツールチップ文字列
                                |
                                ▼
                           proto.notify         ───▶  $/status/report通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| service.lua | `script/service/service.lua` | ソース | サービスメイン処理 |
| files.lua | `script/files.lua` | ソース | ファイル管理・キャッシュ |
| proto.lua | `script/proto/proto.lua` | ソース | LSP通知送信 |
| script.lua | `locale/en-us/script.lua` | 言語リソース | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
