| blob | 79ccc6d32db15225fc87eb303e328af3808769c4 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994-1997, 2000-2017 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 <https://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 ;; Official window for buffer Ancestor
120 ;; Ediff's window configuration.
121 ;; Used to minimize the need to rearrange windows.
124 ;; Association between buff-type and ediff-window-*
136 "The function used to split the main window between buffer-A and buffer-B.
137 You can set it to a horizontal split instead of the default vertical split
138 by setting this variable to `split-window-horizontally'.
139 You can also have your own function to do fancy splits.
140 This variable has no effect when buffer-A/B are shown in different frames.
141 In this case, Ediff will use those frames to display these buffers."
145 function)
149 "The function used to split the main window between buffer-A and buffer-B.
150 You can set it to a vertical split instead of the default horizontal split
151 by setting this variable to `split-window-vertically'.
152 You can also have your own function to do fancy splits.
153 This variable has no effect when buffer-A/B/C are shown in different frames.
154 In this case, Ediff will use those frames to display these buffers."
158 function)
161 ;; Definitions hidden from the compiler by compat wrappers.
168 ;;'(unsplittable . t)
178 ;; don't lower but auto-raise
182 ;; make initial frame small to avoid distraction
184 ;; Fullscreen control frames don't make sense (Bug#29026).
186 ;; this blocks queries from window manager as to where to put
187 ;; ediff's control frame. we put the frame outside the display,
188 ;; so the initial frame won't jump all over the screen
195 )
196 "Frame parameters for displaying Ediff Control Panel.
199 ;; position of the mouse; used to decide whether to warp the mouse into ctl
200 ;; frame
203 ;; not used for now
205 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
208 "If t, Ediff will always grab the mouse and put it in the control frame.
209 If `maybe', Ediff will do it sometimes, but not after operations that require
210 relatively long time. If nil, the mouse will be entirely user's
211 responsibility."
216 "Function to call to determine the desired location for the control panel.
217 Expects three parameters: the control buffer, the desired width and height
218 of the control frame. It returns an association list
219 of the form \((top . <position>) \(left . <position>))"
224 "The upward shift of control frame from the top of buffer A's frame.
225 Measured in pixels.
226 This is used by the default control frame positioning function,
227 `ediff-make-frame-position'. This variable is provided for easy
228 customization of the default control frame positioning."
233 "The leftward shift of control frame from the right edge of buf A's frame.
234 Measured in characters.
235 This is used by the default control frame positioning function,
236 `ediff-make-frame-position' to adjust the position of the control frame
237 when it shows the short menu. This variable is provided for easy
238 customization of the default."
243 "The rightward shift of control frame from the left edge of buf A's frame.
244 Measured in characters.
245 This is used by the default control frame positioning function,
246 `ediff-make-frame-position' to adjust the position of the control frame
247 when it shows the full menu. This variable is provided for easy
248 customization of the default."
253 ;; Wide frame display
255 ;; t means Ediff is using wide display
257 ;; keeps frame config for toggling wide display
259 "Frame parameters to be restored when the user wants to toggle the wide
264 "The value is a function that is called to create a wide display.
265 The function is called without arguments. It should resize the frame in
266 which buffers A, B, and C are to be displayed, and it should save the old
267 frame parameters in `ediff-wide-display-orig-parameters'.
268 The variable `ediff-wide-display-frame' should be set to contain
271 ;; Frame used for the control panel in a windowing system.
275 "If t, keep control panel iconified when help message is off.
276 This has effect only on a windowing system.
277 If t, hitting `?' to toggle control panel off iconifies it.
279 This is only useful in Emacs and only for certain kinds of window managers,
280 such as TWM and its derivatives, since the window manager must permit
281 keyboard input to go into icons. XEmacs completely ignores keyboard input
282 into icons, regardless of the window manager."
286 ;;; Functions
302 ;; Select the lowest window on the frame.
317 lowest-window this-window))
324 ;;; Common window setup routines
326 ;; Set up the window configuration. If POS is given, set the points to
327 ;; the beginnings of the buffers.
328 ;; When 3way comparison is added, this will have to choose the appropriate
329 ;; setup function based on ediff-job-name
331 ;; Make sure we are not in the minibuffer window when we try to delete
332 ;; all other windows.
337 ;; in case user did a no-no on a tty
344 buffer-A buffer-B buffer-C control-buffer))
349 'ediff-setup-windows-multiframe
351 buffer-A buffer-B buffer-C control-buffer))
353 ;; Just set up 3 windows.
354 ;; Usually used without windowing systems
355 ;; With windowing, we want to use dedicated frames.
361 buffer-A buffer-B buffer-C control-buffer)
363 buffer-A buffer-B buffer-C control-buffer)))
368 ;; skip dedicated and unsplittable frames
372 ediff-merge-with-ancestor-job))
373 split-window-function
374 merge-window-share merge-window-lines
376 ediff-ancestor-buffer))
377 wind-A wind-B wind-C wind-Ancestor)
380 ;; this lets us have local versions of ediff-split-window-function
381 split-window-function ediff-split-window-function))
388 ;; go to the upper window and split it betw A, B, and possibly C
395 ;; XEmacs used to have a lot of trouble with display
396 ;; It did't set things right unless we tell it to sit still
397 ;; 19.12 seems ok.
398 ;;(if (featurep 'xemacs) (sit-for 0))
424 ediff-window-B wind-B
425 ediff-window-C wind-C
426 ediff-window-Ancestor wind-Ancestor))
430 ))
433 ;; This function handles all comparison jobs, including 3way jobs
435 ;; skip dedicated and unsplittable frames
438 split-window-function wind-width-or-height
439 three-way-comparison
440 wind-A-start wind-B-start wind-A wind-B wind-C)
448 ;; this lets us have local versions of ediff-split-window-function
449 split-window-function ediff-split-window-function
450 three-way-comparison ediff-3way-comparison-job))
451 ;; if in minibuffer go somewhere else
461 ;; go to the upper window and split it betw A, B, and possibly C
472 ;; XEmacs used to have a lot of trouble with display
473 ;; It did't set things right unless we told it to sit still
474 ;; 19.12 seems ok.
475 ;;(if (featurep 'xemacs) (sit-for 0))
494 ediff-window-B wind-B
495 ediff-window-C wind-C))
497 ;; It is unlikely that we will want to implement 3way window comparison.
498 ;; So, only buffers A and B are used here.
506 ))
509 ;; dispatch an appropriate window setup function
518 ;; Algorithm:
519 ;; 1. Never use frames that have dedicated windows in them---it is bad to
520 ;; destroy dedicated windows.
521 ;; 2. If A and B are in the same frame but C's frame is different--- use one
522 ;; frame for A and B and use a separate frame for C.
523 ;; 3. If C's frame is non-existent, then: if the first suitable
524 ;; non-dedicated frame is different from A&B's, then use it for C.
525 ;; Otherwise, put A,B, and C in one frame.
526 ;; 4. If buffers A, B, C are is separate frames, use them to display these
527 ;; buffers.
529 ;; Skip dedicated or iconified frames.
530 ;; Unsplittable frames are taken care of later.
538 ediff-ancestor-buffer))
544 ;; on wide display, do things in one frame
547 ;; this lets us have local versions of ediff-split-window-function
553 ;; A and C must be in one frame
555 ;; B and C must be in one frame
557 ;; A or B is not visible
560 ;; A or B is not suitable for display
563 ;; A and B in the same frame, and no good frame
564 ;; for C
567 ))
568 ;; use-same-frame-for-AB implies wind A and B are ok for display
572 ediff-merge-window-share))
573 merge-window-lines
574 designated-minibuffer-frame ; ediff-merge-with-ancestor-job
576 ediff-merge-with-ancestor-job))
578 done-A done-B done-C)
580 ;; buf-A on its own
585 ;; buffer buf-A is seen in live wind-A
591 ;; buf-B on its own
596 ;; buffer buf-B is seen in live wind-B
602 ;; buf-C on its own
607 ;; buffer buf-C is seen in live wind-C
613 ;; buf-Ancestor on its own
615 with-Ancestor-p
620 ;; buffer buf-Ancestor is seen in live wind-Ancestor
629 ;; wind-A must already be displaying buf-A
641 done-B t)))
650 ;; avoid dedicated and non-splittable windows
682 done-B t
683 done-C t
684 done-Ancestor t)))
687 ;;; or it was set before because use-same-frame = 1
689 ;; Buf-A was not set up yet as it wasn't visible,
690 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
695 ))
697 ;;; or it was set before because use-same-frame = 1
699 ;; Buf-B was not set up yet as it wasn't visible
700 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
705 ))
708 ;;; or it was set before because use-same-frame = 1
710 ;; Buf-C was not set up yet as it wasn't visible
711 ;; and use-same-frame = nil
716 ))
720 ;;; or it was set before because use-same-frame = 1
722 ;; Buf-Ancestor was not set up yet as it wasn't visible
723 ;; and use-same-frame = nil
731 ediff-window-B wind-B
732 ediff-window-C wind-C
733 ediff-window-Ancestor wind-Ancestor)
735 designated-minibuffer-frame
739 ))
741 ;; Window setup for all comparison jobs, including 3way comparisons
743 ;; Algorithm:
744 ;; If a buffer is seen in a frame, use that frame for that buffer.
745 ;; If it is not seen, use the current frame.
746 ;; If both buffers are not seen, they share the current frame. If one
747 ;; of the buffers is not seen, it is placed in the current frame (where
748 ;; ediff started). If that frame is displaying the other buffer, it is
749 ;; shared between the two buffers.
750 ;; However, if we decide to put both buffers in one frame
751 ;; and the selected frame isn't splittable, we create a new frame and
752 ;; put both buffers there, event if one of this buffers is visible in
753 ;; another frame.
764 ;; on wide display, do things in one frame
767 ;; this lets us have local versions of ediff-split-window-function
789 wind-A-start wind-B-start
790 designated-minibuffer-frame)
804 ;; avoid dedicated and non-splittable windows
812 (/
834 ;; buffer buf-A is seen in live wind-A
838 ;; Buf-A was not set up yet as it wasn't visible,
839 ;; and use-same-frame = nil
840 ;; Skip dedicated or iconified frames.
841 ;; Unsplittable frames are taken care of later.
849 ;; buffer buf-B is seen in live wind-B
853 ;; Buf-B was not set up yet as it wasn't visible,
854 ;; and use-same-frame = nil
855 ;; Skip dedicated or iconified frames.
856 ;; Unsplittable frames are taken care of later.
864 ;; buffer buf-C is seen in live wind-C
870 ;; Buf-C was not set up yet as it wasn't visible,
871 ;; and use-same-frame = nil
872 ;; Skip dedicated or iconified frames.
873 ;; Unsplittable frames are taken care of later.
878 ))))
882 ediff-window-B wind-B
883 ediff-window-C wind-C)
886 designated-minibuffer-frame
889 ;; It is unlikely that we'll implement a version of ediff-windows that
890 ;; would compare 3 windows at once. So, we don't use buffer C here.
897 ))
900 "Skip unsplittable frames and frames that have dedicated windows.
901 create a new splittable frame if none is found."
904 seen-windows)
909 ;; skip small windows
913 nil
915 ;; remember history
917 ;; try new window
920 )
922 ;; fed up, no appropriate frames
926 )))
933 'ignore-minibuffer
934 frame)
935 ans))
937 ;; window is ok, if it is only one window on the frame, not counting the
938 ;; minibuffer, or none of the frame's windows is dedicated.
939 ;; The idea is that it is bad to destroy dedicated windows while creating an
940 ;; ediff window setup
945 ;; only one window
947 ;; none is dedicated (in multiframe setup)
949 )))
953 ;; Prepare or refresh control frame
956 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
957 ctl-frame old-ctl-frame lines
958 ;; user-grabbed-mouse
959 fheight fwidth adjusted-parameters)
964 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
970 old-ctl-frame
972 ediff-control-frame ctl-frame)
973 ;; protect against undefined face-attribute
982 ()
986 ;; must be before ediff-setup-control-buffer
987 ;; just a precaution--we should be in ctl-buffer already
998 dont-iconify-ctl-frame))
1000 ;; 1 more line for the mode line
1002 fheight lines
1005 adjusted-parameters
1007 ;; possibly change surrogate minibuffer
1010 designated-minibuffer-frame))
1014 ))
1016 ;; adjust autoraise
1021 adjusted-parameters))
1023 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
1024 ;; are changed.
1031 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
1035 ;; As a precaution, we call modify frame parameters twice, in
1036 ;; order to make sure that at least once we do it for
1037 ;; a non-iconified frame. (It appears that in the Windows port of
1038 ;; Emacs, one can't modify frame parameters of iconified frames.)
1042 ;; make or zap toolbar (if not requested)
1050 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1051 ;; iconified, the current buffer changes to that of the frame that
1052 ;; becomes exposed as a result of this iconification.
1053 ;; So, we make sure the current buffer doesn't change.
1065 ;; Now move the frame. We must do it separately due to an obscure bug in
1066 ;; XEmacs
1068 ctl-frame
1071 ;; synchronize so the cursor will move to control frame
1072 ;; per RMS suggestion
1081 ;; don't warp the mouse, unless ediff-grab-mouse = t
1106 ;;(ediff-reset-mouse nil)
1107 )
1110 ;; finds a good place to clip control frame
1119 horizontal-adjustment upward-adjustment
1120 ctl-frame-top ctl-frame-left)
1122 ;; Multiple control frames are clipped based on the value of
1123 ;; ediff-control-buffer-number. This is done in order not to obscure
1124 ;; other active control panels.
1130 ctl-frame-left
1131 (+ frame-A-left
1134 (+ ediff-wide-control-frame-rightward-shift
1135 horizontal-adjustment))
1138 (+ ctl-frame-width
1139 ediff-narrow-control-frame-leftward-shift
1140 horizontal-adjustment))))))
1146 ctl-frame-left
1150 ;; keep ctl frame within the visible bounds
1156 )))
1164 "Construct an alist of parameters for the wide display.
1165 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1166 The frame to be resized is kept in `ediff-wide-display-frame'.
1167 This function modifies only the left margin and the width of the display.
1168 It assumes that it is called from within the control buffer."
1178 ediff-wide-display-frame frame-A)
1183 ;; Revise the mode line to display which difference we have selected
1184 ;; Also resets mode lines of buffers A/B, since they may be clobbered by
1185 ;; other invocations of Ediff.
1209 ediff-current-difference)
1210 " AncestorEmpty"
1212 )
1215 buf-B-state-diff ""
1218 ;; control buffer format
1223 ;; control buffer id
1228 ;; Force mode-line redisplay
1256 ;; we keep the second dummy string in the mode line format of the
1257 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1258 ;; ediff-strip-mode-line-format expects that.
1268 mode-line-format))))
1269 ))
1274 ;; set frame/icon titles for Emacs
1276 ediff-control-frame
1279 ))
1280 ;; set frame/icon titles for XEmacs
1283 ;; force an update of the frame title
1290 " "
1299 ediff-number-of-differences)))))
1304 ediff-control-buffer-suffix))
1309 ediff-number-of-differences)))
1312 ediff-number-of-differences)))
1316 ediff-number-of-differences)))))
1320 ;; If buff is not live, return nil
1328 ;;; Functions to decide when to redraw windows
1344 ;; if buffer C is defined then take it into account
1359 ctl-wind A-wind B-wind C-wind Ancestor-wind
1360 ediff-split-window-function
1362 ediff-wide-display-p)))))))
1366 ;;; ediff-wind.el ends here