# 通知設計書 4-spacevim#vim#cursor#TruncatedEcho

## 概要

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

### 本通知の処理概要

`spacevim#vim#cursor#TruncatedEcho` は、長いメッセージを画面幅に合わせて自動的に切り詰めて表示する基盤関数である。この関数はALEプラグインから引用されたコードであり、space-vimの他の通知関数（err, warn, info）の内部で共通して使用される。

**業務上の目的・背景**：Vimのコマンドライン領域は画面幅に制限があり、長いメッセージを表示すると「Press ENTER or type command to continue」というプロンプトが表示されてユーザーの操作が中断される。この問題を解決するため、メッセージを画面幅に収まるよう自動的に切り詰める機能が必要とされる。本関数により、どのような長さのメッセージでもスムーズに表示でき、ユーザーの操作性が向上する。

**通知の送信タイミング**：この関数は直接呼び出されるのではなく、`spacevim#util#err`、`spacevim#util#warn`、`spacevim#util#info` などの上位関数から内部的に呼び出される。したがって、これらの上位関数が呼び出されたタイミングで本関数も実行される。

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

**通知内容の概要**：呼び出し元から渡されたメッセージがそのまま、または切り詰められた形で表示される。切り詰められた場合は末尾に「...」が付与される。

**期待されるアクション**：ユーザーは表示されたメッセージを読み、内容を把握する。メッセージが切り詰められている場合、重要な情報が欠落している可能性があるため、`:messages` コマンドで完全なメッセージを確認することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 呼び出し元に依存 |
| リトライ | 無し |

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 表示位置 | Vimコマンドライン領域 |
| ハイライト | 呼び出し元で設定（本関数では設定しない） |
| プレフィックス | なし（呼び出し元で付与） |
| 形式 | テキスト |

### 本文テンプレート

```
{メッセージ}
```

または切り詰め時：

```
{切り詰められたメッセージ}...
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 関数呼び出し | spacevim#vim#cursor#TruncatedEcho(msg)の呼び出し | 常時（呼び出されたら実行） | 上位関数（err, warn, info）から内部的に呼び出される |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[TruncatedEcho呼び出し] --> B[タブ文字をスペースに置換]
    B --> C[改行文字を除去]
    C --> D[shortmessオプションを保存]
    D --> E[shortmess+=T を設定]
    E --> F{echomsg実行}
    F -->|成功| G[カーソル位置を復元]
    F -->|E523エラー| H[手動切り詰め処理]
    H --> I[画面幅でメッセージを切り詰め]
    I --> J[切り詰めたメッセージを表示]
    J --> G
    G --> K[shortmessオプションを復元]
    K --> L[終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| E523エラー | shortmess設定変更が不可能な状況 | 手動でメッセージを切り詰めてechomsgで表示 |
| 表示領域不足 | 画面幅が極端に狭い場合 | メッセージを画面幅-4文字で切り詰め、「...」を付与 |
| カーソル位置ずれ | echomsg実行後にカーソルが移動 | setpos()でカーソル位置を元に戻す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- このコードはALEプラグイン（Asynchronous Lint Engine）から引用されている
- ALEのissue #1987で報告されたE523エラーへの対応が含まれている
- Vimパッチ8.1.0998でカーソル位置がずれる問題が認識されており、その対策が実装されている
- この関数は基盤関数として位置づけられ、直接呼び出すことは推奨されない

---

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

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

### 推奨読解順序

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

本関数は単純な文字列メッセージを受け取り、それを整形して表示する。複雑なデータ構造は使用していない。

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

**読解のコツ**: Vim scriptでは `a:` プレフィックスは関数引数を、`l:` プレフィックスはローカル変数を示す。

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

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

**主要処理フロー**:
1. **3行目**: `function! spacevim#vim#cursor#TruncatedEcho(msg) abort` - 関数定義
2. **4行目**: `let l:msg = a:msg` - 引数をローカル変数にコピー
3. **6行目**: `let l:msg = substitute(l:msg, "\t", ' ', 'g')` - タブをスペースに置換
4. **8行目**: `let l:msg = substitute(l:msg, "\n", '', 'g')` - 改行を除去
5. **10行目**: `let l:shortmess_options = &l:shortmess` - shortmessオプションを保存
6. **12行目**: `let l:cursor_position = getpos('.')` - カーソル位置を保存
7. **15行目**: `setlocal shortmess+=T` - 切り詰め有効化
8. **17行目**: `exec "norm! :echomsg l:msg\n"` - メッセージ表示
9. **18-25行目**: E523エラー時のフォールバック処理
10. **32-33行目**: カーソル位置の復元
11. **36行目**: `let &l:shortmess = l:shortmess_options` - shortmessオプションを復元

#### Step 3: エラー処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | cursor.vim | `core/autoload/spacevim/vim/cursor.vim` | E523エラーのフォールバック処理（18-25行目） |

**主要処理フロー**:
- **18行目**: `catch /^Vim\%((\a\+)\)\=:E523/` - E523エラーをキャッチ
- **20行目**: `let l:winwidth = winwidth(0)` - 現在のウィンドウ幅を取得
- **21行目**: `if l:winwidth < strdisplaywidth(l:msg)` - メッセージが画面幅より長いか判定
- **23行目**: `let l:msg = l:msg[:l:winwidth - 4] . '...'` - メッセージを切り詰めて「...」を付与
- **25行目**: `exec 'echomsg l:msg'` - 切り詰めたメッセージを表示

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

```
spacevim#vim#cursor#TruncatedEcho(msg)
    │
    ├─ substitute() - タブ文字をスペースに置換
    │
    ├─ substitute() - 改行文字を除去
    │
    ├─ getpos('.') - カーソル位置を保存
    │
    ├─ setlocal shortmess+=T - 切り詰め有効化
    │
    ├─ exec "norm! :echomsg l:msg\n" - メッセージ表示
    │      │
    │      └─ [E523エラー時] フォールバック処理
    │             ├─ winwidth(0) - 画面幅取得
    │             ├─ strdisplaywidth() - 表示幅計算
    │             └─ 手動切り詰め
    │
    ├─ setpos('.') - カーソル位置復元（必要時）
    │
    └─ &l:shortmess 復元
```

### データフロー図

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

msg (文字列) ───▶ タブ/改行除去 ───▶ 切り詰め判定 ───▶ コマンドライン領域
                                          │
                                          ├─ 画面幅内 → そのまま表示
                                          │
                                          └─ 画面幅超過 → 切り詰めて「...」付与
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| cursor.vim | `core/autoload/spacevim/vim/cursor.vim` | ソース | TruncatedEcho関数の実装 |
| util.vim | `core/autoload/spacevim/util.vim` | ソース | 呼び出し元関数（err, warn, info） |
