ここは俺の備忘録だ

少なくとも日本語での言及が少ない話をするつもりです

OCaml on Vim with Homebrew

Mac OCaml Programming Vim 環境構築

動機

私は元々Vimを使っていたが、OCamlはEmacsで書くのが安牌だとされている。(現在ではSpacemacsが最も簡単に入門できる環境だろう) そこでEmacsに乗り換えてみると、此方は此方で快適であるものの、同様にエディタを軽々と乗り換えられる人はそう多くないだろうとも思った。 丁度「OCamlに入門したんだから今の内に振り返りの記事を書こう」と考えていたので、その布石としてOS X上でVimを使う際の環境構築について書くことにした。 Emacs側についてはもっと詳細な説明を書かかれている方がいらっしゃるのでそちらを参照してもらいたい。

前提

みんな HomebrewとNeoBundleの入ったVimは持ったな！！ 行くぞォ！！

シェル上での設定

言語専属パッケージマネージャがOCamlにも有るので入れる。各種操作でコケる事の殆ど無い良い子。

brew install opam
opam init --comp 4.03.0

ここまででopamが何か言っているようならそちらに従って下さい。 インストールが完了したようなら~/.ocamlinitに#topfindが有ること、~/.zshenvないし~/.zshrc(お好みのシェルの設定に置き換えてください)に. ~/.opam/opam-init/init.zsh > /dev/null 2> /dev/null || true があることを確認して下さい。

次に後に紹介するmerlinのための設定を行います。シェルの設定に以下の環境変数を追加してexec $SHELL -lしてください。

export OCAMLPARAM="_,bin-annot=1"
export OPAMKEEPBUILDDIR=1

1つ目の変数はOCamlのコンパイラに渡すデフォルトのオプションです。ここでbin-annotを1にしておきます。これにより生成されるcmtファイルにはコンパイルしたソースの型付き構文木情報が含まれており、merlinはこれを利用することで:MerlinLocate(IDEにお馴染みのGoto Definition機能)を実現しています。

2つ目の変数はopamでインストールしたパッケージのソースを残すオプションで、buildディレクトリ下にビルド済みのソースがプロジェクト丸ごと保存されるようになります。1つ目のオプションと組み合わせることでcmtが生成されている筈なので、そのプロジェクトのディレクトリに移動してソースを開けばすぐにソースブラウジングができるようになります。

OCamlは基本的にmlファイル(実装のファイル)に対応したmliファイル(mlの実装のうち、露出する関数のシグネチャを記すファイル、大体ocamlbuild ソース名.inferred.mliで自動生成してから弄る)にその関数のドキュメント付けを行う文化があります。特に後述するライブラリのcore等はweb上のドキュメントよりもmliのドキュメントの方が圧倒的なので、ソースを読む癖を徹底付ける必要があります。そのためこの2つのオプションは結構重要です。詳細は以下を参照して下さい。

Letting merlin locate go to stuff in .opam · the-lambda-church/merlin Wiki · GitHub

続いて色々インストールしていきます。

opam install ocamlfind ocamlbuild utop merlin ocp-indent core -y

順番に、ライブラリの依存関係やパスを解決するツール、ビルドツール、REPL、補完プラグイン、インデントプラグイン、JaneStreet製の標準ライブラリ強化版です。ちょっと語弊が有るかもしれませんが許してください。

なお、今回はRealWorldOCamlを読むための設定を兼ねているのでcoreを導入していますが、如何せんビッグなライブラリなので、バイナリが大きくなることが気になるなら扱いやすいサイズのライブラリが良いと思われます。次点で有名なGitHub - ocaml-batteries-team/batteries-included: Batteries Included projectはOCaml 4.02.3と共に最近AtCoderに入りました。OCamlは実行コンパイル共に関数型プログラミング言語では高速とされる部類なので競プロにも良い筈です。 (最近はBatteriesの方がいいなと思っています)

Vimの設定

ここから先程入れたプラグインを呼び出す設定をしていきます。 お使いのVimのパッケージマネージャでsyntasticとocp-indent-vimを入れて下さい。 (まだ試してないんですけどwatchdogs.vimでも設定すればOCaml用のチェック走らせられそうですね、保存時以外の非同期チェックが良い方はそちらを試して僕に是非教えて下さい)

NeoBundle 'Shougo/neocomplete.vim'
NeoBundle 'scrooloose/syntastic'
NeoBundle 'def-lkb/ocp-indent-vim'

Neocompleteの設定に関してはVim界隈で沢山の言及があるので説明は不要かと思われます。githubの設定例のコピペで全く問題なく動作するでしょう。ただし後述するmerlinのようなvim側のパッケージマネージャで管理しないvimscriptの読み込みをNeoBundleLazyなどで遅延読み込みするのはお勧めしません。私の経験談でしかありませんが、結構簡単に動かなくなります。

私のsyntasticの設定です。特に重要なのは上2パラグラフで、symbolや色の設定はお好みでどうぞ。

set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*

let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 0
let g:syntastic_check_on_open = 0
let g:syntastic_check_on_wq = 0

hi SyntasticErrorSign ctermfg=160
hi SyntasticWarningSign ctermfg=220

そして一番この記事で重要そうなのがここ。

let g:opamshare = substitute(system('opam config var share'),'\n$','','''')

execute "set rtp+=" . g:opamshare . "/merlin/vim"
let g:syntastic_ocaml_checkers = ['merlin']

if !exists('g:neocomplete#force_omni_input_patterns')
    let g:neocomplete#force_omni_input_patterns = {}
endif
let g:neocomplete#force_omni_input_patterns.ocaml = '[^. *\t]\.\w*\|\h\w*|#'

opamはコンパイラのバージョン毎にディレクトリを分けており、それに付随するパッケージ達もディレクトリ毎に分かれています。ユーザーが意図的にディレクトリを分けることも可能であるため、

  • 実験的なコンパイラも手軽に試せる
  • バージョン由来の問題を各ディレクトリに閉じ込められる
  • 特定プロジェクト用の環境を作れる

などなど利点が多いのですが、エディタ側の設定では工夫が必要になります。 opamは現在フォーカスしているコンパイラ(これはopam switch <コンパイラのバージョン>で切り替えます)の情報を提供するコマンドがあるので、それを使って各パッケージに同梱されたVimのプラグインファイルへのパスをVim本体が読み込むランタイムパスに追加する必要が有るという訳です。merlin自体のパスを通したらsyntasticにmerlinを設定しておいて下さい。ocp-indentについては先程入れたVim側のプラグインがよしなにしてくれるので特に何も記述する必要はありませんが、細かなインデントの変更を行いたい場合だけ公式ドキュメントを見ながら.ocp/ocp-indent.confを設定して下さい。ocp-indent.confの記入例はこちら

ちなみにこのスクリプトのsystem関数はopamが無いとエラーを吐くので、ポータブルなvimrcを望む方はopamの所在を確認しておきましょう。(if executable('opam')などなど

最後に自動補完の設定となります。補完自体はmerlinにお任せしたいので、Neocompleteのg:neocomplete#force_omni_input_patternsに補完を呼び出す際の正規表現を渡します。 良い方法ないかなーと思って探していた所、merlinのVimプラグインのhelpファイルの最も奥底にneocomplcache時代の設定が眠っていたので正規表現だけ拝借しました。本当に神様仏様暗黒美夢王様です。

(2015 11/15追記) そういえば忘れてましたけどデフォルトのままだとインデント周りでocp-indent-vimが支配的に成れていないようなので、~/.vim/ftplugin/ocaml.vimに、

set shiftwidth=2
set tabstop=2
set softtabstop=2

のように追記しておいて下さい(あくまで貴方のocp-indent.confに合わせてお願いします、これは私の例です)、この場合であればfiletypeがocamlの時だけインデントがスペース2個分になります、expandtabするか否かはお好みでどうぞ。 ftplugin/ocaml.vimはmerlinでも使用しているようで、ここにプラグインの遅延読み込み設定などを入れるとエラーになりやすいので気をつけて下さい。(経験談

merlinのための設定

.merlinファイルを貴方が作業するディレクトリ下に配置することでどのソースやパッケージを補完するのかを設定することが出来ます。 coreだけ入れてくれれば良いよという場合はPKG coreをカレントディレクトリの.merlin内に書いて下さい。 詳しくはこの辺を参考にすると良いと思われます。

no-maddojp.hatenablog.com

vim使用時のmerlinの諸機能(式の型評価やコードサーフィン機能)や、補完の詳細なコンフィグは以下のmerlin自体のwikiを見て下さい(実質必読

github.com

すると…

(ここから2文字も打てば殆ど絞られるので作業に支障は無いです)

(追記:) 実際に沢山のパスを記述するのは面倒なものです。こちらもお勧めしておきます。

nnwww.hatenablog.com

学ぶ

Real World OCamlが無料で公開されており、難しくない英語ですし、他の和書と比べ新しめで踏み込んだ内容だと思います。(まだ2章のパース関連までしか読めてないのですが…)

日本語なら…

gihyo.jp

OCamlについて踏み込む訳では有りませんが、関数型言語を用いたプログラミングの基礎としては、

http://www.saiensu.co.jp/?page=book_details&ISBN=ISBN978-4-7819-1160-1&YEAR=2007

を読むのが良いと思われます(少なくともweb上の小難しい表現で得意になっている記事よりは余程平易で為に成ります)

言語化を兼ねて関数型プログラミング & OCaml雰囲気ざっくり入門を書いてみました、専門書と比べあまりにも貧相ですが御参考までにどうぞ。

nnwww.hatenablog.com

ocp-index, OCamlSpot, merlin, 或いは gtags

これらはmliとmlの間を移動したり、呼び出しから実装へ跳んだりする機能を持つプラグインです。規模が大きくなったり本腰を入れたコードリーディングには欠かせない存在だと思います。 私の場合試しにocp-indexを入れてみたんですが思った挙動をしないのでそれ以外を入れることを検討中です… unite-gtagsのようなgtagsとの連携はまだ導入していませんが、最近merlinを使っています。機能の詳細は先程挙げたmerlinのwikiを見て欲しいのですが

  • top levelのモジュール名を指定してml, mliへジャンプする機能
  • 式の型を表示する機能(更にその式の外側or内側の式を評価する機能)
  • カーソルを置いた関数の定義へジャンプする機能

があるので非常に便利です。またOCamlのシンタックスに併せた移動機能MerlinJumpが追加されたようですね。

Jump command · the-lambda-church/merlin Wiki · GitHub

これにアウトラインを走査する機能があれば最高なのでgtagsとかも試してみたいですね!