ruvim 0.1.0 → 0.3.0

data/docs/config.md

@@ -61,90 +61,209 @@ setglobal "tabstop=8"
 
 実装の定義元は `lib/ruvim/editor.rb` の `RuVim::Editor::OPTION_DEFS` です。
 
-### `number`
-
-- 型: `bool`
-- 既定スコープ: `window-local`
-- デフォルト: `false`
-- 用途:
-  - 行番号表示の ON/OFF
-  - 描画（`Screen`）に反映
-- 例:
-  - `:set number`
-  - `:set nonumber`
-  - `:setlocal number`
-
-### `relativenumber`
-
-- 型: `bool`
-- 既定スコープ: `window-local`
-- デフォルト: `false`
-- 用途:
-  - 相対行番号表示
-  - `number` 併用時は current line を絶対行番号、それ以外を相対行番号で表示
-- 例:
-  - `:set relativenumber`
-  - `:set norelativenumber`
-  - `:setlocal relativenumber`
-
-### `tabstop`
-
-- 型: `int`
-- 既定スコープ: `buffer-local`
-- デフォルト: `2`
-- 用途:
-  - タブ展開幅（表示幅計算・描画）
-- 例:
-  - `:set tabstop=4`
-  - `:set tabstop?`
-  - `:setlocal tabstop=2`
-  - `:setglobal tabstop=8`
-
-### `filetype`
-
-- 型: `string`
-- 既定スコープ: `buffer-local`
-- デフォルト: `nil`
-- 用途:
-  - filetype-local keymap 解決
-  - ftplugin ロード対象の決定
-- 備考:
-  - 通常は path から自動検出される
-  - 手動で `:set filetype=ruby` も可能
-  - 現状、手動変更時に ftplugin を再適用する仕組みはない
-
-### `ignorecase`
-
-- 型: `bool`
-- 既定スコープ: `global`
-- デフォルト: `false`
-- 用途:
-  - 検索・置換で大文字小文字を無視
-- 例:
-  - `:set ignorecase`
-  - `:set noignorecase`
-
-### `smartcase`
-
-- 型: `bool`
-- 既定スコープ: `global`
-- デフォルト: `false`
-- 用途:
-  - `ignorecase` 有効時、検索パターンに大文字を含む場合は case-sensitive にする
-- 例:
-  - `:set smartcase`
-  - `:set nosmartcase`
-
-### `hlsearch`
-
-- 型: `bool`
-- 既定スコープ: `global`
-- デフォルト: `true`
-- 用途:
-  - 検索マッチの画面ハイライト ON/OFF
-- 例:
-  - `:set hlsearch`
-  - `:set nohlsearch`
+補足:
+- `DONE` / `PARTIAL` / `定義のみ` は、RuVim 内での実装の反映度を示します（Vim 完全互換度ではありません）
+- `PARTIAL` は「主要な場面では効くが、Vim の細部互換までは未実装」の意味です
+
+### Window-local options
+
+- `number` (`bool`, default `false`) [`DONE`]
+  - 行番号表示を有効化します。
+  - `Screen` の行番号ガター描画に反映されます。
+
+- `relativenumber` (`bool`, default `false`) [`DONE`]
+  - 相対行番号を表示します。
+  - `number` 併用時は current line を絶対行番号で表示します。
+
+- `wrap` (`bool`, default `true`) [`PARTIAL`]
+  - 長い行を画面幅で折り返して表示します。
+  - 最小実装として描画ベースで折り返します。Vim のスクロール/カーソル互換は未完成です。
+
+- `linebreak` (`bool`, default `false`) [`PARTIAL`]
+  - `wrap` 時に空白位置を優先して折り返します。
+  - 現状は簡易な空白ベース判定です。
+
+- `breakindent` (`bool`, default `false`) [`PARTIAL`]
+  - `wrap` の継続行に元行のインデントを反映します。
+  - 現状は先頭空白の簡易再利用です。
+
+- `cursorline` (`bool`, default `false`) [`DONE`]
+  - 現在行の背景ハイライトを有効化します。
+  - 検索/選択/カーソル反転より優先度は低く描画されます。
+
+- `scrolloff` (`int`, default `0`) [`DONE`]
+  - 縦スクロール時にカーソル上下の余白行数を維持します。
+  - `Window#ensure_visible` に反映されます。
+
+- `sidescrolloff` (`int`, default `0`) [`DONE`]
+  - 横スクロール時にカーソル左右の余白桁数を維持します。
+  - 表示幅ベースで計算されます（全角/タブを考慮）。
+
+- `numberwidth` (`int`, default `4`) [`DONE`]
+  - 行番号列の最小幅を指定します。
+  - `number` / `relativenumber` のガター幅計算に反映されます。
+
+- `colorcolumn` (`string`, default `nil`) [`DONE`]
+  - 桁ガイド列を背景色で表示します。
+  - 現状は `80` や `80,100` のような数値列指定のみ対応です。
+
+- `signcolumn` (`string`, default `"auto"`) [`PARTIAL`]
+  - サイン列の表示方針を指定します。
+  - 現状は `yes` / `yes:N` の幅予約に対応する最小実装です（サイン自体の描画は未実装）。
+
+- `list` (`bool`, default `false`) [`PARTIAL`]
+  - 不可視文字を可視化します。
+  - 現状は `listchars` と組み合わせた描画の最小対応です。
+
+- `listchars` (`string`, default `"tab:>-,trail:-,nbsp:+"`) [`PARTIAL`]
+  - 不可視文字の表示記号を指定します。
+  - 現状は `tab`, `trail`, `nbsp` のみ使用します。
+
+- `showbreak` (`string`, default `">"`) [`PARTIAL`]
+  - `wrap` 継続行の先頭に表示する文字列です。
+  - 現状は描画にのみ反映されます。
+
+### Global options
+
+- `showmatch` (`bool`, default `false`) [`PARTIAL`]
+  - 閉じ括弧入力時に対応括弧のフィードバックを出します。
+  - 現状は Vim の一時ジャンプ/点滅ではなく、`match` メッセージ表示です。
+
+- `matchtime` (`int`, default `5`) [`PARTIAL`]
+  - `showmatch` の一時メッセージ表示時間（0.1秒単位）です。
+  - 現状は `match` メッセージの自動消去時間に反映されます。
+
+- `whichwrap` (`string`, default `""`) [`PARTIAL`]
+  - 左右移動が行をまたぐ条件を指定します。
+  - 現状は `h` / `l`、左右矢印（`left` / `right`、`<` / `>`）の最小対応です。
+
+- `virtualedit` (`string`, default `""`) [`PARTIAL`]
+  - 実文字のない位置へのカーソル移動可否を指定します。
+  - 現状は `onemore` と `all` の最小対応（主に左右移動と描画）です。
+
+- `ignorecase` (`bool`, default `false`) [`DONE`]
+  - 検索/置換の大文字小文字を無視します。
+  - `smartcase` と組み合わせて挙動が変わります。
+
+- `smartcase` (`bool`, default `false`) [`DONE`]
+  - `ignorecase` 有効時に、パターンに大文字を含む場合だけ case-sensitive にします。
+
+- `hlsearch` (`bool`, default `true`) [`DONE`]
+  - 直前検索パターンのマッチを画面上でハイライトします。
+
+- `incsearch` (`bool`, default `false`) [`PARTIAL`]
+  - `/` `?` の入力中に逐次検索プレビューを行います。
+  - 現状はカーソル移動中心の最小実装で、Esc で元位置に戻ります。
+
+- `splitbelow` (`bool`, default `false`) [`DONE`]
+  - `:split` 時に現在 window の下側へ分割を挿入します。
+
+- `splitright` (`bool`, default `false`) [`DONE`]
+  - `:vsplit` 時に現在 window の右側へ分割を挿入します。
+
+- `hidden` (`bool`, default `false`) [`PARTIAL`]
+  - 未保存バッファを残したまま別バッファへ移動できるようにします。
+  - 現状は `:e`, `:buffer`, `:bnext`, `:bprev`, `:tabnew`, `gf` の主要経路で参照します。
+
+- `autowrite` (`bool`, default `false`) [`PARTIAL`]
+  - 一部のバッファ切替/ファイル移動コマンドの前に、変更済みファイルバッファを自動保存します。
+  - 現状は `:buffer`, `:bnext`, `:bprev`, `:e {file}`, `:tabnew`, `gf` の主要経路で最小対応です。
+  - 無名バッファや特殊バッファは自動保存しません。
+
+- `clipboard` (`string`, default `""`) [`PARTIAL`]
+  - unnamed register を `*` / `+` に連携する方針を指定します。
+  - 現状は `unnamed`, `unnamedplus` の基本連携のみ対応です。
+
+- `timeoutlen` (`int`, default `1000`) [`DONE`]
+  - キーマップの保留入力待ち時間（ms）です。
+  - 曖昧なキーマップ解決のタイムアウトに使います。
+
+- `ttimeoutlen` (`int`, default `50`) [`DONE`]
+  - 端末の ESC シーケンス待ち時間（ms）です。
+  - 矢印キー等の読み取りタイムアウトに使います。
+
+- `backspace` (`string`, default `"indent,eol,start"`) [`PARTIAL`]
+  - Insert mode の Backspace が越えてよい境界を指定します。
+  - 現状は `start`, `eol`, `indent`, `2` の最小判定です（Vim 完全互換ではありません）。
+
+- `completeopt` (`string`, default `"menu,menuone,noselect"`) [`PARTIAL`]
+  - Insert mode 補完 UI/選択挙動を指定します。
+  - 現状は `menu`, `menuone`, `noselect`, `noinsert` をメッセージ行ベースの簡易 UI に反映します。
+
+- `pumheight` (`int`, default `10`) [`PARTIAL`]
+  - 補完候補 UI の最大表示件数です。
+  - 現状はメッセージ行ベースの補完候補表示件数に使います。
+
+- `wildmode` (`string`, default `"full"`) [`PARTIAL`]
+  - コマンドライン補完の Tab 挙動を指定します。
+  - 現状は `longest`, `list`, `full` の最小対応です（`list:full` 形式も可）。
+
+- `wildignore` (`string`, default `""`) [`DONE`]
+  - コマンドライン path 補完から除外するパターンを指定します。
+  - `File.fnmatch?` ベースで判定します。
+
+- `wildignorecase` (`bool`, default `false`) [`DONE`]
+  - `wildignore` のパターンマッチを大文字小文字無視にします。
+
+- `wildmenu` (`bool`, default `false`) [`PARTIAL`]
+  - コマンドライン補完候補の一覧表示 UI を有効化します。
+  - 現状はメッセージ行への簡易表示です（Vim の下部メニュー UI ではない）。
+
+- `termguicolors` (`bool`, default `false`) [`PARTIAL`]
+  - truecolor ANSI シーケンスを使う描画を有効化します。
+  - 現状は検索ハイライト、`cursorline`、`colorcolumn` の背景色に最小反映されます。
+
+### Buffer-local options
+
+- `path` (`string`, default `nil`) [`PARTIAL`]
+  - `gf` などのファイル探索ディレクトリを指定します（`,` 区切り）。
+  - 現状は `gf` の最小探索に利用します（`file:line` の `line` ジャンプにも対応）。
+  - `lib/**` のような再帰探索（簡易）に対応します。
+
+- `suffixesadd` (`string`, default `nil`) [`PARTIAL`]
+  - `gf` などで補完する拡張子候補を指定します（`,` 区切り）。
+  - 現状は `gf` の最小探索に利用します（`file:line` の `path` 部分に適用）。
+
+- `textwidth` (`int`, default `0`) [`定義のみ`]
+  - 自動改行幅の指定です。
+  - 現状は値を保持できるだけで、自動整形には未接続です。
+
+- `formatoptions` (`string`, default `nil`) [`定義のみ`]
+  - 自動整形/コメント継続の挙動を指定します。
+  - 現状は値を保持できるだけで、編集処理には未接続です。
+
+- `expandtab` (`bool`, default `false`) [`DONE`]
+  - Insert mode の Tab 入力を空白に変換します。
+  - `softtabstop` / `tabstop` と組み合わせて空白数を決めます。
+
+- `shiftwidth` (`int`, default `2`) [`PARTIAL`]
+  - インデント幅の基準です。
+  - 現状は `smartindent` の追加インデント幅で使用します。
+
+- `softtabstop` (`int`, default `0`) [`PARTIAL`]
+  - Tab 入力/削除時の編集幅を指定します。
+  - 現状は Insert mode の Tab 入力と、`expandtab` 時の空白 Backspace（最小）で使用します。
+
+- `autoindent` (`bool`, default `false`) [`DONE`]
+  - 改行時に前行の先頭インデントを引き継ぎます。
+  - Insert mode `Enter`、`o`/`O` に反映されます。
+
+- `smartindent` (`bool`, default `false`) [`PARTIAL`]
+  - 簡易な自動インデントを行います。
+  - 現状は前行が `{` `[` `(` で終わる場合に `shiftwidth` 分の空白を追加します。
+
+- `iskeyword` (`string`, default `nil`) [`PARTIAL`]
+  - 単語境界の定義を指定します。
+  - 現状は `w/b/e`、`*` / `#`、一部 text object、Insert 補完の単語抽出に反映します。
+
+- `tabstop` (`int`, default `2`) [`DONE`]
+  - タブの表示幅です。
+  - 表示幅計算、描画、一部編集処理に使います。
+
+- `filetype` (`string`, default `nil`) [`DONE`]
+  - filetype を示します。
+  - ftplugin 読み込み対象、filetype-local keymap、簡易 syntax highlight の判定に使います。
+  - 手動で変更した場合の ftplugin 再適用は現状未対応です。
 
 ## 制限（現状）
 

data/docs/done.md

@@ -30,12 +30,15 @@
 - quickfix / location list（最小）
 - Visual block（`Ctrl-v`、最小）
 - `.` repeat の精度向上（operator + text object + macro 連携）
+- `=` operator（自動インデント: `==`, `=j`, `=k`, `=G`, `=gg`, Visual `=`。Ruby filetype 対応）
 
 ## コマンド / 設計 / 拡張基盤
 
 - `:command`（ユーザー定義 Ex コマンド）
 - `:ruby` / `:rb`
 - バッファ管理コマンド（`:ls`, `:buffers`, `:bnext`, `:bprev`, `:buffer`, `#`）
+- arglist（引数リスト）管理コマンド（`:args`, `:next`, `:prev`, `:first`, `:last`）
+- 複数ファイル起動時に全ファイルをバッファとして読み込む（`:ls` に表示）
 - キーマップのレイヤー化（mode/global/buffer/filetype）
 - option system（global / buffer-local / window-local, `:set` 系）
 - ファイルタイプ検出と ftplugin
@@ -45,6 +48,19 @@
 - block-based keymap DSL（`nmap/imap/map_global ... do |ctx, ...| end`）
 - plugin 向け `ctx.editor / ctx.buffer / ctx.window` API リファレンス（未確定 API 注記つき）
 
+## Rich mode / 構造化データ表示
+
+- Rich View フレームワーク（filetype ごとのレンダラー登録）
+- TSV/CSV テーブルレンダラー（列幅自動計算、CJK 対応、CSV quoted field パース）
+- `:rich [format]` Ex コマンド（トグル）
+- `gr` Normal mode キーバインド（トグル）
+- filetype 検出に `.tsv` / `.csv` 追加
+- Rich View → Rich mode へ変換（仮想バッファ方式から同一バッファ上のモード方式へ）
+- Rich mode の横スクロール修正（`$` で行末に移動した際の縦揃えズレを解消）
+- Markdown Rich mode（見出し・インライン装飾・テーブル罫線・コードブロック・HR・ブロック引用の ANSI レンダリング）
+- `render_rich_view_line_sc` の ANSI エスケープシーケンス対応
+- `ensure_visible_rich` の汎用化（`renderer.cursor_display_col` インターフェース）
+
 ## UI / 画面描画 / 端末挙動
 
 - リサイズ対応（`SIGWINCH` + 即時再描画）
@@ -53,12 +69,14 @@
 - コマンドライン改善（履歴 / 補完 / エラー表示）
 - カーソル位置の強調表示
 - 複数 window / split UI（`:split`, `:vsplit`, window 間移動）
+- ネストしたウィンドウ分割（layout tree: vsplit→split でカラム内だけ上下分割）
 - Tabpage（`:tabnew`, `:tabnext`, `:tabprev`）
 - ヘルプ / コマンド一覧の read-only 仮想バッファ表示
 - intro screen（Vim 風 welcome buffer）
 - エラー表示の改善（最下段・強調表示）
 - PageUp / PageDown 対応
 - `:q` の window/tab/app クローズ挙動を Vim 寄りに調整
+- hit-enter prompt（複数行メッセージ表示: `:ls`, `:args`, `:set`, `:command`）
 
 ## Unicode / 日本語 / 表示幅 / 座標系
 
@@ -69,15 +87,18 @@
 - 表示幅ベース描画の共通化（`TextMetrics` 中心）
 - 日本語/全角を含む操作の整合性確認（`w/b/e`, Visual yank, `p/P`）
 - 描画回帰テストの追加（Unicode / wide char）
+- `truncate` の表示幅計算を文字数ベースから `DisplayWidth` ベースに修正（全角文字を含むエラーメッセージでターミナルがスクロールするバグを修正）
 
 ## 品質 / テスト / CI / パフォーマンス
 
 - テスト追加（Buffer / Dispatcher / Ex parser / KeymapManager）
 - パフォーマンス改善（表示幅ベース水平スクロール / syntax cache）
+- Insert mode ペースト高速化（stdin に pending input がある間はレンダリングをスキップしバッチ処理）
 - rope/piece-table などのバッファ構造検討メモ（`docs/spec.md`）
 - テスト基盤の拡張（結合テスト / snapshot / シナリオ）
 - CI / 開発体験（GitHub Actions, `rake docs:check`, `rake ci`）
 - シンタックスハイライト（最小）
+- Markdown シンタックスハイライト（`Lang::Markdown` に抽出、通常モード + Rich mode で共有）
 - 補完基盤（Ex 補完 / Insert mode 補完）
 
 ## CLI オプション（Vim 風・実装済み / placeholder 含む）

data/docs/lib_cleanup_report.md

@@ -0,0 +1,79 @@
+# lib/ Cleanup Report
+
+このレポートは、`lib/` 配下のコードを対象に、性能面のホットスポットと冗長な実装を見直した内容をまとめたものです。
+
+## 対象と方針
+
+- 対象: `lib/` 配下の全ファイル（重点は描画・文字幅計算・入力/編集のホットパス）
+- 方針:
+  - 挙動を変えない（または最小限）
+  - 依存追加なし
+  - 効果の大きいキャッシュ / 重複除去を優先
+
+## 実施した改善
+
+### 1. `iskeyword` 解析の共通化 + キャッシュ化
+
+変更ファイル:
+- `lib/ruvim/keyword_chars.rb`
+- `lib/ruvim/app.rb`
+- `lib/ruvim/global_commands.rb`
+- `lib/ruvim.rb`
+
+内容:
+- `app.rb` と `global_commands.rb` に重複していた `iskeyword` 解析ロジックを `RuVim::KeywordChars` に切り出し
+- 解析結果（文字クラス文字列 / Regex）を spec 文字列単位でキャッシュ
+
+効果:
+- 冗長コード削減
+- `word motion`, `text object`, `*`, 補完などで繰り返し発生する `iskeyword` 解析コストを低減
+
+### 2. `DisplayWidth` の codepoint 幅計算をキャッシュ化
+
+変更ファイル:
+- `lib/ruvim/display_width.rb`
+- `test/display_width_test.rb`
+
+内容:
+- `tab` 以外の codepoint 幅計算をキャッシュ
+- `RUVIM_AMBIGUOUS_WIDTH` 環境変数の値が変わった場合はキャッシュを自動破棄
+- 初回/ENV変更時のキャッシュ初期化を明示化
+
+効果:
+- 描画 (`Screen`)
+- 文字幅計算 (`TextMetrics`)
+- カーソル位置計算
+
+上記のホットパスで、同一文字の幅判定の再計算を削減
+
+### 3. `Screen` の option 解析キャッシュ (`listchars`, `colorcolumn`)
+
+変更ファイル:
+- `lib/ruvim/screen.rb`
+
+内容:
+- `parse_listchars` を raw 文字列単位でキャッシュ
+- `colorcolumn_display_cols` を raw 文字列単位でキャッシュ
+- `render_cells` の未使用変数 (`idx`) を削除
+
+効果:
+- 行ごと描画時に毎回 `split(',')` / parse していた処理を削減
+- 描画ホットパスの定数処理を軽量化
+
+## 動作確認
+
+- `rake test`
+  - `154 runs, 494 assertions, 0 failures`
+
+## 変更の性質（互換性）
+
+- 基本的に挙動は維持
+- `DisplayWidth` のキャッシュ導入に伴い、`RUVIM_AMBIGUOUS_WIDTH` 変更時の追従をテストで保証
+
+## 今後の改善候補（今回未着手）
+
+- `Screen` の `effective_option(...)` 呼び出しのフレーム内キャッシュ（window/buffer単位）
+- `app.rb` の `completeopt` / `wildmode` / `backspace` など CSV option 解析の共通化 + キャッシュ
+- `GlobalCommands` の `whichwrap` / `virtualedit` / `path` / `suffixesadd` 解析のキャッシュ
+- `TextMetrics.screen_col_for_char_index` の部分再利用（長い行での O(n) 再計算削減）
+

data/docs/plugin.md

@@ -83,9 +83,13 @@ imap "jk", "ui.clear_message"
 
 - 用途:
   - 汎用のキーバインド定義
+  - `mode: nil` で最下位フォールバック map を定義
 - 登録先:
   - `mode:` を指定した場合: その mode の map
   - `mode: nil` の場合: `global map`（最下位フォールバック）
+- 実用上の目安:
+  - 通常は `nmap` / `imap` を使う方が分かりやすい
+  - `map_global` は「複数 mode で共有したい」「フォールバックを置きたい」場合向け
 - 例:
 
 ```ruby
@@ -206,6 +210,10 @@ ex_command_call "Hello", "user.hello", desc: "Run hello"
 
 同じキーが複数定義されている場合、上にあるものが優先されます。
 
+補足:
+- `map_global(..., mode: nil)` は最後に評価されるため、普段の設定では出番は少なめです。
+- まず `nmap` / `imap` で定義し、必要なときだけ `map_global` を使うのがおすすめです。
+
 ## `command` と `ex_command` の違い
 
 ### `command`
@@ -504,19 +512,9 @@ ctx.window.clamp_to_buffer(ctx.buffer)
 - 型: `RuVim::CommandInvocation` または `nil`
 - 意味:
   - 現在実行中のコマンド呼び出し情報
-- 直接使わなくても、通常は `ctx.count` / `ctx.bang?` で足ります
-
-### `ctx.count`
-
-- 型: `Integer`
-- 意味:
-  - Normal mode の count（なければ `1`）
-
-### `ctx.bang?`
-
-- 型: `true` / `false`
-- 意味:
-  - Ex コマンドが `!` 付きで呼ばれたかどうか
+- 主な参照:
+  - `ctx.invocation&.count`
+  - `ctx.invocation&.bang`
 
 ## block で使う引数（`argv`, `kwargs`, `bang`, `count`）
 
@@ -533,9 +531,9 @@ end
 - `kwargs`
   - keymap / 内部呼び出しの named args（Hash）
 - `bang`
-  - `ctx.bang?` と同じ意味
+  - Ex コマンドが `!` 付きで呼ばれたかどうか
 - `count`
-  - `ctx.count` と同じ意味
+  - Normal mode の count（なければ `1`）
 
 ## どこまで plugin と呼べる？