# 通知設計書 55-WINDOW_CHECK_SEMANTIC

## 概要

本ドキュメントは、Lua Language Serverにおけるセマンティックハイライト設定案内通知（WINDOW_CHECK_SEMANTIC）の設計仕様を定義するものである。

### 本通知の処理概要

本通知は、ユーザーがマーケットプレイスのカラーテーマを使用している場合に、セマンティックハイライトを有効にするための設定案内メッセージを表示する。VSCodeのセマンティックトークン機能を活用するために必要な追加設定をユーザーに通知する役割を果たす。

**業務上の目的・背景**：Lua Language Serverはセマンティックトークン（変数の種類、関数、定数などをより詳細に識別する機能）を提供しているが、一部のカラーテーマではこの機能がデフォルトで無効になっている場合がある。この通知は、ユーザーが `editor.semanticHighlighting.enabled` 設定を `true` に変更する必要があることを案内し、より豊かなシンタックスハイライトを体験できるようサポートする。

**通知の送信タイミング**：セマンティックハイライトの設定が必要と判断された場合に表示される。具体的なトリガー条件は、セマンティックトークンのサポートを確認する処理に関連する。

**通知の受信者**：エディタ（VSCode等のLSPクライアント）を使用しているユーザー。情報メッセージとして表示される。

**通知内容の概要**：マーケットプレイスのカラーテーマを使用している場合、`editor.semanticHighlighting.enabled` を `true` に設定する必要があるかもしれないという案内メッセージ。

**期待されるアクション**：ユーザーがVSCodeの設定で `editor.semanticHighlighting.enabled` を `true` に変更することを期待。

## 通知種別

アプリ内通知（情報メッセージ）

## 送信仕様

### 基本情報

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

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

- 送信先はLSPクライアント（エディタ）
- セマンティックハイライト設定が必要な場合に表示

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| 表示場所 | エディタ通知領域 |
| 形式 | テキスト（マークダウン対応） |

### 本文テンプレート

英語版:
```
If you are using the color theme in the market, you may need to modify `editor.semanticHighlighting.enabled` to `true` to make semantic tokens take effect.
```

日本語版:
```
マーケットプレイスのカラーテーマを使用している場合、セマンティックハイライトを有効にするには `editor.semanticHighlighting.enabled` オプションを `true` に設定する必要があるかもしれまん。
```

### 添付ファイル

該当なし

## テンプレート変数

該当なし（固定メッセージ）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 設定確認 | セマンティックトークン関連処理 | 設定が必要と判断された場合 | カラーテーマ使用時の案内 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 設定済みの場合 | 既に`editor.semanticHighlighting.enabled`が`true`の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[セマンティックトークン処理] --> B{設定確認}
    B -->|設定必要| C[WINDOW_CHECK_SEMANTICメッセージ表示]
    B -->|設定済み| D[処理継続]
    C --> E[ユーザーに設定変更を案内]
    E --> F[終了]
    D --> F
```

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

### 参照テーブル一覧

該当なし（データベースを使用しない）

### 更新テーブル一覧

該当なし（データベースを使用しない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | - | - |

### リトライ仕様

該当なし

## 配信設定

### レート制限

該当なし

### 配信時間帯

制限なし

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

- 個人情報を含まない固定メッセージのため、特別な考慮は不要
- 設定変更の案内のみであり、自動的に設定を変更しない

## 備考

- VSCodeのセマンティックハイライト機能に関連する通知
- マークダウン形式で設定項目がバッククォートで囲まれている
- 一部の言語版（日本語版）にタイポが含まれている可能性がある（「かもしれまん」）

---

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

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

### 推奨読解順序

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

まず、通知メッセージの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | WINDOW_CHECK_SEMANTICの英語メッセージ定義（583-584行目） |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | WINDOW_CHECK_SEMANTICの日本語メッセージ定義（583-584行目） |

**読解のコツ**: メッセージ内のバッククォート（`）で囲まれた部分は設定項目名を示している。

#### Step 2: セマンティックトークン処理を理解する

セマンティックトークンの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | provider.lua | `script/provider/provider.lua` | セマンティックトークン関連ハンドラー（1079-1140行目） |

**主要処理フロー**:
1. **1082-1107行目**: `textDocument/semanticTokens/full` ハンドラー
2. **1111-1140行目**: `textDocument/semanticTokens/range` ハンドラー

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

```
セマンティックトークン処理
    │
    ├─ textDocument/semanticTokens/full [1082行目]
    │      └─ lang.script.WINDOW_PROCESSING_SEMANTIC_FULL [1099行目]
    │
    └─ textDocument/semanticTokens/range [1111行目]
           └─ lang.script.WINDOW_PROCESSING_SEMANTIC_RANGE [1127行目]

設定案内（別処理）
    │
    └─ client.showMessage または requestMessage
           └─ lang.script.WINDOW_CHECK_SEMANTIC ← 本通知
```

### データフロー図

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

カラーテーマ ───▶ 設定状態確認 ───▶ 案内必要性判定
使用検出                                      │
                                              ▼
                     lang.script() ───▶ WINDOW_CHECK_SEMANTIC
                                              │
                                              ▼
                     showMessage ───▶ [クライアント（エディタ）]
                                              │
                                              ▼
                                        設定案内メッセージ表示
                                              │
                                              ▼
                              [ユーザーによる設定変更]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | 設定 | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 設定 | 日本語メッセージ定義 |
| provider.lua | `script/provider/provider.lua` | ソース | セマンティックトークンハンドラー |
| client.lua | `script/client.lua` | ソース | メッセージ表示処理 |
| define.lua | `script/proto/define.lua` | ソース | トークンタイプ・モディファイア定義 |
