plugin/vcsbzr.vim

   1 " vim600: set foldmethod=marker:
   2 "
   3 " BZR 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 " VCSCommandBZRExec
  33 "   This variable specifies the BZR executable.  If not set, it defaults to
  34 "   'bzr' executed from the user's executable path.
  35
  36 " Section: Plugin header {{{1
  37
  38 if exists('VCSCommandDisableAll')
  39         finish
  40 endif
  41
  42 if v:version < 700
  43   echohl WarningMsg|echomsg 'VCSCommand requires at least VIM 7.0'|echohl None
  44   finish
  45 endif
  46
  47 runtime plugin/vcscommand.vim
  48
  49 if !executable(VCSCommandGetOption('VCSCommandBZRExec', 'bzr'))
  50   " BZR is not installed
  51   finish
  52 endif
  53
  54 let s:save_cpo=&cpo
  55 set cpo&vim
  56
  57 " Section: Variable initialization {{{1
  58
  59 let s:bzrFunctions = {}
  60
  61 " Section: Utility functions {{{1
  62
  63 " Function: s:Executable() {{{2
  64 " Returns the executable used to invoke bzr suitable for use in a shell
  65 " command.
  66 function! s:Executable()
  67         return shellescape(VCSCommandGetOption('VCSCommandBZRExec', 'bzr'))
  68 endfunction
  69
  70 " Function: s:DoCommand(cmd, cmdName, statusText) {{{2
  71 " Wrapper to VCSCommandDoCommand to add the name of the BZR executable to the
  72 " command argument.
  73 function! s:DoCommand(cmd, cmdName, statusText, options)
  74   if VCSCommandGetVCSType(expand('%')) == 'BZR'
  75     let fullCmd = s:Executable() . ' ' . a:cmd
  76     return VCSCommandDoCommand(fullCmd, a:cmdName, a:statusText, a:options)
  77   else
  78     throw 'BZR VCSCommand plugin called on non-BZR item.'
  79   endif
  80 endfunction
  81
  82 " Section: VCS function implementations {{{1
  83
  84 " Function: s:bzrFunctions.Identify(buffer) {{{2
  85 function! s:bzrFunctions.Identify(buffer)
  86   let fileName = resolve(bufname(a:buffer))
  87   let statusText = s:VCSCommandUtility.system(s:Executable() . ' info -- "' . fileName . '"')
  88   if(v:shell_error)
  89     return 0
  90   else
  91     return 1
  92   endif
  93 endfunction
  94
  95 " Function: s:bzrFunctions.Add() {{{2
  96 function! s:bzrFunctions.Add(argList)
  97   return s:DoCommand(join(['add'] + a:argList, ' '), 'add', join(a:argList, ' '), {})
  98 endfunction
  99
 100 " Function: s:bzrFunctions.Annotate(argList) {{{2
 101 function! s:bzrFunctions.Annotate(argList)
 102   if len(a:argList) == 0
 103     if &filetype == 'BZRannotate'
 104       " Perform annotation of the version indicated by the current line.
 105       let caption = matchstr(getline('.'),'\v^\s+\zs\d+')
 106       let options = ' -r' . caption
 107     else
 108       let caption = ''
 109       let options = ''
 110     endif
 111   elseif len(a:argList) == 1 && a:argList[0] !~ '^-'
 112     let caption = a:argList[0]
 113     let options = ' -r' . caption
 114   else
 115     let caption = join(a:argList, ' ')
 116     let options = ' ' . caption
 117   endif
 118
 119   let resultBuffer = s:DoCommand('blame' . options, 'annotate', caption, {})
 120   if resultBuffer > 0
 121     normal 1G2dd
 122   endif
 123   return resultBuffer
 124 endfunction
 125
 126 " Function: s:bzrFunctions.Commit(argList) {{{2
 127 function! s:bzrFunctions.Commit(argList)
 128   let resultBuffer = s:DoCommand('commit -F "' . a:argList[0] . '"', 'commit', '', {})
 129   if resultBuffer == 0
 130     echomsg 'No commit needed.'
 131   endif
 132 endfunction
 133
 134 " Function: s:bzrFunctions.Delete() {{{2
 135 function! s:bzrFunctions.Delete(argList)
 136   return s:DoCommand(join(['rm'] + a:argList, ' '), 'rm', join(a:argList, ' '), {})
 137 endfunction
 138
 139 " Function: s:bzrFunctions.Diff(argList) {{{2
 140 function! s:bzrFunctions.Diff(argList)
 141   if len(a:argList) == 0
 142     let revOptions = []
 143     let caption = ''
 144   elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
 145     let revOptions = ['-r' . join(a:argList, '..')]
 146     let caption = '(' . a:argList[0] . ' : ' . get(a:argList, 1, 'current') . ')'
 147   else
 148     " Pass-through
 149     let caption = join(a:argList, ' ')
 150     let revOptions = a:argList
 151   endif
 152
 153   return s:DoCommand(join(['diff'] + revOptions), 'diff', caption, {'allowNonZeroExit': 1})
 154 endfunction
 155
 156 " Function: s:bzrFunctions.GetBufferInfo() {{{2
 157 " Provides version control details for the current file.  Current version
 158 " number and current repository version number are required to be returned by
 159 " the vcscommand plugin.
 160 " Returns: List of results:  [revision, repository]
 161
 162 function! s:bzrFunctions.GetBufferInfo()
 163   let originalBuffer = VCSCommandGetOriginalBuffer(bufnr('%'))
 164   let fileName = resolve(bufname(originalBuffer))
 165   let statusText = s:VCSCommandUtility.system(s:Executable() . ' status -S -- "' . fileName . '"')
 166   let revision = s:VCSCommandUtility.system(s:Executable() . ' revno -- "' . fileName . '"')
 167   if(v:shell_error)
 168     return []
 169   endif
 170
 171   " File not under BZR control.
 172   if statusText =~ '^?'
 173     return ['Unknown']
 174   endif
 175
 176   let [flags, repository] = matchlist(statusText, '^\(.\{3}\)\s\+\(\S\+\)')[1:2]
 177   if revision == ''
 178     " Error
 179     return ['Unknown']
 180   elseif flags =~ '^A'
 181     return ['New', 'New']
 182   else
 183     return [revision, repository]
 184   endif
 185 endfunction
 186
 187 " Function: s:bzrFunctions.Info(argList) {{{2
 188 function! s:bzrFunctions.Info(argList)
 189   return s:DoCommand(join(['version-info'] + a:argList, ' '), 'version-info', join(a:argList, ' '), {})
 190 endfunction
 191
 192 " Function: s:bzrFunctions.Lock(argList) {{{2
 193 function! s:bzrFunctions.Lock(argList)
 194   echomsg 'bzr lock is not necessary'
 195 endfunction
 196
 197 " Function: s:bzrFunctions.Log() {{{2
 198 function! s:bzrFunctions.Log(argList)
 199   if len(a:argList) == 0
 200     let options = []
 201     let caption = ''
 202   elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
 203     let options = ['-r' . join(a:argList, ':')]
 204     let caption = options[0]
 205   else
 206     " Pass-through
 207     let options = a:argList
 208     let caption = join(a:argList, ' ')
 209   endif
 210
 211   let resultBuffer = s:DoCommand(join(['log', '-v'] + options), 'log', caption, {})
 212   return resultBuffer
 213 endfunction
 214
 215 " Function: s:bzrFunctions.Revert(argList) {{{2
 216 function! s:bzrFunctions.Revert(argList)
 217   return s:DoCommand('revert', 'revert', '', {})
 218 endfunction
 219
 220 " Function: s:bzrFunctions.Review(argList) {{{2
 221 function! s:bzrFunctions.Review(argList)
 222   if len(a:argList) == 0
 223     let versiontag = '(current)'
 224     let versionOption = ''
 225   else
 226     let versiontag = a:argList[0]
 227     let versionOption = ' -r ' . versiontag . ' '
 228   endif
 229
 230   return s:DoCommand('cat' . versionOption, 'review', versiontag, {})
 231 endfunction
 232
 233 " Function: s:bzrFunctions.Status(argList) {{{2
 234 function! s:bzrFunctions.Status(argList)
 235   let options = ['-S']
 236   if len(a:argList) == 0
 237     let options = a:argList
 238   endif
 239   return s:DoCommand(join(['status'] + options, ' '), 'status', join(options, ' '), {})
 240 endfunction
 241
 242 " Function: s:bzrFunctions.Unlock(argList) {{{2
 243 function! s:bzrFunctions.Unlock(argList)
 244   echomsg 'bzr unlock is not necessary'
 245 endfunction
 246 " Function: s:bzrFunctions.Update(argList) {{{2
 247 function! s:bzrFunctions.Update(argList)
 248   return s:DoCommand('update', 'update', '', {})
 249 endfunction
 250
 251 " Annotate setting {{{2
 252 let s:bzrFunctions.AnnotateSplitRegex = '^[^|]\+ | '
 253
 254 " Section: Plugin Registration {{{1
 255 let s:VCSCommandUtility = VCSCommandRegisterModule('BZR', expand('<sfile>'), s:bzrFunctions, [])
 256
 257 let &cpo = s:save_cpo