| blob | 749ca89a4f509e5a6c136786f56d232486a463c9 |
1 ;;; ediff-wind.el --- window manipulation utilities
2 ;;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
4 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to
20 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 'ediff-setup-windows-multiframe
29 "*Function called to set up windows.
30 Ediff provides a choice of two functions: ediff-setup-windows-plain, for
31 doing everything in one frame, and ediff-setup-windows-multiframe,
32 which sets the control panel in a separate frame. Also, if the latter
33 function detects that one of the buffers A/B is seen in some other frame,
34 it will try to keep that buffer in that frame.
36 If you don't like the two functions provided---write your own one.
37 The basic guidelines:
38 1. It should leave the control buffer current and the control window
39 selected.
40 2. It should set ediff-window-A, ediff-window-B, ediff-window-C,
41 and ediff-control-window to contain window objects that display
42 the corresponding buffers.
43 3. It should accept the following arguments:
44 buffer-A, buffer-B, buffer-C, control-buffer
45 Buffer C may not be used in jobs that compare only two buffers.
46 If you plan to do something fancy, take a close look at how the two
49 ;; indicates if we are in a multiframe setup
52 ;; Share of the frame occupied by the merge window (buffer C)
55 ;; The control window.
57 ;; Official window for buffer A
59 ;; Official window for buffer B
61 ;; Official window for buffer C
63 ;; Ediff's window configuration.
64 ;; Used to minimize the need to rearrange windows.
69 "*The function used to split the main window between buffer-A and buffer-B.
70 You can set it to a horizontal split instead of the default vertical split
71 by setting this variable to `split-window-horizontally'.
72 You can also have your own function to do fancy splits.
73 This variable has no effect when buffer-A/B are shown in different frames.
77 "*The function used to split the main window between buffer-A and buffer-B.
78 You can set it to a vertical split instead of the default horizontal split
79 by setting this variable to `split-window-vertically'.
80 You can also have your own function to do fancy splits.
81 This variable has no effect when buffer-A/B/C are shown in different frames.
88 ;;'(unsplittable . t)
95 ;; don't lower and auto-raise
98 ;; this blocks queries from window manager as to where to put
99 ;; ediff's control frame. we put the frame outside the display,
100 ;; so the initial frame won't jump all over the screen
107 ))
108 "Frame parameters for displaying Ediff Control Panel.
111 ;; position of the mouse; used to decide whether to warp the mouse into ctl
112 ;; frame
115 ;; not used for now
117 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
120 "*If t, Ediff will always grab the mouse and put it in the control frame.
121 If 'maybe, Ediff will do it sometimes, but not after operations that require
122 relatively long time. If nil, the mouse will be entirely user's
126 "Function to call to determine the desired location for the control panel.
127 Expects three parameters: the control buffer, the desired width and height
128 of the control frame. It returns an association list
132 "*The upward shift of control frame from the top of buffer A's frame.
133 Measured in pixels.
134 This is used by the default control frame positioning function,
135 `ediff-make-frame-position'. This variable is provided for easy
139 "*The leftward shift of control frame from the right edge of buf A's frame.
140 Measured in characters.
141 This is used by the default control frame positioning function,
142 `ediff-make-frame-position' to adjust the position of the control frame
143 when it shows the short menu. This variable is provided for easy
147 "*The rightward shift of control frame from the left edge of buf A's frame.
148 Measured in characters.
149 This is used by the default control frame positioning function,
150 `ediff-make-frame-position' to adjust the position of the control frame
151 when it shows the full menu. This variable is provided for easy
155 ;; Wide frame display
157 ;; t means Ediff is using wide display
159 ;; keeps frame config for toggling wide display
161 "Frame parameters to be restored when the user wants to toggle the wide
166 "The value is a function that is called to create a wide display.
167 The function is called without arguments. It should resize the frame in
168 which buffers A, B, and C are to be displayed, and it should save the old
169 frame parameters in `ediff-wide-display-orig-parameters'.
170 The variable `ediff-wide-display-frame' should be set to contain
173 ;; Frame used for the control panel in a windowing system.
177 "*If t, keep control panel iconified when help message is off.
178 This has effect only on a windowing system.
179 If t, hiting `?' to toggle control panel off iconifies it.
181 This is only useful in Emacs and only for certain kinds of window managers,
182 such as TWM and its derivatives, since the window manager must permit
183 keyboard input to go into icons. XEmacs completely ignores keyboard input
186 ;;; Functions
200 ))
203 ;; Select the lowest window on the frame.
228 ;;; Common window setup routines
230 ;; Set up the window configuration. If POS is given, set the points to
231 ;; the beginnings of the buffers.
232 ;; When 3way comparison is added, this will have to choose the appropriate
233 ;; setup function based on ediff-job-name
235 ;; Make sure we are not in the minibuffer window when we try to delete
236 ;; all other windows.
241 ;; in case user did a no-no on a tty
248 buffer-A buffer-B buffer-C control-buffer))
251 ;; Just set up 3 windows.
252 ;; Usually used without windowing systems
253 ;; With windowing, we want to use dedicated frames.
259 buffer-A buffer-B buffer-C control-buffer)
261 buffer-A buffer-B buffer-C control-buffer)))
264 ;; skip dedicated and unsplittable frames
267 split-window-function
268 merge-window-share merge-window-lines
269 wind-A wind-B wind-C)
272 ;; this lets us have local versions of ediff-split-window-function
273 split-window-function ediff-split-window-function))
279 ;; go to the upper window and split it betw A, B, and possibly C
286 ;; XEmacs used to have a lot of trouble with display
287 ;; It did't set things right unless we tell it to sit still
288 ;; 19.12 seems ok.
289 ;;(if ediff-xemacs-p (sit-for 0))
307 ediff-window-B wind-B
308 ediff-window-C wind-C))
312 ))
315 ;; This function handles all comparison jobs, including 3way jobs
317 ;; skip dedicated and unsplittable frames
320 split-window-function wind-width-or-height
321 three-way-comparison
322 wind-A-start wind-B-start wind-A wind-B wind-C)
330 ;; this lets us have local versions of ediff-split-window-function
331 split-window-function ediff-split-window-function
332 three-way-comparison ediff-3way-comparison-job))
338 ;; go to the upper window and split it betw A, B, and possibly C
349 ;; XEmacs used to have a lot of trouble with display
350 ;; It did't set things right unless we told it to sit still
351 ;; 19.12 seems ok.
352 ;;(if ediff-xemacs-p (sit-for 0))
371 ediff-window-B wind-B
372 ediff-window-C wind-C))
374 ;; It is unlikely that we will want to implement 3way window comparison.
375 ;; So, only buffers A and B are used here.
383 ))
386 ;; dispatch the appropriate window setup function
395 ;;; Algorithm:
396 ;;; If A and B are in the same frame but C's frame is different--- use one
397 ;;; frame for A and B and use a separate frame for C.
398 ;;; If C's frame is non-existent, then: if the first suitable
399 ;;; non-dedicated frame is different from A&B's, then use it for C.
400 ;;; Otherwise, put A,B, and C in one frame.
401 ;;; If buffers A, B, C are is separate frames, use them to display these
402 ;;; buffers.
404 ;; Skip dedicated or iconified frames.
405 ;; Unsplittable frames are taken care of later.
415 ;; on wide display, do things in one frame
418 ;; this lets us have local versions of ediff-split-window-function
430 ))
434 ediff-merge-window-share))
435 merge-window-lines
436 designated-minibuffer-frame
437 done-A done-B done-C)
439 ;; buf-A on its own
450 ;; buf-B on its own
459 ;; buf-C on its own
482 done-B t)))
487 ;; avoid dedicated and non-splittable windows
491 wind-B nil
492 wind-C nil
495 ;; set the right frame
506 ;; XEmacs used to have a lot of trouble with display
507 ;; It did't set things right unless we told it to catch breath
508 ;;(if ediff-xemacs-p (sit-for 0))
526 done-B t
527 done-C t)
528 ))
536 ))
543 ))
551 ))
555 ediff-window-B wind-B
556 ediff-window-C wind-C)
558 designated-minibuffer-frame
562 ))
565 ;; Window setup for all comparison jobs, including 3way comparisons
567 ;;; Algorithm:
568 ;;; If a buffer is seen in a frame, use that frame for that buffer.
569 ;;; If it is not seen, use the current frame.
570 ;;; If both buffers are not seen, they share the current frame. If one
571 ;;; of the buffers is not seen, it is placed in the current frame (where
572 ;;; ediff started). If that frame is displaying the other buffer, it is
573 ;;; shared between the two buffers.
574 ;;; However, if we decide to put both buffers in one frame
575 ;;; and the selected frame isn't splittable, we create a new frame and
576 ;;; put both buffers there, event if one of this buffers is visible in
577 ;;; another frame.
579 ;; Skip dedicated or iconified frames.
580 ;; Unsplittable frames are taken care of later.
592 ;; on wide display, do things in one frame
595 ;; this lets us have local versions of ediff-split-window-function
615 wind-A-start wind-B-start
616 designated-minibuffer-frame
617 done-A done-B done-C)
653 ;; this affects 3way setups only
654 wind-width-or-height)
655 ;; avoid dedicated and non-splittable windows
659 wind-B nil
660 wind-C nil
663 ;; set the right frame
672 ;; XEmacs used to have a lot of trouble with display
673 ;; It didn't set things right unless we told it to catch breath
674 ;;(if ediff-xemacs-p (sit-for 0))
678 (/
698 done-B t
699 done-C t)
700 ))
708 ))
715 ))
724 )))
728 ediff-window-B wind-B
729 ediff-window-C wind-C)
732 designated-minibuffer-frame
735 ;; It is unlikely that we'll implement ediff-windows that would compare
736 ;; 3 windows at once. So, we don't use buffer C here.
743 ))
745 ;; skip unsplittable and dedicated windows
746 ;; create a new splittable frame if none is found
755 nil
757 ;; remember where started
759 ;; try new window
762 ;; fed up, no appropriate frame
764 ;;(redraw-display)
767 ;; Prepare or refresh control frame
770 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
771 ctl-frame old-ctl-frame lines user-grabbed-mouse
772 fheight fwidth adjusted-parameters)
776 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
780 ;; Delete the old ctl frame and get a new ctl frame.
781 ;; The old ctl frame is deleted to let emacs reset default minibuffer
782 ;; frame or when the ctl frame needs to be moved.
783 ;; The old frame isn't reused, since ediff-setup-control-frame is called
784 ;; very rarely, so the overhead is minimal.
786 ;;(redraw-display)
787 ;; new ctl frame should be created while ctl-buff is current, so that
788 ;; the local default-minibuffer-frame will be consulted and
789 ;; that ediff-control-frame-parameters will have the right value.
793 ediff-control-frame ctl-frame)))
798 ()
802 ;; must be before ediff-setup-control-buffer
803 ;; just a precaution--we should be in ctl-buffer already
814 dont-iconify-ctl-frame))
816 ;; 1 more line for the modeline
820 fheight lines
827 ediff-control-frame-position-function
828 ctl-buffer fwidth fheight)))
833 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
834 ;; are changed.
841 ;; XEmacs needed a redisplay, as it had trouble setting
842 ;; height correctly otherwise.
843 ;;(sit-for 0)
844 ))
846 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in
847 ;; order to make sure that at least once we do it for non-iconified
848 ;; frame. If appears that in the OS/2 port of Emacs, one can't modify
849 ;; frame parameters of iconified frames.
857 ;; This works around a bug in 19.25 and earlier. There, if frame gets
858 ;; iconified, the current buffer changes to that of the frame that
859 ;; becomes exposed as a result of this iconification.
860 ;; So, we make sure the current buffer doesn't change.
874 ;; resynch so the cursor will move to control frame
875 ;; per RMS suggestion
883 ;; don't warp the mouse, unless ediff-grab-mouse = t
890 ))
894 ))
904 )))
906 ;;(ediff-reset-mouse nil)
907 )
910 ;; finds a good place to clip control frame
919 horizontal-adjustment upward-adjustment
920 ctl-frame-top ctl-frame-left)
922 ;; Multiple control frames are clipped based on the value of
923 ;; ediff-control-buffer-number. This is done in order not to obscure
924 ;; other active control panels.
930 ctl-frame-left
931 (+ frame-A-left
934 (+ ediff-wide-control-frame-rightward-shift
935 horizontal-adjustment))
938 (+ ctl-frame-width
939 ediff-narrow-control-frame-leftward-shift
940 horizontal-adjustment))))))
941 ;; keep ctl frame within the visible bounds
949 ctl-frame-left
956 )))
964 "Construct an alist of parameters for the wide display.
965 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
966 The frame to be resized is kept in `ediff-wide-display-frame'.
967 This function modifies only the left margin and the width of the display.
968 It assumes that it is called from within the control buffer."
978 ediff-wide-display-frame frame-A)
984 ;; Revise the mode line to display which difference we have selected
985 ;; Also resets modelines of buffers A/B, since they may be clobbered by
986 ;; anothe invocations of Ediff.
1010 ediff-current-difference)
1011 " AncestorEmpty"
1013 )
1016 buf-B-state-diff ""
1019 ;; control buffer format
1022 mode-line-buffer-identification
1024 ;; control buffer id
1029 ;; Force mode-line redisplay
1057 ;; we keep the second dummy string in the mode line format of the
1058 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1059 ;; ediff-strip-mode-line-format expects that.
1069 mode-line-format))))
1070 ))
1077 ;; the emacs part will be modified once the 'name and 'title
1078 ;; frame parameters are separated
1081 ediff-control-frame
1083 ;; force an update of the frame title
1090 " "
1093 ediff-control-buffer-suffix))
1101 ediff-number-of-differences)))))
1106 ediff-number-of-differences)))
1109 ediff-number-of-differences)))
1113 ediff-number-of-differences)))))
1117 ;; If buff is not live, return nil
1124 ;;; Functions to decide when to redraw windows
1139 ;; if buffer C is defined then take it into account
1148 ctl-wind A-wind B-wind C-wind
1149 ediff-split-window-function
1151 ediff-wide-display-p)))))))
1157 ;;; ediff-wind.el ends here