plugin/vcshg.vim

   1 " vim600: set foldmethod=marker:
   2 "
   3 " Mercurial extension for VCSCommand.
   4 "
   5 " Version:       VCS development
   6 " Maintainer:    Bob Hiestand <bob.hiestand@gmail.com>
   7 " License:
   8 " Copyright (c) 2009 Bob Hiestand
   9 "
  10 " Permission is hereby granted, free of charge, to any person obtaining a copy
  11 " of this software and associated documentation files (the "Software"), to
  12 " deal in the Software without restriction, including without limitation the
  13 " rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  14 " sell copies of the Software, and to permit persons to whom the Software is
  15 " furnished to do so, subject to the following conditions:
  16 "
  17 " The above copyright notice and this permission notice shall be included in
  18 " all copies or substantial portions of the Software.
  19 "
  20 " THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 " IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 " FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23 " AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24 " LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25 " FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  26 " IN THE SOFTWARE.
  27 "
  28 " Section: Documentation {{{1
  29 "
  30 " Options documentation: {{{2
  31 "
  32 " VCSCommandHGExec
  33 "   This variable specifies the mercurial executable.  If not set, it defaults
  34 "   to 'hg' executed from the user's executable path.
  35 "
  36 " VCSCommandHGDiffExt
  37 "   This variable, if set, sets the external diff program used by Subversion.
  38 "
  39 " VCSCommandHGDiffOpt
  40 "   This variable, if set, determines the options passed to the hg diff
  41 "   command (such as 'u', 'w', or 'b').
  42
  43 " Section: Plugin header {{{1
  44
  45 if exists('VCSCommandDisableAll')
  46         finish
  47 endif
  48
  49 if v:version < 700
  50         echohl WarningMsg|echomsg 'VCSCommand requires at least VIM 7.0'|echohl None
  51         finish
  52 endif
  53
  54 runtime plugin/vcscommand.vim
  55
  56 if !executable(VCSCommandGetOption('VCSCommandHGExec', 'hg'))
  57         " HG is not installed
  58         finish
  59 endif
  60
  61 let s:save_cpo=&cpo
  62 set cpo&vim
  63
  64 " Section: Variable initialization {{{1
  65
  66 let s:hgFunctions = {}
  67
  68 " Section: Utility functions {{{1
  69
  70 " Function: s:Executable() {{{2
  71 " Returns the executable used to invoke hg suitable for use in a shell
  72 " command.
  73 function! s:Executable()
  74         return shellescape(VCSCommandGetOption('VCSCommandHGExec', 'hg'))
  75 endfunction
  76
  77 " Function: s:DoCommand(cmd, cmdName, statusText, options) {{{2
  78 " Wrapper to VCSCommandDoCommand to add the name of the HG executable to the
  79 " command argument.
  80 function! s:DoCommand(cmd, cmdName, statusText, options)
  81         if VCSCommandGetVCSType(expand('%')) == 'HG'
  82                 let fullCmd = s:Executable() . ' ' . a:cmd
  83                 return VCSCommandDoCommand(fullCmd, a:cmdName, a:statusText, a:options)
  84         else
  85                 throw 'HG VCSCommand plugin called on non-HG item.'
  86         endif
  87 endfunction
  88
  89 " Section: VCS function implementations {{{1
  90
  91 " Function: s:hgFunctions.Identify(buffer) {{{2
  92 function! s:hgFunctions.Identify(buffer)
  93         let oldCwd = VCSCommandChangeToCurrentFileDir(resolve(bufname(a:buffer)))
  94         try
  95                 call s:VCSCommandUtility.system(s:Executable() . ' root')
  96                 if(v:shell_error)
  97                         return 0
  98                 else
  99                         return g:VCSCOMMAND_IDENTIFY_INEXACT
 100                 endif
 101         finally
 102                 call VCSCommandChdir(oldCwd)
 103         endtry
 104 endfunction
 105
 106 " Function: s:hgFunctions.Add() {{{2
 107 function! s:hgFunctions.Add(argList)
 108         return s:DoCommand(join(['add'] + a:argList, ' '), 'add', join(a:argList, ' '), {})
 109 endfunction
 110
 111 " Function: s:hgFunctions.Annotate(argList) {{{2
 112 function! s:hgFunctions.Annotate(argList)
 113         if len(a:argList) == 0
 114                 if &filetype == 'HGannotate'
 115                         " Perform annotation of the version indicated by the current line.
 116                         let caption = matchstr(getline('.'),'\v^\s+\zs\d+')
 117                         let options = ' -r' . caption
 118                 else
 119                         let caption = ''
 120                         let options = ' -un'
 121                 endif
 122         elseif len(a:argList) == 1 && a:argList[0] !~ '^-'
 123                 let caption = a:argList[0]
 124                 let options = ' -un -r' . caption
 125         else
 126                 let caption = join(a:argList, ' ')
 127                 let options = ' ' . caption
 128         endif
 129
 130         return s:DoCommand('blame' . options, 'annotate', caption, {})
 131 endfunction
 132
 133 " Function: s:hgFunctions.Commit(argList) {{{2
 134 function! s:hgFunctions.Commit(argList)
 135         let resultBuffer = s:DoCommand('commit -l "' . a:argList[0] . '"', 'commit', '', {})
 136         if resultBuffer == 0
 137                 echomsg 'No commit needed.'
 138         endif
 139 endfunction
 140
 141 " Function: s:hgFunctions.Delete() {{{2
 142 function! s:hgFunctions.Delete(argList)
 143         return s:DoCommand(join(['remove'] + a:argList, ' '), 'remove', join(a:argList, ' '), {})
 144 endfunction
 145
 146 " Function: s:hgFunctions.Diff(argList) {{{2
 147 function! s:hgFunctions.Diff(argList)
 148         if len(a:argList) == 0
 149                 let revOptions = []
 150                 let caption = ''
 151         elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
 152                 let revOptions = ['-r' . join(a:argList, ':')]
 153                 let caption = '(' . a:argList[0] . ' : ' . get(a:argList, 1, 'current') . ')'
 154         else
 155                 " Pass-through
 156                 let caption = join(a:argList, ' ')
 157                 let revOptions = a:argList
 158         endif
 159
 160         let hgDiffExt = VCSCommandGetOption('VCSCommandHGDiffExt', '')
 161         if hgDiffExt == ''
 162                 let diffExt = []
 163         else
 164                 let diffExt = ['--diff-cmd ' . hgDiffExt]
 165         endif
 166
 167         let hgDiffOpt = VCSCommandGetOption('VCSCommandHGDiffOpt', '')
 168         if hgDiffOpt == ''
 169                 let diffOptions = []
 170         else
 171                 let diffOptions = ['-x -' . hgDiffOpt]
 172         endif
 173
 174         return s:DoCommand(join(['diff'] + diffExt + diffOptions + revOptions), 'diff', caption, {})
 175 endfunction
 176
 177 " Function: s:hgFunctions.Info(argList) {{{2
 178 function! s:hgFunctions.Info(argList)
 179         return s:DoCommand(join(['log --limit 1'] + a:argList, ' '), 'log', join(a:argList, ' '), {})
 180 endfunction
 181
 182 " Function: s:hgFunctions.GetBufferInfo() {{{2
 183 " Provides version control details for the current file.  Current version
 184 " number and current repository version number are required to be returned by
 185 " the vcscommand plugin.
 186 " Returns: List of results:  [revision, repository, branch]
 187
 188 function! s:hgFunctions.GetBufferInfo()
 189         let originalBuffer = VCSCommandGetOriginalBuffer(bufnr('%'))
 190         let fileName = bufname(originalBuffer)
 191         let statusText = s:VCSCommandUtility.system(s:Executable() . ' status -- "' . fileName . '"')
 192         if(v:shell_error)
 193                 return []
 194         endif
 195
 196         " File not under HG control.
 197         if statusText =~ '^?'
 198                 return ['Unknown']
 199         endif
 200
 201         let parentsText = s:VCSCommandUtility.system(s:Executable() . ' parents -- "' . fileName . '"')
 202         let revision = matchlist(parentsText, '^changeset:\s\+\(\S\+\)\n')[1]
 203
 204         let logText = s:VCSCommandUtility.system(s:Executable() . ' log -- "' . fileName . '"')
 205         let repository = matchlist(logText, '^changeset:\s\+\(\S\+\)\n')[1]
 206
 207         if revision == ''
 208                 " Error
 209                 return ['Unknown']
 210         elseif statusText =~ '^A'
 211                 return ['New', 'New']
 212         else
 213                 return [revision, repository]
 214         endif
 215 endfunction
 216
 217 " Function: s:hgFunctions.Log(argList) {{{2
 218 function! s:hgFunctions.Log(argList)
 219         if len(a:argList) == 0
 220                 let options = []
 221                 let caption = ''
 222         elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
 223                 let options = ['-r' . join(a:argList, ':')]
 224                 let caption = options[0]
 225         else
 226                 " Pass-through
 227                 let options = a:argList
 228                 let caption = join(a:argList, ' ')
 229         endif
 230
 231         let resultBuffer = s:DoCommand(join(['log', '-v'] + options), 'log', caption, {})
 232         return resultBuffer
 233 endfunction
 234
 235 " Function: s:hgFunctions.Revert(argList) {{{2
 236 function! s:hgFunctions.Revert(argList)
 237         return s:DoCommand('revert', 'revert', '', {})
 238 endfunction
 239
 240 " Function: s:hgFunctions.Review(argList) {{{2
 241 function! s:hgFunctions.Review(argList)
 242         if len(a:argList) == 0
 243                 let versiontag = '(current)'
 244                 let versionOption = ''
 245         else
 246                 let versiontag = a:argList[0]
 247                 let versionOption = ' -r ' . versiontag . ' '
 248         endif
 249
 250         return s:DoCommand('cat' . versionOption, 'review', versiontag, {})
 251 endfunction
 252
 253 " Function: s:hgFunctions.Status(argList) {{{2
 254 function! s:hgFunctions.Status(argList)
 255         let options = ['-u', '-v']
 256         if len(a:argList) == 0
 257                 let options = a:argList
 258         endif
 259         return s:DoCommand(join(['status'] + options, ' '), 'status', join(options, ' '), {})
 260 endfunction
 261
 262 " Function: s:hgFunctions.Update(argList) {{{2
 263 function! s:hgFunctions.Update(argList)
 264         return s:DoCommand('update', 'update', '', {})
 265 endfunction
 266
 267 " Annotate setting {{{2
 268 let s:hgFunctions.AnnotateSplitRegex = '\d\+: '
 269
 270 " Section: Plugin Registration {{{1
 271 let s:VCSCommandUtility = VCSCommandRegisterModule('HG', expand('<sfile>'), s:hgFunctions, [])
 272
 273 let &cpo = s:save_cpo