1 ;;; ediff-util.el --- the core commands and utilities of ediff
3 ;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
33 "Ediff mode controls all operations in a single Ediff session.
34 This mode is entered through one of the following commands:
43 `ediff-merge-files-with-ancestor'
45 `ediff-merge-buffers-with-ancestor'
46 `ediff-merge-revisions'
47 `ediff-merge-revisions-with-ancestor'
48 `ediff-windows-wordwise'
49 `ediff-windows-linewise'
50 `ediff-regions-wordwise'
51 `ediff-regions-linewise'
60 (kill-all-local-variables)
61 (setq major-mode 'ediff-mode)
62 (setq mode-name "Ediff")
63 (run-hooks 'ediff-mode-hook))
72 (ediff-defvar-local ediff-mode-map nil
73 "Local keymap used in Ediff mode.
74 This is local to each Ediff Control Panel, so they may vary from invocation
77 ;; Set up the keymap in the control buffer
78 (defun ediff-set-keys ()
79 "Set up Ediff keymap, if necessary."
80 (if (null ediff-mode-map)
82 (use-local-map ediff-mode-map))
84 ;; Reload Ediff keymap. For debugging only.
85 (defun ediff-reload-keymap ()
87 (setq ediff-mode-map nil)
91 (defun ediff-setup-keymap ()
92 "Set up the keymap used in the control buffer of Ediff."
93 (setq ediff-mode-map (make-sparse-keymap))
94 (suppress-keymap ediff-mode-map)
96 (define-key ediff-mode-map "p" 'ediff-previous-difference)
97 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
98 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
99 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
100 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
101 'ediff-previous-difference nil))
102 (define-key ediff-mode-map "n" 'ediff-next-difference)
103 (define-key ediff-mode-map " " 'ediff-next-difference)
104 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
105 (define-key ediff-mode-map "g" nil)
106 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
107 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
108 (define-key ediff-mode-map "q" 'ediff-quit)
109 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
110 (define-key ediff-mode-map "z" 'ediff-suspend)
111 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
112 (define-key ediff-mode-map "|" 'ediff-toggle-split)
113 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
115 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
117 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
118 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
119 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
120 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
121 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
122 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
123 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
124 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
125 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
126 (define-key ediff-mode-map "i" 'ediff-status-info)
127 (define-key ediff-mode-map "E" 'ediff-documentation)
128 (define-key ediff-mode-map "?" 'ediff-toggle-help)
129 (define-key ediff-mode-map "!" 'ediff-update-diffs)
130 (define-key ediff-mode-map "M" 'ediff-show-meta-buffer)
131 (define-key ediff-mode-map "R" 'ediff-show-registry)
133 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
134 (define-key ediff-mode-map "a" nil)
135 (define-key ediff-mode-map "b" nil)
136 (define-key ediff-mode-map "r" nil)
137 (cond (ediff-merge-job
138 ;; Will barf if no ancestor
139 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
140 ;; In merging, we allow only A->C and B->C copying.
141 (define-key ediff-mode-map "a" (function
144 (ediff-diff-to-diff arg "ac"))))
145 (define-key ediff-mode-map "b" (function
148 (ediff-diff-to-diff arg "bc"))))
149 (define-key ediff-mode-map "r" (function
152 (ediff-restore-diff arg ?c))))
153 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
154 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
155 (define-key ediff-mode-map "$" 'ediff-toggle-show-clashes-only)
156 (define-key ediff-mode-map "&" 'ediff-re-merge))
157 (ediff-3way-comparison-job
158 (define-key ediff-mode-map "ab" 'ediff-diff-to-diff)
159 (define-key ediff-mode-map "ba" 'ediff-diff-to-diff)
160 (define-key ediff-mode-map "ac" 'ediff-diff-to-diff)
161 (define-key ediff-mode-map "bc" 'ediff-diff-to-diff)
162 (define-key ediff-mode-map "c" nil)
163 (define-key ediff-mode-map "ca" 'ediff-diff-to-diff)
164 (define-key ediff-mode-map "cb" 'ediff-diff-to-diff)
165 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
166 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
167 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
168 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
169 (t ; 2-way comparison
170 (define-key ediff-mode-map "a" (function
173 (ediff-diff-to-diff arg "ab"))))
174 (define-key ediff-mode-map "b" (function
177 (ediff-diff-to-diff arg "ba"))))
178 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
179 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
181 (define-key ediff-mode-map "G" 'ediff-submit-report)
182 (define-key ediff-mode-map "#" nil)
183 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
184 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
186 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
187 (define-key ediff-mode-map "o" nil)
188 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
189 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
190 (define-key ediff-mode-map "w" nil)
191 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
192 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
193 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
196 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
197 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
200 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
202 ;; Allow ediff-mode-map to be referenced indirectly
203 (fset 'ediff-mode-map ediff-mode-map)
204 (run-hooks 'ediff-keymap-setup-hook))
209 (require 'ediff-wind)
211 (or (boundp 'synchronize-minibuffers)
212 (defvar synchronize-minibuffers nil))
214 ;; Common startup entry for all Ediff functions
215 ;; It now returns control buffer so other functions can do post-processing
216 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
217 startup-hooks setup-parameters)
218 (setq file-A (expand-file-name file-A))
219 (setq file-B (expand-file-name file-B))
221 (setq file-C (expand-file-name file-C)))
222 (let* ((control-buffer-name
223 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
224 (control-buffer (ediff-eval-in-buffer buffer-A
225 (get-buffer-create control-buffer-name))))
226 (ediff-eval-in-buffer control-buffer
229 ;; unwrap set up parameters passed as argument
230 (while setup-parameters
231 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
232 (setq setup-parameters (cdr setup-parameters)))
234 ;; set variables classifying the current ediff job
235 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
236 ediff-merge-job (ediff-merge-job)
237 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
238 ediff-3way-job (ediff-3way-job)
239 ediff-diff3-job (ediff-diff3-job)
240 ediff-narrow-job (ediff-narrow-job)
241 ediff-windows-job (ediff-windows-job)
242 ediff-word-mode-job (ediff-word-mode-job))
244 (make-local-variable 'ediff-prefer-long-help-message)
245 (make-local-variable 'ediff-prefer-iconified-control-frame)
246 (make-local-variable 'ediff-split-window-function)
247 (make-local-variable 'ediff-default-variant)
248 (make-local-variable 'ediff-merge-window-share)
249 (make-local-variable 'ediff-window-setup-function)
250 (make-local-variable 'ediff-keep-variants)
252 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
253 ;; This is because u may loose work---dangerous.
254 (if (string-match "buffer" (symbol-name ediff-job-name))
255 (setq ediff-keep-variants t))
257 ;; XEmacs has local-pre-command-hook
259 (make-local-variable 'pre-command-hook))
262 (add-hook 'pre-command-hook 'ediff-spy-after-mouse)
263 (add-hook 'local-pre-command-hook 'ediff-spy-after-mouse))
264 (setq ediff-mouse-pixel-position (mouse-pixel-position))
266 ;; adjust for merge jobs
269 ;; If default variant is `combined', the right stuff is
270 ;; inserted by ediff-do-merge
271 ;; Note: at some point, we tried to put ancestor buffer here
272 ;; (which is currently buffer C. This didn't work right
273 ;; because the merge buffer will contain lossage: diff regions
274 ;; in the ancestor, which correspond to revisions that agree
275 ;; in both buf A and B.
276 (cond ((eq ediff-default-variant 'default-B)
280 (setq ediff-split-window-function
281 ediff-merge-split-window-function)
283 ;; remember the ancestor buffer, if any
284 (setq ediff-ancestor-buffer buffer-C)
288 (ediff-unique-buffer-name "*ediff-merge" "*")))
290 (set-buffer buffer-C)
292 (funcall (ediff-eval-in-buffer buf major-mode))
293 ;; after Stig@hackvan.com
294 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode)
296 (setq buffer-read-only nil
297 ediff-buffer-A buffer-A
298 ediff-buffer-B buffer-B
299 ediff-buffer-C buffer-C
300 ediff-control-buffer control-buffer)
302 (setq ediff-control-buffer-suffix
303 (if (string-match "<[0-9]*>" control-buffer-name)
304 (substring control-buffer-name
305 (match-beginning 0) (match-end 0))
307 ediff-control-buffer-number
313 ediff-control-buffer-suffix
315 (string-match "[0-9]+" ediff-control-buffer-suffix)
318 (setq ediff-error-buffer
319 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
321 (ediff-eval-in-buffer buffer-A (ediff-strip-mode-line-format))
322 (ediff-eval-in-buffer buffer-B (ediff-strip-mode-line-format))
324 (ediff-eval-in-buffer buffer-C (ediff-strip-mode-line-format)))
325 (if (ediff-buffer-live-p ediff-ancestor-buffer)
326 (ediff-eval-in-buffer ediff-ancestor-buffer
327 (ediff-strip-mode-line-format)))
329 (ediff-save-protected-variables) ; save variables to be restored on exit
331 ;; ediff-setup-diff-regions-function must be set after setup
332 ;; parameters are processed.
333 (setq ediff-setup-diff-regions-function
335 'ediff-setup-diff-regions3
336 'ediff-setup-diff-regions))
338 (setq ediff-wide-bounds
339 (list (ediff-make-bullet-proof-overlay
340 '(point-min) '(point-max) ediff-buffer-A)
341 (ediff-make-bullet-proof-overlay
342 '(point-min) '(point-max) ediff-buffer-B)
343 (ediff-make-bullet-proof-overlay
344 '(point-min) '(point-max) ediff-buffer-C)))
346 ;; This has effect only on ediff-windows/regions
347 ;; In all other cases, ediff-visible-region sets visibility bounds to
348 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
349 (if ediff-start-narrowed
350 (setq ediff-visible-bounds ediff-narrow-bounds)
351 (setq ediff-visible-bounds ediff-wide-bounds))
353 (ediff-set-keys) ; comes after parameter setup
355 ;; set up ediff-narrow-bounds, if not set
356 (or ediff-narrow-bounds
357 (setq ediff-narrow-bounds ediff-wide-bounds))
359 ;; All these must be inside ediff-eval-in-buffer control-buffer,
360 ;; since these vars are local to control-buffer
361 ;; These won't run if there are errors in diff
362 (ediff-eval-in-buffer ediff-buffer-A
363 (ediff-nuke-selective-display)
364 (run-hooks 'ediff-prepare-buffer-hook)
365 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
366 (setq buffer-read-only t))
367 ;; add control-buffer to the list of sessions--no longer used, but may
368 ;; be used again in the future
369 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
370 (setq ediff-this-buffer-ediff-sessions
371 (cons control-buffer ediff-this-buffer-ediff-sessions)))
373 (ediff-eval-in-buffer ediff-buffer-B
374 (ediff-nuke-selective-display)
375 (run-hooks 'ediff-prepare-buffer-hook)
376 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
377 (setq buffer-read-only t))
378 ;; add control-buffer to the list of sessions
379 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
380 (setq ediff-this-buffer-ediff-sessions
381 (cons control-buffer ediff-this-buffer-ediff-sessions)))
384 (ediff-eval-in-buffer ediff-buffer-C
385 (ediff-nuke-selective-display)
386 (run-hooks 'ediff-prepare-buffer-hook)
387 ;; add control-buffer to the list of sessions
388 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
389 (setq ediff-this-buffer-ediff-sessions
391 ediff-this-buffer-ediff-sessions)))
394 (if (ediff-buffer-live-p ediff-ancestor-buffer)
395 (ediff-eval-in-buffer ediff-ancestor-buffer
396 (ediff-nuke-selective-display)
397 (setq buffer-read-only t)
398 (run-hooks 'ediff-prepare-buffer-hook)
399 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
400 (setq ediff-this-buffer-ediff-sessions
402 ediff-this-buffer-ediff-sessions)))
405 ;; must come after setting up ediff-narrow-bounds AND after
406 ;; nuking selective display
407 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
408 (setq ediff-number-of-differences (length ediff-difference-vector-A))
409 (setq ediff-current-difference -1)
411 (ediff-make-current-diff-overlay 'A)
412 (ediff-make-current-diff-overlay 'B)
414 (ediff-make-current-diff-overlay 'C))
415 (if ediff-merge-with-ancestor-job
416 (ediff-make-current-diff-overlay 'Ancestor))
418 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
420 (let ((shift-A (ediff-overlay-start
421 (ediff-get-value-according-to-buffer-type
422 'A ediff-narrow-bounds)))
423 (shift-B (ediff-overlay-start
424 (ediff-get-value-according-to-buffer-type
425 'B ediff-narrow-bounds)))
426 (shift-C (ediff-overlay-start
427 (ediff-get-value-according-to-buffer-type
428 'C ediff-narrow-bounds))))
429 ;; position point in buf A
431 (select-window ediff-window-A)
433 ;; position point in buf B
435 (select-window ediff-window-B)
439 (select-window ediff-window-C)
440 (goto-char shift-C)))
443 (select-window ediff-control-window)
444 (ediff-visible-region)
446 (run-hooks 'startup-hooks)
447 (ediff-refresh-mode-lines)
448 (setq buffer-read-only t)
449 (setq ediff-session-registry
450 (cons control-buffer ediff-session-registry))
451 (ediff-update-registry)
452 (if (ediff-buffer-live-p ediff-meta-buffer)
453 (ediff-update-meta-buffer ediff-meta-buffer))
454 (run-hooks 'ediff-startup-hook)
455 ) ; eval in control-buffer
459 ;; This function assumes that we are in the window where control buffer is
461 (defun ediff-setup-control-buffer (ctl-buf)
462 "Set up window for control buffer."
463 (if (window-dedicated-p (selected-window))
464 (set-buffer ctl-buf) ; we are in control frame but just in case
465 (switch-to-buffer ctl-buf))
466 (let ((window-min-height 2))
468 (ediff-set-help-message)
469 (insert ediff-help-message)
470 (shrink-window-if-larger-than-buffer)
471 (or (ediff-multiframe-setup-p)
472 (ediff-indent-help-message))
473 (set-buffer-modified-p nil)
474 (ediff-refresh-mode-lines)
475 (setq ediff-control-window (selected-window))
476 (setq ediff-window-config-saved
477 (format "%S%S%S%S%S%S%S"
482 ediff-split-window-function
483 (ediff-multiframe-setup-p)
484 ediff-wide-display-p))
485 (goto-char (point-min))
486 (skip-chars-forward ediff-whitespace)))
488 ;; assuming we are in control window, calculate length of the first line in
490 (defun ediff-help-message-line-length ()
492 (goto-char (point-min))
493 (if ediff-prefer-long-help-message
499 (defun ediff-indent-help-message ()
500 (let* ((shift (/ (max 0 (- (window-width (selected-window))
501 (ediff-help-message-line-length)))
503 (str (make-string shift ?\ )))
505 (goto-char (point-min))
506 (while (< (point) (point-max))
512 (defun ediff-set-help-message ()
513 (setq ediff-long-help-message
514 (cond ((and ediff-long-help-message-function
515 (or (symbolp ediff-long-help-message-function)
516 (consp ediff-long-help-message-function)))
517 (funcall ediff-long-help-message-function))
519 (concat ediff-long-help-message-head
520 ediff-long-help-message-word-mode
521 ediff-long-help-message-tail))
523 (concat ediff-long-help-message-head
524 ediff-long-help-message-narrow2
525 ediff-long-help-message-tail))
527 (concat ediff-long-help-message-head
528 ediff-long-help-message-merge
529 ediff-long-help-message-tail))
531 (concat ediff-long-help-message-head
532 ediff-long-help-message-compare3
533 ediff-long-help-message-tail))
535 (concat ediff-long-help-message-head
536 ediff-long-help-message-compare2
537 ediff-long-help-message-tail))))
538 (setq ediff-brief-help-message
539 (cond ((and ediff-brief-help-message-function
540 (or (symbolp ediff-brief-help-message-function)
541 (consp ediff-brief-help-message-function)))
542 (funcall ediff-brief-help-message-function))
543 ((stringp ediff-brief-help-message-function)
544 ediff-brief-help-message-function)
545 ((ediff-multiframe-setup-p) ediff-brief-message-string)
546 (t ; long brief msg, not multiframe --- put in the middle
547 ediff-brief-message-string)
549 (setq ediff-help-message (if ediff-prefer-long-help-message
550 ediff-long-help-message
551 ediff-brief-help-message))
552 (run-hooks 'ediff-display-help-hook))
556 ;;; Commands for working with Ediff
558 (defun ediff-update-diffs ()
559 "Recompute difference regions in buffers A, B, and C.
560 Buffers are not synchronized with their respective files, so changes done
561 to these buffers are not saved at this point---the user can do this later,
564 (ediff-barf-if-not-control-buffer)
565 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
566 (not (y-or-n-p "Recompute differences during merge, really? ")))
567 (error "God forbid!"))
569 (let ((point-A (ediff-eval-in-buffer ediff-buffer-A (point)))
570 ;;(point-B (ediff-eval-in-buffer ediff-buffer-B (point)))
571 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
573 (file-name-nondirectory (or (buffer-file-name ediff-buffer-A)
574 (buffer-name ediff-buffer-A)
577 (file-name-nondirectory (or (buffer-file-name ediff-buffer-B)
578 (buffer-name ediff-buffer-B)
581 (file-name-nondirectory (or (buffer-file-name ediff-buffer-C)
582 ;; if (null ediff-buffer-C), there is
583 ;; no danger, since we later check if
584 ;; ediff-buffer-C is alive
585 (buffer-name ediff-buffer-C)
587 (overl-A (ediff-get-value-according-to-buffer-type
588 'A ediff-narrow-bounds))
589 (overl-B (ediff-get-value-according-to-buffer-type
590 'B ediff-narrow-bounds))
591 (overl-C (ediff-get-value-according-to-buffer-type
592 'C ediff-narrow-bounds))
593 beg-A end-A beg-B end-B beg-C end-C
594 file-A file-B file-C)
595 (ediff-unselect-and-select-difference -1)
597 (setq beg-A (ediff-overlay-start overl-A)
598 beg-B (ediff-overlay-start overl-B)
599 beg-C (ediff-overlay-start overl-C)
600 end-A (ediff-overlay-end overl-A)
601 end-B (ediff-overlay-end overl-B)
602 end-C (ediff-overlay-end overl-C))
606 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
607 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
608 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
609 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
612 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
613 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
616 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
617 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
619 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
622 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
623 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
624 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
625 (ediff-clear-diff-vector
626 'ediff-difference-vector-Ancestor 'fine-diffs-also)
627 ;; let them garbage collect. we can't use the ancestor after recomputing
629 (setq ediff-difference-vector-Ancestor nil
630 ediff-ancestor-buffer nil
631 ediff-state-of-merge nil)
633 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
635 ;; In case of merge job, fool it into thinking that it is just doing
637 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
638 (ediff-3way-comparison-job ediff-3way-comparison-job)
639 (ediff-merge-job ediff-merge-job)
640 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
641 (ediff-job-name ediff-job-name))
643 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
644 ediff-3way-comparison-job t
646 ediff-merge-with-ancestor-job nil
647 ediff-job-name 'ediff-files3))
648 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
650 (setq ediff-number-of-differences (length ediff-difference-vector-A))
654 (delete-file file-C))
657 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
659 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
663 ;; Not bound to any key---to dangerous. A user can do it if necessary.
664 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
665 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
667 (ediff-barf-if-not-control-buffer)
668 (let ((bufA ediff-buffer-A)
669 (bufB ediff-buffer-B)
670 (bufC ediff-buffer-C)
671 (ctl-buf ediff-control-buffer)
672 (keep-variants ediff-keep-variants)
673 (ancestor-buf ediff-ancestor-buffer)
674 (ancestor-job ediff-merge-with-ancestor-job)
675 (merge ediff-merge-job)
676 (comparison ediff-3way-comparison-job))
677 (ediff-eval-in-buffer bufA
678 (revert-buffer t noconfirm))
679 (ediff-eval-in-buffer bufB
680 (revert-buffer t noconfirm))
681 ;; this should only be executed in a 3way comparison, not in merge
683 (ediff-eval-in-buffer bufC
684 (revert-buffer t noconfirm)))
688 ;; the argument says whether to reverse the meaning of
689 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
691 (ediff-really-quit (not keep-variants))
694 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
695 (ediff-merge-buffers bufA bufB)))
696 (ediff-update-diffs))))
699 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
700 (defun ediff-recenter (&optional no-rehighlight)
701 "Bring the highlighted region of all buffers being compared into view.
702 Reestablish the default three-window display."
704 (ediff-barf-if-not-control-buffer)
706 ;; force all minibuffer to display ediff's messages.
707 ;; when xemacs implements minibufferless frames, this won't be necessary
708 (if ediff-xemacs-p (setq synchronize-minibuffers t))
710 (setq ediff-disturbed-overlays nil) ; clear after use
711 (let (buffer-read-only)
712 (if (and (ediff-buffer-live-p ediff-buffer-A)
713 (ediff-buffer-live-p ediff-buffer-B)
714 (or (not ediff-3way-job)
715 (ediff-buffer-live-p ediff-buffer-C)))
717 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
718 (or (eq this-command 'ediff-quit)
720 "You've killed an essential Ediff buffer---Please quit Ediff"
724 ;; set visibility range appropriate to this invocation of Ediff.
725 (ediff-visible-region)
727 (if (and (ediff-window-display-p)
728 (symbolp this-command)
729 (symbolp last-command)
730 ;; Either one of the display-changing commands
731 (or (memq this-command
733 ediff-dir-action ediff-registry-action
735 ediff-toggle-wide-display ediff-toggle-multiframe))
736 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
737 ;; This avoids raising frames unnecessarily.
738 (and (memq this-command
739 '(ediff-next-difference
740 ediff-previous-difference
741 ediff-jump-to-difference
742 ediff-jump-to-difference-at-point))
743 (not (string-match "^ediff-" (symbol-name last-command)))
746 (if (window-live-p ediff-window-A)
747 (raise-frame (window-frame ediff-window-A)))
748 (if (window-live-p ediff-window-B)
749 (raise-frame (window-frame ediff-window-B)))
750 (if (window-live-p ediff-window-C)
751 (raise-frame (window-frame ediff-window-C)))))
752 (if (and (ediff-window-display-p)
753 (frame-live-p ediff-control-frame)
754 (not ediff-prefer-long-help-message)
755 (not (ediff-frame-iconified-p ediff-control-frame)))
756 (raise-frame ediff-control-frame))
758 ;; Redisplay whatever buffers are showing, if there is a selected difference
759 (let ((control-frame ediff-control-frame)
760 (control-buf ediff-control-buffer))
761 (if (and (ediff-buffer-live-p ediff-buffer-A)
762 (ediff-buffer-live-p ediff-buffer-B)
763 (or (not ediff-3way-job)
764 (ediff-buffer-live-p ediff-buffer-C))
768 (ediff-select-difference ediff-current-difference))
770 (ediff-recenter-one-window 'A)
771 (ediff-recenter-one-window 'B)
773 (ediff-recenter-one-window 'C))
775 (ediff-eval-in-buffer control-buf
776 (ediff-recenter-ancestor) ; it checks if ancestor is alive
778 (if (and (ediff-multiframe-setup-p)
779 (not ediff-prefer-long-help-message)
780 (not (ediff-frame-iconified-p ediff-control-frame)))
781 ;; never grab mouse on quit in this place
784 (eq this-command 'ediff-quit))))
786 (ediff-eval-in-buffer control-buf
787 (ediff-refresh-mode-lines))
790 ;; this function returns to the window it was called from
791 ;; (which was the control window)
792 (defun ediff-recenter-one-window (buf-type)
793 (if (ediff-valid-difference-p)
794 ;; context must be saved before switching to windows A/B/C
795 (let* ((ctl-wind (selected-window))
796 (shift (ediff-overlay-start
797 (ediff-get-value-according-to-buffer-type
798 buf-type ediff-narrow-bounds)))
799 (job-name ediff-job-name)
800 (control-buf ediff-control-buffer)
801 (window-name (intern (format "ediff-window-%S" buf-type)))
802 (window (if (window-live-p (symbol-value window-name))
803 (symbol-value window-name))))
805 (if (and window ediff-windows-job)
806 (set-window-start window shift))
809 (select-window window)
810 (ediff-deactivate-mark)
811 (ediff-position-region
812 (ediff-get-diff-posn buf-type 'beg nil control-buf)
813 (ediff-get-diff-posn buf-type 'end nil control-buf)
814 (ediff-get-diff-posn buf-type 'beg nil control-buf)
817 (select-window ctl-wind)
820 (defun ediff-recenter-ancestor ()
821 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
823 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
824 (ediff-valid-difference-p))
825 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
826 (ctl-wind (selected-window))
827 (job-name ediff-job-name)
828 (ctl-buf ediff-control-buffer))
829 (ediff-eval-in-buffer ediff-ancestor-buffer
830 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
833 (select-window window)
834 (ediff-position-region
835 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
836 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
837 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
839 (select-window ctl-wind)
843 ;; This will have to be refined for 3way jobs
844 (defun ediff-toggle-split ()
845 "Toggle vertical/horizontal window split.
846 Does nothing if file-A and file-B are in different frames."
848 (ediff-barf-if-not-control-buffer)
849 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
850 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
851 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
852 (frame-A (if wind-A (window-frame wind-A)))
853 (frame-B (if wind-B (window-frame wind-B)))
854 (frame-C (if wind-C (window-frame wind-C))))
855 (if (or (eq frame-A frame-B)
856 (not (frame-live-p frame-A))
857 (not (frame-live-p frame-B))
858 (if ediff-3way-comparison-job
859 (or (not (frame-live-p frame-C))
860 (eq frame-A frame-C) (eq frame-B frame-C))))
861 (setq ediff-split-window-function
862 (if (eq ediff-split-window-function 'split-window-vertically)
863 'split-window-horizontally
864 'split-window-vertically))
865 (message "Buffers being compared are in different frames"))
866 (ediff-recenter 'no-rehighlight)))
868 (defun ediff-toggle-hilit ()
869 "Switch between highlighting using ASCII flags and highlighting using faces.
870 On a dumb terminal, switches between ASCII highlighting and no highlighting."
872 (ediff-barf-if-not-control-buffer)
873 (if (not (ediff-window-display-p))
874 (if (eq ediff-highlighting-style 'ascii)
876 (message "ASCII highlighting flags removed")
877 (ediff-unselect-and-select-difference ediff-current-difference
879 (setq ediff-highlighting-style 'off))
880 (ediff-unselect-and-select-difference ediff-current-difference
882 (ediff-unselect-and-select-difference ediff-current-difference
884 ;; cycle through highlighting
885 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
886 (message "Unhighlighting unselected difference regions")
887 (setq ediff-highlight-all-diffs nil))
889 (message "Highlighting with ASCII flags")
890 (setq ediff-use-faces nil))
892 (message "Re-highlighting all difference regions")
893 (setq ediff-use-faces t
894 ediff-highlight-all-diffs t)))
896 (if (and ediff-use-faces ediff-highlight-all-diffs)
897 (ediff-color-background-regions)
898 (ediff-color-background-regions 'unhighlight))
900 (ediff-unselect-and-select-difference
901 ediff-current-difference 'select-only))
904 (defun ediff-toggle-autorefine ()
905 "Toggle auto-refine mode."
907 (ediff-barf-if-not-control-buffer)
909 (error "No fine differences in this mode"))
910 (cond ((eq ediff-auto-refine 'nix)
911 (setq ediff-auto-refine 'on)
912 (ediff-make-fine-diffs ediff-current-difference 'noforce)
913 (message "Auto-refining is ON"))
914 ((eq ediff-auto-refine 'on)
915 (message "Auto-refining is OFF")
916 (setq ediff-auto-refine 'off))
918 (ediff-set-fine-diff-properties ediff-current-difference 'default)
919 (message "Refinements are HIDDEN")
920 (setq ediff-auto-refine 'nix))
923 (defun ediff-show-ancestor ()
924 "Show the ancestor buffer in a suitable window."
927 (or (ediff-buffer-live-p ediff-ancestor-buffer)
928 (if ediff-merge-with-ancestor-job
929 (error "Lost connection to ancestor buffer...sorry")
930 (error "Not merging with ancestor")))
932 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
933 (raise-frame (window-frame wind)))
934 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
936 (defun ediff-make-or-kill-fine-diffs (arg)
937 "Compute fine diffs. With negative prefix arg, kill fine diffs.
938 In both cases, operates on the currrent difference region."
940 (ediff-barf-if-not-control-buffer)
942 (ediff-clear-fine-differences ediff-current-difference))
943 ((and (numberp arg) (< arg 0))
944 (ediff-clear-fine-differences ediff-current-difference))
945 (t (ediff-make-fine-diffs))))
948 (defun ediff-toggle-help ()
949 "Toggle short/long help message."
951 (ediff-barf-if-not-control-buffer)
952 (let (buffer-read-only)
954 (setq ediff-prefer-long-help-message (not ediff-prefer-long-help-message))
955 (ediff-set-help-message))
956 ;; remember the icon status of the control frame when the user requested
957 ;; full control message
958 (if (and ediff-prefer-long-help-message (ediff-multiframe-setup-p))
959 (setq ediff-prefer-iconified-control-frame
960 (ediff-frame-iconified-p ediff-control-frame)))
962 (setq ediff-window-config-saved "") ; force redisplay
963 (ediff-recenter 'no-rehighlight))
966 ;; If BUF, this is the buffer to toggle, not current buffer.
967 (defun ediff-toggle-read-only (&optional buf)
968 "Toggle read-only in current buffer.
969 If buffer is under version control and locked, check it out first.
970 If optional argument BUF is specified, toggle read-only in that buffer instead
971 of the current buffer."
973 (ediff-barf-if-not-control-buffer)
974 (let ((ctl-buf (if (null buf) (current-buffer))))
975 (or buf (ediff-recenter))
978 (ediff-get-buffer (ediff-char-to-buftype last-command-char))))
980 (ediff-eval-in-buffer buf ; eval in buf A/B/C
981 (let* ((file (buffer-file-name buf))
982 (file-writable (and file
984 (file-writable-p file)))
985 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
986 ((ediff-file-checked-out-p file)
988 (file-writable 'toggle-read-only)
989 (t (key-binding "\C-x\C-q")))))
990 ;; If the file is checked in, make sure we don't make buffer modifiable
991 ;; without warning the user. The user can fool our checks by making the
992 ;; buffer non-RO without checking the file out. We regard this as a
994 (if (and (ediff-file-checked-in-p file)
995 ;; If ctl-buf is null, this means we called this
996 ;; non-interactively, in which case don't ask questions
998 (cond ((not buffer-read-only)
999 (setq toggle-ro-cmd 'toggle-read-only))
1000 ((and (or (beep 1) t) ; always beep
1003 "File %s is under version control. Check it out? "
1004 (ediff-abbreviate-file-name file))))
1005 ;; if we checked the file out, we should also change the
1006 ;; original state of buffer-read-only to nil. If we don't
1007 ;; do this, the mode line will show %%, since the file was
1008 ;; RO before ediff started, so the user will think the file
1010 (ediff-eval-in-buffer ctl-buf
1011 (ediff-change-saved-variable
1012 'buffer-read-only nil
1013 (ediff-char-to-buftype last-command-char))))
1015 (setq toggle-ro-cmd 'toggle-read-only)
1018 "Boy, this is risky! Better don't change this file...")
1019 (sit-for 3)))) ; let the user see the warning
1020 (if (and toggle-ro-cmd
1021 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1023 (save-window-excursion
1024 (command-execute toggle-ro-cmd)))
1025 (error "Don't know how to toggle read-only in buffer %S" buf))
1027 ;; Check if we made the current buffer updatable, but its file is RO.
1028 ;; Signal a warning in this case.
1029 (if (and file (not buffer-read-only)
1030 (eq this-command 'ediff-toggle-read-only)
1031 (file-exists-p file)
1032 (not (file-writable-p file)))
1033 (message "Warning: file %s is read-only"
1034 (ediff-abbreviate-file-name file) (beep 1)))
1038 ;; This is a simple-minded check for whether a file is under version control
1039 ;; and is checked out.
1040 ;; If file,v exists but file doesn't, this file is considered to be not checked
1041 ;; in and not checked out for the purpose of patching (since patch won't be
1042 ;; able to read such a file anyway).
1043 ;; FILE is a string representing file name
1044 (defsubst ediff-file-checked-out-p (file)
1046 (file-exists-p file)
1047 (file-writable-p file)
1048 (file-exists-p (concat file ",v"))))
1049 (defsubst ediff-file-checked-in-p (file)
1051 (file-exists-p file)
1052 (not (file-writable-p file))
1053 (file-exists-p (concat file ",v"))))
1055 (defun ediff-swap-buffers ()
1056 "Rotate the display of buffers A, B, and C."
1058 (ediff-barf-if-not-control-buffer)
1059 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1060 (let ((buf ediff-buffer-A)
1061 (values ediff-buffer-values-orig-A)
1062 (diff-vec ediff-difference-vector-A)
1063 (hide-regexp ediff-regexp-hide-A)
1064 (focus-regexp ediff-regexp-focus-A)
1065 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1066 (overlay (if (ediff-window-display-p)
1067 ediff-current-diff-overlay-A)))
1068 (if ediff-3way-comparison-job
1070 (set-window-buffer ediff-window-A ediff-buffer-C)
1071 (set-window-buffer ediff-window-B ediff-buffer-A)
1072 (set-window-buffer ediff-window-C ediff-buffer-B)
1074 (set-window-buffer ediff-window-A ediff-buffer-B)
1075 (set-window-buffer ediff-window-B ediff-buffer-A))
1076 ;; swap diff buffers
1077 (if ediff-3way-comparison-job
1078 (setq ediff-buffer-A ediff-buffer-C
1079 ediff-buffer-C ediff-buffer-B
1081 (setq ediff-buffer-A ediff-buffer-B
1082 ediff-buffer-B buf))
1084 ;; swap saved buffer characteristics
1085 (if ediff-3way-comparison-job
1086 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1087 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1088 ediff-buffer-values-orig-B values)
1089 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1090 ediff-buffer-values-orig-B values))
1092 ;; swap diff vectors
1093 (if ediff-3way-comparison-job
1094 (setq ediff-difference-vector-A ediff-difference-vector-C
1095 ediff-difference-vector-C ediff-difference-vector-B
1096 ediff-difference-vector-B diff-vec)
1097 (setq ediff-difference-vector-A ediff-difference-vector-B
1098 ediff-difference-vector-B diff-vec))
1100 ;; swap hide/focus regexp
1101 (if ediff-3way-comparison-job
1102 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1103 ediff-regexp-hide-C ediff-regexp-hide-B
1104 ediff-regexp-hide-B hide-regexp
1105 ediff-regexp-focus-A ediff-regexp-focus-C
1106 ediff-regexp-focus-C ediff-regexp-focus-B
1107 ediff-regexp-focus-B focus-regexp)
1108 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1109 ediff-regexp-hide-B hide-regexp
1110 ediff-regexp-focus-A ediff-regexp-focus-B
1111 ediff-regexp-focus-B focus-regexp))
1113 ;; The following is needed for XEmacs, since there one can't move
1114 ;; overlay to another buffer. In Emacs, this swap is redundant.
1115 (if (ediff-window-display-p)
1116 (if ediff-3way-comparison-job
1117 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1118 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1119 ediff-current-diff-overlay-B overlay)
1120 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1121 ediff-current-diff-overlay-B overlay)))
1124 (setq ediff-wide-bounds
1125 (cond (ediff-3way-comparison-job
1126 (list (nth 2 ediff-wide-bounds)
1127 (nth 0 ediff-wide-bounds)
1128 (nth 1 ediff-wide-bounds)))
1130 (list (nth 1 ediff-wide-bounds)
1131 (nth 0 ediff-wide-bounds)
1132 (nth 2 ediff-wide-bounds)))
1134 (list (nth 1 ediff-wide-bounds)
1135 (nth 0 ediff-wide-bounds)))))
1136 ;; swap narrow bounds
1137 (setq ediff-narrow-bounds
1138 (cond (ediff-3way-comparison-job
1139 (list (nth 2 ediff-narrow-bounds)
1140 (nth 0 ediff-narrow-bounds)
1141 (nth 1 ediff-narrow-bounds)))
1143 (list (nth 1 ediff-narrow-bounds)
1144 (nth 0 ediff-narrow-bounds)
1145 (nth 2 ediff-narrow-bounds)))
1147 (list (nth 1 ediff-narrow-bounds)
1148 (nth 0 ediff-narrow-bounds)))))
1149 (if wide-visibility-p
1150 (setq ediff-visible-bounds ediff-wide-bounds)
1151 (setq ediff-visible-bounds ediff-narrow-bounds))
1154 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1155 (ediff-recenter 'no-rehighlight)
1159 (defun ediff-toggle-wide-display ()
1160 "Toggle wide/regular display.
1161 This is especially useful when comparing buffers side-by-side."
1163 (ediff-barf-if-not-control-buffer)
1164 (or (ediff-window-display-p)
1165 (error "%sEmacs is not running as a window application"
1166 (if ediff-emacs-p "" "X")))
1167 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1168 (let ((ctl-buf ediff-control-buffer))
1169 (setq ediff-wide-display-p (not ediff-wide-display-p))
1170 (if (not ediff-wide-display-p)
1171 (ediff-eval-in-buffer ctl-buf
1172 (modify-frame-parameters
1173 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1174 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1175 ;; restore control buf, since ctl window may have been deleted
1177 (set-buffer ctl-buf)
1178 (setq ediff-wide-display-orig-parameters nil
1179 ediff-window-B nil) ; force update of window config
1180 (ediff-recenter 'no-rehighlight))
1181 (funcall ediff-make-wide-display-function)
1182 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1183 (ediff-eval-in-buffer ctl-buf
1184 (setq ediff-window-B nil) ; force update of window config
1185 (ediff-recenter 'no-rehighlight)))))
1187 (defun ediff-toggle-multiframe ()
1188 "Switch from the multiframe display to single-frame display and back.
1189 This is primarily for debugging, but one can use it for fun, too."
1191 (ediff-barf-if-not-control-buffer)
1192 (or (ediff-window-display-p)
1193 (error "%sEmacs is not running as a window application"
1194 (if ediff-emacs-p "" "X")))
1195 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1196 (setq ediff-window-setup-function 'ediff-setup-windows-plain))
1197 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1198 (setq ediff-window-setup-function 'ediff-setup-windows-multiframe)))
1199 (setq ediff-window-B nil)
1200 (ediff-recenter 'no-rehighlight))
1204 (defun ediff-toggle-show-clashes-only ()
1205 "Toggle the mode where only the regions where both buffers differ with the ancestor are shown."
1207 (ediff-barf-if-not-control-buffer)
1208 (if (not ediff-merge-with-ancestor-job)
1209 (error "This command makes sense only when merging with an ancestor"))
1210 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1211 (if ediff-show-clashes-only
1212 (message "Focus on regions where both buffers differ from the ancestor")
1213 (message "Canceling focus on regions where changes clash")))
1215 ;; Widening/narrowing
1217 (defun ediff-toggle-narrow-region ()
1218 "Toggle narrowing in buffers A, B, and C.
1219 Used in ediff-windows/regions only."
1221 (if (eq ediff-buffer-A ediff-buffer-B)
1223 "Buffers A and B are the same. Can't narrow to two different regions"))
1224 (if (eq ediff-visible-bounds ediff-wide-bounds)
1225 (setq ediff-visible-bounds ediff-narrow-bounds)
1226 (setq ediff-visible-bounds ediff-wide-bounds))
1227 (ediff-recenter 'no-rehighlight))
1229 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1230 ;; ediff-wide-bounds, then this actually widens.
1231 ;; This function does nothing if job-name is not
1232 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1233 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1234 ;; to two different regions in one buffer.
1235 (defun ediff-visible-region ()
1236 (if (or (eq ediff-buffer-A ediff-buffer-B)
1237 (eq ediff-buffer-A ediff-buffer-C)
1238 (eq ediff-buffer-C ediff-buffer-B))
1240 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1241 ;; Otherwise, always use full range.
1242 (if (not ediff-narrow-job)
1243 (setq ediff-visible-bounds ediff-wide-bounds))
1244 (let ((overl-A (ediff-get-value-according-to-buffer-type
1245 'A ediff-visible-bounds))
1246 (overl-B (ediff-get-value-according-to-buffer-type
1247 'B ediff-visible-bounds))
1248 (overl-C (ediff-get-value-according-to-buffer-type
1249 'C ediff-visible-bounds))
1251 (ediff-eval-in-buffer ediff-buffer-A
1253 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A)))
1254 (ediff-eval-in-buffer ediff-buffer-B
1256 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B)))
1259 (ediff-eval-in-buffer ediff-buffer-C
1261 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1265 ;; Window scrolling operations
1267 ;; Performs some operation on the two file windows (if they are showing).
1268 ;; Traps all errors on the operation in windows A/B/C.
1269 ;; Usually, errors come from scrolling off the
1270 ;; beginning or end of the buffer, and this gives error messages.
1271 (defun ediff-operate-on-windows (operation arg)
1273 ;; make sure windows aren't dead
1274 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1275 (ediff-recenter 'no-rehighlight))
1276 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1277 (ediff-buffer-live-p ediff-buffer-B)
1278 (or (not ediff-3way-job) ediff-buffer-C)
1280 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1282 (let* ((wind (selected-window))
1283 (wind-A ediff-window-A)
1284 (wind-B ediff-window-B)
1285 (wind-C ediff-window-C)
1286 (coefA (ediff-get-region-size-coefficient 'A operation))
1287 (coefB (ediff-get-region-size-coefficient 'B operation))
1288 (three-way ediff-3way-job)
1289 (coefC (if three-way
1290 (ediff-get-region-size-coefficient 'C operation))))
1292 (select-window wind-A)
1294 (funcall operation (round (* coefA arg)))
1296 (select-window wind-B)
1298 (funcall operation (round (* coefB arg)))
1302 (select-window wind-C)
1304 (funcall operation (round (* coefC arg)))
1306 (select-window wind)))
1308 (defun ediff-scroll-vertically (&optional arg)
1309 "Vertically scroll buffers A, B \(and C if appropriate\).
1310 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1311 the height of window-A."
1313 (ediff-barf-if-not-control-buffer)
1315 ;; make sure windows aren't dead
1316 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1317 (ediff-recenter 'no-rehighlight))
1318 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1319 (ediff-buffer-live-p ediff-buffer-B)
1320 (or (not ediff-3way-job)
1321 (ediff-buffer-live-p ediff-buffer-C))
1323 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1325 (ediff-operate-on-windows
1326 (if (memq last-command-char '(?v ?\C-v))
1329 ;; calculate argument to scroll-up/down
1330 ;; if there is an explicit argument
1331 (if (and arg (not (equal arg '-)))
1333 (prefix-numeric-value arg)
1334 ;; if not, see if we can determine a default amount (the window height)
1335 (let (default-amount)
1336 (setq default-amount
1337 (- (/ (min (window-height ediff-window-A)
1338 (window-height ediff-window-B)
1340 (window-height ediff-window-C)
1341 500)) ; some large number
1343 1 next-screen-context-lines))
1346 ;; C-u as argument means half of default amount
1347 (/ default-amount 2)
1348 ;; no argument means default amount
1352 (defun ediff-scroll-horizontally (&optional arg)
1353 "Horizontally scroll buffers A, B \(and C if appropriate\).
1354 If an argument is given, that is how many columns are scrolled, else nearly
1355 the width of the A/B/C windows."
1357 (ediff-barf-if-not-control-buffer)
1359 ;; make sure windows aren't dead
1360 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1361 (ediff-recenter 'no-rehighlight))
1362 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1363 (ediff-buffer-live-p ediff-buffer-B)
1364 (or (not ediff-3way-job)
1365 (ediff-buffer-live-p ediff-buffer-C))
1367 (error "You've killed an essential Ediff buffer---Please quit Ediff"))
1369 (ediff-operate-on-windows
1370 (if (= last-command-char ?<)
1373 ;; calculate argument to scroll-left/right
1374 ;; if there is an explicit argument
1375 (if (and arg (not (equal arg '-)))
1377 (prefix-numeric-value arg)
1378 ;; if not, see if we can determine a default amount
1379 ;; (half the window width)
1380 (if (null ediff-control-window)
1381 ;; no control window, use nil
1383 (let ((default-amount
1384 (- (/ (min (window-width ediff-window-A)
1385 (window-width ediff-window-B)
1386 (if ediff-3way-comparison-job
1387 (window-width ediff-window-C)
1388 500) ; some large number
1394 ;; C-u as argument means half of default amount
1395 (/ default-amount 2)
1396 ;; no argument means default amount
1397 default-amount))))))
1400 ;;BEG, END show the region to be positioned.
1401 ;;JOB-NAME holds ediff-job-name. Ediff-windows job positions regions
1403 (defun ediff-position-region (beg end pos job-name)
1404 (if (> end (point-max))
1405 (setq end (point-max)))
1406 (if ediff-windows-job
1407 (if (pos-visible-in-window-p end)
1408 () ; do nothing, wind is already positioned
1409 ;; at this point, windows are positioned at the beginning of the
1410 ;; file regions (not diff-regions) being compared.
1412 (move-to-window-line (- (window-height) 2))
1413 (let ((amount (+ 2 (count-lines (point) end))))
1414 (scroll-up amount))))
1415 (set-window-start (selected-window) beg)
1416 (if (pos-visible-in-window-p end)
1417 ;; Determine the number of lines that the region occupies
1420 (while ( and (> end (progn
1421 (move-to-window-line lines)
1423 ;; `end' may be beyond the window bottom, so check
1424 ;; that we are making progress
1425 (< prev-point (point)))
1426 (setq prev-point (point))
1427 (setq lines (1+ lines)))
1428 ;; And position the beginning on the right line
1430 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1438 ;; get number of lines from window start to region end
1439 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1440 (or n (setq n ediff-current-difference))
1441 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1442 (ediff-eval-in-buffer ctl-buf
1443 (let* ((buf (ediff-get-buffer buf-type))
1444 (wind (eval (intern (format "ediff-window-%S" buf-type))))
1445 (beg (window-start wind))
1446 (end (ediff-get-diff-posn buf-type 'end))
1448 (ediff-eval-in-buffer buf
1450 (setq lines (count-lines beg end))
1455 ;; get number of lines from window end to region start
1456 (defun ediff-get-lines-to-region-start (buf-type &optional n ctl-buf)
1457 (or n (setq n ediff-current-difference))
1458 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1459 (ediff-eval-in-buffer ctl-buf
1460 (let* ((buf (ediff-get-buffer buf-type))
1461 (wind (eval (intern (format "ediff-window-%S" buf-type))))
1462 (end (window-end wind))
1463 (beg (ediff-get-diff-posn buf-type 'beg)))
1464 (ediff-eval-in-buffer buf
1465 (if (< beg end) (count-lines beg end) 0))
1469 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1470 (ediff-eval-in-buffer (or ctl-buf ediff-control-buffer)
1471 (let* ((func (cond ((eq op 'scroll-down) 'ediff-get-lines-to-region-start)
1472 ((eq op 'scroll-up) 'ediff-get-lines-to-region-end)
1473 (t '(lambda (a b c) 0))))
1474 (max-lines (max (funcall func 'A n ctl-buf)
1475 (funcall func 'B n ctl-buf)
1476 (if (ediff-buffer-live-p ediff-buffer-C)
1477 (funcall func 'C n ctl-buf)
1479 ;; this covers the horizontal coefficient as well:
1480 ;; if max-lines = 0 then coef = 1
1482 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1488 (defun ediff-next-difference (&optional arg)
1489 "Advance to the next difference.
1490 With a prefix argument, go back that many differences."
1492 (ediff-barf-if-not-control-buffer)
1493 (if (< ediff-current-difference ediff-number-of-differences)
1494 (let ((n (min ediff-number-of-differences
1495 (+ ediff-current-difference (if arg arg 1))))
1498 (or (>= n ediff-number-of-differences)
1499 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1500 (ediff-install-fine-diff-if-necessary n))
1501 (while (and (< n ediff-number-of-differences)
1505 ;; skip clashes, if necessary
1506 (and ediff-show-clashes-only
1507 (string-match "prefer"
1508 (or (ediff-get-state-of-merge n) "")))
1509 ;; skip difference regions that differ in white space
1510 (and ediff-ignore-similar-regions
1511 (ediff-no-fine-diffs-p n))))
1513 (if (= 0 (mod n 20))
1514 (message "Skipped over region %d and counting ..." n))
1515 (or (>= n ediff-number-of-differences)
1516 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1517 (ediff-install-fine-diff-if-necessary n))
1520 (ediff-unselect-and-select-difference n)
1522 (ediff-visible-region)
1523 (error "At end of the difference list")))
1525 (defun ediff-previous-difference (&optional arg)
1526 "Go to the previous difference.
1527 With a prefix argument, go back that many differences."
1529 (ediff-barf-if-not-control-buffer)
1530 (if (> ediff-current-difference -1)
1531 (let ((n (max -1 (- ediff-current-difference (if arg arg 1))))
1535 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1536 (ediff-install-fine-diff-if-necessary n))
1537 (while (and (> n -1)
1541 ;; skip clashes, if necessary
1542 (and ediff-show-clashes-only
1543 (string-match "prefer"
1544 (or (ediff-get-state-of-merge n) "")))
1545 ;; skip difference regions that differ in white space
1546 (and ediff-ignore-similar-regions
1547 (ediff-no-fine-diffs-p n))))
1548 (if (= 0 (mod (1+ n) 20))
1549 (message "Skipped over region %d and counting ..." (1+ n)))
1552 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1553 (ediff-install-fine-diff-if-necessary n))
1556 (ediff-unselect-and-select-difference n)
1558 (ediff-visible-region)
1559 (error "At beginning of the difference list")))
1561 (defun ediff-jump-to-difference (difference-number)
1562 "Go to the difference specified as a prefix argument."
1564 (ediff-barf-if-not-control-buffer)
1565 (setq difference-number (1- difference-number))
1566 (if (and (>= difference-number -1)
1567 (< difference-number (1+ ediff-number-of-differences)))
1568 (ediff-unselect-and-select-difference difference-number)
1569 (error "Bad difference number, %d" difference-number)))
1571 (defun ediff-jump-to-difference-at-point ()
1572 "Go to difference closest to the point in buffer A, B, or C.
1573 The type of buffer depends on last command character \(a, b, or c\) that
1574 invoked this command."
1576 (ediff-barf-if-not-control-buffer)
1577 (let ((buf-type (ediff-char-to-buftype last-command-char)))
1578 (ediff-jump-to-difference (ediff-diff-at-point buf-type))))
1581 ;; find region most related to the current point position (or POS, if given)
1582 (defun ediff-diff-at-point (buf-type &optional pos)
1583 (let ((buffer (ediff-get-buffer buf-type))
1584 (ctl-buffer ediff-control-buffer)
1585 (max-dif-num (1- ediff-number-of-differences))
1592 (ediff-eval-in-buffer buffer
1593 (setq pos (or pos (point)))
1594 (while (and (or (< pos prev-beg) (> pos beg))
1595 (< diff-no max-dif-num))
1596 (setq diff-no (1+ diff-no))
1599 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1600 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1603 (if (< (abs (- pos prev-end))
1606 (1+ diff-no)) ; jump-to-diff works with diff nums higher by 1
1612 (defun ediff-diff-to-diff (arg &optional keys)
1613 "Copy buffer-X'th diff to buffer Y \(X,Y are A, B, or C\).
1614 If numerical prefix argument, copy this diff specified in the arg.
1615 Otherwise, copy the difference given by `ediff-current-difference'.
1616 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1617 `ac', etc., which is used to determine the types of buffers to be used for
1618 copying difference regions. The first character in the sequence specifies
1619 the source buffer and the second specifies the target.
1621 If the second optional argument, a 2-character string, is given, use it to
1622 determine the source and the target buffers instead of the command keys."
1624 (ediff-barf-if-not-control-buffer)
1625 (or keys (setq keys (this-command-keys)))
1627 (ediff-jump-to-difference arg))
1628 (let* ((key1 (aref keys 0))
1629 (key2 (aref keys 1))
1630 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1631 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2))
1633 (ediff-copy-diff ediff-current-difference
1634 (ediff-char-to-buftype char1)
1635 (ediff-char-to-buftype char2))
1636 ;; recenter with rehighlighting, but no messages
1640 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1641 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1642 ;; target diff. This is used in merging, when constructing the merged
1644 (defun ediff-copy-diff (n from-buf-type to-buf-type
1645 &optional batch-invocation reg-to-copy)
1646 (let* ((to-buf (ediff-get-buffer to-buf-type))
1647 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1648 (ctrl-buf ediff-control-buffer)
1650 (three-way ediff-3way-job)
1653 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1655 (setq reg-to-delete-beg
1656 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1657 (setq reg-to-delete-end
1658 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1661 (setq from-buf-type nil)
1662 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1664 (setq reg-to-delete (ediff-get-region-contents
1665 n to-buf-type ctrl-buf
1666 reg-to-delete-beg reg-to-delete-end))
1668 (setq ediff-disturbed-overlays nil) ; clear before use
1670 (if (string= reg-to-delete reg-to-copy)
1671 (setq saved-p nil) ; refuse to copy identical buffers
1673 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1674 (condition-case conds
1676 (ediff-eval-in-buffer to-buf
1677 ;; to prevent flags from interfering if buffer is writable
1678 (let ((inhibit-read-only (null buffer-read-only)))
1679 ;; these two insert a dummy char to overcome a bug in
1680 ;; XEmacs, which sometimes prevents 0-length extents
1681 ;; from sensing insertion at its end-points.
1682 ;; (need to check if 19.12 still has the bug)
1685 (goto-char reg-to-delete-end)
1686 (insert-before-markers "@")))
1688 (goto-char reg-to-delete-end)
1689 (insert-before-markers reg-to-copy)
1691 ;; delete the dummy char "@"
1696 (if (> reg-to-delete-end reg-to-delete-beg)
1697 (kill-region reg-to-delete-beg
1699 (if (> reg-to-delete-end reg-to-delete-beg)
1700 (kill-region reg-to-delete-beg reg-to-delete-end)
1701 (ediff-move-disturbed-overlays reg-to-delete-beg)
1704 (or batch-invocation
1707 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1708 (error (message "ediff-copy-diff: %s %s"
1710 (mapconcat 'prin1-to-string (cdr conds) " "))
1712 (sit-for 2) ; let the user see the error msg
1717 ;; adjust state of difference in case 3-way and diff was copied ok
1718 (if (and saved-p three-way)
1719 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
1721 (if batch-invocation
1722 (ediff-clear-fine-differences n)
1723 ;; If diff3 job, we should recompute fine diffs so we clear them
1724 ;; before reinserting flags (and thus before ediff-recenter).
1725 (if (and saved-p three-way)
1726 (ediff-clear-fine-differences n))
1728 (ediff-refresh-mode-lines)
1730 ;; For diff2 jobs, don't recompute fine diffs, since we know there
1731 ;; aren't any. So we clear diffs after ediff-recenter.
1732 (if (and saved-p (not three-way))
1733 (ediff-clear-fine-differences n))
1734 ;; Make sure that the message about saving and how to restore is seen
1739 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
1740 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
1741 ;; is the region to save. It is redundant here, but is passed anyway, for
1743 (defun ediff-save-diff-region (n buf-type reg)
1744 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1745 (buf (ediff-get-buffer buf-type))
1746 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1748 (if this-buf-n-th-diff-saved
1749 ;; either nothing saved for n-th diff and buffer or we OK'ed
1751 (setcdr this-buf-n-th-diff-saved reg)
1752 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
1753 (nconc n-th-diff-saved (list (cons buf reg)))
1754 (setq ediff-killed-diffs-alist ;; create record for n-th diff
1755 (cons (list n (cons buf reg))
1756 ediff-killed-diffs-alist))))
1757 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
1760 "" (downcase (symbol-name buf-type))))
1763 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
1764 (defun ediff-test-save-region (n buf-type)
1765 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1766 (buf (ediff-get-buffer buf-type))
1767 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1769 (if this-buf-n-th-diff-saved
1772 "You've previously copied diff region %d to buffer %S. Confirm "
1778 (defun ediff-pop-diff (n buf-type)
1779 "Pop last killed Nth diff region from buffer BUF-TYPE."
1780 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
1781 (buf (ediff-get-buffer buf-type))
1782 (saved-rec (assoc buf (cdr n-th-record)))
1783 (three-way ediff-3way-job)
1784 (ctl-buf ediff-control-buffer)
1786 saved-diff reg-beg reg-end recovered)
1789 (setq saved-diff (cdr saved-rec))
1790 (if (> ediff-number-of-differences 0)
1791 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
1792 (error "No differences found")))
1794 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
1795 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
1796 (setq ediff-disturbed-overlays nil) ; clear before use
1798 (condition-case conds
1799 (ediff-eval-in-buffer buf
1800 (let ((inhibit-read-only (null buffer-read-only)))
1801 ;; these two insert a dummy char to overcome a bug in XEmacs,
1802 ;; which sometimes prevents 0-length extents from sensing
1803 ;; insertion at its end-points.
1804 ;; (need to check if 19.12 still has the bug)
1808 (insert-before-markers "@")))
1811 (insert-before-markers saved-diff)
1813 ;; delete dummy char
1818 (if (> reg-end reg-beg)
1819 (kill-region reg-beg reg-end))
1820 (if (> reg-end reg-beg)
1821 (kill-region reg-beg reg-end)
1822 (ediff-move-disturbed-overlays reg-beg)
1827 (error (message "ediff-pop-diff: %s %s"
1829 (mapconcat 'prin1-to-string (cdr conds) " "))
1832 ;; Clearing fine diffs is necessary for
1833 ;; ediff-unselect-and-select-difference to properly recompute them. We
1834 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
1835 ;; have modified diff regions after copying and, thus, may have recomputed
1838 (ediff-clear-fine-differences n))
1840 ;; adjust state of difference
1841 (if (and three-way recovered)
1842 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
1844 (ediff-refresh-mode-lines)
1848 (setq n-th-record (delq saved-rec n-th-record))
1849 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
1853 (defun ediff-restore-diff (arg &optional key)
1854 "Restore ARGth diff from `ediff-killed-diffs-alist'.
1855 ARG is a prefix argument. If ARG is nil, restore current-difference.
1857 If the second optional argument, a character, is given, use it to
1858 determine the target buffer instead of last-command-char"
1860 (ediff-barf-if-not-control-buffer)
1862 (ediff-jump-to-difference arg))
1863 (ediff-pop-diff ediff-current-difference
1864 (ediff-char-to-buftype (or key last-command-char)))
1865 ;; recenter with rehighlighting, but no messages
1866 (let (ediff-verbose-p)
1869 (defun ediff-toggle-regexp-match ()
1870 "Toggle between focusing and hiding of difference regions that match
1871 a regular expression typed in by the user."
1873 (ediff-barf-if-not-control-buffer)
1877 msg-connective alt-msg-connective alt-connective)
1879 ((or (and (eq ediff-skip-diff-region-function
1880 'ediff-focus-on-regexp-matches-function)
1881 (eq last-command-char ?f))
1882 (and (eq ediff-skip-diff-region-function
1883 ediff-hide-regexp-matches-function)
1884 (eq last-command-char ?h)))
1885 (message "Selective browsing by regexp turned off")
1886 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
1887 ((eq last-command-char ?h)
1888 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
1892 "Ignore A-regions matching this regexp (default \"%s\"): "
1893 ediff-regexp-hide-A))
1897 "Ignore B-regions matching this regexp (default \"%s\"): "
1898 ediff-regexp-hide-B)))
1899 (if ediff-3way-comparison-job
1903 "Ignore C-regions matching this regexp (default \"%s\"): "
1904 ediff-regexp-hide-C))))
1905 (if (eq ediff-hide-regexp-connective 'and)
1906 (setq msg-connective "BOTH"
1907 alt-msg-connective "ONE OF"
1909 (setq msg-connective "ONE OF"
1910 alt-msg-connective "BOTH"
1911 alt-connective 'and))
1914 "Ignore regions that match %s regexps, OK? "
1915 msg-connective alt-msg-connective))
1916 (message "Will ignore regions that match %s regexps" msg-connective)
1917 (setq ediff-hide-regexp-connective alt-connective)
1918 (message "Will ignore regions that match %s regexps"
1919 alt-msg-connective))
1921 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
1922 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
1923 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
1925 ((eq last-command-char ?f)
1926 (setq ediff-skip-diff-region-function
1927 ediff-focus-on-regexp-matches-function
1931 "Focus on A-regions matching this regexp (default \"%s\"): "
1932 ediff-regexp-focus-A))
1936 "Focus on B-regions matching this regexp (default \"%s\"): "
1937 ediff-regexp-focus-B)))
1938 (if ediff-3way-comparison-job
1942 "Focus on C-regions matching this regexp (default \"%s\"): "
1943 ediff-regexp-focus-C))))
1944 (if (eq ediff-focus-regexp-connective 'and)
1945 (setq msg-connective "BOTH"
1946 alt-msg-connective "ONE OF"
1948 (setq msg-connective "ONE OF"
1949 alt-msg-connective "BOTH"
1950 alt-connective 'and))
1953 "Focus on regions that match %s regexps, OK? "
1954 msg-connective alt-msg-connective))
1955 (message "Will focus on regions that match %s regexps"
1957 (setq ediff-focus-regexp-connective alt-connective)
1958 (message "Will focus on regions that match %s regexps"
1959 alt-msg-connective))
1961 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
1962 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
1963 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
1965 (defun ediff-toggle-skip-similar ()
1967 (ediff-barf-if-not-control-buffer)
1968 (if (not (eq ediff-auto-refine 'on))
1970 "Can't skip over whitespace regions: first turn auto-refining on"))
1971 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
1972 (if ediff-ignore-similar-regions
1974 "Skipping regions that differ only in white space & line breaks")
1975 (message "Skipping over white-space differences turned off")))
1977 (defun ediff-focus-on-regexp-matches (n)
1978 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
1979 Regions to be ignored according to this function are those where
1980 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
1981 doesn't match `ediff-regexp-focus-B'.
1982 This function returns nil if the region number N (specified as
1983 an argument) is not to be ignored and t if region N is to be ignored.
1985 N is a region number used by Ediff internally. It is 1 less
1986 the number seen by the user."
1987 (if (ediff-valid-difference-p n)
1988 (let* ((ctl-buf ediff-control-buffer)
1989 (regex-A ediff-regexp-focus-A)
1990 (regex-B ediff-regexp-focus-B)
1991 (regex-C ediff-regexp-focus-C)
1992 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
1993 (goto-char (ediff-get-diff-posn 'A 'beg n ctl-buf))
1996 (ediff-get-diff-posn 'A 'end n ctl-buf)
1998 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
1999 (goto-char (ediff-get-diff-posn 'B 'beg n ctl-buf))
2002 (ediff-get-diff-posn 'B 'end n ctl-buf)
2004 (reg-C-match (if ediff-3way-comparison-job
2005 (ediff-eval-in-buffer ediff-buffer-C
2007 (ediff-get-diff-posn 'C 'beg n ctl-buf))
2010 (ediff-get-diff-posn 'C 'end n ctl-buf)
2012 (not (eval (if ediff-3way-comparison-job
2013 (list ediff-focus-regexp-connective
2014 reg-A-match reg-B-match reg-C-match)
2015 (list ediff-focus-regexp-connective
2016 reg-A-match reg-B-match))))
2019 (defun ediff-hide-regexp-matches (n)
2020 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2021 Regions to be ignored are those where buf A region matches
2022 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2023 This function returns nil if the region number N (specified as
2024 an argument) is not to be ignored and t if region N is to be ignored.
2026 N is a region number used by Ediff internally. It is 1 less
2027 the number seen by the user."
2028 (if (ediff-valid-difference-p n)
2029 (let* ((ctl-buf ediff-control-buffer)
2030 (regex-A ediff-regexp-hide-A)
2031 (regex-B ediff-regexp-hide-B)
2032 (regex-C ediff-regexp-hide-C)
2033 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
2034 (goto-char (ediff-get-diff-posn 'A 'beg n ctl-buf))
2037 (ediff-get-diff-posn 'A 'end n ctl-buf)
2039 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
2040 (goto-char (ediff-get-diff-posn 'B 'beg n ctl-buf))
2043 (ediff-get-diff-posn 'B 'end n ctl-buf)
2045 (reg-C-match (if ediff-3way-comparison-job
2046 (ediff-eval-in-buffer ediff-buffer-C
2048 (ediff-get-diff-posn 'C 'beg n ctl-buf))
2051 (ediff-get-diff-posn 'C 'end n ctl-buf)
2053 (eval (if ediff-3way-comparison-job
2054 (list ediff-hide-regexp-connective
2055 reg-A-match reg-B-match reg-C-match)
2056 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2061 ;;; Quitting, suspending, etc.
2063 (defun ediff-quit (reverse-default-keep-variants)
2064 "Finish an Ediff session and exit Ediff.
2065 Unselects the selected difference, if any, restores the read-only and modified
2066 flags of the compared file buffers, kills Ediff buffers for this session
2067 \(but not buffers A, B, C\).
2069 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2070 containing the variants should be removed \(if they haven't been modified\).
2071 If it is t, they will be preserved unconditionally. A prefix argument,
2072 temporarily reverses the meaning of this variable."
2074 (ediff-barf-if-not-control-buffer)
2077 (format "Quit this Ediff session%s? "
2078 (if (ediff-buffer-live-p ediff-meta-buffer)
2079 " & show containing session group" "")))
2081 (ediff-really-quit reverse-default-keep-variants)))
2084 ;; Perform the quit operations.
2085 (defun ediff-really-quit (reverse-default-keep-variants)
2086 (ediff-unhighlight-diffs-totally)
2087 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2088 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2089 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2090 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2092 (ediff-delete-temp-files)
2094 ;; Restore visibility range. This affects only ediff-*-regions/windows.
2095 ;; Since for other job names ediff-visible-region sets
2096 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2097 ;; ignored for such jobs.
2098 (if ediff-quit-widened
2099 (setq ediff-visible-bounds ediff-wide-bounds)
2100 (setq ediff-visible-bounds ediff-narrow-bounds))
2102 ;; Apply selective display to narrow or widen
2103 (ediff-visible-region)
2104 (mapcar (function (lambda (overl)
2105 (if (ediff-overlayp overl)
2106 (ediff-delete-overlay overl))))
2108 (mapcar (function (lambda (overl)
2109 (if (ediff-overlayp overl)
2110 (ediff-delete-overlay overl))))
2111 ediff-narrow-bounds)
2113 ;; restore buffer mode line id's in buffer-A/B/C
2114 (let ((control-buffer ediff-control-buffer)
2115 (meta-buffer ediff-meta-buffer))
2117 (ediff-eval-in-buffer ediff-buffer-A
2118 (setq ediff-this-buffer-ediff-sessions
2119 (delq control-buffer ediff-this-buffer-ediff-sessions))
2120 (kill-local-variable 'mode-line-buffer-identification)
2121 (kill-local-variable 'mode-line-format)
2126 (ediff-eval-in-buffer ediff-buffer-B
2127 (setq ediff-this-buffer-ediff-sessions
2128 (delq control-buffer ediff-this-buffer-ediff-sessions))
2129 (kill-local-variable 'mode-line-buffer-identification)
2130 (kill-local-variable 'mode-line-format)
2135 (ediff-eval-in-buffer ediff-buffer-C
2136 (setq ediff-this-buffer-ediff-sessions
2137 (delq control-buffer ediff-this-buffer-ediff-sessions))
2138 (kill-local-variable 'mode-line-buffer-identification)
2139 (kill-local-variable 'mode-line-format)
2144 (ediff-eval-in-buffer ediff-ancestor-buffer
2145 (setq ediff-this-buffer-ediff-sessions
2146 (delq control-buffer ediff-this-buffer-ediff-sessions))
2147 (kill-local-variable 'mode-line-buffer-identification)
2148 (kill-local-variable 'mode-line-format)
2152 (setq ediff-session-registry
2153 (delq ediff-control-buffer ediff-session-registry))
2154 (ediff-update-registry)
2155 ;; restore state of buffers to what it was before ediff
2156 (ediff-restore-protected-variables)
2157 ;; good place to kill buffers A/B/C
2158 (run-hooks 'ediff-cleanup-hook)
2159 (let ((ediff-keep-variants ediff-keep-variants))
2160 (if reverse-default-keep-variants
2161 (setq ediff-keep-variants (not ediff-keep-variants)))
2162 (or ediff-keep-variants (ediff-janitor 'ask)))
2164 (run-hooks 'ediff-quit-hook)
2165 (ediff-cleanup-meta-buffer meta-buffer)
2166 (if (ediff-buffer-live-p meta-buffer)
2167 (ediff-show-meta-buffer meta-buffer))
2171 (defun ediff-delete-temp-files ()
2172 (if (stringp ediff-temp-file-A)
2173 (delete-file ediff-temp-file-A))
2174 (if (stringp ediff-temp-file-B)
2175 (delete-file ediff-temp-file-B))
2176 (if (stringp ediff-temp-file-C)
2177 (delete-file ediff-temp-file-C)))
2180 ;; Kill control buffer, other auxiliary Ediff buffers.
2181 ;; Leave one of the frames split between buffers A/B/C
2182 (defun ediff-cleanup-mess ()
2183 (let ((buff-A ediff-buffer-A)
2184 (buff-B ediff-buffer-B)
2185 (buff-C ediff-buffer-C)
2186 (ctl-buf ediff-control-buffer)
2187 (ctl-frame ediff-control-frame)
2188 (three-way-job ediff-3way-job))
2190 (ediff-kill-buffer-carefully ediff-diff-buffer)
2191 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2192 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2193 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2194 (ediff-kill-buffer-carefully ediff-error-buffer)
2195 (ediff-kill-buffer-carefully ediff-patch-diagnostics)
2196 (ediff-kill-buffer-carefully ediff-msg-buffer)
2197 (ediff-kill-buffer-carefully ediff-debug-buffer)
2200 (if (and (ediff-window-display-p) (frame-live-p ctl-frame))
2201 (delete-frame ctl-frame))
2202 (ediff-kill-buffer-carefully ctl-buf)
2204 (delete-other-windows)
2206 ;; display only if not visible
2208 (or (ediff-get-visible-buffer-window buff-B)
2209 (switch-to-buffer buff-B))
2212 (or (ediff-get-visible-buffer-window buff-A)
2214 (if (ediff-get-visible-buffer-window buff-B)
2215 (split-window-vertically))
2216 (switch-to-buffer buff-A)))
2220 (or (ediff-get-visible-buffer-window buff-C)
2222 (if (or (ediff-get-visible-buffer-window buff-A)
2223 (ediff-get-visible-buffer-window buff-B))
2224 (split-window-vertically))
2225 (switch-to-buffer buff-C)
2231 (defun ediff-janitor (&optional ask)
2232 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2233 In merge jobs, buffer C is never deleted.
2234 However, the side effect of cleaning up may be that you cannot compare the same
2235 buffer in two separate Ediff sessions: quitting one of them will delete this
2236 buffer in another session as well."
2237 (or (not (ediff-buffer-live-p ediff-buffer-A))
2238 (buffer-modified-p ediff-buffer-A)
2240 (not (y-or-n-p (format "Kill buffer A [%s]? "
2241 (buffer-name ediff-buffer-A)))))
2242 (ediff-kill-buffer-carefully ediff-buffer-A))
2243 (or (not (ediff-buffer-live-p ediff-buffer-B))
2244 (buffer-modified-p ediff-buffer-B)
2246 (not (y-or-n-p (format "Kill buffer B [%s]? "
2247 (buffer-name ediff-buffer-B)))))
2248 (ediff-kill-buffer-carefully ediff-buffer-B))
2249 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2250 (or (not (ediff-buffer-live-p ediff-ancestor-buffer))
2251 (buffer-modified-p ediff-ancestor-buffer)
2253 (not (y-or-n-p (format "Kill the ancestor buffer [%s]? "
2254 (buffer-name ediff-ancestor-buffer)))))
2255 (ediff-kill-buffer-carefully ediff-ancestor-buffer))
2256 (or (not (ediff-buffer-live-p ediff-buffer-C))
2257 (buffer-modified-p ediff-buffer-C)
2258 (and ask (not (y-or-n-p (format "Kill buffer C [%s]? "
2259 (buffer-name ediff-buffer-C)))))
2260 (ediff-kill-buffer-carefully ediff-buffer-C))))
2262 ;; The default way of suspending Ediff.
2263 ;; Buries Ediff buffers, kills all windows.
2264 (defun ediff-default-suspend-function ()
2265 (let* ((buf-A ediff-buffer-A)
2266 (buf-B ediff-buffer-B)
2267 (buf-C ediff-buffer-C)
2268 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2269 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2270 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2271 (buf-patch ediff-patch-buf)
2272 (buf-patch-diag ediff-patch-diagnostics)
2273 (buf-err ediff-error-buffer)
2274 (buf-diff ediff-diff-buffer)
2275 (buf-custom-diff ediff-custom-diff-buffer)
2276 (buf-fine-diff ediff-fine-diff-buffer))
2278 ;; hide the control panel
2279 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2280 (iconify-frame ediff-control-frame)
2282 (if buf-err (bury-buffer buf-err))
2283 (if buf-diff (bury-buffer buf-diff))
2284 (if buf-custom-diff (bury-buffer buf-custom-diff))
2285 (if buf-fine-diff (bury-buffer buf-fine-diff))
2286 (if buf-patch (bury-buffer buf-patch))
2287 (if buf-patch-diag (bury-buffer buf-patch-diag))
2288 (if (window-live-p buf-A-wind)
2290 (select-window buf-A-wind)
2291 (delete-other-windows)
2293 (if (ediff-buffer-live-p buf-A) (bury-buffer buf-A)))
2294 (if (window-live-p buf-B-wind)
2296 (select-window buf-B-wind)
2297 (delete-other-windows)
2299 (if (ediff-buffer-live-p buf-B) (bury-buffer buf-B)))
2300 (if (window-live-p buf-C-wind)
2302 (select-window buf-C-wind)
2303 (delete-other-windows)
2305 (if (ediff-buffer-live-p buf-C) (bury-buffer buf-C)))
2310 (defun ediff-suspend ()
2312 To resume, switch to the appropriate `Ediff Control Panel'
2313 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2314 up an appropriate window config."
2316 (ediff-barf-if-not-control-buffer)
2317 (run-hooks 'ediff-suspend-hook)
2319 "To resume, type M-x eregistry and select the desired Ediff session"))
2322 (defun ediff-status-info ()
2323 "Show the names of the buffers or files being operated on by Ediff.
2324 Hit \\[ediff-recenter] to reset the windows afterward."
2326 (ediff-barf-if-not-control-buffer)
2328 (ediff-skip-unsuitable-frames))
2329 (with-output-to-temp-buffer " *ediff-info*"
2330 (princ (ediff-version))
2332 (ediff-eval-in-buffer ediff-buffer-A
2333 (if buffer-file-name
2335 (format "File A = %S\n" buffer-file-name))
2337 (format "Buffer A = %S\n" (buffer-name)))))
2338 (ediff-eval-in-buffer ediff-buffer-B
2339 (if buffer-file-name
2341 (format "File B = %S\n" buffer-file-name))
2343 (format "Buffer B = %S\n" (buffer-name)))))
2345 (ediff-eval-in-buffer ediff-buffer-C
2346 (if buffer-file-name
2348 (format "File C = %S\n" buffer-file-name))
2350 (format "Buffer C = %S\n" (buffer-name))))))
2351 (princ (format "Customized diff output %s\n"
2352 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2353 (concat "\tin buffer "
2354 (buffer-name ediff-custom-diff-buffer))
2355 "is not available")))
2356 (princ (format "Plain diff output %s\n"
2357 (if (ediff-buffer-live-p ediff-diff-buffer)
2358 (concat "\tin buffer "
2359 (buffer-name ediff-diff-buffer))
2360 "is not available")))
2362 (let* ((A-line (ediff-eval-in-buffer ediff-buffer-A
2363 (1+ (count-lines (point-min) (point)))))
2364 (B-line (ediff-eval-in-buffer ediff-buffer-B
2365 (1+ (count-lines (point-min) (point)))))
2367 (princ (format "\Buffer A's point is on line %d\n" A-line))
2368 (princ (format "Buffer B's point is on line %d\n" B-line))
2371 (setq C-line (ediff-eval-in-buffer ediff-buffer-C
2372 (1+ (count-lines (point-min) (point)))))
2373 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2375 (princ (format "\nCurrent difference number = %S\n"
2376 (cond ((< ediff-current-difference 0) 'start)
2377 ((>= ediff-current-difference
2378 ediff-number-of-differences) 'end)
2379 (t (1+ ediff-current-difference)))))
2381 (cond (ediff-ignore-similar-regions
2382 (princ "\nSkipping regions that differ only in white space & line breaks"))
2384 (princ "\nNot skipping regions that differ in white space & line breaks")))
2386 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2387 (princ "\nSelective browsing by regexp is off.\n"))
2388 ((eq ediff-skip-diff-region-function
2389 ediff-hide-regexp-matches-function)
2391 "\nIgnoring regions that match")
2394 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2395 ediff-regexp-hide-A ediff-hide-regexp-connective
2396 ediff-regexp-hide-B)))
2397 ((eq ediff-skip-diff-region-function
2398 ediff-focus-on-regexp-matches-function)
2400 "\nFocusing on regions that match")
2403 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2404 ediff-regexp-focus-A ediff-focus-regexp-connective
2405 ediff-regexp-focus-B)))
2406 (t (princ "\nSelective browsing via a user-defined method.\n")))
2409 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2410 (substitute-command-keys "\\[ediff-submit-report]")))
2412 (if (frame-live-p ediff-control-frame)
2413 (ediff-reset-mouse ediff-control-frame))
2414 (if (window-live-p ediff-control-window)
2415 (select-window ediff-control-window)))
2417 (defun ediff-documentation ()
2418 "Jump to Ediff's Info file."
2420 (let ((ctl-window ediff-control-window)
2421 (ctl-buf ediff-control-buffer))
2423 (ediff-skip-unsuitable-frames)
2426 (pop-to-buffer (get-buffer-create "*info*"))
2428 (message "Type `i' to search for a specific topic"))
2430 (with-output-to-temp-buffer " *ediff-info*"
2432 The Info file for Ediff does not seem to be installed.
2434 This file is part of the distribution of %sEmacs.
2435 Please contact your system administrator. "
2436 (if ediff-xemacs-p "X" ""))))
2437 (if (window-live-p ctl-window)
2439 (select-window ctl-window)
2440 (set-window-buffer ctl-window ctl-buf)))))))
2445 ;;; Support routines
2447 ;; Select a difference by placing the ASCII flags around the appropriate
2448 ;; group of lines in the A, B buffers
2449 ;; This may have to be modified for buffer C, when it will be supported.
2450 (defun ediff-select-difference (n)
2451 (if (and (ediff-buffer-live-p ediff-buffer-A)
2452 (ediff-buffer-live-p ediff-buffer-B)
2453 (ediff-valid-difference-p n))
2455 (if (and (ediff-window-display-p) ediff-use-faces)
2457 (ediff-highlight-diff n)
2458 (setq ediff-highlighting-style 'face))
2459 (setq ediff-highlighting-style 'ascii)
2460 (ediff-place-flags-in-buffer
2461 'A ediff-buffer-A ediff-control-buffer n)
2462 (ediff-place-flags-in-buffer
2463 'B ediff-buffer-B ediff-control-buffer n)
2465 (ediff-place-flags-in-buffer
2466 'C ediff-buffer-C ediff-control-buffer n))
2467 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2468 (ediff-place-flags-in-buffer
2469 'Ancestor ediff-ancestor-buffer
2470 ediff-control-buffer n))
2473 (ediff-install-fine-diff-if-necessary n)
2474 (run-hooks 'ediff-select-hook))))
2477 ;; Unselect a difference by removing the ASCII flags in the buffers.
2478 ;; This may have to be modified for buffer C, when it will be supported.
2479 (defun ediff-unselect-difference (n)
2480 (if (ediff-valid-difference-p n)
2482 (cond ((and (ediff-window-display-p) ediff-use-faces)
2483 (ediff-unhighlight-diff))
2484 ((eq ediff-highlighting-style 'ascii)
2485 (ediff-remove-flags-from-buffer
2487 (ediff-get-diff-overlay n 'A))
2488 (ediff-remove-flags-from-buffer
2490 (ediff-get-diff-overlay n 'B))
2492 (ediff-remove-flags-from-buffer
2494 (ediff-get-diff-overlay n 'C)))
2495 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2496 (ediff-remove-flags-from-buffer
2497 ediff-ancestor-buffer
2498 (ediff-get-diff-overlay n 'Ancestor)))
2500 (setq ediff-highlighting-style nil)
2502 ;; unhighlight fine diffs
2503 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2504 (run-hooks 'ediff-unselect-hook))))
2507 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2508 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2509 ;; next difference is selected, but the current selection is not
2510 ;; unselected. If FLAG is 'unselect-only then the current selection is
2511 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2512 ;; don't recenter buffers after selecting/unselecting.
2513 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2514 (let ((ediff-current-difference n))
2516 (ediff-recenter 'no-rehighlight)))
2518 (let ((control-buf ediff-control-buffer))
2521 (or (eq flag 'select-only)
2522 (ediff-unselect-difference ediff-current-difference))
2524 (or (eq flag 'unselect-only)
2525 (ediff-select-difference n))
2526 (setq ediff-current-difference n)
2527 ) ; end protected section
2529 (ediff-eval-in-buffer control-buf
2530 (ediff-refresh-mode-lines))
2534 (defun ediff-read-file-name (prompt default-dir default-file)
2535 ; This is a modified version of a similar function in `emerge.el'.
2536 ; PROMPT should not have trailing ': ', so that it can be modified
2537 ; according to context.
2538 ; If default-file is set, it should be used as the default value.
2539 ; If default-dir is non-nil, use it as the default directory.
2540 ; Otherwise, use the value of Emacs' variable `default-directory.'
2542 ;; hack default-dir if it is not set
2544 (file-name-as-directory
2545 (ediff-abbreviate-file-name
2546 (expand-file-name (or default-dir
2548 (file-name-directory default-file))
2549 default-directory)))))
2551 ;; strip the directory from default-file
2553 (setq default-file (file-name-nondirectory default-file)))
2554 (if (string= default-file "")
2555 (setq default-file nil))
2558 (setq f (expand-file-name
2563 (concat " (default " default-file ")")
2567 t ; must match, no-confirm
2568 (if default-file (file-name-directory default-file))
2572 ;; If user enters a directory name, expand the default file in that
2573 ;; directory. This allows the user to enter a directory name for the
2574 ;; B-file and diff against the default-file in that directory instead
2575 ;; of a DIRED listing!
2576 (if (and (file-directory-p f) default-file)
2577 (setq f (expand-file-name
2578 (file-name-nondirectory default-file) f)))
2581 ;; If `prefix' is given, then it is used as a prefix for the temp file
2582 ;; name. Otherwise, `ediff_' is used. If `file' is given, use this
2583 ;; file and don't create a new one.
2584 ;; Also, save buffer from START to END in the file.
2585 ;; START defaults to (point-min), END to (point-max)
2586 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
2587 (let ((f (or given-file
2588 (make-temp-name (concat
2589 ediff-temp-file-prefix
2594 (ediff-eval-in-buffer buff
2595 (write-region (if start start (point-min))
2596 (if end end (point-max))
2598 nil ; don't append---erase
2600 (set-file-modes f ediff-temp-file-mode)
2603 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
2605 ;;(defun ediff-protect-metachars (str)
2606 ;; (or (memq system-type '(emx vax-vms axp-vms))
2608 ;; (while (string-match ediff-metachars str limit)
2609 ;; (setq str (concat (substring str 0 (match-beginning 0))
2611 ;; (substring str (match-beginning 0))))
2612 ;; (setq limit (1+ (match-end 0))))))
2615 ;; Make sure the current buffer (for a file) has the same contents as the
2616 ;; file on disk, and attempt to remedy the situation if not.
2617 ;; Signal an error if we can't make them the same, or the user doesn't want
2618 ;; to do what is necessary to make them the same.
2619 ;; If file has file handlers (indicated by the optional arg), then we
2620 ;; offer to instead of saving. This is one difference with Emerge.
2621 ;; Another is that we always offer to revert obsolete files, whether they
2622 ;; are modified or not.
2623 (defun ediff-verify-file-buffer (&optional file-magic)
2624 ;; First check if the file has been modified since the buffer visited it.
2625 (if (verify-visited-file-modtime (current-buffer))
2626 (if (buffer-modified-p)
2627 ;; If buffer is not obsolete and is modified, offer to save
2629 (format "Buffer out of sync with visited file. %s file %s? "
2630 (if file-magic "Revert" "Save")
2632 (if (not file-magic)
2634 ;; for some reason, file-name-handlers append instead of
2635 ;; replacing, so we have to erase first.
2637 (revert-buffer t t))
2638 (error "Buffer out of sync for file %s" buffer-file-name))
2639 ;; If buffer is not obsolete and is not modified, do nothing
2641 ;; If buffer is obsolete, offer to revert
2643 (format "Buffer out of sync with visited file. Revert file %s? "
2648 (revert-buffer t t))
2649 (error "Buffer out of sync for file %s" buffer-file-name))))
2653 ;; It would be nice to use these two functions as hooks instead of
2654 ;; ediff-insert-in-front and ediff-move-disturbed-overlays.
2655 ;; However, Emacs has a bug that causes BEG and END, below, to be
2656 ;; the same, i.e., the end of inserted text is not passed correctly.
2657 ;; Since the overlay doesn't move when these hooks run,
2658 ;; there is no way to correctly determine the new (desired) position of
2660 ;; Either this bug is fixed, or (better) use sticky overlays when they will
2661 ;; be implemented in Emacs, like they are in XEmacs.
2662 ;;(defun ediff-capture-inserts-in-front (overl flag beg end &optional len)
2663 ;; (if (and flag (ediff-overlay-get overl 'ediff-diff-num))
2664 ;; (ediff-move-overlay overl beg (ediff-overlay-end overl))
2667 ;;(defun ediff-capture-inserts-behind (overl flag beg end &optional len)
2668 ;; (if (and flag (ediff-overlay-get overl 'ediff-diff-num))
2669 ;; (ediff-move-overlay overl (ediff-overlay-start overl) (point))
2672 ;; to be deleted in due time
2673 ;; Capture overlays that had insertions in the front.
2674 ;; Called when overlay OVERL gets insertion in front.
2675 (defun ediff-insert-in-front (overl &optional flag beg end length)
2676 (if (ediff-overlay-get overl 'ediff-diff-num)
2677 (setq ediff-disturbed-overlays
2678 (cons overl ediff-disturbed-overlays))))
2681 ;; to be deleted in due time
2682 ;; We can't move overlays directly in insert-in-front-hooks
2683 ;; because when diff is highlighted with ascii flags, they will disturb
2684 ;; overlays and so they will be included in them, which we don't want.
2685 (defun ediff-move-disturbed-overlays (posn)
2686 (mapcar (function (lambda (overl)
2687 (ediff-move-overlay overl
2689 (ediff-overlay-end overl))
2691 ediff-disturbed-overlays)
2692 (setq ediff-disturbed-overlays nil))
2695 (defun ediff-save-buffer (arg)
2696 "Safe way of saving buffers A, B, C, and the diff output.
2697 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
2698 and `wd' saves the diff output.
2700 With prefix argument, `wd' saves plain diff output.
2701 Without an argument, it saves customized diff argument, if available
2702 \(and plain output, if customized output was not generated\)."
2704 (ediff-barf-if-not-control-buffer)
2705 (ediff-compute-custom-diffs-maybe)
2706 (ediff-eval-in-buffer
2707 (cond ((memq last-command-char '(?a ?b ?c))
2709 (ediff-char-to-buftype last-command-char)))
2710 ((eq last-command-char ?d)
2711 (message "Saving diff output ...")
2712 (sit-for 1) ; let the user see the message
2713 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2715 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2716 ediff-custom-diff-buffer)
2717 ((ediff-buffer-live-p ediff-diff-buffer)
2719 (t (error "Output from `diff' not found"))))
2723 (defun ediff-compute-custom-diffs-maybe ()
2725 (let ((file-A (ediff-make-temp-file ediff-buffer-A))
2726 (file-B (ediff-make-temp-file ediff-buffer-B)))
2727 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
2728 (setq ediff-custom-diff-buffer
2730 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
2732 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
2733 ediff-custom-diff-options file-A file-B))))
2735 (defun ediff-show-diff-output (arg)
2737 (ediff-barf-if-not-control-buffer)
2738 (ediff-compute-custom-diffs-maybe)
2740 (ediff-skip-unsuitable-frames ' ok-unsplittable))
2741 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2743 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2744 ediff-custom-diff-buffer)
2745 ((ediff-buffer-live-p ediff-diff-buffer)
2749 (message "Output from `diff' not found")
2753 (ediff-eval-in-buffer buf
2754 (goto-char (point-min)))
2755 (switch-to-buffer buf)
2756 (raise-frame (selected-frame)))))
2757 (if (frame-live-p ediff-control-frame)
2758 (ediff-reset-mouse ediff-control-frame))
2759 (if (window-live-p ediff-control-window)
2760 (select-window ediff-control-window)))
2764 ;; will simplify it in due time, when emacs acquires before/after strings
2765 (defun ediff-remove-flags-from-buffer (buffer overlay)
2766 (ediff-eval-in-buffer buffer
2767 (let ((inhibit-read-only t))
2769 (ediff-overlay-put overlay 'begin-glyph nil)
2770 ;; before-string is not yet implemented in emacs.
2771 ;; when it will be, I will be able to delete much of the rest of
2773 (ediff-overlay-put overlay 'before-string nil))
2776 (ediff-overlay-put overlay 'end-glyph nil)
2777 ;; after-string is not yet implemented in emacs.
2778 (ediff-overlay-put overlay 'after-string nil))
2783 ;; will simplify it in due time, when emacs acquires before/after strings
2784 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
2785 (ediff-eval-in-buffer buffer
2786 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
2789 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
2790 (let* ((curr-overl (ediff-eval-in-buffer ctl-buffer
2791 (ediff-get-diff-overlay diff-no buf-type)))
2792 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
2793 after beg-of-line flag)
2795 ;; insert flag before the difference
2797 (setq beg-of-line (bolp))
2799 (setq flag (ediff-eval-in-buffer ctl-buffer
2800 (if (eq ediff-highlighting-style 'ascii)
2802 ediff-before-flag-bol ediff-before-flag-mol))))
2804 ;; insert the flag itself
2806 (ediff-overlay-put curr-overl 'begin-glyph flag)
2807 (ediff-overlay-put curr-overl 'before-string flag))
2809 ;; insert the flag after the difference
2810 ;; `after' must be set here, after the before-flag was inserted
2811 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
2813 (setq beg-of-line (bolp))
2815 (setq flag (ediff-eval-in-buffer ctl-buffer
2816 (if (eq ediff-highlighting-style 'ascii)
2818 ediff-after-flag-eol ediff-after-flag-mol))))
2820 ;; insert the flag itself
2822 (ediff-overlay-put curr-overl 'end-glyph flag)
2823 (ediff-overlay-put curr-overl 'after-string flag))
2827 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
2828 "Returns positions of difference sectors in the BUF-TYPE buffer.
2829 BUF-TYPE should be a symbol--either `A' or `B'.
2830 POS is either `beg' or `end'--it specifies whether you want the position at the
2831 beginning of a difference or at the end.
2833 The optional argument N says which difference \(default:
2834 `ediff-current-difference'\). The optional argument CONTROL-BUF says
2835 which control buffer is in effect in case it is not the current
2839 (setq control-buf (current-buffer)))
2841 (ediff-eval-in-buffer control-buf
2842 (or n (setq n ediff-current-difference))
2843 (if (or (< n 0) (>= n ediff-number-of-differences))
2844 (if (> ediff-number-of-differences 0)
2845 (error "There is no diff %d. Valid diffs are 1 to %d"
2846 (1+ n) ediff-number-of-differences)
2847 (error "No differences found")))
2848 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
2849 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
2851 "You have killed an essential Ediff buffer---Please exit Ediff"))
2853 (ediff-overlay-start diff-overlay)
2854 (ediff-overlay-end diff-overlay))
2859 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
2860 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2861 (let* ((buff (ediff-get-buffer buf-type))
2862 (last (ediff-eval-in-buffer buff (point-max)))
2863 (begin (ediff-get-diff-posn buf-type 'beg n))
2864 (end (ediff-get-diff-posn buf-type 'end n))
2865 (xtra (if (equal begin end) 1 0))
2866 (end-hilit (min last (+ end xtra)))
2867 (current-diff-overlay
2869 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2873 (ediff-move-overlay current-diff-overlay begin end-hilit)
2874 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
2875 ;; giving priority of 0 and then changing it may look funny, but
2876 ;; this overcomes an obscure Emacs bug.
2877 (ediff-overlay-put current-diff-overlay 'priority 0)
2878 (ediff-overlay-put current-diff-overlay 'priority
2879 (ediff-highest-priority begin end-hilit buff))
2880 (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
2882 ;; unhighlight the background overlay for diff n so it won't
2883 ;; interfere with the current diff overlay
2884 (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
2888 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
2889 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2890 (let ((current-diff-overlay
2892 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2894 (ediff-get-diff-overlay ediff-current-difference buf-type))
2897 (ediff-move-overlay current-diff-overlay 1 1)
2899 ;; rehighlight the overlay in the background of the
2900 ;; current difference region
2901 (ediff-set-overlay-face
2903 (if (and (ediff-window-display-p)
2904 ediff-use-faces ediff-highlight-all-diffs)
2905 (ediff-background-face buf-type ediff-current-difference)))
2908 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
2909 (ediff-unselect-and-select-difference -1)
2910 (if (and (ediff-window-display-p) ediff-use-faces)
2911 (let* ((inhibit-quit t)
2912 (current-diff-overlay-var
2913 (intern (format "ediff-current-diff-overlay-%S" buf-type)))
2914 (current-diff-overlay (symbol-value current-diff-overlay-var)))
2915 (ediff-color-background-regions 'unhighlight)
2916 (if (ediff-overlayp current-diff-overlay)
2917 (ediff-delete-overlay current-diff-overlay))
2918 (set current-diff-overlay-var nil)
2922 ;; null out difference overlays so they won't slow down future
2923 ;; editing operations
2924 ;; VEC is either a difference vector or a fine-diff vector
2925 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
2926 (if (vectorp (symbol-value vec-var))
2929 (ediff-delete-overlay
2930 (ediff-get-diff-overlay-from-diff-record elt))
2932 (ediff-clear-fine-diff-vector elt))
2934 (symbol-value vec-var)))
2935 ;; allow them to be garbage collected
2938 (defun ediff-color-background-regions (&optional unhighlight)
2939 (ediff-color-background-regions-in-one-buffer
2941 (ediff-color-background-regions-in-one-buffer
2943 (ediff-color-background-regions-in-one-buffer
2945 (ediff-color-background-regions-in-one-buffer
2946 'Ancestor unhighlight))
2948 (defun ediff-color-background-regions-in-one-buffer (buf-type unhighlight)
2950 (eval (intern (format "ediff-difference-vector-%S" buf-type))))
2954 (setq overl (ediff-get-diff-overlay-from-diff-record rec)
2955 diff-num (ediff-overlay-get overl 'ediff-diff-num))
2956 (ediff-set-overlay-face
2958 (if (not unhighlight)
2959 (ediff-background-face buf-type diff-num))
2966 ;; These two functions are here to neutralize XEmacs's unwillingness to
2967 ;; handle overlays whose buffers were deleted.
2968 (defun ediff-move-overlay (overlay beg end &optional buffer)
2969 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
2970 Checks if overlay's buffer exists before actually doing the move."
2971 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
2972 (if (ediff-buffer-live-p buf)
2974 (set-extent-endpoints overlay beg end)
2975 (move-overlay overlay beg end buffer))
2978 (ediff-delete-overlay overlay)))))
2980 (defun ediff-overlay-put (overlay prop value)
2981 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
2982 Checks if overlay's buffer exists."
2983 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
2985 (set-extent-property overlay prop value)
2986 (overlay-put overlay prop value))
2987 (ediff-delete-overlay overlay)))
2990 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
2991 ;; supporting sticky overlays, this function will make a sticky overlay.
2992 ;; BEG and END are expressions telling where overlay starts.
2993 ;; If they are numbers or buffers, then all is well. Otherwise, they must
2994 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
2996 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
2997 ;; newly created overlay.
2998 (defun ediff-make-bullet-proof-overlay (beg end buff)
2999 (if (ediff-buffer-live-p buff)
3001 (ediff-eval-in-buffer buff
3002 (or (number-or-marker-p beg)
3003 (setq beg (eval beg)))
3004 (or (number-or-marker-p end)
3005 (setq end (eval end)))
3006 (setq overl (ediff-make-overlay beg end buff))
3010 ;; take precautions against detached extents
3011 (ediff-overlay-put overl 'detachable nil)
3012 ;; chars inserted at both ends will be inside extent
3013 (ediff-overlay-put overl 'start-open nil)
3014 (ediff-overlay-put overl 'end-open nil))
3015 (ediff-overlay-put overl 'evaporate nil) ; don't detach
3016 ;; doesn't work since emacs buggily doesn't call these functions
3018 ;;(ediff-overlay-put overl 'insert-in-front-hooks
3019 ;; '(ediff-capture-inserts-in-front))
3020 ;;(ediff-overlay-put overl 'insert-behind-hooks
3021 ;; '(ediff-capture-inserts-behind))
3023 ;; These two are not yet implemented in Emacs
3024 (ediff-overlay-put overl 'rear-sticky t)
3025 (ediff-overlay-put overl 'front-sticky t)
3027 (ediff-overlay-put overl 'ediff-diff-num 0)
3030 (defsubst ediff-overlay-start (overl)
3031 (if (ediff-overlayp overl)
3033 (overlay-start overl)
3034 (extent-start-position overl))))
3036 (defsubst ediff-overlay-end (overl)
3037 (if (ediff-overlayp overl)
3040 (extent-end-position overl))))
3043 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3044 ;; other insignificant buffers (those beginning with "^[ *]").
3045 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3047 (defun ediff-other-buffer (buff)
3048 (if (not (listp buff)) (setq buff (list buff)))
3049 (let* ((frame-buffers (buffer-list))
3050 (significant-buffers
3052 (function (lambda (x)
3053 (cond ((member (buffer-name x) buff)
3055 ((not (ediff-get-visible-buffer-window x))
3057 ((string-match "^ " (buffer-name x))
3061 (buffers (delq nil significant-buffers))
3062 less-significant-buffers)
3064 (cond (buffers (car buffers))
3065 ;; try also buffers that are not displayed in windows
3066 ((setq less-significant-buffers
3071 (cond ((member (buffer-name x) buff) nil)
3072 ((string-match "^[ *]" (buffer-name x)) nil)
3075 (car less-significant-buffers))
3076 (t (other-buffer (current-buffer))))
3080 ;; Construct a unique buffer name.
3081 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3082 ;; prefix<3>suffix, etc.
3083 (defun ediff-unique-buffer-name (prefix suffix)
3084 (if (null (get-buffer (concat prefix suffix)))
3085 (concat prefix suffix)
3087 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3089 (format "%s<%d>%s" prefix n suffix))))
3092 ;; splits at a white space, returns a list
3093 (defun ediff-split-string (string)
3097 (while (string-match "[ \t]+" string start)
3098 (let ((match (string-match "[ \t]+" string start)))
3099 (setq substr (substring string start match))
3100 (if (> (length substr) 0)
3101 (setq result (cons substr result)))
3102 (setq start (match-end 0))))
3103 (setq substr (substring string start nil))
3104 (if (> (length substr) 0)
3105 (setq result (cons substr result)))
3108 (defun ediff-submit-report ()
3109 "Submit bug report on Ediff."
3111 (ediff-barf-if-not-control-buffer)
3112 (let ((reporter-prompt-for-summary-p t)
3113 (ctl-buf ediff-control-buffer)
3114 (ediff-device-type (ediff-device-type))
3115 varlist salutation buffer-name)
3116 (setq varlist '(ediff-diff-program ediff-diff-options
3117 ediff-patch-program ediff-patch-options
3120 ediff-auto-refine ediff-highlighting-style
3121 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3122 ediff-forward-word-function
3124 ediff-control-frame-parameters
3125 ediff-control-frame-position-function
3126 ediff-prefer-iconified-control-frame
3127 ediff-window-setup-function
3128 ediff-split-window-function
3135 Congratulations! You may have unearthed a bug in Ediff!
3137 Please make a concise and accurate summary of what happened
3138 and mail it to the address above.
3139 -----------------------------------------------------------
3142 (ediff-skip-unsuitable-frames)
3145 (switch-to-buffer ediff-msg-buffer)
3147 (delete-other-windows)
3149 Please read this first:
3150 ----------------------
3152 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3153 reporting that certain difference regions are not matched as you think they
3154 should, this is most likely due to the way Unix diff program decides what
3155 constitutes a difference region. Ediff is an Emacs interface to diff, and
3156 it has nothing to do with those decisions---it only takes the output from
3157 diff and presents it in a way that is better suited for human browsing and
3160 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3161 an Emacs bug. Report this to Emacs maintainers.
3163 Another popular topic for reports is compilation messages. Because Ediff
3164 interfaces to several other packages and runs under Emacs and XEmacs,
3165 byte-compilation may produce output like this:
3167 While compiling toplevel forms in file ediff.el:
3168 ** reference to free variable pm-color-alist
3169 ........................
3170 While compiling the end of the data:
3171 ** The following functions are not known to be defined:
3172 ediff-valid-color-p, ediff-set-face,
3173 ........................
3175 These are NOT errors, but inevitable warnings, which ought to be ignored.
3177 Please do not report those and similar things. However, comments and
3178 suggestions are always welcome.
3180 Mail anyway? (y or n) ")
3182 (if (y-or-n-p "Mail anyway? ")
3184 (if (ediff-buffer-live-p ctl-buf)
3185 (set-buffer ctl-buf))
3186 (setq buffer-name (buffer-name))
3188 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
3192 'delete-other-windows
3195 (beep 1)(message "Bug report aborted")
3196 (if (ediff-buffer-live-p ctl-buf)
3197 (ediff-eval-in-buffer ctl-buf
3198 (ediff-recenter 'no-rehighlight))))
3202 (defun ediff-deactivate-mark ()
3204 (zmacs-deactivate-region)
3207 (cond ((fboundp 'nuke-selective-display)
3208 ;; XEmacs 19.12 has nuke-selective-display
3209 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
3211 (defun ediff-nuke-selective-display ()
3215 (goto-char (point-min))
3216 (let ((mod-p (buffer-modified-p))
3217 buffer-read-only end)
3218 (and (eq t selective-display)
3219 (while (search-forward "\^M" nil t)
3223 (while (search-forward "\^M" end t)
3226 (set-buffer-modified-p mod-p)
3227 (setq selective-display nil)))))
3231 ;; The next two are modified versions from emerge.el.
3232 ;; VARS must be a list of symbols
3233 ;; ediff-save-variables returns an association list: ((var . val) ...)
3234 (defsubst ediff-save-variables (vars)
3235 (mapcar (function (lambda (v) (cons v (symbol-value v))))
3237 ;; VARS is a list of variable symbols.
3238 (defun ediff-restore-variables (vars assoc-list)
3240 (set (car vars) (cdr (assoc (car vars) assoc-list)))
3241 (setq vars (cdr vars))))
3243 (defun ediff-change-saved-variable (var value buf-type)
3245 (symbol-value (intern
3246 (concat "ediff-buffer-values-orig-"
3247 (symbol-name buf-type)))))
3248 (assoc-elt (assoc var assoc-list)))
3250 (setcdr assoc-elt value))))
3253 ;; must execute in control buf
3254 (defun ediff-save-protected-variables ()
3255 (setq ediff-buffer-values-orig-A
3256 (ediff-eval-in-buffer ediff-buffer-A
3257 (ediff-save-variables ediff-protected-variables)))
3258 (setq ediff-buffer-values-orig-B
3259 (ediff-eval-in-buffer ediff-buffer-B
3260 (ediff-save-variables ediff-protected-variables)))
3261 (if ediff-3way-comparison-job
3262 (setq ediff-buffer-values-orig-C
3263 (ediff-eval-in-buffer ediff-buffer-C
3264 (ediff-save-variables ediff-protected-variables))))
3265 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3266 (setq ediff-buffer-values-orig-Ancestor
3267 (ediff-eval-in-buffer ediff-ancestor-buffer
3268 (ediff-save-variables ediff-protected-variables)))))
3270 ;; must execute in control buf
3271 (defun ediff-restore-protected-variables ()
3272 (let ((values-A ediff-buffer-values-orig-A)
3273 (values-B ediff-buffer-values-orig-B)
3274 (values-C ediff-buffer-values-orig-C)
3275 (values-Ancestor ediff-buffer-values-orig-Ancestor))
3276 (ediff-eval-in-buffer ediff-buffer-A
3277 (ediff-restore-variables ediff-protected-variables values-A))
3278 (ediff-eval-in-buffer ediff-buffer-B
3279 (ediff-restore-variables ediff-protected-variables values-B))
3280 (if ediff-3way-comparison-job
3281 (ediff-eval-in-buffer ediff-buffer-C
3282 (ediff-restore-variables ediff-protected-variables values-C)))
3283 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3284 (ediff-eval-in-buffer ediff-ancestor-buffer
3285 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
3291 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3293 ;; calculate time used by command
3294 (defun ediff-calc-command-time ()
3295 (let ((end (current-time))
3298 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3299 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3300 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3301 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3302 (or (equal ediff-command-begin-time '(0 0 0))
3303 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3305 (defsubst ediff-save-time ()
3306 (setq ediff-command-begin-time (current-time)))
3308 (defun ediff-profile ()
3309 "Toggle profiling Ediff commands."
3311 (ediff-barf-if-not-control-buffer)
3313 (make-local-variable 'post-command-hook))
3314 (let ((pre-hook (if ediff-emacs-p 'pre-command-hook 'local-pre-command-hook))
3316 (if ediff-emacs-p 'post-command-hook 'local-post-command-hook)))
3317 (if (not (equal ediff-command-begin-time '(0 0 0)))
3318 (progn (remove-hook pre-hook 'ediff-save-time)
3319 (remove-hook post-hook 'ediff-calc-command-time)
3320 (setq ediff-command-begin-time '(0 0 0))
3321 (message "Ediff profiling disabled"))
3322 (add-hook pre-hook 'ediff-save-time t)
3323 (add-hook post-hook 'ediff-calc-command-time)
3324 (message "Ediff profiling enabled"))))
3326 (defun ediff-print-diff-vector (diff-vector-var)
3327 (princ (format "\n*** %S ***\n" diff-vector-var))
3332 "Diff %d: \tOverlay: %S
3334 \t\tNo-fine-diff-flag: %S
3335 \t\tState-of-diff:\t %S
3336 \t\tState-of-merge:\t %S
3338 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3341 (if (= (length (aref overl-vec 1)) 0)
3343 (mapconcat 'prin1-to-string
3344 (aref overl-vec 1) "\n\t\t\t "))
3345 (aref overl-vec 2) ; no fine diff flag
3346 (aref overl-vec 3) ; state-of-diff
3347 (aref overl-vec 4) ; state-of-merge
3349 (eval diff-vector-var)))
3353 (defun ediff-debug-info ()
3355 (ediff-barf-if-not-control-buffer)
3356 (with-output-to-temp-buffer ediff-debug-buffer
3357 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3358 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
3359 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
3360 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
3361 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
3364 ;; don't report error if version control package wasn't found
3365 ;;(ediff-load-version-control 'silent)
3367 (run-hooks 'ediff-load-hook)
3370 ;;; Local Variables:
3371 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3372 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
3375 (provide 'ediff-util)
3377 ;;; ediff-util.el ends here