本文参考自:http://easwy.com/blog/archives/advanced-vim-skills-taglist-plugin/
插件介绍:
taglist可以使得用户在vim编辑器中方便地查看源代码文件结构,它可以在vim窗口中划出一部分来显示源代码的函数、类、结构体等信息,用户可以从taglist中选择并进入。
插件安装:
注:安装taglist前要先安装ctags,ctags安装方法可见http://www.cnblogs.com/willsonli/p/6555179.html
1、从http://www.vim.org/scripts/script.php?script_id=273下载最新版本的taglist plugin;
2、将其解压缩至~/.vim中,此时,会在你的~/.vim/plugin和~/.vim/doc目录中各放入一个文件:
plugin/taglist.vim taglist插件
doc/taglist.txt taglist帮助文件
插件配置:
1、生成帮助标签,即在用户目录下输入vim回车,在命令行模式输入:
:helptags ~/.vim/doc
2、生成帮助标签后,我们就可以用下面的命令查看taglist的帮助了:
:help taglist.txt
3、在~/.vimrc中输入:
filetype plugin indent on "打开文件类型检测功能 let Tlist_Ctags_Cmd = '/usr/bin/ctags' "设定系统中ctags程序的位置 let Tlist_Show_One_File = 1 "不同时显示多个文件的tag,只显示当前文件的 let Tlist_Exit_OnlyWindow = 1 "如果taglist窗口是最后一个窗口,则退出vim map:TlistToggle "按F9等同于在命令行模式输入:TlistToggle
插件用法:
经过以上配置后,用vim打开一个文件然后输入:TlistOpen就会显示为:
下面是一些taglist常用的配置:
- Tlist_Ctags_Cmd选项用于指定你的Exuberant ctags程序的位置,如果它没在你PATH变量所定义的路径中,需要使用此选项设置一下;
- 如果你不想同时显示多个文件中的tag,设置Tlist_Show_One_File为1。缺省为显示多个文件中的tag;
- 设置Tlist_Sort_Type为”name“可以使taglist以tag名字进行排序,缺省是按tag在文件中出现的顺序进行排序。按tag出现的范围(即所属的namespace或class)排序,已经加入taglist的TODO List,但尚未支持;
- 如果你在想taglist窗口是最后一个窗口时退出vim,设置Tlist_Exit_OnlyWindow为1;
- 如果你想taglist窗口出现在右侧,设置Tlist_Use_Right_Window为1。缺省显示在左侧。
- 在gvim中,如果你想显示taglist菜单,设置Tlist_Show_Menu为1。你可以使用Tlist_Max_Submenu_Items和Tlist_Max_Tag_Length来控制菜单条目数和所显示tag名字的长度;
- 缺省情况下,在双击一个tag时,才会跳到该tag定义的位置,如果你想单击tag就跳转,设置Tlist_Use_SingleClick为1;
- 如果你想在启动vim后,自动打开taglist窗口,设置Tlist_Auto_Open为1;
- 如果你希望在选择了tag后自动关闭taglist窗口,设置Tlist_Close_On_Select为1;
- 当同时显示多个文件中的tag时,设置Tlist_File_Fold_Auto_Close为1,可使taglist只显示当前文件tag,其它文件的tag都被折叠起来。
- 在使用:TlistToggle打开taglist窗口时,如果希望输入焦点在taglist窗口中,设置Tlist_GainFocus_On_ToggleOpen为1;
- 如果希望taglist始终解析文件中的tag,不管taglist窗口有没有打开,设置Tlist_Process_File_Always为1;
- Tlist_WinHeight和Tlist_WinWidth可以设置taglist窗口的高度和宽度。Tlist_Use_Horiz_Window为1设置taglist窗口横向显示;
在taglist窗口中,可以使用下面的快捷键:
跳到光标下tag所定义的位置,用鼠标双击此tag功能也一样 o 在一个新打开的窗口中显示光标下tag 显示光标下tag的原型定义 u 更新taglist窗口中的tag s 更改排序方式,在按名字排序和按出现顺序排序间切换 x taglist窗口放大和缩小,方便查看较长的tag + 打开一个折叠,同zo - 将tag折叠起来,同zc * 打开所有的折叠,同zR = 将所有tag折叠起来,同zM [[ 跳到前一个文件 ]] 跳到后一个文件 q 关闭taglist窗口 显示帮助
可以用”:TlistOpen“打开taglist窗口,用”:TlistClose“关闭taglist窗口。或者使用”:TlistToggle“在打开和关闭间切换。在我的vimrc中定义了下面的映射,使用
map:TlistToggle
参考自:易水博客 [ http://easwy.com/blog/ ]