1 ;;; ediff-util.el --- the core commands and utilities of ediff
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)
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.
29 (defvar ediff-patch-diagnostics
)
30 (defvar ediff-patchbufer
)
31 (defvar ediff-toolbar
)
32 (defvar ediff-toolbar-3way
)
33 (defvar bottom-toolbar
)
34 (defvar bottom-toolbar-visible-p
)
35 (defvar bottom-toolbar-height
)
39 (let ((load-path (cons (expand-file-name ".") load-path
)))
40 (or (featurep 'ediff-init
)
41 (load "ediff-init.el" nil nil
'nosuffix
))
42 (or (featurep 'ediff-help
)
43 (load "ediff-help.el" nil nil
'nosuffix
))
44 (or (featurep 'ediff-mult
)
45 (load "ediff-mult.el" nil nil
'nosuffix
))
46 (or (featurep 'ediff-wind
)
47 (load "ediff-wind.el" nil nil
'nosuffix
))
48 (or (featurep 'ediff-diff
)
49 (load "ediff-diff.el" nil nil
'nosuffix
))
50 (or (featurep 'ediff-merg
)
51 (load "ediff-merg.el" nil nil
'nosuffix
))
53 (load "ediff.el" nil nil
'nosuffix
))
54 (or (featurep 'ediff-tbar
)
55 (load "ediff-tbar.el" 'noerror nil
'nosuffix
))
67 ;; be careful with ediff-tbar
72 (defun ediff-use-toolbar-p () nil
)))
73 (defun ediff-use-toolbar-p () nil
))
79 "Ediff mode controls all operations in a single Ediff session.
80 This mode is entered through one of the following commands:
91 `ediff-merge-files-with-ancestor'
93 `ediff-merge-buffers-with-ancestor'
94 `ediff-merge-revisions'
95 `ediff-merge-revisions-with-ancestor'
96 `ediff-windows-wordwise'
97 `ediff-windows-linewise'
98 `ediff-regions-wordwise'
99 `ediff-regions-linewise'
109 (kill-all-local-variables)
110 (setq major-mode
'ediff-mode
)
111 (setq mode-name
"Ediff")
112 (run-hooks 'ediff-mode-hook
))
118 (ediff-defvar-local ediff-mode-map nil
119 "Local keymap used in Ediff mode.
120 This is local to each Ediff Control Panel, so they may vary from invocation
123 ;; Set up the keymap in the control buffer
124 (defun ediff-set-keys ()
125 "Set up Ediff keymap, if necessary."
126 (if (null ediff-mode-map
)
127 (ediff-setup-keymap))
128 (use-local-map ediff-mode-map
))
130 ;; Reload Ediff keymap. For debugging only.
131 (defun ediff-reload-keymap ()
133 (setq ediff-mode-map nil
)
137 (defun ediff-setup-keymap ()
138 "Set up the keymap used in the control buffer of Ediff."
139 (setq ediff-mode-map
(make-sparse-keymap))
140 (suppress-keymap ediff-mode-map
)
142 (define-key ediff-mode-map
143 (if ediff-emacs-p
[mouse-2
] [button2]) 'ediff-help-for-quick-help)
144 (define-key ediff-mode-map "\C-m" 'ediff-help-for-quick-help)
146 (define-key ediff-mode-map "p" 'ediff-previous-difference)
147 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
148 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
149 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
150 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
151 'ediff-previous-difference nil))
152 (define-key ediff-mode-map "n" 'ediff-next-difference)
153 (define-key ediff-mode-map " " 'ediff-next-difference)
154 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
155 (define-key ediff-mode-map "g" nil)
156 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
157 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
158 (define-key ediff-mode-map "q" 'ediff-quit)
159 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
160 (define-key ediff-mode-map "z" 'ediff-suspend)
161 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
162 (define-key ediff-mode-map "|" 'ediff-toggle-split)
163 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
165 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
167 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
168 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
169 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
170 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
171 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
172 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
173 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
174 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
175 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
176 (define-key ediff-mode-map "i" 'ediff-status-info)
177 (define-key ediff-mode-map "E" 'ediff-documentation)
178 (define-key ediff-mode-map "?" 'ediff-toggle-help)
179 (define-key ediff-mode-map "!" 'ediff-update-diffs)
180 (define-key ediff-mode-map "M" 'ediff-show-meta-buffer)
181 (define-key ediff-mode-map "R" 'ediff-show-registry)
183 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
184 (define-key ediff-mode-map "a" nil)
185 (define-key ediff-mode-map "b" nil)
186 (define-key ediff-mode-map "r" nil)
187 (cond (ediff-merge-job
188 ;; Will barf if no ancestor
189 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
190 ;; In merging, we allow only A->C and B->C copying.
191 (define-key ediff-mode-map "a" 'ediff-copy-A-to-C)
192 (define-key ediff-mode-map "b" 'ediff-copy-B-to-C)
193 (define-key ediff-mode-map "r" 'ediff-restore-diff-in-merge-buffer)
194 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
195 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
196 (define-key ediff-mode-map "$" 'ediff-toggle-show-clashes-only)
197 (define-key ediff-mode-map "&" 'ediff-re-merge))
198 (ediff-3way-comparison-job
199 (define-key ediff-mode-map "ab" 'ediff-copy-A-to-B)
200 (define-key ediff-mode-map "ba" 'ediff-copy-B-to-A)
201 (define-key ediff-mode-map "ac" 'ediff-copy-A-to-C)
202 (define-key ediff-mode-map "bc" 'ediff-copy-B-to-C)
203 (define-key ediff-mode-map "c" nil)
204 (define-key ediff-mode-map "ca" 'ediff-copy-C-to-A)
205 (define-key ediff-mode-map "cb" 'ediff-copy-C-to-B)
206 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
207 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
208 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
209 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
210 (t ; 2-way comparison
211 (define-key ediff-mode-map "a" 'ediff-copy-A-to-B)
212 (define-key ediff-mode-map "b" 'ediff-copy-B-to-A)
213 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
214 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
216 (define-key ediff-mode-map "G" 'ediff-submit-report)
217 (define-key ediff-mode-map "#" nil)
218 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
219 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
221 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
222 (define-key ediff-mode-map "o" nil)
223 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
224 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
225 (define-key ediff-mode-map "w" nil)
226 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
227 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
228 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
229 (define-key ediff-mode-map "=" 'ediff-inferior-compare-regions)
230 (if (fboundp 'ediff-show-patch-diagnostics)
231 (define-key ediff-mode-map "P" 'ediff-show-patch-diagnostics))
234 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
235 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
238 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
240 ;; Allow ediff-mode-map to be referenced indirectly
241 (fset 'ediff-mode-map ediff-mode-map)
242 (run-hooks 'ediff-keymap-setup-hook))
247 ;; Common startup entry for all Ediff functions It now returns control buffer
248 ;; so other functions can do post-processing SETUP-PARAMETERS is a list of the
249 ;; form ((param .val) (param . val)...) This serves a similar purpose to
250 ;; STARTUP-HOOKS, but these parameters are set in the new control buffer right
251 ;; after this buf is created and before any windows are set and such.
252 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
253 startup-hooks setup-parameters)
254 ;; ediff-convert-standard-filename puts file names in the form appropriate
255 ;; for the OS at hand.
256 (setq file-A (ediff-convert-standard-filename (expand-file-name file-A)))
257 (setq file-B (ediff-convert-standard-filename (expand-file-name file-B)))
260 (ediff-convert-standard-filename (expand-file-name file-C))))
261 (let* ((control-buffer-name
262 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
263 (control-buffer (ediff-with-current-buffer buffer-A
264 (get-buffer-create control-buffer-name))))
265 (ediff-with-current-buffer control-buffer
268 (make-local-variable 'ediff-use-long-help-message)
269 (make-local-variable 'ediff-prefer-iconified-control-frame)
270 (make-local-variable 'ediff-split-window-function)
271 (make-local-variable 'ediff-default-variant)
272 (make-local-variable 'ediff-merge-window-share)
273 (make-local-variable 'ediff-window-setup-function)
274 (make-local-variable 'ediff-keep-variants)
276 ;; unwrap set up parameters passed as argument
277 (while setup-parameters
278 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
279 (setq setup-parameters (cdr setup-parameters)))
281 ;; set variables classifying the current ediff job
282 ;; must come AFTER setup-parameters
283 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
284 ediff-merge-job (ediff-merge-job)
285 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
286 ediff-3way-job (ediff-3way-job)
287 ediff-diff3-job (ediff-diff3-job)
288 ediff-narrow-job (ediff-narrow-job)
289 ediff-windows-job (ediff-windows-job)
290 ediff-word-mode-job (ediff-word-mode-job))
292 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
293 ;; This is because u may loose work---dangerous.
294 (if (string-match "buffer" (symbol-name ediff-job-name))
295 (setq ediff-keep-variants t))
297 (make-local-hook 'pre-command-hook)
298 (if (ediff-window-display-p)
299 (add-hook 'pre-command-hook 'ediff-spy-after-mouse nil t))
300 (setq ediff-mouse-pixel-position (mouse-pixel-position))
302 ;; adjust for merge jobs
305 ;; If default variant is `combined', the right stuff is
306 ;; inserted by ediff-do-merge
307 ;; Note: at some point, we tried to put ancestor buffer here
308 ;; (which is currently buffer C. This didn't work right
309 ;; because the merge buffer will contain lossage: diff regions
310 ;; in the ancestor, which correspond to revisions that agree
311 ;; in both buf A and B.
312 (cond ((eq ediff-default-variant 'default-B)
316 (setq ediff-split-window-function
317 ediff-merge-split-window-function)
319 ;; remember the ancestor buffer, if any
320 (setq ediff-ancestor-buffer buffer-C)
324 (ediff-unique-buffer-name "*ediff-merge" "*")))
326 (set-buffer buffer-C)
328 (funcall (ediff-with-current-buffer buf major-mode))
329 ;; after Stig@hackvan.com
330 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode nil t)
332 (setq buffer-read-only nil
333 ediff-buffer-A buffer-A
334 ediff-buffer-B buffer-B
335 ediff-buffer-C buffer-C
336 ediff-control-buffer control-buffer)
338 (setq ediff-control-buffer-suffix
339 (if (string-match "<[0-9]*>" control-buffer-name)
340 (substring control-buffer-name
341 (match-beginning 0) (match-end 0))
343 ediff-control-buffer-number
349 ediff-control-buffer-suffix
351 (string-match "[0-9]+" ediff-control-buffer-suffix)
354 (setq ediff-error-buffer
355 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
357 (ediff-with-current-buffer buffer-A (ediff-strip-mode-line-format))
358 (ediff-with-current-buffer buffer-B (ediff-strip-mode-line-format))
360 (ediff-with-current-buffer buffer-C (ediff-strip-mode-line-format)))
361 (if (ediff-buffer-live-p ediff-ancestor-buffer)
362 (ediff-with-current-buffer ediff-ancestor-buffer
363 (ediff-strip-mode-line-format)))
365 (ediff-save-protected-variables) ; save variables to be restored on exit
367 ;; ediff-setup-diff-regions-function must be set after setup
368 ;; parameters are processed.
369 (setq ediff-setup-diff-regions-function
371 'ediff-setup-diff-regions3
372 'ediff-setup-diff-regions))
374 (setq ediff-wide-bounds
375 (list (ediff-make-bullet-proof-overlay
376 '(point-min) '(point-max) ediff-buffer-A)
377 (ediff-make-bullet-proof-overlay
378 '(point-min) '(point-max) ediff-buffer-B)
379 (ediff-make-bullet-proof-overlay
380 '(point-min) '(point-max) ediff-buffer-C)))
382 ;; This has effect only on ediff-windows/regions
383 ;; In all other cases, ediff-visible-region sets visibility bounds to
384 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
385 (if ediff-start-narrowed
386 (setq ediff-visible-bounds ediff-narrow-bounds)
387 (setq ediff-visible-bounds ediff-wide-bounds))
389 (ediff-set-keys) ; comes after parameter setup
391 ;; set up ediff-narrow-bounds, if not set
392 (or ediff-narrow-bounds
393 (setq ediff-narrow-bounds ediff-wide-bounds))
395 ;; All these must be inside ediff-with-current-buffer control-buffer,
396 ;; since these vars are local to control-buffer
397 ;; These won't run if there are errors in diff
398 (ediff-with-current-buffer ediff-buffer-A
399 (ediff-nuke-selective-display)
400 (run-hooks 'ediff-prepare-buffer-hook)
401 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
402 (setq buffer-read-only t))
403 ;; add control-buffer to the list of sessions--no longer used, but may
404 ;; be used again in the future
405 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
406 (setq ediff-this-buffer-ediff-sessions
407 (cons control-buffer ediff-this-buffer-ediff-sessions)))
408 (if ediff-make-buffers-readonly-at-startup
409 (setq buffer-read-only t))
412 (ediff-with-current-buffer ediff-buffer-B
413 (ediff-nuke-selective-display)
414 (run-hooks 'ediff-prepare-buffer-hook)
415 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
416 (setq buffer-read-only t))
417 ;; add control-buffer to the list of sessions
418 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
419 (setq ediff-this-buffer-ediff-sessions
420 (cons control-buffer ediff-this-buffer-ediff-sessions)))
421 (if ediff-make-buffers-readonly-at-startup
422 (setq buffer-read-only t))
426 (ediff-with-current-buffer ediff-buffer-C
427 (ediff-nuke-selective-display)
428 (run-hooks 'ediff-prepare-buffer-hook)
429 ;; add control-buffer to the list of sessions
430 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
431 (setq ediff-this-buffer-ediff-sessions
433 ediff-this-buffer-ediff-sessions)))
434 (if ediff-make-buffers-readonly-at-startup
435 (setq buffer-read-only t))
438 (if (ediff-buffer-live-p ediff-ancestor-buffer)
439 (ediff-with-current-buffer ediff-ancestor-buffer
440 (ediff-nuke-selective-display)
441 (setq buffer-read-only t)
442 (run-hooks 'ediff-prepare-buffer-hook)
443 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
444 (setq ediff-this-buffer-ediff-sessions
446 ediff-this-buffer-ediff-sessions)))
449 ;; must come after setting up ediff-narrow-bounds AND after
450 ;; nuking selective display
451 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
452 (setq ediff-number-of-differences (length ediff-difference-vector-A))
453 (setq ediff-current-difference -1)
455 (ediff-make-current-diff-overlay 'A)
456 (ediff-make-current-diff-overlay 'B)
458 (ediff-make-current-diff-overlay 'C))
459 (if ediff-merge-with-ancestor-job
460 (ediff-make-current-diff-overlay 'Ancestor))
462 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
464 (let ((shift-A (ediff-overlay-start
465 (ediff-get-value-according-to-buffer-type
466 'A ediff-narrow-bounds)))
467 (shift-B (ediff-overlay-start
468 (ediff-get-value-according-to-buffer-type
469 'B ediff-narrow-bounds)))
470 (shift-C (ediff-overlay-start
471 (ediff-get-value-according-to-buffer-type
472 'C ediff-narrow-bounds))))
473 ;; position point in buf A
475 (select-window ediff-window-A)
477 ;; position point in buf B
479 (select-window ediff-window-B)
483 (select-window ediff-window-C)
484 (goto-char shift-C)))
487 (select-window ediff-control-window)
488 (ediff-visible-region)
490 (run-hooks 'startup-hooks)
491 (ediff-refresh-mode-lines)
492 (setq buffer-read-only t)
493 (setq ediff-session-registry
494 (cons control-buffer ediff-session-registry))
495 (ediff-update-registry)
496 (if (ediff-buffer-live-p ediff-meta-buffer)
497 (ediff-update-meta-buffer ediff-meta-buffer))
498 (run-hooks 'ediff-startup-hook)
499 ) ; eval in control-buffer
503 ;; This function assumes that we are in the window where control buffer is
505 (defun ediff-setup-control-buffer (ctl-buf)
506 "Set up window for control buffer."
507 (if (window-dedicated-p (selected-window))
508 (set-buffer ctl-buf) ; we are in control frame but just in case
509 (switch-to-buffer ctl-buf))
510 (let ((window-min-height 2))
512 (ediff-set-help-message)
513 (insert ediff-help-message)
514 (shrink-window-if-larger-than-buffer)
515 (or (ediff-multiframe-setup-p)
516 (ediff-indent-help-message))
517 (ediff-set-help-overlays)
519 (set-buffer-modified-p nil)
520 (ediff-refresh-mode-lines)
521 (setq ediff-control-window (selected-window))
522 (setq ediff-window-config-saved
523 (format "%S%S%S%S%S%S%S"
528 ediff-split-window-function
529 (ediff-multiframe-setup-p)
530 ediff-wide-display-p))
532 ;; In multiframe, toolbar is set in ediff-setup-control-frame
533 (if (not (ediff-multiframe-setup-p))
534 (ediff-make-bottom-toolbar)) ; this checks if toolbar is requested
535 (goto-char (point-min))
536 (skip-chars-forward ediff-whitespace)))
541 ;;; Commands for working with Ediff
543 (defun ediff-update-diffs ()
544 "Recompute difference regions in buffers A, B, and C.
545 Buffers are not synchronized with their respective files, so changes done
546 to these buffers are not saved at this point---the user can do this later,
549 (ediff-barf-if-not-control-buffer)
550 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
553 "Ancestor buffer will not be used. Recompute diffs anyway? ")))
554 (error "Recomputation of differences canceled"))
556 (let ((point-A (ediff-with-current-buffer ediff-buffer-A (point)))
557 ;;(point-B (ediff-with-current-buffer ediff-buffer-B (point)))
558 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
559 (buf-A-file-name (buffer-file-name ediff-buffer-A))
560 (buf-B-file-name (buffer-file-name ediff-buffer-B))
561 ;; (null ediff-buffer-C) is no problem, as we later check if
562 ;; ediff-buffer-C is alive
563 (buf-C-file-name (buffer-file-name ediff-buffer-C))
564 (overl-A (ediff-get-value-according-to-buffer-type
565 'A ediff-narrow-bounds))
566 (overl-B (ediff-get-value-according-to-buffer-type
567 'B ediff-narrow-bounds))
568 (overl-C (ediff-get-value-according-to-buffer-type
569 'C ediff-narrow-bounds))
570 beg-A end-A beg-B end-B beg-C end-C
571 file-A file-B file-C)
573 (if (stringp buf-A-file-name)
574 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
575 (if (stringp buf-B-file-name)
576 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
577 (if (stringp buf-C-file-name)
578 (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
580 (ediff-unselect-and-select-difference -1)
582 (setq beg-A (ediff-overlay-start overl-A)
583 beg-B (ediff-overlay-start overl-B)
584 beg-C (ediff-overlay-start overl-C)
585 end-A (ediff-overlay-end overl-A)
586 end-B (ediff-overlay-end overl-B)
587 end-C (ediff-overlay-end overl-C))
591 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
592 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
593 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
594 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
597 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
598 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
601 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
602 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
604 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
607 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
608 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
609 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
610 (ediff-clear-diff-vector
611 'ediff-difference-vector-Ancestor 'fine-diffs-also)
612 ;; let them garbage collect. we can't use the ancestor after recomputing
614 (setq ediff-difference-vector-Ancestor nil
615 ediff-ancestor-buffer nil
616 ediff-state-of-merge nil)
618 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
620 ;; In case of merge job, fool it into thinking that it is just doing
622 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
623 (ediff-3way-comparison-job ediff-3way-comparison-job)
624 (ediff-merge-job ediff-merge-job)
625 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
626 (ediff-job-name ediff-job-name))
628 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
629 ediff-3way-comparison-job t
631 ediff-merge-with-ancestor-job nil
632 ediff-job-name 'ediff-files3))
633 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
635 (setq ediff-number-of-differences (length ediff-difference-vector-A))
639 (delete-file file-C))
642 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
644 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
648 ;; Not bound to any key---to dangerous. A user can do it if necessary.
649 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
650 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
652 (ediff-barf-if-not-control-buffer)
653 (let ((bufA ediff-buffer-A)
654 (bufB ediff-buffer-B)
655 (bufC ediff-buffer-C)
656 (ctl-buf ediff-control-buffer)
657 (keep-variants ediff-keep-variants)
658 (ancestor-buf ediff-ancestor-buffer)
659 (ancestor-job ediff-merge-with-ancestor-job)
660 (merge ediff-merge-job)
661 (comparison ediff-3way-comparison-job))
662 (ediff-with-current-buffer bufA
663 (revert-buffer t noconfirm))
664 (ediff-with-current-buffer bufB
665 (revert-buffer t noconfirm))
666 ;; this should only be executed in a 3way comparison, not in merge
668 (ediff-with-current-buffer bufC
669 (revert-buffer t noconfirm)))
673 ;; the argument says whether to reverse the meaning of
674 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
676 (ediff-really-quit (not keep-variants))
679 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
680 (ediff-merge-buffers bufA bufB)))
681 (ediff-update-diffs))))
684 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
685 (defun ediff-recenter (&optional no-rehighlight)
686 "Bring the highlighted region of all buffers being compared into view.
687 Reestablish the default three-window display."
689 (ediff-barf-if-not-control-buffer)
691 ;; ;; No longer needed: XEmacs has surrogate minibuffers now.
692 ;; (if ediff-xemacs-p (setq synchronize-minibuffers t))
694 (let (buffer-read-only)
695 (if (and (ediff-buffer-live-p ediff-buffer-A)
696 (ediff-buffer-live-p ediff-buffer-B)
697 (or (not ediff-3way-job)
698 (ediff-buffer-live-p ediff-buffer-C)))
700 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
701 (or (eq this-command 'ediff-quit)
702 (message ediff-KILLED-VITAL-BUFFER
706 ;; set visibility range appropriate to this invocation of Ediff.
707 (ediff-visible-region)
709 (if (and (ediff-window-display-p)
710 (symbolp this-command)
711 (symbolp last-command)
712 ;; Either one of the display-changing commands
713 (or (memq this-command
715 ediff-dir-action ediff-registry-action
717 ediff-toggle-wide-display ediff-toggle-multiframe))
718 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
719 ;; This avoids raising frames unnecessarily.
720 (and (memq this-command
721 '(ediff-next-difference
722 ediff-previous-difference
723 ediff-jump-to-difference
724 ediff-jump-to-difference-at-point))
725 (not (string-match "^ediff-" (symbol-name last-command)))
728 (if (window-live-p ediff-window-A)
729 (raise-frame (window-frame ediff-window-A)))
730 (if (window-live-p ediff-window-B)
731 (raise-frame (window-frame ediff-window-B)))
732 (if (window-live-p ediff-window-C)
733 (raise-frame (window-frame ediff-window-C)))))
734 (if (and (ediff-window-display-p)
735 (frame-live-p ediff-control-frame)
736 (not ediff-use-long-help-message)
737 (not (ediff-frame-iconified-p ediff-control-frame)))
738 (raise-frame ediff-control-frame))
740 ;; Redisplay whatever buffers are showing, if there is a selected difference
741 (let ((control-frame ediff-control-frame)
742 (control-buf ediff-control-buffer))
743 (if (and (ediff-buffer-live-p ediff-buffer-A)
744 (ediff-buffer-live-p ediff-buffer-B)
745 (or (not ediff-3way-job)
746 (ediff-buffer-live-p ediff-buffer-C)))
749 (ediff-select-difference ediff-current-difference))
751 (ediff-recenter-one-window 'A)
752 (ediff-recenter-one-window 'B)
754 (ediff-recenter-one-window 'C))
756 (ediff-with-current-buffer control-buf
757 (ediff-recenter-ancestor) ; check if ancestor is alive
759 (if (and (ediff-multiframe-setup-p)
760 (not ediff-use-long-help-message)
761 (not (ediff-frame-iconified-p ediff-control-frame)))
762 ;; never grab mouse on quit in this place
765 (eq this-command 'ediff-quit))))
768 (ediff-restore-highlighting)
769 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
772 ;; this function returns to the window it was called from
773 ;; (which was the control window)
774 (defun ediff-recenter-one-window (buf-type)
775 (if (ediff-valid-difference-p)
776 ;; context must be saved before switching to windows A/B/C
777 (let* ((ctl-wind (selected-window))
778 (shift (ediff-overlay-start
779 (ediff-get-value-according-to-buffer-type
780 buf-type ediff-narrow-bounds)))
781 (job-name ediff-job-name)
782 (control-buf ediff-control-buffer)
783 (window-name (ediff-get-symbol-from-alist
784 buf-type ediff-window-alist))
785 (window (if (window-live-p (symbol-value window-name))
786 (symbol-value window-name))))
788 (if (and window ediff-windows-job)
789 (set-window-start window shift))
792 (select-window window)
793 (ediff-deactivate-mark)
794 (ediff-position-region
795 (ediff-get-diff-posn buf-type 'beg nil control-buf)
796 (ediff-get-diff-posn buf-type 'end nil control-buf)
797 (ediff-get-diff-posn buf-type 'beg nil control-buf)
800 (select-window ctl-wind)
803 (defun ediff-recenter-ancestor ()
804 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
806 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
807 (ediff-valid-difference-p))
808 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
809 (ctl-wind (selected-window))
810 (job-name ediff-job-name)
811 (ctl-buf ediff-control-buffer))
812 (ediff-with-current-buffer ediff-ancestor-buffer
813 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
816 (select-window window)
817 (ediff-position-region
818 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
819 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
820 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
822 (select-window ctl-wind)
826 ;; This will have to be refined for 3way jobs
827 (defun ediff-toggle-split ()
828 "Toggle vertical/horizontal window split.
829 Does nothing if file-A and file-B are in different frames."
831 (ediff-barf-if-not-control-buffer)
832 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
833 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
834 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
835 (frame-A (if wind-A (window-frame wind-A)))
836 (frame-B (if wind-B (window-frame wind-B)))
837 (frame-C (if wind-C (window-frame wind-C))))
838 (if (or (eq frame-A frame-B)
839 (not (frame-live-p frame-A))
840 (not (frame-live-p frame-B))
841 (if ediff-3way-comparison-job
842 (or (not (frame-live-p frame-C))
843 (eq frame-A frame-C) (eq frame-B frame-C))))
844 (setq ediff-split-window-function
845 (if (eq ediff-split-window-function 'split-window-vertically)
846 'split-window-horizontally
847 'split-window-vertically))
848 (message "Buffers being compared are in different frames"))
849 (ediff-recenter 'no-rehighlight)))
851 (defun ediff-toggle-hilit ()
852 "Switch between highlighting using ASCII flags and highlighting using faces.
853 On a dumb terminal, switches between ASCII highlighting and no highlighting."
855 (ediff-barf-if-not-control-buffer)
856 (if (not (ediff-has-face-support-p))
857 (if (eq ediff-highlighting-style 'ascii)
859 (message "ASCII highlighting flags removed")
860 (ediff-unselect-and-select-difference ediff-current-difference
862 (setq ediff-highlighting-style 'off))
863 (ediff-unselect-and-select-difference ediff-current-difference
865 (ediff-unselect-and-select-difference ediff-current-difference
867 ;; cycle through highlighting
868 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
869 (message "Unhighlighting unselected difference regions")
870 (setq ediff-highlight-all-diffs nil))
872 (message "Highlighting with ASCII flags")
873 (setq ediff-use-faces nil))
875 (message "Re-highlighting all difference regions")
876 (setq ediff-use-faces t
877 ediff-highlight-all-diffs t)))
879 (if (and ediff-use-faces ediff-highlight-all-diffs)
880 (ediff-paint-background-regions)
881 (ediff-paint-background-regions 'unhighlight))
883 (ediff-unselect-and-select-difference
884 ediff-current-difference 'select-only))
888 (defun ediff-toggle-autorefine ()
889 "Toggle auto-refine mode."
891 (ediff-barf-if-not-control-buffer)
893 (error "No fine differences in this mode"))
894 (cond ((eq ediff-auto-refine 'nix)
895 (setq ediff-auto-refine 'on)
896 (ediff-make-fine-diffs ediff-current-difference 'noforce)
897 (message "Auto-refining is ON"))
898 ((eq ediff-auto-refine 'on)
899 (message "Auto-refining is OFF")
900 (setq ediff-auto-refine 'off))
902 (ediff-set-fine-diff-properties ediff-current-difference 'default)
903 (message "Refinements are HIDDEN")
904 (setq ediff-auto-refine 'nix))
907 (defun ediff-show-ancestor ()
908 "Show the ancestor buffer in a suitable window."
911 (or (ediff-buffer-live-p ediff-ancestor-buffer)
912 (if ediff-merge-with-ancestor-job
913 (error "Lost connection to ancestor buffer...sorry")
914 (error "Not merging with ancestor")))
916 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
917 (raise-frame (window-frame wind)))
918 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
920 (defun ediff-make-or-kill-fine-diffs (arg)
921 "Compute fine diffs. With negative prefix arg, kill fine diffs.
922 In both cases, operates on the currrent difference region."
924 (ediff-barf-if-not-control-buffer)
926 (ediff-clear-fine-differences ediff-current-difference))
927 ((and (numberp arg) (< arg 0))
928 (ediff-clear-fine-differences ediff-current-difference))
929 (t (ediff-make-fine-diffs))))
932 (defun ediff-toggle-help ()
933 "Toggle short/long help message."
935 (ediff-barf-if-not-control-buffer)
936 (let (buffer-read-only)
938 (setq ediff-use-long-help-message (not ediff-use-long-help-message))
939 (ediff-set-help-message))
940 ;; remember the icon status of the control frame when the user requested
941 ;; full control message
942 (if (and ediff-use-long-help-message (ediff-multiframe-setup-p))
943 (setq ediff-prefer-iconified-control-frame
944 (ediff-frame-iconified-p ediff-control-frame)))
946 (setq ediff-window-config-saved "") ; force redisplay
947 (ediff-recenter 'no-rehighlight))
950 ;; If BUF, this is the buffer to toggle, not current buffer.
951 (defun ediff-toggle-read-only (&optional buf)
952 "Toggle read-only in current buffer.
953 If buffer is under version control and locked, check it out first.
954 If optional argument BUF is specified, toggle read-only in that buffer instead
955 of the current buffer."
957 (ediff-barf-if-not-control-buffer)
958 (let ((ctl-buf (if (null buf) (current-buffer)))
959 (buf-type (ediff-char-to-buftype last-command-char)))
960 (or buf (ediff-recenter))
962 (setq buf (ediff-get-buffer buf-type)))
964 (ediff-with-current-buffer buf ; eval in buf A/B/C
965 (let* ((file (buffer-file-name buf))
966 (file-writable (and file
968 (file-writable-p file)))
969 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
970 ((ediff-file-checked-out-p file)
972 (file-writable 'toggle-read-only)
973 (t (key-binding "\C-x\C-q")))))
974 ;; If the file is checked in, make sure we don't make buffer modifiable
975 ;; without warning the user. The user can fool our checks by making the
976 ;; buffer non-RO without checking the file out. We regard this as a
978 (if (and (ediff-file-checked-in-p file)
979 ;; If ctl-buf is null, this means we called this
980 ;; non-interactively, in which case don't ask questions
982 (cond ((not buffer-read-only)
983 (setq toggle-ro-cmd 'toggle-read-only))
984 ((and (or (beep 1) t) ; always beep
987 "File %s is under version control. Check it out? "
988 (ediff-abbreviate-file-name file))))
989 ;; if we checked the file out, we should also change the
990 ;; original state of buffer-read-only to nil. If we don't
991 ;; do this, the mode line will show %%, since the file was
992 ;; RO before ediff started, so the user will think the file
994 (ediff-with-current-buffer ctl-buf
995 (ediff-change-saved-variable
996 'buffer-read-only nil buf-type)))
998 (setq toggle-ro-cmd 'toggle-read-only)
1001 "Boy, this is risky! Don't modify this file...")
1002 (sit-for 3)))) ; let the user see the warning
1003 (if (and toggle-ro-cmd
1004 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1006 (save-window-excursion
1007 (select-window (ediff-get-visible-buffer-window buf))
1008 (command-execute toggle-ro-cmd)))
1009 (error "Don't know how to toggle read-only in buffer %S" buf))
1011 ;; Check if we made the current buffer updatable, but its file is RO.
1012 ;; Signal a warning in this case.
1013 (if (and file (not buffer-read-only)
1014 (eq this-command 'ediff-toggle-read-only)
1015 (file-exists-p file)
1016 (not (file-writable-p file)))
1017 (message "Warning: file %s is read-only"
1018 (ediff-abbreviate-file-name file) (beep 1)))
1021 ;; checkout if visited file is checked in
1022 (defun ediff-maybe-checkout (buf)
1023 (let ((file (buffer-file-name buf))
1024 (checkout-function (key-binding "\C-x\C-q")))
1025 (if (and (ediff-file-checked-in-p file)
1029 "File %s is under version control. Check it out? "
1030 (ediff-abbreviate-file-name file))))
1031 (ediff-with-current-buffer buf
1032 (command-execute checkout-function)))))
1035 ;; This is a simple-minded check for whether a file is under version control.
1036 ;; If file,v exists but file doesn't, this file is considered to be not checked
1037 ;; in and not checked out for the purpose of patching (since patch won't be
1038 ;; able to read such a file anyway).
1039 ;; FILE is a string representing file name
1040 (defun ediff-file-under-version-control (file)
1041 (let* ((filedir (file-name-directory file))
1042 (file-nondir (file-name-nondirectory file))
1043 (trial (concat file-nondir ",v"))
1044 (full-trial (concat filedir trial))
1045 (full-rcs-trial (concat filedir "RCS/" trial)))
1047 (file-exists-p file)
1050 (file-exists-p full-trial)
1051 ;; in FAT FS, `file,v' and `file' may turn out to be the same!
1052 ;; don't be fooled by this!
1053 (not (equal (file-attributes file)
1054 (file-attributes full-trial))))
1055 ;; check if a version is in RCS/ directory
1056 (file-exists-p full-rcs-trial)))
1059 (defun ediff-file-checked-out-p (file)
1060 (and (ediff-file-under-version-control file)
1061 (file-writable-p file)))
1062 (defun ediff-file-checked-in-p (file)
1063 (and (ediff-file-under-version-control file)
1064 (not (file-writable-p file))))
1066 (defun ediff-swap-buffers ()
1067 "Rotate the display of buffers A, B, and C."
1069 (ediff-barf-if-not-control-buffer)
1070 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1071 (let ((buf ediff-buffer-A)
1072 (values ediff-buffer-values-orig-A)
1073 (diff-vec ediff-difference-vector-A)
1074 (hide-regexp ediff-regexp-hide-A)
1075 (focus-regexp ediff-regexp-focus-A)
1076 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1077 (overlay (if (ediff-has-face-support-p)
1078 ediff-current-diff-overlay-A)))
1079 (if ediff-3way-comparison-job
1081 (set-window-buffer ediff-window-A ediff-buffer-C)
1082 (set-window-buffer ediff-window-B ediff-buffer-A)
1083 (set-window-buffer ediff-window-C ediff-buffer-B)
1085 (set-window-buffer ediff-window-A ediff-buffer-B)
1086 (set-window-buffer ediff-window-B ediff-buffer-A))
1087 ;; swap diff buffers
1088 (if ediff-3way-comparison-job
1089 (setq ediff-buffer-A ediff-buffer-C
1090 ediff-buffer-C ediff-buffer-B
1092 (setq ediff-buffer-A ediff-buffer-B
1093 ediff-buffer-B buf))
1095 ;; swap saved buffer characteristics
1096 (if ediff-3way-comparison-job
1097 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1098 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1099 ediff-buffer-values-orig-B values)
1100 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1101 ediff-buffer-values-orig-B values))
1103 ;; swap diff vectors
1104 (if ediff-3way-comparison-job
1105 (setq ediff-difference-vector-A ediff-difference-vector-C
1106 ediff-difference-vector-C ediff-difference-vector-B
1107 ediff-difference-vector-B diff-vec)
1108 (setq ediff-difference-vector-A ediff-difference-vector-B
1109 ediff-difference-vector-B diff-vec))
1111 ;; swap hide/focus regexp
1112 (if ediff-3way-comparison-job
1113 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1114 ediff-regexp-hide-C ediff-regexp-hide-B
1115 ediff-regexp-hide-B hide-regexp
1116 ediff-regexp-focus-A ediff-regexp-focus-C
1117 ediff-regexp-focus-C ediff-regexp-focus-B
1118 ediff-regexp-focus-B focus-regexp)
1119 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1120 ediff-regexp-hide-B hide-regexp
1121 ediff-regexp-focus-A ediff-regexp-focus-B
1122 ediff-regexp-focus-B focus-regexp))
1124 ;; The following is needed for XEmacs, since there one can't move
1125 ;; overlay to another buffer. In Emacs, this swap is redundant.
1126 (if (ediff-has-face-support-p)
1127 (if ediff-3way-comparison-job
1128 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1129 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1130 ediff-current-diff-overlay-B overlay)
1131 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1132 ediff-current-diff-overlay-B overlay)))
1135 (setq ediff-wide-bounds
1136 (cond (ediff-3way-comparison-job
1137 (list (nth 2 ediff-wide-bounds)
1138 (nth 0 ediff-wide-bounds)
1139 (nth 1 ediff-wide-bounds)))
1141 (list (nth 1 ediff-wide-bounds)
1142 (nth 0 ediff-wide-bounds)
1143 (nth 2 ediff-wide-bounds)))
1145 (list (nth 1 ediff-wide-bounds)
1146 (nth 0 ediff-wide-bounds)))))
1147 ;; swap narrow bounds
1148 (setq ediff-narrow-bounds
1149 (cond (ediff-3way-comparison-job
1150 (list (nth 2 ediff-narrow-bounds)
1151 (nth 0 ediff-narrow-bounds)
1152 (nth 1 ediff-narrow-bounds)))
1154 (list (nth 1 ediff-narrow-bounds)
1155 (nth 0 ediff-narrow-bounds)
1156 (nth 2 ediff-narrow-bounds)))
1158 (list (nth 1 ediff-narrow-bounds)
1159 (nth 0 ediff-narrow-bounds)))))
1160 (if wide-visibility-p
1161 (setq ediff-visible-bounds ediff-wide-bounds)
1162 (setq ediff-visible-bounds ediff-narrow-bounds))
1165 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1166 (ediff-recenter 'no-rehighlight)
1170 (defun ediff-toggle-wide-display ()
1171 "Toggle wide/regular display.
1172 This is especially useful when comparing buffers side-by-side."
1174 (ediff-barf-if-not-control-buffer)
1175 (or (ediff-window-display-p)
1176 (error "%sEmacs is not running as a window application"
1177 (if ediff-emacs-p "" "X")))
1178 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1179 (let ((ctl-buf ediff-control-buffer))
1180 (setq ediff-wide-display-p (not ediff-wide-display-p))
1181 (if (not ediff-wide-display-p)
1182 (ediff-with-current-buffer ctl-buf
1183 (modify-frame-parameters
1184 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1185 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1186 ;; restore control buf, since ctl window may have been deleted
1188 (set-buffer ctl-buf)
1189 (setq ediff-wide-display-orig-parameters nil
1190 ediff-window-B nil) ; force update of window config
1191 (ediff-recenter 'no-rehighlight))
1192 (funcall ediff-make-wide-display-function)
1193 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1194 (ediff-with-current-buffer ctl-buf
1195 (setq ediff-window-B nil) ; force update of window config
1196 (ediff-recenter 'no-rehighlight)))))
1199 (defun ediff-toggle-multiframe ()
1200 "Switch from multiframe display to single-frame display and back.
1201 To change the default, set the variable `ediff-window-setup-function',
1204 (let (window-setup-func)
1205 (or (ediff-window-display-p)
1206 (error "%sEmacs is not running as a window application"
1207 (if ediff-emacs-p "" "X")))
1209 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1210 (setq window-setup-func 'ediff-setup-windows-plain))
1211 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1212 (if (ediff-in-control-buffer-p)
1213 (ediff-kill-bottom-toolbar))
1214 (setq window-setup-func 'ediff-setup-windows-multiframe)))
1217 (setq-default ediff-window-setup-function window-setup-func)
1218 ;; change in all active ediff sessions
1219 (mapcar (function (lambda(buf)
1220 (ediff-with-current-buffer buf
1221 (setq ediff-window-setup-function window-setup-func
1222 ediff-window-B nil))))
1223 ediff-session-registry)
1224 (if (ediff-in-control-buffer-p)
1225 (ediff-recenter 'no-rehighlight))))
1229 (defun ediff-toggle-use-toolbar ()
1230 "Enable or disable Ediff toolbar.
1231 Works only in versions of Emacs that support toolbars.
1232 To change the default, set the variable `ediff-use-toolbar-p', which see."
1234 (if (featurep 'ediff-tbar)
1236 (or (ediff-window-display-p)
1237 (error "%sEmacs is not running as a window application"
1238 (if ediff-emacs-p "" "X")))
1239 (if (ediff-use-toolbar-p)
1240 (ediff-kill-bottom-toolbar))
1241 ;; do this only after killing the toolbar
1242 (setq ediff-use-toolbar-p (not ediff-use-toolbar-p))
1244 (mapcar (function (lambda(buf)
1245 (ediff-with-current-buffer buf
1247 (setq ediff-window-config-saved "")
1249 ediff-session-registry)
1250 (if (ediff-in-control-buffer-p)
1251 (ediff-recenter 'no-rehighlight)))))
1254 ;; if was using toolbar, kill it
1255 (defun ediff-kill-bottom-toolbar ()
1256 ;; Using ctl-buffer or ediff-control-window for LOCALE does not
1257 ;; work properly in XEmacs 19.14: we have to use
1259 ;; The problem with this is that any previous bottom-toolbar
1260 ;; will not re-appear after our cleanup here. Is there a way
1261 ;; to do "push" and "pop" toolbars ? --marcpa
1262 (if (ediff-use-toolbar-p)
1264 (set-specifier bottom-toolbar (list (selected-frame) nil))
1265 (set-specifier bottom-toolbar-visible-p (list (selected-frame) nil)))))
1267 ;; If wants to use toolbar, make it.
1268 ;; If not, zero the toolbar for XEmacs.
1269 ;; Do nothing for Emacs.
1270 (defun ediff-make-bottom-toolbar (&optional frame)
1271 (if (ediff-window-display-p)
1273 (setq frame (or frame (selected-frame)))
1274 (cond ((ediff-use-toolbar-p) ; this checks for XEmacs
1277 (list frame (if (ediff-3way-comparison-job)
1278 ediff-toolbar-3way ediff-toolbar)))
1279 (set-specifier bottom-toolbar-visible-p (list frame t))
1280 (set-specifier bottom-toolbar-height
1281 (list frame ediff-toolbar-height)))
1283 (set-specifier bottom-toolbar-height (list frame 0)))
1289 (defun ediff-toggle-show-clashes-only ()
1290 "Toggle the mode where only the regions where both buffers differ with the ancestor are shown."
1292 (ediff-barf-if-not-control-buffer)
1293 (if (not ediff-merge-with-ancestor-job)
1294 (error "This command makes sense only when merging with an ancestor"))
1295 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1296 (if ediff-show-clashes-only
1297 (message "Focus on regions where both buffers differ from the ancestor")
1298 (message "Canceling focus on regions where changes clash")))
1300 ;; Widening/narrowing
1302 (defun ediff-toggle-narrow-region ()
1303 "Toggle narrowing in buffers A, B, and C.
1304 Used in ediff-windows/regions only."
1306 (if (eq ediff-buffer-A ediff-buffer-B)
1307 (error ediff-NO-DIFFERENCES))
1308 (if (eq ediff-visible-bounds ediff-wide-bounds)
1309 (setq ediff-visible-bounds ediff-narrow-bounds)
1310 (setq ediff-visible-bounds ediff-wide-bounds))
1311 (ediff-recenter 'no-rehighlight))
1313 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1314 ;; ediff-wide-bounds, then this actually widens.
1315 ;; This function does nothing if job-name is not
1316 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1317 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1318 ;; to two different regions in one buffer.
1319 (defun ediff-visible-region ()
1320 (if (or (eq ediff-buffer-A ediff-buffer-B)
1321 (eq ediff-buffer-A ediff-buffer-C)
1322 (eq ediff-buffer-C ediff-buffer-B))
1324 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1325 ;; Otherwise, always use full range.
1326 (if (not ediff-narrow-job)
1327 (setq ediff-visible-bounds ediff-wide-bounds))
1328 (let ((overl-A (ediff-get-value-according-to-buffer-type
1329 'A ediff-visible-bounds))
1330 (overl-B (ediff-get-value-according-to-buffer-type
1331 'B ediff-visible-bounds))
1332 (overl-C (ediff-get-value-according-to-buffer-type
1333 'C ediff-visible-bounds))
1335 (ediff-with-current-buffer ediff-buffer-A
1337 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A)))
1338 (ediff-with-current-buffer ediff-buffer-B
1340 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B)))
1343 (ediff-with-current-buffer ediff-buffer-C
1345 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1349 ;; Window scrolling operations
1351 ;; Performs some operation on the two file windows (if they are showing).
1352 ;; Traps all errors on the operation in windows A/B/C.
1353 ;; Usually, errors come from scrolling off the
1354 ;; beginning or end of the buffer, and this gives error messages.
1355 (defun ediff-operate-on-windows (operation arg)
1357 ;; make sure windows aren't dead
1358 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1359 (ediff-recenter 'no-rehighlight))
1360 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1361 (ediff-buffer-live-p ediff-buffer-B)
1362 (or (not ediff-3way-job) ediff-buffer-C)
1364 (error ediff-KILLED-VITAL-BUFFER))
1366 (let* ((wind (selected-window))
1367 (wind-A ediff-window-A)
1368 (wind-B ediff-window-B)
1369 (wind-C ediff-window-C)
1370 (coefA (ediff-get-region-size-coefficient 'A operation))
1371 (coefB (ediff-get-region-size-coefficient 'B operation))
1372 (three-way ediff-3way-job)
1373 (coefC (if three-way
1374 (ediff-get-region-size-coefficient 'C operation))))
1376 (select-window wind-A)
1378 (funcall operation (round (* coefA arg)))
1380 (select-window wind-B)
1382 (funcall operation (round (* coefB arg)))
1386 (select-window wind-C)
1388 (funcall operation (round (* coefC arg)))
1390 (select-window wind)))
1392 (defun ediff-scroll-vertically (&optional arg)
1393 "Vertically scroll buffers A, B \(and C if appropriate\).
1394 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1395 the one half of the height of window-A."
1397 (ediff-barf-if-not-control-buffer)
1399 ;; make sure windows aren't dead
1400 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1401 (ediff-recenter 'no-rehighlight))
1402 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1403 (ediff-buffer-live-p ediff-buffer-B)
1404 (or (not ediff-3way-job)
1405 (ediff-buffer-live-p ediff-buffer-C))
1407 (error ediff-KILLED-VITAL-BUFFER))
1409 (ediff-operate-on-windows
1410 (if (memq last-command-char '(?v ?\C-v))
1413 ;; calculate argument to scroll-up/down
1414 ;; if there is an explicit argument
1415 (if (and arg (not (equal arg '-)))
1417 (prefix-numeric-value arg)
1418 ;; if not, see if we can determine a default amount (the window height)
1419 (let (default-amount)
1420 (setq default-amount
1421 (- (/ (min (window-height ediff-window-A)
1422 (window-height ediff-window-B)
1424 (window-height ediff-window-C)
1425 500)) ; some large number
1427 1 next-screen-context-lines))
1430 ;; C-u as argument means half of default amount
1431 (/ default-amount 2)
1432 ;; no argument means default amount
1436 (defun ediff-scroll-horizontally (&optional arg)
1437 "Horizontally scroll buffers A, B \(and C if appropriate\).
1438 If an argument is given, that is how many columns are scrolled, else nearly
1439 the width of the A/B/C windows."
1441 (ediff-barf-if-not-control-buffer)
1443 ;; make sure windows aren't dead
1444 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1445 (ediff-recenter 'no-rehighlight))
1446 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1447 (ediff-buffer-live-p ediff-buffer-B)
1448 (or (not ediff-3way-job)
1449 (ediff-buffer-live-p ediff-buffer-C))
1451 (error ediff-KILLED-VITAL-BUFFER))
1453 (ediff-operate-on-windows
1454 (if (= last-command-char ?<)
1457 ;; calculate argument to scroll-left/right
1458 ;; if there is an explicit argument
1459 (if (and arg (not (equal arg '-)))
1461 (prefix-numeric-value arg)
1462 ;; if not, see if we can determine a default amount
1463 ;; (half the window width)
1464 (if (null ediff-control-window)
1465 ;; no control window, use nil
1467 (let ((default-amount
1468 (- (/ (min (window-width ediff-window-A)
1469 (window-width ediff-window-B)
1470 (if ediff-3way-comparison-job
1471 (window-width ediff-window-C)
1472 500) ; some large number
1478 ;; C-u as argument means half of default amount
1479 (/ default-amount 2)
1480 ;; no argument means default amount
1481 default-amount))))))
1484 ;;BEG, END show the region to be positioned.
1485 ;;JOB-NAME holds ediff-job-name. The ediff-windows job positions regions
1487 (defun ediff-position-region (beg end pos job-name)
1488 (if (> end (point-max))
1489 (setq end (point-max)))
1490 (if ediff-windows-job
1491 (if (pos-visible-in-window-p end)
1492 () ; do nothing, wind is already positioned
1493 ;; at this point, windows are positioned at the beginning of the
1494 ;; file regions (not diff-regions) being compared.
1496 (move-to-window-line (- (window-height) 2))
1497 (let ((amount (+ 2 (count-lines (point) end))))
1498 (scroll-up amount))))
1499 (set-window-start (selected-window) beg)
1500 (if (pos-visible-in-window-p end)
1501 ;; Determine the number of lines that the region occupies
1504 (while ( and (> end (progn
1505 (move-to-window-line lines)
1507 ;; `end' may be beyond the window bottom, so check
1508 ;; that we are making progress
1509 (< prev-point (point)))
1510 (setq prev-point (point))
1511 (setq lines (1+ lines)))
1512 ;; And position the beginning on the right line
1514 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1522 ;; get number of lines from window start to region end
1523 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1524 (or n (setq n ediff-current-difference))
1525 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1526 (ediff-with-current-buffer ctl-buf
1527 (let* ((buf (ediff-get-buffer buf-type))
1528 (wind (eval (ediff-get-symbol-from-alist
1529 buf-type ediff-window-alist)))
1530 (beg (window-start wind))
1531 (end (ediff-get-diff-posn buf-type 'end))
1533 (ediff-with-current-buffer buf
1535 (setq lines (count-lines beg end))
1540 ;; get number of lines from window end to region start
1541 (defun ediff-get-lines-to-region-start (buf-type &optional n ctl-buf)
1542 (or n (setq n ediff-current-difference))
1543 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1544 (ediff-with-current-buffer ctl-buf
1545 (let* ((buf (ediff-get-buffer buf-type))
1546 (wind (eval (ediff-get-symbol-from-alist
1547 buf-type ediff-window-alist)))
1548 (end (window-end wind))
1549 (beg (ediff-get-diff-posn buf-type 'beg)))
1550 (ediff-with-current-buffer buf
1551 (if (< beg end) (count-lines beg end) 0))
1555 ;; region size coefficient is a coefficient by which to adjust scrolling
1556 ;; up/down of the window displaying buffer of type BUFTYPE.
1557 ;; The purpose of this coefficient is to make the windows scroll in sync, so
1558 ;; that it won't happen that one diff region is scrolled off while the other is
1561 ;; If the difference region is invalid, the coefficient is 1
1562 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1563 (ediff-with-current-buffer (or ctl-buf ediff-control-buffer)
1564 (if (ediff-valid-difference-p n)
1565 (let* ((func (cond ((eq op 'scroll-down)
1566 'ediff-get-lines-to-region-start)
1568 'ediff-get-lines-to-region-end)
1569 (t '(lambda (a b c) 0))))
1570 (max-lines (max (funcall func 'A n ctl-buf)
1571 (funcall func 'B n ctl-buf)
1572 (if (ediff-buffer-live-p ediff-buffer-C)
1573 (funcall func 'C n ctl-buf)
1575 ;; this covers the horizontal coefficient as well:
1576 ;; if max-lines = 0 then coef = 1
1578 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1584 (defun ediff-next-difference (&optional arg)
1585 "Advance to the next difference.
1586 With a prefix argument, go forward that many differences."
1588 (ediff-barf-if-not-control-buffer)
1589 (if (< ediff-current-difference ediff-number-of-differences)
1590 (let ((n (min ediff-number-of-differences
1591 (+ ediff-current-difference arg)))
1594 (ediff-visible-region)
1595 (or (>= n ediff-number-of-differences)
1596 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1597 (ediff-install-fine-diff-if-necessary n))
1598 (while (and (< n ediff-number-of-differences)
1602 ;; skip clashes, if necessary
1603 (and ediff-show-clashes-only
1604 (string-match "prefer"
1605 (or (ediff-get-state-of-merge n) "")))
1606 ;; skip difference regions that differ in white space
1607 (and ediff-ignore-similar-regions
1608 (eq (ediff-no-fine-diffs-p n) t))))
1610 (if (= 0 (mod n 20))
1611 (message "Skipped over region %d and counting ..." n))
1612 (or (>= n ediff-number-of-differences)
1613 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1614 (ediff-install-fine-diff-if-necessary n))
1617 (ediff-unselect-and-select-difference n)
1619 (ediff-visible-region)
1620 (error "At end of the difference list")))
1622 (defun ediff-previous-difference (&optional arg)
1623 "Go to the previous difference.
1624 With a prefix argument, go back that many differences."
1626 (ediff-barf-if-not-control-buffer)
1627 (if (> ediff-current-difference -1)
1628 (let ((n (max -1 (- ediff-current-difference arg)))
1631 (ediff-visible-region)
1633 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1634 (ediff-install-fine-diff-if-necessary n))
1635 (while (and (> n -1)
1639 ;; skip clashes, if necessary
1640 (and ediff-show-clashes-only
1641 (string-match "prefer"
1642 (or (ediff-get-state-of-merge n) "")))
1643 ;; skip difference regions that differ in white space
1644 (and ediff-ignore-similar-regions
1645 (eq (ediff-no-fine-diffs-p n) t))))
1646 (if (= 0 (mod (1+ n) 20))
1647 (message "Skipped over region %d and counting ..." (1+ n)))
1650 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1651 (ediff-install-fine-diff-if-necessary n))
1654 (ediff-unselect-and-select-difference n)
1656 (ediff-visible-region)
1657 (error "At beginning of the difference list")))
1659 ;; The diff number is as perceived by the user (i.e., 1+ the internal
1661 (defun ediff-jump-to-difference (difference-number)
1662 "Go to the difference specified as a prefix argument.
1663 If the prefix is negative, count differences from the end."
1665 (ediff-barf-if-not-control-buffer)
1666 (setq difference-number
1667 (cond ((< difference-number 0)
1668 (+ ediff-number-of-differences difference-number))
1669 ((> difference-number 0) (1- difference-number))
1671 ;; -1 is allowed by ediff-unselect-and-select-difference --- it is the
1672 ;; position before the first one.
1673 (if (and (>= difference-number -1)
1674 (<= difference-number ediff-number-of-differences))
1675 (ediff-unselect-and-select-difference difference-number)
1676 (error ediff-BAD-DIFF-NUMBER
1677 this-command (1+ difference-number) ediff-number-of-differences)))
1679 (defun ediff-jump-to-difference-at-point (arg)
1680 "Go to difference closest to the point in buffer A, B, or C.
1681 The buffer depends on last command character \(a, b, or c\) that invoked this
1682 command. For instance, if the command was `ga' then the point value in buffer A
1684 With a prefix argument, synchronize all files around the current point position
1685 in the specified buffer."
1687 (ediff-barf-if-not-control-buffer)
1688 (let* ((buf-type (ediff-char-to-buftype last-command-char))
1689 (buffer (ediff-get-buffer buf-type))
1690 (pt (ediff-with-current-buffer buffer (point)))
1691 (diff-no (ediff-diff-at-point buf-type nil (if arg 'after)))
1692 (past-last-diff (< ediff-number-of-differences diff-no))
1693 (beg (if past-last-diff
1694 (ediff-with-current-buffer buffer (point-max))
1695 (ediff-get-diff-posn buf-type 'beg (1- diff-no))))
1696 ctl-wind wind-A wind-B wind-C
1699 (ediff-jump-to-difference -1)
1700 (ediff-jump-to-difference diff-no))
1701 (setq ctl-wind (selected-window)
1702 wind-A ediff-window-A
1703 wind-B ediff-window-B
1704 wind-C ediff-window-C)
1707 (ediff-with-current-buffer buffer
1708 (setq shift (- beg pt)))
1709 (select-window wind-A)
1710 (if past-last-diff (goto-char (point-max)))
1712 (backward-char shift) ; noerror, if beginning of buffer
1715 (select-window wind-B)
1716 (if past-last-diff (goto-char (point-max)))
1718 (backward-char shift) ; noerror, if beginning of buffer
1721 (if (window-live-p wind-C)
1723 (select-window wind-C)
1724 (if past-last-diff (goto-char (point-max)))
1726 (backward-char shift) ; noerror, if beginning of buffer
1730 (select-window ctl-wind)
1735 ;; find region most related to the current point position (or POS, if given)
1736 ;; returns diff number as seen by the user (i.e., 1+ the internal
1738 ;; The optional argument WHICH-DIFF can be `after' or `before'. If `after',
1739 ;; find the diff after the point. If `before', find the diff before the
1740 ;; point. If the point is inside a diff, return that diff.
1741 (defun ediff-diff-at-point (buf-type &optional pos which-diff)
1742 (let ((buffer (ediff-get-buffer buf-type))
1743 (ctl-buffer ediff-control-buffer)
1744 (max-dif-num (1- ediff-number-of-differences))
1751 (ediff-with-current-buffer buffer
1752 (setq pos (or pos (point)))
1753 (while (and (or (< pos prev-beg) (> pos beg))
1754 (< diff-no max-dif-num))
1755 (setq diff-no (1+ diff-no))
1758 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1759 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1762 ;; boost diff-no by 1, if past the last diff region
1763 (if (and (memq which-diff '(after before))
1764 (> pos beg) (= diff-no max-dif-num))
1765 (setq diff-no (1+ diff-no)))
1767 (cond ((eq which-diff 'after) (1+ diff-no))
1768 ((eq which-diff 'before) diff-no)
1769 ((< (abs (count-lines pos (max 1 prev-end)))
1770 (abs (count-lines pos (max 1 beg))))
1771 diff-no) ; choose prev difference
1773 (1+ diff-no))) ; choose next difference
1779 (defun ediff-diff-to-diff (arg &optional keys)
1780 "Copy buffer-X'th difference region to buffer Y \(X,Y are A, B, or C\).
1781 If numerical prefix argument, copy the difference specified in the arg.
1782 Otherwise, copy the difference given by `ediff-current-difference'.
1783 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1784 `ac', etc., which is used to determine the types of buffers to be used for
1785 copying difference regions. The first character in the sequence specifies
1786 the source buffer and the second specifies the target.
1788 If the second optional argument, a 2-character string, is given, use it to
1789 determine the source and the target buffers instead of the command keys."
1791 (ediff-barf-if-not-control-buffer)
1792 (or keys (setq keys (this-command-keys)))
1793 (if (eq arg '-) (setq arg -1)) ; translate neg arg to -1
1794 (if (numberp arg) (ediff-jump-to-difference arg))
1796 (let* ((key1 (aref keys 0))
1797 (key2 (aref keys 1))
1798 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1799 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2))
1801 (ediff-copy-diff ediff-current-difference
1802 (ediff-char-to-buftype char1)
1803 (ediff-char-to-buftype char2))
1804 ;; recenter with rehighlighting, but no messages
1807 (defun ediff-copy-A-to-B (arg)
1808 "Copy ARGth difference region from buffer A to B.
1809 ARG is a prefix argument. If nil, copy the current difference region."
1811 (ediff-diff-to-diff arg "ab"))
1813 (defun ediff-copy-B-to-A (arg)
1814 "Copy ARGth difference region from buffer B to A.
1815 ARG is a prefix argument. If nil, copy the current difference region."
1817 (ediff-diff-to-diff arg "ba"))
1819 (defun ediff-copy-A-to-C (arg)
1820 "Copy ARGth difference region from buffer A to buffer C.
1821 ARG is a prefix argument. If nil, copy the current difference region."
1823 (ediff-diff-to-diff arg "ac"))
1825 (defun ediff-copy-B-to-C (arg)
1826 "Copy ARGth difference region from buffer B to buffer C.
1827 ARG is a prefix argument. If nil, copy the current difference region."
1829 (ediff-diff-to-diff arg "bc"))
1831 (defun ediff-copy-C-to-B (arg)
1832 "Copy ARGth difference region from buffer C to B.
1833 ARG is a prefix argument. If nil, copy the current difference region."
1835 (ediff-diff-to-diff arg "cb"))
1837 (defun ediff-copy-C-to-A (arg)
1838 "Copy ARGth difference region from buffer C to A.
1839 ARG is a prefix argument. If nil, copy the current difference region."
1841 (ediff-diff-to-diff arg "ca"))
1845 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1846 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1847 ;; target diff. This is used in merging, when constructing the merged
1849 (defun ediff-copy-diff (n from-buf-type to-buf-type
1850 &optional batch-invocation reg-to-copy)
1851 (let* ((to-buf (ediff-get-buffer to-buf-type))
1852 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1853 (ctrl-buf ediff-control-buffer)
1855 (three-way ediff-3way-job)
1858 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1860 (setq reg-to-delete-beg
1861 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1862 (setq reg-to-delete-end
1863 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1866 (setq from-buf-type nil)
1867 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1869 (setq reg-to-delete (ediff-get-region-contents
1870 n to-buf-type ctrl-buf
1871 reg-to-delete-beg reg-to-delete-end))
1873 (if (string= reg-to-delete reg-to-copy)
1874 (setq saved-p nil) ; don't copy identical buffers
1876 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1877 (condition-case conds
1879 (ediff-with-current-buffer to-buf
1880 ;; to prevent flags from interfering if buffer is writable
1881 (let ((inhibit-read-only (null buffer-read-only)))
1883 (goto-char reg-to-delete-end)
1884 (insert reg-to-copy)
1886 (if (> reg-to-delete-end reg-to-delete-beg)
1887 (kill-region reg-to-delete-beg reg-to-delete-end))
1889 (or batch-invocation
1892 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1893 (error (message "ediff-copy-diff: %s %s"
1895 (mapconcat 'prin1-to-string (cdr conds) " "))
1897 (sit-for 2) ; let the user see the error msg
1902 ;; adjust state of difference in case 3-way and diff was copied ok
1903 (if (and saved-p three-way)
1904 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
1906 (if batch-invocation
1907 (ediff-clear-fine-differences n)
1908 ;; If diff3 job, we should recompute fine diffs so we clear them
1909 ;; before reinserting flags (and thus before ediff-recenter).
1910 (if (and saved-p three-way)
1911 (ediff-clear-fine-differences n))
1913 (ediff-refresh-mode-lines)
1915 ;; For diff2 jobs, don't recompute fine diffs, since we know there
1916 ;; aren't any. So we clear diffs after ediff-recenter.
1917 (if (and saved-p (not three-way))
1918 (ediff-clear-fine-differences n))
1919 ;; Make sure that the message about saving and how to restore is seen
1924 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
1925 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
1926 ;; is the region to save. It is redundant here, but is passed anyway, for
1928 (defun ediff-save-diff-region (n buf-type reg)
1929 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1930 (buf (ediff-get-buffer buf-type))
1931 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1933 (if this-buf-n-th-diff-saved
1934 ;; either nothing saved for n-th diff and buffer or we OK'ed
1936 (setcdr this-buf-n-th-diff-saved reg)
1937 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
1938 (nconc n-th-diff-saved (list (cons buf reg)))
1939 (setq ediff-killed-diffs-alist ;; create record for n-th diff
1940 (cons (list n (cons buf reg))
1941 ediff-killed-diffs-alist))))
1942 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
1945 "" (downcase (symbol-name buf-type))))
1948 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
1949 (defun ediff-test-save-region (n buf-type)
1950 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1951 (buf (ediff-get-buffer buf-type))
1952 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1954 (if this-buf-n-th-diff-saved
1957 "You've previously copied diff region %d to buffer %S. Confirm "
1963 (defun ediff-pop-diff (n buf-type)
1964 "Pop last killed Nth diff region from buffer BUF-TYPE."
1965 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
1966 (buf (ediff-get-buffer buf-type))
1967 (saved-rec (assoc buf (cdr n-th-record)))
1968 (three-way ediff-3way-job)
1969 (ctl-buf ediff-control-buffer)
1971 saved-diff reg-beg reg-end recovered)
1974 (setq saved-diff (cdr saved-rec))
1975 (if (> ediff-number-of-differences 0)
1976 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
1977 (error ediff-NO-DIFFERENCES)))
1979 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
1980 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
1982 (condition-case conds
1983 (ediff-with-current-buffer buf
1984 (let ((inhibit-read-only (null buffer-read-only)))
1989 (if (> reg-end reg-beg)
1990 (kill-region reg-beg reg-end))
1994 (error (message "ediff-pop-diff: %s %s"
1996 (mapconcat 'prin1-to-string (cdr conds) " "))
1999 ;; Clearing fine diffs is necessary for
2000 ;; ediff-unselect-and-select-difference to properly recompute them. We
2001 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
2002 ;; have modified diff regions after copying and, thus, may have recomputed
2005 (ediff-clear-fine-differences n))
2007 ;; adjust state of difference
2008 (if (and three-way recovered)
2009 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
2011 (ediff-refresh-mode-lines)
2015 (setq n-th-record (delq saved-rec n-th-record))
2016 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
2020 (defun ediff-restore-diff (arg &optional key)
2021 "Restore ARGth diff from `ediff-killed-diffs-alist'.
2022 ARG is a prefix argument. If ARG is nil, restore the current-difference.
2023 If the second optional argument, a character, is given, use it to
2024 determine the target buffer instead of last-command-char"
2026 (ediff-barf-if-not-control-buffer)
2028 (ediff-jump-to-difference arg))
2029 (ediff-pop-diff ediff-current-difference
2030 (ediff-char-to-buftype (or key last-command-char)))
2031 ;; recenter with rehighlighting, but no messages
2032 (let (ediff-verbose-p)
2035 (defun ediff-restore-diff-in-merge-buffer (arg)
2036 "Restore ARGth diff in the merge buffer.
2037 ARG is a prefix argument. If nil, restore the current diff."
2039 (ediff-restore-diff arg ?c))
2042 (defun ediff-toggle-regexp-match ()
2043 "Toggle between focusing and hiding of difference regions that match
2044 a regular expression typed in by the user."
2046 (ediff-barf-if-not-control-buffer)
2050 msg-connective alt-msg-connective alt-connective)
2052 ((or (and (eq ediff-skip-diff-region-function
2053 ediff-focus-on-regexp-matches-function)
2054 (eq last-command-char ?f))
2055 (and (eq ediff-skip-diff-region-function
2056 ediff-hide-regexp-matches-function)
2057 (eq last-command-char ?h)))
2058 (message "Selective browsing by regexp turned off")
2059 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
2060 ((eq last-command-char ?h)
2061 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
2065 "Ignore A-regions matching this regexp (default \"%s\"): "
2066 ediff-regexp-hide-A))
2070 "Ignore B-regions matching this regexp (default \"%s\"): "
2071 ediff-regexp-hide-B)))
2072 (if ediff-3way-comparison-job
2076 "Ignore C-regions matching this regexp (default \"%s\"): "
2077 ediff-regexp-hide-C))))
2078 (if (eq ediff-hide-regexp-connective 'and)
2079 (setq msg-connective "BOTH"
2080 alt-msg-connective "ONE OF"
2082 (setq msg-connective "ONE OF"
2083 alt-msg-connective "BOTH"
2084 alt-connective 'and))
2087 "Ignore regions that match %s regexps, OK? "
2088 msg-connective alt-msg-connective))
2089 (message "Will ignore regions that match %s regexps" msg-connective)
2090 (setq ediff-hide-regexp-connective alt-connective)
2091 (message "Will ignore regions that match %s regexps"
2092 alt-msg-connective))
2094 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
2095 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
2096 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
2098 ((eq last-command-char ?f)
2099 (setq ediff-skip-diff-region-function
2100 ediff-focus-on-regexp-matches-function
2104 "Focus on A-regions matching this regexp (default \"%s\"): "
2105 ediff-regexp-focus-A))
2109 "Focus on B-regions matching this regexp (default \"%s\"): "
2110 ediff-regexp-focus-B)))
2111 (if ediff-3way-comparison-job
2115 "Focus on C-regions matching this regexp (default \"%s\"): "
2116 ediff-regexp-focus-C))))
2117 (if (eq ediff-focus-regexp-connective 'and)
2118 (setq msg-connective "BOTH"
2119 alt-msg-connective "ONE OF"
2121 (setq msg-connective "ONE OF"
2122 alt-msg-connective "BOTH"
2123 alt-connective 'and))
2126 "Focus on regions that match %s regexps, OK? "
2127 msg-connective alt-msg-connective))
2128 (message "Will focus on regions that match %s regexps"
2130 (setq ediff-focus-regexp-connective alt-connective)
2131 (message "Will focus on regions that match %s regexps"
2132 alt-msg-connective))
2134 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
2135 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
2136 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
2138 (defun ediff-toggle-skip-similar ()
2140 (ediff-barf-if-not-control-buffer)
2141 (if (not (eq ediff-auto-refine 'on))
2143 "Can't skip over whitespace regions: first turn auto-refining on"))
2144 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
2145 (if ediff-ignore-similar-regions
2147 "Skipping regions that differ only in white space & line breaks")
2148 (message "Skipping over white-space differences turned off")))
2150 (defun ediff-focus-on-regexp-matches (n)
2151 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
2152 Regions to be ignored according to this function are those where
2153 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
2154 doesn't match `ediff-regexp-focus-B'.
2155 This function returns nil if the region number N (specified as
2156 an argument) is not to be ignored and t if region N is to be ignored.
2158 N is a region number used by Ediff internally. It is 1 less
2159 the number seen by the user."
2160 (if (ediff-valid-difference-p n)
2161 (let* ((ctl-buf ediff-control-buffer)
2162 (regex-A ediff-regexp-focus-A)
2163 (regex-B ediff-regexp-focus-B)
2164 (regex-C ediff-regexp-focus-C)
2165 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2168 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2169 (ediff-get-diff-posn 'A 'end n ctl-buf))
2170 (goto-char (point-min))
2171 (re-search-forward regex-A nil t))))
2172 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2175 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2176 (ediff-get-diff-posn 'B 'end n ctl-buf))
2177 (re-search-forward regex-B nil t))))
2178 (reg-C-match (if ediff-3way-comparison-job
2179 (ediff-with-current-buffer ediff-buffer-C
2182 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2183 (ediff-get-diff-posn 'C 'end n ctl-buf))
2184 (re-search-forward regex-C nil t))))))
2185 (not (eval (if ediff-3way-comparison-job
2186 (list ediff-focus-regexp-connective
2187 reg-A-match reg-B-match reg-C-match)
2188 (list ediff-focus-regexp-connective
2189 reg-A-match reg-B-match))))
2192 (defun ediff-hide-regexp-matches (n)
2193 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2194 Regions to be ignored are those where buf A region matches
2195 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2196 This function returns nil if the region number N (specified as
2197 an argument) is not to be ignored and t if region N is to be ignored.
2199 N is a region number used by Ediff internally. It is 1 less
2200 the number seen by the user."
2201 (if (ediff-valid-difference-p n)
2202 (let* ((ctl-buf ediff-control-buffer)
2203 (regex-A ediff-regexp-hide-A)
2204 (regex-B ediff-regexp-hide-B)
2205 (regex-C ediff-regexp-hide-C)
2206 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2209 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2210 (ediff-get-diff-posn 'A 'end n ctl-buf))
2211 (goto-char (point-min))
2212 (re-search-forward regex-A nil t))))
2213 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2216 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2217 (ediff-get-diff-posn 'B 'end n ctl-buf))
2218 (goto-char (point-min))
2219 (re-search-forward regex-B nil t))))
2220 (reg-C-match (if ediff-3way-comparison-job
2221 (ediff-with-current-buffer ediff-buffer-C
2224 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2225 (ediff-get-diff-posn 'C 'end n ctl-buf))
2226 (goto-char (point-min))
2227 (re-search-forward regex-C nil t))))))
2228 (eval (if ediff-3way-comparison-job
2229 (list ediff-hide-regexp-connective
2230 reg-A-match reg-B-match reg-C-match)
2231 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2236 ;;; Quitting, suspending, etc.
2238 (defun ediff-quit (reverse-default-keep-variants)
2239 "Finish an Ediff session and exit Ediff.
2240 Unselects the selected difference, if any, restores the read-only and modified
2241 flags of the compared file buffers, kills Ediff buffers for this session
2242 \(but not buffers A, B, C\).
2244 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2245 containing the variants should be removed \(if they haven't been modified\).
2246 If it is t, they will be preserved unconditionally. A prefix argument,
2247 temporarily reverses the meaning of this variable."
2249 (ediff-barf-if-not-control-buffer)
2250 (let ((ctl-buf (current-buffer)))
2251 (if (y-or-n-p (format "Quit this Ediff session%s? "
2252 (if (ediff-buffer-live-p ediff-meta-buffer)
2253 " & show containing session group" "")))
2256 (set-buffer ctl-buf)
2257 (ediff-really-quit reverse-default-keep-variants))
2261 ;; Perform the quit operations.
2262 (defun ediff-really-quit (reverse-default-keep-variants)
2263 (ediff-unhighlight-diffs-totally)
2264 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2265 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2266 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2267 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2269 (ediff-delete-temp-files)
2271 ;; Restore visibility range. This affects only ediff-*-regions/windows.
2272 ;; Since for other job names ediff-visible-region sets
2273 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2274 ;; ignored for such jobs.
2275 (if ediff-quit-widened
2276 (setq ediff-visible-bounds ediff-wide-bounds)
2277 (setq ediff-visible-bounds ediff-narrow-bounds))
2279 ;; Apply selective display to narrow or widen
2280 (ediff-visible-region)
2281 (mapcar (function (lambda (overl)
2282 (if (ediff-overlayp overl)
2283 (ediff-delete-overlay overl))))
2285 (mapcar (function (lambda (overl)
2286 (if (ediff-overlayp overl)
2287 (ediff-delete-overlay overl))))
2288 ediff-narrow-bounds)
2290 ;; restore buffer mode line id's in buffer-A/B/C
2291 (let ((control-buffer ediff-control-buffer)
2292 (meta-buffer ediff-meta-buffer)
2293 ;; suitable working frame
2294 (warp-frame (if (and (ediff-window-display-p) (eq ediff-grab-mouse t))
2295 (cond ((window-live-p ediff-window-A)
2296 (window-frame ediff-window-A))
2297 ((window-live-p ediff-window-B)
2298 (window-frame ediff-window-B))
2299 (t (next-frame))))))
2301 (ediff-with-current-buffer ediff-buffer-A
2302 (setq ediff-this-buffer-ediff-sessions
2303 (delq control-buffer ediff-this-buffer-ediff-sessions))
2304 (kill-local-variable 'mode-line-buffer-identification)
2305 (kill-local-variable 'mode-line-format)
2310 (ediff-with-current-buffer ediff-buffer-B
2311 (setq ediff-this-buffer-ediff-sessions
2312 (delq control-buffer ediff-this-buffer-ediff-sessions))
2313 (kill-local-variable 'mode-line-buffer-identification)
2314 (kill-local-variable 'mode-line-format)
2319 (ediff-with-current-buffer ediff-buffer-C
2320 (setq ediff-this-buffer-ediff-sessions
2321 (delq control-buffer ediff-this-buffer-ediff-sessions))
2322 (kill-local-variable 'mode-line-buffer-identification)
2323 (kill-local-variable 'mode-line-format)
2328 (ediff-with-current-buffer ediff-ancestor-buffer
2329 (setq ediff-this-buffer-ediff-sessions
2330 (delq control-buffer ediff-this-buffer-ediff-sessions))
2331 (kill-local-variable 'mode-line-buffer-identification)
2332 (kill-local-variable 'mode-line-format)
2336 (setq ediff-session-registry
2337 (delq ediff-control-buffer ediff-session-registry))
2338 (ediff-update-registry)
2339 ;; restore state of buffers to what it was before ediff
2340 (ediff-restore-protected-variables)
2342 ;; If the user interrupts (canceling saving the merge buffer), continue
2345 (if (ediff-merge-job)
2346 (run-hooks 'ediff-quit-merge-hook))
2349 ;; good place to kill buffers A/B/C
2350 (run-hooks 'ediff-cleanup-hook)
2351 (let ((ediff-keep-variants ediff-keep-variants))
2352 (if reverse-default-keep-variants
2353 (setq ediff-keep-variants (not ediff-keep-variants)))
2354 (or ediff-keep-variants (ediff-janitor 'ask)))
2356 (run-hooks 'ediff-quit-hook)
2357 (ediff-cleanup-meta-buffer meta-buffer)
2359 ;; warp mouse into a working window
2360 (setq warp-frame ; if mouse is over a reasonable frame, use it
2361 (cond ((and ediff-xemacs-p (window-live-p (car (mouse-position))))
2362 (window-frame (car (mouse-position))))
2363 ((frame-live-p (car (mouse-position)))
2364 (car (mouse-position)))
2366 (if (frame-live-p warp-frame)
2367 (set-mouse-position (if ediff-emacs-p
2369 (frame-selected-window warp-frame))
2372 (if (ediff-buffer-live-p meta-buffer)
2373 (ediff-show-meta-buffer meta-buffer))
2377 (defun ediff-delete-temp-files ()
2378 (if (stringp ediff-temp-file-A)
2379 (delete-file ediff-temp-file-A))
2380 (if (stringp ediff-temp-file-B)
2381 (delete-file ediff-temp-file-B))
2382 (if (stringp ediff-temp-file-C)
2383 (delete-file ediff-temp-file-C)))
2386 ;; Kill control buffer, other auxiliary Ediff buffers.
2387 ;; Leave one of the frames split between buffers A/B/C
2388 (defun ediff-cleanup-mess ()
2389 (let ((buff-A ediff-buffer-A)
2390 (buff-B ediff-buffer-B)
2391 (buff-C ediff-buffer-C)
2392 (ctl-buf ediff-control-buffer)
2393 (ctl-frame ediff-control-frame)
2394 (three-way-job ediff-3way-job))
2396 (ediff-kill-buffer-carefully ediff-diff-buffer)
2397 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2398 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2399 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2400 (ediff-kill-buffer-carefully ediff-error-buffer)
2401 (ediff-kill-buffer-carefully ediff-msg-buffer)
2402 (ediff-kill-buffer-carefully ediff-debug-buffer)
2403 (if (boundp 'ediff-patch-diagnostics)
2404 (ediff-kill-buffer-carefully ediff-patch-diagnostics))
2406 (if (and (ediff-window-display-p) (frame-live-p ctl-frame))
2407 (delete-frame ctl-frame))
2408 ;; Hide bottom toolbar. --marcpa
2409 (if (not (ediff-multiframe-setup-p))
2410 (ediff-kill-bottom-toolbar))
2412 (ediff-kill-buffer-carefully ctl-buf)
2414 (delete-other-windows)
2416 ;; display only if not visible
2418 (or (ediff-get-visible-buffer-window buff-B)
2419 (switch-to-buffer buff-B))
2422 (or (ediff-get-visible-buffer-window buff-A)
2424 (if (ediff-get-visible-buffer-window buff-B)
2425 (funcall ediff-split-window-function))
2426 (switch-to-buffer buff-A)))
2430 (or (ediff-get-visible-buffer-window buff-C)
2432 (if (or (ediff-get-visible-buffer-window buff-A)
2433 (ediff-get-visible-buffer-window buff-B))
2434 (funcall ediff-split-window-function))
2435 (switch-to-buffer buff-C)
2441 (defun ediff-janitor (&optional ask)
2442 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2443 In merge jobs, buffer C is never deleted.
2444 However, the side effect of cleaning up may be that you cannot compare the same
2445 buffer in two separate Ediff sessions: quitting one of them will delete this
2446 buffer in another session as well."
2447 (or (not (ediff-buffer-live-p ediff-buffer-A))
2448 (buffer-modified-p ediff-buffer-A)
2450 (not (y-or-n-p (format "Kill buffer A [%s]? "
2451 (buffer-name ediff-buffer-A)))))
2452 (ediff-kill-buffer-carefully ediff-buffer-A))
2453 (or (not (ediff-buffer-live-p ediff-buffer-B))
2454 (buffer-modified-p ediff-buffer-B)
2456 (not (y-or-n-p (format "Kill buffer B [%s]? "
2457 (buffer-name ediff-buffer-B)))))
2458 (ediff-kill-buffer-carefully ediff-buffer-B))
2459 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2460 (or (not (ediff-buffer-live-p ediff-ancestor-buffer))
2461 (buffer-modified-p ediff-ancestor-buffer)
2463 (not (y-or-n-p (format "Kill the ancestor buffer [%s]? "
2464 (buffer-name ediff-ancestor-buffer)))))
2465 (ediff-kill-buffer-carefully ediff-ancestor-buffer))
2466 (or (not (ediff-buffer-live-p ediff-buffer-C))
2467 (buffer-modified-p ediff-buffer-C)
2468 (and ask (not (y-or-n-p (format "Kill buffer C [%s]? "
2469 (buffer-name ediff-buffer-C)))))
2470 (ediff-kill-buffer-carefully ediff-buffer-C))))
2472 (defun ediff-maybe-save-and-delete-merge (&optional save-and-continue)
2473 "Default hook to run on quitting a merge job.
2474 This can also be used to save merge buffer in the middle of an Ediff session.
2476 If the optional SAVE-AND-CONTINUE argument is non-nil, save merge buffer and
2477 continue. Otherwise:
2478 If `ediff-autostore-merges' is nil, this does nothing.
2479 If it is t, it saves the merge buffer in the file `ediff-merge-store-file'
2480 or asks the user, if the latter is nil. It then asks the user whether to
2481 delete the merge buffer.
2482 If `ediff-autostore-merges' is neither nil nor t, the merge buffer is saved
2483 only if this merge job is part of a group, i.e., was invoked from within
2484 `ediff-merge-directories', `ediff-merge-directory-revisions', and such."
2485 (let ((merge-store-file ediff-merge-store-file)
2486 (ediff-autostore-merges ; fake ediff-autostore-merges, if necessary
2487 (if save-and-continue t ediff-autostore-merges)))
2488 (if ediff-autostore-merges
2489 (cond ((stringp ediff-merge-store-file)
2490 ;; store, ask to delete
2491 (ediff-write-merge-buffer-and-maybe-kill
2492 ediff-buffer-C merge-store-file 'show-file save-and-continue))
2493 ((eq ediff-autostore-merges t)
2494 ;; ask for file name
2495 (setq merge-store-file
2496 (read-file-name "Save the merge buffer in file: "))
2497 (ediff-write-merge-buffer-and-maybe-kill
2498 ediff-buffer-C merge-store-file nil save-and-continue))
2499 ((and (ediff-buffer-live-p ediff-meta-buffer)
2500 (ediff-with-current-buffer ediff-meta-buffer
2501 (ediff-merge-metajob)))
2502 ;; This case shouldn't occur, as the parent metajob must pass on
2503 ;; a file name, ediff-merge-store-file, where to save the result
2505 ;; Ask where to save anyway--will decide what to do here later.
2506 (setq merge-store-file
2507 (read-file-name "Save the merge buffer in file: "))
2508 (ediff-write-merge-buffer-and-maybe-kill
2509 ediff-buffer-C merge-store-file nil save-and-continue))))
2512 ;; write merge buffer. If the optional argument save-and-continue is non-nil,
2513 ;; then don't kill the merge buffer
2514 (defun ediff-write-merge-buffer-and-maybe-kill (buf file
2516 show-file save-and-continue)
2517 (ediff-with-current-buffer buf
2518 (if (or (not (file-exists-p file))
2519 (y-or-n-p (format "File %s exists, overwrite? " file)))
2521 (write-region (point-min) (point-max) file)
2524 (message "Merge buffer saved in: %s" file)
2527 (not save-and-continue)
2528 (y-or-n-p "Merge buffer saved in file. Now kill the buffer? "))
2529 (ediff-kill-buffer-carefully buf))))))
2531 ;; The default way of suspending Ediff.
2532 ;; Buries Ediff buffers, kills all windows.
2533 (defun ediff-default-suspend-function ()
2534 (let* ((buf-A ediff-buffer-A)
2535 (buf-B ediff-buffer-B)
2536 (buf-C ediff-buffer-C)
2537 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2538 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2539 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2540 (buf-patch (if (boundp 'ediff-patchbufer) ediff-patchbufer nil))
2541 (buf-patch-diag (if (boundp 'ediff-patch-diagnostics)
2542 ediff-patch-diagnostics nil))
2543 (buf-err ediff-error-buffer)
2544 (buf-diff ediff-diff-buffer)
2545 (buf-custom-diff ediff-custom-diff-buffer)
2546 (buf-fine-diff ediff-fine-diff-buffer))
2548 ;; hide the control panel
2549 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2550 (iconify-frame ediff-control-frame)
2552 (if buf-err (bury-buffer buf-err))
2553 (if buf-diff (bury-buffer buf-diff))
2554 (if buf-custom-diff (bury-buffer buf-custom-diff))
2555 (if buf-fine-diff (bury-buffer buf-fine-diff))
2556 (if buf-patch (bury-buffer buf-patch))
2557 (if buf-patch-diag (bury-buffer buf-patch-diag))
2558 (if (window-live-p buf-A-wind)
2560 (select-window buf-A-wind)
2561 (delete-other-windows)
2563 (if (ediff-buffer-live-p buf-A)
2567 (if (window-live-p buf-B-wind)
2569 (select-window buf-B-wind)
2570 (delete-other-windows)
2572 (if (ediff-buffer-live-p buf-B)
2576 (if (window-live-p buf-C-wind)
2578 (select-window buf-C-wind)
2579 (delete-other-windows)
2581 (if (ediff-buffer-live-p buf-C)
2588 (defun ediff-suspend ()
2590 To resume, switch to the appropriate `Ediff Control Panel'
2591 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2592 up an appropriate window config."
2594 (ediff-barf-if-not-control-buffer)
2595 (run-hooks 'ediff-suspend-hook)
2597 "To resume, type M-x eregistry and select the desired Ediff session"))
2600 (defun ediff-status-info ()
2601 "Show the names of the buffers or files being operated on by Ediff.
2602 Hit \\[ediff-recenter] to reset the windows afterward."
2604 (ediff-barf-if-not-control-buffer)
2606 (ediff-skip-unsuitable-frames))
2607 (with-output-to-temp-buffer ediff-msg-buffer
2608 (raise-frame (selected-frame))
2609 (princ (ediff-version))
2611 (ediff-with-current-buffer ediff-buffer-A
2612 (if buffer-file-name
2614 (format "File A = %S\n" buffer-file-name))
2616 (format "Buffer A = %S\n" (buffer-name)))))
2617 (ediff-with-current-buffer ediff-buffer-B
2618 (if buffer-file-name
2620 (format "File B = %S\n" buffer-file-name))
2622 (format "Buffer B = %S\n" (buffer-name)))))
2624 (ediff-with-current-buffer ediff-buffer-C
2625 (if buffer-file-name
2627 (format "File C = %S\n" buffer-file-name))
2629 (format "Buffer C = %S\n" (buffer-name))))))
2630 (princ (format "Customized diff output %s\n"
2631 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2632 (concat "\tin buffer "
2633 (buffer-name ediff-custom-diff-buffer))
2634 " is not available")))
2635 (princ (format "Plain diff output %s\n"
2636 (if (ediff-buffer-live-p ediff-diff-buffer)
2637 (concat "\tin buffer "
2638 (buffer-name ediff-diff-buffer))
2639 " is not available")))
2641 (let* ((A-line (ediff-with-current-buffer ediff-buffer-A
2642 (1+ (count-lines (point-min) (point)))))
2643 (B-line (ediff-with-current-buffer ediff-buffer-B
2644 (1+ (count-lines (point-min) (point)))))
2646 (princ (format "\Buffer A's point is on line %d\n" A-line))
2647 (princ (format "Buffer B's point is on line %d\n" B-line))
2650 (setq C-line (ediff-with-current-buffer ediff-buffer-C
2651 (1+ (count-lines (point-min) (point)))))
2652 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2654 (princ (format "\nCurrent difference number = %S\n"
2655 (cond ((< ediff-current-difference 0) 'start)
2656 ((>= ediff-current-difference
2657 ediff-number-of-differences) 'end)
2658 (t (1+ ediff-current-difference)))))
2661 (format "\n%s regions that differ in white space & line breaks only"
2662 (if ediff-ignore-similar-regions
2663 "Ignoring" "Showing")))
2664 (if (and ediff-merge-job ediff-show-clashes-only)
2666 "\nFocusing on regions where both buffers differ from the ancestor"))
2668 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2669 (princ "\nSelective browsing by regexp is off\n"))
2670 ((eq ediff-skip-diff-region-function
2671 ediff-hide-regexp-matches-function)
2673 "\nIgnoring regions that match")
2676 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2677 ediff-regexp-hide-A ediff-hide-regexp-connective
2678 ediff-regexp-hide-B)))
2679 ((eq ediff-skip-diff-region-function
2680 ediff-focus-on-regexp-matches-function)
2682 "\nFocusing on regions that match")
2685 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2686 ediff-regexp-focus-A ediff-focus-regexp-connective
2687 ediff-regexp-focus-B)))
2688 (t (princ "\nSelective browsing via a user-defined method.\n")))
2691 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2692 (substitute-command-keys "\\[ediff-submit-report]")))
2694 (if (frame-live-p ediff-control-frame)
2695 (ediff-reset-mouse ediff-control-frame))
2696 (if (window-live-p ediff-control-window)
2697 (select-window ediff-control-window)))
2702 ;;; Support routines
2704 ;; Select a difference by placing the ASCII flags around the appropriate
2705 ;; group of lines in the A, B buffers
2706 ;; This may have to be modified for buffer C, when it will be supported.
2707 (defun ediff-select-difference (n)
2708 (if (and (ediff-buffer-live-p ediff-buffer-A)
2709 (ediff-buffer-live-p ediff-buffer-B)
2710 (ediff-valid-difference-p n))
2712 (if (and (ediff-has-face-support-p) ediff-use-faces)
2714 (ediff-highlight-diff n)
2715 (setq ediff-highlighting-style 'face))
2716 (setq ediff-highlighting-style 'ascii)
2717 (ediff-place-flags-in-buffer
2718 'A ediff-buffer-A ediff-control-buffer n)
2719 (ediff-place-flags-in-buffer
2720 'B ediff-buffer-B ediff-control-buffer n)
2722 (ediff-place-flags-in-buffer
2723 'C ediff-buffer-C ediff-control-buffer n))
2724 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2725 (ediff-place-flags-in-buffer
2726 'Ancestor ediff-ancestor-buffer
2727 ediff-control-buffer n))
2730 (ediff-install-fine-diff-if-necessary n)
2731 (run-hooks 'ediff-select-hook))))
2734 ;; Unselect a difference by removing the ASCII flags in the buffers.
2735 ;; This may have to be modified for buffer C, when it will be supported.
2736 (defun ediff-unselect-difference (n)
2737 (if (ediff-valid-difference-p n)
2739 (cond ((and (ediff-has-face-support-p) ediff-use-faces)
2740 (ediff-unhighlight-diff))
2741 ((eq ediff-highlighting-style 'ascii)
2742 (ediff-remove-flags-from-buffer
2744 (ediff-get-diff-overlay n 'A))
2745 (ediff-remove-flags-from-buffer
2747 (ediff-get-diff-overlay n 'B))
2749 (ediff-remove-flags-from-buffer
2751 (ediff-get-diff-overlay n 'C)))
2752 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2753 (ediff-remove-flags-from-buffer
2754 ediff-ancestor-buffer
2755 (ediff-get-diff-overlay n 'Ancestor)))
2757 (setq ediff-highlighting-style nil)
2759 ;; unhighlight fine diffs
2760 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2761 (run-hooks 'ediff-unselect-hook))))
2764 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2765 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2766 ;; next difference is selected, but the current selection is not
2767 ;; unselected. If FLAG is 'unselect-only then the current selection is
2768 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2769 ;; don't recenter buffers after selecting/unselecting.
2770 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2771 (let ((ediff-current-difference n))
2773 (ediff-recenter 'no-rehighlight)))
2775 (let ((control-buf ediff-control-buffer))
2778 (or (eq flag 'select-only)
2779 (ediff-unselect-difference ediff-current-difference))
2781 (or (eq flag 'unselect-only)
2782 (ediff-select-difference n))
2783 (setq ediff-current-difference n)
2784 ) ; end protected section
2786 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
2790 (defun ediff-read-file-name (prompt default-dir default-file)
2791 ; This is a modified version of a similar function in `emerge.el'.
2792 ; PROMPT should not have trailing ': ', so that it can be modified
2793 ; according to context.
2794 ; If default-file is set, it should be used as the default value.
2795 ; If default-dir is non-nil, use it as the default directory.
2796 ; Otherwise, use the value of Emacs' variable `default-directory.'
2798 ;; hack default-dir if it is not set
2800 (file-name-as-directory
2801 (ediff-abbreviate-file-name
2802 (expand-file-name (or default-dir
2804 (file-name-directory default-file))
2805 default-directory)))))
2807 ;; strip the directory from default-file
2809 (setq default-file (file-name-nondirectory default-file)))
2810 (if (string= default-file "")
2811 (setq default-file nil))
2814 (setq f (expand-file-name
2819 (concat " (default " default-file "):"))
2820 (t (concat " (default " default-dir "):"))))
2822 (or default-file default-dir)
2823 t ; must match, no-confirm
2824 (if default-file (file-name-directory default-file))
2828 ;; If user enters a directory name, expand the default file in that
2829 ;; directory. This allows the user to enter a directory name for the
2830 ;; B-file and diff against the default-file in that directory instead
2831 ;; of a DIRED listing!
2832 (if (and (file-directory-p f) default-file)
2833 (setq f (expand-file-name
2834 (file-name-nondirectory default-file) f)))
2837 ;; If PREFIX is given, then it is used as a prefix for the temp file
2838 ;; name. Otherwise, `ediff_' is used. If FILE is given, use this
2839 ;; file and don't create a new one.
2840 ;; On MS-DOS, make sure the prefix isn't longer than 7 characters, or
2841 ;; else `make-temp-name' isn't guaranteed to return a unique filename.
2842 ;; Also, save buffer from START to END in the file.
2843 ;; START defaults to (point-min), END to (point-max)
2844 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
2845 (let ((p (or prefix "ediff"))
2847 (if (and (eq system-type 'ms-dos) (> (length p) 7))
2848 (setq p (substring p 0 7)))
2850 (setq f (concat ediff-temp-file-prefix p)
2851 f (cond (given-file)
2852 ((find-file-name-handler f 'find-file-noselect)
2853 ;; to thwart file handlers in write-region, e.g., if file
2854 ;; name ends with .Z or .gz
2855 ;; This is needed so that patches produced by ediff will
2856 ;; have more meaningful names
2858 ;; Prefix is most often the same as the file name for the
2859 ;; variant. Here we are trying to use the original file name
2860 ;; but in the temp directory.
2861 ((and prefix (not (file-exists-p f))) f)
2862 ;; If a file with the orig name exists, add some random stuff
2864 (t (make-temp-name f))))
2867 (ediff-with-current-buffer buff
2868 (write-region (if start start (point-min))
2869 (if end end (point-max))
2871 nil ; don't append---erase
2873 (set-file-modes f ediff-temp-file-mode)
2874 (ediff-convert-standard-filename (expand-file-name f)))))
2876 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
2878 ;;(defun ediff-protect-metachars (str)
2879 ;; (or (memq system-type '(emx vax-vms axp-vms))
2881 ;; (while (string-match ediff-metachars str limit)
2882 ;; (setq str (concat (substring str 0 (match-beginning 0))
2884 ;; (substring str (match-beginning 0))))
2885 ;; (setq limit (1+ (match-end 0))))))
2888 ;; Make sure the current buffer (for a file) has the same contents as the
2889 ;; file on disk, and attempt to remedy the situation if not.
2890 ;; Signal an error if we can't make them the same, or the user doesn't want
2891 ;; to do what is necessary to make them the same.
2892 ;; Also, Ediff always offers to revert obsolete buffers, whether they
2893 ;; are modified or not.
2894 (defun ediff-verify-file-buffer (&optional file-magic)
2895 ;; First check if the file has been modified since the buffer visited it.
2896 (if (verify-visited-file-modtime (current-buffer))
2897 (if (buffer-modified-p)
2898 ;; If buffer is not obsolete and is modified, offer to save
2900 (format "Buffer out of sync with visited file. Save file %s? "
2906 (message "Couldn't save %s" buffer-file-name)))
2907 (error "Buffer is out of sync for file %s" buffer-file-name))
2908 ;; If buffer is not obsolete and is not modified, do nothing
2910 ;; If buffer is obsolete, offer to revert
2912 (format "Buffer is out of sync with visited file. REVERT file %s? "
2917 (revert-buffer t t))
2918 (error "Buffer out of sync for file %s" buffer-file-name))))
2921 (defun ediff-save-buffer (arg)
2922 "Safe way of saving buffers A, B, C, and the diff output.
2923 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
2924 and `wd' saves the diff output.
2926 With prefix argument, `wd' saves plain diff output.
2927 Without an argument, it saves customized diff argument, if available
2928 \(and plain output, if customized output was not generated\)."
2930 (ediff-barf-if-not-control-buffer)
2931 (ediff-compute-custom-diffs-maybe)
2932 (ediff-with-current-buffer
2933 (cond ((memq last-command-char '(?a ?b ?c))
2935 (ediff-char-to-buftype last-command-char)))
2936 ((eq last-command-char ?d)
2937 (message "Saving diff output ...")
2938 (sit-for 1) ; let the user see the message
2939 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2941 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2942 ediff-custom-diff-buffer)
2943 ((ediff-buffer-live-p ediff-diff-buffer)
2945 (t (error "Output from `diff' not found"))))
2949 (defun ediff-compute-custom-diffs-maybe ()
2950 (let ((buf-A-file-name (buffer-file-name ediff-buffer-A))
2951 (buf-B-file-name (buffer-file-name ediff-buffer-B))
2953 (if (stringp buf-A-file-name)
2954 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
2955 (if (stringp buf-B-file-name)
2956 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
2957 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name)
2958 file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
2960 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
2961 (setq ediff-custom-diff-buffer
2963 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
2965 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
2966 ediff-custom-diff-options file-A file-B)
2967 (delete-file file-A)
2968 (delete-file file-B)
2971 (defun ediff-show-diff-output (arg)
2973 (ediff-barf-if-not-control-buffer)
2974 (ediff-compute-custom-diffs-maybe)
2976 (ediff-skip-unsuitable-frames ' ok-unsplittable))
2977 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2979 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2980 ediff-custom-diff-buffer)
2981 ((ediff-buffer-live-p ediff-diff-buffer)
2985 (message "Output from `diff' not found")
2989 (ediff-with-current-buffer buf
2990 (goto-char (point-min)))
2991 (switch-to-buffer buf)
2992 (raise-frame (selected-frame)))))
2993 (if (frame-live-p ediff-control-frame)
2994 (ediff-reset-mouse ediff-control-frame))
2995 (if (window-live-p ediff-control-window)
2996 (select-window ediff-control-window)))
2999 (defun ediff-inferior-compare-regions ()
3000 "Compare regions in an active Ediff session.
3001 Like ediff-regions-linewise but is called from under an active Ediff session on
3002 the files that belong to that session.
3004 After quitting the session invoked via this function, type C-l to the parent
3005 Ediff Control Panel to restore highlighting."
3008 (possibilities (list ?A ?B ?C))
3010 (ctl-buf (current-buffer))
3012 begA begB endA endB bufA bufB)
3014 (cond ((ediff-merge-job)
3015 (setq bufB ediff-buffer-C)
3016 (while (cond ((eq answer ?A)
3017 (setq bufA ediff-buffer-A
3018 possibilities '(?B))
3021 (setq bufA ediff-buffer-B
3022 possibilities '(?A))
3026 (message "Valid values are A or B")
3029 (let ((cursor-in-echo-area t))
3030 (message "Which buffer to compare to the merge buffer (A/B)? ")
3031 (setq answer (capitalize (read-char-exclusive))))))
3033 ((ediff-3way-comparison-job)
3034 (while (cond ((memq answer possibilities)
3035 (setq possibilities (delq answer possibilities))
3038 (ediff-get-symbol-from-alist
3039 answer ediff-buffer-alist)))
3044 "Valid values are %s"
3045 (mapconcat 'char-to-string possibilities " or "))
3048 (let ((cursor-in-echo-area t))
3049 (message "Enter the 1st buffer you want to compare (%s): "
3050 (mapconcat 'char-to-string possibilities "/"))
3051 (setq answer (capitalize (read-char-exclusive)))))
3052 (setq answer "") ; silence error msg
3053 (while (cond ((memq answer possibilities)
3054 (setq possibilities (delq answer possibilities))
3057 (ediff-get-symbol-from-alist
3058 answer ediff-buffer-alist)))
3063 "Valid values are %s"
3064 (mapconcat 'char-to-string possibilities " or "))
3067 (let ((cursor-in-echo-area t))
3068 (message "Enter the 2nd buffer you want to compare (%s): "
3069 (mapconcat 'char-to-string possibilities "/"))
3070 (setq answer (capitalize (read-char-exclusive))))))
3071 (t ; 2way comparison
3072 (setq bufA ediff-buffer-A
3074 possibilities nil)))
3076 (ediff-with-current-buffer bufA
3078 (error "You forgot to specify a region in buffer %s" (buffer-name)))
3079 (setq begA (region-beginning)
3086 (or (eobp) (forward-char)) ; include the newline char
3087 (setq endA (point)))
3088 (ediff-with-current-buffer bufB
3090 (error "You forgot to specify a region in buffer %s" (buffer-name)))
3091 (setq begB (region-beginning)
3098 (or (eobp) (forward-char)) ; include the newline char
3099 (setq endB (point)))
3101 (ediff-unselect-and-select-difference
3102 ediff-current-difference 'unselect-only)
3103 (ediff-paint-background-regions 'unhighlight)
3105 (ediff-with-current-buffer bufA
3108 (narrow-to-region begA endA)
3109 ;; (ediff-activate-mark)
3112 (ediff-with-current-buffer bufB
3115 (narrow-to-region begB endB)
3116 ;; (ediff-activate-mark)
3120 ;; At this point, possibilities contains either the window char A/B/C
3121 ;; that was not selected, or it is nil. We delete the window that is not
3124 (ediff-with-current-buffer ctl-buf
3125 (let* ((wind-to-delete (eval
3126 (ediff-get-symbol-from-alist
3128 ediff-window-alist)))
3129 (frame (window-frame wind-to-delete)))
3130 (delete-window wind-to-delete)
3131 (select-frame frame)
3132 (balance-windows))))
3134 "Please check regions selected for comparison. Continue? ")
3137 (ediff-with-current-buffer bufA
3139 (ediff-with-current-buffer bufB
3142 (ediff-with-current-buffer ctl-buf
3145 (error "All right. Make up your mind and come back...")))
3147 (ediff-regions-internal
3148 bufA begA endA bufB begB endB
3150 'ediff-regions-linewise ; job name
3152 ;; setup param to pass to ediff-setup
3153 (list (cons 'ediff-split-window-function ediff-split-window-function)))
3158 (defun ediff-remove-flags-from-buffer (buffer overlay)
3159 (ediff-with-current-buffer buffer
3160 (let ((inhibit-read-only t))
3162 (ediff-overlay-put overlay 'begin-glyph nil)
3163 (ediff-overlay-put overlay 'before-string nil))
3166 (ediff-overlay-put overlay 'end-glyph nil)
3167 (ediff-overlay-put overlay 'after-string nil))
3172 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
3173 (ediff-with-current-buffer buffer
3174 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
3177 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
3178 (let* ((curr-overl (ediff-with-current-buffer ctl-buffer
3179 (ediff-get-diff-overlay diff-no buf-type)))
3180 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
3181 after beg-of-line flag)
3183 ;; insert flag before the difference
3185 (setq beg-of-line (bolp))
3187 (setq flag (ediff-with-current-buffer ctl-buffer
3188 (if (eq ediff-highlighting-style 'ascii)
3190 ediff-before-flag-bol ediff-before-flag-mol))))
3192 ;; insert the flag itself
3194 (ediff-overlay-put curr-overl 'begin-glyph flag)
3195 (ediff-overlay-put curr-overl 'before-string flag))
3197 ;; insert the flag after the difference
3198 ;; `after' must be set here, after the before-flag was inserted
3199 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
3201 (setq beg-of-line (bolp))
3203 (setq flag (ediff-with-current-buffer ctl-buffer
3204 (if (eq ediff-highlighting-style 'ascii)
3206 ediff-after-flag-eol ediff-after-flag-mol))))
3208 ;; insert the flag itself
3210 (ediff-overlay-put curr-overl 'end-glyph flag)
3211 (ediff-overlay-put curr-overl 'after-string flag))
3215 ;; Returns positions of difference sectors in the BUF-TYPE buffer.
3216 ;; BUF-TYPE should be a symbol -- `A', `B', or `C'.
3217 ;; POS is either `beg' or `end'--it specifies whether you want the position at
3218 ;; the beginning of a difference or at the end.
3220 ;; The optional argument N says which difference (default:
3221 ;; `ediff-current-difference'). N is the internal difference number (1- what
3222 ;; the user sees). The optional argument CONTROL-BUF says
3223 ;; which control buffer is in effect in case it is not the current
3225 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
3228 (setq control-buf (current-buffer)))
3230 (ediff-with-current-buffer control-buf
3231 (or n (setq n ediff-current-difference))
3232 (if (or (< n 0) (>= n ediff-number-of-differences))
3233 (if (> ediff-number-of-differences 0)
3234 (error ediff-BAD-DIFF-NUMBER
3235 this-command (1+ n) ediff-number-of-differences)
3236 (error ediff-NO-DIFFERENCES)))
3237 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
3238 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
3239 (error ediff-KILLED-VITAL-BUFFER))
3241 (ediff-overlay-start diff-overlay)
3242 (ediff-overlay-end diff-overlay))
3246 ;; Restore highlighting to what it should be according to ediff-use-faces,
3247 ;; ediff-highlighting-style, and ediff-highlight-all-diffs variables.
3248 (defun ediff-restore-highlighting (&optional ctl-buf)
3249 (ediff-with-current-buffer (or ctl-buf (current-buffer))
3250 (if (and (ediff-has-face-support-p)
3252 ediff-highlight-all-diffs)
3253 (ediff-paint-background-regions))
3254 (ediff-select-difference ediff-current-difference)))
3258 ;; null out difference overlays so they won't slow down future
3259 ;; editing operations
3260 ;; VEC is either a difference vector or a fine-diff vector
3261 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
3262 (if (vectorp (symbol-value vec-var))
3265 (ediff-delete-overlay
3266 (ediff-get-diff-overlay-from-diff-record elt))
3268 (ediff-clear-fine-diff-vector elt))
3270 (symbol-value vec-var)))
3271 ;; allow them to be garbage collected
3278 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
3279 ;; supporting sticky overlays, this function will make a sticky overlay.
3280 ;; BEG and END are expressions telling where overlay starts.
3281 ;; If they are numbers or buffers, then all is well. Otherwise, they must
3282 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
3284 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
3285 ;; newly created overlay.
3286 (defun ediff-make-bullet-proof-overlay (beg end buff)
3287 (if (ediff-buffer-live-p buff)
3289 (ediff-with-current-buffer buff
3290 (or (number-or-marker-p beg)
3291 (setq beg (eval beg)))
3292 (or (number-or-marker-p end)
3293 (setq end (eval end)))
3296 (make-extent beg end buff)
3297 ;; advance front and rear of the overlay
3298 (make-overlay beg end buff nil 'rear-advance)))
3302 overl (if ediff-emacs-p 'evaporate 'detachable) nil)
3303 ;; make vip-minibuffer-overlay open-ended
3304 ;; In emacs, it is made open ended at creation time
3307 (ediff-overlay-put overl 'start-open nil)
3308 (ediff-overlay-put overl 'end-open nil)))
3309 (ediff-overlay-put overl 'ediff-diff-num 0)
3313 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3314 ;; other insignificant buffers (those beginning with "^[ *]").
3315 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3317 (defun ediff-other-buffer (buff)
3318 (if (not (listp buff)) (setq buff (list buff)))
3319 (let* ((frame-buffers (buffer-list))
3320 (significant-buffers
3322 (function (lambda (x)
3323 (cond ((member (buffer-name x) buff)
3325 ((not (ediff-get-visible-buffer-window x))
3327 ((string-match "^ " (buffer-name x))
3331 (buffers (delq nil significant-buffers))
3332 less-significant-buffers)
3334 (cond (buffers (car buffers))
3335 ;; try also buffers that are not displayed in windows
3336 ((setq less-significant-buffers
3341 (cond ((member (buffer-name x) buff) nil)
3342 ((string-match "^[ *]" (buffer-name x)) nil)
3345 (car less-significant-buffers))
3346 (t (other-buffer (current-buffer))))
3350 ;; Construct a unique buffer name.
3351 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3352 ;; prefix<3>suffix, etc.
3353 (defun ediff-unique-buffer-name (prefix suffix)
3354 (if (null (get-buffer (concat prefix suffix)))
3355 (concat prefix suffix)
3357 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3359 (format "%s<%d>%s" prefix n suffix))))
3362 (defun ediff-submit-report ()
3363 "Submit bug report on Ediff."
3365 (ediff-barf-if-not-control-buffer)
3366 (let ((reporter-prompt-for-summary-p t)
3367 (ctl-buf ediff-control-buffer)
3368 (ediff-device-type (ediff-device-type))
3369 varlist salutation buffer-name)
3370 (setq varlist '(ediff-diff-program ediff-diff-options
3371 ediff-patch-program ediff-patch-options
3374 ediff-auto-refine ediff-highlighting-style
3375 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3376 ediff-forward-word-function
3378 ediff-control-frame-parameters
3379 ediff-control-frame-position-function
3380 ediff-prefer-iconified-control-frame
3381 ediff-window-setup-function
3382 ediff-split-window-function
3389 Congratulations! You may have unearthed a bug in Ediff!
3391 Please make a concise and accurate summary of what happened
3392 and mail it to the address above.
3393 -----------------------------------------------------------
3396 (ediff-skip-unsuitable-frames)
3399 (switch-to-buffer ediff-msg-buffer)
3401 (delete-other-windows)
3403 Please read this first:
3404 ----------------------
3406 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3407 reporting that certain difference regions are not matched as you think they
3408 should, this is most likely due to the way Unix diff program decides what
3409 constitutes a difference region. Ediff is an Emacs interface to diff, and
3410 it has nothing to do with those decisions---it only takes the output from
3411 diff and presents it in a way that is better suited for human browsing and
3414 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3415 an Emacs bug. Report this to Emacs maintainers.
3417 Another popular topic for reports is compilation messages. Because Ediff
3418 interfaces to several other packages and runs under Emacs and XEmacs,
3419 byte-compilation may produce output like this:
3421 While compiling toplevel forms in file ediff.el:
3422 ** reference to free variable pm-color-alist
3423 ........................
3424 While compiling the end of the data:
3425 ** The following functions are not known to be defined:
3426 ediff-valid-color-p, ediff-set-face,
3427 ........................
3429 These are NOT errors, but inevitable warnings, which ought to be ignored.
3431 Please do not report those and similar things. However, comments and
3432 suggestions are always welcome.
3434 Mail anyway? (y or n) ")
3436 (if (y-or-n-p "Mail anyway? ")
3438 (if (ediff-buffer-live-p ctl-buf)
3439 (set-buffer ctl-buf))
3440 (setq buffer-name (buffer-name))
3442 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
3446 'delete-other-windows
3449 (beep 1)(message "Bug report aborted")
3450 (if (ediff-buffer-live-p ctl-buf)
3451 (ediff-with-current-buffer ctl-buf
3452 (ediff-recenter 'no-rehighlight))))
3456 (defun ediff-deactivate-mark ()
3458 (zmacs-deactivate-region)
3460 (defun ediff-activate-mark ()
3462 (setq mark-active t)
3463 (zmacs-activate-region)))
3465 (cond ((fboundp 'nuke-selective-display)
3466 ;; XEmacs 19.12 has nuke-selective-display
3467 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
3469 (defun ediff-nuke-selective-display ()
3473 (goto-char (point-min))
3474 (let ((mod-p (buffer-modified-p))
3475 buffer-read-only end)
3476 (and (eq t selective-display)
3477 (while (search-forward "\^M" nil t)
3481 (while (search-forward "\^M" end t)
3484 (set-buffer-modified-p mod-p)
3485 (setq selective-display nil)))))
3489 ;; The next two are modified versions from emerge.el.
3490 ;; VARS must be a list of symbols
3491 ;; ediff-save-variables returns an association list: ((var . val) ...)
3492 (defsubst ediff-save-variables (vars)
3493 (mapcar (function (lambda (v) (cons v (symbol-value v))))
3495 ;; VARS is a list of variable symbols.
3496 (defun ediff-restore-variables (vars assoc-list)
3498 (set (car vars) (cdr (assoc (car vars) assoc-list)))
3499 (setq vars (cdr vars))))
3501 (defun ediff-change-saved-variable (var value buf-type)
3503 (symbol-value (ediff-get-symbol-from-alist
3505 ediff-buffer-values-orig-alist)))
3506 (assoc-elt (assoc var assoc-list)))
3508 (setcdr assoc-elt value))))
3511 ;; must execute in control buf
3512 (defun ediff-save-protected-variables ()
3513 (setq ediff-buffer-values-orig-A
3514 (ediff-with-current-buffer ediff-buffer-A
3515 (ediff-save-variables ediff-protected-variables)))
3516 (setq ediff-buffer-values-orig-B
3517 (ediff-with-current-buffer ediff-buffer-B
3518 (ediff-save-variables ediff-protected-variables)))
3519 (if ediff-3way-comparison-job
3520 (setq ediff-buffer-values-orig-C
3521 (ediff-with-current-buffer ediff-buffer-C
3522 (ediff-save-variables ediff-protected-variables))))
3523 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3524 (setq ediff-buffer-values-orig-Ancestor
3525 (ediff-with-current-buffer ediff-ancestor-buffer
3526 (ediff-save-variables ediff-protected-variables)))))
3528 ;; must execute in control buf
3529 (defun ediff-restore-protected-variables ()
3530 (let ((values-A ediff-buffer-values-orig-A)
3531 (values-B ediff-buffer-values-orig-B)
3532 (values-C ediff-buffer-values-orig-C)
3533 (values-Ancestor ediff-buffer-values-orig-Ancestor))
3534 (ediff-with-current-buffer ediff-buffer-A
3535 (ediff-restore-variables ediff-protected-variables values-A))
3536 (ediff-with-current-buffer ediff-buffer-B
3537 (ediff-restore-variables ediff-protected-variables values-B))
3538 (if ediff-3way-comparison-job
3539 (ediff-with-current-buffer ediff-buffer-C
3540 (ediff-restore-variables ediff-protected-variables values-C)))
3541 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3542 (ediff-with-current-buffer ediff-ancestor-buffer
3543 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
3546 ;; save BUFFER in FILE. used in hooks.
3547 (defun ediff-save-buffer-in-file (buffer file)
3548 (ediff-with-current-buffer buffer
3554 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3556 ;; calculate time used by command
3557 (defun ediff-calc-command-time ()
3558 (let ((end (current-time))
3561 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3562 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3563 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3564 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3565 (or (equal ediff-command-begin-time '(0 0 0))
3566 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3568 (defsubst ediff-save-time ()
3569 (setq ediff-command-begin-time (current-time)))
3571 (defun ediff-profile ()
3572 "Toggle profiling Ediff commands."
3574 (ediff-barf-if-not-control-buffer)
3575 (make-local-hook 'post-command-hook)
3576 (let ((pre-hook 'pre-command-hook)
3577 (post-hook 'post-command-hook))
3578 (if (not (equal ediff-command-begin-time '(0 0 0)))
3579 (progn (remove-hook pre-hook 'ediff-save-time)
3580 (remove-hook post-hook 'ediff-calc-command-time)
3581 (setq ediff-command-begin-time '(0 0 0))
3582 (message "Ediff profiling disabled"))
3583 (add-hook pre-hook 'ediff-save-time t t)
3584 (add-hook post-hook 'ediff-calc-command-time nil t)
3585 (message "Ediff profiling enabled"))))
3587 (defun ediff-print-diff-vector (diff-vector-var)
3588 (princ (format "\n*** %S ***\n" diff-vector-var))
3593 "Diff %d: \tOverlay: %S
3595 \t\tNo-fine-diff-flag: %S
3596 \t\tState-of-diff:\t %S
3597 \t\tState-of-merge:\t %S
3599 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3602 (if (= (length (aref overl-vec 1)) 0)
3604 (mapconcat 'prin1-to-string
3605 (aref overl-vec 1) "\n\t\t\t "))
3606 (aref overl-vec 2) ; no fine diff flag
3607 (aref overl-vec 3) ; state-of-diff
3608 (aref overl-vec 4) ; state-of-merge
3610 (eval diff-vector-var)))
3614 (defun ediff-debug-info ()
3616 (ediff-barf-if-not-control-buffer)
3617 (with-output-to-temp-buffer ediff-debug-buffer
3618 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3619 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
3620 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
3621 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
3622 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
3626 ;;; General utilities
3628 ;; this uses comparison-func to decide who is a member
3629 (defun ediff-member (elt lis comparison-func)
3630 (while (and lis (not (funcall comparison-func (car lis) elt)))
3631 (setq lis (cdr lis)))
3634 ;; this uses comparison-func to decide who is a member, and this determines how
3635 ;; intersection looks like
3636 (defun ediff-intersection (lis1 lis2 comparison-func)
3637 (let ((result (list 'a)))
3639 (if (ediff-member (car lis1) lis2 comparison-func)
3640 (nconc result (list (car lis1))))
3641 (setq lis1 (cdr lis1)))
3645 ;; eliminates duplicates using comparison-func
3646 (defun ediff-union (lis1 lis2 comparison-func)
3647 (let ((result (list 'a)))
3649 (or (ediff-member (car lis1) (cdr result) comparison-func)
3650 (nconc result (list (car lis1))))
3651 (setq lis1 (cdr lis1)))
3653 (or (ediff-member (car lis2) (cdr result) comparison-func)
3654 (nconc result (list (car lis2))))
3655 (setq lis2 (cdr lis2)))
3658 ;; eliminates duplicates using comparison-func
3659 (defun ediff-set-difference (lis1 lis2 comparison-func)
3660 (let ((result (list 'a)))
3662 (or (ediff-member (car lis1) (cdr result) comparison-func)
3663 (ediff-member (car lis1) lis2 comparison-func)
3664 (nconc result (list (car lis1))))
3665 (setq lis1 (cdr lis1)))
3668 (defun ediff-copy-list (list)
3671 ;;; (while (consp list) (push (pop list) res))
3672 ;;; (prog1 (nreverse res) (setcdr res list)))
3675 (setq elt (car list)
3682 ;; don't report error if version control package wasn't found
3683 ;;(ediff-load-version-control 'silent)
3685 (run-hooks 'ediff-load-hook)
3688 ;;; Local Variables:
3689 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3690 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
3691 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
3694 ;;; ediff-util.el ends here