| blob | e094c15bdfe327e448b8b5e18facb88c518cabb2 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 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 3, or (at your option)
13 ;; any later version.
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.
25 ;;; Commentary:
27 ;;; Code:
30 ;; Compiler pacifier
43 ;; declare-function does not exist in XEmacs
53 )
54 ;; end pacifier
58 ;; be careful with ediff-tbar
67 "Ediff window manipulation."
73 ;; Determine which window setup function to use based on current window system.
76 'ediff-setup-windows-multiframe
80 "*Function called to set up windows.
81 Ediff provides a choice of two functions: `ediff-setup-windows-plain', for
82 doing everything in one frame and `ediff-setup-windows-multiframe', which sets
83 the control panel in a separate frame. By default, the appropriate function is
84 chosen automatically depending on the current window system.
85 However, `ediff-toggle-multiframe' can be used to toggle between the multiframe
86 display and the single frame display.
87 If the multiframe function detects that one of the buffers A/B is seen in some
88 other frame, it will try to keep that buffer in that frame.
90 If you don't like any of the two provided functions, write your own one.
91 The basic guidelines:
92 1. It should leave the control buffer current and the control window
93 selected.
94 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
95 and `ediff-control-window' to contain window objects that display
96 the corresponding buffers.
97 3. It should accept the following arguments:
98 buffer-A, buffer-B, buffer-C, control-buffer
99 Buffer C may not be used in jobs that compare only two buffers.
100 If you plan to do something fancy, take a close look at how the two
101 provided functions are written."
107 ;; indicates if we are in a multiframe setup
110 ;; Share of the frame occupied by the merge window (buffer C)
113 ;; The control window.
115 ;; Official window for buffer A
117 ;; Official window for buffer B
119 ;; Official window for buffer C
121 ;; Ediff's window configuration.
122 ;; Used to minimize the need to rearrange windows.
125 ;; Association between buff-type and ediff-window-*
136 "*The function used to split the main window between buffer-A and buffer-B.
137 You can set it to a horizontal split instead of the default vertical split
138 by setting this variable to `split-window-horizontally'.
139 You can also have your own function to do fancy splits.
140 This variable has no effect when buffer-A/B are shown in different frames.
141 In this case, Ediff will use those frames to display these buffers."
146 "*The function used to split the main window between buffer-A and buffer-B.
147 You can set it to a vertical split instead of the default horizontal split
148 by setting this variable to `split-window-vertically'.
149 You can also have your own function to do fancy splits.
150 This variable has no effect when buffer-A/B/C are shown in different frames.
151 In this case, Ediff will use those frames to display these buffers."
155 ;; Definitions hidden from the compiler by compat wrappers.
162 ;;'(unsplittable . t)
172 ;; don't lower but auto-raise
176 ;; make initial frame small to avoid distraction
178 ;; this blocks queries from window manager as to where to put
179 ;; ediff's control frame. we put the frame outside the display,
180 ;; so the initial frame won't jump all over the screen
187 )
188 "Frame parameters for displaying Ediff Control Panel.
191 ;; position of the mouse; used to decide whether to warp the mouse into ctl
192 ;; frame
195 ;; not used for now
197 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
200 "*If t, Ediff will always grab the mouse and put it in the control frame.
201 If 'maybe, Ediff will do it sometimes, but not after operations that require
202 relatively long time. If nil, the mouse will be entirely user's
203 responsibility."
208 "Function to call to determine the desired location for the control panel.
209 Expects three parameters: the control buffer, the desired width and height
210 of the control frame. It returns an association list
211 of the form \(\(top . <position>\) \(left . <position>\)\)"
216 "*The upward shift of control frame from the top of buffer A's frame.
217 Measured in pixels.
218 This is used by the default control frame positioning function,
219 `ediff-make-frame-position'. This variable is provided for easy
220 customization of the default control frame positioning."
225 "*The leftward shift of control frame from the right 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 short menu. This variable is provided for easy
230 customization of the default."
235 "*The rightward shift of control frame from the left edge of buf A's frame.
236 Measured in characters.
237 This is used by the default control frame positioning function,
238 `ediff-make-frame-position' to adjust the position of the control frame
239 when it shows the full menu. This variable is provided for easy
240 customization of the default."
245 ;; Wide frame display
247 ;; t means Ediff is using wide display
249 ;; keeps frame config for toggling wide display
251 "Frame parameters to be restored when the user wants to toggle the wide
256 "The value is a function that is called to create a wide display.
257 The function is called without arguments. It should resize the frame in
258 which buffers A, B, and C are to be displayed, and it should save the old
259 frame parameters in `ediff-wide-display-orig-parameters'.
260 The variable `ediff-wide-display-frame' should be set to contain
263 ;; Frame used for the control panel in a windowing system.
267 "*If t, keep control panel iconified when help message is off.
268 This has effect only on a windowing system.
269 If t, hitting `?' to toggle control panel off iconifies it.
271 This is only useful in Emacs and only for certain kinds of window managers,
272 such as TWM and its derivatives, since the window manager must permit
273 keyboard input to go into icons. XEmacs completely ignores keyboard input
274 into icons, regardless of the window manager."
278 ;;; Functions
294 ;; Select the lowest window on the frame.
309 lowest-window this-window))
316 ;;; Common window setup routines
318 ;; Set up the window configuration. If POS is given, set the points to
319 ;; the beginnings of the buffers.
320 ;; When 3way comparison is added, this will have to choose the appropriate
321 ;; setup function based on ediff-job-name
323 ;; Make sure we are not in the minibuffer window when we try to delete
324 ;; all other windows.
329 ;; in case user did a no-no on a tty
336 buffer-A buffer-B buffer-C control-buffer))
339 ;; Just set up 3 windows.
340 ;; Usually used without windowing systems
341 ;; With windowing, we want to use dedicated frames.
347 buffer-A buffer-B buffer-C control-buffer)
349 buffer-A buffer-B buffer-C control-buffer)))
352 ;; skip dedicated and unsplittable frames
355 split-window-function
356 merge-window-share merge-window-lines
357 wind-A wind-B wind-C)
360 ;; this lets us have local versions of ediff-split-window-function
361 split-window-function ediff-split-window-function))
368 ;; go to the upper window and split it betw A, B, and possibly C
375 ;; XEmacs used to have a lot of trouble with display
376 ;; It did't set things right unless we tell it to sit still
377 ;; 19.12 seems ok.
378 ;;(if (featurep 'xemacs) (sit-for 0))
396 ediff-window-B wind-B
397 ediff-window-C wind-C))
401 ))
404 ;; This function handles all comparison jobs, including 3way jobs
406 ;; skip dedicated and unsplittable frames
409 split-window-function wind-width-or-height
410 three-way-comparison
411 wind-A-start wind-B-start wind-A wind-B wind-C)
419 ;; this lets us have local versions of ediff-split-window-function
420 split-window-function ediff-split-window-function
421 three-way-comparison ediff-3way-comparison-job))
428 ;; go to the upper window and split it betw A, B, and possibly C
439 ;; XEmacs used to have a lot of trouble with display
440 ;; It did't set things right unless we told it to sit still
441 ;; 19.12 seems ok.
442 ;;(if (featurep 'xemacs) (sit-for 0))
461 ediff-window-B wind-B
462 ediff-window-C wind-C))
464 ;; It is unlikely that we will want to implement 3way window comparison.
465 ;; So, only buffers A and B are used here.
473 ))
476 ;; dispatch an appropriate window setup function
485 ;;; Algorithm:
486 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
487 ;;; destroy dedicated windows.
488 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
489 ;;; frame for A and B and use a separate frame for C.
490 ;;; 3. If C's frame is non-existent, then: if the first suitable
491 ;;; non-dedicated frame is different from A&B's, then use it for C.
492 ;;; Otherwise, put A,B, and C in one frame.
493 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
494 ;;; buffers.
496 ;; Skip dedicated or iconified frames.
497 ;; Unsplittable frames are taken care of later.
507 ;; on wide display, do things in one frame
510 ;; this lets us have local versions of ediff-split-window-function
516 ;; A and C must be in one frame
518 ;; B and C must be in one frame
520 ;; A or B is not visible
523 ;; A or B is not suitable for display
526 ;; A and B in the same frame, and no good frame
527 ;; for C
530 ))
531 ;; use-same-frame-for-AB implies wind A and B are ok for display
535 ediff-merge-window-share))
536 merge-window-lines
537 designated-minibuffer-frame
538 done-A done-B done-C)
540 ;; buf-A on its own
545 ;; buffer buf-A is seen in live wind-A
551 ;; buf-B on its own
556 ;; buffer buf-B is seen in live wind-B
562 ;; buf-C on its own
567 ;; buffer buf-C is seen in live wind-C
576 ;; wind-A must already be displaying buf-A
588 done-B t)))
596 ;; avoid dedicated and non-splittable windows
620 done-B t
621 done-C t)
622 ))
625 ;;; or it was set before because use-same-frame = 1
627 ;; Buf-A was not set up yet as it wasn't visible,
628 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
633 ))
635 ;;; or it was set before because use-same-frame = 1
637 ;; Buf-B was not set up yet as it wasn't visible
638 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
643 ))
646 ;;; or it was set before because use-same-frame = 1
648 ;; Buf-C was not set up yet as it wasn't visible
649 ;; and use-same-frame = nil
654 ))
658 ediff-window-B wind-B
659 ediff-window-C wind-C)
661 designated-minibuffer-frame
665 ))
668 ;; Window setup for all comparison jobs, including 3way comparisons
670 ;;; Algorithm:
671 ;;; If a buffer is seen in a frame, use that frame for that buffer.
672 ;;; If it is not seen, use the current frame.
673 ;;; If both buffers are not seen, they share the current frame. If one
674 ;;; of the buffers is not seen, it is placed in the current frame (where
675 ;;; ediff started). If that frame is displaying the other buffer, it is
676 ;;; shared between the two buffers.
677 ;;; However, if we decide to put both buffers in one frame
678 ;;; and the selected frame isn't splittable, we create a new frame and
679 ;;; put both buffers there, event if one of this buffers is visible in
680 ;;; another frame.
682 ;; Skip dedicated or iconified frames.
683 ;; Unsplittable frames are taken care of later.
695 ;; on wide display, do things in one frame
698 ;; this lets us have local versions of ediff-split-window-function
721 wind-A-start wind-B-start
722 designated-minibuffer-frame
723 done-A done-B done-C)
735 ;; buffer buf-A is seen in live wind-A
743 ;; buffer buf-B is seen in live wind-B
751 ;; buffer buf-C is seen in live wind-C
761 ;; avoid dedicated and non-splittable windows
769 (/
789 done-B t
790 done-C t)
791 ))
794 ;;; or it was set before because use-same-frame = 1
796 ;; Buf-A was not set up yet as it wasn't visible,
797 ;; and use-same-frame = nil
802 ))
804 ;;; or it was set before because use-same-frame = 1
806 ;; Buf-B was not set up yet as it wasn't visible,
807 ;; and use-same-frame = nil
812 ))
816 ;;; or it was set before because use-same-frame = 1
818 ;; Buf-C was not set up yet as it wasn't visible,
819 ;; and use-same-frame = nil
824 )))
828 ediff-window-B wind-B
829 ediff-window-C wind-C)
832 designated-minibuffer-frame
835 ;; It is unlikely that we'll implement a version of ediff-windows that
836 ;; would compare 3 windows at once. So, we don't use buffer C here.
843 ))
845 ;; skip unsplittable frames and frames that have dedicated windows.
846 ;; create a new splittable frame if none is found
850 seen-windows)
855 ;; skip small windows
859 nil
861 ;; remember history
863 ;; try new window
866 )
868 ;; fed up, no appropriate frames
872 )))
879 'ignore-minibuffer
880 frame)
881 ans))
883 ;; window is ok, if it is only one window on the frame, not counting the
884 ;; minibuffer, or none of the frame's windows is dedicated.
885 ;; The idea is that it is bad to destroy dedicated windows while creating an
886 ;; ediff window setup
891 ;; only one window
893 ;; none is dedicated (in multiframe setup)
895 )))
897 ;; Prepare or refresh control frame
900 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
901 ctl-frame old-ctl-frame lines
902 ;; user-grabbed-mouse
903 fheight fwidth adjusted-parameters)
908 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
914 old-ctl-frame
916 ediff-control-frame ctl-frame)
917 ;; protect against undefined face-attribute
926 ()
930 ;; must be before ediff-setup-control-buffer
931 ;; just a precaution--we should be in ctl-buffer already
942 dont-iconify-ctl-frame))
944 ;; 1 more line for the modeline
946 fheight lines
949 adjusted-parameters
951 ;; possibly change surrogate minibuffer
954 designated-minibuffer-frame))
958 ))
960 ;; adjust autoraise
965 adjusted-parameters))
967 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
968 ;; are changed.
975 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
979 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
980 ;; to make sure that at least once we do it for non-iconified frame. If
981 ;; appears that in the OS/2 port of Emacs, one can't modify frame
982 ;; parameters of iconified frames. As a precaution, we do likewise for
983 ;; windows-nt.
987 ;; make or zap toolbar (if not requested)
995 ;; This works around a bug in 19.25 and earlier. There, if frame gets
996 ;; iconified, the current buffer changes to that of the frame that
997 ;; becomes exposed as a result of this iconification.
998 ;; So, we make sure the current buffer doesn't change.
1010 ;; Now move the frame. We must do it separately due to an obscure bug in
1011 ;; XEmacs
1013 ctl-frame
1016 ;; synchronize so the cursor will move to control frame
1017 ;; per RMS suggestion
1026 ;; don't warp the mouse, unless ediff-grab-mouse = t
1051 ;;(ediff-reset-mouse nil)
1052 )
1055 ;; finds a good place to clip control frame
1064 horizontal-adjustment upward-adjustment
1065 ctl-frame-top ctl-frame-left)
1067 ;; Multiple control frames are clipped based on the value of
1068 ;; ediff-control-buffer-number. This is done in order not to obscure
1069 ;; other active control panels.
1075 ctl-frame-left
1076 (+ frame-A-left
1079 (+ ediff-wide-control-frame-rightward-shift
1080 horizontal-adjustment))
1083 (+ ctl-frame-width
1084 ediff-narrow-control-frame-leftward-shift
1085 horizontal-adjustment))))))
1091 ctl-frame-left
1095 ;; keep ctl frame within the visible bounds
1101 )))
1109 "Construct an alist of parameters for the wide display.
1110 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1111 The frame to be resized is kept in `ediff-wide-display-frame'.
1112 This function modifies only the left margin and the width of the display.
1113 It assumes that it is called from within the control buffer."
1123 ediff-wide-display-frame frame-A)
1128 ;; Revise the mode line to display which difference we have selected
1129 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1130 ;; anothe invocations of Ediff.
1154 ediff-current-difference)
1155 " AncestorEmpty"
1157 )
1160 buf-B-state-diff ""
1163 ;; control buffer format
1168 ;; control buffer id
1173 ;; Force mode-line redisplay
1201 ;; we keep the second dummy string in the mode line format of the
1202 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1203 ;; ediff-strip-mode-line-format expects that.
1213 mode-line-format))))
1214 ))
1219 ;; set frame/icon titles for Emacs
1221 ediff-control-frame
1224 ))
1225 ;; set frame/icon titles for XEmacs
1228 ;; force an update of the frame title
1235 " "
1244 ediff-number-of-differences)))))
1249 ediff-control-buffer-suffix))
1254 ediff-number-of-differences)))
1257 ediff-number-of-differences)))
1261 ediff-number-of-differences)))))
1265 ;; If buff is not live, return nil
1273 ;;; Functions to decide when to redraw windows
1287 ;; if buffer C is defined then take it into account
1296 ctl-wind A-wind B-wind C-wind
1297 ediff-split-window-function
1299 ediff-wide-display-p)))))))
1305 ;;; Local Variables:
1306 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1307 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1308 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1309 ;;; End:
1311 ;;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1312 ;;; ediff-wind.el ends here