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