| blob | 49f84960078b52fd86fb32e6dc5f703710cf3a22 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2012
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-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live window or internal window.
105 Otherwise, return nil; this includes the case where OBJECT is a
106 deleted window."
109 t))
112 "Return buffer specified by BUFFER-OR-NAME.
113 BUFFER-OR-NAME must be either a buffer or a string naming a live
114 buffer and defaults to the current buffer."
120 buffer-or-name
127 "Return frame specified by FRAME.
128 FRAME must be a live frame and defaults to the selected frame."
131 frame
136 "Return window specified by WINDOW.
137 If WINDOW is nil, return `selected-window'.
138 If WINDOW is a live window or internal window, return WINDOW;
139 if LIVE-ONLY is non-nil, return WINDOW for a live window only.
140 Otherwise, signal an error."
145 window
148 window
152 "If non-nil, standard functions ignore window parameters.
153 The functions currently affected by this are `split-window',
154 `delete-window', `delete-other-windows' and `other-window'.
156 An application may bind this to a non-nil value around calls to
160 "The absolute minimum number of lines of a window.
164 "The minimum number of lines of any window.
165 The value has to accommodate a mode- or header-line if present.
166 A value less than `window-safe-min-height' is ignored. The value
167 of this variable is honored when windows are resized or split.
169 Applications should never rebind this variable. To resize a
170 window to a height less than the one specified here, an
171 application should instead call `window-resize' with a non-nil
172 IGNORE argument. In order to have `split-window' make a window
173 shorter, explicitly specify the SIZE argument of that function."
179 "The absolute minimum number of columns of a window.
183 "The minimum number of columns of any window.
184 The value has to accommodate margins, fringes, or scrollbars if
185 present. A value less than `window-safe-min-width' is ignored.
186 The value of this variable is honored when windows are resized or
187 split.
189 Applications should never rebind this variable. To resize a
190 window to a width less than the one specified here, an
191 application should instead call `window-resize' with a non-nil
192 IGNORE argument. In order to have `split-window' make a window
193 narrower, explicitly specify the SIZE argument of that function."
199 "Return non-nil if WINDOW has siblings in a given direction.
200 If WINDOW is omitted or nil, it defaults to the selected window.
202 HORIZONTAL determines a direction for the window combination.
203 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
204 of a vertical window combination.
205 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
206 horizontal window combination."
215 "Return largest number of windows vertically arranged within WINDOW.
216 If WINDOW is omitted or nil, it defaults to the selected window.
217 If HORIZONTAL is non-nil, return the largest number of
218 windows horizontally arranged within WINDOW."
222 ;; If WINDOW is live, return 1.
227 ;; If WINDOW is iso-combined, return the sum of the values for all
228 ;; child windows of WINDOW.
234 count))
236 count))
238 ;; If WINDOW is not iso-combined, return the maximum value of any
239 ;; child window of WINDOW.
245 count))
247 count))))
250 "Helper function for `walk-window-tree' and `walk-window-subtree'."
268 "Run function FUN on each live window of FRAME.
269 FUN must be a function with one argument - a window. FRAME must
270 be a live frame and defaults to the selected one. ANY, if
271 non-nil means to run FUN on all live and internal windows of
272 FRAME.
274 This function performs a pre-order, depth-first traversal of the
275 window tree. If FUN changes the window tree, the result is
276 unpredictable."
282 "Run function FUN on the subtree of windows rooted at WINDOW.
283 WINDOW defaults to the selected window. FUN must be a function
284 with one argument - a window. By default, run FUN only on live
285 windows of the subtree. If the optional argument ANY is non-nil,
286 run FUN on all live and internal windows of the subtree. If
287 WINDOW is live, run FUN on WINDOW only.
289 This function performs a pre-order, depth-first traversal of the
290 subtree rooted at WINDOW. If FUN changes that tree, the result
291 is unpredictable."
296 "Return first window on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return a window whose window-parameter value
299 for PARAMETER equals VALUE (comparison is done with `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too."
309 frame any))))
311 ;;; Atomic windows.
313 "Return root of atomic window WINDOW is a part of.
314 WINDOW can be any window and defaults to the selected one.
315 Return nil if WINDOW is not part of an atomic window."
321 root))
324 "Make WINDOW an atomic window.
325 WINDOW must be an internal window. Return WINDOW."
331 window t)
332 window))
335 "Subroutine of `window--atom-check'."
345 window t))
346 ;; count >= 1 must hold here. If there's no other
347 ;; window around dissolve this atomic window.
349 ;; Dissolve atomic window.
353 window t)))
354 ;; Check children.
358 ;; Check right sibling
362 "Check atomicity of all windows on FRAME.
363 FRAME defaults to the selected frame. If an atomic window is
364 wrongly configured, reset the atomicity of all its windows on
365 FRAME to nil. An atomic window is wrongly configured if it has
366 no child windows or one of its child windows is not atomic."
369 ;; Side windows.
374 "If non-nil, left and right side windows are full height.
375 Otherwise, top and bottom side windows are full width."
381 "Maximum number of side window slots.
382 The value is a list of four elements specifying the number of
383 side window slots on (in this order) the left, top, right and
384 bottom side of each frame. If an element is a number, this means
385 to display at most that many side windows on the corresponding
386 side. If an element is nil, this means there's no bound on the
387 number of slots on that side."
389 :risky t
390 :type
396 :value nil
403 :value nil
410 :value nil
417 :value nil
424 "Check the window-side parameter of all windows on FRAME.
425 FRAME defaults to the selected frame. If the configuration is
426 invalid, reset all window-side parameters to nil.
428 A valid configuration has to preserve the following invariant:
430 - If a window has a non-nil window-side parameter, it must have a
431 parent window and the parent window's window-side parameter
432 must be either nil or the same as for window.
434 - If windows with non-nil window-side parameters exist, there
435 must be at most one window of each side and non-side with a
436 parent whose window-side parameter is nil and there must be no
437 leaf window whose window-side parameter is nil."
439 side parent parent-side)
447 ;; The following `cond' seems a bit tedious, but I'd
448 ;; rather stick to using just the stack.
452 ;; A parent whose window-side is non-nil must
453 ;; have a child with the same window-side.
455 ;; Now check that there's more than one main window
456 ;; for any of none, left, top, right and bottom.
478 ;; A leaf window without window-side parameter,
479 ;; record its existence.
481 frame t))
483 ;; At least one non-side window exists, so there must
484 ;; be at least one side-window and no normal window.
486 ;; No non-side window exists, so there must be no side
487 ;; window either.
492 frame t))))
495 "Check atomic and side windows on FRAME.
496 FRAME defaults to the selected frame."
500 ;;; Window sizes.
502 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
503 If the value is `height', then only the window's height is fixed.
504 If the value is `width', then only the window's width is fixed.
505 Any other non-nil value fixes both the width and the height.
507 Emacs won't change the size of any window displaying that buffer,
508 unless it has no other choice (like when deleting a neighboring
513 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
517 "Return the minimum size of WINDOW.
518 WINDOW can be an arbitrary window and defaults to the selected
519 one. Optional argument HORIZONTAL non-nil means return the
520 minimum number of columns of WINDOW; otherwise return the minimum
521 number of WINDOW's lines.
523 Optional argument IGNORE, if non-nil, means ignore restrictions
524 imposed by fixed size windows, `window-min-height' or
525 `window-min-width' settings. If IGNORE equals `safe', live
526 windows may get as small as `window-safe-min-height' lines and
527 `window-safe-min-width' columns. If IGNORE is a window, ignore
528 restrictions for that window only. Any other non-nil value
529 means ignore all of the above restrictions for all windows."
534 "Internal function of `window-min-size'."
538 ;; WINDOW is an internal window.
540 ;; The minimum size of an iso-combination is the sum of
541 ;; the minimum sizes of its child windows.
546 ;; The minimum size of an ortho-combination is the maximum of
547 ;; the minimum sizes of its child windows.
552 value)
557 ;; The minimum size of a fixed size window is its size.
560 ;; If IGNORE equals `safe' or WINDOW return the safe values.
563 ;; For the minimum width of a window take fringes and
564 ;; scroll-bars into account. This is questionable and should
565 ;; be removed as soon as we are able to split (and resize)
566 ;; windows such that the new (or resized) windows can get a
567 ;; size less than the user-specified `window-min-height' and
568 ;; `window-min-width'.
573 (+ window-safe-min-width
586 window-min-width
589 ;; For the minimum height of a window take any mode- or
590 ;; header-line into account.
596 window-min-height
600 "Return DELTA if DELTA lines can be added to WINDOW.
601 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
602 columns can be added to WINDOW. A return value of zero means
603 that no lines (or columns) can be added to WINDOW.
605 This function looks only at WINDOW and, recursively, its child
606 windows. The function `window-resizable' looks at other windows
607 as well.
609 DELTA positive means WINDOW shall be enlarged by DELTA lines or
610 columns. If WINDOW cannot be enlarged by DELTA lines or columns
611 return the maximum value in the range 0..DELTA by which WINDOW
612 can be enlarged.
614 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
615 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
616 return the minimum value in the range DELTA..0 by which WINDOW
617 can be shrunk.
619 Optional argument IGNORE non-nil means ignore restrictions
620 imposed by fixed size windows, `window-min-height' or
621 `window-min-width' settings. If IGNORE equals `safe', live
622 windows may get as small as `window-safe-min-height' lines and
623 `window-safe-min-width' columns. If IGNORE is a window, ignore
624 restrictions for that window only. Any other non-nil value means
625 ignore all of the above restrictions for all windows."
631 delta))
633 delta)
636 0
637 delta))
641 "Return t if WINDOW can be resized by DELTA lines.
642 For the meaning of the arguments of this function see the
643 doc-string of `window-sizable'."
650 "Internal function for `window-size-fixed-p'."
654 ;; WINDOW is an internal window.
656 ;; An iso-combination is fixed size if all its child
657 ;; windows are fixed-size.
661 ;; We found a non-fixed-size child window, so
662 ;; WINDOW's size is not fixed.
665 ;; All child windows are fixed-size, so WINDOW's size is
666 ;; fixed.
668 ;; An ortho-combination is fixed-size if at least one of its
669 ;; child windows is fixed-size.
672 ;; We found a fixed-size child window, so WINDOW's size
673 ;; is fixed.
676 ;; WINDOW is a live window.
683 "Return non-nil if WINDOW's height is fixed.
684 WINDOW can be an arbitrary window and defaults to the selected
685 window. Optional argument HORIZONTAL non-nil means return
686 non-nil if WINDOW's width is fixed.
688 If this function returns nil, this does not necessarily mean that
689 WINDOW can be resized in the desired direction. The function
690 `window-resizable' can tell that."
695 "Internal function for `window-min-delta'."
697 ;; If we can't go up, return zero.
698 0
699 ;; Else try to find a non-fixed-size sibling of WINDOW.
704 ;; In an iso-combination throw DELTA if we find at least one
705 ;; child window and that window is either not fixed-size or
706 ;; we can ignore fixed-sizeness.
716 ;; We found a non-fixed-size child window.
719 ;; In an ortho-combination set DELTA to the minimum value by
720 ;; which other child windows can shrink.
729 delta
733 "Return number of lines by which WINDOW can be shrunk.
734 WINDOW can be an arbitrary window and defaults to the selected
735 window. Return zero if WINDOW cannot be shrunk.
737 Optional argument HORIZONTAL non-nil means return number of
738 columns by which WINDOW can be shrunk.
740 Optional argument IGNORE non-nil means ignore restrictions
741 imposed by fixed size windows, `window-min-height' or
742 `window-min-width' settings. If IGNORE is a window, ignore
743 restrictions for that window only. If IGNORE equals `safe',
744 live windows may get as small as `window-safe-min-height' lines
745 and `window-safe-min-width' columns. Any other non-nil value
746 means ignore all of the above restrictions for all windows.
748 Optional argument TRAIL restricts the windows that can be enlarged.
749 If its value is `before', only windows to the left of or above WINDOW
750 can be enlarged. If it is `after', only windows to the right of or
751 below WINDOW can be enlarged.
753 Optional argument NOUP non-nil means don't go up in the window
754 tree, but try to enlarge windows within WINDOW's combination only.
756 Optional argument NODOWN non-nil means don't check whether WINDOW
757 itself (and its child windows) can be shrunk; check only whether
758 at least one other window can be enlarged appropriately."
764 ;; If NODOWN is t, try to recover the entire size of WINDOW.
767 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
768 ;; there's nothing to recover.
771 ;; Otherwise, try to recover whatever WINDOW is larger than its
772 ;; minimum size.
777 "Internal function of `window-max-delta'."
779 ;; Can't go up. Return DELTA.
780 delta
785 ;; For an iso-combination calculate how much we can get from
786 ;; other child windows.
795 (+ delta
799 ;; For an ortho-combination throw DELTA when at least one
800 ;; child window is fixed-size.
808 ;; When NOUP is nil, DELTA is all we can get.
809 delta
810 ;; Else try with parent of WINDOW, passing the DELTA we
811 ;; recovered so far.
815 "Return maximum number of lines by which WINDOW can be enlarged.
816 WINDOW can be an arbitrary window and defaults to the selected
817 window. The return value is zero if WINDOW cannot be enlarged.
819 Optional argument HORIZONTAL non-nil means return maximum number
820 of columns by which WINDOW can be enlarged.
822 Optional argument IGNORE non-nil means ignore restrictions
823 imposed by fixed size windows, `window-min-height' or
824 `window-min-width' settings. If IGNORE is a window, ignore
825 restrictions for that window only. If IGNORE equals `safe',
826 live windows may get as small as `window-safe-min-height' lines
827 and `window-safe-min-width' columns. Any other non-nil value means
828 ignore all of the above restrictions for all windows.
830 Optional argument TRAIL restricts the windows that can be enlarged.
831 If its value is `before', only windows to the left of or above WINDOW
832 can be enlarged. If it is `after', only windows to the right of or
833 below WINDOW can be enlarged.
835 Optional argument NOUP non-nil means don't go up in the window
836 tree but try to obtain the entire space from windows within
837 WINDOW's combination.
839 Optional argument NODOWN non-nil means do not check whether
840 WINDOW itself (and its child windows) can be enlarged; check
841 only whether other windows can be shrunk appropriately."
845 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
846 ;; size.
847 0
848 ;; WINDOW has no fixed size.
851 ;; Make NOUP also inhibit the min-size check.
853 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
854 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
855 can be resized horizontally by DELTA columns. A return value of
856 zero means that WINDOW is not resizable.
858 DELTA positive means WINDOW shall be enlarged by DELTA lines or
859 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
860 return the maximum value in the range 0..DELTA by which WINDOW
861 can be enlarged.
863 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
864 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
865 return the minimum value in the range DELTA..0 that can be used
866 for shrinking WINDOW.
868 Optional argument IGNORE non-nil means ignore restrictions
869 imposed by fixed size windows, `window-min-height' or
870 `window-min-width' settings. If IGNORE is a window, ignore
871 restrictions for that window only. If IGNORE equals `safe',
872 live windows may get as small as `window-safe-min-height' lines
873 and `window-safe-min-width' columns. Any other non-nil value
874 means ignore all of the above restrictions for all windows.
876 Optional argument TRAIL `before' means only windows to the left
877 of or below WINDOW can be shrunk. Optional argument TRAIL
878 `after' means only windows to the right of or above WINDOW can be
879 shrunk.
881 Optional argument NOUP non-nil means don't go up in the window
882 tree but check only whether space can be obtained from (or given
883 to) WINDOW's siblings.
885 Optional argument NODOWN non-nil means don't go down in the
886 window tree. This means do not check whether resizing would
887 violate size restrictions of WINDOW or its child windows."
892 delta))
895 delta))
899 "Return t if WINDOW can be resized vertically by DELTA lines.
900 For the meaning of the arguments of this function see the
901 doc-string of `window--resizable'."
905 delta)
907 delta)))
910 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
911 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
912 can be resized horizontally by DELTA columns. A return value of
913 zero means that WINDOW is not resizable.
915 DELTA positive means WINDOW shall be enlarged by DELTA lines or
916 columns. If WINDOW cannot be enlarged by DELTA lines or columns
917 return the maximum value in the range 0..DELTA by which WINDOW
918 can be enlarged.
920 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
921 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
922 return the minimum value in the range DELTA..0 that can be used
923 for shrinking WINDOW.
925 Optional argument IGNORE non-nil means ignore restrictions
926 imposed by fixed size windows, `window-min-height' or
927 `window-min-width' settings. If IGNORE is a window, ignore
928 restrictions for that window only. If IGNORE equals `safe',
929 live windows may get as small as `window-safe-min-height' lines
930 and `window-safe-min-width' columns. Any other non-nil value
931 means ignore all of the above restrictions for all windows."
936 "Return the total height or width of WINDOW.
937 If WINDOW is omitted or nil, it defaults to the selected window.
939 If HORIZONTAL is omitted or nil, return the total height of
940 WINDOW, in lines, like `window-total-height'. Otherwise return
941 the total width, in columns, like `window-total-width'."
946 ;; Eventually we should make `window-height' obsolete.
949 ;; See discussion in bug#4543.
951 "Return t if WINDOW is as high as its containing frame.
952 More precisely, return t if and only if the total height of
953 WINDOW equals the total height of the root window of WINDOW's
954 frame. WINDOW can be any window and defaults to the selected
955 one."
961 "Return t if WINDOW is as wide as its containing frame.
962 More precisely, return t if and only if the total width of WINDOW
963 equals the total width of the root window of WINDOW's frame.
964 WINDOW can be any window and defaults to the selected one."
970 "Return the height or width of WINDOW's text area.
971 If WINDOW is omitted or nil, it defaults to the selected window.
972 Signal an error if the window is not live.
974 If HORIZONTAL is omitted or nil, return the height of the text
975 area, like `window-body-height'. Otherwise, return the width of
976 the text area, like `window-body-width'."
981 ;; Eventually we should make `window-height' obsolete.
985 "Return the current scroll bar settings for WINDOW.
986 WINDOW must be a live window and defaults to the selected one.
988 The return value is a cons cell (VERTICAL . HORIZONTAL) where
989 VERTICAL specifies the current location of the vertical scroll
990 bars (`left', `right', or nil), and HORIZONTAL specifies the
991 current location of the horizontal scroll bars (`top', `bottom',
992 or nil).
994 Unlike `window-scroll-bars', this function reports the scroll bar
995 type actually used, once frame defaults and `scroll-bar-mode' are
996 taken into account."
1009 "Cycle through all live windows, calling FUN for each one.
1010 FUN must specify a function with a window as its sole argument.
1011 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1012 windows to include in the walk.
1014 MINIBUF t means include the minibuffer window even if the
1015 minibuffer is not active. MINIBUF nil or omitted means include
1016 the minibuffer window only if the minibuffer is active. Any
1017 other value means do not include the minibuffer window even if
1018 the minibuffer is active.
1020 ALL-FRAMES nil or omitted means consider all windows on the
1021 selected frame, plus the minibuffer window if specified by the
1022 MINIBUF argument. If the minibuffer counts, consider all windows
1023 on all frames that share that minibuffer too. The following
1024 non-nil values of ALL-FRAMES have special meanings:
1026 - t means consider all windows on all existing frames.
1028 - `visible' means consider all windows on all visible frames on
1029 the current terminal.
1031 - 0 (the number zero) means consider all windows on all visible
1032 and iconified frames on the current terminal.
1034 - A frame means consider all windows on that frame only.
1036 Anything else means consider all windows on the selected frame
1037 and no others.
1039 This function changes neither the order of recently selected
1040 windows nor the buffer list."
1041 ;; If we start from the minibuffer window, don't fail to come
1042 ;; back to it.
1045 ;; Make sure to not mess up the order of recently selected
1046 ;; windows. Use `save-selected-window' and `select-window'
1047 ;; with second argument non-nil for this purpose.
1055 "Return value of WINDOW's point.
1056 WINDOW can be any live window and defaults to the selected one.
1058 This function is like `window-point' with one exception: If
1059 WINDOW is selected, it returns the value of `point' of WINDOW's
1060 buffer regardless of whether that buffer is current or not."
1068 "Set value of WINDOW's point to POS.
1069 WINDOW can be any live window and defaults to the selected one.
1071 This function is like `set-window-point' with one exception: If
1072 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1073 regardless of whether that buffer is current or not."
1081 "Return t if WINDOW is at SIDE of its containing frame.
1082 WINDOW can be any window and defaults to the selected one. SIDE
1083 can be any of the symbols `left', `top', `right' or `bottom'.
1084 The default value nil is handled like `bottom'."
1096 "Return list of all windows on SIDE of FRAME.
1097 FRAME must be a live frame and defaults to the selected frame.
1098 SIDE can be any of the symbols `left', `top', `right' or
1099 `bottom'. The default value nil is handled like `bottom'."
1106 frame)
1110 "Support function for `window-in-direction'."
1122 "Return window in DIRECTION as seen from WINDOW.
1123 DIRECTION must be one of `above', `below', `left' or `right'.
1124 WINDOW must be a live window and defaults to the selected one.
1125 IGNORE non-nil means a window can be returned even if its
1126 `no-other-window' parameter is non-nil."
1139 ;; The column / row value of `posn-at-point' can be nil for the
1140 ;; mini-window, guard against that.
1151 best best-2 best-diff-2-new)
1158 ;; Ignore ourselves.
1160 ;; Ignore W unless IGNORE is non-nil.
1166 ;; W is to the left or right of WINDOW and covers POSN.
1176 ;; W is to the left or right of WINDOW but does not
1177 ;; cover POSN.
1192 ;; W is above or below WINDOW and covers POSN.
1202 ;; W is above or below WINDOW but does not cover POSN.
1217 "Return a live window satisfying PREDICATE.
1218 More precisely, cycle through all windows calling the function
1219 PREDICATE on each one of them with the window as its sole
1220 argument. Return the first window for which PREDICATE returns
1221 non-nil. Windows are scanned starting with the window following
1222 the selected window. If no window satisfies PREDICATE, return
1223 DEFAULT.
1225 MINIBUF t means include the minibuffer window even if the
1226 minibuffer is not active. MINIBUF nil or omitted means include
1227 the minibuffer window only if the minibuffer is active. Any
1228 other value means do not include the minibuffer window even if
1229 the minibuffer is active.
1231 ALL-FRAMES nil or omitted means consider all windows on the selected
1232 frame, plus the minibuffer window if specified by the MINIBUF
1233 argument. If the minibuffer counts, consider all windows on all
1234 frames that share that minibuffer too. The following non-nil
1235 values of ALL-FRAMES have special meanings:
1237 - t means consider all windows on all existing frames.
1239 - `visible' means consider all windows on all visible frames on
1240 the current terminal.
1242 - 0 (the number zero) means consider all windows on all visible
1243 and iconified frames on the current terminal.
1245 - A frame means consider all windows on that frame only.
1247 Anything else means consider all windows on the selected frame
1248 and no others."
1252 minibuf all-frames))
1255 default))
1260 "Return the least recently used window on frames specified by ALL-FRAMES.
1261 Return a full-width window if possible. A minibuffer window is
1262 never a candidate. A dedicated window is never a candidate
1263 unless DEDICATED is non-nil, so if all windows are dedicated, the
1264 value is nil. Avoid returning the selected window if possible.
1266 The following non-nil values of the optional argument ALL-FRAMES
1267 have special meanings:
1269 - t means consider all windows on all existing frames.
1271 - `visible' means consider all windows on all visible frames on
1272 the current terminal.
1274 - 0 (the number zero) means consider all windows on all visible
1275 and iconified frames on the current terminal.
1277 - A frame means consider all windows on that frame only.
1279 Any other value of ALL-FRAMES means consider all windows on the
1280 selected frame and no others."
1296 "Return the most recently used window on frames specified by ALL-FRAMES.
1297 Do not return a minibuffer window.
1299 The following non-nil values of the optional argument ALL-FRAMES
1300 have special meanings:
1302 - t means consider all windows on all existing frames.
1304 - `visible' means consider all windows on all visible frames on
1305 the current terminal.
1307 - 0 (the number zero) means consider all windows on all visible
1308 and iconified frames on the current terminal.
1310 - A frame means consider all windows on that frame only.
1312 Any other value of ALL-FRAMES means consider all windows on the
1313 selected frame and no others."
1320 best-window))
1323 "Return the largest window on frames specified by ALL-FRAMES.
1324 A minibuffer window is never a candidate. A dedicated window is
1325 never a candidate unless DEDICATED is non-nil, so if all windows
1326 are dedicated, the value is nil.
1328 The following non-nil values of the optional argument ALL-FRAMES
1329 have special meanings:
1331 - t means consider all windows on all existing frames.
1333 - `visible' means consider all windows on all visible frames on
1334 the current terminal.
1336 - 0 (the number zero) means consider all windows on all visible
1337 and iconified frames on the current terminal.
1339 - A frame means consider all windows on that frame only.
1341 Any other value of ALL-FRAMES means consider all windows on the
1342 selected frame and no others."
1344 best-window size)
1352 best-window))
1355 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1356 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1357 and defaults to the current buffer. Windows are scanned starting
1358 with the selected window.
1360 MINIBUF t means include the minibuffer window even if the
1361 minibuffer is not active. MINIBUF nil or omitted means include
1362 the minibuffer window only if the minibuffer is active. Any
1363 other value means do not include the minibuffer window even if
1364 the minibuffer is active.
1366 ALL-FRAMES nil or omitted means consider all windows on the
1367 selected frame, plus the minibuffer window if specified by the
1368 MINIBUF argument. If the minibuffer counts, consider all windows
1369 on all frames that share that minibuffer too. The following
1370 non-nil values of ALL-FRAMES have special meanings:
1372 - t means consider all windows on all existing frames.
1374 - `visible' means consider all windows on all visible frames on
1375 the current terminal.
1377 - 0 (the number zero) means consider all windows on all visible
1378 and iconified frames on the current terminal.
1380 - A frame means consider all windows on that frame only.
1382 Anything else means consider all windows on the selected frame
1383 and no others."
1385 windows)
1392 "Return t if WINDOW is the currently active minibuffer window."
1396 "Return the number of live windows on the selected frame.
1397 The optional argument MINIBUF specifies whether the minibuffer
1398 window shall be counted. See `walk-windows' for the precise
1399 meaning of this argument."
1401 \f
1402 ;;; Resizing windows.
1404 "Reset resize values for all windows on FRAME.
1405 FRAME defaults to the selected frame.
1407 This function stores the current value of `window-total-size' applied
1408 with argument HORIZONTAL in the new total size of all windows on
1409 FRAME. It also resets the new normal size of each of these
1410 windows."
1415 "Internal function of `window--resize-reset'."
1416 ;; Register old size in the new total size.
1418 ;; Reset new normal size.
1425 ;; The following routine is used to manually resize the minibuffer
1426 ;; window and is currently used, for example, by ispell.el.
1428 "Resize minibuffer window WINDOW by DELTA lines.
1429 If WINDOW cannot be resized by DELTA lines make it as large (or
1430 as small) as possible, but don't signal an error."
1438 ;; Sanitize DELTA.
1445 ;; Resize now.
1447 ;; Ideally we should be able to resize just the last child of root
1448 ;; here. See the comment in `resize-root-window-vertically' for
1449 ;; why we do not do that.
1452 ;; The following routine catches the case where we want to resize
1453 ;; a minibuffer-only frame.
1457 "Resize WINDOW vertically by DELTA lines.
1458 WINDOW can be an arbitrary window and defaults to the selected
1459 one. An attempt to resize the root window of a frame will raise
1460 an error though.
1462 DELTA a positive number means WINDOW shall be enlarged by DELTA
1463 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1464 lines.
1466 Optional argument HORIZONTAL non-nil means resize WINDOW
1467 horizontally by DELTA columns. In this case a positive DELTA
1468 means enlarge WINDOW by DELTA columns. DELTA negative means
1469 WINDOW shall be shrunk by -DELTA columns.
1471 Optional argument IGNORE non-nil means ignore restrictions
1472 imposed by fixed size windows, `window-min-height' or
1473 `window-min-width' settings. If IGNORE is a window, ignore
1474 restrictions for that window only. If IGNORE equals `safe',
1475 live windows may get as small as `window-safe-min-height' lines
1476 and `window-safe-min-width' columns. Any other non-nil value
1477 means ignore all of the above restrictions for all windows.
1479 This function resizes other windows proportionally and never
1480 deletes any windows. If you want to move only the low (right)
1481 edge of WINDOW consider using `adjust-window-trailing-edge'
1482 instead."
1486 sibling)
1499 ;; If WINDOW is full height and either `resize-mini-windows' is
1500 ;; nil or the minibuffer window is active, resize the minibuffer
1501 ;; window.
1510 ;; If window-combination-resize is nil, WINDOW is part of an
1511 ;; iso-combination, and WINDOW's neighboring right or left
1512 ;; sibling can be resized as requested, resize that sibling.
1519 normal-delta))
1522 normal-delta)))
1523 ;; Otherwise, resize all other windows in the same combination.
1530 "Return non-nil if WINDOW shall be skipped by resizing routines."
1533 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1534 "Recursively set new normal height of child windows of window PARENT.
1535 HORIZONTAL non-nil means set the new normal width of these
1536 windows. WINDOW specifies a child window of PARENT that has been
1537 resized by THIS-DELTA lines (columns).
1539 Optional argument TRAIL either `before' or `after' means set values
1540 only for windows before or after WINDOW. Optional argument
1541 OTHER-DELTA, a number, specifies that this many lines (columns)
1542 have been obtained from (or returned to) an ancestor window of
1543 PARENT in order to resize WINDOW."
1547 ;; When WINDOW gets deleted and we can return its entire
1548 ;; space to its siblings, use WINDOW's normal size as the
1549 ;; normal delta.
1551 ;; In any other case calculate the normal delta from the
1552 ;; relation of THIS-DELTA to the total size of PARENT.
1558 ;; Set parent-normal to the sum of the normal sizes of all child
1559 ;; windows of PARENT that shall be resized, excluding only WINDOW
1560 ;; and any windows specified by the optional TRAIL argument.
1571 ;; Set the new normal size of all child windows of PARENT from what
1572 ;; they should have contributed for recovering THIS-DELTA lines
1573 ;; (columns).
1587 delta-normal))
1588 ;; Don't drop below 0.
1593 ;; Set the new normal size of windows from what they should have
1594 ;; contributed for recovering OTHER-DELTA lines (columns).
1597 other-delta)))
1609 ;; Don't drop below 0.
1613 ;; Set the new normal size of WINDOW to what is left by the sum of
1614 ;; the normal sizes of its siblings.
1616 window
1627 ;; Don't get larger than 1 or smaller than 0.
1630 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1631 "Resize child windows of window PARENT vertically by DELTA lines.
1632 PARENT must be a vertically combined internal window.
1634 Optional argument HORIZONTAL non-nil means resize child windows of
1635 PARENT horizontally by DELTA columns. In this case PARENT must
1636 be a horizontally combined internal window.
1638 WINDOW, if specified, must denote a child window of PARENT that
1639 is resized by DELTA lines.
1641 Optional argument IGNORE non-nil means ignore restrictions
1642 imposed by fixed size windows, `window-min-height' or
1643 `window-min-width' settings. If IGNORE equals `safe', live
1644 windows may get as small as `window-safe-min-height' lines and
1645 `window-safe-min-width' columns. If IGNORE is a window, ignore
1646 restrictions for that window only. Any other non-nil value means
1647 ignore all of the above restrictions for all windows.
1649 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1650 of windows that shall be resized. If TRAIL equals `before',
1651 resize only windows on the left or above EDGE. If TRAIL equals
1652 `after', resize only windows on the right or below EDGE. Also,
1653 preferably only resize windows adjacent to EDGE.
1655 Return the symbol `normalized' if new normal sizes have been
1656 already set by this routine."
1660 best-window best-value)
1672 sub)
1677 edge)
1682 edge)
1685 ;; Resize only windows adjacent to EDGE.
1688 sub delta horizontal ignore t trail edge)
1691 ;; Assign new normal sizes.
1700 ;; Return 'normalized to notify `window--resize-siblings' that
1701 ;; normal sizes have been already set.
1703 ;; Resize all windows proportionally.
1708 ;; Ignore windows to skip and fixed-size child windows -
1709 ;; in the latter case make it a window to skip.
1714 ;; When shrinking store the number of lines/cols we can get
1715 ;; from this window here together with the total/normal size
1716 ;; factor.
1718 sub
1720 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1723 parent-total)
1726 ;; When enlarging store the total/normal size factor only
1728 sub
1730 parent-total)
1737 ;; Shrink windows by delta.
1756 best-window
1761 parent-total)
1764 ;; Enlarge windows by delta.
1782 best-window
1784 parent-total)
1792 ;; Reset new normal size fields so `window-resize-apply'
1793 ;; won't use them to apply new sizes.
1797 ;; Resize this window's child windows (back-engineering
1798 ;; delta from sub's old and new total sizes).
1802 ;; For the TRAIL non-nil case we have to resize SUB
1803 ;; recursively even if it's size does not change.
1805 sub delta horizontal ignore nil trail edge))))
1809 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1810 Optional argument HORIZONTAL non-nil means resize other windows
1811 when WINDOW is resized horizontally by DELTA columns. WINDOW
1812 itself is not resized by this function.
1814 Optional argument IGNORE non-nil means ignore restrictions
1815 imposed by fixed size windows, `window-min-height' or
1816 `window-min-width' settings. If IGNORE equals `safe', live
1817 windows may get as small as `window-safe-min-height' lines and
1818 `window-safe-min-width' columns. If IGNORE is a window, ignore
1819 restrictions for that window only. Any other non-nil value means
1820 ignore all of the above restrictions for all windows.
1822 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1823 of windows that shall be resized. If TRAIL equals `before',
1824 resize only windows on the left or above EDGE. If TRAIL equals
1825 `after', resize only windows on the right or below EDGE. Also,
1826 preferably only resize windows adjacent to EDGE."
1831 ;; In an iso-combination try to extract DELTA from WINDOW's
1832 ;; siblings.
1834 this-delta other-delta)
1835 ;; Decide which windows shall be left alone.
1839 ;; Make sure WINDOW is left alone when
1840 ;; resizing its siblings.
1844 ;; Make sure this sibling is left alone when
1845 ;; resizing its siblings.
1849 ;; Set this-delta to t to signal that we found a sibling
1850 ;; of WINDOW whose size is not fixed.
1855 ;; Set this-delta to what we can get from WINDOW's siblings.
1857 ;; A deletion, presumably. We must handle this case
1858 ;; specially since `window--resizable' can't be used.
1860 ;; There's at least one resizable sibling we can
1861 ;; give WINDOW's size to.
1863 ;; No resizable sibling exists.
1865 ;; Any other form of resizing.
1869 ;; Set other-delta to what we still have to get from
1870 ;; ancestor windows of parent.
1873 ;; Unless we got everything from WINDOW's siblings, PARENT
1874 ;; must be resized by other-delta lines or columns.
1878 ;; We haven't got anything from WINDOW's siblings but we
1879 ;; must update the normal sizes to respect other-delta.
1881 parent horizontal window this-delta trail other-delta)
1882 ;; We did get something from WINDOW's siblings which means
1883 ;; we have to resize their child windows.
1886 window ignore trail edge)
1887 ;; If `window--resize-child-windows' returns
1888 ;; 'normalized, this means it has set the
1889 ;; normal sizes already.
1891 ;; Set the normal sizes.
1893 parent horizontal window this-delta trail other-delta))
1894 ;; Set DELTA to what we still have to get from ancestor
1895 ;; windows.
1898 ;; In an ortho-combination all siblings of WINDOW must be
1899 ;; resized by DELTA.
1907 ;; "Go up."
1909 parent delta horizontal ignore trail edge)))))
1912 "Resize WINDOW vertically by DELTA lines.
1913 Optional argument HORIZONTAL non-nil means resize WINDOW
1914 horizontally by DELTA columns.
1916 Optional argument IGNORE non-nil means ignore restrictions
1917 imposed by fixed size windows, `window-min-height' or
1918 `window-min-width' settings. If IGNORE equals `safe', live
1919 windows may get as small as `window-safe-min-height' lines and
1920 `window-safe-min-width' columns. If IGNORE is a window, ignore
1921 restrictions for that window only. Any other non-nil value
1922 means ignore all of the above restrictions for all windows.
1924 Optional argument ADD non-nil means add DELTA to the new total
1925 size of WINDOW.
1927 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1928 of windows that shall be resized. If TRAIL equals `before',
1929 resize only windows on the left or above EDGE. If TRAIL equals
1930 `after', resize only windows on the right or below EDGE. Also,
1931 preferably only resize windows adjacent to EDGE.
1933 This function recursively resizes WINDOW's child windows to fit the
1934 new size. Make sure that WINDOW is `window--resizable' before
1935 calling this function. Note that this function does not resize
1936 siblings of WINDOW or WINDOW's parent window. You have to
1937 eventually call `window-resize-apply' in order to make resizing
1938 actually take effect."
1940 ;; Add DELTA to the new total size of WINDOW.
1947 ;; In an iso-combination resize child windows according to their
1948 ;; normal sizes.
1950 window delta horizontal nil ignore trail edge))
1951 ;; In an ortho-combination resize each child window by DELTA.
1955 sub delta horizontal ignore t trail edge)
1959 "Resize root window WINDOW vertically by DELTA lines.
1960 HORIZONTAL non-nil means resize root window WINDOW horizontally
1961 by DELTA columns.
1963 IGNORE non-nil means ignore any restrictions imposed by fixed
1964 size windows, `window-min-height' or `window-min-width' settings.
1966 This function is only called by the frame resizing routines. It
1967 resizes windows proportionally and never deletes any windows."
1974 "Resize root window WINDOW vertically by DELTA lines.
1975 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1976 lines, shrink it as much as possible. If DELTA is greater than
1977 zero, this function can resize fixed-size windows in order to
1978 recover the necessary lines.
1980 Return the number of lines that were recovered.
1982 This function is only called by the minibuffer window resizing
1983 routines. It resizes windows proportionally and never deletes
1984 any windows."
1995 ;; Ideally, we would resize just the last window in a combination
1996 ;; but that's not feasible for the following reason: If we grow
1997 ;; the minibuffer window and the last window cannot be shrunk any
1998 ;; more, we shrink another window instead. But if we then shrink
1999 ;; the minibuffer window again, the last window might get enlarged
2000 ;; and the state after shrinking is not the state before growing.
2001 ;; So, in practice, we'd need a history variable to record how to
2002 ;; proceed. But I'm not sure how such a variable could work with
2003 ;; repeated minibuffer window growing steps.
2005 delta)))
2008 "Move WINDOW's bottom edge by DELTA lines.
2009 Optional argument HORIZONTAL non-nil means move WINDOW's right
2010 edge by DELTA columns. WINDOW defaults to the selected window.
2012 If DELTA is greater than zero, move the edge downwards or to the
2013 right. If DELTA is less than zero, move the edge upwards or to
2014 the left. If the edge can't be moved by DELTA lines or columns,
2015 move it as far as possible in the desired direction."
2020 left this-delta min-delta max-delta)
2021 ;; Find the edge we want to move.
2027 ;; Resize the minibuffer window if it's on the same frame as
2028 ;; and immediately below WINDOW and it's either active or
2029 ;; `resize-mini-windows' is nil.
2041 ;; Set LEFT to the first resizable window on the left. This step is
2042 ;; needed to handle fixed-size windows.
2055 ;; Set RIGHT to the first resizable window on the right. This step
2056 ;; is needed to handle fixed-size windows.
2069 ;; LEFT and RIGHT (which might be both internal windows) are now the
2070 ;; two windows we want to resize.
2076 ;; We can't get the whole DELTA - move as far as possible.
2079 ;; Start resizing.
2081 ;; Try to enlarge LEFT first.
2085 left this-delta horizontal nil t 'before
2089 ;; Shrink windows on right of LEFT.
2091 left delta horizontal nil 'after
2099 ;; We can't get the whole DELTA - move as far as possible.
2102 ;; Start resizing.
2104 ;; Try to enlarge RIGHT.
2108 right this-delta horizontal nil t 'after
2112 ;; Shrink windows on left of RIGHT.
2119 ;; Don't report an error in the standard case.
2121 ;; But do report an error if applying the changes fails.
2125 "Make the selected window DELTA lines taller.
2126 Interactively, if no argument is given, make the selected window
2127 one line taller. If optional argument HORIZONTAL is non-nil,
2128 make selected window wider by DELTA columns. If DELTA is
2129 negative, shrink selected window by -DELTA lines or columns.
2130 Return nil."
2145 ;; If the selected window is full height and `resize-mini-windows'
2146 ;; is nil, resize the minibuffer window.
2155 horizontal)))))
2158 "Make the selected window DELTA lines smaller.
2159 Interactively, if no argument is given, make the selected window
2160 one line smaller. If optional argument HORIZONTAL is non-nil,
2161 make selected window narrower by DELTA columns. If DELTA is
2162 negative, enlarge selected window by -DELTA lines or columns.
2163 Also see the `window-min-height' variable.
2164 Return nil."
2179 ;; If the selected window is full height and `resize-mini-windows'
2180 ;; is nil, resize the minibuffer window.
2189 horizontal)))))
2192 "Maximize WINDOW.
2193 Make WINDOW as large as possible without deleting any windows.
2194 WINDOW can be any window and defaults to the selected window."
2201 "Minimize WINDOW.
2202 Make WINDOW as small as possible without deleting any windows.
2203 WINDOW can be any window and defaults to the selected window."
2208 \f
2210 "Return non-nil if WINDOW is the root window of its frame."
2214 "Return window subtree rooted at WINDOW.
2215 Optional argument NEXT non-nil means include WINDOW's right
2216 siblings in the return value.
2218 See the documentation of `window-tree' for a description of the
2219 return value."
2232 list))
2237 "Return the window tree of frame FRAME.
2238 FRAME must be a live frame and defaults to the selected frame.
2239 The return value is a list of the form (ROOT MINI), where ROOT
2240 represents the window tree of the frame's root window, and MINI
2241 is the frame's minibuffer window.
2243 If the root window is not split, ROOT is the root window itself.
2244 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2245 for a horizontal split, and t for a vertical split. EDGES gives
2246 the combined size and position of the child windows in the split,
2247 and the rest of the elements are the child windows in the split.
2248 Each of the child windows may again be a window or a list
2249 representing a window split, and so on. EDGES is a list (LEFT
2250 TOP RIGHT BOTTOM) as returned by `window-edges'."
2253 \f
2255 "Select another window in cyclic ordering of windows.
2256 COUNT specifies the number of windows to skip, starting with the
2257 selected window, before making the selection. If COUNT is
2258 positive, skip COUNT windows forwards. If COUNT is negative,
2259 skip -COUNT windows backwards. COUNT zero means do not skip any
2260 window, so select the selected window. In an interactive call,
2261 COUNT is the numeric prefix argument. Return nil.
2263 If the `other-window' parameter of the selected window is a
2264 function and `ignore-window-parameters' is nil, call that
2265 function with the arguments COUNT and ALL-FRAMES.
2267 This function does not select a window whose `no-other-window'
2268 window parameter is non-nil.
2270 This function uses `next-window' for finding the window to
2271 select. The argument ALL-FRAMES has the same meaning as in
2272 `next-window', but the MINIBUF argument of `next-window' is
2273 always effectively nil."
2278 old-window old-count)
2281 ;; `next-window' and `previous-window' may return a window we are
2282 ;; not allowed to select. Hence we need an exit strategy in case
2283 ;; all windows are non-selectable.
2290 ;; Keep out of infinite loops. When COUNT has not changed
2291 ;; since we last looked at `window' we're probably in one.
2295 ;; The first non-selectable window `next-window' got us:
2296 ;; Remember it and the current value of COUNT.
2306 ;; Keep out of infinite loops. When COUNT has not changed
2307 ;; since we last looked at `window' we're probably in one.
2311 ;; The first non-selectable window `previous-window' got
2312 ;; us: Remember it and the current value of COUNT.
2319 ;; Always return nil.
2320 nil))))
2322 ;; This should probably return non-nil when the selected window is part
2323 ;; of an atomic window whose root is the frame's root window.
2325 "Return non-nil if the selected window is the only window.
2326 Optional arg NOMINI non-nil means don't count the minibuffer
2327 even if it is active. Otherwise, the minibuffer is counted
2328 when it is active.
2330 Optional argument ALL-FRAMES specifies the set of frames to
2331 consider, see also `next-window'. ALL-FRAMES nil or omitted
2332 means consider windows on the selected frame only, plus the
2333 minibuffer window if specified by the NOMINI argument. If the
2334 minibuffer counts, consider all windows on all frames that share
2335 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2336 with a special meaning are:
2338 - t means consider all windows on all existing frames.
2340 - `visible' means consider all windows on all visible frames on
2341 the current terminal.
2343 - 0 (the number zero) means consider all windows on all visible
2344 and iconified frames on the current terminal.
2346 - A frame means consider all windows on that frame only.
2348 Anything else means consider all windows on the selected frame
2349 and no others."
2355 \f
2356 ;;; Deleting windows.
2358 "Return t if WINDOW can be safely deleted from its frame.
2359 Return `frame' if deleting WINDOW should also delete its
2360 frame."
2364 ;; Handle atomicity.
2372 ;; WINDOW's frame can be deleted only if there are other frames
2373 ;; on the same terminal.
2379 ;; WINDOW can be deleted unless it is the main window of its
2380 ;; frame.
2381 t))))
2384 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2394 "Delete WINDOW.
2395 WINDOW can be an arbitrary window and defaults to the selected
2396 one. Return nil.
2398 If the variable `ignore-window-parameters' is non-nil or the
2399 `delete-window' parameter of WINDOW equals t, do not process any
2400 parameters of WINDOW. Otherwise, if the `delete-window'
2401 parameter of WINDOW specifies a function, call that function with
2402 WINDOW as its sole argument and return the value returned by that
2403 function.
2405 Otherwise, if WINDOW is part of an atomic window, call
2406 `delete-window' with the root of the atomic window as its
2407 argument. If WINDOW is the only window on its frame or the last
2408 non-side window, signal an error."
2414 atom-root)
2417 ;; Handle window parameters.
2419 ;; Ignore window parameters if `ignore-window-parameters' tells
2420 ;; us so or `delete-window' equals t.
2423 ;; The `delete-window' parameter specifies the function to call.
2424 ;; If that function is `ignore' nothing is done. It's up to the
2425 ;; function called here to avoid infinite recursion.
2442 ;; Emacs 23 preferably gives WINDOW's space to its left
2443 ;; sibling.
2449 ;; Resize WINDOW's sibling.
2455 ;; Can do without resizing fixed-size windows.
2458 ;; Can't do without resizing fixed-size windows.
2460 ;; Actually delete WINDOW.
2465 ;; `delete-window-internal' has selected a window that should
2466 ;; not be selected, fix this here.
2470 ;; Always return nil.
2471 nil))))
2474 "Make WINDOW fill its frame.
2475 WINDOW may be any window and defaults to the selected one.
2476 Return nil.
2478 If the variable `ignore-window-parameters' is non-nil or the
2479 `delete-other-windows' parameter of WINDOW equals t, do not
2480 process any parameters of WINDOW. Otherwise, if the
2481 `delete-other-windows' parameter of WINDOW specifies a function,
2482 call that function with WINDOW as its sole argument and return
2483 the value returned by that function.
2485 Otherwise, if WINDOW is part of an atomic window, call this
2486 function with the root of the atomic window as its argument. If
2487 WINDOW is a non-side window, make WINDOW the only non-side window
2488 on the frame. Side windows are not deleted. If WINDOW is a side
2489 window signal an error."
2495 atom-root side-main)
2499 ;; Ignore window parameters if `ignore-window-parameters' is t or
2500 ;; `delete-other-windows' is t.
2503 ;; The `delete-other-windows' parameter specifies the function
2504 ;; to call. If the function is `ignore' no windows are deleted.
2505 ;; It's up to the function called to avoid infinite recursion.
2512 ;; Set side-main to the major non-side window.
2516 ;; If WINDOW is the main non-side window, do nothing.
2521 ;; Always return nil.
2522 nil)))
2525 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2527 if you often split windows horizontally."
2539 ;;; Windows and buffers.
2541 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2542 ;; for (1) determining which buffer to show in the window when its
2543 ;; buffer shall be buried or killed and (2) which buffer to show for
2544 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2546 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2547 ;; triples. The entries on this list are ordered by the time their
2548 ;; buffer has been removed from the window, the most recently removed
2549 ;; buffer's entry being first. The window-start and window-point
2550 ;; components are `window-start' and `window-point' at the time the
2551 ;; buffer was removed from the window which implies that the entry must
2552 ;; be added when `set-window-buffer' removes the buffer from the window.
2554 ;; `next-buffers' is the list of buffers that have been replaced
2555 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2556 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2557 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2558 ;; reset to nil by any action changing the window's buffer with the
2559 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2560 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2561 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2563 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2564 ;; if such a buffer was killed while the window was hidden within a
2565 ;; window configuration. Such killed buffers get removed whenever
2566 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2568 ;; The following function is called by `set-window-buffer' _before_ it
2569 ;; replaces the buffer of the argument window with the new buffer.
2571 "Record WINDOW's buffer.
2572 WINDOW must be a live window and defaults to the selected one."
2576 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2577 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2581 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2585 ;; Don't record insignificant buffers.
2587 ;; Add an entry for buffer to WINDOW's previous buffers.
2594 ;; We have an entry, update marker positions.
2597 ;; Make new markers.
2605 "Unrecord BUFFER in WINDOW.
2606 WINDOW must be a live window and defaults to the selected one.
2607 BUFFER must be a live buffer and defaults to the buffer of
2608 WINDOW."
2617 "Set WINDOW's buffer to BUFFER.
2618 Optional argument START non-nil means set WINDOW's start position
2619 to START. Optional argument POINT non-nil means set WINDOW's
2620 point to POINT. If WINDOW is selected this also sets BUFFER's
2621 `point' to POINT. If WINDOW is selected and the buffer it showed
2622 before was current this also makes BUFFER the current buffer."
2629 ;; Don't force window-start here (even if POINT is nil).
2635 "If non-nil, allow switching to an already visible buffer.
2636 If this variable is non-nil, `switch-to-prev-buffer' and
2637 `switch-to-next-buffer' may switch to an already visible buffer
2638 provided the buffer was shown in the argument window before. If
2639 this variable is nil, `switch-to-prev-buffer' and
2640 `switch-to-next-buffer' always try to avoid switching to a buffer
2641 that is already visible in another window on the same frame."
2647 "In WINDOW switch to previous buffer.
2648 WINDOW must be a live window and defaults to the selected one.
2650 Optional argument BURY-OR-KILL non-nil means the buffer currently
2651 shown in WINDOW is about to be buried or killed and consequently
2652 shall not be switched to in future invocations of this command."
2657 ;; Save this since it's destroyed by `set-window-buffer'.
2659 entry new-buffer killed-buffers visible)
2664 ;; Scan WINDOW's previous buffers first, skipping entries of next
2665 ;; buffers.
2676 ;; Try to avoid showing a buffer visible in some other window.
2681 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2682 ;; entries of next buffers. Note that when we bury or kill a
2683 ;; buffer we don't reverse the global buffer list to avoid showing
2684 ;; a buried buffer instead. Otherwise, we must reverse the global
2685 ;; buffer list in order to make sure that switching to the
2686 ;; previous/next buffer traverse it in opposite directions.
2695 ;; Try to avoid showing a buffer visible in some other window.
2702 ;; Scan reverted next buffers last (must not use nreverse
2703 ;; here!).
2705 ;; Actually, buffer _must_ be live here since otherwise it
2706 ;; would have been caught in the scan of previous buffers.
2717 ;; Show a buffer visible in another window.
2723 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2724 ;; of) next buffers.
2729 ;; Move `old-buffer' to head of WINDOW's restored list of next
2730 ;; buffers.
2734 ;; Remove killed buffers from WINDOW's previous and next buffers.
2742 ;; Return new-buffer.
2743 new-buffer))
2746 "In WINDOW switch to next buffer.
2747 WINDOW must be a live window and defaults to the selected one."
2753 new-buffer entry killed-buffers visible)
2758 ;; Scan WINDOW's next buffers first.
2769 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2770 ;; buffers entries.
2776 ;; Try to avoid showing a buffer visible in some other window.
2781 ;; Scan WINDOW's reverted previous buffers last (must not use
2782 ;; nreverse here!)
2791 ;; Try to avoid showing a buffer visible in some other window.
2798 ;; Show a buffer visible in another window.
2803 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2806 ;; Remove killed buffers from WINDOW's previous and next buffers.
2814 ;; Return new-buffer.
2815 new-buffer))
2818 "Search LIST for a valid buffer to display in FRAME.
2819 Return nil when all buffers in LIST are undesirable for display,
2820 otherwise return the first suitable buffer in LIST.
2822 Buffers not visible in windows are preferred to visible buffers,
2823 unless VISIBLE-OK is non-nil.
2824 If the optional argument FRAME is nil, it defaults to the selected frame.
2825 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2826 ;; This logic is more or less copied from other-buffer.
2829 found buf)
2842 "Return the last buffer in FRAME's buffer list.
2843 If BUFFER is the last buffer, return the preceding buffer
2844 instead. Buffers not visible in windows are preferred to visible
2845 buffers, unless optional argument VISIBLE-OK is non-nil.
2846 Optional third argument FRAME nil or omitted means use the
2847 selected frame's buffer list. If no such buffer exists, return
2848 the buffer `*scratch*', creating it if necessary."
2851 buffer visible-ok frame)
2855 scratch)))
2858 "Function called to automatically hide frames.
2859 The function is called with one argument - a frame.
2861 Functions affected by this option are those that bury a buffer
2862 shown in a separate frame like `quit-window' and `bury-buffer'."
2866 function)
2872 "Delete WINDOW if possible.
2873 WINDOW must be a live window and defaults to the selected one.
2874 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2875 only if it's dedicated to its buffer. Optional argument KILL
2876 means the buffer shown in window will be killed. Return non-nil
2877 if WINDOW gets deleted or its frame is auto-hidden."
2892 t)))))
2895 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2896 There it is the least likely candidate for `other-buffer' to
2898 select by default.
2900 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2901 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2902 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2903 remove the current buffer from the selected window if it is
2904 displayed there."
2907 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2908 ;; although it's not "here" (call it a feature).
2910 ;; Handle case where `buffer-or-name' is nil and the current buffer
2911 ;; is shown in the selected window.
2916 ;; Switch to another buffer in window.
2920 ;; Always return nil.
2921 nil))
2924 "Switch to the last buffer in the buffer list."
2929 "In selected window switch to next buffer."
2936 "In selected window switch to previous buffer."
2943 "Delete all windows showing BUFFER-OR-NAME.
2944 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2945 and defaults to the current buffer.
2947 The following non-nil values of the optional argument FRAME
2948 have special meanings:
2950 - t means consider all windows on the selected frame only.
2952 - `visible' means consider all windows on all visible frames on
2953 the current terminal.
2955 - 0 (the number zero) means consider all windows on all visible
2956 and iconified frames on the current terminal.
2958 - A frame means consider all windows on that frame only.
2960 Any other value of FRAME means consider all windows on all
2961 frames.
2963 When a window showing BUFFER-OR-NAME is dedicated and the only
2964 window of its frame, that frame is deleted when there are other
2965 frames left."
2968 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2969 ;; `window-list-1' based function.
2976 ;; Delete frame if and only if window is dedicated.
2979 ;; Delete window.
2982 ;; In window switch to previous buffer.
2985 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2989 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2990 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2991 and defaults to the current buffer.
2993 When a window showing BUFFER-OR-NAME is dedicated, that window is
2994 deleted. If that window is the only window on its frame, the
2995 frame is deleted too when there are other frames left. If there
2996 are no other frames left, some other buffer is displayed in that
2997 window.
2999 This function removes the buffer denoted by BUFFER-OR-NAME from
3000 all window-local buffer lists."
3006 ;; Switch to another buffer in window.
3009 ;; Unrecord BUFFER in WINDOW.
3013 "Quit WINDOW and bury its buffer.
3014 WINDOW must be a live window and defaults to the selected one.
3015 With prefix argument KILL non-nil, kill the buffer instead of
3016 burying it.
3018 According to information stored in WINDOW's `quit-restore' window
3019 parameter either (1) delete WINDOW and its frame, (2) delete
3020 WINDOW, (3) restore the buffer previously displayed in WINDOW,
3021 or (4) make WINDOW display some other buffer than the present
3022 one. If non-nil, reset `quit-restore' parameter to nil."
3033 buffer))))
3034 prev-buffer)))
3035 quad resize)
3040 ;; Delete WINDOW if possible.
3042 ;; If the previously selected window is still alive, select it.
3048 ;; Show another buffer stored in quit-restore parameter.
3054 ;; Try to resize WINDOW to its old height but don't signal an
3055 ;; error.
3059 ;; Restore WINDOW's previous buffer, start and point position.
3062 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
3063 ;; re-recorded by `set-window-buffer'.
3065 ;; Reset the quit-restore parameter.
3067 ;; Select old window.
3071 ;; Show some other buffer in WINDOW and reset the quit-restore
3072 ;; parameter.
3074 ;; Make sure that WINDOW is no more dedicated.
3078 ;; Kill WINDOW's old-buffer if requested
3084 "Quit all windows showing BUFFER-OR-NAME.
3085 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3086 and defaults to the current buffer. Optional argument KILL
3087 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3088 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3089 `delete-windows-on'.
3091 This function calls `quit-window' on all candidate windows
3092 showing BUFFER-OR-NAME."
3095 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3096 ;; `window-list-1' based function.
3101 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3103 \f
3104 ;;; Splitting windows.
3106 "Return minimum height of any window when splitting windows.
3107 Optional argument HORIZONTAL non-nil means return minimum width."
3113 "Make a new window adjacent to WINDOW.
3114 WINDOW can be any window and defaults to the selected one.
3115 Return the new window which is always a live window.
3117 Optional argument SIZE a positive number means make WINDOW SIZE
3118 lines or columns tall. If SIZE is negative, make the new window
3119 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3120 absolute value can be less than `window-min-height' or
3121 `window-min-width'; so this command can make a new window as
3122 small as one line or two columns. SIZE defaults to half of
3123 WINDOW's size. Interactively, SIZE is the prefix argument.
3125 Optional third argument SIDE nil (or `below') specifies that the
3126 new window shall be located below WINDOW. SIDE `above' means the
3127 new window shall be located above WINDOW. In both cases SIZE
3128 specifies the new number of lines for WINDOW (or the new window
3129 if SIZE is negative) including space reserved for the mode and/or
3130 header line.
3132 SIDE t (or `right') specifies that the new window shall be
3133 located on the right side of WINDOW. SIDE `left' means the new
3134 window shall be located on the left of WINDOW. In both cases
3135 SIZE specifies the new number of columns for WINDOW (or the new
3136 window provided SIZE is negative) including space reserved for
3137 fringes and the scrollbar or a divider column. Any other non-nil
3138 value for SIDE is currently handled like t (or `right').
3140 If the variable `ignore-window-parameters' is non-nil or the
3141 `split-window' parameter of WINDOW equals t, do not process any
3142 parameters of WINDOW. Otherwise, if the `split-window' parameter
3143 of WINDOW specifies a function, call that function with all three
3144 arguments and return the value returned by that function.
3147 root of that atomic window. The new window does not become a
3148 member of that atomic window.
3150 If WINDOW is live, properties of the new window like margins and
3151 scrollbars are inherited from WINDOW. If WINDOW is an internal
3152 window, these properties as well as the buffer displayed in the
3153 new window are inherited from the window selected on WINDOW's
3154 frame. The selected window is not changed by this function."
3166 ;; Rebind `window-combination-limit' since in some cases we may
3167 ;; have to override its value.
3169 atom-root)
3174 ;; Ignore window parameters if either `ignore-window-parameters'
3175 ;; is t or the `split-window' parameter equals t.
3178 ;; The `split-window' parameter specifies the function to call.
3179 ;; If that function is `ignore', do nothing.
3181 ;; If WINDOW is part of an atomic window, split the root window
3182 ;; of that atomic window instead.
3191 ;; WINDOW is a side root window. To make sure that a new parent
3192 ;; window gets created set `window-combination-limit' to t.
3196 ;; If `window-combination-resize' is non-nil and SIZE is a
3197 ;; non-negative integer, we cannot reasonably resize other
3198 ;; windows. Rather bind `window-combination-limit' to t to make
3199 ;; sure that subsequent window deletions are handled correctly.
3203 ;; `parent-size' is the size of WINDOW's parent, provided
3204 ;; it has one.
3206 ;; `resize' non-nil means we are supposed to resize other
3207 ;; windows in WINDOW's combination.
3210 ;; Resize makes sense in iso-combinations only.
3212 ;; `old-size' is the current size of WINDOW.
3214 ;; `new-size' is the specified or calculated size of the
3215 ;; new window.
3221 ;; When resizing try to give the new window the
3222 ;; average size of a window in its combination.
3225 (/ parent-size
3227 parent horizontal))))
3228 ;; Else try to give the new window half the size
3229 ;; of WINDOW (plus an eventual odd line).
3232 ;; SIZE non-negative specifies the new size of WINDOW.
3234 ;; Note: Specifying a non-negative SIZE is practically
3235 ;; always done as workaround for making the new window
3236 ;; appear above or on the left of the new window (the
3237 ;; ispell window is a typical example of that). In all
3238 ;; these cases the SIDE argument should be set to 'above
3239 ;; or 'left in order to support the 'resize option.
3240 ;; Here we have to nest the windows instead, see above.
3243 ;; SIZE negative specifies the size of the new window.
3245 new-parent new-normal)
3247 ;; Check SIZE.
3252 ;; SIZE unspecified, resizing.
3254 ;; Try again with minimum split size.
3260 ;; SIZE unspecified, no resizing.
3265 window-safe-min-width
3266 window-safe-min-width))))
3267 ;; SIZE specified as new size of old window. If the new size
3268 ;; is larger than the old size or the size of the new window
3269 ;; would be less than the safe minimum, signal an error.
3272 ;; SIZE specified, resizing.
3274 ;; If we cannot resize the parent give up.
3280 ;; SIZE specification violates minimum size restrictions.
3286 ;; Make new-parent non-nil if we need a new parent window;
3287 ;; either because we want to nest or because WINDOW is not
3288 ;; iso-combined.
3292 ;; Make new-normal the normal size of the new window.
3300 ;; Try to get space from OLD's siblings. We could go "up" and
3301 ;; try getting additional space from surrounding windows but
3302 ;; we won't be able to return space to those windows when we
3303 ;; delete the one we create here. Hence we do not go up.
3312 ;; Get entire space from WINDOW.
3317 new-normal)))
3320 ;; Inherit window-side parameters, if any.
3327 ;; Always return the new window.
3328 new)))))
3330 ;; I think this should be the default; I think people will prefer it--rms.
3333 If nil, adjust point in the two windows to minimize redisplay.
3334 This option applies only to `split-window-below' and functions
3335 that call it. The low-level `split-window' function always keeps
3336 the original point in both windows."
3341 "Split the selected window into two windows, one above the other.
3342 The selected window is above. The newly split-off window is
3343 below, and displays the same buffer. Return the new window.
3345 If optional argument SIZE is omitted or nil, both windows get the
3346 same height, or close to it. If SIZE is positive, the upper
3347 \(selected) window gets SIZE lines. If SIZE is negative, the
3348 lower (new) window gets -SIZE lines.
3350 If the variable `split-window-keep-point' is non-nil, both
3351 windows get the same value of point as the selected window.
3352 Otherwise, the window starts are chosen so as to minimize the
3353 amount of redisplay; this is convenient on slow terminals."
3358 moved-by-window-height moved new-window bottom)
3360 ;; `split-window' would not signal an error here.
3365 ;; Use `save-excursion' around vertical movements below
3366 ;; (Bug#10971). Note: When the selected window's buffer has a
3367 ;; header line, up to two lines of the buffer may not show up
3368 ;; in the resulting configuration.
3386 ;; Always copy quit-restore parameter in interactive use.
3390 new-window))
3395 "Split the selected window into two side-by-side windows.
3396 The selected window is on the left. The newly split-off window
3397 is on the right, and displays the same buffer. Return the new
3398 window.
3400 If optional argument SIZE is omitted or nil, both windows get the
3401 same width, or close to it. If SIZE is positive, the left-hand
3402 \(selected) window gets SIZE columns. If SIZE is negative, the
3403 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3404 the width of the window's scroll bar; if there are no scroll
3405 bars, it includes the width of the divider column to the window's
3406 right, if any."
3410 new-window)
3412 ;; `split-window' would not signal an error here.
3415 ;; Always copy quit-restore parameter in interactive use.
3419 new-window))
3422 \f
3423 ;;; Balancing windows.
3425 ;; The following routine uses the recycled code from an old version of
3426 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3427 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3428 ;; more readable (FWIW we'd need three loops - one to calculate the
3429 ;; minimum sizes per window, one to enlarge or shrink windows until the
3430 ;; new parent-size matches, and one where we shrink the largest/enlarge
3431 ;; the smallest window).
3433 "Subroutine of `balance-windows-1'.
3434 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3435 is non-nil."
3441 failed size sub-total sub-delta sub-amount rest)
3456 ;; Ignore child windows that should be ignored or are stuck.
3462 ;; Register the new total size for this child window.
3467 ;; We failed and need a new round.
3473 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3474 ;; (column) until `rest' is zero.
3482 ;; Fix rounding by trying to enlarge stuck windows by one line
3483 ;; (column) until `rest' equals zero.
3493 ;; Record new normal sizes.
3499 ;; Recursively balance each window's child windows.
3504 "Subroutine of `balance-windows'."
3516 "Balance the sizes of windows of WINDOW-OR-FRAME.
3517 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3518 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3519 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3520 recursively balance the sizes of all child windows of that
3521 window."
3530 window-or-frame)
3534 ;; Balance vertically.
3538 ;; Balance horizontally.
3544 "Return t if WINDOW cannot be resized in DIRECTION.
3545 WINDOW defaults to the selected window. DIRECTION can be
3546 nil (i.e. any), `height' or `width'."
3553 ;;; A different solution to balance-windows.
3555 "Factor by which the window area should be over-estimated.
3556 This is used by `balance-windows-area'.
3561 "Wrapper around `window-resize' with error checking.
3562 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3563 ;; `window-resize' may fail if delta is too large.
3570 ;;(message "adjust: %s" (error-message-string err))
3574 "Make all visible windows the same area (approximately).
3575 See also `window-area-factor' to change the relative size of
3576 specific buffers."
3579 ;; Remove fixed-size windows.
3584 next)
3585 ;; Resizing a window changes the size of surrounding windows in complex
3586 ;; ways, so it's difficult to balance them all. The introduction of
3587 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3588 ;; very difficult to do. `balance-window' above takes an off-line
3589 ;; approach: get the whole window tree, then balance it, then try to
3590 ;; adjust the windows so they fit the result.
3591 ;; Here, instead, we take a "local optimization" approach, where we just
3592 ;; go through all the windows several times until nothing needs to be
3593 ;; changed. The main problem with this approach is that it's difficult
3594 ;; to make sure it terminates, so we use some heuristic to try and break
3595 ;; off infinite loops.
3596 ;; After a round without any change, we allow a second, to give a chance
3597 ;; to the carry to propagate a minor imbalance from the end back to
3598 ;; the beginning.
3600 ;; (message "New round")
3606 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3624 ;; Maybe diff is actually closer to 1 than to 0.
3628 ;; Change things smoothly.
3631 ;; Make sure negligible differences don't accumulate to
3632 ;; become significant.
3634 ;; This used `adjust-window-trailing-edge' before and uses
3635 ;; `window-resize' now. Error wrapping is still needed.
3637 ;; (sit-for 0.5)
3639 ;; If the same change has been seen already for this window,
3640 ;; we're most likely in an endless loop, so don't count it as
3641 ;; a change.
3645 ;; We've now basically balanced all the windows.
3646 ;; But there may be some minor off-by-one imbalance left over,
3647 ;; so let's do some fine tuning.
3648 ;; (bw-finetune wins)
3649 ;; (message "Done in %d rounds" round)
3650 ))
3652 ;;; Window states, how to get them and how to put them in a window.
3654 "Helper function for `window-state-get'."
3663 `(,type
3671 list)
3672 ;; Make copies of those window parameters whose
3673 ;; persistence property is `writable' if WRITABLE is
3674 ;; non-nil and non-nil if WRITABLE is nil.
3677 window-persistent-parameters))))
3680 ;; Add `clone-of' parameter if necessary.
3682 window-persistent-parameters))))
3689 ;; All buffer related things go in here.
3714 "Return state of WINDOW as a Lisp object.
3715 WINDOW can be any window and defaults to the root window of the
3716 selected frame.
3718 Optional argument WRITABLE non-nil means do not use markers for
3719 sampling `window-point' and `window-start'. Together, WRITABLE
3720 and the variable `window-persistent-parameters' specify which
3721 window parameters are saved by this function. WRITABLE should be
3722 non-nil when the return value shall be written to a file and read
3723 back in another session. Otherwise, an application may run into
3724 an `invalid-read-syntax' error while attempting to read back the
3725 value from file.
3727 The return value can be used as argument for `window-state-put'
3728 to put the state recorded here into an arbitrary window. The
3729 value can be also stored on disk and read back in a new session."
3733 window
3736 ;; The return value is a cons whose car specifies some constraints on
3737 ;; the size of WINDOW. The cdr lists the states of the child windows
3738 ;; of WINDOW.
3740 ;; Frame related things would go into a function, say `frame-state',
3741 ;; calling `window-state-get' to insert the frame's root window.
3754 "Helper function for `window-state-put'."
3759 ;; For a leaf window just add unprocessed entries to
3760 ;; `window-state-put-list'.
3766 size new)
3768 ;; Find the next child window. WINDOW always points to the
3769 ;; real window that we want to fill with what we find here.
3772 ;; The last child window. Below `window--state-put-1'
3773 ;; will put into it whatever ITEM has in store.
3775 ;; Not the last child window, prepare for splitting
3776 ;; WINDOW. SIZE is the new (and final) size of the old
3777 ;; window.
3780 ;; Use total size.
3782 ;; Use normalized size and round.
3786 item))))))
3788 ;; Use safe sizes, we try to resize later.
3790 window-safe-min-height
3791 window-safe-min-width)))
3796 ;; We must inherit the combination limit, otherwise
3797 ;; we might mess up handling of atomic and side
3798 ;; window.
3800 ;; Give up if we can't resize window down to safe sizes.
3805 ;; When creating the first child window add for parent
3806 ;; unprocessed entries to `window-state-put-list'.
3809 window-state-put-list))))
3811 ;; Now process the current window (either the one we've just
3812 ;; split or the last child of its parent).
3814 ;; Continue with the last window split off.
3818 "Helper function for `window-state-put'."
3826 ;; Reset window's parameters and assign saved ones (we might want
3827 ;; a `remove-window-parameters' function here).
3833 ;; Process buffer related state.
3835 ;; We don't want to raise an error here so we create a buffer if
3836 ;; there's none.
3848 ;; Adjust vertically.
3850 ;; A fixed height window, try to restore the original size.
3853 window-size-fixed)
3856 ;; Else check whether the window is not high enough.
3862 ;; Adjust horizontally.
3864 ;; A fixed width window, try to restore the original size.
3867 window-size-fixed)
3870 ;; Else check whether the window is not wide enough.
3876 ;; Set dedicated status.
3878 ;; Install positions (maybe we should do this after all windows
3879 ;; have been created and sized).
3883 ;; Select window if it's the selected one.
3888 "Put window state STATE into WINDOW.
3889 STATE should be the state of a window returned by an earlier
3890 invocation of `window-state-get'. Optional argument WINDOW must
3891 specify a live window and defaults to the selected one.
3893 Optional argument IGNORE non-nil means ignore minimum window
3894 sizes and fixed size restrictions. IGNORE equal `safe' means
3895 windows can get as small as `window-safe-min-height' and
3896 `window-safe-min-width'."
3900 ;; We check here (1) whether the total sizes of root window of
3901 ;; STATE and that of WINDOW are equal so we can avoid
3902 ;; calculating new sizes, and (2) if we do have to resize
3903 ;; whether we can do so without violating size restrictions.
3928 (> min-width
3930 ;; The check above might not catch all errors due to rounding
3931 ;; issues - so IGNORE equal 'safe might not always produce the
3932 ;; minimum possible state. But such configurations hardly make
3933 ;; sense anyway.
3937 ;; Work on the windows of a temporary buffer to make sure that
3938 ;; splitting proceeds regardless of any buffer local values of
3939 ;; `window-size-fixed'. Release that buffer after the buffers of
3940 ;; all live windows have been set by `window--state-put-2'.
3946 \f
3948 "Record information for window used by `display-buffer'.
3949 TYPE specifies the type of the calling operation and must be one
3950 of the symbols 'reuse (when WINDOW existed already and was
3951 reused for displaying BUFFER), 'window (when WINDOW was created
3952 on an already existing frame), or 'frame (when WINDOW was
3953 created on a new frame). WINDOW is the window used for or created
3954 by the `display-buffer' routines. BUFFER is the buffer that
3955 shall be displayed.
3957 This function installs or updates the quit-restore parameter of
3958 WINDOW. The quit-restore parameter is a list of four elements:
3959 The first element is one of the symbols 'window, 'frame, 'same or
3960 'other. The second element is either one of the symbols 'window
3961 or 'frame or a list whose elements are the buffer previously
3962 shown in the window, that buffer's window start and window point,
3963 and the window's height. The third element is the window
3964 selected at the time the parameter was created. The fourth
3965 element is BUFFER."
3969 ;; WINDOW shows BUFFER already.
3971 ;; If WINDOW has a quit-restore parameter, reset its car.
3973 ;; WINDOW shows another buffer.
3975 window 'quit-restore
3977 ;; A quadruple of WINDOW's buffer, start, point and height.
3982 ;; WINDOW has been created on an existing frame.
3984 window 'quit-restore
3987 ;; WINDOW has been created on a new frame.
3989 window 'quit-restore
3993 "If non-nil, function to call to handle `display-buffer'.
3994 It will receive two args, the buffer and a flag which if non-nil
3995 means that the currently selected window is not acceptable. It
3996 should choose or create a window, display the specified buffer in
3997 it, and return the window.
3999 The specified function should call `display-buffer-record-window'
4000 with corresponding arguments to set up the quit-restore parameter
4001 of the window used."
4008 "Alist of parameters for automatically generated new frames.
4009 You can set this in your init file; for example,
4011 (setq pop-up-frame-alist '((width . 80) (height . 20)))
4013 If non-nil, the value you specify here is used by the default
4014 `pop-up-frame-function' for the creation of new frames.
4016 Since `pop-up-frame-function' is used by `display-buffer' for
4017 making new frames, any value specified here by default affects
4018 the automatic generation of new frames via `display-buffer' and
4019 all functions based on it. The behavior of `make-frame' is not
4020 affected by this variable."
4028 "Function used by `display-buffer' for creating a new frame.
4029 This function is called with no arguments and should return a new
4030 frame. The default value calls `make-frame' with the argument
4031 `pop-up-frame-alist'."
4036 "List of names of buffers that should be displayed specially.
4037 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4038 its name is in this list, displays the buffer in a way specified
4039 by `special-display-function'. `special-display-popup-frame'
4040 \(the default for `special-display-function') usually displays
4041 the buffer in a separate frame made with the parameters specified
4042 by `special-display-frame-alist'. If `special-display-function'
4043 has been set to some other function, that function is called with
4044 the buffer as first, and nil as second argument.
4046 Alternatively, an element of this list can be specified as
4047 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
4048 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4049 `special-display-popup-frame' will interpret such pairs as frame
4050 parameters when it creates a special frame, overriding the
4051 corresponding values from `special-display-frame-alist'.
4053 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4054 `special-display-popup-frame' displays that buffer in the
4055 selected window. If FRAME-PARAMETERS contains (same-frame . t),
4056 it displays that buffer in a window on the selected frame.
4058 If `special-display-function' specifies some other function than
4059 `special-display-popup-frame', that function is called with the
4060 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4061 argument.
4063 Finally, an element of this list can be also specified as
4064 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4065 `special-display-popup-frame' will call FUNCTION with the buffer
4066 named BUFFER-NAME as first argument, and OTHER-ARGS as the
4067 second.
4069 Any alternative function specified here is responsible for
4070 setting up the quit-restore parameter of the window used.
4073 name to it but the corresponding buffer is displayed in the
4074 selected window, look at the values of `same-window-buffer-names'
4075 and `same-window-regexps'. Those variables take precedence over
4076 this one.
4078 See also `special-display-regexps'."
4100 ;;;###autoload
4104 "List of regexps saying which buffers should be displayed specially.
4105 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4106 any regexp in this list matches its name, displays it specially
4107 using `special-display-function'. `special-display-popup-frame'
4108 \(the default for `special-display-function') usually displays
4109 the buffer in a separate frame made with the parameters specified
4110 by `special-display-frame-alist'. If `special-display-function'
4111 has been set to some other function, that function is called with
4112 the buffer as first, and nil as second argument.
4114 Alternatively, an element of this list can be specified as
4115 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4116 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4117 `special-display-popup-frame' will then interpret these pairs as
4118 frame parameters when creating a special frame for a buffer whose
4119 name matches REGEXP, overriding the corresponding values from
4120 `special-display-frame-alist'.
4122 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4123 `special-display-popup-frame' displays buffers matching REGEXP in
4124 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4125 to display such buffers in a window on the selected frame.
4127 If `special-display-function' specifies some other function than
4128 `special-display-popup-frame', that function is called with the
4129 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4130 as second argument.
4132 Finally, an element of this list can be also specified as
4133 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4134 will then call FUNCTION with the buffer whose name matched
4135 REGEXP as first, and OTHER-ARGS as second argument.
4137 Any alternative function specified here is responsible for
4138 setting up the quit-restore parameter of the window used.
4141 name to it but the corresponding buffer is displayed in the
4142 selected window, look at the values of `same-window-buffer-names'
4143 and `same-window-regexps'. Those variables take precedence over
4144 this one.
4146 See also `special-display-buffer-names'."
4169 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4170 More precisely, return t if `special-display-buffer-names' or
4171 `special-display-regexps' contain a string entry equaling or
4172 matching BUFFER-NAME. If `special-display-buffer-names' or
4173 `special-display-regexps' contain a list entry whose car equals
4174 or matches BUFFER-NAME, the return value is the cdr of that
4175 entry."
4180 t)
4195 "Alist of parameters for special frames.
4196 Special frames are used for buffers whose names are listed in
4197 `special-display-buffer-names' and for buffers whose names match
4198 one of the regular expressions in `special-display-regexps'.
4200 This variable can be set in your init file, like this:
4202 (setq special-display-frame-alist '((width . 80) (height . 20)))
4204 These supersede the values given in `default-frame-alist'."
4211 "Display BUFFER and return the window chosen.
4212 If BUFFER is already displayed in a visible or iconified frame,
4213 raise that frame. Otherwise, display BUFFER in a new frame.
4215 Optional argument ARGS is a list specifying additional
4216 information.
4218 If ARGS is an alist, use it as a list of frame parameters. If
4219 these parameters contain (same-window . t), display BUFFER in
4220 the selected window. If they contain (same-frame . t), display
4221 BUFFER in a window of the selected frame.
4223 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4224 function to do the work. Pass it BUFFER as first argument,
4225 and (cdr ARGS) as second."
4230 ;; If we have a window already, make it visible.
4236 window))
4237 ;; Reuse the current window if the user requested it.
4242 ;; Stay on the same frame if requested.
4245 pop-up-frames
4246 special-display-buffer-names special-display-regexps)
4248 ;; If no window yet, make one in a new frame.
4254 ;; FIXME: Use window--display-buffer-2?
4256 ;; Reset list of WINDOW's previous buffers to nil.
4259 window)))))
4262 "Function to call for displaying special buffers.
4263 This function is called with two arguments - the buffer and,
4264 optionally, a list - and should return a window displaying that
4265 buffer. The default value usually makes a separate frame for the
4266 buffer using `special-display-frame-alist' to specify the frame
4267 parameters. See the definition of `special-display-popup-frame'
4268 for how to specify such a function.
4270 A buffer is special when its name is either listed in
4271 `special-display-buffer-names' or matches a regexp in
4272 `special-display-regexps'.
4274 The specified function should call `display-buffer-record-window'
4275 with corresponding arguments to set up the quit-restore parameter
4276 of the window used."
4282 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4283 on this list in the selected rather than some other window.
4285 An element of this list can be a cons cell instead of just a
4286 string. In that case, the cell's car must be a string specifying
4287 the buffer name. This is for compatibility with
4288 `special-display-buffer-names'; the cdr of the cons cell is
4289 ignored.
4291 See also `same-window-regexps'."
4297 `display-buffer' and `pop-to-buffer' show a buffer whose name
4298 matches a regexp on this list in the selected rather than some
4299 other window.
4301 An element of this list can be a cons cell instead of just a
4302 string. In that case, the cell's car must be a regexp matching
4303 the buffer name. This is for compatibility with
4304 `special-display-regexps'; the cdr of the cons cell is ignored.
4306 See also `same-window-buffer-names'."
4312 This function returns non-nil if `display-buffer' or
4313 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4314 selected rather than (as usual) some other window. See
4315 `same-window-buffer-names' and `same-window-regexps'."
4318 ;; The elements of `same-window-buffer-names' can be buffer
4319 ;; names or cons cells whose cars are buffer names.
4324 ;; The elements of `same-window-regexps' can be regexps
4325 ;; or cons cells whose cars are regexps.
4333 "Whether `display-buffer' should make a separate frame.
4334 If nil, never make a separate frame.
4335 If the value is `graphic-only', make a separate frame
4336 on graphic displays only.
4337 Any other non-nil value means always make a separate frame."
4345 "Non-nil means `display-buffer' should reuse frames.
4346 If the buffer in question is already displayed in a frame, raise
4347 that frame."
4353 "Non-nil means `display-buffer' should make a new window."
4358 "Function called by `display-buffer' routines to split a window.
4359 This function is called with a window as single argument and is
4360 supposed to split that window and return the new window. If the
4361 window can (or shall) not be split, it is supposed to return nil.
4362 The default is to call the function `split-window-sensibly' which
4363 tries to split the window in a way which seems most suitable.
4364 You can customize the options `split-height-threshold' and/or
4365 `split-width-threshold' in order to have `split-window-sensibly'
4366 prefer either vertical or horizontal splitting.
4368 If you set this to any other function, bear in mind that the
4369 `display-buffer' routines may call this function two times. The
4370 argument of the first call is the largest window on its frame.
4371 If that call fails to return a live window, the function is
4372 called again with the least recently used window as argument. If
4373 that call fails too, `display-buffer' will use an existing window
4374 to display its buffer.
4376 The window selected at the time `display-buffer' was invoked is
4377 still selected when this function is called. Hence you can
4378 compare the window argument with the value of `selected-window'
4379 if you intend to split the selected window instead or if you do
4380 not want to split the selected window."
4386 "Minimum height for splitting windows sensibly.
4387 If this is an integer, `split-window-sensibly' may split a window
4388 vertically only if it has at least this many lines. If this is
4389 nil, `split-window-sensibly' is not allowed to split a window
4390 vertically. If, however, a window is the only window on its
4391 frame, `split-window-sensibly' may split it vertically
4392 disregarding the value of this variable."
4398 "Minimum width for splitting windows sensibly.
4399 If this is an integer, `split-window-sensibly' may split a window
4400 horizontally only if it has at least this many columns. If this
4401 is nil, `split-window-sensibly' is not allowed to split a window
4402 horizontally."
4408 "Return non-nil if `split-window-sensibly' may split WINDOW.
4409 Optional argument HORIZONTAL nil or omitted means check whether
4410 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4411 non-nil means check whether WINDOW may be split horizontally.
4413 WINDOW may be split vertically when the following conditions
4414 hold:
4415 - `window-size-fixed' is either nil or equals `width' for the
4416 buffer of WINDOW.
4417 - `split-height-threshold' is an integer and WINDOW is at least as
4418 high as `split-height-threshold'.
4419 - When WINDOW is split evenly, the emanating windows are at least
4420 `window-min-height' lines tall and can accommodate at least one
4421 line plus - if WINDOW has one - a mode line.
4423 WINDOW may be split horizontally when the following conditions
4424 hold:
4425 - `window-size-fixed' is either nil or equals `height' for the
4426 buffer of WINDOW.
4427 - `split-width-threshold' is an integer and WINDOW is at least as
4428 wide as `split-width-threshold'.
4429 - When WINDOW is split evenly, the emanating windows are at least
4430 `window-min-width' or two (whichever is larger) columns wide."
4434 ;; A window can be split horizontally when its width is not
4435 ;; fixed, it is at least `split-width-threshold' columns wide
4436 ;; and at least twice as wide as `window-min-width' and 2 (the
4437 ;; latter value is hardcoded).
4439 ;; Testing `window-full-width-p' here hardly makes any
4440 ;; sense nowadays. This can be done more intuitively by
4441 ;; setting up `split-width-threshold' appropriately.
4446 ;; A window can be split vertically when its height is not
4447 ;; fixed, it is at least `split-height-threshold' lines high,
4448 ;; and it is at least twice as high as `window-min-height' and 2
4449 ;; if it has a modeline or 1.
4458 "Split WINDOW in a way suitable for `display-buffer'.
4459 If `split-height-threshold' specifies an integer, WINDOW is at
4460 least `split-height-threshold' lines tall and can be split
4461 vertically, split WINDOW into two windows one above the other and
4462 return the lower window. Otherwise, if `split-width-threshold'
4463 specifies an integer, WINDOW is at least `split-width-threshold'
4464 columns wide and can be split horizontally, split WINDOW into two
4465 windows side by side and return the window on the right. If this
4466 can't be done either and WINDOW is the only window on its frame,
4467 try to split WINDOW vertically disregarding any value specified
4468 by `split-height-threshold'. If that succeeds, return the lower
4469 window. Return nil otherwise.
4471 By default `display-buffer' routines call this function to split
4472 the largest or least recently used window. To change the default
4473 customize the option `split-window-preferred-function'.
4475 You can enforce this function to not split WINDOW horizontally,
4476 by setting (or binding) the variable `split-width-threshold' to
4477 nil. If, in addition, you set `split-height-threshold' to zero,
4478 chances increase that this function does split WINDOW vertically.
4480 In order to not split WINDOW vertically, set (or bind) the
4481 variable `split-height-threshold' to nil. Additionally, you can
4482 set `split-width-threshold' to zero to make a horizontal split
4483 more likely to occur.
4485 Have a look at the function `window-splittable-p' if you want to
4486 know how `split-window-sensibly' determines whether WINDOW can be
4487 split."
4489 ;; Split window vertically.
4493 ;; Split window horizontally.
4498 ;; If WINDOW is the only window on its frame and is not the
4499 ;; minibuffer window, try to split it vertically disregarding
4500 ;; the value of `split-height-threshold'.
4507 "Try to split WINDOW.
4508 Return value returned by `split-window-preferred-function' if it
4509 represents a live window, nil otherwise."
4513 ;; Since `split-window-preferred-function' might
4514 ;; throw an error use `condition-case'.
4521 "Return FRAME if it can be used to display a buffer."
4524 ;; `frame-root-window' may be an internal window which is considered
4525 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4526 ;; implicitly know that `frame' has a visible window we can use.
4529 ;; If the window is soft-dedicated, the frame is usable.
4530 ;; Actually, even if the window is really dedicated,
4531 ;; the frame is still usable by splitting it.
4532 ;; At least Emacs-22 allowed it, and it is desirable
4533 ;; when displaying same-frame windows.
4534 nil ; (eq t (window-dedicated-p window))
4535 ))
4536 frame))))
4539 "If non-nil `display-buffer' will try to even window heights.
4540 Otherwise `display-buffer' will leave the window configuration
4541 alone. Heights are evened only when `display-buffer' chooses a
4542 window that appears above or below the selected window."
4547 "Even heights of WINDOW and selected window.
4548 Do this only if these windows are vertically adjacent to each
4549 other, `even-window-heights' is non-nil, and the selected window
4550 is higher than WINDOW."
4553 ;; Don't resize minibuffer windows.
4564 ;; Don't throw an error if we can't even window heights for
4565 ;; whatever reason.
4571 "Raise the frame containing WINDOW.
4572 Do not raise the selected frame. Return WINDOW."
4576 ;; Assume the selected frame is already visible enough.
4578 ;; Assume the frame from which we invoked the minibuffer
4579 ;; is visible.
4583 window))
4586 "Display BUFFER in WINDOW and make its frame visible.
4587 Set `window-dedicated-p' to DEDICATED if non-nil.
4588 Return WINDOW."
4595 ;; FIXME: Not implemented.
4596 ;; FIXME: By the way, there could be more levels of dedication:
4597 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4598 ;; the window hasn't been used for something else yet.
4599 ;; - `softly' dedicated only allows reuse when asked explicitly.
4600 ;; - `strongly' never allows reuse.
4602 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4603 The actual non-nil value of this variable will be copied to the
4620 ,display-buffer--action-function-custom-type
4625 :key-type symbol
4630 "Overriding action to perform to display a buffer.
4631 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4632 function or a list of functions. Each function should accept two
4633 arguments: a buffer to display and an alist similar to ALIST.
4638 "Alist of conditional actions for `display-buffer'.
4639 This is a list of elements (CONDITION . ACTION), where:
4641 CONDITION is either a regexp matching buffer names, or a function
4642 that takes a buffer and returns a boolean.
4644 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4645 function or a list of functions. Each such function should
4646 accept two arguments: a buffer to display and an alist of the
4647 same form as ALIST. See `display-buffer' for details."
4650 regexp
4653 :risky t
4658 "User-specified default action for `display-buffer'.
4659 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4660 function or a list of functions. Each function should accept two
4661 arguments: a buffer to display and an alist similar to ALIST.
4662 See `display-buffer' for details."
4663 :type display-buffer--action-custom-type
4664 :risky t
4670 display-buffer-reuse-window
4671 display-buffer--maybe-pop-up-frame-or-window
4672 display-buffer-use-some-window
4673 ;; If all else fails, pop up a new frame.
4674 display-buffer-pop-up-frame))
4675 "Default fallback action for `display-buffer'.
4676 This is the action used by `display-buffer' if no other actions
4677 specified, e.g. by the user options `display-buffer-alist' or
4682 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4700 display-buffer-pop-up-frame)
4707 "Display BUFFER-OR-NAME in some window, without selecting it.
4708 BUFFER-OR-NAME must be a buffer or the name of an existing
4709 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4710 or nil if no such window is found.
4712 Optional argument ACTION should have the form (FUNCTION . ALIST).
4713 FUNCTION is either a function or a list of functions.
4714 ALIST is an arbitrary association list (alist).
4716 Each such FUNCTION should accept two arguments: the buffer to
4717 display and an alist. Based on those arguments, it should either
4718 display the buffer and return the window, or return nil if unable
4719 to display the buffer.
4721 The `display-buffer' function builds a function list and an alist
4722 by combining the functions and alists specified in
4723 `display-buffer-overriding-action', `display-buffer-alist', the
4724 ACTION argument, `display-buffer-base-action', and
4725 `display-buffer-fallback-action' (in order). Then it calls each
4726 function in the combined function list in turn, passing the
4727 buffer as the first argument and the combined alist as the second
4728 argument, until one of the functions returns non-nil.
4730 Available action functions include:
4731 `display-buffer-same-window'
4732 `display-buffer-reuse-window'
4733 `display-buffer-pop-up-frame'
4734 `display-buffer-pop-up-window'
4735 `display-buffer-use-some-window'
4737 Recognized alist entries include:
4739 `inhibit-same-window' -- A non-nil value prevents the same
4740 window from being used for display.
4742 `reusable-frames' -- Value specifies frame(s) to search for a
4743 window that already displays the buffer.
4744 See `display-buffer-reuse-window'.
4746 The ACTION argument to `display-buffer' can also have a non-nil
4747 and non-list value. This means to display the buffer in a window
4748 other than the selected one, even if it is already displayed in
4749 the selected window. If called interactively with a prefix
4750 argument, ACTION is t.
4752 Optional argument FRAME, if non-nil, acts like an additional
4753 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4754 search for a window that is already displaying the buffer. See
4755 `display-buffer-reuse-window'."
4759 buffer-or-name
4761 ;; Handle the old form of the first argument.
4765 ;; If `display-buffer-function' is defined, let it do the job.
4767 ;; Otherwise, use the defined actions.
4770 display-buffer-alist))
4772 ;; Extra actions from the arguments to this function:
4778 ;; Construct action function list and action alist.
4780 user-action special-action action extra-action
4781 display-buffer-base-action
4782 display-buffer-fallback-action))
4787 actions)))
4789 window)
4795 window))))
4798 "Display buffer BUFFER in another frame.
4799 This uses the function `display-buffer' as a subroutine; see
4800 its documentation for additional customization information."
4804 ;;; `display-buffer' action functions:
4807 "Display BUFFER in the selected window.
4808 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4809 if the selected window is a minibuffer window or is dedicated to
4810 another buffer; in that case, return nil. Otherwise, return the
4811 selected window."
4819 "Conditionally display BUFFER in the selected window.
4820 If `same-window-p' returns non-nil for BUFFER's name, call
4821 `display-buffer-same-window' and return its value. Otherwise,
4822 return nil."
4827 "Return a window that is already displaying BUFFER.
4828 Return nil if no usable window is found.
4830 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4831 window is not eligible for reuse.
4833 If ALIST contains a `reusable-frames' entry, its value determines
4834 which frames to search for a reusable window:
4835 nil -- the selected frame (actually the last non-minibuffer frame)
4836 A frame -- just that frame
4837 `visible' -- all visible frames
4838 0 -- all frames on the current terminal
4839 t -- all frames.
4841 If ALIST contains no `reusable-frames' entry, search just the
4842 selected frame if `display-buffer-reuse-frames' and
4843 `pop-up-frames' are both nil; search all frames on the current
4844 terminal if either of those variables is non-nil."
4849 pop-up-frames)
4858 frames))))))
4864 "Return special display action for BUFFER, if any.
4865 If `special-display-p' returns non-nil for BUFFER, return an
4866 appropriate display action involving `special-display-function'.
4867 See `display-buffer' for the format of display actions."
4869 ;; `special-display-p' returns either t or a list of frame
4870 ;; parameters to pass to `special-display-function'.
4879 "Display BUFFER in a new frame.
4880 This works by calling `pop-up-frame-function'. If successful,
4881 return the window used; otherwise return nil."
4883 frame window)
4889 ;; Reset list of WINDOW's previous buffers to nil.
4891 window)))
4894 "Display BUFFER by popping up a new window.
4895 The new window is created on the selected frame, or in
4896 `last-nonminibuffer-frame' if no windows can be created there.
4897 If successful, return the new window; otherwise return nil."
4900 window)
4902 ;; If the selected frame cannot be split, look at
4903 ;; `last-nonminibuffer-frame'.
4908 ;; Attempt to split largest or least recently used window.
4915 ;; Reset list of WINDOW's previous buffers to nil.
4917 window)))
4920 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4922 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4923 text-only terminal), try with `display-buffer-pop-up-frame'.
4925 If that cannot be done, and `pop-up-windows' is non-nil, try
4926 again with `display-buffer-pop-up-window'."
4929 pop-up-frames)
4935 "Display BUFFER in an existing window.
4936 Search for a usable window, set that window to the buffer, and
4937 return the window. If no suitable window is found, return nil."
4940 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4941 ;; selected window to its buffer, to prevent any of the
4942 ;; `get-' routines below from choosing it. (Bug#1415)
4948 window)
4951 ;; Reuse an existing window.
4956 window))
4961 window))
4964 ;; Restore dedicated status of selected window.
4971 ;;; Display + selection commands:
4974 "Select buffer BUFFER in some window, preferably a different one.
4975 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4976 is a string not naming an existent buffer, create a buffer with
4977 that name. If BUFFER is nil, choose some other buffer. Return
4978 the buffer.
4980 This uses `display-buffer' as a subroutine. The optional ACTION
4981 argument is passed to `display-buffer' as its ACTION argument.
4982 See `display-buffer' for more information. ACTION is t if called
4983 interactively with a prefix argument, which means to pop to a
4984 window other than the selected one even if the buffer is already
4985 displayed in the selected window.
4987 If the window to show BUFFER is not on the selected
4988 frame, raise that window's frame and give it input focus.
4990 Optional third arg NORECORD non-nil means do not put this buffer
4991 at the front of the list of recently selected ones."
4999 ;; If we chose another frame, make sure it gets input focus.
5002 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
5004 buffer))
5007 "Select buffer BUFFER in some window, preferably the same one.
5008 This function behaves much like `switch-to-buffer', except it
5009 displays with `special-display-function' if BUFFER has a match in
5010 `special-display-buffer-names' or `special-display-regexps'.
5012 Unlike `pop-to-buffer', this function prefers using the selected
5013 window over popping up a new window or frame.
5015 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5016 is a string not naming an existent buffer, create a buffer with
5017 that name. If BUFFER is nil, choose some other buffer. Return
5018 the buffer.
5020 NORECORD, if non-nil means do not put this buffer at the front of
5021 the list of recently selected ones."
5025 "Read the name of a buffer to switch to, prompting with PROMPT.
5026 Return the name of the buffer as a string.
5028 This function is intended for the `switch-to-buffer' family of
5029 commands since these need to omit the name of the current buffer
5030 from the list of completions and default values."
5035 ;; Since rbts-completion-table is built dynamically, we
5036 ;; can't just add it to the default value of
5037 ;; icomplete-with-completion-tables, so we add it
5038 ;; here manually.
5043 icomplete-with-completion-tables))))
5048 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5049 If BUFFER-OR-NAME is nil, return the buffer returned by
5050 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5051 exists, return that buffer. If no such buffer exists, create a
5052 buffer with the name BUFFER-OR-NAME and return that buffer."
5057 buffer))
5061 "Switch to buffer BUFFER-OR-NAME in the selected window.
5062 If called interactively, prompt for the buffer name using the
5063 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5064 determines whether to request confirmation before creating a new
5065 buffer.
5067 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5068 nil. If BUFFER-OR-NAME is a string that does not identify an
5069 existing buffer, create a buffer with that name. If
5070 BUFFER-OR-NAME is nil, switch to the buffer returned by
5071 `other-buffer'.
5073 Optional argument NORECORD non-nil means do not put the buffer
5074 specified by BUFFER-OR-NAME at the front of the buffer list and
5075 do not make the window displaying it the most recently selected
5076 one.
5078 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5079 in the selected window; signal an error if that is
5080 impossible (e.g. if the selected window is minibuffer-only). If
5081 nil, BUFFER-OR-NAME may be displayed in another window.
5083 Return the buffer switched to."
5088 ;; Don't call set-window-buffer if it's not needed since it
5089 ;; might signal an error (e.g. if the window is dedicated).
5106 "Select the buffer specified by BUFFER-OR-NAME in another window.
5107 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5108 nil. Return the buffer switched to.
5110 If called interactively, prompt for the buffer name using the
5111 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5112 determines whether to request confirmation before creating a new
5113 buffer.
5115 If BUFFER-OR-NAME is a string and does not identify an existing
5116 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5117 nil, switch to the buffer returned by `other-buffer'.
5119 Optional second argument NORECORD non-nil means do not put this
5120 buffer at the front of the list of recently selected ones.
5122 This uses the function `display-buffer' as a subroutine; see its
5123 documentation for additional customization information."
5130 "Switch to buffer BUFFER-OR-NAME in another frame.
5131 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5132 nil. Return the buffer switched to.
5134 If called interactively, prompt for the buffer name using the
5135 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5136 determines whether to request confirmation before creating a new
5137 buffer.
5139 If BUFFER-OR-NAME is a string and does not identify an existing
5140 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5141 nil, switch to the buffer returned by `other-buffer'.
5143 Optional second arg NORECORD non-nil means do not put this
5144 buffer at the front of the list of recently selected ones.
5146 This uses the function `display-buffer' as a subroutine; see its
5147 documentation for additional customization information."
5151 \f
5153 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5154 WINDOW must be a live window. HEIGHT doesn't include the mode
5155 line or header line, if any, or any partial-height lines in the
5156 text display area.
5158 Note that the current implementation of this function cannot
5159 always set the height exactly, but attempts to be conservative,
5160 by allocating more lines than are actually needed in the case
5161 where some error may be present."
5165 ;; Setting window-min-height to a value like 1 can lead to very
5166 ;; bizarre displays because it also allows Emacs to make *other*
5167 ;; windows 1-line tall, which means that there's no more space for
5168 ;; the modeline.
5173 "Make selected window DELTA columns wider.
5174 Interactively, if no argument is given, make selected window one
5175 column wider."
5180 "Make selected window DELTA columns narrower.
5181 Interactively, if no argument is given, make selected window one
5182 column narrower."
5187 "Return the number of screen lines in the region.
5188 The number of screen lines may be different from the number of actual lines,
5189 due to line breaking, display table, etc.
5191 Optional arguments BEG and END default to `point-min' and `point-max'
5192 respectively.
5194 If region ends with a newline, ignore it unless optional third argument
5195 COUNT-FINAL-NEWLINE is non-nil.
5197 The optional fourth argument WINDOW specifies the window used for obtaining
5198 parameters such as width, horizontal scrolling, and so on. The default is
5199 to use the selected window's parameters.
5201 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5202 regardless of which buffer is displayed in WINDOW. This makes possible to use
5203 `count-screen-lines' in any buffer, whether or not it is currently displayed
5204 in some window."
5210 0
5223 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5227 ;; If buffer ends with a newline, ignore it when
5228 ;; counting height unless point is after it.
5230 window))))
5232 ;;; Resizing buffers to fit their contents exactly.
5234 "Adjust height of WINDOW to display its buffer's contents exactly.
5235 WINDOW can be any live window and defaults to the selected one.
5237 Optional argument MAX-HEIGHT specifies the maximum height of
5238 WINDOW and defaults to the height of WINDOW's frame. Optional
5239 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5240 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5241 are specified in lines and include the mode line and header line,
5242 if any.
5244 Optional argument OVERRIDE non-nil means override restrictions
5245 imposed by `window-min-height' and `window-min-width' on the size
5246 of WINDOW.
5248 Return the number of lines by which WINDOW was enlarged or
5249 shrunk. If an error occurs during resizing, return nil but don't
5250 signal an error.
5252 Note that even if this function makes WINDOW large enough to show
5253 _all_ lines of its buffer you might not see the first lines when
5254 WINDOW was scrolled."
5256 ;; Do all the work in WINDOW and its buffer and restore the selected
5257 ;; window and the current buffer when we're done.
5259 ;; Can't resize a full height or fixed-size window.
5262 ;; `with-selected-window' should orderly restore the current buffer.
5264 ;; We are in WINDOW's buffer now.
5270 window-safe-min-height)))
5273 ;; Adjust MAX-HEIGHT.
5276 max-window-height
5278 ;; Make `desired-height' the height necessary to show
5279 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5280 ;; and MAX-HEIGHT.
5285 ;; For non-minibuffers count the mode line, if any.
5287 mode-line-format)
5288 1
5290 ;; Count the header line, if any.
5292 max-height)
5293 min-height))
5302 ;; This `condition-case' shouldn't be necessary, but who knows?
5305 ;; Return zero if DELTA became zero in the process.
5306 0
5307 ;; Don't try to redisplay with the cursor at the end on its
5308 ;; own line--that would force a scroll and spoil things.
5310 ;; It's silly to put `point' at the end of the previous
5311 ;; line and so maybe force horizontal scrolling.
5313 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5315 ;; Check if the last line is surely fully visible. If
5316 ;; not, enlarge the window.
5320 ;; Don't include final newline.
5323 ;; If line-wrapping is turned off, test the
5324 ;; beginning of the last line for
5325 ;; visibility instead of the end, as the
5326 ;; end of the line could be invisible by
5327 ;; virtue of extending past the edge of the
5328 ;; window.
5332 ;; This loop might in some rare pathological cases raise
5333 ;; an error - another reason for the `condition-case'.
5340 delta))))
5343 "Return t if WINDOW can be shrunk without shrinking other windows.
5344 WINDOW defaults to the selected window."
5351 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5352 More precisely, shrink WINDOW vertically to be as small as
5353 possible, while still showing the full contents of its buffer.
5354 WINDOW defaults to the selected window.
5356 Do not shrink WINDOW to less than `window-min-height' lines. Do
5357 nothing if the buffer contains more lines than the present window
5358 height, or if some of the window's contents are scrolled out of
5359 view, or if shrinking this window would also shrink another
5360 window, or if the window is the only window of its frame.
5362 Return non-nil if the window was shrunk, nil otherwise."
5365 ;; Make sure that WINDOW is vertically combined and `point-min' is
5366 ;; visible (for whatever reason that's needed). The remaining issues
5367 ;; should be taken care of by `fit-window-to-buffer'.
5371 \f
5373 "Kill the current buffer and delete the selected window."
5382 ;; If `delete-window' failed before, we rerun it to regenerate
5383 ;; the error so it can be seen in the echo area.
5386 ;; If the buffer is not dead for some reason (probably because
5387 ;; of a `quit' signal), remove the hook again.
5392 \f
5394 "Indicates the last recenter operation performed.
5398 "Cycling order for `recenter-top-bottom'.
5399 A list of elements with possible values `top', `middle', `bottom',
5400 integer or float numbers that define the cycling order for
5401 the command `recenter-top-bottom'.
5403 Top and bottom destinations are `scroll-margin' lines from the true
5404 window top and bottom. Middle redraws the frame and centers point
5405 vertically within the window. Integer number moves current line to
5406 the specified absolute window-line. Float number between 0.0 and 1.0
5407 means the percentage of the screen space from the top. The default
5408 cycling order is middle -> top -> bottom."
5419 "Move current buffer line to the specified window line.
5420 With no prefix argument, successive calls place point according
5421 to the cycling order defined by `recenter-positions'.
5423 A prefix argument is handled like `recenter':
5424 With numeric prefix ARG, move current line to window-line ARG.
5425 With plain `C-u', move current line to window center."
5433 recenter-positions))
5452 "Position point relative to window.
5454 With a prefix argument ARG, acts like `move-to-window-line'.
5456 With no argument, positions point at center of window.
5457 Successive calls position point at positions defined
5458 by `recenter-positions'."
5466 recenter-positions))
5483 \f
5484 ;;; Scrolling commands.
5486 ;;; Scrolling commands which do not signal errors at top/bottom
5487 ;;; of buffer at first key-press (instead move to top/bottom
5488 ;;; of buffer).
5491 "Move point to top/bottom of buffer before signaling a scrolling error.
5492 A value of nil means just signal an error if no more scrolling possible.
5493 A value of t means point moves to the beginning or the end of the buffer
5494 \(depending on scrolling direction) when no more scrolling possible.
5495 When point is already on that position, then signal an error."
5501 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5502 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5503 scroll window further, move cursor to the bottom line.
5504 When point is already on that position, then signal an error.
5505 A near full screen is `next-screen-context-lines' less than a full screen.
5506 Negative ARG means scroll downward.
5507 If ARG is the atom `-', scroll downward by nearly full screen."
5523 ;; When scrolling by ARG lines can't be done,
5524 ;; move by ARG lines instead.
5526 ;; When ARG is nil for full-screen scrolling,
5527 ;; move to the bottom of the buffer.
5533 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5534 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5535 scroll window further, move cursor to the top line.
5536 When point is already on that position, then signal an error.
5537 A near full screen is `next-screen-context-lines' less than a full screen.
5538 Negative ARG means scroll upward.
5539 If ARG is the atom `-', scroll upward by nearly full screen."
5555 ;; When scrolling by ARG lines can't be done,
5556 ;; move by ARG lines instead.
5558 ;; When ARG is nil for full-screen scrolling,
5559 ;; move to the top of the buffer.
5564 ;;; Scrolling commands which scroll a line instead of full screen.
5567 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5568 If ARG is omitted or nil, scroll upward by one line.
5569 This is different from `scroll-up-command' that scrolls a full screen."
5576 "Scroll text of selected window down ARG lines; or one line if no ARG.
5577 If ARG is omitted or nil, scroll down by one line.
5578 This is different from `scroll-down-command' that scrolls a full screen."
5584 \f
5587 For more details, see the documentation for `scroll-other-window'."
5590 ;; Just invert the argument's meaning.
5591 ;; We can do that without knowing which window it will be.
5597 "Move point to the beginning of the buffer in the other window.
5598 Leave mark at previous position.
5599 With arg N, put point N/10 of the way from the true beginning."
5603 ;; We use unwind-protect rather than save-window-excursion
5604 ;; because the latter would preserve the things we want to change.
5608 ;; Set point and mark in that window's buffer.
5611 ;; Set point accordingly.
5616 "Move point to the end of the buffer in the other window.
5617 Leave mark at previous position.
5618 With arg N, put point N/10 of the way from the true end."
5620 ;; See beginning-of-buffer-other-window for comments.
5630 \f
5641 "When non-nil, special state of delayed window autoselection.
5642 Possible values are `suspend' (suspend autoselection after a menu or
5643 scrollbar interaction) and `select' (the next invocation of
5647 "Cancel delayed window autoselection.
5648 Optional argument FORCE means cancel unconditionally."
5650 ;; Don't cancel for select-window or select-frame events
5651 ;; or when the user drags a scroll bar.
5663 "Start delayed window autoselection.
5664 MOUSE-POSITION is the last position where the mouse was seen as returned
5665 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5666 window where the mouse was seen. Optional argument SUSPEND non-nil
5667 means suspend autoselection."
5668 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5672 ;; Install timer which runs `mouse-autoselect-window-select' after
5673 ;; `mouse-autoselect-window' seconds.
5679 "Select window with delayed window autoselection.
5680 If the mouse position has stabilized in a non-selected window, select
5681 that window. The minibuffer window is selected only if the minibuffer
5682 is active. This function is run by `mouse-autoselect-window-timer'."
5693 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5694 ;; of WINDOW, temporarily suspend delayed autoselection.
5697 ;; Delayed autoselection was temporarily suspended, reenable it.
5702 ;; If `mouse-autoselect-window' is positive, select
5703 ;; window if the window is the same as before.
5705 ;; Otherwise select window if the mouse is at the same
5706 ;; position as before. Observe that the first test after
5707 ;; starting autoselection usually fails since the value of
5708 ;; `mouse-autoselect-window-position' recorded there is the
5709 ;; position where the mouse has entered the new window and
5710 ;; not necessarily where the mouse has stopped moving.
5712 ;; The minibuffer is a candidate window if it's active.
5715 ;; Mouse position has stabilized in non-selected window: Cancel
5716 ;; delayed autoselection and try to select that window.
5718 ;; Select window where mouse appears unless the selected window is the
5719 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5720 ;; and post-command hooks and trigger idle timers. To avoid delaying
5721 ;; autoselection again, set `mouse-autoselect-window-state'."
5726 unread-command-events))))
5730 ;; Mouse position has either stabilized in the selected window or at
5731 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5734 ;; Mouse position has not stabilized yet, resume delayed
5735 ;; autoselection.
5739 "Handle select-window events."
5743 ;; Don't switch if we're currently in the minibuffer.
5744 ;; This tries to work around problems where the
5745 ;; minibuffer gets unselected unexpectedly, and where
5746 ;; you then have to move your mouse all the way down to
5747 ;; the minibuffer to select it.
5749 ;; Don't switch to minibuffer window unless it's active.
5752 ;; Don't switch when autoselection shall be delayed.
5757 ;; Cancel any delayed autoselection.
5759 ;; Start delayed autoselection from current mouse
5760 ;; position and window.
5762 ;; Executing a command cancels delayed autoselection.
5766 ;; Reset state of delayed autoselection.
5768 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5773 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5774 WINDOW defaults to the selected window.
5775 Return nil if WINDOW is not a partial-width window
5776 (regardless of the value of `truncate-lines').
5777 Otherwise, consult the value of `truncate-partial-width-windows'
5778 for the buffer shown in WINDOW."
5786 t-p-w-w))))
5787 \f
5788 ;; Some of these are in tutorial--default-keys, so update that if you
5789 ;; change these.
5802 ;;; window.el ends here