1 " vim600: set foldmethod=marker:
3 " SVK extension for VCSCommand.
5 " Version: VCS development
6 " Maintainer: Bob Hiestand <bob.hiestand@gmail.com>
8 " Copyright (c) 2007 Bob Hiestand
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:
17 " The above copyright notice and this permission notice shall be included in
18 " all copies or substantial portions of the Software.
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
28 " Section: Documentation {{{1
30 " Options documentation: {{{2
33 " This variable specifies the SVK executable. If not set, it defaults to
34 " 'svk' executed from the user's executable path.
36 " Section: Plugin header {{{1
38 if exists('VCSCommandDisableAll')
43 echohl WarningMsg|echomsg 'VCSCommand requires at least VIM 7.0'|echohl None
47 runtime plugin/vcscommand.vim
49 if !executable(VCSCommandGetOption('VCSCommandSVKExec', 'svk'))
50 " SVK is not installed
57 " Section: Variable initialization {{{1
59 let s:svkFunctions = {}
61 " Section: Utility functions {{{1
63 " Function: s:Executable() {{{2
64 " Returns the executable used to invoke SVK suitable for use in a shell
66 function! s:Executable()
67 return shellescape(VCSCommandGetOption('VCSCommandSVKExec', 'svk'))
70 " Function: s:DoCommand(cmd, cmdName, statusText, options) {{{2
71 " Wrapper to VCSCommandDoCommand to add the name of the SVK executable to the
73 function! s:DoCommand(cmd, cmdName, statusText, options)
74 if VCSCommandGetVCSType(expand('%')) == 'SVK'
75 let fullCmd = s:Executable() . ' ' . a:cmd
76 return VCSCommandDoCommand(fullCmd, a:cmdName, a:statusText, a:options)
78 throw 'SVK VCSCommand plugin called on non-SVK item.'
82 " Section: VCS function implementations {{{1
84 " Function: s:svkFunctions.Identify(buffer) {{{2
85 function! s:svkFunctions.Identify(buffer)
86 let fileName = resolve(bufname(a:buffer))
87 if isdirectory(fileName)
88 let directoryName = fileName
90 let directoryName = fnamemodify(fileName, ':p:h')
92 let statusText = s:VCSCommandUtility.system(s:Executable() . ' info -- "' . directoryName . '"', "no")
100 " Function: s:svkFunctions.Add() {{{2
101 function! s:svkFunctions.Add(argList)
102 return s:DoCommand(join(['add'] + a:argList, ' '), 'add', join(a:argList, ' '), {})
105 " Function: s:svkFunctions.Annotate(argList) {{{2
106 function! s:svkFunctions.Annotate(argList)
107 if len(a:argList) == 0
108 if &filetype == 'SVKannotate'
109 " Perform annotation of the version indicated by the current line.
110 let caption = matchstr(getline('.'),'\v^\s+\zs\d+')
111 let options = ' -r' . caption
116 elseif len(a:argList) == 1 && a:argList[0] !~ '^-'
117 let caption = a:argList[0]
118 let options = ' -r' . caption
120 let caption = join(a:argList, ' ')
121 let options = ' ' . caption
124 let resultBuffer = s:DoCommand('blame' . options, 'annotate', caption, {})
131 " Function: s:svkFunctions.Commit(argList) {{{2
132 function! s:svkFunctions.Commit(argList)
133 let resultBuffer = s:DoCommand('commit -F "' . a:argList[0] . '"', 'commit', '', {})
135 echomsg 'No commit needed.'
139 " Function: s:svkFunctions.Delete() {{{2
140 function! s:svkFunctions.Delete(argList)
141 return s:DoCommand(join(['delete'] + a:argList, ' '), 'delete', join(a:argList, ' '), {})
144 " Function: s:svkFunctions.Diff(argList) {{{2
145 function! s:svkFunctions.Diff(argList)
146 if len(a:argList) == 0
149 elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
150 let revOptions = ['-r' . join(a:argList, ':')]
151 let caption = '(' . a:argList[0] . ' : ' . get(a:argList, 1, 'current') . ')'
154 let caption = join(a:argList, ' ')
155 let revOptions = a:argList
158 return s:DoCommand(join(['diff'] + revOptions), 'diff', caption, {})
161 " Function: s:svkFunctions.GetBufferInfo() {{{2
162 " Provides version control details for the current file. Current version
163 " number and current repository version number are required to be returned by
164 " the vcscommand plugin.
165 " Returns: List of results: [revision, repository]
167 function! s:svkFunctions.GetBufferInfo()
168 let originalBuffer = VCSCommandGetOriginalBuffer(bufnr('%'))
169 let fileName = resolve(bufname(originalBuffer))
170 let statusText = s:VCSCommandUtility.system(s:Executable() . ' status -v -- "' . fileName . '"')
175 " File not under SVK control.
176 if statusText =~ '^?'
180 let [flags, revision, repository] = matchlist(statusText, '^\(.\{3}\)\s\+\(\S\+\)\s\+\(\S\+\)\s\+\(\S\+\)\s')[1:3]
185 return ['New', 'New']
187 return [revision, repository]
191 " Function: s:svkFunctions.Info(argList) {{{2
192 function! s:svkFunctions.Info(argList)
193 return s:DoCommand(join(['info'] + a:argList, ' '), 'info', join(a:argList, ' '), {})
196 " Function: s:svkFunctions.Lock(argList) {{{2
197 function! s:svkFunctions.Lock(argList)
198 return s:DoCommand(join(['lock'] + a:argList, ' '), 'lock', join(a:argList, ' '), {})
201 " Function: s:svkFunctions.Log() {{{2
202 function! s:svkFunctions.Log(argList)
203 if len(a:argList) == 0
206 elseif len(a:argList) <= 2 && match(a:argList, '^-') == -1
207 let options = ['-r' . join(a:argList, ':')]
208 let caption = options[0]
211 let options = a:argList
212 let caption = join(a:argList, ' ')
215 let resultBuffer = s:DoCommand(join(['log', '-v'] + options), 'log', caption, {})
219 " Function: s:svkFunctions.Revert(argList) {{{2
220 function! s:svkFunctions.Revert(argList)
221 return s:DoCommand('revert', 'revert', '', {})
224 " Function: s:svkFunctions.Review(argList) {{{2
225 function! s:svkFunctions.Review(argList)
226 if len(a:argList) == 0
227 let versiontag = '(current)'
228 let versionOption = ''
230 let versiontag = a:argList[0]
231 let versionOption = ' -r ' . versiontag . ' '
234 return s:DoCommand('cat' . versionOption, 'review', versiontag, {})
237 " Function: s:svkFunctions.Status(argList) {{{2
238 function! s:svkFunctions.Status(argList)
240 if len(a:argList) == 0
241 let options = a:argList
243 return s:DoCommand(join(['status'] + options, ' '), 'status', join(options, ' '), {})
246 " Function: s:svkFunctions.Unlock(argList) {{{2
247 function! s:svkFunctions.Unlock(argList)
248 return s:DoCommand(join(['unlock'] + a:argList, ' '), 'unlock', join(a:argList, ' '), {})
250 " Function: s:svkFunctions.Update(argList) {{{2
251 function! s:svkFunctions.Update(argList)
252 return s:DoCommand('update', 'update', '', {})
255 " Section: Plugin Registration {{{1
256 let s:VCSCommandUtility = VCSCommandRegisterModule('SVK', expand('<sfile>'), s:svkFunctions, [])
258 let &cpo = s:save_cpo