| blob | 4d8b3c92b95724331c52b037fa2f0746d1656d61 |
1 ;;; window.el --- GNU Emacs window commands aside from those written in C
3 ;; Copyright (C) 1985, 1989, 1992-1994, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Window tree functions.
29 ;;; Code:
34 "Execute BODY, then select the previously selected window.
35 The value returned is the value of the last form in BODY.
37 This macro saves and restores the selected window, as well as the
38 selected window in each frame. If the previously selected window
39 is no longer live, then whatever window is selected at the end of
40 BODY remains selected. If the previously selected window of some
41 frame is no longer live at the end of BODY, that frame's selected
42 window is left alone.
44 This macro saves and restores the current buffer, since otherwise
45 its normal operation could make a different buffer current. The
46 order of recently selected windows and the buffer list ordering
47 are not altered by this macro (unless they are altered in BODY)."
50 ;; It is necessary to save all of these, because calling
51 ;; select-window changes frame-selected-window for whatever
52 ;; frame that window is in.
66 ;; The following two functions are like `window-next-sibling' and
67 ;; `window-prev-sibling' but the WINDOW argument is _not_ optional (so
68 ;; they don't substitute the selected window for nil), and they return
69 ;; nil when WINDOW doesn't have a parent (like a frame's root window or
70 ;; a minibuffer window).
72 "Return WINDOW's right sibling.
73 Return nil if WINDOW is the root window of its frame. WINDOW can
74 be any window."
78 "Return WINDOW's left sibling.
79 Return nil if WINDOW is the root window of its frame. WINDOW can
80 be any window."
84 "Return WINDOW's first child window."
88 "Return number of WINDOW's child windows."
94 count))
97 "Return last child window of WINDOW."
101 window)
104 "Return t if OBJECT denotes a live or internal window."
107 t))
110 "Return buffer specified by BUFFER-OR-NAME.
111 BUFFER-OR-NAME must be either a buffer or a string naming a live
112 buffer and defaults to the current buffer."
118 buffer-or-name
125 "Return frame specified by FRAME.
126 FRAME must be a live frame and defaults to the selected frame."
129 frame
134 "Return window specified by WINDOW.
135 WINDOW must be a window that has not been deleted and defaults to
136 the selected window."
139 window
144 "Return live window specified by WINDOW.
145 WINDOW must be a live window and defaults to the selected one."
148 window
153 "If non-nil, standard functions ignore window parameters.
154 The functions currently affected by this are `split-window',
155 `delete-window', `delete-other-windows' and `other-window'.
157 An application may bind this to a non-nil value around calls to
161 "The absolute minimum number of lines of a window.
165 "The minimum number of lines of any window.
166 The value has to accommodate a mode- or header-line if present.
167 A value less than `window-safe-min-height' is ignored. The value
168 of this variable is honored when windows are resized or split.
170 Applications should never rebind this variable. To resize a
171 window to a height less than the one specified here, an
172 application should instead call `window-resize' with a non-nil
173 IGNORE argument. In order to have `split-window' make a window
174 shorter, explictly specify the SIZE argument of that function."
180 "The absolute minimum number of columns of a window.
184 "The minimum number of columns of any window.
185 The value has to accommodate margins, fringes, or scrollbars if
186 present. A value less than `window-safe-min-width' is ignored.
187 The value of this variable is honored when windows are resized or
188 split.
190 Applications should never rebind this variable. To resize a
191 window to a width less than the one specified here, an
192 application should instead call `window-resize' with a non-nil
193 IGNORE argument. In order to have `split-window' make a window
194 narrower, explictly specify the SIZE argument of that function."
200 "If WINDOW is a vertical combination return WINDOW's first child.
201 WINDOW can be any window and defaults to the selected one.
202 Optional argument HORIZONTAL non-nil means return WINDOW's first
203 child if WINDOW is a horizontal combination."
210 "Return non-nil if and only if WINDOW is vertically combined.
211 WINDOW can be any window and defaults to the selected one.
212 Optional argument HORIZONTAL non-nil means return non-nil if and
213 only if WINDOW is horizontally combined."
219 "Return largest number of vertically arranged subwindows of WINDOW.
220 WINDOW can be any window and defaults to the selected one.
221 Optional argument HORIZONTAL non-nil means to return the largest
222 number of horizontally arranged subwindows of WINDOW."
226 ;; If WINDOW is live, return 1.
229 ;; If WINDOW is iso-combined, return the sum of the values for all
230 ;; subwindows of WINDOW.
236 count))
238 count))
240 ;; If WINDOW is not iso-combined, return the maximum value of any
241 ;; subwindow of WINDOW.
247 count))
249 count))))
252 "Helper function for `walk-window-tree' and `walk-window-subtree'."
270 "Run function PROC on each live window of FRAME.
271 PROC must be a function with one argument - a window. FRAME must
272 be a live frame and defaults to the selected one. ANY, if
273 non-nil means to run PROC on all live and internal windows of
274 FRAME.
276 This function performs a pre-order, depth-first traversal of the
277 window tree. If PROC changes the window tree, the result is
278 unpredictable."
284 "Run function PROC on each live subwindow of WINDOW.
285 WINDOW defaults to the selected window. PROC must be a function
286 with one argument - a window. ANY, if non-nil means to run PROC
287 on all live and internal subwindows of WINDOW.
289 This function performs a pre-order, depth-first traversal of the
290 window tree rooted at WINDOW. If PROC changes that window tree,
291 the result is unpredictable."
296 "Return a list of all windows on FRAME with PARAMETER non-nil.
297 FRAME defaults to the selected frame. Optional argument VALUE
298 non-nil means only return windows whose window-parameter value of
299 PARAMETER equals VALUE \(comparison is done using `equal').
300 Optional argument ANY non-nil means consider internal windows
301 too. Optional argument VALUES non-nil means return a list of cons
302 cells whose car is the value of the parameter and whose cdr is
303 the window."
313 frame any)
318 "Return first window on FRAME with PARAMETER non-nil.
319 FRAME defaults to the selected frame. Optional argument VALUE
320 non-nil means only return a window whose window-parameter value
321 for PARAMETER equals VALUE \(comparison is done with `equal').
322 Optional argument ANY non-nil means consider internal windows
323 too."
331 frame any))))
333 ;;; Atomic windows.
335 "Return root of atomic window WINDOW is a part of.
336 WINDOW can be any window and defaults to the selected one.
337 Return nil if WINDOW is not part of a atomic window."
343 root))
346 "Make WINDOW an atomic window.
347 WINDOW must be an internal window. Return WINDOW."
353 window t)
354 window))
357 "Subroutine of `window-atom-check'."
367 window t))
368 ;; count >= 1 must hold here. If there's no other
369 ;; window around dissolve this atomic window.
371 ;; Dissolve atomic window.
375 window t)))
376 ;; Check children.
380 ;; Check right sibling
384 "Check atomicity of all windows on FRAME.
385 FRAME defaults to the selected frame. If an atomic window is
386 wrongly configured, reset the atomicity of all its subwindows to
387 nil. An atomic window is wrongly configured if it has no
388 subwindows or one of its subwindows is not atomic."
391 ;; Side windows.
396 "If non-nil, left and right side windows are full height.
397 Otherwise, top and bottom side windows are full width."
403 "Maximum number of side window slots.
404 The value is a list of four elements specifying the number of
405 side window slots on \(in this order) the left, top, right and
406 bottom side of each frame. If an element is a number, this means
407 to display at most that many side windows on the corresponding
408 side. If an element is nil, this means there's no bound on the
409 number of slots on that side."
410 :risky t
411 :type
417 :value nil
424 :value nil
431 :value nil
438 :value nil
445 "Check the window-side parameter of all windows on FRAME.
446 FRAME defaults to the selected frame. If the configuration is
447 invalid, reset all window-side parameters to nil.
449 A valid configuration has to preserve the following invariant:
451 - If a window has a non-nil window-side parameter, it must have a
452 parent window and the parent window's window-side parameter
453 must be either nil or the same as for window.
455 - If windows with non-nil window-side parameters exist, there
456 must be at most one window of each side and non-side with a
457 parent whose window-side parameter is nil and there must be no
458 leaf window whose window-side parameter is nil."
460 side parent parent-side code)
468 ;; The following `cond' seems a bit tedious, but I'd
469 ;; rather stick to using just the stack.
473 ;; A parent whose window-side is non-nil must
474 ;; have a child with the same window-side.
476 ;; Now check that there's more than one main window
477 ;; for any of none, left, top, right and bottom.
499 ;; A leaf window without window-side parameter,
500 ;; record its existence.
502 frame t))
504 ;; At least one non-side window exists, so there must
505 ;; be at least one side-window and no normal window.
507 ;; No non-side window exists, so there must be no side
508 ;; window either.
513 frame t))))
516 "Check atomic and side windows on FRAME.
517 FRAME defaults to the selected frame."
521 ;;; Window sizes.
523 "Non-nil in a buffer means windows displaying the buffer are fixed-size.
524 If the value is `height', then only the window's height is fixed.
525 If the value is `width', then only the window's width is fixed.
526 Any other non-nil value fixes both the width and the height.
528 Emacs won't change the size of any window displaying that buffer,
529 unless it has no other choice \(like when deleting a neighboring
534 "Return non-nil if IGNORE says to ignore size restrictions for WINDOW."
538 "Return the minimum number of lines of WINDOW.
539 WINDOW can be an arbitrary window and defaults to the selected
540 one. Optional argument HORIZONTAL non-nil means return the
541 minimum number of columns of WINDOW.
543 Optional argument IGNORE non-nil means ignore any restrictions
544 imposed by fixed size windows, `window-min-height' or
545 `window-min-width' settings. IGNORE equal `safe' means live
546 windows may get as small as `window-safe-min-height' lines and
547 `window-safe-min-width' columns. IGNORE a window means ignore
548 restrictions for that window only."
553 "Internal function of `window-min-size'."
557 ;; WINDOW is an internal window.
559 ;; The minimum size of an iso-combination is the sum of
560 ;; the minimum sizes of its subwindows.
565 ;; The minimum size of an ortho-combination is the maximum of
566 ;; the minimum sizes of its subwindows.
571 value)
576 ;; The minimum size of a fixed size window is its size.
579 ;; If IGNORE equals `safe' or WINDOW return the safe values.
582 ;; For the minimum width of a window take fringes and
583 ;; scroll-bars into account. This is questionable and should
584 ;; be removed as soon as we are able to split (and resize)
585 ;; windows such that the new (or resized) windows can get a
586 ;; size less than the user-specified `window-min-height' and
587 ;; `window-min-width'.
592 (+ window-safe-min-width
605 window-min-width
608 ;; For the minimum height of a window take any mode- or
609 ;; header-line into account.
615 window-min-height
619 "Return DELTA if DELTA lines can be added to WINDOW.
620 Optional argument HORIZONTAL non-nil means return DELTA if DELTA
621 columns can be added to WINDOW. A return value of zero means
622 that no lines (or columns) can be added to WINDOW.
624 This function looks only at WINDOW and its subwindows. The
625 function `window-resizable' looks at other windows as well.
627 DELTA positive means WINDOW shall be enlarged by DELTA lines or
628 columns. If WINDOW cannot be enlarged by DELTA lines or columns
629 return the maximum value in the range 0..DELTA by which WINDOW
630 can be enlarged.
632 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
633 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
634 return the minimum value in the range DELTA..0 by which WINDOW
635 can be shrunk.
637 Optional argument IGNORE non-nil means ignore any restrictions
638 imposed by fixed size windows, `window-min-height' or
639 `window-min-width' settings. IGNORE equal `safe' means live
640 windows may get as small as `window-safe-min-height' lines and
641 `window-safe-min-width' columns. IGNORE any window means ignore
642 restrictions for that window only."
648 delta))
650 delta)
653 0
654 delta))
658 "Return t if WINDOW can be resized by DELTA lines.
659 For the meaning of the arguments of this function see the
660 doc-string of `window-sizable'."
667 "Internal function for `window-size-fixed-p'."
671 ;; WINDOW is an internal window.
673 ;; An iso-combination is fixed size if all its subwindows
674 ;; are fixed-size.
678 ;; We found a non-fixed-size subwindow, so WINDOW's
679 ;; size is not fixed.
682 ;; All subwindows are fixed-size, so WINDOW's size is
683 ;; fixed.
685 ;; An ortho-combination is fixed-size if at least one of its
686 ;; subwindows is fixed-size.
689 ;; We found a fixed-size subwindow, so WINDOW's size is
690 ;; fixed.
693 ;; WINDOW is a live window.
700 "Return non-nil if WINDOW's height is fixed.
701 WINDOW can be an arbitrary window and defaults to the selected
702 window. Optional argument HORIZONTAL non-nil means return
703 non-nil if WINDOW's width is fixed.
705 If this function returns nil, this does not necessarily mean that
706 WINDOW can be resized in the desired direction. The functions
707 `window-resizable' and `window-resizable-p' will tell that."
712 "Internal function for `window-min-delta'."
714 ;; If we can't go up, return zero.
715 0
716 ;; Else try to find a non-fixed-size sibling of WINDOW.
721 ;; In an iso-combination throw DELTA if we find at least one
722 ;; subwindow and that subwindow is either not of fixed-size
723 ;; or we can ignore fixed-sizeness.
733 ;; We found a non-fixed-size subwindow.
736 ;; In an ortho-combination set DELTA to the minimum value by
737 ;; which other subwindows can shrink.
746 delta
750 "Return number of lines by which WINDOW can be shrunk.
751 WINDOW can be an arbitrary window and defaults to the selected
752 window. Return zero if WINDOW cannot be shrunk.
754 Optional argument HORIZONTAL non-nil means return number of
755 columns by which WINDOW can be shrunk.
757 Optional argument IGNORE non-nil means ignore any restrictions
758 imposed by fixed size windows, `window-min-height' or
759 `window-min-width' settings. IGNORE a window means ignore
760 restrictions for that window only. IGNORE equal `safe' means
761 live windows may get as small as `window-safe-min-height' lines
762 and `window-safe-min-width' columns.
764 Optional argument TRAIL `before' means only windows to the left
765 of or above WINDOW can be enlarged. Optional argument TRAIL
766 `after' means only windows to the right of or below WINDOW can be
767 enlarged.
769 Optional argument NOUP non-nil means don't go up in the window
770 tree but try to enlarge windows within WINDOW's combination only.
772 Optional argument NODOWN non-nil means don't check whether WINDOW
773 itself \(and its subwindows) can be shrunk; check only whether at
774 least one other windows can be enlarged appropriately."
780 ;; If NODOWN is t, try to recover the entire size of WINDOW.
783 ;; If NODOWN is nil and WINDOW's size is already at its minimum,
784 ;; there's nothing to recover.
787 ;; Otherwise, try to recover whatever WINDOW is larger than its
788 ;; minimum size.
793 "Internal function of `window-max-delta'."
795 ;; Can't go up. Return DELTA.
796 delta
801 ;; For an iso-combination calculate how much we can get from
802 ;; other subwindows.
811 (+ delta
815 ;; For an ortho-combination throw DELTA when at least one
816 ;; subwindow is fixed-size.
824 ;; When NOUP is nil, DELTA is all we can get.
825 delta
826 ;; Else try with parent of WINDOW, passing the DELTA we
827 ;; recovered so far.
831 "Return maximum number of lines WINDOW by which WINDOW can be enlarged.
832 WINDOW can be an arbitrary window and defaults to the selected
833 window. The return value is zero if WINDOW cannot be enlarged.
835 Optional argument HORIZONTAL non-nil means return maximum number
836 of columns by which WINDOW can be enlarged.
838 Optional argument IGNORE non-nil means ignore any restrictions
839 imposed by fixed size windows, `window-min-height' or
840 `window-min-width' settings. IGNORE a window means ignore
841 restrictions for that window only. IGNORE equal `safe' means
842 live windows may get as small as `window-safe-min-height' lines
843 and `window-safe-min-width' columns.
845 Optional argument TRAIL `before' means only windows to the left
846 of or below WINDOW can be shrunk. Optional argument TRAIL
847 `after' means only windows to the right of or above WINDOW can be
848 shrunk.
850 Optional argument NOUP non-nil means don't go up in the window
851 tree but try to obtain the entire space from windows within
852 WINDOW's combination.
854 Optional argument NODOWN non-nil means do not check whether
855 WINDOW itself \(and its subwindows) can be enlarged; check only
856 whether other windows can be shrunk appropriately."
860 ;; With IGNORE and NOWDON nil return zero if WINDOW has fixed
861 ;; size.
862 0
863 ;; WINDOW has no fixed size.
866 ;; Make NOUP also inhibit the min-size check.
868 "Return DELTA if WINDOW can be resized vertically by DELTA lines.
869 Optional argument HORIZONTAL non-nil means return DELTA if WINDOW
870 can be resized horizontally by DELTA columns. A return value of
871 zero means that WINDOW is not resizable.
873 DELTA positive means WINDOW shall be enlarged by DELTA lines or
874 columns. If WINDOW cannot be enlarged by DELTA lines or columns
875 return the maximum value in the range 0..DELTA by which WINDOW
876 can be enlarged.
878 DELTA negative means WINDOW shall be shrunk by -DELTA lines or
879 columns. If WINDOW cannot be shrunk by -DELTA lines or columns,
880 return the minimum value in the range DELTA..0 that can be used
881 for shrinking WINDOW.
883 Optional argument IGNORE non-nil means ignore any restrictions
884 imposed by fixed size windows, `window-min-height' or
885 `window-min-width' settings. IGNORE a window means ignore
886 restrictions for that window only. IGNORE equal `safe' means
887 live windows may get as small as `window-safe-min-height' lines
888 and `window-safe-min-width' columns.
890 Optional argument TRAIL `before' means only windows to the left
891 of or below WINDOW can be shrunk. Optional argument TRAIL
892 `after' means only windows to the right of or above WINDOW can be
893 shrunk.
895 Optional argument NOUP non-nil means don't go up in the window
896 tree but try to distribute the space among the other windows
897 within WINDOW's combination.
899 Optional argument NODOWN non-nil means don't check whether WINDOW
900 and its subwindows can be resized."
905 delta))
908 delta))
912 "Return t if WINDOW can be resized vertically by DELTA lines.
913 For the meaning of the arguments of this function see the
914 doc-string of `window-resizable'."
918 delta)
920 delta)))
923 "Return the total number of lines of WINDOW.
924 WINDOW can be any window and defaults to the selected one. The
925 return value includes WINDOW's mode line and header line, if any.
926 If WINDOW is internal the return value is the sum of the total
927 number of lines of WINDOW's child windows if these are vertically
928 combined and the height of WINDOW's first child otherwise.
930 Note: This function does not take into account the value of
931 `line-spacing' when calculating the number of lines in WINDOW."
934 ;; Eventually we should make `window-height' obsolete.
937 ;; See discussion in bug#4543.
939 "Return t if WINDOW is as high as the containing frame.
940 More precisely, return t if and only if the total height of
941 WINDOW equals the total height of the root window of WINDOW's
942 frame. WINDOW can be any window and defaults to the selected
943 one."
949 "Return the total number of columns of WINDOW.
950 WINDOW can be any window and defaults to the selected one. The
951 return value includes any vertical dividers or scrollbars of
952 WINDOW. If WINDOW is internal, the return value is the sum of
953 the total number of columns of WINDOW's child windows if these
954 are horizontally combined and the width of WINDOW's first child
955 otherwise."
959 "Return t if WINDOW is as wide as the containing frame.
960 More precisely, return t if and only if the total width of WINDOW
961 equals the total width of the root window of WINDOW's frame.
962 WINDOW can be any window and defaults to the selected one."
968 "Return the number of lines of WINDOW's body.
969 WINDOW must be a live window and defaults to the selected one.
971 The return value does not include WINDOW's mode line and header
972 line, if any. If a line at the bottom of the window is only
973 partially visible, that line is included in the return value. If
974 you do not want to include a partially visible bottom line in the
975 return value, use `window-text-height' instead."
979 "Return the number of columns of WINDOW's body.
980 WINDOW must be a live window and defaults to the selected one.
982 The return value does not include any vertical dividers or scroll
983 bars owned by WINDOW. On a window-system the return value does
984 not include the number of columns used for WINDOW's fringes or
985 display margins either."
988 ;; Eventually we should make `window-height' obsolete.
992 "Return the current scroll bar settings for WINDOW.
993 WINDOW must be a live window and defaults to the selected one.
995 The return value is a cons cell (VERTICAL . HORIZONTAL) where
996 VERTICAL specifies the current location of the vertical scroll
997 bars (`left', `right', or nil), and HORIZONTAL specifies the
998 current location of the horizontal scroll bars (`top', `bottom',
999 or nil).
1001 Unlike `window-scroll-bars', this function reports the scroll bar
1002 type actually used, once frame defaults and `scroll-bar-mode' are
1003 taken into account."
1016 "Cycle through all live windows, calling PROC for each one.
1017 PROC must specify a function with a window as its sole argument.
1018 The optional arguments MINIBUF and ALL-FRAMES specify the set of
1019 windows to include in the walk.
1021 MINIBUF t means include the minibuffer window even if the
1022 minibuffer is not active. MINIBUF nil or omitted means include
1023 the minibuffer window only if the minibuffer is active. Any
1024 other value means do not include the minibuffer window even if
1025 the minibuffer is active.
1027 ALL-FRAMES nil or omitted means consider all windows on the
1028 selected frame, plus the minibuffer window if specified by the
1029 MINIBUF argument. If the minibuffer counts, consider all windows
1030 on all frames that share that minibuffer too. The following
1031 non-nil values of ALL-FRAMES have special meanings:
1033 - t means consider all windows on all existing frames.
1035 - `visible' means consider all windows on all visible frames on
1036 the current terminal.
1038 - 0 (the number zero) means consider all windows on all visible
1039 and iconified frames on the current terminal.
1041 - A frame means consider all windows on that frame only.
1043 Anything else means consider all windows on the selected frame
1044 and no others.
1046 This function changes neither the order of recently selected
1047 windows nor the buffer list."
1048 ;; If we start from the minibuffer window, don't fail to come
1049 ;; back to it.
1052 ;; Make sure to not mess up the order of recently selected
1053 ;; windows. Use `save-selected-window' and `select-window'
1054 ;; with second argument non-nil for this purpose.
1062 "Return value of WINDOW's point.
1063 WINDOW can be any live window and defaults to the selected one.
1065 This function is like `window-point' with one exception: If
1066 WINDOW is selected, it returns the value of `point' of WINDOW's
1067 buffer regardless of whether that buffer is current or not."
1075 "Set value of WINDOW's point to POS.
1076 WINDOW can be any live window and defaults to the selected one.
1078 This function is like `set-window-point' with one exception: If
1079 WINDOW is selected, it moves `point' of WINDOW's buffer to POS
1080 regardless of whether that buffer is current or not."
1088 "Support function for `window-in-direction'."
1100 "Return window in DIRECTION as seen from WINDOW.
1101 DIRECTION must be one of `above', `below', `left' or `right'.
1102 WINDOW must be a live window and defaults to the selected one.
1103 IGNORE, when non-nil means a window can be returned even if its
1104 `no-other-window' parameter is non-nil."
1117 ;; The column / row value of `posn-at-point' can be nil for the
1118 ;; mini-window, guard against that.
1129 best best-2 best-diff-2-new)
1136 ;; Ignore ourselves.
1138 ;; Ignore W unless IGNORE is non-nil.
1144 ;; W is to the left or right of WINDOW and covers POSN.
1154 ;; W is to the left or right of WINDOW but does not
1155 ;; cover POSN.
1170 ;; W is above or below WINDOW and covers POSN.
1180 ;; W is above or below WINDOW but does not cover POSN.
1195 "Return a live window satisfying PREDICATE.
1196 More precisely, cycle through all windows calling the function
1197 PREDICATE on each one of them with the window as its sole
1198 argument. Return the first window for which PREDICATE returns
1199 non-nil. Windows are scanned starting with the window following
1200 the selcted window. If no window satisfies PREDICATE, return
1201 DEFAULT.
1203 MINIBUF t means include the minibuffer window even if the
1204 minibuffer is not active. MINIBUF nil or omitted means include
1205 the minibuffer window only if the minibuffer is active. Any
1206 other value means do not include the minibuffer window even if
1207 the minibuffer is active.
1209 ALL-FRAMES nil or omitted means consider all windows on the selected
1210 frame, plus the minibuffer window if specified by the MINIBUF
1211 argument. If the minibuffer counts, consider all windows on all
1212 frames that share that minibuffer too. The following non-nil
1213 values of ALL-FRAMES have special meanings:
1215 - t means consider all windows on all existing frames.
1217 - `visible' means consider all windows on all visible frames on
1218 the current terminal.
1220 - 0 (the number zero) means consider all windows on all visible
1221 and iconified frames on the current terminal.
1223 - A frame means consider all windows on that frame only.
1225 Anything else means consider all windows on the selected frame
1226 and no others."
1230 minibuf all-frames))
1233 default))
1238 "Return the least recently used window on frames specified by ALL-FRAMES.
1239 Return a full-width window if possible. A minibuffer window is
1240 never a candidate. A dedicated window is never a candidate
1241 unless DEDICATED is non-nil, so if all windows are dedicated, the
1242 value is nil. Avoid returning the selected window if possible.
1244 The following non-nil values of the optional argument ALL-FRAMES
1245 have special meanings:
1247 - t means consider all windows on all existing frames.
1249 - `visible' means consider all windows on all visible frames on
1250 the current terminal.
1252 - 0 (the number zero) means consider all windows on all visible
1253 and iconified frames on the current terminal.
1255 - A frame means consider all windows on that frame only.
1257 Any other value of ALL-FRAMES means consider all windows on the
1258 selected frame and no others."
1274 "Return the most recently used window on frames specified by ALL-FRAMES.
1275 Do not return a minibuffer window.
1277 The following non-nil values of the optional argument ALL-FRAMES
1278 have special meanings:
1280 - t means consider all windows on all existing frames.
1282 - `visible' means consider all windows on all visible frames on
1283 the current terminal.
1285 - 0 (the number zero) means consider all windows on all visible
1286 and iconified frames on the current terminal.
1288 - A frame means consider all windows on that frame only.
1290 Any other value of ALL-FRAMES means consider all windows on the
1291 selected frame and no others."
1298 best-window))
1301 "Return the largest window on frames specified by ALL-FRAMES.
1302 A minibuffer window is never a candidate. A dedicated window is
1303 never a candidate unless DEDICATED is non-nil, so if all windows
1304 are dedicated, the value is nil.
1306 The following non-nil values of the optional argument ALL-FRAMES
1307 have special meanings:
1309 - t means consider all windows on all existing frames.
1311 - `visible' means consider all windows on all visible frames on
1312 the current terminal.
1314 - 0 (the number zero) means consider all windows on all visible
1315 and iconified frames on the current terminal.
1317 - A frame means consider all windows on that frame only.
1319 Any other value of ALL-FRAMES means consider all windows on the
1320 selected frame and no others."
1322 best-window size)
1330 best-window))
1333 "Return list of all windows displaying BUFFER-OR-NAME, or nil if none.
1334 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
1335 and defaults to the current buffer. Windows are scanned starting
1336 with the selected window.
1338 MINIBUF t means include the minibuffer window even if the
1339 minibuffer is not active. MINIBUF nil or omitted means include
1340 the minibuffer window only if the minibuffer is active. Any
1341 other value means do not include the minibuffer window even if
1342 the minibuffer is active.
1344 ALL-FRAMES nil or omitted means consider all windows on the
1345 selected frame, plus the minibuffer window if specified by the
1346 MINIBUF argument. If the minibuffer counts, consider all windows
1347 on all frames that share that minibuffer too. The following
1348 non-nil values of ALL-FRAMES have special meanings:
1350 - t means consider all windows on all existing frames.
1352 - `visible' means consider all windows on all visible frames on
1353 the current terminal.
1355 - 0 (the number zero) means consider all windows on all visible
1356 and iconified frames on the current terminal.
1358 - A frame means consider all windows on that frame only.
1360 Anything else means consider all windows on the selected frame
1361 and no others."
1363 windows)
1370 "Return t if WINDOW is the currently active minibuffer window."
1374 "Return the number of live windows on the selected frame.
1375 The optional argument MINIBUF specifies whether the minibuffer
1376 window shall be counted. See `walk-windows' for the precise
1377 meaning of this argument."
1379 \f
1380 ;;; Resizing windows.
1382 "Reset resize values for all windows on FRAME.
1383 FRAME defaults to the selected frame.
1385 This function stores the current value of `window-total-size' applied
1386 with argument HORIZONTAL in the new total size of all windows on
1387 FRAME. It also resets the new normal size of each of these
1388 windows."
1393 "Internal function of `window--resize-reset'."
1394 ;; Register old size in the new total size.
1396 ;; Reset new normal size.
1403 ;; The following routine is used to manually resize the minibuffer
1404 ;; window and is currently used, for example, by ispell.el.
1406 "Resize minibuffer window WINDOW by DELTA lines.
1407 If WINDOW cannot be resized by DELTA lines make it as large \(or
1408 as small) as possible but don't signal an error."
1416 ;; Sanitize DELTA.
1423 ;; Resize now.
1425 ;; Ideally we should be able to resize just the last subwindow of
1426 ;; root here. See the comment in `resize-root-window-vertically'
1427 ;; for why we do not do that.
1430 ;; The following routine catches the case where we want to resize
1431 ;; a minibuffer-only frame.
1435 "Resize WINDOW vertically by DELTA lines.
1436 WINDOW can be an arbitrary window and defaults to the selected
1437 one. An attempt to resize the root window of a frame will raise
1438 an error though.
1440 DELTA a positive number means WINDOW shall be enlarged by DELTA
1441 lines. DELTA negative means WINDOW shall be shrunk by -DELTA
1442 lines.
1444 Optional argument HORIZONTAL non-nil means resize WINDOW
1445 horizontally by DELTA columns. In this case a positive DELTA
1446 means enlarge WINDOW by DELTA columns. DELTA negative means
1447 WINDOW shall be shrunk by -DELTA columns.
1449 Optional argument IGNORE non-nil means ignore any restrictions
1450 imposed by fixed size windows, `window-min-height' or
1451 `window-min-width' settings. IGNORE any window means ignore
1452 restrictions for that window only. IGNORE equal `safe' means
1453 live windows may get as small as `window-safe-min-height' lines
1454 and `window-safe-min-width' columns.
1456 This function resizes other windows proportionally and never
1457 deletes any windows. If you want to move only the low (right)
1458 edge of WINDOW consider using `adjust-window-trailing-edge'
1459 instead."
1462 sibling)
1475 ;; If window-splits returns nil for WINDOW, WINDOW is part of
1476 ;; an iso-combination, and WINDOW's neighboring right or left
1477 ;; sibling can be resized as requested, resize that sibling.
1484 normal-delta))
1487 normal-delta)))
1488 ;; Otherwise, resize all other windows in the same combination.
1495 "Return non-nil if WINDOW shall be skipped by resizing routines."
1498 (defun window--resize-subwindows-normal (parent horizontal window this-delta &optional trail other-delta)
1499 "Set the new normal height of subwindows of window PARENT.
1500 HORIZONTAL non-nil means set the new normal width of these
1501 windows. WINDOW specifies a subwindow of PARENT that has been
1502 resized by THIS-DELTA lines \(columns).
1504 Optional argument TRAIL either 'before or 'after means set values
1505 for windows before or after WINDOW only. Optional argument
1506 OTHER-DELTA a number specifies that this many lines \(columns)
1507 have been obtained from \(or returned to) an ancestor window of
1508 PARENT in order to resize WINDOW."
1512 ;; When WINDOW gets deleted and we can return its entire
1513 ;; space to its siblings, use WINDOW's normal size as the
1514 ;; normal delta.
1516 ;; In any other case calculate the normal delta from the
1517 ;; relation of THIS-DELTA to the total size of PARENT.
1523 ;; Set parent-normal to the sum of the normal sizes of all
1524 ;; subwindows of PARENT that shall be resized, excluding only WINDOW
1525 ;; and any windows specified by the optional TRAIL argument.
1536 ;; Set the new normal size of all subwindows of PARENT from what
1537 ;; they should have contributed for recovering THIS-DELTA lines
1538 ;; (columns).
1552 delta-normal))
1553 ;; Don't drop below 0.
1558 ;; Set the new normal size of windows from what they should have
1559 ;; contributed for recovering OTHER-DELTA lines (columns).
1562 other-delta)))
1574 ;; Don't drop below 0.
1578 ;; Set the new normal size of WINDOW to what is left by the sum of
1579 ;; the normal sizes of its siblings.
1581 window
1592 ;; Don't get larger than 1 or smaller than 0.
1596 "Resize subwindows of window PARENT vertically by DELTA lines.
1597 PARENT must be a vertically combined internal window.
1599 Optional argument HORIZONTAL non-nil means resize subwindows of
1600 PARENT horizontally by DELTA columns. In this case PARENT must
1601 be a horizontally combined internal window.
1603 WINDOW, if specified, must denote a child window of PARENT that
1604 is resized by DELTA lines.
1606 Optional argument IGNORE non-nil means ignore any restrictions
1607 imposed by fixed size windows, `window-min-height' or
1608 `window-min-width' settings. IGNORE equal `safe' means live
1609 windows may get as small as `window-safe-min-height' lines and
1610 `window-safe-min-width' columns. IGNORE any window means ignore
1611 restrictions for that window only.
1613 Optional arguments TRAIL and EDGE, when non-nil, restrict the set
1614 of windows that shall be resized. If TRAIL equals `before',
1615 resize only windows on the left or above EDGE. If TRAIL equals
1616 `after', resize only windows on the right or below EDGE. Also,
1617 preferably only resize windows adjacent to EDGE.
1619 Return the symbol `normalized' if new normal sizes have been
1620 already set by this routine."
1624 best-window best-value)
1636 sub)
1641 edge)
1646 edge)
1649 ;; Resize only windows adjacent to EDGE.
1652 sub delta horizontal ignore t trail edge)
1655 ;; Assign new normal sizes.
1664 ;; Return 'normalized to notify `window--resize-siblings' that
1665 ;; normal sizes have been already set.
1667 ;; Resize all windows proportionally.
1672 ;; Ignore windows to skip and fixed-size subwindows - in
1673 ;; the latter case make it a window to skip.
1678 ;; When shrinking store the number of lines/cols we can get
1679 ;; from this window here together with the total/normal size
1680 ;; factor.
1682 sub
1684 ;; We used to call this with NODOWN t, "fixed" 2011-05-11.
1687 parent-total)
1690 ;; When enlarging store the total/normal size factor only
1692 sub
1694 parent-total)
1701 ;; Shrink windows by delta.
1720 best-window
1725 parent-total)
1728 ;; Enlarge windows by delta.
1746 best-window
1748 parent-total)
1756 ;; Reset new normal size fields so `window-resize-apply'
1757 ;; won't use them to apply new sizes.
1761 ;; Resize this subwindow's subwindows (back-engineering
1762 ;; delta from sub's old and new total sizes).
1766 ;; For the TRAIL non-nil case we have to resize SUB
1767 ;; recursively even if it's size does not change.
1769 sub delta horizontal ignore nil trail edge))))
1773 "Resize other windows when WINDOW is resized vertically by DELTA lines.
1774 Optional argument HORIZONTAL non-nil means resize other windows
1775 when WINDOW is resized horizontally by DELTA columns. WINDOW
1776 itself is not resized by this function.
1778 Optional argument IGNORE non-nil means ignore any restrictions
1779 imposed by fixed size windows, `window-min-height' or
1780 `window-min-width' settings. IGNORE equal `safe' means live
1781 windows may get as small as `window-safe-min-height' lines and
1782 `window-safe-min-width' columns. IGNORE any window means ignore
1783 restrictions for that window only.
1785 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1786 of windows that shall be resized. If TRAIL equals `before',
1787 resize only windows on the left or above EDGE. If TRAIL equals
1788 `after', resize only windows on the right or below EDGE. Also,
1789 preferably only resize windows adjacent to EDGE."
1794 ;; In an iso-combination try to extract DELTA from WINDOW's
1795 ;; siblings.
1798 this-delta other-delta)
1799 ;; Decide which windows shall be left alone.
1803 ;; Make sure WINDOW is left alone when
1804 ;; resizing its siblings.
1808 ;; Make sure this sibling is left alone when
1809 ;; resizing its siblings.
1813 ;; Set this-delta to t to signal that we found a sibling
1814 ;; of WINDOW whose size is not fixed.
1819 ;; Set this-delta to what we can get from WINDOW's siblings.
1821 ;; A deletion, presumably. We must handle this case
1822 ;; specially since `window-resizable' can't be used.
1824 ;; There's at least one resizable sibling we can
1825 ;; give WINDOW's size to.
1827 ;; No resizable sibling exists.
1829 ;; Any other form of resizing.
1833 ;; Set other-delta to what we still have to get from
1834 ;; ancestor windows of parent.
1837 ;; Unless we got everything from WINDOW's siblings, PARENT
1838 ;; must be resized by other-delta lines or columns.
1842 ;; We haven't got anything from WINDOW's siblings but we
1843 ;; must update the normal sizes to respect other-delta.
1845 parent horizontal window this-delta trail other-delta)
1846 ;; We did get something from WINDOW's siblings which means
1847 ;; we have to resize their subwindows.
1850 window ignore trail edge)
1851 ;; If `window--resize-subwindows' returns
1852 ;; 'normalized, this means it has set the
1853 ;; normal sizes already.
1855 ;; Set the normal sizes.
1857 parent horizontal window this-delta trail other-delta))
1858 ;; Set DELTA to what we still have to get from ancestor
1859 ;; windows.
1862 ;; In an ortho-combination all siblings of WINDOW must be
1863 ;; resized by DELTA.
1871 ;; "Go up."
1873 parent delta horizontal ignore trail edge)))))
1876 "Resize WINDOW vertically by DELTA lines.
1877 Optional argument HORIZONTAL non-nil means resize WINDOW
1878 horizontally by DELTA columns.
1880 Optional argument IGNORE non-nil means ignore any restrictions
1881 imposed by fixed size windows, `window-min-height' or
1882 `window-min-width' settings. IGNORE equal `safe' means live
1883 windows may get as small as `window-safe-min-height' lines and
1884 `window-safe-min-width' columns. IGNORE any window means ignore
1885 restrictions for that window only.
1887 Optional argument ADD non-nil means add DELTA to the new total
1888 size of WINDOW.
1890 Optional arguments TRAIL and EDGE, when non-nil, refine the set
1891 of windows that shall be resized. If TRAIL equals `before',
1892 resize only windows on the left or above EDGE. If TRAIL equals
1893 `after', resize only windows on the right or below EDGE. Also,
1894 preferably only resize windows adjacent to EDGE.
1896 This function recursively resizes WINDOW's subwindows to fit the
1897 new size. Make sure that WINDOW is `window-resizable' before
1898 calling this function. Note that this function does not resize
1899 siblings of WINDOW or WINDOW's parent window. You have to
1900 eventually call `window-resize-apply' in order to make resizing
1901 actually take effect."
1903 ;; Add DELTA to the new total size of WINDOW.
1910 ;; In an iso-combination resize subwindows according to their
1911 ;; normal sizes.
1913 window delta horizontal nil ignore trail edge))
1914 ;; In an ortho-combination resize each subwindow by DELTA.
1918 sub delta horizontal ignore t trail edge)
1922 "Resize root window WINDOW vertically by DELTA lines.
1923 HORIZONTAL non-nil means resize root window WINDOW horizontally
1924 by DELTA columns.
1926 IGNORE non-nil means ignore any restrictions imposed by fixed
1927 size windows, `window-min-height' or `window-min-width' settings.
1929 This function is only called by the frame resizing routines. It
1930 resizes windows proportionally and never deletes any windows."
1937 "Resize root window WINDOW vertically by DELTA lines.
1938 If DELTA is less than zero and we can't shrink WINDOW by DELTA
1939 lines, shrink it as much as possible. If DELTA is greater than
1940 zero, this function can resize fixed-size subwindows in order to
1941 recover the necessary lines.
1943 Return the number of lines that were recovered.
1945 This function is only called by the minibuffer window resizing
1946 routines. It resizes windows proportionally and never deletes
1947 any windows."
1958 ;; Ideally, we would resize just the last window in a combination
1959 ;; but that's not feasible for the following reason: If we grow
1960 ;; the minibuffer window and the last window cannot be shrunk any
1961 ;; more, we shrink another window instead. But if we then shrink
1962 ;; the minibuffer window again, the last window might get enlarged
1963 ;; and the state after shrinking is not the state before growing.
1964 ;; So, in practice, we'd need a history variable to record how to
1965 ;; proceed. But I'm not sure how such a variable could work with
1966 ;; repeated minibuffer window growing steps.
1968 delta)))
1971 "Move WINDOW's bottom edge by DELTA lines.
1972 Optional argument HORIZONTAL non-nil means move WINDOW's right
1973 edge by DELTA columns. WINDOW defaults to the selected window.
1975 If DELTA is greater zero, then move the edge downwards or to the
1976 right. If DELTA is less than zero, move the edge upwards or to
1977 the left. If the edge can't be moved by DELTA lines or columns,
1978 move it as far as possible in the desired direction."
1982 left this-delta min-delta max-delta failed)
1983 ;; Find the edge we want to move.
1996 ;; Set LEFT to the first resizable window on the left. This step is
1997 ;; needed to handle fixed-size windows.
2010 ;; Set RIGHT to the first resizable window on the right. This step
2011 ;; is needed to handle fixed-size windows.
2024 ;; LEFT and RIGHT (which might be both internal windows) are now the
2025 ;; two windows we want to resize.
2031 ;; We can't get the whole DELTA - move as far as possible.
2034 ;; Start resizing.
2036 ;; Try to enlarge LEFT first.
2040 left this-delta horizontal nil t 'before
2044 ;; Shrink windows on right of LEFT.
2046 left delta horizontal nil 'after
2054 ;; We can't get the whole DELTA - move as far as possible.
2057 ;; Start resizing.
2059 ;; Try to enlarge RIGHT.
2063 right this-delta horizontal nil t 'after
2067 ;; Shrink windows on left of RIGHT.
2074 ;; Don't report an error in the standard case.
2076 ;; But do report an error if applying the changes fails.
2080 "Make selected window DELTA lines taller.
2081 Interactively, if no argument is given, make the selected window
2082 one line taller. If optional argument HORIZONTAL is non-nil,
2083 make selected window wider by DELTA columns. If DELTA is
2084 negative, shrink selected window by -DELTA lines or columns.
2085 Return nil."
2098 horizontal))))
2101 "Make selected window DELTA lines smaller.
2102 Interactively, if no argument is given, make the selected window
2103 one line smaller. If optional argument HORIZONTAL is non-nil,
2104 make selected window narrower by DELTA columns. If DELTA is
2105 negative, enlarge selected window by -DELTA lines or columns.
2106 Return nil."
2119 horizontal))))
2122 "Maximize WINDOW.
2123 Make WINDOW as large as possible without deleting any windows.
2124 WINDOW can be any window and defaults to the selected window."
2131 "Minimize WINDOW.
2132 Make WINDOW as small as possible without deleting any windows.
2133 WINDOW can be any window and defaults to the selected window."
2138 \f
2140 "Return non-nil if WINDOW is the root window of its frame."
2144 "Return window tree rooted at WINDOW.
2145 Optional argument NEXT non-nil means include windows right
2146 siblings in the return value.
2148 See the documentation of `window-tree' for a description of the
2149 return value."
2162 list))
2167 "Return the window tree of frame FRAME.
2168 FRAME must be a live frame and defaults to the selected frame.
2169 The return value is a list of the form (ROOT MINI), where ROOT
2170 represents the window tree of the frame's root window, and MINI
2171 is the frame's minibuffer window.
2173 If the root window is not split, ROOT is the root window itself.
2174 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil
2175 for a horizontal split, and t for a vertical split. EDGES gives
2176 the combined size and position of the subwindows in the split,
2177 and the rest of the elements are the subwindows in the split.
2178 Each of the subwindows may again be a window or a list
2179 representing a window split, and so on. EDGES is a list \(LEFT
2180 TOP RIGHT BOTTOM) as returned by `window-edges'."
2183 \f
2185 "Select another window in cyclic ordering of windows.
2186 COUNT specifies the number of windows to skip, starting with the
2187 selected window, before making the selection. If COUNT is
2188 positive, skip COUNT windows forwards. If COUNT is negative,
2189 skip -COUNT windows backwards. COUNT zero means do not skip any
2190 window, so select the selected window. In an interactive call,
2191 COUNT is the numeric prefix argument. Return nil.
2193 If the `other-window' parameter of WINDOW is a function and
2194 `ignore-window-parameters' is nil, call that function with the
2195 arguments COUNT and ALL-FRAMES.
2197 This function does not select a window whose `no-other-window'
2198 window parameter is non-nil.
2200 This function uses `next-window' for finding the window to
2201 select. The argument ALL-FRAMES has the same meaning as in
2202 `next-window', but the MINIBUF argument of `next-window' is
2203 always effectively nil."
2208 old-window old-count)
2211 ;; `next-window' and `previous-window' may return a window we are
2212 ;; not allowed to select. Hence we need an exit strategy in case
2213 ;; all windows are non-selectable.
2220 ;; Keep out of infinite loops. When COUNT has not changed
2221 ;; since we last looked at `window' we're probably in one.
2225 ;; The first non-selectable window `next-window' got us:
2226 ;; Remember it and the current value of COUNT.
2236 ;; Keep out of infinite loops. When COUNT has not changed
2237 ;; since we last looked at `window' we're probably in one.
2241 ;; The first non-selectable window `previous-window' got
2242 ;; us: Remember it and the current value of COUNT.
2249 ;; Always return nil.
2250 nil))))
2252 ;; This should probably return non-nil when the selected window is part
2253 ;; of an atomic window whose root is the frame's root window.
2255 "Return non-nil if the selected window is the only window.
2256 Optional arg NOMINI non-nil means don't count the minibuffer
2257 even if it is active. Otherwise, the minibuffer is counted
2258 when it is active.
2260 Optional argument ALL-FRAMES specifies the set of frames to
2261 consider, see also `next-window'. ALL-FRAMES nil or omitted
2262 means consider windows on the selected frame only, plus the
2263 minibuffer window if specified by the NOMINI argument. If the
2264 minibuffer counts, consider all windows on all frames that share
2265 that minibuffer too. The remaining non-nil values of ALL-FRAMES
2266 with a special meaning are:
2268 - t means consider all windows on all existing frames.
2270 - `visible' means consider all windows on all visible frames on
2271 the current terminal.
2273 - 0 (the number zero) means consider all windows on all visible
2274 and iconified frames on the current terminal.
2276 - A frame means consider all windows on that frame only.
2278 Anything else means consider all windows on the selected frame
2279 and no others."
2285 \f
2286 ;;; Deleting windows.
2288 "Return t if WINDOW can be safely deleted from its frame.
2289 Return `frame' if deleting WINDOW should also delete its
2290 frame."
2294 ;; Handle atomicity.
2303 ;; WINDOW's frame can be deleted only if there are other frames
2304 ;; on the same terminal.
2310 ;; WINDOW can be deleted unless it is the main window of its
2311 ;; frame.
2312 t))))
2315 "Return t if SUBWINDOW is either WINDOW or a subwindow of WINDOW."
2325 "Delete WINDOW.
2326 WINDOW can be an arbitrary window and defaults to the selected
2327 one. Return nil.
2329 If the variable `ignore-window-parameters' is non-nil or the
2330 `delete-window' parameter of WINDOW equals t, do not process any
2331 parameters of WINDOW. Otherwise, if the `delete-window'
2332 parameter of WINDOW specifies a function, call that function with
2333 WINDOW as its sole argument and return the value returned by that
2334 function.
2336 Otherwise, if WINDOW is part of an atomic window, call
2337 `delete-window' with the root of the atomic window as its
2338 argument. If WINDOW is the only window on its frame or the last
2339 non-side window, signal an error."
2345 atom-root)
2348 ;; Handle window parameters.
2350 ;; Ignore window parameters if `ignore-window-parameters' tells
2351 ;; us so or `delete-window' equals t.
2354 ;; The `delete-window' parameter specifies the function to call.
2355 ;; If that function is `ignore' nothing is done. It's up to the
2356 ;; function called here to avoid infinite recursion.
2373 ;; Emacs 23 preferably gives WINDOW's space to its left
2374 ;; sibling.
2380 ;; Resize WINDOW's sibling.
2386 ;; Can do without resizing fixed-size windows.
2389 ;; Can't do without resizing fixed-size windows.
2391 ;; Actually delete WINDOW.
2396 ;; `delete-window-internal' has selected a window that should
2397 ;; not be selected, fix this here.
2401 ;; Always return nil.
2402 nil))))
2405 "Make WINDOW fill its frame.
2406 WINDOW may be any window and defaults to the selected one.
2407 Return nil.
2409 If the variable `ignore-window-parameters' is non-nil or the
2410 `delete-other-windows' parameter of WINDOW equals t, do not
2411 process any parameters of WINDOW. Otherwise, if the
2412 `delete-other-windows' parameter of WINDOW specifies a function,
2413 call that function with WINDOW as its sole argument and return
2414 the value returned by that function.
2416 Otherwise, if WINDOW is part of an atomic window, call this
2417 function with the root of the atomic window as its argument. If
2418 WINDOW is a non-side window, make WINDOW the only non-side window
2419 on the frame. Side windows are not deleted. If WINDOW is a side
2420 window signal an error."
2426 atom-root side-main)
2430 ;; Ignore window parameters if `ignore-window-parameters' is t or
2431 ;; `delete-other-windows' is t.
2434 ;; The `delete-other-windows' parameter specifies the function
2435 ;; to call. If the function is `ignore' no windows are deleted.
2436 ;; It's up to the function called to avoid infinite recursion.
2443 ;; Set side-main to the major non-side window.
2447 ;; If WINDOW is the main non-side window, do nothing.
2452 ;; Always return nil.
2453 nil)))
2456 "Delete the windows in the same column with WINDOW, but not WINDOW itself.
2458 if you often split windows horizontally."
2470 ;;; Windows and buffers.
2472 ;; `prev-buffers' and `next-buffers' are two reserved window slots used
2473 ;; for (1) determining which buffer to show in the window when its
2474 ;; buffer shall be buried or killed and (2) which buffer to show for
2475 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2477 ;; `prev-buffers' consists of <buffer, window-start, window-point>
2478 ;; triples. The entries on this list are ordered by the time their
2479 ;; buffer has been removed from the window, the most recently removed
2480 ;; buffer's entry being first. The window-start and window-point
2481 ;; components are `window-start' and `window-point' at the time the
2482 ;; buffer was removed from the window which implies that the entry must
2483 ;; be added when `set-window-buffer' removes the buffer from the window.
2485 ;; `next-buffers' is the list of buffers that have been replaced
2486 ;; recently by `switch-to-prev-buffer'. These buffers are the least
2487 ;; preferred candidates of `switch-to-prev-buffer' and the preferred
2488 ;; candidates of `switch-to-next-buffer' to switch to. This list is
2489 ;; reset to nil by any action changing the window's buffer with the
2490 ;; exception of `switch-to-prev-buffer' and `switch-to-next-buffer'.
2491 ;; `switch-to-prev-buffer' pushes the buffer it just replaced on it,
2492 ;; `switch-to-next-buffer' pops the last pushed buffer from it.
2494 ;; Both `prev-buffers' and `next-buffers' may reference killed buffers
2495 ;; if such a buffer was killed while the window was hidden within a
2496 ;; window configuration. Such killed buffers get removed whenever
2497 ;; `switch-to-prev-buffer' or `switch-to-next-buffer' encounter them.
2499 ;; The following function is called by `set-window-buffer' _before_ it
2500 ;; replaces the buffer of the argument window with the new buffer.
2502 "Record WINDOW's buffer.
2503 WINDOW must be a live window and defaults to the selected one."
2507 ;; Reset WINDOW's next buffers. If needed, they are resurrected by
2508 ;; `switch-to-prev-buffer' and `switch-to-next-buffer'.
2512 ;; Remove all entries for BUFFER from WINDOW's previous buffers.
2516 ;; Don't record insignificant buffers.
2518 ;; Add an entry for buffer to WINDOW's previous buffers.
2525 ;; We have an entry, update marker positions.
2528 ;; Make new markers.
2536 "Unrecord BUFFER in WINDOW.
2537 WINDOW must be a live window and defaults to the selected one.
2538 BUFFER must be a live buffer and defaults to the buffer of
2539 WINDOW."
2548 "Set WINDOW's buffer to BUFFER.
2549 Optional argument START non-nil means set WINDOW's start position
2550 to START. Optional argument POINT non-nil means set WINDOW's
2551 point to POINT. If WINDOW is selected this also sets BUFFER's
2552 `point' to POINT. If WINDOW is selected and the buffer it showed
2553 before was current this also makes BUFFER the current buffer."
2560 ;; Don't force window-start here (even if POINT is nil).
2566 "In WINDOW switch to previous buffer.
2567 WINDOW must be a live window and defaults to the selected one.
2569 Optional argument BURY-OR-KILL non-nil means the buffer currently
2570 shown in WINDOW is about to be buried or killed and consequently
2571 shall not be switched to in future invocations of this command."
2575 ;; Save this since it's destroyed by `set-window-buffer'.
2577 entry new-buffer killed-buffers visible)
2582 ;; Scan WINDOW's previous buffers first, skipping entries of next
2583 ;; buffers.
2595 ;; Scan reverted buffer list of WINDOW's frame next, skipping
2596 ;; entries of next buffers. Note that when we bury or kill a
2597 ;; buffer we don't reverse the global buffer list to avoid showing
2598 ;; a buried buffer instead. Otherwise, we must reverse the global
2599 ;; buffer list in order to make sure that switching to the
2600 ;; previous/next buffer traverse it in opposite directions.
2609 ;; Try to avoid showing a buffer visible in some other window.
2615 ;; Scan reverted next buffers last (must not use nreverse
2616 ;; here!).
2618 ;; Actually, buffer _must_ be live here since otherwise it
2619 ;; would have been caught in the scan of previous buffers.
2630 ;; Show a buffer visible in another window.
2636 ;; Remove `old-buffer' from WINDOW's previous and (restored list
2637 ;; of) next buffers.
2642 ;; Move `old-buffer' to head of WINDOW's restored list of next
2643 ;; buffers.
2647 ;; Remove killed buffers from WINDOW's previous and next buffers.
2655 ;; Return new-buffer.
2656 new-buffer))
2659 "In WINDOW switch to next buffer.
2660 WINDOW must be a live window and defaults to the selected one."
2665 new-buffer entry killed-buffers visible)
2670 ;; Scan WINDOW's next buffers first.
2681 ;; Scan the buffer list of WINDOW's frame next, skipping previous
2682 ;; buffers entries.
2688 ;; Try to avoid showing a buffer visible in some other window.
2693 ;; Scan WINDOW's reverted previous buffers last (must not use
2694 ;; nreverse here!)
2705 ;; Show a buffer visible in another window.
2710 ;; Remove `new-buffer' from and restore WINDOW's next buffers.
2713 ;; Remove killed buffers from WINDOW's previous and next buffers.
2721 ;; Return new-buffer.
2722 new-buffer))
2725 "Search LIST for a valid buffer to display in FRAME.
2726 Return nil when all buffers in LIST are undesirable for display,
2727 otherwise return the first suitable buffer in LIST.
2729 Buffers not visible in windows are preferred to visible buffers,
2730 unless VISIBLE-OK is non-nil.
2731 If the optional argument FRAME is nil, it defaults to the selected frame.
2732 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
2733 ;; This logic is more or less copied from other-buffer.
2736 found buf)
2749 "Return the last buffer in FRAME's buffer list.
2750 If BUFFER is the last buffer, return the preceding buffer
2751 instead. Buffers not visible in windows are preferred to visible
2752 buffers, unless optional argument VISIBLE-OK is non-nil.
2753 Optional third argument FRAME nil or omitted means use the
2754 selected frame's buffer list. If no such buffer exists, return
2755 the buffer `*scratch*', creating it if necessary."
2758 buffer visible-ok frame)
2762 scratch)))
2765 "Function called to automatically hide frames.
2766 The function is called with one argument - a frame.
2768 Functions affected by this option are those that bury a buffer
2769 shown in a separate frame like `quit-window' and `bury-buffer'."
2773 function)
2779 "Delete WINDOW if possible.
2780 WINDOW must be a live window and defaults to the selected one.
2781 Optional argument DEDICATED-ONLY non-nil means to delete WINDOW
2782 only if it's dedicated to its buffer. Optional argument KILL
2783 means the buffer shown in window will be killed. Return non-nil
2784 if WINDOW gets deleted or its frame is auto-hidden."
2800 t)))))
2803 "Put BUFFER-OR-NAME at the end of the list of all buffers.
2804 There it is the least likely candidate for `other-buffer' to
2806 select by default.
2808 You can specify a buffer name as BUFFER-OR-NAME, or an actual
2809 buffer object. If BUFFER-OR-NAME is nil or omitted, bury the
2810 current buffer. Also, if BUFFER-OR-NAME is nil or omitted,
2811 remove the current buffer from the selected window if it is
2812 displayed there."
2815 ;; If `buffer-or-name' is not on the selected frame we unrecord it
2816 ;; although it's not "here" (call it a feature).
2818 ;; Handle case where `buffer-or-name' is nil and the current buffer
2819 ;; is shown in the selected window.
2824 ;; Switch to another buffer in window.
2828 ;; Always return nil.
2829 nil))
2832 "Switch to the last buffer in the buffer list."
2837 "In selected window switch to next buffer."
2844 "In selected window switch to previous buffer."
2851 "Delete all windows showing BUFFER-OR-NAME.
2852 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2853 and defaults to the current buffer.
2855 The following non-nil values of the optional argument FRAME
2856 have special meanings:
2858 - t means consider all windows on the selected frame only.
2860 - `visible' means consider all windows on all visible frames on
2861 the current terminal.
2863 - 0 (the number zero) means consider all windows on all visible
2864 and iconified frames on the current terminal.
2866 - A frame means consider all windows on that frame only.
2868 Any other value of FRAME means consider all windows on all
2869 frames.
2871 When a window showing BUFFER-OR-NAME is dedicated and the only
2872 window of its frame, that frame is deleted when there are other
2873 frames left."
2876 ;; Handle the "inverted" meaning of the FRAME argument wrt other
2877 ;; `window-list-1' based function.
2884 ;; Delete frame if and only if window is dedicated.
2887 ;; Delete window.
2890 ;; In window switch to previous buffer.
2893 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
2897 "Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2898 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2899 and defaults to the current buffer.
2901 When a window showing BUFFER-OR-NAME is dedicated, that window is
2902 deleted. If that window is the only window on its frame, the
2903 frame is deleted too when there are other frames left. If there
2904 are no other frames left, some other buffer is displayed in that
2905 window.
2907 This function removes the buffer denoted by BUFFER-OR-NAME from
2908 all window-local buffer lists."
2913 ;; Switch to another buffer in window.
2916 ;; Unrecord BUFFER in WINDOW.
2920 "Quit WINDOW and bury its buffer.
2921 WINDOW must be a live window and defaults to the selected one.
2922 With prefix argument KILL non-nil, kill the buffer instead of
2923 burying it.
2925 According to information stored in WINDOW's `quit-restore' window
2926 parameter either \(1) delete WINDOW and its frame, \(2) delete
2927 WINDOW, \(3) restore the buffer previously displayed in WINDOW,
2928 or \(4) make WINDOW display some other buffer than the present
2929 one. If non-nil, reset `quit-restore' parameter to nil."
2940 buffer))))
2941 prev-buffer)))
2942 quad resize)
2947 ;; Delete WINDOW if possible.
2949 ;; If the previously selected window is still alive, select it.
2955 ;; Show another buffer stored in quit-restore parameter.
2962 ;; Try to resize WINDOW to its old height but don't signal an
2963 ;; error.
2967 ;; Restore WINDOW's previous buffer, window start and point.
2970 ;; Reset the quit-restore parameter.
2972 ;; Select old window.
2976 ;; Show some other buffer in WINDOW and reset the quit-restore
2977 ;; parameter.
2979 ;; Make sure that WINDOW is no more dedicated.
2983 ;; Kill WINDOW's old-buffer if requested
2989 "Quit all windows showing BUFFER-OR-NAME.
2990 BUFFER-OR-NAME may be a buffer or the name of an existing buffer
2991 and defaults to the current buffer. Optional argument KILL
2992 non-nil means to kill BUFFER-OR-NAME. KILL nil means to bury
2993 BUFFER-OR-NAME. Optional argument FRAME is handled as by
2994 `delete-windows-on'.
2996 This function calls `quit-window' on all candidate windows
2997 showing BUFFER-OR-NAME."
3000 ;; Handle the "inverted" meaning of the FRAME argument wrt other
3001 ;; `window-list-1' based function.
3006 ;; If a window doesn't show BUFFER, unrecord BUFFER in it.
3008 \f
3009 ;;; Splitting windows.
3011 "Return minimum height of any window when splitting windows.
3012 Optional argument HORIZONTAL non-nil means return minimum width."
3018 "Make a new window adjacent to WINDOW.
3019 WINDOW can be any window and defaults to the selected one.
3020 Return the new window which is always a live window.
3022 Optional argument SIZE a positive number means make WINDOW SIZE
3023 lines or columns tall. If SIZE is negative, make the new window
3024 -SIZE lines or columns tall. If and only if SIZE is non-nil, its
3025 absolute value can be less than `window-min-height' or
3026 `window-min-width'; so this command can make a new window as
3027 small as one line or two columns. SIZE defaults to half of
3028 WINDOW's size. Interactively, SIZE is the prefix argument.
3030 Optional third argument SIDE nil (or `below') specifies that the
3031 new window shall be located below WINDOW. SIDE `above' means the
3032 new window shall be located above WINDOW. In both cases SIZE
3033 specifies the new number of lines for WINDOW \(or the new window
3034 if SIZE is negative) including space reserved for the mode and/or
3035 header line.
3037 SIDE t (or `right') specifies that the new window shall be
3038 located on the right side of WINDOW. SIDE `left' means the new
3039 window shall be located on the left of WINDOW. In both cases
3040 SIZE specifies the new number of columns for WINDOW \(or the new
3041 window provided SIZE is negative) including space reserved for
3042 fringes and the scrollbar or a divider column. Any other non-nil
3043 value for SIDE is currently handled like t (or `right').
3045 If the variable `ignore-window-parameters' is non-nil or the
3046 `split-window' parameter of WINDOW equals t, do not process any
3047 parameters of WINDOW. Otherwise, if the `split-window' parameter
3048 of WINDOW specifies a function, call that function with all three
3049 arguments and return the value returned by that function.
3052 root of that atomic window. The new window does not become a
3053 member of that atomic window.
3055 If WINDOW is live, properties of the new window like margins and
3056 scrollbars are inherited from WINDOW. If WINDOW is an internal
3057 window, these properties as well as the buffer displayed in the
3058 new window are inherited from the window selected on WINDOW's
3059 frame. The selected window is not changed by this function."
3071 ;; Rebind `window-nest' since in some cases we may have to
3072 ;; override its value.
3074 atom-root)
3079 ;; Ignore window parameters if either `ignore-window-parameters'
3080 ;; is t or the `split-window' parameter equals t.
3083 ;; The `split-window' parameter specifies the function to call.
3084 ;; If that function is `ignore', do nothing.
3086 ;; If WINDOW is a subwindow of an atomic window, split the root
3087 ;; window of that atomic window instead.
3096 ;; WINDOW is a side root window. To make sure that a new parent
3097 ;; window gets created set `window-nest' to t.
3101 ;; If `window-splits' is non-nil and SIZE is a non-negative
3102 ;; integer, we cannot reasonably resize other windows. Rather
3103 ;; bind `window-nest' to t to make sure that subsequent window
3104 ;; deletions are handled correctly.
3108 ;; `parent-size' is the size of WINDOW's parent, provided
3109 ;; it has one.
3111 ;; `resize' non-nil means we are supposed to resize other
3112 ;; windows in WINDOW's combination.
3115 ;; Resize makes sense in iso-combinations only.
3117 ;; `old-size' is the current size of WINDOW.
3119 ;; `new-size' is the specified or calculated size of the
3120 ;; new window.
3126 ;; When resizing try to give the new window the
3127 ;; average size of a window in its combination.
3130 (/ parent-size
3132 parent horizontal))))
3133 ;; Else try to give the new window half the size
3134 ;; of WINDOW (plus an eventual odd line).
3137 ;; SIZE non-negative specifies the new size of WINDOW.
3139 ;; Note: Specifying a non-negative SIZE is practically
3140 ;; always done as workaround for making the new window
3141 ;; appear above or on the left of the new window (the
3142 ;; ispell window is a typical example of that). In all
3143 ;; these cases the SIDE argument should be set to 'above
3144 ;; or 'left in order to support the 'resize option.
3145 ;; Here we have to nest the windows instead, see above.
3148 ;; SIZE negative specifies the size of the new window.
3150 new-parent new-normal)
3152 ;; Check SIZE.
3157 ;; SIZE unspecified, resizing.
3159 ;; Try again with minimum split size.
3165 ;; SIZE unspecified, no resizing.
3170 window-safe-min-width
3171 window-safe-min-width))))
3172 ;; SIZE specified as new size of old window. If the new size
3173 ;; is larger than the old size or the size of the new window
3174 ;; would be less than the safe minimum, signal an error.
3177 ;; SIZE specified, resizing.
3179 ;; If we cannot resize the parent give up.
3185 ;; SIZE specification violates minimum size restrictions.
3191 ;; Make new-parent non-nil if we need a new parent window;
3192 ;; either because we want to nest or because WINDOW is not
3193 ;; iso-combined.
3196 ;; Make new-normal the normal size of the new window.
3204 ;; Try to get space from OLD's siblings. We could go "up" and
3205 ;; try getting additional space from surrounding windows but
3206 ;; we won't be able to return space to those windows when we
3207 ;; delete the one we create here. Hence we do not go up.
3216 ;; Get entire space from WINDOW.
3221 new-normal)))
3224 ;; Inherit window-side parameters, if any.
3231 ;; Always return the new window.
3232 new)))))
3234 ;; I think this should be the default; I think people will prefer it--rms.
3237 in both children.
3238 This is often more convenient for editing.
3239 If nil, adjust point in each of the two windows to minimize redisplay.
3240 This is convenient on slow terminals, but point can move strangely.
3242 This option applies only to `split-window-above-each-other' and
3243 functions that call it. `split-window' always keeps the original
3244 point in both children."
3249 "Split selected window into two windows, one above the other.
3250 The upper window gets SIZE lines and the lower one gets the rest.
3251 SIZE negative means the lower window gets -SIZE lines and the
3252 upper one the rest. With no argument, split windows equally or
3253 close to it. Both windows display the same buffer, now current.
3255 If the variable `split-window-keep-point' is non-nil, both new
3256 windows will get the same value of point as the selected window.
3257 This is often more convenient for editing. The upper window is
3258 the selected window.
3260 Otherwise, we choose window starts so as to minimize the amount of
3261 redisplay; this is convenient on slow terminals. The new selected
3262 window is the one that the current value of point appears in. The
3263 value of point can change if the text around point is hidden by the
3264 new mode line.
3266 Regardless of the value of `split-window-keep-point', the upper
3267 window is the original one and the return value is the new, lower
3268 window."
3273 moved-by-window-height moved new-window bottom)
3275 ;; `split-window' would not signal an error here.
3296 ;; Always copy quit-restore parameter in interactive use.
3300 new-window))
3305 "Split selected window into two windows side by side.
3306 The selected window becomes the left one and gets SIZE columns.
3307 SIZE negative means the right window gets -SIZE columns.
3309 SIZE includes the width of the window's scroll bar; if there are
3310 no scroll bars, it includes the width of the divider column to
3311 the window's right, if any. SIZE omitted or nil means split
3312 window equally.
3314 The selected window remains selected. Return the new window."
3318 new-window)
3320 ;; `split-window' would not signal an error here.
3323 ;; Always copy quit-restore parameter in interactive use.
3327 new-window))
3330 \f
3331 ;;; Balancing windows.
3333 ;; The following routine uses the recycled code from an old version of
3334 ;; `window--resize-subwindows'. It's not very pretty, but coding it the way the
3335 ;; new `window--resize-subwindows' code does would hardly make it any shorter or
3336 ;; more readable (FWIW we'd need three loops - one to calculate the
3337 ;; minimum sizes per window, one to enlarge or shrink windows until the
3338 ;; new parent-size matches, and one where we shrink the largest/enlarge
3339 ;; the smallest window).
3341 "Subroutine of `balance-windows-1'.
3342 WINDOW must be an iso-combination."
3348 found failed size sub-total sub-delta sub-amount rest)
3363 ;; Ignore subwindows that should be ignored or are stuck.
3370 ;; Register the new total size for this subwindow.
3375 ;; We failed and need a new round.
3381 ;; Fix rounding by trying to enlarge non-stuck windows by one line
3382 ;; (column) until `rest' is zero.
3390 ;; Fix rounding by trying to enlarge stuck windows by one line
3391 ;; (column) until `rest' equals zero.
3401 ;; Record new normal sizes.
3407 ;; Recursively balance each subwindow's subwindows.
3412 "Subroutine of `balance-windows'."
3424 "Balance the sizes of subwindows of WINDOW-OR-FRAME.
3425 WINDOW-OR-FRAME is optional and defaults to the selected frame.
3426 If WINDOW-OR-FRAME denotes a frame, balance the sizes of all
3427 subwindows of that frame's root window. If WINDOW-OR-FRAME
3428 denots a window, balance the sizes of all subwindows of that
3429 window."
3438 window-or-frame)
3442 ;; Balance vertically.
3446 ;; Balance horizontally.
3452 "Return t if WINDOW cannot be resized in DIRECTION.
3453 WINDOW defaults to the selected window. DIRECTION can be
3454 nil (i.e. any), `height' or `width'."
3461 ;;; A different solution to balance-windows.
3463 "Factor by which the window area should be over-estimated.
3464 This is used by `balance-windows-area'.
3469 "Wrapper around `window-resize' with error checking.
3470 Arguments WINDOW, DELTA and HORIZONTAL are passed on to that function."
3471 ;; `window-resize' may fail if delta is too large.
3478 ;;(message "adjust: %s" (error-message-string err))
3482 "Make all visible windows the same area (approximately).
3483 See also `window-area-factor' to change the relative size of
3484 specific buffers."
3487 ;; Remove fixed-size windows.
3492 next)
3493 ;; Resizing a window changes the size of surrounding windows in complex
3494 ;; ways, so it's difficult to balance them all. The introduction of
3495 ;; `adjust-window-trailing-edge' made it a bit easier, but it is still
3496 ;; very difficult to do. `balance-window' above takes an off-line
3497 ;; approach: get the whole window tree, then balance it, then try to
3498 ;; adjust the windows so they fit the result.
3499 ;; Here, instead, we take a "local optimization" approach, where we just
3500 ;; go through all the windows several times until nothing needs to be
3501 ;; changed. The main problem with this approach is that it's difficult
3502 ;; to make sure it terminates, so we use some heuristic to try and break
3503 ;; off infinite loops.
3504 ;; After a round without any change, we allow a second, to give a chance
3505 ;; to the carry to propagate a minor imbalance from the end back to
3506 ;; the beginning.
3508 ;; (message "New round")
3514 ;; (assert (eq next (or (cadr (member win wins)) (car wins))))
3532 ;; Maybe diff is actually closer to 1 than to 0.
3536 ;; Change things smoothly.
3539 ;; Make sure negligible differences don't accumulate to
3540 ;; become significant.
3542 ;; This used `adjust-window-trailing-edge' before and uses
3543 ;; `window-resize' now. Error wrapping is still needed.
3545 ;; (sit-for 0.5)
3547 ;; If the same change has been seen already for this window,
3548 ;; we're most likely in an endless loop, so don't count it as
3549 ;; a change.
3553 ;; We've now basically balanced all the windows.
3554 ;; But there may be some minor off-by-one imbalance left over,
3555 ;; so let's do some fine tuning.
3556 ;; (bw-finetune wins)
3557 ;; (message "Done in %d rounds" round)
3558 ))
3560 ;;; Window states, how to get them and how to put them in a window.
3562 "Like LIST but do not add nil elements of ARGS."
3569 "Helper function for `window-state-get'."
3579 type
3590 window-state-ignored-parameters)
3593 ;; Make a clone-of parameter.
3598 ;; All buffer related things go in here - make the buffer
3599 ;; current when retrieving `point' and `mark'.
3629 "Return state of WINDOW as a Lisp object.
3630 WINDOW can be any window and defaults to the root window of the
3631 selected frame.
3633 Optional argument MARKERS non-nil means use markers for sampling
3634 positions like `window-point' or `window-start'. MARKERS should
3635 be non-nil only if the value is used for putting the state back
3636 in the same session (note that markers slow down processing).
3638 The return value can be used as argument for `window-state-put'
3639 to put the state recorded here into an arbitrary window. The
3640 value can be also stored on disk and read back in a new session."
3644 window
3647 ;; The return value is a cons whose car specifies some constraints on
3648 ;; the size of WINDOW. The cdr lists the states of the subwindows of
3649 ;; WINDOW.
3651 ;; Frame related things would go into a function, say `frame-state',
3652 ;; calling `window-state-get' to insert the frame's root window.
3660 ;; These are probably not needed.
3669 "Helper function for `window-state-put'."
3674 ;; For a leaf window just add unprocessed entries to
3675 ;; `window-state-put-list'.
3682 size new)
3684 ;; Find the next child window. WINDOW always points to the
3685 ;; real window that we want to fill with what we find here.
3688 ;; The last child window. Below `window-state-put-1'
3689 ;; will put into it whatever ITEM has in store.
3691 ;; Not the last child window, prepare for splitting
3692 ;; WINDOW. SIZE is the new (and final) size of the old
3693 ;; window.
3696 ;; Use total size.
3698 ;; Use normalized size and round.
3702 item))))))
3704 ;; Use safe sizes, we try to resize later.
3706 window-safe-min-height
3707 window-safe-min-width)))
3711 ;; We must inherit the nesting, otherwise we might mess
3712 ;; up handling of atomic and side window.
3714 ;; Give up if we can't resize window down to safe sizes.
3719 ;; When creating the first child window add for parent
3720 ;; unprocessed entries to `window-state-put-list'.
3723 window-state-put-list))))
3725 ;; Now process the current window (either the one we've just
3726 ;; split or the last child of its parent).
3728 ;; Continue with the last window split off.
3732 "Helper function for `window-state-put'."
3741 ;; Process parameters.
3745 ;; Process buffer related state.
3747 ;; We don't want to raise an error here so we create a buffer if
3748 ;; there's none.
3760 ;; Adjust vertically.
3762 ;; A fixed height window, try to restore the original size.
3765 window-size-fixed)
3768 ;; Else check whether the window is not high enough.
3774 ;; Adjust horizontally.
3776 ;; A fixed width window, try to restore the original size.
3779 window-size-fixed)
3782 ;; Else check whether the window is not wide enough.
3788 ;; Set dedicated status.
3790 ;; Install positions (maybe we should do this after all windows
3791 ;; have been created and sized).
3795 ;; I'm not sure whether we should set the mark here, but maybe
3796 ;; it can be used.
3799 ;; Select window if it's the selected one.
3804 "Put window state STATE into WINDOW.
3805 STATE should be the state of a window returned by an earlier
3806 invocation of `window-state-get'. Optional argument WINDOW must
3807 specify a live window and defaults to the selected one.
3809 Optional argument IGNORE non-nil means ignore minimum window
3810 sizes and fixed size restrictions. IGNORE equal `safe' means
3811 subwindows can get as small as `window-safe-min-height' and
3812 `window-safe-min-width'."
3816 ;; We check here (1) whether the total sizes of root window of
3817 ;; STATE and that of WINDOW are equal so we can avoid
3818 ;; calculating new sizes, and (2) if we do have to resize
3819 ;; whether we can do so without violating size restrictions.
3827 window-splits selected)
3845 (> min-width
3847 ;; The check above might not catch all errors due to rounding
3848 ;; issues - so IGNORE equal 'safe might not always produce the
3849 ;; minimum possible state. But such configurations hardly make
3850 ;; sense anyway.
3854 ;; Work on the windows of a temporary buffer to make sure that
3855 ;; splitting proceeds regardless of any buffer local values of
3856 ;; `window-size-fixed'. Release that buffer after the buffers of
3857 ;; all live windows have been set by `window-state-put-2'.
3863 \f
3865 "Record information for window used by `display-buffer'.
3866 TYPE specifies the type of the calling operation and must be one
3867 of the symbols 'reuse \(when WINDOW existed already and was
3868 reused for displaying BUFFER), 'window \(when WINDOW was created
3869 on an already existing frame), or 'frame \(when WINDOW was
3870 created on a new frame). WINDOW is the window used for or created
3871 by the `display-buffer' routines. BUFFER is the buffer that
3872 shall be displayed.
3874 This function installs or updates the quit-restore parameter of
3875 WINDOW. The quit-restore parameter is a list of four elements:
3876 The first element is one of the symbols 'window, 'frame, 'same or
3877 'other. The second element is either one of the symbols 'window
3878 or 'frame or a list whose elements are the buffer previously
3879 shown in the window, that buffer's window start and window point,
3880 and the window's height. The third element is the window
3881 selected at the time the parameter was created. The fourth
3882 element is BUFFER."
3886 ;; WINDOW shows BUFFER already.
3888 ;; If WINDOW has a quit-restore parameter, reset its car.
3890 ;; WINDOW shows another buffer.
3892 window 'quit-restore
3894 ;; A quadruple of WINDOW's buffer, start, point and height.
3899 ;; WINDOW has been created on an existing frame.
3901 window 'quit-restore
3904 ;; WINDOW has been created on a new frame.
3906 window 'quit-restore
3910 "If non-nil, function to call to handle `display-buffer'.
3911 It will receive two args, the buffer and a flag which if non-nil
3912 means that the currently selected window is not acceptable. It
3913 should choose or create a window, display the specified buffer in
3914 it, and return the window.
3916 The function specified here is responsible for setting the
3917 quit-restore and help-setup parameters of the window used."
3924 "Alist of parameters for automatically generated new frames.
3925 You can set this in your init file; for example,
3927 (setq pop-up-frame-alist '((width . 80) (height . 20)))
3929 If non-nil, the value you specify here is used by the default
3930 `pop-up-frame-function' for the creation of new frames.
3932 Since `pop-up-frame-function' is used by `display-buffer' for
3933 making new frames, any value specified here by default affects
3934 the automatic generation of new frames via `display-buffer' and
3935 all functions based on it. The behavior of `make-frame' is not
3936 affected by this variable."
3944 "Function used by `display-buffer' for creating a new frame.
3945 This function is called with no arguments and should return a new
3946 frame. The default value calls `make-frame' with the argument
3947 `pop-up-frame-alist'."
3952 "List of names of buffers that should be displayed specially.
3953 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
3954 its name is in this list, displays the buffer in a way specified
3955 by `special-display-function'. `special-display-popup-frame'
3956 \(the default for `special-display-function') usually displays
3957 the buffer in a separate frame made with the parameters specified
3958 by `special-display-frame-alist'. If `special-display-function'
3959 has been set to some other function, that function is called with
3960 the buffer as first, and nil as second argument.
3962 Alternatively, an element of this list can be specified as
3963 \(BUFFER-NAME FRAME-PARAMETERS), where BUFFER-NAME is a buffer
3964 name and FRAME-PARAMETERS an alist of \(PARAMETER . VALUE) pairs.
3965 `special-display-popup-frame' will interpret such pairs as frame
3966 parameters when it creates a special frame, overriding the
3967 corresponding values from `special-display-frame-alist'.
3969 As a special case, if FRAME-PARAMETERS contains (same-window . t)
3970 `special-display-popup-frame' displays that buffer in the
3971 selected window. If FRAME-PARAMETERS contains (same-frame . t),
3972 it displays that buffer in a window on the selected frame.
3974 If `special-display-function' specifies some other function than
3975 `special-display-popup-frame', that function is called with the
3976 buffer named BUFFER-NAME as first, and FRAME-PARAMETERS as second
3977 argument.
3979 Finally, an element of this list can be also specified as
3980 \(BUFFER-NAME FUNCTION OTHER-ARGS). In that case,
3981 `special-display-popup-frame' will call FUNCTION with the buffer
3982 named BUFFER-NAME as first argument, and OTHER-ARGS as the
3983 second.
3985 Any alternative function specified here is responsible for
3986 setting up the quit-restore parameter of the window used.
3989 name to it but the corresponding buffer is displayed in the
3990 selected window, look at the values of `same-window-buffer-names'
3991 and `same-window-regexps'. Those variables take precedence over
3992 this one.
3994 See also `special-display-regexps'."
4016 ;;;###autoload
4020 "List of regexps saying which buffers should be displayed specially.
4021 Displaying a buffer with `display-buffer' or `pop-to-buffer', if
4022 any regexp in this list matches its name, displays it specially
4023 using `special-display-function'. `special-display-popup-frame'
4024 \(the default for `special-display-function') usually displays
4025 the buffer in a separate frame made with the parameters specified
4026 by `special-display-frame-alist'. If `special-display-function'
4027 has been set to some other function, that function is called with
4028 the buffer as first, and nil as second argument.
4030 Alternatively, an element of this list can be specified as
4031 \(REGEXP FRAME-PARAMETERS), where REGEXP is a regexp as above and
4032 FRAME-PARAMETERS an alist of (PARAMETER . VALUE) pairs.
4033 `special-display-popup-frame' will then interpret these pairs as
4034 frame parameters when creating a special frame for a buffer whose
4035 name matches REGEXP, overriding the corresponding values from
4036 `special-display-frame-alist'.
4038 As a special case, if FRAME-PARAMETERS contains (same-window . t)
4039 `special-display-popup-frame' displays buffers matching REGEXP in
4040 the selected window. \(same-frame . t) in FRAME-PARAMETERS means
4041 to display such buffers in a window on the selected frame.
4043 If `special-display-function' specifies some other function than
4044 `special-display-popup-frame', that function is called with the
4045 buffer whose name matched REGEXP as first, and FRAME-PARAMETERS
4046 as second argument.
4048 Finally, an element of this list can be also specified as
4049 \(REGEXP FUNCTION OTHER-ARGS). `special-display-popup-frame'
4050 will then call FUNCTION with the buffer whose name matched
4051 REGEXP as first, and OTHER-ARGS as second argument.
4053 Any alternative function specified here is responsible for
4054 setting up the quit-restore parameter of the window used.
4057 name to it but the corresponding buffer is displayed in the
4058 selected window, look at the values of `same-window-buffer-names'
4059 and `same-window-regexps'. Those variables take precedence over
4060 this one.
4062 See also `special-display-buffer-names'."
4085 "Return non-nil if a buffer named BUFFER-NAME gets a special frame.
4086 More precisely, return t if `special-display-buffer-names' or
4087 `special-display-regexps' contain a string entry equaling or
4088 matching BUFFER-NAME. If `special-display-buffer-names' or
4089 `special-display-regexps' contain a list entry whose car equals
4090 or matches BUFFER-NAME, the return value is the cdr of that
4091 entry."
4096 t)
4111 "Alist of parameters for special frames.
4112 Special frames are used for buffers whose names are listed in
4113 `special-display-buffer-names' and for buffers whose names match
4114 one of the regular expressions in `special-display-regexps'.
4116 This variable can be set in your init file, like this:
4118 (setq special-display-frame-alist '((width . 80) (height . 20)))
4120 These supersede the values given in `default-frame-alist'."
4127 "Display BUFFER and return the window chosen.
4128 If BUFFER is already displayed in a visible or iconified frame,
4129 raise that frame. Otherwise, display BUFFER in a new frame.
4131 Optional argument ARGS is a list specifying additional
4132 information.
4134 If ARGS is an alist, use it as a list of frame parameters. If
4135 these parameters contain \(same-window . t), display BUFFER in
4136 the selected window. If they contain \(same-frame . t), display
4137 BUFFER in a window of the selected frame.
4139 If ARGS is a list whose car is a symbol, use (car ARGS) as a
4140 function to do the work. Pass it BUFFER as first argument,
4141 and (cdr ARGS) as second."
4146 ;; If we have a window already, make it visible.
4152 window))
4153 ;; Reuse the current window if the user requested it.
4158 ;; Stay on the same frame if requested.
4161 pop-up-frames
4162 special-display-buffer-names special-display-regexps)
4164 ;; If no window yet, make one in a new frame.
4171 ;; Reset list of WINDOW's previous buffers to nil.
4174 window)))))
4177 "Function to call for displaying special buffers.
4178 This function is called with two arguments - the buffer and,
4179 optionally, a list - and should return a window displaying that
4180 buffer. The default value usually makes a separate frame for the
4181 buffer using `special-display-frame-alist' to specify the frame
4182 parameters. See the definition of `special-display-popup-frame'
4183 for how to specify such a function.
4185 A buffer is special when its name is either listed in
4186 `special-display-buffer-names' or matches a regexp in
4187 `special-display-regexps'.
4189 The function specified here is responsible for setting the
4190 quit-restore and help-setup parameters of the window used."
4196 `display-buffer' and `pop-to-buffer' show a buffer whose name is
4197 on this list in the selected rather than some other window.
4199 An element of this list can be a cons cell instead of just a
4200 string. In that case, the cell's car must be a string specifying
4201 the buffer name. This is for compatibility with
4202 `special-display-buffer-names'; the cdr of the cons cell is
4203 ignored.
4205 See also `same-window-regexps'."
4211 `display-buffer' and `pop-to-buffer' show a buffer whose name
4212 matches a regexp on this list in the selected rather than some
4213 other window.
4215 An element of this list can be a cons cell instead of just a
4216 string. In that case, the cell's car must be a regexp matching
4217 the buffer name. This is for compatibility with
4218 `special-display-regexps'; the cdr of the cons cell is ignored.
4220 See also `same-window-buffer-names'."
4226 This function returns non-nil if `display-buffer' or
4227 `pop-to-buffer' would show a buffer named BUFFER-NAME in the
4228 selected rather than \(as usual\) some other window. See
4229 `same-window-buffer-names' and `same-window-regexps'."
4232 ;; The elements of `same-window-buffer-names' can be buffer
4233 ;; names or cons cells whose cars are buffer names.
4238 ;; The elements of `same-window-regexps' can be regexps
4239 ;; or cons cells whose cars are regexps.
4247 "Whether `display-buffer' should make a separate frame.
4248 If nil, never make a separate frame.
4249 If the value is `graphic-only', make a separate frame
4250 on graphic displays only.
4251 Any other non-nil value means always make a separate frame."
4259 "Non-nil means `display-buffer' should reuse frames.
4260 If the buffer in question is already displayed in a frame, raise
4261 that frame."
4267 "Non-nil means `display-buffer' should make a new window."
4272 "Function called by `display-buffer' routines to split a window.
4273 This function is called with a window as single argument and is
4274 supposed to split that window and return the new window. If the
4275 window can (or shall) not be split, it is supposed to return nil.
4276 The default is to call the function `split-window-sensibly' which
4277 tries to split the window in a way which seems most suitable.
4278 You can customize the options `split-height-threshold' and/or
4279 `split-width-threshold' in order to have `split-window-sensibly'
4280 prefer either vertical or horizontal splitting.
4282 If you set this to any other function, bear in mind that the
4283 `display-buffer' routines may call this function two times. The
4284 argument of the first call is the largest window on its frame.
4285 If that call fails to return a live window, the function is
4286 called again with the least recently used window as argument. If
4287 that call fails too, `display-buffer' will use an existing window
4288 to display its buffer.
4290 The window selected at the time `display-buffer' was invoked is
4291 still selected when this function is called. Hence you can
4292 compare the window argument with the value of `selected-window'
4293 if you intend to split the selected window instead or if you do
4294 not want to split the selected window."
4300 "Minimum height for splitting windows sensibly.
4301 If this is an integer, `split-window-sensibly' may split a window
4302 vertically only if it has at least this many lines. If this is
4303 nil, `split-window-sensibly' is not allowed to split a window
4304 vertically. If, however, a window is the only window on its
4305 frame, `split-window-sensibly' may split it vertically
4306 disregarding the value of this variable."
4312 "Minimum width for splitting windows sensibly.
4313 If this is an integer, `split-window-sensibly' may split a window
4314 horizontally only if it has at least this many columns. If this
4315 is nil, `split-window-sensibly' is not allowed to split a window
4316 horizontally."
4322 "Return non-nil if `split-window-sensibly' may split WINDOW.
4323 Optional argument HORIZONTAL nil or omitted means check whether
4324 `split-window-sensibly' may split WINDOW vertically. HORIZONTAL
4325 non-nil means check whether WINDOW may be split horizontally.
4327 WINDOW may be split vertically when the following conditions
4328 hold:
4329 - `window-size-fixed' is either nil or equals `width' for the
4330 buffer of WINDOW.
4331 - `split-height-threshold' is an integer and WINDOW is at least as
4332 high as `split-height-threshold'.
4333 - When WINDOW is split evenly, the emanating windows are at least
4334 `window-min-height' lines tall and can accommodate at least one
4335 line plus - if WINDOW has one - a mode line.
4337 WINDOW may be split horizontally when the following conditions
4338 hold:
4339 - `window-size-fixed' is either nil or equals `height' for the
4340 buffer of WINDOW.
4341 - `split-width-threshold' is an integer and WINDOW is at least as
4342 wide as `split-width-threshold'.
4343 - When WINDOW is split evenly, the emanating windows are at least
4344 `window-min-width' or two (whichever is larger) columns wide."
4348 ;; A window can be split horizontally when its width is not
4349 ;; fixed, it is at least `split-width-threshold' columns wide
4350 ;; and at least twice as wide as `window-min-width' and 2 (the
4351 ;; latter value is hardcoded).
4353 ;; Testing `window-full-width-p' here hardly makes any
4354 ;; sense nowadays. This can be done more intuitively by
4355 ;; setting up `split-width-threshold' appropriately.
4360 ;; A window can be split vertically when its height is not
4361 ;; fixed, it is at least `split-height-threshold' lines high,
4362 ;; and it is at least twice as high as `window-min-height' and 2
4363 ;; if it has a modeline or 1.
4372 "Split WINDOW in a way suitable for `display-buffer'.
4373 If `split-height-threshold' specifies an integer, WINDOW is at
4374 least `split-height-threshold' lines tall and can be split
4375 vertically, split WINDOW into two windows one above the other and
4376 return the lower window. Otherwise, if `split-width-threshold'
4377 specifies an integer, WINDOW is at least `split-width-threshold'
4378 columns wide and can be split horizontally, split WINDOW into two
4379 windows side by side and return the window on the right. If this
4380 can't be done either and WINDOW is the only window on its frame,
4381 try to split WINDOW vertically disregarding any value specified
4382 by `split-height-threshold'. If that succeeds, return the lower
4383 window. Return nil otherwise.
4385 By default `display-buffer' routines call this function to split
4386 the largest or least recently used window. To change the default
4387 customize the option `split-window-preferred-function'.
4389 You can enforce this function to not split WINDOW horizontally,
4390 by setting \(or binding) the variable `split-width-threshold' to
4391 nil. If, in addition, you set `split-height-threshold' to zero,
4392 chances increase that this function does split WINDOW vertically.
4394 In order to not split WINDOW vertically, set \(or bind) the
4395 variable `split-height-threshold' to nil. Additionally, you can
4396 set `split-width-threshold' to zero to make a horizontal split
4397 more likely to occur.
4399 Have a look at the function `window-splittable-p' if you want to
4400 know how `split-window-sensibly' determines whether WINDOW can be
4401 split."
4403 ;; Split window vertically.
4407 ;; Split window horizontally.
4412 ;; If WINDOW is the only window on its frame and is not the
4413 ;; minibuffer window, try to split it vertically disregarding
4414 ;; the value of `split-height-threshold'.
4421 "Try to split WINDOW.
4422 Return value returned by `split-window-preferred-function' if it
4423 represents a live window, nil otherwise."
4427 ;; Since `split-window-preferred-function' might
4428 ;; throw an error use `condition-case'.
4435 "Return FRAME if it can be used to display a buffer."
4438 ;; `frame-root-window' may be an internal window which is considered
4439 ;; "dead" by `window-live-p'. Hence if `window' is not live we
4440 ;; implicitly know that `frame' has a visible window we can use.
4443 ;; If the window is soft-dedicated, the frame is usable.
4444 ;; Actually, even if the window is really dedicated,
4445 ;; the frame is still usable by splitting it.
4446 ;; At least Emacs-22 allowed it, and it is desirable
4447 ;; when displaying same-frame windows.
4448 nil ; (eq t (window-dedicated-p window))
4449 ))
4450 frame))))
4453 "If non-nil `display-buffer' will try to even window heights.
4454 Otherwise `display-buffer' will leave the window configuration
4455 alone. Heights are evened only when `display-buffer' chooses a
4456 window that appears above or below the selected window."
4461 "Even heights of WINDOW and selected window.
4462 Do this only if these windows are vertically adjacent to each
4463 other, `even-window-heights' is non-nil, and the selected window
4464 is higher than WINDOW."
4467 ;; Don't resize minibuffer windows.
4478 ;; Don't throw an error if we can't even window heights for
4479 ;; whatever reason.
4485 "Raise the frame containing WINDOW.
4486 Do not raise the selected frame. Return WINDOW."
4490 ;; Assume the selected frame is already visible enough.
4492 ;; Assume the frame from which we invoked the minibuffer
4493 ;; is visible.
4497 window))
4500 "Display BUFFER in WINDOW and make its frame visible.
4501 Set `window-dedicated-p' to DEDICATED if non-nil.
4502 Return WINDOW."
4510 "If non-nil, `display-buffer' marks the windows it creates as dedicated.
4511 The actual non-nil value of this variable will be copied to the
4515 "Normalize BUFFER-OR-NAME argument for buffer display functions.
4516 If BUFFER-OR-NAME is nil, return the curent buffer. Else, if a
4517 buffer specified by BUFFER-OR-NAME exists, return that buffer.
4518 If no such buffer exists, create a buffer with the name
4519 BUFFER-OR-NAME and return that buffer."
4524 buffer))
4541 ,display-buffer--action-function-custom-type
4546 :key-type symbol
4551 "Overriding action to perform to display a buffer.
4552 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4553 function or a list of functions. Each function should accept 2
4554 arguments: a buffer to display and an alist similar to ALIST.
4559 "Alist of conditional actions for `display-buffer'.
4560 This is a list of elements (CONDITION . ACTION), where:
4562 CONDITION is either a regexp matching buffer names, or a function
4563 that takes a buffer and returns a boolean.
4565 ACTION is a cons cell (FUNCTION . ALIST), where FUNCTION is a
4566 function or a list of functions. Each such function should
4567 accept 2 arguments: a buffer to display and an alist of the
4568 same form as ALIST. See `display-buffer' for details."
4571 regexp
4574 :risky t
4579 "User-specified default action for `display-buffer'.
4580 It should be a cons cell (FUNCTION . ALIST), where FUNCTION is a
4581 function or a list of functions. Each function should accept 2
4582 arguments: a buffer to display and an alist similar to ALIST.
4583 See `display-buffer' for details."
4584 :type display-buffer--action-custom-type
4585 :risky t
4591 display-buffer-reuse-window
4592 display-buffer--special
4593 display-buffer--maybe-pop-up-frame-or-window
4594 display-buffer-use-some-window
4595 ;; If all else fails, pop up a new frame.
4596 display-buffer-pop-up-frame))
4597 "Default fallback action for `display-buffer'.
4598 This is the action used by `display-buffer' if no other actions
4599 specified, e.g. by the user options `display-buffer-alist' or
4604 "Retrieve ALIST entry corresponding to BUFFER-NAME."
4623 display-buffer--special
4624 display-buffer-pop-up-frame)
4631 "Display BUFFER-OR-NAME in some window, without selecting it.
4632 BUFFER-OR-NAME must be a buffer or the name of an existing
4633 buffer. Return the window chosen for displaying BUFFER-OR-NAME,
4634 or nil if no such window is found.
4636 Optional argument ACTION should have the form (FUNCTION . ALIST).
4637 FUNCTION is either a function or a list of functions. Each such
4638 function is called with 2 arguments: the buffer to display and an
4639 alist. It should either display the buffer and return the
4640 window, or return nil if unable to display the buffer.
4642 The `display-buffer' function builds a function list and an alist
4643 from `display-buffer-overriding-action', `display-buffer-alist',
4644 the ACTION argument, `display-buffer-base-action', and
4645 `display-buffer-fallback-action' (in that order). Then it calls
4646 each function in the combined function list in turn, passing the
4647 buffer as the first argument and the combined alist as the second
4648 argument, until one of the functions returns non-nil.
4650 Available action functions include:
4651 `display-buffer-same-window'
4652 `display-buffer-reuse-window'
4653 `display-buffer-pop-up-frame'
4654 `display-buffer-pop-up-window'
4655 `display-buffer-use-some-window'
4657 Recognized alist entries include:
4659 `inhibit-same-window' -- A non-nil value prevents the same
4660 window from being used for display.
4662 `reusable-frames' -- Value specifies frame(s) to search for a
4663 window that already displays the buffer.
4664 See `display-buffer-reuse-window'.
4666 The ACTION argument to `display-buffer' can also have a non-nil
4667 and non-list value. This means to display the buffer in a window
4668 other than the selected one, even if it is already displayed in
4669 the selected window. If called interactively with a prefix
4670 argument, ACTION is t.
4672 Optional argument FRAME, if non-nil, acts like an additional
4673 ALIST entry (reusable-frames . FRAME), specifying the frame(s) to
4674 search for a window that is already displaying the buffer. See
4675 `display-buffer-reuse-window'."
4679 ;; Handle the old form of the first argument.
4683 ;; If `display-buffer-function' is defined, let it do the job.
4685 ;; Otherwise, use the defined actions.
4688 display-buffer-alist))
4689 ;; Extra actions from the arguments to this function:
4695 ;; Construct action function list and action alist.
4697 user-action action extra-action
4698 display-buffer-base-action
4699 display-buffer-fallback-action))
4704 actions)))
4706 window)
4712 window))))
4715 "Display buffer BUFFER in another frame.
4716 This uses the function `display-buffer' as a subroutine; see
4717 its documentation for additional customization information."
4721 ;;; `display-buffer' action functions:
4724 "Display BUFFER in the selected window.
4725 This fails if ALIST has a non-nil `inhibit-same-window' entry, or
4726 if the selected window is a minibuffer window or is dedicated to
4727 another buffer; in that case, return nil. Otherwise, return the
4728 selected window."
4736 "Conditionally display BUFFER in the selected window.
4737 If `same-window-p' returns non-nil for BUFFER's name, call
4738 `display-buffer-same-window' and return its value. Otherwise,
4739 return nil."
4744 "Return a window that is already displaying BUFFER.
4745 Return nil if no usable window is found.
4747 If ALIST has a non-nil `inhibit-same-window' entry, the selected
4748 window is not eligible for reuse.
4750 If ALIST contains a `reusable-frames' entry, its value determines
4751 which frames to search for a reusable window:
4752 nil -- the selected frame (actually the last non-minibuffer frame)
4753 A frame -- just that frame
4754 `visible' -- all visible frames
4755 0 -- all frames on the current terminal
4756 t -- all frames.
4758 If ALIST contains no `reusable-frames' entry, search just the
4759 selected frame if `display-buffer-reuse-frames' and
4760 `pop-up-frames' are both nil; search all frames on the current
4761 terminal if either of those variables is non-nil."
4766 pop-up-frames)
4775 frames))))))
4781 "Try to display BUFFER using `special-display-function'.
4782 Call `special-display-p' on BUFFER's name, and if that returns
4783 non-nil, call `special-display-function' on BUFFER."
4785 ;; `special-display-p' returns either t or a list of frame
4786 ;; parameters to pass to `special-display-function'.
4793 "Display BUFFER in a new frame.
4794 This works by calling `pop-up-frame-function'. If successful,
4795 return the window used; otherwise return nil."
4797 frame window)
4803 ;; Reset list of WINDOW's previous buffers to nil.
4805 window)))
4808 "Display BUFFER by popping up a new window.
4809 The new window is created on the selected frame, or in
4810 `last-nonminibuffer-frame' if no windows can be created there.
4811 If sucessful, return the new window; otherwise return nil."
4814 window)
4816 ;; If the selected frame cannot be split, look at
4817 ;; `last-nonminibuffer-frame'.
4822 ;; Attempt to split largest or least recently used window.
4829 ;; Reset list of WINDOW's previous buffers to nil.
4831 window)))
4834 "Try displaying BUFFER based on `pop-up-frames' or `pop-up-windows'.
4836 If `pop-up-frames' is non-nil (and not `graphic-only' on a
4837 text-only terminal), try with `display-buffer-pop-up-frame'.
4839 If that cannot be done, and `pop-up-windows' is non-nil, try
4840 again with `display-buffer-pop-up-window'."
4843 pop-up-frames)
4849 "Display BUFFER in an existing window.
4850 Search for a usable window, set that window to the buffer, and
4851 return the window. If no suitable window is found, return nil."
4854 ;; When NOT-THIS-WINDOW is non-nil, temporarily dedicate the
4855 ;; selected window to its buffer, to prevent any of the
4856 ;; `get-' routines below from choosing it. (Bug#1415)
4862 window)
4865 ;; Reuse an existing window.
4870 window))
4875 window))
4878 ;; Restore dedicated status of selected window.
4885 ;;; Display + selection commands:
4888 "Select buffer BUFFER in some window, preferably a different one.
4889 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4890 is a string not naming an existent buffer, create a buffer with
4891 that name. If BUFFER is nil, choose some other buffer. Return
4892 the buffer.
4894 This uses `display-buffer' as a subroutine. The optional ACTION
4895 argument is passed to `display-buffer' as its ACTION argument.
4896 See `display-buffer' for more information. ACTION is t if called
4897 interactively with a prefix argument, which means to pop to a
4898 window other than the selected one even if the buffer is already
4899 displayed in the selected window.
4901 If the window to show BUFFER is not on the selected
4902 frame, raise that window's frame and give it input focus.
4904 Optional third arg NORECORD non-nil means do not put this buffer
4905 at the front of the list of recently selected ones."
4914 ;; If we chose another frame, make sure it gets input focus.
4917 ;; Make sure new window is selected (Bug#8615), (Bug#6954).
4919 buffer))
4922 "Select buffer BUFFER in some window, preferably the same one.
4923 This function behaves much like `switch-to-buffer', except it
4924 displays with `special-display-function' if BUFFER has a match in
4925 `special-display-buffer-names' or `special-display-regexps'.
4927 Unlike `pop-to-buffer', this function prefers using the selected
4928 window over popping up a new window or frame.
4930 BUFFER may be a buffer, a string (a buffer name), or nil. If it
4931 is a string not naming an existent buffer, create a buffer with
4932 that name. If BUFFER is nil, choose some other buffer. Return
4933 the buffer.
4935 NORECORD, if non-nil means do not put this buffer at the front of
4936 the list of recently selected ones."
4939 display-buffer-same-window)
4941 norecord))
4944 "Read the name of a buffer to switch to, prompting with PROMPT.
4945 Return the neame of the buffer as a string.
4947 This function is intended for the `switch-to-buffer' family of
4948 commands since these need to omit the name of the current buffer
4949 from the list of completions and default values."
4954 ;; Since rbts-completion-table is built dynamically, we
4955 ;; can't just add it to the default value of
4956 ;; icomplete-with-completion-tables, so we add it
4957 ;; here manually.
4962 icomplete-with-completion-tables))))
4967 "Normalize BUFFER-OR-NAME argument of buffer switching functions.
4968 If BUFFER-OR-NAME is nil, return the buffer returned by
4969 `other-buffer'. Else, if a buffer specified by BUFFER-OR-NAME
4970 exists, return that buffer. If no such buffer exists, create a
4971 buffer with the name BUFFER-OR-NAME and return that buffer."
4976 buffer))
4980 "Switch to buffer BUFFER-OR-NAME in the selected window.
4981 If called interactively, prompt for the buffer name using the
4982 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
4983 determines whether to request confirmation before creating a new
4984 buffer.
4986 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
4987 nil. If BUFFER-OR-NAME is a string that does not identify an
4988 existing buffer, create a buffer with that name. If
4989 BUFFER-OR-NAME is nil, switch to the buffer returned by
4990 `other-buffer'.
4992 Optional argument NORECORD non-nil means do not put the buffer
4993 specified by BUFFER-OR-NAME at the front of the buffer list and
4994 do not make the window displaying it the most recently selected
4995 one.
4997 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
4998 in the selected window; signal an error if that is
4999 impossible (e.g. if the selected window is minibuffer-only). If
5000 nil, BUFFER-OR-NAME may be displayed in another window.
5002 Return the buffer switched to."
5009 ;; Don't call set-window-buffer if it's not needed since it
5010 ;; might signal an error (e.g. if the window is dedicated).
5023 "Select the buffer specified by BUFFER-OR-NAME in another window.
5024 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5025 nil. Return the buffer switched to.
5027 If called interactively, prompt for the buffer name using the
5028 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5029 determines whether to request confirmation before creating a new
5030 buffer.
5032 If BUFFER-OR-NAME is a string and does not identify an existing
5033 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5034 nil, switch to the buffer returned by `other-buffer'.
5036 Optional second argument NORECORD non-nil means do not put this
5037 buffer at the front of the list of recently selected ones.
5039 This uses the function `display-buffer' as a subroutine; see its
5040 documentation for additional customization information."
5047 "Switch to buffer BUFFER-OR-NAME in another frame.
5048 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
5049 nil. Return the buffer switched to.
5051 If called interactively, prompt for the buffer name using the
5052 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
5053 determines whether to request confirmation before creating a new
5054 buffer.
5056 If BUFFER-OR-NAME is a string and does not identify an existing
5057 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
5058 nil, switch to the buffer returned by `other-buffer'.
5060 Optional second arg NORECORD non-nil means do not put this
5061 buffer at the front of the list of recently selected ones.
5063 This uses the function `display-buffer' as a subroutine; see its
5064 documentation for additional customization information."
5068 \f
5070 "Set the height in lines of the text display area of WINDOW to HEIGHT.
5071 WINDOW must be a live window. HEIGHT doesn't include the mode
5072 line or header line, if any, or any partial-height lines in the
5073 text display area.
5075 Note that the current implementation of this function cannot
5076 always set the height exactly, but attempts to be conservative,
5077 by allocating more lines than are actually needed in the case
5078 where some error may be present."
5082 ;; Setting window-min-height to a value like 1 can lead to very
5083 ;; bizarre displays because it also allows Emacs to make *other*
5084 ;; windows 1-line tall, which means that there's no more space for
5085 ;; the modeline.
5090 "Make selected window DELTA columns wider.
5091 Interactively, if no argument is given, make selected window one
5092 column wider."
5097 "Make selected window DELTA columns narrower.
5098 Interactively, if no argument is given, make selected window one
5099 column narrower."
5104 "Return the number of screen lines in the region.
5105 The number of screen lines may be different from the number of actual lines,
5106 due to line breaking, display table, etc.
5108 Optional arguments BEG and END default to `point-min' and `point-max'
5109 respectively.
5111 If region ends with a newline, ignore it unless optional third argument
5112 COUNT-FINAL-NEWLINE is non-nil.
5114 The optional fourth argument WINDOW specifies the window used for obtaining
5115 parameters such as width, horizontal scrolling, and so on. The default is
5116 to use the selected window's parameters.
5118 Like `vertical-motion', `count-screen-lines' always uses the current buffer,
5119 regardless of which buffer is displayed in WINDOW. This makes possible to use
5120 `count-screen-lines' in any buffer, whether or not it is currently displayed
5121 in some window."
5127 0
5140 "Return the height (in screen lines) of the buffer that WINDOW is displaying."
5144 ;; If buffer ends with a newline, ignore it when
5145 ;; counting height unless point is after it.
5147 window))))
5149 ;;; Resizing buffers to fit their contents exactly.
5151 "Adjust height of WINDOW to display its buffer's contents exactly.
5152 WINDOW can be any live window and defaults to the selected one.
5154 Optional argument MAX-HEIGHT specifies the maximum height of
5155 WINDOW and defaults to the height of WINDOW's frame. Optional
5156 argument MIN-HEIGHT specifies the minimum height of WINDOW and
5157 defaults to `window-min-height'. Both, MAX-HEIGHT and MIN-HEIGHT
5158 are specified in lines and include the mode line and header line,
5159 if any.
5161 Optional argument OVERRIDE non-nil means override restrictions
5162 imposed by `window-min-height' and `window-min-width' on the size
5163 of WINDOW.
5165 Return the number of lines by which WINDOW was enlarged or
5166 shrunk. If an error occurs during resizing, return nil but don't
5167 signal an error.
5169 Note that even if this function makes WINDOW large enough to show
5170 _all_ lines of its buffer you might not see the first lines when
5171 WINDOW was scrolled."
5173 ;; Do all the work in WINDOW and its buffer and restore the selected
5174 ;; window and the current buffer when we're done.
5176 ;; Can't resize a full height or fixed-size window.
5179 ;; `with-selected-window' should orderly restore the current buffer.
5181 ;; We are in WINDOW's buffer now.
5187 window-safe-min-height)))
5190 ;; Adjust MAX-HEIGHT.
5193 max-window-height
5195 ;; Make `desired-height' the height necessary to show
5196 ;; all of WINDOW's buffer, constrained by MIN-HEIGHT
5197 ;; and MAX-HEIGHT.
5202 ;; For non-minibuffers count the mode line, if any.
5204 mode-line-format)
5205 1
5207 ;; Count the header line, if any.
5209 max-height)
5210 min-height))
5219 ;; This `condition-case' shouldn't be necessary, but who knows?
5222 ;; Return zero if DELTA became zero in the proces.
5223 0
5224 ;; Don't try to redisplay with the cursor at the end on its
5225 ;; own line--that would force a scroll and spoil things.
5227 ;; It's silly to put `point' at the end of the previous
5228 ;; line and so maybe force horizontal scrolling.
5230 ;; Call `window-resize' with OVERRIDE argument equal WINDOW.
5232 ;; Check if the last line is surely fully visible. If
5233 ;; not, enlarge the window.
5237 ;; Don't include final newline.
5240 ;; If line-wrapping is turned off, test the
5241 ;; beginning of the last line for
5242 ;; visibility instead of the end, as the
5243 ;; end of the line could be invisible by
5244 ;; virtue of extending past the edge of the
5245 ;; window.
5249 ;; This loop might in some rare pathological cases raise
5250 ;; an error - another reason for the `condition-case'.
5257 delta))))
5260 "Return t if WINDOW can be shrunk without shrinking other windows.
5261 WINDOW defaults to the selected window."
5264 ;; The following doesn't satisfy the doc-string's claim when
5265 ;; window and previous-/next-window are not part of the same
5266 ;; combination but still share a common edge. Using
5267 ;; `window-iso-combined-p' instead should handle that.
5270 ;; (make-obsolete
5271 ;; 'window-safely-shrinkable-p "use `window-iso-combined-p' instead." "24.1")
5274 "Shrink height of WINDOW if its buffer doesn't need so many lines.
5275 More precisely, shrink WINDOW vertically to be as small as
5276 possible, while still showing the full contents of its buffer.
5277 WINDOW defaults to the selected window.
5279 Do not shrink WINDOW to less than `window-min-height' lines. Do
5280 nothing if the buffer contains more lines than the present window
5281 height, or if some of the window's contents are scrolled out of
5282 view, or if shrinking this window would also shrink another
5283 window, or if the window is the only window of its frame.
5285 Return non-nil if the window was shrunk, nil otherwise."
5288 ;; Make sure that WINDOW is vertically combined and `point-min' is
5289 ;; visible (for whatever reason that's needed). The remaining issues
5290 ;; should be taken care of by `fit-window-to-buffer'.
5294 \f
5296 "Kill the current buffer and delete the selected window."
5305 ;; If `delete-window' failed before, we rerun it to regenerate
5306 ;; the error so it can be seen in the echo area.
5309 ;; If the buffer is not dead for some reason (probably because
5310 ;; of a `quit' signal), remove the hook again.
5315 \f
5317 "Indicates the last recenter operation performed.
5321 "Cycling order for `recenter-top-bottom'.
5322 A list of elements with possible values `top', `middle', `bottom',
5323 integer or float numbers that define the cycling order for
5324 the command `recenter-top-bottom'.
5326 Top and bottom destinations are `scroll-margin' lines the from true
5327 window top and bottom. Middle redraws the frame and centers point
5328 vertically within the window. Integer number moves current line to
5329 the specified absolute window-line. Float number between 0.0 and 1.0
5330 means the percentage of the screen space from the top. The default
5331 cycling order is middle -> top -> bottom."
5342 "Move current buffer line to the specified window line.
5343 With no prefix argument, successive calls place point according
5344 to the cycling order defined by `recenter-positions'.
5346 A prefix argument is handled like `recenter':
5347 With numeric prefix ARG, move current line to window-line ARG.
5348 With plain `C-u', move current line to window center."
5356 recenter-positions))
5375 "Position point relative to window.
5377 With a prefix argument ARG, acts like `move-to-window-line'.
5379 With no argument, positions point at center of window.
5380 Successive calls position point at positions defined
5381 by `recenter-positions'."
5389 recenter-positions))
5406 \f
5407 ;;; Scrolling commands.
5409 ;;; Scrolling commands which does not signal errors at top/bottom
5410 ;;; of buffer at first key-press (instead moves to top/bottom
5411 ;;; of buffer).
5414 "Move point to top/bottom of buffer before signalling a scrolling error.
5415 A value of nil means just signal an error if no more scrolling possible.
5416 A value of t means point moves to the beginning or the end of the buffer
5417 \(depending on scrolling direction) when no more scrolling possible.
5418 When point is already on that position, then signal an error."
5424 "Scroll text of selected window upward ARG lines; or near full screen if no ARG.
5425 If `scroll-error-top-bottom' is non-nil and `scroll-up' cannot
5426 scroll window further, move cursor to the bottom line.
5427 When point is already on that position, then signal an error.
5428 A near full screen is `next-screen-context-lines' less than a full screen.
5429 Negative ARG means scroll downward.
5430 If ARG is the atom `-', scroll downward by nearly full screen."
5446 ;; When scrolling by ARG lines can't be done,
5447 ;; move by ARG lines instead.
5449 ;; When ARG is nil for full-screen scrolling,
5450 ;; move to the bottom of the buffer.
5456 "Scroll text of selected window down ARG lines; or near full screen if no ARG.
5457 If `scroll-error-top-bottom' is non-nil and `scroll-down' cannot
5458 scroll window further, move cursor to the top line.
5459 When point is already on that position, then signal an error.
5460 A near full screen is `next-screen-context-lines' less than a full screen.
5461 Negative ARG means scroll upward.
5462 If ARG is the atom `-', scroll upward by nearly full screen."
5478 ;; When scrolling by ARG lines can't be done,
5479 ;; move by ARG lines instead.
5481 ;; When ARG is nil for full-screen scrolling,
5482 ;; move to the top of the buffer.
5487 ;;; Scrolling commands which scroll a line instead of full screen.
5490 "Scroll text of selected window upward ARG lines; or one line if no ARG.
5491 If ARG is omitted or nil, scroll upward by one line.
5492 This is different from `scroll-up-command' that scrolls a full screen."
5499 "Scroll text of selected window down ARG lines; or one line if no ARG.
5500 If ARG is omitted or nil, scroll down by one line.
5501 This is different from `scroll-down-command' that scrolls a full screen."
5507 \f
5510 For more details, see the documentation for `scroll-other-window'."
5513 ;; Just invert the argument's meaning.
5514 ;; We can do that without knowing which window it will be.
5520 "Move point to the beginning of the buffer in the other window.
5521 Leave mark at previous position.
5522 With arg N, put point N/10 of the way from the true beginning."
5526 ;; We use unwind-protect rather than save-window-excursion
5527 ;; because the latter would preserve the things we want to change.
5531 ;; Set point and mark in that window's buffer.
5534 ;; Set point accordingly.
5539 "Move point to the end of the buffer in the other window.
5540 Leave mark at previous position.
5541 With arg N, put point N/10 of the way from the true end."
5543 ;; See beginning-of-buffer-other-window for comments.
5553 \f
5564 "When non-nil, special state of delayed window autoselection.
5565 Possible values are `suspend' \(suspend autoselection after a menu or
5566 scrollbar interaction\) and `select' \(the next invocation of
5570 "Cancel delayed window autoselection.
5571 Optional argument FORCE means cancel unconditionally."
5573 ;; Don't cancel for select-window or select-frame events
5574 ;; or when the user drags a scroll bar.
5586 "Start delayed window autoselection.
5587 MOUSE-POSITION is the last position where the mouse was seen as returned
5588 by `mouse-position'. Optional argument WINDOW non-nil denotes the
5589 window where the mouse was seen. Optional argument SUSPEND non-nil
5590 means suspend autoselection."
5591 ;; Record values for MOUSE-POSITION, WINDOW, and SUSPEND.
5595 ;; Install timer which runs `mouse-autoselect-window-select' after
5596 ;; `mouse-autoselect-window' seconds.
5602 "Select window with delayed window autoselection.
5603 If the mouse position has stabilized in a non-selected window, select
5604 that window. The minibuffer window is selected only if the minibuffer is
5605 active. This function is run by `mouse-autoselect-window-timer'."
5616 ;; A menu / popup dialog is active or the mouse is on the scroll-bar
5617 ;; of WINDOW, temporarily suspend delayed autoselection.
5620 ;; Delayed autoselection was temporarily suspended, reenable it.
5625 ;; If `mouse-autoselect-window' is positive, select
5626 ;; window if the window is the same as before.
5628 ;; Otherwise select window if the mouse is at the same
5629 ;; position as before. Observe that the first test after
5630 ;; starting autoselection usually fails since the value of
5631 ;; `mouse-autoselect-window-position' recorded there is the
5632 ;; position where the mouse has entered the new window and
5633 ;; not necessarily where the mouse has stopped moving.
5635 ;; The minibuffer is a candidate window if it's active.
5638 ;; Mouse position has stabilized in non-selected window: Cancel
5639 ;; delayed autoselection and try to select that window.
5641 ;; Select window where mouse appears unless the selected window is the
5642 ;; minibuffer. Use `unread-command-events' in order to execute pre-
5643 ;; and post-command hooks and trigger idle timers. To avoid delaying
5644 ;; autoselection again, set `mouse-autoselect-window-state'."
5649 unread-command-events))))
5653 ;; Mouse position has either stabilized in the selected window or at
5654 ;; `mouse-autoselect-window-position': Cancel delayed autoselection.
5657 ;; Mouse position has not stabilized yet, resume delayed
5658 ;; autoselection.
5662 "Handle select-window events."
5666 ;; Don't switch if we're currently in the minibuffer.
5667 ;; This tries to work around problems where the
5668 ;; minibuffer gets unselected unexpectedly, and where
5669 ;; you then have to move your mouse all the way down to
5670 ;; the minibuffer to select it.
5672 ;; Don't switch to minibuffer window unless it's active.
5675 ;; Don't switch when autoselection shall be delayed.
5680 ;; Cancel any delayed autoselection.
5682 ;; Start delayed autoselection from current mouse
5683 ;; position and window.
5685 ;; Executing a command cancels delayed autoselection.
5689 ;; Reset state of delayed autoselection.
5691 ;; Run `mouse-leave-buffer-hook' when autoselecting window.
5696 "Return non-nil if lines in WINDOW are specifically truncated due to its width.
5697 WINDOW defaults to the selected window.
5698 Return nil if WINDOW is not a partial-width window
5699 (regardless of the value of `truncate-lines').
5700 Otherwise, consult the value of `truncate-partial-width-windows'
5701 for the buffer shown in WINDOW."
5709 t-p-w-w))))
5710 \f
5711 ;; Some of these are in tutorial--default-keys, so update that if you
5712 ;; change these.
5725 ;;; window.el ends here