| blob | ab90d8a4bde34453543338c0c90aa3a237bad887 |
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.
95 WINDOW can be any window."
99 "Return number of WINDOW's child windows.
100 WINDOW can be any window."
106 count))
109 "Return last child window of WINDOW.
110 WINDOW can be any window."
114 window)
117 "Return buffer specified by BUFFER-OR-NAME.
118 BUFFER-OR-NAME must be either a buffer or a string naming a live
119 buffer and defaults to the current buffer."
125 buffer-or-name
132 "Return frame specified by FRAME.
133 FRAME must be a live frame and defaults to the selected frame."
136 frame
141 "Return the window specified by WINDOW.
142 If WINDOW is nil, return the selected window. Otherwise, if
143 WINDOW is a live or an internal window, return WINDOW; if
144 LIVE-ONLY is non-nil, return WINDOW for a live window only.
145 Otherwise, signal an error."
151 window
154 window)
159 "If non-nil, standard functions ignore window parameters.
160 The functions currently affected by this are `split-window',
161 `delete-window', `delete-other-windows' and `other-window'.
163 An application may bind this to a non-nil value around calls to
167 "The absolute minimum number of lines of a window.
171 "The minimum number of lines of any window.
172 The value has to accommodate a mode- or header-line if present.
173 A value less than `window-safe-min-height' is ignored. The value
174 of this variable is honored when windows are resized or split.
176 Applications should never rebind this variable. To resize a
177 window to a height less than the one specified here, an
178 application should instead call `window-resize' with a non-nil
179 IGNORE argument. In order to have `split-window' make a window
180 shorter, explicitly specify the SIZE argument of that function."
186 "The absolute minimum number of columns of a window.
190 "The minimum number of columns of any window.
191 The value has to accommodate margins, fringes, or scrollbars if
192 present. A value less than `window-safe-min-width' is ignored.
193 The value of this variable is honored when windows are resized or
194 split.
196 Applications should never rebind this variable. To resize a
197 window to a width less than the one specified here, an
198 application should instead call `window-resize' with a non-nil
199 IGNORE argument. In order to have `split-window' make a window
200 narrower, explicitly specify the SIZE argument of that function."
206 "Return non-nil if WINDOW has siblings in a given direction.
207 WINDOW must be a valid window and defaults to the selected one.
209 HORIZONTAL determines a direction for the window combination.
210 If HORIZONTAL is omitted or nil, return non-nil if WINDOW is part
211 of a vertical window combination.
212 If HORIZONTAL is non-nil, return non-nil if WINDOW is part of a
213 horizontal window combination."
222 "Return largest number of windows vertically arranged within WINDOW.
223 WINDOW must be a valid window and defaults to the selected one.
224 If HORIZONTAL is non-nil, return the largest number of
225 windows horizontally arranged within WINDOW."
229 ;; If WINDOW is live, return 1.
234 ;; If WINDOW is iso-combined, return the sum of the values for all
235 ;; child windows of WINDOW.
241 count))
243 count))
245 ;; If WINDOW is not iso-combined, return the maximum value of any
246 ;; child window of WINDOW.
252 count))
254 count))))
257 "Helper function for `walk-window-tree' and `walk-window-subtree'."
275 "Run function FUN on each live window of FRAME.
276 FUN must be a function with one argument - a window. FRAME must
277 be a live frame and defaults to the selected one. ANY, if
278 non-nil, means to run FUN on all live and internal windows of
279 FRAME.
281 Optional argument MINIBUF t means run FUN on FRAME's minibuffer
282 window even if it isn't active. MINIBUF nil or omitted means run
283 FUN on FRAME's minibuffer window only if it's active. In both
284 cases the minibuffer window must be part of FRAME. MINIBUF
285 neither nil nor t means never run FUN on the minibuffer window.
287 This function performs a pre-order, depth-first traversal of the
288 window tree. If FUN changes the window tree, the result is
289 unpredictable."
293 ;; Run FUN on FRAME's minibuffer window if requested.
302 "Run function FUN on the subtree of windows rooted at WINDOW.
303 WINDOW defaults to the selected window. FUN must be a function
304 with one argument - a window. By default, run FUN only on live
305 windows of the subtree. If the optional argument ANY is non-nil,
306 run FUN on all live and internal windows of the subtree. If
307 WINDOW is live, run FUN on WINDOW only.
309 This function performs a pre-order, depth-first traversal of the
310 subtree rooted at WINDOW. If FUN changes that tree, the result
311 is unpredictable."
316 "Return first window on FRAME with PARAMETER non-nil.
317 FRAME defaults to the selected frame. Optional argument VALUE
318 non-nil means only return a window whose window-parameter value
319 for PARAMETER equals VALUE (comparison is done with `equal').
320 Optional argument ANY non-nil means consider internal windows
321 too.
323 Optional argument MINIBUF t means consider FRAME's minibuffer
324 window even if it isn't active. MINIBUF nil or omitted means
325 consider FRAME's minibuffer window only if it's active. In both
326 cases the minibuffer window must be part of FRAME. MINIBUF
327 neither nil nor t means never consider the minibuffer window."
335 frame any minibuf))))
337 ;;; Atomic windows.
339 "Return root of atomic window WINDOW is a part of.
340 WINDOW must be a valid window and defaults to the selected one.
341 Return nil if WINDOW is not part of an atomic window."
347 root))
350 "Make WINDOW an atomic window.
351 WINDOW must be an internal window. Return WINDOW."
357 window t)
358 window))
361 "Subroutine of `window--atom-check'."
371 window t))
372 ;; count >= 1 must hold here. If there's no other
373 ;; window around dissolve this atomic window.
375 ;; Dissolve atomic window.
379 window t)))
380 ;; Check children.
384 ;; Check right sibling
388 "Check atomicity of all windows on FRAME.
389 FRAME defaults to the selected frame. If an atomic window is
390 wrongly configured, reset the atomicity of all its windows on
391 FRAME to nil. An atomic window is wrongly configured if it has
392 no child windows or one of its child windows is not atomic."
395 ;; Side windows.
400 "If non-nil, left and right side windows are full height.
401 Otherwise, top and bottom side windows are full width."
407 "Maximum number of side window slots.
408 The value is a list of four elements specifying the number of
409 side window slots on (in this order) the left, top, right and
410 bottom side of each frame. If an element is a number, this means
411 to display at most that many side windows on the corresponding
412 side. If an element is nil, this means there's no bound on the
413 number of slots on that side."
415 :risky t
416 :type
422 :value nil
429 :value nil
436 :value nil
443 :value nil
450 "Check the window-side parameter of all windows on FRAME.
451 FRAME defaults to the selected frame. If the configuration is
452 invalid, reset all window-side parameters to nil.
454 A valid configuration has to preserve the following invariant:
456 - If a window has a non-nil window-side parameter, it must have a
457 parent window and the parent window's window-side parameter
458 must be either nil or the same as for window.
460 - If windows with non-nil window-side parameters exist, there
461 must be at most one window of each side and non-side with a
462 parent whose window-side parameter is nil and there must be no
463 leaf window whose window-side parameter is nil."
465 side parent parent-side)
473 ;; The following `cond' seems a bit tedious, but I'd
474 ;; rather stick to using just the stack.
478 ;; A parent whose window-side is non-nil must
479 ;; have a child with the same window-side.
481 ;; Now check that there's more than one main window
482 ;; for any of none, left, top, right and bottom.
504 ;; A leaf window without window-side parameter,
505 ;; record its existence.
507 frame t))
509 ;; At least one non-side window exists, so there must
510 ;; be at least one side-window and no normal window.
512 ;; No non-side window exists, so there must be no side
513 ;; window either.
518 frame t))))
521 "Check atomic and side windows on FRAME.
522 FRAME defaults to the selected frame."
526 ;;; Window sizes.
528 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
529 If the value is `height', then only the window's height is fixed.
530 If the value is `width', then only the window's width is fixed.
531 Any other non-nil value fixes both the width and the height.
533 Emacs won't change the size of any window displaying that buffer,
534 unless it has no other choice (like when deleting a neighboring
539 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
543 "Return the minimum size of WINDOW.
544 WINDOW must be a valid window and defaults to the selected one.
545 Optional argument HORIZONTAL non-nil means return the minimum
546 number of columns of WINDOW; otherwise return the minimum number
547 of WINDOW's lines.
549 Optional argument IGNORE, if non-nil, means ignore restrictions
550 imposed by fixed size windows, `window-min-height' or
551 `window-min-width' settings. If IGNORE equals `safe', live
552 windows may get as small as `window-safe-min-height' lines and
553 `window-safe-min-width' columns. If IGNORE is a window, ignore
554 restrictions for that window only. Any other non-nil value
555 means ignore all of the above restrictions for all windows."
560 "Internal function of `window-min-size'."
564 ;; WINDOW is an internal window.
566 ;; The minimum size of an iso-combination is the sum of
567 ;; the minimum sizes of its child windows.
572 ;; The minimum size of an ortho-combination is the maximum of
573 ;; the minimum sizes of its child windows.
578 value)
583 ;; The minimum size of a fixed size window is its size.
586 ;; If IGNORE equals `safe' or WINDOW return the safe values.
589 ;; For the minimum width of a window take fringes and
590 ;; scroll-bars into account. This is questionable and should
591 ;; be removed as soon as we are able to split (and resize)
592 ;; windows such that the new (or resized) windows can get a
593 ;; size less than the user-specified `window-min-height' and
594 ;; `window-min-width'.
599 (+ window-safe-min-width
612 window-min-width
615 ;; For the minimum height of a window take any mode- or
616 ;; header-line into account.
622 window-min-height
626 "Return DELTA if DELTA lines can be added to WINDOW.
627 WINDOW must be a valid window and defaults to the selected one.
628 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
629 columns can be added to WINDOW. A return value of zero means
630 that no lines (or columns) can be added to WINDOW.
632 This function looks only at WINDOW and, recursively, its child
633 windows. The function `window-resizable' looks at other windows
634 as well.
636 DELTA positive means WINDOW shall be enlarged by DELTA lines or
637 columns. If WINDOW cannot be enlarged by DELTA lines or columns
638 return the maximum value in the range 0..DELTA by which WINDOW
639 can be enlarged.
641 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
642 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
643 return the minimum value in the range DELTA..0 by which WINDOW
644 can be shrunk.
646 Optional argument IGNORE non-nil means ignore restrictions
647 imposed by fixed size windows, `window-min-height' or
648 `window-min-width' settings. If IGNORE equals `safe', live
649 windows may get as small as `window-safe-min-height' lines and
650 `window-safe-min-width' columns. If IGNORE is a window, ignore
651 restrictions for that window only. Any other non-nil value means
652 ignore all of the above restrictions for all windows."
658 delta))
660 delta)
663 0
664 delta))
668 "Return t if WINDOW can be resized by DELTA lines.
669 WINDOW must be a valid window and defaults to the selected one.
670 For the meaning of the arguments of this function see the
671 doc-string of `window-sizable'."
678 "Internal function for `window-size-fixed-p'."
682 ;; WINDOW is an internal window.
684 ;; An iso-combination is fixed size if all its child
685 ;; windows are fixed-size.
689 ;; We found a non-fixed-size child window, so
690 ;; WINDOW's size is not fixed.
693 ;; All child windows are fixed-size, so WINDOW's size is
694 ;; fixed.
696 ;; An ortho-combination is fixed-size if at least one of its
697 ;; child windows is fixed-size.
700 ;; We found a fixed-size child window, so WINDOW's size
701 ;; is fixed.
704 ;; WINDOW is a live window.
711 "Return non-nil if WINDOW's height is fixed.
712 WINDOW must be a valid window and defaults to the selected one.
713 Optional argument HORIZONTAL non-nil means return non-nil if
714 WINDOW's width is fixed.
716 If this function returns nil, this does not necessarily mean that
717 WINDOW can be resized in the desired direction. The function
718 `window-resizable' can tell that."
723 "Internal function for `window-min-delta'."
725 ;; If we can't go up, return zero.
726 0
727 ;; Else try to find a non-fixed-size sibling of WINDOW.
732 ;; In an iso-combination throw DELTA if we find at least one
733 ;; child window and that window is either not fixed-size or
734 ;; we can ignore fixed-sizeness.
744 ;; We found a non-fixed-size child window.
747 ;; In an ortho-combination set DELTA to the minimum value by
748 ;; which other child windows can shrink.
757 delta
761 "Return number of lines by which WINDOW can be shrunk.
762 WINDOW must be a valid window and defaults to the selected one.
763 Return zero if WINDOW cannot be shrunk.
765 Optional argument HORIZONTAL non-nil means return number of
766 columns by which WINDOW can be shrunk.
768 Optional argument IGNORE non-nil means ignore restrictions
769 imposed by fixed size windows, `window-min-height' or
770 `window-min-width' settings. If IGNORE is a window, ignore
771 restrictions for that window only. If IGNORE equals `safe',
772 live windows may get as small as `window-safe-min-height' lines
773 and `window-safe-min-width' columns. Any other non-nil value
774 means ignore all of the above restrictions for all windows.
776 Optional argument TRAIL restricts the windows that can be enlarged.
777 If its value is `before', only windows to the left of or above WINDOW
778 can be enlarged. If it is `after', only windows to the right of or
779 below WINDOW can be enlarged.
781 Optional argument NOUP non-nil means don't go up in the window
782 tree, but try to enlarge windows within WINDOW's combination only.
784 Optional argument NODOWN non-nil means don't check whether WINDOW
785 itself (and its child windows) can be shrunk; check only whether
786 at least one other window can be enlarged appropriately."
792 ;; If NODOWN is t, try to recover the entire size of WINDOW.
795 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
796 ;; there's nothing to recover.
799 ;; Otherwise, try to recover whatever WINDOW is larger than its
800 ;; minimum size.
805 "Internal function of `window-max-delta'."
807 ;; Can't go up. Return DELTA.
808 delta
813 ;; For an iso-combination calculate how much we can get from
814 ;; other child windows.
823 (+ delta
827 ;; For an ortho-combination throw DELTA when at least one
828 ;; child window is fixed-size.
836 ;; When NOUP is nil, DELTA is all we can get.
837 delta
838 ;; Else try with parent of WINDOW, passing the DELTA we
839 ;; recovered so far.
843 "Return maximum number of lines by which WINDOW can be enlarged.
844 WINDOW must be a valid window and defaults to the selected one.
845 The return value is zero if WINDOW cannot be enlarged.
847 Optional argument HORIZONTAL non-nil means return maximum number
848 of columns by which WINDOW can be enlarged.
850 Optional argument IGNORE non-nil means ignore restrictions
851 imposed by fixed size windows, `window-min-height' or
852 `window-min-width' settings. If IGNORE is a window, ignore
853 restrictions for that window only. If IGNORE equals `safe',
854 live windows may get as small as `window-safe-min-height' lines
855 and `window-safe-min-width' columns. Any other non-nil value means
856 ignore all of the above restrictions for all windows.
858 Optional argument TRAIL restricts the windows that can be enlarged.
859 If its value is `before', only windows to the left of or above WINDOW
860 can be enlarged. If it is `after', only windows to the right of or
861 below WINDOW can be enlarged.
863 Optional argument NOUP non-nil means don't go up in the window
864 tree but try to obtain the entire space from windows within
865 WINDOW's combination.
867 Optional argument NODOWN non-nil means do not check whether
868 WINDOW itself (and its child windows) can be enlarged; check
869 only whether other windows can be shrunk appropriately."
873 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
874 ;; size.
875 0
876 ;; WINDOW has no fixed size.
879 ;; Make NOUP also inhibit the min-size check.
881 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
882 WINDOW must be a valid window and defaults to the selected one.
883 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
884 can be resized horizontally by DELTA columns. A return value of
885 zero means that WINDOW is not resizable.
887 DELTA positive means WINDOW shall be enlarged by DELTA lines or
888 columns. If WINDOW cannot be enlarged by DELTA lines or columns,
889 return the maximum value in the range 0..DELTA by which WINDOW
890 can be enlarged.
892 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
893 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
894 return the minimum value in the range DELTA..0 that can be used
895 for shrinking WINDOW.
897 Optional argument IGNORE non-nil means ignore restrictions
898 imposed by fixed size windows, `window-min-height' or
899 `window-min-width' settings. If IGNORE is a window, ignore
900 restrictions for that window only. If IGNORE equals `safe',
901 live windows may get as small as `window-safe-min-height' lines
902 and `window-safe-min-width' columns. Any other non-nil value
903 means ignore all of the above restrictions for all windows.
905 Optional argument TRAIL `before' means only windows to the left
906 of or below WINDOW can be shrunk. Optional argument TRAIL
907 `after' means only windows to the right of or above WINDOW can be
908 shrunk.
910 Optional argument NOUP non-nil means don't go up in the window
911 tree but check only whether space can be obtained from (or given
912 to) WINDOW's siblings.
914 Optional argument NODOWN non-nil means don't go down in the
915 window tree. This means do not check whether resizing would
916 violate size restrictions of WINDOW or its child windows."
921 delta))
924 delta))
928 "Return t if WINDOW can be resized vertically by DELTA lines.
929 WINDOW must be a valid window and defaults to the selected one.
930 For the meaning of the arguments of this function see the
931 doc-string of `window--resizable'."
935 delta)
937 delta)))
940 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
941 WINDOW must be a valid window and defaults to the selected one.
942 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
943 can be resized horizontally by DELTA columns. A return value of
944 zero means that WINDOW is not resizable.
946 DELTA positive means WINDOW shall be enlarged by DELTA lines or
947 columns. If WINDOW cannot be enlarged by DELTA lines or columns
948 return the maximum value in the range 0..DELTA by which WINDOW
949 can be enlarged.
951 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
952 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
953 return the minimum value in the range DELTA..0 that can be used
954 for shrinking WINDOW.
956 Optional argument IGNORE non-nil means ignore restrictions
957 imposed by fixed size windows, `window-min-height' or
958 `window-min-width' settings. If IGNORE is a window, ignore
959 restrictions for that window only. If IGNORE equals `safe',
960 live windows may get as small as `window-safe-min-height' lines
961 and `window-safe-min-width' columns. Any other non-nil value
962 means ignore all of the above restrictions for all windows."
967 "Return the total height or width of WINDOW.
968 WINDOW must be a valid window and defaults to the selected one.
970 If HORIZONTAL is omitted or nil, return the total height of
971 WINDOW, in lines, like `window-total-height'. Otherwise return
972 the total width, in columns, like `window-total-width'."
977 ;; Eventually we should make `window-height' obsolete.
980 ;; See discussion in bug#4543.
982 "Return t if WINDOW is as high as its containing frame.
983 More precisely, return t if and only if the total height of
984 WINDOW equals the total height of the root window of WINDOW's
985 frame. WINDOW must be a valid window and defaults to the
986 selected one."
992 "Return t if WINDOW is as wide as its containing frame.
993 More precisely, return t if and only if the total width of WINDOW
994 equals the total width of the root window of WINDOW's frame.
995 WINDOW must be a valid window and defaults to the selected one."
1001 "Return the height or width of WINDOW's text area.
1002 WINDOW must be a live window and defaults to the selected one.
1004 If HORIZONTAL is omitted or nil, return the height of the text
1005 area, like `window-body-height'. Otherwise, return the width of
1006 the text area, like `window-body-width'."
1011 ;; Eventually we should make `window-height' obsolete.
1015 "Return the current scroll bar settings for WINDOW.
1016 WINDOW must be a live window and defaults to the selected one.
1018 The return value is a cons cell (VERTICAL . HORIZONTAL) where
1019 VERTICAL specifies the current location of the vertical scroll
1020 bars (`left', `right', or nil), and HORIZONTAL specifies the
1021 current location of the horizontal scroll bars (`top', `bottom',
1022 or nil).
1024 Unlike `window-scroll-bars', this function reports the scroll bar
1025 type actually used, once frame defaults and `scroll-bar-mode' are
1026 taken into account."
1039 "Cycle through all live windows, calling FUN for each one.
1040 FUN must specify a function with a window as its sole argument.
1041 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1042 windows to include in the walk.
1044 MINIBUF t means include the minibuffer window even if the
1045 minibuffer is not active. MINIBUF nil or omitted means include
1046 the minibuffer window only if the minibuffer is active. Any
1047 other value means do not include the minibuffer window even if
1048 the minibuffer is active.
1050 ALL-FRAMES nil or omitted means consider all windows on the
1051 selected frame, plus the minibuffer window if specified by the
1052 MINIBUF argument. If the minibuffer counts, consider all windows
1053 on all frames that share that minibuffer too. The following
1054 non-nil values of ALL-FRAMES have special meanings:
1056 - t means consider all windows on all existing frames.
1058 - `visible' means consider all windows on all visible frames on
1059 the current terminal.
1061 - 0 (the number zero) means consider all windows on all visible
1062 and iconified frames on the current terminal.
1064 - A frame means consider all windows on that frame only.
1066 Anything else means consider all windows on the selected frame
1067 and no others.
1069 This function changes neither the order of recently selected
1070 windows nor the buffer list."
1071 ;; If we start from the minibuffer window, don't fail to come
1072 ;; back to it.
1075 ;; Make sure to not mess up the order of recently selected
1076 ;; windows. Use `save-selected-window' and `select-window'
1077 ;; with second argument non-nil for this purpose.
1085 "Return t if WINDOW is at SIDE of its containing frame.
1086 WINDOW must be a valid window and defaults to the selected one.
1087 SIDE can be any of the symbols `left', `top', `right' or
1088 `bottom'. The default value nil is handled like `bottom'."
1100 "Return list of all windows on SIDE of FRAME.
1101 FRAME must be a live frame and defaults to the selected frame.
1102 SIDE can be any of the symbols `left', `top', `right' or
1103 `bottom'. The default value nil is handled like `bottom'."
1114 "Support function for `window-in-direction'."
1125 ;; Predecessors to the below have been devised by Julian Assange in
1126 ;; change-windows-intuitively.el and Hovav Shacham in windmove.el.
1127 ;; Neither of these allow to selectively ignore specific windows
1128 ;; (windows whose `no-other-window' parameter is non-nil) as targets of
1129 ;; the movement.
1131 "Return window in DIRECTION as seen from WINDOW.
1132 More precisely, return the nearest window in direction DIRECTION
1133 as seen from the position of `window-point' in window WINDOW.
1134 DIRECTION must be one of `above', `below', `left' or `right'.
1135 WINDOW must be a live window and defaults to the selected one.
1137 Do not return a window whose `no-other-window' parameter is
1138 non-nil. If the nearest window's `no-other-window' parameter is
1139 non-nil, try to find another window in the indicated direction.
1140 If, however, the optional argument IGNORE is non-nil, return that
1141 window even if its `no-other-window' parameter is non-nil.
1143 Return nil if no suitable window can be found."
1156 ;; The column / row value of `posn-at-point' can be nil for the
1157 ;; mini-window, guard against that.
1168 best best-2 best-diff-2-new)
1175 ;; Ignore ourselves.
1177 ;; Ignore W unless IGNORE is non-nil.
1183 ;; W is to the left or right of WINDOW and covers POSN.
1193 ;; W is to the left or right of WINDOW but does not
1194 ;; cover POSN.
1209 ;; W is above or below WINDOW and covers POSN.
1219 ;; W is above or below WINDOW but does not cover POSN.
1230 frame)
1234 "Return a live window satisfying PREDICATE.
1235 More precisely, cycle through all windows calling the function
1236 PREDICATE on each one of them with the window as its sole
1237 argument. Return the first window for which PREDICATE returns
1238 non-nil. Windows are scanned starting with the window following
1239 the selected window. If no window satisfies PREDICATE, return
1240 DEFAULT.
1242 MINIBUF t means include the minibuffer window even if the
1243 minibuffer is not active. MINIBUF nil or omitted means include
1244 the minibuffer window only if the minibuffer is active. Any
1245 other value means do not include the minibuffer window even if
1246 the minibuffer is active.
1248 ALL-FRAMES nil or omitted means consider all windows on the selected
1249 frame, plus the minibuffer window if specified by the MINIBUF
1250 argument. If the minibuffer counts, consider all windows on all
1251 frames that share that minibuffer too. The following non-nil
1252 values of ALL-FRAMES have special meanings:
1254 - t means consider all windows on all existing frames.
1256 - `visible' means consider all windows on all visible frames on
1257 the current terminal.
1259 - 0 (the number zero) means consider all windows on all visible
1260 and iconified frames on the current terminal.
1262 - A frame means consider all windows on that frame only.
1264 Anything else means consider all windows on the selected frame
1265 and no others."
1269 minibuf all-frames))
1272 default))
1277 "Return the least recently used window on frames specified by ALL-FRAMES.
1278 Return a full-width window if possible. A minibuffer window is
1279 never a candidate. A dedicated window is never a candidate
1280 unless DEDICATED is non-nil, so if all windows are dedicated, the
1281 value is nil. Avoid returning the selected window if possible.
1282 Optional argument NOT-SELECTED non-nil means never return the
1283 selected window.
1285 The following non-nil values of the optional argument ALL-FRAMES
1286 have special meanings:
1288 - t means consider all windows on all existing frames.
1290 - `visible' means consider all windows on all visible frames on
1291 the current terminal.
1293 - 0 (the number zero) means consider all windows on all visible
1294 and iconified frames on the current terminal.
1296 - A frame means consider all windows on that frame only.
1298 Any other value of ALL-FRAMES means consider all windows on the
1299 selected frame and no others."
1316 "Return the most recently used window on frames specified by ALL-FRAMES.
1317 A minibuffer window is never a candidate. A dedicated window is
1318 never a candidate unless DEDICATED is non-nil, so if all windows
1319 are dedicated, the value is nil. Optional argument NOT-SELECTED
1320 non-nil means never return the selected window.
1322 The following non-nil values of the optional argument ALL-FRAMES
1323 have special meanings:
1325 - t means consider all windows on all existing frames.
1327 - `visible' means consider all windows on all visible frames on
1328 the current terminal.
1330 - 0 (the number zero) means consider all windows on all visible
1331 and iconified frames on the current terminal.
1333 - A frame means consider all windows on that frame only.
1335 Any other value of ALL-FRAMES means consider all windows on the
1336 selected frame and no others."
1345 best-window))
1348 "Return the largest window on frames specified by ALL-FRAMES.
1349 A minibuffer window is never a candidate. A dedicated window is
1350 never a candidate unless DEDICATED is non-nil, so if all windows
1351 are dedicated, the value is nil. Optional argument NOT-SELECTED
1352 non-nil means never return the selected window.
1354 The following non-nil values of the optional argument ALL-FRAMES
1355 have special meanings:
1357 - t means consider all windows on all existing frames.
1359 - `visible' means consider all windows on all visible frames on
1360 the current terminal.
1362 - 0 (the number zero) means consider all windows on all visible
1363 and iconified frames on the current terminal.
1365 - A frame means consider all windows on that frame only.
1367 Any other value of ALL-FRAMES means consider all windows on the
1368 selected frame and no others."
1370 best-window size)
1379 best-window))
1382 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1383 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1384 and defaults to the current buffer. Windows are scanned starting
1385 with the selected window.
1387 MINIBUF t means include the minibuffer window even if the
1388 minibuffer is not active. MINIBUF nil or omitted means include
1389 the minibuffer window only if the minibuffer is active. Any
1390 other value means do not include the minibuffer window even if
1391 the minibuffer is active.
1393 ALL-FRAMES nil or omitted means consider all windows on the
1394 selected frame, plus the minibuffer window if specified by the
1395 MINIBUF argument. If the minibuffer counts, consider all windows
1396 on all frames that share that minibuffer too. The following
1397 non-nil values of ALL-FRAMES have special meanings:
1399 - t means consider all windows on all existing frames.
1401 - `visible' means consider all windows on all visible frames on
1402 the current terminal.
1404 - 0 (the number zero) means consider all windows on all visible
1405 and iconified frames on the current terminal.
1407 - A frame means consider all windows on that frame only.
1409 Anything else means consider all windows on the selected frame
1410 and no others."
1412 windows)
1419 "Return t if WINDOW is the currently active minibuffer window."
1423 "Return the number of live windows on the selected frame.
1424 The optional argument MINIBUF specifies whether the minibuffer
1425 window shall be counted. See `walk-windows' for the precise
1426 meaning of this argument."
1428 \f
1429 ;;; Resizing windows.
1431 "Reset resize values for all windows on FRAME.
1432 FRAME defaults to the selected frame.
1434 This function stores the current value of `window-total-size' applied
1435 with argument HORIZONTAL in the new total size of all windows on
1436 FRAME. It also resets the new normal size of each of these
1437 windows."
1442 "Internal function of `window--resize-reset'."
1443 ;; Register old size in the new total size.
1445 ;; Reset new normal size.
1452 ;; The following routine is used to manually resize the minibuffer
1453 ;; window and is currently used, for example, by ispell.el.
1455 "Resize minibuffer window WINDOW by DELTA lines.
1456 If WINDOW cannot be resized by DELTA lines make it as large (or
1457 as small) as possible, but don't signal an error."
1465 ;; Sanitize DELTA.
1472 ;; Resize now.
1474 ;; Ideally we should be able to resize just the last child of root
1475 ;; here. See the comment in `resize-root-window-vertically' for
1476 ;; why we do not do that.
1479 ;; The following routine catches the case where we want to resize
1480 ;; a minibuffer-only frame.
1484 "Resize WINDOW vertically by DELTA lines.
1485 WINDOW can be an arbitrary window and defaults to the selected
1486 one. An attempt to resize the root window of a frame will raise
1487 an error though.
1489 DELTA a positive number means WINDOW shall be enlarged by DELTA
1490 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1491 lines.
1493 Optional argument HORIZONTAL non-nil means resize WINDOW
1494 horizontally by DELTA columns. In this case a positive DELTA
1495 means enlarge WINDOW by DELTA columns. DELTA negative means
1496 WINDOW shall be shrunk by -DELTA columns.
1498 Optional argument IGNORE non-nil means ignore restrictions
1499 imposed by fixed size windows, `window-min-height' or
1500 `window-min-width' settings. If IGNORE is a window, ignore
1501 restrictions for that window only. If IGNORE equals `safe',
1502 live windows may get as small as `window-safe-min-height' lines
1503 and `window-safe-min-width' columns. Any other non-nil value
1504 means ignore all of the above restrictions for all windows.
1506 This function resizes other windows proportionally and never
1507 deletes any windows. If you want to move only the low (right)
1508 edge of WINDOW consider using `adjust-window-trailing-edge'
1509 instead."
1513 sibling)
1526 ;; If WINDOW is full height and either `resize-mini-windows' is
1527 ;; nil or the minibuffer window is active, resize the minibuffer
1528 ;; window.
1537 ;; If window-combination-resize is nil, WINDOW is part of an
1538 ;; iso-combination, and WINDOW's neighboring right or left
1539 ;; sibling can be resized as requested, resize that sibling.
1546 normal-delta))
1549 normal-delta)))
1550 ;; Otherwise, resize all other windows in the same combination.
1557 "Return non-nil if WINDOW shall be skipped by resizing routines."
1560 (defun window--resize-child-windows-normal (parent horizontal window this-delta &optional trail other-delta)
1561 "Recursively set new normal height of child windows of window PARENT.
1562 HORIZONTAL non-nil means set the new normal width of these
1563 windows. WINDOW specifies a child window of PARENT that has been
1564 resized by THIS-DELTA lines (columns).
1566 Optional argument TRAIL either `before' or `after' means set values
1567 only for windows before or after WINDOW. Optional argument
1568 OTHER-DELTA, a number, specifies that this many lines (columns)
1569 have been obtained from (or returned to) an ancestor window of
1570 PARENT in order to resize WINDOW."
1574 ;; When WINDOW gets deleted and we can return its entire
1575 ;; space to its siblings, use WINDOW's normal size as the
1576 ;; normal delta.
1578 ;; In any other case calculate the normal delta from the
1579 ;; relation of THIS-DELTA to the total size of PARENT.
1585 ;; Set parent-normal to the sum of the normal sizes of all child
1586 ;; windows of PARENT that shall be resized, excluding only WINDOW
1587 ;; and any windows specified by the optional TRAIL argument.
1598 ;; Set the new normal size of all child windows of PARENT from what
1599 ;; they should have contributed for recovering THIS-DELTA lines
1600 ;; (columns).
1614 delta-normal))
1615 ;; Don't drop below 0.
1620 ;; Set the new normal size of windows from what they should have
1621 ;; contributed for recovering OTHER-DELTA lines (columns).
1624 other-delta)))
1636 ;; Don't drop below 0.
1640 ;; Set the new normal size of WINDOW to what is left by the sum of
1641 ;; the normal sizes of its siblings.
1643 window
1654 ;; Don't get larger than 1 or smaller than 0.
1657 (defun window--resize-child-windows (parent delta &optional horizontal window ignore trail edge)
1658 "Resize child windows of window PARENT vertically by DELTA lines.
1659 PARENT must be a vertically combined internal window.
1661 Optional argument HORIZONTAL non-nil means resize child windows of
1662 PARENT horizontally by DELTA columns. In this case PARENT must
1663 be a horizontally combined internal window.
1665 WINDOW, if specified, must denote a child window of PARENT that
1666 is resized by DELTA lines.
1668 Optional argument IGNORE non-nil means ignore restrictions
1669 imposed by fixed size windows, `window-min-height' or
1670 `window-min-width' settings. If IGNORE equals `safe', live
1671 windows may get as small as `window-safe-min-height' lines and
1672 `window-safe-min-width' columns. If IGNORE is a window, ignore
1673 restrictions for that window only. Any other non-nil value means
1674 ignore all of the above restrictions for all windows.
1676 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1677 of windows that shall be resized. If TRAIL equals `before',
1678 resize only windows on the left or above EDGE. If TRAIL equals
1679 `after', resize only windows on the right or below EDGE. Also,
1680 preferably only resize windows adjacent to EDGE.
1682 Return the symbol `normalized' if new normal sizes have been
1683 already set by this routine."
1687 best-window best-value)
1699 sub)
1704 edge)
1709 edge)
1712 ;; Resize only windows adjacent to EDGE.
1715 sub delta horizontal ignore t trail edge)
1718 ;; Assign new normal sizes.
1727 ;; Return 'normalized to notify `window--resize-siblings' that
1728 ;; normal sizes have been already set.
1730 ;; Resize all windows proportionally.
1735 ;; Ignore windows to skip and fixed-size child windows -
1736 ;; in the latter case make it a window to skip.
1741 ;; When shrinking store the number of lines/cols we can get
1742 ;; from this window here together with the total/normal size
1743 ;; factor.
1745 sub
1747 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1750 parent-total)
1753 ;; When enlarging store the total/normal size factor only
1755 sub
1757 parent-total)
1764 ;; Shrink windows by delta.
1783 best-window
1788 parent-total)
1791 ;; Enlarge windows by delta.
1809 best-window
1811 parent-total)
1819 ;; Reset new normal size fields so `window-resize-apply'
1820 ;; won't use them to apply new sizes.
1824 ;; Resize this window's child windows (back-engineering
1825 ;; delta from sub's old and new total sizes).
1829 ;; For the TRAIL non-nil case we have to resize SUB
1830 ;; recursively even if it's size does not change.
1832 sub delta horizontal ignore nil trail edge))))
1836 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1837 Optional argument HORIZONTAL non-nil means resize other windows
1838 when WINDOW is resized horizontally by DELTA columns. WINDOW
1839 itself is not resized by this function.
1841 Optional argument IGNORE non-nil means ignore restrictions
1842 imposed by fixed size windows, `window-min-height' or
1843 `window-min-width' settings. If IGNORE equals `safe', live
1844 windows may get as small as `window-safe-min-height' lines and
1845 `window-safe-min-width' columns. If IGNORE is a window, ignore
1846 restrictions for that window only. Any other non-nil value means
1847 ignore all of the above restrictions for all windows.
1849 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1850 of windows that shall be resized. If TRAIL equals `before',
1851 resize only windows on the left or above EDGE. If TRAIL equals
1852 `after', resize only windows on the right or below EDGE. Also,
1853 preferably only resize windows adjacent to EDGE."
1858 ;; In an iso-combination try to extract DELTA from WINDOW's
1859 ;; siblings.
1861 this-delta other-delta)
1862 ;; Decide which windows shall be left alone.
1866 ;; Make sure WINDOW is left alone when
1867 ;; resizing its siblings.
1871 ;; Make sure this sibling is left alone when
1872 ;; resizing its siblings.
1876 ;; Set this-delta to t to signal that we found a sibling
1877 ;; of WINDOW whose size is not fixed.
1882 ;; Set this-delta to what we can get from WINDOW's siblings.
1884 ;; A deletion, presumably. We must handle this case
1885 ;; specially since `window--resizable' can't be used.
1887 ;; There's at least one resizable sibling we can
1888 ;; give WINDOW's size to.
1890 ;; No resizable sibling exists.
1892 ;; Any other form of resizing.
1896 ;; Set other-delta to what we still have to get from
1897 ;; ancestor windows of parent.
1900 ;; Unless we got everything from WINDOW's siblings, PARENT
1901 ;; must be resized by other-delta lines or columns.
1905 ;; We haven't got anything from WINDOW's siblings but we
1906 ;; must update the normal sizes to respect other-delta.
1908 parent horizontal window this-delta trail other-delta)
1909 ;; We did get something from WINDOW's siblings which means
1910 ;; we have to resize their child windows.
1913 window ignore trail edge)
1914 ;; If `window--resize-child-windows' returns
1915 ;; 'normalized, this means it has set the
1916 ;; normal sizes already.
1918 ;; Set the normal sizes.
1920 parent horizontal window this-delta trail other-delta))
1921 ;; Set DELTA to what we still have to get from ancestor
1922 ;; windows.
1925 ;; In an ortho-combination all siblings of WINDOW must be
1926 ;; resized by DELTA.
1934 ;; "Go up."
1936 parent delta horizontal ignore trail edge)))))
1939 "Resize WINDOW vertically by DELTA lines.
1940 Optional argument HORIZONTAL non-nil means resize WINDOW
1941 horizontally by DELTA columns.
1943 Optional argument IGNORE non-nil means ignore restrictions
1944 imposed by fixed size windows, `window-min-height' or
1945 `window-min-width' settings. If IGNORE equals `safe', live
1946 windows may get as small as `window-safe-min-height' lines and
1947 `window-safe-min-width' columns. If IGNORE is a window, ignore
1948 restrictions for that window only. Any other non-nil value
1949 means ignore all of the above restrictions for all windows.
1951 Optional argument ADD non-nil means add DELTA to the new total
1952 size of WINDOW.
1954 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1955 of windows that shall be resized. If TRAIL equals `before',
1956 resize only windows on the left or above EDGE. If TRAIL equals
1957 `after', resize only windows on the right or below EDGE. Also,
1958 preferably only resize windows adjacent to EDGE.
1960 This function recursively resizes WINDOW's child windows to fit the
1961 new size. Make sure that WINDOW is `window--resizable' before
1962 calling this function. Note that this function does not resize
1963 siblings of WINDOW or WINDOW's parent window. You have to
1964 eventually call `window-resize-apply' in order to make resizing
1965 actually take effect."
1967 ;; Add DELTA to the new total size of WINDOW.
1974 ;; In an iso-combination resize child windows according to their
1975 ;; normal sizes.
1977 window delta horizontal nil ignore trail edge))
1978 ;; In an ortho-combination resize each child window by DELTA.
1982 sub delta horizontal ignore t trail edge)
1986 "Resize root window WINDOW vertically by DELTA lines.
1987 HORIZONTAL non-nil means resize root window WINDOW horizontally
1988 by DELTA columns.
1990 IGNORE non-nil means ignore any restrictions imposed by fixed
1991 size windows, `window-min-height' or `window-min-width' settings.
1993 This function is only called by the frame resizing routines. It
1994 resizes windows proportionally and never deletes any windows."
2001 "Resize root window WINDOW vertically by DELTA lines.
2002 If DELTA is less than zero and we can't shrink WINDOW by DELTA
2003 lines, shrink it as much as possible. If DELTA is greater than
2004 zero, this function can resize fixed-size windows in order to
2005 recover the necessary lines.
2007 Return the number of lines that were recovered.
2009 This function is only called by the minibuffer window resizing
2010 routines. It resizes windows proportionally and never deletes
2011 any windows."
2022 ;; Ideally, we would resize just the last window in a combination
2023 ;; but that's not feasible for the following reason: If we grow
2024 ;; the minibuffer window and the last window cannot be shrunk any
2025 ;; more, we shrink another window instead. But if we then shrink
2026 ;; the minibuffer window again, the last window might get enlarged
2027 ;; and the state after shrinking is not the state before growing.
2028 ;; So, in practice, we'd need a history variable to record how to
2029 ;; proceed. But I'm not sure how such a variable could work with
2030 ;; repeated minibuffer window growing steps.
2032 delta)))
2035 "Move WINDOW's bottom edge by DELTA lines.
2036 Optional argument HORIZONTAL non-nil means move WINDOW's right
2037 edge by DELTA columns. WINDOW must be a valid window and
2038 defaults to the selected one.
2040 If DELTA is greater than zero, move the edge downwards or to the
2041 right. If DELTA is less than zero, move the edge upwards or to
2042 the left. If the edge can't be moved by DELTA lines or columns,
2043 move it as far as possible in the desired direction."
2048 left this-delta min-delta max-delta)
2049 ;; Find the edge we want to move.
2055 ;; Resize the minibuffer window if it's on the same frame as
2056 ;; and immediately below WINDOW and it's either active or
2057 ;; `resize-mini-windows' is nil.
2069 ;; Set LEFT to the first resizable window on the left. This step is
2070 ;; needed to handle fixed-size windows.
2083 ;; Set RIGHT to the first resizable window on the right. This step
2084 ;; is needed to handle fixed-size windows.
2097 ;; LEFT and RIGHT (which might be both internal windows) are now the
2098 ;; two windows we want to resize.
2104 ;; We can't get the whole DELTA - move as far as possible.
2107 ;; Start resizing.
2109 ;; Try to enlarge LEFT first.
2113 left this-delta horizontal nil t 'before
2117 ;; Shrink windows on right of LEFT.
2119 left delta horizontal nil 'after
2127 ;; We can't get the whole DELTA - move as far as possible.
2130 ;; Start resizing.
2132 ;; Try to enlarge RIGHT.
2136 right this-delta horizontal nil t 'after
2140 ;; Shrink windows on left of RIGHT.
2147 ;; Don't report an error in the standard case.
2149 ;; But do report an error if applying the changes fails.
2153 "Make the selected window DELTA lines taller.
2154 Interactively, if no argument is given, make the selected window
2155 one line taller. If optional argument HORIZONTAL is non-nil,
2156 make selected window wider by DELTA columns. If DELTA is
2157 negative, shrink selected window by -DELTA lines or columns.
2158 Return nil."
2173 ;; If the selected window is full height and `resize-mini-windows'
2174 ;; is nil, resize the minibuffer window.
2183 horizontal)))))
2186 "Make the selected window DELTA lines smaller.
2187 Interactively, if no argument is given, make the selected window
2188 one line smaller. If optional argument HORIZONTAL is non-nil,
2189 make selected window narrower by DELTA columns. If DELTA is
2190 negative, enlarge selected window by -DELTA lines or columns.
2191 Also see the `window-min-height' variable.
2192 Return nil."
2207 ;; If the selected window is full height and `resize-mini-windows'
2208 ;; is nil, resize the minibuffer window.
2217 horizontal)))))
2220 "Maximize WINDOW.
2221 Make WINDOW as large as possible without deleting any windows.
2222 WINDOW must be a valid window and defaults to the selected one."
2229 "Minimize WINDOW.
2230 Make WINDOW as small as possible without deleting any windows.
2231 WINDOW must be a valid window and defaults to the selected one."
2236 \f
2238 "Return non-nil if WINDOW is the root window of its frame."
2242 "Return window subtree rooted at WINDOW.
2243 Optional argument NEXT non-nil means include WINDOW's right
2244 siblings in the return value.
2246 See the documentation of `window-tree' for a description of the
2247 return value."
2260 list))
2265 "Return the window tree of frame FRAME.
2266 FRAME must be a live frame and defaults to the selected frame.
2267 The return value is a list of the form (ROOT MINI), where ROOT
2268 represents the window tree of the frame's root window, and MINI
2269 is the frame's minibuffer window.
2271 If the root window is not split, ROOT is the root window itself.
2272 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2273 for a horizontal split, and t for a vertical split. EDGES gives
2274 the combined size and position of the child windows in the split,
2275 and the rest of the elements are the child windows in the split.
2276 Each of the child windows may again be a window or a list
2277 representing a window split, and so on. EDGES is a list (LEFT
2278 TOP RIGHT BOTTOM) as returned by `window-edges'."
2281 \f
2283 "Select another window in cyclic ordering of windows.
2284 COUNT specifies the number of windows to skip, starting with the
2285 selected window, before making the selection. If COUNT is
2286 positive, skip COUNT windows forwards. If COUNT is negative,
2287 skip -COUNT windows backwards. COUNT zero means do not skip any
2288 window, so select the selected window. In an interactive call,
2289 COUNT is the numeric prefix argument. Return nil.
2291 If the `other-window' parameter of the selected window is a
2292 function and `ignore-window-parameters' is nil, call that
2293 function with the arguments COUNT and ALL-FRAMES.
2295 This function does not select a window whose `no-other-window'
2296 window parameter is non-nil.
2298 This function uses `next-window' for finding the window to
2299 select. The argument ALL-FRAMES has the same meaning as in
2300 `next-window', but the MINIBUF argument of `next-window' is
2301 always effectively nil."
2306 old-window old-count)
2309 ;; `next-window' and `previous-window' may return a window we are
2310 ;; not allowed to select. Hence we need an exit strategy in case
2311 ;; all windows are non-selectable.
2318 ;; Keep out of infinite loops. When COUNT has not changed
2319 ;; since we last looked at `window' we're probably in one.
2323 ;; The first non-selectable window `next-window' got us:
2324 ;; Remember it and the current value of COUNT.
2334 ;; Keep out of infinite loops. When COUNT has not changed
2335 ;; since we last looked at `window' we're probably in one.
2339 ;; The first non-selectable window `previous-window' got
2340 ;; us: Remember it and the current value of COUNT.
2347 ;; Always return nil.
2348 nil))))
2350 ;; This should probably return non-nil when the selected window is part
2351 ;; of an atomic window whose root is the frame's root window.
2353 "Return non-nil if the selected window is the only window.
2354 Optional arg NOMINI non-nil means don't count the minibuffer
2355 even if it is active. Otherwise, the minibuffer is counted
2356 when it is active.
2358 Optional argument ALL-FRAMES specifies the set of frames to
2359 consider, see also `next-window'. ALL-FRAMES nil or omitted
2360 means consider windows on the selected frame only, plus the
2361 minibuffer window if specified by the NOMINI argument. If the
2362 minibuffer counts, consider all windows on all frames that share
2363 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2364 with a special meaning are:
2366 - t means consider all windows on all existing frames.
2368 - `visible' means consider all windows on all visible frames on
2369 the current terminal.
2371 - 0 (the number zero) means consider all windows on all visible
2372 and iconified frames on the current terminal.
2374 - A frame means consider all windows on that frame only.
2376 Anything else means consider all windows on the selected frame
2377 and no others."
2383 \f
2384 ;;; Deleting windows.
2386 "Return t if WINDOW can be safely deleted from its frame.
2387 WINDOW must be a valid window and defaults to the selected one.
2388 Return `frame' if deleting WINDOW should also delete its frame."
2392 ;; Handle atomicity.
2400 ;; WINDOW's frame can be deleted only if there are other frames
2401 ;; on the same terminal, and it does not contain the active
2402 ;; minibuffer.
2410 ;; WINDOW can be deleted unless it is the main window of its
2411 ;; frame.
2412 t))))
2415 "Return t if WINDOW is either ROOT or a member of ROOT's subtree."
2425 "Delete WINDOW.
2426 WINDOW must be a valid window and defaults to the selected one.
2427 Return nil.
2429 If the variable `ignore-window-parameters' is non-nil or the
2430 `delete-window' parameter of WINDOW equals t, do not process any
2431 parameters of WINDOW. Otherwise, if the `delete-window'
2432 parameter of WINDOW specifies a function, call that function with
2433 WINDOW as its sole argument and return the value returned by that
2434 function.
2436 Otherwise, if WINDOW is part of an atomic window, call
2437 `delete-window' with the root of the atomic window as its
2438 argument. Signal an error if WINDOW is either the only window on
2439 its frame, the last non-side window, or part of an atomic window
2440 that is its frame's root window."
2446 atom-root)
2449 ;; Handle window parameters.
2451 ;; Ignore window parameters if `ignore-window-parameters' tells
2452 ;; us so or `delete-window' equals t.
2455 ;; The `delete-window' parameter specifies the function to call.
2456 ;; If that function is `ignore' nothing is done. It's up to the
2457 ;; function called here to avoid infinite recursion.
2474 ;; Emacs 23 preferably gives WINDOW's space to its left
2475 ;; sibling.
2481 ;; Resize WINDOW's sibling.
2487 ;; Can do without resizing fixed-size windows.
2490 ;; Can't do without resizing fixed-size windows.
2492 ;; Actually delete WINDOW.
2497 ;; `delete-window-internal' has selected a window that should
2498 ;; not be selected, fix this here.
2502 ;; Always return nil.
2503 nil))))
2506 "Make WINDOW fill its frame.
2507 WINDOW must be a valid window and defaults to the selected one.
2508 Return nil.
2510 If the variable `ignore-window-parameters' is non-nil or the
2511 `delete-other-windows' parameter of WINDOW equals t, do not
2512 process any parameters of WINDOW. Otherwise, if the
2513 `delete-other-windows' parameter of WINDOW specifies a function,
2514 call that function with WINDOW as its sole argument and return
2515 the value returned by that function.
2517 Otherwise, if WINDOW is part of an atomic window, call this
2518 function with the root of the atomic window as its argument. If
2519 WINDOW is a non-side window, make WINDOW the only non-side window
2520 on the frame. Side windows are not deleted. If WINDOW is a side
2521 window signal an error."
2527 atom-root side-main)
2531 ;; Ignore window parameters if `ignore-window-parameters' is t or
2532 ;; `delete-other-windows' is t.
2535 ;; The `delete-other-windows' parameter specifies the function
2536 ;; to call. If the function is `ignore' no windows are deleted.
2537 ;; It's up to the function called to avoid infinite recursion.
2544 ;; Set side-main to the major non-side window.
2548 ;; If WINDOW is the main non-side window, do nothing.
2553 ;; Always return nil.
2554 nil)))
2557 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2559 if you often split windows horizontally."
2571 ;;; Windows and buffers.
2573 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2574 ;; for (1) determining which buffer to show in the window when its
2575 ;; buffer shall be buried or killed and (2) which buffer to show for
2576 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2578 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2579 ;; triples. The entries on this list are ordered by the time their
2580 ;; buffer has been removed from the window, the most recently removed
2581 ;; buffer's entry being first. The window-start and window-point
2582 ;; components are `window-start' and `window-point' at the time the
2583 ;; buffer was removed from the window which implies that the entry must
2584 ;; be added when `set-window-buffer' removes the buffer from the window.
2586 ;; `next-buffers' is the list of buffers that have been replaced
2587 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2588 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2589 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2590 ;; reset to nil by any action changing the window's buffer with the
2591 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2592 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2593 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2595 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2596 ;; if such a buffer was killed while the window was hidden within a
2597 ;; window configuration. Such killed buffers get removed whenever
2598 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2600 ;; The following function is called by `set-window-buffer' _before_ it
2601 ;; replaces the buffer of the argument window with the new buffer.
2603 "Record WINDOW's buffer.
2604 WINDOW must be a live window and defaults to the selected one."
2608 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2609 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2613 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2617 ;; Don't record insignificant buffers.
2619 ;; Add an entry for buffer to WINDOW's previous buffers.
2626 ;; We have an entry, update marker positions.
2629 ;; Make new markers.
2637 "Unrecord BUFFER in WINDOW.
2638 WINDOW must be a live window and defaults to the selected one.
2639 BUFFER must be a live buffer and defaults to the buffer of
2640 WINDOW."
2649 "Set WINDOW's buffer to BUFFER.
2650 WINDOW must be a live window and defaults to the selected one.
2651 Optional argument START non-nil means set WINDOW's start position
2652 to START. Optional argument POINT non-nil means set WINDOW's
2653 point to POINT. If WINDOW is selected this also sets BUFFER's
2654 `point' to POINT. If WINDOW is selected and the buffer it showed
2655 before was current this also makes BUFFER the current buffer."
2663 ;; Don't force window-start here (even if POINT is nil).
2669 "If non-nil, allow switching to an already visible buffer.
2670 If this variable is non-nil, `switch-to-prev-buffer' and
2671 `switch-to-next-buffer' may switch to an already visible buffer
2672 provided the buffer was shown in the argument window before. If
2673 this variable is nil, `switch-to-prev-buffer' and
2674 `switch-to-next-buffer' always try to avoid switching to a buffer
2675 that is already visible in another window on the same frame."
2681 "In WINDOW switch to previous buffer.
2682 WINDOW must be a live window and defaults to the selected one.
2683 Return the buffer switched to, nil if no suitable buffer could be
2684 found.
2686 Optional argument BURY-OR-KILL non-nil means the buffer currently
2687 shown in WINDOW is about to be buried or killed and consequently
2688 shall not be switched to in future invocations of this command."
2693 ;; Save this since it's destroyed by `set-window-buffer'.
2695 entry buffer new-buffer killed-buffers visible)
2700 ;; Scan WINDOW's previous buffers first, skipping entries of next
2701 ;; buffers.
2711 ;; Try to avoid showing a buffer visible in some other window.
2717 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2718 ;; entries of next buffers. Note that when we bury or kill a
2719 ;; buffer we don't reverse the global buffer list to avoid showing
2720 ;; a buried buffer instead. Otherwise, we must reverse the global
2721 ;; buffer list in order to make sure that switching to the
2722 ;; previous/next buffer traverse it in opposite directions.
2731 ;; Try to avoid showing a buffer visible in some other window.
2738 ;; Scan reverted next buffers last (must not use nreverse
2739 ;; here!).
2741 ;; Actually, buffer _must_ be live here since otherwise it
2742 ;; would have been caught in the scan of previous buffers.
2753 ;; Show a buffer visible in another window.
2759 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2760 ;; of) next buffers.
2765 ;; Move `old-buffer' to head of WINDOW's restored list of next
2766 ;; buffers.
2770 ;; Remove killed buffers from WINDOW's previous and next buffers.
2778 ;; Return new-buffer.
2779 new-buffer))
2782 "In WINDOW switch to next buffer.
2783 WINDOW must be a live window and defaults to the selected one.
2784 Return the buffer switched to, nil if no suitable buffer could be
2785 found."
2791 buffer new-buffer entry killed-buffers visible)
2796 ;; Scan WINDOW's next buffers first.
2807 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2808 ;; buffers entries.
2814 ;; Try to avoid showing a buffer visible in some other window.
2819 ;; Scan WINDOW's reverted previous buffers last (must not use
2820 ;; nreverse here!)
2829 ;; Try to avoid showing a buffer visible in some other window.
2837 ;; Show a buffer visible in another window.
2842 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2845 ;; Remove killed buffers from WINDOW's previous and next buffers.
2853 ;; Return new-buffer.
2854 new-buffer))
2857 "Search LIST for a valid buffer to display in FRAME.
2858 Return nil when all buffers in LIST are undesirable for display,
2859 otherwise return the first suitable buffer in LIST.
2861 Buffers not visible in windows are preferred to visible buffers,
2862 unless VISIBLE-OK is non-nil.
2863 If the optional argument FRAME is nil, it defaults to the selected frame.
2864 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2865 ;; This logic is more or less copied from other-buffer.
2868 found buf)
2881 "Return the last buffer in FRAME's buffer list.
2882 If BUFFER is the last buffer, return the preceding buffer
2883 instead. Buffers not visible in windows are preferred to visible
2884 buffers, unless optional argument VISIBLE-OK is non-nil.
2885 Optional third argument FRAME nil or omitted means use the
2886 selected frame's buffer list. If no such buffer exists, return
2887 the buffer `*scratch*', creating it if necessary."
2890 buffer visible-ok frame)
2894 scratch)))
2897 "Function called to automatically hide frames.
2898 The function is called with one argument - a frame.
2900 Functions affected by this option are those that bury a buffer
2901 shown in a separate frame like `quit-window' and `bury-buffer'."
2905 function)
2911 "Delete WINDOW if possible.
2912 WINDOW must be a live window and defaults to the selected one.
2913 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2914 only if it's dedicated to its buffer. Optional argument KILL
2915 means the buffer shown in window will be killed. Return non-nil
2916 if WINDOW gets deleted or its frame is auto-hidden."
2931 t)))))
2934 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2935 There it is the least likely candidate for `other-buffer' to
2937 select by default.
2939 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2940 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2941 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2942 remove the current buffer from the selected window if it is
2943 displayed there."
2946 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2947 ;; although it's not "here" (call it a feature).
2949 ;; Handle case where `buffer-or-name' is nil and the current buffer
2950 ;; is shown in the selected window.
2955 ;; Switch to another buffer in window.
2959 ;; Always return nil.
2960 nil))
2963 "Switch to the last buffer in the buffer list."
2968 "In selected window switch to next buffer."
2979 "In selected window switch to previous buffer."
2990 "Delete all windows showing BUFFER-OR-NAME.
2991 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2992 and defaults to the current buffer.
2994 The following non-nil values of the optional argument FRAME
2995 have special meanings:
2997 - t means consider all windows on the selected frame only.
2999 - `visible' means consider all windows on all visible frames on
3000 the current terminal.
3002 - 0 (the number zero) means consider all windows on all visible
3003 and iconified frames on the current terminal.
3005 - A frame means consider all windows on that frame only.
3007 Any other value of FRAME means consider all windows on all
3008 frames.
3010 When a window showing BUFFER-OR-NAME is dedicated and the only
3011 window of its frame, that frame is deleted when there are other
3012 frames left."
3015 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3016 ;; `window-list-1' based function.
3023 ;; Delete frame if and only if window is dedicated.
3026 ;; Delete window.
3029 ;; In window switch to previous buffer.
3032 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3036 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
3037 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3038 and defaults to the current buffer.
3040 When a window showing BUFFER-OR-NAME is dedicated, that window is
3041 deleted. If that window is the only window on its frame, the
3042 frame is deleted too when there are other frames left. If there
3043 are no other frames left, some other buffer is displayed in that
3044 window.
3046 This function removes the buffer denoted by BUFFER-OR-NAME from
3047 all window-local buffer lists."
3053 ;; Switch to another buffer in window.
3056 ;; Unrecord BUFFER in WINDOW.
3060 "Quit WINDOW and bury its buffer.
3061 WINDOW must be a live window and defaults to the selected one.
3062 With prefix argument KILL non-nil, kill the buffer instead of
3063 burying it.
3065 According to information stored in WINDOW's `quit-restore' window
3066 parameter either (1) delete WINDOW and its frame, (2) delete
3067 WINDOW, (3) restore the buffer previously displayed in WINDOW,
3068 or (4) make WINDOW display some other buffer than the present
3069 one. If non-nil, reset `quit-restore' parameter to nil."
3080 buffer))))
3081 prev-buffer)))
3082 quad resize)
3087 ;; Delete WINDOW if possible.
3089 ;; If the previously selected window is still alive, select it.
3095 ;; Show another buffer stored in quit-restore parameter.
3100 ;; Try to resize WINDOW to its old height but don't signal an
3101 ;; error.
3105 ;; Restore WINDOW's previous buffer, start and point position.
3108 ;; Unrecord WINDOW's buffer here (Bug#9937) to make sure it's not
3109 ;; re-recorded by `set-window-buffer'.
3111 ;; Reset the quit-restore parameter.
3113 ;; Select old window.
3117 ;; Show some other buffer in WINDOW and reset the quit-restore
3118 ;; parameter.
3120 ;; Make sure that WINDOW is no more dedicated.
3124 ;; Kill WINDOW's old-buffer if requested
3130 "Quit all windows showing BUFFER-OR-NAME.
3131 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
3132 and defaults to the current buffer. Optional argument KILL
3133 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
3134 BUFFER-OR-NAME. Optional argument FRAME is handled as by
3135 `delete-windows-on'.
3137 This function calls `quit-window' on all candidate windows
3138 showing BUFFER-OR-NAME."
3141 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3142 ;; `window-list-1' based function.
3147 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3149 \f
3150 ;;; Splitting windows.
3152 "Return minimum height of any window when splitting windows.
3153 Optional argument HORIZONTAL non-nil means return minimum width."
3159 "Make a new window adjacent to WINDOW.
3160 WINDOW must be a valid window and defaults to the selected one.
3161 Return the new window which is always a live window.
3163 Optional argument SIZE a positive number means make WINDOW SIZE
3164 lines or columns tall. If SIZE is negative, make the new window
3165 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3166 absolute value can be less than `window-min-height' or
3167 `window-min-width'; so this command can make a new window as
3168 small as one line or two columns. SIZE defaults to half of
3169 WINDOW's size. Interactively, SIZE is the prefix argument.
3171 Optional third argument SIDE nil (or `below') specifies that the
3172 new window shall be located below WINDOW. SIDE `above' means the
3173 new window shall be located above WINDOW. In both cases SIZE
3174 specifies the new number of lines for WINDOW (or the new window
3175 if SIZE is negative) including space reserved for the mode and/or
3176 header line.
3178 SIDE t (or `right') specifies that the new window shall be
3179 located on the right side of WINDOW. SIDE `left' means the new
3180 window shall be located on the left of WINDOW. In both cases
3181 SIZE specifies the new number of columns for WINDOW (or the new
3182 window provided SIZE is negative) including space reserved for
3183 fringes and the scrollbar or a divider column. Any other non-nil
3184 value for SIDE is currently handled like t (or `right').
3186 If the variable `ignore-window-parameters' is non-nil or the
3187 `split-window' parameter of WINDOW equals t, do not process any
3188 parameters of WINDOW. Otherwise, if the `split-window' parameter
3189 of WINDOW specifies a function, call that function with all three
3190 arguments and return the value returned by that function.
3193 root of that atomic window. The new window does not become a
3194 member of that atomic window.
3196 If WINDOW is live, properties of the new window like margins and
3197 scrollbars are inherited from WINDOW. If WINDOW is an internal
3198 window, these properties as well as the buffer displayed in the
3199 new window are inherited from the window selected on WINDOW's
3200 frame. The selected window is not changed by this function."
3212 ;; Rebind `window-combination-limit' since in some cases we may
3213 ;; have to override its value.
3215 atom-root)
3220 ;; Ignore window parameters if either `ignore-window-parameters'
3221 ;; is t or the `split-window' parameter equals t.
3224 ;; The `split-window' parameter specifies the function to call.
3225 ;; If that function is `ignore', do nothing.
3227 ;; If WINDOW is part of an atomic window, split the root window
3228 ;; of that atomic window instead.
3237 ;; WINDOW is a side root window. To make sure that a new parent
3238 ;; window gets created set `window-combination-limit' to t.
3242 ;; If `window-combination-resize' is non-nil and SIZE is a
3243 ;; non-negative integer, we cannot reasonably resize other
3244 ;; windows. Rather bind `window-combination-limit' to t to make
3245 ;; sure that subsequent window deletions are handled correctly.
3249 ;; `parent-size' is the size of WINDOW's parent, provided
3250 ;; it has one.
3252 ;; `resize' non-nil means we are supposed to resize other
3253 ;; windows in WINDOW's combination.
3256 ;; Resize makes sense in iso-combinations only.
3258 ;; `old-size' is the current size of WINDOW.
3260 ;; `new-size' is the specified or calculated size of the
3261 ;; new window.
3267 ;; When resizing try to give the new window the
3268 ;; average size of a window in its combination.
3271 (/ parent-size
3273 parent horizontal))))
3274 ;; Else try to give the new window half the size
3275 ;; of WINDOW (plus an eventual odd line).
3278 ;; SIZE non-negative specifies the new size of WINDOW.
3280 ;; Note: Specifying a non-negative SIZE is practically
3281 ;; always done as workaround for making the new window
3282 ;; appear above or on the left of the new window (the
3283 ;; ispell window is a typical example of that). In all
3284 ;; these cases the SIDE argument should be set to 'above
3285 ;; or 'left in order to support the 'resize option.
3286 ;; Here we have to nest the windows instead, see above.
3289 ;; SIZE negative specifies the size of the new window.
3291 new-parent new-normal)
3293 ;; Check SIZE.
3298 ;; SIZE unspecified, resizing.
3300 ;; Try again with minimum split size.
3306 ;; SIZE unspecified, no resizing.
3311 window-safe-min-width
3312 window-safe-min-width))))
3313 ;; SIZE specified as new size of old window. If the new size
3314 ;; is larger than the old size or the size of the new window
3315 ;; would be less than the safe minimum, signal an error.
3318 ;; SIZE specified, resizing.
3320 ;; If we cannot resize the parent give up.
3326 ;; SIZE specification violates minimum size restrictions.
3332 ;; Make new-parent non-nil if we need a new parent window;
3333 ;; either because we want to nest or because WINDOW is not
3334 ;; iso-combined.
3338 ;; Make new-normal the normal size of the new window.
3346 ;; Try to get space from OLD's siblings. We could go "up" and
3347 ;; try getting additional space from surrounding windows but
3348 ;; we won't be able to return space to those windows when we
3349 ;; delete the one we create here. Hence we do not go up.
3358 ;; Get entire space from WINDOW.
3363 new-normal)))
3366 ;; Inherit window-side parameters, if any.
3373 ;; Always return the new window.
3374 new)))))
3376 ;; I think this should be the default; I think people will prefer it--rms.
3379 If nil, adjust point in the two windows to minimize redisplay.
3380 This option applies only to `split-window-below' and functions
3381 that call it. The low-level `split-window' function always keeps
3382 the original point in both windows."
3387 "Split the selected window into two windows, one above the other.
3388 The selected window is above. The newly split-off window is
3389 below, and displays the same buffer. Return the new window.
3391 If optional argument SIZE is omitted or nil, both windows get the
3392 same height, or close to it. If SIZE is positive, the upper
3393 \(selected) window gets SIZE lines. If SIZE is negative, the
3394 lower (new) window gets -SIZE lines.
3396 If the variable `split-window-keep-point' is non-nil, both
3397 windows get the same value of point as the selected window.
3398 Otherwise, the window starts are chosen so as to minimize the
3399 amount of redisplay; this is convenient on slow terminals."
3404 moved-by-window-height moved new-window bottom)
3406 ;; `split-window' would not signal an error here.
3411 ;; Use `save-excursion' around vertical movements below
3412 ;; (Bug#10971). Note: When the selected window's buffer has a
3413 ;; header line, up to two lines of the buffer may not show up
3414 ;; in the resulting configuration.
3432 ;; Always copy quit-restore parameter in interactive use.
3436 new-window))
3441 "Split the selected window into two side-by-side windows.
3442 The selected window is on the left. The newly split-off window
3443 is on the right, and displays the same buffer. Return the new
3444 window.
3446 If optional argument SIZE is omitted or nil, both windows get the
3447 same width, or close to it. If SIZE is positive, the left-hand
3448 \(selected) window gets SIZE columns. If SIZE is negative, the
3449 right-hand (new) window gets -SIZE columns. Here, SIZE includes
3450 the width of the window's scroll bar; if there are no scroll
3451 bars, it includes the width of the divider column to the window's
3452 right, if any."
3456 new-window)
3458 ;; `split-window' would not signal an error here.
3461 ;; Always copy quit-restore parameter in interactive use.
3465 new-window))
3468 \f
3469 ;;; Balancing windows.
3471 ;; The following routine uses the recycled code from an old version of
3472 ;; `window--resize-child-windows'. It's not very pretty, but coding it the way the
3473 ;; new `window--resize-child-windows' code does would hardly make it any shorter or
3474 ;; more readable (FWIW we'd need three loops - one to calculate the
3475 ;; minimum sizes per window, one to enlarge or shrink windows until the
3476 ;; new parent-size matches, and one where we shrink the largest/enlarge
3477 ;; the smallest window).
3479 "Subroutine of `balance-windows-1'.
3480 WINDOW must be a vertical combination (horizontal if HORIZONTAL
3481 is non-nil)."
3487 failed size sub-total sub-delta sub-amount rest)
3502 ;; Ignore child windows that should be ignored or are stuck.
3508 ;; Register the new total size for this child window.
3513 ;; We failed and need a new round.
3519 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3520 ;; (column) until `rest' is zero.
3528 ;; Fix rounding by trying to enlarge stuck windows by one line
3529 ;; (column) until `rest' equals zero.
3539 ;; Record new normal sizes.
3545 ;; Recursively balance each window's child windows.
3550 "Subroutine of `balance-windows'."
3562 "Balance the sizes of windows of WINDOW-OR-FRAME.
3563 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3564 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3565 windows of that frame. If WINDOW-OR-FRAME denotes a window,
3566 recursively balance the sizes of all child windows of that
3567 window."
3576 window-or-frame)
3580 ;; Balance vertically.
3584 ;; Balance horizontally.
3590 "Return t if WINDOW cannot be resized in DIRECTION.
3591 WINDOW defaults to the selected window. DIRECTION can be
3592 nil (i.e. any), `height' or `width'."
3599 ;;; A different solution to balance-windows.
3601 "Factor by which the window area should be over-estimated.
3602 This is used by `balance-windows-area'.
3607 "Wrapper around `window-resize' with error checking.
3608 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3609 ;; `window-resize' may fail if delta is too large.
3616 ;;(message "adjust: %s" (error-message-string err))
3620 "Make all visible windows the same area (approximately).
3621 See also `window-area-factor' to change the relative size of
3622 specific buffers."
3625 ;; Remove fixed-size windows.
3630 next)
3631 ;; Resizing a window changes the size of surrounding windows in complex
3632 ;; ways, so it's difficult to balance them all. The introduction of
3633 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3634 ;; very difficult to do. `balance-window' above takes an off-line
3635 ;; approach: get the whole window tree, then balance it, then try to
3636 ;; adjust the windows so they fit the result.
3637 ;; Here, instead, we take a "local optimization" approach, where we just
3638 ;; go through all the windows several times until nothing needs to be
3639 ;; changed. The main problem with this approach is that it's difficult
3640 ;; to make sure it terminates, so we use some heuristic to try and break
3641 ;; off infinite loops.
3642 ;; After a round without any change, we allow a second, to give a chance
3643 ;; to the carry to propagate a minor imbalance from the end back to
3644 ;; the beginning.
3646 ;; (message "New round")
3652 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3670 ;; Maybe diff is actually closer to 1 than to 0.
3674 ;; Change things smoothly.
3677 ;; Make sure negligible differences don't accumulate to
3678 ;; become significant.
3680 ;; This used `adjust-window-trailing-edge' before and uses
3681 ;; `window-resize' now. Error wrapping is still needed.
3683 ;; (sit-for 0.5)
3685 ;; If the same change has been seen already for this window,
3686 ;; we're most likely in an endless loop, so don't count it as
3687 ;; a change.
3691 ;; We've now basically balanced all the windows.
3692 ;; But there may be some minor off-by-one imbalance left over,
3693 ;; so let's do some fine tuning.
3694 ;; (bw-finetune wins)
3695 ;; (message "Done in %d rounds" round)
3696 ))
3698 ;;; Window states, how to get them and how to put them in a window.
3700 "Helper function for `window-state-get'."
3709 `(,type
3717 list)
3718 ;; Make copies of those window parameters whose
3719 ;; persistence property is `writable' if WRITABLE is
3720 ;; non-nil and non-nil if WRITABLE is nil.
3723 window-persistent-parameters))))
3726 ;; Add `clone-of' parameter if necessary.
3728 window-persistent-parameters))))
3735 ;; All buffer related things go in here.
3750 'window-point-insertion-type
3751 buffer))))
3764 "Return state of WINDOW as a Lisp object.
3765 WINDOW can be any window and defaults to the root window of the
3766 selected frame.
3768 Optional argument WRITABLE non-nil means do not use markers for
3769 sampling `window-point' and `window-start'. Together, WRITABLE
3770 and the variable `window-persistent-parameters' specify which
3771 window parameters are saved by this function. WRITABLE should be
3772 non-nil when the return value shall be written to a file and read
3773 back in another session. Otherwise, an application may run into
3774 an `invalid-read-syntax' error while attempting to read back the
3775 value from file.
3777 The return value can be used as argument for `window-state-put'
3778 to put the state recorded here into an arbitrary window. The
3779 value can be also stored on disk and read back in a new session."
3783 window
3786 ;; The return value is a cons whose car specifies some constraints on
3787 ;; the size of WINDOW. The cdr lists the states of the child windows
3788 ;; of WINDOW.
3790 ;; Frame related things would go into a function, say `frame-state',
3791 ;; calling `window-state-get' to insert the frame's root window.
3804 "Helper function for `window-state-put'."
3809 ;; For a leaf window just add unprocessed entries to
3810 ;; `window-state-put-list'.
3816 size new)
3818 ;; Find the next child window. WINDOW always points to the
3819 ;; real window that we want to fill with what we find here.
3822 ;; The last child window. Below `window--state-put-1'
3823 ;; will put into it whatever ITEM has in store.
3825 ;; Not the last child window, prepare for splitting
3826 ;; WINDOW. SIZE is the new (and final) size of the old
3827 ;; window.
3830 ;; Use total size.
3832 ;; Use normalized size and round.
3836 item))))))
3838 ;; Use safe sizes, we try to resize later.
3840 window-safe-min-height
3841 window-safe-min-width)))
3846 ;; We must inherit the combination limit, otherwise
3847 ;; we might mess up handling of atomic and side
3848 ;; window.
3850 ;; Give up if we can't resize window down to safe sizes.
3855 ;; When creating the first child window add for parent
3856 ;; unprocessed entries to `window-state-put-list'.
3859 window-state-put-list))))
3861 ;; Now process the current window (either the one we've just
3862 ;; split or the last child of its parent).
3864 ;; Continue with the last window split off.
3868 "Helper function for `window-state-put'."
3876 ;; Reset window's parameters and assign saved ones (we might want
3877 ;; a `remove-window-parameters' function here).
3883 ;; Process buffer related state.
3885 ;; We don't want to raise an error here so we create a buffer if
3886 ;; there's none.
3898 ;; Adjust vertically.
3900 ;; A fixed height window, try to restore the original size.
3903 window-size-fixed)
3906 ;; Else check whether the window is not high enough.
3912 ;; Adjust horizontally.
3914 ;; A fixed width window, try to restore the original size.
3917 window-size-fixed)
3920 ;; Else check whether the window is not wide enough.
3926 ;; Set dedicated status.
3928 ;; Install positions (maybe we should do this after all windows
3929 ;; have been created and sized).
3933 ;; Select window if it's the selected one.
3938 "Put window state STATE into WINDOW.
3939 STATE should be the state of a window returned by an earlier
3940 invocation of `window-state-get'. Optional argument WINDOW must
3941 specify a live window and defaults to the selected one.
3943 Optional argument IGNORE non-nil means ignore minimum window
3944 sizes and fixed size restrictions. IGNORE equal `safe' means
3945 windows can get as small as `window-safe-min-height' and
3946 `window-safe-min-width'."
3950 ;; We check here (1) whether the total sizes of root window of
3951 ;; STATE and that of WINDOW are equal so we can avoid
3952 ;; calculating new sizes, and (2) if we do have to resize
3953 ;; whether we can do so without violating size restrictions.
3978 (> min-width
3980 ;; The check above might not catch all errors due to rounding
3981 ;; issues - so IGNORE equal 'safe might not always produce the
3982 ;; minimum possible state. But such configurations hardly make
3983 ;; sense anyway.
3987 ;; Work on the windows of a temporary buffer to make sure that
3988 ;; splitting proceeds regardless of any buffer local values of
3989 ;; `window-size-fixed'. Release that buffer after the buffers of
3990 ;; all live windows have been set by `window--state-put-2'.
3996 \f
3998 "Record information for window used by `display-buffer'.
3999 TYPE specifies the type of the calling operation and must be one
4000 of the symbols 'reuse (when WINDOW existed already and was
4001 reused for displaying BUFFER), 'window (when WINDOW was created
4002 on an already existing frame), or 'frame (when WINDOW was
4003 created on a new frame). WINDOW is the window used for or created
4004 by the `display-buffer' routines. BUFFER is the buffer that
4005 shall be displayed.
4007 This function installs or updates the quit-restore parameter of
4008 WINDOW. The quit-restore parameter is a list of four elements:
4009 The first element is one of the symbols 'window, 'frame, 'same or
4010 'other. The second element is either one of the symbols 'window
4011 or 'frame or a list whose elements are the buffer previously
4012 shown in the window, that buffer's window start and window point,
4013 and the window's height. The third element is the window
4014 selected at the time the parameter was created. The fourth
4015 element is BUFFER."
4019 ;; WINDOW shows BUFFER already.
4021 ;; If WINDOW has a quit-restore parameter, reset its car.
4023 ;; WINDOW shows another buffer.
4025 window 'quit-restore
4027 ;; A quadruple of WINDOW's buffer, start, point and height.
4032 ;; WINDOW has been created on an existing frame.
4034 window 'quit-restore
4037 ;; WINDOW has been created on a new frame.
4039 window 'quit-restore
4043 "If non-nil, function to call to handle `display-buffer'.
4044 It will receive two args, the buffer and a flag which if non-nil
4045 means that the currently selected window is not acceptable. It
4046 should choose or create a window, display the specified buffer in
4047 it, and return the window.
4049 The specified function should call `display-buffer-record-window'
4050 with corresponding arguments to set up the quit-restore parameter
4051 of the window used."
4058 "Alist of parameters for automatically generated new frames.
4059 You can set this in your init file; for example,
4061 (setq pop-up-frame-alist '((width . 80) (height . 20)))
4063 If non-nil, the value you specify here is used by the default
4064 `pop-up-frame-function' for the creation of new frames.
4066 Since `pop-up-frame-function' is used by `display-buffer' for
4067 making new frames, any value specified here by default affects
4068 the automatic generation of new frames via `display-buffer' and
4069 all functions based on it. The behavior of `make-frame' is not
4070 affected by this variable."
4078 "Function used by `display-buffer' for creating a new frame.
4079 This function is called with no arguments and should return a new
4080 frame. The default value calls `make-frame' with the argument
4081 `pop-up-frame-alist'."
4086 "List of names of buffers that should be displayed specially.
4087 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4088 its name is in this list, displays the buffer in a way specified
4089 by `special-display-function'. `special-display-popup-frame'
4090 \(the default for `special-display-function') usually displays
4091 the buffer in a separate frame made with the parameters specified
4092 by `special-display-frame-alist'. If `special-display-function'
4093 has been set to some other function, that function is called with
4094 the buffer as first, and nil as second argument.
4096 Alternatively, an element of this list can be specified as
4097 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
4098 name and FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4099 `special-display-popup-frame' will interpret such pairs as frame
4100 parameters when it creates a special frame, overriding the
4101 corresponding values from `special-display-frame-alist'.
4103 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4104 `special-display-popup-frame' displays that buffer in the
4105 selected window. If FRAME-PARAMETERS contains (same-frame . t),
4106 it displays that buffer in a window on the selected frame.
4108 If `special-display-function' specifies some other function than
4109 `special-display-popup-frame', that function is called with the
4110 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
4111 argument.
4113 Finally, an element of this list can be also specified as
4114 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
4115 `special-display-popup-frame' will call FUNCTION with the buffer
4116 named BUFFER-NAME as first argument, and OTHER-ARGS as the
4117 second.
4119 Any alternative function specified here is responsible for
4120 setting up the quit-restore parameter of the window used.
4123 name to it but the corresponding buffer is displayed in the
4124 selected window, look at the values of `same-window-buffer-names'
4125 and `same-window-regexps'. Those variables take precedence over
4126 this one.
4128 See also `special-display-regexps'."
4150 ;;;###autoload
4154 "List of regexps saying which buffers should be displayed specially.
4155 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4156 any regexp in this list matches its name, displays it specially
4157 using `special-display-function'. `special-display-popup-frame'
4158 \(the default for `special-display-function') usually displays
4159 the buffer in a separate frame made with the parameters specified
4160 by `special-display-frame-alist'. If `special-display-function'
4161 has been set to some other function, that function is called with
4162 the buffer as first, and nil as second argument.
4164 Alternatively, an element of this list can be specified as
4165 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4166 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4167 `special-display-popup-frame' will then interpret these pairs as
4168 frame parameters when creating a special frame for a buffer whose
4169 name matches REGEXP, overriding the corresponding values from
4170 `special-display-frame-alist'.
4172 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4173 `special-display-popup-frame' displays buffers matching REGEXP in
4174 the selected window. (same-frame . t) in FRAME-PARAMETERS means
4175 to display such buffers in a window on the selected frame.
4177 If `special-display-function' specifies some other function than
4178 `special-display-popup-frame', that function is called with the
4179 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4180 as second argument.
4182 Finally, an element of this list can be also specified as
4183 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4184 will then call FUNCTION with the buffer whose name matched
4185 REGEXP as first, and OTHER-ARGS as second argument.
4187 Any alternative function specified here is responsible for
4188 setting up the quit-restore parameter of the window used.
4191 name to it but the corresponding buffer is displayed in the
4192 selected window, look at the values of `same-window-buffer-names'
4193 and `same-window-regexps'. Those variables take precedence over
4194 this one.
4196 See also `special-display-buffer-names'."
4219 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4220 More precisely, return t if `special-display-buffer-names' or
4221 `special-display-regexps' contain a string entry equaling or
4222 matching BUFFER-NAME. If `special-display-buffer-names' or
4223 `special-display-regexps' contain a list entry whose car equals
4224 or matches BUFFER-NAME, the return value is the cdr of that
4225 entry."
4229 t)
4244 "Alist of parameters for special frames.
4245 Special frames are used for buffers whose names are listed in
4246 `special-display-buffer-names' and for buffers whose names match
4247 one of the regular expressions in `special-display-regexps'.
4249 This variable can be set in your init file, like this:
4251 (setq special-display-frame-alist '((width . 80) (height . 20)))
4253 These supersede the values given in `default-frame-alist'."
4260 "Pop up a frame displaying BUFFER and return its window.
4261 If BUFFER is already displayed in a visible or iconified frame,
4262 raise that frame. Otherwise, display BUFFER in a new frame.
4264 Optional argument ARGS is a list specifying additional
4265 information.
4267 If ARGS is an alist, use it as a list of frame parameters. If
4268 these parameters contain (same-window . t), display BUFFER in
4269 the selected window. If they contain (same-frame . t), display
4270 BUFFER in a window of the selected frame.
4272 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4273 function to do the work. Pass it BUFFER as first argument,
4274 and (cdr ARGS) as second."
4279 ;; If we have a window already, make it visible.
4285 window))
4286 ;; Reuse the current window if the user requested it.
4291 ;; Stay on the same frame if requested.
4294 pop-up-frames
4295 special-display-buffer-names special-display-regexps)
4297 ;; If no window yet, make one in a new frame.
4304 window)))))
4307 "Function to call for displaying special buffers.
4308 This function is called with two arguments - the buffer and,
4309 optionally, a list - and should return a window displaying that
4310 buffer. The default value usually makes a separate frame for the
4311 buffer using `special-display-frame-alist' to specify the frame
4312 parameters. See the definition of `special-display-popup-frame'
4313 for how to specify such a function.
4315 A buffer is special when its name is either listed in
4316 `special-display-buffer-names' or matches a regexp in
4317 `special-display-regexps'.
4319 The specified function should call `display-buffer-record-window'
4320 with corresponding arguments to set up the quit-restore parameter
4321 of the window used."
4327 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4328 on this list in the selected rather than some other window.
4330 An element of this list can be a cons cell instead of just a
4331 string. In that case, the cell's car must be a string specifying
4332 the buffer name. This is for compatibility with
4333 `special-display-buffer-names'; the cdr of the cons cell is
4334 ignored.
4336 See also `same-window-regexps'."
4342 `display-buffer' and `pop-to-buffer' show a buffer whose name
4343 matches a regexp on this list in the selected rather than some
4344 other window.
4346 An element of this list can be a cons cell instead of just a
4347 string. In that case, the cell's car must be a regexp matching
4348 the buffer name. This is for compatibility with
4349 `special-display-regexps'; the cdr of the cons cell is ignored.
4351 See also `same-window-buffer-names'."
4357 This function returns non-nil if `display-buffer' or
4358 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4359 selected rather than (as usual) some other window. See
4360 `same-window-buffer-names' and `same-window-regexps'."
4363 ;; The elements of `same-window-buffer-names' can be buffer
4364 ;; names or cons cells whose cars are buffer names.
4369 ;; The elements of `same-window-regexps' can be regexps
4370 ;; or cons cells whose cars are regexps.
4378 "Whether `display-buffer' should make a separate frame.
4379 If nil, never make a separate frame.
4380 If the value is `graphic-only', make a separate frame
4381 on graphic displays only.
4382 Any other non-nil value means always make a separate frame."
4390 "Non-nil means `display-buffer' should reuse frames.
4391 If the buffer in question is already displayed in a frame, raise
4392 that frame."
4398 "Non-nil means `display-buffer' should make a new window."
4403 "Function called by `display-buffer' routines to split a window.
4404 This function is called with a window as single argument and is
4405 supposed to split that window and return the new window. If the
4406 window can (or shall) not be split, it is supposed to return nil.
4407 The default is to call the function `split-window-sensibly' which
4408 tries to split the window in a way which seems most suitable.
4409 You can customize the options `split-height-threshold' and/or
4410 `split-width-threshold' in order to have `split-window-sensibly'
4411 prefer either vertical or horizontal splitting.
4413 If you set this to any other function, bear in mind that the
4414 `display-buffer' routines may call this function two times. The
4415 argument of the first call is the largest window on its frame.
4416 If that call fails to return a live window, the function is
4417 called again with the least recently used window as argument. If
4418 that call fails too, `display-buffer' will use an existing window
4419 to display its buffer.
4421 The window selected at the time `display-buffer' was invoked is
4422 still selected when this function is called. Hence you can
4423 compare the window argument with the value of `selected-window'
4424 if you intend to split the selected window instead or if you do
4425 not want to split the selected window."
4431 "Minimum height for splitting windows sensibly.
4432 If this is an integer, `split-window-sensibly' may split a window
4433 vertically only if it has at least this many lines. If this is
4434 nil, `split-window-sensibly' is not allowed to split a window
4435 vertically. If, however, a window is the only window on its
4436 frame, `split-window-sensibly' may split it vertically
4437 disregarding the value of this variable."
4443 "Minimum width for splitting windows sensibly.
4444 If this is an integer, `split-window-sensibly' may split a window
4445 horizontally only if it has at least this many columns. If this
4446 is nil, `split-window-sensibly' is not allowed to split a window
4447 horizontally."
4453 "Return non-nil if `split-window-sensibly' may split WINDOW.
4454 Optional argument HORIZONTAL nil or omitted means check whether
4455 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4456 non-nil means check whether WINDOW may be split horizontally.
4458 WINDOW may be split vertically when the following conditions
4459 hold:
4460 - `window-size-fixed' is either nil or equals `width' for the
4461 buffer of WINDOW.
4462 - `split-height-threshold' is an integer and WINDOW is at least as
4463 high as `split-height-threshold'.
4464 - When WINDOW is split evenly, the emanating windows are at least
4465 `window-min-height' lines tall and can accommodate at least one
4466 line plus - if WINDOW has one - a mode line.
4468 WINDOW may be split horizontally when the following conditions
4469 hold:
4470 - `window-size-fixed' is either nil or equals `height' for the
4471 buffer of WINDOW.
4472 - `split-width-threshold' is an integer and WINDOW is at least as
4473 wide as `split-width-threshold'.
4474 - When WINDOW is split evenly, the emanating windows are at least
4475 `window-min-width' or two (whichever is larger) columns wide."
4479 ;; A window can be split horizontally when its width is not
4480 ;; fixed, it is at least `split-width-threshold' columns wide
4481 ;; and at least twice as wide as `window-min-width' and 2 (the
4482 ;; latter value is hardcoded).
4484 ;; Testing `window-full-width-p' here hardly makes any
4485 ;; sense nowadays. This can be done more intuitively by
4486 ;; setting up `split-width-threshold' appropriately.
4491 ;; A window can be split vertically when its height is not
4492 ;; fixed, it is at least `split-height-threshold' lines high,
4493 ;; and it is at least twice as high as `window-min-height' and 2
4494 ;; if it has a mode line or 1.
4503 "Split WINDOW in a way suitable for `display-buffer'.
4504 WINDOW defaults to the currently selected window.
4505 If `split-height-threshold' specifies an integer, WINDOW is at
4506 least `split-height-threshold' lines tall and can be split
4507 vertically, split WINDOW into two windows one above the other and
4508 return the lower window. Otherwise, if `split-width-threshold'
4509 specifies an integer, WINDOW is at least `split-width-threshold'
4510 columns wide and can be split horizontally, split WINDOW into two
4511 windows side by side and return the window on the right. If this
4512 can't be done either and WINDOW is the only window on its frame,
4513 try to split WINDOW vertically disregarding any value specified
4514 by `split-height-threshold'. If that succeeds, return the lower
4515 window. Return nil otherwise.
4517 By default `display-buffer' routines call this function to split
4518 the largest or least recently used window. To change the default
4519 customize the option `split-window-preferred-function'.
4521 You can enforce this function to not split WINDOW horizontally,
4522 by setting (or binding) the variable `split-width-threshold' to
4523 nil. If, in addition, you set `split-height-threshold' to zero,
4524 chances increase that this function does split WINDOW vertically.
4526 In order to not split WINDOW vertically, set (or bind) the
4527 variable `split-height-threshold' to nil. Additionally, you can
4528 set `split-width-threshold' to zero to make a horizontal split
4529 more likely to occur.
4531 Have a look at the function `window-splittable-p' if you want to
4532 know how `split-window-sensibly' determines whether WINDOW can be
4533 split."
4536 ;; Split window vertically.
4540 ;; Split window horizontally.
4545 ;; If WINDOW is the only window on its frame and is not the
4546 ;; minibuffer window, try to split it vertically disregarding
4547 ;; the value of `split-height-threshold'.
4554 "Try to split WINDOW.
4555 Return value returned by `split-window-preferred-function' if it
4556 represents a live window, nil otherwise."
4560 ;; Since `split-window-preferred-function' might
4561 ;; throw an error use `condition-case'.
4568 "Return FRAME if it can be used to display a buffer."
4571 ;; `frame-root-window' may be an internal window which is considered
4572 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4573 ;; implicitly know that `frame' has a visible window we can use.
4576 ;; If the window is soft-dedicated, the frame is usable.
4577 ;; Actually, even if the window is really dedicated,
4578 ;; the frame is still usable by splitting it.
4579 ;; At least Emacs-22 allowed it, and it is desirable
4580 ;; when displaying same-frame windows.
4581 nil ; (eq t (window-dedicated-p window))
4582 ))
4583 frame))))
4586 "If non-nil `display-buffer' will try to even window heights.
4587 Otherwise `display-buffer' will leave the window configuration
4588 alone. Heights are evened only when `display-buffer' chooses a
4589 window that appears above or below the selected window."
4594 "Even heights of WINDOW and selected window.
4595 Do this only if these windows are vertically adjacent to each
4596 other, `even-window-heights' is non-nil, and the selected window
4597 is higher than WINDOW."
4600 ;; Don't resize minibuffer windows.
4611 ;; Don't throw an error if we can't even window heights for
4612 ;; whatever reason.
4618 "Display BUFFER in WINDOW and make its frame visible.
4619 TYPE must be one of the symbols `reuse', `window' or `frame' and
4620 is passed unaltered to `display-buffer-record-window'. Set
4621 `window-dedicated-p' to DEDICATED if non-nil. Return WINDOW if
4622 BUFFER and WINDOW are live."
4632 window))
4637 ;; Assume the selected frame is already visible enough.
4639 ;; Assume the frame from which we invoked the
4640 ;; minibuffer is visible.
4645 ;; FIXME: Not implemented.
4646 ;; FIXME: By the way, there could be more levels of dedication:
4647 ;; - `barely' dedicated doesn't prevent reuse of the window, only records that
4648 ;; the window hasn't been used for something else yet.
4649 ;; - `softly' dedicated only allows reuse when asked explicitly.
4650 ;; - `strongly' never allows reuse.
4652 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4653 The actual non-nil value of this variable will be copied to the
4670 ,display-buffer--action-function-custom-type
4675 :key-type symbol
4680 "Overriding action to perform to display a buffer.
4681 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4682 function or a list of functions. Each function should accept two
4683 arguments: a buffer to display and an alist similar to ALIST.
4688 "Alist of conditional actions for `display-buffer'.
4689 This is a list of elements (CONDITION . ACTION), where:
4691 CONDITION is either a regexp matching buffer names, or a function
4692 that takes a buffer and returns a boolean.
4694 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4695 function or a list of functions. Each such function should
4696 accept two arguments: a buffer to display and an alist of the
4697 same form as ALIST. See `display-buffer' for details."
4700 regexp
4703 :risky t
4708 "User-specified default action for `display-buffer'.
4709 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4710 function or a list of functions. Each function should accept two
4711 arguments: a buffer to display and an alist similar to ALIST.
4712 See `display-buffer' for details."
4713 :type display-buffer--action-custom-type
4714 :risky t
4720 display-buffer-reuse-window
4721 display-buffer--maybe-pop-up-frame-or-window
4722 display-buffer-use-some-window
4723 ;; If all else fails, pop up a new frame.
4724 display-buffer-pop-up-frame))
4725 "Default fallback action for `display-buffer'.
4726 This is the action used by `display-buffer' if no other actions
4727 specified, e.g. by the user options `display-buffer-alist' or
4732 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4750 display-buffer-pop-up-frame)
4757 "Display BUFFER-OR-NAME in some window, without selecting it.
4758 BUFFER-OR-NAME must be a buffer or the name of an existing
4759 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4760 or nil if no such window is found.
4762 Optional argument ACTION should have the form (FUNCTION . ALIST).
4763 FUNCTION is either a function or a list of functions.
4764 ALIST is an arbitrary association list (alist).
4766 Each such FUNCTION should accept two arguments: the buffer to
4767 display and an alist. Based on those arguments, it should either
4768 display the buffer and return the window, or return nil if unable
4769 to display the buffer.
4771 The `display-buffer' function builds a function list and an alist
4772 by combining the functions and alists specified in
4773 `display-buffer-overriding-action', `display-buffer-alist', the
4774 ACTION argument, `display-buffer-base-action', and
4775 `display-buffer-fallback-action' (in order). Then it calls each
4776 function in the combined function list in turn, passing the
4777 buffer as the first argument and the combined alist as the second
4778 argument, until one of the functions returns non-nil.
4780 Available action functions include:
4781 `display-buffer-same-window'
4782 `display-buffer-reuse-window'
4783 `display-buffer-pop-up-frame'
4784 `display-buffer-pop-up-window'
4785 `display-buffer-use-some-window'
4787 Recognized alist entries include:
4789 `inhibit-same-window' -- A non-nil value prevents the same
4790 window from being used for display.
4792 `inhibit-switch-frame' -- A non-nil value prevents any other
4793 frame from being raised or selected,
4794 even if the window is displayed there.
4796 `reusable-frames' -- Value specifies frame(s) to search for a
4797 window that already displays the buffer.
4798 See `display-buffer-reuse-window'.
4800 The ACTION argument to `display-buffer' can also have a non-nil
4801 and non-list value. This means to display the buffer in a window
4802 other than the selected one, even if it is already displayed in
4803 the selected window. If called interactively with a prefix
4804 argument, ACTION is t.
4806 Optional argument FRAME, if non-nil, acts like an additional
4807 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4808 search for a window that is already displaying the buffer. See
4809 `display-buffer-reuse-window'."
4813 buffer-or-name
4815 ;; Handle the old form of the first argument.
4819 ;; If `display-buffer-function' is defined, let it do the job.
4821 ;; Otherwise, use the defined actions.
4824 display-buffer-alist))
4826 ;; Extra actions from the arguments to this function:
4832 ;; Construct action function list and action alist.
4834 user-action special-action action extra-action
4835 display-buffer-base-action
4836 display-buffer-fallback-action))
4841 actions)))
4843 window)
4849 window))))
4852 "Display buffer BUFFER in another frame.
4853 This uses the function `display-buffer' as a subroutine; see
4854 its documentation for additional customization information."
4858 ;;; `display-buffer' action functions:
4861 "Display BUFFER in the selected window.
4862 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4863 if the selected window is a minibuffer window or is dedicated to
4864 another buffer; in that case, return nil. Otherwise, return the
4865 selected window."
4872 "Conditionally display BUFFER in the selected window.
4873 If `same-window-p' returns non-nil for BUFFER's name, call
4874 `display-buffer-same-window' and return its value. Otherwise,
4875 return nil."
4880 "Return a window that is already displaying BUFFER.
4881 Return nil if no usable window is found.
4883 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4884 window is not eligible for reuse.
4886 If ALIST contains a `reusable-frames' entry, its value determines
4887 which frames to search for a reusable window:
4888 nil -- the selected frame (actually the last non-minibuffer frame)
4889 A frame -- just that frame
4890 `visible' -- all visible frames
4891 0 -- all frames on the current terminal
4892 t -- all frames.
4894 If ALIST contains no `reusable-frames' entry, search just the
4895 selected frame if `display-buffer-reuse-frames' and
4896 `pop-up-frames' are both nil; search all frames on the current
4897 terminal if either of those variables is non-nil.
4899 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4900 event that a window on another frame is chosen, avoid raising
4901 that frame."
4906 pop-up-frames)
4915 frames))))))
4922 "Return special display action for BUFFER, if any.
4923 If `special-display-p' returns non-nil for BUFFER, return an
4924 appropriate display action involving `special-display-function'.
4925 See `display-buffer' for the format of display actions."
4927 ;; `special-display-p' returns either t or a list of frame
4928 ;; parameters to pass to `special-display-function'.
4937 "Display BUFFER in a new frame.
4938 This works by calling `pop-up-frame-function'. If successful,
4939 return the window used; otherwise return nil.
4941 If ALIST has a non-nil `inhibit-switch-frame' entry, avoid
4942 raising the new frame."
4944 frame window)
4954 "Display BUFFER by popping up a new window.
4955 The new window is created on the selected frame, or in
4956 `last-nonminibuffer-frame' if no windows can be created there.
4957 If successful, return the new window; otherwise return nil.
4959 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
4960 event that the new window is created on another frame, avoid
4961 raising the frame."
4964 window)
4966 ;; If the selected frame cannot be split, look at
4967 ;; `last-nonminibuffer-frame'.
4972 ;; Attempt to split largest or least recently used window.
4983 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4985 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4986 text-only terminal), try with `display-buffer-pop-up-frame'.
4988 If that cannot be done, and `pop-up-windows' is non-nil, try
4989 again with `display-buffer-pop-up-window'."
4992 pop-up-frames)
4998 "Display BUFFER in an existing window.
4999 Search for a usable window, set that window to the buffer, and
5000 return the window. If no suitable window is found, return nil.
5002 If ALIST has a non-nil `inhibit-switch-frame' entry, then in the
5003 event that a window in another frame is chosen, avoid raising
5004 that frame."
5009 ;; Reuse an existing window.
5014 window))
5019 window))
5027 ;;; Display + selection commands:
5029 "Select buffer BUFFER in some window, preferably a different one.
5030 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5031 is a string not naming an existent buffer, create a buffer with
5032 that name. If BUFFER is nil, choose some other buffer. Return
5033 the buffer.
5035 This uses `display-buffer' as a subroutine. The optional ACTION
5036 argument is passed to `display-buffer' as its ACTION argument.
5037 See `display-buffer' for more information. ACTION is t if called
5038 interactively with a prefix argument, which means to pop to a
5039 window other than the selected one even if the buffer is already
5040 displayed in the selected window.
5042 If the window to show BUFFER is not on the selected
5043 frame, raise that window's frame and give it input focus.
5045 Optional third arg NORECORD non-nil means do not put this buffer
5046 at the front of the list of recently selected ones."
5054 ;; If we chose another frame, make sure it gets input focus.
5057 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
5059 buffer))
5062 "Select buffer BUFFER in some window, preferably the same one.
5063 This function behaves much like `switch-to-buffer', except it
5064 displays with `special-display-function' if BUFFER has a match in
5065 `special-display-buffer-names' or `special-display-regexps'.
5067 Unlike `pop-to-buffer', this function prefers using the selected
5068 window over popping up a new window or frame.
5070 BUFFER may be a buffer, a string (a buffer name), or nil. If it
5071 is a string not naming an existent buffer, create a buffer with
5072 that name. If BUFFER is nil, choose some other buffer. Return
5073 the buffer.
5075 NORECORD, if non-nil means do not put this buffer at the front of
5076 the list of recently selected ones."
5080 "Read the name of a buffer to switch to, prompting with PROMPT.
5081 Return the name of the buffer as a string.
5083 This function is intended for the `switch-to-buffer' family of
5084 commands since these need to omit the name of the current buffer
5085 from the list of completions and default values."
5090 ;; Since rbts-completion-table is built dynamically, we
5091 ;; can't just add it to the default value of
5092 ;; icomplete-with-completion-tables, so we add it
5093 ;; here manually.
5098 icomplete-with-completion-tables))))
5103 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
5104 If BUFFER-OR-NAME is nil, return the buffer returned by
5105 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
5106 exists, return that buffer. If no such buffer exists, create a
5107 buffer with the name BUFFER-OR-NAME and return that buffer."
5112 buffer))
5116 "Switch to buffer BUFFER-OR-NAME in the selected window.
5117 If called interactively, prompt for the buffer name using the
5118 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5119 determines whether to request confirmation before creating a new
5120 buffer.
5122 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5123 nil. If BUFFER-OR-NAME is a string that does not identify an
5124 existing buffer, create a buffer with that name. If
5125 BUFFER-OR-NAME is nil, switch to the buffer returned by
5126 `other-buffer'.
5128 Optional argument NORECORD non-nil means do not put the buffer
5129 specified by BUFFER-OR-NAME at the front of the buffer list and
5130 do not make the window displaying it the most recently selected
5131 one.
5133 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
5134 in the selected window; signal an error if that is
5135 impossible (e.g. if the selected window is minibuffer-only). If
5136 nil, BUFFER-OR-NAME may be displayed in another window.
5138 Return the buffer switched to."
5143 ;; Don't call set-window-buffer if it's not needed since it
5144 ;; might signal an error (e.g. if the window is dedicated).
5161 "Select the buffer specified by BUFFER-OR-NAME in another window.
5162 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5163 nil. Return the buffer switched to.
5165 If called interactively, prompt for the buffer name using the
5166 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5167 determines whether to request confirmation before creating a new
5168 buffer.
5170 If BUFFER-OR-NAME is a string and does not identify an existing
5171 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5172 nil, switch to the buffer returned by `other-buffer'.
5174 Optional second argument NORECORD non-nil means do not put this
5175 buffer at the front of the list of recently selected ones.
5177 This uses the function `display-buffer' as a subroutine; see its
5178 documentation for additional customization information."
5185 "Switch to buffer BUFFER-OR-NAME in another frame.
5186 BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
5187 nil. Return the buffer switched to.
5189 If called interactively, prompt for the buffer name using the
5190 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5191 determines whether to request confirmation before creating a new
5192 buffer.
5194 If BUFFER-OR-NAME is a string and does not identify an existing
5195 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5196 nil, switch to the buffer returned by `other-buffer'.
5198 Optional second arg NORECORD non-nil means do not put this
5199 buffer at the front of the list of recently selected ones.
5201 This uses the function `display-buffer' as a subroutine; see its
5202 documentation for additional customization information."
5206 \f
5208 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5209 WINDOW must be a live window and defaults to the selected one.
5210 HEIGHT doesn't include the mode line or header line, if any, or
5211 any partial-height lines in the text display area.
5213 Note that the current implementation of this function cannot
5214 always set the height exactly, but attempts to be conservative,
5215 by allocating more lines than are actually needed in the case
5216 where some error may be present."
5220 ;; Setting window-min-height to a value like 1 can lead to very
5221 ;; bizarre displays because it also allows Emacs to make *other*
5222 ;; windows one line tall, which means that there's no more space
5223 ;; for the mode line.
5228 "Make selected window DELTA columns wider.
5229 Interactively, if no argument is given, make selected window one
5230 column wider."
5235 "Make selected window DELTA columns narrower.
5236 Interactively, if no argument is given, make selected window one
5237 column narrower."
5242 "Return the number of screen lines in the region.
5243 The number of screen lines may be different from the number of actual lines,
5244 due to line breaking, display table, etc.
5246 Optional arguments BEG and END default to `point-min' and `point-max'
5247 respectively.
5249 If region ends with a newline, ignore it unless optional third argument
5250 COUNT-FINAL-NEWLINE is non-nil.
5252 The optional fourth argument WINDOW specifies the window used for obtaining
5253 parameters such as width, horizontal scrolling, and so on. The default is
5254 to use the selected window's parameters.
5256 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5257 regardless of which buffer is displayed in WINDOW. This makes possible to use
5258 `count-screen-lines' in any buffer, whether or not it is currently displayed
5259 in some window."
5265 0
5278 "Return the height (in screen lines) of the buffer that WINDOW is displaying.
5279 WINDOW must be a live window and defaults to the selected one."
5284 ;; If buffer ends with a newline, ignore it when
5285 ;; counting height unless point is after it.
5287 window))))
5289 ;;; Resizing buffers to fit their contents exactly.
5291 "Adjust height of WINDOW to display its buffer's contents exactly.
5292 WINDOW must be a live window and defaults to the selected one.
5294 Optional argument MAX-HEIGHT specifies the maximum height of
5295 WINDOW and defaults to the height of WINDOW's frame. Optional
5296 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5297 defaults to `window-min-height'. Both MAX-HEIGHT and MIN-HEIGHT
5298 are specified in lines and include the mode line and header line,
5299 if any.
5301 Optional argument OVERRIDE non-nil means override restrictions
5302 imposed by `window-min-height' and `window-min-width' on the size
5303 of WINDOW.
5305 Return the number of lines by which WINDOW was enlarged or
5306 shrunk. If an error occurs during resizing, return nil but don't
5307 signal an error.
5309 Note that even if this function makes WINDOW large enough to show
5310 _all_ lines of its buffer you might not see the first lines when
5311 WINDOW was scrolled."
5313 ;; Do all the work in WINDOW and its buffer and restore the selected
5314 ;; window and the current buffer when we're done.
5316 ;; Can't resize a full height or fixed-size window.
5319 ;; `with-selected-window' should orderly restore the current buffer.
5321 ;; We are in WINDOW's buffer now.
5327 window-safe-min-height)))
5330 ;; Adjust MAX-HEIGHT.
5333 max-window-height
5335 ;; Make `desired-height' the height necessary to show
5336 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5337 ;; and MAX-HEIGHT.
5342 ;; For non-minibuffers count the mode line, if any.
5344 mode-line-format)
5345 1
5347 ;; Count the header line, if any.
5349 max-height)
5350 min-height))
5359 ;; This `condition-case' shouldn't be necessary, but who knows?
5362 ;; Return zero if DELTA became zero in the process.
5363 0
5364 ;; Don't try to redisplay with the cursor at the end on its
5365 ;; own line--that would force a scroll and spoil things.
5367 ;; It's silly to put `point' at the end of the previous
5368 ;; line and so maybe force horizontal scrolling.
5370 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5372 ;; Check if the last line is surely fully visible. If
5373 ;; not, enlarge the window.
5377 ;; Don't include final newline.
5380 ;; If line-wrapping is turned off, test the
5381 ;; beginning of the last line for
5382 ;; visibility instead of the end, as the
5383 ;; end of the line could be invisible by
5384 ;; virtue of extending past the edge of the
5385 ;; window.
5389 ;; This loop might in some rare pathological cases raise
5390 ;; an error - another reason for the `condition-case'.
5397 delta))))
5400 "Return t if WINDOW can be shrunk without shrinking other windows.
5401 WINDOW defaults to the selected window."
5408 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5409 More precisely, shrink WINDOW vertically to be as small as
5410 possible, while still showing the full contents of its buffer.
5411 WINDOW must be a live window and defaults to the selected one.
5413 Do not shrink WINDOW to less than `window-min-height' lines. Do
5414 nothing if the buffer contains more lines than the present window
5415 height, or if some of the window's contents are scrolled out of
5416 view, or if shrinking this window would also shrink another
5417 window, or if the window is the only window of its frame.
5419 Return non-nil if the window was shrunk, nil otherwise."
5422 ;; Make sure that WINDOW is vertically combined and `point-min' is
5423 ;; visible (for whatever reason that's needed). The remaining issues
5424 ;; should be taken care of by `fit-window-to-buffer'.
5428 \f
5430 "Kill the current buffer and delete the selected window."
5439 ;; If `delete-window' failed before, we rerun it to regenerate
5440 ;; the error so it can be seen in the echo area.
5443 ;; If the buffer is not dead for some reason (probably because
5444 ;; of a `quit' signal), remove the hook again.
5449 \f
5451 "Indicates the last recenter operation performed.
5455 "Cycling order for `recenter-top-bottom'.
5456 A list of elements with possible values `top', `middle', `bottom',
5457 integer or float numbers that define the cycling order for
5458 the command `recenter-top-bottom'.
5460 Top and bottom destinations are `scroll-margin' lines from the true
5461 window top and bottom. Middle redraws the frame and centers point
5462 vertically within the window. Integer number moves current line to
5463 the specified absolute window-line. Float number between 0.0 and 1.0
5464 means the percentage of the screen space from the top. The default
5465 cycling order is middle -> top -> bottom."
5476 "Move current buffer line to the specified window line.
5477 With no prefix argument, successive calls place point according
5478 to the cycling order defined by `recenter-positions'.
5480 A prefix argument is handled like `recenter':
5481 With numeric prefix ARG, move current line to window-line ARG.
5482 With plain `C-u', move current line to window center."
5490 recenter-positions))
5509 "Position point relative to window.
5511 With a prefix argument ARG, acts like `move-to-window-line'.
5513 With no argument, positions point at center of window.
5514 Successive calls position point at positions defined
5515 by `recenter-positions'."
5523 recenter-positions))
5540 \f
5541 ;;; Scrolling commands.
5543 ;;; Scrolling commands which do not signal errors at top/bottom
5544 ;;; of buffer at first key-press (instead move to top/bottom
5545 ;;; of buffer).
5548 "Move point to top/bottom of buffer before signaling a scrolling error.
5549 A value of nil means just signal an error if no more scrolling possible.
5550 A value of t means point moves to the beginning or the end of the buffer
5551 \(depending on scrolling direction) when no more scrolling possible.
5552 When point is already on that position, then signal an error."
5558 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5559 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5560 scroll window further, move cursor to the bottom line.
5561 When point is already on that position, then signal an error.
5562 A near full screen is `next-screen-context-lines' less than a full screen.
5563 Negative ARG means scroll downward.
5564 If ARG is the atom `-', scroll downward by nearly full screen."
5580 ;; When scrolling by ARG lines can't be done,
5581 ;; move by ARG lines instead.
5583 ;; When ARG is nil for full-screen scrolling,
5584 ;; move to the bottom of the buffer.
5590 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5591 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5592 scroll window further, move cursor to the top line.
5593 When point is already on that position, then signal an error.
5594 A near full screen is `next-screen-context-lines' less than a full screen.
5595 Negative ARG means scroll upward.
5596 If ARG is the atom `-', scroll upward by nearly full screen."
5612 ;; When scrolling by ARG lines can't be done,
5613 ;; move by ARG lines instead.
5615 ;; When ARG is nil for full-screen scrolling,
5616 ;; move to the top of the buffer.
5621 ;;; Scrolling commands which scroll a line instead of full screen.
5624 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5625 If ARG is omitted or nil, scroll upward by one line.
5626 This is different from `scroll-up-command' that scrolls a full screen."
5633 "Scroll text of selected window down ARG lines; or one line if no ARG.
5634 If ARG is omitted or nil, scroll down by one line.
5635 This is different from `scroll-down-command' that scrolls a full screen."
5641 \f
5644 For more details, see the documentation for `scroll-other-window'."
5647 ;; Just invert the argument's meaning.
5648 ;; We can do that without knowing which window it will be.
5654 "Move point to the beginning of the buffer in the other window.
5655 Leave mark at previous position.
5656 With arg N, put point N/10 of the way from the true beginning."
5660 ;; We use unwind-protect rather than save-window-excursion
5661 ;; because the latter would preserve the things we want to change.
5665 ;; Set point and mark in that window's buffer.
5668 ;; Set point accordingly.
5673 "Move point to the end of the buffer in the other window.
5674 Leave mark at previous position.
5675 With arg N, put point N/10 of the way from the true end."
5677 ;; See beginning-of-buffer-other-window for comments.
5687 \f
5698 "When non-nil, special state of delayed window autoselection.
5699 Possible values are `suspend' (suspend autoselection after a menu or
5700 scrollbar interaction) and `select' (the next invocation of
5704 "Cancel delayed window autoselection.
5705 Optional argument FORCE means cancel unconditionally."
5707 ;; Don't cancel for select-window or select-frame events
5708 ;; or when the user drags a scroll bar.
5720 "Start delayed window autoselection.
5721 MOUSE-POSITION is the last position where the mouse was seen as returned
5722 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5723 window where the mouse was seen. Optional argument SUSPEND non-nil
5724 means suspend autoselection."
5725 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5729 ;; Install timer which runs `mouse-autoselect-window-select' after
5730 ;; `mouse-autoselect-window' seconds.
5736 "Select window with delayed window autoselection.
5737 If the mouse position has stabilized in a non-selected window, select
5738 that window. The minibuffer window is selected only if the minibuffer
5739 is active. This function is run by `mouse-autoselect-window-timer'."
5750 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5751 ;; of WINDOW, temporarily suspend delayed autoselection.
5754 ;; Delayed autoselection was temporarily suspended, reenable it.
5759 ;; If `mouse-autoselect-window' is positive, select
5760 ;; window if the window is the same as before.
5762 ;; Otherwise select window if the mouse is at the same
5763 ;; position as before. Observe that the first test after
5764 ;; starting autoselection usually fails since the value of
5765 ;; `mouse-autoselect-window-position' recorded there is the
5766 ;; position where the mouse has entered the new window and
5767 ;; not necessarily where the mouse has stopped moving.
5769 ;; The minibuffer is a candidate window if it's active.
5772 ;; Mouse position has stabilized in non-selected window: Cancel
5773 ;; delayed autoselection and try to select that window.
5775 ;; Select window where mouse appears unless the selected window is the
5776 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5777 ;; and post-command hooks and trigger idle timers. To avoid delaying
5778 ;; autoselection again, set `mouse-autoselect-window-state'."
5783 unread-command-events))))
5787 ;; Mouse position has either stabilized in the selected window or at
5788 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5791 ;; Mouse position has not stabilized yet, resume delayed
5792 ;; autoselection.
5796 "Handle select-window events."
5800 ;; Don't switch if we're currently in the minibuffer.
5801 ;; This tries to work around problems where the
5802 ;; minibuffer gets unselected unexpectedly, and where
5803 ;; you then have to move your mouse all the way down to
5804 ;; the minibuffer to select it.
5806 ;; Don't switch to minibuffer window unless it's active.
5809 ;; Don't switch when autoselection shall be delayed.
5814 ;; Cancel any delayed autoselection.
5816 ;; Start delayed autoselection from current mouse
5817 ;; position and window.
5819 ;; Executing a command cancels delayed autoselection.
5823 ;; Reset state of delayed autoselection.
5825 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5827 ;; Clear echo area.
5832 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5833 WINDOW must be a live window and defaults to the selected one.
5834 Return nil if WINDOW is not a partial-width window
5835 (regardless of the value of `truncate-lines').
5836 Otherwise, consult the value of `truncate-partial-width-windows'
5837 for the buffer shown in WINDOW."
5844 t-p-w-w))))
5845 \f
5846 ;; Some of these are in tutorial--default-keys, so update that if you
5847 ;; change these.
5860 ;;; window.el ends here