1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
32 (defvar icon-title-format
)
33 (defvar top-toolbar-height
)
34 (defvar bottom-toolbar-height
)
35 (defvar left-toolbar-height
)
36 (defvar right-toolbar-height
)
37 (defvar left-toolbar-width
)
38 (defvar right-toolbar-width
)
39 (defvar default-menubar
)
41 (defvar frame-icon-title-format
)
42 (defvar ediff-diff-status
)
43 (defvar ediff-emacs-p
)
46 (let ((load-path (cons (expand-file-name ".") load-path
)))
47 (or (featurep 'ediff-init
)
48 (load "ediff-init.el" nil nil
'nosuffix
))
49 (or (featurep 'ediff-util
)
50 (load "ediff-util.el" nil nil
'nosuffix
))
51 (or (featurep 'ediff-help
)
52 (load "ediff-help.el" nil nil
'nosuffix
))
53 (or (featurep 'ediff-tbar
)
55 (load "ediff-tbar.el" 'noerror nil
'nosuffix
))
61 ;; be careful with ediff-tbar
66 (defun ediff-compute-toolbar-width () 0)))
67 (defun ediff-compute-toolbar-width () 0))
69 (defgroup ediff-window nil
70 "Ediff window manipulation."
76 (defcustom ediff-window-setup-function
(if (ediff-window-display-p)
77 'ediff-setup-windows-multiframe
78 'ediff-setup-windows-plain
)
79 "*Function called to set up windows.
80 Ediff provides a choice of two functions: `ediff-setup-windows-plain', for
81 doing everything in one frame, and `ediff-setup-windows-multiframe',
82 which sets the control panel in a separate frame. Also, if the latter
83 function detects that one of the buffers A/B is seen in some other frame,
84 it will try to keep that buffer in that frame.
86 If you don't like the two functions provided---write your own one.
88 1. It should leave the control buffer current and the control window
90 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
91 and `ediff-control-window' to contain window objects that display
92 the corresponding buffers.
93 3. It should accept the following arguments:
94 buffer-A, buffer-B, buffer-C, control-buffer
95 Buffer C may not be used in jobs that compare only two buffers.
96 If you plan to do something fancy, take a close look at how the two
97 provided functions are written."
98 :type
'(choice (const :tag
"Multi Frame" ediff-setup-windows-multiframe
)
99 (const :tag
"Single Frame" ediff-setup-windows-plain
)
100 (function :tag
"Other function"))
101 :group
'ediff-window
)
103 ;; indicates if we are in a multiframe setup
104 (ediff-defvar-local ediff-multiframe nil
"")
106 ;; Share of the frame occupied by the merge window (buffer C)
107 (ediff-defvar-local ediff-merge-window-share
0.45 "")
109 ;; The control window.
110 (ediff-defvar-local ediff-control-window nil
"")
111 ;; Official window for buffer A
112 (ediff-defvar-local ediff-window-A nil
"")
113 ;; Official window for buffer B
114 (ediff-defvar-local ediff-window-B nil
"")
115 ;; Official window for buffer C
116 (ediff-defvar-local ediff-window-C nil
"")
117 ;; Ediff's window configuration.
118 ;; Used to minimize the need to rearrange windows.
119 (ediff-defvar-local ediff-window-config-saved
"" "")
121 ;; Association between buff-type and ediff-window-*
122 (defconst ediff-window-alist
123 '((A . ediff-window-A
)
124 (?A . ediff-window-A
)
126 (?B . ediff-window-B
)
128 (?C . ediff-window-C
)))
131 (defcustom ediff-split-window-function
'split-window-vertically
132 "*The function used to split the main window between buffer-A and buffer-B.
133 You can set it to a horizontal split instead of the default vertical split
134 by setting this variable to `split-window-horizontally'.
135 You can also have your own function to do fancy splits.
136 This variable has no effect when buffer-A/B are shown in different frames.
137 In this case, Ediff will use those frames to display these buffers."
139 :group
'ediff-window
)
141 (defcustom ediff-merge-split-window-function
'split-window-horizontally
142 "*The function used to split the main window between buffer-A and buffer-B.
143 You can set it to a vertical split instead of the default horizontal split
144 by setting this variable to `split-window-vertically'.
145 You can also have your own function to do fancy splits.
146 This variable has no effect when buffer-A/B/C are shown in different frames.
147 In this case, Ediff will use those frames to display these buffers."
149 :group
'ediff-window
)
151 (defconst ediff-control-frame-parameters
154 ;;'(unsplittable . t)
156 '(user-position . t
) ; Emacs only
157 '(vertical-scroll-bars . nil
) ; Emacs only
158 '(scrollbar-width .
0) ; XEmacs only
159 '(scrollbar-height .
0) ; XEmacs only
160 '(menu-bar-lines .
0) ; Emacs only
161 '(tool-bar-lines .
0) ; Emacs 21+ only
162 ;; don't lower but auto-raise
166 ;; make initial frame small to avoid distraction
167 '(width .
1) '(height .
1)
168 ;; this blocks queries from window manager as to where to put
169 ;; ediff's control frame. we put the frame outside the display,
170 ;; so the initial frame won't jump all over the screen
171 (cons 'top
(if (fboundp 'ediff-display-pixel-height
)
172 (1+ (ediff-display-pixel-height))
174 (cons 'left
(if (fboundp 'ediff-display-pixel-width
)
175 (1+ (ediff-display-pixel-width))
178 "Frame parameters for displaying Ediff Control Panel.
179 Used internally---not a user option.")
181 ;; position of the mouse; used to decide whether to warp the mouse into ctl
183 (ediff-defvar-local ediff-mouse-pixel-position nil
"")
186 (defvar ediff-mouse-pixel-threshold
30
187 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
189 (defcustom ediff-grab-mouse t
190 "*If t, Ediff will always grab the mouse and put it in the control frame.
191 If 'maybe, Ediff will do it sometimes, but not after operations that require
192 relatively long time. If nil, the mouse will be entirely user's
195 :group
'ediff-window
)
197 (defcustom ediff-control-frame-position-function
'ediff-make-frame-position
198 "Function to call to determine the desired location for the control panel.
199 Expects three parameters: the control buffer, the desired width and height
200 of the control frame. It returns an association list
201 of the form \(\(top . <position>\) \(left . <position>\)\)"
203 :group
'ediff-window
)
205 (defcustom ediff-control-frame-upward-shift
42
206 "*The upward shift of control frame from the top of buffer A's frame.
208 This is used by the default control frame positioning function,
209 `ediff-make-frame-position'. This variable is provided for easy
210 customization of the default control frame positioning."
212 :group
'ediff-window
)
214 (defcustom ediff-narrow-control-frame-leftward-shift
(if ediff-xemacs-p
7 3)
215 "*The leftward shift of control frame from the right edge of buf A's frame.
216 Measured in characters.
217 This is used by the default control frame positioning function,
218 `ediff-make-frame-position' to adjust the position of the control frame
219 when it shows the short menu. This variable is provided for easy
220 customization of the default."
222 :group
'ediff-window
)
224 (defcustom ediff-wide-control-frame-rightward-shift
7
225 "*The rightward shift of control frame from the left edge of buf A's frame.
226 Measured in characters.
227 This is used by the default control frame positioning function,
228 `ediff-make-frame-position' to adjust the position of the control frame
229 when it shows the full menu. This variable is provided for easy
230 customization of the default."
232 :group
'ediff-window
)
235 ;; Wide frame display
237 ;; t means Ediff is using wide display
238 (ediff-defvar-local ediff-wide-display-p nil
"")
239 ;; keeps frame config for toggling wide display
240 (ediff-defvar-local ediff-wide-display-orig-parameters nil
241 "Frame parameters to be restored when the user wants to toggle the wide
243 (ediff-defvar-local ediff-wide-display-frame nil
244 "Frame to be used for wide display.")
245 (ediff-defvar-local ediff-make-wide-display-function
'ediff-make-wide-display
246 "The value is a function that is called to create a wide display.
247 The function is called without arguments. It should resize the frame in
248 which buffers A, B, and C are to be displayed, and it should save the old
249 frame parameters in `ediff-wide-display-orig-parameters'.
250 The variable `ediff-wide-display-frame' should be set to contain
251 the frame used for the wide display.")
253 ;; Frame used for the control panel in a windowing system.
254 (ediff-defvar-local ediff-control-frame nil
"")
256 (defcustom ediff-prefer-iconified-control-frame nil
257 "*If t, keep control panel iconified when help message is off.
258 This has effect only on a windowing system.
259 If t, hitting `?' to toggle control panel off iconifies it.
261 This is only useful in Emacs and only for certain kinds of window managers,
262 such as TWM and its derivatives, since the window manager must permit
263 keyboard input to go into icons. XEmacs completely ignores keyboard input
264 into icons, regardless of the window manager."
266 :group
'ediff-window
)
270 (defun ediff-get-window-by-clicking (wind prev-wind wind-number
)
273 "Select windows by clicking. Please click on Window %d " wind-number
)
274 (while (not (ediff-mouse-event-p (setq event
(ediff-read-event))))
275 (if (sit-for 1) ; if sequence of events, wait till the final word
277 (message "Please click on Window %d " wind-number
))
278 (ediff-read-event) ; discard event
279 (setq wind
(ediff-cond-compile-for-xemacs-or-emacs
280 (event-window event
) ; xemacs
281 (posn-window (event-start event
)) ; emacs
287 ;; Select the lowest window on the frame.
288 (defun ediff-select-lowest-window ()
289 (ediff-cond-compile-for-xemacs-or-emacs
290 (select-window (frame-lowest-window)) ; xemacs
292 (let* ((lowest-window (selected-window))
293 (bottom-edge (car (cdr (cdr (cdr (window-edges))))))
294 (last-window (save-excursion
295 (other-window -
1) (selected-window)))
298 (let* ((this-window (next-window))
300 (car (cdr (cdr (cdr (window-edges this-window
)))))))
301 (if (< bottom-edge next-bottom-edge
)
303 (setq bottom-edge next-bottom-edge
)
304 (setq lowest-window this-window
)))
306 (select-window this-window
)
307 (if (eq last-window this-window
)
309 (select-window lowest-window
)
310 (setq window-search nil
))))))
314 ;;; Common window setup routines
316 ;; Set up the window configuration. If POS is given, set the points to
317 ;; the beginnings of the buffers.
318 ;; When 3way comparison is added, this will have to choose the appropriate
319 ;; setup function based on ediff-job-name
320 (defun ediff-setup-windows (buffer-A buffer-B buffer-C control-buffer
)
321 ;; Make sure we are not in the minibuffer window when we try to delete
322 ;; all other windows.
323 (run-hooks 'ediff-before-setup-windows-hook
)
324 (if (eq (selected-window) (minibuffer-window))
327 ;; in case user did a no-no on a tty
328 (or (ediff-window-display-p)
329 (setq ediff-window-setup-function
'ediff-setup-windows-plain
))
331 (or (ediff-keep-window-config control-buffer
)
333 (ediff-with-current-buffer control-buffer ediff-window-setup-function
)
334 buffer-A buffer-B buffer-C control-buffer
))
335 (run-hooks 'ediff-after-setup-windows-hook
))
337 ;; Just set up 3 windows.
338 ;; Usually used without windowing systems
339 ;; With windowing, we want to use dedicated frames.
340 (defun ediff-setup-windows-plain (buffer-A buffer-B buffer-C control-buffer
)
341 (ediff-with-current-buffer control-buffer
342 (setq ediff-multiframe nil
))
344 (ediff-setup-windows-plain-merge
345 buffer-A buffer-B buffer-C control-buffer
)
346 (ediff-setup-windows-plain-compare
347 buffer-A buffer-B buffer-C control-buffer
)))
349 (defun ediff-setup-windows-plain-merge (buf-A buf-B buf-C control-buffer
)
350 ;; skip dedicated and unsplittable frames
351 (ediff-destroy-control-frame control-buffer
)
352 (let ((window-min-height 1)
353 split-window-function
354 merge-window-share merge-window-lines
355 wind-A wind-B wind-C
)
356 (ediff-with-current-buffer control-buffer
357 (setq merge-window-share ediff-merge-window-share
358 ;; this lets us have local versions of ediff-split-window-function
359 split-window-function ediff-split-window-function
))
360 (delete-other-windows)
361 (split-window-vertically)
362 (ediff-select-lowest-window)
363 (ediff-setup-control-buffer control-buffer
)
365 ;; go to the upper window and split it betw A, B, and possibly C
367 (setq merge-window-lines
368 (max 2 (round (* (window-height) merge-window-share
))))
369 (switch-to-buffer buf-A
)
370 (setq wind-A
(selected-window))
372 ;; XEmacs used to have a lot of trouble with display
373 ;; It did't set things right unless we tell it to sit still
375 ;;(if ediff-xemacs-p (sit-for 0))
377 (split-window-vertically (max 2 (- (window-height) merge-window-lines
)))
378 (if (eq (selected-window) wind-A
)
380 (setq wind-C
(selected-window))
381 (switch-to-buffer buf-C
)
383 (select-window wind-A
)
384 (funcall split-window-function
)
386 (if (eq (selected-window) wind-A
)
388 (switch-to-buffer buf-B
)
389 (setq wind-B
(selected-window))
391 (ediff-with-current-buffer control-buffer
392 (setq ediff-window-A wind-A
393 ediff-window-B wind-B
394 ediff-window-C wind-C
))
396 (ediff-select-lowest-window)
397 (ediff-setup-control-buffer control-buffer
)
401 ;; This function handles all comparison jobs, including 3way jobs
402 (defun ediff-setup-windows-plain-compare (buf-A buf-B buf-C control-buffer
)
403 ;; skip dedicated and unsplittable frames
404 (ediff-destroy-control-frame control-buffer
)
405 (let ((window-min-height 1)
406 split-window-function wind-width-or-height
408 wind-A-start wind-B-start wind-A wind-B wind-C
)
409 (ediff-with-current-buffer control-buffer
410 (setq wind-A-start
(ediff-overlay-start
411 (ediff-get-value-according-to-buffer-type
412 'A ediff-narrow-bounds
))
413 wind-B-start
(ediff-overlay-start
414 (ediff-get-value-according-to-buffer-type
415 'B ediff-narrow-bounds
))
416 ;; this lets us have local versions of ediff-split-window-function
417 split-window-function ediff-split-window-function
418 three-way-comparison ediff-3way-comparison-job
))
419 (delete-other-windows)
420 (split-window-vertically)
421 (ediff-select-lowest-window)
422 (ediff-setup-control-buffer control-buffer
)
424 ;; go to the upper window and split it betw A, B, and possibly C
426 (switch-to-buffer buf-A
)
427 (setq wind-A
(selected-window))
428 (if three-way-comparison
429 (setq wind-width-or-height
430 (/ (if (eq split-window-function
'split-window-vertically
)
431 (window-height wind-A
)
432 (window-width wind-A
))
435 ;; XEmacs used to have a lot of trouble with display
436 ;; It did't set things right unless we told it to sit still
438 ;;(if ediff-xemacs-p (sit-for 0))
440 (funcall split-window-function wind-width-or-height
)
442 (if (eq (selected-window) wind-A
)
444 (switch-to-buffer buf-B
)
445 (setq wind-B
(selected-window))
447 (if three-way-comparison
449 (funcall split-window-function
) ; equally
450 (if (eq (selected-window) wind-B
)
452 (switch-to-buffer buf-C
)
453 (setq wind-C
(selected-window))))
455 (ediff-with-current-buffer control-buffer
456 (setq ediff-window-A wind-A
457 ediff-window-B wind-B
458 ediff-window-C wind-C
))
460 ;; It is unlikely that we will want to implement 3way window comparison.
461 ;; So, only buffers A and B are used here.
462 (if ediff-windows-job
464 (set-window-start wind-A wind-A-start
)
465 (set-window-start wind-B wind-B-start
)))
467 (ediff-select-lowest-window)
468 (ediff-setup-control-buffer control-buffer
)
472 ;; dispatch an appropriate window setup function
473 (defun ediff-setup-windows-multiframe (buf-A buf-B buf-C control-buf
)
474 (ediff-with-current-buffer control-buf
475 (setq ediff-multiframe t
))
477 (ediff-setup-windows-multiframe-merge buf-A buf-B buf-C control-buf
)
478 (ediff-setup-windows-multiframe-compare buf-A buf-B buf-C control-buf
)))
480 (defun ediff-setup-windows-multiframe-merge (buf-A buf-B buf-C control-buf
)
482 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
483 ;;; destroy dedicated windows.
484 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
485 ;;; frame for A and B and use a separate frame for C.
486 ;;; 3. If C's frame is non-existent, then: if the first suitable
487 ;;; non-dedicated frame is different from A&B's, then use it for C.
488 ;;; Otherwise, put A,B, and C in one frame.
489 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
492 ;; Skip dedicated or iconified frames.
493 ;; Unsplittable frames are taken care of later.
494 (ediff-skip-unsuitable-frames 'ok-unsplittable
)
496 (let* ((window-min-height 1)
497 (wind-A (ediff-get-visible-buffer-window buf-A
))
498 (wind-B (ediff-get-visible-buffer-window buf-B
))
499 (wind-C (ediff-get-visible-buffer-window buf-C
))
500 (frame-A (if wind-A
(window-frame wind-A
)))
501 (frame-B (if wind-B
(window-frame wind-B
)))
502 (frame-C (if wind-C
(window-frame wind-C
)))
503 ;; on wide display, do things in one frame
505 (ediff-with-current-buffer control-buf ediff-wide-display-p
))
506 ;; this lets us have local versions of ediff-split-window-function
507 (split-window-function
508 (ediff-with-current-buffer control-buf ediff-split-window-function
))
509 (orig-wind (selected-window))
510 (orig-frame (selected-frame))
511 (use-same-frame (or force-one-frame
512 ;; A and C must be in one frame
513 (eq frame-A
(or frame-C orig-frame
))
514 ;; B and C must be in one frame
515 (eq frame-B
(or frame-C orig-frame
))
516 ;; A or B is not visible
517 (not (frame-live-p frame-A
))
518 (not (frame-live-p frame-B
))
519 ;; A or B is not suitable for display
520 (not (ediff-window-ok-for-display wind-A
))
521 (not (ediff-window-ok-for-display wind-B
))
522 ;; A and B in the same frame, and no good frame
524 (and (eq frame-A frame-B
)
525 (not (frame-live-p frame-C
)))
527 ;; use-same-frame-for-AB implies wind A and B are ok for display
528 (use-same-frame-for-AB (and (not use-same-frame
)
529 (eq frame-A frame-B
)))
530 (merge-window-share (ediff-with-current-buffer control-buf
531 ediff-merge-window-share
))
533 designated-minibuffer-frame
534 done-A done-B done-C
)
537 (if (and (window-live-p wind-A
)
538 (null use-same-frame
) ; implies wind-A is suitable
539 (null use-same-frame-for-AB
))
540 (progn ; bug A on its own
541 ;; buffer buf-A is seen in live wind-A
542 (select-window wind-A
)
543 (delete-other-windows)
544 (setq wind-A
(selected-window))
548 (if (and (window-live-p wind-B
)
549 (null use-same-frame
) ; implies wind-B is suitable
550 (null use-same-frame-for-AB
))
551 (progn ; buf B on its own
552 ;; buffer buf-B is seen in live wind-B
553 (select-window wind-B
)
554 (delete-other-windows)
555 (setq wind-B
(selected-window))
559 (if (and (window-live-p wind-C
)
560 (ediff-window-ok-for-display wind-C
)
561 (null use-same-frame
)) ; buf C on its own
563 ;; buffer buf-C is seen in live wind-C
564 (select-window wind-C
)
565 (delete-other-windows)
566 (setq wind-C
(selected-window))
569 (if (and use-same-frame-for-AB
; implies wind A and B are suitable
570 (window-live-p wind-A
))
572 ;; wind-A must already be displaying buf-A
573 (select-window wind-A
)
574 (delete-other-windows)
575 (setq wind-A
(selected-window))
577 (funcall split-window-function
)
578 (if (eq (selected-window) wind-A
)
580 (switch-to-buffer buf-B
)
581 (setq wind-B
(selected-window))
587 (let ((window-min-height 1))
588 (if (and (eq frame-A frame-B
)
590 (frame-live-p frame-A
))
591 (select-frame frame-A
)
592 ;; avoid dedicated and non-splittable windows
593 (ediff-skip-unsuitable-frames))
594 (delete-other-windows)
595 (setq merge-window-lines
596 (max 2 (round (* (window-height) merge-window-share
))))
597 (switch-to-buffer buf-A
)
598 (setq wind-A
(selected-window))
600 (split-window-vertically
601 (max 2 (- (window-height) merge-window-lines
)))
602 (if (eq (selected-window) wind-A
)
604 (setq wind-C
(selected-window))
605 (switch-to-buffer buf-C
)
607 (select-window wind-A
)
609 (funcall split-window-function
)
610 (if (eq (selected-window) wind-A
)
612 (switch-to-buffer buf-B
)
613 (setq wind-B
(selected-window))
620 (or done-A
; Buf A to be set in its own frame,
621 ;;; or it was set before because use-same-frame = 1
623 ;; Buf-A was not set up yet as it wasn't visible,
624 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
625 (select-window orig-wind
)
626 (delete-other-windows)
627 (switch-to-buffer buf-A
)
628 (setq wind-A
(selected-window))
630 (or done-B
; Buf B to be set in its own frame,
631 ;;; or it was set before because use-same-frame = 1
633 ;; Buf-B was not set up yet as it wasn't visible
634 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
635 (select-window orig-wind
)
636 (delete-other-windows)
637 (switch-to-buffer buf-B
)
638 (setq wind-B
(selected-window))
641 (or done-C
; Buf C to be set in its own frame,
642 ;;; or it was set before because use-same-frame = 1
644 ;; Buf-C was not set up yet as it wasn't visible
645 ;; and use-same-frame = nil
646 (select-window orig-wind
)
647 (delete-other-windows)
648 (switch-to-buffer buf-C
)
649 (setq wind-C
(selected-window))
652 (ediff-with-current-buffer control-buf
653 (setq ediff-window-A wind-A
654 ediff-window-B wind-B
655 ediff-window-C wind-C
)
656 (setq frame-A
(window-frame ediff-window-A
)
657 designated-minibuffer-frame
658 (window-frame (minibuffer-window frame-A
))))
660 (ediff-setup-control-frame control-buf designated-minibuffer-frame
)
664 ;; Window setup for all comparison jobs, including 3way comparisons
665 (defun ediff-setup-windows-multiframe-compare (buf-A buf-B buf-C control-buf
)
667 ;;; If a buffer is seen in a frame, use that frame for that buffer.
668 ;;; If it is not seen, use the current frame.
669 ;;; If both buffers are not seen, they share the current frame. If one
670 ;;; of the buffers is not seen, it is placed in the current frame (where
671 ;;; ediff started). If that frame is displaying the other buffer, it is
672 ;;; shared between the two buffers.
673 ;;; However, if we decide to put both buffers in one frame
674 ;;; and the selected frame isn't splittable, we create a new frame and
675 ;;; put both buffers there, event if one of this buffers is visible in
678 ;; Skip dedicated or iconified frames.
679 ;; Unsplittable frames are taken care of later.
680 (ediff-skip-unsuitable-frames 'ok-unsplittable
)
682 (let* ((window-min-height 1)
683 (wind-A (ediff-get-visible-buffer-window buf-A
))
684 (wind-B (ediff-get-visible-buffer-window buf-B
))
685 (wind-C (ediff-get-visible-buffer-window buf-C
))
686 (frame-A (if wind-A
(window-frame wind-A
)))
687 (frame-B (if wind-B
(window-frame wind-B
)))
688 (frame-C (if wind-C
(window-frame wind-C
)))
689 (ctl-frame-exists-p (ediff-with-current-buffer control-buf
690 (frame-live-p ediff-control-frame
)))
691 ;; on wide display, do things in one frame
693 (ediff-with-current-buffer control-buf ediff-wide-display-p
))
694 ;; this lets us have local versions of ediff-split-window-function
695 (split-window-function
696 (ediff-with-current-buffer control-buf ediff-split-window-function
))
697 (three-way-comparison
698 (ediff-with-current-buffer control-buf ediff-3way-comparison-job
))
699 (orig-wind (selected-window))
700 (use-same-frame (or force-one-frame
702 (not (ediff-window-ok-for-display wind-A
))
703 (not (ediff-window-ok-for-display wind-B
))
704 (if three-way-comparison
705 (or (eq frame-A frame-C
)
707 (not (ediff-window-ok-for-display wind-C
))
708 (not (frame-live-p frame-A
))
709 (not (frame-live-p frame-B
))
710 (not (frame-live-p frame-C
))))
711 (and (not (frame-live-p frame-B
))
712 (or ctl-frame-exists-p
713 (eq frame-A
(selected-frame))))
714 (and (not (frame-live-p frame-A
))
715 (or ctl-frame-exists-p
716 (eq frame-B
(selected-frame))))))
717 wind-A-start wind-B-start
718 designated-minibuffer-frame
719 done-A done-B done-C
)
721 (ediff-with-current-buffer control-buf
722 (setq wind-A-start
(ediff-overlay-start
723 (ediff-get-value-according-to-buffer-type
724 'A ediff-narrow-bounds
))
725 wind-B-start
(ediff-overlay-start
726 (ediff-get-value-according-to-buffer-type
727 'B ediff-narrow-bounds
))))
729 (if (and (window-live-p wind-A
) (null use-same-frame
)) ; buf-A on its own
731 ;; buffer buf-A is seen in live wind-A
732 (select-window wind-A
) ; must be displaying buf-A
733 (delete-other-windows)
734 (setq wind-A
(selected-window))
737 (if (and (window-live-p wind-B
) (null use-same-frame
)) ; buf B on its own
739 ;; buffer buf-B is seen in live wind-B
740 (select-window wind-B
) ; must be displaying buf-B
741 (delete-other-windows)
742 (setq wind-B
(selected-window))
745 (if (and (window-live-p wind-C
) (null use-same-frame
)) ; buf C on its own
747 ;; buffer buf-C is seen in live wind-C
748 (select-window wind-C
) ; must be displaying buf-C
749 (delete-other-windows)
750 (setq wind-C
(selected-window))
754 (let (wind-width-or-height) ; this affects 3way setups only
755 (if (and (eq frame-A frame-B
) (frame-live-p frame-A
))
756 (select-frame frame-A
)
757 ;; avoid dedicated and non-splittable windows
758 (ediff-skip-unsuitable-frames))
759 (delete-other-windows)
760 (switch-to-buffer buf-A
)
761 (setq wind-A
(selected-window))
763 (if three-way-comparison
764 (setq wind-width-or-height
766 (if (eq split-window-function
'split-window-vertically
)
767 (window-height wind-A
)
768 (window-width wind-A
))
771 (funcall split-window-function wind-width-or-height
)
772 (if (eq (selected-window) wind-A
)
774 (switch-to-buffer buf-B
)
775 (setq wind-B
(selected-window))
777 (if three-way-comparison
779 (funcall split-window-function
) ; equally
780 (if (memq (selected-window) (list wind-A wind-B
))
782 (switch-to-buffer buf-C
)
783 (setq wind-C
(selected-window))))
789 (or done-A
; Buf A to be set in its own frame
790 ;;; or it was set before because use-same-frame = 1
792 ;; Buf-A was not set up yet as it wasn't visible,
793 ;; and use-same-frame = nil
794 (select-window orig-wind
)
795 (delete-other-windows)
796 (switch-to-buffer buf-A
)
797 (setq wind-A
(selected-window))
799 (or done-B
; Buf B to be set in its own frame
800 ;;; or it was set before because use-same-frame = 1
802 ;; Buf-B was not set up yet as it wasn't visible,
803 ;; and use-same-frame = nil
804 (select-window orig-wind
)
805 (delete-other-windows)
806 (switch-to-buffer buf-B
)
807 (setq wind-B
(selected-window))
810 (if three-way-comparison
811 (or done-C
; Buf C to be set in its own frame
812 ;;; or it was set before because use-same-frame = 1
814 ;; Buf-C was not set up yet as it wasn't visible,
815 ;; and use-same-frame = nil
816 (select-window orig-wind
)
817 (delete-other-windows)
818 (switch-to-buffer buf-C
)
819 (setq wind-C
(selected-window))
822 (ediff-with-current-buffer control-buf
823 (setq ediff-window-A wind-A
824 ediff-window-B wind-B
825 ediff-window-C wind-C
)
827 (setq frame-A
(window-frame ediff-window-A
)
828 designated-minibuffer-frame
829 (window-frame (minibuffer-window frame-A
))))
831 ;; It is unlikely that we'll implement a version of ediff-windows that
832 ;; would compare 3 windows at once. So, we don't use buffer C here.
833 (if ediff-windows-job
835 (set-window-start wind-A wind-A-start
)
836 (set-window-start wind-B wind-B-start
)))
838 (ediff-setup-control-frame control-buf designated-minibuffer-frame
)
841 ;; skip unsplittable frames and frames that have dedicated windows.
842 ;; create a new splittable frame if none is found
843 (defun ediff-skip-unsuitable-frames (&optional ok-unsplittable
)
844 (if (ediff-window-display-p)
845 (let ((wind-frame (window-frame (selected-window)))
847 (while (and (not (memq (selected-window) seen-windows
))
849 (ediff-frame-has-dedicated-windows wind-frame
)
850 (ediff-frame-iconified-p wind-frame
)
851 ;; skip small windows
852 (< (frame-height wind-frame
)
853 (* 3 window-min-height
))
856 (ediff-frame-unsplittable-p wind-frame
))))
858 (setq seen-windows
(cons (selected-window) seen-windows
))
861 (setq wind-frame
(window-frame (selected-window)))
863 (if (memq (selected-window) seen-windows
)
864 ;; fed up, no appropriate frames
865 (setq wind-frame
(make-frame '((unsplittable)))))
867 (select-frame wind-frame
)
870 (defun ediff-frame-has-dedicated-windows (frame)
873 (lambda (wind) (if (window-dedicated-p wind
)
879 ;; window is ok, if it is only one window on the frame, not counting the
880 ;; minibuffer, or none of the frame's windows is dedicated.
881 ;; The idea is that it is bad to destroy dedicated windows while creating an
882 ;; ediff window setup
883 (defun ediff-window-ok-for-display (wind)
888 (eq wind
(next-window wind
'ignore-minibuffer
(window-frame wind
)))
890 (not (ediff-frame-has-dedicated-windows (window-frame wind
)))
893 ;; Prepare or refresh control frame
894 (defun ediff-setup-control-frame (ctl-buffer designated-minibuffer-frame
)
895 (let ((window-min-height 1)
896 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
897 ctl-frame old-ctl-frame lines
898 ;; user-grabbed-mouse
899 fheight fwidth adjusted-parameters
)
901 (ediff-with-current-buffer ctl-buffer
902 (ediff-cond-compile-for-xemacs-or-emacs
903 (when (featurep 'menubar
) (set-buffer-menubar nil
)) ; xemacs
906 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
907 (run-hooks 'ediff-before-setup-control-frame-hook
))
909 (setq old-ctl-frame
(ediff-with-current-buffer ctl-buffer ediff-control-frame
))
910 (ediff-with-current-buffer ctl-buffer
911 (setq ctl-frame
(if (frame-live-p old-ctl-frame
)
913 (make-frame ediff-control-frame-parameters
))
914 ediff-control-frame ctl-frame
)
915 ;; protect against undefined face-attribute
917 (ediff-cond-compile-for-xemacs-or-emacs
919 (when (face-attribute 'mode-line
:box
)
920 (set-face-attribute 'mode-line ctl-frame
:box nil
))
925 (setq ctl-frame-iconified-p
(ediff-frame-iconified-p ctl-frame
))
926 (select-frame ctl-frame
)
927 (if (window-dedicated-p (selected-window))
929 (delete-other-windows)
930 (switch-to-buffer ctl-buffer
))
932 ;; must be before ediff-setup-control-buffer
933 ;; just a precaution--we should be in ctl-buffer already
934 (ediff-with-current-buffer ctl-buffer
935 (make-local-variable 'frame-title-format
)
936 (make-local-variable 'frame-icon-title-format
) ; XEmacs
937 (make-local-variable 'icon-title-format
)) ; Emacs
939 (ediff-setup-control-buffer ctl-buffer
)
940 (setq dont-iconify-ctl-frame
941 (not (string= ediff-help-message ediff-brief-help-message
)))
942 (setq deiconify-ctl-frame
943 (and (eq this-command
'ediff-toggle-help
)
944 dont-iconify-ctl-frame
))
946 ;; 1 more line for the modeline
947 (setq lines
(1+ (count-lines (point-min) (point-max)))
949 fwidth
(max (+ (ediff-help-message-line-length) 2)
950 (ediff-compute-toolbar-width))
953 ;; possibly change surrogate minibuffer
956 designated-minibuffer-frame
))
958 (cons 'height fheight
))
962 (setq adjusted-parameters
963 (cons (if ediff-use-long-help-message
966 adjusted-parameters
))
968 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
970 (if (ediff-has-toolbar-support-p)
971 (ediff-cond-compile-for-xemacs-or-emacs
973 (if (ediff-has-gutter-support-p)
974 (set-specifier top-gutter
(list ctl-frame nil
)))
976 (set-specifier top-toolbar-height
(list ctl-frame
0))
977 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
978 (set-specifier left-toolbar-width
(list ctl-frame
0))
979 (set-specifier right-toolbar-width
(list ctl-frame
0))
985 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
986 ;; to make sure that at least once we do it for non-iconified frame. If
987 ;; appears that in the OS/2 port of Emacs, one can't modify frame
988 ;; parameters of iconified frames. As a precaution, we do likewise for
990 (if (memq system-type
'(emx windows-nt windows-95
))
991 (modify-frame-parameters ctl-frame adjusted-parameters
))
993 ;; make or zap toolbar (if not requested)
994 (ediff-make-bottom-toolbar ctl-frame
)
996 (goto-char (point-min))
998 (modify-frame-parameters ctl-frame adjusted-parameters
)
999 (make-frame-visible ctl-frame
)
1001 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1002 ;; iconified, the current buffer changes to that of the frame that
1003 ;; becomes exposed as a result of this iconification.
1004 ;; So, we make sure the current buffer doesn't change.
1005 (select-frame ctl-frame
)
1006 (ediff-refresh-control-frame)
1008 (cond ((and ediff-prefer-iconified-control-frame
1009 (not ctl-frame-iconified-p
) (not dont-iconify-ctl-frame
))
1010 (iconify-frame ctl-frame
))
1011 ((or deiconify-ctl-frame
(not ctl-frame-iconified-p
))
1012 (raise-frame ctl-frame
)))
1014 (set-window-dedicated-p (selected-window) t
)
1016 ;; Now move the frame. We must do it separately due to an obscure bug in
1018 (modify-frame-parameters
1020 (funcall ediff-control-frame-position-function ctl-buffer fwidth fheight
))
1022 ;; synchronize so the cursor will move to control frame
1023 ;; per RMS suggestion
1024 (if (ediff-window-display-p)
1027 (while (and (not (frame-visible-p ctl-frame
)) (> count
0))
1028 (setq count
(1- count
))
1031 (or (ediff-frame-iconified-p ctl-frame
)
1032 ;; don't warp the mouse, unless ediff-grab-mouse = t
1033 (ediff-reset-mouse ctl-frame
1034 (or (eq this-command
'ediff-quit
)
1035 (not (eq ediff-grab-mouse t
)))))
1038 (ediff-with-current-buffer ctl-buffer
1039 (ediff-cond-compile-for-xemacs-or-emacs
1040 (make-local-hook 'select-frame-hook
) ; xemacs
1044 'select-frame-hook
'ediff-xemacs-select-frame-hook nil
'local
)
1047 (ediff-with-current-buffer ctl-buffer
1048 (run-hooks 'ediff-after-setup-control-frame-hook
))
1052 (defun ediff-destroy-control-frame (ctl-buffer)
1053 (ediff-with-current-buffer ctl-buffer
1054 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame
))
1055 (let ((ctl-frame ediff-control-frame
))
1056 (ediff-cond-compile-for-xemacs-or-emacs
1057 (when (featurep 'menubar
)
1058 (set-buffer-menubar default-menubar
)) ; xemacs
1061 (setq ediff-control-frame nil
)
1062 (delete-frame ctl-frame
)
1064 (ediff-skip-unsuitable-frames)
1065 ;;(ediff-reset-mouse nil)
1069 ;; finds a good place to clip control frame
1070 (defun ediff-make-frame-position (ctl-buffer ctl-frame-width ctl-frame-height
)
1071 (ediff-with-current-buffer ctl-buffer
1072 (let* ((frame-A (window-frame ediff-window-A
))
1073 (frame-A-parameters (frame-parameters frame-A
))
1074 (frame-A-top (eval (cdr (assoc 'top frame-A-parameters
))))
1075 (frame-A-left (eval (cdr (assoc 'left frame-A-parameters
))))
1076 (frame-A-width (frame-width frame-A
))
1077 (ctl-frame ediff-control-frame
)
1078 horizontal-adjustment upward-adjustment
1079 ctl-frame-top ctl-frame-left
)
1081 ;; Multiple control frames are clipped based on the value of
1082 ;; ediff-control-buffer-number. This is done in order not to obscure
1083 ;; other active control panels.
1084 (setq horizontal-adjustment
(* 2 ediff-control-buffer-number
)
1085 upward-adjustment
(* -
14 ediff-control-buffer-number
))
1088 (- frame-A-top upward-adjustment ediff-control-frame-upward-shift
)
1091 (if ediff-use-long-help-message
1092 (* (ediff-frame-char-width ctl-frame
)
1093 (+ ediff-wide-control-frame-rightward-shift
1094 horizontal-adjustment
))
1095 (- (* frame-A-width
(ediff-frame-char-width frame-A
))
1096 (* (ediff-frame-char-width ctl-frame
)
1098 ediff-narrow-control-frame-leftward-shift
1099 horizontal-adjustment
))))))
1102 (- (ediff-display-pixel-height)
1103 (* 2 ctl-frame-height
1104 (ediff-frame-char-height ctl-frame
))))
1107 (- (ediff-display-pixel-width)
1108 (* ctl-frame-width
(ediff-frame-char-width ctl-frame
)))))
1109 ;; keep ctl frame within the visible bounds
1110 (setq ctl-frame-top
(max ctl-frame-top
1)
1111 ctl-frame-left
(max ctl-frame-left
1))
1113 (list (cons 'top ctl-frame-top
)
1114 (cons 'left ctl-frame-left
))
1117 (defun ediff-xemacs-select-frame-hook ()
1118 (if (and (equal (selected-frame) ediff-control-frame
)
1119 (not ediff-use-long-help-message
))
1120 (raise-frame ediff-control-frame
)))
1122 (defun ediff-make-wide-display ()
1123 "Construct an alist of parameters for the wide display.
1124 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1125 The frame to be resized is kept in `ediff-wide-display-frame'.
1126 This function modifies only the left margin and the width of the display.
1127 It assumes that it is called from within the control buffer."
1128 (if (not (fboundp 'ediff-display-pixel-width
))
1129 (error "Can't determine display width"))
1130 (let* ((frame-A (window-frame ediff-window-A
))
1131 (frame-A-params (frame-parameters frame-A
))
1132 (cw (ediff-frame-char-width frame-A
))
1133 (wd (- (/ (ediff-display-pixel-width) cw
) 5)))
1134 (setq ediff-wide-display-orig-parameters
1135 (list (cons 'left
(max 0 (eval (cdr (assoc 'left frame-A-params
)))))
1136 (cons 'width
(cdr (assoc 'width frame-A-params
))))
1137 ediff-wide-display-frame frame-A
)
1138 (modify-frame-parameters frame-A
(list (cons 'left cw
)
1139 (cons 'width wd
)))))
1143 ;; Revise the mode line to display which difference we have selected
1144 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1145 ;; anothe invocations of Ediff.
1146 (defun ediff-refresh-mode-lines ()
1147 (let (buf-A-state-diff buf-B-state-diff buf-C-state-diff buf-C-state-merge
)
1149 (if (ediff-valid-difference-p)
1151 buf-C-state-diff
(ediff-get-state-of-diff ediff-current-difference
'C
)
1152 buf-C-state-merge
(ediff-get-state-of-merge ediff-current-difference
)
1153 buf-A-state-diff
(ediff-get-state-of-diff ediff-current-difference
'A
)
1154 buf-B-state-diff
(ediff-get-state-of-diff ediff-current-difference
'B
)
1155 buf-A-state-diff
(if buf-A-state-diff
1156 (format "[%s] " buf-A-state-diff
)
1158 buf-B-state-diff
(if buf-B-state-diff
1159 (format "[%s] " buf-B-state-diff
)
1161 buf-C-state-diff
(if (and (ediff-buffer-live-p ediff-buffer-C
)
1162 (or buf-C-state-diff buf-C-state-merge
))
1164 (or buf-C-state-diff
"")
1165 (if buf-C-state-merge
1166 (concat " " buf-C-state-merge
)
1168 (if (ediff-get-state-of-ancestor
1169 ediff-current-difference
)
1174 (setq buf-A-state-diff
""
1176 buf-C-state-diff
""))
1178 ;; control buffer format
1179 (setq mode-line-format
1180 (if (ediff-narrow-control-frame-p)
1181 (list " " mode-line-buffer-identification
)
1182 (list "-- " mode-line-buffer-identification
" Quick Help")))
1183 ;; control buffer id
1184 (setq mode-line-buffer-identification
1185 (if (ediff-narrow-control-frame-p)
1186 (ediff-make-narrow-control-buffer-id 'skip-name
)
1187 (ediff-make-wide-control-buffer-id)))
1188 ;; Force mode-line redisplay
1189 (force-mode-line-update)
1191 (if (and (ediff-window-display-p) (frame-live-p ediff-control-frame
))
1192 (ediff-refresh-control-frame))
1194 (ediff-with-current-buffer ediff-buffer-A
1195 (setq ediff-diff-status buf-A-state-diff
)
1196 (ediff-strip-mode-line-format)
1197 (setq mode-line-format
1198 (list " A: " 'ediff-diff-status mode-line-format
))
1199 (force-mode-line-update))
1200 (ediff-with-current-buffer ediff-buffer-B
1201 (setq ediff-diff-status buf-B-state-diff
)
1202 (ediff-strip-mode-line-format)
1203 (setq mode-line-format
1204 (list " B: " 'ediff-diff-status mode-line-format
))
1205 (force-mode-line-update))
1207 (ediff-with-current-buffer ediff-buffer-C
1208 (setq ediff-diff-status buf-C-state-diff
)
1209 (ediff-strip-mode-line-format)
1210 (setq mode-line-format
1211 (list " C: " 'ediff-diff-status mode-line-format
))
1212 (force-mode-line-update)))
1213 (if (ediff-buffer-live-p ediff-ancestor-buffer
)
1214 (ediff-with-current-buffer ediff-ancestor-buffer
1215 (ediff-strip-mode-line-format)
1216 ;; we keep the second dummy string in the mode line format of the
1217 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1218 ;; ediff-strip-mode-line-format expects that.
1219 (setq mode-line-format
1221 (cond ((not (stringp buf-C-state-merge
))
1223 ((string-match "prefer-A" buf-C-state-merge
)
1225 ((string-match "prefer-B" buf-C-state-merge
)
1228 mode-line-format
))))
1232 (defun ediff-refresh-control-frame ()
1234 ;; set frame/icon titles for Emacs
1235 (modify-frame-parameters
1237 (list (cons 'title
(ediff-make-base-title))
1238 (cons 'icon-name
(ediff-make-narrow-control-buffer-id))
1240 ;; set frame/icon titles for XEmacs
1241 (setq frame-title-format
(ediff-make-base-title)
1242 frame-icon-title-format
(ediff-make-narrow-control-buffer-id))
1243 ;; force an update of the frame title
1244 (modify-frame-parameters ediff-control-frame
'(()))))
1247 (defun ediff-make-narrow-control-buffer-id (&optional skip-name
)
1251 (ediff-make-base-title))
1252 (cond ((< ediff-current-difference
0)
1253 (format " _/%d" ediff-number-of-differences
))
1254 ((>= ediff-current-difference ediff-number-of-differences
)
1255 (format " $/%d" ediff-number-of-differences
))
1258 (1+ ediff-current-difference
)
1259 ediff-number-of-differences
)))))
1261 (defun ediff-make-base-title ()
1263 (cdr (assoc 'name ediff-control-frame-parameters
))
1264 ediff-control-buffer-suffix
))
1266 (defun ediff-make-wide-control-buffer-id ()
1267 (cond ((< ediff-current-difference
0)
1268 (list (format "%%b At start of %d diffs"
1269 ediff-number-of-differences
)))
1270 ((>= ediff-current-difference ediff-number-of-differences
)
1271 (list (format "%%b At end of %d diffs"
1272 ediff-number-of-differences
)))
1274 (list (format "%%b diff %d of %d"
1275 (1+ ediff-current-difference
)
1276 ediff-number-of-differences
)))))
1280 ;; If buff is not live, return nil
1281 (defun ediff-get-visible-buffer-window (buff)
1282 (if (ediff-buffer-live-p buff
)
1284 (get-buffer-window buff t
)
1285 (get-buffer-window buff
'visible
))))
1288 ;;; Functions to decide when to redraw windows
1290 (defun ediff-keep-window-config (control-buf)
1291 (and (eq control-buf
(current-buffer))
1292 (/= (buffer-size) 0)
1293 (ediff-with-current-buffer control-buf
1294 (let ((ctl-wind ediff-control-window
)
1295 (A-wind ediff-window-A
)
1296 (B-wind ediff-window-B
)
1297 (C-wind ediff-window-C
))
1300 (ediff-window-visible-p A-wind
)
1301 (ediff-window-visible-p B-wind
)
1302 ;; if buffer C is defined then take it into account
1303 (or (not ediff-3way-job
)
1304 (ediff-window-visible-p C-wind
))
1305 (eq (window-buffer A-wind
) ediff-buffer-A
)
1306 (eq (window-buffer B-wind
) ediff-buffer-B
)
1307 (or (not ediff-3way-job
)
1308 (eq (window-buffer C-wind
) ediff-buffer-C
))
1309 (string= ediff-window-config-saved
1310 (format "%S%S%S%S%S%S%S"
1311 ctl-wind A-wind B-wind C-wind
1312 ediff-split-window-function
1313 (ediff-multiframe-setup-p)
1314 ediff-wide-display-p
)))))))
1317 ;;; Local Variables:
1318 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1319 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1320 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1323 ;;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1324 ;;; ediff-wind.el ends here