| blob | 50f2be3b8dceb7cdb3ba07bcd694a5fe084e794c |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994-1997, 2000-2012 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
6 ;; Package: ediff
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 of the License, or
13 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
28 ;; Compiler pacifier
41 ;; declare-function does not exist in XEmacs
48 ;; end pacifier
52 ;; be careful with ediff-tbar
58 "Ediff window manipulation."
64 ;; Determine which window setup function to use based on current window system.
67 'ediff-setup-windows-multiframe
74 "Function called to set up windows.
75 Ediff provides a choice of three functions:
76 (1) `ediff-setup-windows-multiframe', which sets the control panel
77 in a separate frame.
78 (2) `ediff-setup-windows-plain', which does everything in one frame
79 (3) `ediff-setup-windows-default' (the default), which does (1)
80 on a graphical display and (2) on a text terminal.
83 between the multiframe display and the single frame display. If
84 the multiframe function detects that one of the buffers A/B is
85 seen in some other frame, it will try to keep that buffer in that
86 frame.
88 If you don't like any of the two provided functions, write your own one.
89 The basic guidelines:
90 1. It should leave the control buffer current and the control window
91 selected.
92 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
93 and `ediff-control-window' to contain window objects that display
94 the corresponding buffers.
95 3. It should accept the following arguments:
96 buffer-A, buffer-B, buffer-C, control-buffer
97 Buffer C may not be used in jobs that compare only two buffers.
98 If you plan to do something fancy, take a close look at how the two
99 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."
145 function)
149 "The function used to split the main window between buffer-A and buffer-B.
150 You can set it to a vertical split instead of the default horizontal split
151 by setting this variable to `split-window-vertically'.
152 You can also have your own function to do fancy splits.
153 This variable has no effect when buffer-A/B/C are shown in different frames.
154 In this case, Ediff will use those frames to display these buffers."
158 function)
161 ;; Definitions hidden from the compiler by compat wrappers.
168 ;;'(unsplittable . t)
178 ;; don't lower but auto-raise
182 ;; make initial frame small to avoid distraction
184 ;; this blocks queries from window manager as to where to put
185 ;; ediff's control frame. we put the frame outside the display,
186 ;; so the initial frame won't jump all over the screen
193 )
194 "Frame parameters for displaying Ediff Control Panel.
197 ;; position of the mouse; used to decide whether to warp the mouse into ctl
198 ;; frame
201 ;; not used for now
203 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
206 "If t, Ediff will always grab the mouse and put it in the control frame.
207 If 'maybe, Ediff will do it sometimes, but not after operations that require
208 relatively long time. If nil, the mouse will be entirely user's
209 responsibility."
214 "Function to call to determine the desired location for the control panel.
215 Expects three parameters: the control buffer, the desired width and height
216 of the control frame. It returns an association list
217 of the form \(\(top . <position>\) \(left . <position>\)\)"
222 "The upward shift of control frame from the top of buffer A's frame.
223 Measured in pixels.
224 This is used by the default control frame positioning function,
225 `ediff-make-frame-position'. This variable is provided for easy
226 customization of the default control frame positioning."
231 "The leftward shift of control frame from the right edge of buf A's frame.
232 Measured in characters.
233 This is used by the default control frame positioning function,
234 `ediff-make-frame-position' to adjust the position of the control frame
235 when it shows the short menu. This variable is provided for easy
236 customization of the default."
241 "The rightward shift of control frame from the left edge of buf A's frame.
242 Measured in characters.
243 This is used by the default control frame positioning function,
244 `ediff-make-frame-position' to adjust the position of the control frame
245 when it shows the full menu. This variable is provided for easy
246 customization of the default."
251 ;; Wide frame display
253 ;; t means Ediff is using wide display
255 ;; keeps frame config for toggling wide display
257 "Frame parameters to be restored when the user wants to toggle the wide
262 "The value is a function that is called to create a wide display.
263 The function is called without arguments. It should resize the frame in
264 which buffers A, B, and C are to be displayed, and it should save the old
265 frame parameters in `ediff-wide-display-orig-parameters'.
266 The variable `ediff-wide-display-frame' should be set to contain
269 ;; Frame used for the control panel in a windowing system.
273 "If t, keep control panel iconified when help message is off.
274 This has effect only on a windowing system.
275 If t, hitting `?' to toggle control panel off iconifies it.
277 This is only useful in Emacs and only for certain kinds of window managers,
278 such as TWM and its derivatives, since the window manager must permit
279 keyboard input to go into icons. XEmacs completely ignores keyboard input
280 into icons, regardless of the window manager."
284 ;;; Functions
300 ;; Select the lowest window on the frame.
315 lowest-window this-window))
322 ;;; Common window setup routines
324 ;; Set up the window configuration. If POS is given, set the points to
325 ;; the beginnings of the buffers.
326 ;; When 3way comparison is added, this will have to choose the appropriate
327 ;; setup function based on ediff-job-name
329 ;; Make sure we are not in the minibuffer window when we try to delete
330 ;; all other windows.
335 ;; in case user did a no-no on a tty
342 buffer-A buffer-B buffer-C control-buffer))
347 'ediff-setup-windows-multiframe
349 buffer-A buffer-B buffer-C control-buffer))
351 ;; Just set up 3 windows.
352 ;; Usually used without windowing systems
353 ;; With windowing, we want to use dedicated frames.
359 buffer-A buffer-B buffer-C control-buffer)
361 buffer-A buffer-B buffer-C control-buffer)))
364 ;; skip dedicated and unsplittable frames
367 split-window-function
368 merge-window-share merge-window-lines
369 wind-A wind-B wind-C)
372 ;; this lets us have local versions of ediff-split-window-function
373 split-window-function ediff-split-window-function))
380 ;; go to the upper window and split it betw A, B, and possibly C
387 ;; XEmacs used to have a lot of trouble with display
388 ;; It did't set things right unless we tell it to sit still
389 ;; 19.12 seems ok.
390 ;;(if (featurep 'xemacs) (sit-for 0))
408 ediff-window-B wind-B
409 ediff-window-C wind-C))
413 ))
416 ;; This function handles all comparison jobs, including 3way jobs
418 ;; skip dedicated and unsplittable frames
421 split-window-function wind-width-or-height
422 three-way-comparison
423 wind-A-start wind-B-start wind-A wind-B wind-C)
431 ;; this lets us have local versions of ediff-split-window-function
432 split-window-function ediff-split-window-function
433 three-way-comparison ediff-3way-comparison-job))
434 ;; if in minibuffer go somewhere else
444 ;; go to the upper window and split it betw A, B, and possibly C
455 ;; XEmacs used to have a lot of trouble with display
456 ;; It did't set things right unless we told it to sit still
457 ;; 19.12 seems ok.
458 ;;(if (featurep 'xemacs) (sit-for 0))
477 ediff-window-B wind-B
478 ediff-window-C wind-C))
480 ;; It is unlikely that we will want to implement 3way window comparison.
481 ;; So, only buffers A and B are used here.
489 ))
492 ;; dispatch an appropriate window setup function
501 ;;; Algorithm:
502 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
503 ;;; destroy dedicated windows.
504 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
505 ;;; frame for A and B and use a separate frame for C.
506 ;;; 3. If C's frame is non-existent, then: if the first suitable
507 ;;; non-dedicated frame is different from A&B's, then use it for C.
508 ;;; Otherwise, put A,B, and C in one frame.
509 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
510 ;;; buffers.
512 ;; Skip dedicated or iconified frames.
513 ;; Unsplittable frames are taken care of later.
523 ;; on wide display, do things in one frame
526 ;; this lets us have local versions of ediff-split-window-function
532 ;; A and C must be in one frame
534 ;; B and C must be in one frame
536 ;; A or B is not visible
539 ;; A or B is not suitable for display
542 ;; A and B in the same frame, and no good frame
543 ;; for C
546 ))
547 ;; use-same-frame-for-AB implies wind A and B are ok for display
551 ediff-merge-window-share))
552 merge-window-lines
553 designated-minibuffer-frame
554 done-A done-B done-C)
556 ;; buf-A on its own
561 ;; buffer buf-A is seen in live wind-A
567 ;; buf-B on its own
572 ;; buffer buf-B is seen in live wind-B
578 ;; buf-C on its own
583 ;; buffer buf-C is seen in live wind-C
592 ;; wind-A must already be displaying buf-A
604 done-B t)))
612 ;; avoid dedicated and non-splittable windows
636 done-B t
637 done-C t)
638 ))
641 ;;; or it was set before because use-same-frame = 1
643 ;; Buf-A was not set up yet as it wasn't visible,
644 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
649 ))
651 ;;; or it was set before because use-same-frame = 1
653 ;; Buf-B was not set up yet as it wasn't visible
654 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
659 ))
662 ;;; or it was set before because use-same-frame = 1
664 ;; Buf-C was not set up yet as it wasn't visible
665 ;; and use-same-frame = nil
670 ))
674 ediff-window-B wind-B
675 ediff-window-C wind-C)
677 designated-minibuffer-frame
681 ))
684 ;; Window setup for all comparison jobs, including 3way comparisons
686 ;;; Algorithm:
687 ;;; If a buffer is seen in a frame, use that frame for that buffer.
688 ;;; If it is not seen, use the current frame.
689 ;;; If both buffers are not seen, they share the current frame. If one
690 ;;; of the buffers is not seen, it is placed in the current frame (where
691 ;;; ediff started). If that frame is displaying the other buffer, it is
692 ;;; shared between the two buffers.
693 ;;; However, if we decide to put both buffers in one frame
694 ;;; and the selected frame isn't splittable, we create a new frame and
695 ;;; put both buffers there, event if one of this buffers is visible in
696 ;;; another frame.
698 ;; Skip dedicated or iconified frames.
699 ;; Unsplittable frames are taken care of later.
711 ;; on wide display, do things in one frame
714 ;; this lets us have local versions of ediff-split-window-function
737 wind-A-start wind-B-start
738 designated-minibuffer-frame
739 done-A done-B done-C)
751 ;; buffer buf-A is seen in live wind-A
759 ;; buffer buf-B is seen in live wind-B
767 ;; buffer buf-C is seen in live wind-C
777 ;; avoid dedicated and non-splittable windows
785 (/
805 done-B t
806 done-C t)
807 ))
810 ;;; or it was set before because use-same-frame = 1
812 ;; Buf-A was not set up yet as it wasn't visible,
813 ;; and use-same-frame = nil
818 ))
820 ;;; or it was set before because use-same-frame = 1
822 ;; Buf-B was not set up yet as it wasn't visible,
823 ;; and use-same-frame = nil
828 ))
832 ;;; or it was set before because use-same-frame = 1
834 ;; Buf-C was not set up yet as it wasn't visible,
835 ;; and use-same-frame = nil
840 )))
844 ediff-window-B wind-B
845 ediff-window-C wind-C)
848 designated-minibuffer-frame
851 ;; It is unlikely that we'll implement a version of ediff-windows that
852 ;; would compare 3 windows at once. So, we don't use buffer C here.
859 ))
861 ;; skip unsplittable frames and frames that have dedicated windows.
862 ;; create a new splittable frame if none is found
866 seen-windows)
871 ;; skip small windows
875 nil
877 ;; remember history
879 ;; try new window
882 )
884 ;; fed up, no appropriate frames
888 )))
895 'ignore-minibuffer
896 frame)
897 ans))
899 ;; window is ok, if it is only one window on the frame, not counting the
900 ;; minibuffer, or none of the frame's windows is dedicated.
901 ;; The idea is that it is bad to destroy dedicated windows while creating an
902 ;; ediff window setup
907 ;; only one window
909 ;; none is dedicated (in multiframe setup)
911 )))
913 ;; Prepare or refresh control frame
916 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
917 ctl-frame old-ctl-frame lines
918 ;; user-grabbed-mouse
919 fheight fwidth adjusted-parameters)
924 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
930 old-ctl-frame
932 ediff-control-frame ctl-frame)
933 ;; protect against undefined face-attribute
942 ()
946 ;; must be before ediff-setup-control-buffer
947 ;; just a precaution--we should be in ctl-buffer already
958 dont-iconify-ctl-frame))
960 ;; 1 more line for the modeline
962 fheight lines
965 adjusted-parameters
967 ;; possibly change surrogate minibuffer
970 designated-minibuffer-frame))
974 ))
976 ;; adjust autoraise
981 adjusted-parameters))
983 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
984 ;; are changed.
991 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
995 ;; As a precaution, we call modify frame parameters twice, in
996 ;; order to make sure that at least once we do it for
997 ;; a non-iconified frame. (It appears that in the Windows port of
998 ;; Emacs, one can't modify frame parameters of iconified frames.)
1002 ;; make or zap toolbar (if not requested)
1010 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1011 ;; iconified, the current buffer changes to that of the frame that
1012 ;; becomes exposed as a result of this iconification.
1013 ;; So, we make sure the current buffer doesn't change.
1025 ;; Now move the frame. We must do it separately due to an obscure bug in
1026 ;; XEmacs
1028 ctl-frame
1031 ;; synchronize so the cursor will move to control frame
1032 ;; per RMS suggestion
1041 ;; don't warp the mouse, unless ediff-grab-mouse = t
1066 ;;(ediff-reset-mouse nil)
1067 )
1070 ;; finds a good place to clip control frame
1079 horizontal-adjustment upward-adjustment
1080 ctl-frame-top ctl-frame-left)
1082 ;; Multiple control frames are clipped based on the value of
1083 ;; ediff-control-buffer-number. This is done in order not to obscure
1084 ;; other active control panels.
1090 ctl-frame-left
1091 (+ frame-A-left
1094 (+ ediff-wide-control-frame-rightward-shift
1095 horizontal-adjustment))
1098 (+ ctl-frame-width
1099 ediff-narrow-control-frame-leftward-shift
1100 horizontal-adjustment))))))
1106 ctl-frame-left
1110 ;; keep ctl frame within the visible bounds
1116 )))
1124 "Construct an alist of parameters for the wide display.
1125 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1126 The frame to be resized is kept in `ediff-wide-display-frame'.
1127 This function modifies only the left margin and the width of the display.
1128 It assumes that it is called from within the control buffer."
1138 ediff-wide-display-frame frame-A)
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 ;; other invocations of Ediff.
1169 ediff-current-difference)
1170 " AncestorEmpty"
1172 )
1175 buf-B-state-diff ""
1178 ;; control buffer format
1183 ;; control buffer id
1188 ;; Force mode-line redisplay
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.
1228 mode-line-format))))
1229 ))
1234 ;; set frame/icon titles for Emacs
1236 ediff-control-frame
1239 ))
1240 ;; set frame/icon titles for XEmacs
1243 ;; force an update of the frame title
1250 " "
1259 ediff-number-of-differences)))))
1264 ediff-control-buffer-suffix))
1269 ediff-number-of-differences)))
1272 ediff-number-of-differences)))
1276 ediff-number-of-differences)))))
1280 ;; If buff is not live, return nil
1288 ;;; Functions to decide when to redraw windows
1302 ;; if buffer C is defined then take it into account
1311 ctl-wind A-wind B-wind C-wind
1312 ediff-split-window-function
1314 ediff-wide-display-p)))))))
1320 ;; Local Variables:
1321 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1322 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1323 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1324 ;; End:
1326 ;;; ediff-wind.el ends here