| blob | 81109906262d7e41c03882dd92a46c998673f201 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994-1997, 2000-2013 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
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.
68 'ediff-setup-windows-multiframe
72 "Function called to set up windows.
73 Ediff provides a choice of three functions:
74 (1) `ediff-setup-windows-multiframe', which sets the control panel
75 in a separate frame.
76 (2) `ediff-setup-windows-plain', which does everything in one frame
77 (3) `ediff-setup-windows-default' (the default), which does (1)
78 on a graphical display and (2) on a text terminal.
81 between the multiframe display and the single frame display. If
82 the multiframe function detects that one of the buffers A/B is
83 seen in some other frame, it will try to keep that buffer in that
84 frame.
86 If you don't like any of the two provided functions, write your own one.
87 The basic guidelines:
88 1. It should leave the control buffer current and the control window
89 selected.
90 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
91 and `ediff-control-window' to contain window objects that display
92 the corresponding buffers.
93 3. It should accept the following arguments:
94 buffer-A, buffer-B, buffer-C, control-buffer
95 Buffer C may not be used in jobs that compare only two buffers.
96 If you plan to do something fancy, take a close look at how the two
97 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))
345 'ediff-setup-windows-multiframe
347 buffer-A buffer-B buffer-C control-buffer))
349 ;; Just set up 3 windows.
350 ;; Usually used without windowing systems
351 ;; With windowing, we want to use dedicated frames.
357 buffer-A buffer-B buffer-C control-buffer)
359 buffer-A buffer-B buffer-C control-buffer)))
362 ;; skip dedicated and unsplittable frames
365 split-window-function
366 merge-window-share merge-window-lines
367 wind-A wind-B wind-C)
370 ;; this lets us have local versions of ediff-split-window-function
371 split-window-function ediff-split-window-function))
378 ;; go to the upper window and split it betw A, B, and possibly C
385 ;; XEmacs used to have a lot of trouble with display
386 ;; It did't set things right unless we tell it to sit still
387 ;; 19.12 seems ok.
388 ;;(if (featurep 'xemacs) (sit-for 0))
406 ediff-window-B wind-B
407 ediff-window-C wind-C))
411 ))
414 ;; This function handles all comparison jobs, including 3way jobs
416 ;; skip dedicated and unsplittable frames
419 split-window-function wind-width-or-height
420 three-way-comparison
421 wind-A-start wind-B-start wind-A wind-B wind-C)
429 ;; this lets us have local versions of ediff-split-window-function
430 split-window-function ediff-split-window-function
431 three-way-comparison ediff-3way-comparison-job))
432 ;; if in minibuffer go somewhere else
442 ;; go to the upper window and split it betw A, B, and possibly C
453 ;; XEmacs used to have a lot of trouble with display
454 ;; It did't set things right unless we told it to sit still
455 ;; 19.12 seems ok.
456 ;;(if (featurep 'xemacs) (sit-for 0))
475 ediff-window-B wind-B
476 ediff-window-C wind-C))
478 ;; It is unlikely that we will want to implement 3way window comparison.
479 ;; So, only buffers A and B are used here.
487 ))
490 ;; dispatch an appropriate window setup function
499 ;;; Algorithm:
500 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
501 ;;; destroy dedicated windows.
502 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
503 ;;; frame for A and B and use a separate frame for C.
504 ;;; 3. If C's frame is non-existent, then: if the first suitable
505 ;;; non-dedicated frame is different from A&B's, then use it for C.
506 ;;; Otherwise, put A,B, and C in one frame.
507 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
508 ;;; buffers.
510 ;; Skip dedicated or iconified frames.
511 ;; Unsplittable frames are taken care of later.
521 ;; on wide display, do things in one frame
524 ;; this lets us have local versions of ediff-split-window-function
530 ;; A and C must be in one frame
532 ;; B and C must be in one frame
534 ;; A or B is not visible
537 ;; A or B is not suitable for display
540 ;; A and B in the same frame, and no good frame
541 ;; for C
544 ))
545 ;; use-same-frame-for-AB implies wind A and B are ok for display
549 ediff-merge-window-share))
550 merge-window-lines
551 designated-minibuffer-frame
552 done-A done-B done-C)
554 ;; buf-A on its own
559 ;; buffer buf-A is seen in live wind-A
565 ;; buf-B on its own
570 ;; buffer buf-B is seen in live wind-B
576 ;; buf-C on its own
581 ;; buffer buf-C is seen in live wind-C
590 ;; wind-A must already be displaying buf-A
602 done-B t)))
610 ;; avoid dedicated and non-splittable windows
634 done-B t
635 done-C t)
636 ))
639 ;;; or it was set before because use-same-frame = 1
641 ;; Buf-A was not set up yet as it wasn't visible,
642 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
647 ))
649 ;;; or it was set before because use-same-frame = 1
651 ;; Buf-B was not set up yet as it wasn't visible
652 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
657 ))
660 ;;; or it was set before because use-same-frame = 1
662 ;; Buf-C was not set up yet as it wasn't visible
663 ;; and use-same-frame = nil
668 ))
672 ediff-window-B wind-B
673 ediff-window-C wind-C)
675 designated-minibuffer-frame
679 ))
682 ;; Window setup for all comparison jobs, including 3way comparisons
684 ;;; Algorithm:
685 ;;; If a buffer is seen in a frame, use that frame for that buffer.
686 ;;; If it is not seen, use the current frame.
687 ;;; If both buffers are not seen, they share the current frame. If one
688 ;;; of the buffers is not seen, it is placed in the current frame (where
689 ;;; ediff started). If that frame is displaying the other buffer, it is
690 ;;; shared between the two buffers.
691 ;;; However, if we decide to put both buffers in one frame
692 ;;; and the selected frame isn't splittable, we create a new frame and
693 ;;; put both buffers there, event if one of this buffers is visible in
694 ;;; another frame.
696 ;; Skip dedicated or iconified frames.
697 ;; Unsplittable frames are taken care of later.
709 ;; on wide display, do things in one frame
712 ;; this lets us have local versions of ediff-split-window-function
735 wind-A-start wind-B-start
736 designated-minibuffer-frame
737 done-A done-B done-C)
749 ;; buffer buf-A is seen in live wind-A
757 ;; buffer buf-B is seen in live wind-B
765 ;; buffer buf-C is seen in live wind-C
775 ;; avoid dedicated and non-splittable windows
783 (/
803 done-B t
804 done-C t)
805 ))
808 ;;; or it was set before because use-same-frame = 1
810 ;; Buf-A was not set up yet as it wasn't visible,
811 ;; and use-same-frame = nil
816 ))
818 ;;; or it was set before because use-same-frame = 1
820 ;; Buf-B was not set up yet as it wasn't visible,
821 ;; and use-same-frame = nil
826 ))
830 ;;; or it was set before because use-same-frame = 1
832 ;; Buf-C was not set up yet as it wasn't visible,
833 ;; and use-same-frame = nil
838 )))
842 ediff-window-B wind-B
843 ediff-window-C wind-C)
846 designated-minibuffer-frame
849 ;; It is unlikely that we'll implement a version of ediff-windows that
850 ;; would compare 3 windows at once. So, we don't use buffer C here.
857 ))
859 ;; skip unsplittable frames and frames that have dedicated windows.
860 ;; create a new splittable frame if none is found
864 seen-windows)
869 ;; skip small windows
873 nil
875 ;; remember history
877 ;; try new window
880 )
882 ;; fed up, no appropriate frames
886 )))
893 'ignore-minibuffer
894 frame)
895 ans))
897 ;; window is ok, if it is only one window on the frame, not counting the
898 ;; minibuffer, or none of the frame's windows is dedicated.
899 ;; The idea is that it is bad to destroy dedicated windows while creating an
900 ;; ediff window setup
905 ;; only one window
907 ;; none is dedicated (in multiframe setup)
909 )))
911 ;; Prepare or refresh control frame
914 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
915 ctl-frame old-ctl-frame lines
916 ;; user-grabbed-mouse
917 fheight fwidth adjusted-parameters)
922 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
928 old-ctl-frame
930 ediff-control-frame ctl-frame)
931 ;; protect against undefined face-attribute
940 ()
944 ;; must be before ediff-setup-control-buffer
945 ;; just a precaution--we should be in ctl-buffer already
956 dont-iconify-ctl-frame))
958 ;; 1 more line for the mode line
960 fheight lines
963 adjusted-parameters
965 ;; possibly change surrogate minibuffer
968 designated-minibuffer-frame))
972 ))
974 ;; adjust autoraise
979 adjusted-parameters))
981 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
982 ;; are changed.
989 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
993 ;; As a precaution, we call modify frame parameters twice, in
994 ;; order to make sure that at least once we do it for
995 ;; a non-iconified frame. (It appears that in the Windows port of
996 ;; Emacs, one can't modify frame parameters of iconified frames.)
1000 ;; make or zap toolbar (if not requested)
1008 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1009 ;; iconified, the current buffer changes to that of the frame that
1010 ;; becomes exposed as a result of this iconification.
1011 ;; So, we make sure the current buffer doesn't change.
1023 ;; Now move the frame. We must do it separately due to an obscure bug in
1024 ;; XEmacs
1026 ctl-frame
1029 ;; synchronize so the cursor will move to control frame
1030 ;; per RMS suggestion
1039 ;; don't warp the mouse, unless ediff-grab-mouse = t
1064 ;;(ediff-reset-mouse nil)
1065 )
1068 ;; finds a good place to clip control frame
1077 horizontal-adjustment upward-adjustment
1078 ctl-frame-top ctl-frame-left)
1080 ;; Multiple control frames are clipped based on the value of
1081 ;; ediff-control-buffer-number. This is done in order not to obscure
1082 ;; other active control panels.
1088 ctl-frame-left
1089 (+ frame-A-left
1092 (+ ediff-wide-control-frame-rightward-shift
1093 horizontal-adjustment))
1096 (+ ctl-frame-width
1097 ediff-narrow-control-frame-leftward-shift
1098 horizontal-adjustment))))))
1104 ctl-frame-left
1108 ;; keep ctl frame within the visible bounds
1114 )))
1122 "Construct an alist of parameters for the wide display.
1123 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1124 The frame to be resized is kept in `ediff-wide-display-frame'.
1125 This function modifies only the left margin and the width of the display.
1126 It assumes that it is called from within the control buffer."
1136 ediff-wide-display-frame frame-A)
1141 ;; Revise the mode line to display which difference we have selected
1142 ;; Also resets mode lines of buffers A/B, since they may be clobbered by
1143 ;; other invocations of Ediff.
1167 ediff-current-difference)
1168 " AncestorEmpty"
1170 )
1173 buf-B-state-diff ""
1176 ;; control buffer format
1181 ;; control buffer id
1186 ;; Force mode-line redisplay
1214 ;; we keep the second dummy string in the mode line format of the
1215 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1216 ;; ediff-strip-mode-line-format expects that.
1226 mode-line-format))))
1227 ))
1232 ;; set frame/icon titles for Emacs
1234 ediff-control-frame
1237 ))
1238 ;; set frame/icon titles for XEmacs
1241 ;; force an update of the frame title
1248 " "
1257 ediff-number-of-differences)))))
1262 ediff-control-buffer-suffix))
1267 ediff-number-of-differences)))
1270 ediff-number-of-differences)))
1274 ediff-number-of-differences)))))
1278 ;; If buff is not live, return nil
1286 ;;; Functions to decide when to redraw windows
1300 ;; if buffer C is defined then take it into account
1309 ctl-wind A-wind B-wind C-wind
1310 ediff-split-window-function
1312 ediff-wide-display-p)))))))
1318 ;; Local Variables:
1319 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1320 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1321 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1322 ;; End:
1324 ;;; ediff-wind.el ends here