annotate runtime/ftplugin/ruby.vim @ 829:dc8197342755 v7.0d04

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