質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.99%

<Plug>括弧で囲む理由が知りたい

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 977

norio13

score 51

環境

  • Debian jessie
  • vim 8.0.118

Googleでサンプルコードを検索すると、ほとんどが<Plug>(Sample)のように括弧で囲っていました。
sample1.vimのように括弧で囲わない書き方をすると、<space>aを押してから約1秒後に1と出力されます。
括弧で囲わない場合は実行されるまで時間がかかりました。
括弧で囲む理由が知りたいのですがヘルプのどこを確認したらいいのでしょうか?

遅くなるサンプル
vim -Nu NONE -S sample1.vim

" sample1.vim
nnoremap <Plug>Sample :<C-u>echo 1<CR>
nnoremap <Plug>Sample2 :<C-u>echo 2<CR>
nmap <space>a <Plug>Sample 
nmap <space>b <Plug>Sample2

遅くないサンプル
vim -Nu NONE -S sample2.vim

" sample2.vim
nnoremap <Plug>(Sample) :<C-u>echo 1<CR>
nnoremap <Plug>(Sample2) :<C-u>echo 2<CR>
nmap <space>a <Plug>(Sample)
nmap <space>b <Plug>(Sample2)
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

0

質問内容にあるような結果になる理由については、詳しくは :help map-typing 周辺に書かれています。

簡単に説明すると、キーマッピング <Plug>Sample と <Plug>Sample2 が存在する場合、<Plug>Sample まで入力された場合、Vim はどちらのキーマッピングを展開するべきか、このタイミングでは判断できません。次の文字が入力されて、それが 2 かそうでないかによって、初めてキーマッピングが展開できます。また、入力が一定時間なかった場合もタイムアウトが発生し、前者であると確定してキーマッピングが展開されます。

本題の <Plug> に続くキーマッピングを () で囲む理由ですが、1 つは上記の問題を明確に回避するためです。

また、別の理由として見やすさがあります。
例えば標準の n を拡張する <Plug>improve-n があったとして、ユーザーはこの n のあとに zz を加えたいとします。この時、<Plug>improve-nzz と <Plug>(improve-n)zz では、後者のほうが圧倒的に見やすいかと思います。

() である理由([] や {} ではない理由)は特になく、習慣的なものと言えます。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/12/02 17:30

    括弧の必要性が分かりました。
    ありがとうございます。

    キャンセル

0

まず <Plug>Sample が遅くなるのは入力 <Plug>Sample に前方一致するキーマッピングが二つ、すなわち 

  • <Plug>Sample
  • <Plug>Sample2

が存在するためユーザーが続けて 2 を入力するかどうかオプション 'timeoutlen の時間だけ待っているためです。括弧で囲んだ場合には <Plug>(Sample) に前方一致するものは(おそらく)ないために問題を回避できます。例えば 

nnoremap <Plug>(Sample)2 :<C-u>echo 2<CR>

と定義すると同じ問題が発生するのが確認できるでしょう。


括弧で囲むのは必須ではありませんが、このような問題があるために良い習慣として認識されているみたいです。上の問題のほかにもユーザーが <Plug>Sample を実行した後に次の行へ移る (j) キーマッピングを vimrc で定義したい場合、

nmap <Space>c <Plug>Samplej

だとどこまでがプラグインによるキーマッピングなのかが分かりにくいですが、

nmap <Space>c <Plug>(Sample)j

だと <Plug>(Sample) が一つの塊であることが一目瞭然ですね。私は確か Vim: Key mappingを極める - while (“im automaton”); を読んで参考にした気がします。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/12/02 17:32

    理解がよりいっそう深まりました。
    ありがとうございます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.99%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる