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