extdiff.py
392 lines
| 14.5 KiB
| text/x-python
|
PythonLexer
/ hgext / extdiff.py
|
r2333 | # extdiff.py - external diff program support for mercurial | ||
# | ||||
# Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r5245 | |||
|
r8934 | '''command to allow external programs to compare revisions | ||
|
r8873 | |||
|
r9286 | The extdiff Mercurial extension allows you to use external programs | ||
|
r9257 | to compare revisions, or revision with working directory. The external | ||
diff programs are called with a configurable set of options and two | ||||
|
r5245 | non-option arguments: paths to directories containing snapshots of | ||
files to compare. | ||||
|
r14327 | The extdiff extension also allows you to configure new diff commands, so | ||
|
r11191 | you do not need to type :hg:`extdiff -p kdiff3` always. :: | ||
|
r3127 | |||
|
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 | ||||
|
r3127 | |||
|
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 | ||||
|
r5245 | meld = | ||
# add new command called vimdiff, runs gvimdiff with DirDiff plugin | ||||
|
r9257 | # (see http://www.vim.org/scripts/script.php?script_id=102) Non | ||
# English user, be sure to put "let g:DirDiffDynamicDiffText = 1" in | ||||
|
r5245 | # your .vimrc | ||
|
r16242 | vimdiff = gvim -f "+next" \\ | ||
"+execute 'DirDiff' fnameescape(argv(0)) fnameescape(argv(1))" | ||||
|
r5245 | |||
|
r11191 | Tool arguments can include variables that are expanded at runtime:: | ||
|
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 | ||||
|
r14045 | $root - repository root | ||
|
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]. | ||||
|
r11191 | :: | ||
|
r11184 | [extdiff] | ||
|
r11191 | kdiff3 = | ||
|
r11184 | |||
[diff-tools] | ||||
kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child | ||||
|
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). | ||||
|
r5245 | ''' | ||
|
r2333 | |||
|
r28970 | from __future__ import absolute_import | ||
import os | ||||
import re | ||||
import shutil | ||||
import tempfile | ||||
|
r3891 | from mercurial.i18n import _ | ||
|
r28970 | from mercurial.node import ( | ||
nullid, | ||||
short, | ||||
) | ||||
from mercurial import ( | ||||
archival, | ||||
cmdutil, | ||||
commands, | ||||
error, | ||||
filemerge, | ||||
|
r30678 | pycompat, | ||
|
r28970 | scmutil, | ||
util, | ||||
) | ||||
|
r5135 | |||
|
r21246 | cmdtable = {} | ||
command = cmdutil.command(cmdtable) | ||||
|
r29841 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for | ||
|
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. | ||||
|
r29841 | testedwith = 'ships-with-hg-core' | ||
|
r16743 | |||
|
r25813 | def snapshot(ui, repo, files, node, tmproot, listsubrepos): | ||
|
r8064 | '''snapshot files as of some revision | ||
if not using snapshot, -I/-X does not work and recursive diff | ||||
in tools like kdiff3 and meld displays too many files.''' | ||||
|
r5135 | dirname = os.path.basename(repo.root) | ||
if dirname == "": | ||||
dirname = "root" | ||||
|
r8064 | if node is not None: | ||
dirname = '%s.%s' % (dirname, short(node)) | ||||
|
r5135 | base = os.path.join(tmproot, dirname) | ||
os.mkdir(base) | ||||
|
r25812 | fns_and_mtime = [] | ||
|
r8064 | if node is not None: | ||
ui.note(_('making snapshot of %d files from rev %s\n') % | ||||
(len(files), short(node))) | ||||
else: | ||||
|
r8066 | ui.note(_('making snapshot of %d files from working directory\n') % | ||
|
r8064 | (len(files))) | ||
|
r25812 | |||
if files: | ||||
repo.ui.setconfig("ui", "archivemeta", False) | ||||
archival.archive(repo, base, node, 'files', | ||||
|
r25813 | matchfn=scmutil.matchfiles(repo, files), | ||
subrepos=listsubrepos) | ||||
|
r25812 | |||
for fn in sorted(files): | ||||
wfn = util.pconvert(fn) | ||||
ui.note(' %s\n' % wfn) | ||||
if node is None: | ||||
dest = os.path.join(base, wfn) | ||||
fns_and_mtime.append((dest, repo.wjoin(fn), | ||||
os.lstat(dest).st_mtime)) | ||||
|
r6103 | return dirname, fns_and_mtime | ||
|
r5143 | |||
|
r23681 | def dodiff(ui, repo, cmdline, pats, opts): | ||
|
r17424 | '''Do the actual diff: | ||
|
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 | ||||
''' | ||||
|
r7758 | |||
revs = opts.get('rev') | ||||
change = opts.get('change') | ||||
|
r23681 | do3way = '$parent2' in cmdline | ||
|
r7758 | |||
if revs and change: | ||||
msg = _('cannot specify --rev and --change at the same time') | ||||
|
r26587 | raise error.Abort(msg) | ||
|
r7758 | elif change: | ||
|
r14319 | node2 = scmutil.revsingle(repo, change, None).node() | ||
|
r9512 | node1a, node1b = repo.changelog.parents(node2) | ||
|
r7758 | else: | ||
|
r14319 | node1a, node2 = scmutil.revpair(repo, revs) | ||
|
r9512 | if not revs: | ||
|
r13878 | node1b = repo.dirstate.p2() | ||
|
r9512 | else: | ||
node1b = nullid | ||||
# Disable 3-way merge if there is only one parent | ||||
if do3way: | ||||
if node1b == nullid: | ||||
do3way = False | ||||
|
r7758 | |||
|
r25813 | subrepos=opts.get('subrepos') | ||
|
r14671 | matcher = scmutil.match(repo[node2], pats, opts) | ||
|
r26227 | |||
|
r26228 | if opts.get('patch'): | ||
if subrepos: | ||||
|
r26587 | raise error.Abort(_('--patch cannot be used with --subrepos')) | ||
|
r26228 | if node2 is None: | ||
|
r26587 | raise error.Abort(_('--patch requires two revisions')) | ||
|
r26228 | else: | ||
|
r26227 | mod_a, add_a, rem_a = map(set, repo.status(node1a, node2, matcher, | ||
|
r25813 | listsubrepos=subrepos)[:3]) | ||
|
r26227 | if do3way: | ||
mod_b, add_b, rem_b = map(set, | ||||
repo.status(node1b, node2, matcher, | ||||
listsubrepos=subrepos)[:3]) | ||||
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 | ||||
|
r2333 | |||
tmproot = tempfile.mkdtemp(prefix='extdiff.') | ||||
try: | ||||
|
r26228 | if not opts.get('patch'): | ||
|
r26227 | # Always make a copy of node1a (and node1b, if applicable) | ||
dir1a_files = mod_a | rem_a | ((mod_b | add_b) - add_a) | ||||
dir1a = snapshot(ui, repo, dir1a_files, node1a, tmproot, | ||||
|
r25813 | subrepos)[0] | ||
|
r26227 | rev1a = '@%d' % repo[node1a].rev() | ||
if do3way: | ||||
dir1b_files = mod_b | rem_b | ((mod_a | add_a) - add_b) | ||||
dir1b = snapshot(ui, repo, dir1b_files, node1b, tmproot, | ||||
subrepos)[0] | ||||
rev1b = '@%d' % repo[node1b].rev() | ||||
else: | ||||
dir1b = None | ||||
rev1b = '' | ||||
|
r9512 | |||
|
r26227 | fns_and_mtime = [] | ||
|
r5137 | |||
|
r26227 | # If node2 in not the wc or there is >1 change, copy it | ||
dir2root = '' | ||||
rev2 = '' | ||||
if node2: | ||||
dir2 = snapshot(ui, repo, modadd, node2, tmproot, subrepos)[0] | ||||
rev2 = '@%d' % repo[node2].rev() | ||||
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, fns_and_mtime = snapshot(ui, repo, modadd, None, tmproot, | ||||
subrepos) | ||||
else: | ||||
# This lets the diff tool open the changed file directly | ||||
dir2 = '' | ||||
dir2root = repo.root | ||||
|
r5137 | |||
|
r26227 | label1a = rev1a | ||
label1b = rev1b | ||||
label2 = rev2 | ||||
|
r11184 | |||
|
r26227 | # 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 = os.devnull | ||||
if do3way: | ||||
dir1b = os.path.join(tmproot, dir1b, common_file) | ||||
label1b = common_file + rev1b | ||||
if not os.path.isfile(dir1b): | ||||
dir1b = os.devnull | ||||
dir2 = os.path.join(dir2root, dir2, common_file) | ||||
label2 = common_file + rev2 | ||||
|
r26228 | else: | ||
template = 'hg-%h.patch' | ||||
cmdutil.export(repo, [repo[node1a].rev(), repo[node2].rev()], | ||||
|
r26229 | template=repo.vfs.reljoin(tmproot, template), | ||
match=matcher) | ||||
|
r26228 | label1a = cmdutil.makefilename(repo, template, node1a) | ||
label2 = cmdutil.makefilename(repo, template, node2) | ||||
dir1a = repo.vfs.reljoin(tmproot, label1a) | ||||
dir2 = repo.vfs.reljoin(tmproot, label2) | ||||
dir1b = None | ||||
label1b = None | ||||
fns_and_mtime = [] | ||||
|
r5143 | |||
|
r9945 | # Function to quote file/dir names in the argument string. | ||
# When not operating in 3-way mode, an empty string is | ||||
# returned for parent2 | ||||
|
r20674 | replace = {'parent': dir1a, 'parent1': dir1a, 'parent2': dir1b, | ||
'plabel1': label1a, 'plabel2': label1b, | ||||
'clabel': label2, 'child': dir2, | ||||
'root': repo.root} | ||||
|
r9512 | def quote(match): | ||
|
r23969 | pre = match.group(2) | ||
key = match.group(3) | ||||
|
r9512 | if not do3way and key == 'parent2': | ||
|
r23969 | return pre | ||
return pre + util.shellquote(replace[key]) | ||||
|
r9512 | |||
# Match parent2 first, so 'parent1?' will match both parent1 and parent | ||||
|
r23969 | regex = (r'''(['"]?)([^\s'"$]*)''' | ||
r'\$(parent2|parent1?|child|plabel1|plabel2|clabel|root)\1') | ||||
|
r23681 | if not do3way and not re.search(regex, cmdline): | ||
cmdline += ' $parent1 $child' | ||||
cmdline = re.sub(regex, quote, cmdline) | ||||
|
r9512 | |||
|
r9467 | ui.debug('running %r in %s\n' % (cmdline, tmproot)) | ||
|
r30982 | ui.system(cmdline, cwd=tmproot, blockedtag='extdiff') | ||
|
r6103 | |||
for copy_fn, working_fn, mtime in fns_and_mtime: | ||||
|
r14021 | if os.lstat(copy_fn).st_mtime != mtime: | ||
|
r9467 | ui.debug('file changed while diffing. ' | ||
'Overwriting: %s (src: %s)\n' % (working_fn, copy_fn)) | ||||
|
r6103 | util.copyfile(copy_fn, working_fn) | ||
|
r2333 | return 1 | ||
finally: | ||||
ui.note(_('cleaning up temp directory\n')) | ||||
shutil.rmtree(tmproot) | ||||
|
r27680 | extdiffopts = [ | ||
|
r21246 | ('o', 'option', [], | ||
_('pass option to comparison program'), _('OPT')), | ||||
('r', 'rev', [], _('revision'), _('REV')), | ||||
('c', 'change', '', _('change made by revision'), _('REV')), | ||||
|
r26228 | ('', 'patch', None, _('compare patches for two revisions')) | ||
|
r27680 | ] + commands.walkopts + commands.subrepoopts | ||
@command('extdiff', | ||||
[('p', 'program', '', _('comparison program to run'), _('CMD')), | ||||
] + extdiffopts, | ||||
|
r21781 | _('hg extdiff [OPT]... [FILE]...'), | ||
inferrepo=True) | ||||
|
r2333 | def extdiff(ui, repo, *pats, **opts): | ||
'''use external program to diff repository (or selected files) | ||||
Show differences between revisions for the specified files, using | ||||
|
r7983 | an external program. The default program used is diff, with | ||
|
r2906 | default options "-Npru". | ||
|
r8076 | To select a different program, use the -p/--program option. The | ||
program will be passed the names of two directories to compare. To | ||||
pass additional options to the program, use -o/--option. These | ||||
will be passed before the names of the directories to compare. | ||||
|
r2333 | |||
|
r7990 | 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.''' | ||||
|
r9519 | program = opts.get('program') | ||
option = opts.get('option') | ||||
if not program: | ||||
program = 'diff' | ||||
option = option or ['-Npru'] | ||||
|
r23680 | cmdline = ' '.join(map(util.shellquote, [program] + option)) | ||
return dodiff(ui, repo, cmdline, pats, opts) | ||||
|
r2333 | |||
|
r29721 | class savedcmd(object): | ||
|
r29723 | """use external program to diff repository (or selected files) | ||
|
r29721 | |||
Show differences between revisions for the specified files, using | ||||
|
r29723 | the following program:: | ||
%(path)s | ||||
|
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. | ||||
""" | ||||
def __init__(self, path, cmdline): | ||||
# We can't pass non-ASCII through docstrings (and path is | ||||
# in an unknown encoding anyway) | ||||
|
r31451 | docpath = util.escapestr(path) | ||
|
r29721 | self.__doc__ = self.__doc__ % {'path': util.uirepr(docpath)} | ||
self._cmdline = cmdline | ||||
def __call__(self, ui, repo, *pats, **opts): | ||||
options = ' '.join(map(util.shellquote, opts['option'])) | ||||
if options: | ||||
options = ' ' + options | ||||
return dodiff(ui, repo, self._cmdline + options, pats, opts) | ||||
|
r2333 | def uisetup(ui): | ||
for cmd, path in ui.configitems('extdiff'): | ||||
|
r24193 | path = util.expandpath(path) | ||
|
r5245 | if cmd.startswith('cmd.'): | ||
cmd = cmd[4:] | ||||
|
r10282 | if not path: | ||
|
r23150 | path = util.findexe(cmd) | ||
if path is None: | ||||
path = filemerge.findexternaltool(ui, cmd) or cmd | ||||
|
r23680 | diffopts = ui.config('extdiff', 'opts.' + cmd, '') | ||
cmdline = util.shellquote(path) | ||||
if diffopts: | ||||
cmdline += ' ' + diffopts | ||||
|
r5245 | elif cmd.startswith('opts.'): | ||
continue | ||||
else: | ||||
if path: | ||||
|
r23680 | # case "cmd = path opts" | ||
cmdline = path | ||||
|
r30678 | diffopts = len(pycompat.shlexsplit(cmdline)) > 1 | ||
|
r5245 | else: | ||
|
r23680 | # case "cmd =" | ||
path = util.findexe(cmd) | ||||
|
r23150 | if path is None: | ||
path = filemerge.findexternaltool(ui, cmd) or cmd | ||||
|
r23680 | cmdline = util.shellquote(path) | ||
diffopts = False | ||||
|
r11184 | # look for diff arguments in [diff-tools] then [merge-tools] | ||
|
r23680 | if not diffopts: | ||
|
r11184 | args = ui.config('diff-tools', cmd+'.diffargs') or \ | ||
ui.config('merge-tools', cmd+'.diffargs') | ||||
if args: | ||||
|
r23680 | cmdline += ' ' + args | ||
|
r27681 | command(cmd, extdiffopts[:], _('hg %s [OPTION]... [FILE]...') % cmd, | ||
|
r29721 | inferrepo=True)(savedcmd(path, cmdline)) | ||
|
r29722 | |||
# tell hggettext to extract docstrings from these functions: | ||||
i18nfunctions = [savedcmd] | ||||