1 ;;; ediff-diff.el --- diff-related utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
29 (defvar ediff-default-variant
)
32 (let ((load-path (cons (expand-file-name ".") load-path
)))
33 (or (featurep 'ediff-init
)
34 (load "ediff-init.el" nil nil
'nosuffix
))
35 (or (featurep 'ediff-util
)
36 (load "ediff-util.el" nil nil
'nosuffix
))
42 (defgroup ediff-diff nil
43 "Diff related utilities"
48 (defcustom ediff-shell
49 (cond ((eq system-type
'emx
) "cmd") ; OS/2
50 ((memq system-type
'(ms-dos windows-nt windows-95
))
51 shell-file-name
) ; no standard name on MS-DOS
52 ((memq system-type
'(vax-vms axp-vms
)) "*dcl*") ; VMS
54 "*The shell used to run diff and patch. If user's .profile or
55 .cshrc files are set up correctly, any shell will do. However, some people
56 set $prompt or other things incorrectly, which leads to undesirable output
57 messages. These may cause Ediff to fail. In such a case, set ediff-shell
58 to a shell that you are not using or, better, fix your shell's startup file."
62 (defcustom ediff-cmp-program
"cmp"
63 "*Utility to use to determine if two files are identical.
64 It must return code 0, if its arguments are identical files."
68 (defcustom ediff-cmp-options nil
69 "*Options to pass to `ediff-cmp-program'. If GNUS diff is used as
70 `ediff-cmp-program', then the most useful options are `-I' RE, to
71 ignore changes whose lines all match RE."
72 :type
'(repeat string
)
75 (defcustom ediff-diff-program
"diff"
76 "*Program to use for generating the differential of the two files."
79 (defcustom ediff-diff-options
""
80 "*Options to pass to `ediff-diff-program'.
81 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
82 `-w', to ignore space, and `-i', to ignore case of letters.
83 At present, the option `-c' is not allowed."
87 (defcustom ediff-custom-diff-program ediff-diff-program
88 "*Program to use for generating custom diff output for saving it in a file.
89 This output is not used by Ediff internally."
92 (defcustom ediff-custom-diff-options
"-c"
93 "*Options to pass to `ediff-custom-diff-program'."
99 (defvar ediff-match-diff3-line
"^====\\(.?\\)$"
100 "Pattern to match lines produced by diff3 that describe differences.")
101 (defcustom ediff-diff3-program
"diff3"
102 "*Program to be used for three-way comparison.
103 Must produce output compatible with Unix's diff3 program."
106 (defcustom ediff-diff3-options
""
107 "*Options to pass to `ediff-diff3-program'."
110 (defcustom ediff-diff3-ok-lines-regexp
111 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
112 "*Regexp that matches normal output lines from `ediff-diff3-program'.
113 Lines that do not match are assumed to be error messages."
117 ;; keeps the status of the current diff in 3-way jobs.
118 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
119 (ediff-defvar-local ediff-diff-status
"" "")
124 (ediff-defvar-local ediff-auto-refine
(if (ediff-has-face-support-p) 'on
'nix
)
125 "If `on', Ediff auto-highlights fine diffs for the current diff region.
126 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
127 at all, unless the user force-refines the region by hitting `*'.
129 This variable can be set either in .emacs or toggled interactively.
130 Use `setq-default' if setting it in .emacs")
132 (ediff-defvar-local ediff-ignore-similar-regions nil
133 "*If t, skip over difference regions that differ only in the white space and line breaks.
134 This variable can be set either in .emacs or toggled interactively.
135 Use `setq-default' if setting it in .emacs")
137 (ediff-defvar-local ediff-auto-refine-limit
1400
138 "*Auto-refine only the regions of this size \(in bytes\) or less.")
142 (defvar ediff-diff-ok-lines-regexp
145 "[0-9,]+[acd][0-9,]+\C-m?$"
150 "\\|.*missing +newline"
153 "Regexp that matches normal output lines from `ediff-diff-program'.
154 This is mostly lifted from Emerge, except that Ediff also considers
155 warnings and `Missing newline'-type messages to be normal output.
156 Lines that do not match are assumed to be error messages.")
158 (defvar ediff-match-diff-line
159 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
160 (concat "^" x
"\\([acd]\\)" x
"\C-m?$"))
161 "Pattern to match lines produced by diff that describe differences.")
163 (ediff-defvar-local ediff-setup-diff-regions-function nil
164 "value is a function symbol depending on the kind of job is to be done.
165 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
166 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
168 The function should take three mandatory arguments, file-A, file-B, and
169 file-C. It may ignore file C for diff2 jobs. It should also take
170 one optional arguments, diff-number to refine.")
175 ;; Generate the difference vector and overlays for the two files
176 ;; With optional arg REG-TO-REFINE, refine this region.
177 ;; File-C argument is not used here. It is there just because
178 ;; ediff-setup-diff-regions is called via a funcall to
179 ;; ediff-setup-diff-regions-function, which can also have the value
180 ;; ediff-setup-diff-regions3, which takes 4 arguments.
181 (defun ediff-setup-diff-regions (file-A file-B file-C
)
182 (if (string-match "c" ediff-diff-options
)
183 (error "Option `-c' is not allowed in `ediff-diff-options'"))
185 ;; create, if it doesn't exist
186 (or (ediff-buffer-live-p ediff-diff-buffer
)
187 (setq ediff-diff-buffer
188 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
189 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B
)
190 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer
)
191 (ediff-convert-diffs-to-overlays
193 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds
)))
195 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
196 ;; Return the size of DIFF-BUFFER
197 (defun ediff-make-diff2-buffer (diff-buffer file1 file2
)
198 (let ((file1-size (ediff-file-size file1
))
199 (file2-size (ediff-file-size file2
)))
200 (cond ((not (numberp file1-size
))
201 (message "Can't find file: %s"
202 (ediff-abbreviate-file-name file1
))
204 ;; 1 is an error exit code
206 ((not (numberp file2-size
))
207 (message "Can't find file: %s"
208 (ediff-abbreviate-file-name file2
))
210 ;; 1 is an error exit code
213 (message "Can't diff remote files: %s"
214 (ediff-abbreviate-file-name file1
))
216 ;; 1 is an error exit code
219 (message "Can't diff remote file: %s"
220 (ediff-abbreviate-file-name file2
))
223 ;; 1 is an error exit code
225 (t (message "Computing differences between %s and %s ..."
226 (file-name-nondirectory file1
)
227 (file-name-nondirectory file2
))
228 ;; this erases the diff buffer automatically
229 (ediff-exec-process ediff-diff-program
232 ediff-diff-options file1 file2
)
234 (ediff-with-current-buffer diff-buffer
239 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
240 ;; This function works for diff3 and diff2 jobs
241 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num
)
242 (or (ediff-buffer-live-p ediff-fine-diff-buffer
)
243 (setq ediff-fine-diff-buffer
245 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
247 (let (diff3-job diff-program diff-options ok-regexp diff-list
)
248 (setq diff3-job ediff-3way-job
249 diff-program
(if diff3-job ediff-diff3-program ediff-diff-program
)
250 diff-options
(if diff3-job ediff-diff3-options ediff-diff-options
)
251 ok-regexp
(if diff3-job
252 ediff-diff3-ok-lines-regexp
253 ediff-diff-ok-lines-regexp
))
255 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num
))
256 (ediff-exec-process diff-program ediff-fine-diff-buffer
'synchronize
258 ;; The shuffle below is because we can compare 3-way
259 ;; or in several 2-way fashions, like fA fC, fA fB,
261 (if file-A file-A file-B
)
262 (if file-B file-B file-A
)
264 (if file-C file-C file-B
))
267 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer
)
268 (ediff-message-if-verbose
270 ;; "Refining difference region %d ... done" (1+ reg-num))
274 (ediff-extract-diffs3
275 ediff-fine-diff-buffer
'3way-comparison
'word-mode
)
276 (ediff-extract-diffs ediff-fine-diff-buffer
'word-mode
)))
280 (mapcar (lambda (elt)
285 (mapcar (lambda (elt)
290 (mapcar (lambda (elt)
296 (ediff-convert-fine-diffs-to-overlays diff-list reg-num
)
300 (defun ediff-prepare-error-list (ok-regexp diff-buff
)
301 (or (ediff-buffer-live-p ediff-error-buffer
)
302 (setq ediff-error-buffer
303 (get-buffer-create (ediff-unique-buffer-name
304 "*ediff-errors" "*"))))
305 (ediff-with-current-buffer ediff-error-buffer
307 (insert (ediff-with-current-buffer diff-buff
(buffer-string)))
308 (goto-char (point-min))
309 (delete-matching-lines ok-regexp
)
310 (if (memq system-type
'(vax-vms axp-vms
))
311 (delete-matching-lines "^$")))
312 ;; If diff reports errors, show them then quit.
313 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer
(buffer-size)))
314 (let ((ctl-buf ediff-control-buffer
)
315 (error-buf ediff-error-buffer
))
316 (ediff-skip-unsuitable-frames)
317 (switch-to-buffer error-buf
)
318 (ediff-kill-buffer-carefully ctl-buf
)
319 (error "Errors in diff output. Diff output is in %S" diff-buff
))))
321 ;; BOUNDS specifies visibility bounds to use.
322 ;; WORD-MODE tells whether we are in the word-mode or not.
323 ;; If WORD-MODE, also construct vector of diffs using word numbers.
324 ;; Else, use point values.
325 ;; This function handles diff-2 jobs including the case of
326 ;; merging buffers and files without ancestor.
327 (defun ediff-extract-diffs (diff-buffer word-mode
&optional bounds
)
328 (let ((A-buffer ediff-buffer-A
)
329 (B-buffer ediff-buffer-B
)
330 (C-buffer ediff-buffer-C
)
331 (a-prev 1) ; this is needed to set the first diff line correctly
334 diff-list shift-A shift-B
337 ;; diff list contains word numbers, unless changed later
338 (setq diff-list
(cons (if word-mode
'words
'points
)
340 ;; we don't use visibility bounds for buffer C when merging
344 (ediff-get-value-according-to-buffer-type 'A bounds
))
347 (ediff-get-value-according-to-buffer-type 'B bounds
))))
349 ;; reset point in buffers A/B/C
350 (ediff-with-current-buffer A-buffer
351 (goto-char (if shift-A shift-A
(point-min))))
352 (ediff-with-current-buffer B-buffer
353 (goto-char (if shift-B shift-B
(point-min))))
354 (if (ediff-buffer-live-p C-buffer
)
355 (ediff-with-current-buffer C-buffer
356 (goto-char (point-min))))
358 (ediff-with-current-buffer diff-buffer
359 (goto-char (point-min))
360 (while (re-search-forward ediff-match-diff-line nil t
)
361 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
363 (a-end (let ((b (match-beginning 3))
366 (string-to-int (buffer-substring b e
))
368 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
369 (b-begin (string-to-int (buffer-substring (match-beginning 5)
371 (b-end (let ((b (match-beginning 7))
374 (string-to-int (buffer-substring b e
))
376 a-begin-pt a-end-pt b-begin-pt b-end-pt
377 c-begin c-end c-begin-pt c-end-pt
)
378 ;; fix the beginning and end numbers, because diff is somewhat
379 ;; strange about how it numbers lines
380 (if (string-equal diff-type
"a")
381 (setq b-end
(1+ b-end
)
384 (if (string-equal diff-type
"d")
385 (setq a-end
(1+ a-end
)
388 ;; (string-equal diff-type "c")
389 (setq a-end
(1+ a-end
)
392 (if (eq ediff-default-variant
'default-B
)
393 (setq c-begin b-begin
395 (setq c-begin a-begin
398 ;; compute main diff vector
400 ;; make diff-list contain word numbers
404 (if (ediff-buffer-live-p C-buffer
)
405 (vector (- a-begin a-prev
) (- a-end a-begin
)
406 (- b-begin b-prev
) (- b-end b-begin
)
407 (- c-begin c-prev
) (- c-end c-begin
)
408 nil nil
; dummy ancestor
411 nil
; state of ancestor
413 (vector (- a-begin a-prev
) (- a-end a-begin
)
414 (- b-begin b-prev
) (- b-end b-begin
)
415 nil nil
; dummy buf C
416 nil nil
; dummy ancestor
419 nil
; state of ancestor
425 ;; else convert lines to points
426 (ediff-with-current-buffer A-buffer
427 (forward-line (- a-begin a-prev
))
428 (setq a-begin-pt
(point))
429 (forward-line (- a-end a-begin
))
430 (setq a-end-pt
(point)
432 (ediff-with-current-buffer B-buffer
433 (forward-line (- b-begin b-prev
))
434 (setq b-begin-pt
(point))
435 (forward-line (- b-end b-begin
))
436 (setq b-end-pt
(point)
438 (if (ediff-buffer-live-p C-buffer
)
439 (ediff-with-current-buffer C-buffer
440 (forward-line (- c-begin c-prev
))
441 (setq c-begin-pt
(point))
442 (forward-line (- c-end c-begin
))
443 (setq c-end-pt
(point)
449 (if (ediff-buffer-live-p C-buffer
)
451 a-begin-pt a-end-pt b-begin-pt b-end-pt
453 nil nil
; dummy ancestor
455 ;; shows which buff is different from the other two
456 (if (eq ediff-default-variant
'default-B
) 'A
'B
)
457 ediff-default-variant
; state of merge
458 nil
; state of ancestor
460 (vector a-begin-pt a-end-pt
462 nil nil
; dummy buf C
463 nil nil
; dummy ancestor
464 nil nil
; dummy state of diff & merge
465 nil
; dummy state of ancestor
469 ))) ; end ediff-with-current-buffer
474 (defun ediff-convert-diffs-to-overlays (diff-list)
475 (ediff-set-diff-overlays-in-one-buffer 'A diff-list
)
476 (ediff-set-diff-overlays-in-one-buffer 'B diff-list
)
478 (ediff-set-diff-overlays-in-one-buffer 'C diff-list
))
479 (if ediff-merge-with-ancestor-job
480 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list
))
481 ;; set up vector showing the status of merge regions
483 (setq ediff-state-of-merge
485 (mapcar (lambda (elt)
486 (let ((state-of-merge (aref elt
9))
487 (state-of-ancestor (aref elt
10)))
489 ;; state of merge: prefers/default-A/B or combined
490 (if state-of-merge
(format "%S" state-of-merge
))
491 ;; whether the ancestor region is empty
493 ;; the first elt designates type of list
496 (message "Processing difference regions ... done"))
499 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list
)
500 (let* ((current-diff -
1)
501 (buff (ediff-get-buffer buf-type
))
502 ;; ediff-extract-diffs puts the type of diff-list as the first elt
503 ;; of this list. The type is either 'points or 'words
504 (diff-list-type (car diff-list
))
505 (shift (ediff-overlay-start
506 (ediff-get-value-according-to-buffer-type
507 buf-type ediff-narrow-bounds
)))
508 (limit (ediff-overlay-end
509 (ediff-get-value-according-to-buffer-type
510 buf-type ediff-narrow-bounds
)))
511 diff-overlay-list list-element total-diffs
512 begin end pt-saved overlay state-of-diff
)
514 (setq diff-list
(cdr diff-list
)) ; discard diff list type
515 (setq total-diffs
(length diff-list
))
517 ;; shift, if necessary
518 (ediff-with-current-buffer buff
(setq pt-saved shift
))
521 (setq current-diff
(1+ current-diff
)
522 list-element
(car diff-list
)
523 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
527 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
531 state-of-diff
(aref list-element
8)
534 (cond ((and (not (eq buf-type state-of-diff
))
535 (not (eq buf-type
'Ancestor
))
536 (memq state-of-diff
'(A B C
)))
538 (car (delq buf-type
(delq state-of-diff
(list 'A
'B
'C
)))))
539 (setq state-of-diff
(format "=diff(%S)" state-of-diff
))
541 (t (setq state-of-diff nil
)))
543 ;; Put overlays at appropriate places in buffer
544 ;; convert word numbers to points, if necessary
545 (if (eq diff-list-type
'words
)
547 (ediff-with-current-buffer buff
(goto-char pt-saved
))
548 (setq begin
(ediff-goto-word (1+ begin
) buff
)
549 end
(ediff-goto-word end buff
'end
))
550 (if (> end limit
) (setq end limit
))
551 (if (> begin end
) (setq begin end
))
552 (setq pt-saved
(ediff-with-current-buffer buff
(point)))))
553 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
555 (ediff-overlay-put overlay
'priority ediff-shadow-overlay-priority
)
556 (ediff-overlay-put overlay
'ediff-diff-num current-diff
)
557 (if (and (ediff-has-face-support-p)
558 ediff-use-faces ediff-highlight-all-diffs
)
559 (ediff-set-overlay-face
560 overlay
(ediff-background-face buf-type current-diff
)))
562 (if (= 0 (mod current-diff
10))
563 (message "Buffer %S: Processing difference region %d of %d"
564 buf-type current-diff total-diffs
))
565 ;; Record all overlays for this difference.
566 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
567 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
568 ;; The 4-th elt says which diff region is different from the other two
569 ;; (3-way jobs only).
570 (setq diff-overlay-list
573 (list (vector overlay nil nil state-of-diff
)))
578 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist
)
579 (vconcat diff-overlay-list
))
582 ;; `n' is the diff region to work on. Default is ediff-current-difference.
583 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
584 ;; diffs have not been computed before.
585 ;; if `flag' is 'skip then don't compute fine diffs for this region.
586 (defun ediff-make-fine-diffs (&optional n flag
)
587 (or n
(setq n ediff-current-difference
))
589 (if (< ediff-number-of-differences
1)
590 (error ediff-NO-DIFFERENCES
))
594 ediff-auto-refine
'nix
))
597 (>= n ediff-number-of-differences
)
598 ;; n is within the range
599 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
600 (file-A ediff-temp-file-A
)
601 (file-B ediff-temp-file-B
)
602 (file-C ediff-temp-file-C
)
603 (empty-A (ediff-empty-diff-region-p n
'A
))
604 (empty-B (ediff-empty-diff-region-p n
'B
))
605 (empty-C (ediff-empty-diff-region-p n
'C
))
606 (whitespace-A (ediff-whitespace-diff-region-p n
'A
))
607 (whitespace-B (ediff-whitespace-diff-region-p n
'B
))
608 (whitespace-C (ediff-whitespace-diff-region-p n
'C
))
609 cumulative-fine-diff-length
)
611 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
612 ;; then don't refine.
613 ;; If the region happens to be entirely whitespace or empty then
615 ((> (length (delq nil
(list empty-A empty-B empty-C
))) 1)
616 (if (and (ediff-looks-like-combined-merge n
)
618 (ediff-set-fine-overlays-in-one-buffer 'C nil n
))
619 (if ediff-3way-comparison-job
620 (ediff-message-if-verbose
621 "Region %d is empty in all buffers but %S"
623 (cond ((not empty-A
) 'A
)
626 (ediff-message-if-verbose
627 "Region %d in buffer %S is empty"
633 ;; if all regions happen to be whitespace
634 (if (and whitespace-A whitespace-B whitespace-C
)
635 ;; mark as space only
636 (ediff-mark-diff-as-space-only n t
)
637 ;; if some regions are white and others don't, then mark as
638 ;; non-white-space-only
639 (ediff-mark-diff-as-space-only n nil
)))
641 ;; don't compute fine diffs if diff vector exists
642 ((and (eq flag
'noforce
) (ediff-get-fine-diff-vector n
'A
))
643 (if (ediff-no-fine-diffs-p n
)
645 "Only white-space differences in region %d %s"
647 (cond ((eq (ediff-no-fine-diffs-p n
) 'A
)
649 ((eq (ediff-no-fine-diffs-p n
) 'B
)
651 ((eq (ediff-no-fine-diffs-p n
) 'C
)
654 ;; don't compute fine diffs for this region
656 (or (ediff-get-fine-diff-vector n
'A
)
657 (memq ediff-auto-refine
'(off nix
))
658 (ediff-message-if-verbose
659 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
661 (substitute-command-keys
662 "\\[ediff-make-or-kill-fine-diffs]")
665 ;; recompute fine diffs
667 (ediff-get-diff-posn 'A
'beg n
)
668 (ediff-get-diff-posn 'A
'end n
)
671 ediff-control-buffer
)
673 (ediff-make-temp-file tmp-buffer
"fineDiffA" file-A
))
676 (ediff-get-diff-posn 'B
'beg n
)
677 (ediff-get-diff-posn 'B
'end n
)
680 ediff-control-buffer
)
682 (ediff-make-temp-file tmp-buffer
"fineDiffB" file-B
))
687 (ediff-get-diff-posn 'C
'beg n
)
688 (ediff-get-diff-posn 'C
'end n
)
691 ediff-control-buffer
)
693 (ediff-make-temp-file
694 tmp-buffer
"fineDiffC" file-C
))))
696 ;; save temp file names.
697 (setq ediff-temp-file-A file-A
698 ediff-temp-file-B file-B
699 ediff-temp-file-C file-C
)
701 ;; set the new vector of fine diffs, if none exists
702 (cond ((and ediff-3way-job whitespace-A
)
703 (ediff-setup-fine-diff-regions nil file-B file-C n
))
704 ((and ediff-3way-job whitespace-B
)
705 (ediff-setup-fine-diff-regions file-A nil file-C n
))
707 ;; In merge-jobs, whitespace-C is t, since
708 ;; ediff-empty-diff-region-p returns t in this case
710 (ediff-setup-fine-diff-regions file-A file-B nil n
))
712 (ediff-setup-fine-diff-regions file-A file-B file-C n
)))
714 (setq cumulative-fine-diff-length
715 (+ (length (ediff-get-fine-diff-vector n
'A
))
716 (length (ediff-get-fine-diff-vector n
'B
))
717 ;; in merge jobs, the merge buffer is never refined
718 (if (and file-C
(not ediff-merge-job
))
719 (length (ediff-get-fine-diff-vector n
'C
))
723 ;; all regions are white space
724 (and whitespace-A whitespace-B whitespace-C
)
725 ;; none is white space and no fine diffs detected
726 (and (not whitespace-A
)
728 (not (and ediff-3way-job whitespace-C
))
729 (eq cumulative-fine-diff-length
0)))
730 (ediff-mark-diff-as-space-only n t
)
731 (ediff-message-if-verbose
732 "Only white-space differences in region %d" (1+ n
)))
733 ((eq cumulative-fine-diff-length
0)
734 (ediff-message-if-verbose
735 "Only white-space differences in region %d %s"
737 (cond (whitespace-A (ediff-mark-diff-as-space-only n
'A
)
739 (whitespace-B (ediff-mark-diff-as-space-only n
'B
)
741 (whitespace-C (ediff-mark-diff-as-space-only n
'C
)
742 "in buffers A & B"))))
744 (ediff-mark-diff-as-space-only n nil
)))
747 (ediff-set-fine-diff-properties n
)
750 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
751 (defun ediff-install-fine-diff-if-necessary (n)
752 (cond ((eq ediff-auto-refine
'on
)
754 (> ediff-auto-refine-limit
755 (- (ediff-get-diff-posn 'A
'end n
)
756 (ediff-get-diff-posn 'A
'beg n
)))
757 (> ediff-auto-refine-limit
758 (- (ediff-get-diff-posn 'B
'end n
)
759 (ediff-get-diff-posn 'B
'beg n
))))
760 (ediff-make-fine-diffs n
'noforce
)
761 (ediff-make-fine-diffs n
'skip
)))
763 ;; highlight iff fine diffs already exist
764 ((eq ediff-auto-refine
'off
)
765 (ediff-make-fine-diffs n
'skip
))))
768 ;; if fine diff vector is not set for diff N, then do nothing
769 (defun ediff-set-fine-diff-properties (n &optional default
)
770 (or (not (ediff-has-face-support-p))
772 (>= n ediff-number-of-differences
)
773 ;; when faces are supported, set faces and priorities of fine overlays
775 (ediff-set-fine-diff-properties-in-one-buffer 'A n default
)
776 (ediff-set-fine-diff-properties-in-one-buffer 'B n default
)
778 (ediff-set-fine-diff-properties-in-one-buffer 'C n default
)))))
780 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
782 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type
))
786 (ediff-get-symbol-from-alist
787 buf-type ediff-fine-diff-face-alist
))))
788 (priority (if default
790 (1+ (or (ediff-overlay-get
792 (ediff-get-symbol-from-alist
794 ediff-current-diff-overlay-alist
))
797 (mapcar (lambda (overl)
798 (ediff-set-overlay-face overl face
)
799 (ediff-overlay-put overl
'priority priority
))
802 ;; This assumes buffer C and that the region looks like a combination of
803 ;; regions in buffer A and C.
804 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num
)
805 (let (overlay1 overlay2 overlay3
)
806 (setq overlay1
(ediff-make-bullet-proof-overlay (nth 0 diff-list
)
809 overlay2
(ediff-make-bullet-proof-overlay (nth 2 diff-list
)
812 overlay3
(ediff-make-bullet-proof-overlay (nth 4 diff-list
)
815 (ediff-set-fine-diff-vector reg-num
'C
(vector overlay1 overlay2 overlay3
))
819 ;; Convert diff list to overlays for a given DIFF-REGION
820 ;; in buffer of type BUF-TYPE
821 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num
)
822 (let* ((current-diff -
1)
823 (reg-start (ediff-get-diff-posn buf-type
'beg region-num
))
824 (buff (ediff-get-buffer buf-type
))
825 combined-merge-diff-list
826 diff-overlay-list list-element
829 (ediff-clear-fine-differences-in-one-buffer region-num buf-type
)
830 (setq diff-list
(cdr diff-list
)) ; discard list type (words or points)
831 (ediff-with-current-buffer buff
(goto-char reg-start
))
833 ;; if it is a combined merge then set overlays in buff C specially
834 (if (and ediff-merge-job
(eq buf-type
'C
)
835 (setq combined-merge-diff-list
836 (ediff-looks-like-combined-merge region-num
)))
837 (ediff-set-fine-overlays-for-combined-merge
838 combined-merge-diff-list region-num
)
841 (setq current-diff
(1+ current-diff
)
842 list-element
(car diff-list
)
843 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
846 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
849 (if (not (or begin end
))
851 ;; Put overlays at appropriate places in buffers
852 ;; convert lines to points, if necessary
853 (setq begin
(ediff-goto-word (1+ begin
) buff
)
854 end
(ediff-goto-word end buff
'end
))
855 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
856 ;; record all overlays for this difference region
857 (setq diff-overlay-list
(nconc diff-overlay-list
(list overlay
))))
859 (setq diff-list
(cdr diff-list
))
861 ;; convert the list of difference information into a vector
863 (ediff-set-fine-diff-vector
864 region-num buf-type
(vconcat diff-overlay-list
))
868 ;; Stolen from emerge.el
869 (defun ediff-get-diff3-group (file)
870 ;; This save-excursion allows ediff-get-diff3-group to be called for the
871 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
872 ;; appear in any order. The reason this is necessary is that Gnu diff3
873 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
876 (concat "^" file
":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
877 (beginning-of-line 2)
878 ;; treatment depends on whether it is an "a" group or a "c" group
879 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
881 (if (match-beginning 2)
882 ;; it has two numbers
884 (buffer-substring (match-beginning 1) (match-end 1)))
886 (buffer-substring (match-beginning 3) (match-end 3)))))
888 (let ((x (string-to-int
889 (buffer-substring (match-beginning 1) (match-end 1)))))
891 ;; it is an "a" group
892 (let ((x (1+ (string-to-int
893 (buffer-substring (match-beginning 1) (match-end 1))))))
897 ;; If WORD-MODE, construct vector of diffs using word numbers.
898 ;; Else, use point values.
899 ;; WORD-MODE also tells if we are in the word-mode or not.
900 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
901 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
902 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
904 ;; BOUNDS specifies visibility bounds to use.
905 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
907 (let ((A-buffer ediff-buffer-A
)
908 (B-buffer ediff-buffer-B
)
909 (C-buffer ediff-buffer-C
)
910 (anc-buffer ediff-ancestor-buffer
)
911 (a-prev 1) ; needed to set the first diff line correctly
915 diff-list shift-A shift-B shift-C
918 ;; diff list contains word numbers or points, depending on word-mode
919 (setq diff-list
(cons (if word-mode
'words
'points
)
924 (ediff-get-value-according-to-buffer-type 'A bounds
))
927 (ediff-get-value-according-to-buffer-type 'B bounds
))
931 (ediff-get-value-according-to-buffer-type 'C bounds
)))))
933 ;; reset point in buffers A, B, C
934 (ediff-with-current-buffer A-buffer
935 (goto-char (if shift-A shift-A
(point-min))))
936 (ediff-with-current-buffer B-buffer
937 (goto-char (if shift-B shift-B
(point-min))))
939 (ediff-with-current-buffer C-buffer
940 (goto-char (if shift-C shift-C
(point-min)))))
941 (if (ediff-buffer-live-p anc-buffer
)
942 (ediff-with-current-buffer anc-buffer
943 (goto-char (point-min))))
945 (ediff-with-current-buffer diff-buffer
946 (goto-char (point-min))
947 (while (re-search-forward ediff-match-diff3-line nil t
)
948 ;; leave point after matched line
949 (beginning-of-line 2)
950 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
951 ;; if the files A and B are the same and not 3way-comparison,
952 ;; ignore the difference
953 (if (or three-way-comp
(not (string-equal agreement
"3")))
954 (let* ((a-begin (car (ediff-get-diff3-group "1")))
955 (a-end (nth 1 (ediff-get-diff3-group "1")))
956 (b-begin (car (ediff-get-diff3-group "2")))
957 (b-end (nth 1 (ediff-get-diff3-group "2")))
958 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
959 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
961 (cond ((string-equal agreement
"1") 'prefer-A
)
962 ((string-equal agreement
"2") 'prefer-B
)
963 (t ediff-default-variant
)))
965 (if (memq state-of-merge
'(default-A prefer-A
)) 'B
'A
))
966 (state-of-diff-comparison
967 (cond ((string-equal agreement
"1") 'A
)
968 ((string-equal agreement
"2") 'B
)
969 ((string-equal agreement
"3") 'C
)))
975 anc-begin-pt anc-end-pt
)
977 (setq state-of-ancestor
978 (= c-or-anc-begin c-or-anc-end
))
980 (cond (three-way-comp
981 (setq c-begin c-or-anc-begin
983 ((eq ediff-default-variant
'default-B
)
984 (setq c-begin b-begin
987 (setq c-begin a-begin
990 ;; compute main diff vector
992 ;; make diff-list contain word numbers
996 (- a-begin a-prev
) (- a-end a-begin
)
997 (- b-begin b-prev
) (- b-end b-begin
)
998 (- c-begin c-prev
) (- c-end c-begin
)
999 nil nil
; dummy ancestor
1001 nil
; state of merge
1002 nil
; state of ancestor
1007 ;; else convert lines to points
1008 (ediff-with-current-buffer A-buffer
1009 (forward-line (- a-begin a-prev
))
1010 (setq a-begin-pt
(point))
1011 (forward-line (- a-end a-begin
))
1012 (setq a-end-pt
(point)
1014 (ediff-with-current-buffer B-buffer
1015 (forward-line (- b-begin b-prev
))
1016 (setq b-begin-pt
(point))
1017 (forward-line (- b-end b-begin
))
1018 (setq b-end-pt
(point)
1020 (ediff-with-current-buffer C-buffer
1021 (forward-line (- c-begin c-prev
))
1022 (setq c-begin-pt
(point))
1023 (forward-line (- c-end c-begin
))
1024 (setq c-end-pt
(point)
1026 (if (ediff-buffer-live-p anc-buffer
)
1027 (ediff-with-current-buffer anc-buffer
1028 (forward-line (- c-or-anc-begin anc-prev
))
1029 (setq anc-begin-pt
(point))
1030 (forward-line (- c-or-anc-end c-or-anc-begin
))
1031 (setq anc-end-pt
(point)
1032 anc-prev c-or-anc-end
)))
1036 ;; if comparing with ancestor, then there also is a
1037 ;; state-of-difference marker
1043 nil nil
; ancestor begin/end
1044 state-of-diff-comparison
1045 nil
; state of merge
1046 nil
; state of ancestor
1048 (list (vector a-begin-pt a-end-pt
1051 anc-begin-pt anc-end-pt
1059 ))) ; end ediff-with-current-buffer
1063 ;; Generate the difference vector and overlays for three files
1064 ;; File-C is either the third file to compare (in case of 3-way comparison)
1065 ;; or it is the ancestor file.
1066 (defun ediff-setup-diff-regions3 (file-A file-B file-C
)
1067 (or (ediff-buffer-live-p ediff-diff-buffer
)
1068 (setq ediff-diff-buffer
1069 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1071 (message "Computing differences ...")
1072 (ediff-exec-process ediff-diff3-program ediff-diff-buffer
'synchronize
1073 ediff-diff3-options file-A file-B file-C
)
1075 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer
)
1076 ;;(message "Computing differences ... done")
1077 (ediff-convert-diffs-to-overlays
1078 (ediff-extract-diffs3
1080 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds
)
1084 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1085 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1086 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1087 ;; string. All elements in FILES must be strings. We also delete nil from
1089 (defun ediff-exec-process (program buffer synch options
&rest files
)
1090 (let ((data (match-data))
1091 (coding-system-for-read 'no-conversion
)
1093 (setq args
(append (split-string options
) files
))
1094 (setq args
(delete "" (delq nil args
))) ; delete nil and "" from arguments
1096 (let ((directory default-directory
)
1101 (setq default-directory directory
)
1102 (if (or (memq system-type
'(emx ms-dos windows-nt windows-95
))
1104 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1105 ;; delete files used by other processes. Thus, in ediff-buffers
1106 ;; and similar functions, we can't delete temp files because
1107 ;; they might be used by the asynch process that computes
1108 ;; custom diffs. So, we have to wait till custom diff
1109 ;; subprocess is done.
1110 ;; Similarly for Windows-*
1111 ;; In DOS, must synchronize because DOS doesn't have
1112 ;; asynchronous processes.
1113 (apply 'call-process program nil buffer nil args
)
1114 ;; On other systems, do it asynchronously.
1115 (setq proc
(get-buffer-process buffer
))
1116 (if proc
(kill-process proc
))
1118 (apply 'start-process
"Custom Diff" buffer program args
))
1119 (setq mode-line-process
'(":%s"))
1120 (set-process-sentinel proc
'ediff-process-sentinel
)
1121 (set-process-filter proc
'ediff-process-filter
)
1123 (store-match-data data
))))
1125 ;; This is shell-command-filter from simple.el in Emacs.
1126 ;; Copied here because XEmacs doesn't have it.
1127 (defun ediff-process-filter (proc string
)
1128 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1129 ;; despite an insertion immediately after it.
1130 (let* ((obuf (current-buffer))
1131 (buffer (process-buffer proc
))
1133 (window (get-buffer-window buffer
))
1134 (pos (window-start window
)))
1138 (or (= (point) (point-max))
1139 (setq opoint
(point)))
1140 (goto-char (point-max))
1141 (insert-before-markers string
))
1142 ;; insert-before-markers moved this marker: set it back.
1143 (set-window-start window pos
)
1144 ;; Finish our save-excursion.
1147 (set-buffer obuf
))))
1149 ;; like shell-command-sentinel but doesn't print an exit status message
1150 ;; we do this because diff always exits with status 1, if diffs are found
1151 ;; so shell-command-sentinel displays a confusing message to the user
1152 (defun ediff-process-sentinel (process signal
)
1153 (if (and (memq (process-status process
) '(exit signal
))
1154 (buffer-name (process-buffer process
)))
1157 (set-buffer (process-buffer process
))
1158 (setq mode-line-process nil
))
1159 (delete-process process
))))
1162 ;;; Word functions used to refine the current diff
1164 (defvar ediff-forward-word-function
'ediff-forward-word
1165 "*Function to call to move to the next word.
1166 Used for splitting difference regions into individual words.")
1168 (defvar ediff-whitespace
" \n\t\f"
1169 "*Characters constituting white space.
1170 These characters are ignored when differing regions are split into words.")
1172 ;;(defvar ediff-word-1 "a-zA-Z---_`'.?!:"
1173 (defvar ediff-word-1
"a-zA-Z---_"
1174 "*Characters that constitute words of type 1.
1175 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1176 See `ediff-forward-word' for more details.")
1178 (defvar ediff-word-2
"0-9.,"
1179 "*Characters that constitute words of type 2.
1180 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1181 See `ediff-forward-word' for more details.")
1183 (defvar ediff-word-3
"`'?!:;\"{}[]()"
1184 "*Characters that constitute words of type 3.
1185 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1186 See `ediff-forward-word' for more details.")
1188 (defvar ediff-word-4
1189 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace
)
1190 "*Characters that constitute words of type 4.
1191 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1192 See `ediff-forward-word' for more details.")
1194 ;; Split region along word boundaries. Each word will be on its own line.
1195 ;; Output to buffer out-buffer.
1196 (defun ediff-forward-word ()
1197 "Move point one word forward.
1198 There are four types of words, each of which consists entirely of
1199 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1200 `ediff-word-4'. Words are recognized by passing these in turn as the
1201 argument to `skip-chars-forward'."
1202 (or (> (skip-chars-forward ediff-word-1
) 0)
1203 (> (skip-chars-forward ediff-word-2
) 0)
1204 (> (skip-chars-forward ediff-word-3
) 0)
1205 (> (skip-chars-forward ediff-word-4
) 0)
1208 (defun ediff-wordify (beg end in-buffer out-buffer
&optional control-buf
)
1209 (let (sv-point string
)
1211 (set-buffer in-buffer
)
1212 (setq string
(buffer-substring-no-properties beg end
))
1214 (set-buffer out-buffer
)
1217 (goto-char (point-min))
1218 (skip-chars-forward ediff-whitespace
)
1219 (delete-region (point-min) (point))
1222 ;; eval incontrol buf to let user create local versions for
1223 ;; different invocations
1226 (ediff-with-current-buffer control-buf ediff-forward-word-function
))
1227 (funcall ediff-forward-word-function
))
1228 (setq sv-point
(point))
1229 (skip-chars-forward ediff-whitespace
)
1230 (delete-region sv-point
(point))
1233 ;; copy string from BEG END from IN-BUF to OUT-BUF
1234 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer
)
1237 (set-buffer in-buffer
)
1238 (setq string
(buffer-substring beg end
))
1240 (set-buffer out-buffer
)
1243 (goto-char (point-min)))))
1246 ;; goto word #n starting at current position in buffer `buf'
1247 ;; For ediff, a word is either a string of a-z,A-Z, incl `-' and `_';
1248 ;; or a string of other non-blanks. A blank is a \n\t\f
1249 ;; If `flag' is non-nil, goto the end of the n-th word.
1250 (defun ediff-goto-word (n buf
&optional flag
)
1251 ;; remember val ediff-forward-word-function has in ctl buf
1252 (let ((fwd-word-fun ediff-forward-word-function
))
1253 (ediff-with-current-buffer buf
1254 (skip-chars-forward ediff-whitespace
)
1256 (funcall fwd-word-fun
)
1257 (skip-chars-forward ediff-whitespace
)
1259 (if (and flag
(> n
0))
1260 (funcall fwd-word-fun
))
1263 (defun ediff-same-file-contents (f1 f2
)
1264 "T if F1 and F2 have identical contents."
1266 (apply 'call-process ediff-cmp-program nil nil nil
1267 (append ediff-cmp-options
(list f1 f2
)))))
1268 (and (numberp res
) (eq res
0))))
1271 ;;; Local Variables:
1272 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1273 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1274 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1278 ;; ediff-diff.el ends here