1 ;;; ediff-util.el --- the core commands and utilities of ediff
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 ;; 2004 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
32 (defvar ediff-patch-diagnostics
)
33 (defvar ediff-patchbufer
)
34 (defvar ediff-use-toolbar-p
)
35 (defvar ediff-toolbar-height
)
36 (defvar ediff-toolbar
)
37 (defvar ediff-toolbar-3way
)
38 (defvar bottom-toolbar
)
39 (defvar bottom-toolbar-visible-p
)
40 (defvar bottom-toolbar-height
)
42 (defvar ediff-emacs-p
)
44 (defvar ediff-after-quit-hook-internal nil
)
48 (load "reporter" 'noerror
)))
51 (let ((load-path (cons (expand-file-name ".") load-path
)))
52 (or (featurep 'ediff-init
)
53 (load "ediff-init.el" nil nil
'nosuffix
))
54 (or (featurep 'ediff-help
)
55 (load "ediff-help.el" nil nil
'nosuffix
))
56 (or (featurep 'ediff-mult
)
57 (load "ediff-mult.el" nil nil
'nosuffix
))
58 (or (featurep 'ediff-wind
)
59 (load "ediff-wind.el" nil nil
'nosuffix
))
60 (or (featurep 'ediff-diff
)
61 (load "ediff-diff.el" nil nil
'nosuffix
))
62 (or (featurep 'ediff-merg
)
63 (load "ediff-merg.el" nil nil
'nosuffix
))
65 (load "ediff.el" nil nil
'nosuffix
))
66 (or (featurep 'ediff-tbar
)
68 (load "ediff-tbar.el" 'noerror nil
'nosuffix
))
81 (require 'ediff-tbar
))
87 "Ediff mode controls all operations in a single Ediff session.
88 This mode is entered through one of the following commands:
99 `ediff-merge-files-with-ancestor'
100 `ediff-merge-buffers'
101 `ediff-merge-buffers-with-ancestor'
102 `ediff-merge-revisions'
103 `ediff-merge-revisions-with-ancestor'
104 `ediff-windows-wordwise'
105 `ediff-windows-linewise'
106 `ediff-regions-wordwise'
107 `ediff-regions-linewise'
117 (kill-all-local-variables)
118 (setq major-mode
'ediff-mode
)
119 (setq mode-name
"Ediff")
120 (run-hooks 'ediff-mode-hook
))
126 (ediff-defvar-local ediff-mode-map nil
127 "Local keymap used in Ediff mode.
128 This is local to each Ediff Control Panel, so they may vary from invocation
131 ;; Set up the keymap in the control buffer
132 (defun ediff-set-keys ()
133 "Set up Ediff keymap, if necessary."
134 (if (null ediff-mode-map
)
135 (ediff-setup-keymap))
136 (use-local-map ediff-mode-map
))
138 ;; Reload Ediff keymap. For debugging only.
139 (defun ediff-reload-keymap ()
141 (setq ediff-mode-map nil
)
145 (defun ediff-setup-keymap ()
146 "Set up the keymap used in the control buffer of Ediff."
147 (setq ediff-mode-map
(make-sparse-keymap))
148 (suppress-keymap ediff-mode-map
)
150 (define-key ediff-mode-map
151 (if ediff-emacs-p
[mouse-2
] [button2]) 'ediff-help-for-quick-help)
152 (define-key ediff-mode-map "\C-m" 'ediff-help-for-quick-help)
154 (define-key ediff-mode-map "p" 'ediff-previous-difference)
155 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
156 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
157 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
158 'ediff-previous-difference nil))
159 ;; must come after C-h, or else C-h wipes out backspace's binding in XEmacs
160 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
161 (define-key ediff-mode-map "n" 'ediff-next-difference)
162 (define-key ediff-mode-map " " 'ediff-next-difference)
163 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
164 (define-key ediff-mode-map "g" nil)
165 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
166 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
167 (define-key ediff-mode-map "q" 'ediff-quit)
168 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
169 (define-key ediff-mode-map "z" 'ediff-suspend)
170 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
171 (define-key ediff-mode-map "|" 'ediff-toggle-split)
172 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
174 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
176 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
177 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
178 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
179 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
180 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
181 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
182 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
183 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
184 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
185 (define-key ediff-mode-map "i" 'ediff-status-info)
186 (define-key ediff-mode-map "E" 'ediff-documentation)
187 (define-key ediff-mode-map "?" 'ediff-toggle-help)
188 (define-key ediff-mode-map "!" 'ediff-update-diffs)
189 (define-key ediff-mode-map "M" 'ediff-show-current-session-meta-buffer)
190 (define-key ediff-mode-map "R" 'ediff-show-registry)
192 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
193 (define-key ediff-mode-map "a" nil)
194 (define-key ediff-mode-map "b" nil)
195 (define-key ediff-mode-map "r" nil)
196 (cond (ediff-merge-job
197 ;; Will barf if no ancestor
198 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
199 ;; In merging, we allow only A->C and B->C copying.
200 (define-key ediff-mode-map "a" 'ediff-copy-A-to-C)
201 (define-key ediff-mode-map "b" 'ediff-copy-B-to-C)
202 (define-key ediff-mode-map "r" 'ediff-restore-diff-in-merge-buffer)
203 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
204 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
205 (define-key ediff-mode-map "$" nil)
206 (define-key ediff-mode-map "$$" 'ediff-toggle-show-clashes-only)
207 (define-key ediff-mode-map "$*" 'ediff-toggle-skip-changed-regions)
208 (define-key ediff-mode-map "&" 'ediff-re-merge))
209 (ediff-3way-comparison-job
210 (define-key ediff-mode-map "ab" 'ediff-copy-A-to-B)
211 (define-key ediff-mode-map "ba" 'ediff-copy-B-to-A)
212 (define-key ediff-mode-map "ac" 'ediff-copy-A-to-C)
213 (define-key ediff-mode-map "bc" 'ediff-copy-B-to-C)
214 (define-key ediff-mode-map "c" nil)
215 (define-key ediff-mode-map "ca" 'ediff-copy-C-to-A)
216 (define-key ediff-mode-map "cb" 'ediff-copy-C-to-B)
217 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
218 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
219 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
220 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
221 (t ; 2-way comparison
222 (define-key ediff-mode-map "a" 'ediff-copy-A-to-B)
223 (define-key ediff-mode-map "b" 'ediff-copy-B-to-A)
224 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
225 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
227 (define-key ediff-mode-map "G" 'ediff-submit-report)
228 (define-key ediff-mode-map "#" nil)
229 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
230 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
232 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
233 (define-key ediff-mode-map "o" nil)
234 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
235 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
236 (define-key ediff-mode-map "w" nil)
237 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
238 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
239 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
240 (define-key ediff-mode-map "=" 'ediff-inferior-compare-regions)
241 (if (and (fboundp 'ediff-show-patch-diagnostics) (ediff-patch-job))
242 (define-key ediff-mode-map "P" 'ediff-show-patch-diagnostics))
245 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
246 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
249 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
251 ;; Allow ediff-mode-map to be referenced indirectly
252 (fset 'ediff-mode-map ediff-mode-map)
253 (run-hooks 'ediff-keymap-setup-hook))
258 ;; Common startup entry for all Ediff functions It now returns control buffer
259 ;; so other functions can do post-processing SETUP-PARAMETERS is a list of the
260 ;; form ((param .val) (param . val)...) This serves a similar purpose to
261 ;; STARTUP-HOOKS, but these parameters are set in the new control buffer right
262 ;; after this buf is created and before any windows are set and such.
263 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
264 startup-hooks setup-parameters
265 &optional merge-buffer-file)
266 (run-hooks 'ediff-before-setup-hook)
267 ;; ediff-convert-standard-filename puts file names in the form appropriate
268 ;; for the OS at hand.
269 (setq file-A (ediff-convert-standard-filename (expand-file-name file-A)))
270 (setq file-B (ediff-convert-standard-filename (expand-file-name file-B)))
273 (ediff-convert-standard-filename (expand-file-name file-C))))
274 (if (stringp merge-buffer-file)
276 (setq merge-buffer-file
277 (ediff-convert-standard-filename
278 (expand-file-name merge-buffer-file)))
279 ;; check the directory exists
280 (or (file-exists-p (file-name-directory merge-buffer-file))
281 (error "Directory %s given as place to save the merge doesn't exist"
282 (abbreviate-file-name
283 (file-name-directory merge-buffer-file))))
284 (if (and (file-exists-p merge-buffer-file)
285 (file-directory-p merge-buffer-file))
286 (error "The merge buffer file %s must not be a directory"
287 (abbreviate-file-name merge-buffer-file)))
289 (let* ((control-buffer-name
290 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
291 (control-buffer (ediff-with-current-buffer buffer-A
292 (get-buffer-create control-buffer-name))))
293 (ediff-with-current-buffer control-buffer
296 (make-local-variable 'ediff-use-long-help-message)
297 (make-local-variable 'ediff-prefer-iconified-control-frame)
298 (make-local-variable 'ediff-split-window-function)
299 (make-local-variable 'ediff-default-variant)
300 (make-local-variable 'ediff-merge-window-share)
301 (make-local-variable 'ediff-window-setup-function)
302 (make-local-variable 'ediff-keep-variants)
304 (ediff-cond-compile-for-xemacs-or-emacs
305 (make-local-hook 'ediff-after-quit-hook-internal) ; xemacs form
309 ;; unwrap set up parameters passed as argument
310 (while setup-parameters
311 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
312 (setq setup-parameters (cdr setup-parameters)))
314 ;; set variables classifying the current ediff job
315 ;; must come AFTER setup-parameters
316 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
317 ediff-merge-job (ediff-merge-job)
318 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
319 ediff-3way-job (ediff-3way-job)
320 ediff-diff3-job (ediff-diff3-job)
321 ediff-narrow-job (ediff-narrow-job)
322 ediff-windows-job (ediff-windows-job)
323 ediff-word-mode-job (ediff-word-mode-job))
325 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
326 ;; This is because u may loose work---dangerous.
327 (if (string-match "buffer" (symbol-name ediff-job-name))
328 (setq ediff-keep-variants t))
330 (ediff-cond-compile-for-xemacs-or-emacs
331 (make-local-hook 'pre-command-hook) ; xemacs form
335 (if (ediff-window-display-p)
336 (add-hook 'pre-command-hook 'ediff-spy-after-mouse nil 'local))
337 (setq ediff-mouse-pixel-position (mouse-pixel-position))
339 ;; adjust for merge jobs
342 ;; If default variant is `combined', the right stuff is
343 ;; inserted by ediff-do-merge
344 ;; Note: at some point, we tried to put ancestor buffer here
345 ;; (which is currently buffer C. This didn't work right
346 ;; because the merge buffer will contain lossage: diff regions
347 ;; in the ancestor, which correspond to revisions that agree
348 ;; in both buf A and B.
349 (cond ((eq ediff-default-variant 'default-B)
353 (setq ediff-split-window-function
354 ediff-merge-split-window-function)
356 ;; remember the ancestor buffer, if any
357 (setq ediff-ancestor-buffer buffer-C)
361 (ediff-unique-buffer-name "*ediff-merge" "*")))
363 (set-buffer buffer-C)
365 (funcall (ediff-with-current-buffer buf major-mode))
366 (widen) ; merge buffer is always widened
367 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode nil t)
369 (setq buffer-read-only nil
370 ediff-buffer-A buffer-A
371 ediff-buffer-B buffer-B
372 ediff-buffer-C buffer-C
373 ediff-control-buffer control-buffer)
375 (ediff-choose-syntax-table)
377 (setq ediff-control-buffer-suffix
378 (if (string-match "<[0-9]*>" control-buffer-name)
379 (substring control-buffer-name
380 (match-beginning 0) (match-end 0))
382 ediff-control-buffer-number
388 ediff-control-buffer-suffix
390 (string-match "[0-9]+" ediff-control-buffer-suffix)
393 (setq ediff-error-buffer
394 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
396 (ediff-with-current-buffer buffer-A (ediff-strip-mode-line-format))
397 (ediff-with-current-buffer buffer-B (ediff-strip-mode-line-format))
399 (ediff-with-current-buffer buffer-C (ediff-strip-mode-line-format)))
400 (if (ediff-buffer-live-p ediff-ancestor-buffer)
401 (ediff-with-current-buffer ediff-ancestor-buffer
402 (ediff-strip-mode-line-format)))
404 (ediff-save-protected-variables) ; save variables to be restored on exit
406 ;; ediff-setup-diff-regions-function must be set after setup
407 ;; parameters are processed.
408 (setq ediff-setup-diff-regions-function
410 'ediff-setup-diff-regions3
411 'ediff-setup-diff-regions))
413 (setq ediff-wide-bounds
414 (list (ediff-make-bullet-proof-overlay
415 '(point-min) '(point-max) ediff-buffer-A)
416 (ediff-make-bullet-proof-overlay
417 '(point-min) '(point-max) ediff-buffer-B)
418 (ediff-make-bullet-proof-overlay
419 '(point-min) '(point-max) ediff-buffer-C)))
421 ;; This has effect only on ediff-windows/regions
422 ;; In all other cases, ediff-visible-region sets visibility bounds to
423 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
424 (if ediff-start-narrowed
425 (setq ediff-visible-bounds ediff-narrow-bounds)
426 (setq ediff-visible-bounds ediff-wide-bounds))
428 (ediff-set-keys) ; comes after parameter setup
430 ;; set up ediff-narrow-bounds, if not set
431 (or ediff-narrow-bounds
432 (setq ediff-narrow-bounds ediff-wide-bounds))
434 ;; All these must be inside ediff-with-current-buffer control-buffer,
435 ;; since these vars are local to control-buffer
436 ;; These won't run if there are errors in diff
437 (ediff-with-current-buffer ediff-buffer-A
438 (ediff-nuke-selective-display)
439 (run-hooks 'ediff-prepare-buffer-hook)
440 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
441 (setq buffer-read-only t))
442 ;; add control-buffer to the list of sessions--no longer used, but may
443 ;; be used again in the future
444 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
445 (setq ediff-this-buffer-ediff-sessions
446 (cons control-buffer ediff-this-buffer-ediff-sessions)))
447 (if ediff-make-buffers-readonly-at-startup
448 (setq buffer-read-only t))
451 (ediff-with-current-buffer ediff-buffer-B
452 (ediff-nuke-selective-display)
453 (run-hooks 'ediff-prepare-buffer-hook)
454 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
455 (setq buffer-read-only t))
456 ;; add control-buffer to the list of sessions
457 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
458 (setq ediff-this-buffer-ediff-sessions
459 (cons control-buffer ediff-this-buffer-ediff-sessions)))
460 (if ediff-make-buffers-readonly-at-startup
461 (setq buffer-read-only t))
465 (ediff-with-current-buffer ediff-buffer-C
466 (ediff-nuke-selective-display)
467 ;; the merge bufer should never be narrowed
468 ;; (it can happen if it is on rmail-mode or similar)
469 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
471 (run-hooks 'ediff-prepare-buffer-hook)
472 ;; add control-buffer to the list of sessions
473 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
474 (setq ediff-this-buffer-ediff-sessions
476 ediff-this-buffer-ediff-sessions)))
477 (if ediff-make-buffers-readonly-at-startup
478 (setq buffer-read-only t)
479 (setq buffer-read-only nil))
482 (if (ediff-buffer-live-p ediff-ancestor-buffer)
483 (ediff-with-current-buffer ediff-ancestor-buffer
484 (ediff-nuke-selective-display)
485 (setq buffer-read-only t)
486 (run-hooks 'ediff-prepare-buffer-hook)
487 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
488 (setq ediff-this-buffer-ediff-sessions
490 ediff-this-buffer-ediff-sessions)))
493 ;; the following must be after setting up ediff-narrow-bounds AND after
494 ;; nuking selective display
495 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
496 (setq ediff-number-of-differences (length ediff-difference-vector-A))
497 (setq ediff-current-difference -1)
499 (ediff-make-current-diff-overlay 'A)
500 (ediff-make-current-diff-overlay 'B)
502 (ediff-make-current-diff-overlay 'C))
503 (if ediff-merge-with-ancestor-job
504 (ediff-make-current-diff-overlay 'Ancestor))
506 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
508 (let ((shift-A (ediff-overlay-start
509 (ediff-get-value-according-to-buffer-type
510 'A ediff-narrow-bounds)))
511 (shift-B (ediff-overlay-start
512 (ediff-get-value-according-to-buffer-type
513 'B ediff-narrow-bounds)))
514 (shift-C (ediff-overlay-start
515 (ediff-get-value-according-to-buffer-type
516 'C ediff-narrow-bounds))))
517 ;; position point in buf A
519 (select-window ediff-window-A)
521 ;; position point in buf B
523 (select-window ediff-window-B)
527 (select-window ediff-window-C)
528 (goto-char shift-C)))
531 (select-window ediff-control-window)
532 (ediff-visible-region)
534 (run-hooks 'startup-hooks)
535 (ediff-arrange-autosave-in-merge-jobs merge-buffer-file)
537 (ediff-refresh-mode-lines)
538 (setq buffer-read-only t)
539 (setq ediff-session-registry
540 (cons control-buffer ediff-session-registry))
541 (ediff-update-registry)
542 (if (ediff-buffer-live-p ediff-meta-buffer)
543 (ediff-update-meta-buffer
544 ediff-meta-buffer nil ediff-meta-session-number))
545 (run-hooks 'ediff-startup-hook)
546 ) ; eval in control-buffer
550 ;; This function assumes that we are in the window where control buffer is
552 (defun ediff-setup-control-buffer (ctl-buf)
553 "Set up window for control buffer."
554 (if (window-dedicated-p (selected-window))
555 (set-buffer ctl-buf) ; we are in control frame but just in case
556 (switch-to-buffer ctl-buf))
557 (let ((window-min-height 2))
559 (ediff-set-help-message)
560 (insert ediff-help-message)
561 (shrink-window-if-larger-than-buffer)
562 (or (ediff-multiframe-setup-p)
563 (ediff-indent-help-message))
564 (ediff-set-help-overlays)
566 (set-buffer-modified-p nil)
567 (ediff-refresh-mode-lines)
568 (setq ediff-control-window (selected-window))
569 (setq ediff-window-config-saved
570 (format "%S%S%S%S%S%S%S"
575 ediff-split-window-function
576 (ediff-multiframe-setup-p)
577 ediff-wide-display-p))
579 ;; In multiframe, toolbar is set in ediff-setup-control-frame
580 (if (not (ediff-multiframe-setup-p))
581 (ediff-make-bottom-toolbar)) ; this checks if toolbar is requested
582 (goto-char (point-min))
583 (skip-chars-forward ediff-whitespace)))
585 ;; This executes in control buffer and sets auto-save, visited file name, etc,
586 ;; in the merge buffer
587 (defun ediff-arrange-autosave-in-merge-jobs (merge-buffer-file)
588 (if (not ediff-merge-job)
590 (if (stringp merge-buffer-file)
591 (setq ediff-autostore-merges t
592 ediff-merge-store-file merge-buffer-file))
593 (if (stringp ediff-merge-store-file)
595 ;; save before leaving ctl buffer
596 (ediff-verify-file-merge-buffer ediff-merge-store-file)
597 (setq merge-buffer-file ediff-merge-store-file)
598 (ediff-with-current-buffer ediff-buffer-C
599 (set-visited-file-name merge-buffer-file))))
600 (ediff-with-current-buffer ediff-buffer-C
601 (setq buffer-offer-save t) ; ask before killing buffer
602 ;; make sure the contents is auto-saved
607 ;;; Commands for working with Ediff
609 (defun ediff-update-diffs ()
610 "Recompute difference regions in buffers A, B, and C.
611 Buffers are not synchronized with their respective files, so changes done
612 to these buffers are not saved at this point---the user can do this later,
615 (ediff-barf-if-not-control-buffer)
616 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
619 "Ancestor buffer will not be used. Recompute diffs anyway? ")))
620 (error "Recomputation of differences canceled"))
622 (let ((point-A (ediff-with-current-buffer ediff-buffer-A (point)))
623 ;;(point-B (ediff-with-current-buffer ediff-buffer-B (point)))
624 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
625 (buf-A-file-name (buffer-file-name ediff-buffer-A))
626 (buf-B-file-name (buffer-file-name ediff-buffer-B))
627 ;; (null ediff-buffer-C) is no problem, as we later check if
628 ;; ediff-buffer-C is alive
629 (buf-C-file-name (buffer-file-name ediff-buffer-C))
630 (overl-A (ediff-get-value-according-to-buffer-type
631 'A ediff-narrow-bounds))
632 (overl-B (ediff-get-value-according-to-buffer-type
633 'B ediff-narrow-bounds))
634 (overl-C (ediff-get-value-according-to-buffer-type
635 'C ediff-narrow-bounds))
636 beg-A end-A beg-B end-B beg-C end-C
637 file-A file-B file-C)
639 (if (stringp buf-A-file-name)
640 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
641 (if (stringp buf-B-file-name)
642 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
643 (if (stringp buf-C-file-name)
644 (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
646 (ediff-unselect-and-select-difference -1)
648 (setq beg-A (ediff-overlay-start overl-A)
649 beg-B (ediff-overlay-start overl-B)
650 beg-C (ediff-overlay-start overl-C)
651 end-A (ediff-overlay-end overl-A)
652 end-B (ediff-overlay-end overl-B)
653 end-C (ediff-overlay-end overl-C))
657 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
658 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
659 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
660 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
663 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
664 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
667 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
668 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
670 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
673 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
674 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
675 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
676 (ediff-clear-diff-vector
677 'ediff-difference-vector-Ancestor 'fine-diffs-also)
678 ;; let them garbage collect. we can't use the ancestor after recomputing
680 (setq ediff-difference-vector-Ancestor nil
681 ediff-ancestor-buffer nil
682 ediff-state-of-merge nil)
684 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
686 ;; In case of merge job, fool it into thinking that it is just doing
688 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
689 (ediff-3way-comparison-job ediff-3way-comparison-job)
690 (ediff-merge-job ediff-merge-job)
691 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
692 (ediff-job-name ediff-job-name))
694 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
695 ediff-3way-comparison-job t
697 ediff-merge-with-ancestor-job nil
698 ediff-job-name 'ediff-files3))
699 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
701 (setq ediff-number-of-differences (length ediff-difference-vector-A))
705 (delete-file file-C))
708 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
710 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
714 ;; Not bound to any key---to dangerous. A user can do it if necessary.
715 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
716 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
718 (ediff-barf-if-not-control-buffer)
719 (let ((bufA ediff-buffer-A)
720 (bufB ediff-buffer-B)
721 (bufC ediff-buffer-C)
722 (ctl-buf ediff-control-buffer)
723 (keep-variants ediff-keep-variants)
724 (ancestor-buf ediff-ancestor-buffer)
725 (ancestor-job ediff-merge-with-ancestor-job)
726 (merge ediff-merge-job)
727 (comparison ediff-3way-comparison-job))
728 (ediff-with-current-buffer bufA
729 (revert-buffer t noconfirm))
730 (ediff-with-current-buffer bufB
731 (revert-buffer t noconfirm))
732 ;; this should only be executed in a 3way comparison, not in merge
734 (ediff-with-current-buffer bufC
735 (revert-buffer t noconfirm)))
739 ;; the argument says whether to reverse the meaning of
740 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
742 (ediff-really-quit (not keep-variants))
745 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
746 (ediff-merge-buffers bufA bufB)))
747 (ediff-update-diffs))))
750 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
751 (defun ediff-recenter (&optional no-rehighlight)
752 "Bring the highlighted region of all buffers being compared into view.
753 Reestablish the default three-window display."
755 (ediff-barf-if-not-control-buffer)
756 (let (buffer-read-only)
757 (if (and (ediff-buffer-live-p ediff-buffer-A)
758 (ediff-buffer-live-p ediff-buffer-B)
759 (or (not ediff-3way-job)
760 (ediff-buffer-live-p ediff-buffer-C)))
762 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
763 (or (eq this-command 'ediff-quit)
764 (message ediff-KILLED-VITAL-BUFFER
768 ;; set visibility range appropriate to this invocation of Ediff.
769 (ediff-visible-region)
771 (if (and (ediff-window-display-p)
772 (symbolp this-command)
773 (symbolp last-command)
774 ;; Either one of the display-changing commands
775 (or (memq this-command
777 ediff-dir-action ediff-registry-action
779 ediff-toggle-wide-display ediff-toggle-multiframe))
780 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
781 ;; This avoids raising frames unnecessarily.
782 (and (memq this-command
783 '(ediff-next-difference
784 ediff-previous-difference
785 ediff-jump-to-difference
786 ediff-jump-to-difference-at-point))
787 (not (string-match "^ediff-" (symbol-name last-command)))
790 (if (window-live-p ediff-window-A)
791 (raise-frame (window-frame ediff-window-A)))
792 (if (window-live-p ediff-window-B)
793 (raise-frame (window-frame ediff-window-B)))
794 (if (window-live-p ediff-window-C)
795 (raise-frame (window-frame ediff-window-C)))))
796 (if (and (ediff-window-display-p)
797 (frame-live-p ediff-control-frame)
798 (not ediff-use-long-help-message)
799 (not (ediff-frame-iconified-p ediff-control-frame)))
800 (raise-frame ediff-control-frame))
802 ;; Redisplay whatever buffers are showing, if there is a selected difference
803 (let ((control-frame ediff-control-frame)
804 (control-buf ediff-control-buffer))
805 (if (and (ediff-buffer-live-p ediff-buffer-A)
806 (ediff-buffer-live-p ediff-buffer-B)
807 (or (not ediff-3way-job)
808 (ediff-buffer-live-p ediff-buffer-C)))
811 (ediff-select-difference ediff-current-difference))
813 (ediff-recenter-one-window 'A)
814 (ediff-recenter-one-window 'B)
816 (ediff-recenter-one-window 'C))
818 (ediff-with-current-buffer control-buf
819 (ediff-recenter-ancestor) ; check if ancestor is alive
821 (if (and (ediff-multiframe-setup-p)
822 (not ediff-use-long-help-message)
823 (not (ediff-frame-iconified-p ediff-control-frame)))
824 ;; never grab mouse on quit in this place
827 (eq this-command 'ediff-quit))))
831 (ediff-restore-highlighting))
832 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
835 ;; this function returns to the window it was called from
836 ;; (which was the control window)
837 (defun ediff-recenter-one-window (buf-type)
838 (if (ediff-valid-difference-p)
839 ;; context must be saved before switching to windows A/B/C
840 (let* ((ctl-wind (selected-window))
841 (shift (ediff-overlay-start
842 (ediff-get-value-according-to-buffer-type
843 buf-type ediff-narrow-bounds)))
844 (job-name ediff-job-name)
845 (control-buf ediff-control-buffer)
846 (window-name (ediff-get-symbol-from-alist
847 buf-type ediff-window-alist))
848 (window (if (window-live-p (symbol-value window-name))
849 (symbol-value window-name))))
851 (if (and window ediff-windows-job)
852 (set-window-start window shift))
855 (select-window window)
856 (ediff-deactivate-mark)
857 (ediff-position-region
858 (ediff-get-diff-posn buf-type 'beg nil control-buf)
859 (ediff-get-diff-posn buf-type 'end nil control-buf)
860 (ediff-get-diff-posn buf-type 'beg nil control-buf)
863 (select-window ctl-wind)
866 (defun ediff-recenter-ancestor ()
867 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
869 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
870 (ediff-valid-difference-p))
871 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
872 (ctl-wind (selected-window))
873 (job-name ediff-job-name)
874 (ctl-buf ediff-control-buffer))
875 (ediff-with-current-buffer ediff-ancestor-buffer
876 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
879 (select-window window)
880 (ediff-position-region
881 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
882 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
883 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
885 (select-window ctl-wind)
889 ;; This will have to be refined for 3way jobs
890 (defun ediff-toggle-split ()
891 "Toggle vertical/horizontal window split.
892 Does nothing if file-A and file-B are in different frames."
894 (ediff-barf-if-not-control-buffer)
895 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
896 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
897 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
898 (frame-A (if wind-A (window-frame wind-A)))
899 (frame-B (if wind-B (window-frame wind-B)))
900 (frame-C (if wind-C (window-frame wind-C))))
901 (if (or (eq frame-A frame-B)
902 (not (frame-live-p frame-A))
903 (not (frame-live-p frame-B))
904 (if ediff-3way-comparison-job
905 (or (not (frame-live-p frame-C))
906 (eq frame-A frame-C) (eq frame-B frame-C))))
907 (setq ediff-split-window-function
908 (if (eq ediff-split-window-function 'split-window-vertically)
909 'split-window-horizontally
910 'split-window-vertically))
911 (message "Buffers being compared are in different frames"))
912 (ediff-recenter 'no-rehighlight)))
914 (defun ediff-toggle-hilit ()
915 "Switch between highlighting using ASCII flags and highlighting using faces.
916 On a dumb terminal, switches between ASCII highlighting and no highlighting."
918 (ediff-barf-if-not-control-buffer)
920 (ediff-unselect-and-select-difference
921 ediff-current-difference 'unselect-only)
922 ;; cycle through highlighting
923 (cond ((and ediff-use-faces
924 (ediff-has-face-support-p)
925 ediff-highlight-all-diffs)
926 (message "Unhighlighting unselected difference regions")
927 (setq ediff-highlight-all-diffs nil
928 ediff-highlighting-style 'face))
929 ((or (and ediff-use-faces (ediff-has-face-support-p)
930 (eq ediff-highlighting-style 'face)) ; has face support
931 (and (not (ediff-has-face-support-p)) ; no face support
932 (eq ediff-highlighting-style 'off)))
933 (message "Highlighting with ASCII flags")
934 (setq ediff-highlighting-style 'ascii
935 ediff-highlight-all-diffs nil
936 ediff-use-faces nil))
937 ((eq ediff-highlighting-style 'ascii)
938 (message "ASCII highlighting flags removed")
939 (setq ediff-highlighting-style 'off
940 ediff-highlight-all-diffs nil))
941 ((ediff-has-face-support-p) ; catch-all for cases with face support
942 (message "Re-highlighting all difference regions")
943 (setq ediff-use-faces t
944 ediff-highlighting-style 'face
945 ediff-highlight-all-diffs t)))
947 (if (and ediff-use-faces ediff-highlight-all-diffs)
948 (ediff-paint-background-regions)
949 (ediff-paint-background-regions 'unhighlight))
951 (ediff-unselect-and-select-difference
952 ediff-current-difference 'select-only))
955 (defun ediff-toggle-autorefine ()
956 "Toggle auto-refine mode."
958 (ediff-barf-if-not-control-buffer)
960 (error "No fine differences in this mode"))
961 (cond ((eq ediff-auto-refine 'nix)
962 (setq ediff-auto-refine 'on)
963 (ediff-make-fine-diffs ediff-current-difference 'noforce)
964 (message "Auto-refining is ON"))
965 ((eq ediff-auto-refine 'on)
966 (message "Auto-refining is OFF")
967 (setq ediff-auto-refine 'off))
969 (ediff-set-fine-diff-properties ediff-current-difference 'default)
970 (message "Refinements are HIDDEN")
971 (setq ediff-auto-refine 'nix))
974 (defun ediff-show-ancestor ()
975 "Show the ancestor buffer in a suitable window."
978 (or (ediff-buffer-live-p ediff-ancestor-buffer)
979 (if ediff-merge-with-ancestor-job
980 (error "Lost connection to ancestor buffer...sorry")
981 (error "Not merging with ancestor")))
983 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
984 (raise-frame (window-frame wind)))
985 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
987 (defun ediff-make-or-kill-fine-diffs (arg)
988 "Compute fine diffs. With negative prefix arg, kill fine diffs.
989 In both cases, operates on the current difference region."
991 (ediff-barf-if-not-control-buffer)
993 (ediff-clear-fine-differences ediff-current-difference))
994 ((and (numberp arg) (< arg 0))
995 (ediff-clear-fine-differences ediff-current-difference))
996 (t (ediff-make-fine-diffs))))
999 (defun ediff-toggle-help ()
1000 "Toggle short/long help message."
1002 (ediff-barf-if-not-control-buffer)
1003 (let (buffer-read-only)
1005 (setq ediff-use-long-help-message (not ediff-use-long-help-message))
1006 (ediff-set-help-message))
1007 ;; remember the icon status of the control frame when the user requested
1008 ;; full control message
1009 (if (and ediff-use-long-help-message (ediff-multiframe-setup-p))
1010 (setq ediff-prefer-iconified-control-frame
1011 (ediff-frame-iconified-p ediff-control-frame)))
1013 (setq ediff-window-config-saved "") ; force redisplay
1014 (ediff-recenter 'no-rehighlight))
1017 ;; If BUF, this is the buffer to toggle, not current buffer.
1018 (defun ediff-toggle-read-only (&optional buf)
1019 "Toggle read-only in current buffer.
1020 If buffer is under version control and locked, check it out first.
1021 If optional argument BUF is specified, toggle read-only in that buffer instead
1022 of the current buffer."
1024 (ediff-barf-if-not-control-buffer)
1025 (let ((ctl-buf (if (null buf) (current-buffer)))
1026 (buf-type (ediff-char-to-buftype last-command-char)))
1027 (or buf (ediff-recenter))
1029 (setq buf (ediff-get-buffer buf-type)))
1031 (ediff-with-current-buffer buf ; eval in buf A/B/C
1032 (let* ((file (buffer-file-name buf))
1033 (file-writable (and file
1034 (file-exists-p file)
1035 (file-writable-p file)))
1036 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
1037 ((ediff-file-checked-out-p file)
1039 (file-writable 'toggle-read-only)
1040 (t (key-binding "\C-x\C-q")))))
1041 ;; If the file is checked in, make sure we don't make buffer modifiable
1042 ;; without warning the user. The user can fool our checks by making the
1043 ;; buffer non-RO without checking the file out. We regard this as a
1045 (if (and (ediff-file-checked-in-p file)
1046 ;; If ctl-buf is null, this means we called this
1047 ;; non-interactively, in which case don't ask questions
1049 (cond ((not buffer-read-only)
1050 (setq toggle-ro-cmd 'toggle-read-only))
1051 ((and (or (beep 1) t) ; always beep
1054 "File %s is under version control. Check it out? "
1055 (ediff-abbreviate-file-name file))))
1056 ;; if we checked the file out, we should also change the
1057 ;; original state of buffer-read-only to nil. If we don't
1058 ;; do this, the mode line will show %%, since the file was
1059 ;; RO before ediff started, so the user will think the file
1061 (ediff-with-current-buffer ctl-buf
1062 (ediff-change-saved-variable
1063 'buffer-read-only nil buf-type)))
1065 (setq toggle-ro-cmd 'toggle-read-only)
1068 "Boy, this is risky! Don't modify this file...")
1069 (sit-for 3)))) ; let the user see the warning
1070 (if (and toggle-ro-cmd
1071 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1073 (save-window-excursion
1074 (select-window (ediff-get-visible-buffer-window buf))
1075 (command-execute toggle-ro-cmd)))
1076 (error "Don't know how to toggle read-only in buffer %S" buf))
1078 ;; Check if we made the current buffer updatable, but its file is RO.
1079 ;; Signal a warning in this case.
1080 (if (and file (not buffer-read-only)
1081 (eq this-command 'ediff-toggle-read-only)
1082 (file-exists-p file)
1083 (not (file-writable-p file)))
1086 (message "Warning: file %s is read-only"
1087 (ediff-abbreviate-file-name file))))
1090 ;; checkout if visited file is checked in
1091 (defun ediff-maybe-checkout (buf)
1092 (let ((file (expand-file-name (buffer-file-name buf)))
1093 (checkout-function (key-binding "\C-x\C-q")))
1094 (if (and (ediff-file-checked-in-p file)
1098 "File %s is under version control. Check it out? "
1099 (ediff-abbreviate-file-name file))))
1100 (ediff-with-current-buffer buf
1101 (command-execute checkout-function)))))
1104 ;; This is a simple-minded check for whether a file is under version control.
1105 ;; If file,v exists but file doesn't, this file is considered to be not checked
1106 ;; in and not checked out for the purpose of patching (since patch won't be
1107 ;; able to read such a file anyway).
1108 ;; FILE is a string representing file name
1109 ;;(defun ediff-file-under-version-control (file)
1110 ;; (let* ((filedir (file-name-directory file))
1111 ;; (file-nondir (file-name-nondirectory file))
1112 ;; (trial (concat file-nondir ",v"))
1113 ;; (full-trial (concat filedir trial))
1114 ;; (full-rcs-trial (concat filedir "RCS/" trial)))
1115 ;; (and (stringp file)
1116 ;; (file-exists-p file)
1119 ;; (file-exists-p full-trial)
1120 ;; ;; in FAT FS, `file,v' and `file' may turn out to be the same!
1121 ;; ;; don't be fooled by this!
1122 ;; (not (equal (file-attributes file)
1123 ;; (file-attributes full-trial))))
1124 ;; ;; check if a version is in RCS/ directory
1125 ;; (file-exists-p full-rcs-trial)))
1129 (defsubst ediff-file-checked-out-p (file)
1130 (or (not (featurep 'vc-hooks))
1131 (and (vc-backend file)
1132 (if (fboundp 'vc-state)
1133 (or (memq (vc-state file) '(edited needs-merge))
1134 (stringp (vc-state file)))
1135 ;; XEmacs has no vc-state
1136 (vc-locking-user file))
1139 (defsubst ediff-file-checked-in-p (file)
1140 (and (featurep 'vc-hooks)
1141 ;; CVS files are considered not checked in
1142 (not (memq (vc-backend file) '(nil CVS)))
1143 (if (fboundp 'vc-state)
1145 (not (memq (vc-state file) '(edited needs-merge)))
1146 (not (stringp (vc-state file))))
1147 ;; XEmacs has no vc-state
1148 (not (vc-locking-user file)))
1151 (defun ediff-file-compressed-p (file)
1153 (require 'jka-compr)
1155 (if (featurep 'jka-compr)
1156 (string-match (jka-compr-build-file-regexp) file)))
1159 (defun ediff-swap-buffers ()
1160 "Rotate the display of buffers A, B, and C."
1162 (ediff-barf-if-not-control-buffer)
1163 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1164 (let ((buf ediff-buffer-A)
1165 (values ediff-buffer-values-orig-A)
1166 (diff-vec ediff-difference-vector-A)
1167 (hide-regexp ediff-regexp-hide-A)
1168 (focus-regexp ediff-regexp-focus-A)
1169 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1170 (overlay (if (ediff-has-face-support-p)
1171 ediff-current-diff-overlay-A)))
1172 (if ediff-3way-comparison-job
1174 (set-window-buffer ediff-window-A ediff-buffer-C)
1175 (set-window-buffer ediff-window-B ediff-buffer-A)
1176 (set-window-buffer ediff-window-C ediff-buffer-B)
1178 (set-window-buffer ediff-window-A ediff-buffer-B)
1179 (set-window-buffer ediff-window-B ediff-buffer-A))
1180 ;; swap diff buffers
1181 (if ediff-3way-comparison-job
1182 (setq ediff-buffer-A ediff-buffer-C
1183 ediff-buffer-C ediff-buffer-B
1185 (setq ediff-buffer-A ediff-buffer-B
1186 ediff-buffer-B buf))
1188 ;; swap saved buffer characteristics
1189 (if ediff-3way-comparison-job
1190 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1191 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1192 ediff-buffer-values-orig-B values)
1193 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1194 ediff-buffer-values-orig-B values))
1196 ;; swap diff vectors
1197 (if ediff-3way-comparison-job
1198 (setq ediff-difference-vector-A ediff-difference-vector-C
1199 ediff-difference-vector-C ediff-difference-vector-B
1200 ediff-difference-vector-B diff-vec)
1201 (setq ediff-difference-vector-A ediff-difference-vector-B
1202 ediff-difference-vector-B diff-vec))
1204 ;; swap hide/focus regexp
1205 (if ediff-3way-comparison-job
1206 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1207 ediff-regexp-hide-C ediff-regexp-hide-B
1208 ediff-regexp-hide-B hide-regexp
1209 ediff-regexp-focus-A ediff-regexp-focus-C
1210 ediff-regexp-focus-C ediff-regexp-focus-B
1211 ediff-regexp-focus-B focus-regexp)
1212 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1213 ediff-regexp-hide-B hide-regexp
1214 ediff-regexp-focus-A ediff-regexp-focus-B
1215 ediff-regexp-focus-B focus-regexp))
1217 ;; The following is needed for XEmacs, since there one can't move
1218 ;; overlay to another buffer. In Emacs, this swap is redundant.
1219 (if (ediff-has-face-support-p)
1220 (if ediff-3way-comparison-job
1221 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1222 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1223 ediff-current-diff-overlay-B overlay)
1224 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1225 ediff-current-diff-overlay-B overlay)))
1228 (setq ediff-wide-bounds
1229 (cond (ediff-3way-comparison-job
1230 (list (nth 2 ediff-wide-bounds)
1231 (nth 0 ediff-wide-bounds)
1232 (nth 1 ediff-wide-bounds)))
1234 (list (nth 1 ediff-wide-bounds)
1235 (nth 0 ediff-wide-bounds)
1236 (nth 2 ediff-wide-bounds)))
1238 (list (nth 1 ediff-wide-bounds)
1239 (nth 0 ediff-wide-bounds)))))
1240 ;; swap narrow bounds
1241 (setq ediff-narrow-bounds
1242 (cond (ediff-3way-comparison-job
1243 (list (nth 2 ediff-narrow-bounds)
1244 (nth 0 ediff-narrow-bounds)
1245 (nth 1 ediff-narrow-bounds)))
1247 (list (nth 1 ediff-narrow-bounds)
1248 (nth 0 ediff-narrow-bounds)
1249 (nth 2 ediff-narrow-bounds)))
1251 (list (nth 1 ediff-narrow-bounds)
1252 (nth 0 ediff-narrow-bounds)))))
1253 (if wide-visibility-p
1254 (setq ediff-visible-bounds ediff-wide-bounds)
1255 (setq ediff-visible-bounds ediff-narrow-bounds))
1258 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1259 (ediff-recenter 'no-rehighlight)
1263 (defun ediff-toggle-wide-display ()
1264 "Toggle wide/regular display.
1265 This is especially useful when comparing buffers side-by-side."
1267 (ediff-barf-if-not-control-buffer)
1268 (or (ediff-window-display-p)
1269 (error "%sEmacs is not running as a window application"
1270 (if ediff-emacs-p "" "X")))
1271 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1272 (let ((ctl-buf ediff-control-buffer))
1273 (setq ediff-wide-display-p (not ediff-wide-display-p))
1274 (if (not ediff-wide-display-p)
1275 (ediff-with-current-buffer ctl-buf
1276 (modify-frame-parameters
1277 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1278 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1279 ;; restore control buf, since ctl window may have been deleted
1281 (set-buffer ctl-buf)
1282 (setq ediff-wide-display-orig-parameters nil
1283 ediff-window-B nil) ; force update of window config
1284 (ediff-recenter 'no-rehighlight))
1285 (funcall ediff-make-wide-display-function)
1286 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1287 (ediff-with-current-buffer ctl-buf
1288 (setq ediff-window-B nil) ; force update of window config
1289 (ediff-recenter 'no-rehighlight)))))
1292 (defun ediff-toggle-multiframe ()
1293 "Switch from multiframe display to single-frame display and back.
1294 To change the default, set the variable `ediff-window-setup-function',
1297 (let (window-setup-func)
1298 (or (ediff-window-display-p)
1299 (error "%sEmacs is not running as a window application"
1300 (if ediff-emacs-p "" "X")))
1302 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1303 (setq window-setup-func 'ediff-setup-windows-plain))
1304 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1305 (if (ediff-in-control-buffer-p)
1306 (ediff-kill-bottom-toolbar))
1307 (setq window-setup-func 'ediff-setup-windows-multiframe)))
1310 (setq-default ediff-window-setup-function window-setup-func)
1311 ;; change in all active ediff sessions
1312 (mapcar (lambda(buf) (ediff-with-current-buffer buf
1313 (setq ediff-window-setup-function window-setup-func
1314 ediff-window-B nil)))
1315 ediff-session-registry)
1316 (if (ediff-in-control-buffer-p)
1317 (ediff-recenter 'no-rehighlight))))
1321 (defun ediff-toggle-use-toolbar ()
1322 "Enable or disable Ediff toolbar.
1323 Works only in versions of Emacs that support toolbars.
1324 To change the default, set the variable `ediff-use-toolbar-p', which see."
1326 (if (featurep 'ediff-tbar)
1328 (or (ediff-window-display-p)
1329 (error "%sEmacs is not running as a window application"
1330 (if ediff-emacs-p "" "X")))
1331 (if (ediff-use-toolbar-p)
1332 (ediff-kill-bottom-toolbar))
1333 ;; do this only after killing the toolbar
1334 (setq ediff-use-toolbar-p (not ediff-use-toolbar-p))
1336 (mapcar (lambda(buf)
1337 (ediff-with-current-buffer buf
1339 (setq ediff-window-config-saved "")
1341 ediff-session-registry)
1342 (if (ediff-in-control-buffer-p)
1343 (ediff-recenter 'no-rehighlight)))))
1346 ;; if was using toolbar, kill it
1347 (defun ediff-kill-bottom-toolbar ()
1348 ;; Using ctl-buffer or ediff-control-window for LOCALE does not
1349 ;; work properly in XEmacs 19.14: we have to use
1351 ;; The problem with this is that any previous bottom-toolbar
1352 ;; will not re-appear after our cleanup here. Is there a way
1353 ;; to do "push" and "pop" toolbars ? --marcpa
1354 (if (ediff-use-toolbar-p)
1355 (ediff-cond-compile-for-xemacs-or-emacs
1357 (set-specifier bottom-toolbar (list (selected-frame) nil))
1358 (set-specifier bottom-toolbar-visible-p (list (selected-frame) nil)))
1363 ;; If wants to use toolbar, make it.
1364 ;; If not, zero the toolbar for XEmacs.
1365 ;; Do nothing for Emacs.
1366 (defun ediff-make-bottom-toolbar (&optional frame)
1367 (if (ediff-window-display-p)
1369 (setq frame (or frame (selected-frame)))
1370 (cond ((ediff-use-toolbar-p) ; this checks for XEmacs
1371 (ediff-cond-compile-for-xemacs-or-emacs
1375 (list frame (if (ediff-3way-comparison-job)
1376 ediff-toolbar-3way ediff-toolbar)))
1377 (set-specifier bottom-toolbar-visible-p (list frame t))
1378 (set-specifier bottom-toolbar-height
1379 (list frame ediff-toolbar-height)))
1383 ((ediff-has-toolbar-support-p)
1384 (ediff-cond-compile-for-xemacs-or-emacs
1385 (set-specifier bottom-toolbar-height (list frame 0)) ; xemacs
1394 (defun ediff-toggle-show-clashes-only ()
1395 "Toggle the mode that shows only the merge regions where both variants differ from the ancestor."
1397 (ediff-barf-if-not-control-buffer)
1398 (if (not ediff-merge-with-ancestor-job)
1399 (error "This command makes sense only when merging with an ancestor"))
1400 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1401 (if ediff-show-clashes-only
1402 (message "Focus on regions where both buffers differ from the ancestor")
1403 (message "Canceling focus on regions where changes clash")))
1405 (defun ediff-toggle-skip-changed-regions ()
1406 "Toggle the mode that skips the merge regions that differ from the default."
1408 (ediff-barf-if-not-control-buffer)
1409 (setq ediff-skip-merge-regions-that-differ-from-default
1410 (not ediff-skip-merge-regions-that-differ-from-default))
1411 (if ediff-skip-merge-regions-that-differ-from-default
1412 (message "Skipping regions that differ from default setting")
1413 (message "Showing regions that differ from default setting")))
1417 ;; Widening/narrowing
1419 (defun ediff-toggle-narrow-region ()
1420 "Toggle narrowing in buffers A, B, and C.
1421 Used in ediff-windows/regions only."
1423 (if (eq ediff-buffer-A ediff-buffer-B)
1424 (error ediff-NO-DIFFERENCES))
1425 (if (eq ediff-visible-bounds ediff-wide-bounds)
1426 (setq ediff-visible-bounds ediff-narrow-bounds)
1427 (setq ediff-visible-bounds ediff-wide-bounds))
1428 (ediff-recenter 'no-rehighlight))
1430 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1431 ;; ediff-wide-bounds, then this actually widens.
1432 ;; This function does nothing if job-name is not
1433 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1434 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1435 ;; to two different regions in one buffer.
1436 (defun ediff-visible-region ()
1437 (if (or (eq ediff-buffer-A ediff-buffer-B)
1438 (eq ediff-buffer-A ediff-buffer-C)
1439 (eq ediff-buffer-C ediff-buffer-B))
1441 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1442 ;; Otherwise, always use full range.
1443 (if (not ediff-narrow-job)
1444 (setq ediff-visible-bounds ediff-wide-bounds))
1445 (let ((overl-A (ediff-get-value-according-to-buffer-type
1446 'A ediff-visible-bounds))
1447 (overl-B (ediff-get-value-according-to-buffer-type
1448 'B ediff-visible-bounds))
1449 (overl-C (ediff-get-value-according-to-buffer-type
1450 'C ediff-visible-bounds))
1452 (ediff-with-current-buffer ediff-buffer-A
1453 (if (ediff-overlay-buffer overl-A)
1455 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A))))
1456 (ediff-with-current-buffer ediff-buffer-B
1457 (if (ediff-overlay-buffer overl-B)
1459 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B))))
1461 (if (and ediff-3way-job (ediff-overlay-buffer overl-C))
1462 (ediff-with-current-buffer ediff-buffer-C
1464 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1468 ;; Window scrolling operations
1470 ;; Performs some operation on the two file windows (if they are showing).
1471 ;; Traps all errors on the operation in windows A/B/C.
1472 ;; Usually, errors come from scrolling off the
1473 ;; beginning or end of the buffer, and this gives error messages.
1474 (defun ediff-operate-on-windows (operation arg)
1476 ;; make sure windows aren't dead
1477 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1478 (ediff-recenter 'no-rehighlight))
1479 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1480 (ediff-buffer-live-p ediff-buffer-B)
1481 (or (not ediff-3way-job) ediff-buffer-C)
1483 (error ediff-KILLED-VITAL-BUFFER))
1485 (let* ((wind (selected-window))
1486 (wind-A ediff-window-A)
1487 (wind-B ediff-window-B)
1488 (wind-C ediff-window-C)
1489 (coefA (ediff-get-region-size-coefficient 'A operation))
1490 (coefB (ediff-get-region-size-coefficient 'B operation))
1491 (three-way ediff-3way-job)
1492 (coefC (if three-way
1493 (ediff-get-region-size-coefficient 'C operation))))
1495 (select-window wind-A)
1497 (funcall operation (round (* coefA arg)))
1499 (select-window wind-B)
1501 (funcall operation (round (* coefB arg)))
1505 (select-window wind-C)
1507 (funcall operation (round (* coefC arg)))
1509 (select-window wind)))
1511 (defun ediff-scroll-vertically (&optional arg)
1512 "Vertically scroll buffers A, B \(and C if appropriate\).
1513 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1514 the one half of the height of window-A."
1516 (ediff-barf-if-not-control-buffer)
1518 ;; make sure windows aren't dead
1519 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1520 (ediff-recenter 'no-rehighlight))
1521 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1522 (ediff-buffer-live-p ediff-buffer-B)
1523 (or (not ediff-3way-job)
1524 (ediff-buffer-live-p ediff-buffer-C))
1526 (error ediff-KILLED-VITAL-BUFFER))
1528 (ediff-operate-on-windows
1529 (if (memq last-command-char '(?v ?\C-v))
1532 ;; calculate argument to scroll-up/down
1533 ;; if there is an explicit argument
1534 (if (and arg (not (equal arg '-)))
1536 (prefix-numeric-value arg)
1537 ;; if not, see if we can determine a default amount (the window height)
1538 (let (default-amount)
1539 (setq default-amount
1540 (- (/ (min (window-height ediff-window-A)
1541 (window-height ediff-window-B)
1543 (window-height ediff-window-C)
1544 500)) ; some large number
1546 1 next-screen-context-lines))
1549 ;; C-u as argument means half of default amount
1550 (/ default-amount 2)
1551 ;; no argument means default amount
1555 (defun ediff-scroll-horizontally (&optional arg)
1556 "Horizontally scroll buffers A, B \(and C if appropriate\).
1557 If an argument is given, that is how many columns are scrolled, else nearly
1558 the width of the A/B/C windows."
1560 (ediff-barf-if-not-control-buffer)
1562 ;; make sure windows aren't dead
1563 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1564 (ediff-recenter 'no-rehighlight))
1565 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1566 (ediff-buffer-live-p ediff-buffer-B)
1567 (or (not ediff-3way-job)
1568 (ediff-buffer-live-p ediff-buffer-C))
1570 (error ediff-KILLED-VITAL-BUFFER))
1572 (ediff-operate-on-windows
1573 ;; Arrange for scroll-left and scroll-right being called
1574 ;; interactively so that they set the window's min_hscroll.
1575 ;; Otherwise, automatic hscrolling will undo the effect of
1577 (if (= last-command-char ?<)
1579 (let ((prefix-arg arg))
1580 (call-interactively 'scroll-left)))
1582 (let ((prefix-arg arg))
1583 (call-interactively 'scroll-right))))
1584 ;; calculate argument to scroll-left/right
1585 ;; if there is an explicit argument
1586 (if (and arg (not (equal arg '-)))
1588 (prefix-numeric-value arg)
1589 ;; if not, see if we can determine a default amount
1590 ;; (half the window width)
1591 (if (null ediff-control-window)
1592 ;; no control window, use nil
1594 (let ((default-amount
1595 (- (/ (min (window-width ediff-window-A)
1596 (window-width ediff-window-B)
1597 (if ediff-3way-comparison-job
1598 (window-width ediff-window-C)
1599 500) ; some large number
1605 ;; C-u as argument means half of default amount
1606 (/ default-amount 2)
1607 ;; no argument means default amount
1608 default-amount))))))
1611 ;;BEG, END show the region to be positioned.
1612 ;;JOB-NAME holds ediff-job-name. The ediff-windows job positions regions
1614 (defun ediff-position-region (beg end pos job-name)
1615 (if (> end (point-max))
1616 (setq end (point-max)))
1617 (if ediff-windows-job
1618 (if (pos-visible-in-window-p end)
1619 () ; do nothing, wind is already positioned
1620 ;; at this point, windows are positioned at the beginning of the
1621 ;; file regions (not diff-regions) being compared.
1623 (move-to-window-line (- (window-height) 2))
1624 (let ((amount (+ 2 (count-lines (point) end))))
1625 (scroll-up amount))))
1626 (set-window-start (selected-window) beg)
1627 (if (pos-visible-in-window-p end)
1628 ;; Determine the number of lines that the region occupies
1631 (while ( and (> end (progn
1632 (move-to-window-line lines)
1634 ;; `end' may be beyond the window bottom, so check
1635 ;; that we are making progress
1636 (< prev-point (point)))
1637 (setq prev-point (point))
1638 (setq lines (1+ lines)))
1639 ;; And position the beginning on the right line
1641 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1649 ;; get number of lines from window start to region end
1650 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1651 (or n (setq n ediff-current-difference))
1652 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1653 (ediff-with-current-buffer ctl-buf
1654 (let* ((buf (ediff-get-buffer buf-type))
1655 (wind (eval (ediff-get-symbol-from-alist
1656 buf-type ediff-window-alist)))
1657 (beg (window-start wind))
1658 (end (ediff-get-diff-posn buf-type 'end))
1660 (ediff-with-current-buffer buf
1662 (setq lines (count-lines beg end))
1667 ;; Calculate the number of lines from window end to the start of diff region
1668 (defun ediff-get-lines-to-region-start (buf-type &optional diff-num ctl-buf)
1669 (or diff-num (setq diff-num ediff-current-difference))
1670 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1671 (ediff-with-current-buffer ctl-buf
1672 (let* ((buf (ediff-get-buffer buf-type))
1673 (wind (eval (ediff-get-symbol-from-alist
1674 buf-type ediff-window-alist)))
1675 (end (or (window-end wind) (window-end wind t)))
1676 (beg (ediff-get-diff-posn buf-type 'beg diff-num)))
1677 (ediff-with-current-buffer buf
1679 (count-lines (max beg (point-min)) (min end (point-max))) 0))
1683 ;; region size coefficient is a coefficient by which to adjust scrolling
1684 ;; up/down of the window displaying buffer of type BUFTYPE.
1685 ;; The purpose of this coefficient is to make the windows scroll in sync, so
1686 ;; that it won't happen that one diff region is scrolled off while the other is
1689 ;; If the difference region is invalid, the coefficient is 1
1690 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1691 (ediff-with-current-buffer (or ctl-buf ediff-control-buffer)
1692 (if (ediff-valid-difference-p n)
1693 (let* ((func (cond ((eq op 'scroll-down)
1694 'ediff-get-lines-to-region-start)
1696 'ediff-get-lines-to-region-end)
1697 (t '(lambda (a b c) 0))))
1698 (max-lines (max (funcall func 'A n ctl-buf)
1699 (funcall func 'B n ctl-buf)
1700 (if (ediff-buffer-live-p ediff-buffer-C)
1701 (funcall func 'C n ctl-buf)
1703 ;; this covers the horizontal coefficient as well:
1704 ;; if max-lines = 0 then coef = 1
1706 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1712 (defun ediff-next-difference (&optional arg)
1713 "Advance to the next difference.
1714 With a prefix argument, go forward that many differences."
1716 (ediff-barf-if-not-control-buffer)
1717 (if (< ediff-current-difference ediff-number-of-differences)
1718 (let ((n (min ediff-number-of-differences
1719 (+ ediff-current-difference (or arg 1))))
1720 non-clash-skip skip-changed regexp-skip)
1722 (ediff-visible-region)
1723 (or (>= n ediff-number-of-differences)
1724 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1725 ;; this won't exec if regexp-skip is t
1726 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1728 (ediff-skip-merge-region-if-changed-from-default-p n))
1729 (ediff-install-fine-diff-if-necessary n))
1731 (while (and (< n ediff-number-of-differences)
1735 ;; skip clashes, if necessary
1737 ;; skip processed regions
1739 ;; skip difference regions that differ in white space
1740 (and ediff-ignore-similar-regions
1741 (or (eq (ediff-no-fine-diffs-p n) t)
1742 (and (ediff-merge-job)
1743 (eq (ediff-no-fine-diffs-p n) 'C)))
1746 (if (= 0 (mod n 20))
1747 (message "Skipped over region %d and counting ..." n))
1748 (or (>= n ediff-number-of-differences)
1749 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1750 ;; this won't exec if regexp-skip is t
1751 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1753 (ediff-skip-merge-region-if-changed-from-default-p n))
1754 (ediff-install-fine-diff-if-necessary n))
1757 (ediff-unselect-and-select-difference n)
1759 (ediff-visible-region)
1760 (error "At end of the difference list")))
1762 (defun ediff-previous-difference (&optional arg)
1763 "Go to the previous difference.
1764 With a prefix argument, go back that many differences."
1766 (ediff-barf-if-not-control-buffer)
1767 (if (> ediff-current-difference -1)
1768 (let ((n (max -1 (- ediff-current-difference (or arg 1))))
1769 non-clash-skip skip-changed regexp-skip)
1771 (ediff-visible-region)
1773 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1774 ;; this won't exec if regexp-skip is t
1775 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1777 (ediff-skip-merge-region-if-changed-from-default-p n))
1778 (ediff-install-fine-diff-if-necessary n))
1779 (while (and (> n -1)
1783 ;; skip clashes, if necessary
1785 ;; skipp changed regions
1787 ;; skip difference regions that differ in white space
1788 (and ediff-ignore-similar-regions
1789 (or (eq (ediff-no-fine-diffs-p n) t)
1790 (and (ediff-merge-job)
1791 (eq (ediff-no-fine-diffs-p n) 'C)))
1793 (if (= 0 (mod (1+ n) 20))
1794 (message "Skipped over region %d and counting ..." (1+ n)))
1797 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1798 ;; this won't exec if regexp-skip is t
1799 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1801 (ediff-skip-merge-region-if-changed-from-default-p n))
1802 (ediff-install-fine-diff-if-necessary n))
1805 (ediff-unselect-and-select-difference n)
1807 (ediff-visible-region)
1808 (error "At beginning of the difference list")))
1810 ;; The diff number is as perceived by the user (i.e., 1+ the internal
1812 (defun ediff-jump-to-difference (difference-number)
1813 "Go to the difference specified as a prefix argument.
1814 If the prefix is negative, count differences from the end."
1816 (ediff-barf-if-not-control-buffer)
1817 (setq difference-number
1818 (cond ((< difference-number 0)
1819 (+ ediff-number-of-differences difference-number))
1820 ((> difference-number 0) (1- difference-number))
1822 ;; -1 is allowed by ediff-unselect-and-select-difference --- it is the
1823 ;; position before the first one.
1824 (if (and (>= difference-number -1)
1825 (<= difference-number ediff-number-of-differences))
1826 (ediff-unselect-and-select-difference difference-number)
1827 (error ediff-BAD-DIFF-NUMBER
1828 this-command (1+ difference-number) ediff-number-of-differences)))
1830 (defun ediff-jump-to-difference-at-point (arg)
1831 "Go to difference closest to the point in buffer A, B, or C.
1832 The buffer depends on last command character \(a, b, or c\) that invoked this
1833 command. For instance, if the command was `ga' then the point value in buffer
1835 With a prefix argument, synchronize all files around the current point position
1836 in the specified buffer."
1838 (ediff-barf-if-not-control-buffer)
1839 (let* ((buf-type (ediff-char-to-buftype last-command-char))
1840 (buffer (ediff-get-buffer buf-type))
1841 (pt (ediff-with-current-buffer buffer (point)))
1842 (diff-no (ediff-diff-at-point buf-type nil (if arg 'after)))
1843 (past-last-diff (< ediff-number-of-differences diff-no))
1844 (beg (if past-last-diff
1845 (ediff-with-current-buffer buffer (point-max))
1846 (ediff-get-diff-posn buf-type 'beg (1- diff-no))))
1847 ctl-wind wind-A wind-B wind-C
1850 (ediff-jump-to-difference -1)
1851 (ediff-jump-to-difference diff-no))
1852 (setq ctl-wind (selected-window)
1853 wind-A ediff-window-A
1854 wind-B ediff-window-B
1855 wind-C ediff-window-C)
1858 (ediff-with-current-buffer buffer
1859 (setq shift (- beg pt)))
1860 (select-window wind-A)
1861 (if past-last-diff (goto-char (point-max)))
1863 (backward-char shift) ; noerror, if beginning of buffer
1866 (select-window wind-B)
1867 (if past-last-diff (goto-char (point-max)))
1869 (backward-char shift) ; noerror, if beginning of buffer
1872 (if (window-live-p wind-C)
1874 (select-window wind-C)
1875 (if past-last-diff (goto-char (point-max)))
1877 (backward-char shift) ; noerror, if beginning of buffer
1881 (select-window ctl-wind)
1886 ;; find region most related to the current point position (or POS, if given)
1887 ;; returns diff number as seen by the user (i.e., 1+ the internal
1889 ;; The optional argument WHICH-DIFF can be `after' or `before'. If `after',
1890 ;; find the diff after the point. If `before', find the diff before the
1891 ;; point. If the point is inside a diff, return that diff.
1892 (defun ediff-diff-at-point (buf-type &optional pos which-diff)
1893 (let ((buffer (ediff-get-buffer buf-type))
1894 (ctl-buffer ediff-control-buffer)
1895 (max-dif-num (1- ediff-number-of-differences))
1902 (ediff-with-current-buffer buffer
1903 (setq pos (or pos (point)))
1904 (while (and (or (< pos prev-beg) (> pos beg))
1905 (< diff-no max-dif-num))
1906 (setq diff-no (1+ diff-no))
1909 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1910 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1913 ;; boost diff-no by 1, if past the last diff region
1914 (if (and (memq which-diff '(after before))
1915 (> pos beg) (= diff-no max-dif-num))
1916 (setq diff-no (1+ diff-no)))
1918 (cond ((eq which-diff 'after) (1+ diff-no))
1919 ((eq which-diff 'before) diff-no)
1920 ((< (abs (count-lines pos (max 1 prev-end)))
1921 (abs (count-lines pos (max 1 beg))))
1922 diff-no) ; choose prev difference
1924 (1+ diff-no))) ; choose next difference
1930 (defun ediff-diff-to-diff (arg &optional keys)
1931 "Copy buffer-X'th difference region to buffer Y \(X,Y are A, B, or C\).
1932 If numerical prefix argument, copy the difference specified in the arg.
1933 Otherwise, copy the difference given by `ediff-current-difference'.
1934 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1935 `ac', etc., which is used to determine the types of buffers to be used for
1936 copying difference regions. The first character in the sequence specifies
1937 the source buffer and the second specifies the target.
1939 If the second optional argument, a 2-character string, is given, use it to
1940 determine the source and the target buffers instead of the command keys."
1942 (ediff-barf-if-not-control-buffer)
1943 (or keys (setq keys (this-command-keys)))
1944 (if (eq arg '-) (setq arg -1)) ; translate neg arg to -1
1945 (if (numberp arg) (ediff-jump-to-difference arg))
1947 (let* ((key1 (aref keys 0))
1948 (key2 (aref keys 1))
1949 (char1 (ediff-event-key key1))
1950 (char2 (ediff-event-key key2))
1952 (ediff-copy-diff ediff-current-difference
1953 (ediff-char-to-buftype char1)
1954 (ediff-char-to-buftype char2))
1955 ;; recenter with rehighlighting, but no messages
1958 (defun ediff-copy-A-to-B (arg)
1959 "Copy ARGth difference region from buffer A to B.
1960 ARG is a prefix argument. If nil, copy the current difference region."
1962 (ediff-diff-to-diff arg "ab"))
1964 (defun ediff-copy-B-to-A (arg)
1965 "Copy ARGth difference region from buffer B to A.
1966 ARG is a prefix argument. If nil, copy the current difference region."
1968 (ediff-diff-to-diff arg "ba"))
1970 (defun ediff-copy-A-to-C (arg)
1971 "Copy ARGth difference region from buffer A to buffer C.
1972 ARG is a prefix argument. If nil, copy the current difference region."
1974 (ediff-diff-to-diff arg "ac"))
1976 (defun ediff-copy-B-to-C (arg)
1977 "Copy ARGth difference region from buffer B to buffer C.
1978 ARG is a prefix argument. If nil, copy the current difference region."
1980 (ediff-diff-to-diff arg "bc"))
1982 (defun ediff-copy-C-to-B (arg)
1983 "Copy ARGth difference region from buffer C to B.
1984 ARG is a prefix argument. If nil, copy the current difference region."
1986 (ediff-diff-to-diff arg "cb"))
1988 (defun ediff-copy-C-to-A (arg)
1989 "Copy ARGth difference region from buffer C to A.
1990 ARG is a prefix argument. If nil, copy the current difference region."
1992 (ediff-diff-to-diff arg "ca"))
1996 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1997 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1998 ;; target diff. This is used in merging, when constructing the merged
2000 (defun ediff-copy-diff (n from-buf-type to-buf-type
2001 &optional batch-invocation reg-to-copy)
2002 (let* ((to-buf (ediff-get-buffer to-buf-type))
2003 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
2004 (ctrl-buf ediff-control-buffer)
2006 (three-way ediff-3way-job)
2009 reg-to-delete reg-to-delete-beg reg-to-delete-end)
2011 (setq reg-to-delete-beg
2012 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
2013 (setq reg-to-delete-end
2014 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
2017 (setq from-buf-type nil)
2018 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
2020 (setq reg-to-delete (ediff-get-region-contents
2021 n to-buf-type ctrl-buf
2022 reg-to-delete-beg reg-to-delete-end))
2024 (if (string= reg-to-delete reg-to-copy)
2025 (setq saved-p nil) ; don't copy identical buffers
2027 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
2028 (condition-case conds
2030 (ediff-with-current-buffer to-buf
2031 ;; to prevent flags from interfering if buffer is writable
2032 (let ((inhibit-read-only (null buffer-read-only)))
2034 (goto-char reg-to-delete-end)
2035 (insert reg-to-copy)
2037 (if (> reg-to-delete-end reg-to-delete-beg)
2038 (kill-region reg-to-delete-beg reg-to-delete-end))
2040 (or batch-invocation
2043 (ediff-save-diff-region n to-buf-type reg-to-delete))))
2044 (error (message "ediff-copy-diff: %s %s"
2046 (mapconcat 'prin1-to-string (cdr conds) " "))
2048 (sit-for 2) ; let the user see the error msg
2053 ;; adjust state of difference in case 3-way and diff was copied ok
2054 (if (and saved-p three-way)
2055 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
2057 (if batch-invocation
2058 (ediff-clear-fine-differences n)
2059 ;; If diff3 job, we should recompute fine diffs so we clear them
2060 ;; before reinserting flags (and thus before ediff-recenter).
2061 (if (and saved-p three-way)
2062 (ediff-clear-fine-differences n))
2064 (ediff-refresh-mode-lines)
2066 ;; For diff2 jobs, don't recompute fine diffs, since we know there
2067 ;; aren't any. So we clear diffs after ediff-recenter.
2068 (if (and saved-p (not three-way))
2069 (ediff-clear-fine-differences n))
2070 ;; Make sure that the message about saving and how to restore is seen
2075 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
2076 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
2077 ;; is the region to save. It is redundant here, but is passed anyway, for
2079 (defun ediff-save-diff-region (n buf-type reg)
2080 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
2081 (buf (ediff-get-buffer buf-type))
2082 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
2084 (if this-buf-n-th-diff-saved
2085 ;; either nothing saved for n-th diff and buffer or we OK'ed
2087 (setcdr this-buf-n-th-diff-saved reg)
2088 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
2089 (nconc n-th-diff-saved (list (cons buf reg)))
2090 (setq ediff-killed-diffs-alist ;; create record for n-th diff
2091 (cons (list n (cons buf reg))
2092 ediff-killed-diffs-alist))))
2093 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
2096 "" (downcase (symbol-name buf-type))))
2099 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
2100 (defun ediff-test-save-region (n buf-type)
2101 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
2102 (buf (ediff-get-buffer buf-type))
2103 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
2105 (if this-buf-n-th-diff-saved
2108 "You've previously copied diff region %d to buffer %S. Confirm "
2114 (defun ediff-pop-diff (n buf-type)
2115 "Pop last killed Nth diff region from buffer BUF-TYPE."
2116 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
2117 (buf (ediff-get-buffer buf-type))
2118 (saved-rec (assoc buf (cdr n-th-record)))
2119 (three-way ediff-3way-job)
2120 (ctl-buf ediff-control-buffer)
2122 saved-diff reg-beg reg-end recovered)
2125 (setq saved-diff (cdr saved-rec))
2126 (if (> ediff-number-of-differences 0)
2127 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
2128 (error ediff-NO-DIFFERENCES)))
2130 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
2131 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
2133 (condition-case conds
2134 (ediff-with-current-buffer buf
2135 (let ((inhibit-read-only (null buffer-read-only)))
2140 (if (> reg-end reg-beg)
2141 (kill-region reg-beg reg-end))
2145 (error (message "ediff-pop-diff: %s %s"
2147 (mapconcat 'prin1-to-string (cdr conds) " "))
2150 ;; Clearing fine diffs is necessary for
2151 ;; ediff-unselect-and-select-difference to properly recompute them. We
2152 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
2153 ;; have modified diff regions after copying and, thus, may have recomputed
2156 (ediff-clear-fine-differences n))
2158 ;; adjust state of difference
2159 (if (and three-way recovered)
2160 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
2162 (ediff-refresh-mode-lines)
2166 (setq n-th-record (delq saved-rec n-th-record))
2167 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
2171 (defun ediff-restore-diff (arg &optional key)
2172 "Restore ARGth diff from `ediff-killed-diffs-alist'.
2173 ARG is a prefix argument. If ARG is nil, restore the current-difference.
2174 If the second optional argument, a character, is given, use it to
2175 determine the target buffer instead of last-command-char"
2177 (ediff-barf-if-not-control-buffer)
2179 (ediff-jump-to-difference arg))
2180 (ediff-pop-diff ediff-current-difference
2181 (ediff-char-to-buftype (or key last-command-char)))
2182 ;; recenter with rehighlighting, but no messages
2183 (let (ediff-verbose-p)
2186 (defun ediff-restore-diff-in-merge-buffer (arg)
2187 "Restore ARGth diff in the merge buffer.
2188 ARG is a prefix argument. If nil, restore the current diff."
2190 (ediff-restore-diff arg ?c))
2193 (defun ediff-toggle-regexp-match ()
2194 "Toggle between focusing and hiding of difference regions that match
2195 a regular expression typed in by the user."
2197 (ediff-barf-if-not-control-buffer)
2201 msg-connective alt-msg-connective alt-connective)
2203 ((or (and (eq ediff-skip-diff-region-function
2204 ediff-focus-on-regexp-matches-function)
2205 (eq last-command-char ?f))
2206 (and (eq ediff-skip-diff-region-function
2207 ediff-hide-regexp-matches-function)
2208 (eq last-command-char ?h)))
2209 (message "Selective browsing by regexp turned off")
2210 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
2211 ((eq last-command-char ?h)
2212 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
2216 "Ignore A-regions matching this regexp (default \"%s\"): "
2217 ediff-regexp-hide-A))
2221 "Ignore B-regions matching this regexp (default \"%s\"): "
2222 ediff-regexp-hide-B)))
2223 (if ediff-3way-comparison-job
2227 "Ignore C-regions matching this regexp (default \"%s\"): "
2228 ediff-regexp-hide-C))))
2229 (if (eq ediff-hide-regexp-connective 'and)
2230 (setq msg-connective "BOTH"
2231 alt-msg-connective "ONE OF"
2233 (setq msg-connective "ONE OF"
2234 alt-msg-connective "BOTH"
2235 alt-connective 'and))
2238 "Ignore regions that match %s regexps, OK? "
2240 (message "Will ignore regions that match %s regexps" msg-connective)
2241 (setq ediff-hide-regexp-connective alt-connective)
2242 (message "Will ignore regions that match %s regexps"
2243 alt-msg-connective))
2245 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
2246 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
2247 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
2249 ((eq last-command-char ?f)
2250 (setq ediff-skip-diff-region-function
2251 ediff-focus-on-regexp-matches-function
2255 "Focus on A-regions matching this regexp (default \"%s\"): "
2256 ediff-regexp-focus-A))
2260 "Focus on B-regions matching this regexp (default \"%s\"): "
2261 ediff-regexp-focus-B)))
2262 (if ediff-3way-comparison-job
2266 "Focus on C-regions matching this regexp (default \"%s\"): "
2267 ediff-regexp-focus-C))))
2268 (if (eq ediff-focus-regexp-connective 'and)
2269 (setq msg-connective "BOTH"
2270 alt-msg-connective "ONE OF"
2272 (setq msg-connective "ONE OF"
2273 alt-msg-connective "BOTH"
2274 alt-connective 'and))
2277 "Focus on regions that match %s regexps, OK? "
2279 (message "Will focus on regions that match %s regexps"
2281 (setq ediff-focus-regexp-connective alt-connective)
2282 (message "Will focus on regions that match %s regexps"
2283 alt-msg-connective))
2285 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
2286 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
2287 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
2289 (defun ediff-toggle-skip-similar ()
2291 (ediff-barf-if-not-control-buffer)
2292 (if (not (eq ediff-auto-refine 'on))
2294 "Can't skip over whitespace regions: first turn auto-refining on"))
2295 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
2296 (if ediff-ignore-similar-regions
2298 "Skipping regions that differ only in white space & line breaks")
2299 (message "Skipping over white-space differences turned off")))
2301 (defun ediff-focus-on-regexp-matches (n)
2302 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
2303 Regions to be ignored according to this function are those where
2304 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
2305 doesn't match `ediff-regexp-focus-B'.
2306 This function returns nil if the region number N (specified as
2307 an argument) is not to be ignored and t if region N is to be ignored.
2309 N is a region number used by Ediff internally. It is 1 less
2310 the number seen by the user."
2311 (if (ediff-valid-difference-p n)
2312 (let* ((ctl-buf ediff-control-buffer)
2313 (regex-A ediff-regexp-focus-A)
2314 (regex-B ediff-regexp-focus-B)
2315 (regex-C ediff-regexp-focus-C)
2316 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2319 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2320 (ediff-get-diff-posn 'A 'end n ctl-buf))
2321 (goto-char (point-min))
2322 (re-search-forward regex-A nil t))))
2323 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2326 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2327 (ediff-get-diff-posn 'B 'end n ctl-buf))
2328 (re-search-forward regex-B nil t))))
2329 (reg-C-match (if ediff-3way-comparison-job
2330 (ediff-with-current-buffer ediff-buffer-C
2333 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2334 (ediff-get-diff-posn 'C 'end n ctl-buf))
2335 (re-search-forward regex-C nil t))))))
2336 (not (eval (if ediff-3way-comparison-job
2337 (list ediff-focus-regexp-connective
2338 reg-A-match reg-B-match reg-C-match)
2339 (list ediff-focus-regexp-connective
2340 reg-A-match reg-B-match))))
2343 (defun ediff-hide-regexp-matches (n)
2344 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2345 Regions to be ignored are those where buf A region matches
2346 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2347 This function returns nil if the region number N (specified as
2348 an argument) is not to be ignored and t if region N is to be ignored.
2350 N is a region number used by Ediff internally. It is 1 less
2351 the number seen by the user."
2352 (if (ediff-valid-difference-p n)
2353 (let* ((ctl-buf ediff-control-buffer)
2354 (regex-A ediff-regexp-hide-A)
2355 (regex-B ediff-regexp-hide-B)
2356 (regex-C ediff-regexp-hide-C)
2357 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2360 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2361 (ediff-get-diff-posn 'A 'end n ctl-buf))
2362 (goto-char (point-min))
2363 (re-search-forward regex-A nil t))))
2364 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2367 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2368 (ediff-get-diff-posn 'B 'end n ctl-buf))
2369 (goto-char (point-min))
2370 (re-search-forward regex-B nil t))))
2371 (reg-C-match (if ediff-3way-comparison-job
2372 (ediff-with-current-buffer ediff-buffer-C
2375 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2376 (ediff-get-diff-posn 'C 'end n ctl-buf))
2377 (goto-char (point-min))
2378 (re-search-forward regex-C nil t))))))
2379 (eval (if ediff-3way-comparison-job
2380 (list ediff-hide-regexp-connective
2381 reg-A-match reg-B-match reg-C-match)
2382 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2387 ;;; Quitting, suspending, etc.
2389 (defun ediff-quit (reverse-default-keep-variants)
2390 "Finish an Ediff session and exit Ediff.
2391 Unselects the selected difference, if any, restores the read-only and modified
2392 flags of the compared file buffers, kills Ediff buffers for this session
2393 \(but not buffers A, B, C\).
2395 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2396 containing the variants should be removed \(if they haven't been modified\).
2397 If it is t, they will be preserved unconditionally. A prefix argument,
2398 temporarily reverses the meaning of this variable."
2400 (ediff-barf-if-not-control-buffer)
2401 (let ((ctl-buf (current-buffer)))
2402 (if (y-or-n-p (format "Quit this Ediff session%s? "
2403 (if (ediff-buffer-live-p ediff-meta-buffer)
2404 " & show containing session group" "")))
2407 (set-buffer ctl-buf)
2408 (ediff-really-quit reverse-default-keep-variants))
2412 ;; Perform the quit operations.
2413 (defun ediff-really-quit (reverse-default-keep-variants)
2414 (ediff-unhighlight-diffs-totally)
2415 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2416 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2417 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2418 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2420 (ediff-delete-temp-files)
2422 ;; Restore the visibility range. This affects only ediff-*-regions/windows.
2423 ;; Since for other job names ediff-visible-region sets
2424 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2425 ;; ignored for such jobs.
2426 (if ediff-quit-widened
2427 (setq ediff-visible-bounds ediff-wide-bounds)
2428 (setq ediff-visible-bounds ediff-narrow-bounds))
2430 ;; Apply selective display to narrow or widen
2431 (ediff-visible-region)
2432 (mapcar (lambda (overl)
2433 (if (ediff-overlayp overl)
2434 (ediff-delete-overlay overl)))
2436 (mapcar (lambda (overl)
2437 (if (ediff-overlayp overl)
2438 (ediff-delete-overlay overl)))
2439 ediff-narrow-bounds)
2441 ;; restore buffer mode line id's in buffer-A/B/C
2442 (let ((control-buffer ediff-control-buffer)
2443 (meta-buffer ediff-meta-buffer)
2444 (after-quit-hook-internal ediff-after-quit-hook-internal)
2445 (session-number ediff-meta-session-number)
2446 ;; suitable working frame
2447 (warp-frame (if (and (ediff-window-display-p) (eq ediff-grab-mouse t))
2448 (cond ((window-live-p ediff-window-A)
2449 (window-frame ediff-window-A))
2450 ((window-live-p ediff-window-B)
2451 (window-frame ediff-window-B))
2452 (t (next-frame))))))
2454 (ediff-with-current-buffer ediff-buffer-A
2455 (setq ediff-this-buffer-ediff-sessions
2456 (delq control-buffer ediff-this-buffer-ediff-sessions))
2457 (kill-local-variable 'mode-line-buffer-identification)
2458 (kill-local-variable 'mode-line-format)
2463 (ediff-with-current-buffer ediff-buffer-B
2464 (setq ediff-this-buffer-ediff-sessions
2465 (delq control-buffer ediff-this-buffer-ediff-sessions))
2466 (kill-local-variable 'mode-line-buffer-identification)
2467 (kill-local-variable 'mode-line-format)
2472 (ediff-with-current-buffer ediff-buffer-C
2473 (setq ediff-this-buffer-ediff-sessions
2474 (delq control-buffer ediff-this-buffer-ediff-sessions))
2475 (kill-local-variable 'mode-line-buffer-identification)
2476 (kill-local-variable 'mode-line-format)
2481 (ediff-with-current-buffer ediff-ancestor-buffer
2482 (setq ediff-this-buffer-ediff-sessions
2483 (delq control-buffer ediff-this-buffer-ediff-sessions))
2484 (kill-local-variable 'mode-line-buffer-identification)
2485 (kill-local-variable 'mode-line-format)
2489 (setq ediff-session-registry
2490 (delq ediff-control-buffer ediff-session-registry))
2491 (ediff-update-registry)
2492 ;; restore state of buffers to what it was before ediff
2493 (ediff-restore-protected-variables)
2495 ;; If the user interrupts (canceling saving the merge buffer), continue
2498 (if (ediff-merge-job)
2499 (run-hooks 'ediff-quit-merge-hook))
2502 (run-hooks 'ediff-cleanup-hook)
2506 ;; reverse-default-keep-variants is t if the user quits with a prefix arg
2507 (if reverse-default-keep-variants
2508 (not ediff-keep-variants)
2509 ediff-keep-variants))
2511 ;; one hook here is ediff-cleanup-mess, which kills the control buffer and
2512 ;; other auxiliary buffers. we made it into a hook to let the users do their
2513 ;; own cleanup, if needed.
2514 (run-hooks 'ediff-quit-hook)
2515 (ediff-update-meta-buffer meta-buffer nil session-number)
2517 ;; warp mouse into a working window
2518 (setq warp-frame ; if mouse is over a reasonable frame, use it
2519 (cond ((ediff-good-frame-under-mouse))
2521 (if (and (ediff-window-display-p) (frame-live-p warp-frame) ediff-grab-mouse)
2522 (set-mouse-position (if ediff-emacs-p
2524 (frame-selected-window warp-frame))
2527 (run-hooks 'after-quit-hook-internal)
2530 ;; Returns frame under mouse, if this frame is not a minibuffer
2531 ;; frame. Otherwise: nil
2532 (defun ediff-good-frame-under-mouse ()
2533 (let ((frame-or-win (car (mouse-position)))
2538 (frame-live-p frame-or-win)
2539 (window-live-p frame-or-win)))
2541 (setq frame (if ediff-emacs-p frame-or-win (window-frame frame-or-win))
2543 (buffer-name (window-buffer (frame-selected-window frame)))))
2544 (if (string-match "Minibuf" buf-name)
2549 (defun ediff-delete-temp-files ()
2550 (if (and (stringp ediff-temp-file-A) (file-exists-p ediff-temp-file-A))
2551 (delete-file ediff-temp-file-A))
2552 (if (and (stringp ediff-temp-file-B) (file-exists-p ediff-temp-file-B))
2553 (delete-file ediff-temp-file-B))
2554 (if (and (stringp ediff-temp-file-C) (file-exists-p ediff-temp-file-C))
2555 (delete-file ediff-temp-file-C)))
2558 ;; Kill control buffer, other auxiliary Ediff buffers.
2559 ;; Leave one of the frames split between buffers A/B/C
2560 (defun ediff-cleanup-mess ()
2561 (let* ((buff-A ediff-buffer-A)
2562 (buff-B ediff-buffer-B)
2563 (buff-C ediff-buffer-C)
2564 (ctl-buf ediff-control-buffer)
2565 (ctl-wind (ediff-get-visible-buffer-window ctl-buf))
2566 (ctl-frame ediff-control-frame)
2567 (three-way-job ediff-3way-job)
2568 (main-frame (cond ((window-live-p ediff-window-A)
2569 (window-frame ediff-window-A))
2570 ((window-live-p ediff-window-B)
2571 (window-frame ediff-window-B)))))
2573 (ediff-kill-buffer-carefully ediff-diff-buffer)
2574 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2575 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2576 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2577 (ediff-kill-buffer-carefully ediff-error-buffer)
2578 (ediff-kill-buffer-carefully ediff-msg-buffer)
2579 (ediff-kill-buffer-carefully ediff-debug-buffer)
2580 (if (boundp 'ediff-patch-diagnostics)
2581 (ediff-kill-buffer-carefully ediff-patch-diagnostics))
2583 ;; delete control frame or window
2584 (cond ((and (ediff-window-display-p) (frame-live-p ctl-frame))
2585 (delete-frame ctl-frame))
2586 ((window-live-p ctl-wind)
2587 (delete-window ctl-wind)))
2589 ;; Hide bottom toolbar. --marcpa
2590 (if (not (ediff-multiframe-setup-p))
2591 (ediff-kill-bottom-toolbar))
2593 (ediff-kill-buffer-carefully ctl-buf)
2595 (if (frame-live-p main-frame)
2596 (select-frame main-frame))
2598 ;; display only if not visible
2600 (or (ediff-get-visible-buffer-window buff-B)
2601 (switch-to-buffer buff-B))
2604 (or (ediff-get-visible-buffer-window buff-A)
2606 (if (and (ediff-get-visible-buffer-window buff-B)
2607 (ediff-buffer-live-p buff-A))
2608 (funcall ediff-split-window-function))
2609 (switch-to-buffer buff-A)))
2613 (or (ediff-get-visible-buffer-window buff-C)
2615 (if (and (or (ediff-get-visible-buffer-window buff-A)
2616 (ediff-get-visible-buffer-window buff-B))
2617 (ediff-buffer-live-p buff-C))
2618 (funcall ediff-split-window-function))
2619 (switch-to-buffer buff-C)))
2625 (defun ediff-janitor (ask keep-variants)
2626 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2627 In merge jobs, buffer C is not deleted here, but rather according to
2628 ediff-quit-merge-hook.
2629 A side effect of cleaning up may be that you should be careful when comparing
2630 the same buffer in two separate Ediff sessions: quitting one of them might
2631 delete this buffer in another session as well."
2632 (ediff-dispose-of-variant-according-to-user
2633 ediff-buffer-A 'A ask keep-variants)
2634 (ediff-dispose-of-variant-according-to-user
2635 ediff-buffer-B 'B ask keep-variants)
2636 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2637 (ediff-dispose-of-variant-according-to-user
2638 ediff-ancestor-buffer 'Ancestor ask keep-variants)
2639 (ediff-dispose-of-variant-according-to-user
2640 ediff-buffer-C 'C ask keep-variants)
2643 ;; Kill the variant buffer, according to user directives (ask, kill
2644 ;; unconditionaly, keep)
2645 ;; BUFF is the buffer, BUFF-TYPE is either 'A, or 'B, 'C, 'Ancestor
2646 (defun ediff-dispose-of-variant-according-to-user (buff bufftype ask keep-variants)
2647 ;; if this is indirect buffer, kill it and substitute with direct buf
2648 (if (and (ediff-buffer-live-p buff)
2649 (ediff-with-current-buffer buff ediff-temp-indirect-buffer))
2650 (let ((wind (ediff-get-visible-buffer-window buff))
2651 (base (buffer-base-buffer buff))
2652 (modified-p (buffer-modified-p buff)))
2653 (if (and (window-live-p wind) (ediff-buffer-live-p base))
2654 (set-window-buffer wind base))
2655 ;; Kill indirect buffer even if it is modified, because the base buffer
2656 ;; is still there. Note that if the base buffer is dead then so will be
2657 ;; the indirect buffer
2658 (ediff-with-current-buffer buff
2659 (set-buffer-modified-p nil))
2660 (ediff-kill-buffer-carefully buff)
2661 (ediff-with-current-buffer base
2662 (set-buffer-modified-p modified-p)))
2663 ;; otherwise, ask or use the value of keep-variants
2664 (or (not (ediff-buffer-live-p buff))
2666 (buffer-modified-p buff)
2668 (not (y-or-n-p (format "Kill buffer %S [%s]? "
2669 bufftype (buffer-name buff)))))
2670 (ediff-kill-buffer-carefully buff))
2673 (defun ediff-maybe-save-and-delete-merge (&optional save-and-continue)
2674 "Default hook to run on quitting a merge job.
2675 This can also be used to save merge buffer in the middle of an Ediff session.
2677 If the optional SAVE-AND-CONTINUE argument is non-nil, save merge buffer and
2678 continue. Otherwise:
2679 If `ediff-autostore-merges' is nil, this does nothing.
2680 If it is t, it saves the merge buffer in the file `ediff-merge-store-file'
2681 or asks the user, if the latter is nil. It then asks the user whether to
2682 delete the merge buffer.
2683 If `ediff-autostore-merges' is neither nil nor t, the merge buffer is saved
2684 only if this merge job is part of a group, i.e., was invoked from within
2685 `ediff-merge-directories', `ediff-merge-directory-revisions', and such."
2686 (let ((merge-store-file ediff-merge-store-file)
2687 (ediff-autostore-merges ; fake ediff-autostore-merges, if necessary
2688 (if save-and-continue t ediff-autostore-merges)))
2689 (if ediff-autostore-merges
2690 (cond ((stringp merge-store-file)
2691 ;; store, ask to delete
2692 (ediff-write-merge-buffer-and-maybe-kill
2693 ediff-buffer-C merge-store-file 'show-file save-and-continue))
2694 ((eq ediff-autostore-merges t)
2695 ;; ask for file name
2696 (setq merge-store-file
2697 (read-file-name "Save the result of the merge in file: "))
2698 (ediff-write-merge-buffer-and-maybe-kill
2699 ediff-buffer-C merge-store-file nil save-and-continue))
2700 ((and (ediff-buffer-live-p ediff-meta-buffer)
2701 (ediff-with-current-buffer ediff-meta-buffer
2702 (ediff-merge-metajob)))
2703 ;; The parent metajob passed nil as the autostore file.
2707 ;; write merge buffer. If the optional argument save-and-continue is non-nil,
2708 ;; then don't kill the merge buffer
2709 (defun ediff-write-merge-buffer-and-maybe-kill (buf file
2711 show-file save-and-continue)
2712 (if (not (eq (find-buffer-visiting file) buf))
2714 (format "Another buffer is visiting file %s. Too dangerous to save the merge buffer"
2717 (message warn-message)
2718 (with-output-to-temp-buffer ediff-msg-buffer
2720 (princ warn-message)
2724 (ediff-with-current-buffer buf
2725 (if (or (not (file-exists-p file))
2726 (y-or-n-p (format "File %s exists, overwrite? " file)))
2728 ;;(write-region (point-min) (point-max) file)
2729 (ediff-with-current-buffer buf
2730 (set-visited-file-name file)
2734 (message "Merge buffer saved in: %s" file)
2735 (set-buffer-modified-p nil)
2738 (not save-and-continue)
2739 (y-or-n-p "Merge buffer saved. Now kill the buffer? "))
2740 (ediff-kill-buffer-carefully buf)))))
2743 ;; The default way of suspending Ediff.
2744 ;; Buries Ediff buffers, kills all windows.
2745 (defun ediff-default-suspend-function ()
2746 (let* ((buf-A ediff-buffer-A)
2747 (buf-B ediff-buffer-B)
2748 (buf-C ediff-buffer-C)
2749 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2750 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2751 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2752 (buf-patch (if (boundp 'ediff-patchbufer) ediff-patchbufer nil))
2753 (buf-patch-diag (if (boundp 'ediff-patch-diagnostics)
2754 ediff-patch-diagnostics nil))
2755 (buf-err ediff-error-buffer)
2756 (buf-diff ediff-diff-buffer)
2757 (buf-custom-diff ediff-custom-diff-buffer)
2758 (buf-fine-diff ediff-fine-diff-buffer))
2760 ;; hide the control panel
2761 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2762 (iconify-frame ediff-control-frame)
2764 (if buf-err (bury-buffer buf-err))
2765 (if buf-diff (bury-buffer buf-diff))
2766 (if buf-custom-diff (bury-buffer buf-custom-diff))
2767 (if buf-fine-diff (bury-buffer buf-fine-diff))
2768 (if buf-patch (bury-buffer buf-patch))
2769 (if buf-patch-diag (bury-buffer buf-patch-diag))
2770 (if (window-live-p buf-A-wind)
2772 (select-window buf-A-wind)
2773 (delete-other-windows)
2775 (if (ediff-buffer-live-p buf-A)
2779 (if (window-live-p buf-B-wind)
2781 (select-window buf-B-wind)
2782 (delete-other-windows)
2784 (if (ediff-buffer-live-p buf-B)
2788 (if (window-live-p buf-C-wind)
2790 (select-window buf-C-wind)
2791 (delete-other-windows)
2793 (if (ediff-buffer-live-p buf-C)
2800 (defun ediff-suspend ()
2802 To resume, switch to the appropriate `Ediff Control Panel'
2803 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2804 up an appropriate window config."
2806 (ediff-barf-if-not-control-buffer)
2807 (run-hooks 'ediff-suspend-hook)
2809 "To resume, type M-x eregistry and select the desired Ediff session"))
2812 (defun ediff-status-info ()
2813 "Show the names of the buffers or files being operated on by Ediff.
2814 Hit \\[ediff-recenter] to reset the windows afterward."
2816 (ediff-barf-if-not-control-buffer)
2818 (ediff-skip-unsuitable-frames))
2819 (with-output-to-temp-buffer ediff-msg-buffer
2820 (ediff-with-current-buffer standard-output
2822 (raise-frame (selected-frame))
2823 (princ (ediff-version))
2825 (ediff-with-current-buffer ediff-buffer-A
2826 (if buffer-file-name
2828 (format "File A = %S\n" buffer-file-name))
2830 (format "Buffer A = %S\n" (buffer-name)))))
2831 (ediff-with-current-buffer ediff-buffer-B
2832 (if buffer-file-name
2834 (format "File B = %S\n" buffer-file-name))
2836 (format "Buffer B = %S\n" (buffer-name)))))
2838 (ediff-with-current-buffer ediff-buffer-C
2839 (if buffer-file-name
2841 (format "File C = %S\n" buffer-file-name))
2843 (format "Buffer C = %S\n" (buffer-name))))))
2844 (princ (format "Customized diff output %s\n"
2845 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2846 (concat "\tin buffer "
2847 (buffer-name ediff-custom-diff-buffer))
2848 " is not available")))
2849 (princ (format "Plain diff output %s\n"
2850 (if (ediff-buffer-live-p ediff-diff-buffer)
2851 (concat "\tin buffer "
2852 (buffer-name ediff-diff-buffer))
2853 " is not available")))
2855 (let* ((A-line (ediff-with-current-buffer ediff-buffer-A
2856 (1+ (count-lines (point-min) (point)))))
2857 (B-line (ediff-with-current-buffer ediff-buffer-B
2858 (1+ (count-lines (point-min) (point)))))
2860 (princ (format "\Buffer A's point is on line %d\n" A-line))
2861 (princ (format "Buffer B's point is on line %d\n" B-line))
2864 (setq C-line (ediff-with-current-buffer ediff-buffer-C
2865 (1+ (count-lines (point-min) (point)))))
2866 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2868 (princ (format "\nCurrent difference number = %S\n"
2869 (cond ((< ediff-current-difference 0) 'start)
2870 ((>= ediff-current-difference
2871 ediff-number-of-differences) 'end)
2872 (t (1+ ediff-current-difference)))))
2875 (format "\n%s regions that differ in white space & line breaks only"
2876 (if ediff-ignore-similar-regions
2877 "Ignoring" "Showing")))
2878 (if (and ediff-merge-job ediff-show-clashes-only)
2880 "\nFocusing on regions where both buffers differ from the ancestor"))
2881 (if (and ediff-skip-merge-regions-that-differ-from-default ediff-merge-job)
2883 "\nSkipping merge regions that differ from default setting"))
2885 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2886 (princ "\nSelective browsing by regexp is off\n"))
2887 ((eq ediff-skip-diff-region-function
2888 ediff-hide-regexp-matches-function)
2890 "\nIgnoring regions that match")
2893 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2894 ediff-regexp-hide-A ediff-hide-regexp-connective
2895 ediff-regexp-hide-B)))
2896 ((eq ediff-skip-diff-region-function
2897 ediff-focus-on-regexp-matches-function)
2899 "\nFocusing on regions that match")
2902 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2903 ediff-regexp-focus-A ediff-focus-regexp-connective
2904 ediff-regexp-focus-B)))
2905 (t (princ "\nSelective browsing via a user-defined method.\n")))
2908 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2909 (substitute-command-keys "\\[ediff-submit-report]")))
2911 (if (frame-live-p ediff-control-frame)
2912 (ediff-reset-mouse ediff-control-frame))
2913 (if (window-live-p ediff-control-window)
2914 (select-window ediff-control-window)))
2919 ;;; Support routines
2921 ;; Select a difference by placing the ASCII flags around the appropriate
2922 ;; group of lines in the A, B buffers
2923 ;; This may have to be modified for buffer C, when it will be supported.
2924 (defun ediff-select-difference (n)
2925 (if (and (ediff-buffer-live-p ediff-buffer-A)
2926 (ediff-buffer-live-p ediff-buffer-B)
2927 (ediff-valid-difference-p n))
2930 ((and (ediff-has-face-support-p) ediff-use-faces)
2931 (ediff-highlight-diff n))
2932 ((eq ediff-highlighting-style 'ascii)
2933 (ediff-place-flags-in-buffer
2934 'A ediff-buffer-A ediff-control-buffer n)
2935 (ediff-place-flags-in-buffer
2936 'B ediff-buffer-B ediff-control-buffer n)
2938 (ediff-place-flags-in-buffer
2939 'C ediff-buffer-C ediff-control-buffer n))
2940 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2941 (ediff-place-flags-in-buffer
2942 'Ancestor ediff-ancestor-buffer
2943 ediff-control-buffer n))
2946 (ediff-install-fine-diff-if-necessary n)
2947 ;; set current difference here so the hook will be able to refer to it
2948 (setq ediff-current-difference n)
2949 (run-hooks 'ediff-select-hook))))
2952 ;; Unselect a difference by removing the ASCII flags in the buffers.
2953 ;; This may have to be modified for buffer C, when it will be supported.
2954 (defun ediff-unselect-difference (n)
2955 (if (ediff-valid-difference-p n)
2957 (cond ((and (ediff-has-face-support-p) ediff-use-faces)
2958 (ediff-unhighlight-diff))
2959 ((eq ediff-highlighting-style 'ascii)
2960 (ediff-remove-flags-from-buffer
2962 (ediff-get-diff-overlay n 'A))
2963 (ediff-remove-flags-from-buffer
2965 (ediff-get-diff-overlay n 'B))
2967 (ediff-remove-flags-from-buffer
2969 (ediff-get-diff-overlay n 'C)))
2970 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2971 (ediff-remove-flags-from-buffer
2972 ediff-ancestor-buffer
2973 (ediff-get-diff-overlay n 'Ancestor)))
2976 ;; unhighlight fine diffs
2977 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2978 (run-hooks 'ediff-unselect-hook))))
2981 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2982 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2983 ;; next difference is selected, but the current selection is not
2984 ;; unselected. If FLAG is 'unselect-only then the current selection is
2985 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2986 ;; don't recenter buffers after selecting/unselecting.
2987 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2988 (let ((ediff-current-difference n))
2990 (ediff-recenter 'no-rehighlight)))
2992 (let ((control-buf ediff-control-buffer))
2995 (or (eq flag 'select-only)
2996 (ediff-unselect-difference ediff-current-difference))
2998 (or (eq flag 'unselect-only)
2999 (ediff-select-difference n))
3000 ;; need to set current diff here even though it is also set in
3001 ;; ediff-select-difference because ediff-select-difference might not
3002 ;; be called if unselect-only is specified
3003 (setq ediff-current-difference n)
3004 ) ; end protected section
3006 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines)))
3011 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
3012 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
3013 (let* ((buff (ediff-get-buffer buf-type))
3014 (last (ediff-with-current-buffer buff (point-max)))
3015 (begin (ediff-get-diff-posn buf-type 'beg n))
3016 (end (ediff-get-diff-posn buf-type 'end n))
3017 (xtra (if (equal begin end) 1 0))
3018 (end-hilit (min last (+ end xtra)))
3019 (current-diff-overlay
3021 (ediff-get-symbol-from-alist
3022 buf-type ediff-current-diff-overlay-alist))))
3025 (ediff-move-overlay current-diff-overlay begin end-hilit)
3026 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
3027 (ediff-overlay-put current-diff-overlay 'priority
3028 (ediff-highest-priority begin end-hilit buff))
3029 (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
3031 ;; unhighlight the background overlay for diff n so it won't
3032 ;; interfere with the current diff overlay
3033 (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
3037 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
3038 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
3039 (let ((current-diff-overlay
3041 (ediff-get-symbol-from-alist
3042 buf-type ediff-current-diff-overlay-alist)))
3044 (ediff-get-diff-overlay ediff-current-difference buf-type))
3047 (ediff-move-overlay current-diff-overlay 1 1)
3049 ;; rehighlight the overlay in the background of the
3050 ;; current difference region
3051 (ediff-set-overlay-face
3053 (if (and (ediff-has-face-support-p)
3054 ediff-use-faces ediff-highlight-all-diffs)
3055 (ediff-background-face buf-type ediff-current-difference)))
3058 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
3059 (ediff-unselect-and-select-difference -1)
3060 (if (and (ediff-has-face-support-p) ediff-use-faces)
3061 (let* ((inhibit-quit t)
3062 (current-diff-overlay-var
3063 (ediff-get-symbol-from-alist
3064 buf-type ediff-current-diff-overlay-alist))
3065 (current-diff-overlay (symbol-value current-diff-overlay-var)))
3066 (ediff-paint-background-regions 'unhighlight)
3067 (if (ediff-overlayp current-diff-overlay)
3068 (ediff-delete-overlay current-diff-overlay))
3069 (set current-diff-overlay-var nil)
3073 (defsubst ediff-highlight-diff (n)
3074 "Put face on diff N. Invoked for X displays only."
3075 (ediff-highlight-diff-in-one-buffer n 'A)
3076 (ediff-highlight-diff-in-one-buffer n 'B)
3077 (ediff-highlight-diff-in-one-buffer n 'C)
3078 (ediff-highlight-diff-in-one-buffer n 'Ancestor)
3082 (defsubst ediff-unhighlight-diff ()
3083 "Remove overlays from buffers A, B, and C."
3084 (ediff-unhighlight-diff-in-one-buffer 'A)
3085 (ediff-unhighlight-diff-in-one-buffer 'B)
3086 (ediff-unhighlight-diff-in-one-buffer 'C)
3087 (ediff-unhighlight-diff-in-one-buffer 'Ancestor)
3090 ;; delete highlighting overlays, restore faces to their original form
3091 (defsubst ediff-unhighlight-diffs-totally ()
3092 (ediff-unhighlight-diffs-totally-in-one-buffer 'A)
3093 (ediff-unhighlight-diffs-totally-in-one-buffer 'B)
3094 (ediff-unhighlight-diffs-totally-in-one-buffer 'C)
3095 (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor)
3099 ;; This is adapted from a similar function in `emerge.el'.
3100 ;; PROMPT should not have a trailing ': ', so that it can be modified
3101 ;; according to context.
3102 ;; If DEFAULT-FILE is set, it should be used as the default value.
3103 ;; If DEFAULT-DIR is non-nil, use it as the default directory.
3104 ;; Otherwise, use the value of Emacs' variable `default-directory.'
3105 (defun ediff-read-file-name (prompt default-dir default-file &optional no-dirs)
3106 ;; hack default-dir if it is not set
3108 (file-name-as-directory
3109 (ediff-abbreviate-file-name
3110 (expand-file-name (or default-dir
3112 (file-name-directory default-file))
3113 default-directory)))))
3115 ;; strip the directory from default-file
3117 (setq default-file (file-name-nondirectory default-file)))
3118 (if (string= default-file "")
3119 (setq default-file nil))
3122 (setq f (expand-file-name
3127 (concat " (default " default-file "):"))
3128 (t (concat " (default " default-dir "):"))))
3130 (or default-file default-dir)
3131 t ; must match, no-confirm
3132 (if default-file (file-name-directory default-file))
3136 ;; If user entered a directory name, expand the default file in that
3137 ;; directory. This allows the user to enter a directory name for the
3138 ;; B-file and diff against the default-file in that directory instead
3139 ;; of a DIRED listing!
3140 (if (and (file-directory-p f) default-file)
3141 (setq f (expand-file-name
3142 (file-name-nondirectory default-file) f)))
3143 (if (and no-dirs (file-directory-p f))
3144 (error "File %s is a directory" f))
3147 ;; If PREFIX is given, then it is used as a prefix for the temp file
3148 ;; name. Otherwise, `ediff' is used. If FILE is given, use this
3149 ;; file and don't create a new one.
3150 ;; In MS-DOS, make sure the prefix isn't too long, or else
3151 ;; `make-temp-name' isn't guaranteed to return a unique filename.
3152 ;; Also, save buffer from START to END in the file.
3153 ;; START defaults to (point-min), END to (point-max)
3154 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
3155 (let* ((p (ediff-convert-standard-filename (or prefix "ediff")))
3157 (coding-system-for-write ediff-coding-system-for-write)
3159 (if (and (fboundp 'msdos-long-file-names)
3160 (not (msdos-long-file-names))
3162 (setq short-p (substring p 0 2)))
3164 (setq f (concat ediff-temp-file-prefix p)
3165 short-f (concat ediff-temp-file-prefix short-p)
3166 f (cond (given-file)
3167 ((find-file-name-handler f 'find-file-noselect)
3168 ;; to thwart file handlers in write-region, e.g., if file
3169 ;; name ends with .Z or .gz
3170 ;; This is needed so that patches produced by ediff will
3171 ;; have more meaningful names
3172 (ediff-make-empty-tmp-file short-f))
3174 ;; Prefix is most often the same as the file name for the
3175 ;; variant. Here we are trying to use the original file
3176 ;; name but in the temp directory.
3177 (ediff-make-empty-tmp-file f 'keep-name))
3179 ;; If don't care about name, add some random stuff
3180 ;; to proposed file name.
3181 (ediff-make-empty-tmp-file short-f))))
3184 (ediff-with-current-buffer buff
3185 (write-region (if start start (point-min))
3186 (if end end (point-max))
3188 nil ; don't append---erase
3190 (set-file-modes f ediff-temp-file-mode)
3191 (expand-file-name f))))
3193 ;; Create a temporary file.
3194 ;; The returned file name (created by appending some random characters at the
3195 ;; end of PROPOSED-NAME is guaranteed to point to a newly created empty file.
3196 ;; This is a replacement for make-temp-name, which eliminates a security hole.
3197 ;; If KEEP-PROPOSED-NAME isn't nil, try to keep PROPOSED-NAME, unless such file
3199 ;; It is a modified version of make-temp-file in emacs 20.5
3200 (defun ediff-make-empty-tmp-file (proposed-name &optional keep-proposed-name)
3201 (let ((file proposed-name))
3202 (while (condition-case ()
3204 (if (or (file-exists-p file) (not keep-proposed-name))
3205 (setq file (make-temp-name proposed-name)))
3206 ;; the with-temp-buffer thing is a workaround for an XEmacs
3207 ;; bug: write-region complains that we are trying to visit a
3208 ;; file in an indirect buffer, failing to notice that the
3209 ;; VISIT flag is unset and that we are actually writing from a
3210 ;; string and not from any buffer.
3212 (write-region "" nil file nil 'silent nil 'excl))
3214 (file-already-exists t))
3215 ;; the file was somehow created by someone else between
3216 ;; `make-temp-name' and `write-region', let's try again.
3221 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
3223 ;;(defun ediff-protect-metachars (str)
3224 ;; (or (memq system-type '(emx vax-vms axp-vms))
3226 ;; (while (string-match ediff-metachars str limit)
3227 ;; (setq str (concat (substring str 0 (match-beginning 0))
3229 ;; (substring str (match-beginning 0))))
3230 ;; (setq limit (1+ (match-end 0))))))
3233 ;; Make sure the current buffer (for a file) has the same contents as the
3234 ;; file on disk, and attempt to remedy the situation if not.
3235 ;; Signal an error if we can't make them the same, or the user doesn't want
3236 ;; to do what is necessary to make them the same.
3237 ;; Also, Ediff always offers to revert obsolete buffers, whether they
3238 ;; are modified or not.
3239 (defun ediff-verify-file-buffer (&optional file-magic)
3240 ;; First check if the file has been modified since the buffer visited it.
3241 (if (verify-visited-file-modtime (current-buffer))
3242 (if (buffer-modified-p)
3243 ;; If buffer is not obsolete and is modified, offer to save
3245 (format "Buffer %s has been modified. Save it in file %s? "
3252 (message "Couldn't save %s" buffer-file-name)))
3253 (error "Buffer is out of sync for file %s" buffer-file-name))
3254 ;; If buffer is not obsolete and is not modified, do nothing
3256 ;; If buffer is obsolete, offer to revert
3258 (format "File %s was modified since visited by buffer %s. REVERT file %s? "
3265 (revert-buffer t t))
3266 (error "Buffer out of sync for file %s" buffer-file-name))))
3268 ;; if there is another buffer visiting the file of the merge buffer, offer to
3269 ;; save and delete the buffer; else bark
3270 (defun ediff-verify-file-merge-buffer (file)
3271 (let ((buff (if (stringp file) (find-buffer-visiting file)))
3276 (format "Buffer %s is visiting %s. Save and kill the buffer? "
3277 (buffer-name buff) file))
3278 (with-output-to-temp-buffer ediff-msg-buffer
3280 (princ warn-message)
3283 (message warn-message))
3284 (with-current-buffer buff
3286 (kill-buffer (current-buffer)))
3287 (error "Too dangerous to merge versions of a file visited by another buffer"))))
3292 (defun ediff-filename-magic-p (file)
3293 (or (ediff-file-compressed-p file)
3294 (ediff-file-remote-p file)))
3297 (defun ediff-save-buffer (arg)
3298 "Safe way of saving buffers A, B, C, and the diff output.
3299 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
3300 and `wd' saves the diff output.
3302 With prefix argument, `wd' saves plain diff output.
3303 Without an argument, it saves customized diff argument, if available
3304 \(and plain output, if customized output was not generated\)."
3306 (ediff-barf-if-not-control-buffer)
3307 (ediff-compute-custom-diffs-maybe)
3308 (ediff-with-current-buffer
3309 (cond ((memq last-command-char '(?a ?b ?c))
3311 (ediff-char-to-buftype last-command-char)))
3312 ((eq last-command-char ?d)
3313 (message "Saving diff output ...")
3314 (sit-for 1) ; let the user see the message
3315 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3317 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3318 ediff-custom-diff-buffer)
3319 ((ediff-buffer-live-p ediff-diff-buffer)
3321 (t (error "Output from `diff' not found"))))
3326 ;; idea suggested by Hannu Koivisto <azure@iki.fi>
3327 (defun ediff-clone-buffer-for-region-comparison (buff region-name)
3328 (let ((cloned-buff (ediff-make-cloned-buffer buff region-name))
3333 (ediff-with-current-buffer cloned-buff
3334 (setq ediff-temp-indirect-buffer t))
3335 (pop-to-buffer cloned-buff)
3336 (setq wind (ediff-get-visible-buffer-window cloned-buff))
3337 (select-window wind)
3338 (delete-other-windows)
3339 (split-window-vertically)
3340 (ediff-select-lowest-window)
3341 (setq other-wind (selected-window))
3345 (format "\n ******* Mark a region in buffer %s *******\n"
3346 (buffer-name cloned-buff)))
3348 (ediff-with-current-buffer buff
3349 (format "\n\t When done, type %s Use %s to abort\n "
3350 (ediff-format-bindings-of 'exit-recursive-edit)
3351 (ediff-format-bindings-of 'abort-recursive-edit))))
3352 (goto-char (point-min))
3353 (setq msg-buf (current-buffer))
3354 (set-window-buffer other-wind msg-buf)
3355 (shrink-window-if-larger-than-buffer)
3356 (if (window-live-p wind)
3357 (select-window wind))
3361 (ediff-kill-buffer-carefully cloned-buff)))
3366 (defun ediff-clone-buffer-for-window-comparison (buff wind region-name)
3367 (let ((cloned-buff (ediff-make-cloned-buffer buff region-name)))
3368 (ediff-with-current-buffer cloned-buff
3369 (setq ediff-temp-indirect-buffer t))
3370 (set-window-buffer wind cloned-buff)
3373 (defun ediff-clone-buffer-for-current-diff-comparison (buff buf-type reg-name)
3374 (let ((cloned-buff (ediff-make-cloned-buffer buff reg-name))
3375 (reg-start (ediff-get-diff-posn buf-type 'beg))
3376 (reg-end (ediff-get-diff-posn buf-type 'end)))
3377 (ediff-with-current-buffer cloned-buff
3378 ;; set region to be the current diff region
3379 (goto-char reg-start)
3381 (setq ediff-temp-indirect-buffer t))
3386 (defun ediff-make-cloned-buffer (buff region-name)
3387 (ediff-make-indirect-buffer
3388 buff (generate-new-buffer-name
3389 (concat (if (stringp buff) buff (buffer-name buff)) region-name))
3393 (defun ediff-make-indirect-buffer (base-buf indirect-buf-name)
3394 (ediff-cond-compile-for-xemacs-or-emacs
3395 (make-indirect-buffer base-buf indirect-buf-name) ; xemacs
3396 (make-indirect-buffer base-buf indirect-buf-name 'clone) ; emacs
3400 ;; This function operates only from an ediff control buffer
3401 (defun ediff-compute-custom-diffs-maybe ()
3402 (let ((buf-A-file-name (buffer-file-name ediff-buffer-A))
3403 (buf-B-file-name (buffer-file-name ediff-buffer-B))
3405 (unless (and buf-A-file-name (file-exists-p buf-A-file-name))
3407 (ediff-make-temp-file ediff-buffer-A)))
3408 (unless (and buf-B-file-name (file-exists-p buf-B-file-name))
3410 (ediff-make-temp-file ediff-buffer-B)))
3411 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
3412 (setq ediff-custom-diff-buffer
3414 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
3415 (ediff-with-current-buffer ediff-custom-diff-buffer
3416 (setq buffer-read-only nil)
3419 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
3420 ediff-custom-diff-options
3421 ;; repetition of buf-A-file-name is needed so it'll return a file
3422 (or (and buf-A-file-name (file-exists-p buf-A-file-name) buf-A-file-name)
3424 (or (and buf-B-file-name (file-exists-p buf-B-file-name) buf-B-file-name)
3426 ;; put the diff file in diff-mode, if it is available
3427 (if (fboundp 'diff-mode)
3428 (with-current-buffer ediff-custom-diff-buffer
3430 (and file-A (file-exists-p file-A) (delete-file file-A))
3431 (and file-B (file-exists-p file-B) (delete-file file-B))
3434 (defun ediff-show-diff-output (arg)
3436 (ediff-barf-if-not-control-buffer)
3437 (ediff-compute-custom-diffs-maybe)
3439 (ediff-skip-unsuitable-frames ' ok-unsplittable))
3440 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3442 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3443 ediff-custom-diff-buffer)
3444 ((ediff-buffer-live-p ediff-diff-buffer)
3448 (message "Output from `diff' not found")
3452 (ediff-with-current-buffer buf
3453 (goto-char (point-min)))
3454 (switch-to-buffer buf)
3455 (raise-frame (selected-frame)))))
3456 (if (frame-live-p ediff-control-frame)
3457 (ediff-reset-mouse ediff-control-frame))
3458 (if (window-live-p ediff-control-window)
3459 (select-window ediff-control-window)))
3462 (defun ediff-inferior-compare-regions ()
3463 "Compare regions in an active Ediff session.
3464 Like ediff-regions-linewise but is called from under an active Ediff session on
3465 the files that belong to that session.
3467 After quitting the session invoked via this function, type C-l to the parent
3468 Ediff Control Panel to restore highlighting."
3471 (possibilities (list ?A ?B ?C))
3474 begA begB endA endB bufA bufB)
3476 (if (ediff-valid-difference-p ediff-current-difference)
3478 (ediff-set-fine-diff-properties ediff-current-difference 'default)
3479 (ediff-unhighlight-diff)))
3480 (ediff-paint-background-regions 'unhighlight)
3482 (cond ((ediff-merge-job)
3483 (setq bufB ediff-buffer-C)
3484 ;; ask which buffer to compare to the merge buffer
3485 (while (cond ((eq answer ?A)
3486 (setq bufA ediff-buffer-A
3487 possibilities '(?B))
3490 (setq bufA ediff-buffer-B
3491 possibilities '(?A))
3495 (message "Valid values are A or B")
3498 (let ((cursor-in-echo-area t))
3500 "Which buffer to compare to the merge buffer (A or B)? ")
3501 (setq answer (capitalize (read-char-exclusive))))))
3503 ((ediff-3way-comparison-job)
3504 ;; ask which two buffers to compare
3505 (while (cond ((memq answer possibilities)
3506 (setq possibilities (delq answer possibilities))
3509 (ediff-get-symbol-from-alist
3510 answer ediff-buffer-alist)))
3515 "Valid values are %s"
3516 (mapconcat 'char-to-string possibilities " or "))
3519 (let ((cursor-in-echo-area t))
3520 (message "Enter the 1st buffer you want to compare (%s): "
3521 (mapconcat 'char-to-string possibilities " or "))
3522 (setq answer (capitalize (read-char-exclusive)))))
3523 (setq answer "") ; silence error msg
3524 (while (cond ((memq answer possibilities)
3525 (setq possibilities (delq answer possibilities))
3528 (ediff-get-symbol-from-alist
3529 answer ediff-buffer-alist)))
3534 "Valid values are %s"
3535 (mapconcat 'char-to-string possibilities " or "))
3538 (let ((cursor-in-echo-area t))
3539 (message "Enter the 2nd buffer you want to compare (%s): "
3540 (mapconcat 'char-to-string possibilities "/"))
3541 (setq answer (capitalize (read-char-exclusive))))))
3542 (t ; 2way comparison
3543 (setq bufA ediff-buffer-A
3545 possibilities nil)))
3547 (if (and (ediff-valid-difference-p ediff-current-difference)
3548 (y-or-n-p "Compare currently highlighted difference regions? "))
3549 (setq use-current-diff-p t))
3551 (setq bufA (if use-current-diff-p
3552 (ediff-clone-buffer-for-current-diff-comparison
3553 bufA 'A "-Region.A-")
3554 (ediff-clone-buffer-for-region-comparison bufA "-Region.A-")))
3555 (ediff-with-current-buffer bufA
3556 (setq begA (region-beginning)
3563 (or (eobp) (forward-char)) ; include the newline char
3564 (setq endA (point)))
3566 (setq bufB (if use-current-diff-p
3567 (ediff-clone-buffer-for-current-diff-comparison
3568 bufB 'B "-Region.B-")
3569 (ediff-clone-buffer-for-region-comparison bufB "-Region.B-")))
3570 (ediff-with-current-buffer bufB
3571 (setq begB (region-beginning)
3578 (or (eobp) (forward-char)) ; include the newline char
3579 (setq endB (point)))
3582 (ediff-regions-internal
3583 bufA begA endA bufB begB endB
3585 (if use-current-diff-p ; job name
3586 'ediff-regions-wordwise
3587 'ediff-regions-linewise)
3588 (if use-current-diff-p ; word mode, if diffing current diff
3590 ;; setup param to pass to ediff-setup
3591 (list (cons 'ediff-split-window-function ediff-split-window-function)))
3596 (defun ediff-remove-flags-from-buffer (buffer overlay)
3597 (ediff-with-current-buffer buffer
3598 (let ((inhibit-read-only t))
3600 (ediff-overlay-put overlay 'begin-glyph nil)
3601 (ediff-overlay-put overlay 'before-string nil))
3604 (ediff-overlay-put overlay 'end-glyph nil)
3605 (ediff-overlay-put overlay 'after-string nil))
3610 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
3611 (ediff-with-current-buffer buffer
3612 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
3615 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
3616 (let* ((curr-overl (ediff-with-current-buffer ctl-buffer
3617 (ediff-get-diff-overlay diff-no buf-type)))
3618 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
3619 after beg-of-line flag)
3621 ;; insert flag before the difference
3623 (setq beg-of-line (bolp))
3625 (setq flag (ediff-with-current-buffer ctl-buffer
3626 (if (eq ediff-highlighting-style 'ascii)
3628 ediff-before-flag-bol ediff-before-flag-mol))))
3630 ;; insert the flag itself
3632 (ediff-overlay-put curr-overl 'begin-glyph flag)
3633 (ediff-overlay-put curr-overl 'before-string flag))
3635 ;; insert the flag after the difference
3636 ;; `after' must be set here, after the before-flag was inserted
3637 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
3639 (setq beg-of-line (bolp))
3641 (setq flag (ediff-with-current-buffer ctl-buffer
3642 (if (eq ediff-highlighting-style 'ascii)
3644 ediff-after-flag-eol ediff-after-flag-mol))))
3646 ;; insert the flag itself
3648 (ediff-overlay-put curr-overl 'end-glyph flag)
3649 (ediff-overlay-put curr-overl 'after-string flag))
3653 ;;; Some diff region tests
3655 ;; t if diff region is empty.
3656 ;; In case of buffer C, t also if it is not a 3way
3657 ;; comparison job (merging jobs return t as well).
3658 (defun ediff-empty-diff-region-p (n buf-type)
3659 (if (eq buf-type 'C)
3660 (or (not ediff-3way-comparison-job)
3661 (= (ediff-get-diff-posn 'C 'beg n)
3662 (ediff-get-diff-posn 'C 'end n)))
3663 (= (ediff-get-diff-posn buf-type 'beg n)
3664 (ediff-get-diff-posn buf-type 'end n))))
3666 ;; Test if diff region is white space only.
3667 ;; If 2-way job and buf-type = C, then returns t.
3668 (defun ediff-whitespace-diff-region-p (n buf-type)
3669 (or (and (eq buf-type 'C) (not ediff-3way-job))
3670 (ediff-empty-diff-region-p n buf-type)
3671 (let ((beg (ediff-get-diff-posn buf-type 'beg n))
3672 (end (ediff-get-diff-posn buf-type 'end n)))
3673 (ediff-with-current-buffer (ediff-get-buffer buf-type)
3676 (skip-chars-forward ediff-whitespace)
3677 (>= (point) end))))))
3680 (defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end)
3681 (ediff-with-current-buffer
3682 (ediff-with-current-buffer ctrl-buf (ediff-get-buffer buf-type))
3684 (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf))
3685 (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf)))))
3687 ;; Returns positions of difference sectors in the BUF-TYPE buffer.
3688 ;; BUF-TYPE should be a symbol -- `A', `B', or `C'.
3689 ;; POS is either `beg' or `end'--it specifies whether you want the position at
3690 ;; the beginning of a difference or at the end.
3692 ;; The optional argument N says which difference (default:
3693 ;; `ediff-current-difference'). N is the internal difference number (1- what
3694 ;; the user sees). The optional argument CONTROL-BUF says
3695 ;; which control buffer is in effect in case it is not the current
3697 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
3700 (setq control-buf (current-buffer)))
3702 (ediff-with-current-buffer control-buf
3703 (or n (setq n ediff-current-difference))
3704 (if (or (< n 0) (>= n ediff-number-of-differences))
3705 (if (> ediff-number-of-differences 0)
3706 (error ediff-BAD-DIFF-NUMBER
3707 this-command (1+ n) ediff-number-of-differences)
3708 (error ediff-NO-DIFFERENCES)))
3709 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
3710 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
3711 (error ediff-KILLED-VITAL-BUFFER))
3713 (ediff-overlay-start diff-overlay)
3714 (ediff-overlay-end diff-overlay))
3718 ;; Restore highlighting to what it should be according to ediff-use-faces,
3719 ;; ediff-highlighting-style, and ediff-highlight-all-diffs variables.
3720 (defun ediff-restore-highlighting (&optional ctl-buf)
3721 (ediff-with-current-buffer (or ctl-buf (current-buffer))
3722 (if (and (ediff-has-face-support-p)
3724 ediff-highlight-all-diffs)
3725 (ediff-paint-background-regions))
3726 (ediff-select-difference ediff-current-difference)))
3730 ;; null out difference overlays so they won't slow down future
3731 ;; editing operations
3732 ;; VEC is either a difference vector or a fine-diff vector
3733 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
3734 (if (vectorp (symbol-value vec-var))
3735 (mapcar (lambda (elt)
3736 (ediff-delete-overlay
3737 (ediff-get-diff-overlay-from-diff-record elt))
3739 (ediff-clear-fine-diff-vector elt))
3741 (symbol-value vec-var)))
3742 ;; allow them to be garbage collected
3749 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
3750 ;; supporting sticky overlays, this function will make a sticky overlay.
3751 ;; BEG and END are expressions telling where overlay starts.
3752 ;; If they are numbers or buffers, then all is well. Otherwise, they must
3753 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
3755 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
3756 ;; newly created overlay.
3757 (defun ediff-make-bullet-proof-overlay (beg end buff)
3758 (if (ediff-buffer-live-p buff)
3760 (ediff-with-current-buffer buff
3761 (or (number-or-marker-p beg)
3762 (setq beg (eval beg)))
3763 (or (number-or-marker-p end)
3764 (setq end (eval end)))
3766 (ediff-cond-compile-for-xemacs-or-emacs
3767 (make-extent beg end buff) ; xemacs
3768 ;; advance front and rear of the overlay
3769 (make-overlay beg end buff nil 'rear-advance) ; emacs
3774 overl (if ediff-emacs-p 'evaporate 'detachable) nil)
3775 ;; make overlay open-ended
3776 ;; In emacs, it is made open ended at creation time
3779 (ediff-overlay-put overl 'start-open nil)
3780 (ediff-overlay-put overl 'end-open nil)))
3781 (ediff-overlay-put overl 'ediff-diff-num 0)
3785 (defun ediff-make-current-diff-overlay (type)
3786 (if (ediff-has-face-support-p)
3787 (let ((overlay (ediff-get-symbol-from-alist
3788 type ediff-current-diff-overlay-alist))
3789 (buffer (ediff-get-buffer type))
3792 (ediff-get-symbol-from-alist
3793 type ediff-current-diff-face-alist)))))
3795 (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer))
3796 (ediff-set-overlay-face (symbol-value overlay) face)
3797 (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer))
3801 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3802 ;; other insignificant buffers (those beginning with "^[ *]").
3803 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3805 ;; EXCL-BUFF-LIST is an exclusion list.
3806 (defun ediff-other-buffer (excl-buff-lst)
3807 (or (listp excl-buff-lst) (setq excl-buff-lst (list excl-buff-lst)))
3808 (let* ((all-buffers (nconc (ediff-get-selected-buffers) (buffer-list)))
3809 ;; we compute this the second time because we need to do memq on it
3810 ;; later, and nconc above will break it. Either this or use slow
3811 ;; append instead of nconc
3812 (selected-buffers (ediff-get-selected-buffers))
3813 (prefered-buffer (car all-buffers))
3814 visible-dired-buffers
3815 (excl-buff-name-list
3817 (lambda (b) (cond ((stringp b) b)
3818 ((bufferp b) (buffer-name b))))
3820 ;; if at least one buffer on the exclusion list is dired, then force
3821 ;; all others to be dired. This is because this means that the user
3822 ;; has already chosen a dired buffer before
3823 (use-dired-major-mode
3824 (cond ((null (ediff-buffer-live-p (car excl-buff-lst))) 'unknown)
3825 ((eq (ediff-with-current-buffer (car excl-buff-lst) major-mode)
3829 ;; significant-buffers must be visible and not belong
3830 ;; to the exclusion list `buff-list'
3831 ;; We also exclude temporary buffers, but keep mail and gnus buffers
3832 ;; Furthermore, we exclude dired buffers, unless they are the only
3833 ;; ones visible (and there are at least two of them).
3834 ;; Also, any visible window not on the exclusion list that is first in
3835 ;; the buffer list is chosen regardless. (This is because the user
3836 ;; clicked on it or did something to distinguish it).
3837 (significant-buffers
3840 (cond ((member (buffer-name x) excl-buff-name-list) nil)
3841 ((memq x selected-buffers) x)
3842 ((not (ediff-get-visible-buffer-window x)) nil)
3843 ((eq x prefered-buffer) x)
3844 ;; if prev selected buffer is dired, look only at
3846 ((eq use-dired-major-mode 'yes)
3847 (if (eq (ediff-with-current-buffer x major-mode)
3850 ((eq (ediff-with-current-buffer x major-mode)
3852 (if (null use-dired-major-mode)
3853 ;; don't know if we must enforce dired.
3854 ;; Remember this buffer in case
3855 ;; dired buffs are the only ones visible.
3856 (setq visible-dired-buffers
3857 (cons x visible-dired-buffers)))
3858 ;; skip, if dired is not forced
3860 ((memq (ediff-with-current-buffer x major-mode)
3866 ((string-match "^[ *]" (buffer-name x)) nil)
3867 ((string= "*scratch*" (buffer-name x)) nil)
3870 (clean-significant-buffers (delq nil significant-buffers))
3871 less-significant-buffers)
3873 (if (and (null clean-significant-buffers)
3874 (> (length visible-dired-buffers) 0))
3875 (setq clean-significant-buffers visible-dired-buffers))
3877 (cond (clean-significant-buffers (car clean-significant-buffers))
3878 ;; try also buffers that are not displayed in windows
3879 ((setq less-significant-buffers
3883 (cond ((member (buffer-name x) excl-buff-name-list)
3885 ((eq use-dired-major-mode 'yes)
3886 (if (eq (ediff-with-current-buffer
3890 ((eq (ediff-with-current-buffer x major-mode)
3893 ((string-match "^[ *]" (buffer-name x)) nil)
3894 ((string= "*scratch*" (buffer-name x)) nil)
3897 (car less-significant-buffers))
3902 ;; If current buffer is a Buffer-menu buffer, then take the selected buffers
3903 ;; and append the buffer at the cursor to the end.
3904 ;; This list would be the preferred list.
3905 (defun ediff-get-selected-buffers ()
3906 (if (eq major-mode 'Buffer-menu-mode)
3907 (let ((lis (condition-case nil
3908 (list (Buffer-menu-buffer t))
3912 (goto-char (point-max))
3913 (while (search-backward "\n>" nil t)
3915 (setq lis (cons (Buffer-menu-buffer t) lis)))
3919 ;; Construct a unique buffer name.
3920 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3921 ;; prefix<3>suffix, etc.
3922 (defun ediff-unique-buffer-name (prefix suffix)
3923 (if (null (get-buffer (concat prefix suffix)))
3924 (concat prefix suffix)
3926 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3928 (format "%s<%d>%s" prefix n suffix))))
3931 (defun ediff-submit-report ()
3932 "Submit bug report on Ediff."
3934 (ediff-barf-if-not-control-buffer)
3935 (let ((reporter-prompt-for-summary-p t)
3936 (ctl-buf ediff-control-buffer)
3937 (ediff-device-type (ediff-device-type))
3938 varlist salutation buffer-name)
3939 (setq varlist '(ediff-diff-program ediff-diff-options
3940 ediff-patch-program ediff-patch-options
3943 ediff-auto-refine ediff-highlighting-style
3944 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3945 ediff-forward-word-function
3947 ediff-control-frame-parameters
3948 ediff-control-frame-position-function
3949 ediff-prefer-iconified-control-frame
3950 ediff-window-setup-function
3951 ediff-split-window-function
3958 Congratulations! You may have unearthed a bug in Ediff!
3960 Please make a concise and accurate summary of what happened
3961 and mail it to the address above.
3962 -----------------------------------------------------------
3965 (ediff-skip-unsuitable-frames)
3968 (switch-to-buffer ediff-msg-buffer)
3970 (delete-other-windows)
3972 Please read this first:
3973 ----------------------
3975 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3976 reporting that certain difference regions are not matched as you think they
3977 should, this is most likely due to the way Unix diff program decides what
3978 constitutes a difference region. Ediff is an Emacs interface to diff, and
3979 it has nothing to do with those decisions---it only takes the output from
3980 diff and presents it in a way that is better suited for human browsing and
3983 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3984 an Emacs bug. Report this to Emacs maintainers.
3986 Another popular topic for reports is compilation messages. Because Ediff
3987 interfaces to several other packages and runs under Emacs and XEmacs,
3988 byte-compilation may produce output like this:
3990 While compiling toplevel forms in file ediff.el:
3991 ** reference to free variable pm-color-alist
3992 ........................
3993 While compiling the end of the data:
3994 ** The following functions are not known to be defined:
3995 ediff-valid-color-p, ediff-set-face,
3996 ........................
3998 These are NOT errors, but inevitable warnings, which ought to be ignored.
4000 Please do not report those and similar things. However, comments and
4001 suggestions are always welcome.
4003 Mail anyway? (y or n) ")
4005 (if (y-or-n-p "Mail anyway? ")
4007 (if (ediff-buffer-live-p ctl-buf)
4008 (set-buffer ctl-buf))
4009 (setq buffer-name (buffer-name))
4011 (reporter-submit-bug-report "kifer@cs.stonybrook.edu"
4015 'delete-other-windows
4018 (beep 1)(message "Bug report aborted")
4019 (if (ediff-buffer-live-p ctl-buf)
4020 (ediff-with-current-buffer ctl-buf
4021 (ediff-recenter 'no-rehighlight))))
4025 ;; Find an appropriate syntax table for everyone to use
4026 ;; If buffer B is not fundamental or text mode, use its syntax table
4027 ;; Otherwise, use buffer B's.
4028 ;; The syntax mode is used in ediff-forward-word-function
4029 ;; The important thing is that every buffer should use the same syntax table
4030 ;; during the refinement operation
4031 (defun ediff-choose-syntax-table ()
4032 (setq ediff-syntax-table
4033 (ediff-with-current-buffer ediff-buffer-A
4034 (if (not (memq major-mode
4035 '(fundamental-mode text-mode indented-text-mode)))
4037 (if (not ediff-syntax-table)
4038 (setq ediff-syntax-table
4039 (ediff-with-current-buffer ediff-buffer-B
4044 (defun ediff-deactivate-mark ()
4045 (ediff-cond-compile-for-xemacs-or-emacs
4046 (zmacs-deactivate-region) ; xemacs
4047 (deactivate-mark) ; emacs
4049 (defun ediff-activate-mark ()
4050 (ediff-cond-compile-for-xemacs-or-emacs
4051 (zmacs-activate-region) ; xemacs
4052 (setq mark-active t) ; emacs
4055 (cond ((fboundp 'nuke-selective-display)
4056 ;; XEmacs has nuke-selective-display
4057 (defalias 'ediff-nuke-selective-display 'nuke-selective-display))
4059 (defun ediff-nuke-selective-display ()
4063 (goto-char (point-min))
4064 (let ((mod-p (buffer-modified-p))
4065 buffer-read-only end)
4066 (and (eq t selective-display)
4067 (while (search-forward "\^M" nil t)
4071 (while (search-forward "\^M" end t)
4074 (set-buffer-modified-p mod-p)
4075 (setq selective-display nil)))))
4079 ;; The next two are modified versions from emerge.el.
4080 ;; VARS must be a list of symbols
4081 ;; ediff-save-variables returns an association list: ((var . val) ...)
4082 (defsubst ediff-save-variables (vars)
4083 (mapcar (lambda (v) (cons v (symbol-value v)))
4085 ;; VARS is a list of variable symbols.
4086 (defun ediff-restore-variables (vars assoc-list)
4088 (set (car vars) (cdr (assoc (car vars) assoc-list)))
4089 (setq vars (cdr vars))))
4091 (defun ediff-change-saved-variable (var value buf-type)
4093 (symbol-value (ediff-get-symbol-from-alist
4095 ediff-buffer-values-orig-alist)))
4096 (assoc-elt (assoc var assoc-list)))
4098 (setcdr assoc-elt value))))
4101 ;; must execute in control buf
4102 (defun ediff-save-protected-variables ()
4103 (setq ediff-buffer-values-orig-A
4104 (ediff-with-current-buffer ediff-buffer-A
4105 (ediff-save-variables ediff-protected-variables)))
4106 (setq ediff-buffer-values-orig-B
4107 (ediff-with-current-buffer ediff-buffer-B
4108 (ediff-save-variables ediff-protected-variables)))
4109 (if ediff-3way-comparison-job
4110 (setq ediff-buffer-values-orig-C
4111 (ediff-with-current-buffer ediff-buffer-C
4112 (ediff-save-variables ediff-protected-variables))))
4113 (if (ediff-buffer-live-p ediff-ancestor-buffer)
4114 (setq ediff-buffer-values-orig-Ancestor
4115 (ediff-with-current-buffer ediff-ancestor-buffer
4116 (ediff-save-variables ediff-protected-variables)))))
4118 ;; must execute in control buf
4119 (defun ediff-restore-protected-variables ()
4120 (let ((values-A ediff-buffer-values-orig-A)
4121 (values-B ediff-buffer-values-orig-B)
4122 (values-C ediff-buffer-values-orig-C)
4123 (values-Ancestor ediff-buffer-values-orig-Ancestor))
4124 (ediff-with-current-buffer ediff-buffer-A
4125 (ediff-restore-variables ediff-protected-variables values-A))
4126 (ediff-with-current-buffer ediff-buffer-B
4127 (ediff-restore-variables ediff-protected-variables values-B))
4128 (if ediff-3way-comparison-job
4129 (ediff-with-current-buffer ediff-buffer-C
4130 (ediff-restore-variables ediff-protected-variables values-C)))
4131 (if (ediff-buffer-live-p ediff-ancestor-buffer)
4132 (ediff-with-current-buffer ediff-ancestor-buffer
4133 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
4136 ;; save BUFFER in FILE. used in hooks.
4137 (defun ediff-save-buffer-in-file (buffer file)
4138 (ediff-with-current-buffer buffer
4144 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
4146 ;; calculate time used by command
4147 (defun ediff-calc-command-time ()
4148 (let ((end (current-time))
4151 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
4152 (- (nth 2 end) (nth 2 ediff-command-begin-time))
4153 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
4154 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
4155 (or (equal ediff-command-begin-time '(0 0 0))
4156 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
4158 (defsubst ediff-save-time ()
4159 (setq ediff-command-begin-time (current-time)))
4161 (defun ediff-profile ()
4162 "Toggle profiling Ediff commands."
4164 (ediff-barf-if-not-control-buffer)
4166 (ediff-cond-compile-for-xemacs-or-emacs
4167 (make-local-hook 'post-command-hook) ; xemacs form
4171 (let ((pre-hook 'pre-command-hook)
4172 (post-hook 'post-command-hook))
4173 (if (not (equal ediff-command-begin-time '(0 0 0)))
4174 (progn (remove-hook pre-hook 'ediff-save-time)
4175 (remove-hook post-hook 'ediff-calc-command-time)
4176 (setq ediff-command-begin-time '(0 0 0))
4177 (message "Ediff profiling disabled"))
4178 (add-hook pre-hook 'ediff-save-time t 'local)
4179 (add-hook post-hook 'ediff-calc-command-time nil 'local)
4180 (message "Ediff profiling enabled"))))
4182 (defun ediff-print-diff-vector (diff-vector-var)
4183 (princ (format "\n*** %S ***\n" diff-vector-var))
4184 (mapcar (lambda (overl-vec)
4187 "Diff %d: \tOverlay: %S
4189 \t\tNo-fine-diff-flag: %S
4190 \t\tState-of-diff:\t %S
4191 \t\tState-of-merge:\t %S
4193 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
4196 (if (= (length (aref overl-vec 1)) 0)
4198 (mapconcat 'prin1-to-string
4199 (aref overl-vec 1) "\n\t\t\t "))
4200 (aref overl-vec 2) ; no fine diff flag
4201 (aref overl-vec 3) ; state-of-diff
4202 (aref overl-vec 4) ; state-of-merge
4204 (eval diff-vector-var)))
4208 (defun ediff-debug-info ()
4210 (ediff-barf-if-not-control-buffer)
4211 (with-output-to-temp-buffer ediff-debug-buffer
4212 (ediff-with-current-buffer standard-output
4214 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
4215 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
4216 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
4217 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
4218 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
4222 ;;; General utilities
4224 ;; this uses comparison-func to decide who is a member
4225 (defun ediff-member (elt lis comparison-func)
4226 (while (and lis (not (funcall comparison-func (car lis) elt)))
4227 (setq lis (cdr lis)))
4230 ;; Make a readable representation of the invocation sequence for FUNC-DEF.
4231 ;; It would either be a key or M-x something.
4232 (defun ediff-format-bindings-of (func-def)
4233 (let ((desc (car (where-is-internal func-def
4234 overriding-local-map
4237 (key-description desc)
4238 (format "M-x %s" func-def))))
4240 ;; this uses comparison-func to decide who is a member, and this determines how
4241 ;; intersection looks like
4242 (defun ediff-intersection (lis1 lis2 comparison-func)
4243 (let ((result (list 'a)))
4245 (if (ediff-member (car lis1) lis2 comparison-func)
4246 (nconc result (list (car lis1))))
4247 (setq lis1 (cdr lis1)))
4251 ;; eliminates duplicates using comparison-func
4252 (defun ediff-union (lis1 lis2 comparison-func)
4253 (let ((result (list 'a)))
4255 (or (ediff-member (car lis1) (cdr result) comparison-func)
4256 (nconc result (list (car lis1))))
4257 (setq lis1 (cdr lis1)))
4259 (or (ediff-member (car lis2) (cdr result) comparison-func)
4260 (nconc result (list (car lis2))))
4261 (setq lis2 (cdr lis2)))
4264 ;; eliminates duplicates using comparison-func
4265 (defun ediff-set-difference (lis1 lis2 comparison-func)
4266 (let ((result (list 'a)))
4268 (or (ediff-member (car lis1) (cdr result) comparison-func)
4269 (ediff-member (car lis1) lis2 comparison-func)
4270 (nconc result (list (car lis1))))
4271 (setq lis1 (cdr lis1)))
4274 (if (fboundp 'copy-sequence)
4275 (defalias 'ediff-copy-list 'copy-sequence)
4276 (defun ediff-copy-list (list)
4279 ;;; (while (consp list) (push (pop list) res))
4280 ;;; (prog1 (nreverse res) (setcdr res list)))
4283 (setq elt (car list)
4290 ;; don't report error if version control package wasn't found
4291 ;;(ediff-load-version-control 'silent)
4293 (run-hooks 'ediff-load-hook)
4296 ;;; Local Variables:
4297 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
4298 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
4299 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
4302 ;;; arch-tag: f51099b6-ef4b-470f-88a1-3a0e0b03a879
4303 ;;; ediff-util.el ends here