Fix interaction of load-theme with cust-theme.el.
[emacs.git] / lisp / vc / ediff-diff.el
blob37b7fce6f327e8b00bbbb7ba73342246190c0b00
1 ;;; ediff-diff.el --- diff-related utilities
3 ;; Copyright (C) 1994-2012 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
6 ;; Package: ediff
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
28 (provide 'ediff-diff)
30 (eval-when-compile
31 (require 'ediff-util))
33 (require 'ediff-init)
35 (defgroup ediff-diff nil
36 "Diff related utilities."
37 :prefix "ediff-"
38 :group 'ediff)
40 (defcustom ediff-diff-program "diff"
41 "Program to use for generating the differential of the two files."
42 :type 'string
43 :group 'ediff-diff)
44 (defcustom ediff-diff3-program "diff3"
45 "Program to be used for three-way comparison.
46 Must produce output compatible with Unix's diff3 program."
47 :type 'string
48 :group 'ediff-diff)
51 ;; The following functions must precede all defcustom-defined variables.
53 (fset 'ediff-set-actual-diff-options (lambda () nil))
55 (defcustom ediff-shell
56 (cond ((memq system-type '(ms-dos windows-nt))
57 shell-file-name) ; no standard name on MS-DOS
58 (t "sh")) ; UNIX
59 "The shell used to run diff and patch.
60 If user's .profile or .cshrc files are set up correctly, any shell
61 will do. However, some people set $prompt or other things
62 incorrectly, which leads to undesirable output messages. These may
63 cause Ediff to fail. In such a case, set `ediff-shell' to a shell that
64 you are not using or, better, fix your shell's startup file."
65 :type 'string
66 :group 'ediff-diff)
68 (defcustom ediff-cmp-program "cmp"
69 "Utility to use to determine if two files are identical.
70 It must return code 0, if its arguments are identical files."
71 :type 'string
72 :group 'ediff-diff)
74 (defcustom ediff-cmp-options nil
75 "Options to pass to `ediff-cmp-program'.
76 If GNU diff is used as `ediff-cmp-program', then the most useful options
77 are `-I REGEXP', to ignore changes whose lines match the REGEXP."
78 :type '(repeat string)
79 :group 'ediff-diff)
81 (defun ediff-set-diff-options (symbol value)
82 (set symbol value)
83 (ediff-set-actual-diff-options))
85 (defcustom ediff-diff-options
86 (if (memq system-type '(ms-dos windows-nt)) "--binary" "")
87 "Options to pass to `ediff-diff-program'.
88 If Unix diff is used as `ediff-diff-program',
89 then a useful option is `-w', to ignore space.
90 Options `-c', `-u', and `-i' are not allowed. Case sensitivity can be
91 toggled interactively using \\[ediff-toggle-ignore-case].
93 Do not remove the default options. If you need to change this variable, add new
94 options after the default ones.
96 This variable is not for customizing the look of the differences produced by
97 the command \\[ediff-show-diff-output]. Use the variable
98 `ediff-custom-diff-options' for that."
99 :set 'ediff-set-diff-options
100 :type 'string
101 :group 'ediff-diff)
103 (ediff-defvar-local ediff-ignore-case nil
104 "*If t, skip over difference regions that differ only in letter case.
105 This variable can be set either in .emacs or toggled interactively.
106 Use `setq-default' if setting it in .emacs")
108 (defcustom ediff-ignore-case-option "-i"
109 "Option that causes the diff program to ignore case of letters."
110 :type 'string
111 :group 'ediff-diff)
113 (defcustom ediff-ignore-case-option3 ""
114 "Option that causes the diff3 program to ignore case of letters.
115 GNU diff3 doesn't have such an option."
116 :type 'string
117 :group 'ediff-diff)
119 ;; the actual options used in comparison
120 (ediff-defvar-local ediff-actual-diff-options ediff-diff-options "")
122 (defcustom ediff-custom-diff-program ediff-diff-program
123 "Program to use for generating custom diff output for saving it in a file.
124 This output is not used by Ediff internally."
125 :type 'string
126 :group 'ediff-diff)
127 (defcustom ediff-custom-diff-options "-c"
128 "Options to pass to `ediff-custom-diff-program'."
129 :type 'string
130 :group 'ediff-diff)
132 ;;; Support for diff3
134 (defvar ediff-match-diff3-line "^====\\(.?\\)\C-m?$"
135 "Pattern to match lines produced by diff3 that describe differences.")
136 (defcustom ediff-diff3-options ""
137 "Options to pass to `ediff-diff3-program'."
138 :set 'ediff-set-diff-options
139 :type 'string
140 :group 'ediff-diff)
142 ;; the actual options used in comparison
143 (ediff-defvar-local ediff-actual-diff3-options ediff-diff3-options "")
145 (defcustom ediff-diff3-ok-lines-regexp
146 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
147 "Regexp that matches normal output lines from `ediff-diff3-program'.
148 Lines that do not match are assumed to be error messages."
149 :type 'regexp
150 :group 'ediff-diff)
152 ;; keeps the status of the current diff in 3-way jobs.
153 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
154 (ediff-defvar-local ediff-diff-status "" "")
157 ;;; Fine differences
159 (ediff-defvar-local ediff-auto-refine (if (ediff-has-face-support-p) 'on 'nix)
160 "If `on', Ediff auto-highlights fine diffs for the current diff region.
161 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
162 at all, unless the user force-refines the region by hitting `*'.
164 This variable can be set either in .emacs or toggled interactively.
165 Use `setq-default' if setting it in .emacs")
167 (ediff-defvar-local ediff-ignore-similar-regions nil
168 "*If t, skip over difference regions that differ only in the white space and line breaks.
169 This variable can be set either in .emacs or toggled interactively.
170 Use `setq-default' if setting it in .emacs")
172 (ediff-defvar-local ediff-auto-refine-limit 14000
173 "*Auto-refine only the regions of this size \(in bytes\) or less.")
175 ;;; General
177 (defvar ediff-diff-ok-lines-regexp
178 (concat
179 "^\\("
180 "[0-9,]+[acd][0-9,]+\C-m?$"
181 "\\|[<>] "
182 "\\|---"
183 "\\|.*Warning *:"
184 "\\|.*No +newline"
185 "\\|.*missing +newline"
186 "\\|^\C-m?$"
187 "\\)")
188 "Regexp that matches normal output lines from `ediff-diff-program'.
189 This is mostly lifted from Emerge, except that Ediff also considers
190 warnings and `Missing newline'-type messages to be normal output.
191 Lines that do not match are assumed to be error messages.")
193 (defvar ediff-match-diff-line
194 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
195 (concat "^" x "\\([acd]\\)" x "\C-m?$"))
196 "Pattern to match lines produced by diff that describe differences.")
198 (ediff-defvar-local ediff-setup-diff-regions-function nil
199 "value is a function symbol depending on the kind of job is to be done.
200 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
201 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
203 The function should take three mandatory arguments, file-A, file-B, and
204 file-C. It may ignore file C for diff2 jobs. It should also take
205 one optional arguments, diff-number to refine.")
208 ;;; Functions
210 ;; Generate the difference vector and overlays for the two files
211 ;; With optional arg REG-TO-REFINE, refine this region.
212 ;; File-C argument is not used here. It is there just because
213 ;; ediff-setup-diff-regions is called via a funcall to
214 ;; ediff-setup-diff-regions-function, which can also have the value
215 ;; ediff-setup-diff-regions3, which takes 4 arguments.
216 (defun ediff-setup-diff-regions (file-A file-B file-C)
217 ;; looking for '-c', '-i', '-u', or 'c', 'i', 'u' among clustered non-long options
218 (if (string-match "^-[ciu]\\| -[ciu]\\|\\(^\\| \\)-[^- ]+[ciu]"
219 ediff-diff-options)
220 (error "Options `-c', `-u', and `-i' are not allowed in `ediff-diff-options'"))
222 ;; create, if it doesn't exist
223 (or (ediff-buffer-live-p ediff-diff-buffer)
224 (setq ediff-diff-buffer
225 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
226 (ediff-make-diff2-buffer ediff-diff-buffer file-A file-B)
227 (ediff-prepare-error-list ediff-diff-ok-lines-regexp ediff-diff-buffer)
228 (ediff-convert-diffs-to-overlays
229 (ediff-extract-diffs
230 ediff-diff-buffer ediff-word-mode ediff-narrow-bounds)))
232 ;; Run the diff program on FILE1 and FILE2 and put the output in DIFF-BUFFER
233 ;; Return the size of DIFF-BUFFER
234 ;; The return code isn't used in the program at present.
235 (defun ediff-make-diff2-buffer (diff-buffer file1 file2)
236 (let ((file1-size (ediff-file-size file1))
237 (file2-size (ediff-file-size file2)))
238 (cond ((not (numberp file1-size))
239 (message "Can't find file: %s"
240 (ediff-abbreviate-file-name file1))
241 (sit-for 2)
242 ;; 1 is an error exit code
244 ((not (numberp file2-size))
245 (message "Can't find file: %s"
246 (ediff-abbreviate-file-name file2))
247 (sit-for 2)
248 ;; 1 is an error exit code
250 (t (message "Computing differences between %s and %s ..."
251 (file-name-nondirectory file1)
252 (file-name-nondirectory file2))
253 ;; this erases the diff buffer automatically
254 (ediff-exec-process ediff-diff-program
255 diff-buffer
256 'synchronize
257 ediff-actual-diff-options file1 file2)
258 (message "")
259 (ediff-with-current-buffer diff-buffer
260 (buffer-size))))))
264 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
265 ;; This function works for diff3 and diff2 jobs
266 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num)
267 (or (ediff-buffer-live-p ediff-fine-diff-buffer)
268 (setq ediff-fine-diff-buffer
269 (get-buffer-create
270 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
272 (let (diff3-job diff-program diff-options ok-regexp diff-list)
273 (setq diff3-job ediff-3way-job
274 diff-program (if diff3-job ediff-diff3-program ediff-diff-program)
275 diff-options (if diff3-job
276 ediff-actual-diff3-options
277 ediff-actual-diff-options)
278 ok-regexp (if diff3-job
279 ediff-diff3-ok-lines-regexp
280 ediff-diff-ok-lines-regexp))
282 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num))
283 (ediff-exec-process diff-program ediff-fine-diff-buffer 'synchronize
284 diff-options
285 ;; The shuffle below is because we can compare 3-way
286 ;; or in several 2-way fashions, like fA fC, fA fB,
287 ;; or fB fC.
288 (if file-A file-A file-B)
289 (if file-B file-B file-A)
290 (if diff3-job
291 (if file-C file-C file-B))
292 ) ; exec process
294 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer)
295 (ediff-message-if-verbose
297 ;; "Refining difference region %d ... done" (1+ reg-num))
299 (setq diff-list
300 (if diff3-job
301 (ediff-extract-diffs3
302 ediff-fine-diff-buffer '3way-comparison 'word-mode)
303 (ediff-extract-diffs ediff-fine-diff-buffer 'word-mode)))
304 ;; fixup diff-list
305 (if diff3-job
306 (cond ((not file-A)
307 (mapc (lambda (elt)
308 (aset elt 0 nil)
309 (aset elt 1 nil))
310 (cdr diff-list)))
311 ((not file-B)
312 (mapc (lambda (elt)
313 (aset elt 2 nil)
314 (aset elt 3 nil))
315 (cdr diff-list)))
316 ((not file-C)
317 (mapc (lambda (elt)
318 (aset elt 4 nil)
319 (aset elt 5 nil))
320 (cdr diff-list)))
323 (ediff-convert-fine-diffs-to-overlays diff-list reg-num)
327 (defun ediff-prepare-error-list (ok-regexp diff-buff)
328 (or (ediff-buffer-live-p ediff-error-buffer)
329 (setq ediff-error-buffer
330 (get-buffer-create (ediff-unique-buffer-name
331 "*ediff-errors" "*"))))
332 (ediff-with-current-buffer ediff-error-buffer
333 (setq buffer-undo-list t)
334 (erase-buffer)
335 (insert (ediff-with-current-buffer diff-buff (buffer-string)))
336 (goto-char (point-min))
337 (delete-matching-lines ok-regexp))
338 ;; If diff reports errors, show them then quit.
339 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer (buffer-size)))
340 (let ((ctl-buf ediff-control-buffer)
341 (error-buf ediff-error-buffer))
342 (ediff-skip-unsuitable-frames)
343 (switch-to-buffer error-buf)
344 (ediff-kill-buffer-carefully ctl-buf)
345 (error "Errors in diff output. Diff output is in %S" diff-buff))))
347 ;; BOUNDS specifies visibility bounds to use.
348 ;; WORD-MODE tells whether we are in the word-mode or not.
349 ;; If WORD-MODE, also construct vector of diffs using word numbers.
350 ;; Else, use point values.
351 ;; This function handles diff-2 jobs including the case of
352 ;; merging buffers and files without ancestor.
353 (defun ediff-extract-diffs (diff-buffer word-mode &optional bounds)
354 (let ((A-buffer ediff-buffer-A)
355 (B-buffer ediff-buffer-B)
356 (C-buffer ediff-buffer-C)
357 (a-prev 1) ; this is needed to set the first diff line correctly
358 (a-prev-pt nil)
359 (b-prev 1)
360 (b-prev-pt nil)
361 (c-prev 1)
362 (c-prev-pt nil)
363 diff-list shift-A shift-B
366 ;; diff list contains word numbers, unless changed later
367 (setq diff-list (cons (if word-mode 'words 'points)
368 diff-list))
369 ;; we don't use visibility bounds for buffer C when merging
370 (if bounds
371 (setq shift-A
372 (ediff-overlay-start
373 (ediff-get-value-according-to-buffer-type 'A bounds))
374 shift-B
375 (ediff-overlay-start
376 (ediff-get-value-according-to-buffer-type 'B bounds))))
378 ;; reset point in buffers A/B/C
379 (ediff-with-current-buffer A-buffer
380 (goto-char (if shift-A shift-A (point-min))))
381 (ediff-with-current-buffer B-buffer
382 (goto-char (if shift-B shift-B (point-min))))
383 (if (ediff-buffer-live-p C-buffer)
384 (ediff-with-current-buffer C-buffer
385 (goto-char (point-min))))
387 (ediff-with-current-buffer diff-buffer
388 (goto-char (point-min))
389 (while (re-search-forward ediff-match-diff-line nil t)
390 (let* ((a-begin (string-to-number (buffer-substring (match-beginning 1)
391 (match-end 1))))
392 (a-end (let ((b (match-beginning 3))
393 (e (match-end 3)))
394 (if b
395 (string-to-number (buffer-substring b e))
396 a-begin)))
397 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
398 (b-begin (string-to-number (buffer-substring (match-beginning 5)
399 (match-end 5))))
400 (b-end (let ((b (match-beginning 7))
401 (e (match-end 7)))
402 (if b
403 (string-to-number (buffer-substring b e))
404 b-begin)))
405 a-begin-pt a-end-pt b-begin-pt b-end-pt
406 c-begin c-end c-begin-pt c-end-pt)
407 ;; fix the beginning and end numbers, because diff is somewhat
408 ;; strange about how it numbers lines
409 (if (string-equal diff-type "a")
410 (setq b-end (1+ b-end)
411 a-begin (1+ a-begin)
412 a-end a-begin)
413 (if (string-equal diff-type "d")
414 (setq a-end (1+ a-end)
415 b-begin (1+ b-begin)
416 b-end b-begin)
417 ;; (string-equal diff-type "c")
418 (setq a-end (1+ a-end)
419 b-end (1+ b-end))))
421 (if (eq ediff-default-variant 'default-B)
422 (setq c-begin b-begin
423 c-end b-end)
424 (setq c-begin a-begin
425 c-end a-end))
427 ;; compute main diff vector
428 (if word-mode
429 ;; make diff-list contain word numbers
430 (setq diff-list
431 (nconc diff-list
432 (list
433 (if (ediff-buffer-live-p C-buffer)
434 (vector (- a-begin a-prev) (- a-end a-begin)
435 (- b-begin b-prev) (- b-end b-begin)
436 (- c-begin c-prev) (- c-end c-begin)
437 nil nil ; dummy ancestor
438 nil ; state of diff
439 nil ; state of merge
440 nil ; state of ancestor
442 (vector (- a-begin a-prev) (- a-end a-begin)
443 (- b-begin b-prev) (- b-end b-begin)
444 nil nil ; dummy buf C
445 nil nil ; dummy ancestor
446 nil ; state of diff
447 nil ; state of merge
448 nil ; state of ancestor
451 a-prev a-end
452 b-prev b-end
453 c-prev c-end)
454 ;; else convert lines to points
455 (ediff-with-current-buffer A-buffer
456 (let ((longlines-mode-val
457 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
458 ;; we must disable and then restore longlines-mode
459 (if (eq longlines-mode-val 1)
460 (longlines-mode 0))
461 (goto-char (or a-prev-pt shift-A (point-min)))
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)
466 a-prev a-end
467 a-prev-pt a-end-pt)
468 (if (eq longlines-mode-val 1)
469 (longlines-mode longlines-mode-val))
471 (ediff-with-current-buffer B-buffer
472 (let ((longlines-mode-val
473 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
474 (if (eq longlines-mode-val 1)
475 (longlines-mode 0))
476 (goto-char (or b-prev-pt shift-B (point-min)))
477 (forward-line (- b-begin b-prev))
478 (setq b-begin-pt (point))
479 (forward-line (- b-end b-begin))
480 (setq b-end-pt (point)
481 b-prev b-end
482 b-prev-pt b-end-pt)
483 (if (eq longlines-mode-val 1)
484 (longlines-mode longlines-mode-val))
486 (if (ediff-buffer-live-p C-buffer)
487 (ediff-with-current-buffer C-buffer
488 (let ((longlines-mode-val
489 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
490 (if (eq longlines-mode-val 1)
491 (longlines-mode 0))
492 (goto-char (or c-prev-pt (point-min)))
493 (forward-line (- c-begin c-prev))
494 (setq c-begin-pt (point))
495 (forward-line (- c-end c-begin))
496 (setq c-end-pt (point)
497 c-prev c-end
498 c-prev-pt c-end-pt)
499 (if (eq longlines-mode-val 1)
500 (longlines-mode longlines-mode-val))
502 (setq diff-list
503 (nconc
504 diff-list
505 (list
506 (if (ediff-buffer-live-p C-buffer)
507 (vector
508 a-begin-pt a-end-pt b-begin-pt b-end-pt
509 c-begin-pt c-end-pt
510 nil nil ; dummy ancestor
511 ;; state of diff
512 ;; shows which buff is different from the other two
513 (if (eq ediff-default-variant 'default-B) 'A 'B)
514 ediff-default-variant ; state of merge
515 nil ; state of ancestor
517 (vector a-begin-pt a-end-pt
518 b-begin-pt b-end-pt
519 nil nil ; dummy buf C
520 nil nil ; dummy ancestor
521 nil nil ; dummy state of diff & merge
522 nil ; dummy state of ancestor
526 ))) ; end ediff-with-current-buffer
527 diff-list
531 (defun ediff-convert-diffs-to-overlays (diff-list)
532 (ediff-set-diff-overlays-in-one-buffer 'A diff-list)
533 (ediff-set-diff-overlays-in-one-buffer 'B diff-list)
534 (if ediff-3way-job
535 (ediff-set-diff-overlays-in-one-buffer 'C diff-list))
536 (if ediff-merge-with-ancestor-job
537 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list))
538 ;; set up vector showing the status of merge regions
539 (if ediff-merge-job
540 (setq ediff-state-of-merge
541 (vconcat
542 (mapcar (lambda (elt)
543 (let ((state-of-merge (aref elt 9))
544 (state-of-ancestor (aref elt 10)))
545 (vector
546 ;; state of merge: prefers/default-A/B or combined
547 (if state-of-merge (format "%S" state-of-merge))
548 ;; whether the ancestor region is empty
549 state-of-ancestor)))
550 ;; the first elt designates type of list
551 (cdr diff-list))
553 (message "Processing difference regions ... done"))
556 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list)
557 (let* ((current-diff -1)
558 (buff (ediff-get-buffer buf-type))
559 (ctl-buf ediff-control-buffer)
560 ;; ediff-extract-diffs puts the type of diff-list as the first elt
561 ;; of this list. The type is either 'points or 'words
562 (diff-list-type (car diff-list))
563 (shift (ediff-overlay-start
564 (ediff-get-value-according-to-buffer-type
565 buf-type ediff-narrow-bounds)))
566 (limit (ediff-overlay-end
567 (ediff-get-value-according-to-buffer-type
568 buf-type ediff-narrow-bounds)))
569 diff-overlay-list list-element total-diffs
570 begin end pt-saved overlay state-of-diff)
572 (setq diff-list (cdr diff-list)) ; discard diff list type
573 (setq total-diffs (length diff-list))
575 ;; shift, if necessary
576 (ediff-with-current-buffer buff (setq pt-saved shift))
578 (while diff-list
579 (setq current-diff (1+ current-diff)
580 list-element (car diff-list)
581 begin (aref list-element (cond ((eq buf-type 'A) 0)
582 ((eq buf-type 'B) 2)
583 ((eq buf-type 'C) 4)
584 (t 6))) ; Ancestor
585 end (aref list-element (cond ((eq buf-type 'A) 1)
586 ((eq buf-type 'B) 3)
587 ((eq buf-type 'C) 5)
588 (t 7))) ; Ancestor
589 state-of-diff (aref list-element 8)
592 (cond ((and (not (eq buf-type state-of-diff))
593 (not (eq buf-type 'Ancestor))
594 (memq state-of-diff '(A B C)))
595 (setq state-of-diff
596 (car (delq buf-type (delq state-of-diff (list 'A 'B 'C)))))
597 (setq state-of-diff (format "=diff(%S)" state-of-diff))
599 (t (setq state-of-diff nil)))
601 ;; Put overlays at appropriate places in buffer
602 ;; convert word numbers to points, if necessary
603 (if (eq diff-list-type 'words)
604 (progn
605 (ediff-with-current-buffer buff (goto-char pt-saved))
606 (ediff-with-current-buffer ctl-buf
607 (setq begin (ediff-goto-word (1+ begin) buff)
608 end (ediff-goto-word end buff 'end)))
609 (if (> end limit) (setq end limit))
610 (if (> begin end) (setq begin end))
611 (setq pt-saved (ediff-with-current-buffer buff (point)))))
612 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
614 (ediff-overlay-put overlay 'priority ediff-shadow-overlay-priority)
615 (ediff-overlay-put overlay 'ediff-diff-num current-diff)
616 (if (and (ediff-has-face-support-p)
617 ediff-use-faces ediff-highlight-all-diffs)
618 (ediff-set-overlay-face
619 overlay (ediff-background-face buf-type current-diff)))
621 (if (= 0 (mod current-diff 10))
622 (message "Buffer %S: Processing difference region %d of %d"
623 buf-type current-diff total-diffs))
624 ;; Record all overlays for this difference.
625 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
626 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
627 ;; The 4-th elt says which diff region is different from the other two
628 ;; (3-way jobs only).
629 (setq diff-overlay-list
630 (nconc
631 diff-overlay-list
632 (list (vector overlay nil nil state-of-diff)))
633 diff-list
634 (cdr diff-list))
635 ) ; while
637 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist)
638 (vconcat diff-overlay-list))
641 ;; `n' is the diff region to work on. Default is ediff-current-difference.
642 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
643 ;; diffs have not been computed before.
644 ;; if `flag' is 'skip then don't compute fine diffs for this region.
645 (defun ediff-make-fine-diffs (&optional n flag)
646 (or n (setq n ediff-current-difference))
648 (if (< ediff-number-of-differences 1)
649 (error ediff-NO-DIFFERENCES))
651 (if ediff-word-mode
652 (setq flag 'skip
653 ediff-auto-refine 'nix))
655 (or (< n 0)
656 (>= n ediff-number-of-differences)
657 ;; n is within the range
658 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
659 (file-A ediff-temp-file-A)
660 (file-B ediff-temp-file-B)
661 (file-C ediff-temp-file-C)
662 (empty-A (ediff-empty-diff-region-p n 'A))
663 (empty-B (ediff-empty-diff-region-p n 'B))
664 (empty-C (ediff-empty-diff-region-p n 'C))
665 (whitespace-A (ediff-whitespace-diff-region-p n 'A))
666 (whitespace-B (ediff-whitespace-diff-region-p n 'B))
667 (whitespace-C (ediff-whitespace-diff-region-p n 'C))
668 cumulative-fine-diff-length)
670 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
671 ;; then don't refine.
672 ;; If the region happens to be entirely whitespace or empty then
673 ;; mark as such.
674 ((> (length (delq nil (list empty-A empty-B empty-C))) 1)
675 (if (and (ediff-looks-like-combined-merge n)
676 ediff-merge-job)
677 (ediff-set-fine-overlays-in-one-buffer 'C nil n))
678 (if ediff-3way-comparison-job
679 (ediff-message-if-verbose
680 "Region %d is empty in all buffers but %S"
681 (1+ n)
682 (cond ((not empty-A) 'A)
683 ((not empty-B) 'B)
684 ((not empty-C) 'C)))
685 (ediff-message-if-verbose
686 "Region %d in buffer %S is empty"
687 (1+ n)
688 (cond (empty-A 'A)
689 (empty-B 'B)
690 (empty-C 'C)))
692 ;; if all regions happen to be whitespace
693 (if (and whitespace-A whitespace-B whitespace-C)
694 ;; mark as space only
695 (ediff-mark-diff-as-space-only n t)
696 ;; if some regions are white and others don't, then mark as
697 ;; non-white-space-only
698 (ediff-mark-diff-as-space-only n nil)))
700 ;; don't compute fine diffs if diff vector exists
701 ((and (eq flag 'noforce) (ediff-get-fine-diff-vector n 'A))
702 (if (ediff-no-fine-diffs-p n)
703 (message
704 "Only white-space differences in region %d %s"
705 (1+ n)
706 (cond ((eq (ediff-no-fine-diffs-p n) 'A)
707 "in buffers B & C")
708 ((eq (ediff-no-fine-diffs-p n) 'B)
709 "in buffers A & C")
710 ((eq (ediff-no-fine-diffs-p n) 'C)
711 "in buffers A & B")
712 (t "")))))
713 ;; don't compute fine diffs for this region
714 ((eq flag 'skip)
715 (or (ediff-get-fine-diff-vector n 'A)
716 (memq ediff-auto-refine '(off nix))
717 (ediff-message-if-verbose
718 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
719 (1+ n)
720 (substitute-command-keys
721 "\\[ediff-make-or-kill-fine-diffs]")
724 ;; recompute fine diffs
725 (ediff-wordify
726 (ediff-get-diff-posn 'A 'beg n)
727 (ediff-get-diff-posn 'A 'end n)
728 ediff-buffer-A
729 tmp-buffer
730 ediff-control-buffer)
731 (setq file-A
732 (ediff-make-temp-file tmp-buffer "fineDiffA" file-A))
734 (ediff-wordify
735 (ediff-get-diff-posn 'B 'beg n)
736 (ediff-get-diff-posn 'B 'end n)
737 ediff-buffer-B
738 tmp-buffer
739 ediff-control-buffer)
740 (setq file-B
741 (ediff-make-temp-file tmp-buffer "fineDiffB" file-B))
743 (if ediff-3way-job
744 (progn
745 (ediff-wordify
746 (ediff-get-diff-posn 'C 'beg n)
747 (ediff-get-diff-posn 'C 'end n)
748 ediff-buffer-C
749 tmp-buffer
750 ediff-control-buffer)
751 (setq file-C
752 (ediff-make-temp-file
753 tmp-buffer "fineDiffC" file-C))))
755 ;; save temp file names.
756 (setq ediff-temp-file-A file-A
757 ediff-temp-file-B file-B
758 ediff-temp-file-C file-C)
760 ;; set the new vector of fine diffs, if none exists
761 (cond ((and ediff-3way-job whitespace-A)
762 (ediff-setup-fine-diff-regions nil file-B file-C n))
763 ((and ediff-3way-job whitespace-B)
764 (ediff-setup-fine-diff-regions file-A nil file-C n))
765 ((and ediff-3way-job
766 ;; In merge-jobs, whitespace-C is t, since
767 ;; ediff-empty-diff-region-p returns t in this case
768 whitespace-C)
769 (ediff-setup-fine-diff-regions file-A file-B nil n))
771 (ediff-setup-fine-diff-regions file-A file-B file-C n)))
773 (setq cumulative-fine-diff-length
774 (+ (length (ediff-get-fine-diff-vector n 'A))
775 (length (ediff-get-fine-diff-vector n 'B))
776 ;; in merge jobs, the merge buffer is never refined
777 (if (and file-C (not ediff-merge-job))
778 (length (ediff-get-fine-diff-vector n 'C))
779 0)))
781 (cond ((or
782 ;; all regions are white space
783 (and whitespace-A whitespace-B whitespace-C)
784 ;; none is white space and no fine diffs detected
785 (and (not whitespace-A)
786 (not whitespace-B)
787 (not (and ediff-3way-job whitespace-C))
788 (eq cumulative-fine-diff-length 0)))
789 (ediff-mark-diff-as-space-only n t)
790 (ediff-message-if-verbose
791 "Only white-space differences in region %d" (1+ n)))
792 ((eq cumulative-fine-diff-length 0)
793 (ediff-message-if-verbose
794 "Only white-space differences in region %d %s"
795 (1+ n)
796 (cond (whitespace-A (ediff-mark-diff-as-space-only n 'A)
797 "in buffers B & C")
798 (whitespace-B (ediff-mark-diff-as-space-only n 'B)
799 "in buffers A & C")
800 (whitespace-C (ediff-mark-diff-as-space-only n 'C)
801 "in buffers A & B"))))
803 (ediff-mark-diff-as-space-only n nil)))
805 ) ; end cond
806 (ediff-set-fine-diff-properties n)
809 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
810 (defun ediff-install-fine-diff-if-necessary (n)
811 (cond ((and (eq ediff-auto-refine 'on)
812 ediff-use-faces
813 (not (eq ediff-highlighting-style 'off))
814 (not (eq ediff-highlighting-style 'ascii)))
815 (if (and
816 (> ediff-auto-refine-limit
817 (- (ediff-get-diff-posn 'A 'end n)
818 (ediff-get-diff-posn 'A 'beg n)))
819 (> ediff-auto-refine-limit
820 (- (ediff-get-diff-posn 'B 'end n)
821 (ediff-get-diff-posn 'B 'beg n))))
822 (ediff-make-fine-diffs n 'noforce)
823 (ediff-make-fine-diffs n 'skip)))
825 ;; highlight if fine diffs already exist
826 ((eq ediff-auto-refine 'off)
827 (ediff-make-fine-diffs n 'skip))))
830 ;; if fine diff vector is not set for diff N, then do nothing
831 (defun ediff-set-fine-diff-properties (n &optional default)
832 (or (not (ediff-has-face-support-p))
833 (< n 0)
834 (>= n ediff-number-of-differences)
835 ;; when faces are supported, set faces and priorities of fine overlays
836 (progn
837 (ediff-set-fine-diff-properties-in-one-buffer 'A n default)
838 (ediff-set-fine-diff-properties-in-one-buffer 'B n default)
839 (if ediff-3way-job
840 (ediff-set-fine-diff-properties-in-one-buffer 'C n default)))))
842 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
843 n &optional default)
844 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type))
845 (face (if default
846 'default
847 (ediff-get-symbol-from-alist
848 buf-type ediff-fine-diff-face-alist)
850 (priority (if default
852 (1+ (or (ediff-overlay-get
853 (symbol-value
854 (ediff-get-symbol-from-alist
855 buf-type
856 ediff-current-diff-overlay-alist))
857 'priority)
858 0)))))
859 (mapcar (lambda (overl)
860 (ediff-set-overlay-face overl face)
861 (ediff-overlay-put overl 'priority priority))
862 fine-diff-vector)))
864 ;; Set overlays over the regions that denote delimiters
865 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num)
866 (let (overlay overlay-list)
867 (while diff-list
868 (condition-case nil
869 (setq overlay
870 (ediff-make-bullet-proof-overlay
871 (nth 0 diff-list) (nth 1 diff-list) ediff-buffer-C))
872 (error ""))
873 (setq overlay-list (cons overlay overlay-list))
874 (if (> (length diff-list) 1)
875 (setq diff-list (cdr (cdr diff-list)))
876 (error "ediff-set-fine-overlays-for-combined-merge: corrupt list of
877 delimiter regions"))
879 (setq overlay-list (reverse overlay-list))
880 (ediff-set-fine-diff-vector
881 reg-num 'C (apply 'vector overlay-list))
885 ;; Convert diff list to overlays for a given DIFF-REGION
886 ;; in buffer of type BUF-TYPE
887 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num)
888 (let* ((current-diff -1)
889 (reg-start (ediff-get-diff-posn buf-type 'beg region-num))
890 (buff (ediff-get-buffer buf-type))
891 (ctl-buf ediff-control-buffer)
892 combined-merge-diff-list
893 diff-overlay-list list-element
894 begin end overlay)
896 (ediff-clear-fine-differences-in-one-buffer region-num buf-type)
897 (setq diff-list (cdr diff-list)) ; discard list type (words or points)
898 (ediff-with-current-buffer buff (goto-char reg-start))
900 ;; if it is a combined merge then set overlays in buff C specially
901 (if (and ediff-merge-job (eq buf-type 'C)
902 (setq combined-merge-diff-list
903 (ediff-looks-like-combined-merge region-num)))
904 (ediff-set-fine-overlays-for-combined-merge
905 combined-merge-diff-list region-num)
906 ;; regular fine diff
907 (while diff-list
908 (setq current-diff (1+ current-diff)
909 list-element (car diff-list)
910 begin (aref list-element (cond ((eq buf-type 'A) 0)
911 ((eq buf-type 'B) 2)
912 (t 4))) ; buf C
913 end (aref list-element (cond ((eq buf-type 'A) 1)
914 ((eq buf-type 'B) 3)
915 (t 5)))) ; buf C
916 (if (not (or begin end))
917 () ; skip this diff
918 ;; Put overlays at appropriate places in buffers
919 ;; convert lines to points, if necessary
920 (ediff-with-current-buffer ctl-buf
921 (setq begin (ediff-goto-word (1+ begin) buff)
922 end (ediff-goto-word end buff 'end)))
923 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
924 ;; record all overlays for this difference region
925 (setq diff-overlay-list (nconc diff-overlay-list (list overlay))))
927 (setq diff-list (cdr diff-list))
928 ) ; while
929 ;; convert the list of difference information into a vector
930 ;; for fast access
931 (ediff-set-fine-diff-vector
932 region-num buf-type (vconcat diff-overlay-list))
936 (defun ediff-convert-fine-diffs-to-overlays (diff-list region-num)
937 (ediff-set-fine-overlays-in-one-buffer 'A diff-list region-num)
938 (ediff-set-fine-overlays-in-one-buffer 'B diff-list region-num)
939 (if ediff-3way-job
940 (ediff-set-fine-overlays-in-one-buffer 'C diff-list region-num)
944 ;; Stolen from emerge.el
945 (defun ediff-get-diff3-group (file)
946 ;; This save-excursion allows ediff-get-diff3-group to be called for the
947 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
948 ;; appear in any order. The reason this is necessary is that Gnu diff3
949 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
950 (save-excursion
951 (re-search-forward
952 (concat "^" file ":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)\C-m?$"))
953 (beginning-of-line 2)
954 ;; treatment depends on whether it is an "a" group or a "c" group
955 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
956 ;; it is a "c" group
957 (if (match-beginning 2)
958 ;; it has two numbers
959 (list (string-to-number
960 (buffer-substring (match-beginning 1) (match-end 1)))
961 (1+ (string-to-number
962 (buffer-substring (match-beginning 3) (match-end 3)))))
963 ;; it has one number
964 (let ((x (string-to-number
965 (buffer-substring (match-beginning 1) (match-end 1)))))
966 (list x (1+ x))))
967 ;; it is an "a" group
968 (let ((x (1+ (string-to-number
969 (buffer-substring (match-beginning 1) (match-end 1))))))
970 (list x x)))))
973 ;; If WORD-MODE, construct vector of diffs using word numbers.
974 ;; Else, use point values.
975 ;; WORD-MODE also tells if we are in the word-mode or not.
976 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
977 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
978 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
979 ;; value.
980 ;; BOUNDS specifies visibility bounds to use.
981 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
982 &optional bounds)
983 (let ((A-buffer ediff-buffer-A)
984 (B-buffer ediff-buffer-B)
985 (C-buffer ediff-buffer-C)
986 (anc-buffer ediff-ancestor-buffer)
987 (a-prev 1) ; needed to set the first diff line correctly
988 (a-prev-pt nil)
989 (b-prev 1)
990 (b-prev-pt nil)
991 (c-prev 1)
992 (c-prev-pt nil)
993 (anc-prev 1)
994 diff-list shift-A shift-B shift-C
997 ;; diff list contains word numbers or points, depending on word-mode
998 (setq diff-list (cons (if word-mode 'words 'points)
999 diff-list))
1000 (if bounds
1001 (setq shift-A
1002 (ediff-overlay-start
1003 (ediff-get-value-according-to-buffer-type 'A bounds))
1004 shift-B
1005 (ediff-overlay-start
1006 (ediff-get-value-according-to-buffer-type 'B bounds))
1007 shift-C
1008 (if three-way-comp
1009 (ediff-overlay-start
1010 (ediff-get-value-according-to-buffer-type 'C bounds)))))
1012 ;; reset point in buffers A, B, C
1013 (ediff-with-current-buffer A-buffer
1014 (goto-char (if shift-A shift-A (point-min))))
1015 (ediff-with-current-buffer B-buffer
1016 (goto-char (if shift-B shift-B (point-min))))
1017 (if three-way-comp
1018 (ediff-with-current-buffer C-buffer
1019 (goto-char (if shift-C shift-C (point-min)))))
1020 (if (ediff-buffer-live-p anc-buffer)
1021 (ediff-with-current-buffer anc-buffer
1022 (goto-char (point-min))))
1024 (ediff-with-current-buffer diff-buffer
1025 (goto-char (point-min))
1026 (while (re-search-forward ediff-match-diff3-line nil t)
1027 ;; leave point after matched line
1028 (beginning-of-line 2)
1029 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
1030 ;; if the files A and B are the same and not 3way-comparison,
1031 ;; ignore the difference
1032 (if (or three-way-comp (not (string-equal agreement "3")))
1033 (let* ((a-begin (car (ediff-get-diff3-group "1")))
1034 (a-end (nth 1 (ediff-get-diff3-group "1")))
1035 (b-begin (car (ediff-get-diff3-group "2")))
1036 (b-end (nth 1 (ediff-get-diff3-group "2")))
1037 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
1038 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
1039 (state-of-merge
1040 (cond ((string-equal agreement "1") 'prefer-A)
1041 ((string-equal agreement "2") 'prefer-B)
1042 (t ediff-default-variant)))
1043 (state-of-diff-merge
1044 (if (memq state-of-merge '(default-A prefer-A)) 'B 'A))
1045 (state-of-diff-comparison
1046 (cond ((string-equal agreement "1") 'A)
1047 ((string-equal agreement "2") 'B)
1048 ((string-equal agreement "3") 'C)))
1049 state-of-ancestor
1050 c-begin c-end
1051 a-begin-pt a-end-pt
1052 b-begin-pt b-end-pt
1053 c-begin-pt c-end-pt
1054 anc-begin-pt anc-end-pt)
1056 (setq state-of-ancestor
1057 (= c-or-anc-begin c-or-anc-end))
1059 (cond (three-way-comp
1060 (setq c-begin c-or-anc-begin
1061 c-end c-or-anc-end))
1062 ((eq ediff-default-variant 'default-B)
1063 (setq c-begin b-begin
1064 c-end b-end))
1066 (setq c-begin a-begin
1067 c-end a-end)))
1069 ;; compute main diff vector
1070 (if word-mode
1071 ;; make diff-list contain word numbers
1072 (setq diff-list
1073 (nconc diff-list
1074 (list (vector
1075 (- a-begin a-prev) (- a-end a-begin)
1076 (- b-begin b-prev) (- b-end b-begin)
1077 (- c-begin c-prev) (- c-end c-begin)
1078 nil nil ; dummy ancestor
1079 nil ; state of diff
1080 nil ; state of merge
1081 nil ; state of ancestor
1083 a-prev a-end
1084 b-prev b-end
1085 c-prev c-end)
1086 ;; else convert lines to points
1087 (ediff-with-current-buffer A-buffer
1088 (let ((longlines-mode-val
1089 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
1090 ;; we must disable and then restore longlines-mode
1091 (if (eq longlines-mode-val 1)
1092 (longlines-mode 0))
1093 (goto-char (or a-prev-pt shift-A (point-min)))
1094 (forward-line (- a-begin a-prev))
1095 (setq a-begin-pt (point))
1096 (forward-line (- a-end a-begin))
1097 (setq a-end-pt (point)
1098 a-prev a-end
1099 a-prev-pt a-end-pt)
1100 (if (eq longlines-mode-val 1)
1101 (longlines-mode longlines-mode-val))
1103 (ediff-with-current-buffer B-buffer
1104 (let ((longlines-mode-val
1105 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
1106 (if (eq longlines-mode-val 1)
1107 (longlines-mode 0))
1108 (goto-char (or b-prev-pt shift-B (point-min)))
1109 (forward-line (- b-begin b-prev))
1110 (setq b-begin-pt (point))
1111 (forward-line (- b-end b-begin))
1112 (setq b-end-pt (point)
1113 b-prev b-end
1114 b-prev-pt b-end-pt)
1115 (if (eq longlines-mode-val 1)
1116 (longlines-mode longlines-mode-val))
1118 (ediff-with-current-buffer C-buffer
1119 (let ((longlines-mode-val
1120 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
1121 (if (eq longlines-mode-val 1)
1122 (longlines-mode 0))
1123 (goto-char (or c-prev-pt shift-C (point-min)))
1124 (forward-line (- c-begin c-prev))
1125 (setq c-begin-pt (point))
1126 (forward-line (- c-end c-begin))
1127 (setq c-end-pt (point)
1128 c-prev c-end
1129 c-prev-pt c-end-pt)
1130 (if (eq longlines-mode-val 1)
1131 (longlines-mode longlines-mode-val))
1133 (if (ediff-buffer-live-p anc-buffer)
1134 (ediff-with-current-buffer anc-buffer
1135 (let ((longlines-mode-val
1136 (if (and (boundp 'longlines-mode) longlines-mode) 1 0)))
1137 (if (eq longlines-mode-val 1)
1138 (longlines-mode 0))
1139 (forward-line (- c-or-anc-begin anc-prev))
1140 (setq anc-begin-pt (point))
1141 (forward-line (- c-or-anc-end c-or-anc-begin))
1142 (setq anc-end-pt (point)
1143 anc-prev c-or-anc-end)
1144 (if (eq longlines-mode-val 1)
1145 (longlines-mode longlines-mode-val))
1147 (setq diff-list
1148 (nconc
1149 diff-list
1150 ;; if comparing with ancestor, then there also is a
1151 ;; state-of-difference marker
1152 (if three-way-comp
1153 (list (vector
1154 a-begin-pt a-end-pt
1155 b-begin-pt b-end-pt
1156 c-begin-pt c-end-pt
1157 nil nil ; ancestor begin/end
1158 state-of-diff-comparison
1159 nil ; state of merge
1160 nil ; state of ancestor
1162 (list (vector a-begin-pt a-end-pt
1163 b-begin-pt b-end-pt
1164 c-begin-pt c-end-pt
1165 anc-begin-pt anc-end-pt
1166 state-of-diff-merge
1167 state-of-merge
1168 state-of-ancestor
1173 ))) ; end ediff-with-current-buffer
1174 diff-list
1177 ;; Generate the difference vector and overlays for three files
1178 ;; File-C is either the third file to compare (in case of 3-way comparison)
1179 ;; or it is the ancestor file.
1180 (defun ediff-setup-diff-regions3 (file-A file-B file-C)
1181 ;; looking for '-i' or a 'i' among clustered non-long options
1182 (if (string-match "^-i\\| -i\\|\\(^\\| \\)-[^- ]+i" ediff-diff-options)
1183 (error "Option `-i' is not allowed in `ediff-diff3-options'"))
1185 (or (ediff-buffer-live-p ediff-diff-buffer)
1186 (setq ediff-diff-buffer
1187 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1189 (message "Computing differences ...")
1190 (ediff-exec-process ediff-diff3-program ediff-diff-buffer 'synchronize
1191 ediff-actual-diff3-options file-A file-B file-C)
1193 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer)
1194 ;;(message "Computing differences ... done")
1195 (ediff-convert-diffs-to-overlays
1196 (ediff-extract-diffs3
1197 ediff-diff-buffer
1198 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds)
1202 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1203 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1204 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1205 ;; string. All elements in FILES must be strings. We also delete nil from
1206 ;; args.
1207 (defun ediff-exec-process (program buffer synch options &rest files)
1208 (let ((data (match-data))
1209 ;; If this is a buffer job, we are diffing temporary files
1210 ;; produced by Emacs with ediff-coding-system-for-write, so
1211 ;; use the same encoding to read the results.
1212 (coding-system-for-read
1213 (if (string-match "buffer" (symbol-name ediff-job-name))
1214 ediff-coding-system-for-write
1215 ediff-coding-system-for-read))
1216 args)
1217 (setq args (append (split-string options) files))
1218 (setq args (delete "" (delq nil args))) ; delete nil and "" from arguments
1219 ;; the --binary option, if present, should be used only for buffer jobs
1220 ;; or for refining the differences
1221 (or (string-match "buffer" (symbol-name ediff-job-name))
1222 (eq buffer ediff-fine-diff-buffer)
1223 (setq args (delete "--binary" args)))
1224 (unwind-protect
1225 (let ((directory default-directory)
1226 proc)
1227 (with-current-buffer buffer
1228 (erase-buffer)
1229 (setq default-directory directory)
1230 (if (or (memq system-type '(ms-dos windows-nt))
1231 synch)
1232 ;; In Windows do it synchronously, since Windows doesn't let us
1233 ;; delete files used by other processes. Thus, in ediff-buffers
1234 ;; and similar functions, we can't delete temp files because
1235 ;; they might be used by the asynch process that computes
1236 ;; custom diffs. So, we have to wait till custom diff
1237 ;; subprocess is done.
1238 ;; In DOS, must synchronize because DOS doesn't have
1239 ;; asynchronous processes.
1240 (apply 'call-process program nil buffer nil args)
1241 ;; On other systems, do it asynchronously.
1242 (setq proc (get-buffer-process buffer))
1243 (if proc (kill-process proc))
1244 (setq proc
1245 (apply 'start-process "Custom Diff" buffer program args))
1246 (setq mode-line-process '(":%s"))
1247 (set-process-sentinel proc 'ediff-process-sentinel)
1248 (set-process-filter proc 'ediff-process-filter)
1250 (store-match-data data))))
1252 ;; This is shell-command-filter from simple.el in Emacs.
1253 ;; Copied here because XEmacs doesn't have it.
1254 (defun ediff-process-filter (proc string)
1255 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1256 ;; despite an insertion immediately after it.
1257 (let* ((obuf (current-buffer))
1258 (buffer (process-buffer proc))
1259 opoint
1260 (window (get-buffer-window buffer))
1261 (pos (window-start window)))
1262 (unwind-protect
1263 (progn
1264 (set-buffer buffer)
1265 (or (= (point) (point-max))
1266 (setq opoint (point)))
1267 (goto-char (point-max))
1268 (insert-before-markers string))
1269 ;; insert-before-markers moved this marker: set it back.
1270 (set-window-start window pos)
1271 ;; Finish our save-excursion.
1272 (if opoint
1273 (goto-char opoint))
1274 (set-buffer obuf))))
1276 ;; like shell-command-sentinel but doesn't print an exit status message
1277 ;; we do this because diff always exits with status 1, if diffs are found
1278 ;; so shell-command-sentinel displays a confusing message to the user
1279 (defun ediff-process-sentinel (process signal)
1280 (if (and (memq (process-status process) '(exit signal))
1281 (buffer-name (process-buffer process)))
1282 (progn
1283 (with-current-buffer (process-buffer process)
1284 (setq mode-line-process nil))
1285 (delete-process process))))
1288 ;;; Word functions used to refine the current diff
1290 (defvar ediff-forward-word-function 'ediff-forward-word
1291 "*Function to call to move to the next word.
1292 Used for splitting difference regions into individual words.")
1293 (make-variable-buffer-local 'ediff-forward-word-function)
1295 ;; \240 is Unicode symbol for nonbreakable whitespace
1296 (defvar ediff-whitespace " \n\t\f\r\240"
1297 "*Characters constituting white space.
1298 These characters are ignored when differing regions are split into words.")
1299 (make-variable-buffer-local 'ediff-whitespace)
1301 (defvar ediff-word-1
1302 (if (featurep 'xemacs) "a-zA-Z---_" "-[:word:]_")
1303 "*Characters that constitute words of type 1.
1304 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1305 See `ediff-forward-word' for more details.")
1306 (make-variable-buffer-local 'ediff-word-1)
1308 (defvar ediff-word-2 "0-9.,"
1309 "*Characters that constitute words of type 2.
1310 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1311 See `ediff-forward-word' for more details.")
1312 (make-variable-buffer-local 'ediff-word-2)
1314 (defvar ediff-word-3 "`'?!:;\"{}[]()"
1315 "*Characters that constitute words of type 3.
1316 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1317 See `ediff-forward-word' for more details.")
1318 (make-variable-buffer-local 'ediff-word-3)
1320 (defvar ediff-word-4
1321 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace)
1322 "*Characters that constitute words of type 4.
1323 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1324 See `ediff-forward-word' for more details.")
1325 (make-variable-buffer-local 'ediff-word-4)
1327 ;; Split region along word boundaries. Each word will be on its own line.
1328 ;; Output to buffer out-buffer.
1329 (defun ediff-forward-word ()
1330 "Move point one word forward.
1331 There are four types of words, each of which consists entirely of
1332 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1333 `ediff-word-4'. Words are recognized by passing these one after another as
1334 arguments to `skip-chars-forward'."
1335 (or (> (+ (skip-chars-forward ediff-word-1)
1336 (skip-syntax-forward "w"))
1338 (> (skip-chars-forward ediff-word-2) 0)
1339 (> (skip-chars-forward ediff-word-3) 0)
1340 (> (skip-chars-forward ediff-word-4) 0)
1344 (defun ediff-wordify (beg end in-buffer out-buffer &optional control-buf)
1345 (let ((forward-word-function
1346 ;; eval in control buf to let user create local versions for
1347 ;; different invocations
1348 (if control-buf
1349 (ediff-with-current-buffer control-buf
1350 ediff-forward-word-function)
1351 ediff-forward-word-function))
1352 inbuf-syntax-tbl sv-point diff-string)
1353 (with-current-buffer in-buffer
1354 (setq inbuf-syntax-tbl
1355 (if control-buf
1356 (ediff-with-current-buffer control-buf
1357 ediff-syntax-table)
1358 (syntax-table)))
1359 (setq diff-string (buffer-substring-no-properties beg end))
1361 (set-buffer out-buffer)
1362 ;; Make sure that temp buff syntax table is the same as the original buf
1363 ;; syntax tbl, because we use ediff-forward-word in both and
1364 ;; ediff-forward-word depends on the syntax classes of characters.
1365 (set-syntax-table inbuf-syntax-tbl)
1366 (erase-buffer)
1367 (insert diff-string)
1368 (goto-char (point-min))
1369 (skip-chars-forward ediff-whitespace)
1370 (delete-region (point-min) (point))
1372 (while (not (eobp))
1373 (funcall forward-word-function)
1374 (setq sv-point (point))
1375 (skip-chars-forward ediff-whitespace)
1376 (delete-region sv-point (point))
1377 (insert "\n")))))
1379 ;; copy string specified as BEG END from IN-BUF to OUT-BUF
1380 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer)
1381 (with-current-buffer out-buffer
1382 (erase-buffer)
1383 (insert-buffer-substring in-buffer beg end)
1384 (goto-char (point-min))))
1387 ;; goto word #n starting at current position in buffer `buf'
1388 ;; For ediff, a word is determined by ediff-forward-word-function
1389 ;; If `flag' is non-nil, goto the end of the n-th word.
1390 (defun ediff-goto-word (n buf &optional flag)
1391 ;; remember val ediff-forward-word-function has in ctl buf
1392 (let ((fwd-word-fun ediff-forward-word-function)
1393 (syntax-tbl ediff-syntax-table))
1394 (ediff-with-current-buffer buf
1395 (skip-chars-forward ediff-whitespace)
1396 (ediff-with-syntax-table syntax-tbl
1397 (while (> n 1)
1398 (funcall fwd-word-fun)
1399 (skip-chars-forward ediff-whitespace)
1400 (setq n (1- n)))
1401 (if (and flag (> n 0))
1402 (funcall fwd-word-fun)))
1403 (point))))
1405 (defun ediff-same-file-contents (f1 f2)
1406 "Return t if files F1 and F2 have identical contents."
1407 (if (and (not (file-directory-p f1))
1408 (not (file-directory-p f2)))
1409 (let ((res
1410 (apply 'call-process ediff-cmp-program nil nil nil
1411 (append ediff-cmp-options (list (expand-file-name f1)
1412 (expand-file-name f2))))
1414 (and (numberp res) (eq res 0)))
1418 (defun ediff-same-contents (d1 d2 &optional filter-re)
1419 "Return t if D1 and D2 have the same content.
1420 D1 and D2 can either be both directories or both regular files.
1421 Symlinks and the likes are not handled.
1422 If FILTER-RE is non-nil, recursive checking in directories
1423 affects only files whose names match the expression."
1424 ;; Normalize empty filter RE to nil.
1425 (unless (> (length filter-re) 0) (setq filter-re nil))
1426 ;; Indicate progress
1427 (message "Comparing '%s' and '%s' modulo '%s'" d1 d2 filter-re)
1428 (cond
1429 ;; D1 & D2 directories => recurse
1430 ((and (file-directory-p d1)
1431 (file-directory-p d2))
1432 (if (null ediff-recurse-to-subdirectories)
1433 (if (y-or-n-p "Compare subdirectories recursively? ")
1434 (setq ediff-recurse-to-subdirectories 'yes)
1435 (setq ediff-recurse-to-subdirectories 'no)))
1436 (if (eq ediff-recurse-to-subdirectories 'yes)
1437 (let* ((all-entries-1 (directory-files d1 t filter-re))
1438 (all-entries-2 (directory-files d2 t filter-re))
1439 (entries-1 (ediff-delete-all-matches "^\\.\\.?$" all-entries-1))
1440 (entries-2 (ediff-delete-all-matches "^\\.\\.?$" all-entries-2))
1443 (ediff-same-file-contents-lists entries-1 entries-2 filter-re)
1445 ) ; end of the directories case
1446 ;; D1 & D2 are both files => compare directly
1447 ((and (file-regular-p d1)
1448 (file-regular-p d2))
1449 (ediff-same-file-contents d1 d2))
1450 ;; Otherwise => false: unequal contents
1454 ;; If lists have the same length and names of files are pairwise equal
1455 ;; (removing the directories) then compare contents pairwise.
1456 ;; True if all contents are the same; false otherwise
1457 (defun ediff-same-file-contents-lists (entries-1 entries-2 filter-re)
1458 ;; First, check only the names (works quickly and ensures a
1459 ;; precondition for subsequent code)
1460 (if (and (= (length entries-1) (length entries-2))
1461 (equal (mapcar 'file-name-nondirectory entries-1)
1462 (mapcar 'file-name-nondirectory entries-2)))
1463 ;; With name equality established, compare the entries
1464 ;; through recursion.
1465 (let ((continue t))
1466 (while (and entries-1 continue)
1467 (if (ediff-same-contents
1468 (car entries-1) (car entries-2) filter-re)
1469 (setq entries-1 (cdr entries-1)
1470 entries-2 (cdr entries-2))
1471 (setq continue nil))
1473 ;; if reached the end then lists are equal
1474 (null entries-1))
1479 ;; ARG1 is a regexp, ARG2 is a list of full-filenames
1480 ;; Delete all entries that match the regexp
1481 (defun ediff-delete-all-matches (regex file-list-list)
1482 (let (result elt)
1483 (while file-list-list
1484 (setq elt (car file-list-list))
1485 (or (string-match regex (file-name-nondirectory elt))
1486 (setq result (cons elt result)))
1487 (setq file-list-list (cdr file-list-list)))
1488 (reverse result)))
1491 (defun ediff-set-actual-diff-options ()
1492 (if ediff-ignore-case
1493 (setq ediff-actual-diff-options
1494 (concat ediff-diff-options " " ediff-ignore-case-option)
1495 ediff-actual-diff3-options
1496 (concat ediff-diff3-options " " ediff-ignore-case-option3))
1497 (setq ediff-actual-diff-options ediff-diff-options
1498 ediff-actual-diff3-options ediff-diff3-options)
1500 (setq-default ediff-actual-diff-options ediff-actual-diff-options
1501 ediff-actual-diff3-options ediff-actual-diff3-options)
1505 ;; Ignore case handling - some ideas from drew.adams@@oracle.com
1506 (defun ediff-toggle-ignore-case ()
1507 (interactive)
1508 (ediff-barf-if-not-control-buffer)
1509 (setq ediff-ignore-case (not ediff-ignore-case))
1510 (ediff-set-actual-diff-options)
1511 (if ediff-ignore-case
1512 (message "Ignoring regions that differ only in case")
1513 (message "Ignoring case differences turned OFF"))
1514 (cond (ediff-merge-job
1515 (message "Ignoring letter case is too dangerous in merge jobs"))
1516 ((and ediff-diff3-job (string= ediff-ignore-case-option3 ""))
1517 (message "Ignoring letter case is not supported by this diff3 program"))
1518 ((and (not ediff-3way-job) (string= ediff-ignore-case-option ""))
1519 (message "Ignoring letter case is not supported by this diff program"))
1521 (sit-for 1)
1522 (ediff-update-diffs)))
1527 ;; Local Variables:
1528 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1529 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1530 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1531 ;; End:
1533 ;;; ediff-diff.el ends here