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