(imenu-buffer-menubar): Add defvar.
[emacs.git] / lisp / ediff-util.el
blob327f9011e1c341184b0600430f5eea93c196e746
1 ;;; ediff-util.el --- the core commands and utilities of ediff
3 ;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
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.
24 ;;; Code:
26 (require 'ediff-init)
27 (require 'ediff-mult)
30 ;;; Functions
32 (defun ediff-mode ()
33 "Ediff mode controls all operations in a single Ediff session.
34 This mode is entered through one of the following commands:
35 `ediff'
36 `ediff-files'
37 `ediff-buffers'
38 `ediff3'
39 `ediff-files3'
40 `ediff-buffers3'
41 `ediff-merge'
42 `ediff-merge-files'
43 `ediff-merge-files-with-ancestor'
44 `ediff-merge-buffers'
45 `ediff-merge-buffers-with-ancestor'
46 `ediff-merge-revisions'
47 `ediff-merge-revisions-with-ancestor'
48 `ediff-windows-wordwise'
49 `ediff-windows-linewise'
50 `ediff-regions-wordwise'
51 `ediff-regions-linewise'
52 `epatch'
53 `ediff-patch-file'
54 `ediff-patch-buffer'
55 `epatch-buffer'
56 `ediff-revision'
58 Commands:
59 \\{ediff-mode-map}"
60 (kill-all-local-variables)
61 (setq major-mode 'ediff-mode)
62 (setq mode-name "Ediff")
63 (run-hooks 'ediff-mode-hook))
66 (require 'ediff-diff)
67 (require 'ediff-merg)
70 ;;; Build keymaps
72 (ediff-defvar-local ediff-mode-map nil
73 "Local keymap used in Ediff mode.
74 This is local to each Ediff Control Panel, so they may vary from invocation
75 to invocation.")
77 ;; Set up the keymap in the control buffer
78 (defun ediff-set-keys ()
79 "Set up Ediff keymap, if necessary."
80 (if (null ediff-mode-map)
81 (ediff-setup-keymap))
82 (use-local-map ediff-mode-map))
84 ;; Reload Ediff keymap. For debugging only.
85 (defun ediff-reload-keymap ()
86 (interactive)
87 (setq ediff-mode-map nil)
88 (ediff-set-keys))
91 (defun ediff-setup-keymap ()
92 "Set up the keymap used in the control buffer of Ediff."
93 (setq ediff-mode-map (make-sparse-keymap))
94 (suppress-keymap ediff-mode-map)
96 (define-key ediff-mode-map "p" 'ediff-previous-difference)
97 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
98 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
99 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
100 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
101 'ediff-previous-difference nil))
102 (define-key ediff-mode-map "n" 'ediff-next-difference)
103 (define-key ediff-mode-map " " 'ediff-next-difference)
104 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
105 (define-key ediff-mode-map "g" nil)
106 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
107 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
108 (define-key ediff-mode-map "q" 'ediff-quit)
109 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
110 (define-key ediff-mode-map "z" 'ediff-suspend)
111 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
112 (define-key ediff-mode-map "|" 'ediff-toggle-split)
113 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
114 (or ediff-word-mode
115 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
116 (if ediff-narrow-job
117 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
118 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
119 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
120 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
121 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
122 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
123 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
124 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
125 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
126 (define-key ediff-mode-map "i" 'ediff-status-info)
127 (define-key ediff-mode-map "E" 'ediff-documentation)
128 (define-key ediff-mode-map "?" 'ediff-toggle-help)
129 (define-key ediff-mode-map "!" 'ediff-update-diffs)
130 (define-key ediff-mode-map "M" 'ediff-show-meta-buffer)
131 (define-key ediff-mode-map "R" 'ediff-show-registry)
132 (or ediff-word-mode
133 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
134 (define-key ediff-mode-map "a" nil)
135 (define-key ediff-mode-map "b" nil)
136 (define-key ediff-mode-map "r" nil)
137 (cond (ediff-merge-job
138 ;; Will barf if no ancestor
139 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
140 ;; In merging, we allow only A->C and B->C copying.
141 (define-key ediff-mode-map "a" 'ediff-copy-A-to-C)
142 (define-key ediff-mode-map "b" 'ediff-copy-B-to-C)
143 (define-key ediff-mode-map "r" 'ediff-restore-diff-in-merge-buffer)
144 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
145 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
146 (define-key ediff-mode-map "$" 'ediff-toggle-show-clashes-only)
147 (define-key ediff-mode-map "&" 'ediff-re-merge))
148 (ediff-3way-comparison-job
149 (define-key ediff-mode-map "ab" 'ediff-copy-A-to-B)
150 (define-key ediff-mode-map "ba" 'ediff-copy-B-to-A)
151 (define-key ediff-mode-map "ac" 'ediff-copy-A-to-C)
152 (define-key ediff-mode-map "bc" 'ediff-copy-B-to-C)
153 (define-key ediff-mode-map "c" nil)
154 (define-key ediff-mode-map "ca" 'ediff-copy-C-to-A)
155 (define-key ediff-mode-map "cb" 'ediff-copy-C-to-B)
156 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
157 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
158 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
159 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
160 (t ; 2-way comparison
161 (define-key ediff-mode-map "a" 'ediff-copy-A-to-B)
162 (define-key ediff-mode-map "b" 'ediff-copy-B-to-A)
163 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
164 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
165 ) ; cond
166 (define-key ediff-mode-map "G" 'ediff-submit-report)
167 (define-key ediff-mode-map "#" nil)
168 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
169 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
170 (or ediff-word-mode
171 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
172 (define-key ediff-mode-map "o" nil)
173 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
174 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
175 (define-key ediff-mode-map "w" nil)
176 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
177 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
178 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
179 (if ediff-3way-job
180 (progn
181 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
182 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
185 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
187 ;; Allow ediff-mode-map to be referenced indirectly
188 (fset 'ediff-mode-map ediff-mode-map)
189 (run-hooks 'ediff-keymap-setup-hook))
192 ;;; Setup functions
194 (require 'ediff-wind)
196 ;; No longer needed: XEmacs has surrogate minibuffers now.
197 ;;(or (boundp 'synchronize-minibuffers)
198 ;; (defvar synchronize-minibuffers nil))
200 ;; Common startup entry for all Ediff functions
201 ;; It now returns control buffer so other functions can do post-processing
202 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
203 startup-hooks setup-parameters)
204 (setq file-A (expand-file-name file-A))
205 (setq file-B (expand-file-name file-B))
206 (if (stringp file-C)
207 (setq file-C (expand-file-name file-C)))
208 (let* ((control-buffer-name
209 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
210 (control-buffer (ediff-eval-in-buffer buffer-A
211 (get-buffer-create control-buffer-name))))
212 (ediff-eval-in-buffer control-buffer
213 (ediff-mode)
215 ;; unwrap set up parameters passed as argument
216 (while setup-parameters
217 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
218 (setq setup-parameters (cdr setup-parameters)))
220 ;; set variables classifying the current ediff job
221 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
222 ediff-merge-job (ediff-merge-job)
223 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
224 ediff-3way-job (ediff-3way-job)
225 ediff-diff3-job (ediff-diff3-job)
226 ediff-narrow-job (ediff-narrow-job)
227 ediff-windows-job (ediff-windows-job)
228 ediff-word-mode-job (ediff-word-mode-job))
230 (make-local-variable 'ediff-use-long-help-message)
231 (make-local-variable 'ediff-prefer-iconified-control-frame)
232 (make-local-variable 'ediff-split-window-function)
233 (make-local-variable 'ediff-default-variant)
234 (make-local-variable 'ediff-merge-window-share)
235 (make-local-variable 'ediff-window-setup-function)
236 (make-local-variable 'ediff-keep-variants)
238 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
239 ;; This is because u may loose work---dangerous.
240 (if (string-match "buffer" (symbol-name ediff-job-name))
241 (setq ediff-keep-variants t))
243 (make-local-hook 'pre-command-hook)
244 (if (ediff-window-display-p)
245 (add-hook 'pre-command-hook 'ediff-spy-after-mouse))
246 (setq ediff-mouse-pixel-position (mouse-pixel-position))
248 ;; adjust for merge jobs
249 (if ediff-merge-job
250 (let ((buf
251 ;; If default variant is `combined', the right stuff is
252 ;; inserted by ediff-do-merge
253 ;; Note: at some point, we tried to put ancestor buffer here
254 ;; (which is currently buffer C. This didn't work right
255 ;; because the merge buffer will contain lossage: diff regions
256 ;; in the ancestor, which correspond to revisions that agree
257 ;; in both buf A and B.
258 (cond ((eq ediff-default-variant 'default-B)
259 buffer-B)
260 (t buffer-A))))
262 (setq ediff-split-window-function
263 ediff-merge-split-window-function)
265 ;; remember the ancestor buffer, if any
266 (setq ediff-ancestor-buffer buffer-C)
268 (setq buffer-C
269 (get-buffer-create
270 (ediff-unique-buffer-name "*ediff-merge" "*")))
271 (save-excursion
272 (set-buffer buffer-C)
273 (insert-buffer buf)
274 (funcall (ediff-eval-in-buffer buf major-mode))
275 ;; after Stig@hackvan.com
276 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode)
278 (setq buffer-read-only nil
279 ediff-buffer-A buffer-A
280 ediff-buffer-B buffer-B
281 ediff-buffer-C buffer-C
282 ediff-control-buffer control-buffer)
284 (setq ediff-control-buffer-suffix
285 (if (string-match "<[0-9]*>" control-buffer-name)
286 (substring control-buffer-name
287 (match-beginning 0) (match-end 0))
289 ediff-control-buffer-number
290 (max
293 (string-to-number
294 (substring
295 ediff-control-buffer-suffix
297 (string-match "[0-9]+" ediff-control-buffer-suffix)
298 0))))))
300 (setq ediff-error-buffer
301 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
303 (ediff-eval-in-buffer buffer-A (ediff-strip-mode-line-format))
304 (ediff-eval-in-buffer buffer-B (ediff-strip-mode-line-format))
305 (if ediff-3way-job
306 (ediff-eval-in-buffer buffer-C (ediff-strip-mode-line-format)))
307 (if (ediff-buffer-live-p ediff-ancestor-buffer)
308 (ediff-eval-in-buffer ediff-ancestor-buffer
309 (ediff-strip-mode-line-format)))
311 (ediff-save-protected-variables) ; save variables to be restored on exit
313 ;; ediff-setup-diff-regions-function must be set after setup
314 ;; parameters are processed.
315 (setq ediff-setup-diff-regions-function
316 (if ediff-diff3-job
317 'ediff-setup-diff-regions3
318 'ediff-setup-diff-regions))
320 (setq ediff-wide-bounds
321 (list (ediff-make-bullet-proof-overlay
322 '(point-min) '(point-max) ediff-buffer-A)
323 (ediff-make-bullet-proof-overlay
324 '(point-min) '(point-max) ediff-buffer-B)
325 (ediff-make-bullet-proof-overlay
326 '(point-min) '(point-max) ediff-buffer-C)))
328 ;; This has effect only on ediff-windows/regions
329 ;; In all other cases, ediff-visible-region sets visibility bounds to
330 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
331 (if ediff-start-narrowed
332 (setq ediff-visible-bounds ediff-narrow-bounds)
333 (setq ediff-visible-bounds ediff-wide-bounds))
335 (ediff-set-keys) ; comes after parameter setup
337 ;; set up ediff-narrow-bounds, if not set
338 (or ediff-narrow-bounds
339 (setq ediff-narrow-bounds ediff-wide-bounds))
341 ;; All these must be inside ediff-eval-in-buffer control-buffer,
342 ;; since these vars are local to control-buffer
343 ;; These won't run if there are errors in diff
344 (ediff-eval-in-buffer ediff-buffer-A
345 (ediff-nuke-selective-display)
346 (run-hooks 'ediff-prepare-buffer-hook)
347 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
348 (setq buffer-read-only t))
349 ;; add control-buffer to the list of sessions--no longer used, but may
350 ;; be used again in the future
351 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
352 (setq ediff-this-buffer-ediff-sessions
353 (cons control-buffer ediff-this-buffer-ediff-sessions)))
355 (ediff-eval-in-buffer ediff-buffer-B
356 (ediff-nuke-selective-display)
357 (run-hooks 'ediff-prepare-buffer-hook)
358 (if (ediff-eval-in-buffer control-buffer ediff-merge-job)
359 (setq buffer-read-only t))
360 ;; add control-buffer to the list of sessions
361 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
362 (setq ediff-this-buffer-ediff-sessions
363 (cons control-buffer ediff-this-buffer-ediff-sessions)))
365 (if ediff-3way-job
366 (ediff-eval-in-buffer ediff-buffer-C
367 (ediff-nuke-selective-display)
368 (run-hooks 'ediff-prepare-buffer-hook)
369 ;; add control-buffer to the list of sessions
370 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
371 (setq ediff-this-buffer-ediff-sessions
372 (cons control-buffer
373 ediff-this-buffer-ediff-sessions)))
376 (if (ediff-buffer-live-p ediff-ancestor-buffer)
377 (ediff-eval-in-buffer ediff-ancestor-buffer
378 (ediff-nuke-selective-display)
379 (setq buffer-read-only t)
380 (run-hooks 'ediff-prepare-buffer-hook)
381 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
382 (setq ediff-this-buffer-ediff-sessions
383 (cons control-buffer
384 ediff-this-buffer-ediff-sessions)))
387 ;; must come after setting up ediff-narrow-bounds AND after
388 ;; nuking selective display
389 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
390 (setq ediff-number-of-differences (length ediff-difference-vector-A))
391 (setq ediff-current-difference -1)
393 (ediff-make-current-diff-overlay 'A)
394 (ediff-make-current-diff-overlay 'B)
395 (if ediff-3way-job
396 (ediff-make-current-diff-overlay 'C))
397 (if ediff-merge-with-ancestor-job
398 (ediff-make-current-diff-overlay 'Ancestor))
400 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
402 (let ((shift-A (ediff-overlay-start
403 (ediff-get-value-according-to-buffer-type
404 'A ediff-narrow-bounds)))
405 (shift-B (ediff-overlay-start
406 (ediff-get-value-according-to-buffer-type
407 'B ediff-narrow-bounds)))
408 (shift-C (ediff-overlay-start
409 (ediff-get-value-according-to-buffer-type
410 'C ediff-narrow-bounds))))
411 ;; position point in buf A
412 (save-excursion
413 (select-window ediff-window-A)
414 (goto-char shift-A))
415 ;; position point in buf B
416 (save-excursion
417 (select-window ediff-window-B)
418 (goto-char shift-B))
419 (if ediff-3way-job
420 (save-excursion
421 (select-window ediff-window-C)
422 (goto-char shift-C)))
425 (select-window ediff-control-window)
426 (ediff-visible-region)
428 (run-hooks 'startup-hooks)
429 (ediff-refresh-mode-lines)
430 (setq buffer-read-only t)
431 (setq ediff-session-registry
432 (cons control-buffer ediff-session-registry))
433 (ediff-update-registry)
434 (if (ediff-buffer-live-p ediff-meta-buffer)
435 (ediff-update-meta-buffer ediff-meta-buffer))
436 (run-hooks 'ediff-startup-hook)
437 ) ; eval in control-buffer
438 control-buffer))
441 ;; This function assumes that we are in the window where control buffer is
442 ;; to reside.
443 (defun ediff-setup-control-buffer (ctl-buf)
444 "Set up window for control buffer."
445 (if (window-dedicated-p (selected-window))
446 (set-buffer ctl-buf) ; we are in control frame but just in case
447 (switch-to-buffer ctl-buf))
448 (let ((window-min-height 2))
449 (erase-buffer)
450 (ediff-set-help-message)
451 (insert ediff-help-message)
452 (shrink-window-if-larger-than-buffer)
453 (or (ediff-multiframe-setup-p)
454 (ediff-indent-help-message))
455 (set-buffer-modified-p nil)
456 (ediff-refresh-mode-lines)
457 (setq ediff-control-window (selected-window))
458 (setq ediff-window-config-saved
459 (format "%S%S%S%S%S%S%S"
460 ediff-control-window
461 ediff-window-A
462 ediff-window-B
463 ediff-window-C
464 ediff-split-window-function
465 (ediff-multiframe-setup-p)
466 ediff-wide-display-p))
467 (goto-char (point-min))
468 (skip-chars-forward ediff-whitespace)))
470 ;; assuming we are in control window, calculate length of the first line in
471 ;; help message
472 (defun ediff-help-message-line-length ()
473 (save-excursion
474 (goto-char (point-min))
475 (if ediff-use-long-help-message
476 (next-line 1))
477 (end-of-line)
478 (current-column)))
481 (defun ediff-indent-help-message ()
482 (let* ((shift (/ (max 0 (- (window-width (selected-window))
483 (ediff-help-message-line-length)))
485 (str (make-string shift ?\ )))
486 (save-excursion
487 (goto-char (point-min))
488 (while (< (point) (point-max))
489 (insert str)
490 (beginning-of-line)
491 (forward-line 1)))))
494 (defun ediff-set-help-message ()
495 (setq ediff-long-help-message
496 (cond ((and ediff-long-help-message-function
497 (or (symbolp ediff-long-help-message-function)
498 (consp ediff-long-help-message-function)))
499 (funcall ediff-long-help-message-function))
500 (ediff-word-mode
501 (concat ediff-long-help-message-head
502 ediff-long-help-message-word-mode
503 ediff-long-help-message-tail))
504 (ediff-narrow-job
505 (concat ediff-long-help-message-head
506 ediff-long-help-message-narrow2
507 ediff-long-help-message-tail))
508 (ediff-merge-job
509 (concat ediff-long-help-message-head
510 ediff-long-help-message-merge
511 ediff-long-help-message-tail))
512 (ediff-diff3-job
513 (concat ediff-long-help-message-head
514 ediff-long-help-message-compare3
515 ediff-long-help-message-tail))
517 (concat ediff-long-help-message-head
518 ediff-long-help-message-compare2
519 ediff-long-help-message-tail))))
520 (setq ediff-brief-help-message
521 (cond ((and ediff-brief-help-message-function
522 (or (symbolp ediff-brief-help-message-function)
523 (consp ediff-brief-help-message-function)))
524 (funcall ediff-brief-help-message-function))
525 ((stringp ediff-brief-help-message-function)
526 ediff-brief-help-message-function)
527 ((ediff-multiframe-setup-p) ediff-brief-message-string)
528 (t ; long brief msg, not multiframe --- put in the middle
529 ediff-brief-message-string)
531 (setq ediff-help-message (if ediff-use-long-help-message
532 ediff-long-help-message
533 ediff-brief-help-message))
534 (run-hooks 'ediff-display-help-hook))
538 ;;; Commands for working with Ediff
540 (defun ediff-update-diffs ()
541 "Recompute difference regions in buffers A, B, and C.
542 Buffers are not synchronized with their respective files, so changes done
543 to these buffers are not saved at this point---the user can do this later,
544 if necessary."
545 (interactive)
546 (ediff-barf-if-not-control-buffer)
547 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
548 (not (y-or-n-p "Recompute differences during merge, really? ")))
549 (error "God forbid!"))
551 (let ((point-A (ediff-eval-in-buffer ediff-buffer-A (point)))
552 ;;(point-B (ediff-eval-in-buffer ediff-buffer-B (point)))
553 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
554 (buf-A-file-name
555 (file-name-nondirectory (or (buffer-file-name ediff-buffer-A)
556 (buffer-name ediff-buffer-A)
558 (buf-B-file-name
559 (file-name-nondirectory (or (buffer-file-name ediff-buffer-B)
560 (buffer-name ediff-buffer-B)
562 (buf-C-file-name
563 (file-name-nondirectory (or (buffer-file-name ediff-buffer-C)
564 ;; if (null ediff-buffer-C), there is
565 ;; no danger, since we later check if
566 ;; ediff-buffer-C is alive
567 (buffer-name ediff-buffer-C)
569 (overl-A (ediff-get-value-according-to-buffer-type
570 'A ediff-narrow-bounds))
571 (overl-B (ediff-get-value-according-to-buffer-type
572 'B ediff-narrow-bounds))
573 (overl-C (ediff-get-value-according-to-buffer-type
574 'C ediff-narrow-bounds))
575 beg-A end-A beg-B end-B beg-C end-C
576 file-A file-B file-C)
577 (ediff-unselect-and-select-difference -1)
579 (setq beg-A (ediff-overlay-start overl-A)
580 beg-B (ediff-overlay-start overl-B)
581 beg-C (ediff-overlay-start overl-C)
582 end-A (ediff-overlay-end overl-A)
583 end-B (ediff-overlay-end overl-B)
584 end-C (ediff-overlay-end overl-C))
586 (if ediff-word-mode
587 (progn
588 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
589 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
590 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
591 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
592 (if ediff-3way-job
593 (progn
594 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
595 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
597 ;; not word-mode
598 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
599 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
600 (if ediff-3way-job
601 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
604 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
605 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
606 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
607 (ediff-clear-diff-vector
608 'ediff-difference-vector-Ancestor 'fine-diffs-also)
609 ;; let them garbage collect. we can't use the ancestor after recomputing
610 ;; the diffs.
611 (setq ediff-difference-vector-Ancestor nil
612 ediff-ancestor-buffer nil
613 ediff-state-of-merge nil)
615 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
617 ;; In case of merge job, fool it into thinking that it is just doing
618 ;; comparison
619 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
620 (ediff-3way-comparison-job ediff-3way-comparison-job)
621 (ediff-merge-job ediff-merge-job)
622 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
623 (ediff-job-name ediff-job-name))
624 (if ediff-merge-job
625 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
626 ediff-3way-comparison-job t
627 ediff-merge-job nil
628 ediff-merge-with-ancestor-job nil
629 ediff-job-name 'ediff-files3))
630 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
632 (setq ediff-number-of-differences (length ediff-difference-vector-A))
633 (delete-file file-A)
634 (delete-file file-B)
635 (if file-C
636 (delete-file file-C))
638 (if ediff-3way-job
639 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
641 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
642 (message "")
645 ;; Not bound to any key---to dangerous. A user can do it if necessary.
646 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
647 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
648 (interactive "P")
649 (ediff-barf-if-not-control-buffer)
650 (let ((bufA ediff-buffer-A)
651 (bufB ediff-buffer-B)
652 (bufC ediff-buffer-C)
653 (ctl-buf ediff-control-buffer)
654 (keep-variants ediff-keep-variants)
655 (ancestor-buf ediff-ancestor-buffer)
656 (ancestor-job ediff-merge-with-ancestor-job)
657 (merge ediff-merge-job)
658 (comparison ediff-3way-comparison-job))
659 (ediff-eval-in-buffer bufA
660 (revert-buffer t noconfirm))
661 (ediff-eval-in-buffer bufB
662 (revert-buffer t noconfirm))
663 ;; this should only be executed in a 3way comparison, not in merge
664 (if comparison
665 (ediff-eval-in-buffer bufC
666 (revert-buffer t noconfirm)))
667 (if merge
668 (progn
669 (set-buffer ctl-buf)
670 ;; the argument says whether to reverse the meaning of
671 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
672 ;; variants kept.
673 (ediff-really-quit (not keep-variants))
674 (kill-buffer bufC)
675 (if ancestor-job
676 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
677 (ediff-merge-buffers bufA bufB)))
678 (ediff-update-diffs))))
681 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
682 (defun ediff-recenter (&optional no-rehighlight)
683 "Bring the highlighted region of all buffers being compared into view.
684 Reestablish the default three-window display."
685 (interactive)
686 (ediff-barf-if-not-control-buffer)
688 ;; ;; No longer needed: XEmacs has surrogate minibuffers now.
689 ;; (if ediff-xemacs-p (setq synchronize-minibuffers t))
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)))
696 (ediff-setup-windows
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
700 (beep 1)))
703 ;; set visibility range appropriate to this invocation of Ediff.
704 (ediff-visible-region)
705 ;; raise
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
711 '(ediff-recenter
712 ediff-dir-action ediff-registry-action
713 ediff-patch-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)))
724 (progn
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))
745 (progn
746 (or no-rehighlight
747 (ediff-select-difference ediff-current-difference))
749 (ediff-recenter-one-window 'A)
750 (ediff-recenter-one-window 'B)
751 (if ediff-3way-job
752 (ediff-recenter-one-window 'C))
754 (ediff-eval-in-buffer control-buf
755 (ediff-recenter-ancestor) ; check if ancestor is alive
757 (if (and (ediff-multiframe-setup-p)
758 (not ediff-use-long-help-message)
759 (not (ediff-frame-iconified-p ediff-control-frame)))
760 ;; never grab mouse on quit in this place
761 (ediff-reset-mouse
762 control-frame
763 (eq this-command 'ediff-quit))))
765 (ediff-eval-in-buffer control-buf
766 (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 (intern (format "ediff-window-%S" buf-type)))
781 (window (if (window-live-p (symbol-value window-name))
782 (symbol-value window-name))))
784 (if (and window ediff-windows-job)
785 (set-window-start window shift))
786 (if window
787 (progn
788 (select-window window)
789 (ediff-deactivate-mark)
790 (ediff-position-region
791 (ediff-get-diff-posn buf-type 'beg nil control-buf)
792 (ediff-get-diff-posn buf-type 'end nil control-buf)
793 (ediff-get-diff-posn buf-type 'beg nil control-buf)
794 job-name
796 (select-window ctl-wind)
799 (defun ediff-recenter-ancestor ()
800 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
801 ;; visible.
802 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
803 (ediff-valid-difference-p))
804 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
805 (ctl-wind (selected-window))
806 (job-name ediff-job-name)
807 (ctl-buf ediff-control-buffer))
808 (ediff-eval-in-buffer ediff-ancestor-buffer
809 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
810 (if window
811 (progn
812 (select-window window)
813 (ediff-position-region
814 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
815 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
816 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
817 job-name))))
818 (select-window ctl-wind)
822 ;; This will have to be refined for 3way jobs
823 (defun ediff-toggle-split ()
824 "Toggle vertical/horizontal window split.
825 Does nothing if file-A and file-B are in different frames."
826 (interactive)
827 (ediff-barf-if-not-control-buffer)
828 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
829 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
830 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
831 (frame-A (if wind-A (window-frame wind-A)))
832 (frame-B (if wind-B (window-frame wind-B)))
833 (frame-C (if wind-C (window-frame wind-C))))
834 (if (or (eq frame-A frame-B)
835 (not (frame-live-p frame-A))
836 (not (frame-live-p frame-B))
837 (if ediff-3way-comparison-job
838 (or (not (frame-live-p frame-C))
839 (eq frame-A frame-C) (eq frame-B frame-C))))
840 (setq ediff-split-window-function
841 (if (eq ediff-split-window-function 'split-window-vertically)
842 'split-window-horizontally
843 'split-window-vertically))
844 (message "Buffers being compared are in different frames"))
845 (ediff-recenter 'no-rehighlight)))
847 (defun ediff-toggle-hilit ()
848 "Switch between highlighting using ASCII flags and highlighting using faces.
849 On a dumb terminal, switches between ASCII highlighting and no highlighting."
850 (interactive)
851 (ediff-barf-if-not-control-buffer)
852 (if (not (ediff-has-face-support-p))
853 (if (eq ediff-highlighting-style 'ascii)
854 (progn
855 (message "ASCII highlighting flags removed")
856 (ediff-unselect-and-select-difference ediff-current-difference
857 'unselect-only)
858 (setq ediff-highlighting-style 'off))
859 (ediff-unselect-and-select-difference ediff-current-difference
860 'select-only))
861 (ediff-unselect-and-select-difference ediff-current-difference
862 'unselect-only)
863 ;; cycle through highlighting
864 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
865 (message "Unhighlighting unselected difference regions")
866 (setq ediff-highlight-all-diffs nil))
867 (ediff-use-faces
868 (message "Highlighting with ASCII flags")
869 (setq ediff-use-faces nil))
871 (message "Re-highlighting all difference regions")
872 (setq ediff-use-faces t
873 ediff-highlight-all-diffs t)))
875 (if (and ediff-use-faces ediff-highlight-all-diffs)
876 (ediff-color-background-regions)
877 (ediff-color-background-regions 'unhighlight))
879 (ediff-unselect-and-select-difference
880 ediff-current-difference 'select-only))
883 (defun ediff-toggle-autorefine ()
884 "Toggle auto-refine mode."
885 (interactive)
886 (ediff-barf-if-not-control-buffer)
887 (if ediff-word-mode
888 (error "No fine differences in this mode"))
889 (cond ((eq ediff-auto-refine 'nix)
890 (setq ediff-auto-refine 'on)
891 (ediff-make-fine-diffs ediff-current-difference 'noforce)
892 (message "Auto-refining is ON"))
893 ((eq ediff-auto-refine 'on)
894 (message "Auto-refining is OFF")
895 (setq ediff-auto-refine 'off))
896 (t ;; nix 'em
897 (ediff-set-fine-diff-properties ediff-current-difference 'default)
898 (message "Refinements are HIDDEN")
899 (setq ediff-auto-refine 'nix))
902 (defun ediff-show-ancestor ()
903 "Show the ancestor buffer in a suitable window."
904 (interactive)
905 (ediff-recenter)
906 (or (ediff-buffer-live-p ediff-ancestor-buffer)
907 (if ediff-merge-with-ancestor-job
908 (error "Lost connection to ancestor buffer...sorry")
909 (error "Not merging with ancestor")))
910 (let (wind)
911 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
912 (raise-frame (window-frame wind)))
913 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
915 (defun ediff-make-or-kill-fine-diffs (arg)
916 "Compute fine diffs. With negative prefix arg, kill fine diffs.
917 In both cases, operates on the currrent difference region."
918 (interactive "P")
919 (ediff-barf-if-not-control-buffer)
920 (cond ((eq arg '-)
921 (ediff-clear-fine-differences ediff-current-difference))
922 ((and (numberp arg) (< arg 0))
923 (ediff-clear-fine-differences ediff-current-difference))
924 (t (ediff-make-fine-diffs))))
927 (defun ediff-toggle-help ()
928 "Toggle short/long help message."
929 (interactive)
930 (ediff-barf-if-not-control-buffer)
931 (let (buffer-read-only)
932 (erase-buffer)
933 (setq ediff-use-long-help-message (not ediff-use-long-help-message))
934 (ediff-set-help-message))
935 ;; remember the icon status of the control frame when the user requested
936 ;; full control message
937 (if (and ediff-use-long-help-message (ediff-multiframe-setup-p))
938 (setq ediff-prefer-iconified-control-frame
939 (ediff-frame-iconified-p ediff-control-frame)))
941 (setq ediff-window-config-saved "") ; force redisplay
942 (ediff-recenter 'no-rehighlight))
945 ;; If BUF, this is the buffer to toggle, not current buffer.
946 (defun ediff-toggle-read-only (&optional buf)
947 "Toggle read-only in current buffer.
948 If buffer is under version control and locked, check it out first.
949 If optional argument BUF is specified, toggle read-only in that buffer instead
950 of the current buffer."
951 (interactive)
952 (ediff-barf-if-not-control-buffer)
953 (let ((ctl-buf (if (null buf) (current-buffer)))
954 (buf-type (ediff-char-to-buftype last-command-char)))
955 (or buf (ediff-recenter))
956 (or buf
957 (setq buf (ediff-get-buffer buf-type)))
959 (ediff-eval-in-buffer buf ; eval in buf A/B/C
960 (let* ((file (buffer-file-name buf))
961 (file-writable (and file
962 (file-exists-p file)
963 (file-writable-p file)))
964 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
965 ((ediff-file-checked-out-p file)
966 'toggle-read-only)
967 (file-writable 'toggle-read-only)
968 (t (key-binding "\C-x\C-q")))))
969 ;; If the file is checked in, make sure we don't make buffer modifiable
970 ;; without warning the user. The user can fool our checks by making the
971 ;; buffer non-RO without checking the file out. We regard this as a
972 ;; user problem.
973 (if (and (ediff-file-checked-in-p file)
974 ;; If ctl-buf is null, this means we called this
975 ;; non-interactively, in which case don't ask questions
976 ctl-buf)
977 (cond ((not buffer-read-only)
978 (setq toggle-ro-cmd 'toggle-read-only))
979 ((and (or (beep 1) t) ; always beep
980 (y-or-n-p
981 (format
982 "File %s is under version control. Check it out? "
983 (ediff-abbreviate-file-name file))))
984 ;; if we checked the file out, we should also change the
985 ;; original state of buffer-read-only to nil. If we don't
986 ;; do this, the mode line will show %%, since the file was
987 ;; RO before ediff started, so the user will think the file
988 ;; is checked in.
989 (ediff-eval-in-buffer ctl-buf
990 (ediff-change-saved-variable
991 'buffer-read-only nil buf-type)))
993 (setq toggle-ro-cmd 'toggle-read-only)
994 (beep 1) (beep 1)
995 (message
996 "Boy, this is risky! Better don't change this file...")
997 (sit-for 3)))) ; let the user see the warning
998 (if (and toggle-ro-cmd
999 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1000 (save-excursion
1001 (save-window-excursion
1002 (command-execute toggle-ro-cmd)))
1003 (error "Don't know how to toggle read-only in buffer %S" buf))
1005 ;; Check if we made the current buffer updatable, but its file is RO.
1006 ;; Signal a warning in this case.
1007 (if (and file (not buffer-read-only)
1008 (eq this-command 'ediff-toggle-read-only)
1009 (file-exists-p file)
1010 (not (file-writable-p file)))
1011 (message "Warning: file %s is read-only"
1012 (ediff-abbreviate-file-name file) (beep 1)))
1013 ))))
1016 ;; This is a simple-minded check for whether a file is under version control
1017 ;; and is checked out.
1018 ;; If file,v exists but file doesn't, this file is considered to be not checked
1019 ;; in and not checked out for the purpose of patching (since patch won't be
1020 ;; able to read such a file anyway).
1021 ;; FILE is a string representing file name
1022 (defun ediff-file-checked-out-p (file)
1023 (and (stringp file)
1024 (file-exists-p file)
1025 (file-writable-p file)
1027 (file-exists-p (concat file ",v"))
1028 (file-exists-p (concat "RCS/" file ",v")))
1030 (defun ediff-file-checked-in-p (file)
1031 (and (stringp file)
1032 (file-exists-p file)
1033 (not (file-writable-p file))
1035 (file-exists-p (concat file ",v"))
1036 (file-exists-p (concat "RCS/" file ",v")))
1039 (defun ediff-swap-buffers ()
1040 "Rotate the display of buffers A, B, and C."
1041 (interactive)
1042 (ediff-barf-if-not-control-buffer)
1043 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1044 (let ((buf ediff-buffer-A)
1045 (values ediff-buffer-values-orig-A)
1046 (diff-vec ediff-difference-vector-A)
1047 (hide-regexp ediff-regexp-hide-A)
1048 (focus-regexp ediff-regexp-focus-A)
1049 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1050 (overlay (if (ediff-has-face-support-p)
1051 ediff-current-diff-overlay-A)))
1052 (if ediff-3way-comparison-job
1053 (progn
1054 (set-window-buffer ediff-window-A ediff-buffer-C)
1055 (set-window-buffer ediff-window-B ediff-buffer-A)
1056 (set-window-buffer ediff-window-C ediff-buffer-B)
1058 (set-window-buffer ediff-window-A ediff-buffer-B)
1059 (set-window-buffer ediff-window-B ediff-buffer-A))
1060 ;; swap diff buffers
1061 (if ediff-3way-comparison-job
1062 (setq ediff-buffer-A ediff-buffer-C
1063 ediff-buffer-C ediff-buffer-B
1064 ediff-buffer-B buf)
1065 (setq ediff-buffer-A ediff-buffer-B
1066 ediff-buffer-B buf))
1068 ;; swap saved buffer characteristics
1069 (if ediff-3way-comparison-job
1070 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1071 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1072 ediff-buffer-values-orig-B values)
1073 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1074 ediff-buffer-values-orig-B values))
1076 ;; swap diff vectors
1077 (if ediff-3way-comparison-job
1078 (setq ediff-difference-vector-A ediff-difference-vector-C
1079 ediff-difference-vector-C ediff-difference-vector-B
1080 ediff-difference-vector-B diff-vec)
1081 (setq ediff-difference-vector-A ediff-difference-vector-B
1082 ediff-difference-vector-B diff-vec))
1084 ;; swap hide/focus regexp
1085 (if ediff-3way-comparison-job
1086 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1087 ediff-regexp-hide-C ediff-regexp-hide-B
1088 ediff-regexp-hide-B hide-regexp
1089 ediff-regexp-focus-A ediff-regexp-focus-C
1090 ediff-regexp-focus-C ediff-regexp-focus-B
1091 ediff-regexp-focus-B focus-regexp)
1092 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1093 ediff-regexp-hide-B hide-regexp
1094 ediff-regexp-focus-A ediff-regexp-focus-B
1095 ediff-regexp-focus-B focus-regexp))
1097 ;; The following is needed for XEmacs, since there one can't move
1098 ;; overlay to another buffer. In Emacs, this swap is redundant.
1099 (if (ediff-has-face-support-p)
1100 (if ediff-3way-comparison-job
1101 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1102 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1103 ediff-current-diff-overlay-B overlay)
1104 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1105 ediff-current-diff-overlay-B overlay)))
1107 ;; swap wide bounds
1108 (setq ediff-wide-bounds
1109 (cond (ediff-3way-comparison-job
1110 (list (nth 2 ediff-wide-bounds)
1111 (nth 0 ediff-wide-bounds)
1112 (nth 1 ediff-wide-bounds)))
1113 (ediff-3way-job
1114 (list (nth 1 ediff-wide-bounds)
1115 (nth 0 ediff-wide-bounds)
1116 (nth 2 ediff-wide-bounds)))
1118 (list (nth 1 ediff-wide-bounds)
1119 (nth 0 ediff-wide-bounds)))))
1120 ;; swap narrow bounds
1121 (setq ediff-narrow-bounds
1122 (cond (ediff-3way-comparison-job
1123 (list (nth 2 ediff-narrow-bounds)
1124 (nth 0 ediff-narrow-bounds)
1125 (nth 1 ediff-narrow-bounds)))
1126 (ediff-3way-job
1127 (list (nth 1 ediff-narrow-bounds)
1128 (nth 0 ediff-narrow-bounds)
1129 (nth 2 ediff-narrow-bounds)))
1131 (list (nth 1 ediff-narrow-bounds)
1132 (nth 0 ediff-narrow-bounds)))))
1133 (if wide-visibility-p
1134 (setq ediff-visible-bounds ediff-wide-bounds)
1135 (setq ediff-visible-bounds ediff-narrow-bounds))
1137 (if ediff-3way-job
1138 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1139 (ediff-recenter 'no-rehighlight)
1143 (defun ediff-toggle-wide-display ()
1144 "Toggle wide/regular display.
1145 This is especially useful when comparing buffers side-by-side."
1146 (interactive)
1147 (ediff-barf-if-not-control-buffer)
1148 (or (ediff-window-display-p)
1149 (error "%sEmacs is not running as a window application"
1150 (if ediff-emacs-p "" "X")))
1151 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1152 (let ((ctl-buf ediff-control-buffer))
1153 (setq ediff-wide-display-p (not ediff-wide-display-p))
1154 (if (not ediff-wide-display-p)
1155 (ediff-eval-in-buffer ctl-buf
1156 (modify-frame-parameters
1157 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1158 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1159 ;; restore control buf, since ctl window may have been deleted
1160 ;; during resizing
1161 (set-buffer ctl-buf)
1162 (setq ediff-wide-display-orig-parameters nil
1163 ediff-window-B nil) ; force update of window config
1164 (ediff-recenter 'no-rehighlight))
1165 (funcall ediff-make-wide-display-function)
1166 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1167 (ediff-eval-in-buffer ctl-buf
1168 (setq ediff-window-B nil) ; force update of window config
1169 (ediff-recenter 'no-rehighlight)))))
1171 (defun ediff-toggle-multiframe ()
1172 "Switch from the multiframe display to single-frame display and back.
1173 This is primarily for debugging, but one can use it for fun, too."
1174 (interactive)
1175 (ediff-barf-if-not-control-buffer)
1176 (or (ediff-window-display-p)
1177 (error "%sEmacs is not running as a window application"
1178 (if ediff-emacs-p "" "X")))
1179 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1180 (setq ediff-window-setup-function 'ediff-setup-windows-plain))
1181 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1182 (setq ediff-window-setup-function 'ediff-setup-windows-multiframe)))
1183 (setq ediff-window-B nil)
1184 (ediff-recenter 'no-rehighlight))
1186 ;; Merging
1188 (defun ediff-toggle-show-clashes-only ()
1189 "Toggle the mode where only the regions where both buffers differ with the ancestor are shown."
1190 (interactive)
1191 (ediff-barf-if-not-control-buffer)
1192 (if (not ediff-merge-with-ancestor-job)
1193 (error "This command makes sense only when merging with an ancestor"))
1194 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1195 (if ediff-show-clashes-only
1196 (message "Focus on regions where both buffers differ from the ancestor")
1197 (message "Canceling focus on regions where changes clash")))
1199 ;; Widening/narrowing
1201 (defun ediff-toggle-narrow-region ()
1202 "Toggle narrowing in buffers A, B, and C.
1203 Used in ediff-windows/regions only."
1204 (interactive)
1205 (if (eq ediff-buffer-A ediff-buffer-B)
1206 (error ediff-NO-DIFFERENCES))
1207 (if (eq ediff-visible-bounds ediff-wide-bounds)
1208 (setq ediff-visible-bounds ediff-narrow-bounds)
1209 (setq ediff-visible-bounds ediff-wide-bounds))
1210 (ediff-recenter 'no-rehighlight))
1212 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1213 ;; ediff-wide-bounds, then this actually widens.
1214 ;; This function does nothing if job-name is not
1215 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1216 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1217 ;; to two different regions in one buffer.
1218 (defun ediff-visible-region ()
1219 (if (or (eq ediff-buffer-A ediff-buffer-B)
1220 (eq ediff-buffer-A ediff-buffer-C)
1221 (eq ediff-buffer-C ediff-buffer-B))
1223 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1224 ;; Otherwise, always use full range.
1225 (if (not ediff-narrow-job)
1226 (setq ediff-visible-bounds ediff-wide-bounds))
1227 (let ((overl-A (ediff-get-value-according-to-buffer-type
1228 'A ediff-visible-bounds))
1229 (overl-B (ediff-get-value-according-to-buffer-type
1230 'B ediff-visible-bounds))
1231 (overl-C (ediff-get-value-according-to-buffer-type
1232 'C ediff-visible-bounds))
1234 (ediff-eval-in-buffer ediff-buffer-A
1235 (narrow-to-region
1236 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A)))
1237 (ediff-eval-in-buffer ediff-buffer-B
1238 (narrow-to-region
1239 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B)))
1241 (if ediff-3way-comparison-job
1242 (ediff-eval-in-buffer ediff-buffer-C
1243 (narrow-to-region
1244 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1248 ;; Window scrolling operations
1250 ;; Performs some operation on the two file windows (if they are showing).
1251 ;; Traps all errors on the operation in windows A/B/C.
1252 ;; Usually, errors come from scrolling off the
1253 ;; beginning or end of the buffer, and this gives error messages.
1254 (defun ediff-operate-on-windows (operation arg)
1256 ;; make sure windows aren't dead
1257 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1258 (ediff-recenter 'no-rehighlight))
1259 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1260 (ediff-buffer-live-p ediff-buffer-B)
1261 (or (not ediff-3way-job) ediff-buffer-C)
1263 (error ediff-KILLED-VITAL-BUFFER))
1265 (let* ((wind (selected-window))
1266 (wind-A ediff-window-A)
1267 (wind-B ediff-window-B)
1268 (wind-C ediff-window-C)
1269 (coefA (ediff-get-region-size-coefficient 'A operation))
1270 (coefB (ediff-get-region-size-coefficient 'B operation))
1271 (three-way ediff-3way-job)
1272 (coefC (if three-way
1273 (ediff-get-region-size-coefficient 'C operation))))
1275 (select-window wind-A)
1276 (condition-case nil
1277 (funcall operation (round (* coefA arg)))
1278 (error))
1279 (select-window wind-B)
1280 (condition-case nil
1281 (funcall operation (round (* coefB arg)))
1282 (error))
1283 (if three-way
1284 (progn
1285 (select-window wind-C)
1286 (condition-case nil
1287 (funcall operation (round (* coefC arg)))
1288 (error))))
1289 (select-window wind)))
1291 (defun ediff-scroll-vertically (&optional arg)
1292 "Vertically scroll buffers A, B \(and C if appropriate\).
1293 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1294 the one half of the height of window-A."
1295 (interactive "P")
1296 (ediff-barf-if-not-control-buffer)
1298 ;; make sure windows aren't dead
1299 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1300 (ediff-recenter 'no-rehighlight))
1301 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1302 (ediff-buffer-live-p ediff-buffer-B)
1303 (or (not ediff-3way-job)
1304 (ediff-buffer-live-p ediff-buffer-C))
1306 (error ediff-KILLED-VITAL-BUFFER))
1308 (ediff-operate-on-windows
1309 (if (memq last-command-char '(?v ?\C-v))
1310 'scroll-up
1311 'scroll-down)
1312 ;; calculate argument to scroll-up/down
1313 ;; if there is an explicit argument
1314 (if (and arg (not (equal arg '-)))
1315 ;; use it
1316 (prefix-numeric-value arg)
1317 ;; if not, see if we can determine a default amount (the window height)
1318 (let (default-amount)
1319 (setq default-amount
1320 (- (/ (min (window-height ediff-window-A)
1321 (window-height ediff-window-B)
1322 (if ediff-3way-job
1323 (window-height ediff-window-C)
1324 500)) ; some large number
1326 1 next-screen-context-lines))
1327 ;; window found
1328 (if arg
1329 ;; C-u as argument means half of default amount
1330 (/ default-amount 2)
1331 ;; no argument means default amount
1332 default-amount)))))
1335 (defun ediff-scroll-horizontally (&optional arg)
1336 "Horizontally scroll buffers A, B \(and C if appropriate\).
1337 If an argument is given, that is how many columns are scrolled, else nearly
1338 the width of the A/B/C windows."
1339 (interactive "P")
1340 (ediff-barf-if-not-control-buffer)
1342 ;; make sure windows aren't dead
1343 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1344 (ediff-recenter 'no-rehighlight))
1345 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1346 (ediff-buffer-live-p ediff-buffer-B)
1347 (or (not ediff-3way-job)
1348 (ediff-buffer-live-p ediff-buffer-C))
1350 (error ediff-KILLED-VITAL-BUFFER))
1352 (ediff-operate-on-windows
1353 (if (= last-command-char ?<)
1354 'scroll-left
1355 'scroll-right)
1356 ;; calculate argument to scroll-left/right
1357 ;; if there is an explicit argument
1358 (if (and arg (not (equal arg '-)))
1359 ;; use it
1360 (prefix-numeric-value arg)
1361 ;; if not, see if we can determine a default amount
1362 ;; (half the window width)
1363 (if (null ediff-control-window)
1364 ;; no control window, use nil
1366 (let ((default-amount
1367 (- (/ (min (window-width ediff-window-A)
1368 (window-width ediff-window-B)
1369 (if ediff-3way-comparison-job
1370 (window-width ediff-window-C)
1371 500) ; some large number
1374 3)))
1375 ;; window found
1376 (if arg
1377 ;; C-u as argument means half of default amount
1378 (/ default-amount 2)
1379 ;; no argument means default amount
1380 default-amount))))))
1383 ;;BEG, END show the region to be positioned.
1384 ;;JOB-NAME holds ediff-job-name. Ediff-windows job positions regions
1385 ;;differently.
1386 (defun ediff-position-region (beg end pos job-name)
1387 (if (> end (point-max))
1388 (setq end (point-max)))
1389 (if ediff-windows-job
1390 (if (pos-visible-in-window-p end)
1391 () ; do nothing, wind is already positioned
1392 ;; at this point, windows are positioned at the beginning of the
1393 ;; file regions (not diff-regions) being compared.
1394 (save-excursion
1395 (move-to-window-line (- (window-height) 2))
1396 (let ((amount (+ 2 (count-lines (point) end))))
1397 (scroll-up amount))))
1398 (set-window-start (selected-window) beg)
1399 (if (pos-visible-in-window-p end)
1400 ;; Determine the number of lines that the region occupies
1401 (let ((lines 0)
1402 (prev-point 0))
1403 (while ( and (> end (progn
1404 (move-to-window-line lines)
1405 (point)))
1406 ;; `end' may be beyond the window bottom, so check
1407 ;; that we are making progress
1408 (< prev-point (point)))
1409 (setq prev-point (point))
1410 (setq lines (1+ lines)))
1411 ;; And position the beginning on the right line
1412 (goto-char beg)
1413 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1414 lines)
1417 2))))
1418 (goto-char pos)
1421 ;; get number of lines from window start to region end
1422 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1423 (or n (setq n ediff-current-difference))
1424 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1425 (ediff-eval-in-buffer ctl-buf
1426 (let* ((buf (ediff-get-buffer buf-type))
1427 (wind (eval (intern (format "ediff-window-%S" buf-type))))
1428 (beg (window-start wind))
1429 (end (ediff-get-diff-posn buf-type 'end))
1430 lines)
1431 (ediff-eval-in-buffer buf
1432 (if (< beg end)
1433 (setq lines (count-lines beg end))
1434 (setq lines 0))
1435 lines
1436 ))))
1438 ;; get number of lines from window end to region start
1439 (defun ediff-get-lines-to-region-start (buf-type &optional n ctl-buf)
1440 (or n (setq n ediff-current-difference))
1441 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1442 (ediff-eval-in-buffer ctl-buf
1443 (let* ((buf (ediff-get-buffer buf-type))
1444 (wind (eval (intern (format "ediff-window-%S" buf-type))))
1445 (end (window-end wind))
1446 (beg (ediff-get-diff-posn buf-type 'beg)))
1447 (ediff-eval-in-buffer buf
1448 (if (< beg end) (count-lines beg end) 0))
1452 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1453 (ediff-eval-in-buffer (or ctl-buf ediff-control-buffer)
1454 (let* ((func (cond ((eq op 'scroll-down) 'ediff-get-lines-to-region-start)
1455 ((eq op 'scroll-up) 'ediff-get-lines-to-region-end)
1456 (t '(lambda (a b c) 0))))
1457 (max-lines (max (funcall func 'A n ctl-buf)
1458 (funcall func 'B n ctl-buf)
1459 (if (ediff-buffer-live-p ediff-buffer-C)
1460 (funcall func 'C n ctl-buf)
1461 0))))
1462 ;; this covers the horizontal coefficient as well:
1463 ;; if max-lines = 0 then coef = 1
1464 (if (> max-lines 0)
1465 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1466 (+ max-lines 0.0))
1471 (defun ediff-next-difference (&optional arg)
1472 "Advance to the next difference.
1473 With a prefix argument, go back that many differences."
1474 (interactive "P")
1475 (ediff-barf-if-not-control-buffer)
1476 (if (< ediff-current-difference ediff-number-of-differences)
1477 (let ((n (min ediff-number-of-differences
1478 (+ ediff-current-difference (if arg arg 1))))
1479 regexp-skip)
1481 (or (>= n ediff-number-of-differences)
1482 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1483 (ediff-install-fine-diff-if-necessary n))
1484 (while (and (< n ediff-number-of-differences)
1486 ;; regexp skip
1487 regexp-skip
1488 ;; skip clashes, if necessary
1489 (and ediff-show-clashes-only
1490 (string-match "prefer"
1491 (or (ediff-get-state-of-merge n) "")))
1492 ;; skip difference regions that differ in white space
1493 (and ediff-ignore-similar-regions
1494 (ediff-no-fine-diffs-p n))))
1495 (setq n (1+ n))
1496 (if (= 0 (mod n 20))
1497 (message "Skipped over region %d and counting ..." n))
1498 (or (>= n ediff-number-of-differences)
1499 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1500 (ediff-install-fine-diff-if-necessary n))
1502 (message "")
1503 (ediff-unselect-and-select-difference n)
1504 ) ; let
1505 (ediff-visible-region)
1506 (error "At end of the difference list")))
1508 (defun ediff-previous-difference (&optional arg)
1509 "Go to the previous difference.
1510 With a prefix argument, go back that many differences."
1511 (interactive "P")
1512 (ediff-barf-if-not-control-buffer)
1513 (if (> ediff-current-difference -1)
1514 (let ((n (max -1 (- ediff-current-difference (if arg arg 1))))
1515 regexp-skip)
1517 (or (< n 0)
1518 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1519 (ediff-install-fine-diff-if-necessary n))
1520 (while (and (> n -1)
1522 ;; regexp skip
1523 regexp-skip
1524 ;; skip clashes, if necessary
1525 (and ediff-show-clashes-only
1526 (string-match "prefer"
1527 (or (ediff-get-state-of-merge n) "")))
1528 ;; skip difference regions that differ in white space
1529 (and ediff-ignore-similar-regions
1530 (ediff-no-fine-diffs-p n))))
1531 (if (= 0 (mod (1+ n) 20))
1532 (message "Skipped over region %d and counting ..." (1+ n)))
1533 (setq n (1- n))
1534 (or (< n 0)
1535 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1536 (ediff-install-fine-diff-if-necessary n))
1538 (message "")
1539 (ediff-unselect-and-select-difference n)
1540 ) ; let
1541 (ediff-visible-region)
1542 (error "At beginning of the difference list")))
1544 (defun ediff-jump-to-difference (difference-number)
1545 "Go to the difference specified as a prefix argument."
1546 (interactive "p")
1547 (ediff-barf-if-not-control-buffer)
1548 (setq difference-number (1- difference-number))
1549 (if (and (>= difference-number -1)
1550 (< difference-number (1+ ediff-number-of-differences)))
1551 (ediff-unselect-and-select-difference difference-number)
1552 (error "Bad difference number, %d. Valid numbers are 1 to %d"
1553 (1+ difference-number) ediff-number-of-differences)))
1555 (defun ediff-jump-to-difference-at-point ()
1556 "Go to difference closest to the point in buffer A, B, or C.
1557 The type of buffer depends on last command character \(a, b, or c\) that
1558 invoked this command."
1559 (interactive)
1560 (ediff-barf-if-not-control-buffer)
1561 (let ((buf-type (ediff-char-to-buftype last-command-char)))
1562 (ediff-jump-to-difference (ediff-diff-at-point buf-type))))
1565 ;; find region most related to the current point position (or POS, if given)
1566 (defun ediff-diff-at-point (buf-type &optional pos)
1567 (let ((buffer (ediff-get-buffer buf-type))
1568 (ctl-buffer ediff-control-buffer)
1569 (max-dif-num (1- ediff-number-of-differences))
1570 (diff-no -1)
1571 (prev-beg 0)
1572 (prev-end 0)
1573 (beg 0)
1574 (end 0))
1576 (ediff-eval-in-buffer buffer
1577 (setq pos (or pos (point)))
1578 (while (and (or (< pos prev-beg) (> pos beg))
1579 (< diff-no max-dif-num))
1580 (setq diff-no (1+ diff-no))
1581 (setq prev-beg beg
1582 prev-end end)
1583 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1584 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1587 (if (< (abs (- pos prev-end))
1588 (abs (- pos beg)))
1589 diff-no
1590 (1+ diff-no)) ; jump-to-diff works with diff nums higher by 1
1594 ;;; Copying diffs.
1596 (defun ediff-diff-to-diff (arg &optional keys)
1597 "Copy buffer-X'th difference region to buffer Y \(X,Y are A, B, or C\).
1598 If numerical prefix argument, copy the difference specified in the arg.
1599 Otherwise, copy the difference given by `ediff-current-difference'.
1600 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1601 `ac', etc., which is used to determine the types of buffers to be used for
1602 copying difference regions. The first character in the sequence specifies
1603 the source buffer and the second specifies the target.
1605 If the second optional argument, a 2-character string, is given, use it to
1606 determine the source and the target buffers instead of the command keys."
1607 (interactive "P")
1608 (ediff-barf-if-not-control-buffer)
1609 (or keys (setq keys (this-command-keys)))
1610 (if (numberp arg)
1611 (ediff-jump-to-difference arg))
1612 (let* ((key1 (aref keys 0))
1613 (key2 (aref keys 1))
1614 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1615 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2))
1616 ediff-verbose-p)
1617 (ediff-copy-diff ediff-current-difference
1618 (ediff-char-to-buftype char1)
1619 (ediff-char-to-buftype char2))
1620 ;; recenter with rehighlighting, but no messages
1621 (ediff-recenter)))
1623 (defun ediff-copy-A-to-B (arg)
1624 "Copy ARGth difference region from buffer A to B.
1625 ARG is a prefix argument. If nil, copy the current difference region."
1626 (interactive "P")
1627 (ediff-diff-to-diff arg "ab"))
1629 (defun ediff-copy-B-to-A (arg)
1630 "Copy ARGth difference region from buffer B to A.
1631 ARG is a prefix argument. If nil, copy the current difference region."
1632 (interactive "P")
1633 (ediff-diff-to-diff arg "ba"))
1635 (defun ediff-copy-A-to-C (arg)
1636 "Copy ARGth difference region from buffer A to buffer C.
1637 ARG is a prefix argument. If nil, copy the current difference region."
1638 (interactive "P")
1639 (ediff-diff-to-diff arg "ac"))
1641 (defun ediff-copy-B-to-C (arg)
1642 "Copy ARGth difference region from buffer B to buffer C.
1643 ARG is a prefix argument. If nil, copy the current difference region."
1644 (interactive "P")
1645 (ediff-diff-to-diff arg "bc"))
1647 (defun ediff-copy-C-to-B (arg)
1648 "Copy ARGth difference region from buffer C to B.
1649 ARG is a prefix argument. If nil, copy the current difference region."
1650 (interactive "P")
1651 (ediff-diff-to-diff arg "cb"))
1653 (defun ediff-copy-C-to-A (arg)
1654 "Copy ARGth difference region from buffer C to A.
1655 ARG is a prefix argument. If nil, copy the current difference region."
1656 (interactive "P")
1657 (ediff-diff-to-diff arg "ca"))
1661 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1662 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1663 ;; target diff. This is used in merging, when constructing the merged
1664 ;; version.
1665 (defun ediff-copy-diff (n from-buf-type to-buf-type
1666 &optional batch-invocation reg-to-copy)
1667 (let* ((to-buf (ediff-get-buffer to-buf-type))
1668 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1669 (ctrl-buf ediff-control-buffer)
1670 (saved-p t)
1671 (three-way ediff-3way-job)
1672 messg
1673 ediff-verbose-p
1674 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1676 (setq reg-to-delete-beg
1677 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1678 (setq reg-to-delete-end
1679 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1681 (if reg-to-copy
1682 (setq from-buf-type nil)
1683 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1685 (setq reg-to-delete (ediff-get-region-contents
1686 n to-buf-type ctrl-buf
1687 reg-to-delete-beg reg-to-delete-end))
1689 (if (string= reg-to-delete reg-to-copy)
1690 (setq saved-p nil) ; don't copy identical buffers
1691 ;; seems ok to copy
1692 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1693 (condition-case conds
1694 (progn
1695 (ediff-eval-in-buffer to-buf
1696 ;; to prevent flags from interfering if buffer is writable
1697 (let ((inhibit-read-only (null buffer-read-only)))
1699 (goto-char reg-to-delete-end)
1700 (insert reg-to-copy)
1702 (if (> reg-to-delete-end reg-to-delete-beg)
1703 (kill-region reg-to-delete-beg reg-to-delete-end))
1705 (or batch-invocation
1706 (setq
1707 messg
1708 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1709 (error (message "ediff-copy-diff: %s %s"
1710 (car conds)
1711 (mapconcat 'prin1-to-string (cdr conds) " "))
1712 (beep 1)
1713 (sit-for 2) ; let the user see the error msg
1714 (setq saved-p nil)
1718 ;; adjust state of difference in case 3-way and diff was copied ok
1719 (if (and saved-p three-way)
1720 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
1722 (if batch-invocation
1723 (ediff-clear-fine-differences n)
1724 ;; If diff3 job, we should recompute fine diffs so we clear them
1725 ;; before reinserting flags (and thus before ediff-recenter).
1726 (if (and saved-p three-way)
1727 (ediff-clear-fine-differences n))
1729 (ediff-refresh-mode-lines)
1731 ;; For diff2 jobs, don't recompute fine diffs, since we know there
1732 ;; aren't any. So we clear diffs after ediff-recenter.
1733 (if (and saved-p (not three-way))
1734 (ediff-clear-fine-differences n))
1735 ;; Make sure that the message about saving and how to restore is seen
1736 ;; by the user
1737 (message messg))
1740 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
1741 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
1742 ;; is the region to save. It is redundant here, but is passed anyway, for
1743 ;; convenience.
1744 (defun ediff-save-diff-region (n buf-type reg)
1745 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1746 (buf (ediff-get-buffer buf-type))
1747 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1749 (if this-buf-n-th-diff-saved
1750 ;; either nothing saved for n-th diff and buffer or we OK'ed
1751 ;; overriding
1752 (setcdr this-buf-n-th-diff-saved reg)
1753 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
1754 (nconc n-th-diff-saved (list (cons buf reg)))
1755 (setq ediff-killed-diffs-alist ;; create record for n-th diff
1756 (cons (list n (cons buf reg))
1757 ediff-killed-diffs-alist))))
1758 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
1759 (1+ n) buf-type
1760 (if ediff-merge-job
1761 "" (downcase (symbol-name buf-type))))
1764 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
1765 (defun ediff-test-save-region (n buf-type)
1766 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
1767 (buf (ediff-get-buffer buf-type))
1768 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
1770 (if this-buf-n-th-diff-saved
1771 (if (yes-or-no-p
1772 (format
1773 "You've previously copied diff region %d to buffer %S. Confirm "
1774 (1+ n) buf-type))
1776 (error "Quit"))
1777 t)))
1779 (defun ediff-pop-diff (n buf-type)
1780 "Pop last killed Nth diff region from buffer BUF-TYPE."
1781 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
1782 (buf (ediff-get-buffer buf-type))
1783 (saved-rec (assoc buf (cdr n-th-record)))
1784 (three-way ediff-3way-job)
1785 (ctl-buf ediff-control-buffer)
1786 ediff-verbose-p
1787 saved-diff reg-beg reg-end recovered)
1789 (if (cdr saved-rec)
1790 (setq saved-diff (cdr saved-rec))
1791 (if (> ediff-number-of-differences 0)
1792 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
1793 (error ediff-NO-DIFFERENCES)))
1795 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
1796 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
1798 (condition-case conds
1799 (ediff-eval-in-buffer buf
1800 (let ((inhibit-read-only (null buffer-read-only)))
1802 (goto-char reg-end)
1803 (insert saved-diff)
1805 (if (> reg-end reg-beg)
1806 (kill-region reg-beg reg-end))
1808 (setq recovered t)
1810 (error (message "ediff-pop-diff: %s %s"
1811 (car conds)
1812 (mapconcat 'prin1-to-string (cdr conds) " "))
1813 (beep 1)))
1815 ;; Clearing fine diffs is necessary for
1816 ;; ediff-unselect-and-select-difference to properly recompute them. We
1817 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
1818 ;; have modified diff regions after copying and, thus, may have recomputed
1819 ;; fine diffs.
1820 (if recovered
1821 (ediff-clear-fine-differences n))
1823 ;; adjust state of difference
1824 (if (and three-way recovered)
1825 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
1827 (ediff-refresh-mode-lines)
1829 (if recovered
1830 (progn
1831 (setq n-th-record (delq saved-rec n-th-record))
1832 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
1836 (defun ediff-restore-diff (arg &optional key)
1837 "Restore ARGth diff from `ediff-killed-diffs-alist'.
1838 ARG is a prefix argument. If ARG is nil, restore the current-difference.
1839 If the second optional argument, a character, is given, use it to
1840 determine the target buffer instead of last-command-char"
1841 (interactive "P")
1842 (ediff-barf-if-not-control-buffer)
1843 (if (numberp arg)
1844 (ediff-jump-to-difference arg))
1845 (ediff-pop-diff ediff-current-difference
1846 (ediff-char-to-buftype (or key last-command-char)))
1847 ;; recenter with rehighlighting, but no messages
1848 (let (ediff-verbose-p)
1849 (ediff-recenter)))
1851 (defun ediff-restore-diff-in-merge-buffer (arg)
1852 "Restore ARGth diff in the merge buffer.
1853 ARG is a prefix argument. If nil, restore the current diff."
1854 (interactive "P")
1855 (ediff-restore-diff arg ?c))
1858 (defun ediff-toggle-regexp-match ()
1859 "Toggle between focusing and hiding of difference regions that match
1860 a regular expression typed in by the user."
1861 (interactive)
1862 (ediff-barf-if-not-control-buffer)
1863 (let ((regexp-A "")
1864 (regexp-B "")
1865 (regexp-C "")
1866 msg-connective alt-msg-connective alt-connective)
1867 (cond
1868 ((or (and (eq ediff-skip-diff-region-function
1869 'ediff-focus-on-regexp-matches-function)
1870 (eq last-command-char ?f))
1871 (and (eq ediff-skip-diff-region-function
1872 ediff-hide-regexp-matches-function)
1873 (eq last-command-char ?h)))
1874 (message "Selective browsing by regexp turned off")
1875 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
1876 ((eq last-command-char ?h)
1877 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
1878 regexp-A
1879 (read-string
1880 (format
1881 "Ignore A-regions matching this regexp (default \"%s\"): "
1882 ediff-regexp-hide-A))
1883 regexp-B
1884 (read-string
1885 (format
1886 "Ignore B-regions matching this regexp (default \"%s\"): "
1887 ediff-regexp-hide-B)))
1888 (if ediff-3way-comparison-job
1889 (setq regexp-C
1890 (read-string
1891 (format
1892 "Ignore C-regions matching this regexp (default \"%s\"): "
1893 ediff-regexp-hide-C))))
1894 (if (eq ediff-hide-regexp-connective 'and)
1895 (setq msg-connective "BOTH"
1896 alt-msg-connective "ONE OF"
1897 alt-connective 'or)
1898 (setq msg-connective "ONE OF"
1899 alt-msg-connective "BOTH"
1900 alt-connective 'and))
1901 (if (y-or-n-p
1902 (format
1903 "Ignore regions that match %s regexps, OK? "
1904 msg-connective alt-msg-connective))
1905 (message "Will ignore regions that match %s regexps" msg-connective)
1906 (setq ediff-hide-regexp-connective alt-connective)
1907 (message "Will ignore regions that match %s regexps"
1908 alt-msg-connective))
1910 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
1911 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
1912 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
1914 ((eq last-command-char ?f)
1915 (setq ediff-skip-diff-region-function
1916 ediff-focus-on-regexp-matches-function
1917 regexp-A
1918 (read-string
1919 (format
1920 "Focus on A-regions matching this regexp (default \"%s\"): "
1921 ediff-regexp-focus-A))
1922 regexp-B
1923 (read-string
1924 (format
1925 "Focus on B-regions matching this regexp (default \"%s\"): "
1926 ediff-regexp-focus-B)))
1927 (if ediff-3way-comparison-job
1928 (setq regexp-C
1929 (read-string
1930 (format
1931 "Focus on C-regions matching this regexp (default \"%s\"): "
1932 ediff-regexp-focus-C))))
1933 (if (eq ediff-focus-regexp-connective 'and)
1934 (setq msg-connective "BOTH"
1935 alt-msg-connective "ONE OF"
1936 alt-connective 'or)
1937 (setq msg-connective "ONE OF"
1938 alt-msg-connective "BOTH"
1939 alt-connective 'and))
1940 (if (y-or-n-p
1941 (format
1942 "Focus on regions that match %s regexps, OK? "
1943 msg-connective alt-msg-connective))
1944 (message "Will focus on regions that match %s regexps"
1945 msg-connective)
1946 (setq ediff-focus-regexp-connective alt-connective)
1947 (message "Will focus on regions that match %s regexps"
1948 alt-msg-connective))
1950 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
1951 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
1952 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
1954 (defun ediff-toggle-skip-similar ()
1955 (interactive)
1956 (ediff-barf-if-not-control-buffer)
1957 (if (not (eq ediff-auto-refine 'on))
1958 (error
1959 "Can't skip over whitespace regions: first turn auto-refining on"))
1960 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
1961 (if ediff-ignore-similar-regions
1962 (message
1963 "Skipping regions that differ only in white space & line breaks")
1964 (message "Skipping over white-space differences turned off")))
1966 (defun ediff-focus-on-regexp-matches (n)
1967 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
1968 Regions to be ignored according to this function are those where
1969 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
1970 doesn't match `ediff-regexp-focus-B'.
1971 This function returns nil if the region number N (specified as
1972 an argument) is not to be ignored and t if region N is to be ignored.
1974 N is a region number used by Ediff internally. It is 1 less
1975 the number seen by the user."
1976 (if (ediff-valid-difference-p n)
1977 (let* ((ctl-buf ediff-control-buffer)
1978 (regex-A ediff-regexp-focus-A)
1979 (regex-B ediff-regexp-focus-B)
1980 (regex-C ediff-regexp-focus-C)
1981 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
1982 (save-restriction
1983 (narrow-to-region
1984 (ediff-get-diff-posn 'A 'beg n ctl-buf)
1985 (ediff-get-diff-posn 'A 'end n ctl-buf))
1986 (goto-char (point-min))
1987 (re-search-forward regex-A nil t))))
1988 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
1989 (save-restriction
1990 (narrow-to-region
1991 (ediff-get-diff-posn 'B 'beg n ctl-buf)
1992 (ediff-get-diff-posn 'B 'end n ctl-buf))
1993 (re-search-forward regex-B nil t))))
1994 (reg-C-match (if ediff-3way-comparison-job
1995 (ediff-eval-in-buffer ediff-buffer-C
1996 (save-restriction
1997 (narrow-to-region
1998 (ediff-get-diff-posn 'C 'beg n ctl-buf)
1999 (ediff-get-diff-posn 'C 'end n ctl-buf))
2000 (re-search-forward regex-C nil t))))))
2001 (not (eval (if ediff-3way-comparison-job
2002 (list ediff-focus-regexp-connective
2003 reg-A-match reg-B-match reg-C-match)
2004 (list ediff-focus-regexp-connective
2005 reg-A-match reg-B-match))))
2008 (defun ediff-hide-regexp-matches (n)
2009 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2010 Regions to be ignored are those where buf A region matches
2011 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2012 This function returns nil if the region number N (specified as
2013 an argument) is not to be ignored and t if region N is to be ignored.
2015 N is a region number used by Ediff internally. It is 1 less
2016 the number seen by the user."
2017 (if (ediff-valid-difference-p n)
2018 (let* ((ctl-buf ediff-control-buffer)
2019 (regex-A ediff-regexp-hide-A)
2020 (regex-B ediff-regexp-hide-B)
2021 (regex-C ediff-regexp-hide-C)
2022 (reg-A-match (ediff-eval-in-buffer ediff-buffer-A
2023 (save-restriction
2024 (narrow-to-region
2025 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2026 (ediff-get-diff-posn 'A 'end n ctl-buf))
2027 (goto-char (point-min))
2028 (re-search-forward regex-A nil t))))
2029 (reg-B-match (ediff-eval-in-buffer ediff-buffer-B
2030 (save-restriction
2031 (narrow-to-region
2032 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2033 (ediff-get-diff-posn 'B 'end n ctl-buf))
2034 (goto-char (point-min))
2035 (re-search-forward regex-B nil t))))
2036 (reg-C-match (if ediff-3way-comparison-job
2037 (ediff-eval-in-buffer ediff-buffer-C
2038 (save-restriction
2039 (narrow-to-region
2040 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2041 (ediff-get-diff-posn 'C 'end n ctl-buf))
2042 (goto-char (point-min))
2043 (re-search-forward regex-C nil t))))))
2044 (eval (if ediff-3way-comparison-job
2045 (list ediff-hide-regexp-connective
2046 reg-A-match reg-B-match reg-C-match)
2047 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2052 ;;; Quitting, suspending, etc.
2054 (defun ediff-quit (reverse-default-keep-variants)
2055 "Finish an Ediff session and exit Ediff.
2056 Unselects the selected difference, if any, restores the read-only and modified
2057 flags of the compared file buffers, kills Ediff buffers for this session
2058 \(but not buffers A, B, C\).
2060 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2061 containing the variants should be removed \(if they haven't been modified\).
2062 If it is t, they will be preserved unconditionally. A prefix argument,
2063 temporarily reverses the meaning of this variable."
2064 (interactive "P")
2065 (ediff-barf-if-not-control-buffer)
2066 (if (prog1
2067 (y-or-n-p
2068 (format "Quit this Ediff session%s? "
2069 (if (ediff-buffer-live-p ediff-meta-buffer)
2070 " & show containing session group" "")))
2071 (message ""))
2072 (ediff-really-quit reverse-default-keep-variants)))
2075 ;; Perform the quit operations.
2076 (defun ediff-really-quit (reverse-default-keep-variants)
2077 (ediff-unhighlight-diffs-totally)
2078 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2079 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2080 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2081 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2083 (ediff-delete-temp-files)
2085 ;; Restore visibility range. This affects only ediff-*-regions/windows.
2086 ;; Since for other job names ediff-visible-region sets
2087 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2088 ;; ignored for such jobs.
2089 (if ediff-quit-widened
2090 (setq ediff-visible-bounds ediff-wide-bounds)
2091 (setq ediff-visible-bounds ediff-narrow-bounds))
2093 ;; Apply selective display to narrow or widen
2094 (ediff-visible-region)
2095 (mapcar (function (lambda (overl)
2096 (if (ediff-overlayp overl)
2097 (ediff-delete-overlay overl))))
2098 ediff-wide-bounds)
2099 (mapcar (function (lambda (overl)
2100 (if (ediff-overlayp overl)
2101 (ediff-delete-overlay overl))))
2102 ediff-narrow-bounds)
2104 ;; restore buffer mode line id's in buffer-A/B/C
2105 (let ((control-buffer ediff-control-buffer)
2106 (meta-buffer ediff-meta-buffer))
2107 (condition-case nil
2108 (ediff-eval-in-buffer ediff-buffer-A
2109 (setq ediff-this-buffer-ediff-sessions
2110 (delq control-buffer ediff-this-buffer-ediff-sessions))
2111 (kill-local-variable 'mode-line-buffer-identification)
2112 (kill-local-variable 'mode-line-format)
2114 (error))
2116 (condition-case nil
2117 (ediff-eval-in-buffer ediff-buffer-B
2118 (setq ediff-this-buffer-ediff-sessions
2119 (delq control-buffer ediff-this-buffer-ediff-sessions))
2120 (kill-local-variable 'mode-line-buffer-identification)
2121 (kill-local-variable 'mode-line-format)
2123 (error))
2125 (condition-case nil
2126 (ediff-eval-in-buffer ediff-buffer-C
2127 (setq ediff-this-buffer-ediff-sessions
2128 (delq control-buffer ediff-this-buffer-ediff-sessions))
2129 (kill-local-variable 'mode-line-buffer-identification)
2130 (kill-local-variable 'mode-line-format)
2132 (error))
2134 (condition-case nil
2135 (ediff-eval-in-buffer ediff-ancestor-buffer
2136 (setq ediff-this-buffer-ediff-sessions
2137 (delq control-buffer ediff-this-buffer-ediff-sessions))
2138 (kill-local-variable 'mode-line-buffer-identification)
2139 (kill-local-variable 'mode-line-format)
2141 (error))
2143 (setq ediff-session-registry
2144 (delq ediff-control-buffer ediff-session-registry))
2145 (ediff-update-registry)
2146 ;; restore state of buffers to what it was before ediff
2147 (ediff-restore-protected-variables)
2148 ;; good place to kill buffers A/B/C
2149 (run-hooks 'ediff-cleanup-hook)
2150 (let ((ediff-keep-variants ediff-keep-variants))
2151 (if reverse-default-keep-variants
2152 (setq ediff-keep-variants (not ediff-keep-variants)))
2153 (or ediff-keep-variants (ediff-janitor 'ask)))
2155 (run-hooks 'ediff-quit-hook)
2156 (ediff-cleanup-meta-buffer meta-buffer)
2157 (if (ediff-buffer-live-p meta-buffer)
2158 (ediff-show-meta-buffer meta-buffer))
2162 (defun ediff-delete-temp-files ()
2163 (if (stringp ediff-temp-file-A)
2164 (delete-file ediff-temp-file-A))
2165 (if (stringp ediff-temp-file-B)
2166 (delete-file ediff-temp-file-B))
2167 (if (stringp ediff-temp-file-C)
2168 (delete-file ediff-temp-file-C)))
2171 ;; Kill control buffer, other auxiliary Ediff buffers.
2172 ;; Leave one of the frames split between buffers A/B/C
2173 (defun ediff-cleanup-mess ()
2174 (let ((buff-A ediff-buffer-A)
2175 (buff-B ediff-buffer-B)
2176 (buff-C ediff-buffer-C)
2177 (ctl-buf ediff-control-buffer)
2178 (ctl-frame ediff-control-frame)
2179 (three-way-job ediff-3way-job))
2181 (ediff-kill-buffer-carefully ediff-diff-buffer)
2182 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2183 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2184 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2185 (ediff-kill-buffer-carefully ediff-error-buffer)
2186 (ediff-kill-buffer-carefully ediff-patch-diagnostics)
2187 (ediff-kill-buffer-carefully ediff-msg-buffer)
2188 (ediff-kill-buffer-carefully ediff-debug-buffer)
2190 (if (and (ediff-window-display-p) (frame-live-p ctl-frame))
2191 (delete-frame ctl-frame))
2192 (ediff-kill-buffer-carefully ctl-buf)
2194 (delete-other-windows)
2196 ;; display only if not visible
2197 (condition-case nil
2198 (or (ediff-get-visible-buffer-window buff-B)
2199 (switch-to-buffer buff-B))
2200 (error))
2201 (condition-case nil
2202 (or (ediff-get-visible-buffer-window buff-A)
2203 (progn
2204 (if (ediff-get-visible-buffer-window buff-B)
2205 (split-window-vertically))
2206 (switch-to-buffer buff-A)))
2207 (error))
2208 (if three-way-job
2209 (condition-case nil
2210 (or (ediff-get-visible-buffer-window buff-C)
2211 (progn
2212 (if (or (ediff-get-visible-buffer-window buff-A)
2213 (ediff-get-visible-buffer-window buff-B))
2214 (split-window-vertically))
2215 (switch-to-buffer buff-C)
2216 (balance-windows)))
2217 (error)))
2218 (message "")
2221 (defun ediff-janitor (&optional ask)
2222 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2223 In merge jobs, buffer C is never deleted.
2224 However, the side effect of cleaning up may be that you cannot compare the same
2225 buffer in two separate Ediff sessions: quitting one of them will delete this
2226 buffer in another session as well."
2227 (or (not (ediff-buffer-live-p ediff-buffer-A))
2228 (buffer-modified-p ediff-buffer-A)
2229 (and ask
2230 (not (y-or-n-p (format "Kill buffer A [%s]? "
2231 (buffer-name ediff-buffer-A)))))
2232 (ediff-kill-buffer-carefully ediff-buffer-A))
2233 (or (not (ediff-buffer-live-p ediff-buffer-B))
2234 (buffer-modified-p ediff-buffer-B)
2235 (and ask
2236 (not (y-or-n-p (format "Kill buffer B [%s]? "
2237 (buffer-name ediff-buffer-B)))))
2238 (ediff-kill-buffer-carefully ediff-buffer-B))
2239 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2240 (or (not (ediff-buffer-live-p ediff-ancestor-buffer))
2241 (buffer-modified-p ediff-ancestor-buffer)
2242 (and ask
2243 (not (y-or-n-p (format "Kill the ancestor buffer [%s]? "
2244 (buffer-name ediff-ancestor-buffer)))))
2245 (ediff-kill-buffer-carefully ediff-ancestor-buffer))
2246 (or (not (ediff-buffer-live-p ediff-buffer-C))
2247 (buffer-modified-p ediff-buffer-C)
2248 (and ask (not (y-or-n-p (format "Kill buffer C [%s]? "
2249 (buffer-name ediff-buffer-C)))))
2250 (ediff-kill-buffer-carefully ediff-buffer-C))))
2252 ;; The default way of suspending Ediff.
2253 ;; Buries Ediff buffers, kills all windows.
2254 (defun ediff-default-suspend-function ()
2255 (let* ((buf-A ediff-buffer-A)
2256 (buf-B ediff-buffer-B)
2257 (buf-C ediff-buffer-C)
2258 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2259 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2260 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2261 (buf-patch ediff-patch-buf)
2262 (buf-patch-diag ediff-patch-diagnostics)
2263 (buf-err ediff-error-buffer)
2264 (buf-diff ediff-diff-buffer)
2265 (buf-custom-diff ediff-custom-diff-buffer)
2266 (buf-fine-diff ediff-fine-diff-buffer))
2268 ;; hide the control panel
2269 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2270 (iconify-frame ediff-control-frame)
2271 (bury-buffer))
2272 (if buf-err (bury-buffer buf-err))
2273 (if buf-diff (bury-buffer buf-diff))
2274 (if buf-custom-diff (bury-buffer buf-custom-diff))
2275 (if buf-fine-diff (bury-buffer buf-fine-diff))
2276 (if buf-patch (bury-buffer buf-patch))
2277 (if buf-patch-diag (bury-buffer buf-patch-diag))
2278 (if (window-live-p buf-A-wind)
2279 (progn
2280 (select-window buf-A-wind)
2281 (delete-other-windows)
2282 (bury-buffer))
2283 (if (ediff-buffer-live-p buf-A) (bury-buffer buf-A)))
2284 (if (window-live-p buf-B-wind)
2285 (progn
2286 (select-window buf-B-wind)
2287 (delete-other-windows)
2288 (bury-buffer))
2289 (if (ediff-buffer-live-p buf-B) (bury-buffer buf-B)))
2290 (if (window-live-p buf-C-wind)
2291 (progn
2292 (select-window buf-C-wind)
2293 (delete-other-windows)
2294 (bury-buffer))
2295 (if (ediff-buffer-live-p buf-C) (bury-buffer buf-C)))
2300 (defun ediff-suspend ()
2301 "Suspend Ediff.
2302 To resume, switch to the appropriate `Ediff Control Panel'
2303 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2304 up an appropriate window config."
2305 (interactive)
2306 (ediff-barf-if-not-control-buffer)
2307 (run-hooks 'ediff-suspend-hook)
2308 (message
2309 "To resume, type M-x eregistry and select the desired Ediff session"))
2312 (defun ediff-status-info ()
2313 "Show the names of the buffers or files being operated on by Ediff.
2314 Hit \\[ediff-recenter] to reset the windows afterward."
2315 (interactive)
2316 (ediff-barf-if-not-control-buffer)
2317 (save-excursion
2318 (ediff-skip-unsuitable-frames))
2319 (with-output-to-temp-buffer " *ediff-info*"
2320 (princ (ediff-version))
2321 (princ "\n\n")
2322 (ediff-eval-in-buffer ediff-buffer-A
2323 (if buffer-file-name
2324 (princ
2325 (format "File A = %S\n" buffer-file-name))
2326 (princ
2327 (format "Buffer A = %S\n" (buffer-name)))))
2328 (ediff-eval-in-buffer ediff-buffer-B
2329 (if buffer-file-name
2330 (princ
2331 (format "File B = %S\n" buffer-file-name))
2332 (princ
2333 (format "Buffer B = %S\n" (buffer-name)))))
2334 (if ediff-3way-job
2335 (ediff-eval-in-buffer ediff-buffer-C
2336 (if buffer-file-name
2337 (princ
2338 (format "File C = %S\n" buffer-file-name))
2339 (princ
2340 (format "Buffer C = %S\n" (buffer-name))))))
2341 (princ (format "Customized diff output %s\n"
2342 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2343 (concat "\tin buffer "
2344 (buffer-name ediff-custom-diff-buffer))
2345 "is not available")))
2346 (princ (format "Plain diff output %s\n"
2347 (if (ediff-buffer-live-p ediff-diff-buffer)
2348 (concat "\tin buffer "
2349 (buffer-name ediff-diff-buffer))
2350 "is not available")))
2352 (let* ((A-line (ediff-eval-in-buffer ediff-buffer-A
2353 (1+ (count-lines (point-min) (point)))))
2354 (B-line (ediff-eval-in-buffer ediff-buffer-B
2355 (1+ (count-lines (point-min) (point)))))
2356 C-line)
2357 (princ (format "\Buffer A's point is on line %d\n" A-line))
2358 (princ (format "Buffer B's point is on line %d\n" B-line))
2359 (if ediff-3way-job
2360 (progn
2361 (setq C-line (ediff-eval-in-buffer ediff-buffer-C
2362 (1+ (count-lines (point-min) (point)))))
2363 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2365 (princ (format "\nCurrent difference number = %S\n"
2366 (cond ((< ediff-current-difference 0) 'start)
2367 ((>= ediff-current-difference
2368 ediff-number-of-differences) 'end)
2369 (t (1+ ediff-current-difference)))))
2371 (princ
2372 (format "\n%s regions that differ only in white space & line breaks"
2373 (if ediff-ignore-similar-regions
2374 "Skipping" "Not skipping")))
2375 (if (and ediff-merge-job ediff-show-clashes-only)
2376 (princ
2377 "\nFocusing on regions where both buffers differ from the ancestor"))
2379 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2380 (princ "\nSelective browsing by regexp is off\n"))
2381 ((eq ediff-skip-diff-region-function
2382 ediff-hide-regexp-matches-function)
2383 (princ
2384 "\nIgnoring regions that match")
2385 (princ
2386 (format
2387 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2388 ediff-regexp-hide-A ediff-hide-regexp-connective
2389 ediff-regexp-hide-B)))
2390 ((eq ediff-skip-diff-region-function
2391 ediff-focus-on-regexp-matches-function)
2392 (princ
2393 "\nFocusing on regions that match")
2394 (princ
2395 (format
2396 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2397 ediff-regexp-focus-A ediff-focus-regexp-connective
2398 ediff-regexp-focus-B)))
2399 (t (princ "\nSelective browsing via a user-defined method.\n")))
2401 (princ
2402 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2403 (substitute-command-keys "\\[ediff-submit-report]")))
2404 ) ; with output
2405 (if (frame-live-p ediff-control-frame)
2406 (ediff-reset-mouse ediff-control-frame))
2407 (if (window-live-p ediff-control-window)
2408 (select-window ediff-control-window)))
2413 ;;; Support routines
2415 ;; Select a difference by placing the ASCII flags around the appropriate
2416 ;; group of lines in the A, B buffers
2417 ;; This may have to be modified for buffer C, when it will be supported.
2418 (defun ediff-select-difference (n)
2419 (if (and (ediff-buffer-live-p ediff-buffer-A)
2420 (ediff-buffer-live-p ediff-buffer-B)
2421 (ediff-valid-difference-p n))
2422 (progn
2423 (if (and (ediff-has-face-support-p) ediff-use-faces)
2424 (progn
2425 (ediff-highlight-diff n)
2426 (setq ediff-highlighting-style 'face))
2427 (setq ediff-highlighting-style 'ascii)
2428 (ediff-place-flags-in-buffer
2429 'A ediff-buffer-A ediff-control-buffer n)
2430 (ediff-place-flags-in-buffer
2431 'B ediff-buffer-B ediff-control-buffer n)
2432 (if ediff-3way-job
2433 (ediff-place-flags-in-buffer
2434 'C ediff-buffer-C ediff-control-buffer n))
2435 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2436 (ediff-place-flags-in-buffer
2437 'Ancestor ediff-ancestor-buffer
2438 ediff-control-buffer n))
2441 (ediff-install-fine-diff-if-necessary n)
2442 (run-hooks 'ediff-select-hook))))
2445 ;; Unselect a difference by removing the ASCII flags in the buffers.
2446 ;; This may have to be modified for buffer C, when it will be supported.
2447 (defun ediff-unselect-difference (n)
2448 (if (ediff-valid-difference-p n)
2449 (progn
2450 (cond ((and (ediff-has-face-support-p) ediff-use-faces)
2451 (ediff-unhighlight-diff))
2452 ((eq ediff-highlighting-style 'ascii)
2453 (ediff-remove-flags-from-buffer
2454 ediff-buffer-A
2455 (ediff-get-diff-overlay n 'A))
2456 (ediff-remove-flags-from-buffer
2457 ediff-buffer-B
2458 (ediff-get-diff-overlay n 'B))
2459 (if ediff-3way-job
2460 (ediff-remove-flags-from-buffer
2461 ediff-buffer-C
2462 (ediff-get-diff-overlay n 'C)))
2463 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2464 (ediff-remove-flags-from-buffer
2465 ediff-ancestor-buffer
2466 (ediff-get-diff-overlay n 'Ancestor)))
2468 (setq ediff-highlighting-style nil)
2470 ;; unhighlight fine diffs
2471 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2472 (run-hooks 'ediff-unselect-hook))))
2475 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2476 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2477 ;; next difference is selected, but the current selection is not
2478 ;; unselected. If FLAG is 'unselect-only then the current selection is
2479 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2480 ;; don't recenter buffers after selecting/unselecting.
2481 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2482 (let ((ediff-current-difference n))
2483 (or no-recenter
2484 (ediff-recenter 'no-rehighlight)))
2486 (let ((control-buf ediff-control-buffer))
2487 (unwind-protect
2488 (progn
2489 (or (eq flag 'select-only)
2490 (ediff-unselect-difference ediff-current-difference))
2492 (or (eq flag 'unselect-only)
2493 (ediff-select-difference n))
2494 (setq ediff-current-difference n)
2495 ) ; end protected section
2497 (ediff-eval-in-buffer control-buf
2498 (ediff-refresh-mode-lines))
2502 (defun ediff-read-file-name (prompt default-dir default-file)
2503 ; This is a modified version of a similar function in `emerge.el'.
2504 ; PROMPT should not have trailing ': ', so that it can be modified
2505 ; according to context.
2506 ; If default-file is set, it should be used as the default value.
2507 ; If default-dir is non-nil, use it as the default directory.
2508 ; Otherwise, use the value of Emacs' variable `default-directory.'
2510 ;; hack default-dir if it is not set
2511 (setq default-dir
2512 (file-name-as-directory
2513 (ediff-abbreviate-file-name
2514 (expand-file-name (or default-dir
2515 (and default-file
2516 (file-name-directory default-file))
2517 default-directory)))))
2519 ;; strip the directory from default-file
2520 (if default-file
2521 (setq default-file (file-name-nondirectory default-file)))
2522 (if (string= default-file "")
2523 (setq default-file nil))
2525 (let (f)
2526 (setq f (expand-file-name
2527 (read-file-name
2528 (format "%s%s: "
2529 prompt
2530 (if default-file
2531 (concat " (default " default-file ")")
2532 ""))
2533 default-dir
2534 default-file
2535 t ; must match, no-confirm
2536 (if default-file (file-name-directory default-file))
2538 default-dir
2540 ;; If user enters a directory name, expand the default file in that
2541 ;; directory. This allows the user to enter a directory name for the
2542 ;; B-file and diff against the default-file in that directory instead
2543 ;; of a DIRED listing!
2544 (if (and (file-directory-p f) default-file)
2545 (setq f (expand-file-name
2546 (file-name-nondirectory default-file) f)))
2547 f))
2549 ;; If PREFIX is given, then it is used as a prefix for the temp file
2550 ;; name. Otherwise, `ediff_' is used. If FILE is given, use this
2551 ;; file and don't create a new one.
2552 ;; On MS-DOS, make sure the prefix isn't longer than 7 characters, or
2553 ;; else `make-temp-name' isn't guaranteed to return a unique filename.
2554 ;; Also, save buffer from START to END in the file.
2555 ;; START defaults to (point-min), END to (point-max)
2556 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
2557 (let ((p (or prefix "ediff"))
2559 (if (and (eq system-type 'ms-dos) (> (length p) 7))
2560 (setq p (substring p 0 7)))
2562 (setq f (concat ediff-temp-file-prefix p)
2563 f (cond (given-file)
2564 ((find-file-name-handler f 'find-file-noselect)
2565 ;; to thwart file handlers in write-region, e.g., if file
2566 ;; name ends with .Z or .gz
2567 ;; This is needed so that patches produced by ediff will
2568 ;; have more meaningful names
2569 (make-temp-name f))
2570 ;; Prefix is most often the same as the file name for the
2571 ;; variant. Here we are trying to use the original file name
2572 ;; but in the temp directory.
2573 ((and prefix (not (file-exists-p f))) f)
2574 ;; If a file with the orig name exists, add some random stuff
2575 ;; to it.
2576 (t (make-temp-name f))))
2578 ;; create the file
2579 (ediff-eval-in-buffer buff
2580 (write-region (if start start (point-min))
2581 (if end end (point-max))
2583 nil ; don't append---erase
2584 'no-message)
2585 (set-file-modes f ediff-temp-file-mode)
2586 f)))
2588 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
2589 ;; EMX OS/2
2590 ;;(defun ediff-protect-metachars (str)
2591 ;; (or (memq system-type '(emx vax-vms axp-vms))
2592 ;; (let ((limit 0))
2593 ;; (while (string-match ediff-metachars str limit)
2594 ;; (setq str (concat (substring str 0 (match-beginning 0))
2595 ;; "\\"
2596 ;; (substring str (match-beginning 0))))
2597 ;; (setq limit (1+ (match-end 0))))))
2598 ;; str)
2600 ;; Make sure the current buffer (for a file) has the same contents as the
2601 ;; file on disk, and attempt to remedy the situation if not.
2602 ;; Signal an error if we can't make them the same, or the user doesn't want
2603 ;; to do what is necessary to make them the same.
2604 ;; If file has file handlers (indicated by the optional arg), then we
2605 ;; offer to revert instead of saving. This is one difference with Emerge.
2606 ;; Another is that we always offer to revert obsolete files, whether they
2607 ;; are modified or not.
2608 (defun ediff-verify-file-buffer (&optional file-magic)
2609 ;; First check if the file has been modified since the buffer visited it.
2610 (if (verify-visited-file-modtime (current-buffer))
2611 (if (buffer-modified-p)
2612 ;; If buffer is not obsolete and is modified, offer to save
2613 (if (yes-or-no-p
2614 (format "Buffer out of sync with visited file. %s file %s? "
2615 (if file-magic "Revert" "Save")
2616 buffer-file-name))
2617 (if (not file-magic)
2618 (save-buffer)
2619 ;; for some reason, file-name-handlers append instead of
2620 ;; replacing, so we have to erase first.
2621 (erase-buffer)
2622 (revert-buffer t t))
2623 (error "Buffer out of sync for file %s" buffer-file-name))
2624 ;; If buffer is not obsolete and is not modified, do nothing
2625 nil)
2626 ;; If buffer is obsolete, offer to revert
2627 (if (yes-or-no-p
2628 (format "Buffer out of sync with visited file. Revert file %s? "
2629 buffer-file-name))
2630 (progn
2631 (if file-magic
2632 (erase-buffer))
2633 (revert-buffer t t))
2634 (error "Buffer out of sync for file %s" buffer-file-name))))
2637 (defun ediff-save-buffer (arg)
2638 "Safe way of saving buffers A, B, C, and the diff output.
2639 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
2640 and `wd' saves the diff output.
2642 With prefix argument, `wd' saves plain diff output.
2643 Without an argument, it saves customized diff argument, if available
2644 \(and plain output, if customized output was not generated\)."
2645 (interactive "P")
2646 (ediff-barf-if-not-control-buffer)
2647 (ediff-compute-custom-diffs-maybe)
2648 (ediff-eval-in-buffer
2649 (cond ((memq last-command-char '(?a ?b ?c))
2650 (ediff-get-buffer
2651 (ediff-char-to-buftype last-command-char)))
2652 ((eq last-command-char ?d)
2653 (message "Saving diff output ...")
2654 (sit-for 1) ; let the user see the message
2655 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2656 ediff-diff-buffer)
2657 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2658 ediff-custom-diff-buffer)
2659 ((ediff-buffer-live-p ediff-diff-buffer)
2660 ediff-diff-buffer)
2661 (t (error "Output from `diff' not found"))))
2663 (save-buffer)))
2665 (defun ediff-compute-custom-diffs-maybe ()
2666 (let ((buf-A-file-name (buffer-file-name ediff-buffer-A))
2667 (buf-B-file-name (buffer-file-name ediff-buffer-B))
2668 file-A file-B)
2669 (if (stringp buf-A-file-name)
2670 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
2671 (if (stringp buf-B-file-name)
2672 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
2673 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name)
2674 file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
2676 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
2677 (setq ediff-custom-diff-buffer
2678 (get-buffer-create
2679 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
2680 (ediff-exec-process
2681 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
2682 ediff-custom-diff-options file-A file-B)
2683 (delete-file file-A)
2684 (delete-file file-B)
2687 (defun ediff-show-diff-output (arg)
2688 (interactive "P")
2689 (ediff-barf-if-not-control-buffer)
2690 (ediff-compute-custom-diffs-maybe)
2691 (save-excursion
2692 (ediff-skip-unsuitable-frames ' ok-unsplittable))
2693 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
2694 ediff-diff-buffer)
2695 ((ediff-buffer-live-p ediff-custom-diff-buffer)
2696 ediff-custom-diff-buffer)
2697 ((ediff-buffer-live-p ediff-diff-buffer)
2698 ediff-diff-buffer)
2700 (beep)
2701 (message "Output from `diff' not found")
2702 nil))))
2703 (if buf
2704 (progn
2705 (ediff-eval-in-buffer buf
2706 (goto-char (point-min)))
2707 (switch-to-buffer buf)
2708 (raise-frame (selected-frame)))))
2709 (if (frame-live-p ediff-control-frame)
2710 (ediff-reset-mouse ediff-control-frame))
2711 (if (window-live-p ediff-control-window)
2712 (select-window ediff-control-window)))
2716 ;; will simplify it in due time, when emacs acquires before/after strings
2717 (defun ediff-remove-flags-from-buffer (buffer overlay)
2718 (ediff-eval-in-buffer buffer
2719 (let ((inhibit-read-only t))
2720 (if ediff-xemacs-p
2721 (ediff-overlay-put overlay 'begin-glyph nil)
2722 ;; before-string is not yet implemented in emacs.
2723 ;; when it will be, I will be able to delete much of the rest of
2724 ;; this function
2725 (ediff-overlay-put overlay 'before-string nil))
2727 (if ediff-xemacs-p
2728 (ediff-overlay-put overlay 'end-glyph nil)
2729 ;; after-string is not yet implemented in emacs.
2730 (ediff-overlay-put overlay 'after-string nil))
2735 ;; will simplify it in due time, when emacs acquires before/after strings
2736 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
2737 (ediff-eval-in-buffer buffer
2738 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
2741 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
2742 (let* ((curr-overl (ediff-eval-in-buffer ctl-buffer
2743 (ediff-get-diff-overlay diff-no buf-type)))
2744 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
2745 after beg-of-line flag)
2747 ;; insert flag before the difference
2748 (goto-char before)
2749 (setq beg-of-line (bolp))
2751 (setq flag (ediff-eval-in-buffer ctl-buffer
2752 (if (eq ediff-highlighting-style 'ascii)
2753 (if beg-of-line
2754 ediff-before-flag-bol ediff-before-flag-mol))))
2756 ;; insert the flag itself
2757 (if ediff-xemacs-p
2758 (ediff-overlay-put curr-overl 'begin-glyph flag)
2759 (ediff-overlay-put curr-overl 'before-string flag))
2761 ;; insert the flag after the difference
2762 ;; `after' must be set here, after the before-flag was inserted
2763 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
2764 (goto-char after)
2765 (setq beg-of-line (bolp))
2767 (setq flag (ediff-eval-in-buffer ctl-buffer
2768 (if (eq ediff-highlighting-style 'ascii)
2769 (if beg-of-line
2770 ediff-after-flag-eol ediff-after-flag-mol))))
2772 ;; insert the flag itself
2773 (if ediff-xemacs-p
2774 (ediff-overlay-put curr-overl 'end-glyph flag)
2775 (ediff-overlay-put curr-overl 'after-string flag))
2779 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
2780 "Returns positions of difference sectors in the BUF-TYPE buffer.
2781 BUF-TYPE should be a symbol--either `A' or `B'.
2782 POS is either `beg' or `end'--it specifies whether you want the position at the
2783 beginning of a difference or at the end.
2785 The optional argument N says which difference \(default:
2786 `ediff-current-difference'\). The optional argument CONTROL-BUF says
2787 which control buffer is in effect in case it is not the current
2788 buffer."
2789 (let (diff-overlay)
2790 (or control-buf
2791 (setq control-buf (current-buffer)))
2793 (ediff-eval-in-buffer control-buf
2794 (or n (setq n ediff-current-difference))
2795 (if (or (< n 0) (>= n ediff-number-of-differences))
2796 (if (> ediff-number-of-differences 0)
2797 (error "Bad difference number, %d. Valid numbers are 1 to %d"
2798 (1+ n) ediff-number-of-differences)
2799 (error ediff-NO-DIFFERENCES)))
2800 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
2801 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
2802 (error ediff-KILLED-VITAL-BUFFER))
2803 (if (eq pos 'beg)
2804 (ediff-overlay-start diff-overlay)
2805 (ediff-overlay-end diff-overlay))
2810 (defun ediff-highlight-diff-in-one-buffer (n buf-type)
2811 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2812 (let* ((buff (ediff-get-buffer buf-type))
2813 (last (ediff-eval-in-buffer buff (point-max)))
2814 (begin (ediff-get-diff-posn buf-type 'beg n))
2815 (end (ediff-get-diff-posn buf-type 'end n))
2816 (xtra (if (equal begin end) 1 0))
2817 (end-hilit (min last (+ end xtra)))
2818 (current-diff-overlay
2819 (symbol-value
2820 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2823 (if ediff-xemacs-p
2824 (ediff-move-overlay current-diff-overlay begin end-hilit)
2825 (ediff-move-overlay current-diff-overlay begin end-hilit buff))
2826 ;; giving priority of 0 and then changing it may look funny, but
2827 ;; this overcomes an obscure Emacs bug.
2828 (ediff-overlay-put current-diff-overlay 'priority 0)
2829 (ediff-overlay-put current-diff-overlay 'priority
2830 (ediff-highest-priority begin end-hilit buff))
2831 (ediff-overlay-put current-diff-overlay 'ediff-diff-num n)
2833 ;; unhighlight the background overlay for diff n so it won't
2834 ;; interfere with the current diff overlay
2835 (ediff-set-overlay-face (ediff-get-diff-overlay n buf-type) nil)
2839 (defun ediff-unhighlight-diff-in-one-buffer (buf-type)
2840 (if (ediff-buffer-live-p (ediff-get-buffer buf-type))
2841 (let ((current-diff-overlay
2842 (symbol-value
2843 (intern (format "ediff-current-diff-overlay-%S" buf-type))))
2844 (overlay
2845 (ediff-get-diff-overlay ediff-current-difference buf-type))
2848 (ediff-move-overlay current-diff-overlay 1 1)
2850 ;; rehighlight the overlay in the background of the
2851 ;; current difference region
2852 (ediff-set-overlay-face
2853 overlay
2854 (if (and (ediff-has-face-support-p)
2855 ediff-use-faces ediff-highlight-all-diffs)
2856 (ediff-background-face buf-type ediff-current-difference)))
2859 (defun ediff-unhighlight-diffs-totally-in-one-buffer (buf-type)
2860 (ediff-unselect-and-select-difference -1)
2861 (if (and (ediff-has-face-support-p) ediff-use-faces)
2862 (let* ((inhibit-quit t)
2863 (current-diff-overlay-var
2864 (intern (format "ediff-current-diff-overlay-%S" buf-type)))
2865 (current-diff-overlay (symbol-value current-diff-overlay-var)))
2866 (ediff-color-background-regions 'unhighlight)
2867 (if (ediff-overlayp current-diff-overlay)
2868 (ediff-delete-overlay current-diff-overlay))
2869 (set current-diff-overlay-var nil)
2873 ;; null out difference overlays so they won't slow down future
2874 ;; editing operations
2875 ;; VEC is either a difference vector or a fine-diff vector
2876 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
2877 (if (vectorp (symbol-value vec-var))
2878 (mapcar (function
2879 (lambda (elt)
2880 (ediff-delete-overlay
2881 (ediff-get-diff-overlay-from-diff-record elt))
2882 (if fine-diffs-also
2883 (ediff-clear-fine-diff-vector elt))
2885 (symbol-value vec-var)))
2886 ;; allow them to be garbage collected
2887 (set vec-var nil))
2889 (defun ediff-color-background-regions (&optional unhighlight)
2890 (ediff-color-background-regions-in-one-buffer
2891 'A unhighlight)
2892 (ediff-color-background-regions-in-one-buffer
2893 'B unhighlight)
2894 (ediff-color-background-regions-in-one-buffer
2895 'C unhighlight)
2896 (ediff-color-background-regions-in-one-buffer
2897 'Ancestor unhighlight))
2899 (defun ediff-color-background-regions-in-one-buffer (buf-type unhighlight)
2900 (let ((diff-vector
2901 (eval (intern (format "ediff-difference-vector-%S" buf-type))))
2902 overl diff-num)
2903 (mapcar (function
2904 (lambda (rec)
2905 (setq overl (ediff-get-diff-overlay-from-diff-record rec)
2906 diff-num (ediff-overlay-get overl 'ediff-diff-num))
2907 (ediff-set-overlay-face
2908 overl
2909 (if (not unhighlight)
2910 (ediff-background-face buf-type diff-num))
2912 diff-vector)))
2915 ;;; Misc
2917 ;; These two functions are here to neutralize XEmacs unwillingless to
2918 ;; handle overlays whose buffers were deleted.
2919 (defun ediff-move-overlay (overlay beg end &optional buffer)
2920 "Calls `move-overlay' in Emacs and `set-extent-endpoints' in Lemacs.
2921 Checks if overlay's buffer exists before actually doing the move."
2922 (let ((buf (and overlay (ediff-overlay-buffer overlay))))
2923 (if (ediff-buffer-live-p buf)
2924 (if ediff-xemacs-p
2925 (set-extent-endpoints overlay beg end)
2926 (move-overlay overlay beg end buffer))
2927 ;; buffer's dead
2928 (if overlay
2929 (ediff-delete-overlay overlay)))))
2931 (defun ediff-overlay-put (overlay prop value)
2932 "Calls `overlay-put' or `set-extent-property' depending on Emacs version.
2933 Checks if overlay's buffer exists."
2934 (if (ediff-buffer-live-p (ediff-overlay-buffer overlay))
2935 (if ediff-xemacs-p
2936 (set-extent-property overlay prop value)
2937 (overlay-put overlay prop value))
2938 (ediff-delete-overlay overlay)))
2941 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
2942 ;; supporting sticky overlays, this function will make a sticky overlay.
2943 ;; BEG and END are expressions telling where overlay starts.
2944 ;; If they are numbers or buffers, then all is well. Otherwise, they must
2945 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
2946 ;; bounds.
2947 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
2948 ;; newly created overlay.
2949 (defun ediff-make-bullet-proof-overlay (beg end buff)
2950 (if (ediff-buffer-live-p buff)
2951 (let (overl)
2952 (ediff-eval-in-buffer buff
2953 (or (number-or-marker-p beg)
2954 (setq beg (eval beg)))
2955 (or (number-or-marker-p end)
2956 (setq end (eval end)))
2957 (setq overl
2958 (if ediff-xemacs-p
2959 (make-extent beg end buff)
2960 ;; don't advance front, but advance rear
2961 (make-overlay beg end buff nil 'rear-advance)))
2963 (if ediff-emacs-p
2964 (ediff-overlay-put overl 'evaporate nil) ; don't detach
2965 (ediff-overlay-put overl 'detachable nil) ; don't detach
2966 ;; don't advance front, but advance rear
2967 (ediff-overlay-put overl 'start-open nil)
2968 (ediff-overlay-put overl 'end-open nil))
2970 (ediff-overlay-put overl 'ediff-diff-num 0)
2971 overl))))
2973 (defsubst ediff-overlay-start (overl)
2974 (if (ediff-overlayp overl)
2975 (if ediff-emacs-p
2976 (overlay-start overl)
2977 (extent-start-position overl))))
2979 (defsubst ediff-overlay-end (overl)
2980 (if (ediff-overlayp overl)
2981 (if ediff-emacs-p
2982 (overlay-end overl)
2983 (extent-end-position overl))))
2986 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
2987 ;; other insignificant buffers (those beginning with "^[ *]").
2988 ;; Gets one arg--buffer name or a list of buffer names (it won't return
2989 ;; these buffers).
2990 (defun ediff-other-buffer (buff)
2991 (if (not (listp buff)) (setq buff (list buff)))
2992 (let* ((frame-buffers (buffer-list))
2993 (significant-buffers
2994 (mapcar
2995 (function (lambda (x)
2996 (cond ((member (buffer-name x) buff)
2997 nil)
2998 ((not (ediff-get-visible-buffer-window x))
2999 nil)
3000 ((string-match "^ " (buffer-name x))
3001 nil)
3002 (t x))))
3003 frame-buffers))
3004 (buffers (delq nil significant-buffers))
3005 less-significant-buffers)
3007 (cond (buffers (car buffers))
3008 ;; try also buffers that are not displayed in windows
3009 ((setq less-significant-buffers
3010 (delq nil
3011 (mapcar
3012 (function
3013 (lambda (x)
3014 (cond ((member (buffer-name x) buff) nil)
3015 ((string-match "^[ *]" (buffer-name x)) nil)
3016 (t x))))
3017 frame-buffers)))
3018 (car less-significant-buffers))
3019 (t (other-buffer (current-buffer))))
3023 ;; Construct a unique buffer name.
3024 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3025 ;; prefix<3>suffix, etc.
3026 (defun ediff-unique-buffer-name (prefix suffix)
3027 (if (null (get-buffer (concat prefix suffix)))
3028 (concat prefix suffix)
3029 (let ((n 2))
3030 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3031 (setq n (1+ n)))
3032 (format "%s<%d>%s" prefix n suffix))))
3035 ;; splits at a white space, returns a list
3036 (defun ediff-split-string (string)
3037 (let ((start 0)
3038 (result '())
3039 substr)
3040 (while (string-match "[ \t]+" string start)
3041 (let ((match (string-match "[ \t]+" string start)))
3042 (setq substr (substring string start match))
3043 (if (> (length substr) 0)
3044 (setq result (cons substr result)))
3045 (setq start (match-end 0))))
3046 (setq substr (substring string start nil))
3047 (if (> (length substr) 0)
3048 (setq result (cons substr result)))
3049 (nreverse result)))
3051 (defun ediff-submit-report ()
3052 "Submit bug report on Ediff."
3053 (interactive)
3054 (ediff-barf-if-not-control-buffer)
3055 (let ((reporter-prompt-for-summary-p t)
3056 (ctl-buf ediff-control-buffer)
3057 (ediff-device-type (ediff-device-type))
3058 varlist salutation buffer-name)
3059 (setq varlist '(ediff-diff-program ediff-diff-options
3060 ediff-patch-program ediff-patch-options
3061 ediff-shell
3062 ediff-use-faces
3063 ediff-auto-refine ediff-highlighting-style
3064 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3065 ediff-forward-word-function
3066 ediff-control-frame
3067 ediff-control-frame-parameters
3068 ediff-control-frame-position-function
3069 ediff-prefer-iconified-control-frame
3070 ediff-window-setup-function
3071 ediff-split-window-function
3072 ediff-job-name
3073 ediff-word-mode
3074 buffer-name
3075 ediff-device-type
3077 (setq salutation "
3078 Congratulations! You may have unearthed a bug in Ediff!
3080 Please make a concise and accurate summary of what happened
3081 and mail it to the address above.
3082 -----------------------------------------------------------
3085 (ediff-skip-unsuitable-frames)
3086 (ediff-reset-mouse)
3088 (switch-to-buffer ediff-msg-buffer)
3089 (erase-buffer)
3090 (delete-other-windows)
3091 (insert "
3092 Please read this first:
3093 ----------------------
3095 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3096 reporting that certain difference regions are not matched as you think they
3097 should, this is most likely due to the way Unix diff program decides what
3098 constitutes a difference region. Ediff is an Emacs interface to diff, and
3099 it has nothing to do with those decisions---it only takes the output from
3100 diff and presents it in a way that is better suited for human browsing and
3101 manipulation.
3103 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3104 an Emacs bug. Report this to Emacs maintainers.
3106 Another popular topic for reports is compilation messages. Because Ediff
3107 interfaces to several other packages and runs under Emacs and XEmacs,
3108 byte-compilation may produce output like this:
3110 While compiling toplevel forms in file ediff.el:
3111 ** reference to free variable pm-color-alist
3112 ........................
3113 While compiling the end of the data:
3114 ** The following functions are not known to be defined:
3115 ediff-valid-color-p, ediff-set-face,
3116 ........................
3118 These are NOT errors, but inevitable warnings, which ought to be ignored.
3120 Please do not report those and similar things. However, comments and
3121 suggestions are always welcome.
3123 Mail anyway? (y or n) ")
3125 (if (y-or-n-p "Mail anyway? ")
3126 (progn
3127 (if (ediff-buffer-live-p ctl-buf)
3128 (set-buffer ctl-buf))
3129 (setq buffer-name (buffer-name))
3130 (require 'reporter)
3131 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
3132 (ediff-version)
3133 varlist
3134 nil
3135 'delete-other-windows
3136 salutation))
3137 (bury-buffer)
3138 (beep 1)(message "Bug report aborted")
3139 (if (ediff-buffer-live-p ctl-buf)
3140 (ediff-eval-in-buffer ctl-buf
3141 (ediff-recenter 'no-rehighlight))))
3145 (defun ediff-deactivate-mark ()
3146 (if ediff-xemacs-p
3147 (zmacs-deactivate-region)
3148 (deactivate-mark)))
3150 (cond ((fboundp 'nuke-selective-display)
3151 ;; XEmacs 19.12 has nuke-selective-display
3152 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
3154 (defun ediff-nuke-selective-display ()
3155 (save-excursion
3156 (save-restriction
3157 (widen)
3158 (goto-char (point-min))
3159 (let ((mod-p (buffer-modified-p))
3160 buffer-read-only end)
3161 (and (eq t selective-display)
3162 (while (search-forward "\^M" nil t)
3163 (end-of-line)
3164 (setq end (point))
3165 (beginning-of-line)
3166 (while (search-forward "\^M" end t)
3167 (delete-char -1)
3168 (insert "\^J"))))
3169 (set-buffer-modified-p mod-p)
3170 (setq selective-display nil)))))
3174 ;; The next two are modified versions from emerge.el.
3175 ;; VARS must be a list of symbols
3176 ;; ediff-save-variables returns an association list: ((var . val) ...)
3177 (defsubst ediff-save-variables (vars)
3178 (mapcar (function (lambda (v) (cons v (symbol-value v))))
3179 vars))
3180 ;; VARS is a list of variable symbols.
3181 (defun ediff-restore-variables (vars assoc-list)
3182 (while vars
3183 (set (car vars) (cdr (assoc (car vars) assoc-list)))
3184 (setq vars (cdr vars))))
3186 (defun ediff-change-saved-variable (var value buf-type)
3187 (let* ((assoc-list
3188 (symbol-value (intern
3189 (concat "ediff-buffer-values-orig-"
3190 (symbol-name buf-type)))))
3191 (assoc-elt (assoc var assoc-list)))
3192 (if assoc-elt
3193 (setcdr assoc-elt value))))
3196 ;; must execute in control buf
3197 (defun ediff-save-protected-variables ()
3198 (setq ediff-buffer-values-orig-A
3199 (ediff-eval-in-buffer ediff-buffer-A
3200 (ediff-save-variables ediff-protected-variables)))
3201 (setq ediff-buffer-values-orig-B
3202 (ediff-eval-in-buffer ediff-buffer-B
3203 (ediff-save-variables ediff-protected-variables)))
3204 (if ediff-3way-comparison-job
3205 (setq ediff-buffer-values-orig-C
3206 (ediff-eval-in-buffer ediff-buffer-C
3207 (ediff-save-variables ediff-protected-variables))))
3208 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3209 (setq ediff-buffer-values-orig-Ancestor
3210 (ediff-eval-in-buffer ediff-ancestor-buffer
3211 (ediff-save-variables ediff-protected-variables)))))
3213 ;; must execute in control buf
3214 (defun ediff-restore-protected-variables ()
3215 (let ((values-A ediff-buffer-values-orig-A)
3216 (values-B ediff-buffer-values-orig-B)
3217 (values-C ediff-buffer-values-orig-C)
3218 (values-Ancestor ediff-buffer-values-orig-Ancestor))
3219 (ediff-eval-in-buffer ediff-buffer-A
3220 (ediff-restore-variables ediff-protected-variables values-A))
3221 (ediff-eval-in-buffer ediff-buffer-B
3222 (ediff-restore-variables ediff-protected-variables values-B))
3223 (if ediff-3way-comparison-job
3224 (ediff-eval-in-buffer ediff-buffer-C
3225 (ediff-restore-variables ediff-protected-variables values-C)))
3226 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3227 (ediff-eval-in-buffer ediff-ancestor-buffer
3228 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
3231 ;; save BUFFER in FILE. used in hooks.
3232 (defun ediff-save-buffer-in-file (buffer file)
3233 (ediff-eval-in-buffer buffer
3234 (write-file file)))
3237 ;;; Debug
3239 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3241 ;; calculate time used by command
3242 (defun ediff-calc-command-time ()
3243 (let ((end (current-time))
3244 micro sec)
3245 (setq micro
3246 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3247 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3248 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3249 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3250 (or (equal ediff-command-begin-time '(0 0 0))
3251 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3253 (defsubst ediff-save-time ()
3254 (setq ediff-command-begin-time (current-time)))
3256 (defun ediff-profile ()
3257 "Toggle profiling Ediff commands."
3258 (interactive)
3259 (ediff-barf-if-not-control-buffer)
3260 (make-local-hook 'post-command-hook)
3261 (let ((pre-hook 'pre-command-hook)
3262 (post-hook 'post-command-hook))
3263 (if (not (equal ediff-command-begin-time '(0 0 0)))
3264 (progn (remove-hook pre-hook 'ediff-save-time)
3265 (remove-hook post-hook 'ediff-calc-command-time)
3266 (setq ediff-command-begin-time '(0 0 0))
3267 (message "Ediff profiling disabled"))
3268 (add-hook pre-hook 'ediff-save-time t)
3269 (add-hook post-hook 'ediff-calc-command-time)
3270 (message "Ediff profiling enabled"))))
3272 (defun ediff-print-diff-vector (diff-vector-var)
3273 (princ (format "\n*** %S ***\n" diff-vector-var))
3274 (mapcar (function
3275 (lambda (overl-vec)
3276 (princ
3277 (format
3278 "Diff %d: \tOverlay: %S
3279 \t\tFine diffs: %s
3280 \t\tNo-fine-diff-flag: %S
3281 \t\tState-of-diff:\t %S
3282 \t\tState-of-merge:\t %S
3284 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3285 (aref overl-vec 0)
3286 ;; fine-diff-vector
3287 (if (= (length (aref overl-vec 1)) 0)
3288 "none\n"
3289 (mapconcat 'prin1-to-string
3290 (aref overl-vec 1) "\n\t\t\t "))
3291 (aref overl-vec 2) ; no fine diff flag
3292 (aref overl-vec 3) ; state-of-diff
3293 (aref overl-vec 4) ; state-of-merge
3294 ))))
3295 (eval diff-vector-var)))
3299 (defun ediff-debug-info ()
3300 (interactive)
3301 (ediff-barf-if-not-control-buffer)
3302 (with-output-to-temp-buffer ediff-debug-buffer
3303 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3304 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
3305 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
3306 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
3307 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
3311 ;;; General utilities
3313 ;; this uses comparison-func to decide who is a member
3314 (defun ediff-member (elt lis comparison-func)
3315 (while (and lis (not (funcall comparison-func (car lis) elt)))
3316 (setq lis (cdr lis)))
3317 lis)
3319 ;; this uses comparison-func to decide who is a member, and this determines how
3320 ;; intersection looks like
3321 (defun ediff-intersection (lis1 lis2 comparison-func)
3322 (let ((result (list 'a)))
3323 (while lis1
3324 (if (ediff-member (car lis1) lis2 comparison-func)
3325 (nconc result (list (car lis1))))
3326 (setq lis1 (cdr lis1)))
3327 (cdr result)))
3330 ;; eliminates duplicates using comparison-func
3331 (defun ediff-union (lis1 lis2 comparison-func)
3332 (let ((result (list 'a)))
3333 (while lis1
3334 (or (ediff-member (car lis1) (cdr result) comparison-func)
3335 (nconc result (list (car lis1))))
3336 (setq lis1 (cdr lis1)))
3337 (while lis2
3338 (or (ediff-member (car lis2) (cdr result) comparison-func)
3339 (nconc result (list (car lis2))))
3340 (setq lis2 (cdr lis2)))
3341 (cdr result)))
3343 ;; eliminates duplicates using comparison-func
3344 (defun ediff-set-difference (lis1 lis2 comparison-func)
3345 (let ((result (list 'a)))
3346 (while lis1
3347 (or (ediff-member (car lis1) (cdr result) comparison-func)
3348 (ediff-member (car lis1) lis2 comparison-func)
3349 (nconc result (list (car lis1))))
3350 (setq lis1 (cdr lis1)))
3351 (cdr result)))
3353 (defun ediff-copy-list (list)
3354 (if (consp list)
3355 ;;;(let ((res nil))
3356 ;;; (while (consp list) (push (pop list) res))
3357 ;;; (prog1 (nreverse res) (setcdr res list)))
3358 (let (res elt)
3359 (while (consp list)
3360 (setq elt (car list)
3361 res (cons elt res)
3362 list (cdr list)))
3363 (nreverse res))
3364 (car list)))
3367 ;; don't report error if version control package wasn't found
3368 ;;(ediff-load-version-control 'silent)
3370 (run-hooks 'ediff-load-hook)
3373 ;;; Local Variables:
3374 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3375 ;;; eval: (put 'ediff-eval-in-buffer 'lisp-indent-hook 1)
3376 ;;; End:
3378 (provide 'ediff-util)
3380 ;;; ediff-util.el ends here