前置き
Vim でプラグインをたくさんいれていると、それらを呼び出すためにキーマッピングを用意したくなることはよくある。
Vim はキーシーケンスに対してマッピングを割り当てられるので、何かのキーを prefix キーとして、そのキーに続けて何かしら機能を割り当てると言うテクニックがよく用いられる。
" スペースキーを prefix にする例 " スペースキー単体では何も起きないようにする " これをしておかないと、うっかり <Space> + 割り当ててないキーを " 押すと <Space> の元の機能が発動する nnoremap <Space> <Nop> " <Space>q でウィンドウを閉じる nnoremap <silent> <Space>q :<C-u>quit<CR> " ... 以下、<Space> + 何かにキーを割り当てられる
しかしこの方法をもってしても、割り当てたい機能はどんどん増えていくものである。prefix キーとして利用しやすいキーはいくつかあるが、それらが枯渇するほど機能を割り当てている人も世の中にはいるようだ。
q を prefix にすることで起きる問題
q は、マクロの記録を開始するコマンドである。q + レジスタのアルファベット1文字で、そのレジスタに対してマクロの記録を開始する。
しかし、26個もあるマクロを全て器用に使いこなしている人はおそらくまずいないと思う。私なんてだいたい1つしか使わない。どこに何が記録されているか、覚えられないからだ。
となると、残りの q + アルファベットは空いていることになる。q を prefix にすればこれらが使える。何ならアルファベット以外の文字も使えることになる。
nnoremap q <Nop> nnoremap qa :<C-u>echo 'Awesome feature!'<CR>
こうすることで、qa は無事便利機能に割り当てることができる…が、こうしてしまうと、q を <Nop> にすることで、マクロの開始が一切できなくなってしまう。
これはさすがにまずい。しかしこれは単に q に <Nop> を割り当てなければ解決する。
nnoremap qa :<C-u>echo 'Awesome feature!'<CR>
マクロの記録も開始できる。これで何も問題はない…?
更に潜む問題
Vim のマクロの記録は q 単体で終了する。ところが、q で始まるキーマッピングがあると、押された q がマクロの終了であるのか、はたまたキーマッピングの呼び出しなのかを判断するため、Vim はしばらくの間キーマッピングの待受をする。
待受時間を待ってやり過ごすか、q で始まるキーマッピングではない何か別のキーのコマンドを実行すれば済むのだが、いかんせんやきもきしてしまう。やはり prefix 以外のキーマッピング待ちは発生させたくない。
解決策
今回、この問題を解決するために以下のように設定してみた。
nnoremap <script> <expr> q reg_recording() is# '' ? '<SID>(q)' : 'q' nnoremap <silent> <SID>(q) q nnoremap <silent> <SID>(q)a :<C-u>echo 'Awesome feature!'<CR> nnoremap <silent> <SID>(q)<Space> :<C-u>quit<CR>
q を押した際に、マクロの記録中であれば即座に q を起動してマクロの記録を終了させ、そうでなければ prefix としての q を呼び出す。prefix の設定がない場合はそのまま q として機能させることで、マクロの記録開始も行えるようにする。
こうすることで、q を prefix として機能させつつマクロの記録開始/終了に影響を与えないようにすることができる。私は <Space>q をよく q<Space> に誤爆することがあったので、同じ機能を割り当ててみた。
今回はなんとなく <SID> を使ってみたが、q prefix のキーマッピングを複数のスクリプトで定義したい場合は <Plug> を使っても問題ないだろう。
nmap <expr> q reg_recording() is# '' ? '<Plug>(q)' : 'q' nnoremap <silent> <Plug>(q) q nnoremap <silent> <Plug>(q)a :<C-u>echo 'Awesome feature!'<CR> nnoremap <silent> <Plug>(q)<Space> :<C-u>quit<CR>
この場合は q のキーマッピングに nnoremap ではなく nmap を使うことに注意する必要がある。
残る問題
ここまでやっても一応まだ問題は残ってる。ここで定義した q で始まるキーマッピングは、マクロの記録中に呼び出すことはできない。
しかしこれはある意味当然であり、マクロ記録中に呼び出したい機能を q に割り当てないようにする他はない。
