Wikia

Vim Tips Wiki

Changes: Auto highlight current word when idle

Edit

Back to page

m (fix category typo)
(Escaping!)
Line 33: Line 33:
 
augroup auto_highlight
 
augroup auto_highlight
 
au!
 
au!
au CursorHold * let @/ = '\<'.expand('<cword>').'\>'
+
au CursorHold * let @/ = '\V\<'.escape(expand('<cword>'), '\').'\>'
 
augroup end
 
augroup end
 
setl updatetime=500
 
setl updatetime=500

Revision as of 15:58, March 2, 2011

Tip 572 Printable Monobook Previous Next

created 2003 · complexity basic · author mosh · version 6.0


Vim can easily highlight all search pattern matches and search for the current word (the word under the cursor). This tip shows how to automatically highlight all occurrences of the current word without searching. That can useful when examining unfamiliar source code: just move the cursor to a variable, and all occurrences of the variable will be highlighted.

Script

Put the following code in your vimrc, or create file ~/.vim/plugin/autohighlight.vim (Unix) or $HOME/vimfiles/plugin/autohighlight.vim (Windows) containing the script below. Then restart Vim.

To automatically highlight the current word, type z/. To turn off, type z/ again.

" Highlight all instances of word under cursor, when idle.
" Useful when studying strange source code.
" Type z/ to toggle highlighting on/off.
nnoremap z/ :if AutoHighlightToggle()<Bar>set hls<Bar>endif<CR>
function! AutoHighlightToggle()
  let @/ = ''
  if exists('#auto_highlight')
    au! auto_highlight
    augroup! auto_highlight
    setl updatetime=4000
    echo 'Highlight current word: off'
    return 0
  else
    augroup auto_highlight
      au!
      au CursorHold * let @/ = '\V\<'.escape(expand('<cword>'), '\').'\>'
    augroup end
    setl updatetime=500
    echo 'Highlight current word: ON'
    return 1
  endif
endfunction

Comments

Around Wikia's network

Random Wiki