" vim600: set foldmethod=marker:

"

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

"

" Last Change:   2006/02/22

" Version:       1.77

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

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

" Credits:

"                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.

"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

"

" Section: Documentation

"----------------------------

"

" Documentation should be available by ":help hgcommand" command, once the

" script has been copied in you .vim/plugin directory.

"

" You still can read the documentation at the end of this file. Locate it by

" searching the "hgcommand-contents" string (and set ft=help to have

" appropriate syntaxic coloration).

" 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("g:loaded_hgcommand")

   finish

endif

let g:loaded_hgcommand = 1

" store 'compatible' settings

let s:save_cpo = &cpo

set cpo&vim

" run checks

let s:script_name = expand("<sfile>:t:r")

function! s:HGCleanupOnFailure(err)

  echohl WarningMsg

  echomsg s:script_name . ":" a:err "Plugin not loaded"

  echohl None

  let g:loaded_hgcommand = "no"

  unlet s:save_cpo s:script_name

endfunction

if v:version < 602

  call <SID>HGCleanupOnFailure("VIM 6.2 or later required.")

  finish

endif

if !exists("*system")

  call <SID>HGCleanupOnFailure("builtin system() function required.")

  finish

endif

let s:script_version = "v0.2"

" 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 = <SID>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=<SID>HGResolveLink(a:fileName)

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

  if strlen(newCwd) > 0

    execute 'cd' escape(newCwd, ' ')

  endif

  return oldCwd

endfunction

" Function: <SID>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 = <SID>HGGetOption('HGCommandEdit', 'edit')

  if editCommand != 'edit'

    if <SID>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 <SID>HGGetOption("HGCommandNameResultBuffers", 0)

    let nameMarker = <SID>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 = <SID>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 <SID>HGEditFile(resultBufferName, a:origBuffNR) == -1

    return -1

  endif

  set buftype=nofile

  set noswapfile

  set filetype=

  if <SID>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")

    setlocal nofoldenable

  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 <SID>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=<SID>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(<SID>HGResolveLink(fileName), ':t')

  let oldCwd=<SID>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=<SID>HGCreateCommandBuffer(fullCmd, a:cmdName, a:statusText, hgBufferCheck)

    return resultBuffer

  catch

    echoerr v:exception

    return -1

  finally

    execute 'cd' escape(oldCwd, ' ')

  endtry

endfunction

" Function: s:HGGetStatusVars(revision, branch, repository) {{{2

"

" Obtains a HG revision number and branch name.  The 'revisionVar',

" 'branchVar'and 'repositoryVar' arguments, if non-empty, contain the names of variables to hold

" the corresponding results.

"

" Returns: string to be exec'd that sets the multiple return values.

function! s:HGGetStatusVars(revisionVar, branchVar, repositoryVar)

  let hgBufferCheck=<SID>HGCurrentBufferCheck()

  "echomsg "DBG : in HGGetStatusVars"

  if hgBufferCheck == -1

    return ""

  endif

  let fileName=bufname(hgBufferCheck)

  let fileNameWithoutLink=<SID>HGResolveLink(fileName)

  let realFileName = fnamemodify(fileNameWithoutLink, ':t')

  let oldCwd=<SID>HGChangeToCurrentFileDir(realFileName)

  try

    let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " root  "

    let roottext=system(hgCommand)

    " Suppress ending null char ! Does it work in window ?

    let roottext=substitute(roottext,'^.*/\([^/\n\r]*\)\n\_.*$','\1','')

    if match(getcwd()."/".fileNameWithoutLink, roottext) == -1

      return ""

    endif

    let returnExpression = ""

    if a:repositoryVar != ""

      let returnExpression=returnExpression . " | let " . a:repositoryVar . "='" . roottext . "'"

    endif

    let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " status -mardui " . realFileName

    let statustext=system(hgCommand)

    if(v:shell_error)

      return ""

    endif

    if match(statustext, '^[?I]') >= 0

      let revision="NEW"

    elseif match(statustext, '^[R]') >= 0

      let revision="REMOVED"

    elseif match(statustext, '^[D]') >= 0

      let revision="DELETED"

    elseif match(statustext, '^[A]') >= 0

      let revision="ADDED"

    else

      " The file is tracked, we can try to get is revision number

      let hgCommand = <SID>HGGetOption("HGCommandHGExec", "hg") . " parents "

      let statustext=system(hgCommand)

      if(v:shell_error)

          return ""

      endif

      let revision=substitute(statustext, '^changeset:\s*\(\d\+\):.*\_$\_.*$', '\1', "")

      if a:branchVar != "" && match(statustext, '^\_.*\_^branch:') >= 0

        let branch=substitute(statustext, '^\_.*\_^branch:\s*\(\S\+\)\n\_.*$', '\1', "")

        let returnExpression=returnExpression . " | let " . a:branchVar . "='" . branch . "'"

      endif

    endif

    if (exists('revision'))

      let returnExpression = "let " . a:revisionVar . "='" . revision . "' " . returnExpression

    endif

    return returnExpression

  finally

    execute 'cd' escape(oldCwd, ' ')

  endtry

endfunction

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

" Attempts to set the b:HGBranch, b:HGRevision and b:HGRepository variables.

function! s:HGSetupBuffer(...)

  if (exists("b:HGBufferSetup") && b:HGBufferSetup && !exists('a:1'))

    " This buffer is already set up.

    return

  endif

  if !<SID>HGGetOption("HGCommandEnableBufferSetup", 0)

        \ || @% == ""

        \ || s:HGCommandEditFileRunning > 0

        \ || exists("b:HGOrigBuffNR")

    unlet! b:HGRevision

    unlet! b:HGBranch

    unlet! b:HGRepository

    return

  endif

  if !filereadable(expand("%"))

    return -1

  endif

  let revision=""

  let branch=""

  let repository=""

  exec <SID>HGGetStatusVars('revision', 'branch', 'repository')

  "echomsg "DBG ".revision."#".branch."#".repository

  if revision != ""

    let b:HGRevision=revision

  else

    unlet! b:HGRevision

  endif

  if branch != ""

    let b:HGBranch=branch

  else

    unlet! b:HGBranch

  endif

  if repository != ""

     let b:HGRepository=repository

  else

     unlet! b:HGRepository

  endif

  silent do HGCommand User HGBufferSetup

  let b:HGBufferSetup=1

endfunction

" Function: s:HGMarkOrigBufferForSetup(hgbuffer) {{{2

" Resets the buffer setup state of the original buffer for a given HG buffer.

" Returns:  The HG buffer number in a passthrough mode.

function! s:HGMarkOrigBufferForSetup(hgBuffer)

  checktime

  if a:hgBuffer != -1

    let origBuffer = <SID>HGBufferCheck(a:hgBuffer)

    "This should never not work, but I'm paranoid

    if origBuffer != a:hgBuffer

      call setbufvar(origBuffer, "HGBufferSetup", 0)

    endif

  else

    "We are presumably in the original buffer

    let b:HGBufferSetup = 0

    "We do the setup now as now event will be triggered allowing it later.

    call <SID>HGSetupBuffer()

  endif

  return a:hgBuffer

endfunction

" Function: s:HGOverrideOption(option, [value]) {{{2

" Provides a temporary override for the given HG option.  If no value is

" passed, the override is disabled.

function! s:HGOverrideOption(option, ...)

  if a:0 == 0

    unlet! s:{a:option}Override

  else

    let s:{a:option}Override = a:1

  endif

endfunction

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

" Clears all current HG buffers of the specified type for a given source.

function! s:HGWipeoutCommandBuffers(originalBuffer, hgCommand)

  let buffer = 1

  while buffer <= bufnr('$')

    if getbufvar(buffer, 'HGOrigBuffNR') == a:originalBuffer

      if getbufvar(buffer, 'HGCommand') == a:hgCommand

        execute 'bw' buffer

      endif

    endif

    let buffer = buffer + 1

  endwhile

endfunction

" Function: s:HGInstallDocumentation(full_name, revision)              {{{2

"   Install help documentation.

" Arguments:

"   full_name: Full name of this vim plugin script, including path name.

"   revision:  Revision of the vim script. #version# mark in the document file

"              will be replaced with this string with 'v' prefix.

" Return: