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"
47 ;; these two must be here to prevent ediff-test-utility from barking
48 (defcustom ediff-diff-program
"diff"
49 "*Program to use for generating the differential of the two files."
52 (defcustom ediff-diff3-program
"diff3"
53 "*Program to be used for three-way comparison.
54 Must produce output compatible with Unix's diff3 program."
58 (defcustom ediff-coding-system-for-read
'raw-text
59 "*The coding system for read to use when running the diff program as a subprocess.
60 In most cases, the default will do. However, under certain circumstances in
61 Windows NT/98/95 you might need to use something like 'raw-text-dos here.
62 So, if the output that your diff program sends to Emacs contains extra ^M's,
63 you might need to experiment here, if the default or 'raw-text-dos doesn't
68 ;; The following functions must precede all defcustom-defined variables.
70 ;; The following functions needed for setting diff/diff3 options
71 ;; test if diff supports the --binary option
72 (defsubst ediff-test-utility
(diff-util option
&optional files
)
73 (zerop (apply 'call-process
74 (append (list diff-util nil nil nil option
) files
))))
76 (defun ediff-diff-mandatory-option (diff-util)
77 (let ((file (if (boundp 'null-device
) null-device
"/dev/null")))
78 (cond ((not (memq system-type
'(ms-dos windows-nt windows-95
)))
80 ((and (string= diff-util ediff-diff-program
)
82 ediff-diff-program
"--binary" (list file file
)))
84 ((and (string= diff-util ediff-diff3-program
)
86 ediff-diff3-program
"--binary" (list file file file
)))
90 ;; make sure that mandatory options are added even if the user changes
91 ;; ediff-diff-options or ediff-diff3-options in the customization widget
92 (defun ediff-reset-diff-options (symb val
)
94 (if (eq symb
'ediff-diff-options
)
97 (mandatory-option (ediff-diff-mandatory-option diff-program
))
98 (spacer (if (string-equal mandatory-option
"") "" " ")))
100 (if (string-match mandatory-option val
)
102 (concat mandatory-option spacer val
)))
106 (defcustom ediff-shell
107 (cond ((eq system-type
'emx
) "cmd") ; OS/2
108 ((memq system-type
'(ms-dos windows-nt windows-95
))
109 shell-file-name
) ; no standard name on MS-DOS
110 ((memq system-type
'(vax-vms axp-vms
)) "*dcl*") ; VMS
112 "*The shell used to run diff and patch. If user's .profile or
113 .cshrc files are set up correctly, any shell will do. However, some people
114 set $prompt or other things incorrectly, which leads to undesirable output
115 messages. These may cause Ediff to fail. In such a case, set ediff-shell
116 to a shell that you are not using or, better, fix your shell's startup file."
120 (defcustom ediff-cmp-program
"cmp"
121 "*Utility to use to determine if two files are identical.
122 It must return code 0, if its arguments are identical files."
126 (defcustom ediff-cmp-options nil
127 "*Options to pass to `ediff-cmp-program'. If GNUS diff is used as
128 `ediff-cmp-program', then the most useful options are `-I' RE, to
129 ignore changes whose lines all match RE."
130 :type
'(repeat string
)
133 (defcustom ediff-diff-options
""
134 "*Options to pass to `ediff-diff-program'.
135 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
136 `-w', to ignore space, and `-i', to ignore case of letters.
137 At present, the option `-c' is not allowed."
138 :set
'ediff-reset-diff-options
142 (defcustom ediff-custom-diff-program ediff-diff-program
143 "*Program to use for generating custom diff output for saving it in a file.
144 This output is not used by Ediff internally."
147 (defcustom ediff-custom-diff-options
"-c"
148 "*Options to pass to `ediff-custom-diff-program'."
152 ;;; Support for diff3
154 (defvar ediff-match-diff3-line
"^====\\(.?\\)$"
155 "Pattern to match lines produced by diff3 that describe differences.")
156 (defcustom ediff-diff3-options
""
157 "*Options to pass to `ediff-diff3-program'."
158 :set
'ediff-reset-diff-options
161 (defcustom ediff-diff3-ok-lines-regexp
162 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
163 "*Regexp that matches normal output lines from `ediff-diff3-program'.
164 Lines that do not match are assumed to be error messages."
168 ;; keeps the status of the current diff in 3-way jobs.
169 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
170 (ediff-defvar-local ediff-diff-status
"" "")
175 (ediff-defvar-local ediff-auto-refine
(if (ediff-has-face-support-p) 'on
'nix
)
176 "If `on', Ediff auto-highlights fine diffs for the current diff region.
177 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
178 at all, unless the user force-refines the region by hitting `*'.
180 This variable can be set either in .emacs or toggled interactively.
181 Use `setq-default' if setting it in .emacs")
183 (ediff-defvar-local ediff-ignore-similar-regions nil
184 "*If t, skip over difference regions that differ only in the white space and line breaks.
185 This variable can be set either in .emacs or toggled interactively.
186 Use `setq-default' if setting it in .emacs")
188 (ediff-defvar-local ediff-auto-refine-limit
1400
189 "*Auto-refine only the regions of this size \(in bytes\) or less.")
193 (defvar ediff-diff-ok-lines-regexp
196 "[0-9,]+[acd][0-9,]+\C-m?$"
201 "\\|.*missing +newline"
204 "Regexp that matches normal output lines from `ediff-diff-program'.
205 This is mostly lifted from Emerge, except that Ediff also considers
206 warnings and `Missing newline'-type messages to be normal output.
207 Lines that do not match are assumed to be error messages.")
209 (defvar ediff-match-diff-line
210 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
211 (concat "^" x
"\\([acd]\\)" x
"\C-m?$"))
212 "Pattern to match lines produced by diff that describe differences.")
214 (ediff-defvar-local ediff-setup-diff-regions-function nil
215 "value is a function symbol depending on the kind of job is to be done.
216 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
217 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
219 The function should take three mandatory arguments, file-A, file-B, and
220 file-C. It may ignore file C for diff2 jobs. It should also take
221 one optional arguments, diff-number to refine.")
226 ;; Generate the difference vector and overlays for the two files
227 ;; With optional arg REG-TO-REFINE, refine this region.
228 ;; File-C argument is not used here. It is there just because
229 ;; ediff-setup-diff-regions is called via a funcall to
230 ;; ediff-setup-diff-regions-function, which can also have the value
231 ;; ediff-setup-diff-regions3, which takes 4 arguments.
232 (defun ediff-setup-diff-regions (file-A file-B file-C
)
233 (if (string-match "c" ediff-diff-options
)
234 (error "Option `-c' is not allowed in `ediff-diff-options'"))
236 ;; create, if it doesn't exist
237 (or (ediff-buffer-live-p ediff-diff-buffer
)
238 (setq ediff-diff-buffer
239 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
240 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B
)
241 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer
)
242 (ediff-convert-diffs-to-overlays
244 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds
)))
246 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
247 ;; Return the size of DIFF-BUFFER
248 ;; The return code isn't used in the program at present.
249 (defun ediff-make-diff2-buffer (diff-buffer file1 file2
)
250 (let ((file1-size (ediff-file-size file1
))
251 (file2-size (ediff-file-size file2
)))
252 (cond ((not (numberp file1-size
))
253 (message "Can't find file: %s"
254 (ediff-abbreviate-file-name file1
))
256 ;; 1 is an error exit code
258 ((not (numberp file2-size
))
259 (message "Can't find file: %s"
260 (ediff-abbreviate-file-name file2
))
262 ;; 1 is an error exit code
264 (t (message "Computing differences between %s and %s ..."
265 (file-name-nondirectory file1
)
266 (file-name-nondirectory file2
))
267 ;; this erases the diff buffer automatically
268 (ediff-exec-process ediff-diff-program
271 ediff-diff-options file1 file2
)
273 (ediff-with-current-buffer diff-buffer
278 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
279 ;; This function works for diff3 and diff2 jobs
280 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num
)
281 (or (ediff-buffer-live-p ediff-fine-diff-buffer
)
282 (setq ediff-fine-diff-buffer
284 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
286 (let (diff3-job diff-program diff-options ok-regexp diff-list
)
287 (setq diff3-job ediff-3way-job
288 diff-program
(if diff3-job ediff-diff3-program ediff-diff-program
)
289 diff-options
(if diff3-job ediff-diff3-options ediff-diff-options
)
290 ok-regexp
(if diff3-job
291 ediff-diff3-ok-lines-regexp
292 ediff-diff-ok-lines-regexp
))
294 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num
))
295 (ediff-exec-process diff-program ediff-fine-diff-buffer
'synchronize
297 ;; The shuffle below is because we can compare 3-way
298 ;; or in several 2-way fashions, like fA fC, fA fB,
300 (if file-A file-A file-B
)
301 (if file-B file-B file-A
)
303 (if file-C file-C file-B
))
306 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer
)
307 (ediff-message-if-verbose
309 ;; "Refining difference region %d ... done" (1+ reg-num))
313 (ediff-extract-diffs3
314 ediff-fine-diff-buffer
'3way-comparison
'word-mode
)
315 (ediff-extract-diffs ediff-fine-diff-buffer
'word-mode
)))
319 (mapcar (lambda (elt)
324 (mapcar (lambda (elt)
329 (mapcar (lambda (elt)
335 (ediff-convert-fine-diffs-to-overlays diff-list reg-num
)
339 (defun ediff-prepare-error-list (ok-regexp diff-buff
)
340 (or (ediff-buffer-live-p ediff-error-buffer
)
341 (setq ediff-error-buffer
342 (get-buffer-create (ediff-unique-buffer-name
343 "*ediff-errors" "*"))))
344 (ediff-with-current-buffer ediff-error-buffer
346 (insert (ediff-with-current-buffer diff-buff
(buffer-string)))
347 (goto-char (point-min))
348 (delete-matching-lines ok-regexp
)
349 (if (memq system-type
'(vax-vms axp-vms
))
350 (delete-matching-lines "^$")))
351 ;; If diff reports errors, show them then quit.
352 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer
(buffer-size)))
353 (let ((ctl-buf ediff-control-buffer
)
354 (error-buf ediff-error-buffer
))
355 (ediff-skip-unsuitable-frames)
356 (switch-to-buffer error-buf
)
357 (ediff-kill-buffer-carefully ctl-buf
)
358 (error "Errors in diff output. Diff output is in %S" diff-buff
))))
360 ;; BOUNDS specifies visibility bounds to use.
361 ;; WORD-MODE tells whether we are in the word-mode or not.
362 ;; If WORD-MODE, also construct vector of diffs using word numbers.
363 ;; Else, use point values.
364 ;; This function handles diff-2 jobs including the case of
365 ;; merging buffers and files without ancestor.
366 (defun ediff-extract-diffs (diff-buffer word-mode
&optional bounds
)
367 (let ((A-buffer ediff-buffer-A
)
368 (B-buffer ediff-buffer-B
)
369 (C-buffer ediff-buffer-C
)
370 (a-prev 1) ; this is needed to set the first diff line correctly
373 diff-list shift-A shift-B
376 ;; diff list contains word numbers, unless changed later
377 (setq diff-list
(cons (if word-mode
'words
'points
)
379 ;; we don't use visibility bounds for buffer C when merging
383 (ediff-get-value-according-to-buffer-type 'A bounds
))
386 (ediff-get-value-according-to-buffer-type 'B bounds
))))
388 ;; reset point in buffers A/B/C
389 (ediff-with-current-buffer A-buffer
390 (goto-char (if shift-A shift-A
(point-min))))
391 (ediff-with-current-buffer B-buffer
392 (goto-char (if shift-B shift-B
(point-min))))
393 (if (ediff-buffer-live-p C-buffer
)
394 (ediff-with-current-buffer C-buffer
395 (goto-char (point-min))))
397 (ediff-with-current-buffer diff-buffer
398 (goto-char (point-min))
399 (while (re-search-forward ediff-match-diff-line nil t
)
400 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
402 (a-end (let ((b (match-beginning 3))
405 (string-to-int (buffer-substring b e
))
407 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
408 (b-begin (string-to-int (buffer-substring (match-beginning 5)
410 (b-end (let ((b (match-beginning 7))
413 (string-to-int (buffer-substring b e
))
415 a-begin-pt a-end-pt b-begin-pt b-end-pt
416 c-begin c-end c-begin-pt c-end-pt
)
417 ;; fix the beginning and end numbers, because diff is somewhat
418 ;; strange about how it numbers lines
419 (if (string-equal diff-type
"a")
420 (setq b-end
(1+ b-end
)
423 (if (string-equal diff-type
"d")
424 (setq a-end
(1+ a-end
)
427 ;; (string-equal diff-type "c")
428 (setq a-end
(1+ a-end
)
431 (if (eq ediff-default-variant
'default-B
)
432 (setq c-begin b-begin
434 (setq c-begin a-begin
437 ;; compute main diff vector
439 ;; make diff-list contain word numbers
443 (if (ediff-buffer-live-p C-buffer
)
444 (vector (- a-begin a-prev
) (- a-end a-begin
)
445 (- b-begin b-prev
) (- b-end b-begin
)
446 (- c-begin c-prev
) (- c-end c-begin
)
447 nil nil
; dummy ancestor
450 nil
; state of ancestor
452 (vector (- a-begin a-prev
) (- a-end a-begin
)
453 (- b-begin b-prev
) (- b-end b-begin
)
454 nil nil
; dummy buf C
455 nil nil
; dummy ancestor
458 nil
; state of ancestor
464 ;; else convert lines to points
465 (ediff-with-current-buffer A-buffer
466 (forward-line (- a-begin a-prev
))
467 (setq a-begin-pt
(point))
468 (forward-line (- a-end a-begin
))
469 (setq a-end-pt
(point)
471 (ediff-with-current-buffer B-buffer
472 (forward-line (- b-begin b-prev
))
473 (setq b-begin-pt
(point))
474 (forward-line (- b-end b-begin
))
475 (setq b-end-pt
(point)
477 (if (ediff-buffer-live-p C-buffer
)
478 (ediff-with-current-buffer C-buffer
479 (forward-line (- c-begin c-prev
))
480 (setq c-begin-pt
(point))
481 (forward-line (- c-end c-begin
))
482 (setq c-end-pt
(point)
488 (if (ediff-buffer-live-p C-buffer
)
490 a-begin-pt a-end-pt b-begin-pt b-end-pt
492 nil nil
; dummy ancestor
494 ;; shows which buff is different from the other two
495 (if (eq ediff-default-variant
'default-B
) 'A
'B
)
496 ediff-default-variant
; state of merge
497 nil
; state of ancestor
499 (vector a-begin-pt a-end-pt
501 nil nil
; dummy buf C
502 nil nil
; dummy ancestor
503 nil nil
; dummy state of diff & merge
504 nil
; dummy state of ancestor
508 ))) ; end ediff-with-current-buffer
513 (defun ediff-convert-diffs-to-overlays (diff-list)
514 (ediff-set-diff-overlays-in-one-buffer 'A diff-list
)
515 (ediff-set-diff-overlays-in-one-buffer 'B diff-list
)
517 (ediff-set-diff-overlays-in-one-buffer 'C diff-list
))
518 (if ediff-merge-with-ancestor-job
519 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list
))
520 ;; set up vector showing the status of merge regions
522 (setq ediff-state-of-merge
524 (mapcar (lambda (elt)
525 (let ((state-of-merge (aref elt
9))
526 (state-of-ancestor (aref elt
10)))
528 ;; state of merge: prefers/default-A/B or combined
529 (if state-of-merge
(format "%S" state-of-merge
))
530 ;; whether the ancestor region is empty
532 ;; the first elt designates type of list
535 (message "Processing difference regions ... done"))
538 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list
)
539 (let* ((current-diff -
1)
540 (buff (ediff-get-buffer buf-type
))
541 ;; ediff-extract-diffs puts the type of diff-list as the first elt
542 ;; of this list. The type is either 'points or 'words
543 (diff-list-type (car diff-list
))
544 (shift (ediff-overlay-start
545 (ediff-get-value-according-to-buffer-type
546 buf-type ediff-narrow-bounds
)))
547 (limit (ediff-overlay-end
548 (ediff-get-value-according-to-buffer-type
549 buf-type ediff-narrow-bounds
)))
550 diff-overlay-list list-element total-diffs
551 begin end pt-saved overlay state-of-diff
)
553 (setq diff-list
(cdr diff-list
)) ; discard diff list type
554 (setq total-diffs
(length diff-list
))
556 ;; shift, if necessary
557 (ediff-with-current-buffer buff
(setq pt-saved shift
))
560 (setq current-diff
(1+ current-diff
)
561 list-element
(car diff-list
)
562 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
566 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
570 state-of-diff
(aref list-element
8)
573 (cond ((and (not (eq buf-type state-of-diff
))
574 (not (eq buf-type
'Ancestor
))
575 (memq state-of-diff
'(A B C
)))
577 (car (delq buf-type
(delq state-of-diff
(list 'A
'B
'C
)))))
578 (setq state-of-diff
(format "=diff(%S)" state-of-diff
))
580 (t (setq state-of-diff nil
)))
582 ;; Put overlays at appropriate places in buffer
583 ;; convert word numbers to points, if necessary
584 (if (eq diff-list-type
'words
)
586 (ediff-with-current-buffer buff
(goto-char pt-saved
))
587 (setq begin
(ediff-goto-word (1+ begin
) buff
)
588 end
(ediff-goto-word end buff
'end
))
589 (if (> end limit
) (setq end limit
))
590 (if (> begin end
) (setq begin end
))
591 (setq pt-saved
(ediff-with-current-buffer buff
(point)))))
592 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
594 (ediff-overlay-put overlay
'priority ediff-shadow-overlay-priority
)
595 (ediff-overlay-put overlay
'ediff-diff-num current-diff
)
596 (if (and (ediff-has-face-support-p)
597 ediff-use-faces ediff-highlight-all-diffs
)
598 (ediff-set-overlay-face
599 overlay
(ediff-background-face buf-type current-diff
)))
601 (if (= 0 (mod current-diff
10))
602 (message "Buffer %S: Processing difference region %d of %d"
603 buf-type current-diff total-diffs
))
604 ;; Record all overlays for this difference.
605 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
606 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
607 ;; The 4-th elt says which diff region is different from the other two
608 ;; (3-way jobs only).
609 (setq diff-overlay-list
612 (list (vector overlay nil nil state-of-diff
)))
617 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist
)
618 (vconcat diff-overlay-list
))
621 ;; `n' is the diff region to work on. Default is ediff-current-difference.
622 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
623 ;; diffs have not been computed before.
624 ;; if `flag' is 'skip then don't compute fine diffs for this region.
625 (defun ediff-make-fine-diffs (&optional n flag
)
626 (or n
(setq n ediff-current-difference
))
628 (if (< ediff-number-of-differences
1)
629 (error ediff-NO-DIFFERENCES
))
633 ediff-auto-refine
'nix
))
636 (>= n ediff-number-of-differences
)
637 ;; n is within the range
638 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
639 (file-A ediff-temp-file-A
)
640 (file-B ediff-temp-file-B
)
641 (file-C ediff-temp-file-C
)
642 (empty-A (ediff-empty-diff-region-p n
'A
))
643 (empty-B (ediff-empty-diff-region-p n
'B
))
644 (empty-C (ediff-empty-diff-region-p n
'C
))
645 (whitespace-A (ediff-whitespace-diff-region-p n
'A
))
646 (whitespace-B (ediff-whitespace-diff-region-p n
'B
))
647 (whitespace-C (ediff-whitespace-diff-region-p n
'C
))
648 cumulative-fine-diff-length
)
650 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
651 ;; then don't refine.
652 ;; If the region happens to be entirely whitespace or empty then
654 ((> (length (delq nil
(list empty-A empty-B empty-C
))) 1)
655 (if (and (ediff-looks-like-combined-merge n
)
657 (ediff-set-fine-overlays-in-one-buffer 'C nil n
))
658 (if ediff-3way-comparison-job
659 (ediff-message-if-verbose
660 "Region %d is empty in all buffers but %S"
662 (cond ((not empty-A
) 'A
)
665 (ediff-message-if-verbose
666 "Region %d in buffer %S is empty"
672 ;; if all regions happen to be whitespace
673 (if (and whitespace-A whitespace-B whitespace-C
)
674 ;; mark as space only
675 (ediff-mark-diff-as-space-only n t
)
676 ;; if some regions are white and others don't, then mark as
677 ;; non-white-space-only
678 (ediff-mark-diff-as-space-only n nil
)))
680 ;; don't compute fine diffs if diff vector exists
681 ((and (eq flag
'noforce
) (ediff-get-fine-diff-vector n
'A
))
682 (if (ediff-no-fine-diffs-p n
)
684 "Only white-space differences in region %d %s"
686 (cond ((eq (ediff-no-fine-diffs-p n
) 'A
)
688 ((eq (ediff-no-fine-diffs-p n
) 'B
)
690 ((eq (ediff-no-fine-diffs-p n
) 'C
)
693 ;; don't compute fine diffs for this region
695 (or (ediff-get-fine-diff-vector n
'A
)
696 (memq ediff-auto-refine
'(off nix
))
697 (ediff-message-if-verbose
698 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
700 (substitute-command-keys
701 "\\[ediff-make-or-kill-fine-diffs]")
704 ;; recompute fine diffs
706 (ediff-get-diff-posn 'A
'beg n
)
707 (ediff-get-diff-posn 'A
'end n
)
710 ediff-control-buffer
)
712 (ediff-make-temp-file tmp-buffer
"fineDiffA" file-A
))
715 (ediff-get-diff-posn 'B
'beg n
)
716 (ediff-get-diff-posn 'B
'end n
)
719 ediff-control-buffer
)
721 (ediff-make-temp-file tmp-buffer
"fineDiffB" file-B
))
726 (ediff-get-diff-posn 'C
'beg n
)
727 (ediff-get-diff-posn 'C
'end n
)
730 ediff-control-buffer
)
732 (ediff-make-temp-file
733 tmp-buffer
"fineDiffC" file-C
))))
735 ;; save temp file names.
736 (setq ediff-temp-file-A file-A
737 ediff-temp-file-B file-B
738 ediff-temp-file-C file-C
)
740 ;; set the new vector of fine diffs, if none exists
741 (cond ((and ediff-3way-job whitespace-A
)
742 (ediff-setup-fine-diff-regions nil file-B file-C n
))
743 ((and ediff-3way-job whitespace-B
)
744 (ediff-setup-fine-diff-regions file-A nil file-C n
))
746 ;; In merge-jobs, whitespace-C is t, since
747 ;; ediff-empty-diff-region-p returns t in this case
749 (ediff-setup-fine-diff-regions file-A file-B nil n
))
751 (ediff-setup-fine-diff-regions file-A file-B file-C n
)))
753 (setq cumulative-fine-diff-length
754 (+ (length (ediff-get-fine-diff-vector n
'A
))
755 (length (ediff-get-fine-diff-vector n
'B
))
756 ;; in merge jobs, the merge buffer is never refined
757 (if (and file-C
(not ediff-merge-job
))
758 (length (ediff-get-fine-diff-vector n
'C
))
762 ;; all regions are white space
763 (and whitespace-A whitespace-B whitespace-C
)
764 ;; none is white space and no fine diffs detected
765 (and (not whitespace-A
)
767 (not (and ediff-3way-job whitespace-C
))
768 (eq cumulative-fine-diff-length
0)))
769 (ediff-mark-diff-as-space-only n t
)
770 (ediff-message-if-verbose
771 "Only white-space differences in region %d" (1+ n
)))
772 ((eq cumulative-fine-diff-length
0)
773 (ediff-message-if-verbose
774 "Only white-space differences in region %d %s"
776 (cond (whitespace-A (ediff-mark-diff-as-space-only n
'A
)
778 (whitespace-B (ediff-mark-diff-as-space-only n
'B
)
780 (whitespace-C (ediff-mark-diff-as-space-only n
'C
)
781 "in buffers A & B"))))
783 (ediff-mark-diff-as-space-only n nil
)))
786 (ediff-set-fine-diff-properties n
)
789 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
790 (defun ediff-install-fine-diff-if-necessary (n)
791 (cond ((eq ediff-auto-refine
'on
)
793 (> ediff-auto-refine-limit
794 (- (ediff-get-diff-posn 'A
'end n
)
795 (ediff-get-diff-posn 'A
'beg n
)))
796 (> ediff-auto-refine-limit
797 (- (ediff-get-diff-posn 'B
'end n
)
798 (ediff-get-diff-posn 'B
'beg n
))))
799 (ediff-make-fine-diffs n
'noforce
)
800 (ediff-make-fine-diffs n
'skip
)))
802 ;; highlight iff fine diffs already exist
803 ((eq ediff-auto-refine
'off
)
804 (ediff-make-fine-diffs n
'skip
))))
807 ;; if fine diff vector is not set for diff N, then do nothing
808 (defun ediff-set-fine-diff-properties (n &optional default
)
809 (or (not (ediff-has-face-support-p))
811 (>= n ediff-number-of-differences
)
812 ;; when faces are supported, set faces and priorities of fine overlays
814 (ediff-set-fine-diff-properties-in-one-buffer 'A n default
)
815 (ediff-set-fine-diff-properties-in-one-buffer 'B n default
)
817 (ediff-set-fine-diff-properties-in-one-buffer 'C n default
)))))
819 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
821 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type
))
825 (ediff-get-symbol-from-alist
826 buf-type ediff-fine-diff-face-alist
))))
827 (priority (if default
829 (1+ (or (ediff-overlay-get
831 (ediff-get-symbol-from-alist
833 ediff-current-diff-overlay-alist
))
836 (mapcar (lambda (overl)
837 (ediff-set-overlay-face overl face
)
838 (ediff-overlay-put overl
'priority priority
))
841 ;; Set overlays over the regions that denote delimiters
842 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num
)
843 (let (overlay overlay-list
)
847 (ediff-make-bullet-proof-overlay
848 (nth 0 diff-list
) (nth 1 diff-list
) ediff-buffer-C
))
850 (setq overlay-list
(cons overlay overlay-list
))
851 (if (> (length diff-list
) 1)
852 (setq diff-list
(cdr (cdr diff-list
)))
853 (error "ediff-set-fine-overlays-for-combined-merge: corrupt list of
856 (setq overlay-list
(reverse overlay-list
))
857 (ediff-set-fine-diff-vector
858 reg-num
'C
(apply 'vector overlay-list
))
862 ;; Convert diff list to overlays for a given DIFF-REGION
863 ;; in buffer of type BUF-TYPE
864 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num
)
865 (let* ((current-diff -
1)
866 (reg-start (ediff-get-diff-posn buf-type
'beg region-num
))
867 (buff (ediff-get-buffer buf-type
))
868 combined-merge-diff-list
869 diff-overlay-list list-element
872 (ediff-clear-fine-differences-in-one-buffer region-num buf-type
)
873 (setq diff-list
(cdr diff-list
)) ; discard list type (words or points)
874 (ediff-with-current-buffer buff
(goto-char reg-start
))
876 ;; if it is a combined merge then set overlays in buff C specially
877 (if (and ediff-merge-job
(eq buf-type
'C
)
878 (setq combined-merge-diff-list
879 (ediff-looks-like-combined-merge region-num
)))
880 (ediff-set-fine-overlays-for-combined-merge
881 combined-merge-diff-list region-num
)
884 (setq current-diff
(1+ current-diff
)
885 list-element
(car diff-list
)
886 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
889 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
892 (if (not (or begin end
))
894 ;; Put overlays at appropriate places in buffers
895 ;; convert lines to points, if necessary
896 (setq begin
(ediff-goto-word (1+ begin
) buff
)
897 end
(ediff-goto-word end buff
'end
))
898 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
899 ;; record all overlays for this difference region
900 (setq diff-overlay-list
(nconc diff-overlay-list
(list overlay
))))
902 (setq diff-list
(cdr diff-list
))
904 ;; convert the list of difference information into a vector
906 (ediff-set-fine-diff-vector
907 region-num buf-type
(vconcat diff-overlay-list
))
911 ;; Stolen from emerge.el
912 (defun ediff-get-diff3-group (file)
913 ;; This save-excursion allows ediff-get-diff3-group to be called for the
914 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
915 ;; appear in any order. The reason this is necessary is that Gnu diff3
916 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
919 (concat "^" file
":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
920 (beginning-of-line 2)
921 ;; treatment depends on whether it is an "a" group or a "c" group
922 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
924 (if (match-beginning 2)
925 ;; it has two numbers
927 (buffer-substring (match-beginning 1) (match-end 1)))
929 (buffer-substring (match-beginning 3) (match-end 3)))))
931 (let ((x (string-to-int
932 (buffer-substring (match-beginning 1) (match-end 1)))))
934 ;; it is an "a" group
935 (let ((x (1+ (string-to-int
936 (buffer-substring (match-beginning 1) (match-end 1))))))
940 ;; If WORD-MODE, construct vector of diffs using word numbers.
941 ;; Else, use point values.
942 ;; WORD-MODE also tells if we are in the word-mode or not.
943 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
944 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
945 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
947 ;; BOUNDS specifies visibility bounds to use.
948 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
950 (let ((A-buffer ediff-buffer-A
)
951 (B-buffer ediff-buffer-B
)
952 (C-buffer ediff-buffer-C
)
953 (anc-buffer ediff-ancestor-buffer
)
954 (a-prev 1) ; needed to set the first diff line correctly
958 diff-list shift-A shift-B shift-C
961 ;; diff list contains word numbers or points, depending on word-mode
962 (setq diff-list
(cons (if word-mode
'words
'points
)
967 (ediff-get-value-according-to-buffer-type 'A bounds
))
970 (ediff-get-value-according-to-buffer-type 'B bounds
))
974 (ediff-get-value-according-to-buffer-type 'C bounds
)))))
976 ;; reset point in buffers A, B, C
977 (ediff-with-current-buffer A-buffer
978 (goto-char (if shift-A shift-A
(point-min))))
979 (ediff-with-current-buffer B-buffer
980 (goto-char (if shift-B shift-B
(point-min))))
982 (ediff-with-current-buffer C-buffer
983 (goto-char (if shift-C shift-C
(point-min)))))
984 (if (ediff-buffer-live-p anc-buffer
)
985 (ediff-with-current-buffer anc-buffer
986 (goto-char (point-min))))
988 (ediff-with-current-buffer diff-buffer
989 (goto-char (point-min))
990 (while (re-search-forward ediff-match-diff3-line nil t
)
991 ;; leave point after matched line
992 (beginning-of-line 2)
993 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
994 ;; if the files A and B are the same and not 3way-comparison,
995 ;; ignore the difference
996 (if (or three-way-comp
(not (string-equal agreement
"3")))
997 (let* ((a-begin (car (ediff-get-diff3-group "1")))
998 (a-end (nth 1 (ediff-get-diff3-group "1")))
999 (b-begin (car (ediff-get-diff3-group "2")))
1000 (b-end (nth 1 (ediff-get-diff3-group "2")))
1001 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
1002 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
1004 (cond ((string-equal agreement
"1") 'prefer-A
)
1005 ((string-equal agreement
"2") 'prefer-B
)
1006 (t ediff-default-variant
)))
1007 (state-of-diff-merge
1008 (if (memq state-of-merge
'(default-A prefer-A
)) 'B
'A
))
1009 (state-of-diff-comparison
1010 (cond ((string-equal agreement
"1") 'A
)
1011 ((string-equal agreement
"2") 'B
)
1012 ((string-equal agreement
"3") 'C
)))
1018 anc-begin-pt anc-end-pt
)
1020 (setq state-of-ancestor
1021 (= c-or-anc-begin c-or-anc-end
))
1023 (cond (three-way-comp
1024 (setq c-begin c-or-anc-begin
1025 c-end c-or-anc-end
))
1026 ((eq ediff-default-variant
'default-B
)
1027 (setq c-begin b-begin
1030 (setq c-begin a-begin
1033 ;; compute main diff vector
1035 ;; make diff-list contain word numbers
1039 (- a-begin a-prev
) (- a-end a-begin
)
1040 (- b-begin b-prev
) (- b-end b-begin
)
1041 (- c-begin c-prev
) (- c-end c-begin
)
1042 nil nil
; dummy ancestor
1044 nil
; state of merge
1045 nil
; state of ancestor
1050 ;; else convert lines to points
1051 (ediff-with-current-buffer A-buffer
1052 (forward-line (- a-begin a-prev
))
1053 (setq a-begin-pt
(point))
1054 (forward-line (- a-end a-begin
))
1055 (setq a-end-pt
(point)
1057 (ediff-with-current-buffer B-buffer
1058 (forward-line (- b-begin b-prev
))
1059 (setq b-begin-pt
(point))
1060 (forward-line (- b-end b-begin
))
1061 (setq b-end-pt
(point)
1063 (ediff-with-current-buffer C-buffer
1064 (forward-line (- c-begin c-prev
))
1065 (setq c-begin-pt
(point))
1066 (forward-line (- c-end c-begin
))
1067 (setq c-end-pt
(point)
1069 (if (ediff-buffer-live-p anc-buffer
)
1070 (ediff-with-current-buffer anc-buffer
1071 (forward-line (- c-or-anc-begin anc-prev
))
1072 (setq anc-begin-pt
(point))
1073 (forward-line (- c-or-anc-end c-or-anc-begin
))
1074 (setq anc-end-pt
(point)
1075 anc-prev c-or-anc-end
)))
1079 ;; if comparing with ancestor, then there also is a
1080 ;; state-of-difference marker
1086 nil nil
; ancestor begin/end
1087 state-of-diff-comparison
1088 nil
; state of merge
1089 nil
; state of ancestor
1091 (list (vector a-begin-pt a-end-pt
1094 anc-begin-pt anc-end-pt
1102 ))) ; end ediff-with-current-buffer
1106 ;; Generate the difference vector and overlays for three files
1107 ;; File-C is either the third file to compare (in case of 3-way comparison)
1108 ;; or it is the ancestor file.
1109 (defun ediff-setup-diff-regions3 (file-A file-B file-C
)
1110 (or (ediff-buffer-live-p ediff-diff-buffer
)
1111 (setq ediff-diff-buffer
1112 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1114 (message "Computing differences ...")
1115 (ediff-exec-process ediff-diff3-program ediff-diff-buffer
'synchronize
1116 ediff-diff3-options file-A file-B file-C
)
1118 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer
)
1119 ;;(message "Computing differences ... done")
1120 (ediff-convert-diffs-to-overlays
1121 (ediff-extract-diffs3
1123 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds
)
1127 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1128 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1129 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1130 ;; string. All elements in FILES must be strings. We also delete nil from
1132 (defun ediff-exec-process (program buffer synch options
&rest files
)
1133 (let ((data (match-data))
1134 (coding-system-for-read ediff-coding-system-for-read
)
1136 (setq args
(append (split-string options
) files
))
1137 (setq args
(delete "" (delq nil args
))) ; delete nil and "" from arguments
1138 ;; the --binary option, if present, should be used only for buffer jobs
1139 ;; or for refining the differences
1140 (or (string-match "buffer" (symbol-name ediff-job-name
))
1141 (eq buffer ediff-fine-diff-buffer
)
1142 (setq args
(delete "--binary" args
)))
1144 (let ((directory default-directory
)
1149 (setq default-directory directory
)
1150 (if (or (memq system-type
'(emx ms-dos windows-nt windows-95
))
1152 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1153 ;; delete files used by other processes. Thus, in ediff-buffers
1154 ;; and similar functions, we can't delete temp files because
1155 ;; they might be used by the asynch process that computes
1156 ;; custom diffs. So, we have to wait till custom diff
1157 ;; subprocess is done.
1158 ;; Similarly for Windows-*
1159 ;; In DOS, must synchronize because DOS doesn't have
1160 ;; asynchronous processes.
1161 (apply 'call-process program nil buffer nil args
)
1162 ;; On other systems, do it asynchronously.
1163 (setq proc
(get-buffer-process buffer
))
1164 (if proc
(kill-process proc
))
1166 (apply 'start-process
"Custom Diff" buffer program args
))
1167 (setq mode-line-process
'(":%s"))
1168 (set-process-sentinel proc
'ediff-process-sentinel
)
1169 (set-process-filter proc
'ediff-process-filter
)
1171 (store-match-data data
))))
1173 ;; This is shell-command-filter from simple.el in Emacs.
1174 ;; Copied here because XEmacs doesn't have it.
1175 (defun ediff-process-filter (proc string
)
1176 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1177 ;; despite an insertion immediately after it.
1178 (let* ((obuf (current-buffer))
1179 (buffer (process-buffer proc
))
1181 (window (get-buffer-window buffer
))
1182 (pos (window-start window
)))
1186 (or (= (point) (point-max))
1187 (setq opoint
(point)))
1188 (goto-char (point-max))
1189 (insert-before-markers string
))
1190 ;; insert-before-markers moved this marker: set it back.
1191 (set-window-start window pos
)
1192 ;; Finish our save-excursion.
1195 (set-buffer obuf
))))
1197 ;; like shell-command-sentinel but doesn't print an exit status message
1198 ;; we do this because diff always exits with status 1, if diffs are found
1199 ;; so shell-command-sentinel displays a confusing message to the user
1200 (defun ediff-process-sentinel (process signal
)
1201 (if (and (memq (process-status process
) '(exit signal
))
1202 (buffer-name (process-buffer process
)))
1205 (set-buffer (process-buffer process
))
1206 (setq mode-line-process nil
))
1207 (delete-process process
))))
1210 ;;; Word functions used to refine the current diff
1212 (defvar ediff-forward-word-function
'ediff-forward-word
1213 "*Function to call to move to the next word.
1214 Used for splitting difference regions into individual words.")
1216 (defvar ediff-whitespace
" \n\t\f"
1217 "*Characters constituting white space.
1218 These characters are ignored when differing regions are split into words.")
1220 (defvar ediff-word-1
"a-zA-Z---_"
1221 "*Characters that constitute words of type 1.
1222 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1223 See `ediff-forward-word' for more details.")
1225 (defvar ediff-word-2
"0-9.,"
1226 "*Characters that constitute words of type 2.
1227 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1228 See `ediff-forward-word' for more details.")
1230 (defvar ediff-word-3
"`'?!:;\"{}[]()"
1231 "*Characters that constitute words of type 3.
1232 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1233 See `ediff-forward-word' for more details.")
1235 (defvar ediff-word-4
1236 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace
)
1237 "*Characters that constitute words of type 4.
1238 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1239 See `ediff-forward-word' for more details.")
1241 ;; Split region along word boundaries. Each word will be on its own line.
1242 ;; Output to buffer out-buffer.
1243 (defun ediff-forward-word ()
1244 "Move point one word forward.
1245 There are four types of words, each of which consists entirely of
1246 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1247 `ediff-word-4'. Words are recognized by passing these one after another as
1248 arguments to `skip-chars-forward'."
1249 (or (> (+ (skip-chars-forward ediff-word-1
)
1250 (skip-syntax-forward "w"))
1252 (> (skip-chars-forward ediff-word-2
) 0)
1253 (> (skip-chars-forward ediff-word-3
) 0)
1254 (> (skip-chars-forward ediff-word-4
) 0)
1258 (defun ediff-wordify (beg end in-buffer out-buffer
&optional control-buf
)
1259 (let (inbuf-syntax-tbl sv-point diff-string
)
1261 (set-buffer in-buffer
)
1262 (setq inbuf-syntax-tbl
1264 (ediff-with-current-buffer control-buf
1267 (setq diff-string
(buffer-substring-no-properties beg end
))
1269 (set-buffer out-buffer
)
1270 ;; Make sure that temp buff syntax table is the same a the original buf
1271 ;; syntax tbl, because we use ediff-forward-word in both and
1272 ;; ediff-forward-word depends on the syntax classes of characters.
1273 (set-syntax-table inbuf-syntax-tbl
)
1275 (insert diff-string
)
1276 (goto-char (point-min))
1277 (skip-chars-forward ediff-whitespace
)
1278 (delete-region (point-min) (point))
1281 ;; eval in control buf to let user create local versions for
1282 ;; different invocations
1285 (ediff-with-current-buffer control-buf
1286 ediff-forward-word-function
))
1287 (funcall ediff-forward-word-function
))
1288 (setq sv-point
(point))
1289 (skip-chars-forward ediff-whitespace
)
1290 (delete-region sv-point
(point))
1293 ;; copy string from BEG END from IN-BUF to OUT-BUF
1294 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer
)
1297 (set-buffer in-buffer
)
1298 (setq string
(buffer-substring beg end
))
1300 (set-buffer out-buffer
)
1303 (goto-char (point-min)))))
1306 ;; goto word #n starting at current position in buffer `buf'
1307 ;; For ediff, a word is determined by ediff-forward-word-function
1308 ;; If `flag' is non-nil, goto the end of the n-th word.
1309 (defun ediff-goto-word (n buf
&optional flag
)
1310 ;; remember val ediff-forward-word-function has in ctl buf
1311 (let ((fwd-word-fun ediff-forward-word-function
)
1312 (syntax-tbl ediff-syntax-table
))
1313 (ediff-with-current-buffer buf
1314 (skip-chars-forward ediff-whitespace
)
1316 (ediff-with-syntax-table syntax-tbl
1317 (funcall fwd-word-fun
))
1318 (skip-chars-forward ediff-whitespace
)
1320 (if (and flag
(> n
0))
1321 (funcall fwd-word-fun
))
1324 (defun ediff-same-file-contents (f1 f2
)
1325 "T if F1 and F2 have identical contents."
1327 (apply 'call-process ediff-cmp-program nil nil nil
1328 (append ediff-cmp-options
(list f1 f2
)))))
1329 (and (numberp res
) (eq res
0))))
1332 ;;; Local Variables:
1333 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1334 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1335 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1339 ;; ediff-diff.el ends here