1 ;;; ediff-diff.el --- diff-related utilities
3 ;; Copyright (C) 1994, 1995 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 (cond ((eq system-type 'emx) "cmd") ; OS/2
30 ((memq system-type '(vax-vms axp-vms)) "*dcl*") ; VMS
32 "*The shell used to run diff and patch. If user's .profile or
33 .cshrc files are set up correctly, any shell will do. However, some people
34 set $prompt or other things incorrectly, which leads to undesirable output
35 messages. These may cause Ediff to fail. In such a case, set ediff-shell
36 to a shell that you are not using or, better, fix your shell's startup file.")
39 (defvar ediff-diff-program "diff"
40 "*Program to use for generating the differential of the two files.")
41 (defvar ediff-diff-options ""
42 "*Options to pass to `ediff-diff-program'.
43 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
44 `-w', to ignore space, and `-i', to ignore case of letters.
45 At present, the option `-c' is ignored, since Ediff doesn't understand this
48 (defvar ediff-custom-diff-program ediff-diff-program
49 "*Program to use for generating custom diff output for saving it in a file.
50 This output is not used by Ediff internally.")
51 (defvar ediff-custom-diff-options "-c"
52 "*Options to pass to `ediff-custom-diff-program'.")
56 (defvar ediff-match-diff3-line "^====\\(.?\\)$"
57 "Pattern to match lines produced by diff3 that describe differences.")
58 (defvar ediff-diff3-program "diff3"
59 "*Program to be used for three-way comparison.
60 Must produce output compatible with Unix's diff3 program.")
61 (defvar ediff-diff3-options ""
62 "*Options to pass to `ediff-diff3-program'.")
63 (defvar ediff-diff3-ok-lines-regexp
64 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\)"
65 "*Regexp that matches normal output lines from `ediff-diff3-program'.
66 Lines that do not match are assumed to be error messages.")
68 ;; keeps the status of the current diff in 3-way jobs.
69 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
70 (ediff-defvar-local ediff-diff-status "" "")
74 (defvar ediff-patch-program "patch"
75 "*Name of the program that applies patches.")
76 (defvar ediff-patch-options ""
77 "*Options to pass to ediff-patch-program.")
79 ;; The buffer of the patch file.
80 (defvar ediff-patch-buf nil)
81 ;; The buffer where patch would display its diagnostics.
82 (defvar ediff-patch-diagnostics nil)
87 (ediff-defvar-local ediff-auto-refine (if (ediff-window-display-p) 'on 'nix)
88 "If `on', Ediff auto-highlights fine diffs for the current diff region.
89 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
90 at all, unless the user force-refines the region by hitting `*'.
92 This variable can be set either in .emacs or toggled interactively.
93 Use `setq-default' if setting it in .emacs")
95 (ediff-defvar-local ediff-ignore-similar-regions nil
96 "*If t, skip over difference regions that differ only in the white space and line breaks.
97 This variable can be set either in .emacs or toggled interactively.
98 Use `setq-default' if setting it in .emacs")
100 (ediff-defvar-local ediff-auto-refine-limit 700
101 "Auto-refine only those regions that are smaller than this number of bytes.")
105 (defvar ediff-diff-ok-lines-regexp
106 "^\\([0-9,]+[acd][0-9,]+$\\|[<>] \\|---\\|.*Warning *:\\|.*No newline\\|.*missing newline\\)"
107 "Regexp that matches normal output lines from `ediff-diff-program'.
108 This is mostly lifted from Emerge, except that Ediff also considers
109 warnings and `Missing newline'-type messages to be normal output.
110 Lines that do not match are assumed to be error messages.")
112 (defvar ediff-match-diff-line (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
113 (concat "^" x "\\([acd]\\)" x "$"))
114 "Pattern to match lines produced by diff that describe differences.")
116 (ediff-defvar-local ediff-setup-diff-regions-function nil
117 "value is a function symbol depending on the kind of job is to be done.
118 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
119 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
121 The function should take three mandatory arguments, file-A, file-B, and
122 file-C. It may ignore file C for diff2 jobs. It should also take
123 one optional arguments, diff-number to refine.")
128 ;; Generate the difference vector and overlays for the two files
129 ;; With optional arg REG-TO-REFINE, refine this region.
130 ;; File-C argument is not used here. It is there just because
131 ;; ediff-setup-diff-regions is called via a funcall to
132 ;; ediff-setup-diff-regions-function, which can also have the value
133 ;; ediff-setup-diff-regions3, which takes 4 arguments.
134 (defun ediff-setup-diff-regions (file-A file-B file-C)
135 ;; Force all minibuffers to display ediff's messages.
136 ;; When xemacs implements minibufferless frames, this won't be necessary
137 (if ediff-xemacs-p (setq synchronize-minibuffers t))
139 (or (ediff-buffer-live-p ediff-diff-buffer)
140 (setq ediff-diff-buffer
141 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
143 (message "Computing differences ...")
144 (ediff-exec-process ediff-diff-program ediff-diff-buffer 'synchronize
145 ediff-diff-options file-A file-B)
147 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer)
148 ;;(message "Computing differences ... done")
149 (ediff-convert-diffs-to-overlays
151 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds))
154 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
155 ;; This function works for diff3 and diff2 jobs
156 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num)
157 (or (ediff-buffer-live-p ediff-fine-diff-buffer)
158 (setq ediff-fine-diff-buffer
160 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
162 (let (diff3-job diff-program ok-regexp diff-list)
163 (setq diff3-job ediff-3way-job
164 diff-program (if diff3-job ediff-diff3-program ediff-diff-program)
165 ok-regexp (if diff3-job
166 ediff-diff3-ok-lines-regexp
167 ediff-diff-ok-lines-regexp))
169 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num))
170 (ediff-exec-process diff-program ediff-fine-diff-buffer 'synchronize
171 ;; The shuffle below is because we can compare 3-way
172 ;; or in several 2-way fashions, like fA fC, fA fB,
174 (if file-A file-A file-B)
175 (if file-B file-B file-A)
177 (if file-C file-C file-B))
180 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer)
181 ;;(ediff-message-if-verbose
182 ;; "Refining difference region %d ... done" (1+ reg-num))
186 (ediff-extract-diffs3
187 ediff-fine-diff-buffer '3way-comparison 'word-mode)
188 (ediff-extract-diffs ediff-fine-diff-buffer 'word-mode)))
192 (mapcar (function (lambda (elt)
197 (mapcar (function (lambda (elt)
202 (mapcar (function (lambda (elt)
208 (ediff-convert-fine-diffs-to-overlays diff-list reg-num)
212 (defun ediff-prepare-error-list (ok-regexp diff-buff)
213 (or (ediff-buffer-live-p ediff-error-buffer)
214 (setq ediff-error-buffer
215 (get-buffer-create (ediff-unique-buffer-name
216 "*ediff-errors" "*"))))
217 (ediff-eval-in-buffer ediff-error-buffer
219 (insert (ediff-eval-in-buffer diff-buff (buffer-string)))
220 (goto-char (point-min))
221 (delete-matching-lines ok-regexp)
222 (if (memq system-type '(vax-vms axp-vms))
223 (delete-matching-lines "^$")))
224 ;; If diff reports errors, show them then quit.
225 (if (/= 0 (ediff-eval-in-buffer ediff-error-buffer (buffer-size)))
226 (let ((ctl-buf ediff-control-buffer)
227 (error-buf ediff-error-buffer))
228 (ediff-skip-unsuitable-frames)
229 (switch-to-buffer error-buf)
230 (ediff-kill-buffer-carefully ctl-buf)
231 (error "Errors in diff output. Diff output is in %S" diff-buff))))
233 ;; BOUNDS specifies visibility bounds to use.
234 ;; WORD-MODE tells whether we are in the word-mode or not.
235 ;; If WORD-MODE, also construct vector of diffs using word numbers.
236 ;; Else, use point values.
237 ;; This function handles diff-2 jobs including the case of
238 ;; merging buffers and files without ancestor.
239 (defun ediff-extract-diffs (diff-buffer word-mode &optional bounds)
240 (let ((A-buffer ediff-buffer-A)
241 (B-buffer ediff-buffer-B)
242 (C-buffer ediff-buffer-C)
243 (a-prev 1) ; this is needed to set the first diff line correctly
246 diff-list shift-A shift-B
249 ;; diff list contains word numbers, unless changed later
250 (setq diff-list (cons (if word-mode 'words 'points)
252 ;; we don't use visibility bounds for buffer C when merging
256 (ediff-get-value-according-to-buffer-type 'A bounds))
259 (ediff-get-value-according-to-buffer-type 'B bounds))))
261 ;; reset point in buffers A/B/C
262 (ediff-eval-in-buffer A-buffer
263 (goto-char (if shift-A shift-A (point-min))))
264 (ediff-eval-in-buffer B-buffer
265 (goto-char (if shift-B shift-B (point-min))))
266 (if (ediff-buffer-live-p C-buffer)
267 (ediff-eval-in-buffer C-buffer
268 (goto-char (point-min))))
270 (ediff-eval-in-buffer diff-buffer
271 (goto-char (point-min))
272 (while (re-search-forward ediff-match-diff-line nil t)
273 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
275 (a-end (let ((b (match-beginning 3))
278 (string-to-int (buffer-substring b e))
280 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
281 (b-begin (string-to-int (buffer-substring (match-beginning 5)
283 (b-end (let ((b (match-beginning 7))
286 (string-to-int (buffer-substring b e))
288 a-begin-pt a-end-pt b-begin-pt b-end-pt
289 c-begin c-end c-begin-pt c-end-pt)
290 ;; fix the beginning and end numbers, because diff is somewhat
291 ;; strange about how it numbers lines
292 (if (string-equal diff-type "a")
293 (setq b-end (1+ b-end)
296 (if (string-equal diff-type "d")
297 (setq a-end (1+ a-end)
300 ;; (string-equal diff-type "c")
301 (setq a-end (1+ a-end)
304 (if (eq ediff-default-variant 'default-B)
305 (setq c-begin b-begin
307 (setq c-begin a-begin
310 ;; compute main diff vector
312 ;; make diff-list contain word numbers
316 (if (ediff-buffer-live-p C-buffer)
317 (vector (- a-begin a-prev) (- a-end a-begin)
318 (- b-begin b-prev) (- b-end b-begin)
319 (- c-begin c-prev) (- c-end c-begin)
320 nil nil ; dummy ancestor
323 nil ; state of ancestor
325 (vector (- a-begin a-prev) (- a-end a-begin)
326 (- b-begin b-prev) (- b-end b-begin)
327 nil nil ; dummy buf C
328 nil nil ; dummy ancestor
331 nil ; state of ancestor
337 ;; else convert lines to points
338 (ediff-eval-in-buffer A-buffer
339 (forward-line (- a-begin a-prev))
340 (setq a-begin-pt (point))
341 (forward-line (- a-end a-begin))
342 (setq a-end-pt (point)
344 (ediff-eval-in-buffer B-buffer
345 (forward-line (- b-begin b-prev))
346 (setq b-begin-pt (point))
347 (forward-line (- b-end b-begin))
348 (setq b-end-pt (point)
350 (if (ediff-buffer-live-p C-buffer)
351 (ediff-eval-in-buffer C-buffer
352 (forward-line (- c-begin c-prev))
353 (setq c-begin-pt (point))
354 (forward-line (- c-end c-begin))
355 (setq c-end-pt (point)
361 (if (ediff-buffer-live-p C-buffer)
363 a-begin-pt a-end-pt b-begin-pt b-end-pt
365 nil nil ; dummy ancestor
367 ;; shows which buff is different from the other two
368 (if (eq ediff-default-variant 'default-B) 'A 'B)
369 ediff-default-variant ; state of merge
370 nil ; state of ancestor
372 (vector a-begin-pt a-end-pt
374 nil nil ; dummy buf C
375 nil nil ; dummy ancestor
376 nil nil ; dummy state of diff & merge
377 nil ; dummy state of ancestor
381 ))) ; end ediff-eval-in-buffer
386 (defun ediff-convert-diffs-to-overlays (diff-list)
387 (ediff-set-diff-overlays-in-one-buffer 'A diff-list)
388 (ediff-set-diff-overlays-in-one-buffer 'B diff-list)
390 (ediff-set-diff-overlays-in-one-buffer 'C diff-list))
391 (if ediff-merge-with-ancestor-job
392 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list))
393 ;; set up vector showing the status of merge regions
395 (setq ediff-state-of-merge
399 (let ((state-of-merge (aref elt 9))
400 (state-of-ancestor (aref elt 10)))
402 (if state-of-merge (format "%S" state-of-merge))
403 state-of-ancestor))))
404 ;; the first elt designates type of list
407 (message "Processing difference regions ... done"))
410 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list)
411 (let* ((current-diff -1)
412 (buff (ediff-get-buffer buf-type))
413 ;; ediff-extract-diffs puts the type of diff-list as the first elt
414 ;; of this list. The type is either 'points or 'words
415 (diff-list-type (car diff-list))
416 (shift (ediff-overlay-start
417 (ediff-get-value-according-to-buffer-type
418 buf-type ediff-narrow-bounds)))
419 (limit (ediff-overlay-end
420 (ediff-get-value-according-to-buffer-type
421 buf-type ediff-narrow-bounds)))
422 diff-overlay-list list-element total-diffs
423 begin end pt-saved overlay state-of-diff)
425 (setq diff-list (cdr diff-list)) ; discard diff list type
426 (setq total-diffs (length diff-list))
428 ;; shift, if necessary
429 (ediff-eval-in-buffer buff (setq pt-saved shift))
432 (setq current-diff (1+ current-diff)
433 list-element (car diff-list)
434 begin (aref list-element (cond ((eq buf-type 'A) 0)
438 end (aref list-element (cond ((eq buf-type 'A) 1)
442 state-of-diff (aref list-element 8)
445 (cond ((and (not (eq buf-type state-of-diff))
446 (not (eq buf-type 'Ancestor))
447 (memq state-of-diff '(A B C)))
449 (car (delq buf-type (delq state-of-diff (list 'A 'B 'C)))))
450 (setq state-of-diff (format "=diff(%S)" state-of-diff))
452 (t (setq state-of-diff nil)))
454 ;; Put overlays at appropriate places in buffer
455 ;; convert word numbers to points, if necessary
456 (if (eq diff-list-type 'words)
458 (ediff-eval-in-buffer buff (goto-char pt-saved))
459 (setq begin (ediff-goto-word (1+ begin) buff)
460 end (ediff-goto-word end buff 'end))
461 (if (> end limit) (setq end limit))
462 (if (> begin end) (setq begin end))
463 (setq pt-saved (ediff-eval-in-buffer buff (point)))))
464 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
466 ;; Priorities of overlays should be equal in all ediff control
467 ;; panel buffers. Otherwise it won't work due to Emacs
468 ;; bug, as insert-in-front-hooks will be called
469 ;; only on behalf of the buffer with higher priority.
470 (ediff-overlay-put overlay 'priority ediff-shadow-overlay-priority)
471 (ediff-overlay-put overlay 'ediff-diff-num current-diff)
473 overlay 'insert-in-front-hooks '(ediff-insert-in-front))
474 (if (and (ediff-window-display-p)
475 ediff-use-faces ediff-highlight-all-diffs)
476 (ediff-set-overlay-face
477 overlay (ediff-background-face buf-type current-diff)))
479 (if (= 0 (mod current-diff 10))
480 (message "Buffer %S: Processing difference region %d of %d"
481 buf-type current-diff total-diffs))
482 ;; record all overlays for this difference
483 ;; the second elt, nil, is a place holder for the fine diff vector.
484 ;; the third elt, nil, is a place holder for no-fine-diffs flag.
485 (setq diff-overlay-list
488 (list (vector overlay nil nil state-of-diff)))
493 (set (intern (format "ediff-difference-vector-%S" buf-type))
494 (vconcat diff-overlay-list))
497 ;; `n' is the diff region to work on. Default is ediff-current-difference.
498 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
499 ;; diffs have not been computed before.
500 ;; if `flag' is 'skip then don't compute fine diffs for this region.
501 (defun ediff-make-fine-diffs (&optional n flag)
502 (or n (setq n ediff-current-difference))
504 (if (< ediff-number-of-differences 1)
505 (error "No differences found"))
509 ediff-auto-refine 'nix))
512 (>= n ediff-number-of-differences)
513 ;; n is within the range
514 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
515 (file-A ediff-temp-file-A)
516 (file-B ediff-temp-file-B)
517 (file-C ediff-temp-file-C)
518 (empty-A (ediff-empty-diff-region-p n 'A))
519 (empty-B (ediff-empty-diff-region-p n 'B))
520 (empty-C (ediff-empty-diff-region-p n 'C))
521 (whitespace-A (ediff-whitespace-diff-region-p n 'A))
522 (whitespace-B (ediff-whitespace-diff-region-p n 'B))
523 (whitespace-C (ediff-whitespace-diff-region-p n 'C))
524 cumulative-fine-diff-length)
526 (cond ((and (eq flag 'noforce) (ediff-get-fine-diff-vector n 'A))
527 ;; don't compute fine diffs if diff vector exists
528 (if (ediff-no-fine-diffs-p n)
529 (ediff-message-if-verbose
530 "Only white-space differences in region %d" (1+ n))))
531 ;; If one of the regions is empty (or 2 in 3way comparison)
532 ;; then don't refine.
533 ;; If the region happens to be entirely whitespace or empty then
535 ((> (length (delq nil (list empty-A empty-B empty-C))) 1)
536 (if (and (ediff-looks-like-combined-merge n)
538 (ediff-set-fine-overlays-in-one-buffer 'C nil n))
539 (if ediff-3way-comparison-job
540 (ediff-message-if-verbose
541 "Region %d is empty in all buffers but %S"
543 (cond ((not empty-A) 'A)
546 (ediff-message-if-verbose
547 "Region %d in buffer %S is empty"
553 ;; if all regions happen to be whitespace, indicate this
554 (if (and whitespace-A whitespace-B whitespace-C)
555 (ediff-mark-diff-as-space-only n t)
556 (ediff-mark-diff-as-space-only n nil)))
557 ;; don't compute fine diffs for this region
559 (or (ediff-get-fine-diff-vector n 'A)
560 (memq ediff-auto-refine '(off nix))
561 (ediff-message-if-verbose
562 "Region %d exceeds auto-refine limit. `%s' force-refines"
564 (substitute-command-keys
565 "\\[ediff-make-or-kill-fine-diffs]")
568 ;; recompute fine diffs
570 (ediff-get-diff-posn 'A 'beg n)
571 (ediff-get-diff-posn 'A 'end n)
574 ediff-control-buffer)
576 (ediff-make-temp-file tmp-buffer "fineDiffA" file-A))
579 (ediff-get-diff-posn 'B 'beg n)
580 (ediff-get-diff-posn 'B 'end n)
583 ediff-control-buffer)
585 (ediff-make-temp-file tmp-buffer "fineDiffB" file-B))
590 (ediff-get-diff-posn 'C 'beg n)
591 (ediff-get-diff-posn 'C 'end n)
594 ediff-control-buffer)
596 (ediff-make-temp-file
597 tmp-buffer "fineDiffC" file-C))))
599 ;; save temp file names.
600 (setq ediff-temp-file-A file-A
601 ediff-temp-file-B file-B
602 ediff-temp-file-C file-C)
604 ;; set the new vector of fine diffs, if none exists
605 (cond ((and ediff-3way-job whitespace-A)
606 (ediff-setup-fine-diff-regions nil file-B file-C n))
607 ((and ediff-3way-job whitespace-B)
608 (ediff-setup-fine-diff-regions file-A nil file-C n))
612 (ediff-looks-like-combined-merge n))))
613 (ediff-setup-fine-diff-regions file-A file-B nil n))
615 (ediff-setup-fine-diff-regions file-A file-B file-C n)))
617 (setq cumulative-fine-diff-length
618 (+ (length (ediff-get-fine-diff-vector n 'A))
619 (length (ediff-get-fine-diff-vector n 'B))
622 (ediff-get-fine-diff-vector n 'C))
626 ;; all regions are white space
627 (and whitespace-A whitespace-B whitespace-C)
628 ;; none is white space and no fine diffs detected
629 (and (not whitespace-A)
631 (not (and ediff-3way-job whitespace-C))
632 (eq cumulative-fine-diff-length 0)))
633 (ediff-mark-diff-as-space-only n t)
634 (ediff-message-if-verbose
635 "Only white-space differences in region %d" (1+ n)))
636 ((eq cumulative-fine-diff-length 0)
637 (ediff-mark-diff-as-space-only n nil)
638 (ediff-message-if-verbose
639 "Only white-space differences in region %d %s"
641 (cond (whitespace-A "in buffers B & C")
642 (whitespace-B "in buffers A & C")
643 (whitespace-C "in buffers A & B"))))
645 (ediff-mark-diff-as-space-only n nil)))
648 (ediff-set-fine-diff-properties n)
651 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
652 (defun ediff-install-fine-diff-if-necessary (n)
653 (cond ((eq ediff-auto-refine 'on)
655 (> ediff-auto-refine-limit
656 (- (ediff-get-diff-posn 'A 'end n)
657 (ediff-get-diff-posn 'A 'beg n)))
658 (> ediff-auto-refine-limit
659 (- (ediff-get-diff-posn 'B 'end n)
660 (ediff-get-diff-posn 'B 'beg n))))
661 (ediff-make-fine-diffs n 'noforce)
662 (ediff-make-fine-diffs n 'skip)))
664 ;; highlight iff fine diffs already exist
665 ((eq ediff-auto-refine 'off)
666 (ediff-make-fine-diffs n 'skip))))
669 ;; if fine diff vector is not set for diff N, then do nothing
670 (defun ediff-set-fine-diff-properties (n &optional default)
671 (or (not (ediff-window-display-p))
673 (>= n ediff-number-of-differences)
674 ;; in a window system, set faces and priorities of fine overlays
676 (ediff-set-fine-diff-properties-in-one-buffer 'A n default)
677 (ediff-set-fine-diff-properties-in-one-buffer 'B n default)
679 (ediff-set-fine-diff-properties-in-one-buffer 'C n default)))))
681 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
683 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type))
687 (intern (format "ediff-fine-diff-face-%S" buf-type)))))
688 (priority (if default
690 (1+ (or (ediff-overlay-get
694 "ediff-current-diff-overlay-%S" buf-type)))
698 (function (lambda (overl)
699 (ediff-set-overlay-face overl face)
700 (ediff-overlay-put overl 'priority priority)))
703 ;; This assumes buffer C and that the region looks like a combination of
704 ;; regions in buffer A and C.
705 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num)
706 (let (overlay1 overlay2 overlay3)
707 (setq overlay1 (ediff-make-bullet-proof-overlay (nth 0 diff-list)
710 overlay2 (ediff-make-bullet-proof-overlay (nth 2 diff-list)
713 overlay3 (ediff-make-bullet-proof-overlay (nth 4 diff-list)
716 (ediff-set-fine-diff-vector reg-num 'C (vector overlay1 overlay2 overlay3))
720 ;; Convert diff list to overlays for a given DIFF-REGION
721 ;; in buffer of type BUF-TYPE
722 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num)
723 (let* ((current-diff -1)
724 (reg-start (ediff-get-diff-posn buf-type 'beg region-num))
725 (buff (ediff-get-buffer buf-type))
726 combined-merge-diff-list
727 diff-overlay-list list-element
730 (ediff-clear-fine-differences-in-one-buffer region-num buf-type)
731 (setq diff-list (cdr diff-list)) ; discard list type (words or points)
732 (ediff-eval-in-buffer buff (goto-char reg-start))
734 ;; if it is a combined merge then set overlays in buff C specially
735 (if (and ediff-merge-job (eq buf-type 'C)
736 (setq combined-merge-diff-list
737 (ediff-looks-like-combined-merge region-num)))
738 (ediff-set-fine-overlays-for-combined-merge
739 combined-merge-diff-list region-num)
742 (setq current-diff (1+ current-diff)
743 list-element (car diff-list)
744 begin (aref list-element (cond ((eq buf-type 'A) 0)
747 end (aref list-element (cond ((eq buf-type 'A) 1)
750 (if (not (or begin end))
752 ;; Put overlays at appropriate places in buffers
753 ;; convert lines to points, if necessary
754 (setq begin (ediff-goto-word (1+ begin) buff)
755 end (ediff-goto-word end buff 'end))
756 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
757 ;; record all overlays for this difference region
758 (setq diff-overlay-list (nconc diff-overlay-list (list overlay))))
760 (setq diff-list (cdr diff-list))
762 ;; convert the list of difference information into a vector
764 (ediff-set-fine-diff-vector
765 region-num buf-type (vconcat diff-overlay-list))
769 ;; Stolen from emerge.el
770 (defun ediff-get-diff3-group (file)
771 ;; This save-excursion allows ediff-get-diff3-group to be called for the
772 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
773 ;; appear in any order. The reason this is necessary is that Gnu diff3
774 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
777 (concat "^" file ":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
778 (beginning-of-line 2)
779 ;; treatment depends on whether it is an "a" group or a "c" group
780 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
782 (if (match-beginning 2)
783 ;; it has two numbers
785 (buffer-substring (match-beginning 1) (match-end 1)))
787 (buffer-substring (match-beginning 3) (match-end 3)))))
789 (let ((x (string-to-int
790 (buffer-substring (match-beginning 1) (match-end 1)))))
792 ;; it is an "a" group
793 (let ((x (1+ (string-to-int
794 (buffer-substring (match-beginning 1) (match-end 1))))))
798 ;; If WORD-MODE, construct vector of diffs using word numbers.
799 ;; Else, use point values.
800 ;; WORD-MODE also tells if we are in the word-mode or not.
801 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
802 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
803 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
805 ;; BOUNDS specifies visibility bounds to use.
806 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
808 (let ((A-buffer ediff-buffer-A)
809 (B-buffer ediff-buffer-B)
810 (C-buffer ediff-buffer-C)
811 (anc-buffer ediff-ancestor-buffer)
812 (a-prev 1) ; needed to set the first diff line correctly
816 diff-list shift-A shift-B shift-C
819 ;; diff list contains word numbers or points, depending on word-mode
820 (setq diff-list (cons (if word-mode 'words 'points)
825 (ediff-get-value-according-to-buffer-type 'A bounds))
828 (ediff-get-value-according-to-buffer-type 'B bounds))
832 (ediff-get-value-according-to-buffer-type 'C bounds)))))
834 ;; reset point in buffers A, B, C
835 (ediff-eval-in-buffer A-buffer
836 (goto-char (if shift-A shift-A (point-min))))
837 (ediff-eval-in-buffer B-buffer
838 (goto-char (if shift-B shift-B (point-min))))
840 (ediff-eval-in-buffer C-buffer
841 (goto-char (if shift-C shift-C (point-min)))))
842 (if (ediff-buffer-live-p anc-buffer)
843 (ediff-eval-in-buffer anc-buffer
844 (goto-char (point-min))))
846 (ediff-eval-in-buffer diff-buffer
847 (goto-char (point-min))
848 (while (re-search-forward ediff-match-diff3-line nil t)
849 ;; leave point after matched line
850 (beginning-of-line 2)
851 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
852 ;; if the A and B files are the same and not 3way-comparison,
853 ;; ignore the difference
854 (if (or three-way-comp (not (string-equal agreement "3")))
855 (let* ((a-begin (car (ediff-get-diff3-group "1")))
856 (a-end (nth 1 (ediff-get-diff3-group "1")))
857 (b-begin (car (ediff-get-diff3-group "2")))
858 (b-end (nth 1 (ediff-get-diff3-group "2")))
859 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
860 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
862 (cond ((string-equal agreement "1") 'prefer-A)
863 ((string-equal agreement "2") 'prefer-B)
864 (t ediff-default-variant)))
866 (if (memq state-of-merge '(default-A prefer-A)) 'B 'A))
867 (state-of-diff-comparison
868 (cond ((string-equal agreement "1") 'A)
869 ((string-equal agreement "2") 'B)
870 ((string-equal agreement "3") 'C)))
876 anc-begin-pt anc-end-pt)
878 (setq state-of-ancestor
879 (= c-or-anc-begin c-or-anc-end))
881 (cond (three-way-comp
882 (setq c-begin c-or-anc-begin
884 ((eq ediff-default-variant 'default-B)
885 (setq c-begin b-begin
888 (setq c-begin a-begin
891 ;; compute main diff vector
893 ;; make diff-list contain word numbers
897 (- a-begin a-prev) (- a-end a-begin)
898 (- b-begin b-prev) (- b-end b-begin)
899 (- c-begin c-prev) (- c-end c-begin)
900 nil nil ; dummy ancestor
903 nil ; state of ancestor
908 ;; else convert lines to points
909 (ediff-eval-in-buffer A-buffer
910 (forward-line (- a-begin a-prev))
911 (setq a-begin-pt (point))
912 (forward-line (- a-end a-begin))
913 (setq a-end-pt (point)
915 (ediff-eval-in-buffer B-buffer
916 (forward-line (- b-begin b-prev))
917 (setq b-begin-pt (point))
918 (forward-line (- b-end b-begin))
919 (setq b-end-pt (point)
921 (ediff-eval-in-buffer C-buffer
922 (forward-line (- c-begin c-prev))
923 (setq c-begin-pt (point))
924 (forward-line (- c-end c-begin))
925 (setq c-end-pt (point)
927 (if (ediff-buffer-live-p anc-buffer)
928 (ediff-eval-in-buffer anc-buffer
929 (forward-line (- c-or-anc-begin anc-prev))
930 (setq anc-begin-pt (point))
931 (forward-line (- c-or-anc-end c-or-anc-begin))
932 (setq anc-end-pt (point)
933 anc-prev c-or-anc-end)))
937 ;; if comparing with ancestor, then there also is a
938 ;; state-of-difference marker
944 nil nil ; ancestor begin/end
945 state-of-diff-comparison
947 nil ; state of ancestor
949 (list (vector a-begin-pt a-end-pt
952 anc-begin-pt anc-end-pt
960 ))) ; end ediff-eval-in-buffer
964 ;; Generate the difference vector and overlays for three files
965 ;; File-C is either the third file to compare (in case of 3-way comparison)
966 ;; or it is the ancestor file.
967 (defun ediff-setup-diff-regions3 (file-A file-B file-C)
969 ;; force all minibuffers to display ediff's messages.
970 ;; when xemacs implements minibufferless frames, this won't be necessary
971 (if ediff-xemacs-p (setq synchronize-minibuffers t))
973 (or (ediff-buffer-live-p ediff-diff-buffer)
974 (setq ediff-diff-buffer
975 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
977 (message "Computing differences ...")
978 (ediff-exec-process ediff-diff3-program ediff-diff-buffer 'synchronize
979 ediff-diff3-options file-A file-B file-C)
981 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer)
982 ;;(message "Computing differences ... done")
983 (ediff-convert-diffs-to-overlays
984 (ediff-extract-diffs3
986 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds)
990 ;; Execute PROGRAM asynchronously, unless OS/2 or unless SYNC is non-nil.
991 ;; BUFFER must be a buffer object, and must be alive.
992 ;; All arguments in ARGS must be strings. The first arg may be a blank string,
993 ;; in which case we delete it from ARGS list. We also delete nil from args.
994 (defun ediff-exec-process (program buffer sync &rest args)
995 (let ((data (match-data)))
996 (if (string-match "^[ \t]*$" (car args)) ; delete blank string
997 (setq args (cdr args)))
998 (setq args (delq nil args)) ; delete nil from arguments
999 (setq args (ediff-split-string (mapconcat 'identity args " ")))
1001 (let ((directory default-directory)
1006 (setq default-directory directory)
1007 (if (or (eq system-type 'emx) sync)
1008 ;; In OS/2 do it synchronously, since OS/2 doesn't let us
1009 ;; delete files used by other processes. Thus, in ediff-buffers
1010 ;; and similar functions, we can't delete temp files because
1011 ;; they might be used by the async process that computes
1012 ;; custom diffs. So, we have to wait till custom diff
1013 ;; subprocess is done.
1014 (apply 'call-process program nil buffer nil args)
1015 ;; On other systems, do it asynchronously.
1016 (setq proc (get-buffer-process buffer))
1017 (if proc (kill-process proc))
1019 (apply 'start-process "Custom Diff" buffer program args))
1020 (setq mode-line-process '(":%s"))
1021 (set-process-sentinel proc 'ediff-process-sentinel)
1022 (set-process-filter proc 'ediff-process-filter)
1024 (store-match-data data))))
1026 ;; This is shell-command-filter from simple.el in FSF Emacs.
1027 ;; Copied here because XEmacs doesn't have it.
1028 (defun ediff-process-filter (proc string)
1029 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1030 ;; despite an insertion immediately after it.
1031 (let* ((obuf (current-buffer))
1032 (buffer (process-buffer proc))
1034 (window (get-buffer-window buffer))
1035 (pos (window-start window)))
1039 (or (= (point) (point-max))
1040 (setq opoint (point)))
1041 (goto-char (point-max))
1042 (insert-before-markers string))
1043 ;; insert-before-markers moved this marker: set it back.
1044 (set-window-start window pos)
1045 ;; Finish our save-excursion.
1048 (set-buffer obuf))))
1050 ;; like shell-command-sentinel but doesn't print an exit status message
1051 ;; we do this because diff always exits with status 1, if diffs are found
1052 ;; so shell-command-sentinel displays a confusing message to the user
1053 (defun ediff-process-sentinel (process signal)
1054 (if (and (memq (process-status process) '(exit signal))
1055 (buffer-name (process-buffer process)))
1058 (set-buffer (process-buffer process))
1059 (setq mode-line-process nil))
1060 (delete-process process))))
1063 ;;; Word functions used to refine the current diff
1065 (defvar ediff-forward-word-function 'ediff-forward-word
1066 "*Function to call to move to the next word.
1067 Used for splitting difference regions into individual words.")
1069 (defvar ediff-whitespace " \n\t\f"
1070 "*Characters constituting white space.
1071 These characters are ignored when differing regions are split into words.")
1073 ;;(defvar ediff-word-1 "a-zA-Z---_`'.?!:"
1074 (defvar ediff-word-1 "a-zA-Z---_"
1075 "*Characters that constitute words of type 1.
1076 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1077 See `ediff-forward-word' for more details.")
1079 (defvar ediff-word-2 "0-9.,"
1080 "*Characters that constitute words of type 2.
1081 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1082 See `ediff-forward-word' for more details.")
1084 (defvar ediff-word-3 "`'?!:;\"{}[]()"
1085 "*Characters that constitute words of type 3.
1086 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1087 See `ediff-forward-word' for more details.")
1089 (defvar ediff-word-4
1090 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace)
1091 "*Characters that constitute words of type 4.
1092 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1093 See `ediff-forward-word' for more details.")
1095 ;; Split region along word boundaries. Each word will be on its own line.
1096 ;; Output to buffer out-buffer.
1097 (defun ediff-forward-word ()
1098 "Move point one word forward.
1099 There are four types of words, each of which consists entirely of
1100 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1101 `ediff-word-4'. Words are recognized by passing these in turn as the
1102 argument to `skip-chars-forward'."
1103 (or (> (skip-chars-forward ediff-word-1) 0)
1104 (> (skip-chars-forward ediff-word-2) 0)
1105 (> (skip-chars-forward ediff-word-3) 0)
1106 (> (skip-chars-forward ediff-word-4) 0)
1109 (defun ediff-wordify (beg end in-buffer out-buffer &optional control-buf)
1110 (let (sv-point string)
1112 (set-buffer in-buffer)
1113 (setq string (buffer-substring beg end))
1115 (set-buffer out-buffer)
1118 (goto-char (point-min))
1119 (skip-chars-forward ediff-whitespace)
1120 (delete-region (point-min) (point))
1123 ;; eval incontrol buf to let user create local versions for
1124 ;; different invocations
1127 (ediff-eval-in-buffer control-buf ediff-forward-word-function))
1128 (funcall ediff-forward-word-function))
1129 (setq sv-point (point))
1130 (skip-chars-forward ediff-whitespace)
1131 (delete-region sv-point (point))
1134 ;; copy string from BEG END from IN-BUF to OUT-BUF
1135 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer)
1138 (set-buffer in-buffer)
1139 (setq string (buffer-substring beg end))
1141 (set-buffer out-buffer)
1144 (goto-char (point-min)))))
1147 ;; goto word #n starting at current position in buffer `buf'
1148 ;; For ediff, a word is either a string of a-z,A-Z, incl `-' and `_';
1149 ;; or a string of other non-blanks. A blank is a \n\t\f
1150 ;; If `flag' is non-nil, goto the end of the n-th word.
1151 (defun ediff-goto-word (n buf &optional flag)
1152 ;; remember val ediff-forward-word-function has in ctl buf
1153 (let ((fwd-word-fun ediff-forward-word-function))
1154 (ediff-eval-in-buffer buf
1155 (skip-chars-forward ediff-whitespace)
1157 (funcall fwd-word-fun)
1158 (skip-chars-forward ediff-whitespace)
1160 (if (and flag (> n 0))
1161 (funcall fwd-word-fun))
1165 (provide 'ediff-diff)
1167 ;; ediff-diff.el ends here