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