blob: 59d33f4d4eeb9c316c406b58e776b4eeb181d87e [file] [log] [blame]
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001" Vim plugin for showing matching parens
2" Maintainer: Bram Moolenaar <Bram@vim.org>
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01003" Last Change: 2019 Oct 28
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004
5" Exit quickly when:
6" - this plugin was already loaded (or disabled)
7" - when 'compatible' is set
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02008" - the "CursorMoved" autocmd event is not available.
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00009if exists("g:loaded_matchparen") || &cp || !exists("##CursorMoved")
10 finish
11endif
12let g:loaded_matchparen = 1
13
Bram Moolenaarad3b3662013-05-17 18:14:19 +020014if !exists("g:matchparen_timeout")
15 let g:matchparen_timeout = 300
16endif
17if !exists("g:matchparen_insert_timeout")
18 let g:matchparen_insert_timeout = 60
19endif
20
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000021augroup matchparen
22 " Replace all matchparen autocommands
Bram Moolenaarfa2e0442007-08-18 16:21:50 +000023 autocmd! CursorMoved,CursorMovedI,WinEnter * call s:Highlight_Matching_Pair()
Bram Moolenaar186628f2013-03-19 13:33:23 +010024 if exists('##TextChanged')
25 autocmd! TextChanged,TextChangedI * call s:Highlight_Matching_Pair()
26 endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000027augroup END
28
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000029" Skip the rest if it was already done.
30if exists("*s:Highlight_Matching_Pair")
31 finish
32endif
33
Bram Moolenaar5c736222010-01-06 20:54:52 +010034let s:cpo_save = &cpo
Bram Moolenaar3b1ddfe2006-03-14 22:55:34 +000035set cpo-=C
36
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000037" The function that is invoked (very often) to define a ":match" highlighting
38" for any matching paren.
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +010039func s:Highlight_Matching_Pair()
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000040 " Remove any previous match.
Bram Moolenaar910f66f2006-04-05 20:41:53 +000041 if exists('w:paren_hl_on') && w:paren_hl_on
Bram Moolenaarb3414592014-06-17 17:48:32 +020042 silent! call matchdelete(3)
Bram Moolenaar910f66f2006-04-05 20:41:53 +000043 let w:paren_hl_on = 0
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000044 endif
45
Bram Moolenaar36fc5352006-03-04 21:49:37 +000046 " Avoid that we remove the popup menu.
Bram Moolenaarf2b2e702008-03-09 15:45:53 +000047 " Return when there are no colors (looks like the cursor jumps).
48 if pumvisible() || (&t_Co < 8 && !has("gui_running"))
Bram Moolenaar36fc5352006-03-04 21:49:37 +000049 return
50 endif
51
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000052 " Get the character under the cursor and check if it's in 'matchpairs'.
53 let c_lnum = line('.')
54 let c_col = col('.')
55 let before = 0
56
Bram Moolenaardb6ea062014-07-10 22:01:47 +020057 let text = getline(c_lnum)
Bram Moolenaarc21d67e2015-12-31 22:27:55 +010058 let matches = matchlist(text, '\(.\)\=\%'.c_col.'c\(.\=\)')
Bram Moolenaar256972a2015-12-29 19:10:25 +010059 if empty(matches)
60 let [c_before, c] = ['', '']
61 else
62 let [c_before, c] = matches[1:2]
63 endif
Bram Moolenaar41e6cd52006-09-09 11:37:51 +000064 let plist = split(&matchpairs, '.\zs[:,]')
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000065 let i = index(plist, c)
66 if i < 0
67 " not found, in Insert mode try character before the cursor
68 if c_col > 1 && (mode() == 'i' || mode() == 'R')
Bram Moolenaar256972a2015-12-29 19:10:25 +010069 let before = strlen(c_before)
70 let c = c_before
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000071 let i = index(plist, c)
72 endif
73 if i < 0
74 " not found, nothing to do
75 return
76 endif
77 endif
78
79 " Figure out the arguments for searchpairpos().
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000080 if i % 2 == 0
81 let s_flags = 'nW'
82 let c2 = plist[i + 1]
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000083 else
84 let s_flags = 'nbW'
85 let c2 = c
86 let c = plist[i - 1]
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000087 endif
88 if c == '['
89 let c = '\['
90 let c2 = '\]'
91 endif
92
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000093 " Find the match. When it was just before the cursor move it there for a
Bram Moolenaarc06ac342006-03-02 22:43:39 +000094 " moment.
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +000095 if before > 0
Bram Moolenaar07d87792014-07-19 14:04:47 +020096 let has_getcurpos = exists("*getcurpos")
97 if has_getcurpos
98 " getcurpos() is more efficient but doesn't exist before 7.4.313.
99 let save_cursor = getcurpos()
100 else
101 let save_cursor = winsaveview()
102 endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000103 call cursor(c_lnum, c_col - before)
104 endif
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000105
Bram Moolenaar3d1d6472018-07-03 18:18:23 +0200106 if !has("syntax") || !exists("g:syntax_on")
107 let s_skip = "0"
108 else
109 " Build an expression that detects whether the current cursor position is
110 " in certain syntax types (string, comment, etc.), for use as
111 " searchpairpos()'s skip argument.
112 " We match "escape" for special items, such as lispEscapeSpecial.
113 let s_skip = '!empty(filter(map(synstack(line("."), col(".")), ''synIDattr(v:val, "name")''), ' .
Bram Moolenaare98cfe12014-08-06 19:09:16 +0200114 \ '''v:val =~? "string\\|character\\|singlequote\\|escape\\|comment"''))'
Bram Moolenaar3d1d6472018-07-03 18:18:23 +0200115 " If executing the expression determines that the cursor is currently in
116 " one of the syntax types, then we want searchpairpos() to find the pair
117 " within those syntax types (i.e., not skip). Otherwise, the cursor is
118 " outside of the syntax types and s_skip should keep its value so we skip
119 " any matching pair inside the syntax types.
120 " Catch if this throws E363: pattern uses more memory than 'maxmempattern'.
121 try
122 execute 'if ' . s_skip . ' | let s_skip = "0" | endif'
123 catch /^Vim\%((\a\+)\)\=:E363/
124 " We won't find anything, so skip searching, should keep Vim responsive.
125 return
126 endtry
127 endif
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000128
Bram Moolenaarf2b2e702008-03-09 15:45:53 +0000129 " Limit the search to lines visible in the window.
130 let stoplinebottom = line('w$')
131 let stoplinetop = line('w0')
132 if i % 2 == 0
133 let stopline = stoplinebottom
134 else
135 let stopline = stoplinetop
136 endif
137
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200138 " Limit the search time to 300 msec to avoid a hang on very long lines.
139 " This fails when a timeout is not supported.
140 if mode() == 'i' || mode() == 'R'
141 let timeout = exists("b:matchparen_insert_timeout") ? b:matchparen_insert_timeout : g:matchparen_insert_timeout
142 else
143 let timeout = exists("b:matchparen_timeout") ? b:matchparen_timeout : g:matchparen_timeout
144 endif
Bram Moolenaar76929292008-01-06 19:07:36 +0000145 try
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200146 let [m_lnum, m_col] = searchpairpos(c, '', c2, s_flags, s_skip, stopline, timeout)
Bram Moolenaar76929292008-01-06 19:07:36 +0000147 catch /E118/
Bram Moolenaarf2b2e702008-03-09 15:45:53 +0000148 " Can't use the timeout, restrict the stopline a bit more to avoid taking
149 " a long time on closed folds and long lines.
150 " The "viewable" variables give a range in which we can scroll while
151 " keeping the cursor at the same position.
152 " adjustedScrolloff accounts for very large numbers of scrolloff.
153 let adjustedScrolloff = min([&scrolloff, (line('w$') - line('w0')) / 2])
154 let bottom_viewable = min([line('$'), c_lnum + &lines - adjustedScrolloff - 2])
155 let top_viewable = max([1, c_lnum-&lines+adjustedScrolloff + 2])
156 " one of these stoplines will be adjusted below, but the current values are
157 " minimal boundaries within the current window
158 if i % 2 == 0
159 if has("byte_offset") && has("syntax_items") && &smc > 0
160 let stopbyte = min([line2byte("$"), line2byte(".") + col(".") + &smc * 2])
161 let stopline = min([bottom_viewable, byte2line(stopbyte)])
162 else
163 let stopline = min([bottom_viewable, c_lnum + 100])
164 endif
165 let stoplinebottom = stopline
166 else
167 if has("byte_offset") && has("syntax_items") && &smc > 0
168 let stopbyte = max([1, line2byte(".") + col(".") - &smc * 2])
169 let stopline = max([top_viewable, byte2line(stopbyte)])
170 else
171 let stopline = max([top_viewable, c_lnum - 100])
172 endif
173 let stoplinetop = stopline
174 endif
Bram Moolenaar76929292008-01-06 19:07:36 +0000175 let [m_lnum, m_col] = searchpairpos(c, '', c2, s_flags, s_skip, stopline)
176 endtry
Bram Moolenaar25e2c9e2006-04-27 21:40:34 +0000177
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000178 if before > 0
Bram Moolenaar07d87792014-07-19 14:04:47 +0200179 if has_getcurpos
180 call setpos('.', save_cursor)
181 else
182 call winrestview(save_cursor)
183 endif
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000184 endif
185
186 " If a match is found setup match highlighting.
Bram Moolenaaref045862007-08-02 21:00:50 +0000187 if m_lnum > 0 && m_lnum >= stoplinetop && m_lnum <= stoplinebottom
Bram Moolenaarb3414592014-06-17 17:48:32 +0200188 if exists('*matchaddpos')
189 call matchaddpos('MatchParen', [[c_lnum, c_col - before], [m_lnum, m_col]], 10, 3)
190 else
191 exe '3match MatchParen /\(\%' . c_lnum . 'l\%' . (c_col - before) .
192 \ 'c\)\|\(\%' . m_lnum . 'l\%' . m_col . 'c\)/'
193 endif
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000194 let w:paren_hl_on = 1
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000195 endif
196endfunction
197
198" Define commands that will disable and enable the plugin.
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100199command DoMatchParen call s:DoMatchParen()
200command NoMatchParen call s:NoMatchParen()
Bram Moolenaar01164a62017-11-02 22:58:42 +0100201
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100202func s:NoMatchParen()
Bram Moolenaar01164a62017-11-02 22:58:42 +0100203 let w = winnr()
204 noau windo silent! call matchdelete(3)
205 unlet! g:loaded_matchparen
206 exe "noau ". w . "wincmd w"
207 au! matchparen
208endfunc
209
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100210func s:DoMatchParen()
Bram Moolenaar01164a62017-11-02 22:58:42 +0100211 runtime plugin/matchparen.vim
212 let w = winnr()
213 silent windo doau CursorMoved
214 exe "noau ". w . "wincmd w"
215endfunc
Bram Moolenaar3b1ddfe2006-03-14 22:55:34 +0000216
Bram Moolenaar5c736222010-01-06 20:54:52 +0100217let &cpo = s:cpo_save
218unlet s:cpo_save