| blob | d7129df858515fbbc6fd6f631b5dc67f1ee70fa8 |
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:
32 "Execute BODY, then select the previously selected window.
33 The value returned is the value of the last form in BODY.
35 This macro saves and restores the selected window, as well as the
36 selected window in each frame. If the previously selected window
37 is no longer live, then whatever window is selected at the end of
38 BODY remains selected. If the previously selected window of some
39 frame is no longer live at the end of BODY, that frame's selected
40 window is left alone.
42 This macro saves and restores the current buffer, since otherwise
43 its normal operation could make a different buffer current. The
44 order of recently selected windows and the buffer list ordering
45 are not altered by this macro (unless they are altered in BODY)."
48 ;; We save and restore all frames' selected windows, because
49 ;; `select-window' can change the frame-selected-window of
50 ;; whatever frame that window is in. Each text terminal's
51 ;; top-frame is preserved by putting it last in the list.
57 alist)
64 alist))))
76 ;; The following two functions are like `window-next-sibling' and
77 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
78 ;; they don't substitute the selected window for nil), and they return
79 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
80 ;; a minibuffer window).
82 "Return WINDOW's right sibling.
83 Return nil if WINDOW is the root window of its frame. WINDOW can
84 be any window."
88 "Return WINDOW's left sibling.
89 Return nil if WINDOW is the root window of its frame. WINDOW can
90 be any window."
94 "Return WINDOW's first child window."
98 "Return number of WINDOW's child windows."
104 count))
107 "Return last child window of WINDOW."
111 window)
114 "Return buffer specified by BUFFER-OR-NAME.
115 BUFFER-OR-NAME must be either a buffer or a string naming a live
116 buffer and defaults to the current buffer."
122 buffer-or-name
129 "Return frame specified by FRAME.
130 FRAME must be a live frame and defaults to the selected frame."
133 frame
138 "Return window specified by WINDOW.
139 If WINDOW is nil, return `selected-window'.
140 If WINDOW is a live window or internal window, return WINDOW;
141 if LIVE-ONLY is non-nil, return WINDOW for a live window only.
142 Otherwise, signal an error."
147 window
150 window
154 "If non-nil, standard functions ignore window parameters.
155 The functions currently affected by this are `split-window',
156 `delete-window', `delete-other-windows' and `other-window'.
158 An application may bind this to a non-nil value around calls to
162 "The absolute minimum number of lines of a window.
166 "The minimum number of lines of any window.
167 The value has to accommodate a mode- or header-line if present.
168 A value less than `window-safe-min-height' is ignored. The value
169 of this variable is honored when windows are resized or split.
171 Applications should never rebind this variable. To resize a
172 window to a height less than the one specified here, an
173 application should instead call `window-resize' with a non-nil
174 IGNORE argument. In order to have `split-window' make a window
175 shorter, explicitly specify the SIZE argument of that function."
181 "The absolute minimum number of columns of a window.
185 "The minimum number of columns of any window.
186 The value has to accommodate margins, fringes, or scrollbars if
187 present. A value less than `window-safe-min-width' is ignored.
188 The value of this variable is honored when windows are resized or
189 split.
191 Applications should never rebind this variable. To resize a
192 window to a width less than the one specified here, an
193 application should instead call `window-resize' with a non-nil
194 IGNORE argument. In order to have `split-window' make a window
195 narrower, explicitly specify the SIZE argument of that function."
201 "Return non-nil if WINDOW has siblings in a given direction.
202 If WINDOW is omitted or nil, it defaults to the selected window.
204 HORIZONTAL determines a direction for the window combination.
205 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
206 of a vertical window combination.
207 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
208 horizontal window combination."
217 "Return largest number of windows vertically arranged within WINDOW.
218 If WINDOW is omitted or nil, it defaults to the selected window.
219 If HORIZONTAL is non-nil, return the largest number of
220 windows horizontally arranged within WINDOW."
224 ;; If WINDOW is live, return 1.
229 ;; If WINDOW is iso-combined, return the sum of the values for all
230 ;; child windows of WINDOW.
236 count))
238 count))
240 ;; If WINDOW is not iso-combined, return the maximum value of any
241 ;; child window of WINDOW.
247 count))
249 count))))
252 "Helper function for `walk-window-tree' and `walk-window-subtree'."
270 "Run function FUN on each live window of FRAME.
271 FUN must be a function with one argument - a window. FRAME must
272 be a live frame and defaults to the selected one. ANY, if
273 non-nil means to run FUN on all live and internal windows of
274 FRAME.
276 This function performs a pre-order, depth-first traversal of the
277 window tree. If FUN changes the window tree, the result is
278 unpredictable."
284 "Run function FUN on the subtree of windows rooted at WINDOW.
285 WINDOW defaults to the selected window. FUN must be a function
286 with one argument - a window. By default, run FUN only on live
287 windows of the subtree. If the optional argument ANY is non-nil,
288 run FUN on all live and internal windows of the subtree. If
289 WINDOW is live, run FUN on WINDOW only.
291 This function performs a pre-order, depth-first traversal of the
292 subtree rooted at WINDOW. If FUN changes that tree, the result
293 is unpredictable."
298 "Return first window on FRAME with PARAMETER non-nil.
299 FRAME defaults to the selected frame. Optional argument VALUE
300 non-nil means only return a window whose window-parameter value
301 for PARAMETER equals VALUE (comparison is done with `equal').
302 Optional argument ANY non-nil means consider internal windows
303 too."
311 frame any))))
313 ;;; Atomic windows.
315 "Return root of atomic window WINDOW is a part of.
316 WINDOW can be any window and defaults to the selected one.
317 Return nil if WINDOW is not part of an atomic window."
323 root))
326 "Make WINDOW an atomic window.
327 WINDOW must be an internal window. Return WINDOW."
333 window t)
334 window))
337 "Subroutine of `window--atom-check'."
347 window t))
348 ;; count >= 1 must hold here. If there's no other
349 ;; window around dissolve this atomic window.
351 ;; Dissolve atomic window.
355 window t)))
356 ;; Check children.
360 ;; Check right sibling
364 "Check atomicity of all windows on FRAME.
365 FRAME defaults to the selected frame. If an atomic window is
366 wrongly configured, reset the atomicity of all its windows on
367 FRAME to nil. An atomic window is wrongly configured if it has
368 no child windows or one of its child windows is not atomic."
371 ;; Side windows.
376 "If non-nil, left and right side windows are full height.
377 Otherwise, top and bottom side windows are full width."
383 "Maximum number of side window slots.
384 The value is a list of four elements specifying the number of
385 side window slots on (in this order) the left, top, right and
386 bottom side of each frame. If an element is a number, this means
387 to display at most that many side windows on the corresponding
388 side. If an element is nil, this means there's no bound on the
389 number of slots on that side."
391 :risky t
392 :type
398 :value nil
405 :value nil
412 :value nil
419 :value nil
426 "Check the window-side parameter of all windows on FRAME.
427 FRAME defaults to the selected frame. If the configuration is
428 invalid, reset all window-side parameters to nil.
430 A valid configuration has to preserve the following invariant:
432 - If a window has a non-nil window-side parameter, it must have a
433 parent window and the parent window's window-side parameter
434 must be either nil or the same as for window.
436 - If windows with non-nil window-side parameters exist, there
437 must be at most one window of each side and non-side with a
438 parent whose window-side parameter is nil and there must be no
439 leaf window whose window-side parameter is nil."
441 side parent parent-side)
449 ;; The following `cond' seems a bit tedious, but I'd
450 ;; rather stick to using just the stack.
454 ;; A parent whose window-side is non-nil must
455 ;; have a child with the same window-side.
457 ;; Now check that there's more than one main window
458 ;; for any of none, left, top, right and bottom.
480 ;; A leaf window without window-side parameter,
481 ;; record its existence.
483 frame t))
485 ;; At least one non-side window exists, so there must
486 ;; be at least one side-window and no normal window.
488 ;; No non-side window exists, so there must be no side
489 ;; window either.
494 frame t))))
497 "Check atomic and side windows on FRAME.
498 FRAME defaults to the selected frame."
502 ;;; Window sizes.
504 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
505 If the value is `height', then only the window's height is fixed.
506 If the value is `width', then only the window's width is fixed.
507 Any other non-nil value fixes both the width and the height.
509 Emacs won't change the size of any window displaying that buffer,
510 unless it has no other choice (like when deleting a neighboring
515 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
519 "Return the minimum size of WINDOW.
520 WINDOW can be an arbitrary window and defaults to the selected
521 one. Optional argument HORIZONTAL non-nil means return the
522 minimum number of columns of WINDOW; otherwise return the minimum
523 number of WINDOW's lines.
525 Optional argument IGNORE, if non-nil, means ignore restrictions
526 imposed by fixed size windows, `window-min-height' or
527 `window-min-width' settings. If IGNORE equals `safe', live
528 windows may get as small as `window-safe-min-height' lines and
529 `window-safe-min-width' columns. If IGNORE is a window, ignore
530 restrictions for that window only. Any other non-nil value
531 means ignore all of the above restrictions for all windows."
536 "Internal function of `window-min-size'."
540 ;; WINDOW is an internal window.
542 ;; The minimum size of an iso-combination is the sum of
543 ;; the minimum sizes of its child windows.
548 ;; The minimum size of an ortho-combination is the maximum of
549 ;; the minimum sizes of its child windows.
554 value)
559 ;; The minimum size of a fixed size window is its size.
562 ;; If IGNORE equals `safe' or WINDOW return the safe values.
565 ;; For the minimum width of a window take fringes and
566 ;; scroll-bars into account. This is questionable and should
567 ;; be removed as soon as we are able to split (and resize)
568 ;; windows such that the new (or resized) windows can get a
569 ;; size less than the user-specified `window-min-height' and
570 ;; `window-min-width'.
575 (+ window-safe-min-width
588 window-min-width
591 ;; For the minimum height of a window take any mode- or
592 ;; header-line into account.
598 window-min-height
602 "Return DELTA if DELTA lines can be added to WINDOW.
603 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
604 columns can be added to WINDOW. A return value of zero means
605 that no lines (or columns) can be added to WINDOW.
607 This function looks only at WINDOW and, recursively, its child
608 windows. The function `window-resizable' looks at other windows
609 as well.
611 DELTA positive means WINDOW shall be enlarged by DELTA lines or
612 columns. If WINDOW cannot be enlarged by DELTA lines or columns
613 return the maximum value in the range 0..DELTA by which WINDOW
614 can be enlarged.
616 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
617 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
618 return the minimum value in the range DELTA..0 by which WINDOW
619 can be shrunk.
621 Optional argument IGNORE non-nil means ignore restrictions
622 imposed by fixed size windows, `window-min-height' or
623 `window-min-width' settings. If IGNORE equals `safe', live
624 windows may get as small as `window-safe-min-height' lines and
625 `window-safe-min-width' columns. If IGNORE is a window, ignore
626 restrictions for that window only. Any other non-nil value means
627 ignore all of the above restrictions for all windows."
633 delta))
635 delta)
638 0
639 delta))
643 "Return t if WINDOW can be resized by DELTA lines.
644 For the meaning of the arguments of this function see the
645 doc-string of `window-sizable'."
652 "Internal function for `window-size-fixed-p'."
656 ;; WINDOW is an internal window.
658 ;; An iso-combination is fixed size if all its child
659 ;; windows are fixed-size.
663 ;; We found a non-fixed-size child window, so
664 ;; WINDOW's size is not fixed.
667 ;; All child windows are fixed-size, so WINDOW's size is
668 ;; fixed.
670 ;; An ortho-combination is fixed-size if at least one of its
671 ;; child windows is fixed-size.
674 ;; We found a fixed-size child window, so WINDOW's size
675 ;; is fixed.
678 ;; WINDOW is a live window.
685 "Return non-nil if WINDOW's height is fixed.
686 WINDOW can be an arbitrary window and defaults to the selected
687 window. Optional argument HORIZONTAL non-nil means return
688 non-nil if WINDOW's width is fixed.
690 If this function returns nil, this does not necessarily mean that
691 WINDOW can be resized in the desired direction. The function
692 `window-resizable' can tell that."
697 "Internal function for `window-min-delta'."
699 ;; If we can't go up, return zero.
700 0
701 ;; Else try to find a non-fixed-size sibling of WINDOW.
706 ;; In an iso-combination throw DELTA if we find at least one
707 ;; child window and that window is either not fixed-size or
708 ;; we can ignore fixed-sizeness.
718 ;; We found a non-fixed-size child window.
721 ;; In an ortho-combination set DELTA to the minimum value by
722 ;; which other child windows can shrink.
731 delta
735 "Return number of lines by which WINDOW can be shrunk.
736 WINDOW can be an arbitrary window and defaults to the selected
737 window. Return zero if WINDOW cannot be shrunk.
739 Optional argument HORIZONTAL non-nil means return number of
740 columns by which WINDOW can be shrunk.
742 Optional argument IGNORE non-nil means ignore restrictions
743 imposed by fixed size windows, `window-min-height' or
744 `window-min-width' settings. If IGNORE is a window, ignore
745 restrictions for that window only. If IGNORE equals `safe',
746 live windows may get as small as `window-safe-min-height' lines
747 and `window-safe-min-width' columns. Any other non-nil value
748 means ignore all of the above restrictions for all windows.
750 Optional argument TRAIL restricts the windows that can be enlarged.
751 If its value is `before', only windows to the left of or above WINDOW
752 can be enlarged. If it is `after', only windows to the right of or
753 below WINDOW can be enlarged.
755 Optional argument NOUP non-nil means don't go up in the window
756 tree, but try to enlarge windows within WINDOW's combination only.
758 Optional argument NODOWN non-nil means don't check whether WINDOW
759 itself (and its child windows) can be shrunk; check only whether
760 at least one other window can be enlarged appropriately."
766 ;; If NODOWN is t, try to recover the entire size of WINDOW.
769 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
770 ;; there's nothing to recover.
773 ;; Otherwise, try to recover whatever WINDOW is larger than its
774 ;; minimum size.
779 "Internal function of `window-max-delta'."
781 ;; Can't go up. Return DELTA.
782 delta
787 ;; For an iso-combination calculate how much we can get from
788 ;; other child windows.
797 (+ delta
801 ;; For an ortho-combination throw DELTA when at least one
802 ;; child window is fixed-size.
810 ;; When NOUP is nil, DELTA is all we can get.
811 delta
812 ;; Else try with parent of WINDOW, passing the DELTA we
813 ;; recovered so far.
817 "Return maximum number of lines by which WINDOW can be enlarged.
818 WINDOW can be an arbitrary window and defaults to the selected
819 window. The return value is zero if WINDOW cannot be enlarged.
821 Optional argument HORIZONTAL non-nil means return maximum number
822 of columns by which WINDOW can be enlarged.
824 Optional argument IGNORE non-nil means ignore restrictions
825 imposed by fixed size windows, `window-min-height' or
826 `window-min-width' settings. If IGNORE is a window, ignore
827 restrictions for that window only. If IGNORE equals `safe',
828 live windows may get as small as `window-safe-min-height' lines
829 and `window-safe-min-width' columns. Any other non-nil value means
830 ignore all of the above restrictions for all windows.
832 Optional argument TRAIL restricts the windows that can be enlarged.
833 If its value is `before', only windows to the left of or above WINDOW
834 can be enlarged. If it is `after', only windows to the right of or
835 below WINDOW can be enlarged.
837 Optional argument NOUP non-nil means don't go up in the window
838 tree but try to obtain the entire space from windows within
839 WINDOW's combination.
841 Optional argument NODOWN non-nil means do not check whether
842 WINDOW itself (and its child windows) can be enlarged; check
843 only whether other windows can be shrunk appropriately."
847 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
848 ;; size.
849 0
850 ;; WINDOW has no fixed size.
853 ;; Make NOUP also inhibit the min-size check.
855 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
856 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
857 can be resized horizontally by DELTA columns. A return value of
858 zero means that WINDOW is not resizable.
860 DELTA positive means WINDOW shall be enlarged by DELTA lines or
861 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
862 return the maximum value in the range 0..DELTA by which WINDOW
863 can be enlarged.
865 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
866 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
867 return the minimum value in the range DELTA..0 that can be used
868 for shrinking WINDOW.
870 Optional argument IGNORE non-nil means ignore restrictions
871 imposed by fixed size windows, `window-min-height' or
872 `window-min-width' settings. If IGNORE is a window, ignore
873 restrictions for that window only. If IGNORE equals `safe',
874 live windows may get as small as `window-safe-min-height' lines
875 and `window-safe-min-width' columns. Any other non-nil value
876 means ignore all of the above restrictions for all windows.
878 Optional argument TRAIL `before' means only windows to the left
879 of or below WINDOW can be shrunk. Optional argument TRAIL
880 `after' means only windows to the right of or above WINDOW can be
881 shrunk.
883 Optional argument NOUP non-nil means don't go up in the window
884 tree but check only whether space can be obtained from (or given
885 to) WINDOW's siblings.
887 Optional argument NODOWN non-nil means don't go down in the
888 window tree. This means do not check whether resizing would
889 violate size restrictions of WINDOW or its child windows."
894 delta))
897 delta))
901 "Return t if WINDOW can be resized vertically by DELTA lines.
902 For the meaning of the arguments of this function see the
903 doc-string of `window--resizable'."
907 delta)
909 delta)))
912 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
913 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
914 can be resized horizontally by DELTA columns. A return value of
915 zero means that WINDOW is not resizable.
917 DELTA positive means WINDOW shall be enlarged by DELTA lines or
918 columns. If WINDOW cannot be enlarged by DELTA lines or columns
919 return the maximum value in the range 0..DELTA by which WINDOW
920 can be enlarged.
922 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
923 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
924 return the minimum value in the range DELTA..0 that can be used
925 for shrinking WINDOW.
927 Optional argument IGNORE non-nil means ignore restrictions
928 imposed by fixed size windows, `window-min-height' or
929 `window-min-width' settings. If IGNORE is a window, ignore
930 restrictions for that window only. If IGNORE equals `safe',
931 live windows may get as small as `window-safe-min-height' lines
932 and `window-safe-min-width' columns. Any other non-nil value
933 means ignore all of the above restrictions for all windows."
938 "Return the total height or width of WINDOW.
939 If WINDOW is omitted or nil, it defaults to the selected window.
941 If HORIZONTAL is omitted or nil, return the total height of
942 WINDOW, in lines, like `window-total-height'. Otherwise return
943 the total width, in columns, like `window-total-width'."
948 ;; Eventually we should make `window-height' obsolete.
951 ;; See discussion in bug#4543.
953 "Return t if WINDOW is as high as its containing frame.
954 More precisely, return t if and only if the total height of
955 WINDOW equals the total height of the root window of WINDOW's
956 frame. WINDOW can be any window and defaults to the selected
957 one."
963 "Return t if WINDOW is as wide as its containing frame.
964 More precisely, return t if and only if the total width of WINDOW
965 equals the total width of the root window of WINDOW's frame.
966 WINDOW can be any window and defaults to the selected one."
972 "Return the height or width of WINDOW's text area.
973 If WINDOW is omitted or nil, it defaults to the selected window.
974 Signal an error if the window is not live.
976 If HORIZONTAL is omitted or nil, return the height of the text
977 area, like `window-body-height'. Otherwise, return the width of
978 the text area, like `window-body-width'."
983 ;; Eventually we should make `window-height' obsolete.
987 "Return the current scroll bar settings for WINDOW.
988 WINDOW must be a live window and defaults to the selected one.
990 The return value is a cons cell (VERTICAL . HORIZONTAL) where
991 VERTICAL specifies the current location of the vertical scroll
992 bars (`left', `right', or nil), and HORIZONTAL specifies the
993 current location of the horizontal scroll bars (`top', `bottom',
994 or nil).
996 Unlike `window-scroll-bars', this function reports the scroll bar
997 type actually used, once frame defaults and `scroll-bar-mode' are
998 taken into account."
1011 "Cycle through all live windows, calling FUN for each one.
1012 FUN must specify a function with a window as its sole argument.
1013 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1014 windows to include in the walk.
1016 MINIBUF t means include the minibuffer window even if the
1017 minibuffer is not active. MINIBUF nil or omitted means include
1018 the minibuffer window only if the minibuffer is active. Any
1019 other value means do not include the minibuffer window even if
1020 the minibuffer is active.
1022 ALL-FRAMES nil or omitted means consider all windows on the
1023 selected frame, plus the minibuffer window if specified by the
1024 MINIBUF argument. If the minibuffer counts, consider all windows
1025 on all frames that share that minibuffer too. The following
1026 non-nil values of ALL-FRAMES have special meanings:
1028 - t means consider all windows on all existing frames.
1030 - `visible' means consider all windows on all visible frames on
1031 the current terminal.
1033 - 0 (the number zero) means consider all windows on all visible
1034 and iconified frames on the current terminal.
1036 - A frame means consider all windows on that frame only.
1038 Anything else means consider all windows on the selected frame
1039 and no others.
1041 This function changes neither the order of recently selected
1042 windows nor the buffer list."
1043 ;; If we start from the minibuffer window, don't fail to come
1044 ;; back to it.
1047 ;; Make sure to not mess up the order of recently selected
1048 ;; windows. Use `save-selected-window' and `select-window'
1049 ;; with second argument non-nil for this purpose.
1057 "Return value of WINDOW's point.
1058 WINDOW can be any live window and defaults to the selected one.
1060 This function is like `window-point' with one exception: If
1061 WINDOW is selected, it returns the value of `point' of WINDOW's
1062 buffer regardless of whether that buffer is current or not."
1070 "Set value of WINDOW's point to POS.
1071 WINDOW can be any live window and defaults to the selected one.
1073 This function is like `set-window-point' with one exception: If
1074 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1075 regardless of whether that buffer is current or not."
1083 "Return t if WINDOW is at SIDE of its containing frame.
1084 WINDOW can be any window and defaults to the selected one. SIDE
1085 can be any of the symbols `left', `top', `right' or `bottom'.
1086 The default value nil is handled like `bottom'."
1098 "Return list of all windows on SIDE of FRAME.
1099 FRAME must be a live frame and defaults to the selected frame.
1100 SIDE can be any of the symbols `left', `top', `right' or
1101 `bottom'. The default value nil is handled like `bottom'."
1108 frame)
1112 "Support function for `window-in-direction'."
1124 "Return window in DIRECTION as seen from WINDOW.
1125 DIRECTION must be one of `above', `below', `left' or `right'.
1126 WINDOW must be a live window and defaults to the selected one.
1127 IGNORE non-nil means a window can be returned even if its
1128 `no-other-window' parameter is non-nil."
1141 ;; The column / row value of `posn-at-point' can be nil for the
1142 ;; mini-window, guard against that.
1153 best best-2 best-diff-2-new)
1160 ;; Ignore ourselves.
1162 ;; Ignore W unless IGNORE is non-nil.
1168 ;; W is to the left or right of WINDOW and covers POSN.
1178 ;; W is to the left or right of WINDOW but does not
1179 ;; cover POSN.
1194 ;; W is above or below WINDOW and covers POSN.
1204 ;; W is above or below WINDOW but does not cover POSN.
1219 "Return a live window satisfying PREDICATE.
1220 More precisely, cycle through all windows calling the function
1221 PREDICATE on each one of them with the window as its sole
1222 argument. Return the first window for which PREDICATE returns
1223 non-nil. Windows are scanned starting with the window following
1224 the selected window. If no window satisfies PREDICATE, return
1225 DEFAULT.
1227 MINIBUF t means include the minibuffer window even if the
1228 minibuffer is not active. MINIBUF nil or omitted means include
1229 the minibuffer window only if the minibuffer is active. Any
1230 other value means do not include the minibuffer window even if
1231 the minibuffer is active.
1233 ALL-FRAMES nil or omitted means consider all windows on the selected
1234 frame, plus the minibuffer window if specified by the MINIBUF
1235 argument. If the minibuffer counts, consider all windows on all
1236 frames that share that minibuffer too. The following non-nil
1237 values of ALL-FRAMES have special meanings:
1239 - t means consider all windows on all existing frames.
1241 - `visible' means consider all windows on all visible frames on
1242 the current terminal.
1244 - 0 (the number zero) means consider all windows on all visible
1245 and iconified frames on the current terminal.
1247 - A frame means consider all windows on that frame only.
1249 Anything else means consider all windows on the selected frame
1250 and no others."
1254 minibuf all-frames))
1257 default))
1262 "Return the least recently used window on frames specified by ALL-FRAMES.
1263 Return a full-width window if possible. A minibuffer window is
1264 never a candidate. A dedicated window is never a candidate
1265 unless DEDICATED is non-nil, so if all windows are dedicated, the
1266 value is nil. Avoid returning the selected window if possible.
1267 Optional argument NOT-SELECTED non-nil means never return the
1268 selected window.
1270 The following non-nil values of the optional argument ALL-FRAMES
1271 have special meanings:
1273 - t means consider all windows on all existing frames.
1275 - `visible' means consider all windows on all visible frames on
1276 the current terminal.
1278 - 0 (the number zero) means consider all windows on all visible
1279 and iconified frames on the current terminal.
1281 - A frame means consider all windows on that frame only.
1283 Any other value of ALL-FRAMES means consider all windows on the
1284 selected frame and no others."
1301 "Return the most recently used window on frames specified by ALL-FRAMES.
1302 A minibuffer window is never a candidate. A dedicated window is
1303 never a candidate unless DEDICATED is non-nil, so if all windows
1304 are dedicated, the value is nil. Optional argument NOT-SELECTED
1305 non-nil means never return the selected window.
1307 The following non-nil values of the optional argument ALL-FRAMES
1308 have special meanings:
1310 - t means consider all windows on all existing frames.
1312 - `visible' means consider all windows on all visible frames on
1313 the current terminal.
1315 - 0 (the number zero) means consider all windows on all visible
1316 and iconified frames on the current terminal.
1318 - A frame means consider all windows on that frame only.
1320 Any other value of ALL-FRAMES means consider all windows on the
1321 selected frame and no others."
1330 best-window))
1333 "Return the largest window on frames specified by ALL-FRAMES.
1334 A minibuffer window is never a candidate. A dedicated window is
1335 never a candidate unless DEDICATED is non-nil, so if all windows
1336 are dedicated, the value is nil. Optional argument NOT-SELECTED
1337 non-nil means never return the selected window.
1339 The following non-nil values of the optional argument ALL-FRAMES
1340 have special meanings:
1342 - t means consider all windows on all existing frames.
1344 - `visible' means consider all windows on all visible frames on
1345 the current terminal.
1347 - 0 (the number zero) means consider all windows on all visible
1348 and iconified frames on the current terminal.
1350 - A frame means consider all windows on that frame only.
1352 Any other value of ALL-FRAMES means consider all windows on the
1353 selected frame and no others."
1355 best-window size)
1364 best-window))
1367 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1368 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1369 and defaults to the current buffer. Windows are scanned starting
1370 with the selected window.
1372 MINIBUF t means include the minibuffer window even if the
1373 minibuffer is not active. MINIBUF nil or omitted means include
1374 the minibuffer window only if the minibuffer is active. Any
1375 other value means do not include the minibuffer window even if
1376 the minibuffer is active.
1378 ALL-FRAMES nil or omitted means consider all windows on the
1379 selected frame, plus the minibuffer window if specified by the
1380 MINIBUF argument. If the minibuffer counts, consider all windows
1381 on all frames that share that minibuffer too. The following
1382 non-nil values of ALL-FRAMES have special meanings:
1384 - t means consider all windows on all existing frames.
1386 - `visible' means consider all windows on all visible frames on
1387 the current terminal.
1389 - 0 (the number zero) means consider all windows on all visible
1390 and iconified frames on the current terminal.
1392 - A frame means consider all windows on that frame only.
1394 Anything else means consider all windows on the selected frame
1395 and no others."
1397 windows)
1404 "Return t if WINDOW is the currently active minibuffer window."
1408 "Return the number of live windows on the selected frame.
1409 The optional argument MINIBUF specifies whether the minibuffer
1410 window shall be counted. See `walk-windows' for the precise
1411 meaning of this argument."
1413 \f
1414 ;;; Resizing windows.
1416 "Reset resize values for all windows on FRAME.
1417 FRAME defaults to the selected frame.
1419 This function stores the current value of `window-total-size' applied
1420 with argument HORIZONTAL in the new total size of all windows on
1421 FRAME. It also resets the new normal size of each of these
1422 windows."
1427 "Internal function of `window--resize-reset'."
1428 ;; Register old size in the new total size.
1430 ;; Reset new normal size.
1437 ;; The following routine is used to manually resize the minibuffer
1438 ;; window and is currently used, for example, by ispell.el.
1440 "Resize minibuffer window WINDOW by DELTA lines.
1441 If WINDOW cannot be resized by DELTA lines make it as large (or
1442 as small) as possible, but don't signal an error."
1450 ;; Sanitize DELTA.
1457 ;; Resize now.
1459 ;; Ideally we should be able to resize just the last child of root
1460 ;; here. See the comment in `resize-root-window-vertically' for
1461 ;; why we do not do that.
1464 ;; The following routine catches the case where we want to resize
1465 ;; a minibuffer-only frame.
1469 "Resize WINDOW vertically by DELTA lines.
1470 WINDOW can be an arbitrary window and defaults to the selected
1471 one. An attempt to resize the root window of a frame will raise
1472 an error though.
1474 DELTA a positive number means WINDOW shall be enlarged by DELTA
1475 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1476 lines.
1478 Optional argument HORIZONTAL non-nil means resize WINDOW
1479 horizontally by DELTA columns. In this case a positive DELTA
1480 means enlarge WINDOW by DELTA columns. DELTA negative means
1481 WINDOW shall be shrunk by -DELTA columns.
1483 Optional argument IGNORE non-nil means ignore restrictions
1484 imposed by fixed size windows, `window-min-height' or
1485 `window-min-width' settings. If IGNORE is a window, ignore
1486 restrictions for that window only. If IGNORE equals `safe',
1487 live windows may get as small as `window-safe-min-height' lines
1488 and `window-safe-min-width' columns. Any other non-nil value
1489 means ignore all of the above restrictions for all windows.
1491 This function resizes other windows proportionally and never
1492 deletes any windows. If you want to move only the low (right)
1493 edge of WINDOW consider using `adjust-window-trailing-edge'
1494 instead."
1498 sibling)
1511 ;; If WINDOW is full height and either `resize-mini-windows' is
1512 ;; nil or the minibuffer window is active, resize the minibuffer
1513 ;; window.
1522 ;; If window-combination-resize is nil, WINDOW is part of an
1523 ;; iso-combination, and WINDOW's neighboring right or left
1524 ;; sibling can be resized as requested, resize that sibling.
1531 normal-delta))
1534 normal-delta)))
1535 ;; Otherwise, resize all other windows in the same combination.
1542 "Return non-nil if WINDOW shall be skipped by resizing routines."
1545 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1546 "Recursively set new normal height of child windows of window PARENT.
1547 HORIZONTAL non-nil means set the new normal width of these
1548 windows. WINDOW specifies a child window of PARENT that has been
1549 resized by THIS-DELTA lines (columns).
1551 Optional argument TRAIL either `before' or `after' means set values
1552 only for windows before or after WINDOW. Optional argument
1553 OTHER-DELTA, a number, specifies that this many lines (columns)
1554 have been obtained from (or returned to) an ancestor window of
1555 PARENT in order to resize WINDOW."
1559 ;; When WINDOW gets deleted and we can return its entire
1560 ;; space to its siblings, use WINDOW's normal size as the
1561 ;; normal delta.
1563 ;; In any other case calculate the normal delta from the
1564 ;; relation of THIS-DELTA to the total size of PARENT.
1570 ;; Set parent-normal to the sum of the normal sizes of all child
1571 ;; windows of PARENT that shall be resized, excluding only WINDOW
1572 ;; and any windows specified by the optional TRAIL argument.
1583 ;; Set the new normal size of all child windows of PARENT from what
1584 ;; they should have contributed for recovering THIS-DELTA lines
1585 ;; (columns).
1599 delta-normal))
1600 ;; Don't drop below 0.
1605 ;; Set the new normal size of windows from what they should have
1606 ;; contributed for recovering OTHER-DELTA lines (columns).
1609 other-delta)))
1621 ;; Don't drop below 0.
1625 ;; Set the new normal size of WINDOW to what is left by the sum of
1626 ;; the normal sizes of its siblings.
1628 window
1639 ;; Don't get larger than 1 or smaller than 0.
1642 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1643 "Resize child windows of window PARENT vertically by DELTA lines.
1644 PARENT must be a vertically combined internal window.
1646 Optional argument HORIZONTAL non-nil means resize child windows of
1647 PARENT horizontally by DELTA columns. In this case PARENT must
1648 be a horizontally combined internal window.
1650 WINDOW, if specified, must denote a child window of PARENT that
1651 is resized by DELTA lines.
1653 Optional argument IGNORE non-nil means ignore restrictions
1654 imposed by fixed size windows, `window-min-height' or
1655 `window-min-width' settings. If IGNORE equals `safe', live
1656 windows may get as small as `window-safe-min-height' lines and
1657 `window-safe-min-width' columns. If IGNORE is a window, ignore
1658 restrictions for that window only. Any other non-nil value means
1659 ignore all of the above restrictions for all windows.
1661 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1662 of windows that shall be resized. If TRAIL equals `before',
1663 resize only windows on the left or above EDGE. If TRAIL equals
1664 `after', resize only windows on the right or below EDGE. Also,
1665 preferably only resize windows adjacent to EDGE.
1667 Return the symbol `normalized' if new normal sizes have been
1668 already set by this routine."
1672 best-window best-value)
1684 sub)
1689 edge)
1694 edge)
1697 ;; Resize only windows adjacent to EDGE.
1700 sub delta horizontal ignore t trail edge)
1703 ;; Assign new normal sizes.
1712 ;; Return 'normalized to notify `window--resize-siblings' that
1713 ;; normal sizes have been already set.
1715 ;; Resize all windows proportionally.
1720 ;; Ignore windows to skip and fixed-size child windows -
1721 ;; in the latter case make it a window to skip.
1726 ;; When shrinking store the number of lines/cols we can get
1727 ;; from this window here together with the total/normal size
1728 ;; factor.
1730 sub
1732 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1735 parent-total)
1738 ;; When enlarging store the total/normal size factor only
1740 sub
1742 parent-total)
1749 ;; Shrink windows by delta.
1768 best-window
1773 parent-total)
1776 ;; Enlarge windows by delta.
1794 best-window
1796 parent-total)
1804 ;; Reset new normal size fields so `window-resize-apply'
1805 ;; won't use them to apply new sizes.
1809 ;; Resize this window's child windows (back-engineering
1810 ;; delta from sub's old and new total sizes).
1814 ;; For the TRAIL non-nil case we have to resize SUB
1815 ;; recursively even if it's size does not change.
1817 sub delta horizontal ignore nil trail edge))))
1821 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1822 Optional argument HORIZONTAL non-nil means resize other windows
1823 when WINDOW is resized horizontally by DELTA columns. WINDOW
1824 itself is not resized by this function.
1826 Optional argument IGNORE non-nil means ignore restrictions
1827 imposed by fixed size windows, `window-min-height' or
1828 `window-min-width' settings. If IGNORE equals `safe', live
1829 windows may get as small as `window-safe-min-height' lines and
1830 `window-safe-min-width' columns. If IGNORE is a window, ignore
1831 restrictions for that window only. Any other non-nil value means
1832 ignore all of the above restrictions for all windows.
1834 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1835 of windows that shall be resized. If TRAIL equals `before',
1836 resize only windows on the left or above EDGE. If TRAIL equals
1837 `after', resize only windows on the right or below EDGE. Also,
1838 preferably only resize windows adjacent to EDGE."
1843 ;; In an iso-combination try to extract DELTA from WINDOW's
1844 ;; siblings.
1846 this-delta other-delta)
1847 ;; Decide which windows shall be left alone.
1851 ;; Make sure WINDOW is left alone when
1852 ;; resizing its siblings.
1856 ;; Make sure this sibling is left alone when
1857 ;; resizing its siblings.
1861 ;; Set this-delta to t to signal that we found a sibling
1862 ;; of WINDOW whose size is not fixed.
1867 ;; Set this-delta to what we can get from WINDOW's siblings.
1869 ;; A deletion, presumably. We must handle this case
1870 ;; specially since `window--resizable' can't be used.
1872 ;; There's at least one resizable sibling we can
1873 ;; give WINDOW's size to.
1875 ;; No resizable sibling exists.
1877 ;; Any other form of resizing.
1881 ;; Set other-delta to what we still have to get from
1882 ;; ancestor windows of parent.
1885 ;; Unless we got everything from WINDOW's siblings, PARENT
1886 ;; must be resized by other-delta lines or columns.
1890 ;; We haven't got anything from WINDOW's siblings but we
1891 ;; must update the normal sizes to respect other-delta.
1893 parent horizontal window this-delta trail other-delta)
1894 ;; We did get something from WINDOW's siblings which means
1895 ;; we have to resize their child windows.
1898 window ignore trail edge)
1899 ;; If `window--resize-child-windows' returns
1900 ;; 'normalized, this means it has set the
1901 ;; normal sizes already.
1903 ;; Set the normal sizes.
1905 parent horizontal window this-delta trail other-delta))
1906 ;; Set DELTA to what we still have to get from ancestor
1907 ;; windows.
1910 ;; In an ortho-combination all siblings of WINDOW must be
1911 ;; resized by DELTA.
1919 ;; "Go up."
1921 parent delta horizontal ignore trail edge)))))
1924 "Resize WINDOW vertically by DELTA lines.
1925 Optional argument HORIZONTAL non-nil means resize WINDOW
1926 horizontally by DELTA columns.
1928 Optional argument IGNORE non-nil means ignore restrictions
1929 imposed by fixed size windows, `window-min-height' or
1930 `window-min-width' settings. If IGNORE equals `safe', live
1931 windows may get as small as `window-safe-min-height' lines and
1932 `window-safe-min-width' columns. If IGNORE is a window, ignore
1933 restrictions for that window only. Any other non-nil value
1934 means ignore all of the above restrictions for all windows.
1936 Optional argument ADD non-nil means add DELTA to the new total
1937 size of WINDOW.
1939 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1940 of windows that shall be resized. If TRAIL equals `before',
1941 resize only windows on the left or above EDGE. If TRAIL equals
1942 `after', resize only windows on the right or below EDGE. Also,
1943 preferably only resize windows adjacent to EDGE.
1945 This function recursively resizes WINDOW's child windows to fit the
1946 new size. Make sure that WINDOW is `window--resizable' before
1947 calling this function. Note that this function does not resize
1948 siblings of WINDOW or WINDOW's parent window. You have to
1949 eventually call `window-resize-apply' in order to make resizing
1950 actually take effect."
1952 ;; Add DELTA to the new total size of WINDOW.
1959 ;; In an iso-combination resize child windows according to their
1960 ;; normal sizes.
1962 window delta horizontal nil ignore trail edge))
1963 ;; In an ortho-combination resize each child window by DELTA.
1967 sub delta horizontal ignore t trail edge)
1971 "Resize root window WINDOW vertically by DELTA lines.
1972 HORIZONTAL non-nil means resize root window WINDOW horizontally
1973 by DELTA columns.
1975 IGNORE non-nil means ignore any restrictions imposed by fixed
1976 size windows, `window-min-height' or `window-min-width' settings.
1978 This function is only called by the frame resizing routines. It
1979 resizes windows proportionally and never deletes any windows."
1986 "Resize root window WINDOW vertically by DELTA lines.
1987 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1988 lines, shrink it as much as possible. If DELTA is greater than
1989 zero, this function can resize fixed-size windows in order to
1990 recover the necessary lines.
1992 Return the number of lines that were recovered.
1994 This function is only called by the minibuffer window resizing
1995 routines. It resizes windows proportionally and never deletes
1996 any windows."
2007 ;; Ideally, we would resize just the last window in a combination
2008 ;; but that's not feasible for the following reason: If we grow
2009 ;; the minibuffer window and the last window cannot be shrunk any
2010 ;; more, we shrink another window instead. But if we then shrink
2011 ;; the minibuffer window again, the last window might get enlarged
2012 ;; and the state after shrinking is not the state before growing.
2013 ;; So, in practice, we'd need a history variable to record how to
2014 ;; proceed. But I'm not sure how such a variable could work with
2015 ;; repeated minibuffer window growing steps.
2017 delta)))
2020 "Move WINDOW's bottom edge by DELTA lines.
2021 Optional argument HORIZONTAL non-nil means move WINDOW's right
2022 edge by DELTA columns. WINDOW defaults to the selected window.
2024 If DELTA is greater than zero, move the edge downwards or to the
2025 right. If DELTA is less than zero, move the edge upwards or to
2026 the left. If the edge can't be moved by DELTA lines or columns,
2027 move it as far as possible in the desired direction."
2032 left this-delta min-delta max-delta)
2033 ;; Find the edge we want to move.
2039 ;; Resize the minibuffer window if it's on the same frame as
2040 ;; and immediately below WINDOW and it's either active or
2041 ;; `resize-mini-windows' is nil.
2053 ;; Set LEFT to the first resizable window on the left. This step is
2054 ;; needed to handle fixed-size windows.
2067 ;; Set RIGHT to the first resizable window on the right. This step
2068 ;; is needed to handle fixed-size windows.
2081 ;; LEFT and RIGHT (which might be both internal windows) are now the
2082 ;; two windows we want to resize.
2088 ;; We can't get the whole DELTA - move as far as possible.
2091 ;; Start resizing.
2093 ;; Try to enlarge LEFT first.
2097 left this-delta horizontal nil t 'before
2101 ;; Shrink windows on right of LEFT.
2103 left delta horizontal nil 'after
2111 ;; We can't get the whole DELTA - move as far as possible.
2114 ;; Start resizing.
2116 ;; Try to enlarge RIGHT.
2120 right this-delta horizontal nil t 'after
2124 ;; Shrink windows on left of RIGHT.
2131 ;; Don't report an error in the standard case.
2133 ;; But do report an error if applying the changes fails.
2137 "Make the selected window DELTA lines taller.
2138 Interactively, if no argument is given, make the selected window
2139 one line taller. If optional argument HORIZONTAL is non-nil,
2140 make selected window wider by DELTA columns. If DELTA is
2141 negative, shrink selected window by -DELTA lines or columns.
2142 Return nil."
2157 ;; If the selected window is full height and `resize-mini-windows'
2158 ;; is nil, resize the minibuffer window.
2167 horizontal)))))
2170 "Make the selected window DELTA lines smaller.
2171 Interactively, if no argument is given, make the selected window
2172 one line smaller. If optional argument HORIZONTAL is non-nil,
2173 make selected window narrower by DELTA columns. If DELTA is
2174 negative, enlarge selected window by -DELTA lines or columns.
2175 Also see the `window-min-height' variable.
2176 Return nil."
2191 ;; If the selected window is full height and `resize-mini-windows'
2192 ;; is nil, resize the minibuffer window.
2201 horizontal)))))
2204 "Maximize WINDOW.
2205 Make WINDOW as large as possible without deleting any windows.
2206 WINDOW can be any window and defaults to the selected window."
2213 "Minimize WINDOW.
2214 Make WINDOW as small as possible without deleting any windows.
2215 WINDOW can be any window and defaults to the selected window."
2220 \f
2222 "Return non-nil if WINDOW is the root window of its frame."
2226 "Return window subtree rooted at WINDOW.
2227 Optional argument NEXT non-nil means include WINDOW's right
2228 siblings in the return value.
2230 See the documentation of `window-tree' for a description of the
2231 return value."
2244 list))
2249 "Return the window tree of frame FRAME.
2250 FRAME must be a live frame and defaults to the selected frame.
2251 The return value is a list of the form (ROOT MINI), where ROOT
2252 represents the window tree of the frame's root window, and MINI
2253 is the frame's minibuffer window.
2255 If the root window is not split, ROOT is the root window itself.
2256 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2257 for a horizontal split, and t for a vertical split. EDGES gives
2258 the combined size and position of the child windows in the split,
2259 and the rest of the elements are the child windows in the split.
2260 Each of the child windows may again be a window or a list
2261 representing a window split, and so on. EDGES is a list (LEFT
2262 TOP RIGHT BOTTOM) as returned by `window-edges'."
2265 \f
2267 "Select another window in cyclic ordering of windows.
2268 COUNT specifies the number of windows to skip, starting with the
2269 selected window, before making the selection. If COUNT is
2270 positive, skip COUNT windows forwards. If COUNT is negative,
2271 skip -COUNT windows backwards. COUNT zero means do not skip any
2272 window, so select the selected window. In an interactive call,
2273 COUNT is the numeric prefix argument. Return nil.
2275 If the `other-window' parameter of the selected window is a
2276 function and `ignore-window-parameters' is nil, call that
2277 function with the arguments COUNT and ALL-FRAMES.
2279 This function does not select a window whose `no-other-window'
2280 window parameter is non-nil.
2282 This function uses `next-window' for finding the window to
2283 select. The argument ALL-FRAMES has the same meaning as in
2284 `next-window', but the MINIBUF argument of `next-window' is
2285 always effectively nil."
2290 old-window old-count)
2293 ;; `next-window' and `previous-window' may return a window we are
2294 ;; not allowed to select. Hence we need an exit strategy in case
2295 ;; all windows are non-selectable.
2302 ;; Keep out of infinite loops. When COUNT has not changed
2303 ;; since we last looked at `window' we're probably in one.
2307 ;; The first non-selectable window `next-window' got us:
2308 ;; Remember it and the current value of COUNT.
2318 ;; Keep out of infinite loops. When COUNT has not changed
2319 ;; since we last looked at `window' we're probably in one.
2323 ;; The first non-selectable window `previous-window' got
2324 ;; us: Remember it and the current value of COUNT.
2331 ;; Always return nil.
2332 nil))))
2334 ;; This should probably return non-nil when the selected window is part
2335 ;; of an atomic window whose root is the frame's root window.
2337 "Return non-nil if the selected window is the only window.
2338 Optional arg NOMINI non-nil means don't count the minibuffer
2339 even if it is active. Otherwise, the minibuffer is counted
2340 when it is active.
2342 Optional argument ALL-FRAMES specifies the set of frames to
2343 consider, see also `next-window'. ALL-FRAMES nil or omitted
2344 means consider windows on the selected frame only, plus the
2345 minibuffer window if specified by the NOMINI argument. If the
2346 minibuffer counts, consider all windows on all frames that share
2347 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2348 with a special meaning are:
2350 - t means consider all windows on all existing frames.
2352 - `visible' means consider all windows on all visible frames on
2353 the current terminal.
2355 - 0 (the number zero) means consider all windows on all visible
2356 and iconified frames on the current terminal.
2358 - A frame means consider all windows on that frame only.
2360 Anything else means consider all windows on the selected frame
2361 and no others."
2367 \f
2368 ;;; Deleting windows.
2370 "Return t if WINDOW can be safely deleted from its frame.
2371 Return `frame' if deleting WINDOW should also delete its
2372 frame."
2376 ;; Handle atomicity.
2384 ;; WINDOW's frame can be deleted only if there are other frames
2385 ;; on the same terminal, and it does not contain the active
2386 ;; minibuffer.
2394 ;; WINDOW can be deleted unless it is the main window of its
2395 ;; frame.
2396 t))))
2399 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2409 "Delete WINDOW.
2410 WINDOW can be an arbitrary window and defaults to the selected
2411 one. Return nil.
2413 If the variable `ignore-window-parameters' is non-nil or the
2414 `delete-window' parameter of WINDOW equals t, do not process any
2415 parameters of WINDOW. Otherwise, if the `delete-window'
2416 parameter of WINDOW specifies a function, call that function with
2417 WINDOW as its sole argument and return the value returned by that
2418 function.
2420 Otherwise, if WINDOW is part of an atomic window, call
2421 `delete-window' with the root of the atomic window as its
2422 argument. If WINDOW is the only window on its frame or the last
2423 non-side window, signal an error."
2429 atom-root)
2432 ;; Handle window parameters.
2434 ;; Ignore window parameters if `ignore-window-parameters' tells
2435 ;; us so or `delete-window' equals t.
2438 ;; The `delete-window' parameter specifies the function to call.
2439 ;; If that function is `ignore' nothing is done. It's up to the
2440 ;; function called here to avoid infinite recursion.
2457 ;; Emacs 23 preferably gives WINDOW's space to its left
2458 ;; sibling.
2464 ;; Resize WINDOW's sibling.
2470 ;; Can do without resizing fixed-size windows.
2473 ;; Can't do without resizing fixed-size windows.
2475 ;; Actually delete WINDOW.
2480 ;; `delete-window-internal' has selected a window that should
2481 ;; not be selected, fix this here.
2485 ;; Always return nil.
2486 nil))))
2489 "Make WINDOW fill its frame.
2490 WINDOW may be any window and defaults to the selected one.
2491 Return nil.
2493 If the variable `ignore-window-parameters' is non-nil or the
2494 `delete-other-windows' parameter of WINDOW equals t, do not
2495 process any parameters of WINDOW. Otherwise, if the
2496 `delete-other-windows' parameter of WINDOW specifies a function,
2497 call that function with WINDOW as its sole argument and return
2498 the value returned by that function.
2500 Otherwise, if WINDOW is part of an atomic window, call this
2501 function with the root of the atomic window as its argument. If
2502 WINDOW is a non-side window, make WINDOW the only non-side window
2503 on the frame. Side windows are not deleted. If WINDOW is a side
2504 window signal an error."
2510 atom-root side-main)
2514 ;; Ignore window parameters if `ignore-window-parameters' is t or
2515 ;; `delete-other-windows' is t.
2518 ;; The `delete-other-windows' parameter specifies the function
2519 ;; to call. If the function is `ignore' no windows are deleted.
2520 ;; It's up to the function called to avoid infinite recursion.
2527 ;; Set side-main to the major non-side window.
2531 ;; If WINDOW is the main non-side window, do nothing.
2536 ;; Always return nil.
2537 nil)))
2540 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2542 if you often split windows horizontally."
2554 ;;; Windows and buffers.
2556 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2557 ;; for (1) determining which buffer to show in the window when its
2558 ;; buffer shall be buried or killed and (2) which buffer to show for
2559 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2561 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2562 ;; triples. The entries on this list are ordered by the time their
2563 ;; buffer has been removed from the window, the most recently removed
2564 ;; buffer's entry being first. The window-start and window-point
2565 ;; components are `window-start' and `window-point' at the time the
2566 ;; buffer was removed from the window which implies that the entry must
2567 ;; be added when `set-window-buffer' removes the buffer from the window.
2569 ;; `next-buffers' is the list of buffers that have been replaced
2570 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2571 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2572 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2573 ;; reset to nil by any action changing the window's buffer with the
2574 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2575 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2576 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2578 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2579 ;; if such a buffer was killed while the window was hidden within a
2580 ;; window configuration. Such killed buffers get removed whenever
2581 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2583 ;; The following function is called by `set-window-buffer' _before_ it
2584 ;; replaces the buffer of the argument window with the new buffer.
2586 "Record WINDOW's buffer.
2587 WINDOW must be a live window and defaults to the selected one."
2591 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2592 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2596 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2600 ;; Don't record insignificant buffers.
2602 ;; Add an entry for buffer to WINDOW's previous buffers.
2609 ;; We have an entry, update marker positions.
2612 ;; Make new markers.
2620 "Unrecord BUFFER in WINDOW.
2621 WINDOW must be a live window and defaults to the selected one.
2622 BUFFER must be a live buffer and defaults to the buffer of
2623 WINDOW."
2632 "Set WINDOW's buffer to BUFFER.
2633 Optional argument START non-nil means set WINDOW's start position
2634 to START. Optional argument POINT non-nil means set WINDOW's
2635 point to POINT. If WINDOW is selected this also sets BUFFER's
2636 `point' to POINT. If WINDOW is selected and the buffer it showed
2637 before was current this also makes BUFFER the current buffer."
2644 ;; Don't force window-start here (even if POINT is nil).
2650 "If non-nil, allow switching to an already visible buffer.
2651 If this variable is non-nil, `switch-to-prev-buffer' and
2652 `switch-to-next-buffer' may switch to an already visible buffer
2653 provided the buffer was shown in the argument window before. If
2654 this variable is nil, `switch-to-prev-buffer' and
2655 `switch-to-next-buffer' always try to avoid switching to a buffer
2656 that is already visible in another window on the same frame."
2662 "In WINDOW switch to previous buffer.
2663 WINDOW must be a live window and defaults to the selected one.
2664 Return the buffer switched to, nil if no suitable buffer could be
2665 found.
2667 Optional argument BURY-OR-KILL non-nil means the buffer currently
2668 shown in WINDOW is about to be buried or killed and consequently
2669 shall not be switched to in future invocations of this command."
2674 ;; Save this since it's destroyed by `set-window-buffer'.
2676 entry buffer new-buffer killed-buffers visible)
2681 ;; Scan WINDOW's previous buffers first, skipping entries of next
2682 ;; buffers.
2692 ;; Try to avoid showing a buffer visible in some other window.
2698 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2699 ;; entries of next buffers. Note that when we bury or kill a
2700 ;; buffer we don't reverse the global buffer list to avoid showing
2701 ;; a buried buffer instead. Otherwise, we must reverse the global
2702 ;; buffer list in order to make sure that switching to the
2703 ;; previous/next buffer traverse it in opposite directions.
2712 ;; Try to avoid showing a buffer visible in some other window.
2719 ;; Scan reverted next buffers last (must not use nreverse
2720 ;; here!).
2722 ;; Actually, buffer _must_ be live here since otherwise it
2723 ;; would have been caught in the scan of previous buffers.
2734 ;; Show a buffer visible in another window.
2740 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2741 ;; of) next buffers.
2746 ;; Move `old-buffer' to head of WINDOW's restored list of next
2747 ;; buffers.
2751 ;; Remove killed buffers from WINDOW's previous and next buffers.
2759 ;; Return new-buffer.
2760 new-buffer))
2763 "In WINDOW switch to next buffer.
2764 WINDOW must be a live window and defaults to the selected one.
2765 Return the buffer switched to, nil if no suitable buffer could be
2766 found."
2772 buffer new-buffer entry killed-buffers visible)
2777 ;; Scan WINDOW's next buffers first.
2788 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2789 ;; buffers entries.
2795 ;; Try to avoid showing a buffer visible in some other window.
2800 ;; Scan WINDOW's reverted previous buffers last (must not use
2801 ;; nreverse here!)
2810 ;; Try to avoid showing a buffer visible in some other window.
2818 ;; Show a buffer visible in another window.
2823 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2826 ;; Remove killed buffers from WINDOW's previous and next buffers.
2834 ;; Return new-buffer.
2835 new-buffer))
2838 "Search LIST for a valid buffer to display in FRAME.
2839 Return nil when all buffers in LIST are undesirable for display,
2840 otherwise return the first suitable buffer in LIST.
2842 Buffers not visible in windows are preferred to visible buffers,
2843 unless VISIBLE-OK is non-nil.
2844 If the optional argument FRAME is nil, it defaults to the selected frame.
2845 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2846 ;; This logic is more or less copied from other-buffer.
2849 found buf)
2862 "Return the last buffer in FRAME's buffer list.
2863 If BUFFER is the last buffer, return the preceding buffer
2864 instead. Buffers not visible in windows are preferred to visible
2865 buffers, unless optional argument VISIBLE-OK is non-nil.
2866 Optional third argument FRAME nil or omitted means use the
2867 selected frame's buffer list. If no such buffer exists, return
2868 the buffer `*scratch*', creating it if necessary."
2871 buffer visible-ok frame)
2875 scratch)))
2878 "Function called to automatically hide frames.
2879 The function is called with one argument - a frame.
2881 Functions affected by this option are those that bury a buffer
2882 shown in a separate frame like `quit-window' and `bury-buffer'."
2886 function)
2892 "Delete WINDOW if possible.
2893 WINDOW must be a live window and defaults to the selected one.
2894 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2895 only if it's dedicated to its buffer. Optional argument KILL
2896 means the buffer shown in window will be killed. Return non-nil
2897 if WINDOW gets deleted or its frame is auto-hidden."
2912 t)))))
2915 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2916 There it is the least likely candidate for `other-buffer' to
2918 select by default.
2920 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2921 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2922 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2923 remove the current buffer from the selected window if it is
2924 displayed there."
2927 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2928 ;; although it's not "here" (call it a feature).
2930 ;; Handle case where `buffer-or-name' is nil and the current buffer
2931 ;; is shown in the selected window.
2936 ;; Switch to another buffer in window.
2940 ;; Always return nil.
2941 nil))
2944 "Switch to the last buffer in the buffer list."
2949 "In selected window switch to next buffer."
2956 "In selected window switch to previous buffer."
2963 "Delete all windows showing BUFFER-OR-NAME.
2964 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2965 and defaults to the current buffer.
2967 The following non-nil values of the optional argument FRAME
2968 have special meanings:
2970 - t means consider all windows on the selected frame only.
2972 - `visible' means consider all windows on all visible frames on
2973 the current terminal.
2975 - 0 (the number zero) means consider all windows on all visible
2976 and iconified frames on the current terminal.
2978 - A frame means consider all windows on that frame only.
2980 Any other value of FRAME means consider all windows on all
2981 frames.
2983 When a window showing BUFFER-OR-NAME is dedicated and the only
2984 window of its frame, that frame is deleted when there are other
2985 frames left."
2988 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2989 ;; `window-list-1' based function.
2996 ;; Delete frame if and only if window is dedicated.
2999 ;; Delete window.
3002 ;; In window switch to previous buffer.
3005 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3009 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
3010 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3011 and defaults to the current buffer.
3013 When a window showing BUFFER-OR-NAME is dedicated, that window is
3014 deleted. If that window is the only window on its frame, the
3015 frame is deleted too when there are other frames left. If there
3016 are no other frames left, some other buffer is displayed in that
3017 window.
3019 This function removes the buffer denoted by BUFFER-OR-NAME from
3020 all window-local buffer lists."
3026 ;; Switch to another buffer in window.
3029 ;; Unrecord BUFFER in WINDOW.
3033 "Quit WINDOW and bury its buffer.
3034 WINDOW must be a live window and defaults to the selected one.
3035 With prefix argument KILL non-nil, kill the buffer instead of
3036 burying it.
3038 According to information stored in WINDOW's `quit-restore' window
3039 parameter either (1) delete WINDOW and its frame, (2) delete
3040 WINDOW, (3) restore the buffer previously displayed in WINDOW,
3041 or (4) make WINDOW display some other buffer than the present
3042 one. If non-nil, reset `quit-restore' parameter to nil."
3053 buffer))))
3054 prev-buffer)))
3055 quad resize)
3060 ;; Delete WINDOW if possible.
3062 ;; If the previously selected window is still alive, select it.
3068 ;; Show another buffer stored in quit-restore parameter.
3073 ;; Try to resize WINDOW to its old height but don't signal an
3074 ;; error.
3078 ;; Restore WINDOW's previous buffer, start and point position.
3081 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
3082 ;; re-recorded by `set-window-buffer'.
3084 ;; Reset the quit-restore parameter.
3086 ;; Select old window.
3090 ;; Show some other buffer in WINDOW and reset the quit-restore
3091 ;; parameter.
3093 ;; Make sure that WINDOW is no more dedicated.
3097 ;; Kill WINDOW's old-buffer if requested
3103 "Quit all windows showing BUFFER-OR-NAME.
3104 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3105 and defaults to the current buffer. Optional argument KILL
3106 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3107 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3108 `delete-windows-on'.
3110 This function calls `quit-window' on all candidate windows
3111 showing BUFFER-OR-NAME."
3114 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3115 ;; `window-list-1' based function.
3120 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3122 \f
3123 ;;; Splitting windows.
3125 "Return minimum height of any window when splitting windows.
3126 Optional argument HORIZONTAL non-nil means return minimum width."
3132 "Make a new window adjacent to WINDOW.
3133 WINDOW can be any window and defaults to the selected one.
3134 Return the new window which is always a live window.
3136 Optional argument SIZE a positive number means make WINDOW SIZE
3137 lines or columns tall. If SIZE is negative, make the new window
3138 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3139 absolute value can be less than `window-min-height' or
3140 `window-min-width'; so this command can make a new window as
3141 small as one line or two columns. SIZE defaults to half of
3142 WINDOW's size. Interactively, SIZE is the prefix argument.
3144 Optional third argument SIDE nil (or `below') specifies that the
3145 new window shall be located below WINDOW. SIDE `above' means the
3146 new window shall be located above WINDOW. In both cases SIZE
3147 specifies the new number of lines for WINDOW (or the new window
3148 if SIZE is negative) including space reserved for the mode and/or
3149 header line.
3151 SIDE t (or `right') specifies that the new window shall be
3152 located on the right side of WINDOW. SIDE `left' means the new
3153 window shall be located on the left of WINDOW. In both cases
3154 SIZE specifies the new number of columns for WINDOW (or the new
3155 window provided SIZE is negative) including space reserved for
3156 fringes and the scrollbar or a divider column. Any other non-nil
3157 value for SIDE is currently handled like t (or `right').
3159 If the variable `ignore-window-parameters' is non-nil or the
3160 `split-window' parameter of WINDOW equals t, do not process any
3161 parameters of WINDOW. Otherwise, if the `split-window' parameter
3162 of WINDOW specifies a function, call that function with all three
3163 arguments and return the value returned by that function.
3166 root of that atomic window. The new window does not become a
3167 member of that atomic window.
3169 If WINDOW is live, properties of the new window like margins and
3170 scrollbars are inherited from WINDOW. If WINDOW is an internal
3171 window, these properties as well as the buffer displayed in the
3172 new window are inherited from the window selected on WINDOW's
3173 frame. The selected window is not changed by this function."
3185 ;; Rebind `window-combination-limit' since in some cases we may
3186 ;; have to override its value.
3188 atom-root)
3193 ;; Ignore window parameters if either `ignore-window-parameters'
3194 ;; is t or the `split-window' parameter equals t.
3197 ;; The `split-window' parameter specifies the function to call.
3198 ;; If that function is `ignore', do nothing.
3200 ;; If WINDOW is part of an atomic window, split the root window
3201 ;; of that atomic window instead.
3210 ;; WINDOW is a side root window. To make sure that a new parent
3211 ;; window gets created set `window-combination-limit' to t.
3215 ;; If `window-combination-resize' is non-nil and SIZE is a
3216 ;; non-negative integer, we cannot reasonably resize other
3217 ;; windows. Rather bind `window-combination-limit' to t to make
3218 ;; sure that subsequent window deletions are handled correctly.
3222 ;; `parent-size' is the size of WINDOW's parent, provided
3223 ;; it has one.
3225 ;; `resize' non-nil means we are supposed to resize other
3226 ;; windows in WINDOW's combination.
3229 ;; Resize makes sense in iso-combinations only.
3231 ;; `old-size' is the current size of WINDOW.
3233 ;; `new-size' is the specified or calculated size of the
3234 ;; new window.
3240 ;; When resizing try to give the new window the
3241 ;; average size of a window in its combination.
3244 (/ parent-size
3246 parent horizontal))))
3247 ;; Else try to give the new window half the size
3248 ;; of WINDOW (plus an eventual odd line).
3251 ;; SIZE non-negative specifies the new size of WINDOW.
3253 ;; Note: Specifying a non-negative SIZE is practically
3254 ;; always done as workaround for making the new window
3255 ;; appear above or on the left of the new window (the
3256 ;; ispell window is a typical example of that). In all
3257 ;; these cases the SIDE argument should be set to 'above
3258 ;; or 'left in order to support the 'resize option.
3259 ;; Here we have to nest the windows instead, see above.
3262 ;; SIZE negative specifies the size of the new window.
3264 new-parent new-normal)
3266 ;; Check SIZE.
3271 ;; SIZE unspecified, resizing.
3273 ;; Try again with minimum split size.
3279 ;; SIZE unspecified, no resizing.
3284 window-safe-min-width
3285 window-safe-min-width))))
3286 ;; SIZE specified as new size of old window. If the new size
3287 ;; is larger than the old size or the size of the new window
3288 ;; would be less than the safe minimum, signal an error.
3291 ;; SIZE specified, resizing.
3293 ;; If we cannot resize the parent give up.
3299 ;; SIZE specification violates minimum size restrictions.
3305 ;; Make new-parent non-nil if we need a new parent window;
3306 ;; either because we want to nest or because WINDOW is not
3307 ;; iso-combined.
3311 ;; Make new-normal the normal size of the new window.
3319 ;; Try to get space from OLD's siblings. We could go "up" and
3320 ;; try getting additional space from surrounding windows but
3321 ;; we won't be able to return space to those windows when we
3322 ;; delete the one we create here. Hence we do not go up.
3331 ;; Get entire space from WINDOW.
3336 new-normal)))
3339 ;; Inherit window-side parameters, if any.
3346 ;; Always return the new window.
3347 new)))))
3349 ;; I think this should be the default; I think people will prefer it--rms.
3352 If nil, adjust point in the two windows to minimize redisplay.
3353 This option applies only to `split-window-below' and functions
3354 that call it. The low-level `split-window' function always keeps
3355 the original point in both windows."
3360 "Split the selected window into two windows, one above the other.
3361 The selected window is above. The newly split-off window is
3362 below, and displays the same buffer. Return the new window.
3364 If optional argument SIZE is omitted or nil, both windows get the
3365 same height, or close to it. If SIZE is positive, the upper
3366 \(selected) window gets SIZE lines. If SIZE is negative, the
3367 lower (new) window gets -SIZE lines.
3369 If the variable `split-window-keep-point' is non-nil, both
3370 windows get the same value of point as the selected window.
3371 Otherwise, the window starts are chosen so as to minimize the
3372 amount of redisplay; this is convenient on slow terminals."
3377 moved-by-window-height moved new-window bottom)
3379 ;; `split-window' would not signal an error here.
3384 ;; Use `save-excursion' around vertical movements below
3385 ;; (Bug#10971). Note: When the selected window's buffer has a
3386 ;; header line, up to two lines of the buffer may not show up
3387 ;; in the resulting configuration.
3405 ;; Always copy quit-restore parameter in interactive use.
3409 new-window))
3414 "Split the selected window into two side-by-side windows.
3415 The selected window is on the left. The newly split-off window
3416 is on the right, and displays the same buffer. Return the new
3417 window.
3419 If optional argument SIZE is omitted or nil, both windows get the
3420 same width, or close to it. If SIZE is positive, the left-hand
3421 \(selected) window gets SIZE columns. If SIZE is negative, the
3422 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3423 the width of the window's scroll bar; if there are no scroll
3424 bars, it includes the width of the divider column to the window's
3425 right, if any."
3429 new-window)
3431 ;; `split-window' would not signal an error here.
3434 ;; Always copy quit-restore parameter in interactive use.
3438 new-window))
3441 \f
3442 ;;; Balancing windows.
3444 ;; The following routine uses the recycled code from an old version of
3445 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3446 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3447 ;; more readable (FWIW we'd need three loops - one to calculate the
3448 ;; minimum sizes per window, one to enlarge or shrink windows until the
3449 ;; new parent-size matches, and one where we shrink the largest/enlarge
3450 ;; the smallest window).
3452 "Subroutine of `balance-windows-1'.
3453 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3454 is non-nil."
3460 failed size sub-total sub-delta sub-amount rest)
3475 ;; Ignore child windows that should be ignored or are stuck.
3481 ;; Register the new total size for this child window.
3486 ;; We failed and need a new round.
3492 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3493 ;; (column) until `rest' is zero.
3501 ;; Fix rounding by trying to enlarge stuck windows by one line
3502 ;; (column) until `rest' equals zero.
3512 ;; Record new normal sizes.
3518 ;; Recursively balance each window's child windows.
3523 "Subroutine of `balance-windows'."
3535 "Balance the sizes of windows of WINDOW-OR-FRAME.
3536 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3537 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3538 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3539 recursively balance the sizes of all child windows of that
3540 window."
3549 window-or-frame)
3553 ;; Balance vertically.
3557 ;; Balance horizontally.
3563 "Return t if WINDOW cannot be resized in DIRECTION.
3564 WINDOW defaults to the selected window. DIRECTION can be
3565 nil (i.e. any), `height' or `width'."
3572 ;;; A different solution to balance-windows.
3574 "Factor by which the window area should be over-estimated.
3575 This is used by `balance-windows-area'.
3580 "Wrapper around `window-resize' with error checking.
3581 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3582 ;; `window-resize' may fail if delta is too large.
3589 ;;(message "adjust: %s" (error-message-string err))
3593 "Make all visible windows the same area (approximately).
3594 See also `window-area-factor' to change the relative size of
3595 specific buffers."
3598 ;; Remove fixed-size windows.
3603 next)
3604 ;; Resizing a window changes the size of surrounding windows in complex
3605 ;; ways, so it's difficult to balance them all. The introduction of
3606 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3607 ;; very difficult to do. `balance-window' above takes an off-line
3608 ;; approach: get the whole window tree, then balance it, then try to
3609 ;; adjust the windows so they fit the result.
3610 ;; Here, instead, we take a "local optimization" approach, where we just
3611 ;; go through all the windows several times until nothing needs to be
3612 ;; changed. The main problem with this approach is that it's difficult
3613 ;; to make sure it terminates, so we use some heuristic to try and break
3614 ;; off infinite loops.
3615 ;; After a round without any change, we allow a second, to give a chance
3616 ;; to the carry to propagate a minor imbalance from the end back to
3617 ;; the beginning.
3619 ;; (message "New round")
3625 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3643 ;; Maybe diff is actually closer to 1 than to 0.
3647 ;; Change things smoothly.
3650 ;; Make sure negligible differences don't accumulate to
3651 ;; become significant.
3653 ;; This used `adjust-window-trailing-edge' before and uses
3654 ;; `window-resize' now. Error wrapping is still needed.
3656 ;; (sit-for 0.5)
3658 ;; If the same change has been seen already for this window,
3659 ;; we're most likely in an endless loop, so don't count it as
3660 ;; a change.
3664 ;; We've now basically balanced all the windows.
3665 ;; But there may be some minor off-by-one imbalance left over,
3666 ;; so let's do some fine tuning.
3667 ;; (bw-finetune wins)
3668 ;; (message "Done in %d rounds" round)
3669 ))
3671 ;;; Window states, how to get them and how to put them in a window.
3673 "Helper function for `window-state-get'."
3682 `(,type
3690 list)
3691 ;; Make copies of those window parameters whose
3692 ;; persistence property is `writable' if WRITABLE is
3693 ;; non-nil and non-nil if WRITABLE is nil.
3696 window-persistent-parameters))))
3699 ;; Add `clone-of' parameter if necessary.
3701 window-persistent-parameters))))
3708 ;; All buffer related things go in here.
3723 'window-point-insertion-type
3724 buffer))))
3737 "Return state of WINDOW as a Lisp object.
3738 WINDOW can be any window and defaults to the root window of the
3739 selected frame.
3741 Optional argument WRITABLE non-nil means do not use markers for
3742 sampling `window-point' and `window-start'. Together, WRITABLE
3743 and the variable `window-persistent-parameters' specify which
3744 window parameters are saved by this function. WRITABLE should be
3745 non-nil when the return value shall be written to a file and read
3746 back in another session. Otherwise, an application may run into
3747 an `invalid-read-syntax' error while attempting to read back the
3748 value from file.
3750 The return value can be used as argument for `window-state-put'
3751 to put the state recorded here into an arbitrary window. The
3752 value can be also stored on disk and read back in a new session."
3756 window
3759 ;; The return value is a cons whose car specifies some constraints on
3760 ;; the size of WINDOW. The cdr lists the states of the child windows
3761 ;; of WINDOW.
3763 ;; Frame related things would go into a function, say `frame-state',
3764 ;; calling `window-state-get' to insert the frame's root window.
3777 "Helper function for `window-state-put'."
3782 ;; For a leaf window just add unprocessed entries to
3783 ;; `window-state-put-list'.
3789 size new)
3791 ;; Find the next child window. WINDOW always points to the
3792 ;; real window that we want to fill with what we find here.
3795 ;; The last child window. Below `window--state-put-1'
3796 ;; will put into it whatever ITEM has in store.
3798 ;; Not the last child window, prepare for splitting
3799 ;; WINDOW. SIZE is the new (and final) size of the old
3800 ;; window.
3803 ;; Use total size.
3805 ;; Use normalized size and round.
3809 item))))))
3811 ;; Use safe sizes, we try to resize later.
3813 window-safe-min-height
3814 window-safe-min-width)))
3819 ;; We must inherit the combination limit, otherwise
3820 ;; we might mess up handling of atomic and side
3821 ;; window.
3823 ;; Give up if we can't resize window down to safe sizes.
3828 ;; When creating the first child window add for parent
3829 ;; unprocessed entries to `window-state-put-list'.
3832 window-state-put-list))))
3834 ;; Now process the current window (either the one we've just
3835 ;; split or the last child of its parent).
3837 ;; Continue with the last window split off.
3841 "Helper function for `window-state-put'."
3849 ;; Reset window's parameters and assign saved ones (we might want
3850 ;; a `remove-window-parameters' function here).
3856 ;; Process buffer related state.
3858 ;; We don't want to raise an error here so we create a buffer if
3859 ;; there's none.
3871 ;; Adjust vertically.
3873 ;; A fixed height window, try to restore the original size.
3876 window-size-fixed)
3879 ;; Else check whether the window is not high enough.
3885 ;; Adjust horizontally.
3887 ;; A fixed width window, try to restore the original size.
3890 window-size-fixed)
3893 ;; Else check whether the window is not wide enough.
3899 ;; Set dedicated status.
3901 ;; Install positions (maybe we should do this after all windows
3902 ;; have been created and sized).
3906 ;; Select window if it's the selected one.
3911 "Put window state STATE into WINDOW.
3912 STATE should be the state of a window returned by an earlier
3913 invocation of `window-state-get'. Optional argument WINDOW must
3914 specify a live window and defaults to the selected one.
3916 Optional argument IGNORE non-nil means ignore minimum window
3917 sizes and fixed size restrictions. IGNORE equal `safe' means
3918 windows can get as small as `window-safe-min-height' and
3919 `window-safe-min-width'."
3923 ;; We check here (1) whether the total sizes of root window of
3924 ;; STATE and that of WINDOW are equal so we can avoid
3925 ;; calculating new sizes, and (2) if we do have to resize
3926 ;; whether we can do so without violating size restrictions.
3951 (> min-width
3953 ;; The check above might not catch all errors due to rounding
3954 ;; issues - so IGNORE equal 'safe might not always produce the
3955 ;; minimum possible state. But such configurations hardly make
3956 ;; sense anyway.
3960 ;; Work on the windows of a temporary buffer to make sure that
3961 ;; splitting proceeds regardless of any buffer local values of
3962 ;; `window-size-fixed'. Release that buffer after the buffers of
3963 ;; all live windows have been set by `window--state-put-2'.
3969 \f
3971 "Record information for window used by `display-buffer'.
3972 TYPE specifies the type of the calling operation and must be one
3973 of the symbols 'reuse (when WINDOW existed already and was
3974 reused for displaying BUFFER), 'window (when WINDOW was created
3975 on an already existing frame), or 'frame (when WINDOW was
3976 created on a new frame). WINDOW is the window used for or created
3977 by the `display-buffer' routines. BUFFER is the buffer that
3978 shall be displayed.
3980 This function installs or updates the quit-restore parameter of
3981 WINDOW. The quit-restore parameter is a list of four elements:
3982 The first element is one of the symbols 'window, 'frame, 'same or
3983 'other. The second element is either one of the symbols 'window
3984 or 'frame or a list whose elements are the buffer previously
3985 shown in the window, that buffer's window start and window point,
3986 and the window's height. The third element is the window
3987 selected at the time the parameter was created. The fourth
3988 element is BUFFER."
3992 ;; WINDOW shows BUFFER already.
3994 ;; If WINDOW has a quit-restore parameter, reset its car.
3996 ;; WINDOW shows another buffer.
3998 window 'quit-restore
4000 ;; A quadruple of WINDOW's buffer, start, point and height.
4005 ;; WINDOW has been created on an existing frame.
4007 window 'quit-restore
4010 ;; WINDOW has been created on a new frame.
4012 window 'quit-restore
4016 "If non-nil, function to call to handle `display-buffer'.
4017 It will receive two args, the buffer and a flag which if non-nil
4018 means that the currently selected window is not acceptable. It
4019 should choose or create a window, display the specified buffer in
4020 it, and return the window.
4022 The specified function should call `display-buffer-record-window'
4023 with corresponding arguments to set up the quit-restore parameter
4024 of the window used."
4031 "Alist of parameters for automatically generated new frames.
4032 You can set this in your init file; for example,
4034 (setq pop-up-frame-alist '((width . 80) (height . 20)))
4036 If non-nil, the value you specify here is used by the default
4037 `pop-up-frame-function' for the creation of new frames.
4039 Since `pop-up-frame-function' is used by `display-buffer' for
4040 making new frames, any value specified here by default affects
4041 the automatic generation of new frames via `display-buffer' and
4042 all functions based on it. The behavior of `make-frame' is not
4043 affected by this variable."
4051 "Function used by `display-buffer' for creating a new frame.
4052 This function is called with no arguments and should return a new
4053 frame. The default value calls `make-frame' with the argument
4054 `pop-up-frame-alist'."
4059 "List of names of buffers that should be displayed specially.
4060 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4061 its name is in this list, displays the buffer in a way specified
4062 by `special-display-function'. `special-display-popup-frame'
4063 \(the default for `special-display-function') usually displays
4064 the buffer in a separate frame made with the parameters specified
4065 by `special-display-frame-alist'. If `special-display-function'
4066 has been set to some other function, that function is called with
4067 the buffer as first, and nil as second argument.
4069 Alternatively, an element of this list can be specified as
4070 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
4071 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4072 `special-display-popup-frame' will interpret such pairs as frame
4073 parameters when it creates a special frame, overriding the
4074 corresponding values from `special-display-frame-alist'.
4076 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4077 `special-display-popup-frame' displays that buffer in the
4078 selected window. If FRAME-PARAMETERS contains (same-frame . t),
4079 it displays that buffer in a window on the selected frame.
4081 If `special-display-function' specifies some other function than
4082 `special-display-popup-frame', that function is called with the
4083 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4084 argument.
4086 Finally, an element of this list can be also specified as
4087 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4088 `special-display-popup-frame' will call FUNCTION with the buffer
4089 named BUFFER-NAME as first argument, and OTHER-ARGS as the
4090 second.
4092 Any alternative function specified here is responsible for
4093 setting up the quit-restore parameter of the window used.
4096 name to it but the corresponding buffer is displayed in the
4097 selected window, look at the values of `same-window-buffer-names'
4098 and `same-window-regexps'. Those variables take precedence over
4099 this one.
4101 See also `special-display-regexps'."
4123 ;;;###autoload
4127 "List of regexps saying which buffers should be displayed specially.
4128 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4129 any regexp in this list matches its name, displays it specially
4130 using `special-display-function'. `special-display-popup-frame'
4131 \(the default for `special-display-function') usually displays
4132 the buffer in a separate frame made with the parameters specified
4133 by `special-display-frame-alist'. If `special-display-function'
4134 has been set to some other function, that function is called with
4135 the buffer as first, and nil as second argument.
4137 Alternatively, an element of this list can be specified as
4138 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4139 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4140 `special-display-popup-frame' will then interpret these pairs as
4141 frame parameters when creating a special frame for a buffer whose
4142 name matches REGEXP, overriding the corresponding values from
4143 `special-display-frame-alist'.
4145 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4146 `special-display-popup-frame' displays buffers matching REGEXP in
4147 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4148 to display such buffers in a window on the selected frame.
4150 If `special-display-function' specifies some other function than
4151 `special-display-popup-frame', that function is called with the
4152 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4153 as second argument.
4155 Finally, an element of this list can be also specified as
4156 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4157 will then call FUNCTION with the buffer whose name matched
4158 REGEXP as first, and OTHER-ARGS as second argument.
4160 Any alternative function specified here is responsible for
4161 setting up the quit-restore parameter of the window used.
4164 name to it but the corresponding buffer is displayed in the
4165 selected window, look at the values of `same-window-buffer-names'
4166 and `same-window-regexps'. Those variables take precedence over
4167 this one.
4169 See also `special-display-buffer-names'."
4192 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4193 More precisely, return t if `special-display-buffer-names' or
4194 `special-display-regexps' contain a string entry equaling or
4195 matching BUFFER-NAME. If `special-display-buffer-names' or
4196 `special-display-regexps' contain a list entry whose car equals
4197 or matches BUFFER-NAME, the return value is the cdr of that
4198 entry."
4202 t)
4217 "Alist of parameters for special frames.
4218 Special frames are used for buffers whose names are listed in
4219 `special-display-buffer-names' and for buffers whose names match
4220 one of the regular expressions in `special-display-regexps'.
4222 This variable can be set in your init file, like this:
4224 (setq special-display-frame-alist '((width . 80) (height . 20)))
4226 These supersede the values given in `default-frame-alist'."
4233 "Pop up a frame displaying BUFFER and return its window.
4234 If BUFFER is already displayed in a visible or iconified frame,
4235 raise that frame. Otherwise, display BUFFER in a new frame.
4237 Optional argument ARGS is a list specifying additional
4238 information.
4240 If ARGS is an alist, use it as a list of frame parameters. If
4241 these parameters contain (same-window . t), display BUFFER in
4242 the selected window. If they contain (same-frame . t), display
4243 BUFFER in a window of the selected frame.
4245 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4246 function to do the work. Pass it BUFFER as first argument,
4247 and (cdr ARGS) as second."
4252 ;; If we have a window already, make it visible.
4258 window))
4259 ;; Reuse the current window if the user requested it.
4264 ;; Stay on the same frame if requested.
4267 pop-up-frames
4268 special-display-buffer-names special-display-regexps)
4270 ;; If no window yet, make one in a new frame.
4277 window)))))
4280 "Function to call for displaying special buffers.
4281 This function is called with two arguments - the buffer and,
4282 optionally, a list - and should return a window displaying that
4283 buffer. The default value usually makes a separate frame for the
4284 buffer using `special-display-frame-alist' to specify the frame
4285 parameters. See the definition of `special-display-popup-frame'
4286 for how to specify such a function.
4288 A buffer is special when its name is either listed in
4289 `special-display-buffer-names' or matches a regexp in
4290 `special-display-regexps'.
4292 The specified function should call `display-buffer-record-window'
4293 with corresponding arguments to set up the quit-restore parameter
4294 of the window used."
4300 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4301 on this list in the selected rather than some other window.
4303 An element of this list can be a cons cell instead of just a
4304 string. In that case, the cell's car must be a string specifying
4305 the buffer name. This is for compatibility with
4306 `special-display-buffer-names'; the cdr of the cons cell is
4307 ignored.
4309 See also `same-window-regexps'."
4315 `display-buffer' and `pop-to-buffer' show a buffer whose name
4316 matches a regexp on this list in the selected rather than some
4317 other window.
4319 An element of this list can be a cons cell instead of just a
4320 string. In that case, the cell's car must be a regexp matching
4321 the buffer name. This is for compatibility with
4322 `special-display-regexps'; the cdr of the cons cell is ignored.
4324 See also `same-window-buffer-names'."
4330 This function returns non-nil if `display-buffer' or
4331 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4332 selected rather than (as usual) some other window. See
4333 `same-window-buffer-names' and `same-window-regexps'."
4336 ;; The elements of `same-window-buffer-names' can be buffer
4337 ;; names or cons cells whose cars are buffer names.
4342 ;; The elements of `same-window-regexps' can be regexps
4343 ;; or cons cells whose cars are regexps.
4351 "Whether `display-buffer' should make a separate frame.
4352 If nil, never make a separate frame.
4353 If the value is `graphic-only', make a separate frame
4354 on graphic displays only.
4355 Any other non-nil value means always make a separate frame."
4363 "Non-nil means `display-buffer' should reuse frames.
4364 If the buffer in question is already displayed in a frame, raise
4365 that frame."
4371 "Non-nil means `display-buffer' should make a new window."
4376 "Function called by `display-buffer' routines to split a window.
4377 This function is called with a window as single argument and is
4378 supposed to split that window and return the new window. If the
4379 window can (or shall) not be split, it is supposed to return nil.
4380 The default is to call the function `split-window-sensibly' which
4381 tries to split the window in a way which seems most suitable.
4382 You can customize the options `split-height-threshold' and/or
4383 `split-width-threshold' in order to have `split-window-sensibly'
4384 prefer either vertical or horizontal splitting.
4386 If you set this to any other function, bear in mind that the
4387 `display-buffer' routines may call this function two times. The
4388 argument of the first call is the largest window on its frame.
4389 If that call fails to return a live window, the function is
4390 called again with the least recently used window as argument. If
4391 that call fails too, `display-buffer' will use an existing window
4392 to display its buffer.
4394 The window selected at the time `display-buffer' was invoked is
4395 still selected when this function is called. Hence you can
4396 compare the window argument with the value of `selected-window'
4397 if you intend to split the selected window instead or if you do
4398 not want to split the selected window."
4404 "Minimum height for splitting windows sensibly.
4405 If this is an integer, `split-window-sensibly' may split a window
4406 vertically only if it has at least this many lines. If this is
4407 nil, `split-window-sensibly' is not allowed to split a window
4408 vertically. If, however, a window is the only window on its
4409 frame, `split-window-sensibly' may split it vertically
4410 disregarding the value of this variable."
4416 "Minimum width for splitting windows sensibly.
4417 If this is an integer, `split-window-sensibly' may split a window
4418 horizontally only if it has at least this many columns. If this
4419 is nil, `split-window-sensibly' is not allowed to split a window
4420 horizontally."
4426 "Return non-nil if `split-window-sensibly' may split WINDOW.
4427 Optional argument HORIZONTAL nil or omitted means check whether
4428 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4429 non-nil means check whether WINDOW may be split horizontally.
4431 WINDOW may be split vertically when the following conditions
4432 hold:
4433 - `window-size-fixed' is either nil or equals `width' for the
4434 buffer of WINDOW.
4435 - `split-height-threshold' is an integer and WINDOW is at least as
4436 high as `split-height-threshold'.
4437 - When WINDOW is split evenly, the emanating windows are at least
4438 `window-min-height' lines tall and can accommodate at least one
4439 line plus - if WINDOW has one - a mode line.
4441 WINDOW may be split horizontally when the following conditions
4442 hold:
4443 - `window-size-fixed' is either nil or equals `height' for the
4444 buffer of WINDOW.
4445 - `split-width-threshold' is an integer and WINDOW is at least as
4446 wide as `split-width-threshold'.
4447 - When WINDOW is split evenly, the emanating windows are at least
4448 `window-min-width' or two (whichever is larger) columns wide."
4452 ;; A window can be split horizontally when its width is not
4453 ;; fixed, it is at least `split-width-threshold' columns wide
4454 ;; and at least twice as wide as `window-min-width' and 2 (the
4455 ;; latter value is hardcoded).
4457 ;; Testing `window-full-width-p' here hardly makes any
4458 ;; sense nowadays. This can be done more intuitively by
4459 ;; setting up `split-width-threshold' appropriately.
4464 ;; A window can be split vertically when its height is not
4465 ;; fixed, it is at least `split-height-threshold' lines high,
4466 ;; and it is at least twice as high as `window-min-height' and 2
4467 ;; if it has a mode line or 1.
4476 "Split WINDOW in a way suitable for `display-buffer'.
4477 WINDOW defaults to the currently selected window.
4478 If `split-height-threshold' specifies an integer, WINDOW is at
4479 least `split-height-threshold' lines tall and can be split
4480 vertically, split WINDOW into two windows one above the other and
4481 return the lower window. Otherwise, if `split-width-threshold'
4482 specifies an integer, WINDOW is at least `split-width-threshold'
4483 columns wide and can be split horizontally, split WINDOW into two
4484 windows side by side and return the window on the right. If this
4485 can't be done either and WINDOW is the only window on its frame,
4486 try to split WINDOW vertically disregarding any value specified
4487 by `split-height-threshold'. If that succeeds, return the lower
4488 window. Return nil otherwise.
4490 By default `display-buffer' routines call this function to split
4491 the largest or least recently used window. To change the default
4492 customize the option `split-window-preferred-function'.
4494 You can enforce this function to not split WINDOW horizontally,
4495 by setting (or binding) the variable `split-width-threshold' to
4496 nil. If, in addition, you set `split-height-threshold' to zero,
4497 chances increase that this function does split WINDOW vertically.
4499 In order to not split WINDOW vertically, set (or bind) the
4500 variable `split-height-threshold' to nil. Additionally, you can
4501 set `split-width-threshold' to zero to make a horizontal split
4502 more likely to occur.
4504 Have a look at the function `window-splittable-p' if you want to
4505 know how `split-window-sensibly' determines whether WINDOW can be
4506 split."
4509 ;; Split window vertically.
4513 ;; Split window horizontally.
4518 ;; If WINDOW is the only window on its frame and is not the
4519 ;; minibuffer window, try to split it vertically disregarding
4520 ;; the value of `split-height-threshold'.
4527 "Try to split WINDOW.
4528 Return value returned by `split-window-preferred-function' if it
4529 represents a live window, nil otherwise."
4533 ;; Since `split-window-preferred-function' might
4534 ;; throw an error use `condition-case'.
4541 "Return FRAME if it can be used to display a buffer."
4544 ;; `frame-root-window' may be an internal window which is considered
4545 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4546 ;; implicitly know that `frame' has a visible window we can use.
4549 ;; If the window is soft-dedicated, the frame is usable.
4550 ;; Actually, even if the window is really dedicated,
4551 ;; the frame is still usable by splitting it.
4552 ;; At least Emacs-22 allowed it, and it is desirable
4553 ;; when displaying same-frame windows.
4554 nil ; (eq t (window-dedicated-p window))
4555 ))
4556 frame))))
4559 "If non-nil `display-buffer' will try to even window heights.
4560 Otherwise `display-buffer' will leave the window configuration
4561 alone. Heights are evened only when `display-buffer' chooses a
4562 window that appears above or below the selected window."
4567 "Even heights of WINDOW and selected window.
4568 Do this only if these windows are vertically adjacent to each
4569 other, `even-window-heights' is non-nil, and the selected window
4570 is higher than WINDOW."
4573 ;; Don't resize minibuffer windows.
4584 ;; Don't throw an error if we can't even window heights for
4585 ;; whatever reason.
4591 "Display BUFFER in WINDOW and make its frame visible.
4592 TYPE must be one of the symbols `reuse', `window' or `frame' and
4593 is passed unaltered to `display-buffer-record-window'. Set
4594 `window-dedicated-p' to DEDICATED if non-nil. Return WINDOW if
4595 BUFFER and WINDOW are live."
4605 window))
4610 ;; Assume the selected frame is already visible enough.
4612 ;; Assume the frame from which we invoked the
4613 ;; minibuffer is visible.
4618 ;; FIXME: Not implemented.
4619 ;; FIXME: By the way, there could be more levels of dedication:
4620 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4621 ;; the window hasn't been used for something else yet.
4622 ;; - `softly' dedicated only allows reuse when asked explicitly.
4623 ;; - `strongly' never allows reuse.
4625 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4626 The actual non-nil value of this variable will be copied to the
4643 ,display-buffer--action-function-custom-type
4648 :key-type symbol
4653 "Overriding action to perform to display a buffer.
4654 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4655 function or a list of functions. Each function should accept two
4656 arguments: a buffer to display and an alist similar to ALIST.
4661 "Alist of conditional actions for `display-buffer'.
4662 This is a list of elements (CONDITION . ACTION), where:
4664 CONDITION is either a regexp matching buffer names, or a function
4665 that takes a buffer and returns a boolean.
4667 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4668 function or a list of functions. Each such function should
4669 accept two arguments: a buffer to display and an alist of the
4670 same form as ALIST. See `display-buffer' for details."
4673 regexp
4676 :risky t
4681 "User-specified default action for `display-buffer'.
4682 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4683 function or a list of functions. Each function should accept two
4684 arguments: a buffer to display and an alist similar to ALIST.
4685 See `display-buffer' for details."
4686 :type display-buffer--action-custom-type
4687 :risky t
4693 display-buffer-reuse-window
4694 display-buffer--maybe-pop-up-frame-or-window
4695 display-buffer-use-some-window
4696 ;; If all else fails, pop up a new frame.
4697 display-buffer-pop-up-frame))
4698 "Default fallback action for `display-buffer'.
4699 This is the action used by `display-buffer' if no other actions
4700 specified, e.g. by the user options `display-buffer-alist' or
4705 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4723 display-buffer-pop-up-frame)
4730 "Display BUFFER-OR-NAME in some window, without selecting it.
4731 BUFFER-OR-NAME must be a buffer or the name of an existing
4732 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4733 or nil if no such window is found.
4735 Optional argument ACTION should have the form (FUNCTION . ALIST).
4736 FUNCTION is either a function or a list of functions.
4737 ALIST is an arbitrary association list (alist).
4739 Each such FUNCTION should accept two arguments: the buffer to
4740 display and an alist. Based on those arguments, it should either
4741 display the buffer and return the window, or return nil if unable
4742 to display the buffer.
4744 The `display-buffer' function builds a function list and an alist
4745 by combining the functions and alists specified in
4746 `display-buffer-overriding-action', `display-buffer-alist', the
4747 ACTION argument, `display-buffer-base-action', and
4748 `display-buffer-fallback-action' (in order). Then it calls each
4749 function in the combined function list in turn, passing the
4750 buffer as the first argument and the combined alist as the second
4751 argument, until one of the functions returns non-nil.
4753 Available action functions include:
4754 `display-buffer-same-window'
4755 `display-buffer-reuse-window'
4756 `display-buffer-pop-up-frame'
4757 `display-buffer-pop-up-window'
4758 `display-buffer-use-some-window'
4760 Recognized alist entries include:
4762 `inhibit-same-window' -- A non-nil value prevents the same
4763 window from being used for display.
4765 `inhibit-switch-frame' -- A non-nil value prevents any other
4766 frame from being raised or selected,
4767 even if the window is displayed there.
4769 `reusable-frames' -- Value specifies frame(s) to search for a
4770 window that already displays the buffer.
4771 See `display-buffer-reuse-window'.
4773 The ACTION argument to `display-buffer' can also have a non-nil
4774 and non-list value. This means to display the buffer in a window
4775 other than the selected one, even if it is already displayed in
4776 the selected window. If called interactively with a prefix
4777 argument, ACTION is t.
4779 Optional argument FRAME, if non-nil, acts like an additional
4780 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4781 search for a window that is already displaying the buffer. See
4782 `display-buffer-reuse-window'."
4786 buffer-or-name
4788 ;; Handle the old form of the first argument.
4792 ;; If `display-buffer-function' is defined, let it do the job.
4794 ;; Otherwise, use the defined actions.
4797 display-buffer-alist))
4799 ;; Extra actions from the arguments to this function:
4805 ;; Construct action function list and action alist.
4807 user-action special-action action extra-action
4808 display-buffer-base-action
4809 display-buffer-fallback-action))
4814 actions)))
4816 window)
4822 window))))
4825 "Display buffer BUFFER in another frame.
4826 This uses the function `display-buffer' as a subroutine; see
4827 its documentation for additional customization information."
4831 ;;; `display-buffer' action functions:
4834 "Display BUFFER in the selected window.
4835 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4836 if the selected window is a minibuffer window or is dedicated to
4837 another buffer; in that case, return nil. Otherwise, return the
4838 selected window."
4845 "Conditionally display BUFFER in the selected window.
4846 If `same-window-p' returns non-nil for BUFFER's name, call
4847 `display-buffer-same-window' and return its value. Otherwise,
4848 return nil."
4853 "Return a window that is already displaying BUFFER.
4854 Return nil if no usable window is found.
4856 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4857 window is not eligible for reuse.
4859 If ALIST contains a `reusable-frames' entry, its value determines
4860 which frames to search for a reusable window:
4861 nil -- the selected frame (actually the last non-minibuffer frame)
4862 A frame -- just that frame
4863 `visible' -- all visible frames
4864 0 -- all frames on the current terminal
4865 t -- all frames.
4867 If ALIST contains no `reusable-frames' entry, search just the
4868 selected frame if `display-buffer-reuse-frames' and
4869 `pop-up-frames' are both nil; search all frames on the current
4870 terminal if either of those variables is non-nil.
4872 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4873 event that a window on another frame is chosen, avoid raising
4874 that frame."
4879 pop-up-frames)
4888 frames))))))
4895 "Return special display action for BUFFER, if any.
4896 If `special-display-p' returns non-nil for BUFFER, return an
4897 appropriate display action involving `special-display-function'.
4898 See `display-buffer' for the format of display actions."
4900 ;; `special-display-p' returns either t or a list of frame
4901 ;; parameters to pass to `special-display-function'.
4910 "Display BUFFER in a new frame.
4911 This works by calling `pop-up-frame-function'. If successful,
4912 return the window used; otherwise return nil.
4914 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
4915 raising the new frame."
4917 frame window)
4927 "Display BUFFER by popping up a new window.
4928 The new window is created on the selected frame, or in
4929 `last-nonminibuffer-frame' if no windows can be created there.
4930 If successful, return the new window; otherwise return nil.
4932 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4933 event that the new window is created on another frame, avoid
4934 raising the frame."
4937 window)
4939 ;; If the selected frame cannot be split, look at
4940 ;; `last-nonminibuffer-frame'.
4945 ;; Attempt to split largest or least recently used window.
4956 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4958 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4959 text-only terminal), try with `display-buffer-pop-up-frame'.
4961 If that cannot be done, and `pop-up-windows' is non-nil, try
4962 again with `display-buffer-pop-up-window'."
4965 pop-up-frames)
4971 "Display BUFFER in an existing window.
4972 Search for a usable window, set that window to the buffer, and
4973 return the window. If no suitable window is found, return nil.
4975 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4976 event that a window in another frame is chosen, avoid raising
4977 that frame."
4982 ;; Reuse an existing window.
4987 window))
4992 window))
5000 ;;; Display + selection commands:
5002 "Select buffer BUFFER in some window, preferably a different one.
5003 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5004 is a string not naming an existent buffer, create a buffer with
5005 that name. If BUFFER is nil, choose some other buffer. Return
5006 the buffer.
5008 This uses `display-buffer' as a subroutine. The optional ACTION
5009 argument is passed to `display-buffer' as its ACTION argument.
5010 See `display-buffer' for more information. ACTION is t if called
5011 interactively with a prefix argument, which means to pop to a
5012 window other than the selected one even if the buffer is already
5013 displayed in the selected window.
5015 If the window to show BUFFER is not on the selected
5016 frame, raise that window's frame and give it input focus.
5018 Optional third arg NORECORD non-nil means do not put this buffer
5019 at the front of the list of recently selected ones."
5027 ;; If we chose another frame, make sure it gets input focus.
5030 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
5032 buffer))
5035 "Select buffer BUFFER in some window, preferably the same one.
5036 This function behaves much like `switch-to-buffer', except it
5037 displays with `special-display-function' if BUFFER has a match in
5038 `special-display-buffer-names' or `special-display-regexps'.
5040 Unlike `pop-to-buffer', this function prefers using the selected
5041 window over popping up a new window or frame.
5043 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5044 is a string not naming an existent buffer, create a buffer with
5045 that name. If BUFFER is nil, choose some other buffer. Return
5046 the buffer.
5048 NORECORD, if non-nil means do not put this buffer at the front of
5049 the list of recently selected ones."
5053 "Read the name of a buffer to switch to, prompting with PROMPT.
5054 Return the name of the buffer as a string.
5056 This function is intended for the `switch-to-buffer' family of
5057 commands since these need to omit the name of the current buffer
5058 from the list of completions and default values."
5063 ;; Since rbts-completion-table is built dynamically, we
5064 ;; can't just add it to the default value of
5065 ;; icomplete-with-completion-tables, so we add it
5066 ;; here manually.
5071 icomplete-with-completion-tables))))
5076 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5077 If BUFFER-OR-NAME is nil, return the buffer returned by
5078 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5079 exists, return that buffer. If no such buffer exists, create a
5080 buffer with the name BUFFER-OR-NAME and return that buffer."
5085 buffer))
5089 "Switch to buffer BUFFER-OR-NAME in the selected window.
5090 If called interactively, prompt for the buffer name using the
5091 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5092 determines whether to request confirmation before creating a new
5093 buffer.
5095 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5096 nil. If BUFFER-OR-NAME is a string that does not identify an
5097 existing buffer, create a buffer with that name. If
5098 BUFFER-OR-NAME is nil, switch to the buffer returned by
5099 `other-buffer'.
5101 Optional argument NORECORD non-nil means do not put the buffer
5102 specified by BUFFER-OR-NAME at the front of the buffer list and
5103 do not make the window displaying it the most recently selected
5104 one.
5106 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5107 in the selected window; signal an error if that is
5108 impossible (e.g. if the selected window is minibuffer-only). If
5109 nil, BUFFER-OR-NAME may be displayed in another window.
5111 Return the buffer switched to."
5116 ;; Don't call set-window-buffer if it's not needed since it
5117 ;; might signal an error (e.g. if the window is dedicated).
5134 "Select the buffer specified by BUFFER-OR-NAME in another window.
5135 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5136 nil. Return the buffer switched to.
5138 If called interactively, prompt for the buffer name using the
5139 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5140 determines whether to request confirmation before creating a new
5141 buffer.
5143 If BUFFER-OR-NAME is a string and does not identify an existing
5144 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5145 nil, switch to the buffer returned by `other-buffer'.
5147 Optional second argument NORECORD non-nil means do not put this
5148 buffer at the front of the list of recently selected ones.
5150 This uses the function `display-buffer' as a subroutine; see its
5151 documentation for additional customization information."
5158 "Switch to buffer BUFFER-OR-NAME in another frame.
5159 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5160 nil. Return the buffer switched to.
5162 If called interactively, prompt for the buffer name using the
5163 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5164 determines whether to request confirmation before creating a new
5165 buffer.
5167 If BUFFER-OR-NAME is a string and does not identify an existing
5168 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5169 nil, switch to the buffer returned by `other-buffer'.
5171 Optional second arg NORECORD non-nil means do not put this
5172 buffer at the front of the list of recently selected ones.
5174 This uses the function `display-buffer' as a subroutine; see its
5175 documentation for additional customization information."
5179 \f
5181 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5182 WINDOW must be a live window. HEIGHT doesn't include the mode
5183 line or header line, if any, or any partial-height lines in the
5184 text display area.
5186 Note that the current implementation of this function cannot
5187 always set the height exactly, but attempts to be conservative,
5188 by allocating more lines than are actually needed in the case
5189 where some error may be present."
5193 ;; Setting window-min-height to a value like 1 can lead to very
5194 ;; bizarre displays because it also allows Emacs to make *other*
5195 ;; windows one line tall, which means that there's no more space
5196 ;; for the mode line.
5201 "Make selected window DELTA columns wider.
5202 Interactively, if no argument is given, make selected window one
5203 column wider."
5208 "Make selected window DELTA columns narrower.
5209 Interactively, if no argument is given, make selected window one
5210 column narrower."
5215 "Return the number of screen lines in the region.
5216 The number of screen lines may be different from the number of actual lines,
5217 due to line breaking, display table, etc.
5219 Optional arguments BEG and END default to `point-min' and `point-max'
5220 respectively.
5222 If region ends with a newline, ignore it unless optional third argument
5223 COUNT-FINAL-NEWLINE is non-nil.
5225 The optional fourth argument WINDOW specifies the window used for obtaining
5226 parameters such as width, horizontal scrolling, and so on. The default is
5227 to use the selected window's parameters.
5229 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5230 regardless of which buffer is displayed in WINDOW. This makes possible to use
5231 `count-screen-lines' in any buffer, whether or not it is currently displayed
5232 in some window."
5238 0
5251 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5255 ;; If buffer ends with a newline, ignore it when
5256 ;; counting height unless point is after it.
5258 window))))
5260 ;;; Resizing buffers to fit their contents exactly.
5262 "Adjust height of WINDOW to display its buffer's contents exactly.
5263 WINDOW can be any live window and defaults to the selected one.
5265 Optional argument MAX-HEIGHT specifies the maximum height of
5266 WINDOW and defaults to the height of WINDOW's frame. Optional
5267 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5268 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5269 are specified in lines and include the mode line and header line,
5270 if any.
5272 Optional argument OVERRIDE non-nil means override restrictions
5273 imposed by `window-min-height' and `window-min-width' on the size
5274 of WINDOW.
5276 Return the number of lines by which WINDOW was enlarged or
5277 shrunk. If an error occurs during resizing, return nil but don't
5278 signal an error.
5280 Note that even if this function makes WINDOW large enough to show
5281 _all_ lines of its buffer you might not see the first lines when
5282 WINDOW was scrolled."
5284 ;; Do all the work in WINDOW and its buffer and restore the selected
5285 ;; window and the current buffer when we're done.
5287 ;; Can't resize a full height or fixed-size window.
5290 ;; `with-selected-window' should orderly restore the current buffer.
5292 ;; We are in WINDOW's buffer now.
5298 window-safe-min-height)))
5301 ;; Adjust MAX-HEIGHT.
5304 max-window-height
5306 ;; Make `desired-height' the height necessary to show
5307 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5308 ;; and MAX-HEIGHT.
5313 ;; For non-minibuffers count the mode line, if any.
5315 mode-line-format)
5316 1
5318 ;; Count the header line, if any.
5320 max-height)
5321 min-height))
5330 ;; This `condition-case' shouldn't be necessary, but who knows?
5333 ;; Return zero if DELTA became zero in the process.
5334 0
5335 ;; Don't try to redisplay with the cursor at the end on its
5336 ;; own line--that would force a scroll and spoil things.
5338 ;; It's silly to put `point' at the end of the previous
5339 ;; line and so maybe force horizontal scrolling.
5341 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5343 ;; Check if the last line is surely fully visible. If
5344 ;; not, enlarge the window.
5348 ;; Don't include final newline.
5351 ;; If line-wrapping is turned off, test the
5352 ;; beginning of the last line for
5353 ;; visibility instead of the end, as the
5354 ;; end of the line could be invisible by
5355 ;; virtue of extending past the edge of the
5356 ;; window.
5360 ;; This loop might in some rare pathological cases raise
5361 ;; an error - another reason for the `condition-case'.
5368 delta))))
5371 "Return t if WINDOW can be shrunk without shrinking other windows.
5372 WINDOW defaults to the selected window."
5379 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5380 More precisely, shrink WINDOW vertically to be as small as
5381 possible, while still showing the full contents of its buffer.
5382 WINDOW defaults to the selected window.
5384 Do not shrink WINDOW to less than `window-min-height' lines. Do
5385 nothing if the buffer contains more lines than the present window
5386 height, or if some of the window's contents are scrolled out of
5387 view, or if shrinking this window would also shrink another
5388 window, or if the window is the only window of its frame.
5390 Return non-nil if the window was shrunk, nil otherwise."
5393 ;; Make sure that WINDOW is vertically combined and `point-min' is
5394 ;; visible (for whatever reason that's needed). The remaining issues
5395 ;; should be taken care of by `fit-window-to-buffer'.
5399 \f
5401 "Kill the current buffer and delete the selected window."
5410 ;; If `delete-window' failed before, we rerun it to regenerate
5411 ;; the error so it can be seen in the echo area.
5414 ;; If the buffer is not dead for some reason (probably because
5415 ;; of a `quit' signal), remove the hook again.
5420 \f
5422 "Indicates the last recenter operation performed.
5426 "Cycling order for `recenter-top-bottom'.
5427 A list of elements with possible values `top', `middle', `bottom',
5428 integer or float numbers that define the cycling order for
5429 the command `recenter-top-bottom'.
5431 Top and bottom destinations are `scroll-margin' lines from the true
5432 window top and bottom. Middle redraws the frame and centers point
5433 vertically within the window. Integer number moves current line to
5434 the specified absolute window-line. Float number between 0.0 and 1.0
5435 means the percentage of the screen space from the top. The default
5436 cycling order is middle -> top -> bottom."
5447 "Move current buffer line to the specified window line.
5448 With no prefix argument, successive calls place point according
5449 to the cycling order defined by `recenter-positions'.
5451 A prefix argument is handled like `recenter':
5452 With numeric prefix ARG, move current line to window-line ARG.
5453 With plain `C-u', move current line to window center."
5461 recenter-positions))
5480 "Position point relative to window.
5482 With a prefix argument ARG, acts like `move-to-window-line'.
5484 With no argument, positions point at center of window.
5485 Successive calls position point at positions defined
5486 by `recenter-positions'."
5494 recenter-positions))
5511 \f
5512 ;;; Scrolling commands.
5514 ;;; Scrolling commands which do not signal errors at top/bottom
5515 ;;; of buffer at first key-press (instead move to top/bottom
5516 ;;; of buffer).
5519 "Move point to top/bottom of buffer before signaling a scrolling error.
5520 A value of nil means just signal an error if no more scrolling possible.
5521 A value of t means point moves to the beginning or the end of the buffer
5522 \(depending on scrolling direction) when no more scrolling possible.
5523 When point is already on that position, then signal an error."
5529 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5530 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5531 scroll window further, move cursor to the bottom line.
5532 When point is already on that position, then signal an error.
5533 A near full screen is `next-screen-context-lines' less than a full screen.
5534 Negative ARG means scroll downward.
5535 If ARG is the atom `-', scroll downward by nearly full screen."
5551 ;; When scrolling by ARG lines can't be done,
5552 ;; move by ARG lines instead.
5554 ;; When ARG is nil for full-screen scrolling,
5555 ;; move to the bottom of the buffer.
5561 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5562 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5563 scroll window further, move cursor to the top line.
5564 When point is already on that position, then signal an error.
5565 A near full screen is `next-screen-context-lines' less than a full screen.
5566 Negative ARG means scroll upward.
5567 If ARG is the atom `-', scroll upward by nearly full screen."
5583 ;; When scrolling by ARG lines can't be done,
5584 ;; move by ARG lines instead.
5586 ;; When ARG is nil for full-screen scrolling,
5587 ;; move to the top of the buffer.
5592 ;;; Scrolling commands which scroll a line instead of full screen.
5595 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5596 If ARG is omitted or nil, scroll upward by one line.
5597 This is different from `scroll-up-command' that scrolls a full screen."
5604 "Scroll text of selected window down ARG lines; or one line if no ARG.
5605 If ARG is omitted or nil, scroll down by one line.
5606 This is different from `scroll-down-command' that scrolls a full screen."
5612 \f
5615 For more details, see the documentation for `scroll-other-window'."
5618 ;; Just invert the argument's meaning.
5619 ;; We can do that without knowing which window it will be.
5625 "Move point to the beginning of the buffer in the other window.
5626 Leave mark at previous position.
5627 With arg N, put point N/10 of the way from the true beginning."
5631 ;; We use unwind-protect rather than save-window-excursion
5632 ;; because the latter would preserve the things we want to change.
5636 ;; Set point and mark in that window's buffer.
5639 ;; Set point accordingly.
5644 "Move point to the end of the buffer in the other window.
5645 Leave mark at previous position.
5646 With arg N, put point N/10 of the way from the true end."
5648 ;; See beginning-of-buffer-other-window for comments.
5658 \f
5669 "When non-nil, special state of delayed window autoselection.
5670 Possible values are `suspend' (suspend autoselection after a menu or
5671 scrollbar interaction) and `select' (the next invocation of
5675 "Cancel delayed window autoselection.
5676 Optional argument FORCE means cancel unconditionally."
5678 ;; Don't cancel for select-window or select-frame events
5679 ;; or when the user drags a scroll bar.
5691 "Start delayed window autoselection.
5692 MOUSE-POSITION is the last position where the mouse was seen as returned
5693 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5694 window where the mouse was seen. Optional argument SUSPEND non-nil
5695 means suspend autoselection."
5696 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5700 ;; Install timer which runs `mouse-autoselect-window-select' after
5701 ;; `mouse-autoselect-window' seconds.
5707 "Select window with delayed window autoselection.
5708 If the mouse position has stabilized in a non-selected window, select
5709 that window. The minibuffer window is selected only if the minibuffer
5710 is active. This function is run by `mouse-autoselect-window-timer'."
5721 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5722 ;; of WINDOW, temporarily suspend delayed autoselection.
5725 ;; Delayed autoselection was temporarily suspended, reenable it.
5730 ;; If `mouse-autoselect-window' is positive, select
5731 ;; window if the window is the same as before.
5733 ;; Otherwise select window if the mouse is at the same
5734 ;; position as before. Observe that the first test after
5735 ;; starting autoselection usually fails since the value of
5736 ;; `mouse-autoselect-window-position' recorded there is the
5737 ;; position where the mouse has entered the new window and
5738 ;; not necessarily where the mouse has stopped moving.
5740 ;; The minibuffer is a candidate window if it's active.
5743 ;; Mouse position has stabilized in non-selected window: Cancel
5744 ;; delayed autoselection and try to select that window.
5746 ;; Select window where mouse appears unless the selected window is the
5747 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5748 ;; and post-command hooks and trigger idle timers. To avoid delaying
5749 ;; autoselection again, set `mouse-autoselect-window-state'."
5754 unread-command-events))))
5758 ;; Mouse position has either stabilized in the selected window or at
5759 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5762 ;; Mouse position has not stabilized yet, resume delayed
5763 ;; autoselection.
5767 "Handle select-window events."
5771 ;; Don't switch if we're currently in the minibuffer.
5772 ;; This tries to work around problems where the
5773 ;; minibuffer gets unselected unexpectedly, and where
5774 ;; you then have to move your mouse all the way down to
5775 ;; the minibuffer to select it.
5777 ;; Don't switch to minibuffer window unless it's active.
5780 ;; Don't switch when autoselection shall be delayed.
5785 ;; Cancel any delayed autoselection.
5787 ;; Start delayed autoselection from current mouse
5788 ;; position and window.
5790 ;; Executing a command cancels delayed autoselection.
5794 ;; Reset state of delayed autoselection.
5796 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5798 ;; Clear echo area.
5803 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5804 WINDOW defaults to the selected window.
5805 Return nil if WINDOW is not a partial-width window
5806 (regardless of the value of `truncate-lines').
5807 Otherwise, consult the value of `truncate-partial-width-windows'
5808 for the buffer shown in WINDOW."
5816 t-p-w-w))))
5817 \f
5818 ;; Some of these are in tutorial--default-keys, so update that if you
5819 ;; change these.
5832 ;;; window.el ends here