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