| blob | 8b72a673d176d2edf40a24e84d8e874b7336ada0 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 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
54 ))
55 ;; end pacifier
59 ;; be careful with ediff-tbar
68 "Ediff window manipulation."
75 "*Function called to set up windows.
76 Ediff provides a choice of three functions: `ediff-setup-windows-plain', for
77 doing everything in one frame, `ediff-setup-windows-multiframe', which sets
78 the control panel in a separate frame, and
79 `ediff-setup-windows-automatic' (the default), which chooses an appropriate
80 behaviour based on the current window system. If the multiframe function
81 detects that one of the buffers A/B is seen in some other frame, it will try
82 to keep that buffer in that frame.
84 If you don't like the two functions provided---write your own one.
85 The basic guidelines:
86 1. It should leave the control buffer current and the control window
87 selected.
88 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
89 and `ediff-control-window' to contain window objects that display
90 the corresponding buffers.
91 3. It should accept the following arguments:
92 buffer-A, buffer-B, buffer-C, control-buffer
93 Buffer C may not be used in jobs that compare only two buffers.
94 If you plan to do something fancy, take a close look at how the two
95 provided functions are written."
102 ;; indicates if we are in a multiframe setup
105 ;; Share of the frame occupied by the merge window (buffer C)
108 ;; The control window.
110 ;; Official window for buffer A
112 ;; Official window for buffer B
114 ;; Official window for buffer C
116 ;; Ediff's window configuration.
117 ;; Used to minimize the need to rearrange windows.
120 ;; Association between buff-type and ediff-window-*
131 "*The function used to split the main window between buffer-A and buffer-B.
132 You can set it to a horizontal split instead of the default vertical split
133 by setting this variable to `split-window-horizontally'.
134 You can also have your own function to do fancy splits.
135 This variable has no effect when buffer-A/B are shown in different frames.
136 In this case, Ediff will use those frames to display these buffers."
141 "*The function used to split the main window between buffer-A and buffer-B.
142 You can set it to a vertical split instead of the default horizontal split
143 by setting this variable to `split-window-vertically'.
144 You can also have your own function to do fancy splits.
145 This variable has no effect when buffer-A/B/C are shown in different frames.
146 In this case, Ediff will use those frames to display these buffers."
153 ;;'(unsplittable . t)
163 ;; don't lower but auto-raise
167 ;; make initial frame small to avoid distraction
169 ;; this blocks queries from window manager as to where to put
170 ;; ediff's control frame. we put the frame outside the display,
171 ;; so the initial frame won't jump all over the screen
178 )
179 "Frame parameters for displaying Ediff Control Panel.
182 ;; position of the mouse; used to decide whether to warp the mouse into ctl
183 ;; frame
186 ;; not used for now
188 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
191 "*If t, Ediff will always grab the mouse and put it in the control frame.
192 If 'maybe, Ediff will do it sometimes, but not after operations that require
193 relatively long time. If nil, the mouse will be entirely user's
194 responsibility."
199 "Function to call to determine the desired location for the control panel.
200 Expects three parameters: the control buffer, the desired width and height
201 of the control frame. It returns an association list
202 of the form \(\(top . <position>\) \(left . <position>\)\)"
207 "*The upward shift of control frame from the top of buffer A's frame.
208 Measured in pixels.
209 This is used by the default control frame positioning function,
210 `ediff-make-frame-position'. This variable is provided for easy
211 customization of the default control frame positioning."
216 "*The leftward shift of control frame from the right edge of buf A's frame.
217 Measured in characters.
218 This is used by the default control frame positioning function,
219 `ediff-make-frame-position' to adjust the position of the control frame
220 when it shows the short menu. This variable is provided for easy
221 customization of the default."
226 "*The rightward shift of control frame from the left edge of buf A's frame.
227 Measured in characters.
228 This is used by the default control frame positioning function,
229 `ediff-make-frame-position' to adjust the position of the control frame
230 when it shows the full menu. This variable is provided for easy
231 customization of the default."
236 ;; Wide frame display
238 ;; t means Ediff is using wide display
240 ;; keeps frame config for toggling wide display
242 "Frame parameters to be restored when the user wants to toggle the wide
247 "The value is a function that is called to create a wide display.
248 The function is called without arguments. It should resize the frame in
249 which buffers A, B, and C are to be displayed, and it should save the old
250 frame parameters in `ediff-wide-display-orig-parameters'.
251 The variable `ediff-wide-display-frame' should be set to contain
254 ;; Frame used for the control panel in a windowing system.
258 "*If t, keep control panel iconified when help message is off.
259 This has effect only on a windowing system.
260 If t, hitting `?' to toggle control panel off iconifies it.
262 This is only useful in Emacs and only for certain kinds of window managers,
263 such as TWM and its derivatives, since the window manager must permit
264 keyboard input to go into icons. XEmacs completely ignores keyboard input
265 into icons, regardless of the window manager."
269 ;;; Functions
283 )
284 )
285 ))
288 ;; Select the lowest window on the frame.
292 ;; emacs
312 ))
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 ;; Set up windows using the correct method based on the current window system.
344 ;; Just set up 3 windows.
345 ;; Usually used without windowing systems
346 ;; With windowing, we want to use dedicated frames.
352 buffer-A buffer-B buffer-C control-buffer)
354 buffer-A buffer-B buffer-C control-buffer)))
357 ;; skip dedicated and unsplittable frames
360 split-window-function
361 merge-window-share merge-window-lines
362 wind-A wind-B wind-C)
365 ;; this lets us have local versions of ediff-split-window-function
366 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))
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
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 nil ; emacs
912 )
913 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
919 old-ctl-frame
921 ediff-control-frame ctl-frame)
922 ;; protect against undefined face-attribute
925 nil ; xemacs
928 )
930 )
935 ()
939 ;; must be before ediff-setup-control-buffer
940 ;; just a precaution--we should be in ctl-buffer already
951 dont-iconify-ctl-frame))
953 ;; 1 more line for the modeline
955 fheight lines
958 adjusted-parameters
960 ;; possibly change surrogate minibuffer
963 designated-minibuffer-frame))
967 ))
969 ;; adjust autoraise
974 adjusted-parameters))
976 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
977 ;; are changed.
985 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
988 )
989 nil ; emacs
990 )
991 )
993 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
994 ;; to make sure that at least once we do it for non-iconified frame. If
995 ;; appears that in the OS/2 port of Emacs, one can't modify frame
996 ;; parameters of iconified frames. As a precaution, we do likewise for
997 ;; windows-nt.
1001 ;; make or zap toolbar (if not requested)
1009 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1010 ;; iconified, the current buffer changes to that of the frame that
1011 ;; becomes exposed as a result of this iconification.
1012 ;; So, we make sure the current buffer doesn't change.
1024 ;; Now move the frame. We must do it separately due to an obscure bug in
1025 ;; XEmacs
1027 ctl-frame
1030 ;; synchronize so the cursor will move to control frame
1031 ;; per RMS suggestion
1040 ;; don't warp the mouse, unless ediff-grab-mouse = t
1049 nil ; emacs
1050 )
1053 ))
1057 ))
1067 nil ; emacs
1068 )
1071 )))
1073 ;;(ediff-reset-mouse nil)
1074 )
1077 ;; finds a good place to clip control frame
1086 horizontal-adjustment upward-adjustment
1087 ctl-frame-top ctl-frame-left)
1089 ;; Multiple control frames are clipped based on the value of
1090 ;; ediff-control-buffer-number. This is done in order not to obscure
1091 ;; other active control panels.
1097 ctl-frame-left
1098 (+ frame-A-left
1101 (+ ediff-wide-control-frame-rightward-shift
1102 horizontal-adjustment))
1105 (+ ctl-frame-width
1106 ediff-narrow-control-frame-leftward-shift
1107 horizontal-adjustment))))))
1113 ctl-frame-left
1117 ;; keep ctl frame within the visible bounds
1123 )))
1131 "Construct an alist of parameters for the wide display.
1132 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1133 The frame to be resized is kept in `ediff-wide-display-frame'.
1134 This function modifies only the left margin and the width of the display.
1135 It assumes that it is called from within the control buffer."
1145 ediff-wide-display-frame frame-A)
1150 ;; Revise the mode line to display which difference we have selected
1151 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1152 ;; anothe invocations of Ediff.
1176 ediff-current-difference)
1177 " AncestorEmpty"
1179 )
1182 buf-B-state-diff ""
1185 ;; control buffer format
1190 ;; control buffer id
1195 ;; Force mode-line redisplay
1223 ;; we keep the second dummy string in the mode line format of the
1224 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1225 ;; ediff-strip-mode-line-format expects that.
1235 mode-line-format))))
1236 ))
1241 ;; set frame/icon titles for Emacs
1243 ediff-control-frame
1246 ))
1247 ;; set frame/icon titles for XEmacs
1250 ;; force an update of the frame title
1257 " "
1266 ediff-number-of-differences)))))
1271 ediff-control-buffer-suffix))
1276 ediff-number-of-differences)))
1279 ediff-number-of-differences)))
1283 ediff-number-of-differences)))))
1287 ;; If buff is not live, return nil
1295 ;;; Functions to decide when to redraw windows
1309 ;; if buffer C is defined then take it into account
1318 ctl-wind A-wind B-wind C-wind
1319 ediff-split-window-function
1321 ediff-wide-display-p)))))))
1327 ;;; Local Variables:
1328 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1329 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1330 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1331 ;;; End:
1333 ;;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1334 ;;; ediff-wind.el ends here