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