Merge branch 'VladimirPal-feature/highlight-execution'

Author: laktak

README.md

@@ -194,7 +194,12 @@ nmap <Leader>P <Plug>(TomePlayParagraph)
 xmap <Leader>p <Plug>(TomePlaySelection)
 ```
 
-[See `help TomeConfig`](doc/tome.txt) in Vim to change them, and for more options.
+[See `help TomeConfig`](doc/tome.txt) in Vim to change them, and for more options:
+
+- execution highlighting
+- "no send" to prevent sending commands vim and other TUIs.
+- target to send to vim terminal instead of tmux
+
 
 ### tmux options
 

doc/tome.txt

@@ -114,4 +114,19 @@ let g:tome_vars = 0
 ```
 
 
+HIGHLIGHT EXECUTED TEXT                         *TomeHighlight*
+
+Tome can briefly highlight the lines you executed. This is disabled by default.
+Note that TomePlaySelection will highlight the full lines.
+
+```
+" enable highlighting with > 0
+let g:tome_highlight_ms = 500
+```
+
+By default the highlight links to |IncSearch| through the `TomeExecuted`
+highlight group. You can customize it by setting your own highlight group
+definition for `TomeExecuted`.
+
+
  vim:tw=78:ts=8:ft=help:norl:

plugin/tome.vim

@@ -21,7 +21,12 @@ if !exists("g:tome_skip_prefix")
   let g:tome_skip_prefix = '^\$\s\+'
 endif
 
+if !exists("g:tome_highlight_ms")
+  let g:tome_highlight_ms = 0
+endif
+
 let s:vars = {}
+let s:highlight_ids = []
 
 function! TomeSetVar(name, value)
   if g:tome_vars
@@ -47,6 +52,46 @@ function! s:notify(text)
   endif
 endfunction
 
+function! s:setExecutedHighlight(start_line, end_line)
+  if g:tome_highlight_ms <= 0
+    return
+  endif
+
+  if !hlexists('TomeExecuted')
+    highlight default link TomeExecuted IncSearch
+  endif
+
+  call s:clearExecutedHighlight()
+
+  for line_num in range(a:start_line, a:end_line)
+    let pattern = '\%'.line_num.'l.*'
+    let id = matchadd('TomeExecuted', pattern)
+    call add(s:highlight_ids, id)
+  endfor
+
+  if len(s:highlight_ids) > 0
+    let s:tome_highlight_timer = timer_start(g:tome_highlight_ms, function('s:tomeClearHighlightTimer'))
+  endif
+endfunction
+
+function! s:clearExecutedHighlight()
+  if len(s:highlight_ids) > 0
+    call timer_stop(s:tome_highlight_timer)
+    for id in s:highlight_ids
+      try
+        call matchdelete(id)
+      catch
+        " Ignore errors if highlight doesn't exist
+      endtry
+    endfor
+  endif
+  let s:highlight_ids = []
+endfunction
+
+function! s:tomeClearHighlightTimer(timer)
+  call s:clearExecutedHighlight()
+endfunction
+
 function! s:tomeSubstituteVars(text)
   if !g:tome_vars | return [a:text, [], []] | endif
   let result = a:text
@@ -93,8 +138,14 @@ function! s:tomeSubstituteVars(text)
   endif
 endfunction
 
-function! s:getVisualSelection()
+function! s:getAndHighlightCurrentLine()
+  call s:setExecutedHighlight(line("."), line("."))
+  return getline(".")."\n"
+endfunction
+
+function! s:getAndHighlightVisualSelection()
   try
+    call s:setExecutedHighlight(line("'<"), line("'>"))
     let oldA = @a
     silent normal! gv"ay
     return getreg('a', 1, 0)
@@ -103,14 +154,15 @@ function! s:getVisualSelection()
   endtry
 endfunction
 
-function! s:getParagraph()
+function! s:getAndHighlightParagraph()
   let start = search('^$', 'bnW')
   let end = search('^$', 'nW')
   if end > 0
     let end = end - 1
   else
     let end = '$'
   endif
+  call s:setExecutedHighlight(start + 1, end)
   let res = getbufline("%", start+1, end)
   return join(res, "\n")
 endfunction
@@ -214,15 +266,15 @@ function! s:prepAndSendCommand(targetOffset, text)
 endfunction
 
 function! s:playLine()
-  call s:prepAndSendCommand(v:count, getline(".")."\n")
+  call s:prepAndSendCommand(v:count, s:getAndHighlightCurrentLine())
 endfunction
 
 function! s:playSel()
-  call s:prepAndSendCommand(v:count, s:getVisualSelection())
+  call s:prepAndSendCommand(v:count, s:getAndHighlightVisualSelection())
 endfunction
 
 function! s:playParagraph()
-  call s:prepAndSendCommand(v:count, s:getParagraph() . "\n")
+  call s:prepAndSendCommand(v:count, s:getAndHighlightParagraph() . "\n")
 endfunction
 
 function! s:mapBufferCRToPlay()
@@ -252,7 +304,6 @@ command! TomePlayBook call s:mapBufferCRToPlay()
 command! -nargs=? TomeScratchPad call s:markScratch(<q-args>)|call s:mapBufferCRToPlay()
 command! -nargs=? TomeScratchPadOnly call s:markScratch(<q-args>)
 
-
 if !exists("g:tome_no_mappings")
 
   nmap <Leader>p <Plug>(TomePlayLine)