" vim600: set foldmethod=marker:

"

" Vim plugin to assist in working with HG-controlled files.

"

" Last Change:   2006/02/22

" Version:       1.76

" Maintainer:    Mathieu Clabaut <mathieu.clabaut@gmail.com>

" License:       This file is placed in the public domain.

" Credits: {{{1

"                Bob Hiestand <bob.hiestand@gmail.com> for the fabulous

"                cvscommand.vim from which this script was directly created by

"                means of sed commands and minor tweaks.

"

" Provides functions to invoke various HG commands on the current file

" (either the current buffer, or, in the case of an directory buffer, the file

" on the current line).  The output of the commands is captured in a new

" scratch window.  For convenience, if the functions are invoked on a HG

" output window, the original file is used for the hg operation instead after

" the window is split.  This is primarily useful when running HGCommit and

" you need to see the changes made, so that HGDiff is usable and shows up in

" another window.

"

" Command documentation {{{2

"

" HGAdd           Performs "hg add" on the current file.

"

" HGAnnotate      Performs "hg annotate" on the current file.  If an

"                  argument is given, the argument is used as a revision

"                  number to display.  If not given an argument, it uses the

"                  most recent version of the file on the current branch.

"                  Additionally, if the current buffer is a HGAnnotate buffer

"                  already, the version number on the current line is used.

"

"                  If the 'HGCommandAnnotateParent' variable is set to a

"                  non-zero value, the version previous to the one on the

"                  current line is used instead.  This allows one to navigate

"                  back to examine the previous version of a line.

"

" HGCommit[!]     If called with arguments, this performs "hg commit" using

"                  the arguments as the log message.

"

"                  If '!' is used, an empty log message is committed.

"

"                  If called with no arguments, this is a two-step command.

"                  The first step opens a buffer to accept a log message.

"                  When that buffer is written, it is automatically closed and

"                  the file is committed using the information from that log

"                  message.  The commit can be abandoned if the log message

"                  buffer is deleted or wiped before being written.

"

" HGDiff          With no arguments, this performs "hg diff" on the current

"                  file.  With one argument, "hg diff" is performed on the

"                  current file against the specified revision.  With two

"                  arguments, hg diff is performed between the specified

"                  revisions of the current file.  This command uses the

"                  'HGCommandDiffOpt' variable to specify diff options.  If

"                  that variable does not exist, then 'wbBc' is assumed.  If

"                  you wish to have no options, then set it to the empty

"                  string.

"

" HGGotoOriginal  Returns the current window to the source buffer if the

"                  current buffer is a HG output buffer.

"

" HGLog           Performs "hg log" on the current file.

"

" HGRevert        Replaces the modified version of the current file with the

"                  most recent version from the repository.

"

" HGReview        Retrieves a particular version of the current file.  If no

"                  argument is given, the most recent version of the file on

"                  the current branch is retrieved.  The specified revision is

"                  retrieved into a new buffer.

"

" HGStatus        Performs "hg status" on the current file.

"

" HGUpdate        Performs "hg update" on the current file.

"

" HGVimDiff       With no arguments, this prompts the user for a revision and

"                  then uses vimdiff to display the differences between the

"                  current file and the specified revision.  If no revision is

"                  specified, the most recent version of the file on the

"                  current branch is used.  With one argument, that argument

"                  is used as the revision as above.  With two arguments, the

"                  differences between the two revisions is displayed using

"                  vimdiff.

"

"                  With either zero or one argument, the original buffer is used

"                  to perform the vimdiff.  When the other buffer is closed, the

"                  original buffer will be returned to normal mode.

"

"                  Once vimdiff mode is started using the above methods,

"                  additional vimdiff buffers may be added by passing a single

"                  version argument to the command.  There may be up to 4

"                  vimdiff buffers total.

"

"                  Using the 2-argument form of the command resets the vimdiff

"                  to only those 2 versions.  Additionally, invoking the

"                  command on a different file will close the previous vimdiff

"                  buffers.

"

"

" Mapping documentation: {{{2

"

" By default, a mapping is defined for each command.  User-provided mappings

" can be used instead by mapping to <Plug>CommandName, for instance:

"

" nnoremap ,ca <Plug>HGAdd

"

" The default mappings are as follow:

"

"   <Leader>hga HGAdd

"   <Leader>hgn HGAnnotate

"   <Leader>hgc HGCommit

"   <Leader>hgd HGDiff

"   <Leader>hgg HGGotoOriginal

"   <Leader>hgG HGGotoOriginal!

"   <Leader>hgl HGLog

"   <Leader>hgr HGReview

"   <Leader>hgs HGStatus

"   <Leader>hgu HGUpdate

"   <Leader>hgv HGVimDiff

"

" Options documentation: {{{2

"

" Several variables are checked by the script to determine behavior as follow:

"

" HGCommandAnnotateParent

"   This variable, if set to a non-zero value, causes the zero-argument form

"   of HGAnnotate when invoked on a HGAnnotate buffer to go to the version

"   previous to that displayed on the current line.  If not set, it defaults

"   to 0.

"

" HGCommandCommitOnWrite

"   This variable, if set to a non-zero value, causes the pending hg commit

"   to take place immediately as soon as the log message buffer is written.

"   If set to zero, only the HGCommit mapping will cause the pending commit

"   to occur.  If not set, it defaults to 1.

"

" HGCommandDeleteOnHide

"   This variable, if set to a non-zero value, causes the temporary HG result

"   buffers to automatically delete themselves when hidden.

"

" HGCommandDiffOpt

"   This variable, if set, determines the options passed to the diff command

"   of HG.  If not set, it defaults to 'wbBc'.

"

" HGCommandDiffSplit

"   This variable overrides the HGCommandSplit variable, but only for buffers

"   created with HGVimDiff.

"

" HGCommandEdit

"   This variable controls whether the original buffer is replaced ('edit') or

"   split ('split').  If not set, it defaults to 'edit'.

"

" HGCommandEnableBufferSetup

"   This variable, if set to a non-zero value, activates HG buffer management

"   mode.  This mode means that two buffer variables, 'HGRevision' and

"   'HGBranch', are set if the file is HG-controlled.  This is useful for

"   displaying version information in the status bar.

"

" HGCommandInteractive

"   This variable, if set to a non-zero value, causes appropriate functions (for

"   the moment, only HGReview) to query the user for a revision to use

"   instead of the current revision if none is specified.

"

" HGCommandNameMarker

"   This variable, if set, configures the special attention-getting characters

"   that appear on either side of the hg buffer type in the buffer name.

"   This has no effect unless 'HGCommandNameResultBuffers' is set to a true

"   value.  If not set, it defaults to '_'.  

"

" HGCommandNameResultBuffers

"   This variable, if set to a true value, causes the hg result buffers to be

"   named in the old way ('<source file name> _<hg command>_').  If not set

"   or set to a false value, the result buffer is nameless.

"

" HGCommandSplit

"   This variable controls the orientation of the various window splits that

"   may occur (such as with HGVimDiff, when using a HG command on a HG

"   command buffer, or when the 'HGCommandEdit' variable is set to 'split'.

"   If set to 'horizontal', the resulting windows will be on stacked on top of

"   one another.  If set to 'vertical', the resulting windows will be

"   side-by-side.  If not set, it defaults to 'horizontal' for all but

"   HGVimDiff windows.

"

" Event documentation {{{2

"   For additional customization, hgcommand.vim uses User event autocommand

"   hooks.  Each event is in the HGCommand group, and different patterns

"   match the various hooks.

"

"   For instance, the following could be added to the vimrc to provide a 'q'

"   mapping to quit a HG buffer:

"

"   augroup HGCommand

"     au HGCommand User HGBufferCreated silent! nmap <unique> <buffer> q :bwipeout<cr> 

"   augroup END

"

"   The following hooks are available:

"

"   HGBufferCreated           This event is fired just after a hg command

"                              result buffer is created and filled with the

"                              result of a hg command.  It is executed within

"                              the context of the new buffer.

"

"   HGBufferSetup             This event is fired just after HG buffer setup

"                              occurs, if enabled.

"

"   HGPluginInit              This event is fired when the HGCommand plugin

"                              first loads.

"

"   HGPluginFinish            This event is fired just after the HGCommand

"                              plugin loads.

"

"   HGVimDiffFinish           This event is fired just after the HGVimDiff

"                              command executes to allow customization of,

"                              for instance, window placement and focus.

"

" Section: Plugin header {{{1

" loaded_hgcommand is set to 1 when the initialization begins, and 2 when it

" completes.  This allows various actions to only be taken by functions after

" system initialization.

if exists("loaded_hgcommand")

   finish

endif

let loaded_hgcommand = 1

if v:version < 602

  echohl WarningMsg|echomsg "HGCommand 1.69 or later requires VIM 6.2 or later"|echohl None

  finish

endif

" Section: Event group setup {{{1

augroup HGCommand

augroup END

" Section: Plugin initialization {{{1

silent do HGCommand User HGPluginInit

" Section: Script variable initialization {{{1

let s:HGCommandEditFileRunning = 0

unlet! s:vimDiffRestoreCmd

unlet! s:vimDiffSourceBuffer

unlet! s:vimDiffBufferCount

unlet! s:vimDiffScratchList

" Section: Utility functions {{{1

" Function: s:HGResolveLink() {{{2

" Fully resolve the given file name to remove shortcuts or symbolic links.

function! s:HGResolveLink(fileName)

  let resolved = resolve(a:fileName)

  if resolved != a:fileName

    let resolved = s:HGResolveLink(resolved)

  endif

  return resolved

endfunction

" Function: s:HGChangeToCurrentFileDir() {{{2

" Go to the directory in which the current HG-controlled file is located.

" If this is a HG command buffer, first switch to the original file.

function! s:HGChangeToCurrentFileDir(fileName)

  let oldCwd=getcwd()

  let fileName=s:HGResolveLink(a:fileName)

  let newCwd=fnamemodify(fileName, ':h')

  if strlen(newCwd) > 0

    execute 'cd' escape(newCwd, ' ')

  endif

  return oldCwd

endfunction

" Function: s:HGGetOption(name, default) {{{2

" Grab a user-specified option to override the default provided.  Options are

" searched in the window, buffer, then global spaces.

function! s:HGGetOption(name, default)

  if exists("s:" . a:name . "Override")

    execute "return s:".a:name."Override"

  elseif exists("w:" . a:name)

    execute "return w:".a:name

  elseif exists("b:" . a:name)

    execute "return b:".a:name

  elseif exists("g:" . a:name)

    execute "return g:".a:name

  else

    return a:default

  endif

endfunction

" Function: s:HGEditFile(name, origBuffNR) {{{2

" Wrapper around the 'edit' command to provide some helpful error text if the

" current buffer can't be abandoned.  If name is provided, it is used;

" otherwise, a nameless scratch buffer is used.

" Returns: 0 if successful, -1 if an error occurs.

function! s:HGEditFile(name, origBuffNR)

  "Name parameter will be pasted into expression.

  let name = escape(a:name, ' *?\')

  let editCommand = s:HGGetOption('HGCommandEdit', 'edit')

  if editCommand != 'edit'

    if s:HGGetOption('HGCommandSplit', 'horizontal') == 'horizontal'

      if name == ""

        let editCommand = 'rightbelow new'

      else

        let editCommand = 'rightbelow split ' . name

      endif

    else

      if name == ""

        let editCommand = 'vert rightbelow new'

      else

        let editCommand = 'vert rightbelow split ' . name

      endif

    endif

  else

    if name == ""

      let editCommand = 'enew'

    else

      let editCommand = 'edit ' . name

    endif

  endif

  " Protect against useless buffer set-up

  let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning + 1

  try

    execute editCommand

  finally

    let s:HGCommandEditFileRunning = s:HGCommandEditFileRunning - 1

  endtry

  let b:HGOrigBuffNR=a:origBuffNR

  let b:HGCommandEdit='split'

endfunction

" Function: s:HGCreateCommandBuffer(cmd, cmdName, statusText, filename) {{{2

" Creates a new scratch buffer and captures the output from execution of the

" given command.  The name of the scratch buffer is returned.

function! s:HGCreateCommandBuffer(cmd, cmdName, statusText, origBuffNR)

  let fileName=bufname(a:origBuffNR)

  let resultBufferName=''

  if s:HGGetOption("HGCommandNameResultBuffers", 0)

    let nameMarker = s:HGGetOption("HGCommandNameMarker", '_')

    if strlen(a:statusText) > 0

      let bufName=a:cmdName . ' -- ' . a:statusText

    else

      let bufName=a:cmdName

    endif

    let bufName=fileName . ' ' . nameMarker . bufName . nameMarker

    let counter=0

    let resultBufferName = bufName

    while buflisted(resultBufferName)

      let counter=counter + 1

      let resultBufferName=bufName . ' (' . counter . ')'

    endwhile

  endif

  let hgCommand = s:HGGetOption("HGCommandHGExec", "hg") . " " . a:cmd

  echomsg "DBG :".hgCommand

  let hgOut = system(hgCommand)

  " HACK:  diff command does not return proper error codes

  if v:shell_error && a:cmdName != 'hgdiff'

    if strlen(hgOut) == 0

      echoerr "HG command failed"

    else

      echoerr "HG command failed:  " . hgOut

    endif

    return -1

  endif

  if strlen(hgOut) == 0

    " Handle case of no output.  In this case, it is important to check the

    " file status, especially since hg edit/unedit may change the attributes

    " of the file with no visible output.

    echomsg "No output from HG command"

    checktime

    return -1

  endif

  if s:HGEditFile(resultBufferName, a:origBuffNR) == -1

    return -1

  endif

  set buftype=nofile

  set noswapfile

  set filetype=

  if s:HGGetOption("HGCommandDeleteOnHide", 0)

    set bufhidden=delete

  endif

  silent 0put=hgOut

  " The last command left a blank line at the end of the buffer.  If the

  " last line is folded (a side effect of the 'put') then the attempt to

  " remove the blank line will kill the last fold.

  "

  " This could be fixed by explicitly detecting whether the last line is

  " within a fold, but I prefer to simply unfold the result buffer altogether.

  if has('folding')

    normal zR

  endif

  $d

  1

  " Define the environment and execute user-defined hooks.

  let b:HGSourceFile=fileName

  let b:HGCommand=a:cmdName

  if a:statusText != ""

    let b:HGStatusText=a:statusText

  endif

  silent do HGCommand User HGBufferCreated

  return bufnr("%")

endfunction

" Function: s:HGBufferCheck(hgBuffer) {{{2

" Attempts to locate the original file to which HG operations were applied

" for a given buffer.

function! s:HGBufferCheck(hgBuffer)

  let origBuffer = getbufvar(a:hgBuffer, "HGOrigBuffNR")

  if origBuffer

    if bufexists(origBuffer)

      return origBuffer

    else

      " Original buffer no longer exists.

      return -1 

    endif

  else

    " No original buffer

    return a:hgBuffer

  endif

endfunction

" Function: s:HGCurrentBufferCheck() {{{2

" Attempts to locate the original file to which HG operations were applied

" for the current buffer.

function! s:HGCurrentBufferCheck()

  return s:HGBufferCheck(bufnr("%"))

endfunction

" Function: s:HGToggleDeleteOnHide() {{{2

" Toggles on and off the delete-on-hide behavior of HG buffers

function! s:HGToggleDeleteOnHide()

  if exists("g:HGCommandDeleteOnHide")

    unlet g:HGCommandDeleteOnHide

  else

    let g:HGCommandDeleteOnHide=1

  endif

endfunction

" Function: s:HGDoCommand(hgcmd, cmdName, statusText) {{{2

" General skeleton for HG function execution.

" Returns: name of the new command buffer containing the command results

function! s:HGDoCommand(cmd, cmdName, statusText)

  let hgBufferCheck=s:HGCurrentBufferCheck()

  if hgBufferCheck == -1 

    echo "Original buffer no longer exists, aborting."

    return -1

  endif

  let fileName=bufname(hgBufferCheck)

  if isdirectory(fileName)

    let fileName=fileName . "/" . getline(".")

  endif

  let realFileName = fnamemodify(s:HGResolveLink(fileName), ':t')

  let oldCwd=s:HGChangeToCurrentFileDir(fileName)

  try

     " TODO

    "if !filereadable('HG/Root')

      "throw fileName . ' is not a HG-controlled file.'

    "endif

    let fullCmd = a:cmd . ' "' . realFileName . '"'

    "echomsg "DEBUG".fullCmd

    let resultBuffer=s:HGCreateCommandBuffer(fullCmd, a:cmdName, a:statusText, hgBufferCheck)

    return resultBuffer