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 ;; The following functions must precede all defcustom-defined variables.
60 ;; The following functions needed for setting diff/diff3 options
61 ;; test if diff supports the --binary option
62 (defsubst ediff-test-utility
(diff-util option
&optional files
)
63 (zerop (apply 'call-process
64 (append (list diff-util nil nil nil option
) files
))))
66 (defun ediff-diff-mandatory-option (diff-util)
67 (let ((file (if (boundp 'null-device
) null-device
"/dev/null")))
68 (cond ((not (memq system-type
'(ms-dos windows-nt windows-95
)))
70 ((and (string= diff-util ediff-diff-program
)
72 ediff-diff-program
"--binary" (list file file
)))
74 ((and (string= diff-util ediff-diff3-program
)
76 ediff-diff3-program
"--binary" (list file file file
)))
80 ;; make sure that mandatory options are added even if the user changes
81 ;; ediff-diff-options or ediff-diff3-options in the customization widget
82 (defun ediff-reset-diff-options (symb val
)
84 (if (eq symb
'ediff-diff-options
)
87 (mandatory-option (ediff-diff-mandatory-option diff-program
))
88 (spacer (if (string-equal mandatory-option
"") "" " ")))
90 (if (string-match mandatory-option val
)
92 (concat mandatory-option spacer val
)))
96 (defcustom ediff-shell
97 (cond ((eq system-type
'emx
) "cmd") ; OS/2
98 ((memq system-type
'(ms-dos windows-nt windows-95
))
99 shell-file-name
) ; no standard name on MS-DOS
100 ((memq system-type
'(vax-vms axp-vms
)) "*dcl*") ; VMS
102 "*The shell used to run diff and patch. If user's .profile or
103 .cshrc files are set up correctly, any shell will do. However, some people
104 set $prompt or other things incorrectly, which leads to undesirable output
105 messages. These may cause Ediff to fail. In such a case, set ediff-shell
106 to a shell that you are not using or, better, fix your shell's startup file."
110 (defcustom ediff-cmp-program
"cmp"
111 "*Utility to use to determine if two files are identical.
112 It must return code 0, if its arguments are identical files."
116 (defcustom ediff-cmp-options nil
117 "*Options to pass to `ediff-cmp-program'. If GNUS diff is used as
118 `ediff-cmp-program', then the most useful options are `-I' RE, to
119 ignore changes whose lines all match RE."
120 :type
'(repeat string
)
123 (defcustom ediff-diff-options
""
124 "*Options to pass to `ediff-diff-program'.
125 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
126 `-w', to ignore space, and `-i', to ignore case of letters.
127 At present, the option `-c' is not allowed."
128 :set
'ediff-reset-diff-options
132 (defcustom ediff-custom-diff-program ediff-diff-program
133 "*Program to use for generating custom diff output for saving it in a file.
134 This output is not used by Ediff internally."
137 (defcustom ediff-custom-diff-options
"-c"
138 "*Options to pass to `ediff-custom-diff-program'."
142 ;;; Support for diff3
144 (defvar ediff-match-diff3-line
"^====\\(.?\\)$"
145 "Pattern to match lines produced by diff3 that describe differences.")
146 (defcustom ediff-diff3-options
""
147 "*Options to pass to `ediff-diff3-program'."
148 :set
'ediff-reset-diff-options
151 (defcustom ediff-diff3-ok-lines-regexp
152 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
153 "*Regexp that matches normal output lines from `ediff-diff3-program'.
154 Lines that do not match are assumed to be error messages."
158 ;; keeps the status of the current diff in 3-way jobs.
159 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
160 (ediff-defvar-local ediff-diff-status
"" "")
165 (ediff-defvar-local ediff-auto-refine
(if (ediff-has-face-support-p) 'on
'nix
)
166 "If `on', Ediff auto-highlights fine diffs for the current diff region.
167 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
168 at all, unless the user force-refines the region by hitting `*'.
170 This variable can be set either in .emacs or toggled interactively.
171 Use `setq-default' if setting it in .emacs")
173 (ediff-defvar-local ediff-ignore-similar-regions nil
174 "*If t, skip over difference regions that differ only in the white space and line breaks.
175 This variable can be set either in .emacs or toggled interactively.
176 Use `setq-default' if setting it in .emacs")
178 (ediff-defvar-local ediff-auto-refine-limit
1400
179 "*Auto-refine only the regions of this size \(in bytes\) or less.")
183 (defvar ediff-diff-ok-lines-regexp
186 "[0-9,]+[acd][0-9,]+\C-m?$"
191 "\\|.*missing +newline"
194 "Regexp that matches normal output lines from `ediff-diff-program'.
195 This is mostly lifted from Emerge, except that Ediff also considers
196 warnings and `Missing newline'-type messages to be normal output.
197 Lines that do not match are assumed to be error messages.")
199 (defvar ediff-match-diff-line
200 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
201 (concat "^" x
"\\([acd]\\)" x
"\C-m?$"))
202 "Pattern to match lines produced by diff that describe differences.")
204 (ediff-defvar-local ediff-setup-diff-regions-function nil
205 "value is a function symbol depending on the kind of job is to be done.
206 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
207 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
209 The function should take three mandatory arguments, file-A, file-B, and
210 file-C. It may ignore file C for diff2 jobs. It should also take
211 one optional arguments, diff-number to refine.")
216 ;; Generate the difference vector and overlays for the two files
217 ;; With optional arg REG-TO-REFINE, refine this region.
218 ;; File-C argument is not used here. It is there just because
219 ;; ediff-setup-diff-regions is called via a funcall to
220 ;; ediff-setup-diff-regions-function, which can also have the value
221 ;; ediff-setup-diff-regions3, which takes 4 arguments.
222 (defun ediff-setup-diff-regions (file-A file-B file-C
)
223 (if (string-match "c" ediff-diff-options
)
224 (error "Option `-c' is not allowed in `ediff-diff-options'"))
226 ;; create, if it doesn't exist
227 (or (ediff-buffer-live-p ediff-diff-buffer
)
228 (setq ediff-diff-buffer
229 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
230 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B
)
231 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer
)
232 (ediff-convert-diffs-to-overlays
234 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds
)))
236 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
237 ;; Return the size of DIFF-BUFFER
238 (defun ediff-make-diff2-buffer (diff-buffer file1 file2
)
239 (let ((file1-size (ediff-file-size file1
))
240 (file2-size (ediff-file-size file2
)))
241 (cond ((not (numberp file1-size
))
242 (message "Can't find file: %s"
243 (ediff-abbreviate-file-name file1
))
245 ;; 1 is an error exit code
247 ((not (numberp file2-size
))
248 (message "Can't find file: %s"
249 (ediff-abbreviate-file-name file2
))
251 ;; 1 is an error exit code
254 (message "Can't diff remote files: %s"
255 (ediff-abbreviate-file-name file1
))
257 ;; 1 is an error exit code
260 (message "Can't diff remote file: %s"
261 (ediff-abbreviate-file-name file2
))
264 ;; 1 is an error exit code
266 (t (message "Computing differences between %s and %s ..."
267 (file-name-nondirectory file1
)
268 (file-name-nondirectory file2
))
269 ;; this erases the diff buffer automatically
270 (ediff-exec-process ediff-diff-program
273 ediff-diff-options file1 file2
)
275 (ediff-with-current-buffer diff-buffer
280 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
281 ;; This function works for diff3 and diff2 jobs
282 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num
)
283 (or (ediff-buffer-live-p ediff-fine-diff-buffer
)
284 (setq ediff-fine-diff-buffer
286 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
288 (let (diff3-job diff-program diff-options ok-regexp diff-list
)
289 (setq diff3-job ediff-3way-job
290 diff-program
(if diff3-job ediff-diff3-program ediff-diff-program
)
291 diff-options
(if diff3-job ediff-diff3-options ediff-diff-options
)
292 ok-regexp
(if diff3-job
293 ediff-diff3-ok-lines-regexp
294 ediff-diff-ok-lines-regexp
))
296 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num
))
297 (ediff-exec-process diff-program ediff-fine-diff-buffer
'synchronize
299 ;; The shuffle below is because we can compare 3-way
300 ;; or in several 2-way fashions, like fA fC, fA fB,
302 (if file-A file-A file-B
)
303 (if file-B file-B file-A
)
305 (if file-C file-C file-B
))
308 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer
)
309 (ediff-message-if-verbose
311 ;; "Refining difference region %d ... done" (1+ reg-num))
315 (ediff-extract-diffs3
316 ediff-fine-diff-buffer
'3way-comparison
'word-mode
)
317 (ediff-extract-diffs ediff-fine-diff-buffer
'word-mode
)))
321 (mapcar (lambda (elt)
326 (mapcar (lambda (elt)
331 (mapcar (lambda (elt)
337 (ediff-convert-fine-diffs-to-overlays diff-list reg-num
)
341 (defun ediff-prepare-error-list (ok-regexp diff-buff
)
342 (or (ediff-buffer-live-p ediff-error-buffer
)
343 (setq ediff-error-buffer
344 (get-buffer-create (ediff-unique-buffer-name
345 "*ediff-errors" "*"))))
346 (ediff-with-current-buffer ediff-error-buffer
348 (insert (ediff-with-current-buffer diff-buff
(buffer-string)))
349 (goto-char (point-min))
350 (delete-matching-lines ok-regexp
)
351 (if (memq system-type
'(vax-vms axp-vms
))
352 (delete-matching-lines "^$")))
353 ;; If diff reports errors, show them then quit.
354 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer
(buffer-size)))
355 (let ((ctl-buf ediff-control-buffer
)
356 (error-buf ediff-error-buffer
))
357 (ediff-skip-unsuitable-frames)
358 (switch-to-buffer error-buf
)
359 (ediff-kill-buffer-carefully ctl-buf
)
360 (error "Errors in diff output. Diff output is in %S" diff-buff
))))
362 ;; BOUNDS specifies visibility bounds to use.
363 ;; WORD-MODE tells whether we are in the word-mode or not.
364 ;; If WORD-MODE, also construct vector of diffs using word numbers.
365 ;; Else, use point values.
366 ;; This function handles diff-2 jobs including the case of
367 ;; merging buffers and files without ancestor.
368 (defun ediff-extract-diffs (diff-buffer word-mode
&optional bounds
)
369 (let ((A-buffer ediff-buffer-A
)
370 (B-buffer ediff-buffer-B
)
371 (C-buffer ediff-buffer-C
)
372 (a-prev 1) ; this is needed to set the first diff line correctly
375 diff-list shift-A shift-B
378 ;; diff list contains word numbers, unless changed later
379 (setq diff-list
(cons (if word-mode
'words
'points
)
381 ;; we don't use visibility bounds for buffer C when merging
385 (ediff-get-value-according-to-buffer-type 'A bounds
))
388 (ediff-get-value-according-to-buffer-type 'B bounds
))))
390 ;; reset point in buffers A/B/C
391 (ediff-with-current-buffer A-buffer
392 (goto-char (if shift-A shift-A
(point-min))))
393 (ediff-with-current-buffer B-buffer
394 (goto-char (if shift-B shift-B
(point-min))))
395 (if (ediff-buffer-live-p C-buffer
)
396 (ediff-with-current-buffer C-buffer
397 (goto-char (point-min))))
399 (ediff-with-current-buffer diff-buffer
400 (goto-char (point-min))
401 (while (re-search-forward ediff-match-diff-line nil t
)
402 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
404 (a-end (let ((b (match-beginning 3))
407 (string-to-int (buffer-substring b e
))
409 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
410 (b-begin (string-to-int (buffer-substring (match-beginning 5)
412 (b-end (let ((b (match-beginning 7))
415 (string-to-int (buffer-substring b e
))
417 a-begin-pt a-end-pt b-begin-pt b-end-pt
418 c-begin c-end c-begin-pt c-end-pt
)
419 ;; fix the beginning and end numbers, because diff is somewhat
420 ;; strange about how it numbers lines
421 (if (string-equal diff-type
"a")
422 (setq b-end
(1+ b-end
)
425 (if (string-equal diff-type
"d")
426 (setq a-end
(1+ a-end
)
429 ;; (string-equal diff-type "c")
430 (setq a-end
(1+ a-end
)
433 (if (eq ediff-default-variant
'default-B
)
434 (setq c-begin b-begin
436 (setq c-begin a-begin
439 ;; compute main diff vector
441 ;; make diff-list contain word numbers
445 (if (ediff-buffer-live-p C-buffer
)
446 (vector (- a-begin a-prev
) (- a-end a-begin
)
447 (- b-begin b-prev
) (- b-end b-begin
)
448 (- c-begin c-prev
) (- c-end c-begin
)
449 nil nil
; dummy ancestor
452 nil
; state of ancestor
454 (vector (- a-begin a-prev
) (- a-end a-begin
)
455 (- b-begin b-prev
) (- b-end b-begin
)
456 nil nil
; dummy buf C
457 nil nil
; dummy ancestor
460 nil
; state of ancestor
466 ;; else convert lines to points
467 (ediff-with-current-buffer A-buffer
468 (forward-line (- a-begin a-prev
))
469 (setq a-begin-pt
(point))
470 (forward-line (- a-end a-begin
))
471 (setq a-end-pt
(point)
473 (ediff-with-current-buffer B-buffer
474 (forward-line (- b-begin b-prev
))
475 (setq b-begin-pt
(point))
476 (forward-line (- b-end b-begin
))
477 (setq b-end-pt
(point)
479 (if (ediff-buffer-live-p C-buffer
)
480 (ediff-with-current-buffer C-buffer
481 (forward-line (- c-begin c-prev
))
482 (setq c-begin-pt
(point))
483 (forward-line (- c-end c-begin
))
484 (setq c-end-pt
(point)
490 (if (ediff-buffer-live-p C-buffer
)
492 a-begin-pt a-end-pt b-begin-pt b-end-pt
494 nil nil
; dummy ancestor
496 ;; shows which buff is different from the other two
497 (if (eq ediff-default-variant
'default-B
) 'A
'B
)
498 ediff-default-variant
; state of merge
499 nil
; state of ancestor
501 (vector a-begin-pt a-end-pt
503 nil nil
; dummy buf C
504 nil nil
; dummy ancestor
505 nil nil
; dummy state of diff & merge
506 nil
; dummy state of ancestor
510 ))) ; end ediff-with-current-buffer
515 (defun ediff-convert-diffs-to-overlays (diff-list)
516 (ediff-set-diff-overlays-in-one-buffer 'A diff-list
)
517 (ediff-set-diff-overlays-in-one-buffer 'B diff-list
)
519 (ediff-set-diff-overlays-in-one-buffer 'C diff-list
))
520 (if ediff-merge-with-ancestor-job
521 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list
))
522 ;; set up vector showing the status of merge regions
524 (setq ediff-state-of-merge
526 (mapcar (lambda (elt)
527 (let ((state-of-merge (aref elt
9))
528 (state-of-ancestor (aref elt
10)))
530 ;; state of merge: prefers/default-A/B or combined
531 (if state-of-merge
(format "%S" state-of-merge
))
532 ;; whether the ancestor region is empty
534 ;; the first elt designates type of list
537 (message "Processing difference regions ... done"))
540 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list
)
541 (let* ((current-diff -
1)
542 (buff (ediff-get-buffer buf-type
))
543 ;; ediff-extract-diffs puts the type of diff-list as the first elt
544 ;; of this list. The type is either 'points or 'words
545 (diff-list-type (car diff-list
))
546 (shift (ediff-overlay-start
547 (ediff-get-value-according-to-buffer-type
548 buf-type ediff-narrow-bounds
)))
549 (limit (ediff-overlay-end
550 (ediff-get-value-according-to-buffer-type
551 buf-type ediff-narrow-bounds
)))
552 diff-overlay-list list-element total-diffs
553 begin end pt-saved overlay state-of-diff
)
555 (setq diff-list
(cdr diff-list
)) ; discard diff list type
556 (setq total-diffs
(length diff-list
))
558 ;; shift, if necessary
559 (ediff-with-current-buffer buff
(setq pt-saved shift
))
562 (setq current-diff
(1+ current-diff
)
563 list-element
(car diff-list
)
564 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
568 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
572 state-of-diff
(aref list-element
8)
575 (cond ((and (not (eq buf-type state-of-diff
))
576 (not (eq buf-type
'Ancestor
))
577 (memq state-of-diff
'(A B C
)))
579 (car (delq buf-type
(delq state-of-diff
(list 'A
'B
'C
)))))
580 (setq state-of-diff
(format "=diff(%S)" state-of-diff
))
582 (t (setq state-of-diff nil
)))
584 ;; Put overlays at appropriate places in buffer
585 ;; convert word numbers to points, if necessary
586 (if (eq diff-list-type
'words
)
588 (ediff-with-current-buffer buff
(goto-char pt-saved
))
589 (setq begin
(ediff-goto-word (1+ begin
) buff
)
590 end
(ediff-goto-word end buff
'end
))
591 (if (> end limit
) (setq end limit
))
592 (if (> begin end
) (setq begin end
))
593 (setq pt-saved
(ediff-with-current-buffer buff
(point)))))
594 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
596 (ediff-overlay-put overlay
'priority ediff-shadow-overlay-priority
)
597 (ediff-overlay-put overlay
'ediff-diff-num current-diff
)
598 (if (and (ediff-has-face-support-p)
599 ediff-use-faces ediff-highlight-all-diffs
)
600 (ediff-set-overlay-face
601 overlay
(ediff-background-face buf-type current-diff
)))
603 (if (= 0 (mod current-diff
10))
604 (message "Buffer %S: Processing difference region %d of %d"
605 buf-type current-diff total-diffs
))
606 ;; Record all overlays for this difference.
607 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
608 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
609 ;; The 4-th elt says which diff region is different from the other two
610 ;; (3-way jobs only).
611 (setq diff-overlay-list
614 (list (vector overlay nil nil state-of-diff
)))
619 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist
)
620 (vconcat diff-overlay-list
))
623 ;; `n' is the diff region to work on. Default is ediff-current-difference.
624 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
625 ;; diffs have not been computed before.
626 ;; if `flag' is 'skip then don't compute fine diffs for this region.
627 (defun ediff-make-fine-diffs (&optional n flag
)
628 (or n
(setq n ediff-current-difference
))
630 (if (< ediff-number-of-differences
1)
631 (error ediff-NO-DIFFERENCES
))
635 ediff-auto-refine
'nix
))
638 (>= n ediff-number-of-differences
)
639 ;; n is within the range
640 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
641 (file-A ediff-temp-file-A
)
642 (file-B ediff-temp-file-B
)
643 (file-C ediff-temp-file-C
)
644 (empty-A (ediff-empty-diff-region-p n
'A
))
645 (empty-B (ediff-empty-diff-region-p n
'B
))
646 (empty-C (ediff-empty-diff-region-p n
'C
))
647 (whitespace-A (ediff-whitespace-diff-region-p n
'A
))
648 (whitespace-B (ediff-whitespace-diff-region-p n
'B
))
649 (whitespace-C (ediff-whitespace-diff-region-p n
'C
))
650 cumulative-fine-diff-length
)
652 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
653 ;; then don't refine.
654 ;; If the region happens to be entirely whitespace or empty then
656 ((> (length (delq nil
(list empty-A empty-B empty-C
))) 1)
657 (if (and (ediff-looks-like-combined-merge n
)
659 (ediff-set-fine-overlays-in-one-buffer 'C nil n
))
660 (if ediff-3way-comparison-job
661 (ediff-message-if-verbose
662 "Region %d is empty in all buffers but %S"
664 (cond ((not empty-A
) 'A
)
667 (ediff-message-if-verbose
668 "Region %d in buffer %S is empty"
674 ;; if all regions happen to be whitespace
675 (if (and whitespace-A whitespace-B whitespace-C
)
676 ;; mark as space only
677 (ediff-mark-diff-as-space-only n t
)
678 ;; if some regions are white and others don't, then mark as
679 ;; non-white-space-only
680 (ediff-mark-diff-as-space-only n nil
)))
682 ;; don't compute fine diffs if diff vector exists
683 ((and (eq flag
'noforce
) (ediff-get-fine-diff-vector n
'A
))
684 (if (ediff-no-fine-diffs-p n
)
686 "Only white-space differences in region %d %s"
688 (cond ((eq (ediff-no-fine-diffs-p n
) 'A
)
690 ((eq (ediff-no-fine-diffs-p n
) 'B
)
692 ((eq (ediff-no-fine-diffs-p n
) 'C
)
695 ;; don't compute fine diffs for this region
697 (or (ediff-get-fine-diff-vector n
'A
)
698 (memq ediff-auto-refine
'(off nix
))
699 (ediff-message-if-verbose
700 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
702 (substitute-command-keys
703 "\\[ediff-make-or-kill-fine-diffs]")
706 ;; recompute fine diffs
708 (ediff-get-diff-posn 'A
'beg n
)
709 (ediff-get-diff-posn 'A
'end n
)
712 ediff-control-buffer
)
714 (ediff-make-temp-file tmp-buffer
"fineDiffA" file-A
))
717 (ediff-get-diff-posn 'B
'beg n
)
718 (ediff-get-diff-posn 'B
'end n
)
721 ediff-control-buffer
)
723 (ediff-make-temp-file tmp-buffer
"fineDiffB" file-B
))
728 (ediff-get-diff-posn 'C
'beg n
)
729 (ediff-get-diff-posn 'C
'end n
)
732 ediff-control-buffer
)
734 (ediff-make-temp-file
735 tmp-buffer
"fineDiffC" file-C
))))
737 ;; save temp file names.
738 (setq ediff-temp-file-A file-A
739 ediff-temp-file-B file-B
740 ediff-temp-file-C file-C
)
742 ;; set the new vector of fine diffs, if none exists
743 (cond ((and ediff-3way-job whitespace-A
)
744 (ediff-setup-fine-diff-regions nil file-B file-C n
))
745 ((and ediff-3way-job whitespace-B
)
746 (ediff-setup-fine-diff-regions file-A nil file-C n
))
748 ;; In merge-jobs, whitespace-C is t, since
749 ;; ediff-empty-diff-region-p returns t in this case
751 (ediff-setup-fine-diff-regions file-A file-B nil n
))
753 (ediff-setup-fine-diff-regions file-A file-B file-C n
)))
755 (setq cumulative-fine-diff-length
756 (+ (length (ediff-get-fine-diff-vector n
'A
))
757 (length (ediff-get-fine-diff-vector n
'B
))
758 ;; in merge jobs, the merge buffer is never refined
759 (if (and file-C
(not ediff-merge-job
))
760 (length (ediff-get-fine-diff-vector n
'C
))
764 ;; all regions are white space
765 (and whitespace-A whitespace-B whitespace-C
)
766 ;; none is white space and no fine diffs detected
767 (and (not whitespace-A
)
769 (not (and ediff-3way-job whitespace-C
))
770 (eq cumulative-fine-diff-length
0)))
771 (ediff-mark-diff-as-space-only n t
)
772 (ediff-message-if-verbose
773 "Only white-space differences in region %d" (1+ n
)))
774 ((eq cumulative-fine-diff-length
0)
775 (ediff-message-if-verbose
776 "Only white-space differences in region %d %s"
778 (cond (whitespace-A (ediff-mark-diff-as-space-only n
'A
)
780 (whitespace-B (ediff-mark-diff-as-space-only n
'B
)
782 (whitespace-C (ediff-mark-diff-as-space-only n
'C
)
783 "in buffers A & B"))))
785 (ediff-mark-diff-as-space-only n nil
)))
788 (ediff-set-fine-diff-properties n
)
791 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
792 (defun ediff-install-fine-diff-if-necessary (n)
793 (cond ((eq ediff-auto-refine
'on
)
795 (> ediff-auto-refine-limit
796 (- (ediff-get-diff-posn 'A
'end n
)
797 (ediff-get-diff-posn 'A
'beg n
)))
798 (> ediff-auto-refine-limit
799 (- (ediff-get-diff-posn 'B
'end n
)
800 (ediff-get-diff-posn 'B
'beg n
))))
801 (ediff-make-fine-diffs n
'noforce
)
802 (ediff-make-fine-diffs n
'skip
)))
804 ;; highlight iff fine diffs already exist
805 ((eq ediff-auto-refine
'off
)
806 (ediff-make-fine-diffs n
'skip
))))
809 ;; if fine diff vector is not set for diff N, then do nothing
810 (defun ediff-set-fine-diff-properties (n &optional default
)
811 (or (not (ediff-has-face-support-p))
813 (>= n ediff-number-of-differences
)
814 ;; when faces are supported, set faces and priorities of fine overlays
816 (ediff-set-fine-diff-properties-in-one-buffer 'A n default
)
817 (ediff-set-fine-diff-properties-in-one-buffer 'B n default
)
819 (ediff-set-fine-diff-properties-in-one-buffer 'C n default
)))))
821 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
823 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type
))
827 (ediff-get-symbol-from-alist
828 buf-type ediff-fine-diff-face-alist
))))
829 (priority (if default
831 (1+ (or (ediff-overlay-get
833 (ediff-get-symbol-from-alist
835 ediff-current-diff-overlay-alist
))
838 (mapcar (lambda (overl)
839 (ediff-set-overlay-face overl face
)
840 (ediff-overlay-put overl
'priority priority
))
843 ;; Set overlays over the regions that denote delimiters
844 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num
)
845 (let (overlay overlay-list
)
849 (ediff-make-bullet-proof-overlay
850 (nth 0 diff-list
) (nth 1 diff-list
) ediff-buffer-C
))
852 (setq overlay-list
(cons overlay overlay-list
))
853 (if (> (length diff-list
) 1)
854 (setq diff-list
(cdr (cdr diff-list
)))
855 (error "ediff-set-fine-overlays-for-combined-merge: corrupt list of
858 (setq overlay-list
(reverse overlay-list
))
859 (ediff-set-fine-diff-vector
860 reg-num
'C
(apply 'vector overlay-list
))
864 ;; Convert diff list to overlays for a given DIFF-REGION
865 ;; in buffer of type BUF-TYPE
866 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num
)
867 (let* ((current-diff -
1)
868 (reg-start (ediff-get-diff-posn buf-type
'beg region-num
))
869 (buff (ediff-get-buffer buf-type
))
870 combined-merge-diff-list
871 diff-overlay-list list-element
874 (ediff-clear-fine-differences-in-one-buffer region-num buf-type
)
875 (setq diff-list
(cdr diff-list
)) ; discard list type (words or points)
876 (ediff-with-current-buffer buff
(goto-char reg-start
))
878 ;; if it is a combined merge then set overlays in buff C specially
879 (if (and ediff-merge-job
(eq buf-type
'C
)
880 (setq combined-merge-diff-list
881 (ediff-looks-like-combined-merge region-num
)))
882 (ediff-set-fine-overlays-for-combined-merge
883 combined-merge-diff-list region-num
)
886 (setq current-diff
(1+ current-diff
)
887 list-element
(car diff-list
)
888 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
891 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
894 (if (not (or begin end
))
896 ;; Put overlays at appropriate places in buffers
897 ;; convert lines to points, if necessary
898 (setq begin
(ediff-goto-word (1+ begin
) buff
)
899 end
(ediff-goto-word end buff
'end
))
900 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
901 ;; record all overlays for this difference region
902 (setq diff-overlay-list
(nconc diff-overlay-list
(list overlay
))))
904 (setq diff-list
(cdr diff-list
))
906 ;; convert the list of difference information into a vector
908 (ediff-set-fine-diff-vector
909 region-num buf-type
(vconcat diff-overlay-list
))
913 ;; Stolen from emerge.el
914 (defun ediff-get-diff3-group (file)
915 ;; This save-excursion allows ediff-get-diff3-group to be called for the
916 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
917 ;; appear in any order. The reason this is necessary is that Gnu diff3
918 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
921 (concat "^" file
":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
922 (beginning-of-line 2)
923 ;; treatment depends on whether it is an "a" group or a "c" group
924 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
926 (if (match-beginning 2)
927 ;; it has two numbers
929 (buffer-substring (match-beginning 1) (match-end 1)))
931 (buffer-substring (match-beginning 3) (match-end 3)))))
933 (let ((x (string-to-int
934 (buffer-substring (match-beginning 1) (match-end 1)))))
936 ;; it is an "a" group
937 (let ((x (1+ (string-to-int
938 (buffer-substring (match-beginning 1) (match-end 1))))))
942 ;; If WORD-MODE, construct vector of diffs using word numbers.
943 ;; Else, use point values.
944 ;; WORD-MODE also tells if we are in the word-mode or not.
945 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
946 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
947 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
949 ;; BOUNDS specifies visibility bounds to use.
950 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
952 (let ((A-buffer ediff-buffer-A
)
953 (B-buffer ediff-buffer-B
)
954 (C-buffer ediff-buffer-C
)
955 (anc-buffer ediff-ancestor-buffer
)
956 (a-prev 1) ; needed to set the first diff line correctly
960 diff-list shift-A shift-B shift-C
963 ;; diff list contains word numbers or points, depending on word-mode
964 (setq diff-list
(cons (if word-mode
'words
'points
)
969 (ediff-get-value-according-to-buffer-type 'A bounds
))
972 (ediff-get-value-according-to-buffer-type 'B bounds
))
976 (ediff-get-value-according-to-buffer-type 'C bounds
)))))
978 ;; reset point in buffers A, B, C
979 (ediff-with-current-buffer A-buffer
980 (goto-char (if shift-A shift-A
(point-min))))
981 (ediff-with-current-buffer B-buffer
982 (goto-char (if shift-B shift-B
(point-min))))
984 (ediff-with-current-buffer C-buffer
985 (goto-char (if shift-C shift-C
(point-min)))))
986 (if (ediff-buffer-live-p anc-buffer
)
987 (ediff-with-current-buffer anc-buffer
988 (goto-char (point-min))))
990 (ediff-with-current-buffer diff-buffer
991 (goto-char (point-min))
992 (while (re-search-forward ediff-match-diff3-line nil t
)
993 ;; leave point after matched line
994 (beginning-of-line 2)
995 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
996 ;; if the files A and B are the same and not 3way-comparison,
997 ;; ignore the difference
998 (if (or three-way-comp
(not (string-equal agreement
"3")))
999 (let* ((a-begin (car (ediff-get-diff3-group "1")))
1000 (a-end (nth 1 (ediff-get-diff3-group "1")))
1001 (b-begin (car (ediff-get-diff3-group "2")))
1002 (b-end (nth 1 (ediff-get-diff3-group "2")))
1003 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
1004 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
1006 (cond ((string-equal agreement
"1") 'prefer-A
)
1007 ((string-equal agreement
"2") 'prefer-B
)
1008 (t ediff-default-variant
)))
1009 (state-of-diff-merge
1010 (if (memq state-of-merge
'(default-A prefer-A
)) 'B
'A
))
1011 (state-of-diff-comparison
1012 (cond ((string-equal agreement
"1") 'A
)
1013 ((string-equal agreement
"2") 'B
)
1014 ((string-equal agreement
"3") 'C
)))
1020 anc-begin-pt anc-end-pt
)
1022 (setq state-of-ancestor
1023 (= c-or-anc-begin c-or-anc-end
))
1025 (cond (three-way-comp
1026 (setq c-begin c-or-anc-begin
1027 c-end c-or-anc-end
))
1028 ((eq ediff-default-variant
'default-B
)
1029 (setq c-begin b-begin
1032 (setq c-begin a-begin
1035 ;; compute main diff vector
1037 ;; make diff-list contain word numbers
1041 (- a-begin a-prev
) (- a-end a-begin
)
1042 (- b-begin b-prev
) (- b-end b-begin
)
1043 (- c-begin c-prev
) (- c-end c-begin
)
1044 nil nil
; dummy ancestor
1046 nil
; state of merge
1047 nil
; state of ancestor
1052 ;; else convert lines to points
1053 (ediff-with-current-buffer A-buffer
1054 (forward-line (- a-begin a-prev
))
1055 (setq a-begin-pt
(point))
1056 (forward-line (- a-end a-begin
))
1057 (setq a-end-pt
(point)
1059 (ediff-with-current-buffer B-buffer
1060 (forward-line (- b-begin b-prev
))
1061 (setq b-begin-pt
(point))
1062 (forward-line (- b-end b-begin
))
1063 (setq b-end-pt
(point)
1065 (ediff-with-current-buffer C-buffer
1066 (forward-line (- c-begin c-prev
))
1067 (setq c-begin-pt
(point))
1068 (forward-line (- c-end c-begin
))
1069 (setq c-end-pt
(point)
1071 (if (ediff-buffer-live-p anc-buffer
)
1072 (ediff-with-current-buffer anc-buffer
1073 (forward-line (- c-or-anc-begin anc-prev
))
1074 (setq anc-begin-pt
(point))
1075 (forward-line (- c-or-anc-end c-or-anc-begin
))
1076 (setq anc-end-pt
(point)
1077 anc-prev c-or-anc-end
)))
1081 ;; if comparing with ancestor, then there also is a
1082 ;; state-of-difference marker
1088 nil nil
; ancestor begin/end
1089 state-of-diff-comparison
1090 nil
; state of merge
1091 nil
; state of ancestor
1093 (list (vector a-begin-pt a-end-pt
1096 anc-begin-pt anc-end-pt
1104 ))) ; end ediff-with-current-buffer
1108 ;; Generate the difference vector and overlays for three files
1109 ;; File-C is either the third file to compare (in case of 3-way comparison)
1110 ;; or it is the ancestor file.
1111 (defun ediff-setup-diff-regions3 (file-A file-B file-C
)
1112 (or (ediff-buffer-live-p ediff-diff-buffer
)
1113 (setq ediff-diff-buffer
1114 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1116 (message "Computing differences ...")
1117 (ediff-exec-process ediff-diff3-program ediff-diff-buffer
'synchronize
1118 ediff-diff3-options file-A file-B file-C
)
1120 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer
)
1121 ;;(message "Computing differences ... done")
1122 (ediff-convert-diffs-to-overlays
1123 (ediff-extract-diffs3
1125 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds
)
1129 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1130 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1131 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1132 ;; string. All elements in FILES must be strings. We also delete nil from
1134 (defun ediff-exec-process (program buffer synch options
&rest files
)
1135 (let ((data (match-data))
1136 (coding-system-for-read 'no-conversion
)
1138 (setq args
(append (split-string options
) files
))
1139 (setq args
(delete "" (delq nil args
))) ; delete nil and "" from arguments
1140 ;; the --binary option, if present, should be used only for buffer jobs
1141 ;; or for refining the differences
1142 (or (string-match "buffer" (symbol-name ediff-job-name
))
1143 (eq buffer ediff-fine-diff-buffer
)
1144 (setq args
(delete "--binary" args
)))
1146 (let ((directory default-directory
)
1151 (setq default-directory directory
)
1152 (if (or (memq system-type
'(emx ms-dos windows-nt windows-95
))
1154 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1155 ;; delete files used by other processes. Thus, in ediff-buffers
1156 ;; and similar functions, we can't delete temp files because
1157 ;; they might be used by the asynch process that computes
1158 ;; custom diffs. So, we have to wait till custom diff
1159 ;; subprocess is done.
1160 ;; Similarly for Windows-*
1161 ;; In DOS, must synchronize because DOS doesn't have
1162 ;; asynchronous processes.
1163 (apply 'call-process program nil buffer nil args
)
1164 ;; On other systems, do it asynchronously.
1165 (setq proc
(get-buffer-process buffer
))
1166 (if proc
(kill-process proc
))
1168 (apply 'start-process
"Custom Diff" buffer program args
))
1169 (setq mode-line-process
'(":%s"))
1170 (set-process-sentinel proc
'ediff-process-sentinel
)
1171 (set-process-filter proc
'ediff-process-filter
)
1173 (store-match-data data
))))
1175 ;; This is shell-command-filter from simple.el in Emacs.
1176 ;; Copied here because XEmacs doesn't have it.
1177 (defun ediff-process-filter (proc string
)
1178 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1179 ;; despite an insertion immediately after it.
1180 (let* ((obuf (current-buffer))
1181 (buffer (process-buffer proc
))
1183 (window (get-buffer-window buffer
))
1184 (pos (window-start window
)))
1188 (or (= (point) (point-max))
1189 (setq opoint
(point)))
1190 (goto-char (point-max))
1191 (insert-before-markers string
))
1192 ;; insert-before-markers moved this marker: set it back.
1193 (set-window-start window pos
)
1194 ;; Finish our save-excursion.
1197 (set-buffer obuf
))))
1199 ;; like shell-command-sentinel but doesn't print an exit status message
1200 ;; we do this because diff always exits with status 1, if diffs are found
1201 ;; so shell-command-sentinel displays a confusing message to the user
1202 (defun ediff-process-sentinel (process signal
)
1203 (if (and (memq (process-status process
) '(exit signal
))
1204 (buffer-name (process-buffer process
)))
1207 (set-buffer (process-buffer process
))
1208 (setq mode-line-process nil
))
1209 (delete-process process
))))
1212 ;;; Word functions used to refine the current diff
1214 (defvar ediff-forward-word-function
'ediff-forward-word
1215 "*Function to call to move to the next word.
1216 Used for splitting difference regions into individual words.")
1218 (defvar ediff-whitespace
" \n\t\f"
1219 "*Characters constituting white space.
1220 These characters are ignored when differing regions are split into words.")
1222 (defvar ediff-word-1
"a-zA-Z---_"
1223 "*Characters that constitute words of type 1.
1224 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1225 See `ediff-forward-word' for more details.")
1227 (defvar ediff-word-2
"0-9.,"
1228 "*Characters that constitute words of type 2.
1229 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1230 See `ediff-forward-word' for more details.")
1232 (defvar ediff-word-3
"`'?!:;\"{}[]()"
1233 "*Characters that constitute words of type 3.
1234 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1235 See `ediff-forward-word' for more details.")
1237 (defvar ediff-word-4
1238 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace
)
1239 "*Characters that constitute words of type 4.
1240 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1241 See `ediff-forward-word' for more details.")
1243 ;; Split region along word boundaries. Each word will be on its own line.
1244 ;; Output to buffer out-buffer.
1245 (defun ediff-forward-word ()
1246 "Move point one word forward.
1247 There are four types of words, each of which consists entirely of
1248 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1249 `ediff-word-4'. Words are recognized by passing these one after another as
1250 arguments to `skip-chars-forward'."
1251 (or (> (+ (skip-chars-forward ediff-word-1
)
1252 (skip-syntax-forward "w"))
1254 (> (skip-chars-forward ediff-word-2
) 0)
1255 (> (skip-chars-forward ediff-word-3
) 0)
1256 (> (skip-chars-forward ediff-word-4
) 0)
1260 (defun ediff-wordify (beg end in-buffer out-buffer
&optional control-buf
)
1261 (let (inbuf-syntax-tbl sv-point string
)
1263 (set-buffer in-buffer
)
1264 (setq inbuf-syntax-tbl
(syntax-table))
1265 (setq string
(buffer-substring-no-properties beg end
))
1267 (set-buffer out-buffer
)
1268 ;; Make sure that temp buff syntax table is the same a the original buf
1269 ;; syntax tbl, because we use ediff-forward-word in both and
1270 ;; ediff-forward-word depends on the syntax classes of characters.
1271 (set-syntax-table inbuf-syntax-tbl
)
1274 (goto-char (point-min))
1275 (skip-chars-forward ediff-whitespace
)
1276 (delete-region (point-min) (point))
1279 ;; eval incontrol buf to let user create local versions for
1280 ;; different invocations
1283 (ediff-with-current-buffer
1284 control-buf ediff-forward-word-function
))
1285 (funcall ediff-forward-word-function
))
1286 (setq sv-point
(point))
1287 (skip-chars-forward ediff-whitespace
)
1288 (delete-region sv-point
(point))
1291 ;; copy string from BEG END from IN-BUF to OUT-BUF
1292 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer
)
1295 (set-buffer in-buffer
)
1296 (setq string
(buffer-substring beg end
))
1298 (set-buffer out-buffer
)
1301 (goto-char (point-min)))))
1304 ;; goto word #n starting at current position in buffer `buf'
1305 ;; For ediff, a word is either a string of a-z,A-Z, incl `-' and `_';
1306 ;; or a string of other non-blanks. A blank is a \n\t\f
1307 ;; If `flag' is non-nil, goto the end of the n-th word.
1308 (defun ediff-goto-word (n buf
&optional flag
)
1309 ;; remember val ediff-forward-word-function has in ctl buf
1310 (let ((fwd-word-fun ediff-forward-word-function
))
1311 (ediff-with-current-buffer buf
1312 (skip-chars-forward ediff-whitespace
)
1314 (funcall fwd-word-fun
)
1315 (skip-chars-forward ediff-whitespace
)
1317 (if (and flag
(> n
0))
1318 (funcall fwd-word-fun
))
1321 (defun ediff-same-file-contents (f1 f2
)
1322 "T if F1 and F2 have identical contents."
1324 (apply 'call-process ediff-cmp-program nil nil nil
1325 (append ediff-cmp-options
(list f1 f2
)))))
1326 (and (numberp res
) (eq res
0))))
1329 ;;; Local Variables:
1330 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1331 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1332 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1336 ;; ediff-diff.el ends here