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