1 ;;; ediff-util.el --- the core commands and utilities of ediff
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
29 (defvar ediff-patch-diagnostics
)
30 (defvar ediff-patchbufer
)
31 (defvar ediff-toolbar
)
32 (defvar ediff-toolbar-3way
)
33 (defvar bottom-toolbar
)
34 (defvar bottom-toolbar-visible-p
)
35 (defvar bottom-toolbar-height
)
39 (let ((load-path (cons (expand-file-name ".") load-path
)))
40 (or (featurep 'ediff-init
)
41 (load "ediff-init.el" nil nil
'nosuffix
))
42 (or (featurep 'ediff-help
)
43 (load "ediff-help.el" nil nil
'nosuffix
))
44 (or (featurep 'ediff-mult
)
45 (load "ediff-mult.el" nil nil
'nosuffix
))
46 (or (featurep 'ediff-wind
)
47 (load "ediff-wind.el" nil nil
'nosuffix
))
48 (or (featurep 'ediff-diff
)
49 (load "ediff-diff.el" nil nil
'nosuffix
))
50 (or (featurep 'ediff-merg
)
51 (load "ediff-merg.el" nil nil
'nosuffix
))
53 (load "ediff.el" nil nil
'nosuffix
))
54 (or (featurep 'ediff-tbar
)
55 (load "ediff-tbar.el" 'noerror nil
'nosuffix
))
67 ;; be careful with ediff-tbar
72 (defun ediff-use-toolbar-p () nil
)))
73 (defun ediff-use-toolbar-p () nil
))
79 "Ediff mode controls all operations in a single Ediff session.
80 This mode is entered through one of the following commands:
91 `ediff-merge-files-with-ancestor'
93 `ediff-merge-buffers-with-ancestor'
94 `ediff-merge-revisions'
95 `ediff-merge-revisions-with-ancestor'
96 `ediff-windows-wordwise'
97 `ediff-windows-linewise'
98 `ediff-regions-wordwise'
99 `ediff-regions-linewise'
109 (kill-all-local-variables)
110 (setq major-mode
'ediff-mode
)
111 (setq mode-name
"Ediff")
112 (run-hooks 'ediff-mode-hook
))
118 (ediff-defvar-local ediff-mode-map nil
119 "Local keymap used in Ediff mode.
120 This is local to each Ediff Control Panel, so they may vary from invocation
123 ;; Set up the keymap in the control buffer
124 (defun ediff-set-keys ()
125 "Set up Ediff keymap, if necessary."
126 (if (null ediff-mode-map
)
127 (ediff-setup-keymap))
128 (use-local-map ediff-mode-map
))
130 ;; Reload Ediff keymap. For debugging only.
131 (defun ediff-reload-keymap ()
133 (setq ediff-mode-map nil
)
137 (defun ediff-setup-keymap ()
138 "Set up the keymap used in the control buffer of Ediff."
139 (setq ediff-mode-map
(make-sparse-keymap))
140 (suppress-keymap ediff-mode-map
)
142 (define-key ediff-mode-map
143 (if ediff-emacs-p
[mouse-2
] [button2]) 'ediff-help-for-quick-help)
144 (define-key ediff-mode-map "\C-m" 'ediff-help-for-quick-help)
146 (define-key ediff-mode-map "p" 'ediff-previous-difference)
147 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
148 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
149 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
150 'ediff-previous-difference nil))
151 ;; must come after C-h, or else C-h wipes out backspace's binding in XEmacs
152 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
153 (define-key ediff-mode-map "n" 'ediff-next-difference)
154 (define-key ediff-mode-map " " 'ediff-next-difference)
155 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
156 (define-key ediff-mode-map "g" nil)
157 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
158 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
159 (define-key ediff-mode-map "q" 'ediff-quit)
160 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
161 (define-key ediff-mode-map "z" 'ediff-suspend)
162 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
163 (define-key ediff-mode-map "|" 'ediff-toggle-split)
164 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
166 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
168 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
169 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
170 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
171 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
172 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
173 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
174 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
175 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
176 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
177 (define-key ediff-mode-map "i" 'ediff-status-info)
178 (define-key ediff-mode-map "E" 'ediff-documentation)
179 (define-key ediff-mode-map "?" 'ediff-toggle-help)
180 (define-key ediff-mode-map "!" 'ediff-update-diffs)
181 (define-key ediff-mode-map "M" 'ediff-show-meta-buffer)
182 (define-key ediff-mode-map "R" 'ediff-show-registry)
184 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
185 (define-key ediff-mode-map "a" nil)
186 (define-key ediff-mode-map "b" nil)
187 (define-key ediff-mode-map "r" nil)
188 (cond (ediff-merge-job
189 ;; Will barf if no ancestor
190 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
191 ;; In merging, we allow only A->C and B->C copying.
192 (define-key ediff-mode-map "a" 'ediff-copy-A-to-C)
193 (define-key ediff-mode-map "b" 'ediff-copy-B-to-C)
194 (define-key ediff-mode-map "r" 'ediff-restore-diff-in-merge-buffer)
195 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
196 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
197 (define-key ediff-mode-map "$" 'ediff-toggle-show-clashes-only)
198 (define-key ediff-mode-map "&" 'ediff-re-merge))
199 (ediff-3way-comparison-job
200 (define-key ediff-mode-map "ab" 'ediff-copy-A-to-B)
201 (define-key ediff-mode-map "ba" 'ediff-copy-B-to-A)
202 (define-key ediff-mode-map "ac" 'ediff-copy-A-to-C)
203 (define-key ediff-mode-map "bc" 'ediff-copy-B-to-C)
204 (define-key ediff-mode-map "c" nil)
205 (define-key ediff-mode-map "ca" 'ediff-copy-C-to-A)
206 (define-key ediff-mode-map "cb" 'ediff-copy-C-to-B)
207 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
208 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
209 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
210 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
211 (t ; 2-way comparison
212 (define-key ediff-mode-map "a" 'ediff-copy-A-to-B)
213 (define-key ediff-mode-map "b" 'ediff-copy-B-to-A)
214 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
215 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
217 (define-key ediff-mode-map "G" 'ediff-submit-report)
218 (define-key ediff-mode-map "#" nil)
219 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
220 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
222 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
223 (define-key ediff-mode-map "o" nil)
224 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
225 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
226 (define-key ediff-mode-map "w" nil)
227 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
228 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
229 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
230 (define-key ediff-mode-map "=" 'ediff-inferior-compare-regions)
231 (if (fboundp 'ediff-show-patch-diagnostics)
232 (define-key ediff-mode-map "P" 'ediff-show-patch-diagnostics))
235 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
236 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
239 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
241 ;; Allow ediff-mode-map to be referenced indirectly
242 (fset 'ediff-mode-map ediff-mode-map)
243 (run-hooks 'ediff-keymap-setup-hook))
248 ;; Common startup entry for all Ediff functions It now returns control buffer
249 ;; so other functions can do post-processing SETUP-PARAMETERS is a list of the
250 ;; form ((param .val) (param . val)...) This serves a similar purpose to
251 ;; STARTUP-HOOKS, but these parameters are set in the new control buffer right
252 ;; after this buf is created and before any windows are set and such.
253 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
254 startup-hooks setup-parameters)
255 ;; ediff-convert-standard-filename puts file names in the form appropriate
256 ;; for the OS at hand.
257 (setq file-A (ediff-convert-standard-filename (expand-file-name file-A)))
258 (setq file-B (ediff-convert-standard-filename (expand-file-name file-B)))
261 (ediff-convert-standard-filename (expand-file-name file-C))))
262 (let* ((control-buffer-name
263 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
264 (control-buffer (ediff-with-current-buffer buffer-A
265 (get-buffer-create control-buffer-name))))
266 (ediff-with-current-buffer control-buffer
269 (make-local-variable 'ediff-use-long-help-message)
270 (make-local-variable 'ediff-prefer-iconified-control-frame)
271 (make-local-variable 'ediff-split-window-function)
272 (make-local-variable 'ediff-default-variant)
273 (make-local-variable 'ediff-merge-window-share)
274 (make-local-variable 'ediff-window-setup-function)
275 (make-local-variable 'ediff-keep-variants)
277 ;; unwrap set up parameters passed as argument
278 (while setup-parameters
279 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
280 (setq setup-parameters (cdr setup-parameters)))
282 ;; set variables classifying the current ediff job
283 ;; must come AFTER setup-parameters
284 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
285 ediff-merge-job (ediff-merge-job)
286 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
287 ediff-3way-job (ediff-3way-job)
288 ediff-diff3-job (ediff-diff3-job)
289 ediff-narrow-job (ediff-narrow-job)
290 ediff-windows-job (ediff-windows-job)
291 ediff-word-mode-job (ediff-word-mode-job))
293 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
294 ;; This is because u may loose work---dangerous.
295 (if (string-match "buffer" (symbol-name ediff-job-name))
296 (setq ediff-keep-variants t))
298 (make-local-hook 'pre-command-hook)
299 (if (ediff-window-display-p)
300 (add-hook 'pre-command-hook 'ediff-spy-after-mouse nil t))
301 (setq ediff-mouse-pixel-position (mouse-pixel-position))
303 ;; adjust for merge jobs
306 ;; If default variant is `combined', the right stuff is
307 ;; inserted by ediff-do-merge
308 ;; Note: at some point, we tried to put ancestor buffer here
309 ;; (which is currently buffer C. This didn't work right
310 ;; because the merge buffer will contain lossage: diff regions
311 ;; in the ancestor, which correspond to revisions that agree
312 ;; in both buf A and B.
313 (cond ((eq ediff-default-variant 'default-B)
317 (setq ediff-split-window-function
318 ediff-merge-split-window-function)
320 ;; remember the ancestor buffer, if any
321 (setq ediff-ancestor-buffer buffer-C)
325 (ediff-unique-buffer-name "*ediff-merge" "*")))
327 (set-buffer buffer-C)
329 (funcall (ediff-with-current-buffer buf major-mode))
330 ;; after Stig@hackvan.com
331 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode nil t)
333 (setq buffer-read-only nil
334 ediff-buffer-A buffer-A
335 ediff-buffer-B buffer-B
336 ediff-buffer-C buffer-C
337 ediff-control-buffer control-buffer)
339 (setq ediff-control-buffer-suffix
340 (if (string-match "<[0-9]*>" control-buffer-name)
341 (substring control-buffer-name
342 (match-beginning 0) (match-end 0))
344 ediff-control-buffer-number
350 ediff-control-buffer-suffix
352 (string-match "[0-9]+" ediff-control-buffer-suffix)
355 (setq ediff-error-buffer
356 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
358 (ediff-with-current-buffer buffer-A (ediff-strip-mode-line-format))
359 (ediff-with-current-buffer buffer-B (ediff-strip-mode-line-format))
361 (ediff-with-current-buffer buffer-C (ediff-strip-mode-line-format)))
362 (if (ediff-buffer-live-p ediff-ancestor-buffer)
363 (ediff-with-current-buffer ediff-ancestor-buffer
364 (ediff-strip-mode-line-format)))
366 (ediff-save-protected-variables) ; save variables to be restored on exit
368 ;; ediff-setup-diff-regions-function must be set after setup
369 ;; parameters are processed.
370 (setq ediff-setup-diff-regions-function
372 'ediff-setup-diff-regions3
373 'ediff-setup-diff-regions))
375 (setq ediff-wide-bounds
376 (list (ediff-make-bullet-proof-overlay
377 '(point-min) '(point-max) ediff-buffer-A)
378 (ediff-make-bullet-proof-overlay
379 '(point-min) '(point-max) ediff-buffer-B)
380 (ediff-make-bullet-proof-overlay
381 '(point-min) '(point-max) ediff-buffer-C)))
383 ;; This has effect only on ediff-windows/regions
384 ;; In all other cases, ediff-visible-region sets visibility bounds to
385 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
386 (if ediff-start-narrowed
387 (setq ediff-visible-bounds ediff-narrow-bounds)
388 (setq ediff-visible-bounds ediff-wide-bounds))
390 (ediff-set-keys) ; comes after parameter setup
392 ;; set up ediff-narrow-bounds, if not set
393 (or ediff-narrow-bounds
394 (setq ediff-narrow-bounds ediff-wide-bounds))
396 ;; All these must be inside ediff-with-current-buffer control-buffer,
397 ;; since these vars are local to control-buffer
398 ;; These won't run if there are errors in diff
399 (ediff-with-current-buffer ediff-buffer-A
400 (ediff-nuke-selective-display)
401 (run-hooks 'ediff-prepare-buffer-hook)
402 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
403 (setq buffer-read-only t))
404 ;; add control-buffer to the list of sessions--no longer used, but may
405 ;; be used again in the future
406 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
407 (setq ediff-this-buffer-ediff-sessions
408 (cons control-buffer ediff-this-buffer-ediff-sessions)))
409 (if ediff-make-buffers-readonly-at-startup
410 (setq buffer-read-only t))
413 (ediff-with-current-buffer ediff-buffer-B
414 (ediff-nuke-selective-display)
415 (run-hooks 'ediff-prepare-buffer-hook)
416 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
417 (setq buffer-read-only t))
418 ;; add control-buffer to the list of sessions
419 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
420 (setq ediff-this-buffer-ediff-sessions
421 (cons control-buffer ediff-this-buffer-ediff-sessions)))
422 (if ediff-make-buffers-readonly-at-startup
423 (setq buffer-read-only t))
427 (ediff-with-current-buffer ediff-buffer-C
428 (ediff-nuke-selective-display)
429 (run-hooks 'ediff-prepare-buffer-hook)
430 ;; add control-buffer to the list of sessions
431 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
432 (setq ediff-this-buffer-ediff-sessions
434 ediff-this-buffer-ediff-sessions)))
435 (if ediff-make-buffers-readonly-at-startup
436 (setq buffer-read-only t))
439 (if (ediff-buffer-live-p ediff-ancestor-buffer)
440 (ediff-with-current-buffer ediff-ancestor-buffer
441 (ediff-nuke-selective-display)
442 (setq buffer-read-only t)
443 (run-hooks 'ediff-prepare-buffer-hook)
444 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
445 (setq ediff-this-buffer-ediff-sessions
447 ediff-this-buffer-ediff-sessions)))
450 ;; must come after setting up ediff-narrow-bounds AND after
451 ;; nuking selective display
452 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
453 (setq ediff-number-of-differences (length ediff-difference-vector-A))
454 (setq ediff-current-difference -1)
456 (ediff-make-current-diff-overlay 'A)
457 (ediff-make-current-diff-overlay 'B)
459 (ediff-make-current-diff-overlay 'C))
460 (if ediff-merge-with-ancestor-job
461 (ediff-make-current-diff-overlay 'Ancestor))
463 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
465 (let ((shift-A (ediff-overlay-start
466 (ediff-get-value-according-to-buffer-type
467 'A ediff-narrow-bounds)))
468 (shift-B (ediff-overlay-start
469 (ediff-get-value-according-to-buffer-type
470 'B ediff-narrow-bounds)))
471 (shift-C (ediff-overlay-start
472 (ediff-get-value-according-to-buffer-type
473 'C ediff-narrow-bounds))))
474 ;; position point in buf A
476 (select-window ediff-window-A)
478 ;; position point in buf B
480 (select-window ediff-window-B)
484 (select-window ediff-window-C)
485 (goto-char shift-C)))
488 (select-window ediff-control-window)
489 (ediff-visible-region)
491 (run-hooks 'startup-hooks)
492 (ediff-refresh-mode-lines)
493 (setq buffer-read-only t)
494 (setq ediff-session-registry
495 (cons control-buffer ediff-session-registry))
496 (ediff-update-registry)
497 (if (ediff-buffer-live-p ediff-meta-buffer)
498 (ediff-update-meta-buffer ediff-meta-buffer))
499 (run-hooks 'ediff-startup-hook)
500 ) ; eval in control-buffer
504 ;; This function assumes that we are in the window where control buffer is
506 (defun ediff-setup-control-buffer (ctl-buf)
507 "Set up window for control buffer."
508 (if (window-dedicated-p (selected-window))
509 (set-buffer ctl-buf) ; we are in control frame but just in case
510 (switch-to-buffer ctl-buf))
511 (let ((window-min-height 2))
513 (ediff-set-help-message)
514 (insert ediff-help-message)
515 (shrink-window-if-larger-than-buffer)
516 (or (ediff-multiframe-setup-p)
517 (ediff-indent-help-message))
518 (ediff-set-help-overlays)
520 (set-buffer-modified-p nil)
521 (ediff-refresh-mode-lines)
522 (setq ediff-control-window (selected-window))
523 (setq ediff-window-config-saved
524 (format "%S%S%S%S%S%S%S"
529 ediff-split-window-function
530 (ediff-multiframe-setup-p)
531 ediff-wide-display-p))
533 ;; In multiframe, toolbar is set in ediff-setup-control-frame
534 (if (not (ediff-multiframe-setup-p))
535 (ediff-make-bottom-toolbar)) ; this checks if toolbar is requested
536 (goto-char (point-min))
537 (skip-chars-forward ediff-whitespace)))
542 ;;; Commands for working with Ediff
544 (defun ediff-update-diffs ()
545 "Recompute difference regions in buffers A, B, and C.
546 Buffers are not synchronized with their respective files, so changes done
547 to these buffers are not saved at this point---the user can do this later,
550 (ediff-barf-if-not-control-buffer)
551 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
554 "Ancestor buffer will not be used. Recompute diffs anyway? ")))
555 (error "Recomputation of differences canceled"))
557 (let ((point-A (ediff-with-current-buffer ediff-buffer-A (point)))
558 ;;(point-B (ediff-with-current-buffer ediff-buffer-B (point)))
559 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
560 (buf-A-file-name (buffer-file-name ediff-buffer-A))
561 (buf-B-file-name (buffer-file-name ediff-buffer-B))
562 ;; (null ediff-buffer-C) is no problem, as we later check if
563 ;; ediff-buffer-C is alive
564 (buf-C-file-name (buffer-file-name ediff-buffer-C))
565 (overl-A (ediff-get-value-according-to-buffer-type
566 'A ediff-narrow-bounds))
567 (overl-B (ediff-get-value-according-to-buffer-type
568 'B ediff-narrow-bounds))
569 (overl-C (ediff-get-value-according-to-buffer-type
570 'C ediff-narrow-bounds))
571 beg-A end-A beg-B end-B beg-C end-C
572 file-A file-B file-C)
574 (if (stringp buf-A-file-name)
575 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
576 (if (stringp buf-B-file-name)
577 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
578 (if (stringp buf-C-file-name)
579 (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
581 (ediff-unselect-and-select-difference -1)
583 (setq beg-A (ediff-overlay-start overl-A)
584 beg-B (ediff-overlay-start overl-B)
585 beg-C (ediff-overlay-start overl-C)
586 end-A (ediff-overlay-end overl-A)
587 end-B (ediff-overlay-end overl-B)
588 end-C (ediff-overlay-end overl-C))
592 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
593 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
594 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
595 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
598 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
599 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
602 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
603 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
605 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
608 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
609 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
610 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
611 (ediff-clear-diff-vector
612 'ediff-difference-vector-Ancestor 'fine-diffs-also)
613 ;; let them garbage collect. we can't use the ancestor after recomputing
615 (setq ediff-difference-vector-Ancestor nil
616 ediff-ancestor-buffer nil
617 ediff-state-of-merge nil)
619 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
621 ;; In case of merge job, fool it into thinking that it is just doing
623 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
624 (ediff-3way-comparison-job ediff-3way-comparison-job)
625 (ediff-merge-job ediff-merge-job)
626 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
627 (ediff-job-name ediff-job-name))
629 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
630 ediff-3way-comparison-job t
632 ediff-merge-with-ancestor-job nil
633 ediff-job-name 'ediff-files3))
634 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
636 (setq ediff-number-of-differences (length ediff-difference-vector-A))
640 (delete-file file-C))
643 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
645 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
649 ;; Not bound to any key---to dangerous. A user can do it if necessary.
650 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
651 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
653 (ediff-barf-if-not-control-buffer)
654 (let ((bufA ediff-buffer-A)
655 (bufB ediff-buffer-B)
656 (bufC ediff-buffer-C)
657 (ctl-buf ediff-control-buffer)
658 (keep-variants ediff-keep-variants)
659 (ancestor-buf ediff-ancestor-buffer)
660 (ancestor-job ediff-merge-with-ancestor-job)
661 (merge ediff-merge-job)
662 (comparison ediff-3way-comparison-job))
663 (ediff-with-current-buffer bufA
664 (revert-buffer t noconfirm))
665 (ediff-with-current-buffer bufB
666 (revert-buffer t noconfirm))
667 ;; this should only be executed in a 3way comparison, not in merge
669 (ediff-with-current-buffer bufC
670 (revert-buffer t noconfirm)))
674 ;; the argument says whether to reverse the meaning of
675 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
677 (ediff-really-quit (not keep-variants))
680 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
681 (ediff-merge-buffers bufA bufB)))
682 (ediff-update-diffs))))
685 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
686 (defun ediff-recenter (&optional no-rehighlight)
687 "Bring the highlighted region of all buffers being compared into view.
688 Reestablish the default three-window display."
690 (ediff-barf-if-not-control-buffer)
691 (let (buffer-read-only)
692 (if (and (ediff-buffer-live-p ediff-buffer-A)
693 (ediff-buffer-live-p ediff-buffer-B)
694 (or (not ediff-3way-job)
695 (ediff-buffer-live-p ediff-buffer-C)))
697 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
698 (or (eq this-command 'ediff-quit)
699 (message ediff-KILLED-VITAL-BUFFER
703 ;; set visibility range appropriate to this invocation of Ediff.
704 (ediff-visible-region)
706 (if (and (ediff-window-display-p)
707 (symbolp this-command)
708 (symbolp last-command)
709 ;; Either one of the display-changing commands
710 (or (memq this-command
712 ediff-dir-action ediff-registry-action
714 ediff-toggle-wide-display ediff-toggle-multiframe))
715 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
716 ;; This avoids raising frames unnecessarily.
717 (and (memq this-command
718 '(ediff-next-difference
719 ediff-previous-difference
720 ediff-jump-to-difference
721 ediff-jump-to-difference-at-point))
722 (not (string-match "^ediff-" (symbol-name last-command)))
725 (if (window-live-p ediff-window-A)
726 (raise-frame (window-frame ediff-window-A)))
727 (if (window-live-p ediff-window-B)
728 (raise-frame (window-frame ediff-window-B)))
729 (if (window-live-p ediff-window-C)
730 (raise-frame (window-frame ediff-window-C)))))
731 (if (and (ediff-window-display-p)
732 (frame-live-p ediff-control-frame)
733 (not ediff-use-long-help-message)
734 (not (ediff-frame-iconified-p ediff-control-frame)))
735 (raise-frame ediff-control-frame))
737 ;; Redisplay whatever buffers are showing, if there is a selected difference
738 (let ((control-frame ediff-control-frame)
739 (control-buf ediff-control-buffer))
740 (if (and (ediff-buffer-live-p ediff-buffer-A)
741 (ediff-buffer-live-p ediff-buffer-B)
742 (or (not ediff-3way-job)
743 (ediff-buffer-live-p ediff-buffer-C)))
746 (ediff-select-difference ediff-current-difference))
748 (ediff-recenter-one-window 'A)
749 (ediff-recenter-one-window 'B)
751 (ediff-recenter-one-window 'C))
753 (ediff-with-current-buffer control-buf
754 (ediff-recenter-ancestor) ; check if ancestor is alive
756 (if (and (ediff-multiframe-setup-p)
757 (not ediff-use-long-help-message)
758 (not (ediff-frame-iconified-p ediff-control-frame)))
759 ;; never grab mouse on quit in this place
762 (eq this-command 'ediff-quit))))
765 (ediff-restore-highlighting)
766 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
769 ;; this function returns to the window it was called from
770 ;; (which was the control window)
771 (defun ediff-recenter-one-window (buf-type)
772 (if (ediff-valid-difference-p)
773 ;; context must be saved before switching to windows A/B/C
774 (let* ((ctl-wind (selected-window))
775 (shift (ediff-overlay-start
776 (ediff-get-value-according-to-buffer-type
777 buf-type ediff-narrow-bounds)))
778 (job-name ediff-job-name)
779 (control-buf ediff-control-buffer)
780 (window-name (ediff-get-symbol-from-alist
781 buf-type ediff-window-alist))
782 (window (if (window-live-p (symbol-value window-name))
783 (symbol-value window-name))))
785 (if (and window ediff-windows-job)
786 (set-window-start window shift))
789 (select-window window)
790 (ediff-deactivate-mark)
791 (ediff-position-region
792 (ediff-get-diff-posn buf-type 'beg nil control-buf)
793 (ediff-get-diff-posn buf-type 'end nil control-buf)
794 (ediff-get-diff-posn buf-type 'beg nil control-buf)
797 (select-window ctl-wind)
800 (defun ediff-recenter-ancestor ()
801 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
803 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
804 (ediff-valid-difference-p))
805 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
806 (ctl-wind (selected-window))
807 (job-name ediff-job-name)
808 (ctl-buf ediff-control-buffer))
809 (ediff-with-current-buffer ediff-ancestor-buffer
810 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
813 (select-window window)
814 (ediff-position-region
815 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
816 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
817 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
819 (select-window ctl-wind)
823 ;; This will have to be refined for 3way jobs
824 (defun ediff-toggle-split ()
825 "Toggle vertical/horizontal window split.
826 Does nothing if file-A and file-B are in different frames."
828 (ediff-barf-if-not-control-buffer)
829 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
830 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
831 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
832 (frame-A (if wind-A (window-frame wind-A)))
833 (frame-B (if wind-B (window-frame wind-B)))
834 (frame-C (if wind-C (window-frame wind-C))))
835 (if (or (eq frame-A frame-B)
836 (not (frame-live-p frame-A))
837 (not (frame-live-p frame-B))
838 (if ediff-3way-comparison-job
839 (or (not (frame-live-p frame-C))
840 (eq frame-A frame-C) (eq frame-B frame-C))))
841 (setq ediff-split-window-function
842 (if (eq ediff-split-window-function 'split-window-vertically)
843 'split-window-horizontally
844 'split-window-vertically))
845 (message "Buffers being compared are in different frames"))
846 (ediff-recenter 'no-rehighlight)))
848 (defun ediff-toggle-hilit ()
849 "Switch between highlighting using ASCII flags and highlighting using faces.
850 On a dumb terminal, switches between ASCII highlighting and no highlighting."
852 (ediff-barf-if-not-control-buffer)
853 (if (not (ediff-has-face-support-p))
854 (if (eq ediff-highlighting-style 'ascii)
856 (message "ASCII highlighting flags removed")
857 (ediff-unselect-and-select-difference ediff-current-difference
859 (setq ediff-highlighting-style 'off))
860 (ediff-unselect-and-select-difference ediff-current-difference
862 (ediff-unselect-and-select-difference ediff-current-difference
864 ;; cycle through highlighting
865 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
866 (message "Unhighlighting unselected difference regions")
867 (setq ediff-highlight-all-diffs nil))
869 (message "Highlighting with ASCII flags")
870 (setq ediff-use-faces nil))
872 (message "Re-highlighting all difference regions")
873 (setq ediff-use-faces t
874 ediff-highlight-all-diffs t)))
876 (if (and ediff-use-faces ediff-highlight-all-diffs)
877 (ediff-paint-background-regions)
878 (ediff-paint-background-regions 'unhighlight))
880 (ediff-unselect-and-select-difference
881 ediff-current-difference 'select-only))
885 (defun ediff-toggle-autorefine ()
886 "Toggle auto-refine mode."
888 (ediff-barf-if-not-control-buffer)
890 (error "No fine differences in this mode"))
891 (cond ((eq ediff-auto-refine 'nix)
892 (setq ediff-auto-refine 'on)
893 (ediff-make-fine-diffs ediff-current-difference 'noforce)
894 (message "Auto-refining is ON"))
895 ((eq ediff-auto-refine 'on)
896 (message "Auto-refining is OFF")
897 (setq ediff-auto-refine 'off))
899 (ediff-set-fine-diff-properties ediff-current-difference 'default)
900 (message "Refinements are HIDDEN")
901 (setq ediff-auto-refine 'nix))
904 (defun ediff-show-ancestor ()
905 "Show the ancestor buffer in a suitable window."
908 (or (ediff-buffer-live-p ediff-ancestor-buffer)
909 (if ediff-merge-with-ancestor-job
910 (error "Lost connection to ancestor buffer...sorry")
911 (error "Not merging with ancestor")))
913 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
914 (raise-frame (window-frame wind)))
915 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
917 (defun ediff-make-or-kill-fine-diffs (arg)
918 "Compute fine diffs. With negative prefix arg, kill fine diffs.
919 In both cases, operates on the currrent difference region."
921 (ediff-barf-if-not-control-buffer)
923 (ediff-clear-fine-differences ediff-current-difference))
924 ((and (numberp arg) (< arg 0))
925 (ediff-clear-fine-differences ediff-current-difference))
926 (t (ediff-make-fine-diffs))))
929 (defun ediff-toggle-help ()
930 "Toggle short/long help message."
932 (ediff-barf-if-not-control-buffer)
933 (let (buffer-read-only)
935 (setq ediff-use-long-help-message (not ediff-use-long-help-message))
936 (ediff-set-help-message))
937 ;; remember the icon status of the control frame when the user requested
938 ;; full control message
939 (if (and ediff-use-long-help-message (ediff-multiframe-setup-p))
940 (setq ediff-prefer-iconified-control-frame
941 (ediff-frame-iconified-p ediff-control-frame)))
943 (setq ediff-window-config-saved "") ; force redisplay
944 (ediff-recenter 'no-rehighlight))
947 ;; If BUF, this is the buffer to toggle, not current buffer.
948 (defun ediff-toggle-read-only (&optional buf)
949 "Toggle read-only in current buffer.
950 If buffer is under version control and locked, check it out first.
951 If optional argument BUF is specified, toggle read-only in that buffer instead
952 of the current buffer."
954 (ediff-barf-if-not-control-buffer)
955 (let ((ctl-buf (if (null buf) (current-buffer)))
956 (buf-type (ediff-char-to-buftype last-command-char)))
957 (or buf (ediff-recenter))
959 (setq buf (ediff-get-buffer buf-type)))
961 (ediff-with-current-buffer buf ; eval in buf A/B/C
962 (let* ((file (buffer-file-name buf))
963 (file-writable (and file
965 (file-writable-p file)))
966 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
967 ((ediff-file-checked-out-p file)
969 (file-writable 'toggle-read-only)
970 (t (key-binding "\C-x\C-q")))))
971 ;; If the file is checked in, make sure we don't make buffer modifiable
972 ;; without warning the user. The user can fool our checks by making the
973 ;; buffer non-RO without checking the file out. We regard this as a
975 (if (and (ediff-file-checked-in-p file)
976 ;; If ctl-buf is null, this means we called this
977 ;; non-interactively, in which case don't ask questions
979 (cond ((not buffer-read-only)
980 (setq toggle-ro-cmd 'toggle-read-only))
981 ((and (or (beep 1) t) ; always beep
984 "File %s is under version control. Check it out? "
985 (ediff-abbreviate-file-name file))))
986 ;; if we checked the file out, we should also change the
987 ;; original state of buffer-read-only to nil. If we don't
988 ;; do this, the mode line will show %%, since the file was
989 ;; RO before ediff started, so the user will think the file
991 (ediff-with-current-buffer ctl-buf
992 (ediff-change-saved-variable
993 'buffer-read-only nil buf-type)))
995 (setq toggle-ro-cmd 'toggle-read-only)
998 "Boy, this is risky! Don't modify this file...")
999 (sit-for 3)))) ; let the user see the warning
1000 (if (and toggle-ro-cmd
1001 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1003 (save-window-excursion
1004 (select-window (ediff-get-visible-buffer-window buf))
1005 (command-execute toggle-ro-cmd)))
1006 (error "Don't know how to toggle read-only in buffer %S" buf))
1008 ;; Check if we made the current buffer updatable, but its file is RO.
1009 ;; Signal a warning in this case.
1010 (if (and file (not buffer-read-only)
1011 (eq this-command 'ediff-toggle-read-only)
1012 (file-exists-p file)
1013 (not (file-writable-p file)))
1014 (message "Warning: file %s is read-only"
1015 (ediff-abbreviate-file-name file) (beep 1)))
1018 ;; checkout if visited file is checked in
1019 (defun ediff-maybe-checkout (buf)
1020 (let ((file (buffer-file-name buf))
1021 (checkout-function (key-binding "\C-x\C-q")))
1022 (if (and (ediff-file-checked-in-p file)
1026 "File %s is under version control. Check it out? "
1027 (ediff-abbreviate-file-name file))))
1028 (ediff-with-current-buffer buf
1029 (command-execute checkout-function)))))
1032 ;; This is a simple-minded check for whether a file is under version control.
1033 ;; If file,v exists but file doesn't, this file is considered to be not checked
1034 ;; in and not checked out for the purpose of patching (since patch won't be
1035 ;; able to read such a file anyway).
1036 ;; FILE is a string representing file name
1037 (defun ediff-file-under-version-control (file)
1038 (let* ((filedir (file-name-directory file))
1039 (file-nondir (file-name-nondirectory file))
1040 (trial (concat file-nondir ",v"))
1041 (full-trial (concat filedir trial))
1042 (full-rcs-trial (concat filedir "RCS/" trial)))
1044 (file-exists-p file)
1047 (file-exists-p full-trial)
1048 ;; in FAT FS, `file,v' and `file' may turn out to be the same!
1049 ;; don't be fooled by this!
1050 (not (equal (file-attributes file)
1051 (file-attributes full-trial))))
1052 ;; check if a version is in RCS/ directory
1053 (file-exists-p full-rcs-trial)))
1056 (defun ediff-file-checked-out-p (file)
1057 (and (ediff-file-under-version-control file)
1058 (file-writable-p file)))
1059 (defun ediff-file-checked-in-p (file)
1060 (and (ediff-file-under-version-control file)
1061 (not (file-writable-p file))))
1063 (defun ediff-swap-buffers ()
1064 "Rotate the display of buffers A, B, and C."
1066 (ediff-barf-if-not-control-buffer)
1067 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1068 (let ((buf ediff-buffer-A)
1069 (values ediff-buffer-values-orig-A)
1070 (diff-vec ediff-difference-vector-A)
1071 (hide-regexp ediff-regexp-hide-A)
1072 (focus-regexp ediff-regexp-focus-A)
1073 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1074 (overlay (if (ediff-has-face-support-p)
1075 ediff-current-diff-overlay-A)))
1076 (if ediff-3way-comparison-job
1078 (set-window-buffer ediff-window-A ediff-buffer-C)
1079 (set-window-buffer ediff-window-B ediff-buffer-A)
1080 (set-window-buffer ediff-window-C ediff-buffer-B)
1082 (set-window-buffer ediff-window-A ediff-buffer-B)
1083 (set-window-buffer ediff-window-B ediff-buffer-A))
1084 ;; swap diff buffers
1085 (if ediff-3way-comparison-job
1086 (setq ediff-buffer-A ediff-buffer-C
1087 ediff-buffer-C ediff-buffer-B
1089 (setq ediff-buffer-A ediff-buffer-B
1090 ediff-buffer-B buf))
1092 ;; swap saved buffer characteristics
1093 (if ediff-3way-comparison-job
1094 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1095 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1096 ediff-buffer-values-orig-B values)
1097 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1098 ediff-buffer-values-orig-B values))
1100 ;; swap diff vectors
1101 (if ediff-3way-comparison-job
1102 (setq ediff-difference-vector-A ediff-difference-vector-C
1103 ediff-difference-vector-C ediff-difference-vector-B
1104 ediff-difference-vector-B diff-vec)
1105 (setq ediff-difference-vector-A ediff-difference-vector-B
1106 ediff-difference-vector-B diff-vec))
1108 ;; swap hide/focus regexp
1109 (if ediff-3way-comparison-job
1110 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1111 ediff-regexp-hide-C ediff-regexp-hide-B
1112 ediff-regexp-hide-B hide-regexp
1113 ediff-regexp-focus-A ediff-regexp-focus-C
1114 ediff-regexp-focus-C ediff-regexp-focus-B
1115 ediff-regexp-focus-B focus-regexp)
1116 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1117 ediff-regexp-hide-B hide-regexp
1118 ediff-regexp-focus-A ediff-regexp-focus-B
1119 ediff-regexp-focus-B focus-regexp))
1121 ;; The following is needed for XEmacs, since there one can't move
1122 ;; overlay to another buffer. In Emacs, this swap is redundant.
1123 (if (ediff-has-face-support-p)
1124 (if ediff-3way-comparison-job
1125 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1126 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1127 ediff-current-diff-overlay-B overlay)
1128 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1129 ediff-current-diff-overlay-B overlay)))
1132 (setq ediff-wide-bounds
1133 (cond (ediff-3way-comparison-job
1134 (list (nth 2 ediff-wide-bounds)
1135 (nth 0 ediff-wide-bounds)
1136 (nth 1 ediff-wide-bounds)))
1138 (list (nth 1 ediff-wide-bounds)
1139 (nth 0 ediff-wide-bounds)
1140 (nth 2 ediff-wide-bounds)))
1142 (list (nth 1 ediff-wide-bounds)
1143 (nth 0 ediff-wide-bounds)))))
1144 ;; swap narrow bounds
1145 (setq ediff-narrow-bounds
1146 (cond (ediff-3way-comparison-job
1147 (list (nth 2 ediff-narrow-bounds)
1148 (nth 0 ediff-narrow-bounds)
1149 (nth 1 ediff-narrow-bounds)))
1151 (list (nth 1 ediff-narrow-bounds)
1152 (nth 0 ediff-narrow-bounds)
1153 (nth 2 ediff-narrow-bounds)))
1155 (list (nth 1 ediff-narrow-bounds)
1156 (nth 0 ediff-narrow-bounds)))))
1157 (if wide-visibility-p
1158 (setq ediff-visible-bounds ediff-wide-bounds)
1159 (setq ediff-visible-bounds ediff-narrow-bounds))
1162 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1163 (ediff-recenter 'no-rehighlight)
1167 (defun ediff-toggle-wide-display ()
1168 "Toggle wide/regular display.
1169 This is especially useful when comparing buffers side-by-side."
1171 (ediff-barf-if-not-control-buffer)
1172 (or (ediff-window-display-p)
1173 (error "%sEmacs is not running as a window application"
1174 (if ediff-emacs-p "" "X")))
1175 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1176 (let ((ctl-buf ediff-control-buffer))
1177 (setq ediff-wide-display-p (not ediff-wide-display-p))
1178 (if (not ediff-wide-display-p)
1179 (ediff-with-current-buffer ctl-buf
1180 (modify-frame-parameters
1181 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1182 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1183 ;; restore control buf, since ctl window may have been deleted
1185 (set-buffer ctl-buf)
1186 (setq ediff-wide-display-orig-parameters nil
1187 ediff-window-B nil) ; force update of window config
1188 (ediff-recenter 'no-rehighlight))
1189 (funcall ediff-make-wide-display-function)
1190 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1191 (ediff-with-current-buffer ctl-buf
1192 (setq ediff-window-B nil) ; force update of window config
1193 (ediff-recenter 'no-rehighlight)))))
1196 (defun ediff-toggle-multiframe ()
1197 "Switch from multiframe display to single-frame display and back.
1198 To change the default, set the variable `ediff-window-setup-function',
1201 (let (window-setup-func)
1202 (or (ediff-window-display-p)
1203 (error "%sEmacs is not running as a window application"
1204 (if ediff-emacs-p "" "X")))
1206 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1207 (setq window-setup-func 'ediff-setup-windows-plain))
1208 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1209 (if (ediff-in-control-buffer-p)
1210 (ediff-kill-bottom-toolbar))
1211 (setq window-setup-func 'ediff-setup-windows-multiframe)))
1214 (setq-default ediff-window-setup-function window-setup-func)
1215 ;; change in all active ediff sessions
1216 (mapcar (function (lambda(buf)
1217 (ediff-with-current-buffer buf
1218 (setq ediff-window-setup-function window-setup-func
1219 ediff-window-B nil))))
1220 ediff-session-registry)
1221 (if (ediff-in-control-buffer-p)
1222 (ediff-recenter 'no-rehighlight))))
1226 (defun ediff-toggle-use-toolbar ()
1227 "Enable or disable Ediff toolbar.
1228 Works only in versions of Emacs that support toolbars.
1229 To change the default, set the variable `ediff-use-toolbar-p', which see."
1231 (if (featurep 'ediff-tbar)
1233 (or (ediff-window-display-p)
1234 (error "%sEmacs is not running as a window application"
1235 (if ediff-emacs-p "" "X")))
1236 (if (ediff-use-toolbar-p)
1237 (ediff-kill-bottom-toolbar))
1238 ;; do this only after killing the toolbar
1239 (setq ediff-use-toolbar-p (not ediff-use-toolbar-p))
1241 (mapcar (function (lambda(buf)
1242 (ediff-with-current-buffer buf
1244 (setq ediff-window-config-saved "")
1246 ediff-session-registry)
1247 (if (ediff-in-control-buffer-p)
1248 (ediff-recenter 'no-rehighlight)))))
1251 ;; if was using toolbar, kill it
1252 (defun ediff-kill-bottom-toolbar ()
1253 ;; Using ctl-buffer or ediff-control-window for LOCALE does not
1254 ;; work properly in XEmacs 19.14: we have to use
1256 ;; The problem with this is that any previous bottom-toolbar
1257 ;; will not re-appear after our cleanup here. Is there a way
1258 ;; to do "push" and "pop" toolbars ? --marcpa
1259 (if (ediff-use-toolbar-p)
1261 (set-specifier bottom-toolbar (list (selected-frame) nil))
1262 (set-specifier bottom-toolbar-visible-p (list (selected-frame) nil)))))
1264 ;; If wants to use toolbar, make it.
1265 ;; If not, zero the toolbar for XEmacs.
1266 ;; Do nothing for Emacs.
1267 (defun ediff-make-bottom-toolbar (&optional frame)
1268 (if (ediff-window-display-p)
1270 (setq frame (or frame (selected-frame)))
1271 (cond ((ediff-use-toolbar-p) ; this checks for XEmacs
1274 (list frame (if (ediff-3way-comparison-job)
1275 ediff-toolbar-3way ediff-toolbar)))
1276 (set-specifier bottom-toolbar-visible-p (list frame t))
1277 (set-specifier bottom-toolbar-height
1278 (list frame ediff-toolbar-height)))
1280 (set-specifier bottom-toolbar-height (list frame 0)))
1286 (defun ediff-toggle-show-clashes-only ()
1287 "Toggle the mode where only the regions where both buffers differ with the ancestor are shown."
1289 (ediff-barf-if-not-control-buffer)
1290 (if (not ediff-merge-with-ancestor-job)
1291 (error "This command makes sense only when merging with an ancestor"))
1292 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1293 (if ediff-show-clashes-only
1294 (message "Focus on regions where both buffers differ from the ancestor")
1295 (message "Canceling focus on regions where changes clash")))
1297 ;; Widening/narrowing
1299 (defun ediff-toggle-narrow-region ()
1300 "Toggle narrowing in buffers A, B, and C.
1301 Used in ediff-windows/regions only."
1303 (if (eq ediff-buffer-A ediff-buffer-B)
1304 (error ediff-NO-DIFFERENCES))
1305 (if (eq ediff-visible-bounds ediff-wide-bounds)
1306 (setq ediff-visible-bounds ediff-narrow-bounds)
1307 (setq ediff-visible-bounds ediff-wide-bounds))
1308 (ediff-recenter 'no-rehighlight))
1310 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1311 ;; ediff-wide-bounds, then this actually widens.
1312 ;; This function does nothing if job-name is not
1313 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1314 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1315 ;; to two different regions in one buffer.
1316 (defun ediff-visible-region ()
1317 (if (or (eq ediff-buffer-A ediff-buffer-B)
1318 (eq ediff-buffer-A ediff-buffer-C)
1319 (eq ediff-buffer-C ediff-buffer-B))
1321 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1322 ;; Otherwise, always use full range.
1323 (if (not ediff-narrow-job)
1324 (setq ediff-visible-bounds ediff-wide-bounds))
1325 (let ((overl-A (ediff-get-value-according-to-buffer-type
1326 'A ediff-visible-bounds))
1327 (overl-B (ediff-get-value-according-to-buffer-type
1328 'B ediff-visible-bounds))
1329 (overl-C (ediff-get-value-according-to-buffer-type
1330 'C ediff-visible-bounds))
1332 (ediff-with-current-buffer ediff-buffer-A
1334 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A)))
1335 (ediff-with-current-buffer ediff-buffer-B
1337 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B)))
1340 (ediff-with-current-buffer ediff-buffer-C
1342 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1346 ;; Window scrolling operations
1348 ;; Performs some operation on the two file windows (if they are showing).
1349 ;; Traps all errors on the operation in windows A/B/C.
1350 ;; Usually, errors come from scrolling off the
1351 ;; beginning or end of the buffer, and this gives error messages.
1352 (defun ediff-operate-on-windows (operation arg)
1354 ;; make sure windows aren't dead
1355 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1356 (ediff-recenter 'no-rehighlight))
1357 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1358 (ediff-buffer-live-p ediff-buffer-B)
1359 (or (not ediff-3way-job) ediff-buffer-C)
1361 (error ediff-KILLED-VITAL-BUFFER))
1363 (let* ((wind (selected-window))
1364 (wind-A ediff-window-A)
1365 (wind-B ediff-window-B)
1366 (wind-C ediff-window-C)
1367 (coefA (ediff-get-region-size-coefficient 'A operation))
1368 (coefB (ediff-get-region-size-coefficient 'B operation))
1369 (three-way ediff-3way-job)
1370 (coefC (if three-way
1371 (ediff-get-region-size-coefficient 'C operation))))
1373 (select-window wind-A)
1375 (funcall operation (round (* coefA arg)))
1377 (select-window wind-B)
1379 (funcall operation (round (* coefB arg)))
1383 (select-window wind-C)
1385 (funcall operation (round (* coefC arg)))
1387 (select-window wind)))
1389 (defun ediff-scroll-vertically (&optional arg)
1390 "Vertically scroll buffers A, B \(and C if appropriate\).
1391 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1392 the one half of the height of window-A."
1394 (ediff-barf-if-not-control-buffer)
1396 ;; make sure windows aren't dead
1397 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1398 (ediff-recenter 'no-rehighlight))
1399 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1400 (ediff-buffer-live-p ediff-buffer-B)
1401 (or (not ediff-3way-job)
1402 (ediff-buffer-live-p ediff-buffer-C))
1404 (error ediff-KILLED-VITAL-BUFFER))
1406 (ediff-operate-on-windows
1407 (if (memq last-command-char '(?v ?\C-v))
1410 ;; calculate argument to scroll-up/down
1411 ;; if there is an explicit argument
1412 (if (and arg (not (equal arg '-)))
1414 (prefix-numeric-value arg)
1415 ;; if not, see if we can determine a default amount (the window height)
1416 (let (default-amount)
1417 (setq default-amount
1418 (- (/ (min (window-height ediff-window-A)
1419 (window-height ediff-window-B)
1421 (window-height ediff-window-C)
1422 500)) ; some large number
1424 1 next-screen-context-lines))
1427 ;; C-u as argument means half of default amount
1428 (/ default-amount 2)
1429 ;; no argument means default amount
1433 (defun ediff-scroll-horizontally (&optional arg)
1434 "Horizontally scroll buffers A, B \(and C if appropriate\).
1435 If an argument is given, that is how many columns are scrolled, else nearly
1436 the width of the A/B/C windows."
1438 (ediff-barf-if-not-control-buffer)
1440 ;; make sure windows aren't dead
1441 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1442 (ediff-recenter 'no-rehighlight))
1443 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1444 (ediff-buffer-live-p ediff-buffer-B)
1445 (or (not ediff-3way-job)
1446 (ediff-buffer-live-p ediff-buffer-C))
1448 (error ediff-KILLED-VITAL-BUFFER))
1450 (ediff-operate-on-windows
1451 (if (= last-command-char ?<)
1454 ;; calculate argument to scroll-left/right
1455 ;; if there is an explicit argument
1456 (if (and arg (not (equal arg '-)))
1458 (prefix-numeric-value arg)
1459 ;; if not, see if we can determine a default amount
1460 ;; (half the window width)
1461 (if (null ediff-control-window)
1462 ;; no control window, use nil
1464 (let ((default-amount
1465 (- (/ (min (window-width ediff-window-A)
1466 (window-width ediff-window-B)
1467 (if ediff-3way-comparison-job
1468 (window-width ediff-window-C)
1469 500) ; some large number
1475 ;; C-u as argument means half of default amount
1476 (/ default-amount 2)
1477 ;; no argument means default amount
1478 default-amount))))))
1481 ;;BEG, END show the region to be positioned.
1482 ;;JOB-NAME holds ediff-job-name. The ediff-windows job positions regions
1484 (defun ediff-position-region (beg end pos job-name)
1485 (if (> end (point-max))
1486 (setq end (point-max)))
1487 (if ediff-windows-job
1488 (if (pos-visible-in-window-p end)
1489 () ; do nothing, wind is already positioned
1490 ;; at this point, windows are positioned at the beginning of the
1491 ;; file regions (not diff-regions) being compared.
1493 (move-to-window-line (- (window-height) 2))
1494 (let ((amount (+ 2 (count-lines (point) end))))
1495 (scroll-up amount))))
1496 (set-window-start (selected-window) beg)
1497 (if (pos-visible-in-window-p end)
1498 ;; Determine the number of lines that the region occupies
1501 (while ( and (> end (progn
1502 (move-to-window-line lines)
1504 ;; `end' may be beyond the window bottom, so check
1505 ;; that we are making progress
1506 (< prev-point (point)))
1507 (setq prev-point (point))
1508 (setq lines (1+ lines)))
1509 ;; And position the beginning on the right line
1511 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1519 ;; get number of lines from window start to region end
1520 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1521 (or n (setq n ediff-current-difference))
1522 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1523 (ediff-with-current-buffer ctl-buf
1524 (let* ((buf (ediff-get-buffer buf-type))
1525 (wind (eval (ediff-get-symbol-from-alist
1526 buf-type ediff-window-alist)))
1527 (beg (window-start wind))
1528 (end (ediff-get-diff-posn buf-type 'end))
1530 (ediff-with-current-buffer buf
1532 (setq lines (count-lines beg end))
1537 ;; get number of lines from window end to region start
1538 (defun ediff-get-lines-to-region-start (buf-type &optional n ctl-buf)
1539 (or n (setq n ediff-current-difference))
1540 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1541 (ediff-with-current-buffer ctl-buf
1542 (let* ((buf (ediff-get-buffer buf-type))
1543 (wind (eval (ediff-get-symbol-from-alist
1544 buf-type ediff-window-alist)))
1545 (end (window-end wind))
1546 (beg (ediff-get-diff-posn buf-type 'beg)))
1547 (ediff-with-current-buffer buf
1548 (if (< beg end) (count-lines beg end) 0))
1552 ;; region size coefficient is a coefficient by which to adjust scrolling
1553 ;; up/down of the window displaying buffer of type BUFTYPE.
1554 ;; The purpose of this coefficient is to make the windows scroll in sync, so
1555 ;; that it won't happen that one diff region is scrolled off while the other is
1558 ;; If the difference region is invalid, the coefficient is 1
1559 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1560 (ediff-with-current-buffer (or ctl-buf ediff-control-buffer)
1561 (if (ediff-valid-difference-p n)
1562 (let* ((func (cond ((eq op 'scroll-down)
1563 'ediff-get-lines-to-region-start)
1565 'ediff-get-lines-to-region-end)
1566 (t '(lambda (a b c) 0))))
1567 (max-lines (max (funcall func 'A n ctl-buf)
1568 (funcall func 'B n ctl-buf)
1569 (if (ediff-buffer-live-p ediff-buffer-C)
1570 (funcall func 'C n ctl-buf)
1572 ;; this covers the horizontal coefficient as well:
1573 ;; if max-lines = 0 then coef = 1
1575 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1581 (defun ediff-next-difference (&optional arg)
1582 "Advance to the next difference.
1583 With a prefix argument, go forward that many differences."
1585 (ediff-barf-if-not-control-buffer)
1586 (if (< ediff-current-difference ediff-number-of-differences)
1587 (let ((n (min ediff-number-of-differences
1588 (+ ediff-current-difference arg)))
1591 (ediff-visible-region)
1592 (or (>= n ediff-number-of-differences)
1593 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1594 (ediff-install-fine-diff-if-necessary n))
1595 (while (and (< n ediff-number-of-differences)
1599 ;; skip clashes, if necessary
1600 (and ediff-show-clashes-only
1601 (string-match "prefer"
1602 (or (ediff-get-state-of-merge n) "")))
1603 ;; skip difference regions that differ in white space
1604 (and ediff-ignore-similar-regions
1605 (eq (ediff-no-fine-diffs-p n) t))))
1607 (if (= 0 (mod n 20))
1608 (message "Skipped over region %d and counting ..." n))
1609 (or (>= n ediff-number-of-differences)
1610 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1611 (ediff-install-fine-diff-if-necessary n))
1614 (ediff-unselect-and-select-difference n)
1616 (ediff-visible-region)
1617 (error "At end of the difference list")))
1619 (defun ediff-previous-difference (&optional arg)
1620 "Go to the previous difference.
1621 With a prefix argument, go back that many differences."
1623 (ediff-barf-if-not-control-buffer)
1624 (if (> ediff-current-difference -1)
1625 (let ((n (max -1 (- ediff-current-difference arg)))
1628 (ediff-visible-region)
1630 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1631 (ediff-install-fine-diff-if-necessary n))
1632 (while (and (> n -1)
1636 ;; skip clashes, if necessary
1637 (and ediff-show-clashes-only
1638 (string-match "prefer"
1639 (or (ediff-get-state-of-merge n) "")))
1640 ;; skip difference regions that differ in white space
1641 (and ediff-ignore-similar-regions
1642 (eq (ediff-no-fine-diffs-p n) t))))
1643 (if (= 0 (mod (1+ n) 20))
1644 (message "Skipped over region %d and counting ..." (1+ n)))
1647 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1648 (ediff-install-fine-diff-if-necessary n))
1651 (ediff-unselect-and-select-difference n)
1653 (ediff-visible-region)
1654 (error "At beginning of the difference list")))
1656 ;; The diff number is as perceived by the user (i.e., 1+ the internal
1658 (defun ediff-jump-to-difference (difference-number)
1659 "Go to the difference specified as a prefix argument.
1660 If the prefix is negative, count differences from the end."
1662 (ediff-barf-if-not-control-buffer)
1663 (setq difference-number
1664 (cond ((< difference-number 0)
1665 (+ ediff-number-of-differences difference-number))
1666 ((> difference-number 0) (1- difference-number))
1668 ;; -1 is allowed by ediff-unselect-and-select-difference --- it is the
1669 ;; position before the first one.
1670 (if (and (>= difference-number -1)
1671 (<= difference-number ediff-number-of-differences))
1672 (ediff-unselect-and-select-difference difference-number)
1673 (error ediff-BAD-DIFF-NUMBER
1674 this-command (1+ difference-number) ediff-number-of-differences)))
1676 (defun ediff-jump-to-difference-at-point (arg)
1677 "Go to difference closest to the point in buffer A, B, or C.
1678 The buffer depends on last command character \(a, b, or c\) that invoked this
1679 command. For instance, if the command was `ga' then the point value in buffer A
1681 With a prefix argument, synchronize all files around the current point position
1682 in the specified buffer."
1684 (ediff-barf-if-not-control-buffer)
1685 (let* ((buf-type (ediff-char-to-buftype last-command-char))
1686 (buffer (ediff-get-buffer buf-type))
1687 (pt (ediff-with-current-buffer buffer (point)))
1688 (diff-no (ediff-diff-at-point buf-type nil (if arg 'after)))
1689 (past-last-diff (< ediff-number-of-differences diff-no))
1690 (beg (if past-last-diff
1691 (ediff-with-current-buffer buffer (point-max))
1692 (ediff-get-diff-posn buf-type 'beg (1- diff-no))))
1693 ctl-wind wind-A wind-B wind-C
1696 (ediff-jump-to-difference -1)
1697 (ediff-jump-to-difference diff-no))
1698 (setq ctl-wind (selected-window)
1699 wind-A ediff-window-A
1700 wind-B ediff-window-B
1701 wind-C ediff-window-C)
1704 (ediff-with-current-buffer buffer
1705 (setq shift (- beg pt)))
1706 (select-window wind-A)
1707 (if past-last-diff (goto-char (point-max)))
1709 (backward-char shift) ; noerror, if beginning of buffer
1712 (select-window wind-B)
1713 (if past-last-diff (goto-char (point-max)))
1715 (backward-char shift) ; noerror, if beginning of buffer
1718 (if (window-live-p wind-C)
1720 (select-window wind-C)
1721 (if past-last-diff (goto-char (point-max)))
1723 (backward-char shift) ; noerror, if beginning of buffer
1727 (select-window ctl-wind)
1732 ;; find region most related to the current point position (or POS, if given)
1733 ;; returns diff number as seen by the user (i.e., 1+ the internal
1735 ;; The optional argument WHICH-DIFF can be `after' or `before'. If `after',
1736 ;; find the diff after the point. If `before', find the diff before the
1737 ;; point. If the point is inside a diff, return that diff.
1738 (defun ediff-diff-at-point (buf-type &optional pos which-diff)
1739 (let ((buffer (ediff-get-buffer buf-type))
1740 (ctl-buffer ediff-control-buffer)
1741 (max-dif-num (1- ediff-number-of-differences))
1748 (ediff-with-current-buffer buffer
1749 (setq pos (or pos (point)))
1750 (while (and (or (< pos prev-beg) (> pos beg))
1751 (< diff-no max-dif-num))
1752 (setq diff-no (1+ diff-no))
1755 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1756 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1759 ;; boost diff-no by 1, if past the last diff region
1760 (if (and (memq which-diff '(after before))
1761 (> pos beg) (= diff-no max-dif-num))
1762 (setq diff-no (1+ diff-no)))
1764 (cond ((eq which-diff 'after) (1+ diff-no))
1765 ((eq which-diff 'before) diff-no)
1766 ((< (abs (count-lines pos (max 1 prev-end)))
1767 (abs (count-lines pos (max 1 beg))))
1768 diff-no) ; choose prev difference
1770 (1+ diff-no))) ; choose next difference
1776 (defun ediff-diff-to-diff (arg &optional keys)
1777 "Copy buffer-X'th difference region to buffer Y \(X,Y are A, B, or C\).
1778 If numerical prefix argument, copy the difference specified in the arg.
1779 Otherwise, copy the difference given by `ediff-current-difference'.
1780 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1781 `ac', etc., which is used to determine the types of buffers to be used for
1782 copying difference regions. The first character in the sequence specifies
1783 the source buffer and the second specifies the target.
1785 If the second optional argument, a 2-character string, is given, use it to
1786 determine the source and the target buffers instead of the command keys."
1788 (ediff-barf-if-not-control-buffer)
1789 (or keys (setq keys (this-command-keys)))
1790 (if (eq arg '-) (setq arg -1)) ; translate neg arg to -1
1791 (if (numberp arg) (ediff-jump-to-difference arg))
1793 (let* ((key1 (aref keys 0))
1794 (key2 (aref keys 1))
1795 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1796 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2))
1798 (ediff-copy-diff ediff-current-difference
1799 (ediff-char-to-buftype char1)
1800 (ediff-char-to-buftype char2))
1801 ;; recenter with rehighlighting, but no messages
1804 (defun ediff-copy-A-to-B (arg)
1805 "Copy ARGth difference region from buffer A to B.
1806 ARG is a prefix argument. If nil, copy the current difference region."
1808 (ediff-diff-to-diff arg "ab"))
1810 (defun ediff-copy-B-to-A (arg)
1811 "Copy ARGth difference region from buffer B to A.
1812 ARG is a prefix argument. If nil, copy the current difference region."
1814 (ediff-diff-to-diff arg "ba"))
1816 (defun ediff-copy-A-to-C (arg)
1817 "Copy ARGth difference region from buffer A to buffer C.
1818 ARG is a prefix argument. If nil, copy the current difference region."
1820 (ediff-diff-to-diff arg "ac"))
1822 (defun ediff-copy-B-to-C (arg)
1823 "Copy ARGth difference region from buffer B to buffer C.
1824 ARG is a prefix argument. If nil, copy the current difference region."
1826 (ediff-diff-to-diff arg "bc"))
1828 (defun ediff-copy-C-to-B (arg)
1829 "Copy ARGth difference region from buffer C to B.
1830 ARG is a prefix argument. If nil, copy the current difference region."
1832 (ediff-diff-to-diff arg "cb"))
1834 (defun ediff-copy-C-to-A (arg)
1835 "Copy ARGth difference region from buffer C to A.
1836 ARG is a prefix argument. If nil, copy the current difference region."
1838 (ediff-diff-to-diff arg "ca"))
1842 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1843 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1844 ;; target diff. This is used in merging, when constructing the merged
1846 (defun ediff-copy-diff (n from-buf-type to-buf-type
1847 &optional batch-invocation reg-to-copy)
1848 (let* ((to-buf (ediff-get-buffer to-buf-type))
1849 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1850 (ctrl-buf ediff-control-buffer)
1852 (three-way ediff-3way-job)
1855 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1857 (setq reg-to-delete-beg
1858 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1859 (setq reg-to-delete-end
1860 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1863 (setq from-buf-type nil)
1864 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1866 (setq reg-to-delete (ediff-get-region-contents
1867 n to-buf-type ctrl-buf
1868 reg-to-delete-beg reg-to-delete-end))
1870 (if (string= reg-to-delete reg-to-copy)
1871 (setq saved-p nil) ; don't copy identical buffers
1873 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1874 (condition-case conds
1876 (ediff-with-current-buffer to-buf
1877 ;; to prevent flags from interfering if buffer is writable
1878 (let ((inhibit-read-only (null buffer-read-only)))
1880 (goto-char reg-to-delete-end)
1881 (insert reg-to-copy)
1883 (if (> reg-to-delete-end reg-to-delete-beg)
1884 (kill-region reg-to-delete-beg reg-to-delete-end))
1886 (or batch-invocation
1889 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1890 (error (message "ediff-copy-diff: %s %s"
1892 (mapconcat 'prin1-to-string (cdr conds) " "))
1894 (sit-for 2) ; let the user see the error msg
1899 ;; adjust state of difference in case 3-way and diff was copied ok
1900 (if (and saved-p three-way)
1901 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
1903 (if batch-invocation
1904 (ediff-clear-fine-differences n)
1905 ;; If diff3 job, we should recompute fine diffs so we clear them
1906 ;; before reinserting flags (and thus before ediff-recenter).
1907 (if (and saved-p three-way)
1908 (ediff-clear-fine-differences n))
1910 (ediff-refresh-mode-lines)
1912 ;; For diff2 jobs, don't recompute fine diffs, since we know there
1913 ;; aren't any. So we clear diffs after ediff-recenter.
1914 (if (and saved-p (not three-way))
1915 (ediff-clear-fine-differences n))
1916 ;; Make sure that the message about saving and how to restore is seen
1921 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
1922 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
1923 ;; is the region to save. It is redundant here, but is passed anyway, for
1925 (defun ediff-save-diff-region (n buf-type reg)
1926 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1927 (buf (ediff-get-buffer buf-type))
1928 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1930 (if this-buf-n-th-diff-saved
1931 ;; either nothing saved for n-th diff and buffer or we OK'ed
1933 (setcdr this-buf-n-th-diff-saved reg)
1934 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
1935 (nconc n-th-diff-saved (list (cons buf reg)))
1936 (setq ediff-killed-diffs-alist ;; create record for n-th diff
1937 (cons (list n (cons buf reg))
1938 ediff-killed-diffs-alist))))
1939 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
1942 "" (downcase (symbol-name buf-type))))
1945 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
1946 (defun ediff-test-save-region (n buf-type)
1947 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1948 (buf (ediff-get-buffer buf-type))
1949 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1951 (if this-buf-n-th-diff-saved
1954 "You've previously copied diff region %d to buffer %S. Confirm "
1960 (defun ediff-pop-diff (n buf-type)
1961 "Pop last killed Nth diff region from buffer BUF-TYPE."
1962 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
1963 (buf (ediff-get-buffer buf-type))
1964 (saved-rec (assoc buf (cdr n-th-record)))
1965 (three-way ediff-3way-job)
1966 (ctl-buf ediff-control-buffer)
1968 saved-diff reg-beg reg-end recovered)
1971 (setq saved-diff (cdr saved-rec))
1972 (if (> ediff-number-of-differences 0)
1973 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
1974 (error ediff-NO-DIFFERENCES)))
1976 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
1977 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
1979 (condition-case conds
1980 (ediff-with-current-buffer buf
1981 (let ((inhibit-read-only (null buffer-read-only)))
1986 (if (> reg-end reg-beg)
1987 (kill-region reg-beg reg-end))
1991 (error (message "ediff-pop-diff: %s %s"
1993 (mapconcat 'prin1-to-string (cdr conds) " "))
1996 ;; Clearing fine diffs is necessary for
1997 ;; ediff-unselect-and-select-difference to properly recompute them. We
1998 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
1999 ;; have modified diff regions after copying and, thus, may have recomputed
2002 (ediff-clear-fine-differences n))
2004 ;; adjust state of difference
2005 (if (and three-way recovered)
2006 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
2008 (ediff-refresh-mode-lines)
2012 (setq n-th-record (delq saved-rec n-th-record))
2013 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
2017 (defun ediff-restore-diff (arg &optional key)
2018 "Restore ARGth diff from `ediff-killed-diffs-alist'.
2019 ARG is a prefix argument. If ARG is nil, restore the current-difference.
2020 If the second optional argument, a character, is given, use it to
2021 determine the target buffer instead of last-command-char"
2023 (ediff-barf-if-not-control-buffer)
2025 (ediff-jump-to-difference arg))
2026 (ediff-pop-diff ediff-current-difference
2027 (ediff-char-to-buftype (or key last-command-char)))
2028 ;; recenter with rehighlighting, but no messages
2029 (let (ediff-verbose-p)
2032 (defun ediff-restore-diff-in-merge-buffer (arg)
2033 "Restore ARGth diff in the merge buffer.
2034 ARG is a prefix argument. If nil, restore the current diff."
2036 (ediff-restore-diff arg ?c))
2039 (defun ediff-toggle-regexp-match ()
2040 "Toggle between focusing and hiding of difference regions that match
2041 a regular expression typed in by the user."
2043 (ediff-barf-if-not-control-buffer)
2047 msg-connective alt-msg-connective alt-connective)
2049 ((or (and (eq ediff-skip-diff-region-function
2050 ediff-focus-on-regexp-matches-function)
2051 (eq last-command-char ?f))
2052 (and (eq ediff-skip-diff-region-function
2053 ediff-hide-regexp-matches-function)
2054 (eq last-command-char ?h)))
2055 (message "Selective browsing by regexp turned off")
2056 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
2057 ((eq last-command-char ?h)
2058 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
2062 "Ignore A-regions matching this regexp (default \"%s\"): "
2063 ediff-regexp-hide-A))
2067 "Ignore B-regions matching this regexp (default \"%s\"): "
2068 ediff-regexp-hide-B)))
2069 (if ediff-3way-comparison-job
2073 "Ignore C-regions matching this regexp (default \"%s\"): "
2074 ediff-regexp-hide-C))))
2075 (if (eq ediff-hide-regexp-connective 'and)
2076 (setq msg-connective "BOTH"
2077 alt-msg-connective "ONE OF"
2079 (setq msg-connective "ONE OF"
2080 alt-msg-connective "BOTH"
2081 alt-connective 'and))
2084 "Ignore regions that match %s regexps, OK? "
2085 msg-connective alt-msg-connective))
2086 (message "Will ignore regions that match %s regexps" msg-connective)
2087 (setq ediff-hide-regexp-connective alt-connective)
2088 (message "Will ignore regions that match %s regexps"
2089 alt-msg-connective))
2091 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
2092 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
2093 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
2095 ((eq last-command-char ?f)
2096 (setq ediff-skip-diff-region-function
2097 ediff-focus-on-regexp-matches-function
2101 "Focus on A-regions matching this regexp (default \"%s\"): "
2102 ediff-regexp-focus-A))
2106 "Focus on B-regions matching this regexp (default \"%s\"): "
2107 ediff-regexp-focus-B)))
2108 (if ediff-3way-comparison-job
2112 "Focus on C-regions matching this regexp (default \"%s\"): "
2113 ediff-regexp-focus-C))))
2114 (if (eq ediff-focus-regexp-connective 'and)
2115 (setq msg-connective "BOTH"
2116 alt-msg-connective "ONE OF"
2118 (setq msg-connective "ONE OF"
2119 alt-msg-connective "BOTH"
2120 alt-connective 'and))
2123 "Focus on regions that match %s regexps, OK? "
2124 msg-connective alt-msg-connective))
2125 (message "Will focus on regions that match %s regexps"
2127 (setq ediff-focus-regexp-connective alt-connective)
2128 (message "Will focus on regions that match %s regexps"
2129 alt-msg-connective))
2131 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
2132 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
2133 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
2135 (defun ediff-toggle-skip-similar ()
2137 (ediff-barf-if-not-control-buffer)
2138 (if (not (eq ediff-auto-refine 'on))
2140 "Can't skip over whitespace regions: first turn auto-refining on"))
2141 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
2142 (if ediff-ignore-similar-regions
2144 "Skipping regions that differ only in white space & line breaks")
2145 (message "Skipping over white-space differences turned off")))
2147 (defun ediff-focus-on-regexp-matches (n)
2148 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
2149 Regions to be ignored according to this function are those where
2150 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
2151 doesn't match `ediff-regexp-focus-B'.
2152 This function returns nil if the region number N (specified as
2153 an argument) is not to be ignored and t if region N is to be ignored.
2155 N is a region number used by Ediff internally. It is 1 less
2156 the number seen by the user."
2157 (if (ediff-valid-difference-p n)
2158 (let* ((ctl-buf ediff-control-buffer)
2159 (regex-A ediff-regexp-focus-A)
2160 (regex-B ediff-regexp-focus-B)
2161 (regex-C ediff-regexp-focus-C)
2162 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2165 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2166 (ediff-get-diff-posn 'A 'end n ctl-buf))
2167 (goto-char (point-min))
2168 (re-search-forward regex-A nil t))))
2169 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2172 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2173 (ediff-get-diff-posn 'B 'end n ctl-buf))
2174 (re-search-forward regex-B nil t))))
2175 (reg-C-match (if ediff-3way-comparison-job
2176 (ediff-with-current-buffer ediff-buffer-C
2179 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2180 (ediff-get-diff-posn 'C 'end n ctl-buf))
2181 (re-search-forward regex-C nil t))))))
2182 (not (eval (if ediff-3way-comparison-job
2183 (list ediff-focus-regexp-connective
2184 reg-A-match reg-B-match reg-C-match)
2185 (list ediff-focus-regexp-connective
2186 reg-A-match reg-B-match))))
2189 (defun ediff-hide-regexp-matches (n)
2190 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2191 Regions to be ignored are those where buf A region matches
2192 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2193 This function returns nil if the region number N (specified as
2194 an argument) is not to be ignored and t if region N is to be ignored.
2196 N is a region number used by Ediff internally. It is 1 less
2197 the number seen by the user."
2198 (if (ediff-valid-difference-p n)
2199 (let* ((ctl-buf ediff-control-buffer)
2200 (regex-A ediff-regexp-hide-A)
2201 (regex-B ediff-regexp-hide-B)
2202 (regex-C ediff-regexp-hide-C)
2203 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2206 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2207 (ediff-get-diff-posn 'A 'end n ctl-buf))
2208 (goto-char (point-min))
2209 (re-search-forward regex-A nil t))))
2210 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2213 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2214 (ediff-get-diff-posn 'B 'end n ctl-buf))
2215 (goto-char (point-min))
2216 (re-search-forward regex-B nil t))))
2217 (reg-C-match (if ediff-3way-comparison-job
2218 (ediff-with-current-buffer ediff-buffer-C
2221 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2222 (ediff-get-diff-posn 'C 'end n ctl-buf))
2223 (goto-char (point-min))
2224 (re-search-forward regex-C nil t))))))
2225 (eval (if ediff-3way-comparison-job
2226 (list ediff-hide-regexp-connective
2227 reg-A-match reg-B-match reg-C-match)
2228 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2233 ;;; Quitting, suspending, etc.
2235 (defun ediff-quit (reverse-default-keep-variants)
2236 "Finish an Ediff session and exit Ediff.
2237 Unselects the selected difference, if any, restores the read-only and modified
2238 flags of the compared file buffers, kills Ediff buffers for this session
2239 \(but not buffers A, B, C\).
2241 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2242 containing the variants should be removed \(if they haven't been modified\).
2243 If it is t, they will be preserved unconditionally. A prefix argument,
2244 temporarily reverses the meaning of this variable."
2246 (ediff-barf-if-not-control-buffer)
2247 (let ((ctl-buf (current-buffer)))
2248 (if (y-or-n-p (format "Quit this Ediff session%s? "
2249 (if (ediff-buffer-live-p ediff-meta-buffer)
2250 " & show containing session group" "")))
2253 (set-buffer ctl-buf)
2254 (ediff-really-quit reverse-default-keep-variants))
2258 ;; Perform the quit operations.
2259 (defun ediff-really-quit (reverse-default-keep-variants)
2260 (ediff-unhighlight-diffs-totally)
2261 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2262 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2263 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2264 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2266 (ediff-delete-temp-files)
2268 ;; Restore visibility range. This affects only ediff-*-regions/windows.
2269 ;; Since for other job names ediff-visible-region sets
2270 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2271 ;; ignored for such jobs.
2272 (if ediff-quit-widened
2273 (setq ediff-visible-bounds ediff-wide-bounds)
2274 (setq ediff-visible-bounds ediff-narrow-bounds))
2276 ;; Apply selective display to narrow or widen
2277 (ediff-visible-region)
2278 (mapcar (function (lambda (overl)
2279 (if (ediff-overlayp overl)
2280 (ediff-delete-overlay overl))))
2282 (mapcar (function (lambda (overl)
2283 (if (ediff-overlayp overl)
2284 (ediff-delete-overlay overl))))
2285 ediff-narrow-bounds)
2287 ;; restore buffer mode line id's in buffer-A/B/C
2288 (let ((control-buffer ediff-control-buffer)
2289 (meta-buffer ediff-meta-buffer)
2290 ;; suitable working frame
2291 (warp-frame (if (and (ediff-window-display-p) (eq ediff-grab-mouse t))
2292 (cond ((window-live-p ediff-window-A)
2293 (window-frame ediff-window-A))
2294 ((window-live-p ediff-window-B)
2295 (window-frame ediff-window-B))
2296 (t (next-frame))))))
2298 (ediff-with-current-buffer ediff-buffer-A
2299 (setq ediff-this-buffer-ediff-sessions
2300 (delq control-buffer ediff-this-buffer-ediff-sessions))
2301 (kill-local-variable 'mode-line-buffer-identification)
2302 (kill-local-variable 'mode-line-format)
2307 (ediff-with-current-buffer ediff-buffer-B
2308 (setq ediff-this-buffer-ediff-sessions
2309 (delq control-buffer ediff-this-buffer-ediff-sessions))
2310 (kill-local-variable 'mode-line-buffer-identification)
2311 (kill-local-variable 'mode-line-format)
2316 (ediff-with-current-buffer ediff-buffer-C
2317 (setq ediff-this-buffer-ediff-sessions
2318 (delq control-buffer ediff-this-buffer-ediff-sessions))
2319 (kill-local-variable 'mode-line-buffer-identification)
2320 (kill-local-variable 'mode-line-format)
2325 (ediff-with-current-buffer ediff-ancestor-buffer
2326 (setq ediff-this-buffer-ediff-sessions
2327 (delq control-buffer ediff-this-buffer-ediff-sessions))
2328 (kill-local-variable 'mode-line-buffer-identification)
2329 (kill-local-variable 'mode-line-format)
2333 (setq ediff-session-registry
2334 (delq ediff-control-buffer ediff-session-registry))
2335 (ediff-update-registry)
2336 ;; restore state of buffers to what it was before ediff
2337 (ediff-restore-protected-variables)
2339 ;; If the user interrupts (canceling saving the merge buffer), continue
2342 (if (ediff-merge-job)
2343 (run-hooks 'ediff-quit-merge-hook))
2346 ;; good place to kill buffers A/B/C
2347 (run-hooks 'ediff-cleanup-hook)
2348 (let ((ediff-keep-variants ediff-keep-variants))
2349 (if reverse-default-keep-variants
2350 (setq ediff-keep-variants (not ediff-keep-variants)))
2351 (or ediff-keep-variants (ediff-janitor 'ask)))
2353 (run-hooks 'ediff-quit-hook)
2354 (ediff-cleanup-meta-buffer meta-buffer)
2356 ;; warp mouse into a working window
2357 (setq warp-frame ; if mouse is over a reasonable frame, use it
2358 (cond ((ediff-good-frame-under-mouse))
2360 (if (frame-live-p warp-frame)
2361 (set-mouse-position (if ediff-emacs-p
2363 (frame-selected-window warp-frame))
2366 (if (ediff-buffer-live-p meta-buffer)
2367 (ediff-show-meta-buffer meta-buffer))
2370 ;; Returns frame under mouse, if this frame is not a minibuffer
2371 ;; frame. Otherwise: nil
2372 (defun ediff-good-frame-under-mouse ()
2373 (let ((frame-or-win (car (mouse-position)))
2378 (frame-live-p frame-or-win)
2379 (window-live-p frame-or-win)))
2381 (setq frame (if ediff-emacs-p frame-or-win (window-frame frame-or-win))
2383 (buffer-name (window-buffer (frame-selected-window frame)))))
2384 (if (string-match "Minibuf" buf-name)
2389 (defun ediff-delete-temp-files ()
2390 (if (stringp ediff-temp-file-A)
2391 (delete-file ediff-temp-file-A))
2392 (if (stringp ediff-temp-file-B)
2393 (delete-file ediff-temp-file-B))
2394 (if (stringp ediff-temp-file-C)
2395 (delete-file ediff-temp-file-C)))
2398 ;; Kill control buffer, other auxiliary Ediff buffers.
2399 ;; Leave one of the frames split between buffers A/B/C
2400 (defun ediff-cleanup-mess ()
2401 (let ((buff-A ediff-buffer-A)
2402 (buff-B ediff-buffer-B)
2403 (buff-C ediff-buffer-C)
2404 (ctl-buf ediff-control-buffer)
2405 (ctl-frame ediff-control-frame)
2406 (three-way-job ediff-3way-job))
2408 (ediff-kill-buffer-carefully ediff-diff-buffer)
2409 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2410 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2411 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2412 (ediff-kill-buffer-carefully ediff-error-buffer)
2413 (ediff-kill-buffer-carefully ediff-msg-buffer)
2414 (ediff-kill-buffer-carefully ediff-debug-buffer)
2415 (if (boundp 'ediff-patch-diagnostics)
2416 (ediff-kill-buffer-carefully ediff-patch-diagnostics))
2418 (if (and (ediff-window-display-p) (frame-live-p ctl-frame))
2419 (delete-frame ctl-frame))
2420 ;; Hide bottom toolbar. --marcpa
2421 (if (not (ediff-multiframe-setup-p))
2422 (ediff-kill-bottom-toolbar))
2424 (ediff-kill-buffer-carefully ctl-buf)
2426 (delete-other-windows)
2428 ;; display only if not visible
2430 (or (ediff-get-visible-buffer-window buff-B)
2431 (switch-to-buffer buff-B))
2434 (or (ediff-get-visible-buffer-window buff-A)
2436 (if (ediff-get-visible-buffer-window buff-B)
2437 (funcall ediff-split-window-function))
2438 (switch-to-buffer buff-A)))
2442 (or (ediff-get-visible-buffer-window buff-C)
2444 (if (or (ediff-get-visible-buffer-window buff-A)
2445 (ediff-get-visible-buffer-window buff-B))
2446 (funcall ediff-split-window-function))
2447 (switch-to-buffer buff-C)
2453 (defun ediff-janitor (&optional ask)
2454 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2455 In merge jobs, buffer C is never deleted.
2456 However, the side effect of cleaning up may be that you cannot compare the same
2457 buffer in two separate Ediff sessions: quitting one of them will delete this
2458 buffer in another session as well."
2459 (or (not (ediff-buffer-live-p ediff-buffer-A))
2460 (buffer-modified-p ediff-buffer-A)
2462 (not (y-or-n-p (format "Kill buffer A [%s]? "
2463 (buffer-name ediff-buffer-A)))))
2464 (ediff-kill-buffer-carefully ediff-buffer-A))
2465 (or (not (ediff-buffer-live-p ediff-buffer-B))
2466 (buffer-modified-p ediff-buffer-B)
2468 (not (y-or-n-p (format "Kill buffer B [%s]? "
2469 (buffer-name ediff-buffer-B)))))
2470 (ediff-kill-buffer-carefully ediff-buffer-B))
2471 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2472 (or (not (ediff-buffer-live-p ediff-ancestor-buffer))
2473 (buffer-modified-p ediff-ancestor-buffer)
2475 (not (y-or-n-p (format "Kill the ancestor buffer [%s]? "
2476 (buffer-name ediff-ancestor-buffer)))))
2477 (ediff-kill-buffer-carefully ediff-ancestor-buffer))
2478 (or (not (ediff-buffer-live-p ediff-buffer-C))
2479 (buffer-modified-p ediff-buffer-C)
2480 (and ask (not (y-or-n-p (format "Kill buffer C [%s]? "
2481 (buffer-name ediff-buffer-C)))))
2482 (ediff-kill-buffer-carefully ediff-buffer-C))))
2484 (defun ediff-maybe-save-and-delete-merge (&optional save-and-continue)
2485 "Default hook to run on quitting a merge job.
2486 This can also be used to save merge buffer in the middle of an Ediff session.
2488 If the optional SAVE-AND-CONTINUE argument is non-nil, save merge buffer and
2489 continue. Otherwise:
2490 If `ediff-autostore-merges' is nil, this does nothing.
2491 If it is t, it saves the merge buffer in the file `ediff-merge-store-file'
2492 or asks the user, if the latter is nil. It then asks the user whether to
2493 delete the merge buffer.
2494 If `ediff-autostore-merges' is neither nil nor t, the merge buffer is saved
2495 only if this merge job is part of a group, i.e., was invoked from within
2496 `ediff-merge-directories', `ediff-merge-directory-revisions', and such."
2497 (let ((merge-store-file ediff-merge-store-file)
2498 (ediff-autostore-merges ; fake ediff-autostore-merges, if necessary
2499 (if save-and-continue t ediff-autostore-merges)))
2500 (if ediff-autostore-merges
2501 (cond ((stringp ediff-merge-store-file)
2502 ;; store, ask to delete
2503 (ediff-write-merge-buffer-and-maybe-kill
2504 ediff-buffer-C merge-store-file 'show-file save-and-continue))
2505 ((eq ediff-autostore-merges t)
2506 ;; ask for file name
2507 (setq merge-store-file
2508 (read-file-name "Save the merge buffer in file: "))
2509 (ediff-write-merge-buffer-and-maybe-kill
2510 ediff-buffer-C merge-store-file nil save-and-continue))
2511 ((and (ediff-buffer-live-p ediff-meta-buffer)
2512 (ediff-with-current-buffer ediff-meta-buffer
2513 (ediff-merge-metajob)))
2514 ;; This case shouldn't occur, as the parent metajob must pass on
2515 ;; a file name, ediff-merge-store-file, where to save the result
2517 ;; Ask where to save anyway--will decide what to do here later.
2518 (setq merge-store-file
2519 (read-file-name "Save the merge buffer in file: "))
2520 (ediff-write-merge-buffer-and-maybe-kill
2521 ediff-buffer-C merge-store-file nil save-and-continue))))
2524 ;; write merge buffer. If the optional argument save-and-continue is non-nil,
2525 ;; then don't kill the merge buffer
2526 (defun ediff-write-merge-buffer-and-maybe-kill (buf file
2528 show-file save-and-continue)
2529 (ediff-with-current-buffer buf
2530 (if (or (not (file-exists-p file))
2531 (y-or-n-p (format "File %s exists, overwrite? " file)))
2533 (write-region (point-min) (point-max) file)
2536 (message "Merge buffer saved in: %s" file)
2539 (not save-and-continue)
2540 (y-or-n-p "Merge buffer saved in file. Now kill the buffer? "))
2541 (ediff-kill-buffer-carefully buf))))))
2543 ;; The default way of suspending Ediff.
2544 ;; Buries Ediff buffers, kills all windows.
2545 (defun ediff-default-suspend-function ()
2546 (let* ((buf-A ediff-buffer-A)
2547 (buf-B ediff-buffer-B)
2548 (buf-C ediff-buffer-C)
2549 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2550 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2551 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2552 (buf-patch (if (boundp 'ediff-patchbufer) ediff-patchbufer nil))
2553 (buf-patch-diag (if (boundp 'ediff-patch-diagnostics)
2554 ediff-patch-diagnostics nil))
2555 (buf-err ediff-error-buffer)
2556 (buf-diff ediff-diff-buffer)
2557 (buf-custom-diff ediff-custom-diff-buffer)
2558 (buf-fine-diff ediff-fine-diff-buffer))
2560 ;; hide the control panel
2561 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2562 (iconify-frame ediff-control-frame)
2564 (if buf-err (bury-buffer buf-err))
2565 (if buf-diff (bury-buffer buf-diff))
2566 (if buf-custom-diff (bury-buffer buf-custom-diff))
2567 (if buf-fine-diff (bury-buffer buf-fine-diff))
2568 (if buf-patch (bury-buffer buf-patch))
2569 (if buf-patch-diag (bury-buffer buf-patch-diag))
2570 (if (window-live-p buf-A-wind)
2572 (select-window buf-A-wind)
2573 (delete-other-windows)
2575 (if (ediff-buffer-live-p buf-A)
2579 (if (window-live-p buf-B-wind)
2581 (select-window buf-B-wind)
2582 (delete-other-windows)
2584 (if (ediff-buffer-live-p buf-B)
2588 (if (window-live-p buf-C-wind)
2590 (select-window buf-C-wind)
2591 (delete-other-windows)
2593 (if (ediff-buffer-live-p buf-C)
2600 (defun ediff-suspend ()
2602 To resume, switch to the appropriate `Ediff Control Panel'
2603 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2604 up an appropriate window config."
2606 (ediff-barf-if-not-control-buffer)
2607 (run-hooks 'ediff-suspend-hook)
2609 "To resume, type M-x eregistry and select the desired Ediff session"))
2612 (defun ediff-status-info ()
2613 "Show the names of the buffers or files being operated on by Ediff.
2614 Hit \\[ediff-recenter] to reset the windows afterward."
2616 (ediff-barf-if-not-control-buffer)
2618 (ediff-skip-unsuitable-frames))
2619 (with-output-to-temp-buffer ediff-msg-buffer
2620 (raise-frame (selected-frame))
2621 (princ (ediff-version))
2623 (ediff-with-current-buffer ediff-buffer-A
2624 (if buffer-file-name
2626 (format "File A = %S\n" buffer-file-name))
2628 (format "Buffer A = %S\n" (buffer-name)))))
2629 (ediff-with-current-buffer ediff-buffer-B
2630 (if buffer-file-name
2632 (format "File B = %S\n" buffer-file-name))
2634 (format "Buffer B = %S\n" (buffer-name)))))
2636 (ediff-with-current-buffer ediff-buffer-C
2637 (if buffer-file-name
2639 (format "File C = %S\n" buffer-file-name))
2641 (format "Buffer C = %S\n" (buffer-name))))))
2642 (princ (format "Customized diff output %s\n"
2643 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2644 (concat "\tin buffer "
2645 (buffer-name ediff-custom-diff-buffer))
2646 " is not available")))
2647 (princ (format "Plain diff output %s\n"
2648 (if (ediff-buffer-live-p ediff-diff-buffer)
2649 (concat "\tin buffer "
2650 (buffer-name ediff-diff-buffer))
2651 " is not available")))
2653 (let* ((A-line (ediff-with-current-buffer ediff-buffer-A
2654 (1+ (count-lines (point-min) (point)))))
2655 (B-line (ediff-with-current-buffer ediff-buffer-B
2656 (1+ (count-lines (point-min) (point)))))
2658 (princ (format "\Buffer A's point is on line %d\n" A-line))
2659 (princ (format "Buffer B's point is on line %d\n" B-line))
2662 (setq C-line (ediff-with-current-buffer ediff-buffer-C
2663 (1+ (count-lines (point-min) (point)))))
2664 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2666 (princ (format "\nCurrent difference number = %S\n"
2667 (cond ((< ediff-current-difference 0) 'start)
2668 ((>= ediff-current-difference
2669 ediff-number-of-differences) 'end)
2670 (t (1+ ediff-current-difference)))))
2673 (format "\n%s regions that differ in white space & line breaks only"
2674 (if ediff-ignore-similar-regions
2675 "Ignoring" "Showing")))
2676 (if (and ediff-merge-job ediff-show-clashes-only)
2678 "\nFocusing on regions where both buffers differ from the ancestor"))
2680 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2681 (princ "\nSelective browsing by regexp is off\n"))
2682 ((eq ediff-skip-diff-region-function
2683 ediff-hide-regexp-matches-function)
2685 "\nIgnoring regions that match")
2688 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2689 ediff-regexp-hide-A ediff-hide-regexp-connective
2690 ediff-regexp-hide-B)))
2691 ((eq ediff-skip-diff-region-function
2692 ediff-focus-on-regexp-matches-function)
2694 "\nFocusing on regions that match")
2697 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2698 ediff-regexp-focus-A ediff-focus-regexp-connective
2699 ediff-regexp-focus-B)))
2700 (t (princ "\nSelective browsing via a user-defined method.\n")))
2703 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2704 (substitute-command-keys "\\[ediff-submit-report]")))
2706 (if (frame-live-p ediff-control-frame)
2707 (ediff-reset-mouse ediff-control-frame))
2708 (if (window-live-p ediff-control-window)
2709 (select-window ediff-control-window)))
2714 ;;; Support routines
2716 ;; Select a difference by placing the ASCII flags around the appropriate
2717 ;; group of lines in the A, B buffers
2718 ;; This may have to be modified for buffer C, when it will be supported.
2719 (defun ediff-select-difference (n)
2720 (if (and (ediff-buffer-live-p ediff-buffer-A)
2721 (ediff-buffer-live-p ediff-buffer-B)
2722 (ediff-valid-difference-p n))
2724 (if (and (ediff-has-face-support-p) ediff-use-faces)
2726 (ediff-highlight-diff n)
2727 (setq ediff-highlighting-style 'face))
2728 (setq ediff-highlighting-style 'ascii)
2729 (ediff-place-flags-in-buffer
2730 'A ediff-buffer-A ediff-control-buffer n)
2731 (ediff-place-flags-in-buffer
2732 'B ediff-buffer-B ediff-control-buffer n)
2734 (ediff-place-flags-in-buffer
2735 'C ediff-buffer-C ediff-control-buffer n))
2736 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2737 (ediff-place-flags-in-buffer
2738 'Ancestor ediff-ancestor-buffer
2739 ediff-control-buffer n))
2742 (ediff-install-fine-diff-if-necessary n)
2743 (run-hooks 'ediff-select-hook))))
2746 ;; Unselect a difference by removing the ASCII flags in the buffers.
2747 ;; This may have to be modified for buffer C, when it will be supported.
2748 (defun ediff-unselect-difference (n)
2749 (if (ediff-valid-difference-p n)
2751 (cond ((and (ediff-has-face-support-p) ediff-use-faces)
2752 (ediff-unhighlight-diff))
2753 ((eq ediff-highlighting-style 'ascii)
2754 (ediff-remove-flags-from-buffer
2756 (ediff-get-diff-overlay n 'A))
2757 (ediff-remove-flags-from-buffer
2759 (ediff-get-diff-overlay n 'B))
2761 (ediff-remove-flags-from-buffer
2763 (ediff-get-diff-overlay n 'C)))
2764 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2765 (ediff-remove-flags-from-buffer
2766 ediff-ancestor-buffer
2767 (ediff-get-diff-overlay n 'Ancestor)))
2769 (setq ediff-highlighting-style nil)
2771 ;; unhighlight fine diffs
2772 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2773 (run-hooks 'ediff-unselect-hook))))
2776 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2777 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2778 ;; next difference is selected, but the current selection is not
2779 ;; unselected. If FLAG is 'unselect-only then the current selection is
2780 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2781 ;; don't recenter buffers after selecting/unselecting.
2782 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2783 (let ((ediff-current-difference n))
2785 (ediff-recenter 'no-rehighlight)))
2787 (let ((control-buf ediff-control-buffer))
2790 (or (eq flag 'select-only)
2791 (ediff-unselect-difference ediff-current-difference))
2793 (or (eq flag 'unselect-only)
2794 (ediff-select-difference n))
2795 (setq ediff-current-difference n)
2796 ) ; end protected section
2798 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
2802 (defun ediff-read-file-name (prompt default-dir default-file)
2803 ; This is a modified version of a similar function in `emerge.el'.
2804 ; PROMPT should not have trailing ': ', so that it can be modified
2805 ; according to context.
2806 ; If default-file is set, it should be used as the default value.
2807 ; If default-dir is non-nil, use it as the default directory.
2808 ; Otherwise, use the value of Emacs' variable `default-directory.'
2810 ;; hack default-dir if it is not set
2812 (file-name-as-directory
2813 (ediff-abbreviate-file-name
2814 (expand-file-name (or default-dir
2816 (file-name-directory default-file))
2817 default-directory)))))
2819 ;; strip the directory from default-file
2821 (setq default-file (file-name-nondirectory default-file)))
2822 (if (string= default-file "")
2823 (setq default-file nil))
2826 (setq f (expand-file-name
2831 (concat " (default " default-file "):"))
2832 (t (concat " (default " default-dir "):"))))
2834 (or default-file default-dir)
2835 t ; must match, no-confirm
2836 (if default-file (file-name-directory default-file))
2840 ;; If user enters a directory name, expand the default file in that
2841 ;; directory. This allows the user to enter a directory name for the
2842 ;; B-file and diff against the default-file in that directory instead
2843 ;; of a DIRED listing!
2844 (if (and (file-directory-p f) default-file)
2845 (setq f (expand-file-name
2846 (file-name-nondirectory default-file) f)))
2849 ;; If PREFIX is given, then it is used as a prefix for the temp file
2850 ;; name. Otherwise, `ediff_' is used. If FILE is given, use this
2851 ;; file and don't create a new one.
2852 ;; On MS-DOS, make sure the prefix isn't longer than 7 characters, or
2853 ;; else `make-temp-name' isn't guaranteed to return a unique filename.
2854 ;; Also, save buffer from START to END in the file.
2855 ;; START defaults to (point-min), END to (point-max)
2856 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
2857 (let ((p (or prefix "ediff"))
2859 (if (and (eq system-type 'ms-dos) (> (length p) 7))
2860 (setq p (substring p 0 7)))
2862 (setq f (concat ediff-temp-file-prefix p)
2863 f (cond (given-file)
2864 ((find-file-name-handler f 'find-file-noselect)
2865 ;; to thwart file handlers in write-region, e.g., if file
2866 ;; name ends with .Z or .gz
2867 ;; This is needed so that patches produced by ediff will
2868 ;; have more meaningful names
2870 ;; Prefix is most often the same as the file name for the
2871 ;; variant. Here we are trying to use the original file name
2872 ;; but in the temp directory.
2873 ((and prefix (not (file-exists-p f))) f)
2874 ;; If a file with the orig name exists, add some random stuff
2876 (t (make-temp-name f))))
2879 (ediff-with-current-buffer buff
2880 (write-region (if start start (point-min))
2881 (if end end (point-max))
2883 nil ; don't append---erase
2885 (set-file-modes f ediff-temp-file-mode)
2886 (ediff-convert-standard-filename (expand-file-name f)))))
2888 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
2890 ;;(defun ediff-protect-metachars (str)
2891 ;; (or (memq system-type '(emx vax-vms axp-vms))
2893 ;; (while (string-match ediff-metachars str limit)
2894 ;; (setq str (concat (substring str 0 (match-beginning 0))
2896 ;; (substring str (match-beginning 0))))
2897 ;; (setq limit (1+ (match-end 0))))))
2900 ;; Make sure the current buffer (for a file) has the same contents as the
2901 ;; file on disk, and attempt to remedy the situation if not.
2902 ;; Signal an error if we can't make them the same, or the user doesn't want
2903 ;; to do what is necessary to make them the same.
2904 ;; Also, Ediff always offers to revert obsolete buffers, whether they
2905 ;; are modified or not.
2906 (defun ediff-verify-file-buffer (&optional file-magic)
2907 ;; First check if the file has been modified since the buffer visited it.
2908 (if (verify-visited-file-modtime (current-buffer))
2909 (if (buffer-modified-p)
2910 ;; If buffer is not obsolete and is modified, offer to save
2912 (format "Buffer out of sync with visited file. Save file %s? "
2918 (message "Couldn't save %s" buffer-file-name)))
2919 (error "Buffer is out of sync for file %s" buffer-file-name))
2920 ;; If buffer is not obsolete and is not modified, do nothing
2922 ;; If buffer is obsolete, offer to revert
2924 (format "Buffer is out of sync with visited file. REVERT file %s? "
2929 (revert-buffer t t))
2930 (error "Buffer out of sync for file %s" buffer-file-name))))
2933 (defun ediff-file-compressed-p (file)
2934 (require 'jka-compr)
2935 (string-match (jka-compr-build-file-regexp) file))
2937 (defun ediff-filename-magic-p (file)
2938 (or (ediff-file-compressed-p file)
2939 (ediff-file-remote-p file)))
2942 (defun ediff-save-buffer (arg)
2943 "Safe way of saving buffers A, B, C, and the diff output.
2944 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
2945 and `wd' saves the diff output.
2947 With prefix argument, `wd' saves plain diff output.
2948 Without an argument, it saves customized diff argument, if available
2949 \(and plain output, if customized output was not generated\)."
2951 (ediff-barf-if-not-control-buffer)
2952 (ediff-compute-custom-diffs-maybe)
2953 (ediff-with-current-buffer
2954 (cond ((memq last-command-char '(?a ?b ?c))
2956 (ediff-char-to-buftype last-command-char)))
2957 ((eq last-command-char ?d)
2958 (message "Saving diff output ...")
2959 (sit-for 1) ; let the user see the message
2960 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2962 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2963 ediff-custom-diff-buffer)
2964 ((ediff-buffer-live-p ediff-diff-buffer)
2966 (t (error "Output from `diff' not found"))))
2970 (defun ediff-compute-custom-diffs-maybe ()
2971 (let ((buf-A-file-name (buffer-file-name ediff-buffer-A))
2972 (buf-B-file-name (buffer-file-name ediff-buffer-B))
2974 (if (stringp buf-A-file-name)
2975 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
2976 (if (stringp buf-B-file-name)
2977 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
2978 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name)
2979 file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
2981 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
2982 (setq ediff-custom-diff-buffer
2984 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
2986 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
2987 ediff-custom-diff-options file-A file-B)
2988 (delete-file file-A)
2989 (delete-file file-B)
2992 (defun ediff-show-diff-output (arg)
2994 (ediff-barf-if-not-control-buffer)
2995 (ediff-compute-custom-diffs-maybe)
2997 (ediff-skip-unsuitable-frames ' ok-unsplittable))
2998 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3000 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3001 ediff-custom-diff-buffer)
3002 ((ediff-buffer-live-p ediff-diff-buffer)
3006 (message "Output from `diff' not found")
3010 (ediff-with-current-buffer buf
3011 (goto-char (point-min)))
3012 (switch-to-buffer buf)
3013 (raise-frame (selected-frame)))))
3014 (if (frame-live-p ediff-control-frame)
3015 (ediff-reset-mouse ediff-control-frame))
3016 (if (window-live-p ediff-control-window)
3017 (select-window ediff-control-window)))
3020 (defun ediff-inferior-compare-regions ()
3021 "Compare regions in an active Ediff session.
3022 Like ediff-regions-linewise but is called from under an active Ediff session on
3023 the files that belong to that session.
3025 After quitting the session invoked via this function, type C-l to the parent
3026 Ediff Control Panel to restore highlighting."
3029 (possibilities (list ?A ?B ?C))
3031 (ctl-buf (current-buffer))
3033 begA begB endA endB bufA bufB)
3035 (cond ((ediff-merge-job)
3036 (setq bufB ediff-buffer-C)
3037 (while (cond ((eq answer ?A)
3038 (setq bufA ediff-buffer-A
3039 possibilities '(?B))
3042 (setq bufA ediff-buffer-B
3043 possibilities '(?A))
3047 (message "Valid values are A or B")
3050 (let ((cursor-in-echo-area t))
3051 (message "Which buffer to compare to the merge buffer (A/B)? ")
3052 (setq answer (capitalize (read-char-exclusive))))))
3054 ((ediff-3way-comparison-job)
3055 (while (cond ((memq answer possibilities)
3056 (setq possibilities (delq answer possibilities))
3059 (ediff-get-symbol-from-alist
3060 answer ediff-buffer-alist)))
3065 "Valid values are %s"
3066 (mapconcat 'char-to-string possibilities " or "))
3069 (let ((cursor-in-echo-area t))
3070 (message "Enter the 1st buffer you want to compare (%s): "
3071 (mapconcat 'char-to-string possibilities "/"))
3072 (setq answer (capitalize (read-char-exclusive)))))
3073 (setq answer "") ; silence error msg
3074 (while (cond ((memq answer possibilities)
3075 (setq possibilities (delq answer possibilities))
3078 (ediff-get-symbol-from-alist
3079 answer ediff-buffer-alist)))
3084 "Valid values are %s"
3085 (mapconcat 'char-to-string possibilities " or "))
3088 (let ((cursor-in-echo-area t))
3089 (message "Enter the 2nd buffer you want to compare (%s): "
3090 (mapconcat 'char-to-string possibilities "/"))
3091 (setq answer (capitalize (read-char-exclusive))))))
3092 (t ; 2way comparison
3093 (setq bufA ediff-buffer-A
3095 possibilities nil)))
3097 (ediff-with-current-buffer bufA
3099 (error "You forgot to specify a region in buffer %s" (buffer-name)))
3100 (setq begA (region-beginning)
3107 (or (eobp) (forward-char)) ; include the newline char
3108 (setq endA (point)))
3109 (ediff-with-current-buffer bufB
3111 (error "You forgot to specify a region in buffer %s" (buffer-name)))
3112 (setq begB (region-beginning)
3119 (or (eobp) (forward-char)) ; include the newline char
3120 (setq endB (point)))
3122 (ediff-unselect-and-select-difference
3123 ediff-current-difference 'unselect-only)
3124 (ediff-paint-background-regions 'unhighlight)
3126 (ediff-with-current-buffer bufA
3129 (narrow-to-region begA endA)
3130 ;; (ediff-activate-mark)
3133 (ediff-with-current-buffer bufB
3136 (narrow-to-region begB endB)
3137 ;; (ediff-activate-mark)
3141 ;; At this point, possibilities contains either the window char A/B/C
3142 ;; that was not selected, or it is nil. We delete the window that is not
3145 (ediff-with-current-buffer ctl-buf
3146 (let* ((wind-to-delete (eval
3147 (ediff-get-symbol-from-alist
3149 ediff-window-alist)))
3150 (frame (window-frame wind-to-delete)))
3151 (delete-window wind-to-delete)
3152 (select-frame frame)
3153 (balance-windows))))
3155 "Please check regions selected for comparison. Continue? ")
3158 (ediff-with-current-buffer bufA
3160 (ediff-with-current-buffer bufB
3163 (ediff-with-current-buffer ctl-buf
3166 (error "All right. Make up your mind and come back...")))
3168 (ediff-regions-internal
3169 bufA begA endA bufB begB endB
3171 'ediff-regions-linewise ; job name
3173 ;; setup param to pass to ediff-setup
3174 (list (cons 'ediff-split-window-function ediff-split-window-function)))
3179 (defun ediff-remove-flags-from-buffer (buffer overlay)
3180 (ediff-with-current-buffer buffer
3181 (let ((inhibit-read-only t))
3183 (ediff-overlay-put overlay 'begin-glyph nil)
3184 (ediff-overlay-put overlay 'before-string nil))
3187 (ediff-overlay-put overlay 'end-glyph nil)
3188 (ediff-overlay-put overlay 'after-string nil))
3193 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
3194 (ediff-with-current-buffer buffer
3195 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
3198 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
3199 (let* ((curr-overl (ediff-with-current-buffer ctl-buffer
3200 (ediff-get-diff-overlay diff-no buf-type)))
3201 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
3202 after beg-of-line flag)
3204 ;; insert flag before the difference
3206 (setq beg-of-line (bolp))
3208 (setq flag (ediff-with-current-buffer ctl-buffer
3209 (if (eq ediff-highlighting-style 'ascii)
3211 ediff-before-flag-bol ediff-before-flag-mol))))
3213 ;; insert the flag itself
3215 (ediff-overlay-put curr-overl 'begin-glyph flag)
3216 (ediff-overlay-put curr-overl 'before-string flag))
3218 ;; insert the flag after the difference
3219 ;; `after' must be set here, after the before-flag was inserted
3220 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
3222 (setq beg-of-line (bolp))
3224 (setq flag (ediff-with-current-buffer ctl-buffer
3225 (if (eq ediff-highlighting-style 'ascii)
3227 ediff-after-flag-eol ediff-after-flag-mol))))
3229 ;; insert the flag itself
3231 (ediff-overlay-put curr-overl 'end-glyph flag)
3232 (ediff-overlay-put curr-overl 'after-string flag))
3236 ;; Returns positions of difference sectors in the BUF-TYPE buffer.
3237 ;; BUF-TYPE should be a symbol -- `A', `B', or `C'.
3238 ;; POS is either `beg' or `end'--it specifies whether you want the position at
3239 ;; the beginning of a difference or at the end.
3241 ;; The optional argument N says which difference (default:
3242 ;; `ediff-current-difference'). N is the internal difference number (1- what
3243 ;; the user sees). The optional argument CONTROL-BUF says
3244 ;; which control buffer is in effect in case it is not the current
3246 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
3249 (setq control-buf (current-buffer)))
3251 (ediff-with-current-buffer control-buf
3252 (or n (setq n ediff-current-difference))
3253 (if (or (< n 0) (>= n ediff-number-of-differences))
3254 (if (> ediff-number-of-differences 0)
3255 (error ediff-BAD-DIFF-NUMBER
3256 this-command (1+ n) ediff-number-of-differences)
3257 (error ediff-NO-DIFFERENCES)))
3258 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
3259 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
3260 (error ediff-KILLED-VITAL-BUFFER))
3262 (ediff-overlay-start diff-overlay)
3263 (ediff-overlay-end diff-overlay))
3267 ;; Restore highlighting to what it should be according to ediff-use-faces,
3268 ;; ediff-highlighting-style, and ediff-highlight-all-diffs variables.
3269 (defun ediff-restore-highlighting (&optional ctl-buf)
3270 (ediff-with-current-buffer (or ctl-buf (current-buffer))
3271 (if (and (ediff-has-face-support-p)
3273 ediff-highlight-all-diffs)
3274 (ediff-paint-background-regions))
3275 (ediff-select-difference ediff-current-difference)))
3279 ;; null out difference overlays so they won't slow down future
3280 ;; editing operations
3281 ;; VEC is either a difference vector or a fine-diff vector
3282 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
3283 (if (vectorp (symbol-value vec-var))
3286 (ediff-delete-overlay
3287 (ediff-get-diff-overlay-from-diff-record elt))
3289 (ediff-clear-fine-diff-vector elt))
3291 (symbol-value vec-var)))
3292 ;; allow them to be garbage collected
3299 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
3300 ;; supporting sticky overlays, this function will make a sticky overlay.
3301 ;; BEG and END are expressions telling where overlay starts.
3302 ;; If they are numbers or buffers, then all is well. Otherwise, they must
3303 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
3305 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
3306 ;; newly created overlay.
3307 (defun ediff-make-bullet-proof-overlay (beg end buff)
3308 (if (ediff-buffer-live-p buff)
3310 (ediff-with-current-buffer buff
3311 (or (number-or-marker-p beg)
3312 (setq beg (eval beg)))
3313 (or (number-or-marker-p end)
3314 (setq end (eval end)))
3317 (make-extent beg end buff)
3318 ;; advance front and rear of the overlay
3319 (make-overlay beg end buff nil 'rear-advance)))
3323 overl (if ediff-emacs-p 'evaporate 'detachable) nil)
3324 ;; make vip-minibuffer-overlay open-ended
3325 ;; In emacs, it is made open ended at creation time
3328 (ediff-overlay-put overl 'start-open nil)
3329 (ediff-overlay-put overl 'end-open nil)))
3330 (ediff-overlay-put overl 'ediff-diff-num 0)
3334 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3335 ;; other insignificant buffers (those beginning with "^[ *]").
3336 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3338 (defun ediff-other-buffer (buff-lst)
3339 (or (listp buff-lst) (setq buff-lst (list buff-lst)))
3340 (let* ((frame-buffers (buffer-list))
3343 (function (lambda (b)
3344 (cond ((stringp b) b)
3345 ((bufferp b) (buffer-name b)))))
3347 (significant-buffers
3349 (function (lambda (x)
3350 (cond ((member (buffer-name x) buff-name-list) nil)
3351 ((not (ediff-get-visible-buffer-window x)) nil)
3352 ((string-match "^[ *]" (buffer-name x)) nil)
3353 ((memq (ediff-with-current-buffer x major-mode)
3358 (buffers (delq nil significant-buffers))
3359 less-significant-buffers)
3361 (cond (buffers (car buffers))
3362 ;; try also buffers that are not displayed in windows
3363 ((setq less-significant-buffers
3368 (cond ((member (buffer-name x) buff-name-list) nil)
3369 ((string-match "^[ *]" (buffer-name x)) nil)
3371 (ediff-with-current-buffer x major-mode)
3376 (car less-significant-buffers))
3377 (t (other-buffer (current-buffer))))
3381 ;; Construct a unique buffer name.
3382 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3383 ;; prefix<3>suffix, etc.
3384 (defun ediff-unique-buffer-name (prefix suffix)
3385 (if (null (get-buffer (concat prefix suffix)))
3386 (concat prefix suffix)
3388 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3390 (format "%s<%d>%s" prefix n suffix))))
3393 (defun ediff-submit-report ()
3394 "Submit bug report on Ediff."
3396 (ediff-barf-if-not-control-buffer)
3397 (let ((reporter-prompt-for-summary-p t)
3398 (ctl-buf ediff-control-buffer)
3399 (ediff-device-type (ediff-device-type))
3400 varlist salutation buffer-name)
3401 (setq varlist '(ediff-diff-program ediff-diff-options
3402 ediff-patch-program ediff-patch-options
3405 ediff-auto-refine ediff-highlighting-style
3406 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3407 ediff-forward-word-function
3409 ediff-control-frame-parameters
3410 ediff-control-frame-position-function
3411 ediff-prefer-iconified-control-frame
3412 ediff-window-setup-function
3413 ediff-split-window-function
3420 Congratulations! You may have unearthed a bug in Ediff!
3422 Please make a concise and accurate summary of what happened
3423 and mail it to the address above.
3424 -----------------------------------------------------------
3427 (ediff-skip-unsuitable-frames)
3430 (switch-to-buffer ediff-msg-buffer)
3432 (delete-other-windows)
3434 Please read this first:
3435 ----------------------
3437 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3438 reporting that certain difference regions are not matched as you think they
3439 should, this is most likely due to the way Unix diff program decides what
3440 constitutes a difference region. Ediff is an Emacs interface to diff, and
3441 it has nothing to do with those decisions---it only takes the output from
3442 diff and presents it in a way that is better suited for human browsing and
3445 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3446 an Emacs bug. Report this to Emacs maintainers.
3448 Another popular topic for reports is compilation messages. Because Ediff
3449 interfaces to several other packages and runs under Emacs and XEmacs,
3450 byte-compilation may produce output like this:
3452 While compiling toplevel forms in file ediff.el:
3453 ** reference to free variable pm-color-alist
3454 ........................
3455 While compiling the end of the data:
3456 ** The following functions are not known to be defined:
3457 ediff-valid-color-p, ediff-set-face,
3458 ........................
3460 These are NOT errors, but inevitable warnings, which ought to be ignored.
3462 Please do not report those and similar things. However, comments and
3463 suggestions are always welcome.
3465 Mail anyway? (y or n) ")
3467 (if (y-or-n-p "Mail anyway? ")
3469 (if (ediff-buffer-live-p ctl-buf)
3470 (set-buffer ctl-buf))
3471 (setq buffer-name (buffer-name))
3473 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
3477 'delete-other-windows
3480 (beep 1)(message "Bug report aborted")
3481 (if (ediff-buffer-live-p ctl-buf)
3482 (ediff-with-current-buffer ctl-buf
3483 (ediff-recenter 'no-rehighlight))))
3487 (defun ediff-deactivate-mark ()
3489 (zmacs-deactivate-region)
3491 (defun ediff-activate-mark ()
3493 (setq mark-active t)
3494 (zmacs-activate-region)))
3496 (cond ((fboundp 'nuke-selective-display)
3497 ;; XEmacs 19.12 has nuke-selective-display
3498 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
3500 (defun ediff-nuke-selective-display ()
3504 (goto-char (point-min))
3505 (let ((mod-p (buffer-modified-p))
3506 buffer-read-only end)
3507 (and (eq t selective-display)
3508 (while (search-forward "\^M" nil t)
3512 (while (search-forward "\^M" end t)
3515 (set-buffer-modified-p mod-p)
3516 (setq selective-display nil)))))
3520 ;; The next two are modified versions from emerge.el.
3521 ;; VARS must be a list of symbols
3522 ;; ediff-save-variables returns an association list: ((var . val) ...)
3523 (defsubst ediff-save-variables (vars)
3524 (mapcar (function (lambda (v) (cons v (symbol-value v))))
3526 ;; VARS is a list of variable symbols.
3527 (defun ediff-restore-variables (vars assoc-list)
3529 (set (car vars) (cdr (assoc (car vars) assoc-list)))
3530 (setq vars (cdr vars))))
3532 (defun ediff-change-saved-variable (var value buf-type)
3534 (symbol-value (ediff-get-symbol-from-alist
3536 ediff-buffer-values-orig-alist)))
3537 (assoc-elt (assoc var assoc-list)))
3539 (setcdr assoc-elt value))))
3542 ;; must execute in control buf
3543 (defun ediff-save-protected-variables ()
3544 (setq ediff-buffer-values-orig-A
3545 (ediff-with-current-buffer ediff-buffer-A
3546 (ediff-save-variables ediff-protected-variables)))
3547 (setq ediff-buffer-values-orig-B
3548 (ediff-with-current-buffer ediff-buffer-B
3549 (ediff-save-variables ediff-protected-variables)))
3550 (if ediff-3way-comparison-job
3551 (setq ediff-buffer-values-orig-C
3552 (ediff-with-current-buffer ediff-buffer-C
3553 (ediff-save-variables ediff-protected-variables))))
3554 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3555 (setq ediff-buffer-values-orig-Ancestor
3556 (ediff-with-current-buffer ediff-ancestor-buffer
3557 (ediff-save-variables ediff-protected-variables)))))
3559 ;; must execute in control buf
3560 (defun ediff-restore-protected-variables ()
3561 (let ((values-A ediff-buffer-values-orig-A)
3562 (values-B ediff-buffer-values-orig-B)
3563 (values-C ediff-buffer-values-orig-C)
3564 (values-Ancestor ediff-buffer-values-orig-Ancestor))
3565 (ediff-with-current-buffer ediff-buffer-A
3566 (ediff-restore-variables ediff-protected-variables values-A))
3567 (ediff-with-current-buffer ediff-buffer-B
3568 (ediff-restore-variables ediff-protected-variables values-B))
3569 (if ediff-3way-comparison-job
3570 (ediff-with-current-buffer ediff-buffer-C
3571 (ediff-restore-variables ediff-protected-variables values-C)))
3572 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3573 (ediff-with-current-buffer ediff-ancestor-buffer
3574 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
3577 ;; save BUFFER in FILE. used in hooks.
3578 (defun ediff-save-buffer-in-file (buffer file)
3579 (ediff-with-current-buffer buffer
3585 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3587 ;; calculate time used by command
3588 (defun ediff-calc-command-time ()
3589 (let ((end (current-time))
3592 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3593 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3594 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3595 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3596 (or (equal ediff-command-begin-time '(0 0 0))
3597 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3599 (defsubst ediff-save-time ()
3600 (setq ediff-command-begin-time (current-time)))
3602 (defun ediff-profile ()
3603 "Toggle profiling Ediff commands."
3605 (ediff-barf-if-not-control-buffer)
3606 (make-local-hook 'post-command-hook)
3607 (let ((pre-hook 'pre-command-hook)
3608 (post-hook 'post-command-hook))
3609 (if (not (equal ediff-command-begin-time '(0 0 0)))
3610 (progn (remove-hook pre-hook 'ediff-save-time)
3611 (remove-hook post-hook 'ediff-calc-command-time)
3612 (setq ediff-command-begin-time '(0 0 0))
3613 (message "Ediff profiling disabled"))
3614 (add-hook pre-hook 'ediff-save-time t t)
3615 (add-hook post-hook 'ediff-calc-command-time nil t)
3616 (message "Ediff profiling enabled"))))
3618 (defun ediff-print-diff-vector (diff-vector-var)
3619 (princ (format "\n*** %S ***\n" diff-vector-var))
3624 "Diff %d: \tOverlay: %S
3626 \t\tNo-fine-diff-flag: %S
3627 \t\tState-of-diff:\t %S
3628 \t\tState-of-merge:\t %S
3630 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3633 (if (= (length (aref overl-vec 1)) 0)
3635 (mapconcat 'prin1-to-string
3636 (aref overl-vec 1) "\n\t\t\t "))
3637 (aref overl-vec 2) ; no fine diff flag
3638 (aref overl-vec 3) ; state-of-diff
3639 (aref overl-vec 4) ; state-of-merge
3641 (eval diff-vector-var)))
3645 (defun ediff-debug-info ()
3647 (ediff-barf-if-not-control-buffer)
3648 (with-output-to-temp-buffer ediff-debug-buffer
3649 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3650 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
3651 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
3652 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
3653 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
3657 ;;; General utilities
3659 ;; this uses comparison-func to decide who is a member
3660 (defun ediff-member (elt lis comparison-func)
3661 (while (and lis (not (funcall comparison-func (car lis) elt)))
3662 (setq lis (cdr lis)))
3665 ;; this uses comparison-func to decide who is a member, and this determines how
3666 ;; intersection looks like
3667 (defun ediff-intersection (lis1 lis2 comparison-func)
3668 (let ((result (list 'a)))
3670 (if (ediff-member (car lis1) lis2 comparison-func)
3671 (nconc result (list (car lis1))))
3672 (setq lis1 (cdr lis1)))
3676 ;; eliminates duplicates using comparison-func
3677 (defun ediff-union (lis1 lis2 comparison-func)
3678 (let ((result (list 'a)))
3680 (or (ediff-member (car lis1) (cdr result) comparison-func)
3681 (nconc result (list (car lis1))))
3682 (setq lis1 (cdr lis1)))
3684 (or (ediff-member (car lis2) (cdr result) comparison-func)
3685 (nconc result (list (car lis2))))
3686 (setq lis2 (cdr lis2)))
3689 ;; eliminates duplicates using comparison-func
3690 (defun ediff-set-difference (lis1 lis2 comparison-func)
3691 (let ((result (list 'a)))
3693 (or (ediff-member (car lis1) (cdr result) comparison-func)
3694 (ediff-member (car lis1) lis2 comparison-func)
3695 (nconc result (list (car lis1))))
3696 (setq lis1 (cdr lis1)))
3699 (defun ediff-copy-list (list)
3702 ;;; (while (consp list) (push (pop list) res))
3703 ;;; (prog1 (nreverse res) (setcdr res list)))
3706 (setq elt (car list)
3713 ;; don't report error if version control package wasn't found
3714 ;;(ediff-load-version-control 'silent)
3716 (run-hooks 'ediff-load-hook)
3719 ;;; Local Variables:
3720 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3721 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
3722 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
3725 ;;; ediff-util.el ends here