| blob | 8b16c5a4a121b6e4f417f4d17318ea6248679b86 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; Package: ediff
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
29 ;; Compiler pacifier
42 ;; declare-function does not exist in XEmacs
49 ;; end pacifier
53 ;; be careful with ediff-tbar
59 "Ediff window manipulation."
65 ;; 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 two functions: `ediff-setup-windows-plain', for
74 doing everything in one frame and `ediff-setup-windows-multiframe', which sets
75 the control panel in a separate frame. By default, the appropriate function is
76 chosen automatically depending on the current window system.
77 However, `ediff-toggle-multiframe' can be used to toggle between the multiframe
78 display and the single frame display.
79 If the multiframe function detects that one of the buffers A/B is seen in some
80 other frame, it will try to keep that buffer in that frame.
82 If you don't like any of the two provided functions, write your own one.
83 The basic guidelines:
84 1. It should leave the control buffer current and the control window
85 selected.
86 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
87 and `ediff-control-window' to contain window objects that display
88 the corresponding buffers.
89 3. It should accept the following arguments:
90 buffer-A, buffer-B, buffer-C, control-buffer
91 Buffer C may not be used in jobs that compare only two buffers.
92 If you plan to do something fancy, take a close look at how the two
93 provided functions are written."
99 ;; indicates if we are in a multiframe setup
102 ;; Share of the frame occupied by the merge window (buffer C)
105 ;; The control window.
107 ;; Official window for buffer A
109 ;; Official window for buffer B
111 ;; Official window for buffer C
113 ;; Ediff's window configuration.
114 ;; Used to minimize the need to rearrange windows.
117 ;; Association between buff-type and ediff-window-*
128 "The function used to split the main window between buffer-A and buffer-B.
129 You can set it to a horizontal split instead of the default vertical split
130 by setting this variable to `split-window-horizontally'.
131 You can also have your own function to do fancy splits.
132 This variable has no effect when buffer-A/B are shown in different frames.
133 In this case, Ediff will use those frames to display these buffers."
137 function)
141 "The function used to split the main window between buffer-A and buffer-B.
142 You can set it to a vertical split instead of the default horizontal split
143 by setting this variable to `split-window-vertically'.
144 You can also have your own function to do fancy splits.
145 This variable has no effect when buffer-A/B/C are shown in different frames.
146 In this case, Ediff will use those frames to display these buffers."
150 function)
153 ;; Definitions hidden from the compiler by compat wrappers.
160 ;;'(unsplittable . t)
170 ;; don't lower but auto-raise
174 ;; make initial frame small to avoid distraction
176 ;; this blocks queries from window manager as to where to put
177 ;; ediff's control frame. we put the frame outside the display,
178 ;; so the initial frame won't jump all over the screen
185 )
186 "Frame parameters for displaying Ediff Control Panel.
189 ;; position of the mouse; used to decide whether to warp the mouse into ctl
190 ;; frame
193 ;; not used for now
195 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
198 "If t, Ediff will always grab the mouse and put it in the control frame.
199 If 'maybe, Ediff will do it sometimes, but not after operations that require
200 relatively long time. If nil, the mouse will be entirely user's
201 responsibility."
206 "Function to call to determine the desired location for the control panel.
207 Expects three parameters: the control buffer, the desired width and height
208 of the control frame. It returns an association list
209 of the form \(\(top . <position>\) \(left . <position>\)\)"
214 "The upward shift of control frame from the top of buffer A's frame.
215 Measured in pixels.
216 This is used by the default control frame positioning function,
217 `ediff-make-frame-position'. This variable is provided for easy
218 customization of the default control frame positioning."
223 "The leftward shift of control frame from the right edge of buf A's frame.
224 Measured in characters.
225 This is used by the default control frame positioning function,
226 `ediff-make-frame-position' to adjust the position of the control frame
227 when it shows the short menu. This variable is provided for easy
228 customization of the default."
233 "The rightward shift of control frame from the left 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 full menu. This variable is provided for easy
238 customization of the default."
243 ;; Wide frame display
245 ;; t means Ediff is using wide display
247 ;; keeps frame config for toggling wide display
249 "Frame parameters to be restored when the user wants to toggle the wide
254 "The value is a function that is called to create a wide display.
255 The function is called without arguments. It should resize the frame in
256 which buffers A, B, and C are to be displayed, and it should save the old
257 frame parameters in `ediff-wide-display-orig-parameters'.
258 The variable `ediff-wide-display-frame' should be set to contain
261 ;; Frame used for the control panel in a windowing system.
265 "If t, keep control panel iconified when help message is off.
266 This has effect only on a windowing system.
267 If t, hitting `?' to toggle control panel off iconifies it.
269 This is only useful in Emacs and only for certain kinds of window managers,
270 such as TWM and its derivatives, since the window manager must permit
271 keyboard input to go into icons. XEmacs completely ignores keyboard input
272 into icons, regardless of the window manager."
276 ;;; Functions
292 ;; Select the lowest window on the frame.
307 lowest-window this-window))
314 ;;; Common window setup routines
316 ;; Set up the window configuration. If POS is given, set the points to
317 ;; the beginnings of the buffers.
318 ;; When 3way comparison is added, this will have to choose the appropriate
319 ;; setup function based on ediff-job-name
321 ;; Make sure we are not in the minibuffer window when we try to delete
322 ;; all other windows.
327 ;; in case user did a no-no on a tty
334 buffer-A buffer-B buffer-C control-buffer))
337 ;; Just set up 3 windows.
338 ;; Usually used without windowing systems
339 ;; With windowing, we want to use dedicated frames.
345 buffer-A buffer-B buffer-C control-buffer)
347 buffer-A buffer-B buffer-C control-buffer)))
350 ;; skip dedicated and unsplittable frames
353 split-window-function
354 merge-window-share merge-window-lines
355 wind-A wind-B wind-C)
358 ;; this lets us have local versions of ediff-split-window-function
359 split-window-function ediff-split-window-function))
366 ;; go to the upper window and split it betw A, B, and possibly C
373 ;; XEmacs used to have a lot of trouble with display
374 ;; It did't set things right unless we tell it to sit still
375 ;; 19.12 seems ok.
376 ;;(if (featurep 'xemacs) (sit-for 0))
394 ediff-window-B wind-B
395 ediff-window-C wind-C))
399 ))
402 ;; This function handles all comparison jobs, including 3way jobs
404 ;; skip dedicated and unsplittable frames
407 split-window-function wind-width-or-height
408 three-way-comparison
409 wind-A-start wind-B-start wind-A wind-B wind-C)
417 ;; this lets us have local versions of ediff-split-window-function
418 split-window-function ediff-split-window-function
419 three-way-comparison ediff-3way-comparison-job))
420 ;; if in minibuffer go somewhere else
430 ;; go to the upper window and split it betw A, B, and possibly C
441 ;; XEmacs used to have a lot of trouble with display
442 ;; It did't set things right unless we told it to sit still
443 ;; 19.12 seems ok.
444 ;;(if (featurep 'xemacs) (sit-for 0))
463 ediff-window-B wind-B
464 ediff-window-C wind-C))
466 ;; It is unlikely that we will want to implement 3way window comparison.
467 ;; So, only buffers A and B are used here.
475 ))
478 ;; dispatch an appropriate window setup function
487 ;;; Algorithm:
488 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
489 ;;; destroy dedicated windows.
490 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
491 ;;; frame for A and B and use a separate frame for C.
492 ;;; 3. If C's frame is non-existent, then: if the first suitable
493 ;;; non-dedicated frame is different from A&B's, then use it for C.
494 ;;; Otherwise, put A,B, and C in one frame.
495 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
496 ;;; buffers.
498 ;; Skip dedicated or iconified frames.
499 ;; Unsplittable frames are taken care of later.
509 ;; on wide display, do things in one frame
512 ;; this lets us have local versions of ediff-split-window-function
518 ;; A and C must be in one frame
520 ;; B and C must be in one frame
522 ;; A or B is not visible
525 ;; A or B is not suitable for display
528 ;; A and B in the same frame, and no good frame
529 ;; for C
532 ))
533 ;; use-same-frame-for-AB implies wind A and B are ok for display
537 ediff-merge-window-share))
538 merge-window-lines
539 designated-minibuffer-frame
540 done-A done-B done-C)
542 ;; buf-A on its own
547 ;; buffer buf-A is seen in live wind-A
553 ;; buf-B on its own
558 ;; buffer buf-B is seen in live wind-B
564 ;; buf-C on its own
569 ;; buffer buf-C is seen in live wind-C
578 ;; wind-A must already be displaying buf-A
590 done-B t)))
598 ;; avoid dedicated and non-splittable windows
622 done-B t
623 done-C t)
624 ))
627 ;;; or it was set before because use-same-frame = 1
629 ;; Buf-A was not set up yet as it wasn't visible,
630 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
635 ))
637 ;;; or it was set before because use-same-frame = 1
639 ;; Buf-B was not set up yet as it wasn't visible
640 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
645 ))
648 ;;; or it was set before because use-same-frame = 1
650 ;; Buf-C was not set up yet as it wasn't visible
651 ;; and use-same-frame = nil
656 ))
660 ediff-window-B wind-B
661 ediff-window-C wind-C)
663 designated-minibuffer-frame
667 ))
670 ;; Window setup for all comparison jobs, including 3way comparisons
672 ;;; Algorithm:
673 ;;; If a buffer is seen in a frame, use that frame for that buffer.
674 ;;; If it is not seen, use the current frame.
675 ;;; If both buffers are not seen, they share the current frame. If one
676 ;;; of the buffers is not seen, it is placed in the current frame (where
677 ;;; ediff started). If that frame is displaying the other buffer, it is
678 ;;; shared between the two buffers.
679 ;;; However, if we decide to put both buffers in one frame
680 ;;; and the selected frame isn't splittable, we create a new frame and
681 ;;; put both buffers there, event if one of this buffers is visible in
682 ;;; another frame.
684 ;; Skip dedicated or iconified frames.
685 ;; Unsplittable frames are taken care of later.
697 ;; on wide display, do things in one frame
700 ;; this lets us have local versions of ediff-split-window-function
723 wind-A-start wind-B-start
724 designated-minibuffer-frame
725 done-A done-B done-C)
737 ;; buffer buf-A is seen in live wind-A
745 ;; buffer buf-B is seen in live wind-B
753 ;; buffer buf-C is seen in live wind-C
763 ;; avoid dedicated and non-splittable windows
771 (/
791 done-B t
792 done-C t)
793 ))
796 ;;; or it was set before because use-same-frame = 1
798 ;; Buf-A was not set up yet as it wasn't visible,
799 ;; and use-same-frame = nil
804 ))
806 ;;; or it was set before because use-same-frame = 1
808 ;; Buf-B was not set up yet as it wasn't visible,
809 ;; and use-same-frame = nil
814 ))
818 ;;; or it was set before because use-same-frame = 1
820 ;; Buf-C was not set up yet as it wasn't visible,
821 ;; and use-same-frame = nil
826 )))
830 ediff-window-B wind-B
831 ediff-window-C wind-C)
834 designated-minibuffer-frame
837 ;; It is unlikely that we'll implement a version of ediff-windows that
838 ;; would compare 3 windows at once. So, we don't use buffer C here.
845 ))
847 ;; skip unsplittable frames and frames that have dedicated windows.
848 ;; create a new splittable frame if none is found
852 seen-windows)
857 ;; skip small windows
861 nil
863 ;; remember history
865 ;; try new window
868 )
870 ;; fed up, no appropriate frames
874 )))
881 'ignore-minibuffer
882 frame)
883 ans))
885 ;; window is ok, if it is only one window on the frame, not counting the
886 ;; minibuffer, or none of the frame's windows is dedicated.
887 ;; The idea is that it is bad to destroy dedicated windows while creating an
888 ;; ediff window setup
893 ;; only one window
895 ;; none is dedicated (in multiframe setup)
897 )))
899 ;; Prepare or refresh control frame
902 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
903 ctl-frame old-ctl-frame lines
904 ;; user-grabbed-mouse
905 fheight fwidth adjusted-parameters)
910 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
916 old-ctl-frame
918 ediff-control-frame ctl-frame)
919 ;; protect against undefined face-attribute
928 ()
932 ;; must be before ediff-setup-control-buffer
933 ;; just a precaution--we should be in ctl-buffer already
944 dont-iconify-ctl-frame))
946 ;; 1 more line for the modeline
948 fheight lines
951 adjusted-parameters
953 ;; possibly change surrogate minibuffer
956 designated-minibuffer-frame))
960 ))
962 ;; adjust autoraise
967 adjusted-parameters))
969 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
970 ;; are changed.
977 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
981 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
982 ;; to make sure that at least once we do it for non-iconified frame. If
983 ;; appears that in the OS/2 port of Emacs, one can't modify frame
984 ;; parameters of iconified frames. As a precaution, we do likewise for
985 ;; windows-nt.
989 ;; make or zap toolbar (if not requested)
997 ;; This works around a bug in 19.25 and earlier. There, if frame gets
998 ;; iconified, the current buffer changes to that of the frame that
999 ;; becomes exposed as a result of this iconification.
1000 ;; So, we make sure the current buffer doesn't change.
1012 ;; Now move the frame. We must do it separately due to an obscure bug in
1013 ;; XEmacs
1015 ctl-frame
1018 ;; synchronize so the cursor will move to control frame
1019 ;; per RMS suggestion
1028 ;; don't warp the mouse, unless ediff-grab-mouse = t
1053 ;;(ediff-reset-mouse nil)
1054 )
1057 ;; finds a good place to clip control frame
1066 horizontal-adjustment upward-adjustment
1067 ctl-frame-top ctl-frame-left)
1069 ;; Multiple control frames are clipped based on the value of
1070 ;; ediff-control-buffer-number. This is done in order not to obscure
1071 ;; other active control panels.
1077 ctl-frame-left
1078 (+ frame-A-left
1081 (+ ediff-wide-control-frame-rightward-shift
1082 horizontal-adjustment))
1085 (+ ctl-frame-width
1086 ediff-narrow-control-frame-leftward-shift
1087 horizontal-adjustment))))))
1093 ctl-frame-left
1097 ;; keep ctl frame within the visible bounds
1103 )))
1111 "Construct an alist of parameters for the wide display.
1112 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1113 The frame to be resized is kept in `ediff-wide-display-frame'.
1114 This function modifies only the left margin and the width of the display.
1115 It assumes that it is called from within the control buffer."
1125 ediff-wide-display-frame frame-A)
1130 ;; Revise the mode line to display which difference we have selected
1131 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1132 ;; anothe invocations of Ediff.
1156 ediff-current-difference)
1157 " AncestorEmpty"
1159 )
1162 buf-B-state-diff ""
1165 ;; control buffer format
1170 ;; control buffer id
1175 ;; Force mode-line redisplay
1203 ;; we keep the second dummy string in the mode line format of the
1204 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1205 ;; ediff-strip-mode-line-format expects that.
1215 mode-line-format))))
1216 ))
1221 ;; set frame/icon titles for Emacs
1223 ediff-control-frame
1226 ))
1227 ;; set frame/icon titles for XEmacs
1230 ;; force an update of the frame title
1237 " "
1246 ediff-number-of-differences)))))
1251 ediff-control-buffer-suffix))
1256 ediff-number-of-differences)))
1259 ediff-number-of-differences)))
1263 ediff-number-of-differences)))))
1267 ;; If buff is not live, return nil
1275 ;;; Functions to decide when to redraw windows
1289 ;; if buffer C is defined then take it into account
1298 ctl-wind A-wind B-wind C-wind
1299 ediff-split-window-function
1301 ediff-wide-display-p)))))))
1307 ;; Local Variables:
1308 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1309 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1310 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1311 ;; End:
1313 ;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1314 ;;; ediff-wind.el ends here