15e3cb7e8SBram Moolenaar" Vim plugin for showing matching parens
25e3cb7e8SBram Moolenaar" Maintainer:  Bram Moolenaar <[email protected]>
3*2347f062SBram Moolenaar" Last Change: 2006 May 11
45e3cb7e8SBram Moolenaar
55e3cb7e8SBram Moolenaar" Exit quickly when:
65e3cb7e8SBram Moolenaar" - this plugin was already loaded (or disabled)
75e3cb7e8SBram Moolenaar" - when 'compatible' is set
85e3cb7e8SBram Moolenaar" - the "CursorMoved" autocmd event is not availble.
95e3cb7e8SBram Moolenaarif exists("g:loaded_matchparen") || &cp || !exists("##CursorMoved")
105e3cb7e8SBram Moolenaar  finish
115e3cb7e8SBram Moolenaarendif
125e3cb7e8SBram Moolenaarlet g:loaded_matchparen = 1
135e3cb7e8SBram Moolenaar
145e3cb7e8SBram Moolenaaraugroup matchparen
155e3cb7e8SBram Moolenaar  " Replace all matchparen autocommands
165e3cb7e8SBram Moolenaar  autocmd! CursorMoved,CursorMovedI * call s:Highlight_Matching_Pair()
175e3cb7e8SBram Moolenaaraugroup END
185e3cb7e8SBram Moolenaar
195e3cb7e8SBram Moolenaar" Skip the rest if it was already done.
205e3cb7e8SBram Moolenaarif exists("*s:Highlight_Matching_Pair")
215e3cb7e8SBram Moolenaar  finish
225e3cb7e8SBram Moolenaarendif
235e3cb7e8SBram Moolenaar
243b1ddfedSBram Moolenaarlet cpo_save = &cpo
253b1ddfedSBram Moolenaarset cpo-=C
263b1ddfedSBram Moolenaar
275e3cb7e8SBram Moolenaar" The function that is invoked (very often) to define a ":match" highlighting
285e3cb7e8SBram Moolenaar" for any matching paren.
295e3cb7e8SBram Moolenaarfunction! s:Highlight_Matching_Pair()
305e3cb7e8SBram Moolenaar  " Remove any previous match.
31910f66f9SBram Moolenaar  if exists('w:paren_hl_on') && w:paren_hl_on
32e1438bb8SBram Moolenaar    3match none
33910f66f9SBram Moolenaar    let w:paren_hl_on = 0
345e3cb7e8SBram Moolenaar  endif
355e3cb7e8SBram Moolenaar
3636fc535cSBram Moolenaar  " Avoid that we remove the popup menu.
3736fc535cSBram Moolenaar  if pumvisible()
3836fc535cSBram Moolenaar    return
3936fc535cSBram Moolenaar  endif
4036fc535cSBram Moolenaar
415e3cb7e8SBram Moolenaar  " Get the character under the cursor and check if it's in 'matchpairs'.
425e3cb7e8SBram Moolenaar  let c_lnum = line('.')
435e3cb7e8SBram Moolenaar  let c_col = col('.')
445e3cb7e8SBram Moolenaar  let before = 0
455e3cb7e8SBram Moolenaar
465e3cb7e8SBram Moolenaar  let c = getline(c_lnum)[c_col - 1]
475e3cb7e8SBram Moolenaar  let plist = split(&matchpairs, ':\|,')
485e3cb7e8SBram Moolenaar  let i = index(plist, c)
495e3cb7e8SBram Moolenaar  if i < 0
505e3cb7e8SBram Moolenaar    " not found, in Insert mode try character before the cursor
515e3cb7e8SBram Moolenaar    if c_col > 1 && (mode() == 'i' || mode() == 'R')
525e3cb7e8SBram Moolenaar      let before = 1
535e3cb7e8SBram Moolenaar      let c = getline(c_lnum)[c_col - 2]
545e3cb7e8SBram Moolenaar      let i = index(plist, c)
555e3cb7e8SBram Moolenaar    endif
565e3cb7e8SBram Moolenaar    if i < 0
575e3cb7e8SBram Moolenaar      " not found, nothing to do
585e3cb7e8SBram Moolenaar      return
595e3cb7e8SBram Moolenaar    endif
605e3cb7e8SBram Moolenaar  endif
615e3cb7e8SBram Moolenaar
625e3cb7e8SBram Moolenaar  " Figure out the arguments for searchpairpos().
635e3cb7e8SBram Moolenaar  " Restrict the search to visible lines with "stopline".
64910f66f9SBram Moolenaar  " And avoid searching very far (e.g., for closed folds and long lines)
655e3cb7e8SBram Moolenaar  if i % 2 == 0
665e3cb7e8SBram Moolenaar    let s_flags = 'nW'
675e3cb7e8SBram Moolenaar    let c2 = plist[i + 1]
68910f66f9SBram Moolenaar    if has("byte_offset") && has("syntax_items") && &smc > 0
69910f66f9SBram Moolenaar      let stopbyte = min([line2byte("$"), line2byte(".") + col(".") + &smc * 2])
70910f66f9SBram Moolenaar      let stopline = min([line('w$'), byte2line(stopbyte)])
71910f66f9SBram Moolenaar    else
72910f66f9SBram Moolenaar      let stopline = min([line('w$'), c_lnum + 100])
73e2f98b95SBram Moolenaar    endif
745e3cb7e8SBram Moolenaar  else
755e3cb7e8SBram Moolenaar    let s_flags = 'nbW'
765e3cb7e8SBram Moolenaar    let c2 = c
775e3cb7e8SBram Moolenaar    let c = plist[i - 1]
78910f66f9SBram Moolenaar    if has("byte_offset") && has("syntax_items") && &smc > 0
79910f66f9SBram Moolenaar      let stopbyte = max([1, line2byte(".") + col(".") - &smc * 2])
80910f66f9SBram Moolenaar      let stopline = max([line('w0'), byte2line(stopbyte)])
81910f66f9SBram Moolenaar    else
82910f66f9SBram Moolenaar      let stopline = max([line('w0'), c_lnum - 100])
83e2f98b95SBram Moolenaar    endif
845e3cb7e8SBram Moolenaar  endif
855e3cb7e8SBram Moolenaar  if c == '['
865e3cb7e8SBram Moolenaar    let c = '\['
875e3cb7e8SBram Moolenaar    let c2 = '\]'
885e3cb7e8SBram Moolenaar  endif
895e3cb7e8SBram Moolenaar
905e3cb7e8SBram Moolenaar  " Find the match.  When it was just before the cursor move it there for a
91c06ac340SBram Moolenaar  " moment.
925e3cb7e8SBram Moolenaar  if before > 0
93*2347f062SBram Moolenaar    let save_cursor = winsaveview()
945e3cb7e8SBram Moolenaar    call cursor(c_lnum, c_col - before)
955e3cb7e8SBram Moolenaar  endif
9625e2c9e3SBram Moolenaar
9725e2c9e3SBram Moolenaar  " When not in a string or comment ignore matches inside them.
9825e2c9e3SBram Moolenaar  let s_skip ='synIDattr(synID(line("."), col("."), 0), "name") ' .
9925e2c9e3SBram Moolenaar	\ '=~?  "string\\|comment"'
10025e2c9e3SBram Moolenaar  execute 'if' s_skip '| let s_skip = 0 | endif'
10125e2c9e3SBram Moolenaar
1025e3cb7e8SBram Moolenaar  let [m_lnum, m_col] = searchpairpos(c, '', c2, s_flags, s_skip, stopline)
10325e2c9e3SBram Moolenaar
1045e3cb7e8SBram Moolenaar  if before > 0
105*2347f062SBram Moolenaar    call winrestview(save_cursor)
1065e3cb7e8SBram Moolenaar  endif
1075e3cb7e8SBram Moolenaar
1085e3cb7e8SBram Moolenaar  " If a match is found setup match highlighting.
1095e3cb7e8SBram Moolenaar  if m_lnum > 0 && m_lnum >= line('w0') && m_lnum <= line('w$')
110e1438bb8SBram Moolenaar    exe '3match MatchParen /\(\%' . c_lnum . 'l\%' . (c_col - before) .
1115e3cb7e8SBram Moolenaar	  \ 'c\)\|\(\%' . m_lnum . 'l\%' . m_col . 'c\)/'
112910f66f9SBram Moolenaar    let w:paren_hl_on = 1
1135e3cb7e8SBram Moolenaar  endif
1145e3cb7e8SBram Moolenaarendfunction
1155e3cb7e8SBram Moolenaar
1165e3cb7e8SBram Moolenaar" Define commands that will disable and enable the plugin.
117e1438bb8SBram Moolenaarcommand! NoMatchParen 3match none | unlet! g:loaded_matchparen | au! matchparen
1185e3cb7e8SBram Moolenaarcommand! DoMatchParen runtime plugin/matchparen.vim | doau CursorMoved
1193b1ddfedSBram Moolenaar
1203b1ddfedSBram Moolenaarlet &cpo = cpo_save
121