| blob | 5b29ebcb411197a90f4b0a4cb47aafe8b258a462 |
1 ;;; ediff-wind.el --- window manipulation utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
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, or (at your option)
13 ;; 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;;; Code:
30 ;; Compiler pacifier
43 ;; declare-function does not exist in XEmacs
59 ))
60 ;; end pacifier
64 ;; be careful with ediff-tbar
73 "Ediff window manipulation."
80 "*Function called to set up windows.
81 Ediff provides a choice of three functions: `ediff-setup-windows-plain', for
82 doing everything in one frame, `ediff-setup-windows-multiframe', which sets
83 the control panel in a separate frame, and
84 `ediff-setup-windows-automatic' (the default), which chooses an appropriate
85 behavior based on the current window system. If the multiframe function
86 detects that one of the buffers A/B is seen in some other frame, it will try
87 to keep that buffer in that frame.
89 If you don't like the two functions provided---write your own one.
90 The basic guidelines:
91 1. It should leave the control buffer current and the control window
92 selected.
93 2. It should set `ediff-window-A', `ediff-window-B', `ediff-window-C',
94 and `ediff-control-window' to contain window objects that display
95 the corresponding buffers.
96 3. It should accept the following arguments:
97 buffer-A, buffer-B, buffer-C, control-buffer
98 Buffer C may not be used in jobs that compare only two buffers.
99 If you plan to do something fancy, take a close look at how the two
100 provided functions are written."
107 ;; indicates if we are in a multiframe setup
110 ;; Share of the frame occupied by the merge window (buffer C)
113 ;; The control window.
115 ;; Official window for buffer A
117 ;; Official window for buffer B
119 ;; Official window for buffer C
121 ;; Ediff's window configuration.
122 ;; Used to minimize the need to rearrange windows.
125 ;; 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."
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 ;; Definitions hidden from the compiler by compat wrappers.
162 ;;'(unsplittable . t)
172 ;; don't lower but auto-raise
176 ;; make initial frame small to avoid distraction
178 ;; this blocks queries from window manager as to where to put
179 ;; ediff's control frame. we put the frame outside the display,
180 ;; so the initial frame won't jump all over the screen
187 )
188 "Frame parameters for displaying Ediff Control Panel.
191 ;; position of the mouse; used to decide whether to warp the mouse into ctl
192 ;; frame
195 ;; not used for now
197 "If the user moves mouse more than this many pixels, Ediff won't warp mouse into control window.")
200 "*If t, Ediff will always grab the mouse and put it in the control frame.
201 If 'maybe, Ediff will do it sometimes, but not after operations that require
202 relatively long time. If nil, the mouse will be entirely user's
203 responsibility."
208 "Function to call to determine the desired location for the control panel.
209 Expects three parameters: the control buffer, the desired width and height
210 of the control frame. It returns an association list
211 of the form \(\(top . <position>\) \(left . <position>\)\)"
216 "*The upward shift of control frame from the top of buffer A's frame.
217 Measured in pixels.
218 This is used by the default control frame positioning function,
219 `ediff-make-frame-position'. This variable is provided for easy
220 customization of the default control frame positioning."
225 "*The leftward shift of control frame from the right edge of buf A's frame.
226 Measured in characters.
227 This is used by the default control frame positioning function,
228 `ediff-make-frame-position' to adjust the position of the control frame
229 when it shows the short menu. This variable is provided for easy
230 customization of the default."
235 "*The rightward shift of control frame from the left edge of buf A's frame.
236 Measured in characters.
237 This is used by the default control frame positioning function,
238 `ediff-make-frame-position' to adjust the position of the control frame
239 when it shows the full menu. This variable is provided for easy
240 customization of the default."
245 ;; Wide frame display
247 ;; t means Ediff is using wide display
249 ;; keeps frame config for toggling wide display
251 "Frame parameters to be restored when the user wants to toggle the wide
256 "The value is a function that is called to create a wide display.
257 The function is called without arguments. It should resize the frame in
258 which buffers A, B, and C are to be displayed, and it should save the old
259 frame parameters in `ediff-wide-display-orig-parameters'.
260 The variable `ediff-wide-display-frame' should be set to contain
263 ;; Frame used for the control panel in a windowing system.
267 "*If t, keep control panel iconified when help message is off.
268 This has effect only on a windowing system.
269 If t, hitting `?' to toggle control panel off iconifies it.
271 This is only useful in Emacs and only for certain kinds of window managers,
272 such as TWM and its derivatives, since the window manager must permit
273 keyboard input to go into icons. XEmacs completely ignores keyboard input
274 into icons, regardless of the window manager."
278 ;;; Functions
294 ;; Select the lowest window on the frame.
298 ;; emacs
310 lowest-window this-window))
317 ;;; Common window setup routines
319 ;; Set up the window configuration. If POS is given, set the points to
320 ;; the beginnings of the buffers.
321 ;; When 3way comparison is added, this will have to choose the appropriate
322 ;; setup function based on ediff-job-name
324 ;; Make sure we are not in the minibuffer window when we try to delete
325 ;; all other windows.
330 ;; in case user did a no-no on a tty
337 buffer-A buffer-B buffer-C control-buffer))
340 ;; Set up windows using the correct method based on the current window system.
346 ;; Just set up 3 windows.
347 ;; Usually used without windowing systems
348 ;; With windowing, we want to use dedicated frames.
354 buffer-A buffer-B buffer-C control-buffer)
356 buffer-A buffer-B buffer-C control-buffer)))
359 ;; skip dedicated and unsplittable frames
362 split-window-function
363 merge-window-share merge-window-lines
364 wind-A wind-B wind-C)
367 ;; this lets us have local versions of ediff-split-window-function
368 split-window-function ediff-split-window-function))
374 ;; go to the upper window and split it betw A, B, and possibly C
381 ;; XEmacs used to have a lot of trouble with display
382 ;; It did't set things right unless we tell it to sit still
383 ;; 19.12 seems ok.
384 ;;(if (featurep 'xemacs) (sit-for 0))
402 ediff-window-B wind-B
403 ediff-window-C wind-C))
407 ))
410 ;; This function handles all comparison jobs, including 3way jobs
412 ;; skip dedicated and unsplittable frames
415 split-window-function wind-width-or-height
416 three-way-comparison
417 wind-A-start wind-B-start wind-A wind-B wind-C)
425 ;; this lets us have local versions of ediff-split-window-function
426 split-window-function ediff-split-window-function
427 three-way-comparison ediff-3way-comparison-job))
433 ;; go to the upper window and split it betw A, B, and possibly C
444 ;; XEmacs used to have a lot of trouble with display
445 ;; It did't set things right unless we told it to sit still
446 ;; 19.12 seems ok.
447 ;;(if (featurep 'xemacs) (sit-for 0))
466 ediff-window-B wind-B
467 ediff-window-C wind-C))
469 ;; It is unlikely that we will want to implement 3way window comparison.
470 ;; So, only buffers A and B are used here.
478 ))
481 ;; dispatch an appropriate window setup function
490 ;;; Algorithm:
491 ;;; 1. Never use frames that have dedicated windows in them---it is bad to
492 ;;; destroy dedicated windows.
493 ;;; 2. If A and B are in the same frame but C's frame is different--- use one
494 ;;; frame for A and B and use a separate frame for C.
495 ;;; 3. If C's frame is non-existent, then: if the first suitable
496 ;;; non-dedicated frame is different from A&B's, then use it for C.
497 ;;; Otherwise, put A,B, and C in one frame.
498 ;;; 4. If buffers A, B, C are is separate frames, use them to display these
499 ;;; buffers.
501 ;; Skip dedicated or iconified frames.
502 ;; Unsplittable frames are taken care of later.
512 ;; on wide display, do things in one frame
515 ;; this lets us have local versions of ediff-split-window-function
521 ;; A and C must be in one frame
523 ;; B and C must be in one frame
525 ;; A or B is not visible
528 ;; A or B is not suitable for display
531 ;; A and B in the same frame, and no good frame
532 ;; for C
535 ))
536 ;; use-same-frame-for-AB implies wind A and B are ok for display
540 ediff-merge-window-share))
541 merge-window-lines
542 designated-minibuffer-frame
543 done-A done-B done-C)
545 ;; buf-A on its own
550 ;; buffer buf-A is seen in live wind-A
556 ;; buf-B on its own
561 ;; buffer buf-B is seen in live wind-B
567 ;; buf-C on its own
572 ;; buffer buf-C is seen in live wind-C
581 ;; wind-A must already be displaying buf-A
593 done-B t)))
601 ;; avoid dedicated and non-splittable windows
625 done-B t
626 done-C t)
627 ))
630 ;;; or it was set before because use-same-frame = 1
632 ;; Buf-A was not set up yet as it wasn't visible,
633 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
638 ))
640 ;;; or it was set before because use-same-frame = 1
642 ;; Buf-B was not set up yet as it wasn't visible
643 ;; and use-same-frame = nil, use-same-frame-for-AB = nil
648 ))
651 ;;; or it was set before because use-same-frame = 1
653 ;; Buf-C was not set up yet as it wasn't visible
654 ;; and use-same-frame = nil
659 ))
663 ediff-window-B wind-B
664 ediff-window-C wind-C)
666 designated-minibuffer-frame
670 ))
673 ;; Window setup for all comparison jobs, including 3way comparisons
675 ;;; Algorithm:
676 ;;; If a buffer is seen in a frame, use that frame for that buffer.
677 ;;; If it is not seen, use the current frame.
678 ;;; If both buffers are not seen, they share the current frame. If one
679 ;;; of the buffers is not seen, it is placed in the current frame (where
680 ;;; ediff started). If that frame is displaying the other buffer, it is
681 ;;; shared between the two buffers.
682 ;;; However, if we decide to put both buffers in one frame
683 ;;; and the selected frame isn't splittable, we create a new frame and
684 ;;; put both buffers there, event if one of this buffers is visible in
685 ;;; another frame.
687 ;; Skip dedicated or iconified frames.
688 ;; Unsplittable frames are taken care of later.
700 ;; on wide display, do things in one frame
703 ;; this lets us have local versions of ediff-split-window-function
726 wind-A-start wind-B-start
727 designated-minibuffer-frame
728 done-A done-B done-C)
740 ;; buffer buf-A is seen in live wind-A
748 ;; buffer buf-B is seen in live wind-B
756 ;; buffer buf-C is seen in live wind-C
766 ;; avoid dedicated and non-splittable windows
774 (/
794 done-B t
795 done-C t)
796 ))
799 ;;; or it was set before because use-same-frame = 1
801 ;; Buf-A was not set up yet as it wasn't visible,
802 ;; and use-same-frame = nil
807 ))
809 ;;; or it was set before because use-same-frame = 1
811 ;; Buf-B was not set up yet as it wasn't visible,
812 ;; and use-same-frame = nil
817 ))
821 ;;; or it was set before because use-same-frame = 1
823 ;; Buf-C was not set up yet as it wasn't visible,
824 ;; and use-same-frame = nil
829 )))
833 ediff-window-B wind-B
834 ediff-window-C wind-C)
837 designated-minibuffer-frame
840 ;; It is unlikely that we'll implement a version of ediff-windows that
841 ;; would compare 3 windows at once. So, we don't use buffer C here.
848 ))
850 ;; skip unsplittable frames and frames that have dedicated windows.
851 ;; create a new splittable frame if none is found
855 seen-windows)
860 ;; skip small windows
864 nil
866 ;; remember history
868 ;; try new window
871 )
873 ;; fed up, no appropriate frames
877 )))
884 'ignore-minibuffer
885 frame)
886 ans))
888 ;; window is ok, if it is only one window on the frame, not counting the
889 ;; minibuffer, or none of the frame's windows is dedicated.
890 ;; The idea is that it is bad to destroy dedicated windows while creating an
891 ;; ediff window setup
896 ;; only one window
898 ;; none is dedicated
900 )))
902 ;; Prepare or refresh control frame
905 ctl-frame-iconified-p dont-iconify-ctl-frame deiconify-ctl-frame
906 ctl-frame old-ctl-frame lines
907 ;; user-grabbed-mouse
908 fheight fwidth adjusted-parameters)
913 ;;(setq user-grabbed-mouse (ediff-user-grabbed-mouse))
919 old-ctl-frame
921 ediff-control-frame ctl-frame)
922 ;; protect against undefined face-attribute
932 ()
936 ;; must be before ediff-setup-control-buffer
937 ;; just a precaution--we should be in ctl-buffer already
948 dont-iconify-ctl-frame))
950 ;; 1 more line for the modeline
952 fheight lines
955 adjusted-parameters
957 ;; possibly change surrogate minibuffer
960 designated-minibuffer-frame))
964 ))
966 ;; adjust autoraise
971 adjusted-parameters))
973 ;; In XEmacs, buffer menubar needs to be killed before frame parameters
974 ;; are changed.
981 ;;(set-specifier bottom-toolbar-height (list ctl-frame 0))
985 ;; Under OS/2 (emx) we have to call modify frame parameters twice, in order
986 ;; to make sure that at least once we do it for non-iconified frame. If
987 ;; appears that in the OS/2 port of Emacs, one can't modify frame
988 ;; parameters of iconified frames. As a precaution, we do likewise for
989 ;; windows-nt.
993 ;; make or zap toolbar (if not requested)
1001 ;; This works around a bug in 19.25 and earlier. There, if frame gets
1002 ;; iconified, the current buffer changes to that of the frame that
1003 ;; becomes exposed as a result of this iconification.
1004 ;; So, we make sure the current buffer doesn't change.
1016 ;; Now move the frame. We must do it separately due to an obscure bug in
1017 ;; XEmacs
1019 ctl-frame
1022 ;; synchronize so the cursor will move to control frame
1023 ;; per RMS suggestion
1032 ;; don't warp the mouse, unless ediff-grab-mouse = t
1056 ;;(ediff-reset-mouse nil)
1057 )
1060 ;; finds a good place to clip control frame
1069 horizontal-adjustment upward-adjustment
1070 ctl-frame-top ctl-frame-left)
1072 ;; Multiple control frames are clipped based on the value of
1073 ;; ediff-control-buffer-number. This is done in order not to obscure
1074 ;; other active control panels.
1080 ctl-frame-left
1081 (+ frame-A-left
1084 (+ ediff-wide-control-frame-rightward-shift
1085 horizontal-adjustment))
1088 (+ ctl-frame-width
1089 ediff-narrow-control-frame-leftward-shift
1090 horizontal-adjustment))))))
1096 ctl-frame-left
1100 ;; keep ctl frame within the visible bounds
1106 )))
1114 "Construct an alist of parameters for the wide display.
1115 Saves the old frame parameters in `ediff-wide-display-orig-parameters'.
1116 The frame to be resized is kept in `ediff-wide-display-frame'.
1117 This function modifies only the left margin and the width of the display.
1118 It assumes that it is called from within the control buffer."
1128 ediff-wide-display-frame frame-A)
1133 ;; Revise the mode line to display which difference we have selected
1134 ;; Also resets modelines of buffers A/B, since they may be clobbered by
1135 ;; anothe invocations of Ediff.
1159 ediff-current-difference)
1160 " AncestorEmpty"
1162 )
1165 buf-B-state-diff ""
1168 ;; control buffer format
1173 ;; control buffer id
1178 ;; Force mode-line redisplay
1206 ;; we keep the second dummy string in the mode line format of the
1207 ;; ancestor, since for other buffers Ediff prepends 2 strings and
1208 ;; ediff-strip-mode-line-format expects that.
1218 mode-line-format))))
1219 ))
1224 ;; set frame/icon titles for Emacs
1226 ediff-control-frame
1229 ))
1230 ;; set frame/icon titles for XEmacs
1233 ;; force an update of the frame title
1240 " "
1249 ediff-number-of-differences)))))
1254 ediff-control-buffer-suffix))
1259 ediff-number-of-differences)))
1262 ediff-number-of-differences)))
1266 ediff-number-of-differences)))))
1270 ;; If buff is not live, return nil
1278 ;;; Functions to decide when to redraw windows
1292 ;; if buffer C is defined then take it into account
1301 ctl-wind A-wind B-wind C-wind
1302 ediff-split-window-function
1304 ediff-wide-display-p)))))))
1310 ;;; Local Variables:
1311 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
1312 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
1313 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
1314 ;;; End:
1316 ;;; arch-tag: 73d9a5d7-eed7-4d9c-8b4b-21d5d78eb597
1317 ;;; ediff-wind.el ends here