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