| blob | 5e698c39ebbae9503e0faf6060038e57ac4e25be |
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
54 )
55 ;; end pacifier
59 ;; be careful with ediff-tbar
65 "Ediff window manipulation."
71 ;; Determine which window setup function to use based on current window system.
74 'ediff-setup-windows-multiframe
78 "*Function called to set up windows.
79 Ediff provides a choice of two functions: `ediff-setup-windows-plain', for
80 doing everything in one frame and `ediff-setup-windows-multiframe', which sets
81 the control panel in a separate frame. By default, the appropriate function is
82 chosen automatically depending on the current window system.
83 However, `ediff-toggle-multiframe' can be used to toggle between the multiframe
84 display and the single frame display.
85 If the multiframe function detects that one of the buffers A/B is seen in some
86 other frame, it will try to keep that buffer in that 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."
105 ;; indicates if we are in a multiframe setup
108 ;; Share of the frame occupied by the merge window (buffer C)
111 ;; The control window.
113 ;; Official window for buffer A
115 ;; Official window for buffer B
117 ;; Official window for buffer C
119 ;; Ediff's window configuration.
120 ;; Used to minimize the need to rearrange windows.
123 ;; Association between buff-type and ediff-window-*
134 "*The function used to split the main window between buffer-A and buffer-B.
135 You can set it to a horizontal split instead of the default vertical split
136 by setting this variable to `split-window-horizontally'.
137 You can also have your own function to do fancy splits.
138 This variable has no effect when buffer-A/B are shown in different frames.
139 In this case, Ediff will use those frames to display these buffers."
143 function)
147 "*The function used to split the main window between buffer-A and buffer-B.
148 You can set it to a vertical split instead of the default horizontal split
149 by setting this variable to `split-window-vertically'.
150 You can also have your own function to do fancy splits.
151 This variable has no effect when buffer-A/B/C are shown in different frames.
152 In this case, Ediff will use those frames to display these buffers."
156 function)
159 ;; Definitions hidden from the compiler by compat wrappers.
166 ;;'(unsplittable . t)
176 ;; don't lower but auto-raise
180 ;; make initial frame small to avoid distraction
182 ;; this blocks queries from window manager as to where to put
183 ;; ediff's control frame. we put the frame outside the display,
184 ;; so the initial frame won't jump all over the screen
191 )
192 "Frame parameters for displaying Ediff Control Panel.
195 ;; position of the mouse; used to decide whether to warp the mouse into ctl
196 ;; frame
199 ;; not used for now
201 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
204 "*If t, Ediff will always grab the mouse and put it in the control frame.
205 If 'maybe, Ediff will do it sometimes, but not after operations that require
206 relatively long time. If nil, the mouse will be entirely user's
207 responsibility."
212 "Function to call to determine the desired location for the control panel.
213 Expects three parameters: the control buffer, the desired width and height
214 of the control frame. It returns an association list
215 of the form \(\(top . <position>\) \(left . <position>\)\)"
220 "*The upward shift of control frame from the top of buffer A's frame.
221 Measured in pixels.
222 This is used by the default control frame positioning function,
223 `ediff-make-frame-position'. This variable is provided for easy
224 customization of the default control frame positioning."
229 "*The leftward shift of control frame from the right edge of buf A's frame.
230 Measured in characters.
231 This is used by the default control frame positioning function,
232 `ediff-make-frame-position' to adjust the position of the control frame
233 when it shows the short menu. This variable is provided for easy
234 customization of the default."
239 "*The rightward shift of control frame from the left edge of buf A's frame.
240 Measured in characters.
241 This is used by the default control frame positioning function,
242 `ediff-make-frame-position' to adjust the position of the control frame
243 when it shows the full menu. This variable is provided for easy
244 customization of the default."
249 ;; Wide frame display
251 ;; t means Ediff is using wide display
253 ;; keeps frame config for toggling wide display
255 "Frame parameters to be restored when the user wants to toggle the wide
260 "The value is a function that is called to create a wide display.
261 The function is called without arguments. It should resize the frame in
262 which buffers A, B, and C are to be displayed, and it should save the old
263 frame parameters in `ediff-wide-display-orig-parameters'.
264 The variable `ediff-wide-display-frame' should be set to contain
267 ;; Frame used for the control panel in a windowing system.
271 "*If t, keep control panel iconified when help message is off.
272 This has effect only on a windowing system.
273 If t, hitting `?' to toggle control panel off iconifies it.
275 This is only useful in Emacs and only for certain kinds of window managers,
276 such as TWM and its derivatives, since the window manager must permit
277 keyboard input to go into icons. XEmacs completely ignores keyboard input
278 into icons, regardless of the window manager."
282 ;;; Functions
298 ;; Select the lowest window on the frame.
313 lowest-window this-window))
320 ;;; Common window setup routines
322 ;; Set up the window configuration. If POS is given, set the points to
323 ;; the beginnings of the buffers.
324 ;; When 3way comparison is added, this will have to choose the appropriate
325 ;; setup function based on ediff-job-name
327 ;; Make sure we are not in the minibuffer window when we try to delete
328 ;; all other windows.
333 ;; in case user did a no-no on a tty
340 buffer-A buffer-B buffer-C control-buffer))
343 ;; Just set up 3 windows.
344 ;; Usually used without windowing systems
345 ;; With windowing, we want to use dedicated frames.
351 buffer-A buffer-B buffer-C control-buffer)
353 buffer-A buffer-B buffer-C control-buffer)))
356 ;; skip dedicated and unsplittable frames
359 split-window-function
360 merge-window-share merge-window-lines
361 wind-A wind-B wind-C)
364 ;; this lets us have local versions of ediff-split-window-function
365 split-window-function ediff-split-window-function))
372 ;; go to the upper window and split it betw A, B, and possibly C
379 ;; XEmacs used to have a lot of trouble with display
380 ;; It did't set things right unless we tell it to sit still
381 ;; 19.12 seems ok.
382 ;;(if (featurep 'xemacs) (sit-for 0))
400 ediff-window-B wind-B
401 ediff-window-C wind-C))
405 ))
408 ;; This function handles all comparison jobs, including 3way jobs
410 ;; skip dedicated and unsplittable frames
413 split-window-function wind-width-or-height
414 three-way-comparison
415 wind-A-start wind-B-start wind-A wind-B wind-C)
423 ;; this lets us have local versions of ediff-split-window-function
424 split-window-function ediff-split-window-function
425 three-way-comparison ediff-3way-comparison-job))
432 ;; go to the upper window and split it betw A, B, and possibly C
443 ;; XEmacs used to have a lot of trouble with display
444 ;; It did't set things right unless we told it to sit still
445 ;; 19.12 seems ok.
446 ;;(if (featurep 'xemacs) (sit-for 0))
465 ediff-window-B wind-B
466 ediff-window-C wind-C))
468 ;; It is unlikely that we will want to implement 3way window comparison.
469 ;; So, only buffers A and B are used here.
477 ))
480 ;; dispatch an appropriate window setup function
489 ;;; Algorithm:
490 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
491 ;;; destroy dedicated windows.
492 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
493 ;;; frame for A and B and use a separate frame for C.
494 ;;; 3. If C's frame is non-existent, then: if the first suitable
495 ;;; non-dedicated frame is different from A&B's, then use it for C.
496 ;;; Otherwise, put A,B, and C in one frame.
497 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
498 ;;; buffers.
500 ;; Skip dedicated or iconified frames.
501 ;; Unsplittable frames are taken care of later.
511 ;; on wide display, do things in one frame
514 ;; this lets us have local versions of ediff-split-window-function
520 ;; A and C must be in one frame
522 ;; B and C must be in one frame
524 ;; A or B is not visible
527 ;; A or B is not suitable for display
530 ;; A and B in the same frame, and no good frame
531 ;; for C
534 ))
535 ;; use-same-frame-for-AB implies wind A and B are ok for display
539 ediff-merge-window-share))
540 merge-window-lines
541 designated-minibuffer-frame
542 done-A done-B done-C)
544 ;; buf-A on its own
549 ;; buffer buf-A is seen in live wind-A
555 ;; buf-B on its own
560 ;; buffer buf-B is seen in live wind-B
566 ;; buf-C on its own
571 ;; buffer buf-C is seen in live wind-C
580 ;; wind-A must already be displaying buf-A
592 done-B t)))
600 ;; avoid dedicated and non-splittable windows
624 done-B t
625 done-C t)
626 ))
629 ;;; or it was set before because use-same-frame = 1
631 ;; Buf-A was not set up yet as it wasn't visible,
632 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
637 ))
639 ;;; or it was set before because use-same-frame = 1
641 ;; Buf-B was not set up yet as it wasn't visible
642 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
647 ))
650 ;;; or it was set before because use-same-frame = 1
652 ;; Buf-C was not set up yet as it wasn't visible
653 ;; and use-same-frame = nil
658 ))
662 ediff-window-B wind-B
663 ediff-window-C wind-C)
665 designated-minibuffer-frame
669 ))
672 ;; Window setup for all comparison jobs, including 3way comparisons
674 ;;; Algorithm:
675 ;;; If a buffer is seen in a frame, use that frame for that buffer.
676 ;;; If it is not seen, use the current frame.
677 ;;; If both buffers are not seen, they share the current frame. If one
678 ;;; of the buffers is not seen, it is placed in the current frame (where
679 ;;; ediff started). If that frame is displaying the other buffer, it is
680 ;;; shared between the two buffers.
681 ;;; However, if we decide to put both buffers in one frame
682 ;;; and the selected frame isn't splittable, we create a new frame and
683 ;;; put both buffers there, event if one of this buffers is visible in
684 ;;; another frame.
686 ;; Skip dedicated or iconified frames.
687 ;; Unsplittable frames are taken care of later.
699 ;; on wide display, do things in one frame
702 ;; this lets us have local versions of ediff-split-window-function
725 wind-A-start wind-B-start
726 designated-minibuffer-frame
727 done-A done-B done-C)
739 ;; buffer buf-A is seen in live wind-A
747 ;; buffer buf-B is seen in live wind-B
755 ;; buffer buf-C is seen in live wind-C
765 ;; avoid dedicated and non-splittable windows
773 (/
793 done-B t
794 done-C t)
795 ))
798 ;;; or it was set before because use-same-frame = 1
800 ;; Buf-A was not set up yet as it wasn't visible,
801 ;; and use-same-frame = nil
806 ))
808 ;;; or it was set before because use-same-frame = 1
810 ;; Buf-B was not set up yet as it wasn't visible,
811 ;; and use-same-frame = nil
816 ))
820 ;;; or it was set before because use-same-frame = 1
822 ;; Buf-C was not set up yet as it wasn't visible,
823 ;; and use-same-frame = nil
828 )))
832 ediff-window-B wind-B
833 ediff-window-C wind-C)
836 designated-minibuffer-frame
839 ;; It is unlikely that we'll implement a version of ediff-windows that
840 ;; would compare 3 windows at once. So, we don't use buffer C here.
847 ))
849 ;; skip unsplittable frames and frames that have dedicated windows.
850 ;; create a new splittable frame if none is found
854 seen-windows)
859 ;; skip small windows
863 nil
865 ;; remember history
867 ;; try new window
870 )
872 ;; fed up, no appropriate frames
876 )))
883 'ignore-minibuffer
884 frame)
885 ans))
887 ;; window is ok, if it is only one window on the frame, not counting the
888 ;; minibuffer, or none of the frame's windows is dedicated.
889 ;; The idea is that it is bad to destroy dedicated windows while creating an
890 ;; ediff window setup
895 ;; only one window
897 ;; none is dedicated (in multiframe setup)
899 )))
901 ;; Prepare or refresh control frame
904 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
905 ctl-frame old-ctl-frame lines
906 ;; user-grabbed-mouse
907 fheight fwidth adjusted-parameters)
912 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
918 old-ctl-frame
920 ediff-control-frame ctl-frame)
921 ;; protect against undefined face-attribute
930 ()
934 ;; must be before ediff-setup-control-buffer
935 ;; just a precaution--we should be in ctl-buffer already
946 dont-iconify-ctl-frame))
948 ;; 1 more line for the modeline
950 fheight lines
953 adjusted-parameters
955 ;; possibly change surrogate minibuffer
958 designated-minibuffer-frame))
962 ))
964 ;; adjust autoraise
969 adjusted-parameters))
971 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
972 ;; are changed.
979 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
983 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
984 ;; to make sure that at least once we do it for non-iconified frame. If
985 ;; appears that in the OS/2 port of Emacs, one can't modify frame
986 ;; parameters of iconified frames. As a precaution, we do likewise for
987 ;; windows-nt.
991 ;; make or zap toolbar (if not requested)
999 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1000 ;; iconified, the current buffer changes to that of the frame that
1001 ;; becomes exposed as a result of this iconification.
1002 ;; So, we make sure the current buffer doesn't change.
1014 ;; Now move the frame. We must do it separately due to an obscure bug in
1015 ;; XEmacs
1017 ctl-frame
1020 ;; synchronize so the cursor will move to control frame
1021 ;; per RMS suggestion
1030 ;; don't warp the mouse, unless ediff-grab-mouse = t
1055 ;;(ediff-reset-mouse nil)
1056 )
1059 ;; finds a good place to clip control frame
1068 horizontal-adjustment upward-adjustment
1069 ctl-frame-top ctl-frame-left)
1071 ;; Multiple control frames are clipped based on the value of
1072 ;; ediff-control-buffer-number. This is done in order not to obscure
1073 ;; other active control panels.
1079 ctl-frame-left
1080 (+ frame-A-left
1083 (+ ediff-wide-control-frame-rightward-shift
1084 horizontal-adjustment))
1087 (+ ctl-frame-width
1088 ediff-narrow-control-frame-leftward-shift
1089 horizontal-adjustment))))))
1095 ctl-frame-left
1099 ;; keep ctl frame within the visible bounds
1105 )))
1113 "Construct an alist of parameters for the wide display.
1114 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1115 The frame to be resized is kept in `ediff-wide-display-frame'.
1116 This function modifies only the left margin and the width of the display.
1117 It assumes that it is called from within the control buffer."
1127 ediff-wide-display-frame frame-A)
1132 ;; Revise the mode line to display which difference we have selected
1133 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1134 ;; anothe invocations of Ediff.
1158 ediff-current-difference)
1159 " AncestorEmpty"
1161 )
1164 buf-B-state-diff ""
1167 ;; control buffer format
1172 ;; control buffer id
1177 ;; Force mode-line redisplay
1205 ;; we keep the second dummy string in the mode line format of the
1206 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1207 ;; ediff-strip-mode-line-format expects that.
1217 mode-line-format))))
1218 ))
1223 ;; set frame/icon titles for Emacs
1225 ediff-control-frame
1228 ))
1229 ;; set frame/icon titles for XEmacs
1232 ;; force an update of the frame title
1239 " "
1248 ediff-number-of-differences)))))
1253 ediff-control-buffer-suffix))
1258 ediff-number-of-differences)))
1261 ediff-number-of-differences)))
1265 ediff-number-of-differences)))))
1269 ;; If buff is not live, return nil
1277 ;;; Functions to decide when to redraw windows
1291 ;; if buffer C is defined then take it into account
1300 ctl-wind A-wind B-wind C-wind
1301 ediff-split-window-function
1303 ediff-wide-display-p)))))))
1309 ;;; Local Variables:
1310 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1311 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1312 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1313 ;;; End:
1315 ;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1316 ;;; ediff-wind.el ends here