# 通知設計書 3-spacevim#util#info

## 概要

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

### 本通知の処理概要

`spacevim#util#info` は、space-vimプラグイン全体で使用される統一的な情報メッセージ表示関数である。この関数は、ユーザーに対して一般的な情報や状態を通知するために使用され、通常のテキスト色（ハイライトなし）でメッセージを表示する。

**業務上の目的・背景**：space-vimの運用において、エラーや警告ではない通常の情報（処理の完了通知、現在の状態表示、ヒントの提示など）をユーザーに伝える必要がある。この情報通知機能により、ユーザーは操作の結果や現在の状態を把握できる。通常色での表示により、緊急性のない情報であることを視覚的に示す。

**通知の送信タイミング**：space-vim内の各種処理で情報を通知すべき場面において、当該処理から直接この関数が呼び出されることで通知が発生する。例えば、設定の読み込み完了、プラグインの状態表示、ユーザーへのヒント提示などの場面で使用される。

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

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

**期待されるアクション**：ユーザーは情報メッセージの内容を確認し、必要に応じて参考にする。特別な対応が必要とされることは少なく、主に状態確認や情報提供が目的である。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
[space-vim] {情報メッセージ}
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[呼び出し元で情報通知] --> B[spacevim#util#info呼び出し]
    B --> C[TruncatedEcho関数呼び出し]
    C --> D[メッセージの整形・切り詰め]
    D --> E[echomsgでメッセージ表示]
    E --> F[終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- この関数は `spacevim#util#err` や `spacevim#util#warn` と異なり、echohl によるハイライト設定を行わない
- 最もシンプルな実装で、TruncatedEchoを直接呼び出すのみ
- メッセージが長い場合は画面幅に合わせて自動的に切り詰められる

---

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

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

### 推奨読解順序

#### 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#info関数の定義（16-18行目） |

**主要処理フロー**:
1. **16行目**: `function! spacevim#util#info(msg)` - 関数定義。引数として表示するメッセージを受け取る
2. **17行目**: `call spacevim#vim#cursor#TruncatedEcho('[space-vim] '.a:msg)` - プレフィックスを付与してTruncatedEchoを呼び出し
3. **18行目**: `endfunction` - 関数終了

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

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

**主要処理フロー**:
- **6行目**: タブ文字をスペースに置換
- **8行目**: 改行文字を除去
- **10行目**: shortmessオプションを保存
- **15行目**: shortmessにTフラグを追加（切り詰め有効化）
- **17行目**: echomsgコマンドでメッセージを表示

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

```
spacevim#util#info(msg)
    │
    └─ spacevim#vim#cursor#TruncatedEcho('[space-vim] '.msg)
           ├─ substitute() - タブ・改行を除去
           ├─ setlocal shortmess+=T - 切り詰め有効化
           ├─ echomsg - メッセージ表示
           └─ setpos() - カーソル位置復元
```

### データフロー図

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

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

### 関連ファイル一覧

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