Some fixes to follow coding conventions in files maintained by FSF.
[emacs.git] / lisp / ediff-util.el
blobc26162715c7988ec73ce42a94e99c8d9c2aa6082
1 ;;; ediff-util.el --- the core commands and utilities of ediff
3 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01 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 (provide 'ediff-util)
28 ;; Compiler pacifier
29 (defvar ediff-patch-diagnostics)
30 (defvar ediff-patchbufer)
31 (defvar ediff-use-toolbar-p)
32 (defvar ediff-toolbar-height)
33 (defvar ediff-toolbar)
34 (defvar ediff-toolbar-3way)
35 (defvar bottom-toolbar)
36 (defvar bottom-toolbar-visible-p)
37 (defvar bottom-toolbar-height)
38 (defvar mark-active)
39 (defvar ediff-emacs-p)
41 (eval-when-compile
42 (let ((load-path (cons (expand-file-name ".") load-path)))
43 (or (featurep 'ediff-init)
44 (load "ediff-init.el" nil nil 'nosuffix))
45 (or (featurep 'ediff-help)
46 (load "ediff-help.el" nil nil 'nosuffix))
47 (or (featurep 'ediff-mult)
48 (load "ediff-mult.el" nil nil 'nosuffix))
49 (or (featurep 'ediff-wind)
50 (load "ediff-wind.el" nil nil 'nosuffix))
51 (or (featurep 'ediff-diff)
52 (load "ediff-diff.el" nil nil 'nosuffix))
53 (or (featurep 'ediff-merg)
54 (load "ediff-merg.el" nil nil 'nosuffix))
55 (or (featurep 'ediff)
56 (load "ediff.el" nil nil 'nosuffix))
57 (or (featurep 'ediff-tbar)
58 ediff-emacs-p
59 (load "ediff-tbar.el" 'noerror nil 'nosuffix))
61 ;; end pacifier
64 (require 'ediff-init)
65 (require 'ediff-help)
66 (require 'ediff-mult)
67 (require 'ediff-wind)
68 (require 'ediff-diff)
69 (require 'ediff-merg)
71 (if ediff-xemacs-p
72 (require 'ediff-tbar))
75 ;;; Functions
77 (defun ediff-mode ()
78 "Ediff mode controls all operations in a single Ediff session.
79 This mode is entered through one of the following commands:
80 `ediff'
81 `ediff-files'
82 `ediff-buffers'
83 `ebuffers'
84 `ediff3'
85 `ediff-files3'
86 `ediff-buffers3'
87 `ebuffers3'
88 `ediff-merge'
89 `ediff-merge-files'
90 `ediff-merge-files-with-ancestor'
91 `ediff-merge-buffers'
92 `ediff-merge-buffers-with-ancestor'
93 `ediff-merge-revisions'
94 `ediff-merge-revisions-with-ancestor'
95 `ediff-windows-wordwise'
96 `ediff-windows-linewise'
97 `ediff-regions-wordwise'
98 `ediff-regions-linewise'
99 `epatch'
100 `ediff-patch-file'
101 `ediff-patch-buffer'
102 `epatch-buffer'
103 `erevision'
104 `ediff-revision'
106 Commands:
107 \\{ediff-mode-map}"
108 (kill-all-local-variables)
109 (setq major-mode 'ediff-mode)
110 (setq mode-name "Ediff")
111 (run-hooks 'ediff-mode-hook))
115 ;;; Build keymaps
117 (ediff-defvar-local ediff-mode-map nil
118 "Local keymap used in Ediff mode.
119 This is local to each Ediff Control Panel, so they may vary from invocation
120 to invocation.")
122 ;; Set up the keymap in the control buffer
123 (defun ediff-set-keys ()
124 "Set up Ediff keymap, if necessary."
125 (if (null ediff-mode-map)
126 (ediff-setup-keymap))
127 (use-local-map ediff-mode-map))
129 ;; Reload Ediff keymap. For debugging only.
130 (defun ediff-reload-keymap ()
131 (interactive)
132 (setq ediff-mode-map nil)
133 (ediff-set-keys))
136 (defun ediff-setup-keymap ()
137 "Set up the keymap used in the control buffer of Ediff."
138 (setq ediff-mode-map (make-sparse-keymap))
139 (suppress-keymap ediff-mode-map)
141 (define-key ediff-mode-map
142 (if ediff-emacs-p [mouse-2] [button2]) 'ediff-help-for-quick-help)
143 (define-key ediff-mode-map "\C-m" 'ediff-help-for-quick-help)
145 (define-key ediff-mode-map "p" 'ediff-previous-difference)
146 (define-key ediff-mode-map "\C-?" 'ediff-previous-difference)
147 (define-key ediff-mode-map [delete] 'ediff-previous-difference)
148 (define-key ediff-mode-map "\C-h" (if ediff-no-emacs-help-in-control-buffer
149 'ediff-previous-difference nil))
150 ;; must come after C-h, or else C-h wipes out backspace's binding in XEmacs
151 (define-key ediff-mode-map [backspace] 'ediff-previous-difference)
152 (define-key ediff-mode-map "n" 'ediff-next-difference)
153 (define-key ediff-mode-map " " 'ediff-next-difference)
154 (define-key ediff-mode-map "j" 'ediff-jump-to-difference)
155 (define-key ediff-mode-map "g" nil)
156 (define-key ediff-mode-map "ga" 'ediff-jump-to-difference-at-point)
157 (define-key ediff-mode-map "gb" 'ediff-jump-to-difference-at-point)
158 (define-key ediff-mode-map "q" 'ediff-quit)
159 (define-key ediff-mode-map "D" 'ediff-show-diff-output)
160 (define-key ediff-mode-map "z" 'ediff-suspend)
161 (define-key ediff-mode-map "\C-l" 'ediff-recenter)
162 (define-key ediff-mode-map "|" 'ediff-toggle-split)
163 (define-key ediff-mode-map "h" 'ediff-toggle-hilit)
164 (or ediff-word-mode
165 (define-key ediff-mode-map "@" 'ediff-toggle-autorefine))
166 (if ediff-narrow-job
167 (define-key ediff-mode-map "%" 'ediff-toggle-narrow-region))
168 (define-key ediff-mode-map "~" 'ediff-swap-buffers)
169 (define-key ediff-mode-map "v" 'ediff-scroll-vertically)
170 (define-key ediff-mode-map "\C-v" 'ediff-scroll-vertically)
171 (define-key ediff-mode-map "^" 'ediff-scroll-vertically)
172 (define-key ediff-mode-map "\M-v" 'ediff-scroll-vertically)
173 (define-key ediff-mode-map "V" 'ediff-scroll-vertically)
174 (define-key ediff-mode-map "<" 'ediff-scroll-horizontally)
175 (define-key ediff-mode-map ">" 'ediff-scroll-horizontally)
176 (define-key ediff-mode-map "i" 'ediff-status-info)
177 (define-key ediff-mode-map "E" 'ediff-documentation)
178 (define-key ediff-mode-map "?" 'ediff-toggle-help)
179 (define-key ediff-mode-map "!" 'ediff-update-diffs)
180 (define-key ediff-mode-map "M" 'ediff-show-current-session-meta-buffer)
181 (define-key ediff-mode-map "R" 'ediff-show-registry)
182 (or ediff-word-mode
183 (define-key ediff-mode-map "*" 'ediff-make-or-kill-fine-diffs))
184 (define-key ediff-mode-map "a" nil)
185 (define-key ediff-mode-map "b" nil)
186 (define-key ediff-mode-map "r" nil)
187 (cond (ediff-merge-job
188 ;; Will barf if no ancestor
189 (define-key ediff-mode-map "/" 'ediff-show-ancestor)
190 ;; In merging, we allow only A->C and B->C copying.
191 (define-key ediff-mode-map "a" 'ediff-copy-A-to-C)
192 (define-key ediff-mode-map "b" 'ediff-copy-B-to-C)
193 (define-key ediff-mode-map "r" 'ediff-restore-diff-in-merge-buffer)
194 (define-key ediff-mode-map "s" 'ediff-shrink-window-C)
195 (define-key ediff-mode-map "+" 'ediff-combine-diffs)
196 (define-key ediff-mode-map "$" nil)
197 (define-key ediff-mode-map "$$" 'ediff-toggle-show-clashes-only)
198 (define-key ediff-mode-map "$*" 'ediff-toggle-skip-changed-regions)
199 (define-key ediff-mode-map "&" 'ediff-re-merge))
200 (ediff-3way-comparison-job
201 (define-key ediff-mode-map "ab" 'ediff-copy-A-to-B)
202 (define-key ediff-mode-map "ba" 'ediff-copy-B-to-A)
203 (define-key ediff-mode-map "ac" 'ediff-copy-A-to-C)
204 (define-key ediff-mode-map "bc" 'ediff-copy-B-to-C)
205 (define-key ediff-mode-map "c" nil)
206 (define-key ediff-mode-map "ca" 'ediff-copy-C-to-A)
207 (define-key ediff-mode-map "cb" 'ediff-copy-C-to-B)
208 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
209 (define-key ediff-mode-map "rb" 'ediff-restore-diff)
210 (define-key ediff-mode-map "rc" 'ediff-restore-diff)
211 (define-key ediff-mode-map "C" 'ediff-toggle-read-only))
212 (t ; 2-way comparison
213 (define-key ediff-mode-map "a" 'ediff-copy-A-to-B)
214 (define-key ediff-mode-map "b" 'ediff-copy-B-to-A)
215 (define-key ediff-mode-map "ra" 'ediff-restore-diff)
216 (define-key ediff-mode-map "rb" 'ediff-restore-diff))
217 ) ; cond
218 (define-key ediff-mode-map "G" 'ediff-submit-report)
219 (define-key ediff-mode-map "#" nil)
220 (define-key ediff-mode-map "#h" 'ediff-toggle-regexp-match)
221 (define-key ediff-mode-map "#f" 'ediff-toggle-regexp-match)
222 (or ediff-word-mode
223 (define-key ediff-mode-map "##" 'ediff-toggle-skip-similar))
224 (define-key ediff-mode-map "o" nil)
225 (define-key ediff-mode-map "A" 'ediff-toggle-read-only)
226 (define-key ediff-mode-map "B" 'ediff-toggle-read-only)
227 (define-key ediff-mode-map "w" nil)
228 (define-key ediff-mode-map "wa" 'ediff-save-buffer)
229 (define-key ediff-mode-map "wb" 'ediff-save-buffer)
230 (define-key ediff-mode-map "wd" 'ediff-save-buffer)
231 (define-key ediff-mode-map "=" 'ediff-inferior-compare-regions)
232 (if (fboundp 'ediff-show-patch-diagnostics)
233 (define-key ediff-mode-map "P" 'ediff-show-patch-diagnostics))
234 (if ediff-3way-job
235 (progn
236 (define-key ediff-mode-map "wc" 'ediff-save-buffer)
237 (define-key ediff-mode-map "gc" 'ediff-jump-to-difference-at-point)
240 (define-key ediff-mode-map "m" 'ediff-toggle-wide-display)
242 ;; Allow ediff-mode-map to be referenced indirectly
243 (fset 'ediff-mode-map ediff-mode-map)
244 (run-hooks 'ediff-keymap-setup-hook))
247 ;;; Setup functions
249 ;; Common startup entry for all Ediff functions It now returns control buffer
250 ;; so other functions can do post-processing SETUP-PARAMETERS is a list of the
251 ;; form ((param .val) (param . val)...) This serves a similar purpose to
252 ;; STARTUP-HOOKS, but these parameters are set in the new control buffer right
253 ;; after this buf is created and before any windows are set and such.
254 (defun ediff-setup (buffer-A file-A buffer-B file-B buffer-C file-C
255 startup-hooks setup-parameters
256 &optional merge-buffer-file)
257 (run-hooks 'ediff-before-setup-hook)
258 ;; ediff-convert-standard-filename puts file names in the form appropriate
259 ;; for the OS at hand.
260 (setq file-A (ediff-convert-standard-filename (expand-file-name file-A)))
261 (setq file-B (ediff-convert-standard-filename (expand-file-name file-B)))
262 (if (stringp file-C)
263 (setq file-C
264 (ediff-convert-standard-filename (expand-file-name file-C))))
265 (if (stringp merge-buffer-file)
266 (progn
267 (setq merge-buffer-file
268 (ediff-convert-standard-filename
269 (expand-file-name merge-buffer-file)))
270 ;; check the directory exists
271 (or (file-exists-p (file-name-directory merge-buffer-file))
272 (error "Directory %s given as place to save the merge doesn't exist."
273 (abbreviate-file-name
274 (file-name-directory merge-buffer-file))))
275 (if (and (file-exists-p merge-buffer-file)
276 (file-directory-p merge-buffer-file))
277 (error "The merge buffer file %s must not be a directory"
278 (abbreviate-file-name merge-buffer-file)))
280 (let* ((control-buffer-name
281 (ediff-unique-buffer-name "*Ediff Control Panel" "*"))
282 (control-buffer (ediff-with-current-buffer buffer-A
283 (get-buffer-create control-buffer-name))))
284 (ediff-with-current-buffer control-buffer
285 (ediff-mode)
287 (make-local-variable 'ediff-use-long-help-message)
288 (make-local-variable 'ediff-prefer-iconified-control-frame)
289 (make-local-variable 'ediff-split-window-function)
290 (make-local-variable 'ediff-default-variant)
291 (make-local-variable 'ediff-merge-window-share)
292 (make-local-variable 'ediff-window-setup-function)
293 (make-local-variable 'ediff-keep-variants)
295 (make-local-hook 'ediff-after-quit-hook-internal)
297 ;; unwrap set up parameters passed as argument
298 (while setup-parameters
299 (set (car (car setup-parameters)) (cdr (car setup-parameters)))
300 (setq setup-parameters (cdr setup-parameters)))
302 ;; set variables classifying the current ediff job
303 ;; must come AFTER setup-parameters
304 (setq ediff-3way-comparison-job (ediff-3way-comparison-job)
305 ediff-merge-job (ediff-merge-job)
306 ediff-merge-with-ancestor-job (ediff-merge-with-ancestor-job)
307 ediff-3way-job (ediff-3way-job)
308 ediff-diff3-job (ediff-diff3-job)
309 ediff-narrow-job (ediff-narrow-job)
310 ediff-windows-job (ediff-windows-job)
311 ediff-word-mode-job (ediff-word-mode-job))
313 ;; Don't delete variants in case of ediff-buffer-* jobs without asking.
314 ;; This is because u may loose work---dangerous.
315 (if (string-match "buffer" (symbol-name ediff-job-name))
316 (setq ediff-keep-variants t))
318 (make-local-hook 'pre-command-hook)
319 (if (ediff-window-display-p)
320 (add-hook 'pre-command-hook 'ediff-spy-after-mouse nil t))
321 (setq ediff-mouse-pixel-position (mouse-pixel-position))
323 ;; adjust for merge jobs
324 (if ediff-merge-job
325 (let ((buf
326 ;; If default variant is `combined', the right stuff is
327 ;; inserted by ediff-do-merge
328 ;; Note: at some point, we tried to put ancestor buffer here
329 ;; (which is currently buffer C. This didn't work right
330 ;; because the merge buffer will contain lossage: diff regions
331 ;; in the ancestor, which correspond to revisions that agree
332 ;; in both buf A and B.
333 (cond ((eq ediff-default-variant 'default-B)
334 buffer-B)
335 (t buffer-A))))
337 (setq ediff-split-window-function
338 ediff-merge-split-window-function)
340 ;; remember the ancestor buffer, if any
341 (setq ediff-ancestor-buffer buffer-C)
343 (setq buffer-C
344 (get-buffer-create
345 (ediff-unique-buffer-name "*ediff-merge" "*")))
346 (save-excursion
347 (set-buffer buffer-C)
348 (insert-buffer buf)
349 (funcall (ediff-with-current-buffer buf major-mode))
350 (add-hook 'local-write-file-hooks 'ediff-set-merge-mode nil t)
352 (setq buffer-read-only nil
353 ediff-buffer-A buffer-A
354 ediff-buffer-B buffer-B
355 ediff-buffer-C buffer-C
356 ediff-control-buffer control-buffer)
358 (ediff-choose-syntax-table)
360 (setq ediff-control-buffer-suffix
361 (if (string-match "<[0-9]*>" control-buffer-name)
362 (substring control-buffer-name
363 (match-beginning 0) (match-end 0))
365 ediff-control-buffer-number
366 (max
369 (string-to-number
370 (substring
371 ediff-control-buffer-suffix
373 (string-match "[0-9]+" ediff-control-buffer-suffix)
374 0))))))
376 (setq ediff-error-buffer
377 (get-buffer-create (ediff-unique-buffer-name "*ediff-errors" "*")))
379 (ediff-with-current-buffer buffer-A (ediff-strip-mode-line-format))
380 (ediff-with-current-buffer buffer-B (ediff-strip-mode-line-format))
381 (if ediff-3way-job
382 (ediff-with-current-buffer buffer-C (ediff-strip-mode-line-format)))
383 (if (ediff-buffer-live-p ediff-ancestor-buffer)
384 (ediff-with-current-buffer ediff-ancestor-buffer
385 (ediff-strip-mode-line-format)))
387 (ediff-save-protected-variables) ; save variables to be restored on exit
389 ;; ediff-setup-diff-regions-function must be set after setup
390 ;; parameters are processed.
391 (setq ediff-setup-diff-regions-function
392 (if ediff-diff3-job
393 'ediff-setup-diff-regions3
394 'ediff-setup-diff-regions))
396 (setq ediff-wide-bounds
397 (list (ediff-make-bullet-proof-overlay
398 '(point-min) '(point-max) ediff-buffer-A)
399 (ediff-make-bullet-proof-overlay
400 '(point-min) '(point-max) ediff-buffer-B)
401 (ediff-make-bullet-proof-overlay
402 '(point-min) '(point-max) ediff-buffer-C)))
404 ;; This has effect only on ediff-windows/regions
405 ;; In all other cases, ediff-visible-region sets visibility bounds to
406 ;; ediff-wide-bounds, and ediff-narrow-bounds are ignored.
407 (if ediff-start-narrowed
408 (setq ediff-visible-bounds ediff-narrow-bounds)
409 (setq ediff-visible-bounds ediff-wide-bounds))
411 (ediff-set-keys) ; comes after parameter setup
413 ;; set up ediff-narrow-bounds, if not set
414 (or ediff-narrow-bounds
415 (setq ediff-narrow-bounds ediff-wide-bounds))
417 ;; All these must be inside ediff-with-current-buffer control-buffer,
418 ;; since these vars are local to control-buffer
419 ;; These won't run if there are errors in diff
420 (ediff-with-current-buffer ediff-buffer-A
421 (ediff-nuke-selective-display)
422 (run-hooks 'ediff-prepare-buffer-hook)
423 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
424 (setq buffer-read-only t))
425 ;; add control-buffer to the list of sessions--no longer used, but may
426 ;; be used again in the future
427 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
428 (setq ediff-this-buffer-ediff-sessions
429 (cons control-buffer ediff-this-buffer-ediff-sessions)))
430 (if ediff-make-buffers-readonly-at-startup
431 (setq buffer-read-only t))
434 (ediff-with-current-buffer ediff-buffer-B
435 (ediff-nuke-selective-display)
436 (run-hooks 'ediff-prepare-buffer-hook)
437 (if (ediff-with-current-buffer control-buffer ediff-merge-job)
438 (setq buffer-read-only t))
439 ;; add control-buffer to the list of sessions
440 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
441 (setq ediff-this-buffer-ediff-sessions
442 (cons control-buffer ediff-this-buffer-ediff-sessions)))
443 (if ediff-make-buffers-readonly-at-startup
444 (setq buffer-read-only t))
447 (if ediff-3way-job
448 (ediff-with-current-buffer ediff-buffer-C
449 (ediff-nuke-selective-display)
450 (run-hooks 'ediff-prepare-buffer-hook)
451 ;; add control-buffer to the list of sessions
452 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
453 (setq ediff-this-buffer-ediff-sessions
454 (cons control-buffer
455 ediff-this-buffer-ediff-sessions)))
456 (if ediff-make-buffers-readonly-at-startup
457 (setq buffer-read-only t))
460 (if (ediff-buffer-live-p ediff-ancestor-buffer)
461 (ediff-with-current-buffer ediff-ancestor-buffer
462 (ediff-nuke-selective-display)
463 (setq buffer-read-only t)
464 (run-hooks 'ediff-prepare-buffer-hook)
465 (or (memq control-buffer ediff-this-buffer-ediff-sessions)
466 (setq ediff-this-buffer-ediff-sessions
467 (cons control-buffer
468 ediff-this-buffer-ediff-sessions)))
471 ;; must come after setting up ediff-narrow-bounds AND after
472 ;; nuking selective display
473 (funcall ediff-setup-diff-regions-function file-A file-B file-C)
474 (setq ediff-number-of-differences (length ediff-difference-vector-A))
475 (setq ediff-current-difference -1)
477 (ediff-make-current-diff-overlay 'A)
478 (ediff-make-current-diff-overlay 'B)
479 (if ediff-3way-job
480 (ediff-make-current-diff-overlay 'C))
481 (if ediff-merge-with-ancestor-job
482 (ediff-make-current-diff-overlay 'Ancestor))
484 (ediff-setup-windows buffer-A buffer-B buffer-C control-buffer)
486 (let ((shift-A (ediff-overlay-start
487 (ediff-get-value-according-to-buffer-type
488 'A ediff-narrow-bounds)))
489 (shift-B (ediff-overlay-start
490 (ediff-get-value-according-to-buffer-type
491 'B ediff-narrow-bounds)))
492 (shift-C (ediff-overlay-start
493 (ediff-get-value-according-to-buffer-type
494 'C ediff-narrow-bounds))))
495 ;; position point in buf A
496 (save-excursion
497 (select-window ediff-window-A)
498 (goto-char shift-A))
499 ;; position point in buf B
500 (save-excursion
501 (select-window ediff-window-B)
502 (goto-char shift-B))
503 (if ediff-3way-job
504 (save-excursion
505 (select-window ediff-window-C)
506 (goto-char shift-C)))
509 (select-window ediff-control-window)
510 (ediff-visible-region)
512 (run-hooks 'startup-hooks)
513 (ediff-arrange-autosave-in-merge-jobs merge-buffer-file)
515 (ediff-refresh-mode-lines)
516 (setq buffer-read-only t)
517 (setq ediff-session-registry
518 (cons control-buffer ediff-session-registry))
519 (ediff-update-registry)
520 (if (ediff-buffer-live-p ediff-meta-buffer)
521 (ediff-update-meta-buffer
522 ediff-meta-buffer nil ediff-meta-session-number))
523 (run-hooks 'ediff-startup-hook)
524 ) ; eval in control-buffer
525 control-buffer))
528 ;; This function assumes that we are in the window where control buffer is
529 ;; to reside.
530 (defun ediff-setup-control-buffer (ctl-buf)
531 "Set up window for control buffer."
532 (if (window-dedicated-p (selected-window))
533 (set-buffer ctl-buf) ; we are in control frame but just in case
534 (switch-to-buffer ctl-buf))
535 (let ((window-min-height 2))
536 (erase-buffer)
537 (ediff-set-help-message)
538 (insert ediff-help-message)
539 (shrink-window-if-larger-than-buffer)
540 (or (ediff-multiframe-setup-p)
541 (ediff-indent-help-message))
542 (ediff-set-help-overlays)
544 (set-buffer-modified-p nil)
545 (ediff-refresh-mode-lines)
546 (setq ediff-control-window (selected-window))
547 (setq ediff-window-config-saved
548 (format "%S%S%S%S%S%S%S"
549 ediff-control-window
550 ediff-window-A
551 ediff-window-B
552 ediff-window-C
553 ediff-split-window-function
554 (ediff-multiframe-setup-p)
555 ediff-wide-display-p))
557 ;; In multiframe, toolbar is set in ediff-setup-control-frame
558 (if (not (ediff-multiframe-setup-p))
559 (ediff-make-bottom-toolbar)) ; this checks if toolbar is requested
560 (goto-char (point-min))
561 (skip-chars-forward ediff-whitespace)))
563 ;; This executes in control buffer and sets auto-save, visited file name, etc,
564 ;; in the merge buffer
565 (defun ediff-arrange-autosave-in-merge-jobs (merge-buffer-file)
566 (if (not ediff-merge-job)
568 (if (stringp merge-buffer-file)
569 (setq ediff-autostore-merges t
570 ediff-merge-store-file merge-buffer-file))
571 (if (stringp ediff-merge-store-file)
572 (progn
573 ;; save before leaving ctl buffer
574 (setq merge-buffer-file ediff-merge-store-file)
575 (ediff-with-current-buffer ediff-buffer-C
576 (set-visited-file-name merge-buffer-file))))
577 (ediff-with-current-buffer ediff-buffer-C
578 (setq buffer-offer-save t) ; ask before killing buffer
579 ;; make sure the contents is auto-saved
580 (auto-save-mode 1))
584 ;;; Commands for working with Ediff
586 (defun ediff-update-diffs ()
587 "Recompute difference regions in buffers A, B, and C.
588 Buffers are not synchronized with their respective files, so changes done
589 to these buffers are not saved at this point---the user can do this later,
590 if necessary."
591 (interactive)
592 (ediff-barf-if-not-control-buffer)
593 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
594 (not
595 (y-or-n-p
596 "Ancestor buffer will not be used. Recompute diffs anyway? ")))
597 (error "Recomputation of differences canceled"))
599 (let ((point-A (ediff-with-current-buffer ediff-buffer-A (point)))
600 ;;(point-B (ediff-with-current-buffer ediff-buffer-B (point)))
601 (tmp-buffer (get-buffer-create ediff-tmp-buffer))
602 (buf-A-file-name (buffer-file-name ediff-buffer-A))
603 (buf-B-file-name (buffer-file-name ediff-buffer-B))
604 ;; (null ediff-buffer-C) is no problem, as we later check if
605 ;; ediff-buffer-C is alive
606 (buf-C-file-name (buffer-file-name ediff-buffer-C))
607 (overl-A (ediff-get-value-according-to-buffer-type
608 'A ediff-narrow-bounds))
609 (overl-B (ediff-get-value-according-to-buffer-type
610 'B ediff-narrow-bounds))
611 (overl-C (ediff-get-value-according-to-buffer-type
612 'C ediff-narrow-bounds))
613 beg-A end-A beg-B end-B beg-C end-C
614 file-A file-B file-C)
616 (if (stringp buf-A-file-name)
617 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
618 (if (stringp buf-B-file-name)
619 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
620 (if (stringp buf-C-file-name)
621 (setq buf-C-file-name (file-name-nondirectory buf-C-file-name)))
623 (ediff-unselect-and-select-difference -1)
625 (setq beg-A (ediff-overlay-start overl-A)
626 beg-B (ediff-overlay-start overl-B)
627 beg-C (ediff-overlay-start overl-C)
628 end-A (ediff-overlay-end overl-A)
629 end-B (ediff-overlay-end overl-B)
630 end-C (ediff-overlay-end overl-C))
632 (if ediff-word-mode
633 (progn
634 (ediff-wordify beg-A end-A ediff-buffer-A tmp-buffer)
635 (setq file-A (ediff-make-temp-file tmp-buffer "regA"))
636 (ediff-wordify beg-B end-B ediff-buffer-B tmp-buffer)
637 (setq file-B (ediff-make-temp-file tmp-buffer "regB"))
638 (if ediff-3way-job
639 (progn
640 (ediff-wordify beg-C end-C ediff-buffer-C tmp-buffer)
641 (setq file-C (ediff-make-temp-file tmp-buffer "regC"))))
643 ;; not word-mode
644 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name))
645 (setq file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
646 (if ediff-3way-job
647 (setq file-C (ediff-make-temp-file ediff-buffer-C buf-C-file-name)))
650 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
651 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
652 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
653 (ediff-clear-diff-vector
654 'ediff-difference-vector-Ancestor 'fine-diffs-also)
655 ;; let them garbage collect. we can't use the ancestor after recomputing
656 ;; the diffs.
657 (setq ediff-difference-vector-Ancestor nil
658 ediff-ancestor-buffer nil
659 ediff-state-of-merge nil)
661 (setq ediff-killed-diffs-alist nil) ; invalidate saved killed diff regions
663 ;; In case of merge job, fool it into thinking that it is just doing
664 ;; comparison
665 (let ((ediff-setup-diff-regions-function ediff-setup-diff-regions-function)
666 (ediff-3way-comparison-job ediff-3way-comparison-job)
667 (ediff-merge-job ediff-merge-job)
668 (ediff-merge-with-ancestor-job ediff-merge-with-ancestor-job)
669 (ediff-job-name ediff-job-name))
670 (if ediff-merge-job
671 (setq ediff-setup-diff-regions-function 'ediff-setup-diff-regions3
672 ediff-3way-comparison-job t
673 ediff-merge-job nil
674 ediff-merge-with-ancestor-job nil
675 ediff-job-name 'ediff-files3))
676 (funcall ediff-setup-diff-regions-function file-A file-B file-C))
678 (setq ediff-number-of-differences (length ediff-difference-vector-A))
679 (delete-file file-A)
680 (delete-file file-B)
681 (if file-C
682 (delete-file file-C))
684 (if ediff-3way-job
685 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
687 (ediff-jump-to-difference (ediff-diff-at-point 'A point-A))
688 (message "")
691 ;; Not bound to any key---to dangerous. A user can do it if necessary.
692 (defun ediff-revert-buffers-then-recompute-diffs (noconfirm)
693 "Revert buffers A, B and C. Then rerun Ediff on file A and file B."
694 (interactive "P")
695 (ediff-barf-if-not-control-buffer)
696 (let ((bufA ediff-buffer-A)
697 (bufB ediff-buffer-B)
698 (bufC ediff-buffer-C)
699 (ctl-buf ediff-control-buffer)
700 (keep-variants ediff-keep-variants)
701 (ancestor-buf ediff-ancestor-buffer)
702 (ancestor-job ediff-merge-with-ancestor-job)
703 (merge ediff-merge-job)
704 (comparison ediff-3way-comparison-job))
705 (ediff-with-current-buffer bufA
706 (revert-buffer t noconfirm))
707 (ediff-with-current-buffer bufB
708 (revert-buffer t noconfirm))
709 ;; this should only be executed in a 3way comparison, not in merge
710 (if comparison
711 (ediff-with-current-buffer bufC
712 (revert-buffer t noconfirm)))
713 (if merge
714 (progn
715 (set-buffer ctl-buf)
716 ;; the argument says whether to reverse the meaning of
717 ;; ediff-keep-variants, i.e., ediff-really-quit runs here with
718 ;; variants kept.
719 (ediff-really-quit (not keep-variants))
720 (kill-buffer bufC)
721 (if ancestor-job
722 (ediff-merge-buffers-with-ancestor bufA bufB ancestor-buf)
723 (ediff-merge-buffers bufA bufB)))
724 (ediff-update-diffs))))
727 ;; optional NO-REHIGHLIGHT says to not rehighlight buffers
728 (defun ediff-recenter (&optional no-rehighlight)
729 "Bring the highlighted region of all buffers being compared into view.
730 Reestablish the default three-window display."
731 (interactive)
732 (ediff-barf-if-not-control-buffer)
733 (let (buffer-read-only)
734 (if (and (ediff-buffer-live-p ediff-buffer-A)
735 (ediff-buffer-live-p ediff-buffer-B)
736 (or (not ediff-3way-job)
737 (ediff-buffer-live-p ediff-buffer-C)))
738 (ediff-setup-windows
739 ediff-buffer-A ediff-buffer-B ediff-buffer-C ediff-control-buffer)
740 (or (eq this-command 'ediff-quit)
741 (message ediff-KILLED-VITAL-BUFFER
742 (beep 1)))
745 ;; set visibility range appropriate to this invocation of Ediff.
746 (ediff-visible-region)
747 ;; raise
748 (if (and (ediff-window-display-p)
749 (symbolp this-command)
750 (symbolp last-command)
751 ;; Either one of the display-changing commands
752 (or (memq this-command
753 '(ediff-recenter
754 ediff-dir-action ediff-registry-action
755 ediff-patch-action
756 ediff-toggle-wide-display ediff-toggle-multiframe))
757 ;; Or one of the movement cmds and prev cmd was an Ediff cmd
758 ;; This avoids raising frames unnecessarily.
759 (and (memq this-command
760 '(ediff-next-difference
761 ediff-previous-difference
762 ediff-jump-to-difference
763 ediff-jump-to-difference-at-point))
764 (not (string-match "^ediff-" (symbol-name last-command)))
766 (progn
767 (if (window-live-p ediff-window-A)
768 (raise-frame (window-frame ediff-window-A)))
769 (if (window-live-p ediff-window-B)
770 (raise-frame (window-frame ediff-window-B)))
771 (if (window-live-p ediff-window-C)
772 (raise-frame (window-frame ediff-window-C)))))
773 (if (and (ediff-window-display-p)
774 (frame-live-p ediff-control-frame)
775 (not ediff-use-long-help-message)
776 (not (ediff-frame-iconified-p ediff-control-frame)))
777 (raise-frame ediff-control-frame))
779 ;; Redisplay whatever buffers are showing, if there is a selected difference
780 (let ((control-frame ediff-control-frame)
781 (control-buf ediff-control-buffer))
782 (if (and (ediff-buffer-live-p ediff-buffer-A)
783 (ediff-buffer-live-p ediff-buffer-B)
784 (or (not ediff-3way-job)
785 (ediff-buffer-live-p ediff-buffer-C)))
786 (progn
787 (or no-rehighlight
788 (ediff-select-difference ediff-current-difference))
790 (ediff-recenter-one-window 'A)
791 (ediff-recenter-one-window 'B)
792 (if ediff-3way-job
793 (ediff-recenter-one-window 'C))
795 (ediff-with-current-buffer control-buf
796 (ediff-recenter-ancestor) ; check if ancestor is alive
798 (if (and (ediff-multiframe-setup-p)
799 (not ediff-use-long-help-message)
800 (not (ediff-frame-iconified-p ediff-control-frame)))
801 ;; never grab mouse on quit in this place
802 (ediff-reset-mouse
803 control-frame
804 (eq this-command 'ediff-quit))))
807 (ediff-restore-highlighting)
808 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
811 ;; this function returns to the window it was called from
812 ;; (which was the control window)
813 (defun ediff-recenter-one-window (buf-type)
814 (if (ediff-valid-difference-p)
815 ;; context must be saved before switching to windows A/B/C
816 (let* ((ctl-wind (selected-window))
817 (shift (ediff-overlay-start
818 (ediff-get-value-according-to-buffer-type
819 buf-type ediff-narrow-bounds)))
820 (job-name ediff-job-name)
821 (control-buf ediff-control-buffer)
822 (window-name (ediff-get-symbol-from-alist
823 buf-type ediff-window-alist))
824 (window (if (window-live-p (symbol-value window-name))
825 (symbol-value window-name))))
827 (if (and window ediff-windows-job)
828 (set-window-start window shift))
829 (if window
830 (progn
831 (select-window window)
832 (ediff-deactivate-mark)
833 (ediff-position-region
834 (ediff-get-diff-posn buf-type 'beg nil control-buf)
835 (ediff-get-diff-posn buf-type 'end nil control-buf)
836 (ediff-get-diff-posn buf-type 'beg nil control-buf)
837 job-name
839 (select-window ctl-wind)
842 (defun ediff-recenter-ancestor ()
843 ;; do half-hearted job by recentering the ancestor buffer, if it is alive and
844 ;; visible.
845 (if (and (ediff-buffer-live-p ediff-ancestor-buffer)
846 (ediff-valid-difference-p))
847 (let ((window (ediff-get-visible-buffer-window ediff-ancestor-buffer))
848 (ctl-wind (selected-window))
849 (job-name ediff-job-name)
850 (ctl-buf ediff-control-buffer))
851 (ediff-with-current-buffer ediff-ancestor-buffer
852 (goto-char (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf))
853 (if window
854 (progn
855 (select-window window)
856 (ediff-position-region
857 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
858 (ediff-get-diff-posn 'Ancestor 'end nil ctl-buf)
859 (ediff-get-diff-posn 'Ancestor 'beg nil ctl-buf)
860 job-name))))
861 (select-window ctl-wind)
865 ;; This will have to be refined for 3way jobs
866 (defun ediff-toggle-split ()
867 "Toggle vertical/horizontal window split.
868 Does nothing if file-A and file-B are in different frames."
869 (interactive)
870 (ediff-barf-if-not-control-buffer)
871 (let* ((wind-A (if (window-live-p ediff-window-A) ediff-window-A))
872 (wind-B (if (window-live-p ediff-window-B) ediff-window-B))
873 (wind-C (if (window-live-p ediff-window-C) ediff-window-C))
874 (frame-A (if wind-A (window-frame wind-A)))
875 (frame-B (if wind-B (window-frame wind-B)))
876 (frame-C (if wind-C (window-frame wind-C))))
877 (if (or (eq frame-A frame-B)
878 (not (frame-live-p frame-A))
879 (not (frame-live-p frame-B))
880 (if ediff-3way-comparison-job
881 (or (not (frame-live-p frame-C))
882 (eq frame-A frame-C) (eq frame-B frame-C))))
883 (setq ediff-split-window-function
884 (if (eq ediff-split-window-function 'split-window-vertically)
885 'split-window-horizontally
886 'split-window-vertically))
887 (message "Buffers being compared are in different frames"))
888 (ediff-recenter 'no-rehighlight)))
890 (defun ediff-toggle-hilit ()
891 "Switch between highlighting using ASCII flags and highlighting using faces.
892 On a dumb terminal, switches between ASCII highlighting and no highlighting."
893 (interactive)
894 (ediff-barf-if-not-control-buffer)
895 (if (not (ediff-has-face-support-p))
896 (if (eq ediff-highlighting-style 'ascii)
897 (progn
898 (message "ASCII highlighting flags removed")
899 (ediff-unselect-and-select-difference ediff-current-difference
900 'unselect-only)
901 (setq ediff-highlighting-style 'off))
902 (ediff-unselect-and-select-difference ediff-current-difference
903 'select-only))
904 (ediff-unselect-and-select-difference ediff-current-difference
905 'unselect-only)
906 ;; cycle through highlighting
907 (cond ((and ediff-use-faces ediff-highlight-all-diffs)
908 (message "Unhighlighting unselected difference regions")
909 (setq ediff-highlight-all-diffs nil))
910 (ediff-use-faces
911 (message "Highlighting with ASCII flags")
912 (setq ediff-use-faces nil))
914 (message "Re-highlighting all difference regions")
915 (setq ediff-use-faces t
916 ediff-highlight-all-diffs t)))
918 (if (and ediff-use-faces ediff-highlight-all-diffs)
919 (ediff-paint-background-regions)
920 (ediff-paint-background-regions 'unhighlight))
922 (ediff-unselect-and-select-difference
923 ediff-current-difference 'select-only))
927 (defun ediff-toggle-autorefine ()
928 "Toggle auto-refine mode."
929 (interactive)
930 (ediff-barf-if-not-control-buffer)
931 (if ediff-word-mode
932 (error "No fine differences in this mode"))
933 (cond ((eq ediff-auto-refine 'nix)
934 (setq ediff-auto-refine 'on)
935 (ediff-make-fine-diffs ediff-current-difference 'noforce)
936 (message "Auto-refining is ON"))
937 ((eq ediff-auto-refine 'on)
938 (message "Auto-refining is OFF")
939 (setq ediff-auto-refine 'off))
940 (t ;; nix 'em
941 (ediff-set-fine-diff-properties ediff-current-difference 'default)
942 (message "Refinements are HIDDEN")
943 (setq ediff-auto-refine 'nix))
946 (defun ediff-show-ancestor ()
947 "Show the ancestor buffer in a suitable window."
948 (interactive)
949 (ediff-recenter)
950 (or (ediff-buffer-live-p ediff-ancestor-buffer)
951 (if ediff-merge-with-ancestor-job
952 (error "Lost connection to ancestor buffer...sorry")
953 (error "Not merging with ancestor")))
954 (let (wind)
955 (cond ((setq wind (ediff-get-visible-buffer-window ediff-ancestor-buffer))
956 (raise-frame (window-frame wind)))
957 (t (set-window-buffer ediff-window-C ediff-ancestor-buffer)))))
959 (defun ediff-make-or-kill-fine-diffs (arg)
960 "Compute fine diffs. With negative prefix arg, kill fine diffs.
961 In both cases, operates on the current difference region."
962 (interactive "P")
963 (ediff-barf-if-not-control-buffer)
964 (cond ((eq arg '-)
965 (ediff-clear-fine-differences ediff-current-difference))
966 ((and (numberp arg) (< arg 0))
967 (ediff-clear-fine-differences ediff-current-difference))
968 (t (ediff-make-fine-diffs))))
971 (defun ediff-toggle-help ()
972 "Toggle short/long help message."
973 (interactive)
974 (ediff-barf-if-not-control-buffer)
975 (let (buffer-read-only)
976 (erase-buffer)
977 (setq ediff-use-long-help-message (not ediff-use-long-help-message))
978 (ediff-set-help-message))
979 ;; remember the icon status of the control frame when the user requested
980 ;; full control message
981 (if (and ediff-use-long-help-message (ediff-multiframe-setup-p))
982 (setq ediff-prefer-iconified-control-frame
983 (ediff-frame-iconified-p ediff-control-frame)))
985 (setq ediff-window-config-saved "") ; force redisplay
986 (ediff-recenter 'no-rehighlight))
989 ;; If BUF, this is the buffer to toggle, not current buffer.
990 (defun ediff-toggle-read-only (&optional buf)
991 "Toggle read-only in current buffer.
992 If buffer is under version control and locked, check it out first.
993 If optional argument BUF is specified, toggle read-only in that buffer instead
994 of the current buffer."
995 (interactive)
996 (ediff-barf-if-not-control-buffer)
997 (let ((ctl-buf (if (null buf) (current-buffer)))
998 (buf-type (ediff-char-to-buftype last-command-char)))
999 (or buf (ediff-recenter))
1000 (or buf
1001 (setq buf (ediff-get-buffer buf-type)))
1003 (ediff-with-current-buffer buf ; eval in buf A/B/C
1004 (let* ((file (buffer-file-name buf))
1005 (file-writable (and file
1006 (file-exists-p file)
1007 (file-writable-p file)))
1008 (toggle-ro-cmd (cond (ediff-toggle-read-only-function)
1009 ((ediff-file-checked-out-p file)
1010 'toggle-read-only)
1011 (file-writable 'toggle-read-only)
1012 (t (key-binding "\C-x\C-q")))))
1013 ;; If the file is checked in, make sure we don't make buffer modifiable
1014 ;; without warning the user. The user can fool our checks by making the
1015 ;; buffer non-RO without checking the file out. We regard this as a
1016 ;; user problem.
1017 (if (and (ediff-file-checked-in-p file)
1018 ;; If ctl-buf is null, this means we called this
1019 ;; non-interactively, in which case don't ask questions
1020 ctl-buf)
1021 (cond ((not buffer-read-only)
1022 (setq toggle-ro-cmd 'toggle-read-only))
1023 ((and (or (beep 1) t) ; always beep
1024 (y-or-n-p
1025 (format
1026 "File %s is under version control. Check it out? "
1027 (ediff-abbreviate-file-name file))))
1028 ;; if we checked the file out, we should also change the
1029 ;; original state of buffer-read-only to nil. If we don't
1030 ;; do this, the mode line will show %%, since the file was
1031 ;; RO before ediff started, so the user will think the file
1032 ;; is checked in.
1033 (ediff-with-current-buffer ctl-buf
1034 (ediff-change-saved-variable
1035 'buffer-read-only nil buf-type)))
1037 (setq toggle-ro-cmd 'toggle-read-only)
1038 (beep 1) (beep 1)
1039 (message
1040 "Boy, this is risky! Don't modify this file...")
1041 (sit-for 3)))) ; let the user see the warning
1042 (if (and toggle-ro-cmd
1043 (string-match "toggle-read-only" (symbol-name toggle-ro-cmd)))
1044 (save-excursion
1045 (save-window-excursion
1046 (select-window (ediff-get-visible-buffer-window buf))
1047 (command-execute toggle-ro-cmd)))
1048 (error "Don't know how to toggle read-only in buffer %S" buf))
1050 ;; Check if we made the current buffer updatable, but its file is RO.
1051 ;; Signal a warning in this case.
1052 (if (and file (not buffer-read-only)
1053 (eq this-command 'ediff-toggle-read-only)
1054 (file-exists-p file)
1055 (not (file-writable-p file)))
1056 (message "Warning: file %s is read-only"
1057 (ediff-abbreviate-file-name file) (beep 1)))
1058 ))))
1060 ;; checkout if visited file is checked in
1061 (defun ediff-maybe-checkout (buf)
1062 (let ((file (expand-file-name (buffer-file-name buf)))
1063 (checkout-function (key-binding "\C-x\C-q")))
1064 (if (and (ediff-file-checked-in-p file)
1065 (or (beep 1) t)
1066 (y-or-n-p
1067 (format
1068 "File %s is under version control. Check it out? "
1069 (ediff-abbreviate-file-name file))))
1070 (ediff-with-current-buffer buf
1071 (command-execute checkout-function)))))
1074 ;; This is a simple-minded check for whether a file is under version control.
1075 ;; If file,v exists but file doesn't, this file is considered to be not checked
1076 ;; in and not checked out for the purpose of patching (since patch won't be
1077 ;; able to read such a file anyway).
1078 ;; FILE is a string representing file name
1079 ;;(defun ediff-file-under-version-control (file)
1080 ;; (let* ((filedir (file-name-directory file))
1081 ;; (file-nondir (file-name-nondirectory file))
1082 ;; (trial (concat file-nondir ",v"))
1083 ;; (full-trial (concat filedir trial))
1084 ;; (full-rcs-trial (concat filedir "RCS/" trial)))
1085 ;; (and (stringp file)
1086 ;; (file-exists-p file)
1087 ;; (or
1088 ;; (and
1089 ;; (file-exists-p full-trial)
1090 ;; ;; in FAT FS, `file,v' and `file' may turn out to be the same!
1091 ;; ;; don't be fooled by this!
1092 ;; (not (equal (file-attributes file)
1093 ;; (file-attributes full-trial))))
1094 ;; ;; check if a version is in RCS/ directory
1095 ;; (file-exists-p full-rcs-trial)))
1096 ;; ))
1099 (defsubst ediff-file-checked-out-p (file)
1100 (or (not (featurep 'vc-hooks))
1101 (and (vc-backend file)
1102 (or (memq (vc-state file) '(edited needs-merge))
1103 (stringp (vc-state file))))))
1105 (defsubst ediff-file-checked-in-p (file)
1106 (and (featurep 'vc-hooks)
1107 ;; CVS files are considered not checked in
1108 (not (memq (vc-backend file) '(nil CVS)))
1109 (not (memq (vc-state file) '(edited needs-merge)))
1110 (not (stringp (vc-state file)))))
1112 (defun ediff-file-compressed-p (file)
1113 (condition-case nil
1114 (require 'jka-compr)
1115 (error))
1116 (if (featurep 'jka-compr)
1117 (string-match (jka-compr-build-file-regexp) file)))
1120 (defun ediff-swap-buffers ()
1121 "Rotate the display of buffers A, B, and C."
1122 (interactive)
1123 (ediff-barf-if-not-control-buffer)
1124 (if (and (window-live-p ediff-window-A) (window-live-p ediff-window-B))
1125 (let ((buf ediff-buffer-A)
1126 (values ediff-buffer-values-orig-A)
1127 (diff-vec ediff-difference-vector-A)
1128 (hide-regexp ediff-regexp-hide-A)
1129 (focus-regexp ediff-regexp-focus-A)
1130 (wide-visibility-p (eq ediff-visible-bounds ediff-wide-bounds))
1131 (overlay (if (ediff-has-face-support-p)
1132 ediff-current-diff-overlay-A)))
1133 (if ediff-3way-comparison-job
1134 (progn
1135 (set-window-buffer ediff-window-A ediff-buffer-C)
1136 (set-window-buffer ediff-window-B ediff-buffer-A)
1137 (set-window-buffer ediff-window-C ediff-buffer-B)
1139 (set-window-buffer ediff-window-A ediff-buffer-B)
1140 (set-window-buffer ediff-window-B ediff-buffer-A))
1141 ;; swap diff buffers
1142 (if ediff-3way-comparison-job
1143 (setq ediff-buffer-A ediff-buffer-C
1144 ediff-buffer-C ediff-buffer-B
1145 ediff-buffer-B buf)
1146 (setq ediff-buffer-A ediff-buffer-B
1147 ediff-buffer-B buf))
1149 ;; swap saved buffer characteristics
1150 (if ediff-3way-comparison-job
1151 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-C
1152 ediff-buffer-values-orig-C ediff-buffer-values-orig-B
1153 ediff-buffer-values-orig-B values)
1154 (setq ediff-buffer-values-orig-A ediff-buffer-values-orig-B
1155 ediff-buffer-values-orig-B values))
1157 ;; swap diff vectors
1158 (if ediff-3way-comparison-job
1159 (setq ediff-difference-vector-A ediff-difference-vector-C
1160 ediff-difference-vector-C ediff-difference-vector-B
1161 ediff-difference-vector-B diff-vec)
1162 (setq ediff-difference-vector-A ediff-difference-vector-B
1163 ediff-difference-vector-B diff-vec))
1165 ;; swap hide/focus regexp
1166 (if ediff-3way-comparison-job
1167 (setq ediff-regexp-hide-A ediff-regexp-hide-C
1168 ediff-regexp-hide-C ediff-regexp-hide-B
1169 ediff-regexp-hide-B hide-regexp
1170 ediff-regexp-focus-A ediff-regexp-focus-C
1171 ediff-regexp-focus-C ediff-regexp-focus-B
1172 ediff-regexp-focus-B focus-regexp)
1173 (setq ediff-regexp-hide-A ediff-regexp-hide-B
1174 ediff-regexp-hide-B hide-regexp
1175 ediff-regexp-focus-A ediff-regexp-focus-B
1176 ediff-regexp-focus-B focus-regexp))
1178 ;; The following is needed for XEmacs, since there one can't move
1179 ;; overlay to another buffer. In Emacs, this swap is redundant.
1180 (if (ediff-has-face-support-p)
1181 (if ediff-3way-comparison-job
1182 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-C
1183 ediff-current-diff-overlay-C ediff-current-diff-overlay-B
1184 ediff-current-diff-overlay-B overlay)
1185 (setq ediff-current-diff-overlay-A ediff-current-diff-overlay-B
1186 ediff-current-diff-overlay-B overlay)))
1188 ;; swap wide bounds
1189 (setq ediff-wide-bounds
1190 (cond (ediff-3way-comparison-job
1191 (list (nth 2 ediff-wide-bounds)
1192 (nth 0 ediff-wide-bounds)
1193 (nth 1 ediff-wide-bounds)))
1194 (ediff-3way-job
1195 (list (nth 1 ediff-wide-bounds)
1196 (nth 0 ediff-wide-bounds)
1197 (nth 2 ediff-wide-bounds)))
1199 (list (nth 1 ediff-wide-bounds)
1200 (nth 0 ediff-wide-bounds)))))
1201 ;; swap narrow bounds
1202 (setq ediff-narrow-bounds
1203 (cond (ediff-3way-comparison-job
1204 (list (nth 2 ediff-narrow-bounds)
1205 (nth 0 ediff-narrow-bounds)
1206 (nth 1 ediff-narrow-bounds)))
1207 (ediff-3way-job
1208 (list (nth 1 ediff-narrow-bounds)
1209 (nth 0 ediff-narrow-bounds)
1210 (nth 2 ediff-narrow-bounds)))
1212 (list (nth 1 ediff-narrow-bounds)
1213 (nth 0 ediff-narrow-bounds)))))
1214 (if wide-visibility-p
1215 (setq ediff-visible-bounds ediff-wide-bounds)
1216 (setq ediff-visible-bounds ediff-narrow-bounds))
1218 (if ediff-3way-job
1219 (ediff-set-state-of-all-diffs-in-all-buffers ediff-control-buffer))
1220 (ediff-recenter 'no-rehighlight)
1224 (defun ediff-toggle-wide-display ()
1225 "Toggle wide/regular display.
1226 This is especially useful when comparing buffers side-by-side."
1227 (interactive)
1228 (ediff-barf-if-not-control-buffer)
1229 (or (ediff-window-display-p)
1230 (error "%sEmacs is not running as a window application"
1231 (if ediff-emacs-p "" "X")))
1232 (ediff-recenter 'no-rehighlight) ; make sure buffs are displayed in windows
1233 (let ((ctl-buf ediff-control-buffer))
1234 (setq ediff-wide-display-p (not ediff-wide-display-p))
1235 (if (not ediff-wide-display-p)
1236 (ediff-with-current-buffer ctl-buf
1237 (modify-frame-parameters
1238 ediff-wide-display-frame ediff-wide-display-orig-parameters)
1239 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1240 ;; restore control buf, since ctl window may have been deleted
1241 ;; during resizing
1242 (set-buffer ctl-buf)
1243 (setq ediff-wide-display-orig-parameters nil
1244 ediff-window-B nil) ; force update of window config
1245 (ediff-recenter 'no-rehighlight))
1246 (funcall ediff-make-wide-display-function)
1247 ;;(sit-for (if ediff-xemacs-p 0.4 0))
1248 (ediff-with-current-buffer ctl-buf
1249 (setq ediff-window-B nil) ; force update of window config
1250 (ediff-recenter 'no-rehighlight)))))
1252 ;;;###autoload
1253 (defun ediff-toggle-multiframe ()
1254 "Switch from multiframe display to single-frame display and back.
1255 To change the default, set the variable `ediff-window-setup-function',
1256 which see."
1257 (interactive)
1258 (let (window-setup-func)
1259 (or (ediff-window-display-p)
1260 (error "%sEmacs is not running as a window application"
1261 (if ediff-emacs-p "" "X")))
1263 (cond ((eq ediff-window-setup-function 'ediff-setup-windows-multiframe)
1264 (setq window-setup-func 'ediff-setup-windows-plain))
1265 ((eq ediff-window-setup-function 'ediff-setup-windows-plain)
1266 (if (ediff-in-control-buffer-p)
1267 (ediff-kill-bottom-toolbar))
1268 (setq window-setup-func 'ediff-setup-windows-multiframe)))
1270 ;; change default
1271 (setq-default ediff-window-setup-function window-setup-func)
1272 ;; change in all active ediff sessions
1273 (mapcar (lambda(buf) (ediff-with-current-buffer buf
1274 (setq ediff-window-setup-function window-setup-func
1275 ediff-window-B nil)))
1276 ediff-session-registry)
1277 (if (ediff-in-control-buffer-p)
1278 (ediff-recenter 'no-rehighlight))))
1281 ;;;###autoload
1282 (defun ediff-toggle-use-toolbar ()
1283 "Enable or disable Ediff toolbar.
1284 Works only in versions of Emacs that support toolbars.
1285 To change the default, set the variable `ediff-use-toolbar-p', which see."
1286 (interactive)
1287 (if (featurep 'ediff-tbar)
1288 (progn
1289 (or (ediff-window-display-p)
1290 (error "%sEmacs is not running as a window application"
1291 (if ediff-emacs-p "" "X")))
1292 (if (ediff-use-toolbar-p)
1293 (ediff-kill-bottom-toolbar))
1294 ;; do this only after killing the toolbar
1295 (setq ediff-use-toolbar-p (not ediff-use-toolbar-p))
1297 (mapcar (lambda(buf)
1298 (ediff-with-current-buffer buf
1299 ;; force redisplay
1300 (setq ediff-window-config-saved "")
1302 ediff-session-registry)
1303 (if (ediff-in-control-buffer-p)
1304 (ediff-recenter 'no-rehighlight)))))
1307 ;; if was using toolbar, kill it
1308 (defun ediff-kill-bottom-toolbar ()
1309 ;; Using ctl-buffer or ediff-control-window for LOCALE does not
1310 ;; work properly in XEmacs 19.14: we have to use
1311 ;;(selected-frame).
1312 ;; The problem with this is that any previous bottom-toolbar
1313 ;; will not re-appear after our cleanup here. Is there a way
1314 ;; to do "push" and "pop" toolbars ? --marcpa
1315 (if (ediff-use-toolbar-p)
1316 (progn
1317 (set-specifier bottom-toolbar (list (selected-frame) nil))
1318 (set-specifier bottom-toolbar-visible-p (list (selected-frame) nil)))))
1320 ;; If wants to use toolbar, make it.
1321 ;; If not, zero the toolbar for XEmacs.
1322 ;; Do nothing for Emacs.
1323 (defun ediff-make-bottom-toolbar (&optional frame)
1324 (if (ediff-window-display-p)
1325 (progn
1326 (setq frame (or frame (selected-frame)))
1327 (cond ((ediff-use-toolbar-p) ; this checks for XEmacs
1328 (set-specifier
1329 bottom-toolbar
1330 (list frame (if (ediff-3way-comparison-job)
1331 ediff-toolbar-3way ediff-toolbar)))
1332 (set-specifier bottom-toolbar-visible-p (list frame t))
1333 (set-specifier bottom-toolbar-height
1334 (list frame ediff-toolbar-height)))
1335 ((ediff-has-toolbar-support-p)
1336 (set-specifier bottom-toolbar-height (list frame 0)))
1340 ;; Merging
1342 (defun ediff-toggle-show-clashes-only ()
1343 "Toggle the mode that shows only the merge regions where both variants differ from the ancestor."
1344 (interactive)
1345 (ediff-barf-if-not-control-buffer)
1346 (if (not ediff-merge-with-ancestor-job)
1347 (error "This command makes sense only when merging with an ancestor"))
1348 (setq ediff-show-clashes-only (not ediff-show-clashes-only))
1349 (if ediff-show-clashes-only
1350 (message "Focus on regions where both buffers differ from the ancestor")
1351 (message "Canceling focus on regions where changes clash")))
1353 (defun ediff-toggle-skip-changed-regions ()
1354 "Toggle the mode that skips the merge regions that differ from the default."
1355 (interactive)
1356 (ediff-barf-if-not-control-buffer)
1357 (setq ediff-skip-merge-regions-that-differ-from-default
1358 (not ediff-skip-merge-regions-that-differ-from-default))
1359 (if ediff-skip-merge-regions-that-differ-from-default
1360 (message "Skipping regions that differ from default setting")
1361 (message "Showing regions that differ from default setting")))
1365 ;; Widening/narrowing
1367 (defun ediff-toggle-narrow-region ()
1368 "Toggle narrowing in buffers A, B, and C.
1369 Used in ediff-windows/regions only."
1370 (interactive)
1371 (if (eq ediff-buffer-A ediff-buffer-B)
1372 (error ediff-NO-DIFFERENCES))
1373 (if (eq ediff-visible-bounds ediff-wide-bounds)
1374 (setq ediff-visible-bounds ediff-narrow-bounds)
1375 (setq ediff-visible-bounds ediff-wide-bounds))
1376 (ediff-recenter 'no-rehighlight))
1378 ;; Narrow bufs A/B/C to ediff-visible-bounds. If this is currently set to
1379 ;; ediff-wide-bounds, then this actually widens.
1380 ;; This function does nothing if job-name is not
1381 ;; ediff-regions-wordwise/linewise or ediff-windows-wordwise/linewise.
1382 ;; Does nothing if buffer-A = buffer-B since we can't narrow
1383 ;; to two different regions in one buffer.
1384 (defun ediff-visible-region ()
1385 (if (or (eq ediff-buffer-A ediff-buffer-B)
1386 (eq ediff-buffer-A ediff-buffer-C)
1387 (eq ediff-buffer-C ediff-buffer-B))
1389 ;; If ediff-*-regions/windows, ediff-visible-bounds is already set
1390 ;; Otherwise, always use full range.
1391 (if (not ediff-narrow-job)
1392 (setq ediff-visible-bounds ediff-wide-bounds))
1393 (let ((overl-A (ediff-get-value-according-to-buffer-type
1394 'A ediff-visible-bounds))
1395 (overl-B (ediff-get-value-according-to-buffer-type
1396 'B ediff-visible-bounds))
1397 (overl-C (ediff-get-value-according-to-buffer-type
1398 'C ediff-visible-bounds))
1400 (ediff-with-current-buffer ediff-buffer-A
1401 (if (ediff-overlay-buffer overl-A)
1402 (narrow-to-region
1403 (ediff-overlay-start overl-A) (ediff-overlay-end overl-A))))
1404 (ediff-with-current-buffer ediff-buffer-B
1405 (if (ediff-overlay-buffer overl-B)
1406 (narrow-to-region
1407 (ediff-overlay-start overl-B) (ediff-overlay-end overl-B))))
1409 (if (and ediff-3way-job (ediff-overlay-buffer overl-C))
1410 (ediff-with-current-buffer ediff-buffer-C
1411 (narrow-to-region
1412 (ediff-overlay-start overl-C) (ediff-overlay-end overl-C))))
1416 ;; Window scrolling operations
1418 ;; Performs some operation on the two file windows (if they are showing).
1419 ;; Traps all errors on the operation in windows A/B/C.
1420 ;; Usually, errors come from scrolling off the
1421 ;; beginning or end of the buffer, and this gives error messages.
1422 (defun ediff-operate-on-windows (operation arg)
1424 ;; make sure windows aren't dead
1425 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1426 (ediff-recenter 'no-rehighlight))
1427 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1428 (ediff-buffer-live-p ediff-buffer-B)
1429 (or (not ediff-3way-job) ediff-buffer-C)
1431 (error ediff-KILLED-VITAL-BUFFER))
1433 (let* ((wind (selected-window))
1434 (wind-A ediff-window-A)
1435 (wind-B ediff-window-B)
1436 (wind-C ediff-window-C)
1437 (coefA (ediff-get-region-size-coefficient 'A operation))
1438 (coefB (ediff-get-region-size-coefficient 'B operation))
1439 (three-way ediff-3way-job)
1440 (coefC (if three-way
1441 (ediff-get-region-size-coefficient 'C operation))))
1443 (select-window wind-A)
1444 (condition-case nil
1445 (funcall operation (round (* coefA arg)))
1446 (error))
1447 (select-window wind-B)
1448 (condition-case nil
1449 (funcall operation (round (* coefB arg)))
1450 (error))
1451 (if three-way
1452 (progn
1453 (select-window wind-C)
1454 (condition-case nil
1455 (funcall operation (round (* coefC arg)))
1456 (error))))
1457 (select-window wind)))
1459 (defun ediff-scroll-vertically (&optional arg)
1460 "Vertically scroll buffers A, B \(and C if appropriate\).
1461 With optional argument ARG, scroll ARG lines; otherwise scroll by nearly
1462 the one half of the height of window-A."
1463 (interactive "P")
1464 (ediff-barf-if-not-control-buffer)
1466 ;; make sure windows aren't dead
1467 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1468 (ediff-recenter 'no-rehighlight))
1469 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1470 (ediff-buffer-live-p ediff-buffer-B)
1471 (or (not ediff-3way-job)
1472 (ediff-buffer-live-p ediff-buffer-C))
1474 (error ediff-KILLED-VITAL-BUFFER))
1476 (ediff-operate-on-windows
1477 (if (memq last-command-char '(?v ?\C-v))
1478 'scroll-up
1479 'scroll-down)
1480 ;; calculate argument to scroll-up/down
1481 ;; if there is an explicit argument
1482 (if (and arg (not (equal arg '-)))
1483 ;; use it
1484 (prefix-numeric-value arg)
1485 ;; if not, see if we can determine a default amount (the window height)
1486 (let (default-amount)
1487 (setq default-amount
1488 (- (/ (min (window-height ediff-window-A)
1489 (window-height ediff-window-B)
1490 (if ediff-3way-job
1491 (window-height ediff-window-C)
1492 500)) ; some large number
1494 1 next-screen-context-lines))
1495 ;; window found
1496 (if arg
1497 ;; C-u as argument means half of default amount
1498 (/ default-amount 2)
1499 ;; no argument means default amount
1500 default-amount)))))
1503 (defun ediff-scroll-horizontally (&optional arg)
1504 "Horizontally scroll buffers A, B \(and C if appropriate\).
1505 If an argument is given, that is how many columns are scrolled, else nearly
1506 the width of the A/B/C windows."
1507 (interactive "P")
1508 (ediff-barf-if-not-control-buffer)
1510 ;; make sure windows aren't dead
1511 (if (not (and (window-live-p ediff-window-A) (window-live-p ediff-window-B)))
1512 (ediff-recenter 'no-rehighlight))
1513 (if (not (and (ediff-buffer-live-p ediff-buffer-A)
1514 (ediff-buffer-live-p ediff-buffer-B)
1515 (or (not ediff-3way-job)
1516 (ediff-buffer-live-p ediff-buffer-C))
1518 (error ediff-KILLED-VITAL-BUFFER))
1520 (ediff-operate-on-windows
1521 ;; Arrange for scroll-left and scroll-right being called
1522 ;; interactively so that they set the window's min_hscroll.
1523 ;; Otherwise, automatic hscrolling will undo the effect of
1524 ;; hscrolling.
1525 (if (= last-command-char ?<)
1526 (lambda (arg)
1527 (let ((prefix-arg arg))
1528 (call-interactively 'scroll-left)))
1529 (lambda (arg)
1530 (let ((prefix-arg arg))
1531 (call-interactively 'scroll-right))))
1532 ;; calculate argument to scroll-left/right
1533 ;; if there is an explicit argument
1534 (if (and arg (not (equal arg '-)))
1535 ;; use it
1536 (prefix-numeric-value arg)
1537 ;; if not, see if we can determine a default amount
1538 ;; (half the window width)
1539 (if (null ediff-control-window)
1540 ;; no control window, use nil
1542 (let ((default-amount
1543 (- (/ (min (window-width ediff-window-A)
1544 (window-width ediff-window-B)
1545 (if ediff-3way-comparison-job
1546 (window-width ediff-window-C)
1547 500) ; some large number
1550 3)))
1551 ;; window found
1552 (if arg
1553 ;; C-u as argument means half of default amount
1554 (/ default-amount 2)
1555 ;; no argument means default amount
1556 default-amount))))))
1559 ;;BEG, END show the region to be positioned.
1560 ;;JOB-NAME holds ediff-job-name. The ediff-windows job positions regions
1561 ;;differently.
1562 (defun ediff-position-region (beg end pos job-name)
1563 (if (> end (point-max))
1564 (setq end (point-max)))
1565 (if ediff-windows-job
1566 (if (pos-visible-in-window-p end)
1567 () ; do nothing, wind is already positioned
1568 ;; at this point, windows are positioned at the beginning of the
1569 ;; file regions (not diff-regions) being compared.
1570 (save-excursion
1571 (move-to-window-line (- (window-height) 2))
1572 (let ((amount (+ 2 (count-lines (point) end))))
1573 (scroll-up amount))))
1574 (set-window-start (selected-window) beg)
1575 (if (pos-visible-in-window-p end)
1576 ;; Determine the number of lines that the region occupies
1577 (let ((lines 0)
1578 (prev-point 0))
1579 (while ( and (> end (progn
1580 (move-to-window-line lines)
1581 (point)))
1582 ;; `end' may be beyond the window bottom, so check
1583 ;; that we are making progress
1584 (< prev-point (point)))
1585 (setq prev-point (point))
1586 (setq lines (1+ lines)))
1587 ;; And position the beginning on the right line
1588 (goto-char beg)
1589 (recenter (/ (1+ (max (- (1- (window-height (selected-window)))
1590 lines)
1593 2))))
1594 (goto-char pos)
1597 ;; get number of lines from window start to region end
1598 (defun ediff-get-lines-to-region-end (buf-type &optional n ctl-buf)
1599 (or n (setq n ediff-current-difference))
1600 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1601 (ediff-with-current-buffer ctl-buf
1602 (let* ((buf (ediff-get-buffer buf-type))
1603 (wind (eval (ediff-get-symbol-from-alist
1604 buf-type ediff-window-alist)))
1605 (beg (window-start wind))
1606 (end (ediff-get-diff-posn buf-type 'end))
1607 lines)
1608 (ediff-with-current-buffer buf
1609 (if (< beg end)
1610 (setq lines (count-lines beg end))
1611 (setq lines 0))
1612 lines
1613 ))))
1615 ;; Calculate the number of lines from window end to the start of diff region
1616 (defun ediff-get-lines-to-region-start (buf-type &optional diff-num ctl-buf)
1617 (or diff-num (setq diff-num ediff-current-difference))
1618 (or ctl-buf (setq ctl-buf ediff-control-buffer))
1619 (ediff-with-current-buffer ctl-buf
1620 (let* ((buf (ediff-get-buffer buf-type))
1621 (wind (eval (ediff-get-symbol-from-alist
1622 buf-type ediff-window-alist)))
1623 (end (or (window-end wind) (window-end wind t)))
1624 (beg (ediff-get-diff-posn buf-type 'beg diff-num)))
1625 (ediff-with-current-buffer buf
1626 (if (< beg end)
1627 (count-lines (max beg (point-min)) (min end (point-max))) 0))
1631 ;; region size coefficient is a coefficient by which to adjust scrolling
1632 ;; up/down of the window displaying buffer of type BUFTYPE.
1633 ;; The purpose of this coefficient is to make the windows scroll in sync, so
1634 ;; that it won't happen that one diff region is scrolled off while the other is
1635 ;; still seen.
1637 ;; If the difference region is invalid, the coefficient is 1
1638 (defun ediff-get-region-size-coefficient (buf-type op &optional n ctl-buf)
1639 (ediff-with-current-buffer (or ctl-buf ediff-control-buffer)
1640 (if (ediff-valid-difference-p n)
1641 (let* ((func (cond ((eq op 'scroll-down)
1642 'ediff-get-lines-to-region-start)
1643 ((eq op 'scroll-up)
1644 'ediff-get-lines-to-region-end)
1645 (t '(lambda (a b c) 0))))
1646 (max-lines (max (funcall func 'A n ctl-buf)
1647 (funcall func 'B n ctl-buf)
1648 (if (ediff-buffer-live-p ediff-buffer-C)
1649 (funcall func 'C n ctl-buf)
1650 0))))
1651 ;; this covers the horizontal coefficient as well:
1652 ;; if max-lines = 0 then coef = 1
1653 (if (> max-lines 0)
1654 (/ (+ (funcall func buf-type n ctl-buf) 0.0)
1655 (+ max-lines 0.0))
1657 1)))
1660 (defun ediff-next-difference (&optional arg)
1661 "Advance to the next difference.
1662 With a prefix argument, go forward that many differences."
1663 (interactive "p")
1664 (ediff-barf-if-not-control-buffer)
1665 (if (< ediff-current-difference ediff-number-of-differences)
1666 (let ((n (min ediff-number-of-differences
1667 (+ ediff-current-difference (or arg 1))))
1668 non-clash-skip skip-changed regexp-skip)
1670 (ediff-visible-region)
1671 (or (>= n ediff-number-of-differences)
1672 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1673 ;; this won't exec if regexp-skip is t
1674 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1675 skip-changed
1676 (ediff-skip-merge-region-if-changed-from-default-p n))
1677 (ediff-install-fine-diff-if-necessary n))
1678 ;; Skip loop
1679 (while (and (< n ediff-number-of-differences)
1681 ;; regexp skip
1682 regexp-skip
1683 ;; skip clashes, if necessary
1684 non-clash-skip
1685 ;; skip processed regions
1686 skip-changed
1687 ;; skip difference regions that differ in white space
1688 (and ediff-ignore-similar-regions
1689 (or (eq (ediff-no-fine-diffs-p n) t)
1690 (and (ediff-merge-job)
1691 (eq (ediff-no-fine-diffs-p n) 'C)))
1693 (setq n (1+ n))
1694 (if (= 0 (mod n 20))
1695 (message "Skipped over region %d and counting ..." n))
1696 (or (>= n ediff-number-of-differences)
1697 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1698 ;; this won't exec if regexp-skip is t
1699 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1700 skip-changed
1701 (ediff-skip-merge-region-if-changed-from-default-p n))
1702 (ediff-install-fine-diff-if-necessary n))
1704 (message "")
1705 (ediff-unselect-and-select-difference n)
1706 ) ; let
1707 (ediff-visible-region)
1708 (error "At end of the difference list")))
1710 (defun ediff-previous-difference (&optional arg)
1711 "Go to the previous difference.
1712 With a prefix argument, go back that many differences."
1713 (interactive "p")
1714 (ediff-barf-if-not-control-buffer)
1715 (if (> ediff-current-difference -1)
1716 (let ((n (max -1 (- ediff-current-difference (or arg 1))))
1717 non-clash-skip skip-changed regexp-skip)
1719 (ediff-visible-region)
1720 (or (< n 0)
1721 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1722 ;; this won't exec if regexp-skip is t
1723 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1724 skip-changed
1725 (ediff-skip-merge-region-if-changed-from-default-p n))
1726 (ediff-install-fine-diff-if-necessary n))
1727 (while (and (> n -1)
1729 ;; regexp skip
1730 regexp-skip
1731 ;; skip clashes, if necessary
1732 non-clash-skip
1733 ;; skipp changed regions
1734 skip-changed
1735 ;; skip difference regions that differ in white space
1736 (and ediff-ignore-similar-regions
1737 (or (eq (ediff-no-fine-diffs-p n) t)
1738 (and (ediff-merge-job)
1739 (eq (ediff-no-fine-diffs-p n) 'C)))
1741 (if (= 0 (mod (1+ n) 20))
1742 (message "Skipped over region %d and counting ..." (1+ n)))
1743 (setq n (1- n))
1744 (or (< n 0)
1745 (setq regexp-skip (funcall ediff-skip-diff-region-function n))
1746 ;; this won't exec if regexp-skip is t
1747 (setq non-clash-skip (ediff-merge-region-is-non-clash n)
1748 skip-changed
1749 (ediff-skip-merge-region-if-changed-from-default-p n))
1750 (ediff-install-fine-diff-if-necessary n))
1752 (message "")
1753 (ediff-unselect-and-select-difference n)
1754 ) ; let
1755 (ediff-visible-region)
1756 (error "At beginning of the difference list")))
1758 ;; The diff number is as perceived by the user (i.e., 1+ the internal
1759 ;; representation)
1760 (defun ediff-jump-to-difference (difference-number)
1761 "Go to the difference specified as a prefix argument.
1762 If the prefix is negative, count differences from the end."
1763 (interactive "p")
1764 (ediff-barf-if-not-control-buffer)
1765 (setq difference-number
1766 (cond ((< difference-number 0)
1767 (+ ediff-number-of-differences difference-number))
1768 ((> difference-number 0) (1- difference-number))
1769 (t -1)))
1770 ;; -1 is allowed by ediff-unselect-and-select-difference --- it is the
1771 ;; position before the first one.
1772 (if (and (>= difference-number -1)
1773 (<= difference-number ediff-number-of-differences))
1774 (ediff-unselect-and-select-difference difference-number)
1775 (error ediff-BAD-DIFF-NUMBER
1776 this-command (1+ difference-number) ediff-number-of-differences)))
1778 (defun ediff-jump-to-difference-at-point (arg)
1779 "Go to difference closest to the point in buffer A, B, or C.
1780 The buffer depends on last command character \(a, b, or c\) that invoked this
1781 command. For instance, if the command was `ga' then the point value in buffer
1782 A is used.
1783 With a prefix argument, synchronize all files around the current point position
1784 in the specified buffer."
1785 (interactive "P")
1786 (ediff-barf-if-not-control-buffer)
1787 (let* ((buf-type (ediff-char-to-buftype last-command-char))
1788 (buffer (ediff-get-buffer buf-type))
1789 (pt (ediff-with-current-buffer buffer (point)))
1790 (diff-no (ediff-diff-at-point buf-type nil (if arg 'after)))
1791 (past-last-diff (< ediff-number-of-differences diff-no))
1792 (beg (if past-last-diff
1793 (ediff-with-current-buffer buffer (point-max))
1794 (ediff-get-diff-posn buf-type 'beg (1- diff-no))))
1795 ctl-wind wind-A wind-B wind-C
1796 shift)
1797 (if past-last-diff
1798 (ediff-jump-to-difference -1)
1799 (ediff-jump-to-difference diff-no))
1800 (setq ctl-wind (selected-window)
1801 wind-A ediff-window-A
1802 wind-B ediff-window-B
1803 wind-C ediff-window-C)
1804 (if arg
1805 (progn
1806 (ediff-with-current-buffer buffer
1807 (setq shift (- beg pt)))
1808 (select-window wind-A)
1809 (if past-last-diff (goto-char (point-max)))
1810 (condition-case nil
1811 (backward-char shift) ; noerror, if beginning of buffer
1812 (error))
1813 (recenter)
1814 (select-window wind-B)
1815 (if past-last-diff (goto-char (point-max)))
1816 (condition-case nil
1817 (backward-char shift) ; noerror, if beginning of buffer
1818 (error))
1819 (recenter)
1820 (if (window-live-p wind-C)
1821 (progn
1822 (select-window wind-C)
1823 (if past-last-diff (goto-char (point-max)))
1824 (condition-case nil
1825 (backward-char shift) ; noerror, if beginning of buffer
1826 (error))
1827 (recenter)
1829 (select-window ctl-wind)
1834 ;; find region most related to the current point position (or POS, if given)
1835 ;; returns diff number as seen by the user (i.e., 1+ the internal
1836 ;; representation)
1837 ;; The optional argument WHICH-DIFF can be `after' or `before'. If `after',
1838 ;; find the diff after the point. If `before', find the diff before the
1839 ;; point. If the point is inside a diff, return that diff.
1840 (defun ediff-diff-at-point (buf-type &optional pos which-diff)
1841 (let ((buffer (ediff-get-buffer buf-type))
1842 (ctl-buffer ediff-control-buffer)
1843 (max-dif-num (1- ediff-number-of-differences))
1844 (diff-no -1)
1845 (prev-beg 0)
1846 (prev-end 0)
1847 (beg 0)
1848 (end 0))
1850 (ediff-with-current-buffer buffer
1851 (setq pos (or pos (point)))
1852 (while (and (or (< pos prev-beg) (> pos beg))
1853 (< diff-no max-dif-num))
1854 (setq diff-no (1+ diff-no))
1855 (setq prev-beg beg
1856 prev-end end)
1857 (setq beg (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer)
1858 end (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
1861 ;; boost diff-no by 1, if past the last diff region
1862 (if (and (memq which-diff '(after before))
1863 (> pos beg) (= diff-no max-dif-num))
1864 (setq diff-no (1+ diff-no)))
1866 (cond ((eq which-diff 'after) (1+ diff-no))
1867 ((eq which-diff 'before) diff-no)
1868 ((< (abs (count-lines pos (max 1 prev-end)))
1869 (abs (count-lines pos (max 1 beg))))
1870 diff-no) ; choose prev difference
1872 (1+ diff-no))) ; choose next difference
1876 ;;; Copying diffs.
1878 (defun ediff-diff-to-diff (arg &optional keys)
1879 "Copy buffer-X'th difference region to buffer Y \(X,Y are A, B, or C\).
1880 If numerical prefix argument, copy the difference specified in the arg.
1881 Otherwise, copy the difference given by `ediff-current-difference'.
1882 This command assumes it is bound to a 2-character key sequence, `ab', `ba',
1883 `ac', etc., which is used to determine the types of buffers to be used for
1884 copying difference regions. The first character in the sequence specifies
1885 the source buffer and the second specifies the target.
1887 If the second optional argument, a 2-character string, is given, use it to
1888 determine the source and the target buffers instead of the command keys."
1889 (interactive "P")
1890 (ediff-barf-if-not-control-buffer)
1891 (or keys (setq keys (this-command-keys)))
1892 (if (eq arg '-) (setq arg -1)) ; translate neg arg to -1
1893 (if (numberp arg) (ediff-jump-to-difference arg))
1895 (let* ((key1 (aref keys 0))
1896 (key2 (aref keys 1))
1897 (char1 (if (and ediff-xemacs-p (eventp key1)) (event-key key1) key1))
1898 (char2 (if (and ediff-xemacs-p (eventp key1)) (event-key key2) key2))
1899 ediff-verbose-p)
1900 (ediff-copy-diff ediff-current-difference
1901 (ediff-char-to-buftype char1)
1902 (ediff-char-to-buftype char2))
1903 ;; recenter with rehighlighting, but no messages
1904 (ediff-recenter)))
1906 (defun ediff-copy-A-to-B (arg)
1907 "Copy ARGth difference region from buffer A to B.
1908 ARG is a prefix argument. If nil, copy the current difference region."
1909 (interactive "P")
1910 (ediff-diff-to-diff arg "ab"))
1912 (defun ediff-copy-B-to-A (arg)
1913 "Copy ARGth difference region from buffer B to A.
1914 ARG is a prefix argument. If nil, copy the current difference region."
1915 (interactive "P")
1916 (ediff-diff-to-diff arg "ba"))
1918 (defun ediff-copy-A-to-C (arg)
1919 "Copy ARGth difference region from buffer A to buffer C.
1920 ARG is a prefix argument. If nil, copy the current difference region."
1921 (interactive "P")
1922 (ediff-diff-to-diff arg "ac"))
1924 (defun ediff-copy-B-to-C (arg)
1925 "Copy ARGth difference region from buffer B to buffer C.
1926 ARG is a prefix argument. If nil, copy the current difference region."
1927 (interactive "P")
1928 (ediff-diff-to-diff arg "bc"))
1930 (defun ediff-copy-C-to-B (arg)
1931 "Copy ARGth difference region from buffer C to B.
1932 ARG is a prefix argument. If nil, copy the current difference region."
1933 (interactive "P")
1934 (ediff-diff-to-diff arg "cb"))
1936 (defun ediff-copy-C-to-A (arg)
1937 "Copy ARGth difference region from buffer C to A.
1938 ARG is a prefix argument. If nil, copy the current difference region."
1939 (interactive "P")
1940 (ediff-diff-to-diff arg "ca"))
1944 ;; Copy diff N from FROM-BUF-TYPE \(given as A, B or C\) to TO-BUF-TYPE.
1945 ;; If optional DO-NOT-SAVE is non-nil, do not save the old value of the
1946 ;; target diff. This is used in merging, when constructing the merged
1947 ;; version.
1948 (defun ediff-copy-diff (n from-buf-type to-buf-type
1949 &optional batch-invocation reg-to-copy)
1950 (let* ((to-buf (ediff-get-buffer to-buf-type))
1951 ;;(from-buf (if (not reg-to-copy) (ediff-get-buffer from-buf-type)))
1952 (ctrl-buf ediff-control-buffer)
1953 (saved-p t)
1954 (three-way ediff-3way-job)
1955 messg
1956 ediff-verbose-p
1957 reg-to-delete reg-to-delete-beg reg-to-delete-end)
1959 (setq reg-to-delete-beg
1960 (ediff-get-diff-posn to-buf-type 'beg n ctrl-buf))
1961 (setq reg-to-delete-end
1962 (ediff-get-diff-posn to-buf-type 'end n ctrl-buf))
1964 (if reg-to-copy
1965 (setq from-buf-type nil)
1966 (setq reg-to-copy (ediff-get-region-contents n from-buf-type ctrl-buf)))
1968 (setq reg-to-delete (ediff-get-region-contents
1969 n to-buf-type ctrl-buf
1970 reg-to-delete-beg reg-to-delete-end))
1972 (if (string= reg-to-delete reg-to-copy)
1973 (setq saved-p nil) ; don't copy identical buffers
1974 ;; seems ok to copy
1975 (if (or batch-invocation (ediff-test-save-region n to-buf-type))
1976 (condition-case conds
1977 (progn
1978 (ediff-with-current-buffer to-buf
1979 ;; to prevent flags from interfering if buffer is writable
1980 (let ((inhibit-read-only (null buffer-read-only)))
1982 (goto-char reg-to-delete-end)
1983 (insert reg-to-copy)
1985 (if (> reg-to-delete-end reg-to-delete-beg)
1986 (kill-region reg-to-delete-beg reg-to-delete-end))
1988 (or batch-invocation
1989 (setq
1990 messg
1991 (ediff-save-diff-region n to-buf-type reg-to-delete))))
1992 (error (message "ediff-copy-diff: %s %s"
1993 (car conds)
1994 (mapconcat 'prin1-to-string (cdr conds) " "))
1995 (beep 1)
1996 (sit-for 2) ; let the user see the error msg
1997 (setq saved-p nil)
2001 ;; adjust state of difference in case 3-way and diff was copied ok
2002 (if (and saved-p three-way)
2003 (ediff-set-state-of-diff-in-all-buffers n ctrl-buf))
2005 (if batch-invocation
2006 (ediff-clear-fine-differences n)
2007 ;; If diff3 job, we should recompute fine diffs so we clear them
2008 ;; before reinserting flags (and thus before ediff-recenter).
2009 (if (and saved-p three-way)
2010 (ediff-clear-fine-differences n))
2012 (ediff-refresh-mode-lines)
2014 ;; For diff2 jobs, don't recompute fine diffs, since we know there
2015 ;; aren't any. So we clear diffs after ediff-recenter.
2016 (if (and saved-p (not three-way))
2017 (ediff-clear-fine-differences n))
2018 ;; Make sure that the message about saving and how to restore is seen
2019 ;; by the user
2020 (message messg))
2023 ;; Save Nth diff of buffer BUF-TYPE \(A, B, or C\).
2024 ;; That is to say, the Nth diff on the `ediff-killed-diffs-alist'. REG
2025 ;; is the region to save. It is redundant here, but is passed anyway, for
2026 ;; convenience.
2027 (defun ediff-save-diff-region (n buf-type reg)
2028 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
2029 (buf (ediff-get-buffer buf-type))
2030 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
2032 (if this-buf-n-th-diff-saved
2033 ;; either nothing saved for n-th diff and buffer or we OK'ed
2034 ;; overriding
2035 (setcdr this-buf-n-th-diff-saved reg)
2036 (if n-th-diff-saved ;; n-th diff saved, but for another buffer
2037 (nconc n-th-diff-saved (list (cons buf reg)))
2038 (setq ediff-killed-diffs-alist ;; create record for n-th diff
2039 (cons (list n (cons buf reg))
2040 ediff-killed-diffs-alist))))
2041 (message "Saving old diff region #%d of buffer %S. To recover, type `r%s'"
2042 (1+ n) buf-type
2043 (if ediff-merge-job
2044 "" (downcase (symbol-name buf-type))))
2047 ;; Test if saving Nth difference region of buffer BUF-TYPE is possible.
2048 (defun ediff-test-save-region (n buf-type)
2049 (let* ((n-th-diff-saved (assoc n ediff-killed-diffs-alist))
2050 (buf (ediff-get-buffer buf-type))
2051 (this-buf-n-th-diff-saved (assoc buf (cdr n-th-diff-saved))))
2053 (if this-buf-n-th-diff-saved
2054 (if (yes-or-no-p
2055 (format
2056 "You've previously copied diff region %d to buffer %S. Confirm "
2057 (1+ n) buf-type))
2059 (error "Quit"))
2060 t)))
2062 (defun ediff-pop-diff (n buf-type)
2063 "Pop last killed Nth diff region from buffer BUF-TYPE."
2064 (let* ((n-th-record (assoc n ediff-killed-diffs-alist))
2065 (buf (ediff-get-buffer buf-type))
2066 (saved-rec (assoc buf (cdr n-th-record)))
2067 (three-way ediff-3way-job)
2068 (ctl-buf ediff-control-buffer)
2069 ediff-verbose-p
2070 saved-diff reg-beg reg-end recovered)
2072 (if (cdr saved-rec)
2073 (setq saved-diff (cdr saved-rec))
2074 (if (> ediff-number-of-differences 0)
2075 (error "Nothing saved for diff %d in buffer %S" (1+ n) buf-type)
2076 (error ediff-NO-DIFFERENCES)))
2078 (setq reg-beg (ediff-get-diff-posn buf-type 'beg n ediff-control-buffer))
2079 (setq reg-end (ediff-get-diff-posn buf-type 'end n ediff-control-buffer))
2081 (condition-case conds
2082 (ediff-with-current-buffer buf
2083 (let ((inhibit-read-only (null buffer-read-only)))
2085 (goto-char reg-end)
2086 (insert saved-diff)
2088 (if (> reg-end reg-beg)
2089 (kill-region reg-beg reg-end))
2091 (setq recovered t)
2093 (error (message "ediff-pop-diff: %s %s"
2094 (car conds)
2095 (mapconcat 'prin1-to-string (cdr conds) " "))
2096 (beep 1)))
2098 ;; Clearing fine diffs is necessary for
2099 ;; ediff-unselect-and-select-difference to properly recompute them. We
2100 ;; can't rely on ediff-copy-diff to clear this vector, as the user might
2101 ;; have modified diff regions after copying and, thus, may have recomputed
2102 ;; fine diffs.
2103 (if recovered
2104 (ediff-clear-fine-differences n))
2106 ;; adjust state of difference
2107 (if (and three-way recovered)
2108 (ediff-set-state-of-diff-in-all-buffers n ctl-buf))
2110 (ediff-refresh-mode-lines)
2112 (if recovered
2113 (progn
2114 (setq n-th-record (delq saved-rec n-th-record))
2115 (message "Diff region %d in buffer %S restored" (1+ n) buf-type)
2119 (defun ediff-restore-diff (arg &optional key)
2120 "Restore ARGth diff from `ediff-killed-diffs-alist'.
2121 ARG is a prefix argument. If ARG is nil, restore the current-difference.
2122 If the second optional argument, a character, is given, use it to
2123 determine the target buffer instead of last-command-char"
2124 (interactive "P")
2125 (ediff-barf-if-not-control-buffer)
2126 (if (numberp arg)
2127 (ediff-jump-to-difference arg))
2128 (ediff-pop-diff ediff-current-difference
2129 (ediff-char-to-buftype (or key last-command-char)))
2130 ;; recenter with rehighlighting, but no messages
2131 (let (ediff-verbose-p)
2132 (ediff-recenter)))
2134 (defun ediff-restore-diff-in-merge-buffer (arg)
2135 "Restore ARGth diff in the merge buffer.
2136 ARG is a prefix argument. If nil, restore the current diff."
2137 (interactive "P")
2138 (ediff-restore-diff arg ?c))
2141 (defun ediff-toggle-regexp-match ()
2142 "Toggle between focusing and hiding of difference regions that match
2143 a regular expression typed in by the user."
2144 (interactive)
2145 (ediff-barf-if-not-control-buffer)
2146 (let ((regexp-A "")
2147 (regexp-B "")
2148 (regexp-C "")
2149 msg-connective alt-msg-connective alt-connective)
2150 (cond
2151 ((or (and (eq ediff-skip-diff-region-function
2152 ediff-focus-on-regexp-matches-function)
2153 (eq last-command-char ?f))
2154 (and (eq ediff-skip-diff-region-function
2155 ediff-hide-regexp-matches-function)
2156 (eq last-command-char ?h)))
2157 (message "Selective browsing by regexp turned off")
2158 (setq ediff-skip-diff-region-function 'ediff-show-all-diffs))
2159 ((eq last-command-char ?h)
2160 (setq ediff-skip-diff-region-function ediff-hide-regexp-matches-function
2161 regexp-A
2162 (read-string
2163 (format
2164 "Ignore A-regions matching this regexp (default \"%s\"): "
2165 ediff-regexp-hide-A))
2166 regexp-B
2167 (read-string
2168 (format
2169 "Ignore B-regions matching this regexp (default \"%s\"): "
2170 ediff-regexp-hide-B)))
2171 (if ediff-3way-comparison-job
2172 (setq regexp-C
2173 (read-string
2174 (format
2175 "Ignore C-regions matching this regexp (default \"%s\"): "
2176 ediff-regexp-hide-C))))
2177 (if (eq ediff-hide-regexp-connective 'and)
2178 (setq msg-connective "BOTH"
2179 alt-msg-connective "ONE OF"
2180 alt-connective 'or)
2181 (setq msg-connective "ONE OF"
2182 alt-msg-connective "BOTH"
2183 alt-connective 'and))
2184 (if (y-or-n-p
2185 (format
2186 "Ignore regions that match %s regexps, OK? "
2187 msg-connective alt-msg-connective))
2188 (message "Will ignore regions that match %s regexps" msg-connective)
2189 (setq ediff-hide-regexp-connective alt-connective)
2190 (message "Will ignore regions that match %s regexps"
2191 alt-msg-connective))
2193 (or (string= regexp-A "") (setq ediff-regexp-hide-A regexp-A))
2194 (or (string= regexp-B "") (setq ediff-regexp-hide-B regexp-B))
2195 (or (string= regexp-C "") (setq ediff-regexp-hide-C regexp-C)))
2197 ((eq last-command-char ?f)
2198 (setq ediff-skip-diff-region-function
2199 ediff-focus-on-regexp-matches-function
2200 regexp-A
2201 (read-string
2202 (format
2203 "Focus on A-regions matching this regexp (default \"%s\"): "
2204 ediff-regexp-focus-A))
2205 regexp-B
2206 (read-string
2207 (format
2208 "Focus on B-regions matching this regexp (default \"%s\"): "
2209 ediff-regexp-focus-B)))
2210 (if ediff-3way-comparison-job
2211 (setq regexp-C
2212 (read-string
2213 (format
2214 "Focus on C-regions matching this regexp (default \"%s\"): "
2215 ediff-regexp-focus-C))))
2216 (if (eq ediff-focus-regexp-connective 'and)
2217 (setq msg-connective "BOTH"
2218 alt-msg-connective "ONE OF"
2219 alt-connective 'or)
2220 (setq msg-connective "ONE OF"
2221 alt-msg-connective "BOTH"
2222 alt-connective 'and))
2223 (if (y-or-n-p
2224 (format
2225 "Focus on regions that match %s regexps, OK? "
2226 msg-connective alt-msg-connective))
2227 (message "Will focus on regions that match %s regexps"
2228 msg-connective)
2229 (setq ediff-focus-regexp-connective alt-connective)
2230 (message "Will focus on regions that match %s regexps"
2231 alt-msg-connective))
2233 (or (string= regexp-A "") (setq ediff-regexp-focus-A regexp-A))
2234 (or (string= regexp-B "") (setq ediff-regexp-focus-B regexp-B))
2235 (or (string= regexp-C "") (setq ediff-regexp-focus-C regexp-C))))))
2237 (defun ediff-toggle-skip-similar ()
2238 (interactive)
2239 (ediff-barf-if-not-control-buffer)
2240 (if (not (eq ediff-auto-refine 'on))
2241 (error
2242 "Can't skip over whitespace regions: first turn auto-refining on"))
2243 (setq ediff-ignore-similar-regions (not ediff-ignore-similar-regions))
2244 (if ediff-ignore-similar-regions
2245 (message
2246 "Skipping regions that differ only in white space & line breaks")
2247 (message "Skipping over white-space differences turned off")))
2249 (defun ediff-focus-on-regexp-matches (n)
2250 "Focus on diffs that match regexp `ediff-regexp-focus-A/B'.
2251 Regions to be ignored according to this function are those where
2252 buf A region doesn't match `ediff-regexp-focus-A' and buf B region
2253 doesn't match `ediff-regexp-focus-B'.
2254 This function returns nil if the region number N (specified as
2255 an argument) is not to be ignored and t if region N is to be ignored.
2257 N is a region number used by Ediff internally. It is 1 less
2258 the number seen by the user."
2259 (if (ediff-valid-difference-p n)
2260 (let* ((ctl-buf ediff-control-buffer)
2261 (regex-A ediff-regexp-focus-A)
2262 (regex-B ediff-regexp-focus-B)
2263 (regex-C ediff-regexp-focus-C)
2264 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2265 (save-restriction
2266 (narrow-to-region
2267 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2268 (ediff-get-diff-posn 'A 'end n ctl-buf))
2269 (goto-char (point-min))
2270 (re-search-forward regex-A nil t))))
2271 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2272 (save-restriction
2273 (narrow-to-region
2274 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2275 (ediff-get-diff-posn 'B 'end n ctl-buf))
2276 (re-search-forward regex-B nil t))))
2277 (reg-C-match (if ediff-3way-comparison-job
2278 (ediff-with-current-buffer ediff-buffer-C
2279 (save-restriction
2280 (narrow-to-region
2281 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2282 (ediff-get-diff-posn 'C 'end n ctl-buf))
2283 (re-search-forward regex-C nil t))))))
2284 (not (eval (if ediff-3way-comparison-job
2285 (list ediff-focus-regexp-connective
2286 reg-A-match reg-B-match reg-C-match)
2287 (list ediff-focus-regexp-connective
2288 reg-A-match reg-B-match))))
2291 (defun ediff-hide-regexp-matches (n)
2292 "Hide diffs that match regexp `ediff-regexp-hide-A/B/C'.
2293 Regions to be ignored are those where buf A region matches
2294 `ediff-regexp-hide-A' and buf B region matches `ediff-regexp-hide-B'.
2295 This function returns nil if the region number N (specified as
2296 an argument) is not to be ignored and t if region N is to be ignored.
2298 N is a region number used by Ediff internally. It is 1 less
2299 the number seen by the user."
2300 (if (ediff-valid-difference-p n)
2301 (let* ((ctl-buf ediff-control-buffer)
2302 (regex-A ediff-regexp-hide-A)
2303 (regex-B ediff-regexp-hide-B)
2304 (regex-C ediff-regexp-hide-C)
2305 (reg-A-match (ediff-with-current-buffer ediff-buffer-A
2306 (save-restriction
2307 (narrow-to-region
2308 (ediff-get-diff-posn 'A 'beg n ctl-buf)
2309 (ediff-get-diff-posn 'A 'end n ctl-buf))
2310 (goto-char (point-min))
2311 (re-search-forward regex-A nil t))))
2312 (reg-B-match (ediff-with-current-buffer ediff-buffer-B
2313 (save-restriction
2314 (narrow-to-region
2315 (ediff-get-diff-posn 'B 'beg n ctl-buf)
2316 (ediff-get-diff-posn 'B 'end n ctl-buf))
2317 (goto-char (point-min))
2318 (re-search-forward regex-B nil t))))
2319 (reg-C-match (if ediff-3way-comparison-job
2320 (ediff-with-current-buffer ediff-buffer-C
2321 (save-restriction
2322 (narrow-to-region
2323 (ediff-get-diff-posn 'C 'beg n ctl-buf)
2324 (ediff-get-diff-posn 'C 'end n ctl-buf))
2325 (goto-char (point-min))
2326 (re-search-forward regex-C nil t))))))
2327 (eval (if ediff-3way-comparison-job
2328 (list ediff-hide-regexp-connective
2329 reg-A-match reg-B-match reg-C-match)
2330 (list ediff-hide-regexp-connective reg-A-match reg-B-match)))
2335 ;;; Quitting, suspending, etc.
2337 (defun ediff-quit (reverse-default-keep-variants)
2338 "Finish an Ediff session and exit Ediff.
2339 Unselects the selected difference, if any, restores the read-only and modified
2340 flags of the compared file buffers, kills Ediff buffers for this session
2341 \(but not buffers A, B, C\).
2343 If `ediff-keep-variants' is nil, the user will be asked whether the buffers
2344 containing the variants should be removed \(if they haven't been modified\).
2345 If it is t, they will be preserved unconditionally. A prefix argument,
2346 temporarily reverses the meaning of this variable."
2347 (interactive "P")
2348 (ediff-barf-if-not-control-buffer)
2349 (let ((ctl-buf (current-buffer)))
2350 (if (y-or-n-p (format "Quit this Ediff session%s? "
2351 (if (ediff-buffer-live-p ediff-meta-buffer)
2352 " & show containing session group" "")))
2353 (progn
2354 (message "")
2355 (set-buffer ctl-buf)
2356 (ediff-really-quit reverse-default-keep-variants))
2357 (message ""))))
2360 ;; Perform the quit operations.
2361 (defun ediff-really-quit (reverse-default-keep-variants)
2362 (ediff-unhighlight-diffs-totally)
2363 (ediff-clear-diff-vector 'ediff-difference-vector-A 'fine-diffs-also)
2364 (ediff-clear-diff-vector 'ediff-difference-vector-B 'fine-diffs-also)
2365 (ediff-clear-diff-vector 'ediff-difference-vector-C 'fine-diffs-also)
2366 (ediff-clear-diff-vector 'ediff-difference-vector-Ancestor 'fine-diffs-also)
2368 (ediff-delete-temp-files)
2370 ;; Restore visibility range. This affects only ediff-*-regions/windows.
2371 ;; Since for other job names ediff-visible-region sets
2372 ;; ediff-visible-bounds to ediff-wide-bounds, the settings below are
2373 ;; ignored for such jobs.
2374 (if ediff-quit-widened
2375 (setq ediff-visible-bounds ediff-wide-bounds)
2376 (setq ediff-visible-bounds ediff-narrow-bounds))
2378 ;; Apply selective display to narrow or widen
2379 (ediff-visible-region)
2380 (mapcar (lambda (overl)
2381 (if (ediff-overlayp overl)
2382 (ediff-delete-overlay overl)))
2383 ediff-wide-bounds)
2384 (mapcar (lambda (overl)
2385 (if (ediff-overlayp overl)
2386 (ediff-delete-overlay overl)))
2387 ediff-narrow-bounds)
2389 ;; restore buffer mode line id's in buffer-A/B/C
2390 (let ((control-buffer ediff-control-buffer)
2391 (meta-buffer ediff-meta-buffer)
2392 (after-quit-hook-internal ediff-after-quit-hook-internal)
2393 (session-number ediff-meta-session-number)
2394 ;; suitable working frame
2395 (warp-frame (if (and (ediff-window-display-p) (eq ediff-grab-mouse t))
2396 (cond ((window-live-p ediff-window-A)
2397 (window-frame ediff-window-A))
2398 ((window-live-p ediff-window-B)
2399 (window-frame ediff-window-B))
2400 (t (next-frame))))))
2401 (condition-case nil
2402 (ediff-with-current-buffer ediff-buffer-A
2403 (setq ediff-this-buffer-ediff-sessions
2404 (delq control-buffer ediff-this-buffer-ediff-sessions))
2405 (kill-local-variable 'mode-line-buffer-identification)
2406 (kill-local-variable 'mode-line-format)
2408 (error))
2410 (condition-case nil
2411 (ediff-with-current-buffer ediff-buffer-B
2412 (setq ediff-this-buffer-ediff-sessions
2413 (delq control-buffer ediff-this-buffer-ediff-sessions))
2414 (kill-local-variable 'mode-line-buffer-identification)
2415 (kill-local-variable 'mode-line-format)
2417 (error))
2419 (condition-case nil
2420 (ediff-with-current-buffer ediff-buffer-C
2421 (setq ediff-this-buffer-ediff-sessions
2422 (delq control-buffer ediff-this-buffer-ediff-sessions))
2423 (kill-local-variable 'mode-line-buffer-identification)
2424 (kill-local-variable 'mode-line-format)
2426 (error))
2428 (condition-case nil
2429 (ediff-with-current-buffer ediff-ancestor-buffer
2430 (setq ediff-this-buffer-ediff-sessions
2431 (delq control-buffer ediff-this-buffer-ediff-sessions))
2432 (kill-local-variable 'mode-line-buffer-identification)
2433 (kill-local-variable 'mode-line-format)
2435 (error))
2437 (setq ediff-session-registry
2438 (delq ediff-control-buffer ediff-session-registry))
2439 (ediff-update-registry)
2440 ;; restore state of buffers to what it was before ediff
2441 (ediff-restore-protected-variables)
2443 ;; If the user interrupts (canceling saving the merge buffer), continue
2444 ;; normally.
2445 (condition-case nil
2446 (if (ediff-merge-job)
2447 (run-hooks 'ediff-quit-merge-hook))
2448 (quit))
2450 (run-hooks 'ediff-cleanup-hook)
2452 ;; now kill buffers A/B/C, if requested
2453 (let ((ediff-keep-variants ediff-keep-variants))
2454 (if reverse-default-keep-variants
2455 (setq ediff-keep-variants (not ediff-keep-variants)))
2456 (or ediff-keep-variants (ediff-janitor 'ask)))
2458 ;; one hook here is ediff-cleanup-mess, which kills the control buffer and
2459 ;; other auxiliary buffers. we made it into a hook to let the users do their
2460 ;; own cleanup, if needed.
2461 (run-hooks 'ediff-quit-hook)
2462 (ediff-update-meta-buffer meta-buffer nil session-number)
2464 ;; warp mouse into a working window
2465 (setq warp-frame ; if mouse is over a reasonable frame, use it
2466 (cond ((ediff-good-frame-under-mouse))
2467 (t warp-frame)))
2468 (if (and (ediff-window-display-p) (frame-live-p warp-frame) ediff-grab-mouse)
2469 (set-mouse-position (if ediff-emacs-p
2470 warp-frame
2471 (frame-selected-window warp-frame))
2472 2 1))
2474 (run-hooks 'after-quit-hook-internal)
2477 ;; Returns frame under mouse, if this frame is not a minibuffer
2478 ;; frame. Otherwise: nil
2479 (defun ediff-good-frame-under-mouse ()
2480 (let ((frame-or-win (car (mouse-position)))
2481 (buf-name "")
2482 frame obj-ok)
2483 (setq obj-ok
2484 (if ediff-emacs-p
2485 (frame-live-p frame-or-win)
2486 (window-live-p frame-or-win)))
2487 (if obj-ok
2488 (setq frame (if ediff-emacs-p frame-or-win (window-frame frame-or-win))
2489 buf-name
2490 (buffer-name (window-buffer (frame-selected-window frame)))))
2491 (if (string-match "Minibuf" buf-name)
2493 frame)))
2496 (defun ediff-delete-temp-files ()
2497 (if (and (stringp ediff-temp-file-A) (file-exists-p ediff-temp-file-A))
2498 (delete-file ediff-temp-file-A))
2499 (if (and (stringp ediff-temp-file-B) (file-exists-p ediff-temp-file-B))
2500 (delete-file ediff-temp-file-B))
2501 (if (and (stringp ediff-temp-file-C) (file-exists-p ediff-temp-file-C))
2502 (delete-file ediff-temp-file-C)))
2505 ;; Kill control buffer, other auxiliary Ediff buffers.
2506 ;; Leave one of the frames split between buffers A/B/C
2507 (defun ediff-cleanup-mess ()
2508 (let* ((buff-A ediff-buffer-A)
2509 (buff-B ediff-buffer-B)
2510 (buff-C ediff-buffer-C)
2511 (ctl-buf ediff-control-buffer)
2512 (ctl-frame ediff-control-frame)
2513 (three-way-job ediff-3way-job)
2514 (main-frame (cond ((window-live-p ediff-window-A)
2515 (window-frame ediff-window-A))
2516 ((window-live-p ediff-window-B)
2517 (window-frame ediff-window-B)))))
2519 (ediff-kill-buffer-carefully ediff-diff-buffer)
2520 (ediff-kill-buffer-carefully ediff-custom-diff-buffer)
2521 (ediff-kill-buffer-carefully ediff-fine-diff-buffer)
2522 (ediff-kill-buffer-carefully ediff-tmp-buffer)
2523 (ediff-kill-buffer-carefully ediff-error-buffer)
2524 (ediff-kill-buffer-carefully ediff-msg-buffer)
2525 (ediff-kill-buffer-carefully ediff-debug-buffer)
2526 (if (boundp 'ediff-patch-diagnostics)
2527 (ediff-kill-buffer-carefully ediff-patch-diagnostics))
2529 (if (and (ediff-window-display-p) (frame-live-p ctl-frame))
2530 (delete-frame ctl-frame))
2531 ;; Hide bottom toolbar. --marcpa
2532 (if (not (ediff-multiframe-setup-p))
2533 (ediff-kill-bottom-toolbar))
2535 (ediff-kill-buffer-carefully ctl-buf)
2537 (if (frame-live-p main-frame)
2538 (progn
2539 (select-frame main-frame)
2540 (delete-other-windows)))
2542 ;; display only if not visible
2543 (condition-case nil
2544 (or (ediff-get-visible-buffer-window buff-B)
2545 (switch-to-buffer buff-B))
2546 (error))
2547 (condition-case nil
2548 (or (ediff-get-visible-buffer-window buff-A)
2549 (progn
2550 (if (ediff-get-visible-buffer-window buff-B)
2551 (funcall ediff-split-window-function))
2552 (switch-to-buffer buff-A)))
2553 (error))
2554 (if three-way-job
2555 (condition-case nil
2556 (or (ediff-get-visible-buffer-window buff-C)
2557 (progn
2558 (if (or (ediff-get-visible-buffer-window buff-A)
2559 (ediff-get-visible-buffer-window buff-B))
2560 (funcall ediff-split-window-function))
2561 (switch-to-buffer buff-C)
2562 (balance-windows)))
2563 (error)))
2564 (message "")
2567 (defun ediff-janitor (&optional ask)
2568 "Kill buffers A, B, and, possibly, C, if these buffers aren't modified.
2569 In merge jobs, buffer C is never deleted.
2570 However, the side effect of cleaning up may be that you cannot compare the same
2571 buffer in two separate Ediff sessions: quitting one of them will delete this
2572 buffer in another session as well."
2573 (or (not (ediff-buffer-live-p ediff-buffer-A))
2574 (buffer-modified-p ediff-buffer-A)
2575 (and ask
2576 (not (y-or-n-p (format "Kill buffer A [%s]? "
2577 (buffer-name ediff-buffer-A)))))
2578 (ediff-kill-buffer-carefully ediff-buffer-A))
2579 (or (not (ediff-buffer-live-p ediff-buffer-B))
2580 (buffer-modified-p ediff-buffer-B)
2581 (and ask
2582 (not (y-or-n-p (format "Kill buffer B [%s]? "
2583 (buffer-name ediff-buffer-B)))))
2584 (ediff-kill-buffer-carefully ediff-buffer-B))
2585 (if ediff-merge-job ; don't del buf C if merging--del ancestor buf instead
2586 (or (not (ediff-buffer-live-p ediff-ancestor-buffer))
2587 (buffer-modified-p ediff-ancestor-buffer)
2588 (and ask
2589 (not (y-or-n-p (format "Kill the ancestor buffer [%s]? "
2590 (buffer-name ediff-ancestor-buffer)))))
2591 (ediff-kill-buffer-carefully ediff-ancestor-buffer))
2592 (or (not (ediff-buffer-live-p ediff-buffer-C))
2593 (buffer-modified-p ediff-buffer-C)
2594 (and ask (not (y-or-n-p (format "Kill buffer C [%s]? "
2595 (buffer-name ediff-buffer-C)))))
2596 (ediff-kill-buffer-carefully ediff-buffer-C))))
2598 (defun ediff-maybe-save-and-delete-merge (&optional save-and-continue)
2599 "Default hook to run on quitting a merge job.
2600 This can also be used to save merge buffer in the middle of an Ediff session.
2602 If the optional SAVE-AND-CONTINUE argument is non-nil, save merge buffer and
2603 continue. Otherwise:
2604 If `ediff-autostore-merges' is nil, this does nothing.
2605 If it is t, it saves the merge buffer in the file `ediff-merge-store-file'
2606 or asks the user, if the latter is nil. It then asks the user whether to
2607 delete the merge buffer.
2608 If `ediff-autostore-merges' is neither nil nor t, the merge buffer is saved
2609 only if this merge job is part of a group, i.e., was invoked from within
2610 `ediff-merge-directories', `ediff-merge-directory-revisions', and such."
2611 (let ((merge-store-file ediff-merge-store-file)
2612 (ediff-autostore-merges ; fake ediff-autostore-merges, if necessary
2613 (if save-and-continue t ediff-autostore-merges)))
2614 (if ediff-autostore-merges
2615 (cond ((stringp ediff-merge-store-file)
2616 ;; store, ask to delete
2617 (ediff-write-merge-buffer-and-maybe-kill
2618 ediff-buffer-C merge-store-file 'show-file save-and-continue))
2619 ((eq ediff-autostore-merges t)
2620 ;; ask for file name
2621 (setq merge-store-file
2622 (read-file-name "Save the merge buffer in file: "))
2623 (ediff-write-merge-buffer-and-maybe-kill
2624 ediff-buffer-C merge-store-file nil save-and-continue))
2625 ((and (ediff-buffer-live-p ediff-meta-buffer)
2626 (ediff-with-current-buffer ediff-meta-buffer
2627 (ediff-merge-metajob)))
2628 ;; The parent metajob passed nil as the autostore file.
2629 nil)))
2632 ;; write merge buffer. If the optional argument save-and-continue is non-nil,
2633 ;; then don't kill the merge buffer
2634 (defun ediff-write-merge-buffer-and-maybe-kill (buf file
2635 &optional
2636 show-file save-and-continue)
2637 (ediff-with-current-buffer buf
2638 (if (or (not (file-exists-p file))
2639 (y-or-n-p (format "File %s exists, overwrite? " file)))
2640 (progn
2641 (write-region (point-min) (point-max) file)
2642 (if show-file
2643 (progn
2644 (message "Merge buffer saved in: %s" file)
2645 (set-buffer-modified-p nil)
2646 (sit-for 3)))
2647 (if (and
2648 (not save-and-continue)
2649 (y-or-n-p "Merge buffer saved. Now kill the buffer? "))
2650 (ediff-kill-buffer-carefully buf))))))
2652 ;; The default way of suspending Ediff.
2653 ;; Buries Ediff buffers, kills all windows.
2654 (defun ediff-default-suspend-function ()
2655 (let* ((buf-A ediff-buffer-A)
2656 (buf-B ediff-buffer-B)
2657 (buf-C ediff-buffer-C)
2658 (buf-A-wind (ediff-get-visible-buffer-window buf-A))
2659 (buf-B-wind (ediff-get-visible-buffer-window buf-B))
2660 (buf-C-wind (ediff-get-visible-buffer-window buf-C))
2661 (buf-patch (if (boundp 'ediff-patchbufer) ediff-patchbufer nil))
2662 (buf-patch-diag (if (boundp 'ediff-patch-diagnostics)
2663 ediff-patch-diagnostics nil))
2664 (buf-err ediff-error-buffer)
2665 (buf-diff ediff-diff-buffer)
2666 (buf-custom-diff ediff-custom-diff-buffer)
2667 (buf-fine-diff ediff-fine-diff-buffer))
2669 ;; hide the control panel
2670 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame))
2671 (iconify-frame ediff-control-frame)
2672 (bury-buffer))
2673 (if buf-err (bury-buffer buf-err))
2674 (if buf-diff (bury-buffer buf-diff))
2675 (if buf-custom-diff (bury-buffer buf-custom-diff))
2676 (if buf-fine-diff (bury-buffer buf-fine-diff))
2677 (if buf-patch (bury-buffer buf-patch))
2678 (if buf-patch-diag (bury-buffer buf-patch-diag))
2679 (if (window-live-p buf-A-wind)
2680 (progn
2681 (select-window buf-A-wind)
2682 (delete-other-windows)
2683 (bury-buffer))
2684 (if (ediff-buffer-live-p buf-A)
2685 (progn
2686 (set-buffer buf-A)
2687 (bury-buffer))))
2688 (if (window-live-p buf-B-wind)
2689 (progn
2690 (select-window buf-B-wind)
2691 (delete-other-windows)
2692 (bury-buffer))
2693 (if (ediff-buffer-live-p buf-B)
2694 (progn
2695 (set-buffer buf-B)
2696 (bury-buffer))))
2697 (if (window-live-p buf-C-wind)
2698 (progn
2699 (select-window buf-C-wind)
2700 (delete-other-windows)
2701 (bury-buffer))
2702 (if (ediff-buffer-live-p buf-C)
2703 (progn
2704 (set-buffer buf-C)
2705 (bury-buffer))))
2709 (defun ediff-suspend ()
2710 "Suspend Ediff.
2711 To resume, switch to the appropriate `Ediff Control Panel'
2712 buffer and then type \\[ediff-recenter]. Ediff will automatically set
2713 up an appropriate window config."
2714 (interactive)
2715 (ediff-barf-if-not-control-buffer)
2716 (run-hooks 'ediff-suspend-hook)
2717 (message
2718 "To resume, type M-x eregistry and select the desired Ediff session"))
2721 (defun ediff-status-info ()
2722 "Show the names of the buffers or files being operated on by Ediff.
2723 Hit \\[ediff-recenter] to reset the windows afterward."
2724 (interactive)
2725 (ediff-barf-if-not-control-buffer)
2726 (save-excursion
2727 (ediff-skip-unsuitable-frames))
2728 (with-output-to-temp-buffer ediff-msg-buffer
2729 (ediff-with-current-buffer standard-output
2730 (fundamental-mode))
2731 (raise-frame (selected-frame))
2732 (princ (ediff-version))
2733 (princ "\n\n")
2734 (ediff-with-current-buffer ediff-buffer-A
2735 (if buffer-file-name
2736 (princ
2737 (format "File A = %S\n" buffer-file-name))
2738 (princ
2739 (format "Buffer A = %S\n" (buffer-name)))))
2740 (ediff-with-current-buffer ediff-buffer-B
2741 (if buffer-file-name
2742 (princ
2743 (format "File B = %S\n" buffer-file-name))
2744 (princ
2745 (format "Buffer B = %S\n" (buffer-name)))))
2746 (if ediff-3way-job
2747 (ediff-with-current-buffer ediff-buffer-C
2748 (if buffer-file-name
2749 (princ
2750 (format "File C = %S\n" buffer-file-name))
2751 (princ
2752 (format "Buffer C = %S\n" (buffer-name))))))
2753 (princ (format "Customized diff output %s\n"
2754 (if (ediff-buffer-live-p ediff-custom-diff-buffer)
2755 (concat "\tin buffer "
2756 (buffer-name ediff-custom-diff-buffer))
2757 " is not available")))
2758 (princ (format "Plain diff output %s\n"
2759 (if (ediff-buffer-live-p ediff-diff-buffer)
2760 (concat "\tin buffer "
2761 (buffer-name ediff-diff-buffer))
2762 " is not available")))
2764 (let* ((A-line (ediff-with-current-buffer ediff-buffer-A
2765 (1+ (count-lines (point-min) (point)))))
2766 (B-line (ediff-with-current-buffer ediff-buffer-B
2767 (1+ (count-lines (point-min) (point)))))
2768 C-line)
2769 (princ (format "\Buffer A's point is on line %d\n" A-line))
2770 (princ (format "Buffer B's point is on line %d\n" B-line))
2771 (if ediff-3way-job
2772 (progn
2773 (setq C-line (ediff-with-current-buffer ediff-buffer-C
2774 (1+ (count-lines (point-min) (point)))))
2775 (princ (format "Buffer C's point is on line %d\n" C-line)))))
2777 (princ (format "\nCurrent difference number = %S\n"
2778 (cond ((< ediff-current-difference 0) 'start)
2779 ((>= ediff-current-difference
2780 ediff-number-of-differences) 'end)
2781 (t (1+ ediff-current-difference)))))
2783 (princ
2784 (format "\n%s regions that differ in white space & line breaks only"
2785 (if ediff-ignore-similar-regions
2786 "Ignoring" "Showing")))
2787 (if (and ediff-merge-job ediff-show-clashes-only)
2788 (princ
2789 "\nFocusing on regions where both buffers differ from the ancestor"))
2790 (if (and ediff-skip-merge-regions-that-differ-from-default ediff-merge-job)
2791 (princ
2792 "\nSkipping merge regions that differ from default setting"))
2794 (cond ((eq ediff-skip-diff-region-function 'ediff-show-all-diffs)
2795 (princ "\nSelective browsing by regexp is off\n"))
2796 ((eq ediff-skip-diff-region-function
2797 ediff-hide-regexp-matches-function)
2798 (princ
2799 "\nIgnoring regions that match")
2800 (princ
2801 (format
2802 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2803 ediff-regexp-hide-A ediff-hide-regexp-connective
2804 ediff-regexp-hide-B)))
2805 ((eq ediff-skip-diff-region-function
2806 ediff-focus-on-regexp-matches-function)
2807 (princ
2808 "\nFocusing on regions that match")
2809 (princ
2810 (format
2811 "\n\t regexp `%s' in buffer A %S\n\t regexp `%s' in buffer B\n"
2812 ediff-regexp-focus-A ediff-focus-regexp-connective
2813 ediff-regexp-focus-B)))
2814 (t (princ "\nSelective browsing via a user-defined method.\n")))
2816 (princ
2817 (format "\nBugs/suggestions: type `%s' while in Ediff Control Panel."
2818 (substitute-command-keys "\\[ediff-submit-report]")))
2819 ) ; with output
2820 (if (frame-live-p ediff-control-frame)
2821 (ediff-reset-mouse ediff-control-frame))
2822 (if (window-live-p ediff-control-window)
2823 (select-window ediff-control-window)))
2828 ;;; Support routines
2830 ;; Select a difference by placing the ASCII flags around the appropriate
2831 ;; group of lines in the A, B buffers
2832 ;; This may have to be modified for buffer C, when it will be supported.
2833 (defun ediff-select-difference (n)
2834 (if (and (ediff-buffer-live-p ediff-buffer-A)
2835 (ediff-buffer-live-p ediff-buffer-B)
2836 (ediff-valid-difference-p n))
2837 (progn
2838 (if (and (ediff-has-face-support-p) ediff-use-faces)
2839 (progn
2840 (ediff-highlight-diff n)
2841 (setq ediff-highlighting-style 'face))
2842 (setq ediff-highlighting-style 'ascii)
2843 (ediff-place-flags-in-buffer
2844 'A ediff-buffer-A ediff-control-buffer n)
2845 (ediff-place-flags-in-buffer
2846 'B ediff-buffer-B ediff-control-buffer n)
2847 (if ediff-3way-job
2848 (ediff-place-flags-in-buffer
2849 'C ediff-buffer-C ediff-control-buffer n))
2850 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2851 (ediff-place-flags-in-buffer
2852 'Ancestor ediff-ancestor-buffer
2853 ediff-control-buffer n))
2856 (ediff-install-fine-diff-if-necessary n)
2857 (run-hooks 'ediff-select-hook))))
2860 ;; Unselect a difference by removing the ASCII flags in the buffers.
2861 ;; This may have to be modified for buffer C, when it will be supported.
2862 (defun ediff-unselect-difference (n)
2863 (if (ediff-valid-difference-p n)
2864 (progn
2865 (cond ((and (ediff-has-face-support-p) ediff-use-faces)
2866 (ediff-unhighlight-diff))
2867 ((eq ediff-highlighting-style 'ascii)
2868 (ediff-remove-flags-from-buffer
2869 ediff-buffer-A
2870 (ediff-get-diff-overlay n 'A))
2871 (ediff-remove-flags-from-buffer
2872 ediff-buffer-B
2873 (ediff-get-diff-overlay n 'B))
2874 (if ediff-3way-job
2875 (ediff-remove-flags-from-buffer
2876 ediff-buffer-C
2877 (ediff-get-diff-overlay n 'C)))
2878 (if (ediff-buffer-live-p ediff-ancestor-buffer)
2879 (ediff-remove-flags-from-buffer
2880 ediff-ancestor-buffer
2881 (ediff-get-diff-overlay n 'Ancestor)))
2883 (setq ediff-highlighting-style nil)
2885 ;; unhighlight fine diffs
2886 (ediff-set-fine-diff-properties ediff-current-difference 'default)
2887 (run-hooks 'ediff-unselect-hook))))
2890 ;; Unselects prev diff and selects a new one, if FLAG has value other than
2891 ;; 'select-only or 'unselect-only. If FLAG is 'select-only, the
2892 ;; next difference is selected, but the current selection is not
2893 ;; unselected. If FLAG is 'unselect-only then the current selection is
2894 ;; unselected, but the next one is not selected. If NO-RECENTER is non-nil,
2895 ;; don't recenter buffers after selecting/unselecting.
2896 (defun ediff-unselect-and-select-difference (n &optional flag no-recenter)
2897 (let ((ediff-current-difference n))
2898 (or no-recenter
2899 (ediff-recenter 'no-rehighlight)))
2901 (let ((control-buf ediff-control-buffer))
2902 (unwind-protect
2903 (progn
2904 (or (eq flag 'select-only)
2905 (ediff-unselect-difference ediff-current-difference))
2907 (or (eq flag 'unselect-only)
2908 (ediff-select-difference n))
2909 (setq ediff-current-difference n)
2910 ) ; end protected section
2912 (ediff-with-current-buffer control-buf (ediff-refresh-mode-lines))
2916 ;; This is adapted from a similar function in `emerge.el'.
2917 ;; PROMPT should not have a trailing ': ', so that it can be modified
2918 ;; according to context.
2919 ;; If DEFAULT-FILE is set, it should be used as the default value.
2920 ;; If DEFAULT-DIR is non-nil, use it as the default directory.
2921 ;; Otherwise, use the value of Emacs' variable `default-directory.'
2922 (defun ediff-read-file-name (prompt default-dir default-file)
2923 ;; hack default-dir if it is not set
2924 (setq default-dir
2925 (file-name-as-directory
2926 (ediff-abbreviate-file-name
2927 (expand-file-name (or default-dir
2928 (and default-file
2929 (file-name-directory default-file))
2930 default-directory)))))
2932 ;; strip the directory from default-file
2933 (if default-file
2934 (setq default-file (file-name-nondirectory default-file)))
2935 (if (string= default-file "")
2936 (setq default-file nil))
2938 (let (f)
2939 (setq f (expand-file-name
2940 (read-file-name
2941 (format "%s%s "
2942 prompt
2943 (cond (default-file
2944 (concat " (default " default-file "):"))
2945 (t (concat " (default " default-dir "):"))))
2946 default-dir
2947 (or default-file default-dir)
2948 t ; must match, no-confirm
2949 (if default-file (file-name-directory default-file))
2951 default-dir
2953 ;; If user enters a directory name, expand the default file in that
2954 ;; directory. This allows the user to enter a directory name for the
2955 ;; B-file and diff against the default-file in that directory instead
2956 ;; of a DIRED listing!
2957 (if (and (file-directory-p f) default-file)
2958 (setq f (expand-file-name
2959 (file-name-nondirectory default-file) f)))
2960 f))
2962 ;; If PREFIX is given, then it is used as a prefix for the temp file
2963 ;; name. Otherwise, `ediff' is used. If FILE is given, use this
2964 ;; file and don't create a new one.
2965 ;; In MS-DOS, make sure the prefix isn't too long, or else
2966 ;; `make-temp-name' isn't guaranteed to return a unique filename.
2967 ;; Also, save buffer from START to END in the file.
2968 ;; START defaults to (point-min), END to (point-max)
2969 (defun ediff-make-temp-file (buff &optional prefix given-file start end)
2970 (let* ((p (ediff-convert-standard-filename (or prefix "ediff")))
2971 (short-p p)
2972 (coding-system-for-write 'no-conversion)
2973 f short-f)
2974 (if (and (fboundp 'msdos-long-file-names)
2975 (not (msdos-long-file-names))
2976 (> (length p) 2))
2977 (setq short-p (substring p 0 2)))
2979 (setq f (concat ediff-temp-file-prefix p)
2980 short-f (concat ediff-temp-file-prefix short-p)
2981 f (cond (given-file)
2982 ((find-file-name-handler f 'find-file-noselect)
2983 ;; to thwart file handlers in write-region, e.g., if file
2984 ;; name ends with .Z or .gz
2985 ;; This is needed so that patches produced by ediff will
2986 ;; have more meaningful names
2987 (ediff-make-empty-tmp-file short-f))
2988 (prefix
2989 ;; Prefix is most often the same as the file name for the
2990 ;; variant. Here we are trying to use the original file
2991 ;; name but in the temp directory.
2992 (ediff-make-empty-tmp-file f 'keep-name))
2994 ;; If don't care about name, add some random stuff
2995 ;; to proposed file name.
2996 (ediff-make-empty-tmp-file short-f))))
2998 ;; create the file
2999 (ediff-with-current-buffer buff
3000 (write-region (if start start (point-min))
3001 (if end end (point-max))
3003 nil ; don't append---erase
3004 'no-message)
3005 (set-file-modes f ediff-temp-file-mode)
3006 (expand-file-name f))))
3008 ;; Create a temporary file.
3009 ;; The returned file name (created by appending some random characters at the
3010 ;; end of PROPOSED-NAME is guaranteed to point to a newly created empty file.
3011 ;; This is a replacement for make-temp-name, which eliminates a security hole.
3012 ;; If KEEP-PROPOSED-NAME isn't nil, try to keep PROPOSED-NAME, unless such file
3013 ;; already exists.
3014 ;; It is a modified version of make-temp-file in emacs 20.5
3015 (defun ediff-make-empty-tmp-file (proposed-name &optional keep-proposed-name)
3016 (let ((file proposed-name))
3017 (while (condition-case ()
3018 (progn
3019 (if (or (file-exists-p file) (not keep-proposed-name))
3020 (setq file (make-temp-name proposed-name)))
3021 (write-region "" nil file nil 'silent nil 'excl)
3022 nil)
3023 (file-already-exists t))
3024 ;; the file was somehow created by someone else between
3025 ;; `make-temp-name' and `write-region', let's try again.
3026 nil)
3027 file))
3030 ;; Quote metacharacters (using \) when executing diff in Unix, but not in
3031 ;; EMX OS/2
3032 ;;(defun ediff-protect-metachars (str)
3033 ;; (or (memq system-type '(emx vax-vms axp-vms))
3034 ;; (let ((limit 0))
3035 ;; (while (string-match ediff-metachars str limit)
3036 ;; (setq str (concat (substring str 0 (match-beginning 0))
3037 ;; "\\"
3038 ;; (substring str (match-beginning 0))))
3039 ;; (setq limit (1+ (match-end 0))))))
3040 ;; str)
3042 ;; Make sure the current buffer (for a file) has the same contents as the
3043 ;; file on disk, and attempt to remedy the situation if not.
3044 ;; Signal an error if we can't make them the same, or the user doesn't want
3045 ;; to do what is necessary to make them the same.
3046 ;; Also, Ediff always offers to revert obsolete buffers, whether they
3047 ;; are modified or not.
3048 (defun ediff-verify-file-buffer (&optional file-magic)
3049 ;; First check if the file has been modified since the buffer visited it.
3050 (if (verify-visited-file-modtime (current-buffer))
3051 (if (buffer-modified-p)
3052 ;; If buffer is not obsolete and is modified, offer to save
3053 (if (yes-or-no-p
3054 (format "Buffer out of sync with visited file. Save file %s? "
3055 buffer-file-name))
3056 (condition-case nil
3057 (save-buffer)
3058 (error
3059 (beep)
3060 (message "Couldn't save %s" buffer-file-name)))
3061 (error "Buffer is out of sync for file %s" buffer-file-name))
3062 ;; If buffer is not obsolete and is not modified, do nothing
3063 nil)
3064 ;; If buffer is obsolete, offer to revert
3065 (if (yes-or-no-p
3066 (format "Buffer is out of sync with visited file. REVERT file %s? "
3067 buffer-file-name))
3068 (progn
3069 (if file-magic
3070 (erase-buffer))
3071 (revert-buffer t t))
3072 (error "Buffer out of sync for file %s" buffer-file-name))))
3075 (defun ediff-filename-magic-p (file)
3076 (or (ediff-file-compressed-p file)
3077 (ediff-file-remote-p file)))
3080 (defun ediff-save-buffer (arg)
3081 "Safe way of saving buffers A, B, C, and the diff output.
3082 `wa' saves buffer A, `wb' saves buffer B, `wc' saves buffer C,
3083 and `wd' saves the diff output.
3085 With prefix argument, `wd' saves plain diff output.
3086 Without an argument, it saves customized diff argument, if available
3087 \(and plain output, if customized output was not generated\)."
3088 (interactive "P")
3089 (ediff-barf-if-not-control-buffer)
3090 (ediff-compute-custom-diffs-maybe)
3091 (ediff-with-current-buffer
3092 (cond ((memq last-command-char '(?a ?b ?c))
3093 (ediff-get-buffer
3094 (ediff-char-to-buftype last-command-char)))
3095 ((eq last-command-char ?d)
3096 (message "Saving diff output ...")
3097 (sit-for 1) ; let the user see the message
3098 (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3099 ediff-diff-buffer)
3100 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3101 ediff-custom-diff-buffer)
3102 ((ediff-buffer-live-p ediff-diff-buffer)
3103 ediff-diff-buffer)
3104 (t (error "Output from `diff' not found"))))
3106 (save-buffer)))
3108 (defun ediff-compute-custom-diffs-maybe ()
3109 (let ((buf-A-file-name (buffer-file-name ediff-buffer-A))
3110 (buf-B-file-name (buffer-file-name ediff-buffer-B))
3111 file-A file-B)
3112 (if (stringp buf-A-file-name)
3113 (setq buf-A-file-name (file-name-nondirectory buf-A-file-name)))
3114 (if (stringp buf-B-file-name)
3115 (setq buf-B-file-name (file-name-nondirectory buf-B-file-name)))
3116 (setq file-A (ediff-make-temp-file ediff-buffer-A buf-A-file-name)
3117 file-B (ediff-make-temp-file ediff-buffer-B buf-B-file-name))
3119 (or (ediff-buffer-live-p ediff-custom-diff-buffer)
3120 (setq ediff-custom-diff-buffer
3121 (get-buffer-create
3122 (ediff-unique-buffer-name "*ediff-custom-diff" "*"))))
3123 (ediff-exec-process
3124 ediff-custom-diff-program ediff-custom-diff-buffer 'synchronize
3125 ediff-custom-diff-options file-A file-B)
3126 ;; put the diff file in diff-mode, if it is available
3127 (if (fboundp 'diff-mode)
3128 (with-current-buffer ediff-custom-diff-buffer
3129 (diff-mode)))
3130 (delete-file file-A)
3131 (delete-file file-B)
3134 (defun ediff-show-diff-output (arg)
3135 (interactive "P")
3136 (ediff-barf-if-not-control-buffer)
3137 (ediff-compute-custom-diffs-maybe)
3138 (save-excursion
3139 (ediff-skip-unsuitable-frames ' ok-unsplittable))
3140 (let ((buf (cond ((and arg (ediff-buffer-live-p ediff-diff-buffer))
3141 ediff-diff-buffer)
3142 ((ediff-buffer-live-p ediff-custom-diff-buffer)
3143 ediff-custom-diff-buffer)
3144 ((ediff-buffer-live-p ediff-diff-buffer)
3145 ediff-diff-buffer)
3147 (beep)
3148 (message "Output from `diff' not found")
3149 nil))))
3150 (if buf
3151 (progn
3152 (ediff-with-current-buffer buf
3153 (goto-char (point-min)))
3154 (switch-to-buffer buf)
3155 (raise-frame (selected-frame)))))
3156 (if (frame-live-p ediff-control-frame)
3157 (ediff-reset-mouse ediff-control-frame))
3158 (if (window-live-p ediff-control-window)
3159 (select-window ediff-control-window)))
3162 (defun ediff-inferior-compare-regions ()
3163 "Compare regions in an active Ediff session.
3164 Like ediff-regions-linewise but is called from under an active Ediff session on
3165 the files that belong to that session.
3167 After quitting the session invoked via this function, type C-l to the parent
3168 Ediff Control Panel to restore highlighting."
3169 (interactive)
3170 (let ((answer "")
3171 (possibilities (list ?A ?B ?C))
3172 (zmacs-regions t)
3173 (ctl-buf (current-buffer))
3174 quit-now
3175 begA begB endA endB bufA bufB)
3177 (cond ((ediff-merge-job)
3178 (setq bufB ediff-buffer-C)
3179 (while (cond ((eq answer ?A)
3180 (setq bufA ediff-buffer-A
3181 possibilities '(?B))
3182 nil)
3183 ((eq answer ?B)
3184 (setq bufA ediff-buffer-B
3185 possibilities '(?A))
3186 nil)
3187 ((equal answer ""))
3188 (t (beep 1)
3189 (message "Valid values are A or B")
3190 (sit-for 2)
3192 (let ((cursor-in-echo-area t))
3193 (message "Which buffer to compare to the merge buffer (A/B)? ")
3194 (setq answer (capitalize (read-char-exclusive))))))
3196 ((ediff-3way-comparison-job)
3197 (while (cond ((memq answer possibilities)
3198 (setq possibilities (delq answer possibilities))
3199 (setq bufA
3200 (eval
3201 (ediff-get-symbol-from-alist
3202 answer ediff-buffer-alist)))
3203 nil)
3204 ((equal answer ""))
3205 (t (beep 1)
3206 (message
3207 "Valid values are %s"
3208 (mapconcat 'char-to-string possibilities " or "))
3209 (sit-for 2)
3211 (let ((cursor-in-echo-area t))
3212 (message "Enter the 1st buffer you want to compare (%s): "
3213 (mapconcat 'char-to-string possibilities "/"))
3214 (setq answer (capitalize (read-char-exclusive)))))
3215 (setq answer "") ; silence error msg
3216 (while (cond ((memq answer possibilities)
3217 (setq possibilities (delq answer possibilities))
3218 (setq bufB
3219 (eval
3220 (ediff-get-symbol-from-alist
3221 answer ediff-buffer-alist)))
3222 nil)
3223 ((equal answer ""))
3224 (t (beep 1)
3225 (message
3226 "Valid values are %s"
3227 (mapconcat 'char-to-string possibilities " or "))
3228 (sit-for 2)
3230 (let ((cursor-in-echo-area t))
3231 (message "Enter the 2nd buffer you want to compare (%s): "
3232 (mapconcat 'char-to-string possibilities "/"))
3233 (setq answer (capitalize (read-char-exclusive))))))
3234 (t ; 2way comparison
3235 (setq bufA ediff-buffer-A
3236 bufB ediff-buffer-B
3237 possibilities nil)))
3239 (ediff-with-current-buffer bufA
3240 (or (mark t)
3241 (error "You forgot to specify a region in buffer %s" (buffer-name)))
3242 (setq begA (region-beginning)
3243 endA (region-end))
3244 (goto-char begA)
3245 (beginning-of-line)
3246 (setq begA (point))
3247 (goto-char endA)
3248 (end-of-line)
3249 (or (eobp) (forward-char)) ; include the newline char
3250 (setq endA (point)))
3251 (ediff-with-current-buffer bufB
3252 (or (mark t)
3253 (error "You forgot to specify a region in buffer %s" (buffer-name)))
3254 (setq begB (region-beginning)
3255 endB (region-end))
3256 (goto-char begB)
3257 (beginning-of-line)
3258 (setq begB (point))
3259 (goto-char endB)
3260 (end-of-line)
3261 (or (eobp) (forward-char)) ; include the newline char
3262 (setq endB (point)))
3264 (ediff-unselect-and-select-difference
3265 ediff-current-difference 'unselect-only)
3266 (ediff-paint-background-regions 'unhighlight)
3268 (ediff-with-current-buffer bufA
3269 (goto-char begA)
3270 (set-mark endA)
3271 (narrow-to-region begA endA)
3272 ;; (ediff-activate-mark)
3274 ;; (sit-for 0)
3275 (ediff-with-current-buffer bufB
3276 (goto-char begB)
3277 (set-mark endB)
3278 (narrow-to-region begB endB)
3279 ;; (ediff-activate-mark)
3281 ;; (sit-for 0)
3283 ;; At this point, possibilities contains either the window char A/B/C
3284 ;; that was not selected, or it is nil. We delete the window that is not
3285 ;; selected.
3286 (if possibilities
3287 (ediff-with-current-buffer ctl-buf
3288 (let* ((wind-to-delete (eval
3289 (ediff-get-symbol-from-alist
3290 (car possibilities)
3291 ediff-window-alist)))
3292 (frame (window-frame wind-to-delete)))
3293 (delete-window wind-to-delete)
3294 (select-frame frame)
3295 (balance-windows))))
3296 (or (y-or-n-p
3297 "Please check regions selected for comparison. Continue? ")
3298 (setq quit-now t))
3300 (ediff-with-current-buffer bufA
3301 (widen))
3302 (ediff-with-current-buffer bufB
3303 (widen))
3304 (if quit-now
3305 (ediff-with-current-buffer ctl-buf
3306 (ediff-recenter)
3307 (sit-for 0)
3308 (error "All right. Make up your mind and come back...")))
3310 (ediff-regions-internal
3311 bufA begA endA bufB begB endB
3312 nil ; setup-hook
3313 'ediff-regions-linewise ; job name
3314 nil ; no word mode
3315 ;; setup param to pass to ediff-setup
3316 (list (cons 'ediff-split-window-function ediff-split-window-function)))
3321 (defun ediff-remove-flags-from-buffer (buffer overlay)
3322 (ediff-with-current-buffer buffer
3323 (let ((inhibit-read-only t))
3324 (if ediff-xemacs-p
3325 (ediff-overlay-put overlay 'begin-glyph nil)
3326 (ediff-overlay-put overlay 'before-string nil))
3328 (if ediff-xemacs-p
3329 (ediff-overlay-put overlay 'end-glyph nil)
3330 (ediff-overlay-put overlay 'after-string nil))
3335 (defun ediff-place-flags-in-buffer (buf-type buffer ctl-buffer diff)
3336 (ediff-with-current-buffer buffer
3337 (ediff-place-flags-in-buffer1 buf-type ctl-buffer diff)))
3340 (defun ediff-place-flags-in-buffer1 (buf-type ctl-buffer diff-no)
3341 (let* ((curr-overl (ediff-with-current-buffer ctl-buffer
3342 (ediff-get-diff-overlay diff-no buf-type)))
3343 (before (ediff-get-diff-posn buf-type 'beg diff-no ctl-buffer))
3344 after beg-of-line flag)
3346 ;; insert flag before the difference
3347 (goto-char before)
3348 (setq beg-of-line (bolp))
3350 (setq flag (ediff-with-current-buffer ctl-buffer
3351 (if (eq ediff-highlighting-style 'ascii)
3352 (if beg-of-line
3353 ediff-before-flag-bol ediff-before-flag-mol))))
3355 ;; insert the flag itself
3356 (if ediff-xemacs-p
3357 (ediff-overlay-put curr-overl 'begin-glyph flag)
3358 (ediff-overlay-put curr-overl 'before-string flag))
3360 ;; insert the flag after the difference
3361 ;; `after' must be set here, after the before-flag was inserted
3362 (setq after (ediff-get-diff-posn buf-type 'end diff-no ctl-buffer))
3363 (goto-char after)
3364 (setq beg-of-line (bolp))
3366 (setq flag (ediff-with-current-buffer ctl-buffer
3367 (if (eq ediff-highlighting-style 'ascii)
3368 (if beg-of-line
3369 ediff-after-flag-eol ediff-after-flag-mol))))
3371 ;; insert the flag itself
3372 (if ediff-xemacs-p
3373 (ediff-overlay-put curr-overl 'end-glyph flag)
3374 (ediff-overlay-put curr-overl 'after-string flag))
3378 ;; Returns positions of difference sectors in the BUF-TYPE buffer.
3379 ;; BUF-TYPE should be a symbol -- `A', `B', or `C'.
3380 ;; POS is either `beg' or `end'--it specifies whether you want the position at
3381 ;; the beginning of a difference or at the end.
3383 ;; The optional argument N says which difference (default:
3384 ;; `ediff-current-difference'). N is the internal difference number (1- what
3385 ;; the user sees). The optional argument CONTROL-BUF says
3386 ;; which control buffer is in effect in case it is not the current
3387 ;; buffer.
3388 (defun ediff-get-diff-posn (buf-type pos &optional n control-buf)
3389 (let (diff-overlay)
3390 (or control-buf
3391 (setq control-buf (current-buffer)))
3393 (ediff-with-current-buffer control-buf
3394 (or n (setq n ediff-current-difference))
3395 (if (or (< n 0) (>= n ediff-number-of-differences))
3396 (if (> ediff-number-of-differences 0)
3397 (error ediff-BAD-DIFF-NUMBER
3398 this-command (1+ n) ediff-number-of-differences)
3399 (error ediff-NO-DIFFERENCES)))
3400 (setq diff-overlay (ediff-get-diff-overlay n buf-type)))
3401 (if (not (ediff-buffer-live-p (ediff-overlay-buffer diff-overlay)))
3402 (error ediff-KILLED-VITAL-BUFFER))
3403 (if (eq pos 'beg)
3404 (ediff-overlay-start diff-overlay)
3405 (ediff-overlay-end diff-overlay))
3409 ;; Restore highlighting to what it should be according to ediff-use-faces,
3410 ;; ediff-highlighting-style, and ediff-highlight-all-diffs variables.
3411 (defun ediff-restore-highlighting (&optional ctl-buf)
3412 (ediff-with-current-buffer (or ctl-buf (current-buffer))
3413 (if (and (ediff-has-face-support-p)
3414 ediff-use-faces
3415 ediff-highlight-all-diffs)
3416 (ediff-paint-background-regions))
3417 (ediff-select-difference ediff-current-difference)))
3421 ;; null out difference overlays so they won't slow down future
3422 ;; editing operations
3423 ;; VEC is either a difference vector or a fine-diff vector
3424 (defun ediff-clear-diff-vector (vec-var &optional fine-diffs-also)
3425 (if (vectorp (symbol-value vec-var))
3426 (mapcar (lambda (elt)
3427 (ediff-delete-overlay
3428 (ediff-get-diff-overlay-from-diff-record elt))
3429 (if fine-diffs-also
3430 (ediff-clear-fine-diff-vector elt))
3432 (symbol-value vec-var)))
3433 ;; allow them to be garbage collected
3434 (set vec-var nil))
3438 ;;; Misc
3440 ;; In Emacs, this just makes overlay. In the future, when Emacs will start
3441 ;; supporting sticky overlays, this function will make a sticky overlay.
3442 ;; BEG and END are expressions telling where overlay starts.
3443 ;; If they are numbers or buffers, then all is well. Otherwise, they must
3444 ;; be expressions to be evaluated in buffer BUF in order to get the overlay
3445 ;; bounds.
3446 ;; If BUFF is not a live buffer, then return nil; otherwise, return the
3447 ;; newly created overlay.
3448 (defun ediff-make-bullet-proof-overlay (beg end buff)
3449 (if (ediff-buffer-live-p buff)
3450 (let (overl)
3451 (ediff-with-current-buffer buff
3452 (or (number-or-marker-p beg)
3453 (setq beg (eval beg)))
3454 (or (number-or-marker-p end)
3455 (setq end (eval end)))
3456 (setq overl
3457 (if ediff-xemacs-p
3458 (make-extent beg end buff)
3459 ;; advance front and rear of the overlay
3460 (make-overlay beg end buff nil 'rear-advance)))
3462 ;; never detach
3463 (ediff-overlay-put
3464 overl (if ediff-emacs-p 'evaporate 'detachable) nil)
3465 ;; make vip-minibuffer-overlay open-ended
3466 ;; In emacs, it is made open ended at creation time
3467 (if ediff-xemacs-p
3468 (progn
3469 (ediff-overlay-put overl 'start-open nil)
3470 (ediff-overlay-put overl 'end-open nil)))
3471 (ediff-overlay-put overl 'ediff-diff-num 0)
3472 overl))))
3475 ;; Like other-buffer, but prefers visible buffers and ignores temporary or
3476 ;; other insignificant buffers (those beginning with "^[ *]").
3477 ;; Gets one arg--buffer name or a list of buffer names (it won't return
3478 ;; these buffers).
3479 ;; EXCL-BUFF-LIST is an exclusion list.
3480 (defun ediff-other-buffer (excl-buff-lst)
3481 (or (listp excl-buff-lst) (setq excl-buff-lst (list excl-buff-lst)))
3482 (let* ((all-buffers (nconc (ediff-get-selected-buffers) (buffer-list)))
3483 ;; we compute this the second time because we need to do memq on it
3484 ;; later, and nconc above will break it. Either this or use slow
3485 ;; append instead of nconc
3486 (selected-buffers (ediff-get-selected-buffers))
3487 (prefered-buffer (car all-buffers))
3488 visible-dired-buffers
3489 (excl-buff-name-list
3490 (mapcar
3491 (lambda (b) (cond ((stringp b) b)
3492 ((bufferp b) (buffer-name b))))
3493 excl-buff-lst))
3494 ;; if at least one buffer on the exclusion list is dired, then force
3495 ;; all others to be dired. This is because this means that the user
3496 ;; has already chosen a dired buffer before
3497 (use-dired-major-mode
3498 (cond ((null (ediff-buffer-live-p (car excl-buff-lst))) 'unknown)
3499 ((eq (ediff-with-current-buffer (car excl-buff-lst) major-mode)
3500 'dired-mode)
3501 'yes)
3502 (t 'no)))
3503 ;; significant-buffers must be visible and not belong
3504 ;; to the exclusion list `buff-list'
3505 ;; We also exclude temporary buffers, but keep mail and gnus buffers
3506 ;; Furthermore, we exclude dired buffers, unless they are the only
3507 ;; ones visible (and there are at least two of them).
3508 ;; Also, any visible window not on the exclusion list that is first in
3509 ;; the buffer list is chosen regardless. (This is because the user
3510 ;; clicked on it or did something to distinguish it).
3511 (significant-buffers
3512 (mapcar
3513 (lambda (x)
3514 (cond ((member (buffer-name x) excl-buff-name-list) nil)
3515 ((memq x selected-buffers) x)
3516 ((not (ediff-get-visible-buffer-window x)) nil)
3517 ((eq x prefered-buffer) x)
3518 ;; if prev selected buffer is dired, look only at
3519 ;; dired.
3520 ((eq use-dired-major-mode 'yes)
3521 (if (eq (ediff-with-current-buffer x major-mode)
3522 'dired-mode)
3523 x nil))
3524 ((eq (ediff-with-current-buffer x major-mode)
3525 'dired-mode)
3526 (if (null use-dired-major-mode)
3527 ;; don't know if we must enforce dired.
3528 ;; Remember this buffer in case
3529 ;; dired buffs are the only ones visible.
3530 (setq visible-dired-buffers
3531 (cons x visible-dired-buffers)))
3532 ;; skip, if dired is not forced
3533 nil)
3534 ((memq (ediff-with-current-buffer x major-mode)
3535 '(rmail-mode
3536 vm-mode
3537 gnus-article-mode
3538 mh-show-mode))
3540 ((string-match "^[ *]" (buffer-name x)) nil)
3541 ((string= "*scratch*" (buffer-name x)) nil)
3542 (t x)))
3543 all-buffers))
3544 (clean-significant-buffers (delq nil significant-buffers))
3545 less-significant-buffers)
3547 (if (and (null clean-significant-buffers)
3548 (> (length visible-dired-buffers) 0))
3549 (setq clean-significant-buffers visible-dired-buffers))
3551 (cond (clean-significant-buffers (car clean-significant-buffers))
3552 ;; try also buffers that are not displayed in windows
3553 ((setq less-significant-buffers
3554 (delq nil
3555 (mapcar
3556 (lambda (x)
3557 (cond ((member (buffer-name x) excl-buff-name-list)
3558 nil)
3559 ((eq use-dired-major-mode 'yes)
3560 (if (eq (ediff-with-current-buffer
3561 x major-mode)
3562 'dired-mode)
3563 x nil))
3564 ((eq (ediff-with-current-buffer x major-mode)
3565 'dired-mode)
3566 nil)
3567 ((string-match "^[ *]" (buffer-name x)) nil)
3568 ((string= "*scratch*" (buffer-name x)) nil)
3569 (t x)))
3570 all-buffers)))
3571 (car less-significant-buffers))
3572 (t "*scratch*"))
3576 ;; If current buffer is a Buffer-menu buffer, then take the selected buffers
3577 ;; and append the buffer at the cursor to the end.
3578 ;; This list would be the preferred list.
3579 (defun ediff-get-selected-buffers ()
3580 (if (eq major-mode 'Buffer-menu-mode)
3581 (let ((lis (condition-case nil
3582 (list (Buffer-menu-buffer t))
3583 (error))
3585 (save-excursion
3586 (goto-char (point-max))
3587 (while (search-backward "\n>" nil t)
3588 (forward-char 1)
3589 (setq lis (cons (Buffer-menu-buffer t) lis)))
3590 lis))
3593 ;; Construct a unique buffer name.
3594 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
3595 ;; prefix<3>suffix, etc.
3596 (defun ediff-unique-buffer-name (prefix suffix)
3597 (if (null (get-buffer (concat prefix suffix)))
3598 (concat prefix suffix)
3599 (let ((n 2))
3600 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
3601 (setq n (1+ n)))
3602 (format "%s<%d>%s" prefix n suffix))))
3605 (defun ediff-submit-report ()
3606 "Submit bug report on Ediff."
3607 (interactive)
3608 (ediff-barf-if-not-control-buffer)
3609 (let ((reporter-prompt-for-summary-p t)
3610 (ctl-buf ediff-control-buffer)
3611 (ediff-device-type (ediff-device-type))
3612 varlist salutation buffer-name)
3613 (setq varlist '(ediff-diff-program ediff-diff-options
3614 ediff-patch-program ediff-patch-options
3615 ediff-shell
3616 ediff-use-faces
3617 ediff-auto-refine ediff-highlighting-style
3618 ediff-buffer-A ediff-buffer-B ediff-control-buffer
3619 ediff-forward-word-function
3620 ediff-control-frame
3621 ediff-control-frame-parameters
3622 ediff-control-frame-position-function
3623 ediff-prefer-iconified-control-frame
3624 ediff-window-setup-function
3625 ediff-split-window-function
3626 ediff-job-name
3627 ediff-word-mode
3628 buffer-name
3629 ediff-device-type
3631 (setq salutation "
3632 Congratulations! You may have unearthed a bug in Ediff!
3634 Please make a concise and accurate summary of what happened
3635 and mail it to the address above.
3636 -----------------------------------------------------------
3639 (ediff-skip-unsuitable-frames)
3640 (ediff-reset-mouse)
3642 (switch-to-buffer ediff-msg-buffer)
3643 (erase-buffer)
3644 (delete-other-windows)
3645 (insert "
3646 Please read this first:
3647 ----------------------
3649 Some ``bugs'' may actually be no bugs at all. For instance, if you are
3650 reporting that certain difference regions are not matched as you think they
3651 should, this is most likely due to the way Unix diff program decides what
3652 constitutes a difference region. Ediff is an Emacs interface to diff, and
3653 it has nothing to do with those decisions---it only takes the output from
3654 diff and presents it in a way that is better suited for human browsing and
3655 manipulation.
3657 If Emacs happens to dump core, this is NOT an Ediff problem---it is
3658 an Emacs bug. Report this to Emacs maintainers.
3660 Another popular topic for reports is compilation messages. Because Ediff
3661 interfaces to several other packages and runs under Emacs and XEmacs,
3662 byte-compilation may produce output like this:
3664 While compiling toplevel forms in file ediff.el:
3665 ** reference to free variable pm-color-alist
3666 ........................
3667 While compiling the end of the data:
3668 ** The following functions are not known to be defined:
3669 ediff-valid-color-p, ediff-set-face,
3670 ........................
3672 These are NOT errors, but inevitable warnings, which ought to be ignored.
3674 Please do not report those and similar things. However, comments and
3675 suggestions are always welcome.
3677 Mail anyway? (y or n) ")
3679 (if (y-or-n-p "Mail anyway? ")
3680 (progn
3681 (if (ediff-buffer-live-p ctl-buf)
3682 (set-buffer ctl-buf))
3683 (setq buffer-name (buffer-name))
3684 (require 'reporter)
3685 (reporter-submit-bug-report "kifer@cs.sunysb.edu"
3686 (ediff-version)
3687 varlist
3688 nil
3689 'delete-other-windows
3690 salutation))
3691 (bury-buffer)
3692 (beep 1)(message "Bug report aborted")
3693 (if (ediff-buffer-live-p ctl-buf)
3694 (ediff-with-current-buffer ctl-buf
3695 (ediff-recenter 'no-rehighlight))))
3699 ;; Find an appropriate syntax table for everyone to use
3700 ;; If buffer B is not fundamental or text mode, use its syntax table
3701 ;; Otherwise, use buffer B's.
3702 ;; The syntax mode is used in ediff-forward-word-function
3703 ;; The important thing is that every buffer should use the same syntax table
3704 ;; during the refinement operation
3705 (defun ediff-choose-syntax-table ()
3706 (setq ediff-syntax-table
3707 (ediff-with-current-buffer ediff-buffer-A
3708 (if (not (memq major-mode
3709 '(fundamental-mode text-mode indented-text-mode)))
3710 (syntax-table))))
3711 (if (not ediff-syntax-table)
3712 (setq ediff-syntax-table
3713 (ediff-with-current-buffer ediff-buffer-B
3714 (syntax-table))))
3718 (defun ediff-deactivate-mark ()
3719 (if ediff-xemacs-p
3720 (zmacs-deactivate-region)
3721 (deactivate-mark)))
3722 (defun ediff-activate-mark ()
3723 (if ediff-emacs-p
3724 (setq mark-active t)
3725 (zmacs-activate-region)))
3727 (cond ((fboundp 'nuke-selective-display)
3728 ;; XEmacs 19.12 has nuke-selective-display
3729 (fset 'ediff-nuke-selective-display 'nuke-selective-display))
3731 (defun ediff-nuke-selective-display ()
3732 (save-excursion
3733 (save-restriction
3734 (widen)
3735 (goto-char (point-min))
3736 (let ((mod-p (buffer-modified-p))
3737 buffer-read-only end)
3738 (and (eq t selective-display)
3739 (while (search-forward "\^M" nil t)
3740 (end-of-line)
3741 (setq end (point))
3742 (beginning-of-line)
3743 (while (search-forward "\^M" end t)
3744 (delete-char -1)
3745 (insert "\^J"))))
3746 (set-buffer-modified-p mod-p)
3747 (setq selective-display nil)))))
3751 ;; The next two are modified versions from emerge.el.
3752 ;; VARS must be a list of symbols
3753 ;; ediff-save-variables returns an association list: ((var . val) ...)
3754 (defsubst ediff-save-variables (vars)
3755 (mapcar (lambda (v) (cons v (symbol-value v)))
3756 vars))
3757 ;; VARS is a list of variable symbols.
3758 (defun ediff-restore-variables (vars assoc-list)
3759 (while vars
3760 (set (car vars) (cdr (assoc (car vars) assoc-list)))
3761 (setq vars (cdr vars))))
3763 (defun ediff-change-saved-variable (var value buf-type)
3764 (let* ((assoc-list
3765 (symbol-value (ediff-get-symbol-from-alist
3766 buf-type
3767 ediff-buffer-values-orig-alist)))
3768 (assoc-elt (assoc var assoc-list)))
3769 (if assoc-elt
3770 (setcdr assoc-elt value))))
3773 ;; must execute in control buf
3774 (defun ediff-save-protected-variables ()
3775 (setq ediff-buffer-values-orig-A
3776 (ediff-with-current-buffer ediff-buffer-A
3777 (ediff-save-variables ediff-protected-variables)))
3778 (setq ediff-buffer-values-orig-B
3779 (ediff-with-current-buffer ediff-buffer-B
3780 (ediff-save-variables ediff-protected-variables)))
3781 (if ediff-3way-comparison-job
3782 (setq ediff-buffer-values-orig-C
3783 (ediff-with-current-buffer ediff-buffer-C
3784 (ediff-save-variables ediff-protected-variables))))
3785 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3786 (setq ediff-buffer-values-orig-Ancestor
3787 (ediff-with-current-buffer ediff-ancestor-buffer
3788 (ediff-save-variables ediff-protected-variables)))))
3790 ;; must execute in control buf
3791 (defun ediff-restore-protected-variables ()
3792 (let ((values-A ediff-buffer-values-orig-A)
3793 (values-B ediff-buffer-values-orig-B)
3794 (values-C ediff-buffer-values-orig-C)
3795 (values-Ancestor ediff-buffer-values-orig-Ancestor))
3796 (ediff-with-current-buffer ediff-buffer-A
3797 (ediff-restore-variables ediff-protected-variables values-A))
3798 (ediff-with-current-buffer ediff-buffer-B
3799 (ediff-restore-variables ediff-protected-variables values-B))
3800 (if ediff-3way-comparison-job
3801 (ediff-with-current-buffer ediff-buffer-C
3802 (ediff-restore-variables ediff-protected-variables values-C)))
3803 (if (ediff-buffer-live-p ediff-ancestor-buffer)
3804 (ediff-with-current-buffer ediff-ancestor-buffer
3805 (ediff-restore-variables ediff-protected-variables values-Ancestor)))
3808 ;; save BUFFER in FILE. used in hooks.
3809 (defun ediff-save-buffer-in-file (buffer file)
3810 (ediff-with-current-buffer buffer
3811 (write-file file)))
3814 ;;; Debug
3816 (ediff-defvar-local ediff-command-begin-time '(0 0 0) "")
3818 ;; calculate time used by command
3819 (defun ediff-calc-command-time ()
3820 (let ((end (current-time))
3821 micro sec)
3822 (setq micro
3823 (if (>= (nth 2 end) (nth 2 ediff-command-begin-time))
3824 (- (nth 2 end) (nth 2 ediff-command-begin-time))
3825 (+ (nth 2 end) (- 1000000 (nth 2 ediff-command-begin-time)))))
3826 (setq sec (- (nth 1 end) (nth 1 ediff-command-begin-time)))
3827 (or (equal ediff-command-begin-time '(0 0 0))
3828 (message "Elapsed time: %d second(s) + %d microsecond(s)" sec micro))))
3830 (defsubst ediff-save-time ()
3831 (setq ediff-command-begin-time (current-time)))
3833 (defun ediff-profile ()
3834 "Toggle profiling Ediff commands."
3835 (interactive)
3836 (ediff-barf-if-not-control-buffer)
3837 (make-local-hook 'post-command-hook)
3838 (let ((pre-hook 'pre-command-hook)
3839 (post-hook 'post-command-hook))
3840 (if (not (equal ediff-command-begin-time '(0 0 0)))
3841 (progn (remove-hook pre-hook 'ediff-save-time)
3842 (remove-hook post-hook 'ediff-calc-command-time)
3843 (setq ediff-command-begin-time '(0 0 0))
3844 (message "Ediff profiling disabled"))
3845 (add-hook pre-hook 'ediff-save-time t t)
3846 (add-hook post-hook 'ediff-calc-command-time nil t)
3847 (message "Ediff profiling enabled"))))
3849 (defun ediff-print-diff-vector (diff-vector-var)
3850 (princ (format "\n*** %S ***\n" diff-vector-var))
3851 (mapcar (lambda (overl-vec)
3852 (princ
3853 (format
3854 "Diff %d: \tOverlay: %S
3855 \t\tFine diffs: %s
3856 \t\tNo-fine-diff-flag: %S
3857 \t\tState-of-diff:\t %S
3858 \t\tState-of-merge:\t %S
3860 (1+ (ediff-overlay-get (aref overl-vec 0) 'ediff-diff-num))
3861 (aref overl-vec 0)
3862 ;; fine-diff-vector
3863 (if (= (length (aref overl-vec 1)) 0)
3864 "none\n"
3865 (mapconcat 'prin1-to-string
3866 (aref overl-vec 1) "\n\t\t\t "))
3867 (aref overl-vec 2) ; no fine diff flag
3868 (aref overl-vec 3) ; state-of-diff
3869 (aref overl-vec 4) ; state-of-merge
3871 (eval diff-vector-var)))
3875 (defun ediff-debug-info ()
3876 (interactive)
3877 (ediff-barf-if-not-control-buffer)
3878 (with-output-to-temp-buffer ediff-debug-buffer
3879 (ediff-with-current-buffer standard-output
3880 (fundamental-mode))
3881 (princ (format "\nCtl buffer: %S\n" ediff-control-buffer))
3882 (ediff-print-diff-vector (intern "ediff-difference-vector-A"))
3883 (ediff-print-diff-vector (intern "ediff-difference-vector-B"))
3884 (ediff-print-diff-vector (intern "ediff-difference-vector-C"))
3885 (ediff-print-diff-vector (intern "ediff-difference-vector-Ancestor"))
3889 ;;; General utilities
3891 ;; this uses comparison-func to decide who is a member
3892 (defun ediff-member (elt lis comparison-func)
3893 (while (and lis (not (funcall comparison-func (car lis) elt)))
3894 (setq lis (cdr lis)))
3895 lis)
3897 ;; this uses comparison-func to decide who is a member, and this determines how
3898 ;; intersection looks like
3899 (defun ediff-intersection (lis1 lis2 comparison-func)
3900 (let ((result (list 'a)))
3901 (while lis1
3902 (if (ediff-member (car lis1) lis2 comparison-func)
3903 (nconc result (list (car lis1))))
3904 (setq lis1 (cdr lis1)))
3905 (cdr result)))
3908 ;; eliminates duplicates using comparison-func
3909 (defun ediff-union (lis1 lis2 comparison-func)
3910 (let ((result (list 'a)))
3911 (while lis1
3912 (or (ediff-member (car lis1) (cdr result) comparison-func)
3913 (nconc result (list (car lis1))))
3914 (setq lis1 (cdr lis1)))
3915 (while lis2
3916 (or (ediff-member (car lis2) (cdr result) comparison-func)
3917 (nconc result (list (car lis2))))
3918 (setq lis2 (cdr lis2)))
3919 (cdr result)))
3921 ;; eliminates duplicates using comparison-func
3922 (defun ediff-set-difference (lis1 lis2 comparison-func)
3923 (let ((result (list 'a)))
3924 (while lis1
3925 (or (ediff-member (car lis1) (cdr result) comparison-func)
3926 (ediff-member (car lis1) lis2 comparison-func)
3927 (nconc result (list (car lis1))))
3928 (setq lis1 (cdr lis1)))
3929 (cdr result)))
3931 (if (fboundp 'copy-sequence)
3932 (defalias 'ediff-copy-list 'copy-sequence)
3933 (defun ediff-copy-list (list)
3934 (if (consp list)
3935 ;;;(let ((res nil))
3936 ;;; (while (consp list) (push (pop list) res))
3937 ;;; (prog1 (nreverse res) (setcdr res list)))
3938 (let (res elt)
3939 (while (consp list)
3940 (setq elt (car list)
3941 res (cons elt res)
3942 list (cdr list)))
3943 (nreverse res))
3944 (car list))))
3947 ;; don't report error if version control package wasn't found
3948 ;;(ediff-load-version-control 'silent)
3950 (run-hooks 'ediff-load-hook)
3953 ;;; Local Variables:
3954 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
3955 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
3956 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
3957 ;;; End:
3959 ;;; ediff-util.el ends here