| blob | 8516c11d136d6f5db204dd1df35cfc57d619ce00 |
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 <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 ;; 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 ;; this blocks queries from window manager as to where to put
185 ;; ediff's control frame. we put the frame outside the display,
186 ;; so the initial frame won't jump all over the screen
193 )
194 "Frame parameters for displaying Ediff Control Panel.
197 ;; position of the mouse; used to decide whether to warp the mouse into ctl
198 ;; frame
201 ;; not used for now
203 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
206 "If t, Ediff will always grab the mouse and put it in the control frame.
207 If `maybe', Ediff will do it sometimes, but not after operations that require
208 relatively long time. If nil, the mouse will be entirely user's
209 responsibility."
214 "Function to call to determine the desired location for the control panel.
215 Expects three parameters: the control buffer, the desired width and height
216 of the control frame. It returns an association list
217 of the form \((top . <position>) \(left . <position>))"
222 "The upward shift of control frame from the top of buffer A's frame.
223 Measured in pixels.
224 This is used by the default control frame positioning function,
225 `ediff-make-frame-position'. This variable is provided for easy
226 customization of the default control frame positioning."
231 "The leftward shift of control frame from the right edge of buf A's frame.
232 Measured in characters.
233 This is used by the default control frame positioning function,
234 `ediff-make-frame-position' to adjust the position of the control frame
235 when it shows the short menu. This variable is provided for easy
236 customization of the default."
241 "The rightward shift of control frame from the left edge of buf A's frame.
242 Measured in characters.
243 This is used by the default control frame positioning function,
244 `ediff-make-frame-position' to adjust the position of the control frame
245 when it shows the full menu. This variable is provided for easy
246 customization of the default."
251 ;; Wide frame display
253 ;; t means Ediff is using wide display
255 ;; keeps frame config for toggling wide display
257 "Frame parameters to be restored when the user wants to toggle the wide
262 "The value is a function that is called to create a wide display.
263 The function is called without arguments. It should resize the frame in
264 which buffers A, B, and C are to be displayed, and it should save the old
265 frame parameters in `ediff-wide-display-orig-parameters'.
266 The variable `ediff-wide-display-frame' should be set to contain
269 ;; Frame used for the control panel in a windowing system.
273 "If t, keep control panel iconified when help message is off.
274 This has effect only on a windowing system.
275 If t, hitting `?' to toggle control panel off iconifies it.
277 This is only useful in Emacs and only for certain kinds of window managers,
278 such as TWM and its derivatives, since the window manager must permit
279 keyboard input to go into icons. XEmacs completely ignores keyboard input
280 into icons, regardless of the window manager."
284 ;;; Functions
300 ;; Select the lowest window on the frame.
315 lowest-window this-window))
322 ;;; Common window setup routines
324 ;; Set up the window configuration. If POS is given, set the points to
325 ;; the beginnings of the buffers.
326 ;; When 3way comparison is added, this will have to choose the appropriate
327 ;; setup function based on ediff-job-name
329 ;; Make sure we are not in the minibuffer window when we try to delete
330 ;; all other windows.
335 ;; in case user did a no-no on a tty
342 buffer-A buffer-B buffer-C control-buffer))
347 'ediff-setup-windows-multiframe
349 buffer-A buffer-B buffer-C control-buffer))
351 ;; Just set up 3 windows.
352 ;; Usually used without windowing systems
353 ;; With windowing, we want to use dedicated frames.
359 buffer-A buffer-B buffer-C control-buffer)
361 buffer-A buffer-B buffer-C control-buffer)))
366 ;; skip dedicated and unsplittable frames
370 ediff-merge-with-ancestor-job))
371 split-window-function
372 merge-window-share merge-window-lines
374 ediff-ancestor-buffer))
375 wind-A wind-B wind-C wind-Ancestor)
378 ;; this lets us have local versions of ediff-split-window-function
379 split-window-function ediff-split-window-function))
386 ;; go to the upper window and split it betw A, B, and possibly C
393 ;; XEmacs used to have a lot of trouble with display
394 ;; It did't set things right unless we tell it to sit still
395 ;; 19.12 seems ok.
396 ;;(if (featurep 'xemacs) (sit-for 0))
422 ediff-window-B wind-B
423 ediff-window-C wind-C
424 ediff-window-Ancestor wind-Ancestor))
428 ))
431 ;; This function handles all comparison jobs, including 3way jobs
433 ;; skip dedicated and unsplittable frames
436 split-window-function wind-width-or-height
437 three-way-comparison
438 wind-A-start wind-B-start wind-A wind-B wind-C)
446 ;; this lets us have local versions of ediff-split-window-function
447 split-window-function ediff-split-window-function
448 three-way-comparison ediff-3way-comparison-job))
449 ;; if in minibuffer go somewhere else
459 ;; go to the upper window and split it betw A, B, and possibly C
470 ;; XEmacs used to have a lot of trouble with display
471 ;; It did't set things right unless we told it to sit still
472 ;; 19.12 seems ok.
473 ;;(if (featurep 'xemacs) (sit-for 0))
492 ediff-window-B wind-B
493 ediff-window-C wind-C))
495 ;; It is unlikely that we will want to implement 3way window comparison.
496 ;; So, only buffers A and B are used here.
504 ))
507 ;; dispatch an appropriate window setup function
516 ;;; Algorithm:
517 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
518 ;;; destroy dedicated windows.
519 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
520 ;;; frame for A and B and use a separate frame for C.
521 ;;; 3. If C's frame is non-existent, then: if the first suitable
522 ;;; non-dedicated frame is different from A&B's, then use it for C.
523 ;;; Otherwise, put A,B, and C in one frame.
524 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
525 ;;; buffers.
527 ;; Skip dedicated or iconified frames.
528 ;; Unsplittable frames are taken care of later.
536 ediff-ancestor-buffer))
542 ;; on wide display, do things in one frame
545 ;; this lets us have local versions of ediff-split-window-function
551 ;; A and C must be in one frame
553 ;; B and C must be in one frame
555 ;; A or B is not visible
558 ;; A or B is not suitable for display
561 ;; A and B in the same frame, and no good frame
562 ;; for C
565 ))
566 ;; use-same-frame-for-AB implies wind A and B are ok for display
570 ediff-merge-window-share))
571 merge-window-lines
572 designated-minibuffer-frame ; ediff-merge-with-ancestor-job
574 ediff-merge-with-ancestor-job))
576 done-A done-B done-C)
578 ;; buf-A on its own
583 ;; buffer buf-A is seen in live wind-A
589 ;; buf-B on its own
594 ;; buffer buf-B is seen in live wind-B
600 ;; buf-C on its own
605 ;; buffer buf-C is seen in live wind-C
611 ;; buf-Ancestor on its own
613 with-Ancestor-p
618 ;; buffer buf-Ancestor is seen in live wind-Ancestor
627 ;; wind-A must already be displaying buf-A
639 done-B t)))
648 ;; avoid dedicated and non-splittable windows
680 done-B t
681 done-C t
682 done-Ancestor t)))
685 ;;; or it was set before because use-same-frame = 1
687 ;; Buf-A was not set up yet as it wasn't visible,
688 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
693 ))
695 ;;; or it was set before because use-same-frame = 1
697 ;; Buf-B was not set up yet as it wasn't visible
698 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
703 ))
706 ;;; or it was set before because use-same-frame = 1
708 ;; Buf-C was not set up yet as it wasn't visible
709 ;; and use-same-frame = nil
714 ))
718 ;;; or it was set before because use-same-frame = 1
720 ;; Buf-Ancestor was not set up yet as it wasn't visible
721 ;; and use-same-frame = nil
729 ediff-window-B wind-B
730 ediff-window-C wind-C
731 ediff-window-Ancestor wind-Ancestor)
733 designated-minibuffer-frame
737 ))
739 ;; Window setup for all comparison jobs, including 3way comparisons
741 ;;; Algorithm:
742 ;;; If a buffer is seen in a frame, use that frame for that buffer.
743 ;;; If it is not seen, use the current frame.
744 ;;; If both buffers are not seen, they share the current frame. If one
745 ;;; of the buffers is not seen, it is placed in the current frame (where
746 ;;; ediff started). If that frame is displaying the other buffer, it is
747 ;;; shared between the two buffers.
748 ;;; However, if we decide to put both buffers in one frame
749 ;;; and the selected frame isn't splittable, we create a new frame and
750 ;;; put both buffers there, event if one of this buffers is visible in
751 ;;; another frame.
753 ;; Skip dedicated or iconified frames.
754 ;; Unsplittable frames are taken care of later.
766 ;; on wide display, do things in one frame
769 ;; this lets us have local versions of ediff-split-window-function
792 wind-A-start wind-B-start
793 designated-minibuffer-frame
794 done-A done-B done-C)
806 ;; buffer buf-A is seen in live wind-A
814 ;; buffer buf-B is seen in live wind-B
822 ;; buffer buf-C is seen in live wind-C
832 ;; avoid dedicated and non-splittable windows
840 (/
860 done-B t
861 done-C t)
862 ))
865 ;;; or it was set before because use-same-frame = 1
867 ;; Buf-A was not set up yet as it wasn't visible,
868 ;; and use-same-frame = nil
873 ))
875 ;;; or it was set before because use-same-frame = 1
877 ;; Buf-B was not set up yet as it wasn't visible,
878 ;; and use-same-frame = nil
883 ))
887 ;;; or it was set before because use-same-frame = 1
889 ;; Buf-C was not set up yet as it wasn't visible,
890 ;; and use-same-frame = nil
895 )))
899 ediff-window-B wind-B
900 ediff-window-C wind-C)
903 designated-minibuffer-frame
906 ;; It is unlikely that we'll implement a version of ediff-windows that
907 ;; would compare 3 windows at once. So, we don't use buffer C here.
914 ))
916 ;; skip unsplittable frames and frames that have dedicated windows.
917 ;; create a new splittable frame if none is found
921 seen-windows)
926 ;; skip small windows
930 nil
932 ;; remember history
934 ;; try new window
937 )
939 ;; fed up, no appropriate frames
943 )))
950 'ignore-minibuffer
951 frame)
952 ans))
954 ;; window is ok, if it is only one window on the frame, not counting the
955 ;; minibuffer, or none of the frame's windows is dedicated.
956 ;; The idea is that it is bad to destroy dedicated windows while creating an
957 ;; ediff window setup
962 ;; only one window
964 ;; none is dedicated (in multiframe setup)
966 )))
970 ;; Prepare or refresh control frame
973 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
974 ctl-frame old-ctl-frame lines
975 ;; user-grabbed-mouse
976 fheight fwidth adjusted-parameters)
981 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
987 old-ctl-frame
989 ediff-control-frame ctl-frame)
990 ;; protect against undefined face-attribute
999 ()
1003 ;; must be before ediff-setup-control-buffer
1004 ;; just a precaution--we should be in ctl-buffer already
1015 dont-iconify-ctl-frame))
1017 ;; 1 more line for the mode line
1019 fheight lines
1022 adjusted-parameters
1024 ;; possibly change surrogate minibuffer
1027 designated-minibuffer-frame))
1031 ))
1033 ;; adjust autoraise
1038 adjusted-parameters))
1040 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
1041 ;; are changed.
1048 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
1052 ;; As a precaution, we call modify frame parameters twice, in
1053 ;; order to make sure that at least once we do it for
1054 ;; a non-iconified frame. (It appears that in the Windows port of
1055 ;; Emacs, one can't modify frame parameters of iconified frames.)
1059 ;; make or zap toolbar (if not requested)
1067 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1068 ;; iconified, the current buffer changes to that of the frame that
1069 ;; becomes exposed as a result of this iconification.
1070 ;; So, we make sure the current buffer doesn't change.
1082 ;; Now move the frame. We must do it separately due to an obscure bug in
1083 ;; XEmacs
1085 ctl-frame
1088 ;; synchronize so the cursor will move to control frame
1089 ;; per RMS suggestion
1098 ;; don't warp the mouse, unless ediff-grab-mouse = t
1123 ;;(ediff-reset-mouse nil)
1124 )
1127 ;; finds a good place to clip control frame
1136 horizontal-adjustment upward-adjustment
1137 ctl-frame-top ctl-frame-left)
1139 ;; Multiple control frames are clipped based on the value of
1140 ;; ediff-control-buffer-number. This is done in order not to obscure
1141 ;; other active control panels.
1147 ctl-frame-left
1148 (+ frame-A-left
1151 (+ ediff-wide-control-frame-rightward-shift
1152 horizontal-adjustment))
1155 (+ ctl-frame-width
1156 ediff-narrow-control-frame-leftward-shift
1157 horizontal-adjustment))))))
1163 ctl-frame-left
1167 ;; keep ctl frame within the visible bounds
1173 )))
1181 "Construct an alist of parameters for the wide display.
1182 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1183 The frame to be resized is kept in `ediff-wide-display-frame'.
1184 This function modifies only the left margin and the width of the display.
1185 It assumes that it is called from within the control buffer."
1195 ediff-wide-display-frame frame-A)
1200 ;; Revise the mode line to display which difference we have selected
1201 ;; Also resets mode lines of buffers A/B, since they may be clobbered by
1202 ;; other invocations of Ediff.
1226 ediff-current-difference)
1227 " AncestorEmpty"
1229 )
1232 buf-B-state-diff ""
1235 ;; control buffer format
1240 ;; control buffer id
1245 ;; Force mode-line redisplay
1273 ;; we keep the second dummy string in the mode line format of the
1274 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1275 ;; ediff-strip-mode-line-format expects that.
1285 mode-line-format))))
1286 ))
1291 ;; set frame/icon titles for Emacs
1293 ediff-control-frame
1296 ))
1297 ;; set frame/icon titles for XEmacs
1300 ;; force an update of the frame title
1307 " "
1316 ediff-number-of-differences)))))
1321 ediff-control-buffer-suffix))
1326 ediff-number-of-differences)))
1329 ediff-number-of-differences)))
1333 ediff-number-of-differences)))))
1337 ;; If buff is not live, return nil
1345 ;;; Functions to decide when to redraw windows
1361 ;; if buffer C is defined then take it into account
1376 ctl-wind A-wind B-wind C-wind Ancestor-wind
1377 ediff-split-window-function
1379 ediff-wide-display-p)))))))
1385 ;; Local Variables:
1386 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1387 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1388 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1389 ;; End:
1391 ;;; ediff-wind.el ends here