2016/01/29

Recent entries from same category

  1. vim-soundcloud 作った。
  2. Software Design 2016年5月号 Vim 「実戦」投入
  3. Re: ちょっと使えるかも(?)しれない、正規表現
  4. 仕事ですぐ役立つ Vim&Emacsエキスパート活用術
  5. Vim の channel を使って非同期 twitter タイムライン

13年前、僕は vim-dev (Vim の開発グループ)に Vim からソケット通信が出来る関数群のパッチを書いて送りました。

Socket functions for vim. - Yahoo! Groups
https://groups.yahoo.com/neo/groups/vimdev/conversations/topics/32576

その時は Bram (vimboss) に「Python や Perl インタフェースを使えるやないか、もしくは外部コマンドとか」と返されてしまいました。確かに言語拡張を使えば出来ますし、それに処理がブロッキングだったので実はそれほど有益では無かったかも知れません。

その後、このソケット通信のパッチは vimproc の一部に取り込まれ、シーケンシャルなソケット通信は出来る様になりました。しかし Vim には非同期インタフェースがありません。自分でイベントを投げ続けてソケットをハンドリングするしかありませんでした。しかし本日リリースされたパッチ 7.4.1191 で channel という機能により、非同期ソケット通信が出来る様になりました。

Patch 7.4.1191 - Google Groups
https://groups.google.com/forum/#!topic/vim_dev/t6RbXywJZRo

あのパッチを送った頃を知っている KoRoN さんや ynkdir さんは恐らく感慨深い思いではないかと思います。

channel は以下の様に使います。

function! Callback(handle, msg)
  echo a:msg
endfunction
let handle = ch_open("127.0.0.1:5000""raw")
call ch_sendraw(handle, "GET / HTTP/1.0\r\n\r\n""Callback")

ローカルにウェブサーバを立てておき、このコードを実行すると以下の様に表示されます。

channel

raw だけでなく json も扱えます。先日入った jsonencode() を使う事も出来ます。接続関数 ch_open の第二引数に raw を指定すると文字列がそのまま送受信されます。json を指定すると json エンコードされた文字列が送信されます。送信関数は2つあり、ch_sendraw() は生の文字列を、ch_sendexpr() はハンドルと文字列をペアにした配列を送信します。サーバ側はこのハンドルに対して応答を返すと、複数のハンドルを持った vim のどちらに応答するか、といった事が可能になります。

今日はこの ch_sendexpr を使って時刻通知機能を作ってみました。まずサーバを書きます。

package main

import (
    "encoding/json"
    "log"
    "net"
    "time"
)

func main() {
    l, err := net.Listen("tcp"":8888")
    if err != nil {
        log.Fatal(err)
    }
    for {
        conn, err := l.Accept()
        if err != nil {
            continue
        }
        go func(conn net.Conn) {
            defer conn.Close()
            var b [500]byte
            // リクエストを受け取る
            // フォーマットは JSON の配列
            // [handle, msg]
            n, err := conn.Read(b[:])
            if err != nil {
                log.Println(err)
                return
            }
            var v [2]interface{}
            err = json.Unmarshal(b[:n], &v)
            if err != nil {
                log.Println(err)
                return
            }
            // v の1個目には handle が入っているのでそのまま使う
            for {
                // v の2個目を更新して送信する
                v[1] = time.Now().String()
                err = json.NewEncoder(conn).Encode(v)
                if err != nil {
                    break
                }
                time.Sleep(1 * time.Second)
            }
        }(conn)
    }
}

サーバは Accept すると1行リクエストを受け取ってハンドル番号を得ます。その後、そのハンドル番号を指定して現在時刻を送り続けます。Vim script 側は以下の様に書きます。

function! Callback(handle, msg)
  echo "ただ今:" . a:msg
endfunction
let handle = ch_open("127.0.0.1:8888""json""Callback")
echo ch_sendexpr(handle"GET""Callback")

これを実行すると

time server

おぉぉぉぉぉぉ!if_python だとスレッドを使ってバックグラウンドでソケット受信する必要がありましたが、これだと何も意識しなくて良いし、マルチスレッドが起因して落ちる事もない!これで勝つる!!!

今日の出来事は、個人的には数年ぶりの感動でした。これからどんどん非同期通信を使った Vim plugin が現れてくると思うのでとても楽しみです。


blog comments powered by Disqus