support incsearch

[ZSaberLv0]

add incsearch support, for :M/:S/:G/:V/ command, and :M? backward search series

limitations:

• require exists('##CmdlineChanged') && exists('##CmdlineLeave'), to simulate incsearch
  • it seems possible by cmapa to z to simulate incsearch, but that would cause much more trouble
• require has('timers'), to prevent some buggy behavior when used in keymaps, such as nnoremap xxx :S/<c-r><c-w>
• for vim, added a cmap <cr> due to lack of neovim's v:event['abort'] of CmdlineLeave, which may break user's custom keymap
  • if unable to detect the "abort" state, incsearch still work, but the original search pattern can't be restored if :M/ canceled by <esc> or <c-c>

[huyz]

This is awesome. Thanks @ZSaberLv0 !

[huyz]

And thanks @othree as well of course :)

[othree]

@ZSaberLv0 is this ready for review? I see you kept pushing new commits when you created the PR. So I am waiting.

[ZSaberLv0]

it's ready for review, I have tested for these days, no further issue found for my case

[huyz]

Question:
I always prefer case-insensitive matching for / but the safer case-sensitive matching for :s (and :S). So what I've been doing for years is to add \c by default:

nnoremap//\cnnoremap??\c

In the case of eregex, I now do the same with \c:

nnoremap<expr>/":<C-U>".v:count1."M/\\c"nnoremap<expr>?":<C-U>".v:count1."M?\\c"

The problem is that incsearch will highlight the entire file because the pattern already has \c and vim doesn't realize that this is equivalent to just empty string and thus shouldn't be highlighted. Is there a workaround to avoid the momentary whole-file highlighting?

I guess another solution for me would be if eregex could support separate eregex_force_case_in_search and eregex_force_case_in_substitute. Then I wouldn't need the \c. But I don't know if this would cause problems (e.g., if I reuse the search history)

Not a big deal, either way.

[ZSaberLv0]

maybe we can add user defined pattern filter around here: incsearch.vim#L53

let Fn_filter =get(b:, 'Fn_eregex_incsearch_filter', get(g:, 'Fn_eregex_incsearch_filter', ''))
if!empty(Fn_filter) &&Fn_filter(cmd['pattern'])
ifexists('s:patternSaved')
let@/=s:patternSavedendififexists('s:stateSaved')
callwinrestview(s:stateSaved)
endifredraw!returnendif

[huyz]

@ZSaberLv0 A user-defined filter would be great for me.

[huyz]

Great, it works fine for me now if I do /. But for some reason I can't get incsearch when I do ?.

This is my .vimrc right now:

" We want `:S` substitutions to be case-sensitive.letg:eregex_force_case=1" Disable the default mappings because we have to do the mapping ourselvesletg:eregex_default_enable=0letg:eregex_forward_delim='/'letg:eregex_backward_delim='?'" Avoid total-file highlight because of the additional `\c`letg:Fn_eregex_incsearch_filter= {x-> x=='\c'}
" Code from eregex.vimlets:enable=0function!EregexToggle(...)
letsilent=0ifexists('a:1') &&a:1letsilent=1endififs:enable==0exec'nnoremap <expr> '.g:eregex_forward_delim.' ":<C-U>".v:count1."M/\\c"'exec'nnoremap <expr> '.g:eregex_backward_delim.' ":<C-U>".v:count1."M?\\c"'ifsilent!=1echo"eregex.vim key mapping enabled"endifelseexec'nunmap '.g:eregex_forward_delimexec'nunmap '.g:eregex_backward_delimifsilent!=1echo"eregex.vim key mapping disabled"endifendiflets:enable=1-s:enableendfuncallMapKey('<M-t>/', '<Cmd>call EregexToggle()<CR>')
" Start out enabledcallEregexToggle(v:true)

[huyz]

There might be another issue. I have:

setignorecasesmartcaseletg:eregex_force_case=1

So if I type :%S/case then CASE should not be highlighted by incsearch, but it is highlighted.

[huyz]

Thanks a lot for the quick turnaround! Looks good so far.

[huyz]

I think it's a good time to review and merge :)

[ZSaberLv0]

add support for custom cmdparser, a typical config for dkprice/vim-easygrep

function!Easygrep_incsearch(cmdline)
let cmd =substitute(a:cmdline, ' .*', '', '')
if cmd =='Grep'return {
\ 'method' : cmd,
\ 'delim' : '/',
\ 'modifiers' : '',
\ 'pattern' : substitute(a:cmdline, '^ *[^ ]\+ \+', '', ''),
\ }
elseif cmd =='Replace'let slashToken =nr2char(127)
let cmdline =substitute(a:cmdline, '^ *[^ ]\+ \+', '', '')
let cmdline =substitute(cmdline, '\\/', slashToken, 'g')
letitems=split(cmdline, '/')
ifempty(items)
return {}
endifreturn {
\ 'method' : cmd,
\ 'delim' : '/',
\ 'modifiers' : '',
\ 'pattern' : substitute(items[0], slashToken, '\\/', 'g'),
\ }
elsereturn {}
endifendfunctionletg:eregex_incsearch_custom_cmdparser= {
\ 'easygrep' : function('Easygrep_incsearch'),
\ }