1 ;;; ediff-diff.el --- diff-related utilities
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
31 (defvar ediff-default-variant
)
35 (let ((load-path (cons (expand-file-name ".") load-path
)))
36 (or (featurep 'ediff-init
)
37 (load "ediff-init.el" nil nil
'nosuffix
))
38 (or (featurep 'ediff-util
)
39 (load "ediff-util.el" nil nil
'nosuffix
))
45 (defgroup ediff-diff nil
46 "Diff related utilities"
50 ;; these two must be here to prevent ediff-test-utility from barking
51 (defcustom ediff-diff-program
"diff"
52 "*Program to use for generating the differential of the two files."
55 (defcustom ediff-diff3-program
"diff3"
56 "*Program to be used for three-way comparison.
57 Must produce output compatible with Unix's diff3 program."
62 ;; The following functions must precede all defcustom-defined variables.
64 ;; The following functions needed for setting diff/diff3 options
65 ;; test if diff supports the --binary option
66 (defsubst ediff-test-utility
(diff-util option
&optional files
)
67 (zerop (apply 'call-process
68 (append (list diff-util nil nil nil option
) files
))))
70 (defun ediff-diff-mandatory-option (diff-util)
71 (let ((file (if (boundp 'null-device
) null-device
"/dev/null")))
72 (cond ((not (memq system-type
'(ms-dos windows-nt windows-95
)))
74 ((and (string= diff-util ediff-diff-program
)
76 ediff-diff-program
"--binary" (list file file
)))
78 ((and (string= diff-util ediff-diff3-program
)
80 ediff-diff3-program
"--binary" (list file file file
)))
84 ;; make sure that mandatory options are added even if the user changes
85 ;; ediff-diff-options or ediff-diff3-options in the customization widget
86 (defun ediff-reset-diff-options (symb val
)
88 (if (eq symb
'ediff-diff-options
)
91 (mandatory-option (ediff-diff-mandatory-option diff-program
))
92 (spacer (if (string-equal mandatory-option
"") "" " ")))
94 (if (string-match mandatory-option val
)
96 (concat mandatory-option spacer val
)))
100 (defcustom ediff-shell
101 (cond ((eq system-type
'emx
) "cmd") ; OS/2
102 ((memq system-type
'(ms-dos windows-nt windows-95
))
103 shell-file-name
) ; no standard name on MS-DOS
104 ((memq system-type
'(vax-vms axp-vms
)) "*dcl*") ; VMS
106 "*The shell used to run diff and patch.
107 If user's .profile or .cshrc files are set up correctly, any shell
108 will do. However, some people set $prompt or other things
109 incorrectly, which leads to undesirable output messages. These may
110 cause Ediff to fail. In such a case, set `ediff-shell' to a shell that
111 you are not using or, better, fix your shell's startup file."
115 (defcustom ediff-cmp-program
"cmp"
116 "*Utility to use to determine if two files are identical.
117 It must return code 0, if its arguments are identical files."
121 (defcustom ediff-cmp-options nil
122 "*Options to pass to `ediff-cmp-program'.
123 If GNU diff is used as `ediff-cmp-program', then the most useful options
124 are `-I REGEXP', to ignore changes whose lines match the REGEXP."
125 :type
'(repeat string
)
128 (defcustom ediff-diff-options
""
129 "*Options to pass to `ediff-diff-program'.
130 If Unix diff is used as `ediff-diff-program', then the most useful options are
131 `-w', to ignore space, and `-i', to ignore case of letters.
132 At present, the option `-c' is not allowed."
133 :set
'ediff-reset-diff-options
137 (defcustom ediff-custom-diff-program ediff-diff-program
138 "*Program to use for generating custom diff output for saving it in a file.
139 This output is not used by Ediff internally."
142 (defcustom ediff-custom-diff-options
"-c"
143 "*Options to pass to `ediff-custom-diff-program'."
147 ;;; Support for diff3
149 (defvar ediff-match-diff3-line
"^====\\(.?\\)\C-m?$"
150 "Pattern to match lines produced by diff3 that describe differences.")
151 (defcustom ediff-diff3-options
""
152 "*Options to pass to `ediff-diff3-program'."
153 :set
'ediff-reset-diff-options
156 (defcustom ediff-diff3-ok-lines-regexp
157 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
158 "*Regexp that matches normal output lines from `ediff-diff3-program'.
159 Lines that do not match are assumed to be error messages."
163 ;; keeps the status of the current diff in 3-way jobs.
164 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
165 (ediff-defvar-local ediff-diff-status
"" "")
170 (ediff-defvar-local ediff-auto-refine
(if (ediff-has-face-support-p) 'on
'nix
)
171 "If `on', Ediff auto-highlights fine diffs for the current diff region.
172 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
173 at all, unless the user force-refines the region by hitting `*'.
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-ignore-similar-regions nil
179 "*If t, skip over difference regions that differ only in the white space and line breaks.
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-auto-refine-limit
1400
184 "*Auto-refine only the regions of this size \(in bytes\) or less.")
188 (defvar ediff-diff-ok-lines-regexp
191 "[0-9,]+[acd][0-9,]+\C-m?$"
196 "\\|.*missing +newline"
199 "Regexp that matches normal output lines from `ediff-diff-program'.
200 This is mostly lifted from Emerge, except that Ediff also considers
201 warnings and `Missing newline'-type messages to be normal output.
202 Lines that do not match are assumed to be error messages.")
204 (defvar ediff-match-diff-line
205 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
206 (concat "^" x
"\\([acd]\\)" x
"\C-m?$"))
207 "Pattern to match lines produced by diff that describe differences.")
209 (ediff-defvar-local ediff-setup-diff-regions-function nil
210 "value is a function symbol depending on the kind of job is to be done.
211 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
212 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
214 The function should take three mandatory arguments, file-A, file-B, and
215 file-C. It may ignore file C for diff2 jobs. It should also take
216 one optional arguments, diff-number to refine.")
221 ;; Generate the difference vector and overlays for the two files
222 ;; With optional arg REG-TO-REFINE, refine this region.
223 ;; File-C argument is not used here. It is there just because
224 ;; ediff-setup-diff-regions is called via a funcall to
225 ;; ediff-setup-diff-regions-function, which can also have the value
226 ;; ediff-setup-diff-regions3, which takes 4 arguments.
227 (defun ediff-setup-diff-regions (file-A file-B file-C
)
228 ;; looking either for '-c' or a 'c' in a set of clustered non-long options
229 (if (string-match "^-c\\| -c\\|-[^- ]+c" ediff-diff-options
)
230 (error "Option `-c' is not allowed in `ediff-diff-options'"))
232 ;; create, if it doesn't exist
233 (or (ediff-buffer-live-p ediff-diff-buffer
)
234 (setq ediff-diff-buffer
235 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
236 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B
)
237 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer
)
238 (ediff-convert-diffs-to-overlays
240 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds
)))
242 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
243 ;; Return the size of DIFF-BUFFER
244 ;; The return code isn't used in the program at present.
245 (defun ediff-make-diff2-buffer (diff-buffer file1 file2
)
246 (let ((file1-size (ediff-file-size file1
))
247 (file2-size (ediff-file-size file2
)))
248 (cond ((not (numberp file1-size
))
249 (message "Can't find file: %s"
250 (ediff-abbreviate-file-name file1
))
252 ;; 1 is an error exit code
254 ((not (numberp file2-size
))
255 (message "Can't find file: %s"
256 (ediff-abbreviate-file-name file2
))
258 ;; 1 is an error exit code
260 (t (message "Computing differences between %s and %s ..."
261 (file-name-nondirectory file1
)
262 (file-name-nondirectory file2
))
263 ;; this erases the diff buffer automatically
264 (ediff-exec-process ediff-diff-program
267 ediff-diff-options file1 file2
)
269 (ediff-with-current-buffer diff-buffer
274 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
275 ;; This function works for diff3 and diff2 jobs
276 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num
)
277 (or (ediff-buffer-live-p ediff-fine-diff-buffer
)
278 (setq ediff-fine-diff-buffer
280 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
282 (let (diff3-job diff-program diff-options ok-regexp diff-list
)
283 (setq diff3-job ediff-3way-job
284 diff-program
(if diff3-job ediff-diff3-program ediff-diff-program
)
285 diff-options
(if diff3-job ediff-diff3-options ediff-diff-options
)
286 ok-regexp
(if diff3-job
287 ediff-diff3-ok-lines-regexp
288 ediff-diff-ok-lines-regexp
))
290 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num
))
291 (ediff-exec-process diff-program ediff-fine-diff-buffer
'synchronize
293 ;; The shuffle below is because we can compare 3-way
294 ;; or in several 2-way fashions, like fA fC, fA fB,
296 (if file-A file-A file-B
)
297 (if file-B file-B file-A
)
299 (if file-C file-C file-B
))
302 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer
)
303 (ediff-message-if-verbose
305 ;; "Refining difference region %d ... done" (1+ reg-num))
309 (ediff-extract-diffs3
310 ediff-fine-diff-buffer
'3way-comparison
'word-mode
)
311 (ediff-extract-diffs ediff-fine-diff-buffer
'word-mode
)))
315 (mapcar (lambda (elt)
320 (mapcar (lambda (elt)
325 (mapcar (lambda (elt)
331 (ediff-convert-fine-diffs-to-overlays diff-list reg-num
)
335 (defun ediff-prepare-error-list (ok-regexp diff-buff
)
336 (or (ediff-buffer-live-p ediff-error-buffer
)
337 (setq ediff-error-buffer
338 (get-buffer-create (ediff-unique-buffer-name
339 "*ediff-errors" "*"))))
340 (ediff-with-current-buffer ediff-error-buffer
342 (insert (ediff-with-current-buffer diff-buff
(buffer-string)))
343 (goto-char (point-min))
344 (delete-matching-lines ok-regexp
)
345 (if (memq system-type
'(vax-vms axp-vms
))
346 (delete-matching-lines "^$")))
347 ;; If diff reports errors, show them then quit.
348 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer
(buffer-size)))
349 (let ((ctl-buf ediff-control-buffer
)
350 (error-buf ediff-error-buffer
))
351 (ediff-skip-unsuitable-frames)
352 (switch-to-buffer error-buf
)
353 (ediff-kill-buffer-carefully ctl-buf
)
354 (error "Errors in diff output. Diff output is in %S" diff-buff
))))
356 ;; BOUNDS specifies visibility bounds to use.
357 ;; WORD-MODE tells whether we are in the word-mode or not.
358 ;; If WORD-MODE, also construct vector of diffs using word numbers.
359 ;; Else, use point values.
360 ;; This function handles diff-2 jobs including the case of
361 ;; merging buffers and files without ancestor.
362 (defun ediff-extract-diffs (diff-buffer word-mode
&optional bounds
)
363 (let ((A-buffer ediff-buffer-A
)
364 (B-buffer ediff-buffer-B
)
365 (C-buffer ediff-buffer-C
)
366 (a-prev 1) ; this is needed to set the first diff line correctly
369 diff-list shift-A shift-B
372 ;; diff list contains word numbers, unless changed later
373 (setq diff-list
(cons (if word-mode
'words
'points
)
375 ;; we don't use visibility bounds for buffer C when merging
379 (ediff-get-value-according-to-buffer-type 'A bounds
))
382 (ediff-get-value-according-to-buffer-type 'B bounds
))))
384 ;; reset point in buffers A/B/C
385 (ediff-with-current-buffer A-buffer
386 (goto-char (if shift-A shift-A
(point-min))))
387 (ediff-with-current-buffer B-buffer
388 (goto-char (if shift-B shift-B
(point-min))))
389 (if (ediff-buffer-live-p C-buffer
)
390 (ediff-with-current-buffer C-buffer
391 (goto-char (point-min))))
393 (ediff-with-current-buffer diff-buffer
394 (goto-char (point-min))
395 (while (re-search-forward ediff-match-diff-line nil t
)
396 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
398 (a-end (let ((b (match-beginning 3))
401 (string-to-int (buffer-substring b e
))
403 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
404 (b-begin (string-to-int (buffer-substring (match-beginning 5)
406 (b-end (let ((b (match-beginning 7))
409 (string-to-int (buffer-substring b e
))
411 a-begin-pt a-end-pt b-begin-pt b-end-pt
412 c-begin c-end c-begin-pt c-end-pt
)
413 ;; fix the beginning and end numbers, because diff is somewhat
414 ;; strange about how it numbers lines
415 (if (string-equal diff-type
"a")
416 (setq b-end
(1+ b-end
)
419 (if (string-equal diff-type
"d")
420 (setq a-end
(1+ a-end
)
423 ;; (string-equal diff-type "c")
424 (setq a-end
(1+ a-end
)
427 (if (eq ediff-default-variant
'default-B
)
428 (setq c-begin b-begin
430 (setq c-begin a-begin
433 ;; compute main diff vector
435 ;; make diff-list contain word numbers
439 (if (ediff-buffer-live-p C-buffer
)
440 (vector (- a-begin a-prev
) (- a-end a-begin
)
441 (- b-begin b-prev
) (- b-end b-begin
)
442 (- c-begin c-prev
) (- c-end c-begin
)
443 nil nil
; dummy ancestor
446 nil
; state of ancestor
448 (vector (- a-begin a-prev
) (- a-end a-begin
)
449 (- b-begin b-prev
) (- b-end b-begin
)
450 nil nil
; dummy buf C
451 nil nil
; dummy ancestor
454 nil
; state of ancestor
460 ;; else convert lines to points
461 (ediff-with-current-buffer A-buffer
462 (forward-line (- a-begin a-prev
))
463 (setq a-begin-pt
(point))
464 (forward-line (- a-end a-begin
))
465 (setq a-end-pt
(point)
467 (ediff-with-current-buffer B-buffer
468 (forward-line (- b-begin b-prev
))
469 (setq b-begin-pt
(point))
470 (forward-line (- b-end b-begin
))
471 (setq b-end-pt
(point)
473 (if (ediff-buffer-live-p C-buffer
)
474 (ediff-with-current-buffer C-buffer
475 (forward-line (- c-begin c-prev
))
476 (setq c-begin-pt
(point))
477 (forward-line (- c-end c-begin
))
478 (setq c-end-pt
(point)
484 (if (ediff-buffer-live-p C-buffer
)
486 a-begin-pt a-end-pt b-begin-pt b-end-pt
488 nil nil
; dummy ancestor
490 ;; shows which buff is different from the other two
491 (if (eq ediff-default-variant
'default-B
) 'A
'B
)
492 ediff-default-variant
; state of merge
493 nil
; state of ancestor
495 (vector a-begin-pt a-end-pt
497 nil nil
; dummy buf C
498 nil nil
; dummy ancestor
499 nil nil
; dummy state of diff & merge
500 nil
; dummy state of ancestor
504 ))) ; end ediff-with-current-buffer
509 (defun ediff-convert-diffs-to-overlays (diff-list)
510 (ediff-set-diff-overlays-in-one-buffer 'A diff-list
)
511 (ediff-set-diff-overlays-in-one-buffer 'B diff-list
)
513 (ediff-set-diff-overlays-in-one-buffer 'C diff-list
))
514 (if ediff-merge-with-ancestor-job
515 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list
))
516 ;; set up vector showing the status of merge regions
518 (setq ediff-state-of-merge
520 (mapcar (lambda (elt)
521 (let ((state-of-merge (aref elt
9))
522 (state-of-ancestor (aref elt
10)))
524 ;; state of merge: prefers/default-A/B or combined
525 (if state-of-merge
(format "%S" state-of-merge
))
526 ;; whether the ancestor region is empty
528 ;; the first elt designates type of list
531 (message "Processing difference regions ... done"))
534 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list
)
535 (let* ((current-diff -
1)
536 (buff (ediff-get-buffer buf-type
))
537 ;; ediff-extract-diffs puts the type of diff-list as the first elt
538 ;; of this list. The type is either 'points or 'words
539 (diff-list-type (car diff-list
))
540 (shift (ediff-overlay-start
541 (ediff-get-value-according-to-buffer-type
542 buf-type ediff-narrow-bounds
)))
543 (limit (ediff-overlay-end
544 (ediff-get-value-according-to-buffer-type
545 buf-type ediff-narrow-bounds
)))
546 diff-overlay-list list-element total-diffs
547 begin end pt-saved overlay state-of-diff
)
549 (setq diff-list
(cdr diff-list
)) ; discard diff list type
550 (setq total-diffs
(length diff-list
))
552 ;; shift, if necessary
553 (ediff-with-current-buffer buff
(setq pt-saved shift
))
556 (setq current-diff
(1+ current-diff
)
557 list-element
(car diff-list
)
558 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
562 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
566 state-of-diff
(aref list-element
8)
569 (cond ((and (not (eq buf-type state-of-diff
))
570 (not (eq buf-type
'Ancestor
))
571 (memq state-of-diff
'(A B C
)))
573 (car (delq buf-type
(delq state-of-diff
(list 'A
'B
'C
)))))
574 (setq state-of-diff
(format "=diff(%S)" state-of-diff
))
576 (t (setq state-of-diff nil
)))
578 ;; Put overlays at appropriate places in buffer
579 ;; convert word numbers to points, if necessary
580 (if (eq diff-list-type
'words
)
582 (ediff-with-current-buffer buff
(goto-char pt-saved
))
583 (setq begin
(ediff-goto-word (1+ begin
) buff
)
584 end
(ediff-goto-word end buff
'end
))
585 (if (> end limit
) (setq end limit
))
586 (if (> begin end
) (setq begin end
))
587 (setq pt-saved
(ediff-with-current-buffer buff
(point)))))
588 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
590 (ediff-overlay-put overlay
'priority ediff-shadow-overlay-priority
)
591 (ediff-overlay-put overlay
'ediff-diff-num current-diff
)
592 (if (and (ediff-has-face-support-p)
593 ediff-use-faces ediff-highlight-all-diffs
)
594 (ediff-set-overlay-face
595 overlay
(ediff-background-face buf-type current-diff
)))
597 (if (= 0 (mod current-diff
10))
598 (message "Buffer %S: Processing difference region %d of %d"
599 buf-type current-diff total-diffs
))
600 ;; Record all overlays for this difference.
601 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
602 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
603 ;; The 4-th elt says which diff region is different from the other two
604 ;; (3-way jobs only).
605 (setq diff-overlay-list
608 (list (vector overlay nil nil state-of-diff
)))
613 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist
)
614 (vconcat diff-overlay-list
))
617 ;; `n' is the diff region to work on. Default is ediff-current-difference.
618 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
619 ;; diffs have not been computed before.
620 ;; if `flag' is 'skip then don't compute fine diffs for this region.
621 (defun ediff-make-fine-diffs (&optional n flag
)
622 (or n
(setq n ediff-current-difference
))
624 (if (< ediff-number-of-differences
1)
625 (error ediff-NO-DIFFERENCES
))
629 ediff-auto-refine
'nix
))
632 (>= n ediff-number-of-differences
)
633 ;; n is within the range
634 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer
))
635 (file-A ediff-temp-file-A
)
636 (file-B ediff-temp-file-B
)
637 (file-C ediff-temp-file-C
)
638 (empty-A (ediff-empty-diff-region-p n
'A
))
639 (empty-B (ediff-empty-diff-region-p n
'B
))
640 (empty-C (ediff-empty-diff-region-p n
'C
))
641 (whitespace-A (ediff-whitespace-diff-region-p n
'A
))
642 (whitespace-B (ediff-whitespace-diff-region-p n
'B
))
643 (whitespace-C (ediff-whitespace-diff-region-p n
'C
))
644 cumulative-fine-diff-length
)
646 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
647 ;; then don't refine.
648 ;; If the region happens to be entirely whitespace or empty then
650 ((> (length (delq nil
(list empty-A empty-B empty-C
))) 1)
651 (if (and (ediff-looks-like-combined-merge n
)
653 (ediff-set-fine-overlays-in-one-buffer 'C nil n
))
654 (if ediff-3way-comparison-job
655 (ediff-message-if-verbose
656 "Region %d is empty in all buffers but %S"
658 (cond ((not empty-A
) 'A
)
661 (ediff-message-if-verbose
662 "Region %d in buffer %S is empty"
668 ;; if all regions happen to be whitespace
669 (if (and whitespace-A whitespace-B whitespace-C
)
670 ;; mark as space only
671 (ediff-mark-diff-as-space-only n t
)
672 ;; if some regions are white and others don't, then mark as
673 ;; non-white-space-only
674 (ediff-mark-diff-as-space-only n nil
)))
676 ;; don't compute fine diffs if diff vector exists
677 ((and (eq flag
'noforce
) (ediff-get-fine-diff-vector n
'A
))
678 (if (ediff-no-fine-diffs-p n
)
680 "Only white-space differences in region %d %s"
682 (cond ((eq (ediff-no-fine-diffs-p n
) 'A
)
684 ((eq (ediff-no-fine-diffs-p n
) 'B
)
686 ((eq (ediff-no-fine-diffs-p n
) 'C
)
689 ;; don't compute fine diffs for this region
691 (or (ediff-get-fine-diff-vector n
'A
)
692 (memq ediff-auto-refine
'(off nix
))
693 (ediff-message-if-verbose
694 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
696 (substitute-command-keys
697 "\\[ediff-make-or-kill-fine-diffs]")
700 ;; recompute fine diffs
702 (ediff-get-diff-posn 'A
'beg n
)
703 (ediff-get-diff-posn 'A
'end n
)
706 ediff-control-buffer
)
708 (ediff-make-temp-file tmp-buffer
"fineDiffA" file-A
))
711 (ediff-get-diff-posn 'B
'beg n
)
712 (ediff-get-diff-posn 'B
'end n
)
715 ediff-control-buffer
)
717 (ediff-make-temp-file tmp-buffer
"fineDiffB" file-B
))
722 (ediff-get-diff-posn 'C
'beg n
)
723 (ediff-get-diff-posn 'C
'end n
)
726 ediff-control-buffer
)
728 (ediff-make-temp-file
729 tmp-buffer
"fineDiffC" file-C
))))
731 ;; save temp file names.
732 (setq ediff-temp-file-A file-A
733 ediff-temp-file-B file-B
734 ediff-temp-file-C file-C
)
736 ;; set the new vector of fine diffs, if none exists
737 (cond ((and ediff-3way-job whitespace-A
)
738 (ediff-setup-fine-diff-regions nil file-B file-C n
))
739 ((and ediff-3way-job whitespace-B
)
740 (ediff-setup-fine-diff-regions file-A nil file-C n
))
742 ;; In merge-jobs, whitespace-C is t, since
743 ;; ediff-empty-diff-region-p returns t in this case
745 (ediff-setup-fine-diff-regions file-A file-B nil n
))
747 (ediff-setup-fine-diff-regions file-A file-B file-C n
)))
749 (setq cumulative-fine-diff-length
750 (+ (length (ediff-get-fine-diff-vector n
'A
))
751 (length (ediff-get-fine-diff-vector n
'B
))
752 ;; in merge jobs, the merge buffer is never refined
753 (if (and file-C
(not ediff-merge-job
))
754 (length (ediff-get-fine-diff-vector n
'C
))
758 ;; all regions are white space
759 (and whitespace-A whitespace-B whitespace-C
)
760 ;; none is white space and no fine diffs detected
761 (and (not whitespace-A
)
763 (not (and ediff-3way-job whitespace-C
))
764 (eq cumulative-fine-diff-length
0)))
765 (ediff-mark-diff-as-space-only n t
)
766 (ediff-message-if-verbose
767 "Only white-space differences in region %d" (1+ n
)))
768 ((eq cumulative-fine-diff-length
0)
769 (ediff-message-if-verbose
770 "Only white-space differences in region %d %s"
772 (cond (whitespace-A (ediff-mark-diff-as-space-only n
'A
)
774 (whitespace-B (ediff-mark-diff-as-space-only n
'B
)
776 (whitespace-C (ediff-mark-diff-as-space-only n
'C
)
777 "in buffers A & B"))))
779 (ediff-mark-diff-as-space-only n nil
)))
782 (ediff-set-fine-diff-properties n
)
785 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
786 (defun ediff-install-fine-diff-if-necessary (n)
787 (cond ((and (eq ediff-auto-refine
'on
)
789 (not (eq ediff-highlighting-style
'off
))
790 (not (eq ediff-highlighting-style
'ascii
)))
792 (> ediff-auto-refine-limit
793 (- (ediff-get-diff-posn 'A
'end n
)
794 (ediff-get-diff-posn 'A
'beg n
)))
795 (> ediff-auto-refine-limit
796 (- (ediff-get-diff-posn 'B
'end n
)
797 (ediff-get-diff-posn 'B
'beg n
))))
798 (ediff-make-fine-diffs n
'noforce
)
799 (ediff-make-fine-diffs n
'skip
)))
801 ;; highlight iff fine diffs already exist
802 ((eq ediff-auto-refine
'off
)
803 (ediff-make-fine-diffs n
'skip
))))
806 ;; if fine diff vector is not set for diff N, then do nothing
807 (defun ediff-set-fine-diff-properties (n &optional default
)
808 (or (not (ediff-has-face-support-p))
810 (>= n ediff-number-of-differences
)
811 ;; when faces are supported, set faces and priorities of fine overlays
813 (ediff-set-fine-diff-properties-in-one-buffer 'A n default
)
814 (ediff-set-fine-diff-properties-in-one-buffer 'B n default
)
816 (ediff-set-fine-diff-properties-in-one-buffer 'C n default
)))))
818 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
820 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type
))
824 (ediff-get-symbol-from-alist
825 buf-type ediff-fine-diff-face-alist
))))
826 (priority (if default
828 (1+ (or (ediff-overlay-get
830 (ediff-get-symbol-from-alist
832 ediff-current-diff-overlay-alist
))
835 (mapcar (lambda (overl)
836 (ediff-set-overlay-face overl face
)
837 (ediff-overlay-put overl
'priority priority
))
840 ;; Set overlays over the regions that denote delimiters
841 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num
)
842 (let (overlay overlay-list
)
846 (ediff-make-bullet-proof-overlay
847 (nth 0 diff-list
) (nth 1 diff-list
) ediff-buffer-C
))
849 (setq overlay-list
(cons overlay overlay-list
))
850 (if (> (length diff-list
) 1)
851 (setq diff-list
(cdr (cdr diff-list
)))
852 (error "ediff-set-fine-overlays-for-combined-merge: corrupt list of
855 (setq overlay-list
(reverse overlay-list
))
856 (ediff-set-fine-diff-vector
857 reg-num
'C
(apply 'vector overlay-list
))
861 ;; Convert diff list to overlays for a given DIFF-REGION
862 ;; in buffer of type BUF-TYPE
863 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num
)
864 (let* ((current-diff -
1)
865 (reg-start (ediff-get-diff-posn buf-type
'beg region-num
))
866 (buff (ediff-get-buffer buf-type
))
867 combined-merge-diff-list
868 diff-overlay-list list-element
871 (ediff-clear-fine-differences-in-one-buffer region-num buf-type
)
872 (setq diff-list
(cdr diff-list
)) ; discard list type (words or points)
873 (ediff-with-current-buffer buff
(goto-char reg-start
))
875 ;; if it is a combined merge then set overlays in buff C specially
876 (if (and ediff-merge-job
(eq buf-type
'C
)
877 (setq combined-merge-diff-list
878 (ediff-looks-like-combined-merge region-num
)))
879 (ediff-set-fine-overlays-for-combined-merge
880 combined-merge-diff-list region-num
)
883 (setq current-diff
(1+ current-diff
)
884 list-element
(car diff-list
)
885 begin
(aref list-element
(cond ((eq buf-type
'A
) 0)
888 end
(aref list-element
(cond ((eq buf-type
'A
) 1)
891 (if (not (or begin end
))
893 ;; Put overlays at appropriate places in buffers
894 ;; convert lines to points, if necessary
895 (setq begin
(ediff-goto-word (1+ begin
) buff
)
896 end
(ediff-goto-word end buff
'end
))
897 (setq overlay
(ediff-make-bullet-proof-overlay begin end buff
))
898 ;; record all overlays for this difference region
899 (setq diff-overlay-list
(nconc diff-overlay-list
(list overlay
))))
901 (setq diff-list
(cdr diff-list
))
903 ;; convert the list of difference information into a vector
905 (ediff-set-fine-diff-vector
906 region-num buf-type
(vconcat diff-overlay-list
))
910 (defsubst ediff-convert-fine-diffs-to-overlays
(diff-list region-num
)
911 (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num
)
912 (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num
)
914 (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num
)
918 ;; Stolen from emerge.el
919 (defun ediff-get-diff3-group (file)
920 ;; This save-excursion allows ediff-get-diff3-group to be called for the
921 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
922 ;; appear in any order. The reason this is necessary is that Gnu diff3
923 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
926 (concat "^" file
":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)\C-m?$"))
927 (beginning-of-line 2)
928 ;; treatment depends on whether it is an "a" group or a "c" group
929 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
931 (if (match-beginning 2)
932 ;; it has two numbers
934 (buffer-substring (match-beginning 1) (match-end 1)))
936 (buffer-substring (match-beginning 3) (match-end 3)))))
938 (let ((x (string-to-int
939 (buffer-substring (match-beginning 1) (match-end 1)))))
941 ;; it is an "a" group
942 (let ((x (1+ (string-to-int
943 (buffer-substring (match-beginning 1) (match-end 1))))))
947 ;; If WORD-MODE, construct vector of diffs using word numbers.
948 ;; Else, use point values.
949 ;; WORD-MODE also tells if we are in the word-mode or not.
950 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
951 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
952 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
954 ;; BOUNDS specifies visibility bounds to use.
955 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
957 (let ((A-buffer ediff-buffer-A
)
958 (B-buffer ediff-buffer-B
)
959 (C-buffer ediff-buffer-C
)
960 (anc-buffer ediff-ancestor-buffer
)
961 (a-prev 1) ; needed to set the first diff line correctly
965 diff-list shift-A shift-B shift-C
968 ;; diff list contains word numbers or points, depending on word-mode
969 (setq diff-list
(cons (if word-mode
'words
'points
)
974 (ediff-get-value-according-to-buffer-type 'A bounds
))
977 (ediff-get-value-according-to-buffer-type 'B bounds
))
981 (ediff-get-value-according-to-buffer-type 'C bounds
)))))
983 ;; reset point in buffers A, B, C
984 (ediff-with-current-buffer A-buffer
985 (goto-char (if shift-A shift-A
(point-min))))
986 (ediff-with-current-buffer B-buffer
987 (goto-char (if shift-B shift-B
(point-min))))
989 (ediff-with-current-buffer C-buffer
990 (goto-char (if shift-C shift-C
(point-min)))))
991 (if (ediff-buffer-live-p anc-buffer
)
992 (ediff-with-current-buffer anc-buffer
993 (goto-char (point-min))))
995 (ediff-with-current-buffer diff-buffer
996 (goto-char (point-min))
997 (while (re-search-forward ediff-match-diff3-line nil t
)
998 ;; leave point after matched line
999 (beginning-of-line 2)
1000 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
1001 ;; if the files A and B are the same and not 3way-comparison,
1002 ;; ignore the difference
1003 (if (or three-way-comp
(not (string-equal agreement
"3")))
1004 (let* ((a-begin (car (ediff-get-diff3-group "1")))
1005 (a-end (nth 1 (ediff-get-diff3-group "1")))
1006 (b-begin (car (ediff-get-diff3-group "2")))
1007 (b-end (nth 1 (ediff-get-diff3-group "2")))
1008 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
1009 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
1011 (cond ((string-equal agreement
"1") 'prefer-A
)
1012 ((string-equal agreement
"2") 'prefer-B
)
1013 (t ediff-default-variant
)))
1014 (state-of-diff-merge
1015 (if (memq state-of-merge
'(default-A prefer-A
)) 'B
'A
))
1016 (state-of-diff-comparison
1017 (cond ((string-equal agreement
"1") 'A
)
1018 ((string-equal agreement
"2") 'B
)
1019 ((string-equal agreement
"3") 'C
)))
1025 anc-begin-pt anc-end-pt
)
1027 (setq state-of-ancestor
1028 (= c-or-anc-begin c-or-anc-end
))
1030 (cond (three-way-comp
1031 (setq c-begin c-or-anc-begin
1032 c-end c-or-anc-end
))
1033 ((eq ediff-default-variant
'default-B
)
1034 (setq c-begin b-begin
1037 (setq c-begin a-begin
1040 ;; compute main diff vector
1042 ;; make diff-list contain word numbers
1046 (- a-begin a-prev
) (- a-end a-begin
)
1047 (- b-begin b-prev
) (- b-end b-begin
)
1048 (- c-begin c-prev
) (- c-end c-begin
)
1049 nil nil
; dummy ancestor
1051 nil
; state of merge
1052 nil
; state of ancestor
1057 ;; else convert lines to points
1058 (ediff-with-current-buffer A-buffer
1059 (forward-line (- a-begin a-prev
))
1060 (setq a-begin-pt
(point))
1061 (forward-line (- a-end a-begin
))
1062 (setq a-end-pt
(point)
1064 (ediff-with-current-buffer B-buffer
1065 (forward-line (- b-begin b-prev
))
1066 (setq b-begin-pt
(point))
1067 (forward-line (- b-end b-begin
))
1068 (setq b-end-pt
(point)
1070 (ediff-with-current-buffer C-buffer
1071 (forward-line (- c-begin c-prev
))
1072 (setq c-begin-pt
(point))
1073 (forward-line (- c-end c-begin
))
1074 (setq c-end-pt
(point)
1076 (if (ediff-buffer-live-p anc-buffer
)
1077 (ediff-with-current-buffer anc-buffer
1078 (forward-line (- c-or-anc-begin anc-prev
))
1079 (setq anc-begin-pt
(point))
1080 (forward-line (- c-or-anc-end c-or-anc-begin
))
1081 (setq anc-end-pt
(point)
1082 anc-prev c-or-anc-end
)))
1086 ;; if comparing with ancestor, then there also is a
1087 ;; state-of-difference marker
1093 nil nil
; ancestor begin/end
1094 state-of-diff-comparison
1095 nil
; state of merge
1096 nil
; state of ancestor
1098 (list (vector a-begin-pt a-end-pt
1101 anc-begin-pt anc-end-pt
1109 ))) ; end ediff-with-current-buffer
1113 ;; Generate the difference vector and overlays for three files
1114 ;; File-C is either the third file to compare (in case of 3-way comparison)
1115 ;; or it is the ancestor file.
1116 (defun ediff-setup-diff-regions3 (file-A file-B file-C
)
1117 (or (ediff-buffer-live-p ediff-diff-buffer
)
1118 (setq ediff-diff-buffer
1119 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1121 (message "Computing differences ...")
1122 (ediff-exec-process ediff-diff3-program ediff-diff-buffer
'synchronize
1123 ediff-diff3-options file-A file-B file-C
)
1125 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer
)
1126 ;;(message "Computing differences ... done")
1127 (ediff-convert-diffs-to-overlays
1128 (ediff-extract-diffs3
1130 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds
)
1134 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1135 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1136 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1137 ;; string. All elements in FILES must be strings. We also delete nil from
1139 (defun ediff-exec-process (program buffer synch options
&rest files
)
1140 (let ((data (match-data))
1141 (coding-system-for-read ediff-coding-system-for-read
)
1143 (setq args
(append (split-string options
) files
))
1144 (setq args
(delete "" (delq nil args
))) ; delete nil and "" from arguments
1145 ;; the --binary option, if present, should be used only for buffer jobs
1146 ;; or for refining the differences
1147 (or (string-match "buffer" (symbol-name ediff-job-name
))
1148 (eq buffer ediff-fine-diff-buffer
)
1149 (setq args
(delete "--binary" args
)))
1151 (let ((directory default-directory
)
1156 (setq default-directory directory
)
1157 (if (or (memq system-type
'(emx ms-dos windows-nt windows-95
))
1159 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1160 ;; delete files used by other processes. Thus, in ediff-buffers
1161 ;; and similar functions, we can't delete temp files because
1162 ;; they might be used by the asynch process that computes
1163 ;; custom diffs. So, we have to wait till custom diff
1164 ;; subprocess is done.
1165 ;; Similarly for Windows-*
1166 ;; In DOS, must synchronize because DOS doesn't have
1167 ;; asynchronous processes.
1168 (apply 'call-process program nil buffer nil args
)
1169 ;; On other systems, do it asynchronously.
1170 (setq proc
(get-buffer-process buffer
))
1171 (if proc
(kill-process proc
))
1173 (apply 'start-process
"Custom Diff" buffer program args
))
1174 (setq mode-line-process
'(":%s"))
1175 (set-process-sentinel proc
'ediff-process-sentinel
)
1176 (set-process-filter proc
'ediff-process-filter
)
1178 (store-match-data data
))))
1180 ;; This is shell-command-filter from simple.el in Emacs.
1181 ;; Copied here because XEmacs doesn't have it.
1182 (defun ediff-process-filter (proc string
)
1183 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1184 ;; despite an insertion immediately after it.
1185 (let* ((obuf (current-buffer))
1186 (buffer (process-buffer proc
))
1188 (window (get-buffer-window buffer
))
1189 (pos (window-start window
)))
1193 (or (= (point) (point-max))
1194 (setq opoint
(point)))
1195 (goto-char (point-max))
1196 (insert-before-markers string
))
1197 ;; insert-before-markers moved this marker: set it back.
1198 (set-window-start window pos
)
1199 ;; Finish our save-excursion.
1202 (set-buffer obuf
))))
1204 ;; like shell-command-sentinel but doesn't print an exit status message
1205 ;; we do this because diff always exits with status 1, if diffs are found
1206 ;; so shell-command-sentinel displays a confusing message to the user
1207 (defun ediff-process-sentinel (process signal
)
1208 (if (and (memq (process-status process
) '(exit signal
))
1209 (buffer-name (process-buffer process
)))
1212 (set-buffer (process-buffer process
))
1213 (setq mode-line-process nil
))
1214 (delete-process process
))))
1217 ;;; Word functions used to refine the current diff
1219 (defvar ediff-forward-word-function
'ediff-forward-word
1220 "*Function to call to move to the next word.
1221 Used for splitting difference regions into individual words.")
1222 (make-variable-buffer-local 'ediff-forward-word-function
)
1224 (defvar ediff-whitespace
" \n\t\f"
1225 "*Characters constituting white space.
1226 These characters are ignored when differing regions are split into words.")
1227 (make-variable-buffer-local 'ediff-whitespace
)
1229 (defvar ediff-word-1
1230 (ediff-cond-compile-for-xemacs-or-emacs "a-zA-Z---_" "-[:word:]_")
1231 "*Characters that constitute words of type 1.
1232 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1233 See `ediff-forward-word' for more details.")
1234 (make-variable-buffer-local 'ediff-word-1
)
1236 (defvar ediff-word-2
"0-9.,"
1237 "*Characters that constitute words of type 2.
1238 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1239 See `ediff-forward-word' for more details.")
1240 (make-variable-buffer-local 'ediff-word-2
)
1242 (defvar ediff-word-3
"`'?!:;\"{}[]()"
1243 "*Characters that constitute words of type 3.
1244 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1245 See `ediff-forward-word' for more details.")
1246 (make-variable-buffer-local 'ediff-word-3
)
1248 (defvar ediff-word-4
1249 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace
)
1250 "*Characters that constitute words of type 4.
1251 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1252 See `ediff-forward-word' for more details.")
1253 (make-variable-buffer-local 'ediff-word-4
)
1255 ;; Split region along word boundaries. Each word will be on its own line.
1256 ;; Output to buffer out-buffer.
1257 (defun ediff-forward-word ()
1258 "Move point one word forward.
1259 There are four types of words, each of which consists entirely of
1260 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1261 `ediff-word-4'. Words are recognized by passing these one after another as
1262 arguments to `skip-chars-forward'."
1263 (or (> (+ (skip-chars-forward ediff-word-1
)
1264 (skip-syntax-forward "w"))
1266 (> (skip-chars-forward ediff-word-2
) 0)
1267 (> (skip-chars-forward ediff-word-3
) 0)
1268 (> (skip-chars-forward ediff-word-4
) 0)
1272 (defun ediff-wordify (beg end in-buffer out-buffer
&optional control-buf
)
1273 (let ((forward-word-function
1274 ;; eval in control buf to let user create local versions for
1275 ;; different invocations
1277 (ediff-with-current-buffer control-buf
1278 ediff-forward-word-function
)
1279 ediff-forward-word-function
))
1280 inbuf-syntax-tbl sv-point diff-string
)
1282 (set-buffer in-buffer
)
1283 (setq inbuf-syntax-tbl
1285 (ediff-with-current-buffer control-buf
1288 (setq diff-string
(buffer-substring-no-properties beg end
))
1290 (set-buffer out-buffer
)
1291 ;; Make sure that temp buff syntax table is the same as the original buf
1292 ;; syntax tbl, because we use ediff-forward-word in both and
1293 ;; ediff-forward-word depends on the syntax classes of characters.
1294 (set-syntax-table inbuf-syntax-tbl
)
1296 (insert diff-string
)
1297 (goto-char (point-min))
1298 (skip-chars-forward ediff-whitespace
)
1299 (delete-region (point-min) (point))
1302 (funcall forward-word-function
)
1303 (setq sv-point
(point))
1304 (skip-chars-forward ediff-whitespace
)
1305 (delete-region sv-point
(point))
1308 ;; copy string specified as BEG END from IN-BUF to OUT-BUF
1309 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer
)
1310 (with-current-buffer out-buffer
1312 (insert-buffer-substring in-buffer beg end
)
1313 (goto-char (point-min))))
1316 ;; goto word #n starting at current position in buffer `buf'
1317 ;; For ediff, a word is determined by ediff-forward-word-function
1318 ;; If `flag' is non-nil, goto the end of the n-th word.
1319 (defun ediff-goto-word (n buf
&optional flag
)
1320 ;; remember val ediff-forward-word-function has in ctl buf
1321 (let ((fwd-word-fun ediff-forward-word-function
)
1322 (syntax-tbl ediff-syntax-table
))
1323 (ediff-with-current-buffer buf
1324 (skip-chars-forward ediff-whitespace
)
1325 (ediff-with-syntax-table syntax-tbl
1327 (funcall fwd-word-fun
)
1328 (skip-chars-forward ediff-whitespace
)
1330 (if (and flag
(> n
0))
1331 (funcall fwd-word-fun
))
1334 (defun ediff-same-file-contents (f1 f2
)
1335 "Return t if F1 and F2 have identical contents."
1337 (apply 'call-process ediff-cmp-program nil nil nil
1338 (append ediff-cmp-options
(list f1 f2
)))))
1339 (and (numberp res
) (eq res
0))))
1342 ;;; Local Variables:
1343 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1344 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1345 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1349 ;;; ediff-diff.el ends here