" VIM plugin for doing single, multi-patch or diff code reviews {{{

" Home:  http://www.vim.org/scripts/script.php?script_id=1563

" Version       : 0.2.2                                        "{{{

" Author        : Manpreet Singh < junkblocker@yahoo.com >

" Copyright     : 2006-2010 by Manpreet Singh

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

"                 No warranties express or implied. Use at your own risk.

"

" Changelog :

"

"   0.2.2 - Security fixes by removing custom tempfile creation

"         - Removed need for DiffReviewCleanup/PatchReviewCleanup

"         - Better command execution error detection and display

"         - Improved diff view and folding by ignoring modelines

"         - Improved tab labels display

"

"   0.2.1 - Minor temp directory autodetection logic and cleanup

"

"   0.2 - Removed the need for filterdiff by implementing it in pure vim script

"       - Added DiffReview command for reverse (changed repository to

"         pristine state) reviews.

"         (PatchReview does pristine repository to patch review)

"       - DiffReview does automatic detection and generation of diffs for

"         various Source Control systems

"       - Skip load if VIM 7.0 or higher unavailable

"

"   0.1 - First released

"}}}

" Documentation:                                                         "{{{

" ===========================================================================

" This plugin allows single or multiple, patch or diff based code reviews to

" be easily done in VIM. VIM has :diffpatch command to do single file reviews

" but a) can not handle patch files containing multiple patches or b) do

" automated diff generation for various version control systems. This plugin

" attempts to provide those functionalities. It opens each changed / added or

" removed file diff in new tabs.

"

" Installing:

"

"   For a quick start, unzip patchreview.zip into your ~/.vim directory and

"   restart Vim.

"

" Details:

"

"   Requirements:

"

"   1) VIM 7.0 or higher built with +diff option.

"

"   2) A gnu compatible patch command installed. This is the standard patch

"      command on Linux, Mac OS X, *BSD, Cygwin or /usr/bin/gpatch on newer

"      Solaris.

"

"   3) Optional (but recommended for speed)

"

"      Install patchutils ( http://cyberelk.net/tim/patchutils/ ) for your

"      OS. For windows it is available from Cygwin

"

"         http://www.cygwin.com

"

"      or GnuWin32

"

"         http://gnuwin32.sourceforge.net/

"

"   Install:

"

"   1) Extract the zip in your $HOME/.vim or $VIM/vimfiles directory and

"      restart vim. The  directory location relevant to your platform can be

"      seen by running :help add-global-plugin in vim.

"

"   2) Restart vim.

"

"  Configuration:

"

"  Optionally, specify the locations to these filterdiff and patch commands

"  and location of a temporary directory to use in your .vimrc.

"

"      let g:patchreview_patch       = '/path/to/gnu/patch'

"

"      " If you are using filterdiff

"      let g:patchreview_filterdiff  = '/path/to/filterdiff'

"

"

" Usage:

"

"  Please see :help patchreview or :help diffreview for details.

"

""}}}

" Enabled only during development

" unlet! g:loaded_patchreview " DEBUG

" unlet! g:patchreview_patch " DEBUG

" unlet! g:patchreview_filterdiff " DEBUG

" let g:patchreview_patch = 'patch'    " DEBUG

if v:version < 700

  finish

endif

if ! has('diff')

  call confirm('patchreview.vim plugin needs (G)VIM built with +diff support to work.')

  finish

endif

" load only once

if (! exists('g:patchreview_debug') && exists('g:loaded_patchreview')) || &compatible

  finish

endif

let g:loaded_patchreview="0.2.2"

let s:msgbufname = '-PatchReviewMessages-'

function! <SID>Debug(str)                                                 "{{{

  if exists('g:patchreview_debug')

    Pecho 'DEBUG: ' . a:str

  endif

endfunction

command! -nargs=+ -complete=expression Debug call s:Debug(<args>)

"}}}

function! <SID>PR_wipeMsgBuf()                                            "{{{

  let winnum = bufwinnr(s:msgbufname)

  if winnum != -1 " If the window is already open, jump to it

    let cur_winnr = winnr()

    if winnr() != winnum

      exe winnum . 'wincmd w'

      exe 'bw'

      exe cur_winnr . 'wincmd w'

    endif

  endif

endfunction

"}}}

function! <SID>Pecho(...)                                                 "{{{

  " Usage: Pecho(msg, [return_to_original_window_flag])

  "            default return_to_original_window_flag = 0

  "

  let cur_winnr = winnr()

  let winnum = bufwinnr(s:msgbufname)

  if winnum != -1 " If the window is already open, jump to it

    if winnr() != winnum

      exe winnum . 'wincmd w'

    endif

  else

    let bufnum = bufnr(s:msgbufname)

    if bufnum == -1

      let wcmd = s:msgbufname

    else

      let wcmd = '+buffer' . bufnum

    endif

    exe 'silent! botright 5split ' . wcmd

  endif

  setlocal modifiable

  setlocal buftype=nofile

  setlocal bufhidden=delete

  setlocal noswapfile

  setlocal nowrap

  setlocal nobuflisted

  if a:0 != 0

    silent! $put =a:1

  endif

  exe ':$'

  setlocal nomodifiable

  if a:0 > 1 && a:2

    exe cur_winnr . 'wincmd w'

  endif

endfunction

command! -nargs=+ -complete=expression Pecho call s:Pecho(<args>)

"}}}

function! <SID>PR_checkBinary(BinaryName)                                 "{{{

  " Verify that BinaryName is specified or available

  if ! exists('g:patchreview_' . a:BinaryName)

    if executable(a:BinaryName)

      let g:patchreview_{a:BinaryName} = a:BinaryName

      return 1

    else

      Pecho 'g:patchreview_' . a:BinaryName . ' is not defined and ' . a:BinaryName . ' command could not be found on path.'

      Pecho 'Please define it in your .vimrc.'

      return 0

    endif

  elseif ! executable(g:patchreview_{a:BinaryName})

    Pecho 'Specified g:patchreview_' . a:BinaryName . ' [' . g:patchreview_{a:BinaryName} . '] is not executable.'

    return 0

  else

    return 1

  endif

endfunction

"}}}

function! <SID>ExtractDiffsNative(...)                                    "{{{

  " Sets g:patches = {'reason':'', 'patch':[

  " {

  "  'filename': filepath

  "  'type'    : '+' | '-' | '!'

  "  'content' : patch text for this file

  " },

  " ...

  " ]}

  let g:patches = {'reason' : '', 'patch' : []}

  " TODO : User pointers into lines list rather then use collect

  if a:0 == 0

    let g:patches['reason'] = "ExtractDiffsNative expects at least a patchfile argument"

    return

  endif

  let patchfile = expand(a:1, ':p')

  if a:0 > 1

    let patch = a:2

  endif

  if ! filereadable(patchfile)

    let g:patches['reason'] = "File " . patchfile . " is not readable"

    return

  endif

  unlet! filterdiffcmd

  let filterdiffcmd = '' . g:patchreview_filterdiff . ' --list -s ' . patchfile

  let fileslist = split(system(filterdiffcmd), '[\r\n]')

  for filewithchangetype in fileslist

    if filewithchangetype !~ '^[!+-] '

      Pecho '*** Skipping review generation due to unknown change for [' . filewithchangetype . ']'

      continue

    endif

    unlet! this_patch

    let this_patch = {}

    unlet! relpath

    let relpath = substitute(filewithchangetype, '^. ', '', '')

    let this_patch['filename'] = relpath

    if filewithchangetype =~ '^! '

      let this_patch['type'] = '!'

    elseif filewithchangetype =~ '^+ '

      let this_patch['type'] = '+'

    elseif filewithchangetype =~ '^- '

      let this_patch['type'] = '-'

    endif

    unlet! filterdiffcmd

    let filterdiffcmd = '' . g:patchreview_filterdiff . ' -i ' . relpath . ' ' . patchfile

    let this_patch['content'] = split(system(filterdiffcmd), '[\n\r]')

    let g:patches['patch'] += [this_patch]

    Debug "Patch collected for " . relpath

  endfor

endfunction

"}}}

function! <SID>ExtractDiffsPureVim(...)                                   "{{{

  " Sets g:patches = {'reason':'', 'patch':[

  " {

  "  'filename': filepath

  "  'type'    : '+' | '-' | '!'

  "  'content' : patch text for this file

  " },

  " ...

  " ]}

  let g:patches = {'reason' : '', 'patch' : []}

  " TODO : User pointers into lines list rather then use collect

  if a:0 == 0

    let g:patches['reason'] = "ExtractDiffsPureVim expects at least a patchfile argument"

    return

  endif

  let patchfile = expand(a:1, ':p')

  if a:0 > 1

    let patch = a:2

  endif

  if ! filereadable(patchfile)

    let g:patches['reason'] = "File " . patchfile . " is not readable"

    return

  endif

  call s:PR_wipeMsgBuf()

  let collect = []

  let linum = 0

  let lines = readfile(patchfile)

  let linescount = len(lines)

  State 'START'

  while linum < linescount

    let line = lines[linum]

    let linum += 1

    if State() == 'START'

      let mat = matchlist(line, '^--- \([^\t]\+\).*$')

      if ! empty(mat) && mat[1] != ''

        State 'MAYBE_UNIFIED_DIFF'

        let p_first_file = mat[1]

        let collect = [line]

        Debug line . State()

        continue

      endif

      let mat = matchlist(line, '^\*\*\* \([^\t]\+\).*$')

      if ! empty(mat) && mat[1] != ''

        State 'MAYBE_CONTEXT_DIFF'

        let p_first_file = mat[1]

        let collect = [line]

        Debug line . State()

        continue

      endif

      continue

    elseif State() == 'MAYBE_CONTEXT_DIFF'

      let mat = matchlist(line, '^--- \([^\t]\+\).*$')

      if empty(mat) || mat[1] == ''

        State 'START'

        let linum -= 1

        continue

        Debug 'Back to square one ' . line()

      endif

      let p_second_file = mat[1]

      if p_first_file == '/dev/null'

        if p_second_file == '/dev/null'

          let g:patches['reason'] = "Malformed diff found at line " . linum

          return

        endif

        let p_type = '+'

        let filepath = p_second_file

      else

        if p_second_file == '/dev/null'

          let p_type = '-'

          let filepath = p_first_file

        else

          let p_type = '!'

          let filepath = p_first_file

        endif

      endif

      State 'EXPECT_15_STARS'

      let collect += [line]

      Debug line . State()

    elseif State() == 'EXPECT_15_STARS'

      if line !~ '^*\{15}$'

        State 'START'

        let linum -= 1

        Debug line . State()

        continue

      endif

      State 'EXPECT_CONTEXT_CHUNK_HEADER_1'

      let collect += [line]

      Debug line . State()

    elseif State() == 'EXPECT_CONTEXT_CHUNK_HEADER_1'

      let mat = matchlist(line, '^\*\*\* \(\d\+,\)\?\(\d\+\) \*\*\*\*$')

      if empty(mat) || mat[1] == ''

        State 'START'

        let linum -= 1

        Debug line . State()

        continue

      endif

      let collect += [line]

      State 'SKIP_CONTEXT_STUFF_1'

      Debug line . State()

      continue

    elseif State() == 'SKIP_CONTEXT_STUFF_1'

      if line !~ '^[ !+].*$'

        let mat = matchlist(line, '^--- \(\d\+\),\(\d\+\) ----$')

        if ! empty(mat) && mat[1] != '' && mat[2] != ''

          let goal_count = mat[2] - mat[1] + 1

          let c_count = 0

          State 'READ_CONTEXT_CHUNK'

          let collect += [line]

          Debug line . State() . " Goal count set to " . goal_count

          continue

        endif

        State 'START'

        let linum -= 1

        Debug line . State()

        continue

      endif

      let collect += [line]

      continue

    elseif State() == 'READ_CONTEXT_CHUNK'

      let c_count += 1

      if c_count == goal_count

        let collect += [line]

        State 'BACKSLASH_OR_CRANGE_EOF'

        continue

      else " goal not met yet

        let mat = matchlist(line, '^\([\\!+ ]\).*$')

        if empty(mat) || mat[1] == ''

          let linum -= 1

          State 'START'

          Debug line . State()

          continue

        endif

        let collect += [line]

        continue

      endif

    elseif State() == 'BACKSLASH_OR_CRANGE_EOF'

      if line =~ '^\\ No newline.*$'   " XXX: Can we go to another chunk from here??

        let collect += [line]

        let this_patch = {}

        let this_patch['filename'] = filepath

        let this_patch['type'] = p_type

        let this_patch['content'] = collect

        let g:patches['patch'] += [this_patch]

        Debug "Patch collected for " . filepath

        State 'START'

        continue

      endif

      if line =~ '^\*\{15}$'

        let collect += [line]

        State 'EXPECT_CONTEXT_CHUNK_HEADER_1'

        Debug line . State()

        continue

      endif

      let this_patch = {}

      let this_patch['filename'] = filepath

      let this_patch['type'] = p_type

      let this_patch['content'] = collect

      let g:patches['patch'] += [this_patch]

      let linum -= 1

      State 'START'

      Debug "Patch collected for " . filepath

      Debug line . State()

      continue

    elseif State() == 'MAYBE_UNIFIED_DIFF'

      let mat = matchlist(line, '^+++ \([^\t]\+\).*$')

      if empty(mat) || mat[1] == ''

        State 'START'

        let linum -= 1

        Debug line . State()

        continue

      endif

      let p_second_file = mat[1]

      if p_first_file == '/dev/null'

        if p_second_file == '/dev/null'

          let g:patches['reason'] = "Malformed diff found at line " . linum

          return

        endif

        let p_type = '+'

        let filepath = p_second_file

      else

        if p_second_file == '/dev/null'

          let p_type = '-'

          let filepath = p_first_file

        else

          let p_type = '!'

          let filepath = p_first_file

        endif

      endif