| blob | 8da752a15298159c59c821fd6958c8ec34e598d5 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994-1997, 2000-2015 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
47 ;; end pacifier
50 ;; be careful with ediff-tbar
57 "Ediff window manipulation."
63 ;; 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 three functions:
73 (1) `ediff-setup-windows-multiframe', which sets the control panel
74 in a separate frame.
75 (2) `ediff-setup-windows-plain', which does everything in one frame
76 (3) `ediff-setup-windows-default' (the default), which does (1)
77 on a graphical display and (2) on a text terminal.
80 between the multiframe display and the single frame display. If
81 the multiframe function detects that one of the buffers A/B is
82 seen in some other frame, it will try to keep that buffer in that
83 frame.
85 If you don't like any of the two provided functions, write your own one.
86 The basic guidelines:
87 1. It should leave the control buffer current and the control window
88 selected.
89 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
90 and `ediff-control-window' to contain window objects that display
91 the corresponding buffers.
92 3. It should accept the following arguments:
93 buffer-A, buffer-B, buffer-C, control-buffer
94 Buffer C may not be used in jobs that compare only two buffers.
95 If you plan to do something fancy, take a close look at how the two
96 provided functions are written."
104 ;; indicates if we are in a multiframe setup
107 ;; Share of the frame occupied by the merge window (buffer C)
110 ;; The control window.
112 ;; Official window for buffer A
114 ;; Official window for buffer B
116 ;; Official window for buffer C
118 ;; Ediff's window configuration.
119 ;; Used to minimize the need to rearrange windows.
122 ;; Association between buff-type and ediff-window-*
133 "The function used to split the main window between buffer-A and buffer-B.
134 You can set it to a horizontal split instead of the default vertical split
135 by setting this variable to `split-window-horizontally'.
136 You can also have your own function to do fancy splits.
137 This variable has no effect when buffer-A/B are shown in different frames.
138 In this case, Ediff will use those frames to display these buffers."
142 function)
146 "The function used to split the main window between buffer-A and buffer-B.
147 You can set it to a vertical split instead of the default horizontal split
148 by setting this variable to `split-window-vertically'.
149 You can also have your own function to do fancy splits.
150 This variable has no effect when buffer-A/B/C are shown in different frames.
151 In this case, Ediff will use those frames to display these buffers."
155 function)
158 ;; Definitions hidden from the compiler by compat wrappers.
165 ;;'(unsplittable . t)
175 ;; don't lower but auto-raise
179 ;; make initial frame small to avoid distraction
181 ;; this blocks queries from window manager as to where to put
182 ;; ediff's control frame. we put the frame outside the display,
183 ;; so the initial frame won't jump all over the screen
190 )
191 "Frame parameters for displaying Ediff Control Panel.
194 ;; position of the mouse; used to decide whether to warp the mouse into ctl
195 ;; frame
198 ;; not used for now
200 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
203 "If t, Ediff will always grab the mouse and put it in the control frame.
204 If `maybe', Ediff will do it sometimes, but not after operations that require
205 relatively long time. If nil, the mouse will be entirely user's
206 responsibility."
211 "Function to call to determine the desired location for the control panel.
212 Expects three parameters: the control buffer, the desired width and height
213 of the control frame. It returns an association list
214 of the form \((top . <position>) \(left . <position>))"
219 "The upward shift of control frame from the top of buffer A's frame.
220 Measured in pixels.
221 This is used by the default control frame positioning function,
222 `ediff-make-frame-position'. This variable is provided for easy
223 customization of the default control frame positioning."
228 "The leftward shift of control frame from the right edge of buf A's frame.
229 Measured in characters.
230 This is used by the default control frame positioning function,
231 `ediff-make-frame-position' to adjust the position of the control frame
232 when it shows the short menu. This variable is provided for easy
233 customization of the default."
238 "The rightward shift of control frame from the left edge of buf A's frame.
239 Measured in characters.
240 This is used by the default control frame positioning function,
241 `ediff-make-frame-position' to adjust the position of the control frame
242 when it shows the full menu. This variable is provided for easy
243 customization of the default."
248 ;; Wide frame display
250 ;; t means Ediff is using wide display
252 ;; keeps frame config for toggling wide display
254 "Frame parameters to be restored when the user wants to toggle the wide
259 "The value is a function that is called to create a wide display.
260 The function is called without arguments. It should resize the frame in
261 which buffers A, B, and C are to be displayed, and it should save the old
262 frame parameters in `ediff-wide-display-orig-parameters'.
263 The variable `ediff-wide-display-frame' should be set to contain
266 ;; Frame used for the control panel in a windowing system.
270 "If t, keep control panel iconified when help message is off.
271 This has effect only on a windowing system.
272 If t, hitting `?' to toggle control panel off iconifies it.
274 This is only useful in Emacs and only for certain kinds of window managers,
275 such as TWM and its derivatives, since the window manager must permit
276 keyboard input to go into icons. XEmacs completely ignores keyboard input
277 into icons, regardless of the window manager."
281 ;;; Functions
297 ;; Select the lowest window on the frame.
312 lowest-window this-window))
319 ;;; Common window setup routines
321 ;; Set up the window configuration. If POS is given, set the points to
322 ;; the beginnings of the buffers.
323 ;; When 3way comparison is added, this will have to choose the appropriate
324 ;; setup function based on ediff-job-name
326 ;; Make sure we are not in the minibuffer window when we try to delete
327 ;; all other windows.
332 ;; in case user did a no-no on a tty
339 buffer-A buffer-B buffer-C control-buffer))
344 'ediff-setup-windows-multiframe
346 buffer-A buffer-B buffer-C control-buffer))
348 ;; Just set up 3 windows.
349 ;; Usually used without windowing systems
350 ;; With windowing, we want to use dedicated frames.
356 buffer-A buffer-B buffer-C control-buffer)
358 buffer-A buffer-B buffer-C control-buffer)))
363 ;; skip dedicated and unsplittable frames
366 split-window-function
367 merge-window-share merge-window-lines
368 wind-A wind-B wind-C)
371 ;; this lets us have local versions of ediff-split-window-function
372 split-window-function ediff-split-window-function))
379 ;; go to the upper window and split it betw A, B, and possibly C
386 ;; XEmacs used to have a lot of trouble with display
387 ;; It did't set things right unless we tell it to sit still
388 ;; 19.12 seems ok.
389 ;;(if (featurep 'xemacs) (sit-for 0))
407 ediff-window-B wind-B
408 ediff-window-C wind-C))
412 ))
415 ;; This function handles all comparison jobs, including 3way jobs
417 ;; skip dedicated and unsplittable frames
420 split-window-function wind-width-or-height
421 three-way-comparison
422 wind-A-start wind-B-start wind-A wind-B wind-C)
430 ;; this lets us have local versions of ediff-split-window-function
431 split-window-function ediff-split-window-function
432 three-way-comparison ediff-3way-comparison-job))
433 ;; if in minibuffer go somewhere else
443 ;; go to the upper window and split it betw A, B, and possibly C
454 ;; XEmacs used to have a lot of trouble with display
455 ;; It did't set things right unless we told it to sit still
456 ;; 19.12 seems ok.
457 ;;(if (featurep 'xemacs) (sit-for 0))
476 ediff-window-B wind-B
477 ediff-window-C wind-C))
479 ;; It is unlikely that we will want to implement 3way window comparison.
480 ;; So, only buffers A and B are used here.
488 ))
491 ;; dispatch an appropriate window setup function
500 ;;; Algorithm:
501 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
502 ;;; destroy dedicated windows.
503 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
504 ;;; frame for A and B and use a separate frame for C.
505 ;;; 3. If C's frame is non-existent, then: if the first suitable
506 ;;; non-dedicated frame is different from A&B's, then use it for C.
507 ;;; Otherwise, put A,B, and C in one frame.
508 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
509 ;;; buffers.
511 ;; Skip dedicated or iconified frames.
512 ;; Unsplittable frames are taken care of later.
522 ;; on wide display, do things in one frame
525 ;; this lets us have local versions of ediff-split-window-function
531 ;; A and C must be in one frame
533 ;; B and C must be in one frame
535 ;; A or B is not visible
538 ;; A or B is not suitable for display
541 ;; A and B in the same frame, and no good frame
542 ;; for C
545 ))
546 ;; use-same-frame-for-AB implies wind A and B are ok for display
550 ediff-merge-window-share))
551 merge-window-lines
552 designated-minibuffer-frame
553 done-A done-B done-C)
555 ;; buf-A on its own
560 ;; buffer buf-A is seen in live wind-A
566 ;; buf-B on its own
571 ;; buffer buf-B is seen in live wind-B
577 ;; buf-C on its own
582 ;; buffer buf-C is seen in live wind-C
591 ;; wind-A must already be displaying buf-A
603 done-B t)))
611 ;; avoid dedicated and non-splittable windows
635 done-B t
636 done-C t)
637 ))
640 ;;; or it was set before because use-same-frame = 1
642 ;; Buf-A was not set up yet as it wasn't visible,
643 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
648 ))
650 ;;; or it was set before because use-same-frame = 1
652 ;; Buf-B was not set up yet as it wasn't visible
653 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
658 ))
661 ;;; or it was set before because use-same-frame = 1
663 ;; Buf-C was not set up yet as it wasn't visible
664 ;; and use-same-frame = nil
669 ))
673 ediff-window-B wind-B
674 ediff-window-C wind-C)
676 designated-minibuffer-frame
680 ))
683 ;; Window setup for all comparison jobs, including 3way comparisons
685 ;;; Algorithm:
686 ;;; If a buffer is seen in a frame, use that frame for that buffer.
687 ;;; If it is not seen, use the current frame.
688 ;;; If both buffers are not seen, they share the current frame. If one
689 ;;; of the buffers is not seen, it is placed in the current frame (where
690 ;;; ediff started). If that frame is displaying the other buffer, it is
691 ;;; shared between the two buffers.
692 ;;; However, if we decide to put both buffers in one frame
693 ;;; and the selected frame isn't splittable, we create a new frame and
694 ;;; put both buffers there, event if one of this buffers is visible in
695 ;;; another frame.
697 ;; Skip dedicated or iconified frames.
698 ;; Unsplittable frames are taken care of later.
710 ;; on wide display, do things in one frame
713 ;; this lets us have local versions of ediff-split-window-function
736 wind-A-start wind-B-start
737 designated-minibuffer-frame
738 done-A done-B done-C)
750 ;; buffer buf-A is seen in live wind-A
758 ;; buffer buf-B is seen in live wind-B
766 ;; buffer buf-C is seen in live wind-C
776 ;; avoid dedicated and non-splittable windows
784 (/
804 done-B t
805 done-C t)
806 ))
809 ;;; or it was set before because use-same-frame = 1
811 ;; Buf-A was not set up yet as it wasn't visible,
812 ;; and use-same-frame = nil
817 ))
819 ;;; or it was set before because use-same-frame = 1
821 ;; Buf-B was not set up yet as it wasn't visible,
822 ;; and use-same-frame = nil
827 ))
831 ;;; or it was set before because use-same-frame = 1
833 ;; Buf-C was not set up yet as it wasn't visible,
834 ;; and use-same-frame = nil
839 )))
843 ediff-window-B wind-B
844 ediff-window-C wind-C)
847 designated-minibuffer-frame
850 ;; It is unlikely that we'll implement a version of ediff-windows that
851 ;; would compare 3 windows at once. So, we don't use buffer C here.
858 ))
860 ;; skip unsplittable frames and frames that have dedicated windows.
861 ;; create a new splittable frame if none is found
865 seen-windows)
870 ;; skip small windows
874 nil
876 ;; remember history
878 ;; try new window
881 )
883 ;; fed up, no appropriate frames
887 )))
894 'ignore-minibuffer
895 frame)
896 ans))
898 ;; window is ok, if it is only one window on the frame, not counting the
899 ;; minibuffer, or none of the frame's windows is dedicated.
900 ;; The idea is that it is bad to destroy dedicated windows while creating an
901 ;; ediff window setup
906 ;; only one window
908 ;; none is dedicated (in multiframe setup)
910 )))
914 ;; Prepare or refresh control frame
917 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
918 ctl-frame old-ctl-frame lines
919 ;; user-grabbed-mouse
920 fheight fwidth adjusted-parameters)
925 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
931 old-ctl-frame
933 ediff-control-frame ctl-frame)
934 ;; protect against undefined face-attribute
943 ()
947 ;; must be before ediff-setup-control-buffer
948 ;; just a precaution--we should be in ctl-buffer already
959 dont-iconify-ctl-frame))
961 ;; 1 more line for the mode line
963 fheight lines
966 adjusted-parameters
968 ;; possibly change surrogate minibuffer
971 designated-minibuffer-frame))
975 ))
977 ;; adjust autoraise
982 adjusted-parameters))
984 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
985 ;; are changed.
992 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
996 ;; As a precaution, we call modify frame parameters twice, in
997 ;; order to make sure that at least once we do it for
998 ;; a non-iconified frame. (It appears that in the Windows port of
999 ;; Emacs, one can't modify frame parameters of iconified frames.)
1003 ;; make or zap toolbar (if not requested)
1011 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1012 ;; iconified, the current buffer changes to that of the frame that
1013 ;; becomes exposed as a result of this iconification.
1014 ;; So, we make sure the current buffer doesn't change.
1026 ;; Now move the frame. We must do it separately due to an obscure bug in
1027 ;; XEmacs
1029 ctl-frame
1032 ;; synchronize so the cursor will move to control frame
1033 ;; per RMS suggestion
1042 ;; don't warp the mouse, unless ediff-grab-mouse = t
1067 ;;(ediff-reset-mouse nil)
1068 )
1071 ;; finds a good place to clip control frame
1080 horizontal-adjustment upward-adjustment
1081 ctl-frame-top ctl-frame-left)
1083 ;; Multiple control frames are clipped based on the value of
1084 ;; ediff-control-buffer-number. This is done in order not to obscure
1085 ;; other active control panels.
1091 ctl-frame-left
1092 (+ frame-A-left
1095 (+ ediff-wide-control-frame-rightward-shift
1096 horizontal-adjustment))
1099 (+ ctl-frame-width
1100 ediff-narrow-control-frame-leftward-shift
1101 horizontal-adjustment))))))
1107 ctl-frame-left
1111 ;; keep ctl frame within the visible bounds
1117 )))
1125 "Construct an alist of parameters for the wide display.
1126 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1127 The frame to be resized is kept in `ediff-wide-display-frame'.
1128 This function modifies only the left margin and the width of the display.
1129 It assumes that it is called from within the control buffer."
1139 ediff-wide-display-frame frame-A)
1144 ;; Revise the mode line to display which difference we have selected
1145 ;; Also resets mode lines of buffers A/B, since they may be clobbered by
1146 ;; other invocations of Ediff.
1170 ediff-current-difference)
1171 " AncestorEmpty"
1173 )
1176 buf-B-state-diff ""
1179 ;; control buffer format
1184 ;; control buffer id
1189 ;; Force mode-line redisplay
1217 ;; we keep the second dummy string in the mode line format of the
1218 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1219 ;; ediff-strip-mode-line-format expects that.
1229 mode-line-format))))
1230 ))
1235 ;; set frame/icon titles for Emacs
1237 ediff-control-frame
1240 ))
1241 ;; set frame/icon titles for XEmacs
1244 ;; force an update of the frame title
1251 " "
1260 ediff-number-of-differences)))))
1265 ediff-control-buffer-suffix))
1270 ediff-number-of-differences)))
1273 ediff-number-of-differences)))
1277 ediff-number-of-differences)))))
1281 ;; If buff is not live, return nil
1289 ;;; Functions to decide when to redraw windows
1303 ;; if buffer C is defined then take it into account
1312 ctl-wind A-wind B-wind C-wind
1313 ediff-split-window-function
1315 ediff-wide-display-p)))))))
1321 ;; Local Variables:
1322 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1323 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1324 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1325 ;; End:
1327 ;;; ediff-wind.el ends here