1" Vim filetype plugin 2" Language: Ruby 3" Maintainer: Gavin Sinclair <gsinclair at gmail.com> 4" Info: $Id$ 5" URL: http://vim-ruby.rubyforge.org 6" Anon CVS: See above site 7" Release Coordinator: Doug Kearns <[email protected]> 8" ---------------------------------------------------------------------------- 9" 10" Original matchit support thanks to Ned Konz. See his ftplugin/ruby.vim at 11" http://bike-nomad.com/vim/ruby.vim. 12" ---------------------------------------------------------------------------- 13 14" Only do this when not done yet for this buffer 15if (exists("b:did_ftplugin")) 16 finish 17endif 18let b:did_ftplugin = 1 19 20let s:cpo_save = &cpo 21set cpo&vim 22 23" Matchit support 24if exists("loaded_matchit") && !exists("b:match_words") 25 let b:match_ignorecase = 0 26 27 " TODO: improve optional do loops 28 let b:match_words = 29 \ '\%(' . 30 \ '\%(\%(\.\|\:\:\)\s*\|\:\)\@<!\<\%(class\|module\|begin\|def\|case\|for\|do\)\>' . 31 \ '\|' . 32 \ '\%(\%(^\|\.\.\.\=\|[\,;=([<>~\*/%!&^|+-]\)\s*\)\@<=\%(if\|unless\|until\|while\)\>' . 33 \ '\)' . 34 \ ':' . 35 \ '\%(' . 36 \ '\%(\%(\.\|\:\:\)\s*\|\:\)\@<!\<\%(else\|elsif\|ensure\|when\)\>' . 37 \ '\|' . 38 \ '\%(\%(^\|;\)\s*\)\@<=\<rescue\>' . 39 \ '\)' . 40 \ ':' . 41 \ '\%(\%(\.\|\:\:\)\s*\|\:\)\@<!\<end\>' . 42 \ ',{:},\[:\],(:)' 43 44 let b:match_skip = 45 \ "synIDattr(synID(line('.'),col('.'),0),'name') =~ '" . 46 \ "\\<ruby\\%(String\\|StringDelimiter\\|ASCIICode\\|Interpolation\\|" . 47 \ "NoInterpolation\\|Escape\\|Comment\\|Documentation\\)\\>'" 48 49endif 50 51setlocal formatoptions-=t formatoptions+=croql 52 53setlocal include=^\\s*\\<\\(load\\\|\w*require\\)\\> 54setlocal includeexpr=substitute(substitute(v:fname,'::','/','g'),'$','.rb','') 55setlocal suffixesadd=.rb 56 57if version >= 700 58 setlocal omnifunc=rubycomplete#Complete 59endif 60 61" TODO: 62"setlocal define=^\\s*def 63 64setlocal comments=:# 65setlocal commentstring=#\ %s 66 67if !exists("s:rubypath") 68 if executable("ruby") 69 let s:code = "print ($: + begin; require %q{rubygems}; Gem.all_load_paths.sort.uniq; rescue LoadError; []; end).join(%q{,})" 70 if &shellxquote == "'" 71 let s:rubypath = system('ruby -e "' . s:code . '"') 72 else 73 let s:rubypath = system("ruby -e '" . s:code . "'") 74 endif 75 let s:rubypath = '.,' . substitute(s:rubypath, '\%(^\|,\)\.\%(,\|$\)', ',,', '') 76 else 77 " If we can't call ruby to get its path, just default to using the 78 " current directory and the directory of the current file. 79 let s:rubypath = ".,," 80 endif 81endif 82 83let &l:path = s:rubypath 84 85if has("gui_win32") && !exists("b:browsefilter") 86 let b:browsefilter = "Ruby Source Files (*.rb)\t*.rb\n" . 87 \ "All Files (*.*)\t*.*\n" 88endif 89 90let b:undo_ftplugin = "setl fo< inc< inex< sua< def< com< cms< path< " 91 \ "| unlet! b:browsefilter b:match_ignorecase b:match_words b:match_skip" 92 93let &cpo = s:cpo_save 94unlet s:cpo_save 95 96" 97" Instructions for enabling "matchit" support: 98" 99" 1. Look for the latest "matchit" plugin at 100" 101" http://www.vim.org/scripts/script.php?script_id=39 102" 103" It is also packaged with Vim, in the $VIMRUNTIME/macros directory. 104" 105" 2. Copy "matchit.txt" into a "doc" directory (e.g. $HOME/.vim/doc). 106" 107" 3. Copy "matchit.vim" into a "plugin" directory (e.g. $HOME/.vim/plugin). 108" 109" 4. Ensure this file (ftplugin/ruby.vim) is installed. 110" 111" 5. Ensure you have this line in your $HOME/.vimrc: 112" filetype plugin on 113" 114" 6. Restart Vim and create the matchit documentation: 115" 116" :helptags ~/.vim/doc 117" 118" Now you can do ":help matchit", and you should be able to use "%" on Ruby 119" keywords. Try ":echo b:match_words" to be sure. 120" 121" Thanks to Mark J. Reed for the instructions. See ":help vimrc" for the 122" locations of plugin directories, etc., as there are several options, and it 123" differs on Windows. Email [email protected] if you need help. 124" 125 126" vim: nowrap sw=2 sts=2 ts=8 ff=unix: 127