# 通知設計書 20-レイヤーステータス表示

## 概要

本ドキュメントは、space-vimのレイヤーステータス機能（spacevim#layer#status）において、有効なレイヤーの一覧を新しいウィンドウに表示する通知の設計を記載する。

### 本通知の処理概要

レイヤーステータス表示は、現在有効になっているspace-vimのレイヤー一覧を専用のウィンドウに表示する機能である。:LayerStatusコマンドで呼び出される。

**業務上の目的・背景**：space-vimは多数のレイヤーで構成されており、どのレイヤーが有効になっているかを確認することは設定の把握やトラブルシューティングにおいて重要である。この通知により、ユーザーは現在の設定状態を視覚的に確認できる。

**通知の送信タイミング**：:LayerStatusコマンドが実行された時点で、新しいウィンドウが開かれてレイヤー一覧が表示される。

**通知の受信者**：Vim/NeoVimを使用しているspace-vimユーザー。新しい垂直分割ウィンドウにレイヤー一覧が表示される。

**通知内容の概要**：「Enabled layers: (有効数/総数)」というヘッダーとともに、プログレスバー風の表示、および有効な各レイヤーの名前が「+ レイヤー名」の形式でリスト表示される。

**期待されるアクション**：ユーザーはレイヤー一覧を確認し、必要に応じて.spacevimファイルを編集してレイヤー設定を変更する。qキーでウィンドウを閉じることができる。

## 通知種別

Vimウィンドウ表示（専用バッファ）

## 送信仕様

### 基本情報

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

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

新しい垂直分割ウィンドウ（vertical topleft new）を作成して表示する。ウィンドウ位置は`g:spacevim_window`変数でカスタマイズ可能。

## 通知テンプレート

### Vimウィンドウの場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 新規垂直分割ウィンドウ |
| 形式 | カスタムシンタックスハイライト付きテキスト |

### 本文テンプレート

```
Enabled layers: (有効レイヤー数/総レイヤー数)
[===...===]
+ レイヤー名1
+ レイヤー名2
...
```

- 1行目: 有効レイヤー数と総数のサマリー
- 2行目: プログレスバー風の表示（=の数は有効レイヤー数に対応）
- 3行目以降: 各有効レイヤーの名前（+プレフィックス付き）

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| g:spacevim.loaded | 有効レイヤーリスト | グローバル変数 | Yes |
| g:spacevim | 総レイヤー情報 | グローバル変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | :LayerStatus | 常時 | spacevim#layer#status関数呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | コマンド実行時は常に表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[:LayerStatus実行] --> B[spacevim#layer#status呼び出し]
    B --> C[s:new_window で新規ウィンドウ作成]
    C --> D[バッファ変数初期化]
    D --> E[s:assign_name でバッファ名設定]
    E --> F[ヘッダー行挿入]
    F --> G[プログレスバー行挿入]
    G --> H[各レイヤー名を挿入]
    H --> I[バッファオプション設定]
    I --> J[シンタックスハイライト設定]
    J --> K[qキーマッピング設定]
    K --> L[終了]
```

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

### 参照テーブル一覧

該当なし（Vimグローバル変数を参照）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ウィンドウ作成失敗 | 稀なエッジケース | Vimの標準エラー処理に依存 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（コマンド実行時に即座に表示）

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

- 機密情報は含まれない（レイヤー名のみ）
- 外部通信なし
- ユーザー入力は処理されない

## 備考

- 関数は`core/autoload/spacevim/layer.vim`の26-51行目で定義
- plug.vimから抽出されたコード（コメントに記載）
- バッファは`buftype=nofile`で一時的なバッファとして作成
- シンタックスハイライトは`s:syntax()`関数で設定（53-92行目）
- qキーで`:bd`（バッファ削除）が実行されウィンドウが閉じる

---

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

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

### 推奨読解順序

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

レイヤー情報を保持するグローバル変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | layer.vim | `core/autoload/spacevim/layer.vim` | スクリプトローカル変数（1-2行目） |

**読解のコツ**: `g:spacevim.loaded`は有効なレイヤーのリスト、`g:spacevim`は全体の設定辞書を保持する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | layer.vim | `core/autoload/spacevim/layer.vim` | spacevim#layer#status関数（26-51行目） |

**主要処理フロー**:
1. **27行目**: `call s:new_window()` - 新規ウィンドウ作成
2. **29-32行目**: バッファ変数とタブ/バッファ番号設定
3. **34-36行目**: レイヤー数計算
4. **38行目**: ヘッダー行挿入
5. **39行目**: プログレスバー行挿入
6. **40-44行目**: 各レイヤー名を挿入
7. **45行目**: バッファオプション設定
8. **46-49行目**: シンタックスハイライトとキーマッピング

#### Step 3: ウィンドウ作成ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | layer.vim | `core/autoload/spacevim/layer.vim` | s:new_window関数（4-6行目） |
| 3-2 | layer.vim | `core/autoload/spacevim/layer.vim` | s:assign_name関数（13-23行目） |

**主要処理フロー**:
- **5行目**: `execute get(g:, 'spacevim_window', 'vertical topleft new')` - ウィンドウ作成
- **15-21行目**: バッファ名の一意性を確保

#### Step 4: シンタックスハイライト設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | layer.vim | `core/autoload/spacevim/layer.vim` | s:syntax関数（53-92行目） |

**主要処理フロー**:
- **54-69行目**: シンタックス定義
- **72-91行目**: ハイライトグループとのリンク

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

```
:LayerStatus (コマンド)
    |
    +-- spacevim#layer#status (26-51行目)
            |
            +-- s:new_window (4-6行目)
            |       +-- execute 'vertical topleft new'
            |
            +-- s:assign_name (13-23行目)
            |       +-- バッファ名 '[Layers]' を設定
            |
            +-- append / setline
            |       +-- ヘッダー、プログレスバー、レイヤー名を挿入
            |
            +-- setlocal (バッファオプション設定)
            |
            +-- s:syntax (53-92行目)
            |       +-- シンタックスハイライト定義
            |
            +-- nnoremap q :bd<CR>
                    +-- qキーでバッファ削除
```

### データフロー図

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

g:spacevim.loaded ──▶ spacevim#layer#status ──▶ 新規ウィンドウ
(有効レイヤーリスト)         |                     |
                     ループでレイヤー名取得    Enabled layers: (x/y)
                            |                  [===...===]
                     setline で行挿入         + layer1
                            |                  + layer2
                     シンタックスハイライト       ...
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| layer.vim | `core/autoload/spacevim/layer.vim` | ソース | レイヤー管理機能の実装 |
