| blob | 708fb413d3e574484ad1b6919f74d41b4e2e975f |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009 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 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
71 "Function called to set up windows.
72 Ediff provides a choice of two functions: `ediff-setup-windows-plain', for
73 doing everything in one frame and `ediff-setup-windows-multiframe', which sets
74 the control panel in a separate frame. By default, the appropriate function is
75 chosen automatically depending on the current window system.
76 However, `ediff-toggle-multiframe' can be used to toggle between the multiframe
77 display and the single frame display.
78 If the multiframe function detects that one of the buffers A/B is seen in some
79 other frame, it will try to keep that buffer in that frame.
81 If you don't like any of the two provided functions, write your own one.
82 The basic guidelines:
83 1. It should leave the control buffer current and the control window
84 selected.
85 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
86 and `ediff-control-window' to contain window objects that display
87 the corresponding buffers.
88 3. It should accept the following arguments:
89 buffer-A, buffer-B, buffer-C, control-buffer
90 Buffer C may not be used in jobs that compare only two buffers.
91 If you plan to do something fancy, take a close look at how the two
92 provided functions are written."
98 ;; indicates if we are in a multiframe setup
101 ;; Share of the frame occupied by the merge window (buffer C)
104 ;; The control window.
106 ;; Official window for buffer A
108 ;; Official window for buffer B
110 ;; Official window for buffer C
112 ;; Ediff's window configuration.
113 ;; Used to minimize the need to rearrange windows.
116 ;; Association between buff-type and ediff-window-*
127 "The function used to split the main window between buffer-A and buffer-B.
128 You can set it to a horizontal split instead of the default vertical split
129 by setting this variable to `split-window-horizontally'.
130 You can also have your own function to do fancy splits.
131 This variable has no effect when buffer-A/B are shown in different frames.
132 In this case, Ediff will use those frames to display these buffers."
136 function)
140 "The function used to split the main window between buffer-A and buffer-B.
141 You can set it to a vertical split instead of the default horizontal split
142 by setting this variable to `split-window-vertically'.
143 You can also have your own function to do fancy splits.
144 This variable has no effect when buffer-A/B/C are shown in different frames.
145 In this case, Ediff will use those frames to display these buffers."
149 function)
152 ;; Definitions hidden from the compiler by compat wrappers.
159 ;;'(unsplittable . t)
169 ;; don't lower but auto-raise
173 ;; make initial frame small to avoid distraction
175 ;; this blocks queries from window manager as to where to put
176 ;; ediff's control frame. we put the frame outside the display,
177 ;; so the initial frame won't jump all over the screen
184 )
185 "Frame parameters for displaying Ediff Control Panel.
188 ;; position of the mouse; used to decide whether to warp the mouse into ctl
189 ;; frame
192 ;; not used for now
194 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
197 "If t, Ediff will always grab the mouse and put it in the control frame.
198 If 'maybe, Ediff will do it sometimes, but not after operations that require
199 relatively long time. If nil, the mouse will be entirely user's
200 responsibility."
205 "Function to call to determine the desired location for the control panel.
206 Expects three parameters: the control buffer, the desired width and height
207 of the control frame. It returns an association list
208 of the form \(\(top . <position>\) \(left . <position>\)\)"
213 "The upward shift of control frame from the top of buffer A's frame.
214 Measured in pixels.
215 This is used by the default control frame positioning function,
216 `ediff-make-frame-position'. This variable is provided for easy
217 customization of the default control frame positioning."
222 "The leftward shift of control frame from the right edge of buf A's frame.
223 Measured in characters.
224 This is used by the default control frame positioning function,
225 `ediff-make-frame-position' to adjust the position of the control frame
226 when it shows the short menu. This variable is provided for easy
227 customization of the default."
232 "The rightward shift of control frame from the left edge of buf A's frame.
233 Measured in characters.
234 This is used by the default control frame positioning function,
235 `ediff-make-frame-position' to adjust the position of the control frame
236 when it shows the full menu. This variable is provided for easy
237 customization of the default."
242 ;; Wide frame display
244 ;; t means Ediff is using wide display
246 ;; keeps frame config for toggling wide display
248 "Frame parameters to be restored when the user wants to toggle the wide
253 "The value is a function that is called to create a wide display.
254 The function is called without arguments. It should resize the frame in
255 which buffers A, B, and C are to be displayed, and it should save the old
256 frame parameters in `ediff-wide-display-orig-parameters'.
257 The variable `ediff-wide-display-frame' should be set to contain
260 ;; Frame used for the control panel in a windowing system.
264 "If t, keep control panel iconified when help message is off.
265 This has effect only on a windowing system.
266 If t, hitting `?' to toggle control panel off iconifies it.
268 This is only useful in Emacs and only for certain kinds of window managers,
269 such as TWM and its derivatives, since the window manager must permit
270 keyboard input to go into icons. XEmacs completely ignores keyboard input
271 into icons, regardless of the window manager."
275 ;;; Functions
291 ;; Select the lowest window on the frame.
306 lowest-window this-window))
313 ;;; Common window setup routines
315 ;; Set up the window configuration. If POS is given, set the points to
316 ;; the beginnings of the buffers.
317 ;; When 3way comparison is added, this will have to choose the appropriate
318 ;; setup function based on ediff-job-name
320 ;; Make sure we are not in the minibuffer window when we try to delete
321 ;; all other windows.
326 ;; in case user did a no-no on a tty
333 buffer-A buffer-B buffer-C control-buffer))
336 ;; Just set up 3 windows.
337 ;; Usually used without windowing systems
338 ;; With windowing, we want to use dedicated frames.
344 buffer-A buffer-B buffer-C control-buffer)
346 buffer-A buffer-B buffer-C control-buffer)))
349 ;; skip dedicated and unsplittable frames
352 split-window-function
353 merge-window-share merge-window-lines
354 wind-A wind-B wind-C)
357 ;; this lets us have local versions of ediff-split-window-function
358 split-window-function ediff-split-window-function))
365 ;; go to the upper window and split it betw A, B, and possibly C
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
374 ;; 19.12 seems ok.
375 ;;(if (featurep 'xemacs) (sit-for 0))
393 ediff-window-B wind-B
394 ediff-window-C wind-C))
398 ))
401 ;; This function handles all comparison jobs, including 3way jobs
403 ;; skip dedicated and unsplittable frames
406 split-window-function wind-width-or-height
407 three-way-comparison
408 wind-A-start wind-B-start wind-A wind-B wind-C)
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 ;; if in minibuffer go somewhere else
429 ;; go to the upper window and split it betw A, B, and possibly C
440 ;; XEmacs used to have a lot of trouble with display
441 ;; It did't set things right unless we told it to sit still
442 ;; 19.12 seems ok.
443 ;;(if (featurep 'xemacs) (sit-for 0))
462 ediff-window-B wind-B
463 ediff-window-C wind-C))
465 ;; It is unlikely that we will want to implement 3way window comparison.
466 ;; So, only buffers A and B are used here.
474 ))
477 ;; dispatch an appropriate window setup function
486 ;;; Algorithm:
487 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
488 ;;; destroy dedicated windows.
489 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
490 ;;; frame for A and B and use a separate frame for C.
491 ;;; 3. If C's frame is non-existent, then: if the first suitable
492 ;;; non-dedicated frame is different from A&B's, then use it for C.
493 ;;; Otherwise, put A,B, and C in one frame.
494 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
495 ;;; buffers.
497 ;; Skip dedicated or iconified frames.
498 ;; Unsplittable frames are taken care of later.
508 ;; on wide display, do things in one frame
511 ;; this lets us have local versions of ediff-split-window-function
517 ;; A and C must be in one frame
519 ;; B and C must be in one frame
521 ;; A or B is not visible
524 ;; A or B is not suitable for display
527 ;; A and B in the same frame, and no good frame
528 ;; for C
531 ))
532 ;; use-same-frame-for-AB implies wind A and B are ok for display
536 ediff-merge-window-share))
537 merge-window-lines
538 designated-minibuffer-frame
539 done-A done-B done-C)
541 ;; buf-A on its own
546 ;; buffer buf-A is seen in live wind-A
552 ;; buf-B on its own
557 ;; buffer buf-B is seen in live wind-B
563 ;; buf-C on its own
568 ;; buffer buf-C is seen in live wind-C
577 ;; wind-A must already be displaying buf-A
589 done-B t)))
597 ;; avoid dedicated and non-splittable windows
621 done-B t
622 done-C t)
623 ))
626 ;;; or it was set before because use-same-frame = 1
628 ;; Buf-A was not set up yet as it wasn't visible,
629 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
634 ))
636 ;;; or it was set before because use-same-frame = 1
638 ;; Buf-B was not set up yet as it wasn't visible
639 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
644 ))
647 ;;; or it was set before because use-same-frame = 1
649 ;; Buf-C was not set up yet as it wasn't visible
650 ;; and use-same-frame = nil
655 ))
659 ediff-window-B wind-B
660 ediff-window-C wind-C)
662 designated-minibuffer-frame
666 ))
669 ;; Window setup for all comparison jobs, including 3way comparisons
671 ;;; Algorithm:
672 ;;; If a buffer is seen in a frame, use that frame for that buffer.
673 ;;; If it is not seen, use the current frame.
674 ;;; If both buffers are not seen, they share the current frame. If one
675 ;;; of the buffers is not seen, it is placed in the current frame (where
676 ;;; ediff started). If that frame is displaying the other buffer, it is
677 ;;; shared between the two buffers.
678 ;;; However, if we decide to put both buffers in one frame
679 ;;; and the selected frame isn't splittable, we create a new frame and
680 ;;; put both buffers there, event if one of this buffers is visible in
681 ;;; another frame.
683 ;; Skip dedicated or iconified frames.
684 ;; Unsplittable frames are taken care of later.
696 ;; on wide display, do things in one frame
699 ;; this lets us have local versions of ediff-split-window-function
722 wind-A-start wind-B-start
723 designated-minibuffer-frame
724 done-A done-B done-C)
736 ;; buffer buf-A is seen in live wind-A
744 ;; buffer buf-B is seen in live wind-B
752 ;; buffer buf-C is seen in live wind-C
762 ;; avoid dedicated and non-splittable windows
770 (/
790 done-B t
791 done-C t)
792 ))
795 ;;; or it was set before because use-same-frame = 1
797 ;; Buf-A was not set up yet as it wasn't visible,
798 ;; and use-same-frame = nil
803 ))
805 ;;; or it was set before because use-same-frame = 1
807 ;; Buf-B was not set up yet as it wasn't visible,
808 ;; and use-same-frame = nil
813 ))
817 ;;; or it was set before because use-same-frame = 1
819 ;; Buf-C was not set up yet as it wasn't visible,
820 ;; and use-same-frame = nil
825 )))
829 ediff-window-B wind-B
830 ediff-window-C wind-C)
833 designated-minibuffer-frame
836 ;; It is unlikely that we'll implement a version of ediff-windows that
837 ;; would compare 3 windows at once. So, we don't use buffer C here.
844 ))
846 ;; skip unsplittable frames and frames that have dedicated windows.
847 ;; create a new splittable frame if none is found
851 seen-windows)
856 ;; skip small windows
860 nil
862 ;; remember history
864 ;; try new window
867 )
869 ;; fed up, no appropriate frames
873 )))
880 'ignore-minibuffer
881 frame)
882 ans))
884 ;; window is ok, if it is only one window on the frame, not counting the
885 ;; minibuffer, or none of the frame's windows is dedicated.
886 ;; The idea is that it is bad to destroy dedicated windows while creating an
887 ;; ediff window setup
892 ;; only one window
894 ;; none is dedicated (in multiframe setup)
896 )))
898 ;; Prepare or refresh control frame
901 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
902 ctl-frame old-ctl-frame lines
903 ;; user-grabbed-mouse
904 fheight fwidth adjusted-parameters)
909 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
915 old-ctl-frame
917 ediff-control-frame ctl-frame)
918 ;; protect against undefined face-attribute
927 ()
931 ;; must be before ediff-setup-control-buffer
932 ;; just a precaution--we should be in ctl-buffer already
943 dont-iconify-ctl-frame))
945 ;; 1 more line for the modeline
947 fheight lines
950 adjusted-parameters
952 ;; possibly change surrogate minibuffer
955 designated-minibuffer-frame))
959 ))
961 ;; adjust autoraise
966 adjusted-parameters))
968 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
969 ;; are changed.
976 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
980 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
981 ;; to make sure that at least once we do it for non-iconified frame. If
982 ;; appears that in the OS/2 port of Emacs, one can't modify frame
983 ;; parameters of iconified frames. As a precaution, we do likewise for
984 ;; windows-nt.
988 ;; make or zap toolbar (if not requested)
996 ;; This works around a bug in 19.25 and earlier. There, if frame gets
997 ;; iconified, the current buffer changes to that of the frame that
998 ;; becomes exposed as a result of this iconification.
999 ;; So, we make sure the current buffer doesn't change.
1011 ;; Now move the frame. We must do it separately due to an obscure bug in
1012 ;; XEmacs
1014 ctl-frame
1017 ;; synchronize so the cursor will move to control frame
1018 ;; per RMS suggestion
1027 ;; don't warp the mouse, unless ediff-grab-mouse = t
1052 ;;(ediff-reset-mouse nil)
1053 )
1056 ;; finds a good place to clip control frame
1065 horizontal-adjustment upward-adjustment
1066 ctl-frame-top ctl-frame-left)
1068 ;; Multiple control frames are clipped based on the value of
1069 ;; ediff-control-buffer-number. This is done in order not to obscure
1070 ;; other active control panels.
1076 ctl-frame-left
1077 (+ frame-A-left
1080 (+ ediff-wide-control-frame-rightward-shift
1081 horizontal-adjustment))
1084 (+ ctl-frame-width
1085 ediff-narrow-control-frame-leftward-shift
1086 horizontal-adjustment))))))
1092 ctl-frame-left
1096 ;; keep ctl frame within the visible bounds
1102 )))
1110 "Construct an alist of parameters for the wide display.
1111 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1112 The frame to be resized is kept in `ediff-wide-display-frame'.
1113 This function modifies only the left margin and the width of the display.
1114 It assumes that it is called from within the control buffer."
1124 ediff-wide-display-frame frame-A)
1129 ;; Revise the mode line to display which difference we have selected
1130 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1131 ;; anothe invocations of Ediff.
1155 ediff-current-difference)
1156 " AncestorEmpty"
1158 )
1161 buf-B-state-diff ""
1164 ;; control buffer format
1169 ;; control buffer id
1174 ;; Force mode-line redisplay
1202 ;; we keep the second dummy string in the mode line format of the
1203 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1204 ;; ediff-strip-mode-line-format expects that.
1214 mode-line-format))))
1215 ))
1220 ;; set frame/icon titles for Emacs
1222 ediff-control-frame
1225 ))
1226 ;; set frame/icon titles for XEmacs
1229 ;; force an update of the frame title
1236 " "
1245 ediff-number-of-differences)))))
1250 ediff-control-buffer-suffix))
1255 ediff-number-of-differences)))
1258 ediff-number-of-differences)))
1262 ediff-number-of-differences)))))
1266 ;; If buff is not live, return nil
1274 ;;; Functions to decide when to redraw windows
1288 ;; if buffer C is defined then take it into account
1297 ctl-wind A-wind B-wind C-wind
1298 ediff-split-window-function
1300 ediff-wide-display-p)))))))
1306 ;; Local Variables:
1307 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1308 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1309 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1310 ;; End:
1312 ;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1313 ;;; ediff-wind.el ends here