mercurial-crew-with-dirclash: contrib/vim/hgcommand.vim comparison

comparison contrib/vim/hgcommand.vim @ 2733:0b7206a65325

hgcommand.vim: cleanup of doc self-install code

author	Christian Ebert <blacktrash@gmx.net>
date	Sat, 29 Jul 2006 01:58:12 +0200
parents	8dadff054acf
children	19436facb073

comparison

equal deleted inserted replaced

-:42a02b5773d4
+:0b7206a65325
 else
 " The file is tracked, we can try to get is revision number
 let hgCommand = s:HGGetOption("HGCommandHGExec", "hg") . " parents -b  "
 let statustext=system(hgCommand)
 if(v:shell_error)
-	  return ""
+return ""
 endif
 let revision=substitute(statustext, '^changeset:\s*\(\d\+\):.*\_$\_.*$', '\1', "")
 if a:branchVar != "" && match(statustext, '^\_.*\_^branch:') >= 0
-	let branch=substitute(statustext, '^\_.*\_^branch:\s*\(\S\+\)\n\_.*$', '\1', "")
+let branch=substitute(statustext, '^\_.*\_^branch:\s*\(\S\+\)\n\_.*$', '\1', "")
-	let returnExpression=returnExpression . " | let " . a:branchVar . "='" . branch . "'"
+let returnExpression=returnExpression . " | let " . a:branchVar . "='" . branch . "'"
 endif
 endif
 if (exists('revision'))
 let returnExpression = "let " . a:revisionVar . "='" . revision . "' " . returnExpression
 endif
 "              will be replaced with this string with 'v' prefix.
 " Return:
 "   1 if new document installed, 0 otherwise.
 " Note: Cleaned and generalized by guo-peng Wen
 "'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+" Helper function to make mkdir as portable as possible
+function! s:HGFlexiMkdir(dir)
+if exists("*mkdir") " we can use Vim's own mkdir()
+call mkdir(a:dir)
+elseif !exists("+shellslash")
+call system('mkdir -p "'.a:dir.'"')
+else " M$
+let l:ssl = &shellslash
+try
+set shellslash
+call system('mkdir "'.a:dir.'"')
+finally
+let &shellslash = l:ssl
+endtry
+endif
+endfunction
 function! s:HGInstallDocumentation(full_name, revision)
-" Name of the document path based on the system we use:
+" Figure out document path based on full name of this script:
-if (has("unix"))
+let l:vim_plugin_path = fnamemodify(a:full_name, ':h')
-" On UNIX like system, using forward slash:
+let l:vim_doc_path  = fnamemodify(a:full_name, ':h:h') . "/doc"
-let l:slash_char = '/'
+if filewritable(l:vim_doc_path) != 2
-let l:mkdir_cmd  = ':silent !mkdir -p '
+echomsg "hgcommand: Trying to update docs at: " . l:vim_doc_path
-else
+silent! call <SID>HGFlexiMkdir(l:vim_doc_path)
-" On M$ system, use backslash. Also mkdir syntax is different.
+if filewritable(l:vim_doc_path) != 2
-" This should only work on W2K and up.
+" Try first item in 'runtimepath':
-let l:slash_char = '\'
+let l:vimfiles = matchstr(&runtimepath, '[^,]\+\ze,')
-let l:mkdir_cmd  = ':silent !mkdir '
+let l:vim_doc_path = l:vimfiles . "/doc"
-endif
+if filewritable(l:vim_doc_path) != 2
+echomsg "hgcommand: Trying to update docs at: " . l:vim_doc_path
-let l:doc_path = l:slash_char . 'doc'
+silent! call <SID>HGFlexiMkdir(l:vim_doc_path)
-let l:doc_home = l:slash_char . '.vim' . l:slash_char . 'doc'
+if filewritable(l:vim_doc_path) != 2
+" Put a warning:
-" Figure out document path based on full name of this script:
+echomsg "Unable to open documentation directory"
-let l:vim_plugin_path = fnamemodify(a:full_name, ':h')
+echomsg " type `:help add-local-help' for more information."
-let l:vim_doc_path    = fnamemodify(a:full_name, ':h:h') . l:doc_path
+return 0
-if (!(filewritable(l:vim_doc_path) == 2))
-echomsg "Doc path: " . l:vim_doc_path
-execute l:mkdir_cmd . '"' . l:vim_doc_path . '"'
-if (!(filewritable(l:vim_doc_path) == 2))
-" Try a default configuration in user home:
-let l:vim_doc_path = expand("~") . l:doc_home
-if (!(filewritable(l:vim_doc_path) == 2))
-execute l:mkdir_cmd . '"' . l:vim_doc_path . '"'
-if (!(filewritable(l:vim_doc_path) == 2))
-" Put a warning:
-echomsg "Unable to open documentation directory"
-echomsg " type :help add-local-help for more informations."
-return 0
-endif
-endif
 endif
 endif
+endif
-" Exit if we have problem to access the document directory:
+endif
-if (!isdirectory(l:vim_plugin_path)
-\ || !isdirectory(l:vim_doc_path)
+" Full name of script and documentation file:
-\ || filewritable(l:vim_doc_path) != 2)
+let l:script_name = fnamemodify(a:full_name, ':t')
-return 0
+let l:doc_name  = fnamemodify(a:full_name, ':t:r') . '.txt'
-endif
+let l:doc_file  = l:vim_doc_path . "/" . l:doc_name
-" Full name of script and documentation file:
+" Bail out if document file is still up to date:
-let l:script_name = fnamemodify(a:full_name, ':t')
+if filereadable(l:doc_file)  && getftime(a:full_name) < getftime(l:doc_file)
-let l:doc_name    = fnamemodify(a:full_name, ':t:r') . '.txt'
+return 0
-let l:plugin_file = l:vim_plugin_path . l:slash_char . l:script_name
+endif
-let l:doc_file    = l:vim_doc_path    . l:slash_char . l:doc_name
+" Create a new buffer & read in the plugin file (me):
-" Bail out if document file is still up to date:
+setl nomodeline
-if (filereadable(l:doc_file)  &&
+1 new!
-\ getftime(l:plugin_file) < getftime(l:doc_file))
+setl noswapfile modifiable
-return 0
+sil exe 'read ' . a:full_name
-endif
+setl modeline
-" Prepare window position restoring command:
+let l:buf = bufnr("%")
-if (strlen(@%))
-let l:go_back = 'b ' . bufnr("%")
+norm zR
-else
+norm gg
-let l:go_back = 'enew!'
-endif
+" Delete from first line to a line starts with
+" === START_DOC
-" Create a new buffer & read in the plugin file (me):
+sil 1,/^=\{3,}\s\+START_DOC\C/ d
-setl nomodeline
-exe 'enew!'
+" Delete from a line starts with
-exe 'r ' . l:plugin_file
+" === END_DOC
+" to the end of the documents:
-setl modeline
+sil /^=\{3,}\s\+END_DOC\C/,$ d
-let l:buf = bufnr("%")
-setl noswapfile modifiable
+" Remove fold marks:
+sil %s/{\{3}[1-9]/  /e
-norm zR
-norm gg
+" Add modeline for help doc: the modeline string is mangled intentionally
+" to avoid it be recognized by VIM:
-" Delete from first line to a line starts with
+call append(line('$'), '')
-" === START_DOC
+call append(line('$'), ' v' . 'im:tw=78:ts=8:ft=help:norl:')
-1,/^=\{3,}\s\+START_DOC\C/ d
+" Replace revision:
-" Delete from a line starts with
+sil exe "normal :1s/#version#/ v" . a:revision . "/\<CR>"
-" === END_DOC
-" to the end of the documents:
+" Save the help document and wipe out buffer:
-/^=\{3,}\s\+END_DOC\C/,$ d
+sil exe 'wq! ' . l:doc_file . ' | bw ' . l:buf
-" Remove fold marks:
+" Build help tags:
-%s/{\{3}[1-9]/    /
+sil exe 'helptags ' . l:vim_doc_path
-" Add modeline for help doc: the modeline string is mangled intentionally
+return 1
-" to avoid it be recognized by VIM:
-call append(line('$'), '')
-call append(line('$'), ' v' . 'im:tw=78:ts=8:ft=help:norl:')
-" Replace revision:
-exe "normal :1s/#version#/ v" . a:revision . "/\<CR>"
-" Save the help document:
-exe 'w! ' . l:doc_file
-exe l:go_back
-exe 'bw ' . l:buf
-" Build help tags:
-exe 'helptags ' . l:vim_doc_path
-return 1
 endfunction
 " Section: Public functions {{{1
 " Function: HGGetRevision() {{{2
 endif
 " Section: Doc installation {{{1
 "
 let s:revision="0.1"
-silent! let s:install_status =
+if s:HGInstallDocumentation(escape(expand('<sfile>:p'), ' '), s:revision)
-\ s:HGInstallDocumentation(expand('<sfile>:p'), s:revision)
+echom expand('<sfile>:t:r') . ' v' . s:revision .
-if (s:install_status == 1)
+\ ': Help-documentation installed.'
-echom expand("<sfile>:t:r") . ' v' . s:revision .
+endif
-		\ ': Help-documentation installed.'
-endif
+" delete one-time vars and functions
+delfunction <SID>HGInstallDocumentation
+delfunction <SID>HGFlexiMkdir
+unlet s:revision
 " Section: Plugin completion {{{1
 let loaded_hgcommand=2
 that it attempts to set two buffer variables ('HGRevision' and 'HGBranch')
 upon entry into a buffer.  This is rather slow because it means that 'hg
 status' will be invoked at each entry into a buffer (during the |BufEnter|
 autocommand).
-This mode is enablmed by default.  In order to disable it, set the
+This mode is enabled by default.  In order to disable it, set the
 |HGCommandEnableBufferSetup| variable to a false (zero) value.  Enabling
 this mode simply provides the buffer variables mentioned above.  The user
 must explicitly include those in the |'statusline'| option if they are to
 appear in the status line (but see |hgcommand-statusline| for a simple way
 to do that).

Mercurial > hg > mercurial-crew-with-dirclash

comparison contrib/vim/hgcommand.vim @ 2733:0b7206a65325