Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1 | " Vim filetype plugin |
| 2 | " Language: Vim |
Christian Brabandt | e978b45 | 2023-08-13 10:33:05 +0200 | [diff] [blame] | 3 | " Maintainer: The Vim Project <https://github.com/vim/vim> |
| 4 | " Last Change: 2023 Aug 10 |
| 5 | " Former Maintainer: Bram Moolenaar <Bram@vim.org> |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6 | |
| 7 | " Only do this when not done yet for this buffer |
| 8 | if exists("b:did_ftplugin") |
| 9 | finish |
| 10 | endif |
| 11 | |
| 12 | " Don't load another plugin for this buffer |
| 13 | let b:did_ftplugin = 1 |
| 14 | |
Bram Moolenaar | 5c73622 | 2010-01-06 20:54:52 +0100 | [diff] [blame] | 15 | let s:cpo_save = &cpo |
Bram Moolenaar | 388a5d4 | 2020-05-26 21:20:45 +0200 | [diff] [blame] | 16 | set cpo&vim |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 17 | |
Bram Moolenaar | fd35811 | 2018-07-07 23:21:31 +0200 | [diff] [blame] | 18 | if !exists('*VimFtpluginUndo') |
| 19 | func VimFtpluginUndo() |
Bram Moolenaar | 5ed1153 | 2022-07-06 13:18:11 +0100 | [diff] [blame] | 20 | setl fo< isk< com< tw< commentstring< include< define< |
Bram Moolenaar | d473c8c | 2018-08-11 18:00:22 +0200 | [diff] [blame] | 21 | if exists('b:did_add_maps') |
| 22 | silent! nunmap <buffer> [[ |
| 23 | silent! vunmap <buffer> [[ |
| 24 | silent! nunmap <buffer> ]] |
| 25 | silent! vunmap <buffer> ]] |
| 26 | silent! nunmap <buffer> [] |
| 27 | silent! vunmap <buffer> [] |
| 28 | silent! nunmap <buffer> ][ |
| 29 | silent! vunmap <buffer> ][ |
| 30 | silent! nunmap <buffer> ]" |
| 31 | silent! vunmap <buffer> ]" |
| 32 | silent! nunmap <buffer> [" |
| 33 | silent! vunmap <buffer> [" |
Bram Moolenaar | fd35811 | 2018-07-07 23:21:31 +0200 | [diff] [blame] | 34 | endif |
| 35 | unlet! b:match_ignorecase b:match_words b:match_skip b:did_add_maps |
| 36 | endfunc |
| 37 | endif |
| 38 | |
| 39 | let b:undo_ftplugin = "call VimFtpluginUndo()" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 40 | |
| 41 | " Set 'formatoptions' to break comment lines but not other lines, |
| 42 | " and insert the comment leader when hitting <CR> or using "o". |
| 43 | setlocal fo-=t fo+=croql |
| 44 | |
Bram Moolenaar | 5c73622 | 2010-01-06 20:54:52 +0100 | [diff] [blame] | 45 | " To allow tag lookup via CTRL-] for autoload functions, '#' must be a |
| 46 | " keyword character. E.g., for netrw#Nread(). |
| 47 | setlocal isk+=# |
| 48 | |
Bram Moolenaar | 7f2e9d7 | 2017-11-11 20:58:53 +0100 | [diff] [blame] | 49 | " Use :help to lookup the keyword under the cursor with K. |
| 50 | setlocal keywordprg=:help |
| 51 | |
Bram Moolenaar | 71b6d33 | 2022-09-10 13:13:14 +0100 | [diff] [blame] | 52 | " Comments starts with # in Vim9 script. We have to guess which one to use. |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 53 | if "\n" .. getline(1, 10)->join("\n") =~# '\n\s*vim9\%[script]\>' |
Bram Moolenaar | 98a29d0 | 2021-01-18 19:55:44 +0100 | [diff] [blame] | 54 | setlocal commentstring=#%s |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 55 | else |
Bram Moolenaar | 98a29d0 | 2021-01-18 19:55:44 +0100 | [diff] [blame] | 56 | setlocal commentstring=\"%s |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 57 | endif |
| 58 | |
Bram Moolenaar | 71b6d33 | 2022-09-10 13:13:14 +0100 | [diff] [blame] | 59 | " Set 'comments' to format dashed lists in comments, both in Vim9 and legacy |
| 60 | " script. |
| 61 | setlocal com=sO:#\ -,mO:#\ \ ,eO:##,:#,sO:\"\ -,mO:\"\ \ ,eO:\"\",:\" |
| 62 | |
Bram Moolenaar | 5ed1153 | 2022-07-06 13:18:11 +0100 | [diff] [blame] | 63 | " set 'include' to recognize import commands |
| 64 | setlocal include=\\v^\\s*import\\s*(autoload)? |
| 65 | |
| 66 | " set 'define' to recognize export commands |
| 67 | setlocal define=\\v^\\s*export\\s*(def\|const\|var\|final) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 68 | |
| 69 | " Format comments to be up to 78 characters long |
| 70 | if &tw == 0 |
| 71 | setlocal tw=78 |
| 72 | endif |
| 73 | |
Bram Moolenaar | f0b03c4 | 2017-12-17 17:17:07 +0100 | [diff] [blame] | 74 | if !exists("no_plugin_maps") && !exists("no_vim_maps") |
Bram Moolenaar | fd35811 | 2018-07-07 23:21:31 +0200 | [diff] [blame] | 75 | let b:did_add_maps = 1 |
| 76 | |
Bram Moolenaar | f0b03c4 | 2017-12-17 17:17:07 +0100 | [diff] [blame] | 77 | " Move around functions. |
Bram Moolenaar | 9fbdbb8 | 2022-09-27 17:30:34 +0100 | [diff] [blame] | 78 | nnoremap <silent><buffer> [[ m':call search('^\s*\(fu\%[nction]\\|\(export\s\+\)\?def\)\>', "bW")<CR> |
| 79 | vnoremap <silent><buffer> [[ m':<C-U>exe "normal! gv"<Bar>call search('^\s*\(fu\%[nction]\\|\(export\s\+\)\?def\)\>', "bW")<CR> |
| 80 | nnoremap <silent><buffer> ]] m':call search('^\s*\(fu\%[nction]\\|\(export\s\+\)\?def\)\>', "W")<CR> |
| 81 | vnoremap <silent><buffer> ]] m':<C-U>exe "normal! gv"<Bar>call search('^\s*\(fu\%[nction]\\|\(export\s\+\)\?def\)\>', "W")<CR> |
| 82 | nnoremap <silent><buffer> [] m':call search('^\s*end\(f\%[unction]\\|\(export\s\+\)\?def\)\>', "bW")<CR> |
| 83 | vnoremap <silent><buffer> [] m':<C-U>exe "normal! gv"<Bar>call search('^\s*end\(f\%[unction]\\|\(export\s\+\)\?def\)\>', "bW")<CR> |
| 84 | nnoremap <silent><buffer> ][ m':call search('^\s*end\(f\%[unction]\\|\(export\s\+\)\?def\)\>', "W")<CR> |
| 85 | vnoremap <silent><buffer> ][ m':<C-U>exe "normal! gv"<Bar>call search('^\s*end\(f\%[unction]\\|\(export\s\+\)\?def\)\>', "W")<CR> |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 86 | |
Bram Moolenaar | f0b03c4 | 2017-12-17 17:17:07 +0100 | [diff] [blame] | 87 | " Move around comments |
| 88 | nnoremap <silent><buffer> ]" :call search('^\(\s*".*\n\)\@<!\(\s*"\)', "W")<CR> |
| 89 | vnoremap <silent><buffer> ]" :<C-U>exe "normal! gv"<Bar>call search('^\(\s*".*\n\)\@<!\(\s*"\)', "W")<CR> |
| 90 | nnoremap <silent><buffer> [" :call search('\%(^\s*".*\n\)\%(^\s*"\)\@!', "bW")<CR> |
| 91 | vnoremap <silent><buffer> [" :<C-U>exe "normal! gv"<Bar>call search('\%(^\s*".*\n\)\%(^\s*"\)\@!', "bW")<CR> |
| 92 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 93 | |
| 94 | " Let the matchit plugin know what items can be matched. |
| 95 | if exists("loaded_matchit") |
| 96 | let b:match_ignorecase = 0 |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 97 | " "func" can also be used as a type: |
| 98 | " var Ref: func |
| 99 | " or to list functions: |
| 100 | " func name |
| 101 | " require a parenthesis following, then there can be an "endfunc". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 102 | let b:match_words = |
Bram Moolenaar | 938ae28 | 2023-02-20 20:44:55 +0000 | [diff] [blame] | 103 | \ '\<\%(fu\%[nction]\|def\)!\=\s\+\S\+\s*(:\%(\%(^\||\)\s*\)\@<=\<retu\%[rn]\>:\%(\%(^\||\)\s*\)\@<=\<\%(endf\%[unction]\|enddef\)\>,' .. |
| 104 | \ '\<\%(wh\%[ile]\|for\)\>:\%(\%(^\||\)\s*\)\@<=\<brea\%[k]\>:\%(\%(^\||\)\s*\)\@<=\<con\%[tinue]\>:\%(\%(^\||\)\s*\)\@<=\<end\%(w\%[hile]\|fo\%[r]\)\>,' .. |
| 105 | \ '\<if\>:\%(\%(^\||\)\s*\)\@<=\<el\%[seif]\>:\%(\%(^\||\)\s*\)\@<=\<en\%[dif]\>,' .. |
| 106 | \ '{:},' .. |
| 107 | \ '\<try\>:\%(\%(^\||\)\s*\)\@<=\<cat\%[ch]\>:\%(\%(^\||\)\s*\)\@<=\<fina\%[lly]\>:\%(\%(^\||\)\s*\)\@<=\<endt\%[ry]\>,' .. |
| 108 | \ '\<aug\%[roup]\s\+\%(END\>\)\@!\S:\<aug\%[roup]\s\+END\>,' .. |
| 109 | \ '\<class\>:\<endclass\>,' .. |
| 110 | \ '\<inte\%[rface]\>:\<endinterface\>,' .. |
| 111 | \ '\<enu\%[m]\>:\<endenum\>,' |
| 112 | |
Bram Moolenaar | 6e93246 | 2014-09-09 18:48:09 +0200 | [diff] [blame] | 113 | " Ignore syntax region commands and settings, any 'en*' would clobber |
| 114 | " if-endif. |
| 115 | " - set spl=de,en |
| 116 | " - au! FileType javascript syntax region foldBraces start=/{/ end=/}/ … |
Bram Moolenaar | 938ae28 | 2023-02-20 20:44:55 +0000 | [diff] [blame] | 117 | " Also ignore here-doc and dictionary keys (vimVar). |
| 118 | let b:match_skip = 'synIDattr(synID(line("."), col("."), 1), "name") |
| 119 | \ =~? "comment\\|string\\|vimSynReg\\|vimSet\\|vimLetHereDoc\\|vimVar"' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 120 | endif |
| 121 | |
Bram Moolenaar | 5c73622 | 2010-01-06 20:54:52 +0100 | [diff] [blame] | 122 | let &cpo = s:cpo_save |
| 123 | unlet s:cpo_save |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 124 | |
| 125 | " removed this, because 'cpoptions' is a global option. |
| 126 | " setlocal cpo+=M " makes \%( match \) |