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.
31 (defvar ediff-default-variant
)
34 (let ((load-path (cons (expand-file-name ".") load-path
)))
35 (or (featurep 'ediff-init
)
36 (load "ediff-init.el" nil nil
'nosuffix
))
37 (or (featurep 'ediff-util
)
38 (load "ediff-util.el" nil nil
'nosuffix
))
44 (defgroup ediff-diff nil
45 "Diff related utilities"
49 ;; these two must be here to prevent ediff-test-utility from barking
50 (defcustom ediff-diff-program
"diff"
51 "*Program to use for generating the differential of the two files."
54 (defcustom ediff-diff3-program
"diff3"
55 "*Program to be used for three-way comparison.
56 Must produce output compatible with Unix's diff3 program."
61 ;; The following functions must precede all defcustom-defined variables.
63 ;; The following functions needed for setting diff/diff3 options
64 ;; test if diff supports the --binary option
65 (defsubst ediff-test-utility
(diff-util option
&optional files
)
66 (zerop (apply 'call-process
67 (append (list diff-util nil nil nil option
) files
))))
69 (defun ediff-diff-mandatory-option (diff-util)
70 (let ((file (if (boundp 'null-device
) null-device
"/dev/null")))
71 (cond ((not (memq system-type
'(ms-dos windows-nt windows-95
)))
73 ((and (string= diff-util ediff-diff-program
)
75 ediff-diff-program
"--binary" (list file file
)))
77 ((and (string= diff-util ediff-diff3-program
)
79 ediff-diff3-program
"--binary" (list file file file
)))
83 ;; make sure that mandatory options are added even if the user changes
84 ;; ediff-diff-options or ediff-diff3-options in the customization widget
85 (defun ediff-reset-diff-options (symb val
)
87 (if (eq symb
'ediff-diff-options
)
90 (mandatory-option (ediff-diff-mandatory-option diff-program
))
91 (spacer (if (string-equal mandatory-option
"") "" " ")))
93 (if (string-match mandatory-option val
)
95 (concat mandatory-option spacer val
)))
99 (defcustom ediff-shell
100 (cond ((eq system-type
'emx
) "cmd") ; OS/2
101 ((memq system-type
'(ms-dos windows-nt windows-95
))
102 shell-file-name
) ; no standard name on MS-DOS
103 ((memq system-type
'(vax-vms axp-vms
)) "*dcl*") ; VMS
105 "*The shell used to run diff and patch. If user's .profile or
106 .cshrc files are set up correctly, any shell will do. However, some people
107 set $prompt or other things incorrectly, which leads to undesirable output
108 messages. These may cause Ediff to fail. In such a case, set ediff-shell
109 to a shell that you are not using or, better, fix your shell's startup file."
113 (defcustom ediff-cmp-program
"cmp"
114 "*Utility to use to determine if two files are identical.
115 It must return code 0, if its arguments are identical files."
119 (defcustom ediff-cmp-options nil
120 "*Options to pass to `ediff-cmp-program'.
121 If GNU diff is used as `ediff-cmp-program', then the most useful options
122 are `-I RE', to ignore changes whose lines all match the regexp RE."
123 :type
'(repeat string
)
126 (defcustom ediff-diff-options
""
127 "*Options to pass to `ediff-diff-program'.
128 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
129 `-w', to ignore space, and `-i', to ignore case of letters.
130 At present, the option `-c' is not allowed."
131 :set
'ediff-reset-diff-options
135 (defcustom ediff-custom-diff-program ediff-diff-program
136 "*Program to use for generating custom diff output for saving it in a file.
137 This output is not used by Ediff internally."
140 (defcustom ediff-custom-diff-options
"-c"
141 "*Options to pass to `ediff-custom-diff-program'."
145 ;;; Support for diff3
147 (defvar ediff-match-diff3-line
"^====\\(.?\\)\C-m?$"
148 "Pattern to match lines produced by diff3 that describe differences.")
149 (defcustom ediff-diff3-options
""
150 "*Options to pass to `ediff-diff3-program'."
151 :set
'ediff-reset-diff-options
154 (defcustom ediff-diff3-ok-lines-regexp
155 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
156 "*Regexp that matches normal output lines from `ediff-diff3-program'.
157 Lines that do not match are assumed to be error messages."
161 ;; keeps the status of the current diff in 3-way jobs.
162 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
163 (ediff-defvar-local ediff-diff-status
"" "")
168 (ediff-defvar-local ediff-auto-refine
(if (ediff-has-face-support-p) 'on
'nix
)
169 "If `on', Ediff auto-highlights fine diffs for the current diff region.
170 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
171 at all, unless the user force-refines the region by hitting `*'.
173 This variable can be set either in .emacs or toggled interactively.
174 Use `setq-default' if setting it in .emacs")
176 (ediff-defvar-local ediff-ignore-similar-regions nil
177 "*If t, skip over difference regions that differ only in the white space and line breaks.
178 This variable can be set either in .emacs or toggled interactively.
179 Use `setq-default' if setting it in .emacs")
181 (ediff-defvar-local ediff-auto-refine-limit
1400
182 "*Auto-refine only the regions of this size \(in bytes\) or less.")
186 (defvar ediff-diff-ok-lines-regexp
189 "[0-9,]+[acd][0-9,]+\C-m?$"
194 "\\|.*missing +newline"
197 "Regexp that matches normal output lines from `ediff-diff-program'.
198 This is mostly lifted from Emerge, except that Ediff also considers
199 warnings and `Missing newline'-type messages to be normal output.
200 Lines that do not match are assumed to be error messages.")
202 (defvar ediff-match-diff-line
203 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
204 (concat "^" x
"\\([acd]\\)" x
"\C-m?$"))
205 "Pattern to match lines produced by diff that describe differences.")
207 (ediff-defvar-local ediff-setup-diff-regions-function nil
208 "value is a function symbol depending on the kind of job is to be done.
209 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
210 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
212 The function should take three mandatory arguments, file-A, file-B, and
213 file-C. It may ignore file C for diff2 jobs. It should also take
214 one optional arguments, diff-number to refine.")
219 ;; Generate the difference vector and overlays for the two files
220 ;; With optional arg REG-TO-REFINE, refine this region.
221 ;; File-C argument is not used here. It is there just because
222 ;; ediff-setup-diff-regions is called via a funcall to
223 ;; ediff-setup-diff-regions-function, which can also have the value
224 ;; ediff-setup-diff-regions3, which takes 4 arguments.
225 (defun ediff-setup-diff-regions (file-A file-B file-C
)
226 (if (string-match "c" ediff-diff-options
)
227 (error "Option `-c' is not allowed in `ediff-diff-options'"))
229 ;; create, if it doesn't exist
230 (or (ediff-buffer-live-p ediff-diff-buffer
)
231 (setq ediff-diff-buffer
232 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
233 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B
)
234 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer
)
235 (ediff-convert-diffs-to-overlays
237 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds
)))
239 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
240 ;; Return the size of DIFF-BUFFER
241 ;; The return code isn't used in the program at present.
242 (defun ediff-make-diff2-buffer (diff-buffer file1 file2
)
243 (let ((file1-size (ediff-file-size file1
))
244 (file2-size (ediff-file-size file2
)))
245 (cond ((not (numberp file1-size
))
246 (message "Can't find file: %s"
247 (ediff-abbreviate-file-name file1
))
249 ;; 1 is an error exit code
251 ((not (numberp file2-size
))
252 (message "Can't find file: %s"
253 (ediff-abbreviate-file-name file2
))
255 ;; 1 is an error exit code
257 (t (message "Computing differences between %s and %s ..."
258 (file-name-nondirectory file1
)
259 (file-name-nondirectory file2
))
260 ;; this erases the diff buffer automatically
261 (ediff-exec-process ediff-diff-program
264 ediff-diff-options file1 file2
)
266 (ediff-with-current-buffer diff-buffer
271 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
272 ;; This function works for diff3 and diff2 jobs
273 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num
)
274 (or (ediff-buffer-live-p ediff-fine-diff-buffer
)
275 (setq ediff-fine-diff-buffer
277 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
279 (let (diff3-job diff-program diff-options ok-regexp diff-list
)
280 (setq diff3-job ediff-3way-job
281 diff-program
(if diff3-job ediff-diff3-program ediff-diff-program
)
282 diff-options
(if diff3-job ediff-diff3-options ediff-diff-options
)
283 ok-regexp
(if diff3-job
284 ediff-diff3-ok-lines-regexp
285 ediff-diff-ok-lines-regexp
))
287 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num
))
288 (ediff-exec-process diff-program ediff-fine-diff-buffer
'synchronize
290 ;; The shuffle below is because we can compare 3-way
291 ;; or in several 2-way fashions, like fA fC, fA fB,
293 (if file-A file-A file-B
)
294 (if file-B file-B file-A
)
296 (if file-C file-C file-B
))
299 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer
)
300 (ediff-message-if-verbose
302 ;; "Refining difference region %d ... done" (1+ reg-num))
306 (ediff-extract-diffs3
307 ediff-fine-diff-buffer
'3way-comparison
'word-mode
)
308 (ediff-extract-diffs ediff-fine-diff-buffer
'word-mode
)))
312 (mapcar (lambda (elt)
317 (mapcar (lambda (elt)
322 (mapcar (lambda (elt)
328 (ediff-convert-fine-diffs-to-overlays diff-list reg-num
)
332 (defun ediff-prepare-error-list (ok-regexp diff-buff
)
333 (or (ediff-buffer-live-p ediff-error-buffer
)
334 (setq ediff-error-buffer
335 (get-buffer-create (ediff-unique-buffer-name
336 "*ediff-errors" "*"))))
337 (ediff-with-current-buffer ediff-error-buffer
339 (insert (ediff-with-current-buffer diff-buff
(buffer-string)))
340 (goto-char (point-min))
341 (delete-matching-lines ok-regexp
)
342 (if (memq system-type
'(vax-vms axp-vms
))
343 (delete-matching-lines "^$")))
344 ;; If diff reports errors, show them then quit.
345 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer
(buffer-size)))
346 (let ((ctl-buf ediff-control-buffer
)
347 (error-buf ediff-error-buffer
))
348 (ediff-skip-unsuitable-frames)
349 (switch-to-buffer error-buf
)
350 (ediff-kill-buffer-carefully ctl-buf
)
351 (error "Errors in diff output. Diff output is in %S" diff-buff
))))
353 ;; BOUNDS specifies visibility bounds to use.
354 ;; WORD-MODE tells whether we are in the word-mode or not.
355 ;; If WORD-MODE, also construct vector of diffs using word numbers.
356 ;; Else, use point values.
357 ;; This function handles diff-2 jobs including the case of
358 ;; merging buffers and files without ancestor.
359 (defun ediff-extract-diffs (diff-buffer word-mode
&optional bounds
)
360 (let ((A-buffer ediff-buffer-A
)
361 (B-buffer ediff-buffer-B
)
362 (C-buffer ediff-buffer-C
)
363 (a-prev 1) ; this is needed to set the first diff line correctly
366 diff-list shift-A shift-B
369 ;; diff list contains word numbers, unless changed later
370 (setq diff-list
(cons (if word-mode
'words
'points
)
372 ;; we don't use visibility bounds for buffer C when merging
376 (ediff-get-value-according-to-buffer-type 'A bounds
))
379 (ediff-get-value-according-to-buffer-type 'B bounds
))))
381 ;; reset point in buffers A/B/C
382 (ediff-with-current-buffer A-buffer
383 (goto-char (if shift-A shift-A
(point-min))))
384 (ediff-with-current-buffer B-buffer
385 (goto-char (if shift-B shift-B
(point-min))))
386 (if (ediff-buffer-live-p C-buffer
)
387 (ediff-with-current-buffer C-buffer
388 (goto-char (point-min))))
390 (ediff-with-current-buffer diff-buffer
391 (goto-char (point-min))
392 (while (re-search-forward ediff-match-diff-line nil t
)
393 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
395 (a-end (let ((b (match-beginning 3))
398 (string-to-int (buffer-substring b e
))
400 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
401 (b-begin (string-to-int (buffer-substring (match-beginning 5)
403 (b-end (let ((b (match-beginning 7))
406 (string-to-int (buffer-substring b e
))
408 a-begin-pt a-end-pt b-begin-pt b-end-pt
409 c-begin c-end c-begin-pt c-end-pt
)
410 ;; fix the beginning and end numbers, because diff is somewhat
411 ;; strange about how it numbers lines
412 (if (string-equal diff-type
"a")
413 (setq b-end
(1+ b-end
)
416 (if (string-equal diff-type
"d")
417 (setq a-end
(1+ a-end
)
420 ;; (string-equal diff-type "c")
421 (setq a-end
(1+ a-end
)
424 (if (eq ediff-default-variant
'default-B
)
425 (setq c-begin b-begin
427 (setq c-begin a-begin
430 ;; compute main diff vector
432 ;; make diff-list contain word numbers
436 (if (ediff-buffer-live-p C-buffer
)
437 (vector (- a-begin a-prev
) (- a-end a-begin
)
438 (- b-begin b-prev
) (- b-end b-begin
)
439 (- c-begin c-prev
) (- c-end c-begin
)
440 nil nil
; dummy ancestor
443 nil
; state of ancestor
445 (vector (- a-begin a-prev
) (- a-end a-begin
)
446 (- b-begin b-prev
) (- b-end b-begin
)
447 nil nil
; dummy buf C
448 nil nil
; dummy ancestor
451 nil
; state of ancestor
457 ;; else convert lines to points
458 (ediff-with-current-buffer A-buffer
459 (forward-line (- a-begin a-prev
))
460 (setq a-begin-pt
(point))
461 (forward-line (- a-end a-begin
))
462 (setq a-end-pt
(point)
464 (ediff-with-current-buffer B-buffer
465 (forward-line (- b-begin b-prev
))
466 (setq b-begin-pt
(point))
467 (forward-line (- b-end b-begin
))
468 (setq b-end-pt
(point)
470 (if (ediff-buffer-live-p C-buffer
)
471 (ediff-with-current-buffer C-buffer
472 (forward-line (- c-begin c-prev
))
473 (setq c-begin-pt
(point))
474 (forward-line (- c-end c-begin
))
475 (setq c-end-pt
(point)
481 (if (ediff-buffer-live-p C-buffer
)
483 a-begin-pt a-end-pt b-begin-pt b-end-pt
485 nil nil
; dummy ancestor
487 ;; shows which buff is different from the other two
488 (if (eq ediff-default-variant
'default-B
) 'A
'B
)
489 ediff-default-variant
; state of merge
490 nil
; state of ancestor
492 (vector a-begin-pt a-end-pt
494 nil nil
; dummy buf C
495 nil nil
; dummy ancestor
496 nil nil
; dummy state of diff & merge
497 nil
; dummy state of ancestor
501 ))) ; end ediff-with-current-buffer
506 (defun ediff-convert-diffs-to-overlays (diff-list)
507 (ediff-set-diff-overlays-in-one-buffer 'A diff-list
)
508 (ediff-set-diff-overlays-in-one-buffer 'B diff-list
)
510 (ediff-set-diff-overlays-in-one-buffer 'C diff-list
))
511 (if ediff-merge-with-ancestor-job
512 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list
))
513 ;; set up vector showing the status of merge regions
515 (setq ediff-state-of-merge
517 (mapcar (lambda (elt)
518 (let ((state-of-merge (aref elt
9))
519 (state-of-ancestor (aref elt
10)))
521 ;; state of merge: prefers/default-A/B or combined
522 (if state-of-merge
(format "%S" state-of-merge
))
523 ;; whether the ancestor region is empty
525 ;; the first elt designates type of list
528 (message "Processing difference regions ... done"))
531 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list
)
532 (let* ((current-diff -
1)
533 (buff (ediff-get-buffer buf-type
))
534 ;; ediff-extract-diffs puts the type of diff-list as the first elt
535 ;; of this list. The type is either 'points or 'words
536 (diff-list-type (car diff-list
))
537 (shift (ediff-overlay-start
538 (ediff-get-value-according-to-buffer-type
539 buf-type ediff-narrow-bounds
)))
540 (limit (ediff-overlay-end
541 (ediff-get-value-according-to-buffer-type
542 buf-type ediff-narrow-bounds
)))
543 diff-overlay-list list-element total-diffs
544 begin end pt-saved overlay state-of-diff
)
546 (setq diff-list
(cdr diff-list
)) ; discard diff list type
547 (setq total-diffs
(length diff-list
))
549 ;; shift, if necessary
550 (ediff-with-current-buffer buff
(setq pt-saved shift
))
553 (setq current-diff
(1+ current-diff
)
554 list-element
(car diff-list
)
555 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
559 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
563 state-of-diff
(aref list-element
8)
566 (cond ((and (not (eq buf-type state-of-diff
))
567 (not (eq buf-type
'Ancestor
))
568 (memq state-of-diff
'(A B C
)))
570 (car (delq buf-type
(delq state-of-diff
(list 'A
'B
'C
)))))
571 (setq state-of-diff
(format "=diff(%S)" state-of-diff
))
573 (t (setq state-of-diff nil
)))
575 ;; Put overlays at appropriate places in buffer
576 ;; convert word numbers to points, if necessary
577 (if (eq diff-list-type
'words
)
579 (ediff-with-current-buffer buff
(goto-char pt-saved
))
580 (setq begin
(ediff-goto-word (1+ begin
) buff
)
581 end
(ediff-goto-word end buff
'end
))
582 (if (> end limit
) (setq end limit
))
583 (if (> begin end
) (setq begin end
))
584 (setq pt-saved
(ediff-with-current-buffer buff
(point)))))
585 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
587 (ediff-overlay-put overlay
'priority ediff-shadow-overlay-priority
)
588 (ediff-overlay-put overlay
'ediff-diff-num current-diff
)
589 (if (and (ediff-has-face-support-p)
590 ediff-use-faces ediff-highlight-all-diffs
)
591 (ediff-set-overlay-face
592 overlay
(ediff-background-face buf-type current-diff
)))
594 (if (= 0 (mod current-diff
10))
595 (message "Buffer %S: Processing difference region %d of %d"
596 buf-type current-diff total-diffs
))
597 ;; Record all overlays for this difference.
598 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
599 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
600 ;; The 4-th elt says which diff region is different from the other two
601 ;; (3-way jobs only).
602 (setq diff-overlay-list
605 (list (vector overlay nil nil state-of-diff
)))
610 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist
)
611 (vconcat diff-overlay-list
))
614 ;; `n' is the diff region to work on. Default is ediff-current-difference.
615 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
616 ;; diffs have not been computed before.
617 ;; if `flag' is 'skip then don't compute fine diffs for this region.
618 (defun ediff-make-fine-diffs (&optional n flag
)
619 (or n
(setq n ediff-current-difference
))
621 (if (< ediff-number-of-differences
1)
622 (error ediff-NO-DIFFERENCES
))
626 ediff-auto-refine
'nix
))
629 (>= n ediff-number-of-differences
)
630 ;; n is within the range
631 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
632 (file-A ediff-temp-file-A
)
633 (file-B ediff-temp-file-B
)
634 (file-C ediff-temp-file-C
)
635 (empty-A (ediff-empty-diff-region-p n
'A
))
636 (empty-B (ediff-empty-diff-region-p n
'B
))
637 (empty-C (ediff-empty-diff-region-p n
'C
))
638 (whitespace-A (ediff-whitespace-diff-region-p n
'A
))
639 (whitespace-B (ediff-whitespace-diff-region-p n
'B
))
640 (whitespace-C (ediff-whitespace-diff-region-p n
'C
))
641 cumulative-fine-diff-length
)
643 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
644 ;; then don't refine.
645 ;; If the region happens to be entirely whitespace or empty then
647 ((> (length (delq nil
(list empty-A empty-B empty-C
))) 1)
648 (if (and (ediff-looks-like-combined-merge n
)
650 (ediff-set-fine-overlays-in-one-buffer 'C nil n
))
651 (if ediff-3way-comparison-job
652 (ediff-message-if-verbose
653 "Region %d is empty in all buffers but %S"
655 (cond ((not empty-A
) 'A
)
658 (ediff-message-if-verbose
659 "Region %d in buffer %S is empty"
665 ;; if all regions happen to be whitespace
666 (if (and whitespace-A whitespace-B whitespace-C
)
667 ;; mark as space only
668 (ediff-mark-diff-as-space-only n t
)
669 ;; if some regions are white and others don't, then mark as
670 ;; non-white-space-only
671 (ediff-mark-diff-as-space-only n nil
)))
673 ;; don't compute fine diffs if diff vector exists
674 ((and (eq flag
'noforce
) (ediff-get-fine-diff-vector n
'A
))
675 (if (ediff-no-fine-diffs-p n
)
677 "Only white-space differences in region %d %s"
679 (cond ((eq (ediff-no-fine-diffs-p n
) 'A
)
681 ((eq (ediff-no-fine-diffs-p n
) 'B
)
683 ((eq (ediff-no-fine-diffs-p n
) 'C
)
686 ;; don't compute fine diffs for this region
688 (or (ediff-get-fine-diff-vector n
'A
)
689 (memq ediff-auto-refine
'(off nix
))
690 (ediff-message-if-verbose
691 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
693 (substitute-command-keys
694 "\\[ediff-make-or-kill-fine-diffs]")
697 ;; recompute fine diffs
699 (ediff-get-diff-posn 'A
'beg n
)
700 (ediff-get-diff-posn 'A
'end n
)
703 ediff-control-buffer
)
705 (ediff-make-temp-file tmp-buffer
"fineDiffA" file-A
))
708 (ediff-get-diff-posn 'B
'beg n
)
709 (ediff-get-diff-posn 'B
'end n
)
712 ediff-control-buffer
)
714 (ediff-make-temp-file tmp-buffer
"fineDiffB" file-B
))
719 (ediff-get-diff-posn 'C
'beg n
)
720 (ediff-get-diff-posn 'C
'end n
)
723 ediff-control-buffer
)
725 (ediff-make-temp-file
726 tmp-buffer
"fineDiffC" file-C
))))
728 ;; save temp file names.
729 (setq ediff-temp-file-A file-A
730 ediff-temp-file-B file-B
731 ediff-temp-file-C file-C
)
733 ;; set the new vector of fine diffs, if none exists
734 (cond ((and ediff-3way-job whitespace-A
)
735 (ediff-setup-fine-diff-regions nil file-B file-C n
))
736 ((and ediff-3way-job whitespace-B
)
737 (ediff-setup-fine-diff-regions file-A nil file-C n
))
739 ;; In merge-jobs, whitespace-C is t, since
740 ;; ediff-empty-diff-region-p returns t in this case
742 (ediff-setup-fine-diff-regions file-A file-B nil n
))
744 (ediff-setup-fine-diff-regions file-A file-B file-C n
)))
746 (setq cumulative-fine-diff-length
747 (+ (length (ediff-get-fine-diff-vector n
'A
))
748 (length (ediff-get-fine-diff-vector n
'B
))
749 ;; in merge jobs, the merge buffer is never refined
750 (if (and file-C
(not ediff-merge-job
))
751 (length (ediff-get-fine-diff-vector n
'C
))
755 ;; all regions are white space
756 (and whitespace-A whitespace-B whitespace-C
)
757 ;; none is white space and no fine diffs detected
758 (and (not whitespace-A
)
760 (not (and ediff-3way-job whitespace-C
))
761 (eq cumulative-fine-diff-length
0)))
762 (ediff-mark-diff-as-space-only n t
)
763 (ediff-message-if-verbose
764 "Only white-space differences in region %d" (1+ n
)))
765 ((eq cumulative-fine-diff-length
0)
766 (ediff-message-if-verbose
767 "Only white-space differences in region %d %s"
769 (cond (whitespace-A (ediff-mark-diff-as-space-only n
'A
)
771 (whitespace-B (ediff-mark-diff-as-space-only n
'B
)
773 (whitespace-C (ediff-mark-diff-as-space-only n
'C
)
774 "in buffers A & B"))))
776 (ediff-mark-diff-as-space-only n nil
)))
779 (ediff-set-fine-diff-properties n
)
782 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
783 (defun ediff-install-fine-diff-if-necessary (n)
784 (cond ((eq ediff-auto-refine
'on
)
786 (> ediff-auto-refine-limit
787 (- (ediff-get-diff-posn 'A
'end n
)
788 (ediff-get-diff-posn 'A
'beg n
)))
789 (> ediff-auto-refine-limit
790 (- (ediff-get-diff-posn 'B
'end n
)
791 (ediff-get-diff-posn 'B
'beg n
))))
792 (ediff-make-fine-diffs n
'noforce
)
793 (ediff-make-fine-diffs n
'skip
)))
795 ;; highlight iff fine diffs already exist
796 ((eq ediff-auto-refine
'off
)
797 (ediff-make-fine-diffs n
'skip
))))
800 ;; if fine diff vector is not set for diff N, then do nothing
801 (defun ediff-set-fine-diff-properties (n &optional default
)
802 (or (not (ediff-has-face-support-p))
804 (>= n ediff-number-of-differences
)
805 ;; when faces are supported, set faces and priorities of fine overlays
807 (ediff-set-fine-diff-properties-in-one-buffer 'A n default
)
808 (ediff-set-fine-diff-properties-in-one-buffer 'B n default
)
810 (ediff-set-fine-diff-properties-in-one-buffer 'C n default
)))))
812 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
814 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type
))
818 (ediff-get-symbol-from-alist
819 buf-type ediff-fine-diff-face-alist
))))
820 (priority (if default
822 (1+ (or (ediff-overlay-get
824 (ediff-get-symbol-from-alist
826 ediff-current-diff-overlay-alist
))
829 (mapcar (lambda (overl)
830 (ediff-set-overlay-face overl face
)
831 (ediff-overlay-put overl
'priority priority
))
834 ;; Set overlays over the regions that denote delimiters
835 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num
)
836 (let (overlay overlay-list
)
840 (ediff-make-bullet-proof-overlay
841 (nth 0 diff-list
) (nth 1 diff-list
) ediff-buffer-C
))
843 (setq overlay-list
(cons overlay overlay-list
))
844 (if (> (length diff-list
) 1)
845 (setq diff-list
(cdr (cdr diff-list
)))
846 (error "ediff-set-fine-overlays-for-combined-merge: corrupt list of
849 (setq overlay-list
(reverse overlay-list
))
850 (ediff-set-fine-diff-vector
851 reg-num
'C
(apply 'vector overlay-list
))
855 ;; Convert diff list to overlays for a given DIFF-REGION
856 ;; in buffer of type BUF-TYPE
857 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num
)
858 (let* ((current-diff -
1)
859 (reg-start (ediff-get-diff-posn buf-type
'beg region-num
))
860 (buff (ediff-get-buffer buf-type
))
861 combined-merge-diff-list
862 diff-overlay-list list-element
865 (ediff-clear-fine-differences-in-one-buffer region-num buf-type
)
866 (setq diff-list
(cdr diff-list
)) ; discard list type (words or points)
867 (ediff-with-current-buffer buff
(goto-char reg-start
))
869 ;; if it is a combined merge then set overlays in buff C specially
870 (if (and ediff-merge-job
(eq buf-type
'C
)
871 (setq combined-merge-diff-list
872 (ediff-looks-like-combined-merge region-num
)))
873 (ediff-set-fine-overlays-for-combined-merge
874 combined-merge-diff-list region-num
)
877 (setq current-diff
(1+ current-diff
)
878 list-element
(car diff-list
)
879 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
882 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
885 (if (not (or begin end
))
887 ;; Put overlays at appropriate places in buffers
888 ;; convert lines to points, if necessary
889 (setq begin
(ediff-goto-word (1+ begin
) buff
)
890 end
(ediff-goto-word end buff
'end
))
891 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
892 ;; record all overlays for this difference region
893 (setq diff-overlay-list
(nconc diff-overlay-list
(list overlay
))))
895 (setq diff-list
(cdr diff-list
))
897 ;; convert the list of difference information into a vector
899 (ediff-set-fine-diff-vector
900 region-num buf-type
(vconcat diff-overlay-list
))
904 ;; Stolen from emerge.el
905 (defun ediff-get-diff3-group (file)
906 ;; This save-excursion allows ediff-get-diff3-group to be called for the
907 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
908 ;; appear in any order. The reason this is necessary is that Gnu diff3
909 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
912 (concat "^" file
":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)\C-m?$"))
913 (beginning-of-line 2)
914 ;; treatment depends on whether it is an "a" group or a "c" group
915 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
917 (if (match-beginning 2)
918 ;; it has two numbers
920 (buffer-substring (match-beginning 1) (match-end 1)))
922 (buffer-substring (match-beginning 3) (match-end 3)))))
924 (let ((x (string-to-int
925 (buffer-substring (match-beginning 1) (match-end 1)))))
927 ;; it is an "a" group
928 (let ((x (1+ (string-to-int
929 (buffer-substring (match-beginning 1) (match-end 1))))))
933 ;; If WORD-MODE, construct vector of diffs using word numbers.
934 ;; Else, use point values.
935 ;; WORD-MODE also tells if we are in the word-mode or not.
936 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
937 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
938 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
940 ;; BOUNDS specifies visibility bounds to use.
941 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
943 (let ((A-buffer ediff-buffer-A
)
944 (B-buffer ediff-buffer-B
)
945 (C-buffer ediff-buffer-C
)
946 (anc-buffer ediff-ancestor-buffer
)
947 (a-prev 1) ; needed to set the first diff line correctly
951 diff-list shift-A shift-B shift-C
954 ;; diff list contains word numbers or points, depending on word-mode
955 (setq diff-list
(cons (if word-mode
'words
'points
)
960 (ediff-get-value-according-to-buffer-type 'A bounds
))
963 (ediff-get-value-according-to-buffer-type 'B bounds
))
967 (ediff-get-value-according-to-buffer-type 'C bounds
)))))
969 ;; reset point in buffers A, B, C
970 (ediff-with-current-buffer A-buffer
971 (goto-char (if shift-A shift-A
(point-min))))
972 (ediff-with-current-buffer B-buffer
973 (goto-char (if shift-B shift-B
(point-min))))
975 (ediff-with-current-buffer C-buffer
976 (goto-char (if shift-C shift-C
(point-min)))))
977 (if (ediff-buffer-live-p anc-buffer
)
978 (ediff-with-current-buffer anc-buffer
979 (goto-char (point-min))))
981 (ediff-with-current-buffer diff-buffer
982 (goto-char (point-min))
983 (while (re-search-forward ediff-match-diff3-line nil t
)
984 ;; leave point after matched line
985 (beginning-of-line 2)
986 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
987 ;; if the files A and B are the same and not 3way-comparison,
988 ;; ignore the difference
989 (if (or three-way-comp
(not (string-equal agreement
"3")))
990 (let* ((a-begin (car (ediff-get-diff3-group "1")))
991 (a-end (nth 1 (ediff-get-diff3-group "1")))
992 (b-begin (car (ediff-get-diff3-group "2")))
993 (b-end (nth 1 (ediff-get-diff3-group "2")))
994 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
995 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
997 (cond ((string-equal agreement
"1") 'prefer-A
)
998 ((string-equal agreement
"2") 'prefer-B
)
999 (t ediff-default-variant
)))
1000 (state-of-diff-merge
1001 (if (memq state-of-merge
'(default-A prefer-A
)) 'B
'A
))
1002 (state-of-diff-comparison
1003 (cond ((string-equal agreement
"1") 'A
)
1004 ((string-equal agreement
"2") 'B
)
1005 ((string-equal agreement
"3") 'C
)))
1011 anc-begin-pt anc-end-pt
)
1013 (setq state-of-ancestor
1014 (= c-or-anc-begin c-or-anc-end
))
1016 (cond (three-way-comp
1017 (setq c-begin c-or-anc-begin
1018 c-end c-or-anc-end
))
1019 ((eq ediff-default-variant
'default-B
)
1020 (setq c-begin b-begin
1023 (setq c-begin a-begin
1026 ;; compute main diff vector
1028 ;; make diff-list contain word numbers
1032 (- a-begin a-prev
) (- a-end a-begin
)
1033 (- b-begin b-prev
) (- b-end b-begin
)
1034 (- c-begin c-prev
) (- c-end c-begin
)
1035 nil nil
; dummy ancestor
1037 nil
; state of merge
1038 nil
; state of ancestor
1043 ;; else convert lines to points
1044 (ediff-with-current-buffer A-buffer
1045 (forward-line (- a-begin a-prev
))
1046 (setq a-begin-pt
(point))
1047 (forward-line (- a-end a-begin
))
1048 (setq a-end-pt
(point)
1050 (ediff-with-current-buffer B-buffer
1051 (forward-line (- b-begin b-prev
))
1052 (setq b-begin-pt
(point))
1053 (forward-line (- b-end b-begin
))
1054 (setq b-end-pt
(point)
1056 (ediff-with-current-buffer C-buffer
1057 (forward-line (- c-begin c-prev
))
1058 (setq c-begin-pt
(point))
1059 (forward-line (- c-end c-begin
))
1060 (setq c-end-pt
(point)
1062 (if (ediff-buffer-live-p anc-buffer
)
1063 (ediff-with-current-buffer anc-buffer
1064 (forward-line (- c-or-anc-begin anc-prev
))
1065 (setq anc-begin-pt
(point))
1066 (forward-line (- c-or-anc-end c-or-anc-begin
))
1067 (setq anc-end-pt
(point)
1068 anc-prev c-or-anc-end
)))
1072 ;; if comparing with ancestor, then there also is a
1073 ;; state-of-difference marker
1079 nil nil
; ancestor begin/end
1080 state-of-diff-comparison
1081 nil
; state of merge
1082 nil
; state of ancestor
1084 (list (vector a-begin-pt a-end-pt
1087 anc-begin-pt anc-end-pt
1095 ))) ; end ediff-with-current-buffer
1099 ;; Generate the difference vector and overlays for three files
1100 ;; File-C is either the third file to compare (in case of 3-way comparison)
1101 ;; or it is the ancestor file.
1102 (defun ediff-setup-diff-regions3 (file-A file-B file-C
)
1103 (or (ediff-buffer-live-p ediff-diff-buffer
)
1104 (setq ediff-diff-buffer
1105 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1107 (message "Computing differences ...")
1108 (ediff-exec-process ediff-diff3-program ediff-diff-buffer
'synchronize
1109 ediff-diff3-options file-A file-B file-C
)
1111 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer
)
1112 ;;(message "Computing differences ... done")
1113 (ediff-convert-diffs-to-overlays
1114 (ediff-extract-diffs3
1116 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds
)
1120 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1121 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1122 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1123 ;; string. All elements in FILES must be strings. We also delete nil from
1125 (defun ediff-exec-process (program buffer synch options
&rest files
)
1126 (let ((data (match-data))
1127 (coding-system-for-read ediff-coding-system-for-read
)
1129 (setq args
(append (split-string options
) files
))
1130 (setq args
(delete "" (delq nil args
))) ; delete nil and "" from arguments
1131 ;; the --binary option, if present, should be used only for buffer jobs
1132 ;; or for refining the differences
1133 (or (string-match "buffer" (symbol-name ediff-job-name
))
1134 (eq buffer ediff-fine-diff-buffer
)
1135 (setq args
(delete "--binary" args
)))
1137 (let ((directory default-directory
)
1142 (setq default-directory directory
)
1143 (if (or (memq system-type
'(emx ms-dos windows-nt windows-95
))
1145 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1146 ;; delete files used by other processes. Thus, in ediff-buffers
1147 ;; and similar functions, we can't delete temp files because
1148 ;; they might be used by the asynch process that computes
1149 ;; custom diffs. So, we have to wait till custom diff
1150 ;; subprocess is done.
1151 ;; Similarly for Windows-*
1152 ;; In DOS, must synchronize because DOS doesn't have
1153 ;; asynchronous processes.
1154 (apply 'call-process program nil buffer nil args
)
1155 ;; On other systems, do it asynchronously.
1156 (setq proc
(get-buffer-process buffer
))
1157 (if proc
(kill-process proc
))
1159 (apply 'start-process
"Custom Diff" buffer program args
))
1160 (setq mode-line-process
'(":%s"))
1161 (set-process-sentinel proc
'ediff-process-sentinel
)
1162 (set-process-filter proc
'ediff-process-filter
)
1164 (store-match-data data
))))
1166 ;; This is shell-command-filter from simple.el in Emacs.
1167 ;; Copied here because XEmacs doesn't have it.
1168 (defun ediff-process-filter (proc string
)
1169 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1170 ;; despite an insertion immediately after it.
1171 (let* ((obuf (current-buffer))
1172 (buffer (process-buffer proc
))
1174 (window (get-buffer-window buffer
))
1175 (pos (window-start window
)))
1179 (or (= (point) (point-max))
1180 (setq opoint
(point)))
1181 (goto-char (point-max))
1182 (insert-before-markers string
))
1183 ;; insert-before-markers moved this marker: set it back.
1184 (set-window-start window pos
)
1185 ;; Finish our save-excursion.
1188 (set-buffer obuf
))))
1190 ;; like shell-command-sentinel but doesn't print an exit status message
1191 ;; we do this because diff always exits with status 1, if diffs are found
1192 ;; so shell-command-sentinel displays a confusing message to the user
1193 (defun ediff-process-sentinel (process signal
)
1194 (if (and (memq (process-status process
) '(exit signal
))
1195 (buffer-name (process-buffer process
)))
1198 (set-buffer (process-buffer process
))
1199 (setq mode-line-process nil
))
1200 (delete-process process
))))
1203 ;;; Word functions used to refine the current diff
1205 (defvar ediff-forward-word-function
'ediff-forward-word
1206 "*Function to call to move to the next word.
1207 Used for splitting difference regions into individual words.")
1209 (defvar ediff-whitespace
" \n\t\f"
1210 "*Characters constituting white space.
1211 These characters are ignored when differing regions are split into words.")
1213 (defvar ediff-word-1
"a-zA-Z---_"
1214 "*Characters that constitute words of type 1.
1215 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1216 See `ediff-forward-word' for more details.")
1218 (defvar ediff-word-2
"0-9.,"
1219 "*Characters that constitute words of type 2.
1220 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1221 See `ediff-forward-word' for more details.")
1223 (defvar ediff-word-3
"`'?!:;\"{}[]()"
1224 "*Characters that constitute words of type 3.
1225 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1226 See `ediff-forward-word' for more details.")
1228 (defvar ediff-word-4
1229 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace
)
1230 "*Characters that constitute words of type 4.
1231 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1232 See `ediff-forward-word' for more details.")
1234 ;; Split region along word boundaries. Each word will be on its own line.
1235 ;; Output to buffer out-buffer.
1236 (defun ediff-forward-word ()
1237 "Move point one word forward.
1238 There are four types of words, each of which consists entirely of
1239 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1240 `ediff-word-4'. Words are recognized by passing these one after another as
1241 arguments to `skip-chars-forward'."
1242 (or (> (+ (skip-chars-forward ediff-word-1
)
1243 (skip-syntax-forward "w"))
1245 (> (skip-chars-forward ediff-word-2
) 0)
1246 (> (skip-chars-forward ediff-word-3
) 0)
1247 (> (skip-chars-forward ediff-word-4
) 0)
1251 (defun ediff-wordify (beg end in-buffer out-buffer
&optional control-buf
)
1252 (let (inbuf-syntax-tbl sv-point diff-string
)
1254 (set-buffer in-buffer
)
1255 (setq inbuf-syntax-tbl
1257 (ediff-with-current-buffer control-buf
1260 (setq diff-string
(buffer-substring-no-properties beg end
))
1262 (set-buffer out-buffer
)
1263 ;; Make sure that temp buff syntax table is the same a the original buf
1264 ;; syntax tbl, because we use ediff-forward-word in both and
1265 ;; ediff-forward-word depends on the syntax classes of characters.
1266 (set-syntax-table inbuf-syntax-tbl
)
1268 (insert diff-string
)
1269 (goto-char (point-min))
1270 (skip-chars-forward ediff-whitespace
)
1271 (delete-region (point-min) (point))
1274 ;; eval in control buf to let user create local versions for
1275 ;; different invocations
1278 (ediff-with-current-buffer control-buf
1279 ediff-forward-word-function
))
1280 (funcall ediff-forward-word-function
))
1281 (setq sv-point
(point))
1282 (skip-chars-forward ediff-whitespace
)
1283 (delete-region sv-point
(point))
1286 ;; copy string from BEG END from IN-BUF to OUT-BUF
1287 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer
)
1290 (set-buffer in-buffer
)
1291 (setq string
(buffer-substring beg end
))
1293 (set-buffer out-buffer
)
1296 (goto-char (point-min)))))
1299 ;; goto word #n starting at current position in buffer `buf'
1300 ;; For ediff, a word is determined by ediff-forward-word-function
1301 ;; If `flag' is non-nil, goto the end of the n-th word.
1302 (defun ediff-goto-word (n buf
&optional flag
)
1303 ;; remember val ediff-forward-word-function has in ctl buf
1304 (let ((fwd-word-fun ediff-forward-word-function
)
1305 (syntax-tbl ediff-syntax-table
))
1306 (ediff-with-current-buffer buf
1307 (skip-chars-forward ediff-whitespace
)
1309 (ediff-with-syntax-table syntax-tbl
1310 (funcall fwd-word-fun
))
1311 (skip-chars-forward ediff-whitespace
)
1313 (if (and flag
(> n
0))
1314 (funcall fwd-word-fun
))
1317 (defun ediff-same-file-contents (f1 f2
)
1318 "T if F1 and F2 have identical contents."
1320 (apply 'call-process ediff-cmp-program nil nil nil
1321 (append ediff-cmp-options
(list f1 f2
)))))
1322 (and (numberp res
) (eq res
0))))
1325 ;;; Local Variables:
1326 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1327 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1328 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1332 ;;; ediff-diff.el ends here