Pick the dynamic filter from #353

CHANGELOG.md

@@ -13,6 +13,7 @@ CHANGELOG
 - Print a note about Rust nightly is requred for building the Python dynamic module.
 - Refine the syntax of `Clap lines` with `ClapLinesBufname` and `ClapLinesNumber` group added.
 - [perf] Use const table instead of `lazy_static` for the icons, [more info](https://github.com/liuchengxu/vim-clap/pull/354#discussion_r395975392). Thanks to @ImmemorConsultrixContrarie .
+- [perf] Major improvement :tada: support the filter dynamic support, contribution by @ImmemorConsultrixContrarie. ([#364](https://github.com/liuchengxu/vim-clap/pull/364))
 
 ### Fixed
 

autoload/clap.vim

@@ -145,22 +145,6 @@ function! clap#_init() abort
   call g:clap.display.setbufvar('&filetype', '')
 endfunction
 
-function! s:unlet_vars(vars) abort
-  for var in a:vars
-    if exists(var)
-      execute 'unlet' var
-    endif
-  endfor
-endfunction
-
-function! s:remove_provider_tmp_vars(vars) abort
-  for var in a:vars
-    if has_key(g:clap.provider, var)
-      call remove(g:clap.provider, var)
-    endif
-  endfor
-endfunction
-
 function! clap#_exit() abort
   call g:clap.provider.jobstop()
   call clap#forerunner#stop()
@@ -178,20 +162,10 @@ function! clap#_exit() abort
   call g:clap.input.clear()
   call g:clap.display.clear()
 
-  call s:remove_provider_tmp_vars([
-        \ 'args',
-        \ 'source_tempfile',
-        \ 'should_switch_to_async',
-        \ ])
-
-  call s:unlet_vars([
-        \ 'g:__clap_fuzzy_matched_indices',
-        \ 'g:__clap_forerunner_result',
-        \ 'g:__clap_lines_truncated_map',
-        \ ])
-
   call clap#sign#reset()
 
+  call clap#state#clear_post()
+
   call map(g:clap.tmps, 'delete(v:val)')
   let g:clap.tmps = []
 endfunction
@@ -268,7 +242,7 @@ function! s:try_register_is_ok(provider_id) abort
     try
       let registration_info = g:clap#provider#{provider_id}#
     catch /^Vim\%((\a\+)\)\=:E121/
-      call clap#helper#echo_error('Fail to load the provider: '.provider_id)
+      call clap#helper#echo_error('Fail to load provider: '.provider_id.', E:'.v:exception)
       return v:false
     endtry
   endif
@@ -283,21 +257,6 @@ function! s:try_register_is_ok(provider_id) abort
   return s:validate_provider(registration_info)
 endfunction
 
-function! s:clear_state() abort
-  call s:unlet_vars([
-        \ 'g:__clap_provider_cwd',
-        \ 'g:__clap_raw_source',
-        \ 'g:__clap_initial_source_size',
-        \ ])
-
-  if exists('g:__clap_forerunner_tempfile')
-    if filereadable(g:__clap_forerunner_tempfile)
-      call delete(g:__clap_forerunner_tempfile)
-    endif
-    unlet g:__clap_forerunner_tempfile
-  endif
-endfunction
-
 function! clap#for(provider_id_or_alias) abort
   if has_key(s:provider_alias, a:provider_id_or_alias)
     let provider_id = s:provider_alias[a:provider_id_or_alias]
@@ -314,6 +273,9 @@ function! clap#for(provider_id_or_alias) abort
     return
   endif
 
+  call clap#state#clear_pre()
+
+  " g:__clap_provider_cwd can be set during this process, so this needs to be executed after s:clear_state()
   if has_key(g:clap.provider._(), 'source')
     if has_key(g:clap.provider._(), 'source_type')
       let g:clap.provider.source_type = g:clap.provider._().source_type
@@ -323,8 +285,6 @@ function! clap#for(provider_id_or_alias) abort
     endif
   endif
 
-  call s:clear_state()
-
   call clap#handler#init()
 
   call g:clap.open_win()

autoload/clap/api.vim

@@ -442,25 +442,6 @@ function! s:init_provider() abort
     return cmd
   endfunction
 
-  " Return the cached source tmp file,
-  " otherwise write the source list into a temp file and then return it.
-  function! s:into_source_tmp_file(source_list) abort
-    if has_key(g:clap.provider, 'source_tempfile')
-      let tmp = g:clap.provider.source_tempfile
-      return tmp
-    else
-      let tmp = tempname()
-      if writefile(a:source_list, tmp) == 0
-        call add(g:clap.tmps, tmp)
-        let g:clap.provider.source_tempfile = tmp
-        return tmp
-      else
-        call g:clap.abort('Fail to write source to a temp file')
-        return ''
-      endif
-    endif
-  endfunction
-
   function! provider.source_async_or_default() abort
     if has_key(self._(), 'source_async')
       return self._().source_async()
@@ -472,7 +453,9 @@ function! s:init_provider() abort
         return s:wrap_async_cmd(Source)
       elseif self.source_type == g:__t_func_string
         return s:wrap_async_cmd(Source())
-      elseif self.source_type == g:__t_list
+      endif
+
+      if self.source_type == g:__t_list
         let lines = copy(Source)
       " This optimization has been moved to on_typed_async_impl()
       " elseif self.id ==# 'blines'
@@ -484,7 +467,7 @@ function! s:init_provider() abort
 
       let ext_filter_cmd = clap#filter#async#external#get_cmd_or_default()
 
-      let tmp = s:into_source_tmp_file(lines)
+      let tmp = clap#state#into_tempfile(lines)
       let cmd = s:read_from_file_or_pipe(ext_filter_cmd, tmp)
 
       return cmd

autoload/clap/filter/async/dyn.vim

@@ -0,0 +1,43 @@
+" Author: liuchengxu <xuliuchengxlc@gmail.com>
+" Description: Dynamic update version of maple filter.
+
+let s:save_cpo = &cpoptions
+set cpoptions&vim
+
+function! s:handle_message(msg) abort
+  if !g:clap.display.win_is_valid()
+        \ || g:clap.input.get() !=# s:last_query
+    return
+  endif
+
+  call clap#state#handle_message(a:msg)
+endfunction
+
+function! clap#filter#async#dyn#start_directly(maple_cmd) abort
+  let s:last_query = g:clap.input.get()
+  call clap#job#stdio#start_service(function('s:handle_message'), a:maple_cmd)
+endfunction
+
+function! clap#filter#async#dyn#start(cmd) abort
+  let s:last_query = g:clap.input.get()
+  call clap#job#stdio#start_dyn_filter_service(function('s:handle_message'), a:cmd)
+endfunction
+
+function! clap#filter#async#dyn#from_tempfile(tempfile) abort
+  let s:last_query = g:clap.input.get()
+  if g:clap_enable_icon && index(['files', 'git_files'], g:clap.provider.id) > -1
+    let enable_icon_opt = '--enable-icon'
+  else
+    let enable_icon_opt = ''
+  endif
+  let filter_cmd = printf('%s --number 100 --winwidth %d filter "%s" --input %s',
+        \ enable_icon_opt,
+        \ winwidth(g:clap.display.winid),
+        \ g:clap.input.get(),
+        \ a:tempfile
+        \ )
+  call clap#job#stdio#start_service(function('s:handle_message'), clap#maple#build_cmd(filter_cmd))
+endfunction
+
+let &cpoptions = s:save_cpo
+unlet s:save_cpo

autoload/clap/filter/async/external.vim

@@ -48,7 +48,7 @@ endfunction
 
 function! s:cmd_of(ext_filter) abort
   if a:ext_filter ==# 'maple'
-    return clap#maple#filter_subcommand(g:clap.input.get())
+    return clap#maple#sync_filter_subcommand(g:clap.input.get())
   else
     return printf(s:ext_cmd[a:ext_filter], g:clap.input.get())
   endif

autoload/clap/forerunner.vim

@@ -13,7 +13,7 @@ function! s:on_complete_common(lines, initial_size) abort
   endif
 
   let g:clap.display.initial_size = a:initial_size
-  call clap#state#refresh_matches_count(string(a:initial_size))
+  call clap#state#refresh_matches_count_on_forerunner_done()
 
   let g:__clap_current_forerunner_status = g:clap_forerunner_status_sign.done
   call clap#spinner#refresh()

autoload/clap/impl.vim

@@ -100,15 +100,27 @@ function! s:on_typed_async_impl() abort
     let source_file = expand('#'.g:clap.start.bufnr.':p')
     let blines_cmd = clap#maple#blines_subcommand(g:clap.input.get())
     let maple_cmd = printf('%s %s', blines_cmd, source_file)
-    call clap#rooter#run(function('clap#maple#job_start'), maple_cmd)
-  else
-    let cmd = g:clap.provider.source_async_or_default()
+    call clap#filter#async#dyn#start_directly(maple_cmd)
+    return
+  endif
 
-    if clap#filter#async#external#using_maple()
-      call clap#rooter#run(function('clap#maple#job_start'), cmd)
-    else
-      call clap#rooter#run(function('clap#dispatcher#job_start'), cmd)
+  if clap#filter#async#external#using_maple()
+    if exists('g:__clap_forerunner_tempfile')
+      call clap#filter#async#dyn#from_tempfile(g:__clap_forerunner_tempfile)
+      return
+    endif
+    if g:clap.provider.source_type == g:__t_string
+      call clap#filter#async#dyn#start(g:clap.provider._().source)
+      return
+    elseif g:clap.provider.source_type == g:__t_func_string
+      call clap#filter#async#dyn#start(g:clap.provider._().source())
+      return
     endif
+    let cmd = g:clap.provider.source_async_or_default()
+    call clap#rooter#run(function('clap#maple#job_start'), cmd)
+  else
+    let cmd = g:clap.provider.source_async_or_default()
+    call clap#rooter#run(function('clap#dispatcher#job_start'), cmd)
   endif
 
   call clap#spinner#set_busy()
@@ -173,10 +185,12 @@ function! clap#impl#on_typed() abort
     call s:on_typed_async_impl()
     return
   endif
+
   if exists('g:__clap_forerunner_result')
     call s:on_typed_sync_impl()
     return
   endif
+
   if g:clap.provider.can_async() &&
         \ (get(g:clap.context, 'async') is v:true || s:should_switch_to_async())
     call s:on_typed_async_impl()

autoload/clap/maple.vim

@@ -54,7 +54,12 @@ function! s:on_complete() abort
     return
   endif
 
-  let decoded = json_decode(s:chunks[0])
+  try
+    let decoded = json_decode(s:chunks[0])
+  catch
+    echoerr '[maple]decoded on_complete:'.string(s:chunks)
+    return
+  endtry
   if has_key(decoded, 'error')
     call g:clap.display.set_lines([
           \ 'The external job runs into some issue:',
@@ -196,14 +201,15 @@ function! clap#maple#forerunner_exec_subcommand(cmd) abort
   return printf('%s %s %s', s:maple_bin, global_opt, subcommand)
 endfunction
 
-function! clap#maple#filter_subcommand(query) abort
+" Returns the filtered results after the input stream is complete.
+function! clap#maple#sync_filter_subcommand(query) abort
   let global_opt = '--number '.g:clap.display.preload_capacity.' --winwidth '.winwidth(g:clap.display.winid)
 
   if g:clap.provider.id ==# 'files' && g:clap_enable_icon
     let global_opt .= ' --enable-icon'
   endif
 
-  let cmd = printf('%s %s filter "%s"', s:maple_bin, global_opt, a:query)
+  let cmd = printf('%s %s filter "%s" --sync', s:maple_bin, global_opt, a:query)
 
   return cmd
 endfunction

autoload/clap/state.vim

@@ -8,6 +8,7 @@ set cpoptions&vim
 " may run into some erratic read-only error.
 function! clap#state#refresh_matches_count(cnt_str) abort
   let l:matches_cnt = a:cnt_str
+  let s:current_matches = a:cnt_str
 
   if get(g:clap.display, 'initial_size', -1) > 0
     let l:matches_cnt .= '/'.g:clap.display.initial_size
@@ -17,6 +18,12 @@ function! clap#state#refresh_matches_count(cnt_str) abort
   call clap#sign#reset_to_first_line()
 endfunction
 
+function! clap#state#refresh_matches_count_on_forerunner_done() abort
+  if exists('s:current_matches')
+    call clap#indicator#set_matches(printf('[%s/%s]', s:current_matches, g:clap.display.initial_size))
+  endif
+endfunction
+
 function! clap#state#handle_message(msg) abort
   let decoded = json_decode(a:msg)
 
@@ -41,5 +48,72 @@ function! clap#state#handle_message(msg) abort
   endif
 endfunction
 
+" Returns the cached source tmp file.
+"
+" Write the providers whose `source` is list-style into a tempfile.
+function! clap#state#into_tempfile(source_list) abort
+  if has_key(g:clap.provider, 'source_tempfile')
+    let tmp = g:clap.provider.source_tempfile
+    return tmp
+  else
+    let tmp = tempname()
+    if writefile(a:source_list, tmp) == 0
+      call add(g:clap.tmps, tmp)
+      let g:clap.provider.source_tempfile = tmp
+      return tmp
+    else
+      call g:clap.abort('Fail to write source to a temp file')
+      return ''
+    endif
+  endif
+endfunction
+
+function! s:unlet_vars(vars) abort
+  for var in a:vars
+    if exists(var)
+      execute 'unlet' var
+    endif
+  endfor
+endfunction
+
+function! s:remove_provider_tmp_vars(vars) abort
+  for var in a:vars
+    if has_key(g:clap.provider, var)
+      call remove(g:clap.provider, var)
+    endif
+  endfor
+endfunction
+
+" Clear the previous temp state when invoking a new provider.
+function! clap#state#clear_pre() abort
+  call s:unlet_vars([
+        \ 'g:__clap_raw_source',
+        \ 'g:__clap_provider_cwd',
+        \ 'g:__clap_initial_source_size',
+        \ ])
+
+  if exists('g:__clap_forerunner_tempfile')
+    if filereadable(g:__clap_forerunner_tempfile)
+      call delete(g:__clap_forerunner_tempfile)
+    endif
+    unlet g:__clap_forerunner_tempfile
+  endif
+endfunction
+
+" Clear temp state on clap#_exit()
+function! clap#state#clear_post() abort
+  call s:remove_provider_tmp_vars([
+        \ 'args',
+        \ 'source_tempfile',
+        \ 'should_switch_to_async',
+        \ ])
+
+  call s:unlet_vars([
+        \ 'g:__clap_fuzzy_matched_indices',
+        \ 'g:__clap_forerunner_result',
+        \ 'g:__clap_lines_truncated_map',
+        \ ])
+endfunction
+
 let &cpoptions = s:save_cpo
 unlet s:save_cpo