##// END OF EJS Templates
extdiff: refactor logic to diff revs of versions of files...
Pulkit Goyal -
r45687:da2e69a2 default
parent child Browse files
Show More
@@ -1,736 +1,755 b''
1 1 # extdiff.py - external diff program support for mercurial
2 2 #
3 3 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 '''command to allow external programs to compare revisions
9 9
10 10 The extdiff Mercurial extension allows you to use external programs
11 11 to compare revisions, or revision with working directory. The external
12 12 diff programs are called with a configurable set of options and two
13 13 non-option arguments: paths to directories containing snapshots of
14 14 files to compare.
15 15
16 16 If there is more than one file being compared and the "child" revision
17 17 is the working directory, any modifications made in the external diff
18 18 program will be copied back to the working directory from the temporary
19 19 directory.
20 20
21 21 The extdiff extension also allows you to configure new diff commands, so
22 22 you do not need to type :hg:`extdiff -p kdiff3` always. ::
23 23
24 24 [extdiff]
25 25 # add new command that runs GNU diff(1) in 'context diff' mode
26 26 cdiff = gdiff -Nprc5
27 27 ## or the old way:
28 28 #cmd.cdiff = gdiff
29 29 #opts.cdiff = -Nprc5
30 30
31 31 # add new command called meld, runs meld (no need to name twice). If
32 32 # the meld executable is not available, the meld tool in [merge-tools]
33 33 # will be used, if available
34 34 meld =
35 35
36 36 # add new command called vimdiff, runs gvimdiff with DirDiff plugin
37 37 # (see http://www.vim.org/scripts/script.php?script_id=102) Non
38 38 # English user, be sure to put "let g:DirDiffDynamicDiffText = 1" in
39 39 # your .vimrc
40 40 vimdiff = gvim -f "+next" \\
41 41 "+execute 'DirDiff' fnameescape(argv(0)) fnameescape(argv(1))"
42 42
43 43 Tool arguments can include variables that are expanded at runtime::
44 44
45 45 $parent1, $plabel1 - filename, descriptive label of first parent
46 46 $child, $clabel - filename, descriptive label of child revision
47 47 $parent2, $plabel2 - filename, descriptive label of second parent
48 48 $root - repository root
49 49 $parent is an alias for $parent1.
50 50
51 51 The extdiff extension will look in your [diff-tools] and [merge-tools]
52 52 sections for diff tool arguments, when none are specified in [extdiff].
53 53
54 54 ::
55 55
56 56 [extdiff]
57 57 kdiff3 =
58 58
59 59 [diff-tools]
60 60 kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child
61 61
62 62 If a program has a graphical interface, it might be interesting to tell
63 63 Mercurial about it. It will prevent the program from being mistakenly
64 64 used in a terminal-only environment (such as an SSH terminal session),
65 65 and will make :hg:`extdiff --per-file` open multiple file diffs at once
66 66 instead of one by one (if you still want to open file diffs one by one,
67 67 you can use the --confirm option).
68 68
69 69 Declaring that a tool has a graphical interface can be done with the
70 70 ``gui`` flag next to where ``diffargs`` are specified:
71 71
72 72 ::
73 73
74 74 [diff-tools]
75 75 kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child
76 76 kdiff3.gui = true
77 77
78 78 You can use -I/-X and list of file or directory names like normal
79 79 :hg:`diff` command. The extdiff extension makes snapshots of only
80 80 needed files, so running the external diff program will actually be
81 81 pretty fast (at least faster than having to compare the entire tree).
82 82 '''
83 83
84 84 from __future__ import absolute_import
85 85
86 86 import os
87 87 import re
88 88 import shutil
89 89 import stat
90 90 import subprocess
91 91
92 92 from mercurial.i18n import _
93 93 from mercurial.node import (
94 94 nullid,
95 95 short,
96 96 )
97 97 from mercurial import (
98 98 archival,
99 99 cmdutil,
100 100 encoding,
101 101 error,
102 102 filemerge,
103 103 formatter,
104 104 pycompat,
105 105 registrar,
106 106 scmutil,
107 107 util,
108 108 )
109 109 from mercurial.utils import (
110 110 procutil,
111 111 stringutil,
112 112 )
113 113
114 114 cmdtable = {}
115 115 command = registrar.command(cmdtable)
116 116
117 117 configtable = {}
118 118 configitem = registrar.configitem(configtable)
119 119
120 120 configitem(
121 121 b'extdiff', br'opts\..*', default=b'', generic=True,
122 122 )
123 123
124 124 configitem(
125 125 b'extdiff', br'gui\..*', generic=True,
126 126 )
127 127
128 128 configitem(
129 129 b'diff-tools', br'.*\.diffargs$', default=None, generic=True,
130 130 )
131 131
132 132 configitem(
133 133 b'diff-tools', br'.*\.gui$', generic=True,
134 134 )
135 135
136 136 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
137 137 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
138 138 # be specifying the version(s) of Mercurial they are tested with, or
139 139 # leave the attribute unspecified.
140 140 testedwith = b'ships-with-hg-core'
141 141
142 142
143 143 def snapshot(ui, repo, files, node, tmproot, listsubrepos):
144 144 '''snapshot files as of some revision
145 145 if not using snapshot, -I/-X does not work and recursive diff
146 146 in tools like kdiff3 and meld displays too many files.'''
147 147 dirname = os.path.basename(repo.root)
148 148 if dirname == b"":
149 149 dirname = b"root"
150 150 if node is not None:
151 151 dirname = b'%s.%s' % (dirname, short(node))
152 152 base = os.path.join(tmproot, dirname)
153 153 os.mkdir(base)
154 154 fnsandstat = []
155 155
156 156 if node is not None:
157 157 ui.note(
158 158 _(b'making snapshot of %d files from rev %s\n')
159 159 % (len(files), short(node))
160 160 )
161 161 else:
162 162 ui.note(
163 163 _(b'making snapshot of %d files from working directory\n')
164 164 % (len(files))
165 165 )
166 166
167 167 if files:
168 168 repo.ui.setconfig(b"ui", b"archivemeta", False)
169 169
170 170 archival.archive(
171 171 repo,
172 172 base,
173 173 node,
174 174 b'files',
175 175 match=scmutil.matchfiles(repo, files),
176 176 subrepos=listsubrepos,
177 177 )
178 178
179 179 for fn in sorted(files):
180 180 wfn = util.pconvert(fn)
181 181 ui.note(b' %s\n' % wfn)
182 182
183 183 if node is None:
184 184 dest = os.path.join(base, wfn)
185 185
186 186 fnsandstat.append((dest, repo.wjoin(fn), os.lstat(dest)))
187 187 return dirname, fnsandstat
188 188
189 189
190 190 def formatcmdline(
191 191 cmdline,
192 192 repo_root,
193 193 do3way,
194 194 parent1,
195 195 plabel1,
196 196 parent2,
197 197 plabel2,
198 198 child,
199 199 clabel,
200 200 ):
201 201 # Function to quote file/dir names in the argument string.
202 202 # When not operating in 3-way mode, an empty string is
203 203 # returned for parent2
204 204 replace = {
205 205 b'parent': parent1,
206 206 b'parent1': parent1,
207 207 b'parent2': parent2,
208 208 b'plabel1': plabel1,
209 209 b'plabel2': plabel2,
210 210 b'child': child,
211 211 b'clabel': clabel,
212 212 b'root': repo_root,
213 213 }
214 214
215 215 def quote(match):
216 216 pre = match.group(2)
217 217 key = match.group(3)
218 218 if not do3way and key == b'parent2':
219 219 return pre
220 220 return pre + procutil.shellquote(replace[key])
221 221
222 222 # Match parent2 first, so 'parent1?' will match both parent1 and parent
223 223 regex = (
224 224 br'''(['"]?)([^\s'"$]*)'''
225 225 br'\$(parent2|parent1?|child|plabel1|plabel2|clabel|root)\1'
226 226 )
227 227 if not do3way and not re.search(regex, cmdline):
228 228 cmdline += b' $parent1 $child'
229 229 return re.sub(regex, quote, cmdline)
230 230
231 231
232 232 def _systembackground(cmd, environ=None, cwd=None):
233 233 ''' like 'procutil.system', but returns the Popen object directly
234 234 so we don't have to wait on it.
235 235 '''
236 236 env = procutil.shellenviron(environ)
237 237 proc = subprocess.Popen(
238 238 procutil.tonativestr(cmd),
239 239 shell=True,
240 240 close_fds=procutil.closefds,
241 241 env=procutil.tonativeenv(env),
242 242 cwd=pycompat.rapply(procutil.tonativestr, cwd),
243 243 )
244 244 return proc
245 245
246 246
247 247 def _runperfilediff(
248 248 cmdline,
249 249 repo_root,
250 250 ui,
251 251 guitool,
252 252 do3way,
253 253 confirm,
254 254 commonfiles,
255 255 tmproot,
256 256 dir1a,
257 257 dir1b,
258 258 dir2root,
259 259 dir2,
260 260 rev1a,
261 261 rev1b,
262 262 rev2,
263 263 ):
264 264 # Note that we need to sort the list of files because it was
265 265 # built in an "unstable" way and it's annoying to get files in a
266 266 # random order, especially when "confirm" mode is enabled.
267 267 waitprocs = []
268 268 totalfiles = len(commonfiles)
269 269 for idx, commonfile in enumerate(sorted(commonfiles)):
270 270 path1a = os.path.join(tmproot, dir1a, commonfile)
271 271 label1a = commonfile + rev1a
272 272 if not os.path.isfile(path1a):
273 273 path1a = pycompat.osdevnull
274 274
275 275 path1b = b''
276 276 label1b = b''
277 277 if do3way:
278 278 path1b = os.path.join(tmproot, dir1b, commonfile)
279 279 label1b = commonfile + rev1b
280 280 if not os.path.isfile(path1b):
281 281 path1b = pycompat.osdevnull
282 282
283 283 path2 = os.path.join(dir2root, dir2, commonfile)
284 284 label2 = commonfile + rev2
285 285
286 286 if confirm:
287 287 # Prompt before showing this diff
288 288 difffiles = _(b'diff %s (%d of %d)') % (
289 289 commonfile,
290 290 idx + 1,
291 291 totalfiles,
292 292 )
293 293 responses = _(
294 294 b'[Yns?]'
295 295 b'$$ &Yes, show diff'
296 296 b'$$ &No, skip this diff'
297 297 b'$$ &Skip remaining diffs'
298 298 b'$$ &? (display help)'
299 299 )
300 300 r = ui.promptchoice(b'%s %s' % (difffiles, responses))
301 301 if r == 3: # ?
302 302 while r == 3:
303 303 for c, t in ui.extractchoices(responses)[1]:
304 304 ui.write(b'%s - %s\n' % (c, encoding.lower(t)))
305 305 r = ui.promptchoice(b'%s %s' % (difffiles, responses))
306 306 if r == 0: # yes
307 307 pass
308 308 elif r == 1: # no
309 309 continue
310 310 elif r == 2: # skip
311 311 break
312 312
313 313 curcmdline = formatcmdline(
314 314 cmdline,
315 315 repo_root,
316 316 do3way=do3way,
317 317 parent1=path1a,
318 318 plabel1=label1a,
319 319 parent2=path1b,
320 320 plabel2=label1b,
321 321 child=path2,
322 322 clabel=label2,
323 323 )
324 324
325 325 if confirm or not guitool:
326 326 # Run the comparison program and wait for it to exit
327 327 # before we show the next file.
328 328 # This is because either we need to wait for confirmation
329 329 # from the user between each invocation, or because, as far
330 330 # as we know, the tool doesn't have a GUI, in which case
331 331 # we can't run multiple CLI programs at the same time.
332 332 ui.debug(
333 333 b'running %r in %s\n' % (pycompat.bytestr(curcmdline), tmproot)
334 334 )
335 335 ui.system(curcmdline, cwd=tmproot, blockedtag=b'extdiff')
336 336 else:
337 337 # Run the comparison program but don't wait, as we're
338 338 # going to rapid-fire each file diff and then wait on
339 339 # the whole group.
340 340 ui.debug(
341 341 b'running %r in %s (backgrounded)\n'
342 342 % (pycompat.bytestr(curcmdline), tmproot)
343 343 )
344 344 proc = _systembackground(curcmdline, cwd=tmproot)
345 345 waitprocs.append(proc)
346 346
347 347 if waitprocs:
348 348 with ui.timeblockedsection(b'extdiff'):
349 349 for proc in waitprocs:
350 350 proc.wait()
351 351
352 352
353 353 def diffpatch(ui, repo, node1a, node2, tmproot, matcher, cmdline, do3way):
354 354 template = b'hg-%h.patch'
355 355 with formatter.nullformatter(ui, b'extdiff', {}) as fm:
356 356 cmdutil.export(
357 357 repo,
358 358 [repo[node1a].rev(), repo[node2].rev()],
359 359 fm,
360 360 fntemplate=repo.vfs.reljoin(tmproot, template),
361 361 match=matcher,
362 362 )
363 363 label1a = cmdutil.makefilename(repo[node1a], template)
364 364 label2 = cmdutil.makefilename(repo[node2], template)
365 365 dir1a = repo.vfs.reljoin(tmproot, label1a)
366 366 dir2 = repo.vfs.reljoin(tmproot, label2)
367 367 dir1b = None
368 368 label1b = None
369 369 cmdline = formatcmdline(
370 370 cmdline,
371 371 repo.root,
372 372 do3way=do3way,
373 373 parent1=dir1a,
374 374 plabel1=label1a,
375 375 parent2=dir1b,
376 376 plabel2=label1b,
377 377 child=dir2,
378 378 clabel=label2,
379 379 )
380 380 ui.debug(b'running %r in %s\n' % (pycompat.bytestr(cmdline), tmproot))
381 381 ui.system(cmdline, cwd=tmproot, blockedtag=b'extdiff')
382 382 return 1
383 383
384 384
385 def dodiff(ui, repo, cmdline, pats, opts, guitool=False):
386 '''Do the actual diff:
387
388 - copy to a temp structure if diffing 2 internal revisions
389 - copy to a temp structure if diffing working revision with
390 another one and more than 1 file is changed
391 - just invoke the diff for a single file in the working dir
392 '''
393
394 cmdutil.check_at_most_one_arg(opts, b'rev', b'change')
395 revs = opts.get(b'rev')
396 change = opts.get(b'change')
397 do3way = b'$parent2' in cmdline
398
399 if change:
400 ctx2 = scmutil.revsingle(repo, change, None)
401 ctx1a, ctx1b = ctx2.p1(), ctx2.p2()
402 else:
403 ctx1a, ctx2 = scmutil.revpair(repo, revs)
404 if not revs:
405 ctx1b = repo[None].p2()
406 else:
407 ctx1b = repo[nullid]
408
409 perfile = opts.get(b'per_file')
410 confirm = opts.get(b'confirm')
411
412 node1a = ctx1a.node()
413 node1b = ctx1b.node()
414 node2 = ctx2.node()
415
416 # Disable 3-way merge if there is only one parent
417 if do3way:
418 if node1b == nullid:
419 do3way = False
385 def diffrevs(
386 ui,
387 repo,
388 node1a,
389 node1b,
390 node2,
391 matcher,
392 tmproot,
393 cmdline,
394 do3way,
395 guitool,
396 opts,
397 ):
420 398
421 399 subrepos = opts.get(b'subrepos')
422
423 matcher = scmutil.match(repo[node2], pats, opts)
424
425 if opts.get(b'patch'):
426 if subrepos:
427 raise error.Abort(_(b'--patch cannot be used with --subrepos'))
428 if perfile:
429 raise error.Abort(_(b'--patch cannot be used with --per-file'))
430 if node2 is None:
431 raise error.Abort(_(b'--patch requires two revisions'))
432 else:
433 400 st = repo.status(node1a, node2, matcher, listsubrepos=subrepos)
434 401 mod_a, add_a, rem_a = set(st.modified), set(st.added), set(st.removed)
435 402 if do3way:
436 403 stb = repo.status(node1b, node2, matcher, listsubrepos=subrepos)
437 404 mod_b, add_b, rem_b = (
438 405 set(stb.modified),
439 406 set(stb.added),
440 407 set(stb.removed),
441 408 )
442 409 else:
443 410 mod_b, add_b, rem_b = set(), set(), set()
444 411 modadd = mod_a | add_a | mod_b | add_b
445 412 common = modadd | rem_a | rem_b
446 413 if not common:
447 414 return 0
448
449 tmproot = pycompat.mkdtemp(prefix=b'extdiff.')
450 try:
451 if opts.get(b'patch'):
452 return diffpatch(
453 ui, repo, node1a, node2, tmproot, matcher, cmdline, do3way
454 )
455
456 415 # Always make a copy of node1a (and node1b, if applicable)
457 416 dir1a_files = mod_a | rem_a | ((mod_b | add_b) - add_a)
458 417 dir1a = snapshot(ui, repo, dir1a_files, node1a, tmproot, subrepos)[0]
459 418 rev1a = b'@%d' % repo[node1a].rev()
460 419 if do3way:
461 420 dir1b_files = mod_b | rem_b | ((mod_a | add_a) - add_b)
462 dir1b = snapshot(ui, repo, dir1b_files, node1b, tmproot, subrepos)[
463 0
464 ]
421 dir1b = snapshot(ui, repo, dir1b_files, node1b, tmproot, subrepos)[0]
465 422 rev1b = b'@%d' % repo[node1b].rev()
466 423 else:
467 424 dir1b = None
468 425 rev1b = b''
469 426
470 427 fnsandstat = []
471 428
472 429 # If node2 in not the wc or there is >1 change, copy it
473 430 dir2root = b''
474 431 rev2 = b''
475 432 if node2:
476 433 dir2 = snapshot(ui, repo, modadd, node2, tmproot, subrepos)[0]
477 434 rev2 = b'@%d' % repo[node2].rev()
478 435 elif len(common) > 1:
479 436 # we only actually need to get the files to copy back to
480 437 # the working dir in this case (because the other cases
481 438 # are: diffing 2 revisions or single file -- in which case
482 439 # the file is already directly passed to the diff tool).
483 dir2, fnsandstat = snapshot(
484 ui, repo, modadd, None, tmproot, subrepos
485 )
440 dir2, fnsandstat = snapshot(ui, repo, modadd, None, tmproot, subrepos)
486 441 else:
487 442 # This lets the diff tool open the changed file directly
488 443 dir2 = b''
489 444 dir2root = repo.root
490 445
491 446 label1a = rev1a
492 447 label1b = rev1b
493 448 label2 = rev2
494 449
495 450 # If only one change, diff the files instead of the directories
496 451 # Handle bogus modifies correctly by checking if the files exist
497 452 if len(common) == 1:
498 453 common_file = util.localpath(common.pop())
499 454 dir1a = os.path.join(tmproot, dir1a, common_file)
500 455 label1a = common_file + rev1a
501 456 if not os.path.isfile(dir1a):
502 457 dir1a = pycompat.osdevnull
503 458 if do3way:
504 459 dir1b = os.path.join(tmproot, dir1b, common_file)
505 460 label1b = common_file + rev1b
506 461 if not os.path.isfile(dir1b):
507 462 dir1b = pycompat.osdevnull
508 463 dir2 = os.path.join(dir2root, dir2, common_file)
509 464 label2 = common_file + rev2
510 465
511 if not perfile:
466 if not opts.get(b'per_file'):
512 467 # Run the external tool on the 2 temp directories or the patches
513 468 cmdline = formatcmdline(
514 469 cmdline,
515 470 repo.root,
516 471 do3way=do3way,
517 472 parent1=dir1a,
518 473 plabel1=label1a,
519 474 parent2=dir1b,
520 475 plabel2=label1b,
521 476 child=dir2,
522 477 clabel=label2,
523 478 )
524 ui.debug(
525 b'running %r in %s\n' % (pycompat.bytestr(cmdline), tmproot)
526 )
479 ui.debug(b'running %r in %s\n' % (pycompat.bytestr(cmdline), tmproot))
527 480 ui.system(cmdline, cwd=tmproot, blockedtag=b'extdiff')
528 481 else:
529 482 # Run the external tool once for each pair of files
530 483 _runperfilediff(
531 484 cmdline,
532 485 repo.root,
533 486 ui,
534 487 guitool=guitool,
535 488 do3way=do3way,
536 confirm=confirm,
489 confirm=opts.get(b'confirm'),
537 490 commonfiles=common,
538 491 tmproot=tmproot,
539 492 dir1a=dir1a,
540 493 dir1b=dir1b,
541 494 dir2root=dir2root,
542 495 dir2=dir2,
543 496 rev1a=rev1a,
544 497 rev1b=rev1b,
545 498 rev2=rev2,
546 499 )
547 500
548 501 for copy_fn, working_fn, st in fnsandstat:
549 502 cpstat = os.lstat(copy_fn)
550 503 # Some tools copy the file and attributes, so mtime may not detect
551 504 # all changes. A size check will detect more cases, but not all.
552 505 # The only certain way to detect every case is to diff all files,
553 506 # which could be expensive.
554 507 # copyfile() carries over the permission, so the mode check could
555 508 # be in an 'elif' branch, but for the case where the file has
556 509 # changed without affecting mtime or size.
557 510 if (
558 511 cpstat[stat.ST_MTIME] != st[stat.ST_MTIME]
559 512 or cpstat.st_size != st.st_size
560 513 or (cpstat.st_mode & 0o100) != (st.st_mode & 0o100)
561 514 ):
562 515 ui.debug(
563 516 b'file changed while diffing. '
564 517 b'Overwriting: %s (src: %s)\n' % (working_fn, copy_fn)
565 518 )
566 519 util.copyfile(copy_fn, working_fn)
567 520
568 521 return 1
522
523
524 def dodiff(ui, repo, cmdline, pats, opts, guitool=False):
525 '''Do the actual diff:
526
527 - copy to a temp structure if diffing 2 internal revisions
528 - copy to a temp structure if diffing working revision with
529 another one and more than 1 file is changed
530 - just invoke the diff for a single file in the working dir
531 '''
532
533 cmdutil.check_at_most_one_arg(opts, b'rev', b'change')
534 revs = opts.get(b'rev')
535 change = opts.get(b'change')
536 do3way = b'$parent2' in cmdline
537
538 if change:
539 ctx2 = scmutil.revsingle(repo, change, None)
540 ctx1a, ctx1b = ctx2.p1(), ctx2.p2()
541 else:
542 ctx1a, ctx2 = scmutil.revpair(repo, revs)
543 if not revs:
544 ctx1b = repo[None].p2()
545 else:
546 ctx1b = repo[nullid]
547
548 node1a = ctx1a.node()
549 node1b = ctx1b.node()
550 node2 = ctx2.node()
551
552 # Disable 3-way merge if there is only one parent
553 if do3way:
554 if node1b == nullid:
555 do3way = False
556
557 matcher = scmutil.match(repo[node2], pats, opts)
558
559 if opts.get(b'patch'):
560 if opts.get(b'subrepos'):
561 raise error.Abort(_(b'--patch cannot be used with --subrepos'))
562 if opts.get(b'per_file'):
563 raise error.Abort(_(b'--patch cannot be used with --per-file'))
564 if node2 is None:
565 raise error.Abort(_(b'--patch requires two revisions'))
566
567 tmproot = pycompat.mkdtemp(prefix=b'extdiff.')
568 try:
569 if opts.get(b'patch'):
570 return diffpatch(
571 ui, repo, node1a, node2, tmproot, matcher, cmdline, do3way
572 )
573
574 return diffrevs(
575 ui,
576 repo,
577 node1a,
578 node1b,
579 node2,
580 matcher,
581 tmproot,
582 cmdline,
583 do3way,
584 guitool,
585 opts,
586 )
587
569 588 finally:
570 589 ui.note(_(b'cleaning up temp directory\n'))
571 590 shutil.rmtree(tmproot)
572 591
573 592
574 593 extdiffopts = (
575 594 [
576 595 (
577 596 b'o',
578 597 b'option',
579 598 [],
580 599 _(b'pass option to comparison program'),
581 600 _(b'OPT'),
582 601 ),
583 602 (b'r', b'rev', [], _(b'revision'), _(b'REV')),
584 603 (b'c', b'change', b'', _(b'change made by revision'), _(b'REV')),
585 604 (
586 605 b'',
587 606 b'per-file',
588 607 False,
589 608 _(b'compare each file instead of revision snapshots'),
590 609 ),
591 610 (
592 611 b'',
593 612 b'confirm',
594 613 False,
595 614 _(b'prompt user before each external program invocation'),
596 615 ),
597 616 (b'', b'patch', None, _(b'compare patches for two revisions')),
598 617 ]
599 618 + cmdutil.walkopts
600 619 + cmdutil.subrepoopts
601 620 )
602 621
603 622
604 623 @command(
605 624 b'extdiff',
606 625 [(b'p', b'program', b'', _(b'comparison program to run'), _(b'CMD')),]
607 626 + extdiffopts,
608 627 _(b'hg extdiff [OPT]... [FILE]...'),
609 628 helpcategory=command.CATEGORY_FILE_CONTENTS,
610 629 inferrepo=True,
611 630 )
612 631 def extdiff(ui, repo, *pats, **opts):
613 632 '''use external program to diff repository (or selected files)
614 633
615 634 Show differences between revisions for the specified files, using
616 635 an external program. The default program used is diff, with
617 636 default options "-Npru".
618 637
619 638 To select a different program, use the -p/--program option. The
620 639 program will be passed the names of two directories to compare,
621 640 unless the --per-file option is specified (see below). To pass
622 641 additional options to the program, use -o/--option. These will be
623 642 passed before the names of the directories or files to compare.
624 643
625 644 When two revision arguments are given, then changes are shown
626 645 between those revisions. If only one revision is specified then
627 646 that revision is compared to the working directory, and, when no
628 647 revisions are specified, the working directory files are compared
629 648 to its parent.
630 649
631 650 The --per-file option runs the external program repeatedly on each
632 651 file to diff, instead of once on two directories. By default,
633 652 this happens one by one, where the next file diff is open in the
634 653 external program only once the previous external program (for the
635 654 previous file diff) has exited. If the external program has a
636 655 graphical interface, it can open all the file diffs at once instead
637 656 of one by one. See :hg:`help -e extdiff` for information about how
638 657 to tell Mercurial that a given program has a graphical interface.
639 658
640 659 The --confirm option will prompt the user before each invocation of
641 660 the external program. It is ignored if --per-file isn't specified.
642 661 '''
643 662 opts = pycompat.byteskwargs(opts)
644 663 program = opts.get(b'program')
645 664 option = opts.get(b'option')
646 665 if not program:
647 666 program = b'diff'
648 667 option = option or [b'-Npru']
649 668 cmdline = b' '.join(map(procutil.shellquote, [program] + option))
650 669 return dodiff(ui, repo, cmdline, pats, opts)
651 670
652 671
653 672 class savedcmd(object):
654 673 """use external program to diff repository (or selected files)
655 674
656 675 Show differences between revisions for the specified files, using
657 676 the following program::
658 677
659 678 %(path)s
660 679
661 680 When two revision arguments are given, then changes are shown
662 681 between those revisions. If only one revision is specified then
663 682 that revision is compared to the working directory, and, when no
664 683 revisions are specified, the working directory files are compared
665 684 to its parent.
666 685 """
667 686
668 687 def __init__(self, path, cmdline, isgui):
669 688 # We can't pass non-ASCII through docstrings (and path is
670 689 # in an unknown encoding anyway), but avoid double separators on
671 690 # Windows
672 691 docpath = stringutil.escapestr(path).replace(b'\\\\', b'\\')
673 692 self.__doc__ %= {'path': pycompat.sysstr(stringutil.uirepr(docpath))}
674 693 self._cmdline = cmdline
675 694 self._isgui = isgui
676 695
677 696 def __call__(self, ui, repo, *pats, **opts):
678 697 opts = pycompat.byteskwargs(opts)
679 698 options = b' '.join(map(procutil.shellquote, opts[b'option']))
680 699 if options:
681 700 options = b' ' + options
682 701 return dodiff(
683 702 ui, repo, self._cmdline + options, pats, opts, guitool=self._isgui
684 703 )
685 704
686 705
687 706 def uisetup(ui):
688 707 for cmd, path in ui.configitems(b'extdiff'):
689 708 path = util.expandpath(path)
690 709 if cmd.startswith(b'cmd.'):
691 710 cmd = cmd[4:]
692 711 if not path:
693 712 path = procutil.findexe(cmd)
694 713 if path is None:
695 714 path = filemerge.findexternaltool(ui, cmd) or cmd
696 715 diffopts = ui.config(b'extdiff', b'opts.' + cmd)
697 716 cmdline = procutil.shellquote(path)
698 717 if diffopts:
699 718 cmdline += b' ' + diffopts
700 719 isgui = ui.configbool(b'extdiff', b'gui.' + cmd)
701 720 elif cmd.startswith(b'opts.') or cmd.startswith(b'gui.'):
702 721 continue
703 722 else:
704 723 if path:
705 724 # case "cmd = path opts"
706 725 cmdline = path
707 726 diffopts = len(pycompat.shlexsplit(cmdline)) > 1
708 727 else:
709 728 # case "cmd ="
710 729 path = procutil.findexe(cmd)
711 730 if path is None:
712 731 path = filemerge.findexternaltool(ui, cmd) or cmd
713 732 cmdline = procutil.shellquote(path)
714 733 diffopts = False
715 734 isgui = ui.configbool(b'extdiff', b'gui.' + cmd)
716 735 # look for diff arguments in [diff-tools] then [merge-tools]
717 736 if not diffopts:
718 737 key = cmd + b'.diffargs'
719 738 for section in (b'diff-tools', b'merge-tools'):
720 739 args = ui.config(section, key)
721 740 if args:
722 741 cmdline += b' ' + args
723 742 if isgui is None:
724 743 isgui = ui.configbool(section, cmd + b'.gui') or False
725 744 break
726 745 command(
727 746 cmd,
728 747 extdiffopts[:],
729 748 _(b'hg %s [OPTION]... [FILE]...') % cmd,
730 749 helpcategory=command.CATEGORY_FILE_CONTENTS,
731 750 inferrepo=True,
732 751 )(savedcmd(path, cmdline, isgui))
733 752
734 753
735 754 # tell hggettext to extract docstrings from these functions:
736 755 i18nfunctions = [savedcmd]
General Comments 0
You need to be logged in to leave comments. Login now