# 通知設計書 1-spacevim#util#err

## 概要

本ドキュメントは、space-vimにおけるエラーメッセージ表示関数 `spacevim#util#err` の通知仕様を定義するものである。

### 本通知の処理概要

`spacevim#util#err` は、space-vimプラグイン全体で使用される統一的なエラーメッセージ表示関数である。この関数は、ユーザーに対してエラー状態を視覚的に明確に伝えるため、Vimの `ErrorMsg` ハイライトグループを使用して赤色でメッセージを表示する。

**業務上の目的・背景**：space-vimは多数のレイヤーとプラグインで構成される複雑なVim設定フレームワークである。各コンポーネントでエラーが発生した際に、ユーザーが一貫した形式でエラーを認識できるよう、統一されたエラー通知機能が必要とされる。この関数により、どのコンポーネントでエラーが発生しても `[space-vim]` プレフィックス付きの赤色メッセージとして表示され、ユーザーはspace-vim由来のエラーであることを即座に識別できる。

**通知の送信タイミング**：space-vim内の各種処理でエラー状態が検出された際に、当該処理から直接この関数が呼び出されることで通知が発生する。例えば、設定の読み込み失敗、プラグインの初期化エラー、ファイル操作の失敗などの場面で使用される。

**通知の受信者**：Vimエディタを操作しているユーザー本人がメッセージの受信者となる。メッセージはVimのコマンドライン領域に表示される。

**通知内容の概要**：`[space-vim]` というプレフィックスに続いて、具体的なエラー内容を示すメッセージが表示される。メッセージは画面幅に収まるよう自動的に切り詰められる。

**期待されるアクション**：ユーザーはエラーメッセージの内容を確認し、原因を特定して対処する。設定ファイルの修正、不足しているプラグインのインストール、パーミッションの修正などが期待される行動である。

## 通知種別

アプリ内通知（Vimコマンドライン表示）

## 送信仕様

### 基本情報

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

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

現在Vimエディタを操作しているユーザーのコマンドライン領域に直接表示される。特別な送信先決定ロジックは存在しない。

## 通知テンプレート

### アプリ内通知の場合

| 項目 | 内容 |
|-----|------|
| 表示位置 | Vimコマンドライン領域 |
| ハイライト | ErrorMsg（赤色） |
| プレフィックス | [space-vim] |
| 形式 | テキスト |

### 本文テンプレート

```
[space-vim] {エラーメッセージ}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| msg | エラーメッセージ本文 | 呼び出し元関数からの引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | spacevim#util#err(msg)の呼び出し | 常時（呼び出されたら実行） | space-vim内の任意のコンポーネントがエラーを検出した際に呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | 関数が呼び出された場合は常に表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[呼び出し元でエラー検出] --> B[spacevim#util#err呼び出し]
    B --> C[echohl ErrorMsg実行]
    C --> D[TruncatedEcho関数呼び出し]
    D --> E[メッセージの整形・切り詰め]
    E --> F[echomsgでメッセージ表示]
    F --> G[echohl None実行]
    G --> H[ハイライト解除・終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| E523エラー | shortmess設定変更不可時 | TruncatedEcho内でフォールバック処理（手動切り詰め） |
| 表示領域不足 | 画面幅が極端に狭い場合 | メッセージを自動切り詰めして「...」を付与 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（Vimが起動している間は常に表示可能）

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

- エラーメッセージにはファイルパスなどの情報が含まれる可能性があるが、ローカル環境での表示のため特別な保護は不要
- 外部への送信は行わない

## 備考

- この関数はALEプラグインから引用された `TruncatedEcho` 関数を内部で使用している
- メッセージが長い場合は画面幅に合わせて自動的に切り詰められる
- 他の通知関数（warn, info）と同じ構造を持ち、ハイライトグループのみが異なる

---

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

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

### 推奨読解順序

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

エラー通知は単純な文字列メッセージを受け取り、それを整形して表示するだけの構造である。複雑なデータ構造は使用していない。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | util.vim | `core/autoload/spacevim/util.vim` | 関数シグネチャで受け取る引数 `msg` が文字列であることを確認 |

**読解のコツ**: Vim scriptでは `a:` プレフィックスは関数引数を示す。`a:msg` は引数として渡されたメッセージを参照している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | util.vim | `core/autoload/spacevim/util.vim` | spacevim#util#err関数の定義（4-8行目） |

**主要処理フロー**:
1. **4行目**: `function! spacevim#util#err(msg)` - 関数定義。引数として表示するメッセージを受け取る
2. **5行目**: `echohl ErrorMsg` - 以降の出力に赤色のエラーハイライトを適用
3. **6行目**: `call spacevim#vim#cursor#TruncatedEcho('[space-vim] '.a:msg)` - プレフィックスを付与してTruncatedEchoを呼び出し
4. **7行目**: `echohl None` - ハイライトをリセット

#### Step 3: メッセージ表示処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | cursor.vim | `core/autoload/spacevim/vim/cursor.vim` | TruncatedEcho関数の実装（3-38行目） |

**主要処理フロー**:
- **6行目**: タブ文字をスペースに置換
- **8行目**: 改行文字を除去
- **10行目**: shortmessオプションを保存
- **15行目**: shortmessにTフラグを追加（切り詰め有効化）
- **17行目**: echomsgコマンドでメッセージを表示
- **18-25行目**: E523エラー時のフォールバック処理
- **32-33行目**: カーソル位置の復元
- **36行目**: shortmessオプションを元に戻す

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

```
spacevim#util#err(msg)
    │
    ├─ echohl ErrorMsg
    │      └─ Vimのハイライト設定を変更
    │
    ├─ spacevim#vim#cursor#TruncatedEcho('[space-vim] '.msg)
    │      ├─ substitute() - タブ・改行を除去
    │      ├─ setlocal shortmess+=T - 切り詰め有効化
    │      ├─ echomsg - メッセージ表示
    │      └─ setpos() - カーソル位置復元
    │
    └─ echohl None
           └─ ハイライト設定をリセット
```

### データフロー図

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

msg (文字列) ───▶ spacevim#util#err ───▶ コマンドライン領域
                        │                    （赤色表示）
                        │
                        ▼
              [space-vim] プレフィックス付与
                        │
                        ▼
              TruncatedEcho（切り詰め処理）
                        │
                        ▼
                 echomsg で表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| util.vim | `core/autoload/spacevim/util.vim` | ソース | err/warn/info関数の定義 |
| cursor.vim | `core/autoload/spacevim/vim/cursor.vim` | ソース | TruncatedEcho関数の実装 |
