extdiff.py
836 lines
| 25.7 KiB
| text/x-python
|
PythonLexer
/ hgext / extdiff.py
Vadim Gelfer
|
r2333 | # extdiff.py - external diff program support for mercurial | ||
# | ||||
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
# | ||||
Martin Geisler
|
r8225 | # This software may be used and distributed according to the terms of the | ||
Matt Mackall
|
r10263 | # GNU General Public License version 2 or any later version. | ||
Brendan Cully
|
r5245 | |||
Dirkjan Ochtman
|
r8934 | '''command to allow external programs to compare revisions | ||
Dirkjan Ochtman
|
r8873 | |||
Cédric Duval
|
r9286 | The extdiff Mercurial extension allows you to use external programs | ||
Martin Geisler
|
r9257 | to compare revisions, or revision with working directory. The external | ||
diff programs are called with a configurable set of options and two | ||||
Brendan Cully
|
r5245 | non-option arguments: paths to directories containing snapshots of | ||
files to compare. | ||||
Kyle Lippincott
|
r37226 | If there is more than one file being compared and the "child" revision | ||
is the working directory, any modifications made in the external diff | ||||
program will be copied back to the working directory from the temporary | ||||
directory. | ||||
Javi Merino
|
r14327 | The extdiff extension also allows you to configure new diff commands, so | ||
Martin Geisler
|
r11191 | you do not need to type :hg:`extdiff -p kdiff3` always. :: | ||
Mathieu Clabaut
|
r3127 | |||
Brendan Cully
|
r5245 | [extdiff] | ||
# add new command that runs GNU diff(1) in 'context diff' mode | ||||
cdiff = gdiff -Nprc5 | ||||
## or the old way: | ||||
#cmd.cdiff = gdiff | ||||
#opts.cdiff = -Nprc5 | ||||
Mathieu Clabaut
|
r3127 | |||
Matt Harbison
|
r23150 | # add new command called meld, runs meld (no need to name twice). If | ||
# the meld executable is not available, the meld tool in [merge-tools] | ||||
# will be used, if available | ||||
Brendan Cully
|
r5245 | meld = | ||
# add new command called vimdiff, runs gvimdiff with DirDiff plugin | ||||
Martin Geisler
|
r9257 | # (see http://www.vim.org/scripts/script.php?script_id=102) Non | ||
# English user, be sure to put "let g:DirDiffDynamicDiffText = 1" in | ||||
Brendan Cully
|
r5245 | # your .vimrc | ||
Thomas Arendsen Hein
|
r16242 | vimdiff = gvim -f "+next" \\ | ||
"+execute 'DirDiff' fnameescape(argv(0)) fnameescape(argv(1))" | ||||
Brendan Cully
|
r5245 | |||
Martin Geisler
|
r11191 | Tool arguments can include variables that are expanded at runtime:: | ||
Steve Borho
|
r11184 | |||
$parent1, $plabel1 - filename, descriptive label of first parent | ||||
$child, $clabel - filename, descriptive label of child revision | ||||
$parent2, $plabel2 - filename, descriptive label of second parent | ||||
Steven Stallion
|
r14045 | $root - repository root | ||
Steve Borho
|
r11184 | $parent is an alias for $parent1. | ||
The extdiff extension will look in your [diff-tools] and [merge-tools] | ||||
sections for diff tool arguments, when none are specified in [extdiff]. | ||||
Martin Geisler
|
r11191 | :: | ||
Steve Borho
|
r11184 | [extdiff] | ||
Martin Geisler
|
r11191 | kdiff3 = | ||
Steve Borho
|
r11184 | |||
[diff-tools] | ||||
kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child | ||||
Ludovic Chabant
|
r41724 | If a program has a graphical interface, it might be interesting to tell | ||
Mercurial about it. It will prevent the program from being mistakenly | ||||
used in a terminal-only environment (such as an SSH terminal session), | ||||
and will make :hg:`extdiff --per-file` open multiple file diffs at once | ||||
instead of one by one (if you still want to open file diffs one by one, | ||||
you can use the --confirm option). | ||||
Declaring that a tool has a graphical interface can be done with the | ||||
``gui`` flag next to where ``diffargs`` are specified: | ||||
:: | ||||
[diff-tools] | ||||
kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child | ||||
kdiff3.gui = true | ||||
Martin Geisler
|
r11191 | You can use -I/-X and list of file or directory names like normal | ||
:hg:`diff` command. The extdiff extension makes snapshots of only | ||||
needed files, so running the external diff program will actually be | ||||
pretty fast (at least faster than having to compare the entire tree). | ||||
Brendan Cully
|
r5245 | ''' | ||
Vadim Gelfer
|
r2333 | |||
Matt Harbison
|
r52756 | from __future__ import annotations | ||
Pulkit Goyal
|
r28970 | |||
import os | ||||
import re | ||||
import shutil | ||||
Augie Fackler
|
r36799 | import stat | ||
Ludovic Chabant
|
r41724 | import subprocess | ||
Matt Harbison
|
r52752 | import typing | ||
from typing import ( | ||||
List, | ||||
Optional, | ||||
Tuple, | ||||
) | ||||
Yuya Nishihara
|
r38183 | |||
Matt Mackall
|
r3891 | from mercurial.i18n import _ | ||
Pulkit Goyal
|
r28970 | from mercurial.node import ( | ||
Joerg Sonnenberger
|
r47601 | nullrev, | ||
Pulkit Goyal
|
r28970 | short, | ||
) | ||||
from mercurial import ( | ||||
archival, | ||||
cmdutil, | ||||
Ludovic Chabant
|
r41628 | encoding, | ||
Pulkit Goyal
|
r28970 | error, | ||
filemerge, | ||||
Yuya Nishihara
|
r37622 | formatter, | ||
Martin von Zweigbergk
|
r48929 | logcmdutil, | ||
Pulkit Goyal
|
r30678 | pycompat, | ||
Yuya Nishihara
|
r32337 | registrar, | ||
Pulkit Goyal
|
r28970 | scmutil, | ||
util, | ||||
) | ||||
Yuya Nishihara
|
r37102 | from mercurial.utils import ( | ||
Yuya Nishihara
|
r37138 | procutil, | ||
Yuya Nishihara
|
r37102 | stringutil, | ||
) | ||||
Brad Schick
|
r5135 | |||
Matt Harbison
|
r52752 | if typing.TYPE_CHECKING: | ||
from mercurial import ( | ||||
localrepo, | ||||
ui as uimod, | ||||
) | ||||
Gregory Szorc
|
r21246 | cmdtable = {} | ||
Yuya Nishihara
|
r32337 | command = registrar.command(cmdtable) | ||
Boris Feld
|
r34778 | |||
configtable = {} | ||||
configitem = registrar.configitem(configtable) | ||||
Augie Fackler
|
r43346 | configitem( | ||
Augie Fackler
|
r46554 | b'extdiff', | ||
br'opts\..*', | ||||
default=b'', | ||||
generic=True, | ||||
Boris Feld
|
r34778 | ) | ||
Augie Fackler
|
r43346 | configitem( | ||
Augie Fackler
|
r46554 | b'extdiff', | ||
br'gui\..*', | ||||
generic=True, | ||||
Ludovic Chabant
|
r41724 | ) | ||
Augie Fackler
|
r43346 | configitem( | ||
Augie Fackler
|
r46554 | b'diff-tools', | ||
br'.*\.diffargs$', | ||||
default=None, | ||||
generic=True, | ||||
Boris Feld
|
r34779 | ) | ||
Augie Fackler
|
r43346 | configitem( | ||
Augie Fackler
|
r46554 | b'diff-tools', | ||
br'.*\.gui$', | ||||
generic=True, | ||||
Ludovic Chabant
|
r41724 | ) | ||
Augie Fackler
|
r29841 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for | ||
Augie Fackler
|
r25186 | # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should | ||
# be specifying the version(s) of Mercurial they are tested with, or | ||||
# leave the attribute unspecified. | ||||
Augie Fackler
|
r43347 | testedwith = b'ships-with-hg-core' | ||
Augie Fackler
|
r16743 | |||
Augie Fackler
|
r43346 | |||
Matt Harbison
|
r52752 | def snapshot( | ||
ui: "uimod.ui", | ||||
repo: "localrepo.localrepository", | ||||
files, | ||||
node: Optional[bytes], | ||||
tmproot: bytes, | ||||
listsubrepos: bool, | ||||
) -> Tuple[bytes, List[Tuple[bytes, bytes, os.stat_result]]]: | ||||
Augie Fackler
|
r46554 | """snapshot files as of some revision | ||
Patrick Mezard
|
r8064 | if not using snapshot, -I/-X does not work and recursive diff | ||
Augie Fackler
|
r46554 | in tools like kdiff3 and meld displays too many files.""" | ||
Brad Schick
|
r5135 | dirname = os.path.basename(repo.root) | ||
Augie Fackler
|
r43347 | if dirname == b"": | ||
dirname = b"root" | ||||
Patrick Mezard
|
r8064 | if node is not None: | ||
Augie Fackler
|
r43347 | dirname = b'%s.%s' % (dirname, short(node)) | ||
Brad Schick
|
r5135 | base = os.path.join(tmproot, dirname) | ||
os.mkdir(base) | ||||
Matt Harbison
|
r32212 | fnsandstat = [] | ||
Matt Harbison
|
r25812 | |||
Patrick Mezard
|
r8064 | if node is not None: | ||
Augie Fackler
|
r43346 | ui.note( | ||
Augie Fackler
|
r43347 | _(b'making snapshot of %d files from rev %s\n') | ||
Augie Fackler
|
r43346 | % (len(files), short(node)) | ||
) | ||||
Patrick Mezard
|
r8064 | else: | ||
Augie Fackler
|
r43346 | ui.note( | ||
Augie Fackler
|
r43347 | _(b'making snapshot of %d files from working directory\n') | ||
Augie Fackler
|
r43346 | % (len(files)) | ||
) | ||||
Matt Harbison
|
r25812 | |||
if files: | ||||
Augie Fackler
|
r43347 | repo.ui.setconfig(b"ui", b"archivemeta", False) | ||
Matt Harbison
|
r25812 | |||
Augie Fackler
|
r43346 | archival.archive( | ||
repo, | ||||
base, | ||||
node, | ||||
Augie Fackler
|
r43347 | b'files', | ||
Augie Fackler
|
r43346 | match=scmutil.matchfiles(repo, files), | ||
subrepos=listsubrepos, | ||||
) | ||||
Matt Harbison
|
r25812 | |||
for fn in sorted(files): | ||||
wfn = util.pconvert(fn) | ||||
Augie Fackler
|
r43347 | ui.note(b' %s\n' % wfn) | ||
Matt Harbison
|
r25812 | |||
if node is None: | ||||
dest = os.path.join(base, wfn) | ||||
Matt Harbison
|
r32212 | fnsandstat.append((dest, repo.wjoin(fn), os.lstat(dest))) | ||
return dirname, fnsandstat | ||||
Thomas Arendsen Hein
|
r5143 | |||
Augie Fackler
|
r43346 | |||
def formatcmdline( | ||||
cmdline, | ||||
repo_root, | ||||
do3way, | ||||
parent1, | ||||
plabel1, | ||||
parent2, | ||||
plabel2, | ||||
child, | ||||
clabel, | ||||
): | ||||
Ludovic Chabant
|
r41232 | # Function to quote file/dir names in the argument string. | ||
# When not operating in 3-way mode, an empty string is | ||||
# returned for parent2 | ||||
Augie Fackler
|
r43346 | replace = { | ||
Augie Fackler
|
r43347 | b'parent': parent1, | ||
b'parent1': parent1, | ||||
b'parent2': parent2, | ||||
b'plabel1': plabel1, | ||||
b'plabel2': plabel2, | ||||
b'child': child, | ||||
b'clabel': clabel, | ||||
b'root': repo_root, | ||||
Augie Fackler
|
r43346 | } | ||
Ludovic Chabant
|
r41232 | def quote(match): | ||
pre = match.group(2) | ||||
key = match.group(3) | ||||
Augie Fackler
|
r43347 | if not do3way and key == b'parent2': | ||
Ludovic Chabant
|
r41232 | return pre | ||
return pre + procutil.shellquote(replace[key]) | ||||
# Match parent2 first, so 'parent1?' will match both parent1 and parent | ||||
Augie Fackler
|
r43346 | regex = ( | ||
br'''(['"]?)([^\s'"$]*)''' | ||||
br'\$(parent2|parent1?|child|plabel1|plabel2|clabel|root)\1' | ||||
) | ||||
Ludovic Chabant
|
r41232 | if not do3way and not re.search(regex, cmdline): | ||
Augie Fackler
|
r43347 | cmdline += b' $parent1 $child' | ||
Ludovic Chabant
|
r41232 | return re.sub(regex, quote, cmdline) | ||
Augie Fackler
|
r43346 | |||
Ludovic Chabant
|
r41724 | def _systembackground(cmd, environ=None, cwd=None): | ||
Augie Fackler
|
r46554 | """like 'procutil.system', but returns the Popen object directly | ||
so we don't have to wait on it. | ||||
""" | ||||
Ludovic Chabant
|
r41724 | env = procutil.shellenviron(environ) | ||
Augie Fackler
|
r43346 | proc = subprocess.Popen( | ||
procutil.tonativestr(cmd), | ||||
shell=True, | ||||
close_fds=procutil.closefds, | ||||
env=procutil.tonativeenv(env), | ||||
cwd=pycompat.rapply(procutil.tonativestr, cwd), | ||||
) | ||||
Ludovic Chabant
|
r41724 | return proc | ||
Augie Fackler
|
r43346 | |||
def _runperfilediff( | ||||
cmdline, | ||||
repo_root, | ||||
ui, | ||||
guitool, | ||||
do3way, | ||||
confirm, | ||||
commonfiles, | ||||
tmproot, | ||||
dir1a, | ||||
dir1b, | ||||
dir2, | ||||
rev1a, | ||||
rev1b, | ||||
rev2, | ||||
): | ||||
Ludovic Chabant
|
r41628 | # Note that we need to sort the list of files because it was | ||
# built in an "unstable" way and it's annoying to get files in a | ||||
# random order, especially when "confirm" mode is enabled. | ||||
Ludovic Chabant
|
r41724 | waitprocs = [] | ||
Ludovic Chabant
|
r41628 | totalfiles = len(commonfiles) | ||
for idx, commonfile in enumerate(sorted(commonfiles)): | ||||
Pulkit Goyal
|
r45957 | path1a = os.path.join(dir1a, commonfile) | ||
Ludovic Chabant
|
r41628 | label1a = commonfile + rev1a | ||
if not os.path.isfile(path1a): | ||||
Kyle Lippincott
|
r44229 | path1a = pycompat.osdevnull | ||
Ludovic Chabant
|
r41628 | |||
Augie Fackler
|
r43347 | path1b = b'' | ||
label1b = b'' | ||||
Ludovic Chabant
|
r41628 | if do3way: | ||
Pulkit Goyal
|
r45957 | path1b = os.path.join(dir1b, commonfile) | ||
Ludovic Chabant
|
r41628 | label1b = commonfile + rev1b | ||
if not os.path.isfile(path1b): | ||||
Kyle Lippincott
|
r44229 | path1b = pycompat.osdevnull | ||
Ludovic Chabant
|
r41628 | |||
Pulkit Goyal
|
r45958 | path2 = os.path.join(dir2, commonfile) | ||
Ludovic Chabant
|
r41628 | label2 = commonfile + rev2 | ||
if confirm: | ||||
# Prompt before showing this diff | ||||
Augie Fackler
|
r43347 | difffiles = _(b'diff %s (%d of %d)') % ( | ||
Augie Fackler
|
r43346 | commonfile, | ||
idx + 1, | ||||
totalfiles, | ||||
) | ||||
responses = _( | ||||
Augie Fackler
|
r43347 | b'[Yns?]' | ||
b'$$ &Yes, show diff' | ||||
b'$$ &No, skip this diff' | ||||
b'$$ &Skip remaining diffs' | ||||
b'$$ &? (display help)' | ||||
Augie Fackler
|
r43346 | ) | ||
Augie Fackler
|
r43347 | r = ui.promptchoice(b'%s %s' % (difffiles, responses)) | ||
Augie Fackler
|
r43346 | if r == 3: # ? | ||
Ludovic Chabant
|
r41628 | while r == 3: | ||
for c, t in ui.extractchoices(responses)[1]: | ||||
Augie Fackler
|
r43347 | ui.write(b'%s - %s\n' % (c, encoding.lower(t))) | ||
r = ui.promptchoice(b'%s %s' % (difffiles, responses)) | ||||
Augie Fackler
|
r43346 | if r == 0: # yes | ||
Ludovic Chabant
|
r41628 | pass | ||
Augie Fackler
|
r43346 | elif r == 1: # no | ||
Ludovic Chabant
|
r41628 | continue | ||
Augie Fackler
|
r43346 | elif r == 2: # skip | ||
Ludovic Chabant
|
r41628 | break | ||
curcmdline = formatcmdline( | ||||
Augie Fackler
|
r43346 | cmdline, | ||
repo_root, | ||||
do3way=do3way, | ||||
parent1=path1a, | ||||
plabel1=label1a, | ||||
parent2=path1b, | ||||
plabel2=label1b, | ||||
child=path2, | ||||
clabel=label2, | ||||
) | ||||
Ludovic Chabant
|
r41628 | |||
Ludovic Chabant
|
r41724 | if confirm or not guitool: | ||
# Run the comparison program and wait for it to exit | ||||
# before we show the next file. | ||||
# This is because either we need to wait for confirmation | ||||
# from the user between each invocation, or because, as far | ||||
# as we know, the tool doesn't have a GUI, in which case | ||||
# we can't run multiple CLI programs at the same time. | ||||
Augie Fackler
|
r43346 | ui.debug( | ||
Augie Fackler
|
r43347 | b'running %r in %s\n' % (pycompat.bytestr(curcmdline), tmproot) | ||
Augie Fackler
|
r43346 | ) | ||
Augie Fackler
|
r43347 | ui.system(curcmdline, cwd=tmproot, blockedtag=b'extdiff') | ||
Ludovic Chabant
|
r41724 | else: | ||
# Run the comparison program but don't wait, as we're | ||||
# going to rapid-fire each file diff and then wait on | ||||
# the whole group. | ||||
Augie Fackler
|
r43346 | ui.debug( | ||
Augie Fackler
|
r43347 | b'running %r in %s (backgrounded)\n' | ||
Augie Fackler
|
r43346 | % (pycompat.bytestr(curcmdline), tmproot) | ||
) | ||||
Ludovic Chabant
|
r41724 | proc = _systembackground(curcmdline, cwd=tmproot) | ||
waitprocs.append(proc) | ||||
Ludovic Chabant
|
r41628 | |||
Ludovic Chabant
|
r41724 | if waitprocs: | ||
Augie Fackler
|
r43347 | with ui.timeblockedsection(b'extdiff'): | ||
Ludovic Chabant
|
r41724 | for proc in waitprocs: | ||
proc.wait() | ||||
Augie Fackler
|
r43346 | |||
Pulkit Goyal
|
r45689 | def diffpatch(ui, repo, node1, node2, tmproot, matcher, cmdline): | ||
Pulkit Goyal
|
r45686 | template = b'hg-%h.patch' | ||
Pulkit Goyal
|
r45689 | # write patches to temporary files | ||
Pulkit Goyal
|
r45686 | with formatter.nullformatter(ui, b'extdiff', {}) as fm: | ||
cmdutil.export( | ||||
repo, | ||||
Pulkit Goyal
|
r45689 | [repo[node1].rev(), repo[node2].rev()], | ||
Pulkit Goyal
|
r45686 | fm, | ||
fntemplate=repo.vfs.reljoin(tmproot, template), | ||||
match=matcher, | ||||
) | ||||
Pulkit Goyal
|
r45689 | label1 = cmdutil.makefilename(repo[node1], template) | ||
Pulkit Goyal
|
r45686 | label2 = cmdutil.makefilename(repo[node2], template) | ||
Pulkit Goyal
|
r45689 | file1 = repo.vfs.reljoin(tmproot, label1) | ||
file2 = repo.vfs.reljoin(tmproot, label2) | ||||
Pulkit Goyal
|
r45686 | cmdline = formatcmdline( | ||
cmdline, | ||||
repo.root, | ||||
Pulkit Goyal
|
r45688 | # no 3way while comparing patches | ||
do3way=False, | ||||
Pulkit Goyal
|
r45689 | parent1=file1, | ||
plabel1=label1, | ||||
# while comparing patches, there is no second parent | ||||
parent2=None, | ||||
plabel2=None, | ||||
child=file2, | ||||
Pulkit Goyal
|
r45686 | clabel=label2, | ||
) | ||||
ui.debug(b'running %r in %s\n' % (pycompat.bytestr(cmdline), tmproot)) | ||||
ui.system(cmdline, cwd=tmproot, blockedtag=b'extdiff') | ||||
return 1 | ||||
Pulkit Goyal
|
r45687 | def diffrevs( | ||
ui, | ||||
repo, | ||||
Martin von Zweigbergk
|
r46747 | ctx1a, | ||
ctx1b, | ||||
ctx2, | ||||
Pulkit Goyal
|
r45687 | matcher, | ||
tmproot, | ||||
cmdline, | ||||
do3way, | ||||
guitool, | ||||
opts, | ||||
): | ||||
subrepos = opts.get(b'subrepos') | ||||
Pulkit Goyal
|
r45690 | |||
# calculate list of files changed between both revs | ||||
Martin von Zweigbergk
|
r46747 | st = ctx1a.status(ctx2, matcher, listsubrepos=subrepos) | ||
Pulkit Goyal
|
r45687 | mod_a, add_a, rem_a = set(st.modified), set(st.added), set(st.removed) | ||
if do3way: | ||||
Martin von Zweigbergk
|
r46747 | stb = ctx1b.status(ctx2, matcher, listsubrepos=subrepos) | ||
Pulkit Goyal
|
r45687 | mod_b, add_b, rem_b = ( | ||
set(stb.modified), | ||||
set(stb.added), | ||||
set(stb.removed), | ||||
) | ||||
else: | ||||
mod_b, add_b, rem_b = set(), set(), set() | ||||
modadd = mod_a | add_a | mod_b | add_b | ||||
common = modadd | rem_a | rem_b | ||||
if not common: | ||||
return 0 | ||||
Pulkit Goyal
|
r45690 | |||
Martin von Zweigbergk
|
r46747 | # Always make a copy of ctx1a (and ctx1b, if applicable) | ||
Pulkit Goyal
|
r45690 | # dir1a should contain files which are: | ||
Martin von Zweigbergk
|
r46747 | # * modified or removed from ctx1a to ctx2 | ||
# * modified or added from ctx1b to ctx2 | ||||
# (except file added from ctx1a to ctx2 as they were not present in | ||||
# ctx1a) | ||||
Pulkit Goyal
|
r45687 | dir1a_files = mod_a | rem_a | ((mod_b | add_b) - add_a) | ||
Martin von Zweigbergk
|
r46747 | dir1a = snapshot(ui, repo, dir1a_files, ctx1a.node(), tmproot, subrepos)[0] | ||
Martin von Zweigbergk
|
r46748 | rev1a = b'' if ctx1a.rev() is None else b'@%d' % ctx1a.rev() | ||
Pulkit Goyal
|
r45687 | if do3way: | ||
Pulkit Goyal
|
r45690 | # file calculation criteria same as dir1a | ||
Pulkit Goyal
|
r45687 | dir1b_files = mod_b | rem_b | ((mod_a | add_a) - add_b) | ||
Martin von Zweigbergk
|
r46747 | dir1b = snapshot( | ||
ui, repo, dir1b_files, ctx1b.node(), tmproot, subrepos | ||||
)[0] | ||||
rev1b = b'@%d' % ctx1b.rev() | ||||
Pulkit Goyal
|
r45687 | else: | ||
dir1b = None | ||||
rev1b = b'' | ||||
fnsandstat = [] | ||||
Martin von Zweigbergk
|
r46747 | # If ctx2 is not the wc or there is >1 change, copy it | ||
Pulkit Goyal
|
r45687 | dir2root = b'' | ||
rev2 = b'' | ||||
Martin von Zweigbergk
|
r46747 | if ctx2.node() is not None: | ||
dir2 = snapshot(ui, repo, modadd, ctx2.node(), tmproot, subrepos)[0] | ||||
rev2 = b'@%d' % ctx2.rev() | ||||
Pulkit Goyal
|
r45687 | elif len(common) > 1: | ||
# we only actually need to get the files to copy back to | ||||
# the working dir in this case (because the other cases | ||||
# are: diffing 2 revisions or single file -- in which case | ||||
# the file is already directly passed to the diff tool). | ||||
dir2, fnsandstat = snapshot(ui, repo, modadd, None, tmproot, subrepos) | ||||
else: | ||||
# This lets the diff tool open the changed file directly | ||||
dir2 = b'' | ||||
dir2root = repo.root | ||||
label1a = rev1a | ||||
label1b = rev1b | ||||
label2 = rev2 | ||||
Pulkit Goyal
|
r45959 | if not opts.get(b'per_file'): | ||
# If only one change, diff the files instead of the directories | ||||
# Handle bogus modifies correctly by checking if the files exist | ||||
if len(common) == 1: | ||||
common_file = util.localpath(common.pop()) | ||||
dir1a = os.path.join(tmproot, dir1a, common_file) | ||||
label1a = common_file + rev1a | ||||
if not os.path.isfile(dir1a): | ||||
dir1a = pycompat.osdevnull | ||||
if do3way: | ||||
dir1b = os.path.join(tmproot, dir1b, common_file) | ||||
label1b = common_file + rev1b | ||||
if not os.path.isfile(dir1b): | ||||
dir1b = pycompat.osdevnull | ||||
dir2 = os.path.join(dir2root, dir2, common_file) | ||||
label2 = common_file + rev2 | ||||
Pulkit Goyal
|
r45687 | |||
# Run the external tool on the 2 temp directories or the patches | ||||
cmdline = formatcmdline( | ||||
cmdline, | ||||
repo.root, | ||||
do3way=do3way, | ||||
parent1=dir1a, | ||||
plabel1=label1a, | ||||
parent2=dir1b, | ||||
plabel2=label1b, | ||||
child=dir2, | ||||
clabel=label2, | ||||
) | ||||
ui.debug(b'running %r in %s\n' % (pycompat.bytestr(cmdline), tmproot)) | ||||
ui.system(cmdline, cwd=tmproot, blockedtag=b'extdiff') | ||||
else: | ||||
# Run the external tool once for each pair of files | ||||
_runperfilediff( | ||||
cmdline, | ||||
repo.root, | ||||
ui, | ||||
guitool=guitool, | ||||
do3way=do3way, | ||||
confirm=opts.get(b'confirm'), | ||||
commonfiles=common, | ||||
tmproot=tmproot, | ||||
Pulkit Goyal
|
r45957 | dir1a=os.path.join(tmproot, dir1a), | ||
dir1b=os.path.join(tmproot, dir1b) if do3way else None, | ||||
Pulkit Goyal
|
r45958 | dir2=os.path.join(dir2root, dir2), | ||
Pulkit Goyal
|
r45687 | rev1a=rev1a, | ||
rev1b=rev1b, | ||||
rev2=rev2, | ||||
) | ||||
for copy_fn, working_fn, st in fnsandstat: | ||||
cpstat = os.lstat(copy_fn) | ||||
# Some tools copy the file and attributes, so mtime may not detect | ||||
# all changes. A size check will detect more cases, but not all. | ||||
# The only certain way to detect every case is to diff all files, | ||||
# which could be expensive. | ||||
# copyfile() carries over the permission, so the mode check could | ||||
# be in an 'elif' branch, but for the case where the file has | ||||
# changed without affecting mtime or size. | ||||
if ( | ||||
cpstat[stat.ST_MTIME] != st[stat.ST_MTIME] | ||||
or cpstat.st_size != st.st_size | ||||
or (cpstat.st_mode & 0o100) != (st.st_mode & 0o100) | ||||
): | ||||
ui.debug( | ||||
b'file changed while diffing. ' | ||||
b'Overwriting: %s (src: %s)\n' % (working_fn, copy_fn) | ||||
) | ||||
util.copyfile(copy_fn, working_fn) | ||||
return 1 | ||||
Ludovic Chabant
|
r41724 | def dodiff(ui, repo, cmdline, pats, opts, guitool=False): | ||
Augie Fackler
|
r46554 | """Do the actual diff: | ||
Fabio Zadrozny <fabiofz at gmail dot com>
|
r6103 | |||
- copy to a temp structure if diffing 2 internal revisions | ||||
- copy to a temp structure if diffing working revision with | ||||
another one and more than 1 file is changed | ||||
- just invoke the diff for a single file in the working dir | ||||
Augie Fackler
|
r46554 | """ | ||
Gilles Moris
|
r7758 | |||
Martin von Zweigbergk
|
r45322 | cmdutil.check_at_most_one_arg(opts, b'rev', b'change') | ||
Augie Fackler
|
r43347 | revs = opts.get(b'rev') | ||
Martin von Zweigbergk
|
r46749 | from_rev = opts.get(b'from') | ||
to_rev = opts.get(b'to') | ||||
Augie Fackler
|
r43347 | change = opts.get(b'change') | ||
do3way = b'$parent2' in cmdline | ||||
Gilles Moris
|
r7758 | |||
Martin von Zweigbergk
|
r45322 | if change: | ||
Martin von Zweigbergk
|
r48930 | ctx2 = logcmdutil.revsingle(repo, change, None) | ||
Martin von Zweigbergk
|
r37270 | ctx1a, ctx1b = ctx2.p1(), ctx2.p2() | ||
Martin von Zweigbergk
|
r46749 | elif from_rev or to_rev: | ||
repo = scmutil.unhidehashlikerevs( | ||||
repo, [from_rev] + [to_rev], b'nowarn' | ||||
) | ||||
Martin von Zweigbergk
|
r48930 | ctx1a = logcmdutil.revsingle(repo, from_rev, None) | ||
Joerg Sonnenberger
|
r47601 | ctx1b = repo[nullrev] | ||
Martin von Zweigbergk
|
r48930 | ctx2 = logcmdutil.revsingle(repo, to_rev, None) | ||
Gilles Moris
|
r7758 | else: | ||
Martin von Zweigbergk
|
r48929 | ctx1a, ctx2 = logcmdutil.revpair(repo, revs) | ||
Sune Foldager
|
r9512 | if not revs: | ||
Martin von Zweigbergk
|
r37270 | ctx1b = repo[None].p2() | ||
Sune Foldager
|
r9512 | else: | ||
Joerg Sonnenberger
|
r47601 | ctx1b = repo[nullrev] | ||
Martin von Zweigbergk
|
r37270 | |||
Sune Foldager
|
r9512 | # Disable 3-way merge if there is only one parent | ||
if do3way: | ||||
Joerg Sonnenberger
|
r47601 | if ctx1b.rev() == nullrev: | ||
Sune Foldager
|
r9512 | do3way = False | ||
Gilles Moris
|
r7758 | |||
Martin von Zweigbergk
|
r46747 | matcher = scmutil.match(ctx2, pats, opts) | ||
Matt Harbison
|
r26227 | |||
Augie Fackler
|
r43347 | if opts.get(b'patch'): | ||
Pulkit Goyal
|
r45687 | if opts.get(b'subrepos'): | ||
Augie Fackler
|
r43347 | raise error.Abort(_(b'--patch cannot be used with --subrepos')) | ||
Pulkit Goyal
|
r45687 | if opts.get(b'per_file'): | ||
Augie Fackler
|
r43347 | raise error.Abort(_(b'--patch cannot be used with --per-file')) | ||
Martin von Zweigbergk
|
r46747 | if ctx2.node() is None: | ||
Augie Fackler
|
r43347 | raise error.Abort(_(b'--patch requires two revisions')) | ||
Vadim Gelfer
|
r2333 | |||
Augie Fackler
|
r43347 | tmproot = pycompat.mkdtemp(prefix=b'extdiff.') | ||
Vadim Gelfer
|
r2333 | try: | ||
Pulkit Goyal
|
r45686 | if opts.get(b'patch'): | ||
Martin von Zweigbergk
|
r46747 | return diffpatch( | ||
ui, repo, ctx1a.node(), ctx2.node(), tmproot, matcher, cmdline | ||||
) | ||||
Pulkit Goyal
|
r45686 | |||
Pulkit Goyal
|
r45687 | return diffrevs( | ||
ui, | ||||
repo, | ||||
Martin von Zweigbergk
|
r46747 | ctx1a, | ||
ctx1b, | ||||
ctx2, | ||||
Pulkit Goyal
|
r45687 | matcher, | ||
tmproot, | ||||
cmdline, | ||||
do3way, | ||||
guitool, | ||||
opts, | ||||
) | ||||
Thomas Arendsen Hein
|
r5143 | |||
Vadim Gelfer
|
r2333 | finally: | ||
Augie Fackler
|
r43347 | ui.note(_(b'cleaning up temp directory\n')) | ||
Vadim Gelfer
|
r2333 | shutil.rmtree(tmproot) | ||
Yuya Nishihara
|
r27680 | |||
Augie Fackler
|
r43346 | extdiffopts = ( | ||
[ | ||||
( | ||||
Augie Fackler
|
r43347 | b'o', | ||
b'option', | ||||
[], | ||||
_(b'pass option to comparison program'), | ||||
_(b'OPT'), | ||||
), | ||||
Martin von Zweigbergk
|
r46749 | (b'r', b'rev', [], _(b'revision (DEPRECATED)'), _(b'REV')), | ||
(b'', b'from', b'', _(b'revision to diff from'), _(b'REV1')), | ||||
(b'', b'to', b'', _(b'revision to diff to'), _(b'REV2')), | ||||
Augie Fackler
|
r43347 | (b'c', b'change', b'', _(b'change made by revision'), _(b'REV')), | ||
( | ||||
b'', | ||||
b'per-file', | ||||
Augie Fackler
|
r43346 | False, | ||
Augie Fackler
|
r43347 | _(b'compare each file instead of revision snapshots'), | ||
Augie Fackler
|
r43346 | ), | ||
( | ||||
Augie Fackler
|
r43347 | b'', | ||
b'confirm', | ||||
Augie Fackler
|
r43346 | False, | ||
Augie Fackler
|
r43347 | _(b'prompt user before each external program invocation'), | ||
Augie Fackler
|
r43346 | ), | ||
Augie Fackler
|
r43347 | (b'', b'patch', None, _(b'compare patches for two revisions')), | ||
Augie Fackler
|
r43346 | ] | ||
+ cmdutil.walkopts | ||||
+ cmdutil.subrepoopts | ||||
) | ||||
@command( | ||||
Augie Fackler
|
r43347 | b'extdiff', | ||
Augie Fackler
|
r46554 | [ | ||
(b'p', b'program', b'', _(b'comparison program to run'), _(b'CMD')), | ||||
] | ||||
Augie Fackler
|
r43346 | + extdiffopts, | ||
Augie Fackler
|
r43347 | _(b'hg extdiff [OPT]... [FILE]...'), | ||
rdamazio@google.com
|
r40329 | helpcategory=command.CATEGORY_FILE_CONTENTS, | ||
Augie Fackler
|
r43346 | inferrepo=True, | ||
) | ||||
Vadim Gelfer
|
r2333 | def extdiff(ui, repo, *pats, **opts): | ||
Augie Fackler
|
r46554 | """use external program to diff repository (or selected files) | ||
Vadim Gelfer
|
r2333 | |||
Show differences between revisions for the specified files, using | ||||
Martin Geisler
|
r7983 | an external program. The default program used is diff, with | ||
Vadim Gelfer
|
r2906 | default options "-Npru". | ||
Martin Geisler
|
r8076 | To select a different program, use the -p/--program option. The | ||
Ludovic Chabant
|
r41628 | program will be passed the names of two directories to compare, | ||
unless the --per-file option is specified (see below). To pass | ||||
additional options to the program, use -o/--option. These will be | ||||
passed before the names of the directories or files to compare. | ||||
Vadim Gelfer
|
r2333 | |||
Martin von Zweigbergk
|
r46749 | The --from, --to, and --change options work the same way they do for | ||
:hg:`diff`. | ||||
Ludovic Chabant
|
r41628 | |||
The --per-file option runs the external program repeatedly on each | ||||
Ludovic Chabant
|
r41724 | file to diff, instead of once on two directories. By default, | ||
this happens one by one, where the next file diff is open in the | ||||
external program only once the previous external program (for the | ||||
previous file diff) has exited. If the external program has a | ||||
graphical interface, it can open all the file diffs at once instead | ||||
of one by one. See :hg:`help -e extdiff` for information about how | ||||
to tell Mercurial that a given program has a graphical interface. | ||||
Ludovic Chabant
|
r41628 | |||
The --confirm option will prompt the user before each invocation of | ||||
the external program. It is ignored if --per-file isn't specified. | ||||
Augie Fackler
|
r46554 | """ | ||
Pulkit Goyal
|
r34977 | opts = pycompat.byteskwargs(opts) | ||
Augie Fackler
|
r43347 | program = opts.get(b'program') | ||
option = opts.get(b'option') | ||||
Peter Arrenbrecht
|
r9519 | if not program: | ||
Augie Fackler
|
r43347 | program = b'diff' | ||
option = option or [b'-Npru'] | ||||
cmdline = b' '.join(map(procutil.shellquote, [program] + option)) | ||||
FUJIWARA Katsunori
|
r23680 | return dodiff(ui, repo, cmdline, pats, opts) | ||
Vadim Gelfer
|
r2333 | |||
Augie Fackler
|
r43346 | |||
Gregory Szorc
|
r49801 | class savedcmd: | ||
Yuya Nishihara
|
r29723 | """use external program to diff repository (or selected files) | ||
Yuya Nishihara
|
r29721 | |||
Show differences between revisions for the specified files, using | ||||
Yuya Nishihara
|
r29723 | the following program:: | ||
%(path)s | ||||
Yuya Nishihara
|
r29721 | |||
When two revision arguments are given, then changes are shown | ||||
between those revisions. If only one revision is specified then | ||||
that revision is compared to the working directory, and, when no | ||||
revisions are specified, the working directory files are compared | ||||
to its parent. | ||||
""" | ||||
Ludovic Chabant
|
r52916 | def __init__(self, cmd, path, cmdline, isgui): | ||
Yuya Nishihara
|
r29721 | # We can't pass non-ASCII through docstrings (and path is | ||
Matt Harbison
|
r40842 | # in an unknown encoding anyway), but avoid double separators on | ||
# Windows | ||||
docpath = stringutil.escapestr(path).replace(b'\\\\', b'\\') | ||||
Augie Fackler
|
r43906 | self.__doc__ %= {'path': pycompat.sysstr(stringutil.uirepr(docpath))} | ||
Ludovic Chabant
|
r52916 | self._name = cmd | ||
Yuya Nishihara
|
r29721 | self._cmdline = cmdline | ||
Ludovic Chabant
|
r41724 | self._isgui = isgui | ||
Yuya Nishihara
|
r29721 | |||
def __call__(self, ui, repo, *pats, **opts): | ||||
Ludovic Chabant
|
r52916 | if self._isgui and not procutil.gui(): | ||
msg = _(b"tool '%s' requires a GUI") % self._name | ||||
hint = ( | ||||
_(b"to override, use: --config diff-tools.%s.gui=False") | ||||
% self._name | ||||
) | ||||
raise error.Abort(msg, hint=hint) | ||||
Pulkit Goyal
|
r34977 | opts = pycompat.byteskwargs(opts) | ||
Augie Fackler
|
r43347 | options = b' '.join(map(procutil.shellquote, opts[b'option'])) | ||
Yuya Nishihara
|
r29721 | if options: | ||
Augie Fackler
|
r43347 | options = b' ' + options | ||
Augie Fackler
|
r43346 | return dodiff( | ||
ui, repo, self._cmdline + options, pats, opts, guitool=self._isgui | ||||
) | ||||
Yuya Nishihara
|
r29721 | |||
Pulkit Goyal
|
r45970 | def _gettooldetails(ui, cmd, path): | ||
""" | ||||
returns following things for a | ||||
``` | ||||
[extdiff] | ||||
<cmd> = <path> | ||||
``` | ||||
entry: | ||||
cmd: command/tool name | ||||
path: path to the tool | ||||
cmdline: the command which should be run | ||||
isgui: whether the tool uses GUI or not | ||||
Reads all external tools related configs, whether it be extdiff section, | ||||
diff-tools or merge-tools section, or its specified in an old format or | ||||
the latest format. | ||||
""" | ||||
path = util.expandpath(path) | ||||
if cmd.startswith(b'cmd.'): | ||||
cmd = cmd[4:] | ||||
if not path: | ||||
path = procutil.findexe(cmd) | ||||
if path is None: | ||||
path = filemerge.findexternaltool(ui, cmd) or cmd | ||||
diffopts = ui.config(b'extdiff', b'opts.' + cmd) | ||||
cmdline = procutil.shellquote(path) | ||||
if diffopts: | ||||
cmdline += b' ' + diffopts | ||||
isgui = ui.configbool(b'extdiff', b'gui.' + cmd) | ||||
else: | ||||
if path: | ||||
# case "cmd = path opts" | ||||
cmdline = path | ||||
diffopts = len(pycompat.shlexsplit(cmdline)) > 1 | ||||
else: | ||||
# case "cmd =" | ||||
path = procutil.findexe(cmd) | ||||
if path is None: | ||||
path = filemerge.findexternaltool(ui, cmd) or cmd | ||||
cmdline = procutil.shellquote(path) | ||||
diffopts = False | ||||
isgui = ui.configbool(b'extdiff', b'gui.' + cmd) | ||||
# look for diff arguments in [diff-tools] then [merge-tools] | ||||
if not diffopts: | ||||
key = cmd + b'.diffargs' | ||||
for section in (b'diff-tools', b'merge-tools'): | ||||
args = ui.config(section, key) | ||||
if args: | ||||
cmdline += b' ' + args | ||||
break | ||||
Ludovic Chabant
|
r52916 | if isgui is None: | ||
key = cmd + b'.gui' | ||||
for section in (b'diff-tools', b'merge-tools'): | ||||
isgui = ui.configbool(section, key) | ||||
if isgui is not None: | ||||
break | ||||
if isgui is None: | ||||
isgui = False | ||||
Pulkit Goyal
|
r45970 | return cmd, path, cmdline, isgui | ||
Vadim Gelfer
|
r2333 | def uisetup(ui): | ||
Augie Fackler
|
r43347 | for cmd, path in ui.configitems(b'extdiff'): | ||
Pulkit Goyal
|
r45969 | if cmd.startswith(b'opts.') or cmd.startswith(b'gui.'): | ||
continue | ||||
Pulkit Goyal
|
r45970 | cmd, path, cmdline, isgui = _gettooldetails(ui, cmd, path) | ||
Augie Fackler
|
r43346 | command( | ||
cmd, | ||||
extdiffopts[:], | ||||
Augie Fackler
|
r43347 | _(b'hg %s [OPTION]... [FILE]...') % cmd, | ||
Augie Fackler
|
r43346 | helpcategory=command.CATEGORY_FILE_CONTENTS, | ||
inferrepo=True, | ||||
Ludovic Chabant
|
r52916 | )(savedcmd(cmd, path, cmdline, isgui)) | ||
Augie Fackler
|
r43346 | |||
Yuya Nishihara
|
r29722 | |||
# tell hggettext to extract docstrings from these functions: | ||||
i18nfunctions = [savedcmd] | ||||