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