plugin/vcssvn.vim

   1 " vim600: set foldmethod=marker:
   2 "
   3 " SVN extension for VCSCommand.
   4 "
   5 " Version:       VCS development
   6 " Maintainer:    Bob Hiestand <bob.hiestand@gmail.com>
   7 " License:
   8 " Copyright (c) 2007 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 " VCSCommandSVNExec
  33 "   This variable specifies the SVN executable.  If not set, it defaults to
  34 "   'svn' executed from the user's executable path.
  35 "
  36 " VCSCommandSVNDiffExt
  37 "   This variable, if set, sets the external diff program used by Subversion.
  38 "
  39 " VCSCommandSVNDiffOpt
  40 "   This variable, if set, determines the options passed to the svn 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('VCSCommandSVNExec', 'svn'))
  57         " SVN 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:svnFunctions = {}
  67
  68 " Section: Utility functions {{{1
  69
  70 " Function: s:Executable() {{{2
  71 " Returns the executable used to invoke git suitable for use in a shell
  72 " command.
  73 function! s:Executable()
  74         return shellescape(VCSCommandGetOption('VCSCommandSVNExec', 'svn'))
  75 endfunction
  76
  77 " Function: s:DoCommand(cmd, cmdName, statusText, options) {{{2
  78 " Wrapper to VCSCommandDoCommand to add the name of the SVN executable to the
  79 " command argument.
  80 function! s:DoCommand(cmd, cmdName, statusText, options)
  81         if VCSCommandGetVCSType(expand('%')) == 'SVN'
  82                 let fullCmd = s:Executable() . ' ' . a:cmd
  83                 return VCSCommandDoCommand(fullCmd, a:cmdName, a:statusText, a:options)
  84         else
  85                 throw 'SVN VCSCommand plugin called on non-SVN item.'
  86         endif
  87 endfunction
  88
  89 " Section: VCS function implementations {{{1
  90
  91 " Function: s:svnFunctions.Identify(buffer) {{{2
  92 function! s:svnFunctions.Identify(buffer)
  93         let fileName = resolve(bufname(a:buffer))
  94         if isdirectory(fileName)
  95                 let directoryName = fileName
  96         else
  97                 let directoryName = fnamemodify(fileName, ':h')
  98         endif
  99         if strlen(directoryName) > 0
 100                 let svnDir = directoryName . '/.svn'
 101         else
 102                 let svnDir = '.svn'
 103         endif
 104         if isdirectory(svnDir)
 105                 return 1
 106         else
 107                 return 0
 108         endif
 109 endfunction
 110
 111 " Function: s:svnFunctions.Add() {{{2
 112 function! s:svnFunctions.Add(argList)
 113         return s:DoCommand(join(['add'] + a:argList, ' '), 'add', join(a:argList, ' '), {})
 114 endfunction
 115
 116 " Function: s:svnFunctions.Annotate(argList) {{{2
 117 function! s:svnFunctions.Annotate(argList)
 118         if len(a:argList) == 0
 119                 if &filetype == 'SVNannotate'
 120                         " Perform annotation of the version indicated by the current line.
 121                         let caption = matchstr(getline('.'),'\v^\s+\zs\d+')
 122                         let options = ' -r' . caption
 123                 else
 124                         let caption = ''
 125                         let options = ''
 126                 endif
 127         elseif len(a:argList) == 1 && a:argList[0] !~ '^-'
 128                 let caption = a:argList[0]
 129                 let options = ' -r' . caption
 130         else
 131                 let caption = join(a:argList, ' ')
 132                 let options = ' ' . caption
 133         endif
 134
 135         return s:DoCommand('blame --non-interactive' . options, 'annotate', caption, {})
 136 endfunction
 137
 138 " Function: s:svnFunctions.Commit(argList) {{{2
 139 function! s:svnFunctions.Commit(argList)
 140         let resultBuffer = s:DoCommand('commit --non-interactive -F "' . a:argList[0] . '"', 'commit', '', {})
 141         if resultBuffer == 0
 142                 echomsg 'No commit needed.'
 143         endif
 144 endfunction
 145
 146 " Function: s:svnFunctions.Delete() {{{2
 147 function! s:svnFunctions.Delete(argList)
 148         return s:DoCommand(join(['delete --non-interactive'] + a:argList, ' '), 'delete', join(a:argList, ' '), {})
 149 endfunction
 150
 151 " Function: s:svnFunctions.Diff(argList) {{{2
 152 function! s:svnFunctions.Diff(argList)
 153         if len(a:argList) == 0
 154                 let revOptions = []
 155                 let caption = ''
 156         elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
 157                 let revOptions = ['-r' . join(a:argList, ':')]
 158                 let caption = '(' . a:argList[0] . ' : ' . get(a:argList, 1, 'current') . ')'
 159         else
 160                 " Pass-through
 161                 let caption = join(a:argList, ' ')
 162                 let revOptions = a:argList
 163         endif
 164
 165         let svnDiffExt = VCSCommandGetOption('VCSCommandSVNDiffExt', '')
 166         if svnDiffExt == ''
 167                 let diffExt = []
 168         else
 169                 let diffExt = ['--diff-cmd ' . svnDiffExt]
 170         endif
 171
 172         let svnDiffOpt = VCSCommandGetOption('VCSCommandSVNDiffOpt', '')
 173         if svnDiffOpt == ''
 174                 let diffOptions = []
 175         else
 176                 let diffOptions = ['-x -' . svnDiffOpt]
 177         endif
 178
 179         return s:DoCommand(join(['diff --non-interactive'] + diffExt + diffOptions + revOptions), 'diff', caption, {})
 180 endfunction
 181
 182 " Function: s:svnFunctions.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:svnFunctions.GetBufferInfo()
 189         let originalBuffer = VCSCommandGetOriginalBuffer(bufnr('%'))
 190         let fileName = bufname(originalBuffer)
 191         let statusText = s:VCSCommandUtility.system(s:Executable() . ' status --non-interactive -vu -- "' . fileName . '"')
 192         if(v:shell_error)
 193                 return []
 194         endif
 195
 196         " File not under SVN control.
 197         if statusText =~ '^?'
 198                 return ['Unknown']
 199         endif
 200
 201         let [flags, revision, repository] = matchlist(statusText, '^\(.\{9}\)\s*\(\d\+\)\s\+\(\d\+\)')[1:3]
 202         if revision == ''
 203                 " Error
 204                 return ['Unknown']
 205         elseif flags =~ '^A'
 206                 return ['New', 'New']
 207         elseif flags =~ '*'
 208                 return [revision, repository, '*']
 209         else
 210                 return [revision, repository]
 211         endif
 212 endfunction
 213
 214 " Function: s:svnFunctions.Info(argList) {{{2
 215 function! s:svnFunctions.Info(argList)
 216         return s:DoCommand(join(['info --non-interactive'] + a:argList, ' '), 'info', join(a:argList, ' '), {})
 217 endfunction
 218
 219 " Function: s:svnFunctions.Lock(argList) {{{2
 220 function! s:svnFunctions.Lock(argList)
 221         return s:DoCommand(join(['lock --non-interactive'] + a:argList, ' '), 'lock', join(a:argList, ' '), {})
 222 endfunction
 223
 224 " Function: s:svnFunctions.Log(argList) {{{2
 225 function! s:svnFunctions.Log(argList)
 226         if len(a:argList) == 0
 227                 let options = []
 228                 let caption = ''
 229         elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
 230                 let options = ['-r' . join(a:argList, ':')]
 231                 let caption = options[0]
 232         else
 233                 " Pass-through
 234                 let options = a:argList
 235                 let caption = join(a:argList, ' ')
 236         endif
 237
 238         let resultBuffer = s:DoCommand(join(['log --non-interactive', '-v'] + options), 'log', caption, {})
 239         return resultBuffer
 240 endfunction
 241
 242 " Function: s:svnFunctions.Revert(argList) {{{2
 243 function! s:svnFunctions.Revert(argList)
 244         return s:DoCommand('revert', 'revert', '', {})
 245 endfunction
 246
 247 " Function: s:svnFunctions.Review(argList) {{{2
 248 function! s:svnFunctions.Review(argList)
 249         if len(a:argList) == 0
 250                 let versiontag = '(current)'
 251                 let versionOption = ''
 252         else
 253                 let versiontag = a:argList[0]
 254                 let versionOption = ' -r ' . versiontag . ' '
 255         endif
 256
 257         return s:DoCommand('cat --non-interactive' . versionOption, 'review', versiontag, {})
 258 endfunction
 259
 260 " Function: s:svnFunctions.Status(argList) {{{2
 261 function! s:svnFunctions.Status(argList)
 262         let options = ['-u', '-v']
 263         if len(a:argList) == 0
 264                 let options = a:argList
 265         endif
 266         return s:DoCommand(join(['status --non-interactive'] + options, ' '), 'status', join(options, ' '), {})
 267 endfunction
 268
 269 " Function: s:svnFunctions.Unlock(argList) {{{2
 270 function! s:svnFunctions.Unlock(argList)
 271         return s:DoCommand(join(['unlock --non-interactive'] + a:argList, ' '), 'unlock', join(a:argList, ' '), {})
 272 endfunction
 273
 274 " Function: s:svnFunctions.Update(argList) {{{2
 275 function! s:svnFunctions.Update(argList)
 276         return s:DoCommand('update --non-interactive', 'update', '', {})
 277 endfunction
 278
 279 " Annotate setting {{{2
 280 let s:svnFunctions.AnnotateSplitRegex = '\s\+\S\+\s\+\S\+ '
 281
 282 " Section: Plugin Registration {{{1
 283 let s:VCSCommandUtility = VCSCommandRegisterModule('SVN', expand('<sfile>'), s:svnFunctions, [])
 284
 285 let &cpo = s:save_cpo