xref: /vim-8.2.3635/runtime/ftplugin/vim.vim (revision 1d59aa1f)
1" Vim filetype plugin
2" Language:	Vim
3" Maintainer:	Bram Moolenaar <[email protected]>
4" Last Change:	2020 Aug 14
5
6" Only do this when not done yet for this buffer
7if exists("b:did_ftplugin")
8  finish
9endif
10
11" Don't load another plugin for this buffer
12let b:did_ftplugin = 1
13
14let s:cpo_save = &cpo
15set cpo&vim
16
17if !exists('*VimFtpluginUndo')
18  func VimFtpluginUndo()
19    setl fo< isk< com< tw< commentstring<
20    if exists('b:did_add_maps')
21      silent! nunmap <buffer> [[
22      silent! vunmap <buffer> [[
23      silent! nunmap <buffer> ]]
24      silent! vunmap <buffer> ]]
25      silent! nunmap <buffer> []
26      silent! vunmap <buffer> []
27      silent! nunmap <buffer> ][
28      silent! vunmap <buffer> ][
29      silent! nunmap <buffer> ]"
30      silent! vunmap <buffer> ]"
31      silent! nunmap <buffer> ["
32      silent! vunmap <buffer> ["
33    endif
34    unlet! b:match_ignorecase b:match_words b:match_skip b:did_add_maps
35  endfunc
36endif
37
38let b:undo_ftplugin = "call VimFtpluginUndo()"
39
40" Set 'formatoptions' to break comment lines but not other lines,
41" and insert the comment leader when hitting <CR> or using "o".
42setlocal fo-=t fo+=croql
43
44" To allow tag lookup via CTRL-] for autoload functions, '#' must be a
45" keyword character.  E.g., for netrw#Nread().
46setlocal isk+=#
47
48" Use :help to lookup the keyword under the cursor with K.
49setlocal keywordprg=:help
50
51" Set 'comments' to format dashed lists in comments
52" Avoid that #{} starts a comment.
53setlocal com=sO:\"\ -,mO:\"\ \ ,sO:#\ -,mO:#\ \ ,eO:##,:\",b:#
54
55" Format comments to be up to 78 characters long
56if &tw == 0
57  setlocal tw=78
58endif
59
60" Comments start with a double quote; in Vim9 script # would also work
61setlocal commentstring=\"%s
62
63if !exists("no_plugin_maps") && !exists("no_vim_maps")
64  let b:did_add_maps = 1
65
66  " Move around functions.
67  nnoremap <silent><buffer> [[ m':call search('^\s*\(fu\%[nction]\\|def\)\>', "bW")<CR>
68  vnoremap <silent><buffer> [[ m':<C-U>exe "normal! gv"<Bar>call search('^\s*\(fu\%[nction]\\|def\)\>', "bW")<CR>
69  nnoremap <silent><buffer> ]] m':call search('^\s*\(fu\%[nction]\\|def\)\>', "W")<CR>
70  vnoremap <silent><buffer> ]] m':<C-U>exe "normal! gv"<Bar>call search('^\s*\(fu\%[nction]\\|def\)\>', "W")<CR>
71  nnoremap <silent><buffer> [] m':call search('^\s*end\(f\%[unction]\\|def\)\>', "bW")<CR>
72  vnoremap <silent><buffer> [] m':<C-U>exe "normal! gv"<Bar>call search('^\s*end\(f\%[unction]\\|def\)\>', "bW")<CR>
73  nnoremap <silent><buffer> ][ m':call search('^\s*end\(f\%[unction]\\|def\)\>', "W")<CR>
74  vnoremap <silent><buffer> ][ m':<C-U>exe "normal! gv"<Bar>call search('^\s*end\(f\%[unction]\\|def\)\>', "W")<CR>
75
76  " Move around comments
77  nnoremap <silent><buffer> ]" :call search('^\(\s*".*\n\)\@<!\(\s*"\)', "W")<CR>
78  vnoremap <silent><buffer> ]" :<C-U>exe "normal! gv"<Bar>call search('^\(\s*".*\n\)\@<!\(\s*"\)', "W")<CR>
79  nnoremap <silent><buffer> [" :call search('\%(^\s*".*\n\)\%(^\s*"\)\@!', "bW")<CR>
80  vnoremap <silent><buffer> [" :<C-U>exe "normal! gv"<Bar>call search('\%(^\s*".*\n\)\%(^\s*"\)\@!', "bW")<CR>
81endif
82
83" Let the matchit plugin know what items can be matched.
84if exists("loaded_matchit")
85  let b:match_ignorecase = 0
86  let b:match_words =
87	\ '\<\%(fu\%[nction]\|def\)\>)\@!:\<retu\%[rn]\>:\<\%(endf\%[unction]\|enddef\)\>,' .
88 	\ '\<\(wh\%[ile]\|for\)\>:\<brea\%[k]\>:\<con\%[tinue]\>:\<end\(w\%[hile]\|fo\%[r]\)\>,' .
89	\ '\<if\>:\<el\%[seif]\>:\<en\%[dif]\>,' .
90	\ '{:},' .
91	\ '\<try\>:\<cat\%[ch]\>:\<fina\%[lly]\>:\<endt\%[ry]\>,' .
92	\ '\<aug\%[roup]\s\+\%(END\>\)\@!\S:\<aug\%[roup]\s\+END\>,'
93  " Ignore syntax region commands and settings, any 'en*' would clobber
94  " if-endif.
95  " - set spl=de,en
96  " - au! FileType javascript syntax region foldBraces start=/{/ end=/}/ …
97  let b:match_skip = 'synIDattr(synID(line("."),col("."),1),"name")
98        \ =~? "comment\\|string\\|vimSynReg\\|vimSet"'
99endif
100
101let &cpo = s:cpo_save
102unlet s:cpo_save
103
104" removed this, because 'cpoptions' is a global option.
105" setlocal cpo+=M		" makes \%( match \)
106