1 ;;; ediff-util.el --- the core commands and utilities of ediff
2 ;;; Copyright (C) 1994 Free Software Foundation, Inc.
4 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to
20 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
31 "Ediff mode is used by the Ediff file-difference package.
32 It is entered only through one of the following commands:
41 `ediff-merge-files-with-ancestor'
43 `ediff-merge-buffers-with-ancestor'
44 `ediff-merge-revisions'
45 `ediff-merge-revisions-with-ancestor'
57 (kill-all-local-variables)
58 (setq major-mode 'ediff-mode)
59 (setq mode-name "Ediff")
60 (run-hooks 'ediff-mode-hooks))
62 (defun ediff-version ()
63 "Return string describing the version of Ediff.
64 When called interactively, displays the version."
67 (message (ediff-version))
68 (format "Ediff %s of %s" ediff-version ediff-date)))
77 (ediff-defvar-local ediff-mode-map nil
78 "Local keymap used in Ediff mode.
79 This is local to each Ediff Control Panel, so they may vary from invocation
82 ;; Set up the keymap in the control buffer
83 (defun ediff-set-keys ()
84 "Set up Ediff keymap, if necessary."
85 (if (null ediff-mode-map)
87 (use-local-map ediff-mode-map))
89 ;; Reload Ediff keymap. For debugging only.
90 (defun ediff-reload-keymap ()
92 (setq ediff-mode-map nil)
96 (defun ediff-setup-keymap ()
97 "Set up the keymap used in the control buffer of Ediff."
98 (setq ediff-mode-map (make-sparse-keymap))
99 (suppress-keymap ediff-mode-map)
101 (define-key ediff-mode-map "p" 'ediff-previous-difference)
102 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
103 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
104 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
105 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
106 'ediff-previous-difference nil))
107 (define-key ediff-mode-map "n" 'ediff-next-difference)
108 (define-key ediff-mode-map " " 'ediff-next-difference)
109 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
110 (define-key ediff-mode-map "g" nil)
111 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
112 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
113 (define-key ediff-mode-map "q" 'ediff-quit)
114 (define-key ediff-mode-map "z" 'ediff-suspend)
115 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
116 (define-key ediff-mode-map "|" 'ediff-toggle-split)
117 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
119 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
120 (if ediff-word-mode-job
121 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
122 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
123 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
124 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
125 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
126 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
127 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
128 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
129 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
130 (define-key ediff-mode-map "i" 'ediff-status-info)
131 (define-key ediff-mode-map "?" 'ediff-toggle-help)
132 (define-key ediff-mode-map "!" 'ediff-update-diffs)
134 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
135 (define-key ediff-mode-map "a" nil)
136 (define-key ediff-mode-map "b" nil)
137 (define-key ediff-mode-map "r" nil)
138 (cond (ediff-merge-job
139 ;; In merging, we allow only A->C and B->C copying.
140 (define-key ediff-mode-map "a" (function
143 (ediff-diff-to-diff arg "ac"))))
144 (define-key ediff-mode-map "b" (function
147 (ediff-diff-to-diff arg "bc"))))
148 (define-key ediff-mode-map "r" (function
151 (ediff-restore-diff arg ?c))))
152 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
153 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
154 (define-key ediff-mode-map "$" 'ediff-toggle-show-clashes-only)
155 (define-key ediff-mode-map "&" 'ediff-re-merge))
156 (ediff-3way-comparison-job
157 (define-key ediff-mode-map "ab" 'ediff-diff-to-diff)
158 (define-key ediff-mode-map "ba" 'ediff-diff-to-diff)
159 (define-key ediff-mode-map "ac" 'ediff-diff-to-diff)
160 (define-key ediff-mode-map "bc" 'ediff-diff-to-diff)
161 (define-key ediff-mode-map "c" nil)
162 (define-key ediff-mode-map "ca" 'ediff-diff-to-diff)
163 (define-key ediff-mode-map "cb" 'ediff-diff-to-diff)
164 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
165 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
166 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
167 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
168 (t ; 2-way comparison
169 (define-key ediff-mode-map "a" (function
172 (ediff-diff-to-diff arg "ab"))))
173 (define-key ediff-mode-map "b" (function
176 (ediff-diff-to-diff arg "ba"))))
177 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
178 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
180 (define-key ediff-mode-map "G" 'ediff-submit-report)
181 (define-key ediff-mode-map "#" nil)
182 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
183 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
185 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
186 (define-key ediff-mode-map "o" nil)
187 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
188 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
189 (define-key ediff-mode-map "w" nil)
190 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
191 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
192 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
195 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
196 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
199 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
201 (define-key ediff-mode-map "k" nil)
202 (define-key ediff-mode-map "kkk" 'ediff-reload-keymap) ; for debugging
204 ;; Allow ediff-mode-map to be referenced indirectly
205 (fset 'ediff-mode-map ediff-mode-map)
206 (run-hooks 'ediff-keymap-setup-hooks))
211 (require 'ediff-wind)
213 ;; Common startup entry for all Ediff functions
214 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
215 startup-hooks setup-parameters)
216 (setq file-A (expand-file-name file-A))
217 (setq file-B (expand-file-name file-B))
219 (setq file-C (expand-file-name file-C)))
220 (let* ((control-buffer-name
221 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
222 (control-buffer (ediff-eval-in-buffer buffer-A
223 (get-buffer-create control-buffer-name))))
224 (ediff-eval-in-buffer control-buffer
227 ;; unwrap set up parameters passed as argument
228 (while setup-parameters
229 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
230 (setq setup-parameters (cdr setup-parameters)))
232 ;; set variables classifying the current ediff job
233 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
234 ediff-merge-job (ediff-merge-job)
235 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
236 ediff-3way-job (ediff-3way-job)
237 ediff-diff3-job (ediff-diff3-job)
238 ediff-word-mode-job (ediff-word-mode-job))
240 (make-local-variable 'ediff-prefer-long-help-message)
241 (make-local-variable 'ediff-prefer-iconified-control-frame)
242 (make-local-variable 'ediff-split-window-function)
243 (make-local-variable 'ediff-default-variant)
244 (make-local-variable 'ediff-merge-window-share)
246 ;; adjust for merge jobs
249 ;; Use buf A even if `combined'. The right stuff is
250 ;; inserted by ediff-do-merge
251 (if (eq ediff-default-variant 'default-B) buffer-B buffer-A)))
253 (setq ediff-split-window-function
254 ediff-merge-split-window-function)
256 ;; remember the ancestor buffer, if any
257 (setq ediff-ancestor-buffer buffer-C)
261 (ediff-unique-buffer-name "*ediff-merge" "*")))
263 (set-buffer buffer-C)
264 (insert-buffer buf))))
265 (setq buffer-read-only nil
266 ediff-buffer-A buffer-A
267 ediff-buffer-B buffer-B
268 ediff-buffer-C buffer-C
269 ediff-control-buffer control-buffer)
271 (setq ediff-control-buffer-suffix
272 (if (string-match "<[0-9]*>" control-buffer-name)
273 (substring control-buffer-name
274 (match-beginning 0) (match-end 0))
276 ediff-control-buffer-number
282 ediff-control-buffer-suffix
284 (string-match "[0-9]+" ediff-control-buffer-suffix)
287 (setq ediff-error-buffer (get-buffer-create (ediff-unique-buffer-name
288 "*ediff-errors" "*")))
290 (ediff-eval-in-buffer buffer-A (ediff-strip-mode-line-format))
291 (ediff-eval-in-buffer buffer-B (ediff-strip-mode-line-format))
293 (ediff-eval-in-buffer buffer-C (ediff-strip-mode-line-format)))
295 (ediff-save-protected-variables) ; save variables to be restored on exit
297 ;; This will be deleted when emacs gets before/after strings
298 (ediff-remember-buffer-characteristics t) ; remember at setup
300 ;; ediff-setup-diff-regions-function must be set after setup
301 ;; parameters are processed.
302 (setq ediff-setup-diff-regions-function
304 'ediff-setup-diff-regions3
305 'ediff-setup-diff-regions))
309 (make-local-variable 'default-minibuffer-frame))
311 (setq ediff-wide-bounds
312 (list (ediff-make-bullet-proof-overlay
313 '(point-min) '(point-max) ediff-buffer-A)
314 (ediff-make-bullet-proof-overlay
315 '(point-min) '(point-max) ediff-buffer-B)
316 (ediff-make-bullet-proof-overlay
317 '(point-min) '(point-max) ediff-buffer-C)))
319 ;; This has effect only on ediff-windows/regions
320 ;; In all other cases, ediff-visible-region sets visibility bounds to
321 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
322 (if ediff-start-narrowed
323 (setq ediff-visible-bounds ediff-narrow-bounds)
324 (setq ediff-visible-bounds ediff-wide-bounds))
326 (ediff-set-keys) ; comes after parameter setup
328 ;; set up ediff-narrow-bounds, if not set
329 (or ediff-narrow-bounds
330 (setq ediff-narrow-bounds ediff-wide-bounds))
332 ;; The following will go away once before/after-string overlay
333 ;; properties are added to emacs 19. The only thing that will remain
334 ;; are the calls to ediff-prepare-buffer-hooks, nuking the selective
335 ;; display, and setting files A/B r/o for merge.
337 ;; All these must be inside ediff-eval-in-buffer control-buffer,
338 ;; since these vars are local to control-buffer
339 ;; These won't run if there are errors in diff
340 (ediff-eval-in-buffer ediff-buffer-A
341 (ediff-nuke-selective-display)
342 (run-hooks 'ediff-prepare-buffer-hooks)
343 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
344 (setq buffer-read-only t))
345 (add-hook 'local-write-file-hooks 'ediff-block-write-file)
346 (setq before-change-function 'ediff-before-change-guard)
347 ;; add control-buffer to the list of sessions
348 (or (memq control-buffer ediff-this-buffer-control-sessions)
349 (setq ediff-this-buffer-control-sessions
350 (cons control-buffer ediff-this-buffer-control-sessions)))
352 (ediff-eval-in-buffer ediff-buffer-B
353 (ediff-nuke-selective-display)
354 (run-hooks 'ediff-prepare-buffer-hooks)
355 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
356 (setq buffer-read-only t))
357 (add-hook 'local-write-file-hooks 'ediff-block-write-file)
358 (setq before-change-function 'ediff-before-change-guard)
359 ;; add control-buffer to the list of sessions
360 (or (memq control-buffer ediff-this-buffer-control-sessions)
361 (setq ediff-this-buffer-control-sessions
362 (cons control-buffer ediff-this-buffer-control-sessions)))
365 (ediff-eval-in-buffer ediff-buffer-C
366 (ediff-nuke-selective-display)
367 (run-hooks 'ediff-prepare-buffer-hooks)
368 (add-hook 'local-write-file-hooks 'ediff-block-write-file)
369 (setq before-change-function 'ediff-before-change-guard)
370 ;; add control-buffer to the list of sessions
371 (or (memq control-buffer ediff-this-buffer-control-sessions)
372 (setq ediff-this-buffer-control-sessions
374 ediff-this-buffer-control-sessions)))
377 ;; must come after setting up ediff-narrow-bounds AND after
378 ;; nuking selective display
379 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
380 (setq ediff-number-of-differences (length ediff-difference-vector-A))
381 (setq ediff-current-difference -1)
383 (ediff-make-current-diff-overlay 'A)
384 (ediff-make-current-diff-overlay 'B)
386 (ediff-make-current-diff-overlay 'C))
389 (ediff-init-var-faces))
391 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
393 (let ((shift-A (ediff-overlay-start
394 (ediff-get-value-according-to-buffer-type
395 'A ediff-narrow-bounds)))
396 (shift-B (ediff-overlay-start
397 (ediff-get-value-according-to-buffer-type
398 'B ediff-narrow-bounds)))
399 (shift-C (ediff-overlay-start
400 (ediff-get-value-according-to-buffer-type
401 'C ediff-narrow-bounds))))
402 ;; position point in buf A
404 (select-window ediff-window-A)
406 ;; position point in buf B
408 (select-window ediff-window-B)
412 (select-window ediff-window-C)
413 (goto-char shift-C)))
416 (select-window ediff-control-window)
417 (ediff-visible-region)
419 ;; The following is a hack to placate OS/2
420 ;; The problem is that OS/2 doesn't let us delete files used by other
421 ;; processes. Thus, in ediff-buffers and other functions, we can't
422 ;; delete temp files because they might be used by the asynchronous
423 ;; process that computes custom diffs. So, under OS/1 we have to wait
424 ;; for some time until custom diffs are done.
425 (if (eq system-type 'emx)
426 (ediff-eval-in-buffer ediff-custom-diff-buffer
427 (let ((proc (get-buffer-process (current-buffer))))
428 (while (and (processp proc)
429 (eq (process-status proc) 'run))
430 (message "Waiting for the diff program to quit")
436 (run-hooks 'startup-hooks 'ediff-startup-hooks)
437 (ediff-refresh-mode-lines)
438 (setq buffer-read-only t))))
441 ;; This function assumes that we are in the window where control buffer is
443 (defun ediff-setup-control-buffer (ctl-buf)
444 "Set up window for control buffer."
445 (if (window-dedicated-p (selected-window))
446 (set-buffer ctl-buf) ; we are in control frame but just in case
447 (switch-to-buffer ctl-buf))
448 (let ((window-min-height 1))
450 (ediff-set-help-message)
451 (insert ediff-help-message)
452 (shrink-window-if-larger-than-buffer)
453 (if (not ediff-multiframe)
454 (ediff-indent-help-message))
455 (set-buffer-modified-p nil)
456 (ediff-refresh-mode-lines)
457 (setq ediff-control-window (selected-window))
458 (setq ediff-window-config-saved
464 ediff-split-window-function))
465 (goto-char (point-min))
466 (skip-chars-forward ediff-whitespace)))
468 ;; assuming we are in control window, calculate length of the first line in
470 (defun ediff-help-message-line-length ()
472 (goto-char (point-min))
473 (if ediff-prefer-long-help-message
479 (defun ediff-indent-help-message ()
480 (let* ((shift (/ (max 0 (- (ediff-frame-width (ediff-selected-frame))
481 (ediff-help-message-line-length)))
483 (str (make-string shift ?\ )))
485 (goto-char (point-min))
486 (while (< (point) (point-max))
492 (defun ediff-set-help-message ()
493 (setq ediff-long-help-message
494 (cond ((and ediff-long-help-message-custom
495 (or (symbolp ediff-long-help-message-custom)
496 (consp ediff-long-help-message-custom)))
497 (funcall ediff-long-help-message-custom))
499 (concat ediff-long-help-message-head
500 ediff-long-help-message-word-mode
501 ediff-long-help-message-tail))
503 (concat ediff-long-help-message-head
504 ediff-long-help-message-merge
505 ediff-long-help-message-tail))
507 (concat ediff-long-help-message-head
508 ediff-long-help-message-compare3
509 ediff-long-help-message-tail))
511 (concat ediff-long-help-message-head
512 ediff-long-help-message-compare2
513 ediff-long-help-message-tail))))
514 (setq ediff-brief-help-message
515 (cond ((and ediff-brief-help-message-custom
516 (or (symbolp ediff-brief-help-message-custom)
517 (consp ediff-brief-help-message-custom)))
518 (funcall ediff-brief-help-message-custom))
519 ((stringp ediff-brief-help-message-custom)
520 ediff-brief-help-message-custom)
521 ((ediff-multiframe-setup-p) ediff-brief-message-string)
522 (t ; long brief msg, not multiframe --- put in the middle
523 ediff-brief-message-string)
525 (setq ediff-help-message (if ediff-prefer-long-help-message
526 ediff-long-help-message
527 ediff-brief-help-message))
528 (run-hooks 'ediff-display-help-hooks)
534 ;;; Commands for working with Ediff
536 (defun ediff-update-diffs ()
537 "Recompute difference regions in buffers A, B, and C.
538 Buffers are not synchronized with their respective files, so changes done
539 to these buffers are not saved at this point---the user can do this later,
542 (let ((point-A (ediff-eval-in-buffer ediff-buffer-A (point)))
543 ;;(point-B (ediff-eval-in-buffer ediff-buffer-B (point)))
544 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
546 (file-name-nondirectory (or (buffer-file-name ediff-buffer-A)
547 (buffer-name ediff-buffer-A)
550 (file-name-nondirectory (or (buffer-file-name ediff-buffer-B)
551 (buffer-name ediff-buffer-B)
554 (file-name-nondirectory (or (buffer-file-name ediff-buffer-C)
555 ;; if (null ediff-buffer-C), there is
556 ;; no danger, since we later check if
557 ;; ediff-buffer-C is alive
558 (buffer-name ediff-buffer-C)
560 (overl-A (ediff-get-value-according-to-buffer-type
561 'A ediff-narrow-bounds))
562 (overl-B (ediff-get-value-according-to-buffer-type
563 'B ediff-narrow-bounds))
564 (overl-C (ediff-get-value-according-to-buffer-type
565 'C ediff-narrow-bounds))
566 beg-A end-A beg-B end-B beg-C end-C
567 file-A file-B file-C)
568 (ediff-unselect-and-select-difference -1)
570 (setq beg-A (ediff-overlay-start overl-A)
571 beg-B (ediff-overlay-start overl-B)
572 beg-C (ediff-overlay-start overl-C)
573 end-A (ediff-overlay-end overl-A)
574 end-B (ediff-overlay-end overl-B)
575 end-C (ediff-overlay-end overl-C))
579 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
580 (ediff-eval-in-buffer tmp-buffer
581 (setq file-A (ediff-make-temp-file "regA")))
582 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
583 (ediff-eval-in-buffer tmp-buffer
584 (setq file-B (ediff-make-temp-file "regB")))
587 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
588 (ediff-eval-in-buffer tmp-buffer
589 (setq file-C (ediff-make-temp-file "regC")))))
592 (ediff-eval-in-buffer ediff-buffer-A
593 (setq file-A (ediff-make-temp-file buf-A-file-name)))
594 (ediff-eval-in-buffer ediff-buffer-B
595 (setq file-B (ediff-make-temp-file buf-B-file-name)))
597 (ediff-eval-in-buffer ediff-buffer-C
598 (setq file-C (ediff-make-temp-file buf-C-file-name))))
601 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
602 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
603 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
604 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
606 ;; In case of merge job, full it into thinking that it is just doing
608 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
609 (ediff-job-name ediff-job-name))
611 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
612 ediff-job-name 'ediff-files3))
613 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
615 (setq ediff-number-of-differences (length ediff-difference-vector-A))
619 (delete-file file-C))
622 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
624 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
628 ;; Not bound to any key---to dangerous. A user can do it if necessary.
629 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
630 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
632 (let ((bufA ediff-buffer-A)
633 (bufB ediff-buffer-B)
634 (bufC ediff-buffer-C)
635 (ctl-buf ediff-control-buffer)
636 (ancestor-buf ediff-ancestor-buffer)
637 (ancestor-job ediff-merge-with-ancestor-job)
638 (merge ediff-merge-job)
639 (comparison ediff-3way-comparison-job))
640 (ediff-eval-in-buffer bufA
641 (revert-buffer t noconfirm))
642 (ediff-eval-in-buffer bufB
643 (revert-buffer t noconfirm))
644 ;; this should only be executed in a 3way comparison, not in merge
646 (ediff-eval-in-buffer bufC
647 (revert-buffer t noconfirm)))
654 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
655 (ediff-merge-buffers bufA bufB)))
656 (ediff-update-diffs))))
659 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
660 (defun ediff-recenter (&optional no-rehighlight)
661 "Bring the highlighted region of all buffers being compared into view.
662 Reestablish the default three-window display."
665 ;; force all minibuffer to display ediff's messages.
666 ;; when xemacs implements minibufferless screens, this won't be necessary
667 (if ediff-xemacs-p (setq synchronize-minibuffers t))
669 (setq ediff-disturbed-overlays nil) ; clear after use
670 (let (buffer-read-only)
671 (if (and (ediff-buffer-live-p ediff-buffer-A)
672 (ediff-buffer-live-p ediff-buffer-B)
673 (or (not ediff-3way-job)
674 (ediff-buffer-live-p ediff-buffer-C))
677 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
678 (or (eq this-command 'ediff-quit)
680 "You've killed an essential Ediff buffer---Please quit Ediff"
684 ;; set visibility range appropriate to this invocation of Ediff.
685 (ediff-visible-region)
688 (if (and window-system
689 (symbolp this-command)
690 (symbolp last-command)
691 ;; Either one of the display-changing commands
692 (or (memq this-command
694 ediff-toggle-wide-display ediff-toggle-multiframe))
695 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
696 ;; This avoids rasing frames unnecessarily.
697 (and (memq this-command
698 '(ediff-next-difference
699 ediff-previous-difference
700 ediff-jump-to-difference
701 ediff-jump-to-difference-at-point))
702 (not (string-match "^ediff-" (symbol-name last-command)))
705 (if (window-live-p ediff-window-A)
706 (ediff-raise-frame (ediff-window-frame ediff-window-A)))
707 (if (window-live-p ediff-window-B)
708 (ediff-raise-frame (ediff-window-frame ediff-window-B)))
709 (if (window-live-p ediff-window-C)
710 (ediff-raise-frame (ediff-window-frame ediff-window-C)))))
711 (if (and window-system
712 (ediff-frame-live-p ediff-control-frame)
713 (not (ediff-frame-iconified-p ediff-control-frame)))
714 (ediff-raise-frame ediff-control-frame))
716 ;; Redisplay whatever buffers are showing, if there is a selected difference
717 (let* ((control-frame ediff-control-frame)
718 (control-buf ediff-control-buffer))
719 (if (and (ediff-buffer-live-p ediff-buffer-A)
720 (ediff-buffer-live-p ediff-buffer-B)
721 (or (not ediff-3way-job)
722 (ediff-buffer-live-p ediff-buffer-C))
723 (ediff-valid-difference-p))
726 (ediff-operate-on-flags 'insert))
728 (ediff-recenter-one-window 'A)
729 (ediff-recenter-one-window 'B)
731 (ediff-recenter-one-window 'C))
733 (if (and (ediff-multiframe-setup-p)
734 (not (ediff-frame-iconified-p ediff-control-frame)))
736 (set-mouse-position control-frame 1 0)
737 (if (ediff-check-version '< 19 11 'xemacs) (sit-for 0))
739 (cond ((eq window-system 'ns)
740 (unfocus-frame (selected-frame)))
741 (t (unfocus-frame))))
744 (ediff-eval-in-buffer control-buf
745 (ediff-refresh-mode-lines))
748 ;; this function returns to the window it was called from
749 ;; (which was the control window)
750 (defun ediff-recenter-one-window (buf-type)
751 (let* (;; context must be saved before switching to windows A/B/C
752 (ctl-wind (selected-window))
753 (shift (ediff-overlay-start
754 (ediff-get-value-according-to-buffer-type
755 buf-type ediff-narrow-bounds)))
756 (job-name ediff-job-name)
757 (control-buf ediff-control-buffer)
759 (if (eq ediff-highlighting-style 'ascii)
762 (intern (format "ediff-before-flag-%S" buf-type)))))
765 (if (eq ediff-highlighting-style 'ascii)
768 (intern (format "ediff-after-flag-%S" buf-type)))))
770 (window-name (intern (format "ediff-window-%S" buf-type)))
771 (window (if (window-live-p (symbol-value window-name))
772 (symbol-value window-name))))
774 (if (and window (eq job-name 'ediff-windows))
775 (set-window-start window
776 (- shift before-flag-shift)))
779 (select-window window)
780 (ediff-deactivate-mark)
781 (ediff-position-region
782 (- (ediff-get-diff-posn buf-type 'beg nil control-buf)
784 (+ (ediff-get-diff-posn buf-type 'end nil control-buf)
786 (ediff-get-diff-posn buf-type 'beg nil control-buf)
789 (select-window ctl-wind)
793 ;; This will have to be refined for 3way jobs
794 (defun ediff-toggle-split ()
795 "Toggle vertical/horizontal window split.
796 Does nothing if file-A and file-B are in different frames."
798 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
799 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
800 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
801 (frame-A (if wind-A (ediff-window-frame wind-A)))
802 (frame-B (if wind-B (ediff-window-frame wind-B)))
803 (frame-C (if wind-C (ediff-window-frame wind-C))))
804 (if (or (eq frame-A frame-B)
805 (not (ediff-frame-live-p frame-A))
806 (not (ediff-frame-live-p frame-B))
807 (if ediff-3way-comparison-job
808 (or (not (ediff-frame-live-p frame-C))
809 (eq frame-A frame-C) (eq frame-B frame-C))))
810 (setq ediff-split-window-function
811 (if (eq ediff-split-window-function 'split-window-vertically)
812 'split-window-horizontally
813 'split-window-vertically))
814 (message "Buffers being compared are in different frames"))
815 (ediff-recenter 'no-rehighlight)))
817 (defun ediff-toggle-hilit ()
818 "Switch between highlighting using ASCII flags and highlighting using faces.
819 On a dumb terminal, switches between ASCII highlighting and no highlighting."
821 (if (not window-system)
822 (if (eq ediff-highlighting-style 'ascii)
824 (message "ASCII highlighting flags removed")
825 (ediff-unselect-and-select-difference ediff-current-difference
827 (setq ediff-highlighting-style 'off))
828 (ediff-unselect-and-select-difference ediff-current-difference
830 (ediff-unselect-and-select-difference ediff-current-difference
832 ;; cycle through highlighting
833 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
834 (message "Unhighlighting unselected difference regions")
835 (setq ediff-highlight-all-diffs nil))
837 (message "Highlighting with ASCII flags")
838 (setq ediff-use-faces nil))
840 (message "Re-highlighting all difference regions")
841 (setq ediff-use-faces t
842 ediff-highlight-all-diffs t)))
844 (if (and ediff-use-faces ediff-highlight-all-diffs)
845 (if (not (face-differs-from-default-p 'ediff-odd-diff-face-A-var))
847 (copy-face ediff-odd-diff-face-A 'ediff-odd-diff-face-A-var)
848 (copy-face ediff-odd-diff-face-B 'ediff-odd-diff-face-B-var)
849 (copy-face ediff-odd-diff-face-C 'ediff-odd-diff-face-C-var)
850 (copy-face ediff-even-diff-face-A 'ediff-even-diff-face-A-var)
851 (copy-face ediff-even-diff-face-B 'ediff-even-diff-face-B-var)
852 (copy-face ediff-even-diff-face-C 'ediff-even-diff-face-C-var)
854 (copy-face 'default 'ediff-odd-diff-face-A-var)
855 (copy-face 'default 'ediff-odd-diff-face-B-var)
856 (copy-face 'default 'ediff-odd-diff-face-C-var)
857 (copy-face 'default 'ediff-even-diff-face-A-var)
858 (copy-face 'default 'ediff-even-diff-face-B-var)
859 (copy-face 'default 'ediff-even-diff-face-C-var))
861 (ediff-unselect-and-select-difference
862 ediff-current-difference 'select-only))
863 (ediff-operate-on-flags 'insert)
866 (defun ediff-toggle-autorefine ()
867 "Toggle auto-refine mode."
870 (error "No fine differences in this mode"))
871 (cond ((eq ediff-auto-refine 'nix)
872 (setq ediff-auto-refine 'on)
873 (ediff-make-fine-diffs ediff-current-difference 'noforce)
874 (message "Auto-refining is ON"))
875 ((eq ediff-auto-refine 'on)
876 (message "Auto-refining is OFF")
877 (setq ediff-auto-refine 'off))
879 (ediff-set-fine-diff-properties ediff-current-difference 'default)
880 (message "Refinements are HIDDEN")
881 (setq ediff-auto-refine 'nix))
884 (defun ediff-make-or-kill-fine-diffs (arg)
885 "Compute fine diffs. With negative prefix arg, kill fine diffs.
886 In both cases, operates on the currrent difference region."
889 (ediff-clear-fine-differences ediff-current-difference))
890 ((and (numberp arg) (< arg 0))
891 (ediff-clear-fine-differences ediff-current-difference))
892 (t (ediff-make-fine-diffs))))
895 (defun ediff-toggle-help ()
896 "Toggle short/long help message."
898 (let (buffer-read-only)
900 (setq ediff-prefer-long-help-message (not ediff-prefer-long-help-message))
901 (ediff-set-help-message))
902 ;; remember the icon status of the control frame when the user requested
903 ;; full control message
904 (if (and ediff-prefer-long-help-message (ediff-multiframe-setup-p))
905 (setq ediff-prefer-iconified-control-frame
906 (ediff-frame-iconified-p ediff-control-frame)))
908 (setq ediff-window-config-saved "") ; force redisplay
909 (ediff-recenter 'no-rehighlight))
912 ;; Optional argument, BUF, is passed only in a startup hook.
913 (defun ediff-toggle-read-only (&optional buff)
914 "Toggles read-only in buffers being compared.
915 If buffer is under version control and locked, check it out first."
918 (or buff (ediff-recenter))
921 (ediff-eval-in-buffer
922 (or buff (ediff-get-buffer (ediff-char-to-buftype last-command-char)))
923 (let* ((file (buffer-file-name (current-buffer)))
924 (file-writable (and file (file-writable-p file)))
925 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
926 (ediff-file-checked-out-flag 'toggle-read-only)
927 (file-writable 'toggle-read-only)
928 (t (key-binding "\C-x\C-q")))))
929 (if (and toggle-ro-cmd
930 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
932 (save-window-excursion
933 (setq ediff-file-checked-out-flag t)
934 (command-execute toggle-ro-cmd)))
935 (error "Don't know how to toggle read-only in buffer %S"
937 ;; Check if we made the current buffer updatable, but its file is RO.
938 ;; Signal a warning in this case.
939 (if (and file (not buffer-read-only)
940 (eq this-command 'ediff-toggle-read-only)
942 (message "Warning: file %s is read-only"
943 (abbreviate-file-name file) (beep 1)))
946 (defun ediff-swap-buffers ()
947 "Rotate the display of buffers A, B, and C."
949 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
950 (let ((buf ediff-buffer-A)
951 (values ediff-buffer-A-values-orig)
952 (diff-vec ediff-difference-vector-A)
953 (hide-regexp ediff-regexp-hide-A)
954 (focus-regexp ediff-regexp-focus-A)
955 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
956 (overlay (if window-system ediff-current-diff-overlay-A))
958 (if ediff-3way-comparison-job
960 (set-window-buffer ediff-window-A ediff-buffer-C)
961 (set-window-buffer ediff-window-B ediff-buffer-A)
962 (set-window-buffer ediff-window-C ediff-buffer-B)
964 (set-window-buffer ediff-window-A ediff-buffer-B)
965 (set-window-buffer ediff-window-B ediff-buffer-A))
967 (if ediff-3way-comparison-job
968 (setq ediff-buffer-A ediff-buffer-C
969 ediff-buffer-C ediff-buffer-B
971 (setq ediff-buffer-A ediff-buffer-B
974 ;; swap saved buffer characteristics
975 (if ediff-3way-comparison-job
976 (setq ediff-buffer-A-values-orig ediff-buffer-C-values-orig
977 ediff-buffer-C-values-orig ediff-buffer-B-values-orig
978 ediff-buffer-B-values-orig values)
979 (setq ediff-buffer-A-values-orig ediff-buffer-B-values-orig
980 ediff-buffer-B-values-orig values))
983 (if ediff-3way-comparison-job
984 (setq ediff-difference-vector-A ediff-difference-vector-C
985 ediff-difference-vector-C ediff-difference-vector-B
986 ediff-difference-vector-B diff-vec)
987 (setq ediff-difference-vector-A ediff-difference-vector-B
988 ediff-difference-vector-B diff-vec))
990 ;; swap hide/focus regexp
991 (if ediff-3way-comparison-job
992 (setq ediff-regexp-hide-A ediff-regexp-hide-C
993 ediff-regexp-hide-C ediff-regexp-hide-B
994 ediff-regexp-hide-B hide-regexp
995 ediff-regexp-focus-A ediff-regexp-focus-C
996 ediff-regexp-focus-C ediff-regexp-focus-B
997 ediff-regexp-focus-B focus-regexp)
998 (setq ediff-regexp-hide-A ediff-regexp-hide-B
999 ediff-regexp-hide-B hide-regexp
1000 ediff-regexp-focus-A ediff-regexp-focus-B
1001 ediff-regexp-focus-B focus-regexp))
1003 ;; The following is needed for XEmacs, since there one can't move
1004 ;; overlay to another buffer. In Emacs, this swap is redundant.
1006 (if ediff-3way-comparison-job
1007 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1008 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1009 ediff-current-diff-overlay-B overlay)
1010 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1011 ediff-current-diff-overlay-B overlay)))
1014 (setq ediff-wide-bounds
1015 (cond (ediff-3way-comparison-job
1016 (list (nth 2 ediff-wide-bounds)
1017 (nth 0 ediff-wide-bounds)
1018 (nth 1 ediff-wide-bounds)))
1020 (list (nth 1 ediff-wide-bounds)
1021 (nth 0 ediff-wide-bounds)
1022 (nth 2 ediff-wide-bounds)))
1024 (list (nth 1 ediff-wide-bounds)
1025 (nth 0 ediff-wide-bounds)))))
1026 ;; swap narrow bounds
1027 (setq ediff-narrow-bounds
1028 (cond (ediff-3way-comparison-job
1029 (list (nth 2 ediff-narrow-bounds)
1030 (nth 0 ediff-narrow-bounds)
1031 (nth 1 ediff-narrow-bounds)))
1033 (list (nth 1 ediff-narrow-bounds)
1034 (nth 0 ediff-narrow-bounds)
1035 (nth 2 ediff-narrow-bounds)))
1037 (list (nth 1 ediff-narrow-bounds)
1038 (nth 0 ediff-narrow-bounds)))))
1039 (if wide-visibility-p
1040 (setq ediff-visible-bounds ediff-wide-bounds)
1041 (setq ediff-visible-bounds ediff-narrow-bounds))
1044 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1045 (ediff-recenter 'no-rehighlight)
1049 (defun ediff-toggle-wide-display ()
1050 "Toggle wide/regular display.
1051 This is especially useful when comparing buffers side-by-side."
1054 (error "Emacs is not running as a window application"))
1055 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1056 (let ((ctl-buf ediff-control-buffer))
1057 (setq ediff-wide-display-p (not ediff-wide-display-p))
1058 (if (not ediff-wide-display-p)
1059 (ediff-eval-in-buffer ctl-buf
1060 (ediff-modify-frame-parameters
1061 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1062 (sit-for (if ediff-xemacs-p 0.4 0))
1063 ;; restore control buf, since ctl window may have been deleted
1065 (set-buffer ctl-buf)
1066 (setq ediff-wide-display-orig-parameters nil
1067 ediff-window-B nil) ; force update of window config
1068 (ediff-recenter 'no-rehighlight))
1069 (funcall ediff-make-wide-display-function)
1070 (sit-for (if ediff-xemacs-p 0.4 0))
1071 (ediff-eval-in-buffer ctl-buf
1072 (setq ediff-window-B nil) ; force update of window config
1073 (ediff-recenter 'no-rehighlight)))))
1075 (defun ediff-toggle-multiframe ()
1076 "Switch from the multiframe display to single-frame display and back.
1077 This is primarily for debugging, but one can use it for fun, too."
1079 (if (ediff-check-version '< 19 12 'xemacs)
1080 (error "This command doesn't work under XEmacs 19.11 and earlier"))
1082 (error "Emacs is not running as a window application"))
1083 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1084 (setq ediff-window-setup-function 'ediff-setup-windows-plain))
1085 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1086 (setq ediff-window-setup-function 'ediff-setup-windows-multiframe)))
1087 (setq ediff-window-B nil)
1088 (ediff-recenter 'no-rehighlight))
1092 (defun ediff-toggle-show-clashes-only ()
1093 "Toggle the mode where only the regions where both buffers differ with the ancestor are shown."
1095 (if (not ediff-merge-with-ancestor-job)
1096 (error "This command makes sense only when merging with an ancestor"))
1097 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1098 (if ediff-show-clashes-only
1099 (message "Focus on regions where both buffers differ from the ancestor")
1100 (message "Canceling focus on regions where changes clash")))
1102 ;; Widening/narrowing
1104 (defun ediff-toggle-narrow-region ()
1105 "Toggle narrowing in buffers A, B, and C.
1106 Used in ediff-windows/regions only."
1108 (if (eq ediff-buffer-A ediff-buffer-B)
1110 "Buffers A and B are the same. Can't narrow to two different regions"))
1111 (if (eq ediff-visible-bounds ediff-wide-bounds)
1112 (setq ediff-visible-bounds ediff-narrow-bounds)
1113 (setq ediff-visible-bounds ediff-wide-bounds))
1114 (ediff-recenter 'no-rehighlight))
1116 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1117 ;; ediff-wide-bounds, then this actually widens.
1118 ;; This function does nothing if job-name is not ediff-small/large-regions or
1120 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1121 ;; to two different regions in one buffer.
1122 (defun ediff-visible-region ()
1123 (if (or (eq ediff-buffer-A ediff-buffer-B)
1124 (eq ediff-buffer-A ediff-buffer-C)
1125 (eq ediff-buffer-C ediff-buffer-B))
1127 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1128 ;; Otherwise, always use full range.
1129 (if (not ediff-word-mode-job)
1130 (setq ediff-visible-bounds ediff-wide-bounds))
1131 (let ((overl-A (ediff-get-value-according-to-buffer-type
1132 'A ediff-visible-bounds))
1133 (overl-B (ediff-get-value-according-to-buffer-type
1134 'B ediff-visible-bounds))
1135 (overl-C (ediff-get-value-according-to-buffer-type
1136 'C ediff-visible-bounds))
1138 (ediff-eval-in-buffer ediff-buffer-A
1140 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A)))
1141 (ediff-eval-in-buffer ediff-buffer-B
1143 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B)))
1146 (ediff-eval-in-buffer ediff-buffer-C
1148 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1152 ;; Window scrolling operations
1154 ;; Performs some operation on the two file windows (if they are showing).
1155 ;; Traps all errors on the operation in windows A/B/C.
1156 ;; Usually, errors come from scrolling off the
1157 ;; beginning or end of the buffer, and this gives error messages.
1158 (defun ediff-operate-on-windows (operation arg)
1160 ;; make sure windows aren't dead
1161 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1162 (ediff-recenter 'no-rehighlight))
1163 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1164 (ediff-buffer-live-p ediff-buffer-B)
1165 (or (not ediff-3way-job) ediff-buffer-C)
1167 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1169 (let* ((wind (selected-window))
1170 (wind-A ediff-window-A)
1171 (wind-B ediff-window-B)
1172 (wind-C ediff-window-C)
1173 (three-way ediff-3way-job))
1175 (select-window wind-A)
1177 (funcall operation arg)
1179 (select-window wind-B)
1181 (funcall operation arg)
1185 (select-window wind-C)
1187 (funcall operation arg)
1190 (select-window wind)))
1192 (defun ediff-scroll-vertically (&optional arg)
1193 "Vertically scroll buffers A, B \(and C if appropriate\).
1194 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1195 the height of window-A."
1198 ;; make sure windows aren't dead
1199 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1200 (ediff-recenter 'no-rehighlight))
1201 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1202 (ediff-buffer-live-p ediff-buffer-B)
1203 (or (not ediff-3way-job)
1204 (ediff-buffer-live-p ediff-buffer-C))
1206 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1208 (ediff-operate-on-windows
1209 (if (memq last-command-char '(?v ?\C-v))
1212 ;; calculate argument to scroll-up/down
1213 ;; if there is an explicit argument
1214 (if (and arg (not (equal arg '-)))
1216 (prefix-numeric-value arg)
1217 ;; if not, see if we can determine a default amount (the window height)
1218 (let* (default-amount)
1219 (setq default-amount
1220 (- (min (window-height ediff-window-A)
1221 (window-height ediff-window-B)
1223 (window-height ediff-window-C)
1224 123) ; some large number
1226 1 next-screen-context-lines))
1229 ;; C-u as argument means half of default amount
1230 (/ default-amount 2)
1231 ;; no argument means default amount
1235 (defun ediff-scroll-horizontally (&optional arg)
1236 "Horizontally scroll buffers A, B \(and C if appropriate\).
1237 If an argument is given, that is how many columns are scrolled, else nearly
1238 the width of the A/B/C windows."
1241 ;; make sure windows aren't dead
1242 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1243 (ediff-recenter 'no-rehighlight))
1244 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1245 (ediff-buffer-live-p ediff-buffer-B)
1246 (or (not ediff-3way-job)
1247 (ediff-buffer-live-p ediff-buffer-C))
1249 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1251 (ediff-operate-on-windows
1252 (if (= last-command-char ?<)
1255 ;; calculate argument to scroll-left/right
1256 ;; if there is an explicit argument
1257 (if (and arg (not (equal arg '-)))
1259 (prefix-numeric-value arg)
1260 ;; if not, see if we can determine a default amount
1261 ;; (half the window width)
1262 (if (null ediff-control-window)
1263 ;; no control window, use nil
1265 (let ((default-amount
1266 (- (/ (min (window-width ediff-window-A)
1267 (window-width ediff-window-B)
1268 (if ediff-3way-comparison-job
1269 (window-width ediff-window-C)
1270 500) ; some large number
1276 ;; C-u as argument means half of default amount
1277 (/ default-amount 2)
1278 ;; no argument means default amount
1279 default-amount))))))
1282 ;;BEG, END show the region to be positioned.
1283 ;;JOB-NAME holds ediff-job-name. Ediff-windows job positions regions
1285 (defun ediff-position-region (beg end pos job-name)
1286 (if (> end (point-max))
1287 (setq end (point-max)))
1288 (if (eq job-name 'ediff-windows)
1289 (if (pos-visible-in-window-p end)
1290 () ; do nothing, wind is already positioned
1291 ;; at this point, windows are positioned at the beginning of the
1292 ;; file regions (not diff-regions) being compared.
1294 (move-to-window-line (- (window-height) 2))
1295 (let ((amount (+ 2 (count-lines (point) end))))
1296 (scroll-up amount))))
1297 (set-window-start (selected-window) beg)
1298 (if (pos-visible-in-window-p end)
1299 ;; Determine the number of lines that the region occupies
1301 (while (> end (progn
1302 (move-to-window-line lines)
1304 (setq lines (1+ lines)))
1305 ;; And position the beginning on the right line
1307 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1316 (defun ediff-next-difference (&optional arg)
1317 "Advance to the next difference.
1318 With a prefix argument, go back that many differences."
1320 (if (< ediff-current-difference ediff-number-of-differences)
1321 (let ((n (min ediff-number-of-differences
1322 (+ ediff-current-difference (if arg arg 1))))
1323 regexp-skip buffer-read-only)
1325 (or (>= n ediff-number-of-differences)
1326 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1327 (ediff-install-fine-diff-if-necessary n))
1328 (while (and (< n ediff-number-of-differences)
1332 ;; skip clashes, if necessary
1333 (and ediff-show-clashes-only
1334 (string-match "prefer"
1335 (or (ediff-get-state-of-merge n) "")))
1336 ;; skip difference regions that differ in white space
1337 (and ediff-ignore-similar-regions
1338 (ediff-no-fine-diffs-p n))))
1340 (if (= 0 (mod n 20))
1341 (message "Skipped over region %d and counting ..." n))
1342 (or (>= n ediff-number-of-differences)
1343 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1344 (ediff-install-fine-diff-if-necessary n))
1347 (ediff-unselect-and-select-difference n)
1349 (ediff-visible-region)
1350 (error "At end of the difference list")))
1352 (defun ediff-previous-difference (&optional arg)
1353 "Go to the previous difference.
1354 With a prefix argument, go back that many differences."
1356 (if (> ediff-current-difference -1)
1357 (let ((n (max -1 (- ediff-current-difference (if arg arg 1))))
1358 regexp-skip buffer-read-only)
1361 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1362 (ediff-install-fine-diff-if-necessary n))
1363 (while (and (> n -1)
1367 ;; skip clashes, if necessary
1368 (and ediff-show-clashes-only
1369 (string-match "prefer"
1370 (or (ediff-get-state-of-merge n) "")))
1371 ;; skip difference regions that differ in white space
1372 (and ediff-ignore-similar-regions
1373 (ediff-no-fine-diffs-p n))))
1374 (if (= 0 (mod (1+ n) 20))
1375 (message "Skipped over region %d and counting ..." (1+ n)))
1378 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1379 (ediff-install-fine-diff-if-necessary n))
1381 (ediff-unselect-and-select-difference n)
1383 (ediff-visible-region)
1384 (error "At beginning of the difference list")))
1386 (defun ediff-jump-to-difference (difference-number)
1387 "Go to the difference specified as a prefix argument."
1389 (let (buffer-read-only)
1390 (setq difference-number (1- difference-number))
1391 (if (and (>= difference-number -1)
1392 (< difference-number (1+ ediff-number-of-differences)))
1393 (ediff-unselect-and-select-difference difference-number)
1394 (error "Bad difference number, %d" difference-number))))
1396 (defun ediff-jump-to-difference-at-point ()
1397 "Go to difference closest to the point in buffer A, B, or C.
1398 The type of buffer depends on last command character \(a, b, or c\) that
1399 invoked this command."
1401 (let ((buf-type (ediff-char-to-buftype last-command-char))
1403 (ediff-jump-to-difference (ediff-diff-at-point buf-type))))
1406 ;; find region most related to the current point position (or POS, if given)
1407 (defun ediff-diff-at-point (buf-type &optional pos)
1408 (let ((buffer (ediff-get-buffer buf-type))
1409 (ctl-buffer ediff-control-buffer)
1410 (max-dif-num (1- ediff-number-of-differences))
1417 (ediff-eval-in-buffer buffer
1418 (setq pos (or pos (point)))
1419 (while (and (or (< pos prev-beg) (> pos beg))
1420 (< diff-no max-dif-num))
1421 (setq diff-no (1+ diff-no))
1424 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1425 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1428 (if (< (abs (- pos prev-end))
1431 (1+ diff-no)) ; jump-to-diff works with diff nums higher by 1
1437 (defun ediff-diff-to-diff (arg &optional keys)
1438 "Copy buffer-X'th diff to buffer Y \(X,Y are A, B, or C\).
1439 If numerical prefix argument, copy this diff specified in the arg.
1440 Otherwise, copy the difference given by `ediff-current-difference'.
1441 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1442 `ac', etc., which is used to determine the types of buffers to be used for
1443 copying difference regions. The first character in the sequence specifies
1444 the source buffer and the second specifies the target.
1446 If the second optional argument, a 2-character string, is given, use it to
1447 determine the source and the target buffers instead of the command keys."
1449 (or keys (setq keys (this-command-keys)))
1451 (ediff-jump-to-difference arg))
1452 (let* ((key1 (aref keys 0))
1453 (key2 (aref keys 1))
1454 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1455 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2)))
1456 (ediff-copy-diff ediff-current-difference
1457 (ediff-char-to-buftype char1)
1458 (ediff-char-to-buftype char2))
1459 (ediff-recenter 'no-rehighlight)))
1462 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1463 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1464 ;; target diff. This is used in merging, when constructing the merged
1466 (defun ediff-copy-diff (n from-buf-type to-buf-type
1467 &optional batch-invocation reg-to-copy)
1468 (let* ((to-buf (ediff-get-buffer to-buf-type))
1469 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1470 (ctrl-buf ediff-control-buffer)
1472 (three-way ediff-3way-job)
1475 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1477 (ediff-operate-on-flags 'remove)
1478 (setq reg-to-delete-beg
1479 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1480 (setq reg-to-delete-end
1481 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1484 (setq from-buf-type nil)
1485 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1487 (setq reg-to-delete (ediff-get-region-contents
1488 n to-buf-type ctrl-buf
1489 reg-to-delete-beg reg-to-delete-end))
1491 (setq ediff-disturbed-overlays nil) ; clear before use
1493 (if (string= reg-to-delete reg-to-copy)
1494 (setq saved-p nil) ; refuse to copy identical buffers
1495 ;;; (progn ; refuse to copy identical buffers
1496 ;;; (setq saved-p nil)
1497 ;;; (or batch-invocation
1499 ;;; "Region %d in buffer %S is identical to that in buffer %S"
1500 ;;; (1+ n) from-buf-type to-buf-type (ding))))
1502 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1503 (condition-case conds
1505 (ediff-eval-in-buffer to-buf
1506 ;; to prevent flags from interfering if buffer is writable
1507 (let ((inhibit-read-only (null buffer-read-only))
1508 before-change-function)
1509 ;; these two insert a dummy char to overcome a bug in
1510 ;; XEmacs, which sometimes prevents 0-length extents
1511 ;; from sensing insertion at its end-points.
1514 (goto-char reg-to-delete-end)
1515 (insert-before-markers "@")))
1517 (goto-char reg-to-delete-end)
1518 (insert-before-markers reg-to-copy)
1520 ;; delete the dummy char "@"
1526 (ediff-collect-extents-xemacs reg-to-delete-beg)
1527 (if (> reg-to-delete-end reg-to-delete-beg)
1529 (kill-region reg-to-delete-beg
1531 (if (string= reg-to-copy "")
1532 (ediff-adjust-disturbed-extents-xemacs
1533 reg-to-delete-beg)))))
1534 (if (> reg-to-delete-end reg-to-delete-beg)
1535 (kill-region reg-to-delete-beg reg-to-delete-end)
1536 (ediff-move-disturbed-overlays reg-to-delete-beg)
1539 (or batch-invocation
1542 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1543 (error (message "ediff-copy-diff: %s %s"
1545 (mapconcat 'prin1-to-string (cdr conds) " "))
1552 ;; adjust state of difference in case 3-way and diff was copied ok
1553 (if (and saved-p three-way)
1554 (ediff-set-state-of-all-diffs-in-all-buffers ctrl-buf))
1556 (if batch-invocation
1557 (ediff-clear-fine-differences n)
1558 ;; If diff3 job, we should recompute fine diffs so we clear them
1559 ;; before reinserting flags (and thus before ediff-recenter).
1560 (if (and saved-p three-way)
1561 (ediff-clear-fine-differences n))
1562 (ediff-operate-on-flags 'insert)
1563 ;; For diff2 jobs, don't recompute fine diffs, since we know there
1564 ;; aren't any. So we clear diffs after ediff-recenter.
1565 (if (and saved-p (not three-way))
1566 (ediff-clear-fine-differences n))
1567 ;; Make sure that the message about saving and how to restore is seen
1572 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
1573 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
1574 ;; is the region to save. It is redundant here, but is passed anyway, for
1576 (defun ediff-save-diff-region (n buf-type reg)
1577 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1578 (buf (ediff-get-buffer buf-type))
1579 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1581 (if this-buf-n-th-diff-saved
1582 ;; either nothing saved for n-th diff and buffer or we OK'ed
1584 (setcdr this-buf-n-th-diff-saved reg)
1585 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
1586 (nconc n-th-diff-saved (list (cons buf reg)))
1587 (setq ediff-killed-diffs-alist ;; create record for n-th diff
1588 (cons (list n (cons buf reg))
1589 ediff-killed-diffs-alist))))
1590 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
1593 "" (downcase (symbol-name buf-type))))
1596 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
1597 (defun ediff-test-save-region (n buf-type)
1598 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1599 (buf (ediff-get-buffer buf-type))
1600 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1602 (if this-buf-n-th-diff-saved
1605 "You've previously copied diff region %d to buffer %S. Confirm "
1611 (defun ediff-pop-diff (n buf-type)
1612 "Pop last killed Nth diff region from buffer BUF-TYPE."
1613 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
1614 (buf (ediff-get-buffer buf-type))
1615 (saved-rec (assoc buf (cdr n-th-record)))
1616 (three-way ediff-3way-job)
1617 (ctl-buf ediff-control-buffer)
1619 saved-diff reg-beg reg-end recovered)
1622 (setq saved-diff (cdr saved-rec))
1623 (if (> ediff-number-of-differences 0)
1624 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
1625 (error "No differences found")))
1627 (ediff-operate-on-flags 'remove)
1629 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
1630 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
1631 (setq ediff-disturbed-overlays nil) ; clear before use
1633 (condition-case conds
1634 (ediff-eval-in-buffer buf
1635 (let ((inhibit-read-only (null buffer-read-only))
1636 (before-change-function nil))
1637 ;; these two insert a dummy char to overcome a bug in XEmacs,
1638 ;; which sometimes prevents 0-length extents from sensing
1639 ;; insertion at its end-points.
1643 (insert-before-markers "@")))
1646 (insert-before-markers saved-diff)
1648 ;; delete dummy char
1654 (ediff-collect-extents-xemacs reg-beg)
1655 (if (> reg-end reg-beg)
1657 (kill-region reg-beg reg-end)
1658 (if (string= saved-diff "")
1659 (ediff-adjust-disturbed-extents-xemacs reg-beg)))))
1660 (if (> reg-end reg-beg)
1661 (kill-region reg-beg reg-end)
1662 (ediff-move-disturbed-overlays reg-beg)
1667 (error (message "ediff-pop-diff: %s %s"
1669 (mapconcat 'prin1-to-string (cdr conds) " "))
1672 ;; Clearing fine diffs is necessary in order for ediff-operate-on-flags
1673 ;; to properly recompute them. We can't rely on ediff-copy-diff on
1674 ;; clearing this vector because the user might have modified diff
1675 ;; regions after copying and may have recomputed fine diffs.
1677 (ediff-clear-fine-differences n))
1679 ;; adjust state of difference
1680 (if (and three-way recovered)
1681 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
1683 (ediff-operate-on-flags 'insert)
1686 (setq n-th-record (delq saved-rec n-th-record))
1687 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
1691 (defun ediff-restore-diff (arg &optional key)
1692 "Restore ARGth diff from `ediff-killed-diffs-alist'.
1693 ARG is a prefix argument. If ARG is nil, restore current-difference.
1695 If the second optional argument, a character, is given, use it to
1696 determine the target buffer instead of last-command-char"
1699 (ediff-jump-to-difference arg))
1700 (ediff-pop-diff ediff-current-difference
1701 (ediff-char-to-buftype (or key last-command-char)))
1702 (ediff-recenter 'no-rehighlight))
1704 (defun ediff-toggle-regexp-match ()
1705 "Toggle between focusing and hiding of difference regions that match
1706 a regular expression typed in by the user."
1711 msg-connective alt-msg-connective alt-connective)
1713 ((or (and (eq ediff-skip-diff-region-function
1714 'ediff-focus-on-regexp-matches)
1715 (eq last-command-char ?f))
1716 (and (eq ediff-skip-diff-region-function 'ediff-hide-regexp-matches)
1717 (eq last-command-char ?h)))
1718 (message "Selective browsing by regexp turned off")
1719 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
1720 ((eq last-command-char ?h)
1721 (setq ediff-skip-diff-region-function 'ediff-hide-regexp-matches
1725 "Ignore A-regions matching this regexp (default \"%s\"): "
1726 ediff-regexp-hide-A))
1730 "Ignore B-regions matching this regexp (default \"%s\"): "
1731 ediff-regexp-hide-B)))
1732 (if ediff-3way-comparison-job
1736 "Ignore C-regions matching this regexp (default \"%s\"): "
1737 ediff-regexp-hide-C))))
1738 (if (eq ediff-hide-regexp-connective 'and)
1739 (setq msg-connective "BOTH"
1740 alt-msg-connective "ONE OF"
1742 (setq msg-connective "ONE OF"
1743 alt-msg-connective "BOTH"
1744 alt-connective 'and))
1747 "Hiding diff regions that match %s regexps. Use %s instead? "
1748 msg-connective alt-msg-connective))
1750 (setq ediff-hide-regexp-connective alt-connective)
1751 (message "Hiding diff regions that match %s regexps"
1752 alt-msg-connective))
1753 (message "Hiding diff regions that match %s regexps" msg-connective))
1754 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
1755 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
1756 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
1757 ((eq last-command-char ?f)
1758 (setq ediff-skip-diff-region-function 'ediff-focus-on-regexp-matches
1762 "Focus on A-regions matching this regexp (default \"%s\"): "
1763 ediff-regexp-focus-A))
1767 "Focus on B-regions matching this regexp (default \"%s\"): "
1768 ediff-regexp-focus-B)))
1769 (if ediff-3way-comparison-job
1773 "Focus on C-regions matching this regexp (default \"%s\"): "
1774 ediff-regexp-focus-C))))
1775 (if (eq ediff-focus-regexp-connective 'and)
1776 (setq msg-connective "BOTH"
1777 alt-msg-connective "ONE OF"
1779 (setq msg-connective "ONE OF"
1780 alt-msg-connective "BOTH"
1781 alt-connective 'and))
1784 "Focusing on diff regions that match %s regexps. Use %s instead? "
1785 msg-connective alt-msg-connective))
1787 (setq ediff-focus-regexp-connective alt-connective)
1788 (message "Focusing on diff regions that match %s regexps"
1789 alt-msg-connective))
1790 (message "Focusing on diff regions that match %s regexps"
1792 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
1793 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
1794 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
1796 (defun ediff-toggle-skip-similar ()
1798 (if (not (eq ediff-auto-refine 'on))
1800 "Can't skip over whitespace regions: first turn auto-refining on"))
1801 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
1802 (if ediff-ignore-similar-regions
1804 "Skipping regions that differ only in white space & line breaks")
1805 (message "Skipping over white-space differences turned off")))
1807 (defun ediff-focus-on-regexp-matches (n)
1808 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
1809 Regions to be ignored according to this function are those where
1810 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
1811 doesn't match `ediff-regexp-focus-B'.
1812 This function returns nil if the region number N (specified as
1813 an argument) is not to be ignored and t if region N is to be ignored.
1815 N is a region number used by Ediff internally. It is 1 less
1816 the number seen by the user."
1817 (if (ediff-valid-difference-p n)
1818 (let* ((ctl-buf ediff-control-buffer)
1819 (regex-A ediff-regexp-focus-A)
1820 (regex-B ediff-regexp-focus-B)
1821 (regex-C ediff-regexp-focus-C)
1822 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
1823 (goto-char (ediff-get-diff-posn 'A 'beg n ctl-buf))
1826 (ediff-get-diff-posn 'A 'end n ctl-buf)
1828 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
1829 (goto-char (ediff-get-diff-posn 'B 'beg n ctl-buf))
1832 (ediff-get-diff-posn 'B 'end n ctl-buf)
1834 (reg-C-match (if ediff-3way-comparison-job
1835 (ediff-eval-in-buffer ediff-buffer-C
1837 (ediff-get-diff-posn 'C 'beg n ctl-buf))
1840 (ediff-get-diff-posn 'C 'end n ctl-buf)
1842 (not (eval (if ediff-3way-comparison-job
1843 (list ediff-focus-regexp-connective
1844 reg-A-match reg-B-match reg-C-match)
1845 (list ediff-focus-regexp-connective
1846 reg-A-match reg-B-match))))
1849 (defun ediff-hide-regexp-matches (n)
1850 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
1851 Regions to be ignored are those where buf A region matches
1852 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
1853 This function returns nil if the region number N (specified as
1854 an argument) is not to be ignored and t if region N is to be ignored.
1856 N is a region number used by Ediff internally. It is 1 less
1857 the number seen by the user."
1858 (if (ediff-valid-difference-p n)
1859 (let* ((ctl-buf ediff-control-buffer)
1860 (regex-A ediff-regexp-hide-A)
1861 (regex-B ediff-regexp-hide-B)
1862 (regex-C ediff-regexp-hide-C)
1863 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
1864 (goto-char (ediff-get-diff-posn 'A 'beg n ctl-buf))
1867 (ediff-get-diff-posn 'A 'end n ctl-buf)
1869 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
1870 (goto-char (ediff-get-diff-posn 'B 'beg n ctl-buf))
1873 (ediff-get-diff-posn 'B 'end n ctl-buf)
1875 (reg-C-match (if ediff-3way-comparison-job
1876 (ediff-eval-in-buffer ediff-buffer-C
1878 (ediff-get-diff-posn 'C 'beg n ctl-buf))
1881 (ediff-get-diff-posn 'C 'end n ctl-buf)
1883 (eval (if ediff-3way-comparison-job
1884 (list ediff-hide-regexp-connective
1885 reg-A-match reg-B-match reg-C-match)
1886 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
1891 ;;; Quitting, suspending, etc.
1893 (defun ediff-quit ()
1894 "Finish an Ediff session and exit Ediff.
1895 Unselects the selected difference, if any, restores the read-only and modified
1896 flags of the compared file buffers, kills Ediff buffers for this session
1897 \(but not buffers A, B, C\)."
1900 (y-or-n-p "Do you really want to exit Ediff? ")
1902 (ediff-really-quit)))
1905 ;; Perform the quit operations.
1906 (defun ediff-really-quit ()
1907 (ediff-restore-buffer-characteristics t) ; restore as they were at setup
1908 (ediff-unhighlight-diffs-totally)
1909 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
1910 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
1911 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
1913 (ediff-delete-temp-files)
1915 ;; Restore visibility range. This affects only ediff-*-regions/windows.
1916 ;; Since for other job names ediff-visible-region sets
1917 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
1918 ;; ignored for such jobs.
1919 (if ediff-quit-widened
1920 (setq ediff-visible-bounds ediff-wide-bounds)
1921 (setq ediff-visible-bounds ediff-narrow-bounds))
1923 ;; Apply selective display to narrow or widen
1924 (ediff-visible-region)
1925 (mapcar (function (lambda (overl)
1926 (if (ediff-overlayp overl)
1927 (ediff-delete-overlay overl))))
1929 (mapcar (function (lambda (overl)
1930 (if (ediff-overlayp overl)
1931 (ediff-delete-overlay overl))))
1932 ediff-narrow-bounds)
1934 ;; restore buffer mode line id's in buffer-A/B/C
1935 ;; much of what is here, except for mode line, will be deleted when Emacs
1936 ;; acquires before/after-string overlay properties
1937 (let ((control-buffer ediff-control-buffer))
1939 (ediff-eval-in-buffer ediff-buffer-A
1940 (setq before-change-function nil)
1941 (setq ediff-this-buffer-control-sessions
1942 (delq control-buffer ediff-this-buffer-control-sessions))
1943 (if (null ediff-this-buffer-control-sessions)
1944 (setq local-write-file-hooks
1945 (delq 'ediff-block-write-file local-write-file-hooks)))
1946 (kill-local-variable 'ediff-file-checked-out-flag)
1947 (kill-local-variable 'mode-line-buffer-identification)
1948 (kill-local-variable 'mode-line-format)
1953 (ediff-eval-in-buffer ediff-buffer-B
1954 (setq ediff-this-buffer-control-sessions
1955 (delq control-buffer ediff-this-buffer-control-sessions))
1956 (if (null ediff-this-buffer-control-sessions)
1957 (setq local-write-file-hooks
1958 (delq 'ediff-block-write-file local-write-file-hooks)))
1959 (setq before-change-function nil)
1960 (kill-local-variable 'ediff-file-checked-out-flag)
1961 (kill-local-variable 'mode-line-buffer-identification)
1962 (kill-local-variable 'mode-line-format)
1967 (ediff-eval-in-buffer ediff-buffer-C
1968 (if (null ediff-this-buffer-control-sessions)
1969 (setq local-write-file-hooks
1970 (delq 'ediff-block-write-file local-write-file-hooks)))
1971 (setq before-change-function nil)
1972 (kill-local-variable 'ediff-file-checked-out-flag)
1973 (kill-local-variable 'mode-line-buffer-identification)
1974 (kill-local-variable 'mode-line-format)
1978 ;; restore state of buffers to what it was before ediff
1979 (ediff-restore-protected-variables)
1980 (run-hooks 'ediff-quit-hooks))
1983 (defun ediff-delete-temp-files ()
1984 (if (stringp ediff-temp-file-A)
1985 (delete-file ediff-temp-file-A))
1986 (if (stringp ediff-temp-file-B)
1987 (delete-file ediff-temp-file-B))
1988 (if (stringp ediff-temp-file-C)
1989 (delete-file ediff-temp-file-C)))
1992 ;; Kill control buffer, other auxiliary Ediff buffers.
1993 ;; Leave one of the frames split between buffers A/B/C
1994 (defun ediff-cleanup-mess ()
1995 (let ((buff-A ediff-buffer-A)
1996 (buff-B ediff-buffer-B)
1997 (buff-C ediff-buffer-C)
1998 (ctl-buf ediff-control-buffer)
1999 (ctl-frame ediff-control-frame)
2000 (three-way-job ediff-3way-job))
2002 (ediff-kill-buffer-carefully ediff-diff-buffer)
2003 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2004 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2005 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2006 (ediff-kill-buffer-carefully ediff-error-buffer)
2007 (ediff-kill-buffer-carefully ediff-patch-diagnostics)
2008 (ediff-kill-buffer-carefully ediff-msg-buffer)
2009 (ediff-kill-buffer-carefully ediff-debug-buffer)
2011 ;; XEmacs 19.11 has a bug (?) that doesn't let us delete buffer in
2012 ;; dedicated window. So, we delete the frame first.
2014 (if (and window-system (ediff-frame-live-p ctl-frame))
2015 (ediff-delete-frame ctl-frame))
2016 (ediff-kill-buffer-carefully ctl-buf)
2018 (delete-other-windows)
2020 ;; display only if not visible
2022 (or (ediff-get-visible-buffer-window buff-B)
2023 (switch-to-buffer buff-B))
2026 (or (ediff-get-visible-buffer-window buff-A)
2028 (if (ediff-get-visible-buffer-window buff-B)
2029 (split-window-vertically))
2030 (switch-to-buffer buff-A)))
2034 (or (ediff-get-visible-buffer-window buff-C)
2036 (if (or (ediff-get-visible-buffer-window buff-A)
2037 (ediff-get-visible-buffer-window buff-B))
2038 (split-window-vertically))
2039 (switch-to-buffer buff-C)
2045 ;; The default way of suspending Ediff.
2046 ;; Buries Ediff buffers, kills all windows.
2047 (defun ediff-default-suspend-hook ()
2048 (let* ((buf-A ediff-buffer-A)
2049 (buf-B ediff-buffer-B)
2050 (buf-C ediff-buffer-C)
2051 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2052 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2053 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2054 (buf-patch ediff-patch-buf)
2055 (buf-patch-diag ediff-patch-diagnostics)
2056 (buf-err ediff-error-buffer)
2057 (buf-diff ediff-diff-buffer)
2058 (buf-custom-diff ediff-custom-diff-buffer)
2059 (buf-fine-diff ediff-fine-diff-buffer))
2061 ;; hide the control panel
2062 (if (and window-system (ediff-frame-live-p ediff-control-frame))
2063 (ediff-iconify-frame ediff-control-frame)
2065 (if buf-err (bury-buffer buf-err))
2066 (if buf-diff (bury-buffer buf-diff))
2067 (if buf-custom-diff (bury-buffer buf-custom-diff))
2068 (if buf-fine-diff (bury-buffer buf-fine-diff))
2069 (if buf-patch (bury-buffer buf-patch))
2070 (if buf-patch-diag (bury-buffer buf-patch-diag))
2071 (if (window-live-p buf-A-wind)
2073 (select-window buf-A-wind)
2074 (delete-other-windows)
2076 (if (ediff-buffer-live-p buf-A) (bury-buffer buf-A)))
2077 (if (window-live-p buf-B-wind)
2079 (select-window buf-B-wind)
2080 (delete-other-windows)
2082 (if (ediff-buffer-live-p buf-B) (bury-buffer buf-B)))
2083 (if (window-live-p buf-C-wind)
2085 (select-window buf-C-wind)
2086 (delete-other-windows)
2088 (if (ediff-buffer-live-p buf-C) (bury-buffer buf-C)))
2093 (defun ediff-suspend ()
2095 To resume, switch to the appropriate `Ediff Control Panel'
2096 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2097 up an appropriate window config."
2099 (let ((key (substitute-command-keys "\\[ediff-recenter]")))
2100 (run-hooks 'ediff-suspend-hooks)
2102 "To resume, switch to Ediff Control Panel and hit `%s'" key)))
2105 (defun ediff-status-info ()
2106 "Show the names of the buffers or files being operated on by Ediff.
2107 Hit \\[ediff-recenter] to reset the windows afterward."
2109 (with-output-to-temp-buffer " *ediff-info*"
2110 (princ (ediff-version))
2112 (ediff-eval-in-buffer ediff-buffer-A
2113 (if buffer-file-name
2115 (format "File A = %S\n" buffer-file-name))
2117 (format "Buffer A = %S\n" (buffer-name)))))
2118 (ediff-eval-in-buffer ediff-buffer-B
2119 (if buffer-file-name
2121 (format "File B = %S\n" buffer-file-name))
2123 (format "Buffer B = %S\n" (buffer-name)))))
2125 (ediff-eval-in-buffer ediff-buffer-C
2126 (if buffer-file-name
2128 (format "File C = %S\n" buffer-file-name))
2130 (format "Buffer C = %S\n" (buffer-name))))))
2132 (let* ((A-line (ediff-eval-in-buffer ediff-buffer-A
2133 (1+ (count-lines (point-min) (point)))))
2134 (B-line (ediff-eval-in-buffer ediff-buffer-B
2135 (1+ (count-lines (point-min) (point)))))
2137 (princ (format "\Buffer A's point is on line %d\n" A-line))
2138 (princ (format "Buffer B's point is on line %d\n" B-line))
2141 (setq C-line (ediff-eval-in-buffer ediff-buffer-C
2142 (1+ (count-lines (point-min) (point)))))
2143 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2145 (princ (format "\nCurrent difference number = %S\n"
2146 (cond ((< ediff-current-difference 0) 'start)
2147 ((>= ediff-current-difference
2148 ediff-number-of-differences) 'end)
2149 (t (1+ ediff-current-difference)))))
2151 (cond (ediff-ignore-similar-regions
2152 (princ "\nSkipping regions that differ only in white space & line breaks"))
2154 (princ "\nNot skipping regions that differ in white space & line breaks")))
2156 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2157 (princ "\nSelective browsing by regexp is off.\n"))
2158 ((eq ediff-skip-diff-region-function 'ediff-hide-regexp-matches)
2160 "\nIgnoring regions that match")
2163 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2164 ediff-regexp-hide-A ediff-hide-regexp-connective
2165 ediff-regexp-hide-B)))
2166 ((eq ediff-skip-diff-region-function 'ediff-focus-on-regexp-matches)
2168 "\nFocusing on regions that match")
2171 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2172 ediff-regexp-focus-A ediff-focus-regexp-connective
2173 ediff-regexp-focus-B)))
2174 (t (princ "\nSelective browsing via a user-defined method.\n")))
2177 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2178 (substitute-command-keys "\\[ediff-submit-report]")))
2184 ;;; Support routines
2186 ;; Select a difference by placing the ASCII flags around the appropriate
2187 ;; group of lines in the A, B buffers
2188 ;; This may have to be modified for buffer C, when it will be supported.
2189 (defun ediff-select-difference (n)
2190 (if (and (ediff-buffer-live-p ediff-buffer-A)
2191 (ediff-buffer-live-p ediff-buffer-B)
2192 (ediff-valid-difference-p n))
2194 (ediff-remember-buffer-characteristics)
2195 (if (and window-system ediff-use-faces)
2197 (ediff-highlight-diff n)
2198 (setq ediff-highlighting-style 'face))
2199 (setq ediff-highlighting-style 'ascii)
2200 (ediff-place-flags-in-buffer 'A ediff-buffer-A
2201 ediff-control-buffer n)
2202 (ediff-place-flags-in-buffer 'B ediff-buffer-B
2203 ediff-control-buffer n)
2205 (ediff-place-flags-in-buffer 'C ediff-buffer-C
2206 ediff-control-buffer n))
2209 (ediff-install-fine-diff-if-necessary n)
2211 (ediff-restore-buffer-characteristics)
2212 (run-hooks 'ediff-select-hooks))))
2215 ;; Unselect a difference by removing the ASCII flags in the buffers.
2216 ;; This may have to be modified for buffer C, when it will be supported.
2217 (defun ediff-unselect-difference (n)
2218 (if (ediff-valid-difference-p n)
2220 (ediff-remember-buffer-characteristics)
2222 (cond ((and window-system ediff-use-faces)
2223 (ediff-unhighlight-diff))
2224 ((eq ediff-highlighting-style 'ascii)
2225 (ediff-remove-flags-from-buffer
2227 (ediff-get-diff-overlay n 'A)
2228 (ediff-get-diff-posn 'A 'beg n)
2229 (ediff-get-diff-posn 'A 'end n)
2230 ediff-before-flag-A ediff-after-flag-A)
2231 (ediff-remove-flags-from-buffer
2233 (ediff-get-diff-overlay n 'B)
2234 (ediff-get-diff-posn 'B 'beg n)
2235 (ediff-get-diff-posn 'B 'end n)
2236 ediff-before-flag-B ediff-after-flag-B)
2238 (ediff-remove-flags-from-buffer
2240 (ediff-get-diff-overlay n 'C)
2241 (ediff-get-diff-posn 'C 'beg n)
2242 (ediff-get-diff-posn 'C 'end n)
2243 ediff-before-flag-C ediff-after-flag-C))
2246 (ediff-restore-buffer-characteristics)
2247 (setq ediff-highlighting-style nil)
2249 ;; unhighlight fine diffs
2250 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2252 (run-hooks 'ediff-unselect-hooks))))
2255 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2256 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2257 ;; next difference is selected, but the current selection is not
2258 ;; unselected. If FLAG is 'unselect-only then the current selection is
2259 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2260 ;; don't recenter buffers after selecting/unselecting.
2262 ;; Don't use `ediff-select-difference' and `ediff-unselect-difference'
2263 ;; directly, since this will screw up the undo info in the presence of
2265 ;; Instead, use `ediff-unselect-and-select-difference' with appropriate
2268 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2269 (let (;; save buf modified info
2270 (control-buf ediff-control-buffer)
2271 (buf-A-modified (buffer-modified-p ediff-buffer-A))
2272 (buf-B-modified (buffer-modified-p ediff-buffer-B))
2273 ;; temporarily disable undo so highlighting won't confuse the user
2274 buf-C-modified buf-A-undo buf-B-undo buf-C-undo)
2276 (let ((ediff-current-difference n))
2278 (ediff-recenter 'no-rehighlight)))
2280 (if (and (ediff-buffer-live-p ediff-buffer-A)
2281 (ediff-buffer-live-p ediff-buffer-B))
2283 (ediff-eval-in-buffer ediff-buffer-A
2284 (setq buf-A-undo buffer-undo-list))
2285 (ediff-eval-in-buffer ediff-buffer-B
2286 (setq buf-B-undo buffer-undo-list))
2287 (buffer-disable-undo ediff-buffer-A)
2288 (buffer-disable-undo ediff-buffer-B)))
2290 (if (ediff-buffer-live-p ediff-buffer-C)
2292 (setq buf-C-modified (buffer-modified-p ediff-buffer-C))
2293 (ediff-eval-in-buffer ediff-buffer-C
2294 (setq buf-C-undo buffer-undo-list))
2295 (buffer-disable-undo ediff-buffer-C)))
2297 (unwind-protect ; we don't want to lose undo info due to error
2299 (or (eq flag 'select-only)
2300 (ediff-unselect-difference ediff-current-difference))
2302 ;; Auto-save buffers while Ediff flags are temporarily removed.
2303 (ediff-eval-in-buffer ediff-buffer-A
2304 (if buf-A-modified (do-auto-save)))
2305 (ediff-eval-in-buffer ediff-buffer-B
2306 (if buf-B-modified (do-auto-save)))
2307 (if (ediff-buffer-live-p ediff-buffer-C)
2308 (ediff-eval-in-buffer ediff-buffer-C
2309 (if buf-C-modified (do-auto-save))))
2311 (or (eq flag 'unselect-only)
2312 (ediff-select-difference n))
2313 (setq ediff-current-difference n)
2314 ) ; end protected section
2316 (ediff-eval-in-buffer control-buf
2317 (ediff-refresh-mode-lines)
2318 ;; restore undo and buffer-modified info
2319 (ediff-eval-in-buffer ediff-buffer-A
2320 (set-buffer-modified-p buf-A-modified)
2321 (setq buffer-undo-list buf-A-undo)))
2322 (ediff-eval-in-buffer control-buf
2323 (ediff-eval-in-buffer ediff-buffer-B
2324 (set-buffer-modified-p buf-B-modified)
2325 (setq buffer-undo-list buf-B-undo)))
2326 (if (ediff-buffer-live-p ediff-buffer-C)
2327 (ediff-eval-in-buffer control-buf
2328 (ediff-eval-in-buffer ediff-buffer-C
2329 (set-buffer-modified-p buf-C-modified)
2330 (setq buffer-undo-list buf-C-undo))))
2334 (defun ediff-read-file-name (prompt default-dir default-file)
2335 ; This is a modified version of a similar function in `emerge.el'.
2336 ; PROMPT should not have trailing ': ', so that it can be modified
2337 ; according to context.
2338 ; If default-file is set, it should be used as the default value.
2339 ; If default-dir is non-nil, use it as the default directory.
2340 ; Otherwise, use the value of Emacs' variable `default-directory.'
2342 ;; hack default-dir if it is not set
2344 (file-name-as-directory
2345 (abbreviate-file-name
2346 (expand-file-name (or default-dir
2348 (file-name-directory default-file))
2349 default-directory)))))
2351 ;; strip the directory from default-file
2353 (setq default-file (file-name-nondirectory default-file)))
2354 (if (string= default-file "")
2355 (setq default-file nil))
2358 (setq f (expand-file-name
2363 (concat " (default " default-file ")")
2368 (if default-file (file-name-directory default-file))
2372 ;; If user enters a directory name, expand the default file in that
2373 ;; directory. This allows the user to enter a directory name for the
2374 ;; B-file and diff against the default-file in that directory instead
2375 ;; of a DIRED listing!
2376 (if (and (file-directory-p f) default-file)
2377 (setq f (expand-file-name
2378 (file-name-nondirectory default-file) f)))
2381 ;; If `prefix' is given, then it is used as a prefix for the temp file
2382 ;; name. Otherwise, `_buffer-name' is used. If `file' is given, use this
2383 ;; file and don't create a new one.
2384 (defun ediff-make-temp-file (&optional prefix given-file start end)
2385 (let ((f (or given-file
2386 (make-temp-name (concat
2387 ediff-temp-file-prefix
2392 (write-region (if start start (point-min))
2393 (if end end (point-max))
2395 nil ; don't append---erase
2397 (set-file-modes f ediff-temp-file-mode)
2400 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
2402 (defun ediff-protect-metachars (str)
2403 (or (memq system-type '(emx vax-vms axp-vms))
2405 (while (string-match ediff-metachars str limit)
2406 (setq str (concat (substring str 0 (match-beginning 0))
2408 (substring str (match-beginning 0))))
2409 (setq limit (1+ (match-end 0))))))
2412 ;; Make sure the current buffer (for a file) has the same contents as the
2413 ;; file on disk, and attempt to remedy the situation if not.
2414 ;; Signal an error if we can't make them the same, or the user doesn't want
2415 ;; to do what is necessary to make them the same.
2416 ;; If file has file handlers (indicated by the optional arg), then we
2417 ;; offer to instead of saving. This is one difference with Emerge.
2418 ;; Another is that we always offer to revert obsolete files, whether they
2419 ;; are modified or not.
2420 (defun ediff-verify-file-buffer (&optional file-magic)
2421 ;; First check if the file has been modified since the buffer visited it.
2422 (if (verify-visited-file-modtime (current-buffer))
2423 (if (buffer-modified-p)
2424 ;; If buffer is not obsolete and is modified, offer to save
2426 (format "Buffer out of sync with visited file. %s file %s? "
2427 (if file-magic "Revert" "Save")
2429 (if (not file-magic)
2431 ;; for some reason, file-name-handlers append instead of
2432 ;; replacing, so we have to erase first.
2434 (revert-buffer t t))
2435 (error "Buffer out of sync for file %s" buffer-file-name))
2436 ;; If buffer is not obsolete and is not modified, do nothing
2438 ;; If buffer is obsolete, offer to revert
2440 (format "Buffer out of sync with visited file. Revert file %s? "
2445 (revert-buffer t t))
2446 (error "Buffer out of sync for file %s" buffer-file-name))))
2449 ;; to be deleted in due time
2450 (defun ediff-block-write-file ()
2451 "Prevent writing files A and B directly."
2452 (if (ediff-check-for-ascii-flags)
2453 (error "Type `wa' and `wb' in Ediff Control Panel to save buffs A/B")))
2455 ;; To be deleted in due time
2456 (defun ediff-before-change-guard (start end)
2457 "If buffer is highlighted with ASCII flags, remove highlighting.
2458 Arguments, START and END are not used, but are provided
2459 because this is required by `before-change-function'."
2460 (let (rehighlight-key)
2461 (save-window-excursion
2465 (ediff-eval-in-buffer buf
2466 (if (eq ediff-highlighting-style 'ascii)
2468 (ediff-unselect-and-select-difference
2469 ediff-current-difference
2470 'unselect-only 'no-recenter)
2471 (setq rehighlight-key
2472 (substitute-command-keys "\\[ediff-recenter]"))
2474 ediff-this-buffer-control-sessions)
2477 "ASCII flags removed. You can edit now. Hit `%s' to rehighlight"
2482 (defun ediff-check-for-ascii-flags ()
2485 (mapcar (function (lambda (buf)
2486 (if (ediff-buffer-live-p buf)
2487 (ediff-eval-in-buffer buf
2488 (eq ediff-highlighting-style 'ascii)))))
2489 ediff-this-buffer-control-sessions))))
2491 ;; It would be nice to use these two functions as hooks instead of
2492 ;; ediff-insert-in-front and ediff-move-disturbed-overlays.
2493 ;; However, Emacs has a bug that causes BEG and END, below, to be
2494 ;; the same, i.e., the end of inserted text is not passed correctly.
2495 ;; Since the overlay doesn't move when these hooks run,
2496 ;; there is no way to correctly determine the new (desired) position of
2498 ;; Either this bug is fixed, or (better) use sticky overlays when they will
2499 ;; be implemented in Emacs, like they are in XEmacs.
2500 ;;(defun ediff-capture-inserts-in-front (overl beg end)
2501 ;; (if (ediff-overlay-get overl 'ediff-diff-num)
2502 ;; (ediff-move-overlay
2503 ;; overl beg (+ (- end beg) (ediff-overlay-end overl)))
2505 ;;(defun ediff-capture-inserts-behind (overl beg end)
2506 ;; (if (ediff-overlay-get overl 'ediff-diff-num)
2507 ;; (ediff-move-overlay overl (ediff-overlay-start overl) end))
2510 ;; to be deleted in due time
2511 ;; Capture overlays that had insertions in the front.
2512 ;; Called when overlay OVERL gets insertion in front.
2513 (defun ediff-insert-in-front (overl &optional flag beg end length)
2514 (if (ediff-overlay-get overl 'ediff-diff-num)
2515 (setq ediff-disturbed-overlays
2516 (cons overl ediff-disturbed-overlays))))
2518 ;; to be deleted in due time
2519 ;; Collects all extents at POS having property `ediff-diff-num'.
2520 ;; XEmacs causes headache by detaching empty extents, so I have to save
2521 ;; them before they disappear.
2522 (defun ediff-collect-extents-xemacs (pos)
2524 (while (setq elt (extent-at pos nil 'ediff-diff-num elt))
2525 (setq lis (cons elt lis)))
2526 (setq ediff-disturbed-overlays lis)))
2528 ;; to be deleted in due time
2529 ;; We can't move overlays directly in insert-in-front-hooks
2530 ;; because when diff is highlighted with ascii flags, they will disturb
2531 ;; overlays and so they will be included in them, which we don't want.
2532 (defun ediff-move-disturbed-overlays (posn)
2533 (mapcar (function (lambda (overl)
2534 (ediff-move-overlay overl
2536 (ediff-overlay-end overl))
2538 ediff-disturbed-overlays)
2539 (setq ediff-disturbed-overlays nil))
2541 ;; to be deleted in due time
2542 ;; If XEmacs adds the ability to not detach extents, we should be able to
2544 (defun ediff-adjust-disturbed-extents-xemacs (posn)
2545 (mapcar (function (lambda (overl)
2546 (if (equal (ediff-overlay-start overl)
2547 (ediff-overlay-end overl))
2548 (ediff-move-overlay overl posn posn))))
2549 ediff-disturbed-overlays)
2550 (setq ediff-disturbed-overlays nil))
2552 (defun ediff-save-buffer (arg)
2553 "Safe way of saving buffers A, B, C, and the diff output.
2554 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
2555 and `wd' saves the diff output."
2557 (let ((hooks local-write-file-hooks))
2558 (ediff-unselect-and-select-difference ediff-current-difference
2561 (ediff-eval-in-buffer
2562 (cond ((memq last-command-char '(?a ?b ?c))
2564 (ediff-char-to-buftype last-command-char)))
2565 ((eq last-command-char ?d)
2566 (message "Saving diff output ...")(sit-for 1)
2567 (if arg ediff-diff-buffer ediff-custom-diff-buffer)
2569 ;; temporarily remove writing block
2570 (setq hooks (delq 'ediff-block-write-file hooks))
2571 (let ((local-write-file-hooks hooks))
2573 (ediff-unselect-and-select-difference ediff-current-difference
2578 ;; will simplify it in due time, when emacs acquires before/after strings
2579 (defun ediff-remove-flags-from-buffer (buffer overlay before-posn after-posn
2580 before-flag after-flag)
2581 (ediff-eval-in-buffer buffer
2582 (let ((before-flag-length (length before-flag))
2583 (after-flag-length (length after-flag))
2584 (inhibit-read-only t)
2586 before-change-function)
2587 (goto-char after-posn)
2588 (setq after-posn (point-marker)) ; after-posn is now a marker
2589 ;; remove the flags, if they're there
2590 (goto-char (- before-posn before-flag-length))
2592 (ediff-overlay-put overlay 'begin-glyph nil)
2593 ;; before-string is not yet implemented in emacs.
2594 ;; when it will be, I will be able to delete much of the rest of
2596 (ediff-overlay-put overlay 'before-string nil)
2597 (if (looking-at (regexp-quote before-flag))
2598 (delete-region (point) (+ (point) before-flag-length))
2601 (message "Trouble removing ASCII flag"))
2605 (ediff-overlay-put overlay 'end-glyph nil)
2606 ;; after-string is not yet implemented in emacs.
2607 (ediff-overlay-put overlay 'after-string nil)
2608 (goto-char after-posn)
2609 (if (looking-at (regexp-quote after-flag))
2610 (delete-region (point) (+ (point) after-flag-length))
2613 (message "Trouble removing ASCII flag"))
2614 (setq after-posn nil) ; after has become a marker--garbage-collect
2620 ;; will simplify it in due time, when emacs acquires before/after strings
2621 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
2622 (ediff-eval-in-buffer buffer
2623 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
2626 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
2627 (let* ((before-flag-name (intern (format "ediff-before-flag-%S" buf-type)))
2628 (after-flag-name (intern (format "ediff-after-flag-%S" buf-type)))
2629 (curr-overl (ediff-eval-in-buffer ctl-buffer
2630 (ediff-get-diff-overlay diff-no buf-type)))
2631 (inhibit-read-only t)
2632 (narrow-overlay (ediff-eval-in-buffer ctl-buffer
2633 (ediff-get-value-according-to-buffer-type
2634 buf-type ediff-narrow-bounds)))
2635 (wide-overlay (ediff-eval-in-buffer ctl-buffer
2636 (ediff-get-value-according-to-buffer-type
2637 buf-type ediff-wide-bounds)))
2638 (visibility-overlay (ediff-eval-in-buffer ctl-buffer
2639 (ediff-get-value-according-to-buffer-type
2640 buf-type ediff-visible-bounds)))
2641 (visibility-min (ediff-overlay-start visibility-overlay))
2642 (visibility-max (ediff-overlay-end visibility-overlay))
2643 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
2644 after buffer-read-only before-change-function beg-of-line flag)
2646 ;; we need it to be a marker
2647 (setq visibility-max
2649 (make-marker) (if (numberp visibility-max) visibility-max 1)))
2653 ;; insert flag before the difference
2655 (setq beg-of-line (bolp))
2657 (setq flag (ediff-eval-in-buffer ctl-buffer
2659 (set before-flag-name ediff-before-flag-bol)
2660 (set before-flag-name ediff-before-flag-mol))))
2662 ;; insert the flag itself
2664 (ediff-overlay-put curr-overl 'begin-glyph flag)
2665 ;; before-string is not yet implemented in emacs.
2666 ;; when it will, I will be able to delete much of the rest of this
2668 ;;(ediff-overlay-put curr-overl 'before-string flag)
2669 (insert-before-markers flag)
2670 (if (or (not (numberp visibility-min)) (< before visibility-min))
2671 (setq visibility-min before))
2674 ;; insert the flag after the difference
2675 ;; `after' must be set here, after the before-flag was inserted
2676 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
2678 (setq beg-of-line (bolp))
2680 (setq flag (ediff-eval-in-buffer ctl-buffer
2682 (set after-flag-name ediff-after-flag-eol)
2683 (set after-flag-name ediff-after-flag-mol))))
2685 ;; insert the flag itself
2687 ;; In XEmacs, end-glyph of a 0-length overlay is not inserted.
2688 ;; Hopefully, this bug will be fixed in 19.12.
2689 (ediff-overlay-put curr-overl 'end-glyph flag)
2690 ;; after-string is not yet implemented in emacs.
2691 ;;(ediff-overlay-put curr-overl 'after-string flag)
2693 (if (> (point) visibility-max)
2694 (move-marker visibility-max (point)))
2696 (narrow-to-region visibility-min visibility-max)
2697 (ediff-move-overlay wide-overlay
2699 (ediff-overlay-start wide-overlay))
2701 (ediff-overlay-end wide-overlay)))
2702 (ediff-move-overlay narrow-overlay
2704 (ediff-overlay-start narrow-overlay))
2706 (ediff-overlay-end narrow-overlay)))
2708 (setq visibility-max nil) ; garbage-collect it
2712 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
2713 "Returns positions of difference sectors in the BUF-TYPE buffer.
2714 BUF-TYPE should be a symbol--either `A' or `B'.
2715 POS is either `beg' or `end'--it specifies whether you want the position at the
2716 beginning of a difference or at the end.
2718 The optional argument N says which difference \(default:
2719 `ediff-current-difference'\). The optional argument CONTROL-BUF says
2720 which control buffer is in effect in case it is not the current
2724 (setq control-buf (current-buffer)))
2726 (ediff-eval-in-buffer control-buf
2727 (or n (setq n ediff-current-difference))
2728 (if (or (< n 0) (>= n ediff-number-of-differences))
2729 (if (> ediff-number-of-differences 0)
2730 (error "There is no diff %d. Valid diffs are 1 to %d"
2731 (1+ n) ediff-number-of-differences)
2732 (error "No differences found")))
2733 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
2736 (ediff-overlay-start diff-overlay)
2737 (ediff-overlay-end diff-overlay))
2742 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
2743 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2744 (let* ((buff (ediff-get-buffer buf-type))
2745 (last (ediff-eval-in-buffer buff (point-max)))
2746 (begin (ediff-get-diff-posn buf-type 'beg n))
2747 (end (ediff-get-diff-posn buf-type 'end n))
2748 (xtra (if (equal begin end) 1 0))
2749 (end-hilit (min last (+ end xtra)))
2750 (current-diff-overlay
2752 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2755 (intern (format "ediff-odd-diff-face-%S" buf-type))))
2758 (intern (format "ediff-even-diff-face-%S" buf-type))))
2760 (intern (format "ediff-odd-diff-face-%S-var" buf-type)))
2762 (intern (format "ediff-even-diff-face-%S-var" buf-type)))
2767 current-diff-overlay begin end-hilit)
2768 ;; Emacs 19.22 has a bug, which requires that ediff-move-overlay will
2769 ;; have the buffer as a parameter. Believed fixed in 19.23.
2770 (ediff-move-overlay current-diff-overlay
2771 begin end-hilit buff))
2772 ;; giving priority of 0 and then changing it may look funny, but
2773 ;; this overcomes an obscure Emacs bug.
2774 (ediff-overlay-put current-diff-overlay 'priority 0)
2775 (ediff-overlay-put current-diff-overlay 'priority
2776 (ediff-highest-priority begin end-hilit buff))
2778 (or (face-differs-from-default-p odd-diff-face-var)
2779 (not ediff-highlight-all-diffs)
2781 (copy-face odd-diff-face odd-diff-face-var)
2782 (copy-face even-diff-face even-diff-face-var)))
2784 ;; unhighlight the background overlay for diff n so they won't
2785 ;; interfere with the current diff overlay
2786 (ediff-overlay-put (ediff-get-diff-overlay n buf-type) 'face nil)
2790 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
2791 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2792 (let ((current-diff-overlay
2794 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2796 (intern (format "ediff-odd-diff-face-%S-var" buf-type)))
2798 (intern (format "ediff-even-diff-face-%S-var" buf-type)))
2800 (ediff-get-diff-overlay ediff-current-difference buf-type))
2803 (ediff-move-overlay current-diff-overlay 1 1)
2805 ;; rehighlight the overlay in the background of the
2806 ;; current difference region
2807 (ediff-overlay-put overlay
2808 'face (if (ediff-odd-p ediff-current-difference)
2810 even-diff-face-var))
2813 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
2814 (let (buffer-read-only)
2815 (ediff-unselect-and-select-difference -1)
2816 (if (and window-system ediff-use-faces)
2817 (let* ((inhibit-quit t)
2818 (current-diff-overlay-var
2819 (intern (format "ediff-current-diff-overlay-%S" buf-type)))
2820 (current-diff-overlay (symbol-value current-diff-overlay-var))
2822 (intern (format "ediff-odd-diff-face-%S-var" buf-type)))
2824 (intern (format "ediff-even-diff-face-%S-var" buf-type))))
2825 (if (face-differs-from-default-p odd-diff-face-var)
2827 (copy-face 'default odd-diff-face-var)
2828 (copy-face 'default even-diff-face-var)))
2829 (if (ediff-overlayp current-diff-overlay)
2830 (ediff-delete-overlay current-diff-overlay))
2831 (set current-diff-overlay-var nil)
2836 ;; null out difference overlays so they won't slow down future
2837 ;; editing operations
2838 ;; VEC is either a difference vector or a fine-diff vector
2839 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
2840 (if (vectorp (symbol-value vec-var))
2843 (ediff-delete-overlay
2844 (ediff-get-diff-overlay-from-diff-record elt))
2846 (ediff-clear-fine-diff-vector elt))
2848 (symbol-value vec-var)))
2849 ;; allow them to be garbage collected
2852 (defun ediff-operate-on-flags (action)
2853 "Re/unhighlights buffers A and B with all flags from all Ediff sessions.
2854 This is usually needed only when a
2855 buffer is involved in multiple Ediff sessions."
2856 (let* ((A-sessions (ediff-eval-in-buffer ediff-buffer-A
2857 ediff-this-buffer-control-sessions))
2858 (B-sessions (ediff-eval-in-buffer ediff-buffer-B
2859 ediff-this-buffer-control-sessions))
2860 (C-sessions (if ediff-3way-job
2861 (ediff-eval-in-buffer ediff-buffer-C
2862 ediff-this-buffer-control-sessions)))
2863 (sessions (ediff-union
2864 (ediff-union A-sessions B-sessions) C-sessions))
2865 (flag (if (eq action 'remove) 'unselect-only 'select-only)))
2869 (if (ediff-buffer-live-p buf)
2870 (ediff-eval-in-buffer buf
2871 (or (if (eq action 'insert)
2872 (memq ediff-highlighting-style '(ascii off))
2873 (not (eq ediff-highlighting-style 'ascii)))
2874 (ediff-unselect-and-select-difference
2875 ediff-current-difference
2885 ;; These two functions are here to neutralize XEmacs unwillingless to
2886 ;; handle overlays whose buffers were deleted.
2887 (defun ediff-move-overlay (overlay beg end &optional buffer)
2888 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
2889 Checks if overlay's buffer exists before actually doing the move."
2890 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
2891 (if (ediff-buffer-live-p buf)
2894 (set-extent-endpoints overlay beg end)
2895 (set-extent-property overlay 'ediff-marker beg))
2896 (move-overlay overlay beg end buffer))
2899 (ediff-delete-overlay overlay)))))
2901 (defun ediff-overlay-put (overlay prop value)
2902 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
2903 Checks if overlay's buffer exists."
2904 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
2906 (set-extent-property overlay prop value)
2907 (overlay-put overlay prop value))
2908 (ediff-delete-overlay overlay)))
2911 ;; In Emacs 19.23 and XEmacs 19.10, the number of variables to
2912 ;; file-name-handler has changed.
2913 (defun ediff-find-file-name-handler (file)
2915 (setq newvers (if ediff-xemacs-p
2916 (ediff-check-version '> 19 9)
2917 (ediff-check-version '> 19 22)))
2919 (find-file-name-handler file 'find-file-noselect)
2920 (find-file-name-handler file))))
2922 ;; In XEmacs, it checks if the overlay is detached. If so, it reattaches
2923 ;; this overlay at position specified by ediff-marker.
2924 ;; If extent is not detached, it simply returns the start point.
2925 ;; In Emacs, this is the same as overlay-start.
2926 ;; If arg is not overlay, retuns nil
2927 (defun ediff-overlay-start (overl)
2928 (if (ediff-overlay-p overl)
2930 (overlay-start overl)
2931 (let ((pos (extent-property overl 'ediff-marker)))
2932 (if (and (ediff-overlay-get overl 'detached)
2933 (number-or-marker-p pos))
2934 (ediff-move-overlay overl pos pos))
2935 (extent-start-position overl)))))
2937 ;; In XEmacs, it checks if the overlay is detached. If so, it reattaches
2938 ;; this overlay at position specified by ediff-marker.
2939 ;; If extent is not detached, it simply returns the end point.
2940 ;; In Emacs, this is the same as overlay-end.
2941 (defun ediff-overlay-end (overl)
2942 (if (ediff-overlay-p overl)
2945 (let ((pos (extent-property overl 'ediff-marker)))
2946 (if (and (ediff-overlay-get overl 'detached)
2947 (number-or-marker-p pos))
2948 (ediff-move-overlay overl pos pos))
2949 (extent-end-position overl)))))
2951 ;; Makes overlays that remember their position, even if detached in XEmacs.
2952 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
2953 ;; supporting sticky overlays, this function will make a sticky overlay.
2954 ;; BEG and END are expressions telling where overlay starts.
2955 ;; If they are numbers or buffers, then all is well. Otherwise, they must
2956 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
2958 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
2959 ;; newly created overlay.
2960 (defun ediff-make-bullet-proof-overlay (beg end buff)
2961 (if (ediff-buffer-live-p buff)
2963 (ediff-eval-in-buffer buff
2964 (or (number-or-marker-p beg)
2965 (setq beg (eval beg)))
2966 (or (number-or-marker-p end)
2967 (setq end (eval end)))
2968 (setq overl (ediff-make-overlay beg end buff))
2972 ;; take precautions against detached extents
2974 overl 'ediff-marker (move-marker (make-marker) beg buff))
2975 ;; chars inserted at both ends will be inside extent
2976 (ediff-overlay-put overl 'start-open nil)
2977 (ediff-overlay-put overl 'end-open nil))
2978 (ediff-overlay-put overl 'ediff-diff-num 0)
2979 ;;(ediff-overlay-put overl 'insert-in-front-hooks
2980 ;; (list 'ediff-capture-inserts-in-front))
2981 ;;(ediff-overlay-put overl 'insert-behind-hooks
2982 ;; (list 'ediff-capture-inserts-behind))
2983 ;; These two are not yet implemented in Emacs
2984 ;;(ediff-overlay-put overl 'rear-sticky t)
2985 ;;(ediff-overlay-put overl 'front-sticky t)
2990 ;; Check the current version against the major and minor version numbers
2991 ;; using op: cur-vers op major.minor If emacs-major-version or
2992 ;; emacs-minor-version are not defined, we assume that the current version
2993 ;; is hopelessly outdated. We assume that emacs-major-version and
2994 ;; emacs-minor-version are defined. Otherwise, for Emacs/XEmacs 19, if the
2995 ;; current minor version is < 10 (xemacs) or < 23 (emacs) the return value
2996 ;; will be nil (when op is =, >, or >=) and t (when op is <, <=), which may be
2997 ;; incorrect. However, this gives correct result in our cases, since we are
2998 ;; testing for sufficiently high Emacs versions.
2999 (defun ediff-check-version (op major minor &optional type-of-emacs)
3000 (if (and (boundp 'emacs-major-version) (boundp 'emacs-minor-version))
3001 (and (cond ((eq type-of-emacs 'xemacs) ediff-xemacs-p)
3002 ((eq type-of-emacs 'emacs) ediff-emacs-p)
3004 (cond ((eq op '=) (and (= emacs-minor-version minor)
3005 (= emacs-major-version major)))
3006 ((memq op '(> >= < <=))
3007 (and (or (funcall op emacs-major-version major)
3008 (= emacs-major-version major))
3009 (if (= emacs-major-version major)
3010 (funcall op emacs-minor-version minor)
3013 (error "%S: Invalid op in ediff-check-version" op))))
3014 (cond ((memq op '(= > >=)) nil)
3015 ((memq op '(< <=)) t))))
3018 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3019 ;; other insignificant buffers (those beginning with "^[ *]").
3020 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3022 (defun ediff-other-buffer (buff)
3023 (if (not (listp buff)) (setq buff (list buff)))
3024 (let* ((screen-buffers (buffer-list))
3025 (significant-buffers
3027 (function (lambda (x)
3028 (cond ((member (buffer-name x) buff)
3030 ((not (ediff-get-visible-buffer-window x))
3032 ((string-match "^ " (buffer-name x))
3036 (buffers (delq nil significant-buffers))
3037 less-significant-buffers)
3039 (cond (buffers (car buffers))
3040 ;; try also buffers that are not displayed in windows
3041 ((setq less-significant-buffers
3046 (cond ((member (buffer-name x) buff) nil)
3047 ((string-match "^[ *]" (buffer-name x)) nil)
3050 (car less-significant-buffers))
3051 (t (other-buffer (current-buffer))))
3055 ;; Construct a unique buffer name.
3056 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3057 ;; prefix<3>suffix, etc.
3058 (defun ediff-unique-buffer-name (prefix suffix)
3059 (if (null (get-buffer (concat prefix suffix)))
3060 (concat prefix suffix)
3062 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3064 (format "%s<%d>%s" prefix n suffix))))
3067 ;; Early versions of XEmacs didn't have window-live-p (or it didn't work right)
3068 (if (ediff-check-version '< 19 11 'xemacs)
3069 (defun window-live-p (win)
3073 (if(equal walk-win win)
3079 (defun ediff-submit-report ()
3080 "Submit bug report on Ediff."
3082 (let ((reporter-prompt-for-summary-p t)
3083 (ctl-buf ediff-control-buffer)
3084 varlist salutation buffer-name)
3085 (setq varlist '(ediff-diff-program ediff-diff-options
3086 ediff-patch-program ediff-patch-options
3089 ediff-auto-refine ediff-highlighting-style
3090 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3091 ediff-forward-word-function
3093 ediff-control-frame-parameters
3094 ediff-control-frame-position-function
3095 ediff-prefer-iconified-control-frame
3096 ediff-window-setup-function
3097 ediff-split-window-function
3104 Congratulations! You may have unearthed a bug in Ediff!
3106 Please make a concise and accurate summary of what happened
3107 and mail it to the address above.
3108 -----------------------------------------------------------
3111 (ediff-skip-unsuitable-frames)
3113 (set-mouse-position (ediff-selected-frame) 1 0))
3115 (switch-to-buffer ediff-msg-buffer)
3117 (delete-other-windows)
3119 Please read this first:
3120 ----------------------
3122 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3123 reporting that certain difference regions are not matched as you think they
3124 should, this is most likely due to the way Unix diff program decides what
3125 constitutes a difference region. Ediff is an Emacs interface to diff, and
3126 it has nothing to do with those decisions---it only takes the output from
3127 diff and presents it in a way that is better suited for human browsing and
3130 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3131 an Emacs bug. Report this to Emacs maintainers.
3133 Another popular topic for reports is compilation messages. Because Ediff
3134 interfaces to several other packages and runs under Emacs and XEmacs,
3135 byte-compilation may produce output like this:
3137 While compiling toplevel forms in file ediff.el:
3138 ** reference to free variable pm-color-alist
3139 ........................
3140 While compiling the end of the data:
3141 ** The following functions are not known to be defined:
3142 ediff-valid-color-p, ediff-display-color-p, ediff-set-face,
3143 ........................
3145 These are NOT errors, but inevitable warnings, which ought to be ignored.
3147 Please do not report those and similar things. However, comments and
3148 suggestions are always welcome.
3150 Mail anyway? (y or n) ")
3152 (if (y-or-n-p "Mail anyway? ")
3154 (if (ediff-buffer-live-p ctl-buf)
3155 (set-buffer ctl-buf))
3156 (setq buffer-name (buffer-name))
3158 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
3162 'delete-other-windows
3165 (beep 1)(message "Bug report aborted")
3166 (if (ediff-buffer-live-p ctl-buf)
3167 (ediff-eval-in-buffer ctl-buf
3168 (ediff-recenter 'no-rehighlight))))
3172 (defun ediff-union (list1 list2)
3173 "Combine LIST1 and LIST2 using a set-union operation.
3174 The result list contains all items that appear in either LIST1 or LIST2.
3175 This is a non-destructive function; it makes a copy of the data if necessary
3176 to avoid corrupting the original LIST1 and LIST2.
3177 This is a slightly simplified version from `cl-seq.el'. Added here to
3178 avoid loading cl-*."
3179 (cond ((null list1) list2) ((null list2) list1)
3180 ((equal list1 list2) list1)
3182 (or (>= (length list1) (length list2))
3183 (setq list1 (prog1 list2 (setq list2 list1))))
3185 (or (memq (car list2) list1)
3186 (setq list1 (cons (car list2) list1)))
3187 (setq list2 (cdr list2)))
3190 (defun ediff-deactivate-mark ()
3192 (zmacs-deactivate-region)
3195 (cond ((fboundp 'nuke-selective-display)
3196 ;; XEmacs 19.12 has nuke-selective-display
3197 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
3199 (defun ediff-nuke-selective-display ()
3203 (goto-char (point-min))
3204 (let ((mod-p (buffer-modified-p))
3205 (buffer-read-only nil)
3207 (and (eq t selective-display)
3208 (while (search-forward "\^M" nil t)
3212 (while (search-forward "\^M" end t)
3215 (set-buffer-modified-p mod-p)
3216 (setq selective-display nil)))))
3220 ;; The next two are simplified versions from emerge.el.
3221 ;; VARS must be a list of symbols
3222 (defun ediff-save-variables (vars)
3223 (mapcar (function (lambda (v) (symbol-value v)))
3225 (defun ediff-restore-variables (vars values)
3227 (set (car vars) (car values))
3228 (setq vars (cdr vars)
3229 values (cdr values))))
3231 ;; When Emacs implements before/after-string properties in overlays,
3232 ;; this function will be deleted
3233 (defun ediff-remember-buffer-characteristics (&optional arg)
3234 "Record certain properties of the buffers being compared.
3235 Must be called in the control buffer. Saves `read-only', `modified',
3236 and `auto-save' properties in buffer local variables. Turns off
3237 `auto-save-mode'. These properties are restored via a call to
3238 `ediff-restore-buffer-characteristics'."
3240 ;; remember and alter buffer characteristics
3241 (set (if arg 'ediff-buffer-A-values-setup 'ediff-buffer-A-values)
3242 (ediff-eval-in-buffer ediff-buffer-A
3244 (ediff-save-variables ediff-saved-variables)
3245 (ediff-restore-variables ediff-saved-variables
3246 ediff-working-values))))
3247 (set (if arg 'ediff-buffer-B-values-setup 'ediff-buffer-B-values)
3248 (ediff-eval-in-buffer ediff-buffer-B
3250 (ediff-save-variables ediff-saved-variables)
3251 (ediff-restore-variables ediff-saved-variables
3252 ediff-working-values))))
3253 (if (ediff-buffer-live-p ediff-buffer-C)
3254 (set (if arg 'ediff-buffer-C-values-setup 'ediff-buffer-C-values)
3255 (ediff-eval-in-buffer ediff-buffer-C
3257 (ediff-save-variables ediff-saved-variables)
3258 (ediff-restore-variables ediff-saved-variables
3259 ediff-working-values)))))
3262 ;; must execute in control buf
3263 (defun ediff-save-protected-variables ()
3264 (setq ediff-buffer-A-values-orig
3265 (ediff-eval-in-buffer ediff-buffer-A
3266 (ediff-save-variables ediff-protected-variables)))
3267 (setq ediff-buffer-B-values-orig
3268 (ediff-eval-in-buffer ediff-buffer-B
3269 (ediff-save-variables ediff-protected-variables)))
3270 (if ediff-3way-comparison-job
3271 (setq ediff-buffer-C-values-orig
3272 (ediff-eval-in-buffer ediff-buffer-C
3273 (ediff-save-variables ediff-protected-variables)))))
3275 ;; must execute in control buf
3276 (defun ediff-restore-protected-variables ()
3277 (let ((values-A ediff-buffer-A-values-orig)
3278 (values-B ediff-buffer-B-values-orig)
3279 (values-C ediff-buffer-C-values-orig))
3280 (ediff-eval-in-buffer ediff-buffer-A
3281 (ediff-restore-variables ediff-protected-variables values-A))
3282 (ediff-eval-in-buffer ediff-buffer-B
3283 (ediff-restore-variables ediff-protected-variables values-B))
3284 (if ediff-3way-comparison-job
3285 (ediff-eval-in-buffer ediff-buffer-C
3286 (ediff-restore-variables ediff-protected-variables values-C)))))
3288 ;; When Emacs implements before/after-string properties in overlays, this
3289 ;; function will be called only once, in ediff-really-quit.
3290 (defun ediff-restore-buffer-characteristics (&optional arg)
3291 "Restore properties saved by `ediff-remember-buffer-characteristics'."
3292 (let ((A-values (if arg ediff-buffer-A-values-setup ediff-buffer-A-values))
3293 (B-values (if arg ediff-buffer-B-values-setup ediff-buffer-B-values))
3294 (C-values (if arg ediff-buffer-C-values-setup ediff-buffer-C-values))
3297 (ediff-eval-in-buffer ediff-buffer-A
3298 (ediff-restore-variables ediff-saved-variables A-values))
3299 (ediff-eval-in-buffer ediff-buffer-B
3300 (ediff-restore-variables ediff-saved-variables B-values))
3301 (if (ediff-buffer-live-p ediff-buffer-C)
3302 (ediff-eval-in-buffer ediff-buffer-C
3303 (ediff-restore-variables ediff-saved-variables C-values)))
3309 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3311 ;; calculate time used by command
3312 (defun ediff-calc-command-time ()
3313 (let ((end (current-time))
3316 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3317 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3318 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3319 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3320 (or (equal ediff-command-begin-time '(0 0 0))
3321 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3323 (defsubst ediff-save-time ()
3324 (setq ediff-command-begin-time (current-time)))
3326 (defun ediff-profile ()
3327 "Toggle profiling Ediff commands."
3329 (or (ediff-buffer-live-p ediff-control-buffer)
3330 (error "This command runs only out of Ediff Control Buffer"))
3331 (make-local-variable 'pre-command-hook)
3332 (make-local-variable 'post-command-hook)
3333 (if (memq 'ediff-save-time pre-command-hook)
3334 (progn (remove-hook 'pre-command-hook 'ediff-save-time)
3335 (remove-hook 'post-command-hook 'ediff-calc-command-time)
3336 (setq ediff-command-begin-time '(0 0 0))
3337 (message "Ediff profiling disabled"))
3338 (add-hook 'pre-command-hook 'ediff-save-time t)
3339 (add-hook 'post-command-hook 'ediff-calc-command-time)
3340 (message "Ediff profiling enabled")))
3342 (defun ediff-print-diff-vector (diff-vector-var)
3343 (princ (format "\n*** %S ***\n" diff-vector-var))
3348 "Diff %d: \tOverlay: %S
3350 \t\tNo-fine-diff-flag: %S
3351 \t\tState-of-diff:\t %S
3352 \t\tState-of-merge:\t %S
3354 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3357 (if (= (length (aref overl-vec 1)) 0)
3359 (mapconcat 'prin1-to-string
3360 (aref overl-vec 1) "\n\t\t\t "))
3361 (aref overl-vec 2) ; no fine diff flag
3362 (aref overl-vec 3) ; state-of-diff
3363 (aref overl-vec 4) ; state-of-merge
3365 (eval diff-vector-var)))
3369 (defun ediff-debug-info ()
3371 (or (ediff-buffer-live-p ediff-control-buffer)
3372 (error "This command runs only out of Ediff Control Buffer"))
3373 (with-output-to-temp-buffer ediff-debug-buffer
3374 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3375 (ediff-print-diff-vector (intern (concat "ediff-difference-vector-" "A")))
3376 (ediff-print-diff-vector (intern (concat "ediff-difference-vector-" "B")))
3377 (ediff-print-diff-vector (intern (concat "ediff-difference-vector-" "C")))
3380 ;; don't report error if version control package wasn't found
3381 ;;(ediff-load-version-control 'silent)
3383 (run-hooks 'ediff-load-hooks)
3385 ;; to foil foul play
3386 (if (or (not window-system)
3387 (ediff-check-version '< 19 11 'xemacs))
3388 (fset 'ediff-setup-windows-multiframe 'ediff-setup-windows-plain))
3391 ;;; Local Variables:
3392 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3393 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
3396 (provide 'ediff-util)
3398 ;;; ediff-util.el ends here