extdiff.py
325 lines
| 12.1 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. | ||||
|
r9286 | The extdiff extension also allows 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 | |||
|
r5245 | # add new command called vdiff, runs kdiff3 | ||
vdiff = kdiff3 | ||||
|
r3127 | |||
|
r5245 | # add new command called meld, runs meld (no need to name twice) | ||
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 | ||
vimdiff = gvim -f '+next' '+execute "DirDiff" argv(0) argv(1)' | ||||
|
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 | ||||
$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 | |||
|
r3891 | from mercurial.i18n import _ | ||
|
r9512 | from mercurial.node import short, nullid | ||
|
r13970 | from mercurial import cmdutil, scmutil, util, commands, encoding | ||
|
r9512 | import os, shlex, shutil, tempfile, re | ||
|
r5135 | |||
|
r8064 | def snapshot(ui, repo, files, node, tmproot): | ||
'''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) | ||||
|
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))) | ||
|
r13970 | wopener = scmutil.opener(base) | ||
|
r8064 | fns_and_mtime = [] | ||
|
r6747 | ctx = repo[node] | ||
|
r5135 | for fn in files: | ||
|
r6747 | wfn = util.pconvert(fn) | ||
if not wfn in ctx: | ||||
|
r9512 | # File doesn't exist; could be a bogus modify | ||
|
r5135 | continue | ||
ui.note(' %s\n' % wfn) | ||||
dest = os.path.join(base, wfn) | ||||
|
r8065 | fctx = ctx[wfn] | ||
data = repo.wwritedata(wfn, fctx.data()) | ||||
if 'l' in fctx.flags(): | ||||
wopener.symlink(data, wfn) | ||||
else: | ||||
wopener(wfn, 'w').write(data) | ||||
if 'x' in fctx.flags(): | ||||
util.set_flags(dest, False, True) | ||||
|
r8064 | if node is None: | ||
fns_and_mtime.append((dest, repo.wjoin(fn), os.path.getmtime(dest))) | ||||
|
r6103 | return dirname, fns_and_mtime | ||
|
r5143 | |||
|
r2906 | def dodiff(ui, repo, diffcmd, diffopts, pats, opts): | ||
|
r6103 | '''Do the actuall diff: | ||
- 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') | ||||
|
r9512 | args = ' '.join(diffopts) | ||
do3way = '$parent2' in args | ||||
|
r7758 | |||
if revs and change: | ||||
msg = _('cannot specify --rev and --change at the same time') | ||||
raise util.Abort(msg) | ||||
elif change: | ||||
|
r13660 | node2 = cmdutil.revsingle(repo, change, None).node() | ||
|
r9512 | node1a, node1b = repo.changelog.parents(node2) | ||
|
r7758 | else: | ||
|
r9512 | node1a, node2 = cmdutil.revpair(repo, revs) | ||
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 | |||
|
r6582 | matcher = cmdutil.match(repo, pats, opts) | ||
|
r9512 | mod_a, add_a, rem_a = map(set, repo.status(node1a, node2, matcher)[:3]) | ||
if do3way: | ||||
mod_b, add_b, rem_b = map(set, repo.status(node1b, node2, matcher)[: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: | ||||
|
r10394 | return 0 | ||
|
r2333 | |||
tmproot = tempfile.mkdtemp(prefix='extdiff.') | ||||
try: | ||||
|
r9512 | # 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)[0] | ||||
|
r11184 | rev1a = '@%d' % repo[node1a].rev() | ||
|
r9512 | if do3way: | ||
dir1b_files = mod_b | rem_b | ((mod_a | add_a) - add_b) | ||||
dir1b = snapshot(ui, repo, dir1b_files, node1b, tmproot)[0] | ||||
|
r11184 | rev1b = '@%d' % repo[node1b].rev() | ||
|
r9512 | else: | ||
dir1b = None | ||||
|
r11184 | rev1b = '' | ||
|
r9512 | |||
fns_and_mtime = [] | ||||
|
r5137 | |||
# If node2 in not the wc or there is >1 change, copy it | ||||
|
r9512 | dir2root = '' | ||
|
r11184 | rev2 = '' | ||
|
r9512 | if node2: | ||
dir2 = snapshot(ui, repo, modadd, node2, tmproot)[0] | ||||
|
r11184 | rev2 = '@%d' % repo[node2].rev() | ||
|
r9512 | elif len(common) > 1: | ||
|
r9945 | #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). | ||||
|
r9512 | dir2, fns_and_mtime = snapshot(ui, repo, modadd, None, tmproot) | ||
|
r2333 | else: | ||
|
r5137 | # This lets the diff tool open the changed file directly | ||
dir2 = '' | ||||
dir2root = repo.root | ||||
|
r11184 | label1a = rev1a | ||
label1b = rev1b | ||||
label2 = rev2 | ||||
|
r5137 | # If only one change, diff the files instead of the directories | ||
|
r9512 | # Handle bogus modifies correctly by checking if the files exist | ||
if len(common) == 1: | ||||
common_file = util.localpath(common.pop()) | ||||
|
r13758 | dir1a = os.path.join(tmproot, dir1a, common_file) | ||
|
r11184 | label1a = common_file + rev1a | ||
|
r13758 | if not os.path.isfile(dir1a): | ||
|
r9512 | dir1a = os.devnull | ||
if do3way: | ||||
|
r13758 | dir1b = os.path.join(tmproot, dir1b, common_file) | ||
|
r11184 | label1b = common_file + rev1b | ||
|
r13758 | if not os.path.isfile(dir1b): | ||
|
r9512 | dir1b = os.devnull | ||
dir2 = os.path.join(dir2root, dir2, common_file) | ||||
|
r11184 | label2 = common_file + rev2 | ||
|
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 | ||||
|
r11184 | replace = dict(parent=dir1a, parent1=dir1a, parent2=dir1b, | ||
plabel1=label1a, plabel2=label1b, | ||||
clabel=label2, child=dir2) | ||||
|
r9512 | def quote(match): | ||
key = match.group()[1:] | ||||
if not do3way and key == 'parent2': | ||||
return '' | ||||
return util.shellquote(replace[key]) | ||||
# Match parent2 first, so 'parent1?' will match both parent1 and parent | ||||
|
r11184 | regex = '\$(parent2|parent1?|child|plabel1|plabel2|clabel)' | ||
|
r9512 | if not do3way and not re.search(regex, args): | ||
args += ' $parent1 $child' | ||||
args = re.sub(regex, quote, args) | ||||
cmdline = util.shellquote(diffcmd) + ' ' + args | ||||
|
r9467 | ui.debug('running %r in %s\n' % (cmdline, tmproot)) | ||
|
r2906 | util.system(cmdline, cwd=tmproot) | ||
|
r6103 | |||
for copy_fn, working_fn, mtime in fns_and_mtime: | ||||
if os.path.getmtime(copy_fn) != 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) | ||||
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'] | ||||
|
r3129 | return dodiff(ui, repo, program, option, pats, opts) | ||
|
r2333 | |||
cmdtable = { | ||||
"extdiff": | ||||
(extdiff, | ||||
|
r11321 | [('p', 'program', '', | ||
_('comparison program to run'), _('CMD')), | ||||
('o', 'option', [], | ||||
_('pass option to comparison program'), _('OPT')), | ||||
('r', 'rev', [], | ||||
_('revision'), _('REV')), | ||||
('c', 'change', '', | ||||
_('change made by revision'), _('REV')), | ||||
|
r5147 | ] + commands.walkopts, | ||
|
r2333 | _('hg extdiff [OPT]... [FILE]...')), | ||
} | ||||
def uisetup(ui): | ||||
for cmd, path in ui.configitems('extdiff'): | ||||
|
r5245 | if cmd.startswith('cmd.'): | ||
cmd = cmd[4:] | ||||
|
r10282 | if not path: | ||
path = cmd | ||||
|
r5245 | diffopts = ui.config('extdiff', 'opts.' + cmd, '') | ||
diffopts = diffopts and [diffopts] or [] | ||||
elif cmd.startswith('opts.'): | ||||
continue | ||||
else: | ||||
# command = path opts | ||||
if path: | ||||
diffopts = shlex.split(path) | ||||
path = diffopts.pop(0) | ||||
else: | ||||
path, diffopts = cmd, [] | ||||
|
r11184 | # look for diff arguments in [diff-tools] then [merge-tools] | ||
if diffopts == []: | ||||
args = ui.config('diff-tools', cmd+'.diffargs') or \ | ||||
ui.config('merge-tools', cmd+'.diffargs') | ||||
if args: | ||||
diffopts = shlex.split(args) | ||||
|
r2959 | def save(cmd, path, diffopts): | ||
|
r2333 | '''use closure to save diff command to use''' | ||
def mydiff(ui, repo, *pats, **opts): | ||||
|
r9956 | return dodiff(ui, repo, path, diffopts + opts['option'], | ||
pats, opts) | ||||
|
r9941 | doc = _('''\ | ||
|
r9050 | use %(path)s to diff repository (or selected files) | ||
|
r2333 | |||
|
r9945 | Show differences between revisions for the specified files, using | ||
the %(path)s program. | ||||
|
r2333 | |||
|
r9945 | 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.\ | ||||
|
r9050 | ''') % dict(path=util.uirepr(path)) | ||
|
r9941 | |||
# We must translate the docstring right away since it is | ||||
# used as a format string. The string will unfortunately | ||||
# be translated again in commands.helpcmd and this will | ||||
# fail when the docstring contains non-ASCII characters. | ||||
# Decoding the string to a Unicode string here (using the | ||||
# right encoding) prevents that. | ||||
mydiff.__doc__ = doc.decode(encoding.encoding) | ||||
|
r2333 | return mydiff | ||
|
r2959 | cmdtable[cmd] = (save(cmd, path, diffopts), | ||
|
r2333 | cmdtable['extdiff'][1][1:], | ||
|
r4730 | _('hg %s [OPTION]... [FILE]...') % cmd) | ||