Docstrings fixes.
[emacs.git] / lisp / ediff-diff.el
blobe6864bf02feca8859205ddc9363d1137c40590b4
1 ;;; ediff-diff.el --- diff-related utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
24 ;;; Code:
26 (provide 'ediff-diff)
28 ;; compiler pacifier
29 (defvar ediff-default-variant)
31 (eval-when-compile
32 (let ((load-path (cons (expand-file-name ".") load-path)))
33 (or (featurep 'ediff-init)
34 (load "ediff-init.el" nil nil 'nosuffix))
35 (or (featurep 'ediff-util)
36 (load "ediff-util.el" nil nil 'nosuffix))
38 ;; end pacifier
40 (require 'ediff-init)
42 (defgroup ediff-diff nil
43 "Diff related utilities"
44 :prefix "ediff-"
45 :group 'ediff)
48 ;; The following functions needed for setting diff/diff3 options
49 ;; test if diff supports the --binary option
50 (defsubst ediff-test-utility (diff-util option &optional files)
51 (zerop (apply 'call-process
52 (append (list diff-util nil nil nil option) files))))
54 (defun ediff-diff-mandatory-option (diff-util)
55 (let ((file (if (boundp 'null-device) null-device "/dev/null")))
56 (cond ((not (memq system-type '(ms-dos windows-nt windows-95)))
57 "")
58 ((and (string= diff-util ediff-diff-program)
59 (ediff-test-utility
60 ediff-diff-program "--binary" (list file file)))
61 "--binary")
62 ((and (string= diff-util ediff-diff3-program)
63 (ediff-test-utility
64 ediff-diff3-program "--binary" (list file file file)))
65 "--binary")
66 (t ""))))
68 ;; make sure that mandatory options are added even if the user changes
69 ;; ediff-diff-options or ediff-diff3-options in the customization widget
70 (defun ediff-reset-diff-options (symb val)
71 (let* ((diff-program
72 (if (eq symb 'ediff-diff-options)
73 ediff-diff-program
74 ediff-diff3-program))
75 (mandatory-option (ediff-diff-mandatory-option diff-program))
76 (spacer (if (string-equal mandatory-option "") "" " ")))
77 (set symb
78 (if (string-match mandatory-option val)
79 val
80 (concat mandatory-option spacer val)))
84 (defcustom ediff-shell
85 (cond ((eq system-type 'emx) "cmd") ; OS/2
86 ((memq system-type '(ms-dos windows-nt windows-95))
87 shell-file-name) ; no standard name on MS-DOS
88 ((memq system-type '(vax-vms axp-vms)) "*dcl*") ; VMS
89 (t "sh")) ; UNIX
90 "*The shell used to run diff and patch. If user's .profile or
91 .cshrc files are set up correctly, any shell will do. However, some people
92 set $prompt or other things incorrectly, which leads to undesirable output
93 messages. These may cause Ediff to fail. In such a case, set ediff-shell
94 to a shell that you are not using or, better, fix your shell's startup file."
95 :type 'string
96 :group 'ediff-diff)
98 (defcustom ediff-cmp-program "cmp"
99 "*Utility to use to determine if two files are identical.
100 It must return code 0, if its arguments are identical files."
101 :type 'string
102 :group 'ediff-diff)
104 (defcustom ediff-cmp-options nil
105 "*Options to pass to `ediff-cmp-program'. If GNUS diff is used as
106 `ediff-cmp-program', then the most useful options are `-I' RE, to
107 ignore changes whose lines all match RE."
108 :type '(repeat string)
109 :group 'ediff-diff)
111 (defcustom ediff-diff-program "diff"
112 "*Program to use for generating the differential of the two files."
113 :type 'string
114 :group 'ediff-diff)
115 (defcustom ediff-diff-options ""
116 "*Options to pass to `ediff-diff-program'.
117 If diff\(1\) is used as `ediff-diff-program', then the most useful options are
118 `-w', to ignore space, and `-i', to ignore case of letters.
119 At present, the option `-c' is not allowed."
120 :set 'ediff-reset-diff-options
121 :type 'string
122 :group 'ediff-diff)
124 (defcustom ediff-custom-diff-program ediff-diff-program
125 "*Program to use for generating custom diff output for saving it in a file.
126 This output is not used by Ediff internally."
127 :type 'string
128 :group 'ediff-diff)
129 (defcustom ediff-custom-diff-options "-c"
130 "*Options to pass to `ediff-custom-diff-program'."
131 :type 'string
132 :group 'ediff-diff)
134 ;;; Support for diff3
136 (defvar ediff-match-diff3-line "^====\\(.?\\)$"
137 "Pattern to match lines produced by diff3 that describe differences.")
138 (defcustom ediff-diff3-program "diff3"
139 "*Program to be used for three-way comparison.
140 Must produce output compatible with Unix's diff3 program."
141 :type 'string
142 :group 'ediff-diff)
143 (defcustom ediff-diff3-options ""
144 "*Options to pass to `ediff-diff3-program'."
145 :set 'ediff-reset-diff-options
146 :type 'string
147 :group 'ediff-diff)
148 (defcustom ediff-diff3-ok-lines-regexp
149 "^\\([1-3]:\\|====\\| \\|.*Warning *:\\|.*No newline\\|.*missing newline\\|^\C-m$\\)"
150 "*Regexp that matches normal output lines from `ediff-diff3-program'.
151 Lines that do not match are assumed to be error messages."
152 :type 'regexp
153 :group 'ediff-diff)
155 ;; keeps the status of the current diff in 3-way jobs.
156 ;; the status can be =diff(A), =diff(B), or =diff(A+B)
157 (ediff-defvar-local ediff-diff-status "" "")
160 ;;; Fine differences
162 (ediff-defvar-local ediff-auto-refine (if (ediff-has-face-support-p) 'on 'nix)
163 "If `on', Ediff auto-highlights fine diffs for the current diff region.
164 If `off', auto-highlighting is not used. If `nix', no fine diffs are shown
165 at all, unless the user force-refines the region by hitting `*'.
167 This variable can be set either in .emacs or toggled interactively.
168 Use `setq-default' if setting it in .emacs")
170 (ediff-defvar-local ediff-ignore-similar-regions nil
171 "*If t, skip over difference regions that differ only in the white space and line breaks.
172 This variable can be set either in .emacs or toggled interactively.
173 Use `setq-default' if setting it in .emacs")
175 (ediff-defvar-local ediff-auto-refine-limit 1400
176 "*Auto-refine only the regions of this size \(in bytes\) or less.")
178 ;;; General
180 (defvar ediff-diff-ok-lines-regexp
181 (concat
182 "^\\("
183 "[0-9,]+[acd][0-9,]+\C-m?$"
184 "\\|[<>] "
185 "\\|---"
186 "\\|.*Warning *:"
187 "\\|.*No +newline"
188 "\\|.*missing +newline"
189 "\\|^\C-m?$"
190 "\\)")
191 "Regexp that matches normal output lines from `ediff-diff-program'.
192 This is mostly lifted from Emerge, except that Ediff also considers
193 warnings and `Missing newline'-type messages to be normal output.
194 Lines that do not match are assumed to be error messages.")
196 (defvar ediff-match-diff-line
197 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
198 (concat "^" x "\\([acd]\\)" x "\C-m?$"))
199 "Pattern to match lines produced by diff that describe differences.")
201 (ediff-defvar-local ediff-setup-diff-regions-function nil
202 "value is a function symbol depending on the kind of job is to be done.
203 For 2-way jobs and for ediff-merge, it should be `ediff-setup-diff-regions'.
204 For jobs requiring diff3, it should be `ediff-setup-diff-regions3'.
206 The function should take three mandatory arguments, file-A, file-B, and
207 file-C. It may ignore file C for diff2 jobs. It should also take
208 one optional arguments, diff-number to refine.")
211 ;;; Functions
213 ;; Generate the difference vector and overlays for the two files
214 ;; With optional arg REG-TO-REFINE, refine this region.
215 ;; File-C argument is not used here. It is there just because
216 ;; ediff-setup-diff-regions is called via a funcall to
217 ;; ediff-setup-diff-regions-function, which can also have the value
218 ;; ediff-setup-diff-regions3, which takes 4 arguments.
219 (defun ediff-setup-diff-regions (file-A file-B file-C)
220 (if (string-match "c" ediff-diff-options)
221 (error "Option `-c' is 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 (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 ((< file1-size 0)
251 (message "Can't diff remote files: %s"
252 (ediff-abbreviate-file-name file1))
253 (sit-for 2)
254 ;; 1 is an error exit code
256 ((< file2-size 0)
257 (message "Can't diff remote file: %s"
258 (ediff-abbreviate-file-name file2))
259 (sit-for 2)
260 (message "")
261 ;; 1 is an error exit code
263 (t (message "Computing differences between %s and %s ..."
264 (file-name-nondirectory file1)
265 (file-name-nondirectory file2))
266 ;; this erases the diff buffer automatically
267 (ediff-exec-process ediff-diff-program
268 diff-buffer
269 'synchronize
270 ediff-diff-options file1 file2)
271 (message "")
272 (ediff-with-current-buffer diff-buffer
273 (buffer-size))))))
277 ;; If file-A/B/C is nil, do 2-way comparison with the non-nil buffers
278 ;; This function works for diff3 and diff2 jobs
279 (defun ediff-setup-fine-diff-regions (file-A file-B file-C reg-num)
280 (or (ediff-buffer-live-p ediff-fine-diff-buffer)
281 (setq ediff-fine-diff-buffer
282 (get-buffer-create
283 (ediff-unique-buffer-name "*ediff-fine-diff" "*"))))
285 (let (diff3-job diff-program diff-options ok-regexp diff-list)
286 (setq diff3-job ediff-3way-job
287 diff-program (if diff3-job ediff-diff3-program ediff-diff-program)
288 diff-options (if diff3-job ediff-diff3-options ediff-diff-options)
289 ok-regexp (if diff3-job
290 ediff-diff3-ok-lines-regexp
291 ediff-diff-ok-lines-regexp))
293 (ediff-message-if-verbose "Refining difference region %d ..." (1+ reg-num))
294 (ediff-exec-process diff-program ediff-fine-diff-buffer 'synchronize
295 diff-options
296 ;; The shuffle below is because we can compare 3-way
297 ;; or in several 2-way fashions, like fA fC, fA fB,
298 ;; or fB fC.
299 (if file-A file-A file-B)
300 (if file-B file-B file-A)
301 (if diff3-job
302 (if file-C file-C file-B))
303 ) ; exec process
305 (ediff-prepare-error-list ok-regexp ediff-fine-diff-buffer)
306 (ediff-message-if-verbose
308 ;; "Refining difference region %d ... done" (1+ reg-num))
310 (setq diff-list
311 (if diff3-job
312 (ediff-extract-diffs3
313 ediff-fine-diff-buffer '3way-comparison 'word-mode)
314 (ediff-extract-diffs ediff-fine-diff-buffer 'word-mode)))
315 ;; fixup diff-list
316 (if diff3-job
317 (cond ((not file-A)
318 (mapcar (lambda (elt)
319 (aset elt 0 nil)
320 (aset elt 1 nil))
321 (cdr diff-list)))
322 ((not file-B)
323 (mapcar (lambda (elt)
324 (aset elt 2 nil)
325 (aset elt 3 nil))
326 (cdr diff-list)))
327 ((not file-C)
328 (mapcar (lambda (elt)
329 (aset elt 4 nil)
330 (aset elt 5 nil))
331 (cdr diff-list)))
334 (ediff-convert-fine-diffs-to-overlays diff-list reg-num)
338 (defun ediff-prepare-error-list (ok-regexp diff-buff)
339 (or (ediff-buffer-live-p ediff-error-buffer)
340 (setq ediff-error-buffer
341 (get-buffer-create (ediff-unique-buffer-name
342 "*ediff-errors" "*"))))
343 (ediff-with-current-buffer ediff-error-buffer
344 (erase-buffer)
345 (insert (ediff-with-current-buffer diff-buff (buffer-string)))
346 (goto-char (point-min))
347 (delete-matching-lines ok-regexp)
348 (if (memq system-type '(vax-vms axp-vms))
349 (delete-matching-lines "^$")))
350 ;; If diff reports errors, show them then quit.
351 (if (/= 0 (ediff-with-current-buffer ediff-error-buffer (buffer-size)))
352 (let ((ctl-buf ediff-control-buffer)
353 (error-buf ediff-error-buffer))
354 (ediff-skip-unsuitable-frames)
355 (switch-to-buffer error-buf)
356 (ediff-kill-buffer-carefully ctl-buf)
357 (error "Errors in diff output. Diff output is in %S" diff-buff))))
359 ;; BOUNDS specifies visibility bounds to use.
360 ;; WORD-MODE tells whether we are in the word-mode or not.
361 ;; If WORD-MODE, also construct vector of diffs using word numbers.
362 ;; Else, use point values.
363 ;; This function handles diff-2 jobs including the case of
364 ;; merging buffers and files without ancestor.
365 (defun ediff-extract-diffs (diff-buffer word-mode &optional bounds)
366 (let ((A-buffer ediff-buffer-A)
367 (B-buffer ediff-buffer-B)
368 (C-buffer ediff-buffer-C)
369 (a-prev 1) ; this is needed to set the first diff line correctly
370 (b-prev 1)
371 (c-prev 1)
372 diff-list shift-A shift-B
375 ;; diff list contains word numbers, unless changed later
376 (setq diff-list (cons (if word-mode 'words 'points)
377 diff-list))
378 ;; we don't use visibility bounds for buffer C when merging
379 (if bounds
380 (setq shift-A
381 (ediff-overlay-start
382 (ediff-get-value-according-to-buffer-type 'A bounds))
383 shift-B
384 (ediff-overlay-start
385 (ediff-get-value-according-to-buffer-type 'B bounds))))
387 ;; reset point in buffers A/B/C
388 (ediff-with-current-buffer A-buffer
389 (goto-char (if shift-A shift-A (point-min))))
390 (ediff-with-current-buffer B-buffer
391 (goto-char (if shift-B shift-B (point-min))))
392 (if (ediff-buffer-live-p C-buffer)
393 (ediff-with-current-buffer C-buffer
394 (goto-char (point-min))))
396 (ediff-with-current-buffer diff-buffer
397 (goto-char (point-min))
398 (while (re-search-forward ediff-match-diff-line nil t)
399 (let* ((a-begin (string-to-int (buffer-substring (match-beginning 1)
400 (match-end 1))))
401 (a-end (let ((b (match-beginning 3))
402 (e (match-end 3)))
403 (if b
404 (string-to-int (buffer-substring b e))
405 a-begin)))
406 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
407 (b-begin (string-to-int (buffer-substring (match-beginning 5)
408 (match-end 5))))
409 (b-end (let ((b (match-beginning 7))
410 (e (match-end 7)))
411 (if b
412 (string-to-int (buffer-substring b e))
413 b-begin)))
414 a-begin-pt a-end-pt b-begin-pt b-end-pt
415 c-begin c-end c-begin-pt c-end-pt)
416 ;; fix the beginning and end numbers, because diff is somewhat
417 ;; strange about how it numbers lines
418 (if (string-equal diff-type "a")
419 (setq b-end (1+ b-end)
420 a-begin (1+ a-begin)
421 a-end a-begin)
422 (if (string-equal diff-type "d")
423 (setq a-end (1+ a-end)
424 b-begin (1+ b-begin)
425 b-end b-begin)
426 ;; (string-equal diff-type "c")
427 (setq a-end (1+ a-end)
428 b-end (1+ b-end))))
430 (if (eq ediff-default-variant 'default-B)
431 (setq c-begin b-begin
432 c-end b-end)
433 (setq c-begin a-begin
434 c-end a-end))
436 ;; compute main diff vector
437 (if word-mode
438 ;; make diff-list contain word numbers
439 (setq diff-list
440 (nconc diff-list
441 (list
442 (if (ediff-buffer-live-p C-buffer)
443 (vector (- a-begin a-prev) (- a-end a-begin)
444 (- b-begin b-prev) (- b-end b-begin)
445 (- c-begin c-prev) (- c-end c-begin)
446 nil nil ; dummy ancestor
447 nil ; state of diff
448 nil ; state of merge
449 nil ; state of ancestor
451 (vector (- a-begin a-prev) (- a-end a-begin)
452 (- b-begin b-prev) (- b-end b-begin)
453 nil nil ; dummy buf C
454 nil nil ; dummy ancestor
455 nil ; state of diff
456 nil ; state of merge
457 nil ; state of ancestor
460 a-prev a-end
461 b-prev b-end
462 c-prev c-end)
463 ;; else convert lines to points
464 (ediff-with-current-buffer A-buffer
465 (forward-line (- a-begin a-prev))
466 (setq a-begin-pt (point))
467 (forward-line (- a-end a-begin))
468 (setq a-end-pt (point)
469 a-prev a-end))
470 (ediff-with-current-buffer B-buffer
471 (forward-line (- b-begin b-prev))
472 (setq b-begin-pt (point))
473 (forward-line (- b-end b-begin))
474 (setq b-end-pt (point)
475 b-prev b-end))
476 (if (ediff-buffer-live-p C-buffer)
477 (ediff-with-current-buffer C-buffer
478 (forward-line (- c-begin c-prev))
479 (setq c-begin-pt (point))
480 (forward-line (- c-end c-begin))
481 (setq c-end-pt (point)
482 c-prev c-end)))
483 (setq diff-list
484 (nconc
485 diff-list
486 (list
487 (if (ediff-buffer-live-p C-buffer)
488 (vector
489 a-begin-pt a-end-pt b-begin-pt b-end-pt
490 c-begin-pt c-end-pt
491 nil nil ; dummy ancestor
492 ;; state of diff
493 ;; shows which buff is different from the other two
494 (if (eq ediff-default-variant 'default-B) 'A 'B)
495 ediff-default-variant ; state of merge
496 nil ; state of ancestor
498 (vector a-begin-pt a-end-pt
499 b-begin-pt b-end-pt
500 nil nil ; dummy buf C
501 nil nil ; dummy ancestor
502 nil nil ; dummy state of diff & merge
503 nil ; dummy state of ancestor
504 )))
507 ))) ; end ediff-with-current-buffer
508 diff-list
512 (defun ediff-convert-diffs-to-overlays (diff-list)
513 (ediff-set-diff-overlays-in-one-buffer 'A diff-list)
514 (ediff-set-diff-overlays-in-one-buffer 'B diff-list)
515 (if ediff-3way-job
516 (ediff-set-diff-overlays-in-one-buffer 'C diff-list))
517 (if ediff-merge-with-ancestor-job
518 (ediff-set-diff-overlays-in-one-buffer 'Ancestor diff-list))
519 ;; set up vector showing the status of merge regions
520 (if ediff-merge-job
521 (setq ediff-state-of-merge
522 (vconcat
523 (mapcar (lambda (elt)
524 (let ((state-of-merge (aref elt 9))
525 (state-of-ancestor (aref elt 10)))
526 (vector
527 ;; state of merge: prefers/default-A/B or combined
528 (if state-of-merge (format "%S" state-of-merge))
529 ;; whether the ancestor region is empty
530 state-of-ancestor)))
531 ;; the first elt designates type of list
532 (cdr diff-list))
534 (message "Processing difference regions ... done"))
537 (defun ediff-set-diff-overlays-in-one-buffer (buf-type diff-list)
538 (let* ((current-diff -1)
539 (buff (ediff-get-buffer buf-type))
540 ;; ediff-extract-diffs puts the type of diff-list as the first elt
541 ;; of this list. The type is either 'points or 'words
542 (diff-list-type (car diff-list))
543 (shift (ediff-overlay-start
544 (ediff-get-value-according-to-buffer-type
545 buf-type ediff-narrow-bounds)))
546 (limit (ediff-overlay-end
547 (ediff-get-value-according-to-buffer-type
548 buf-type ediff-narrow-bounds)))
549 diff-overlay-list list-element total-diffs
550 begin end pt-saved overlay state-of-diff)
552 (setq diff-list (cdr diff-list)) ; discard diff list type
553 (setq total-diffs (length diff-list))
555 ;; shift, if necessary
556 (ediff-with-current-buffer buff (setq pt-saved shift))
558 (while diff-list
559 (setq current-diff (1+ current-diff)
560 list-element (car diff-list)
561 begin (aref list-element (cond ((eq buf-type 'A) 0)
562 ((eq buf-type 'B) 2)
563 ((eq buf-type 'C) 4)
564 (t 6))) ; Ancestor
565 end (aref list-element (cond ((eq buf-type 'A) 1)
566 ((eq buf-type 'B) 3)
567 ((eq buf-type 'C) 5)
568 (t 7))) ; Ancestor
569 state-of-diff (aref list-element 8)
572 (cond ((and (not (eq buf-type state-of-diff))
573 (not (eq buf-type 'Ancestor))
574 (memq state-of-diff '(A B C)))
575 (setq state-of-diff
576 (car (delq buf-type (delq state-of-diff (list 'A 'B 'C)))))
577 (setq state-of-diff (format "=diff(%S)" state-of-diff))
579 (t (setq state-of-diff nil)))
581 ;; Put overlays at appropriate places in buffer
582 ;; convert word numbers to points, if necessary
583 (if (eq diff-list-type 'words)
584 (progn
585 (ediff-with-current-buffer buff (goto-char pt-saved))
586 (setq begin (ediff-goto-word (1+ begin) buff)
587 end (ediff-goto-word end buff 'end))
588 (if (> end limit) (setq end limit))
589 (if (> begin end) (setq begin end))
590 (setq pt-saved (ediff-with-current-buffer buff (point)))))
591 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
593 (ediff-overlay-put overlay 'priority ediff-shadow-overlay-priority)
594 (ediff-overlay-put overlay 'ediff-diff-num current-diff)
595 (if (and (ediff-has-face-support-p)
596 ediff-use-faces ediff-highlight-all-diffs)
597 (ediff-set-overlay-face
598 overlay (ediff-background-face buf-type current-diff)))
600 (if (= 0 (mod current-diff 10))
601 (message "Buffer %S: Processing difference region %d of %d"
602 buf-type current-diff total-diffs))
603 ;; Record all overlays for this difference.
604 ;; The 2-d elt, nil, is a place holder for the fine diff vector.
605 ;; The 3-d elt, nil, is a place holder for no-fine-diffs flag.
606 ;; The 4-th elt says which diff region is different from the other two
607 ;; (3-way jobs only).
608 (setq diff-overlay-list
609 (nconc
610 diff-overlay-list
611 (list (vector overlay nil nil state-of-diff)))
612 diff-list
613 (cdr diff-list))
614 ) ; while
616 (set (ediff-get-symbol-from-alist buf-type ediff-difference-vector-alist)
617 (vconcat diff-overlay-list))
620 ;; `n' is the diff region to work on. Default is ediff-current-difference.
621 ;; if `flag' is 'noforce then make fine-diffs only if this region's fine
622 ;; diffs have not been computed before.
623 ;; if `flag' is 'skip then don't compute fine diffs for this region.
624 (defun ediff-make-fine-diffs (&optional n flag)
625 (or n (setq n ediff-current-difference))
627 (if (< ediff-number-of-differences 1)
628 (error ediff-NO-DIFFERENCES))
630 (if ediff-word-mode
631 (setq flag 'skip
632 ediff-auto-refine 'nix))
634 (or (< n 0)
635 (>= n ediff-number-of-differences)
636 ;; n is within the range
637 (let ((tmp-buffer (get-buffer-create ediff-tmp-buffer))
638 (file-A ediff-temp-file-A)
639 (file-B ediff-temp-file-B)
640 (file-C ediff-temp-file-C)
641 (empty-A (ediff-empty-diff-region-p n 'A))
642 (empty-B (ediff-empty-diff-region-p n 'B))
643 (empty-C (ediff-empty-diff-region-p n 'C))
644 (whitespace-A (ediff-whitespace-diff-region-p n 'A))
645 (whitespace-B (ediff-whitespace-diff-region-p n 'B))
646 (whitespace-C (ediff-whitespace-diff-region-p n 'C))
647 cumulative-fine-diff-length)
649 (cond ;; If one of the regions is empty (or 2 in 3way comparison)
650 ;; then don't refine.
651 ;; If the region happens to be entirely whitespace or empty then
652 ;; mark as such.
653 ((> (length (delq nil (list empty-A empty-B empty-C))) 1)
654 (if (and (ediff-looks-like-combined-merge n)
655 ediff-merge-job)
656 (ediff-set-fine-overlays-in-one-buffer 'C nil n))
657 (if ediff-3way-comparison-job
658 (ediff-message-if-verbose
659 "Region %d is empty in all buffers but %S"
660 (1+ n)
661 (cond ((not empty-A) 'A)
662 ((not empty-B) 'B)
663 ((not empty-C) 'C)))
664 (ediff-message-if-verbose
665 "Region %d in buffer %S is empty"
666 (1+ n)
667 (cond (empty-A 'A)
668 (empty-B 'B)
669 (empty-C 'C)))
671 ;; if all regions happen to be whitespace
672 (if (and whitespace-A whitespace-B whitespace-C)
673 ;; mark as space only
674 (ediff-mark-diff-as-space-only n t)
675 ;; if some regions are white and others don't, then mark as
676 ;; non-white-space-only
677 (ediff-mark-diff-as-space-only n nil)))
679 ;; don't compute fine diffs if diff vector exists
680 ((and (eq flag 'noforce) (ediff-get-fine-diff-vector n 'A))
681 (if (ediff-no-fine-diffs-p n)
682 (message
683 "Only white-space differences in region %d %s"
684 (1+ n)
685 (cond ((eq (ediff-no-fine-diffs-p n) 'A)
686 "in buffers B & C")
687 ((eq (ediff-no-fine-diffs-p n) 'B)
688 "in buffers A & C")
689 ((eq (ediff-no-fine-diffs-p n) 'C)
690 "in buffers A & B")
691 (t "")))))
692 ;; don't compute fine diffs for this region
693 ((eq flag 'skip)
694 (or (ediff-get-fine-diff-vector n 'A)
695 (memq ediff-auto-refine '(off nix))
696 (ediff-message-if-verbose
697 "Region %d exceeds the auto-refinement limit. Type `%s' to refine"
698 (1+ n)
699 (substitute-command-keys
700 "\\[ediff-make-or-kill-fine-diffs]")
703 ;; recompute fine diffs
704 (ediff-wordify
705 (ediff-get-diff-posn 'A 'beg n)
706 (ediff-get-diff-posn 'A 'end n)
707 ediff-buffer-A
708 tmp-buffer
709 ediff-control-buffer)
710 (setq file-A
711 (ediff-make-temp-file tmp-buffer "fineDiffA" file-A))
713 (ediff-wordify
714 (ediff-get-diff-posn 'B 'beg n)
715 (ediff-get-diff-posn 'B 'end n)
716 ediff-buffer-B
717 tmp-buffer
718 ediff-control-buffer)
719 (setq file-B
720 (ediff-make-temp-file tmp-buffer "fineDiffB" file-B))
722 (if ediff-3way-job
723 (progn
724 (ediff-wordify
725 (ediff-get-diff-posn 'C 'beg n)
726 (ediff-get-diff-posn 'C 'end n)
727 ediff-buffer-C
728 tmp-buffer
729 ediff-control-buffer)
730 (setq file-C
731 (ediff-make-temp-file
732 tmp-buffer "fineDiffC" file-C))))
734 ;; save temp file names.
735 (setq ediff-temp-file-A file-A
736 ediff-temp-file-B file-B
737 ediff-temp-file-C file-C)
739 ;; set the new vector of fine diffs, if none exists
740 (cond ((and ediff-3way-job whitespace-A)
741 (ediff-setup-fine-diff-regions nil file-B file-C n))
742 ((and ediff-3way-job whitespace-B)
743 (ediff-setup-fine-diff-regions file-A nil file-C n))
744 ((and ediff-3way-job
745 ;; In merge-jobs, whitespace-C is t, since
746 ;; ediff-empty-diff-region-p returns t in this case
747 whitespace-C)
748 (ediff-setup-fine-diff-regions file-A file-B nil n))
750 (ediff-setup-fine-diff-regions file-A file-B file-C n)))
752 (setq cumulative-fine-diff-length
753 (+ (length (ediff-get-fine-diff-vector n 'A))
754 (length (ediff-get-fine-diff-vector n 'B))
755 ;; in merge jobs, the merge buffer is never refined
756 (if (and file-C (not ediff-merge-job))
757 (length (ediff-get-fine-diff-vector n 'C))
758 0)))
760 (cond ((or
761 ;; all regions are white space
762 (and whitespace-A whitespace-B whitespace-C)
763 ;; none is white space and no fine diffs detected
764 (and (not whitespace-A)
765 (not whitespace-B)
766 (not (and ediff-3way-job whitespace-C))
767 (eq cumulative-fine-diff-length 0)))
768 (ediff-mark-diff-as-space-only n t)
769 (ediff-message-if-verbose
770 "Only white-space differences in region %d" (1+ n)))
771 ((eq cumulative-fine-diff-length 0)
772 (ediff-message-if-verbose
773 "Only white-space differences in region %d %s"
774 (1+ n)
775 (cond (whitespace-A (ediff-mark-diff-as-space-only n 'A)
776 "in buffers B & C")
777 (whitespace-B (ediff-mark-diff-as-space-only n 'B)
778 "in buffers A & C")
779 (whitespace-C (ediff-mark-diff-as-space-only n 'C)
780 "in buffers A & B"))))
782 (ediff-mark-diff-as-space-only n nil)))
784 ) ; end cond
785 (ediff-set-fine-diff-properties n)
788 ;; Interface to ediff-make-fine-diffs. Checks for auto-refine limit, etc.
789 (defun ediff-install-fine-diff-if-necessary (n)
790 (cond ((eq ediff-auto-refine 'on)
791 (if (and
792 (> ediff-auto-refine-limit
793 (- (ediff-get-diff-posn 'A 'end n)
794 (ediff-get-diff-posn 'A 'beg n)))
795 (> ediff-auto-refine-limit
796 (- (ediff-get-diff-posn 'B 'end n)
797 (ediff-get-diff-posn 'B 'beg n))))
798 (ediff-make-fine-diffs n 'noforce)
799 (ediff-make-fine-diffs n 'skip)))
801 ;; highlight iff fine diffs already exist
802 ((eq ediff-auto-refine 'off)
803 (ediff-make-fine-diffs n 'skip))))
806 ;; if fine diff vector is not set for diff N, then do nothing
807 (defun ediff-set-fine-diff-properties (n &optional default)
808 (or (not (ediff-has-face-support-p))
809 (< n 0)
810 (>= n ediff-number-of-differences)
811 ;; when faces are supported, set faces and priorities of fine overlays
812 (progn
813 (ediff-set-fine-diff-properties-in-one-buffer 'A n default)
814 (ediff-set-fine-diff-properties-in-one-buffer 'B n default)
815 (if ediff-3way-job
816 (ediff-set-fine-diff-properties-in-one-buffer 'C n default)))))
818 (defun ediff-set-fine-diff-properties-in-one-buffer (buf-type
819 n &optional default)
820 (let ((fine-diff-vector (ediff-get-fine-diff-vector n buf-type))
821 (face (if default
822 'default
823 (face-name
824 (ediff-get-symbol-from-alist
825 buf-type ediff-fine-diff-face-alist))))
826 (priority (if default
828 (1+ (or (ediff-overlay-get
829 (symbol-value
830 (ediff-get-symbol-from-alist
831 buf-type
832 ediff-current-diff-overlay-alist))
833 'priority)
834 0)))))
835 (mapcar (lambda (overl)
836 (ediff-set-overlay-face overl face)
837 (ediff-overlay-put overl 'priority priority))
838 fine-diff-vector)))
840 ;; Set overlays over the regions that denote delimiters
841 (defun ediff-set-fine-overlays-for-combined-merge (diff-list reg-num)
842 (let (overlay overlay-list)
843 (while diff-list
844 (condition-case nil
845 (setq overlay
846 (ediff-make-bullet-proof-overlay
847 (nth 0 diff-list) (nth 1 diff-list) ediff-buffer-C))
848 (error ""))
849 (setq overlay-list (cons overlay overlay-list))
850 (if (> (length diff-list) 1)
851 (setq diff-list (cdr (cdr diff-list)))
852 (error "ediff-set-fine-overlays-for-combined-merge: corrupt list of
853 delimiter regions"))
855 (setq overlay-list (reverse overlay-list))
856 (ediff-set-fine-diff-vector
857 reg-num 'C (apply 'vector overlay-list))
861 ;; Convert diff list to overlays for a given DIFF-REGION
862 ;; in buffer of type BUF-TYPE
863 (defun ediff-set-fine-overlays-in-one-buffer (buf-type diff-list region-num)
864 (let* ((current-diff -1)
865 (reg-start (ediff-get-diff-posn buf-type 'beg region-num))
866 (buff (ediff-get-buffer buf-type))
867 combined-merge-diff-list
868 diff-overlay-list list-element
869 begin end overlay)
871 (ediff-clear-fine-differences-in-one-buffer region-num buf-type)
872 (setq diff-list (cdr diff-list)) ; discard list type (words or points)
873 (ediff-with-current-buffer buff (goto-char reg-start))
875 ;; if it is a combined merge then set overlays in buff C specially
876 (if (and ediff-merge-job (eq buf-type 'C)
877 (setq combined-merge-diff-list
878 (ediff-looks-like-combined-merge region-num)))
879 (ediff-set-fine-overlays-for-combined-merge
880 combined-merge-diff-list region-num)
881 ;; regular fine diff
882 (while diff-list
883 (setq current-diff (1+ current-diff)
884 list-element (car diff-list)
885 begin (aref list-element (cond ((eq buf-type 'A) 0)
886 ((eq buf-type 'B) 2)
887 (t 4))) ; buf C
888 end (aref list-element (cond ((eq buf-type 'A) 1)
889 ((eq buf-type 'B) 3)
890 (t 5)))) ; buf C
891 (if (not (or begin end))
892 () ; skip this diff
893 ;; Put overlays at appropriate places in buffers
894 ;; convert lines to points, if necessary
895 (setq begin (ediff-goto-word (1+ begin) buff)
896 end (ediff-goto-word end buff 'end))
897 (setq overlay (ediff-make-bullet-proof-overlay begin end buff))
898 ;; record all overlays for this difference region
899 (setq diff-overlay-list (nconc diff-overlay-list (list overlay))))
901 (setq diff-list (cdr diff-list))
902 ) ; while
903 ;; convert the list of difference information into a vector
904 ;; for fast access
905 (ediff-set-fine-diff-vector
906 region-num buf-type (vconcat diff-overlay-list))
910 ;; Stolen from emerge.el
911 (defun ediff-get-diff3-group (file)
912 ;; This save-excursion allows ediff-get-diff3-group to be called for the
913 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
914 ;; appear in any order. The reason this is necessary is that Gnu diff3
915 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
916 (save-excursion
917 (re-search-forward
918 (concat "^" file ":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
919 (beginning-of-line 2)
920 ;; treatment depends on whether it is an "a" group or a "c" group
921 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
922 ;; it is a "c" group
923 (if (match-beginning 2)
924 ;; it has two numbers
925 (list (string-to-int
926 (buffer-substring (match-beginning 1) (match-end 1)))
927 (1+ (string-to-int
928 (buffer-substring (match-beginning 3) (match-end 3)))))
929 ;; it has one number
930 (let ((x (string-to-int
931 (buffer-substring (match-beginning 1) (match-end 1)))))
932 (list x (1+ x))))
933 ;; it is an "a" group
934 (let ((x (1+ (string-to-int
935 (buffer-substring (match-beginning 1) (match-end 1))))))
936 (list x x)))))
939 ;; If WORD-MODE, construct vector of diffs using word numbers.
940 ;; Else, use point values.
941 ;; WORD-MODE also tells if we are in the word-mode or not.
942 ;; If THREE-WAY-COMP, then it is a 3-way comparison. Else, it is merging
943 ;; with ancestor, in which case buffer-C contents is identical to buffer-A/B,
944 ;; contents (unless buffer-A is narrowed) depending on ediff-default-variant's
945 ;; value.
946 ;; BOUNDS specifies visibility bounds to use.
947 (defun ediff-extract-diffs3 (diff-buffer word-mode three-way-comp
948 &optional bounds)
949 (let ((A-buffer ediff-buffer-A)
950 (B-buffer ediff-buffer-B)
951 (C-buffer ediff-buffer-C)
952 (anc-buffer ediff-ancestor-buffer)
953 (a-prev 1) ; needed to set the first diff line correctly
954 (b-prev 1)
955 (c-prev 1)
956 (anc-prev 1)
957 diff-list shift-A shift-B shift-C
960 ;; diff list contains word numbers or points, depending on word-mode
961 (setq diff-list (cons (if word-mode 'words 'points)
962 diff-list))
963 (if bounds
964 (setq shift-A
965 (ediff-overlay-start
966 (ediff-get-value-according-to-buffer-type 'A bounds))
967 shift-B
968 (ediff-overlay-start
969 (ediff-get-value-according-to-buffer-type 'B bounds))
970 shift-C
971 (if three-way-comp
972 (ediff-overlay-start
973 (ediff-get-value-according-to-buffer-type 'C bounds)))))
975 ;; reset point in buffers A, B, C
976 (ediff-with-current-buffer A-buffer
977 (goto-char (if shift-A shift-A (point-min))))
978 (ediff-with-current-buffer B-buffer
979 (goto-char (if shift-B shift-B (point-min))))
980 (if three-way-comp
981 (ediff-with-current-buffer C-buffer
982 (goto-char (if shift-C shift-C (point-min)))))
983 (if (ediff-buffer-live-p anc-buffer)
984 (ediff-with-current-buffer anc-buffer
985 (goto-char (point-min))))
987 (ediff-with-current-buffer diff-buffer
988 (goto-char (point-min))
989 (while (re-search-forward ediff-match-diff3-line nil t)
990 ;; leave point after matched line
991 (beginning-of-line 2)
992 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
993 ;; if the files A and B are the same and not 3way-comparison,
994 ;; ignore the difference
995 (if (or three-way-comp (not (string-equal agreement "3")))
996 (let* ((a-begin (car (ediff-get-diff3-group "1")))
997 (a-end (nth 1 (ediff-get-diff3-group "1")))
998 (b-begin (car (ediff-get-diff3-group "2")))
999 (b-end (nth 1 (ediff-get-diff3-group "2")))
1000 (c-or-anc-begin (car (ediff-get-diff3-group "3")))
1001 (c-or-anc-end (nth 1 (ediff-get-diff3-group "3")))
1002 (state-of-merge
1003 (cond ((string-equal agreement "1") 'prefer-A)
1004 ((string-equal agreement "2") 'prefer-B)
1005 (t ediff-default-variant)))
1006 (state-of-diff-merge
1007 (if (memq state-of-merge '(default-A prefer-A)) 'B 'A))
1008 (state-of-diff-comparison
1009 (cond ((string-equal agreement "1") 'A)
1010 ((string-equal agreement "2") 'B)
1011 ((string-equal agreement "3") 'C)))
1012 state-of-ancestor
1013 c-begin c-end
1014 a-begin-pt a-end-pt
1015 b-begin-pt b-end-pt
1016 c-begin-pt c-end-pt
1017 anc-begin-pt anc-end-pt)
1019 (setq state-of-ancestor
1020 (= c-or-anc-begin c-or-anc-end))
1022 (cond (three-way-comp
1023 (setq c-begin c-or-anc-begin
1024 c-end c-or-anc-end))
1025 ((eq ediff-default-variant 'default-B)
1026 (setq c-begin b-begin
1027 c-end b-end))
1029 (setq c-begin a-begin
1030 c-end a-end)))
1032 ;; compute main diff vector
1033 (if word-mode
1034 ;; make diff-list contain word numbers
1035 (setq diff-list
1036 (nconc diff-list
1037 (list (vector
1038 (- a-begin a-prev) (- a-end a-begin)
1039 (- b-begin b-prev) (- b-end b-begin)
1040 (- c-begin c-prev) (- c-end c-begin)
1041 nil nil ; dummy ancestor
1042 nil ; state of diff
1043 nil ; state of merge
1044 nil ; state of ancestor
1046 a-prev a-end
1047 b-prev b-end
1048 c-prev c-end)
1049 ;; else convert lines to points
1050 (ediff-with-current-buffer A-buffer
1051 (forward-line (- a-begin a-prev))
1052 (setq a-begin-pt (point))
1053 (forward-line (- a-end a-begin))
1054 (setq a-end-pt (point)
1055 a-prev a-end))
1056 (ediff-with-current-buffer B-buffer
1057 (forward-line (- b-begin b-prev))
1058 (setq b-begin-pt (point))
1059 (forward-line (- b-end b-begin))
1060 (setq b-end-pt (point)
1061 b-prev b-end))
1062 (ediff-with-current-buffer C-buffer
1063 (forward-line (- c-begin c-prev))
1064 (setq c-begin-pt (point))
1065 (forward-line (- c-end c-begin))
1066 (setq c-end-pt (point)
1067 c-prev c-end))
1068 (if (ediff-buffer-live-p anc-buffer)
1069 (ediff-with-current-buffer anc-buffer
1070 (forward-line (- c-or-anc-begin anc-prev))
1071 (setq anc-begin-pt (point))
1072 (forward-line (- c-or-anc-end c-or-anc-begin))
1073 (setq anc-end-pt (point)
1074 anc-prev c-or-anc-end)))
1075 (setq diff-list
1076 (nconc
1077 diff-list
1078 ;; if comparing with ancestor, then there also is a
1079 ;; state-of-difference marker
1080 (if three-way-comp
1081 (list (vector
1082 a-begin-pt a-end-pt
1083 b-begin-pt b-end-pt
1084 c-begin-pt c-end-pt
1085 nil nil ; ancestor begin/end
1086 state-of-diff-comparison
1087 nil ; state of merge
1088 nil ; state of ancestor
1090 (list (vector a-begin-pt a-end-pt
1091 b-begin-pt b-end-pt
1092 c-begin-pt c-end-pt
1093 anc-begin-pt anc-end-pt
1094 state-of-diff-merge
1095 state-of-merge
1096 state-of-ancestor
1101 ))) ; end ediff-with-current-buffer
1102 diff-list
1105 ;; Generate the difference vector and overlays for three files
1106 ;; File-C is either the third file to compare (in case of 3-way comparison)
1107 ;; or it is the ancestor file.
1108 (defun ediff-setup-diff-regions3 (file-A file-B file-C)
1109 (or (ediff-buffer-live-p ediff-diff-buffer)
1110 (setq ediff-diff-buffer
1111 (get-buffer-create (ediff-unique-buffer-name "*ediff-diff" "*"))))
1113 (message "Computing differences ...")
1114 (ediff-exec-process ediff-diff3-program ediff-diff-buffer 'synchronize
1115 ediff-diff3-options file-A file-B file-C)
1117 (ediff-prepare-error-list ediff-diff3-ok-lines-regexp ediff-diff-buffer)
1118 ;;(message "Computing differences ... done")
1119 (ediff-convert-diffs-to-overlays
1120 (ediff-extract-diffs3
1121 ediff-diff-buffer
1122 ediff-word-mode ediff-3way-comparison-job ediff-narrow-bounds)
1126 ;; Execute PROGRAM asynchronously, unless OS/2, Windows-*, or DOS, or unless
1127 ;; SYNCH is non-nil. BUFFER must be a buffer object, and must be alive. The
1128 ;; OPTIONS arg is a list of options to pass to PROGRAM. It may be a blank
1129 ;; string. All elements in FILES must be strings. We also delete nil from
1130 ;; args.
1131 (defun ediff-exec-process (program buffer synch options &rest files)
1132 (let ((data (match-data))
1133 (coding-system-for-read 'no-conversion)
1134 args)
1135 (setq args (append (split-string options) files))
1136 (setq args (delete "" (delq nil args))) ; delete nil and "" from arguments
1137 ;; the --binary option, if present, should be used only for buffer jobs
1138 ;; or for refining the differences
1139 (or (string-match "buffer" (symbol-name ediff-job-name))
1140 (eq buffer ediff-fine-diff-buffer)
1141 (setq args (delete "--binary" args)))
1142 (unwind-protect
1143 (let ((directory default-directory)
1144 proc)
1145 (save-excursion
1146 (set-buffer buffer)
1147 (erase-buffer)
1148 (setq default-directory directory)
1149 (if (or (memq system-type '(emx ms-dos windows-nt windows-95))
1150 synch)
1151 ;; In OS/2 (emx) do it synchronously, since OS/2 doesn't let us
1152 ;; delete files used by other processes. Thus, in ediff-buffers
1153 ;; and similar functions, we can't delete temp files because
1154 ;; they might be used by the asynch process that computes
1155 ;; custom diffs. So, we have to wait till custom diff
1156 ;; subprocess is done.
1157 ;; Similarly for Windows-*
1158 ;; In DOS, must synchronize because DOS doesn't have
1159 ;; asynchronous processes.
1160 (apply 'call-process program nil buffer nil args)
1161 ;; On other systems, do it asynchronously.
1162 (setq proc (get-buffer-process buffer))
1163 (if proc (kill-process proc))
1164 (setq proc
1165 (apply 'start-process "Custom Diff" buffer program args))
1166 (setq mode-line-process '(":%s"))
1167 (set-process-sentinel proc 'ediff-process-sentinel)
1168 (set-process-filter proc 'ediff-process-filter)
1170 (store-match-data data))))
1172 ;; This is shell-command-filter from simple.el in Emacs.
1173 ;; Copied here because XEmacs doesn't have it.
1174 (defun ediff-process-filter (proc string)
1175 ;; Do save-excursion by hand so that we can leave point numerically unchanged
1176 ;; despite an insertion immediately after it.
1177 (let* ((obuf (current-buffer))
1178 (buffer (process-buffer proc))
1179 opoint
1180 (window (get-buffer-window buffer))
1181 (pos (window-start window)))
1182 (unwind-protect
1183 (progn
1184 (set-buffer buffer)
1185 (or (= (point) (point-max))
1186 (setq opoint (point)))
1187 (goto-char (point-max))
1188 (insert-before-markers string))
1189 ;; insert-before-markers moved this marker: set it back.
1190 (set-window-start window pos)
1191 ;; Finish our save-excursion.
1192 (if opoint
1193 (goto-char opoint))
1194 (set-buffer obuf))))
1196 ;; like shell-command-sentinel but doesn't print an exit status message
1197 ;; we do this because diff always exits with status 1, if diffs are found
1198 ;; so shell-command-sentinel displays a confusing message to the user
1199 (defun ediff-process-sentinel (process signal)
1200 (if (and (memq (process-status process) '(exit signal))
1201 (buffer-name (process-buffer process)))
1202 (progn
1203 (save-excursion
1204 (set-buffer (process-buffer process))
1205 (setq mode-line-process nil))
1206 (delete-process process))))
1209 ;;; Word functions used to refine the current diff
1211 (defvar ediff-forward-word-function 'ediff-forward-word
1212 "*Function to call to move to the next word.
1213 Used for splitting difference regions into individual words.")
1215 (defvar ediff-whitespace " \n\t\f"
1216 "*Characters constituting white space.
1217 These characters are ignored when differing regions are split into words.")
1219 (defvar ediff-word-1 "a-zA-Z---_"
1220 "*Characters that constitute words of type 1.
1221 More precisely, [ediff-word-1] is a regexp that matches type 1 words.
1222 See `ediff-forward-word' for more details.")
1224 (defvar ediff-word-2 "0-9.,"
1225 "*Characters that constitute words of type 2.
1226 More precisely, [ediff-word-2] is a regexp that matches type 2 words.
1227 See `ediff-forward-word' for more details.")
1229 (defvar ediff-word-3 "`'?!:;\"{}[]()"
1230 "*Characters that constitute words of type 3.
1231 More precisely, [ediff-word-3] is a regexp that matches type 3 words.
1232 See `ediff-forward-word' for more details.")
1234 (defvar ediff-word-4
1235 (concat "^" ediff-word-1 ediff-word-2 ediff-word-3 ediff-whitespace)
1236 "*Characters that constitute words of type 4.
1237 More precisely, [ediff-word-4] is a regexp that matches type 4 words.
1238 See `ediff-forward-word' for more details.")
1240 ;; Split region along word boundaries. Each word will be on its own line.
1241 ;; Output to buffer out-buffer.
1242 (defun ediff-forward-word ()
1243 "Move point one word forward.
1244 There are four types of words, each of which consists entirely of
1245 characters in `ediff-word-1', `ediff-word-2', `ediff-word-3', or
1246 `ediff-word-4'. Words are recognized by passing these one after another as
1247 arguments to `skip-chars-forward'."
1248 (or (> (+ (skip-chars-forward ediff-word-1)
1249 (skip-syntax-forward "w"))
1251 (> (skip-chars-forward ediff-word-2) 0)
1252 (> (skip-chars-forward ediff-word-3) 0)
1253 (> (skip-chars-forward ediff-word-4) 0)
1257 (defun ediff-wordify (beg end in-buffer out-buffer &optional control-buf)
1258 (let (inbuf-syntax-tbl sv-point string)
1259 (save-excursion
1260 (set-buffer in-buffer)
1261 (setq inbuf-syntax-tbl (syntax-table))
1262 (setq string (buffer-substring-no-properties beg end))
1264 (set-buffer out-buffer)
1265 ;; Make sure that temp buff syntax table is the same a the original buf
1266 ;; syntax tbl, because we use ediff-forward-word in both and
1267 ;; ediff-forward-word depends on the syntax classes of characters.
1268 (set-syntax-table inbuf-syntax-tbl)
1269 (erase-buffer)
1270 (insert string)
1271 (goto-char (point-min))
1272 (skip-chars-forward ediff-whitespace)
1273 (delete-region (point-min) (point))
1275 (while (not (eobp))
1276 ;; eval incontrol buf to let user create local versions for
1277 ;; different invocations
1278 (if control-buf
1279 (funcall
1280 (ediff-with-current-buffer
1281 control-buf ediff-forward-word-function))
1282 (funcall ediff-forward-word-function))
1283 (setq sv-point (point))
1284 (skip-chars-forward ediff-whitespace)
1285 (delete-region sv-point (point))
1286 (insert "\n")))))
1288 ;; copy string from BEG END from IN-BUF to OUT-BUF
1289 (defun ediff-copy-to-buffer (beg end in-buffer out-buffer)
1290 (let (string)
1291 (save-excursion
1292 (set-buffer in-buffer)
1293 (setq string (buffer-substring beg end))
1295 (set-buffer out-buffer)
1296 (erase-buffer)
1297 (insert string)
1298 (goto-char (point-min)))))
1301 ;; goto word #n starting at current position in buffer `buf'
1302 ;; For ediff, a word is either a string of a-z,A-Z, incl `-' and `_';
1303 ;; or a string of other non-blanks. A blank is a \n\t\f
1304 ;; If `flag' is non-nil, goto the end of the n-th word.
1305 (defun ediff-goto-word (n buf &optional flag)
1306 ;; remember val ediff-forward-word-function has in ctl buf
1307 (let ((fwd-word-fun ediff-forward-word-function))
1308 (ediff-with-current-buffer buf
1309 (skip-chars-forward ediff-whitespace)
1310 (while (> n 1)
1311 (funcall fwd-word-fun)
1312 (skip-chars-forward ediff-whitespace)
1313 (setq n (1- n)))
1314 (if (and flag (> n 0))
1315 (funcall fwd-word-fun))
1316 (point))))
1318 (defun ediff-same-file-contents (f1 f2)
1319 "T if F1 and F2 have identical contents."
1320 (let ((res
1321 (apply 'call-process ediff-cmp-program nil nil nil
1322 (append ediff-cmp-options (list f1 f2)))))
1323 (and (numberp res) (eq res 0))))
1326 ;;; Local Variables:
1327 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1328 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1329 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1330 ;;; End:
1333 ;; ediff-diff.el ends here