1 ;;; ediff-diff.el --- diff-related utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
29 (defvar ediff-default-variant)
32 (let ((load-path (cons (expand-file-name ".") load-path)))
33 (or (featurep 'ediff-init)
34 (load "ediff-init.el" nil nil 'nosuffix))
35 (or (featurep 'ediff-util)
36 (load "ediff-util.el" nil nil 'nosuffix))
42 (defgroup ediff-diff nil
43 "Diff related utilities"
48 (defcustom ediff-shell
49 (cond ((eq system-type 'emx) "cmd") ; OS/2
50 ((memq system-type '(ms-dos windows-nt windows-95))
51 shell-file-name) ; no standard name on MS-DOS
52 ((memq system-type '(vax-vms axp-vms)) "*dcl*") ; VMS
54 "*The shell used to run diff and patch. If user's .profile or
55 .cshrc files are set up correctly, any shell will do. However, some people
56 set $prompt or other things incorrectly, which leads to undesirable output
57 messages. These may cause Ediff to fail. In such a case, set ediff-shell
58 to a shell that you are not using or, better, fix your shell's startup file."
62 (defcustom ediff-cmp-program "cmp"
63 "*Utility to use to determine if two files are identical.
64 It must return code 0, if its arguments are identical files."
68 (defcustom ediff-diff-program "diff"
69 "*Program to use for generating the differential of the two files."
72 (defcustom ediff-diff-options ""
73 "*Options to pass to `ediff-diff-program'.
74 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
75 `-w', to ignore space, and `-i', to ignore case of letters.
76 At present, the option `-c' is not allowed."
80 (defcustom ediff-custom-diff-program ediff-diff-program
81 "*Program to use for generating custom diff output for saving it in a file.
82 This output is not used by Ediff internally."
85 (defcustom ediff-custom-diff-options "-c"
86 "*Options to pass to `ediff-custom-diff-program'."
92 (defvar ediff-match-diff3-line "^====\\(.?\\)$"
93 "Pattern to match lines produced by diff3 that describe differences.")
94 (defcustom ediff-diff3-program "diff3"
95 "*Program to be used for three-way comparison.
96 Must produce output compatible with Unix's diff3 program."
99 (defcustom ediff-diff3-options ""
100 "*Options to pass to `ediff-diff3-program'."
103 (defcustom ediff-diff3-ok-lines-regexp
104 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
105 "*Regexp that matches normal output lines from `ediff-diff3-program'.
106 Lines that do not match are assumed to be error messages."
110 ;; keeps the status of the current diff in 3-way jobs.
111 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
112 (ediff-defvar-local ediff-diff-status "" "")
117 (ediff-defvar-local ediff-auto-refine (if (ediff-has-face-support-p) 'on 'nix)
118 "If `on', Ediff auto-highlights fine diffs for the current diff region.
119 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
120 at all, unless the user force-refines the region by hitting `*'.
122 This variable can be set either in .emacs or toggled interactively.
123 Use `setq-default' if setting it in .emacs")
125 (ediff-defvar-local ediff-ignore-similar-regions nil
126 "*If t, skip over difference regions that differ only in the white space and line breaks.
127 This variable can be set either in .emacs or toggled interactively.
128 Use `setq-default' if setting it in .emacs")
130 (ediff-defvar-local ediff-auto-refine-limit 1400
131 "*Auto-refine only the regions of this size \(in bytes\) or less.")
135 (defvar ediff-diff-ok-lines-regexp
138 "[0-9,]+[acd][0-9,]+\C-m?$"
143 "\\|.*missing +newline"
146 "Regexp that matches normal output lines from `ediff-diff-program'.
147 This is mostly lifted from Emerge, except that Ediff also considers
148 warnings and `Missing newline'-type messages to be normal output.
149 Lines that do not match are assumed to be error messages.")
151 (defvar ediff-match-diff-line
152 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
153 (concat "^" x "\\([acd]\\)" x "\C-m?$"))
154 "Pattern to match lines produced by diff that describe differences.")
156 (ediff-defvar-local ediff-setup-diff-regions-function nil
157 "value is a function symbol depending on the kind of job is to be done.
158 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
159 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
161 The function should take three mandatory arguments, file-A, file-B, and
162 file-C. It may ignore file C for diff2 jobs. It should also take
163 one optional arguments, diff-number to refine.")
168 ;; Generate the difference vector and overlays for the two files
169 ;; With optional arg REG-TO-REFINE, refine this region.
170 ;; File-C argument is not used here. It is there just because
171 ;; ediff-setup-diff-regions is called via a funcall to
172 ;; ediff-setup-diff-regions-function, which can also have the value
173 ;; ediff-setup-diff-regions3, which takes 4 arguments.
174 (defun ediff-setup-diff-regions (file-A file-B file-C)
175 (if (string-match "c" ediff-diff-options)
176 (error "Option `-c' is not allowed in `ediff-diff-options'"))
178 ;; create, if it doesn't exist
179 (or (ediff-buffer-live-p ediff-diff-buffer)
180 (setq ediff-diff-buffer
181 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
182 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B)
183 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer)
184 (ediff-convert-diffs-to-overlays
186 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds)))
188 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
189 ;; Return the size of DIFF-BUFFER
190 (defun ediff-make-diff2-buffer (diff-buffer file1 file2)
191 (let ((file1-size (ediff-file-size file1))
192 (file2-size (ediff-file-size file2)))
193 (cond ((not (numberp file1-size))
194 (message "Can't find file: %s"
195 (ediff-abbreviate-file-name file1))
197 ;; 1 is an error exit code
199 ((not (numberp file2-size))
200 (message "Can't find file: %s"
201 (ediff-abbreviate-file-name file2))
203 ;; 1 is an error exit code
206 (message "Can't diff remote files: %s"
207 (ediff-abbreviate-file-name file1))
209 ;; 1 is an error exit code
212 (message "Can't diff remote file: %s"
213 (ediff-abbreviate-file-name file2))
216 ;; 1 is an error exit code
218 (t (message "Computing differences between %s and %s ..."
219 (file-name-nondirectory file1)
220 (file-name-nondirectory file2))
221 ;; this erases the diff buffer automatically
222 (ediff-exec-process ediff-diff-program
225 ediff-diff-options file1 file2)
227 (ediff-with-current-buffer diff-buffer
232 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
233 ;; This function works for diff3 and diff2 jobs
234 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num)
235 (or (ediff-buffer-live-p ediff-fine-diff-buffer)
236 (setq ediff-fine-diff-buffer
238 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
240 (let (diff3-job diff-program diff-options ok-regexp diff-list)
241 (setq diff3-job ediff-3way-job
242 diff-program (if diff3-job ediff-diff3-program ediff-diff-program)
243 diff-options (if diff3-job ediff-diff3-options ediff-diff-options)
244 ok-regexp (if diff3-job
245 ediff-diff3-ok-lines-regexp
246 ediff-diff-ok-lines-regexp))
248 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num))
249 (ediff-exec-process diff-program ediff-fine-diff-buffer 'synchronize
251 ;; The shuffle below is because we can compare 3-way
252 ;; or in several 2-way fashions, like fA fC, fA fB,
254 (if file-A file-A file-B)
255 (if file-B file-B file-A)
257 (if file-C file-C file-B))
260 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer)
261 (ediff-message-if-verbose
263 ;; "Refining difference region %d ... done" (1+ reg-num))
267 (ediff-extract-diffs3
268 ediff-fine-diff-buffer '3way-comparison 'word-mode)
269 (ediff-extract-diffs ediff-fine-diff-buffer 'word-mode)))
273 (mapcar (function (lambda (elt)
278 (mapcar (function (lambda (elt)
283 (mapcar (function (lambda (elt)
289 (ediff-convert-fine-diffs-to-overlays diff-list reg-num)
293 (defun ediff-prepare-error-list (ok-regexp diff-buff)
294 (or (ediff-buffer-live-p ediff-error-buffer)
295 (setq ediff-error-buffer
296 (get-buffer-create (ediff-unique-buffer-name
297 "*ediff-errors" "*"))))
298 (ediff-with-current-buffer ediff-error-buffer
300 (insert (ediff-with-current-buffer diff-buff (buffer-string)))
301 (goto-char (point-min))
302 (delete-matching-lines ok-regexp)
303 (if (memq system-type '(vax-vms axp-vms))
304 (delete-matching-lines "^$")))
305 ;; If diff reports errors, show them then quit.
306 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer (buffer-size)))
307 (let ((ctl-buf ediff-control-buffer)
308 (error-buf ediff-error-buffer))
309 (ediff-skip-unsuitable-frames)
310 (switch-to-buffer error-buf)
311 (ediff-kill-buffer-carefully ctl-buf)
312 (error "Errors in diff output. Diff output is in %S" diff-buff))))
314 ;; BOUNDS specifies visibility bounds to use.
315 ;; WORD-MODE tells whether we are in the word-mode or not.
316 ;; If WORD-MODE, also construct vector of diffs using word numbers.
317 ;; Else, use point values.
318 ;; This function handles diff-2 jobs including the case of
319 ;; merging buffers and files without ancestor.
320 (defun ediff-extract-diffs (diff-buffer word-mode &optional bounds)
321 (let ((A-buffer ediff-buffer-A)
322 (B-buffer ediff-buffer-B)
323 (C-buffer ediff-buffer-C)
324 (a-prev 1) ; this is needed to set the first diff line correctly
327 diff-list shift-A shift-B
330 ;; diff list contains word numbers, unless changed later
331 (setq diff-list (cons (if word-mode 'words 'points)
333 ;; we don't use visibility bounds for buffer C when merging
337 (ediff-get-value-according-to-buffer-type 'A bounds))
340 (ediff-get-value-according-to-buffer-type 'B bounds))))
342 ;; reset point in buffers A/B/C
343 (ediff-with-current-buffer A-buffer
344 (goto-char (if shift-A shift-A (point-min))))
345 (ediff-with-current-buffer B-buffer
346 (goto-char (if shift-B shift-B (point-min))))
347 (if (ediff-buffer-live-p C-buffer)
348 (ediff-with-current-buffer C-buffer
349 (goto-char (point-min))))
351 (ediff-with-current-buffer diff-buffer
352 (goto-char (point-min))
353 (while (re-search-forward ediff-match-diff-line nil t)
354 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
356 (a-end (let ((b (match-beginning 3))
359 (string-to-int (buffer-substring b e))
361 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
362 (b-begin (string-to-int (buffer-substring (match-beginning 5)
364 (b-end (let ((b (match-beginning 7))
367 (string-to-int (buffer-substring b e))
369 a-begin-pt a-end-pt b-begin-pt b-end-pt
370 c-begin c-end c-begin-pt c-end-pt)
371 ;; fix the beginning and end numbers, because diff is somewhat
372 ;; strange about how it numbers lines
373 (if (string-equal diff-type "a")
374 (setq b-end (1+ b-end)
377 (if (string-equal diff-type "d")
378 (setq a-end (1+ a-end)
381 ;; (string-equal diff-type "c")
382 (setq a-end (1+ a-end)
385 (if (eq ediff-default-variant 'default-B)
386 (setq c-begin b-begin
388 (setq c-begin a-begin
391 ;; compute main diff vector
393 ;; make diff-list contain word numbers
397 (if (ediff-buffer-live-p C-buffer)
398 (vector (- a-begin a-prev) (- a-end a-begin)
399 (- b-begin b-prev) (- b-end b-begin)
400 (- c-begin c-prev) (- c-end c-begin)
401 nil nil ; dummy ancestor
404 nil ; state of ancestor
406 (vector (- a-begin a-prev) (- a-end a-begin)
407 (- b-begin b-prev) (- b-end b-begin)
408 nil nil ; dummy buf C
409 nil nil ; dummy ancestor
412 nil ; state of ancestor
418 ;; else convert lines to points
419 (ediff-with-current-buffer A-buffer
420 (forward-line (- a-begin a-prev))
421 (setq a-begin-pt (point))
422 (forward-line (- a-end a-begin))
423 (setq a-end-pt (point)
425 (ediff-with-current-buffer B-buffer
426 (forward-line (- b-begin b-prev))
427 (setq b-begin-pt (point))
428 (forward-line (- b-end b-begin))
429 (setq b-end-pt (point)
431 (if (ediff-buffer-live-p C-buffer)
432 (ediff-with-current-buffer C-buffer
433 (forward-line (- c-begin c-prev))
434 (setq c-begin-pt (point))
435 (forward-line (- c-end c-begin))
436 (setq c-end-pt (point)
442 (if (ediff-buffer-live-p C-buffer)
444 a-begin-pt a-end-pt b-begin-pt b-end-pt
446 nil nil ; dummy ancestor
448 ;; shows which buff is different from the other two
449 (if (eq ediff-default-variant 'default-B) 'A 'B)
450 ediff-default-variant ; state of merge
451 nil ; state of ancestor
453 (vector a-begin-pt a-end-pt
455 nil nil ; dummy buf C
456 nil nil ; dummy ancestor
457 nil nil ; dummy state of diff & merge
458 nil ; dummy state of ancestor
462 ))) ; end ediff-with-current-buffer
467 (defun ediff-convert-diffs-to-overlays (diff-list)
468 (ediff-set-diff-overlays-in-one-buffer 'A diff-list)
469 (ediff-set-diff-overlays-in-one-buffer 'B diff-list)
471 (ediff-set-diff-overlays-in-one-buffer 'C diff-list))
472 (if ediff-merge-with-ancestor-job
473 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list))
474 ;; set up vector showing the status of merge regions
476 (setq ediff-state-of-merge
480 (let ((state-of-merge (aref elt 9))
481 (state-of-ancestor (aref elt 10)))
483 (if state-of-merge (format "%S" state-of-merge))
484 state-of-ancestor))))
485 ;; the first elt designates type of list
488 (message "Processing difference regions ... done"))
491 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list)
492 (let* ((current-diff -1)
493 (buff (ediff-get-buffer buf-type))
494 ;; ediff-extract-diffs puts the type of diff-list as the first elt
495 ;; of this list. The type is either 'points or 'words
496 (diff-list-type (car diff-list))
497 (shift (ediff-overlay-start
498 (ediff-get-value-according-to-buffer-type
499 buf-type ediff-narrow-bounds)))
500 (limit (ediff-overlay-end
501 (ediff-get-value-according-to-buffer-type
502 buf-type ediff-narrow-bounds)))
503 diff-overlay-list list-element total-diffs
504 begin end pt-saved overlay state-of-diff)
506 (setq diff-list (cdr diff-list)) ; discard diff list type
507 (setq total-diffs (length diff-list))
509 ;; shift, if necessary
510 (ediff-with-current-buffer buff (setq pt-saved shift))
513 (setq current-diff (1+ current-diff)
514 list-element (car diff-list)
515 begin (aref list-element (cond ((eq buf-type 'A) 0)
519 end (aref list-element (cond ((eq buf-type 'A) 1)
523 state-of-diff (aref list-element 8)
526 (cond ((and (not (eq buf-type state-of-diff))
527 (not (eq buf-type 'Ancestor))
528 (memq state-of-diff '(A B C)))
530 (car (delq buf-type (delq state-of-diff (list 'A 'B 'C)))))
531 (setq state-of-diff (format "=diff(%S)" state-of-diff))
533 (t (setq state-of-diff nil)))
535 ;; Put overlays at appropriate places in buffer
536 ;; convert word numbers to points, if necessary
537 (if (eq diff-list-type 'words)
539 (ediff-with-current-buffer buff (goto-char pt-saved))
540 (setq begin (ediff-goto-word (1+ begin) buff)
541 end (ediff-goto-word end buff 'end))
542 (if (> end limit) (setq end limit))
543 (if (> begin end) (setq begin end))
544 (setq pt-saved (ediff-with-current-buffer buff (point)))))
545 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
547 (ediff-overlay-put overlay 'priority ediff-shadow-overlay-priority)
548 (ediff-overlay-put overlay 'ediff-diff-num current-diff)
549 (if (and (ediff-has-face-support-p)
550 ediff-use-faces ediff-highlight-all-diffs)
551 (ediff-set-overlay-face
552 overlay (ediff-background-face buf-type current-diff)))
554 (if (= 0 (mod current-diff 10))
555 (message "Buffer %S: Processing difference region %d of %d"
556 buf-type current-diff total-diffs))
557 ;; record all overlays for this difference
558 ;; the second elt, nil, is a place holder for the fine diff vector.
559 ;; the third elt, nil, is a place holder for no-fine-diffs flag.
560 (setq diff-overlay-list
563 (list (vector overlay nil nil state-of-diff)))
568 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist)
569 (vconcat diff-overlay-list))
572 ;; `n' is the diff region to work on. Default is ediff-current-difference.
573 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
574 ;; diffs have not been computed before.
575 ;; if `flag' is 'skip then don't compute fine diffs for this region.
576 (defun ediff-make-fine-diffs (&optional n flag)
577 (or n (setq n ediff-current-difference))
579 (if (< ediff-number-of-differences 1)
580 (error ediff-NO-DIFFERENCES))
584 ediff-auto-refine 'nix))
587 (>= n ediff-number-of-differences)
588 ;; n is within the range
589 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
590 (file-A ediff-temp-file-A)
591 (file-B ediff-temp-file-B)
592 (file-C ediff-temp-file-C)
593 (empty-A (ediff-empty-diff-region-p n 'A))
594 (empty-B (ediff-empty-diff-region-p n 'B))
595 (empty-C (ediff-empty-diff-region-p n 'C))
596 (whitespace-A (ediff-whitespace-diff-region-p n 'A))
597 (whitespace-B (ediff-whitespace-diff-region-p n 'B))
598 (whitespace-C (ediff-whitespace-diff-region-p n 'C))
599 cumulative-fine-diff-length)
601 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
602 ;; then don't refine.
603 ;; If the region happens to be entirely whitespace or empty then
605 ((> (length (delq nil (list empty-A empty-B empty-C))) 1)
606 (if (and (ediff-looks-like-combined-merge n)
608 (ediff-set-fine-overlays-in-one-buffer 'C nil n))
609 (if ediff-3way-comparison-job
610 (ediff-message-if-verbose
611 "Region %d is empty in all buffers but %S"
613 (cond ((not empty-A) 'A)
616 (ediff-message-if-verbose
617 "Region %d in buffer %S is empty"
623 ;; if all regions happen to be whitespace
624 (if (and whitespace-A whitespace-B whitespace-C)
625 ;; mark as space only
626 (ediff-mark-diff-as-space-only n t)
627 ;; if some regions are white and others don't, then mark as
628 ;; non-white-space-only
629 (ediff-mark-diff-as-space-only n nil)))
631 ;; don't compute fine diffs if diff vector exists
632 ((and (eq flag 'noforce) (ediff-get-fine-diff-vector n 'A))
633 (if (ediff-no-fine-diffs-p n)
635 "Only white-space differences in region %d %s"
637 (cond ((eq (ediff-no-fine-diffs-p n) 'A)
639 ((eq (ediff-no-fine-diffs-p n) 'B)
641 ((eq (ediff-no-fine-diffs-p n) 'C)
644 ;; don't compute fine diffs for this region
646 (or (ediff-get-fine-diff-vector n 'A)
647 (memq ediff-auto-refine '(off nix))
648 (ediff-message-if-verbose
649 "Region %d exceeds auto-refine limit. Type `%s' to refine"
651 (substitute-command-keys
652 "\\[ediff-make-or-kill-fine-diffs]")
655 ;; recompute fine diffs
657 (ediff-get-diff-posn 'A 'beg n)
658 (ediff-get-diff-posn 'A 'end n)
661 ediff-control-buffer)
663 (ediff-make-temp-file tmp-buffer "fineDiffA" file-A))
666 (ediff-get-diff-posn 'B 'beg n)
667 (ediff-get-diff-posn 'B 'end n)
670 ediff-control-buffer)
672 (ediff-make-temp-file tmp-buffer "fineDiffB" file-B))
677 (ediff-get-diff-posn 'C 'beg n)
678 (ediff-get-diff-posn 'C 'end n)
681 ediff-control-buffer)
683 (ediff-make-temp-file
684 tmp-buffer "fineDiffC" file-C))))
686 ;; save temp file names.
687 (setq ediff-temp-file-A file-A
688 ediff-temp-file-B file-B
689 ediff-temp-file-C file-C)
691 ;; set the new vector of fine diffs, if none exists
692 (cond ((and ediff-3way-job whitespace-A)
693 (ediff-setup-fine-diff-regions nil file-B file-C n))
694 ((and ediff-3way-job whitespace-B)
695 (ediff-setup-fine-diff-regions file-A nil file-C n))
697 ;; In merge-jobs, whitespace-C is t, since
698 ;; ediff-empty-diff-region-p returns t in this case
700 (ediff-setup-fine-diff-regions file-A file-B nil n))
702 (ediff-setup-fine-diff-regions file-A file-B file-C n)))
704 (setq cumulative-fine-diff-length
705 (+ (length (ediff-get-fine-diff-vector n 'A))
706 (length (ediff-get-fine-diff-vector n 'B))
707 ;; in merge jobs, the merge buffer is never refined
708 (if (and file-C (not ediff-merge-job))
709 (length (ediff-get-fine-diff-vector n 'C))
713 ;; all regions are white space
714 (and whitespace-A whitespace-B whitespace-C)
715 ;; none is white space and no fine diffs detected
716 (and (not whitespace-A)
718 (not (and ediff-3way-job whitespace-C))
719 (eq cumulative-fine-diff-length 0)))
720 (ediff-mark-diff-as-space-only n t)
721 (ediff-message-if-verbose
722 "Only white-space differences in region %d" (1+ n)))
723 ((eq cumulative-fine-diff-length 0)
724 (ediff-message-if-verbose
725 "Only white-space differences in region %d %s"
727 (cond (whitespace-A (ediff-mark-diff-as-space-only n 'A)
729 (whitespace-B (ediff-mark-diff-as-space-only n 'B)
731 (whitespace-C (ediff-mark-diff-as-space-only n 'C)
732 "in buffers A & B"))))
734 (ediff-mark-diff-as-space-only n nil)))
737 (ediff-set-fine-diff-properties n)
740 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
741 (defun ediff-install-fine-diff-if-necessary (n)
742 (cond ((eq ediff-auto-refine 'on)
744 (> ediff-auto-refine-limit
745 (- (ediff-get-diff-posn 'A 'end n)
746 (ediff-get-diff-posn 'A 'beg n)))
747 (> ediff-auto-refine-limit
748 (- (ediff-get-diff-posn 'B 'end n)
749 (ediff-get-diff-posn 'B 'beg n))))
750 (ediff-make-fine-diffs n 'noforce)
751 (ediff-make-fine-diffs n 'skip)))
753 ;; highlight iff fine diffs already exist
754 ((eq ediff-auto-refine 'off)
755 (ediff-make-fine-diffs n 'skip))))
758 ;; if fine diff vector is not set for diff N, then do nothing
759 (defun ediff-set-fine-diff-properties (n &optional default)
760 (or (not (ediff-has-face-support-p))
762 (>= n ediff-number-of-differences)
763 ;; when faces are supported, set faces and priorities of fine overlays
765 (ediff-set-fine-diff-properties-in-one-buffer 'A n default)
766 (ediff-set-fine-diff-properties-in-one-buffer 'B n default)
768 (ediff-set-fine-diff-properties-in-one-buffer 'C n default)))))
770 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
772 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type))
776 (ediff-get-symbol-from-alist
777 buf-type ediff-fine-diff-face-alist))))
778 (priority (if default
780 (1+ (or (ediff-overlay-get
782 (ediff-get-symbol-from-alist
784 ediff-current-diff-overlay-alist))
788 (function (lambda (overl)
789 (ediff-set-overlay-face overl face)
790 (ediff-overlay-put overl 'priority priority)))
793 ;; This assumes buffer C and that the region looks like a combination of
794 ;; regions in buffer A and C.
795 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num)
796 (let (overlay1 overlay2 overlay3)
797 (setq overlay1 (ediff-make-bullet-proof-overlay (nth 0 diff-list)
800 overlay2 (ediff-make-bullet-proof-overlay (nth 2 diff-list)
803 overlay3 (ediff-make-bullet-proof-overlay (nth 4 diff-list)
806 (ediff-set-fine-diff-vector reg-num 'C (vector overlay1 overlay2 overlay3))
810 ;; Convert diff list to overlays for a given DIFF-REGION
811 ;; in buffer of type BUF-TYPE
812 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num)
813 (let* ((current-diff -1)
814 (reg-start (ediff-get-diff-posn buf-type 'beg region-num))
815 (buff (ediff-get-buffer buf-type))
816 combined-merge-diff-list
817 diff-overlay-list list-element
820 (ediff-clear-fine-differences-in-one-buffer region-num buf-type)
821 (setq diff-list (cdr diff-list)) ; discard list type (words or points)
822 (ediff-with-current-buffer buff (goto-char reg-start))
824 ;; if it is a combined merge then set overlays in buff C specially
825 (if (and ediff-merge-job (eq buf-type 'C)
826 (setq combined-merge-diff-list
827 (ediff-looks-like-combined-merge region-num)))
828 (ediff-set-fine-overlays-for-combined-merge
829 combined-merge-diff-list region-num)
832 (setq current-diff (1+ current-diff)
833 list-element (car diff-list)
834 begin (aref list-element (cond ((eq buf-type 'A) 0)
837 end (aref list-element (cond ((eq buf-type 'A) 1)
840 (if (not (or begin end))
842 ;; Put overlays at appropriate places in buffers
843 ;; convert lines to points, if necessary
844 (setq begin (ediff-goto-word (1+ begin) buff)
845 end (ediff-goto-word end buff 'end))
846 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
847 ;; record all overlays for this difference region
848 (setq diff-overlay-list (nconc diff-overlay-list (list overlay))))
850 (setq diff-list (cdr diff-list))
852 ;; convert the list of difference information into a vector
854 (ediff-set-fine-diff-vector
855 region-num buf-type (vconcat diff-overlay-list))
859 ;; Stolen from emerge.el
860 (defun ediff-get-diff3-group (file)
861 ;; This save-excursion allows ediff-get-diff3-group to be called for the
862 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
863 ;; appear in any order. The reason this is necessary is that Gnu diff3
864 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
867 (concat "^" file ":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
868 (beginning-of-line 2)
869 ;; treatment depends on whether it is an "a" group or a "c" group
870 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
872 (if (match-beginning 2)
873 ;; it has two numbers
875 (buffer-substring (match-beginning 1) (match-end 1)))
877 (buffer-substring (match-beginning 3) (match-end 3)))))
879 (let ((x (string-to-int
880 (buffer-substring (match-beginning 1) (match-end 1)))))
882 ;; it is an "a" group
883 (let ((x (1+ (string-to-int
884 (buffer-substring (match-beginning 1) (match-end 1))))))
888 ;; If WORD-MODE, construct vector of diffs using word numbers.
889 ;; Else, use point values.
890 ;; WORD-MODE also tells if we are in the word-mode or not.
891 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
892 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
893 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
895 ;; BOUNDS specifies visibility bounds to use.
896 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
898 (let ((A-buffer ediff-buffer-A)
899 (B-buffer ediff-buffer-B)
900 (C-buffer ediff-buffer-C)
901 (anc-buffer ediff-ancestor-buffer)
902 (a-prev 1) ; needed to set the first diff line correctly
906 diff-list shift-A shift-B shift-C
909 ;; diff list contains word numbers or points, depending on word-mode
910 (setq diff-list (cons (if word-mode 'words 'points)
915 (ediff-get-value-according-to-buffer-type 'A bounds))
918 (ediff-get-value-according-to-buffer-type 'B bounds))
922 (ediff-get-value-according-to-buffer-type 'C bounds)))))
924 ;; reset point in buffers A, B, C
925 (ediff-with-current-buffer A-buffer
926 (goto-char (if shift-A shift-A (point-min))))
927 (ediff-with-current-buffer B-buffer
928 (goto-char (if shift-B shift-B (point-min))))
930 (ediff-with-current-buffer C-buffer
931 (goto-char (if shift-C shift-C (point-min)))))
932 (if (ediff-buffer-live-p anc-buffer)
933 (ediff-with-current-buffer anc-buffer
934 (goto-char (point-min))))
936 (ediff-with-current-buffer diff-buffer
937 (goto-char (point-min))
938 (while (re-search-forward ediff-match-diff3-line nil t)
939 ;; leave point after matched line
940 (beginning-of-line 2)
941 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
942 ;; if the files A and B are the same and not 3way-comparison,
943 ;; ignore the difference
944 (if (or three-way-comp (not (string-equal agreement "3")))
945 (let* ((a-begin (car (ediff-get-diff3-group "1")))
946 (a-end (nth 1 (ediff-get-diff3-group "1")))
947 (b-begin (car (ediff-get-diff3-group "2")))
948 (b-end (nth 1 (ediff-get-diff3-group "2")))
949 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
950 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
952 (cond ((string-equal agreement "1") 'prefer-A)
953 ((string-equal agreement "2") 'prefer-B)
954 (t ediff-default-variant)))
956 (if (memq state-of-merge '(default-A prefer-A)) 'B 'A))
957 (state-of-diff-comparison
958 (cond ((string-equal agreement "1") 'A)
959 ((string-equal agreement "2") 'B)
960 ((string-equal agreement "3") 'C)))
966 anc-begin-pt anc-end-pt)
968 (setq state-of-ancestor
969 (= c-or-anc-begin c-or-anc-end))
971 (cond (three-way-comp
972 (setq c-begin c-or-anc-begin
974 ((eq ediff-default-variant 'default-B)
975 (setq c-begin b-begin
978 (setq c-begin a-begin
981 ;; compute main diff vector
983 ;; make diff-list contain word numbers
987 (- a-begin a-prev) (- a-end a-begin)
988 (- b-begin b-prev) (- b-end b-begin)
989 (- c-begin c-prev) (- c-end c-begin)
990 nil nil ; dummy ancestor
993 nil ; state of ancestor
998 ;; else convert lines to points
999 (ediff-with-current-buffer A-buffer
1000 (forward-line (- a-begin a-prev))
1001 (setq a-begin-pt (point))
1002 (forward-line (- a-end a-begin))
1003 (setq a-end-pt (point)
1005 (ediff-with-current-buffer B-buffer
1006 (forward-line (- b-begin b-prev))
1007 (setq b-begin-pt (point))
1008 (forward-line (- b-end b-begin))
1009 (setq b-end-pt (point)
1011 (ediff-with-current-buffer C-buffer
1012 (forward-line (- c-begin c-prev))
1013 (setq c-begin-pt (point))
1014 (forward-line (- c-end c-begin))
1015 (setq c-end-pt (point)
1017 (if (ediff-buffer-live-p anc-buffer)
1018 (ediff-with-current-buffer anc-buffer
1019 (forward-line (- c-or-anc-begin anc-prev))
1020 (setq anc-begin-pt (point))
1021 (forward-line (- c-or-anc-end c-or-anc-begin))
1022 (setq anc-end-pt (point)
1023 anc-prev c-or-anc-end)))
1027 ;; if comparing with ancestor, then there also is a
1028 ;; state-of-difference marker
1034 nil nil ; ancestor begin/end
1035 state-of-diff-comparison
1036 nil ; state of merge
1037 nil ; state of ancestor
1039 (list (vector a-begin-pt a-end-pt
1042 anc-begin-pt anc-end-pt
1050 ))) ; end ediff-with-current-buffer
1054 ;; Generate the difference vector and overlays for three files
1055 ;; File-C is either the third file to compare (in case of 3-way comparison)
1056 ;; or it is the ancestor file.
1057 (defun ediff-setup-diff-regions3 (file-A file-B file-C)
1058 (or (ediff-buffer-live-p ediff-diff-buffer)
1059 (setq ediff-diff-buffer
1060 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1062 (message "Computing differences ...")
1063 (ediff-exec-process ediff-diff3-program ediff-diff-buffer 'synchronize
1064 ediff-diff3-options file-A file-B file-C)
1066 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer)
1067 ;;(message "Computing differences ... done")
1068 (ediff-convert-diffs-to-overlays
1069 (ediff-extract-diffs3
1071 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds)
1075 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1076 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1077 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1078 ;; string. All elements in FILES must be strings. We also delete nil from
1080 (defun ediff-exec-process (program buffer synch options &rest files)
1081 (let ((data (match-data))
1083 (setq args (append (split-string options) files))
1084 (setq args (delete "" (delq nil args))) ; delete nil and "" from arguments
1086 (let ((directory default-directory)
1091 (setq default-directory directory)
1092 (if (or (memq system-type '(emx ms-dos windows-nt windows-95))
1094 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1095 ;; delete files used by other processes. Thus, in ediff-buffers
1096 ;; and similar functions, we can't delete temp files because
1097 ;; they might be used by the asynch process that computes
1098 ;; custom diffs. So, we have to wait till custom diff
1099 ;; subprocess is done.
1100 ;; Similarly for Windows-*
1101 ;; In DOS, must synchronize because DOS doesn't have
1102 ;; asynchronous processes.
1103 (apply 'call-process program nil buffer nil args)
1104 ;; On other systems, do it asynchronously.
1105 (setq proc (get-buffer-process buffer))
1106 (if proc (kill-process proc))
1108 (apply 'start-process "Custom Diff" buffer program args))
1109 (setq mode-line-process '(":%s"))
1110 (set-process-sentinel proc 'ediff-process-sentinel)
1111 (set-process-filter proc 'ediff-process-filter)
1113 (store-match-data data))))
1115 ;; This is shell-command-filter from simple.el in Emacs.
1116 ;; Copied here because XEmacs doesn't have it.
1117 (defun ediff-process-filter (proc string)
1118 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1119 ;; despite an insertion immediately after it.
1120 (let* ((obuf (current-buffer))
1121 (buffer (process-buffer proc))
1123 (window (get-buffer-window buffer))
1124 (pos (window-start window)))
1128 (or (= (point) (point-max))
1129 (setq opoint (point)))
1130 (goto-char (point-max))
1131 (insert-before-markers string))
1132 ;; insert-before-markers moved this marker: set it back.
1133 (set-window-start window pos)
1134 ;; Finish our save-excursion.
1137 (set-buffer obuf))))
1139 ;; like shell-command-sentinel but doesn't print an exit status message
1140 ;; we do this because diff always exits with status 1, if diffs are found
1141 ;; so shell-command-sentinel displays a confusing message to the user
1142 (defun ediff-process-sentinel (process signal)
1143 (if (and (memq (process-status process) '(exit signal))
1144 (buffer-name (process-buffer process)))
1147 (set-buffer (process-buffer process))
1148 (setq mode-line-process nil))
1149 (delete-process process))))
1152 ;;; Word functions used to refine the current diff
1154 (defvar ediff-forward-word-function 'ediff-forward-word
1155 "*Function to call to move to the next word.
1156 Used for splitting difference regions into individual words.")
1158 (defvar ediff-whitespace " \n\t\f"
1159 "*Characters constituting white space.
1160 These characters are ignored when differing regions are split into words.")
1162 ;;(defvar ediff-word-1 "a-zA-Z---_`'.?!:"
1163 (defvar ediff-word-1 "a-zA-Z---_"
1164 "*Characters that constitute words of type 1.
1165 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1166 See `ediff-forward-word' for more details.")
1168 (defvar ediff-word-2 "0-9.,"
1169 "*Characters that constitute words of type 2.
1170 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1171 See `ediff-forward-word' for more details.")
1173 (defvar ediff-word-3 "`'?!:;\"{}[]()"
1174 "*Characters that constitute words of type 3.
1175 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1176 See `ediff-forward-word' for more details.")
1178 (defvar ediff-word-4
1179 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace)
1180 "*Characters that constitute words of type 4.
1181 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1182 See `ediff-forward-word' for more details.")
1184 ;; Split region along word boundaries. Each word will be on its own line.
1185 ;; Output to buffer out-buffer.
1186 (defun ediff-forward-word ()
1187 "Move point one word forward.
1188 There are four types of words, each of which consists entirely of
1189 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1190 `ediff-word-4'. Words are recognized by passing these in turn as the
1191 argument to `skip-chars-forward'."
1192 (or (> (skip-chars-forward ediff-word-1) 0)
1193 (> (skip-chars-forward ediff-word-2) 0)
1194 (> (skip-chars-forward ediff-word-3) 0)
1195 (> (skip-chars-forward ediff-word-4) 0)
1198 (defun ediff-wordify (beg end in-buffer out-buffer &optional control-buf)
1199 (let (sv-point string)
1201 (set-buffer in-buffer)
1202 (setq string (buffer-substring-no-properties beg end))
1204 (set-buffer out-buffer)
1207 (goto-char (point-min))
1208 (skip-chars-forward ediff-whitespace)
1209 (delete-region (point-min) (point))
1212 ;; eval incontrol buf to let user create local versions for
1213 ;; different invocations
1216 (ediff-with-current-buffer control-buf ediff-forward-word-function))
1217 (funcall ediff-forward-word-function))
1218 (setq sv-point (point))
1219 (skip-chars-forward ediff-whitespace)
1220 (delete-region sv-point (point))
1223 ;; copy string from BEG END from IN-BUF to OUT-BUF
1224 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer)
1227 (set-buffer in-buffer)
1228 (setq string (buffer-substring beg end))
1230 (set-buffer out-buffer)
1233 (goto-char (point-min)))))
1236 ;; goto word #n starting at current position in buffer `buf'
1237 ;; For ediff, a word is either a string of a-z,A-Z, incl `-' and `_';
1238 ;; or a string of other non-blanks. A blank is a \n\t\f
1239 ;; If `flag' is non-nil, goto the end of the n-th word.
1240 (defun ediff-goto-word (n buf &optional flag)
1241 ;; remember val ediff-forward-word-function has in ctl buf
1242 (let ((fwd-word-fun ediff-forward-word-function))
1243 (ediff-with-current-buffer buf
1244 (skip-chars-forward ediff-whitespace)
1246 (funcall fwd-word-fun)
1247 (skip-chars-forward ediff-whitespace)
1249 (if (and flag (> n 0))
1250 (funcall fwd-word-fun))
1253 (defun ediff-same-file-contents (f1 f2)
1254 "T if F1 and F2 have identical contents."
1255 (let ((res (call-process ediff-cmp-program nil nil nil f1 f2)))
1256 (and (numberp res) (eq res 0))))
1259 ;;; Local Variables:
1260 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1261 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1262 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1266 ;; ediff-diff.el ends here