unite-outline の近況: 次期バージョンの開発

昨年の秋頃から目立った変化のない unite-outline ですが、開発が停滞しているとか、作者のやる気がなくなった*1とかではなく、「今年の抱負 - Vimプラギン編」で述べた通り、次期バージョンの開発(準備)を少しずつ進めています。

ある程度形になったら別ブランチを切って push しようと思ってますが、まだ仕様をあれこれ考えたり非同期実行のやり方を模索している段階で、ものは全然できておりません(汗 まあ、上半期のうちに最初のバージョンを push できたらいいな、ぐらいの見込みです。*2

大きな変更が必要になるついでに、「もうこの際、たまった負債を全部返済してやる!」みたいな意気込みでして、プラグインの構成上前から気になっていた点や、作者がまずいと思っている outline info の仕様など、全面的に見直してドカンと刷新する予定です。(というか、そうせざるを得ないのです…… 詳細は以下を参照)

で、その次期バージョンですが、青写真は以下の通りです。

NuOutline(仮)

アウトライン解析部を独立したプラグイン(NuOutline(仮))として切り出し、unite-outline をそのフロントエンドとして添付するという構成をとります。

プラグインの構成上一番大きな変更点がこれです。

「unite.vim の source として unite-outline は大き過ぎる」、「アウトライン解析を行うプラグインに unite-outline を添付すべきでは?*3」という指摘は以前から何度かあり、自分でも気になっていました。また、

  • autoload/unite/sources/outline/ 以下のディレクトリ階層の深い位置にファイルがごちゃごちゃと多過ぎる。
  • その結果、オートロード関数の名前がやたら長くなる。
  • また、動作が複雑になってオプション変数も増えたが、unite.vim の source のそれはやはり名前が長くなる。
  • unite.vim の source とアウトライン解析部が渾然一体、なんだかなー

といったこともあり、アウトライン解析を行う部分を独立したプラグインとして切り出し、プラグイン全体の構成を仕切り直すことにしました。図で示すと以下のようになります。

きれいに 3層に分離しました。3者の役割分担は Webアプリケーションなどでおなじみの MVCパターンでとらえると理解しやすいです。アウトライン表示のインターフェースを提供してくれる unite.vim がビュー、見出し抽出のロジックを持っている NuOutline がモデル、両者の間に入ってあれこれと調停をし、見出しの自動更新のための面倒をみたりする unite-outline がコントローラというわけですね。

V, C は交換可能(にしたい)

NuOutline は(頑張って)unite.vim, unite-outline と密に結合させないで作ろうと思っています。unite-outline はあくまでフロントエンドのデフォルト実装として NuOutline に添付されているもの、という位置付けにして、第三者が別のフロントエンドを提供できる余地を残しておきます。(そんな人が現れるかは別にして ;-) )

が、リポジトリは unite-outline のままで!

どちらかというと unite-outline の方が NuOutline のオマケ的な存在なのですが、Vundle や neobundle.vim 全盛(?)の昨今、リポジトリの URL が変わるというのは致命的だと思うので、開発は引き続き、現行の unite-outline のリポジトリで行います。まあ、使うだけなら NuOutline は unite-outline の影に隠れて見えませんし、ユーザーが使うのはあくまで unite.vim を通してですからね。

というわけでなんと、unite-outline という unite.vim の source に、プラグインがまるまる1個付いてくるということになります(笑)

オプション変数名が変化

「unite.vim上でどう表示するか」に関する設定を除き、オプション変数の所管が NuOutline の方へ移るので変数の名前が変わってしまいます。しばらくは古い変数の方も見るようにしたいところですが……

outline info → parser

unite.vim の source である unite-outline の source……的な存在であった outline info は所管が NuOutline の方へ移ります。それにともない名称も outline info から parser に変更し、配置場所も

  • autoload/nuoutline/parsers/

とします。*4unite.vim における sources, kinds, filters などと同様の位置付けになります。

DRY でない create_heading() よ消え去れ!

outline info の仕様には(今となっては)気に入らない部分がたくさんあり、その最たるものが見出し抽出のためのパターンが複雑になると create_heading() の中身が DRY でなくなるというものです。例えば、

'^\s*\(foo\|bar\|baz\|fizz\|buzz\)\>'

のようなパターンを設定したとして、マッチングが行われ、マッチが見つかって create_heading() が呼び出されたとします。その場合、マッチしたサブマッチがどれかによって処理を分けなければならないことがほとんどで、現行の outline info ではマッチした文字列に対して再度マッチングを試み、サブマッチのうちのどれに実際にマッチしたのかを判定するような DRY でないコードが氾濫しています。

これは outline info を書く側の問題ではなくて、そのようにしか書けなくしている outline info の仕様の方に問題があるのです。

「こんなことでは outline info を書いてみようと思ってくれた人も離れていくわ!」

と強く思った私は、outline info の所管が NuOutline へ移るこのタイミングで、その仕様を刷新することにしました。

まだ仕様を練っている段階ですが、

let s:parser.foo_pattern = "foo's pattern"
function! s:parser.create_foo_heading()
endfunction

let s:parser.bar_pattern = "bar's pattern"
function! s:parser.create_bar_heading()
endfunction

let s:parser.baz_pattern = "baz's pattern"
function! s:parser.create_baz_heading()
endfunction

こんな風に、見出しの種類ごとに個別にパターンを設定できるようにし、「どのパターンにマッチしたか」の判定までを本体側の責任として、適切なコールバックが呼び出されるようにします。parser側では見出し(辞書)の作成に専念できるようになるので、パターンマッチ方式の parser を作るための敷居はかなり下がるはずです。

構文解析が必要になるケースのサポート

create_heading() について力説した直後にアレですが、「正規表現によるパターンマッチ → create_heading() 」というやり方で見出しが拾えるファイルタイプは実は少なく、ほとんどのプログラミング言語では見出しを「ちゃんと」拾うのに構文解析が必要になります。

具体的に言うと、ctags などの外部の構文解析プログラムを呼び出し、その出力を解析して見出しの木を parser が自前で作る必要があります。

今後、対応ファイルタイプを増やしていくためにも、その辺の処理が書きやすくなるようなユーティリティコードの充実やドキュメントの整備などが必要と考えています。

まとめ

最初からちゃんと設計しとけや! ヽ(*`Д´)ノゴルァ

うう、当初は「正規表現でマッチさせて拾うだけやん」程度の軽いノリで作り始めたのでございます。最初にコミットされたバージョンの素朴さがすべてを物語っている……

しかし、まあ、ここまできたらプラグインとしてちゃんとしたものにしたいですね!

*1:むしろ逆で、変なブーストが入ったw

*2:今年の抱負ということになってるので、遅くとも年内にはw

*3:alignta に unite-alignta が同梱されているのがこの構成ですね。

*4:outline info は autoload/outline/ に配置してもよいことになっていましたが、これは autoload/unite/sources/outline/ が自作の outline info を配置する場所として位置が深すぎるだろうとの配慮からでした。通常、autoload/ に何かを配置させるにあたっては、プラグイン名できちんと名前空間を切るべきです。

はてダの Twitter連携とツイート内容

はてダの Twitter連携についてテストしてみた。

以下のエントリを「Twitterに通知」にチェックを入れて公開し、Twitter に投稿されるツイートの内容を確認してみた。

記事タイトル [tag]テスト
記事内容 Twitter連携のテストです。
「ツイートの内容」を空欄にすると、

[tag]テスト d.hatena.ne.jp/h1mesuke/20120…

空欄にしておけば勝手に記事のタイトルが入っていい感じになるだろうと思ったら、タイトルの前にタグ(カテゴリ)が前置されてツイートとしては見苦しい感じになった。(というか、[tag] はタイトルの一部ということか)

ツイートの内容としてこれは意図したものでないと思われるので、「ツイートの内容」フィールドは空欄にしない方がいい。

「ツイートの内容」を「テストです。」にすると、

テストです。 d.hatena.ne.jp/h1mesuke/20120…

「ツイートの内容」に入力した内容に URL が続く形。この場合は記事のタイトルが自動的には入らないので注意。特別なメッセージがないなら「ツイートの内容」フィールドに記事のタイトル(タグ除く)を入れておけばいいだろう。

Vim のプラグインのプラグインの呼称

Vimプラグインプラグインの呼称について、自分が知っている範囲でまとめてみた。

Plugin Plugin's Plugin Load Function
neocomplcache source #define()
QuickRun module #new()*1
ref.vim source #define()
unite.vim source, kind, filter #define()
unite-outline outline info #outline_info()

うーん……

outline info っていう名前が気に入らないなー

元々、unite.vim の source である unite-outline のプラグインがこれまた source だったら紛らわしいなあと思い、何か別の呼称を考えようということで outline info としたのが事の始まり。しかし、今にして思うと「〜info」みたいな名前はそれが何かを端的に表しておらず、漠然としていて、決していい名前とはいえない。おまけに長いし。

何かもっとよい呼称はないものか。*2

unite-outline の次期バージョンでは、本体を独立したプラグインとして切り出し、unite-outline をそのプラグインに添付する、という構成にする予定で、ディレクトリの構成とか思いっ切り変わるので、これを機に outline info という呼称をなくそうと考え中。

*1:使用する際は明示的に quickrun#register_module() などで登録する。

*2:一応候補は見つかった。

非同期砂漠

プラギンが哭(な)いてる ユーザーに罵られて
 Vim はやさしさを どこに棄ててきたの
  だけどわたしは 好きよこのエディタが
   肩を寄せあえる vimproc・・・system_bg() がいる
    呼び出し側で あゝブロックしないならば
     つらくはないわ この非同期砂漠
      あなたがいれば あゝユーザー待たさないで
       コマンド実行できる この非同期砂漠


( ^ω^)・・・


なんか vimproc の使い方調べてたらいつの間にかサビの部分を口ずさんでいたw

昔テレビの CM(ビルの屋上でバスケしてるやつw)で流れていたサビの部分の歌詞とメロディしか知らないというのに、いつの間にかその部分で替え歌ができるというのですから、テレビの力というのは恐ろしいものですね!

ちなみに原曲は 内山田洋とクールファイブの「東京砂漠」で昭和51年の曲。なんと私が生まれる前の曲でした。(さりげなくオッサンじゃないアピール)

Vim のプラグインを書きたいと思っている人は今すぐ :help write-plugin を読もう!

特に *use-cpo-save* のところ。プラグインのソースでよく見かける、

これ

let s:save_cpo = &cpo
set cpo&vim

と、これ

let &cpo = s:save_cpo

がなぜ必要なのかが書いてあるよ!

というか、行の継続を許容するためだったとか全然知らんかったw

ということで、このイディオムの効用を勝手に誤解していた自分のプラグインでは、行の継続をばりばり使っているにも関わらず、正しく set cpo&vim していないソースが散見されたので、ここ数日それをせっせと直していました。あわわ(汗

これまでこの件でエラーの報告がきたことはないので、Vim を起動したら(意図せず) 'compatible' が ON になる、という条件*1のユーザーは極めて少ないんだとは思うけど、自作のプラグインを公開するものとして、所作は正しく身に付けておきたいものです(キリッ ( ← 数日前までできてなかった)

*1:Vimプラグインを拾ってきて自分の .vim に配置できて、なおかつ vimrc も gvimrc もない、という条件のユーザー。かなり想像しにくい。

今年の抱負 - Vimプラギン編

抱負を述べるには時期を逸した感があるものの、こういうものは一応でも言っておいた方が、一年を通してほどよいプレッシャーになっていいと思うのでw

alignta

去年やるはずだったのにできなかった、

  • 前回の整列を繰り返す機能
  • unite-alignta と連動した履歴の機能
  • ヘルプの英訳

これらの ToDo に引き続き取り組む。

後、自分で使っていて、「あれ、そうじゃないって(汗」という局面がまだまだあるので、そういう整列の細かい挙動などを少しずつ改善していく。

整列方法の指定書式はこれ以上増やしたくないが、既存の書式で「こう揃えたい」を表現できないとなれば、何か加える可能性はある。*1

(取り組む本人が)面白そうな ToDo としてこんなのもある。*2

後、コードをもっとすっきりさせたいし、プロファイルをとって少しでも速くしたい。機能の追加が控えているうちは多分手を付けないと思うけど、その辺までいければ今年は御の字といえる。

unite-outline

今年の課題はずばり以下の2つ。

他にも細かい ToDo はいろいろとあるけれども、この2つに比べれば瑣末といえる。また、この2つの課題をクリアするためには、中核部分はほとんど書き直しに近い変更が必要になると思うので、それまで他の ToDo はとりあえず塩漬けになると思う。

現在のバージョンに対しては最低限のバグフィックスのみを行うようにし、別ブランチで新バージョンを開発、みたいな流れかな。具体的にどうやって進めていくかはまだ決めてないけど。

GitHub で最初に公開したバージョンからずっと、見出しの抽出は「現在のバッファ」と密に結合していて、かつ「同期的」だった。昨年はこれらの問題点が明らかになった年で、今年はそれらを解決する年としたい。

*1:とはいえ、あまり複雑にし過ぎると暗号のようになり、「覚えいにくい」「使いにくい」といったことになるので、その辺のバランスは難しい。

*2:ヘルプの英訳よりはやく終わるかもw

Vim script のベンチマーク

数万回くらい実行されるループの中で文字列が空かどうかを調べなければならないとする。

  • empty(str)
  • str == ""

さて、どちらがいいだろう? empty() を使う方が、文字列が空かどうかを調べる、という意図が明確になっていいような気がするが、empty() の方は関数呼び出しなので、ひょっとすると ==演算子に比べて相当遅いかも知れないぞ……

この手の疑問/迷いを解消するために、同じことをする複数の Vim script コード片の速度性能を簡単に比較できるツールを作ってみました。

+reltime と +float が必要。7.2以降の Vim なら多分大丈夫(だと思うけど自信はないw)

使い方はこんな感じ。最初の疑問を解消すべく、ベンチマークスクリプトを作ってみる。

let s:bm = benchmark#new("String is empty?")

let s:N = 10000
let s:str = "hello"

function! s:bm.empty()
  let i = 0
  while i < s:N
    if empty(s:str)
    endif
    let i += 1
  endwhile
endfunction

function! s:bm.op_equal()
  let i = 0
  while i < s:N
    if s:str == ""
    endif
    let i += 1
  endwhile
endfunction

function! s:bm.op_match()
  let i = 0
  while i < s:N
    if s:str =~ '^\s*$'
    endif
    let i += 1
  endwhile
endfunction

call s:bm.run(3)

で、:source % または :QuickRun すると……

Benchmark: String is empty?

Trial #1
  op_equal : 0.078297
  empty    : 0.086356
  op_match : 0.114139

Trial #2
  op_equal : 0.080296
  empty    : 0.086518
  op_match : 0.109003
    
Trial #3
  op_equal : 0.080530
  empty    : 0.091485
  op_match : 0.118427

こういう結果が得られます。

所要時間にはループのコストも含まれていて、実はそれが所要時間の半分以上を占めていたりするので*1、これがそのまま ==演算子と empty() の速度差というわけではないものの、whileループの中に置いた場合の差は大体この程度、というのがわかります。(空の whileループの所要時間も同時に計測すれば、ループのコストを差し引いたおおよその速度差も検証できるはず)

Vim script を書いていて、ある処理を記述する複数の書き方のどれを選択するかで迷ったとき、これを使って速度比較を行ってみると、思わぬ発見があるやも。

もっと詳細に性能の評価を行いたい場合は……

このスクリプトのように、ループの中身が1行だけみたいな場合、ループ自体のコストが無視できないレベルになるので、このツールは対象コードの純粋な性能評価には向いていません。どちらかというと複数ある選択肢の中のどれが一番いいか、を比較するためのものです。

もっと詳細に行単位で性能を評価したいとか、全体のボトルネックを突き止めたいとかいった場合には、Vim のプロファイル機能を利用するべきでしょう。

*1:Vim script の while は for に比べて相当遅いです。付属のサンプル参照。