---

Ⅰ. 插件描述

ocaml related vim script collection

Ⅱ. 基本信息

创建日期：  2010-08-11 使用用户：  2 Github星：  7 插件作者：  Marc Weber

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'marcweber/vim-addon-ocaml'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'marcweber/vim-addon-ocaml'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'marcweber/vim-addon-ocaml'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/marcweber/vim-addon-ocaml

Ⅳ. 文档说明

vim ocaml scritps

This collection includes well known scripts I was pointed to such as ocaml
indentation, annot support

I modified the indenting slightly so that the args ".." and x y are not
indented at all. (Using vim indentation they are indented the same as Printf
which is annoying)

let f x =
let y = x + 1 in
Printf.printf

"%d + 1 = %d"
x y

completion details:

All completion is based on .mli files found in all tag files.
If you don't have tags, tell Vim which .mli files to use:

let g:vim_addon_ocaml = { 'provide_additional_mlis': function('name of function returning a list of .mli files') }

a) name completion:
all .mli files are grepped for the name
Additionally all let bindings found in current buffer are taken into account

b) type completion:

con:str finnds concat : string -> string

:^int->string$ finds string_of_int

c) var based completion (not that well tested)

x:conc

the type of x is looked up by .annot files (you must have created the musing ocamlc or ocamelopt)
Then b) completion is used using the type of x.

For both b) and c) the completion result is
(concat x)

Its not perfect - but its a starting point.

goto feature:

press gf on a thing to make Vim try to find the definition. These locations are considered:

• by tags
• by tag (and matching module name. Eg String.concat)
• lets in other **/MODULE.ml files whith matching module name
• type definition (experimental)

TIPS:

• https://github.com/def-lkb/merlin
• learn about vim-addon-actions
• don't use tags, but .annot, ocamlspot, merlin?
• consider putting this into your ~/.ctags file

--langmap=OCaml:.sml,OCaml:.ml
--regex-ocaml=/^[ t]*external[ t]+([A-Za-z0-9_]+)/1/c,v/
--regex-OCaml=/^[ t]*datatype[ t]+([A-Z'a-z0-9_]+)/1/d,datatype/
--regex-OCaml=/^[ t]*and[ t]+([A-Z'a-z0-9_]+)/1/d,datatype/
--regex-OCaml=/^[ t]*withtype[ t]+([A-Z'a-z0-9_]+)/1/w,withtype/
--regex-OCaml=/^[ t]*structure[ t]+([A-Z'a-z0-9_]+)/1/s,structure/
--regex-OCaml=/[ t]*val[ t]+([A-Z'a-z0-9_]+)/1/v,val/
--regex-OCaml=/^[ t]*fun[ t]+([A-Z'a-z0-9_]+)/1/f,fun/
--regex-OCaml=/^[ t]*type[ t]+([A-Z'a-z0-9_]+)/1/t,type/
--regex-OCaml=/|[ t]([A-Z'a-z0-9_]+)¹$/1/c,cons/
--regex-Ocaml=/^[ t]*module[ t]+type[ t]+([A-Z'a-z0-9_]+)/1/t,type/
--regex-Ocaml=/^[ t]*value[ t]+([A-Z'a-z0-9_]+)/1/t,type/

(verify that ctags --list-maps has an ocaml entry. If it doesn't upgrade
exuberant ctags)

If you want to tag ocaml sources you have to apply ctags.patch preventing some segfaults

HapPy vimming!

TODO / bugs

local vals/vars in buf have no type hinting in completion
... many more