| blob | e222cb04eef4b408deee36ef37b49c11d4b26d84 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next' and `window-prev'
67 ;; but the WINDOW argument is _not_ optional (so they don't substitute
68 ;; the selected window for nil), and they return nil when WINDOW doesn't
69 ;; have a parent (like a frame's root window or a minibuffer window).
71 "Return WINDOW's right sibling.
72 Return nil if WINDOW is the root window of its frame. WINDOW can
73 be any window."
77 "Return WINDOW's left sibling.
78 Return nil if WINDOW is the root window of its frame. WINDOW can
79 be any window."
83 "Return WINDOW's first child window."
87 "Return number of WINDOW's child windows."
93 count))
96 "Return last child window of WINDOW."
100 window)
103 "Return t if OBJECT denotes a live or internal window."
106 t))
108 ;; The following four functions should probably go to subr.el.
110 "Return buffer specified by BUFFER-OR-NAME.
111 BUFFER-OR-NAME must be either a buffer or a string naming a live
112 buffer and defaults to the current buffer."
118 buffer-or-name
125 "Return frame specified by FRAME.
126 FRAME must be a live frame and defaults to the selected frame."
129 frame
134 "Return window specified by WINDOW.
135 WINDOW must be a window that has not been deleted and defaults to
136 the selected window."
139 window
144 "Return live window specified by WINDOW.
145 WINDOW must be a live window and defaults to the selected one."
148 window
153 "If non-nil, standard functions ignore window parameters.
154 The functions currently affected by this are `split-window',
155 `delete-window', `delete-other-windows' and `other-window'.
157 An application may bind this to a non-nil value around calls to
161 "The absolut minimum number of lines of a window.
165 "The minimum number of lines of any window.
166 The value has to accomodate a mode- or header-line if present. A
167 value less than `window-safe-min-height' is ignored. The value
168 of this variable is honored when windows are resized or split.
170 Applications should never rebind this variable. To resize a
171 window to a height less than the one specified here, an
172 application should instead call `resize-window' with a non-nil
173 IGNORE argument. In order to have `split-window' make a window
174 shorter, explictly specify the SIZE argument of that function."
180 "The absolut minimum number of columns of a window.
184 "The minimum number of columns of any window.
185 The value has to accomodate margins, fringes, or scrollbars if
186 present. A value less than `window-safe-min-width' is ignored.
187 The value of this variable is honored when windows are resized or
188 split.
190 Applications should never rebind this variable. To resize a
191 window to a width less than the one specified here, an
192 application should instead call `resize-window' with a non-nil
193 IGNORE argument. In order to have `split-window' make a window
194 narrower, explictly specify the SIZE argument of that function."
200 "If WINDOW is a vertical combination return WINDOW's first child.
201 WINDOW can be any window and defaults to the selected one.
202 Optional argument HORIZONTAL non-nil means return WINDOW's first
203 child if WINDOW is a horizontal combination."
210 "Return non-nil if and only if WINDOW is vertically combined.
211 WINDOW can be any window and defaults to the selected one.
212 Optional argument HORIZONTAL non-nil means return non-nil if and
213 only if WINDOW is horizontally combined."
219 "Return largest number of vertically arranged subwindows of WINDOW.
220 WINDOW can be any window and defaults to the selected one.
221 Optional argument HORIZONTAL non-nil means to return the largest
222 number of horizontally arranged subwindows of WINDOW."
226 ;; If WINDOW is live, return 1.
229 ;; If WINDOW is iso-combined, return the sum of the values for all
230 ;; subwindows of WINDOW.
236 count))
238 count))
240 ;; If WINDOW is not iso-combined, return the maximum value of any
241 ;; subwindow of WINDOW.
247 count))
249 count))))
252 "Helper function for `walk-window-tree' and `walk-window-subtree'."
270 "Run function PROC on each live window of FRAME.
271 PROC must be a function with one argument - a window. FRAME must
272 be a live frame and defaults to the selected one. ANY, if
273 non-nil means to run PROC on all live and internal windows of
274 FRAME.
276 This function performs a pre-order, depth-first traversal of the
277 window tree. If PROC changes the window tree, the result is
278 unpredictable."
284 "Run function PROC on each live subwindow of WINDOW.
285 WINDOW defaults to the selected window. PROC must be a function
286 with one argument - a window. ANY, if non-nil means to run PROC
287 on all live and internal subwindows of WINDOW.
289 This function performs a pre-order, depth-first traversal of the
290 window tree rooted at WINDOW. If PROC changes that window tree,
291 the result is unpredictable."
296 "Return a list of all windows on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return windows whose window-parameter value of
299 PARAMETER equals VALUE \(comparison is done using `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too. Optional argument VALUES non-nil means return a list of cons
302 cells whose car is the value of the parameter and whose cdr is
303 the window."
313 frame any)
318 "Return first window on FRAME with PARAMETER non-nil.
319 FRAME defaults to the selected frame. Optional argument VALUE
320 non-nil means only return a window whose window-parameter value
321 for PARAMETER equals VALUE \(comparison is done with `equal').
322 Optional argument ANY non-nil means consider internal windows
323 too."
331 frame any))))
333 ;;; Atomic windows.
335 "Return root of atomic window WINDOW is a part of.
336 WINDOW can be any window and defaults to the selected one.
337 Return nil if WINDOW is not part of a atomic window."
343 root))
346 "Make WINDOW an atomic window.
347 WINDOW must be an internal window. Return WINDOW."
353 window t)
354 window))
357 "Subroutine of `window-atom-check'."
367 window t))
368 ;; count >= 1 must hold here. If there's no other
369 ;; window around dissolve this atomic window.
371 ;; Dissolve atomic window.
375 window t)))
376 ;; Check children.
380 ;; Check right sibling
384 "Check atomicity of all windows on FRAME.
385 FRAME defaults to the selected frame. If an atomic window is
386 wrongly configured, reset the atomicity of all its subwindows to
387 nil. An atomic window is wrongly configured if it has no
388 subwindows or one of its subwindows is not atomic."
391 ;; Side windows.
396 "If non-nil, left and right side windows are full height.
397 Otherwise, top and bottom side windows are full width."
403 "Maximum number of side window slots.
404 The value is a list of four elements specifying the number of
405 side window slots on \(in this order) the left, top, right and
406 bottom side of each frame. If an element is a number, this means
407 to display at most that many side windows on the corresponding
408 side. If an element is nil, this means there's no bound on the
409 number of slots on that side."
410 :risky t
411 :type
417 :value nil
424 :value nil
431 :value nil
438 :value nil
445 "Check the window-side parameter of all windows on FRAME.
446 FRAME defaults to the selected frame. If the configuration is
447 invalid, reset all window-side parameters to nil.
449 A valid configuration has to preserve the following invariant:
451 - If a window has a non-nil window-side parameter, it must have a
452 parent window and the parent window's window-side parameter
453 must be either nil or the same as for window.
455 - If windows with non-nil window-side parameters exist, there
456 must be at most one window of each side and non-side with a
457 parent whose window-side parameter is nil and there must be no
458 leaf window whose window-side parameter is nil."
460 side parent parent-side code)
468 ;; The following `cond' seems a bit tedious, but I'd
469 ;; rather stick to using just the stack.
473 ;; A parent whose window-side is non-nil must
474 ;; have a child with the same window-side.
476 ;; Now check that there's more than one main window
477 ;; for any of none, left, top, right and bottom.
499 ;; A leaf window without window-side parameter,
500 ;; record its existence.
502 frame t))
504 ;; At least one non-side window exists, so there must
505 ;; be at least one side-window and no normal window.
507 ;; No non-side window exists, so there must be no side
508 ;; window either.
513 frame t))))
516 "Check atomic and side windows on FRAME.
517 FRAME defaults to the selected frame."
521 ;;; Window sizes.
523 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
524 If the value is `height', then only the window's height is fixed.
525 If the value is `width', then only the window's width is fixed.
526 Any other non-nil value fixes both the width and the height.
528 Emacs won't change the size of any window displaying that buffer,
529 unless it has no other choice \(like when deleting a neighboring
534 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
538 "Return the minimum number of lines of WINDOW.
539 WINDOW can be an arbitrary window and defaults to the selected
540 one. Optional argument HORIZONTAL non-nil means return the
541 minimum number of columns of WINDOW.
543 Optional argument IGNORE non-nil means ignore any restrictions
544 imposed by fixed size windows, `window-min-height' or
545 `window-min-width' settings. IGNORE equal `safe' means live
546 windows may get as small as `window-safe-min-height' lines and
547 `window-safe-min-width' columns. IGNORE a window means ignore
548 restrictions for that window only."
553 "Internal function of `window-min-size'."
557 ;; WINDOW is an internal window.
559 ;; The minimum size of an iso-combination is the sum of
560 ;; the minimum sizes of its subwindows.
565 ;; The minimum size of an ortho-combination is the maximum of
566 ;; the minimum sizes of its subwindows.
571 value)
576 ;; The minimum size of a fixed size window is its size.
579 ;; If IGNORE equals `safe' or WINDOW return the safe values.
582 ;; For the minimum width of a window take fringes and
583 ;; scroll-bars into account. This is questionable and should
584 ;; be removed as soon as we are able to split (and resize)
585 ;; windows such that the new (or resized) windows can get a
586 ;; size less than the user-specified `window-min-height' and
587 ;; `window-min-width'.
592 (+ window-safe-min-width
605 window-min-width
608 ;; For the minimum height of a window take any mode- or
609 ;; header-line into account.
615 window-min-height
619 "Return DELTA if DELTA lines can be added to WINDOW.
620 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
621 columns can be added to WINDOW. A return value of zero means
622 that no lines (or columns) can be added to WINDOW.
624 This function looks only at WINDOW and its subwindows. The
625 function `window-resizable' looks at other windows as well.
627 DELTA positive means WINDOW shall be enlarged by DELTA lines or
628 columns. If WINDOW cannot be enlarged by DELTA lines or columns
629 return the maximum value in the range 0..DELTA by which WINDOW
630 can be enlarged.
632 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
633 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
634 return the minimum value in the range DELTA..0 by which WINDOW
635 can be shrunk.
637 Optional argument IGNORE non-nil means ignore any restrictions
638 imposed by fixed size windows, `window-min-height' or
639 `window-min-width' settings. IGNORE equal `safe' means live
640 windows may get as small as `window-safe-min-height' lines and
641 `window-safe-min-width' columns. IGNORE any window means ignore
642 restrictions for that window only."
648 delta))
650 delta)
653 0
654 delta))
658 "Return t if WINDOW can be resized by DELTA lines.
659 For the meaning of the arguments of this function see the
660 doc-string of `window-sizable'."
667 "Internal function for `window-size-fixed-p'."
671 ;; WINDOW is an internal window.
673 ;; An iso-combination is fixed size if all its subwindows
674 ;; are fixed-size.
678 ;; We found a non-fixed-size subwindow, so WINDOW's
679 ;; size is not fixed.
682 ;; All subwindows are fixed-size, so WINDOW's size is
683 ;; fixed.
685 ;; An ortho-combination is fixed-size if at least one of its
686 ;; subwindows is fixed-size.
689 ;; We found a fixed-size subwindow, so WINDOW's size is
690 ;; fixed.
693 ;; WINDOW is a live window.
700 "Return non-nil if WINDOW's height is fixed.
701 WINDOW can be an arbitrary window and defaults to the selected
702 window. Optional argument HORIZONTAL non-nil means return
703 non-nil if WINDOW's width is fixed.
705 If this function returns nil, this does not necessarily mean that
706 WINDOW can be resized in the desired direction. The functions
707 `window-resizable' and `window-resizable-p' will tell that."
712 "Internal function for `window-min-delta'."
714 ;; If we can't go up, return zero.
715 0
716 ;; Else try to find a non-fixed-size sibling of WINDOW.
721 ;; In an iso-combination throw DELTA if we find at least one
722 ;; subwindow and that subwindow is either not of fixed-size
723 ;; or we can ignore fixed-sizeness.
733 ;; We found a non-fixed-size subwindow.
736 ;; In an ortho-combination set DELTA to the minimum value by
737 ;; which other subwindows can shrink.
746 delta
750 "Return number of lines by which WINDOW can be shrunk.
751 WINDOW can be an arbitrary window and defaults to the selected
752 window. Return zero if WINDOW cannot be shrunk.
754 Optional argument HORIZONTAL non-nil means return number of
755 columns by which WINDOW can be shrunk.
757 Optional argument IGNORE non-nil means ignore any restrictions
758 imposed by fixed size windows, `window-min-height' or
759 `window-min-width' settings. IGNORE a window means ignore
760 restrictions for that window only. IGNORE equal `safe' means
761 live windows may get as small as `window-safe-min-height' lines
762 and `window-safe-min-width' columns.
764 Optional argument TRAIL `before' means only windows to the left
765 of or above WINDOW can be enlarged. Optional argument TRAIL
766 `after' means only windows to the right of or below WINDOW can be
767 enlarged.
769 Optional argument NOUP non-nil means don't go up in the window
770 tree but try to enlarge windows within WINDOW's combination only.
772 Optional argument NODOWN non-nil means don't check whether WINDOW
773 itself \(and its subwindows) can be shrunk; check only whether at
774 least one other windows can be enlarged appropriately."
780 ;; If NODOWN is t, try to recover the entire size of WINDOW.
783 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
784 ;; there's nothing to recover.
787 ;; Otherwise, try to recover whatever WINDOW is larger than its
788 ;; minimum size.
793 "Internal function of `window-max-delta'."
795 ;; Can't go up. Return DELTA.
796 delta
801 ;; For an iso-combination calculate how much we can get from
802 ;; other subwindows.
811 (+ delta
815 ;; For an ortho-combination throw DELTA when at least one
816 ;; subwindow is fixed-size.
824 ;; When NOUP is nil, DELTA is all we can get.
825 delta
826 ;; Else try with parent of WINDOW, passing the DELTA we
827 ;; recovered so far.
831 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
832 WINDOW can be an arbitrary window and defaults to the selected
833 window. The return value is zero if WINDOW cannot be enlarged.
835 Optional argument HORIZONTAL non-nil means return maximum number
836 of columns by which WINDOW can be enlarged.
838 Optional argument IGNORE non-nil means ignore any restrictions
839 imposed by fixed size windows, `window-min-height' or
840 `window-min-width' settings. IGNORE a window means ignore
841 restrictions for that window only. IGNORE equal `safe' means
842 live windows may get as small as `window-safe-min-height' lines
843 and `window-safe-min-width' columns.
845 Optional argument TRAIL `before' means only windows to the left
846 of or below WINDOW can be shrunk. Optional argument TRAIL
847 `after' means only windows to the right of or above WINDOW can be
848 shrunk.
850 Optional argument NOUP non-nil means don't go up in the window
851 tree but try to obtain the entire space from windows within
852 WINDOW's combination.
854 Optional argument NODOWN non-nil means do not check whether
855 WINDOW itself \(and its subwindows) can be enlarged; check only
856 whether other windows can be shrunk appropriately."
860 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
861 ;; size.
862 0
863 ;; WINDOW has no fixed size.
866 ;; Make NOUP also inhibit the min-size check.
868 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
869 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
870 can be resized horizontally by DELTA columns. A return value of
871 zero means that WINDOW is not resizable.
873 DELTA positive means WINDOW shall be enlarged by DELTA lines or
874 columns. If WINDOW cannot be enlarged by DELTA lines or columns
875 return the maximum value in the range 0..DELTA by which WINDOW
876 can be enlarged.
878 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
879 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
880 return the minimum value in the range DELTA..0 that can be used
881 for shrinking WINDOW.
883 Optional argument IGNORE non-nil means ignore any restrictions
884 imposed by fixed size windows, `window-min-height' or
885 `window-min-width' settings. IGNORE a window means ignore
886 restrictions for that window only. IGNORE equal `safe' means
887 live windows may get as small as `window-safe-min-height' lines
888 and `window-safe-min-width' columns.
890 Optional argument TRAIL `before' means only windows to the left
891 of or below WINDOW can be shrunk. Optional argument TRAIL
892 `after' means only windows to the right of or above WINDOW can be
893 shrunk.
895 Optional argument NOUP non-nil means don't go up in the window
896 tree but try to distribute the space among the other windows
897 within WINDOW's combination.
899 Optional argument NODOWN non-nil means don't check whether WINDOW
900 and its subwindows can be resized."
905 delta))
908 delta))
912 "Return t if WINDOW can be resized vertically by DELTA lines.
913 For the meaning of the arguments of this function see the
914 doc-string of `window-resizable'."
918 delta)
920 delta)))
923 "Return the total number of lines of WINDOW.
924 WINDOW can be any window and defaults to the selected one. The
925 return value includes WINDOW's mode line and header line, if any.
926 If WINDOW is internal the return value is the sum of the total
927 number of lines of WINDOW's child windows if these are vertically
928 combined and the height of WINDOW's first child otherwise.
930 Note: This function does not take into account the value of
931 `line-spacing' when calculating the number of lines in WINDOW."
934 ;; Eventually we should make `window-height' obsolete.
937 ;; See discussion in bug#4543.
939 "Return t if WINDOW is as high as the containing frame.
940 More precisely, return t if and only if the total height of
941 WINDOW equals the total height of the root window of WINDOW's
942 frame. WINDOW can be any window and defaults to the selected
943 one."
949 "Return the total number of columns of WINDOW.
950 WINDOW can be any window and defaults to the selected one. The
951 return value includes any vertical dividers or scrollbars of
952 WINDOW. If WINDOW is internal, the return value is the sum of
953 the total number of columns of WINDOW's child windows if these
954 are horizontally combined and the width of WINDOW's first child
955 otherwise."
959 "Return t if WINDOW is as wide as the containing frame.
960 More precisely, return t if and only if the total width of WINDOW
961 equals the total width of the root window of WINDOW's frame.
962 WINDOW can be any window and defaults to the selected one."
968 "Return the number of lines of WINDOW's body.
969 WINDOW must be a live window and defaults to the selected one.
971 The return value does not include WINDOW's mode line and header
972 line, if any. If a line at the bottom of the window is only
973 partially visible, that line is included in the return value. If
974 you do not want to include a partially visible bottom line in the
975 return value, use `window-text-height' instead."
979 "Return the number of columns of WINDOW's body.
980 WINDOW must be a live window and defaults to the selected one.
982 The return value does not include any vertical dividers or scroll
983 bars owned by WINDOW. On a window-system the return value does
984 not include the number of columns used for WINDOW's fringes or
985 display margins either."
988 ;; Eventually we should make `window-height' obsolete.
992 "Return the current scroll bar settings for WINDOW.
993 WINDOW must be a live window and defaults to the selected one.
995 The return value is a cons cell (VERTICAL . HORIZONTAL) where
996 VERTICAL specifies the current location of the vertical scroll
997 bars (`left', `right', or nil), and HORIZONTAL specifies the
998 current location of the horizontal scroll bars (`top', `bottom',
999 or nil).
1001 Unlike `window-scroll-bars', this function reports the scroll bar
1002 type actually used, once frame defaults and `scroll-bar-mode' are
1003 taken into account."
1016 "Cycle through all live windows, calling PROC for each one.
1017 PROC must specify a function with a window as its sole argument.
1018 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1019 windows to include in the walk.
1021 MINIBUF t means include the minibuffer window even if the
1022 minibuffer is not active. MINIBUF nil or omitted means include
1023 the minibuffer window only if the minibuffer is active. Any
1024 other value means do not include the minibuffer window even if
1025 the minibuffer is active.
1027 ALL-FRAMES nil or omitted means consider all windows on the
1028 selected frame, plus the minibuffer window if specified by the
1029 MINIBUF argument. If the minibuffer counts, consider all windows
1030 on all frames that share that minibuffer too. The following
1031 non-nil values of ALL-FRAMES have special meanings:
1033 - t means consider all windows on all existing frames.
1035 - `visible' means consider all windows on all visible frames on
1036 the current terminal.
1038 - 0 (the number zero) means consider all windows on all visible
1039 and iconified frames on the current terminal.
1041 - A frame means consider all windows on that frame only.
1043 Anything else means consider all windows on the selected frame
1044 and no others.
1046 This function changes neither the order of recently selected
1047 windows nor the buffer list."
1048 ;; If we start from the minibuffer window, don't fail to come
1049 ;; back to it.
1052 ;; Make sure to not mess up the order of recently selected
1053 ;; windows. Use `save-selected-window' and `select-window'
1054 ;; with second argument non-nil for this purpose.
1062 "Support function for `window-in-direction'."
1074 "Return window in DIRECTION as seen from WINDOW.
1075 DIRECTION must be one of `above', `below', `left' or `right'.
1076 WINDOW must be a live window and defaults to the selected one.
1077 IGNORE, when non-nil means a window can be returned even if its
1078 `no-other-window' parameter is non-nil."
1091 ;; The column / row value of `posn-at-point' can be nil for the
1092 ;; mini-window, guard against that.
1103 best best-2 best-diff-2-new)
1110 ;; Ignore ourselves.
1112 ;; Ignore W unless IGNORE is non-nil.
1118 ;; W is to the left or right of WINDOW and covers POSN.
1128 ;; W is to the left or right of WINDOW but does not
1129 ;; cover POSN.
1144 ;; W is above or below WINDOW and covers POSN.
1154 ;; W is above or below WINDOW but does not cover POSN.
1169 "Return a live window satisfying PREDICATE.
1170 More precisely, cycle through all windows calling the function
1171 PREDICATE on each one of them with the window as its sole
1172 argument. Return the first window for which PREDICATE returns
1173 non-nil. Windows are scanned starting with the window following
1174 the selcted window. If no window satisfies PREDICATE, return
1175 DEFAULT.
1177 MINIBUF t means include the minibuffer window even if the
1178 minibuffer is not active. MINIBUF nil or omitted means include
1179 the minibuffer window only if the minibuffer is active. Any
1180 other value means do not include the minibuffer window even if
1181 the minibuffer is active.
1183 ALL-FRAMES nil or omitted means consider all windows on the selected
1184 frame, plus the minibuffer window if specified by the MINIBUF
1185 argument. If the minibuffer counts, consider all windows on all
1186 frames that share that minibuffer too. The following non-nil
1187 values of ALL-FRAMES have special meanings:
1189 - t means consider all windows on all existing frames.
1191 - `visible' means consider all windows on all visible frames on
1192 the current terminal.
1194 - 0 (the number zero) means consider all windows on all visible
1195 and iconified frames on the current terminal.
1197 - A frame means consider all windows on that frame only.
1199 Anything else means consider all windows on the selected frame
1200 and no others."
1204 minibuf all-frames))
1207 default))
1212 "Return the least recently used window on frames specified by ALL-FRAMES.
1213 Return a full-width window if possible. A minibuffer window is
1214 never a candidate. A dedicated window is never a candidate
1215 unless DEDICATED is non-nil, so if all windows are dedicated, the
1216 value is nil. Avoid returning the selected window if possible.
1218 The following non-nil values of the optional argument ALL-FRAMES
1219 have special meanings:
1221 - t means consider all windows on all existing frames.
1223 - `visible' means consider all windows on all visible frames on
1224 the current terminal.
1226 - 0 (the number zero) means consider all windows on all visible
1227 and iconified frames on the current terminal.
1229 - A frame means consider all windows on that frame only.
1231 Any other value of ALL-FRAMES means consider all windows on the
1232 selected frame and no others."
1248 "Return the most recently used window on frames specified by ALL-FRAMES.
1249 Do not return a minibuffer window.
1251 The following non-nil values of the optional argument ALL-FRAMES
1252 have special meanings:
1254 - t means consider all windows on all existing frames.
1256 - `visible' means consider all windows on all visible frames on
1257 the current terminal.
1259 - 0 (the number zero) means consider all windows on all visible
1260 and iconified frames on the current terminal.
1262 - A frame means consider all windows on that frame only.
1264 Any other value of ALL-FRAMES means consider all windows on the
1265 selected frame and no others."
1272 best-window))
1275 "Return the largest window on frames specified by ALL-FRAMES.
1276 A minibuffer window is never a candidate. A dedicated window is
1277 never a candidate unless DEDICATED is non-nil, so if all windows
1278 are dedicated, the value is nil.
1280 The following non-nil values of the optional argument ALL-FRAMES
1281 have special meanings:
1283 - t means consider all windows on all existing frames.
1285 - `visible' means consider all windows on all visible frames on
1286 the current terminal.
1288 - 0 (the number zero) means consider all windows on all visible
1289 and iconified frames on the current terminal.
1291 - A frame means consider all windows on that frame only.
1293 Any other value of ALL-FRAMES means consider all windows on the
1294 selected frame and no others."
1296 best-window size)
1304 best-window))
1307 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1308 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1309 and defaults to the current buffer. Windows are scanned starting
1310 with the selected window.
1312 MINIBUF t means include the minibuffer window even if the
1313 minibuffer is not active. MINIBUF nil or omitted means include
1314 the minibuffer window only if the minibuffer is active. Any
1315 other value means do not include the minibuffer window even if
1316 the minibuffer is active.
1318 ALL-FRAMES nil or omitted means consider all windows on the
1319 selected frame, plus the minibuffer window if specified by the
1320 MINIBUF argument. If the minibuffer counts, consider all windows
1321 on all frames that share that minibuffer too. The following
1322 non-nil values of ALL-FRAMES have special meanings:
1324 - t means consider all windows on all existing frames.
1326 - `visible' means consider all windows on all visible frames on
1327 the current terminal.
1329 - 0 (the number zero) means consider all windows on all visible
1330 and iconified frames on the current terminal.
1332 - A frame means consider all windows on that frame only.
1334 Anything else means consider all windows on the selected frame
1335 and no others."
1337 windows)
1344 "Return t if WINDOW is the currently active minibuffer window."
1348 "Return the number of live windows on the selected frame.
1349 The optional argument MINIBUF specifies whether the minibuffer
1350 window shall be counted. See `walk-windows' for the precise
1351 meaning of this argument."
1353 \f
1354 ;;; Resizing windows.
1356 "Reset resize values for all windows on FRAME.
1357 FRAME defaults to the selected frame.
1359 This function stores the current value of `window-total-size' applied
1360 with argument HORIZONTAL in the new total size of all windows on
1361 FRAME. It also resets the new normal size of each of these
1362 windows."
1367 "Internal function of `resize-window-reset'."
1368 ;; Register old size in the new total size.
1370 ;; Reset new normal size.
1377 ;; The following routine is used to manually resize the minibuffer
1378 ;; window and is currently used, for example, by ispell.el.
1380 "Resize minibuffer window WINDOW by DELTA lines.
1381 If WINDOW cannot be resized by DELTA lines make it as large \(or
1382 as small) as possible but don't signal an error."
1390 ;; Sanitize DELTA.
1397 ;; Resize now.
1399 ;; Ideally we should be able to resize just the last subwindow of
1400 ;; root here. See the comment in `resize-root-window-vertically'
1401 ;; for why we do not do that.
1404 ;; The following routine catches the case where we want to resize
1405 ;; a minibuffer-only frame.
1409 "Resize WINDOW vertically by DELTA lines.
1410 WINDOW can be an arbitrary window and defaults to the selected
1411 one. An attempt to resize the root window of a frame will raise
1412 an error though.
1414 DELTA a positive number means WINDOW shall be enlarged by DELTA
1415 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1416 lines.
1418 Optional argument HORIZONTAL non-nil means resize WINDOW
1419 horizontally by DELTA columns. In this case a positive DELTA
1420 means enlarge WINDOW by DELTA columns. DELTA negative means
1421 WINDOW shall be shrunk by -DELTA columns.
1423 Optional argument IGNORE non-nil means ignore any restrictions
1424 imposed by fixed size windows, `window-min-height' or
1425 `window-min-width' settings. IGNORE any window means ignore
1426 restrictions for that window only. IGNORE equal `safe' means
1427 live windows may get as small as `window-safe-min-height' lines
1428 and `window-safe-min-width' columns.
1430 This function resizes other windows proportionally and never
1431 deletes any windows. If you want to move only the low (right)
1432 edge of WINDOW consider using `adjust-window-trailing-edge'
1433 instead."
1436 sibling)
1449 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1450 ;; an iso-combination, and WINDOW's neighboring right or left
1451 ;; sibling can be resized as requested, resize that sibling.
1458 normal-delta))
1461 normal-delta)))
1462 ;; Otherwise, resize all other windows in the same combination.
1469 "Return non-nil if WINDOW shall be skipped by resizing routines."
1472 (defun resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
1473 "Set the new normal height of subwindows of window PARENT.
1474 HORIZONTAL non-nil means set the new normal width of these
1475 windows. WINDOW specifies a subwindow of PARENT that has been
1476 resized by THIS-DELTA lines \(columns).
1478 Optional argument TRAIL either 'before or 'after means set values
1479 for windows before or after WINDOW only. Optional argument
1480 OTHER-DELTA a number specifies that this many lines \(columns)
1481 have been obtained from \(or returned to) an ancestor window of
1482 PARENT in order to resize WINDOW."
1486 ;; When WINDOW gets deleted and we can return its entire
1487 ;; space to its siblings, use WINDOW's normal size as the
1488 ;; normal delta.
1490 ;; In any other case calculate the normal delta from the
1491 ;; relation of THIS-DELTA to the total size of PARENT.
1497 ;; Set parent-normal to the sum of the normal sizes of all
1498 ;; subwindows of PARENT that shall be resized, excluding only WINDOW
1499 ;; and any windows specified by the optional TRAIL argument.
1510 ;; Set the new normal size of all subwindows of PARENT from what
1511 ;; they should have contributed for recovering THIS-DELTA lines
1512 ;; (columns).
1526 delta-normal))
1527 ;; Don't drop below 0.
1532 ;; Set the new normal size of windows from what they should have
1533 ;; contributed for recovering OTHER-DELTA lines (columns).
1536 other-delta)))
1548 ;; Don't drop below 0.
1552 ;; Set the new normal size of WINDOW to what is left by the sum of
1553 ;; the normal sizes of its siblings.
1555 window
1566 ;; Don't get larger than 1 or smaller than 0.
1570 "Resize subwindows of window PARENT vertically by DELTA lines.
1571 PARENT must be a vertically combined internal window.
1573 Optional argument HORIZONTAL non-nil means resize subwindows of
1574 PARENT horizontally by DELTA columns. In this case PARENT must
1575 be a horizontally combined internal window.
1577 WINDOW, if specified, must denote a child window of PARENT that
1578 is resized by DELTA lines.
1580 Optional argument IGNORE non-nil means ignore any restrictions
1581 imposed by fixed size windows, `window-min-height' or
1582 `window-min-width' settings. IGNORE equal `safe' means live
1583 windows may get as small as `window-safe-min-height' lines and
1584 `window-safe-min-width' columns. IGNORE any window means ignore
1585 restrictions for that window only.
1587 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1588 of windows that shall be resized. If TRAIL equals `before',
1589 resize only windows on the left or above EDGE. If TRAIL equals
1590 `after', resize only windows on the right or below EDGE. Also,
1591 preferably only resize windows adjacent to EDGE.
1593 Return the symbol `normalized' if new normal sizes have been
1594 already set by this routine."
1598 best-window best-value)
1610 sub)
1615 edge)
1620 edge)
1623 ;; Resize only windows adjacent to EDGE.
1628 ;; Assign new normal sizes.
1636 ;; Return 'normalized to notify `resize-other-windows' that
1637 ;; normal sizes have been already set.
1639 ;; Resize all windows proportionally.
1644 ;; Ignore windows to skip and fixed-size subwindows - in
1645 ;; the latter case make it a window to skip.
1650 ;; When shrinking store the number of lines/cols we can get
1651 ;; from this window here together with the total/normal size
1652 ;; factor.
1654 sub
1656 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1659 parent-total)
1662 ;; When enlarging store the total/normal size factor only
1664 sub
1666 parent-total)
1673 ;; Shrink windows by delta.
1692 best-window
1697 parent-total)
1700 ;; Enlarge windows by delta.
1718 best-window
1720 parent-total)
1728 ;; Reset new normal size fields so `resize-window-apply'
1729 ;; won't use them to apply new sizes.
1733 ;; Resize this subwindow's subwindows (back-engineering
1734 ;; delta from sub's old and new total sizes).
1738 ;; For the TRAIL non-nil case we have to resize SUB
1739 ;; recursively even if it's size does not change.
1741 sub delta horizontal ignore nil trail edge))))
1745 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1746 Optional argument HORIZONTAL non-nil means resize other windows
1747 when WINDOW is resized horizontally by DELTA columns. WINDOW
1748 itself is not resized by this function.
1750 Optional argument IGNORE non-nil means ignore any restrictions
1751 imposed by fixed size windows, `window-min-height' or
1752 `window-min-width' settings. IGNORE equal `safe' means live
1753 windows may get as small as `window-safe-min-height' lines and
1754 `window-safe-min-width' columns. IGNORE any window means ignore
1755 restrictions for that window only.
1757 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1758 of windows that shall be resized. If TRAIL equals `before',
1759 resize only windows on the left or above EDGE. If TRAIL equals
1760 `after', resize only windows on the right or below EDGE. Also,
1761 preferably only resize windows adjacent to EDGE."
1766 ;; In an iso-combination try to extract DELTA from WINDOW's
1767 ;; siblings.
1770 this-delta other-delta)
1771 ;; Decide which windows shall be left alone.
1775 ;; Make sure WINDOW is left alone when
1776 ;; resizing its siblings.
1780 ;; Make sure this sibling is left alone when
1781 ;; resizing its siblings.
1785 ;; Set this-delta to t to signal that we found a sibling
1786 ;; of WINDOW whose size is not fixed.
1791 ;; Set this-delta to what we can get from WINDOW's siblings.
1793 ;; A deletion, presumably. We must handle this case
1794 ;; specially since `window-resizable' can't be used.
1796 ;; There's at least one resizable sibling we can
1797 ;; give WINDOW's size to.
1799 ;; No resizable sibling exists.
1801 ;; Any other form of resizing.
1805 ;; Set other-delta to what we still have to get from
1806 ;; ancestor windows of parent.
1809 ;; Unless we got everything from WINDOW's siblings, PARENT
1810 ;; must be resized by other-delta lines or columns.
1814 ;; We haven't got anything from WINDOW's siblings but we
1815 ;; must update the normal sizes to respect other-delta.
1817 parent horizontal window this-delta trail other-delta)
1818 ;; We did get something from WINDOW's siblings which means
1819 ;; we have to resize their subwindows.
1821 window ignore trail edge)
1822 ;; `resize-subwindows' returning 'normalized,
1823 ;; means it has set the normal sizes already.
1825 ;; Set the normal sizes.
1827 parent horizontal window this-delta trail other-delta))
1828 ;; Set DELTA to what we still have to get from ancestor
1829 ;; windows.
1832 ;; In an ortho-combination all siblings of WINDOW must be
1833 ;; resized by DELTA.
1841 ;; "Go up."
1845 "Resize WINDOW vertically by DELTA lines.
1846 Optional argument HORIZONTAL non-nil means resize WINDOW
1847 horizontally by DELTA columns.
1849 Optional argument IGNORE non-nil means ignore any restrictions
1850 imposed by fixed size windows, `window-min-height' or
1851 `window-min-width' settings. IGNORE equal `safe' means live
1852 windows may get as small as `window-safe-min-height' lines and
1853 `window-safe-min-width' columns. IGNORE any window means ignore
1854 restrictions for that window only.
1856 Optional argument ADD non-nil means add DELTA to the new total
1857 size of WINDOW.
1859 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1860 of windows that shall be resized. If TRAIL equals `before',
1861 resize only windows on the left or above EDGE. If TRAIL equals
1862 `after', resize only windows on the right or below EDGE. Also,
1863 preferably only resize windows adjacent to EDGE.
1865 This function recursively resizes WINDOW's subwindows to fit the
1866 new size. Make sure that WINDOW is `window-resizable' before
1867 calling this function. Note that this function does not resize
1868 siblings of WINDOW or WINDOW's parent window. You have to
1869 eventually call `resize-window-apply' in order to make resizing
1870 actually take effect."
1872 ;; Add DELTA to the new total size of WINDOW.
1879 ;; In an iso-combination resize subwindows according to their
1880 ;; normal sizes.
1882 ;; In an ortho-combination resize each subwindow by DELTA.
1889 "Resize root window WINDOW vertically by DELTA lines.
1890 HORIZONTAL non-nil means resize root window WINDOW horizontally
1891 by DELTA columns.
1893 IGNORE non-nil means ignore any restrictions imposed by fixed
1894 size windows, `window-min-height' or `window-min-width' settings.
1896 This function is only called by the frame resizing routines. It
1897 resizes windows proportionally and never deletes any windows."
1904 "Resize root window WINDOW vertically by DELTA lines.
1905 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1906 lines, shrink it as much as possible. If DELTA is greater than
1907 zero, this function can resize fixed-size subwindows in order to
1908 recover the necessary lines.
1910 Return the number of lines that were recovered.
1912 This function is only called by the minibuffer window resizing
1913 routines. It resizes windows proportionally and never deletes
1914 any windows."
1925 ;; Ideally, we would resize just the last window in a combination
1926 ;; but that's not feasible for the following reason: If we grow
1927 ;; the minibuffer window and the last window cannot be shrunk any
1928 ;; more, we shrink another window instead. But if we then shrink
1929 ;; the minibuffer window again, the last window might get enlarged
1930 ;; and the state after shrinking is not the state before growing.
1931 ;; So, in practice, we'd need a history variable to record how to
1932 ;; proceed. But I'm not sure how such a variable could work with
1933 ;; repeated minibuffer window growing steps.
1935 delta)))
1938 "Move WINDOW's bottom edge by DELTA lines.
1939 Optional argument HORIZONTAL non-nil means move WINDOW's right
1940 edge by DELTA columns. WINDOW defaults to the selected window.
1942 If DELTA is greater zero, then move the edge downwards or to the
1943 right. If DELTA is less than zero, move the edge upwards or to
1944 the left. If the edge can't be moved by DELTA lines or columns,
1945 move it as far as possible in the desired direction."
1949 left this-delta min-delta max-delta failed)
1950 ;; Find the edge we want to move.
1963 ;; Set LEFT to the first resizable window on the left. This step is
1964 ;; needed to handle fixed-size windows.
1977 ;; Set RIGHT to the first resizable window on the right. This step
1978 ;; is needed to handle fixed-size windows.
1991 ;; LEFT and RIGHT (which might be both internal windows) are now the
1992 ;; two windows we want to resize.
1998 ;; We can't get the whole DELTA - move as far as possible.
2001 ;; Start resizing.
2003 ;; Try to enlarge LEFT first.
2007 left this-delta horizontal nil t 'before
2011 ;; Shrink windows on right of LEFT.
2013 left delta horizontal nil 'after
2021 ;; We can't get the whole DELTA - move as far as possible.
2024 ;; Start resizing.
2026 ;; Try to enlarge RIGHT.
2030 right this-delta horizontal nil t 'after
2034 ;; Shrink windows on left of RIGHT.
2041 ;; Don't report an error in the standard case.
2043 ;; But do report an error if applying the changes fails.
2047 "Make selected window DELTA lines taller.
2048 Interactively, if no argument is given, make the selected window
2049 one line taller. If optional argument HORIZONTAL is non-nil,
2050 make selected window wider by DELTA columns. If DELTA is
2051 negative, shrink selected window by -DELTA lines or columns.
2052 Return nil."
2065 horizontal))))
2068 "Make selected window DELTA lines smaller.
2069 Interactively, if no argument is given, make the selected window
2070 one line smaller. If optional argument HORIZONTAL is non-nil,
2071 make selected window narrower by DELTA columns. If DELTA is
2072 negative, enlarge selected window by -DELTA lines or columns.
2073 Return nil."
2086 horizontal))))
2089 "Maximize WINDOW.
2090 Make WINDOW as large as possible without deleting any windows.
2091 WINDOW can be any window and defaults to the selected window."
2098 "Minimize WINDOW.
2099 Make WINDOW as small as possible without deleting any windows.
2100 WINDOW can be any window and defaults to the selected window."
2105 \f
2107 "Return non-nil if WINDOW is the root window of its frame."
2111 "Return window tree rooted at WINDOW.
2112 Optional argument NEXT non-nil means include windows right
2113 siblings in the return value.
2115 See the documentation of `window-tree' for a description of the
2116 return value."
2129 list))
2134 "Return the window tree of frame FRAME.
2135 FRAME must be a live frame and defaults to the selected frame.
2136 The return value is a list of the form (ROOT MINI), where ROOT
2137 represents the window tree of the frame's root window, and MINI
2138 is the frame's minibuffer window.
2140 If the root window is not split, ROOT is the root window itself.
2141 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2142 for a horizontal split, and t for a vertical split. EDGES gives
2143 the combined size and position of the subwindows in the split,
2144 and the rest of the elements are the subwindows in the split.
2145 Each of the subwindows may again be a window or a list
2146 representing a window split, and so on. EDGES is a list \(LEFT
2147 TOP RIGHT BOTTOM) as returned by `window-edges'."
2150 \f
2152 "Select another window in cyclic ordering of windows.
2153 COUNT specifies the number of windows to skip, starting with the
2154 selected window, before making the selection. If COUNT is
2155 positive, skip COUNT windows forwards. If COUNT is negative,
2156 skip -COUNT windows backwards. COUNT zero means do not skip any
2157 window, so select the selected window. In an interactive call,
2158 COUNT is the numeric prefix argument. Return nil.
2160 If the `other-window' parameter of WINDOW is a function and
2161 `ignore-window-parameters' is nil, call that function with the
2162 arguments COUNT and ALL-FRAMES.
2164 This function does not select a window whose `no-other-window'
2165 window parameter is non-nil.
2167 This function uses `next-window' for finding the window to
2168 select. The argument ALL-FRAMES has the same meaning as in
2169 `next-window', but the MINIBUF argument of `next-window' is
2170 always effectively nil."
2175 old-window old-count)
2178 ;; `next-window' and `previous-window' may return a window we are
2179 ;; not allowed to select. Hence we need an exit strategy in case
2180 ;; all windows are non-selectable.
2187 ;; Keep out of infinite loops. When COUNT has not changed
2188 ;; since we last looked at `window' we're probably in one.
2192 ;; The first non-selectable window `next-window' got us:
2193 ;; Remember it and the current value of COUNT.
2203 ;; Keep out of infinite loops. When COUNT has not changed
2204 ;; since we last looked at `window' we're probably in one.
2208 ;; The first non-selectable window `previous-window' got
2209 ;; us: Remember it and the current value of COUNT.
2216 ;; Always return nil.
2217 nil))))
2219 ;; This should probably return non-nil when the selected window is part
2220 ;; of an atomic window whose root is the frame's root window.
2222 "Return non-nil if the selected window is the only window.
2223 Optional arg NOMINI non-nil means don't count the minibuffer
2224 even if it is active. Otherwise, the minibuffer is counted
2225 when it is active.
2227 Optional argument ALL-FRAMES specifies the set of frames to
2228 consider, see also `next-window'. ALL-FRAMES nil or omitted
2229 means consider windows on the selected frame only, plus the
2230 minibuffer window if specified by the NOMINI argument. If the
2231 minibuffer counts, consider all windows on all frames that share
2232 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2233 with a special meaning are:
2235 - t means consider all windows on all existing frames.
2237 - `visible' means consider all windows on all visible frames on
2238 the current terminal.
2240 - 0 (the number zero) means consider all windows on all visible
2241 and iconified frames on the current terminal.
2243 - A frame means consider all windows on that frame only.
2245 Anything else means consider all windows on the selected frame
2246 and no others."
2252 \f
2253 ;;; Deleting windows.
2255 "If non-nil, quitting a window can delete it's frame.
2256 If this variable is nil, functions that quit a window never
2257 delete the associated frame. If this variable equals the symbol
2258 `automatic', a frame is deleted only if it the window is
2259 dedicated or was created by `display-buffer'. If this variable
2260 is t, a frame can be always deleted, even if it was created by
2261 `make-frame-command'. Other values should not be used.
2263 Note that a frame will be effectively deleted if and only if
2264 another frame still exists.
2266 Functions quitting a window and consequently affected by this
2267 variable are `switch-to-prev-buffer', `delete-windows-on',
2268 `replace-buffer-in-windows' and `quit-restore-window'."
2277 "Return t if WINDOW can be safely deleted from its frame.
2278 Return `frame' if deleting WINDOW should delete its frame
2279 instead."
2282 ;; Handle atomicity.
2298 ;; WINDOW is the root window of its frame. Return `frame' but
2299 ;; only if WINDOW is (1) either dedicated or quit-restore's car
2300 ;; is new-frame and the window still displays the same buffer
2301 ;; and (2) there are other frames left.
2307 ;; Can't delete last main window.
2308 nil)
2312 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2322 "Delete WINDOW.
2323 WINDOW can be an arbitrary window and defaults to the selected
2324 one. Return nil.
2326 If the variable `ignore-window-parameters' is non-nil or the
2327 `delete-window' parameter of WINDOW equals t, do not process any
2328 parameters of WINDOW. Otherwise, if the `delete-window'
2329 parameter of WINDOW specifies a function, call that function with
2330 WINDOW as its sole argument and return the value returned by that
2331 function.
2333 Otherwise, if WINDOW is part of an atomic window, call
2334 `delete-window' with the root of the atomic window as its
2335 argument. If WINDOW is the only window on its frame or the last
2336 non-side window, signal an error."
2342 atom-root)
2345 ;; Handle window parameters.
2347 ;; Ignore window parameters if `ignore-window-parameters' tells
2348 ;; us so or `delete-window' equals t.
2351 ;; The `delete-window' parameter specifies the function to call.
2352 ;; If that function is `ignore' nothing is done. It's up to the
2353 ;; function called here to avoid infinite recursion.
2370 ;; Emacs 23 preferably gives WINDOW's space to its left
2371 ;; sibling.
2377 ;; Resize WINDOW's sibling.
2383 ;; Can do without resizing fixed-size windows.
2386 ;; Can't do without resizing fixed-size windows.
2388 ;; Actually delete WINDOW.
2393 ;; `delete-window-internal' has selected a window that should
2394 ;; not be selected, fix this here.
2398 ;; Always return nil.
2399 nil))))
2402 "Make WINDOW fill its frame.
2403 WINDOW may be any window and defaults to the selected one.
2404 Return nil.
2406 If the variable `ignore-window-parameters' is non-nil or the
2407 `delete-other-windows' parameter of WINDOW equals t, do not
2408 process any parameters of WINDOW. Otherwise, if the
2409 `delete-other-windows' parameter of WINDOW specifies a function,
2410 call that function with WINDOW as its sole argument and return
2411 the value returned by that function.
2413 Otherwise, if WINDOW is part of an atomic window, call this
2414 function with the root of the atomic window as its argument. If
2415 WINDOW is a non-side window, make WINDOW the only non-side window
2416 on the frame. Side windows are not deleted. If WINDOW is a side
2417 window signal an error."
2423 atom-root side-main)
2427 ;; Ignore window parameters if `ignore-window-parameters' is t or
2428 ;; `delete-other-windows' is t.
2431 ;; The `delete-other-windows' parameter specifies the function
2432 ;; to call. If the function is `ignore' no windows are deleted.
2433 ;; It's up to the function called to avoid infinite recursion.
2440 ;; Set side-main to the major non-side window.
2444 ;; If WINDOW is the main non-side window, do nothing.
2449 ;; Always return nil.
2450 nil)))
2453 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2455 if you often split windows horizontally."
2467 ;;; Windows and buffers.
2469 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2470 ;; for (1) determining which buffer to show in the window when its
2471 ;; buffer shall be buried or killed and (2) which buffer to show for
2472 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2474 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2475 ;; triples. The entries on this list are ordered by the time their
2476 ;; buffer has been removed from the window, the most recently removed
2477 ;; buffer's entry being first. The window-start and window-point
2478 ;; components are `window-start' and `window-point' at the time the
2479 ;; buffer was removed from the window which implies that the entry must
2480 ;; be added when `set-window-buffer' removes the buffer from the window.
2482 ;; `next-buffers' is the list of buffers that have been replaced
2483 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2484 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2485 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2486 ;; reset to nil by any action changing the window's buffer with the
2487 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2488 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2489 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2491 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2492 ;; if such a buffer was killed while the window was hidden within a
2493 ;; window configuration. Such killed buffers get removed whenever
2494 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2496 ;; The following function is called by `set-window-buffer' _before_ it
2497 ;; replaces the buffer of the argument window with the new buffer.
2499 "Record WINDOW's buffer.
2500 WINDOW must be a live window and defaults to the selected one."
2504 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2505 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2509 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2513 ;; Don't record insignificant buffers.
2515 ;; Add an entry for buffer to WINDOW's previous buffers.
2522 ;; We have an entry, update marker positions.
2525 ;; Make new markers.
2533 "Unrecord BUFFER in WINDOW.
2534 WINDOW must be a live window and defaults to the selected one.
2535 BUFFER must be a live buffer and defaults to the buffer of
2536 WINDOW."
2545 "Set WINDOW's buffer to BUFFER.
2546 Optional argument START non-nil means set WINDOW's start position
2547 to START. Optional argument POINT non-nil means set WINDOW's
2548 point to POINT. If WINDOW is selected this also sets BUFFER's
2549 `point' to POINT. If WINDOW is selected and the buffer it showed
2550 before was current this also makes BUFFER the current buffer."
2565 "In WINDOW switch to previous buffer.
2566 WINDOW must be a live window and defaults to the selected one.
2568 Optional argument BURY-OR-KILL non-nil means the buffer currently
2569 shown in WINDOW is about to be buried or killed and consequently
2570 shall not be switched to in future invocations of this command."
2574 ;; Save this since it's destroyed by `set-window-buffer'.
2576 entry new-buffer killed-buffers deletable visible)
2578 ;; When BURY-OR-KILL is non-nil, there's no previous buffer for
2579 ;; this window, and we can delete the window (or the frame) do
2580 ;; that.
2594 ;; Scan WINDOW's previous buffers first, skipping entries of next
2595 ;; buffers.
2607 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2608 ;; entries of next buffers. Note that when we bury or kill a
2609 ;; buffer we don't reverse the global buffer list to avoid showing
2610 ;; a buried buffer instead. Otherwise, we must reverse the global
2611 ;; buffer list in order to make sure that switching to the
2612 ;; previous/next buffer traverse it in opposite directions.
2621 ;; Try to avoid showing a buffer visible in some other window.
2627 ;; Scan reverted next buffers last (must not use nreverse
2628 ;; here!).
2630 ;; Actually, buffer _must_ be live here since otherwise it
2631 ;; would have been caught in the scan of previous buffers.
2642 ;; Show a buffer visible in another window.
2648 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2649 ;; of) next buffers.
2654 ;; Move `old-buffer' to head of WINDOW's restored list of next
2655 ;; buffers.
2659 ;; Remove killed buffers from WINDOW's previous and next buffers.
2667 ;; Return new-buffer.
2668 new-buffer))
2671 "In WINDOW switch to next buffer.
2672 WINDOW must be a live window and defaults to the selected one."
2677 new-buffer entry killed-buffers visible)
2682 ;; Scan WINDOW's next buffers first.
2693 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2694 ;; buffers entries.
2700 ;; Try to avoid showing a buffer visible in some other window.
2705 ;; Scan WINDOW's reverted previous buffers last (must not use
2706 ;; nreverse here!)
2717 ;; Show a buffer visible in another window.
2722 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2725 ;; Remove killed buffers from WINDOW's previous and next buffers.
2733 ;; Return new-buffer.
2734 new-buffer))
2737 "Search LIST for a valid buffer to display in FRAME.
2738 Return nil when all buffers in LIST are undesirable for display,
2739 otherwise return the first suitable buffer in LIST.
2741 Buffers not visible in windows are preferred to visible buffers,
2742 unless VISIBLE-OK is non-nil.
2743 If the optional argument FRAME is nil, it defaults to the selected frame.
2744 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2745 ;; This logic is more or less copied from other-buffer.
2748 found buf)
2761 "Return the last buffer in FRAME's buffer list.
2762 If BUFFER is the last buffer, return the preceding buffer
2763 instead. Buffers not visible in windows are preferred to visible
2764 buffers, unless optional argument VISIBLE-OK is non-nil.
2765 Optional third argument FRAME nil or omitted means use the
2766 selected frame's buffer list. If no such buffer exists, return
2767 the buffer `*scratch*', creating it if necessary."
2770 buffer visible-ok frame)
2774 scratch)))
2777 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2778 There it is the least likely candidate for `other-buffer' to
2780 select by default.
2782 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2783 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2784 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2785 remove the current buffer from the selected window if it is
2786 displayed there."
2789 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2790 ;; although it's not "here" (call it a feature).
2792 ;; Handle case where `buffer-or-name' is nil and the current buffer
2793 ;; is shown in the selected window.
2802 ;; Always return nil.
2803 nil))
2806 "Switch to the last buffer in the buffer list."
2811 "In selected window switch to next buffer."
2816 "In selected window switch to previous buffer."
2821 "Delete all windows showing BUFFER-OR-NAME.
2822 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2823 and defaults to the current buffer.
2825 The following non-nil values of the optional argument FRAME
2826 have special meanings:
2828 - t means consider all windows on the selected frame only.
2830 - `visible' means consider all windows on all visible frames on
2831 the current terminal.
2833 - 0 (the number zero) means consider all windows on all visible
2834 and iconified frames on the current terminal.
2836 - A frame means consider all windows on that frame only.
2838 Any other value of FRAME means consider all windows on all
2839 frames.
2841 When a window showing BUFFER-OR-NAME is dedicated and the only
2842 window of its frame, that frame is deleted when there are other
2843 frames left."
2846 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2847 ;; `window-list-1' based function.
2854 ;; Delete frame.
2857 ;; Delete window only.
2860 ;; In window switch to previous buffer.
2863 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2867 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2868 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2869 and defaults to the current buffer.
2871 When a window showing BUFFER-OR-NAME is either dedicated, or the
2872 window has no previous buffer, that window is deleted. If that
2873 window is the only window on its frame, the frame is deleted too
2874 when there are other frames left. If there are no other frames
2875 left, some other buffer is displayed in that window.
2877 This function removes the buffer denoted by BUFFER-OR-NAME from
2878 all window-local buffer lists."
2885 ;; Delete frame.
2888 ;; Delete window.
2891 ;; Switch to another buffer in window.
2894 ;; Unrecord BUFFER in WINDOW.
2898 "Quit WINDOW in some way.
2899 WINDOW must be a live window and defaults to the selected window.
2900 Return nil.
2902 According to information stored in WINDOW's `quit-restore' window
2903 parameter either \(1) delete WINDOW and its frame, \(2) delete
2904 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2905 or \(4) make WINDOW display some other buffer than the present
2906 one. If non-nil, reset `quit-restore' parameter to nil.
2908 Optional argument KILL non-nil means in addition kill WINDOW's
2909 buffer. If KILL is nil, put WINDOW's buffer at the end of the
2910 buffer list. Interactively, KILL is the prefix argument."
2915 deletable resize)
2918 ;; Check that WINDOW's buffer is still the same.
2922 ;; WINDOW can be deleted.
2925 ;; WINDOW's frame can be deleted.
2927 ;; Just delete WINDOW.
2929 ;; If the previously selected window is still alive, select it.
2933 ;; The buffer currently shown in WINDOW must still be the
2934 ;; buffer shown when its `quit-restore' parameter was created
2935 ;; in the first place.
2938 ;; Unrecord buffer.
2941 ;; Display buffer stored in the quit-restore parameter.
2949 ;; Reset the quit-restore parameter.
2954 ;; Otherwise, show another buffer in WINDOW and reset the
2955 ;; quit-restore parameter.
2960 ;; Kill WINDOW's old-buffer if requested
2962 nil))
2963 \f
2964 ;;; Splitting windows.
2966 "Return minimum height of any window when splitting windows.
2967 Optional argument HORIZONTAL non-nil means return minimum width."
2973 "Make a new window adjacent to WINDOW.
2974 WINDOW can be any window and defaults to the selected one.
2975 Return the new window which is always a live window.
2977 Optional argument SIZE a positive number means make WINDOW SIZE
2978 lines or columns tall. If SIZE is negative, make the new window
2979 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
2980 absolute value can be less than `window-min-height' or
2981 `window-min-width'; so this command can make a new window as
2982 small as one line or two columns. SIZE defaults to half of
2983 WINDOW's size. Interactively, SIZE is the prefix argument.
2985 Optional third argument SIDE nil (or `below') specifies that the
2986 new window shall be located below WINDOW. SIDE `above' means the
2987 new window shall be located above WINDOW. In both cases SIZE
2988 specifies the new number of lines for WINDOW \(or the new window
2989 if SIZE is negative) including space reserved for the mode and/or
2990 header line.
2992 SIDE t (or `right') specifies that the new window shall be
2993 located on the right side of WINDOW. SIDE `left' means the new
2994 window shall be located on the left of WINDOW. In both cases
2995 SIZE specifies the new number of columns for WINDOW \(or the new
2996 window provided SIZE is negative) including space reserved for
2997 fringes and the scrollbar or a divider column. Any other non-nil
2998 value for SIDE is currently handled like t (or `right').
3000 If the variable `ignore-window-parameters' is non-nil or the
3001 `split-window' parameter of WINDOW equals t, do not process any
3002 parameters of WINDOW. Otherwise, if the `split-window' parameter
3003 of WINDOW specifies a function, call that function with all three
3004 arguments and return the value returned by that function.
3007 root of that atomic window. The new window does not become a
3008 member of that atomic window.
3010 If WINDOW is live, properties of the new window like margins and
3011 scrollbars are inherited from WINDOW. If WINDOW is an internal
3012 window, these properties as well as the buffer displayed in the
3013 new window are inherited from the window selected on WINDOW's
3014 frame. The selected window is not changed by this function."
3022 ;; Rebind `window-nest' since in some cases we may have to
3023 ;; override its value.
3025 atom-root)
3030 ;; Ignore window parameters if either `ignore-window-parameters'
3031 ;; is t or the `split-window' parameter equals t.
3034 ;; The `split-window' parameter specifies the function to call.
3035 ;; If that function is `ignore', do nothing.
3037 ;; If WINDOW is a subwindow of an atomic window, split the root
3038 ;; window of that atomic window instead.
3047 ;; WINDOW is a side root window. To make sure that a new parent
3048 ;; window gets created set `window-nest' to t.
3052 ;; If `window-splits' is non-nil and SIZE is a non-negative
3053 ;; integer, we cannot reasonably resize other windows. Rather
3054 ;; bind `window-nest' to t to make sure that subsequent window
3055 ;; deletions are handled correctly.
3059 ;; `parent-size' is the size of WINDOW's parent, provided
3060 ;; it has one.
3062 ;; `resize' non-nil means we are supposed to resize other
3063 ;; windows in WINDOW's combination.
3066 ;; Resize makes sense in iso-combinations only.
3068 ;; `old-size' is the current size of WINDOW.
3070 ;; `new-size' is the specified or calculated size of the
3071 ;; new window.
3077 ;; When resizing try to give the new window the
3078 ;; average size of a window in its combination.
3081 (/ parent-size
3083 parent horizontal))))
3084 ;; Else try to give the new window half the size
3085 ;; of WINDOW (plus an eventual odd line).
3088 ;; SIZE non-negative specifies the new size of WINDOW.
3090 ;; Note: Specifying a non-negative SIZE is practically
3091 ;; always done as workaround for making the new window
3092 ;; appear above or on the left of the new window (the
3093 ;; ispell window is a typical example of that). In all
3094 ;; these cases the SIDE argument should be set to 'above
3095 ;; or 'left in order to support the 'resize option.
3096 ;; Here we have to nest the windows instead, see above.
3099 ;; SIZE negative specifies the size of the new window.
3101 new-parent new-normal)
3103 ;; Check SIZE.
3108 ;; SIZE unspecified, resizing.
3110 ;; Try again with minimum split size.
3116 ;; SIZE unspecified, no resizing.
3121 window-safe-min-width
3122 window-safe-min-width))))
3123 ;; SIZE specified as new size of old window. If the new size
3124 ;; is larger than the old size or the size of the new window
3125 ;; would be less than the safe minimum, signal an error.
3128 ;; SIZE specified, resizing.
3130 ;; If we cannot resize the parent give up.
3136 ;; SIZE specification violates minimum size restrictions.
3142 ;; Make new-parent non-nil if we need a new parent window;
3143 ;; either because we want to nest or because WINDOW is not
3144 ;; iso-combined.
3147 ;; Make new-normal the normal size of the new window.
3155 ;; Try to get space from OLD's siblings. We could go "up" and
3156 ;; try getting additional space from surrounding windows but
3157 ;; we won't be able to return space to those windows when we
3158 ;; delete the one we create here. Hence we do not go up.
3167 ;; Get entire space from WINDOW.
3172 new-normal)))
3175 ;; Inherit window-side parameters, if any.
3182 ;; Always return the new window.
3183 new)))))
3185 ;; I think this should be the default; I think people will prefer it--rms.
3188 in both children.
3189 This is often more convenient for editing.
3190 If nil, adjust point in each of the two windows to minimize redisplay.
3191 This is convenient on slow terminals, but point can move strangely.
3193 This option applies only to `split-window-above-each-other' and
3194 functions that call it. `split-window' always keeps the original
3195 point in both children."
3200 "Split selected window into two windows, one above the other.
3201 The upper window gets SIZE lines and the lower one gets the rest.
3202 SIZE negative means the lower window gets -SIZE lines and the
3203 upper one the rest. With no argument, split windows equally or
3204 close to it. Both windows display the same buffer, now current.
3206 If the variable `split-window-keep-point' is non-nil, both new
3207 windows will get the same value of point as the selected window.
3208 This is often more convenient for editing. The upper window is
3209 the selected window.
3211 Otherwise, we choose window starts so as to minimize the amount of
3212 redisplay; this is convenient on slow terminals. The new selected
3213 window is the one that the current value of point appears in. The
3214 value of point can change if the text around point is hidden by the
3215 new mode line.
3217 Regardless of the value of `split-window-keep-point', the upper
3218 window is the original one and the return value is the new, lower
3219 window."
3224 moved-by-window-height moved new-window bottom)
3226 ;; `split-window' would not signal an error here.
3247 ;; Always copy quit-restore parameter in interactive use.
3251 new-window))
3256 "Split selected window into two windows side by side.
3257 The selected window becomes the left one and gets SIZE columns.
3258 SIZE negative means the right window gets -SIZE lines.
3260 SIZE includes the width of the window's scroll bar; if there are
3261 no scroll bars, it includes the width of the divider column to
3262 the window's right, if any. SIZE omitted or nil means split
3263 window equally.
3265 The selected window remains selected. Return the new window."
3269 new-window)
3271 ;; `split-window' would not signal an error here.
3274 ;; Always copy quit-restore parameter in interactive use.
3278 new-window))
3281 \f
3282 ;;; Balancing windows.
3284 ;; The following routine uses the recycled code from an old version of
3285 ;; `resize-subwindows'. It's not very pretty, but coding it the way the
3286 ;; new `resize-subwindows' code does would hardly make it any shorter or
3287 ;; more readable (FWIW we'd need three loops - one to calculate the
3288 ;; minimum sizes per window, one to enlarge or shrink windows until the
3289 ;; new parent-size matches, and one where we shrink the largest/enlarge
3290 ;; the smallest window).
3292 "Subroutine of `balance-windows-1'.
3293 WINDOW must be an iso-combination."
3299 found failed size sub-total sub-delta sub-amount rest)
3314 ;; Ignore subwindows that should be ignored or are stuck.
3321 ;; Register the new total size for this subwindow.
3326 ;; We failed and need a new round.
3332 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3333 ;; (column) until `rest' is zero.
3341 ;; Fix rounding by trying to enlarge stuck windows by one line
3342 ;; (column) until `rest' equals zero.
3352 ;; Record new normal sizes.
3358 ;; Recursively balance each subwindow's subwindows.
3363 "Subroutine of `balance-windows'."
3375 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3376 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3377 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3378 subwindows of that frame's root window. If WINDOW-OR-FRAME
3379 denots a window, balance the sizes of all subwindows of that
3380 window."
3389 window-or-frame)
3393 ;; Balance vertically.
3397 ;; Balance horizontally.
3403 "Return t if WINDOW cannot be resized in DIRECTION.
3404 WINDOW defaults to the selected window. DIRECTION can be
3405 nil (i.e. any), `height' or `width'."
3412 ;;; A different solution to balance-windows.
3414 "Factor by which the window area should be over-estimated.
3415 This is used by `balance-windows-area'.
3420 "Wrapper around `resize-window' with error checking.
3421 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3422 ;; `resize-window' may fail if delta is too large.
3429 ;;(message "adjust: %s" (error-message-string err))
3433 "Make all visible windows the same area (approximately).
3434 See also `window-area-factor' to change the relative size of
3435 specific buffers."
3438 ;; Remove fixed-size windows.
3443 next)
3444 ;; Resizing a window changes the size of surrounding windows in complex
3445 ;; ways, so it's difficult to balance them all. The introduction of
3446 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3447 ;; very difficult to do. `balance-window' above takes an off-line
3448 ;; approach: get the whole window tree, then balance it, then try to
3449 ;; adjust the windows so they fit the result.
3450 ;; Here, instead, we take a "local optimization" approach, where we just
3451 ;; go through all the windows several times until nothing needs to be
3452 ;; changed. The main problem with this approach is that it's difficult
3453 ;; to make sure it terminates, so we use some heuristic to try and break
3454 ;; off infinite loops.
3455 ;; After a round without any change, we allow a second, to give a chance
3456 ;; to the carry to propagate a minor imbalance from the end back to
3457 ;; the beginning.
3459 ;; (message "New round")
3465 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3483 ;; Maybe diff is actually closer to 1 than to 0.
3487 ;; Change things smoothly.
3490 ;; Make sure negligible differences don't accumulate to
3491 ;; become significant.
3493 ;; This used `adjust-window-trailing-edge' before and uses
3494 ;; `resize-window' now. Error wrapping is still needed.
3496 ;; (sit-for 0.5)
3498 ;; If the same change has been seen already for this window,
3499 ;; we're most likely in an endless loop, so don't count it as
3500 ;; a change.
3504 ;; We've now basically balanced all the windows.
3505 ;; But there may be some minor off-by-one imbalance left over,
3506 ;; so let's do some fine tuning.
3507 ;; (bw-finetune wins)
3508 ;; (message "Done in %d rounds" round)
3509 ))
3511 ;;; Window states, how to get them and how to put them in a window.
3513 "Like LIST but do not add nil elements of ARGS."
3520 "Helper function for `window-state-get'."
3530 type
3542 window-state-ignored-parameters)
3547 ;; All buffer related things go in here - make the buffer
3548 ;; current when retrieving `point' and `mark'.
3578 "Return state of WINDOW as a Lisp object.
3579 WINDOW can be any window and defaults to the root window of the
3580 selected frame.
3582 Optional argument MARKERS non-nil means use markers for sampling
3583 positions like `window-point' or `window-start'. MARKERS should
3584 be non-nil only if the value is used for putting the state back
3585 in the same session (note that markers slow down processing).
3587 The return value can be used as argument for `window-state-put'
3588 to put the state recorded here into an arbitrary window. The
3589 value can be also stored on disk and read back in a new session."
3593 window
3596 ;; The return value is a cons whose car specifies some constraints on
3597 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3598 ;; WINDOW.
3600 ;; Frame related things would go into a function, say `frame-state',
3601 ;; calling `window-state-get' to insert the frame's root window.
3609 ;; These are probably not needed.
3618 "Helper function for `window-state-put'."
3623 ;; For a leaf window just add unprocessed entries to
3624 ;; `window-state-put-list'.
3631 size new)
3633 ;; Find the next child window. WINDOW always points to the
3634 ;; real window that we want to fill with what we find here.
3637 ;; The last child window. Below `window-state-put-1'
3638 ;; will put into it whatever ITEM has in store.
3640 ;; Not the last child window, prepare for splitting
3641 ;; WINDOW. SIZE is the new (and final) size of the old
3642 ;; window.
3645 ;; Use total size.
3647 ;; Use normalized size and round.
3651 item))))))
3653 ;; Use safe sizes, we try to resize later.
3655 window-safe-min-height
3656 window-safe-min-width)))
3660 ;; We must inherit the nesting, otherwise we might mess
3661 ;; up handling of atomic and side window.
3663 ;; Give up if we can't resize window down to safe sizes.
3668 ;; When creating the first child window add for parent
3669 ;; unprocessed entries to `window-state-put-list'.
3672 window-state-put-list))))
3674 ;; Now process the current window (either the one we've just
3675 ;; split or the last child of its parent).
3677 ;; Continue with the last window split off.
3681 "Helper function for `window-state-put'."
3689 ;; Put in clone-number.
3693 ;; Process parameters.
3697 ;; Process buffer related state.
3699 ;; We don't want to raise an error here so we create a buffer if
3700 ;; there's none.
3712 ;; Adjust vertically.
3714 ;; A fixed height window, try to restore the original size.
3717 window-size-fixed)
3720 ;; Else check whether the window is not high enough.
3726 ;; Adjust horizontally.
3728 ;; A fixed width window, try to restore the original size.
3731 window-size-fixed)
3734 ;; Else check whether the window is not wide enough.
3740 ;; Set dedicated status.
3742 ;; Install positions (maybe we should do this after all windows
3743 ;; have been created and sized).
3747 ;; I'm not sure whether we should set the mark here, but maybe
3748 ;; it can be used.
3751 ;; Select window if it's the selected one.
3756 "Put window state STATE into WINDOW.
3757 STATE should be the state of a window returned by an earlier
3758 invocation of `window-state-get'. Optional argument WINDOW must
3759 specify a live window and defaults to the selected one.
3761 Optional argument IGNORE non-nil means ignore minimum window
3762 sizes and fixed size restrictions. IGNORE equal `safe' means
3763 subwindows can get as small as `window-safe-min-height' and
3764 `window-safe-min-width'."
3768 ;; We check here (1) whether the total sizes of root window of
3769 ;; STATE and that of WINDOW are equal so we can avoid
3770 ;; calculating new sizes, and (2) if we do have to resize
3771 ;; whether we can do so without violating size restrictions.
3779 window-splits selected)
3797 (> min-width
3799 ;; The check above might not catch all errors due to rounding
3800 ;; issues - so IGNORE equal 'safe might not always produce the
3801 ;; minimum possible state. But such configurations hardly make
3802 ;; sense anyway.
3806 ;; Work on the windows of a temporary buffer to make sure that
3807 ;; splitting proceeds regardless of any buffer local values of
3808 ;; `window-size-fixed'. Release that buffer after the buffers of
3809 ;; all live windows have been set by `window-state-put-2'.
3815 \f
3816 ;;; Displaying buffers.
3828 "Buffer display default specifiers.
3829 The value specified here is used when no other specifiers have
3830 been specified by the user or the application. Consult the
3831 documentation of `display-buffer-alist' for a description of
3836 ;; Use the same window.
3839 ;; Avoid other frames.
3843 ;; (other-window
3844 ;; ;; Avoid selected window.
3845 ;; (reuse-window other same visible)
3846 ;; (pop-up-window (largest . nil) (lru . nil))
3847 ;; (reuse-window other other visible))
3849 ;; Avoid other frames and selected window.
3854 ;; Avoid selected frame.
3859 ;; The default specifiers.
3860 display-buffer-default-specifiers))
3865 ;; Reuse window showing same buffer.
3867 ;; Pop up window.
3868 pop-up-window
3869 ;; Split largest or lru window.
3873 ;; Reuse any but selected window on same frame.
3876 "List associating buffer identifiers with display specifiers.
3877 The car of each element of this list is built from a set of cons
3878 cells called buffer identifiers. `display-buffer' shows a buffer
3879 according to the display specifiers in the element's cdr
3880 \(elements are true lists) if at least one of the identifiers
3881 matches the first or third argument of `display-buffer'. Such a
3882 match occurs in one of the following three cases:
3884 - The car of the buffer identifier is the symbol `name' and its
3885 cdr is a string equalling the name of the buffer specified by
3886 the first \(BUFFER-OR-NAME) argument of `display-buffer'.
3888 - The car is the symbol `regexp' and the cdr is a regular
3889 expression matching the name of the buffer specified by the
3890 first \(BUFFER-OR-NAME) argument of `display-buffer'.
3892 - The car is the symbol `label' and the cdr is a symbol equalling
3893 the third \(LABEL) argument of `display-buffer'.
3895 Display specifiers are either symbols, cons cells, or lists.
3896 Five specifiers have been reserved to indicate the basic method
3897 for displaying the buffer: `reuse-window', `pop-up-window',
3898 `pop-up-frame', `use-side-window', and `fun-with-args'.
3900 A list whose car is the symbol `reuse-window' indicates that an
3901 existing window shall be reused for displaying the buffer. The
3902 second element of this list specifies the window to use and can
3903 be one of the following symbols:
3905 nil stands for any window.
3907 `same' stands for the selected window.
3909 `other' stands for any but the selected window.
3911 The third element specifies whether the buffer shown in a window
3912 that shall be reused must be the same buffer that shall be
3913 displayed or another buffer and can be one of the following:
3915 nil means to not care about the window's buffer.
3917 `same' means the window must show the buffer already.
3919 `other' means the window must not show the buffer yet.
3921 The fourth element specifies the set of frames to search for a
3922 suitable window and can be one of the following:
3924 nil to reuse a window on the selected frame.
3926 `visible' to search visible frames on the current terminal.
3928 `other' stands for any visible frame but the selected one.
3930 0 \(the number zero) to search visible and iconified frames on
3931 the current terminal.
3933 t to search arbitrary frames including invisible ones.
3935 If more than one window fits the constraints imposed by these
3936 elements, the least recently used candidate is chosen. A side
3937 window is never reused unless it already shows the buffer.
3939 The following two specifiers are useful when the method equals
3940 `reuse-window':
3942 - A cons cell whose car is the symbol `reuse-window-even-sizes'
3943 and whose cdr is non-nil means to even out the sizes of a
3944 reused window and the selected window provided they (1) appear
3945 adjacent to each other and (2) the selected window is larger
3946 than the window chosen. If the cdr is nil, this means that the
3947 window sizes are left alone.
3949 - A cons cell whose car is the symbol `reuse-window-dedicated'
3950 and whose cdr is non-nil means that a window can be reused even
3951 if it's weakly dedicated to its buffer. If the cdr is t, a
3952 strongly dedicated window can be reused to show the buffer.
3953 Any other non-nil value means only weakly dedicated windows can
3954 be reused. If the cdr is nil, dedicated windows are not
3955 reused.
3957 This specifier should be used in emergency cases only since
3958 windows are usually made dedicated in order to prevent
3959 `display-buffer' from reusing them.
3961 A list whose car is the symbol `pop-up-window' and whose cdr is
3962 built from cons cells representing window/side tuples indicates
3963 that a new window shall be made for displaying the buffer on the
3964 selected frame.
3966 Window/side tuples are cons cells. The car of such a tuple
3967 identifies the window that shall be split. Possible values are
3968 `largest', `lru', `selected', and `root' to split the largest,
3969 least recently used, selected or root window of the selected
3970 frame.
3972 If the frame has side windows, these values do allow to split
3973 only the selected frame's main window or one of its subwindows.
3974 Setting the car to one of `left', `top', `right' and `bottom'
3975 splits the corresponding side window, provided such a window
3976 exists.
3978 The cdr of each pair specifies on which side of the window to
3979 split the new window shall appear and can be one of `below',
3980 `right', `above', or `left' with the obvious meanings. If the
3981 cdr is nil, the window is split in a fashion suitable for its
3982 current dimensions. If the cdr specifies a function, that
3983 function is called with one argument - the window to split. The
3984 function is supposed to split that window and return the new
3985 window.
3987 `display-buffer' scans these tuples until it can either produce a
3988 suitable window or fails. The default value for
3989 `display-buffer-alist' contains the tuples \(largest . nil) and
3990 \(lru . nil) in order to split the largest window first and, if
3991 that fails, the least recently used one.
3993 The following specifiers are useful if the method specifier is
3994 `pop-up-window'.
3996 - A cons cell whose car is the symbol `pop-up-window-min-height'
3997 specifiies the minimum height of the new window. If the cdr is
3998 an integer number, it specifies the minimum number of lines of
3999 the window. A floating point number gives the minimum fraction
4000 of the window height with respect to the height of the frame's
4001 root window. A new window is created only if it can be made at
4002 least as high as specified by the number. If the cdr is nil,
4003 this means to use the value of `window-min-height'.
4005 - A cons cell whose car is the symbol `pop-up-window-min-width'
4006 specifies the minimum width of the new window. If the cdr is
4007 an integer number, it specifies the minimum number of columns
4008 of the window. A floating point number gives the minimum
4009 fraction of the window width with respect to the width of the
4010 frame's root window. A new window is created only if it can be
4011 made at least as wide as specified by the number. If the cdr
4012 is nil, this means to use the value of `window-min-width'.
4014 - A cons cell whose car is `pop-up-window-set-height' with
4015 the following interpretations for the cdr:
4017 - nil means leave the height of the new window alone.
4019 - A number specifies the desired height of the new window. An
4020 integer number specifies the number of lines of the window.
4021 A floating point number gives the fraction of the window
4022 height with respect to the height of the frame's root window.
4024 - If the cdr specifies a function, that function is called with
4025 one argument - the new window. The function is supposed to
4026 adjust the height of the window; its return value is ignored.
4027 Suitable functions are `shrink-window-if-larger-than-buffer'
4028 and `fit-window-to-buffer'.
4030 - A cons cell whose car equals `pop-up-window-set-width' with
4031 the following interpretations for the cdr:
4033 - nil means leave the width of the new window alone.
4035 - A number specifies the desired width of the new window. An
4036 integer number specifies the number of columns of the window.
4037 A floating point number gives the fraction of the window
4038 width with respect to the width of the frame's root window.
4040 - If the cdr specifies a function, that function is called with
4041 one argument - the new window. The function is supposed to
4042 adjust the width of the window; its return value is ignored.
4044 Observe that specifying `pop-up-window-set-height' or
4045 `pop-up-window-set-width' may override restrictions given by
4046 the `pop-up-window-min-height' and `pop-up-window-min-width'
4047 specifiers.
4049 - A cons cell whose car is `pop-up-window-split-unsplittable' and
4050 whose cdr is non-nil allows to make a new window on an
4051 unsplittable frame. If the cdr is nil, unsplittable frames are
4052 not split. This specifier should be used in special cases only
4053 since frames are usually made unsplittable in order to prevent
4054 `display-buffer' from splitting them.
4056 A list whose car is the symbol `pop-up-frame' specifies that a
4057 new frame shall be made for displaying the buffer. The second
4058 element, if non-nil, allows popping up a new frame on graphic
4059 displays only.
4061 The following specifiers are useful if the method specifier is
4062 `pop-up-frame'.
4064 - A list whose car is the symbol `pop-up-frame-function' together
4065 with a valid function as cdr specifies the function for
4066 creating a new frame. If the cdr is nil, the default function
4067 `make-frame' is called. The function is called with the
4068 parameters and values provided by the specifier described next.
4070 - A list whose car is the symbol `pop-up-frame-alist' followed by
4071 an arbitrary number of frame parameter/value tuples, each given
4072 as a cons cell, specifies the parameters passed to the pop-up
4073 frame function.
4075 A list of three elements whose car is the symbol
4076 `use-side-window' specifies that the buffer shall be displayed in
4077 a side window of the selected frame. The second element denotes
4078 the side of the frame where the window appears or shall be made.
4079 The third element denotes the slot used by the window. If a side
4080 window with the specified slot exists already, that window is
4081 reused. If no such window exists it is created.
4083 The following specifiers are useful in connection with the
4084 `use-side-window' method specifier: `reuse-window-dedicated',
4085 `pop-up-window-min-height', `pop-up-window-min-width',
4086 `pop-up-window-set-height' and `pop-up-window-set-width'.
4088 A list whose car is the symbol `fun-with-args' specifies that the
4089 function specified in the second element of the list is
4090 responsible for displaying the buffer. `display-buffer' calls
4091 this function with the buffer as first argument and the remaining
4092 elements of the list as second argument.
4094 The function should choose or create a window, display the buffer
4095 in it, and return the window. It is also responsible for giving
4096 the variable `display-buffer-window' and the `quit-restore'
4097 parameter of the window used a meaningful value.
4099 Within the body of this function avoid calling `display-buffer'
4100 with the same buffer as argument since this may lead to endless
4101 recursion.
4103 Instead of supplying basic method specifiers, it's sometimes more
4104 convenient to use macro specifiers. They provide some commonly
4105 used display methods but do not support the fine control provided
4106 by the basic method specifiers. Macro specifiers are symbols.
4107 The following macro specifiers are provided:
4109 `same-window' to display the buffer in the selected window.
4111 `same-frame' to display the buffer on the selected frame.
4113 `other-window' to display the buffer in any window but the
4114 selected one.
4116 `same-frame-other-window' as `other-window' but stay on the
4117 selected frame.
4119 `other-frame' to display the buffer on another visible
4120 frame.
4122 `default' to use the default value of `display-buffer-alist'.
4124 One specifier is useful with any method specifier: A list whose
4125 car is the symbol `dedicate' and whose cdr is non-nil will
4126 dedicate the window to its buffer. The following values are
4127 supported:
4129 - nil to not dedicate the window to the buffer.
4131 - `weak' to weakly dedicate the window to the buffer.
4133 - t to strongly dedicate the window to the buffer.
4135 A cons cell whose car is `other-window-means-other-frame' and
4136 whose cdr is non-nil means that you want calls of
4137 `display-buffer' with the second argument t or the symbol
4138 `other-window' to display the buffer in another frame. This
4139 means, for example, that you prefer functions like
4140 `find-file-other-window' or `switch-to-buffer-other-window' to
4141 make a new frame instead of a new window on the selected frame.
4143 Usually, applications are free to override the specifiers of
4144 `display-buffer-alist' by passing their own specifiers as second
4145 argument of `display-buffer'. For every `display-buffer-alist'
4146 entry you can, however, add a cons cell whose car is the symbol
4147 `override' and whose cdr is non-nil, to explicitly override any
4148 value supplied by the application.
4150 Overriding specifiers supplied by the calling application is, in
4151 general, not advisable. It permits, for example, to change the
4152 semantics of a function like `display-buffer-other-window' by
4153 using the location specifiers `same-window' or `other-frame'."
4154 :risky t
4155 :type
4158 ;; Associations of buffer identifiers and display specifiers.
4161 ;; Buffer identifiers.
4186 ;; Display specifiers.
4190 :inline t
4192 :inline t
4199 :inline t
4203 ;; Reuse window specifiers.
4210 :inline t
4211 ;; For customization purposes only.
4215 :inline t
4216 ;; The window to reuse.
4220 ;; The window type.
4224 :value nil
4229 ;; The window's buffer.
4233 :value t
4238 ;; The window's frame.
4242 :value nil
4249 ;; Whether window sizes should be evened out.
4257 :value t
4261 ;; Whether to reuse a dedicated window
4273 ;; Pop-up window specifiers.
4278 :inline t
4282 :inline t
4283 ;; Pop-up window list.
4290 :inline t
4296 :value largest
4309 :value nil
4318 ;; Minimum height of pop-up windows.
4328 ;; Minimum width of pop-up windows.
4338 ;; Desired height of pop-up windows.
4349 ;; Desired width of pop-up windows.
4360 ;; Split unsplittable frames.
4370 ;; Pop-up frame specifiers.
4378 :inline t
4382 :inline t
4383 ;; Pop-up frame.
4395 ;; Pop-up frame function.
4401 :value nil
4406 :value make-frame
4409 ;; Pop-up frame alist.
4415 :inline t
4427 ;; Use side-window specifiers.
4432 :inline t
4433 ;; For customization purposes only.
4437 :inline t
4438 ;; Side and slot.
4443 ;; The side.
4447 :value bottom
4453 ;; The slot
4459 ;; Whether to reuse a dedicated side window
4470 ;; Minimum height of pop-up side windows.
4480 ;; Minimum width of pop-up windows.
4490 ;; Desired height of pop-up windows.
4501 ;; Desired width of pop-up windows.
4513 ;; Function with argument specifiers.
4518 :inline t
4519 ;; For customization purposes only.
4523 :inline t
4533 :inline t
4538 ;; Macro specifiers.
4542 :inline t
4547 :inline t
4552 :inline t
4557 :inline t
4562 :inline t
4567 :inline t
4568 ;; Dedicate window to buffer.
4578 ;; No other window.
4587 ;; Other window means other frame.
4596 ;; Overriding.
4609 "If non-nil, function to call to display a buffer.
4610 `display-buffer' calls this function with two arguments, the
4611 buffer to display and a list of buffer display specifiers, see
4612 `display-buffer-alist'.
4614 The function is supposed to choose or create a window, display
4615 the specified buffer in it, and return the window. It is also
4616 responsible for giving the variable `display-buffer-window' and
4617 the `quit-restore' parameter of the window used a meaningful
4618 value.
4620 The function specified here overrides all specifiers of the
4621 variable `display-buffer-alist' any specifiers passed to
4622 `display-buffer'.
4624 If you call `display-buffer' within the body of the function,
4625 bind the value of `display-buffer-function' to nil around that
4626 call to avoid that the function recursively calls itself."
4632 ;; The following is a global variable which is used externally (by
4633 ;; help.el) to (1) know which window was used for displaying a buffer
4634 ;; and (2) whether the window was new or reused.
4636 "Window used by `display-buffer' and related information.
4637 After `display-buffer' displays a buffer in some window this
4638 variable is a cons cell whose car denotes the window used to
4639 display the buffer. The cdr is supposed to be one of the symbols
4640 `reuse-buffer-window', `reuse-other-window', `new-window' or
4641 `new-frame'.
4643 If the buffer display location specifier is one of 'same-window,
4644 'same-frame, or 'other-frame, the `display-buffer' routines
4645 assign the value of this variable. If the location specifier is
4646 a function, that function becomes responsible for assigning a
4647 meaningful value to this variable. See the functions
4648 `display-buffer-reuse-window', `display-buffer-pop-up-window' and
4652 "Even sizes of WINDOW and selected window according to SPECIFIERS.
4653 SPECIFIERS must be a list of buffer display specifiers, see the
4654 documentation of `display-buffer-alist' for a description.
4656 Sizes are evened out if and only if WINDOW and the selected
4657 window appear next to each other and the selected window is
4658 larger than WINDOW."
4661 ;; Don't resize minibuffer windows.
4663 ;; WINDOW must be adjacent to the selected one.
4667 ;; Resize iff the selected window is higher than WINDOW.
4669 ;; Don't throw an error if we can't even window heights for
4670 ;; whatever reason. In any case, enlarging the selected window
4671 ;; might fail anyway if there are other windows above or below
4672 ;; WINDOW and the selected one. But for a simple two windows
4673 ;; configuration the present behavior is good enough so why care?
4679 ;; Resize iff the selected window is wider than WINDOW.
4681 ;; Don't throw an error if we can't even window widths, see
4682 ;; comment above.
4689 "Adjust height of WINDOW according to SPECIFIERS.
4690 SPECIFIERS must be a list of buffer display specifiers, see the
4691 documentation of `display-buffer-alist' for a description."
4696 set-height
4699 set-height))))
4708 "Adjust width of WINDOW according to SPECIFIERS.
4709 SPECIFIERS must be a list of buffer display specifiers, see the
4710 documentation of `display-buffer-alist' for a description."
4715 set-width
4718 set-width))))
4726 ;; We have to work around the deficiency that the command loop does not
4727 ;; preserve the selected window when it is on a frame that hasn't been
4728 ;; raised or given input focus. So we have to (1) select the window
4729 ;; used for displaying a buffer and (2) raise its frame if necessary,
4730 ;; thus defeating one primary principle of `display-buffer' namely to
4731 ;; _not_ select the window chosen for displaying the buffer :-(
4733 "Select WINDOW and raise its frame if necessary."
4736 ;; Select WINDOW _before_ raising the frame to assure that the mouse
4737 ;; cursor moves into the correct window.
4743 "Display BUFFER in WINDOW and raise its frame if needed.
4744 WINDOW must be a live window and defaults to the selected one.
4745 Return WINDOW.
4747 SPECIFIERS must be a list of buffer display specifiers, see the
4748 documentation of `display-buffer-alist' for a description."
4755 ;; Show BUFFER in WINDOW.
4764 ;; Return window.
4765 window))
4768 "Display BUFFER in an existing window.
4769 METHOD must be a list in the form of the cdr of a `reuse-window'
4770 buffer display specifier, see `display-buffer-alist' for an
4771 explanation. The first element must specifiy the window to use,
4772 and can be either nil, `same', `other', or a live window. The
4773 second element must specify the window's buffer and can be either
4774 nil, `same', `other', or a live buffer. The third element is the
4775 frame to use - either nil, 0, `visible', `other', t, or a live
4776 frame.
4778 Optional argument SPECIFIERS must be a list of valid display
4779 specifiers. Return the window chosen to display BUFFER, nil if
4780 none was found."
4785 windows other-frame dedicated time best-window best-time)
4787 ;; `other' is not handled by `window-list-1'.
4793 ;; Don't reuse a side window.
4801 ;; Special case for applications that specifiy
4802 ;; the window explicitly.
4809 ;; Special case for applications that specifiy
4810 ;; the window's buffer explicitly.
4814 ;; Handle dedicatedness.
4816 ;; The window does not show the same buffer.
4818 ;; If the window is weakly dedicated to its
4819 ;; buffer, reuse-dedicated must be non-nil.
4821 ;; If the window is strongly dedicated to its
4822 ;; buffer, reuse-dedicated must be t.
4827 ;; When reusing a window on the same buffer use the lru one.
4833 ;; Otherwise, sort windows according to their use-time.
4840 ;; Try to get a full-width window (this is silly and can
4841 ;; get us to another frame but let's ignore these issues
4842 ;; for the moment).
4847 ;; If there's no full-width window return the lru window.
4852 ;; Never change the quit-restore parameter of a window here.
4859 ;; Don't overwrite an existing quit-restore entry.
4861 best-window 'quit-restore
4875 "Subroutine of `display-buffer-split-window'."
4880 ;; We either resize WINDOW or its parent.
4882 new-size)
4883 ;; We don't call split-window-vertically/-horizontally any more
4884 ;; here. If for some reason it's needed we can always do so
4885 ;; (provided we give it an optional SIDE argument).
4888 ;; When we resize a combination, the new window must be at least
4889 ;; MIN-SIZE large after the split.
4893 (/ old-size
4894 ;; Try to make the size of the new window
4895 ;; proportional to the number of iso-arranged
4896 ;; windows in the combination.
4902 ;; When WINDOW is live, the old _and_ the new window must be at
4903 ;; least MIN-SIZE large after the split.
4906 ;; Do an even split to make Stepan happy.
4909 ;; When WINDOW is internal, the new window must be at least
4910 ;; MIN-SIZE large after the split.
4913 (/ old-size
4914 ;; Try to make the size of the new window
4915 ;; proportional to the number of iso-arranged
4916 ;; subwindows of WINDOW.
4922 "Split WINDOW in a way suitable for `display-buffer'.
4923 Optional argument SIDE must be a side specifier \(one of the
4924 symbols below, right, above, left, or nil). SPECIFIERS must be a
4925 list of buffer display specifiers, see the documentation of
4926 `display-buffer-alist' for a description.
4928 Return the new window, nil if it could not be created."
4931 size)
4932 ;; Normalize min-height and min-width, we might need both.
4934 ;; If min-height is specified, it can be as small as
4935 ;; `window-safe-min-height'.
4939 min-height)
4947 height))))
4950 ;; If min-width is specified, it can be as small as
4951 ;; `window-safe-min-width'.
4955 min-width)
4963 width))))
4969 ;; If SIDE is nil and vertical splitting failed, we try again
4970 ;; splitting horizontally this time.
4974 ;; If WINDOW is live and the root window of its frame, try once
4975 ;; more splitting vertically, disregarding the min-height
4976 ;; specifier this time and using `window-min-height' instead.
4985 "Make WINDOW part of an atomic window."
4989 root new new-parent)
4991 ;; We are in an atomic window.
4993 ;; Split the root window.
4998 ;; WINDOW is or becomes atomic.
5003 window t))
5004 ;; New window and any new parent get their window-atom parameter
5005 ;; set too.
5008 new)))
5011 "Display BUFFER in a new window.
5012 Return the window displaying BUFFER, nil if popping up the window
5013 failed. METHODS must be a list of window/side tuples like those
5014 forming the cdr of the `pop-up-window' buffer display specifier.
5015 As a special case, the car of such a tuple can be also a live
5016 window.
5018 Optional argument SPECIFIERS must be a list of buffer display
5019 specifiers, see the doc-string of `display-buffer-alist' for a
5020 description."
5023 window side atomic)
5025 ;; Don't split an unsplittable frame unless
5026 ;; SPECIFIERS allow it.
5041 ;; If there are side windows, split the main
5042 ;; window else the frame root window.
5046 ;; This should gets us the "root" side
5047 ;; window if there exists more than one.
5050 ;; A window, directly specified.
5051 window)))
5052 ;; The window must be on the selected frame,
5054 ;; and must be neither a minibuffer window,
5056 ;; nor a side window.
5068 ;; Don't pass any specifiers to this function.
5073 ;; Adjust sizes if asked for.
5081 window))))
5084 "Make a new frame for displaying BUFFER.
5085 Return the window displaying BUFFER if creating the new frame was
5086 successful, nil otherwise. Optional argument GRAPHIC-ONLY
5087 non-nil means to make a new frame on graphic displays only.
5089 SPECIFIERS must be a list of buffer display specifiers, see the
5090 documentation of `display-buffer-alist' for a description."
5092 noninteractive)
5111 "Display BUFFER in a new window on SIDE of the selected frame.
5112 SLOT specifies the slot to use. SPECIFIERS must be a list of
5113 buffer display specifiers.
5115 Return the window displaying BUFFER, nil if popping up the window
5116 failed."
5124 main
5125 root))
5133 fun)
5138 ;; Make all main-or-root subwindows main windows.
5140 main-or-root t))
5141 ;; Make sure that parent's window-side is nil.
5143 ;; Initialize side.
5145 ;; Adjust sizes if asked for.
5148 ;; Set window parameters.
5155 window)))
5158 "Display BUFFER in a window on SIDE of the selected frame.
5159 SLOT, if non-nil, specifies the window slot where to display the
5160 BUFFER. SLOT zero or nil means use the central slot on SIDE.
5161 SLOT negative means use a slot preceding the central window.
5162 SLOT positive means use a slot following the central window.
5164 SPECIFIERS must be a list of buffer display specifiers."
5168 ;; `major' is the major window on SIDE, `windows' the life
5169 ;; windows on SIDE.
5178 window-sides-slots))
5180 window this-window this-slot prev-window next-window
5181 best-window best-slot abs-slot)
5186 ;; No suitable side window exists, make one.
5188 ;; Scan windows on SIDE.
5195 ;; Dedicatedness check.
5198 ;; Window with matching SLOT, use it.
5212 ;; `this-window' is the first window with the same SLOT.
5213 ;; `prev-window' is the window with the largest slot < SLOT. A new
5214 ;; window will be created after it.
5215 ;; `next-window' is the window with the smallest slot > SLOT. A new
5216 ;; window will be created before it.
5217 ;; `best-window' is the window with the smallest absolute difference
5218 ;; of its slot and SLOT.
5220 ;; Reuse this window.
5229 ;; Don't overwrite an existing quit-restore entry.
5231 window 'quit-restore
5237 ;; Make new window before next-window.
5241 next-window next-side specifiers))))
5243 ;; Make new window after prev-window.
5247 prev-window prev-side specifiers)))))
5252 window 'quit-restore
5255 window))
5258 ;; Reuse best window (the window nearest to SLOT).
5266 ;; Don't overwrite an existing quit-restore entry.
5268 window 'quit-restore
5272 window))
5276 ;; Don't change exisiting slot value.
5281 "Normalize BUFFER-OR-NAME argument for buffer display functions.
5282 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
5283 buffer specified by BUFFER-OR-NAME exists, return that buffer.
5284 If no such buffer exists, create a buffer with the name
5285 BUFFER-OR-NAME and return that buffer."
5290 buffer))
5294 "Return non-nil if BUFFER shall be preferably displayed in another frame.
5295 BUFFER must be a live buffer or the name of a live buffer.
5297 Return nil if BUFFER shall be preferably displayed in another
5298 window on the selected frame. Return non-nil if BUFFER shall be
5299 preferably displayed in a window on any but the selected frame.
5301 Optional argument LABEL is like the same argument of
5302 `display-buffer'.
5304 The calculation of the return value is exclusively based on the
5305 user preferences expressed in `display-buffer-alist'."
5313 "Normalize second argument of `display-buffer'.
5314 BUFFER-NAME is the name of the buffer that shall be displayed,
5315 SPECIFIERS is the second argument of `display-buffer'. LABEL the
5316 same argument of `display-buffer'. OTHER-FRAME non-nil means use
5317 other-frame for other-windo."
5321 nil)
5323 ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
5329 ;; `other-window' must be treated separately.
5331 'other-frame
5333 display-buffer-macro-specifiers)))
5337 ;; Might be a macro specifier, try to expand it (the cdr is a
5338 ;; list and we have to reverse it later, so do it one at a
5339 ;; time).
5343 ;; Reverse list.
5346 ;; A macro specifier.
5349 ;; Pop up another frame.
5352 ;; In any other case pop up a new window.
5356 "Subroutine of `display-buffer-normalize-specifiers'.
5357 BUFFER-OR-NAME is the buffer to display. This routine provides a
5358 compatibility layer for the now obsolete Emacs 23 buffer display
5359 options."
5362 specifiers)
5363 ;; Disable warnings, there are too many obsolete options here.
5365 ;; `even-window-heights', unless nil or unset.
5370 ;; `display-buffer-mark-dedicated'
5374 specifiers)))
5376 ;; `pop-up-window' group. Anything is added here iff
5377 ;; `pop-up-windows' is neither nil nor unset.
5381 split-window-preferred-function))
5388 ;; Create an entry only if a default value was changed.
5392 ;; `reuse-window' (needed as fallback when popping up the new
5393 ;; window fails).
5396 specifiers))
5397 ;; `split-width-threshold'
5400 specifiers))
5401 ;; `split-height-threshold'
5404 specifiers))
5405 ;; `pop-up-window'
5409 specifiers))))
5411 ;; `pop-up-frame' group. Add things if `pop-up-frames' is non-nil
5412 ;; (we ignore the problem that callers usually don't care about
5413 ;; graphic-only).
5415 ;; `pop-up-frame-function'. If `pop-up-frame-function' uses the
5416 ;; now obsolete `pop-up-frame-alist' it will continue to do so.
5419 specifiers))
5420 ;; `pop-up-frame'
5424 ;; `special-display-p' group.
5426 ;; `special-display-p' returns either t or a list of frame
5427 ;; parameters to pass to `special-display-function'.
5433 specifiers)))))
5435 ;; `same-window-p' group.
5437 ;; Try to reuse the same (selected) window.
5440 specifiers)))
5442 ;; `pop-up-windows' and `pop-up-frames' both nil means means we
5443 ;; are supposed to reuse any window (unless we find one showing
5444 ;; the same buffer already).
5446 ;; `reuse-window' showing any buffer on same frame.
5449 specifiers)))
5451 ;; `display-buffer-reuse-frames' or `pop-up-frames' non-nil means
5452 ;; we are supposed to reuse a window showing the same buffer on
5453 ;; another frame.
5455 ;; `reuse-window' showing same buffer on visible frame.
5459 ;; Prepend "reuse window on same frame if showing the buffer
5460 ;; already" specifier.
5462 specifiers))
5464 specifiers)))
5467 "Subroutine of `display-buffer-normalize-alist'.
5468 SPECIFIERS is a list of buffer display specfiers. LABEL is the
5469 same argument of `display-buffer'."
5473 nil)
5475 ;; If SPECIFIERS is a list, we assume it is a list of specifiers.
5481 ;; Might be a macro specifier, try to expand it (the cdr is a
5482 ;; list and we have to reverse it later, so do it one at a
5483 ;; time).
5487 ;; Reverse list.
5490 ;; A macro specifier.
5494 "Normalize `display-buffer-alist'.
5495 BUFFER-NAME must be the name of the buffer that shall be displayed.
5496 LABEL the corresponding argument of `display-buffer'."
5518 normalized))
5522 normalized))))))
5530 "Return normalized specifiers for a buffer matching BUFFER-NAME or LABEL.
5531 BUFFER-NAME must be a string specifying a valid buffer name.
5532 SPECIFIERS and LABEL are the homonymous arguments of
5533 `display-buffer'.
5535 The method for displaying the buffer specified by BUFFER-NAME or
5536 LABEL is established by appending the following four lists of
5537 specifiers:
5539 - The specifiers in `display-buffer-alist' whose buffer
5540 identifier matches BUFFER-NAME or LABEL and whose 'override
5541 component is set.
5543 - SPECIFIERS.
5545 - The specifiers in `display-buffer-alist' whose buffer
5546 identifier matches BUFFER-NAME or LABEL and whose 'override
5547 component is not set.
5549 - `display-buffer-default-specifiers'."
5554 ;; Overriding user specifiers.
5556 ;; Application specifiers.
5558 buffer-name specifiers label other-frame)
5559 ;; Emacs 23 compatibility specifiers.
5562 ;; Non-overriding user specifiers.
5564 ;; Default specifiers.
5565 display-buffer-default-specifiers)))
5567 ;; Minibuffer-only frames should be documented better. They really
5568 ;; deserve a separate section in the manual. Also
5569 ;; `last-nonminibuffer-frame' is nowhere documented in the manual.
5571 "Return FRAME if it is live and not a minibuffer-only frame.
5572 Return the value of `last-nonminibuffer-frame' otherwise."
5575 ;; A not very nice way to get that information.
5577 frame
5581 "Make the buffer specified by BUFFER-OR-NAME appear in some window.
5582 Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5583 buffer name), or nil. If BUFFER-OR-NAME is a string not naming
5584 an existent buffer, create a buffer with that name. If
5585 BUFFER-OR-NAME is nil or omitted, display the current buffer.
5586 Interactively, prompt for the buffer name using the minibuffer.
5588 Return the window chosen to display the buffer or nil if no such
5589 window is found. Do not change the selected window unless the
5590 buffer is shown on a different frame than the selected one.
5592 Optional argument SPECIFIERS must be a list of buffer display
5593 specifiers, see the documentation of `display-buffer-alist' for a
5594 description.
5596 For convenience, SPECIFIERS may also consist of a single buffer
5597 display location specifier or t, where the latter means to
5598 display the buffer in any but the selected window. If SPECIFIERS
5599 is nil or omitted, this means to exclusively use the specifiers
5600 provided by `display-buffer-alist'. If the value of the latter
5601 is nil too, all specifiers are provided by the constant
5602 `display-buffer-default-specifiers'.
5604 As a special case, the `reuse-window' specifier allows to specify
5605 as second element an arbitrary window, as third element an
5606 arbitrary buffer, and as fourth element an arbitrary frame. As
5607 first element of a window/side pair of the `pop-up-window'
5608 specifier you can specifiy an arbitrary window.
5610 The optional third argument LABEL, if non-nil, must be a symbol
5611 specifiying the buffer display label. Applications should set
5612 this when the buffer shall be displayed in some special way but
5613 BUFFER-OR-NAME does not identify the buffer as special. Typical
5614 buffers that fit into this category are those whose names are
5615 derived from the name of the file they are visiting. A user can
5616 override SPECIFIERS by adding an entry to `display-buffer-alist'
5617 whose car contains LABEL and whose cdr specifies the preferred
5618 alternative display method.
5620 The method to display the buffer is derived by combining the
5621 values of `display-buffer-alist' and SPECIFIERS. Highest
5622 priority is given to overriding elements of
5623 `display-buffer-alist'. Next come the elements specified by
5624 SPECIFIERS, followed by the non-overriding elements of
5625 `display-buffer-alist'.
5627 The result must be a list of valid buffer display specifiers. If
5628 `display-buffer-function' is non-nil, call it with the buffer and
5629 this list as arguments."
5634 ;; Normalize specifiers.
5636 ;; Don't use a minibuffer frame.
5638 ;; `window' is the window we use for showing `buffer'.
5639 window specifier method)
5640 ;; Reset this.
5643 ;; Let `display-buffer-function' do the job.
5645 ;; Retrieve the next location specifier while there a specifiers
5646 ;; left and we don't have a valid window.
5668 ;; If we don't have a window yet, try a fallback method. All
5669 ;; specifiers have been used up by now.
5671 ;; Try reusing a window showing BUFFER on any visible or
5672 ;; iconfied frame.
5674 ;; Try reusing a window not showing BUFFER on any visible or
5675 ;; iconified frame.
5677 ;; Try making a new frame.
5679 ;; Try using a weakly dedicated window.
5682 ;; Try using a strongly dedicated window.
5687 "Display buffer specified by BUFFER-OR-NAME in the selected window.
5688 Another window will be used only if the buffer can't be shown in
5689 the selected window, usually because it is dedicated to another
5690 buffer. Optional argument BUFFER-OR-NAME and LABEL are as for
5691 `display-buffer'."
5696 "Display buffer specified by BUFFER-OR-NAME in a window on the same frame.
5697 Another frame will be used only if there is no other choice.
5698 Optional argument BUFFER-OR-NAME and LABEL are as for
5699 `display-buffer'."
5704 "Display buffer specified by BUFFER-OR-NAME in another window.
5705 The selected window will be used only if there is no other
5706 choice. Windows on the selected frame are preferred to windows
5707 on other frames. Optional argument BUFFER-OR-NAME and LABEL are as
5708 for `display-buffer'."
5713 "Display buffer specified by BUFFER-OR-NAME in another window on the same frame.
5714 The selected window or another frame will be used only if there
5715 is no other choice. Optional argument BUFFER-OR-NAME and LABEL are
5716 as for `display-buffer'."
5721 "Display buffer specified by BUFFER-OR-NAME on another frame.
5722 The selected frame will be used only if there is no other choice.
5723 Optional argument BUFFER-OR-NAME and LABEL are as for
5724 `display-buffer'.
5726 If this command uses another frame, it will also select that frame."
5731 "Display buffer specified by BUFFER-OR-NAME and select the window used.
5732 Optional argument BUFFER-OR-NAME may be a buffer, a string \(a
5733 buffer name), or nil. If BUFFER-OR-NAME is a string not naming
5734 an existent buffer, create a buffer with that name. If
5735 BUFFER-OR-NAME is nil or omitted, display the current buffer.
5736 Interactively, prompt for the buffer name using the minibuffer.
5738 Optional second argument SPECIFIERS must be a list of buffer
5739 display specifiers, a single location specifier, `t' which means
5740 the latter means to display the buffer in any but the selected
5741 window, or nil which means to exclusively apply the specifiers
5742 customized by the user.
5744 Optional argument NORECORD non-nil means do not put the buffer
5745 specified by BUFFER-OR-NAME at the front of the buffer list and
5746 do not make the window displaying it the most recently selected
5747 one.
5749 The optional argument LABEL, if non-nil, is a symbol specifying the
5750 display purpose. Applications should set this when the buffer
5751 shall be displayed in a special way but BUFFER-OR-NAME does not
5752 identify the buffer as special. Buffers that typically fit into
5753 this category are those whose names have been derived from the
5754 name of the file they are visiting.
5756 Return the buffer specified by BUFFER-OR-NAME or nil if
5757 displaying the buffer failed.
5759 This uses the function `display-buffer' as a subroutine; see the
5760 documentations of `display-buffer' and `display-buffer-alist' for
5761 additional information."
5764 window)
5768 buffer)))
5771 "Pop to buffer specified by BUFFER-OR-NAME in the selected window.
5772 Another window will be used only if the buffer can't be shown in
5773 the selected window, usually because it is dedicated to another
5774 buffer. Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are
5775 as for `pop-to-buffer'."
5780 "Pop to buffer specified by BUFFER-OR-NAME in a window on the selected frame.
5781 Another frame will be used only if there is no other choice.
5782 Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5783 `pop-to-buffer'."
5788 "Pop to buffer specified by BUFFER-OR-NAME in another window.
5789 The selected window will be used only if there is no other
5790 choice. Windows on the selected frame are preferred to windows
5791 on other frames. Optional arguments BUFFER-OR-NAME, NORECORD and
5792 LABEL are as for `pop-to-buffer'."
5797 "Pop to buffer specified by BUFFER-OR-NAME in another window on the selected frame.
5798 The selected window or another frame will be used only if there
5799 is no other choice. Optional arguments BUFFER-OR-NAME, NORECORD
5800 and LABEL are as for `pop-to-buffer'."
5805 "Pop to buffer specified by BUFFER-OR-NAME on another frame.
5806 The selected frame will be used only if there's no other choice.
5807 Optional arguments BUFFER-OR-NAME, NORECORD and LABEL are as for
5808 `pop-to-buffer'."
5813 "Read the name of a buffer to switch to, prompting with PROMPT.
5814 Return the neame of the buffer as a string.
5816 This function is intended for the `switch-to-buffer' family of
5817 commands since these need to omit the name of the current buffer
5818 from the list of completions and default values."
5823 ;; Since rbts-completion-table is built dynamically, we
5824 ;; can't just add it to the default value of
5825 ;; icomplete-with-completion-tables, so we add it
5826 ;; here manually.
5831 icomplete-with-completion-tables))))
5836 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5837 If BUFFER-OR-NAME is nil, return the buffer returned by
5838 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5839 exists, return that buffer. If no such buffer exists, create a
5840 buffer with the name BUFFER-OR-NAME and return that buffer."
5845 buffer))
5849 "Switch to buffer BUFFER-OR-NAME in the selected window.
5850 If called interactively, prompt for the buffer name using the
5851 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5852 determines whether to request confirmation before creating a new
5853 buffer.
5855 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5856 nil. If BUFFER-OR-NAME is a string that does not identify an
5857 existing buffer, create a buffer with that name. If
5858 BUFFER-OR-NAME is nil, switch to the buffer returned by
5859 `other-buffer'.
5861 Optional argument NORECORD non-nil means do not put the buffer
5862 specified by BUFFER-OR-NAME at the front of the buffer list and
5863 do not make the window displaying it the most recently selected
5864 one. Return the buffer switched to.
5866 This function is intended for interactive use only. Lisp
5867 functions should call `pop-to-buffer-same-window' instead."
5873 ;; Cannot switch to another buffer in a minibuffer or strongly
5874 ;; dedicated window that does not show the buffer already. Call
5875 ;; `pop-to-buffer' instead.
5878 ;; I'm not sure why we should NOT call `set-window-buffer' here,
5879 ;; but let's keep things as they are (otherwise we could always
5880 ;; call `pop-to-buffer-same-window' here).
5887 "Switch to buffer BUFFER-OR-NAME in a window on the selected frame.
5888 Another frame will be used only if there is no other choice.
5889 Arguments BUFFER-OR-NAME and NORECORD have the same meaning as
5890 for `switch-to-buffer'.
5892 This function is intended for interactive use only. Lisp
5893 functions should call `pop-to-buffer-same-frame' instead."
5900 "Switch to buffer BUFFER-OR-NAME in another window.
5901 The selected window will be used only if there is no other
5902 choice. Windows on the selected frame are preferred to windows
5903 on other frames. Arguments BUFFER-OR-NAME and NORECORD have the
5904 same meaning as for `switch-to-buffer'.
5906 This function is intended for interactive use only. Lisp
5907 functions should call `pop-to-buffer-other-window' instead."
5914 "Switch to buffer BUFFER-OR-NAME in another window on the selected frame.
5915 The selected window or another frame will be used only if there
5916 is no other choice. Arguments BUFFER-OR-NAME and NORECORD have
5917 the same meaning as for `switch-to-buffer'.
5919 This function is intended for interactive use only. Lisp
5920 functions should call `pop-to-buffer-other-window-same-frame'
5921 instead."
5928 "Switch to buffer BUFFER-OR-NAME on another frame.
5929 The same frame will be used only if there is no other choice.
5930 Arguments BUFFER-OR-NAME and NORECORD have the same meaning
5931 as for `switch-to-buffer'.
5933 This function is intended for interactive use only. Lisp
5934 functions should call `pop-to-buffer-other-frame' instead."
5940 ;;; Obsolete definitions of `display-buffer' below.
5943 `display-buffer' and `pop-to-buffer' show a buffer whose name is
5944 on this list in the selected rather than some other window.
5946 An element of this list can be a cons cell instead of just a
5947 string. In that case, the cell's car must be a string specifying
5948 the buffer name. This is for compatibility with
5949 `special-display-buffer-names'; the cdr of the cons cell is
5950 ignored.
5952 See also `same-window-regexps'."
5956 'same-window-buffer-names
5961 `display-buffer' and `pop-to-buffer' show a buffer whose name
5962 matches a regexp on this list in the selected rather than some
5963 other window.
5965 An element of this list can be a cons cell instead of just a
5966 string. In that case, the cell's car must be a regexp matching
5967 the buffer name. This is for compatibility with
5968 `special-display-regexps'; the cdr of the cons cell is ignored.
5970 See also `same-window-buffer-names'."
5974 'same-window-regexps
5979 This function returns non-nil if `display-buffer' or
5980 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
5981 selected rather than \(as usual\) some other window. See
5982 `same-window-buffer-names' and `same-window-regexps'."
5987 ;; The elements of `same-window-buffer-names' can be buffer
5988 ;; names or cons cells whose cars are buffer names.
5993 ;; The elements of `same-window-regexps' can be regexps
5994 ;; or cons cells whose cars are regexps.
6005 "Alist of parameters for special frames.
6006 Special frames are used for buffers whose names are listed in
6007 `special-display-buffer-names' and for buffers whose names match
6008 one of the regular expressions in `special-display-regexps'.
6010 This variable can be set in your init file, like this:
6012 (setq special-display-frame-alist '((width . 80) (height . 20)))
6014 These supersede the values given in `default-frame-alist'."
6020 'special-display-frame-alist
6024 "Display BUFFER in a special frame and return the window chosen.
6025 If BUFFER is already displayed in a visible or iconified frame,
6026 raise that frame. Otherwise, display BUFFER in a way as
6027 specified by optional argument ARGS.
6029 If ARGS is an alist, use it as a list of frame parameters. If
6030 these parameters contain \(same-window . t), display BUFFER in
6031 the selected window. If they contain \(same-frame . t), display
6032 BUFFER in a window on the selected frame.
6034 If ARGS is a list whose car is a symbol, use (car ARGS) as a
6035 function to do the work. Pass it BUFFER as first argument,
6036 and (cdr ARGS) as second."
6041 ;; If we have a window already, make it visible.
6046 window))
6047 ;; Reuse the current window if the user requested it.
6051 ;; Stay on the same frame if requested.
6058 ;; If no window yet, make one in a new frame.
6063 special-display-frame-alist))))))
6068 'special-display-popup-frame
6072 "Function to call for displaying special buffers.
6073 This function is called with two arguments - the buffer and,
6074 optionally, a list - and should return a window displaying that
6075 buffer. The default value usually makes a separate frame for the
6076 buffer using `special-display-frame-alist' to specify the frame
6077 parameters. See the definition of `special-display-popup-frame'
6078 for how to specify such a function.
6080 A buffer is special when its name is either listed in
6081 `special-display-buffer-names' or matches a regexp in
6082 `special-display-regexps'."
6087 'special-display-function
6091 "List of names of buffers that should be displayed specially.
6092 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6093 its name is in this list, displays the buffer in a way specified
6094 by `special-display-function'. `special-display-popup-frame'
6095 \(the default for `special-display-function') usually displays
6096 the buffer in a separate frame made with the parameters specified
6097 by `special-display-frame-alist'. If `special-display-function'
6098 has been set to some other function, that function is called with
6099 the buffer as first, and nil as second argument.
6101 Alternatively, an element of this list can be specified as
6102 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
6103 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
6104 `special-display-popup-frame' will interpret such pairs as frame
6105 parameters when it creates a special frame, overriding the
6106 corresponding values from `special-display-frame-alist'.
6108 As a special case, if FRAME-PARAMETERS contains (same-window . t)
6109 `special-display-popup-frame' displays that buffer in the
6110 selected window. If FRAME-PARAMETERS contains (same-frame . t),
6111 it displays that buffer in a window on the selected frame.
6113 If `special-display-function' specifies some other function than
6114 `special-display-popup-frame', that function is called with the
6115 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
6116 argument.
6118 Finally, an element of this list can be also specified as
6119 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
6120 `special-display-popup-frame' will call FUNCTION with the buffer
6121 named BUFFER-NAME as first argument, and OTHER-ARGS as the
6122 second. If `special-display-function' specifies some other
6123 function, that function is called with the buffer named
6124 BUFFER-NAME as first, and the element's cdr as second argument.
6127 name to it but the corresponding buffer is displayed in the
6128 selected window, look at the values of `same-window-buffer-names'
6129 and `same-window-regexps'. Those variables take precedence over
6130 this one.
6132 See also `special-display-regexps'."
6154 'special-display-buffer-names
6157 ;;;###autoload
6161 "List of regexps saying which buffers should be displayed specially.
6162 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
6163 any regexp in this list matches its name, displays it specially
6164 using `special-display-function'. `special-display-popup-frame'
6165 \(the default for `special-display-function') usually displays
6166 the buffer in a separate frame made with the parameters specified
6167 by `special-display-frame-alist'. If `special-display-function'
6168 has been set to some other function, that function is called with
6169 the buffer as first, and nil as second argument.
6171 Alternatively, an element of this list can be specified as
6172 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
6173 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
6174 `special-display-popup-frame' will then interpret these pairs as
6175 frame parameters when creating a special frame for a buffer whose
6176 name matches REGEXP, overriding the corresponding values from
6177 `special-display-frame-alist'.
6179 As a special case, if FRAME-PARAMETERS contains (same-window . t)
6180 `special-display-popup-frame' displays buffers matching REGEXP in
6181 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
6182 to display such buffers in a window on the selected frame.
6184 If `special-display-function' specifies some other function than
6185 `special-display-popup-frame', that function is called with the
6186 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
6187 as second argument.
6189 Finally, an element of this list can be also specified as
6190 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
6191 will then call FUNCTION with the buffer whose name matched
6192 REGEXP as first, and OTHER-ARGS as second argument. If
6193 `special-display-function' specifies some other function, that
6194 function is called with the buffer whose name matched REGEXP
6195 as first, and the element's cdr as second argument.
6198 name to it but the corresponding buffer is displayed in the
6199 selected window, look at the values of `same-window-buffer-names'
6200 and `same-window-regexps'. Those variables take precedence over
6201 this one.
6203 See also `special-display-buffer-names'."
6225 'special-display-regexps
6229 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
6230 More precisely, return t if `special-display-buffer-names' or
6231 `special-display-regexps' contain a string entry equaling or
6232 matching BUFFER-NAME. If `special-display-buffer-names' or
6233 `special-display-regexps' contain a list entry whose car equals
6234 or matches BUFFER-NAME, the return value is the cdr of that
6235 entry."
6238 tmp)
6242 t)
6255 'special-display-p
6259 "Alist of parameters for automatically generated new frames.
6260 You can set this in your init file; for example,
6262 (setq pop-up-frame-alist '((width . 80) (height . 20)))
6264 If non-nil, the value you specify here is used by the default
6265 `pop-up-frame-function' for the creation of new frames.
6267 Since `pop-up-frame-function' is used by `display-buffer' for
6268 making new frames, any value specified here by default affects
6269 the automatic generation of new frames via `display-buffer' and
6270 all functions based on it. The behavior of `make-frame' is not
6271 affected by this variable."
6277 'pop-up-frame-alist
6282 "Function used by `display-buffer' for creating a new frame.
6283 This function is called with no arguments and should return a new
6284 frame. The default value calls `make-frame' with the argument
6285 `pop-up-frame-alist'."
6289 'pop-up-frame-function
6293 "Whether `display-buffer' should make a separate frame.
6294 If nil, never make a separate frame.
6295 If the value is `graphic-only', make a separate frame
6296 on graphic displays only.
6297 Any other non-nil value means always make a separate frame."
6305 'pop-up-frames
6309 "Set and non-nil means `display-buffer' should reuse frames.
6310 If the buffer in question is already displayed in a frame, raise
6311 that frame."
6317 'display-buffer-reuse-frames
6321 "Set and non-nil means `display-buffer' should make a new window."
6326 'pop-up-windows
6330 "Function called by `display-buffer' to split a window.
6331 This function is called with a window as single argument and is
6332 supposed to split that window and return the new window. If the
6333 window can (or shall) not be split, it is supposed to return nil.
6335 The default is to call the function `split-window-sensibly' which
6336 tries to split the window in a way which seems most suitable.
6337 You can customize the options `split-height-threshold' and/or
6338 `split-width-threshold' in order to have `split-window-sensibly'
6339 prefer either vertical or horizontal splitting.
6341 If you set this to any other function, bear in mind that
6342 `display-buffer' may call that function repeatedly; the option
6343 `pop-up-windows' controls which windows may become the argument
6344 of this function.
6346 The window selected at the time `display-buffer' was invoked is
6347 still selected when this function is called. Hence you can
6348 compare the window argument with the value of `selected-window'
6349 if you intend to split the selected window instead or if you do
6350 not want to split the selected window."
6355 'split-window-preferred-function
6359 "Minimum height for splitting a window to display a buffer.
6360 If this is an integer, `display-buffer' can split a window
6361 vertically only if it has at least this many lines. If this is
6362 nil, `display-buffer' does not split windows vertically. If a
6363 window is the only window on its frame, `display-buffer' may
6364 split it vertically disregarding the value of this variable."
6369 'split-height-threshold
6373 "Minimum width for splitting a window to display a buffer.
6374 If this is an integer, `display-buffer' can split a window
6375 horizontally only if it has at least this many columns. If this
6376 is nil, `display-buffer' cannot split windows horizontally."
6381 'split-width-threshold
6385 "If set and non-nil `display-buffer' will try to even window heights.
6386 Otherwise `display-buffer' will leave the window configuration
6387 alone. Heights are evened only when `display-buffer' reuses a
6388 window that appears above or below the selected window."
6393 'even-window-heights
6397 "Non-nil means `display-buffer' marks the windows it creates as dedicated.
6398 The actual non-nil value of this variable will be copied to the
6401 'display-buffer-mark-dedicated
6405 "Return non-nil if `split-window-sensibly' may split WINDOW.
6406 Optional argument HORIZONTAL nil or omitted means check whether
6407 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
6408 non-nil means check whether WINDOW may be split horizontally.
6410 WINDOW may be split vertically when the following conditions
6411 hold:
6412 - `window-size-fixed' is either nil or equals `width' for the
6413 buffer of WINDOW.
6414 - `split-height-threshold' is an integer and WINDOW is at least as
6415 high as `split-height-threshold'.
6416 - When WINDOW is split evenly, the emanating windows are at least
6417 `window-min-height' lines tall and can accommodate at least one
6418 line plus - if WINDOW has one - a mode line.
6420 WINDOW may be split horizontally when the following conditions
6421 hold:
6422 - `window-size-fixed' is either nil or equals `height' for the
6423 buffer of WINDOW.
6424 - `split-width-threshold' is an integer and WINDOW is at least as
6425 wide as `split-width-threshold'.
6426 - When WINDOW is split evenly, the emanating windows are at least
6427 `window-min-width' or two (whichever is larger) columns wide."
6431 ;; A window can be split horizontally when its width is not
6432 ;; fixed, it is at least `split-width-threshold' columns wide
6433 ;; and at least twice as wide as `window-min-width' and 2 (the
6434 ;; latter value is hardcoded).
6436 ;; Testing `window-full-width-p' here hardly makes any
6437 ;; sense nowadays. This can be done more intuitively by
6438 ;; setting up `split-width-threshold' appropriately.
6443 ;; A window can be split vertically when its height is not
6444 ;; fixed, it is at least `split-height-threshold' lines high,
6445 ;; and it is at least twice as high as `window-min-height' and 2
6446 ;; if it has a modeline or 1.
6457 "Split WINDOW in a way suitable for `display-buffer'.
6458 If `split-height-threshold' specifies an integer, WINDOW is at
6459 least `split-height-threshold' lines tall and can be split
6460 vertically, split WINDOW into two windows one above the other and
6461 return the lower window. Otherwise, if `split-width-threshold'
6462 specifies an integer, WINDOW is at least `split-width-threshold'
6463 columns wide and can be split horizontally, split WINDOW into two
6464 windows side by side and return the window on the right. If this
6465 can't be done either and WINDOW is the only window on its frame,
6466 try to split WINDOW vertically disregarding any value specified
6467 by `split-height-threshold'. If that succeeds, return the lower
6468 window. Return nil otherwise.
6470 By default `display-buffer' routines call this function to split
6471 the largest or least recently used window. To change the default
6472 customize the option `split-window-preferred-function'.
6474 You can enforce this function to not split WINDOW horizontally,
6475 by setting \(or binding) the variable `split-width-threshold' to
6476 nil. If, in addition, you set `split-height-threshold' to zero,
6477 chances increase that this function does split WINDOW vertically.
6479 In order to not split WINDOW vertically, set \(or bind) the
6480 variable `split-height-threshold' to nil. Additionally, you can
6481 set `split-width-threshold' to zero to make a horizontal split
6482 more likely to occur.
6484 Have a look at the function `window-splittable-p' if you want to
6485 know how `split-window-sensibly' determines whether WINDOW can be
6486 split."
6488 ;; Split window vertically.
6492 ;; Split window horizontally.
6497 ;; If WINDOW is the only window on its frame and is not the
6498 ;; minibuffer window, try to split it vertically disregarding
6499 ;; the value of `split-height-threshold'.
6507 ;; Functions for converting Emacs 23 buffer display options to buffer
6508 ;; display specifiers.
6510 "Helper function for `display-buffer-alist-set'."
6520 'display-buffer-alist
6524 "Set `display-buffer-alist' from Emacs 23 buffer display options.
6525 Optional argument NO-CUSTOM nil means use `customize-set-variable'
6526 to set the value of `display-buffer-alist'. NO-CUSTOM non-nil
6527 means to use `setq' instead.
6529 Optional argument ADD nil means to replace the actual value of
6530 `display-buffer-alist' with the value calculated here. ADD
6531 non-nil means prepend the value calculated here to the current
6532 value of `display-buffer-alist'."
6538 ;; Disable warnings, there are too many obsolete options here.
6540 ;; `pop-up-windows'
6542 nil
6545 ;; `split-window-sensibly' has been merged into the
6546 ;; `display-buffer-split-window' code as `nil'.
6547 split-window-preferred-function))
6551 ;; Undocumented hack.
6556 ;; Undocumented hack.
6559 'pop-up-window
6562 'pop-up-window
6567 no-custom)
6569 ;; `pop-up-frames'
6571 nil
6573 'pop-up-frame
6580 no-custom)
6582 ;; `special-display-regexps'
6586 ;; Plain string.
6590 'fun-with-args
6592 special-display-frame-alist))
6593 no-custom))
6599 ;; A function.
6603 'fun-with-args
6604 ;; Weary.
6606 no-custom))
6608 ;; A list of parameters.
6616 no-custom))
6624 'fun-with-args
6626 special-display-frame-alist))
6627 no-custom)))))))))
6629 ;; `special-display-buffer-names'
6633 ;; Plain string.
6637 'fun-with-args
6639 special-display-frame-alist))
6640 no-custom))
6646 ;; A function.
6650 'fun-with-args
6651 ;; Weary.
6653 no-custom))
6655 ;; A list of parameters.
6663 no-custom))
6671 'fun-with-args
6673 special-display-frame-alist))
6674 no-custom)))))))))
6676 ;; `same-window-regexps'
6683 no-custom))
6688 no-custom))))
6690 ;; `same-window-buffer-names'
6697 no-custom))
6702 no-custom))))
6704 ;; `reuse-window'
6706 nil
6708 'reuse-window
6711 ;; "0" (all visible and iconified frames) is hardcoded in
6712 ;; Emacs 23.
6716 no-custom)
6718 ;; `display-buffer-mark-dedicated'
6721 nil
6724 no-custom)))
6726 display-buffer-alist)
6727 \f
6729 "Set the height in lines of the text display area of WINDOW to HEIGHT.
6730 WINDOW must be a live window. HEIGHT doesn't include the mode
6731 line or header line, if any, or any partial-height lines in the
6732 text display area.
6734 Note that the current implementation of this function cannot
6735 always set the height exactly, but attempts to be conservative,
6736 by allocating more lines than are actually needed in the case
6737 where some error may be present."
6741 ;; Setting window-min-height to a value like 1 can lead to very
6742 ;; bizarre displays because it also allows Emacs to make *other*
6743 ;; windows 1-line tall, which means that there's no more space for
6744 ;; the modeline.
6749 "Make selected window DELTA columns wider.
6750 Interactively, if no argument is given, make selected window one
6751 column wider."
6756 "Make selected window DELTA columns narrower.
6757 Interactively, if no argument is given, make selected window one
6758 column narrower."
6763 "Return the number of screen lines in the region.
6764 The number of screen lines may be different from the number of actual lines,
6765 due to line breaking, display table, etc.
6767 Optional arguments BEG and END default to `point-min' and `point-max'
6768 respectively.
6770 If region ends with a newline, ignore it unless optional third argument
6771 COUNT-FINAL-NEWLINE is non-nil.
6773 The optional fourth argument WINDOW specifies the window used for obtaining
6774 parameters such as width, horizontal scrolling, and so on. The default is
6775 to use the selected window's parameters.
6777 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
6778 regardless of which buffer is displayed in WINDOW. This makes possible to use
6779 `count-screen-lines' in any buffer, whether or not it is currently displayed
6780 in some window."
6786 0
6799 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
6803 ;; If buffer ends with a newline, ignore it when
6804 ;; counting height unless point is after it.
6806 window))))
6808 ;;; Resizing buffers to fit their contents exactly.
6810 "Adjust height of WINDOW to display its buffer's contents exactly.
6811 WINDOW can be any live window and defaults to the selected one.
6813 Optional argument MAX-HEIGHT specifies the maximum height of
6814 WINDOW and defaults to the height of WINDOW's frame. Optional
6815 argument MIN-HEIGHT specifies the minimum height of WINDOW and
6816 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
6817 are specified in lines and include the mode line and header line,
6818 if any.
6820 Optional argument OVERRIDE non-nil means override restrictions
6821 imposed by `window-min-height' and `window-min-width' on the size
6822 of WINDOW.
6824 Return the number of lines by which WINDOW was enlarged or
6825 shrunk. If an error occurs during resizing, return nil but don't
6826 signal an error.
6828 Note that even if this function makes WINDOW large enough to show
6829 _all_ lines of its buffer you might not see the first lines when
6830 WINDOW was scrolled."
6832 ;; Do all the work in WINDOW and its buffer and restore the selected
6833 ;; window and the current buffer when we're done.
6835 ;; Can't resize a full height or fixed-size window.
6838 ;; `with-selected-window' should orderly restore the current buffer.
6840 ;; We are in WINDOW's buffer now.
6846 window-safe-min-height)))
6849 ;; Adjust MAX-HEIGHT.
6852 max-window-height
6854 ;; Make `desired-height' the height necessary to show
6855 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
6856 ;; and MAX-HEIGHT.
6861 ;; For non-minibuffers count the mode line, if any.
6863 mode-line-format)
6864 1
6866 ;; Count the header line, if any.
6868 max-height)
6869 min-height))
6878 ;; This `condition-case' shouldn't be necessary, but who knows?
6881 ;; Return zero if DELTA became zero in the proces.
6882 0
6883 ;; Don't try to redisplay with the cursor at the end on its
6884 ;; own line--that would force a scroll and spoil things.
6886 ;; It's silly to put `point' at the end of the previous
6887 ;; line and so maybe force horizontal scrolling.
6889 ;; Call `resize-window' with OVERRIDE argument equal WINDOW.
6891 ;; Check if the last line is surely fully visible. If
6892 ;; not, enlarge the window.
6896 ;; Don't include final newline.
6899 ;; If line-wrapping is turned off, test the
6900 ;; beginning of the last line for
6901 ;; visibility instead of the end, as the
6902 ;; end of the line could be invisible by
6903 ;; virtue of extending past the edge of the
6904 ;; window.
6908 ;; This loop might in some rare pathological cases raise
6909 ;; an error - another reason for the `condition-case'.
6916 delta))))
6919 "Return t if WINDOW can be shrunk without shrinking other windows.
6920 WINDOW defaults to the selected window."
6923 ;; The following doesn't satisfy the doc-string's claim when
6924 ;; window and previous-/next-window are not part of the same
6925 ;; combination but still share a common edge. Using
6926 ;; `window-iso-combined-p' instead should handle that.
6933 "Shrink height of WINDOW if its buffer doesn't need so many lines.
6934 More precisely, shrink WINDOW vertically to be as small as
6935 possible, while still showing the full contents of its buffer.
6936 WINDOW defaults to the selected window.
6938 Do not shrink WINDOW to less than `window-min-height' lines. Do
6939 nothing if the buffer contains more lines than the present window
6940 height, or if some of the window's contents are scrolled out of
6941 view, or if shrinking this window would also shrink another
6942 window, or if the window is the only window of its frame.
6944 Return non-nil if the window was shrunk, nil otherwise."
6947 ;; Make sure that WINDOW is vertically combined and `point-min' is
6948 ;; visible (for whatever reason that's needed). The remaining issues
6949 ;; should be taken care of by `fit-window-to-buffer'.
6953 \f
6955 "Kill the current buffer and delete the selected window."
6964 ;; If `delete-window' failed before, we rerun it to regenerate
6965 ;; the error so it can be seen in the echo area.
6968 ;; If the buffer is not dead for some reason (probably because
6969 ;; of a `quit' signal), remove the hook again.
6975 "Quit WINDOW and bury its buffer.
6976 With a prefix argument, kill the buffer instead. WINDOW defaults
6977 to the selected window.
6979 If WINDOW is non-nil, dedicated, or a minibuffer window, delete
6980 it and, if it's alone on its frame, its frame too. Otherwise, or
6981 if deleting WINDOW fails in any of the preceding cases, display
6982 another buffer in WINDOW using `switch-to-buffer'.
6984 Optional argument KILL non-nil means kill WINDOW's buffer.
6985 Otherwise, bury WINDOW's buffer, see `bury-buffer'."
6991 ;; WINDOW is either non-nil, a minibuffer window, or dedicated;
6992 ;; try to delete it.
6996 ;; WINDOW is alone on its frame.
6998 ;; There are other windows on its frame, delete WINDOW.
7000 ;; Otherwise, switch to another buffer in the selected window.
7003 ;; Deal with the buffer.
7007 \f
7009 "Indicates the last recenter operation performed.
7013 "Cycling order for `recenter-top-bottom'.
7014 A list of elements with possible values `top', `middle', `bottom',
7015 integer or float numbers that define the cycling order for
7016 the command `recenter-top-bottom'.
7018 Top and bottom destinations are `scroll-margin' lines the from true
7019 window top and bottom. Middle redraws the frame and centers point
7020 vertically within the window. Integer number moves current line to
7021 the specified absolute window-line. Float number between 0.0 and 1.0
7022 means the percentage of the screen space from the top. The default
7023 cycling order is middle -> top -> bottom."
7034 "Move current buffer line to the specified window line.
7035 With no prefix argument, successive calls place point according
7036 to the cycling order defined by `recenter-positions'.
7038 A prefix argument is handled like `recenter':
7039 With numeric prefix ARG, move current line to window-line ARG.
7040 With plain `C-u', move current line to window center."
7048 recenter-positions))
7067 "Position point relative to window.
7069 With a prefix argument ARG, acts like `move-to-window-line'.
7071 With no argument, positions point at center of window.
7072 Successive calls position point at positions defined
7073 by `recenter-positions'."
7081 recenter-positions))
7098 \f
7099 ;;; Scrolling commands.
7101 ;;; Scrolling commands which does not signal errors at top/bottom
7102 ;;; of buffer at first key-press (instead moves to top/bottom
7103 ;;; of buffer).
7106 "Move point to top/bottom of buffer before signalling a scrolling error.
7107 A value of nil means just signal an error if no more scrolling possible.
7108 A value of t means point moves to the beginning or the end of the buffer
7109 \(depending on scrolling direction) when no more scrolling possible.
7110 When point is already on that position, then signal an error."
7116 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
7117 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
7118 scroll window further, move cursor to the bottom line.
7119 When point is already on that position, then signal an error.
7120 A near full screen is `next-screen-context-lines' less than a full screen.
7121 Negative ARG means scroll downward.
7122 If ARG is the atom `-', scroll downward by nearly full screen."
7138 ;; When scrolling by ARG lines can't be done,
7139 ;; move by ARG lines instead.
7141 ;; When ARG is nil for full-screen scrolling,
7142 ;; move to the bottom of the buffer.
7148 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
7149 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
7150 scroll window further, move cursor to the top line.
7151 When point is already on that position, then signal an error.
7152 A near full screen is `next-screen-context-lines' less than a full screen.
7153 Negative ARG means scroll upward.
7154 If ARG is the atom `-', scroll upward by nearly full screen."
7170 ;; When scrolling by ARG lines can't be done,
7171 ;; move by ARG lines instead.
7173 ;; When ARG is nil for full-screen scrolling,
7174 ;; move to the top of the buffer.
7179 ;;; Scrolling commands which scroll a line instead of full screen.
7182 "Scroll text of selected window upward ARG lines; or one line if no ARG.
7183 If ARG is omitted or nil, scroll upward by one line.
7184 This is different from `scroll-up-command' that scrolls a full screen."
7191 "Scroll text of selected window down ARG lines; or one line if no ARG.
7192 If ARG is omitted or nil, scroll down by one line.
7193 This is different from `scroll-down-command' that scrolls a full screen."
7199 \f
7202 For more details, see the documentation for `scroll-other-window'."
7205 ;; Just invert the argument's meaning.
7206 ;; We can do that without knowing which window it will be.
7212 "Move point to the beginning of the buffer in the other window.
7213 Leave mark at previous position.
7214 With arg N, put point N/10 of the way from the true beginning."
7218 ;; We use unwind-protect rather than save-window-excursion
7219 ;; because the latter would preserve the things we want to change.
7223 ;; Set point and mark in that window's buffer.
7226 ;; Set point accordingly.
7231 "Move point to the end of the buffer in the other window.
7232 Leave mark at previous position.
7233 With arg N, put point N/10 of the way from the true end."
7235 ;; See beginning-of-buffer-other-window for comments.
7245 \f
7256 "When non-nil, special state of delayed window autoselection.
7257 Possible values are `suspend' \(suspend autoselection after a menu or
7258 scrollbar interaction\) and `select' \(the next invocation of
7262 "Cancel delayed window autoselection.
7263 Optional argument FORCE means cancel unconditionally."
7265 ;; Don't cancel for select-window or select-frame events
7266 ;; or when the user drags a scroll bar.
7278 "Start delayed window autoselection.
7279 MOUSE-POSITION is the last position where the mouse was seen as returned
7280 by `mouse-position'. Optional argument WINDOW non-nil denotes the
7281 window where the mouse was seen. Optional argument SUSPEND non-nil
7282 means suspend autoselection."
7283 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
7287 ;; Install timer which runs `mouse-autoselect-window-select' after
7288 ;; `mouse-autoselect-window' seconds.
7294 "Select window with delayed window autoselection.
7295 If the mouse position has stabilized in a non-selected window, select
7296 that window. The minibuffer window is selected only if the minibuffer is
7297 active. This function is run by `mouse-autoselect-window-timer'."
7308 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
7309 ;; of WINDOW, temporarily suspend delayed autoselection.
7312 ;; Delayed autoselection was temporarily suspended, reenable it.
7317 ;; If `mouse-autoselect-window' is positive, select
7318 ;; window if the window is the same as before.
7320 ;; Otherwise select window if the mouse is at the same
7321 ;; position as before. Observe that the first test after
7322 ;; starting autoselection usually fails since the value of
7323 ;; `mouse-autoselect-window-position' recorded there is the
7324 ;; position where the mouse has entered the new window and
7325 ;; not necessarily where the mouse has stopped moving.
7327 ;; The minibuffer is a candidate window if it's active.
7330 ;; Mouse position has stabilized in non-selected window: Cancel
7331 ;; delayed autoselection and try to select that window.
7333 ;; Select window where mouse appears unless the selected window is the
7334 ;; minibuffer. Use `unread-command-events' in order to execute pre-
7335 ;; and post-command hooks and trigger idle timers. To avoid delaying
7336 ;; autoselection again, set `mouse-autoselect-window-state'."
7341 unread-command-events))))
7345 ;; Mouse position has either stabilized in the selected window or at
7346 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
7349 ;; Mouse position has not stabilized yet, resume delayed
7350 ;; autoselection.
7354 "Handle select-window events."
7358 ;; Don't switch if we're currently in the minibuffer.
7359 ;; This tries to work around problems where the
7360 ;; minibuffer gets unselected unexpectedly, and where
7361 ;; you then have to move your mouse all the way down to
7362 ;; the minibuffer to select it.
7364 ;; Don't switch to minibuffer window unless it's active.
7367 ;; Don't switch when autoselection shall be delayed.
7372 ;; Cancel any delayed autoselection.
7374 ;; Start delayed autoselection from current mouse
7375 ;; position and window.
7377 ;; Executing a command cancels delayed autoselection.
7381 ;; Reset state of delayed autoselection.
7383 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
7388 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
7389 WINDOW defaults to the selected window.
7390 Return nil if WINDOW is not a partial-width window
7391 (regardless of the value of `truncate-lines').
7392 Otherwise, consult the value of `truncate-partial-width-windows'
7393 for the buffer shown in WINDOW."
7401 t-p-w-w))))
7402 \f
7415 ;;; window.el ends here