| blob | 2eb335fb215d57e56f1967b877f1d3d974912249 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
7 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
8 ;; Package: ediff
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;;; Code:
30 ;; Compiler pacifier
43 ;; declare-function does not exist in XEmacs
50 ;; end pacifier
54 ;; be careful with ediff-tbar
60 "Ediff window manipulation."
66 ;; Determine which window setup function to use based on current window system.
69 'ediff-setup-windows-multiframe
73 "Function called to set up windows.
74 Ediff provides a choice of two functions: `ediff-setup-windows-plain', for
75 doing everything in one frame and `ediff-setup-windows-multiframe', which sets
76 the control panel in a separate frame. By default, the appropriate function is
77 chosen automatically depending on the current window system.
78 However, `ediff-toggle-multiframe' can be used to toggle between the multiframe
79 display and the single frame display.
80 If the multiframe function detects that one of the buffers A/B is seen in some
81 other frame, it will try to keep that buffer in that frame.
83 If you don't like any of the two provided functions, write your own one.
84 The basic guidelines:
85 1. It should leave the control buffer current and the control window
86 selected.
87 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
88 and `ediff-control-window' to contain window objects that display
89 the corresponding buffers.
90 3. It should accept the following arguments:
91 buffer-A, buffer-B, buffer-C, control-buffer
92 Buffer C may not be used in jobs that compare only two buffers.
93 If you plan to do something fancy, take a close look at how the two
94 provided functions are written."
100 ;; indicates if we are in a multiframe setup
103 ;; Share of the frame occupied by the merge window (buffer C)
106 ;; The control window.
108 ;; Official window for buffer A
110 ;; Official window for buffer B
112 ;; Official window for buffer C
114 ;; Ediff's window configuration.
115 ;; Used to minimize the need to rearrange windows.
118 ;; Association between buff-type and ediff-window-*
129 "The function used to split the main window between buffer-A and buffer-B.
130 You can set it to a horizontal split instead of the default vertical split
131 by setting this variable to `split-window-horizontally'.
132 You can also have your own function to do fancy splits.
133 This variable has no effect when buffer-A/B are shown in different frames.
134 In this case, Ediff will use those frames to display these buffers."
138 function)
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."
151 function)
154 ;; Definitions hidden from the compiler by compat wrappers.
161 ;;'(unsplittable . t)
171 ;; don't lower but auto-raise
175 ;; make initial frame small to avoid distraction
177 ;; this blocks queries from window manager as to where to put
178 ;; ediff's control frame. we put the frame outside the display,
179 ;; so the initial frame won't jump all over the screen
186 )
187 "Frame parameters for displaying Ediff Control Panel.
190 ;; position of the mouse; used to decide whether to warp the mouse into ctl
191 ;; frame
194 ;; not used for now
196 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
199 "If t, Ediff will always grab the mouse and put it in the control frame.
200 If 'maybe, Ediff will do it sometimes, but not after operations that require
201 relatively long time. If nil, the mouse will be entirely user's
202 responsibility."
207 "Function to call to determine the desired location for the control panel.
208 Expects three parameters: the control buffer, the desired width and height
209 of the control frame. It returns an association list
210 of the form \(\(top . <position>\) \(left . <position>\)\)"
215 "The upward shift of control frame from the top of buffer A's frame.
216 Measured in pixels.
217 This is used by the default control frame positioning function,
218 `ediff-make-frame-position'. This variable is provided for easy
219 customization of the default control frame positioning."
224 "The leftward shift of control frame from the right edge of buf A's frame.
225 Measured in characters.
226 This is used by the default control frame positioning function,
227 `ediff-make-frame-position' to adjust the position of the control frame
228 when it shows the short menu. This variable is provided for easy
229 customization of the default."
234 "The rightward shift of control frame from the left edge of buf A's frame.
235 Measured in characters.
236 This is used by the default control frame positioning function,
237 `ediff-make-frame-position' to adjust the position of the control frame
238 when it shows the full menu. This variable is provided for easy
239 customization of the default."
244 ;; Wide frame display
246 ;; t means Ediff is using wide display
248 ;; keeps frame config for toggling wide display
250 "Frame parameters to be restored when the user wants to toggle the wide
255 "The value is a function that is called to create a wide display.
256 The function is called without arguments. It should resize the frame in
257 which buffers A, B, and C are to be displayed, and it should save the old
258 frame parameters in `ediff-wide-display-orig-parameters'.
259 The variable `ediff-wide-display-frame' should be set to contain
262 ;; Frame used for the control panel in a windowing system.
266 "If t, keep control panel iconified when help message is off.
267 This has effect only on a windowing system.
268 If t, hitting `?' to toggle control panel off iconifies it.
270 This is only useful in Emacs and only for certain kinds of window managers,
271 such as TWM and its derivatives, since the window manager must permit
272 keyboard input to go into icons. XEmacs completely ignores keyboard input
273 into icons, regardless of the window manager."
277 ;;; Functions
293 ;; Select the lowest window on the frame.
308 lowest-window this-window))
315 ;;; Common window setup routines
317 ;; Set up the window configuration. If POS is given, set the points to
318 ;; the beginnings of the buffers.
319 ;; When 3way comparison is added, this will have to choose the appropriate
320 ;; setup function based on ediff-job-name
322 ;; Make sure we are not in the minibuffer window when we try to delete
323 ;; all other windows.
328 ;; in case user did a no-no on a tty
335 buffer-A buffer-B buffer-C control-buffer))
338 ;; Just set up 3 windows.
339 ;; Usually used without windowing systems
340 ;; With windowing, we want to use dedicated frames.
346 buffer-A buffer-B buffer-C control-buffer)
348 buffer-A buffer-B buffer-C control-buffer)))
351 ;; skip dedicated and unsplittable frames
354 split-window-function
355 merge-window-share merge-window-lines
356 wind-A wind-B wind-C)
359 ;; this lets us have local versions of ediff-split-window-function
360 split-window-function ediff-split-window-function))
367 ;; go to the upper window and split it betw A, B, and possibly C
374 ;; XEmacs used to have a lot of trouble with display
375 ;; It did't set things right unless we tell it to sit still
376 ;; 19.12 seems ok.
377 ;;(if (featurep 'xemacs) (sit-for 0))
395 ediff-window-B wind-B
396 ediff-window-C wind-C))
400 ))
403 ;; This function handles all comparison jobs, including 3way jobs
405 ;; skip dedicated and unsplittable frames
408 split-window-function wind-width-or-height
409 three-way-comparison
410 wind-A-start wind-B-start wind-A wind-B wind-C)
418 ;; this lets us have local versions of ediff-split-window-function
419 split-window-function ediff-split-window-function
420 three-way-comparison ediff-3way-comparison-job))
421 ;; if in minibuffer go somewhere else
431 ;; go to the upper window and split it betw A, B, and possibly C
442 ;; XEmacs used to have a lot of trouble with display
443 ;; It did't set things right unless we told it to sit still
444 ;; 19.12 seems ok.
445 ;;(if (featurep 'xemacs) (sit-for 0))
464 ediff-window-B wind-B
465 ediff-window-C wind-C))
467 ;; It is unlikely that we will want to implement 3way window comparison.
468 ;; So, only buffers A and B are used here.
476 ))
479 ;; dispatch an appropriate window setup function
488 ;;; Algorithm:
489 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
490 ;;; destroy dedicated windows.
491 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
492 ;;; frame for A and B and use a separate frame for C.
493 ;;; 3. If C's frame is non-existent, then: if the first suitable
494 ;;; non-dedicated frame is different from A&B's, then use it for C.
495 ;;; Otherwise, put A,B, and C in one frame.
496 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
497 ;;; buffers.
499 ;; Skip dedicated or iconified frames.
500 ;; Unsplittable frames are taken care of later.
510 ;; on wide display, do things in one frame
513 ;; this lets us have local versions of ediff-split-window-function
519 ;; A and C must be in one frame
521 ;; B and C must be in one frame
523 ;; A or B is not visible
526 ;; A or B is not suitable for display
529 ;; A and B in the same frame, and no good frame
530 ;; for C
533 ))
534 ;; use-same-frame-for-AB implies wind A and B are ok for display
538 ediff-merge-window-share))
539 merge-window-lines
540 designated-minibuffer-frame
541 done-A done-B done-C)
543 ;; buf-A on its own
548 ;; buffer buf-A is seen in live wind-A
554 ;; buf-B on its own
559 ;; buffer buf-B is seen in live wind-B
565 ;; buf-C on its own
570 ;; buffer buf-C is seen in live wind-C
579 ;; wind-A must already be displaying buf-A
591 done-B t)))
599 ;; avoid dedicated and non-splittable windows
623 done-B t
624 done-C t)
625 ))
628 ;;; or it was set before because use-same-frame = 1
630 ;; Buf-A was not set up yet as it wasn't visible,
631 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
636 ))
638 ;;; or it was set before because use-same-frame = 1
640 ;; Buf-B was not set up yet as it wasn't visible
641 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
646 ))
649 ;;; or it was set before because use-same-frame = 1
651 ;; Buf-C was not set up yet as it wasn't visible
652 ;; and use-same-frame = nil
657 ))
661 ediff-window-B wind-B
662 ediff-window-C wind-C)
664 designated-minibuffer-frame
668 ))
671 ;; Window setup for all comparison jobs, including 3way comparisons
673 ;;; Algorithm:
674 ;;; If a buffer is seen in a frame, use that frame for that buffer.
675 ;;; If it is not seen, use the current frame.
676 ;;; If both buffers are not seen, they share the current frame. If one
677 ;;; of the buffers is not seen, it is placed in the current frame (where
678 ;;; ediff started). If that frame is displaying the other buffer, it is
679 ;;; shared between the two buffers.
680 ;;; However, if we decide to put both buffers in one frame
681 ;;; and the selected frame isn't splittable, we create a new frame and
682 ;;; put both buffers there, event if one of this buffers is visible in
683 ;;; another frame.
685 ;; Skip dedicated or iconified frames.
686 ;; Unsplittable frames are taken care of later.
698 ;; on wide display, do things in one frame
701 ;; this lets us have local versions of ediff-split-window-function
724 wind-A-start wind-B-start
725 designated-minibuffer-frame
726 done-A done-B done-C)
738 ;; buffer buf-A is seen in live wind-A
746 ;; buffer buf-B is seen in live wind-B
754 ;; buffer buf-C is seen in live wind-C
764 ;; avoid dedicated and non-splittable windows
772 (/
792 done-B t
793 done-C t)
794 ))
797 ;;; or it was set before because use-same-frame = 1
799 ;; Buf-A was not set up yet as it wasn't visible,
800 ;; and use-same-frame = nil
805 ))
807 ;;; or it was set before because use-same-frame = 1
809 ;; Buf-B was not set up yet as it wasn't visible,
810 ;; and use-same-frame = nil
815 ))
819 ;;; or it was set before because use-same-frame = 1
821 ;; Buf-C was not set up yet as it wasn't visible,
822 ;; and use-same-frame = nil
827 )))
831 ediff-window-B wind-B
832 ediff-window-C wind-C)
835 designated-minibuffer-frame
838 ;; It is unlikely that we'll implement a version of ediff-windows that
839 ;; would compare 3 windows at once. So, we don't use buffer C here.
846 ))
848 ;; skip unsplittable frames and frames that have dedicated windows.
849 ;; create a new splittable frame if none is found
853 seen-windows)
858 ;; skip small windows
862 nil
864 ;; remember history
866 ;; try new window
869 )
871 ;; fed up, no appropriate frames
875 )))
882 'ignore-minibuffer
883 frame)
884 ans))
886 ;; window is ok, if it is only one window on the frame, not counting the
887 ;; minibuffer, or none of the frame's windows is dedicated.
888 ;; The idea is that it is bad to destroy dedicated windows while creating an
889 ;; ediff window setup
894 ;; only one window
896 ;; none is dedicated (in multiframe setup)
898 )))
900 ;; Prepare or refresh control frame
903 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
904 ctl-frame old-ctl-frame lines
905 ;; user-grabbed-mouse
906 fheight fwidth adjusted-parameters)
911 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
917 old-ctl-frame
919 ediff-control-frame ctl-frame)
920 ;; protect against undefined face-attribute
929 ()
933 ;; must be before ediff-setup-control-buffer
934 ;; just a precaution--we should be in ctl-buffer already
945 dont-iconify-ctl-frame))
947 ;; 1 more line for the modeline
949 fheight lines
952 adjusted-parameters
954 ;; possibly change surrogate minibuffer
957 designated-minibuffer-frame))
961 ))
963 ;; adjust autoraise
968 adjusted-parameters))
970 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
971 ;; are changed.
978 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
982 ;; As a precaution, we call modify frame parameters twice, in
983 ;; order to make sure that at least once we do it for
984 ;; a non-iconified frame. (It appears that in the Windows port of
985 ;; Emacs, one can't modify frame parameters of iconified frames.)
989 ;; make or zap toolbar (if not requested)
997 ;; This works around a bug in 19.25 and earlier. There, if frame gets
998 ;; iconified, the current buffer changes to that of the frame that
999 ;; becomes exposed as a result of this iconification.
1000 ;; So, we make sure the current buffer doesn't change.
1012 ;; Now move the frame. We must do it separately due to an obscure bug in
1013 ;; XEmacs
1015 ctl-frame
1018 ;; synchronize so the cursor will move to control frame
1019 ;; per RMS suggestion
1028 ;; don't warp the mouse, unless ediff-grab-mouse = t
1053 ;;(ediff-reset-mouse nil)
1054 )
1057 ;; finds a good place to clip control frame
1066 horizontal-adjustment upward-adjustment
1067 ctl-frame-top ctl-frame-left)
1069 ;; Multiple control frames are clipped based on the value of
1070 ;; ediff-control-buffer-number. This is done in order not to obscure
1071 ;; other active control panels.
1077 ctl-frame-left
1078 (+ frame-A-left
1081 (+ ediff-wide-control-frame-rightward-shift
1082 horizontal-adjustment))
1085 (+ ctl-frame-width
1086 ediff-narrow-control-frame-leftward-shift
1087 horizontal-adjustment))))))
1093 ctl-frame-left
1097 ;; keep ctl frame within the visible bounds
1103 )))
1111 "Construct an alist of parameters for the wide display.
1112 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1113 The frame to be resized is kept in `ediff-wide-display-frame'.
1114 This function modifies only the left margin and the width of the display.
1115 It assumes that it is called from within the control buffer."
1125 ediff-wide-display-frame frame-A)
1130 ;; Revise the mode line to display which difference we have selected
1131 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1132 ;; anothe invocations of Ediff.
1156 ediff-current-difference)
1157 " AncestorEmpty"
1159 )
1162 buf-B-state-diff ""
1165 ;; control buffer format
1170 ;; control buffer id
1175 ;; Force mode-line redisplay
1203 ;; we keep the second dummy string in the mode line format of the
1204 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1205 ;; ediff-strip-mode-line-format expects that.
1215 mode-line-format))))
1216 ))
1221 ;; set frame/icon titles for Emacs
1223 ediff-control-frame
1226 ))
1227 ;; set frame/icon titles for XEmacs
1230 ;; force an update of the frame title
1237 " "
1246 ediff-number-of-differences)))))
1251 ediff-control-buffer-suffix))
1256 ediff-number-of-differences)))
1259 ediff-number-of-differences)))
1263 ediff-number-of-differences)))))
1267 ;; If buff is not live, return nil
1275 ;;; Functions to decide when to redraw windows
1289 ;; if buffer C is defined then take it into account
1298 ctl-wind A-wind B-wind C-wind
1299 ediff-split-window-function
1301 ediff-wide-display-p)))))))
1307 ;; Local Variables:
1308 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1309 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1310 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1311 ;; End:
1313 ;;; ediff-wind.el ends here