1 ;;; ediff-util.el --- the core commands and utilities of ediff
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
31 (defvar ediff-patch-diagnostics
)
32 (defvar ediff-patchbufer
)
33 (defvar ediff-use-toolbar-p
)
34 (defvar ediff-toolbar-height
)
35 (defvar ediff-toolbar
)
36 (defvar ediff-toolbar-3way
)
37 (defvar bottom-toolbar
)
38 (defvar bottom-toolbar-visible-p
)
39 (defvar bottom-toolbar-height
)
41 (defvar ediff-emacs-p
)
43 (defvar ediff-after-quit-hook-internal nil
)
47 (load "reporter" 'noerror
)))
50 (let ((load-path (cons (expand-file-name ".") load-path
)))
51 (or (featurep 'ediff-init
)
52 (load "ediff-init.el" nil nil
'nosuffix
))
53 (or (featurep 'ediff-help
)
54 (load "ediff-help.el" nil nil
'nosuffix
))
55 (or (featurep 'ediff-mult
)
56 (load "ediff-mult.el" nil nil
'nosuffix
))
57 (or (featurep 'ediff-wind
)
58 (load "ediff-wind.el" nil nil
'nosuffix
))
59 (or (featurep 'ediff-diff
)
60 (load "ediff-diff.el" nil nil
'nosuffix
))
61 (or (featurep 'ediff-merg
)
62 (load "ediff-merg.el" nil nil
'nosuffix
))
64 (load "ediff.el" nil nil
'nosuffix
))
65 (or (featurep 'ediff-tbar
)
67 (load "ediff-tbar.el" 'noerror nil
'nosuffix
))
80 (require 'ediff-tbar
))
86 "Ediff mode controls all operations in a single Ediff session.
87 This mode is entered through one of the following commands:
98 `ediff-merge-files-with-ancestor'
100 `ediff-merge-buffers-with-ancestor'
101 `ediff-merge-revisions'
102 `ediff-merge-revisions-with-ancestor'
103 `ediff-windows-wordwise'
104 `ediff-windows-linewise'
105 `ediff-regions-wordwise'
106 `ediff-regions-linewise'
116 (kill-all-local-variables)
117 (setq major-mode
'ediff-mode
)
118 (setq mode-name
"Ediff")
119 (run-hooks 'ediff-mode-hook
))
125 (ediff-defvar-local ediff-mode-map nil
126 "Local keymap used in Ediff mode.
127 This is local to each Ediff Control Panel, so they may vary from invocation
130 ;; Set up the keymap in the control buffer
131 (defun ediff-set-keys ()
132 "Set up Ediff keymap, if necessary."
133 (if (null ediff-mode-map
)
134 (ediff-setup-keymap))
135 (use-local-map ediff-mode-map
))
137 ;; Reload Ediff keymap. For debugging only.
138 (defun ediff-reload-keymap ()
140 (setq ediff-mode-map nil
)
144 (defun ediff-setup-keymap ()
145 "Set up the keymap used in the control buffer of Ediff."
146 (setq ediff-mode-map
(make-sparse-keymap))
147 (suppress-keymap ediff-mode-map
)
149 (define-key ediff-mode-map
150 (if ediff-emacs-p
[mouse-2
] [button2]) 'ediff-help-for-quick-help)
151 (define-key ediff-mode-map "\C-m" 'ediff-help-for-quick-help)
153 (define-key ediff-mode-map "p" 'ediff-previous-difference)
154 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
155 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
156 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
157 'ediff-previous-difference nil))
158 ;; must come after C-h, or else C-h wipes out backspace's binding in XEmacs
159 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
160 (define-key ediff-mode-map "n" 'ediff-next-difference)
161 (define-key ediff-mode-map " " 'ediff-next-difference)
162 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
163 (define-key ediff-mode-map "g" nil)
164 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
165 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
166 (define-key ediff-mode-map "q" 'ediff-quit)
167 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
168 (define-key ediff-mode-map "z" 'ediff-suspend)
169 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
170 (define-key ediff-mode-map "|" 'ediff-toggle-split)
171 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
173 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
175 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
176 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
177 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
178 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
179 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
180 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
181 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
182 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
183 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
184 (define-key ediff-mode-map "i" 'ediff-status-info)
185 (define-key ediff-mode-map "E" 'ediff-documentation)
186 (define-key ediff-mode-map "?" 'ediff-toggle-help)
187 (define-key ediff-mode-map "!" 'ediff-update-diffs)
188 (define-key ediff-mode-map "M" 'ediff-show-current-session-meta-buffer)
189 (define-key ediff-mode-map "R" 'ediff-show-registry)
191 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
192 (define-key ediff-mode-map "a" nil)
193 (define-key ediff-mode-map "b" nil)
194 (define-key ediff-mode-map "r" nil)
195 (cond (ediff-merge-job
196 ;; Will barf if no ancestor
197 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
198 ;; In merging, we allow only A->C and B->C copying.
199 (define-key ediff-mode-map "a" 'ediff-copy-A-to-C)
200 (define-key ediff-mode-map "b" 'ediff-copy-B-to-C)
201 (define-key ediff-mode-map "r" 'ediff-restore-diff-in-merge-buffer)
202 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
203 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
204 (define-key ediff-mode-map "$" nil)
205 (define-key ediff-mode-map "$$" 'ediff-toggle-show-clashes-only)
206 (define-key ediff-mode-map "$*" 'ediff-toggle-skip-changed-regions)
207 (define-key ediff-mode-map "&" 'ediff-re-merge))
208 (ediff-3way-comparison-job
209 (define-key ediff-mode-map "ab" 'ediff-copy-A-to-B)
210 (define-key ediff-mode-map "ba" 'ediff-copy-B-to-A)
211 (define-key ediff-mode-map "ac" 'ediff-copy-A-to-C)
212 (define-key ediff-mode-map "bc" 'ediff-copy-B-to-C)
213 (define-key ediff-mode-map "c" nil)
214 (define-key ediff-mode-map "ca" 'ediff-copy-C-to-A)
215 (define-key ediff-mode-map "cb" 'ediff-copy-C-to-B)
216 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
217 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
218 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
219 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
220 (t ; 2-way comparison
221 (define-key ediff-mode-map "a" 'ediff-copy-A-to-B)
222 (define-key ediff-mode-map "b" 'ediff-copy-B-to-A)
223 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
224 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
226 (define-key ediff-mode-map "G" 'ediff-submit-report)
227 (define-key ediff-mode-map "#" nil)
228 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
229 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
231 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
232 (define-key ediff-mode-map "o" nil)
233 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
234 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
235 (define-key ediff-mode-map "w" nil)
236 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
237 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
238 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
239 (define-key ediff-mode-map "=" 'ediff-inferior-compare-regions)
240 (if (and (fboundp 'ediff-show-patch-diagnostics) (ediff-patch-job))
241 (define-key ediff-mode-map "P" 'ediff-show-patch-diagnostics))
244 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
245 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
248 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
250 ;; Allow ediff-mode-map to be referenced indirectly
251 (fset 'ediff-mode-map ediff-mode-map)
252 (run-hooks 'ediff-keymap-setup-hook))
257 ;; Common startup entry for all Ediff functions It now returns control buffer
258 ;; so other functions can do post-processing SETUP-PARAMETERS is a list of the
259 ;; form ((param .val) (param . val)...) This serves a similar purpose to
260 ;; STARTUP-HOOKS, but these parameters are set in the new control buffer right
261 ;; after this buf is created and before any windows are set and such.
262 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
263 startup-hooks setup-parameters
264 &optional merge-buffer-file)
265 (run-hooks 'ediff-before-setup-hook)
266 ;; ediff-convert-standard-filename puts file names in the form appropriate
267 ;; for the OS at hand.
268 (setq file-A (ediff-convert-standard-filename (expand-file-name file-A)))
269 (setq file-B (ediff-convert-standard-filename (expand-file-name file-B)))
272 (ediff-convert-standard-filename (expand-file-name file-C))))
273 (if (stringp merge-buffer-file)
275 (setq merge-buffer-file
276 (ediff-convert-standard-filename
277 (expand-file-name merge-buffer-file)))
278 ;; check the directory exists
279 (or (file-exists-p (file-name-directory merge-buffer-file))
280 (error "Directory %s given as place to save the merge doesn't exist"
281 (abbreviate-file-name
282 (file-name-directory merge-buffer-file))))
283 (if (and (file-exists-p merge-buffer-file)
284 (file-directory-p merge-buffer-file))
285 (error "The merge buffer file %s must not be a directory"
286 (abbreviate-file-name merge-buffer-file)))
288 (let* ((control-buffer-name
289 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
290 (control-buffer (ediff-with-current-buffer buffer-A
291 (get-buffer-create control-buffer-name))))
292 (ediff-with-current-buffer control-buffer
295 (make-local-variable 'ediff-use-long-help-message)
296 (make-local-variable 'ediff-prefer-iconified-control-frame)
297 (make-local-variable 'ediff-split-window-function)
298 (make-local-variable 'ediff-default-variant)
299 (make-local-variable 'ediff-merge-window-share)
300 (make-local-variable 'ediff-window-setup-function)
301 (make-local-variable 'ediff-keep-variants)
303 (ediff-cond-compile-for-xemacs-or-emacs
304 (make-local-hook 'ediff-after-quit-hook-internal) ; xemacs form
308 ;; unwrap set up parameters passed as argument
309 (while setup-parameters
310 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
311 (setq setup-parameters (cdr setup-parameters)))
313 ;; set variables classifying the current ediff job
314 ;; must come AFTER setup-parameters
315 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
316 ediff-merge-job (ediff-merge-job)
317 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
318 ediff-3way-job (ediff-3way-job)
319 ediff-diff3-job (ediff-diff3-job)
320 ediff-narrow-job (ediff-narrow-job)
321 ediff-windows-job (ediff-windows-job)
322 ediff-word-mode-job (ediff-word-mode-job))
324 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
325 ;; This is because u may loose work---dangerous.
326 (if (string-match "buffer" (symbol-name ediff-job-name))
327 (setq ediff-keep-variants t))
329 (ediff-cond-compile-for-xemacs-or-emacs
330 (make-local-hook 'pre-command-hook) ; xemacs form
334 (if (ediff-window-display-p)
335 (add-hook 'pre-command-hook 'ediff-spy-after-mouse nil 'local))
336 (setq ediff-mouse-pixel-position (mouse-pixel-position))
338 ;; adjust for merge jobs
341 ;; If default variant is `combined', the right stuff is
342 ;; inserted by ediff-do-merge
343 ;; Note: at some point, we tried to put ancestor buffer here
344 ;; (which is currently buffer C. This didn't work right
345 ;; because the merge buffer will contain lossage: diff regions
346 ;; in the ancestor, which correspond to revisions that agree
347 ;; in both buf A and B.
348 (cond ((eq ediff-default-variant 'default-B)
352 (setq ediff-split-window-function
353 ediff-merge-split-window-function)
355 ;; remember the ancestor buffer, if any
356 (setq ediff-ancestor-buffer buffer-C)
360 (ediff-unique-buffer-name "*ediff-merge" "*")))
362 (set-buffer buffer-C)
364 (funcall (ediff-with-current-buffer buf major-mode))
365 (widen) ; merge buffer is always widened
366 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode nil t)
368 (setq buffer-read-only nil
369 ediff-buffer-A buffer-A
370 ediff-buffer-B buffer-B
371 ediff-buffer-C buffer-C
372 ediff-control-buffer control-buffer)
374 (ediff-choose-syntax-table)
376 (setq ediff-control-buffer-suffix
377 (if (string-match "<[0-9]*>" control-buffer-name)
378 (substring control-buffer-name
379 (match-beginning 0) (match-end 0))
381 ediff-control-buffer-number
387 ediff-control-buffer-suffix
389 (string-match "[0-9]+" ediff-control-buffer-suffix)
392 (setq ediff-error-buffer
393 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
395 (ediff-with-current-buffer buffer-A (ediff-strip-mode-line-format))
396 (ediff-with-current-buffer buffer-B (ediff-strip-mode-line-format))
398 (ediff-with-current-buffer buffer-C (ediff-strip-mode-line-format)))
399 (if (ediff-buffer-live-p ediff-ancestor-buffer)
400 (ediff-with-current-buffer ediff-ancestor-buffer
401 (ediff-strip-mode-line-format)))
403 (ediff-save-protected-variables) ; save variables to be restored on exit
405 ;; ediff-setup-diff-regions-function must be set after setup
406 ;; parameters are processed.
407 (setq ediff-setup-diff-regions-function
409 'ediff-setup-diff-regions3
410 'ediff-setup-diff-regions))
412 (setq ediff-wide-bounds
413 (list (ediff-make-bullet-proof-overlay
414 '(point-min) '(point-max) ediff-buffer-A)
415 (ediff-make-bullet-proof-overlay
416 '(point-min) '(point-max) ediff-buffer-B)
417 (ediff-make-bullet-proof-overlay
418 '(point-min) '(point-max) ediff-buffer-C)))
420 ;; This has effect only on ediff-windows/regions
421 ;; In all other cases, ediff-visible-region sets visibility bounds to
422 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
423 (if ediff-start-narrowed
424 (setq ediff-visible-bounds ediff-narrow-bounds)
425 (setq ediff-visible-bounds ediff-wide-bounds))
427 (ediff-set-keys) ; comes after parameter setup
429 ;; set up ediff-narrow-bounds, if not set
430 (or ediff-narrow-bounds
431 (setq ediff-narrow-bounds ediff-wide-bounds))
433 ;; All these must be inside ediff-with-current-buffer control-buffer,
434 ;; since these vars are local to control-buffer
435 ;; These won't run if there are errors in diff
436 (ediff-with-current-buffer ediff-buffer-A
437 (ediff-nuke-selective-display)
438 (run-hooks 'ediff-prepare-buffer-hook)
439 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
440 (setq buffer-read-only t))
441 ;; add control-buffer to the list of sessions--no longer used, but may
442 ;; be used again in the future
443 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
444 (setq ediff-this-buffer-ediff-sessions
445 (cons control-buffer ediff-this-buffer-ediff-sessions)))
446 (if ediff-make-buffers-readonly-at-startup
447 (setq buffer-read-only t))
450 (ediff-with-current-buffer ediff-buffer-B
451 (ediff-nuke-selective-display)
452 (run-hooks 'ediff-prepare-buffer-hook)
453 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
454 (setq buffer-read-only t))
455 ;; add control-buffer to the list of sessions
456 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
457 (setq ediff-this-buffer-ediff-sessions
458 (cons control-buffer ediff-this-buffer-ediff-sessions)))
459 (if ediff-make-buffers-readonly-at-startup
460 (setq buffer-read-only t))
464 (ediff-with-current-buffer ediff-buffer-C
465 (ediff-nuke-selective-display)
466 ;; the merge bufer should never be narrowed
467 ;; (it can happen if it is on rmail-mode or similar)
468 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
470 (run-hooks 'ediff-prepare-buffer-hook)
471 ;; add control-buffer to the list of sessions
472 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
473 (setq ediff-this-buffer-ediff-sessions
475 ediff-this-buffer-ediff-sessions)))
476 (if ediff-make-buffers-readonly-at-startup
477 (setq buffer-read-only t)
478 (setq buffer-read-only nil))
481 (if (ediff-buffer-live-p ediff-ancestor-buffer)
482 (ediff-with-current-buffer ediff-ancestor-buffer
483 (ediff-nuke-selective-display)
484 (setq buffer-read-only t)
485 (run-hooks 'ediff-prepare-buffer-hook)
486 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
487 (setq ediff-this-buffer-ediff-sessions
489 ediff-this-buffer-ediff-sessions)))
492 ;; the following must be after setting up ediff-narrow-bounds AND after
493 ;; nuking selective display
494 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
495 (setq ediff-number-of-differences (length ediff-difference-vector-A))
496 (setq ediff-current-difference -1)
498 (ediff-make-current-diff-overlay 'A)
499 (ediff-make-current-diff-overlay 'B)
501 (ediff-make-current-diff-overlay 'C))
502 (if ediff-merge-with-ancestor-job
503 (ediff-make-current-diff-overlay 'Ancestor))
505 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
507 (let ((shift-A (ediff-overlay-start
508 (ediff-get-value-according-to-buffer-type
509 'A ediff-narrow-bounds)))
510 (shift-B (ediff-overlay-start
511 (ediff-get-value-according-to-buffer-type
512 'B ediff-narrow-bounds)))
513 (shift-C (ediff-overlay-start
514 (ediff-get-value-according-to-buffer-type
515 'C ediff-narrow-bounds))))
516 ;; position point in buf A
518 (select-window ediff-window-A)
520 ;; position point in buf B
522 (select-window ediff-window-B)
526 (select-window ediff-window-C)
527 (goto-char shift-C)))
530 (select-window ediff-control-window)
531 (ediff-visible-region)
533 (run-hooks 'startup-hooks)
534 (ediff-arrange-autosave-in-merge-jobs merge-buffer-file)
536 (ediff-refresh-mode-lines)
537 (setq buffer-read-only t)
538 (setq ediff-session-registry
539 (cons control-buffer ediff-session-registry))
540 (ediff-update-registry)
541 (if (ediff-buffer-live-p ediff-meta-buffer)
542 (ediff-update-meta-buffer
543 ediff-meta-buffer nil ediff-meta-session-number))
544 (run-hooks 'ediff-startup-hook)
545 ) ; eval in control-buffer
549 ;; This function assumes that we are in the window where control buffer is
551 (defun ediff-setup-control-buffer (ctl-buf)
552 "Set up window for control buffer."
553 (if (window-dedicated-p (selected-window))
554 (set-buffer ctl-buf) ; we are in control frame but just in case
555 (switch-to-buffer ctl-buf))
556 (let ((window-min-height 2))
558 (ediff-set-help-message)
559 (insert ediff-help-message)
560 (shrink-window-if-larger-than-buffer)
561 (or (ediff-multiframe-setup-p)
562 (ediff-indent-help-message))
563 (ediff-set-help-overlays)
565 (set-buffer-modified-p nil)
566 (ediff-refresh-mode-lines)
567 (setq ediff-control-window (selected-window))
568 (setq ediff-window-config-saved
569 (format "%S%S%S%S%S%S%S"
574 ediff-split-window-function
575 (ediff-multiframe-setup-p)
576 ediff-wide-display-p))
578 ;; In multiframe, toolbar is set in ediff-setup-control-frame
579 (if (not (ediff-multiframe-setup-p))
580 (ediff-make-bottom-toolbar)) ; this checks if toolbar is requested
581 (goto-char (point-min))
582 (skip-chars-forward ediff-whitespace)))
584 ;; This executes in control buffer and sets auto-save, visited file name, etc,
585 ;; in the merge buffer
586 (defun ediff-arrange-autosave-in-merge-jobs (merge-buffer-file)
587 (if (not ediff-merge-job)
589 (if (stringp merge-buffer-file)
590 (setq ediff-autostore-merges t
591 ediff-merge-store-file merge-buffer-file))
592 (if (stringp ediff-merge-store-file)
594 ;; save before leaving ctl buffer
595 (ediff-verify-file-merge-buffer ediff-merge-store-file)
596 (setq merge-buffer-file ediff-merge-store-file)
597 (ediff-with-current-buffer ediff-buffer-C
598 (set-visited-file-name merge-buffer-file))))
599 (ediff-with-current-buffer ediff-buffer-C
600 (setq buffer-offer-save t) ; ask before killing buffer
601 ;; make sure the contents is auto-saved
606 ;;; Commands for working with Ediff
608 (defun ediff-update-diffs ()
609 "Recompute difference regions in buffers A, B, and C.
610 Buffers are not synchronized with their respective files, so changes done
611 to these buffers are not saved at this point---the user can do this later,
614 (ediff-barf-if-not-control-buffer)
615 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
618 "Ancestor buffer will not be used. Recompute diffs anyway? ")))
619 (error "Recomputation of differences canceled"))
621 (let ((point-A (ediff-with-current-buffer ediff-buffer-A (point)))
622 ;;(point-B (ediff-with-current-buffer ediff-buffer-B (point)))
623 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
624 (buf-A-file-name (buffer-file-name ediff-buffer-A))
625 (buf-B-file-name (buffer-file-name ediff-buffer-B))
626 ;; (null ediff-buffer-C) is no problem, as we later check if
627 ;; ediff-buffer-C is alive
628 (buf-C-file-name (buffer-file-name ediff-buffer-C))
629 (overl-A (ediff-get-value-according-to-buffer-type
630 'A ediff-narrow-bounds))
631 (overl-B (ediff-get-value-according-to-buffer-type
632 'B ediff-narrow-bounds))
633 (overl-C (ediff-get-value-according-to-buffer-type
634 'C ediff-narrow-bounds))
635 beg-A end-A beg-B end-B beg-C end-C
636 file-A file-B file-C)
638 (if (stringp buf-A-file-name)
639 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
640 (if (stringp buf-B-file-name)
641 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
642 (if (stringp buf-C-file-name)
643 (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
645 (ediff-unselect-and-select-difference -1)
647 (setq beg-A (ediff-overlay-start overl-A)
648 beg-B (ediff-overlay-start overl-B)
649 beg-C (ediff-overlay-start overl-C)
650 end-A (ediff-overlay-end overl-A)
651 end-B (ediff-overlay-end overl-B)
652 end-C (ediff-overlay-end overl-C))
656 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
657 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
658 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
659 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
662 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
663 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
666 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
667 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
669 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
672 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
673 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
674 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
675 (ediff-clear-diff-vector
676 'ediff-difference-vector-Ancestor 'fine-diffs-also)
677 ;; let them garbage collect. we can't use the ancestor after recomputing
679 (setq ediff-difference-vector-Ancestor nil
680 ediff-ancestor-buffer nil
681 ediff-state-of-merge nil)
683 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
685 ;; In case of merge job, fool it into thinking that it is just doing
687 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
688 (ediff-3way-comparison-job ediff-3way-comparison-job)
689 (ediff-merge-job ediff-merge-job)
690 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
691 (ediff-job-name ediff-job-name))
693 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
694 ediff-3way-comparison-job t
696 ediff-merge-with-ancestor-job nil
697 ediff-job-name 'ediff-files3))
698 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
700 (setq ediff-number-of-differences (length ediff-difference-vector-A))
704 (delete-file file-C))
707 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
709 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
713 ;; Not bound to any key---to dangerous. A user can do it if necessary.
714 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
715 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
717 (ediff-barf-if-not-control-buffer)
718 (let ((bufA ediff-buffer-A)
719 (bufB ediff-buffer-B)
720 (bufC ediff-buffer-C)
721 (ctl-buf ediff-control-buffer)
722 (keep-variants ediff-keep-variants)
723 (ancestor-buf ediff-ancestor-buffer)
724 (ancestor-job ediff-merge-with-ancestor-job)
725 (merge ediff-merge-job)
726 (comparison ediff-3way-comparison-job))
727 (ediff-with-current-buffer bufA
728 (revert-buffer t noconfirm))
729 (ediff-with-current-buffer bufB
730 (revert-buffer t noconfirm))
731 ;; this should only be executed in a 3way comparison, not in merge
733 (ediff-with-current-buffer bufC
734 (revert-buffer t noconfirm)))
738 ;; the argument says whether to reverse the meaning of
739 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
741 (ediff-really-quit (not keep-variants))
744 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
745 (ediff-merge-buffers bufA bufB)))
746 (ediff-update-diffs))))
749 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
750 (defun ediff-recenter (&optional no-rehighlight)
751 "Bring the highlighted region of all buffers being compared into view.
752 Reestablish the default three-window display."
754 (ediff-barf-if-not-control-buffer)
755 (let (buffer-read-only)
756 (if (and (ediff-buffer-live-p ediff-buffer-A)
757 (ediff-buffer-live-p ediff-buffer-B)
758 (or (not ediff-3way-job)
759 (ediff-buffer-live-p ediff-buffer-C)))
761 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
762 (or (eq this-command 'ediff-quit)
763 (message ediff-KILLED-VITAL-BUFFER
767 ;; set visibility range appropriate to this invocation of Ediff.
768 (ediff-visible-region)
770 (if (and (ediff-window-display-p)
771 (symbolp this-command)
772 (symbolp last-command)
773 ;; Either one of the display-changing commands
774 (or (memq this-command
776 ediff-dir-action ediff-registry-action
778 ediff-toggle-wide-display ediff-toggle-multiframe))
779 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
780 ;; This avoids raising frames unnecessarily.
781 (and (memq this-command
782 '(ediff-next-difference
783 ediff-previous-difference
784 ediff-jump-to-difference
785 ediff-jump-to-difference-at-point))
786 (not (string-match "^ediff-" (symbol-name last-command)))
789 (if (window-live-p ediff-window-A)
790 (raise-frame (window-frame ediff-window-A)))
791 (if (window-live-p ediff-window-B)
792 (raise-frame (window-frame ediff-window-B)))
793 (if (window-live-p ediff-window-C)
794 (raise-frame (window-frame ediff-window-C)))))
795 (if (and (ediff-window-display-p)
796 (frame-live-p ediff-control-frame)
797 (not ediff-use-long-help-message)
798 (not (ediff-frame-iconified-p ediff-control-frame)))
799 (raise-frame ediff-control-frame))
801 ;; Redisplay whatever buffers are showing, if there is a selected difference
802 (let ((control-frame ediff-control-frame)
803 (control-buf ediff-control-buffer))
804 (if (and (ediff-buffer-live-p ediff-buffer-A)
805 (ediff-buffer-live-p ediff-buffer-B)
806 (or (not ediff-3way-job)
807 (ediff-buffer-live-p ediff-buffer-C)))
810 (ediff-select-difference ediff-current-difference))
812 (ediff-recenter-one-window 'A)
813 (ediff-recenter-one-window 'B)
815 (ediff-recenter-one-window 'C))
817 (ediff-with-current-buffer control-buf
818 (ediff-recenter-ancestor) ; check if ancestor is alive
820 (if (and (ediff-multiframe-setup-p)
821 (not ediff-use-long-help-message)
822 (not (ediff-frame-iconified-p ediff-control-frame)))
823 ;; never grab mouse on quit in this place
826 (eq this-command 'ediff-quit))))
830 (ediff-restore-highlighting))
831 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
834 ;; this function returns to the window it was called from
835 ;; (which was the control window)
836 (defun ediff-recenter-one-window (buf-type)
837 (if (ediff-valid-difference-p)
838 ;; context must be saved before switching to windows A/B/C
839 (let* ((ctl-wind (selected-window))
840 (shift (ediff-overlay-start
841 (ediff-get-value-according-to-buffer-type
842 buf-type ediff-narrow-bounds)))
843 (job-name ediff-job-name)
844 (control-buf ediff-control-buffer)
845 (window-name (ediff-get-symbol-from-alist
846 buf-type ediff-window-alist))
847 (window (if (window-live-p (symbol-value window-name))
848 (symbol-value window-name))))
850 (if (and window ediff-windows-job)
851 (set-window-start window shift))
854 (select-window window)
855 (ediff-deactivate-mark)
856 (ediff-position-region
857 (ediff-get-diff-posn buf-type 'beg nil control-buf)
858 (ediff-get-diff-posn buf-type 'end nil control-buf)
859 (ediff-get-diff-posn buf-type 'beg nil control-buf)
862 (select-window ctl-wind)
865 (defun ediff-recenter-ancestor ()
866 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
868 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
869 (ediff-valid-difference-p))
870 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
871 (ctl-wind (selected-window))
872 (job-name ediff-job-name)
873 (ctl-buf ediff-control-buffer))
874 (ediff-with-current-buffer ediff-ancestor-buffer
875 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
878 (select-window window)
879 (ediff-position-region
880 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
881 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
882 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
884 (select-window ctl-wind)
888 ;; This will have to be refined for 3way jobs
889 (defun ediff-toggle-split ()
890 "Toggle vertical/horizontal window split.
891 Does nothing if file-A and file-B are in different frames."
893 (ediff-barf-if-not-control-buffer)
894 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
895 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
896 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
897 (frame-A (if wind-A (window-frame wind-A)))
898 (frame-B (if wind-B (window-frame wind-B)))
899 (frame-C (if wind-C (window-frame wind-C))))
900 (if (or (eq frame-A frame-B)
901 (not (frame-live-p frame-A))
902 (not (frame-live-p frame-B))
903 (if ediff-3way-comparison-job
904 (or (not (frame-live-p frame-C))
905 (eq frame-A frame-C) (eq frame-B frame-C))))
906 (setq ediff-split-window-function
907 (if (eq ediff-split-window-function 'split-window-vertically)
908 'split-window-horizontally
909 'split-window-vertically))
910 (message "Buffers being compared are in different frames"))
911 (ediff-recenter 'no-rehighlight)))
913 (defun ediff-toggle-hilit ()
914 "Switch between highlighting using ASCII flags and highlighting using faces.
915 On a dumb terminal, switches between ASCII highlighting and no highlighting."
917 (ediff-barf-if-not-control-buffer)
919 (ediff-unselect-and-select-difference
920 ediff-current-difference 'unselect-only)
921 ;; cycle through highlighting
922 (cond ((and ediff-use-faces
923 (ediff-has-face-support-p)
924 ediff-highlight-all-diffs)
925 (message "Unhighlighting unselected difference regions")
926 (setq ediff-highlight-all-diffs nil
927 ediff-highlighting-style 'face))
928 ((or (and ediff-use-faces (ediff-has-face-support-p)
929 (eq ediff-highlighting-style 'face)) ; has face support
930 (and (not (ediff-has-face-support-p)) ; no face support
931 (eq ediff-highlighting-style 'off)))
932 (message "Highlighting with ASCII flags")
933 (setq ediff-highlighting-style 'ascii
934 ediff-highlight-all-diffs nil
935 ediff-use-faces nil))
936 ((eq ediff-highlighting-style 'ascii)
937 (message "ASCII highlighting flags removed")
938 (setq ediff-highlighting-style 'off
939 ediff-highlight-all-diffs nil))
940 ((ediff-has-face-support-p) ; catch-all for cases with face support
941 (message "Re-highlighting all difference regions")
942 (setq ediff-use-faces t
943 ediff-highlighting-style 'face
944 ediff-highlight-all-diffs t)))
946 (if (and ediff-use-faces ediff-highlight-all-diffs)
947 (ediff-paint-background-regions)
948 (ediff-paint-background-regions 'unhighlight))
950 (ediff-unselect-and-select-difference
951 ediff-current-difference 'select-only))
954 (defun ediff-toggle-autorefine ()
955 "Toggle auto-refine mode."
957 (ediff-barf-if-not-control-buffer)
959 (error "No fine differences in this mode"))
960 (cond ((eq ediff-auto-refine 'nix)
961 (setq ediff-auto-refine 'on)
962 (ediff-make-fine-diffs ediff-current-difference 'noforce)
963 (message "Auto-refining is ON"))
964 ((eq ediff-auto-refine 'on)
965 (message "Auto-refining is OFF")
966 (setq ediff-auto-refine 'off))
968 (ediff-set-fine-diff-properties ediff-current-difference 'default)
969 (message "Refinements are HIDDEN")
970 (setq ediff-auto-refine 'nix))
973 (defun ediff-show-ancestor ()
974 "Show the ancestor buffer in a suitable window."
977 (or (ediff-buffer-live-p ediff-ancestor-buffer)
978 (if ediff-merge-with-ancestor-job
979 (error "Lost connection to ancestor buffer...sorry")
980 (error "Not merging with ancestor")))
982 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
983 (raise-frame (window-frame wind)))
984 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
986 (defun ediff-make-or-kill-fine-diffs (arg)
987 "Compute fine diffs. With negative prefix arg, kill fine diffs.
988 In both cases, operates on the current difference region."
990 (ediff-barf-if-not-control-buffer)
992 (ediff-clear-fine-differences ediff-current-difference))
993 ((and (numberp arg) (< arg 0))
994 (ediff-clear-fine-differences ediff-current-difference))
995 (t (ediff-make-fine-diffs))))
998 (defun ediff-toggle-help ()
999 "Toggle short/long help message."
1001 (ediff-barf-if-not-control-buffer)
1002 (let (buffer-read-only)
1004 (setq ediff-use-long-help-message (not ediff-use-long-help-message))
1005 (ediff-set-help-message))
1006 ;; remember the icon status of the control frame when the user requested
1007 ;; full control message
1008 (if (and ediff-use-long-help-message (ediff-multiframe-setup-p))
1009 (setq ediff-prefer-iconified-control-frame
1010 (ediff-frame-iconified-p ediff-control-frame)))
1012 (setq ediff-window-config-saved "") ; force redisplay
1013 (ediff-recenter 'no-rehighlight))
1016 ;; If BUF, this is the buffer to toggle, not current buffer.
1017 (defun ediff-toggle-read-only (&optional buf)
1018 "Toggle read-only in current buffer.
1019 If buffer is under version control and locked, check it out first.
1020 If optional argument BUF is specified, toggle read-only in that buffer instead
1021 of the current buffer."
1023 (ediff-barf-if-not-control-buffer)
1024 (let ((ctl-buf (if (null buf) (current-buffer)))
1025 (buf-type (ediff-char-to-buftype last-command-char)))
1026 (or buf (ediff-recenter))
1028 (setq buf (ediff-get-buffer buf-type)))
1030 (ediff-with-current-buffer buf ; eval in buf A/B/C
1031 (let* ((file (buffer-file-name buf))
1032 (file-writable (and file
1033 (file-exists-p file)
1034 (file-writable-p file)))
1035 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
1036 ((ediff-file-checked-out-p file)
1038 (file-writable 'toggle-read-only)
1039 (t (key-binding "\C-x\C-q")))))
1040 ;; If the file is checked in, make sure we don't make buffer modifiable
1041 ;; without warning the user. The user can fool our checks by making the
1042 ;; buffer non-RO without checking the file out. We regard this as a
1044 (if (and (ediff-file-checked-in-p file)
1045 ;; If ctl-buf is null, this means we called this
1046 ;; non-interactively, in which case don't ask questions
1048 (cond ((not buffer-read-only)
1049 (setq toggle-ro-cmd 'toggle-read-only))
1050 ((and (or (beep 1) t) ; always beep
1053 "File %s is under version control. Check it out? "
1054 (ediff-abbreviate-file-name file))))
1055 ;; if we checked the file out, we should also change the
1056 ;; original state of buffer-read-only to nil. If we don't
1057 ;; do this, the mode line will show %%, since the file was
1058 ;; RO before ediff started, so the user will think the file
1060 (ediff-with-current-buffer ctl-buf
1061 (ediff-change-saved-variable
1062 'buffer-read-only nil buf-type)))
1064 (setq toggle-ro-cmd 'toggle-read-only)
1067 "Boy, this is risky! Don't modify this file...")
1068 (sit-for 3)))) ; let the user see the warning
1069 (if (and toggle-ro-cmd
1070 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1072 (save-window-excursion
1073 (select-window (ediff-get-visible-buffer-window buf))
1074 (command-execute toggle-ro-cmd)))
1075 (error "Don't know how to toggle read-only in buffer %S" buf))
1077 ;; Check if we made the current buffer updatable, but its file is RO.
1078 ;; Signal a warning in this case.
1079 (if (and file (not buffer-read-only)
1080 (eq this-command 'ediff-toggle-read-only)
1081 (file-exists-p file)
1082 (not (file-writable-p file)))
1083 (message "Warning: file %s is read-only"
1084 (ediff-abbreviate-file-name file) (beep 1)))
1087 ;; checkout if visited file is checked in
1088 (defun ediff-maybe-checkout (buf)
1089 (let ((file (expand-file-name (buffer-file-name buf)))
1090 (checkout-function (key-binding "\C-x\C-q")))
1091 (if (and (ediff-file-checked-in-p file)
1095 "File %s is under version control. Check it out? "
1096 (ediff-abbreviate-file-name file))))
1097 (ediff-with-current-buffer buf
1098 (command-execute checkout-function)))))
1101 ;; This is a simple-minded check for whether a file is under version control.
1102 ;; If file,v exists but file doesn't, this file is considered to be not checked
1103 ;; in and not checked out for the purpose of patching (since patch won't be
1104 ;; able to read such a file anyway).
1105 ;; FILE is a string representing file name
1106 ;;(defun ediff-file-under-version-control (file)
1107 ;; (let* ((filedir (file-name-directory file))
1108 ;; (file-nondir (file-name-nondirectory file))
1109 ;; (trial (concat file-nondir ",v"))
1110 ;; (full-trial (concat filedir trial))
1111 ;; (full-rcs-trial (concat filedir "RCS/" trial)))
1112 ;; (and (stringp file)
1113 ;; (file-exists-p file)
1116 ;; (file-exists-p full-trial)
1117 ;; ;; in FAT FS, `file,v' and `file' may turn out to be the same!
1118 ;; ;; don't be fooled by this!
1119 ;; (not (equal (file-attributes file)
1120 ;; (file-attributes full-trial))))
1121 ;; ;; check if a version is in RCS/ directory
1122 ;; (file-exists-p full-rcs-trial)))
1126 (defsubst ediff-file-checked-out-p (file)
1127 (or (not (featurep 'vc-hooks))
1128 (and (vc-backend file)
1129 (if (fboundp 'vc-state)
1130 (or (memq (vc-state file) '(edited needs-merge))
1131 (stringp (vc-state file)))
1132 ;; XEmacs has no vc-state
1133 (vc-locking-user file))
1136 (defsubst ediff-file-checked-in-p (file)
1137 (and (featurep 'vc-hooks)
1138 ;; CVS files are considered not checked in
1139 (not (memq (vc-backend file) '(nil CVS)))
1140 (if (fboundp 'vc-state)
1142 (not (memq (vc-state file) '(edited needs-merge)))
1143 (not (stringp (vc-state file))))
1144 ;; XEmacs has no vc-state
1145 (not (vc-locking-user file)))
1148 (defun ediff-file-compressed-p (file)
1150 (require 'jka-compr)
1152 (if (featurep 'jka-compr)
1153 (string-match (jka-compr-build-file-regexp) file)))
1156 (defun ediff-swap-buffers ()
1157 "Rotate the display of buffers A, B, and C."
1159 (ediff-barf-if-not-control-buffer)
1160 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1161 (let ((buf ediff-buffer-A)
1162 (values ediff-buffer-values-orig-A)
1163 (diff-vec ediff-difference-vector-A)
1164 (hide-regexp ediff-regexp-hide-A)
1165 (focus-regexp ediff-regexp-focus-A)
1166 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1167 (overlay (if (ediff-has-face-support-p)
1168 ediff-current-diff-overlay-A)))
1169 (if ediff-3way-comparison-job
1171 (set-window-buffer ediff-window-A ediff-buffer-C)
1172 (set-window-buffer ediff-window-B ediff-buffer-A)
1173 (set-window-buffer ediff-window-C ediff-buffer-B)
1175 (set-window-buffer ediff-window-A ediff-buffer-B)
1176 (set-window-buffer ediff-window-B ediff-buffer-A))
1177 ;; swap diff buffers
1178 (if ediff-3way-comparison-job
1179 (setq ediff-buffer-A ediff-buffer-C
1180 ediff-buffer-C ediff-buffer-B
1182 (setq ediff-buffer-A ediff-buffer-B
1183 ediff-buffer-B buf))
1185 ;; swap saved buffer characteristics
1186 (if ediff-3way-comparison-job
1187 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1188 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1189 ediff-buffer-values-orig-B values)
1190 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1191 ediff-buffer-values-orig-B values))
1193 ;; swap diff vectors
1194 (if ediff-3way-comparison-job
1195 (setq ediff-difference-vector-A ediff-difference-vector-C
1196 ediff-difference-vector-C ediff-difference-vector-B
1197 ediff-difference-vector-B diff-vec)
1198 (setq ediff-difference-vector-A ediff-difference-vector-B
1199 ediff-difference-vector-B diff-vec))
1201 ;; swap hide/focus regexp
1202 (if ediff-3way-comparison-job
1203 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1204 ediff-regexp-hide-C ediff-regexp-hide-B
1205 ediff-regexp-hide-B hide-regexp
1206 ediff-regexp-focus-A ediff-regexp-focus-C
1207 ediff-regexp-focus-C ediff-regexp-focus-B
1208 ediff-regexp-focus-B focus-regexp)
1209 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1210 ediff-regexp-hide-B hide-regexp
1211 ediff-regexp-focus-A ediff-regexp-focus-B
1212 ediff-regexp-focus-B focus-regexp))
1214 ;; The following is needed for XEmacs, since there one can't move
1215 ;; overlay to another buffer. In Emacs, this swap is redundant.
1216 (if (ediff-has-face-support-p)
1217 (if ediff-3way-comparison-job
1218 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1219 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1220 ediff-current-diff-overlay-B overlay)
1221 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1222 ediff-current-diff-overlay-B overlay)))
1225 (setq ediff-wide-bounds
1226 (cond (ediff-3way-comparison-job
1227 (list (nth 2 ediff-wide-bounds)
1228 (nth 0 ediff-wide-bounds)
1229 (nth 1 ediff-wide-bounds)))
1231 (list (nth 1 ediff-wide-bounds)
1232 (nth 0 ediff-wide-bounds)
1233 (nth 2 ediff-wide-bounds)))
1235 (list (nth 1 ediff-wide-bounds)
1236 (nth 0 ediff-wide-bounds)))))
1237 ;; swap narrow bounds
1238 (setq ediff-narrow-bounds
1239 (cond (ediff-3way-comparison-job
1240 (list (nth 2 ediff-narrow-bounds)
1241 (nth 0 ediff-narrow-bounds)
1242 (nth 1 ediff-narrow-bounds)))
1244 (list (nth 1 ediff-narrow-bounds)
1245 (nth 0 ediff-narrow-bounds)
1246 (nth 2 ediff-narrow-bounds)))
1248 (list (nth 1 ediff-narrow-bounds)
1249 (nth 0 ediff-narrow-bounds)))))
1250 (if wide-visibility-p
1251 (setq ediff-visible-bounds ediff-wide-bounds)
1252 (setq ediff-visible-bounds ediff-narrow-bounds))
1255 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1256 (ediff-recenter 'no-rehighlight)
1260 (defun ediff-toggle-wide-display ()
1261 "Toggle wide/regular display.
1262 This is especially useful when comparing buffers side-by-side."
1264 (ediff-barf-if-not-control-buffer)
1265 (or (ediff-window-display-p)
1266 (error "%sEmacs is not running as a window application"
1267 (if ediff-emacs-p "" "X")))
1268 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1269 (let ((ctl-buf ediff-control-buffer))
1270 (setq ediff-wide-display-p (not ediff-wide-display-p))
1271 (if (not ediff-wide-display-p)
1272 (ediff-with-current-buffer ctl-buf
1273 (modify-frame-parameters
1274 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1275 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1276 ;; restore control buf, since ctl window may have been deleted
1278 (set-buffer ctl-buf)
1279 (setq ediff-wide-display-orig-parameters nil
1280 ediff-window-B nil) ; force update of window config
1281 (ediff-recenter 'no-rehighlight))
1282 (funcall ediff-make-wide-display-function)
1283 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1284 (ediff-with-current-buffer ctl-buf
1285 (setq ediff-window-B nil) ; force update of window config
1286 (ediff-recenter 'no-rehighlight)))))
1289 (defun ediff-toggle-multiframe ()
1290 "Switch from multiframe display to single-frame display and back.
1291 To change the default, set the variable `ediff-window-setup-function',
1294 (let (window-setup-func)
1295 (or (ediff-window-display-p)
1296 (error "%sEmacs is not running as a window application"
1297 (if ediff-emacs-p "" "X")))
1299 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1300 (setq window-setup-func 'ediff-setup-windows-plain))
1301 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1302 (if (ediff-in-control-buffer-p)
1303 (ediff-kill-bottom-toolbar))
1304 (setq window-setup-func 'ediff-setup-windows-multiframe)))
1307 (setq-default ediff-window-setup-function window-setup-func)
1308 ;; change in all active ediff sessions
1309 (mapcar (lambda(buf) (ediff-with-current-buffer buf
1310 (setq ediff-window-setup-function window-setup-func
1311 ediff-window-B nil)))
1312 ediff-session-registry)
1313 (if (ediff-in-control-buffer-p)
1314 (ediff-recenter 'no-rehighlight))))
1318 (defun ediff-toggle-use-toolbar ()
1319 "Enable or disable Ediff toolbar.
1320 Works only in versions of Emacs that support toolbars.
1321 To change the default, set the variable `ediff-use-toolbar-p', which see."
1323 (if (featurep 'ediff-tbar)
1325 (or (ediff-window-display-p)
1326 (error "%sEmacs is not running as a window application"
1327 (if ediff-emacs-p "" "X")))
1328 (if (ediff-use-toolbar-p)
1329 (ediff-kill-bottom-toolbar))
1330 ;; do this only after killing the toolbar
1331 (setq ediff-use-toolbar-p (not ediff-use-toolbar-p))
1333 (mapcar (lambda(buf)
1334 (ediff-with-current-buffer buf
1336 (setq ediff-window-config-saved "")
1338 ediff-session-registry)
1339 (if (ediff-in-control-buffer-p)
1340 (ediff-recenter 'no-rehighlight)))))
1343 ;; if was using toolbar, kill it
1344 (defun ediff-kill-bottom-toolbar ()
1345 ;; Using ctl-buffer or ediff-control-window for LOCALE does not
1346 ;; work properly in XEmacs 19.14: we have to use
1348 ;; The problem with this is that any previous bottom-toolbar
1349 ;; will not re-appear after our cleanup here. Is there a way
1350 ;; to do "push" and "pop" toolbars ? --marcpa
1351 (if (ediff-use-toolbar-p)
1352 (ediff-cond-compile-for-xemacs-or-emacs
1354 (set-specifier bottom-toolbar (list (selected-frame) nil))
1355 (set-specifier bottom-toolbar-visible-p (list (selected-frame) nil)))
1360 ;; If wants to use toolbar, make it.
1361 ;; If not, zero the toolbar for XEmacs.
1362 ;; Do nothing for Emacs.
1363 (defun ediff-make-bottom-toolbar (&optional frame)
1364 (if (ediff-window-display-p)
1366 (setq frame (or frame (selected-frame)))
1367 (cond ((ediff-use-toolbar-p) ; this checks for XEmacs
1368 (ediff-cond-compile-for-xemacs-or-emacs
1372 (list frame (if (ediff-3way-comparison-job)
1373 ediff-toolbar-3way ediff-toolbar)))
1374 (set-specifier bottom-toolbar-visible-p (list frame t))
1375 (set-specifier bottom-toolbar-height
1376 (list frame ediff-toolbar-height)))
1380 ((ediff-has-toolbar-support-p)
1381 (ediff-cond-compile-for-xemacs-or-emacs
1382 (set-specifier bottom-toolbar-height (list frame 0)) ; xemacs
1391 (defun ediff-toggle-show-clashes-only ()
1392 "Toggle the mode that shows only the merge regions where both variants differ from the ancestor."
1394 (ediff-barf-if-not-control-buffer)
1395 (if (not ediff-merge-with-ancestor-job)
1396 (error "This command makes sense only when merging with an ancestor"))
1397 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1398 (if ediff-show-clashes-only
1399 (message "Focus on regions where both buffers differ from the ancestor")
1400 (message "Canceling focus on regions where changes clash")))
1402 (defun ediff-toggle-skip-changed-regions ()
1403 "Toggle the mode that skips the merge regions that differ from the default."
1405 (ediff-barf-if-not-control-buffer)
1406 (setq ediff-skip-merge-regions-that-differ-from-default
1407 (not ediff-skip-merge-regions-that-differ-from-default))
1408 (if ediff-skip-merge-regions-that-differ-from-default
1409 (message "Skipping regions that differ from default setting")
1410 (message "Showing regions that differ from default setting")))
1414 ;; Widening/narrowing
1416 (defun ediff-toggle-narrow-region ()
1417 "Toggle narrowing in buffers A, B, and C.
1418 Used in ediff-windows/regions only."
1420 (if (eq ediff-buffer-A ediff-buffer-B)
1421 (error ediff-NO-DIFFERENCES))
1422 (if (eq ediff-visible-bounds ediff-wide-bounds)
1423 (setq ediff-visible-bounds ediff-narrow-bounds)
1424 (setq ediff-visible-bounds ediff-wide-bounds))
1425 (ediff-recenter 'no-rehighlight))
1427 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1428 ;; ediff-wide-bounds, then this actually widens.
1429 ;; This function does nothing if job-name is not
1430 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1431 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1432 ;; to two different regions in one buffer.
1433 (defun ediff-visible-region ()
1434 (if (or (eq ediff-buffer-A ediff-buffer-B)
1435 (eq ediff-buffer-A ediff-buffer-C)
1436 (eq ediff-buffer-C ediff-buffer-B))
1438 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1439 ;; Otherwise, always use full range.
1440 (if (not ediff-narrow-job)
1441 (setq ediff-visible-bounds ediff-wide-bounds))
1442 (let ((overl-A (ediff-get-value-according-to-buffer-type
1443 'A ediff-visible-bounds))
1444 (overl-B (ediff-get-value-according-to-buffer-type
1445 'B ediff-visible-bounds))
1446 (overl-C (ediff-get-value-according-to-buffer-type
1447 'C ediff-visible-bounds))
1449 (ediff-with-current-buffer ediff-buffer-A
1450 (if (ediff-overlay-buffer overl-A)
1452 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A))))
1453 (ediff-with-current-buffer ediff-buffer-B
1454 (if (ediff-overlay-buffer overl-B)
1456 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B))))
1458 (if (and ediff-3way-job (ediff-overlay-buffer overl-C))
1459 (ediff-with-current-buffer ediff-buffer-C
1461 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1465 ;; Window scrolling operations
1467 ;; Performs some operation on the two file windows (if they are showing).
1468 ;; Traps all errors on the operation in windows A/B/C.
1469 ;; Usually, errors come from scrolling off the
1470 ;; beginning or end of the buffer, and this gives error messages.
1471 (defun ediff-operate-on-windows (operation arg)
1473 ;; make sure windows aren't dead
1474 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1475 (ediff-recenter 'no-rehighlight))
1476 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1477 (ediff-buffer-live-p ediff-buffer-B)
1478 (or (not ediff-3way-job) ediff-buffer-C)
1480 (error ediff-KILLED-VITAL-BUFFER))
1482 (let* ((wind (selected-window))
1483 (wind-A ediff-window-A)
1484 (wind-B ediff-window-B)
1485 (wind-C ediff-window-C)
1486 (coefA (ediff-get-region-size-coefficient 'A operation))
1487 (coefB (ediff-get-region-size-coefficient 'B operation))
1488 (three-way ediff-3way-job)
1489 (coefC (if three-way
1490 (ediff-get-region-size-coefficient 'C operation))))
1492 (select-window wind-A)
1494 (funcall operation (round (* coefA arg)))
1496 (select-window wind-B)
1498 (funcall operation (round (* coefB arg)))
1502 (select-window wind-C)
1504 (funcall operation (round (* coefC arg)))
1506 (select-window wind)))
1508 (defun ediff-scroll-vertically (&optional arg)
1509 "Vertically scroll buffers A, B \(and C if appropriate\).
1510 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1511 the one half of the height of window-A."
1513 (ediff-barf-if-not-control-buffer)
1515 ;; make sure windows aren't dead
1516 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1517 (ediff-recenter 'no-rehighlight))
1518 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1519 (ediff-buffer-live-p ediff-buffer-B)
1520 (or (not ediff-3way-job)
1521 (ediff-buffer-live-p ediff-buffer-C))
1523 (error ediff-KILLED-VITAL-BUFFER))
1525 (ediff-operate-on-windows
1526 (if (memq last-command-char '(?v ?\C-v))
1529 ;; calculate argument to scroll-up/down
1530 ;; if there is an explicit argument
1531 (if (and arg (not (equal arg '-)))
1533 (prefix-numeric-value arg)
1534 ;; if not, see if we can determine a default amount (the window height)
1535 (let (default-amount)
1536 (setq default-amount
1537 (- (/ (min (window-height ediff-window-A)
1538 (window-height ediff-window-B)
1540 (window-height ediff-window-C)
1541 500)) ; some large number
1543 1 next-screen-context-lines))
1546 ;; C-u as argument means half of default amount
1547 (/ default-amount 2)
1548 ;; no argument means default amount
1552 (defun ediff-scroll-horizontally (&optional arg)
1553 "Horizontally scroll buffers A, B \(and C if appropriate\).
1554 If an argument is given, that is how many columns are scrolled, else nearly
1555 the width of the A/B/C windows."
1557 (ediff-barf-if-not-control-buffer)
1559 ;; make sure windows aren't dead
1560 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1561 (ediff-recenter 'no-rehighlight))
1562 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1563 (ediff-buffer-live-p ediff-buffer-B)
1564 (or (not ediff-3way-job)
1565 (ediff-buffer-live-p ediff-buffer-C))
1567 (error ediff-KILLED-VITAL-BUFFER))
1569 (ediff-operate-on-windows
1570 ;; Arrange for scroll-left and scroll-right being called
1571 ;; interactively so that they set the window's min_hscroll.
1572 ;; Otherwise, automatic hscrolling will undo the effect of
1574 (if (= last-command-char ?<)
1576 (let ((prefix-arg arg))
1577 (call-interactively 'scroll-left)))
1579 (let ((prefix-arg arg))
1580 (call-interactively 'scroll-right))))
1581 ;; calculate argument to scroll-left/right
1582 ;; if there is an explicit argument
1583 (if (and arg (not (equal arg '-)))
1585 (prefix-numeric-value arg)
1586 ;; if not, see if we can determine a default amount
1587 ;; (half the window width)
1588 (if (null ediff-control-window)
1589 ;; no control window, use nil
1591 (let ((default-amount
1592 (- (/ (min (window-width ediff-window-A)
1593 (window-width ediff-window-B)
1594 (if ediff-3way-comparison-job
1595 (window-width ediff-window-C)
1596 500) ; some large number
1602 ;; C-u as argument means half of default amount
1603 (/ default-amount 2)
1604 ;; no argument means default amount
1605 default-amount))))))
1608 ;;BEG, END show the region to be positioned.
1609 ;;JOB-NAME holds ediff-job-name. The ediff-windows job positions regions
1611 (defun ediff-position-region (beg end pos job-name)
1612 (if (> end (point-max))
1613 (setq end (point-max)))
1614 (if ediff-windows-job
1615 (if (pos-visible-in-window-p end)
1616 () ; do nothing, wind is already positioned
1617 ;; at this point, windows are positioned at the beginning of the
1618 ;; file regions (not diff-regions) being compared.
1620 (move-to-window-line (- (window-height) 2))
1621 (let ((amount (+ 2 (count-lines (point) end))))
1622 (scroll-up amount))))
1623 (set-window-start (selected-window) beg)
1624 (if (pos-visible-in-window-p end)
1625 ;; Determine the number of lines that the region occupies
1628 (while ( and (> end (progn
1629 (move-to-window-line lines)
1631 ;; `end' may be beyond the window bottom, so check
1632 ;; that we are making progress
1633 (< prev-point (point)))
1634 (setq prev-point (point))
1635 (setq lines (1+ lines)))
1636 ;; And position the beginning on the right line
1638 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1646 ;; get number of lines from window start to region end
1647 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1648 (or n (setq n ediff-current-difference))
1649 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1650 (ediff-with-current-buffer ctl-buf
1651 (let* ((buf (ediff-get-buffer buf-type))
1652 (wind (eval (ediff-get-symbol-from-alist
1653 buf-type ediff-window-alist)))
1654 (beg (window-start wind))
1655 (end (ediff-get-diff-posn buf-type 'end))
1657 (ediff-with-current-buffer buf
1659 (setq lines (count-lines beg end))
1664 ;; Calculate the number of lines from window end to the start of diff region
1665 (defun ediff-get-lines-to-region-start (buf-type &optional diff-num ctl-buf)
1666 (or diff-num (setq diff-num ediff-current-difference))
1667 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1668 (ediff-with-current-buffer ctl-buf
1669 (let* ((buf (ediff-get-buffer buf-type))
1670 (wind (eval (ediff-get-symbol-from-alist
1671 buf-type ediff-window-alist)))
1672 (end (or (window-end wind) (window-end wind t)))
1673 (beg (ediff-get-diff-posn buf-type 'beg diff-num)))
1674 (ediff-with-current-buffer buf
1676 (count-lines (max beg (point-min)) (min end (point-max))) 0))
1680 ;; region size coefficient is a coefficient by which to adjust scrolling
1681 ;; up/down of the window displaying buffer of type BUFTYPE.
1682 ;; The purpose of this coefficient is to make the windows scroll in sync, so
1683 ;; that it won't happen that one diff region is scrolled off while the other is
1686 ;; If the difference region is invalid, the coefficient is 1
1687 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1688 (ediff-with-current-buffer (or ctl-buf ediff-control-buffer)
1689 (if (ediff-valid-difference-p n)
1690 (let* ((func (cond ((eq op 'scroll-down)
1691 'ediff-get-lines-to-region-start)
1693 'ediff-get-lines-to-region-end)
1694 (t '(lambda (a b c) 0))))
1695 (max-lines (max (funcall func 'A n ctl-buf)
1696 (funcall func 'B n ctl-buf)
1697 (if (ediff-buffer-live-p ediff-buffer-C)
1698 (funcall func 'C n ctl-buf)
1700 ;; this covers the horizontal coefficient as well:
1701 ;; if max-lines = 0 then coef = 1
1703 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1709 (defun ediff-next-difference (&optional arg)
1710 "Advance to the next difference.
1711 With a prefix argument, go forward that many differences."
1713 (ediff-barf-if-not-control-buffer)
1714 (if (< ediff-current-difference ediff-number-of-differences)
1715 (let ((n (min ediff-number-of-differences
1716 (+ ediff-current-difference (or arg 1))))
1717 non-clash-skip skip-changed regexp-skip)
1719 (ediff-visible-region)
1720 (or (>= n ediff-number-of-differences)
1721 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1722 ;; this won't exec if regexp-skip is t
1723 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1725 (ediff-skip-merge-region-if-changed-from-default-p n))
1726 (ediff-install-fine-diff-if-necessary n))
1728 (while (and (< n ediff-number-of-differences)
1732 ;; skip clashes, if necessary
1734 ;; skip processed regions
1736 ;; skip difference regions that differ in white space
1737 (and ediff-ignore-similar-regions
1738 (or (eq (ediff-no-fine-diffs-p n) t)
1739 (and (ediff-merge-job)
1740 (eq (ediff-no-fine-diffs-p n) 'C)))
1743 (if (= 0 (mod n 20))
1744 (message "Skipped over region %d and counting ..." n))
1745 (or (>= n ediff-number-of-differences)
1746 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1747 ;; this won't exec if regexp-skip is t
1748 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1750 (ediff-skip-merge-region-if-changed-from-default-p n))
1751 (ediff-install-fine-diff-if-necessary n))
1754 (ediff-unselect-and-select-difference n)
1756 (ediff-visible-region)
1757 (error "At end of the difference list")))
1759 (defun ediff-previous-difference (&optional arg)
1760 "Go to the previous difference.
1761 With a prefix argument, go back that many differences."
1763 (ediff-barf-if-not-control-buffer)
1764 (if (> ediff-current-difference -1)
1765 (let ((n (max -1 (- ediff-current-difference (or arg 1))))
1766 non-clash-skip skip-changed regexp-skip)
1768 (ediff-visible-region)
1770 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1771 ;; this won't exec if regexp-skip is t
1772 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1774 (ediff-skip-merge-region-if-changed-from-default-p n))
1775 (ediff-install-fine-diff-if-necessary n))
1776 (while (and (> n -1)
1780 ;; skip clashes, if necessary
1782 ;; skipp changed regions
1784 ;; skip difference regions that differ in white space
1785 (and ediff-ignore-similar-regions
1786 (or (eq (ediff-no-fine-diffs-p n) t)
1787 (and (ediff-merge-job)
1788 (eq (ediff-no-fine-diffs-p n) 'C)))
1790 (if (= 0 (mod (1+ n) 20))
1791 (message "Skipped over region %d and counting ..." (1+ n)))
1794 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1795 ;; this won't exec if regexp-skip is t
1796 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1798 (ediff-skip-merge-region-if-changed-from-default-p n))
1799 (ediff-install-fine-diff-if-necessary n))
1802 (ediff-unselect-and-select-difference n)
1804 (ediff-visible-region)
1805 (error "At beginning of the difference list")))
1807 ;; The diff number is as perceived by the user (i.e., 1+ the internal
1809 (defun ediff-jump-to-difference (difference-number)
1810 "Go to the difference specified as a prefix argument.
1811 If the prefix is negative, count differences from the end."
1813 (ediff-barf-if-not-control-buffer)
1814 (setq difference-number
1815 (cond ((< difference-number 0)
1816 (+ ediff-number-of-differences difference-number))
1817 ((> difference-number 0) (1- difference-number))
1819 ;; -1 is allowed by ediff-unselect-and-select-difference --- it is the
1820 ;; position before the first one.
1821 (if (and (>= difference-number -1)
1822 (<= difference-number ediff-number-of-differences))
1823 (ediff-unselect-and-select-difference difference-number)
1824 (error ediff-BAD-DIFF-NUMBER
1825 this-command (1+ difference-number) ediff-number-of-differences)))
1827 (defun ediff-jump-to-difference-at-point (arg)
1828 "Go to difference closest to the point in buffer A, B, or C.
1829 The buffer depends on last command character \(a, b, or c\) that invoked this
1830 command. For instance, if the command was `ga' then the point value in buffer
1832 With a prefix argument, synchronize all files around the current point position
1833 in the specified buffer."
1835 (ediff-barf-if-not-control-buffer)
1836 (let* ((buf-type (ediff-char-to-buftype last-command-char))
1837 (buffer (ediff-get-buffer buf-type))
1838 (pt (ediff-with-current-buffer buffer (point)))
1839 (diff-no (ediff-diff-at-point buf-type nil (if arg 'after)))
1840 (past-last-diff (< ediff-number-of-differences diff-no))
1841 (beg (if past-last-diff
1842 (ediff-with-current-buffer buffer (point-max))
1843 (ediff-get-diff-posn buf-type 'beg (1- diff-no))))
1844 ctl-wind wind-A wind-B wind-C
1847 (ediff-jump-to-difference -1)
1848 (ediff-jump-to-difference diff-no))
1849 (setq ctl-wind (selected-window)
1850 wind-A ediff-window-A
1851 wind-B ediff-window-B
1852 wind-C ediff-window-C)
1855 (ediff-with-current-buffer buffer
1856 (setq shift (- beg pt)))
1857 (select-window wind-A)
1858 (if past-last-diff (goto-char (point-max)))
1860 (backward-char shift) ; noerror, if beginning of buffer
1863 (select-window wind-B)
1864 (if past-last-diff (goto-char (point-max)))
1866 (backward-char shift) ; noerror, if beginning of buffer
1869 (if (window-live-p wind-C)
1871 (select-window wind-C)
1872 (if past-last-diff (goto-char (point-max)))
1874 (backward-char shift) ; noerror, if beginning of buffer
1878 (select-window ctl-wind)
1883 ;; find region most related to the current point position (or POS, if given)
1884 ;; returns diff number as seen by the user (i.e., 1+ the internal
1886 ;; The optional argument WHICH-DIFF can be `after' or `before'. If `after',
1887 ;; find the diff after the point. If `before', find the diff before the
1888 ;; point. If the point is inside a diff, return that diff.
1889 (defun ediff-diff-at-point (buf-type &optional pos which-diff)
1890 (let ((buffer (ediff-get-buffer buf-type))
1891 (ctl-buffer ediff-control-buffer)
1892 (max-dif-num (1- ediff-number-of-differences))
1899 (ediff-with-current-buffer buffer
1900 (setq pos (or pos (point)))
1901 (while (and (or (< pos prev-beg) (> pos beg))
1902 (< diff-no max-dif-num))
1903 (setq diff-no (1+ diff-no))
1906 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1907 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1910 ;; boost diff-no by 1, if past the last diff region
1911 (if (and (memq which-diff '(after before))
1912 (> pos beg) (= diff-no max-dif-num))
1913 (setq diff-no (1+ diff-no)))
1915 (cond ((eq which-diff 'after) (1+ diff-no))
1916 ((eq which-diff 'before) diff-no)
1917 ((< (abs (count-lines pos (max 1 prev-end)))
1918 (abs (count-lines pos (max 1 beg))))
1919 diff-no) ; choose prev difference
1921 (1+ diff-no))) ; choose next difference
1927 (defun ediff-diff-to-diff (arg &optional keys)
1928 "Copy buffer-X'th difference region to buffer Y \(X,Y are A, B, or C\).
1929 If numerical prefix argument, copy the difference specified in the arg.
1930 Otherwise, copy the difference given by `ediff-current-difference'.
1931 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1932 `ac', etc., which is used to determine the types of buffers to be used for
1933 copying difference regions. The first character in the sequence specifies
1934 the source buffer and the second specifies the target.
1936 If the second optional argument, a 2-character string, is given, use it to
1937 determine the source and the target buffers instead of the command keys."
1939 (ediff-barf-if-not-control-buffer)
1940 (or keys (setq keys (this-command-keys)))
1941 (if (eq arg '-) (setq arg -1)) ; translate neg arg to -1
1942 (if (numberp arg) (ediff-jump-to-difference arg))
1944 (let* ((key1 (aref keys 0))
1945 (key2 (aref keys 1))
1946 (char1 (ediff-event-key key1))
1947 (char2 (ediff-event-key key2))
1949 (ediff-copy-diff ediff-current-difference
1950 (ediff-char-to-buftype char1)
1951 (ediff-char-to-buftype char2))
1952 ;; recenter with rehighlighting, but no messages
1955 (defun ediff-copy-A-to-B (arg)
1956 "Copy ARGth difference region from buffer A to B.
1957 ARG is a prefix argument. If nil, copy the current difference region."
1959 (ediff-diff-to-diff arg "ab"))
1961 (defun ediff-copy-B-to-A (arg)
1962 "Copy ARGth difference region from buffer B to A.
1963 ARG is a prefix argument. If nil, copy the current difference region."
1965 (ediff-diff-to-diff arg "ba"))
1967 (defun ediff-copy-A-to-C (arg)
1968 "Copy ARGth difference region from buffer A to buffer C.
1969 ARG is a prefix argument. If nil, copy the current difference region."
1971 (ediff-diff-to-diff arg "ac"))
1973 (defun ediff-copy-B-to-C (arg)
1974 "Copy ARGth difference region from buffer B to buffer C.
1975 ARG is a prefix argument. If nil, copy the current difference region."
1977 (ediff-diff-to-diff arg "bc"))
1979 (defun ediff-copy-C-to-B (arg)
1980 "Copy ARGth difference region from buffer C to B.
1981 ARG is a prefix argument. If nil, copy the current difference region."
1983 (ediff-diff-to-diff arg "cb"))
1985 (defun ediff-copy-C-to-A (arg)
1986 "Copy ARGth difference region from buffer C to A.
1987 ARG is a prefix argument. If nil, copy the current difference region."
1989 (ediff-diff-to-diff arg "ca"))
1993 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1994 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1995 ;; target diff. This is used in merging, when constructing the merged
1997 (defun ediff-copy-diff (n from-buf-type to-buf-type
1998 &optional batch-invocation reg-to-copy)
1999 (let* ((to-buf (ediff-get-buffer to-buf-type))
2000 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
2001 (ctrl-buf ediff-control-buffer)
2003 (three-way ediff-3way-job)
2006 reg-to-delete reg-to-delete-beg reg-to-delete-end)
2008 (setq reg-to-delete-beg
2009 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
2010 (setq reg-to-delete-end
2011 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
2014 (setq from-buf-type nil)
2015 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
2017 (setq reg-to-delete (ediff-get-region-contents
2018 n to-buf-type ctrl-buf
2019 reg-to-delete-beg reg-to-delete-end))
2021 (if (string= reg-to-delete reg-to-copy)
2022 (setq saved-p nil) ; don't copy identical buffers
2024 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
2025 (condition-case conds
2027 (ediff-with-current-buffer to-buf
2028 ;; to prevent flags from interfering if buffer is writable
2029 (let ((inhibit-read-only (null buffer-read-only)))
2031 (goto-char reg-to-delete-end)
2032 (insert reg-to-copy)
2034 (if (> reg-to-delete-end reg-to-delete-beg)
2035 (kill-region reg-to-delete-beg reg-to-delete-end))
2037 (or batch-invocation
2040 (ediff-save-diff-region n to-buf-type reg-to-delete))))
2041 (error (message "ediff-copy-diff: %s %s"
2043 (mapconcat 'prin1-to-string (cdr conds) " "))
2045 (sit-for 2) ; let the user see the error msg
2050 ;; adjust state of difference in case 3-way and diff was copied ok
2051 (if (and saved-p three-way)
2052 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
2054 (if batch-invocation
2055 (ediff-clear-fine-differences n)
2056 ;; If diff3 job, we should recompute fine diffs so we clear them
2057 ;; before reinserting flags (and thus before ediff-recenter).
2058 (if (and saved-p three-way)
2059 (ediff-clear-fine-differences n))
2061 (ediff-refresh-mode-lines)
2063 ;; For diff2 jobs, don't recompute fine diffs, since we know there
2064 ;; aren't any. So we clear diffs after ediff-recenter.
2065 (if (and saved-p (not three-way))
2066 (ediff-clear-fine-differences n))
2067 ;; Make sure that the message about saving and how to restore is seen
2072 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
2073 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
2074 ;; is the region to save. It is redundant here, but is passed anyway, for
2076 (defun ediff-save-diff-region (n buf-type reg)
2077 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
2078 (buf (ediff-get-buffer buf-type))
2079 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
2081 (if this-buf-n-th-diff-saved
2082 ;; either nothing saved for n-th diff and buffer or we OK'ed
2084 (setcdr this-buf-n-th-diff-saved reg)
2085 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
2086 (nconc n-th-diff-saved (list (cons buf reg)))
2087 (setq ediff-killed-diffs-alist ;; create record for n-th diff
2088 (cons (list n (cons buf reg))
2089 ediff-killed-diffs-alist))))
2090 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
2093 "" (downcase (symbol-name buf-type))))
2096 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
2097 (defun ediff-test-save-region (n buf-type)
2098 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
2099 (buf (ediff-get-buffer buf-type))
2100 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
2102 (if this-buf-n-th-diff-saved
2105 "You've previously copied diff region %d to buffer %S. Confirm "
2111 (defun ediff-pop-diff (n buf-type)
2112 "Pop last killed Nth diff region from buffer BUF-TYPE."
2113 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
2114 (buf (ediff-get-buffer buf-type))
2115 (saved-rec (assoc buf (cdr n-th-record)))
2116 (three-way ediff-3way-job)
2117 (ctl-buf ediff-control-buffer)
2119 saved-diff reg-beg reg-end recovered)
2122 (setq saved-diff (cdr saved-rec))
2123 (if (> ediff-number-of-differences 0)
2124 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
2125 (error ediff-NO-DIFFERENCES)))
2127 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
2128 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
2130 (condition-case conds
2131 (ediff-with-current-buffer buf
2132 (let ((inhibit-read-only (null buffer-read-only)))
2137 (if (> reg-end reg-beg)
2138 (kill-region reg-beg reg-end))
2142 (error (message "ediff-pop-diff: %s %s"
2144 (mapconcat 'prin1-to-string (cdr conds) " "))
2147 ;; Clearing fine diffs is necessary for
2148 ;; ediff-unselect-and-select-difference to properly recompute them. We
2149 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
2150 ;; have modified diff regions after copying and, thus, may have recomputed
2153 (ediff-clear-fine-differences n))
2155 ;; adjust state of difference
2156 (if (and three-way recovered)
2157 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
2159 (ediff-refresh-mode-lines)
2163 (setq n-th-record (delq saved-rec n-th-record))
2164 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
2168 (defun ediff-restore-diff (arg &optional key)
2169 "Restore ARGth diff from `ediff-killed-diffs-alist'.
2170 ARG is a prefix argument. If ARG is nil, restore the current-difference.
2171 If the second optional argument, a character, is given, use it to
2172 determine the target buffer instead of last-command-char"
2174 (ediff-barf-if-not-control-buffer)
2176 (ediff-jump-to-difference arg))
2177 (ediff-pop-diff ediff-current-difference
2178 (ediff-char-to-buftype (or key last-command-char)))
2179 ;; recenter with rehighlighting, but no messages
2180 (let (ediff-verbose-p)
2183 (defun ediff-restore-diff-in-merge-buffer (arg)
2184 "Restore ARGth diff in the merge buffer.
2185 ARG is a prefix argument. If nil, restore the current diff."
2187 (ediff-restore-diff arg ?c))
2190 (defun ediff-toggle-regexp-match ()
2191 "Toggle between focusing and hiding of difference regions that match
2192 a regular expression typed in by the user."
2194 (ediff-barf-if-not-control-buffer)
2198 msg-connective alt-msg-connective alt-connective)
2200 ((or (and (eq ediff-skip-diff-region-function
2201 ediff-focus-on-regexp-matches-function)
2202 (eq last-command-char ?f))
2203 (and (eq ediff-skip-diff-region-function
2204 ediff-hide-regexp-matches-function)
2205 (eq last-command-char ?h)))
2206 (message "Selective browsing by regexp turned off")
2207 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
2208 ((eq last-command-char ?h)
2209 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
2213 "Ignore A-regions matching this regexp (default \"%s\"): "
2214 ediff-regexp-hide-A))
2218 "Ignore B-regions matching this regexp (default \"%s\"): "
2219 ediff-regexp-hide-B)))
2220 (if ediff-3way-comparison-job
2224 "Ignore C-regions matching this regexp (default \"%s\"): "
2225 ediff-regexp-hide-C))))
2226 (if (eq ediff-hide-regexp-connective 'and)
2227 (setq msg-connective "BOTH"
2228 alt-msg-connective "ONE OF"
2230 (setq msg-connective "ONE OF"
2231 alt-msg-connective "BOTH"
2232 alt-connective 'and))
2235 "Ignore regions that match %s regexps, OK? "
2236 msg-connective alt-msg-connective))
2237 (message "Will ignore regions that match %s regexps" msg-connective)
2238 (setq ediff-hide-regexp-connective alt-connective)
2239 (message "Will ignore regions that match %s regexps"
2240 alt-msg-connective))
2242 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
2243 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
2244 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
2246 ((eq last-command-char ?f)
2247 (setq ediff-skip-diff-region-function
2248 ediff-focus-on-regexp-matches-function
2252 "Focus on A-regions matching this regexp (default \"%s\"): "
2253 ediff-regexp-focus-A))
2257 "Focus on B-regions matching this regexp (default \"%s\"): "
2258 ediff-regexp-focus-B)))
2259 (if ediff-3way-comparison-job
2263 "Focus on C-regions matching this regexp (default \"%s\"): "
2264 ediff-regexp-focus-C))))
2265 (if (eq ediff-focus-regexp-connective 'and)
2266 (setq msg-connective "BOTH"
2267 alt-msg-connective "ONE OF"
2269 (setq msg-connective "ONE OF"
2270 alt-msg-connective "BOTH"
2271 alt-connective 'and))
2274 "Focus on regions that match %s regexps, OK? "
2275 msg-connective alt-msg-connective))
2276 (message "Will focus on regions that match %s regexps"
2278 (setq ediff-focus-regexp-connective alt-connective)
2279 (message "Will focus on regions that match %s regexps"
2280 alt-msg-connective))
2282 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
2283 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
2284 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
2286 (defun ediff-toggle-skip-similar ()
2288 (ediff-barf-if-not-control-buffer)
2289 (if (not (eq ediff-auto-refine 'on))
2291 "Can't skip over whitespace regions: first turn auto-refining on"))
2292 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
2293 (if ediff-ignore-similar-regions
2295 "Skipping regions that differ only in white space & line breaks")
2296 (message "Skipping over white-space differences turned off")))
2298 (defun ediff-focus-on-regexp-matches (n)
2299 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
2300 Regions to be ignored according to this function are those where
2301 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
2302 doesn't match `ediff-regexp-focus-B'.
2303 This function returns nil if the region number N (specified as
2304 an argument) is not to be ignored and t if region N is to be ignored.
2306 N is a region number used by Ediff internally. It is 1 less
2307 the number seen by the user."
2308 (if (ediff-valid-difference-p n)
2309 (let* ((ctl-buf ediff-control-buffer)
2310 (regex-A ediff-regexp-focus-A)
2311 (regex-B ediff-regexp-focus-B)
2312 (regex-C ediff-regexp-focus-C)
2313 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2316 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2317 (ediff-get-diff-posn 'A 'end n ctl-buf))
2318 (goto-char (point-min))
2319 (re-search-forward regex-A nil t))))
2320 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2323 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2324 (ediff-get-diff-posn 'B 'end n ctl-buf))
2325 (re-search-forward regex-B nil t))))
2326 (reg-C-match (if ediff-3way-comparison-job
2327 (ediff-with-current-buffer ediff-buffer-C
2330 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2331 (ediff-get-diff-posn 'C 'end n ctl-buf))
2332 (re-search-forward regex-C nil t))))))
2333 (not (eval (if ediff-3way-comparison-job
2334 (list ediff-focus-regexp-connective
2335 reg-A-match reg-B-match reg-C-match)
2336 (list ediff-focus-regexp-connective
2337 reg-A-match reg-B-match))))
2340 (defun ediff-hide-regexp-matches (n)
2341 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2342 Regions to be ignored are those where buf A region matches
2343 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2344 This function returns nil if the region number N (specified as
2345 an argument) is not to be ignored and t if region N is to be ignored.
2347 N is a region number used by Ediff internally. It is 1 less
2348 the number seen by the user."
2349 (if (ediff-valid-difference-p n)
2350 (let* ((ctl-buf ediff-control-buffer)
2351 (regex-A ediff-regexp-hide-A)
2352 (regex-B ediff-regexp-hide-B)
2353 (regex-C ediff-regexp-hide-C)
2354 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2357 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2358 (ediff-get-diff-posn 'A 'end n ctl-buf))
2359 (goto-char (point-min))
2360 (re-search-forward regex-A nil t))))
2361 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2364 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2365 (ediff-get-diff-posn 'B 'end n ctl-buf))
2366 (goto-char (point-min))
2367 (re-search-forward regex-B nil t))))
2368 (reg-C-match (if ediff-3way-comparison-job
2369 (ediff-with-current-buffer ediff-buffer-C
2372 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2373 (ediff-get-diff-posn 'C 'end n ctl-buf))
2374 (goto-char (point-min))
2375 (re-search-forward regex-C nil t))))))
2376 (eval (if ediff-3way-comparison-job
2377 (list ediff-hide-regexp-connective
2378 reg-A-match reg-B-match reg-C-match)
2379 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2384 ;;; Quitting, suspending, etc.
2386 (defun ediff-quit (reverse-default-keep-variants)
2387 "Finish an Ediff session and exit Ediff.
2388 Unselects the selected difference, if any, restores the read-only and modified
2389 flags of the compared file buffers, kills Ediff buffers for this session
2390 \(but not buffers A, B, C\).
2392 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2393 containing the variants should be removed \(if they haven't been modified\).
2394 If it is t, they will be preserved unconditionally. A prefix argument,
2395 temporarily reverses the meaning of this variable."
2397 (ediff-barf-if-not-control-buffer)
2398 (let ((ctl-buf (current-buffer)))
2399 (if (y-or-n-p (format "Quit this Ediff session%s? "
2400 (if (ediff-buffer-live-p ediff-meta-buffer)
2401 " & show containing session group" "")))
2404 (set-buffer ctl-buf)
2405 (ediff-really-quit reverse-default-keep-variants))
2409 ;; Perform the quit operations.
2410 (defun ediff-really-quit (reverse-default-keep-variants)
2411 (ediff-unhighlight-diffs-totally)
2412 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2413 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2414 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2415 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2417 (ediff-delete-temp-files)
2419 ;; Restore the visibility range. This affects only ediff-*-regions/windows.
2420 ;; Since for other job names ediff-visible-region sets
2421 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2422 ;; ignored for such jobs.
2423 (if ediff-quit-widened
2424 (setq ediff-visible-bounds ediff-wide-bounds)
2425 (setq ediff-visible-bounds ediff-narrow-bounds))
2427 ;; Apply selective display to narrow or widen
2428 (ediff-visible-region)
2429 (mapcar (lambda (overl)
2430 (if (ediff-overlayp overl)
2431 (ediff-delete-overlay overl)))
2433 (mapcar (lambda (overl)
2434 (if (ediff-overlayp overl)
2435 (ediff-delete-overlay overl)))
2436 ediff-narrow-bounds)
2438 ;; restore buffer mode line id's in buffer-A/B/C
2439 (let ((control-buffer ediff-control-buffer)
2440 (meta-buffer ediff-meta-buffer)
2441 (after-quit-hook-internal ediff-after-quit-hook-internal)
2442 (session-number ediff-meta-session-number)
2443 ;; suitable working frame
2444 (warp-frame (if (and (ediff-window-display-p) (eq ediff-grab-mouse t))
2445 (cond ((window-live-p ediff-window-A)
2446 (window-frame ediff-window-A))
2447 ((window-live-p ediff-window-B)
2448 (window-frame ediff-window-B))
2449 (t (next-frame))))))
2451 (ediff-with-current-buffer ediff-buffer-A
2452 (setq ediff-this-buffer-ediff-sessions
2453 (delq control-buffer ediff-this-buffer-ediff-sessions))
2454 (kill-local-variable 'mode-line-buffer-identification)
2455 (kill-local-variable 'mode-line-format)
2460 (ediff-with-current-buffer ediff-buffer-B
2461 (setq ediff-this-buffer-ediff-sessions
2462 (delq control-buffer ediff-this-buffer-ediff-sessions))
2463 (kill-local-variable 'mode-line-buffer-identification)
2464 (kill-local-variable 'mode-line-format)
2469 (ediff-with-current-buffer ediff-buffer-C
2470 (setq ediff-this-buffer-ediff-sessions
2471 (delq control-buffer ediff-this-buffer-ediff-sessions))
2472 (kill-local-variable 'mode-line-buffer-identification)
2473 (kill-local-variable 'mode-line-format)
2478 (ediff-with-current-buffer ediff-ancestor-buffer
2479 (setq ediff-this-buffer-ediff-sessions
2480 (delq control-buffer ediff-this-buffer-ediff-sessions))
2481 (kill-local-variable 'mode-line-buffer-identification)
2482 (kill-local-variable 'mode-line-format)
2486 (setq ediff-session-registry
2487 (delq ediff-control-buffer ediff-session-registry))
2488 (ediff-update-registry)
2489 ;; restore state of buffers to what it was before ediff
2490 (ediff-restore-protected-variables)
2492 ;; If the user interrupts (canceling saving the merge buffer), continue
2495 (if (ediff-merge-job)
2496 (run-hooks 'ediff-quit-merge-hook))
2499 (run-hooks 'ediff-cleanup-hook)
2503 ;; reverse-default-keep-variants is t if the user quits with a prefix arg
2504 (if reverse-default-keep-variants
2505 (not ediff-keep-variants)
2506 ediff-keep-variants))
2508 ;; one hook here is ediff-cleanup-mess, which kills the control buffer and
2509 ;; other auxiliary buffers. we made it into a hook to let the users do their
2510 ;; own cleanup, if needed.
2511 (run-hooks 'ediff-quit-hook)
2512 (ediff-update-meta-buffer meta-buffer nil session-number)
2514 ;; warp mouse into a working window
2515 (setq warp-frame ; if mouse is over a reasonable frame, use it
2516 (cond ((ediff-good-frame-under-mouse))
2518 (if (and (ediff-window-display-p) (frame-live-p warp-frame) ediff-grab-mouse)
2519 (set-mouse-position (if ediff-emacs-p
2521 (frame-selected-window warp-frame))
2524 (run-hooks 'after-quit-hook-internal)
2527 ;; Returns frame under mouse, if this frame is not a minibuffer
2528 ;; frame. Otherwise: nil
2529 (defun ediff-good-frame-under-mouse ()
2530 (let ((frame-or-win (car (mouse-position)))
2535 (frame-live-p frame-or-win)
2536 (window-live-p frame-or-win)))
2538 (setq frame (if ediff-emacs-p frame-or-win (window-frame frame-or-win))
2540 (buffer-name (window-buffer (frame-selected-window frame)))))
2541 (if (string-match "Minibuf" buf-name)
2546 (defun ediff-delete-temp-files ()
2547 (if (and (stringp ediff-temp-file-A) (file-exists-p ediff-temp-file-A))
2548 (delete-file ediff-temp-file-A))
2549 (if (and (stringp ediff-temp-file-B) (file-exists-p ediff-temp-file-B))
2550 (delete-file ediff-temp-file-B))
2551 (if (and (stringp ediff-temp-file-C) (file-exists-p ediff-temp-file-C))
2552 (delete-file ediff-temp-file-C)))
2555 ;; Kill control buffer, other auxiliary Ediff buffers.
2556 ;; Leave one of the frames split between buffers A/B/C
2557 (defun ediff-cleanup-mess ()
2558 (let* ((buff-A ediff-buffer-A)
2559 (buff-B ediff-buffer-B)
2560 (buff-C ediff-buffer-C)
2561 (ctl-buf ediff-control-buffer)
2562 (ctl-wind (ediff-get-visible-buffer-window ctl-buf))
2563 (ctl-frame ediff-control-frame)
2564 (three-way-job ediff-3way-job)
2565 (main-frame (cond ((window-live-p ediff-window-A)
2566 (window-frame ediff-window-A))
2567 ((window-live-p ediff-window-B)
2568 (window-frame ediff-window-B)))))
2570 (ediff-kill-buffer-carefully ediff-diff-buffer)
2571 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2572 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2573 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2574 (ediff-kill-buffer-carefully ediff-error-buffer)
2575 (ediff-kill-buffer-carefully ediff-msg-buffer)
2576 (ediff-kill-buffer-carefully ediff-debug-buffer)
2577 (if (boundp 'ediff-patch-diagnostics)
2578 (ediff-kill-buffer-carefully ediff-patch-diagnostics))
2580 ;; delete control frame or window
2581 (cond ((and (ediff-window-display-p) (frame-live-p ctl-frame))
2582 (delete-frame ctl-frame))
2583 ((window-live-p ctl-wind)
2584 (delete-window ctl-wind)))
2586 ;; Hide bottom toolbar. --marcpa
2587 (if (not (ediff-multiframe-setup-p))
2588 (ediff-kill-bottom-toolbar))
2590 (ediff-kill-buffer-carefully ctl-buf)
2592 (if (frame-live-p main-frame)
2593 (select-frame main-frame))
2595 ;; display only if not visible
2597 (or (ediff-get-visible-buffer-window buff-B)
2598 (switch-to-buffer buff-B))
2601 (or (ediff-get-visible-buffer-window buff-A)
2603 (if (and (ediff-get-visible-buffer-window buff-B)
2604 (ediff-buffer-live-p buff-A))
2605 (funcall ediff-split-window-function))
2606 (switch-to-buffer buff-A)))
2610 (or (ediff-get-visible-buffer-window buff-C)
2612 (if (and (or (ediff-get-visible-buffer-window buff-A)
2613 (ediff-get-visible-buffer-window buff-B))
2614 (ediff-buffer-live-p buff-C))
2615 (funcall ediff-split-window-function))
2616 (switch-to-buffer buff-C)))
2622 (defun ediff-janitor (ask keep-variants)
2623 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2624 In merge jobs, buffer C is not deleted here, but rather according to
2625 ediff-quit-merge-hook.
2626 A side effect of cleaning up may be that you should be careful when comparing
2627 the same buffer in two separate Ediff sessions: quitting one of them might
2628 delete this buffer in another session as well."
2629 (ediff-dispose-of-variant-according-to-user
2630 ediff-buffer-A 'A ask keep-variants)
2631 (ediff-dispose-of-variant-according-to-user
2632 ediff-buffer-B 'B ask keep-variants)
2633 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2634 (ediff-dispose-of-variant-according-to-user
2635 ediff-ancestor-buffer 'Ancestor ask keep-variants)
2636 (ediff-dispose-of-variant-according-to-user
2637 ediff-buffer-C 'C ask keep-variants)
2640 ;; Kill the variant buffer, according to user directives (ask, kill
2641 ;; unconditionaly, keep)
2642 ;; BUFF is the buffer, BUFF-TYPE is either 'A, or 'B, 'C, 'Ancestor
2643 (defun ediff-dispose-of-variant-according-to-user (buff bufftype ask keep-variants)
2644 ;; if this is indirect buffer, kill it and substitute with direct buf
2645 (if (and (ediff-buffer-live-p buff)
2646 (ediff-with-current-buffer buff ediff-temp-indirect-buffer))
2647 (let ((wind (ediff-get-visible-buffer-window buff))
2648 (base (buffer-base-buffer buff))
2649 (modified-p (buffer-modified-p buff)))
2650 (if (and (window-live-p wind) (ediff-buffer-live-p base))
2651 (set-window-buffer wind base))
2652 ;; Kill indirect buffer even if it is modified, because the base buffer
2653 ;; is still there. Note that if the base buffer is dead then so will be
2654 ;; the indirect buffer
2655 (ediff-with-current-buffer buff
2656 (set-buffer-modified-p nil))
2657 (ediff-kill-buffer-carefully buff)
2658 (ediff-with-current-buffer base
2659 (set-buffer-modified-p modified-p)))
2660 ;; otherwise, ask or use the value of keep-variants
2661 (or (not (ediff-buffer-live-p buff))
2663 (buffer-modified-p buff)
2665 (not (y-or-n-p (format "Kill buffer %S [%s]? "
2666 bufftype (buffer-name buff)))))
2667 (ediff-kill-buffer-carefully buff))
2670 (defun ediff-maybe-save-and-delete-merge (&optional save-and-continue)
2671 "Default hook to run on quitting a merge job.
2672 This can also be used to save merge buffer in the middle of an Ediff session.
2674 If the optional SAVE-AND-CONTINUE argument is non-nil, save merge buffer and
2675 continue. Otherwise:
2676 If `ediff-autostore-merges' is nil, this does nothing.
2677 If it is t, it saves the merge buffer in the file `ediff-merge-store-file'
2678 or asks the user, if the latter is nil. It then asks the user whether to
2679 delete the merge buffer.
2680 If `ediff-autostore-merges' is neither nil nor t, the merge buffer is saved
2681 only if this merge job is part of a group, i.e., was invoked from within
2682 `ediff-merge-directories', `ediff-merge-directory-revisions', and such."
2683 (let ((merge-store-file ediff-merge-store-file)
2684 (ediff-autostore-merges ; fake ediff-autostore-merges, if necessary
2685 (if save-and-continue t ediff-autostore-merges)))
2686 (if ediff-autostore-merges
2687 (cond ((stringp merge-store-file)
2688 ;; store, ask to delete
2689 (ediff-write-merge-buffer-and-maybe-kill
2690 ediff-buffer-C merge-store-file 'show-file save-and-continue))
2691 ((eq ediff-autostore-merges t)
2692 ;; ask for file name
2693 (setq merge-store-file
2694 (read-file-name "Save the result of the merge in file: "))
2695 (ediff-write-merge-buffer-and-maybe-kill
2696 ediff-buffer-C merge-store-file nil save-and-continue))
2697 ((and (ediff-buffer-live-p ediff-meta-buffer)
2698 (ediff-with-current-buffer ediff-meta-buffer
2699 (ediff-merge-metajob)))
2700 ;; The parent metajob passed nil as the autostore file.
2704 ;; write merge buffer. If the optional argument save-and-continue is non-nil,
2705 ;; then don't kill the merge buffer
2706 (defun ediff-write-merge-buffer-and-maybe-kill (buf file
2708 show-file save-and-continue)
2709 (if (not (eq (find-buffer-visiting file) buf))
2711 (format "Another buffer is visiting file %s. Too dangerous to save the merge buffer"
2714 (message warn-message)
2715 (with-output-to-temp-buffer ediff-msg-buffer
2717 (princ warn-message)
2721 (ediff-with-current-buffer buf
2722 (if (or (not (file-exists-p file))
2723 (y-or-n-p (format "File %s exists, overwrite? " file)))
2725 ;;(write-region (point-min) (point-max) file)
2726 (ediff-with-current-buffer buf
2727 (set-visited-file-name file)
2731 (message "Merge buffer saved in: %s" file)
2732 (set-buffer-modified-p nil)
2735 (not save-and-continue)
2736 (y-or-n-p "Merge buffer saved. Now kill the buffer? "))
2737 (ediff-kill-buffer-carefully buf)))))
2740 ;; The default way of suspending Ediff.
2741 ;; Buries Ediff buffers, kills all windows.
2742 (defun ediff-default-suspend-function ()
2743 (let* ((buf-A ediff-buffer-A)
2744 (buf-B ediff-buffer-B)
2745 (buf-C ediff-buffer-C)
2746 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2747 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2748 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2749 (buf-patch (if (boundp 'ediff-patchbufer) ediff-patchbufer nil))
2750 (buf-patch-diag (if (boundp 'ediff-patch-diagnostics)
2751 ediff-patch-diagnostics nil))
2752 (buf-err ediff-error-buffer)
2753 (buf-diff ediff-diff-buffer)
2754 (buf-custom-diff ediff-custom-diff-buffer)
2755 (buf-fine-diff ediff-fine-diff-buffer))
2757 ;; hide the control panel
2758 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2759 (iconify-frame ediff-control-frame)
2761 (if buf-err (bury-buffer buf-err))
2762 (if buf-diff (bury-buffer buf-diff))
2763 (if buf-custom-diff (bury-buffer buf-custom-diff))
2764 (if buf-fine-diff (bury-buffer buf-fine-diff))
2765 (if buf-patch (bury-buffer buf-patch))
2766 (if buf-patch-diag (bury-buffer buf-patch-diag))
2767 (if (window-live-p buf-A-wind)
2769 (select-window buf-A-wind)
2770 (delete-other-windows)
2772 (if (ediff-buffer-live-p buf-A)
2776 (if (window-live-p buf-B-wind)
2778 (select-window buf-B-wind)
2779 (delete-other-windows)
2781 (if (ediff-buffer-live-p buf-B)
2785 (if (window-live-p buf-C-wind)
2787 (select-window buf-C-wind)
2788 (delete-other-windows)
2790 (if (ediff-buffer-live-p buf-C)
2797 (defun ediff-suspend ()
2799 To resume, switch to the appropriate `Ediff Control Panel'
2800 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2801 up an appropriate window config."
2803 (ediff-barf-if-not-control-buffer)
2804 (run-hooks 'ediff-suspend-hook)
2806 "To resume, type M-x eregistry and select the desired Ediff session"))
2809 (defun ediff-status-info ()
2810 "Show the names of the buffers or files being operated on by Ediff.
2811 Hit \\[ediff-recenter] to reset the windows afterward."
2813 (ediff-barf-if-not-control-buffer)
2815 (ediff-skip-unsuitable-frames))
2816 (with-output-to-temp-buffer ediff-msg-buffer
2817 (ediff-with-current-buffer standard-output
2819 (raise-frame (selected-frame))
2820 (princ (ediff-version))
2822 (ediff-with-current-buffer ediff-buffer-A
2823 (if buffer-file-name
2825 (format "File A = %S\n" buffer-file-name))
2827 (format "Buffer A = %S\n" (buffer-name)))))
2828 (ediff-with-current-buffer ediff-buffer-B
2829 (if buffer-file-name
2831 (format "File B = %S\n" buffer-file-name))
2833 (format "Buffer B = %S\n" (buffer-name)))))
2835 (ediff-with-current-buffer ediff-buffer-C
2836 (if buffer-file-name
2838 (format "File C = %S\n" buffer-file-name))
2840 (format "Buffer C = %S\n" (buffer-name))))))
2841 (princ (format "Customized diff output %s\n"
2842 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2843 (concat "\tin buffer "
2844 (buffer-name ediff-custom-diff-buffer))
2845 " is not available")))
2846 (princ (format "Plain diff output %s\n"
2847 (if (ediff-buffer-live-p ediff-diff-buffer)
2848 (concat "\tin buffer "
2849 (buffer-name ediff-diff-buffer))
2850 " is not available")))
2852 (let* ((A-line (ediff-with-current-buffer ediff-buffer-A
2853 (1+ (count-lines (point-min) (point)))))
2854 (B-line (ediff-with-current-buffer ediff-buffer-B
2855 (1+ (count-lines (point-min) (point)))))
2857 (princ (format "\Buffer A's point is on line %d\n" A-line))
2858 (princ (format "Buffer B's point is on line %d\n" B-line))
2861 (setq C-line (ediff-with-current-buffer ediff-buffer-C
2862 (1+ (count-lines (point-min) (point)))))
2863 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2865 (princ (format "\nCurrent difference number = %S\n"
2866 (cond ((< ediff-current-difference 0) 'start)
2867 ((>= ediff-current-difference
2868 ediff-number-of-differences) 'end)
2869 (t (1+ ediff-current-difference)))))
2872 (format "\n%s regions that differ in white space & line breaks only"
2873 (if ediff-ignore-similar-regions
2874 "Ignoring" "Showing")))
2875 (if (and ediff-merge-job ediff-show-clashes-only)
2877 "\nFocusing on regions where both buffers differ from the ancestor"))
2878 (if (and ediff-skip-merge-regions-that-differ-from-default ediff-merge-job)
2880 "\nSkipping merge regions that differ from default setting"))
2882 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2883 (princ "\nSelective browsing by regexp is off\n"))
2884 ((eq ediff-skip-diff-region-function
2885 ediff-hide-regexp-matches-function)
2887 "\nIgnoring regions that match")
2890 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2891 ediff-regexp-hide-A ediff-hide-regexp-connective
2892 ediff-regexp-hide-B)))
2893 ((eq ediff-skip-diff-region-function
2894 ediff-focus-on-regexp-matches-function)
2896 "\nFocusing on regions that match")
2899 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2900 ediff-regexp-focus-A ediff-focus-regexp-connective
2901 ediff-regexp-focus-B)))
2902 (t (princ "\nSelective browsing via a user-defined method.\n")))
2905 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2906 (substitute-command-keys "\\[ediff-submit-report]")))
2908 (if (frame-live-p ediff-control-frame)
2909 (ediff-reset-mouse ediff-control-frame))
2910 (if (window-live-p ediff-control-window)
2911 (select-window ediff-control-window)))
2916 ;;; Support routines
2918 ;; Select a difference by placing the ASCII flags around the appropriate
2919 ;; group of lines in the A, B buffers
2920 ;; This may have to be modified for buffer C, when it will be supported.
2921 (defun ediff-select-difference (n)
2922 (if (and (ediff-buffer-live-p ediff-buffer-A)
2923 (ediff-buffer-live-p ediff-buffer-B)
2924 (ediff-valid-difference-p n))
2927 ((and (ediff-has-face-support-p) ediff-use-faces)
2928 (ediff-highlight-diff n))
2929 ((eq ediff-highlighting-style 'ascii)
2930 (ediff-place-flags-in-buffer
2931 'A ediff-buffer-A ediff-control-buffer n)
2932 (ediff-place-flags-in-buffer
2933 'B ediff-buffer-B ediff-control-buffer n)
2935 (ediff-place-flags-in-buffer
2936 'C ediff-buffer-C ediff-control-buffer n))
2937 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2938 (ediff-place-flags-in-buffer
2939 'Ancestor ediff-ancestor-buffer
2940 ediff-control-buffer n))
2943 (ediff-install-fine-diff-if-necessary n)
2944 ;; set current difference here so the hook will be able to refer to it
2945 (setq ediff-current-difference n)
2946 (run-hooks 'ediff-select-hook))))
2949 ;; Unselect a difference by removing the ASCII flags in the buffers.
2950 ;; This may have to be modified for buffer C, when it will be supported.
2951 (defun ediff-unselect-difference (n)
2952 (if (ediff-valid-difference-p n)
2954 (cond ((and (ediff-has-face-support-p) ediff-use-faces)
2955 (ediff-unhighlight-diff))
2956 ((eq ediff-highlighting-style 'ascii)
2957 (ediff-remove-flags-from-buffer
2959 (ediff-get-diff-overlay n 'A))
2960 (ediff-remove-flags-from-buffer
2962 (ediff-get-diff-overlay n 'B))
2964 (ediff-remove-flags-from-buffer
2966 (ediff-get-diff-overlay n 'C)))
2967 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2968 (ediff-remove-flags-from-buffer
2969 ediff-ancestor-buffer
2970 (ediff-get-diff-overlay n 'Ancestor)))
2973 ;; unhighlight fine diffs
2974 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2975 (run-hooks 'ediff-unselect-hook))))
2978 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2979 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2980 ;; next difference is selected, but the current selection is not
2981 ;; unselected. If FLAG is 'unselect-only then the current selection is
2982 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2983 ;; don't recenter buffers after selecting/unselecting.
2984 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2985 (let ((ediff-current-difference n))
2987 (ediff-recenter 'no-rehighlight)))
2989 (let ((control-buf ediff-control-buffer))
2992 (or (eq flag 'select-only)
2993 (ediff-unselect-difference ediff-current-difference))
2995 (or (eq flag 'unselect-only)
2996 (ediff-select-difference n))
2997 ;; need to set current diff here even though it is also set in
2998 ;; ediff-select-difference because ediff-select-difference might not
2999 ;; be called if unselect-only is specified
3000 (setq ediff-current-difference n)
3001 ) ; end protected section
3003 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines)))
3008 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
3009 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
3010 (let* ((buff (ediff-get-buffer buf-type))
3011 (last (ediff-with-current-buffer buff (point-max)))
3012 (begin (ediff-get-diff-posn buf-type 'beg n))
3013 (end (ediff-get-diff-posn buf-type 'end n))
3014 (xtra (if (equal begin end) 1 0))
3015 (end-hilit (min last (+ end xtra)))
3016 (current-diff-overlay
3018 (ediff-get-symbol-from-alist
3019 buf-type ediff-current-diff-overlay-alist))))
3022 (ediff-move-overlay current-diff-overlay begin end-hilit)
3023 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
3024 (ediff-overlay-put current-diff-overlay 'priority
3025 (ediff-highest-priority begin end-hilit buff))
3026 (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
3028 ;; unhighlight the background overlay for diff n so it won't
3029 ;; interfere with the current diff overlay
3030 (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
3034 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
3035 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
3036 (let ((current-diff-overlay
3038 (ediff-get-symbol-from-alist
3039 buf-type ediff-current-diff-overlay-alist)))
3041 (ediff-get-diff-overlay ediff-current-difference buf-type))
3044 (ediff-move-overlay current-diff-overlay 1 1)
3046 ;; rehighlight the overlay in the background of the
3047 ;; current difference region
3048 (ediff-set-overlay-face
3050 (if (and (ediff-has-face-support-p)
3051 ediff-use-faces ediff-highlight-all-diffs)
3052 (ediff-background-face buf-type ediff-current-difference)))
3055 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
3056 (ediff-unselect-and-select-difference -1)
3057 (if (and (ediff-has-face-support-p) ediff-use-faces)
3058 (let* ((inhibit-quit t)
3059 (current-diff-overlay-var
3060 (ediff-get-symbol-from-alist
3061 buf-type ediff-current-diff-overlay-alist))
3062 (current-diff-overlay (symbol-value current-diff-overlay-var)))
3063 (ediff-paint-background-regions 'unhighlight)
3064 (if (ediff-overlayp current-diff-overlay)
3065 (ediff-delete-overlay current-diff-overlay))
3066 (set current-diff-overlay-var nil)
3070 (defsubst ediff-highlight-diff (n)
3071 "Put face on diff N. Invoked for X displays only."
3072 (ediff-highlight-diff-in-one-buffer n 'A)
3073 (ediff-highlight-diff-in-one-buffer n 'B)
3074 (ediff-highlight-diff-in-one-buffer n 'C)
3075 (ediff-highlight-diff-in-one-buffer n 'Ancestor)
3079 (defsubst ediff-unhighlight-diff ()
3080 "Remove overlays from buffers A, B, and C."
3081 (ediff-unhighlight-diff-in-one-buffer 'A)
3082 (ediff-unhighlight-diff-in-one-buffer 'B)
3083 (ediff-unhighlight-diff-in-one-buffer 'C)
3084 (ediff-unhighlight-diff-in-one-buffer 'Ancestor)
3087 ;; delete highlighting overlays, restore faces to their original form
3088 (defsubst ediff-unhighlight-diffs-totally ()
3089 (ediff-unhighlight-diffs-totally-in-one-buffer 'A)
3090 (ediff-unhighlight-diffs-totally-in-one-buffer 'B)
3091 (ediff-unhighlight-diffs-totally-in-one-buffer 'C)
3092 (ediff-unhighlight-diffs-totally-in-one-buffer 'Ancestor)
3096 ;; This is adapted from a similar function in `emerge.el'.
3097 ;; PROMPT should not have a trailing ': ', so that it can be modified
3098 ;; according to context.
3099 ;; If DEFAULT-FILE is set, it should be used as the default value.
3100 ;; If DEFAULT-DIR is non-nil, use it as the default directory.
3101 ;; Otherwise, use the value of Emacs' variable `default-directory.'
3102 (defun ediff-read-file-name (prompt default-dir default-file &optional no-dirs)
3103 ;; hack default-dir if it is not set
3105 (file-name-as-directory
3106 (ediff-abbreviate-file-name
3107 (expand-file-name (or default-dir
3109 (file-name-directory default-file))
3110 default-directory)))))
3112 ;; strip the directory from default-file
3114 (setq default-file (file-name-nondirectory default-file)))
3115 (if (string= default-file "")
3116 (setq default-file nil))
3119 (setq f (expand-file-name
3124 (concat " (default " default-file "):"))
3125 (t (concat " (default " default-dir "):"))))
3127 (or default-file default-dir)
3128 t ; must match, no-confirm
3129 (if default-file (file-name-directory default-file))
3133 ;; If user entered a directory name, expand the default file in that
3134 ;; directory. This allows the user to enter a directory name for the
3135 ;; B-file and diff against the default-file in that directory instead
3136 ;; of a DIRED listing!
3137 (if (and (file-directory-p f) default-file)
3138 (setq f (expand-file-name
3139 (file-name-nondirectory default-file) f)))
3140 (if (and no-dirs (file-directory-p f))
3141 (error "File %s is a directory" f))
3144 ;; If PREFIX is given, then it is used as a prefix for the temp file
3145 ;; name. Otherwise, `ediff' is used. If FILE is given, use this
3146 ;; file and don't create a new one.
3147 ;; In MS-DOS, make sure the prefix isn't too long, or else
3148 ;; `make-temp-name' isn't guaranteed to return a unique filename.
3149 ;; Also, save buffer from START to END in the file.
3150 ;; START defaults to (point-min), END to (point-max)
3151 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
3152 (let* ((p (ediff-convert-standard-filename (or prefix "ediff")))
3154 (coding-system-for-write ediff-coding-system-for-write)
3156 (if (and (fboundp 'msdos-long-file-names)
3157 (not (msdos-long-file-names))
3159 (setq short-p (substring p 0 2)))
3161 (setq f (concat ediff-temp-file-prefix p)
3162 short-f (concat ediff-temp-file-prefix short-p)
3163 f (cond (given-file)
3164 ((find-file-name-handler f 'find-file-noselect)
3165 ;; to thwart file handlers in write-region, e.g., if file
3166 ;; name ends with .Z or .gz
3167 ;; This is needed so that patches produced by ediff will
3168 ;; have more meaningful names
3169 (ediff-make-empty-tmp-file short-f))
3171 ;; Prefix is most often the same as the file name for the
3172 ;; variant. Here we are trying to use the original file
3173 ;; name but in the temp directory.
3174 (ediff-make-empty-tmp-file f 'keep-name))
3176 ;; If don't care about name, add some random stuff
3177 ;; to proposed file name.
3178 (ediff-make-empty-tmp-file short-f))))
3181 (ediff-with-current-buffer buff
3182 (write-region (if start start (point-min))
3183 (if end end (point-max))
3185 nil ; don't append---erase
3187 (set-file-modes f ediff-temp-file-mode)
3188 (expand-file-name f))))
3190 ;; Create a temporary file.
3191 ;; The returned file name (created by appending some random characters at the
3192 ;; end of PROPOSED-NAME is guaranteed to point to a newly created empty file.
3193 ;; This is a replacement for make-temp-name, which eliminates a security hole.
3194 ;; If KEEP-PROPOSED-NAME isn't nil, try to keep PROPOSED-NAME, unless such file
3196 ;; It is a modified version of make-temp-file in emacs 20.5
3197 (defun ediff-make-empty-tmp-file (proposed-name &optional keep-proposed-name)
3198 (let ((file proposed-name))
3199 (while (condition-case ()
3201 (if (or (file-exists-p file) (not keep-proposed-name))
3202 (setq file (make-temp-name proposed-name)))
3203 ;; the with-temp-buffer thing is a workaround for an XEmacs
3204 ;; bug: write-region complains that we are trying to visit a
3205 ;; file in an indirect buffer, failing to notice that the
3206 ;; VISIT flag is unset and that we are actually writing from a
3207 ;; string and not from any buffer.
3209 (write-region "" nil file nil 'silent nil 'excl))
3211 (file-already-exists t))
3212 ;; the file was somehow created by someone else between
3213 ;; `make-temp-name' and `write-region', let's try again.
3218 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
3220 ;;(defun ediff-protect-metachars (str)
3221 ;; (or (memq system-type '(emx vax-vms axp-vms))
3223 ;; (while (string-match ediff-metachars str limit)
3224 ;; (setq str (concat (substring str 0 (match-beginning 0))
3226 ;; (substring str (match-beginning 0))))
3227 ;; (setq limit (1+ (match-end 0))))))
3230 ;; Make sure the current buffer (for a file) has the same contents as the
3231 ;; file on disk, and attempt to remedy the situation if not.
3232 ;; Signal an error if we can't make them the same, or the user doesn't want
3233 ;; to do what is necessary to make them the same.
3234 ;; Also, Ediff always offers to revert obsolete buffers, whether they
3235 ;; are modified or not.
3236 (defun ediff-verify-file-buffer (&optional file-magic)
3237 ;; First check if the file has been modified since the buffer visited it.
3238 (if (verify-visited-file-modtime (current-buffer))
3239 (if (buffer-modified-p)
3240 ;; If buffer is not obsolete and is modified, offer to save
3242 (format "Buffer %s has been modified. Save it in file %s? "
3249 (message "Couldn't save %s" buffer-file-name)))
3250 (error "Buffer is out of sync for file %s" buffer-file-name))
3251 ;; If buffer is not obsolete and is not modified, do nothing
3253 ;; If buffer is obsolete, offer to revert
3255 (format "File %s was modified since visited by buffer %s. REVERT file %s? "
3262 (revert-buffer t t))
3263 (error "Buffer out of sync for file %s" buffer-file-name))))
3265 ;; if there is another buffer visiting the file of the merge buffer, offer to
3266 ;; save and delete the buffer; else bark
3267 (defun ediff-verify-file-merge-buffer (file)
3268 (let ((buff (if (stringp file) (find-buffer-visiting file)))
3273 (format "Buffer %s is visiting %s. Save and kill the buffer? "
3274 (buffer-name buff) file))
3275 (with-output-to-temp-buffer ediff-msg-buffer
3277 (princ warn-message)
3280 (message warn-message))
3281 (with-current-buffer buff
3283 (kill-buffer (current-buffer)))
3284 (error "Too dangerous to merge versions of a file visited by another buffer"))))
3289 (defun ediff-filename-magic-p (file)
3290 (or (ediff-file-compressed-p file)
3291 (ediff-file-remote-p file)))
3294 (defun ediff-save-buffer (arg)
3295 "Safe way of saving buffers A, B, C, and the diff output.
3296 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
3297 and `wd' saves the diff output.
3299 With prefix argument, `wd' saves plain diff output.
3300 Without an argument, it saves customized diff argument, if available
3301 \(and plain output, if customized output was not generated\)."
3303 (ediff-barf-if-not-control-buffer)
3304 (ediff-compute-custom-diffs-maybe)
3305 (ediff-with-current-buffer
3306 (cond ((memq last-command-char '(?a ?b ?c))
3308 (ediff-char-to-buftype last-command-char)))
3309 ((eq last-command-char ?d)
3310 (message "Saving diff output ...")
3311 (sit-for 1) ; let the user see the message
3312 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3314 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3315 ediff-custom-diff-buffer)
3316 ((ediff-buffer-live-p ediff-diff-buffer)
3318 (t (error "Output from `diff' not found"))))
3323 ;; idea suggested by Hannu Koivisto <azure@iki.fi>
3324 (defun ediff-clone-buffer-for-region-comparison (buff region-name)
3325 (let ((cloned-buff (ediff-make-cloned-buffer buff region-name))
3330 (ediff-with-current-buffer cloned-buff
3331 (setq ediff-temp-indirect-buffer t))
3332 (pop-to-buffer cloned-buff)
3333 (setq wind (ediff-get-visible-buffer-window cloned-buff))
3334 (select-window wind)
3335 (delete-other-windows)
3336 (split-window-vertically)
3337 (ediff-select-lowest-window)
3338 (setq other-wind (selected-window))
3342 (format "\n ******* Mark a region in buffer %s *******\n"
3343 (buffer-name cloned-buff)))
3345 (ediff-with-current-buffer buff
3346 (format "\n\t When done, type %s Use %s to abort\n "
3347 (ediff-format-bindings-of 'exit-recursive-edit)
3348 (ediff-format-bindings-of 'abort-recursive-edit))))
3349 (goto-char (point-min))
3350 (setq msg-buf (current-buffer))
3351 (set-window-buffer other-wind msg-buf)
3352 (shrink-window-if-larger-than-buffer)
3353 (if (window-live-p wind)
3354 (select-window wind))
3358 (ediff-kill-buffer-carefully cloned-buff)))
3363 (defun ediff-clone-buffer-for-window-comparison (buff wind region-name)
3364 (let ((cloned-buff (ediff-make-cloned-buffer buff region-name)))
3365 (ediff-with-current-buffer cloned-buff
3366 (setq ediff-temp-indirect-buffer t))
3367 (set-window-buffer wind cloned-buff)
3370 (defun ediff-clone-buffer-for-current-diff-comparison (buff buf-type reg-name)
3371 (let ((cloned-buff (ediff-make-cloned-buffer buff reg-name))
3372 (reg-start (ediff-get-diff-posn buf-type 'beg))
3373 (reg-end (ediff-get-diff-posn buf-type 'end)))
3374 (ediff-with-current-buffer cloned-buff
3375 ;; set region to be the current diff region
3376 (goto-char reg-start)
3378 (setq ediff-temp-indirect-buffer t))
3383 (defun ediff-make-cloned-buffer (buff region-name)
3384 (ediff-make-indirect-buffer
3385 buff (generate-new-buffer-name
3386 (concat (if (stringp buff) buff (buffer-name buff)) region-name))
3390 (defun ediff-make-indirect-buffer (base-buf indirect-buf-name)
3391 (ediff-cond-compile-for-xemacs-or-emacs
3392 (make-indirect-buffer base-buf indirect-buf-name) ; xemacs
3393 (make-indirect-buffer base-buf indirect-buf-name 'clone) ; emacs
3397 ;; This function operates only from an ediff control buffer
3398 (defun ediff-compute-custom-diffs-maybe ()
3399 (let ((buf-A-file-name (buffer-file-name ediff-buffer-A))
3400 (buf-B-file-name (buffer-file-name ediff-buffer-B))
3402 (if (stringp buf-A-file-name)
3403 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
3404 (if (stringp buf-B-file-name)
3405 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
3406 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name)
3407 file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
3409 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
3410 (setq ediff-custom-diff-buffer
3412 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
3413 (ediff-with-current-buffer ediff-custom-diff-buffer
3414 (setq buffer-read-only nil)
3417 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
3418 ediff-custom-diff-options file-A file-B)
3419 ;; put the diff file in diff-mode, if it is available
3420 (if (fboundp 'diff-mode)
3421 (with-current-buffer ediff-custom-diff-buffer
3423 (delete-file file-A)
3424 (delete-file file-B)
3427 (defun ediff-show-diff-output (arg)
3429 (ediff-barf-if-not-control-buffer)
3430 (ediff-compute-custom-diffs-maybe)
3432 (ediff-skip-unsuitable-frames ' ok-unsplittable))
3433 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3435 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3436 ediff-custom-diff-buffer)
3437 ((ediff-buffer-live-p ediff-diff-buffer)
3441 (message "Output from `diff' not found")
3445 (ediff-with-current-buffer buf
3446 (goto-char (point-min)))
3447 (switch-to-buffer buf)
3448 (raise-frame (selected-frame)))))
3449 (if (frame-live-p ediff-control-frame)
3450 (ediff-reset-mouse ediff-control-frame))
3451 (if (window-live-p ediff-control-window)
3452 (select-window ediff-control-window)))
3455 (defun ediff-inferior-compare-regions ()
3456 "Compare regions in an active Ediff session.
3457 Like ediff-regions-linewise but is called from under an active Ediff session on
3458 the files that belong to that session.
3460 After quitting the session invoked via this function, type C-l to the parent
3461 Ediff Control Panel to restore highlighting."
3464 (possibilities (list ?A ?B ?C))
3467 begA begB endA endB bufA bufB)
3469 (if (ediff-valid-difference-p ediff-current-difference)
3471 (ediff-set-fine-diff-properties ediff-current-difference 'default)
3472 (ediff-unhighlight-diff)))
3473 (ediff-paint-background-regions 'unhighlight)
3475 (cond ((ediff-merge-job)
3476 (setq bufB ediff-buffer-C)
3477 ;; ask which buffer to compare to the merge buffer
3478 (while (cond ((eq answer ?A)
3479 (setq bufA ediff-buffer-A
3480 possibilities '(?B))
3483 (setq bufA ediff-buffer-B
3484 possibilities '(?A))
3488 (message "Valid values are A or B")
3491 (let ((cursor-in-echo-area t))
3493 "Which buffer to compare to the merge buffer (A or B)? ")
3494 (setq answer (capitalize (read-char-exclusive))))))
3496 ((ediff-3way-comparison-job)
3497 ;; ask which two buffers to compare
3498 (while (cond ((memq answer possibilities)
3499 (setq possibilities (delq answer possibilities))
3502 (ediff-get-symbol-from-alist
3503 answer ediff-buffer-alist)))
3508 "Valid values are %s"
3509 (mapconcat 'char-to-string possibilities " or "))
3512 (let ((cursor-in-echo-area t))
3513 (message "Enter the 1st buffer you want to compare (%s): "
3514 (mapconcat 'char-to-string possibilities " or "))
3515 (setq answer (capitalize (read-char-exclusive)))))
3516 (setq answer "") ; silence error msg
3517 (while (cond ((memq answer possibilities)
3518 (setq possibilities (delq answer possibilities))
3521 (ediff-get-symbol-from-alist
3522 answer ediff-buffer-alist)))
3527 "Valid values are %s"
3528 (mapconcat 'char-to-string possibilities " or "))
3531 (let ((cursor-in-echo-area t))
3532 (message "Enter the 2nd buffer you want to compare (%s): "
3533 (mapconcat 'char-to-string possibilities "/"))
3534 (setq answer (capitalize (read-char-exclusive))))))
3535 (t ; 2way comparison
3536 (setq bufA ediff-buffer-A
3538 possibilities nil)))
3540 (if (and (ediff-valid-difference-p ediff-current-difference)
3541 (y-or-n-p "Compare currently highlighted difference regions? "))
3542 (setq use-current-diff-p t))
3544 (setq bufA (if use-current-diff-p
3545 (ediff-clone-buffer-for-current-diff-comparison
3546 bufA 'A "-Region.A-")
3547 (ediff-clone-buffer-for-region-comparison bufA "-Region.A-")))
3548 (ediff-with-current-buffer bufA
3549 (setq begA (region-beginning)
3556 (or (eobp) (forward-char)) ; include the newline char
3557 (setq endA (point)))
3559 (setq bufB (if use-current-diff-p
3560 (ediff-clone-buffer-for-current-diff-comparison
3561 bufB 'B "-Region.B-")
3562 (ediff-clone-buffer-for-region-comparison bufB "-Region.B-")))
3563 (ediff-with-current-buffer bufB
3564 (setq begB (region-beginning)
3571 (or (eobp) (forward-char)) ; include the newline char
3572 (setq endB (point)))
3575 (ediff-regions-internal
3576 bufA begA endA bufB begB endB
3578 (if use-current-diff-p ; job name
3579 'ediff-regions-wordwise
3580 'ediff-regions-linewise)
3581 (if use-current-diff-p ; word mode, if diffing current diff
3583 ;; setup param to pass to ediff-setup
3584 (list (cons 'ediff-split-window-function ediff-split-window-function)))
3589 (defun ediff-remove-flags-from-buffer (buffer overlay)
3590 (ediff-with-current-buffer buffer
3591 (let ((inhibit-read-only t))
3593 (ediff-overlay-put overlay 'begin-glyph nil)
3594 (ediff-overlay-put overlay 'before-string nil))
3597 (ediff-overlay-put overlay 'end-glyph nil)
3598 (ediff-overlay-put overlay 'after-string nil))
3603 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
3604 (ediff-with-current-buffer buffer
3605 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
3608 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
3609 (let* ((curr-overl (ediff-with-current-buffer ctl-buffer
3610 (ediff-get-diff-overlay diff-no buf-type)))
3611 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
3612 after beg-of-line flag)
3614 ;; insert flag before the difference
3616 (setq beg-of-line (bolp))
3618 (setq flag (ediff-with-current-buffer ctl-buffer
3619 (if (eq ediff-highlighting-style 'ascii)
3621 ediff-before-flag-bol ediff-before-flag-mol))))
3623 ;; insert the flag itself
3625 (ediff-overlay-put curr-overl 'begin-glyph flag)
3626 (ediff-overlay-put curr-overl 'before-string flag))
3628 ;; insert the flag after the difference
3629 ;; `after' must be set here, after the before-flag was inserted
3630 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
3632 (setq beg-of-line (bolp))
3634 (setq flag (ediff-with-current-buffer ctl-buffer
3635 (if (eq ediff-highlighting-style 'ascii)
3637 ediff-after-flag-eol ediff-after-flag-mol))))
3639 ;; insert the flag itself
3641 (ediff-overlay-put curr-overl 'end-glyph flag)
3642 (ediff-overlay-put curr-overl 'after-string flag))
3646 ;;; Some diff region tests
3648 ;; t if diff region is empty.
3649 ;; In case of buffer C, t also if it is not a 3way
3650 ;; comparison job (merging jobs return t as well).
3651 (defun ediff-empty-diff-region-p (n buf-type)
3652 (if (eq buf-type 'C)
3653 (or (not ediff-3way-comparison-job)
3654 (= (ediff-get-diff-posn 'C 'beg n)
3655 (ediff-get-diff-posn 'C 'end n)))
3656 (= (ediff-get-diff-posn buf-type 'beg n)
3657 (ediff-get-diff-posn buf-type 'end n))))
3659 ;; Test if diff region is white space only.
3660 ;; If 2-way job and buf-type = C, then returns t.
3661 (defun ediff-whitespace-diff-region-p (n buf-type)
3662 (or (and (eq buf-type 'C) (not ediff-3way-job))
3663 (ediff-empty-diff-region-p n buf-type)
3664 (let ((beg (ediff-get-diff-posn buf-type 'beg n))
3665 (end (ediff-get-diff-posn buf-type 'end n)))
3666 (ediff-with-current-buffer (ediff-get-buffer buf-type)
3669 (skip-chars-forward ediff-whitespace)
3670 (>= (point) end))))))
3673 (defsubst ediff-get-region-contents (n buf-type ctrl-buf &optional start end)
3674 (ediff-with-current-buffer
3675 (ediff-with-current-buffer ctrl-buf (ediff-get-buffer buf-type))
3677 (or start (ediff-get-diff-posn buf-type 'beg n ctrl-buf))
3678 (or end (ediff-get-diff-posn buf-type 'end n ctrl-buf)))))
3680 ;; Returns positions of difference sectors in the BUF-TYPE buffer.
3681 ;; BUF-TYPE should be a symbol -- `A', `B', or `C'.
3682 ;; POS is either `beg' or `end'--it specifies whether you want the position at
3683 ;; the beginning of a difference or at the end.
3685 ;; The optional argument N says which difference (default:
3686 ;; `ediff-current-difference'). N is the internal difference number (1- what
3687 ;; the user sees). The optional argument CONTROL-BUF says
3688 ;; which control buffer is in effect in case it is not the current
3690 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
3693 (setq control-buf (current-buffer)))
3695 (ediff-with-current-buffer control-buf
3696 (or n (setq n ediff-current-difference))
3697 (if (or (< n 0) (>= n ediff-number-of-differences))
3698 (if (> ediff-number-of-differences 0)
3699 (error ediff-BAD-DIFF-NUMBER
3700 this-command (1+ n) ediff-number-of-differences)
3701 (error ediff-NO-DIFFERENCES)))
3702 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
3703 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
3704 (error ediff-KILLED-VITAL-BUFFER))
3706 (ediff-overlay-start diff-overlay)
3707 (ediff-overlay-end diff-overlay))
3711 ;; Restore highlighting to what it should be according to ediff-use-faces,
3712 ;; ediff-highlighting-style, and ediff-highlight-all-diffs variables.
3713 (defun ediff-restore-highlighting (&optional ctl-buf)
3714 (ediff-with-current-buffer (or ctl-buf (current-buffer))
3715 (if (and (ediff-has-face-support-p)
3717 ediff-highlight-all-diffs)
3718 (ediff-paint-background-regions))
3719 (ediff-select-difference ediff-current-difference)))
3723 ;; null out difference overlays so they won't slow down future
3724 ;; editing operations
3725 ;; VEC is either a difference vector or a fine-diff vector
3726 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
3727 (if (vectorp (symbol-value vec-var))
3728 (mapcar (lambda (elt)
3729 (ediff-delete-overlay
3730 (ediff-get-diff-overlay-from-diff-record elt))
3732 (ediff-clear-fine-diff-vector elt))
3734 (symbol-value vec-var)))
3735 ;; allow them to be garbage collected
3742 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
3743 ;; supporting sticky overlays, this function will make a sticky overlay.
3744 ;; BEG and END are expressions telling where overlay starts.
3745 ;; If they are numbers or buffers, then all is well. Otherwise, they must
3746 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
3748 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
3749 ;; newly created overlay.
3750 (defun ediff-make-bullet-proof-overlay (beg end buff)
3751 (if (ediff-buffer-live-p buff)
3753 (ediff-with-current-buffer buff
3754 (or (number-or-marker-p beg)
3755 (setq beg (eval beg)))
3756 (or (number-or-marker-p end)
3757 (setq end (eval end)))
3759 (ediff-cond-compile-for-xemacs-or-emacs
3760 (make-extent beg end buff) ; xemacs
3761 ;; advance front and rear of the overlay
3762 (make-overlay beg end buff nil 'rear-advance) ; emacs
3767 overl (if ediff-emacs-p 'evaporate 'detachable) nil)
3768 ;; make overlay open-ended
3769 ;; In emacs, it is made open ended at creation time
3772 (ediff-overlay-put overl 'start-open nil)
3773 (ediff-overlay-put overl 'end-open nil)))
3774 (ediff-overlay-put overl 'ediff-diff-num 0)
3778 (defun ediff-make-current-diff-overlay (type)
3779 (if (ediff-has-face-support-p)
3780 (let ((overlay (ediff-get-symbol-from-alist
3781 type ediff-current-diff-overlay-alist))
3782 (buffer (ediff-get-buffer type))
3785 (ediff-get-symbol-from-alist
3786 type ediff-current-diff-face-alist)))))
3788 (ediff-make-bullet-proof-overlay (point-max) (point-max) buffer))
3789 (ediff-set-overlay-face (symbol-value overlay) face)
3790 (ediff-overlay-put (symbol-value overlay) 'ediff ediff-control-buffer))
3794 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3795 ;; other insignificant buffers (those beginning with "^[ *]").
3796 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3798 ;; EXCL-BUFF-LIST is an exclusion list.
3799 (defun ediff-other-buffer (excl-buff-lst)
3800 (or (listp excl-buff-lst) (setq excl-buff-lst (list excl-buff-lst)))
3801 (let* ((all-buffers (nconc (ediff-get-selected-buffers) (buffer-list)))
3802 ;; we compute this the second time because we need to do memq on it
3803 ;; later, and nconc above will break it. Either this or use slow
3804 ;; append instead of nconc
3805 (selected-buffers (ediff-get-selected-buffers))
3806 (prefered-buffer (car all-buffers))
3807 visible-dired-buffers
3808 (excl-buff-name-list
3810 (lambda (b) (cond ((stringp b) b)
3811 ((bufferp b) (buffer-name b))))
3813 ;; if at least one buffer on the exclusion list is dired, then force
3814 ;; all others to be dired. This is because this means that the user
3815 ;; has already chosen a dired buffer before
3816 (use-dired-major-mode
3817 (cond ((null (ediff-buffer-live-p (car excl-buff-lst))) 'unknown)
3818 ((eq (ediff-with-current-buffer (car excl-buff-lst) major-mode)
3822 ;; significant-buffers must be visible and not belong
3823 ;; to the exclusion list `buff-list'
3824 ;; We also exclude temporary buffers, but keep mail and gnus buffers
3825 ;; Furthermore, we exclude dired buffers, unless they are the only
3826 ;; ones visible (and there are at least two of them).
3827 ;; Also, any visible window not on the exclusion list that is first in
3828 ;; the buffer list is chosen regardless. (This is because the user
3829 ;; clicked on it or did something to distinguish it).
3830 (significant-buffers
3833 (cond ((member (buffer-name x) excl-buff-name-list) nil)
3834 ((memq x selected-buffers) x)
3835 ((not (ediff-get-visible-buffer-window x)) nil)
3836 ((eq x prefered-buffer) x)
3837 ;; if prev selected buffer is dired, look only at
3839 ((eq use-dired-major-mode 'yes)
3840 (if (eq (ediff-with-current-buffer x major-mode)
3843 ((eq (ediff-with-current-buffer x major-mode)
3845 (if (null use-dired-major-mode)
3846 ;; don't know if we must enforce dired.
3847 ;; Remember this buffer in case
3848 ;; dired buffs are the only ones visible.
3849 (setq visible-dired-buffers
3850 (cons x visible-dired-buffers)))
3851 ;; skip, if dired is not forced
3853 ((memq (ediff-with-current-buffer x major-mode)
3859 ((string-match "^[ *]" (buffer-name x)) nil)
3860 ((string= "*scratch*" (buffer-name x)) nil)
3863 (clean-significant-buffers (delq nil significant-buffers))
3864 less-significant-buffers)
3866 (if (and (null clean-significant-buffers)
3867 (> (length visible-dired-buffers) 0))
3868 (setq clean-significant-buffers visible-dired-buffers))
3870 (cond (clean-significant-buffers (car clean-significant-buffers))
3871 ;; try also buffers that are not displayed in windows
3872 ((setq less-significant-buffers
3876 (cond ((member (buffer-name x) excl-buff-name-list)
3878 ((eq use-dired-major-mode 'yes)
3879 (if (eq (ediff-with-current-buffer
3883 ((eq (ediff-with-current-buffer x major-mode)
3886 ((string-match "^[ *]" (buffer-name x)) nil)
3887 ((string= "*scratch*" (buffer-name x)) nil)
3890 (car less-significant-buffers))
3895 ;; If current buffer is a Buffer-menu buffer, then take the selected buffers
3896 ;; and append the buffer at the cursor to the end.
3897 ;; This list would be the preferred list.
3898 (defun ediff-get-selected-buffers ()
3899 (if (eq major-mode 'Buffer-menu-mode)
3900 (let ((lis (condition-case nil
3901 (list (Buffer-menu-buffer t))
3905 (goto-char (point-max))
3906 (while (search-backward "\n>" nil t)
3908 (setq lis (cons (Buffer-menu-buffer t) lis)))
3912 ;; Construct a unique buffer name.
3913 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3914 ;; prefix<3>suffix, etc.
3915 (defun ediff-unique-buffer-name (prefix suffix)
3916 (if (null (get-buffer (concat prefix suffix)))
3917 (concat prefix suffix)
3919 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3921 (format "%s<%d>%s" prefix n suffix))))
3924 (defun ediff-submit-report ()
3925 "Submit bug report on Ediff."
3927 (ediff-barf-if-not-control-buffer)
3928 (let ((reporter-prompt-for-summary-p t)
3929 (ctl-buf ediff-control-buffer)
3930 (ediff-device-type (ediff-device-type))
3931 varlist salutation buffer-name)
3932 (setq varlist '(ediff-diff-program ediff-diff-options
3933 ediff-patch-program ediff-patch-options
3936 ediff-auto-refine ediff-highlighting-style
3937 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3938 ediff-forward-word-function
3940 ediff-control-frame-parameters
3941 ediff-control-frame-position-function
3942 ediff-prefer-iconified-control-frame
3943 ediff-window-setup-function
3944 ediff-split-window-function
3951 Congratulations! You may have unearthed a bug in Ediff!
3953 Please make a concise and accurate summary of what happened
3954 and mail it to the address above.
3955 -----------------------------------------------------------
3958 (ediff-skip-unsuitable-frames)
3961 (switch-to-buffer ediff-msg-buffer)
3963 (delete-other-windows)
3965 Please read this first:
3966 ----------------------
3968 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3969 reporting that certain difference regions are not matched as you think they
3970 should, this is most likely due to the way Unix diff program decides what
3971 constitutes a difference region. Ediff is an Emacs interface to diff, and
3972 it has nothing to do with those decisions---it only takes the output from
3973 diff and presents it in a way that is better suited for human browsing and
3976 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3977 an Emacs bug. Report this to Emacs maintainers.
3979 Another popular topic for reports is compilation messages. Because Ediff
3980 interfaces to several other packages and runs under Emacs and XEmacs,
3981 byte-compilation may produce output like this:
3983 While compiling toplevel forms in file ediff.el:
3984 ** reference to free variable pm-color-alist
3985 ........................
3986 While compiling the end of the data:
3987 ** The following functions are not known to be defined:
3988 ediff-valid-color-p, ediff-set-face,
3989 ........................
3991 These are NOT errors, but inevitable warnings, which ought to be ignored.
3993 Please do not report those and similar things. However, comments and
3994 suggestions are always welcome.
3996 Mail anyway? (y or n) ")
3998 (if (y-or-n-p "Mail anyway? ")
4000 (if (ediff-buffer-live-p ctl-buf)
4001 (set-buffer ctl-buf))
4002 (setq buffer-name (buffer-name))
4004 (reporter-submit-bug-report "kifer@cs.stonybrook.edu"
4008 'delete-other-windows
4011 (beep 1)(message "Bug report aborted")
4012 (if (ediff-buffer-live-p ctl-buf)
4013 (ediff-with-current-buffer ctl-buf
4014 (ediff-recenter 'no-rehighlight))))
4018 ;; Find an appropriate syntax table for everyone to use
4019 ;; If buffer B is not fundamental or text mode, use its syntax table
4020 ;; Otherwise, use buffer B's.
4021 ;; The syntax mode is used in ediff-forward-word-function
4022 ;; The important thing is that every buffer should use the same syntax table
4023 ;; during the refinement operation
4024 (defun ediff-choose-syntax-table ()
4025 (setq ediff-syntax-table
4026 (ediff-with-current-buffer ediff-buffer-A
4027 (if (not (memq major-mode
4028 '(fundamental-mode text-mode indented-text-mode)))
4030 (if (not ediff-syntax-table)
4031 (setq ediff-syntax-table
4032 (ediff-with-current-buffer ediff-buffer-B
4037 (defun ediff-deactivate-mark ()
4038 (ediff-cond-compile-for-xemacs-or-emacs
4039 (zmacs-deactivate-region) ; xemacs
4040 (deactivate-mark) ; emacs
4042 (defun ediff-activate-mark ()
4043 (ediff-cond-compile-for-xemacs-or-emacs
4044 (zmacs-activate-region) ; xemacs
4045 (setq mark-active t) ; emacs
4048 (cond ((fboundp 'nuke-selective-display)
4049 ;; XEmacs has nuke-selective-display
4050 (defalias 'ediff-nuke-selective-display 'nuke-selective-display))
4052 (defun ediff-nuke-selective-display ()
4056 (goto-char (point-min))
4057 (let ((mod-p (buffer-modified-p))
4058 buffer-read-only end)
4059 (and (eq t selective-display)
4060 (while (search-forward "\^M" nil t)
4064 (while (search-forward "\^M" end t)
4067 (set-buffer-modified-p mod-p)
4068 (setq selective-display nil)))))
4072 ;; The next two are modified versions from emerge.el.
4073 ;; VARS must be a list of symbols
4074 ;; ediff-save-variables returns an association list: ((var . val) ...)
4075 (defsubst ediff-save-variables (vars)
4076 (mapcar (lambda (v) (cons v (symbol-value v)))
4078 ;; VARS is a list of variable symbols.
4079 (defun ediff-restore-variables (vars assoc-list)
4081 (set (car vars) (cdr (assoc (car vars) assoc-list)))
4082 (setq vars (cdr vars))))
4084 (defun ediff-change-saved-variable (var value buf-type)
4086 (symbol-value (ediff-get-symbol-from-alist
4088 ediff-buffer-values-orig-alist)))
4089 (assoc-elt (assoc var assoc-list)))
4091 (setcdr assoc-elt value))))
4094 ;; must execute in control buf
4095 (defun ediff-save-protected-variables ()
4096 (setq ediff-buffer-values-orig-A
4097 (ediff-with-current-buffer ediff-buffer-A
4098 (ediff-save-variables ediff-protected-variables)))
4099 (setq ediff-buffer-values-orig-B
4100 (ediff-with-current-buffer ediff-buffer-B
4101 (ediff-save-variables ediff-protected-variables)))
4102 (if ediff-3way-comparison-job
4103 (setq ediff-buffer-values-orig-C
4104 (ediff-with-current-buffer ediff-buffer-C
4105 (ediff-save-variables ediff-protected-variables))))
4106 (if (ediff-buffer-live-p ediff-ancestor-buffer)
4107 (setq ediff-buffer-values-orig-Ancestor
4108 (ediff-with-current-buffer ediff-ancestor-buffer
4109 (ediff-save-variables ediff-protected-variables)))))
4111 ;; must execute in control buf
4112 (defun ediff-restore-protected-variables ()
4113 (let ((values-A ediff-buffer-values-orig-A)
4114 (values-B ediff-buffer-values-orig-B)
4115 (values-C ediff-buffer-values-orig-C)
4116 (values-Ancestor ediff-buffer-values-orig-Ancestor))
4117 (ediff-with-current-buffer ediff-buffer-A
4118 (ediff-restore-variables ediff-protected-variables values-A))
4119 (ediff-with-current-buffer ediff-buffer-B
4120 (ediff-restore-variables ediff-protected-variables values-B))
4121 (if ediff-3way-comparison-job
4122 (ediff-with-current-buffer ediff-buffer-C
4123 (ediff-restore-variables ediff-protected-variables values-C)))
4124 (if (ediff-buffer-live-p ediff-ancestor-buffer)
4125 (ediff-with-current-buffer ediff-ancestor-buffer
4126 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
4129 ;; save BUFFER in FILE. used in hooks.
4130 (defun ediff-save-buffer-in-file (buffer file)
4131 (ediff-with-current-buffer buffer
4137 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
4139 ;; calculate time used by command
4140 (defun ediff-calc-command-time ()
4141 (let ((end (current-time))
4144 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
4145 (- (nth 2 end) (nth 2 ediff-command-begin-time))
4146 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
4147 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
4148 (or (equal ediff-command-begin-time '(0 0 0))
4149 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
4151 (defsubst ediff-save-time ()
4152 (setq ediff-command-begin-time (current-time)))
4154 (defun ediff-profile ()
4155 "Toggle profiling Ediff commands."
4157 (ediff-barf-if-not-control-buffer)
4159 (ediff-cond-compile-for-xemacs-or-emacs
4160 (make-local-hook 'post-command-hook) ; xemacs form
4164 (let ((pre-hook 'pre-command-hook)
4165 (post-hook 'post-command-hook))
4166 (if (not (equal ediff-command-begin-time '(0 0 0)))
4167 (progn (remove-hook pre-hook 'ediff-save-time)
4168 (remove-hook post-hook 'ediff-calc-command-time)
4169 (setq ediff-command-begin-time '(0 0 0))
4170 (message "Ediff profiling disabled"))
4171 (add-hook pre-hook 'ediff-save-time t 'local)
4172 (add-hook post-hook 'ediff-calc-command-time nil 'local)
4173 (message "Ediff profiling enabled"))))
4175 (defun ediff-print-diff-vector (diff-vector-var)
4176 (princ (format "\n*** %S ***\n" diff-vector-var))
4177 (mapcar (lambda (overl-vec)
4180 "Diff %d: \tOverlay: %S
4182 \t\tNo-fine-diff-flag: %S
4183 \t\tState-of-diff:\t %S
4184 \t\tState-of-merge:\t %S
4186 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
4189 (if (= (length (aref overl-vec 1)) 0)
4191 (mapconcat 'prin1-to-string
4192 (aref overl-vec 1) "\n\t\t\t "))
4193 (aref overl-vec 2) ; no fine diff flag
4194 (aref overl-vec 3) ; state-of-diff
4195 (aref overl-vec 4) ; state-of-merge
4197 (eval diff-vector-var)))
4201 (defun ediff-debug-info ()
4203 (ediff-barf-if-not-control-buffer)
4204 (with-output-to-temp-buffer ediff-debug-buffer
4205 (ediff-with-current-buffer standard-output
4207 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
4208 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
4209 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
4210 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
4211 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
4215 ;;; General utilities
4217 ;; this uses comparison-func to decide who is a member
4218 (defun ediff-member (elt lis comparison-func)
4219 (while (and lis (not (funcall comparison-func (car lis) elt)))
4220 (setq lis (cdr lis)))
4223 ;; Make a readable representation of the invocation sequence for FUNC-DEF.
4224 ;; It would either be a key or M-x something.
4225 (defun ediff-format-bindings-of (func-def)
4226 (let ((desc (car (where-is-internal func-def
4227 overriding-local-map
4230 (key-description desc)
4231 (format "M-x %s" func-def))))
4233 ;; this uses comparison-func to decide who is a member, and this determines how
4234 ;; intersection looks like
4235 (defun ediff-intersection (lis1 lis2 comparison-func)
4236 (let ((result (list 'a)))
4238 (if (ediff-member (car lis1) lis2 comparison-func)
4239 (nconc result (list (car lis1))))
4240 (setq lis1 (cdr lis1)))
4244 ;; eliminates duplicates using comparison-func
4245 (defun ediff-union (lis1 lis2 comparison-func)
4246 (let ((result (list 'a)))
4248 (or (ediff-member (car lis1) (cdr result) comparison-func)
4249 (nconc result (list (car lis1))))
4250 (setq lis1 (cdr lis1)))
4252 (or (ediff-member (car lis2) (cdr result) comparison-func)
4253 (nconc result (list (car lis2))))
4254 (setq lis2 (cdr lis2)))
4257 ;; eliminates duplicates using comparison-func
4258 (defun ediff-set-difference (lis1 lis2 comparison-func)
4259 (let ((result (list 'a)))
4261 (or (ediff-member (car lis1) (cdr result) comparison-func)
4262 (ediff-member (car lis1) lis2 comparison-func)
4263 (nconc result (list (car lis1))))
4264 (setq lis1 (cdr lis1)))
4267 (if (fboundp 'copy-sequence)
4268 (defalias 'ediff-copy-list 'copy-sequence)
4269 (defun ediff-copy-list (list)
4272 ;;; (while (consp list) (push (pop list) res))
4273 ;;; (prog1 (nreverse res) (setcdr res list)))
4276 (setq elt (car list)
4283 ;; don't report error if version control package wasn't found
4284 ;;(ediff-load-version-control 'silent)
4286 (run-hooks 'ediff-load-hook)
4289 ;;; Local Variables:
4290 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
4291 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
4292 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
4295 ;;; arch-tag: f51099b6-ef4b-470f-88a1-3a0e0b03a879
4296 ;;; ediff-util.el ends here