| blob | 9006a5c3cc9ac253d0d22060fffddbd23c6ad44c |
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 t if OBJECT denotes a live window or internal window.
115 Otherwise, return nil; this includes the case where OBJECT is a
116 deleted window."
119 t))
122 "Return buffer specified by BUFFER-OR-NAME.
123 BUFFER-OR-NAME must be either a buffer or a string naming a live
124 buffer and defaults to the current buffer."
130 buffer-or-name
137 "Return frame specified by FRAME.
138 FRAME must be a live frame and defaults to the selected frame."
141 frame
146 "Return window specified by WINDOW.
147 If WINDOW is nil, return `selected-window'.
148 If WINDOW is a live window or internal window, return WINDOW;
149 if LIVE-ONLY is non-nil, return WINDOW for a live window only.
150 Otherwise, signal an error."
155 window
158 window
162 "If non-nil, standard functions ignore window parameters.
163 The functions currently affected by this are `split-window',
164 `delete-window', `delete-other-windows' and `other-window'.
166 An application may bind this to a non-nil value around calls to
170 "The absolute minimum number of lines of a window.
174 "The minimum number of lines of any window.
175 The value has to accommodate a mode- or header-line if present.
176 A value less than `window-safe-min-height' is ignored. The value
177 of this variable is honored when windows are resized or split.
179 Applications should never rebind this variable. To resize a
180 window to a height less than the one specified here, an
181 application should instead call `window-resize' with a non-nil
182 IGNORE argument. In order to have `split-window' make a window
183 shorter, explicitly specify the SIZE argument of that function."
189 "The absolute minimum number of columns of a window.
193 "The minimum number of columns of any window.
194 The value has to accommodate margins, fringes, or scrollbars if
195 present. A value less than `window-safe-min-width' is ignored.
196 The value of this variable is honored when windows are resized or
197 split.
199 Applications should never rebind this variable. To resize a
200 window to a width less than the one specified here, an
201 application should instead call `window-resize' with a non-nil
202 IGNORE argument. In order to have `split-window' make a window
203 narrower, explicitly specify the SIZE argument of that function."
209 "Return non-nil if WINDOW has siblings in a given direction.
210 If WINDOW is omitted or nil, it defaults to the selected window.
212 HORIZONTAL determines a direction for the window combination.
213 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
214 of a vertical window combination.
215 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
216 horizontal window combination."
225 "Return largest number of windows vertically arranged within WINDOW.
226 If WINDOW is omitted or nil, it defaults to the selected window.
227 If HORIZONTAL is non-nil, return the largest number of
228 windows horizontally arranged within WINDOW."
232 ;; If WINDOW is live, return 1.
237 ;; If WINDOW is iso-combined, return the sum of the values for all
238 ;; child windows of WINDOW.
244 count))
246 count))
248 ;; If WINDOW is not iso-combined, return the maximum value of any
249 ;; child window of WINDOW.
255 count))
257 count))))
260 "Helper function for `walk-window-tree' and `walk-window-subtree'."
278 "Run function FUN on each live window of FRAME.
279 FUN must be a function with one argument - a window. FRAME must
280 be a live frame and defaults to the selected one. ANY, if
281 non-nil means to run FUN on all live and internal windows of
282 FRAME.
284 This function performs a pre-order, depth-first traversal of the
285 window tree. If FUN changes the window tree, the result is
286 unpredictable."
292 "Run function FUN on the subtree of windows rooted at WINDOW.
293 WINDOW defaults to the selected window. FUN must be a function
294 with one argument - a window. By default, run FUN only on live
295 windows of the subtree. If the optional argument ANY is non-nil,
296 run FUN on all live and internal windows of the subtree. If
297 WINDOW is live, run FUN on WINDOW only.
299 This function performs a pre-order, depth-first traversal of the
300 subtree rooted at WINDOW. If FUN changes that tree, the result
301 is unpredictable."
306 "Return first window on FRAME with PARAMETER non-nil.
307 FRAME defaults to the selected frame. Optional argument VALUE
308 non-nil means only return a window whose window-parameter value
309 for PARAMETER equals VALUE (comparison is done with `equal').
310 Optional argument ANY non-nil means consider internal windows
311 too."
319 frame any))))
321 ;;; Atomic windows.
323 "Return root of atomic window WINDOW is a part of.
324 WINDOW can be any window and defaults to the selected one.
325 Return nil if WINDOW is not part of an atomic window."
331 root))
334 "Make WINDOW an atomic window.
335 WINDOW must be an internal window. Return WINDOW."
341 window t)
342 window))
345 "Subroutine of `window--atom-check'."
355 window t))
356 ;; count >= 1 must hold here. If there's no other
357 ;; window around dissolve this atomic window.
359 ;; Dissolve atomic window.
363 window t)))
364 ;; Check children.
368 ;; Check right sibling
372 "Check atomicity of all windows on FRAME.
373 FRAME defaults to the selected frame. If an atomic window is
374 wrongly configured, reset the atomicity of all its windows on
375 FRAME to nil. An atomic window is wrongly configured if it has
376 no child windows or one of its child windows is not atomic."
379 ;; Side windows.
384 "If non-nil, left and right side windows are full height.
385 Otherwise, top and bottom side windows are full width."
391 "Maximum number of side window slots.
392 The value is a list of four elements specifying the number of
393 side window slots on (in this order) the left, top, right and
394 bottom side of each frame. If an element is a number, this means
395 to display at most that many side windows on the corresponding
396 side. If an element is nil, this means there's no bound on the
397 number of slots on that side."
399 :risky t
400 :type
406 :value nil
413 :value nil
420 :value nil
427 :value nil
434 "Check the window-side parameter of all windows on FRAME.
435 FRAME defaults to the selected frame. If the configuration is
436 invalid, reset all window-side parameters to nil.
438 A valid configuration has to preserve the following invariant:
440 - If a window has a non-nil window-side parameter, it must have a
441 parent window and the parent window's window-side parameter
442 must be either nil or the same as for window.
444 - If windows with non-nil window-side parameters exist, there
445 must be at most one window of each side and non-side with a
446 parent whose window-side parameter is nil and there must be no
447 leaf window whose window-side parameter is nil."
449 side parent parent-side)
457 ;; The following `cond' seems a bit tedious, but I'd
458 ;; rather stick to using just the stack.
462 ;; A parent whose window-side is non-nil must
463 ;; have a child with the same window-side.
465 ;; Now check that there's more than one main window
466 ;; for any of none, left, top, right and bottom.
488 ;; A leaf window without window-side parameter,
489 ;; record its existence.
491 frame t))
493 ;; At least one non-side window exists, so there must
494 ;; be at least one side-window and no normal window.
496 ;; No non-side window exists, so there must be no side
497 ;; window either.
502 frame t))))
505 "Check atomic and side windows on FRAME.
506 FRAME defaults to the selected frame."
510 ;;; Window sizes.
512 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
513 If the value is `height', then only the window's height is fixed.
514 If the value is `width', then only the window's width is fixed.
515 Any other non-nil value fixes both the width and the height.
517 Emacs won't change the size of any window displaying that buffer,
518 unless it has no other choice (like when deleting a neighboring
523 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
527 "Return the minimum size of WINDOW.
528 WINDOW can be an arbitrary window and defaults to the selected
529 one. Optional argument HORIZONTAL non-nil means return the
530 minimum number of columns of WINDOW; otherwise return the minimum
531 number of WINDOW's lines.
533 Optional argument IGNORE, if non-nil, means ignore restrictions
534 imposed by fixed size windows, `window-min-height' or
535 `window-min-width' settings. If IGNORE equals `safe', live
536 windows may get as small as `window-safe-min-height' lines and
537 `window-safe-min-width' columns. If IGNORE is a window, ignore
538 restrictions for that window only. Any other non-nil value
539 means ignore all of the above restrictions for all windows."
544 "Internal function of `window-min-size'."
548 ;; WINDOW is an internal window.
550 ;; The minimum size of an iso-combination is the sum of
551 ;; the minimum sizes of its child windows.
556 ;; The minimum size of an ortho-combination is the maximum of
557 ;; the minimum sizes of its child windows.
562 value)
567 ;; The minimum size of a fixed size window is its size.
570 ;; If IGNORE equals `safe' or WINDOW return the safe values.
573 ;; For the minimum width of a window take fringes and
574 ;; scroll-bars into account. This is questionable and should
575 ;; be removed as soon as we are able to split (and resize)
576 ;; windows such that the new (or resized) windows can get a
577 ;; size less than the user-specified `window-min-height' and
578 ;; `window-min-width'.
583 (+ window-safe-min-width
596 window-min-width
599 ;; For the minimum height of a window take any mode- or
600 ;; header-line into account.
606 window-min-height
610 "Return DELTA if DELTA lines can be added to WINDOW.
611 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
612 columns can be added to WINDOW. A return value of zero means
613 that no lines (or columns) can be added to WINDOW.
615 This function looks only at WINDOW and, recursively, its child
616 windows. The function `window-resizable' looks at other windows
617 as well.
619 DELTA positive means WINDOW shall be enlarged by DELTA lines or
620 columns. If WINDOW cannot be enlarged by DELTA lines or columns
621 return the maximum value in the range 0..DELTA by which WINDOW
622 can be enlarged.
624 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
625 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
626 return the minimum value in the range DELTA..0 by which WINDOW
627 can be shrunk.
629 Optional argument IGNORE non-nil means ignore restrictions
630 imposed by fixed size windows, `window-min-height' or
631 `window-min-width' settings. If IGNORE equals `safe', live
632 windows may get as small as `window-safe-min-height' lines and
633 `window-safe-min-width' columns. If IGNORE is a window, ignore
634 restrictions for that window only. Any other non-nil value means
635 ignore all of the above restrictions for all windows."
641 delta))
643 delta)
646 0
647 delta))
651 "Return t if WINDOW can be resized by DELTA lines.
652 For the meaning of the arguments of this function see the
653 doc-string of `window-sizable'."
660 "Internal function for `window-size-fixed-p'."
664 ;; WINDOW is an internal window.
666 ;; An iso-combination is fixed size if all its child
667 ;; windows are fixed-size.
671 ;; We found a non-fixed-size child window, so
672 ;; WINDOW's size is not fixed.
675 ;; All child windows are fixed-size, so WINDOW's size is
676 ;; fixed.
678 ;; An ortho-combination is fixed-size if at least one of its
679 ;; child windows is fixed-size.
682 ;; We found a fixed-size child window, so WINDOW's size
683 ;; is fixed.
686 ;; WINDOW is a live window.
693 "Return non-nil if WINDOW's height is fixed.
694 WINDOW can be an arbitrary window and defaults to the selected
695 window. Optional argument HORIZONTAL non-nil means return
696 non-nil if WINDOW's width is fixed.
698 If this function returns nil, this does not necessarily mean that
699 WINDOW can be resized in the desired direction. The function
700 `window-resizable' can tell that."
705 "Internal function for `window-min-delta'."
707 ;; If we can't go up, return zero.
708 0
709 ;; Else try to find a non-fixed-size sibling of WINDOW.
714 ;; In an iso-combination throw DELTA if we find at least one
715 ;; child window and that window is either not fixed-size or
716 ;; we can ignore fixed-sizeness.
726 ;; We found a non-fixed-size child window.
729 ;; In an ortho-combination set DELTA to the minimum value by
730 ;; which other child windows can shrink.
739 delta
743 "Return number of lines by which WINDOW can be shrunk.
744 WINDOW can be an arbitrary window and defaults to the selected
745 window. Return zero if WINDOW cannot be shrunk.
747 Optional argument HORIZONTAL non-nil means return number of
748 columns by which WINDOW can be shrunk.
750 Optional argument IGNORE non-nil means ignore restrictions
751 imposed by fixed size windows, `window-min-height' or
752 `window-min-width' settings. If IGNORE is a window, ignore
753 restrictions for that window only. If IGNORE equals `safe',
754 live windows may get as small as `window-safe-min-height' lines
755 and `window-safe-min-width' columns. Any other non-nil value
756 means ignore all of the above restrictions for all windows.
758 Optional argument TRAIL restricts the windows that can be enlarged.
759 If its value is `before', only windows to the left of or above WINDOW
760 can be enlarged. If it is `after', only windows to the right of or
761 below WINDOW can be enlarged.
763 Optional argument NOUP non-nil means don't go up in the window
764 tree, but try to enlarge windows within WINDOW's combination only.
766 Optional argument NODOWN non-nil means don't check whether WINDOW
767 itself (and its child windows) can be shrunk; check only whether
768 at least one other window can be enlarged appropriately."
774 ;; If NODOWN is t, try to recover the entire size of WINDOW.
777 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
778 ;; there's nothing to recover.
781 ;; Otherwise, try to recover whatever WINDOW is larger than its
782 ;; minimum size.
787 "Internal function of `window-max-delta'."
789 ;; Can't go up. Return DELTA.
790 delta
795 ;; For an iso-combination calculate how much we can get from
796 ;; other child windows.
805 (+ delta
809 ;; For an ortho-combination throw DELTA when at least one
810 ;; child window is fixed-size.
818 ;; When NOUP is nil, DELTA is all we can get.
819 delta
820 ;; Else try with parent of WINDOW, passing the DELTA we
821 ;; recovered so far.
825 "Return maximum number of lines by which WINDOW can be enlarged.
826 WINDOW can be an arbitrary window and defaults to the selected
827 window. The return value is zero if WINDOW cannot be enlarged.
829 Optional argument HORIZONTAL non-nil means return maximum number
830 of columns by which WINDOW can be enlarged.
832 Optional argument IGNORE non-nil means ignore restrictions
833 imposed by fixed size windows, `window-min-height' or
834 `window-min-width' settings. If IGNORE is a window, ignore
835 restrictions for that window only. If IGNORE equals `safe',
836 live windows may get as small as `window-safe-min-height' lines
837 and `window-safe-min-width' columns. Any other non-nil value means
838 ignore all of the above restrictions for all windows.
840 Optional argument TRAIL restricts the windows that can be enlarged.
841 If its value is `before', only windows to the left of or above WINDOW
842 can be enlarged. If it is `after', only windows to the right of or
843 below WINDOW can be enlarged.
845 Optional argument NOUP non-nil means don't go up in the window
846 tree but try to obtain the entire space from windows within
847 WINDOW's combination.
849 Optional argument NODOWN non-nil means do not check whether
850 WINDOW itself (and its child windows) can be enlarged; check
851 only whether other windows can be shrunk appropriately."
855 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
856 ;; size.
857 0
858 ;; WINDOW has no fixed size.
861 ;; Make NOUP also inhibit the min-size check.
863 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
864 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
865 can be resized horizontally by DELTA columns. A return value of
866 zero means that WINDOW is not resizable.
868 DELTA positive means WINDOW shall be enlarged by DELTA lines or
869 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
870 return the maximum value in the range 0..DELTA by which WINDOW
871 can be enlarged.
873 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
874 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
875 return the minimum value in the range DELTA..0 that can be used
876 for shrinking WINDOW.
878 Optional argument IGNORE non-nil means ignore restrictions
879 imposed by fixed size windows, `window-min-height' or
880 `window-min-width' settings. If IGNORE is a window, ignore
881 restrictions for that window only. If IGNORE equals `safe',
882 live windows may get as small as `window-safe-min-height' lines
883 and `window-safe-min-width' columns. Any other non-nil value
884 means ignore all of the above restrictions for all windows.
886 Optional argument TRAIL `before' means only windows to the left
887 of or below WINDOW can be shrunk. Optional argument TRAIL
888 `after' means only windows to the right of or above WINDOW can be
889 shrunk.
891 Optional argument NOUP non-nil means don't go up in the window
892 tree but check only whether space can be obtained from (or given
893 to) WINDOW's siblings.
895 Optional argument NODOWN non-nil means don't go down in the
896 window tree. This means do not check whether resizing would
897 violate size restrictions of WINDOW or its child windows."
902 delta))
905 delta))
909 "Return t if WINDOW can be resized vertically by DELTA lines.
910 For the meaning of the arguments of this function see the
911 doc-string of `window--resizable'."
915 delta)
917 delta)))
920 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
921 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
922 can be resized horizontally by DELTA columns. A return value of
923 zero means that WINDOW is not resizable.
925 DELTA positive means WINDOW shall be enlarged by DELTA lines or
926 columns. If WINDOW cannot be enlarged by DELTA lines or columns
927 return the maximum value in the range 0..DELTA by which WINDOW
928 can be enlarged.
930 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
931 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
932 return the minimum value in the range DELTA..0 that can be used
933 for shrinking WINDOW.
935 Optional argument IGNORE non-nil means ignore restrictions
936 imposed by fixed size windows, `window-min-height' or
937 `window-min-width' settings. If IGNORE is a window, ignore
938 restrictions for that window only. If IGNORE equals `safe',
939 live windows may get as small as `window-safe-min-height' lines
940 and `window-safe-min-width' columns. Any other non-nil value
941 means ignore all of the above restrictions for all windows."
946 "Return the total height or width of WINDOW.
947 If WINDOW is omitted or nil, it defaults to the selected window.
949 If HORIZONTAL is omitted or nil, return the total height of
950 WINDOW, in lines, like `window-total-height'. Otherwise return
951 the total width, in columns, like `window-total-width'."
956 ;; Eventually we should make `window-height' obsolete.
959 ;; See discussion in bug#4543.
961 "Return t if WINDOW is as high as its containing frame.
962 More precisely, return t if and only if the total height of
963 WINDOW equals the total height of the root window of WINDOW's
964 frame. WINDOW can be any window and defaults to the selected
965 one."
971 "Return t if WINDOW is as wide as its containing frame.
972 More precisely, return t if and only if the total width of WINDOW
973 equals the total width of the root window of WINDOW's frame.
974 WINDOW can be any window and defaults to the selected one."
980 "Return the height or width of WINDOW's text area.
981 If WINDOW is omitted or nil, it defaults to the selected window.
982 Signal an error if the window is not live.
984 If HORIZONTAL is omitted or nil, return the height of the text
985 area, like `window-body-height'. Otherwise, return the width of
986 the text area, like `window-body-width'."
991 ;; Eventually we should make `window-height' obsolete.
995 "Return the current scroll bar settings for WINDOW.
996 WINDOW must be a live window and defaults to the selected one.
998 The return value is a cons cell (VERTICAL . HORIZONTAL) where
999 VERTICAL specifies the current location of the vertical scroll
1000 bars (`left', `right', or nil), and HORIZONTAL specifies the
1001 current location of the horizontal scroll bars (`top', `bottom',
1002 or nil).
1004 Unlike `window-scroll-bars', this function reports the scroll bar
1005 type actually used, once frame defaults and `scroll-bar-mode' are
1006 taken into account."
1019 "Cycle through all live windows, calling FUN for each one.
1020 FUN must specify a function with a window as its sole argument.
1021 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1022 windows to include in the walk.
1024 MINIBUF t means include the minibuffer window even if the
1025 minibuffer is not active. MINIBUF nil or omitted means include
1026 the minibuffer window only if the minibuffer is active. Any
1027 other value means do not include the minibuffer window even if
1028 the minibuffer is active.
1030 ALL-FRAMES nil or omitted means consider all windows on the
1031 selected frame, plus the minibuffer window if specified by the
1032 MINIBUF argument. If the minibuffer counts, consider all windows
1033 on all frames that share that minibuffer too. The following
1034 non-nil values of ALL-FRAMES have special meanings:
1036 - t means consider all windows on all existing frames.
1038 - `visible' means consider all windows on all visible frames on
1039 the current terminal.
1041 - 0 (the number zero) means consider all windows on all visible
1042 and iconified frames on the current terminal.
1044 - A frame means consider all windows on that frame only.
1046 Anything else means consider all windows on the selected frame
1047 and no others.
1049 This function changes neither the order of recently selected
1050 windows nor the buffer list."
1051 ;; If we start from the minibuffer window, don't fail to come
1052 ;; back to it.
1055 ;; Make sure to not mess up the order of recently selected
1056 ;; windows. Use `save-selected-window' and `select-window'
1057 ;; with second argument non-nil for this purpose.
1065 "Return value of WINDOW's point.
1066 WINDOW can be any live window and defaults to the selected one.
1068 This function is like `window-point' with one exception: If
1069 WINDOW is selected, it returns the value of `point' of WINDOW's
1070 buffer regardless of whether that buffer is current or not."
1078 "Set value of WINDOW's point to POS.
1079 WINDOW can be any live window and defaults to the selected one.
1081 This function is like `set-window-point' with one exception: If
1082 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1083 regardless of whether that buffer is current or not."
1091 "Return t if WINDOW is at SIDE of its containing frame.
1092 WINDOW can be any window and defaults to the selected one. SIDE
1093 can be any of the symbols `left', `top', `right' or `bottom'.
1094 The default value nil is handled like `bottom'."
1106 "Return list of all windows on SIDE of FRAME.
1107 FRAME must be a live frame and defaults to the selected frame.
1108 SIDE can be any of the symbols `left', `top', `right' or
1109 `bottom'. The default value nil is handled like `bottom'."
1116 frame)
1120 "Support function for `window-in-direction'."
1132 "Return window in DIRECTION as seen from WINDOW.
1133 DIRECTION must be one of `above', `below', `left' or `right'.
1134 WINDOW must be a live window and defaults to the selected one.
1135 IGNORE non-nil means a window can be returned even if its
1136 `no-other-window' parameter is non-nil."
1149 ;; The column / row value of `posn-at-point' can be nil for the
1150 ;; mini-window, guard against that.
1161 best best-2 best-diff-2-new)
1168 ;; Ignore ourselves.
1170 ;; Ignore W unless IGNORE is non-nil.
1176 ;; W is to the left or right of WINDOW and covers POSN.
1186 ;; W is to the left or right of WINDOW but does not
1187 ;; cover POSN.
1202 ;; W is above or below WINDOW and covers POSN.
1212 ;; W is above or below WINDOW but does not cover POSN.
1227 "Return a live window satisfying PREDICATE.
1228 More precisely, cycle through all windows calling the function
1229 PREDICATE on each one of them with the window as its sole
1230 argument. Return the first window for which PREDICATE returns
1231 non-nil. Windows are scanned starting with the window following
1232 the selected window. If no window satisfies PREDICATE, return
1233 DEFAULT.
1235 MINIBUF t means include the minibuffer window even if the
1236 minibuffer is not active. MINIBUF nil or omitted means include
1237 the minibuffer window only if the minibuffer is active. Any
1238 other value means do not include the minibuffer window even if
1239 the minibuffer is active.
1241 ALL-FRAMES nil or omitted means consider all windows on the selected
1242 frame, plus the minibuffer window if specified by the MINIBUF
1243 argument. If the minibuffer counts, consider all windows on all
1244 frames that share that minibuffer too. The following non-nil
1245 values of ALL-FRAMES have special meanings:
1247 - t means consider all windows on all existing frames.
1249 - `visible' means consider all windows on all visible frames on
1250 the current terminal.
1252 - 0 (the number zero) means consider all windows on all visible
1253 and iconified frames on the current terminal.
1255 - A frame means consider all windows on that frame only.
1257 Anything else means consider all windows on the selected frame
1258 and no others."
1262 minibuf all-frames))
1265 default))
1270 "Return the least recently used window on frames specified by ALL-FRAMES.
1271 Return a full-width window if possible. A minibuffer window is
1272 never a candidate. A dedicated window is never a candidate
1273 unless DEDICATED is non-nil, so if all windows are dedicated, the
1274 value is nil. Avoid returning the selected window if possible.
1275 Optional argument NOT-SELECTED non-nil means never return the
1276 selected window.
1278 The following non-nil values of the optional argument ALL-FRAMES
1279 have special meanings:
1281 - t means consider all windows on all existing frames.
1283 - `visible' means consider all windows on all visible frames on
1284 the current terminal.
1286 - 0 (the number zero) means consider all windows on all visible
1287 and iconified frames on the current terminal.
1289 - A frame means consider all windows on that frame only.
1291 Any other value of ALL-FRAMES means consider all windows on the
1292 selected frame and no others."
1309 "Return the most recently used window on frames specified by ALL-FRAMES.
1310 A minibuffer window is never a candidate. A dedicated window is
1311 never a candidate unless DEDICATED is non-nil, so if all windows
1312 are dedicated, the value is nil. Optional argument NOT-SELECTED
1313 non-nil means never return the selected window.
1315 The following non-nil values of the optional argument ALL-FRAMES
1316 have special meanings:
1318 - t means consider all windows on all existing frames.
1320 - `visible' means consider all windows on all visible frames on
1321 the current terminal.
1323 - 0 (the number zero) means consider all windows on all visible
1324 and iconified frames on the current terminal.
1326 - A frame means consider all windows on that frame only.
1328 Any other value of ALL-FRAMES means consider all windows on the
1329 selected frame and no others."
1338 best-window))
1341 "Return the largest window on frames specified by ALL-FRAMES.
1342 A minibuffer window is never a candidate. A dedicated window is
1343 never a candidate unless DEDICATED is non-nil, so if all windows
1344 are dedicated, the value is nil. Optional argument NOT-SELECTED
1345 non-nil means never return the selected window.
1347 The following non-nil values of the optional argument ALL-FRAMES
1348 have special meanings:
1350 - t means consider all windows on all existing frames.
1352 - `visible' means consider all windows on all visible frames on
1353 the current terminal.
1355 - 0 (the number zero) means consider all windows on all visible
1356 and iconified frames on the current terminal.
1358 - A frame means consider all windows on that frame only.
1360 Any other value of ALL-FRAMES means consider all windows on the
1361 selected frame and no others."
1363 best-window size)
1372 best-window))
1375 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1376 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1377 and defaults to the current buffer. Windows are scanned starting
1378 with the selected window.
1380 MINIBUF t means include the minibuffer window even if the
1381 minibuffer is not active. MINIBUF nil or omitted means include
1382 the minibuffer window only if the minibuffer is active. Any
1383 other value means do not include the minibuffer window even if
1384 the minibuffer is active.
1386 ALL-FRAMES nil or omitted means consider all windows on the
1387 selected frame, plus the minibuffer window if specified by the
1388 MINIBUF argument. If the minibuffer counts, consider all windows
1389 on all frames that share that minibuffer too. The following
1390 non-nil values of ALL-FRAMES have special meanings:
1392 - t means consider all windows on all existing frames.
1394 - `visible' means consider all windows on all visible frames on
1395 the current terminal.
1397 - 0 (the number zero) means consider all windows on all visible
1398 and iconified frames on the current terminal.
1400 - A frame means consider all windows on that frame only.
1402 Anything else means consider all windows on the selected frame
1403 and no others."
1405 windows)
1412 "Return t if WINDOW is the currently active minibuffer window."
1416 "Return the number of live windows on the selected frame.
1417 The optional argument MINIBUF specifies whether the minibuffer
1418 window shall be counted. See `walk-windows' for the precise
1419 meaning of this argument."
1421 \f
1422 ;;; Resizing windows.
1424 "Reset resize values for all windows on FRAME.
1425 FRAME defaults to the selected frame.
1427 This function stores the current value of `window-total-size' applied
1428 with argument HORIZONTAL in the new total size of all windows on
1429 FRAME. It also resets the new normal size of each of these
1430 windows."
1435 "Internal function of `window--resize-reset'."
1436 ;; Register old size in the new total size.
1438 ;; Reset new normal size.
1445 ;; The following routine is used to manually resize the minibuffer
1446 ;; window and is currently used, for example, by ispell.el.
1448 "Resize minibuffer window WINDOW by DELTA lines.
1449 If WINDOW cannot be resized by DELTA lines make it as large (or
1450 as small) as possible, but don't signal an error."
1458 ;; Sanitize DELTA.
1465 ;; Resize now.
1467 ;; Ideally we should be able to resize just the last child of root
1468 ;; here. See the comment in `resize-root-window-vertically' for
1469 ;; why we do not do that.
1472 ;; The following routine catches the case where we want to resize
1473 ;; a minibuffer-only frame.
1477 "Resize WINDOW vertically by DELTA lines.
1478 WINDOW can be an arbitrary window and defaults to the selected
1479 one. An attempt to resize the root window of a frame will raise
1480 an error though.
1482 DELTA a positive number means WINDOW shall be enlarged by DELTA
1483 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1484 lines.
1486 Optional argument HORIZONTAL non-nil means resize WINDOW
1487 horizontally by DELTA columns. In this case a positive DELTA
1488 means enlarge WINDOW by DELTA columns. DELTA negative means
1489 WINDOW shall be shrunk by -DELTA columns.
1491 Optional argument IGNORE non-nil means ignore restrictions
1492 imposed by fixed size windows, `window-min-height' or
1493 `window-min-width' settings. If IGNORE is a window, ignore
1494 restrictions for that window only. If IGNORE equals `safe',
1495 live windows may get as small as `window-safe-min-height' lines
1496 and `window-safe-min-width' columns. Any other non-nil value
1497 means ignore all of the above restrictions for all windows.
1499 This function resizes other windows proportionally and never
1500 deletes any windows. If you want to move only the low (right)
1501 edge of WINDOW consider using `adjust-window-trailing-edge'
1502 instead."
1506 sibling)
1519 ;; If WINDOW is full height and either `resize-mini-windows' is
1520 ;; nil or the minibuffer window is active, resize the minibuffer
1521 ;; window.
1530 ;; If window-combination-resize is nil, WINDOW is part of an
1531 ;; iso-combination, and WINDOW's neighboring right or left
1532 ;; sibling can be resized as requested, resize that sibling.
1539 normal-delta))
1542 normal-delta)))
1543 ;; Otherwise, resize all other windows in the same combination.
1550 "Return non-nil if WINDOW shall be skipped by resizing routines."
1553 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1554 "Recursively set new normal height of child windows of window PARENT.
1555 HORIZONTAL non-nil means set the new normal width of these
1556 windows. WINDOW specifies a child window of PARENT that has been
1557 resized by THIS-DELTA lines (columns).
1559 Optional argument TRAIL either `before' or `after' means set values
1560 only for windows before or after WINDOW. Optional argument
1561 OTHER-DELTA, a number, specifies that this many lines (columns)
1562 have been obtained from (or returned to) an ancestor window of
1563 PARENT in order to resize WINDOW."
1567 ;; When WINDOW gets deleted and we can return its entire
1568 ;; space to its siblings, use WINDOW's normal size as the
1569 ;; normal delta.
1571 ;; In any other case calculate the normal delta from the
1572 ;; relation of THIS-DELTA to the total size of PARENT.
1578 ;; Set parent-normal to the sum of the normal sizes of all child
1579 ;; windows of PARENT that shall be resized, excluding only WINDOW
1580 ;; and any windows specified by the optional TRAIL argument.
1591 ;; Set the new normal size of all child windows of PARENT from what
1592 ;; they should have contributed for recovering THIS-DELTA lines
1593 ;; (columns).
1607 delta-normal))
1608 ;; Don't drop below 0.
1613 ;; Set the new normal size of windows from what they should have
1614 ;; contributed for recovering OTHER-DELTA lines (columns).
1617 other-delta)))
1629 ;; Don't drop below 0.
1633 ;; Set the new normal size of WINDOW to what is left by the sum of
1634 ;; the normal sizes of its siblings.
1636 window
1647 ;; Don't get larger than 1 or smaller than 0.
1650 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1651 "Resize child windows of window PARENT vertically by DELTA lines.
1652 PARENT must be a vertically combined internal window.
1654 Optional argument HORIZONTAL non-nil means resize child windows of
1655 PARENT horizontally by DELTA columns. In this case PARENT must
1656 be a horizontally combined internal window.
1658 WINDOW, if specified, must denote a child window of PARENT that
1659 is resized by DELTA lines.
1661 Optional argument IGNORE non-nil means ignore restrictions
1662 imposed by fixed size windows, `window-min-height' or
1663 `window-min-width' settings. If IGNORE equals `safe', live
1664 windows may get as small as `window-safe-min-height' lines and
1665 `window-safe-min-width' columns. If IGNORE is a window, ignore
1666 restrictions for that window only. Any other non-nil value means
1667 ignore all of the above restrictions for all windows.
1669 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1670 of windows that shall be resized. If TRAIL equals `before',
1671 resize only windows on the left or above EDGE. If TRAIL equals
1672 `after', resize only windows on the right or below EDGE. Also,
1673 preferably only resize windows adjacent to EDGE.
1675 Return the symbol `normalized' if new normal sizes have been
1676 already set by this routine."
1680 best-window best-value)
1692 sub)
1697 edge)
1702 edge)
1705 ;; Resize only windows adjacent to EDGE.
1708 sub delta horizontal ignore t trail edge)
1711 ;; Assign new normal sizes.
1720 ;; Return 'normalized to notify `window--resize-siblings' that
1721 ;; normal sizes have been already set.
1723 ;; Resize all windows proportionally.
1728 ;; Ignore windows to skip and fixed-size child windows -
1729 ;; in the latter case make it a window to skip.
1734 ;; When shrinking store the number of lines/cols we can get
1735 ;; from this window here together with the total/normal size
1736 ;; factor.
1738 sub
1740 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1743 parent-total)
1746 ;; When enlarging store the total/normal size factor only
1748 sub
1750 parent-total)
1757 ;; Shrink windows by delta.
1776 best-window
1781 parent-total)
1784 ;; Enlarge windows by delta.
1802 best-window
1804 parent-total)
1812 ;; Reset new normal size fields so `window-resize-apply'
1813 ;; won't use them to apply new sizes.
1817 ;; Resize this window's child windows (back-engineering
1818 ;; delta from sub's old and new total sizes).
1822 ;; For the TRAIL non-nil case we have to resize SUB
1823 ;; recursively even if it's size does not change.
1825 sub delta horizontal ignore nil trail edge))))
1829 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1830 Optional argument HORIZONTAL non-nil means resize other windows
1831 when WINDOW is resized horizontally by DELTA columns. WINDOW
1832 itself is not resized by this function.
1834 Optional argument IGNORE non-nil means ignore restrictions
1835 imposed by fixed size windows, `window-min-height' or
1836 `window-min-width' settings. If IGNORE equals `safe', live
1837 windows may get as small as `window-safe-min-height' lines and
1838 `window-safe-min-width' columns. If IGNORE is a window, ignore
1839 restrictions for that window only. Any other non-nil value means
1840 ignore all of the above restrictions for all windows.
1842 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1843 of windows that shall be resized. If TRAIL equals `before',
1844 resize only windows on the left or above EDGE. If TRAIL equals
1845 `after', resize only windows on the right or below EDGE. Also,
1846 preferably only resize windows adjacent to EDGE."
1851 ;; In an iso-combination try to extract DELTA from WINDOW's
1852 ;; siblings.
1854 this-delta other-delta)
1855 ;; Decide which windows shall be left alone.
1859 ;; Make sure WINDOW is left alone when
1860 ;; resizing its siblings.
1864 ;; Make sure this sibling is left alone when
1865 ;; resizing its siblings.
1869 ;; Set this-delta to t to signal that we found a sibling
1870 ;; of WINDOW whose size is not fixed.
1875 ;; Set this-delta to what we can get from WINDOW's siblings.
1877 ;; A deletion, presumably. We must handle this case
1878 ;; specially since `window--resizable' can't be used.
1880 ;; There's at least one resizable sibling we can
1881 ;; give WINDOW's size to.
1883 ;; No resizable sibling exists.
1885 ;; Any other form of resizing.
1889 ;; Set other-delta to what we still have to get from
1890 ;; ancestor windows of parent.
1893 ;; Unless we got everything from WINDOW's siblings, PARENT
1894 ;; must be resized by other-delta lines or columns.
1898 ;; We haven't got anything from WINDOW's siblings but we
1899 ;; must update the normal sizes to respect other-delta.
1901 parent horizontal window this-delta trail other-delta)
1902 ;; We did get something from WINDOW's siblings which means
1903 ;; we have to resize their child windows.
1906 window ignore trail edge)
1907 ;; If `window--resize-child-windows' returns
1908 ;; 'normalized, this means it has set the
1909 ;; normal sizes already.
1911 ;; Set the normal sizes.
1913 parent horizontal window this-delta trail other-delta))
1914 ;; Set DELTA to what we still have to get from ancestor
1915 ;; windows.
1918 ;; In an ortho-combination all siblings of WINDOW must be
1919 ;; resized by DELTA.
1927 ;; "Go up."
1929 parent delta horizontal ignore trail edge)))))
1932 "Resize WINDOW vertically by DELTA lines.
1933 Optional argument HORIZONTAL non-nil means resize WINDOW
1934 horizontally by DELTA columns.
1936 Optional argument IGNORE non-nil means ignore restrictions
1937 imposed by fixed size windows, `window-min-height' or
1938 `window-min-width' settings. If IGNORE equals `safe', live
1939 windows may get as small as `window-safe-min-height' lines and
1940 `window-safe-min-width' columns. If IGNORE is a window, ignore
1941 restrictions for that window only. Any other non-nil value
1942 means ignore all of the above restrictions for all windows.
1944 Optional argument ADD non-nil means add DELTA to the new total
1945 size of WINDOW.
1947 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1948 of windows that shall be resized. If TRAIL equals `before',
1949 resize only windows on the left or above EDGE. If TRAIL equals
1950 `after', resize only windows on the right or below EDGE. Also,
1951 preferably only resize windows adjacent to EDGE.
1953 This function recursively resizes WINDOW's child windows to fit the
1954 new size. Make sure that WINDOW is `window--resizable' before
1955 calling this function. Note that this function does not resize
1956 siblings of WINDOW or WINDOW's parent window. You have to
1957 eventually call `window-resize-apply' in order to make resizing
1958 actually take effect."
1960 ;; Add DELTA to the new total size of WINDOW.
1967 ;; In an iso-combination resize child windows according to their
1968 ;; normal sizes.
1970 window delta horizontal nil ignore trail edge))
1971 ;; In an ortho-combination resize each child window by DELTA.
1975 sub delta horizontal ignore t trail edge)
1979 "Resize root window WINDOW vertically by DELTA lines.
1980 HORIZONTAL non-nil means resize root window WINDOW horizontally
1981 by DELTA columns.
1983 IGNORE non-nil means ignore any restrictions imposed by fixed
1984 size windows, `window-min-height' or `window-min-width' settings.
1986 This function is only called by the frame resizing routines. It
1987 resizes windows proportionally and never deletes any windows."
1994 "Resize root window WINDOW vertically by DELTA lines.
1995 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1996 lines, shrink it as much as possible. If DELTA is greater than
1997 zero, this function can resize fixed-size windows in order to
1998 recover the necessary lines.
2000 Return the number of lines that were recovered.
2002 This function is only called by the minibuffer window resizing
2003 routines. It resizes windows proportionally and never deletes
2004 any windows."
2015 ;; Ideally, we would resize just the last window in a combination
2016 ;; but that's not feasible for the following reason: If we grow
2017 ;; the minibuffer window and the last window cannot be shrunk any
2018 ;; more, we shrink another window instead. But if we then shrink
2019 ;; the minibuffer window again, the last window might get enlarged
2020 ;; and the state after shrinking is not the state before growing.
2021 ;; So, in practice, we'd need a history variable to record how to
2022 ;; proceed. But I'm not sure how such a variable could work with
2023 ;; repeated minibuffer window growing steps.
2025 delta)))
2028 "Move WINDOW's bottom edge by DELTA lines.
2029 Optional argument HORIZONTAL non-nil means move WINDOW's right
2030 edge by DELTA columns. WINDOW defaults to the selected window.
2032 If DELTA is greater than zero, move the edge downwards or to the
2033 right. If DELTA is less than zero, move the edge upwards or to
2034 the left. If the edge can't be moved by DELTA lines or columns,
2035 move it as far as possible in the desired direction."
2040 left this-delta min-delta max-delta)
2041 ;; Find the edge we want to move.
2047 ;; Resize the minibuffer window if it's on the same frame as
2048 ;; and immediately below WINDOW and it's either active or
2049 ;; `resize-mini-windows' is nil.
2061 ;; Set LEFT to the first resizable window on the left. This step is
2062 ;; needed to handle fixed-size windows.
2075 ;; Set RIGHT to the first resizable window on the right. This step
2076 ;; is needed to handle fixed-size windows.
2089 ;; LEFT and RIGHT (which might be both internal windows) are now the
2090 ;; two windows we want to resize.
2096 ;; We can't get the whole DELTA - move as far as possible.
2099 ;; Start resizing.
2101 ;; Try to enlarge LEFT first.
2105 left this-delta horizontal nil t 'before
2109 ;; Shrink windows on right of LEFT.
2111 left delta horizontal nil 'after
2119 ;; We can't get the whole DELTA - move as far as possible.
2122 ;; Start resizing.
2124 ;; Try to enlarge RIGHT.
2128 right this-delta horizontal nil t 'after
2132 ;; Shrink windows on left of RIGHT.
2139 ;; Don't report an error in the standard case.
2141 ;; But do report an error if applying the changes fails.
2145 "Make the selected window DELTA lines taller.
2146 Interactively, if no argument is given, make the selected window
2147 one line taller. If optional argument HORIZONTAL is non-nil,
2148 make selected window wider by DELTA columns. If DELTA is
2149 negative, shrink selected window by -DELTA lines or columns.
2150 Return nil."
2165 ;; If the selected window is full height and `resize-mini-windows'
2166 ;; is nil, resize the minibuffer window.
2175 horizontal)))))
2178 "Make the selected window DELTA lines smaller.
2179 Interactively, if no argument is given, make the selected window
2180 one line smaller. If optional argument HORIZONTAL is non-nil,
2181 make selected window narrower by DELTA columns. If DELTA is
2182 negative, enlarge selected window by -DELTA lines or columns.
2183 Also see the `window-min-height' variable.
2184 Return nil."
2199 ;; If the selected window is full height and `resize-mini-windows'
2200 ;; is nil, resize the minibuffer window.
2209 horizontal)))))
2212 "Maximize WINDOW.
2213 Make WINDOW as large as possible without deleting any windows.
2214 WINDOW can be any window and defaults to the selected window."
2221 "Minimize WINDOW.
2222 Make WINDOW as small as possible without deleting any windows.
2223 WINDOW can be any window and defaults to the selected window."
2228 \f
2230 "Return non-nil if WINDOW is the root window of its frame."
2234 "Return window subtree rooted at WINDOW.
2235 Optional argument NEXT non-nil means include WINDOW's right
2236 siblings in the return value.
2238 See the documentation of `window-tree' for a description of the
2239 return value."
2252 list))
2257 "Return the window tree of frame FRAME.
2258 FRAME must be a live frame and defaults to the selected frame.
2259 The return value is a list of the form (ROOT MINI), where ROOT
2260 represents the window tree of the frame's root window, and MINI
2261 is the frame's minibuffer window.
2263 If the root window is not split, ROOT is the root window itself.
2264 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2265 for a horizontal split, and t for a vertical split. EDGES gives
2266 the combined size and position of the child windows in the split,
2267 and the rest of the elements are the child windows in the split.
2268 Each of the child windows may again be a window or a list
2269 representing a window split, and so on. EDGES is a list (LEFT
2270 TOP RIGHT BOTTOM) as returned by `window-edges'."
2273 \f
2275 "Select another window in cyclic ordering of windows.
2276 COUNT specifies the number of windows to skip, starting with the
2277 selected window, before making the selection. If COUNT is
2278 positive, skip COUNT windows forwards. If COUNT is negative,
2279 skip -COUNT windows backwards. COUNT zero means do not skip any
2280 window, so select the selected window. In an interactive call,
2281 COUNT is the numeric prefix argument. Return nil.
2283 If the `other-window' parameter of the selected window is a
2284 function and `ignore-window-parameters' is nil, call that
2285 function with the arguments COUNT and ALL-FRAMES.
2287 This function does not select a window whose `no-other-window'
2288 window parameter is non-nil.
2290 This function uses `next-window' for finding the window to
2291 select. The argument ALL-FRAMES has the same meaning as in
2292 `next-window', but the MINIBUF argument of `next-window' is
2293 always effectively nil."
2298 old-window old-count)
2301 ;; `next-window' and `previous-window' may return a window we are
2302 ;; not allowed to select. Hence we need an exit strategy in case
2303 ;; all windows are non-selectable.
2310 ;; Keep out of infinite loops. When COUNT has not changed
2311 ;; since we last looked at `window' we're probably in one.
2315 ;; The first non-selectable window `next-window' got us:
2316 ;; Remember it and the current value of COUNT.
2326 ;; Keep out of infinite loops. When COUNT has not changed
2327 ;; since we last looked at `window' we're probably in one.
2331 ;; The first non-selectable window `previous-window' got
2332 ;; us: Remember it and the current value of COUNT.
2339 ;; Always return nil.
2340 nil))))
2342 ;; This should probably return non-nil when the selected window is part
2343 ;; of an atomic window whose root is the frame's root window.
2345 "Return non-nil if the selected window is the only window.
2346 Optional arg NOMINI non-nil means don't count the minibuffer
2347 even if it is active. Otherwise, the minibuffer is counted
2348 when it is active.
2350 Optional argument ALL-FRAMES specifies the set of frames to
2351 consider, see also `next-window'. ALL-FRAMES nil or omitted
2352 means consider windows on the selected frame only, plus the
2353 minibuffer window if specified by the NOMINI argument. If the
2354 minibuffer counts, consider all windows on all frames that share
2355 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2356 with a special meaning are:
2358 - t means consider all windows on all existing frames.
2360 - `visible' means consider all windows on all visible frames on
2361 the current terminal.
2363 - 0 (the number zero) means consider all windows on all visible
2364 and iconified frames on the current terminal.
2366 - A frame means consider all windows on that frame only.
2368 Anything else means consider all windows on the selected frame
2369 and no others."
2375 \f
2376 ;;; Deleting windows.
2378 "Return t if WINDOW can be safely deleted from its frame.
2379 Return `frame' if deleting WINDOW should also delete its
2380 frame."
2384 ;; Handle atomicity.
2392 ;; WINDOW's frame can be deleted only if there are other frames
2393 ;; on the same terminal, and it does not contain the active
2394 ;; minibuffer.
2402 ;; WINDOW can be deleted unless it is the main window of its
2403 ;; frame.
2404 t))))
2407 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2417 "Delete WINDOW.
2418 WINDOW can be an arbitrary window and defaults to the selected
2419 one. Return nil.
2421 If the variable `ignore-window-parameters' is non-nil or the
2422 `delete-window' parameter of WINDOW equals t, do not process any
2423 parameters of WINDOW. Otherwise, if the `delete-window'
2424 parameter of WINDOW specifies a function, call that function with
2425 WINDOW as its sole argument and return the value returned by that
2426 function.
2428 Otherwise, if WINDOW is part of an atomic window, call
2429 `delete-window' with the root of the atomic window as its
2430 argument. If WINDOW is the only window on its frame or the last
2431 non-side window, signal an error."
2437 atom-root)
2440 ;; Handle window parameters.
2442 ;; Ignore window parameters if `ignore-window-parameters' tells
2443 ;; us so or `delete-window' equals t.
2446 ;; The `delete-window' parameter specifies the function to call.
2447 ;; If that function is `ignore' nothing is done. It's up to the
2448 ;; function called here to avoid infinite recursion.
2465 ;; Emacs 23 preferably gives WINDOW's space to its left
2466 ;; sibling.
2472 ;; Resize WINDOW's sibling.
2478 ;; Can do without resizing fixed-size windows.
2481 ;; Can't do without resizing fixed-size windows.
2483 ;; Actually delete WINDOW.
2488 ;; `delete-window-internal' has selected a window that should
2489 ;; not be selected, fix this here.
2493 ;; Always return nil.
2494 nil))))
2497 "Make WINDOW fill its frame.
2498 WINDOW may be any window and defaults to the selected one.
2499 Return nil.
2501 If the variable `ignore-window-parameters' is non-nil or the
2502 `delete-other-windows' parameter of WINDOW equals t, do not
2503 process any parameters of WINDOW. Otherwise, if the
2504 `delete-other-windows' parameter of WINDOW specifies a function,
2505 call that function with WINDOW as its sole argument and return
2506 the value returned by that function.
2508 Otherwise, if WINDOW is part of an atomic window, call this
2509 function with the root of the atomic window as its argument. If
2510 WINDOW is a non-side window, make WINDOW the only non-side window
2511 on the frame. Side windows are not deleted. If WINDOW is a side
2512 window signal an error."
2518 atom-root side-main)
2522 ;; Ignore window parameters if `ignore-window-parameters' is t or
2523 ;; `delete-other-windows' is t.
2526 ;; The `delete-other-windows' parameter specifies the function
2527 ;; to call. If the function is `ignore' no windows are deleted.
2528 ;; It's up to the function called to avoid infinite recursion.
2535 ;; Set side-main to the major non-side window.
2539 ;; If WINDOW is the main non-side window, do nothing.
2544 ;; Always return nil.
2545 nil)))
2548 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2550 if you often split windows horizontally."
2562 ;;; Windows and buffers.
2564 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2565 ;; for (1) determining which buffer to show in the window when its
2566 ;; buffer shall be buried or killed and (2) which buffer to show for
2567 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2569 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2570 ;; triples. The entries on this list are ordered by the time their
2571 ;; buffer has been removed from the window, the most recently removed
2572 ;; buffer's entry being first. The window-start and window-point
2573 ;; components are `window-start' and `window-point' at the time the
2574 ;; buffer was removed from the window which implies that the entry must
2575 ;; be added when `set-window-buffer' removes the buffer from the window.
2577 ;; `next-buffers' is the list of buffers that have been replaced
2578 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2579 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2580 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2581 ;; reset to nil by any action changing the window's buffer with the
2582 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2583 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2584 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2586 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2587 ;; if such a buffer was killed while the window was hidden within a
2588 ;; window configuration. Such killed buffers get removed whenever
2589 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2591 ;; The following function is called by `set-window-buffer' _before_ it
2592 ;; replaces the buffer of the argument window with the new buffer.
2594 "Record WINDOW's buffer.
2595 WINDOW must be a live window and defaults to the selected one."
2599 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2600 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2604 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2608 ;; Don't record insignificant buffers.
2610 ;; Add an entry for buffer to WINDOW's previous buffers.
2617 ;; We have an entry, update marker positions.
2620 ;; Make new markers.
2628 "Unrecord BUFFER in WINDOW.
2629 WINDOW must be a live window and defaults to the selected one.
2630 BUFFER must be a live buffer and defaults to the buffer of
2631 WINDOW."
2640 "Set WINDOW's buffer to BUFFER.
2641 Optional argument START non-nil means set WINDOW's start position
2642 to START. Optional argument POINT non-nil means set WINDOW's
2643 point to POINT. If WINDOW is selected this also sets BUFFER's
2644 `point' to POINT. If WINDOW is selected and the buffer it showed
2645 before was current this also makes BUFFER the current buffer."
2652 ;; Don't force window-start here (even if POINT is nil).
2658 "If non-nil, allow switching to an already visible buffer.
2659 If this variable is non-nil, `switch-to-prev-buffer' and
2660 `switch-to-next-buffer' may switch to an already visible buffer
2661 provided the buffer was shown in the argument window before. If
2662 this variable is nil, `switch-to-prev-buffer' and
2663 `switch-to-next-buffer' always try to avoid switching to a buffer
2664 that is already visible in another window on the same frame."
2670 "In WINDOW switch to previous buffer.
2671 WINDOW must be a live window and defaults to the selected one.
2672 Return the buffer switched to, nil if no suitable buffer could be
2673 found.
2675 Optional argument BURY-OR-KILL non-nil means the buffer currently
2676 shown in WINDOW is about to be buried or killed and consequently
2677 shall not be switched to in future invocations of this command."
2682 ;; Save this since it's destroyed by `set-window-buffer'.
2684 entry buffer new-buffer killed-buffers visible)
2689 ;; Scan WINDOW's previous buffers first, skipping entries of next
2690 ;; buffers.
2700 ;; Try to avoid showing a buffer visible in some other window.
2706 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2707 ;; entries of next buffers. Note that when we bury or kill a
2708 ;; buffer we don't reverse the global buffer list to avoid showing
2709 ;; a buried buffer instead. Otherwise, we must reverse the global
2710 ;; buffer list in order to make sure that switching to the
2711 ;; previous/next buffer traverse it in opposite directions.
2720 ;; Try to avoid showing a buffer visible in some other window.
2727 ;; Scan reverted next buffers last (must not use nreverse
2728 ;; here!).
2730 ;; Actually, buffer _must_ be live here since otherwise it
2731 ;; would have been caught in the scan of previous buffers.
2742 ;; Show a buffer visible in another window.
2748 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2749 ;; of) next buffers.
2754 ;; Move `old-buffer' to head of WINDOW's restored list of next
2755 ;; buffers.
2759 ;; Remove killed buffers from WINDOW's previous and next buffers.
2767 ;; Return new-buffer.
2768 new-buffer))
2771 "In WINDOW switch to next buffer.
2772 WINDOW must be a live window and defaults to the selected one.
2773 Return the buffer switched to, nil if no suitable buffer could be
2774 found."
2780 buffer new-buffer entry killed-buffers visible)
2785 ;; Scan WINDOW's next buffers first.
2796 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2797 ;; buffers entries.
2803 ;; Try to avoid showing a buffer visible in some other window.
2808 ;; Scan WINDOW's reverted previous buffers last (must not use
2809 ;; nreverse here!)
2818 ;; Try to avoid showing a buffer visible in some other window.
2826 ;; Show a buffer visible in another window.
2831 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2834 ;; Remove killed buffers from WINDOW's previous and next buffers.
2842 ;; Return new-buffer.
2843 new-buffer))
2846 "Search LIST for a valid buffer to display in FRAME.
2847 Return nil when all buffers in LIST are undesirable for display,
2848 otherwise return the first suitable buffer in LIST.
2850 Buffers not visible in windows are preferred to visible buffers,
2851 unless VISIBLE-OK is non-nil.
2852 If the optional argument FRAME is nil, it defaults to the selected frame.
2853 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2854 ;; This logic is more or less copied from other-buffer.
2857 found buf)
2870 "Return the last buffer in FRAME's buffer list.
2871 If BUFFER is the last buffer, return the preceding buffer
2872 instead. Buffers not visible in windows are preferred to visible
2873 buffers, unless optional argument VISIBLE-OK is non-nil.
2874 Optional third argument FRAME nil or omitted means use the
2875 selected frame's buffer list. If no such buffer exists, return
2876 the buffer `*scratch*', creating it if necessary."
2879 buffer visible-ok frame)
2883 scratch)))
2886 "Function called to automatically hide frames.
2887 The function is called with one argument - a frame.
2889 Functions affected by this option are those that bury a buffer
2890 shown in a separate frame like `quit-window' and `bury-buffer'."
2894 function)
2900 "Delete WINDOW if possible.
2901 WINDOW must be a live window and defaults to the selected one.
2902 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2903 only if it's dedicated to its buffer. Optional argument KILL
2904 means the buffer shown in window will be killed. Return non-nil
2905 if WINDOW gets deleted or its frame is auto-hidden."
2920 t)))))
2923 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2924 There it is the least likely candidate for `other-buffer' to
2926 select by default.
2928 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2929 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2930 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2931 remove the current buffer from the selected window if it is
2932 displayed there."
2935 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2936 ;; although it's not "here" (call it a feature).
2938 ;; Handle case where `buffer-or-name' is nil and the current buffer
2939 ;; is shown in the selected window.
2944 ;; Switch to another buffer in window.
2948 ;; Always return nil.
2949 nil))
2952 "Switch to the last buffer in the buffer list."
2957 "In selected window switch to next buffer."
2964 "In selected window switch to previous buffer."
2971 "Delete all windows showing BUFFER-OR-NAME.
2972 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2973 and defaults to the current buffer.
2975 The following non-nil values of the optional argument FRAME
2976 have special meanings:
2978 - t means consider all windows on the selected frame only.
2980 - `visible' means consider all windows on all visible frames on
2981 the current terminal.
2983 - 0 (the number zero) means consider all windows on all visible
2984 and iconified frames on the current terminal.
2986 - A frame means consider all windows on that frame only.
2988 Any other value of FRAME means consider all windows on all
2989 frames.
2991 When a window showing BUFFER-OR-NAME is dedicated and the only
2992 window of its frame, that frame is deleted when there are other
2993 frames left."
2996 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2997 ;; `window-list-1' based function.
3004 ;; Delete frame if and only if window is dedicated.
3007 ;; Delete window.
3010 ;; In window switch to previous buffer.
3013 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3017 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
3018 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3019 and defaults to the current buffer.
3021 When a window showing BUFFER-OR-NAME is dedicated, that window is
3022 deleted. If that window is the only window on its frame, the
3023 frame is deleted too when there are other frames left. If there
3024 are no other frames left, some other buffer is displayed in that
3025 window.
3027 This function removes the buffer denoted by BUFFER-OR-NAME from
3028 all window-local buffer lists."
3034 ;; Switch to another buffer in window.
3037 ;; Unrecord BUFFER in WINDOW.
3041 "Quit WINDOW and bury its buffer.
3042 WINDOW must be a live window and defaults to the selected one.
3043 With prefix argument KILL non-nil, kill the buffer instead of
3044 burying it.
3046 According to information stored in WINDOW's `quit-restore' window
3047 parameter either (1) delete WINDOW and its frame, (2) delete
3048 WINDOW, (3) restore the buffer previously displayed in WINDOW,
3049 or (4) make WINDOW display some other buffer than the present
3050 one. If non-nil, reset `quit-restore' parameter to nil."
3061 buffer))))
3062 prev-buffer)))
3063 quad resize)
3068 ;; Delete WINDOW if possible.
3070 ;; If the previously selected window is still alive, select it.
3076 ;; Show another buffer stored in quit-restore parameter.
3081 ;; Try to resize WINDOW to its old height but don't signal an
3082 ;; error.
3086 ;; Restore WINDOW's previous buffer, start and point position.
3089 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
3090 ;; re-recorded by `set-window-buffer'.
3092 ;; Reset the quit-restore parameter.
3094 ;; Select old window.
3098 ;; Show some other buffer in WINDOW and reset the quit-restore
3099 ;; parameter.
3101 ;; Make sure that WINDOW is no more dedicated.
3105 ;; Kill WINDOW's old-buffer if requested
3111 "Quit all windows showing BUFFER-OR-NAME.
3112 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3113 and defaults to the current buffer. Optional argument KILL
3114 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3115 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3116 `delete-windows-on'.
3118 This function calls `quit-window' on all candidate windows
3119 showing BUFFER-OR-NAME."
3122 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3123 ;; `window-list-1' based function.
3128 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3130 \f
3131 ;;; Splitting windows.
3133 "Return minimum height of any window when splitting windows.
3134 Optional argument HORIZONTAL non-nil means return minimum width."
3140 "Make a new window adjacent to WINDOW.
3141 WINDOW can be any window and defaults to the selected one.
3142 Return the new window which is always a live window.
3144 Optional argument SIZE a positive number means make WINDOW SIZE
3145 lines or columns tall. If SIZE is negative, make the new window
3146 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3147 absolute value can be less than `window-min-height' or
3148 `window-min-width'; so this command can make a new window as
3149 small as one line or two columns. SIZE defaults to half of
3150 WINDOW's size. Interactively, SIZE is the prefix argument.
3152 Optional third argument SIDE nil (or `below') specifies that the
3153 new window shall be located below WINDOW. SIDE `above' means the
3154 new window shall be located above WINDOW. In both cases SIZE
3155 specifies the new number of lines for WINDOW (or the new window
3156 if SIZE is negative) including space reserved for the mode and/or
3157 header line.
3159 SIDE t (or `right') specifies that the new window shall be
3160 located on the right side of WINDOW. SIDE `left' means the new
3161 window shall be located on the left of WINDOW. In both cases
3162 SIZE specifies the new number of columns for WINDOW (or the new
3163 window provided SIZE is negative) including space reserved for
3164 fringes and the scrollbar or a divider column. Any other non-nil
3165 value for SIDE is currently handled like t (or `right').
3167 If the variable `ignore-window-parameters' is non-nil or the
3168 `split-window' parameter of WINDOW equals t, do not process any
3169 parameters of WINDOW. Otherwise, if the `split-window' parameter
3170 of WINDOW specifies a function, call that function with all three
3171 arguments and return the value returned by that function.
3174 root of that atomic window. The new window does not become a
3175 member of that atomic window.
3177 If WINDOW is live, properties of the new window like margins and
3178 scrollbars are inherited from WINDOW. If WINDOW is an internal
3179 window, these properties as well as the buffer displayed in the
3180 new window are inherited from the window selected on WINDOW's
3181 frame. The selected window is not changed by this function."
3193 ;; Rebind `window-combination-limit' since in some cases we may
3194 ;; have to override its value.
3196 atom-root)
3201 ;; Ignore window parameters if either `ignore-window-parameters'
3202 ;; is t or the `split-window' parameter equals t.
3205 ;; The `split-window' parameter specifies the function to call.
3206 ;; If that function is `ignore', do nothing.
3208 ;; If WINDOW is part of an atomic window, split the root window
3209 ;; of that atomic window instead.
3218 ;; WINDOW is a side root window. To make sure that a new parent
3219 ;; window gets created set `window-combination-limit' to t.
3223 ;; If `window-combination-resize' is non-nil and SIZE is a
3224 ;; non-negative integer, we cannot reasonably resize other
3225 ;; windows. Rather bind `window-combination-limit' to t to make
3226 ;; sure that subsequent window deletions are handled correctly.
3230 ;; `parent-size' is the size of WINDOW's parent, provided
3231 ;; it has one.
3233 ;; `resize' non-nil means we are supposed to resize other
3234 ;; windows in WINDOW's combination.
3237 ;; Resize makes sense in iso-combinations only.
3239 ;; `old-size' is the current size of WINDOW.
3241 ;; `new-size' is the specified or calculated size of the
3242 ;; new window.
3248 ;; When resizing try to give the new window the
3249 ;; average size of a window in its combination.
3252 (/ parent-size
3254 parent horizontal))))
3255 ;; Else try to give the new window half the size
3256 ;; of WINDOW (plus an eventual odd line).
3259 ;; SIZE non-negative specifies the new size of WINDOW.
3261 ;; Note: Specifying a non-negative SIZE is practically
3262 ;; always done as workaround for making the new window
3263 ;; appear above or on the left of the new window (the
3264 ;; ispell window is a typical example of that). In all
3265 ;; these cases the SIDE argument should be set to 'above
3266 ;; or 'left in order to support the 'resize option.
3267 ;; Here we have to nest the windows instead, see above.
3270 ;; SIZE negative specifies the size of the new window.
3272 new-parent new-normal)
3274 ;; Check SIZE.
3279 ;; SIZE unspecified, resizing.
3281 ;; Try again with minimum split size.
3287 ;; SIZE unspecified, no resizing.
3292 window-safe-min-width
3293 window-safe-min-width))))
3294 ;; SIZE specified as new size of old window. If the new size
3295 ;; is larger than the old size or the size of the new window
3296 ;; would be less than the safe minimum, signal an error.
3299 ;; SIZE specified, resizing.
3301 ;; If we cannot resize the parent give up.
3307 ;; SIZE specification violates minimum size restrictions.
3313 ;; Make new-parent non-nil if we need a new parent window;
3314 ;; either because we want to nest or because WINDOW is not
3315 ;; iso-combined.
3319 ;; Make new-normal the normal size of the new window.
3327 ;; Try to get space from OLD's siblings. We could go "up" and
3328 ;; try getting additional space from surrounding windows but
3329 ;; we won't be able to return space to those windows when we
3330 ;; delete the one we create here. Hence we do not go up.
3339 ;; Get entire space from WINDOW.
3344 new-normal)))
3347 ;; Inherit window-side parameters, if any.
3354 ;; Always return the new window.
3355 new)))))
3357 ;; I think this should be the default; I think people will prefer it--rms.
3360 If nil, adjust point in the two windows to minimize redisplay.
3361 This option applies only to `split-window-below' and functions
3362 that call it. The low-level `split-window' function always keeps
3363 the original point in both windows."
3368 "Split the selected window into two windows, one above the other.
3369 The selected window is above. The newly split-off window is
3370 below, and displays the same buffer. Return the new window.
3372 If optional argument SIZE is omitted or nil, both windows get the
3373 same height, or close to it. If SIZE is positive, the upper
3374 \(selected) window gets SIZE lines. If SIZE is negative, the
3375 lower (new) window gets -SIZE lines.
3377 If the variable `split-window-keep-point' is non-nil, both
3378 windows get the same value of point as the selected window.
3379 Otherwise, the window starts are chosen so as to minimize the
3380 amount of redisplay; this is convenient on slow terminals."
3385 moved-by-window-height moved new-window bottom)
3387 ;; `split-window' would not signal an error here.
3392 ;; Use `save-excursion' around vertical movements below
3393 ;; (Bug#10971). Note: When the selected window's buffer has a
3394 ;; header line, up to two lines of the buffer may not show up
3395 ;; in the resulting configuration.
3413 ;; Always copy quit-restore parameter in interactive use.
3417 new-window))
3422 "Split the selected window into two side-by-side windows.
3423 The selected window is on the left. The newly split-off window
3424 is on the right, and displays the same buffer. Return the new
3425 window.
3427 If optional argument SIZE is omitted or nil, both windows get the
3428 same width, or close to it. If SIZE is positive, the left-hand
3429 \(selected) window gets SIZE columns. If SIZE is negative, the
3430 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3431 the width of the window's scroll bar; if there are no scroll
3432 bars, it includes the width of the divider column to the window's
3433 right, if any."
3437 new-window)
3439 ;; `split-window' would not signal an error here.
3442 ;; Always copy quit-restore parameter in interactive use.
3446 new-window))
3449 \f
3450 ;;; Balancing windows.
3452 ;; The following routine uses the recycled code from an old version of
3453 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3454 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3455 ;; more readable (FWIW we'd need three loops - one to calculate the
3456 ;; minimum sizes per window, one to enlarge or shrink windows until the
3457 ;; new parent-size matches, and one where we shrink the largest/enlarge
3458 ;; the smallest window).
3460 "Subroutine of `balance-windows-1'.
3461 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3462 is non-nil."
3468 failed size sub-total sub-delta sub-amount rest)
3483 ;; Ignore child windows that should be ignored or are stuck.
3489 ;; Register the new total size for this child window.
3494 ;; We failed and need a new round.
3500 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3501 ;; (column) until `rest' is zero.
3509 ;; Fix rounding by trying to enlarge stuck windows by one line
3510 ;; (column) until `rest' equals zero.
3520 ;; Record new normal sizes.
3526 ;; Recursively balance each window's child windows.
3531 "Subroutine of `balance-windows'."
3543 "Balance the sizes of windows of WINDOW-OR-FRAME.
3544 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3545 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3546 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3547 recursively balance the sizes of all child windows of that
3548 window."
3557 window-or-frame)
3561 ;; Balance vertically.
3565 ;; Balance horizontally.
3571 "Return t if WINDOW cannot be resized in DIRECTION.
3572 WINDOW defaults to the selected window. DIRECTION can be
3573 nil (i.e. any), `height' or `width'."
3580 ;;; A different solution to balance-windows.
3582 "Factor by which the window area should be over-estimated.
3583 This is used by `balance-windows-area'.
3588 "Wrapper around `window-resize' with error checking.
3589 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3590 ;; `window-resize' may fail if delta is too large.
3597 ;;(message "adjust: %s" (error-message-string err))
3601 "Make all visible windows the same area (approximately).
3602 See also `window-area-factor' to change the relative size of
3603 specific buffers."
3606 ;; Remove fixed-size windows.
3611 next)
3612 ;; Resizing a window changes the size of surrounding windows in complex
3613 ;; ways, so it's difficult to balance them all. The introduction of
3614 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3615 ;; very difficult to do. `balance-window' above takes an off-line
3616 ;; approach: get the whole window tree, then balance it, then try to
3617 ;; adjust the windows so they fit the result.
3618 ;; Here, instead, we take a "local optimization" approach, where we just
3619 ;; go through all the windows several times until nothing needs to be
3620 ;; changed. The main problem with this approach is that it's difficult
3621 ;; to make sure it terminates, so we use some heuristic to try and break
3622 ;; off infinite loops.
3623 ;; After a round without any change, we allow a second, to give a chance
3624 ;; to the carry to propagate a minor imbalance from the end back to
3625 ;; the beginning.
3627 ;; (message "New round")
3633 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3651 ;; Maybe diff is actually closer to 1 than to 0.
3655 ;; Change things smoothly.
3658 ;; Make sure negligible differences don't accumulate to
3659 ;; become significant.
3661 ;; This used `adjust-window-trailing-edge' before and uses
3662 ;; `window-resize' now. Error wrapping is still needed.
3664 ;; (sit-for 0.5)
3666 ;; If the same change has been seen already for this window,
3667 ;; we're most likely in an endless loop, so don't count it as
3668 ;; a change.
3672 ;; We've now basically balanced all the windows.
3673 ;; But there may be some minor off-by-one imbalance left over,
3674 ;; so let's do some fine tuning.
3675 ;; (bw-finetune wins)
3676 ;; (message "Done in %d rounds" round)
3677 ))
3679 ;;; Window states, how to get them and how to put them in a window.
3681 "Helper function for `window-state-get'."
3690 `(,type
3698 list)
3699 ;; Make copies of those window parameters whose
3700 ;; persistence property is `writable' if WRITABLE is
3701 ;; non-nil and non-nil if WRITABLE is nil.
3704 window-persistent-parameters))))
3707 ;; Add `clone-of' parameter if necessary.
3709 window-persistent-parameters))))
3716 ;; All buffer related things go in here.
3731 'window-point-insertion-type
3732 buffer))))
3745 "Return state of WINDOW as a Lisp object.
3746 WINDOW can be any window and defaults to the root window of the
3747 selected frame.
3749 Optional argument WRITABLE non-nil means do not use markers for
3750 sampling `window-point' and `window-start'. Together, WRITABLE
3751 and the variable `window-persistent-parameters' specify which
3752 window parameters are saved by this function. WRITABLE should be
3753 non-nil when the return value shall be written to a file and read
3754 back in another session. Otherwise, an application may run into
3755 an `invalid-read-syntax' error while attempting to read back the
3756 value from file.
3758 The return value can be used as argument for `window-state-put'
3759 to put the state recorded here into an arbitrary window. The
3760 value can be also stored on disk and read back in a new session."
3764 window
3767 ;; The return value is a cons whose car specifies some constraints on
3768 ;; the size of WINDOW. The cdr lists the states of the child windows
3769 ;; of WINDOW.
3771 ;; Frame related things would go into a function, say `frame-state',
3772 ;; calling `window-state-get' to insert the frame's root window.
3785 "Helper function for `window-state-put'."
3790 ;; For a leaf window just add unprocessed entries to
3791 ;; `window-state-put-list'.
3797 size new)
3799 ;; Find the next child window. WINDOW always points to the
3800 ;; real window that we want to fill with what we find here.
3803 ;; The last child window. Below `window--state-put-1'
3804 ;; will put into it whatever ITEM has in store.
3806 ;; Not the last child window, prepare for splitting
3807 ;; WINDOW. SIZE is the new (and final) size of the old
3808 ;; window.
3811 ;; Use total size.
3813 ;; Use normalized size and round.
3817 item))))))
3819 ;; Use safe sizes, we try to resize later.
3821 window-safe-min-height
3822 window-safe-min-width)))
3827 ;; We must inherit the combination limit, otherwise
3828 ;; we might mess up handling of atomic and side
3829 ;; window.
3831 ;; Give up if we can't resize window down to safe sizes.
3836 ;; When creating the first child window add for parent
3837 ;; unprocessed entries to `window-state-put-list'.
3840 window-state-put-list))))
3842 ;; Now process the current window (either the one we've just
3843 ;; split or the last child of its parent).
3845 ;; Continue with the last window split off.
3849 "Helper function for `window-state-put'."
3857 ;; Reset window's parameters and assign saved ones (we might want
3858 ;; a `remove-window-parameters' function here).
3864 ;; Process buffer related state.
3866 ;; We don't want to raise an error here so we create a buffer if
3867 ;; there's none.
3879 ;; Adjust vertically.
3881 ;; A fixed height window, try to restore the original size.
3884 window-size-fixed)
3887 ;; Else check whether the window is not high enough.
3893 ;; Adjust horizontally.
3895 ;; A fixed width window, try to restore the original size.
3898 window-size-fixed)
3901 ;; Else check whether the window is not wide enough.
3907 ;; Set dedicated status.
3909 ;; Install positions (maybe we should do this after all windows
3910 ;; have been created and sized).
3914 ;; Select window if it's the selected one.
3919 "Put window state STATE into WINDOW.
3920 STATE should be the state of a window returned by an earlier
3921 invocation of `window-state-get'. Optional argument WINDOW must
3922 specify a live window and defaults to the selected one.
3924 Optional argument IGNORE non-nil means ignore minimum window
3925 sizes and fixed size restrictions. IGNORE equal `safe' means
3926 windows can get as small as `window-safe-min-height' and
3927 `window-safe-min-width'."
3931 ;; We check here (1) whether the total sizes of root window of
3932 ;; STATE and that of WINDOW are equal so we can avoid
3933 ;; calculating new sizes, and (2) if we do have to resize
3934 ;; whether we can do so without violating size restrictions.
3959 (> min-width
3961 ;; The check above might not catch all errors due to rounding
3962 ;; issues - so IGNORE equal 'safe might not always produce the
3963 ;; minimum possible state. But such configurations hardly make
3964 ;; sense anyway.
3968 ;; Work on the windows of a temporary buffer to make sure that
3969 ;; splitting proceeds regardless of any buffer local values of
3970 ;; `window-size-fixed'. Release that buffer after the buffers of
3971 ;; all live windows have been set by `window--state-put-2'.
3977 \f
3979 "Record information for window used by `display-buffer'.
3980 TYPE specifies the type of the calling operation and must be one
3981 of the symbols 'reuse (when WINDOW existed already and was
3982 reused for displaying BUFFER), 'window (when WINDOW was created
3983 on an already existing frame), or 'frame (when WINDOW was
3984 created on a new frame). WINDOW is the window used for or created
3985 by the `display-buffer' routines. BUFFER is the buffer that
3986 shall be displayed.
3988 This function installs or updates the quit-restore parameter of
3989 WINDOW. The quit-restore parameter is a list of four elements:
3990 The first element is one of the symbols 'window, 'frame, 'same or
3991 'other. The second element is either one of the symbols 'window
3992 or 'frame or a list whose elements are the buffer previously
3993 shown in the window, that buffer's window start and window point,
3994 and the window's height. The third element is the window
3995 selected at the time the parameter was created. The fourth
3996 element is BUFFER."
4000 ;; WINDOW shows BUFFER already.
4002 ;; If WINDOW has a quit-restore parameter, reset its car.
4004 ;; WINDOW shows another buffer.
4006 window 'quit-restore
4008 ;; A quadruple of WINDOW's buffer, start, point and height.
4013 ;; WINDOW has been created on an existing frame.
4015 window 'quit-restore
4018 ;; WINDOW has been created on a new frame.
4020 window 'quit-restore
4024 "If non-nil, function to call to handle `display-buffer'.
4025 It will receive two args, the buffer and a flag which if non-nil
4026 means that the currently selected window is not acceptable. It
4027 should choose or create a window, display the specified buffer in
4028 it, and return the window.
4030 The specified function should call `display-buffer-record-window'
4031 with corresponding arguments to set up the quit-restore parameter
4032 of the window used."
4039 "Alist of parameters for automatically generated new frames.
4040 You can set this in your init file; for example,
4042 (setq pop-up-frame-alist '((width . 80) (height . 20)))
4044 If non-nil, the value you specify here is used by the default
4045 `pop-up-frame-function' for the creation of new frames.
4047 Since `pop-up-frame-function' is used by `display-buffer' for
4048 making new frames, any value specified here by default affects
4049 the automatic generation of new frames via `display-buffer' and
4050 all functions based on it. The behavior of `make-frame' is not
4051 affected by this variable."
4059 "Function used by `display-buffer' for creating a new frame.
4060 This function is called with no arguments and should return a new
4061 frame. The default value calls `make-frame' with the argument
4062 `pop-up-frame-alist'."
4067 "List of names of buffers that should be displayed specially.
4068 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4069 its name is in this list, displays the buffer in a way specified
4070 by `special-display-function'. `special-display-popup-frame'
4071 \(the default for `special-display-function') usually displays
4072 the buffer in a separate frame made with the parameters specified
4073 by `special-display-frame-alist'. If `special-display-function'
4074 has been set to some other function, that function is called with
4075 the buffer as first, and nil as second argument.
4077 Alternatively, an element of this list can be specified as
4078 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
4079 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4080 `special-display-popup-frame' will interpret such pairs as frame
4081 parameters when it creates a special frame, overriding the
4082 corresponding values from `special-display-frame-alist'.
4084 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4085 `special-display-popup-frame' displays that buffer in the
4086 selected window. If FRAME-PARAMETERS contains (same-frame . t),
4087 it displays that buffer in a window on the selected frame.
4089 If `special-display-function' specifies some other function than
4090 `special-display-popup-frame', that function is called with the
4091 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4092 argument.
4094 Finally, an element of this list can be also specified as
4095 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4096 `special-display-popup-frame' will call FUNCTION with the buffer
4097 named BUFFER-NAME as first argument, and OTHER-ARGS as the
4098 second.
4100 Any alternative function specified here is responsible for
4101 setting up the quit-restore parameter of the window used.
4104 name to it but the corresponding buffer is displayed in the
4105 selected window, look at the values of `same-window-buffer-names'
4106 and `same-window-regexps'. Those variables take precedence over
4107 this one.
4109 See also `special-display-regexps'."
4131 ;;;###autoload
4135 "List of regexps saying which buffers should be displayed specially.
4136 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4137 any regexp in this list matches its name, displays it specially
4138 using `special-display-function'. `special-display-popup-frame'
4139 \(the default for `special-display-function') usually displays
4140 the buffer in a separate frame made with the parameters specified
4141 by `special-display-frame-alist'. If `special-display-function'
4142 has been set to some other function, that function is called with
4143 the buffer as first, and nil as second argument.
4145 Alternatively, an element of this list can be specified as
4146 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4147 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4148 `special-display-popup-frame' will then interpret these pairs as
4149 frame parameters when creating a special frame for a buffer whose
4150 name matches REGEXP, overriding the corresponding values from
4151 `special-display-frame-alist'.
4153 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4154 `special-display-popup-frame' displays buffers matching REGEXP in
4155 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4156 to display such buffers in a window on the selected frame.
4158 If `special-display-function' specifies some other function than
4159 `special-display-popup-frame', that function is called with the
4160 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4161 as second argument.
4163 Finally, an element of this list can be also specified as
4164 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4165 will then call FUNCTION with the buffer whose name matched
4166 REGEXP as first, and OTHER-ARGS as second argument.
4168 Any alternative function specified here is responsible for
4169 setting up the quit-restore parameter of the window used.
4172 name to it but the corresponding buffer is displayed in the
4173 selected window, look at the values of `same-window-buffer-names'
4174 and `same-window-regexps'. Those variables take precedence over
4175 this one.
4177 See also `special-display-buffer-names'."
4200 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4201 More precisely, return t if `special-display-buffer-names' or
4202 `special-display-regexps' contain a string entry equaling or
4203 matching BUFFER-NAME. If `special-display-buffer-names' or
4204 `special-display-regexps' contain a list entry whose car equals
4205 or matches BUFFER-NAME, the return value is the cdr of that
4206 entry."
4210 t)
4225 "Alist of parameters for special frames.
4226 Special frames are used for buffers whose names are listed in
4227 `special-display-buffer-names' and for buffers whose names match
4228 one of the regular expressions in `special-display-regexps'.
4230 This variable can be set in your init file, like this:
4232 (setq special-display-frame-alist '((width . 80) (height . 20)))
4234 These supersede the values given in `default-frame-alist'."
4241 "Display BUFFER and return the window chosen.
4242 If BUFFER is already displayed in a visible or iconified frame,
4243 raise that frame. Otherwise, display BUFFER in a new frame.
4245 Optional argument ARGS is a list specifying additional
4246 information.
4248 If ARGS is an alist, use it as a list of frame parameters. If
4249 these parameters contain (same-window . t), display BUFFER in
4250 the selected window. If they contain (same-frame . t), display
4251 BUFFER in a window of the selected frame.
4253 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4254 function to do the work. Pass it BUFFER as first argument,
4255 and (cdr ARGS) as second."
4260 ;; If we have a window already, make it visible.
4266 window))
4267 ;; Reuse the current window if the user requested it.
4272 ;; Stay on the same frame if requested.
4275 pop-up-frames
4276 special-display-buffer-names special-display-regexps)
4278 ;; If no window yet, make one in a new frame.
4285 window)))))
4288 "Function to call for displaying special buffers.
4289 This function is called with two arguments - the buffer and,
4290 optionally, a list - and should return a window displaying that
4291 buffer. The default value usually makes a separate frame for the
4292 buffer using `special-display-frame-alist' to specify the frame
4293 parameters. See the definition of `special-display-popup-frame'
4294 for how to specify such a function.
4296 A buffer is special when its name is either listed in
4297 `special-display-buffer-names' or matches a regexp in
4298 `special-display-regexps'.
4300 The specified function should call `display-buffer-record-window'
4301 with corresponding arguments to set up the quit-restore parameter
4302 of the window used."
4308 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4309 on this list in the selected rather than some other window.
4311 An element of this list can be a cons cell instead of just a
4312 string. In that case, the cell's car must be a string specifying
4313 the buffer name. This is for compatibility with
4314 `special-display-buffer-names'; the cdr of the cons cell is
4315 ignored.
4317 See also `same-window-regexps'."
4323 `display-buffer' and `pop-to-buffer' show a buffer whose name
4324 matches a regexp on this list in the selected rather than some
4325 other window.
4327 An element of this list can be a cons cell instead of just a
4328 string. In that case, the cell's car must be a regexp matching
4329 the buffer name. This is for compatibility with
4330 `special-display-regexps'; the cdr of the cons cell is ignored.
4332 See also `same-window-buffer-names'."
4338 This function returns non-nil if `display-buffer' or
4339 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4340 selected rather than (as usual) some other window. See
4341 `same-window-buffer-names' and `same-window-regexps'."
4344 ;; The elements of `same-window-buffer-names' can be buffer
4345 ;; names or cons cells whose cars are buffer names.
4350 ;; The elements of `same-window-regexps' can be regexps
4351 ;; or cons cells whose cars are regexps.
4359 "Whether `display-buffer' should make a separate frame.
4360 If nil, never make a separate frame.
4361 If the value is `graphic-only', make a separate frame
4362 on graphic displays only.
4363 Any other non-nil value means always make a separate frame."
4371 "Non-nil means `display-buffer' should reuse frames.
4372 If the buffer in question is already displayed in a frame, raise
4373 that frame."
4379 "Non-nil means `display-buffer' should make a new window."
4384 "Function called by `display-buffer' routines to split a window.
4385 This function is called with a window as single argument and is
4386 supposed to split that window and return the new window. If the
4387 window can (or shall) not be split, it is supposed to return nil.
4388 The default is to call the function `split-window-sensibly' which
4389 tries to split the window in a way which seems most suitable.
4390 You can customize the options `split-height-threshold' and/or
4391 `split-width-threshold' in order to have `split-window-sensibly'
4392 prefer either vertical or horizontal splitting.
4394 If you set this to any other function, bear in mind that the
4395 `display-buffer' routines may call this function two times. The
4396 argument of the first call is the largest window on its frame.
4397 If that call fails to return a live window, the function is
4398 called again with the least recently used window as argument. If
4399 that call fails too, `display-buffer' will use an existing window
4400 to display its buffer.
4402 The window selected at the time `display-buffer' was invoked is
4403 still selected when this function is called. Hence you can
4404 compare the window argument with the value of `selected-window'
4405 if you intend to split the selected window instead or if you do
4406 not want to split the selected window."
4412 "Minimum height for splitting windows sensibly.
4413 If this is an integer, `split-window-sensibly' may split a window
4414 vertically only if it has at least this many lines. If this is
4415 nil, `split-window-sensibly' is not allowed to split a window
4416 vertically. If, however, a window is the only window on its
4417 frame, `split-window-sensibly' may split it vertically
4418 disregarding the value of this variable."
4424 "Minimum width for splitting windows sensibly.
4425 If this is an integer, `split-window-sensibly' may split a window
4426 horizontally only if it has at least this many columns. If this
4427 is nil, `split-window-sensibly' is not allowed to split a window
4428 horizontally."
4434 "Return non-nil if `split-window-sensibly' may split WINDOW.
4435 Optional argument HORIZONTAL nil or omitted means check whether
4436 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4437 non-nil means check whether WINDOW may be split horizontally.
4439 WINDOW may be split vertically when the following conditions
4440 hold:
4441 - `window-size-fixed' is either nil or equals `width' for the
4442 buffer of WINDOW.
4443 - `split-height-threshold' is an integer and WINDOW is at least as
4444 high as `split-height-threshold'.
4445 - When WINDOW is split evenly, the emanating windows are at least
4446 `window-min-height' lines tall and can accommodate at least one
4447 line plus - if WINDOW has one - a mode line.
4449 WINDOW may be split horizontally when the following conditions
4450 hold:
4451 - `window-size-fixed' is either nil or equals `height' for the
4452 buffer of WINDOW.
4453 - `split-width-threshold' is an integer and WINDOW is at least as
4454 wide as `split-width-threshold'.
4455 - When WINDOW is split evenly, the emanating windows are at least
4456 `window-min-width' or two (whichever is larger) columns wide."
4460 ;; A window can be split horizontally when its width is not
4461 ;; fixed, it is at least `split-width-threshold' columns wide
4462 ;; and at least twice as wide as `window-min-width' and 2 (the
4463 ;; latter value is hardcoded).
4465 ;; Testing `window-full-width-p' here hardly makes any
4466 ;; sense nowadays. This can be done more intuitively by
4467 ;; setting up `split-width-threshold' appropriately.
4472 ;; A window can be split vertically when its height is not
4473 ;; fixed, it is at least `split-height-threshold' lines high,
4474 ;; and it is at least twice as high as `window-min-height' and 2
4475 ;; if it has a mode line or 1.
4484 "Split WINDOW in a way suitable for `display-buffer'.
4485 WINDOW defaults to the currently selected window.
4486 If `split-height-threshold' specifies an integer, WINDOW is at
4487 least `split-height-threshold' lines tall and can be split
4488 vertically, split WINDOW into two windows one above the other and
4489 return the lower window. Otherwise, if `split-width-threshold'
4490 specifies an integer, WINDOW is at least `split-width-threshold'
4491 columns wide and can be split horizontally, split WINDOW into two
4492 windows side by side and return the window on the right. If this
4493 can't be done either and WINDOW is the only window on its frame,
4494 try to split WINDOW vertically disregarding any value specified
4495 by `split-height-threshold'. If that succeeds, return the lower
4496 window. Return nil otherwise.
4498 By default `display-buffer' routines call this function to split
4499 the largest or least recently used window. To change the default
4500 customize the option `split-window-preferred-function'.
4502 You can enforce this function to not split WINDOW horizontally,
4503 by setting (or binding) the variable `split-width-threshold' to
4504 nil. If, in addition, you set `split-height-threshold' to zero,
4505 chances increase that this function does split WINDOW vertically.
4507 In order to not split WINDOW vertically, set (or bind) the
4508 variable `split-height-threshold' to nil. Additionally, you can
4509 set `split-width-threshold' to zero to make a horizontal split
4510 more likely to occur.
4512 Have a look at the function `window-splittable-p' if you want to
4513 know how `split-window-sensibly' determines whether WINDOW can be
4514 split."
4517 ;; Split window vertically.
4521 ;; Split window horizontally.
4526 ;; If WINDOW is the only window on its frame and is not the
4527 ;; minibuffer window, try to split it vertically disregarding
4528 ;; the value of `split-height-threshold'.
4535 "Try to split WINDOW.
4536 Return value returned by `split-window-preferred-function' if it
4537 represents a live window, nil otherwise."
4541 ;; Since `split-window-preferred-function' might
4542 ;; throw an error use `condition-case'.
4549 "Return FRAME if it can be used to display a buffer."
4552 ;; `frame-root-window' may be an internal window which is considered
4553 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4554 ;; implicitly know that `frame' has a visible window we can use.
4557 ;; If the window is soft-dedicated, the frame is usable.
4558 ;; Actually, even if the window is really dedicated,
4559 ;; the frame is still usable by splitting it.
4560 ;; At least Emacs-22 allowed it, and it is desirable
4561 ;; when displaying same-frame windows.
4562 nil ; (eq t (window-dedicated-p window))
4563 ))
4564 frame))))
4567 "If non-nil `display-buffer' will try to even window heights.
4568 Otherwise `display-buffer' will leave the window configuration
4569 alone. Heights are evened only when `display-buffer' chooses a
4570 window that appears above or below the selected window."
4575 "Even heights of WINDOW and selected window.
4576 Do this only if these windows are vertically adjacent to each
4577 other, `even-window-heights' is non-nil, and the selected window
4578 is higher than WINDOW."
4581 ;; Don't resize minibuffer windows.
4592 ;; Don't throw an error if we can't even window heights for
4593 ;; whatever reason.
4599 "Display BUFFER in WINDOW and make its frame visible.
4600 TYPE must be one of the symbols `reuse', `window' or `frame' and
4601 is passed unaltered to `display-buffer-record-window'. Set
4602 `window-dedicated-p' to DEDICATED if non-nil. Return WINDOW if
4603 BUFFER and WINDOW are live."
4613 window))
4618 ;; Assume the selected frame is already visible enough.
4620 ;; Assume the frame from which we invoked the
4621 ;; minibuffer is visible.
4626 ;; FIXME: Not implemented.
4627 ;; FIXME: By the way, there could be more levels of dedication:
4628 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4629 ;; the window hasn't been used for something else yet.
4630 ;; - `softly' dedicated only allows reuse when asked explicitly.
4631 ;; - `strongly' never allows reuse.
4633 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4634 The actual non-nil value of this variable will be copied to the
4651 ,display-buffer--action-function-custom-type
4656 :key-type symbol
4661 "Overriding action to perform to display a buffer.
4662 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4663 function or a list of functions. Each function should accept two
4664 arguments: a buffer to display and an alist similar to ALIST.
4669 "Alist of conditional actions for `display-buffer'.
4670 This is a list of elements (CONDITION . ACTION), where:
4672 CONDITION is either a regexp matching buffer names, or a function
4673 that takes a buffer and returns a boolean.
4675 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4676 function or a list of functions. Each such function should
4677 accept two arguments: a buffer to display and an alist of the
4678 same form as ALIST. See `display-buffer' for details."
4681 regexp
4684 :risky t
4689 "User-specified default action for `display-buffer'.
4690 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4691 function or a list of functions. Each function should accept two
4692 arguments: a buffer to display and an alist similar to ALIST.
4693 See `display-buffer' for details."
4694 :type display-buffer--action-custom-type
4695 :risky t
4701 display-buffer-reuse-window
4702 display-buffer--maybe-pop-up-frame-or-window
4703 display-buffer-use-some-window
4704 ;; If all else fails, pop up a new frame.
4705 display-buffer-pop-up-frame))
4706 "Default fallback action for `display-buffer'.
4707 This is the action used by `display-buffer' if no other actions
4708 specified, e.g. by the user options `display-buffer-alist' or
4713 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4731 display-buffer-pop-up-frame)
4738 "Display BUFFER-OR-NAME in some window, without selecting it.
4739 BUFFER-OR-NAME must be a buffer or the name of an existing
4740 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4741 or nil if no such window is found.
4743 Optional argument ACTION should have the form (FUNCTION . ALIST).
4744 FUNCTION is either a function or a list of functions.
4745 ALIST is an arbitrary association list (alist).
4747 Each such FUNCTION should accept two arguments: the buffer to
4748 display and an alist. Based on those arguments, it should either
4749 display the buffer and return the window, or return nil if unable
4750 to display the buffer.
4752 The `display-buffer' function builds a function list and an alist
4753 by combining the functions and alists specified in
4754 `display-buffer-overriding-action', `display-buffer-alist', the
4755 ACTION argument, `display-buffer-base-action', and
4756 `display-buffer-fallback-action' (in order). Then it calls each
4757 function in the combined function list in turn, passing the
4758 buffer as the first argument and the combined alist as the second
4759 argument, until one of the functions returns non-nil.
4761 Available action functions include:
4762 `display-buffer-same-window'
4763 `display-buffer-reuse-window'
4764 `display-buffer-pop-up-frame'
4765 `display-buffer-pop-up-window'
4766 `display-buffer-use-some-window'
4768 Recognized alist entries include:
4770 `inhibit-same-window' -- A non-nil value prevents the same
4771 window from being used for display.
4773 `inhibit-switch-frame' -- A non-nil value prevents any other
4774 frame from being raised or selected,
4775 even if the window is displayed there.
4777 `reusable-frames' -- Value specifies frame(s) to search for a
4778 window that already displays the buffer.
4779 See `display-buffer-reuse-window'.
4781 The ACTION argument to `display-buffer' can also have a non-nil
4782 and non-list value. This means to display the buffer in a window
4783 other than the selected one, even if it is already displayed in
4784 the selected window. If called interactively with a prefix
4785 argument, ACTION is t.
4787 Optional argument FRAME, if non-nil, acts like an additional
4788 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4789 search for a window that is already displaying the buffer. See
4790 `display-buffer-reuse-window'."
4794 buffer-or-name
4796 ;; Handle the old form of the first argument.
4800 ;; If `display-buffer-function' is defined, let it do the job.
4802 ;; Otherwise, use the defined actions.
4805 display-buffer-alist))
4807 ;; Extra actions from the arguments to this function:
4813 ;; Construct action function list and action alist.
4815 user-action special-action action extra-action
4816 display-buffer-base-action
4817 display-buffer-fallback-action))
4822 actions)))
4824 window)
4830 window))))
4833 "Display buffer BUFFER in another frame.
4834 This uses the function `display-buffer' as a subroutine; see
4835 its documentation for additional customization information."
4839 ;;; `display-buffer' action functions:
4842 "Display BUFFER in the selected window.
4843 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4844 if the selected window is a minibuffer window or is dedicated to
4845 another buffer; in that case, return nil. Otherwise, return the
4846 selected window."
4853 "Conditionally display BUFFER in the selected window.
4854 If `same-window-p' returns non-nil for BUFFER's name, call
4855 `display-buffer-same-window' and return its value. Otherwise,
4856 return nil."
4861 "Return a window that is already displaying BUFFER.
4862 Return nil if no usable window is found.
4864 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4865 window is not eligible for reuse.
4867 If ALIST contains a `reusable-frames' entry, its value determines
4868 which frames to search for a reusable window:
4869 nil -- the selected frame (actually the last non-minibuffer frame)
4870 A frame -- just that frame
4871 `visible' -- all visible frames
4872 0 -- all frames on the current terminal
4873 t -- all frames.
4875 If ALIST contains no `reusable-frames' entry, search just the
4876 selected frame if `display-buffer-reuse-frames' and
4877 `pop-up-frames' are both nil; search all frames on the current
4878 terminal if either of those variables is non-nil.
4880 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4881 event that a window on another frame is chosen, avoid raising
4882 that frame."
4887 pop-up-frames)
4896 frames))))))
4903 "Return special display action for BUFFER, if any.
4904 If `special-display-p' returns non-nil for BUFFER, return an
4905 appropriate display action involving `special-display-function'.
4906 See `display-buffer' for the format of display actions."
4908 ;; `special-display-p' returns either t or a list of frame
4909 ;; parameters to pass to `special-display-function'.
4918 "Display BUFFER in a new frame.
4919 This works by calling `pop-up-frame-function'. If successful,
4920 return the window used; otherwise return nil.
4922 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
4923 raising the new frame."
4925 frame window)
4935 "Display BUFFER by popping up a new window.
4936 The new window is created on the selected frame, or in
4937 `last-nonminibuffer-frame' if no windows can be created there.
4938 If successful, return the new window; otherwise return nil.
4940 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4941 event that the new window is created on another frame, avoid
4942 raising the frame."
4945 window)
4947 ;; If the selected frame cannot be split, look at
4948 ;; `last-nonminibuffer-frame'.
4953 ;; Attempt to split largest or least recently used window.
4964 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4966 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4967 text-only terminal), try with `display-buffer-pop-up-frame'.
4969 If that cannot be done, and `pop-up-windows' is non-nil, try
4970 again with `display-buffer-pop-up-window'."
4973 pop-up-frames)
4979 "Display BUFFER in an existing window.
4980 Search for a usable window, set that window to the buffer, and
4981 return the window. If no suitable window is found, return nil.
4983 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4984 event that a window in another frame is chosen, avoid raising
4985 that frame."
4990 ;; Reuse an existing window.
4995 window))
5000 window))
5008 ;;; Display + selection commands:
5010 "Select buffer BUFFER in some window, preferably a different one.
5011 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5012 is a string not naming an existent buffer, create a buffer with
5013 that name. If BUFFER is nil, choose some other buffer. Return
5014 the buffer.
5016 This uses `display-buffer' as a subroutine. The optional ACTION
5017 argument is passed to `display-buffer' as its ACTION argument.
5018 See `display-buffer' for more information. ACTION is t if called
5019 interactively with a prefix argument, which means to pop to a
5020 window other than the selected one even if the buffer is already
5021 displayed in the selected window.
5023 If the window to show BUFFER is not on the selected
5024 frame, raise that window's frame and give it input focus.
5026 Optional third arg NORECORD non-nil means do not put this buffer
5027 at the front of the list of recently selected ones."
5035 ;; If we chose another frame, make sure it gets input focus.
5038 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
5040 buffer))
5043 "Select buffer BUFFER in some window, preferably the same one.
5044 This function behaves much like `switch-to-buffer', except it
5045 displays with `special-display-function' if BUFFER has a match in
5046 `special-display-buffer-names' or `special-display-regexps'.
5048 Unlike `pop-to-buffer', this function prefers using the selected
5049 window over popping up a new window or frame.
5051 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5052 is a string not naming an existent buffer, create a buffer with
5053 that name. If BUFFER is nil, choose some other buffer. Return
5054 the buffer.
5056 NORECORD, if non-nil means do not put this buffer at the front of
5057 the list of recently selected ones."
5061 "Read the name of a buffer to switch to, prompting with PROMPT.
5062 Return the name of the buffer as a string.
5064 This function is intended for the `switch-to-buffer' family of
5065 commands since these need to omit the name of the current buffer
5066 from the list of completions and default values."
5071 ;; Since rbts-completion-table is built dynamically, we
5072 ;; can't just add it to the default value of
5073 ;; icomplete-with-completion-tables, so we add it
5074 ;; here manually.
5079 icomplete-with-completion-tables))))
5084 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5085 If BUFFER-OR-NAME is nil, return the buffer returned by
5086 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5087 exists, return that buffer. If no such buffer exists, create a
5088 buffer with the name BUFFER-OR-NAME and return that buffer."
5093 buffer))
5097 "Switch to buffer BUFFER-OR-NAME in the selected window.
5098 If called interactively, prompt for the buffer name using the
5099 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5100 determines whether to request confirmation before creating a new
5101 buffer.
5103 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5104 nil. If BUFFER-OR-NAME is a string that does not identify an
5105 existing buffer, create a buffer with that name. If
5106 BUFFER-OR-NAME is nil, switch to the buffer returned by
5107 `other-buffer'.
5109 Optional argument NORECORD non-nil means do not put the buffer
5110 specified by BUFFER-OR-NAME at the front of the buffer list and
5111 do not make the window displaying it the most recently selected
5112 one.
5114 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5115 in the selected window; signal an error if that is
5116 impossible (e.g. if the selected window is minibuffer-only). If
5117 nil, BUFFER-OR-NAME may be displayed in another window.
5119 Return the buffer switched to."
5124 ;; Don't call set-window-buffer if it's not needed since it
5125 ;; might signal an error (e.g. if the window is dedicated).
5142 "Select the buffer specified by BUFFER-OR-NAME in another window.
5143 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5144 nil. Return the buffer switched to.
5146 If called interactively, prompt for the buffer name using the
5147 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5148 determines whether to request confirmation before creating a new
5149 buffer.
5151 If BUFFER-OR-NAME is a string and does not identify an existing
5152 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5153 nil, switch to the buffer returned by `other-buffer'.
5155 Optional second argument NORECORD non-nil means do not put this
5156 buffer at the front of the list of recently selected ones.
5158 This uses the function `display-buffer' as a subroutine; see its
5159 documentation for additional customization information."
5166 "Switch to buffer BUFFER-OR-NAME in another frame.
5167 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5168 nil. Return the buffer switched to.
5170 If called interactively, prompt for the buffer name using the
5171 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5172 determines whether to request confirmation before creating a new
5173 buffer.
5175 If BUFFER-OR-NAME is a string and does not identify an existing
5176 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5177 nil, switch to the buffer returned by `other-buffer'.
5179 Optional second arg NORECORD non-nil means do not put this
5180 buffer at the front of the list of recently selected ones.
5182 This uses the function `display-buffer' as a subroutine; see its
5183 documentation for additional customization information."
5187 \f
5189 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5190 WINDOW must be a live window. HEIGHT doesn't include the mode
5191 line or header line, if any, or any partial-height lines in the
5192 text display area.
5194 Note that the current implementation of this function cannot
5195 always set the height exactly, but attempts to be conservative,
5196 by allocating more lines than are actually needed in the case
5197 where some error may be present."
5201 ;; Setting window-min-height to a value like 1 can lead to very
5202 ;; bizarre displays because it also allows Emacs to make *other*
5203 ;; windows one line tall, which means that there's no more space
5204 ;; for the mode line.
5209 "Make selected window DELTA columns wider.
5210 Interactively, if no argument is given, make selected window one
5211 column wider."
5216 "Make selected window DELTA columns narrower.
5217 Interactively, if no argument is given, make selected window one
5218 column narrower."
5223 "Return the number of screen lines in the region.
5224 The number of screen lines may be different from the number of actual lines,
5225 due to line breaking, display table, etc.
5227 Optional arguments BEG and END default to `point-min' and `point-max'
5228 respectively.
5230 If region ends with a newline, ignore it unless optional third argument
5231 COUNT-FINAL-NEWLINE is non-nil.
5233 The optional fourth argument WINDOW specifies the window used for obtaining
5234 parameters such as width, horizontal scrolling, and so on. The default is
5235 to use the selected window's parameters.
5237 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5238 regardless of which buffer is displayed in WINDOW. This makes possible to use
5239 `count-screen-lines' in any buffer, whether or not it is currently displayed
5240 in some window."
5246 0
5259 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5263 ;; If buffer ends with a newline, ignore it when
5264 ;; counting height unless point is after it.
5266 window))))
5268 ;;; Resizing buffers to fit their contents exactly.
5270 "Adjust height of WINDOW to display its buffer's contents exactly.
5271 WINDOW can be any live window and defaults to the selected one.
5273 Optional argument MAX-HEIGHT specifies the maximum height of
5274 WINDOW and defaults to the height of WINDOW's frame. Optional
5275 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5276 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5277 are specified in lines and include the mode line and header line,
5278 if any.
5280 Optional argument OVERRIDE non-nil means override restrictions
5281 imposed by `window-min-height' and `window-min-width' on the size
5282 of WINDOW.
5284 Return the number of lines by which WINDOW was enlarged or
5285 shrunk. If an error occurs during resizing, return nil but don't
5286 signal an error.
5288 Note that even if this function makes WINDOW large enough to show
5289 _all_ lines of its buffer you might not see the first lines when
5290 WINDOW was scrolled."
5292 ;; Do all the work in WINDOW and its buffer and restore the selected
5293 ;; window and the current buffer when we're done.
5295 ;; Can't resize a full height or fixed-size window.
5298 ;; `with-selected-window' should orderly restore the current buffer.
5300 ;; We are in WINDOW's buffer now.
5306 window-safe-min-height)))
5309 ;; Adjust MAX-HEIGHT.
5312 max-window-height
5314 ;; Make `desired-height' the height necessary to show
5315 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5316 ;; and MAX-HEIGHT.
5321 ;; For non-minibuffers count the mode line, if any.
5323 mode-line-format)
5324 1
5326 ;; Count the header line, if any.
5328 max-height)
5329 min-height))
5338 ;; This `condition-case' shouldn't be necessary, but who knows?
5341 ;; Return zero if DELTA became zero in the process.
5342 0
5343 ;; Don't try to redisplay with the cursor at the end on its
5344 ;; own line--that would force a scroll and spoil things.
5346 ;; It's silly to put `point' at the end of the previous
5347 ;; line and so maybe force horizontal scrolling.
5349 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5351 ;; Check if the last line is surely fully visible. If
5352 ;; not, enlarge the window.
5356 ;; Don't include final newline.
5359 ;; If line-wrapping is turned off, test the
5360 ;; beginning of the last line for
5361 ;; visibility instead of the end, as the
5362 ;; end of the line could be invisible by
5363 ;; virtue of extending past the edge of the
5364 ;; window.
5368 ;; This loop might in some rare pathological cases raise
5369 ;; an error - another reason for the `condition-case'.
5376 delta))))
5379 "Return t if WINDOW can be shrunk without shrinking other windows.
5380 WINDOW defaults to the selected window."
5387 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5388 More precisely, shrink WINDOW vertically to be as small as
5389 possible, while still showing the full contents of its buffer.
5390 WINDOW defaults to the selected window.
5392 Do not shrink WINDOW to less than `window-min-height' lines. Do
5393 nothing if the buffer contains more lines than the present window
5394 height, or if some of the window's contents are scrolled out of
5395 view, or if shrinking this window would also shrink another
5396 window, or if the window is the only window of its frame.
5398 Return non-nil if the window was shrunk, nil otherwise."
5401 ;; Make sure that WINDOW is vertically combined and `point-min' is
5402 ;; visible (for whatever reason that's needed). The remaining issues
5403 ;; should be taken care of by `fit-window-to-buffer'.
5407 \f
5409 "Kill the current buffer and delete the selected window."
5418 ;; If `delete-window' failed before, we rerun it to regenerate
5419 ;; the error so it can be seen in the echo area.
5422 ;; If the buffer is not dead for some reason (probably because
5423 ;; of a `quit' signal), remove the hook again.
5428 \f
5430 "Indicates the last recenter operation performed.
5434 "Cycling order for `recenter-top-bottom'.
5435 A list of elements with possible values `top', `middle', `bottom',
5436 integer or float numbers that define the cycling order for
5437 the command `recenter-top-bottom'.
5439 Top and bottom destinations are `scroll-margin' lines from the true
5440 window top and bottom. Middle redraws the frame and centers point
5441 vertically within the window. Integer number moves current line to
5442 the specified absolute window-line. Float number between 0.0 and 1.0
5443 means the percentage of the screen space from the top. The default
5444 cycling order is middle -> top -> bottom."
5455 "Move current buffer line to the specified window line.
5456 With no prefix argument, successive calls place point according
5457 to the cycling order defined by `recenter-positions'.
5459 A prefix argument is handled like `recenter':
5460 With numeric prefix ARG, move current line to window-line ARG.
5461 With plain `C-u', move current line to window center."
5469 recenter-positions))
5488 "Position point relative to window.
5490 With a prefix argument ARG, acts like `move-to-window-line'.
5492 With no argument, positions point at center of window.
5493 Successive calls position point at positions defined
5494 by `recenter-positions'."
5502 recenter-positions))
5519 \f
5520 ;;; Scrolling commands.
5522 ;;; Scrolling commands which do not signal errors at top/bottom
5523 ;;; of buffer at first key-press (instead move to top/bottom
5524 ;;; of buffer).
5527 "Move point to top/bottom of buffer before signaling a scrolling error.
5528 A value of nil means just signal an error if no more scrolling possible.
5529 A value of t means point moves to the beginning or the end of the buffer
5530 \(depending on scrolling direction) when no more scrolling possible.
5531 When point is already on that position, then signal an error."
5537 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5538 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5539 scroll window further, move cursor to the bottom line.
5540 When point is already on that position, then signal an error.
5541 A near full screen is `next-screen-context-lines' less than a full screen.
5542 Negative ARG means scroll downward.
5543 If ARG is the atom `-', scroll downward by nearly full screen."
5559 ;; When scrolling by ARG lines can't be done,
5560 ;; move by ARG lines instead.
5562 ;; When ARG is nil for full-screen scrolling,
5563 ;; move to the bottom of the buffer.
5569 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5570 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5571 scroll window further, move cursor to the top line.
5572 When point is already on that position, then signal an error.
5573 A near full screen is `next-screen-context-lines' less than a full screen.
5574 Negative ARG means scroll upward.
5575 If ARG is the atom `-', scroll upward by nearly full screen."
5591 ;; When scrolling by ARG lines can't be done,
5592 ;; move by ARG lines instead.
5594 ;; When ARG is nil for full-screen scrolling,
5595 ;; move to the top of the buffer.
5600 ;;; Scrolling commands which scroll a line instead of full screen.
5603 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5604 If ARG is omitted or nil, scroll upward by one line.
5605 This is different from `scroll-up-command' that scrolls a full screen."
5612 "Scroll text of selected window down ARG lines; or one line if no ARG.
5613 If ARG is omitted or nil, scroll down by one line.
5614 This is different from `scroll-down-command' that scrolls a full screen."
5620 \f
5623 For more details, see the documentation for `scroll-other-window'."
5626 ;; Just invert the argument's meaning.
5627 ;; We can do that without knowing which window it will be.
5633 "Move point to the beginning of the buffer in the other window.
5634 Leave mark at previous position.
5635 With arg N, put point N/10 of the way from the true beginning."
5639 ;; We use unwind-protect rather than save-window-excursion
5640 ;; because the latter would preserve the things we want to change.
5644 ;; Set point and mark in that window's buffer.
5647 ;; Set point accordingly.
5652 "Move point to the end of the buffer in the other window.
5653 Leave mark at previous position.
5654 With arg N, put point N/10 of the way from the true end."
5656 ;; See beginning-of-buffer-other-window for comments.
5666 \f
5677 "When non-nil, special state of delayed window autoselection.
5678 Possible values are `suspend' (suspend autoselection after a menu or
5679 scrollbar interaction) and `select' (the next invocation of
5683 "Cancel delayed window autoselection.
5684 Optional argument FORCE means cancel unconditionally."
5686 ;; Don't cancel for select-window or select-frame events
5687 ;; or when the user drags a scroll bar.
5699 "Start delayed window autoselection.
5700 MOUSE-POSITION is the last position where the mouse was seen as returned
5701 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5702 window where the mouse was seen. Optional argument SUSPEND non-nil
5703 means suspend autoselection."
5704 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5708 ;; Install timer which runs `mouse-autoselect-window-select' after
5709 ;; `mouse-autoselect-window' seconds.
5715 "Select window with delayed window autoselection.
5716 If the mouse position has stabilized in a non-selected window, select
5717 that window. The minibuffer window is selected only if the minibuffer
5718 is active. This function is run by `mouse-autoselect-window-timer'."
5729 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5730 ;; of WINDOW, temporarily suspend delayed autoselection.
5733 ;; Delayed autoselection was temporarily suspended, reenable it.
5738 ;; If `mouse-autoselect-window' is positive, select
5739 ;; window if the window is the same as before.
5741 ;; Otherwise select window if the mouse is at the same
5742 ;; position as before. Observe that the first test after
5743 ;; starting autoselection usually fails since the value of
5744 ;; `mouse-autoselect-window-position' recorded there is the
5745 ;; position where the mouse has entered the new window and
5746 ;; not necessarily where the mouse has stopped moving.
5748 ;; The minibuffer is a candidate window if it's active.
5751 ;; Mouse position has stabilized in non-selected window: Cancel
5752 ;; delayed autoselection and try to select that window.
5754 ;; Select window where mouse appears unless the selected window is the
5755 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5756 ;; and post-command hooks and trigger idle timers. To avoid delaying
5757 ;; autoselection again, set `mouse-autoselect-window-state'."
5762 unread-command-events))))
5766 ;; Mouse position has either stabilized in the selected window or at
5767 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5770 ;; Mouse position has not stabilized yet, resume delayed
5771 ;; autoselection.
5775 "Handle select-window events."
5779 ;; Don't switch if we're currently in the minibuffer.
5780 ;; This tries to work around problems where the
5781 ;; minibuffer gets unselected unexpectedly, and where
5782 ;; you then have to move your mouse all the way down to
5783 ;; the minibuffer to select it.
5785 ;; Don't switch to minibuffer window unless it's active.
5788 ;; Don't switch when autoselection shall be delayed.
5793 ;; Cancel any delayed autoselection.
5795 ;; Start delayed autoselection from current mouse
5796 ;; position and window.
5798 ;; Executing a command cancels delayed autoselection.
5802 ;; Reset state of delayed autoselection.
5804 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5806 ;; Clear echo area.
5811 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5812 WINDOW defaults to the selected window.
5813 Return nil if WINDOW is not a partial-width window
5814 (regardless of the value of `truncate-lines').
5815 Otherwise, consult the value of `truncate-partial-width-windows'
5816 for the buffer shown in WINDOW."
5824 t-p-w-w))))
5825 \f
5826 ;; Some of these are in tutorial--default-keys, so update that if you
5827 ;; change these.
5840 ;;; window.el ends here