🐶

カーソル下の検索文字をフラッシュ & 検索件数をecho

2022/08/09に公開

3件

Lua

Neovim

tech

個人的な趣味でピカピカしているものが好きなので、Windows + gVim 環境では n, N 打鍵時にカーソル下の検索文字をフラッシュさせてました。あとvim-anzuを使って検索件数を echo しています(カーソルの残像残っちゃっているのはご愛嬌ということで)

Neovim でも同じ挙動にしたかったので、Lua でプラグインを 2 つ作成しました。
検索時のフラッシュはutahraptor.nvim、検索件数の表示はbistahieversor.nvimで行えます

normal モードの * 打鍵時も検索件数の echo、フラッシュを行って欲しいので
lasterisk.nvimとも組み合わせ、以下設定で一応個人的に満足した設定になってます。

vim.keymap.set({'n', 'x', 'o'}, 'n', function()
  require('bistahieversor').n_and_echo()
  require('utahraptor').flash()
end)
vim.keymap.set({'n', 'x', 'o'}, 'N', function()
  require('bistahieversor').N_and_echo()
  require('utahraptor').flash()
end)

-- `*` でもフラッシュと検索結果表示
vim.keymap.set('n', '*',  function()
  require('lasterisk').search()
  require('bistahieversor').echo()
  require('utahraptor').flash()
end)

-- /hoge<CR>時にも検索件数表示させたいので、CmdlineLeaveに設定追加
vim.api.autocmd('CmdlineLeave', {
  group = 'vimrc_augroup',
  pattern = {'/', '\\?'},
  callback = function()
    if vim.v.event.abort == false then
      vim.api.nvim_feedkeys(vim.api.nvim_replace_termcodes(':lua require("bistahieversor").echo()<CR>',true,false,true),'n',true)
    end
  end
})

設定後の Neovim の挙動がこちら

満足....

ちなみに検索件数の表示についてですが、実はプラグイン使わなくても Vim 標準で既に検索件数を表示する機能が存在します。
set shortmess-=S で以下のように検索件数が右下に表示されます。(Neovim では shortmess にデフォルトで S が含まれていないので、特に設定しなくくても検索件数が表示されます)

私は gVim の時から vim-anzu を私用して左下に検索文字&件数を表示していたので、右下での表示は慣れませんでした。

開発中の話

検索実行直後にも検索件数を表示させたかったのですが、Neovim の場合このissueで報告しているように CmdlineLeave 後のカーソル位置が扱いづらい場所にあり、nvim_feedkeys() を使ってお茶を濁しています
検索文字のフラッシュは以下のように対応しています
1. matchadd でハイライト
2. その後良い感じのタイミングで matchdelete でハイライト除去
良い感じのタイミングというのが結構難しく、以下判定を 42ms 毎チェックするよう対応しました。
- フラッシュ時間(デフォルト 500ms)を超えた場合
- カーソル位置が変わった
- カレントウィンドウの Window ID が変わった
現状上手いこと動いていそうに見えますが、何かエッジケース見つけたらまた対応します。
matchdelete() に Window ID を指定できることを知らず少しはまりました。
1. 検索文字フラッシュ
2. フラッシュしている最中にカレント Window 変更
3. matchdelete が呼び出される
4. そんな ID ないよ!!と怒られる
matchdelete()使うときは Window ID をちゃんと指定しましょう。あとちゃんとヘルプは読みましょう。
検索文字のフラッシュについては今把握できているところでいうと以下は非対応です。他にもまだまだ大量に対応できていないものがありますが、対応出来そうなものあれば対応します。
- very magic
  - /\vhoge
- カーソル位置先頭にヒットしないケース
  - /hoge\zshuga
  - /hoge/1