initial commit

.vim/autoload/xolox/misc/msg.vim

@@ -0,0 +1,129 @@
+" Functions to interact with the user.
+"
+" Author: Peter Odding <peter@peterodding.com>
+" Last Change: March 15, 2015
+" URL: http://peterodding.com/code/vim/misc/
+
+if !exists('g:xolox_message_buffer')
+  " For when I lose my :messages history :-\
+  let g:xolox_message_buffer = 100
+endif
+
+if !exists('g:xolox_messages')
+  let g:xolox_messages = []
+endif
+
+function! xolox#misc#msg#info(...) " {{{1
+  " Show a formatted informational message to the user.
+  "
+  " This function has the same argument handling as Vim's [printf()] []
+  " function with one notable difference: Any arguments which are not numbers
+  " or strings are coerced to strings using Vim's [string()] [] function.
+  "
+  " In the case of `xolox#misc#msg#info()`, automatic string coercion simply
+  " makes the function a bit easier to use.
+  "
+  " The messages emitted by this function have no highlighting. Previously
+  " these messages were highlighted using the [Title group] [hl-title], but it
+  " was pointed out in [pull request 16] [pr-16] that this group shouldn't be
+  " used for informational messages because it is meant for titles and because
+  " of this some color schemes use colors that stand out quite a bit, causing
+  " the informational messages to look like errors.
+  "
+  " [hl-title]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#hl-Title
+  " [pr-16]: https://github.com/xolox/vim-misc/pull/16
+  " [printf()]: http://vimdoc.sourceforge.net/htmldoc/eval.html#printf()
+  " [string()]: http://vimdoc.sourceforge.net/htmldoc/eval.html#string()
+  call s:show_message('None', a:000)
+endfunction
+
+function! xolox#misc#msg#warn(...) " {{{1
+  " Show a formatted warning message to the user.
+  "
+  " This function has the same argument handling as the
+  " `xolox#misc#msg#info()` function.
+  call s:show_message('WarningMsg', a:000)
+endfunction
+
+function! xolox#misc#msg#debug(...) " {{{1
+  " Show a formatted debugging message to the user, *if the user has enabled
+  " increased verbosity by setting Vim's ['verbose'] [] option to one
+  " (1) or higher*.
+  "
+  " This function has the same argument handling as the
+  " `xolox#misc#msg#info()` function.
+  "
+  " In the case of `xolox#misc#msg#debug()`, automatic string coercion
+  " provides lazy evaluation in the sense that complex data structures are
+  " only converted to strings when the user has enabled increased verbosity.
+  "
+  " ['verbose']: http://vimdoc.sourceforge.net/htmldoc/options.html#'verbose'
+  if &vbs >= 1
+    call s:show_message('Question', a:000)
+  endif
+endfunction
+
+function! s:show_message(hlgroup, args) " {{{1
+  " The implementation of info() and warn().
+  let nargs = len(a:args)
+  if nargs == 1
+    let message = a:args[0]
+  elseif nargs >= 2
+    let args = map(copy(a:args), 's:coerce_argument(v:val)')
+    let message = call('printf', args)
+  endif
+  if exists('message')
+    try
+      " Temporarily disable Vim's |hit-enter| prompt and mode display.
+      if !exists('s:more_save')
+        let s:more_save = &more
+        let s:ruler_save = &ruler
+        let s:smd_save = &showmode
+      endif
+      set nomore noshowmode
+      if winnr('$') == 1 | set noruler | endif
+      augroup PluginXoloxHideMode
+        autocmd! CursorHold,CursorHoldI * call s:clear_message()
+      augroup END
+      execute 'echohl' a:hlgroup
+      " Redraw to avoid the |hit-enter| prompt. We use :silent to avoid issues
+      " like this one: https://github.com/xolox/vim-easytags/issues/69.
+      silent! redraw
+      for line in split(message, "\n")
+        echomsg line
+      endfor
+      if g:xolox_message_buffer > 0
+        call add(g:xolox_messages, message)
+        if len(g:xolox_messages) > g:xolox_message_buffer
+          call remove(g:xolox_messages, 0)
+        endif
+      endif
+    finally
+      " Always clear message highlighting, even when interrupted by Ctrl-C.
+      echohl none
+    endtry
+  endif
+endfunction
+
+function! s:coerce_argument(value) " {{{1
+  " Callback to coerce printf() arguments into strings.
+  let value_type = type(a:value)
+  if value_type != type(0) && value_type != type('')
+    return string(a:value)
+  else
+    return a:value
+  endif
+endfunction
+
+function! s:clear_message() " {{{1
+  " Callback to clear message after some time has passed.
+  echo ''
+  let &more = s:more_save
+  let &showmode = s:smd_save
+  let &ruler = s:ruler_save
+  unlet s:more_save s:ruler_save s:smd_save
+  autocmd! PluginXoloxHideMode
+  augroup! PluginXoloxHideMode
+endfunction
+
+" vim: ts=2 sw=2 et