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